From 364db1e4ffe3ea31cd94b2a76cd6ec1b3fee19cb Mon Sep 17 00:00:00 2001 From: Alex Jerabek <38896772+AlexJerabek@users.noreply.github.com> Date: Mon, 15 Sep 2025 14:19:18 -0700 Subject: [PATCH 1/5] Update to versioned-d.ts-tools v0.7.0 with exclusion configs - Updated package.json to use versioned-d.ts-tools 0.7.0 - Created 50+ config files with proper exclusion settings - Excluded enums, static fields, and specified field patterns - Updated GenerateDocs.sh to use new config files - Fixed JSON BOM issues in config files - Regenerated documentation with new exclusions --- generate-docs/GenerateDocs.sh | 256 +++++++++--------- generate-docs/configs/excel-1_1-config.json | 19 ++ generate-docs/configs/excel-1_10-config.json | 19 ++ generate-docs/configs/excel-1_11-config.json | 19 +- generate-docs/configs/excel-1_12-config.json | 19 ++ generate-docs/configs/excel-1_13-config.json | 19 ++ generate-docs/configs/excel-1_14-config.json | 19 ++ generate-docs/configs/excel-1_15-config.json | 19 ++ generate-docs/configs/excel-1_16-config.json | 19 ++ generate-docs/configs/excel-1_17-config.json | 19 ++ generate-docs/configs/excel-1_18-config.json | 19 ++ generate-docs/configs/excel-1_19-config.json | 19 +- generate-docs/configs/excel-1_2-config.json | 19 ++ generate-docs/configs/excel-1_20-config.json | 19 ++ generate-docs/configs/excel-1_3-config.json | 19 ++ generate-docs/configs/excel-1_4-config.json | 19 ++ generate-docs/configs/excel-1_5-config.json | 19 ++ generate-docs/configs/excel-1_6-config.json | 19 ++ generate-docs/configs/excel-1_7-config.json | 19 ++ generate-docs/configs/excel-1_8-config.json | 19 ++ generate-docs/configs/excel-1_9-config.json | 19 ++ .../configs/excel-online-config.json | 19 ++ .../configs/excel-preview-config.json | 19 ++ .../configs/officescript-preview-config.json | 12 + generate-docs/configs/outlook-1.1-config.json | 4 +- .../configs/outlook-1.10-config.json | 16 +- .../configs/outlook-1.11-config.json | 16 +- .../configs/outlook-1.12-config.json | 36 +-- .../configs/outlook-1.13-config.json | 16 +- .../configs/outlook-1.14-config.json | 26 +- .../configs/outlook-1.15-config.json | 16 +- generate-docs/configs/outlook-1.2-config.json | 16 +- generate-docs/configs/outlook-1.3-config.json | 16 +- generate-docs/configs/outlook-1.4-config.json | 16 +- generate-docs/configs/outlook-1.5-config.json | 16 +- generate-docs/configs/outlook-1.6-config.json | 16 +- generate-docs/configs/outlook-1.7-config.json | 16 +- generate-docs/configs/outlook-1.8-config.json | 16 +- generate-docs/configs/outlook-1.9-config.json | 16 +- .../configs/outlook-preview-config.json | 12 + .../configs/powerpoint-1_1-config.json | 19 ++ .../configs/powerpoint-1_2-config.json | 19 ++ .../configs/powerpoint-1_3-config.json | 19 ++ .../configs/powerpoint-1_4-config.json | 19 ++ .../configs/powerpoint-1_5-config.json | 19 ++ .../configs/powerpoint-1_6-config.json | 19 ++ .../configs/powerpoint-1_7-config.json | 19 ++ .../configs/powerpoint-1_8-config.json | 19 ++ .../configs/powerpoint-1_9-config.json | 19 ++ .../configs/powerpoint-preview-config.json | 19 ++ generate-docs/configs/word-1_1-config.json | 19 ++ generate-docs/configs/word-1_2-config.json | 19 ++ generate-docs/configs/word-1_3-config.json | 19 ++ .../word-1_3_hidden_document-config.json | 19 ++ generate-docs/configs/word-1_4-config.json | 19 ++ .../word-1_4_hidden_document-config.json | 19 ++ generate-docs/configs/word-1_5-config.json | 19 ++ .../word-1_5_hidden_document-config.json | 19 ++ generate-docs/configs/word-1_6-config.json | 19 ++ generate-docs/configs/word-1_7-config.json | 19 ++ generate-docs/configs/word-1_8-config.json | 19 ++ .../configs/word-desktop-1_1-config.json | 19 +- .../configs/word-desktop-1_2-config.json | 19 ++ generate-docs/configs/word-online-config.json | 19 ++ .../configs/word-preview-config.json | 19 ++ generate-docs/package-lock.json | 8 +- generate-docs/package.json | 2 +- 67 files changed, 1191 insertions(+), 250 deletions(-) create mode 100644 generate-docs/configs/excel-1_1-config.json create mode 100644 generate-docs/configs/excel-1_10-config.json create mode 100644 generate-docs/configs/excel-1_12-config.json create mode 100644 generate-docs/configs/excel-1_13-config.json create mode 100644 generate-docs/configs/excel-1_14-config.json create mode 100644 generate-docs/configs/excel-1_15-config.json create mode 100644 generate-docs/configs/excel-1_16-config.json create mode 100644 generate-docs/configs/excel-1_17-config.json create mode 100644 generate-docs/configs/excel-1_18-config.json create mode 100644 generate-docs/configs/excel-1_2-config.json create mode 100644 generate-docs/configs/excel-1_20-config.json create mode 100644 generate-docs/configs/excel-1_3-config.json create mode 100644 generate-docs/configs/excel-1_4-config.json create mode 100644 generate-docs/configs/excel-1_5-config.json create mode 100644 generate-docs/configs/excel-1_6-config.json create mode 100644 generate-docs/configs/excel-1_7-config.json create mode 100644 generate-docs/configs/excel-1_8-config.json create mode 100644 generate-docs/configs/excel-1_9-config.json create mode 100644 generate-docs/configs/excel-online-config.json create mode 100644 generate-docs/configs/excel-preview-config.json create mode 100644 generate-docs/configs/officescript-preview-config.json create mode 100644 generate-docs/configs/outlook-preview-config.json create mode 100644 generate-docs/configs/powerpoint-1_1-config.json create mode 100644 generate-docs/configs/powerpoint-1_2-config.json create mode 100644 generate-docs/configs/powerpoint-1_3-config.json create mode 100644 generate-docs/configs/powerpoint-1_4-config.json create mode 100644 generate-docs/configs/powerpoint-1_5-config.json create mode 100644 generate-docs/configs/powerpoint-1_6-config.json create mode 100644 generate-docs/configs/powerpoint-1_7-config.json create mode 100644 generate-docs/configs/powerpoint-1_8-config.json create mode 100644 generate-docs/configs/powerpoint-1_9-config.json create mode 100644 generate-docs/configs/powerpoint-preview-config.json create mode 100644 generate-docs/configs/word-1_1-config.json create mode 100644 generate-docs/configs/word-1_2-config.json create mode 100644 generate-docs/configs/word-1_3-config.json create mode 100644 generate-docs/configs/word-1_3_hidden_document-config.json create mode 100644 generate-docs/configs/word-1_4-config.json create mode 100644 generate-docs/configs/word-1_4_hidden_document-config.json create mode 100644 generate-docs/configs/word-1_5-config.json create mode 100644 generate-docs/configs/word-1_5_hidden_document-config.json create mode 100644 generate-docs/configs/word-1_6-config.json create mode 100644 generate-docs/configs/word-1_7-config.json create mode 100644 generate-docs/configs/word-1_8-config.json create mode 100644 generate-docs/configs/word-desktop-1_2-config.json create mode 100644 generate-docs/configs/word-online-config.json create mode 100644 generate-docs/configs/word-preview-config.json diff --git a/generate-docs/GenerateDocs.sh b/generate-docs/GenerateDocs.sh index 55737a84f2..c1803fd69c 100644 --- a/generate-docs/GenerateDocs.sh +++ b/generate-docs/GenerateDocs.sh @@ -45,27 +45,27 @@ if [ ! -d "tool-inputs" ]; then mkdir tool-inputs fi -npx version-remover api-extractor-inputs-excel-release/Excel_online/excel.d.ts api-extractor-inputs-excel-release/Excel_1_20/excel.d.ts "Api set: ExcelApiOnline 1.1" +npx version-remover api-extractor-inputs-excel-release/Excel_online/excel.d.ts api-extractor-inputs-excel-release/Excel_1_20/excel.d.ts "Api set: ExcelApiOnline 1.1" configs/excel-online-config.json npx version-remover api-extractor-inputs-excel-release/Excel_1_20/excel.d.ts api-extractor-inputs-excel-release/Excel_1_19/excel.d.ts "Api set: ExcelApi 1.20" configs/excel-1_20-config.json npx version-remover api-extractor-inputs-excel-release/Excel_1_19/excel.d.ts api-extractor-inputs-excel-release/Excel_1_18/excel.d.ts "Api set: ExcelApi 1.19" configs/excel-1_19-config.json -npx version-remover api-extractor-inputs-excel-release/Excel_1_18/excel.d.ts api-extractor-inputs-excel-release/Excel_1_17/excel.d.ts "Api set: ExcelApi 1.18" -npx version-remover api-extractor-inputs-excel-release/Excel_1_17/excel.d.ts api-extractor-inputs-excel-release/Excel_1_16/excel.d.ts "Api set: ExcelApi 1.17" -npx version-remover api-extractor-inputs-excel-release/Excel_1_16/excel.d.ts api-extractor-inputs-excel-release/Excel_1_15/excel.d.ts "Api set: ExcelApi 1.16" -npx version-remover api-extractor-inputs-excel-release/Excel_1_15/excel.d.ts api-extractor-inputs-excel-release/Excel_1_14/excel.d.ts "Api set: ExcelApi 1.15" -npx version-remover api-extractor-inputs-excel-release/Excel_1_14/excel.d.ts api-extractor-inputs-excel-release/Excel_1_13/excel.d.ts "Api set: ExcelApi 1.14" -npx version-remover api-extractor-inputs-excel-release/Excel_1_13/excel.d.ts api-extractor-inputs-excel-release/Excel_1_12/excel.d.ts "Api set: ExcelApi 1.13" -npx version-remover api-extractor-inputs-excel-release/Excel_1_12/excel.d.ts api-extractor-inputs-excel-release/Excel_1_11/excel.d.ts "Api set: ExcelApi 1.12" +npx version-remover api-extractor-inputs-excel-release/Excel_1_18/excel.d.ts api-extractor-inputs-excel-release/Excel_1_17/excel.d.ts "Api set: ExcelApi 1.18" configs/excel-1_18-config.json +npx version-remover api-extractor-inputs-excel-release/Excel_1_17/excel.d.ts api-extractor-inputs-excel-release/Excel_1_16/excel.d.ts "Api set: ExcelApi 1.17" configs/excel-1_17-config.json +npx version-remover api-extractor-inputs-excel-release/Excel_1_16/excel.d.ts api-extractor-inputs-excel-release/Excel_1_15/excel.d.ts "Api set: ExcelApi 1.16" configs/excel-1_16-config.json +npx version-remover api-extractor-inputs-excel-release/Excel_1_15/excel.d.ts api-extractor-inputs-excel-release/Excel_1_14/excel.d.ts "Api set: ExcelApi 1.15" configs/excel-1_15-config.json +npx version-remover api-extractor-inputs-excel-release/Excel_1_14/excel.d.ts api-extractor-inputs-excel-release/Excel_1_13/excel.d.ts "Api set: ExcelApi 1.14" configs/excel-1_14-config.json +npx version-remover api-extractor-inputs-excel-release/Excel_1_13/excel.d.ts api-extractor-inputs-excel-release/Excel_1_12/excel.d.ts "Api set: ExcelApi 1.13" configs/excel-1_13-config.json +npx version-remover api-extractor-inputs-excel-release/Excel_1_12/excel.d.ts api-extractor-inputs-excel-release/Excel_1_11/excel.d.ts "Api set: ExcelApi 1.12" configs/excel-1_12-config.json npx version-remover api-extractor-inputs-excel-release/Excel_1_11/excel.d.ts api-extractor-inputs-excel-release/Excel_1_10/excel.d.ts "Api set: ExcelApi 1.11" configs/excel-1_11-config.json -npx version-remover api-extractor-inputs-excel-release/Excel_1_10/excel.d.ts api-extractor-inputs-excel-release/Excel_1_9/excel.d.ts "Api set: ExcelApi 1.10" -npx version-remover api-extractor-inputs-excel-release/Excel_1_9/excel.d.ts api-extractor-inputs-excel-release/Excel_1_8/excel.d.ts "Api set: ExcelApi 1.9" -npx version-remover api-extractor-inputs-excel-release/Excel_1_8/excel.d.ts api-extractor-inputs-excel-release/Excel_1_7/excel.d.ts "Api set: ExcelApi 1.8" -npx version-remover api-extractor-inputs-excel-release/Excel_1_7/excel.d.ts api-extractor-inputs-excel-release/Excel_1_6/excel.d.ts "Api set: ExcelApi 1.7" -npx version-remover api-extractor-inputs-excel-release/Excel_1_6/excel.d.ts api-extractor-inputs-excel-release/Excel_1_5/excel.d.ts "Api set: ExcelApi 1.6" -npx version-remover api-extractor-inputs-excel-release/Excel_1_5/excel.d.ts api-extractor-inputs-excel-release/Excel_1_4/excel.d.ts "Api set: ExcelApi 1.5" -npx version-remover api-extractor-inputs-excel-release/Excel_1_4/excel.d.ts api-extractor-inputs-excel-release/Excel_1_3/excel.d.ts "Api set: ExcelApi 1.4" -npx version-remover api-extractor-inputs-excel-release/Excel_1_3/excel.d.ts api-extractor-inputs-excel-release/Excel_1_2/excel.d.ts "Api set: ExcelApi 1.3" -npx version-remover api-extractor-inputs-excel-release/Excel_1_2/excel.d.ts api-extractor-inputs-excel-release/Excel_1_1/excel.d.ts "Api set: ExcelApi 1.2" -npx version-remover api-extractor-inputs-excel-release/Excel_1_1/excel.d.ts ./tool-inputs/excel-base.d.ts "Api set: ExcelApi 1.1" +npx version-remover api-extractor-inputs-excel-release/Excel_1_10/excel.d.ts api-extractor-inputs-excel-release/Excel_1_9/excel.d.ts "Api set: ExcelApi 1.10" configs/excel-1_10-config.json +npx version-remover api-extractor-inputs-excel-release/Excel_1_9/excel.d.ts api-extractor-inputs-excel-release/Excel_1_8/excel.d.ts "Api set: ExcelApi 1.9" configs/excel-1_9-config.json +npx version-remover api-extractor-inputs-excel-release/Excel_1_8/excel.d.ts api-extractor-inputs-excel-release/Excel_1_7/excel.d.ts "Api set: ExcelApi 1.8" configs/excel-1_8-config.json +npx version-remover api-extractor-inputs-excel-release/Excel_1_7/excel.d.ts api-extractor-inputs-excel-release/Excel_1_6/excel.d.ts "Api set: ExcelApi 1.7" configs/excel-1_7-config.json +npx version-remover api-extractor-inputs-excel-release/Excel_1_6/excel.d.ts api-extractor-inputs-excel-release/Excel_1_5/excel.d.ts "Api set: ExcelApi 1.6" configs/excel-1_6-config.json +npx version-remover api-extractor-inputs-excel-release/Excel_1_5/excel.d.ts api-extractor-inputs-excel-release/Excel_1_4/excel.d.ts "Api set: ExcelApi 1.5" configs/excel-1_5-config.json +npx version-remover api-extractor-inputs-excel-release/Excel_1_4/excel.d.ts api-extractor-inputs-excel-release/Excel_1_3/excel.d.ts "Api set: ExcelApi 1.4" configs/excel-1_4-config.json +npx version-remover api-extractor-inputs-excel-release/Excel_1_3/excel.d.ts api-extractor-inputs-excel-release/Excel_1_2/excel.d.ts "Api set: ExcelApi 1.3" configs/excel-1_3-config.json +npx version-remover api-extractor-inputs-excel-release/Excel_1_2/excel.d.ts api-extractor-inputs-excel-release/Excel_1_1/excel.d.ts "Api set: ExcelApi 1.2" configs/excel-1_2-config.json +npx version-remover api-extractor-inputs-excel-release/Excel_1_1/excel.d.ts ./tool-inputs/excel-base.d.ts "Api set: ExcelApi 1.1" configs/excel-1_1-config.json npx version-remover api-extractor-inputs-outlook-release/outlook_1_15/outlook.d.ts api-extractor-inputs-outlook-release/outlook_1_14/outlook.d.ts "Api set: Mailbox 1.15" configs/outlook-1.15-config.json npx version-remover api-extractor-inputs-outlook-release/outlook_1_14/outlook.d.ts api-extractor-inputs-outlook-release/outlook_1_13/outlook.d.ts "Api set: Mailbox 1.14" configs/outlook-1.14-config.json @@ -83,118 +83,118 @@ 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_9/powerpoint.d.ts api-extractor-inputs-powerpoint-release/powerpoint_1_8/powerpoint.d.ts "Api set: PowerPointApi 1.9" -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" -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" -npx version-remover api-extractor-inputs-powerpoint-release/powerpoint_1_6/powerpoint.d.ts api-extractor-inputs-powerpoint-release/powerpoint_1_5/powerpoint.d.ts "Api set: PowerPointApi 1.6" -npx version-remover api-extractor-inputs-powerpoint-release/powerpoint_1_5/powerpoint.d.ts api-extractor-inputs-powerpoint-release/powerpoint_1_4/powerpoint.d.ts "Api set: PowerPointApi 1.5" -npx version-remover api-extractor-inputs-powerpoint-release/powerpoint_1_4/powerpoint.d.ts api-extractor-inputs-powerpoint-release/powerpoint_1_3/powerpoint.d.ts "Api set: PowerPointApi 1.4" -npx version-remover api-extractor-inputs-powerpoint-release/powerpoint_1_3/powerpoint.d.ts api-extractor-inputs-powerpoint-release/powerpoint_1_2/powerpoint.d.ts "Api set: PowerPointApi 1.3" -npx version-remover api-extractor-inputs-powerpoint-release/powerpoint_1_2/powerpoint.d.ts api-extractor-inputs-powerpoint-release/powerpoint_1_1/powerpoint.d.ts "Api set: PowerPointApi 1.2" -npx version-remover api-extractor-inputs-powerpoint-release/powerpoint_1_1/powerpoint.d.ts ./tool-inputs/powerpoint-base.d.ts "Api set: PowerPointApi 1.1" - -npx version-remover api-extractor-inputs-word-release/word_online/word-init.d.ts api-extractor-inputs-word-release/word_desktop_1_2/word-desktop1.d.ts "Api set: WordApiOnline 1.1" -npx version-remover api-extractor-inputs-word-release/word_desktop_1_2/word-desktop1.d.ts api-extractor-inputs-word-release/word_desktop_1_2/word-desktop2.d.ts "Api set: WordApi 1.9" -npx version-remover api-extractor-inputs-word-release/word_desktop_1_2/word-desktop2.d.ts api-extractor-inputs-word-release/word_desktop_1_2/word-desktop3.d.ts "Api set: WordApiHiddenDocument 1.5" -npx version-remover api-extractor-inputs-word-release/word_desktop_1_2/word-desktop3.d.ts api-extractor-inputs-word-release/word_desktop_1_2/word-desktop4.d.ts "Api set: WordApiHiddenDocument 1.4" -npx version-remover api-extractor-inputs-word-release/word_desktop_1_2/word-desktop4.d.ts api-extractor-inputs-word-release/word_desktop_1_2/word.d.ts "Api set: WordApiHiddenDocument 1.3" -npx version-remover api-extractor-inputs-word-release/word_online/word-init.d.ts api-extractor-inputs-word-release/word_online/word-online1.d.ts "Api set: WordApiDesktop 1.2" +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 +npx version-remover api-extractor-inputs-powerpoint-release/powerpoint_1_6/powerpoint.d.ts api-extractor-inputs-powerpoint-release/powerpoint_1_5/powerpoint.d.ts "Api set: PowerPointApi 1.6" configs/powerpoint-1_6-config.json +npx version-remover api-extractor-inputs-powerpoint-release/powerpoint_1_5/powerpoint.d.ts api-extractor-inputs-powerpoint-release/powerpoint_1_4/powerpoint.d.ts "Api set: PowerPointApi 1.5" configs/powerpoint-1_5-config.json +npx version-remover api-extractor-inputs-powerpoint-release/powerpoint_1_4/powerpoint.d.ts api-extractor-inputs-powerpoint-release/powerpoint_1_3/powerpoint.d.ts "Api set: PowerPointApi 1.4" configs/powerpoint-1_4-config.json +npx version-remover api-extractor-inputs-powerpoint-release/powerpoint_1_3/powerpoint.d.ts api-extractor-inputs-powerpoint-release/powerpoint_1_2/powerpoint.d.ts "Api set: PowerPointApi 1.3" configs/powerpoint-1_3-config.json +npx version-remover api-extractor-inputs-powerpoint-release/powerpoint_1_2/powerpoint.d.ts api-extractor-inputs-powerpoint-release/powerpoint_1_1/powerpoint.d.ts "Api set: PowerPointApi 1.2" configs/powerpoint-1_2-config.json +npx version-remover api-extractor-inputs-powerpoint-release/powerpoint_1_1/powerpoint.d.ts ./tool-inputs/powerpoint-base.d.ts "Api set: PowerPointApi 1.1" configs/powerpoint-1_1-config.json + +npx version-remover api-extractor-inputs-word-release/word_online/word-init.d.ts api-extractor-inputs-word-release/word_desktop_1_2/word-desktop1.d.ts "Api set: WordApiOnline 1.1" configs/word-online-config.json +npx version-remover api-extractor-inputs-word-release/word_desktop_1_2/word-desktop1.d.ts api-extractor-inputs-word-release/word_desktop_1_2/word-desktop2.d.ts "Api set: WordApi 1.9" configs/word-1_9-config.json +npx version-remover api-extractor-inputs-word-release/word_desktop_1_2/word-desktop2.d.ts api-extractor-inputs-word-release/word_desktop_1_2/word-desktop3.d.ts "Api set: WordApiHiddenDocument 1.5" configs/word-1_5_hidden_document-config.json +npx version-remover api-extractor-inputs-word-release/word_desktop_1_2/word-desktop3.d.ts api-extractor-inputs-word-release/word_desktop_1_2/word-desktop4.d.ts "Api set: WordApiHiddenDocument 1.4" configs/word-1_4_hidden_document-config.json +npx version-remover api-extractor-inputs-word-release/word_desktop_1_2/word-desktop4.d.ts api-extractor-inputs-word-release/word_desktop_1_2/word.d.ts "Api set: WordApiHiddenDocument 1.3" configs/word-1_3_hidden_document-config.json +npx version-remover api-extractor-inputs-word-release/word_online/word-init.d.ts api-extractor-inputs-word-release/word_online/word-online1.d.ts "Api set: WordApiDesktop 1.2" configs/word-desktop-1_2-config.json npx version-remover api-extractor-inputs-word-release/word_online/word-online1.d.ts api-extractor-inputs-word-release/word_online/word-online2.d.ts "Api set: WordApiDesktop 1.1" configs/word-desktop-1_1-config.json -npx version-remover api-extractor-inputs-word-release/word_online/word-online2.d.ts api-extractor-inputs-word-release/word_online/word-online3.d.ts "Api set: WordApiHiddenDocument 1.5" -npx version-remover api-extractor-inputs-word-release/word_online/word-online3.d.ts api-extractor-inputs-word-release/word_online/word-online4.d.ts "Api set: WordApiHiddenDocument 1.4" -npx version-remover api-extractor-inputs-word-release/word_online/word-online4.d.ts api-extractor-inputs-word-release/word_online/word.d.ts "Api set: WordApiHiddenDocument 1.3" -npx version-remover api-extractor-inputs-word-release/word_desktop_1_2/word-desktop1.d.ts api-extractor-inputs-word-release/word_desktop_1_1/word-desktop1.d.ts "Api set: WordApiDesktop 1.2" -npx version-remover api-extractor-inputs-word-release/word_desktop_1_1/word-desktop1.d.ts api-extractor-inputs-word-release/word_desktop_1_1/word-desktop2.d.ts "Api set: WordApi 1.9" -npx version-remover api-extractor-inputs-word-release/word_desktop_1_1/word-desktop2.d.ts api-extractor-inputs-word-release/word_desktop_1_1/word-desktop3.d.ts "Api set: WordApiHiddenDocument 1.5" -npx version-remover api-extractor-inputs-word-release/word_desktop_1_1/word-desktop3.d.ts api-extractor-inputs-word-release/word_desktop_1_1/word-desktop4.d.ts "Api set: WordApiHiddenDocument 1.4" -npx version-remover api-extractor-inputs-word-release/word_desktop_1_1/word-desktop4.d.ts api-extractor-inputs-word-release/word_desktop_1_1/word.d.ts "Api set: WordApiHiddenDocument 1.3" +npx version-remover api-extractor-inputs-word-release/word_online/word-online2.d.ts api-extractor-inputs-word-release/word_online/word-online3.d.ts "Api set: WordApiHiddenDocument 1.5" configs/word-1_5_hidden_document-config.json +npx version-remover api-extractor-inputs-word-release/word_online/word-online3.d.ts api-extractor-inputs-word-release/word_online/word-online4.d.ts "Api set: WordApiHiddenDocument 1.4" configs/word-1_4_hidden_document-config.json +npx version-remover api-extractor-inputs-word-release/word_online/word-online4.d.ts api-extractor-inputs-word-release/word_online/word.d.ts "Api set: WordApiHiddenDocument 1.3" configs/word-1_3_hidden_document-config.json +npx version-remover api-extractor-inputs-word-release/word_desktop_1_2/word-desktop1.d.ts api-extractor-inputs-word-release/word_desktop_1_1/word-desktop1.d.ts "Api set: WordApiDesktop 1.2" configs/word-desktop-1_2-config.json +npx version-remover api-extractor-inputs-word-release/word_desktop_1_1/word-desktop1.d.ts api-extractor-inputs-word-release/word_desktop_1_1/word-desktop2.d.ts "Api set: WordApi 1.9" configs/word-1_9-config.json +npx version-remover api-extractor-inputs-word-release/word_desktop_1_1/word-desktop2.d.ts api-extractor-inputs-word-release/word_desktop_1_1/word-desktop3.d.ts "Api set: WordApiHiddenDocument 1.5" configs/word-1_5_hidden_document-config.json +npx version-remover api-extractor-inputs-word-release/word_desktop_1_1/word-desktop3.d.ts api-extractor-inputs-word-release/word_desktop_1_1/word-desktop4.d.ts "Api set: WordApiHiddenDocument 1.4" configs/word-1_4_hidden_document-config.json +npx version-remover api-extractor-inputs-word-release/word_desktop_1_1/word-desktop4.d.ts api-extractor-inputs-word-release/word_desktop_1_1/word.d.ts "Api set: WordApiHiddenDocument 1.3" configs/word-1_3_hidden_document-config.json npx version-remover api-extractor-inputs-word-release/word_desktop_1_1/word-desktop2.d.ts api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop1.d.ts "Api set: WordApiDesktop 1.1" configs/word-desktop-1_1-config.json -npx version-remover api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop1.d.ts api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop2.d.ts "Api set: WordApi 1.8" -npx version-remover api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop2.d.ts api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop3.d.ts "Api set: WordApi 1.7" -npx version-remover api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop3.d.ts api-extractor-inputs-word-release/word_1_5_hidden_document/word.d.ts "Api set: WordApi 1.6" -npx version-remover api-extractor-inputs-word-release/word_1_5_hidden_document/word.d.ts api-extractor-inputs-word-release/word_1_4_hidden_document/word-desktop1.d.ts "Api set: WordApiHiddenDocument 1.5" -npx version-remover api-extractor-inputs-word-release/word_1_4_hidden_document/word-desktop1.d.ts api-extractor-inputs-word-release/word_1_4_hidden_document/word.d.ts "Api set: WordApi 1.5" -npx version-remover api-extractor-inputs-word-release/word_1_4_hidden_document/word.d.ts api-extractor-inputs-word-release/word_1_3_hidden_document/word-desktop1.d.ts "Api set: WordApiHiddenDocument 1.4" -npx version-remover api-extractor-inputs-word-release/word_1_3_hidden_document/word-desktop1.d.ts api-extractor-inputs-word-release/word_1_3_hidden_document/word.d.ts "Api set: WordApi 1.4" -npx version-remover api-extractor-inputs-word-release/word_online/word.d.ts api-extractor-inputs-word-release/word_1_9/word.d.ts "Api set: WordApiOnline 1.1" -npx version-remover api-extractor-inputs-word-release/word_1_9/word.d.ts api-extractor-inputs-word-release/word_1_8/word.d.ts "Api set: WordApi 1.9" -npx version-remover api-extractor-inputs-word-release/word_1_8/word.d.ts api-extractor-inputs-word-release/word_1_7/word.d.ts "Api set: WordApi 1.8" -npx version-remover api-extractor-inputs-word-release/word_1_7/word.d.ts api-extractor-inputs-word-release/word_1_6/word.d.ts "Api set: WordApi 1.7" -npx version-remover api-extractor-inputs-word-release/word_1_6/word.d.ts api-extractor-inputs-word-release/word_1_5/word.d.ts "Api set: WordApi 1.6" -npx version-remover api-extractor-inputs-word-release/word_1_5/word.d.ts api-extractor-inputs-word-release/word_1_4/word.d.ts "Api set: WordApi 1.5" -npx version-remover api-extractor-inputs-word-release/word_1_4/word.d.ts api-extractor-inputs-word-release/word_1_3/word.d.ts "Api set: WordApi 1.4" -npx version-remover api-extractor-inputs-word-release/word_1_3/word.d.ts api-extractor-inputs-word-release/word_1_2/word.d.ts "Api set: WordApi 1.3" -npx version-remover api-extractor-inputs-word-release/word_1_2/word.d.ts api-extractor-inputs-word-release/word_1_1/word.d.ts "Api set: WordApi 1.2" -npx version-remover api-extractor-inputs-word-release/word_1_1/word.d.ts ./tool-inputs/word-base.d.ts "Api set: WordApi 1.1" - - -npx whats-new api-extractor-inputs-excel/excel.d.ts api-extractor-inputs-excel-release/Excel_online/excel.d.ts ../docs/includes/excel-preview javascript/api/excel/ configs/excel-link-config.json -npx whats-new api-extractor-inputs-excel-release/Excel_online/excel.d.ts api-extractor-inputs-excel-release/Excel_1_20/excel.d.ts ../docs/includes/excel-online javascript/api/excel/ configs/excel-link-config.json -npx whats-new api-extractor-inputs-excel-release/Excel_1_20/excel.d.ts api-extractor-inputs-excel-release/Excel_1_19/excel.d.ts ../docs/includes/excel-1_20 javascript/api/excel/ configs/excel-link-config.json -npx whats-new api-extractor-inputs-excel-release/Excel_1_19/excel.d.ts api-extractor-inputs-excel-release/Excel_1_18/excel.d.ts ../docs/includes/excel-1_19 javascript/api/excel/ configs/excel-link-config.json -npx whats-new api-extractor-inputs-excel-release/Excel_1_18/excel.d.ts api-extractor-inputs-excel-release/Excel_1_17/excel.d.ts ../docs/includes/excel-1_18 javascript/api/excel/ configs/excel-link-config.json -npx whats-new api-extractor-inputs-excel-release/Excel_1_17/excel.d.ts api-extractor-inputs-excel-release/Excel_1_16/excel.d.ts ../docs/includes/excel-1_17 javascript/api/excel/ configs/excel-link-config.json -npx whats-new api-extractor-inputs-excel-release/Excel_1_16/excel.d.ts api-extractor-inputs-excel-release/Excel_1_15/excel.d.ts ../docs/includes/excel-1_16 javascript/api/excel/ configs/excel-link-config.json -npx whats-new api-extractor-inputs-excel-release/Excel_1_15/excel.d.ts api-extractor-inputs-excel-release/Excel_1_14/excel.d.ts ../docs/includes/excel-1_15 javascript/api/excel/ configs/excel-link-config.json -npx whats-new api-extractor-inputs-excel-release/Excel_1_14/excel.d.ts api-extractor-inputs-excel-release/Excel_1_13/excel.d.ts ../docs/includes/excel-1_14 javascript/api/excel/ configs/excel-link-config.json -npx whats-new api-extractor-inputs-excel-release/Excel_1_13/excel.d.ts api-extractor-inputs-excel-release/Excel_1_12/excel.d.ts ../docs/includes/excel-1_13 javascript/api/excel/ configs/excel-link-config.json -npx whats-new api-extractor-inputs-excel-release/Excel_1_12/excel.d.ts api-extractor-inputs-excel-release/Excel_1_11/excel.d.ts ../docs/includes/excel-1_12 javascript/api/excel/ configs/excel-link-config.json -npx whats-new api-extractor-inputs-excel-release/Excel_1_11/excel.d.ts api-extractor-inputs-excel-release/Excel_1_10/excel.d.ts ../docs/includes/excel-1_11 javascript/api/excel/ configs/excel-link-config.json -npx whats-new api-extractor-inputs-excel-release/Excel_1_10/excel.d.ts api-extractor-inputs-excel-release/Excel_1_9/excel.d.ts ../docs/includes/excel-1_10 javascript/api/excel/ configs/excel-link-config.json -npx whats-new api-extractor-inputs-excel-release/Excel_1_9/excel.d.ts api-extractor-inputs-excel-release/Excel_1_8/excel.d.ts ../docs/includes/excel-1_9 javascript/api/excel/ configs/excel-link-config.json -npx whats-new api-extractor-inputs-excel-release/Excel_1_8/excel.d.ts api-extractor-inputs-excel-release/Excel_1_7/excel.d.ts ../docs/includes/excel-1_8 javascript/api/excel/ configs/excel-link-config.json -npx whats-new api-extractor-inputs-excel-release/Excel_1_7/excel.d.ts api-extractor-inputs-excel-release/Excel_1_6/excel.d.ts ../docs/includes/excel-1_7 javascript/api/excel/ configs/excel-link-config.json -npx whats-new api-extractor-inputs-excel-release/Excel_1_6/excel.d.ts api-extractor-inputs-excel-release/Excel_1_5/excel.d.ts ../docs/includes/excel-1_6 javascript/api/excel/ configs/excel-link-config.json -npx whats-new api-extractor-inputs-excel-release/Excel_1_5/excel.d.ts api-extractor-inputs-excel-release/Excel_1_4/excel.d.ts ../docs/includes/excel-1_5 javascript/api/excel/ configs/excel-link-config.json -npx whats-new api-extractor-inputs-excel-release/Excel_1_4/excel.d.ts api-extractor-inputs-excel-release/Excel_1_3/excel.d.ts ../docs/includes/excel-1_4 javascript/api/excel/ configs/excel-link-config.json -npx whats-new api-extractor-inputs-excel-release/Excel_1_3/excel.d.ts api-extractor-inputs-excel-release/Excel_1_2/excel.d.ts ../docs/includes/excel-1_3 javascript/api/excel/ configs/excel-link-config.json -npx whats-new api-extractor-inputs-excel-release/Excel_1_2/excel.d.ts api-extractor-inputs-excel-release/Excel_1_1/excel.d.ts ../docs/includes/excel-1_2 javascript/api/excel/ configs/excel-link-config.json -npx whats-new api-extractor-inputs-excel-release/Excel_1_1/excel.d.ts ./tool-inputs/excel-base.d.ts ../docs/includes/excel-1_1 javascript/api/excel/ configs/excel-link-config.json - -npx whats-new api-extractor-inputs-outlook/outlook.d.ts api-extractor-inputs-outlook-release/outlook_1_15/outlook.d.ts ../docs/includes/outlook-preview javascript/api/outlook/ configs/outlook-link-config.json -npx whats-new api-extractor-inputs-outlook-release/outlook_1_15/outlook.d.ts api-extractor-inputs-outlook-release/outlook_1_14/outlook.d.ts ../docs/includes/outlook-1_15 javascript/api/outlook/ configs/outlook-link-config.json -npx whats-new api-extractor-inputs-outlook-release/outlook_1_14/outlook.d.ts api-extractor-inputs-outlook-release/outlook_1_13/outlook.d.ts ../docs/includes/outlook-1_14 javascript/api/outlook/ configs/outlook-link-config.json -npx whats-new api-extractor-inputs-outlook-release/outlook_1_13/outlook.d.ts api-extractor-inputs-outlook-release/outlook_1_12/outlook.d.ts ../docs/includes/outlook-1_13 javascript/api/outlook/ configs/outlook-link-config.json -npx whats-new api-extractor-inputs-outlook-release/outlook_1_12/outlook.d.ts api-extractor-inputs-outlook-release/outlook_1_11/outlook.d.ts ../docs/includes/outlook-1_12 javascript/api/outlook/ configs/outlook-link-config.json -npx whats-new api-extractor-inputs-outlook-release/outlook_1_11/outlook.d.ts api-extractor-inputs-outlook-release/outlook_1_10/outlook.d.ts ../docs/includes/outlook-1_11 javascript/api/outlook/ configs/outlook-link-config.json -npx whats-new api-extractor-inputs-outlook-release/outlook_1_10/outlook.d.ts api-extractor-inputs-outlook-release/outlook_1_9/outlook.d.ts ../docs/includes/outlook-1_10 javascript/api/outlook/ configs/outlook-link-config.json -npx whats-new api-extractor-inputs-outlook-release/outlook_1_9/outlook.d.ts api-extractor-inputs-outlook-release/outlook_1_8/outlook.d.ts ../docs/includes/outlook-1_9 javascript/api/outlook/ configs/outlook-link-config.json -npx whats-new api-extractor-inputs-outlook-release/outlook_1_8/outlook.d.ts api-extractor-inputs-outlook-release/outlook_1_7/outlook.d.ts ../docs/includes/outlook-1_8 javascript/api/outlook/ configs/outlook-link-config.json -npx whats-new api-extractor-inputs-outlook-release/outlook_1_7/outlook.d.ts api-extractor-inputs-outlook-release/outlook_1_6/outlook.d.ts ../docs/includes/outlook-1_7 javascript/api/outlook/ configs/outlook-link-config.json -npx whats-new api-extractor-inputs-outlook-release/outlook_1_6/outlook.d.ts api-extractor-inputs-outlook-release/outlook_1_5/outlook.d.ts ../docs/includes/outlook-1_6 javascript/api/outlook/ configs/outlook-link-config.json -npx whats-new api-extractor-inputs-outlook-release/outlook_1_5/outlook.d.ts api-extractor-inputs-outlook-release/outlook_1_4/outlook.d.ts ../docs/includes/outlook-1_5 javascript/api/outlook/ configs/outlook-link-config.json -npx whats-new api-extractor-inputs-outlook-release/outlook_1_4/outlook.d.ts api-extractor-inputs-outlook-release/outlook_1_3/outlook.d.ts ../docs/includes/outlook-1_4 javascript/api/outlook/ configs/outlook-link-config.json -npx whats-new api-extractor-inputs-outlook-release/outlook_1_3/outlook.d.ts api-extractor-inputs-outlook-release/outlook_1_2/outlook.d.ts ../docs/includes/outlook-1_3 javascript/api/outlook/ configs/outlook-link-config.json -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-link-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-link-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-link-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-link-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-link-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-link-config.json -npx whats-new api-extractor-inputs-powerpoint-release/powerpoint_1_6/powerpoint.d.ts api-extractor-inputs-powerpoint-release/powerpoint_1_5/powerpoint.d.ts ../docs/includes/powerpoint-1_6 javascript/api/powerpoint/ configs/powerpoint-link-config.json -npx whats-new api-extractor-inputs-powerpoint-release/powerpoint_1_5/powerpoint.d.ts api-extractor-inputs-powerpoint-release/powerpoint_1_4/powerpoint.d.ts ../docs/includes/powerpoint-1_5 javascript/api/powerpoint/ configs/powerpoint-link-config.json -npx whats-new api-extractor-inputs-powerpoint-release/powerpoint_1_4/powerpoint.d.ts api-extractor-inputs-powerpoint-release/powerpoint_1_3/powerpoint.d.ts ../docs/includes/powerpoint-1_4 javascript/api/powerpoint/ configs/powerpoint-link-config.json -npx whats-new api-extractor-inputs-powerpoint-release/powerpoint_1_3/powerpoint.d.ts api-extractor-inputs-powerpoint-release/powerpoint_1_2/powerpoint.d.ts ../docs/includes/powerpoint-1_3 javascript/api/powerpoint/ configs/powerpoint-link-config.json -npx whats-new api-extractor-inputs-powerpoint-release/powerpoint_1_2/powerpoint.d.ts api-extractor-inputs-powerpoint-release/powerpoint_1_1/powerpoint.d.ts ../docs/includes/powerpoint-1_2 javascript/api/powerpoint/ configs/powerpoint-link-config.json -npx whats-new api-extractor-inputs-powerpoint-release/powerpoint_1_1/powerpoint.d.ts ./tool-inputs/powerpoint-base.d.ts ../docs/includes/powerpoint-1_1 javascript/api/powerpoint/ configs/powerpoint-link-config.json - -npx whats-new api-extractor-inputs-word/word.d.ts api-extractor-inputs-word-release/word_online/word-init.d.ts ../docs/includes/word-preview javascript/api/word/ configs/word-link-config.json -npx whats-new api-extractor-inputs-word-release/word_online/word.d.ts api-extractor-inputs-word-release/word_1_9/word.d.ts ../docs/includes/word-online javascript/api/word/ configs/word-link-config.json -npx whats-new api-extractor-inputs-word-release/word_desktop_1_2/word.d.ts api-extractor-inputs-word-release/word_desktop_1_1/word.d.ts ../docs/includes/word-desktop-1_2 javascript/api/word/ configs/word-link-config.json -npx whats-new api-extractor-inputs-word-release/word_desktop_1_1/word.d.ts api-extractor-inputs-word-release/word_1_8/word.d.ts ../docs/includes/word-desktop-1_1 javascript/api/word/ configs/word-link-config.json -npx whats-new api-extractor-inputs-word-release/word_1_5_hidden_document/word.d.ts api-extractor-inputs-word-release/word_1_4_hidden_document/word-desktop1.d.ts ../docs/includes/word-1_5_hidden_document javascript/api/word/ configs/word-link-config.json -npx whats-new api-extractor-inputs-word-release/word_1_4_hidden_document/word.d.ts api-extractor-inputs-word-release/word_1_3_hidden_document/word-desktop1.d.ts ../docs/includes/word-1_4_hidden_document javascript/api/word/ configs/word-link-config.json -npx whats-new api-extractor-inputs-word-release/word_1_3_hidden_document/word.d.ts api-extractor-inputs-word-release/word_1_3/word.d.ts ../docs/includes/word-1_3_hidden_document javascript/api/word/ configs/word-link-config.json -npx whats-new api-extractor-inputs-word-release/word_1_9/word.d.ts api-extractor-inputs-word-release/word_1_8/word.d.ts ../docs/includes/word-1_9 javascript/api/word/ configs/word-link-config.json -npx whats-new api-extractor-inputs-word-release/word_1_8/word.d.ts api-extractor-inputs-word-release/word_1_7/word.d.ts ../docs/includes/word-1_8 javascript/api/word/ configs/word-link-config.json -npx whats-new api-extractor-inputs-word-release/word_1_7/word.d.ts api-extractor-inputs-word-release/word_1_6/word.d.ts ../docs/includes/word-1_7 javascript/api/word/ configs/word-link-config.json -npx whats-new api-extractor-inputs-word-release/word_1_6/word.d.ts api-extractor-inputs-word-release/word_1_5/word.d.ts ../docs/includes/word-1_6 javascript/api/word/ configs/word-link-config.json -npx whats-new api-extractor-inputs-word-release/word_1_5/word.d.ts api-extractor-inputs-word-release/word_1_4/word.d.ts ../docs/includes/word-1_5 javascript/api/word/ configs/word-link-config.json -npx whats-new api-extractor-inputs-word-release/word_1_4/word.d.ts api-extractor-inputs-word-release/word_1_3/word.d.ts ../docs/includes/word-1_4 javascript/api/word/ configs/word-link-config.json -npx whats-new api-extractor-inputs-word-release/word_1_3/word.d.ts api-extractor-inputs-word-release/word_1_2/word.d.ts ../docs/includes/word-1_3 javascript/api/word/ configs/word-link-config.json -npx whats-new api-extractor-inputs-word-release/word_1_2/word.d.ts api-extractor-inputs-word-release/word_1_1/word.d.ts ../docs/includes/word-1_2 javascript/api/word/ configs/word-link-config.json -npx whats-new api-extractor-inputs-word-release/word_1_1/word.d.ts ./tool-inputs/word-base.d.ts ../docs/includes/word-1_1 javascript/api/word/ configs/word-link-config.json +npx version-remover api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop1.d.ts api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop2.d.ts "Api set: WordApi 1.8" configs/word-1_8-config.json +npx version-remover api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop2.d.ts api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop3.d.ts "Api set: WordApi 1.7" configs/word-1_7-config.json +npx version-remover api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop3.d.ts api-extractor-inputs-word-release/word_1_5_hidden_document/word.d.ts "Api set: WordApi 1.6" configs/word-1_6-config.json +npx version-remover api-extractor-inputs-word-release/word_1_5_hidden_document/word.d.ts api-extractor-inputs-word-release/word_1_4_hidden_document/word-desktop1.d.ts "Api set: WordApiHiddenDocument 1.5" configs/word-1_5_hidden_document-config.json +npx version-remover api-extractor-inputs-word-release/word_1_4_hidden_document/word-desktop1.d.ts api-extractor-inputs-word-release/word_1_4_hidden_document/word.d.ts "Api set: WordApi 1.5" configs/word-1_5-config.json +npx version-remover api-extractor-inputs-word-release/word_1_4_hidden_document/word.d.ts api-extractor-inputs-word-release/word_1_3_hidden_document/word-desktop1.d.ts "Api set: WordApiHiddenDocument 1.4" configs/word-1_4_hidden_document-config.json +npx version-remover api-extractor-inputs-word-release/word_1_3_hidden_document/word-desktop1.d.ts api-extractor-inputs-word-release/word_1_3_hidden_document/word.d.ts "Api set: WordApi 1.4" configs/word-1_4-config.json +npx version-remover api-extractor-inputs-word-release/word_online/word.d.ts api-extractor-inputs-word-release/word_1_9/word.d.ts "Api set: WordApiOnline 1.1" configs/word-online-config.json +npx version-remover api-extractor-inputs-word-release/word_1_9/word.d.ts api-extractor-inputs-word-release/word_1_8/word.d.ts "Api set: WordApi 1.9" configs/word-1_9-config.json +npx version-remover api-extractor-inputs-word-release/word_1_8/word.d.ts api-extractor-inputs-word-release/word_1_7/word.d.ts "Api set: WordApi 1.8" configs/word-1_8-config.json +npx version-remover api-extractor-inputs-word-release/word_1_7/word.d.ts api-extractor-inputs-word-release/word_1_6/word.d.ts "Api set: WordApi 1.7" configs/word-1_7-config.json +npx version-remover api-extractor-inputs-word-release/word_1_6/word.d.ts api-extractor-inputs-word-release/word_1_5/word.d.ts "Api set: WordApi 1.6" configs/word-1_6-config.json +npx version-remover api-extractor-inputs-word-release/word_1_5/word.d.ts api-extractor-inputs-word-release/word_1_4/word.d.ts "Api set: WordApi 1.5" configs/word-1_5-config.json +npx version-remover api-extractor-inputs-word-release/word_1_4/word.d.ts api-extractor-inputs-word-release/word_1_3/word.d.ts "Api set: WordApi 1.4" configs/word-1_4-config.json +npx version-remover api-extractor-inputs-word-release/word_1_3/word.d.ts api-extractor-inputs-word-release/word_1_2/word.d.ts "Api set: WordApi 1.3" configs/word-1_3-config.json +npx version-remover api-extractor-inputs-word-release/word_1_2/word.d.ts api-extractor-inputs-word-release/word_1_1/word.d.ts "Api set: WordApi 1.2" configs/word-1_2-config.json +npx version-remover api-extractor-inputs-word-release/word_1_1/word.d.ts ./tool-inputs/word-base.d.ts "Api set: WordApi 1.1" configs/word-1_1-config.json + + +npx whats-new api-extractor-inputs-excel/excel.d.ts api-extractor-inputs-excel-release/Excel_online/excel.d.ts ../docs/includes/excel-preview javascript/api/excel/ configs/excel-preview-config.json +npx whats-new api-extractor-inputs-excel-release/Excel_online/excel.d.ts api-extractor-inputs-excel-release/Excel_1_20/excel.d.ts ../docs/includes/excel-online javascript/api/excel/ configs/excel-online-config.json +npx whats-new api-extractor-inputs-excel-release/Excel_1_20/excel.d.ts api-extractor-inputs-excel-release/Excel_1_19/excel.d.ts ../docs/includes/excel-1_20 javascript/api/excel/ configs/excel-1_20-config.json +npx whats-new api-extractor-inputs-excel-release/Excel_1_19/excel.d.ts api-extractor-inputs-excel-release/Excel_1_18/excel.d.ts ../docs/includes/excel-1_19 javascript/api/excel/ configs/excel-1_19-config.json +npx whats-new api-extractor-inputs-excel-release/Excel_1_18/excel.d.ts api-extractor-inputs-excel-release/Excel_1_17/excel.d.ts ../docs/includes/excel-1_18 javascript/api/excel/ configs/excel-1_18-config.json +npx whats-new api-extractor-inputs-excel-release/Excel_1_17/excel.d.ts api-extractor-inputs-excel-release/Excel_1_16/excel.d.ts ../docs/includes/excel-1_17 javascript/api/excel/ configs/excel-1_17-config.json +npx whats-new api-extractor-inputs-excel-release/Excel_1_16/excel.d.ts api-extractor-inputs-excel-release/Excel_1_15/excel.d.ts ../docs/includes/excel-1_16 javascript/api/excel/ configs/excel-1_16-config.json +npx whats-new api-extractor-inputs-excel-release/Excel_1_15/excel.d.ts api-extractor-inputs-excel-release/Excel_1_14/excel.d.ts ../docs/includes/excel-1_15 javascript/api/excel/ configs/excel-1_15-config.json +npx whats-new api-extractor-inputs-excel-release/Excel_1_14/excel.d.ts api-extractor-inputs-excel-release/Excel_1_13/excel.d.ts ../docs/includes/excel-1_14 javascript/api/excel/ configs/excel-1_14-config.json +npx whats-new api-extractor-inputs-excel-release/Excel_1_13/excel.d.ts api-extractor-inputs-excel-release/Excel_1_12/excel.d.ts ../docs/includes/excel-1_13 javascript/api/excel/ configs/excel-1_13-config.json +npx whats-new api-extractor-inputs-excel-release/Excel_1_12/excel.d.ts api-extractor-inputs-excel-release/Excel_1_11/excel.d.ts ../docs/includes/excel-1_12 javascript/api/excel/ configs/excel-1_12-config.json +npx whats-new api-extractor-inputs-excel-release/Excel_1_11/excel.d.ts api-extractor-inputs-excel-release/Excel_1_10/excel.d.ts ../docs/includes/excel-1_11 javascript/api/excel/ configs/excel-1_11-config.json +npx whats-new api-extractor-inputs-excel-release/Excel_1_10/excel.d.ts api-extractor-inputs-excel-release/Excel_1_9/excel.d.ts ../docs/includes/excel-1_10 javascript/api/excel/ configs/excel-1_10-config.json +npx whats-new api-extractor-inputs-excel-release/Excel_1_9/excel.d.ts api-extractor-inputs-excel-release/Excel_1_8/excel.d.ts ../docs/includes/excel-1_9 javascript/api/excel/ configs/excel-1_9-config.json +npx whats-new api-extractor-inputs-excel-release/Excel_1_8/excel.d.ts api-extractor-inputs-excel-release/Excel_1_7/excel.d.ts ../docs/includes/excel-1_8 javascript/api/excel/ configs/excel-1_8-config.json +npx whats-new api-extractor-inputs-excel-release/Excel_1_7/excel.d.ts api-extractor-inputs-excel-release/Excel_1_6/excel.d.ts ../docs/includes/excel-1_7 javascript/api/excel/ configs/excel-1_7-config.json +npx whats-new api-extractor-inputs-excel-release/Excel_1_6/excel.d.ts api-extractor-inputs-excel-release/Excel_1_5/excel.d.ts ../docs/includes/excel-1_6 javascript/api/excel/ configs/excel-1_6-config.json +npx whats-new api-extractor-inputs-excel-release/Excel_1_5/excel.d.ts api-extractor-inputs-excel-release/Excel_1_4/excel.d.ts ../docs/includes/excel-1_5 javascript/api/excel/ configs/excel-1_5-config.json +npx whats-new api-extractor-inputs-excel-release/Excel_1_4/excel.d.ts api-extractor-inputs-excel-release/Excel_1_3/excel.d.ts ../docs/includes/excel-1_4 javascript/api/excel/ configs/excel-1_4-config.json +npx whats-new api-extractor-inputs-excel-release/Excel_1_3/excel.d.ts api-extractor-inputs-excel-release/Excel_1_2/excel.d.ts ../docs/includes/excel-1_3 javascript/api/excel/ configs/excel-1_3-config.json +npx whats-new api-extractor-inputs-excel-release/Excel_1_2/excel.d.ts api-extractor-inputs-excel-release/Excel_1_1/excel.d.ts ../docs/includes/excel-1_2 javascript/api/excel/ configs/excel-1_2-config.json +npx whats-new api-extractor-inputs-excel-release/Excel_1_1/excel.d.ts ./tool-inputs/excel-base.d.ts ../docs/includes/excel-1_1 javascript/api/excel/ configs/excel-1_1-config.json + +npx whats-new api-extractor-inputs-outlook/outlook.d.ts api-extractor-inputs-outlook-release/outlook_1_15/outlook.d.ts ../docs/includes/outlook-preview javascript/api/outlook/ configs/outlook-preview-config.json +npx whats-new api-extractor-inputs-outlook-release/outlook_1_15/outlook.d.ts api-extractor-inputs-outlook-release/outlook_1_14/outlook.d.ts ../docs/includes/outlook-1_15 javascript/api/outlook/ configs/outlook-1.15-config.json +npx whats-new api-extractor-inputs-outlook-release/outlook_1_14/outlook.d.ts api-extractor-inputs-outlook-release/outlook_1_13/outlook.d.ts ../docs/includes/outlook-1_14 javascript/api/outlook/ configs/outlook-1.14-config.json +npx whats-new api-extractor-inputs-outlook-release/outlook_1_13/outlook.d.ts api-extractor-inputs-outlook-release/outlook_1_12/outlook.d.ts ../docs/includes/outlook-1_13 javascript/api/outlook/ configs/outlook-1.13-config.json +npx whats-new api-extractor-inputs-outlook-release/outlook_1_12/outlook.d.ts api-extractor-inputs-outlook-release/outlook_1_11/outlook.d.ts ../docs/includes/outlook-1_12 javascript/api/outlook/ configs/outlook-1.12-config.json +npx whats-new api-extractor-inputs-outlook-release/outlook_1_11/outlook.d.ts api-extractor-inputs-outlook-release/outlook_1_10/outlook.d.ts ../docs/includes/outlook-1_11 javascript/api/outlook/ configs/outlook-1.11-config.json +npx whats-new api-extractor-inputs-outlook-release/outlook_1_10/outlook.d.ts api-extractor-inputs-outlook-release/outlook_1_9/outlook.d.ts ../docs/includes/outlook-1_10 javascript/api/outlook/ configs/outlook-1.10-config.json +npx whats-new api-extractor-inputs-outlook-release/outlook_1_9/outlook.d.ts api-extractor-inputs-outlook-release/outlook_1_8/outlook.d.ts ../docs/includes/outlook-1_9 javascript/api/outlook/ configs/outlook-1.9-config.json +npx whats-new api-extractor-inputs-outlook-release/outlook_1_8/outlook.d.ts api-extractor-inputs-outlook-release/outlook_1_7/outlook.d.ts ../docs/includes/outlook-1_8 javascript/api/outlook/ configs/outlook-1.8-config.json +npx whats-new api-extractor-inputs-outlook-release/outlook_1_7/outlook.d.ts api-extractor-inputs-outlook-release/outlook_1_6/outlook.d.ts ../docs/includes/outlook-1_7 javascript/api/outlook/ configs/outlook-1.7-config.json +npx whats-new api-extractor-inputs-outlook-release/outlook_1_6/outlook.d.ts api-extractor-inputs-outlook-release/outlook_1_5/outlook.d.ts ../docs/includes/outlook-1_6 javascript/api/outlook/ configs/outlook-1.6-config.json +npx whats-new api-extractor-inputs-outlook-release/outlook_1_5/outlook.d.ts api-extractor-inputs-outlook-release/outlook_1_4/outlook.d.ts ../docs/includes/outlook-1_5 javascript/api/outlook/ configs/outlook-1.5-config.json +npx whats-new api-extractor-inputs-outlook-release/outlook_1_4/outlook.d.ts api-extractor-inputs-outlook-release/outlook_1_3/outlook.d.ts ../docs/includes/outlook-1_4 javascript/api/outlook/ configs/outlook-1.4-config.json +npx whats-new api-extractor-inputs-outlook-release/outlook_1_3/outlook.d.ts api-extractor-inputs-outlook-release/outlook_1_2/outlook.d.ts ../docs/includes/outlook-1_3 javascript/api/outlook/ configs/outlook-1.3-config.json +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-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 +npx whats-new api-extractor-inputs-powerpoint-release/powerpoint_1_6/powerpoint.d.ts api-extractor-inputs-powerpoint-release/powerpoint_1_5/powerpoint.d.ts ../docs/includes/powerpoint-1_6 javascript/api/powerpoint/ configs/powerpoint-1_6-config.json +npx whats-new api-extractor-inputs-powerpoint-release/powerpoint_1_5/powerpoint.d.ts api-extractor-inputs-powerpoint-release/powerpoint_1_4/powerpoint.d.ts ../docs/includes/powerpoint-1_5 javascript/api/powerpoint/ configs/powerpoint-1_5-config.json +npx whats-new api-extractor-inputs-powerpoint-release/powerpoint_1_4/powerpoint.d.ts api-extractor-inputs-powerpoint-release/powerpoint_1_3/powerpoint.d.ts ../docs/includes/powerpoint-1_4 javascript/api/powerpoint/ configs/powerpoint-1_4-config.json +npx whats-new api-extractor-inputs-powerpoint-release/powerpoint_1_3/powerpoint.d.ts api-extractor-inputs-powerpoint-release/powerpoint_1_2/powerpoint.d.ts ../docs/includes/powerpoint-1_3 javascript/api/powerpoint/ configs/powerpoint-1_3-config.json +npx whats-new api-extractor-inputs-powerpoint-release/powerpoint_1_2/powerpoint.d.ts api-extractor-inputs-powerpoint-release/powerpoint_1_1/powerpoint.d.ts ../docs/includes/powerpoint-1_2 javascript/api/powerpoint/ configs/powerpoint-1_2-config.json +npx whats-new api-extractor-inputs-powerpoint-release/powerpoint_1_1/powerpoint.d.ts ./tool-inputs/powerpoint-base.d.ts ../docs/includes/powerpoint-1_1 javascript/api/powerpoint/ configs/powerpoint-1_1-config.json + +npx whats-new api-extractor-inputs-word/word.d.ts api-extractor-inputs-word-release/word_online/word-init.d.ts ../docs/includes/word-preview javascript/api/word/ configs/word-preview-config.json +npx whats-new api-extractor-inputs-word-release/word_online/word.d.ts api-extractor-inputs-word-release/word_1_9/word.d.ts ../docs/includes/word-online javascript/api/word/ configs/word-online-config.json +npx whats-new api-extractor-inputs-word-release/word_desktop_1_2/word.d.ts api-extractor-inputs-word-release/word_desktop_1_1/word.d.ts ../docs/includes/word-desktop-1_2 javascript/api/word/ configs/word-desktop-1_2-config.json +npx whats-new api-extractor-inputs-word-release/word_desktop_1_1/word.d.ts api-extractor-inputs-word-release/word_1_8/word.d.ts ../docs/includes/word-desktop-1_1 javascript/api/word/ configs/word-desktop-1_1-config.json +npx whats-new api-extractor-inputs-word-release/word_1_5_hidden_document/word.d.ts api-extractor-inputs-word-release/word_1_4_hidden_document/word-desktop1.d.ts ../docs/includes/word-1_5_hidden_document javascript/api/word/ configs/word-1_5_hidden_document-config.json +npx whats-new api-extractor-inputs-word-release/word_1_4_hidden_document/word.d.ts api-extractor-inputs-word-release/word_1_3_hidden_document/word-desktop1.d.ts ../docs/includes/word-1_4_hidden_document javascript/api/word/ configs/word-1_4_hidden_document-config.json +npx whats-new api-extractor-inputs-word-release/word_1_3_hidden_document/word.d.ts api-extractor-inputs-word-release/word_1_3/word.d.ts ../docs/includes/word-1_3_hidden_document javascript/api/word/ configs/word-1_3_hidden_document-config.json +npx whats-new api-extractor-inputs-word-release/word_1_9/word.d.ts api-extractor-inputs-word-release/word_1_8/word.d.ts ../docs/includes/word-1_9 javascript/api/word/ configs/word-1_9-config.json +npx whats-new api-extractor-inputs-word-release/word_1_8/word.d.ts api-extractor-inputs-word-release/word_1_7/word.d.ts ../docs/includes/word-1_8 javascript/api/word/ configs/word-1_8-config.json +npx whats-new api-extractor-inputs-word-release/word_1_7/word.d.ts api-extractor-inputs-word-release/word_1_6/word.d.ts ../docs/includes/word-1_7 javascript/api/word/ configs/word-1_7-config.json +npx whats-new api-extractor-inputs-word-release/word_1_6/word.d.ts api-extractor-inputs-word-release/word_1_5/word.d.ts ../docs/includes/word-1_6 javascript/api/word/ configs/word-1_6-config.json +npx whats-new api-extractor-inputs-word-release/word_1_5/word.d.ts api-extractor-inputs-word-release/word_1_4/word.d.ts ../docs/includes/word-1_5 javascript/api/word/ configs/word-1_5-config.json +npx whats-new api-extractor-inputs-word-release/word_1_4/word.d.ts api-extractor-inputs-word-release/word_1_3/word.d.ts ../docs/includes/word-1_4 javascript/api/word/ configs/word-1_4-config.json +npx whats-new api-extractor-inputs-word-release/word_1_3/word.d.ts api-extractor-inputs-word-release/word_1_2/word.d.ts ../docs/includes/word-1_3 javascript/api/word/ configs/word-1_3-config.json +npx whats-new api-extractor-inputs-word-release/word_1_2/word.d.ts api-extractor-inputs-word-release/word_1_1/word.d.ts ../docs/includes/word-1_2 javascript/api/word/ configs/word-1_2-config.json +npx whats-new api-extractor-inputs-word-release/word_1_1/word.d.ts ./tool-inputs/word-base.d.ts ../docs/includes/word-1_1 javascript/api/word/ configs/word-1_1-config.json popd diff --git a/generate-docs/configs/excel-1_1-config.json b/generate-docs/configs/excel-1_1-config.json new file mode 100644 index 0000000000..73079ddf18 --- /dev/null +++ b/generate-docs/configs/excel-1_1-config.json @@ -0,0 +1,19 @@ +{ + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false +} \ No newline at end of file diff --git a/generate-docs/configs/excel-1_10-config.json b/generate-docs/configs/excel-1_10-config.json new file mode 100644 index 0000000000..949dd854ab --- /dev/null +++ b/generate-docs/configs/excel-1_10-config.json @@ -0,0 +1,19 @@ +{ + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false +} diff --git a/generate-docs/configs/excel-1_11-config.json b/generate-docs/configs/excel-1_11-config.json index 9b5be97199..2f9837a9b2 100644 --- a/generate-docs/configs/excel-1_11-config.json +++ b/generate-docs/configs/excel-1_11-config.json @@ -5,5 +5,22 @@ "replace": "content: string,", "description": "Address CommentRichContent reference for when removing ExcelApi 1.11" } - ] + ], + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false } diff --git a/generate-docs/configs/excel-1_12-config.json b/generate-docs/configs/excel-1_12-config.json new file mode 100644 index 0000000000..949dd854ab --- /dev/null +++ b/generate-docs/configs/excel-1_12-config.json @@ -0,0 +1,19 @@ +{ + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false +} diff --git a/generate-docs/configs/excel-1_13-config.json b/generate-docs/configs/excel-1_13-config.json new file mode 100644 index 0000000000..949dd854ab --- /dev/null +++ b/generate-docs/configs/excel-1_13-config.json @@ -0,0 +1,19 @@ +{ + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false +} diff --git a/generate-docs/configs/excel-1_14-config.json b/generate-docs/configs/excel-1_14-config.json new file mode 100644 index 0000000000..949dd854ab --- /dev/null +++ b/generate-docs/configs/excel-1_14-config.json @@ -0,0 +1,19 @@ +{ + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false +} diff --git a/generate-docs/configs/excel-1_15-config.json b/generate-docs/configs/excel-1_15-config.json new file mode 100644 index 0000000000..949dd854ab --- /dev/null +++ b/generate-docs/configs/excel-1_15-config.json @@ -0,0 +1,19 @@ +{ + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false +} diff --git a/generate-docs/configs/excel-1_16-config.json b/generate-docs/configs/excel-1_16-config.json new file mode 100644 index 0000000000..949dd854ab --- /dev/null +++ b/generate-docs/configs/excel-1_16-config.json @@ -0,0 +1,19 @@ +{ + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false +} diff --git a/generate-docs/configs/excel-1_17-config.json b/generate-docs/configs/excel-1_17-config.json new file mode 100644 index 0000000000..949dd854ab --- /dev/null +++ b/generate-docs/configs/excel-1_17-config.json @@ -0,0 +1,19 @@ +{ + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false +} diff --git a/generate-docs/configs/excel-1_18-config.json b/generate-docs/configs/excel-1_18-config.json new file mode 100644 index 0000000000..949dd854ab --- /dev/null +++ b/generate-docs/configs/excel-1_18-config.json @@ -0,0 +1,19 @@ +{ + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false +} diff --git a/generate-docs/configs/excel-1_19-config.json b/generate-docs/configs/excel-1_19-config.json index b3340ec2fe..1ffeb5cd7e 100644 --- a/generate-docs/configs/excel-1_19-config.json +++ b/generate-docs/configs/excel-1_19-config.json @@ -15,5 +15,22 @@ "replace": "type CellValue = (ArrayCellValue | BooleanCellValue | DoubleCellValue | EntityCellValue | EmptyCellValue | ErrorCellValue | LinkedEntityCellValue | ReferenceCellValue | StringCellValue | ValueTypeNotAvailableCellValue | WebImageCellValue) & CellValueExtraProperties;", "description": "Remove FormattedNumberCellValue from CellValue union type" } - ] + ], + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false } diff --git a/generate-docs/configs/excel-1_2-config.json b/generate-docs/configs/excel-1_2-config.json new file mode 100644 index 0000000000..73079ddf18 --- /dev/null +++ b/generate-docs/configs/excel-1_2-config.json @@ -0,0 +1,19 @@ +{ + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false +} \ No newline at end of file diff --git a/generate-docs/configs/excel-1_20-config.json b/generate-docs/configs/excel-1_20-config.json new file mode 100644 index 0000000000..949dd854ab --- /dev/null +++ b/generate-docs/configs/excel-1_20-config.json @@ -0,0 +1,19 @@ +{ + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false +} diff --git a/generate-docs/configs/excel-1_3-config.json b/generate-docs/configs/excel-1_3-config.json new file mode 100644 index 0000000000..73079ddf18 --- /dev/null +++ b/generate-docs/configs/excel-1_3-config.json @@ -0,0 +1,19 @@ +{ + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false +} \ No newline at end of file diff --git a/generate-docs/configs/excel-1_4-config.json b/generate-docs/configs/excel-1_4-config.json new file mode 100644 index 0000000000..949dd854ab --- /dev/null +++ b/generate-docs/configs/excel-1_4-config.json @@ -0,0 +1,19 @@ +{ + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false +} diff --git a/generate-docs/configs/excel-1_5-config.json b/generate-docs/configs/excel-1_5-config.json new file mode 100644 index 0000000000..949dd854ab --- /dev/null +++ b/generate-docs/configs/excel-1_5-config.json @@ -0,0 +1,19 @@ +{ + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false +} diff --git a/generate-docs/configs/excel-1_6-config.json b/generate-docs/configs/excel-1_6-config.json new file mode 100644 index 0000000000..949dd854ab --- /dev/null +++ b/generate-docs/configs/excel-1_6-config.json @@ -0,0 +1,19 @@ +{ + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false +} diff --git a/generate-docs/configs/excel-1_7-config.json b/generate-docs/configs/excel-1_7-config.json new file mode 100644 index 0000000000..949dd854ab --- /dev/null +++ b/generate-docs/configs/excel-1_7-config.json @@ -0,0 +1,19 @@ +{ + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false +} diff --git a/generate-docs/configs/excel-1_8-config.json b/generate-docs/configs/excel-1_8-config.json new file mode 100644 index 0000000000..949dd854ab --- /dev/null +++ b/generate-docs/configs/excel-1_8-config.json @@ -0,0 +1,19 @@ +{ + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false +} diff --git a/generate-docs/configs/excel-1_9-config.json b/generate-docs/configs/excel-1_9-config.json new file mode 100644 index 0000000000..949dd854ab --- /dev/null +++ b/generate-docs/configs/excel-1_9-config.json @@ -0,0 +1,19 @@ +{ + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false +} diff --git a/generate-docs/configs/excel-online-config.json b/generate-docs/configs/excel-online-config.json new file mode 100644 index 0000000000..73079ddf18 --- /dev/null +++ b/generate-docs/configs/excel-online-config.json @@ -0,0 +1,19 @@ +{ + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false +} \ No newline at end of file diff --git a/generate-docs/configs/excel-preview-config.json b/generate-docs/configs/excel-preview-config.json new file mode 100644 index 0000000000..73079ddf18 --- /dev/null +++ b/generate-docs/configs/excel-preview-config.json @@ -0,0 +1,19 @@ +{ + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false +} \ No newline at end of file diff --git a/generate-docs/configs/officescript-preview-config.json b/generate-docs/configs/officescript-preview-config.json new file mode 100644 index 0000000000..0385017d61 --- /dev/null +++ b/generate-docs/configs/officescript-preview-config.json @@ -0,0 +1,12 @@ +{ + "excludedFieldPatterns": [ + "toJSON", + "^_" + ], + "excludedFieldNames": [ + "context", + "isNullObject" + ], + "includeStaticFields": false, + "includeEnums": false +} \ No newline at end of file diff --git a/generate-docs/configs/outlook-1.1-config.json b/generate-docs/configs/outlook-1.1-config.json index 21b749dafd..f826e92a99 100644 --- a/generate-docs/configs/outlook-1.1-config.json +++ b/generate-docs/configs/outlook-1.1-config.json @@ -6,5 +6,7 @@ "isRegex": true, "description": "Update Outlook requirement set URL references to version 1.1" } - ] + ], + "includeStaticFields": false, + "includeEnums": false } diff --git a/generate-docs/configs/outlook-1.10-config.json b/generate-docs/configs/outlook-1.10-config.json index 5c75df7e02..dc4252fbcf 100644 --- a/generate-docs/configs/outlook-1.10-config.json +++ b/generate-docs/configs/outlook-1.10-config.json @@ -1,9 +1,11 @@ { - "replacements": [ - { - "find": "outlook/requirement-set-1.10", - "replace": "outlook/requirement-set-1.9", - "description": "Fix requirement set references in outlook_1_10 baseline to match filename" - } - ] + "replacements": [ + { + "find": "outlook/requirement-set-1.10", + "replace": "outlook/requirement-set-1.9", + "description": "Fix requirement set references in outlook_1_10 baseline to match filename" + } + ], + "includeStaticFields": false, + "includeEnums": false } diff --git a/generate-docs/configs/outlook-1.11-config.json b/generate-docs/configs/outlook-1.11-config.json index ea87f04cad..8bf2011ddf 100644 --- a/generate-docs/configs/outlook-1.11-config.json +++ b/generate-docs/configs/outlook-1.11-config.json @@ -1,9 +1,11 @@ { - "replacements": [ - { - "find": "outlook/requirement-set-1.11", - "replace": "outlook/requirement-set-1.10", - "description": "Fix requirement set references in outlook_1_11 baseline to match filename" - } - ] + "replacements": [ + { + "find": "outlook/requirement-set-1.11", + "replace": "outlook/requirement-set-1.10", + "description": "Fix requirement set references in outlook_1_11 baseline to match filename" + } + ], + "includeStaticFields": false, + "includeEnums": false } diff --git a/generate-docs/configs/outlook-1.12-config.json b/generate-docs/configs/outlook-1.12-config.json index 0a18f281f6..3528f8abd4 100644 --- a/generate-docs/configs/outlook-1.12-config.json +++ b/generate-docs/configs/outlook-1.12-config.json @@ -1,19 +1,21 @@ { - "replacements": [ - { - "find": "outlook/requirement-set-1.12", - "replace": "outlook/requirement-set-1.11", - "description": "Fix requirement set references in outlook_1_12 baseline to match filename" - }, - { - "find": "options?: SmartAlertsEventCompletedOptions", - "replace": "", - "description": "Address SmartAlertsEventCompletedOptions reference when removing Mailbox 1.12" - }, - { - "find": "@param options - Optional. An object that specifies the behavior of an event-based or spam-reporting add-in when it completes processing an event.", - "replace": "", - "description": "Remove @param options documentation when removing Mailbox 1.12" - } - ] + "replacements": [ + { + "find": "outlook/requirement-set-1.12", + "replace": "outlook/requirement-set-1.11", + "description": "Fix requirement set references in outlook_1_12 baseline to match filename" + }, + { + "find": "options?: SmartAlertsEventCompletedOptions", + "replace": "", + "description": "Address SmartAlertsEventCompletedOptions reference when removing Mailbox 1.12" + }, + { + "find": "@param options - Optional. An object that specifies the behavior of an event-based or spam-reporting add-in when it completes processing an event.", + "replace": "", + "description": "Remove @param options documentation when removing Mailbox 1.12" + } + ], + "includeStaticFields": false, + "includeEnums": false } diff --git a/generate-docs/configs/outlook-1.13-config.json b/generate-docs/configs/outlook-1.13-config.json index 63d394b74a..30c587a923 100644 --- a/generate-docs/configs/outlook-1.13-config.json +++ b/generate-docs/configs/outlook-1.13-config.json @@ -1,9 +1,11 @@ { - "replacements": [ - { - "find": "outlook/requirement-set-1.13", - "replace": "outlook/requirement-set-1.12", - "description": "Fix requirement set references in outlook_1_13 baseline to match filename" - } - ] + "replacements": [ + { + "find": "outlook/requirement-set-1.13", + "replace": "outlook/requirement-set-1.12", + "description": "Fix requirement set references in outlook_1_13 baseline to match filename" + } + ], + "includeStaticFields": false, + "includeEnums": false } diff --git a/generate-docs/configs/outlook-1.14-config.json b/generate-docs/configs/outlook-1.14-config.json index d0d339fd99..9fa4cd1ce1 100644 --- a/generate-docs/configs/outlook-1.14-config.json +++ b/generate-docs/configs/outlook-1.14-config.json @@ -1,14 +1,16 @@ { - "replacements": [ - { - "find": "outlook/requirement-set-1.14", - "replace": "outlook/requirement-set-1.13", - "description": "Fix requirement set references in outlook_1_14 baseline to match filename" - }, - { - "find": "options?: SmartAlertsEventCompletedOptions | SpamReportingEventCompletedOptions", - "replace": "options?: SmartAlertsEventCompletedOptions", - "description": "Address SpamReportingEventCompletedOptions reference when removing Mailbox 1.14" - } - ] + "replacements": [ + { + "find": "outlook/requirement-set-1.14", + "replace": "outlook/requirement-set-1.13", + "description": "Fix requirement set references in outlook_1_14 baseline to match filename" + }, + { + "find": "options?: SmartAlertsEventCompletedOptions | SpamReportingEventCompletedOptions", + "replace": "options?: SmartAlertsEventCompletedOptions", + "description": "Address SpamReportingEventCompletedOptions reference when removing Mailbox 1.14" + } + ], + "includeStaticFields": false, + "includeEnums": false } diff --git a/generate-docs/configs/outlook-1.15-config.json b/generate-docs/configs/outlook-1.15-config.json index d9a81c43fd..172a20a80b 100644 --- a/generate-docs/configs/outlook-1.15-config.json +++ b/generate-docs/configs/outlook-1.15-config.json @@ -1,9 +1,11 @@ { - "replacements": [ - { - "find": "outlook/requirement-set-1.15", - "replace": "outlook/requirement-set-1.14", - "description": "Fix requirement set references in outlook_1_15 baseline to match filename" - } - ] + "replacements": [ + { + "find": "outlook/requirement-set-1.15", + "replace": "outlook/requirement-set-1.14", + "description": "Fix requirement set references in outlook_1_15 baseline to match filename" + } + ], + "includeStaticFields": false, + "includeEnums": false } diff --git a/generate-docs/configs/outlook-1.2-config.json b/generate-docs/configs/outlook-1.2-config.json index 877466aca2..0b9ef61b5a 100644 --- a/generate-docs/configs/outlook-1.2-config.json +++ b/generate-docs/configs/outlook-1.2-config.json @@ -1,9 +1,11 @@ { - "replacements": [ - { - "find": "outlook/requirement-set-1.2", - "replace": "outlook/requirement-set-1.1", - "description": "Fix requirement set references in outlook_1_2 baseline to match filename" - } - ] + "replacements": [ + { + "find": "outlook/requirement-set-1.2", + "replace": "outlook/requirement-set-1.1", + "description": "Fix requirement set references in outlook_1_2 baseline to match filename" + } + ], + "includeStaticFields": false, + "includeEnums": false } diff --git a/generate-docs/configs/outlook-1.3-config.json b/generate-docs/configs/outlook-1.3-config.json index 1463fa0bbd..dc38099bc9 100644 --- a/generate-docs/configs/outlook-1.3-config.json +++ b/generate-docs/configs/outlook-1.3-config.json @@ -1,9 +1,11 @@ { - "replacements": [ - { - "find": "outlook/requirement-set-1.3", - "replace": "outlook/requirement-set-1.2", - "description": "Fix requirement set references in outlook_1_3 baseline to match filename" - } - ] + "replacements": [ + { + "find": "outlook/requirement-set-1.3", + "replace": "outlook/requirement-set-1.2", + "description": "Fix requirement set references in outlook_1_3 baseline to match filename" + } + ], + "includeStaticFields": false, + "includeEnums": false } diff --git a/generate-docs/configs/outlook-1.4-config.json b/generate-docs/configs/outlook-1.4-config.json index 38c3366f15..cd3050bae1 100644 --- a/generate-docs/configs/outlook-1.4-config.json +++ b/generate-docs/configs/outlook-1.4-config.json @@ -1,9 +1,11 @@ { - "replacements": [ - { - "find": "outlook/requirement-set-1.4", - "replace": "outlook/requirement-set-1.3", - "description": "Fix requirement set references in outlook_1_4 baseline to match filename" - } - ] + "replacements": [ + { + "find": "outlook/requirement-set-1.4", + "replace": "outlook/requirement-set-1.3", + "description": "Fix requirement set references in outlook_1_4 baseline to match filename" + } + ], + "includeStaticFields": false, + "includeEnums": false } diff --git a/generate-docs/configs/outlook-1.5-config.json b/generate-docs/configs/outlook-1.5-config.json index 9c864239db..86e4b426d8 100644 --- a/generate-docs/configs/outlook-1.5-config.json +++ b/generate-docs/configs/outlook-1.5-config.json @@ -1,9 +1,11 @@ { - "replacements": [ - { - "find": "outlook/requirement-set-1.5", - "replace": "outlook/requirement-set-1.4", - "description": "Fix requirement set references in outlook_1_5 baseline to match filename" - } - ] + "replacements": [ + { + "find": "outlook/requirement-set-1.5", + "replace": "outlook/requirement-set-1.4", + "description": "Fix requirement set references in outlook_1_5 baseline to match filename" + } + ], + "includeStaticFields": false, + "includeEnums": false } diff --git a/generate-docs/configs/outlook-1.6-config.json b/generate-docs/configs/outlook-1.6-config.json index 229afbf64d..8b43373f82 100644 --- a/generate-docs/configs/outlook-1.6-config.json +++ b/generate-docs/configs/outlook-1.6-config.json @@ -1,9 +1,11 @@ { - "replacements": [ - { - "find": "outlook/requirement-set-1.6", - "replace": "outlook/requirement-set-1.5", - "description": "Fix requirement set references in outlook_1_6 baseline to match filename" - } - ] + "replacements": [ + { + "find": "outlook/requirement-set-1.6", + "replace": "outlook/requirement-set-1.5", + "description": "Fix requirement set references in outlook_1_6 baseline to match filename" + } + ], + "includeStaticFields": false, + "includeEnums": false } diff --git a/generate-docs/configs/outlook-1.7-config.json b/generate-docs/configs/outlook-1.7-config.json index 7246f89426..bd759355e1 100644 --- a/generate-docs/configs/outlook-1.7-config.json +++ b/generate-docs/configs/outlook-1.7-config.json @@ -1,9 +1,11 @@ { - "replacements": [ - { - "find": "outlook/requirement-set-1.7", - "replace": "outlook/requirement-set-1.6", - "description": "Fix requirement set references in outlook_1_7 baseline to match filename" - } - ] + "replacements": [ + { + "find": "outlook/requirement-set-1.7", + "replace": "outlook/requirement-set-1.6", + "description": "Fix requirement set references in outlook_1_7 baseline to match filename" + } + ], + "includeStaticFields": false, + "includeEnums": false } diff --git a/generate-docs/configs/outlook-1.8-config.json b/generate-docs/configs/outlook-1.8-config.json index 7ea33b87d9..e9044d6383 100644 --- a/generate-docs/configs/outlook-1.8-config.json +++ b/generate-docs/configs/outlook-1.8-config.json @@ -1,9 +1,11 @@ { - "replacements": [ - { - "find": "outlook/requirement-set-1.8", - "replace": "outlook/requirement-set-1.7", - "description": "Fix requirement set references in outlook_1_8 baseline to match filename" - } - ] + "replacements": [ + { + "find": "outlook/requirement-set-1.8", + "replace": "outlook/requirement-set-1.7", + "description": "Fix requirement set references in outlook_1_8 baseline to match filename" + } + ], + "includeStaticFields": false, + "includeEnums": false } diff --git a/generate-docs/configs/outlook-1.9-config.json b/generate-docs/configs/outlook-1.9-config.json index 11a301b339..d8e6890716 100644 --- a/generate-docs/configs/outlook-1.9-config.json +++ b/generate-docs/configs/outlook-1.9-config.json @@ -1,9 +1,11 @@ { - "replacements": [ - { - "find": "outlook/requirement-set-1.9", - "replace": "outlook/requirement-set-1.8", - "description": "Fix requirement set references in outlook_1_9 baseline to match filename" - } - ] + "replacements": [ + { + "find": "outlook/requirement-set-1.9", + "replace": "outlook/requirement-set-1.8", + "description": "Fix requirement set references in outlook_1_9 baseline to match filename" + } + ], + "includeStaticFields": false, + "includeEnums": false } diff --git a/generate-docs/configs/outlook-preview-config.json b/generate-docs/configs/outlook-preview-config.json new file mode 100644 index 0000000000..0385017d61 --- /dev/null +++ b/generate-docs/configs/outlook-preview-config.json @@ -0,0 +1,12 @@ +{ + "excludedFieldPatterns": [ + "toJSON", + "^_" + ], + "excludedFieldNames": [ + "context", + "isNullObject" + ], + "includeStaticFields": false, + "includeEnums": false +} \ No newline at end of file diff --git a/generate-docs/configs/powerpoint-1_1-config.json b/generate-docs/configs/powerpoint-1_1-config.json new file mode 100644 index 0000000000..5940f0d0a5 --- /dev/null +++ b/generate-docs/configs/powerpoint-1_1-config.json @@ -0,0 +1,19 @@ +{ + "excludedFieldPatterns": [ + "\\w+\\??:\\s*\".*\"" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false +} diff --git a/generate-docs/configs/powerpoint-1_2-config.json b/generate-docs/configs/powerpoint-1_2-config.json new file mode 100644 index 0000000000..5940f0d0a5 --- /dev/null +++ b/generate-docs/configs/powerpoint-1_2-config.json @@ -0,0 +1,19 @@ +{ + "excludedFieldPatterns": [ + "\\w+\\??:\\s*\".*\"" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false +} diff --git a/generate-docs/configs/powerpoint-1_3-config.json b/generate-docs/configs/powerpoint-1_3-config.json new file mode 100644 index 0000000000..5940f0d0a5 --- /dev/null +++ b/generate-docs/configs/powerpoint-1_3-config.json @@ -0,0 +1,19 @@ +{ + "excludedFieldPatterns": [ + "\\w+\\??:\\s*\".*\"" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false +} diff --git a/generate-docs/configs/powerpoint-1_4-config.json b/generate-docs/configs/powerpoint-1_4-config.json new file mode 100644 index 0000000000..5940f0d0a5 --- /dev/null +++ b/generate-docs/configs/powerpoint-1_4-config.json @@ -0,0 +1,19 @@ +{ + "excludedFieldPatterns": [ + "\\w+\\??:\\s*\".*\"" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false +} diff --git a/generate-docs/configs/powerpoint-1_5-config.json b/generate-docs/configs/powerpoint-1_5-config.json new file mode 100644 index 0000000000..5940f0d0a5 --- /dev/null +++ b/generate-docs/configs/powerpoint-1_5-config.json @@ -0,0 +1,19 @@ +{ + "excludedFieldPatterns": [ + "\\w+\\??:\\s*\".*\"" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false +} diff --git a/generate-docs/configs/powerpoint-1_6-config.json b/generate-docs/configs/powerpoint-1_6-config.json new file mode 100644 index 0000000000..5940f0d0a5 --- /dev/null +++ b/generate-docs/configs/powerpoint-1_6-config.json @@ -0,0 +1,19 @@ +{ + "excludedFieldPatterns": [ + "\\w+\\??:\\s*\".*\"" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false +} diff --git a/generate-docs/configs/powerpoint-1_7-config.json b/generate-docs/configs/powerpoint-1_7-config.json new file mode 100644 index 0000000000..5940f0d0a5 --- /dev/null +++ b/generate-docs/configs/powerpoint-1_7-config.json @@ -0,0 +1,19 @@ +{ + "excludedFieldPatterns": [ + "\\w+\\??:\\s*\".*\"" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false +} diff --git a/generate-docs/configs/powerpoint-1_8-config.json b/generate-docs/configs/powerpoint-1_8-config.json new file mode 100644 index 0000000000..5940f0d0a5 --- /dev/null +++ b/generate-docs/configs/powerpoint-1_8-config.json @@ -0,0 +1,19 @@ +{ + "excludedFieldPatterns": [ + "\\w+\\??:\\s*\".*\"" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false +} diff --git a/generate-docs/configs/powerpoint-1_9-config.json b/generate-docs/configs/powerpoint-1_9-config.json new file mode 100644 index 0000000000..5940f0d0a5 --- /dev/null +++ b/generate-docs/configs/powerpoint-1_9-config.json @@ -0,0 +1,19 @@ +{ + "excludedFieldPatterns": [ + "\\w+\\??:\\s*\".*\"" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false +} diff --git a/generate-docs/configs/powerpoint-preview-config.json b/generate-docs/configs/powerpoint-preview-config.json new file mode 100644 index 0000000000..73079ddf18 --- /dev/null +++ b/generate-docs/configs/powerpoint-preview-config.json @@ -0,0 +1,19 @@ +{ + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false +} \ No newline at end of file diff --git a/generate-docs/configs/word-1_1-config.json b/generate-docs/configs/word-1_1-config.json new file mode 100644 index 0000000000..949dd854ab --- /dev/null +++ b/generate-docs/configs/word-1_1-config.json @@ -0,0 +1,19 @@ +{ + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false +} diff --git a/generate-docs/configs/word-1_2-config.json b/generate-docs/configs/word-1_2-config.json new file mode 100644 index 0000000000..949dd854ab --- /dev/null +++ b/generate-docs/configs/word-1_2-config.json @@ -0,0 +1,19 @@ +{ + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false +} diff --git a/generate-docs/configs/word-1_3-config.json b/generate-docs/configs/word-1_3-config.json new file mode 100644 index 0000000000..949dd854ab --- /dev/null +++ b/generate-docs/configs/word-1_3-config.json @@ -0,0 +1,19 @@ +{ + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false +} diff --git a/generate-docs/configs/word-1_3_hidden_document-config.json b/generate-docs/configs/word-1_3_hidden_document-config.json new file mode 100644 index 0000000000..73079ddf18 --- /dev/null +++ b/generate-docs/configs/word-1_3_hidden_document-config.json @@ -0,0 +1,19 @@ +{ + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false +} \ No newline at end of file diff --git a/generate-docs/configs/word-1_4-config.json b/generate-docs/configs/word-1_4-config.json new file mode 100644 index 0000000000..949dd854ab --- /dev/null +++ b/generate-docs/configs/word-1_4-config.json @@ -0,0 +1,19 @@ +{ + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false +} diff --git a/generate-docs/configs/word-1_4_hidden_document-config.json b/generate-docs/configs/word-1_4_hidden_document-config.json new file mode 100644 index 0000000000..73079ddf18 --- /dev/null +++ b/generate-docs/configs/word-1_4_hidden_document-config.json @@ -0,0 +1,19 @@ +{ + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false +} \ No newline at end of file diff --git a/generate-docs/configs/word-1_5-config.json b/generate-docs/configs/word-1_5-config.json new file mode 100644 index 0000000000..949dd854ab --- /dev/null +++ b/generate-docs/configs/word-1_5-config.json @@ -0,0 +1,19 @@ +{ + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false +} diff --git a/generate-docs/configs/word-1_5_hidden_document-config.json b/generate-docs/configs/word-1_5_hidden_document-config.json new file mode 100644 index 0000000000..73079ddf18 --- /dev/null +++ b/generate-docs/configs/word-1_5_hidden_document-config.json @@ -0,0 +1,19 @@ +{ + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false +} \ No newline at end of file diff --git a/generate-docs/configs/word-1_6-config.json b/generate-docs/configs/word-1_6-config.json new file mode 100644 index 0000000000..949dd854ab --- /dev/null +++ b/generate-docs/configs/word-1_6-config.json @@ -0,0 +1,19 @@ +{ + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false +} diff --git a/generate-docs/configs/word-1_7-config.json b/generate-docs/configs/word-1_7-config.json new file mode 100644 index 0000000000..949dd854ab --- /dev/null +++ b/generate-docs/configs/word-1_7-config.json @@ -0,0 +1,19 @@ +{ + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false +} diff --git a/generate-docs/configs/word-1_8-config.json b/generate-docs/configs/word-1_8-config.json new file mode 100644 index 0000000000..949dd854ab --- /dev/null +++ b/generate-docs/configs/word-1_8-config.json @@ -0,0 +1,19 @@ +{ + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false +} diff --git a/generate-docs/configs/word-desktop-1_1-config.json b/generate-docs/configs/word-desktop-1_1-config.json index 7e0c2ed0a1..c1427e89aa 100644 --- a/generate-docs/configs/word-desktop-1_1-config.json +++ b/generate-docs/configs/word-desktop-1_1-config.json @@ -16,5 +16,22 @@ "isRegex": true, "description": "Remove importedStylesConflictBehavior parameter from method signature when removing WordApiDesktop 1.1" } - ] + ], + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false } diff --git a/generate-docs/configs/word-desktop-1_2-config.json b/generate-docs/configs/word-desktop-1_2-config.json new file mode 100644 index 0000000000..73079ddf18 --- /dev/null +++ b/generate-docs/configs/word-desktop-1_2-config.json @@ -0,0 +1,19 @@ +{ + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false +} \ No newline at end of file diff --git a/generate-docs/configs/word-online-config.json b/generate-docs/configs/word-online-config.json new file mode 100644 index 0000000000..73079ddf18 --- /dev/null +++ b/generate-docs/configs/word-online-config.json @@ -0,0 +1,19 @@ +{ + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false +} \ No newline at end of file diff --git a/generate-docs/configs/word-preview-config.json b/generate-docs/configs/word-preview-config.json new file mode 100644 index 0000000000..73079ddf18 --- /dev/null +++ b/generate-docs/configs/word-preview-config.json @@ -0,0 +1,19 @@ +{ + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false +} \ No newline at end of file diff --git a/generate-docs/package-lock.json b/generate-docs/package-lock.json index 56e5a777fe..32ff59054b 100644 --- a/generate-docs/package-lock.json +++ b/generate-docs/package-lock.json @@ -11,7 +11,7 @@ "@microsoft/api-documenter": "^7.26.32", "@microsoft/api-extractor": "^7.52.11", "reference-coverage-tester": "^0.1.0", - "versioned-d.ts-tools": "^0.6.0" + "versioned-d.ts-tools": "^0.7.0" } }, "node_modules/@inquirer/checkbox": { @@ -1153,9 +1153,9 @@ } }, "node_modules/versioned-d.ts-tools": { - "version": "0.6.0", - "resolved": "https://registry.npmjs.org/versioned-d.ts-tools/-/versioned-d.ts-tools-0.6.0.tgz", - "integrity": "sha512-SigG33UdcZ+ryd9dEfJnWeyghyL9PDV4rKwirh1GCLOASGZscueawzmsWFneHJqqbxRzL0m6FCquLadn7YEvKA==", + "version": "0.7.0", + "resolved": "https://registry.npmjs.org/versioned-d.ts-tools/-/versioned-d.ts-tools-0.7.0.tgz", + "integrity": "sha512-+DjlMEI6fb9SzjublwAI+5Pl62uEv5yRixH865pB/P8rG9xKXEFM51GC9pL5xkicGEwi/KDT3S0LQSFLY+XpdQ==", "license": "MIT", "dependencies": { "fs-extra": "3.0.1", diff --git a/generate-docs/package.json b/generate-docs/package.json index 669bd02035..4c6d052b88 100644 --- a/generate-docs/package.json +++ b/generate-docs/package.json @@ -5,6 +5,6 @@ "@microsoft/api-extractor": "^7.52.11", "@microsoft/api-documenter": "^7.26.32", "reference-coverage-tester": "^0.1.0", - "versioned-d.ts-tools": "^0.6.0" + "versioned-d.ts-tools": "^0.7.0" } } From 0a24d83ddffd70188d2792ca2d420899f80c29f4 Mon Sep 17 00:00:00 2001 From: Alex Jerabek <38896772+AlexJerabek@users.noreply.github.com> Date: Mon, 15 Sep 2025 14:23:38 -0700 Subject: [PATCH 2/5] Update tool output --- .../excel/excel/excel.cardlayout.yml | 11 +- .../excel/excel/excel.cardlayoutsection.yml | 12 +- .../excel/excel/excel.cellcontrol.yml | 42 +- .../excel/excel/excel.cellvalue.yml | 25 +- .../excel.cellvalueandpropertymetadata.yml | 11 +- .../excel/excel/excel.compactlayout.yml | 10 +- .../excel/excel/excel.entitypropertytype.yml | 11 +- .../excel/excel/excel.errorcellvalue.yml | 59 +- .../excel/excel/excel.functioncellvalue.yml | 10 +- .../excel/excel/excel.referencedvalue.yml | 15 +- .../excel_1_16/excel/excel.cardlayout.yml | 10 +- .../excel/excel.cardlayoutsection.yml | 11 +- .../excel_1_16/excel/excel.cellvalue.yml | 21 +- .../excel.cellvalueandpropertymetadata.yml | 11 +- .../excel_1_16/excel/excel.compactlayout.yml | 10 +- .../excel/excel.entitypropertytype.yml | 11 +- .../excel_1_16/excel/excel.errorcellvalue.yml | 57 +- .../excel/excel.referencedvalue.yml | 15 +- .../excel_1_17/excel/excel.cardlayout.yml | 10 +- .../excel/excel.cardlayoutsection.yml | 11 +- .../excel_1_17/excel/excel.cellvalue.yml | 21 +- .../excel.cellvalueandpropertymetadata.yml | 11 +- .../excel_1_17/excel/excel.compactlayout.yml | 10 +- .../excel/excel.entitypropertytype.yml | 11 +- .../excel_1_17/excel/excel.errorcellvalue.yml | 57 +- .../excel/excel.referencedvalue.yml | 15 +- .../excel_1_18/excel/excel.cardlayout.yml | 10 +- .../excel/excel.cardlayoutsection.yml | 11 +- .../excel_1_18/excel/excel.cellcontrol.yml | 42 +- .../excel_1_18/excel/excel.cellvalue.yml | 21 +- .../excel.cellvalueandpropertymetadata.yml | 11 +- .../excel_1_18/excel/excel.compactlayout.yml | 10 +- .../excel/excel.entitypropertytype.yml | 11 +- .../excel_1_18/excel/excel.errorcellvalue.yml | 57 +- .../excel/excel.referencedvalue.yml | 15 +- .../excel_1_19/excel/excel.cardlayout.yml | 10 +- .../excel/excel.cardlayoutsection.yml | 12 +- .../excel_1_19/excel/excel.cellcontrol.yml | 42 +- .../excel_1_19/excel/excel.cellvalue.yml | 23 +- .../excel.cellvalueandpropertymetadata.yml | 11 +- .../excel_1_19/excel/excel.compactlayout.yml | 10 +- .../excel/excel.entitypropertytype.yml | 11 +- .../excel_1_19/excel/excel.errorcellvalue.yml | 57 +- .../excel/excel.functioncellvalue.yml | 10 +- .../excel/excel.referencedvalue.yml | 15 +- .../excel_1_20/excel/excel.cardlayout.yml | 10 +- .../excel/excel.cardlayoutsection.yml | 12 +- .../excel_1_20/excel/excel.cellcontrol.yml | 42 +- .../excel_1_20/excel/excel.cellvalue.yml | 23 +- .../excel.cellvalueandpropertymetadata.yml | 11 +- .../excel_1_20/excel/excel.compactlayout.yml | 10 +- .../excel/excel.entitypropertytype.yml | 11 +- .../excel_1_20/excel/excel.errorcellvalue.yml | 57 +- .../excel/excel.functioncellvalue.yml | 10 +- .../excel/excel.referencedvalue.yml | 15 +- .../excel_online/excel/excel.cardlayout.yml | 10 +- .../excel/excel.cardlayoutsection.yml | 12 +- .../excel_online/excel/excel.cellcontrol.yml | 42 +- .../excel_online/excel/excel.cellvalue.yml | 23 +- .../excel.cellvalueandpropertymetadata.yml | 11 +- .../excel/excel.compactlayout.yml | 10 +- .../excel/excel.entitypropertytype.yml | 11 +- .../excel/excel.errorcellvalue.yml | 57 +- .../excel/excel.functioncellvalue.yml | 10 +- .../excel/excel.referencedvalue.yml | 15 +- docs/includes/excel-1_1.md | 434 ++-- docs/includes/excel-1_10.md | 288 +-- docs/includes/excel-1_11.md | 70 +- docs/includes/excel-1_12.md | 180 +- docs/includes/excel-1_13.md | 54 +- docs/includes/excel-1_14.md | 82 +- docs/includes/excel-1_15.md | 14 +- docs/includes/excel-1_16.md | 370 ++-- docs/includes/excel-1_17.md | 62 +- docs/includes/excel-1_18.md | 52 +- docs/includes/excel-1_19.md | 194 +- docs/includes/excel-1_2.md | 1112 +++++----- docs/includes/excel-1_20.md | 8 +- docs/includes/excel-1_3.md | 66 +- docs/includes/excel-1_4.md | 82 +- docs/includes/excel-1_5.md | 54 +- docs/includes/excel-1_6.md | 220 +- docs/includes/excel-1_7.md | 470 ++-- docs/includes/excel-1_8.md | 498 ++--- docs/includes/excel-1_9.md | 896 ++++---- docs/includes/excel-online.md | 104 +- docs/includes/excel-preview.md | 326 +-- docs/includes/outlook-1_1.md | 168 +- docs/includes/outlook-1_10.md | 44 +- docs/includes/outlook-1_11.md | 12 +- docs/includes/outlook-1_12.md | 6 +- docs/includes/outlook-1_13.md | 58 +- docs/includes/outlook-1_14.md | 66 +- docs/includes/outlook-1_15.md | 184 +- docs/includes/outlook-1_2.md | 16 +- docs/includes/outlook-1_3.md | 58 +- docs/includes/outlook-1_5.md | 31 +- docs/includes/outlook-1_6.md | 12 +- docs/includes/outlook-1_7.md | 142 +- docs/includes/outlook-1_8.md | 188 +- docs/includes/outlook-1_9.md | 38 +- docs/includes/outlook-preview.md | 26 +- docs/includes/powerpoint-1_1.md | 2 +- docs/includes/powerpoint-1_2.md | 24 +- docs/includes/powerpoint-1_3.md | 86 +- docs/includes/powerpoint-1_4.md | 100 +- docs/includes/powerpoint-1_5.md | 56 +- docs/includes/powerpoint-1_6.md | 12 +- docs/includes/powerpoint-1_7.md | 90 +- docs/includes/powerpoint-1_8.md | 224 +- docs/includes/powerpoint-1_9.md | 98 +- docs/includes/powerpoint-preview.md | 130 +- docs/includes/word-1_1.md | 284 +-- docs/includes/word-1_2.md | 28 +- docs/includes/word-1_3.md | 518 ++--- docs/includes/word-1_3_hidden_document.md | 12 +- docs/includes/word-1_4.md | 212 +- docs/includes/word-1_4_hidden_document.md | 10 +- docs/includes/word-1_5.md | 216 +- docs/includes/word-1_5_hidden_document.md | 8 +- docs/includes/word-1_6.md | 88 +- docs/includes/word-1_7.md | 66 +- docs/includes/word-1_8.md | 22 +- docs/includes/word-1_9.md | 76 +- docs/includes/word-desktop-1_1.md | 106 +- docs/includes/word-desktop-1_2.md | 232 +- docs/includes/word-preview.md | 1900 ++++++++--------- 127 files changed, 6897 insertions(+), 5677 deletions(-) diff --git a/docs/docs-ref-autogen/excel/excel/excel.cardlayout.yml b/docs/docs-ref-autogen/excel/excel/excel.cardlayout.yml index 13bd37ee71..ad538d6d8e 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.cardlayout.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.cardlayout.yml @@ -4,7 +4,16 @@ uid: excel!Excel.CardLayout:type package: excel! fullName: Excel.CardLayout summary: Represents the layout of a card in card view. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.EntityCardLayout](/javascript/api/excel/excel.entitycardlayout), [Excel.EntityArrayCardLayout](/javascript/api/excel/excel.entityarraycardlayout)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.EntityCardLayout](/javascript/api/excel/excel.entitycardlayout), + [Excel.EntityArrayCardLayout](/javascript/api/excel/excel.entityarraycardlayout) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel/excel/excel.cardlayoutsection.yml b/docs/docs-ref-autogen/excel/excel/excel.cardlayoutsection.yml index 5491f6727f..cca1b0c56e 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.cardlayoutsection.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.cardlayoutsection.yml @@ -4,7 +4,17 @@ uid: excel!Excel.CardLayoutSection:type package: excel! fullName: Excel.CardLayoutSection summary: Represents the layout of a section of a card in card view. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CardLayoutListSection](/javascript/api/excel/excel.cardlayoutlistsection), [Excel.CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection), [Excel.CardLayoutTwoColumnSection](/javascript/api/excel/excel.cardlayouttwocolumnsection)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CardLayoutListSection](/javascript/api/excel/excel.cardlayoutlistsection), + [Excel.CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection), + [Excel.CardLayoutTwoColumnSection](/javascript/api/excel/excel.cardlayouttwocolumnsection) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel/excel/excel.cellcontrol.yml b/docs/docs-ref-autogen/excel/excel/excel.cellcontrol.yml index ecd03dccf2..5e5954d3df 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.cellcontrol.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.cellcontrol.yml @@ -4,7 +4,47 @@ uid: excel!Excel.CellControl:type package: excel! fullName: Excel.CellControl summary: Represents an interactable control inside of a cell. -remarks: "\\[ [API set: ExcelApi 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\n\n\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.UnknownCellControl](/javascript/api/excel/excel.unknowncellcontrol), [Excel.EmptyCellControl](/javascript/api/excel/excel.emptycellcontrol), [Excel.MixedCellControl](/javascript/api/excel/excel.mixedcellcontrol), [Excel.CheckboxCellControl](/javascript/api/excel/excel.checkboxcellcontrol)\r\n\r\n#### Examples\n\n```TypeScript\n// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml\n\n// Add checkboxes to the table.\nawait Excel.run(async (context) => {\n const sheet = context.workbook.worksheets.getActiveWorksheet();\n\n // Get the second column in the table, without the header.\n const range = sheet.tables.getItem(\"FruitTable\").columns.getItem(\"Analysis\").getDataBodyRange();\n\n // Change the boolean values to checkboxes.\n range.control = {\n type: Excel.CellControlType.checkbox\n };\n await context.sync();\n});\n```" +remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + + + Learn more about the types in this type alias through the following links. + + + [Excel.UnknownCellControl](/javascript/api/excel/excel.unknowncellcontrol), + [Excel.EmptyCellControl](/javascript/api/excel/excel.emptycellcontrol), + [Excel.MixedCellControl](/javascript/api/excel/excel.mixedcellcontrol), + [Excel.CheckboxCellControl](/javascript/api/excel/excel.checkboxcellcontrol) + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml + + + // Add checkboxes to the table. + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Get the second column in the table, without the header. + const range = sheet.tables.getItem("FruitTable").columns.getItem("Analysis").getDataBodyRange(); + + // Change the boolean values to checkboxes. + range.control = { + type: Excel.CellControlType.checkbox + }; + await context.sync(); + }); + + ``` isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel/excel/excel.cellvalue.yml b/docs/docs-ref-autogen/excel/excel/excel.cellvalue.yml index 62429faa0a..57f85ca484 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.cellvalue.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.cellvalue.yml @@ -4,7 +4,30 @@ uid: excel!Excel.CellValue:type package: excel! fullName: Excel.CellValue summary: Represents the value in a cell. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue), [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), [Excel.EmptyCellValue](/javascript/api/excel/excel.emptycellvalue), [Excel.ErrorCellValue](/javascript/api/excel/excel.errorcellvalue), [Excel.ExternalCodeServiceObjectCellValue](/javascript/api/excel/excel.externalcodeserviceobjectcellvalue), [Excel.FormattedNumberCellValue](/javascript/api/excel/excel.formattednumbercellvalue), [Excel.FunctionCellValue](/javascript/api/excel/excel.functioncellvalue), [Excel.LinkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalue), [Excel.LocalImageCellValue](/javascript/api/excel/excel.localimagecellvalue), [Excel.ReferenceCellValue](/javascript/api/excel/excel.referencecellvalue), [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), [Excel.ValueTypeNotAvailableCellValue](/javascript/api/excel/excel.valuetypenotavailablecellvalue), [Excel.WebImageCellValue](/javascript/api/excel/excel.webimagecellvalue), [Excel.CellValueExtraProperties](/javascript/api/excel/excel.cellvalueextraproperties)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), + [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue), + [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), + [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), + [Excel.EmptyCellValue](/javascript/api/excel/excel.emptycellvalue), + [Excel.ErrorCellValue](/javascript/api/excel/excel.errorcellvalue), + [Excel.ExternalCodeServiceObjectCellValue](/javascript/api/excel/excel.externalcodeserviceobjectcellvalue), + [Excel.FormattedNumberCellValue](/javascript/api/excel/excel.formattednumbercellvalue), + [Excel.FunctionCellValue](/javascript/api/excel/excel.functioncellvalue), + [Excel.LinkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalue), + [Excel.LocalImageCellValue](/javascript/api/excel/excel.localimagecellvalue), + [Excel.ReferenceCellValue](/javascript/api/excel/excel.referencecellvalue), + [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), + [Excel.ValueTypeNotAvailableCellValue](/javascript/api/excel/excel.valuetypenotavailablecellvalue), + [Excel.WebImageCellValue](/javascript/api/excel/excel.webimagecellvalue), + [Excel.CellValueExtraProperties](/javascript/api/excel/excel.cellvalueextraproperties) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel/excel/excel.cellvalueandpropertymetadata.yml b/docs/docs-ref-autogen/excel/excel/excel.cellvalueandpropertymetadata.yml index 566432a914..5f661bb32f 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.cellvalueandpropertymetadata.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.cellvalueandpropertymetadata.yml @@ -6,7 +6,16 @@ fullName: Excel.CellValueAndPropertyMetadata summary: >- Represents the value and metadata of a property. The metadata applies to the property (and not the value), but it is combined with the value in this type. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CellValue](/javascript/api/excel/excel.cellvalue), [Excel.EntityPropertyExtraProperties](/javascript/api/excel/excel.entitypropertyextraproperties)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CellValue](/javascript/api/excel/excel.cellvalue), + [Excel.EntityPropertyExtraProperties](/javascript/api/excel/excel.entitypropertyextraproperties) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel/excel/excel.compactlayout.yml b/docs/docs-ref-autogen/excel/excel/excel.compactlayout.yml index 3f25496779..5bb689c662 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.compactlayout.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.compactlayout.yml @@ -6,7 +6,15 @@ fullName: Excel.CompactLayout summary: >- Represents the layout used when there is limited space to represent the entity. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.EntityCompactLayout](/javascript/api/excel/excel.entitycompactlayout)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.EntityCompactLayout](/javascript/api/excel/excel.entitycompactlayout) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel/excel/excel.entitypropertytype.yml b/docs/docs-ref-autogen/excel/excel/excel.entitypropertytype.yml index 41a8cc7fcf..bc54a6eff6 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.entitypropertytype.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.entitypropertytype.yml @@ -4,7 +4,16 @@ uid: excel!Excel.EntityPropertyType:type package: excel! fullName: Excel.EntityPropertyType summary: Represents the value of a property. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CellValueAndPropertyMetadata](/javascript/api/excel/excel.cellvalueandpropertymetadata), [Excel.CellValue](/javascript/api/excel/excel.cellvalue)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CellValueAndPropertyMetadata](/javascript/api/excel/excel.cellvalueandpropertymetadata), + [Excel.CellValue](/javascript/api/excel/excel.cellvalue) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel/excel/excel.errorcellvalue.yml b/docs/docs-ref-autogen/excel/excel/excel.errorcellvalue.yml index cd381f72c8..f5e56306dd 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.errorcellvalue.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.errorcellvalue.yml @@ -4,7 +4,64 @@ uid: excel!Excel.ErrorCellValue:type package: excel! fullName: Excel.ErrorCellValue summary: Represents a cell value which contains an error. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\n\n\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.BlockedErrorCellValue](/javascript/api/excel/excel.blockederrorcellvalue), [Excel.BusyErrorCellValue](/javascript/api/excel/excel.busyerrorcellvalue), [Excel.CalcErrorCellValue](/javascript/api/excel/excel.calcerrorcellvalue), [Excel.ConnectErrorCellValue](/javascript/api/excel/excel.connecterrorcellvalue), [Excel.Div0ErrorCellValue](/javascript/api/excel/excel.div0errorcellvalue), [Excel.ExternalErrorCellValue](/javascript/api/excel/excel.externalerrorcellvalue), [Excel.FieldErrorCellValue](/javascript/api/excel/excel.fielderrorcellvalue), [Excel.GettingDataErrorCellValue](/javascript/api/excel/excel.gettingdataerrorcellvalue), [Excel.NotAvailableErrorCellValue](/javascript/api/excel/excel.notavailableerrorcellvalue), [Excel.NameErrorCellValue](/javascript/api/excel/excel.nameerrorcellvalue), [Excel.NullErrorCellValue](/javascript/api/excel/excel.nullerrorcellvalue), [Excel.NumErrorCellValue](/javascript/api/excel/excel.numerrorcellvalue), [Excel.PlaceholderErrorCellValue](/javascript/api/excel/excel.placeholdererrorcellvalue), [Excel.PythonErrorCellValue](/javascript/api/excel/excel.pythonerrorcellvalue), [Excel.RefErrorCellValue](/javascript/api/excel/excel.referrorcellvalue), [Excel.SpillErrorCellValue](/javascript/api/excel/excel.spillerrorcellvalue), [Excel.TimeoutErrorCellValue](/javascript/api/excel/excel.timeouterrorcellvalue), [Excel.ValueErrorCellValue](/javascript/api/excel/excel.valueerrorcellvalue)\r\n\r\n#### Examples\n\n```TypeScript\n// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-error-values.yaml\n\n// This function sets the value of cell A1 to a #BUSY! error using data types.\nawait Excel.run(async (context) => {\n // Retrieve the Sample worksheet and cell A1 on that sheet.\n const sheet = context.workbook.worksheets.getItemOrNullObject(\"Sample\");\n const range = sheet.getRange(\"A1\");\n\n // Get the error data type and set its type to `busy`.\n const error: Excel.ErrorCellValue = {\n type: Excel.CellValueType.error,\n errorType: Excel.ErrorCellValueType.busy\n };\n\n // Set cell A1 as the busy error.\n range.valuesAsJson = [[error]];\n await context.sync();\n});\n```" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + + + Learn more about the types in this type alias through the following links. + + + [Excel.BlockedErrorCellValue](/javascript/api/excel/excel.blockederrorcellvalue), + [Excel.BusyErrorCellValue](/javascript/api/excel/excel.busyerrorcellvalue), + [Excel.CalcErrorCellValue](/javascript/api/excel/excel.calcerrorcellvalue), + [Excel.ConnectErrorCellValue](/javascript/api/excel/excel.connecterrorcellvalue), + [Excel.Div0ErrorCellValue](/javascript/api/excel/excel.div0errorcellvalue), + [Excel.ExternalErrorCellValue](/javascript/api/excel/excel.externalerrorcellvalue), + [Excel.FieldErrorCellValue](/javascript/api/excel/excel.fielderrorcellvalue), + [Excel.GettingDataErrorCellValue](/javascript/api/excel/excel.gettingdataerrorcellvalue), + [Excel.NotAvailableErrorCellValue](/javascript/api/excel/excel.notavailableerrorcellvalue), + [Excel.NameErrorCellValue](/javascript/api/excel/excel.nameerrorcellvalue), + [Excel.NullErrorCellValue](/javascript/api/excel/excel.nullerrorcellvalue), + [Excel.NumErrorCellValue](/javascript/api/excel/excel.numerrorcellvalue), + [Excel.PlaceholderErrorCellValue](/javascript/api/excel/excel.placeholdererrorcellvalue), + [Excel.PythonErrorCellValue](/javascript/api/excel/excel.pythonerrorcellvalue), + [Excel.RefErrorCellValue](/javascript/api/excel/excel.referrorcellvalue), + [Excel.SpillErrorCellValue](/javascript/api/excel/excel.spillerrorcellvalue), + [Excel.TimeoutErrorCellValue](/javascript/api/excel/excel.timeouterrorcellvalue), + [Excel.ValueErrorCellValue](/javascript/api/excel/excel.valueerrorcellvalue) + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-error-values.yaml + + + // This function sets the value of cell A1 to a #BUSY! error using data types. + + await Excel.run(async (context) => { + // Retrieve the Sample worksheet and cell A1 on that sheet. + const sheet = context.workbook.worksheets.getItemOrNullObject("Sample"); + const range = sheet.getRange("A1"); + + // Get the error data type and set its type to `busy`. + const error: Excel.ErrorCellValue = { + type: Excel.CellValueType.error, + errorType: Excel.ErrorCellValueType.busy + }; + + // Set cell A1 as the busy error. + range.valuesAsJson = [[error]]; + await context.sync(); + }); + + ``` isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel/excel/excel.functioncellvalue.yml b/docs/docs-ref-autogen/excel/excel/excel.functioncellvalue.yml index 50b7239609..b1f83d2ff4 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.functioncellvalue.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.functioncellvalue.yml @@ -4,7 +4,15 @@ uid: excel!Excel.FunctionCellValue:type package: excel! fullName: Excel.FunctionCellValue summary: Represents a cell value which can be evaluated as a function. -remarks: "\\[ [API set: ExcelApi 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.JavaScriptCustomFunctionReferenceCellValue](/javascript/api/excel/excel.javascriptcustomfunctionreferencecellvalue)" +remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.JavaScriptCustomFunctionReferenceCellValue](/javascript/api/excel/excel.javascriptcustomfunctionreferencecellvalue) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel/excel/excel.referencedvalue.yml b/docs/docs-ref-autogen/excel/excel/excel.referencedvalue.yml index 57044e8ebe..168b4928ba 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.referencedvalue.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.referencedvalue.yml @@ -4,7 +4,20 @@ uid: excel!Excel.ReferencedValue:type package: excel! fullName: Excel.ReferencedValue summary: Represents the value in a cell. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), [Excel.RootReferenceCellValue](/javascript/api/excel/excel.rootreferencecellvalue), [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), + [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), + [Excel.RootReferenceCellValue](/javascript/api/excel/excel.rootreferencecellvalue), + [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), + [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), + [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_16/excel/excel.cardlayout.yml b/docs/docs-ref-autogen/excel_1_16/excel/excel.cardlayout.yml index 4de2b1d604..07ebbc46e3 100644 --- a/docs/docs-ref-autogen/excel_1_16/excel/excel.cardlayout.yml +++ b/docs/docs-ref-autogen/excel_1_16/excel/excel.cardlayout.yml @@ -4,7 +4,15 @@ uid: excel!Excel.CardLayout:type package: excel! fullName: Excel.CardLayout summary: Represents the layout of a card in card view. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.EntityCardLayout](/javascript/api/excel/excel.entitycardlayout)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.EntityCardLayout](/javascript/api/excel/excel.entitycardlayout) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_16/excel/excel.cardlayoutsection.yml b/docs/docs-ref-autogen/excel_1_16/excel/excel.cardlayoutsection.yml index b54480411d..97e90f572d 100644 --- a/docs/docs-ref-autogen/excel_1_16/excel/excel.cardlayoutsection.yml +++ b/docs/docs-ref-autogen/excel_1_16/excel/excel.cardlayoutsection.yml @@ -4,7 +4,16 @@ uid: excel!Excel.CardLayoutSection:type package: excel! fullName: Excel.CardLayoutSection summary: Represents the layout of a section of a card in card view. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CardLayoutListSection](/javascript/api/excel/excel.cardlayoutlistsection), [Excel.CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CardLayoutListSection](/javascript/api/excel/excel.cardlayoutlistsection), + [Excel.CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_16/excel/excel.cellvalue.yml b/docs/docs-ref-autogen/excel_1_16/excel/excel.cellvalue.yml index 63e5befd22..b679b81429 100644 --- a/docs/docs-ref-autogen/excel_1_16/excel/excel.cellvalue.yml +++ b/docs/docs-ref-autogen/excel_1_16/excel/excel.cellvalue.yml @@ -4,7 +4,26 @@ uid: excel!Excel.CellValue:type package: excel! fullName: Excel.CellValue summary: Represents the value in a cell. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue), [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), [Excel.EmptyCellValue](/javascript/api/excel/excel.emptycellvalue), [Excel.ErrorCellValue](/javascript/api/excel/excel.errorcellvalue), [Excel.LinkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalue), [Excel.ReferenceCellValue](/javascript/api/excel/excel.referencecellvalue), [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), [Excel.ValueTypeNotAvailableCellValue](/javascript/api/excel/excel.valuetypenotavailablecellvalue), [Excel.WebImageCellValue](/javascript/api/excel/excel.webimagecellvalue), [Excel.CellValueExtraProperties](/javascript/api/excel/excel.cellvalueextraproperties)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), + [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue), + [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), + [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), + [Excel.EmptyCellValue](/javascript/api/excel/excel.emptycellvalue), + [Excel.ErrorCellValue](/javascript/api/excel/excel.errorcellvalue), + [Excel.LinkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalue), + [Excel.ReferenceCellValue](/javascript/api/excel/excel.referencecellvalue), + [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), + [Excel.ValueTypeNotAvailableCellValue](/javascript/api/excel/excel.valuetypenotavailablecellvalue), + [Excel.WebImageCellValue](/javascript/api/excel/excel.webimagecellvalue), + [Excel.CellValueExtraProperties](/javascript/api/excel/excel.cellvalueextraproperties) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_16/excel/excel.cellvalueandpropertymetadata.yml b/docs/docs-ref-autogen/excel_1_16/excel/excel.cellvalueandpropertymetadata.yml index 566432a914..5f661bb32f 100644 --- a/docs/docs-ref-autogen/excel_1_16/excel/excel.cellvalueandpropertymetadata.yml +++ b/docs/docs-ref-autogen/excel_1_16/excel/excel.cellvalueandpropertymetadata.yml @@ -6,7 +6,16 @@ fullName: Excel.CellValueAndPropertyMetadata summary: >- Represents the value and metadata of a property. The metadata applies to the property (and not the value), but it is combined with the value in this type. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CellValue](/javascript/api/excel/excel.cellvalue), [Excel.EntityPropertyExtraProperties](/javascript/api/excel/excel.entitypropertyextraproperties)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CellValue](/javascript/api/excel/excel.cellvalue), + [Excel.EntityPropertyExtraProperties](/javascript/api/excel/excel.entitypropertyextraproperties) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_16/excel/excel.compactlayout.yml b/docs/docs-ref-autogen/excel_1_16/excel/excel.compactlayout.yml index 3f25496779..5bb689c662 100644 --- a/docs/docs-ref-autogen/excel_1_16/excel/excel.compactlayout.yml +++ b/docs/docs-ref-autogen/excel_1_16/excel/excel.compactlayout.yml @@ -6,7 +6,15 @@ fullName: Excel.CompactLayout summary: >- Represents the layout used when there is limited space to represent the entity. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.EntityCompactLayout](/javascript/api/excel/excel.entitycompactlayout)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.EntityCompactLayout](/javascript/api/excel/excel.entitycompactlayout) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_16/excel/excel.entitypropertytype.yml b/docs/docs-ref-autogen/excel_1_16/excel/excel.entitypropertytype.yml index 41a8cc7fcf..bc54a6eff6 100644 --- a/docs/docs-ref-autogen/excel_1_16/excel/excel.entitypropertytype.yml +++ b/docs/docs-ref-autogen/excel_1_16/excel/excel.entitypropertytype.yml @@ -4,7 +4,16 @@ uid: excel!Excel.EntityPropertyType:type package: excel! fullName: Excel.EntityPropertyType summary: Represents the value of a property. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CellValueAndPropertyMetadata](/javascript/api/excel/excel.cellvalueandpropertymetadata), [Excel.CellValue](/javascript/api/excel/excel.cellvalue)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CellValueAndPropertyMetadata](/javascript/api/excel/excel.cellvalueandpropertymetadata), + [Excel.CellValue](/javascript/api/excel/excel.cellvalue) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_16/excel/excel.errorcellvalue.yml b/docs/docs-ref-autogen/excel_1_16/excel/excel.errorcellvalue.yml index e5addcc22f..b88b1959c2 100644 --- a/docs/docs-ref-autogen/excel_1_16/excel/excel.errorcellvalue.yml +++ b/docs/docs-ref-autogen/excel_1_16/excel/excel.errorcellvalue.yml @@ -4,7 +4,62 @@ uid: excel!Excel.ErrorCellValue:type package: excel! fullName: Excel.ErrorCellValue summary: Represents a cell value which contains an error. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\n\n\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.BlockedErrorCellValue](/javascript/api/excel/excel.blockederrorcellvalue), [Excel.BusyErrorCellValue](/javascript/api/excel/excel.busyerrorcellvalue), [Excel.CalcErrorCellValue](/javascript/api/excel/excel.calcerrorcellvalue), [Excel.ConnectErrorCellValue](/javascript/api/excel/excel.connecterrorcellvalue), [Excel.Div0ErrorCellValue](/javascript/api/excel/excel.div0errorcellvalue), [Excel.ExternalErrorCellValue](/javascript/api/excel/excel.externalerrorcellvalue), [Excel.FieldErrorCellValue](/javascript/api/excel/excel.fielderrorcellvalue), [Excel.GettingDataErrorCellValue](/javascript/api/excel/excel.gettingdataerrorcellvalue), [Excel.NotAvailableErrorCellValue](/javascript/api/excel/excel.notavailableerrorcellvalue), [Excel.NameErrorCellValue](/javascript/api/excel/excel.nameerrorcellvalue), [Excel.NullErrorCellValue](/javascript/api/excel/excel.nullerrorcellvalue), [Excel.NumErrorCellValue](/javascript/api/excel/excel.numerrorcellvalue), [Excel.PlaceholderErrorCellValue](/javascript/api/excel/excel.placeholdererrorcellvalue), [Excel.RefErrorCellValue](/javascript/api/excel/excel.referrorcellvalue), [Excel.SpillErrorCellValue](/javascript/api/excel/excel.spillerrorcellvalue), [Excel.ValueErrorCellValue](/javascript/api/excel/excel.valueerrorcellvalue)\r\n\r\n#### Examples\n\n```TypeScript\n// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-error-values.yaml\n\n// This function sets the value of cell A1 to a #BUSY! error using data types.\nawait Excel.run(async (context) => {\n // Retrieve the Sample worksheet and cell A1 on that sheet.\n const sheet = context.workbook.worksheets.getItemOrNullObject(\"Sample\");\n const range = sheet.getRange(\"A1\");\n\n // Get the error data type and set its type to `busy`.\n const error: Excel.ErrorCellValue = {\n type: Excel.CellValueType.error,\n errorType: Excel.ErrorCellValueType.busy\n };\n\n // Set cell A1 as the busy error.\n range.valuesAsJson = [[error]];\n await context.sync();\n});\n```" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + + + Learn more about the types in this type alias through the following links. + + + [Excel.BlockedErrorCellValue](/javascript/api/excel/excel.blockederrorcellvalue), + [Excel.BusyErrorCellValue](/javascript/api/excel/excel.busyerrorcellvalue), + [Excel.CalcErrorCellValue](/javascript/api/excel/excel.calcerrorcellvalue), + [Excel.ConnectErrorCellValue](/javascript/api/excel/excel.connecterrorcellvalue), + [Excel.Div0ErrorCellValue](/javascript/api/excel/excel.div0errorcellvalue), + [Excel.ExternalErrorCellValue](/javascript/api/excel/excel.externalerrorcellvalue), + [Excel.FieldErrorCellValue](/javascript/api/excel/excel.fielderrorcellvalue), + [Excel.GettingDataErrorCellValue](/javascript/api/excel/excel.gettingdataerrorcellvalue), + [Excel.NotAvailableErrorCellValue](/javascript/api/excel/excel.notavailableerrorcellvalue), + [Excel.NameErrorCellValue](/javascript/api/excel/excel.nameerrorcellvalue), + [Excel.NullErrorCellValue](/javascript/api/excel/excel.nullerrorcellvalue), + [Excel.NumErrorCellValue](/javascript/api/excel/excel.numerrorcellvalue), + [Excel.PlaceholderErrorCellValue](/javascript/api/excel/excel.placeholdererrorcellvalue), + [Excel.RefErrorCellValue](/javascript/api/excel/excel.referrorcellvalue), + [Excel.SpillErrorCellValue](/javascript/api/excel/excel.spillerrorcellvalue), + [Excel.ValueErrorCellValue](/javascript/api/excel/excel.valueerrorcellvalue) + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-error-values.yaml + + + // This function sets the value of cell A1 to a #BUSY! error using data types. + + await Excel.run(async (context) => { + // Retrieve the Sample worksheet and cell A1 on that sheet. + const sheet = context.workbook.worksheets.getItemOrNullObject("Sample"); + const range = sheet.getRange("A1"); + + // Get the error data type and set its type to `busy`. + const error: Excel.ErrorCellValue = { + type: Excel.CellValueType.error, + errorType: Excel.ErrorCellValueType.busy + }; + + // Set cell A1 as the busy error. + range.valuesAsJson = [[error]]; + await context.sync(); + }); + + ``` isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_16/excel/excel.referencedvalue.yml b/docs/docs-ref-autogen/excel_1_16/excel/excel.referencedvalue.yml index 57044e8ebe..168b4928ba 100644 --- a/docs/docs-ref-autogen/excel_1_16/excel/excel.referencedvalue.yml +++ b/docs/docs-ref-autogen/excel_1_16/excel/excel.referencedvalue.yml @@ -4,7 +4,20 @@ uid: excel!Excel.ReferencedValue:type package: excel! fullName: Excel.ReferencedValue summary: Represents the value in a cell. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), [Excel.RootReferenceCellValue](/javascript/api/excel/excel.rootreferencecellvalue), [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), + [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), + [Excel.RootReferenceCellValue](/javascript/api/excel/excel.rootreferencecellvalue), + [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), + [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), + [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_17/excel/excel.cardlayout.yml b/docs/docs-ref-autogen/excel_1_17/excel/excel.cardlayout.yml index 4de2b1d604..07ebbc46e3 100644 --- a/docs/docs-ref-autogen/excel_1_17/excel/excel.cardlayout.yml +++ b/docs/docs-ref-autogen/excel_1_17/excel/excel.cardlayout.yml @@ -4,7 +4,15 @@ uid: excel!Excel.CardLayout:type package: excel! fullName: Excel.CardLayout summary: Represents the layout of a card in card view. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.EntityCardLayout](/javascript/api/excel/excel.entitycardlayout)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.EntityCardLayout](/javascript/api/excel/excel.entitycardlayout) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_17/excel/excel.cardlayoutsection.yml b/docs/docs-ref-autogen/excel_1_17/excel/excel.cardlayoutsection.yml index b54480411d..97e90f572d 100644 --- a/docs/docs-ref-autogen/excel_1_17/excel/excel.cardlayoutsection.yml +++ b/docs/docs-ref-autogen/excel_1_17/excel/excel.cardlayoutsection.yml @@ -4,7 +4,16 @@ uid: excel!Excel.CardLayoutSection:type package: excel! fullName: Excel.CardLayoutSection summary: Represents the layout of a section of a card in card view. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CardLayoutListSection](/javascript/api/excel/excel.cardlayoutlistsection), [Excel.CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CardLayoutListSection](/javascript/api/excel/excel.cardlayoutlistsection), + [Excel.CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_17/excel/excel.cellvalue.yml b/docs/docs-ref-autogen/excel_1_17/excel/excel.cellvalue.yml index 63e5befd22..b679b81429 100644 --- a/docs/docs-ref-autogen/excel_1_17/excel/excel.cellvalue.yml +++ b/docs/docs-ref-autogen/excel_1_17/excel/excel.cellvalue.yml @@ -4,7 +4,26 @@ uid: excel!Excel.CellValue:type package: excel! fullName: Excel.CellValue summary: Represents the value in a cell. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue), [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), [Excel.EmptyCellValue](/javascript/api/excel/excel.emptycellvalue), [Excel.ErrorCellValue](/javascript/api/excel/excel.errorcellvalue), [Excel.LinkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalue), [Excel.ReferenceCellValue](/javascript/api/excel/excel.referencecellvalue), [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), [Excel.ValueTypeNotAvailableCellValue](/javascript/api/excel/excel.valuetypenotavailablecellvalue), [Excel.WebImageCellValue](/javascript/api/excel/excel.webimagecellvalue), [Excel.CellValueExtraProperties](/javascript/api/excel/excel.cellvalueextraproperties)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), + [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue), + [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), + [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), + [Excel.EmptyCellValue](/javascript/api/excel/excel.emptycellvalue), + [Excel.ErrorCellValue](/javascript/api/excel/excel.errorcellvalue), + [Excel.LinkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalue), + [Excel.ReferenceCellValue](/javascript/api/excel/excel.referencecellvalue), + [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), + [Excel.ValueTypeNotAvailableCellValue](/javascript/api/excel/excel.valuetypenotavailablecellvalue), + [Excel.WebImageCellValue](/javascript/api/excel/excel.webimagecellvalue), + [Excel.CellValueExtraProperties](/javascript/api/excel/excel.cellvalueextraproperties) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_17/excel/excel.cellvalueandpropertymetadata.yml b/docs/docs-ref-autogen/excel_1_17/excel/excel.cellvalueandpropertymetadata.yml index 566432a914..5f661bb32f 100644 --- a/docs/docs-ref-autogen/excel_1_17/excel/excel.cellvalueandpropertymetadata.yml +++ b/docs/docs-ref-autogen/excel_1_17/excel/excel.cellvalueandpropertymetadata.yml @@ -6,7 +6,16 @@ fullName: Excel.CellValueAndPropertyMetadata summary: >- Represents the value and metadata of a property. The metadata applies to the property (and not the value), but it is combined with the value in this type. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CellValue](/javascript/api/excel/excel.cellvalue), [Excel.EntityPropertyExtraProperties](/javascript/api/excel/excel.entitypropertyextraproperties)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CellValue](/javascript/api/excel/excel.cellvalue), + [Excel.EntityPropertyExtraProperties](/javascript/api/excel/excel.entitypropertyextraproperties) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_17/excel/excel.compactlayout.yml b/docs/docs-ref-autogen/excel_1_17/excel/excel.compactlayout.yml index 3f25496779..5bb689c662 100644 --- a/docs/docs-ref-autogen/excel_1_17/excel/excel.compactlayout.yml +++ b/docs/docs-ref-autogen/excel_1_17/excel/excel.compactlayout.yml @@ -6,7 +6,15 @@ fullName: Excel.CompactLayout summary: >- Represents the layout used when there is limited space to represent the entity. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.EntityCompactLayout](/javascript/api/excel/excel.entitycompactlayout)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.EntityCompactLayout](/javascript/api/excel/excel.entitycompactlayout) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_17/excel/excel.entitypropertytype.yml b/docs/docs-ref-autogen/excel_1_17/excel/excel.entitypropertytype.yml index 41a8cc7fcf..bc54a6eff6 100644 --- a/docs/docs-ref-autogen/excel_1_17/excel/excel.entitypropertytype.yml +++ b/docs/docs-ref-autogen/excel_1_17/excel/excel.entitypropertytype.yml @@ -4,7 +4,16 @@ uid: excel!Excel.EntityPropertyType:type package: excel! fullName: Excel.EntityPropertyType summary: Represents the value of a property. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CellValueAndPropertyMetadata](/javascript/api/excel/excel.cellvalueandpropertymetadata), [Excel.CellValue](/javascript/api/excel/excel.cellvalue)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CellValueAndPropertyMetadata](/javascript/api/excel/excel.cellvalueandpropertymetadata), + [Excel.CellValue](/javascript/api/excel/excel.cellvalue) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_17/excel/excel.errorcellvalue.yml b/docs/docs-ref-autogen/excel_1_17/excel/excel.errorcellvalue.yml index e5addcc22f..b88b1959c2 100644 --- a/docs/docs-ref-autogen/excel_1_17/excel/excel.errorcellvalue.yml +++ b/docs/docs-ref-autogen/excel_1_17/excel/excel.errorcellvalue.yml @@ -4,7 +4,62 @@ uid: excel!Excel.ErrorCellValue:type package: excel! fullName: Excel.ErrorCellValue summary: Represents a cell value which contains an error. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\n\n\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.BlockedErrorCellValue](/javascript/api/excel/excel.blockederrorcellvalue), [Excel.BusyErrorCellValue](/javascript/api/excel/excel.busyerrorcellvalue), [Excel.CalcErrorCellValue](/javascript/api/excel/excel.calcerrorcellvalue), [Excel.ConnectErrorCellValue](/javascript/api/excel/excel.connecterrorcellvalue), [Excel.Div0ErrorCellValue](/javascript/api/excel/excel.div0errorcellvalue), [Excel.ExternalErrorCellValue](/javascript/api/excel/excel.externalerrorcellvalue), [Excel.FieldErrorCellValue](/javascript/api/excel/excel.fielderrorcellvalue), [Excel.GettingDataErrorCellValue](/javascript/api/excel/excel.gettingdataerrorcellvalue), [Excel.NotAvailableErrorCellValue](/javascript/api/excel/excel.notavailableerrorcellvalue), [Excel.NameErrorCellValue](/javascript/api/excel/excel.nameerrorcellvalue), [Excel.NullErrorCellValue](/javascript/api/excel/excel.nullerrorcellvalue), [Excel.NumErrorCellValue](/javascript/api/excel/excel.numerrorcellvalue), [Excel.PlaceholderErrorCellValue](/javascript/api/excel/excel.placeholdererrorcellvalue), [Excel.RefErrorCellValue](/javascript/api/excel/excel.referrorcellvalue), [Excel.SpillErrorCellValue](/javascript/api/excel/excel.spillerrorcellvalue), [Excel.ValueErrorCellValue](/javascript/api/excel/excel.valueerrorcellvalue)\r\n\r\n#### Examples\n\n```TypeScript\n// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-error-values.yaml\n\n// This function sets the value of cell A1 to a #BUSY! error using data types.\nawait Excel.run(async (context) => {\n // Retrieve the Sample worksheet and cell A1 on that sheet.\n const sheet = context.workbook.worksheets.getItemOrNullObject(\"Sample\");\n const range = sheet.getRange(\"A1\");\n\n // Get the error data type and set its type to `busy`.\n const error: Excel.ErrorCellValue = {\n type: Excel.CellValueType.error,\n errorType: Excel.ErrorCellValueType.busy\n };\n\n // Set cell A1 as the busy error.\n range.valuesAsJson = [[error]];\n await context.sync();\n});\n```" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + + + Learn more about the types in this type alias through the following links. + + + [Excel.BlockedErrorCellValue](/javascript/api/excel/excel.blockederrorcellvalue), + [Excel.BusyErrorCellValue](/javascript/api/excel/excel.busyerrorcellvalue), + [Excel.CalcErrorCellValue](/javascript/api/excel/excel.calcerrorcellvalue), + [Excel.ConnectErrorCellValue](/javascript/api/excel/excel.connecterrorcellvalue), + [Excel.Div0ErrorCellValue](/javascript/api/excel/excel.div0errorcellvalue), + [Excel.ExternalErrorCellValue](/javascript/api/excel/excel.externalerrorcellvalue), + [Excel.FieldErrorCellValue](/javascript/api/excel/excel.fielderrorcellvalue), + [Excel.GettingDataErrorCellValue](/javascript/api/excel/excel.gettingdataerrorcellvalue), + [Excel.NotAvailableErrorCellValue](/javascript/api/excel/excel.notavailableerrorcellvalue), + [Excel.NameErrorCellValue](/javascript/api/excel/excel.nameerrorcellvalue), + [Excel.NullErrorCellValue](/javascript/api/excel/excel.nullerrorcellvalue), + [Excel.NumErrorCellValue](/javascript/api/excel/excel.numerrorcellvalue), + [Excel.PlaceholderErrorCellValue](/javascript/api/excel/excel.placeholdererrorcellvalue), + [Excel.RefErrorCellValue](/javascript/api/excel/excel.referrorcellvalue), + [Excel.SpillErrorCellValue](/javascript/api/excel/excel.spillerrorcellvalue), + [Excel.ValueErrorCellValue](/javascript/api/excel/excel.valueerrorcellvalue) + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-error-values.yaml + + + // This function sets the value of cell A1 to a #BUSY! error using data types. + + await Excel.run(async (context) => { + // Retrieve the Sample worksheet and cell A1 on that sheet. + const sheet = context.workbook.worksheets.getItemOrNullObject("Sample"); + const range = sheet.getRange("A1"); + + // Get the error data type and set its type to `busy`. + const error: Excel.ErrorCellValue = { + type: Excel.CellValueType.error, + errorType: Excel.ErrorCellValueType.busy + }; + + // Set cell A1 as the busy error. + range.valuesAsJson = [[error]]; + await context.sync(); + }); + + ``` isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_17/excel/excel.referencedvalue.yml b/docs/docs-ref-autogen/excel_1_17/excel/excel.referencedvalue.yml index 57044e8ebe..168b4928ba 100644 --- a/docs/docs-ref-autogen/excel_1_17/excel/excel.referencedvalue.yml +++ b/docs/docs-ref-autogen/excel_1_17/excel/excel.referencedvalue.yml @@ -4,7 +4,20 @@ uid: excel!Excel.ReferencedValue:type package: excel! fullName: Excel.ReferencedValue summary: Represents the value in a cell. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), [Excel.RootReferenceCellValue](/javascript/api/excel/excel.rootreferencecellvalue), [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), + [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), + [Excel.RootReferenceCellValue](/javascript/api/excel/excel.rootreferencecellvalue), + [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), + [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), + [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_18/excel/excel.cardlayout.yml b/docs/docs-ref-autogen/excel_1_18/excel/excel.cardlayout.yml index 4de2b1d604..07ebbc46e3 100644 --- a/docs/docs-ref-autogen/excel_1_18/excel/excel.cardlayout.yml +++ b/docs/docs-ref-autogen/excel_1_18/excel/excel.cardlayout.yml @@ -4,7 +4,15 @@ uid: excel!Excel.CardLayout:type package: excel! fullName: Excel.CardLayout summary: Represents the layout of a card in card view. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.EntityCardLayout](/javascript/api/excel/excel.entitycardlayout)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.EntityCardLayout](/javascript/api/excel/excel.entitycardlayout) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_18/excel/excel.cardlayoutsection.yml b/docs/docs-ref-autogen/excel_1_18/excel/excel.cardlayoutsection.yml index b54480411d..97e90f572d 100644 --- a/docs/docs-ref-autogen/excel_1_18/excel/excel.cardlayoutsection.yml +++ b/docs/docs-ref-autogen/excel_1_18/excel/excel.cardlayoutsection.yml @@ -4,7 +4,16 @@ uid: excel!Excel.CardLayoutSection:type package: excel! fullName: Excel.CardLayoutSection summary: Represents the layout of a section of a card in card view. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CardLayoutListSection](/javascript/api/excel/excel.cardlayoutlistsection), [Excel.CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CardLayoutListSection](/javascript/api/excel/excel.cardlayoutlistsection), + [Excel.CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_18/excel/excel.cellcontrol.yml b/docs/docs-ref-autogen/excel_1_18/excel/excel.cellcontrol.yml index ecd03dccf2..5e5954d3df 100644 --- a/docs/docs-ref-autogen/excel_1_18/excel/excel.cellcontrol.yml +++ b/docs/docs-ref-autogen/excel_1_18/excel/excel.cellcontrol.yml @@ -4,7 +4,47 @@ uid: excel!Excel.CellControl:type package: excel! fullName: Excel.CellControl summary: Represents an interactable control inside of a cell. -remarks: "\\[ [API set: ExcelApi 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\n\n\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.UnknownCellControl](/javascript/api/excel/excel.unknowncellcontrol), [Excel.EmptyCellControl](/javascript/api/excel/excel.emptycellcontrol), [Excel.MixedCellControl](/javascript/api/excel/excel.mixedcellcontrol), [Excel.CheckboxCellControl](/javascript/api/excel/excel.checkboxcellcontrol)\r\n\r\n#### Examples\n\n```TypeScript\n// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml\n\n// Add checkboxes to the table.\nawait Excel.run(async (context) => {\n const sheet = context.workbook.worksheets.getActiveWorksheet();\n\n // Get the second column in the table, without the header.\n const range = sheet.tables.getItem(\"FruitTable\").columns.getItem(\"Analysis\").getDataBodyRange();\n\n // Change the boolean values to checkboxes.\n range.control = {\n type: Excel.CellControlType.checkbox\n };\n await context.sync();\n});\n```" +remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + + + Learn more about the types in this type alias through the following links. + + + [Excel.UnknownCellControl](/javascript/api/excel/excel.unknowncellcontrol), + [Excel.EmptyCellControl](/javascript/api/excel/excel.emptycellcontrol), + [Excel.MixedCellControl](/javascript/api/excel/excel.mixedcellcontrol), + [Excel.CheckboxCellControl](/javascript/api/excel/excel.checkboxcellcontrol) + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml + + + // Add checkboxes to the table. + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Get the second column in the table, without the header. + const range = sheet.tables.getItem("FruitTable").columns.getItem("Analysis").getDataBodyRange(); + + // Change the boolean values to checkboxes. + range.control = { + type: Excel.CellControlType.checkbox + }; + await context.sync(); + }); + + ``` isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_18/excel/excel.cellvalue.yml b/docs/docs-ref-autogen/excel_1_18/excel/excel.cellvalue.yml index 63e5befd22..b679b81429 100644 --- a/docs/docs-ref-autogen/excel_1_18/excel/excel.cellvalue.yml +++ b/docs/docs-ref-autogen/excel_1_18/excel/excel.cellvalue.yml @@ -4,7 +4,26 @@ uid: excel!Excel.CellValue:type package: excel! fullName: Excel.CellValue summary: Represents the value in a cell. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue), [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), [Excel.EmptyCellValue](/javascript/api/excel/excel.emptycellvalue), [Excel.ErrorCellValue](/javascript/api/excel/excel.errorcellvalue), [Excel.LinkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalue), [Excel.ReferenceCellValue](/javascript/api/excel/excel.referencecellvalue), [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), [Excel.ValueTypeNotAvailableCellValue](/javascript/api/excel/excel.valuetypenotavailablecellvalue), [Excel.WebImageCellValue](/javascript/api/excel/excel.webimagecellvalue), [Excel.CellValueExtraProperties](/javascript/api/excel/excel.cellvalueextraproperties)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), + [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue), + [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), + [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), + [Excel.EmptyCellValue](/javascript/api/excel/excel.emptycellvalue), + [Excel.ErrorCellValue](/javascript/api/excel/excel.errorcellvalue), + [Excel.LinkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalue), + [Excel.ReferenceCellValue](/javascript/api/excel/excel.referencecellvalue), + [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), + [Excel.ValueTypeNotAvailableCellValue](/javascript/api/excel/excel.valuetypenotavailablecellvalue), + [Excel.WebImageCellValue](/javascript/api/excel/excel.webimagecellvalue), + [Excel.CellValueExtraProperties](/javascript/api/excel/excel.cellvalueextraproperties) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_18/excel/excel.cellvalueandpropertymetadata.yml b/docs/docs-ref-autogen/excel_1_18/excel/excel.cellvalueandpropertymetadata.yml index 566432a914..5f661bb32f 100644 --- a/docs/docs-ref-autogen/excel_1_18/excel/excel.cellvalueandpropertymetadata.yml +++ b/docs/docs-ref-autogen/excel_1_18/excel/excel.cellvalueandpropertymetadata.yml @@ -6,7 +6,16 @@ fullName: Excel.CellValueAndPropertyMetadata summary: >- Represents the value and metadata of a property. The metadata applies to the property (and not the value), but it is combined with the value in this type. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CellValue](/javascript/api/excel/excel.cellvalue), [Excel.EntityPropertyExtraProperties](/javascript/api/excel/excel.entitypropertyextraproperties)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CellValue](/javascript/api/excel/excel.cellvalue), + [Excel.EntityPropertyExtraProperties](/javascript/api/excel/excel.entitypropertyextraproperties) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_18/excel/excel.compactlayout.yml b/docs/docs-ref-autogen/excel_1_18/excel/excel.compactlayout.yml index 3f25496779..5bb689c662 100644 --- a/docs/docs-ref-autogen/excel_1_18/excel/excel.compactlayout.yml +++ b/docs/docs-ref-autogen/excel_1_18/excel/excel.compactlayout.yml @@ -6,7 +6,15 @@ fullName: Excel.CompactLayout summary: >- Represents the layout used when there is limited space to represent the entity. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.EntityCompactLayout](/javascript/api/excel/excel.entitycompactlayout)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.EntityCompactLayout](/javascript/api/excel/excel.entitycompactlayout) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_18/excel/excel.entitypropertytype.yml b/docs/docs-ref-autogen/excel_1_18/excel/excel.entitypropertytype.yml index 41a8cc7fcf..bc54a6eff6 100644 --- a/docs/docs-ref-autogen/excel_1_18/excel/excel.entitypropertytype.yml +++ b/docs/docs-ref-autogen/excel_1_18/excel/excel.entitypropertytype.yml @@ -4,7 +4,16 @@ uid: excel!Excel.EntityPropertyType:type package: excel! fullName: Excel.EntityPropertyType summary: Represents the value of a property. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CellValueAndPropertyMetadata](/javascript/api/excel/excel.cellvalueandpropertymetadata), [Excel.CellValue](/javascript/api/excel/excel.cellvalue)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CellValueAndPropertyMetadata](/javascript/api/excel/excel.cellvalueandpropertymetadata), + [Excel.CellValue](/javascript/api/excel/excel.cellvalue) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_18/excel/excel.errorcellvalue.yml b/docs/docs-ref-autogen/excel_1_18/excel/excel.errorcellvalue.yml index e5addcc22f..b88b1959c2 100644 --- a/docs/docs-ref-autogen/excel_1_18/excel/excel.errorcellvalue.yml +++ b/docs/docs-ref-autogen/excel_1_18/excel/excel.errorcellvalue.yml @@ -4,7 +4,62 @@ uid: excel!Excel.ErrorCellValue:type package: excel! fullName: Excel.ErrorCellValue summary: Represents a cell value which contains an error. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\n\n\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.BlockedErrorCellValue](/javascript/api/excel/excel.blockederrorcellvalue), [Excel.BusyErrorCellValue](/javascript/api/excel/excel.busyerrorcellvalue), [Excel.CalcErrorCellValue](/javascript/api/excel/excel.calcerrorcellvalue), [Excel.ConnectErrorCellValue](/javascript/api/excel/excel.connecterrorcellvalue), [Excel.Div0ErrorCellValue](/javascript/api/excel/excel.div0errorcellvalue), [Excel.ExternalErrorCellValue](/javascript/api/excel/excel.externalerrorcellvalue), [Excel.FieldErrorCellValue](/javascript/api/excel/excel.fielderrorcellvalue), [Excel.GettingDataErrorCellValue](/javascript/api/excel/excel.gettingdataerrorcellvalue), [Excel.NotAvailableErrorCellValue](/javascript/api/excel/excel.notavailableerrorcellvalue), [Excel.NameErrorCellValue](/javascript/api/excel/excel.nameerrorcellvalue), [Excel.NullErrorCellValue](/javascript/api/excel/excel.nullerrorcellvalue), [Excel.NumErrorCellValue](/javascript/api/excel/excel.numerrorcellvalue), [Excel.PlaceholderErrorCellValue](/javascript/api/excel/excel.placeholdererrorcellvalue), [Excel.RefErrorCellValue](/javascript/api/excel/excel.referrorcellvalue), [Excel.SpillErrorCellValue](/javascript/api/excel/excel.spillerrorcellvalue), [Excel.ValueErrorCellValue](/javascript/api/excel/excel.valueerrorcellvalue)\r\n\r\n#### Examples\n\n```TypeScript\n// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-error-values.yaml\n\n// This function sets the value of cell A1 to a #BUSY! error using data types.\nawait Excel.run(async (context) => {\n // Retrieve the Sample worksheet and cell A1 on that sheet.\n const sheet = context.workbook.worksheets.getItemOrNullObject(\"Sample\");\n const range = sheet.getRange(\"A1\");\n\n // Get the error data type and set its type to `busy`.\n const error: Excel.ErrorCellValue = {\n type: Excel.CellValueType.error,\n errorType: Excel.ErrorCellValueType.busy\n };\n\n // Set cell A1 as the busy error.\n range.valuesAsJson = [[error]];\n await context.sync();\n});\n```" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + + + Learn more about the types in this type alias through the following links. + + + [Excel.BlockedErrorCellValue](/javascript/api/excel/excel.blockederrorcellvalue), + [Excel.BusyErrorCellValue](/javascript/api/excel/excel.busyerrorcellvalue), + [Excel.CalcErrorCellValue](/javascript/api/excel/excel.calcerrorcellvalue), + [Excel.ConnectErrorCellValue](/javascript/api/excel/excel.connecterrorcellvalue), + [Excel.Div0ErrorCellValue](/javascript/api/excel/excel.div0errorcellvalue), + [Excel.ExternalErrorCellValue](/javascript/api/excel/excel.externalerrorcellvalue), + [Excel.FieldErrorCellValue](/javascript/api/excel/excel.fielderrorcellvalue), + [Excel.GettingDataErrorCellValue](/javascript/api/excel/excel.gettingdataerrorcellvalue), + [Excel.NotAvailableErrorCellValue](/javascript/api/excel/excel.notavailableerrorcellvalue), + [Excel.NameErrorCellValue](/javascript/api/excel/excel.nameerrorcellvalue), + [Excel.NullErrorCellValue](/javascript/api/excel/excel.nullerrorcellvalue), + [Excel.NumErrorCellValue](/javascript/api/excel/excel.numerrorcellvalue), + [Excel.PlaceholderErrorCellValue](/javascript/api/excel/excel.placeholdererrorcellvalue), + [Excel.RefErrorCellValue](/javascript/api/excel/excel.referrorcellvalue), + [Excel.SpillErrorCellValue](/javascript/api/excel/excel.spillerrorcellvalue), + [Excel.ValueErrorCellValue](/javascript/api/excel/excel.valueerrorcellvalue) + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-error-values.yaml + + + // This function sets the value of cell A1 to a #BUSY! error using data types. + + await Excel.run(async (context) => { + // Retrieve the Sample worksheet and cell A1 on that sheet. + const sheet = context.workbook.worksheets.getItemOrNullObject("Sample"); + const range = sheet.getRange("A1"); + + // Get the error data type and set its type to `busy`. + const error: Excel.ErrorCellValue = { + type: Excel.CellValueType.error, + errorType: Excel.ErrorCellValueType.busy + }; + + // Set cell A1 as the busy error. + range.valuesAsJson = [[error]]; + await context.sync(); + }); + + ``` isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_18/excel/excel.referencedvalue.yml b/docs/docs-ref-autogen/excel_1_18/excel/excel.referencedvalue.yml index 57044e8ebe..168b4928ba 100644 --- a/docs/docs-ref-autogen/excel_1_18/excel/excel.referencedvalue.yml +++ b/docs/docs-ref-autogen/excel_1_18/excel/excel.referencedvalue.yml @@ -4,7 +4,20 @@ uid: excel!Excel.ReferencedValue:type package: excel! fullName: Excel.ReferencedValue summary: Represents the value in a cell. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), [Excel.RootReferenceCellValue](/javascript/api/excel/excel.rootreferencecellvalue), [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), + [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), + [Excel.RootReferenceCellValue](/javascript/api/excel/excel.rootreferencecellvalue), + [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), + [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), + [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_19/excel/excel.cardlayout.yml b/docs/docs-ref-autogen/excel_1_19/excel/excel.cardlayout.yml index 4de2b1d604..07ebbc46e3 100644 --- a/docs/docs-ref-autogen/excel_1_19/excel/excel.cardlayout.yml +++ b/docs/docs-ref-autogen/excel_1_19/excel/excel.cardlayout.yml @@ -4,7 +4,15 @@ uid: excel!Excel.CardLayout:type package: excel! fullName: Excel.CardLayout summary: Represents the layout of a card in card view. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.EntityCardLayout](/javascript/api/excel/excel.entitycardlayout)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.EntityCardLayout](/javascript/api/excel/excel.entitycardlayout) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_19/excel/excel.cardlayoutsection.yml b/docs/docs-ref-autogen/excel_1_19/excel/excel.cardlayoutsection.yml index 5491f6727f..cca1b0c56e 100644 --- a/docs/docs-ref-autogen/excel_1_19/excel/excel.cardlayoutsection.yml +++ b/docs/docs-ref-autogen/excel_1_19/excel/excel.cardlayoutsection.yml @@ -4,7 +4,17 @@ uid: excel!Excel.CardLayoutSection:type package: excel! fullName: Excel.CardLayoutSection summary: Represents the layout of a section of a card in card view. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CardLayoutListSection](/javascript/api/excel/excel.cardlayoutlistsection), [Excel.CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection), [Excel.CardLayoutTwoColumnSection](/javascript/api/excel/excel.cardlayouttwocolumnsection)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CardLayoutListSection](/javascript/api/excel/excel.cardlayoutlistsection), + [Excel.CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection), + [Excel.CardLayoutTwoColumnSection](/javascript/api/excel/excel.cardlayouttwocolumnsection) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_19/excel/excel.cellcontrol.yml b/docs/docs-ref-autogen/excel_1_19/excel/excel.cellcontrol.yml index ecd03dccf2..5e5954d3df 100644 --- a/docs/docs-ref-autogen/excel_1_19/excel/excel.cellcontrol.yml +++ b/docs/docs-ref-autogen/excel_1_19/excel/excel.cellcontrol.yml @@ -4,7 +4,47 @@ uid: excel!Excel.CellControl:type package: excel! fullName: Excel.CellControl summary: Represents an interactable control inside of a cell. -remarks: "\\[ [API set: ExcelApi 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\n\n\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.UnknownCellControl](/javascript/api/excel/excel.unknowncellcontrol), [Excel.EmptyCellControl](/javascript/api/excel/excel.emptycellcontrol), [Excel.MixedCellControl](/javascript/api/excel/excel.mixedcellcontrol), [Excel.CheckboxCellControl](/javascript/api/excel/excel.checkboxcellcontrol)\r\n\r\n#### Examples\n\n```TypeScript\n// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml\n\n// Add checkboxes to the table.\nawait Excel.run(async (context) => {\n const sheet = context.workbook.worksheets.getActiveWorksheet();\n\n // Get the second column in the table, without the header.\n const range = sheet.tables.getItem(\"FruitTable\").columns.getItem(\"Analysis\").getDataBodyRange();\n\n // Change the boolean values to checkboxes.\n range.control = {\n type: Excel.CellControlType.checkbox\n };\n await context.sync();\n});\n```" +remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + + + Learn more about the types in this type alias through the following links. + + + [Excel.UnknownCellControl](/javascript/api/excel/excel.unknowncellcontrol), + [Excel.EmptyCellControl](/javascript/api/excel/excel.emptycellcontrol), + [Excel.MixedCellControl](/javascript/api/excel/excel.mixedcellcontrol), + [Excel.CheckboxCellControl](/javascript/api/excel/excel.checkboxcellcontrol) + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml + + + // Add checkboxes to the table. + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Get the second column in the table, without the header. + const range = sheet.tables.getItem("FruitTable").columns.getItem("Analysis").getDataBodyRange(); + + // Change the boolean values to checkboxes. + range.control = { + type: Excel.CellControlType.checkbox + }; + await context.sync(); + }); + + ``` isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_19/excel/excel.cellvalue.yml b/docs/docs-ref-autogen/excel_1_19/excel/excel.cellvalue.yml index ef4aaccfd2..4722937ebb 100644 --- a/docs/docs-ref-autogen/excel_1_19/excel/excel.cellvalue.yml +++ b/docs/docs-ref-autogen/excel_1_19/excel/excel.cellvalue.yml @@ -4,7 +4,28 @@ uid: excel!Excel.CellValue:type package: excel! fullName: Excel.CellValue summary: Represents the value in a cell. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue), [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), [Excel.EmptyCellValue](/javascript/api/excel/excel.emptycellvalue), [Excel.ErrorCellValue](/javascript/api/excel/excel.errorcellvalue), [Excel.FormattedNumberCellValue](/javascript/api/excel/excel.formattednumbercellvalue), [Excel.FunctionCellValue](/javascript/api/excel/excel.functioncellvalue), [Excel.LinkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalue), [Excel.ReferenceCellValue](/javascript/api/excel/excel.referencecellvalue), [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), [Excel.ValueTypeNotAvailableCellValue](/javascript/api/excel/excel.valuetypenotavailablecellvalue), [Excel.WebImageCellValue](/javascript/api/excel/excel.webimagecellvalue), [Excel.CellValueExtraProperties](/javascript/api/excel/excel.cellvalueextraproperties)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), + [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue), + [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), + [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), + [Excel.EmptyCellValue](/javascript/api/excel/excel.emptycellvalue), + [Excel.ErrorCellValue](/javascript/api/excel/excel.errorcellvalue), + [Excel.FormattedNumberCellValue](/javascript/api/excel/excel.formattednumbercellvalue), + [Excel.FunctionCellValue](/javascript/api/excel/excel.functioncellvalue), + [Excel.LinkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalue), + [Excel.ReferenceCellValue](/javascript/api/excel/excel.referencecellvalue), + [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), + [Excel.ValueTypeNotAvailableCellValue](/javascript/api/excel/excel.valuetypenotavailablecellvalue), + [Excel.WebImageCellValue](/javascript/api/excel/excel.webimagecellvalue), + [Excel.CellValueExtraProperties](/javascript/api/excel/excel.cellvalueextraproperties) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_19/excel/excel.cellvalueandpropertymetadata.yml b/docs/docs-ref-autogen/excel_1_19/excel/excel.cellvalueandpropertymetadata.yml index 566432a914..5f661bb32f 100644 --- a/docs/docs-ref-autogen/excel_1_19/excel/excel.cellvalueandpropertymetadata.yml +++ b/docs/docs-ref-autogen/excel_1_19/excel/excel.cellvalueandpropertymetadata.yml @@ -6,7 +6,16 @@ fullName: Excel.CellValueAndPropertyMetadata summary: >- Represents the value and metadata of a property. The metadata applies to the property (and not the value), but it is combined with the value in this type. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CellValue](/javascript/api/excel/excel.cellvalue), [Excel.EntityPropertyExtraProperties](/javascript/api/excel/excel.entitypropertyextraproperties)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CellValue](/javascript/api/excel/excel.cellvalue), + [Excel.EntityPropertyExtraProperties](/javascript/api/excel/excel.entitypropertyextraproperties) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_19/excel/excel.compactlayout.yml b/docs/docs-ref-autogen/excel_1_19/excel/excel.compactlayout.yml index 3f25496779..5bb689c662 100644 --- a/docs/docs-ref-autogen/excel_1_19/excel/excel.compactlayout.yml +++ b/docs/docs-ref-autogen/excel_1_19/excel/excel.compactlayout.yml @@ -6,7 +6,15 @@ fullName: Excel.CompactLayout summary: >- Represents the layout used when there is limited space to represent the entity. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.EntityCompactLayout](/javascript/api/excel/excel.entitycompactlayout)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.EntityCompactLayout](/javascript/api/excel/excel.entitycompactlayout) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_19/excel/excel.entitypropertytype.yml b/docs/docs-ref-autogen/excel_1_19/excel/excel.entitypropertytype.yml index 41a8cc7fcf..bc54a6eff6 100644 --- a/docs/docs-ref-autogen/excel_1_19/excel/excel.entitypropertytype.yml +++ b/docs/docs-ref-autogen/excel_1_19/excel/excel.entitypropertytype.yml @@ -4,7 +4,16 @@ uid: excel!Excel.EntityPropertyType:type package: excel! fullName: Excel.EntityPropertyType summary: Represents the value of a property. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CellValueAndPropertyMetadata](/javascript/api/excel/excel.cellvalueandpropertymetadata), [Excel.CellValue](/javascript/api/excel/excel.cellvalue)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CellValueAndPropertyMetadata](/javascript/api/excel/excel.cellvalueandpropertymetadata), + [Excel.CellValue](/javascript/api/excel/excel.cellvalue) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_19/excel/excel.errorcellvalue.yml b/docs/docs-ref-autogen/excel_1_19/excel/excel.errorcellvalue.yml index e5addcc22f..b88b1959c2 100644 --- a/docs/docs-ref-autogen/excel_1_19/excel/excel.errorcellvalue.yml +++ b/docs/docs-ref-autogen/excel_1_19/excel/excel.errorcellvalue.yml @@ -4,7 +4,62 @@ uid: excel!Excel.ErrorCellValue:type package: excel! fullName: Excel.ErrorCellValue summary: Represents a cell value which contains an error. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\n\n\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.BlockedErrorCellValue](/javascript/api/excel/excel.blockederrorcellvalue), [Excel.BusyErrorCellValue](/javascript/api/excel/excel.busyerrorcellvalue), [Excel.CalcErrorCellValue](/javascript/api/excel/excel.calcerrorcellvalue), [Excel.ConnectErrorCellValue](/javascript/api/excel/excel.connecterrorcellvalue), [Excel.Div0ErrorCellValue](/javascript/api/excel/excel.div0errorcellvalue), [Excel.ExternalErrorCellValue](/javascript/api/excel/excel.externalerrorcellvalue), [Excel.FieldErrorCellValue](/javascript/api/excel/excel.fielderrorcellvalue), [Excel.GettingDataErrorCellValue](/javascript/api/excel/excel.gettingdataerrorcellvalue), [Excel.NotAvailableErrorCellValue](/javascript/api/excel/excel.notavailableerrorcellvalue), [Excel.NameErrorCellValue](/javascript/api/excel/excel.nameerrorcellvalue), [Excel.NullErrorCellValue](/javascript/api/excel/excel.nullerrorcellvalue), [Excel.NumErrorCellValue](/javascript/api/excel/excel.numerrorcellvalue), [Excel.PlaceholderErrorCellValue](/javascript/api/excel/excel.placeholdererrorcellvalue), [Excel.RefErrorCellValue](/javascript/api/excel/excel.referrorcellvalue), [Excel.SpillErrorCellValue](/javascript/api/excel/excel.spillerrorcellvalue), [Excel.ValueErrorCellValue](/javascript/api/excel/excel.valueerrorcellvalue)\r\n\r\n#### Examples\n\n```TypeScript\n// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-error-values.yaml\n\n// This function sets the value of cell A1 to a #BUSY! error using data types.\nawait Excel.run(async (context) => {\n // Retrieve the Sample worksheet and cell A1 on that sheet.\n const sheet = context.workbook.worksheets.getItemOrNullObject(\"Sample\");\n const range = sheet.getRange(\"A1\");\n\n // Get the error data type and set its type to `busy`.\n const error: Excel.ErrorCellValue = {\n type: Excel.CellValueType.error,\n errorType: Excel.ErrorCellValueType.busy\n };\n\n // Set cell A1 as the busy error.\n range.valuesAsJson = [[error]];\n await context.sync();\n});\n```" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + + + Learn more about the types in this type alias through the following links. + + + [Excel.BlockedErrorCellValue](/javascript/api/excel/excel.blockederrorcellvalue), + [Excel.BusyErrorCellValue](/javascript/api/excel/excel.busyerrorcellvalue), + [Excel.CalcErrorCellValue](/javascript/api/excel/excel.calcerrorcellvalue), + [Excel.ConnectErrorCellValue](/javascript/api/excel/excel.connecterrorcellvalue), + [Excel.Div0ErrorCellValue](/javascript/api/excel/excel.div0errorcellvalue), + [Excel.ExternalErrorCellValue](/javascript/api/excel/excel.externalerrorcellvalue), + [Excel.FieldErrorCellValue](/javascript/api/excel/excel.fielderrorcellvalue), + [Excel.GettingDataErrorCellValue](/javascript/api/excel/excel.gettingdataerrorcellvalue), + [Excel.NotAvailableErrorCellValue](/javascript/api/excel/excel.notavailableerrorcellvalue), + [Excel.NameErrorCellValue](/javascript/api/excel/excel.nameerrorcellvalue), + [Excel.NullErrorCellValue](/javascript/api/excel/excel.nullerrorcellvalue), + [Excel.NumErrorCellValue](/javascript/api/excel/excel.numerrorcellvalue), + [Excel.PlaceholderErrorCellValue](/javascript/api/excel/excel.placeholdererrorcellvalue), + [Excel.RefErrorCellValue](/javascript/api/excel/excel.referrorcellvalue), + [Excel.SpillErrorCellValue](/javascript/api/excel/excel.spillerrorcellvalue), + [Excel.ValueErrorCellValue](/javascript/api/excel/excel.valueerrorcellvalue) + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-error-values.yaml + + + // This function sets the value of cell A1 to a #BUSY! error using data types. + + await Excel.run(async (context) => { + // Retrieve the Sample worksheet and cell A1 on that sheet. + const sheet = context.workbook.worksheets.getItemOrNullObject("Sample"); + const range = sheet.getRange("A1"); + + // Get the error data type and set its type to `busy`. + const error: Excel.ErrorCellValue = { + type: Excel.CellValueType.error, + errorType: Excel.ErrorCellValueType.busy + }; + + // Set cell A1 as the busy error. + range.valuesAsJson = [[error]]; + await context.sync(); + }); + + ``` isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_19/excel/excel.functioncellvalue.yml b/docs/docs-ref-autogen/excel_1_19/excel/excel.functioncellvalue.yml index 50b7239609..b1f83d2ff4 100644 --- a/docs/docs-ref-autogen/excel_1_19/excel/excel.functioncellvalue.yml +++ b/docs/docs-ref-autogen/excel_1_19/excel/excel.functioncellvalue.yml @@ -4,7 +4,15 @@ uid: excel!Excel.FunctionCellValue:type package: excel! fullName: Excel.FunctionCellValue summary: Represents a cell value which can be evaluated as a function. -remarks: "\\[ [API set: ExcelApi 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.JavaScriptCustomFunctionReferenceCellValue](/javascript/api/excel/excel.javascriptcustomfunctionreferencecellvalue)" +remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.JavaScriptCustomFunctionReferenceCellValue](/javascript/api/excel/excel.javascriptcustomfunctionreferencecellvalue) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_19/excel/excel.referencedvalue.yml b/docs/docs-ref-autogen/excel_1_19/excel/excel.referencedvalue.yml index 57044e8ebe..168b4928ba 100644 --- a/docs/docs-ref-autogen/excel_1_19/excel/excel.referencedvalue.yml +++ b/docs/docs-ref-autogen/excel_1_19/excel/excel.referencedvalue.yml @@ -4,7 +4,20 @@ uid: excel!Excel.ReferencedValue:type package: excel! fullName: Excel.ReferencedValue summary: Represents the value in a cell. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), [Excel.RootReferenceCellValue](/javascript/api/excel/excel.rootreferencecellvalue), [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), + [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), + [Excel.RootReferenceCellValue](/javascript/api/excel/excel.rootreferencecellvalue), + [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), + [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), + [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.cardlayout.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.cardlayout.yml index 4de2b1d604..07ebbc46e3 100644 --- a/docs/docs-ref-autogen/excel_1_20/excel/excel.cardlayout.yml +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.cardlayout.yml @@ -4,7 +4,15 @@ uid: excel!Excel.CardLayout:type package: excel! fullName: Excel.CardLayout summary: Represents the layout of a card in card view. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.EntityCardLayout](/javascript/api/excel/excel.entitycardlayout)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.EntityCardLayout](/javascript/api/excel/excel.entitycardlayout) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.cardlayoutsection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.cardlayoutsection.yml index 5491f6727f..cca1b0c56e 100644 --- a/docs/docs-ref-autogen/excel_1_20/excel/excel.cardlayoutsection.yml +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.cardlayoutsection.yml @@ -4,7 +4,17 @@ uid: excel!Excel.CardLayoutSection:type package: excel! fullName: Excel.CardLayoutSection summary: Represents the layout of a section of a card in card view. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CardLayoutListSection](/javascript/api/excel/excel.cardlayoutlistsection), [Excel.CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection), [Excel.CardLayoutTwoColumnSection](/javascript/api/excel/excel.cardlayouttwocolumnsection)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CardLayoutListSection](/javascript/api/excel/excel.cardlayoutlistsection), + [Excel.CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection), + [Excel.CardLayoutTwoColumnSection](/javascript/api/excel/excel.cardlayouttwocolumnsection) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.cellcontrol.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellcontrol.yml index ecd03dccf2..5e5954d3df 100644 --- a/docs/docs-ref-autogen/excel_1_20/excel/excel.cellcontrol.yml +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellcontrol.yml @@ -4,7 +4,47 @@ uid: excel!Excel.CellControl:type package: excel! fullName: Excel.CellControl summary: Represents an interactable control inside of a cell. -remarks: "\\[ [API set: ExcelApi 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\n\n\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.UnknownCellControl](/javascript/api/excel/excel.unknowncellcontrol), [Excel.EmptyCellControl](/javascript/api/excel/excel.emptycellcontrol), [Excel.MixedCellControl](/javascript/api/excel/excel.mixedcellcontrol), [Excel.CheckboxCellControl](/javascript/api/excel/excel.checkboxcellcontrol)\r\n\r\n#### Examples\n\n```TypeScript\n// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml\n\n// Add checkboxes to the table.\nawait Excel.run(async (context) => {\n const sheet = context.workbook.worksheets.getActiveWorksheet();\n\n // Get the second column in the table, without the header.\n const range = sheet.tables.getItem(\"FruitTable\").columns.getItem(\"Analysis\").getDataBodyRange();\n\n // Change the boolean values to checkboxes.\n range.control = {\n type: Excel.CellControlType.checkbox\n };\n await context.sync();\n});\n```" +remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + + + Learn more about the types in this type alias through the following links. + + + [Excel.UnknownCellControl](/javascript/api/excel/excel.unknowncellcontrol), + [Excel.EmptyCellControl](/javascript/api/excel/excel.emptycellcontrol), + [Excel.MixedCellControl](/javascript/api/excel/excel.mixedcellcontrol), + [Excel.CheckboxCellControl](/javascript/api/excel/excel.checkboxcellcontrol) + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml + + + // Add checkboxes to the table. + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Get the second column in the table, without the header. + const range = sheet.tables.getItem("FruitTable").columns.getItem("Analysis").getDataBodyRange(); + + // Change the boolean values to checkboxes. + range.control = { + type: Excel.CellControlType.checkbox + }; + await context.sync(); + }); + + ``` isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.cellvalue.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellvalue.yml index ef4aaccfd2..4722937ebb 100644 --- a/docs/docs-ref-autogen/excel_1_20/excel/excel.cellvalue.yml +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellvalue.yml @@ -4,7 +4,28 @@ uid: excel!Excel.CellValue:type package: excel! fullName: Excel.CellValue summary: Represents the value in a cell. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue), [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), [Excel.EmptyCellValue](/javascript/api/excel/excel.emptycellvalue), [Excel.ErrorCellValue](/javascript/api/excel/excel.errorcellvalue), [Excel.FormattedNumberCellValue](/javascript/api/excel/excel.formattednumbercellvalue), [Excel.FunctionCellValue](/javascript/api/excel/excel.functioncellvalue), [Excel.LinkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalue), [Excel.ReferenceCellValue](/javascript/api/excel/excel.referencecellvalue), [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), [Excel.ValueTypeNotAvailableCellValue](/javascript/api/excel/excel.valuetypenotavailablecellvalue), [Excel.WebImageCellValue](/javascript/api/excel/excel.webimagecellvalue), [Excel.CellValueExtraProperties](/javascript/api/excel/excel.cellvalueextraproperties)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), + [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue), + [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), + [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), + [Excel.EmptyCellValue](/javascript/api/excel/excel.emptycellvalue), + [Excel.ErrorCellValue](/javascript/api/excel/excel.errorcellvalue), + [Excel.FormattedNumberCellValue](/javascript/api/excel/excel.formattednumbercellvalue), + [Excel.FunctionCellValue](/javascript/api/excel/excel.functioncellvalue), + [Excel.LinkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalue), + [Excel.ReferenceCellValue](/javascript/api/excel/excel.referencecellvalue), + [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), + [Excel.ValueTypeNotAvailableCellValue](/javascript/api/excel/excel.valuetypenotavailablecellvalue), + [Excel.WebImageCellValue](/javascript/api/excel/excel.webimagecellvalue), + [Excel.CellValueExtraProperties](/javascript/api/excel/excel.cellvalueextraproperties) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.cellvalueandpropertymetadata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellvalueandpropertymetadata.yml index 566432a914..5f661bb32f 100644 --- a/docs/docs-ref-autogen/excel_1_20/excel/excel.cellvalueandpropertymetadata.yml +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellvalueandpropertymetadata.yml @@ -6,7 +6,16 @@ fullName: Excel.CellValueAndPropertyMetadata summary: >- Represents the value and metadata of a property. The metadata applies to the property (and not the value), but it is combined with the value in this type. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CellValue](/javascript/api/excel/excel.cellvalue), [Excel.EntityPropertyExtraProperties](/javascript/api/excel/excel.entitypropertyextraproperties)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CellValue](/javascript/api/excel/excel.cellvalue), + [Excel.EntityPropertyExtraProperties](/javascript/api/excel/excel.entitypropertyextraproperties) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.compactlayout.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.compactlayout.yml index 3f25496779..5bb689c662 100644 --- a/docs/docs-ref-autogen/excel_1_20/excel/excel.compactlayout.yml +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.compactlayout.yml @@ -6,7 +6,15 @@ fullName: Excel.CompactLayout summary: >- Represents the layout used when there is limited space to represent the entity. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.EntityCompactLayout](/javascript/api/excel/excel.entitycompactlayout)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.EntityCompactLayout](/javascript/api/excel/excel.entitycompactlayout) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.entitypropertytype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.entitypropertytype.yml index 41a8cc7fcf..bc54a6eff6 100644 --- a/docs/docs-ref-autogen/excel_1_20/excel/excel.entitypropertytype.yml +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.entitypropertytype.yml @@ -4,7 +4,16 @@ uid: excel!Excel.EntityPropertyType:type package: excel! fullName: Excel.EntityPropertyType summary: Represents the value of a property. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CellValueAndPropertyMetadata](/javascript/api/excel/excel.cellvalueandpropertymetadata), [Excel.CellValue](/javascript/api/excel/excel.cellvalue)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CellValueAndPropertyMetadata](/javascript/api/excel/excel.cellvalueandpropertymetadata), + [Excel.CellValue](/javascript/api/excel/excel.cellvalue) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.errorcellvalue.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.errorcellvalue.yml index e5addcc22f..b88b1959c2 100644 --- a/docs/docs-ref-autogen/excel_1_20/excel/excel.errorcellvalue.yml +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.errorcellvalue.yml @@ -4,7 +4,62 @@ uid: excel!Excel.ErrorCellValue:type package: excel! fullName: Excel.ErrorCellValue summary: Represents a cell value which contains an error. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\n\n\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.BlockedErrorCellValue](/javascript/api/excel/excel.blockederrorcellvalue), [Excel.BusyErrorCellValue](/javascript/api/excel/excel.busyerrorcellvalue), [Excel.CalcErrorCellValue](/javascript/api/excel/excel.calcerrorcellvalue), [Excel.ConnectErrorCellValue](/javascript/api/excel/excel.connecterrorcellvalue), [Excel.Div0ErrorCellValue](/javascript/api/excel/excel.div0errorcellvalue), [Excel.ExternalErrorCellValue](/javascript/api/excel/excel.externalerrorcellvalue), [Excel.FieldErrorCellValue](/javascript/api/excel/excel.fielderrorcellvalue), [Excel.GettingDataErrorCellValue](/javascript/api/excel/excel.gettingdataerrorcellvalue), [Excel.NotAvailableErrorCellValue](/javascript/api/excel/excel.notavailableerrorcellvalue), [Excel.NameErrorCellValue](/javascript/api/excel/excel.nameerrorcellvalue), [Excel.NullErrorCellValue](/javascript/api/excel/excel.nullerrorcellvalue), [Excel.NumErrorCellValue](/javascript/api/excel/excel.numerrorcellvalue), [Excel.PlaceholderErrorCellValue](/javascript/api/excel/excel.placeholdererrorcellvalue), [Excel.RefErrorCellValue](/javascript/api/excel/excel.referrorcellvalue), [Excel.SpillErrorCellValue](/javascript/api/excel/excel.spillerrorcellvalue), [Excel.ValueErrorCellValue](/javascript/api/excel/excel.valueerrorcellvalue)\r\n\r\n#### Examples\n\n```TypeScript\n// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-error-values.yaml\n\n// This function sets the value of cell A1 to a #BUSY! error using data types.\nawait Excel.run(async (context) => {\n // Retrieve the Sample worksheet and cell A1 on that sheet.\n const sheet = context.workbook.worksheets.getItemOrNullObject(\"Sample\");\n const range = sheet.getRange(\"A1\");\n\n // Get the error data type and set its type to `busy`.\n const error: Excel.ErrorCellValue = {\n type: Excel.CellValueType.error,\n errorType: Excel.ErrorCellValueType.busy\n };\n\n // Set cell A1 as the busy error.\n range.valuesAsJson = [[error]];\n await context.sync();\n});\n```" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + + + Learn more about the types in this type alias through the following links. + + + [Excel.BlockedErrorCellValue](/javascript/api/excel/excel.blockederrorcellvalue), + [Excel.BusyErrorCellValue](/javascript/api/excel/excel.busyerrorcellvalue), + [Excel.CalcErrorCellValue](/javascript/api/excel/excel.calcerrorcellvalue), + [Excel.ConnectErrorCellValue](/javascript/api/excel/excel.connecterrorcellvalue), + [Excel.Div0ErrorCellValue](/javascript/api/excel/excel.div0errorcellvalue), + [Excel.ExternalErrorCellValue](/javascript/api/excel/excel.externalerrorcellvalue), + [Excel.FieldErrorCellValue](/javascript/api/excel/excel.fielderrorcellvalue), + [Excel.GettingDataErrorCellValue](/javascript/api/excel/excel.gettingdataerrorcellvalue), + [Excel.NotAvailableErrorCellValue](/javascript/api/excel/excel.notavailableerrorcellvalue), + [Excel.NameErrorCellValue](/javascript/api/excel/excel.nameerrorcellvalue), + [Excel.NullErrorCellValue](/javascript/api/excel/excel.nullerrorcellvalue), + [Excel.NumErrorCellValue](/javascript/api/excel/excel.numerrorcellvalue), + [Excel.PlaceholderErrorCellValue](/javascript/api/excel/excel.placeholdererrorcellvalue), + [Excel.RefErrorCellValue](/javascript/api/excel/excel.referrorcellvalue), + [Excel.SpillErrorCellValue](/javascript/api/excel/excel.spillerrorcellvalue), + [Excel.ValueErrorCellValue](/javascript/api/excel/excel.valueerrorcellvalue) + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-error-values.yaml + + + // This function sets the value of cell A1 to a #BUSY! error using data types. + + await Excel.run(async (context) => { + // Retrieve the Sample worksheet and cell A1 on that sheet. + const sheet = context.workbook.worksheets.getItemOrNullObject("Sample"); + const range = sheet.getRange("A1"); + + // Get the error data type and set its type to `busy`. + const error: Excel.ErrorCellValue = { + type: Excel.CellValueType.error, + errorType: Excel.ErrorCellValueType.busy + }; + + // Set cell A1 as the busy error. + range.valuesAsJson = [[error]]; + await context.sync(); + }); + + ``` isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.functioncellvalue.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.functioncellvalue.yml index 50b7239609..b1f83d2ff4 100644 --- a/docs/docs-ref-autogen/excel_1_20/excel/excel.functioncellvalue.yml +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.functioncellvalue.yml @@ -4,7 +4,15 @@ uid: excel!Excel.FunctionCellValue:type package: excel! fullName: Excel.FunctionCellValue summary: Represents a cell value which can be evaluated as a function. -remarks: "\\[ [API set: ExcelApi 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.JavaScriptCustomFunctionReferenceCellValue](/javascript/api/excel/excel.javascriptcustomfunctionreferencecellvalue)" +remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.JavaScriptCustomFunctionReferenceCellValue](/javascript/api/excel/excel.javascriptcustomfunctionreferencecellvalue) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.referencedvalue.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.referencedvalue.yml index 57044e8ebe..168b4928ba 100644 --- a/docs/docs-ref-autogen/excel_1_20/excel/excel.referencedvalue.yml +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.referencedvalue.yml @@ -4,7 +4,20 @@ uid: excel!Excel.ReferencedValue:type package: excel! fullName: Excel.ReferencedValue summary: Represents the value in a cell. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), [Excel.RootReferenceCellValue](/javascript/api/excel/excel.rootreferencecellvalue), [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), + [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), + [Excel.RootReferenceCellValue](/javascript/api/excel/excel.rootreferencecellvalue), + [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), + [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), + [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_online/excel/excel.cardlayout.yml b/docs/docs-ref-autogen/excel_online/excel/excel.cardlayout.yml index 4de2b1d604..07ebbc46e3 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.cardlayout.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.cardlayout.yml @@ -4,7 +4,15 @@ uid: excel!Excel.CardLayout:type package: excel! fullName: Excel.CardLayout summary: Represents the layout of a card in card view. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.EntityCardLayout](/javascript/api/excel/excel.entitycardlayout)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.EntityCardLayout](/javascript/api/excel/excel.entitycardlayout) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_online/excel/excel.cardlayoutsection.yml b/docs/docs-ref-autogen/excel_online/excel/excel.cardlayoutsection.yml index 5491f6727f..cca1b0c56e 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.cardlayoutsection.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.cardlayoutsection.yml @@ -4,7 +4,17 @@ uid: excel!Excel.CardLayoutSection:type package: excel! fullName: Excel.CardLayoutSection summary: Represents the layout of a section of a card in card view. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CardLayoutListSection](/javascript/api/excel/excel.cardlayoutlistsection), [Excel.CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection), [Excel.CardLayoutTwoColumnSection](/javascript/api/excel/excel.cardlayouttwocolumnsection)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CardLayoutListSection](/javascript/api/excel/excel.cardlayoutlistsection), + [Excel.CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection), + [Excel.CardLayoutTwoColumnSection](/javascript/api/excel/excel.cardlayouttwocolumnsection) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_online/excel/excel.cellcontrol.yml b/docs/docs-ref-autogen/excel_online/excel/excel.cellcontrol.yml index ecd03dccf2..5e5954d3df 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.cellcontrol.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.cellcontrol.yml @@ -4,7 +4,47 @@ uid: excel!Excel.CellControl:type package: excel! fullName: Excel.CellControl summary: Represents an interactable control inside of a cell. -remarks: "\\[ [API set: ExcelApi 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\n\n\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.UnknownCellControl](/javascript/api/excel/excel.unknowncellcontrol), [Excel.EmptyCellControl](/javascript/api/excel/excel.emptycellcontrol), [Excel.MixedCellControl](/javascript/api/excel/excel.mixedcellcontrol), [Excel.CheckboxCellControl](/javascript/api/excel/excel.checkboxcellcontrol)\r\n\r\n#### Examples\n\n```TypeScript\n// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml\n\n// Add checkboxes to the table.\nawait Excel.run(async (context) => {\n const sheet = context.workbook.worksheets.getActiveWorksheet();\n\n // Get the second column in the table, without the header.\n const range = sheet.tables.getItem(\"FruitTable\").columns.getItem(\"Analysis\").getDataBodyRange();\n\n // Change the boolean values to checkboxes.\n range.control = {\n type: Excel.CellControlType.checkbox\n };\n await context.sync();\n});\n```" +remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + + + Learn more about the types in this type alias through the following links. + + + [Excel.UnknownCellControl](/javascript/api/excel/excel.unknowncellcontrol), + [Excel.EmptyCellControl](/javascript/api/excel/excel.emptycellcontrol), + [Excel.MixedCellControl](/javascript/api/excel/excel.mixedcellcontrol), + [Excel.CheckboxCellControl](/javascript/api/excel/excel.checkboxcellcontrol) + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml + + + // Add checkboxes to the table. + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Get the second column in the table, without the header. + const range = sheet.tables.getItem("FruitTable").columns.getItem("Analysis").getDataBodyRange(); + + // Change the boolean values to checkboxes. + range.control = { + type: Excel.CellControlType.checkbox + }; + await context.sync(); + }); + + ``` isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_online/excel/excel.cellvalue.yml b/docs/docs-ref-autogen/excel_online/excel/excel.cellvalue.yml index ef4aaccfd2..4722937ebb 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.cellvalue.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.cellvalue.yml @@ -4,7 +4,28 @@ uid: excel!Excel.CellValue:type package: excel! fullName: Excel.CellValue summary: Represents the value in a cell. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue), [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), [Excel.EmptyCellValue](/javascript/api/excel/excel.emptycellvalue), [Excel.ErrorCellValue](/javascript/api/excel/excel.errorcellvalue), [Excel.FormattedNumberCellValue](/javascript/api/excel/excel.formattednumbercellvalue), [Excel.FunctionCellValue](/javascript/api/excel/excel.functioncellvalue), [Excel.LinkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalue), [Excel.ReferenceCellValue](/javascript/api/excel/excel.referencecellvalue), [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), [Excel.ValueTypeNotAvailableCellValue](/javascript/api/excel/excel.valuetypenotavailablecellvalue), [Excel.WebImageCellValue](/javascript/api/excel/excel.webimagecellvalue), [Excel.CellValueExtraProperties](/javascript/api/excel/excel.cellvalueextraproperties)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), + [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue), + [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), + [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), + [Excel.EmptyCellValue](/javascript/api/excel/excel.emptycellvalue), + [Excel.ErrorCellValue](/javascript/api/excel/excel.errorcellvalue), + [Excel.FormattedNumberCellValue](/javascript/api/excel/excel.formattednumbercellvalue), + [Excel.FunctionCellValue](/javascript/api/excel/excel.functioncellvalue), + [Excel.LinkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalue), + [Excel.ReferenceCellValue](/javascript/api/excel/excel.referencecellvalue), + [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), + [Excel.ValueTypeNotAvailableCellValue](/javascript/api/excel/excel.valuetypenotavailablecellvalue), + [Excel.WebImageCellValue](/javascript/api/excel/excel.webimagecellvalue), + [Excel.CellValueExtraProperties](/javascript/api/excel/excel.cellvalueextraproperties) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_online/excel/excel.cellvalueandpropertymetadata.yml b/docs/docs-ref-autogen/excel_online/excel/excel.cellvalueandpropertymetadata.yml index 566432a914..5f661bb32f 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.cellvalueandpropertymetadata.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.cellvalueandpropertymetadata.yml @@ -6,7 +6,16 @@ fullName: Excel.CellValueAndPropertyMetadata summary: >- Represents the value and metadata of a property. The metadata applies to the property (and not the value), but it is combined with the value in this type. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CellValue](/javascript/api/excel/excel.cellvalue), [Excel.EntityPropertyExtraProperties](/javascript/api/excel/excel.entitypropertyextraproperties)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CellValue](/javascript/api/excel/excel.cellvalue), + [Excel.EntityPropertyExtraProperties](/javascript/api/excel/excel.entitypropertyextraproperties) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_online/excel/excel.compactlayout.yml b/docs/docs-ref-autogen/excel_online/excel/excel.compactlayout.yml index 3f25496779..5bb689c662 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.compactlayout.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.compactlayout.yml @@ -6,7 +6,15 @@ fullName: Excel.CompactLayout summary: >- Represents the layout used when there is limited space to represent the entity. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.EntityCompactLayout](/javascript/api/excel/excel.entitycompactlayout)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.EntityCompactLayout](/javascript/api/excel/excel.entitycompactlayout) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_online/excel/excel.entitypropertytype.yml b/docs/docs-ref-autogen/excel_online/excel/excel.entitypropertytype.yml index 41a8cc7fcf..bc54a6eff6 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.entitypropertytype.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.entitypropertytype.yml @@ -4,7 +4,16 @@ uid: excel!Excel.EntityPropertyType:type package: excel! fullName: Excel.EntityPropertyType summary: Represents the value of a property. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CellValueAndPropertyMetadata](/javascript/api/excel/excel.cellvalueandpropertymetadata), [Excel.CellValue](/javascript/api/excel/excel.cellvalue)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CellValueAndPropertyMetadata](/javascript/api/excel/excel.cellvalueandpropertymetadata), + [Excel.CellValue](/javascript/api/excel/excel.cellvalue) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_online/excel/excel.errorcellvalue.yml b/docs/docs-ref-autogen/excel_online/excel/excel.errorcellvalue.yml index e5addcc22f..b88b1959c2 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.errorcellvalue.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.errorcellvalue.yml @@ -4,7 +4,62 @@ uid: excel!Excel.ErrorCellValue:type package: excel! fullName: Excel.ErrorCellValue summary: Represents a cell value which contains an error. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\n\n\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.BlockedErrorCellValue](/javascript/api/excel/excel.blockederrorcellvalue), [Excel.BusyErrorCellValue](/javascript/api/excel/excel.busyerrorcellvalue), [Excel.CalcErrorCellValue](/javascript/api/excel/excel.calcerrorcellvalue), [Excel.ConnectErrorCellValue](/javascript/api/excel/excel.connecterrorcellvalue), [Excel.Div0ErrorCellValue](/javascript/api/excel/excel.div0errorcellvalue), [Excel.ExternalErrorCellValue](/javascript/api/excel/excel.externalerrorcellvalue), [Excel.FieldErrorCellValue](/javascript/api/excel/excel.fielderrorcellvalue), [Excel.GettingDataErrorCellValue](/javascript/api/excel/excel.gettingdataerrorcellvalue), [Excel.NotAvailableErrorCellValue](/javascript/api/excel/excel.notavailableerrorcellvalue), [Excel.NameErrorCellValue](/javascript/api/excel/excel.nameerrorcellvalue), [Excel.NullErrorCellValue](/javascript/api/excel/excel.nullerrorcellvalue), [Excel.NumErrorCellValue](/javascript/api/excel/excel.numerrorcellvalue), [Excel.PlaceholderErrorCellValue](/javascript/api/excel/excel.placeholdererrorcellvalue), [Excel.RefErrorCellValue](/javascript/api/excel/excel.referrorcellvalue), [Excel.SpillErrorCellValue](/javascript/api/excel/excel.spillerrorcellvalue), [Excel.ValueErrorCellValue](/javascript/api/excel/excel.valueerrorcellvalue)\r\n\r\n#### Examples\n\n```TypeScript\n// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-error-values.yaml\n\n// This function sets the value of cell A1 to a #BUSY! error using data types.\nawait Excel.run(async (context) => {\n // Retrieve the Sample worksheet and cell A1 on that sheet.\n const sheet = context.workbook.worksheets.getItemOrNullObject(\"Sample\");\n const range = sheet.getRange(\"A1\");\n\n // Get the error data type and set its type to `busy`.\n const error: Excel.ErrorCellValue = {\n type: Excel.CellValueType.error,\n errorType: Excel.ErrorCellValueType.busy\n };\n\n // Set cell A1 as the busy error.\n range.valuesAsJson = [[error]];\n await context.sync();\n});\n```" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + + + Learn more about the types in this type alias through the following links. + + + [Excel.BlockedErrorCellValue](/javascript/api/excel/excel.blockederrorcellvalue), + [Excel.BusyErrorCellValue](/javascript/api/excel/excel.busyerrorcellvalue), + [Excel.CalcErrorCellValue](/javascript/api/excel/excel.calcerrorcellvalue), + [Excel.ConnectErrorCellValue](/javascript/api/excel/excel.connecterrorcellvalue), + [Excel.Div0ErrorCellValue](/javascript/api/excel/excel.div0errorcellvalue), + [Excel.ExternalErrorCellValue](/javascript/api/excel/excel.externalerrorcellvalue), + [Excel.FieldErrorCellValue](/javascript/api/excel/excel.fielderrorcellvalue), + [Excel.GettingDataErrorCellValue](/javascript/api/excel/excel.gettingdataerrorcellvalue), + [Excel.NotAvailableErrorCellValue](/javascript/api/excel/excel.notavailableerrorcellvalue), + [Excel.NameErrorCellValue](/javascript/api/excel/excel.nameerrorcellvalue), + [Excel.NullErrorCellValue](/javascript/api/excel/excel.nullerrorcellvalue), + [Excel.NumErrorCellValue](/javascript/api/excel/excel.numerrorcellvalue), + [Excel.PlaceholderErrorCellValue](/javascript/api/excel/excel.placeholdererrorcellvalue), + [Excel.RefErrorCellValue](/javascript/api/excel/excel.referrorcellvalue), + [Excel.SpillErrorCellValue](/javascript/api/excel/excel.spillerrorcellvalue), + [Excel.ValueErrorCellValue](/javascript/api/excel/excel.valueerrorcellvalue) + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-error-values.yaml + + + // This function sets the value of cell A1 to a #BUSY! error using data types. + + await Excel.run(async (context) => { + // Retrieve the Sample worksheet and cell A1 on that sheet. + const sheet = context.workbook.worksheets.getItemOrNullObject("Sample"); + const range = sheet.getRange("A1"); + + // Get the error data type and set its type to `busy`. + const error: Excel.ErrorCellValue = { + type: Excel.CellValueType.error, + errorType: Excel.ErrorCellValueType.busy + }; + + // Set cell A1 as the busy error. + range.valuesAsJson = [[error]]; + await context.sync(); + }); + + ``` isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_online/excel/excel.functioncellvalue.yml b/docs/docs-ref-autogen/excel_online/excel/excel.functioncellvalue.yml index 50b7239609..b1f83d2ff4 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.functioncellvalue.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.functioncellvalue.yml @@ -4,7 +4,15 @@ uid: excel!Excel.FunctionCellValue:type package: excel! fullName: Excel.FunctionCellValue summary: Represents a cell value which can be evaluated as a function. -remarks: "\\[ [API set: ExcelApi 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.JavaScriptCustomFunctionReferenceCellValue](/javascript/api/excel/excel.javascriptcustomfunctionreferencecellvalue)" +remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.JavaScriptCustomFunctionReferenceCellValue](/javascript/api/excel/excel.javascriptcustomfunctionreferencecellvalue) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_online/excel/excel.referencedvalue.yml b/docs/docs-ref-autogen/excel_online/excel/excel.referencedvalue.yml index 57044e8ebe..168b4928ba 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.referencedvalue.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.referencedvalue.yml @@ -4,7 +4,20 @@ uid: excel!Excel.ReferencedValue:type package: excel! fullName: Excel.ReferencedValue summary: Represents the value in a cell. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), [Excel.RootReferenceCellValue](/javascript/api/excel/excel.rootreferencecellvalue), [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), + [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), + [Excel.RootReferenceCellValue](/javascript/api/excel/excel.rootreferencecellvalue), + [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), + [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), + [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue) isPreview: false isDeprecated: false diff --git a/docs/includes/excel-1_1.md b/docs/includes/excel-1_1.md index 7b5da6c0ad..a10a15841b 100644 --- a/docs/includes/excel-1_1.md +++ b/docs/includes/excel-1_1.md @@ -1,219 +1,219 @@ | Class | Fields | Description | |:---|:---|:---| -|[Application](/javascript/api/excel/excel.application)|[calculate(calculationType: Excel.CalculationType)](/javascript/api/excel/excel.application#excel-excel-application-calculate-member(1))|Recalculate all currently opened workbooks in Excel.| -||[calculationMode](/javascript/api/excel/excel.application#excel-excel-application-calculationmode-member)|Returns the calculation mode used in the workbook, as defined by the constants in `Excel.CalculationMode`.| -|[Binding](/javascript/api/excel/excel.binding)|[getRange()](/javascript/api/excel/excel.binding#excel-excel-binding-getrange-member(1))|Returns the range represented by the binding.| -||[getTable()](/javascript/api/excel/excel.binding#excel-excel-binding-gettable-member(1))|Returns the table represented by the binding.| -||[getText()](/javascript/api/excel/excel.binding#excel-excel-binding-gettext-member(1))|Returns the text represented by the binding.| -||[id](/javascript/api/excel/excel.binding#excel-excel-binding-id-member)|Represents the binding identifier.| -||[type](/javascript/api/excel/excel.binding#excel-excel-binding-type-member)|Returns the type of the binding.| -|[BindingCollection](/javascript/api/excel/excel.bindingcollection)|[count](/javascript/api/excel/excel.bindingcollection#excel-excel-bindingcollection-count-member)|Returns the number of bindings in the collection.| -||[getItem(id: string)](/javascript/api/excel/excel.bindingcollection#excel-excel-bindingcollection-getitem-member(1))|Gets a binding object by ID.| -||[getItemAt(index: number)](/javascript/api/excel/excel.bindingcollection#excel-excel-bindingcollection-getitemat-member(1))|Gets a binding object based on its position in the items array.| -||[items](/javascript/api/excel/excel.bindingcollection#excel-excel-bindingcollection-items-member)|Gets the loaded child items in this collection.| -|[Chart](/javascript/api/excel/excel.chart)|[axes](/javascript/api/excel/excel.chart#excel-excel-chart-axes-member)|Represents chart axes.| -||[dataLabels](/javascript/api/excel/excel.chart#excel-excel-chart-datalabels-member)|Represents the data labels on the chart.| -||[delete()](/javascript/api/excel/excel.chart#excel-excel-chart-delete-member(1))|Deletes the chart object.| -||[format](/javascript/api/excel/excel.chart#excel-excel-chart-format-member)|Encapsulates the format properties for the chart area.| -||[height](/javascript/api/excel/excel.chart#excel-excel-chart-height-member)|Specifies the height, in points, of the chart object.| -||[left](/javascript/api/excel/excel.chart#excel-excel-chart-left-member)|The distance, in points, from the left side of the chart to the worksheet origin.| -||[legend](/javascript/api/excel/excel.chart#excel-excel-chart-legend-member)|Represents the legend for the chart.| -||[name](/javascript/api/excel/excel.chart#excel-excel-chart-name-member)|Specifies the name of a chart object.| -||[series](/javascript/api/excel/excel.chart#excel-excel-chart-series-member)|Represents either a single series or collection of series in the chart.| -||[setData(sourceData: Range, seriesBy?: Excel.ChartSeriesBy)](/javascript/api/excel/excel.chart#excel-excel-chart-setdata-member(1))|Resets the source data for the chart.| -||[setPosition(startCell: Range \| string, endCell?: Range \| string)](/javascript/api/excel/excel.chart#excel-excel-chart-setposition-member(1))|Positions the chart relative to cells on the worksheet.| -||[title](/javascript/api/excel/excel.chart#excel-excel-chart-title-member)|Represents the title of the specified chart, including the text, visibility, position, and formatting of the title.| -||[top](/javascript/api/excel/excel.chart#excel-excel-chart-top-member)|Specifies the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top of the chart area (on a chart).| -||[width](/javascript/api/excel/excel.chart#excel-excel-chart-width-member)|Specifies the width, in points, of the chart object.| -|[ChartAreaFormat](/javascript/api/excel/excel.chartareaformat)|[fill](/javascript/api/excel/excel.chartareaformat#excel-excel-chartareaformat-fill-member)|Represents the fill format of an object, which includes background formatting information.| -||[font](/javascript/api/excel/excel.chartareaformat#excel-excel-chartareaformat-font-member)|Represents the font attributes (font name, font size, color, etc.) for the current object.| -|[ChartAxes](/javascript/api/excel/excel.chartaxes)|[categoryAxis](/javascript/api/excel/excel.chartaxes#excel-excel-chartaxes-categoryaxis-member)|Represents the category axis in a chart.| -||[seriesAxis](/javascript/api/excel/excel.chartaxes#excel-excel-chartaxes-seriesaxis-member)|Represents the series axis of a 3-D chart.| -||[valueAxis](/javascript/api/excel/excel.chartaxes#excel-excel-chartaxes-valueaxis-member)|Represents the value axis in an axis.| -|[ChartAxis](/javascript/api/excel/excel.chartaxis)|[format](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-format-member)|Represents the formatting of a chart object, which includes line and font formatting.| -||[majorGridlines](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-majorgridlines-member)|Returns an object that represents the major gridlines for the specified axis.| -||[majorUnit](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-majorunit-member)|Represents the interval between two major tick marks.| -||[maximum](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-maximum-member)|Represents the maximum value on the value axis.| -||[minimum](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-minimum-member)|Represents the minimum value on the value axis.| -||[minorGridlines](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-minorgridlines-member)|Returns an object that represents the minor gridlines for the specified axis.| -||[minorUnit](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-minorunit-member)|Represents the interval between two minor tick marks.| -||[title](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-title-member)|Represents the axis title.| -|[ChartAxisFormat](/javascript/api/excel/excel.chartaxisformat)|[font](/javascript/api/excel/excel.chartaxisformat#excel-excel-chartaxisformat-font-member)|Specifies the font attributes (font name, font size, color, etc.) for a chart axis element.| -||[line](/javascript/api/excel/excel.chartaxisformat#excel-excel-chartaxisformat-line-member)|Specifies chart line formatting.| -|[ChartAxisTitle](/javascript/api/excel/excel.chartaxistitle)|[format](/javascript/api/excel/excel.chartaxistitle#excel-excel-chartaxistitle-format-member)|Specifies the formatting of the chart axis title.| -||[text](/javascript/api/excel/excel.chartaxistitle#excel-excel-chartaxistitle-text-member)|Specifies the axis title.| -||[visible](/javascript/api/excel/excel.chartaxistitle#excel-excel-chartaxistitle-visible-member)|Specifies if the axis title is visible.| -|[ChartAxisTitleFormat](/javascript/api/excel/excel.chartaxistitleformat)|[font](/javascript/api/excel/excel.chartaxistitleformat#excel-excel-chartaxistitleformat-font-member)|Specifies the chart axis title's font attributes, such as font name, font size, or color, of the chart axis title object.| -|[ChartCollection](/javascript/api/excel/excel.chartcollection)|[add(type: Excel.ChartType, sourceData: Range, seriesBy?: Excel.ChartSeriesBy)](/javascript/api/excel/excel.chartcollection#excel-excel-chartcollection-add-member(1))|Creates a new chart.| -||[count](/javascript/api/excel/excel.chartcollection#excel-excel-chartcollection-count-member)|Returns the number of charts in the worksheet.| -||[getItem(name: string)](/javascript/api/excel/excel.chartcollection#excel-excel-chartcollection-getitem-member(1))|Gets a chart using its name.| -||[getItemAt(index: number)](/javascript/api/excel/excel.chartcollection#excel-excel-chartcollection-getitemat-member(1))|Gets a chart based on its position in the collection.| -||[items](/javascript/api/excel/excel.chartcollection#excel-excel-chartcollection-items-member)|Gets the loaded child items in this collection.| -|[ChartDataLabelFormat](/javascript/api/excel/excel.chartdatalabelformat)|[fill](/javascript/api/excel/excel.chartdatalabelformat#excel-excel-chartdatalabelformat-fill-member)|Represents the fill format of the current chart data label.| -||[font](/javascript/api/excel/excel.chartdatalabelformat#excel-excel-chartdatalabelformat-font-member)|Represents the font attributes (such as font name, font size, and color) for a chart data label.| -|[ChartDataLabels](/javascript/api/excel/excel.chartdatalabels)|[format](/javascript/api/excel/excel.chartdatalabels#excel-excel-chartdatalabels-format-member)|Specifies the format of chart data labels, which includes fill and font formatting.| -||[position](/javascript/api/excel/excel.chartdatalabels#excel-excel-chartdatalabels-position-member)|Value that represents the position of the data label.| -||[separator](/javascript/api/excel/excel.chartdatalabels#excel-excel-chartdatalabels-separator-member)|String representing the separator used for the data labels on a chart.| -||[showBubbleSize](/javascript/api/excel/excel.chartdatalabels#excel-excel-chartdatalabels-showbubblesize-member)|Specifies if the data label bubble size is visible.| -||[showCategoryName](/javascript/api/excel/excel.chartdatalabels#excel-excel-chartdatalabels-showcategoryname-member)|Specifies if the data label category name is visible.| -||[showLegendKey](/javascript/api/excel/excel.chartdatalabels#excel-excel-chartdatalabels-showlegendkey-member)|Specifies if the data label legend key is visible.| -||[showPercentage](/javascript/api/excel/excel.chartdatalabels#excel-excel-chartdatalabels-showpercentage-member)|Specifies if the data label percentage is visible.| -||[showSeriesName](/javascript/api/excel/excel.chartdatalabels#excel-excel-chartdatalabels-showseriesname-member)|Specifies if the data label series name is visible.| -||[showValue](/javascript/api/excel/excel.chartdatalabels#excel-excel-chartdatalabels-showvalue-member)|Specifies if the data label value is visible.| -|[ChartFill](/javascript/api/excel/excel.chartfill)|[clear()](/javascript/api/excel/excel.chartfill#excel-excel-chartfill-clear-member(1))|Clears the fill color of a chart element.| -||[setSolidColor(color: string)](/javascript/api/excel/excel.chartfill#excel-excel-chartfill-setsolidcolor-member(1))|Sets the fill formatting of a chart element to a uniform color.| -|[ChartFont](/javascript/api/excel/excel.chartfont)|[bold](/javascript/api/excel/excel.chartfont#excel-excel-chartfont-bold-member)|Represents the bold status of font.| -||[color](/javascript/api/excel/excel.chartfont#excel-excel-chartfont-color-member)|HTML color code representation of the text color (e.g., #FF0000 represents Red).| -||[italic](/javascript/api/excel/excel.chartfont#excel-excel-chartfont-italic-member)|Represents the italic status of the font.| -||[name](/javascript/api/excel/excel.chartfont#excel-excel-chartfont-name-member)|Font name (e.g., "Calibri")| -||[size](/javascript/api/excel/excel.chartfont#excel-excel-chartfont-size-member)|Size of the font (e.g., 11)| -||[underline](/javascript/api/excel/excel.chartfont#excel-excel-chartfont-underline-member)|Type of underline applied to the font.| -|[ChartGridlines](/javascript/api/excel/excel.chartgridlines)|[format](/javascript/api/excel/excel.chartgridlines#excel-excel-chartgridlines-format-member)|Represents the formatting of chart gridlines.| -||[visible](/javascript/api/excel/excel.chartgridlines#excel-excel-chartgridlines-visible-member)|Specifies if the axis gridlines are visible.| -|[ChartGridlinesFormat](/javascript/api/excel/excel.chartgridlinesformat)|[line](/javascript/api/excel/excel.chartgridlinesformat#excel-excel-chartgridlinesformat-line-member)|Represents chart line formatting.| -|[ChartLegend](/javascript/api/excel/excel.chartlegend)|[format](/javascript/api/excel/excel.chartlegend#excel-excel-chartlegend-format-member)|Represents the formatting of a chart legend, which includes fill and font formatting.| -||[overlay](/javascript/api/excel/excel.chartlegend#excel-excel-chartlegend-overlay-member)|Specifies if the chart legend should overlap with the main body of the chart.| -||[position](/javascript/api/excel/excel.chartlegend#excel-excel-chartlegend-position-member)|Specifies the position of the legend on the chart.| -||[visible](/javascript/api/excel/excel.chartlegend#excel-excel-chartlegend-visible-member)|Specifies if the chart legend is visible.| -|[ChartLegendFormat](/javascript/api/excel/excel.chartlegendformat)|[fill](/javascript/api/excel/excel.chartlegendformat#excel-excel-chartlegendformat-fill-member)|Represents the fill format of an object, which includes background formatting information.| -||[font](/javascript/api/excel/excel.chartlegendformat#excel-excel-chartlegendformat-font-member)|Represents the font attributes such as font name, font size, and color of a chart legend.| -|[ChartLineFormat](/javascript/api/excel/excel.chartlineformat)|[clear()](/javascript/api/excel/excel.chartlineformat#excel-excel-chartlineformat-clear-member(1))|Clears the line format of a chart element.| -||[color](/javascript/api/excel/excel.chartlineformat#excel-excel-chartlineformat-color-member)|HTML color code representing the color of lines in the chart.| -|[ChartPoint](/javascript/api/excel/excel.chartpoint)|[format](/javascript/api/excel/excel.chartpoint#excel-excel-chartpoint-format-member)|Encapsulates the format properties chart point.| -||[value](/javascript/api/excel/excel.chartpoint#excel-excel-chartpoint-value-member)|Returns the value of a chart point.| -|[ChartPointFormat](/javascript/api/excel/excel.chartpointformat)|[fill](/javascript/api/excel/excel.chartpointformat#excel-excel-chartpointformat-fill-member)|Represents the fill format of a chart, which includes background formatting information.| -|[ChartPointsCollection](/javascript/api/excel/excel.chartpointscollection)|[count](/javascript/api/excel/excel.chartpointscollection#excel-excel-chartpointscollection-count-member)|Returns the number of chart points in the series.| -||[getItemAt(index: number)](/javascript/api/excel/excel.chartpointscollection#excel-excel-chartpointscollection-getitemat-member(1))|Retrieve a point based on its position within the series.| -||[items](/javascript/api/excel/excel.chartpointscollection#excel-excel-chartpointscollection-items-member)|Gets the loaded child items in this collection.| -|[ChartSeries](/javascript/api/excel/excel.chartseries)|[format](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-format-member)|Represents the formatting of a chart series, which includes fill and line formatting.| -||[name](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-name-member)|Specifies the name of a series in a chart.| -||[points](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-points-member)|Returns a collection of all points in the series.| -|[ChartSeriesCollection](/javascript/api/excel/excel.chartseriescollection)|[count](/javascript/api/excel/excel.chartseriescollection#excel-excel-chartseriescollection-count-member)|Returns the number of series in the collection.| -||[getItemAt(index: number)](/javascript/api/excel/excel.chartseriescollection#excel-excel-chartseriescollection-getitemat-member(1))|Retrieves a series based on its position in the collection.| -||[items](/javascript/api/excel/excel.chartseriescollection#excel-excel-chartseriescollection-items-member)|Gets the loaded child items in this collection.| -|[ChartSeriesFormat](/javascript/api/excel/excel.chartseriesformat)|[fill](/javascript/api/excel/excel.chartseriesformat#excel-excel-chartseriesformat-fill-member)|Represents the fill format of a chart series, which includes background formatting information.| -||[line](/javascript/api/excel/excel.chartseriesformat#excel-excel-chartseriesformat-line-member)|Represents line formatting.| -|[ChartTitle](/javascript/api/excel/excel.charttitle)|[format](/javascript/api/excel/excel.charttitle#excel-excel-charttitle-format-member)|Represents the formatting of a chart title, which includes fill and font formatting.| -||[overlay](/javascript/api/excel/excel.charttitle#excel-excel-charttitle-overlay-member)|Specifies if the chart title will overlay the chart.| -||[text](/javascript/api/excel/excel.charttitle#excel-excel-charttitle-text-member)|Specifies the chart's title text.| -||[visible](/javascript/api/excel/excel.charttitle#excel-excel-charttitle-visible-member)|Specifies if the chart title is visible.| -|[ChartTitleFormat](/javascript/api/excel/excel.charttitleformat)|[fill](/javascript/api/excel/excel.charttitleformat#excel-excel-charttitleformat-fill-member)|Represents the fill format of an object, which includes background formatting information.| -||[font](/javascript/api/excel/excel.charttitleformat#excel-excel-charttitleformat-font-member)|Represents the font attributes (such as font name, font size, and color) for an object.| -|[NamedItem](/javascript/api/excel/excel.nameditem)|[getRange()](/javascript/api/excel/excel.nameditem#excel-excel-nameditem-getrange-member(1))|Returns the range object that is associated with the name.| -||[name](/javascript/api/excel/excel.nameditem#excel-excel-nameditem-name-member)|The name of the object.| -||[type](/javascript/api/excel/excel.nameditem#excel-excel-nameditem-type-member)|Specifies the type of the value returned by the name's formula.| -||[value](/javascript/api/excel/excel.nameditem#excel-excel-nameditem-value-member)|Represents the value computed by the name's formula.| -||[visible](/javascript/api/excel/excel.nameditem#excel-excel-nameditem-visible-member)|Specifies if the object is visible.| -|[NamedItemCollection](/javascript/api/excel/excel.nameditemcollection)|[getItem(name: string)](/javascript/api/excel/excel.nameditemcollection#excel-excel-nameditemcollection-getitem-member(1))|Gets a `NamedItem` object using its name.| -||[items](/javascript/api/excel/excel.nameditemcollection#excel-excel-nameditemcollection-items-member)|Gets the loaded child items in this collection.| -|[Range](/javascript/api/excel/excel.range)|[address](/javascript/api/excel/excel.range#excel-excel-range-address-member)|Specifies the range reference in A1-style.| -||[addressLocal](/javascript/api/excel/excel.range#excel-excel-range-addresslocal-member)|Represents the range reference for the specified range in the language of the user.| -||[cellCount](/javascript/api/excel/excel.range#excel-excel-range-cellcount-member)|Specifies the number of cells in the range.| -||[clear(applyTo?: Excel.ClearApplyTo)](/javascript/api/excel/excel.range#excel-excel-range-clear-member(1))|Clear range values and formatting, such as fill and border.| -||[columnCount](/javascript/api/excel/excel.range#excel-excel-range-columncount-member)|Specifies the total number of columns in the range.| -||[columnIndex](/javascript/api/excel/excel.range#excel-excel-range-columnindex-member)|Specifies the column number of the first cell in the range.| -||[delete(shift: Excel.DeleteShiftDirection)](/javascript/api/excel/excel.range#excel-excel-range-delete-member(1))|Deletes the cells associated with the range.| -||[format](/javascript/api/excel/excel.range#excel-excel-range-format-member)|Returns a format object, encapsulating the range's font, fill, borders, alignment, and other properties.| -||[formulas](/javascript/api/excel/excel.range#excel-excel-range-formulas-member)|Represents the formula in A1-style notation.| -||[formulasLocal](/javascript/api/excel/excel.range#excel-excel-range-formulaslocal-member)|Represents the formula in A1-style notation, in the user's language and number-formatting locale.| -||[getBoundingRect(anotherRange: Range \| string)](/javascript/api/excel/excel.range#excel-excel-range-getboundingrect-member(1))|Gets the smallest range object that encompasses the given ranges.| -||[getCell(row: number, column: number)](/javascript/api/excel/excel.range#excel-excel-range-getcell-member(1))|Gets the range object containing the single cell based on row and column numbers.| -||[getColumn(column: number)](/javascript/api/excel/excel.range#excel-excel-range-getcolumn-member(1))|Gets a column contained in the range.| -||[getEntireColumn()](/javascript/api/excel/excel.range#excel-excel-range-getentirecolumn-member(1))|Gets an object that represents the entire column of the range (for example, if the current range represents cells "B4:E11", its `getEntireColumn` is a range that represents columns "B:E").| -||[getEntireRow()](/javascript/api/excel/excel.range#excel-excel-range-getentirerow-member(1))|Gets an object that represents the entire row of the range (for example, if the current range represents cells "B4:E11", its `GetEntireRow` is a range that represents rows "4:11").| -||[getIntersection(anotherRange: Range \| string)](/javascript/api/excel/excel.range#excel-excel-range-getintersection-member(1))|Gets the range object that represents the rectangular intersection of the given ranges.| -||[getLastCell()](/javascript/api/excel/excel.range#excel-excel-range-getlastcell-member(1))|Gets the last cell within the range.| -||[getLastColumn()](/javascript/api/excel/excel.range#excel-excel-range-getlastcolumn-member(1))|Gets the last column within the range.| -||[getLastRow()](/javascript/api/excel/excel.range#excel-excel-range-getlastrow-member(1))|Gets the last row within the range.| -||[getOffsetRange(rowOffset: number, columnOffset: number)](/javascript/api/excel/excel.range#excel-excel-range-getoffsetrange-member(1))|Gets an object which represents a range that's offset from the specified range.| -||[getRow(row: number)](/javascript/api/excel/excel.range#excel-excel-range-getrow-member(1))|Gets a row contained in the range.| -||[insert(shift: Excel.InsertShiftDirection)](/javascript/api/excel/excel.range#excel-excel-range-insert-member(1))|Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space.| -||[numberFormat](/javascript/api/excel/excel.range#excel-excel-range-numberformat-member)|Represents Excel's number format code for the given range.| -||[rowCount](/javascript/api/excel/excel.range#excel-excel-range-rowcount-member)|Returns the total number of rows in the range.| -||[rowIndex](/javascript/api/excel/excel.range#excel-excel-range-rowindex-member)|Returns the row number of the first cell in the range.| -||[select()](/javascript/api/excel/excel.range#excel-excel-range-select-member(1))|Selects the specified range in the Excel UI.| -||[text](/javascript/api/excel/excel.range#excel-excel-range-text-member)|Text values of the specified range.| -||[valueTypes](/javascript/api/excel/excel.range#excel-excel-range-valuetypes-member)|Specifies the type of data in each cell.| -||[values](/javascript/api/excel/excel.range#excel-excel-range-values-member)|Represents the raw values of the specified range.| -||[worksheet](/javascript/api/excel/excel.range#excel-excel-range-worksheet-member)|The worksheet containing the current range.| -|[RangeBorder](/javascript/api/excel/excel.rangeborder)|[color](/javascript/api/excel/excel.rangeborder#excel-excel-rangeborder-color-member)|HTML color code representing the color of the border line, in the form #RRGGBB (e.g., "FFA500"), or as a named HTML color (e.g., "orange").| -||[sideIndex](/javascript/api/excel/excel.rangeborder#excel-excel-rangeborder-sideindex-member)|Constant value that indicates the specific side of the border.| -||[style](/javascript/api/excel/excel.rangeborder#excel-excel-rangeborder-style-member)|One of the constants of line style specifying the line style for the border.| -||[weight](/javascript/api/excel/excel.rangeborder#excel-excel-rangeborder-weight-member)|Specifies the weight of the border around a range.| -|[RangeBorderCollection](/javascript/api/excel/excel.rangebordercollection)|[count](/javascript/api/excel/excel.rangebordercollection#excel-excel-rangebordercollection-count-member)|Number of border objects in the collection.| -||[getItem(index: Excel.BorderIndex)](/javascript/api/excel/excel.rangebordercollection#excel-excel-rangebordercollection-getitem-member(1))|Gets a border object using its name.| -||[getItemAt(index: number)](/javascript/api/excel/excel.rangebordercollection#excel-excel-rangebordercollection-getitemat-member(1))|Gets a border object using its index.| -||[items](/javascript/api/excel/excel.rangebordercollection#excel-excel-rangebordercollection-items-member)|Gets the loaded child items in this collection.| -|[RangeFill](/javascript/api/excel/excel.rangefill)|[clear()](/javascript/api/excel/excel.rangefill#excel-excel-rangefill-clear-member(1))|Resets the range background.| -||[color](/javascript/api/excel/excel.rangefill#excel-excel-rangefill-color-member)|HTML color code representing the color of the background, in the form #RRGGBB (e.g., "FFA500"), or as a named HTML color (e.g., "orange")| -|[RangeFont](/javascript/api/excel/excel.rangefont)|[bold](/javascript/api/excel/excel.rangefont#excel-excel-rangefont-bold-member)|Represents the bold status of the font.| -||[color](/javascript/api/excel/excel.rangefont#excel-excel-rangefont-color-member)|HTML color code representation of the text color (e.g., #FF0000 represents Red).| -||[italic](/javascript/api/excel/excel.rangefont#excel-excel-rangefont-italic-member)|Specifies the italic status of the font.| -||[name](/javascript/api/excel/excel.rangefont#excel-excel-rangefont-name-member)|Font name (e.g., "Calibri").| -||[size](/javascript/api/excel/excel.rangefont#excel-excel-rangefont-size-member)|Font size.| -||[underline](/javascript/api/excel/excel.rangefont#excel-excel-rangefont-underline-member)|Type of underline applied to the font.| -|[RangeFormat](/javascript/api/excel/excel.rangeformat)|[borders](/javascript/api/excel/excel.rangeformat#excel-excel-rangeformat-borders-member)|Collection of border objects that apply to the overall range.| -||[fill](/javascript/api/excel/excel.rangeformat#excel-excel-rangeformat-fill-member)|Returns the fill object defined on the overall range.| -||[font](/javascript/api/excel/excel.rangeformat#excel-excel-rangeformat-font-member)|Returns the font object defined on the overall range.| -||[horizontalAlignment](/javascript/api/excel/excel.rangeformat#excel-excel-rangeformat-horizontalalignment-member)|Represents the horizontal alignment for the specified object.| -||[verticalAlignment](/javascript/api/excel/excel.rangeformat#excel-excel-rangeformat-verticalalignment-member)|Represents the vertical alignment for the specified object.| -||[wrapText](/javascript/api/excel/excel.rangeformat#excel-excel-rangeformat-wraptext-member)|Specifies if Excel wraps the text in the object.| -|[Table](/javascript/api/excel/excel.table)|[columns](/javascript/api/excel/excel.table#excel-excel-table-columns-member)|Represents a collection of all the columns in the table.| -||[delete()](/javascript/api/excel/excel.table#excel-excel-table-delete-member(1))|Deletes the table.| -||[getDataBodyRange()](/javascript/api/excel/excel.table#excel-excel-table-getdatabodyrange-member(1))|Gets the range object associated with the data body of the table.| -||[getHeaderRowRange()](/javascript/api/excel/excel.table#excel-excel-table-getheaderrowrange-member(1))|Gets the range object associated with the header row of the table.| -||[getRange()](/javascript/api/excel/excel.table#excel-excel-table-getrange-member(1))|Gets the range object associated with the entire table.| -||[getTotalRowRange()](/javascript/api/excel/excel.table#excel-excel-table-gettotalrowrange-member(1))|Gets the range object associated with the totals row of the table.| -||[id](/javascript/api/excel/excel.table#excel-excel-table-id-member)|Returns a value that uniquely identifies the table in a given workbook.| -||[name](/javascript/api/excel/excel.table#excel-excel-table-name-member)|Name of the table.| -||[rows](/javascript/api/excel/excel.table#excel-excel-table-rows-member)|Represents a collection of all the rows in the table.| -||[showHeaders](/javascript/api/excel/excel.table#excel-excel-table-showheaders-member)|Specifies if the header row is visible.| -||[showTotals](/javascript/api/excel/excel.table#excel-excel-table-showtotals-member)|Specifies if the total row is visible.| -||[style](/javascript/api/excel/excel.table#excel-excel-table-style-member)|Constant value that represents the table style.| -|[TableCollection](/javascript/api/excel/excel.tablecollection)|[add(address: Range \| string, hasHeaders: boolean)](/javascript/api/excel/excel.tablecollection#excel-excel-tablecollection-add-member(1))|Creates a new table.| -||[count](/javascript/api/excel/excel.tablecollection#excel-excel-tablecollection-count-member)|Returns the number of tables in the workbook.| -||[getItem(key: string)](/javascript/api/excel/excel.tablecollection#excel-excel-tablecollection-getitem-member(1))|Gets a table by name or ID.| -||[getItemAt(index: number)](/javascript/api/excel/excel.tablecollection#excel-excel-tablecollection-getitemat-member(1))|Gets a table based on its position in the collection.| -||[items](/javascript/api/excel/excel.tablecollection#excel-excel-tablecollection-items-member)|Gets the loaded child items in this collection.| -|[TableColumn](/javascript/api/excel/excel.tablecolumn)|[delete()](/javascript/api/excel/excel.tablecolumn#excel-excel-tablecolumn-delete-member(1))|Deletes the column from the table.| -||[getDataBodyRange()](/javascript/api/excel/excel.tablecolumn#excel-excel-tablecolumn-getdatabodyrange-member(1))|Gets the range object associated with the data body of the column.| -||[getHeaderRowRange()](/javascript/api/excel/excel.tablecolumn#excel-excel-tablecolumn-getheaderrowrange-member(1))|Gets the range object associated with the header row of the column.| -||[getRange()](/javascript/api/excel/excel.tablecolumn#excel-excel-tablecolumn-getrange-member(1))|Gets the range object associated with the entire column.| -||[getTotalRowRange()](/javascript/api/excel/excel.tablecolumn#excel-excel-tablecolumn-gettotalrowrange-member(1))|Gets the range object associated with the totals row of the column.| -||[id](/javascript/api/excel/excel.tablecolumn#excel-excel-tablecolumn-id-member)|Returns a unique key that identifies the column within the table.| -||[index](/javascript/api/excel/excel.tablecolumn#excel-excel-tablecolumn-index-member)|Returns the index number of the column within the columns collection of the table.| -||[name](/javascript/api/excel/excel.tablecolumn#excel-excel-tablecolumn-name-member)|Specifies the name of the table column.| -||[values](/javascript/api/excel/excel.tablecolumn#excel-excel-tablecolumn-values-member)|Represents the raw values of the specified range.| -|[TableColumnCollection](/javascript/api/excel/excel.tablecolumncollection)|[add(index?: number, values?: Array> \| boolean \| string \| number, name?: string)](/javascript/api/excel/excel.tablecolumncollection#excel-excel-tablecolumncollection-add-member(1))|Adds a new column to the table.| -||[count](/javascript/api/excel/excel.tablecolumncollection#excel-excel-tablecolumncollection-count-member)|Returns the number of columns in the table.| -||[getItem(key: number \| string)](/javascript/api/excel/excel.tablecolumncollection#excel-excel-tablecolumncollection-getitem-member(1))|Gets a column object by name or ID.| -||[getItemAt(index: number)](/javascript/api/excel/excel.tablecolumncollection#excel-excel-tablecolumncollection-getitemat-member(1))|Gets a column based on its position in the collection.| -||[items](/javascript/api/excel/excel.tablecolumncollection#excel-excel-tablecolumncollection-items-member)|Gets the loaded child items in this collection.| -|[TableRow](/javascript/api/excel/excel.tablerow)|[delete()](/javascript/api/excel/excel.tablerow#excel-excel-tablerow-delete-member(1))|Deletes the row from the table.| -||[getRange()](/javascript/api/excel/excel.tablerow#excel-excel-tablerow-getrange-member(1))|Returns the range object associated with the entire row.| -||[index](/javascript/api/excel/excel.tablerow#excel-excel-tablerow-index-member)|Returns the index number of the row within the rows collection of the table.| -||[values](/javascript/api/excel/excel.tablerow#excel-excel-tablerow-values-member)|Represents the raw values of the specified range.| -|[TableRowCollection](/javascript/api/excel/excel.tablerowcollection)|[add(index?: number, values?: Array> \| boolean \| string \| number, alwaysInsert?: boolean)](/javascript/api/excel/excel.tablerowcollection#excel-excel-tablerowcollection-add-member(1))|Adds one or more rows to the table.| -||[count](/javascript/api/excel/excel.tablerowcollection#excel-excel-tablerowcollection-count-member)|Returns the number of rows in the table.| -||[getItemAt(index: number)](/javascript/api/excel/excel.tablerowcollection#excel-excel-tablerowcollection-getitemat-member(1))|Gets a row based on its position in the collection.| -||[items](/javascript/api/excel/excel.tablerowcollection#excel-excel-tablerowcollection-items-member)|Gets the loaded child items in this collection.| -|[Workbook](/javascript/api/excel/excel.workbook)|[application](/javascript/api/excel/excel.workbook#excel-excel-workbook-application-member)|Represents the Excel application instance that contains this workbook.| -||[bindings](/javascript/api/excel/excel.workbook#excel-excel-workbook-bindings-member)|Represents a collection of bindings that are part of the workbook.| -||[getSelectedRange()](/javascript/api/excel/excel.workbook#excel-excel-workbook-getselectedrange-member(1))|Gets the currently selected single range from the workbook.| -||[names](/javascript/api/excel/excel.workbook#excel-excel-workbook-names-member)|Represents a collection of workbook-scoped named items (named ranges and constants).| -||[tables](/javascript/api/excel/excel.workbook#excel-excel-workbook-tables-member)|Represents a collection of tables associated with the workbook.| -||[worksheets](/javascript/api/excel/excel.workbook#excel-excel-workbook-worksheets-member)|Represents a collection of worksheets associated with the workbook.| -|[Worksheet](/javascript/api/excel/excel.worksheet)|[activate()](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-activate-member(1))|Activate the worksheet in the Excel UI.| -||[charts](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-charts-member)|Returns a collection of charts that are part of the worksheet.| -||[delete()](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-delete-member(1))|Deletes the worksheet from the workbook.| -||[getCell(row: number, column: number)](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-getcell-member(1))|Gets the `Range` object containing the single cell based on row and column numbers.| -||[getRange(address?: string)](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-getrange-member(1))|Gets the `Range` object, representing a single rectangular block of cells, specified by the address or name.| -||[id](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-id-member)|Returns a value that uniquely identifies the worksheet in a given workbook.| -||[name](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-name-member)|The display name of the worksheet.| -||[position](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-position-member)|The zero-based position of the worksheet within the workbook.| -||[tables](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-tables-member)|Collection of tables that are part of the worksheet.| -||[visibility](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-visibility-member)|The visibility of the worksheet.| -|[WorksheetCollection](/javascript/api/excel/excel.worksheetcollection)|[add(name?: string)](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-add-member(1))|Adds a new worksheet to the workbook.| -||[getActiveWorksheet()](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-getactiveworksheet-member(1))|Gets the currently active worksheet in the workbook.| -||[getItem(key: string)](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-getitem-member(1))|Gets a worksheet object using its name or ID.| -||[items](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-items-member)|Gets the loaded child items in this collection.| +|[Application](/.application)|[calculate(calculationType: Excel.CalculationType)](/.application#excel-javascript/api/excel/-application-calculate-member(1))|Recalculate all currently opened workbooks in Excel.| +||[calculationMode](/.application#excel-javascript/api/excel/-application-calculationmode-member)|Returns the calculation mode used in the workbook, as defined by the constants in `Excel.CalculationMode`.| +|[Binding](/.binding)|[getRange()](/.binding#excel-javascript/api/excel/-binding-getrange-member(1))|Returns the range represented by the binding.| +||[getTable()](/.binding#excel-javascript/api/excel/-binding-gettable-member(1))|Returns the table represented by the binding.| +||[getText()](/.binding#excel-javascript/api/excel/-binding-gettext-member(1))|Returns the text represented by the binding.| +||[id](/.binding#excel-javascript/api/excel/-binding-id-member)|Represents the binding identifier.| +||[type](/.binding#excel-javascript/api/excel/-binding-type-member)|Returns the type of the binding.| +|[BindingCollection](/.bindingcollection)|[count](/.bindingcollection#excel-javascript/api/excel/-bindingcollection-count-member)|Returns the number of bindings in the collection.| +||[getItem(id: string)](/.bindingcollection#excel-javascript/api/excel/-bindingcollection-getitem-member(1))|Gets a binding object by ID.| +||[getItemAt(index: number)](/.bindingcollection#excel-javascript/api/excel/-bindingcollection-getitemat-member(1))|Gets a binding object based on its position in the items array.| +||[items](/.bindingcollection#excel-javascript/api/excel/-bindingcollection-items-member)|Gets the loaded child items in this collection.| +|[Chart](/.chart)|[axes](/.chart#excel-javascript/api/excel/-chart-axes-member)|Represents chart axes.| +||[dataLabels](/.chart#excel-javascript/api/excel/-chart-datalabels-member)|Represents the data labels on the chart.| +||[delete()](/.chart#excel-javascript/api/excel/-chart-delete-member(1))|Deletes the chart object.| +||[format](/.chart#excel-javascript/api/excel/-chart-format-member)|Encapsulates the format properties for the chart area.| +||[height](/.chart#excel-javascript/api/excel/-chart-height-member)|Specifies the height, in points, of the chart object.| +||[left](/.chart#excel-javascript/api/excel/-chart-left-member)|The distance, in points, from the left side of the chart to the worksheet origin.| +||[legend](/.chart#excel-javascript/api/excel/-chart-legend-member)|Represents the legend for the chart.| +||[name](/.chart#excel-javascript/api/excel/-chart-name-member)|Specifies the name of a chart object.| +||[series](/.chart#excel-javascript/api/excel/-chart-series-member)|Represents either a single series or collection of series in the chart.| +||[setData(sourceData: Range, seriesBy?: Excel.ChartSeriesBy)](/.chart#excel-javascript/api/excel/-chart-setdata-member(1))|Resets the source data for the chart.| +||[setPosition(startCell: Range \| string, endCell?: Range \| string)](/.chart#excel-javascript/api/excel/-chart-setposition-member(1))|Positions the chart relative to cells on the worksheet.| +||[title](/.chart#excel-javascript/api/excel/-chart-title-member)|Represents the title of the specified chart, including the text, visibility, position, and formatting of the title.| +||[top](/.chart#excel-javascript/api/excel/-chart-top-member)|Specifies the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top of the chart area (on a chart).| +||[width](/.chart#excel-javascript/api/excel/-chart-width-member)|Specifies the width, in points, of the chart object.| +|[ChartAreaFormat](/.chartareaformat)|[fill](/.chartareaformat#excel-javascript/api/excel/-chartareaformat-fill-member)|Represents the fill format of an object, which includes background formatting information.| +||[font](/.chartareaformat#excel-javascript/api/excel/-chartareaformat-font-member)|Represents the font attributes (font name, font size, color, etc.) for the current object.| +|[ChartAxes](/.chartaxes)|[categoryAxis](/.chartaxes#excel-javascript/api/excel/-chartaxes-categoryaxis-member)|Represents the category axis in a chart.| +||[seriesAxis](/.chartaxes#excel-javascript/api/excel/-chartaxes-seriesaxis-member)|Represents the series axis of a 3-D chart.| +||[valueAxis](/.chartaxes#excel-javascript/api/excel/-chartaxes-valueaxis-member)|Represents the value axis in an axis.| +|[ChartAxis](/.chartaxis)|[format](/.chartaxis#excel-javascript/api/excel/-chartaxis-format-member)|Represents the formatting of a chart object, which includes line and font formatting.| +||[majorGridlines](/.chartaxis#excel-javascript/api/excel/-chartaxis-majorgridlines-member)|Returns an object that represents the major gridlines for the specified axis.| +||[majorUnit](/.chartaxis#excel-javascript/api/excel/-chartaxis-majorunit-member)|Represents the interval between two major tick marks.| +||[maximum](/.chartaxis#excel-javascript/api/excel/-chartaxis-maximum-member)|Represents the maximum value on the value axis.| +||[minimum](/.chartaxis#excel-javascript/api/excel/-chartaxis-minimum-member)|Represents the minimum value on the value axis.| +||[minorGridlines](/.chartaxis#excel-javascript/api/excel/-chartaxis-minorgridlines-member)|Returns an object that represents the minor gridlines for the specified axis.| +||[minorUnit](/.chartaxis#excel-javascript/api/excel/-chartaxis-minorunit-member)|Represents the interval between two minor tick marks.| +||[title](/.chartaxis#excel-javascript/api/excel/-chartaxis-title-member)|Represents the axis title.| +|[ChartAxisFormat](/.chartaxisformat)|[font](/.chartaxisformat#excel-javascript/api/excel/-chartaxisformat-font-member)|Specifies the font attributes (font name, font size, color, etc.) for a chart axis element.| +||[line](/.chartaxisformat#excel-javascript/api/excel/-chartaxisformat-line-member)|Specifies chart line formatting.| +|[ChartAxisTitle](/.chartaxistitle)|[format](/.chartaxistitle#excel-javascript/api/excel/-chartaxistitle-format-member)|Specifies the formatting of the chart axis title.| +||[text](/.chartaxistitle#excel-javascript/api/excel/-chartaxistitle-text-member)|Specifies the axis title.| +||[visible](/.chartaxistitle#excel-javascript/api/excel/-chartaxistitle-visible-member)|Specifies if the axis title is visible.| +|[ChartAxisTitleFormat](/.chartaxistitleformat)|[font](/.chartaxistitleformat#excel-javascript/api/excel/-chartaxistitleformat-font-member)|Specifies the chart axis title's font attributes, such as font name, font size, or color, of the chart axis title object.| +|[ChartCollection](/.chartcollection)|[add(type: Excel.ChartType, sourceData: Range, seriesBy?: Excel.ChartSeriesBy)](/.chartcollection#excel-javascript/api/excel/-chartcollection-add-member(1))|Creates a new chart.| +||[count](/.chartcollection#excel-javascript/api/excel/-chartcollection-count-member)|Returns the number of charts in the worksheet.| +||[getItem(name: string)](/.chartcollection#excel-javascript/api/excel/-chartcollection-getitem-member(1))|Gets a chart using its name.| +||[getItemAt(index: number)](/.chartcollection#excel-javascript/api/excel/-chartcollection-getitemat-member(1))|Gets a chart based on its position in the collection.| +||[items](/.chartcollection#excel-javascript/api/excel/-chartcollection-items-member)|Gets the loaded child items in this collection.| +|[ChartDataLabelFormat](/.chartdatalabelformat)|[fill](/.chartdatalabelformat#excel-javascript/api/excel/-chartdatalabelformat-fill-member)|Represents the fill format of the current chart data label.| +||[font](/.chartdatalabelformat#excel-javascript/api/excel/-chartdatalabelformat-font-member)|Represents the font attributes (such as font name, font size, and color) for a chart data label.| +|[ChartDataLabels](/.chartdatalabels)|[format](/.chartdatalabels#excel-javascript/api/excel/-chartdatalabels-format-member)|Specifies the format of chart data labels, which includes fill and font formatting.| +||[position](/.chartdatalabels#excel-javascript/api/excel/-chartdatalabels-position-member)|Value that represents the position of the data label.| +||[separator](/.chartdatalabels#excel-javascript/api/excel/-chartdatalabels-separator-member)|String representing the separator used for the data labels on a chart.| +||[showBubbleSize](/.chartdatalabels#excel-javascript/api/excel/-chartdatalabels-showbubblesize-member)|Specifies if the data label bubble size is visible.| +||[showCategoryName](/.chartdatalabels#excel-javascript/api/excel/-chartdatalabels-showcategoryname-member)|Specifies if the data label category name is visible.| +||[showLegendKey](/.chartdatalabels#excel-javascript/api/excel/-chartdatalabels-showlegendkey-member)|Specifies if the data label legend key is visible.| +||[showPercentage](/.chartdatalabels#excel-javascript/api/excel/-chartdatalabels-showpercentage-member)|Specifies if the data label percentage is visible.| +||[showSeriesName](/.chartdatalabels#excel-javascript/api/excel/-chartdatalabels-showseriesname-member)|Specifies if the data label series name is visible.| +||[showValue](/.chartdatalabels#excel-javascript/api/excel/-chartdatalabels-showvalue-member)|Specifies if the data label value is visible.| +|[ChartFill](/.chartfill)|[clear()](/.chartfill#excel-javascript/api/excel/-chartfill-clear-member(1))|Clears the fill color of a chart element.| +||[setSolidColor(color: string)](/.chartfill#excel-javascript/api/excel/-chartfill-setsolidcolor-member(1))|Sets the fill formatting of a chart element to a uniform color.| +|[ChartFont](/.chartfont)|[bold](/.chartfont#excel-javascript/api/excel/-chartfont-bold-member)|Represents the bold status of font.| +||[color](/.chartfont#excel-javascript/api/excel/-chartfont-color-member)|HTML color code representation of the text color (e.g., #FF0000 represents Red).| +||[italic](/.chartfont#excel-javascript/api/excel/-chartfont-italic-member)|Represents the italic status of the font.| +||[name](/.chartfont#excel-javascript/api/excel/-chartfont-name-member)|Font name (e.g., "Calibri")| +||[size](/.chartfont#excel-javascript/api/excel/-chartfont-size-member)|Size of the font (e.g., 11)| +||[underline](/.chartfont#excel-javascript/api/excel/-chartfont-underline-member)|Type of underline applied to the font.| +|[ChartGridlines](/.chartgridlines)|[format](/.chartgridlines#excel-javascript/api/excel/-chartgridlines-format-member)|Represents the formatting of chart gridlines.| +||[visible](/.chartgridlines#excel-javascript/api/excel/-chartgridlines-visible-member)|Specifies if the axis gridlines are visible.| +|[ChartGridlinesFormat](/.chartgridlinesformat)|[line](/.chartgridlinesformat#excel-javascript/api/excel/-chartgridlinesformat-line-member)|Represents chart line formatting.| +|[ChartLegend](/.chartlegend)|[format](/.chartlegend#excel-javascript/api/excel/-chartlegend-format-member)|Represents the formatting of a chart legend, which includes fill and font formatting.| +||[overlay](/.chartlegend#excel-javascript/api/excel/-chartlegend-overlay-member)|Specifies if the chart legend should overlap with the main body of the chart.| +||[position](/.chartlegend#excel-javascript/api/excel/-chartlegend-position-member)|Specifies the position of the legend on the chart.| +||[visible](/.chartlegend#excel-javascript/api/excel/-chartlegend-visible-member)|Specifies if the chart legend is visible.| +|[ChartLegendFormat](/.chartlegendformat)|[fill](/.chartlegendformat#excel-javascript/api/excel/-chartlegendformat-fill-member)|Represents the fill format of an object, which includes background formatting information.| +||[font](/.chartlegendformat#excel-javascript/api/excel/-chartlegendformat-font-member)|Represents the font attributes such as font name, font size, and color of a chart legend.| +|[ChartLineFormat](/.chartlineformat)|[clear()](/.chartlineformat#excel-javascript/api/excel/-chartlineformat-clear-member(1))|Clears the line format of a chart element.| +||[color](/.chartlineformat#excel-javascript/api/excel/-chartlineformat-color-member)|HTML color code representing the color of lines in the chart.| +|[ChartPoint](/.chartpoint)|[format](/.chartpoint#excel-javascript/api/excel/-chartpoint-format-member)|Encapsulates the format properties chart point.| +||[value](/.chartpoint#excel-javascript/api/excel/-chartpoint-value-member)|Returns the value of a chart point.| +|[ChartPointFormat](/.chartpointformat)|[fill](/.chartpointformat#excel-javascript/api/excel/-chartpointformat-fill-member)|Represents the fill format of a chart, which includes background formatting information.| +|[ChartPointsCollection](/.chartpointscollection)|[count](/.chartpointscollection#excel-javascript/api/excel/-chartpointscollection-count-member)|Returns the number of chart points in the series.| +||[getItemAt(index: number)](/.chartpointscollection#excel-javascript/api/excel/-chartpointscollection-getitemat-member(1))|Retrieve a point based on its position within the series.| +||[items](/.chartpointscollection#excel-javascript/api/excel/-chartpointscollection-items-member)|Gets the loaded child items in this collection.| +|[ChartSeries](/.chartseries)|[format](/.chartseries#excel-javascript/api/excel/-chartseries-format-member)|Represents the formatting of a chart series, which includes fill and line formatting.| +||[name](/.chartseries#excel-javascript/api/excel/-chartseries-name-member)|Specifies the name of a series in a chart.| +||[points](/.chartseries#excel-javascript/api/excel/-chartseries-points-member)|Returns a collection of all points in the series.| +|[ChartSeriesCollection](/.chartseriescollection)|[count](/.chartseriescollection#excel-javascript/api/excel/-chartseriescollection-count-member)|Returns the number of series in the collection.| +||[getItemAt(index: number)](/.chartseriescollection#excel-javascript/api/excel/-chartseriescollection-getitemat-member(1))|Retrieves a series based on its position in the collection.| +||[items](/.chartseriescollection#excel-javascript/api/excel/-chartseriescollection-items-member)|Gets the loaded child items in this collection.| +|[ChartSeriesFormat](/.chartseriesformat)|[fill](/.chartseriesformat#excel-javascript/api/excel/-chartseriesformat-fill-member)|Represents the fill format of a chart series, which includes background formatting information.| +||[line](/.chartseriesformat#excel-javascript/api/excel/-chartseriesformat-line-member)|Represents line formatting.| +|[ChartTitle](/.charttitle)|[format](/.charttitle#excel-javascript/api/excel/-charttitle-format-member)|Represents the formatting of a chart title, which includes fill and font formatting.| +||[overlay](/.charttitle#excel-javascript/api/excel/-charttitle-overlay-member)|Specifies if the chart title will overlay the chart.| +||[text](/.charttitle#excel-javascript/api/excel/-charttitle-text-member)|Specifies the chart's title text.| +||[visible](/.charttitle#excel-javascript/api/excel/-charttitle-visible-member)|Specifies if the chart title is visible.| +|[ChartTitleFormat](/.charttitleformat)|[fill](/.charttitleformat#excel-javascript/api/excel/-charttitleformat-fill-member)|Represents the fill format of an object, which includes background formatting information.| +||[font](/.charttitleformat#excel-javascript/api/excel/-charttitleformat-font-member)|Represents the font attributes (such as font name, font size, and color) for an object.| +|[NamedItem](/.nameditem)|[getRange()](/.nameditem#excel-javascript/api/excel/-nameditem-getrange-member(1))|Returns the range object that is associated with the name.| +||[name](/.nameditem#excel-javascript/api/excel/-nameditem-name-member)|The name of the object.| +||[type](/.nameditem#excel-javascript/api/excel/-nameditem-type-member)|Specifies the type of the value returned by the name's formula.| +||[value](/.nameditem#excel-javascript/api/excel/-nameditem-value-member)|Represents the value computed by the name's formula.| +||[visible](/.nameditem#excel-javascript/api/excel/-nameditem-visible-member)|Specifies if the object is visible.| +|[NamedItemCollection](/.nameditemcollection)|[getItem(name: string)](/.nameditemcollection#excel-javascript/api/excel/-nameditemcollection-getitem-member(1))|Gets a `NamedItem` object using its name.| +||[items](/.nameditemcollection#excel-javascript/api/excel/-nameditemcollection-items-member)|Gets the loaded child items in this collection.| +|[Range](/.range)|[address](/.range#excel-javascript/api/excel/-range-address-member)|Specifies the range reference in A1-style.| +||[addressLocal](/.range#excel-javascript/api/excel/-range-addresslocal-member)|Represents the range reference for the specified range in the language of the user.| +||[cellCount](/.range#excel-javascript/api/excel/-range-cellcount-member)|Specifies the number of cells in the range.| +||[clear(applyTo?: Excel.ClearApplyTo)](/.range#excel-javascript/api/excel/-range-clear-member(1))|Clear range values and formatting, such as fill and border.| +||[columnCount](/.range#excel-javascript/api/excel/-range-columncount-member)|Specifies the total number of columns in the range.| +||[columnIndex](/.range#excel-javascript/api/excel/-range-columnindex-member)|Specifies the column number of the first cell in the range.| +||[delete(shift: Excel.DeleteShiftDirection)](/.range#excel-javascript/api/excel/-range-delete-member(1))|Deletes the cells associated with the range.| +||[format](/.range#excel-javascript/api/excel/-range-format-member)|Returns a format object, encapsulating the range's font, fill, borders, alignment, and other properties.| +||[formulas](/.range#excel-javascript/api/excel/-range-formulas-member)|Represents the formula in A1-style notation.| +||[formulasLocal](/.range#excel-javascript/api/excel/-range-formulaslocal-member)|Represents the formula in A1-style notation, in the user's language and number-formatting locale.| +||[getBoundingRect(anotherRange: Range \| string)](/.range#excel-javascript/api/excel/-range-getboundingrect-member(1))|Gets the smallest range object that encompasses the given ranges.| +||[getCell(row: number, column: number)](/.range#excel-javascript/api/excel/-range-getcell-member(1))|Gets the range object containing the single cell based on row and column numbers.| +||[getColumn(column: number)](/.range#excel-javascript/api/excel/-range-getcolumn-member(1))|Gets a column contained in the range.| +||[getEntireColumn()](/.range#excel-javascript/api/excel/-range-getentirecolumn-member(1))|Gets an object that represents the entire column of the range (for example, if the current range represents cells "B4:E11", its `getEntireColumn` is a range that represents columns "B:E").| +||[getEntireRow()](/.range#excel-javascript/api/excel/-range-getentirerow-member(1))|Gets an object that represents the entire row of the range (for example, if the current range represents cells "B4:E11", its `GetEntireRow` is a range that represents rows "4:11").| +||[getIntersection(anotherRange: Range \| string)](/.range#excel-javascript/api/excel/-range-getintersection-member(1))|Gets the range object that represents the rectangular intersection of the given ranges.| +||[getLastCell()](/.range#excel-javascript/api/excel/-range-getlastcell-member(1))|Gets the last cell within the range.| +||[getLastColumn()](/.range#excel-javascript/api/excel/-range-getlastcolumn-member(1))|Gets the last column within the range.| +||[getLastRow()](/.range#excel-javascript/api/excel/-range-getlastrow-member(1))|Gets the last row within the range.| +||[getOffsetRange(rowOffset: number, columnOffset: number)](/.range#excel-javascript/api/excel/-range-getoffsetrange-member(1))|Gets an object which represents a range that's offset from the specified range.| +||[getRow(row: number)](/.range#excel-javascript/api/excel/-range-getrow-member(1))|Gets a row contained in the range.| +||[insert(shift: Excel.InsertShiftDirection)](/.range#excel-javascript/api/excel/-range-insert-member(1))|Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space.| +||[numberFormat](/.range#excel-javascript/api/excel/-range-numberformat-member)|Represents Excel's number format code for the given range.| +||[rowCount](/.range#excel-javascript/api/excel/-range-rowcount-member)|Returns the total number of rows in the range.| +||[rowIndex](/.range#excel-javascript/api/excel/-range-rowindex-member)|Returns the row number of the first cell in the range.| +||[select()](/.range#excel-javascript/api/excel/-range-select-member(1))|Selects the specified range in the Excel UI.| +||[text](/.range#excel-javascript/api/excel/-range-text-member)|Text values of the specified range.| +||[valueTypes](/.range#excel-javascript/api/excel/-range-valuetypes-member)|Specifies the type of data in each cell.| +||[values](/.range#excel-javascript/api/excel/-range-values-member)|Represents the raw values of the specified range.| +||[worksheet](/.range#excel-javascript/api/excel/-range-worksheet-member)|The worksheet containing the current range.| +|[RangeBorder](/.rangeborder)|[color](/.rangeborder#excel-javascript/api/excel/-rangeborder-color-member)|HTML color code representing the color of the border line, in the form #RRGGBB (e.g., "FFA500"), or as a named HTML color (e.g., "orange").| +||[sideIndex](/.rangeborder#excel-javascript/api/excel/-rangeborder-sideindex-member)|Constant value that indicates the specific side of the border.| +||[style](/.rangeborder#excel-javascript/api/excel/-rangeborder-style-member)|One of the constants of line style specifying the line style for the border.| +||[weight](/.rangeborder#excel-javascript/api/excel/-rangeborder-weight-member)|Specifies the weight of the border around a range.| +|[RangeBorderCollection](/.rangebordercollection)|[count](/.rangebordercollection#excel-javascript/api/excel/-rangebordercollection-count-member)|Number of border objects in the collection.| +||[getItem(index: Excel.BorderIndex)](/.rangebordercollection#excel-javascript/api/excel/-rangebordercollection-getitem-member(1))|Gets a border object using its name.| +||[getItemAt(index: number)](/.rangebordercollection#excel-javascript/api/excel/-rangebordercollection-getitemat-member(1))|Gets a border object using its index.| +||[items](/.rangebordercollection#excel-javascript/api/excel/-rangebordercollection-items-member)|Gets the loaded child items in this collection.| +|[RangeFill](/.rangefill)|[clear()](/.rangefill#excel-javascript/api/excel/-rangefill-clear-member(1))|Resets the range background.| +||[color](/.rangefill#excel-javascript/api/excel/-rangefill-color-member)|HTML color code representing the color of the background, in the form #RRGGBB (e.g., "FFA500"), or as a named HTML color (e.g., "orange")| +|[RangeFont](/.rangefont)|[bold](/.rangefont#excel-javascript/api/excel/-rangefont-bold-member)|Represents the bold status of the font.| +||[color](/.rangefont#excel-javascript/api/excel/-rangefont-color-member)|HTML color code representation of the text color (e.g., #FF0000 represents Red).| +||[italic](/.rangefont#excel-javascript/api/excel/-rangefont-italic-member)|Specifies the italic status of the font.| +||[name](/.rangefont#excel-javascript/api/excel/-rangefont-name-member)|Font name (e.g., "Calibri").| +||[size](/.rangefont#excel-javascript/api/excel/-rangefont-size-member)|Font size.| +||[underline](/.rangefont#excel-javascript/api/excel/-rangefont-underline-member)|Type of underline applied to the font.| +|[RangeFormat](/.rangeformat)|[borders](/.rangeformat#excel-javascript/api/excel/-rangeformat-borders-member)|Collection of border objects that apply to the overall range.| +||[fill](/.rangeformat#excel-javascript/api/excel/-rangeformat-fill-member)|Returns the fill object defined on the overall range.| +||[font](/.rangeformat#excel-javascript/api/excel/-rangeformat-font-member)|Returns the font object defined on the overall range.| +||[horizontalAlignment](/.rangeformat#excel-javascript/api/excel/-rangeformat-horizontalalignment-member)|Represents the horizontal alignment for the specified object.| +||[verticalAlignment](/.rangeformat#excel-javascript/api/excel/-rangeformat-verticalalignment-member)|Represents the vertical alignment for the specified object.| +||[wrapText](/.rangeformat#excel-javascript/api/excel/-rangeformat-wraptext-member)|Specifies if Excel wraps the text in the object.| +|[Table](/.table)|[columns](/.table#excel-javascript/api/excel/-table-columns-member)|Represents a collection of all the columns in the table.| +||[delete()](/.table#excel-javascript/api/excel/-table-delete-member(1))|Deletes the table.| +||[getDataBodyRange()](/.table#excel-javascript/api/excel/-table-getdatabodyrange-member(1))|Gets the range object associated with the data body of the table.| +||[getHeaderRowRange()](/.table#excel-javascript/api/excel/-table-getheaderrowrange-member(1))|Gets the range object associated with the header row of the table.| +||[getRange()](/.table#excel-javascript/api/excel/-table-getrange-member(1))|Gets the range object associated with the entire table.| +||[getTotalRowRange()](/.table#excel-javascript/api/excel/-table-gettotalrowrange-member(1))|Gets the range object associated with the totals row of the table.| +||[id](/.table#excel-javascript/api/excel/-table-id-member)|Returns a value that uniquely identifies the table in a given workbook.| +||[name](/.table#excel-javascript/api/excel/-table-name-member)|Name of the table.| +||[rows](/.table#excel-javascript/api/excel/-table-rows-member)|Represents a collection of all the rows in the table.| +||[showHeaders](/.table#excel-javascript/api/excel/-table-showheaders-member)|Specifies if the header row is visible.| +||[showTotals](/.table#excel-javascript/api/excel/-table-showtotals-member)|Specifies if the total row is visible.| +||[style](/.table#excel-javascript/api/excel/-table-style-member)|Constant value that represents the table style.| +|[TableCollection](/.tablecollection)|[add(address: Range \| string, hasHeaders: boolean)](/.tablecollection#excel-javascript/api/excel/-tablecollection-add-member(1))|Creates a new table.| +||[count](/.tablecollection#excel-javascript/api/excel/-tablecollection-count-member)|Returns the number of tables in the workbook.| +||[getItem(key: string)](/.tablecollection#excel-javascript/api/excel/-tablecollection-getitem-member(1))|Gets a table by name or ID.| +||[getItemAt(index: number)](/.tablecollection#excel-javascript/api/excel/-tablecollection-getitemat-member(1))|Gets a table based on its position in the collection.| +||[items](/.tablecollection#excel-javascript/api/excel/-tablecollection-items-member)|Gets the loaded child items in this collection.| +|[TableColumn](/.tablecolumn)|[delete()](/.tablecolumn#excel-javascript/api/excel/-tablecolumn-delete-member(1))|Deletes the column from the table.| +||[getDataBodyRange()](/.tablecolumn#excel-javascript/api/excel/-tablecolumn-getdatabodyrange-member(1))|Gets the range object associated with the data body of the column.| +||[getHeaderRowRange()](/.tablecolumn#excel-javascript/api/excel/-tablecolumn-getheaderrowrange-member(1))|Gets the range object associated with the header row of the column.| +||[getRange()](/.tablecolumn#excel-javascript/api/excel/-tablecolumn-getrange-member(1))|Gets the range object associated with the entire column.| +||[getTotalRowRange()](/.tablecolumn#excel-javascript/api/excel/-tablecolumn-gettotalrowrange-member(1))|Gets the range object associated with the totals row of the column.| +||[id](/.tablecolumn#excel-javascript/api/excel/-tablecolumn-id-member)|Returns a unique key that identifies the column within the table.| +||[index](/.tablecolumn#excel-javascript/api/excel/-tablecolumn-index-member)|Returns the index number of the column within the columns collection of the table.| +||[name](/.tablecolumn#excel-javascript/api/excel/-tablecolumn-name-member)|Specifies the name of the table column.| +||[values](/.tablecolumn#excel-javascript/api/excel/-tablecolumn-values-member)|Represents the raw values of the specified range.| +|[TableColumnCollection](/.tablecolumncollection)|[add(index?: number, values?: Array> \| boolean \| string \| number, name?: string)](/.tablecolumncollection#excel-javascript/api/excel/-tablecolumncollection-add-member(1))|Adds a new column to the table.| +||[count](/.tablecolumncollection#excel-javascript/api/excel/-tablecolumncollection-count-member)|Returns the number of columns in the table.| +||[getItem(key: number \| string)](/.tablecolumncollection#excel-javascript/api/excel/-tablecolumncollection-getitem-member(1))|Gets a column object by name or ID.| +||[getItemAt(index: number)](/.tablecolumncollection#excel-javascript/api/excel/-tablecolumncollection-getitemat-member(1))|Gets a column based on its position in the collection.| +||[items](/.tablecolumncollection#excel-javascript/api/excel/-tablecolumncollection-items-member)|Gets the loaded child items in this collection.| +|[TableRow](/.tablerow)|[delete()](/.tablerow#excel-javascript/api/excel/-tablerow-delete-member(1))|Deletes the row from the table.| +||[getRange()](/.tablerow#excel-javascript/api/excel/-tablerow-getrange-member(1))|Returns the range object associated with the entire row.| +||[index](/.tablerow#excel-javascript/api/excel/-tablerow-index-member)|Returns the index number of the row within the rows collection of the table.| +||[values](/.tablerow#excel-javascript/api/excel/-tablerow-values-member)|Represents the raw values of the specified range.| +|[TableRowCollection](/.tablerowcollection)|[add(index?: number, values?: Array> \| boolean \| string \| number, alwaysInsert?: boolean)](/.tablerowcollection#excel-javascript/api/excel/-tablerowcollection-add-member(1))|Adds one or more rows to the table.| +||[count](/.tablerowcollection#excel-javascript/api/excel/-tablerowcollection-count-member)|Returns the number of rows in the table.| +||[getItemAt(index: number)](/.tablerowcollection#excel-javascript/api/excel/-tablerowcollection-getitemat-member(1))|Gets a row based on its position in the collection.| +||[items](/.tablerowcollection#excel-javascript/api/excel/-tablerowcollection-items-member)|Gets the loaded child items in this collection.| +|[Workbook](/.workbook)|[application](/.workbook#excel-javascript/api/excel/-workbook-application-member)|Represents the Excel application instance that contains this workbook.| +||[bindings](/.workbook#excel-javascript/api/excel/-workbook-bindings-member)|Represents a collection of bindings that are part of the workbook.| +||[getSelectedRange()](/.workbook#excel-javascript/api/excel/-workbook-getselectedrange-member(1))|Gets the currently selected single range from the workbook.| +||[names](/.workbook#excel-javascript/api/excel/-workbook-names-member)|Represents a collection of workbook-scoped named items (named ranges and constants).| +||[tables](/.workbook#excel-javascript/api/excel/-workbook-tables-member)|Represents a collection of tables associated with the workbook.| +||[worksheets](/.workbook#excel-javascript/api/excel/-workbook-worksheets-member)|Represents a collection of worksheets associated with the workbook.| +|[Worksheet](/.worksheet)|[activate()](/.worksheet#excel-javascript/api/excel/-worksheet-activate-member(1))|Activate the worksheet in the Excel UI.| +||[charts](/.worksheet#excel-javascript/api/excel/-worksheet-charts-member)|Returns a collection of charts that are part of the worksheet.| +||[delete()](/.worksheet#excel-javascript/api/excel/-worksheet-delete-member(1))|Deletes the worksheet from the workbook.| +||[getCell(row: number, column: number)](/.worksheet#excel-javascript/api/excel/-worksheet-getcell-member(1))|Gets the `Range` object containing the single cell based on row and column numbers.| +||[getRange(address?: string)](/.worksheet#excel-javascript/api/excel/-worksheet-getrange-member(1))|Gets the `Range` object, representing a single rectangular block of cells, specified by the address or name.| +||[id](/.worksheet#excel-javascript/api/excel/-worksheet-id-member)|Returns a value that uniquely identifies the worksheet in a given workbook.| +||[name](/.worksheet#excel-javascript/api/excel/-worksheet-name-member)|The display name of the worksheet.| +||[position](/.worksheet#excel-javascript/api/excel/-worksheet-position-member)|The zero-based position of the worksheet within the workbook.| +||[tables](/.worksheet#excel-javascript/api/excel/-worksheet-tables-member)|Collection of tables that are part of the worksheet.| +||[visibility](/.worksheet#excel-javascript/api/excel/-worksheet-visibility-member)|The visibility of the worksheet.| +|[WorksheetCollection](/.worksheetcollection)|[add(name?: string)](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-add-member(1))|Adds a new worksheet to the workbook.| +||[getActiveWorksheet()](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-getactiveworksheet-member(1))|Gets the currently active worksheet in the workbook.| +||[getItem(key: string)](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-getitem-member(1))|Gets a worksheet object using its name or ID.| +||[items](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-items-member)|Gets the loaded child items in this collection.| diff --git a/docs/includes/excel-1_10.md b/docs/includes/excel-1_10.md index 2c06934ef5..052cc841f7 100644 --- a/docs/includes/excel-1_10.md +++ b/docs/includes/excel-1_10.md @@ -1,146 +1,146 @@ | Class | Fields | Description | |:---|:---|:---| -|[Comment](/javascript/api/excel/excel.comment)|[authorEmail](/javascript/api/excel/excel.comment#excel-excel-comment-authoremail-member)|Gets the email of the comment's author.| -||[authorName](/javascript/api/excel/excel.comment#excel-excel-comment-authorname-member)|Gets the name of the comment's author.| -||[content](/javascript/api/excel/excel.comment#excel-excel-comment-content-member)|The comment's content.| -||[creationDate](/javascript/api/excel/excel.comment#excel-excel-comment-creationdate-member)|Gets the creation time of the comment.| -||[delete()](/javascript/api/excel/excel.comment#excel-excel-comment-delete-member(1))|Deletes the comment and all the connected replies.| -||[getLocation()](/javascript/api/excel/excel.comment#excel-excel-comment-getlocation-member(1))|Gets the cell where this comment is located.| -||[id](/javascript/api/excel/excel.comment#excel-excel-comment-id-member)|Specifies the comment identifier.| -||[replies](/javascript/api/excel/excel.comment#excel-excel-comment-replies-member)|Represents a collection of reply objects associated with the comment.| -|[CommentCollection](/javascript/api/excel/excel.commentcollection)|[add(cellAddress: Range \| string, content: string, contentType?: Excel.ContentType)](/javascript/api/excel/excel.commentcollection#excel-excel-commentcollection-add-member(1))|Creates a new comment with the given content on the given cell.| -||[getCount()](/javascript/api/excel/excel.commentcollection#excel-excel-commentcollection-getcount-member(1))|Gets the number of comments in the collection.| -||[getItem(commentId: string)](/javascript/api/excel/excel.commentcollection#excel-excel-commentcollection-getitem-member(1))|Gets a comment from the collection based on its ID.| -||[getItemAt(index: number)](/javascript/api/excel/excel.commentcollection#excel-excel-commentcollection-getitemat-member(1))|Gets a comment from the collection based on its position.| -||[getItemByCell(cellAddress: Range \| string)](/javascript/api/excel/excel.commentcollection#excel-excel-commentcollection-getitembycell-member(1))|Gets the comment from the specified cell.| -||[getItemByReplyId(replyId: string)](/javascript/api/excel/excel.commentcollection#excel-excel-commentcollection-getitembyreplyid-member(1))|Gets the comment to which the given reply is connected.| -||[items](/javascript/api/excel/excel.commentcollection#excel-excel-commentcollection-items-member)|Gets the loaded child items in this collection.| -|[CommentReply](/javascript/api/excel/excel.commentreply)|[authorEmail](/javascript/api/excel/excel.commentreply#excel-excel-commentreply-authoremail-member)|Gets the email of the comment reply's author.| -||[authorName](/javascript/api/excel/excel.commentreply#excel-excel-commentreply-authorname-member)|Gets the name of the comment reply's author.| -||[content](/javascript/api/excel/excel.commentreply#excel-excel-commentreply-content-member)|The comment reply's content.| -||[creationDate](/javascript/api/excel/excel.commentreply#excel-excel-commentreply-creationdate-member)|Gets the creation time of the comment reply.| -||[delete()](/javascript/api/excel/excel.commentreply#excel-excel-commentreply-delete-member(1))|Deletes the comment reply.| -||[getLocation()](/javascript/api/excel/excel.commentreply#excel-excel-commentreply-getlocation-member(1))|Gets the cell where this comment reply is located.| -||[getParentComment()](/javascript/api/excel/excel.commentreply#excel-excel-commentreply-getparentcomment-member(1))|Gets the parent comment of this reply.| -||[id](/javascript/api/excel/excel.commentreply#excel-excel-commentreply-id-member)|Specifies the comment reply identifier.| -|[CommentReplyCollection](/javascript/api/excel/excel.commentreplycollection)|[add(content: string, contentType?: Excel.ContentType)](/javascript/api/excel/excel.commentreplycollection#excel-excel-commentreplycollection-add-member(1))|Creates a comment reply for a comment.| -||[getCount()](/javascript/api/excel/excel.commentreplycollection#excel-excel-commentreplycollection-getcount-member(1))|Gets the number of comment replies in the collection.| -||[getItem(commentReplyId: string)](/javascript/api/excel/excel.commentreplycollection#excel-excel-commentreplycollection-getitem-member(1))|Returns a comment reply identified by its ID.| -||[getItemAt(index: number)](/javascript/api/excel/excel.commentreplycollection#excel-excel-commentreplycollection-getitemat-member(1))|Gets a comment reply based on its position in the collection.| -||[items](/javascript/api/excel/excel.commentreplycollection#excel-excel-commentreplycollection-items-member)|Gets the loaded child items in this collection.| -|[PivotLayout](/javascript/api/excel/excel.pivotlayout)|[enableFieldList](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-enablefieldlist-member)|Specifies if the field list can be shown in the UI.| -|[PivotTableStyle](/javascript/api/excel/excel.pivottablestyle)|[delete()](/javascript/api/excel/excel.pivottablestyle#excel-excel-pivottablestyle-delete-member(1))|Deletes the PivotTable style.| -||[duplicate()](/javascript/api/excel/excel.pivottablestyle#excel-excel-pivottablestyle-duplicate-member(1))|Creates a duplicate of this PivotTable style with copies of all the style elements.| -||[name](/javascript/api/excel/excel.pivottablestyle#excel-excel-pivottablestyle-name-member)|Specifies the name of the PivotTable style.| -||[readOnly](/javascript/api/excel/excel.pivottablestyle#excel-excel-pivottablestyle-readonly-member)|Specifies if this `PivotTableStyle` object is read-only.| -|[PivotTableStyleCollection](/javascript/api/excel/excel.pivottablestylecollection)|[add(name: string, makeUniqueName?: boolean)](/javascript/api/excel/excel.pivottablestylecollection#excel-excel-pivottablestylecollection-add-member(1))|Creates a blank `PivotTableStyle` with the specified name.| -||[getCount()](/javascript/api/excel/excel.pivottablestylecollection#excel-excel-pivottablestylecollection-getcount-member(1))|Gets the number of PivotTable styles in the collection.| -||[getDefault()](/javascript/api/excel/excel.pivottablestylecollection#excel-excel-pivottablestylecollection-getdefault-member(1))|Gets the default PivotTable style for the parent object's scope.| -||[getItem(name: string)](/javascript/api/excel/excel.pivottablestylecollection#excel-excel-pivottablestylecollection-getitem-member(1))|Gets a `PivotTableStyle` by name.| -||[getItemOrNullObject(name: string)](/javascript/api/excel/excel.pivottablestylecollection#excel-excel-pivottablestylecollection-getitemornullobject-member(1))|Gets a `PivotTableStyle` by name.| -||[items](/javascript/api/excel/excel.pivottablestylecollection#excel-excel-pivottablestylecollection-items-member)|Gets the loaded child items in this collection.| -||[setDefault(newDefaultStyle: PivotTableStyle \| string)](/javascript/api/excel/excel.pivottablestylecollection#excel-excel-pivottablestylecollection-setdefault-member(1))|Sets the default PivotTable style for use in the parent object's scope.| -|[Range](/javascript/api/excel/excel.range)|[group(groupOption: Excel.GroupOption)](/javascript/api/excel/excel.range#excel-excel-range-group-member(1))|Groups columns and rows for an outline.| -||[height](/javascript/api/excel/excel.range#excel-excel-range-height-member)|Returns the distance in points, for 100% zoom, from the top edge of the range to the bottom edge of the range.| -||[hideGroupDetails(groupOption: Excel.GroupOption)](/javascript/api/excel/excel.range#excel-excel-range-hidegroupdetails-member(1))|Hides the details of the row or column group.| -||[left](/javascript/api/excel/excel.range#excel-excel-range-left-member)|Returns the distance in points, for 100% zoom, from the left edge of the worksheet to the left edge of the range.| -||[showGroupDetails(groupOption: Excel.GroupOption)](/javascript/api/excel/excel.range#excel-excel-range-showgroupdetails-member(1))|Shows the details of the row or column group.| -||[top](/javascript/api/excel/excel.range#excel-excel-range-top-member)|Returns the distance in points, for 100% zoom, from the top edge of the worksheet to the top edge of the range.| -||[ungroup(groupOption: Excel.GroupOption)](/javascript/api/excel/excel.range#excel-excel-range-ungroup-member(1))|Ungroups columns and rows for an outline.| -||[width](/javascript/api/excel/excel.range#excel-excel-range-width-member)|Returns the distance in points, for 100% zoom, from the left edge of the range to the right edge of the range.| -|[Shape](/javascript/api/excel/excel.shape)|[copyTo(destinationSheet?: Worksheet \| string)](/javascript/api/excel/excel.shape#excel-excel-shape-copyto-member(1))|Copies and pastes a `Shape` object.| -||[placement](/javascript/api/excel/excel.shape#excel-excel-shape-placement-member)|Represents how the object is attached to the cells below it.| -|[Slicer](/javascript/api/excel/excel.slicer)|[caption](/javascript/api/excel/excel.slicer#excel-excel-slicer-caption-member)|Represents the caption of the slicer.| -||[clearFilters()](/javascript/api/excel/excel.slicer#excel-excel-slicer-clearfilters-member(1))|Clears all the filters currently applied on the slicer.| -||[delete()](/javascript/api/excel/excel.slicer#excel-excel-slicer-delete-member(1))|Deletes the slicer.| -||[getSelectedItems()](/javascript/api/excel/excel.slicer#excel-excel-slicer-getselecteditems-member(1))|Returns an array of selected items' keys.| -||[height](/javascript/api/excel/excel.slicer#excel-excel-slicer-height-member)|Specifies the height, in points, of the slicer.| -||[id](/javascript/api/excel/excel.slicer#excel-excel-slicer-id-member)|Represents the unique ID of the slicer.| -||[isFilterCleared](/javascript/api/excel/excel.slicer#excel-excel-slicer-isfiltercleared-member)|Value is `true` if all filters currently applied on the slicer are cleared.| -||[left](/javascript/api/excel/excel.slicer#excel-excel-slicer-left-member)|Represents the distance, in points, from the left side of the slicer to the left of the worksheet.| -||[name](/javascript/api/excel/excel.slicer#excel-excel-slicer-name-member)|Represents the name of the slicer.| -||[selectItems(items?: string[])](/javascript/api/excel/excel.slicer#excel-excel-slicer-selectitems-member(1))|Selects slicer items based on their keys.| -||[slicerItems](/javascript/api/excel/excel.slicer#excel-excel-slicer-sliceritems-member)|Represents the collection of slicer items that are part of the slicer.| -||[sortBy](/javascript/api/excel/excel.slicer#excel-excel-slicer-sortby-member)|Specifies the sort order of the items in the slicer.| -||[style](/javascript/api/excel/excel.slicer#excel-excel-slicer-style-member)|Constant value that represents the slicer style.| -||[top](/javascript/api/excel/excel.slicer#excel-excel-slicer-top-member)|Represents the distance, in points, from the top edge of the slicer to the top of the worksheet.| -||[width](/javascript/api/excel/excel.slicer#excel-excel-slicer-width-member)|Represents the width, in points, of the slicer.| -||[worksheet](/javascript/api/excel/excel.slicer#excel-excel-slicer-worksheet-member)|Represents the worksheet containing the slicer.| -|[SlicerCollection](/javascript/api/excel/excel.slicercollection)|[add(slicerSource: string \| PivotTable \| Table, sourceField: string \| PivotField \| number \| TableColumn, slicerDestination?: string \| Worksheet)](/javascript/api/excel/excel.slicercollection#excel-excel-slicercollection-add-member(1))|Adds a new slicer to the workbook.| -||[getCount()](/javascript/api/excel/excel.slicercollection#excel-excel-slicercollection-getcount-member(1))|Returns the number of slicers in the collection.| -||[getItem(key: string)](/javascript/api/excel/excel.slicercollection#excel-excel-slicercollection-getitem-member(1))|Gets a slicer object using its name or ID.| -||[getItemAt(index: number)](/javascript/api/excel/excel.slicercollection#excel-excel-slicercollection-getitemat-member(1))|Gets a slicer based on its position in the collection.| -||[getItemOrNullObject(key: string)](/javascript/api/excel/excel.slicercollection#excel-excel-slicercollection-getitemornullobject-member(1))|Gets a slicer using its name or ID.| -||[items](/javascript/api/excel/excel.slicercollection#excel-excel-slicercollection-items-member)|Gets the loaded child items in this collection.| -|[SlicerItem](/javascript/api/excel/excel.sliceritem)|[hasData](/javascript/api/excel/excel.sliceritem#excel-excel-sliceritem-hasdata-member)|Value is `true` if the slicer item has data.| -||[isSelected](/javascript/api/excel/excel.sliceritem#excel-excel-sliceritem-isselected-member)|Value is `true` if the slicer item is selected.| -||[key](/javascript/api/excel/excel.sliceritem#excel-excel-sliceritem-key-member)|Represents the unique value representing the slicer item.| -||[name](/javascript/api/excel/excel.sliceritem#excel-excel-sliceritem-name-member)|Represents the title displayed in the Excel UI.| -|[SlicerItemCollection](/javascript/api/excel/excel.sliceritemcollection)|[getCount()](/javascript/api/excel/excel.sliceritemcollection#excel-excel-sliceritemcollection-getcount-member(1))|Returns the number of slicer items in the slicer.| -||[getItem(key: string)](/javascript/api/excel/excel.sliceritemcollection#excel-excel-sliceritemcollection-getitem-member(1))|Gets a slicer item object using its key or name.| -||[getItemAt(index: number)](/javascript/api/excel/excel.sliceritemcollection#excel-excel-sliceritemcollection-getitemat-member(1))|Gets a slicer item based on its position in the collection.| -||[getItemOrNullObject(key: string)](/javascript/api/excel/excel.sliceritemcollection#excel-excel-sliceritemcollection-getitemornullobject-member(1))|Gets a slicer item using its key or name.| -||[items](/javascript/api/excel/excel.sliceritemcollection#excel-excel-sliceritemcollection-items-member)|Gets the loaded child items in this collection.| -|[SlicerStyle](/javascript/api/excel/excel.slicerstyle)|[delete()](/javascript/api/excel/excel.slicerstyle#excel-excel-slicerstyle-delete-member(1))|Deletes the slicer style.| -||[duplicate()](/javascript/api/excel/excel.slicerstyle#excel-excel-slicerstyle-duplicate-member(1))|Creates a duplicate of this slicer style with copies of all the style elements.| -||[name](/javascript/api/excel/excel.slicerstyle#excel-excel-slicerstyle-name-member)|Specifies the name of the slicer style.| -||[readOnly](/javascript/api/excel/excel.slicerstyle#excel-excel-slicerstyle-readonly-member)|Specifies if this `SlicerStyle` object is read-only.| -|[SlicerStyleCollection](/javascript/api/excel/excel.slicerstylecollection)|[add(name: string, makeUniqueName?: boolean)](/javascript/api/excel/excel.slicerstylecollection#excel-excel-slicerstylecollection-add-member(1))|Creates a blank slicer style with the specified name.| -||[getCount()](/javascript/api/excel/excel.slicerstylecollection#excel-excel-slicerstylecollection-getcount-member(1))|Gets the number of slicer styles in the collection.| -||[getDefault()](/javascript/api/excel/excel.slicerstylecollection#excel-excel-slicerstylecollection-getdefault-member(1))|Gets the default `SlicerStyle` for the parent object's scope.| -||[getItem(name: string)](/javascript/api/excel/excel.slicerstylecollection#excel-excel-slicerstylecollection-getitem-member(1))|Gets a `SlicerStyle` by name.| -||[getItemOrNullObject(name: string)](/javascript/api/excel/excel.slicerstylecollection#excel-excel-slicerstylecollection-getitemornullobject-member(1))|Gets a `SlicerStyle` by name.| -||[items](/javascript/api/excel/excel.slicerstylecollection#excel-excel-slicerstylecollection-items-member)|Gets the loaded child items in this collection.| -||[setDefault(newDefaultStyle: SlicerStyle \| string)](/javascript/api/excel/excel.slicerstylecollection#excel-excel-slicerstylecollection-setdefault-member(1))|Sets the default slicer style for use in the parent object's scope.| -|[TableStyle](/javascript/api/excel/excel.tablestyle)|[delete()](/javascript/api/excel/excel.tablestyle#excel-excel-tablestyle-delete-member(1))|Deletes the table style.| -||[duplicate()](/javascript/api/excel/excel.tablestyle#excel-excel-tablestyle-duplicate-member(1))|Creates a duplicate of this table style with copies of all the style elements.| -||[name](/javascript/api/excel/excel.tablestyle#excel-excel-tablestyle-name-member)|Specifies the name of the table style.| -||[readOnly](/javascript/api/excel/excel.tablestyle#excel-excel-tablestyle-readonly-member)|Specifies if this `TableStyle` object is read-only.| -|[TableStyleCollection](/javascript/api/excel/excel.tablestylecollection)|[add(name: string, makeUniqueName?: boolean)](/javascript/api/excel/excel.tablestylecollection#excel-excel-tablestylecollection-add-member(1))|Creates a blank `TableStyle` with the specified name.| -||[getCount()](/javascript/api/excel/excel.tablestylecollection#excel-excel-tablestylecollection-getcount-member(1))|Gets the number of table styles in the collection.| -||[getDefault()](/javascript/api/excel/excel.tablestylecollection#excel-excel-tablestylecollection-getdefault-member(1))|Gets the default table style for the parent object's scope.| -||[getItem(name: string)](/javascript/api/excel/excel.tablestylecollection#excel-excel-tablestylecollection-getitem-member(1))|Gets a `TableStyle` by name.| -||[getItemOrNullObject(name: string)](/javascript/api/excel/excel.tablestylecollection#excel-excel-tablestylecollection-getitemornullobject-member(1))|Gets a `TableStyle` by name.| -||[items](/javascript/api/excel/excel.tablestylecollection#excel-excel-tablestylecollection-items-member)|Gets the loaded child items in this collection.| -||[setDefault(newDefaultStyle: TableStyle \| string)](/javascript/api/excel/excel.tablestylecollection#excel-excel-tablestylecollection-setdefault-member(1))|Sets the default table style for use in the parent object's scope.| -|[TimelineStyle](/javascript/api/excel/excel.timelinestyle)|[delete()](/javascript/api/excel/excel.timelinestyle#excel-excel-timelinestyle-delete-member(1))|Deletes the table style.| -||[duplicate()](/javascript/api/excel/excel.timelinestyle#excel-excel-timelinestyle-duplicate-member(1))|Creates a duplicate of this timeline style with copies of all the style elements.| -||[name](/javascript/api/excel/excel.timelinestyle#excel-excel-timelinestyle-name-member)|Specifies the name of the timeline style.| -||[readOnly](/javascript/api/excel/excel.timelinestyle#excel-excel-timelinestyle-readonly-member)|Specifies if this `TimelineStyle` object is read-only.| -|[TimelineStyleCollection](/javascript/api/excel/excel.timelinestylecollection)|[add(name: string, makeUniqueName?: boolean)](/javascript/api/excel/excel.timelinestylecollection#excel-excel-timelinestylecollection-add-member(1))|Creates a blank `TimelineStyle` with the specified name.| -||[getCount()](/javascript/api/excel/excel.timelinestylecollection#excel-excel-timelinestylecollection-getcount-member(1))|Gets the number of timeline styles in the collection.| -||[getDefault()](/javascript/api/excel/excel.timelinestylecollection#excel-excel-timelinestylecollection-getdefault-member(1))|Gets the default timeline style for the parent object's scope.| -||[getItem(name: string)](/javascript/api/excel/excel.timelinestylecollection#excel-excel-timelinestylecollection-getitem-member(1))|Gets a `TimelineStyle` by name.| -||[getItemOrNullObject(name: string)](/javascript/api/excel/excel.timelinestylecollection#excel-excel-timelinestylecollection-getitemornullobject-member(1))|Gets a `TimelineStyle` by name.| -||[items](/javascript/api/excel/excel.timelinestylecollection#excel-excel-timelinestylecollection-items-member)|Gets the loaded child items in this collection.| -||[setDefault(newDefaultStyle: TimelineStyle \| string)](/javascript/api/excel/excel.timelinestylecollection#excel-excel-timelinestylecollection-setdefault-member(1))|Sets the default timeline style for use in the parent object's scope.| -|[Workbook](/javascript/api/excel/excel.workbook)|[comments](/javascript/api/excel/excel.workbook#excel-excel-workbook-comments-member)|Represents a collection of comments associated with the workbook.| -||[getActiveSlicer()](/javascript/api/excel/excel.workbook#excel-excel-workbook-getactiveslicer-member(1))|Gets the currently active slicer in the workbook.| -||[getActiveSlicerOrNullObject()](/javascript/api/excel/excel.workbook#excel-excel-workbook-getactiveslicerornullobject-member(1))|Gets the currently active slicer in the workbook.| -||[pivotTableStyles](/javascript/api/excel/excel.workbook#excel-excel-workbook-pivottablestyles-member)|Represents a collection of PivotTableStyles associated with the workbook.| -||[slicerStyles](/javascript/api/excel/excel.workbook#excel-excel-workbook-slicerstyles-member)|Represents a collection of SlicerStyles associated with the workbook.| -||[slicers](/javascript/api/excel/excel.workbook#excel-excel-workbook-slicers-member)|Represents a collection of slicers associated with the workbook.| -||[tableStyles](/javascript/api/excel/excel.workbook#excel-excel-workbook-tablestyles-member)|Represents a collection of TableStyles associated with the workbook.| -||[timelineStyles](/javascript/api/excel/excel.workbook#excel-excel-workbook-timelinestyles-member)|Represents a collection of TimelineStyles associated with the workbook.| -|[Worksheet](/javascript/api/excel/excel.worksheet)|[comments](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-comments-member)|Returns a collection of all the Comments objects on the worksheet.| -||[onColumnSorted](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-oncolumnsorted-member)|Occurs when one or more columns have been sorted.| -||[onRowSorted](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-onrowsorted-member)|Occurs when one or more rows have been sorted.| -||[onSingleClicked](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-onsingleclicked-member)|Occurs when a left-clicked/tapped action happens in the worksheet.| -||[showOutlineLevels(rowLevels: number, columnLevels: number)](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-showoutlinelevels-member(1))|Shows row or column groups by their outline levels.| -||[slicers](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-slicers-member)|Returns a collection of slicers that are part of the worksheet.| -|[WorksheetCollection](/javascript/api/excel/excel.worksheetcollection)|[onColumnSorted](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-oncolumnsorted-member)|Occurs when one or more columns have been sorted.| -||[onRowSorted](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-onrowsorted-member)|Occurs when one or more rows have been sorted.| -||[onSingleClicked](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-onsingleclicked-member)|Occurs when left-clicked/tapped operation happens in the worksheet collection.| -|[WorksheetColumnSortedEventArgs](/javascript/api/excel/excel.worksheetcolumnsortedeventargs)|[address](/javascript/api/excel/excel.worksheetcolumnsortedeventargs#excel-excel-worksheetcolumnsortedeventargs-address-member)|Gets the range address that represents the sorted areas of a specific worksheet.| -||[source](/javascript/api/excel/excel.worksheetcolumnsortedeventargs#excel-excel-worksheetcolumnsortedeventargs-source-member)|Gets the source of the event.| -||[type](/javascript/api/excel/excel.worksheetcolumnsortedeventargs#excel-excel-worksheetcolumnsortedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/javascript/api/excel/excel.worksheetcolumnsortedeventargs#excel-excel-worksheetcolumnsortedeventargs-worksheetid-member)|Gets the ID of the worksheet where the sorting happened.| -|[WorksheetRowSortedEventArgs](/javascript/api/excel/excel.worksheetrowsortedeventargs)|[address](/javascript/api/excel/excel.worksheetrowsortedeventargs#excel-excel-worksheetrowsortedeventargs-address-member)|Gets the range address that represents the sorted areas of a specific worksheet.| -||[source](/javascript/api/excel/excel.worksheetrowsortedeventargs#excel-excel-worksheetrowsortedeventargs-source-member)|Gets the source of the event.| -||[type](/javascript/api/excel/excel.worksheetrowsortedeventargs#excel-excel-worksheetrowsortedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/javascript/api/excel/excel.worksheetrowsortedeventargs#excel-excel-worksheetrowsortedeventargs-worksheetid-member)|Gets the ID of the worksheet where the sorting happened.| -|[WorksheetSingleClickedEventArgs](/javascript/api/excel/excel.worksheetsingleclickedeventargs)|[address](/javascript/api/excel/excel.worksheetsingleclickedeventargs#excel-excel-worksheetsingleclickedeventargs-address-member)|Gets the address that represents the cell which was left-clicked/tapped for a specific worksheet.| -||[offsetX](/javascript/api/excel/excel.worksheetsingleclickedeventargs#excel-excel-worksheetsingleclickedeventargs-offsetx-member)|The distance, in points, from the left-clicked/tapped point to the left (or right for right-to-left languages) gridline edge of the left-clicked/tapped cell.| -||[offsetY](/javascript/api/excel/excel.worksheetsingleclickedeventargs#excel-excel-worksheetsingleclickedeventargs-offsety-member)|The distance, in points, from the left-clicked/tapped point to the top gridline edge of the left-clicked/tapped cell.| -||[type](/javascript/api/excel/excel.worksheetsingleclickedeventargs#excel-excel-worksheetsingleclickedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/javascript/api/excel/excel.worksheetsingleclickedeventargs#excel-excel-worksheetsingleclickedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the cell was left-clicked/tapped.| +|[Comment](/.comment)|[authorEmail](/.comment#excel-javascript/api/excel/-comment-authoremail-member)|Gets the email of the comment's author.| +||[authorName](/.comment#excel-javascript/api/excel/-comment-authorname-member)|Gets the name of the comment's author.| +||[content](/.comment#excel-javascript/api/excel/-comment-content-member)|The comment's content.| +||[creationDate](/.comment#excel-javascript/api/excel/-comment-creationdate-member)|Gets the creation time of the comment.| +||[delete()](/.comment#excel-javascript/api/excel/-comment-delete-member(1))|Deletes the comment and all the connected replies.| +||[getLocation()](/.comment#excel-javascript/api/excel/-comment-getlocation-member(1))|Gets the cell where this comment is located.| +||[id](/.comment#excel-javascript/api/excel/-comment-id-member)|Specifies the comment identifier.| +||[replies](/.comment#excel-javascript/api/excel/-comment-replies-member)|Represents a collection of reply objects associated with the comment.| +|[CommentCollection](/.commentcollection)|[add(cellAddress: Range \| string, content: string, contentType?: Excel.ContentType)](/.commentcollection#excel-javascript/api/excel/-commentcollection-add-member(1))|Creates a new comment with the given content on the given cell.| +||[getCount()](/.commentcollection#excel-javascript/api/excel/-commentcollection-getcount-member(1))|Gets the number of comments in the collection.| +||[getItem(commentId: string)](/.commentcollection#excel-javascript/api/excel/-commentcollection-getitem-member(1))|Gets a comment from the collection based on its ID.| +||[getItemAt(index: number)](/.commentcollection#excel-javascript/api/excel/-commentcollection-getitemat-member(1))|Gets a comment from the collection based on its position.| +||[getItemByCell(cellAddress: Range \| string)](/.commentcollection#excel-javascript/api/excel/-commentcollection-getitembycell-member(1))|Gets the comment from the specified cell.| +||[getItemByReplyId(replyId: string)](/.commentcollection#excel-javascript/api/excel/-commentcollection-getitembyreplyid-member(1))|Gets the comment to which the given reply is connected.| +||[items](/.commentcollection#excel-javascript/api/excel/-commentcollection-items-member)|Gets the loaded child items in this collection.| +|[CommentReply](/.commentreply)|[authorEmail](/.commentreply#excel-javascript/api/excel/-commentreply-authoremail-member)|Gets the email of the comment reply's author.| +||[authorName](/.commentreply#excel-javascript/api/excel/-commentreply-authorname-member)|Gets the name of the comment reply's author.| +||[content](/.commentreply#excel-javascript/api/excel/-commentreply-content-member)|The comment reply's content.| +||[creationDate](/.commentreply#excel-javascript/api/excel/-commentreply-creationdate-member)|Gets the creation time of the comment reply.| +||[delete()](/.commentreply#excel-javascript/api/excel/-commentreply-delete-member(1))|Deletes the comment reply.| +||[getLocation()](/.commentreply#excel-javascript/api/excel/-commentreply-getlocation-member(1))|Gets the cell where this comment reply is located.| +||[getParentComment()](/.commentreply#excel-javascript/api/excel/-commentreply-getparentcomment-member(1))|Gets the parent comment of this reply.| +||[id](/.commentreply#excel-javascript/api/excel/-commentreply-id-member)|Specifies the comment reply identifier.| +|[CommentReplyCollection](/.commentreplycollection)|[add(content: string, contentType?: Excel.ContentType)](/.commentreplycollection#excel-javascript/api/excel/-commentreplycollection-add-member(1))|Creates a comment reply for a comment.| +||[getCount()](/.commentreplycollection#excel-javascript/api/excel/-commentreplycollection-getcount-member(1))|Gets the number of comment replies in the collection.| +||[getItem(commentReplyId: string)](/.commentreplycollection#excel-javascript/api/excel/-commentreplycollection-getitem-member(1))|Returns a comment reply identified by its ID.| +||[getItemAt(index: number)](/.commentreplycollection#excel-javascript/api/excel/-commentreplycollection-getitemat-member(1))|Gets a comment reply based on its position in the collection.| +||[items](/.commentreplycollection#excel-javascript/api/excel/-commentreplycollection-items-member)|Gets the loaded child items in this collection.| +|[PivotLayout](/.pivotlayout)|[enableFieldList](/.pivotlayout#excel-javascript/api/excel/-pivotlayout-enablefieldlist-member)|Specifies if the field list can be shown in the UI.| +|[PivotTableStyle](/.pivottablestyle)|[delete()](/.pivottablestyle#excel-javascript/api/excel/-pivottablestyle-delete-member(1))|Deletes the PivotTable style.| +||[duplicate()](/.pivottablestyle#excel-javascript/api/excel/-pivottablestyle-duplicate-member(1))|Creates a duplicate of this PivotTable style with copies of all the style elements.| +||[name](/.pivottablestyle#excel-javascript/api/excel/-pivottablestyle-name-member)|Specifies the name of the PivotTable style.| +||[readOnly](/.pivottablestyle#excel-javascript/api/excel/-pivottablestyle-readonly-member)|Specifies if this `PivotTableStyle` object is read-only.| +|[PivotTableStyleCollection](/.pivottablestylecollection)|[add(name: string, makeUniqueName?: boolean)](/.pivottablestylecollection#excel-javascript/api/excel/-pivottablestylecollection-add-member(1))|Creates a blank `PivotTableStyle` with the specified name.| +||[getCount()](/.pivottablestylecollection#excel-javascript/api/excel/-pivottablestylecollection-getcount-member(1))|Gets the number of PivotTable styles in the collection.| +||[getDefault()](/.pivottablestylecollection#excel-javascript/api/excel/-pivottablestylecollection-getdefault-member(1))|Gets the default PivotTable style for the parent object's scope.| +||[getItem(name: string)](/.pivottablestylecollection#excel-javascript/api/excel/-pivottablestylecollection-getitem-member(1))|Gets a `PivotTableStyle` by name.| +||[getItemOrNullObject(name: string)](/.pivottablestylecollection#excel-javascript/api/excel/-pivottablestylecollection-getitemornullobject-member(1))|Gets a `PivotTableStyle` by name.| +||[items](/.pivottablestylecollection#excel-javascript/api/excel/-pivottablestylecollection-items-member)|Gets the loaded child items in this collection.| +||[setDefault(newDefaultStyle: PivotTableStyle \| string)](/.pivottablestylecollection#excel-javascript/api/excel/-pivottablestylecollection-setdefault-member(1))|Sets the default PivotTable style for use in the parent object's scope.| +|[Range](/.range)|[group(groupOption: Excel.GroupOption)](/.range#excel-javascript/api/excel/-range-group-member(1))|Groups columns and rows for an outline.| +||[height](/.range#excel-javascript/api/excel/-range-height-member)|Returns the distance in points, for 100% zoom, from the top edge of the range to the bottom edge of the range.| +||[hideGroupDetails(groupOption: Excel.GroupOption)](/.range#excel-javascript/api/excel/-range-hidegroupdetails-member(1))|Hides the details of the row or column group.| +||[left](/.range#excel-javascript/api/excel/-range-left-member)|Returns the distance in points, for 100% zoom, from the left edge of the worksheet to the left edge of the range.| +||[showGroupDetails(groupOption: Excel.GroupOption)](/.range#excel-javascript/api/excel/-range-showgroupdetails-member(1))|Shows the details of the row or column group.| +||[top](/.range#excel-javascript/api/excel/-range-top-member)|Returns the distance in points, for 100% zoom, from the top edge of the worksheet to the top edge of the range.| +||[ungroup(groupOption: Excel.GroupOption)](/.range#excel-javascript/api/excel/-range-ungroup-member(1))|Ungroups columns and rows for an outline.| +||[width](/.range#excel-javascript/api/excel/-range-width-member)|Returns the distance in points, for 100% zoom, from the left edge of the range to the right edge of the range.| +|[Shape](/.shape)|[copyTo(destinationSheet?: Worksheet \| string)](/.shape#excel-javascript/api/excel/-shape-copyto-member(1))|Copies and pastes a `Shape` object.| +||[placement](/.shape#excel-javascript/api/excel/-shape-placement-member)|Represents how the object is attached to the cells below it.| +|[Slicer](/.slicer)|[caption](/.slicer#excel-javascript/api/excel/-slicer-caption-member)|Represents the caption of the slicer.| +||[clearFilters()](/.slicer#excel-javascript/api/excel/-slicer-clearfilters-member(1))|Clears all the filters currently applied on the slicer.| +||[delete()](/.slicer#excel-javascript/api/excel/-slicer-delete-member(1))|Deletes the slicer.| +||[getSelectedItems()](/.slicer#excel-javascript/api/excel/-slicer-getselecteditems-member(1))|Returns an array of selected items' keys.| +||[height](/.slicer#excel-javascript/api/excel/-slicer-height-member)|Specifies the height, in points, of the slicer.| +||[id](/.slicer#excel-javascript/api/excel/-slicer-id-member)|Represents the unique ID of the slicer.| +||[isFilterCleared](/.slicer#excel-javascript/api/excel/-slicer-isfiltercleared-member)|Value is `true` if all filters currently applied on the slicer are cleared.| +||[left](/.slicer#excel-javascript/api/excel/-slicer-left-member)|Represents the distance, in points, from the left side of the slicer to the left of the worksheet.| +||[name](/.slicer#excel-javascript/api/excel/-slicer-name-member)|Represents the name of the slicer.| +||[selectItems(items?: string[])](/.slicer#excel-javascript/api/excel/-slicer-selectitems-member(1))|Selects slicer items based on their keys.| +||[slicerItems](/.slicer#excel-javascript/api/excel/-slicer-sliceritems-member)|Represents the collection of slicer items that are part of the slicer.| +||[sortBy](/.slicer#excel-javascript/api/excel/-slicer-sortby-member)|Specifies the sort order of the items in the slicer.| +||[style](/.slicer#excel-javascript/api/excel/-slicer-style-member)|Constant value that represents the slicer style.| +||[top](/.slicer#excel-javascript/api/excel/-slicer-top-member)|Represents the distance, in points, from the top edge of the slicer to the top of the worksheet.| +||[width](/.slicer#excel-javascript/api/excel/-slicer-width-member)|Represents the width, in points, of the slicer.| +||[worksheet](/.slicer#excel-javascript/api/excel/-slicer-worksheet-member)|Represents the worksheet containing the slicer.| +|[SlicerCollection](/.slicercollection)|[add(slicerSource: string \| PivotTable \| Table, sourceField: string \| PivotField \| number \| TableColumn, slicerDestination?: string \| Worksheet)](/.slicercollection#excel-javascript/api/excel/-slicercollection-add-member(1))|Adds a new slicer to the workbook.| +||[getCount()](/.slicercollection#excel-javascript/api/excel/-slicercollection-getcount-member(1))|Returns the number of slicers in the collection.| +||[getItem(key: string)](/.slicercollection#excel-javascript/api/excel/-slicercollection-getitem-member(1))|Gets a slicer object using its name or ID.| +||[getItemAt(index: number)](/.slicercollection#excel-javascript/api/excel/-slicercollection-getitemat-member(1))|Gets a slicer based on its position in the collection.| +||[getItemOrNullObject(key: string)](/.slicercollection#excel-javascript/api/excel/-slicercollection-getitemornullobject-member(1))|Gets a slicer using its name or ID.| +||[items](/.slicercollection#excel-javascript/api/excel/-slicercollection-items-member)|Gets the loaded child items in this collection.| +|[SlicerItem](/.sliceritem)|[hasData](/.sliceritem#excel-javascript/api/excel/-sliceritem-hasdata-member)|Value is `true` if the slicer item has data.| +||[isSelected](/.sliceritem#excel-javascript/api/excel/-sliceritem-isselected-member)|Value is `true` if the slicer item is selected.| +||[key](/.sliceritem#excel-javascript/api/excel/-sliceritem-key-member)|Represents the unique value representing the slicer item.| +||[name](/.sliceritem#excel-javascript/api/excel/-sliceritem-name-member)|Represents the title displayed in the Excel UI.| +|[SlicerItemCollection](/.sliceritemcollection)|[getCount()](/.sliceritemcollection#excel-javascript/api/excel/-sliceritemcollection-getcount-member(1))|Returns the number of slicer items in the slicer.| +||[getItem(key: string)](/.sliceritemcollection#excel-javascript/api/excel/-sliceritemcollection-getitem-member(1))|Gets a slicer item object using its key or name.| +||[getItemAt(index: number)](/.sliceritemcollection#excel-javascript/api/excel/-sliceritemcollection-getitemat-member(1))|Gets a slicer item based on its position in the collection.| +||[getItemOrNullObject(key: string)](/.sliceritemcollection#excel-javascript/api/excel/-sliceritemcollection-getitemornullobject-member(1))|Gets a slicer item using its key or name.| +||[items](/.sliceritemcollection#excel-javascript/api/excel/-sliceritemcollection-items-member)|Gets the loaded child items in this collection.| +|[SlicerStyle](/.slicerstyle)|[delete()](/.slicerstyle#excel-javascript/api/excel/-slicerstyle-delete-member(1))|Deletes the slicer style.| +||[duplicate()](/.slicerstyle#excel-javascript/api/excel/-slicerstyle-duplicate-member(1))|Creates a duplicate of this slicer style with copies of all the style elements.| +||[name](/.slicerstyle#excel-javascript/api/excel/-slicerstyle-name-member)|Specifies the name of the slicer style.| +||[readOnly](/.slicerstyle#excel-javascript/api/excel/-slicerstyle-readonly-member)|Specifies if this `SlicerStyle` object is read-only.| +|[SlicerStyleCollection](/.slicerstylecollection)|[add(name: string, makeUniqueName?: boolean)](/.slicerstylecollection#excel-javascript/api/excel/-slicerstylecollection-add-member(1))|Creates a blank slicer style with the specified name.| +||[getCount()](/.slicerstylecollection#excel-javascript/api/excel/-slicerstylecollection-getcount-member(1))|Gets the number of slicer styles in the collection.| +||[getDefault()](/.slicerstylecollection#excel-javascript/api/excel/-slicerstylecollection-getdefault-member(1))|Gets the default `SlicerStyle` for the parent object's scope.| +||[getItem(name: string)](/.slicerstylecollection#excel-javascript/api/excel/-slicerstylecollection-getitem-member(1))|Gets a `SlicerStyle` by name.| +||[getItemOrNullObject(name: string)](/.slicerstylecollection#excel-javascript/api/excel/-slicerstylecollection-getitemornullobject-member(1))|Gets a `SlicerStyle` by name.| +||[items](/.slicerstylecollection#excel-javascript/api/excel/-slicerstylecollection-items-member)|Gets the loaded child items in this collection.| +||[setDefault(newDefaultStyle: SlicerStyle \| string)](/.slicerstylecollection#excel-javascript/api/excel/-slicerstylecollection-setdefault-member(1))|Sets the default slicer style for use in the parent object's scope.| +|[TableStyle](/.tablestyle)|[delete()](/.tablestyle#excel-javascript/api/excel/-tablestyle-delete-member(1))|Deletes the table style.| +||[duplicate()](/.tablestyle#excel-javascript/api/excel/-tablestyle-duplicate-member(1))|Creates a duplicate of this table style with copies of all the style elements.| +||[name](/.tablestyle#excel-javascript/api/excel/-tablestyle-name-member)|Specifies the name of the table style.| +||[readOnly](/.tablestyle#excel-javascript/api/excel/-tablestyle-readonly-member)|Specifies if this `TableStyle` object is read-only.| +|[TableStyleCollection](/.tablestylecollection)|[add(name: string, makeUniqueName?: boolean)](/.tablestylecollection#excel-javascript/api/excel/-tablestylecollection-add-member(1))|Creates a blank `TableStyle` with the specified name.| +||[getCount()](/.tablestylecollection#excel-javascript/api/excel/-tablestylecollection-getcount-member(1))|Gets the number of table styles in the collection.| +||[getDefault()](/.tablestylecollection#excel-javascript/api/excel/-tablestylecollection-getdefault-member(1))|Gets the default table style for the parent object's scope.| +||[getItem(name: string)](/.tablestylecollection#excel-javascript/api/excel/-tablestylecollection-getitem-member(1))|Gets a `TableStyle` by name.| +||[getItemOrNullObject(name: string)](/.tablestylecollection#excel-javascript/api/excel/-tablestylecollection-getitemornullobject-member(1))|Gets a `TableStyle` by name.| +||[items](/.tablestylecollection#excel-javascript/api/excel/-tablestylecollection-items-member)|Gets the loaded child items in this collection.| +||[setDefault(newDefaultStyle: TableStyle \| string)](/.tablestylecollection#excel-javascript/api/excel/-tablestylecollection-setdefault-member(1))|Sets the default table style for use in the parent object's scope.| +|[TimelineStyle](/.timelinestyle)|[delete()](/.timelinestyle#excel-javascript/api/excel/-timelinestyle-delete-member(1))|Deletes the table style.| +||[duplicate()](/.timelinestyle#excel-javascript/api/excel/-timelinestyle-duplicate-member(1))|Creates a duplicate of this timeline style with copies of all the style elements.| +||[name](/.timelinestyle#excel-javascript/api/excel/-timelinestyle-name-member)|Specifies the name of the timeline style.| +||[readOnly](/.timelinestyle#excel-javascript/api/excel/-timelinestyle-readonly-member)|Specifies if this `TimelineStyle` object is read-only.| +|[TimelineStyleCollection](/.timelinestylecollection)|[add(name: string, makeUniqueName?: boolean)](/.timelinestylecollection#excel-javascript/api/excel/-timelinestylecollection-add-member(1))|Creates a blank `TimelineStyle` with the specified name.| +||[getCount()](/.timelinestylecollection#excel-javascript/api/excel/-timelinestylecollection-getcount-member(1))|Gets the number of timeline styles in the collection.| +||[getDefault()](/.timelinestylecollection#excel-javascript/api/excel/-timelinestylecollection-getdefault-member(1))|Gets the default timeline style for the parent object's scope.| +||[getItem(name: string)](/.timelinestylecollection#excel-javascript/api/excel/-timelinestylecollection-getitem-member(1))|Gets a `TimelineStyle` by name.| +||[getItemOrNullObject(name: string)](/.timelinestylecollection#excel-javascript/api/excel/-timelinestylecollection-getitemornullobject-member(1))|Gets a `TimelineStyle` by name.| +||[items](/.timelinestylecollection#excel-javascript/api/excel/-timelinestylecollection-items-member)|Gets the loaded child items in this collection.| +||[setDefault(newDefaultStyle: TimelineStyle \| string)](/.timelinestylecollection#excel-javascript/api/excel/-timelinestylecollection-setdefault-member(1))|Sets the default timeline style for use in the parent object's scope.| +|[Workbook](/.workbook)|[comments](/.workbook#excel-javascript/api/excel/-workbook-comments-member)|Represents a collection of comments associated with the workbook.| +||[getActiveSlicer()](/.workbook#excel-javascript/api/excel/-workbook-getactiveslicer-member(1))|Gets the currently active slicer in the workbook.| +||[getActiveSlicerOrNullObject()](/.workbook#excel-javascript/api/excel/-workbook-getactiveslicerornullobject-member(1))|Gets the currently active slicer in the workbook.| +||[pivotTableStyles](/.workbook#excel-javascript/api/excel/-workbook-pivottablestyles-member)|Represents a collection of PivotTableStyles associated with the workbook.| +||[slicerStyles](/.workbook#excel-javascript/api/excel/-workbook-slicerstyles-member)|Represents a collection of SlicerStyles associated with the workbook.| +||[slicers](/.workbook#excel-javascript/api/excel/-workbook-slicers-member)|Represents a collection of slicers associated with the workbook.| +||[tableStyles](/.workbook#excel-javascript/api/excel/-workbook-tablestyles-member)|Represents a collection of TableStyles associated with the workbook.| +||[timelineStyles](/.workbook#excel-javascript/api/excel/-workbook-timelinestyles-member)|Represents a collection of TimelineStyles associated with the workbook.| +|[Worksheet](/.worksheet)|[comments](/.worksheet#excel-javascript/api/excel/-worksheet-comments-member)|Returns a collection of all the Comments objects on the worksheet.| +||[onColumnSorted](/.worksheet#excel-javascript/api/excel/-worksheet-oncolumnsorted-member)|Occurs when one or more columns have been sorted.| +||[onRowSorted](/.worksheet#excel-javascript/api/excel/-worksheet-onrowsorted-member)|Occurs when one or more rows have been sorted.| +||[onSingleClicked](/.worksheet#excel-javascript/api/excel/-worksheet-onsingleclicked-member)|Occurs when a left-clicked/tapped action happens in the worksheet.| +||[showOutlineLevels(rowLevels: number, columnLevels: number)](/.worksheet#excel-javascript/api/excel/-worksheet-showoutlinelevels-member(1))|Shows row or column groups by their outline levels.| +||[slicers](/.worksheet#excel-javascript/api/excel/-worksheet-slicers-member)|Returns a collection of slicers that are part of the worksheet.| +|[WorksheetCollection](/.worksheetcollection)|[onColumnSorted](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-oncolumnsorted-member)|Occurs when one or more columns have been sorted.| +||[onRowSorted](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-onrowsorted-member)|Occurs when one or more rows have been sorted.| +||[onSingleClicked](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-onsingleclicked-member)|Occurs when left-clicked/tapped operation happens in the worksheet collection.| +|[WorksheetColumnSortedEventArgs](/.worksheetcolumnsortedeventargs)|[address](/.worksheetcolumnsortedeventargs#excel-javascript/api/excel/-worksheetcolumnsortedeventargs-address-member)|Gets the range address that represents the sorted areas of a specific worksheet.| +||[source](/.worksheetcolumnsortedeventargs#excel-javascript/api/excel/-worksheetcolumnsortedeventargs-source-member)|Gets the source of the event.| +||[type](/.worksheetcolumnsortedeventargs#excel-javascript/api/excel/-worksheetcolumnsortedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/.worksheetcolumnsortedeventargs#excel-javascript/api/excel/-worksheetcolumnsortedeventargs-worksheetid-member)|Gets the ID of the worksheet where the sorting happened.| +|[WorksheetRowSortedEventArgs](/.worksheetrowsortedeventargs)|[address](/.worksheetrowsortedeventargs#excel-javascript/api/excel/-worksheetrowsortedeventargs-address-member)|Gets the range address that represents the sorted areas of a specific worksheet.| +||[source](/.worksheetrowsortedeventargs#excel-javascript/api/excel/-worksheetrowsortedeventargs-source-member)|Gets the source of the event.| +||[type](/.worksheetrowsortedeventargs#excel-javascript/api/excel/-worksheetrowsortedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/.worksheetrowsortedeventargs#excel-javascript/api/excel/-worksheetrowsortedeventargs-worksheetid-member)|Gets the ID of the worksheet where the sorting happened.| +|[WorksheetSingleClickedEventArgs](/.worksheetsingleclickedeventargs)|[address](/.worksheetsingleclickedeventargs#excel-javascript/api/excel/-worksheetsingleclickedeventargs-address-member)|Gets the address that represents the cell which was left-clicked/tapped for a specific worksheet.| +||[offsetX](/.worksheetsingleclickedeventargs#excel-javascript/api/excel/-worksheetsingleclickedeventargs-offsetx-member)|The distance, in points, from the left-clicked/tapped point to the left (or right for right-to-left languages) gridline edge of the left-clicked/tapped cell.| +||[offsetY](/.worksheetsingleclickedeventargs#excel-javascript/api/excel/-worksheetsingleclickedeventargs-offsety-member)|The distance, in points, from the left-clicked/tapped point to the top gridline edge of the left-clicked/tapped cell.| +||[type](/.worksheetsingleclickedeventargs#excel-javascript/api/excel/-worksheetsingleclickedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/.worksheetsingleclickedeventargs#excel-javascript/api/excel/-worksheetsingleclickedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the cell was left-clicked/tapped.| diff --git a/docs/includes/excel-1_11.md b/docs/includes/excel-1_11.md index f8850e4d27..2e0c21cdaf 100644 --- a/docs/includes/excel-1_11.md +++ b/docs/includes/excel-1_11.md @@ -1,37 +1,37 @@ | Class | Fields | Description | |:---|:---|:---| -|[Application](/javascript/api/excel/excel.application)|[cultureInfo](/javascript/api/excel/excel.application#excel-excel-application-cultureinfo-member)|Provides information based on current system culture settings.| -||[decimalSeparator](/javascript/api/excel/excel.application#excel-excel-application-decimalseparator-member)|Gets the string used as the decimal separator for numeric values.| -||[thousandsSeparator](/javascript/api/excel/excel.application#excel-excel-application-thousandsseparator-member)|Gets the string used to separate groups of digits to the left of the decimal for numeric values.| -||[useSystemSeparators](/javascript/api/excel/excel.application#excel-excel-application-usesystemseparators-member)|Specifies if the system separators of Excel are enabled.| -|[Comment](/javascript/api/excel/excel.comment)|[mentions](/javascript/api/excel/excel.comment#excel-excel-comment-mentions-member)|Gets the entities (e.g., people) that are mentioned in comments.| -||[resolved](/javascript/api/excel/excel.comment#excel-excel-comment-resolved-member)|The comment thread status.| -||[richContent](/javascript/api/excel/excel.comment#excel-excel-comment-richcontent-member)|Gets the rich comment content (e.g., mentions in comments).| -||[updateMentions(contentWithMentions: Excel.CommentRichContent)](/javascript/api/excel/excel.comment#excel-excel-comment-updatementions-member(1))|Updates the comment content with a specially formatted string and a list of mentions.| -|[CommentCollection](/javascript/api/excel/excel.commentcollection)|[add(cellAddress: Range \| string, content: CommentRichContent \| string, contentType?: Excel.ContentType)](/javascript/api/excel/excel.commentcollection#excel-excel-commentcollection-add-member(1))|Creates a new comment with the given content on the given cell.| -|[CommentMention](/javascript/api/excel/excel.commentmention)|[email](/javascript/api/excel/excel.commentmention#excel-excel-commentmention-email-member)|The email address of the entity that is mentioned in a comment.| -||[id](/javascript/api/excel/excel.commentmention#excel-excel-commentmention-id-member)|The ID of the entity.| -||[name](/javascript/api/excel/excel.commentmention#excel-excel-commentmention-name-member)|The name of the entity that is mentioned in a comment.| -|[CommentReply](/javascript/api/excel/excel.commentreply)|[mentions](/javascript/api/excel/excel.commentreply#excel-excel-commentreply-mentions-member)|The entities (e.g., people) that are mentioned in comments.| -||[resolved](/javascript/api/excel/excel.commentreply#excel-excel-commentreply-resolved-member)|The comment reply status.| -||[richContent](/javascript/api/excel/excel.commentreply#excel-excel-commentreply-richcontent-member)|The rich comment content (e.g., mentions in comments).| -||[updateMentions(contentWithMentions: Excel.CommentRichContent)](/javascript/api/excel/excel.commentreply#excel-excel-commentreply-updatementions-member(1))|Updates the comment content with a specially formatted string and a list of mentions.| -|[CommentReplyCollection](/javascript/api/excel/excel.commentreplycollection)|[add(content: CommentRichContent \| string, contentType?: Excel.ContentType)](/javascript/api/excel/excel.commentreplycollection#excel-excel-commentreplycollection-add-member(1))|Creates a comment reply for a comment.| -|[CommentRichContent](/javascript/api/excel/excel.commentrichcontent)|[mentions](/javascript/api/excel/excel.commentrichcontent#excel-excel-commentrichcontent-mentions-member)|An array containing all the entities (e.g., people) mentioned within the comment.| -||[richContent](/javascript/api/excel/excel.commentrichcontent#excel-excel-commentrichcontent-richcontent-member)|Specifies the rich content of the comment (e.g., comment content with mentions, the first mentioned entity has an ID attribute of 0, and the second mentioned entity has an ID attribute of 1).| -|[CultureInfo](/javascript/api/excel/excel.cultureinfo)|[name](/javascript/api/excel/excel.cultureinfo#excel-excel-cultureinfo-name-member)|Gets the culture name in the format languagecode2-country/regioncode2 (e.g., "zh-cn" or "en-us").| -||[numberFormat](/javascript/api/excel/excel.cultureinfo#excel-excel-cultureinfo-numberformat-member)|Defines the culturally appropriate format of displaying numbers.| -|[NumberFormatInfo](/javascript/api/excel/excel.numberformatinfo)|[numberDecimalSeparator](/javascript/api/excel/excel.numberformatinfo#excel-excel-numberformatinfo-numberdecimalseparator-member)|Gets the string used as the decimal separator for numeric values.| -||[numberGroupSeparator](/javascript/api/excel/excel.numberformatinfo#excel-excel-numberformatinfo-numbergroupseparator-member)|Gets the string used to separate groups of digits to the left of the decimal for numeric values.| -|[Range](/javascript/api/excel/excel.range)|[moveTo(destinationRange: Range \| string)](/javascript/api/excel/excel.range#excel-excel-range-moveto-member(1))|Moves cell values, formatting, and formulas from current range to the destination range, replacing the old information in those cells.| -|[RangeFormat](/javascript/api/excel/excel.rangeformat)|[adjustIndent(amount: number)](/javascript/api/excel/excel.rangeformat#excel-excel-rangeformat-adjustindent-member(1))|Adjusts the indentation of the range formatting.| -|[Workbook](/javascript/api/excel/excel.workbook)|[close(closeBehavior?: Excel.CloseBehavior)](/javascript/api/excel/excel.workbook#excel-excel-workbook-close-member(1))|Close current workbook.| -||[save(saveBehavior?: Excel.SaveBehavior)](/javascript/api/excel/excel.workbook#excel-excel-workbook-save-member(1))|Save current workbook.| -|[Worksheet](/javascript/api/excel/excel.worksheet)|[onRowHiddenChanged](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-onrowhiddenchanged-member)|Occurs when the hidden state of one or more rows has changed on a specific worksheet.| -|[WorksheetCalculatedEventArgs](/javascript/api/excel/excel.worksheetcalculatedeventargs)|[address](/javascript/api/excel/excel.worksheetcalculatedeventargs#excel-excel-worksheetcalculatedeventargs-address-member)|The address of the range that completed calculation.| -|[WorksheetCollection](/javascript/api/excel/excel.worksheetcollection)|[onRowHiddenChanged](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-onrowhiddenchanged-member)|Occurs when the hidden state of one or more rows has changed on a specific worksheet.| -|[WorksheetRowHiddenChangedEventArgs](/javascript/api/excel/excel.worksheetrowhiddenchangedeventargs)|[address](/javascript/api/excel/excel.worksheetrowhiddenchangedeventargs#excel-excel-worksheetrowhiddenchangedeventargs-address-member)|Gets the range address that represents the changed area of a specific worksheet.| -||[changeType](/javascript/api/excel/excel.worksheetrowhiddenchangedeventargs#excel-excel-worksheetrowhiddenchangedeventargs-changetype-member)|Gets the type of change that represents how the event was triggered.| -||[source](/javascript/api/excel/excel.worksheetrowhiddenchangedeventargs#excel-excel-worksheetrowhiddenchangedeventargs-source-member)|Gets the source of the event.| -||[type](/javascript/api/excel/excel.worksheetrowhiddenchangedeventargs#excel-excel-worksheetrowhiddenchangedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/javascript/api/excel/excel.worksheetrowhiddenchangedeventargs#excel-excel-worksheetrowhiddenchangedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the data changed.| +|[Application](/.application)|[cultureInfo](/.application#excel-javascript/api/excel/-application-cultureinfo-member)|Provides information based on current system culture settings.| +||[decimalSeparator](/.application#excel-javascript/api/excel/-application-decimalseparator-member)|Gets the string used as the decimal separator for numeric values.| +||[thousandsSeparator](/.application#excel-javascript/api/excel/-application-thousandsseparator-member)|Gets the string used to separate groups of digits to the left of the decimal for numeric values.| +||[useSystemSeparators](/.application#excel-javascript/api/excel/-application-usesystemseparators-member)|Specifies if the system separators of Excel are enabled.| +|[Comment](/.comment)|[mentions](/.comment#excel-javascript/api/excel/-comment-mentions-member)|Gets the entities (e.g., people) that are mentioned in comments.| +||[resolved](/.comment#excel-javascript/api/excel/-comment-resolved-member)|The comment thread status.| +||[richContent](/.comment#excel-javascript/api/excel/-comment-richcontent-member)|Gets the rich comment content (e.g., mentions in comments).| +||[updateMentions(contentWithMentions: Excel.CommentRichContent)](/.comment#excel-javascript/api/excel/-comment-updatementions-member(1))|Updates the comment content with a specially formatted string and a list of mentions.| +|[CommentCollection](/.commentcollection)|[add(cellAddress: Range \| string, content: CommentRichContent \| string, contentType?: Excel.ContentType)](/.commentcollection#excel-javascript/api/excel/-commentcollection-add-member(1))|Creates a new comment with the given content on the given cell.| +|[CommentMention](/.commentmention)|[email](/.commentmention#excel-javascript/api/excel/-commentmention-email-member)|The email address of the entity that is mentioned in a comment.| +||[id](/.commentmention#excel-javascript/api/excel/-commentmention-id-member)|The ID of the entity.| +||[name](/.commentmention#excel-javascript/api/excel/-commentmention-name-member)|The name of the entity that is mentioned in a comment.| +|[CommentReply](/.commentreply)|[mentions](/.commentreply#excel-javascript/api/excel/-commentreply-mentions-member)|The entities (e.g., people) that are mentioned in comments.| +||[resolved](/.commentreply#excel-javascript/api/excel/-commentreply-resolved-member)|The comment reply status.| +||[richContent](/.commentreply#excel-javascript/api/excel/-commentreply-richcontent-member)|The rich comment content (e.g., mentions in comments).| +||[updateMentions(contentWithMentions: Excel.CommentRichContent)](/.commentreply#excel-javascript/api/excel/-commentreply-updatementions-member(1))|Updates the comment content with a specially formatted string and a list of mentions.| +|[CommentReplyCollection](/.commentreplycollection)|[add(content: CommentRichContent \| string, contentType?: Excel.ContentType)](/.commentreplycollection#excel-javascript/api/excel/-commentreplycollection-add-member(1))|Creates a comment reply for a comment.| +|[CommentRichContent](/.commentrichcontent)|[mentions](/.commentrichcontent#excel-javascript/api/excel/-commentrichcontent-mentions-member)|An array containing all the entities (e.g., people) mentioned within the comment.| +||[richContent](/.commentrichcontent#excel-javascript/api/excel/-commentrichcontent-richcontent-member)|Specifies the rich content of the comment (e.g., comment content with mentions, the first mentioned entity has an ID attribute of 0, and the second mentioned entity has an ID attribute of 1).| +|[CultureInfo](/.cultureinfo)|[name](/.cultureinfo#excel-javascript/api/excel/-cultureinfo-name-member)|Gets the culture name in the format languagecode2-country/regioncode2 (e.g., "zh-cn" or "en-us").| +||[numberFormat](/.cultureinfo#excel-javascript/api/excel/-cultureinfo-numberformat-member)|Defines the culturally appropriate format of displaying numbers.| +|[NumberFormatInfo](/.numberformatinfo)|[numberDecimalSeparator](/.numberformatinfo#excel-javascript/api/excel/-numberformatinfo-numberdecimalseparator-member)|Gets the string used as the decimal separator for numeric values.| +||[numberGroupSeparator](/.numberformatinfo#excel-javascript/api/excel/-numberformatinfo-numbergroupseparator-member)|Gets the string used to separate groups of digits to the left of the decimal for numeric values.| +|[Range](/.range)|[moveTo(destinationRange: Range \| string)](/.range#excel-javascript/api/excel/-range-moveto-member(1))|Moves cell values, formatting, and formulas from current range to the destination range, replacing the old information in those cells.| +|[RangeFormat](/.rangeformat)|[adjustIndent(amount: number)](/.rangeformat#excel-javascript/api/excel/-rangeformat-adjustindent-member(1))|Adjusts the indentation of the range formatting.| +|[Workbook](/.workbook)|[close(closeBehavior?: Excel.CloseBehavior)](/.workbook#excel-javascript/api/excel/-workbook-close-member(1))|Close current workbook.| +||[save(saveBehavior?: Excel.SaveBehavior)](/.workbook#excel-javascript/api/excel/-workbook-save-member(1))|Save current workbook.| +|[Worksheet](/.worksheet)|[onRowHiddenChanged](/.worksheet#excel-javascript/api/excel/-worksheet-onrowhiddenchanged-member)|Occurs when the hidden state of one or more rows has changed on a specific worksheet.| +|[WorksheetCalculatedEventArgs](/.worksheetcalculatedeventargs)|[address](/.worksheetcalculatedeventargs#excel-javascript/api/excel/-worksheetcalculatedeventargs-address-member)|The address of the range that completed calculation.| +|[WorksheetCollection](/.worksheetcollection)|[onRowHiddenChanged](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-onrowhiddenchanged-member)|Occurs when the hidden state of one or more rows has changed on a specific worksheet.| +|[WorksheetRowHiddenChangedEventArgs](/.worksheetrowhiddenchangedeventargs)|[address](/.worksheetrowhiddenchangedeventargs#excel-javascript/api/excel/-worksheetrowhiddenchangedeventargs-address-member)|Gets the range address that represents the changed area of a specific worksheet.| +||[changeType](/.worksheetrowhiddenchangedeventargs#excel-javascript/api/excel/-worksheetrowhiddenchangedeventargs-changetype-member)|Gets the type of change that represents how the event was triggered.| +||[source](/.worksheetrowhiddenchangedeventargs#excel-javascript/api/excel/-worksheetrowhiddenchangedeventargs-source-member)|Gets the source of the event.| +||[type](/.worksheetrowhiddenchangedeventargs#excel-javascript/api/excel/-worksheetrowhiddenchangedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/.worksheetrowhiddenchangedeventargs#excel-javascript/api/excel/-worksheetrowhiddenchangedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the data changed.| diff --git a/docs/includes/excel-1_12.md b/docs/includes/excel-1_12.md index 14790a9d21..826efd2c89 100644 --- a/docs/includes/excel-1_12.md +++ b/docs/includes/excel-1_12.md @@ -1,92 +1,92 @@ | Class | Fields | Description | |:---|:---|:---| -|[ChartAxisTitle](/javascript/api/excel/excel.chartaxistitle)|[textOrientation](/javascript/api/excel/excel.chartaxistitle#excel-excel-chartaxistitle-textorientation-member)|Specifies the angle to which the text is oriented for the chart axis title.| -|[ChartSeries](/javascript/api/excel/excel.chartseries)|[getDimensionValues(dimension: Excel.ChartSeriesDimension)](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-getdimensionvalues-member(1))|Gets the values from a single dimension of the chart series.| -|[Comment](/javascript/api/excel/excel.comment)|[contentType](/javascript/api/excel/excel.comment#excel-excel-comment-contenttype-member)|Gets the content type of the comment.| -|[CommentAddedEventArgs](/javascript/api/excel/excel.commentaddedeventargs)|[commentDetails](/javascript/api/excel/excel.commentaddedeventargs#excel-excel-commentaddedeventargs-commentdetails-member)|Gets the `CommentDetail` array that contains the comment ID and IDs of its related replies.| -||[source](/javascript/api/excel/excel.commentaddedeventargs#excel-excel-commentaddedeventargs-source-member)|Specifies the source of the event.| -||[type](/javascript/api/excel/excel.commentaddedeventargs#excel-excel-commentaddedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/javascript/api/excel/excel.commentaddedeventargs#excel-excel-commentaddedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the event happened.| -|[CommentChangedEventArgs](/javascript/api/excel/excel.commentchangedeventargs)|[changeType](/javascript/api/excel/excel.commentchangedeventargs#excel-excel-commentchangedeventargs-changetype-member)|Gets the change type that represents how the changed event is triggered.| -||[commentDetails](/javascript/api/excel/excel.commentchangedeventargs#excel-excel-commentchangedeventargs-commentdetails-member)|Get the `CommentDetail` array which contains the comment ID and IDs of its related replies.| -||[source](/javascript/api/excel/excel.commentchangedeventargs#excel-excel-commentchangedeventargs-source-member)|Specifies the source of the event.| -||[type](/javascript/api/excel/excel.commentchangedeventargs#excel-excel-commentchangedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/javascript/api/excel/excel.commentchangedeventargs#excel-excel-commentchangedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the event happened.| -|[CommentCollection](/javascript/api/excel/excel.commentcollection)|[onAdded](/javascript/api/excel/excel.commentcollection#excel-excel-commentcollection-onadded-member)|Occurs when the comments are added.| -||[onChanged](/javascript/api/excel/excel.commentcollection#excel-excel-commentcollection-onchanged-member)|Occurs when comments or replies in a comment collection are changed, including when replies are deleted.| -||[onDeleted](/javascript/api/excel/excel.commentcollection#excel-excel-commentcollection-ondeleted-member)|Occurs when comments are deleted in the comment collection.| -|[CommentDeletedEventArgs](/javascript/api/excel/excel.commentdeletedeventargs)|[commentDetails](/javascript/api/excel/excel.commentdeletedeventargs#excel-excel-commentdeletedeventargs-commentdetails-member)|Gets the `CommentDetail` array that contains the comment ID and IDs of its related replies.| -||[source](/javascript/api/excel/excel.commentdeletedeventargs#excel-excel-commentdeletedeventargs-source-member)|Specifies the source of the event.| -||[type](/javascript/api/excel/excel.commentdeletedeventargs#excel-excel-commentdeletedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/javascript/api/excel/excel.commentdeletedeventargs#excel-excel-commentdeletedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the event happened.| -|[CommentDetail](/javascript/api/excel/excel.commentdetail)|[commentId](/javascript/api/excel/excel.commentdetail#excel-excel-commentdetail-commentid-member)|Represents the ID of the comment.| -||[replyIds](/javascript/api/excel/excel.commentdetail#excel-excel-commentdetail-replyids-member)|Represents the IDs of the related replies that belong to the comment.| -|[CommentReply](/javascript/api/excel/excel.commentreply)|[contentType](/javascript/api/excel/excel.commentreply#excel-excel-commentreply-contenttype-member)|The content type of the reply.| -|[CultureInfo](/javascript/api/excel/excel.cultureinfo)|[datetimeFormat](/javascript/api/excel/excel.cultureinfo#excel-excel-cultureinfo-datetimeformat-member)|Defines the culturally appropriate format of displaying date and time.| -|[DatetimeFormatInfo](/javascript/api/excel/excel.datetimeformatinfo)|[dateSeparator](/javascript/api/excel/excel.datetimeformatinfo#excel-excel-datetimeformatinfo-dateseparator-member)|Gets the string used as the date separator.| -||[longDatePattern](/javascript/api/excel/excel.datetimeformatinfo#excel-excel-datetimeformatinfo-longdatepattern-member)|Gets the format string for a long date value.| -||[longTimePattern](/javascript/api/excel/excel.datetimeformatinfo#excel-excel-datetimeformatinfo-longtimepattern-member)|Gets the format string for a long time value.| -||[shortDatePattern](/javascript/api/excel/excel.datetimeformatinfo#excel-excel-datetimeformatinfo-shortdatepattern-member)|Gets the format string for a short date value.| -||[timeSeparator](/javascript/api/excel/excel.datetimeformatinfo#excel-excel-datetimeformatinfo-timeseparator-member)|Gets the string used as the time separator.| -|[PivotDateFilter](/javascript/api/excel/excel.pivotdatefilter)|[comparator](/javascript/api/excel/excel.pivotdatefilter#excel-excel-pivotdatefilter-comparator-member)|The comparator is the static value to which other values are compared.| -||[condition](/javascript/api/excel/excel.pivotdatefilter#excel-excel-pivotdatefilter-condition-member)|Specifies the condition for the filter, which defines the necessary filtering criteria.| -||[exclusive](/javascript/api/excel/excel.pivotdatefilter#excel-excel-pivotdatefilter-exclusive-member)|If `true`, filter *excludes* items that meet criteria.| -||[lowerBound](/javascript/api/excel/excel.pivotdatefilter#excel-excel-pivotdatefilter-lowerbound-member)|The lower-bound of the range for the `between` filter condition.| -||[upperBound](/javascript/api/excel/excel.pivotdatefilter#excel-excel-pivotdatefilter-upperbound-member)|The upper-bound of the range for the `between` filter condition.| -||[wholeDays](/javascript/api/excel/excel.pivotdatefilter#excel-excel-pivotdatefilter-wholedays-member)|For `equals`, `before`, `after`, and `between` filter conditions, indicates if comparisons should be made as whole days.| -|[PivotField](/javascript/api/excel/excel.pivotfield)|[applyFilter(filter: Excel.PivotFilters)](/javascript/api/excel/excel.pivotfield#excel-excel-pivotfield-applyfilter-member(1))|Sets one or more of the field's current PivotFilters and applies them to the field.| -||[clearAllFilters()](/javascript/api/excel/excel.pivotfield#excel-excel-pivotfield-clearallfilters-member(1))|Clears all criteria from all of the field's filters.| -||[clearFilter(filterType: Excel.PivotFilterType)](/javascript/api/excel/excel.pivotfield#excel-excel-pivotfield-clearfilter-member(1))|Clears all existing criteria from the field's filter of the given type (if one is currently applied).| -||[getFilters()](/javascript/api/excel/excel.pivotfield#excel-excel-pivotfield-getfilters-member(1))|Gets all filters currently applied on the field.| -||[isFiltered(filterType?: Excel.PivotFilterType)](/javascript/api/excel/excel.pivotfield#excel-excel-pivotfield-isfiltered-member(1))|Checks if there are any applied filters on the field.| -|[PivotFilters](/javascript/api/excel/excel.pivotfilters)|[dateFilter](/javascript/api/excel/excel.pivotfilters#excel-excel-pivotfilters-datefilter-member)|The PivotField's currently applied date filter.| -||[labelFilter](/javascript/api/excel/excel.pivotfilters#excel-excel-pivotfilters-labelfilter-member)|The PivotField's currently applied label filter.| -||[manualFilter](/javascript/api/excel/excel.pivotfilters#excel-excel-pivotfilters-manualfilter-member)|The PivotField's currently applied manual filter.| -||[valueFilter](/javascript/api/excel/excel.pivotfilters#excel-excel-pivotfilters-valuefilter-member)|The PivotField's currently applied value filter.| -|[PivotLabelFilter](/javascript/api/excel/excel.pivotlabelfilter)|[comparator](/javascript/api/excel/excel.pivotlabelfilter#excel-excel-pivotlabelfilter-comparator-member)|The comparator is the static value to which other values are compared.| -||[condition](/javascript/api/excel/excel.pivotlabelfilter#excel-excel-pivotlabelfilter-condition-member)|Specifies the condition for the filter, which defines the necessary filtering criteria.| -||[exclusive](/javascript/api/excel/excel.pivotlabelfilter#excel-excel-pivotlabelfilter-exclusive-member)|If `true`, filter *excludes* items that meet criteria.| -||[lowerBound](/javascript/api/excel/excel.pivotlabelfilter#excel-excel-pivotlabelfilter-lowerbound-member)|The lower-bound of the range for the `between` filter condition.| -||[substring](/javascript/api/excel/excel.pivotlabelfilter#excel-excel-pivotlabelfilter-substring-member)|The substring used for the `beginsWith`, `endsWith`, and `contains` filter conditions.| -||[upperBound](/javascript/api/excel/excel.pivotlabelfilter#excel-excel-pivotlabelfilter-upperbound-member)|The upper-bound of the range for the `between` filter condition.| -|[PivotManualFilter](/javascript/api/excel/excel.pivotmanualfilter)|[selectedItems](/javascript/api/excel/excel.pivotmanualfilter#excel-excel-pivotmanualfilter-selecteditems-member)|A list of selected items to manually filter.| -|[PivotTable](/javascript/api/excel/excel.pivottable)|[allowMultipleFiltersPerField](/javascript/api/excel/excel.pivottable#excel-excel-pivottable-allowmultiplefiltersperfield-member)|Specifies if the PivotTable allows the application of multiple PivotFilters on a given PivotField in the table.| -|[PivotTableScopedCollection](/javascript/api/excel/excel.pivottablescopedcollection)|[getCount()](/javascript/api/excel/excel.pivottablescopedcollection#excel-excel-pivottablescopedcollection-getcount-member(1))|Gets the number of PivotTables in the collection.| -||[getFirst()](/javascript/api/excel/excel.pivottablescopedcollection#excel-excel-pivottablescopedcollection-getfirst-member(1))|Gets the first PivotTable in the collection.| -||[getItem(key: string)](/javascript/api/excel/excel.pivottablescopedcollection#excel-excel-pivottablescopedcollection-getitem-member(1))|Gets a PivotTable by name.| -||[getItemOrNullObject(name: string)](/javascript/api/excel/excel.pivottablescopedcollection#excel-excel-pivottablescopedcollection-getitemornullobject-member(1))|Gets a PivotTable by name.| -||[items](/javascript/api/excel/excel.pivottablescopedcollection#excel-excel-pivottablescopedcollection-items-member)|Gets the loaded child items in this collection.| -|[PivotValueFilter](/javascript/api/excel/excel.pivotvaluefilter)|[comparator](/javascript/api/excel/excel.pivotvaluefilter#excel-excel-pivotvaluefilter-comparator-member)|The comparator is the static value to which other values are compared.| -||[condition](/javascript/api/excel/excel.pivotvaluefilter#excel-excel-pivotvaluefilter-condition-member)|Specifies the condition for the filter, which defines the necessary filtering criteria.| -||[exclusive](/javascript/api/excel/excel.pivotvaluefilter#excel-excel-pivotvaluefilter-exclusive-member)|If `true`, filter *excludes* items that meet criteria.| -||[lowerBound](/javascript/api/excel/excel.pivotvaluefilter#excel-excel-pivotvaluefilter-lowerbound-member)|The lower-bound of the range for the `between` filter condition.| -||[selectionType](/javascript/api/excel/excel.pivotvaluefilter#excel-excel-pivotvaluefilter-selectiontype-member)|Specifies if the filter is for the top/bottom N items, top/bottom N percent, or top/bottom N sum.| -||[threshold](/javascript/api/excel/excel.pivotvaluefilter#excel-excel-pivotvaluefilter-threshold-member)|The "N" threshold number of items, percent, or sum to be filtered for a top/bottom filter condition.| -||[upperBound](/javascript/api/excel/excel.pivotvaluefilter#excel-excel-pivotvaluefilter-upperbound-member)|The upper-bound of the range for the `between` filter condition.| -||[value](/javascript/api/excel/excel.pivotvaluefilter#excel-excel-pivotvaluefilter-value-member)|Name of the chosen "value" in the field by which to filter.| -|[Range](/javascript/api/excel/excel.range)|[getDirectPrecedents()](/javascript/api/excel/excel.range#excel-excel-range-getdirectprecedents-member(1))|Returns a `WorkbookRangeAreas` object that represents the range containing all the direct precedent cells of a specified range in the same worksheet or across multiple worksheets.| -||[getPivotTables(fullyContained?: boolean)](/javascript/api/excel/excel.range#excel-excel-range-getpivottables-member(1))|Gets a scoped collection of PivotTables that overlap with the range.| -||[getSpillParent()](/javascript/api/excel/excel.range#excel-excel-range-getspillparent-member(1))|Gets the range object containing the anchor cell for a cell getting spilled into.| -||[getSpillParentOrNullObject()](/javascript/api/excel/excel.range#excel-excel-range-getspillparentornullobject-member(1))|Gets the range object containing the anchor cell for the cell getting spilled into.| -||[getSpillingToRange()](/javascript/api/excel/excel.range#excel-excel-range-getspillingtorange-member(1))|Gets the range object containing the spill range when called on an anchor cell.| -||[getSpillingToRangeOrNullObject()](/javascript/api/excel/excel.range#excel-excel-range-getspillingtorangeornullobject-member(1))|Gets the range object containing the spill range when called on an anchor cell.| -||[hasSpill](/javascript/api/excel/excel.range#excel-excel-range-hasspill-member)|Represents if all cells have a spill border.| -||[numberFormatCategories](/javascript/api/excel/excel.range#excel-excel-range-numberformatcategories-member)|Represents the category of number format of each cell.| -||[savedAsArray](/javascript/api/excel/excel.range#excel-excel-range-savedasarray-member)|Represents if all the cells would be saved as an array formula.| -|[RangeAreasCollection](/javascript/api/excel/excel.rangeareascollection)|[getCount()](/javascript/api/excel/excel.rangeareascollection#excel-excel-rangeareascollection-getcount-member(1))|Gets the number of `RangeAreas` objects in this collection.| -||[getItemAt(index: number)](/javascript/api/excel/excel.rangeareascollection#excel-excel-rangeareascollection-getitemat-member(1))|Returns the `RangeAreas` object based on position in the collection.| -||[items](/javascript/api/excel/excel.rangeareascollection#excel-excel-rangeareascollection-items-member)|Gets the loaded child items in this collection.| -|[WorkbookRangeAreas](/javascript/api/excel/excel.workbookrangeareas)|[addresses](/javascript/api/excel/excel.workbookrangeareas#excel-excel-workbookrangeareas-addresses-member)|Returns an array of addresses in A1-style.| -||[areas](/javascript/api/excel/excel.workbookrangeareas#excel-excel-workbookrangeareas-areas-member)|Returns the `RangeAreasCollection` object.| -||[getRangeAreasBySheet(key: string)](/javascript/api/excel/excel.workbookrangeareas#excel-excel-workbookrangeareas-getrangeareasbysheet-member(1))|Returns the `RangeAreas` object based on worksheet ID or name in the collection.| -||[getRangeAreasOrNullObjectBySheet(key: string)](/javascript/api/excel/excel.workbookrangeareas#excel-excel-workbookrangeareas-getrangeareasornullobjectbysheet-member(1))|Returns the `RangeAreas` object based on worksheet name or ID in the collection.| -||[ranges](/javascript/api/excel/excel.workbookrangeareas#excel-excel-workbookrangeareas-ranges-member)|Returns ranges that comprise this object in a `RangeCollection` object.| -|[Worksheet](/javascript/api/excel/excel.worksheet)|[customProperties](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-customproperties-member)|Gets a collection of worksheet-level custom properties.| -|[WorksheetCustomProperty](/javascript/api/excel/excel.worksheetcustomproperty)|[delete()](/javascript/api/excel/excel.worksheetcustomproperty#excel-excel-worksheetcustomproperty-delete-member(1))|Deletes the custom property.| -||[key](/javascript/api/excel/excel.worksheetcustomproperty#excel-excel-worksheetcustomproperty-key-member)|Gets the key of the custom property.| -||[value](/javascript/api/excel/excel.worksheetcustomproperty#excel-excel-worksheetcustomproperty-value-member)|Gets or sets the value of the custom property.| -|[WorksheetCustomPropertyCollection](/javascript/api/excel/excel.worksheetcustompropertycollection)|[add(key: string, value: string)](/javascript/api/excel/excel.worksheetcustompropertycollection#excel-excel-worksheetcustompropertycollection-add-member(1))|Adds a new custom property that maps to the provided key.| -||[getCount()](/javascript/api/excel/excel.worksheetcustompropertycollection#excel-excel-worksheetcustompropertycollection-getcount-member(1))|Gets the number of custom properties on this worksheet.| -||[getItem(key: string)](/javascript/api/excel/excel.worksheetcustompropertycollection#excel-excel-worksheetcustompropertycollection-getitem-member(1))|Gets a custom property object by its key, which is case-insensitive.| -||[getItemOrNullObject(key: string)](/javascript/api/excel/excel.worksheetcustompropertycollection#excel-excel-worksheetcustompropertycollection-getitemornullobject-member(1))|Gets a custom property object by its key, which is case-insensitive.| -||[items](/javascript/api/excel/excel.worksheetcustompropertycollection#excel-excel-worksheetcustompropertycollection-items-member)|Gets the loaded child items in this collection.| +|[ChartAxisTitle](/.chartaxistitle)|[textOrientation](/.chartaxistitle#excel-javascript/api/excel/-chartaxistitle-textorientation-member)|Specifies the angle to which the text is oriented for the chart axis title.| +|[ChartSeries](/.chartseries)|[getDimensionValues(dimension: Excel.ChartSeriesDimension)](/.chartseries#excel-javascript/api/excel/-chartseries-getdimensionvalues-member(1))|Gets the values from a single dimension of the chart series.| +|[Comment](/.comment)|[contentType](/.comment#excel-javascript/api/excel/-comment-contenttype-member)|Gets the content type of the comment.| +|[CommentAddedEventArgs](/.commentaddedeventargs)|[commentDetails](/.commentaddedeventargs#excel-javascript/api/excel/-commentaddedeventargs-commentdetails-member)|Gets the `CommentDetail` array that contains the comment ID and IDs of its related replies.| +||[source](/.commentaddedeventargs#excel-javascript/api/excel/-commentaddedeventargs-source-member)|Specifies the source of the event.| +||[type](/.commentaddedeventargs#excel-javascript/api/excel/-commentaddedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/.commentaddedeventargs#excel-javascript/api/excel/-commentaddedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the event happened.| +|[CommentChangedEventArgs](/.commentchangedeventargs)|[changeType](/.commentchangedeventargs#excel-javascript/api/excel/-commentchangedeventargs-changetype-member)|Gets the change type that represents how the changed event is triggered.| +||[commentDetails](/.commentchangedeventargs#excel-javascript/api/excel/-commentchangedeventargs-commentdetails-member)|Get the `CommentDetail` array which contains the comment ID and IDs of its related replies.| +||[source](/.commentchangedeventargs#excel-javascript/api/excel/-commentchangedeventargs-source-member)|Specifies the source of the event.| +||[type](/.commentchangedeventargs#excel-javascript/api/excel/-commentchangedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/.commentchangedeventargs#excel-javascript/api/excel/-commentchangedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the event happened.| +|[CommentCollection](/.commentcollection)|[onAdded](/.commentcollection#excel-javascript/api/excel/-commentcollection-onadded-member)|Occurs when the comments are added.| +||[onChanged](/.commentcollection#excel-javascript/api/excel/-commentcollection-onchanged-member)|Occurs when comments or replies in a comment collection are changed, including when replies are deleted.| +||[onDeleted](/.commentcollection#excel-javascript/api/excel/-commentcollection-ondeleted-member)|Occurs when comments are deleted in the comment collection.| +|[CommentDeletedEventArgs](/.commentdeletedeventargs)|[commentDetails](/.commentdeletedeventargs#excel-javascript/api/excel/-commentdeletedeventargs-commentdetails-member)|Gets the `CommentDetail` array that contains the comment ID and IDs of its related replies.| +||[source](/.commentdeletedeventargs#excel-javascript/api/excel/-commentdeletedeventargs-source-member)|Specifies the source of the event.| +||[type](/.commentdeletedeventargs#excel-javascript/api/excel/-commentdeletedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/.commentdeletedeventargs#excel-javascript/api/excel/-commentdeletedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the event happened.| +|[CommentDetail](/.commentdetail)|[commentId](/.commentdetail#excel-javascript/api/excel/-commentdetail-commentid-member)|Represents the ID of the comment.| +||[replyIds](/.commentdetail#excel-javascript/api/excel/-commentdetail-replyids-member)|Represents the IDs of the related replies that belong to the comment.| +|[CommentReply](/.commentreply)|[contentType](/.commentreply#excel-javascript/api/excel/-commentreply-contenttype-member)|The content type of the reply.| +|[CultureInfo](/.cultureinfo)|[datetimeFormat](/.cultureinfo#excel-javascript/api/excel/-cultureinfo-datetimeformat-member)|Defines the culturally appropriate format of displaying date and time.| +|[DatetimeFormatInfo](/.datetimeformatinfo)|[dateSeparator](/.datetimeformatinfo#excel-javascript/api/excel/-datetimeformatinfo-dateseparator-member)|Gets the string used as the date separator.| +||[longDatePattern](/.datetimeformatinfo#excel-javascript/api/excel/-datetimeformatinfo-longdatepattern-member)|Gets the format string for a long date value.| +||[longTimePattern](/.datetimeformatinfo#excel-javascript/api/excel/-datetimeformatinfo-longtimepattern-member)|Gets the format string for a long time value.| +||[shortDatePattern](/.datetimeformatinfo#excel-javascript/api/excel/-datetimeformatinfo-shortdatepattern-member)|Gets the format string for a short date value.| +||[timeSeparator](/.datetimeformatinfo#excel-javascript/api/excel/-datetimeformatinfo-timeseparator-member)|Gets the string used as the time separator.| +|[PivotDateFilter](/.pivotdatefilter)|[comparator](/.pivotdatefilter#excel-javascript/api/excel/-pivotdatefilter-comparator-member)|The comparator is the static value to which other values are compared.| +||[condition](/.pivotdatefilter#excel-javascript/api/excel/-pivotdatefilter-condition-member)|Specifies the condition for the filter, which defines the necessary filtering criteria.| +||[exclusive](/.pivotdatefilter#excel-javascript/api/excel/-pivotdatefilter-exclusive-member)|If `true`, filter *excludes* items that meet criteria.| +||[lowerBound](/.pivotdatefilter#excel-javascript/api/excel/-pivotdatefilter-lowerbound-member)|The lower-bound of the range for the `between` filter condition.| +||[upperBound](/.pivotdatefilter#excel-javascript/api/excel/-pivotdatefilter-upperbound-member)|The upper-bound of the range for the `between` filter condition.| +||[wholeDays](/.pivotdatefilter#excel-javascript/api/excel/-pivotdatefilter-wholedays-member)|For `equals`, `before`, `after`, and `between` filter conditions, indicates if comparisons should be made as whole days.| +|[PivotField](/.pivotfield)|[applyFilter(filter: Excel.PivotFilters)](/.pivotfield#excel-javascript/api/excel/-pivotfield-applyfilter-member(1))|Sets one or more of the field's current PivotFilters and applies them to the field.| +||[clearAllFilters()](/.pivotfield#excel-javascript/api/excel/-pivotfield-clearallfilters-member(1))|Clears all criteria from all of the field's filters.| +||[clearFilter(filterType: Excel.PivotFilterType)](/.pivotfield#excel-javascript/api/excel/-pivotfield-clearfilter-member(1))|Clears all existing criteria from the field's filter of the given type (if one is currently applied).| +||[getFilters()](/.pivotfield#excel-javascript/api/excel/-pivotfield-getfilters-member(1))|Gets all filters currently applied on the field.| +||[isFiltered(filterType?: Excel.PivotFilterType)](/.pivotfield#excel-javascript/api/excel/-pivotfield-isfiltered-member(1))|Checks if there are any applied filters on the field.| +|[PivotFilters](/.pivotfilters)|[dateFilter](/.pivotfilters#excel-javascript/api/excel/-pivotfilters-datefilter-member)|The PivotField's currently applied date filter.| +||[labelFilter](/.pivotfilters#excel-javascript/api/excel/-pivotfilters-labelfilter-member)|The PivotField's currently applied label filter.| +||[manualFilter](/.pivotfilters#excel-javascript/api/excel/-pivotfilters-manualfilter-member)|The PivotField's currently applied manual filter.| +||[valueFilter](/.pivotfilters#excel-javascript/api/excel/-pivotfilters-valuefilter-member)|The PivotField's currently applied value filter.| +|[PivotLabelFilter](/.pivotlabelfilter)|[comparator](/.pivotlabelfilter#excel-javascript/api/excel/-pivotlabelfilter-comparator-member)|The comparator is the static value to which other values are compared.| +||[condition](/.pivotlabelfilter#excel-javascript/api/excel/-pivotlabelfilter-condition-member)|Specifies the condition for the filter, which defines the necessary filtering criteria.| +||[exclusive](/.pivotlabelfilter#excel-javascript/api/excel/-pivotlabelfilter-exclusive-member)|If `true`, filter *excludes* items that meet criteria.| +||[lowerBound](/.pivotlabelfilter#excel-javascript/api/excel/-pivotlabelfilter-lowerbound-member)|The lower-bound of the range for the `between` filter condition.| +||[substring](/.pivotlabelfilter#excel-javascript/api/excel/-pivotlabelfilter-substring-member)|The substring used for the `beginsWith`, `endsWith`, and `contains` filter conditions.| +||[upperBound](/.pivotlabelfilter#excel-javascript/api/excel/-pivotlabelfilter-upperbound-member)|The upper-bound of the range for the `between` filter condition.| +|[PivotManualFilter](/.pivotmanualfilter)|[selectedItems](/.pivotmanualfilter#excel-javascript/api/excel/-pivotmanualfilter-selecteditems-member)|A list of selected items to manually filter.| +|[PivotTable](/.pivottable)|[allowMultipleFiltersPerField](/.pivottable#excel-javascript/api/excel/-pivottable-allowmultiplefiltersperfield-member)|Specifies if the PivotTable allows the application of multiple PivotFilters on a given PivotField in the table.| +|[PivotTableScopedCollection](/.pivottablescopedcollection)|[getCount()](/.pivottablescopedcollection#excel-javascript/api/excel/-pivottablescopedcollection-getcount-member(1))|Gets the number of PivotTables in the collection.| +||[getFirst()](/.pivottablescopedcollection#excel-javascript/api/excel/-pivottablescopedcollection-getfirst-member(1))|Gets the first PivotTable in the collection.| +||[getItem(key: string)](/.pivottablescopedcollection#excel-javascript/api/excel/-pivottablescopedcollection-getitem-member(1))|Gets a PivotTable by name.| +||[getItemOrNullObject(name: string)](/.pivottablescopedcollection#excel-javascript/api/excel/-pivottablescopedcollection-getitemornullobject-member(1))|Gets a PivotTable by name.| +||[items](/.pivottablescopedcollection#excel-javascript/api/excel/-pivottablescopedcollection-items-member)|Gets the loaded child items in this collection.| +|[PivotValueFilter](/.pivotvaluefilter)|[comparator](/.pivotvaluefilter#excel-javascript/api/excel/-pivotvaluefilter-comparator-member)|The comparator is the static value to which other values are compared.| +||[condition](/.pivotvaluefilter#excel-javascript/api/excel/-pivotvaluefilter-condition-member)|Specifies the condition for the filter, which defines the necessary filtering criteria.| +||[exclusive](/.pivotvaluefilter#excel-javascript/api/excel/-pivotvaluefilter-exclusive-member)|If `true`, filter *excludes* items that meet criteria.| +||[lowerBound](/.pivotvaluefilter#excel-javascript/api/excel/-pivotvaluefilter-lowerbound-member)|The lower-bound of the range for the `between` filter condition.| +||[selectionType](/.pivotvaluefilter#excel-javascript/api/excel/-pivotvaluefilter-selectiontype-member)|Specifies if the filter is for the top/bottom N items, top/bottom N percent, or top/bottom N sum.| +||[threshold](/.pivotvaluefilter#excel-javascript/api/excel/-pivotvaluefilter-threshold-member)|The "N" threshold number of items, percent, or sum to be filtered for a top/bottom filter condition.| +||[upperBound](/.pivotvaluefilter#excel-javascript/api/excel/-pivotvaluefilter-upperbound-member)|The upper-bound of the range for the `between` filter condition.| +||[value](/.pivotvaluefilter#excel-javascript/api/excel/-pivotvaluefilter-value-member)|Name of the chosen "value" in the field by which to filter.| +|[Range](/.range)|[getDirectPrecedents()](/.range#excel-javascript/api/excel/-range-getdirectprecedents-member(1))|Returns a `WorkbookRangeAreas` object that represents the range containing all the direct precedent cells of a specified range in the same worksheet or across multiple worksheets.| +||[getPivotTables(fullyContained?: boolean)](/.range#excel-javascript/api/excel/-range-getpivottables-member(1))|Gets a scoped collection of PivotTables that overlap with the range.| +||[getSpillParent()](/.range#excel-javascript/api/excel/-range-getspillparent-member(1))|Gets the range object containing the anchor cell for a cell getting spilled into.| +||[getSpillParentOrNullObject()](/.range#excel-javascript/api/excel/-range-getspillparentornullobject-member(1))|Gets the range object containing the anchor cell for the cell getting spilled into.| +||[getSpillingToRange()](/.range#excel-javascript/api/excel/-range-getspillingtorange-member(1))|Gets the range object containing the spill range when called on an anchor cell.| +||[getSpillingToRangeOrNullObject()](/.range#excel-javascript/api/excel/-range-getspillingtorangeornullobject-member(1))|Gets the range object containing the spill range when called on an anchor cell.| +||[hasSpill](/.range#excel-javascript/api/excel/-range-hasspill-member)|Represents if all cells have a spill border.| +||[numberFormatCategories](/.range#excel-javascript/api/excel/-range-numberformatcategories-member)|Represents the category of number format of each cell.| +||[savedAsArray](/.range#excel-javascript/api/excel/-range-savedasarray-member)|Represents if all the cells would be saved as an array formula.| +|[RangeAreasCollection](/.rangeareascollection)|[getCount()](/.rangeareascollection#excel-javascript/api/excel/-rangeareascollection-getcount-member(1))|Gets the number of `RangeAreas` objects in this collection.| +||[getItemAt(index: number)](/.rangeareascollection#excel-javascript/api/excel/-rangeareascollection-getitemat-member(1))|Returns the `RangeAreas` object based on position in the collection.| +||[items](/.rangeareascollection#excel-javascript/api/excel/-rangeareascollection-items-member)|Gets the loaded child items in this collection.| +|[WorkbookRangeAreas](/.workbookrangeareas)|[addresses](/.workbookrangeareas#excel-javascript/api/excel/-workbookrangeareas-addresses-member)|Returns an array of addresses in A1-style.| +||[areas](/.workbookrangeareas#excel-javascript/api/excel/-workbookrangeareas-areas-member)|Returns the `RangeAreasCollection` object.| +||[getRangeAreasBySheet(key: string)](/.workbookrangeareas#excel-javascript/api/excel/-workbookrangeareas-getrangeareasbysheet-member(1))|Returns the `RangeAreas` object based on worksheet ID or name in the collection.| +||[getRangeAreasOrNullObjectBySheet(key: string)](/.workbookrangeareas#excel-javascript/api/excel/-workbookrangeareas-getrangeareasornullobjectbysheet-member(1))|Returns the `RangeAreas` object based on worksheet name or ID in the collection.| +||[ranges](/.workbookrangeareas#excel-javascript/api/excel/-workbookrangeareas-ranges-member)|Returns ranges that comprise this object in a `RangeCollection` object.| +|[Worksheet](/.worksheet)|[customProperties](/.worksheet#excel-javascript/api/excel/-worksheet-customproperties-member)|Gets a collection of worksheet-level custom properties.| +|[WorksheetCustomProperty](/.worksheetcustomproperty)|[delete()](/.worksheetcustomproperty#excel-javascript/api/excel/-worksheetcustomproperty-delete-member(1))|Deletes the custom property.| +||[key](/.worksheetcustomproperty#excel-javascript/api/excel/-worksheetcustomproperty-key-member)|Gets the key of the custom property.| +||[value](/.worksheetcustomproperty#excel-javascript/api/excel/-worksheetcustomproperty-value-member)|Gets or sets the value of the custom property.| +|[WorksheetCustomPropertyCollection](/.worksheetcustompropertycollection)|[add(key: string, value: string)](/.worksheetcustompropertycollection#excel-javascript/api/excel/-worksheetcustompropertycollection-add-member(1))|Adds a new custom property that maps to the provided key.| +||[getCount()](/.worksheetcustompropertycollection#excel-javascript/api/excel/-worksheetcustompropertycollection-getcount-member(1))|Gets the number of custom properties on this worksheet.| +||[getItem(key: string)](/.worksheetcustompropertycollection#excel-javascript/api/excel/-worksheetcustompropertycollection-getitem-member(1))|Gets a custom property object by its key, which is case-insensitive.| +||[getItemOrNullObject(key: string)](/.worksheetcustompropertycollection#excel-javascript/api/excel/-worksheetcustompropertycollection-getitemornullobject-member(1))|Gets a custom property object by its key, which is case-insensitive.| +||[items](/.worksheetcustompropertycollection#excel-javascript/api/excel/-worksheetcustompropertycollection-items-member)|Gets the loaded child items in this collection.| diff --git a/docs/includes/excel-1_13.md b/docs/includes/excel-1_13.md index f904b101b9..9d6932a571 100644 --- a/docs/includes/excel-1_13.md +++ b/docs/includes/excel-1_13.md @@ -1,29 +1,29 @@ | Class | Fields | Description | |:---|:---|:---| -|[FormulaChangedEventDetail](/javascript/api/excel/excel.formulachangedeventdetail)|[cellAddress](/javascript/api/excel/excel.formulachangedeventdetail#excel-excel-formulachangedeventdetail-celladdress-member)|The address of the cell that contains the changed formula.| -||[previousFormula](/javascript/api/excel/excel.formulachangedeventdetail#excel-excel-formulachangedeventdetail-previousformula-member)|Represents the previous formula, before it was changed.| -|[InsertWorksheetOptions](/javascript/api/excel/excel.insertworksheetoptions)|[positionType](/javascript/api/excel/excel.insertworksheetoptions#excel-excel-insertworksheetoptions-positiontype-member)|The insert position, in the current workbook, of the new worksheets.| -||[relativeTo](/javascript/api/excel/excel.insertworksheetoptions#excel-excel-insertworksheetoptions-relativeto-member)|The worksheet in the current workbook that is referenced for the `WorksheetPositionType` parameter.| -||[sheetNamesToInsert](/javascript/api/excel/excel.insertworksheetoptions#excel-excel-insertworksheetoptions-sheetnamestoinsert-member)|The names of individual worksheets to insert.| -|[PivotLayout](/javascript/api/excel/excel.pivotlayout)|[altTextDescription](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-alttextdescription-member)|The alt text description of the PivotTable.| -||[altTextTitle](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-alttexttitle-member)|The alt text title of the PivotTable.| -||[displayBlankLineAfterEachItem(display: boolean)](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-displayblanklineaftereachitem-member(1))|Sets whether or not to display a blank line after each item.| -||[emptyCellText](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-emptycelltext-member)|The text that is automatically filled into any empty cell in the PivotTable if `fillEmptyCells == true`.| -||[fillEmptyCells](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-fillemptycells-member)|Specifies whether empty cells in the PivotTable should be populated with the `emptyCellText`.| -||[repeatAllItemLabels(repeatLabels: boolean)](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-repeatallitemlabels-member(1))|Sets the "repeat all item labels" setting across all fields in the PivotTable.| -||[showFieldHeaders](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-showfieldheaders-member)|Specifies whether the PivotTable displays field headers (field captions and filter drop-downs).| -|[PivotTable](/javascript/api/excel/excel.pivottable)|[refreshOnOpen](/javascript/api/excel/excel.pivottable#excel-excel-pivottable-refreshonopen-member)|Specifies whether the PivotTable refreshes when the workbook opens.| -|[Range](/javascript/api/excel/excel.range)|[getDirectDependents()](/javascript/api/excel/excel.range#excel-excel-range-getdirectdependents-member(1))|Returns a `WorkbookRangeAreas` object that represents the range containing all the direct dependent cells of a specified range in the same worksheet or across multiple worksheets.| -||[getExtendedRange(direction: Excel.KeyboardDirection, activeCell?: Range \| string)](/javascript/api/excel/excel.range#excel-excel-range-getextendedrange-member(1))|Returns a range object that includes the current range and up to the edge of the range, based on the provided direction.| -||[getMergedAreasOrNullObject()](/javascript/api/excel/excel.range#excel-excel-range-getmergedareasornullobject-member(1))|Returns a `RangeAreas` object that represents the merged areas in this range.| -||[getRangeEdge(direction: Excel.KeyboardDirection, activeCell?: Range \| string)](/javascript/api/excel/excel.range#excel-excel-range-getrangeedge-member(1))|Returns a range object that is the edge cell of the data region that corresponds to the provided direction.| -|[Table](/javascript/api/excel/excel.table)|[resize(newRange: Range \| string)](/javascript/api/excel/excel.table#excel-excel-table-resize-member(1))|Resize the table to the new range.| -|[Workbook](/javascript/api/excel/excel.workbook)|[insertWorksheetsFromBase64(base64File: string, options?: Excel.InsertWorksheetOptions)](/javascript/api/excel/excel.workbook#excel-excel-workbook-insertworksheetsfrombase64-member(1))|Inserts the specified worksheets from a source workbook into the current workbook.| -||[onActivated](/javascript/api/excel/excel.workbook#excel-excel-workbook-onactivated-member)|Occurs when the workbook is activated.| -|[WorkbookActivatedEventArgs](/javascript/api/excel/excel.workbookactivatedeventargs)|[type](/javascript/api/excel/excel.workbookactivatedeventargs#excel-excel-workbookactivatedeventargs-type-member)|Gets the type of the event.| -|[Worksheet](/javascript/api/excel/excel.worksheet)|[onFormulaChanged](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-onformulachanged-member)|Occurs when one or more formulas are changed in this worksheet.| -|[WorksheetCollection](/javascript/api/excel/excel.worksheetcollection)|[onFormulaChanged](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-onformulachanged-member)|Occurs when one or more formulas are changed in any worksheet of this collection.| -|[WorksheetFormulaChangedEventArgs](/javascript/api/excel/excel.worksheetformulachangedeventargs)|[formulaDetails](/javascript/api/excel/excel.worksheetformulachangedeventargs#excel-excel-worksheetformulachangedeventargs-formuladetails-member)|Gets an array of `FormulaChangedEventDetail` objects, which contain the details about the all of the changed formulas.| -||[source](/javascript/api/excel/excel.worksheetformulachangedeventargs#excel-excel-worksheetformulachangedeventargs-source-member)|The source of the event.| -||[type](/javascript/api/excel/excel.worksheetformulachangedeventargs#excel-excel-worksheetformulachangedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/javascript/api/excel/excel.worksheetformulachangedeventargs#excel-excel-worksheetformulachangedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the formula changed.| +|[FormulaChangedEventDetail](/.formulachangedeventdetail)|[cellAddress](/.formulachangedeventdetail#excel-javascript/api/excel/-formulachangedeventdetail-celladdress-member)|The address of the cell that contains the changed formula.| +||[previousFormula](/.formulachangedeventdetail#excel-javascript/api/excel/-formulachangedeventdetail-previousformula-member)|Represents the previous formula, before it was changed.| +|[InsertWorksheetOptions](/.insertworksheetoptions)|[positionType](/.insertworksheetoptions#excel-javascript/api/excel/-insertworksheetoptions-positiontype-member)|The insert position, in the current workbook, of the new worksheets.| +||[relativeTo](/.insertworksheetoptions#excel-javascript/api/excel/-insertworksheetoptions-relativeto-member)|The worksheet in the current workbook that is referenced for the `WorksheetPositionType` parameter.| +||[sheetNamesToInsert](/.insertworksheetoptions#excel-javascript/api/excel/-insertworksheetoptions-sheetnamestoinsert-member)|The names of individual worksheets to insert.| +|[PivotLayout](/.pivotlayout)|[altTextDescription](/.pivotlayout#excel-javascript/api/excel/-pivotlayout-alttextdescription-member)|The alt text description of the PivotTable.| +||[altTextTitle](/.pivotlayout#excel-javascript/api/excel/-pivotlayout-alttexttitle-member)|The alt text title of the PivotTable.| +||[displayBlankLineAfterEachItem(display: boolean)](/.pivotlayout#excel-javascript/api/excel/-pivotlayout-displayblanklineaftereachitem-member(1))|Sets whether or not to display a blank line after each item.| +||[emptyCellText](/.pivotlayout#excel-javascript/api/excel/-pivotlayout-emptycelltext-member)|The text that is automatically filled into any empty cell in the PivotTable if `fillEmptyCells == true`.| +||[fillEmptyCells](/.pivotlayout#excel-javascript/api/excel/-pivotlayout-fillemptycells-member)|Specifies whether empty cells in the PivotTable should be populated with the `emptyCellText`.| +||[repeatAllItemLabels(repeatLabels: boolean)](/.pivotlayout#excel-javascript/api/excel/-pivotlayout-repeatallitemlabels-member(1))|Sets the "repeat all item labels" setting across all fields in the PivotTable.| +||[showFieldHeaders](/.pivotlayout#excel-javascript/api/excel/-pivotlayout-showfieldheaders-member)|Specifies whether the PivotTable displays field headers (field captions and filter drop-downs).| +|[PivotTable](/.pivottable)|[refreshOnOpen](/.pivottable#excel-javascript/api/excel/-pivottable-refreshonopen-member)|Specifies whether the PivotTable refreshes when the workbook opens.| +|[Range](/.range)|[getDirectDependents()](/.range#excel-javascript/api/excel/-range-getdirectdependents-member(1))|Returns a `WorkbookRangeAreas` object that represents the range containing all the direct dependent cells of a specified range in the same worksheet or across multiple worksheets.| +||[getExtendedRange(direction: Excel.KeyboardDirection, activeCell?: Range \| string)](/.range#excel-javascript/api/excel/-range-getextendedrange-member(1))|Returns a range object that includes the current range and up to the edge of the range, based on the provided direction.| +||[getMergedAreasOrNullObject()](/.range#excel-javascript/api/excel/-range-getmergedareasornullobject-member(1))|Returns a `RangeAreas` object that represents the merged areas in this range.| +||[getRangeEdge(direction: Excel.KeyboardDirection, activeCell?: Range \| string)](/.range#excel-javascript/api/excel/-range-getrangeedge-member(1))|Returns a range object that is the edge cell of the data region that corresponds to the provided direction.| +|[Table](/.table)|[resize(newRange: Range \| string)](/.table#excel-javascript/api/excel/-table-resize-member(1))|Resize the table to the new range.| +|[Workbook](/.workbook)|[insertWorksheetsFromBase64(base64File: string, options?: Excel.InsertWorksheetOptions)](/.workbook#excel-javascript/api/excel/-workbook-insertworksheetsfrombase64-member(1))|Inserts the specified worksheets from a source workbook into the current workbook.| +||[onActivated](/.workbook#excel-javascript/api/excel/-workbook-onactivated-member)|Occurs when the workbook is activated.| +|[WorkbookActivatedEventArgs](/.workbookactivatedeventargs)|[type](/.workbookactivatedeventargs#excel-javascript/api/excel/-workbookactivatedeventargs-type-member)|Gets the type of the event.| +|[Worksheet](/.worksheet)|[onFormulaChanged](/.worksheet#excel-javascript/api/excel/-worksheet-onformulachanged-member)|Occurs when one or more formulas are changed in this worksheet.| +|[WorksheetCollection](/.worksheetcollection)|[onFormulaChanged](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-onformulachanged-member)|Occurs when one or more formulas are changed in any worksheet of this collection.| +|[WorksheetFormulaChangedEventArgs](/.worksheetformulachangedeventargs)|[formulaDetails](/.worksheetformulachangedeventargs#excel-javascript/api/excel/-worksheetformulachangedeventargs-formuladetails-member)|Gets an array of `FormulaChangedEventDetail` objects, which contain the details about the all of the changed formulas.| +||[source](/.worksheetformulachangedeventargs#excel-javascript/api/excel/-worksheetformulachangedeventargs-source-member)|The source of the event.| +||[type](/.worksheetformulachangedeventargs#excel-javascript/api/excel/-worksheetformulachangedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/.worksheetformulachangedeventargs#excel-javascript/api/excel/-worksheetformulachangedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the formula changed.| diff --git a/docs/includes/excel-1_14.md b/docs/includes/excel-1_14.md index e7b098cb31..4a2bbbbd64 100644 --- a/docs/includes/excel-1_14.md +++ b/docs/includes/excel-1_14.md @@ -1,43 +1,43 @@ | Class | Fields | Description | |:---|:---|:---| -|[AutoFilter](/javascript/api/excel/excel.autofilter)|[clearColumnCriteria(columnIndex: number)](/javascript/api/excel/excel.autofilter#excel-excel-autofilter-clearcolumncriteria-member(1))|Clears the column filter criteria of the AutoFilter.| -|[ChangeDirectionState](/javascript/api/excel/excel.changedirectionstate)|[deleteShiftDirection](/javascript/api/excel/excel.changedirectionstate#excel-excel-changedirectionstate-deleteshiftdirection-member)|Represents the direction (such as up or to the left) that the remaining cells will shift when a cell or cells are deleted.| -||[insertShiftDirection](/javascript/api/excel/excel.changedirectionstate#excel-excel-changedirectionstate-insertshiftdirection-member)|Represents the direction (such as down or to the right) that the existing cells will shift when a new cell or cells are inserted.| -|[Chart](/javascript/api/excel/excel.chart)|[getDataTable()](/javascript/api/excel/excel.chart#excel-excel-chart-getdatatable-member(1))|Gets the data table on the chart.| -||[getDataTableOrNullObject()](/javascript/api/excel/excel.chart#excel-excel-chart-getdatatableornullobject-member(1))|Gets the data table on the chart.| -|[ChartDataTable](/javascript/api/excel/excel.chartdatatable)|[format](/javascript/api/excel/excel.chartdatatable#excel-excel-chartdatatable-format-member)|Represents the format of a chart data table, which includes fill, font, and border format.| -||[showHorizontalBorder](/javascript/api/excel/excel.chartdatatable#excel-excel-chartdatatable-showhorizontalborder-member)|Specifies whether to display the horizontal border of the data table.| -||[showLegendKey](/javascript/api/excel/excel.chartdatatable#excel-excel-chartdatatable-showlegendkey-member)|Specifies whether to show the legend key of the data table.| -||[showOutlineBorder](/javascript/api/excel/excel.chartdatatable#excel-excel-chartdatatable-showoutlineborder-member)|Specifies whether to display the outline border of the data table.| -||[showVerticalBorder](/javascript/api/excel/excel.chartdatatable#excel-excel-chartdatatable-showverticalborder-member)|Specifies whether to display the vertical border of the data table.| -||[visible](/javascript/api/excel/excel.chartdatatable#excel-excel-chartdatatable-visible-member)|Specifies whether to show the data table of the chart.| -|[ChartDataTableFormat](/javascript/api/excel/excel.chartdatatableformat)|[border](/javascript/api/excel/excel.chartdatatableformat#excel-excel-chartdatatableformat-border-member)|Represents the border format of chart data table, which includes color, line style, and weight.| -||[fill](/javascript/api/excel/excel.chartdatatableformat#excel-excel-chartdatatableformat-fill-member)|Represents the fill format of an object, which includes background formatting information.| -||[font](/javascript/api/excel/excel.chartdatatableformat#excel-excel-chartdatatableformat-font-member)|Represents the font attributes (such as font name, font size, and color) for the current object.| -|[CommentCollection](/javascript/api/excel/excel.commentcollection)|[getItemOrNullObject(commentId: string)](/javascript/api/excel/excel.commentcollection#excel-excel-commentcollection-getitemornullobject-member(1))|Gets a comment from the collection based on its ID.| -|[CommentReplyCollection](/javascript/api/excel/excel.commentreplycollection)|[getItemOrNullObject(commentReplyId: string)](/javascript/api/excel/excel.commentreplycollection#excel-excel-commentreplycollection-getitemornullobject-member(1))|Returns a comment reply identified by its ID.| -|[ConditionalFormatCollection](/javascript/api/excel/excel.conditionalformatcollection)|[getItemOrNullObject(id: string)](/javascript/api/excel/excel.conditionalformatcollection#excel-excel-conditionalformatcollection-getitemornullobject-member(1))|Returns a conditional format identified by its ID.| -|[GroupShapeCollection](/javascript/api/excel/excel.groupshapecollection)|[getItemOrNullObject(key: string)](/javascript/api/excel/excel.groupshapecollection#excel-excel-groupshapecollection-getitemornullobject-member(1))|Gets a shape using its name or ID.| -|[Query](/javascript/api/excel/excel.query)|[error](/javascript/api/excel/excel.query#excel-excel-query-error-member)|Gets the query error message from when the query was last refreshed.| -||[loadedTo](/javascript/api/excel/excel.query#excel-excel-query-loadedto-member)|Gets the query loaded to object type.| -||[loadedToDataModel](/javascript/api/excel/excel.query#excel-excel-query-loadedtodatamodel-member)|Specifies if the query loaded to the data model.| -||[name](/javascript/api/excel/excel.query#excel-excel-query-name-member)|Gets the name of the query.| -||[refreshDate](/javascript/api/excel/excel.query#excel-excel-query-refreshdate-member)|Gets the date and time when the query was last refreshed.| -||[rowsLoadedCount](/javascript/api/excel/excel.query#excel-excel-query-rowsloadedcount-member)|Gets the number of rows that were loaded when the query was last refreshed.| -|[QueryCollection](/javascript/api/excel/excel.querycollection)|[getCount()](/javascript/api/excel/excel.querycollection#excel-excel-querycollection-getcount-member(1))|Gets the number of queries in the workbook.| -||[getItem(key: string)](/javascript/api/excel/excel.querycollection#excel-excel-querycollection-getitem-member(1))|Gets a query from the collection based on its name.| -||[items](/javascript/api/excel/excel.querycollection#excel-excel-querycollection-items-member)|Gets the loaded child items in this collection.| -|[Range](/javascript/api/excel/excel.range)|[getPrecedents()](/javascript/api/excel/excel.range#excel-excel-range-getprecedents-member(1))|Returns a `WorkbookRangeAreas` object that represents the range containing all the precedent cells of a specified range in the same worksheet or across multiple worksheets.| -|[ShapeCollection](/javascript/api/excel/excel.shapecollection)|[getItemOrNullObject(key: string)](/javascript/api/excel/excel.shapecollection#excel-excel-shapecollection-getitemornullobject-member(1))|Gets a shape using its name or ID.| -|[StyleCollection](/javascript/api/excel/excel.stylecollection)|[getItemOrNullObject(name: string)](/javascript/api/excel/excel.stylecollection#excel-excel-stylecollection-getitemornullobject-member(1))|Gets a style by name.| -|[TableScopedCollection](/javascript/api/excel/excel.tablescopedcollection)|[getItemOrNullObject(key: string)](/javascript/api/excel/excel.tablescopedcollection#excel-excel-tablescopedcollection-getitemornullobject-member(1))|Gets a table by name or ID.| -|[Workbook](/javascript/api/excel/excel.workbook)|[queries](/javascript/api/excel/excel.workbook#excel-excel-workbook-queries-member)|Returns a collection of Power Query queries that are part of the workbook.| -|[Worksheet](/javascript/api/excel/excel.worksheet)|[onProtectionChanged](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-onprotectionchanged-member)|Occurs when the worksheet protection state is changed.| -||[tabId](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-tabid-member)|Returns a value representing this worksheet that can be read by Open Office XML.| -|[WorksheetChangedEventArgs](/javascript/api/excel/excel.worksheetchangedeventargs)|[changeDirectionState](/javascript/api/excel/excel.worksheetchangedeventargs#excel-excel-worksheetchangedeventargs-changedirectionstate-member)|Represents a change to the direction that the cells in a worksheet will shift when a cell or cells are deleted or inserted.| -||[triggerSource](/javascript/api/excel/excel.worksheetchangedeventargs#excel-excel-worksheetchangedeventargs-triggersource-member)|Represents the trigger source of the event.| -|[WorksheetCollection](/javascript/api/excel/excel.worksheetcollection)|[onProtectionChanged](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-onprotectionchanged-member)|Occurs when the worksheet protection state is changed.| -|[WorksheetProtectionChangedEventArgs](/javascript/api/excel/excel.worksheetprotectionchangedeventargs)|[isProtected](/javascript/api/excel/excel.worksheetprotectionchangedeventargs#excel-excel-worksheetprotectionchangedeventargs-isprotected-member)|Gets the current protection status of the worksheet.| -||[source](/javascript/api/excel/excel.worksheetprotectionchangedeventargs#excel-excel-worksheetprotectionchangedeventargs-source-member)|The source of the event.| -||[type](/javascript/api/excel/excel.worksheetprotectionchangedeventargs#excel-excel-worksheetprotectionchangedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/javascript/api/excel/excel.worksheetprotectionchangedeventargs#excel-excel-worksheetprotectionchangedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the protection status is changed.| +|[AutoFilter](/.autofilter)|[clearColumnCriteria(columnIndex: number)](/.autofilter#excel-javascript/api/excel/-autofilter-clearcolumncriteria-member(1))|Clears the column filter criteria of the AutoFilter.| +|[ChangeDirectionState](/.changedirectionstate)|[deleteShiftDirection](/.changedirectionstate#excel-javascript/api/excel/-changedirectionstate-deleteshiftdirection-member)|Represents the direction (such as up or to the left) that the remaining cells will shift when a cell or cells are deleted.| +||[insertShiftDirection](/.changedirectionstate#excel-javascript/api/excel/-changedirectionstate-insertshiftdirection-member)|Represents the direction (such as down or to the right) that the existing cells will shift when a new cell or cells are inserted.| +|[Chart](/.chart)|[getDataTable()](/.chart#excel-javascript/api/excel/-chart-getdatatable-member(1))|Gets the data table on the chart.| +||[getDataTableOrNullObject()](/.chart#excel-javascript/api/excel/-chart-getdatatableornullobject-member(1))|Gets the data table on the chart.| +|[ChartDataTable](/.chartdatatable)|[format](/.chartdatatable#excel-javascript/api/excel/-chartdatatable-format-member)|Represents the format of a chart data table, which includes fill, font, and border format.| +||[showHorizontalBorder](/.chartdatatable#excel-javascript/api/excel/-chartdatatable-showhorizontalborder-member)|Specifies whether to display the horizontal border of the data table.| +||[showLegendKey](/.chartdatatable#excel-javascript/api/excel/-chartdatatable-showlegendkey-member)|Specifies whether to show the legend key of the data table.| +||[showOutlineBorder](/.chartdatatable#excel-javascript/api/excel/-chartdatatable-showoutlineborder-member)|Specifies whether to display the outline border of the data table.| +||[showVerticalBorder](/.chartdatatable#excel-javascript/api/excel/-chartdatatable-showverticalborder-member)|Specifies whether to display the vertical border of the data table.| +||[visible](/.chartdatatable#excel-javascript/api/excel/-chartdatatable-visible-member)|Specifies whether to show the data table of the chart.| +|[ChartDataTableFormat](/.chartdatatableformat)|[border](/.chartdatatableformat#excel-javascript/api/excel/-chartdatatableformat-border-member)|Represents the border format of chart data table, which includes color, line style, and weight.| +||[fill](/.chartdatatableformat#excel-javascript/api/excel/-chartdatatableformat-fill-member)|Represents the fill format of an object, which includes background formatting information.| +||[font](/.chartdatatableformat#excel-javascript/api/excel/-chartdatatableformat-font-member)|Represents the font attributes (such as font name, font size, and color) for the current object.| +|[CommentCollection](/.commentcollection)|[getItemOrNullObject(commentId: string)](/.commentcollection#excel-javascript/api/excel/-commentcollection-getitemornullobject-member(1))|Gets a comment from the collection based on its ID.| +|[CommentReplyCollection](/.commentreplycollection)|[getItemOrNullObject(commentReplyId: string)](/.commentreplycollection#excel-javascript/api/excel/-commentreplycollection-getitemornullobject-member(1))|Returns a comment reply identified by its ID.| +|[ConditionalFormatCollection](/.conditionalformatcollection)|[getItemOrNullObject(id: string)](/.conditionalformatcollection#excel-javascript/api/excel/-conditionalformatcollection-getitemornullobject-member(1))|Returns a conditional format identified by its ID.| +|[GroupShapeCollection](/.groupshapecollection)|[getItemOrNullObject(key: string)](/.groupshapecollection#excel-javascript/api/excel/-groupshapecollection-getitemornullobject-member(1))|Gets a shape using its name or ID.| +|[Query](/.query)|[error](/.query#excel-javascript/api/excel/-query-error-member)|Gets the query error message from when the query was last refreshed.| +||[loadedTo](/.query#excel-javascript/api/excel/-query-loadedto-member)|Gets the query loaded to object type.| +||[loadedToDataModel](/.query#excel-javascript/api/excel/-query-loadedtodatamodel-member)|Specifies if the query loaded to the data model.| +||[name](/.query#excel-javascript/api/excel/-query-name-member)|Gets the name of the query.| +||[refreshDate](/.query#excel-javascript/api/excel/-query-refreshdate-member)|Gets the date and time when the query was last refreshed.| +||[rowsLoadedCount](/.query#excel-javascript/api/excel/-query-rowsloadedcount-member)|Gets the number of rows that were loaded when the query was last refreshed.| +|[QueryCollection](/.querycollection)|[getCount()](/.querycollection#excel-javascript/api/excel/-querycollection-getcount-member(1))|Gets the number of queries in the workbook.| +||[getItem(key: string)](/.querycollection#excel-javascript/api/excel/-querycollection-getitem-member(1))|Gets a query from the collection based on its name.| +||[items](/.querycollection#excel-javascript/api/excel/-querycollection-items-member)|Gets the loaded child items in this collection.| +|[Range](/.range)|[getPrecedents()](/.range#excel-javascript/api/excel/-range-getprecedents-member(1))|Returns a `WorkbookRangeAreas` object that represents the range containing all the precedent cells of a specified range in the same worksheet or across multiple worksheets.| +|[ShapeCollection](/.shapecollection)|[getItemOrNullObject(key: string)](/.shapecollection#excel-javascript/api/excel/-shapecollection-getitemornullobject-member(1))|Gets a shape using its name or ID.| +|[StyleCollection](/.stylecollection)|[getItemOrNullObject(name: string)](/.stylecollection#excel-javascript/api/excel/-stylecollection-getitemornullobject-member(1))|Gets a style by name.| +|[TableScopedCollection](/.tablescopedcollection)|[getItemOrNullObject(key: string)](/.tablescopedcollection#excel-javascript/api/excel/-tablescopedcollection-getitemornullobject-member(1))|Gets a table by name or ID.| +|[Workbook](/.workbook)|[queries](/.workbook#excel-javascript/api/excel/-workbook-queries-member)|Returns a collection of Power Query queries that are part of the workbook.| +|[Worksheet](/.worksheet)|[onProtectionChanged](/.worksheet#excel-javascript/api/excel/-worksheet-onprotectionchanged-member)|Occurs when the worksheet protection state is changed.| +||[tabId](/.worksheet#excel-javascript/api/excel/-worksheet-tabid-member)|Returns a value representing this worksheet that can be read by Open Office XML.| +|[WorksheetChangedEventArgs](/.worksheetchangedeventargs)|[changeDirectionState](/.worksheetchangedeventargs#excel-javascript/api/excel/-worksheetchangedeventargs-changedirectionstate-member)|Represents a change to the direction that the cells in a worksheet will shift when a cell or cells are deleted or inserted.| +||[triggerSource](/.worksheetchangedeventargs#excel-javascript/api/excel/-worksheetchangedeventargs-triggersource-member)|Represents the trigger source of the event.| +|[WorksheetCollection](/.worksheetcollection)|[onProtectionChanged](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-onprotectionchanged-member)|Occurs when the worksheet protection state is changed.| +|[WorksheetProtectionChangedEventArgs](/.worksheetprotectionchangedeventargs)|[isProtected](/.worksheetprotectionchangedeventargs#excel-javascript/api/excel/-worksheetprotectionchangedeventargs-isprotected-member)|Gets the current protection status of the worksheet.| +||[source](/.worksheetprotectionchangedeventargs#excel-javascript/api/excel/-worksheetprotectionchangedeventargs-source-member)|The source of the event.| +||[type](/.worksheetprotectionchangedeventargs#excel-javascript/api/excel/-worksheetprotectionchangedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/.worksheetprotectionchangedeventargs#excel-javascript/api/excel/-worksheetprotectionchangedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the protection status is changed.| diff --git a/docs/includes/excel-1_15.md b/docs/includes/excel-1_15.md index 70ef8c608e..741bbb0740 100644 --- a/docs/includes/excel-1_15.md +++ b/docs/includes/excel-1_15.md @@ -1,9 +1,9 @@ | Class | Fields | Description | |:---|:---|:---| -|[ChartSeries](/javascript/api/excel/excel.chartseries)|[getDimensionDataSourceString(dimension: Excel.ChartSeriesDimension)](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-getdimensiondatasourcestring-member(1))|Gets the string representation of the data source of the chart series.| -||[getDimensionDataSourceType(dimension: Excel.ChartSeriesDimension)](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-getdimensiondatasourcetype-member(1))|Gets the data source type of the chart series.| -|[PivotTable](/javascript/api/excel/excel.pivottable)|[getDataSourceString()](/javascript/api/excel/excel.pivottable#excel-excel-pivottable-getdatasourcestring-member(1))|Returns the string representation of the data source for the PivotTable.| -||[getDataSourceType()](/javascript/api/excel/excel.pivottable#excel-excel-pivottable-getdatasourcetype-member(1))|Gets the type of the data source for the PivotTable.| -|[PivotTableScopedCollection](/javascript/api/excel/excel.pivottablescopedcollection)|[getFirstOrNullObject()](/javascript/api/excel/excel.pivottablescopedcollection#excel-excel-pivottablescopedcollection-getfirstornullobject-member(1))|Gets the first PivotTable in the collection.| -|[Range](/javascript/api/excel/excel.range)|[getDependents()](/javascript/api/excel/excel.range#excel-excel-range-getdependents-member(1))|Returns a `WorkbookRangeAreas` object that represents the range containing all the dependent cells of a specified range in the same worksheet or across multiple worksheets.| -|[Shape](/javascript/api/excel/excel.shape)|[displayName](/javascript/api/excel/excel.shape#excel-excel-shape-displayname-member)|Gets the display name of the shape.| +|[ChartSeries](/.chartseries)|[getDimensionDataSourceString(dimension: Excel.ChartSeriesDimension)](/.chartseries#excel-javascript/api/excel/-chartseries-getdimensiondatasourcestring-member(1))|Gets the string representation of the data source of the chart series.| +||[getDimensionDataSourceType(dimension: Excel.ChartSeriesDimension)](/.chartseries#excel-javascript/api/excel/-chartseries-getdimensiondatasourcetype-member(1))|Gets the data source type of the chart series.| +|[PivotTable](/.pivottable)|[getDataSourceString()](/.pivottable#excel-javascript/api/excel/-pivottable-getdatasourcestring-member(1))|Returns the string representation of the data source for the PivotTable.| +||[getDataSourceType()](/.pivottable#excel-javascript/api/excel/-pivottable-getdatasourcetype-member(1))|Gets the type of the data source for the PivotTable.| +|[PivotTableScopedCollection](/.pivottablescopedcollection)|[getFirstOrNullObject()](/.pivottablescopedcollection#excel-javascript/api/excel/-pivottablescopedcollection-getfirstornullobject-member(1))|Gets the first PivotTable in the collection.| +|[Range](/.range)|[getDependents()](/.range#excel-javascript/api/excel/-range-getdependents-member(1))|Returns a `WorkbookRangeAreas` object that represents the range containing all the dependent cells of a specified range in the same worksheet or across multiple worksheets.| +|[Shape](/.shape)|[displayName](/.shape#excel-javascript/api/excel/-shape-displayname-member)|Gets the display name of the shape.| diff --git a/docs/includes/excel-1_16.md b/docs/includes/excel-1_16.md index 0fe64560f9..4d7f2ddb61 100644 --- a/docs/includes/excel-1_16.md +++ b/docs/includes/excel-1_16.md @@ -1,187 +1,187 @@ | Class | Fields | Description | |:---|:---|:---| -|[ArrayCellValue](/javascript/api/excel/excel.arraycellvalue)|[basicType](/javascript/api/excel/excel.arraycellvalue#excel-excel-arraycellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/javascript/api/excel/excel.arraycellvalue#excel-excel-arraycellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[elements](/javascript/api/excel/excel.arraycellvalue#excel-excel-arraycellvalue-elements-member)|Represents the elements of the array.| -||[referencedValues](/javascript/api/excel/excel.arraycellvalue#excel-excel-arraycellvalue-referencedvalues-member)|Represents the cell values which are referenced within `ArrayCellValue.elements`.| -||[type](/javascript/api/excel/excel.arraycellvalue#excel-excel-arraycellvalue-type-member)|Represents the type of this cell value.| -|[BlockedErrorCellValue](/javascript/api/excel/excel.blockederrorcellvalue)|[basicType](/javascript/api/excel/excel.blockederrorcellvalue#excel-excel-blockederrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/javascript/api/excel/excel.blockederrorcellvalue#excel-excel-blockederrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[errorSubType](/javascript/api/excel/excel.blockederrorcellvalue#excel-excel-blockederrorcellvalue-errorsubtype-member)|Represents the type of `BlockedErrorCellValue`.| -||[errorType](/javascript/api/excel/excel.blockederrorcellvalue#excel-excel-blockederrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| -||[type](/javascript/api/excel/excel.blockederrorcellvalue#excel-excel-blockederrorcellvalue-type-member)|Represents the type of this cell value.| -|[BooleanCellValue](/javascript/api/excel/excel.booleancellvalue)|[basicType](/javascript/api/excel/excel.booleancellvalue#excel-excel-booleancellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/javascript/api/excel/excel.booleancellvalue#excel-excel-booleancellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[type](/javascript/api/excel/excel.booleancellvalue#excel-excel-booleancellvalue-type-member)|Represents the type of this cell value.| -|[BusyErrorCellValue](/javascript/api/excel/excel.busyerrorcellvalue)|[basicType](/javascript/api/excel/excel.busyerrorcellvalue#excel-excel-busyerrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/javascript/api/excel/excel.busyerrorcellvalue#excel-excel-busyerrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[errorSubType](/javascript/api/excel/excel.busyerrorcellvalue#excel-excel-busyerrorcellvalue-errorsubtype-member)|Represents the type of `BusyErrorCellValue`.| -||[errorType](/javascript/api/excel/excel.busyerrorcellvalue#excel-excel-busyerrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| -||[type](/javascript/api/excel/excel.busyerrorcellvalue#excel-excel-busyerrorcellvalue-type-member)|Represents the type of this cell value.| -|[CalcErrorCellValue](/javascript/api/excel/excel.calcerrorcellvalue)|[basicType](/javascript/api/excel/excel.calcerrorcellvalue#excel-excel-calcerrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/javascript/api/excel/excel.calcerrorcellvalue#excel-excel-calcerrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[errorSubType](/javascript/api/excel/excel.calcerrorcellvalue#excel-excel-calcerrorcellvalue-errorsubtype-member)|Represents the type of `CalcErrorCellValue`.| -||[errorType](/javascript/api/excel/excel.calcerrorcellvalue#excel-excel-calcerrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| -||[functionName](/javascript/api/excel/excel.calcerrorcellvalue#excel-excel-calcerrorcellvalue-functionname-member)|Represents the name of the function causing the error.| -||[type](/javascript/api/excel/excel.calcerrorcellvalue#excel-excel-calcerrorcellvalue-type-member)|Represents the type of this cell value.| -|[CardLayoutListSection](/javascript/api/excel/excel.cardlayoutlistsection)|[layout](/javascript/api/excel/excel.cardlayoutlistsection#excel-excel-cardlayoutlistsection-layout-member)|Represents the type of layout for this section.| -|[CardLayoutPropertyReference](/javascript/api/excel/excel.cardlayoutpropertyreference)|[property](/javascript/api/excel/excel.cardlayoutpropertyreference#excel-excel-cardlayoutpropertyreference-property-member)|Represents the name of the property referenced by the card layout.| -|[CardLayoutSectionStandardProperties](/javascript/api/excel/excel.cardlayoutsectionstandardproperties)|[collapsed](/javascript/api/excel/excel.cardlayoutsectionstandardproperties#excel-excel-cardlayoutsectionstandardproperties-collapsed-member)|Represents whether this section of the card is initially collapsed.| -||[collapsible](/javascript/api/excel/excel.cardlayoutsectionstandardproperties#excel-excel-cardlayoutsectionstandardproperties-collapsible-member)|Represents whether this section of the card is collapsible.| -||[properties](/javascript/api/excel/excel.cardlayoutsectionstandardproperties#excel-excel-cardlayoutsectionstandardproperties-properties-member)|Represents the names of the properties in this section.| -||[title](/javascript/api/excel/excel.cardlayoutsectionstandardproperties#excel-excel-cardlayoutsectionstandardproperties-title-member)|Represents the title of this section of the card.| -|[CardLayoutStandardProperties](/javascript/api/excel/excel.cardlayoutstandardproperties)|[mainImage](/javascript/api/excel/excel.cardlayoutstandardproperties#excel-excel-cardlayoutstandardproperties-mainimage-member)|Specifies a property which will be used as the main image of the card.| -||[sections](/javascript/api/excel/excel.cardlayoutstandardproperties#excel-excel-cardlayoutstandardproperties-sections-member)|Represents the sections of the card.| -||[subTitle](/javascript/api/excel/excel.cardlayoutstandardproperties#excel-excel-cardlayoutstandardproperties-subtitle-member)|Represents a specification of which property contains the subtitle of the card.| -||[title](/javascript/api/excel/excel.cardlayoutstandardproperties#excel-excel-cardlayoutstandardproperties-title-member)|Represents the title of the card or the specification of which property contains the title of the card.| -|[CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection)|[layout](/javascript/api/excel/excel.cardlayouttablesection#excel-excel-cardlayouttablesection-layout-member)|Represents the type of layout for this section.| -|[CellValueAttributionAttributes](/javascript/api/excel/excel.cellvalueattributionattributes)|[licenseAddress](/javascript/api/excel/excel.cellvalueattributionattributes#excel-excel-cellvalueattributionattributes-licenseaddress-member)|Represents a URL to a license or source that describes how this property can be used.| -||[licenseText](/javascript/api/excel/excel.cellvalueattributionattributes#excel-excel-cellvalueattributionattributes-licensetext-member)|Represents a name for the license that governs this property.| -||[sourceAddress](/javascript/api/excel/excel.cellvalueattributionattributes#excel-excel-cellvalueattributionattributes-sourceaddress-member)|Represents a URL to the source of the `CellValue`.| -||[sourceText](/javascript/api/excel/excel.cellvalueattributionattributes#excel-excel-cellvalueattributionattributes-sourcetext-member)|Represents a name for the source of the `CellValue`.| -|[CellValueExtraProperties](/javascript/api/excel/excel.cellvalueextraproperties)|[writable](/javascript/api/excel/excel.cellvalueextraproperties#excel-excel-cellvalueextraproperties-writable-member)|Represents whether this `CellValue` will be used to overwrite a cell.| -||[writableNote](/javascript/api/excel/excel.cellvalueextraproperties#excel-excel-cellvalueextraproperties-writablenote-member)|Represents an explanation about why `CellValue.writable` is specified as false.| -|[CellValuePropertyMetadata](/javascript/api/excel/excel.cellvaluepropertymetadata)|[attribution](/javascript/api/excel/excel.cellvaluepropertymetadata#excel-excel-cellvaluepropertymetadata-attribution-member)|Represents attribution information to describe the source and license requirements for using this property.| -||[excludeFrom](/javascript/api/excel/excel.cellvaluepropertymetadata#excel-excel-cellvaluepropertymetadata-excludefrom-member)|Represents which features this property is excluded from.| -||[sublabel](/javascript/api/excel/excel.cellvaluepropertymetadata#excel-excel-cellvaluepropertymetadata-sublabel-member)|Represents the sublabel for this property shown in card view.| -|[CellValuePropertyMetadataExclusions](/javascript/api/excel/excel.cellvaluepropertymetadataexclusions)|[autoComplete](/javascript/api/excel/excel.cellvaluepropertymetadataexclusions#excel-excel-cellvaluepropertymetadataexclusions-autocomplete-member)|True represents that the property is excluded from the properties shown by auto complete.| -||[calcCompare](/javascript/api/excel/excel.cellvaluepropertymetadataexclusions#excel-excel-cellvaluepropertymetadataexclusions-calccompare-member)|True represents that the property is excluded from the properties used to compare cell values during recalc.| -||[cardView](/javascript/api/excel/excel.cellvaluepropertymetadataexclusions#excel-excel-cellvaluepropertymetadataexclusions-cardview-member)|True represents that the property is excluded from the properties shown by card view.| -||[dotNotation](/javascript/api/excel/excel.cellvaluepropertymetadataexclusions#excel-excel-cellvaluepropertymetadataexclusions-dotnotation-member)|True represents that the property is excluded from the properties which can be accessed via the FIELDVALUE function.| -|[CellValueProviderAttributes](/javascript/api/excel/excel.cellvalueproviderattributes)|[description](/javascript/api/excel/excel.cellvalueproviderattributes#excel-excel-cellvalueproviderattributes-description-member)|Represents the provider description property that is used in card view if no logo is specified.| -||[logoSourceAddress](/javascript/api/excel/excel.cellvalueproviderattributes#excel-excel-cellvalueproviderattributes-logosourceaddress-member)|Represents a URL used to download an image that will be used as a logo in card view.| -||[logoTargetAddress](/javascript/api/excel/excel.cellvalueproviderattributes#excel-excel-cellvalueproviderattributes-logotargetaddress-member)|Represents a URL that is the navigation target if the user clicks on the logo element in card view.| -|[ChangedEventDetail](/javascript/api/excel/excel.changedeventdetail)|[valueAsJsonAfter](/javascript/api/excel/excel.changedeventdetail#excel-excel-changedeventdetail-valueasjsonafter-member)|Represents the type of value after the change.| -||[valueAsJsonBefore](/javascript/api/excel/excel.changedeventdetail#excel-excel-changedeventdetail-valueasjsonbefore-member)|Represents the type of value before the change.| -|[ChartFill](/javascript/api/excel/excel.chartfill)|[getSolidColor()](/javascript/api/excel/excel.chartfill#excel-excel-chartfill-getsolidcolor-member(1))|Gets the uniform color fill formatting of a chart element.| -|[ConnectErrorCellValue](/javascript/api/excel/excel.connecterrorcellvalue)|[basicType](/javascript/api/excel/excel.connecterrorcellvalue#excel-excel-connecterrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/javascript/api/excel/excel.connecterrorcellvalue#excel-excel-connecterrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[errorSubType](/javascript/api/excel/excel.connecterrorcellvalue#excel-excel-connecterrorcellvalue-errorsubtype-member)|Represents the type of `ConnectErrorCellValue`.| -||[errorType](/javascript/api/excel/excel.connecterrorcellvalue#excel-excel-connecterrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| -||[type](/javascript/api/excel/excel.connecterrorcellvalue#excel-excel-connecterrorcellvalue-type-member)|Represents the type of this cell value.| -|[Div0ErrorCellValue](/javascript/api/excel/excel.div0errorcellvalue)|[basicType](/javascript/api/excel/excel.div0errorcellvalue#excel-excel-div0errorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/javascript/api/excel/excel.div0errorcellvalue#excel-excel-div0errorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[errorType](/javascript/api/excel/excel.div0errorcellvalue#excel-excel-div0errorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| -||[type](/javascript/api/excel/excel.div0errorcellvalue#excel-excel-div0errorcellvalue-type-member)|Represents the type of this cell value.| -|[DoubleCellValue](/javascript/api/excel/excel.doublecellvalue)|[basicType](/javascript/api/excel/excel.doublecellvalue#excel-excel-doublecellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/javascript/api/excel/excel.doublecellvalue#excel-excel-doublecellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[type](/javascript/api/excel/excel.doublecellvalue#excel-excel-doublecellvalue-type-member)|Represents the type of this cell value.| -|[EmptyCellValue](/javascript/api/excel/excel.emptycellvalue)|[basicType](/javascript/api/excel/excel.emptycellvalue#excel-excel-emptycellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/javascript/api/excel/excel.emptycellvalue#excel-excel-emptycellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[type](/javascript/api/excel/excel.emptycellvalue#excel-excel-emptycellvalue-type-member)|Represents the type of this cell value.| -|[EntityCardLayout](/javascript/api/excel/excel.entitycardlayout)|[layout](/javascript/api/excel/excel.entitycardlayout#excel-excel-entitycardlayout-layout-member)|Represents the type of this layout.| -|[EntityCellValue](/javascript/api/excel/excel.entitycellvalue)|[basicType](/javascript/api/excel/excel.entitycellvalue#excel-excel-entitycellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/javascript/api/excel/excel.entitycellvalue#excel-excel-entitycellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[layouts](/javascript/api/excel/excel.entitycellvalue#excel-excel-entitycellvalue-layouts-member)|Represents layout information for views of this entity.| -||[properties](/javascript/api/excel/excel.entitycellvalue#excel-excel-entitycellvalue-properties-member)|Represents the properties of this entity and their metadata.| -||[provider](/javascript/api/excel/excel.entitycellvalue#excel-excel-entitycellvalue-provider-member)|Represents information that describes the service that provided the data in this `EntityCellValue`.| -||[referencedValues](/javascript/api/excel/excel.entitycellvalue#excel-excel-entitycellvalue-referencedvalues-member)|Represents the cell values which are referenced within `EntityCellValue.properties`.| -||[text](/javascript/api/excel/excel.entitycellvalue#excel-excel-entitycellvalue-text-member)|Represents the text shown when a cell with this value is rendered.| -||[type](/javascript/api/excel/excel.entitycellvalue#excel-excel-entitycellvalue-type-member)|Represents the type of this cell value.| -|[EntityCompactLayout](/javascript/api/excel/excel.entitycompactlayout)|[icon](/javascript/api/excel/excel.entitycompactlayout#excel-excel-entitycompactlayout-icon-member)|Specifies the name of the icon which is used to open the card.| -|[EntityPropertyExtraProperties](/javascript/api/excel/excel.entitypropertyextraproperties)|[propertyMetadata](/javascript/api/excel/excel.entitypropertyextraproperties#excel-excel-entitypropertyextraproperties-propertymetadata-member)|Represents metadata about the property.| -|[EntityViewLayouts](/javascript/api/excel/excel.entityviewlayouts)|[card](/javascript/api/excel/excel.entityviewlayouts#excel-excel-entityviewlayouts-card-member)|Represents the layout of this entity in card view.| -||[compact](/javascript/api/excel/excel.entityviewlayouts#excel-excel-entityviewlayouts-compact-member)|Represents the layout used when there is limited space to represent the entity.| -|[ExternalErrorCellValue](/javascript/api/excel/excel.externalerrorcellvalue)|[basicType](/javascript/api/excel/excel.externalerrorcellvalue#excel-excel-externalerrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/javascript/api/excel/excel.externalerrorcellvalue#excel-excel-externalerrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[errorSubType](/javascript/api/excel/excel.externalerrorcellvalue#excel-excel-externalerrorcellvalue-errorsubtype-member)|Represents the type of `ExternalErrorCellValue`.| -||[errorType](/javascript/api/excel/excel.externalerrorcellvalue#excel-excel-externalerrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| -||[type](/javascript/api/excel/excel.externalerrorcellvalue#excel-excel-externalerrorcellvalue-type-member)|Represents the type of this cell value.| -|[FieldErrorCellValue](/javascript/api/excel/excel.fielderrorcellvalue)|[basicType](/javascript/api/excel/excel.fielderrorcellvalue#excel-excel-fielderrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/javascript/api/excel/excel.fielderrorcellvalue#excel-excel-fielderrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[errorSubType](/javascript/api/excel/excel.fielderrorcellvalue#excel-excel-fielderrorcellvalue-errorsubtype-member)|Represents the type of `FieldErrorCellValue`.| -||[errorType](/javascript/api/excel/excel.fielderrorcellvalue#excel-excel-fielderrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| -||[fieldName](/javascript/api/excel/excel.fielderrorcellvalue#excel-excel-fielderrorcellvalue-fieldname-member)|Represents the field which was not found by FIELDVALUE.| -||[type](/javascript/api/excel/excel.fielderrorcellvalue#excel-excel-fielderrorcellvalue-type-member)|Represents the type of this cell value.| -|[GettingDataErrorCellValue](/javascript/api/excel/excel.gettingdataerrorcellvalue)|[basicType](/javascript/api/excel/excel.gettingdataerrorcellvalue#excel-excel-gettingdataerrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/javascript/api/excel/excel.gettingdataerrorcellvalue#excel-excel-gettingdataerrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[errorType](/javascript/api/excel/excel.gettingdataerrorcellvalue#excel-excel-gettingdataerrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| -||[type](/javascript/api/excel/excel.gettingdataerrorcellvalue#excel-excel-gettingdataerrorcellvalue-type-member)|Represents the type of this cell value.| -|[LinkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalue)|[basicType](/javascript/api/excel/excel.linkedentitycellvalue#excel-excel-linkedentitycellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/javascript/api/excel/excel.linkedentitycellvalue#excel-excel-linkedentitycellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[id](/javascript/api/excel/excel.linkedentitycellvalue#excel-excel-linkedentitycellvalue-id-member)|Represents the service source that provided the information in this value.| -||[layouts](/javascript/api/excel/excel.linkedentitycellvalue#excel-excel-linkedentitycellvalue-layouts-member)|Represents layout information for views of this linked entity.| -||[properties](/javascript/api/excel/excel.linkedentitycellvalue#excel-excel-linkedentitycellvalue-properties-member)|Represents the properties of this linked entity and their metadata.| -||[provider](/javascript/api/excel/excel.linkedentitycellvalue#excel-excel-linkedentitycellvalue-provider-member)|Represents information that describes the service that provided data in this `LinkedEntityCellValue`.| -||[text](/javascript/api/excel/excel.linkedentitycellvalue#excel-excel-linkedentitycellvalue-text-member)|Represents the text shown when a cell with this value is rendered.| -||[type](/javascript/api/excel/excel.linkedentitycellvalue#excel-excel-linkedentitycellvalue-type-member)|Represents the type of this cell value.| -|[LinkedEntityId](/javascript/api/excel/excel.linkedentityid)|[culture](/javascript/api/excel/excel.linkedentityid#excel-excel-linkedentityid-culture-member)|Represents which language culture was used to create this `CellValue`.| -||[domainId](/javascript/api/excel/excel.linkedentityid#excel-excel-linkedentityid-domainid-member)|Represents a domain specific to a service used to create the `CellValue`.| -||[entityId](/javascript/api/excel/excel.linkedentityid#excel-excel-linkedentityid-entityid-member)|Represents an identifier specific to a service used to create the `CellValue`.| -||[serviceId](/javascript/api/excel/excel.linkedentityid#excel-excel-linkedentityid-serviceid-member)|Represents which service was used to create the `CellValue`.| -|[NameErrorCellValue](/javascript/api/excel/excel.nameerrorcellvalue)|[basicType](/javascript/api/excel/excel.nameerrorcellvalue#excel-excel-nameerrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/javascript/api/excel/excel.nameerrorcellvalue#excel-excel-nameerrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[errorType](/javascript/api/excel/excel.nameerrorcellvalue#excel-excel-nameerrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| -||[type](/javascript/api/excel/excel.nameerrorcellvalue#excel-excel-nameerrorcellvalue-type-member)|Represents the type of this cell value.| -|[NamedItem](/javascript/api/excel/excel.nameditem)|[valueAsJson](/javascript/api/excel/excel.nameditem#excel-excel-nameditem-valueasjson-member)|A JSON representation of the values in this named item.| -||[valueAsJsonLocal](/javascript/api/excel/excel.nameditem#excel-excel-nameditem-valueasjsonlocal-member)|A JSON representation of the values in this named item.| -|[NamedItemArrayValues](/javascript/api/excel/excel.nameditemarrayvalues)|[valuesAsJson](/javascript/api/excel/excel.nameditemarrayvalues#excel-excel-nameditemarrayvalues-valuesasjson-member)|A JSON representation of the values in this named item array.| -||[valuesAsJsonLocal](/javascript/api/excel/excel.nameditemarrayvalues#excel-excel-nameditemarrayvalues-valuesasjsonlocal-member)|A JSON representation of the values in this named item array.| -|[NotAvailableErrorCellValue](/javascript/api/excel/excel.notavailableerrorcellvalue)|[basicType](/javascript/api/excel/excel.notavailableerrorcellvalue#excel-excel-notavailableerrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/javascript/api/excel/excel.notavailableerrorcellvalue#excel-excel-notavailableerrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[errorType](/javascript/api/excel/excel.notavailableerrorcellvalue#excel-excel-notavailableerrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| -||[type](/javascript/api/excel/excel.notavailableerrorcellvalue#excel-excel-notavailableerrorcellvalue-type-member)|Represents the type of this cell value.| -|[NullErrorCellValue](/javascript/api/excel/excel.nullerrorcellvalue)|[basicType](/javascript/api/excel/excel.nullerrorcellvalue#excel-excel-nullerrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/javascript/api/excel/excel.nullerrorcellvalue#excel-excel-nullerrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[errorType](/javascript/api/excel/excel.nullerrorcellvalue#excel-excel-nullerrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| -||[type](/javascript/api/excel/excel.nullerrorcellvalue#excel-excel-nullerrorcellvalue-type-member)|Represents the type of this cell value.| -|[NumErrorCellValue](/javascript/api/excel/excel.numerrorcellvalue)|[basicType](/javascript/api/excel/excel.numerrorcellvalue#excel-excel-numerrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/javascript/api/excel/excel.numerrorcellvalue#excel-excel-numerrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[errorSubType](/javascript/api/excel/excel.numerrorcellvalue#excel-excel-numerrorcellvalue-errorsubtype-member)|Represents the type of `NumErrorCellValue`.| -||[errorType](/javascript/api/excel/excel.numerrorcellvalue#excel-excel-numerrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| -||[functionName](/javascript/api/excel/excel.numerrorcellvalue#excel-excel-numerrorcellvalue-functionname-member)|Represents the name of the function causing the error.| -||[type](/javascript/api/excel/excel.numerrorcellvalue#excel-excel-numerrorcellvalue-type-member)|Represents the type of this cell value.| -|[PlaceholderErrorCellValue](/javascript/api/excel/excel.placeholdererrorcellvalue)|[basicType](/javascript/api/excel/excel.placeholdererrorcellvalue#excel-excel-placeholdererrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/javascript/api/excel/excel.placeholdererrorcellvalue#excel-excel-placeholdererrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[errorType](/javascript/api/excel/excel.placeholdererrorcellvalue#excel-excel-placeholdererrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| -||[target](/javascript/api/excel/excel.placeholdererrorcellvalue#excel-excel-placeholdererrorcellvalue-target-member)|`PlaceholderErrorCellValue` is used during processing, while data is downloaded.| -||[type](/javascript/api/excel/excel.placeholdererrorcellvalue#excel-excel-placeholdererrorcellvalue-type-member)|Represents the type of this cell value.| -|[Range](/javascript/api/excel/excel.range)|[valuesAsJson](/javascript/api/excel/excel.range#excel-excel-range-valuesasjson-member)|A JSON representation of the values in the cells in this range.| -||[valuesAsJsonLocal](/javascript/api/excel/excel.range#excel-excel-range-valuesasjsonlocal-member)|A JSON representation of the values in the cells in this range.| -|[RangeView](/javascript/api/excel/excel.rangeview)|[valuesAsJson](/javascript/api/excel/excel.rangeview#excel-excel-rangeview-valuesasjson-member)|A JSON representation of the values in the cells in this range.| -||[valuesAsJsonLocal](/javascript/api/excel/excel.rangeview#excel-excel-rangeview-valuesasjsonlocal-member)|A JSON representation of the values in the cells in this range.| -|[RefErrorCellValue](/javascript/api/excel/excel.referrorcellvalue)|[basicType](/javascript/api/excel/excel.referrorcellvalue#excel-excel-referrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/javascript/api/excel/excel.referrorcellvalue#excel-excel-referrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[errorSubType](/javascript/api/excel/excel.referrorcellvalue#excel-excel-referrorcellvalue-errorsubtype-member)|Represents the type of `RefErrorCellValue`.| -||[errorType](/javascript/api/excel/excel.referrorcellvalue#excel-excel-referrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| -||[type](/javascript/api/excel/excel.referrorcellvalue#excel-excel-referrorcellvalue-type-member)|Represents the type of this cell value.| -|[ReferenceCellValue](/javascript/api/excel/excel.referencecellvalue)|[basicType](/javascript/api/excel/excel.referencecellvalue#excel-excel-referencecellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/javascript/api/excel/excel.referencecellvalue#excel-excel-referencecellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[reference](/javascript/api/excel/excel.referencecellvalue#excel-excel-referencecellvalue-reference-member)|Represents the index into the `referencedValues` properties of cell values such as `EntityCellValue` and `ArrayCellValue`.| -||[type](/javascript/api/excel/excel.referencecellvalue#excel-excel-referencecellvalue-type-member)|Represents the type of this cell value.| -|[RootReferenceCellValue](/javascript/api/excel/excel.rootreferencecellvalue)|[basicType](/javascript/api/excel/excel.rootreferencecellvalue#excel-excel-rootreferencecellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/javascript/api/excel/excel.rootreferencecellvalue#excel-excel-rootreferencecellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[type](/javascript/api/excel/excel.rootreferencecellvalue#excel-excel-rootreferencecellvalue-type-member)|Represents the type of this cell value.| -|[SpillErrorCellValue](/javascript/api/excel/excel.spillerrorcellvalue)|[basicType](/javascript/api/excel/excel.spillerrorcellvalue#excel-excel-spillerrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/javascript/api/excel/excel.spillerrorcellvalue#excel-excel-spillerrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[columnCount](/javascript/api/excel/excel.spillerrorcellvalue#excel-excel-spillerrorcellvalue-columncount-member)|Represents the number of columns that would spill if there were no #SPILL! error.| -||[errorSubType](/javascript/api/excel/excel.spillerrorcellvalue#excel-excel-spillerrorcellvalue-errorsubtype-member)|Represents the type of `SpillErrorCellValue`.| -||[errorType](/javascript/api/excel/excel.spillerrorcellvalue#excel-excel-spillerrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| -||[rowCount](/javascript/api/excel/excel.spillerrorcellvalue#excel-excel-spillerrorcellvalue-rowcount-member)|Represents the number of rows that would spill if there were no #SPILL! error.| -||[type](/javascript/api/excel/excel.spillerrorcellvalue#excel-excel-spillerrorcellvalue-type-member)|Represents the type of this cell value.| -|[StringCellValue](/javascript/api/excel/excel.stringcellvalue)|[basicType](/javascript/api/excel/excel.stringcellvalue#excel-excel-stringcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/javascript/api/excel/excel.stringcellvalue#excel-excel-stringcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[type](/javascript/api/excel/excel.stringcellvalue#excel-excel-stringcellvalue-type-member)|Represents the type of this cell value.| -|[TableColumn](/javascript/api/excel/excel.tablecolumn)|[valuesAsJson](/javascript/api/excel/excel.tablecolumn#excel-excel-tablecolumn-valuesasjson-member)|A JSON representation of the values in the cells in this table column.| -||[valuesAsJsonLocal](/javascript/api/excel/excel.tablecolumn#excel-excel-tablecolumn-valuesasjsonlocal-member)|A JSON representation of the values in the cells in this table column.| -|[TableColumnCollection](/javascript/api/excel/excel.tablecolumncollection)|[addAsJson(index?: number, values?: CellValue[][], name?: string)](/javascript/api/excel/excel.tablecolumncollection#excel-excel-tablecolumncollection-addasjson-member(1))|Adds a new column to the table.| -|[TableRow](/javascript/api/excel/excel.tablerow)|[valuesAsJson](/javascript/api/excel/excel.tablerow#excel-excel-tablerow-valuesasjson-member)|A JSON representation of the values in the cells in this table row.| -||[valuesAsJsonLocal](/javascript/api/excel/excel.tablerow#excel-excel-tablerow-valuesasjsonlocal-member)|A JSON representation of the values in the cells in this table row.| -|[TableRowCollection](/javascript/api/excel/excel.tablerowcollection)|[addAsJson(index?: number, values?: CellValue[][], alwaysInsert?: boolean)](/javascript/api/excel/excel.tablerowcollection#excel-excel-tablerowcollection-addasjson-member(1))|Adds one or more rows to the table.| -|[ValueErrorCellValue](/javascript/api/excel/excel.valueerrorcellvalue)|[basicType](/javascript/api/excel/excel.valueerrorcellvalue#excel-excel-valueerrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/javascript/api/excel/excel.valueerrorcellvalue#excel-excel-valueerrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[errorSubType](/javascript/api/excel/excel.valueerrorcellvalue#excel-excel-valueerrorcellvalue-errorsubtype-member)|Represents the type of `ValueErrorCellValue`.| -||[errorType](/javascript/api/excel/excel.valueerrorcellvalue#excel-excel-valueerrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| -||[type](/javascript/api/excel/excel.valueerrorcellvalue#excel-excel-valueerrorcellvalue-type-member)|Represents the type of this cell value.| -|[ValueTypeNotAvailableCellValue](/javascript/api/excel/excel.valuetypenotavailablecellvalue)|[basicType](/javascript/api/excel/excel.valuetypenotavailablecellvalue#excel-excel-valuetypenotavailablecellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/javascript/api/excel/excel.valuetypenotavailablecellvalue#excel-excel-valuetypenotavailablecellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[type](/javascript/api/excel/excel.valuetypenotavailablecellvalue#excel-excel-valuetypenotavailablecellvalue-type-member)|Represents the type of this cell value.| -|[WebImageCellValue](/javascript/api/excel/excel.webimagecellvalue)|[address](/javascript/api/excel/excel.webimagecellvalue#excel-excel-webimagecellvalue-address-member)|Represents the URL from which the image will be downloaded.| -||[altText](/javascript/api/excel/excel.webimagecellvalue#excel-excel-webimagecellvalue-alttext-member)|Represents the alternate text that can be used in accessibility scenarios to describe what the image represents.| -||[attribution](/javascript/api/excel/excel.webimagecellvalue#excel-excel-webimagecellvalue-attribution-member)|Represents attribution information to describe the source and license requirements for using this image.| -||[basicType](/javascript/api/excel/excel.webimagecellvalue#excel-excel-webimagecellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/javascript/api/excel/excel.webimagecellvalue#excel-excel-webimagecellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[provider](/javascript/api/excel/excel.webimagecellvalue#excel-excel-webimagecellvalue-provider-member)|Represents information that describes the entity or individual who provided the image.| -||[relatedImagesAddress](/javascript/api/excel/excel.webimagecellvalue#excel-excel-webimagecellvalue-relatedimagesaddress-member)|Represents the URL of a webpage with images that are considered related to this `WebImageCellValue`.| -||[type](/javascript/api/excel/excel.webimagecellvalue#excel-excel-webimagecellvalue-type-member)|Represents the type of this cell value.| -|[Workbook](/javascript/api/excel/excel.workbook)|[getLinkedEntityCellValue(linkedEntityCellValueId: LinkedEntityId)](/javascript/api/excel/excel.workbook#excel-excel-workbook-getlinkedentitycellvalue-member(1))|Returns a `LinkedEntityCellValue` based on the provided `LinkedEntityId`.| +|[ArrayCellValue](/.arraycellvalue)|[basicType](/.arraycellvalue#excel-javascript/api/excel/-arraycellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/.arraycellvalue#excel-javascript/api/excel/-arraycellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[elements](/.arraycellvalue#excel-javascript/api/excel/-arraycellvalue-elements-member)|Represents the elements of the array.| +||[referencedValues](/.arraycellvalue#excel-javascript/api/excel/-arraycellvalue-referencedvalues-member)|Represents the cell values which are referenced within `ArrayCellValue.elements`.| +||[type](/.arraycellvalue#excel-javascript/api/excel/-arraycellvalue-type-member)|Represents the type of this cell value.| +|[BlockedErrorCellValue](/.blockederrorcellvalue)|[basicType](/.blockederrorcellvalue#excel-javascript/api/excel/-blockederrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/.blockederrorcellvalue#excel-javascript/api/excel/-blockederrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[errorSubType](/.blockederrorcellvalue#excel-javascript/api/excel/-blockederrorcellvalue-errorsubtype-member)|Represents the type of `BlockedErrorCellValue`.| +||[errorType](/.blockederrorcellvalue#excel-javascript/api/excel/-blockederrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| +||[type](/.blockederrorcellvalue#excel-javascript/api/excel/-blockederrorcellvalue-type-member)|Represents the type of this cell value.| +|[BooleanCellValue](/.booleancellvalue)|[basicType](/.booleancellvalue#excel-javascript/api/excel/-booleancellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/.booleancellvalue#excel-javascript/api/excel/-booleancellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[type](/.booleancellvalue#excel-javascript/api/excel/-booleancellvalue-type-member)|Represents the type of this cell value.| +|[BusyErrorCellValue](/.busyerrorcellvalue)|[basicType](/.busyerrorcellvalue#excel-javascript/api/excel/-busyerrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/.busyerrorcellvalue#excel-javascript/api/excel/-busyerrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[errorSubType](/.busyerrorcellvalue#excel-javascript/api/excel/-busyerrorcellvalue-errorsubtype-member)|Represents the type of `BusyErrorCellValue`.| +||[errorType](/.busyerrorcellvalue#excel-javascript/api/excel/-busyerrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| +||[type](/.busyerrorcellvalue#excel-javascript/api/excel/-busyerrorcellvalue-type-member)|Represents the type of this cell value.| +|[CalcErrorCellValue](/.calcerrorcellvalue)|[basicType](/.calcerrorcellvalue#excel-javascript/api/excel/-calcerrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/.calcerrorcellvalue#excel-javascript/api/excel/-calcerrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[errorSubType](/.calcerrorcellvalue#excel-javascript/api/excel/-calcerrorcellvalue-errorsubtype-member)|Represents the type of `CalcErrorCellValue`.| +||[errorType](/.calcerrorcellvalue#excel-javascript/api/excel/-calcerrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| +||[functionName](/.calcerrorcellvalue#excel-javascript/api/excel/-calcerrorcellvalue-functionname-member)|Represents the name of the function causing the error.| +||[type](/.calcerrorcellvalue#excel-javascript/api/excel/-calcerrorcellvalue-type-member)|Represents the type of this cell value.| +|[CardLayoutListSection](/.cardlayoutlistsection)|[layout](/.cardlayoutlistsection#excel-javascript/api/excel/-cardlayoutlistsection-layout-member)|Represents the type of layout for this section.| +|[CardLayoutPropertyReference](/.cardlayoutpropertyreference)|[property](/.cardlayoutpropertyreference#excel-javascript/api/excel/-cardlayoutpropertyreference-property-member)|Represents the name of the property referenced by the card layout.| +|[CardLayoutSectionStandardProperties](/.cardlayoutsectionstandardproperties)|[collapsed](/.cardlayoutsectionstandardproperties#excel-javascript/api/excel/-cardlayoutsectionstandardproperties-collapsed-member)|Represents whether this section of the card is initially collapsed.| +||[collapsible](/.cardlayoutsectionstandardproperties#excel-javascript/api/excel/-cardlayoutsectionstandardproperties-collapsible-member)|Represents whether this section of the card is collapsible.| +||[properties](/.cardlayoutsectionstandardproperties#excel-javascript/api/excel/-cardlayoutsectionstandardproperties-properties-member)|Represents the names of the properties in this section.| +||[title](/.cardlayoutsectionstandardproperties#excel-javascript/api/excel/-cardlayoutsectionstandardproperties-title-member)|Represents the title of this section of the card.| +|[CardLayoutStandardProperties](/.cardlayoutstandardproperties)|[mainImage](/.cardlayoutstandardproperties#excel-javascript/api/excel/-cardlayoutstandardproperties-mainimage-member)|Specifies a property which will be used as the main image of the card.| +||[sections](/.cardlayoutstandardproperties#excel-javascript/api/excel/-cardlayoutstandardproperties-sections-member)|Represents the sections of the card.| +||[subTitle](/.cardlayoutstandardproperties#excel-javascript/api/excel/-cardlayoutstandardproperties-subtitle-member)|Represents a specification of which property contains the subtitle of the card.| +||[title](/.cardlayoutstandardproperties#excel-javascript/api/excel/-cardlayoutstandardproperties-title-member)|Represents the title of the card or the specification of which property contains the title of the card.| +|[CardLayoutTableSection](/.cardlayouttablesection)|[layout](/.cardlayouttablesection#excel-javascript/api/excel/-cardlayouttablesection-layout-member)|Represents the type of layout for this section.| +|[CellValueAttributionAttributes](/.cellvalueattributionattributes)|[licenseAddress](/.cellvalueattributionattributes#excel-javascript/api/excel/-cellvalueattributionattributes-licenseaddress-member)|Represents a URL to a license or source that describes how this property can be used.| +||[licenseText](/.cellvalueattributionattributes#excel-javascript/api/excel/-cellvalueattributionattributes-licensetext-member)|Represents a name for the license that governs this property.| +||[sourceAddress](/.cellvalueattributionattributes#excel-javascript/api/excel/-cellvalueattributionattributes-sourceaddress-member)|Represents a URL to the source of the `CellValue`.| +||[sourceText](/.cellvalueattributionattributes#excel-javascript/api/excel/-cellvalueattributionattributes-sourcetext-member)|Represents a name for the source of the `CellValue`.| +|[CellValueExtraProperties](/.cellvalueextraproperties)|[writable](/.cellvalueextraproperties#excel-javascript/api/excel/-cellvalueextraproperties-writable-member)|Represents whether this `CellValue` will be used to overwrite a cell.| +||[writableNote](/.cellvalueextraproperties#excel-javascript/api/excel/-cellvalueextraproperties-writablenote-member)|Represents an explanation about why `CellValue.writable` is specified as false.| +|[CellValuePropertyMetadata](/.cellvaluepropertymetadata)|[attribution](/.cellvaluepropertymetadata#excel-javascript/api/excel/-cellvaluepropertymetadata-attribution-member)|Represents attribution information to describe the source and license requirements for using this property.| +||[excludeFrom](/.cellvaluepropertymetadata#excel-javascript/api/excel/-cellvaluepropertymetadata-excludefrom-member)|Represents which features this property is excluded from.| +||[sublabel](/.cellvaluepropertymetadata#excel-javascript/api/excel/-cellvaluepropertymetadata-sublabel-member)|Represents the sublabel for this property shown in card view.| +|[CellValuePropertyMetadataExclusions](/.cellvaluepropertymetadataexclusions)|[autoComplete](/.cellvaluepropertymetadataexclusions#excel-javascript/api/excel/-cellvaluepropertymetadataexclusions-autocomplete-member)|True represents that the property is excluded from the properties shown by auto complete.| +||[calcCompare](/.cellvaluepropertymetadataexclusions#excel-javascript/api/excel/-cellvaluepropertymetadataexclusions-calccompare-member)|True represents that the property is excluded from the properties used to compare cell values during recalc.| +||[cardView](/.cellvaluepropertymetadataexclusions#excel-javascript/api/excel/-cellvaluepropertymetadataexclusions-cardview-member)|True represents that the property is excluded from the properties shown by card view.| +||[dotNotation](/.cellvaluepropertymetadataexclusions#excel-javascript/api/excel/-cellvaluepropertymetadataexclusions-dotnotation-member)|True represents that the property is excluded from the properties which can be accessed via the FIELDVALUE function.| +|[CellValueProviderAttributes](/.cellvalueproviderattributes)|[description](/.cellvalueproviderattributes#excel-javascript/api/excel/-cellvalueproviderattributes-description-member)|Represents the provider description property that is used in card view if no logo is specified.| +||[logoSourceAddress](/.cellvalueproviderattributes#excel-javascript/api/excel/-cellvalueproviderattributes-logosourceaddress-member)|Represents a URL used to download an image that will be used as a logo in card view.| +||[logoTargetAddress](/.cellvalueproviderattributes#excel-javascript/api/excel/-cellvalueproviderattributes-logotargetaddress-member)|Represents a URL that is the navigation target if the user clicks on the logo element in card view.| +|[ChangedEventDetail](/.changedeventdetail)|[valueAsJsonAfter](/.changedeventdetail#excel-javascript/api/excel/-changedeventdetail-valueasjsonafter-member)|Represents the type of value after the change.| +||[valueAsJsonBefore](/.changedeventdetail#excel-javascript/api/excel/-changedeventdetail-valueasjsonbefore-member)|Represents the type of value before the change.| +|[ChartFill](/.chartfill)|[getSolidColor()](/.chartfill#excel-javascript/api/excel/-chartfill-getsolidcolor-member(1))|Gets the uniform color fill formatting of a chart element.| +|[ConnectErrorCellValue](/.connecterrorcellvalue)|[basicType](/.connecterrorcellvalue#excel-javascript/api/excel/-connecterrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/.connecterrorcellvalue#excel-javascript/api/excel/-connecterrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[errorSubType](/.connecterrorcellvalue#excel-javascript/api/excel/-connecterrorcellvalue-errorsubtype-member)|Represents the type of `ConnectErrorCellValue`.| +||[errorType](/.connecterrorcellvalue#excel-javascript/api/excel/-connecterrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| +||[type](/.connecterrorcellvalue#excel-javascript/api/excel/-connecterrorcellvalue-type-member)|Represents the type of this cell value.| +|[Div0ErrorCellValue](/.div0errorcellvalue)|[basicType](/.div0errorcellvalue#excel-javascript/api/excel/-div0errorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/.div0errorcellvalue#excel-javascript/api/excel/-div0errorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[errorType](/.div0errorcellvalue#excel-javascript/api/excel/-div0errorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| +||[type](/.div0errorcellvalue#excel-javascript/api/excel/-div0errorcellvalue-type-member)|Represents the type of this cell value.| +|[DoubleCellValue](/.doublecellvalue)|[basicType](/.doublecellvalue#excel-javascript/api/excel/-doublecellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/.doublecellvalue#excel-javascript/api/excel/-doublecellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[type](/.doublecellvalue#excel-javascript/api/excel/-doublecellvalue-type-member)|Represents the type of this cell value.| +|[EmptyCellValue](/.emptycellvalue)|[basicType](/.emptycellvalue#excel-javascript/api/excel/-emptycellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/.emptycellvalue#excel-javascript/api/excel/-emptycellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[type](/.emptycellvalue#excel-javascript/api/excel/-emptycellvalue-type-member)|Represents the type of this cell value.| +|[EntityCardLayout](/.entitycardlayout)|[layout](/.entitycardlayout#excel-javascript/api/excel/-entitycardlayout-layout-member)|Represents the type of this layout.| +|[EntityCellValue](/.entitycellvalue)|[basicType](/.entitycellvalue#excel-javascript/api/excel/-entitycellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/.entitycellvalue#excel-javascript/api/excel/-entitycellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[layouts](/.entitycellvalue#excel-javascript/api/excel/-entitycellvalue-layouts-member)|Represents layout information for views of this entity.| +||[properties](/.entitycellvalue#excel-javascript/api/excel/-entitycellvalue-properties-member)|Represents the properties of this entity and their metadata.| +||[provider](/.entitycellvalue#excel-javascript/api/excel/-entitycellvalue-provider-member)|Represents information that describes the service that provided the data in this `EntityCellValue`.| +||[referencedValues](/.entitycellvalue#excel-javascript/api/excel/-entitycellvalue-referencedvalues-member)|Represents the cell values which are referenced within `EntityCellValue.properties`.| +||[text](/.entitycellvalue#excel-javascript/api/excel/-entitycellvalue-text-member)|Represents the text shown when a cell with this value is rendered.| +||[type](/.entitycellvalue#excel-javascript/api/excel/-entitycellvalue-type-member)|Represents the type of this cell value.| +|[EntityCompactLayout](/.entitycompactlayout)|[icon](/.entitycompactlayout#excel-javascript/api/excel/-entitycompactlayout-icon-member)|Specifies the name of the icon which is used to open the card.| +|[EntityPropertyExtraProperties](/.entitypropertyextraproperties)|[propertyMetadata](/.entitypropertyextraproperties#excel-javascript/api/excel/-entitypropertyextraproperties-propertymetadata-member)|Represents metadata about the property.| +|[EntityViewLayouts](/.entityviewlayouts)|[card](/.entityviewlayouts#excel-javascript/api/excel/-entityviewlayouts-card-member)|Represents the layout of this entity in card view.| +||[compact](/.entityviewlayouts#excel-javascript/api/excel/-entityviewlayouts-compact-member)|Represents the layout used when there is limited space to represent the entity.| +|[ExternalErrorCellValue](/.externalerrorcellvalue)|[basicType](/.externalerrorcellvalue#excel-javascript/api/excel/-externalerrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/.externalerrorcellvalue#excel-javascript/api/excel/-externalerrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[errorSubType](/.externalerrorcellvalue#excel-javascript/api/excel/-externalerrorcellvalue-errorsubtype-member)|Represents the type of `ExternalErrorCellValue`.| +||[errorType](/.externalerrorcellvalue#excel-javascript/api/excel/-externalerrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| +||[type](/.externalerrorcellvalue#excel-javascript/api/excel/-externalerrorcellvalue-type-member)|Represents the type of this cell value.| +|[FieldErrorCellValue](/.fielderrorcellvalue)|[basicType](/.fielderrorcellvalue#excel-javascript/api/excel/-fielderrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/.fielderrorcellvalue#excel-javascript/api/excel/-fielderrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[errorSubType](/.fielderrorcellvalue#excel-javascript/api/excel/-fielderrorcellvalue-errorsubtype-member)|Represents the type of `FieldErrorCellValue`.| +||[errorType](/.fielderrorcellvalue#excel-javascript/api/excel/-fielderrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| +||[fieldName](/.fielderrorcellvalue#excel-javascript/api/excel/-fielderrorcellvalue-fieldname-member)|Represents the field which was not found by FIELDVALUE.| +||[type](/.fielderrorcellvalue#excel-javascript/api/excel/-fielderrorcellvalue-type-member)|Represents the type of this cell value.| +|[GettingDataErrorCellValue](/.gettingdataerrorcellvalue)|[basicType](/.gettingdataerrorcellvalue#excel-javascript/api/excel/-gettingdataerrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/.gettingdataerrorcellvalue#excel-javascript/api/excel/-gettingdataerrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[errorType](/.gettingdataerrorcellvalue#excel-javascript/api/excel/-gettingdataerrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| +||[type](/.gettingdataerrorcellvalue#excel-javascript/api/excel/-gettingdataerrorcellvalue-type-member)|Represents the type of this cell value.| +|[LinkedEntityCellValue](/.linkedentitycellvalue)|[basicType](/.linkedentitycellvalue#excel-javascript/api/excel/-linkedentitycellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/.linkedentitycellvalue#excel-javascript/api/excel/-linkedentitycellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[id](/.linkedentitycellvalue#excel-javascript/api/excel/-linkedentitycellvalue-id-member)|Represents the service source that provided the information in this value.| +||[layouts](/.linkedentitycellvalue#excel-javascript/api/excel/-linkedentitycellvalue-layouts-member)|Represents layout information for views of this linked entity.| +||[properties](/.linkedentitycellvalue#excel-javascript/api/excel/-linkedentitycellvalue-properties-member)|Represents the properties of this linked entity and their metadata.| +||[provider](/.linkedentitycellvalue#excel-javascript/api/excel/-linkedentitycellvalue-provider-member)|Represents information that describes the service that provided data in this `LinkedEntityCellValue`.| +||[text](/.linkedentitycellvalue#excel-javascript/api/excel/-linkedentitycellvalue-text-member)|Represents the text shown when a cell with this value is rendered.| +||[type](/.linkedentitycellvalue#excel-javascript/api/excel/-linkedentitycellvalue-type-member)|Represents the type of this cell value.| +|[LinkedEntityId](/.linkedentityid)|[culture](/.linkedentityid#excel-javascript/api/excel/-linkedentityid-culture-member)|Represents which language culture was used to create this `CellValue`.| +||[domainId](/.linkedentityid#excel-javascript/api/excel/-linkedentityid-domainid-member)|Represents a domain specific to a service used to create the `CellValue`.| +||[entityId](/.linkedentityid#excel-javascript/api/excel/-linkedentityid-entityid-member)|Represents an identifier specific to a service used to create the `CellValue`.| +||[serviceId](/.linkedentityid#excel-javascript/api/excel/-linkedentityid-serviceid-member)|Represents which service was used to create the `CellValue`.| +|[NameErrorCellValue](/.nameerrorcellvalue)|[basicType](/.nameerrorcellvalue#excel-javascript/api/excel/-nameerrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/.nameerrorcellvalue#excel-javascript/api/excel/-nameerrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[errorType](/.nameerrorcellvalue#excel-javascript/api/excel/-nameerrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| +||[type](/.nameerrorcellvalue#excel-javascript/api/excel/-nameerrorcellvalue-type-member)|Represents the type of this cell value.| +|[NamedItem](/.nameditem)|[valueAsJson](/.nameditem#excel-javascript/api/excel/-nameditem-valueasjson-member)|A JSON representation of the values in this named item.| +||[valueAsJsonLocal](/.nameditem#excel-javascript/api/excel/-nameditem-valueasjsonlocal-member)|A JSON representation of the values in this named item.| +|[NamedItemArrayValues](/.nameditemarrayvalues)|[valuesAsJson](/.nameditemarrayvalues#excel-javascript/api/excel/-nameditemarrayvalues-valuesasjson-member)|A JSON representation of the values in this named item array.| +||[valuesAsJsonLocal](/.nameditemarrayvalues#excel-javascript/api/excel/-nameditemarrayvalues-valuesasjsonlocal-member)|A JSON representation of the values in this named item array.| +|[NotAvailableErrorCellValue](/.notavailableerrorcellvalue)|[basicType](/.notavailableerrorcellvalue#excel-javascript/api/excel/-notavailableerrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/.notavailableerrorcellvalue#excel-javascript/api/excel/-notavailableerrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[errorType](/.notavailableerrorcellvalue#excel-javascript/api/excel/-notavailableerrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| +||[type](/.notavailableerrorcellvalue#excel-javascript/api/excel/-notavailableerrorcellvalue-type-member)|Represents the type of this cell value.| +|[NullErrorCellValue](/.nullerrorcellvalue)|[basicType](/.nullerrorcellvalue#excel-javascript/api/excel/-nullerrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/.nullerrorcellvalue#excel-javascript/api/excel/-nullerrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[errorType](/.nullerrorcellvalue#excel-javascript/api/excel/-nullerrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| +||[type](/.nullerrorcellvalue#excel-javascript/api/excel/-nullerrorcellvalue-type-member)|Represents the type of this cell value.| +|[NumErrorCellValue](/.numerrorcellvalue)|[basicType](/.numerrorcellvalue#excel-javascript/api/excel/-numerrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/.numerrorcellvalue#excel-javascript/api/excel/-numerrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[errorSubType](/.numerrorcellvalue#excel-javascript/api/excel/-numerrorcellvalue-errorsubtype-member)|Represents the type of `NumErrorCellValue`.| +||[errorType](/.numerrorcellvalue#excel-javascript/api/excel/-numerrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| +||[functionName](/.numerrorcellvalue#excel-javascript/api/excel/-numerrorcellvalue-functionname-member)|Represents the name of the function causing the error.| +||[type](/.numerrorcellvalue#excel-javascript/api/excel/-numerrorcellvalue-type-member)|Represents the type of this cell value.| +|[PlaceholderErrorCellValue](/.placeholdererrorcellvalue)|[basicType](/.placeholdererrorcellvalue#excel-javascript/api/excel/-placeholdererrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/.placeholdererrorcellvalue#excel-javascript/api/excel/-placeholdererrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[errorType](/.placeholdererrorcellvalue#excel-javascript/api/excel/-placeholdererrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| +||[target](/.placeholdererrorcellvalue#excel-javascript/api/excel/-placeholdererrorcellvalue-target-member)|`PlaceholderErrorCellValue` is used during processing, while data is downloaded.| +||[type](/.placeholdererrorcellvalue#excel-javascript/api/excel/-placeholdererrorcellvalue-type-member)|Represents the type of this cell value.| +|[Range](/.range)|[valuesAsJson](/.range#excel-javascript/api/excel/-range-valuesasjson-member)|A JSON representation of the values in the cells in this range.| +||[valuesAsJsonLocal](/.range#excel-javascript/api/excel/-range-valuesasjsonlocal-member)|A JSON representation of the values in the cells in this range.| +|[RangeView](/.rangeview)|[valuesAsJson](/.rangeview#excel-javascript/api/excel/-rangeview-valuesasjson-member)|A JSON representation of the values in the cells in this range.| +||[valuesAsJsonLocal](/.rangeview#excel-javascript/api/excel/-rangeview-valuesasjsonlocal-member)|A JSON representation of the values in the cells in this range.| +|[RefErrorCellValue](/.referrorcellvalue)|[basicType](/.referrorcellvalue#excel-javascript/api/excel/-referrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/.referrorcellvalue#excel-javascript/api/excel/-referrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[errorSubType](/.referrorcellvalue#excel-javascript/api/excel/-referrorcellvalue-errorsubtype-member)|Represents the type of `RefErrorCellValue`.| +||[errorType](/.referrorcellvalue#excel-javascript/api/excel/-referrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| +||[type](/.referrorcellvalue#excel-javascript/api/excel/-referrorcellvalue-type-member)|Represents the type of this cell value.| +|[ReferenceCellValue](/.referencecellvalue)|[basicType](/.referencecellvalue#excel-javascript/api/excel/-referencecellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/.referencecellvalue#excel-javascript/api/excel/-referencecellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[reference](/.referencecellvalue#excel-javascript/api/excel/-referencecellvalue-reference-member)|Represents the index into the `referencedValues` properties of cell values such as `EntityCellValue` and `ArrayCellValue`.| +||[type](/.referencecellvalue#excel-javascript/api/excel/-referencecellvalue-type-member)|Represents the type of this cell value.| +|[RootReferenceCellValue](/.rootreferencecellvalue)|[basicType](/.rootreferencecellvalue#excel-javascript/api/excel/-rootreferencecellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/.rootreferencecellvalue#excel-javascript/api/excel/-rootreferencecellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[type](/.rootreferencecellvalue#excel-javascript/api/excel/-rootreferencecellvalue-type-member)|Represents the type of this cell value.| +|[SpillErrorCellValue](/.spillerrorcellvalue)|[basicType](/.spillerrorcellvalue#excel-javascript/api/excel/-spillerrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/.spillerrorcellvalue#excel-javascript/api/excel/-spillerrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[columnCount](/.spillerrorcellvalue#excel-javascript/api/excel/-spillerrorcellvalue-columncount-member)|Represents the number of columns that would spill if there were no #SPILL! error.| +||[errorSubType](/.spillerrorcellvalue#excel-javascript/api/excel/-spillerrorcellvalue-errorsubtype-member)|Represents the type of `SpillErrorCellValue`.| +||[errorType](/.spillerrorcellvalue#excel-javascript/api/excel/-spillerrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| +||[rowCount](/.spillerrorcellvalue#excel-javascript/api/excel/-spillerrorcellvalue-rowcount-member)|Represents the number of rows that would spill if there were no #SPILL! error.| +||[type](/.spillerrorcellvalue#excel-javascript/api/excel/-spillerrorcellvalue-type-member)|Represents the type of this cell value.| +|[StringCellValue](/.stringcellvalue)|[basicType](/.stringcellvalue#excel-javascript/api/excel/-stringcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/.stringcellvalue#excel-javascript/api/excel/-stringcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[type](/.stringcellvalue#excel-javascript/api/excel/-stringcellvalue-type-member)|Represents the type of this cell value.| +|[TableColumn](/.tablecolumn)|[valuesAsJson](/.tablecolumn#excel-javascript/api/excel/-tablecolumn-valuesasjson-member)|A JSON representation of the values in the cells in this table column.| +||[valuesAsJsonLocal](/.tablecolumn#excel-javascript/api/excel/-tablecolumn-valuesasjsonlocal-member)|A JSON representation of the values in the cells in this table column.| +|[TableColumnCollection](/.tablecolumncollection)|[addAsJson(index?: number, values?: CellValue[][], name?: string)](/.tablecolumncollection#excel-javascript/api/excel/-tablecolumncollection-addasjson-member(1))|Adds a new column to the table.| +|[TableRow](/.tablerow)|[valuesAsJson](/.tablerow#excel-javascript/api/excel/-tablerow-valuesasjson-member)|A JSON representation of the values in the cells in this table row.| +||[valuesAsJsonLocal](/.tablerow#excel-javascript/api/excel/-tablerow-valuesasjsonlocal-member)|A JSON representation of the values in the cells in this table row.| +|[TableRowCollection](/.tablerowcollection)|[addAsJson(index?: number, values?: CellValue[][], alwaysInsert?: boolean)](/.tablerowcollection#excel-javascript/api/excel/-tablerowcollection-addasjson-member(1))|Adds one or more rows to the table.| +|[ValueErrorCellValue](/.valueerrorcellvalue)|[basicType](/.valueerrorcellvalue#excel-javascript/api/excel/-valueerrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/.valueerrorcellvalue#excel-javascript/api/excel/-valueerrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[errorSubType](/.valueerrorcellvalue#excel-javascript/api/excel/-valueerrorcellvalue-errorsubtype-member)|Represents the type of `ValueErrorCellValue`.| +||[errorType](/.valueerrorcellvalue#excel-javascript/api/excel/-valueerrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| +||[type](/.valueerrorcellvalue#excel-javascript/api/excel/-valueerrorcellvalue-type-member)|Represents the type of this cell value.| +|[ValueTypeNotAvailableCellValue](/.valuetypenotavailablecellvalue)|[basicType](/.valuetypenotavailablecellvalue#excel-javascript/api/excel/-valuetypenotavailablecellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/.valuetypenotavailablecellvalue#excel-javascript/api/excel/-valuetypenotavailablecellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[type](/.valuetypenotavailablecellvalue#excel-javascript/api/excel/-valuetypenotavailablecellvalue-type-member)|Represents the type of this cell value.| +|[WebImageCellValue](/.webimagecellvalue)|[address](/.webimagecellvalue#excel-javascript/api/excel/-webimagecellvalue-address-member)|Represents the URL from which the image will be downloaded.| +||[altText](/.webimagecellvalue#excel-javascript/api/excel/-webimagecellvalue-alttext-member)|Represents the alternate text that can be used in accessibility scenarios to describe what the image represents.| +||[attribution](/.webimagecellvalue#excel-javascript/api/excel/-webimagecellvalue-attribution-member)|Represents attribution information to describe the source and license requirements for using this image.| +||[basicType](/.webimagecellvalue#excel-javascript/api/excel/-webimagecellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/.webimagecellvalue#excel-javascript/api/excel/-webimagecellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[provider](/.webimagecellvalue#excel-javascript/api/excel/-webimagecellvalue-provider-member)|Represents information that describes the entity or individual who provided the image.| +||[relatedImagesAddress](/.webimagecellvalue#excel-javascript/api/excel/-webimagecellvalue-relatedimagesaddress-member)|Represents the URL of a webpage with images that are considered related to this `WebImageCellValue`.| +||[type](/.webimagecellvalue#excel-javascript/api/excel/-webimagecellvalue-type-member)|Represents the type of this cell value.| +|[Workbook](/.workbook)|[getLinkedEntityCellValue(linkedEntityCellValueId: LinkedEntityId)](/.workbook#excel-javascript/api/excel/-workbook-getlinkedentitycellvalue-member(1))|Returns a `LinkedEntityCellValue` based on the provided `LinkedEntityId`.| diff --git a/docs/includes/excel-1_17.md b/docs/includes/excel-1_17.md index d1f861946d..18f7ec43d9 100644 --- a/docs/includes/excel-1_17.md +++ b/docs/includes/excel-1_17.md @@ -1,33 +1,33 @@ | Class | Fields | Description | |:---|:---|:---| -|[ConditionalFormat](/javascript/api/excel/excel.conditionalformat)|[changeRuleToCellValue(properties: Excel.ConditionalCellValueRule)](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-changeruletocellvalue-member(1))|Change the conditional format rule type to cell value.| -||[changeRuleToColorScale()](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-changeruletocolorscale-member(1))|Change the conditional format rule type to color scale.| -||[changeRuleToContainsText(properties: Excel.ConditionalTextComparisonRule)](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-changeruletocontainstext-member(1))|Change the conditional format rule type to text comparison.| -||[changeRuleToCustom(formula: string)](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-changeruletocustom-member(1))|Change the conditional format rule type to custom.| -||[changeRuleToDataBar()](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-changeruletodatabar-member(1))|Change the conditional format rule type to data bar.| -||[changeRuleToIconSet()](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-changeruletoiconset-member(1))|Change the conditional format rule type to icon set.| -||[changeRuleToPresetCriteria(properties: Excel.ConditionalPresetCriteriaRule)](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-changeruletopresetcriteria-member(1))|Change the conditional format rule type to preset criteria.| -||[changeRuleToTopBottom(properties: Excel.ConditionalTopBottomRule)](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-changeruletotopbottom-member(1))|Change the conditional format rule type to top/bottom.| -||[setRanges(ranges: Range \| RangeAreas \| string)](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-setranges-member(1))|Set the ranges that the conditional format rule is applied to.| -|[ConditionalRangeFormat](/javascript/api/excel/excel.conditionalrangeformat)|[clearFormat()](/javascript/api/excel/excel.conditionalrangeformat#excel-excel-conditionalrangeformat-clearformat-member(1))|Remove the format properties from a conditional format rule.| -|[NumberFormatInfo](/javascript/api/excel/excel.numberformatinfo)|[currencySymbol](/javascript/api/excel/excel.numberformatinfo#excel-excel-numberformatinfo-currencysymbol-member)|Gets the currency symbol for currency values.| -|[Worksheet](/javascript/api/excel/excel.worksheet)|[onNameChanged](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-onnamechanged-member)|Occurs when the worksheet name is changed.| -||[onVisibilityChanged](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-onvisibilitychanged-member)|Occurs when the worksheet visibility is changed.| -|[WorksheetCollection](/javascript/api/excel/excel.worksheetcollection)|[onMoved](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-onmoved-member)|Occurs when a worksheet is moved within a workbook.| -||[onNameChanged](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-onnamechanged-member)|Occurs when the worksheet name is changed in the worksheet collection.| -||[onVisibilityChanged](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-onvisibilitychanged-member)|Occurs when the worksheet visibility is changed in the worksheet collection.| -|[WorksheetMovedEventArgs](/javascript/api/excel/excel.worksheetmovedeventargs)|[positionAfter](/javascript/api/excel/excel.worksheetmovedeventargs#excel-excel-worksheetmovedeventargs-positionafter-member)|Gets the new position of the worksheet, after the move.| -||[positionBefore](/javascript/api/excel/excel.worksheetmovedeventargs#excel-excel-worksheetmovedeventargs-positionbefore-member)|Gets the previous position of the worksheet, prior to the move.| -||[source](/javascript/api/excel/excel.worksheetmovedeventargs#excel-excel-worksheetmovedeventargs-source-member)|The source of the event.| -||[type](/javascript/api/excel/excel.worksheetmovedeventargs#excel-excel-worksheetmovedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/javascript/api/excel/excel.worksheetmovedeventargs#excel-excel-worksheetmovedeventargs-worksheetid-member)|Gets the ID of the worksheet that was moved.| -|[WorksheetNameChangedEventArgs](/javascript/api/excel/excel.worksheetnamechangedeventargs)|[nameAfter](/javascript/api/excel/excel.worksheetnamechangedeventargs#excel-excel-worksheetnamechangedeventargs-nameafter-member)|Gets the new name of the worksheet, after the name change.| -||[nameBefore](/javascript/api/excel/excel.worksheetnamechangedeventargs#excel-excel-worksheetnamechangedeventargs-namebefore-member)|Gets the previous name of the worksheet, before the name changed.| -||[source](/javascript/api/excel/excel.worksheetnamechangedeventargs#excel-excel-worksheetnamechangedeventargs-source-member)|The source of the event.| -||[type](/javascript/api/excel/excel.worksheetnamechangedeventargs#excel-excel-worksheetnamechangedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/javascript/api/excel/excel.worksheetnamechangedeventargs#excel-excel-worksheetnamechangedeventargs-worksheetid-member)|Gets the ID of the worksheet with the new name.| -|[WorksheetVisibilityChangedEventArgs](/javascript/api/excel/excel.worksheetvisibilitychangedeventargs)|[source](/javascript/api/excel/excel.worksheetvisibilitychangedeventargs#excel-excel-worksheetvisibilitychangedeventargs-source-member)|The source of the event.| -||[type](/javascript/api/excel/excel.worksheetvisibilitychangedeventargs#excel-excel-worksheetvisibilitychangedeventargs-type-member)|Gets the type of the event.| -||[visibilityAfter](/javascript/api/excel/excel.worksheetvisibilitychangedeventargs#excel-excel-worksheetvisibilitychangedeventargs-visibilityafter-member)|Gets the new visibility setting of the worksheet, after the visibility change.| -||[visibilityBefore](/javascript/api/excel/excel.worksheetvisibilitychangedeventargs#excel-excel-worksheetvisibilitychangedeventargs-visibilitybefore-member)|Gets the previous visibility setting of the worksheet, before the visibility change.| -||[worksheetId](/javascript/api/excel/excel.worksheetvisibilitychangedeventargs#excel-excel-worksheetvisibilitychangedeventargs-worksheetid-member)|Gets the ID of the worksheet whose visibility has changed.| +|[ConditionalFormat](/.conditionalformat)|[changeRuleToCellValue(properties: Excel.ConditionalCellValueRule)](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-changeruletocellvalue-member(1))|Change the conditional format rule type to cell value.| +||[changeRuleToColorScale()](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-changeruletocolorscale-member(1))|Change the conditional format rule type to color scale.| +||[changeRuleToContainsText(properties: Excel.ConditionalTextComparisonRule)](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-changeruletocontainstext-member(1))|Change the conditional format rule type to text comparison.| +||[changeRuleToCustom(formula: string)](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-changeruletocustom-member(1))|Change the conditional format rule type to custom.| +||[changeRuleToDataBar()](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-changeruletodatabar-member(1))|Change the conditional format rule type to data bar.| +||[changeRuleToIconSet()](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-changeruletoiconset-member(1))|Change the conditional format rule type to icon set.| +||[changeRuleToPresetCriteria(properties: Excel.ConditionalPresetCriteriaRule)](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-changeruletopresetcriteria-member(1))|Change the conditional format rule type to preset criteria.| +||[changeRuleToTopBottom(properties: Excel.ConditionalTopBottomRule)](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-changeruletotopbottom-member(1))|Change the conditional format rule type to top/bottom.| +||[setRanges(ranges: Range \| RangeAreas \| string)](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-setranges-member(1))|Set the ranges that the conditional format rule is applied to.| +|[ConditionalRangeFormat](/.conditionalrangeformat)|[clearFormat()](/.conditionalrangeformat#excel-javascript/api/excel/-conditionalrangeformat-clearformat-member(1))|Remove the format properties from a conditional format rule.| +|[NumberFormatInfo](/.numberformatinfo)|[currencySymbol](/.numberformatinfo#excel-javascript/api/excel/-numberformatinfo-currencysymbol-member)|Gets the currency symbol for currency values.| +|[Worksheet](/.worksheet)|[onNameChanged](/.worksheet#excel-javascript/api/excel/-worksheet-onnamechanged-member)|Occurs when the worksheet name is changed.| +||[onVisibilityChanged](/.worksheet#excel-javascript/api/excel/-worksheet-onvisibilitychanged-member)|Occurs when the worksheet visibility is changed.| +|[WorksheetCollection](/.worksheetcollection)|[onMoved](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-onmoved-member)|Occurs when a worksheet is moved within a workbook.| +||[onNameChanged](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-onnamechanged-member)|Occurs when the worksheet name is changed in the worksheet collection.| +||[onVisibilityChanged](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-onvisibilitychanged-member)|Occurs when the worksheet visibility is changed in the worksheet collection.| +|[WorksheetMovedEventArgs](/.worksheetmovedeventargs)|[positionAfter](/.worksheetmovedeventargs#excel-javascript/api/excel/-worksheetmovedeventargs-positionafter-member)|Gets the new position of the worksheet, after the move.| +||[positionBefore](/.worksheetmovedeventargs#excel-javascript/api/excel/-worksheetmovedeventargs-positionbefore-member)|Gets the previous position of the worksheet, prior to the move.| +||[source](/.worksheetmovedeventargs#excel-javascript/api/excel/-worksheetmovedeventargs-source-member)|The source of the event.| +||[type](/.worksheetmovedeventargs#excel-javascript/api/excel/-worksheetmovedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/.worksheetmovedeventargs#excel-javascript/api/excel/-worksheetmovedeventargs-worksheetid-member)|Gets the ID of the worksheet that was moved.| +|[WorksheetNameChangedEventArgs](/.worksheetnamechangedeventargs)|[nameAfter](/.worksheetnamechangedeventargs#excel-javascript/api/excel/-worksheetnamechangedeventargs-nameafter-member)|Gets the new name of the worksheet, after the name change.| +||[nameBefore](/.worksheetnamechangedeventargs#excel-javascript/api/excel/-worksheetnamechangedeventargs-namebefore-member)|Gets the previous name of the worksheet, before the name changed.| +||[source](/.worksheetnamechangedeventargs#excel-javascript/api/excel/-worksheetnamechangedeventargs-source-member)|The source of the event.| +||[type](/.worksheetnamechangedeventargs#excel-javascript/api/excel/-worksheetnamechangedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/.worksheetnamechangedeventargs#excel-javascript/api/excel/-worksheetnamechangedeventargs-worksheetid-member)|Gets the ID of the worksheet with the new name.| +|[WorksheetVisibilityChangedEventArgs](/.worksheetvisibilitychangedeventargs)|[source](/.worksheetvisibilitychangedeventargs#excel-javascript/api/excel/-worksheetvisibilitychangedeventargs-source-member)|The source of the event.| +||[type](/.worksheetvisibilitychangedeventargs#excel-javascript/api/excel/-worksheetvisibilitychangedeventargs-type-member)|Gets the type of the event.| +||[visibilityAfter](/.worksheetvisibilitychangedeventargs#excel-javascript/api/excel/-worksheetvisibilitychangedeventargs-visibilityafter-member)|Gets the new visibility setting of the worksheet, after the visibility change.| +||[visibilityBefore](/.worksheetvisibilitychangedeventargs#excel-javascript/api/excel/-worksheetvisibilitychangedeventargs-visibilitybefore-member)|Gets the previous visibility setting of the worksheet, before the visibility change.| +||[worksheetId](/.worksheetvisibilitychangedeventargs#excel-javascript/api/excel/-worksheetvisibilitychangedeventargs-worksheetid-member)|Gets the ID of the worksheet whose visibility has changed.| diff --git a/docs/includes/excel-1_18.md b/docs/includes/excel-1_18.md index 2fad74c650..03dada1f01 100644 --- a/docs/includes/excel-1_18.md +++ b/docs/includes/excel-1_18.md @@ -1,28 +1,28 @@ | Class | Fields | Description | |:---|:---|:---| -|[CheckboxCellControl](/javascript/api/excel/excel.checkboxcellcontrol)|[type](/javascript/api/excel/excel.checkboxcellcontrol#excel-excel-checkboxcellcontrol-type-member)|Represents an interactable control inside of a cell.| -|[EmptyCellControl](/javascript/api/excel/excel.emptycellcontrol)|[type](/javascript/api/excel/excel.emptycellcontrol#excel-excel-emptycellcontrol-type-member)|| -|[MixedCellControl](/javascript/api/excel/excel.mixedcellcontrol)|[type](/javascript/api/excel/excel.mixedcellcontrol#excel-excel-mixedcellcontrol-type-member)|| -|[Note](/javascript/api/excel/excel.note)|[authorName](/javascript/api/excel/excel.note#excel-excel-note-authorname-member)|Gets the author of the note.| -||[content](/javascript/api/excel/excel.note#excel-excel-note-content-member)|Specifies the text of the note.| -||[delete()](/javascript/api/excel/excel.note#excel-excel-note-delete-member(1))|Deletes the note.| -||[getLocation()](/javascript/api/excel/excel.note#excel-excel-note-getlocation-member(1))|Gets the cell where this note is located.| -||[height](/javascript/api/excel/excel.note#excel-excel-note-height-member)|Specifies the height of the note.| -||[visible](/javascript/api/excel/excel.note#excel-excel-note-visible-member)|Specifies the visibility of the note.| -||[width](/javascript/api/excel/excel.note#excel-excel-note-width-member)|Specifies the width of the note.| -|[NoteCollection](/javascript/api/excel/excel.notecollection)|[add(cellAddress: Range \| string, content: any)](/javascript/api/excel/excel.notecollection#excel-excel-notecollection-add-member(1))|Adds a new note with the given content on the given cell.| -||[getCount()](/javascript/api/excel/excel.notecollection#excel-excel-notecollection-getcount-member(1))|Gets the number of notes in the collection.| -||[getItem(key: string)](/javascript/api/excel/excel.notecollection#excel-excel-notecollection-getitem-member(1))|Gets a note by its cell address.| -||[getItemAt(index: number)](/javascript/api/excel/excel.notecollection#excel-excel-notecollection-getitemat-member(1))|Gets a note from the collection based on its position.| -||[getItemOrNullObject(key: string)](/javascript/api/excel/excel.notecollection#excel-excel-notecollection-getitemornullobject-member(1))|Gets a note by its cell address.| -||[items](/javascript/api/excel/excel.notecollection#excel-excel-notecollection-items-member)|Gets the loaded child items in this collection.| -|[Range](/javascript/api/excel/excel.range)|[clearOrResetContents()](/javascript/api/excel/excel.range#excel-excel-range-clearorresetcontents-member(1))|Clears the values of the cells in the range, with special consideration given to cells containing controls.| -||[control](/javascript/api/excel/excel.range#excel-excel-range-control-member)|Accesses the cell control applied to this range.| -|[RangeAreas](/javascript/api/excel/excel.rangeareas)|[clearOrResetContents()](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-clearorresetcontents-member(1))|Clears the values of the cells in the ranges, with special consideration given to cells containing controls.| -||[select()](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-select-member(1))|Selects the specified range areas in the Excel UI.| -|[RangeTextRun](/javascript/api/excel/excel.rangetextrun)|[font](/javascript/api/excel/excel.rangetextrun#excel-excel-rangetextrun-font-member)|The font attributes (such as font name, font size, and color) applied to this text run.| -||[text](/javascript/api/excel/excel.rangetextrun#excel-excel-rangetextrun-text-member)|The text of this text run.| -|[SettableCellProperties](/javascript/api/excel/excel.settablecellproperties)|[textRuns](/javascript/api/excel/excel.settablecellproperties#excel-excel-settablecellproperties-textruns-member)|Represents the `textRuns` property.| -|[UnknownCellControl](/javascript/api/excel/excel.unknowncellcontrol)|[type](/javascript/api/excel/excel.unknowncellcontrol#excel-excel-unknowncellcontrol-type-member)|| -|[Workbook](/javascript/api/excel/excel.workbook)|[notes](/javascript/api/excel/excel.workbook#excel-excel-workbook-notes-member)|Returns a collection of all the notes objects in the workbook.| -|[Worksheet](/javascript/api/excel/excel.worksheet)|[notes](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-notes-member)|Returns a collection of all the notes objects in the worksheet.| +|[CheckboxCellControl](/.checkboxcellcontrol)|[type](/.checkboxcellcontrol#excel-javascript/api/excel/-checkboxcellcontrol-type-member)|Represents an interactable control inside of a cell.| +|[EmptyCellControl](/.emptycellcontrol)|[type](/.emptycellcontrol#excel-javascript/api/excel/-emptycellcontrol-type-member)|| +|[MixedCellControl](/.mixedcellcontrol)|[type](/.mixedcellcontrol#excel-javascript/api/excel/-mixedcellcontrol-type-member)|| +|[Note](/.note)|[authorName](/.note#excel-javascript/api/excel/-note-authorname-member)|Gets the author of the note.| +||[content](/.note#excel-javascript/api/excel/-note-content-member)|Specifies the text of the note.| +||[delete()](/.note#excel-javascript/api/excel/-note-delete-member(1))|Deletes the note.| +||[getLocation()](/.note#excel-javascript/api/excel/-note-getlocation-member(1))|Gets the cell where this note is located.| +||[height](/.note#excel-javascript/api/excel/-note-height-member)|Specifies the height of the note.| +||[visible](/.note#excel-javascript/api/excel/-note-visible-member)|Specifies the visibility of the note.| +||[width](/.note#excel-javascript/api/excel/-note-width-member)|Specifies the width of the note.| +|[NoteCollection](/.notecollection)|[add(cellAddress: Range \| string, content: any)](/.notecollection#excel-javascript/api/excel/-notecollection-add-member(1))|Adds a new note with the given content on the given cell.| +||[getCount()](/.notecollection#excel-javascript/api/excel/-notecollection-getcount-member(1))|Gets the number of notes in the collection.| +||[getItem(key: string)](/.notecollection#excel-javascript/api/excel/-notecollection-getitem-member(1))|Gets a note by its cell address.| +||[getItemAt(index: number)](/.notecollection#excel-javascript/api/excel/-notecollection-getitemat-member(1))|Gets a note from the collection based on its position.| +||[getItemOrNullObject(key: string)](/.notecollection#excel-javascript/api/excel/-notecollection-getitemornullobject-member(1))|Gets a note by its cell address.| +||[items](/.notecollection#excel-javascript/api/excel/-notecollection-items-member)|Gets the loaded child items in this collection.| +|[Range](/.range)|[clearOrResetContents()](/.range#excel-javascript/api/excel/-range-clearorresetcontents-member(1))|Clears the values of the cells in the range, with special consideration given to cells containing controls.| +||[control](/.range#excel-javascript/api/excel/-range-control-member)|Accesses the cell control applied to this range.| +|[RangeAreas](/.rangeareas)|[clearOrResetContents()](/.rangeareas#excel-javascript/api/excel/-rangeareas-clearorresetcontents-member(1))|Clears the values of the cells in the ranges, with special consideration given to cells containing controls.| +||[select()](/.rangeareas#excel-javascript/api/excel/-rangeareas-select-member(1))|Selects the specified range areas in the Excel UI.| +|[RangeTextRun](/.rangetextrun)|[font](/.rangetextrun#excel-javascript/api/excel/-rangetextrun-font-member)|The font attributes (such as font name, font size, and color) applied to this text run.| +||[text](/.rangetextrun#excel-javascript/api/excel/-rangetextrun-text-member)|The text of this text run.| +|[SettableCellProperties](/.settablecellproperties)|[textRuns](/.settablecellproperties#excel-javascript/api/excel/-settablecellproperties-textruns-member)|Represents the `textRuns` property.| +|[UnknownCellControl](/.unknowncellcontrol)|[type](/.unknowncellcontrol#excel-javascript/api/excel/-unknowncellcontrol-type-member)|| +|[Workbook](/.workbook)|[notes](/.workbook#excel-javascript/api/excel/-workbook-notes-member)|Returns a collection of all the notes objects in the workbook.| +|[Worksheet](/.worksheet)|[notes](/.worksheet#excel-javascript/api/excel/-worksheet-notes-member)|Returns a collection of all the notes objects in the worksheet.| diff --git a/docs/includes/excel-1_19.md b/docs/includes/excel-1_19.md index 453e9457c4..cb9a1aa076 100644 --- a/docs/includes/excel-1_19.md +++ b/docs/includes/excel-1_19.md @@ -1,99 +1,99 @@ | Class | Fields | Description | |:---|:---|:---| -|[BasicCardLayout](/javascript/api/excel/excel.basiccardlayout)|[layout](/javascript/api/excel/excel.basiccardlayout#excel-excel-basiccardlayout-layout-member)|Represents the type of this layout.| -|[BasicCompactLayout](/javascript/api/excel/excel.basiccompactlayout)|[icon](/javascript/api/excel/excel.basiccompactlayout#excel-excel-basiccompactlayout-icon-member)|Specifies the name of the icon which is used to open the card.| -|[BasicViewLayouts](/javascript/api/excel/excel.basicviewlayouts)|[card](/javascript/api/excel/excel.basicviewlayouts#excel-excel-basicviewlayouts-card-member)|Represents the layout of this value and its properties in card view.| -||[compact](/javascript/api/excel/excel.basicviewlayouts#excel-excel-basicviewlayouts-compact-member)|Represents the layout used when there is limited space to represent the value.| -|[BooleanCellValue](/javascript/api/excel/excel.booleancellvalue)|[layouts](/javascript/api/excel/excel.booleancellvalue#excel-excel-booleancellvalue-layouts-member)|Represents layout information for views of this Boolean value.| -||[properties](/javascript/api/excel/excel.booleancellvalue#excel-excel-booleancellvalue-properties-member)|Represents additional properties of this Boolean value.| -||[provider](/javascript/api/excel/excel.booleancellvalue#excel-excel-booleancellvalue-provider-member)|Represents information that describes the service that provided the data in this `BooleanCellValue`.| -||[referencedValues](/javascript/api/excel/excel.booleancellvalue#excel-excel-booleancellvalue-referencedvalues-member)|Represents the cell values which are referenced within `BooleanCellValue.properties`.| -|[CardLayoutTwoColumnSection](/javascript/api/excel/excel.cardlayouttwocolumnsection)|[layout](/javascript/api/excel/excel.cardlayouttwocolumnsection#excel-excel-cardlayouttwocolumnsection-layout-member)|Represents the type of layout for this section.| -|[ChartDataLabel](/javascript/api/excel/excel.chartdatalabel)|[geometricShapeType](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-geometricshapetype-member)|Specifies the geometric shape type of the data label.| -||[getSubstring(start: number, length?: number)](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-getsubstring-member(1))|Returns a substring of the data label.| -||[getTailAnchor()](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-gettailanchor-member(1))|Returns the tail anchor of the data label which is shown as a sticky callout.| -||[setHeight(height: number)](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-setheight-member(1))|Sets the height of the data label in points.| -||[setWidth(width: number)](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-setwidth-member(1))|Sets the width of the data label in points.| -||[showAsStickyCallout](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-showasstickycallout-member)|Specifies if the data label is shown as a callout with the tail anchor attached to the data point.| -|[ChartDataLabelAnchor](/javascript/api/excel/excel.chartdatalabelanchor)|[left](/javascript/api/excel/excel.chartdatalabelanchor#excel-excel-chartdatalabelanchor-left-member)|Specifies the distance, in points, from the anchor to the left edge of the chart data label.| -||[top](/javascript/api/excel/excel.chartdatalabelanchor#excel-excel-chartdatalabelanchor-top-member)|Specifies the distance, in points, from the anchor to the top edge of the chart data label.| -|[ChartDataLabels](/javascript/api/excel/excel.chartdatalabels)|[geometricShapeType](/javascript/api/excel/excel.chartdatalabels#excel-excel-chartdatalabels-geometricshapetype-member)|Specifies the geometric shape type of the data labels.| -||[leaderLines](/javascript/api/excel/excel.chartdatalabels#excel-excel-chartdatalabels-leaderlines-member)|Gets an object that represents the leader lines of the data labels.| -||[showAsStickyCallout](/javascript/api/excel/excel.chartdatalabels#excel-excel-chartdatalabels-showasstickycallout-member)|Specifies if the data labels are shown as a callout with the tail anchor attached to the data point.| -||[showLeaderLines](/javascript/api/excel/excel.chartdatalabels#excel-excel-chartdatalabels-showleaderlines-member)|Specifies if leader lines are displayed for the data labels.| -|[ChartLeaderLines](/javascript/api/excel/excel.chartleaderlines)|[format](/javascript/api/excel/excel.chartleaderlines#excel-excel-chartleaderlines-format-member)|Represents the formatting of leader lines of data labels in a series.| -|[ChartLeaderLinesFormat](/javascript/api/excel/excel.chartleaderlinesformat)|[line](/javascript/api/excel/excel.chartleaderlinesformat#excel-excel-chartleaderlinesformat-line-member)|Gets an object that represents the line formatting of chart leader lines.| -|[DoubleCellValue](/javascript/api/excel/excel.doublecellvalue)|[layouts](/javascript/api/excel/excel.doublecellvalue#excel-excel-doublecellvalue-layouts-member)|Represents layout information for views of this double value.| -||[numberFormat](/javascript/api/excel/excel.doublecellvalue#excel-excel-doublecellvalue-numberformat-member)|Returns the number format string that is used to display this value.| -||[properties](/javascript/api/excel/excel.doublecellvalue#excel-excel-doublecellvalue-properties-member)|Represents additional properties of this double value.| -||[provider](/javascript/api/excel/excel.doublecellvalue#excel-excel-doublecellvalue-provider-member)|Represents information that describes the service that provided the data in this `DoubleCellValue`.| -||[referencedValues](/javascript/api/excel/excel.doublecellvalue#excel-excel-doublecellvalue-referencedvalues-member)|Represents the cell values which are referenced within `DoubleCellValue.properties`.| -|[EntityCompactLayout](/javascript/api/excel/excel.entitycompactlayout)|[icon](/javascript/api/excel/excel.entitycompactlayout#excel-excel-entitycompactlayout-icon-member)|Specifies the name of the icon which is used to open the card.| -|[FormattedNumberCellValue](/javascript/api/excel/excel.formattednumbercellvalue)|[basicType](/javascript/api/excel/excel.formattednumbercellvalue#excel-excel-formattednumbercellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/javascript/api/excel/excel.formattednumbercellvalue#excel-excel-formattednumbercellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[numberFormat](/javascript/api/excel/excel.formattednumbercellvalue#excel-excel-formattednumbercellvalue-numberformat-member)|Returns the number format string that is used to display this value.| -||[type](/javascript/api/excel/excel.formattednumbercellvalue#excel-excel-formattednumbercellvalue-type-member)|Represents the type of this cell value.| -|[JavaScriptCustomFunctionReferenceCellValue](/javascript/api/excel/excel.javascriptcustomfunctionreferencecellvalue)|[basicType](/javascript/api/excel/excel.javascriptcustomfunctionreferencecellvalue#excel-excel-javascriptcustomfunctionreferencecellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/javascript/api/excel/excel.javascriptcustomfunctionreferencecellvalue#excel-excel-javascriptcustomfunctionreferencecellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[functionType](/javascript/api/excel/excel.javascriptcustomfunctionreferencecellvalue#excel-excel-javascriptcustomfunctionreferencecellvalue-functiontype-member)|Represents the type of `FunctionCellValue`.| -||[id](/javascript/api/excel/excel.javascriptcustomfunctionreferencecellvalue#excel-excel-javascriptcustomfunctionreferencecellvalue-id-member)|Represents the ID of the custom function.| -||[namespace](/javascript/api/excel/excel.javascriptcustomfunctionreferencecellvalue#excel-excel-javascriptcustomfunctionreferencecellvalue-namespace-member)|Represents the namespace used by the custom function.| -||[type](/javascript/api/excel/excel.javascriptcustomfunctionreferencecellvalue#excel-excel-javascriptcustomfunctionreferencecellvalue-type-member)|Represents the type of this cell value.| -|[LinkedEntityDataDomain](/javascript/api/excel/excel.linkedentitydatadomain)|[dataProvider](/javascript/api/excel/excel.linkedentitydatadomain#excel-excel-linkedentitydatadomain-dataprovider-member)|Gets the name of the data provider for the linked entity data domain.| -||[delete()](/javascript/api/excel/excel.linkedentitydatadomain#excel-excel-linkedentitydatadomain-delete-member(1))|Deletes this object from the `LinkedEntityDataDomainCollection`.| -||[id](/javascript/api/excel/excel.linkedentitydatadomain#excel-excel-linkedentitydatadomain-id-member)|Gets the ID of the linked entity data domain defined by Office Add-ins.| -||[lastRefreshed](/javascript/api/excel/excel.linkedentitydatadomain#excel-excel-linkedentitydatadomain-lastrefreshed-member)|Gets the date and time (in the local time zone) since the workbook was opened and the `LinkedEntityCellValue` objects of this linked entity data domain were last refreshed.| -||[loadFunctionId](/javascript/api/excel/excel.linkedentitydatadomain#excel-excel-linkedentitydatadomain-loadfunctionid-member)|Gets the ID of the custom function that is called on demand to resolve or refresh the `LinkedEntityCellValue` objects of the linked entity data domain defined by Office Add-ins.| -||[name](/javascript/api/excel/excel.linkedentitydatadomain#excel-excel-linkedentitydatadomain-name-member)|Gets the name of the linked entity data domain.| -||[periodicRefreshInterval](/javascript/api/excel/excel.linkedentitydatadomain#excel-excel-linkedentitydatadomain-periodicrefreshinterval-member)|Gets the frequency, in seconds, at which `LinkedEntityCellValue` objects of this linked entity data domain are refreshed automatically.| -||[refresh()](/javascript/api/excel/excel.linkedentitydatadomain#excel-excel-linkedentitydatadomain-refresh-member(1))|Refreshes all `LinkedEntityCellValue` objects of this linked entity data domain.| -||[refreshMode](/javascript/api/excel/excel.linkedentitydatadomain#excel-excel-linkedentitydatadomain-refreshmode-member)|Specifies the refresh mode that defines how and when the `LinkedEntityCellValue` objects of this linked entity data domain are refreshed.| -||[serviceId](/javascript/api/excel/excel.linkedentitydatadomain#excel-excel-linkedentitydatadomain-serviceid-member)|Gets the service ID of the linked entity data domain.| -||[supportedRefreshModes](/javascript/api/excel/excel.linkedentitydatadomain#excel-excel-linkedentitydatadomain-supportedrefreshmodes-member)|Gets all the refresh modes supported by the linked entity data domain.| -|[LinkedEntityDataDomainAddedEventArgs](/javascript/api/excel/excel.linkedentitydatadomainaddedeventargs)|[id](/javascript/api/excel/excel.linkedentitydatadomainaddedeventargs#excel-excel-linkedentitydatadomainaddedeventargs-id-member)|Gets the ID of the linked entity data domain that was just added to the workbook.| -||[serviceId](/javascript/api/excel/excel.linkedentitydatadomainaddedeventargs#excel-excel-linkedentitydatadomainaddedeventargs-serviceid-member)|Gets the service ID of the linked entity data domain that was just added to the workbook.| -||[source](/javascript/api/excel/excel.linkedentitydatadomainaddedeventargs#excel-excel-linkedentitydatadomainaddedeventargs-source-member)|Gets the source of the event.| -||[type](/javascript/api/excel/excel.linkedentitydatadomainaddedeventargs#excel-excel-linkedentitydatadomainaddedeventargs-type-member)|Gets the type of the event.| -|[LinkedEntityDataDomainCollection](/javascript/api/excel/excel.linkedentitydatadomaincollection)|[add(options: Excel.LinkedEntityDataDomainCreateOptions)](/javascript/api/excel/excel.linkedentitydatadomaincollection#excel-excel-linkedentitydatadomaincollection-add-member(1))|Adds a linked entity data domain object defined by the Office Add-in to the collection.| -||[getCount()](/javascript/api/excel/excel.linkedentitydatadomaincollection#excel-excel-linkedentitydatadomaincollection-getcount-member(1))|Gets the number of linked entity data domains in the collection.| -||[getItem(id: string)](/javascript/api/excel/excel.linkedentitydatadomaincollection#excel-excel-linkedentitydatadomaincollection-getitem-member(1))|Gets a linked entity data domain by its `id`.| -||[getItemAt(index: number)](/javascript/api/excel/excel.linkedentitydatadomaincollection#excel-excel-linkedentitydatadomaincollection-getitemat-member(1))|Gets a linked entity data domain by its index in the collection.| -||[getItemByName(name: string)](/javascript/api/excel/excel.linkedentitydatadomaincollection#excel-excel-linkedentitydatadomaincollection-getitembyname-member(1))|Gets a linked entity data domain by its `name`.| -||[getItemByNameOrNullObject(name: string)](/javascript/api/excel/excel.linkedentitydatadomaincollection#excel-excel-linkedentitydatadomaincollection-getitembynameornullobject-member(1))|Gets a linked entity data domain by its `name`.| -||[getItemOrNullObject(id: string)](/javascript/api/excel/excel.linkedentitydatadomaincollection#excel-excel-linkedentitydatadomaincollection-getitemornullobject-member(1))|Gets a linked entity data domain by its `id`.| -||[items](/javascript/api/excel/excel.linkedentitydatadomaincollection#excel-excel-linkedentitydatadomaincollection-items-member)|Gets the loaded child items in this collection.| -||[onLinkedEntityDataDomainAdded](/javascript/api/excel/excel.linkedentitydatadomaincollection#excel-excel-linkedentitydatadomaincollection-onlinkedentitydatadomainadded-member)|Occurs when a new linked entity data domain is added to the workbook.| -||[onRefreshCompleted](/javascript/api/excel/excel.linkedentitydatadomaincollection#excel-excel-linkedentitydatadomaincollection-onrefreshcompleted-member)|Occurs when the request to refresh `LinkedEntityCellValue` objects of a linked entity data domain is completed.| -||[onRefreshModeChanged](/javascript/api/excel/excel.linkedentitydatadomaincollection#excel-excel-linkedentitydatadomaincollection-onrefreshmodechanged-member)|Occurs when the `refreshMode` of a linked entity data domain is changed.| -||[refreshAll()](/javascript/api/excel/excel.linkedentitydatadomaincollection#excel-excel-linkedentitydatadomaincollection-refreshall-member(1))|Refreshes all `LinkedEntityCellValue` objects of all linked entity data domains in this collection.| -|[LinkedEntityDataDomainCreateOptions](/javascript/api/excel/excel.linkedentitydatadomaincreateoptions)|[dataProvider](/javascript/api/excel/excel.linkedentitydatadomaincreateoptions#excel-excel-linkedentitydatadomaincreateoptions-dataprovider-member)|Specifies the name of the data provider for the linked entity data domain.| -||[id](/javascript/api/excel/excel.linkedentitydatadomaincreateoptions#excel-excel-linkedentitydatadomaincreateoptions-id-member)|Specifies the ID of the linked entity data domain.| -||[loadFunctionId](/javascript/api/excel/excel.linkedentitydatadomaincreateoptions#excel-excel-linkedentitydatadomaincreateoptions-loadfunctionid-member)|Specifies the ID of the custom function that will be called on demand to resolve or refresh the `LinkedEntityCellValue` objects of this linked entity data domain.| -||[name](/javascript/api/excel/excel.linkedentitydatadomaincreateoptions#excel-excel-linkedentitydatadomaincreateoptions-name-member)|Specifies the name of the linked entity data domain.| -||[periodicRefreshInterval](/javascript/api/excel/excel.linkedentitydatadomaincreateoptions#excel-excel-linkedentitydatadomaincreateoptions-periodicrefreshinterval-member)|Specifies the frequency, in seconds, at which `LinkedEntityCellValue` objects of this linked entity data domain are refreshed automatically.| -||[supportedRefreshModes](/javascript/api/excel/excel.linkedentitydatadomaincreateoptions#excel-excel-linkedentitydatadomaincreateoptions-supportedrefreshmodes-member)|Specifies all the refresh modes supported by the linked entity data domain.| -|[LinkedEntityDataDomainRefreshCompletedEventArgs](/javascript/api/excel/excel.linkedentitydatadomainrefreshcompletedeventargs)|[errors](/javascript/api/excel/excel.linkedentitydatadomainrefreshcompletedeventargs#excel-excel-linkedentitydatadomainrefreshcompletedeventargs-errors-member)|Gets any errors encountered during the request to refresh `LinkedEntityCellValue` objects of the linked entity data domain.| -||[id](/javascript/api/excel/excel.linkedentitydatadomainrefreshcompletedeventargs#excel-excel-linkedentitydatadomainrefreshcompletedeventargs-id-member)|Gets the ID of the linked entity data domain whose `LinkedEntityCellValue` objects were refreshed.| -||[refreshed](/javascript/api/excel/excel.linkedentitydatadomainrefreshcompletedeventargs#excel-excel-linkedentitydatadomainrefreshcompletedeventargs-refreshed-member)|Returns `true` if the `LinkedEntityCellValue` objects of the linked entity data domain were refreshed successfully, otherwise returns `false`.| -||[serviceId](/javascript/api/excel/excel.linkedentitydatadomainrefreshcompletedeventargs#excel-excel-linkedentitydatadomainrefreshcompletedeventargs-serviceid-member)|Gets the service ID of the linked entity data domain whose `LinkedEntityCellValue` objects were refreshed.| -||[source](/javascript/api/excel/excel.linkedentitydatadomainrefreshcompletedeventargs#excel-excel-linkedentitydatadomainrefreshcompletedeventargs-source-member)|Gets the source of the event.| -||[type](/javascript/api/excel/excel.linkedentitydatadomainrefreshcompletedeventargs#excel-excel-linkedentitydatadomainrefreshcompletedeventargs-type-member)|Gets the type of the event.| -|[LinkedEntityDataDomainRefreshModeChangedEventArgs](/javascript/api/excel/excel.linkedentitydatadomainrefreshmodechangedeventargs)|[id](/javascript/api/excel/excel.linkedentitydatadomainrefreshmodechangedeventargs#excel-excel-linkedentitydatadomainrefreshmodechangedeventargs-id-member)|Gets the ID of the linked entity data domain whose refresh mode was changed.| -||[refreshMode](/javascript/api/excel/excel.linkedentitydatadomainrefreshmodechangedeventargs#excel-excel-linkedentitydatadomainrefreshmodechangedeventargs-refreshmode-member)|Gets the new refresh mode of the linked entity data domain.| -||[serviceId](/javascript/api/excel/excel.linkedentitydatadomainrefreshmodechangedeventargs#excel-excel-linkedentitydatadomainrefreshmodechangedeventargs-serviceid-member)|Gets the service ID of the linked entity data domain whose refresh mode was changed.| -||[source](/javascript/api/excel/excel.linkedentitydatadomainrefreshmodechangedeventargs#excel-excel-linkedentitydatadomainrefreshmodechangedeventargs-source-member)|Gets the source of the event.| -||[type](/javascript/api/excel/excel.linkedentitydatadomainrefreshmodechangedeventargs#excel-excel-linkedentitydatadomainrefreshmodechangedeventargs-type-member)|Gets the type of the event.| -|[LinkedEntityIdCulture](/javascript/api/excel/excel.linkedentityidculture)|[culture](/javascript/api/excel/excel.linkedentityidculture#excel-excel-linkedentityidculture-culture-member)|Represents the language culture used to create the `LinkedEntityCellValue` object.| -||[entityId](/javascript/api/excel/excel.linkedentityidculture#excel-excel-linkedentityidculture-entityid-member)|Represents the identifier specific to a service used to create the `LinkedEntityCellValue` object.| -|[LinkedEntityLoadServiceRequest](/javascript/api/excel/excel.linkedentityloadservicerequest)|[domainId](/javascript/api/excel/excel.linkedentityloadservicerequest#excel-excel-linkedentityloadservicerequest-domainid-member)|Represents the domain specific to the service used to create the `LinkedEntityCellValue` objects.| -||[entities](/javascript/api/excel/excel.linkedentityloadservicerequest#excel-excel-linkedentityloadservicerequest-entities-member)|Represents the entity IDs and cultures of the `LinkedEntityCellValue` objects to load.| -|[LinkedEntityLoadServiceResult](/javascript/api/excel/excel.linkedentityloadserviceresult)|[entities](/javascript/api/excel/excel.linkedentityloadserviceresult#excel-excel-linkedentityloadserviceresult-entities-member)|Represents the loaded `LinkedEntityCellValue` objects.| -|[Range](/javascript/api/excel/excel.range)|[getDisplayedCellProperties(cellPropertiesLoadOptions: CellPropertiesLoadOptions)](/javascript/api/excel/excel.range#excel-excel-range-getdisplayedcellproperties-member(1))|Returns a 2D array, encapsulating the display data for each cell's font, fill, borders, alignment, and other properties.| -|[StringCellValue](/javascript/api/excel/excel.stringcellvalue)|[layouts](/javascript/api/excel/excel.stringcellvalue#excel-excel-stringcellvalue-layouts-member)|Represents layout information for views of this string value.| -||[properties](/javascript/api/excel/excel.stringcellvalue#excel-excel-stringcellvalue-properties-member)|Represents additional properties of this string value.| -||[provider](/javascript/api/excel/excel.stringcellvalue#excel-excel-stringcellvalue-provider-member)|Represents information that describes the service that provided the data in this `StringCellValue`.| -||[referencedValues](/javascript/api/excel/excel.stringcellvalue#excel-excel-stringcellvalue-referencedvalues-member)|Represents the cell values which are referenced within `StringCellValue.properties`.| -|[Workbook](/javascript/api/excel/excel.workbook)|[getActiveShape()](/javascript/api/excel/excel.workbook#excel-excel-workbook-getactiveshape-member(1))|Gets the active shape in the workbook.| -||[getActiveShapeOrNullObject()](/javascript/api/excel/excel.workbook#excel-excel-workbook-getactiveshapeornullobject-member(1))|Gets the active shape in the workbook.| -||[linkedEntityDataDomains](/javascript/api/excel/excel.workbook#excel-excel-workbook-linkedentitydatadomains-member)|Returns a collection of linked entity data domains that are available in the workbook.| -|[Worksheet](/javascript/api/excel/excel.worksheet)|[showDataTypeIcons](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-showdatatypeicons-member)|Specifies if data type icons are visible on the worksheet.| +|[BasicCardLayout](/.basiccardlayout)|[layout](/.basiccardlayout#excel-javascript/api/excel/-basiccardlayout-layout-member)|Represents the type of this layout.| +|[BasicCompactLayout](/.basiccompactlayout)|[icon](/.basiccompactlayout#excel-javascript/api/excel/-basiccompactlayout-icon-member)|Specifies the name of the icon which is used to open the card.| +|[BasicViewLayouts](/.basicviewlayouts)|[card](/.basicviewlayouts#excel-javascript/api/excel/-basicviewlayouts-card-member)|Represents the layout of this value and its properties in card view.| +||[compact](/.basicviewlayouts#excel-javascript/api/excel/-basicviewlayouts-compact-member)|Represents the layout used when there is limited space to represent the value.| +|[BooleanCellValue](/.booleancellvalue)|[layouts](/.booleancellvalue#excel-javascript/api/excel/-booleancellvalue-layouts-member)|Represents layout information for views of this Boolean value.| +||[properties](/.booleancellvalue#excel-javascript/api/excel/-booleancellvalue-properties-member)|Represents additional properties of this Boolean value.| +||[provider](/.booleancellvalue#excel-javascript/api/excel/-booleancellvalue-provider-member)|Represents information that describes the service that provided the data in this `BooleanCellValue`.| +||[referencedValues](/.booleancellvalue#excel-javascript/api/excel/-booleancellvalue-referencedvalues-member)|Represents the cell values which are referenced within `BooleanCellValue.properties`.| +|[CardLayoutTwoColumnSection](/.cardlayouttwocolumnsection)|[layout](/.cardlayouttwocolumnsection#excel-javascript/api/excel/-cardlayouttwocolumnsection-layout-member)|Represents the type of layout for this section.| +|[ChartDataLabel](/.chartdatalabel)|[geometricShapeType](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-geometricshapetype-member)|Specifies the geometric shape type of the data label.| +||[getSubstring(start: number, length?: number)](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-getsubstring-member(1))|Returns a substring of the data label.| +||[getTailAnchor()](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-gettailanchor-member(1))|Returns the tail anchor of the data label which is shown as a sticky callout.| +||[setHeight(height: number)](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-setheight-member(1))|Sets the height of the data label in points.| +||[setWidth(width: number)](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-setwidth-member(1))|Sets the width of the data label in points.| +||[showAsStickyCallout](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-showasstickycallout-member)|Specifies if the data label is shown as a callout with the tail anchor attached to the data point.| +|[ChartDataLabelAnchor](/.chartdatalabelanchor)|[left](/.chartdatalabelanchor#excel-javascript/api/excel/-chartdatalabelanchor-left-member)|Specifies the distance, in points, from the anchor to the left edge of the chart data label.| +||[top](/.chartdatalabelanchor#excel-javascript/api/excel/-chartdatalabelanchor-top-member)|Specifies the distance, in points, from the anchor to the top edge of the chart data label.| +|[ChartDataLabels](/.chartdatalabels)|[geometricShapeType](/.chartdatalabels#excel-javascript/api/excel/-chartdatalabels-geometricshapetype-member)|Specifies the geometric shape type of the data labels.| +||[leaderLines](/.chartdatalabels#excel-javascript/api/excel/-chartdatalabels-leaderlines-member)|Gets an object that represents the leader lines of the data labels.| +||[showAsStickyCallout](/.chartdatalabels#excel-javascript/api/excel/-chartdatalabels-showasstickycallout-member)|Specifies if the data labels are shown as a callout with the tail anchor attached to the data point.| +||[showLeaderLines](/.chartdatalabels#excel-javascript/api/excel/-chartdatalabels-showleaderlines-member)|Specifies if leader lines are displayed for the data labels.| +|[ChartLeaderLines](/.chartleaderlines)|[format](/.chartleaderlines#excel-javascript/api/excel/-chartleaderlines-format-member)|Represents the formatting of leader lines of data labels in a series.| +|[ChartLeaderLinesFormat](/.chartleaderlinesformat)|[line](/.chartleaderlinesformat#excel-javascript/api/excel/-chartleaderlinesformat-line-member)|Gets an object that represents the line formatting of chart leader lines.| +|[DoubleCellValue](/.doublecellvalue)|[layouts](/.doublecellvalue#excel-javascript/api/excel/-doublecellvalue-layouts-member)|Represents layout information for views of this double value.| +||[numberFormat](/.doublecellvalue#excel-javascript/api/excel/-doublecellvalue-numberformat-member)|Returns the number format string that is used to display this value.| +||[properties](/.doublecellvalue#excel-javascript/api/excel/-doublecellvalue-properties-member)|Represents additional properties of this double value.| +||[provider](/.doublecellvalue#excel-javascript/api/excel/-doublecellvalue-provider-member)|Represents information that describes the service that provided the data in this `DoubleCellValue`.| +||[referencedValues](/.doublecellvalue#excel-javascript/api/excel/-doublecellvalue-referencedvalues-member)|Represents the cell values which are referenced within `DoubleCellValue.properties`.| +|[EntityCompactLayout](/.entitycompactlayout)|[icon](/.entitycompactlayout#excel-javascript/api/excel/-entitycompactlayout-icon-member)|Specifies the name of the icon which is used to open the card.| +|[FormattedNumberCellValue](/.formattednumbercellvalue)|[basicType](/.formattednumbercellvalue#excel-javascript/api/excel/-formattednumbercellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/.formattednumbercellvalue#excel-javascript/api/excel/-formattednumbercellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[numberFormat](/.formattednumbercellvalue#excel-javascript/api/excel/-formattednumbercellvalue-numberformat-member)|Returns the number format string that is used to display this value.| +||[type](/.formattednumbercellvalue#excel-javascript/api/excel/-formattednumbercellvalue-type-member)|Represents the type of this cell value.| +|[JavaScriptCustomFunctionReferenceCellValue](/.javascriptcustomfunctionreferencecellvalue)|[basicType](/.javascriptcustomfunctionreferencecellvalue#excel-javascript/api/excel/-javascriptcustomfunctionreferencecellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/.javascriptcustomfunctionreferencecellvalue#excel-javascript/api/excel/-javascriptcustomfunctionreferencecellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[functionType](/.javascriptcustomfunctionreferencecellvalue#excel-javascript/api/excel/-javascriptcustomfunctionreferencecellvalue-functiontype-member)|Represents the type of `FunctionCellValue`.| +||[id](/.javascriptcustomfunctionreferencecellvalue#excel-javascript/api/excel/-javascriptcustomfunctionreferencecellvalue-id-member)|Represents the ID of the custom function.| +||[namespace](/.javascriptcustomfunctionreferencecellvalue#excel-javascript/api/excel/-javascriptcustomfunctionreferencecellvalue-namespace-member)|Represents the namespace used by the custom function.| +||[type](/.javascriptcustomfunctionreferencecellvalue#excel-javascript/api/excel/-javascriptcustomfunctionreferencecellvalue-type-member)|Represents the type of this cell value.| +|[LinkedEntityDataDomain](/.linkedentitydatadomain)|[dataProvider](/.linkedentitydatadomain#excel-javascript/api/excel/-linkedentitydatadomain-dataprovider-member)|Gets the name of the data provider for the linked entity data domain.| +||[delete()](/.linkedentitydatadomain#excel-javascript/api/excel/-linkedentitydatadomain-delete-member(1))|Deletes this object from the `LinkedEntityDataDomainCollection`.| +||[id](/.linkedentitydatadomain#excel-javascript/api/excel/-linkedentitydatadomain-id-member)|Gets the ID of the linked entity data domain defined by Office Add-ins.| +||[lastRefreshed](/.linkedentitydatadomain#excel-javascript/api/excel/-linkedentitydatadomain-lastrefreshed-member)|Gets the date and time (in the local time zone) since the workbook was opened and the `LinkedEntityCellValue` objects of this linked entity data domain were last refreshed.| +||[loadFunctionId](/.linkedentitydatadomain#excel-javascript/api/excel/-linkedentitydatadomain-loadfunctionid-member)|Gets the ID of the custom function that is called on demand to resolve or refresh the `LinkedEntityCellValue` objects of the linked entity data domain defined by Office Add-ins.| +||[name](/.linkedentitydatadomain#excel-javascript/api/excel/-linkedentitydatadomain-name-member)|Gets the name of the linked entity data domain.| +||[periodicRefreshInterval](/.linkedentitydatadomain#excel-javascript/api/excel/-linkedentitydatadomain-periodicrefreshinterval-member)|Gets the frequency, in seconds, at which `LinkedEntityCellValue` objects of this linked entity data domain are refreshed automatically.| +||[refresh()](/.linkedentitydatadomain#excel-javascript/api/excel/-linkedentitydatadomain-refresh-member(1))|Refreshes all `LinkedEntityCellValue` objects of this linked entity data domain.| +||[refreshMode](/.linkedentitydatadomain#excel-javascript/api/excel/-linkedentitydatadomain-refreshmode-member)|Specifies the refresh mode that defines how and when the `LinkedEntityCellValue` objects of this linked entity data domain are refreshed.| +||[serviceId](/.linkedentitydatadomain#excel-javascript/api/excel/-linkedentitydatadomain-serviceid-member)|Gets the service ID of the linked entity data domain.| +||[supportedRefreshModes](/.linkedentitydatadomain#excel-javascript/api/excel/-linkedentitydatadomain-supportedrefreshmodes-member)|Gets all the refresh modes supported by the linked entity data domain.| +|[LinkedEntityDataDomainAddedEventArgs](/.linkedentitydatadomainaddedeventargs)|[id](/.linkedentitydatadomainaddedeventargs#excel-javascript/api/excel/-linkedentitydatadomainaddedeventargs-id-member)|Gets the ID of the linked entity data domain that was just added to the workbook.| +||[serviceId](/.linkedentitydatadomainaddedeventargs#excel-javascript/api/excel/-linkedentitydatadomainaddedeventargs-serviceid-member)|Gets the service ID of the linked entity data domain that was just added to the workbook.| +||[source](/.linkedentitydatadomainaddedeventargs#excel-javascript/api/excel/-linkedentitydatadomainaddedeventargs-source-member)|Gets the source of the event.| +||[type](/.linkedentitydatadomainaddedeventargs#excel-javascript/api/excel/-linkedentitydatadomainaddedeventargs-type-member)|Gets the type of the event.| +|[LinkedEntityDataDomainCollection](/.linkedentitydatadomaincollection)|[add(options: Excel.LinkedEntityDataDomainCreateOptions)](/.linkedentitydatadomaincollection#excel-javascript/api/excel/-linkedentitydatadomaincollection-add-member(1))|Adds a linked entity data domain object defined by the Office Add-in to the collection.| +||[getCount()](/.linkedentitydatadomaincollection#excel-javascript/api/excel/-linkedentitydatadomaincollection-getcount-member(1))|Gets the number of linked entity data domains in the collection.| +||[getItem(id: string)](/.linkedentitydatadomaincollection#excel-javascript/api/excel/-linkedentitydatadomaincollection-getitem-member(1))|Gets a linked entity data domain by its `id`.| +||[getItemAt(index: number)](/.linkedentitydatadomaincollection#excel-javascript/api/excel/-linkedentitydatadomaincollection-getitemat-member(1))|Gets a linked entity data domain by its index in the collection.| +||[getItemByName(name: string)](/.linkedentitydatadomaincollection#excel-javascript/api/excel/-linkedentitydatadomaincollection-getitembyname-member(1))|Gets a linked entity data domain by its `name`.| +||[getItemByNameOrNullObject(name: string)](/.linkedentitydatadomaincollection#excel-javascript/api/excel/-linkedentitydatadomaincollection-getitembynameornullobject-member(1))|Gets a linked entity data domain by its `name`.| +||[getItemOrNullObject(id: string)](/.linkedentitydatadomaincollection#excel-javascript/api/excel/-linkedentitydatadomaincollection-getitemornullobject-member(1))|Gets a linked entity data domain by its `id`.| +||[items](/.linkedentitydatadomaincollection#excel-javascript/api/excel/-linkedentitydatadomaincollection-items-member)|Gets the loaded child items in this collection.| +||[onLinkedEntityDataDomainAdded](/.linkedentitydatadomaincollection#excel-javascript/api/excel/-linkedentitydatadomaincollection-onlinkedentitydatadomainadded-member)|Occurs when a new linked entity data domain is added to the workbook.| +||[onRefreshCompleted](/.linkedentitydatadomaincollection#excel-javascript/api/excel/-linkedentitydatadomaincollection-onrefreshcompleted-member)|Occurs when the request to refresh `LinkedEntityCellValue` objects of a linked entity data domain is completed.| +||[onRefreshModeChanged](/.linkedentitydatadomaincollection#excel-javascript/api/excel/-linkedentitydatadomaincollection-onrefreshmodechanged-member)|Occurs when the `refreshMode` of a linked entity data domain is changed.| +||[refreshAll()](/.linkedentitydatadomaincollection#excel-javascript/api/excel/-linkedentitydatadomaincollection-refreshall-member(1))|Refreshes all `LinkedEntityCellValue` objects of all linked entity data domains in this collection.| +|[LinkedEntityDataDomainCreateOptions](/.linkedentitydatadomaincreateoptions)|[dataProvider](/.linkedentitydatadomaincreateoptions#excel-javascript/api/excel/-linkedentitydatadomaincreateoptions-dataprovider-member)|Specifies the name of the data provider for the linked entity data domain.| +||[id](/.linkedentitydatadomaincreateoptions#excel-javascript/api/excel/-linkedentitydatadomaincreateoptions-id-member)|Specifies the ID of the linked entity data domain.| +||[loadFunctionId](/.linkedentitydatadomaincreateoptions#excel-javascript/api/excel/-linkedentitydatadomaincreateoptions-loadfunctionid-member)|Specifies the ID of the custom function that will be called on demand to resolve or refresh the `LinkedEntityCellValue` objects of this linked entity data domain.| +||[name](/.linkedentitydatadomaincreateoptions#excel-javascript/api/excel/-linkedentitydatadomaincreateoptions-name-member)|Specifies the name of the linked entity data domain.| +||[periodicRefreshInterval](/.linkedentitydatadomaincreateoptions#excel-javascript/api/excel/-linkedentitydatadomaincreateoptions-periodicrefreshinterval-member)|Specifies the frequency, in seconds, at which `LinkedEntityCellValue` objects of this linked entity data domain are refreshed automatically.| +||[supportedRefreshModes](/.linkedentitydatadomaincreateoptions#excel-javascript/api/excel/-linkedentitydatadomaincreateoptions-supportedrefreshmodes-member)|Specifies all the refresh modes supported by the linked entity data domain.| +|[LinkedEntityDataDomainRefreshCompletedEventArgs](/.linkedentitydatadomainrefreshcompletedeventargs)|[errors](/.linkedentitydatadomainrefreshcompletedeventargs#excel-javascript/api/excel/-linkedentitydatadomainrefreshcompletedeventargs-errors-member)|Gets any errors encountered during the request to refresh `LinkedEntityCellValue` objects of the linked entity data domain.| +||[id](/.linkedentitydatadomainrefreshcompletedeventargs#excel-javascript/api/excel/-linkedentitydatadomainrefreshcompletedeventargs-id-member)|Gets the ID of the linked entity data domain whose `LinkedEntityCellValue` objects were refreshed.| +||[refreshed](/.linkedentitydatadomainrefreshcompletedeventargs#excel-javascript/api/excel/-linkedentitydatadomainrefreshcompletedeventargs-refreshed-member)|Returns `true` if the `LinkedEntityCellValue` objects of the linked entity data domain were refreshed successfully, otherwise returns `false`.| +||[serviceId](/.linkedentitydatadomainrefreshcompletedeventargs#excel-javascript/api/excel/-linkedentitydatadomainrefreshcompletedeventargs-serviceid-member)|Gets the service ID of the linked entity data domain whose `LinkedEntityCellValue` objects were refreshed.| +||[source](/.linkedentitydatadomainrefreshcompletedeventargs#excel-javascript/api/excel/-linkedentitydatadomainrefreshcompletedeventargs-source-member)|Gets the source of the event.| +||[type](/.linkedentitydatadomainrefreshcompletedeventargs#excel-javascript/api/excel/-linkedentitydatadomainrefreshcompletedeventargs-type-member)|Gets the type of the event.| +|[LinkedEntityDataDomainRefreshModeChangedEventArgs](/.linkedentitydatadomainrefreshmodechangedeventargs)|[id](/.linkedentitydatadomainrefreshmodechangedeventargs#excel-javascript/api/excel/-linkedentitydatadomainrefreshmodechangedeventargs-id-member)|Gets the ID of the linked entity data domain whose refresh mode was changed.| +||[refreshMode](/.linkedentitydatadomainrefreshmodechangedeventargs#excel-javascript/api/excel/-linkedentitydatadomainrefreshmodechangedeventargs-refreshmode-member)|Gets the new refresh mode of the linked entity data domain.| +||[serviceId](/.linkedentitydatadomainrefreshmodechangedeventargs#excel-javascript/api/excel/-linkedentitydatadomainrefreshmodechangedeventargs-serviceid-member)|Gets the service ID of the linked entity data domain whose refresh mode was changed.| +||[source](/.linkedentitydatadomainrefreshmodechangedeventargs#excel-javascript/api/excel/-linkedentitydatadomainrefreshmodechangedeventargs-source-member)|Gets the source of the event.| +||[type](/.linkedentitydatadomainrefreshmodechangedeventargs#excel-javascript/api/excel/-linkedentitydatadomainrefreshmodechangedeventargs-type-member)|Gets the type of the event.| +|[LinkedEntityIdCulture](/.linkedentityidculture)|[culture](/.linkedentityidculture#excel-javascript/api/excel/-linkedentityidculture-culture-member)|Represents the language culture used to create the `LinkedEntityCellValue` object.| +||[entityId](/.linkedentityidculture#excel-javascript/api/excel/-linkedentityidculture-entityid-member)|Represents the identifier specific to a service used to create the `LinkedEntityCellValue` object.| +|[LinkedEntityLoadServiceRequest](/.linkedentityloadservicerequest)|[domainId](/.linkedentityloadservicerequest#excel-javascript/api/excel/-linkedentityloadservicerequest-domainid-member)|Represents the domain specific to the service used to create the `LinkedEntityCellValue` objects.| +||[entities](/.linkedentityloadservicerequest#excel-javascript/api/excel/-linkedentityloadservicerequest-entities-member)|Represents the entity IDs and cultures of the `LinkedEntityCellValue` objects to load.| +|[LinkedEntityLoadServiceResult](/.linkedentityloadserviceresult)|[entities](/.linkedentityloadserviceresult#excel-javascript/api/excel/-linkedentityloadserviceresult-entities-member)|Represents the loaded `LinkedEntityCellValue` objects.| +|[Range](/.range)|[getDisplayedCellProperties(cellPropertiesLoadOptions: CellPropertiesLoadOptions)](/.range#excel-javascript/api/excel/-range-getdisplayedcellproperties-member(1))|Returns a 2D array, encapsulating the display data for each cell's font, fill, borders, alignment, and other properties.| +|[StringCellValue](/.stringcellvalue)|[layouts](/.stringcellvalue#excel-javascript/api/excel/-stringcellvalue-layouts-member)|Represents layout information for views of this string value.| +||[properties](/.stringcellvalue#excel-javascript/api/excel/-stringcellvalue-properties-member)|Represents additional properties of this string value.| +||[provider](/.stringcellvalue#excel-javascript/api/excel/-stringcellvalue-provider-member)|Represents information that describes the service that provided the data in this `StringCellValue`.| +||[referencedValues](/.stringcellvalue#excel-javascript/api/excel/-stringcellvalue-referencedvalues-member)|Represents the cell values which are referenced within `StringCellValue.properties`.| +|[Workbook](/.workbook)|[getActiveShape()](/.workbook#excel-javascript/api/excel/-workbook-getactiveshape-member(1))|Gets the active shape in the workbook.| +||[getActiveShapeOrNullObject()](/.workbook#excel-javascript/api/excel/-workbook-getactiveshapeornullobject-member(1))|Gets the active shape in the workbook.| +||[linkedEntityDataDomains](/.workbook#excel-javascript/api/excel/-workbook-linkedentitydatadomains-member)|Returns a collection of linked entity data domains that are available in the workbook.| +|[Worksheet](/.worksheet)|[showDataTypeIcons](/.worksheet#excel-javascript/api/excel/-worksheet-showdatatypeicons-member)|Specifies if data type icons are visible on the worksheet.| diff --git a/docs/includes/excel-1_2.md b/docs/includes/excel-1_2.md index 5532cdfbd5..814c25f977 100644 --- a/docs/includes/excel-1_2.md +++ b/docs/includes/excel-1_2.md @@ -1,558 +1,558 @@ | Class | Fields | Description | |:---|:---|:---| -|[Binding](/javascript/api/excel/excel.binding)|[onDataChanged](/javascript/api/excel/excel.binding#excel-excel-binding-ondatachanged-member)|Occurs when data or formatting within the binding is changed.| -||[onSelectionChanged](/javascript/api/excel/excel.binding#excel-excel-binding-onselectionchanged-member)|Occurs when the selected content in the binding is changed.| -|[BindingDataChangedEventArgs](/javascript/api/excel/excel.bindingdatachangedeventargs)|[binding](/javascript/api/excel/excel.bindingdatachangedeventargs#excel-excel-bindingdatachangedeventargs-binding-member)|Gets a temporary `Binding` object that contains the ID of the `Binding` object that raised the event.| -|[BindingSelectionChangedEventArgs](/javascript/api/excel/excel.bindingselectionchangedeventargs)|[binding](/javascript/api/excel/excel.bindingselectionchangedeventargs#excel-excel-bindingselectionchangedeventargs-binding-member)|Gets a temporary `Binding` object that contains the ID of the `Binding` object that raised the event.| -||[columnCount](/javascript/api/excel/excel.bindingselectionchangedeventargs#excel-excel-bindingselectionchangedeventargs-columncount-member)|Gets the number of columns selected.| -||[rowCount](/javascript/api/excel/excel.bindingselectionchangedeventargs#excel-excel-bindingselectionchangedeventargs-rowcount-member)|Gets the number of rows selected.| -||[startColumn](/javascript/api/excel/excel.bindingselectionchangedeventargs#excel-excel-bindingselectionchangedeventargs-startcolumn-member)|Gets the index of the first column of the selection (zero-based).| -||[startRow](/javascript/api/excel/excel.bindingselectionchangedeventargs#excel-excel-bindingselectionchangedeventargs-startrow-member)|Gets the index of the first row of the selection (zero-based).| -|[Chart](/javascript/api/excel/excel.chart)|[getImage(width?: number, height?: number, fittingMode?: Excel.ImageFittingMode)](/javascript/api/excel/excel.chart#excel-excel-chart-getimage-member(1))|Renders the chart as a Base64-encoded image by scaling the chart to fit the specified dimensions.| -||[worksheet](/javascript/api/excel/excel.chart#excel-excel-chart-worksheet-member)|The worksheet containing the current chart.| -|[Filter](/javascript/api/excel/excel.filter)|[apply(criteria: Excel.FilterCriteria)](/javascript/api/excel/excel.filter#excel-excel-filter-apply-member(1))|Apply the given filter criteria on the given column.| -||[applyBottomItemsFilter(count: number)](/javascript/api/excel/excel.filter#excel-excel-filter-applybottomitemsfilter-member(1))|Apply a "Bottom Item" filter to the column for the given number of elements.| -||[applyBottomPercentFilter(percent: number)](/javascript/api/excel/excel.filter#excel-excel-filter-applybottompercentfilter-member(1))|Apply a "Bottom Percent" filter to the column for the given percentage of elements.| -||[applyCellColorFilter(color: string)](/javascript/api/excel/excel.filter#excel-excel-filter-applycellcolorfilter-member(1))|Apply a "Cell Color" filter to the column for the given color.| -||[applyCustomFilter(criteria1: string, criteria2?: string, oper?: Excel.FilterOperator)](/javascript/api/excel/excel.filter#excel-excel-filter-applycustomfilter-member(1))|Apply an "Icon" filter to the column for the given criteria strings.| -||[applyDynamicFilter(criteria: Excel.DynamicFilterCriteria)](/javascript/api/excel/excel.filter#excel-excel-filter-applydynamicfilter-member(1))|Apply a "Dynamic" filter to the column.| -||[applyFontColorFilter(color: string)](/javascript/api/excel/excel.filter#excel-excel-filter-applyfontcolorfilter-member(1))|Apply a "Font Color" filter to the column for the given color.| -||[applyIconFilter(icon: Excel.Icon)](/javascript/api/excel/excel.filter#excel-excel-filter-applyiconfilter-member(1))|Apply an "Icon" filter to the column for the given icon.| -||[applyTopItemsFilter(count: number)](/javascript/api/excel/excel.filter#excel-excel-filter-applytopitemsfilter-member(1))|Apply a "Top Item" filter to the column for the given number of elements.| -||[applyTopPercentFilter(percent: number)](/javascript/api/excel/excel.filter#excel-excel-filter-applytoppercentfilter-member(1))|Apply a "Top Percent" filter to the column for the given percentage of elements.| -||[applyValuesFilter(values: Array)](/javascript/api/excel/excel.filter#excel-excel-filter-applyvaluesfilter-member(1))|Apply a "Values" filter to the column for the given values.| -||[clear()](/javascript/api/excel/excel.filter#excel-excel-filter-clear-member(1))|Clear the filter on the given column.| -||[criteria](/javascript/api/excel/excel.filter#excel-excel-filter-criteria-member)|The currently applied filter on the given column.| -|[FilterCriteria](/javascript/api/excel/excel.filtercriteria)|[color](/javascript/api/excel/excel.filtercriteria#excel-excel-filtercriteria-color-member)|The HTML color string used to filter cells.| -||[criterion1](/javascript/api/excel/excel.filtercriteria#excel-excel-filtercriteria-criterion1-member)|The first criterion used to filter data.| -||[criterion2](/javascript/api/excel/excel.filtercriteria#excel-excel-filtercriteria-criterion2-member)|The second criterion used to filter data.| -||[dynamicCriteria](/javascript/api/excel/excel.filtercriteria#excel-excel-filtercriteria-dynamiccriteria-member)|The dynamic criteria from the `Excel.DynamicFilterCriteria` set to apply on this column.| -||[filterOn](/javascript/api/excel/excel.filtercriteria#excel-excel-filtercriteria-filteron-member)|The property used by the filter to determine whether the values should stay visible.| -||[icon](/javascript/api/excel/excel.filtercriteria#excel-excel-filtercriteria-icon-member)|The icon used to filter cells.| -||[operator](/javascript/api/excel/excel.filtercriteria#excel-excel-filtercriteria-operator-member)|The operator used to combine criterion 1 and 2 when using `custom` filtering.| -||[values](/javascript/api/excel/excel.filtercriteria#excel-excel-filtercriteria-values-member)|The set of values to be used as part of `values` filtering.| -|[FilterDatetime](/javascript/api/excel/excel.filterdatetime)|[date](/javascript/api/excel/excel.filterdatetime#excel-excel-filterdatetime-date-member)|The date in ISO8601 format used to filter data.| -||[specificity](/javascript/api/excel/excel.filterdatetime#excel-excel-filterdatetime-specificity-member)|How specific the date should be used to keep data.| -|[FiveArrowsGraySet](/javascript/api/excel/excel.fivearrowsgrayset)|[grayDownArrow](/javascript/api/excel/excel.fivearrowsgrayset#excel-excel-fivearrowsgrayset-graydownarrow-member)|| -||[grayDownInclineArrow](/javascript/api/excel/excel.fivearrowsgrayset#excel-excel-fivearrowsgrayset-graydowninclinearrow-member)|| -||[graySideArrow](/javascript/api/excel/excel.fivearrowsgrayset#excel-excel-fivearrowsgrayset-graysidearrow-member)|| -||[grayUpArrow](/javascript/api/excel/excel.fivearrowsgrayset#excel-excel-fivearrowsgrayset-grayuparrow-member)|| -||[grayUpInclineArrow](/javascript/api/excel/excel.fivearrowsgrayset#excel-excel-fivearrowsgrayset-grayupinclinearrow-member)|| -|[FiveArrowsSet](/javascript/api/excel/excel.fivearrowsset)|[greenUpArrow](/javascript/api/excel/excel.fivearrowsset#excel-excel-fivearrowsset-greenuparrow-member)|| -||[redDownArrow](/javascript/api/excel/excel.fivearrowsset#excel-excel-fivearrowsset-reddownarrow-member)|| -||[yellowDownInclineArrow](/javascript/api/excel/excel.fivearrowsset#excel-excel-fivearrowsset-yellowdowninclinearrow-member)|| -||[yellowSideArrow](/javascript/api/excel/excel.fivearrowsset#excel-excel-fivearrowsset-yellowsidearrow-member)|| -||[yellowUpInclineArrow](/javascript/api/excel/excel.fivearrowsset#excel-excel-fivearrowsset-yellowupinclinearrow-member)|| -|[FiveBoxesSet](/javascript/api/excel/excel.fiveboxesset)|[fourFilledBoxes](/javascript/api/excel/excel.fiveboxesset#excel-excel-fiveboxesset-fourfilledboxes-member)|| -||[noFilledBoxes](/javascript/api/excel/excel.fiveboxesset#excel-excel-fiveboxesset-nofilledboxes-member)|| -||[oneFilledBox](/javascript/api/excel/excel.fiveboxesset#excel-excel-fiveboxesset-onefilledbox-member)|| -||[threeFilledBoxes](/javascript/api/excel/excel.fiveboxesset#excel-excel-fiveboxesset-threefilledboxes-member)|| -||[twoFilledBoxes](/javascript/api/excel/excel.fiveboxesset#excel-excel-fiveboxesset-twofilledboxes-member)|| -|[FiveQuartersSet](/javascript/api/excel/excel.fivequartersset)|[blackCircle](/javascript/api/excel/excel.fivequartersset#excel-excel-fivequartersset-blackcircle-member)|| -||[circleWithOneWhiteQuarter](/javascript/api/excel/excel.fivequartersset#excel-excel-fivequartersset-circlewithonewhitequarter-member)|| -||[circleWithThreeWhiteQuarters](/javascript/api/excel/excel.fivequartersset#excel-excel-fivequartersset-circlewiththreewhitequarters-member)|| -||[circleWithTwoWhiteQuarters](/javascript/api/excel/excel.fivequartersset#excel-excel-fivequartersset-circlewithtwowhitequarters-member)|| -||[whiteCircleAllWhiteQuarters](/javascript/api/excel/excel.fivequartersset#excel-excel-fivequartersset-whitecircleallwhitequarters-member)|| -|[FiveRatingSet](/javascript/api/excel/excel.fiveratingset)|[fourBars](/javascript/api/excel/excel.fiveratingset#excel-excel-fiveratingset-fourbars-member)|| -||[noBars](/javascript/api/excel/excel.fiveratingset#excel-excel-fiveratingset-nobars-member)|| -||[oneBar](/javascript/api/excel/excel.fiveratingset#excel-excel-fiveratingset-onebar-member)|| -||[threeBars](/javascript/api/excel/excel.fiveratingset#excel-excel-fiveratingset-threebars-member)|| -||[twoBars](/javascript/api/excel/excel.fiveratingset#excel-excel-fiveratingset-twobars-member)|| -|[FormatProtection](/javascript/api/excel/excel.formatprotection)|[formulaHidden](/javascript/api/excel/excel.formatprotection#excel-excel-formatprotection-formulahidden-member)|Specifies if Excel hides the formula for the cells in the range.| -||[locked](/javascript/api/excel/excel.formatprotection#excel-excel-formatprotection-locked-member)|Specifies if Excel locks the cells in the object.| -|[FourArrowsGraySet](/javascript/api/excel/excel.fourarrowsgrayset)|[grayDownArrow](/javascript/api/excel/excel.fourarrowsgrayset#excel-excel-fourarrowsgrayset-graydownarrow-member)|| -||[grayDownInclineArrow](/javascript/api/excel/excel.fourarrowsgrayset#excel-excel-fourarrowsgrayset-graydowninclinearrow-member)|| -||[grayUpArrow](/javascript/api/excel/excel.fourarrowsgrayset#excel-excel-fourarrowsgrayset-grayuparrow-member)|| -||[grayUpInclineArrow](/javascript/api/excel/excel.fourarrowsgrayset#excel-excel-fourarrowsgrayset-grayupinclinearrow-member)|| -|[FourArrowsSet](/javascript/api/excel/excel.fourarrowsset)|[greenUpArrow](/javascript/api/excel/excel.fourarrowsset#excel-excel-fourarrowsset-greenuparrow-member)|| -||[redDownArrow](/javascript/api/excel/excel.fourarrowsset#excel-excel-fourarrowsset-reddownarrow-member)|| -||[yellowDownInclineArrow](/javascript/api/excel/excel.fourarrowsset#excel-excel-fourarrowsset-yellowdowninclinearrow-member)|| -||[yellowUpInclineArrow](/javascript/api/excel/excel.fourarrowsset#excel-excel-fourarrowsset-yellowupinclinearrow-member)|| -|[FourRatingSet](/javascript/api/excel/excel.fourratingset)|[fourBars](/javascript/api/excel/excel.fourratingset#excel-excel-fourratingset-fourbars-member)|| -||[oneBar](/javascript/api/excel/excel.fourratingset#excel-excel-fourratingset-onebar-member)|| -||[threeBars](/javascript/api/excel/excel.fourratingset#excel-excel-fourratingset-threebars-member)|| -||[twoBars](/javascript/api/excel/excel.fourratingset#excel-excel-fourratingset-twobars-member)|| -|[FourRedToBlackSet](/javascript/api/excel/excel.fourredtoblackset)|[blackCircle](/javascript/api/excel/excel.fourredtoblackset#excel-excel-fourredtoblackset-blackcircle-member)|| -||[grayCircle](/javascript/api/excel/excel.fourredtoblackset#excel-excel-fourredtoblackset-graycircle-member)|| -||[pinkCircle](/javascript/api/excel/excel.fourredtoblackset#excel-excel-fourredtoblackset-pinkcircle-member)|| -||[redCircle](/javascript/api/excel/excel.fourredtoblackset#excel-excel-fourredtoblackset-redcircle-member)|| -|[FourTrafficLightsSet](/javascript/api/excel/excel.fourtrafficlightsset)|[blackCircleWithBorder](/javascript/api/excel/excel.fourtrafficlightsset#excel-excel-fourtrafficlightsset-blackcirclewithborder-member)|| -||[greenCircle](/javascript/api/excel/excel.fourtrafficlightsset#excel-excel-fourtrafficlightsset-greencircle-member)|| -||[redCircleWithBorder](/javascript/api/excel/excel.fourtrafficlightsset#excel-excel-fourtrafficlightsset-redcirclewithborder-member)|| -||[yellowCircle](/javascript/api/excel/excel.fourtrafficlightsset#excel-excel-fourtrafficlightsset-yellowcircle-member)|| -|[FunctionResult](/javascript/api/excel/excel.functionresult)|[error](/javascript/api/excel/excel.functionresult#excel-excel-functionresult-error-member)|Error value (such as "#DIV/0") representing the error.| -||[value](/javascript/api/excel/excel.functionresult#excel-excel-functionresult-value-member)|The value of function evaluation.| -|[Functions](/javascript/api/excel/excel.functions)|[abs(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-abs-member(1))|Returns the absolute value of a number, a number without its sign.| -||[accrInt(issue: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, firstInterest: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, par: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, calcMethod?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-accrint-member(1))|Returns the accrued interest for a security that pays periodic interest.| -||[accrIntM(issue: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, par: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-accrintm-member(1))|Returns the accrued interest for a security that pays interest at maturity.| -||[acos(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-acos-member(1))|Returns the arccosine of a number, in radians in the range 0 to Pi.| -||[acosh(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-acosh-member(1))|Returns the inverse hyperbolic cosine of a number.| -||[acot(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-acot-member(1))|Returns the arccotangent of a number, in radians in the range 0 to Pi.| -||[acoth(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-acoth-member(1))|Returns the inverse hyperbolic cotangent of a number.| -||[amorDegrc(cost: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, datePurchased: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, firstPeriod: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, salvage: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, period: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-amordegrc-member(1))|Returns the prorated linear depreciation of an asset for each accounting period.| -||[amorLinc(cost: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, datePurchased: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, firstPeriod: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, salvage: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, period: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-amorlinc-member(1))|Returns the prorated linear depreciation of an asset for each accounting period.| -||[and(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-and-member(1))|Checks whether all arguments are TRUE, and returns TRUE if all arguments are TRUE.| -||[arabic(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-arabic-member(1))|Converts a Roman numeral to Arabic.| -||[areas(reference: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-areas-member(1))|Returns the number of areas in a reference.| -||[asc(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-asc-member(1))|Changes full-width (double-byte) characters to half-width (single-byte) characters.| -||[asin(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-asin-member(1))|Returns the arcsine of a number in radians, in the range -Pi/2 to Pi/2.| -||[asinh(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-asinh-member(1))|Returns the inverse hyperbolic sine of a number.| -||[atan(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-atan-member(1))|Returns the arctangent of a number in radians, in the range -Pi/2 to Pi/2.| -||[atan2(xNum: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, yNum: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-atan2-member(1))|Returns the arctangent of the specified x- and y- coordinates, in radians between -Pi and Pi, excluding -Pi.| -||[atanh(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-atanh-member(1))|Returns the inverse hyperbolic tangent of a number.| -||[aveDev(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-avedev-member(1))|Returns the average of the absolute deviations of data points from their mean.| -||[average(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-average-member(1))|Returns the average (arithmetic mean) of its arguments, which can be numbers or names, arrays, or references that contain numbers.| -||[averageA(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-averagea-member(1))|Returns the average (arithmetic mean) of its arguments, evaluating text and FALSE in arguments as 0; TRUE evaluates as 1.| -||[averageIf(range: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, averageRange?: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-averageif-member(1))|Finds average(arithmetic mean) for the cells specified by a given condition or criteria.| -||[averageIfs(averageRange: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, ...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-averageifs-member(1))|Finds average(arithmetic mean) for the cells specified by a given set of conditions or criteria.| -||[bahtText(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-bahttext-member(1))|Converts a number to text (baht).| -||[base(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, radix: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, minLength?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-base-member(1))|Converts a number into a text representation with the given radix (base).| -||[besselI(x: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, n: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-besseli-member(1))|Returns the modified Bessel function In(x).| -||[besselJ(x: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, n: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-besselj-member(1))|Returns the Bessel function Jn(x).| -||[besselK(x: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, n: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-besselk-member(1))|Returns the modified Bessel function Kn(x).| -||[besselY(x: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, n: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-bessely-member(1))|Returns the Bessel function Yn(x).| -||[beta_Dist(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, alpha: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, beta: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, A?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, B?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-beta_dist-member(1))|Returns the beta probability distribution function.| -||[beta_Inv(probability: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, alpha: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, beta: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, A?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, B?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-beta_inv-member(1))|Returns the inverse of the cumulative beta probability density function (BETA.DIST).| -||[bin2Dec(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-bin2dec-member(1))|Converts a binary number to decimal.| -||[bin2Hex(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, places?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-bin2hex-member(1))|Converts a binary number to hexadecimal.| -||[bin2Oct(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, places?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-bin2oct-member(1))|Converts a binary number to octal.| -||[binom_Dist(numberS: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, trials: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, probabilityS: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-binom_dist-member(1))|Returns the individual term binomial distribution probability.| -||[binom_Dist_Range(trials: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, probabilityS: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numberS: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numberS2?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-binom_dist_range-member(1))|Returns the probability of a trial result using a binomial distribution.| -||[binom_Inv(trials: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, probabilityS: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, alpha: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-binom_inv-member(1))|Returns the smallest value for which the cumulative binomial distribution is greater than or equal to a criterion value.| -||[bitand(number1: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, number2: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-bitand-member(1))|Returns a bitwise 'And' of two numbers.| -||[bitlshift(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, shiftAmount: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-bitlshift-member(1))|Returns a number shifted left by shift_amount bits.| -||[bitor(number1: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, number2: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-bitor-member(1))|Returns a bitwise 'Or' of two numbers.| -||[bitrshift(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, shiftAmount: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-bitrshift-member(1))|Returns a number shifted right by shift_amount bits.| -||[bitxor(number1: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, number2: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-bitxor-member(1))|Returns a bitwise 'Exclusive Or' of two numbers.| -||[ceiling_Math(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, significance?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, mode?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-ceiling_math-member(1))|Rounds a number up, to the nearest integer or to the nearest multiple of significance.| -||[ceiling_Precise(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, significance?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-ceiling_precise-member(1))|Rounds a number up, to the nearest integer or to the nearest multiple of significance.| -||[char(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-char-member(1))|Returns the character specified by the code number from the character set for your computer.| -||[chiSq_Dist(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-chisq_dist-member(1))|Returns the left-tailed probability of the chi-squared distribution.| -||[chiSq_Dist_RT(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-chisq_dist_rt-member(1))|Returns the right-tailed probability of the chi-squared distribution.| -||[chiSq_Inv(probability: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-chisq_inv-member(1))|Returns the inverse of the left-tailed probability of the chi-squared distribution.| -||[chiSq_Inv_RT(probability: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-chisq_inv_rt-member(1))|Returns the inverse of the right-tailed probability of the chi-squared distribution.| -||[choose(indexNum: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, ...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-choose-member(1))|Chooses a value or action to perform from a list of values, based on an index number.| -||[clean(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-clean-member(1))|Removes all nonprintable characters from text.| -||[code(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-code-member(1))|Returns a numeric code for the first character in a text string, in the character set used by your computer.| -||[columns(array: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-columns-member(1))|Returns the number of columns in an array or reference.| -||[combin(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numberChosen: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-combin-member(1))|Returns the number of combinations for a given number of items.| -||[combina(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numberChosen: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-combina-member(1))|Returns the number of combinations with repetitions for a given number of items.| -||[complex(realNum: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, iNum: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, suffix?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-complex-member(1))|Converts real and imaginary coefficients into a complex number.| -||[concatenate(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-concatenate-member(1))|Joins several text strings into one text string.| -||[confidence_Norm(alpha: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, standardDev: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, size: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-confidence_norm-member(1))|Returns the confidence interval for a population mean, using a normal distribution.| -||[confidence_T(alpha: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, standardDev: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, size: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-confidence_t-member(1))|Returns the confidence interval for a population mean, using a Student's T distribution.| -||[convert(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, fromUnit: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, toUnit: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-convert-member(1))|Converts a number from one measurement system to another.| -||[cos(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-cos-member(1))|Returns the cosine of an angle.| -||[cosh(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-cosh-member(1))|Returns the hyperbolic cosine of a number.| -||[cot(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-cot-member(1))|Returns the cotangent of an angle.| -||[coth(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-coth-member(1))|Returns the hyperbolic cotangent of a number.| -||[count(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-count-member(1))|Counts the number of cells in a range that contain numbers.| -||[countA(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-counta-member(1))|Counts the number of cells in a range that are not empty.| -||[countBlank(range: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-countblank-member(1))|Counts the number of empty cells in a specified range of cells.| -||[countIf(range: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-countif-member(1))|Counts the number of cells within a range that meet the given condition.| -||[countIfs(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-countifs-member(1))|Counts the number of cells specified by a given set of conditions or criteria.| -||[coupDayBs(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-coupdaybs-member(1))|Returns the number of days from the beginning of the coupon period to the settlement date.| -||[coupDays(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-coupdays-member(1))|Returns the number of days in the coupon period that contains the settlement date.| -||[coupDaysNc(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-coupdaysnc-member(1))|Returns the number of days from the settlement date to the next coupon date.| -||[coupNcd(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-coupncd-member(1))|Returns the next coupon date after the settlement date.| -||[coupNum(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-coupnum-member(1))|Returns the number of coupons payable between the settlement date and maturity date.| -||[coupPcd(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-couppcd-member(1))|Returns the previous coupon date before the settlement date.| -||[csc(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-csc-member(1))|Returns the cosecant of an angle.| -||[csch(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-csch-member(1))|Returns the hyperbolic cosecant of an angle.| -||[cumIPmt(rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, nper: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pv: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, startPeriod: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, endPeriod: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, type: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-cumipmt-member(1))|Returns the cumulative interest paid between two periods.| -||[cumPrinc(rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, nper: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pv: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, startPeriod: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, endPeriod: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, type: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-cumprinc-member(1))|Returns the cumulative principal paid on a loan between two periods.| -||[date(year: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, month: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, day: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-date-member(1))|Returns the number that represents the date in Microsoft Excel date-time code.| -||[datevalue(dateText: string \| number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-datevalue-member(1))|Converts a date in the form of text to a number that represents the date in Microsoft Excel date-time code.| -||[daverage(database: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, field: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-daverage-member(1))|Averages the values in a column in a list or database that match conditions you specify.| -||[day(serialNumber: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-day-member(1))|Returns the day of the month, a number from 1 to 31.| -||[days(endDate: string \| number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, startDate: string \| number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-days-member(1))|Returns the number of days between the two dates.| -||[days360(startDate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, endDate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, method?: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-days360-member(1))|Returns the number of days between two dates based on a 360-day year (twelve 30-day months).| -||[db(cost: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, salvage: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, life: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, period: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, month?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-db-member(1))|Returns the depreciation of an asset for a specified period using the fixed-declining balance method.| -||[dbcs(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-dbcs-member(1))|Changes half-width (single-byte) characters within a character string to full-width (double-byte) characters.| -||[dcount(database: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, field: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-dcount-member(1))|Counts the cells containing numbers in the field (column) of records in the database that match the conditions you specify.| -||[dcountA(database: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, field: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-dcounta-member(1))|Counts nonblank cells in the field (column) of records in the database that match the conditions you specify.| -||[ddb(cost: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, salvage: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, life: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, period: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, factor?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-ddb-member(1))|Returns the depreciation of an asset for a specified period using the double-declining balance method or some other method you specify.| -||[dec2Bin(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, places?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-dec2bin-member(1))|Converts a decimal number to binary.| -||[dec2Hex(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, places?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-dec2hex-member(1))|Converts a decimal number to hexadecimal.| -||[dec2Oct(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, places?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-dec2oct-member(1))|Converts a decimal number to octal.| -||[decimal(number: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, radix: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-decimal-member(1))|Converts a text representation of a number in a given base into a decimal number.| -||[degrees(angle: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-degrees-member(1))|Converts radians to degrees.| -||[delta(number1: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, number2?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-delta-member(1))|Tests whether two numbers are equal.| -||[devSq(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-devsq-member(1))|Returns the sum of squares of deviations of data points from their sample mean.| -||[dget(database: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, field: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-dget-member(1))|Extracts from a database a single record that matches the conditions you specify.| -||[disc(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pr: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, redemption: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-disc-member(1))|Returns the discount rate for a security.| -||[dmax(database: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, field: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-dmax-member(1))|Returns the largest number in the field (column) of records in the database that match the conditions you specify.| -||[dmin(database: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, field: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-dmin-member(1))|Returns the smallest number in the field (column) of records in the database that match the conditions you specify.| -||[dollar(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, decimals?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-dollar-member(1))|Converts a number to text, using currency format.| -||[dollarDe(fractionalDollar: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, fraction: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-dollarde-member(1))|Converts a dollar price, expressed as a fraction, into a dollar price, expressed as a decimal number.| -||[dollarFr(decimalDollar: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, fraction: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-dollarfr-member(1))|Converts a dollar price, expressed as a decimal number, into a dollar price, expressed as a fraction.| -||[dproduct(database: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, field: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-dproduct-member(1))|Multiplies the values in the field (column) of records in the database that match the conditions you specify.| -||[dstDev(database: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, field: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-dstdev-member(1))|Estimates the standard deviation based on a sample from selected database entries.| -||[dstDevP(database: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, field: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-dstdevp-member(1))|Calculates the standard deviation based on the entire population of selected database entries.| -||[dsum(database: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, field: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-dsum-member(1))|Adds the numbers in the field (column) of records in the database that match the conditions you specify.| -||[duration(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, coupon: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, yld: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-duration-member(1))|Returns the annual duration of a security with periodic interest payments.| -||[dvar(database: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, field: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-dvar-member(1))|Estimates variance based on a sample from selected database entries.| -||[dvarP(database: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, field: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-dvarp-member(1))|Calculates variance based on the entire population of selected database entries.| -||[ecma_Ceiling(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, significance: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-ecma_ceiling-member(1))|Rounds a number up, to the nearest integer or to the nearest multiple of significance.| -||[edate(startDate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, months: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-edate-member(1))|Returns the serial number of the date that is the indicated number of months before or after the start date.| -||[effect(nominalRate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, npery: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-effect-member(1))|Returns the effective annual interest rate.| -||[eoMonth(startDate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, months: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-eomonth-member(1))|Returns the serial number of the last day of the month before or after a specified number of months.| -||[erf(lowerLimit: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, upperLimit?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-erf-member(1))|Returns the error function.| -||[erfC(x: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-erfc-member(1))|Returns the complementary error function.| -||[erfC_Precise(X: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-erfc_precise-member(1))|Returns the complementary error function.| -||[erf_Precise(X: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-erf_precise-member(1))|Returns the error function.| -||[error_Type(errorVal: string \| number \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-error_type-member(1))|Returns a number matching an error value.| -||[even(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-even-member(1))|Rounds a positive number up and negative number down to the nearest even integer.| -||[exact(text1: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, text2: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-exact-member(1))|Checks whether two text strings are exactly the same, and returns TRUE or FALSE.| -||[exp(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-exp-member(1))|Returns e raised to the power of a given number.| -||[expon_Dist(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, lambda: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-expon_dist-member(1))|Returns the exponential distribution.| -||[f_Dist(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom1: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom2: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-f_dist-member(1))|Returns the (left-tailed) F probability distribution (degree of diversity) for two data sets.| -||[f_Dist_RT(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom1: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom2: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-f_dist_rt-member(1))|Returns the (right-tailed) F probability distribution (degree of diversity) for two data sets.| -||[f_Inv(probability: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom1: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom2: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-f_inv-member(1))|Returns the inverse of the (left-tailed) F probability distribution: if p = F.DIST(x,...), then F.INV(p,...) = x.| -||[f_Inv_RT(probability: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom1: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom2: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-f_inv_rt-member(1))|Returns the inverse of the (right-tailed) F probability distribution: if p = F.DIST.RT(x,...), then F.INV.RT(p,...) = x.| -||[fact(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-fact-member(1))|Returns the factorial of a number, equal to 1*2*3*...* Number.| -||[factDouble(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-factdouble-member(1))|Returns the double factorial of a number.| -||[false()](/javascript/api/excel/excel.functions#excel-excel-functions-false-member(1))|Returns the logical value FALSE.| -||[find(findText: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, withinText: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, startNum?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-find-member(1))|Returns the starting position of one text string within another text string.| -||[findB(findText: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, withinText: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, startNum?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-findb-member(1))|Finds the starting position of one text string within another text string.| -||[fisher(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-fisher-member(1))|Returns the Fisher transformation.| -||[fisherInv(y: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-fisherinv-member(1))|Returns the inverse of the Fisher transformation: if y = FISHER(x), then FISHERINV(y) = x.| -||[fixed(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, decimals?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, noCommas?: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-fixed-member(1))|Rounds a number to the specified number of decimals and returns the result as text with or without commas.| -||[floor_Math(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, significance?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, mode?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-floor_math-member(1))|Rounds a number down, to the nearest integer or to the nearest multiple of significance.| -||[floor_Precise(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, significance?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-floor_precise-member(1))|Rounds a number down, to the nearest integer or to the nearest multiple of significance.| -||[fv(rate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, nper: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pmt: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pv?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, type?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-fv-member(1))|Returns the future value of an investment based on periodic, constant payments and a constant interest rate.| -||[fvschedule(principal: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, schedule: number \| string \| Excel.Range \| boolean \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-fvschedule-member(1))|Returns the future value of an initial principal after applying a series of compound interest rates.| -||[gamma(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-gamma-member(1))|Returns the Gamma function value.| -||[gammaLn(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-gammaln-member(1))|Returns the natural logarithm of the gamma function.| -||[gammaLn_Precise(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-gammaln_precise-member(1))|Returns the natural logarithm of the gamma function.| -||[gamma_Dist(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, alpha: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, beta: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-gamma_dist-member(1))|Returns the gamma distribution.| -||[gamma_Inv(probability: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, alpha: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, beta: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-gamma_inv-member(1))|Returns the inverse of the gamma cumulative distribution: if p = GAMMA.DIST(x,...), then GAMMA.INV(p,...) = x.| -||[gauss(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-gauss-member(1))|Returns 0.5 less than the standard normal cumulative distribution.| -||[gcd(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-gcd-member(1))|Returns the greatest common divisor.| -||[geStep(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, step?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-gestep-member(1))|Tests whether a number is greater than a threshold value.| -||[geoMean(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-geomean-member(1))|Returns the geometric mean of an array or range of positive numeric data.| -||[harMean(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-harmean-member(1))|Returns the harmonic mean of a data set of positive numbers: the reciprocal of the arithmetic mean of reciprocals.| -||[hex2Bin(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, places?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-hex2bin-member(1))|Converts a Hexadecimal number to binary.| -||[hex2Dec(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-hex2dec-member(1))|Converts a hexadecimal number to decimal.| -||[hex2Oct(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, places?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-hex2oct-member(1))|Converts a hexadecimal number to octal.| -||[hlookup(lookupValue: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, tableArray: Excel.Range \| number \| Excel.RangeReference \| Excel.FunctionResult, rowIndexNum: Excel.Range \| number \| Excel.RangeReference \| Excel.FunctionResult, rangeLookup?: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-hlookup-member(1))|Looks for a value in the top row of a table or array of values and returns the value in the same column from a row you specify.| -||[hour(serialNumber: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-hour-member(1))|Returns the hour as a number from 0 (12:00 A.M.) to 23 (11:00 P.M.).| -||[hypGeom_Dist(sampleS: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numberSample: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, populationS: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numberPop: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-hypgeom_dist-member(1))|Returns the hypergeometric distribution.| -||[hyperlink(linkLocation: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, friendlyName?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-hyperlink-member(1))|Creates a shortcut or jump that opens a document stored on your hard drive, a network server, or on the Internet.| -||[if(logicalTest: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, valueIfTrue?: Excel.Range \| number \| string \| boolean \| Excel.RangeReference \| Excel.FunctionResult, valueIfFalse?: Excel.Range \| number \| string \| boolean \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-if-member(1))|Checks whether a condition is met, and returns one value if TRUE, and another value if FALSE.| -||[imAbs(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-imabs-member(1))|Returns the absolute value (modulus) of a complex number.| -||[imArgument(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-imargument-member(1))|Returns the argument q, an angle expressed in radians.| -||[imConjugate(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-imconjugate-member(1))|Returns the complex conjugate of a complex number.| -||[imCos(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-imcos-member(1))|Returns the cosine of a complex number.| -||[imCosh(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-imcosh-member(1))|Returns the hyperbolic cosine of a complex number.| -||[imCot(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-imcot-member(1))|Returns the cotangent of a complex number.| -||[imCsc(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-imcsc-member(1))|Returns the cosecant of a complex number.| -||[imCsch(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-imcsch-member(1))|Returns the hyperbolic cosecant of a complex number.| -||[imDiv(inumber1: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, inumber2: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-imdiv-member(1))|Returns the quotient of two complex numbers.| -||[imExp(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-imexp-member(1))|Returns the exponential of a complex number.| -||[imLn(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-imln-member(1))|Returns the natural logarithm of a complex number.| -||[imLog10(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-imlog10-member(1))|Returns the base-10 logarithm of a complex number.| -||[imLog2(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-imlog2-member(1))|Returns the base-2 logarithm of a complex number.| -||[imPower(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-impower-member(1))|Returns a complex number raised to an integer power.| -||[imProduct(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-improduct-member(1))|Returns the product of 1 to 255 complex numbers.| -||[imReal(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-imreal-member(1))|Returns the real coefficient of a complex number.| -||[imSec(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-imsec-member(1))|Returns the secant of a complex number.| -||[imSech(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-imsech-member(1))|Returns the hyperbolic secant of a complex number.| -||[imSin(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-imsin-member(1))|Returns the sine of a complex number.| -||[imSinh(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-imsinh-member(1))|Returns the hyperbolic sine of a complex number.| -||[imSqrt(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-imsqrt-member(1))|Returns the square root of a complex number.| -||[imSub(inumber1: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, inumber2: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-imsub-member(1))|Returns the difference of two complex numbers.| -||[imSum(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-imsum-member(1))|Returns the sum of complex numbers.| -||[imTan(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-imtan-member(1))|Returns the tangent of a complex number.| -||[imaginary(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-imaginary-member(1))|Returns the imaginary coefficient of a complex number.| -||[int(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-int-member(1))|Rounds a number down to the nearest integer.| -||[intRate(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, investment: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, redemption: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-intrate-member(1))|Returns the interest rate for a fully invested security.| -||[ipmt(rate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, per: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, nper: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pv: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, fv?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, type?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-ipmt-member(1))|Returns the interest payment for a given period for an investment, based on periodic, constant payments and a constant interest rate.| -||[irr(values: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, guess?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-irr-member(1))|Returns the internal rate of return for a series of cash flows.| -||[isErr(value: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-iserr-member(1))|Checks whether a value is an error other than #N/A, and returns TRUE or FALSE.| -||[isError(value: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-iserror-member(1))|Checks whether a value is an error, and returns TRUE or FALSE.| -||[isEven(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-iseven-member(1))|Returns TRUE if the number is even.| -||[isFormula(reference: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-isformula-member(1))|Checks whether a reference is to a cell containing a formula, and returns TRUE or FALSE.| -||[isLogical(value: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-islogical-member(1))|Checks whether a value is a logical value (TRUE or FALSE), and returns TRUE or FALSE.| -||[isNA(value: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-isna-member(1))|Checks whether a value is #N/A, and returns TRUE or FALSE.| -||[isNonText(value: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-isnontext-member(1))|Checks whether a value is not text (blank cells are not text), and returns TRUE or FALSE.| -||[isNumber(value: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-isnumber-member(1))|Checks whether a value is a number, and returns TRUE or FALSE.| -||[isOdd(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-isodd-member(1))|Returns TRUE if the number is odd.| -||[isText(value: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-istext-member(1))|Checks whether a value is text, and returns TRUE or FALSE.| -||[isoWeekNum(date: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-isoweeknum-member(1))|Returns the ISO week number in the year for a given date.| -||[iso_Ceiling(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, significance?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-iso_ceiling-member(1))|Rounds a number up, to the nearest integer or to the nearest multiple of significance.| -||[ispmt(rate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, per: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, nper: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pv: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-ispmt-member(1))|Returns the interest paid during a specific period of an investment.| -||[isref(value: Excel.Range \| number \| string \| boolean \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-isref-member(1))|Checks whether a value is a reference, and returns TRUE or FALSE.| -||[kurt(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-kurt-member(1))|Returns the kurtosis of a data set.| -||[large(array: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, k: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-large-member(1))|Returns the k-th largest value in a data set.| -||[lcm(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-lcm-member(1))|Returns the least common multiple.| -||[left(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numChars?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-left-member(1))|Returns the specified number of characters from the start of a text string.| -||[leftb(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numBytes?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-leftb-member(1))|Returns the specified number of characters from the start of a text string.| -||[len(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-len-member(1))|Returns the number of characters in a text string.| -||[lenb(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-lenb-member(1))|Returns the number of characters in a text string.| -||[ln(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-ln-member(1))|Returns the natural logarithm of a number.| -||[log(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, base?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-log-member(1))|Returns the logarithm of a number to the base you specify.| -||[log10(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-log10-member(1))|Returns the base-10 logarithm of a number.| -||[logNorm_Dist(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, mean: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, standardDev: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-lognorm_dist-member(1))|Returns the lognormal distribution of x, where ln(x) is normally distributed with parameters Mean and Standard_dev.| -||[logNorm_Inv(probability: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, mean: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, standardDev: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-lognorm_inv-member(1))|Returns the inverse of the lognormal cumulative distribution function of x, where ln(x) is normally distributed with parameters Mean and Standard_dev.| -||[lookup(lookupValue: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, lookupVector: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, resultVector?: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-lookup-member(1))|Looks up a value either from a one-row or one-column range or from an array.| -||[lower(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-lower-member(1))|Converts all letters in a text string to lowercase.| -||[match(lookupValue: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, lookupArray: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, matchType?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-match-member(1))|Returns the relative position of an item in an array that matches a specified value in a specified order.| -||[max(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-max-member(1))|Returns the largest value in a set of values.| -||[maxA(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-maxa-member(1))|Returns the largest value in a set of values.| -||[mduration(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, coupon: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, yld: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-mduration-member(1))|Returns the Macauley modified duration for a security with an assumed par value of $100.| -||[median(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-median-member(1))|Returns the median, or the number in the middle of the set of given numbers.| -||[mid(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, startNum: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numChars: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-mid-member(1))|Returns the characters from the middle of a text string, given a starting position and length.| -||[midb(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, startNum: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numBytes: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-midb-member(1))|Returns characters from the middle of a text string, given a starting position and length.| -||[min(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-min-member(1))|Returns the smallest number in a set of values.| -||[minA(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-mina-member(1))|Returns the smallest value in a set of values.| -||[minute(serialNumber: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-minute-member(1))|Returns the minute, a number from 0 to 59.| -||[mirr(values: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, financeRate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, reinvestRate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-mirr-member(1))|Returns the internal rate of return for a series of periodic cash flows, considering both cost of investment and interest on reinvestment of cash.| -||[mod(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, divisor: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-mod-member(1))|Returns the remainder after a number is divided by a divisor.| -||[month(serialNumber: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-month-member(1))|Returns the month, a number from 1 (January) to 12 (December).| -||[mround(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, multiple: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-mround-member(1))|Returns a number rounded to the desired multiple.| -||[multiNomial(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-multinomial-member(1))|Returns the multinomial of a set of numbers.| -||[n(value: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-n-member(1))|Converts non-number value to a number, dates to serial numbers, TRUE to 1, anything else to 0 (zero).| -||[na()](/javascript/api/excel/excel.functions#excel-excel-functions-na-member(1))|Returns the error value #N/A (value not available).| -||[negBinom_Dist(numberF: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numberS: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, probabilityS: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-negbinom_dist-member(1))|Returns the negative binomial distribution, the probability that there will be Number_f failures before the Number_s-th success, with Probability_s probability of a success.| -||[networkDays(startDate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, endDate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, holidays?: number \| string \| Excel.Range \| boolean \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-networkdays-member(1))|Returns the number of whole workdays between two dates.| -||[networkDays_Intl(startDate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, endDate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, weekend?: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, holidays?: number \| string \| Excel.Range \| boolean \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-networkdays_intl-member(1))|Returns the number of whole workdays between two dates with custom weekend parameters.| -||[nominal(effectRate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, npery: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-nominal-member(1))|Returns the annual nominal interest rate.| -||[norm_Dist(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, mean: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, standardDev: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-norm_dist-member(1))|Returns the normal distribution for the specified mean and standard deviation.| -||[norm_Inv(probability: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, mean: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, standardDev: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-norm_inv-member(1))|Returns the inverse of the normal cumulative distribution for the specified mean and standard deviation.| -||[norm_S_Dist(z: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-norm_s_dist-member(1))|Returns the standard normal distribution (has a mean of zero and a standard deviation of one).| -||[norm_S_Inv(probability: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-norm_s_inv-member(1))|Returns the inverse of the standard normal cumulative distribution (has a mean of zero and a standard deviation of one).| -||[not(logical: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-not-member(1))|Changes FALSE to TRUE, or TRUE to FALSE.| -||[now()](/javascript/api/excel/excel.functions#excel-excel-functions-now-member(1))|Returns the current date and time formatted as a date and time.| -||[nper(rate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pmt: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pv: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, fv?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, type?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-nper-member(1))|Returns the number of periods for an investment based on periodic, constant payments and a constant interest rate.| -||[npv(rate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, ...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-npv-member(1))|Returns the net present value of an investment based on a discount rate and a series of future payments (negative values) and income (positive values).| -||[numberValue(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, decimalSeparator?: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, groupSeparator?: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-numbervalue-member(1))|Converts text to number in a locale-independent manner.| -||[oct2Bin(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, places?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-oct2bin-member(1))|Converts an octal number to binary.| -||[oct2Dec(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-oct2dec-member(1))|Converts an octal number to decimal.| -||[oct2Hex(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, places?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-oct2hex-member(1))|Converts an octal number to hexadecimal.| -||[odd(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-odd-member(1))|Rounds a positive number up and negative number down to the nearest odd integer.| -||[oddFPrice(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, issue: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, firstCoupon: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, yld: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, redemption: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-oddfprice-member(1))|Returns the price per $100 face value of a security with an odd first period.| -||[oddFYield(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, issue: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, firstCoupon: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pr: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, redemption: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-oddfyield-member(1))|Returns the yield of a security with an odd first period.| -||[oddLPrice(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, lastInterest: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, yld: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, redemption: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-oddlprice-member(1))|Returns the price per $100 face value of a security with an odd last period.| -||[oddLYield(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, lastInterest: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pr: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, redemption: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-oddlyield-member(1))|Returns the yield of a security with an odd last period.| -||[or(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-or-member(1))|Checks whether any of the arguments are TRUE, and returns TRUE or FALSE.| -||[pduration(rate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pv: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, fv: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-pduration-member(1))|Returns the number of periods required by an investment to reach a specified value.| -||[percentRank_Exc(array: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, significance?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-percentrank_exc-member(1))|Returns the rank of a value in a data set as a percentage (0..1, exclusive) of the data set.| -||[percentRank_Inc(array: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, significance?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-percentrank_inc-member(1))|Returns the rank of a value in a data set as a percentage (0..1, inclusive) of the data set.| -||[percentile_Exc(array: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, k: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-percentile_exc-member(1))|Returns the k-th percentile of values in a range, where k is in the range 0..1, exclusive.| -||[percentile_Inc(array: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, k: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-percentile_inc-member(1))|Returns the k-th percentile of values in a range, where k is in the range 0..1, inclusive.| -||[permut(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numberChosen: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-permut-member(1))|Returns the number of permutations for a given number of objects that can be selected from the total objects.| -||[permutationa(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numberChosen: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-permutationa-member(1))|Returns the number of permutations for a given number of objects (with repetitions) that can be selected from the total objects.| -||[phi(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-phi-member(1))|Returns the value of the density function for a standard normal distribution.| -||[pi()](/javascript/api/excel/excel.functions#excel-excel-functions-pi-member(1))|Returns the value of Pi, 3.14159265358979, accurate to 15 digits.| -||[pmt(rate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, nper: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pv: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, fv?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, type?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-pmt-member(1))|Calculates the payment for a loan based on constant payments and a constant interest rate.| -||[poisson_Dist(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, mean: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-poisson_dist-member(1))|Returns the Poisson distribution.| -||[power(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, power: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-power-member(1))|Returns the result of a number raised to a power.| -||[ppmt(rate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, per: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, nper: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pv: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, fv?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, type?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-ppmt-member(1))|Returns the payment on the principal for a given investment based on periodic, constant payments and a constant interest rate.| -||[price(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, yld: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, redemption: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-price-member(1))|Returns the price per $100 face value of a security that pays periodic interest.| -||[priceDisc(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, discount: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, redemption: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-pricedisc-member(1))|Returns the price per $100 face value of a discounted security.| -||[priceMat(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, issue: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, yld: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-pricemat-member(1))|Returns the price per $100 face value of a security that pays interest at maturity.| -||[product(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-product-member(1))|Multiplies all the numbers given as arguments.| -||[proper(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-proper-member(1))|Converts a text string to proper case; the first letter in each word to uppercase, and all other letters to lowercase.| -||[pv(rate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, nper: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pmt: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, fv?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, type?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-pv-member(1))|Returns the present value of an investment: the total amount that a series of future payments is worth now.| -||[quartile_Exc(array: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, quart: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-quartile_exc-member(1))|Returns the quartile of a data set, based on percentile values from 0..1, exclusive.| -||[quartile_Inc(array: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, quart: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-quartile_inc-member(1))|Returns the quartile of a data set, based on percentile values from 0..1, inclusive.| -||[quotient(numerator: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, denominator: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-quotient-member(1))|Returns the integer portion of a division.| -||[radians(angle: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-radians-member(1))|Converts degrees to radians.| -||[rand()](/javascript/api/excel/excel.functions#excel-excel-functions-rand-member(1))|Returns a random number greater than or equal to 0 and less than 1, evenly distributed (changes on recalculation).| -||[randBetween(bottom: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, top: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-randbetween-member(1))|Returns a random number between the numbers you specify.| -||[rank_Avg(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, ref: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, order?: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-rank_avg-member(1))|Returns the rank of a number in a list of numbers: its size relative to other values in the list; if more than one value has the same rank, the average rank is returned.| -||[rank_Eq(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, ref: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, order?: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-rank_eq-member(1))|Returns the rank of a number in a list of numbers: its size relative to other values in the list; if more than one value has the same rank, the top rank of that set of values is returned.| -||[rate(nper: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pmt: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pv: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, fv?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, type?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, guess?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-rate-member(1))|Returns the interest rate per period of a loan or an investment.| -||[received(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, investment: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, discount: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-received-member(1))|Returns the amount received at maturity for a fully invested security.| -||[replace(oldText: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, startNum: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numChars: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, newText: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-replace-member(1))|Replaces part of a text string with a different text string.| -||[replaceB(oldText: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, startNum: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numBytes: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, newText: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-replaceb-member(1))|Replaces part of a text string with a different text string.| -||[rept(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numberTimes: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-rept-member(1))|Repeats text a given number of times.| -||[right(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numChars?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-right-member(1))|Returns the specified number of characters from the end of a text string.| -||[rightb(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numBytes?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-rightb-member(1))|Returns the specified number of characters from the end of a text string.| -||[roman(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, form?: boolean \| number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-roman-member(1))|Converts an Arabic numeral to Roman, as text.| -||[round(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numDigits: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-round-member(1))|Rounds a number to a specified number of digits.| -||[roundDown(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numDigits: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-rounddown-member(1))|Rounds a number down, toward zero.| -||[roundUp(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numDigits: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-roundup-member(1))|Rounds a number up, away from zero.| -||[rows(array: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-rows-member(1))|Returns the number of rows in a reference or array.| -||[rri(nper: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pv: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, fv: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-rri-member(1))|Returns an equivalent interest rate for the growth of an investment.| -||[sec(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-sec-member(1))|Returns the secant of an angle.| -||[sech(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-sech-member(1))|Returns the hyperbolic secant of an angle.| -||[second(serialNumber: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-second-member(1))|Returns the second, a number from 0 to 59.| -||[seriesSum(x: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, n: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, m: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, coefficients: Excel.Range \| string \| number \| boolean \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-seriessum-member(1))|Returns the sum of a power series based on the formula.| -||[sheet(value?: Excel.Range \| string \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-sheet-member(1))|Returns the sheet number of the referenced sheet.| -||[sheets(reference?: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-sheets-member(1))|Returns the number of sheets in a reference.| -||[sign(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-sign-member(1))|Returns the sign of a number: 1 if the number is positive, zero if the number is zero, or -1 if the number is negative.| -||[sin(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-sin-member(1))|Returns the sine of an angle.| -||[sinh(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-sinh-member(1))|Returns the hyperbolic sine of a number.| -||[skew(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-skew-member(1))|Returns the skewness of a distribution: a characterization of the degree of asymmetry of a distribution around its mean.| -||[skew_p(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-skew_p-member(1))|Returns the skewness of a distribution based on a population: a characterization of the degree of asymmetry of a distribution around its mean.| -||[sln(cost: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, salvage: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, life: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-sln-member(1))|Returns the straight-line depreciation of an asset for one period.| -||[small(array: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, k: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-small-member(1))|Returns the k-th smallest value in a data set.| -||[sqrt(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-sqrt-member(1))|Returns the square root of a number.| -||[sqrtPi(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-sqrtpi-member(1))|Returns the square root of (number * Pi).| -||[stDevA(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-stdeva-member(1))|Estimates standard deviation based on a sample, including logical values and text.| -||[stDevPA(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-stdevpa-member(1))|Calculates standard deviation based on an entire population, including logical values and text.| -||[stDev_P(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-stdev_p-member(1))|Calculates standard deviation based on the entire population given as arguments (ignores logical values and text).| -||[stDev_S(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-stdev_s-member(1))|Estimates standard deviation based on a sample (ignores logical values and text in the sample).| -||[standardize(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, mean: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, standardDev: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-standardize-member(1))|Returns a normalized value from a distribution characterized by a mean and standard deviation.| -||[substitute(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, oldText: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, newText: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, instanceNum?: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-substitute-member(1))|Replaces existing text with new text in a text string.| -||[subtotal(functionNum: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, ...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-subtotal-member(1))|Returns a subtotal in a list or database.| -||[sum(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-sum-member(1))|Adds all the numbers in a range of cells.| -||[sumIf(range: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, sumRange?: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-sumif-member(1))|Adds the cells specified by a given condition or criteria.| -||[sumIfs(sumRange: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, ...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-sumifs-member(1))|Adds the cells specified by a given set of conditions or criteria.| -||[sumSq(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-sumsq-member(1))|Returns the sum of the squares of the arguments.| -||[syd(cost: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, salvage: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, life: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, per: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-syd-member(1))|Returns the sum-of-years' digits depreciation of an asset for a specified period.| -||[t(value: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-t-member(1))|Checks whether a value is text, and returns the text if it is, or returns double quotes (empty text) if it is not.| -||[t_Dist(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-t_dist-member(1))|Returns the left-tailed Student's t-distribution.| -||[t_Dist_2T(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-t_dist_2t-member(1))|Returns the two-tailed Student's t-distribution.| -||[t_Dist_RT(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-t_dist_rt-member(1))|Returns the right-tailed Student's t-distribution.| -||[t_Inv(probability: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-t_inv-member(1))|Returns the left-tailed inverse of the Student's t-distribution.| -||[t_Inv_2T(probability: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-t_inv_2t-member(1))|Returns the two-tailed inverse of the Student's t-distribution.| -||[tan(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-tan-member(1))|Returns the tangent of an angle.| -||[tanh(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-tanh-member(1))|Returns the hyperbolic tangent of a number.| -||[tbillEq(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, discount: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-tbilleq-member(1))|Returns the bond-equivalent yield for a treasury bill.| -||[tbillPrice(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, discount: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-tbillprice-member(1))|Returns the price per $100 face value for a treasury bill.| -||[tbillYield(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pr: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-tbillyield-member(1))|Returns the yield for a treasury bill.| -||[text(value: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, formatText: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-text-member(1))|Converts a value to text in a specific number format.| -||[time(hour: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, minute: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, second: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-time-member(1))|Converts hours, minutes, and seconds given as numbers to an Excel serial number, formatted with a time format.| -||[timevalue(timeText: string \| number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-timevalue-member(1))|Converts a text time to an Excel serial number for a time, a number from 0 (12:00:00 AM) to 0.999988426 (11:59:59 PM).| -||[today()](/javascript/api/excel/excel.functions#excel-excel-functions-today-member(1))|Returns the current date formatted as a date.| -||[trim(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-trim-member(1))|Removes all spaces from a text string except for single spaces between words.| -||[trimMean(array: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, percent: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-trimmean-member(1))|Returns the mean of the interior portion of a set of data values.| -||[true()](/javascript/api/excel/excel.functions#excel-excel-functions-true-member(1))|Returns the logical value TRUE.| -||[trunc(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numDigits?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-trunc-member(1))|Truncates a number to an integer by removing the decimal, or fractional, part of the number.| -||[type(value: boolean \| string \| number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-type-member(1))|Returns an integer representing the data type of a value: number = 1; text = 2; logical value = 4; error value = 16; array = 64; compound data = 128.| -||[unichar(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-unichar-member(1))|Returns the Unicode character referenced by the given numeric value.| -||[unicode(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-unicode-member(1))|Returns the number (code point) corresponding to the first character of the text.| -||[upper(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-upper-member(1))|Converts a text string to all uppercase letters.| -||[usdollar(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, decimals?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-usdollar-member(1))|Converts a number to text, using currency format.| -||[value(text: string \| boolean \| number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-value-member(1))|Converts a text string that represents a number to a number.| -||[varA(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-vara-member(1))|Estimates variance based on a sample, including logical values and text.| -||[varPA(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-varpa-member(1))|Calculates variance based on the entire population, including logical values and text.| -||[var_P(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-var_p-member(1))|Calculates variance based on the entire population (ignores logical values and text in the population).| -||[var_S(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-var_s-member(1))|Estimates variance based on a sample (ignores logical values and text in the sample).| -||[vdb(cost: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, salvage: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, life: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, startPeriod: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, endPeriod: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, factor?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, noSwitch?: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-vdb-member(1))|Returns the depreciation of an asset for any period you specify, including partial periods, using the double-declining balance method or some other method you specify.| -||[vlookup(lookupValue: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, tableArray: Excel.Range \| number \| Excel.RangeReference \| Excel.FunctionResult, colIndexNum: Excel.Range \| number \| Excel.RangeReference \| Excel.FunctionResult, rangeLookup?: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-vlookup-member(1))|Looks for a value in the leftmost column of a table, and then returns a value in the same row from a column you specify.| -||[weekNum(serialNumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, returnType?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-weeknum-member(1))|Returns the week number in the year.| -||[weekday(serialNumber: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, returnType?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-weekday-member(1))|Returns a number from 1 to 7 identifying the day of the week of a date.| -||[weibull_Dist(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, alpha: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, beta: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-weibull_dist-member(1))|Returns the Weibull distribution.| -||[workDay(startDate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, days: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, holidays?: number \| string \| Excel.Range \| boolean \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-workday-member(1))|Returns the serial number of the date before or after a specified number of workdays.| -||[workDay_Intl(startDate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, days: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, weekend?: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, holidays?: number \| string \| Excel.Range \| boolean \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-workday_intl-member(1))|Returns the serial number of the date before or after a specified number of workdays with custom weekend parameters.| -||[xirr(values: number \| string \| Excel.Range \| boolean \| Excel.RangeReference \| Excel.FunctionResult, dates: number \| string \| Excel.Range \| boolean \| Excel.RangeReference \| Excel.FunctionResult, guess?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-xirr-member(1))|Returns the internal rate of return for a schedule of cash flows.| -||[xnpv(rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, values: number \| string \| Excel.Range \| boolean \| Excel.RangeReference \| Excel.FunctionResult, dates: number \| string \| Excel.Range \| boolean \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-xnpv-member(1))|Returns the net present value for a schedule of cash flows.| -||[xor(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-xor-member(1))|Returns a logical 'Exclusive Or' of all arguments.| -||[year(serialNumber: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-year-member(1))|Returns the year of a date, an integer in the range 1900 - 9999.| -||[yearFrac(startDate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, endDate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-yearfrac-member(1))|Returns the year fraction representing the number of whole days between start_date and end_date.| -||[yield(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pr: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, redemption: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-yield-member(1))|Returns the yield on a security that pays periodic interest.| -||[yieldDisc(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pr: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, redemption: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-yielddisc-member(1))|Returns the annual yield for a discounted security.| -||[yieldMat(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, issue: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pr: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-yieldmat-member(1))|Returns the annual yield of a security that pays interest at maturity.| -||[z_Test(array: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, sigma?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-z_test-member(1))|Returns the one-tailed P-value of a z-test.| -|[Icon](/javascript/api/excel/excel.icon)|[index](/javascript/api/excel/excel.icon#excel-excel-icon-index-member)|Specifies the index of the icon in the given set.| -|[IconCollections](/javascript/api/excel/excel.iconcollections)|[fiveArrows](/javascript/api/excel/excel.iconcollections#excel-excel-iconcollections-fivearrows-member)|| -||[fiveArrowsGray](/javascript/api/excel/excel.iconcollections#excel-excel-iconcollections-fivearrowsgray-member)|| -||[fiveBoxes](/javascript/api/excel/excel.iconcollections#excel-excel-iconcollections-fiveboxes-member)|[Api set: ExcelApi 1.2]| -||[fiveQuarters](/javascript/api/excel/excel.iconcollections#excel-excel-iconcollections-fivequarters-member)|| -||[fiveRating](/javascript/api/excel/excel.iconcollections#excel-excel-iconcollections-fiverating-member)|| -||[fourArrows](/javascript/api/excel/excel.iconcollections#excel-excel-iconcollections-fourarrows-member)|| -||[fourArrowsGray](/javascript/api/excel/excel.iconcollections#excel-excel-iconcollections-fourarrowsgray-member)|| -||[fourRating](/javascript/api/excel/excel.iconcollections#excel-excel-iconcollections-fourrating-member)|| -||[fourRedToBlack](/javascript/api/excel/excel.iconcollections#excel-excel-iconcollections-fourredtoblack-member)|| -||[fourTrafficLights](/javascript/api/excel/excel.iconcollections#excel-excel-iconcollections-fourtrafficlights-member)|| -||[threeArrows](/javascript/api/excel/excel.iconcollections#excel-excel-iconcollections-threearrows-member)|| -||[threeArrowsGray](/javascript/api/excel/excel.iconcollections#excel-excel-iconcollections-threearrowsgray-member)|| -||[threeFlags](/javascript/api/excel/excel.iconcollections#excel-excel-iconcollections-threeflags-member)|| -||[threeSigns](/javascript/api/excel/excel.iconcollections#excel-excel-iconcollections-threesigns-member)|| -||[threeStars](/javascript/api/excel/excel.iconcollections#excel-excel-iconcollections-threestars-member)|| -||[threeSymbols2](/javascript/api/excel/excel.iconcollections#excel-excel-iconcollections-threesymbols2-member)|| -||[threeSymbols](/javascript/api/excel/excel.iconcollections#excel-excel-iconcollections-threesymbols-member)|| -||[threeTrafficLights1](/javascript/api/excel/excel.iconcollections#excel-excel-iconcollections-threetrafficlights1-member)|| -||[threeTrafficLights2](/javascript/api/excel/excel.iconcollections#excel-excel-iconcollections-threetrafficlights2-member)|| -||[threeTriangles](/javascript/api/excel/excel.iconcollections#excel-excel-iconcollections-threetriangles-member)|| -|[Range](/javascript/api/excel/excel.range)|[columnHidden](/javascript/api/excel/excel.range#excel-excel-range-columnhidden-member)|Represents if all columns in the current range are hidden.| -||[formulasR1C1](/javascript/api/excel/excel.range#excel-excel-range-formulasr1c1-member)|Represents the formula in R1C1-style notation.| -||[getColumnsAfter(count?: number)](/javascript/api/excel/excel.range#excel-excel-range-getcolumnsafter-member(1))|Gets a certain number of columns to the right of the current `Range` object.| -||[getColumnsBefore(count?: number)](/javascript/api/excel/excel.range#excel-excel-range-getcolumnsbefore-member(1))|Gets a certain number of columns to the left of the current `Range` object.| -||[getResizedRange(deltaRows: number, deltaColumns: number)](/javascript/api/excel/excel.range#excel-excel-range-getresizedrange-member(1))|Gets a `Range` object similar to the current `Range` object, but with its bottom-right corner expanded (or contracted) by some number of rows and columns.| -||[getRowsAbove(count?: number)](/javascript/api/excel/excel.range#excel-excel-range-getrowsabove-member(1))|Gets a certain number of rows above the current `Range` object.| -||[getRowsBelow(count?: number)](/javascript/api/excel/excel.range#excel-excel-range-getrowsbelow-member(1))|Gets a certain number of rows below the current `Range` object.| -||[getUsedRange(valuesOnly?: boolean)](/javascript/api/excel/excel.range#excel-excel-range-getusedrange-member(1))|Returns the used range of the given range object.| -||[hidden](/javascript/api/excel/excel.range#excel-excel-range-hidden-member)|Represents if all cells in the current range are hidden.| -||[merge(across?: boolean)](/javascript/api/excel/excel.range#excel-excel-range-merge-member(1))|Merge the range cells into one region in the worksheet.| -||[rowHidden](/javascript/api/excel/excel.range#excel-excel-range-rowhidden-member)|Represents if all rows in the current range are hidden.| -||[sort](/javascript/api/excel/excel.range#excel-excel-range-sort-member)|Represents the range sort of the current range.| -||[unmerge()](/javascript/api/excel/excel.range#excel-excel-range-unmerge-member(1))|Unmerge the range cells into separate cells.| -|[RangeFormat](/javascript/api/excel/excel.rangeformat)|[autofitColumns()](/javascript/api/excel/excel.rangeformat#excel-excel-rangeformat-autofitcolumns-member(1))|Changes the width of the columns of the current range to achieve the best fit, based on the current data in the columns.| -||[autofitRows()](/javascript/api/excel/excel.rangeformat#excel-excel-rangeformat-autofitrows-member(1))|Changes the height of the rows of the current range to achieve the best fit, based on the current data in the columns.| -||[columnWidth](/javascript/api/excel/excel.rangeformat#excel-excel-rangeformat-columnwidth-member)|Specifies the width of all columns within the range.| -||[protection](/javascript/api/excel/excel.rangeformat#excel-excel-rangeformat-protection-member)|Returns the format protection object for a range.| -||[rowHeight](/javascript/api/excel/excel.rangeformat#excel-excel-rangeformat-rowheight-member)|The height of all rows in the range.| -|[RangeReference](/javascript/api/excel/excel.rangereference)|[address](/javascript/api/excel/excel.rangereference#excel-excel-rangereference-address-member)|The address of the range, for example "SheetName!A1:B5".| -|[RangeSort](/javascript/api/excel/excel.rangesort)|[apply(fields: Excel.SortField[], matchCase?: boolean, hasHeaders?: boolean, orientation?: Excel.SortOrientation, method?: Excel.SortMethod)](/javascript/api/excel/excel.rangesort#excel-excel-rangesort-apply-member(1))|Perform a sort operation.| -|[SelectionChangedEventArgs](/javascript/api/excel/excel.selectionchangedeventargs)|[workbook](/javascript/api/excel/excel.selectionchangedeventargs#excel-excel-selectionchangedeventargs-workbook-member)|Gets the workbook object that raised the selection changed event.| -|[SortField](/javascript/api/excel/excel.sortfield)|[ascending](/javascript/api/excel/excel.sortfield#excel-excel-sortfield-ascending-member)|Specifies if the sorting is done in an ascending fashion.| -||[color](/javascript/api/excel/excel.sortfield#excel-excel-sortfield-color-member)|Specifies the color that is the target of the condition if the sorting is on font or cell color.| -||[dataOption](/javascript/api/excel/excel.sortfield#excel-excel-sortfield-dataoption-member)|Represents additional sorting options for this field.| -||[icon](/javascript/api/excel/excel.sortfield#excel-excel-sortfield-icon-member)|Specifies the icon that is the target of the condition, if the sorting is on the cell's icon.| -||[key](/javascript/api/excel/excel.sortfield#excel-excel-sortfield-key-member)|Specifies the column (or row, depending on the sort orientation) that the condition is on.| -||[sortOn](/javascript/api/excel/excel.sortfield#excel-excel-sortfield-sorton-member)|Specifies the type of sorting of this condition.| -|[Table](/javascript/api/excel/excel.table)|[clearFilters()](/javascript/api/excel/excel.table#excel-excel-table-clearfilters-member(1))|Clears all the filters currently applied on the table.| -||[convertToRange()](/javascript/api/excel/excel.table#excel-excel-table-converttorange-member(1))|Converts the table into a normal range of cells.| -||[reapplyFilters()](/javascript/api/excel/excel.table#excel-excel-table-reapplyfilters-member(1))|Reapplies all the filters currently on the table.| -||[sort](/javascript/api/excel/excel.table#excel-excel-table-sort-member)|Represents the sorting for the table.| -||[worksheet](/javascript/api/excel/excel.table#excel-excel-table-worksheet-member)|The worksheet containing the current table.| -|[TableColumn](/javascript/api/excel/excel.tablecolumn)|[filter](/javascript/api/excel/excel.tablecolumn#excel-excel-tablecolumn-filter-member)|Retrieves the filter applied to the column.| -|[TableSort](/javascript/api/excel/excel.tablesort)|[apply(fields: Excel.SortField[], matchCase?: boolean, method?: Excel.SortMethod)](/javascript/api/excel/excel.tablesort#excel-excel-tablesort-apply-member(1))|Perform a sort operation.| -||[clear()](/javascript/api/excel/excel.tablesort#excel-excel-tablesort-clear-member(1))|Clears the sorting that is currently on the table.| -||[fields](/javascript/api/excel/excel.tablesort#excel-excel-tablesort-fields-member)|Specifies the current conditions used to last sort the table.| -||[matchCase](/javascript/api/excel/excel.tablesort#excel-excel-tablesort-matchcase-member)|Specifies if the casing impacts the last sort of the table.| -||[method](/javascript/api/excel/excel.tablesort#excel-excel-tablesort-method-member)|Represents the Chinese character ordering method last used to sort the table.| -||[reapply()](/javascript/api/excel/excel.tablesort#excel-excel-tablesort-reapply-member(1))|Reapplies the current sorting parameters to the table.| -|[ThreeArrowsGraySet](/javascript/api/excel/excel.threearrowsgrayset)|[grayDownArrow](/javascript/api/excel/excel.threearrowsgrayset#excel-excel-threearrowsgrayset-graydownarrow-member)|| -||[graySideArrow](/javascript/api/excel/excel.threearrowsgrayset#excel-excel-threearrowsgrayset-graysidearrow-member)|| -||[grayUpArrow](/javascript/api/excel/excel.threearrowsgrayset#excel-excel-threearrowsgrayset-grayuparrow-member)|| -|[ThreeArrowsSet](/javascript/api/excel/excel.threearrowsset)|[greenUpArrow](/javascript/api/excel/excel.threearrowsset#excel-excel-threearrowsset-greenuparrow-member)|| -||[redDownArrow](/javascript/api/excel/excel.threearrowsset#excel-excel-threearrowsset-reddownarrow-member)|| -||[yellowSideArrow](/javascript/api/excel/excel.threearrowsset#excel-excel-threearrowsset-yellowsidearrow-member)|| -|[ThreeFlagsSet](/javascript/api/excel/excel.threeflagsset)|[greenFlag](/javascript/api/excel/excel.threeflagsset#excel-excel-threeflagsset-greenflag-member)|| -||[redFlag](/javascript/api/excel/excel.threeflagsset#excel-excel-threeflagsset-redflag-member)|| -||[yellowFlag](/javascript/api/excel/excel.threeflagsset#excel-excel-threeflagsset-yellowflag-member)|| -|[ThreeSignsSet](/javascript/api/excel/excel.threesignsset)|[greenCircle](/javascript/api/excel/excel.threesignsset#excel-excel-threesignsset-greencircle-member)|| -||[redDiamond](/javascript/api/excel/excel.threesignsset#excel-excel-threesignsset-reddiamond-member)|| -||[yellowTriangle](/javascript/api/excel/excel.threesignsset#excel-excel-threesignsset-yellowtriangle-member)|| -|[ThreeStarsSet](/javascript/api/excel/excel.threestarsset)|[goldStar](/javascript/api/excel/excel.threestarsset#excel-excel-threestarsset-goldstar-member)|| -||[halfGoldStar](/javascript/api/excel/excel.threestarsset#excel-excel-threestarsset-halfgoldstar-member)|| -||[silverStar](/javascript/api/excel/excel.threestarsset#excel-excel-threestarsset-silverstar-member)|| -|[ThreeSymbols2Set](/javascript/api/excel/excel.threesymbols2set)|[greenCheck](/javascript/api/excel/excel.threesymbols2set#excel-excel-threesymbols2set-greencheck-member)|| -||[redCross](/javascript/api/excel/excel.threesymbols2set#excel-excel-threesymbols2set-redcross-member)|| -||[yellowExclamation](/javascript/api/excel/excel.threesymbols2set#excel-excel-threesymbols2set-yellowexclamation-member)|| -|[ThreeSymbolsSet](/javascript/api/excel/excel.threesymbolsset)|[greenCheckSymbol](/javascript/api/excel/excel.threesymbolsset#excel-excel-threesymbolsset-greenchecksymbol-member)|| -||[redCrossSymbol](/javascript/api/excel/excel.threesymbolsset#excel-excel-threesymbolsset-redcrosssymbol-member)|| -||[yellowExclamationSymbol](/javascript/api/excel/excel.threesymbolsset#excel-excel-threesymbolsset-yellowexclamationsymbol-member)|| -|[ThreeTrafficLights1Set](/javascript/api/excel/excel.threetrafficlights1set)|[greenCircle](/javascript/api/excel/excel.threetrafficlights1set#excel-excel-threetrafficlights1set-greencircle-member)|| -||[redCircleWithBorder](/javascript/api/excel/excel.threetrafficlights1set#excel-excel-threetrafficlights1set-redcirclewithborder-member)|| -||[yellowCircle](/javascript/api/excel/excel.threetrafficlights1set#excel-excel-threetrafficlights1set-yellowcircle-member)|| -|[ThreeTrafficLights2Set](/javascript/api/excel/excel.threetrafficlights2set)|[greenTrafficLight](/javascript/api/excel/excel.threetrafficlights2set#excel-excel-threetrafficlights2set-greentrafficlight-member)|| -||[redTrafficLight](/javascript/api/excel/excel.threetrafficlights2set#excel-excel-threetrafficlights2set-redtrafficlight-member)|| -||[yellowTrafficLight](/javascript/api/excel/excel.threetrafficlights2set#excel-excel-threetrafficlights2set-yellowtrafficlight-member)|| -|[ThreeTrianglesSet](/javascript/api/excel/excel.threetrianglesset)|[greenUpTriangle](/javascript/api/excel/excel.threetrianglesset#excel-excel-threetrianglesset-greenuptriangle-member)|| -||[redDownTriangle](/javascript/api/excel/excel.threetrianglesset#excel-excel-threetrianglesset-reddowntriangle-member)|| -||[yellowDash](/javascript/api/excel/excel.threetrianglesset#excel-excel-threetrianglesset-yellowdash-member)|| -|[Workbook](/javascript/api/excel/excel.workbook)|[functions](/javascript/api/excel/excel.workbook#excel-excel-workbook-functions-member)|Represents a collection of worksheet functions that can be used for computation.| -||[onSelectionChanged](/javascript/api/excel/excel.workbook#excel-excel-workbook-onselectionchanged-member)|Occurs when the selection in the document is changed.| -|[Worksheet](/javascript/api/excel/excel.worksheet)|[getUsedRange(valuesOnly?: boolean)](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-getusedrange-member(1))|The used range is the smallest range that encompasses any cells that have a value or formatting assigned to them.| -||[protection](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-protection-member)|Returns the sheet protection object for a worksheet.| -|[WorksheetProtection](/javascript/api/excel/excel.worksheetprotection)|[options](/javascript/api/excel/excel.worksheetprotection#excel-excel-worksheetprotection-options-member)|Specifies the protection options for the worksheet.| -||[protect(options?: Excel.WorksheetProtectionOptions, password?: string)](/javascript/api/excel/excel.worksheetprotection#excel-excel-worksheetprotection-protect-member(1))|Protects a worksheet.| -||[protected](/javascript/api/excel/excel.worksheetprotection#excel-excel-worksheetprotection-protected-member)|Specifies if the worksheet is protected.| -|[WorksheetProtectionOptions](/javascript/api/excel/excel.worksheetprotectionoptions)|[allowAutoFilter](/javascript/api/excel/excel.worksheetprotectionoptions#excel-excel-worksheetprotectionoptions-allowautofilter-member)|Represents the worksheet protection option allowing use of the AutoFilter feature.| -||[allowDeleteColumns](/javascript/api/excel/excel.worksheetprotectionoptions#excel-excel-worksheetprotectionoptions-allowdeletecolumns-member)|Represents the worksheet protection option allowing deleting of columns.| -||[allowDeleteRows](/javascript/api/excel/excel.worksheetprotectionoptions#excel-excel-worksheetprotectionoptions-allowdeleterows-member)|Represents the worksheet protection option allowing deleting of rows.| -||[allowFormatCells](/javascript/api/excel/excel.worksheetprotectionoptions#excel-excel-worksheetprotectionoptions-allowformatcells-member)|Represents the worksheet protection option allowing formatting of cells.| -||[allowFormatColumns](/javascript/api/excel/excel.worksheetprotectionoptions#excel-excel-worksheetprotectionoptions-allowformatcolumns-member)|Represents the worksheet protection option allowing formatting of columns.| -||[allowFormatRows](/javascript/api/excel/excel.worksheetprotectionoptions#excel-excel-worksheetprotectionoptions-allowformatrows-member)|Represents the worksheet protection option allowing formatting of rows.| -||[allowInsertColumns](/javascript/api/excel/excel.worksheetprotectionoptions#excel-excel-worksheetprotectionoptions-allowinsertcolumns-member)|Represents the worksheet protection option allowing inserting of columns.| -||[allowInsertHyperlinks](/javascript/api/excel/excel.worksheetprotectionoptions#excel-excel-worksheetprotectionoptions-allowinserthyperlinks-member)|Represents the worksheet protection option allowing inserting of hyperlinks.| -||[allowInsertRows](/javascript/api/excel/excel.worksheetprotectionoptions#excel-excel-worksheetprotectionoptions-allowinsertrows-member)|Represents the worksheet protection option allowing inserting of rows.| -||[allowPivotTables](/javascript/api/excel/excel.worksheetprotectionoptions#excel-excel-worksheetprotectionoptions-allowpivottables-member)|Represents the worksheet protection option allowing use of the PivotTable feature.| -||[allowSort](/javascript/api/excel/excel.worksheetprotectionoptions#excel-excel-worksheetprotectionoptions-allowsort-member)|Represents the worksheet protection option allowing use of the sort feature.| +|[Binding](/.binding)|[onDataChanged](/.binding#excel-javascript/api/excel/-binding-ondatachanged-member)|Occurs when data or formatting within the binding is changed.| +||[onSelectionChanged](/.binding#excel-javascript/api/excel/-binding-onselectionchanged-member)|Occurs when the selected content in the binding is changed.| +|[BindingDataChangedEventArgs](/.bindingdatachangedeventargs)|[binding](/.bindingdatachangedeventargs#excel-javascript/api/excel/-bindingdatachangedeventargs-binding-member)|Gets a temporary `Binding` object that contains the ID of the `Binding` object that raised the event.| +|[BindingSelectionChangedEventArgs](/.bindingselectionchangedeventargs)|[binding](/.bindingselectionchangedeventargs#excel-javascript/api/excel/-bindingselectionchangedeventargs-binding-member)|Gets a temporary `Binding` object that contains the ID of the `Binding` object that raised the event.| +||[columnCount](/.bindingselectionchangedeventargs#excel-javascript/api/excel/-bindingselectionchangedeventargs-columncount-member)|Gets the number of columns selected.| +||[rowCount](/.bindingselectionchangedeventargs#excel-javascript/api/excel/-bindingselectionchangedeventargs-rowcount-member)|Gets the number of rows selected.| +||[startColumn](/.bindingselectionchangedeventargs#excel-javascript/api/excel/-bindingselectionchangedeventargs-startcolumn-member)|Gets the index of the first column of the selection (zero-based).| +||[startRow](/.bindingselectionchangedeventargs#excel-javascript/api/excel/-bindingselectionchangedeventargs-startrow-member)|Gets the index of the first row of the selection (zero-based).| +|[Chart](/.chart)|[getImage(width?: number, height?: number, fittingMode?: Excel.ImageFittingMode)](/.chart#excel-javascript/api/excel/-chart-getimage-member(1))|Renders the chart as a Base64-encoded image by scaling the chart to fit the specified dimensions.| +||[worksheet](/.chart#excel-javascript/api/excel/-chart-worksheet-member)|The worksheet containing the current chart.| +|[Filter](/.filter)|[apply(criteria: Excel.FilterCriteria)](/.filter#excel-javascript/api/excel/-filter-apply-member(1))|Apply the given filter criteria on the given column.| +||[applyBottomItemsFilter(count: number)](/.filter#excel-javascript/api/excel/-filter-applybottomitemsfilter-member(1))|Apply a "Bottom Item" filter to the column for the given number of elements.| +||[applyBottomPercentFilter(percent: number)](/.filter#excel-javascript/api/excel/-filter-applybottompercentfilter-member(1))|Apply a "Bottom Percent" filter to the column for the given percentage of elements.| +||[applyCellColorFilter(color: string)](/.filter#excel-javascript/api/excel/-filter-applycellcolorfilter-member(1))|Apply a "Cell Color" filter to the column for the given color.| +||[applyCustomFilter(criteria1: string, criteria2?: string, oper?: Excel.FilterOperator)](/.filter#excel-javascript/api/excel/-filter-applycustomfilter-member(1))|Apply an "Icon" filter to the column for the given criteria strings.| +||[applyDynamicFilter(criteria: Excel.DynamicFilterCriteria)](/.filter#excel-javascript/api/excel/-filter-applydynamicfilter-member(1))|Apply a "Dynamic" filter to the column.| +||[applyFontColorFilter(color: string)](/.filter#excel-javascript/api/excel/-filter-applyfontcolorfilter-member(1))|Apply a "Font Color" filter to the column for the given color.| +||[applyIconFilter(icon: Excel.Icon)](/.filter#excel-javascript/api/excel/-filter-applyiconfilter-member(1))|Apply an "Icon" filter to the column for the given icon.| +||[applyTopItemsFilter(count: number)](/.filter#excel-javascript/api/excel/-filter-applytopitemsfilter-member(1))|Apply a "Top Item" filter to the column for the given number of elements.| +||[applyTopPercentFilter(percent: number)](/.filter#excel-javascript/api/excel/-filter-applytoppercentfilter-member(1))|Apply a "Top Percent" filter to the column for the given percentage of elements.| +||[applyValuesFilter(values: Array)](/.filter#excel-javascript/api/excel/-filter-applyvaluesfilter-member(1))|Apply a "Values" filter to the column for the given values.| +||[clear()](/.filter#excel-javascript/api/excel/-filter-clear-member(1))|Clear the filter on the given column.| +||[criteria](/.filter#excel-javascript/api/excel/-filter-criteria-member)|The currently applied filter on the given column.| +|[FilterCriteria](/.filtercriteria)|[color](/.filtercriteria#excel-javascript/api/excel/-filtercriteria-color-member)|The HTML color string used to filter cells.| +||[criterion1](/.filtercriteria#excel-javascript/api/excel/-filtercriteria-criterion1-member)|The first criterion used to filter data.| +||[criterion2](/.filtercriteria#excel-javascript/api/excel/-filtercriteria-criterion2-member)|The second criterion used to filter data.| +||[dynamicCriteria](/.filtercriteria#excel-javascript/api/excel/-filtercriteria-dynamiccriteria-member)|The dynamic criteria from the `Excel.DynamicFilterCriteria` set to apply on this column.| +||[filterOn](/.filtercriteria#excel-javascript/api/excel/-filtercriteria-filteron-member)|The property used by the filter to determine whether the values should stay visible.| +||[icon](/.filtercriteria#excel-javascript/api/excel/-filtercriteria-icon-member)|The icon used to filter cells.| +||[operator](/.filtercriteria#excel-javascript/api/excel/-filtercriteria-operator-member)|The operator used to combine criterion 1 and 2 when using `custom` filtering.| +||[values](/.filtercriteria#excel-javascript/api/excel/-filtercriteria-values-member)|The set of values to be used as part of `values` filtering.| +|[FilterDatetime](/.filterdatetime)|[date](/.filterdatetime#excel-javascript/api/excel/-filterdatetime-date-member)|The date in ISO8601 format used to filter data.| +||[specificity](/.filterdatetime#excel-javascript/api/excel/-filterdatetime-specificity-member)|How specific the date should be used to keep data.| +|[FiveArrowsGraySet](/.fivearrowsgrayset)|[grayDownArrow](/.fivearrowsgrayset#excel-javascript/api/excel/-fivearrowsgrayset-graydownarrow-member)|| +||[grayDownInclineArrow](/.fivearrowsgrayset#excel-javascript/api/excel/-fivearrowsgrayset-graydowninclinearrow-member)|| +||[graySideArrow](/.fivearrowsgrayset#excel-javascript/api/excel/-fivearrowsgrayset-graysidearrow-member)|| +||[grayUpArrow](/.fivearrowsgrayset#excel-javascript/api/excel/-fivearrowsgrayset-grayuparrow-member)|| +||[grayUpInclineArrow](/.fivearrowsgrayset#excel-javascript/api/excel/-fivearrowsgrayset-grayupinclinearrow-member)|| +|[FiveArrowsSet](/.fivearrowsset)|[greenUpArrow](/.fivearrowsset#excel-javascript/api/excel/-fivearrowsset-greenuparrow-member)|| +||[redDownArrow](/.fivearrowsset#excel-javascript/api/excel/-fivearrowsset-reddownarrow-member)|| +||[yellowDownInclineArrow](/.fivearrowsset#excel-javascript/api/excel/-fivearrowsset-yellowdowninclinearrow-member)|| +||[yellowSideArrow](/.fivearrowsset#excel-javascript/api/excel/-fivearrowsset-yellowsidearrow-member)|| +||[yellowUpInclineArrow](/.fivearrowsset#excel-javascript/api/excel/-fivearrowsset-yellowupinclinearrow-member)|| +|[FiveBoxesSet](/.fiveboxesset)|[fourFilledBoxes](/.fiveboxesset#excel-javascript/api/excel/-fiveboxesset-fourfilledboxes-member)|| +||[noFilledBoxes](/.fiveboxesset#excel-javascript/api/excel/-fiveboxesset-nofilledboxes-member)|| +||[oneFilledBox](/.fiveboxesset#excel-javascript/api/excel/-fiveboxesset-onefilledbox-member)|| +||[threeFilledBoxes](/.fiveboxesset#excel-javascript/api/excel/-fiveboxesset-threefilledboxes-member)|| +||[twoFilledBoxes](/.fiveboxesset#excel-javascript/api/excel/-fiveboxesset-twofilledboxes-member)|| +|[FiveQuartersSet](/.fivequartersset)|[blackCircle](/.fivequartersset#excel-javascript/api/excel/-fivequartersset-blackcircle-member)|| +||[circleWithOneWhiteQuarter](/.fivequartersset#excel-javascript/api/excel/-fivequartersset-circlewithonewhitequarter-member)|| +||[circleWithThreeWhiteQuarters](/.fivequartersset#excel-javascript/api/excel/-fivequartersset-circlewiththreewhitequarters-member)|| +||[circleWithTwoWhiteQuarters](/.fivequartersset#excel-javascript/api/excel/-fivequartersset-circlewithtwowhitequarters-member)|| +||[whiteCircleAllWhiteQuarters](/.fivequartersset#excel-javascript/api/excel/-fivequartersset-whitecircleallwhitequarters-member)|| +|[FiveRatingSet](/.fiveratingset)|[fourBars](/.fiveratingset#excel-javascript/api/excel/-fiveratingset-fourbars-member)|| +||[noBars](/.fiveratingset#excel-javascript/api/excel/-fiveratingset-nobars-member)|| +||[oneBar](/.fiveratingset#excel-javascript/api/excel/-fiveratingset-onebar-member)|| +||[threeBars](/.fiveratingset#excel-javascript/api/excel/-fiveratingset-threebars-member)|| +||[twoBars](/.fiveratingset#excel-javascript/api/excel/-fiveratingset-twobars-member)|| +|[FormatProtection](/.formatprotection)|[formulaHidden](/.formatprotection#excel-javascript/api/excel/-formatprotection-formulahidden-member)|Specifies if Excel hides the formula for the cells in the range.| +||[locked](/.formatprotection#excel-javascript/api/excel/-formatprotection-locked-member)|Specifies if Excel locks the cells in the object.| +|[FourArrowsGraySet](/.fourarrowsgrayset)|[grayDownArrow](/.fourarrowsgrayset#excel-javascript/api/excel/-fourarrowsgrayset-graydownarrow-member)|| +||[grayDownInclineArrow](/.fourarrowsgrayset#excel-javascript/api/excel/-fourarrowsgrayset-graydowninclinearrow-member)|| +||[grayUpArrow](/.fourarrowsgrayset#excel-javascript/api/excel/-fourarrowsgrayset-grayuparrow-member)|| +||[grayUpInclineArrow](/.fourarrowsgrayset#excel-javascript/api/excel/-fourarrowsgrayset-grayupinclinearrow-member)|| +|[FourArrowsSet](/.fourarrowsset)|[greenUpArrow](/.fourarrowsset#excel-javascript/api/excel/-fourarrowsset-greenuparrow-member)|| +||[redDownArrow](/.fourarrowsset#excel-javascript/api/excel/-fourarrowsset-reddownarrow-member)|| +||[yellowDownInclineArrow](/.fourarrowsset#excel-javascript/api/excel/-fourarrowsset-yellowdowninclinearrow-member)|| +||[yellowUpInclineArrow](/.fourarrowsset#excel-javascript/api/excel/-fourarrowsset-yellowupinclinearrow-member)|| +|[FourRatingSet](/.fourratingset)|[fourBars](/.fourratingset#excel-javascript/api/excel/-fourratingset-fourbars-member)|| +||[oneBar](/.fourratingset#excel-javascript/api/excel/-fourratingset-onebar-member)|| +||[threeBars](/.fourratingset#excel-javascript/api/excel/-fourratingset-threebars-member)|| +||[twoBars](/.fourratingset#excel-javascript/api/excel/-fourratingset-twobars-member)|| +|[FourRedToBlackSet](/.fourredtoblackset)|[blackCircle](/.fourredtoblackset#excel-javascript/api/excel/-fourredtoblackset-blackcircle-member)|| +||[grayCircle](/.fourredtoblackset#excel-javascript/api/excel/-fourredtoblackset-graycircle-member)|| +||[pinkCircle](/.fourredtoblackset#excel-javascript/api/excel/-fourredtoblackset-pinkcircle-member)|| +||[redCircle](/.fourredtoblackset#excel-javascript/api/excel/-fourredtoblackset-redcircle-member)|| +|[FourTrafficLightsSet](/.fourtrafficlightsset)|[blackCircleWithBorder](/.fourtrafficlightsset#excel-javascript/api/excel/-fourtrafficlightsset-blackcirclewithborder-member)|| +||[greenCircle](/.fourtrafficlightsset#excel-javascript/api/excel/-fourtrafficlightsset-greencircle-member)|| +||[redCircleWithBorder](/.fourtrafficlightsset#excel-javascript/api/excel/-fourtrafficlightsset-redcirclewithborder-member)|| +||[yellowCircle](/.fourtrafficlightsset#excel-javascript/api/excel/-fourtrafficlightsset-yellowcircle-member)|| +|[FunctionResult](/.functionresult)|[error](/.functionresult#excel-javascript/api/excel/-functionresult-error-member)|Error value (such as "#DIV/0") representing the error.| +||[value](/.functionresult#excel-javascript/api/excel/-functionresult-value-member)|The value of function evaluation.| +|[Functions](/.functions)|[abs(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-abs-member(1))|Returns the absolute value of a number, a number without its sign.| +||[accrInt(issue: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, firstInterest: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, par: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, calcMethod?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-accrint-member(1))|Returns the accrued interest for a security that pays periodic interest.| +||[accrIntM(issue: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, par: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-accrintm-member(1))|Returns the accrued interest for a security that pays interest at maturity.| +||[acos(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-acos-member(1))|Returns the arccosine of a number, in radians in the range 0 to Pi.| +||[acosh(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-acosh-member(1))|Returns the inverse hyperbolic cosine of a number.| +||[acot(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-acot-member(1))|Returns the arccotangent of a number, in radians in the range 0 to Pi.| +||[acoth(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-acoth-member(1))|Returns the inverse hyperbolic cotangent of a number.| +||[amorDegrc(cost: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, datePurchased: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, firstPeriod: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, salvage: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, period: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-amordegrc-member(1))|Returns the prorated linear depreciation of an asset for each accounting period.| +||[amorLinc(cost: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, datePurchased: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, firstPeriod: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, salvage: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, period: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-amorlinc-member(1))|Returns the prorated linear depreciation of an asset for each accounting period.| +||[and(...values: Array)](/.functions#excel-javascript/api/excel/-functions-and-member(1))|Checks whether all arguments are TRUE, and returns TRUE if all arguments are TRUE.| +||[arabic(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-arabic-member(1))|Converts a Roman numeral to Arabic.| +||[areas(reference: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-areas-member(1))|Returns the number of areas in a reference.| +||[asc(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-asc-member(1))|Changes full-width (double-byte) characters to half-width (single-byte) characters.| +||[asin(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-asin-member(1))|Returns the arcsine of a number in radians, in the range -Pi/2 to Pi/2.| +||[asinh(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-asinh-member(1))|Returns the inverse hyperbolic sine of a number.| +||[atan(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-atan-member(1))|Returns the arctangent of a number in radians, in the range -Pi/2 to Pi/2.| +||[atan2(xNum: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, yNum: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-atan2-member(1))|Returns the arctangent of the specified x- and y- coordinates, in radians between -Pi and Pi, excluding -Pi.| +||[atanh(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-atanh-member(1))|Returns the inverse hyperbolic tangent of a number.| +||[aveDev(...values: Array)](/.functions#excel-javascript/api/excel/-functions-avedev-member(1))|Returns the average of the absolute deviations of data points from their mean.| +||[average(...values: Array)](/.functions#excel-javascript/api/excel/-functions-average-member(1))|Returns the average (arithmetic mean) of its arguments, which can be numbers or names, arrays, or references that contain numbers.| +||[averageA(...values: Array)](/.functions#excel-javascript/api/excel/-functions-averagea-member(1))|Returns the average (arithmetic mean) of its arguments, evaluating text and FALSE in arguments as 0; TRUE evaluates as 1.| +||[averageIf(range: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, averageRange?: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-averageif-member(1))|Finds average(arithmetic mean) for the cells specified by a given condition or criteria.| +||[averageIfs(averageRange: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, ...values: Array)](/.functions#excel-javascript/api/excel/-functions-averageifs-member(1))|Finds average(arithmetic mean) for the cells specified by a given set of conditions or criteria.| +||[bahtText(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-bahttext-member(1))|Converts a number to text (baht).| +||[base(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, radix: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, minLength?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-base-member(1))|Converts a number into a text representation with the given radix (base).| +||[besselI(x: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, n: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-besseli-member(1))|Returns the modified Bessel function In(x).| +||[besselJ(x: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, n: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-besselj-member(1))|Returns the Bessel function Jn(x).| +||[besselK(x: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, n: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-besselk-member(1))|Returns the modified Bessel function Kn(x).| +||[besselY(x: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, n: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-bessely-member(1))|Returns the Bessel function Yn(x).| +||[beta_Dist(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, alpha: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, beta: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, A?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, B?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-beta_dist-member(1))|Returns the beta probability distribution function.| +||[beta_Inv(probability: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, alpha: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, beta: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, A?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, B?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-beta_inv-member(1))|Returns the inverse of the cumulative beta probability density function (BETA.DIST).| +||[bin2Dec(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-bin2dec-member(1))|Converts a binary number to decimal.| +||[bin2Hex(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, places?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-bin2hex-member(1))|Converts a binary number to hexadecimal.| +||[bin2Oct(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, places?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-bin2oct-member(1))|Converts a binary number to octal.| +||[binom_Dist(numberS: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, trials: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, probabilityS: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-binom_dist-member(1))|Returns the individual term binomial distribution probability.| +||[binom_Dist_Range(trials: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, probabilityS: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numberS: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numberS2?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-binom_dist_range-member(1))|Returns the probability of a trial result using a binomial distribution.| +||[binom_Inv(trials: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, probabilityS: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, alpha: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-binom_inv-member(1))|Returns the smallest value for which the cumulative binomial distribution is greater than or equal to a criterion value.| +||[bitand(number1: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, number2: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-bitand-member(1))|Returns a bitwise 'And' of two numbers.| +||[bitlshift(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, shiftAmount: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-bitlshift-member(1))|Returns a number shifted left by shift_amount bits.| +||[bitor(number1: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, number2: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-bitor-member(1))|Returns a bitwise 'Or' of two numbers.| +||[bitrshift(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, shiftAmount: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-bitrshift-member(1))|Returns a number shifted right by shift_amount bits.| +||[bitxor(number1: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, number2: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-bitxor-member(1))|Returns a bitwise 'Exclusive Or' of two numbers.| +||[ceiling_Math(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, significance?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, mode?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-ceiling_math-member(1))|Rounds a number up, to the nearest integer or to the nearest multiple of significance.| +||[ceiling_Precise(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, significance?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-ceiling_precise-member(1))|Rounds a number up, to the nearest integer or to the nearest multiple of significance.| +||[char(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-char-member(1))|Returns the character specified by the code number from the character set for your computer.| +||[chiSq_Dist(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-chisq_dist-member(1))|Returns the left-tailed probability of the chi-squared distribution.| +||[chiSq_Dist_RT(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-chisq_dist_rt-member(1))|Returns the right-tailed probability of the chi-squared distribution.| +||[chiSq_Inv(probability: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-chisq_inv-member(1))|Returns the inverse of the left-tailed probability of the chi-squared distribution.| +||[chiSq_Inv_RT(probability: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-chisq_inv_rt-member(1))|Returns the inverse of the right-tailed probability of the chi-squared distribution.| +||[choose(indexNum: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, ...values: Array)](/.functions#excel-javascript/api/excel/-functions-choose-member(1))|Chooses a value or action to perform from a list of values, based on an index number.| +||[clean(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-clean-member(1))|Removes all nonprintable characters from text.| +||[code(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-code-member(1))|Returns a numeric code for the first character in a text string, in the character set used by your computer.| +||[columns(array: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-columns-member(1))|Returns the number of columns in an array or reference.| +||[combin(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numberChosen: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-combin-member(1))|Returns the number of combinations for a given number of items.| +||[combina(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numberChosen: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-combina-member(1))|Returns the number of combinations with repetitions for a given number of items.| +||[complex(realNum: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, iNum: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, suffix?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-complex-member(1))|Converts real and imaginary coefficients into a complex number.| +||[concatenate(...values: Array)](/.functions#excel-javascript/api/excel/-functions-concatenate-member(1))|Joins several text strings into one text string.| +||[confidence_Norm(alpha: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, standardDev: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, size: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-confidence_norm-member(1))|Returns the confidence interval for a population mean, using a normal distribution.| +||[confidence_T(alpha: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, standardDev: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, size: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-confidence_t-member(1))|Returns the confidence interval for a population mean, using a Student's T distribution.| +||[convert(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, fromUnit: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, toUnit: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-convert-member(1))|Converts a number from one measurement system to another.| +||[cos(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-cos-member(1))|Returns the cosine of an angle.| +||[cosh(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-cosh-member(1))|Returns the hyperbolic cosine of a number.| +||[cot(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-cot-member(1))|Returns the cotangent of an angle.| +||[coth(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-coth-member(1))|Returns the hyperbolic cotangent of a number.| +||[count(...values: Array)](/.functions#excel-javascript/api/excel/-functions-count-member(1))|Counts the number of cells in a range that contain numbers.| +||[countA(...values: Array)](/.functions#excel-javascript/api/excel/-functions-counta-member(1))|Counts the number of cells in a range that are not empty.| +||[countBlank(range: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-countblank-member(1))|Counts the number of empty cells in a specified range of cells.| +||[countIf(range: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-countif-member(1))|Counts the number of cells within a range that meet the given condition.| +||[countIfs(...values: Array)](/.functions#excel-javascript/api/excel/-functions-countifs-member(1))|Counts the number of cells specified by a given set of conditions or criteria.| +||[coupDayBs(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-coupdaybs-member(1))|Returns the number of days from the beginning of the coupon period to the settlement date.| +||[coupDays(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-coupdays-member(1))|Returns the number of days in the coupon period that contains the settlement date.| +||[coupDaysNc(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-coupdaysnc-member(1))|Returns the number of days from the settlement date to the next coupon date.| +||[coupNcd(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-coupncd-member(1))|Returns the next coupon date after the settlement date.| +||[coupNum(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-coupnum-member(1))|Returns the number of coupons payable between the settlement date and maturity date.| +||[coupPcd(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-couppcd-member(1))|Returns the previous coupon date before the settlement date.| +||[csc(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-csc-member(1))|Returns the cosecant of an angle.| +||[csch(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-csch-member(1))|Returns the hyperbolic cosecant of an angle.| +||[cumIPmt(rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, nper: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pv: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, startPeriod: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, endPeriod: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, type: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-cumipmt-member(1))|Returns the cumulative interest paid between two periods.| +||[cumPrinc(rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, nper: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pv: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, startPeriod: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, endPeriod: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, type: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-cumprinc-member(1))|Returns the cumulative principal paid on a loan between two periods.| +||[date(year: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, month: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, day: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-date-member(1))|Returns the number that represents the date in Microsoft Excel date-time code.| +||[datevalue(dateText: string \| number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-datevalue-member(1))|Converts a date in the form of text to a number that represents the date in Microsoft Excel date-time code.| +||[daverage(database: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, field: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-daverage-member(1))|Averages the values in a column in a list or database that match conditions you specify.| +||[day(serialNumber: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-day-member(1))|Returns the day of the month, a number from 1 to 31.| +||[days(endDate: string \| number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, startDate: string \| number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-days-member(1))|Returns the number of days between the two dates.| +||[days360(startDate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, endDate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, method?: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-days360-member(1))|Returns the number of days between two dates based on a 360-day year (twelve 30-day months).| +||[db(cost: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, salvage: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, life: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, period: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, month?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-db-member(1))|Returns the depreciation of an asset for a specified period using the fixed-declining balance method.| +||[dbcs(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-dbcs-member(1))|Changes half-width (single-byte) characters within a character string to full-width (double-byte) characters.| +||[dcount(database: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, field: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-dcount-member(1))|Counts the cells containing numbers in the field (column) of records in the database that match the conditions you specify.| +||[dcountA(database: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, field: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-dcounta-member(1))|Counts nonblank cells in the field (column) of records in the database that match the conditions you specify.| +||[ddb(cost: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, salvage: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, life: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, period: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, factor?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-ddb-member(1))|Returns the depreciation of an asset for a specified period using the double-declining balance method or some other method you specify.| +||[dec2Bin(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, places?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-dec2bin-member(1))|Converts a decimal number to binary.| +||[dec2Hex(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, places?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-dec2hex-member(1))|Converts a decimal number to hexadecimal.| +||[dec2Oct(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, places?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-dec2oct-member(1))|Converts a decimal number to octal.| +||[decimal(number: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, radix: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-decimal-member(1))|Converts a text representation of a number in a given base into a decimal number.| +||[degrees(angle: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-degrees-member(1))|Converts radians to degrees.| +||[delta(number1: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, number2?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-delta-member(1))|Tests whether two numbers are equal.| +||[devSq(...values: Array)](/.functions#excel-javascript/api/excel/-functions-devsq-member(1))|Returns the sum of squares of deviations of data points from their sample mean.| +||[dget(database: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, field: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-dget-member(1))|Extracts from a database a single record that matches the conditions you specify.| +||[disc(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pr: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, redemption: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-disc-member(1))|Returns the discount rate for a security.| +||[dmax(database: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, field: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-dmax-member(1))|Returns the largest number in the field (column) of records in the database that match the conditions you specify.| +||[dmin(database: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, field: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-dmin-member(1))|Returns the smallest number in the field (column) of records in the database that match the conditions you specify.| +||[dollar(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, decimals?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-dollar-member(1))|Converts a number to text, using currency format.| +||[dollarDe(fractionalDollar: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, fraction: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-dollarde-member(1))|Converts a dollar price, expressed as a fraction, into a dollar price, expressed as a decimal number.| +||[dollarFr(decimalDollar: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, fraction: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-dollarfr-member(1))|Converts a dollar price, expressed as a decimal number, into a dollar price, expressed as a fraction.| +||[dproduct(database: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, field: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-dproduct-member(1))|Multiplies the values in the field (column) of records in the database that match the conditions you specify.| +||[dstDev(database: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, field: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-dstdev-member(1))|Estimates the standard deviation based on a sample from selected database entries.| +||[dstDevP(database: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, field: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-dstdevp-member(1))|Calculates the standard deviation based on the entire population of selected database entries.| +||[dsum(database: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, field: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-dsum-member(1))|Adds the numbers in the field (column) of records in the database that match the conditions you specify.| +||[duration(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, coupon: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, yld: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-duration-member(1))|Returns the annual duration of a security with periodic interest payments.| +||[dvar(database: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, field: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-dvar-member(1))|Estimates variance based on a sample from selected database entries.| +||[dvarP(database: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, field: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-dvarp-member(1))|Calculates variance based on the entire population of selected database entries.| +||[ecma_Ceiling(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, significance: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-ecma_ceiling-member(1))|Rounds a number up, to the nearest integer or to the nearest multiple of significance.| +||[edate(startDate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, months: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-edate-member(1))|Returns the serial number of the date that is the indicated number of months before or after the start date.| +||[effect(nominalRate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, npery: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-effect-member(1))|Returns the effective annual interest rate.| +||[eoMonth(startDate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, months: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-eomonth-member(1))|Returns the serial number of the last day of the month before or after a specified number of months.| +||[erf(lowerLimit: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, upperLimit?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-erf-member(1))|Returns the error function.| +||[erfC(x: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-erfc-member(1))|Returns the complementary error function.| +||[erfC_Precise(X: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-erfc_precise-member(1))|Returns the complementary error function.| +||[erf_Precise(X: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-erf_precise-member(1))|Returns the error function.| +||[error_Type(errorVal: string \| number \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-error_type-member(1))|Returns a number matching an error value.| +||[even(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-even-member(1))|Rounds a positive number up and negative number down to the nearest even integer.| +||[exact(text1: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, text2: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-exact-member(1))|Checks whether two text strings are exactly the same, and returns TRUE or FALSE.| +||[exp(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-exp-member(1))|Returns e raised to the power of a given number.| +||[expon_Dist(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, lambda: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-expon_dist-member(1))|Returns the exponential distribution.| +||[f_Dist(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom1: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom2: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-f_dist-member(1))|Returns the (left-tailed) F probability distribution (degree of diversity) for two data sets.| +||[f_Dist_RT(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom1: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom2: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-f_dist_rt-member(1))|Returns the (right-tailed) F probability distribution (degree of diversity) for two data sets.| +||[f_Inv(probability: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom1: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom2: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-f_inv-member(1))|Returns the inverse of the (left-tailed) F probability distribution: if p = F.DIST(x,...), then F.INV(p,...) = x.| +||[f_Inv_RT(probability: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom1: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom2: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-f_inv_rt-member(1))|Returns the inverse of the (right-tailed) F probability distribution: if p = F.DIST.RT(x,...), then F.INV.RT(p,...) = x.| +||[fact(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-fact-member(1))|Returns the factorial of a number, equal to 1*2*3*...* Number.| +||[factDouble(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-factdouble-member(1))|Returns the double factorial of a number.| +||[false()](/.functions#excel-javascript/api/excel/-functions-false-member(1))|Returns the logical value FALSE.| +||[find(findText: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, withinText: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, startNum?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-find-member(1))|Returns the starting position of one text string within another text string.| +||[findB(findText: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, withinText: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, startNum?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-findb-member(1))|Finds the starting position of one text string within another text string.| +||[fisher(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-fisher-member(1))|Returns the Fisher transformation.| +||[fisherInv(y: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-fisherinv-member(1))|Returns the inverse of the Fisher transformation: if y = FISHER(x), then FISHERINV(y) = x.| +||[fixed(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, decimals?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, noCommas?: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-fixed-member(1))|Rounds a number to the specified number of decimals and returns the result as text with or without commas.| +||[floor_Math(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, significance?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, mode?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-floor_math-member(1))|Rounds a number down, to the nearest integer or to the nearest multiple of significance.| +||[floor_Precise(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, significance?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-floor_precise-member(1))|Rounds a number down, to the nearest integer or to the nearest multiple of significance.| +||[fv(rate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, nper: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pmt: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pv?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, type?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-fv-member(1))|Returns the future value of an investment based on periodic, constant payments and a constant interest rate.| +||[fvschedule(principal: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, schedule: number \| string \| Excel.Range \| boolean \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-fvschedule-member(1))|Returns the future value of an initial principal after applying a series of compound interest rates.| +||[gamma(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-gamma-member(1))|Returns the Gamma function value.| +||[gammaLn(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-gammaln-member(1))|Returns the natural logarithm of the gamma function.| +||[gammaLn_Precise(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-gammaln_precise-member(1))|Returns the natural logarithm of the gamma function.| +||[gamma_Dist(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, alpha: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, beta: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-gamma_dist-member(1))|Returns the gamma distribution.| +||[gamma_Inv(probability: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, alpha: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, beta: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-gamma_inv-member(1))|Returns the inverse of the gamma cumulative distribution: if p = GAMMA.DIST(x,...), then GAMMA.INV(p,...) = x.| +||[gauss(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-gauss-member(1))|Returns 0.5 less than the standard normal cumulative distribution.| +||[gcd(...values: Array)](/.functions#excel-javascript/api/excel/-functions-gcd-member(1))|Returns the greatest common divisor.| +||[geStep(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, step?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-gestep-member(1))|Tests whether a number is greater than a threshold value.| +||[geoMean(...values: Array)](/.functions#excel-javascript/api/excel/-functions-geomean-member(1))|Returns the geometric mean of an array or range of positive numeric data.| +||[harMean(...values: Array)](/.functions#excel-javascript/api/excel/-functions-harmean-member(1))|Returns the harmonic mean of a data set of positive numbers: the reciprocal of the arithmetic mean of reciprocals.| +||[hex2Bin(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, places?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-hex2bin-member(1))|Converts a Hexadecimal number to binary.| +||[hex2Dec(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-hex2dec-member(1))|Converts a hexadecimal number to decimal.| +||[hex2Oct(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, places?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-hex2oct-member(1))|Converts a hexadecimal number to octal.| +||[hlookup(lookupValue: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, tableArray: Excel.Range \| number \| Excel.RangeReference \| Excel.FunctionResult, rowIndexNum: Excel.Range \| number \| Excel.RangeReference \| Excel.FunctionResult, rangeLookup?: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-hlookup-member(1))|Looks for a value in the top row of a table or array of values and returns the value in the same column from a row you specify.| +||[hour(serialNumber: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-hour-member(1))|Returns the hour as a number from 0 (12:00 A.M.) to 23 (11:00 P.M.).| +||[hypGeom_Dist(sampleS: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numberSample: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, populationS: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numberPop: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-hypgeom_dist-member(1))|Returns the hypergeometric distribution.| +||[hyperlink(linkLocation: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, friendlyName?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-hyperlink-member(1))|Creates a shortcut or jump that opens a document stored on your hard drive, a network server, or on the Internet.| +||[if(logicalTest: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, valueIfTrue?: Excel.Range \| number \| string \| boolean \| Excel.RangeReference \| Excel.FunctionResult, valueIfFalse?: Excel.Range \| number \| string \| boolean \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-if-member(1))|Checks whether a condition is met, and returns one value if TRUE, and another value if FALSE.| +||[imAbs(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-imabs-member(1))|Returns the absolute value (modulus) of a complex number.| +||[imArgument(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-imargument-member(1))|Returns the argument q, an angle expressed in radians.| +||[imConjugate(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-imconjugate-member(1))|Returns the complex conjugate of a complex number.| +||[imCos(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-imcos-member(1))|Returns the cosine of a complex number.| +||[imCosh(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-imcosh-member(1))|Returns the hyperbolic cosine of a complex number.| +||[imCot(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-imcot-member(1))|Returns the cotangent of a complex number.| +||[imCsc(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-imcsc-member(1))|Returns the cosecant of a complex number.| +||[imCsch(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-imcsch-member(1))|Returns the hyperbolic cosecant of a complex number.| +||[imDiv(inumber1: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, inumber2: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-imdiv-member(1))|Returns the quotient of two complex numbers.| +||[imExp(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-imexp-member(1))|Returns the exponential of a complex number.| +||[imLn(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-imln-member(1))|Returns the natural logarithm of a complex number.| +||[imLog10(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-imlog10-member(1))|Returns the base-10 logarithm of a complex number.| +||[imLog2(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-imlog2-member(1))|Returns the base-2 logarithm of a complex number.| +||[imPower(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-impower-member(1))|Returns a complex number raised to an integer power.| +||[imProduct(...values: Array)](/.functions#excel-javascript/api/excel/-functions-improduct-member(1))|Returns the product of 1 to 255 complex numbers.| +||[imReal(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-imreal-member(1))|Returns the real coefficient of a complex number.| +||[imSec(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-imsec-member(1))|Returns the secant of a complex number.| +||[imSech(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-imsech-member(1))|Returns the hyperbolic secant of a complex number.| +||[imSin(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-imsin-member(1))|Returns the sine of a complex number.| +||[imSinh(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-imsinh-member(1))|Returns the hyperbolic sine of a complex number.| +||[imSqrt(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-imsqrt-member(1))|Returns the square root of a complex number.| +||[imSub(inumber1: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, inumber2: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-imsub-member(1))|Returns the difference of two complex numbers.| +||[imSum(...values: Array)](/.functions#excel-javascript/api/excel/-functions-imsum-member(1))|Returns the sum of complex numbers.| +||[imTan(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-imtan-member(1))|Returns the tangent of a complex number.| +||[imaginary(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-imaginary-member(1))|Returns the imaginary coefficient of a complex number.| +||[int(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-int-member(1))|Rounds a number down to the nearest integer.| +||[intRate(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, investment: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, redemption: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-intrate-member(1))|Returns the interest rate for a fully invested security.| +||[ipmt(rate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, per: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, nper: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pv: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, fv?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, type?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-ipmt-member(1))|Returns the interest payment for a given period for an investment, based on periodic, constant payments and a constant interest rate.| +||[irr(values: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, guess?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-irr-member(1))|Returns the internal rate of return for a series of cash flows.| +||[isErr(value: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-iserr-member(1))|Checks whether a value is an error other than #N/A, and returns TRUE or FALSE.| +||[isError(value: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-iserror-member(1))|Checks whether a value is an error, and returns TRUE or FALSE.| +||[isEven(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-iseven-member(1))|Returns TRUE if the number is even.| +||[isFormula(reference: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-isformula-member(1))|Checks whether a reference is to a cell containing a formula, and returns TRUE or FALSE.| +||[isLogical(value: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-islogical-member(1))|Checks whether a value is a logical value (TRUE or FALSE), and returns TRUE or FALSE.| +||[isNA(value: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-isna-member(1))|Checks whether a value is #N/A, and returns TRUE or FALSE.| +||[isNonText(value: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-isnontext-member(1))|Checks whether a value is not text (blank cells are not text), and returns TRUE or FALSE.| +||[isNumber(value: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-isnumber-member(1))|Checks whether a value is a number, and returns TRUE or FALSE.| +||[isOdd(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-isodd-member(1))|Returns TRUE if the number is odd.| +||[isText(value: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-istext-member(1))|Checks whether a value is text, and returns TRUE or FALSE.| +||[isoWeekNum(date: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-isoweeknum-member(1))|Returns the ISO week number in the year for a given date.| +||[iso_Ceiling(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, significance?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-iso_ceiling-member(1))|Rounds a number up, to the nearest integer or to the nearest multiple of significance.| +||[ispmt(rate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, per: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, nper: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pv: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-ispmt-member(1))|Returns the interest paid during a specific period of an investment.| +||[isref(value: Excel.Range \| number \| string \| boolean \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-isref-member(1))|Checks whether a value is a reference, and returns TRUE or FALSE.| +||[kurt(...values: Array)](/.functions#excel-javascript/api/excel/-functions-kurt-member(1))|Returns the kurtosis of a data set.| +||[large(array: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, k: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-large-member(1))|Returns the k-th largest value in a data set.| +||[lcm(...values: Array)](/.functions#excel-javascript/api/excel/-functions-lcm-member(1))|Returns the least common multiple.| +||[left(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numChars?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-left-member(1))|Returns the specified number of characters from the start of a text string.| +||[leftb(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numBytes?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-leftb-member(1))|Returns the specified number of characters from the start of a text string.| +||[len(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-len-member(1))|Returns the number of characters in a text string.| +||[lenb(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-lenb-member(1))|Returns the number of characters in a text string.| +||[ln(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-ln-member(1))|Returns the natural logarithm of a number.| +||[log(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, base?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-log-member(1))|Returns the logarithm of a number to the base you specify.| +||[log10(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-log10-member(1))|Returns the base-10 logarithm of a number.| +||[logNorm_Dist(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, mean: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, standardDev: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-lognorm_dist-member(1))|Returns the lognormal distribution of x, where ln(x) is normally distributed with parameters Mean and Standard_dev.| +||[logNorm_Inv(probability: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, mean: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, standardDev: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-lognorm_inv-member(1))|Returns the inverse of the lognormal cumulative distribution function of x, where ln(x) is normally distributed with parameters Mean and Standard_dev.| +||[lookup(lookupValue: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, lookupVector: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, resultVector?: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-lookup-member(1))|Looks up a value either from a one-row or one-column range or from an array.| +||[lower(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-lower-member(1))|Converts all letters in a text string to lowercase.| +||[match(lookupValue: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, lookupArray: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, matchType?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-match-member(1))|Returns the relative position of an item in an array that matches a specified value in a specified order.| +||[max(...values: Array)](/.functions#excel-javascript/api/excel/-functions-max-member(1))|Returns the largest value in a set of values.| +||[maxA(...values: Array)](/.functions#excel-javascript/api/excel/-functions-maxa-member(1))|Returns the largest value in a set of values.| +||[mduration(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, coupon: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, yld: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-mduration-member(1))|Returns the Macauley modified duration for a security with an assumed par value of $100.| +||[median(...values: Array)](/.functions#excel-javascript/api/excel/-functions-median-member(1))|Returns the median, or the number in the middle of the set of given numbers.| +||[mid(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, startNum: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numChars: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-mid-member(1))|Returns the characters from the middle of a text string, given a starting position and length.| +||[midb(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, startNum: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numBytes: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-midb-member(1))|Returns characters from the middle of a text string, given a starting position and length.| +||[min(...values: Array)](/.functions#excel-javascript/api/excel/-functions-min-member(1))|Returns the smallest number in a set of values.| +||[minA(...values: Array)](/.functions#excel-javascript/api/excel/-functions-mina-member(1))|Returns the smallest value in a set of values.| +||[minute(serialNumber: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-minute-member(1))|Returns the minute, a number from 0 to 59.| +||[mirr(values: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, financeRate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, reinvestRate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-mirr-member(1))|Returns the internal rate of return for a series of periodic cash flows, considering both cost of investment and interest on reinvestment of cash.| +||[mod(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, divisor: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-mod-member(1))|Returns the remainder after a number is divided by a divisor.| +||[month(serialNumber: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-month-member(1))|Returns the month, a number from 1 (January) to 12 (December).| +||[mround(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, multiple: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-mround-member(1))|Returns a number rounded to the desired multiple.| +||[multiNomial(...values: Array)](/.functions#excel-javascript/api/excel/-functions-multinomial-member(1))|Returns the multinomial of a set of numbers.| +||[n(value: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-n-member(1))|Converts non-number value to a number, dates to serial numbers, TRUE to 1, anything else to 0 (zero).| +||[na()](/.functions#excel-javascript/api/excel/-functions-na-member(1))|Returns the error value #N/A (value not available).| +||[negBinom_Dist(numberF: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numberS: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, probabilityS: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-negbinom_dist-member(1))|Returns the negative binomial distribution, the probability that there will be Number_f failures before the Number_s-th success, with Probability_s probability of a success.| +||[networkDays(startDate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, endDate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, holidays?: number \| string \| Excel.Range \| boolean \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-networkdays-member(1))|Returns the number of whole workdays between two dates.| +||[networkDays_Intl(startDate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, endDate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, weekend?: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, holidays?: number \| string \| Excel.Range \| boolean \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-networkdays_intl-member(1))|Returns the number of whole workdays between two dates with custom weekend parameters.| +||[nominal(effectRate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, npery: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-nominal-member(1))|Returns the annual nominal interest rate.| +||[norm_Dist(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, mean: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, standardDev: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-norm_dist-member(1))|Returns the normal distribution for the specified mean and standard deviation.| +||[norm_Inv(probability: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, mean: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, standardDev: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-norm_inv-member(1))|Returns the inverse of the normal cumulative distribution for the specified mean and standard deviation.| +||[norm_S_Dist(z: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-norm_s_dist-member(1))|Returns the standard normal distribution (has a mean of zero and a standard deviation of one).| +||[norm_S_Inv(probability: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-norm_s_inv-member(1))|Returns the inverse of the standard normal cumulative distribution (has a mean of zero and a standard deviation of one).| +||[not(logical: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-not-member(1))|Changes FALSE to TRUE, or TRUE to FALSE.| +||[now()](/.functions#excel-javascript/api/excel/-functions-now-member(1))|Returns the current date and time formatted as a date and time.| +||[nper(rate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pmt: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pv: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, fv?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, type?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-nper-member(1))|Returns the number of periods for an investment based on periodic, constant payments and a constant interest rate.| +||[npv(rate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, ...values: Array)](/.functions#excel-javascript/api/excel/-functions-npv-member(1))|Returns the net present value of an investment based on a discount rate and a series of future payments (negative values) and income (positive values).| +||[numberValue(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, decimalSeparator?: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, groupSeparator?: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-numbervalue-member(1))|Converts text to number in a locale-independent manner.| +||[oct2Bin(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, places?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-oct2bin-member(1))|Converts an octal number to binary.| +||[oct2Dec(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-oct2dec-member(1))|Converts an octal number to decimal.| +||[oct2Hex(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, places?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-oct2hex-member(1))|Converts an octal number to hexadecimal.| +||[odd(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-odd-member(1))|Rounds a positive number up and negative number down to the nearest odd integer.| +||[oddFPrice(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, issue: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, firstCoupon: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, yld: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, redemption: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-oddfprice-member(1))|Returns the price per $100 face value of a security with an odd first period.| +||[oddFYield(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, issue: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, firstCoupon: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pr: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, redemption: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-oddfyield-member(1))|Returns the yield of a security with an odd first period.| +||[oddLPrice(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, lastInterest: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, yld: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, redemption: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-oddlprice-member(1))|Returns the price per $100 face value of a security with an odd last period.| +||[oddLYield(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, lastInterest: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pr: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, redemption: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-oddlyield-member(1))|Returns the yield of a security with an odd last period.| +||[or(...values: Array)](/.functions#excel-javascript/api/excel/-functions-or-member(1))|Checks whether any of the arguments are TRUE, and returns TRUE or FALSE.| +||[pduration(rate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pv: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, fv: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-pduration-member(1))|Returns the number of periods required by an investment to reach a specified value.| +||[percentRank_Exc(array: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, significance?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-percentrank_exc-member(1))|Returns the rank of a value in a data set as a percentage (0..1, exclusive) of the data set.| +||[percentRank_Inc(array: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, significance?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-percentrank_inc-member(1))|Returns the rank of a value in a data set as a percentage (0..1, inclusive) of the data set.| +||[percentile_Exc(array: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, k: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-percentile_exc-member(1))|Returns the k-th percentile of values in a range, where k is in the range 0..1, exclusive.| +||[percentile_Inc(array: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, k: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-percentile_inc-member(1))|Returns the k-th percentile of values in a range, where k is in the range 0..1, inclusive.| +||[permut(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numberChosen: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-permut-member(1))|Returns the number of permutations for a given number of objects that can be selected from the total objects.| +||[permutationa(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numberChosen: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-permutationa-member(1))|Returns the number of permutations for a given number of objects (with repetitions) that can be selected from the total objects.| +||[phi(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-phi-member(1))|Returns the value of the density function for a standard normal distribution.| +||[pi()](/.functions#excel-javascript/api/excel/-functions-pi-member(1))|Returns the value of Pi, 3.14159265358979, accurate to 15 digits.| +||[pmt(rate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, nper: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pv: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, fv?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, type?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-pmt-member(1))|Calculates the payment for a loan based on constant payments and a constant interest rate.| +||[poisson_Dist(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, mean: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-poisson_dist-member(1))|Returns the Poisson distribution.| +||[power(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, power: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-power-member(1))|Returns the result of a number raised to a power.| +||[ppmt(rate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, per: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, nper: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pv: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, fv?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, type?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-ppmt-member(1))|Returns the payment on the principal for a given investment based on periodic, constant payments and a constant interest rate.| +||[price(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, yld: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, redemption: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-price-member(1))|Returns the price per $100 face value of a security that pays periodic interest.| +||[priceDisc(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, discount: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, redemption: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-pricedisc-member(1))|Returns the price per $100 face value of a discounted security.| +||[priceMat(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, issue: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, yld: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-pricemat-member(1))|Returns the price per $100 face value of a security that pays interest at maturity.| +||[product(...values: Array)](/.functions#excel-javascript/api/excel/-functions-product-member(1))|Multiplies all the numbers given as arguments.| +||[proper(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-proper-member(1))|Converts a text string to proper case; the first letter in each word to uppercase, and all other letters to lowercase.| +||[pv(rate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, nper: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pmt: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, fv?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, type?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-pv-member(1))|Returns the present value of an investment: the total amount that a series of future payments is worth now.| +||[quartile_Exc(array: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, quart: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-quartile_exc-member(1))|Returns the quartile of a data set, based on percentile values from 0..1, exclusive.| +||[quartile_Inc(array: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, quart: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-quartile_inc-member(1))|Returns the quartile of a data set, based on percentile values from 0..1, inclusive.| +||[quotient(numerator: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, denominator: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-quotient-member(1))|Returns the integer portion of a division.| +||[radians(angle: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-radians-member(1))|Converts degrees to radians.| +||[rand()](/.functions#excel-javascript/api/excel/-functions-rand-member(1))|Returns a random number greater than or equal to 0 and less than 1, evenly distributed (changes on recalculation).| +||[randBetween(bottom: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, top: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-randbetween-member(1))|Returns a random number between the numbers you specify.| +||[rank_Avg(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, ref: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, order?: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-rank_avg-member(1))|Returns the rank of a number in a list of numbers: its size relative to other values in the list; if more than one value has the same rank, the average rank is returned.| +||[rank_Eq(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, ref: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, order?: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-rank_eq-member(1))|Returns the rank of a number in a list of numbers: its size relative to other values in the list; if more than one value has the same rank, the top rank of that set of values is returned.| +||[rate(nper: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pmt: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pv: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, fv?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, type?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, guess?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-rate-member(1))|Returns the interest rate per period of a loan or an investment.| +||[received(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, investment: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, discount: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-received-member(1))|Returns the amount received at maturity for a fully invested security.| +||[replace(oldText: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, startNum: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numChars: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, newText: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-replace-member(1))|Replaces part of a text string with a different text string.| +||[replaceB(oldText: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, startNum: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numBytes: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, newText: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-replaceb-member(1))|Replaces part of a text string with a different text string.| +||[rept(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numberTimes: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-rept-member(1))|Repeats text a given number of times.| +||[right(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numChars?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-right-member(1))|Returns the specified number of characters from the end of a text string.| +||[rightb(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numBytes?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-rightb-member(1))|Returns the specified number of characters from the end of a text string.| +||[roman(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, form?: boolean \| number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-roman-member(1))|Converts an Arabic numeral to Roman, as text.| +||[round(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numDigits: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-round-member(1))|Rounds a number to a specified number of digits.| +||[roundDown(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numDigits: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-rounddown-member(1))|Rounds a number down, toward zero.| +||[roundUp(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numDigits: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-roundup-member(1))|Rounds a number up, away from zero.| +||[rows(array: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-rows-member(1))|Returns the number of rows in a reference or array.| +||[rri(nper: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pv: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, fv: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-rri-member(1))|Returns an equivalent interest rate for the growth of an investment.| +||[sec(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-sec-member(1))|Returns the secant of an angle.| +||[sech(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-sech-member(1))|Returns the hyperbolic secant of an angle.| +||[second(serialNumber: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-second-member(1))|Returns the second, a number from 0 to 59.| +||[seriesSum(x: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, n: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, m: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, coefficients: Excel.Range \| string \| number \| boolean \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-seriessum-member(1))|Returns the sum of a power series based on the formula.| +||[sheet(value?: Excel.Range \| string \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-sheet-member(1))|Returns the sheet number of the referenced sheet.| +||[sheets(reference?: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-sheets-member(1))|Returns the number of sheets in a reference.| +||[sign(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-sign-member(1))|Returns the sign of a number: 1 if the number is positive, zero if the number is zero, or -1 if the number is negative.| +||[sin(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-sin-member(1))|Returns the sine of an angle.| +||[sinh(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-sinh-member(1))|Returns the hyperbolic sine of a number.| +||[skew(...values: Array)](/.functions#excel-javascript/api/excel/-functions-skew-member(1))|Returns the skewness of a distribution: a characterization of the degree of asymmetry of a distribution around its mean.| +||[skew_p(...values: Array)](/.functions#excel-javascript/api/excel/-functions-skew_p-member(1))|Returns the skewness of a distribution based on a population: a characterization of the degree of asymmetry of a distribution around its mean.| +||[sln(cost: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, salvage: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, life: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-sln-member(1))|Returns the straight-line depreciation of an asset for one period.| +||[small(array: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, k: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-small-member(1))|Returns the k-th smallest value in a data set.| +||[sqrt(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-sqrt-member(1))|Returns the square root of a number.| +||[sqrtPi(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-sqrtpi-member(1))|Returns the square root of (number * Pi).| +||[stDevA(...values: Array)](/.functions#excel-javascript/api/excel/-functions-stdeva-member(1))|Estimates standard deviation based on a sample, including logical values and text.| +||[stDevPA(...values: Array)](/.functions#excel-javascript/api/excel/-functions-stdevpa-member(1))|Calculates standard deviation based on an entire population, including logical values and text.| +||[stDev_P(...values: Array)](/.functions#excel-javascript/api/excel/-functions-stdev_p-member(1))|Calculates standard deviation based on the entire population given as arguments (ignores logical values and text).| +||[stDev_S(...values: Array)](/.functions#excel-javascript/api/excel/-functions-stdev_s-member(1))|Estimates standard deviation based on a sample (ignores logical values and text in the sample).| +||[standardize(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, mean: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, standardDev: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-standardize-member(1))|Returns a normalized value from a distribution characterized by a mean and standard deviation.| +||[substitute(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, oldText: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, newText: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, instanceNum?: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-substitute-member(1))|Replaces existing text with new text in a text string.| +||[subtotal(functionNum: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, ...values: Array)](/.functions#excel-javascript/api/excel/-functions-subtotal-member(1))|Returns a subtotal in a list or database.| +||[sum(...values: Array)](/.functions#excel-javascript/api/excel/-functions-sum-member(1))|Adds all the numbers in a range of cells.| +||[sumIf(range: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, sumRange?: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-sumif-member(1))|Adds the cells specified by a given condition or criteria.| +||[sumIfs(sumRange: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, ...values: Array)](/.functions#excel-javascript/api/excel/-functions-sumifs-member(1))|Adds the cells specified by a given set of conditions or criteria.| +||[sumSq(...values: Array)](/.functions#excel-javascript/api/excel/-functions-sumsq-member(1))|Returns the sum of the squares of the arguments.| +||[syd(cost: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, salvage: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, life: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, per: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-syd-member(1))|Returns the sum-of-years' digits depreciation of an asset for a specified period.| +||[t(value: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-t-member(1))|Checks whether a value is text, and returns the text if it is, or returns double quotes (empty text) if it is not.| +||[t_Dist(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-t_dist-member(1))|Returns the left-tailed Student's t-distribution.| +||[t_Dist_2T(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-t_dist_2t-member(1))|Returns the two-tailed Student's t-distribution.| +||[t_Dist_RT(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-t_dist_rt-member(1))|Returns the right-tailed Student's t-distribution.| +||[t_Inv(probability: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-t_inv-member(1))|Returns the left-tailed inverse of the Student's t-distribution.| +||[t_Inv_2T(probability: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-t_inv_2t-member(1))|Returns the two-tailed inverse of the Student's t-distribution.| +||[tan(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-tan-member(1))|Returns the tangent of an angle.| +||[tanh(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-tanh-member(1))|Returns the hyperbolic tangent of a number.| +||[tbillEq(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, discount: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-tbilleq-member(1))|Returns the bond-equivalent yield for a treasury bill.| +||[tbillPrice(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, discount: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-tbillprice-member(1))|Returns the price per $100 face value for a treasury bill.| +||[tbillYield(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pr: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-tbillyield-member(1))|Returns the yield for a treasury bill.| +||[text(value: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, formatText: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-text-member(1))|Converts a value to text in a specific number format.| +||[time(hour: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, minute: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, second: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-time-member(1))|Converts hours, minutes, and seconds given as numbers to an Excel serial number, formatted with a time format.| +||[timevalue(timeText: string \| number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-timevalue-member(1))|Converts a text time to an Excel serial number for a time, a number from 0 (12:00:00 AM) to 0.999988426 (11:59:59 PM).| +||[today()](/.functions#excel-javascript/api/excel/-functions-today-member(1))|Returns the current date formatted as a date.| +||[trim(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-trim-member(1))|Removes all spaces from a text string except for single spaces between words.| +||[trimMean(array: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, percent: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-trimmean-member(1))|Returns the mean of the interior portion of a set of data values.| +||[true()](/.functions#excel-javascript/api/excel/-functions-true-member(1))|Returns the logical value TRUE.| +||[trunc(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numDigits?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-trunc-member(1))|Truncates a number to an integer by removing the decimal, or fractional, part of the number.| +||[type(value: boolean \| string \| number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-type-member(1))|Returns an integer representing the data type of a value: number = 1; text = 2; logical value = 4; error value = 16; array = 64; compound data = 128.| +||[unichar(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-unichar-member(1))|Returns the Unicode character referenced by the given numeric value.| +||[unicode(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-unicode-member(1))|Returns the number (code point) corresponding to the first character of the text.| +||[upper(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-upper-member(1))|Converts a text string to all uppercase letters.| +||[usdollar(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, decimals?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-usdollar-member(1))|Converts a number to text, using currency format.| +||[value(text: string \| boolean \| number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-value-member(1))|Converts a text string that represents a number to a number.| +||[varA(...values: Array)](/.functions#excel-javascript/api/excel/-functions-vara-member(1))|Estimates variance based on a sample, including logical values and text.| +||[varPA(...values: Array)](/.functions#excel-javascript/api/excel/-functions-varpa-member(1))|Calculates variance based on the entire population, including logical values and text.| +||[var_P(...values: Array)](/.functions#excel-javascript/api/excel/-functions-var_p-member(1))|Calculates variance based on the entire population (ignores logical values and text in the population).| +||[var_S(...values: Array)](/.functions#excel-javascript/api/excel/-functions-var_s-member(1))|Estimates variance based on a sample (ignores logical values and text in the sample).| +||[vdb(cost: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, salvage: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, life: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, startPeriod: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, endPeriod: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, factor?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, noSwitch?: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-vdb-member(1))|Returns the depreciation of an asset for any period you specify, including partial periods, using the double-declining balance method or some other method you specify.| +||[vlookup(lookupValue: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, tableArray: Excel.Range \| number \| Excel.RangeReference \| Excel.FunctionResult, colIndexNum: Excel.Range \| number \| Excel.RangeReference \| Excel.FunctionResult, rangeLookup?: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-vlookup-member(1))|Looks for a value in the leftmost column of a table, and then returns a value in the same row from a column you specify.| +||[weekNum(serialNumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, returnType?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-weeknum-member(1))|Returns the week number in the year.| +||[weekday(serialNumber: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, returnType?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-weekday-member(1))|Returns a number from 1 to 7 identifying the day of the week of a date.| +||[weibull_Dist(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, alpha: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, beta: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-weibull_dist-member(1))|Returns the Weibull distribution.| +||[workDay(startDate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, days: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, holidays?: number \| string \| Excel.Range \| boolean \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-workday-member(1))|Returns the serial number of the date before or after a specified number of workdays.| +||[workDay_Intl(startDate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, days: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, weekend?: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, holidays?: number \| string \| Excel.Range \| boolean \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-workday_intl-member(1))|Returns the serial number of the date before or after a specified number of workdays with custom weekend parameters.| +||[xirr(values: number \| string \| Excel.Range \| boolean \| Excel.RangeReference \| Excel.FunctionResult, dates: number \| string \| Excel.Range \| boolean \| Excel.RangeReference \| Excel.FunctionResult, guess?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-xirr-member(1))|Returns the internal rate of return for a schedule of cash flows.| +||[xnpv(rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, values: number \| string \| Excel.Range \| boolean \| Excel.RangeReference \| Excel.FunctionResult, dates: number \| string \| Excel.Range \| boolean \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-xnpv-member(1))|Returns the net present value for a schedule of cash flows.| +||[xor(...values: Array)](/.functions#excel-javascript/api/excel/-functions-xor-member(1))|Returns a logical 'Exclusive Or' of all arguments.| +||[year(serialNumber: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-year-member(1))|Returns the year of a date, an integer in the range 1900 - 9999.| +||[yearFrac(startDate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, endDate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-yearfrac-member(1))|Returns the year fraction representing the number of whole days between start_date and end_date.| +||[yield(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pr: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, redemption: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-yield-member(1))|Returns the yield on a security that pays periodic interest.| +||[yieldDisc(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pr: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, redemption: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-yielddisc-member(1))|Returns the annual yield for a discounted security.| +||[yieldMat(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, issue: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pr: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-yieldmat-member(1))|Returns the annual yield of a security that pays interest at maturity.| +||[z_Test(array: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, sigma?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-z_test-member(1))|Returns the one-tailed P-value of a z-test.| +|[Icon](/.icon)|[index](/.icon#excel-javascript/api/excel/-icon-index-member)|Specifies the index of the icon in the given set.| +|[IconCollections](/.iconcollections)|[fiveArrows](/.iconcollections#excel-javascript/api/excel/-iconcollections-fivearrows-member)|| +||[fiveArrowsGray](/.iconcollections#excel-javascript/api/excel/-iconcollections-fivearrowsgray-member)|| +||[fiveBoxes](/.iconcollections#excel-javascript/api/excel/-iconcollections-fiveboxes-member)|[Api set: ExcelApi 1.2]| +||[fiveQuarters](/.iconcollections#excel-javascript/api/excel/-iconcollections-fivequarters-member)|| +||[fiveRating](/.iconcollections#excel-javascript/api/excel/-iconcollections-fiverating-member)|| +||[fourArrows](/.iconcollections#excel-javascript/api/excel/-iconcollections-fourarrows-member)|| +||[fourArrowsGray](/.iconcollections#excel-javascript/api/excel/-iconcollections-fourarrowsgray-member)|| +||[fourRating](/.iconcollections#excel-javascript/api/excel/-iconcollections-fourrating-member)|| +||[fourRedToBlack](/.iconcollections#excel-javascript/api/excel/-iconcollections-fourredtoblack-member)|| +||[fourTrafficLights](/.iconcollections#excel-javascript/api/excel/-iconcollections-fourtrafficlights-member)|| +||[threeArrows](/.iconcollections#excel-javascript/api/excel/-iconcollections-threearrows-member)|| +||[threeArrowsGray](/.iconcollections#excel-javascript/api/excel/-iconcollections-threearrowsgray-member)|| +||[threeFlags](/.iconcollections#excel-javascript/api/excel/-iconcollections-threeflags-member)|| +||[threeSigns](/.iconcollections#excel-javascript/api/excel/-iconcollections-threesigns-member)|| +||[threeStars](/.iconcollections#excel-javascript/api/excel/-iconcollections-threestars-member)|| +||[threeSymbols2](/.iconcollections#excel-javascript/api/excel/-iconcollections-threesymbols2-member)|| +||[threeSymbols](/.iconcollections#excel-javascript/api/excel/-iconcollections-threesymbols-member)|| +||[threeTrafficLights1](/.iconcollections#excel-javascript/api/excel/-iconcollections-threetrafficlights1-member)|| +||[threeTrafficLights2](/.iconcollections#excel-javascript/api/excel/-iconcollections-threetrafficlights2-member)|| +||[threeTriangles](/.iconcollections#excel-javascript/api/excel/-iconcollections-threetriangles-member)|| +|[Range](/.range)|[columnHidden](/.range#excel-javascript/api/excel/-range-columnhidden-member)|Represents if all columns in the current range are hidden.| +||[formulasR1C1](/.range#excel-javascript/api/excel/-range-formulasr1c1-member)|Represents the formula in R1C1-style notation.| +||[getColumnsAfter(count?: number)](/.range#excel-javascript/api/excel/-range-getcolumnsafter-member(1))|Gets a certain number of columns to the right of the current `Range` object.| +||[getColumnsBefore(count?: number)](/.range#excel-javascript/api/excel/-range-getcolumnsbefore-member(1))|Gets a certain number of columns to the left of the current `Range` object.| +||[getResizedRange(deltaRows: number, deltaColumns: number)](/.range#excel-javascript/api/excel/-range-getresizedrange-member(1))|Gets a `Range` object similar to the current `Range` object, but with its bottom-right corner expanded (or contracted) by some number of rows and columns.| +||[getRowsAbove(count?: number)](/.range#excel-javascript/api/excel/-range-getrowsabove-member(1))|Gets a certain number of rows above the current `Range` object.| +||[getRowsBelow(count?: number)](/.range#excel-javascript/api/excel/-range-getrowsbelow-member(1))|Gets a certain number of rows below the current `Range` object.| +||[getUsedRange(valuesOnly?: boolean)](/.range#excel-javascript/api/excel/-range-getusedrange-member(1))|Returns the used range of the given range object.| +||[hidden](/.range#excel-javascript/api/excel/-range-hidden-member)|Represents if all cells in the current range are hidden.| +||[merge(across?: boolean)](/.range#excel-javascript/api/excel/-range-merge-member(1))|Merge the range cells into one region in the worksheet.| +||[rowHidden](/.range#excel-javascript/api/excel/-range-rowhidden-member)|Represents if all rows in the current range are hidden.| +||[sort](/.range#excel-javascript/api/excel/-range-sort-member)|Represents the range sort of the current range.| +||[unmerge()](/.range#excel-javascript/api/excel/-range-unmerge-member(1))|Unmerge the range cells into separate cells.| +|[RangeFormat](/.rangeformat)|[autofitColumns()](/.rangeformat#excel-javascript/api/excel/-rangeformat-autofitcolumns-member(1))|Changes the width of the columns of the current range to achieve the best fit, based on the current data in the columns.| +||[autofitRows()](/.rangeformat#excel-javascript/api/excel/-rangeformat-autofitrows-member(1))|Changes the height of the rows of the current range to achieve the best fit, based on the current data in the columns.| +||[columnWidth](/.rangeformat#excel-javascript/api/excel/-rangeformat-columnwidth-member)|Specifies the width of all columns within the range.| +||[protection](/.rangeformat#excel-javascript/api/excel/-rangeformat-protection-member)|Returns the format protection object for a range.| +||[rowHeight](/.rangeformat#excel-javascript/api/excel/-rangeformat-rowheight-member)|The height of all rows in the range.| +|[RangeReference](/.rangereference)|[address](/.rangereference#excel-javascript/api/excel/-rangereference-address-member)|The address of the range, for example "SheetName!A1:B5".| +|[RangeSort](/.rangesort)|[apply(fields: Excel.SortField[], matchCase?: boolean, hasHeaders?: boolean, orientation?: Excel.SortOrientation, method?: Excel.SortMethod)](/.rangesort#excel-javascript/api/excel/-rangesort-apply-member(1))|Perform a sort operation.| +|[SelectionChangedEventArgs](/.selectionchangedeventargs)|[workbook](/.selectionchangedeventargs#excel-javascript/api/excel/-selectionchangedeventargs-workbook-member)|Gets the workbook object that raised the selection changed event.| +|[SortField](/.sortfield)|[ascending](/.sortfield#excel-javascript/api/excel/-sortfield-ascending-member)|Specifies if the sorting is done in an ascending fashion.| +||[color](/.sortfield#excel-javascript/api/excel/-sortfield-color-member)|Specifies the color that is the target of the condition if the sorting is on font or cell color.| +||[dataOption](/.sortfield#excel-javascript/api/excel/-sortfield-dataoption-member)|Represents additional sorting options for this field.| +||[icon](/.sortfield#excel-javascript/api/excel/-sortfield-icon-member)|Specifies the icon that is the target of the condition, if the sorting is on the cell's icon.| +||[key](/.sortfield#excel-javascript/api/excel/-sortfield-key-member)|Specifies the column (or row, depending on the sort orientation) that the condition is on.| +||[sortOn](/.sortfield#excel-javascript/api/excel/-sortfield-sorton-member)|Specifies the type of sorting of this condition.| +|[Table](/.table)|[clearFilters()](/.table#excel-javascript/api/excel/-table-clearfilters-member(1))|Clears all the filters currently applied on the table.| +||[convertToRange()](/.table#excel-javascript/api/excel/-table-converttorange-member(1))|Converts the table into a normal range of cells.| +||[reapplyFilters()](/.table#excel-javascript/api/excel/-table-reapplyfilters-member(1))|Reapplies all the filters currently on the table.| +||[sort](/.table#excel-javascript/api/excel/-table-sort-member)|Represents the sorting for the table.| +||[worksheet](/.table#excel-javascript/api/excel/-table-worksheet-member)|The worksheet containing the current table.| +|[TableColumn](/.tablecolumn)|[filter](/.tablecolumn#excel-javascript/api/excel/-tablecolumn-filter-member)|Retrieves the filter applied to the column.| +|[TableSort](/.tablesort)|[apply(fields: Excel.SortField[], matchCase?: boolean, method?: Excel.SortMethod)](/.tablesort#excel-javascript/api/excel/-tablesort-apply-member(1))|Perform a sort operation.| +||[clear()](/.tablesort#excel-javascript/api/excel/-tablesort-clear-member(1))|Clears the sorting that is currently on the table.| +||[fields](/.tablesort#excel-javascript/api/excel/-tablesort-fields-member)|Specifies the current conditions used to last sort the table.| +||[matchCase](/.tablesort#excel-javascript/api/excel/-tablesort-matchcase-member)|Specifies if the casing impacts the last sort of the table.| +||[method](/.tablesort#excel-javascript/api/excel/-tablesort-method-member)|Represents the Chinese character ordering method last used to sort the table.| +||[reapply()](/.tablesort#excel-javascript/api/excel/-tablesort-reapply-member(1))|Reapplies the current sorting parameters to the table.| +|[ThreeArrowsGraySet](/.threearrowsgrayset)|[grayDownArrow](/.threearrowsgrayset#excel-javascript/api/excel/-threearrowsgrayset-graydownarrow-member)|| +||[graySideArrow](/.threearrowsgrayset#excel-javascript/api/excel/-threearrowsgrayset-graysidearrow-member)|| +||[grayUpArrow](/.threearrowsgrayset#excel-javascript/api/excel/-threearrowsgrayset-grayuparrow-member)|| +|[ThreeArrowsSet](/.threearrowsset)|[greenUpArrow](/.threearrowsset#excel-javascript/api/excel/-threearrowsset-greenuparrow-member)|| +||[redDownArrow](/.threearrowsset#excel-javascript/api/excel/-threearrowsset-reddownarrow-member)|| +||[yellowSideArrow](/.threearrowsset#excel-javascript/api/excel/-threearrowsset-yellowsidearrow-member)|| +|[ThreeFlagsSet](/.threeflagsset)|[greenFlag](/.threeflagsset#excel-javascript/api/excel/-threeflagsset-greenflag-member)|| +||[redFlag](/.threeflagsset#excel-javascript/api/excel/-threeflagsset-redflag-member)|| +||[yellowFlag](/.threeflagsset#excel-javascript/api/excel/-threeflagsset-yellowflag-member)|| +|[ThreeSignsSet](/.threesignsset)|[greenCircle](/.threesignsset#excel-javascript/api/excel/-threesignsset-greencircle-member)|| +||[redDiamond](/.threesignsset#excel-javascript/api/excel/-threesignsset-reddiamond-member)|| +||[yellowTriangle](/.threesignsset#excel-javascript/api/excel/-threesignsset-yellowtriangle-member)|| +|[ThreeStarsSet](/.threestarsset)|[goldStar](/.threestarsset#excel-javascript/api/excel/-threestarsset-goldstar-member)|| +||[halfGoldStar](/.threestarsset#excel-javascript/api/excel/-threestarsset-halfgoldstar-member)|| +||[silverStar](/.threestarsset#excel-javascript/api/excel/-threestarsset-silverstar-member)|| +|[ThreeSymbols2Set](/.threesymbols2set)|[greenCheck](/.threesymbols2set#excel-javascript/api/excel/-threesymbols2set-greencheck-member)|| +||[redCross](/.threesymbols2set#excel-javascript/api/excel/-threesymbols2set-redcross-member)|| +||[yellowExclamation](/.threesymbols2set#excel-javascript/api/excel/-threesymbols2set-yellowexclamation-member)|| +|[ThreeSymbolsSet](/.threesymbolsset)|[greenCheckSymbol](/.threesymbolsset#excel-javascript/api/excel/-threesymbolsset-greenchecksymbol-member)|| +||[redCrossSymbol](/.threesymbolsset#excel-javascript/api/excel/-threesymbolsset-redcrosssymbol-member)|| +||[yellowExclamationSymbol](/.threesymbolsset#excel-javascript/api/excel/-threesymbolsset-yellowexclamationsymbol-member)|| +|[ThreeTrafficLights1Set](/.threetrafficlights1set)|[greenCircle](/.threetrafficlights1set#excel-javascript/api/excel/-threetrafficlights1set-greencircle-member)|| +||[redCircleWithBorder](/.threetrafficlights1set#excel-javascript/api/excel/-threetrafficlights1set-redcirclewithborder-member)|| +||[yellowCircle](/.threetrafficlights1set#excel-javascript/api/excel/-threetrafficlights1set-yellowcircle-member)|| +|[ThreeTrafficLights2Set](/.threetrafficlights2set)|[greenTrafficLight](/.threetrafficlights2set#excel-javascript/api/excel/-threetrafficlights2set-greentrafficlight-member)|| +||[redTrafficLight](/.threetrafficlights2set#excel-javascript/api/excel/-threetrafficlights2set-redtrafficlight-member)|| +||[yellowTrafficLight](/.threetrafficlights2set#excel-javascript/api/excel/-threetrafficlights2set-yellowtrafficlight-member)|| +|[ThreeTrianglesSet](/.threetrianglesset)|[greenUpTriangle](/.threetrianglesset#excel-javascript/api/excel/-threetrianglesset-greenuptriangle-member)|| +||[redDownTriangle](/.threetrianglesset#excel-javascript/api/excel/-threetrianglesset-reddowntriangle-member)|| +||[yellowDash](/.threetrianglesset#excel-javascript/api/excel/-threetrianglesset-yellowdash-member)|| +|[Workbook](/.workbook)|[functions](/.workbook#excel-javascript/api/excel/-workbook-functions-member)|Represents a collection of worksheet functions that can be used for computation.| +||[onSelectionChanged](/.workbook#excel-javascript/api/excel/-workbook-onselectionchanged-member)|Occurs when the selection in the document is changed.| +|[Worksheet](/.worksheet)|[getUsedRange(valuesOnly?: boolean)](/.worksheet#excel-javascript/api/excel/-worksheet-getusedrange-member(1))|The used range is the smallest range that encompasses any cells that have a value or formatting assigned to them.| +||[protection](/.worksheet#excel-javascript/api/excel/-worksheet-protection-member)|Returns the sheet protection object for a worksheet.| +|[WorksheetProtection](/.worksheetprotection)|[options](/.worksheetprotection#excel-javascript/api/excel/-worksheetprotection-options-member)|Specifies the protection options for the worksheet.| +||[protect(options?: Excel.WorksheetProtectionOptions, password?: string)](/.worksheetprotection#excel-javascript/api/excel/-worksheetprotection-protect-member(1))|Protects a worksheet.| +||[protected](/.worksheetprotection#excel-javascript/api/excel/-worksheetprotection-protected-member)|Specifies if the worksheet is protected.| +|[WorksheetProtectionOptions](/.worksheetprotectionoptions)|[allowAutoFilter](/.worksheetprotectionoptions#excel-javascript/api/excel/-worksheetprotectionoptions-allowautofilter-member)|Represents the worksheet protection option allowing use of the AutoFilter feature.| +||[allowDeleteColumns](/.worksheetprotectionoptions#excel-javascript/api/excel/-worksheetprotectionoptions-allowdeletecolumns-member)|Represents the worksheet protection option allowing deleting of columns.| +||[allowDeleteRows](/.worksheetprotectionoptions#excel-javascript/api/excel/-worksheetprotectionoptions-allowdeleterows-member)|Represents the worksheet protection option allowing deleting of rows.| +||[allowFormatCells](/.worksheetprotectionoptions#excel-javascript/api/excel/-worksheetprotectionoptions-allowformatcells-member)|Represents the worksheet protection option allowing formatting of cells.| +||[allowFormatColumns](/.worksheetprotectionoptions#excel-javascript/api/excel/-worksheetprotectionoptions-allowformatcolumns-member)|Represents the worksheet protection option allowing formatting of columns.| +||[allowFormatRows](/.worksheetprotectionoptions#excel-javascript/api/excel/-worksheetprotectionoptions-allowformatrows-member)|Represents the worksheet protection option allowing formatting of rows.| +||[allowInsertColumns](/.worksheetprotectionoptions#excel-javascript/api/excel/-worksheetprotectionoptions-allowinsertcolumns-member)|Represents the worksheet protection option allowing inserting of columns.| +||[allowInsertHyperlinks](/.worksheetprotectionoptions#excel-javascript/api/excel/-worksheetprotectionoptions-allowinserthyperlinks-member)|Represents the worksheet protection option allowing inserting of hyperlinks.| +||[allowInsertRows](/.worksheetprotectionoptions#excel-javascript/api/excel/-worksheetprotectionoptions-allowinsertrows-member)|Represents the worksheet protection option allowing inserting of rows.| +||[allowPivotTables](/.worksheetprotectionoptions#excel-javascript/api/excel/-worksheetprotectionoptions-allowpivottables-member)|Represents the worksheet protection option allowing use of the PivotTable feature.| +||[allowSort](/.worksheetprotectionoptions#excel-javascript/api/excel/-worksheetprotectionoptions-allowsort-member)|Represents the worksheet protection option allowing use of the sort feature.| diff --git a/docs/includes/excel-1_20.md b/docs/includes/excel-1_20.md index 739f05f521..71f1261c73 100644 --- a/docs/includes/excel-1_20.md +++ b/docs/includes/excel-1_20.md @@ -1,6 +1,6 @@ | Class | Fields | Description | |:---|:---|:---| -|[CustomFunctionManager](/javascript/api/excel/excel.customfunctionmanager)||| -|[CustomFunctionVisibilityOptions](/javascript/api/excel/excel.customfunctionvisibilityoptions)|[hide](/javascript/api/excel/excel.customfunctionvisibilityoptions#excel-excel-customfunctionvisibilityoptions-hide-member)|A list of custom functions to hide from Excel AutoComplete.| -||[show](/javascript/api/excel/excel.customfunctionvisibilityoptions#excel-excel-customfunctionvisibilityoptions-show-member)|A list of custom functions to show in Excel AutoComplete.| -|[RunOptions](/javascript/api/excel/excel.runoptions)|[mergeUndoGroup](/javascript/api/excel/excel.runoptions#excel-excel-runoptions-mergeundogroup-member)|Determines whether the batch requests should be merged to one undo group.| +|[CustomFunctionManager](/.customfunctionmanager)||| +|[CustomFunctionVisibilityOptions](/.customfunctionvisibilityoptions)|[hide](/.customfunctionvisibilityoptions#excel-javascript/api/excel/-customfunctionvisibilityoptions-hide-member)|A list of custom functions to hide from Excel AutoComplete.| +||[show](/.customfunctionvisibilityoptions#excel-javascript/api/excel/-customfunctionvisibilityoptions-show-member)|A list of custom functions to show in Excel AutoComplete.| +|[RunOptions](/.runoptions)|[mergeUndoGroup](/.runoptions#excel-javascript/api/excel/-runoptions-mergeundogroup-member)|Determines whether the batch requests should be merged to one undo group.| diff --git a/docs/includes/excel-1_3.md b/docs/includes/excel-1_3.md index b0fcd43e4d..ce1e76293a 100644 --- a/docs/includes/excel-1_3.md +++ b/docs/includes/excel-1_3.md @@ -1,35 +1,35 @@ | Class | Fields | Description | |:---|:---|:---| -|[Binding](/javascript/api/excel/excel.binding)|[delete()](/javascript/api/excel/excel.binding#excel-excel-binding-delete-member(1))|Deletes the binding.| -|[BindingCollection](/javascript/api/excel/excel.bindingcollection)|[add(range: Range \| string, bindingType: Excel.BindingType, id: string)](/javascript/api/excel/excel.bindingcollection#excel-excel-bindingcollection-add-member(1))|Add a new binding to a particular Range.| -||[addFromNamedItem(name: string, bindingType: Excel.BindingType, id: string)](/javascript/api/excel/excel.bindingcollection#excel-excel-bindingcollection-addfromnameditem-member(1))|Add a new binding based on a named item in the workbook.| -||[addFromSelection(bindingType: Excel.BindingType, id: string)](/javascript/api/excel/excel.bindingcollection#excel-excel-bindingcollection-addfromselection-member(1))|Add a new binding based on the current selection.| -|[PivotTable](/javascript/api/excel/excel.pivottable)|[name](/javascript/api/excel/excel.pivottable#excel-excel-pivottable-name-member)|Name of the PivotTable.| -||[refresh()](/javascript/api/excel/excel.pivottable#excel-excel-pivottable-refresh-member(1))|Refreshes the PivotTable.| -||[worksheet](/javascript/api/excel/excel.pivottable#excel-excel-pivottable-worksheet-member)|The worksheet containing the current PivotTable.| -|[PivotTableCollection](/javascript/api/excel/excel.pivottablecollection)|[getItem(name: string)](/javascript/api/excel/excel.pivottablecollection#excel-excel-pivottablecollection-getitem-member(1))|Gets a PivotTable by name.| -||[items](/javascript/api/excel/excel.pivottablecollection#excel-excel-pivottablecollection-items-member)|Gets the loaded child items in this collection.| -||[refreshAll()](/javascript/api/excel/excel.pivottablecollection#excel-excel-pivottablecollection-refreshall-member(1))|Refreshes all the pivot tables in the collection.| -|[Range](/javascript/api/excel/excel.range)|[getVisibleView()](/javascript/api/excel/excel.range#excel-excel-range-getvisibleview-member(1))|Represents the visible rows of the current range.| -|[RangeView](/javascript/api/excel/excel.rangeview)|[cellAddresses](/javascript/api/excel/excel.rangeview#excel-excel-rangeview-celladdresses-member)|Represents the cell addresses of the `RangeView`.| -||[columnCount](/javascript/api/excel/excel.rangeview#excel-excel-rangeview-columncount-member)|The number of visible columns.| -||[formulas](/javascript/api/excel/excel.rangeview#excel-excel-rangeview-formulas-member)|Represents the formula in A1-style notation.| -||[formulasLocal](/javascript/api/excel/excel.rangeview#excel-excel-rangeview-formulaslocal-member)|Represents the formula in A1-style notation, in the user's language and number-formatting locale.| -||[formulasR1C1](/javascript/api/excel/excel.rangeview#excel-excel-rangeview-formulasr1c1-member)|Represents the formula in R1C1-style notation.| -||[getRange()](/javascript/api/excel/excel.rangeview#excel-excel-rangeview-getrange-member(1))|Gets the parent range associated with the current `RangeView`.| -||[index](/javascript/api/excel/excel.rangeview#excel-excel-rangeview-index-member)|Returns a value that represents the index of the `RangeView`.| -||[numberFormat](/javascript/api/excel/excel.rangeview#excel-excel-rangeview-numberformat-member)|Represents Excel's number format code for the given cell.| -||[rowCount](/javascript/api/excel/excel.rangeview#excel-excel-rangeview-rowcount-member)|The number of visible rows.| -||[rows](/javascript/api/excel/excel.rangeview#excel-excel-rangeview-rows-member)|Represents a collection of range views associated with the range.| -||[text](/javascript/api/excel/excel.rangeview#excel-excel-rangeview-text-member)|Text values of the specified range.| -||[valueTypes](/javascript/api/excel/excel.rangeview#excel-excel-rangeview-valuetypes-member)|Represents the type of data of each cell.| -||[values](/javascript/api/excel/excel.rangeview#excel-excel-rangeview-values-member)|Represents the raw values of the specified range view.| -|[RangeViewCollection](/javascript/api/excel/excel.rangeviewcollection)|[getItemAt(index: number)](/javascript/api/excel/excel.rangeviewcollection#excel-excel-rangeviewcollection-getitemat-member(1))|Gets a `RangeView` row via its index.| -||[items](/javascript/api/excel/excel.rangeviewcollection#excel-excel-rangeviewcollection-items-member)|Gets the loaded child items in this collection.| -|[Table](/javascript/api/excel/excel.table)|[highlightFirstColumn](/javascript/api/excel/excel.table#excel-excel-table-highlightfirstcolumn-member)|Specifies if the first column contains special formatting.| -||[highlightLastColumn](/javascript/api/excel/excel.table#excel-excel-table-highlightlastcolumn-member)|Specifies if the last column contains special formatting.| -||[showBandedColumns](/javascript/api/excel/excel.table#excel-excel-table-showbandedcolumns-member)|Specifies if the columns show banded formatting in which odd columns are highlighted differently from even ones, to make reading the table easier.| -||[showBandedRows](/javascript/api/excel/excel.table#excel-excel-table-showbandedrows-member)|Specifies if the rows show banded formatting in which odd rows are highlighted differently from even ones, to make reading the table easier.| -||[showFilterButton](/javascript/api/excel/excel.table#excel-excel-table-showfilterbutton-member)|Specifies if the filter buttons are visible at the top of each column header.| -|[Workbook](/javascript/api/excel/excel.workbook)|[pivotTables](/javascript/api/excel/excel.workbook#excel-excel-workbook-pivottables-member)|Represents a collection of PivotTables associated with the workbook.| -|[Worksheet](/javascript/api/excel/excel.worksheet)|[pivotTables](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-pivottables-member)|Collection of PivotTables that are part of the worksheet.| +|[Binding](/.binding)|[delete()](/.binding#excel-javascript/api/excel/-binding-delete-member(1))|Deletes the binding.| +|[BindingCollection](/.bindingcollection)|[add(range: Range \| string, bindingType: Excel.BindingType, id: string)](/.bindingcollection#excel-javascript/api/excel/-bindingcollection-add-member(1))|Add a new binding to a particular Range.| +||[addFromNamedItem(name: string, bindingType: Excel.BindingType, id: string)](/.bindingcollection#excel-javascript/api/excel/-bindingcollection-addfromnameditem-member(1))|Add a new binding based on a named item in the workbook.| +||[addFromSelection(bindingType: Excel.BindingType, id: string)](/.bindingcollection#excel-javascript/api/excel/-bindingcollection-addfromselection-member(1))|Add a new binding based on the current selection.| +|[PivotTable](/.pivottable)|[name](/.pivottable#excel-javascript/api/excel/-pivottable-name-member)|Name of the PivotTable.| +||[refresh()](/.pivottable#excel-javascript/api/excel/-pivottable-refresh-member(1))|Refreshes the PivotTable.| +||[worksheet](/.pivottable#excel-javascript/api/excel/-pivottable-worksheet-member)|The worksheet containing the current PivotTable.| +|[PivotTableCollection](/.pivottablecollection)|[getItem(name: string)](/.pivottablecollection#excel-javascript/api/excel/-pivottablecollection-getitem-member(1))|Gets a PivotTable by name.| +||[items](/.pivottablecollection#excel-javascript/api/excel/-pivottablecollection-items-member)|Gets the loaded child items in this collection.| +||[refreshAll()](/.pivottablecollection#excel-javascript/api/excel/-pivottablecollection-refreshall-member(1))|Refreshes all the pivot tables in the collection.| +|[Range](/.range)|[getVisibleView()](/.range#excel-javascript/api/excel/-range-getvisibleview-member(1))|Represents the visible rows of the current range.| +|[RangeView](/.rangeview)|[cellAddresses](/.rangeview#excel-javascript/api/excel/-rangeview-celladdresses-member)|Represents the cell addresses of the `RangeView`.| +||[columnCount](/.rangeview#excel-javascript/api/excel/-rangeview-columncount-member)|The number of visible columns.| +||[formulas](/.rangeview#excel-javascript/api/excel/-rangeview-formulas-member)|Represents the formula in A1-style notation.| +||[formulasLocal](/.rangeview#excel-javascript/api/excel/-rangeview-formulaslocal-member)|Represents the formula in A1-style notation, in the user's language and number-formatting locale.| +||[formulasR1C1](/.rangeview#excel-javascript/api/excel/-rangeview-formulasr1c1-member)|Represents the formula in R1C1-style notation.| +||[getRange()](/.rangeview#excel-javascript/api/excel/-rangeview-getrange-member(1))|Gets the parent range associated with the current `RangeView`.| +||[index](/.rangeview#excel-javascript/api/excel/-rangeview-index-member)|Returns a value that represents the index of the `RangeView`.| +||[numberFormat](/.rangeview#excel-javascript/api/excel/-rangeview-numberformat-member)|Represents Excel's number format code for the given cell.| +||[rowCount](/.rangeview#excel-javascript/api/excel/-rangeview-rowcount-member)|The number of visible rows.| +||[rows](/.rangeview#excel-javascript/api/excel/-rangeview-rows-member)|Represents a collection of range views associated with the range.| +||[text](/.rangeview#excel-javascript/api/excel/-rangeview-text-member)|Text values of the specified range.| +||[valueTypes](/.rangeview#excel-javascript/api/excel/-rangeview-valuetypes-member)|Represents the type of data of each cell.| +||[values](/.rangeview#excel-javascript/api/excel/-rangeview-values-member)|Represents the raw values of the specified range view.| +|[RangeViewCollection](/.rangeviewcollection)|[getItemAt(index: number)](/.rangeviewcollection#excel-javascript/api/excel/-rangeviewcollection-getitemat-member(1))|Gets a `RangeView` row via its index.| +||[items](/.rangeviewcollection#excel-javascript/api/excel/-rangeviewcollection-items-member)|Gets the loaded child items in this collection.| +|[Table](/.table)|[highlightFirstColumn](/.table#excel-javascript/api/excel/-table-highlightfirstcolumn-member)|Specifies if the first column contains special formatting.| +||[highlightLastColumn](/.table#excel-javascript/api/excel/-table-highlightlastcolumn-member)|Specifies if the last column contains special formatting.| +||[showBandedColumns](/.table#excel-javascript/api/excel/-table-showbandedcolumns-member)|Specifies if the columns show banded formatting in which odd columns are highlighted differently from even ones, to make reading the table easier.| +||[showBandedRows](/.table#excel-javascript/api/excel/-table-showbandedrows-member)|Specifies if the rows show banded formatting in which odd rows are highlighted differently from even ones, to make reading the table easier.| +||[showFilterButton](/.table#excel-javascript/api/excel/-table-showfilterbutton-member)|Specifies if the filter buttons are visible at the top of each column header.| +|[Workbook](/.workbook)|[pivotTables](/.workbook#excel-javascript/api/excel/-workbook-pivottables-member)|Represents a collection of PivotTables associated with the workbook.| +|[Worksheet](/.worksheet)|[pivotTables](/.worksheet#excel-javascript/api/excel/-worksheet-pivottables-member)|Collection of PivotTables that are part of the worksheet.| diff --git a/docs/includes/excel-1_4.md b/docs/includes/excel-1_4.md index 95c773bad7..9f9d704e7c 100644 --- a/docs/includes/excel-1_4.md +++ b/docs/includes/excel-1_4.md @@ -1,43 +1,43 @@ | Class | Fields | Description | |:---|:---|:---| -|[BindingCollection](/javascript/api/excel/excel.bindingcollection)|[getCount()](/javascript/api/excel/excel.bindingcollection#excel-excel-bindingcollection-getcount-member(1))|Gets the number of bindings in the collection.| -||[getItemOrNullObject(id: string)](/javascript/api/excel/excel.bindingcollection#excel-excel-bindingcollection-getitemornullobject-member(1))|Gets a binding object by ID.| -|[ChartCollection](/javascript/api/excel/excel.chartcollection)|[getCount()](/javascript/api/excel/excel.chartcollection#excel-excel-chartcollection-getcount-member(1))|Returns the number of charts in the worksheet.| -||[getItemOrNullObject(name: string)](/javascript/api/excel/excel.chartcollection#excel-excel-chartcollection-getitemornullobject-member(1))|Gets a chart using its name.| -|[ChartPointsCollection](/javascript/api/excel/excel.chartpointscollection)|[getCount()](/javascript/api/excel/excel.chartpointscollection#excel-excel-chartpointscollection-getcount-member(1))|Returns the number of chart points in the series.| -|[ChartSeriesCollection](/javascript/api/excel/excel.chartseriescollection)|[getCount()](/javascript/api/excel/excel.chartseriescollection#excel-excel-chartseriescollection-getcount-member(1))|Returns the number of series in the collection.| -|[NamedItem](/javascript/api/excel/excel.nameditem)|[comment](/javascript/api/excel/excel.nameditem#excel-excel-nameditem-comment-member)|Specifies the comment associated with this name.| -||[delete()](/javascript/api/excel/excel.nameditem#excel-excel-nameditem-delete-member(1))|Deletes the given name.| -||[getRangeOrNullObject()](/javascript/api/excel/excel.nameditem#excel-excel-nameditem-getrangeornullobject-member(1))|Returns the range object that is associated with the name.| -||[scope](/javascript/api/excel/excel.nameditem#excel-excel-nameditem-scope-member)|Specifies if the name is scoped to the workbook or to a specific worksheet.| -||[worksheet](/javascript/api/excel/excel.nameditem#excel-excel-nameditem-worksheet-member)|Returns the worksheet on which the named item is scoped to.| -||[worksheetOrNullObject](/javascript/api/excel/excel.nameditem#excel-excel-nameditem-worksheetornullobject-member)|Returns the worksheet to which the named item is scoped.| -|[NamedItemCollection](/javascript/api/excel/excel.nameditemcollection)|[add(name: string, reference: Range \| string, comment?: string)](/javascript/api/excel/excel.nameditemcollection#excel-excel-nameditemcollection-add-member(1))|Adds a new name to the collection of the given scope.| -||[addFormulaLocal(name: string, formula: string, comment?: string)](/javascript/api/excel/excel.nameditemcollection#excel-excel-nameditemcollection-addformulalocal-member(1))|Adds a new name to the collection of the given scope using the user's locale for the formula.| -||[getCount()](/javascript/api/excel/excel.nameditemcollection#excel-excel-nameditemcollection-getcount-member(1))|Gets the number of named items in the collection.| -||[getItemOrNullObject(name: string)](/javascript/api/excel/excel.nameditemcollection#excel-excel-nameditemcollection-getitemornullobject-member(1))|Gets a `NamedItem` object using its name.| -|[PivotTableCollection](/javascript/api/excel/excel.pivottablecollection)|[getCount()](/javascript/api/excel/excel.pivottablecollection#excel-excel-pivottablecollection-getcount-member(1))|Gets the number of pivot tables in the collection.| -||[getItemOrNullObject(name: string)](/javascript/api/excel/excel.pivottablecollection#excel-excel-pivottablecollection-getitemornullobject-member(1))|Gets a PivotTable by name.| -|[Range](/javascript/api/excel/excel.range)|[getIntersectionOrNullObject(anotherRange: Range \| string)](/javascript/api/excel/excel.range#excel-excel-range-getintersectionornullobject-member(1))|Gets the range object that represents the rectangular intersection of the given ranges.| -||[getUsedRangeOrNullObject(valuesOnly?: boolean)](/javascript/api/excel/excel.range#excel-excel-range-getusedrangeornullobject-member(1))|Returns the used range of the given range object.| -|[RangeViewCollection](/javascript/api/excel/excel.rangeviewcollection)|[getCount()](/javascript/api/excel/excel.rangeviewcollection#excel-excel-rangeviewcollection-getcount-member(1))|Gets the number of `RangeView` objects in the collection.| -|[Setting](/javascript/api/excel/excel.setting)|[delete()](/javascript/api/excel/excel.setting#excel-excel-setting-delete-member(1))|Deletes the setting.| -||[key](/javascript/api/excel/excel.setting#excel-excel-setting-key-member)|The key that represents the ID of the setting.| -||[value](/javascript/api/excel/excel.setting#excel-excel-setting-value-member)|Represents the value stored for this setting.| -|[SettingCollection](/javascript/api/excel/excel.settingcollection)|[add(key: string, value: string \| number \| boolean \| Date \| any[] \| any)](/javascript/api/excel/excel.settingcollection#excel-excel-settingcollection-add-member(1))|Sets or adds the specified setting to the workbook.| -||[getCount()](/javascript/api/excel/excel.settingcollection#excel-excel-settingcollection-getcount-member(1))|Gets the number of settings in the collection.| -||[getItem(key: string)](/javascript/api/excel/excel.settingcollection#excel-excel-settingcollection-getitem-member(1))|Gets a setting entry via the key.| -||[getItemOrNullObject(key: string)](/javascript/api/excel/excel.settingcollection#excel-excel-settingcollection-getitemornullobject-member(1))|Gets a setting entry via the key.| -||[items](/javascript/api/excel/excel.settingcollection#excel-excel-settingcollection-items-member)|Gets the loaded child items in this collection.| -||[onSettingsChanged](/javascript/api/excel/excel.settingcollection#excel-excel-settingcollection-onsettingschanged-member)|Occurs when the settings in the document are changed.| -|[SettingsChangedEventArgs](/javascript/api/excel/excel.settingschangedeventargs)|[settings](/javascript/api/excel/excel.settingschangedeventargs#excel-excel-settingschangedeventargs-settings-member)|Gets the `Setting` object that represents the binding that raised the settings changed event| -|[TableCollection](/javascript/api/excel/excel.tablecollection)|[getCount()](/javascript/api/excel/excel.tablecollection#excel-excel-tablecollection-getcount-member(1))|Gets the number of tables in the collection.| -||[getItemOrNullObject(key: string)](/javascript/api/excel/excel.tablecollection#excel-excel-tablecollection-getitemornullobject-member(1))|Gets a table by name or ID.| -|[TableColumnCollection](/javascript/api/excel/excel.tablecolumncollection)|[getCount()](/javascript/api/excel/excel.tablecolumncollection#excel-excel-tablecolumncollection-getcount-member(1))|Gets the number of columns in the table.| -||[getItemOrNullObject(key: number \| string)](/javascript/api/excel/excel.tablecolumncollection#excel-excel-tablecolumncollection-getitemornullobject-member(1))|Gets a column object by name or ID.| -|[TableRowCollection](/javascript/api/excel/excel.tablerowcollection)|[getCount()](/javascript/api/excel/excel.tablerowcollection#excel-excel-tablerowcollection-getcount-member(1))|Gets the number of rows in the table.| -|[Workbook](/javascript/api/excel/excel.workbook)|[settings](/javascript/api/excel/excel.workbook#excel-excel-workbook-settings-member)|Represents a collection of settings associated with the workbook.| -|[Worksheet](/javascript/api/excel/excel.worksheet)|[getUsedRangeOrNullObject(valuesOnly?: boolean)](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-getusedrangeornullobject-member(1))|The used range is the smallest range that encompasses any cells that have a value or formatting assigned to them.| -||[names](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-names-member)|Collection of names scoped to the current worksheet.| -|[WorksheetCollection](/javascript/api/excel/excel.worksheetcollection)|[getCount(visibleOnly?: boolean)](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-getcount-member(1))|Gets the number of worksheets in the collection.| -||[getItemOrNullObject(key: string)](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-getitemornullobject-member(1))|Gets a worksheet object using its name or ID.| +|[BindingCollection](/.bindingcollection)|[getCount()](/.bindingcollection#excel-javascript/api/excel/-bindingcollection-getcount-member(1))|Gets the number of bindings in the collection.| +||[getItemOrNullObject(id: string)](/.bindingcollection#excel-javascript/api/excel/-bindingcollection-getitemornullobject-member(1))|Gets a binding object by ID.| +|[ChartCollection](/.chartcollection)|[getCount()](/.chartcollection#excel-javascript/api/excel/-chartcollection-getcount-member(1))|Returns the number of charts in the worksheet.| +||[getItemOrNullObject(name: string)](/.chartcollection#excel-javascript/api/excel/-chartcollection-getitemornullobject-member(1))|Gets a chart using its name.| +|[ChartPointsCollection](/.chartpointscollection)|[getCount()](/.chartpointscollection#excel-javascript/api/excel/-chartpointscollection-getcount-member(1))|Returns the number of chart points in the series.| +|[ChartSeriesCollection](/.chartseriescollection)|[getCount()](/.chartseriescollection#excel-javascript/api/excel/-chartseriescollection-getcount-member(1))|Returns the number of series in the collection.| +|[NamedItem](/.nameditem)|[comment](/.nameditem#excel-javascript/api/excel/-nameditem-comment-member)|Specifies the comment associated with this name.| +||[delete()](/.nameditem#excel-javascript/api/excel/-nameditem-delete-member(1))|Deletes the given name.| +||[getRangeOrNullObject()](/.nameditem#excel-javascript/api/excel/-nameditem-getrangeornullobject-member(1))|Returns the range object that is associated with the name.| +||[scope](/.nameditem#excel-javascript/api/excel/-nameditem-scope-member)|Specifies if the name is scoped to the workbook or to a specific worksheet.| +||[worksheet](/.nameditem#excel-javascript/api/excel/-nameditem-worksheet-member)|Returns the worksheet on which the named item is scoped to.| +||[worksheetOrNullObject](/.nameditem#excel-javascript/api/excel/-nameditem-worksheetornullobject-member)|Returns the worksheet to which the named item is scoped.| +|[NamedItemCollection](/.nameditemcollection)|[add(name: string, reference: Range \| string, comment?: string)](/.nameditemcollection#excel-javascript/api/excel/-nameditemcollection-add-member(1))|Adds a new name to the collection of the given scope.| +||[addFormulaLocal(name: string, formula: string, comment?: string)](/.nameditemcollection#excel-javascript/api/excel/-nameditemcollection-addformulalocal-member(1))|Adds a new name to the collection of the given scope using the user's locale for the formula.| +||[getCount()](/.nameditemcollection#excel-javascript/api/excel/-nameditemcollection-getcount-member(1))|Gets the number of named items in the collection.| +||[getItemOrNullObject(name: string)](/.nameditemcollection#excel-javascript/api/excel/-nameditemcollection-getitemornullobject-member(1))|Gets a `NamedItem` object using its name.| +|[PivotTableCollection](/.pivottablecollection)|[getCount()](/.pivottablecollection#excel-javascript/api/excel/-pivottablecollection-getcount-member(1))|Gets the number of pivot tables in the collection.| +||[getItemOrNullObject(name: string)](/.pivottablecollection#excel-javascript/api/excel/-pivottablecollection-getitemornullobject-member(1))|Gets a PivotTable by name.| +|[Range](/.range)|[getIntersectionOrNullObject(anotherRange: Range \| string)](/.range#excel-javascript/api/excel/-range-getintersectionornullobject-member(1))|Gets the range object that represents the rectangular intersection of the given ranges.| +||[getUsedRangeOrNullObject(valuesOnly?: boolean)](/.range#excel-javascript/api/excel/-range-getusedrangeornullobject-member(1))|Returns the used range of the given range object.| +|[RangeViewCollection](/.rangeviewcollection)|[getCount()](/.rangeviewcollection#excel-javascript/api/excel/-rangeviewcollection-getcount-member(1))|Gets the number of `RangeView` objects in the collection.| +|[Setting](/.setting)|[delete()](/.setting#excel-javascript/api/excel/-setting-delete-member(1))|Deletes the setting.| +||[key](/.setting#excel-javascript/api/excel/-setting-key-member)|The key that represents the ID of the setting.| +||[value](/.setting#excel-javascript/api/excel/-setting-value-member)|Represents the value stored for this setting.| +|[SettingCollection](/.settingcollection)|[add(key: string, value: string \| number \| boolean \| Date \| any[] \| any)](/.settingcollection#excel-javascript/api/excel/-settingcollection-add-member(1))|Sets or adds the specified setting to the workbook.| +||[getCount()](/.settingcollection#excel-javascript/api/excel/-settingcollection-getcount-member(1))|Gets the number of settings in the collection.| +||[getItem(key: string)](/.settingcollection#excel-javascript/api/excel/-settingcollection-getitem-member(1))|Gets a setting entry via the key.| +||[getItemOrNullObject(key: string)](/.settingcollection#excel-javascript/api/excel/-settingcollection-getitemornullobject-member(1))|Gets a setting entry via the key.| +||[items](/.settingcollection#excel-javascript/api/excel/-settingcollection-items-member)|Gets the loaded child items in this collection.| +||[onSettingsChanged](/.settingcollection#excel-javascript/api/excel/-settingcollection-onsettingschanged-member)|Occurs when the settings in the document are changed.| +|[SettingsChangedEventArgs](/.settingschangedeventargs)|[settings](/.settingschangedeventargs#excel-javascript/api/excel/-settingschangedeventargs-settings-member)|Gets the `Setting` object that represents the binding that raised the settings changed event| +|[TableCollection](/.tablecollection)|[getCount()](/.tablecollection#excel-javascript/api/excel/-tablecollection-getcount-member(1))|Gets the number of tables in the collection.| +||[getItemOrNullObject(key: string)](/.tablecollection#excel-javascript/api/excel/-tablecollection-getitemornullobject-member(1))|Gets a table by name or ID.| +|[TableColumnCollection](/.tablecolumncollection)|[getCount()](/.tablecolumncollection#excel-javascript/api/excel/-tablecolumncollection-getcount-member(1))|Gets the number of columns in the table.| +||[getItemOrNullObject(key: number \| string)](/.tablecolumncollection#excel-javascript/api/excel/-tablecolumncollection-getitemornullobject-member(1))|Gets a column object by name or ID.| +|[TableRowCollection](/.tablerowcollection)|[getCount()](/.tablerowcollection#excel-javascript/api/excel/-tablerowcollection-getcount-member(1))|Gets the number of rows in the table.| +|[Workbook](/.workbook)|[settings](/.workbook#excel-javascript/api/excel/-workbook-settings-member)|Represents a collection of settings associated with the workbook.| +|[Worksheet](/.worksheet)|[getUsedRangeOrNullObject(valuesOnly?: boolean)](/.worksheet#excel-javascript/api/excel/-worksheet-getusedrangeornullobject-member(1))|The used range is the smallest range that encompasses any cells that have a value or formatting assigned to them.| +||[names](/.worksheet#excel-javascript/api/excel/-worksheet-names-member)|Collection of names scoped to the current worksheet.| +|[WorksheetCollection](/.worksheetcollection)|[getCount(visibleOnly?: boolean)](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-getcount-member(1))|Gets the number of worksheets in the collection.| +||[getItemOrNullObject(key: string)](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-getitemornullobject-member(1))|Gets a worksheet object using its name or ID.| diff --git a/docs/includes/excel-1_5.md b/docs/includes/excel-1_5.md index f9467a6c3f..f90a4b2ee9 100644 --- a/docs/includes/excel-1_5.md +++ b/docs/includes/excel-1_5.md @@ -1,29 +1,29 @@ | Class | Fields | Description | |:---|:---|:---| -|[CustomXmlPart](/javascript/api/excel/excel.customxmlpart)|[delete()](/javascript/api/excel/excel.customxmlpart#excel-excel-customxmlpart-delete-member(1))|Deletes the custom XML part.| -||[getXml()](/javascript/api/excel/excel.customxmlpart#excel-excel-customxmlpart-getxml-member(1))|Gets the custom XML part's full XML content.| -||[id](/javascript/api/excel/excel.customxmlpart#excel-excel-customxmlpart-id-member)|The custom XML part's ID.| -||[namespaceUri](/javascript/api/excel/excel.customxmlpart#excel-excel-customxmlpart-namespaceuri-member)|The custom XML part's namespace URI.| -||[setXml(xml: string)](/javascript/api/excel/excel.customxmlpart#excel-excel-customxmlpart-setxml-member(1))|Sets the custom XML part's full XML content.| -|[CustomXmlPartCollection](/javascript/api/excel/excel.customxmlpartcollection)|[add(xml: string)](/javascript/api/excel/excel.customxmlpartcollection#excel-excel-customxmlpartcollection-add-member(1))|Adds a new custom XML part to the workbook.| -||[getByNamespace(namespaceUri: string)](/javascript/api/excel/excel.customxmlpartcollection#excel-excel-customxmlpartcollection-getbynamespace-member(1))|Gets a new scoped collection of custom XML parts whose namespaces match the given namespace.| -||[getCount()](/javascript/api/excel/excel.customxmlpartcollection#excel-excel-customxmlpartcollection-getcount-member(1))|Gets the number of custom XML parts in the collection.| -||[getItem(id: string)](/javascript/api/excel/excel.customxmlpartcollection#excel-excel-customxmlpartcollection-getitem-member(1))|Gets a custom XML part based on its ID.| -||[getItemOrNullObject(id: string)](/javascript/api/excel/excel.customxmlpartcollection#excel-excel-customxmlpartcollection-getitemornullobject-member(1))|Gets a custom XML part based on its ID.| -||[items](/javascript/api/excel/excel.customxmlpartcollection#excel-excel-customxmlpartcollection-items-member)|Gets the loaded child items in this collection.| -|[CustomXmlPartScopedCollection](/javascript/api/excel/excel.customxmlpartscopedcollection)|[getCount()](/javascript/api/excel/excel.customxmlpartscopedcollection#excel-excel-customxmlpartscopedcollection-getcount-member(1))|Gets the number of CustomXML parts in this collection.| -||[getItem(id: string)](/javascript/api/excel/excel.customxmlpartscopedcollection#excel-excel-customxmlpartscopedcollection-getitem-member(1))|Gets a custom XML part based on its ID.| -||[getItemOrNullObject(id: string)](/javascript/api/excel/excel.customxmlpartscopedcollection#excel-excel-customxmlpartscopedcollection-getitemornullobject-member(1))|Gets a custom XML part based on its ID.| -||[getOnlyItem()](/javascript/api/excel/excel.customxmlpartscopedcollection#excel-excel-customxmlpartscopedcollection-getonlyitem-member(1))|If the collection contains exactly one item, this method returns it.| -||[getOnlyItemOrNullObject()](/javascript/api/excel/excel.customxmlpartscopedcollection#excel-excel-customxmlpartscopedcollection-getonlyitemornullobject-member(1))|If the collection contains exactly one item, this method returns it.| -||[items](/javascript/api/excel/excel.customxmlpartscopedcollection#excel-excel-customxmlpartscopedcollection-items-member)|Gets the loaded child items in this collection.| -|[PivotTable](/javascript/api/excel/excel.pivottable)|[id](/javascript/api/excel/excel.pivottable#excel-excel-pivottable-id-member)|ID of the PivotTable.| -|[RequestContext](/javascript/api/excel/excel.requestcontext)|[runtime](/javascript/api/excel/excel.requestcontext#excel-excel-requestcontext-runtime-member)|[Api set: ExcelApi 1.5]| -|[Runtime](/javascript/api/excel/excel.runtime)||| -|[Workbook](/javascript/api/excel/excel.workbook)|[customXmlParts](/javascript/api/excel/excel.workbook#excel-excel-workbook-customxmlparts-member)|Represents the collection of custom XML parts contained by this workbook.| -|[Worksheet](/javascript/api/excel/excel.worksheet)|[getNext(visibleOnly?: boolean)](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-getnext-member(1))|Gets the worksheet that follows this one.| -||[getNextOrNullObject(visibleOnly?: boolean)](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-getnextornullobject-member(1))|Gets the worksheet that follows this one.| -||[getPrevious(visibleOnly?: boolean)](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-getprevious-member(1))|Gets the worksheet that precedes this one.| -||[getPreviousOrNullObject(visibleOnly?: boolean)](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-getpreviousornullobject-member(1))|Gets the worksheet that precedes this one.| -|[WorksheetCollection](/javascript/api/excel/excel.worksheetcollection)|[getFirst(visibleOnly?: boolean)](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-getfirst-member(1))|Gets the first worksheet in the collection.| -||[getLast(visibleOnly?: boolean)](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-getlast-member(1))|Gets the last worksheet in the collection.| +|[CustomXmlPart](/.customxmlpart)|[delete()](/.customxmlpart#excel-javascript/api/excel/-customxmlpart-delete-member(1))|Deletes the custom XML part.| +||[getXml()](/.customxmlpart#excel-javascript/api/excel/-customxmlpart-getxml-member(1))|Gets the custom XML part's full XML content.| +||[id](/.customxmlpart#excel-javascript/api/excel/-customxmlpart-id-member)|The custom XML part's ID.| +||[namespaceUri](/.customxmlpart#excel-javascript/api/excel/-customxmlpart-namespaceuri-member)|The custom XML part's namespace URI.| +||[setXml(xml: string)](/.customxmlpart#excel-javascript/api/excel/-customxmlpart-setxml-member(1))|Sets the custom XML part's full XML content.| +|[CustomXmlPartCollection](/.customxmlpartcollection)|[add(xml: string)](/.customxmlpartcollection#excel-javascript/api/excel/-customxmlpartcollection-add-member(1))|Adds a new custom XML part to the workbook.| +||[getByNamespace(namespaceUri: string)](/.customxmlpartcollection#excel-javascript/api/excel/-customxmlpartcollection-getbynamespace-member(1))|Gets a new scoped collection of custom XML parts whose namespaces match the given namespace.| +||[getCount()](/.customxmlpartcollection#excel-javascript/api/excel/-customxmlpartcollection-getcount-member(1))|Gets the number of custom XML parts in the collection.| +||[getItem(id: string)](/.customxmlpartcollection#excel-javascript/api/excel/-customxmlpartcollection-getitem-member(1))|Gets a custom XML part based on its ID.| +||[getItemOrNullObject(id: string)](/.customxmlpartcollection#excel-javascript/api/excel/-customxmlpartcollection-getitemornullobject-member(1))|Gets a custom XML part based on its ID.| +||[items](/.customxmlpartcollection#excel-javascript/api/excel/-customxmlpartcollection-items-member)|Gets the loaded child items in this collection.| +|[CustomXmlPartScopedCollection](/.customxmlpartscopedcollection)|[getCount()](/.customxmlpartscopedcollection#excel-javascript/api/excel/-customxmlpartscopedcollection-getcount-member(1))|Gets the number of CustomXML parts in this collection.| +||[getItem(id: string)](/.customxmlpartscopedcollection#excel-javascript/api/excel/-customxmlpartscopedcollection-getitem-member(1))|Gets a custom XML part based on its ID.| +||[getItemOrNullObject(id: string)](/.customxmlpartscopedcollection#excel-javascript/api/excel/-customxmlpartscopedcollection-getitemornullobject-member(1))|Gets a custom XML part based on its ID.| +||[getOnlyItem()](/.customxmlpartscopedcollection#excel-javascript/api/excel/-customxmlpartscopedcollection-getonlyitem-member(1))|If the collection contains exactly one item, this method returns it.| +||[getOnlyItemOrNullObject()](/.customxmlpartscopedcollection#excel-javascript/api/excel/-customxmlpartscopedcollection-getonlyitemornullobject-member(1))|If the collection contains exactly one item, this method returns it.| +||[items](/.customxmlpartscopedcollection#excel-javascript/api/excel/-customxmlpartscopedcollection-items-member)|Gets the loaded child items in this collection.| +|[PivotTable](/.pivottable)|[id](/.pivottable#excel-javascript/api/excel/-pivottable-id-member)|ID of the PivotTable.| +|[RequestContext](/.requestcontext)|[runtime](/.requestcontext#excel-javascript/api/excel/-requestcontext-runtime-member)|[Api set: ExcelApi 1.5]| +|[Runtime](/.runtime)||| +|[Workbook](/.workbook)|[customXmlParts](/.workbook#excel-javascript/api/excel/-workbook-customxmlparts-member)|Represents the collection of custom XML parts contained by this workbook.| +|[Worksheet](/.worksheet)|[getNext(visibleOnly?: boolean)](/.worksheet#excel-javascript/api/excel/-worksheet-getnext-member(1))|Gets the worksheet that follows this one.| +||[getNextOrNullObject(visibleOnly?: boolean)](/.worksheet#excel-javascript/api/excel/-worksheet-getnextornullobject-member(1))|Gets the worksheet that follows this one.| +||[getPrevious(visibleOnly?: boolean)](/.worksheet#excel-javascript/api/excel/-worksheet-getprevious-member(1))|Gets the worksheet that precedes this one.| +||[getPreviousOrNullObject(visibleOnly?: boolean)](/.worksheet#excel-javascript/api/excel/-worksheet-getpreviousornullobject-member(1))|Gets the worksheet that precedes this one.| +|[WorksheetCollection](/.worksheetcollection)|[getFirst(visibleOnly?: boolean)](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-getfirst-member(1))|Gets the first worksheet in the collection.| +||[getLast(visibleOnly?: boolean)](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-getlast-member(1))|Gets the last worksheet in the collection.| diff --git a/docs/includes/excel-1_6.md b/docs/includes/excel-1_6.md index b1f8a6cbfc..133604be10 100644 --- a/docs/includes/excel-1_6.md +++ b/docs/includes/excel-1_6.md @@ -1,112 +1,112 @@ | Class | Fields | Description | |:---|:---|:---| -|[Application](/javascript/api/excel/excel.application)|[suspendApiCalculationUntilNextSync()](/javascript/api/excel/excel.application#excel-excel-application-suspendapicalculationuntilnextsync-member(1))|Suspends calculation until the next `context.sync()` is called.| -|[CellValueConditionalFormat](/javascript/api/excel/excel.cellvalueconditionalformat)|[format](/javascript/api/excel/excel.cellvalueconditionalformat#excel-excel-cellvalueconditionalformat-format-member)|Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties.| -||[rule](/javascript/api/excel/excel.cellvalueconditionalformat#excel-excel-cellvalueconditionalformat-rule-member)|Specifies the rule object on this conditional format.| -|[ColorScaleConditionalFormat](/javascript/api/excel/excel.colorscaleconditionalformat)|[criteria](/javascript/api/excel/excel.colorscaleconditionalformat#excel-excel-colorscaleconditionalformat-criteria-member)|The criteria of the color scale.| -||[threeColorScale](/javascript/api/excel/excel.colorscaleconditionalformat#excel-excel-colorscaleconditionalformat-threecolorscale-member)|If `true`, the color scale will have three points (minimum, midpoint, maximum), otherwise it will have two (minimum, maximum).| -|[ConditionalCellValueRule](/javascript/api/excel/excel.conditionalcellvaluerule)|[formula1](/javascript/api/excel/excel.conditionalcellvaluerule#excel-excel-conditionalcellvaluerule-formula1-member)|The formula, if required, on which to evaluate the conditional format rule.| -||[formula2](/javascript/api/excel/excel.conditionalcellvaluerule#excel-excel-conditionalcellvaluerule-formula2-member)|The formula, if required, on which to evaluate the conditional format rule.| -||[operator](/javascript/api/excel/excel.conditionalcellvaluerule#excel-excel-conditionalcellvaluerule-operator-member)|The operator of the cell value conditional format.| -|[ConditionalColorScaleCriteria](/javascript/api/excel/excel.conditionalcolorscalecriteria)|[maximum](/javascript/api/excel/excel.conditionalcolorscalecriteria#excel-excel-conditionalcolorscalecriteria-maximum-member)|The maximum point of the color scale criterion.| -||[midpoint](/javascript/api/excel/excel.conditionalcolorscalecriteria#excel-excel-conditionalcolorscalecriteria-midpoint-member)|The midpoint of the color scale criterion, if the color scale is a 3-color scale.| -||[minimum](/javascript/api/excel/excel.conditionalcolorscalecriteria#excel-excel-conditionalcolorscalecriteria-minimum-member)|The minimum point of the color scale criterion.| -|[ConditionalColorScaleCriterion](/javascript/api/excel/excel.conditionalcolorscalecriterion)|[color](/javascript/api/excel/excel.conditionalcolorscalecriterion#excel-excel-conditionalcolorscalecriterion-color-member)|HTML color code representation of the color scale color (e.g., #FF0000 represents Red).| -||[formula](/javascript/api/excel/excel.conditionalcolorscalecriterion#excel-excel-conditionalcolorscalecriterion-formula-member)|A number, a formula, or `null` (if `type` is `lowestValue`).| -||[type](/javascript/api/excel/excel.conditionalcolorscalecriterion#excel-excel-conditionalcolorscalecriterion-type-member)|What the criterion conditional formula should be based on.| -|[ConditionalDataBarNegativeFormat](/javascript/api/excel/excel.conditionaldatabarnegativeformat)|[borderColor](/javascript/api/excel/excel.conditionaldatabarnegativeformat#excel-excel-conditionaldatabarnegativeformat-bordercolor-member)|HTML color code representing the color of the border line, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").| -||[fillColor](/javascript/api/excel/excel.conditionaldatabarnegativeformat#excel-excel-conditionaldatabarnegativeformat-fillcolor-member)|HTML color code representing the fill color, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").| -||[matchPositiveBorderColor](/javascript/api/excel/excel.conditionaldatabarnegativeformat#excel-excel-conditionaldatabarnegativeformat-matchpositivebordercolor-member)|Specifies if the negative data bar has the same border color as the positive data bar.| -||[matchPositiveFillColor](/javascript/api/excel/excel.conditionaldatabarnegativeformat#excel-excel-conditionaldatabarnegativeformat-matchpositivefillcolor-member)|Specifies if the negative data bar has the same fill color as the positive data bar.| -|[ConditionalDataBarPositiveFormat](/javascript/api/excel/excel.conditionaldatabarpositiveformat)|[borderColor](/javascript/api/excel/excel.conditionaldatabarpositiveformat#excel-excel-conditionaldatabarpositiveformat-bordercolor-member)|HTML color code representing the color of the border line, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").| -||[fillColor](/javascript/api/excel/excel.conditionaldatabarpositiveformat#excel-excel-conditionaldatabarpositiveformat-fillcolor-member)|HTML color code representing the fill color, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").| -||[gradientFill](/javascript/api/excel/excel.conditionaldatabarpositiveformat#excel-excel-conditionaldatabarpositiveformat-gradientfill-member)|Specifies if the data bar has a gradient.| -|[ConditionalDataBarRule](/javascript/api/excel/excel.conditionaldatabarrule)|[formula](/javascript/api/excel/excel.conditionaldatabarrule#excel-excel-conditionaldatabarrule-formula-member)|The formula, if required, on which to evaluate the data bar rule.| -||[type](/javascript/api/excel/excel.conditionaldatabarrule#excel-excel-conditionaldatabarrule-type-member)|The type of rule for the data bar.| -|[ConditionalFormat](/javascript/api/excel/excel.conditionalformat)|[cellValue](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-cellvalue-member)|Returns the cell value conditional format properties if the current conditional format is a `CellValue` type.| -||[cellValueOrNullObject](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-cellvalueornullobject-member)|Returns the cell value conditional format properties if the current conditional format is a `CellValue` type.| -||[colorScale](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-colorscale-member)|Returns the color scale conditional format properties if the current conditional format is a `ColorScale` type.| -||[colorScaleOrNullObject](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-colorscaleornullobject-member)|Returns the color scale conditional format properties if the current conditional format is a `ColorScale` type.| -||[custom](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-custom-member)|Returns the custom conditional format properties if the current conditional format is a custom type.| -||[customOrNullObject](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-customornullobject-member)|Returns the custom conditional format properties if the current conditional format is a custom type.| -||[dataBar](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-databar-member)|Returns the data bar properties if the current conditional format is a data bar.| -||[dataBarOrNullObject](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-databarornullobject-member)|Returns the data bar properties if the current conditional format is a data bar.| -||[delete()](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-delete-member(1))|Deletes this conditional format.| -||[getRange()](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-getrange-member(1))|Returns the range the conditional format is applied to.| -||[getRangeOrNullObject()](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-getrangeornullobject-member(1))|Returns the range to which the conditional format is applied.| -||[iconSet](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-iconset-member)|Returns the icon set conditional format properties if the current conditional format is an `IconSet` type.| -||[iconSetOrNullObject](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-iconsetornullobject-member)|Returns the icon set conditional format properties if the current conditional format is an `IconSet` type.| -||[id](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-id-member)|The priority of the conditional format in the current `ConditionalFormatCollection`.| -||[preset](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-preset-member)|Returns the preset criteria conditional format.| -||[presetOrNullObject](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-presetornullobject-member)|Returns the preset criteria conditional format.| -||[priority](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-priority-member)|The priority (or index) within the conditional format collection that this conditional format currently exists in.| -||[stopIfTrue](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-stopiftrue-member)|If the conditions of this conditional format are met, no lower-priority formats shall take effect on that cell.| -||[textComparison](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-textcomparison-member)|Returns the specific text conditional format properties if the current conditional format is a text type.| -||[textComparisonOrNullObject](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-textcomparisonornullobject-member)|Returns the specific text conditional format properties if the current conditional format is a text type.| -||[topBottom](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-topbottom-member)|Returns the top/bottom conditional format properties if the current conditional format is a `TopBottom` type.| -||[topBottomOrNullObject](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-topbottomornullobject-member)|Returns the top/bottom conditional format properties if the current conditional format is a `TopBottom` type.| -||[type](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-type-member)|A type of conditional format.| -|[ConditionalFormatCollection](/javascript/api/excel/excel.conditionalformatcollection)|[add(type: Excel.ConditionalFormatType)](/javascript/api/excel/excel.conditionalformatcollection#excel-excel-conditionalformatcollection-add-member(1))|Adds a new conditional format to the collection at the first/top priority.| -||[clearAll()](/javascript/api/excel/excel.conditionalformatcollection#excel-excel-conditionalformatcollection-clearall-member(1))|Clears all conditional formats active on the current specified range.| -||[getCount()](/javascript/api/excel/excel.conditionalformatcollection#excel-excel-conditionalformatcollection-getcount-member(1))|Returns the number of conditional formats in the workbook.| -||[getItem(id: string)](/javascript/api/excel/excel.conditionalformatcollection#excel-excel-conditionalformatcollection-getitem-member(1))|Returns a conditional format for the given ID.| -||[getItemAt(index: number)](/javascript/api/excel/excel.conditionalformatcollection#excel-excel-conditionalformatcollection-getitemat-member(1))|Returns a conditional format at the given index.| -||[items](/javascript/api/excel/excel.conditionalformatcollection#excel-excel-conditionalformatcollection-items-member)|Gets the loaded child items in this collection.| -|[ConditionalFormatRule](/javascript/api/excel/excel.conditionalformatrule)|[formula](/javascript/api/excel/excel.conditionalformatrule#excel-excel-conditionalformatrule-formula-member)|The formula, if required, on which to evaluate the conditional format rule.| -||[formulaLocal](/javascript/api/excel/excel.conditionalformatrule#excel-excel-conditionalformatrule-formulalocal-member)|The formula, if required, on which to evaluate the conditional format rule in the user's language.| -||[formulaR1C1](/javascript/api/excel/excel.conditionalformatrule#excel-excel-conditionalformatrule-formular1c1-member)|The formula, if required, on which to evaluate the conditional format rule in R1C1-style notation.| -|[ConditionalIconCriterion](/javascript/api/excel/excel.conditionaliconcriterion)|[customIcon](/javascript/api/excel/excel.conditionaliconcriterion#excel-excel-conditionaliconcriterion-customicon-member)|The custom icon for the current criterion, if different from the default icon set, else `null` will be returned.| -||[formula](/javascript/api/excel/excel.conditionaliconcriterion#excel-excel-conditionaliconcriterion-formula-member)|A number or a formula depending on the type.| -||[operator](/javascript/api/excel/excel.conditionaliconcriterion#excel-excel-conditionaliconcriterion-operator-member)|`greaterThan` or `greaterThanOrEqual` for each of the rule types for the icon conditional format.| -||[type](/javascript/api/excel/excel.conditionaliconcriterion#excel-excel-conditionaliconcriterion-type-member)|What the icon conditional formula should be based on.| -|[ConditionalPresetCriteriaRule](/javascript/api/excel/excel.conditionalpresetcriteriarule)|[criterion](/javascript/api/excel/excel.conditionalpresetcriteriarule#excel-excel-conditionalpresetcriteriarule-criterion-member)|The criterion of the conditional format.| -|[ConditionalRangeBorder](/javascript/api/excel/excel.conditionalrangeborder)|[color](/javascript/api/excel/excel.conditionalrangeborder#excel-excel-conditionalrangeborder-color-member)|HTML color code representing the color of the border line, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").| -||[sideIndex](/javascript/api/excel/excel.conditionalrangeborder#excel-excel-conditionalrangeborder-sideindex-member)|Constant value that indicates the specific side of the border.| -||[style](/javascript/api/excel/excel.conditionalrangeborder#excel-excel-conditionalrangeborder-style-member)|One of the constants of line style specifying the line style for the border.| -|[ConditionalRangeBorderCollection](/javascript/api/excel/excel.conditionalrangebordercollection)|[bottom](/javascript/api/excel/excel.conditionalrangebordercollection#excel-excel-conditionalrangebordercollection-bottom-member)|Gets the bottom border.| -||[count](/javascript/api/excel/excel.conditionalrangebordercollection#excel-excel-conditionalrangebordercollection-count-member)|Number of border objects in the collection.| -||[getItem(index: Excel.ConditionalRangeBorderIndex)](/javascript/api/excel/excel.conditionalrangebordercollection#excel-excel-conditionalrangebordercollection-getitem-member(1))|Gets a border object using its name.| -||[getItemAt(index: number)](/javascript/api/excel/excel.conditionalrangebordercollection#excel-excel-conditionalrangebordercollection-getitemat-member(1))|Gets a border object using its index.| -||[items](/javascript/api/excel/excel.conditionalrangebordercollection#excel-excel-conditionalrangebordercollection-items-member)|Gets the loaded child items in this collection.| -||[left](/javascript/api/excel/excel.conditionalrangebordercollection#excel-excel-conditionalrangebordercollection-left-member)|Gets the left border.| -||[right](/javascript/api/excel/excel.conditionalrangebordercollection#excel-excel-conditionalrangebordercollection-right-member)|Gets the right border.| -||[top](/javascript/api/excel/excel.conditionalrangebordercollection#excel-excel-conditionalrangebordercollection-top-member)|Gets the top border.| -|[ConditionalRangeFill](/javascript/api/excel/excel.conditionalrangefill)|[clear()](/javascript/api/excel/excel.conditionalrangefill#excel-excel-conditionalrangefill-clear-member(1))|Resets the fill.| -||[color](/javascript/api/excel/excel.conditionalrangefill#excel-excel-conditionalrangefill-color-member)|HTML color code representing the color of the fill, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").| -|[ConditionalRangeFont](/javascript/api/excel/excel.conditionalrangefont)|[bold](/javascript/api/excel/excel.conditionalrangefont#excel-excel-conditionalrangefont-bold-member)|Specifies if the font is bold.| -||[clear()](/javascript/api/excel/excel.conditionalrangefont#excel-excel-conditionalrangefont-clear-member(1))|Resets the font formats.| -||[color](/javascript/api/excel/excel.conditionalrangefont#excel-excel-conditionalrangefont-color-member)|HTML color code representation of the text color (e.g., #FF0000 represents Red).| -||[italic](/javascript/api/excel/excel.conditionalrangefont#excel-excel-conditionalrangefont-italic-member)|Specifies if the font is italic.| -||[strikethrough](/javascript/api/excel/excel.conditionalrangefont#excel-excel-conditionalrangefont-strikethrough-member)|Specifies the strikethrough status of the font.| -||[underline](/javascript/api/excel/excel.conditionalrangefont#excel-excel-conditionalrangefont-underline-member)|The type of underline applied to the font.| -|[ConditionalRangeFormat](/javascript/api/excel/excel.conditionalrangeformat)|[borders](/javascript/api/excel/excel.conditionalrangeformat#excel-excel-conditionalrangeformat-borders-member)|Collection of border objects that apply to the overall conditional format range.| -||[fill](/javascript/api/excel/excel.conditionalrangeformat#excel-excel-conditionalrangeformat-fill-member)|Returns the fill object defined on the overall conditional format range.| -||[font](/javascript/api/excel/excel.conditionalrangeformat#excel-excel-conditionalrangeformat-font-member)|Returns the font object defined on the overall conditional format range.| -||[numberFormat](/javascript/api/excel/excel.conditionalrangeformat#excel-excel-conditionalrangeformat-numberformat-member)|Represents Excel's number format code for the given range.| -|[ConditionalTextComparisonRule](/javascript/api/excel/excel.conditionaltextcomparisonrule)|[operator](/javascript/api/excel/excel.conditionaltextcomparisonrule#excel-excel-conditionaltextcomparisonrule-operator-member)|The operator of the text conditional format.| -||[text](/javascript/api/excel/excel.conditionaltextcomparisonrule#excel-excel-conditionaltextcomparisonrule-text-member)|The text value of the conditional format.| -|[ConditionalTopBottomRule](/javascript/api/excel/excel.conditionaltopbottomrule)|[rank](/javascript/api/excel/excel.conditionaltopbottomrule#excel-excel-conditionaltopbottomrule-rank-member)|The rank between 1 and 1000 for numeric ranks or 1 and 100 for percent ranks.| -||[type](/javascript/api/excel/excel.conditionaltopbottomrule#excel-excel-conditionaltopbottomrule-type-member)|Format values based on the top or bottom rank.| -|[CustomConditionalFormat](/javascript/api/excel/excel.customconditionalformat)|[format](/javascript/api/excel/excel.customconditionalformat#excel-excel-customconditionalformat-format-member)|Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties.| -||[rule](/javascript/api/excel/excel.customconditionalformat#excel-excel-customconditionalformat-rule-member)|Specifies the `Rule` object on this conditional format.| -|[DataBarConditionalFormat](/javascript/api/excel/excel.databarconditionalformat)|[axisColor](/javascript/api/excel/excel.databarconditionalformat#excel-excel-databarconditionalformat-axiscolor-member)|HTML color code representing the color of the Axis line, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").| -||[axisFormat](/javascript/api/excel/excel.databarconditionalformat#excel-excel-databarconditionalformat-axisformat-member)|Representation of how the axis is determined for an Excel data bar.| -||[barDirection](/javascript/api/excel/excel.databarconditionalformat#excel-excel-databarconditionalformat-bardirection-member)|Specifies the direction that the data bar graphic should be based on.| -||[lowerBoundRule](/javascript/api/excel/excel.databarconditionalformat#excel-excel-databarconditionalformat-lowerboundrule-member)|The rule for what constitutes the lower bound (and how to calculate it, if applicable) for a data bar.| -||[negativeFormat](/javascript/api/excel/excel.databarconditionalformat#excel-excel-databarconditionalformat-negativeformat-member)|Representation of all values to the left of the axis in an Excel data bar.| -||[positiveFormat](/javascript/api/excel/excel.databarconditionalformat#excel-excel-databarconditionalformat-positiveformat-member)|Representation of all values to the right of the axis in an Excel data bar.| -||[showDataBarOnly](/javascript/api/excel/excel.databarconditionalformat#excel-excel-databarconditionalformat-showdatabaronly-member)|If `true`, hides the values from the cells where the data bar is applied.| -||[upperBoundRule](/javascript/api/excel/excel.databarconditionalformat#excel-excel-databarconditionalformat-upperboundrule-member)|The rule for what constitutes the upper bound (and how to calculate it, if applicable) for a data bar.| -|[IconSetConditionalFormat](/javascript/api/excel/excel.iconsetconditionalformat)|[criteria](/javascript/api/excel/excel.iconsetconditionalformat#excel-excel-iconsetconditionalformat-criteria-member)|An array of criteria and icon sets for the rules and potential custom icons for conditional icons.| -||[reverseIconOrder](/javascript/api/excel/excel.iconsetconditionalformat#excel-excel-iconsetconditionalformat-reverseiconorder-member)|If `true`, reverses the icon orders for the icon set.| -||[showIconOnly](/javascript/api/excel/excel.iconsetconditionalformat#excel-excel-iconsetconditionalformat-showicononly-member)|If `true`, hides the values and only shows icons.| -||[style](/javascript/api/excel/excel.iconsetconditionalformat#excel-excel-iconsetconditionalformat-style-member)|If set, displays the icon set option for the conditional format.| -|[PresetCriteriaConditionalFormat](/javascript/api/excel/excel.presetcriteriaconditionalformat)|[format](/javascript/api/excel/excel.presetcriteriaconditionalformat#excel-excel-presetcriteriaconditionalformat-format-member)|Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties.| -||[rule](/javascript/api/excel/excel.presetcriteriaconditionalformat#excel-excel-presetcriteriaconditionalformat-rule-member)|The rule of the conditional format.| -|[Range](/javascript/api/excel/excel.range)|[calculate()](/javascript/api/excel/excel.range#excel-excel-range-calculate-member(1))|Calculates a range of cells on a worksheet.| -||[conditionalFormats](/javascript/api/excel/excel.range#excel-excel-range-conditionalformats-member)|The collection of `ConditionalFormats` that intersect the range.| -|[TextConditionalFormat](/javascript/api/excel/excel.textconditionalformat)|[format](/javascript/api/excel/excel.textconditionalformat#excel-excel-textconditionalformat-format-member)|Returns a format object, encapsulating the conditional format's font, fill, borders, and other properties.| -||[rule](/javascript/api/excel/excel.textconditionalformat#excel-excel-textconditionalformat-rule-member)|The rule of the conditional format.| -|[TopBottomConditionalFormat](/javascript/api/excel/excel.topbottomconditionalformat)|[format](/javascript/api/excel/excel.topbottomconditionalformat#excel-excel-topbottomconditionalformat-format-member)|Returns a format object, encapsulating the conditional format's font, fill, borders, and other properties.| -||[rule](/javascript/api/excel/excel.topbottomconditionalformat#excel-excel-topbottomconditionalformat-rule-member)|The criteria of the top/bottom conditional format.| -|[Worksheet](/javascript/api/excel/excel.worksheet)|[calculate(markAllDirty: boolean)](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-calculate-member(1))|Calculates all cells on a worksheet.| +|[Application](/.application)|[suspendApiCalculationUntilNextSync()](/.application#excel-javascript/api/excel/-application-suspendapicalculationuntilnextsync-member(1))|Suspends calculation until the next `context.sync()` is called.| +|[CellValueConditionalFormat](/.cellvalueconditionalformat)|[format](/.cellvalueconditionalformat#excel-javascript/api/excel/-cellvalueconditionalformat-format-member)|Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties.| +||[rule](/.cellvalueconditionalformat#excel-javascript/api/excel/-cellvalueconditionalformat-rule-member)|Specifies the rule object on this conditional format.| +|[ColorScaleConditionalFormat](/.colorscaleconditionalformat)|[criteria](/.colorscaleconditionalformat#excel-javascript/api/excel/-colorscaleconditionalformat-criteria-member)|The criteria of the color scale.| +||[threeColorScale](/.colorscaleconditionalformat#excel-javascript/api/excel/-colorscaleconditionalformat-threecolorscale-member)|If `true`, the color scale will have three points (minimum, midpoint, maximum), otherwise it will have two (minimum, maximum).| +|[ConditionalCellValueRule](/.conditionalcellvaluerule)|[formula1](/.conditionalcellvaluerule#excel-javascript/api/excel/-conditionalcellvaluerule-formula1-member)|The formula, if required, on which to evaluate the conditional format rule.| +||[formula2](/.conditionalcellvaluerule#excel-javascript/api/excel/-conditionalcellvaluerule-formula2-member)|The formula, if required, on which to evaluate the conditional format rule.| +||[operator](/.conditionalcellvaluerule#excel-javascript/api/excel/-conditionalcellvaluerule-operator-member)|The operator of the cell value conditional format.| +|[ConditionalColorScaleCriteria](/.conditionalcolorscalecriteria)|[maximum](/.conditionalcolorscalecriteria#excel-javascript/api/excel/-conditionalcolorscalecriteria-maximum-member)|The maximum point of the color scale criterion.| +||[midpoint](/.conditionalcolorscalecriteria#excel-javascript/api/excel/-conditionalcolorscalecriteria-midpoint-member)|The midpoint of the color scale criterion, if the color scale is a 3-color scale.| +||[minimum](/.conditionalcolorscalecriteria#excel-javascript/api/excel/-conditionalcolorscalecriteria-minimum-member)|The minimum point of the color scale criterion.| +|[ConditionalColorScaleCriterion](/.conditionalcolorscalecriterion)|[color](/.conditionalcolorscalecriterion#excel-javascript/api/excel/-conditionalcolorscalecriterion-color-member)|HTML color code representation of the color scale color (e.g., #FF0000 represents Red).| +||[formula](/.conditionalcolorscalecriterion#excel-javascript/api/excel/-conditionalcolorscalecriterion-formula-member)|A number, a formula, or `null` (if `type` is `lowestValue`).| +||[type](/.conditionalcolorscalecriterion#excel-javascript/api/excel/-conditionalcolorscalecriterion-type-member)|What the criterion conditional formula should be based on.| +|[ConditionalDataBarNegativeFormat](/.conditionaldatabarnegativeformat)|[borderColor](/.conditionaldatabarnegativeformat#excel-javascript/api/excel/-conditionaldatabarnegativeformat-bordercolor-member)|HTML color code representing the color of the border line, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").| +||[fillColor](/.conditionaldatabarnegativeformat#excel-javascript/api/excel/-conditionaldatabarnegativeformat-fillcolor-member)|HTML color code representing the fill color, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").| +||[matchPositiveBorderColor](/.conditionaldatabarnegativeformat#excel-javascript/api/excel/-conditionaldatabarnegativeformat-matchpositivebordercolor-member)|Specifies if the negative data bar has the same border color as the positive data bar.| +||[matchPositiveFillColor](/.conditionaldatabarnegativeformat#excel-javascript/api/excel/-conditionaldatabarnegativeformat-matchpositivefillcolor-member)|Specifies if the negative data bar has the same fill color as the positive data bar.| +|[ConditionalDataBarPositiveFormat](/.conditionaldatabarpositiveformat)|[borderColor](/.conditionaldatabarpositiveformat#excel-javascript/api/excel/-conditionaldatabarpositiveformat-bordercolor-member)|HTML color code representing the color of the border line, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").| +||[fillColor](/.conditionaldatabarpositiveformat#excel-javascript/api/excel/-conditionaldatabarpositiveformat-fillcolor-member)|HTML color code representing the fill color, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").| +||[gradientFill](/.conditionaldatabarpositiveformat#excel-javascript/api/excel/-conditionaldatabarpositiveformat-gradientfill-member)|Specifies if the data bar has a gradient.| +|[ConditionalDataBarRule](/.conditionaldatabarrule)|[formula](/.conditionaldatabarrule#excel-javascript/api/excel/-conditionaldatabarrule-formula-member)|The formula, if required, on which to evaluate the data bar rule.| +||[type](/.conditionaldatabarrule#excel-javascript/api/excel/-conditionaldatabarrule-type-member)|The type of rule for the data bar.| +|[ConditionalFormat](/.conditionalformat)|[cellValue](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-cellvalue-member)|Returns the cell value conditional format properties if the current conditional format is a `CellValue` type.| +||[cellValueOrNullObject](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-cellvalueornullobject-member)|Returns the cell value conditional format properties if the current conditional format is a `CellValue` type.| +||[colorScale](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-colorscale-member)|Returns the color scale conditional format properties if the current conditional format is a `ColorScale` type.| +||[colorScaleOrNullObject](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-colorscaleornullobject-member)|Returns the color scale conditional format properties if the current conditional format is a `ColorScale` type.| +||[custom](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-custom-member)|Returns the custom conditional format properties if the current conditional format is a custom type.| +||[customOrNullObject](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-customornullobject-member)|Returns the custom conditional format properties if the current conditional format is a custom type.| +||[dataBar](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-databar-member)|Returns the data bar properties if the current conditional format is a data bar.| +||[dataBarOrNullObject](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-databarornullobject-member)|Returns the data bar properties if the current conditional format is a data bar.| +||[delete()](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-delete-member(1))|Deletes this conditional format.| +||[getRange()](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-getrange-member(1))|Returns the range the conditional format is applied to.| +||[getRangeOrNullObject()](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-getrangeornullobject-member(1))|Returns the range to which the conditional format is applied.| +||[iconSet](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-iconset-member)|Returns the icon set conditional format properties if the current conditional format is an `IconSet` type.| +||[iconSetOrNullObject](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-iconsetornullobject-member)|Returns the icon set conditional format properties if the current conditional format is an `IconSet` type.| +||[id](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-id-member)|The priority of the conditional format in the current `ConditionalFormatCollection`.| +||[preset](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-preset-member)|Returns the preset criteria conditional format.| +||[presetOrNullObject](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-presetornullobject-member)|Returns the preset criteria conditional format.| +||[priority](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-priority-member)|The priority (or index) within the conditional format collection that this conditional format currently exists in.| +||[stopIfTrue](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-stopiftrue-member)|If the conditions of this conditional format are met, no lower-priority formats shall take effect on that cell.| +||[textComparison](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-textcomparison-member)|Returns the specific text conditional format properties if the current conditional format is a text type.| +||[textComparisonOrNullObject](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-textcomparisonornullobject-member)|Returns the specific text conditional format properties if the current conditional format is a text type.| +||[topBottom](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-topbottom-member)|Returns the top/bottom conditional format properties if the current conditional format is a `TopBottom` type.| +||[topBottomOrNullObject](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-topbottomornullobject-member)|Returns the top/bottom conditional format properties if the current conditional format is a `TopBottom` type.| +||[type](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-type-member)|A type of conditional format.| +|[ConditionalFormatCollection](/.conditionalformatcollection)|[add(type: Excel.ConditionalFormatType)](/.conditionalformatcollection#excel-javascript/api/excel/-conditionalformatcollection-add-member(1))|Adds a new conditional format to the collection at the first/top priority.| +||[clearAll()](/.conditionalformatcollection#excel-javascript/api/excel/-conditionalformatcollection-clearall-member(1))|Clears all conditional formats active on the current specified range.| +||[getCount()](/.conditionalformatcollection#excel-javascript/api/excel/-conditionalformatcollection-getcount-member(1))|Returns the number of conditional formats in the workbook.| +||[getItem(id: string)](/.conditionalformatcollection#excel-javascript/api/excel/-conditionalformatcollection-getitem-member(1))|Returns a conditional format for the given ID.| +||[getItemAt(index: number)](/.conditionalformatcollection#excel-javascript/api/excel/-conditionalformatcollection-getitemat-member(1))|Returns a conditional format at the given index.| +||[items](/.conditionalformatcollection#excel-javascript/api/excel/-conditionalformatcollection-items-member)|Gets the loaded child items in this collection.| +|[ConditionalFormatRule](/.conditionalformatrule)|[formula](/.conditionalformatrule#excel-javascript/api/excel/-conditionalformatrule-formula-member)|The formula, if required, on which to evaluate the conditional format rule.| +||[formulaLocal](/.conditionalformatrule#excel-javascript/api/excel/-conditionalformatrule-formulalocal-member)|The formula, if required, on which to evaluate the conditional format rule in the user's language.| +||[formulaR1C1](/.conditionalformatrule#excel-javascript/api/excel/-conditionalformatrule-formular1c1-member)|The formula, if required, on which to evaluate the conditional format rule in R1C1-style notation.| +|[ConditionalIconCriterion](/.conditionaliconcriterion)|[customIcon](/.conditionaliconcriterion#excel-javascript/api/excel/-conditionaliconcriterion-customicon-member)|The custom icon for the current criterion, if different from the default icon set, else `null` will be returned.| +||[formula](/.conditionaliconcriterion#excel-javascript/api/excel/-conditionaliconcriterion-formula-member)|A number or a formula depending on the type.| +||[operator](/.conditionaliconcriterion#excel-javascript/api/excel/-conditionaliconcriterion-operator-member)|`greaterThan` or `greaterThanOrEqual` for each of the rule types for the icon conditional format.| +||[type](/.conditionaliconcriterion#excel-javascript/api/excel/-conditionaliconcriterion-type-member)|What the icon conditional formula should be based on.| +|[ConditionalPresetCriteriaRule](/.conditionalpresetcriteriarule)|[criterion](/.conditionalpresetcriteriarule#excel-javascript/api/excel/-conditionalpresetcriteriarule-criterion-member)|The criterion of the conditional format.| +|[ConditionalRangeBorder](/.conditionalrangeborder)|[color](/.conditionalrangeborder#excel-javascript/api/excel/-conditionalrangeborder-color-member)|HTML color code representing the color of the border line, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").| +||[sideIndex](/.conditionalrangeborder#excel-javascript/api/excel/-conditionalrangeborder-sideindex-member)|Constant value that indicates the specific side of the border.| +||[style](/.conditionalrangeborder#excel-javascript/api/excel/-conditionalrangeborder-style-member)|One of the constants of line style specifying the line style for the border.| +|[ConditionalRangeBorderCollection](/.conditionalrangebordercollection)|[bottom](/.conditionalrangebordercollection#excel-javascript/api/excel/-conditionalrangebordercollection-bottom-member)|Gets the bottom border.| +||[count](/.conditionalrangebordercollection#excel-javascript/api/excel/-conditionalrangebordercollection-count-member)|Number of border objects in the collection.| +||[getItem(index: Excel.ConditionalRangeBorderIndex)](/.conditionalrangebordercollection#excel-javascript/api/excel/-conditionalrangebordercollection-getitem-member(1))|Gets a border object using its name.| +||[getItemAt(index: number)](/.conditionalrangebordercollection#excel-javascript/api/excel/-conditionalrangebordercollection-getitemat-member(1))|Gets a border object using its index.| +||[items](/.conditionalrangebordercollection#excel-javascript/api/excel/-conditionalrangebordercollection-items-member)|Gets the loaded child items in this collection.| +||[left](/.conditionalrangebordercollection#excel-javascript/api/excel/-conditionalrangebordercollection-left-member)|Gets the left border.| +||[right](/.conditionalrangebordercollection#excel-javascript/api/excel/-conditionalrangebordercollection-right-member)|Gets the right border.| +||[top](/.conditionalrangebordercollection#excel-javascript/api/excel/-conditionalrangebordercollection-top-member)|Gets the top border.| +|[ConditionalRangeFill](/.conditionalrangefill)|[clear()](/.conditionalrangefill#excel-javascript/api/excel/-conditionalrangefill-clear-member(1))|Resets the fill.| +||[color](/.conditionalrangefill#excel-javascript/api/excel/-conditionalrangefill-color-member)|HTML color code representing the color of the fill, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").| +|[ConditionalRangeFont](/.conditionalrangefont)|[bold](/.conditionalrangefont#excel-javascript/api/excel/-conditionalrangefont-bold-member)|Specifies if the font is bold.| +||[clear()](/.conditionalrangefont#excel-javascript/api/excel/-conditionalrangefont-clear-member(1))|Resets the font formats.| +||[color](/.conditionalrangefont#excel-javascript/api/excel/-conditionalrangefont-color-member)|HTML color code representation of the text color (e.g., #FF0000 represents Red).| +||[italic](/.conditionalrangefont#excel-javascript/api/excel/-conditionalrangefont-italic-member)|Specifies if the font is italic.| +||[strikethrough](/.conditionalrangefont#excel-javascript/api/excel/-conditionalrangefont-strikethrough-member)|Specifies the strikethrough status of the font.| +||[underline](/.conditionalrangefont#excel-javascript/api/excel/-conditionalrangefont-underline-member)|The type of underline applied to the font.| +|[ConditionalRangeFormat](/.conditionalrangeformat)|[borders](/.conditionalrangeformat#excel-javascript/api/excel/-conditionalrangeformat-borders-member)|Collection of border objects that apply to the overall conditional format range.| +||[fill](/.conditionalrangeformat#excel-javascript/api/excel/-conditionalrangeformat-fill-member)|Returns the fill object defined on the overall conditional format range.| +||[font](/.conditionalrangeformat#excel-javascript/api/excel/-conditionalrangeformat-font-member)|Returns the font object defined on the overall conditional format range.| +||[numberFormat](/.conditionalrangeformat#excel-javascript/api/excel/-conditionalrangeformat-numberformat-member)|Represents Excel's number format code for the given range.| +|[ConditionalTextComparisonRule](/.conditionaltextcomparisonrule)|[operator](/.conditionaltextcomparisonrule#excel-javascript/api/excel/-conditionaltextcomparisonrule-operator-member)|The operator of the text conditional format.| +||[text](/.conditionaltextcomparisonrule#excel-javascript/api/excel/-conditionaltextcomparisonrule-text-member)|The text value of the conditional format.| +|[ConditionalTopBottomRule](/.conditionaltopbottomrule)|[rank](/.conditionaltopbottomrule#excel-javascript/api/excel/-conditionaltopbottomrule-rank-member)|The rank between 1 and 1000 for numeric ranks or 1 and 100 for percent ranks.| +||[type](/.conditionaltopbottomrule#excel-javascript/api/excel/-conditionaltopbottomrule-type-member)|Format values based on the top or bottom rank.| +|[CustomConditionalFormat](/.customconditionalformat)|[format](/.customconditionalformat#excel-javascript/api/excel/-customconditionalformat-format-member)|Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties.| +||[rule](/.customconditionalformat#excel-javascript/api/excel/-customconditionalformat-rule-member)|Specifies the `Rule` object on this conditional format.| +|[DataBarConditionalFormat](/.databarconditionalformat)|[axisColor](/.databarconditionalformat#excel-javascript/api/excel/-databarconditionalformat-axiscolor-member)|HTML color code representing the color of the Axis line, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").| +||[axisFormat](/.databarconditionalformat#excel-javascript/api/excel/-databarconditionalformat-axisformat-member)|Representation of how the axis is determined for an Excel data bar.| +||[barDirection](/.databarconditionalformat#excel-javascript/api/excel/-databarconditionalformat-bardirection-member)|Specifies the direction that the data bar graphic should be based on.| +||[lowerBoundRule](/.databarconditionalformat#excel-javascript/api/excel/-databarconditionalformat-lowerboundrule-member)|The rule for what constitutes the lower bound (and how to calculate it, if applicable) for a data bar.| +||[negativeFormat](/.databarconditionalformat#excel-javascript/api/excel/-databarconditionalformat-negativeformat-member)|Representation of all values to the left of the axis in an Excel data bar.| +||[positiveFormat](/.databarconditionalformat#excel-javascript/api/excel/-databarconditionalformat-positiveformat-member)|Representation of all values to the right of the axis in an Excel data bar.| +||[showDataBarOnly](/.databarconditionalformat#excel-javascript/api/excel/-databarconditionalformat-showdatabaronly-member)|If `true`, hides the values from the cells where the data bar is applied.| +||[upperBoundRule](/.databarconditionalformat#excel-javascript/api/excel/-databarconditionalformat-upperboundrule-member)|The rule for what constitutes the upper bound (and how to calculate it, if applicable) for a data bar.| +|[IconSetConditionalFormat](/.iconsetconditionalformat)|[criteria](/.iconsetconditionalformat#excel-javascript/api/excel/-iconsetconditionalformat-criteria-member)|An array of criteria and icon sets for the rules and potential custom icons for conditional icons.| +||[reverseIconOrder](/.iconsetconditionalformat#excel-javascript/api/excel/-iconsetconditionalformat-reverseiconorder-member)|If `true`, reverses the icon orders for the icon set.| +||[showIconOnly](/.iconsetconditionalformat#excel-javascript/api/excel/-iconsetconditionalformat-showicononly-member)|If `true`, hides the values and only shows icons.| +||[style](/.iconsetconditionalformat#excel-javascript/api/excel/-iconsetconditionalformat-style-member)|If set, displays the icon set option for the conditional format.| +|[PresetCriteriaConditionalFormat](/.presetcriteriaconditionalformat)|[format](/.presetcriteriaconditionalformat#excel-javascript/api/excel/-presetcriteriaconditionalformat-format-member)|Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties.| +||[rule](/.presetcriteriaconditionalformat#excel-javascript/api/excel/-presetcriteriaconditionalformat-rule-member)|The rule of the conditional format.| +|[Range](/.range)|[calculate()](/.range#excel-javascript/api/excel/-range-calculate-member(1))|Calculates a range of cells on a worksheet.| +||[conditionalFormats](/.range#excel-javascript/api/excel/-range-conditionalformats-member)|The collection of `ConditionalFormats` that intersect the range.| +|[TextConditionalFormat](/.textconditionalformat)|[format](/.textconditionalformat#excel-javascript/api/excel/-textconditionalformat-format-member)|Returns a format object, encapsulating the conditional format's font, fill, borders, and other properties.| +||[rule](/.textconditionalformat#excel-javascript/api/excel/-textconditionalformat-rule-member)|The rule of the conditional format.| +|[TopBottomConditionalFormat](/.topbottomconditionalformat)|[format](/.topbottomconditionalformat#excel-javascript/api/excel/-topbottomconditionalformat-format-member)|Returns a format object, encapsulating the conditional format's font, fill, borders, and other properties.| +||[rule](/.topbottomconditionalformat#excel-javascript/api/excel/-topbottomconditionalformat-rule-member)|The criteria of the top/bottom conditional format.| +|[Worksheet](/.worksheet)|[calculate(markAllDirty: boolean)](/.worksheet#excel-javascript/api/excel/-worksheet-calculate-member(1))|Calculates all cells on a worksheet.| diff --git a/docs/includes/excel-1_7.md b/docs/includes/excel-1_7.md index 1bae916d0c..7735f9eebb 100644 --- a/docs/includes/excel-1_7.md +++ b/docs/includes/excel-1_7.md @@ -1,237 +1,237 @@ | Class | Fields | Description | |:---|:---|:---| -|[Chart](/javascript/api/excel/excel.chart)|[chartType](/javascript/api/excel/excel.chart#excel-excel-chart-charttype-member)|Specifies the type of the chart.| -||[id](/javascript/api/excel/excel.chart#excel-excel-chart-id-member)|The unique ID of chart.| -||[showAllFieldButtons](/javascript/api/excel/excel.chart#excel-excel-chart-showallfieldbuttons-member)|Specifies whether to display all field buttons on a PivotChart.| -|[ChartAreaFormat](/javascript/api/excel/excel.chartareaformat)|[border](/javascript/api/excel/excel.chartareaformat#excel-excel-chartareaformat-border-member)|Represents the border format of chart area, which includes color, linestyle, and weight.| -|[ChartAxes](/javascript/api/excel/excel.chartaxes)|[getItem(type: Excel.ChartAxisType, group?: Excel.ChartAxisGroup)](/javascript/api/excel/excel.chartaxes#excel-excel-chartaxes-getitem-member(1))|Returns the specific axis identified by type and group.| -|[ChartAxis](/javascript/api/excel/excel.chartaxis)|[axisGroup](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-axisgroup-member)|Specifies the group for the specified axis.| -||[baseTimeUnit](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-basetimeunit-member)|Specifies the base unit for the specified category axis.| -||[categoryType](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-categorytype-member)|Specifies the category axis type.| -||[customDisplayUnit](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-customdisplayunit-member)|Specifies the custom axis display unit value.| -||[displayUnit](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-displayunit-member)|Represents the axis display unit.| -||[height](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-height-member)|Specifies the height, in points, of the chart axis.| -||[left](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-left-member)|Specifies the distance, in points, from the left edge of the axis to the left of chart area.| -||[logBase](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-logbase-member)|Specifies the base of the logarithm when using logarithmic scales.| -||[majorTickMark](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-majortickmark-member)|Specifies the type of major tick mark for the specified axis.| -||[majorTimeUnitScale](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-majortimeunitscale-member)|Specifies the major unit scale value for the category axis when the `categoryType` property is set to `dateAxis`.| -||[minorTickMark](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-minortickmark-member)|Specifies the type of minor tick mark for the specified axis.| -||[minorTimeUnitScale](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-minortimeunitscale-member)|Specifies the minor unit scale value for the category axis when the `categoryType` property is set to `dateAxis`.| -||[reversePlotOrder](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-reverseplotorder-member)|Specifies if Excel plots data points from last to first.| -||[scaleType](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-scaletype-member)|Specifies the value axis scale type.| -||[setCategoryNames(sourceData: Range)](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-setcategorynames-member(1))|Sets all the category names for the specified axis.| -||[setCustomDisplayUnit(value: number)](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-setcustomdisplayunit-member(1))|Sets the axis display unit to a custom value.| -||[showDisplayUnitLabel](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-showdisplayunitlabel-member)|Specifies if the axis display unit label is visible.| -||[tickLabelPosition](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-ticklabelposition-member)|Specifies the position of tick-mark labels on the specified axis.| -||[tickLabelSpacing](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-ticklabelspacing-member)|Specifies the number of categories or series between tick-mark labels.| -||[tickMarkSpacing](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-tickmarkspacing-member)|Specifies the number of categories or series between tick marks.| -||[top](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-top-member)|Specifies the distance, in points, from the top edge of the axis to the top of chart area.| -||[type](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-type-member)|Specifies the axis type.| -||[visible](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-visible-member)|Specifies if the axis is visible.| -||[width](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-width-member)|Specifies the width, in points, of the chart axis.| -|[ChartBorder](/javascript/api/excel/excel.chartborder)|[color](/javascript/api/excel/excel.chartborder#excel-excel-chartborder-color-member)|HTML color code representing the color of borders in the chart.| -||[lineStyle](/javascript/api/excel/excel.chartborder#excel-excel-chartborder-linestyle-member)|Represents the line style of the border.| -||[weight](/javascript/api/excel/excel.chartborder#excel-excel-chartborder-weight-member)|Represents weight of the border, in points.| -|[ChartDataLabel](/javascript/api/excel/excel.chartdatalabel)|[position](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-position-member)|Value that represents the position of the data label.| -||[separator](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-separator-member)|String representing the separator used for the data label on a chart.| -||[showBubbleSize](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-showbubblesize-member)|Specifies if the data label bubble size is visible.| -||[showCategoryName](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-showcategoryname-member)|Specifies if the data label category name is visible.| -||[showLegendKey](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-showlegendkey-member)|Specifies if the data label legend key is visible.| -||[showPercentage](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-showpercentage-member)|Specifies if the data label percentage is visible.| -||[showSeriesName](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-showseriesname-member)|Specifies if the data label series name is visible.| -||[showValue](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-showvalue-member)|Specifies if the data label value is visible.| -|[ChartFormatString](/javascript/api/excel/excel.chartformatstring)|[font](/javascript/api/excel/excel.chartformatstring#excel-excel-chartformatstring-font-member)|Represents the font attributes, such as font name, font size, and color of a chart characters object.| -|[ChartLegend](/javascript/api/excel/excel.chartlegend)|[height](/javascript/api/excel/excel.chartlegend#excel-excel-chartlegend-height-member)|Specifies the height, in points, of the legend on the chart.| -||[left](/javascript/api/excel/excel.chartlegend#excel-excel-chartlegend-left-member)|Specifies the left value, in points, of the legend on the chart.| -||[legendEntries](/javascript/api/excel/excel.chartlegend#excel-excel-chartlegend-legendentries-member)|Represents a collection of legendEntries in the legend.| -||[showShadow](/javascript/api/excel/excel.chartlegend#excel-excel-chartlegend-showshadow-member)|Specifies if the legend has a shadow on the chart.| -||[top](/javascript/api/excel/excel.chartlegend#excel-excel-chartlegend-top-member)|Specifies the top of a chart legend.| -||[width](/javascript/api/excel/excel.chartlegend#excel-excel-chartlegend-width-member)|Specifies the width, in points, of the legend on the chart.| -|[ChartLegendEntry](/javascript/api/excel/excel.chartlegendentry)|[visible](/javascript/api/excel/excel.chartlegendentry#excel-excel-chartlegendentry-visible-member)|Represents the visibility of a chart legend entry.| -|[ChartLegendEntryCollection](/javascript/api/excel/excel.chartlegendentrycollection)|[getCount()](/javascript/api/excel/excel.chartlegendentrycollection#excel-excel-chartlegendentrycollection-getcount-member(1))|Returns the number of legend entries in the collection.| -||[getItemAt(index: number)](/javascript/api/excel/excel.chartlegendentrycollection#excel-excel-chartlegendentrycollection-getitemat-member(1))|Returns a legend entry at the given index.| -||[items](/javascript/api/excel/excel.chartlegendentrycollection#excel-excel-chartlegendentrycollection-items-member)|Gets the loaded child items in this collection.| -|[ChartLineFormat](/javascript/api/excel/excel.chartlineformat)|[lineStyle](/javascript/api/excel/excel.chartlineformat#excel-excel-chartlineformat-linestyle-member)|Represents the line style.| -||[weight](/javascript/api/excel/excel.chartlineformat#excel-excel-chartlineformat-weight-member)|Represents weight of the line, in points.| -|[ChartPoint](/javascript/api/excel/excel.chartpoint)|[dataLabel](/javascript/api/excel/excel.chartpoint#excel-excel-chartpoint-datalabel-member)|Returns the data label of a chart point.| -||[hasDataLabel](/javascript/api/excel/excel.chartpoint#excel-excel-chartpoint-hasdatalabel-member)|Represents whether a data point has a data label.| -||[markerBackgroundColor](/javascript/api/excel/excel.chartpoint#excel-excel-chartpoint-markerbackgroundcolor-member)|HTML color code representation of the marker background color of a data point (e.g., #FF0000 represents Red).| -||[markerForegroundColor](/javascript/api/excel/excel.chartpoint#excel-excel-chartpoint-markerforegroundcolor-member)|HTML color code representation of the marker foreground color of a data point (e.g., #FF0000 represents Red).| -||[markerSize](/javascript/api/excel/excel.chartpoint#excel-excel-chartpoint-markersize-member)|Represents marker size of a data point.| -||[markerStyle](/javascript/api/excel/excel.chartpoint#excel-excel-chartpoint-markerstyle-member)|Represents marker style of a chart data point.| -|[ChartPointFormat](/javascript/api/excel/excel.chartpointformat)|[border](/javascript/api/excel/excel.chartpointformat#excel-excel-chartpointformat-border-member)|Represents the border format of a chart data point, which includes color, style, and weight information.| -|[ChartSeries](/javascript/api/excel/excel.chartseries)|[chartType](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-charttype-member)|Represents the chart type of a series.| -||[delete()](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-delete-member(1))|Deletes the chart series.| -||[doughnutHoleSize](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-doughnutholesize-member)|Represents the doughnut hole size of a chart series.| -||[filtered](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-filtered-member)|Specifies if the series is filtered.| -||[gapWidth](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-gapwidth-member)|Represents the gap width of a chart series.| -||[hasDataLabels](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-hasdatalabels-member)|Specifies if the series has data labels.| -||[markerBackgroundColor](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-markerbackgroundcolor-member)|Specifies the marker background color of a chart series.| -||[markerForegroundColor](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-markerforegroundcolor-member)|Specifies the marker foreground color of a chart series.| -||[markerSize](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-markersize-member)|Specifies the marker size of a chart series.| -||[markerStyle](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-markerstyle-member)|Specifies the marker style of a chart series.| -||[plotOrder](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-plotorder-member)|Specifies the plot order of a chart series within the chart group.| -||[setBubbleSizes(sourceData: Range)](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-setbubblesizes-member(1))|Sets the bubble sizes for a chart series.| -||[setValues(sourceData: Range)](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-setvalues-member(1))|Sets the values for a chart series.| -||[setXAxisValues(sourceData: Range)](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-setxaxisvalues-member(1))|Sets the values of the x-axis for a chart series.| -||[showShadow](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-showshadow-member)|Specifies if the series has a shadow.| -||[smooth](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-smooth-member)|Specifies if the series is smooth.| -||[trendlines](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-trendlines-member)|The collection of trendlines in the series.| -|[ChartSeriesCollection](/javascript/api/excel/excel.chartseriescollection)|[add(name?: string, index?: number)](/javascript/api/excel/excel.chartseriescollection#excel-excel-chartseriescollection-add-member(1))|Add a new series to the collection.| -|[ChartTitle](/javascript/api/excel/excel.charttitle)|[getSubstring(start: number, length: number)](/javascript/api/excel/excel.charttitle#excel-excel-charttitle-getsubstring-member(1))|Get the substring of a chart title.| -||[height](/javascript/api/excel/excel.charttitle#excel-excel-charttitle-height-member)|Returns the height, in points, of the chart title.| -||[horizontalAlignment](/javascript/api/excel/excel.charttitle#excel-excel-charttitle-horizontalalignment-member)|Specifies the horizontal alignment for chart title.| -||[left](/javascript/api/excel/excel.charttitle#excel-excel-charttitle-left-member)|Specifies the distance, in points, from the left edge of chart title to the left edge of chart area.| -||[position](/javascript/api/excel/excel.charttitle#excel-excel-charttitle-position-member)|Represents the position of chart title.| -||[setFormula(formula: string)](/javascript/api/excel/excel.charttitle#excel-excel-charttitle-setformula-member(1))|Sets a string value that represents the formula of chart title using A1-style notation.| -||[showShadow](/javascript/api/excel/excel.charttitle#excel-excel-charttitle-showshadow-member)|Represents a boolean value that determines if the chart title has a shadow.| -||[textOrientation](/javascript/api/excel/excel.charttitle#excel-excel-charttitle-textorientation-member)|Specifies the angle to which the text is oriented for the chart title.| -||[top](/javascript/api/excel/excel.charttitle#excel-excel-charttitle-top-member)|Specifies the distance, in points, from the top edge of chart title to the top of chart area.| -||[verticalAlignment](/javascript/api/excel/excel.charttitle#excel-excel-charttitle-verticalalignment-member)|Specifies the vertical alignment of chart title.| -||[width](/javascript/api/excel/excel.charttitle#excel-excel-charttitle-width-member)|Specifies the width, in points, of the chart title.| -|[ChartTitleFormat](/javascript/api/excel/excel.charttitleformat)|[border](/javascript/api/excel/excel.charttitleformat#excel-excel-charttitleformat-border-member)|Represents the border format of chart title, which includes color, linestyle, and weight.| -|[ChartTrendline](/javascript/api/excel/excel.charttrendline)|[delete()](/javascript/api/excel/excel.charttrendline#excel-excel-charttrendline-delete-member(1))|Delete the trendline object.| -||[format](/javascript/api/excel/excel.charttrendline#excel-excel-charttrendline-format-member)|Represents the formatting of a chart trendline.| -||[intercept](/javascript/api/excel/excel.charttrendline#excel-excel-charttrendline-intercept-member)|Represents the intercept value of the trendline.| -||[movingAveragePeriod](/javascript/api/excel/excel.charttrendline#excel-excel-charttrendline-movingaverageperiod-member)|Represents the period of a chart trendline.| -||[name](/javascript/api/excel/excel.charttrendline#excel-excel-charttrendline-name-member)|Represents the name of the trendline.| -||[polynomialOrder](/javascript/api/excel/excel.charttrendline#excel-excel-charttrendline-polynomialorder-member)|Represents the order of a chart trendline.| -||[type](/javascript/api/excel/excel.charttrendline#excel-excel-charttrendline-type-member)|Represents the type of a chart trendline.| -|[ChartTrendlineCollection](/javascript/api/excel/excel.charttrendlinecollection)|[add(type?: Excel.ChartTrendlineType)](/javascript/api/excel/excel.charttrendlinecollection#excel-excel-charttrendlinecollection-add-member(1))|Adds a new trendline to trendline collection.| -||[getCount()](/javascript/api/excel/excel.charttrendlinecollection#excel-excel-charttrendlinecollection-getcount-member(1))|Returns the number of trendlines in the collection.| -||[getItem(index: number)](/javascript/api/excel/excel.charttrendlinecollection#excel-excel-charttrendlinecollection-getitem-member(1))|Gets a trendline object by index, which is the insertion order in the items array.| -||[items](/javascript/api/excel/excel.charttrendlinecollection#excel-excel-charttrendlinecollection-items-member)|Gets the loaded child items in this collection.| -|[ChartTrendlineFormat](/javascript/api/excel/excel.charttrendlineformat)|[line](/javascript/api/excel/excel.charttrendlineformat#excel-excel-charttrendlineformat-line-member)|Represents chart line formatting.| -|[CustomProperty](/javascript/api/excel/excel.customproperty)|[delete()](/javascript/api/excel/excel.customproperty#excel-excel-customproperty-delete-member(1))|Deletes the custom property.| -||[key](/javascript/api/excel/excel.customproperty#excel-excel-customproperty-key-member)|The key of the custom property.| -||[type](/javascript/api/excel/excel.customproperty#excel-excel-customproperty-type-member)|The type of the value used for the custom property.| -||[value](/javascript/api/excel/excel.customproperty#excel-excel-customproperty-value-member)|The value of the custom property.| -|[CustomPropertyCollection](/javascript/api/excel/excel.custompropertycollection)|[add(key: string, value: any)](/javascript/api/excel/excel.custompropertycollection#excel-excel-custompropertycollection-add-member(1))|Creates a new or sets an existing custom property.| -||[deleteAll()](/javascript/api/excel/excel.custompropertycollection#excel-excel-custompropertycollection-deleteall-member(1))|Deletes all custom properties in this collection.| -||[getCount()](/javascript/api/excel/excel.custompropertycollection#excel-excel-custompropertycollection-getcount-member(1))|Gets the count of custom properties.| -||[getItem(key: string)](/javascript/api/excel/excel.custompropertycollection#excel-excel-custompropertycollection-getitem-member(1))|Gets a custom property object by its key, which is case-insensitive.| -||[getItemOrNullObject(key: string)](/javascript/api/excel/excel.custompropertycollection#excel-excel-custompropertycollection-getitemornullobject-member(1))|Gets a custom property object by its key, which is case-insensitive.| -||[items](/javascript/api/excel/excel.custompropertycollection#excel-excel-custompropertycollection-items-member)|Gets the loaded child items in this collection.| -|[DataConnectionCollection](/javascript/api/excel/excel.dataconnectioncollection)|[refreshAll()](/javascript/api/excel/excel.dataconnectioncollection#excel-excel-dataconnectioncollection-refreshall-member(1))|Refreshes data connections in the collection, such as from a PivotTable to a Power BI dataset, or a Data Model to a table or range in the same workbook.| -|[DocumentProperties](/javascript/api/excel/excel.documentproperties)|[author](/javascript/api/excel/excel.documentproperties#excel-excel-documentproperties-author-member)|The author of the workbook.| -||[category](/javascript/api/excel/excel.documentproperties#excel-excel-documentproperties-category-member)|The category of the workbook.| -||[comments](/javascript/api/excel/excel.documentproperties#excel-excel-documentproperties-comments-member)|The Comments field in the metadata of the workbook.| -||[company](/javascript/api/excel/excel.documentproperties#excel-excel-documentproperties-company-member)|The company of the workbook.| -||[creationDate](/javascript/api/excel/excel.documentproperties#excel-excel-documentproperties-creationdate-member)|Gets the creation date of the workbook.| -||[custom](/javascript/api/excel/excel.documentproperties#excel-excel-documentproperties-custom-member)|Gets the collection of custom properties of the workbook.| -||[keywords](/javascript/api/excel/excel.documentproperties#excel-excel-documentproperties-keywords-member)|The keywords of the workbook.| -||[lastAuthor](/javascript/api/excel/excel.documentproperties#excel-excel-documentproperties-lastauthor-member)|Gets the last author of the workbook.| -||[manager](/javascript/api/excel/excel.documentproperties#excel-excel-documentproperties-manager-member)|The manager of the workbook.| -||[revisionNumber](/javascript/api/excel/excel.documentproperties#excel-excel-documentproperties-revisionnumber-member)|Gets the revision number of the workbook.| -||[subject](/javascript/api/excel/excel.documentproperties#excel-excel-documentproperties-subject-member)|The subject of the workbook.| -||[title](/javascript/api/excel/excel.documentproperties#excel-excel-documentproperties-title-member)|The title of the workbook.| -|[NamedItem](/javascript/api/excel/excel.nameditem)|[arrayValues](/javascript/api/excel/excel.nameditem#excel-excel-nameditem-arrayvalues-member)|Returns an object containing values and types of the named item.| -||[formula](/javascript/api/excel/excel.nameditem#excel-excel-nameditem-formula-member)|The formula of the named item.| -|[NamedItemArrayValues](/javascript/api/excel/excel.nameditemarrayvalues)|[types](/javascript/api/excel/excel.nameditemarrayvalues#excel-excel-nameditemarrayvalues-types-member)|Represents the types for each item in the named item array| -||[values](/javascript/api/excel/excel.nameditemarrayvalues#excel-excel-nameditemarrayvalues-values-member)|Represents the values of each item in the named item array.| -|[Range](/javascript/api/excel/excel.range)|[getAbsoluteResizedRange(numRows: number, numColumns: number)](/javascript/api/excel/excel.range#excel-excel-range-getabsoluteresizedrange-member(1))|Gets a `Range` object with the same top-left cell as the current `Range` object, but with the specified numbers of rows and columns.| -||[getImage()](/javascript/api/excel/excel.range#excel-excel-range-getimage-member(1))|Renders the range as a Base64-encoded PNG image.| -||[getSurroundingRegion()](/javascript/api/excel/excel.range#excel-excel-range-getsurroundingregion-member(1))|Returns a `Range` object that represents the surrounding region for the top-left cell in this range.| -||[hyperlink](/javascript/api/excel/excel.range#excel-excel-range-hyperlink-member)|Represents the hyperlink for the current range.| -||[isEntireColumn](/javascript/api/excel/excel.range#excel-excel-range-isentirecolumn-member)|Represents if the current range is an entire column.| -||[isEntireRow](/javascript/api/excel/excel.range#excel-excel-range-isentirerow-member)|Represents if the current range is an entire row.| -||[numberFormatLocal](/javascript/api/excel/excel.range#excel-excel-range-numberformatlocal-member)|Represents Excel's number format code for the given range, based on the language settings of the user.| -||[showCard()](/javascript/api/excel/excel.range#excel-excel-range-showcard-member(1))|Displays the card for an active cell if it has rich value content.| -||[style](/javascript/api/excel/excel.range#excel-excel-range-style-member)|Represents the style of the current range.| -|[RangeFormat](/javascript/api/excel/excel.rangeformat)|[textOrientation](/javascript/api/excel/excel.rangeformat#excel-excel-rangeformat-textorientation-member)|The text orientation of all the cells within the range.| -||[useStandardHeight](/javascript/api/excel/excel.rangeformat#excel-excel-rangeformat-usestandardheight-member)|Determines if the row height of the `Range` object equals the standard height of the sheet.| -||[useStandardWidth](/javascript/api/excel/excel.rangeformat#excel-excel-rangeformat-usestandardwidth-member)|Specifies if the column width of the `Range` object equals the standard width of the sheet.| -|[RangeHyperlink](/javascript/api/excel/excel.rangehyperlink)|[address](/javascript/api/excel/excel.rangehyperlink#excel-excel-rangehyperlink-address-member)|Represents the URL target for the hyperlink.| -||[documentReference](/javascript/api/excel/excel.rangehyperlink#excel-excel-rangehyperlink-documentreference-member)|Represents the document reference target for the hyperlink.| -||[screenTip](/javascript/api/excel/excel.rangehyperlink#excel-excel-rangehyperlink-screentip-member)|Represents the string displayed when hovering over the hyperlink.| -||[textToDisplay](/javascript/api/excel/excel.rangehyperlink#excel-excel-rangehyperlink-texttodisplay-member)|Represents the string that is displayed in the top left most cell in the range.| -|[Style](/javascript/api/excel/excel.style)|[borders](/javascript/api/excel/excel.style#excel-excel-style-borders-member)|A collection of four border objects that represent the style of the four borders.| -||[builtIn](/javascript/api/excel/excel.style#excel-excel-style-builtin-member)|Specifies if the style is a built-in style.| -||[delete()](/javascript/api/excel/excel.style#excel-excel-style-delete-member(1))|Deletes this style.| -||[fill](/javascript/api/excel/excel.style#excel-excel-style-fill-member)|The fill of the style.| -||[font](/javascript/api/excel/excel.style#excel-excel-style-font-member)|A `Font` object that represents the font of the style.| -||[formulaHidden](/javascript/api/excel/excel.style#excel-excel-style-formulahidden-member)|Specifies if the formula will be hidden when the worksheet is protected.| -||[horizontalAlignment](/javascript/api/excel/excel.style#excel-excel-style-horizontalalignment-member)|Represents the horizontal alignment for the style.| -||[includeAlignment](/javascript/api/excel/excel.style#excel-excel-style-includealignment-member)|Specifies if the style includes the auto indent, horizontal alignment, vertical alignment, wrap text, indent level, and text orientation properties.| -||[includeBorder](/javascript/api/excel/excel.style#excel-excel-style-includeborder-member)|Specifies if the style includes the color, color index, line style, and weight border properties.| -||[includeFont](/javascript/api/excel/excel.style#excel-excel-style-includefont-member)|Specifies if the style includes the background, bold, color, color index, font style, italic, name, size, strikethrough, subscript, superscript, and underline font properties.| -||[includeNumber](/javascript/api/excel/excel.style#excel-excel-style-includenumber-member)|Specifies if the style includes the number format property.| -||[includePatterns](/javascript/api/excel/excel.style#excel-excel-style-includepatterns-member)|Specifies if the style includes the color, color index, invert if negative, pattern, pattern color, and pattern color index interior properties.| -||[includeProtection](/javascript/api/excel/excel.style#excel-excel-style-includeprotection-member)|Specifies if the style includes the formula hidden and locked protection properties.| -||[indentLevel](/javascript/api/excel/excel.style#excel-excel-style-indentlevel-member)|An integer from 0 to 250 that indicates the indent level for the style.| -||[locked](/javascript/api/excel/excel.style#excel-excel-style-locked-member)|Specifies if the object is locked when the worksheet is protected.| -||[name](/javascript/api/excel/excel.style#excel-excel-style-name-member)|The name of the style.| -||[numberFormat](/javascript/api/excel/excel.style#excel-excel-style-numberformat-member)|The format code of the number format for the style.| -||[numberFormatLocal](/javascript/api/excel/excel.style#excel-excel-style-numberformatlocal-member)|The localized format code of the number format for the style.| -||[readingOrder](/javascript/api/excel/excel.style#excel-excel-style-readingorder-member)|The reading order for the style.| -||[shrinkToFit](/javascript/api/excel/excel.style#excel-excel-style-shrinktofit-member)|Specifies if text automatically shrinks to fit in the available column width.| -||[verticalAlignment](/javascript/api/excel/excel.style#excel-excel-style-verticalalignment-member)|Specifies the vertical alignment for the style.| -||[wrapText](/javascript/api/excel/excel.style#excel-excel-style-wraptext-member)|Specifies if Excel wraps the text in the object.| -|[StyleCollection](/javascript/api/excel/excel.stylecollection)|[add(name: string)](/javascript/api/excel/excel.stylecollection#excel-excel-stylecollection-add-member(1))|Adds a new style to the collection.| -||[getItem(name: string)](/javascript/api/excel/excel.stylecollection#excel-excel-stylecollection-getitem-member(1))|Gets a `Style` by name.| -||[items](/javascript/api/excel/excel.stylecollection#excel-excel-stylecollection-items-member)|Gets the loaded child items in this collection.| -|[Table](/javascript/api/excel/excel.table)|[onChanged](/javascript/api/excel/excel.table#excel-excel-table-onchanged-member)|Occurs when data in cells changes on a specific table.| -||[onSelectionChanged](/javascript/api/excel/excel.table#excel-excel-table-onselectionchanged-member)|Occurs when the selection changes on a specific table.| -|[TableChangedEventArgs](/javascript/api/excel/excel.tablechangedeventargs)|[address](/javascript/api/excel/excel.tablechangedeventargs#excel-excel-tablechangedeventargs-address-member)|Gets the address that represents the changed area of a table on a specific worksheet.| -||[changeType](/javascript/api/excel/excel.tablechangedeventargs#excel-excel-tablechangedeventargs-changetype-member)|Gets the change type that represents how the changed event is triggered.| -||[source](/javascript/api/excel/excel.tablechangedeventargs#excel-excel-tablechangedeventargs-source-member)|Gets the source of the event.| -||[tableId](/javascript/api/excel/excel.tablechangedeventargs#excel-excel-tablechangedeventargs-tableid-member)|Gets the ID of the table in which the data changed.| -||[type](/javascript/api/excel/excel.tablechangedeventargs#excel-excel-tablechangedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/javascript/api/excel/excel.tablechangedeventargs#excel-excel-tablechangedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the data changed.| -|[TableCollection](/javascript/api/excel/excel.tablecollection)|[onChanged](/javascript/api/excel/excel.tablecollection#excel-excel-tablecollection-onchanged-member)|Occurs when data changes on any table in a workbook, or a worksheet.| -|[TableSelectionChangedEventArgs](/javascript/api/excel/excel.tableselectionchangedeventargs)|[address](/javascript/api/excel/excel.tableselectionchangedeventargs#excel-excel-tableselectionchangedeventargs-address-member)|Gets the range address that represents the selected area of the table on a specific worksheet.| -||[isInsideTable](/javascript/api/excel/excel.tableselectionchangedeventargs#excel-excel-tableselectionchangedeventargs-isinsidetable-member)|Specifies if the selection is inside a table.| -||[tableId](/javascript/api/excel/excel.tableselectionchangedeventargs#excel-excel-tableselectionchangedeventargs-tableid-member)|Gets the ID of the table in which the selection changed.| -||[type](/javascript/api/excel/excel.tableselectionchangedeventargs#excel-excel-tableselectionchangedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/javascript/api/excel/excel.tableselectionchangedeventargs#excel-excel-tableselectionchangedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the selection changed.| -|[Workbook](/javascript/api/excel/excel.workbook)|[dataConnections](/javascript/api/excel/excel.workbook#excel-excel-workbook-dataconnections-member)|Represents all data connections in the workbook.| -||[getActiveCell()](/javascript/api/excel/excel.workbook#excel-excel-workbook-getactivecell-member(1))|Gets the currently active cell from the workbook.| -||[name](/javascript/api/excel/excel.workbook#excel-excel-workbook-name-member)|Gets the workbook name.| -||[properties](/javascript/api/excel/excel.workbook#excel-excel-workbook-properties-member)|Gets the workbook properties.| -||[protection](/javascript/api/excel/excel.workbook#excel-excel-workbook-protection-member)|Returns the protection object for a workbook.| -||[styles](/javascript/api/excel/excel.workbook#excel-excel-workbook-styles-member)|Represents a collection of styles associated with the workbook.| -|[WorkbookProtection](/javascript/api/excel/excel.workbookprotection)|[protect(password?: string)](/javascript/api/excel/excel.workbookprotection#excel-excel-workbookprotection-protect-member(1))|Protects the workbook.| -||[protected](/javascript/api/excel/excel.workbookprotection#excel-excel-workbookprotection-protected-member)|Specifies if the workbook is protected.| -||[unprotect(password?: string)](/javascript/api/excel/excel.workbookprotection#excel-excel-workbookprotection-unprotect-member(1))|Unprotects the workbook.| -|[Worksheet](/javascript/api/excel/excel.worksheet)|[copy(positionType?: Excel.WorksheetPositionType, relativeTo?: Excel.Worksheet)](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-copy-member(1))|Copies a worksheet and places it at the specified position.| -||[freezePanes](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-freezepanes-member)|Gets an object that can be used to manipulate frozen panes on the worksheet.| -||[getRangeByIndexes(startRow: number, startColumn: number, rowCount: number, columnCount: number)](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-getrangebyindexes-member(1))|Gets the `Range` object beginning at a particular row index and column index, and spanning a certain number of rows and columns.| -||[onActivated](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-onactivated-member)|Occurs when the worksheet is activated.| -||[onChanged](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-onchanged-member)|Occurs when data changes in a specific worksheet.| -||[onDeactivated](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-ondeactivated-member)|Occurs when the worksheet is deactivated.| -||[onSelectionChanged](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-onselectionchanged-member)|Occurs when the selection changes on a specific worksheet.| -||[standardHeight](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-standardheight-member)|Returns the standard (default) height of all the rows in the worksheet, in points.| -||[standardWidth](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-standardwidth-member)|Specifies the standard (default) width of all the columns in the worksheet.| -||[tabColor](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-tabcolor-member)|The tab color of the worksheet.| -|[WorksheetActivatedEventArgs](/javascript/api/excel/excel.worksheetactivatedeventargs)|[type](/javascript/api/excel/excel.worksheetactivatedeventargs#excel-excel-worksheetactivatedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/javascript/api/excel/excel.worksheetactivatedeventargs#excel-excel-worksheetactivatedeventargs-worksheetid-member)|Gets the ID of the worksheet that is activated.| -|[WorksheetAddedEventArgs](/javascript/api/excel/excel.worksheetaddedeventargs)|[source](/javascript/api/excel/excel.worksheetaddedeventargs#excel-excel-worksheetaddedeventargs-source-member)|Gets the source of the event.| -||[type](/javascript/api/excel/excel.worksheetaddedeventargs#excel-excel-worksheetaddedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/javascript/api/excel/excel.worksheetaddedeventargs#excel-excel-worksheetaddedeventargs-worksheetid-member)|Gets the ID of the worksheet that is added to the workbook.| -|[WorksheetChangedEventArgs](/javascript/api/excel/excel.worksheetchangedeventargs)|[address](/javascript/api/excel/excel.worksheetchangedeventargs#excel-excel-worksheetchangedeventargs-address-member)|Gets the range address that represents the changed area of a specific worksheet.| -||[changeType](/javascript/api/excel/excel.worksheetchangedeventargs#excel-excel-worksheetchangedeventargs-changetype-member)|Gets the change type that represents how the changed event is triggered.| -||[source](/javascript/api/excel/excel.worksheetchangedeventargs#excel-excel-worksheetchangedeventargs-source-member)|Gets the source of the event.| -||[type](/javascript/api/excel/excel.worksheetchangedeventargs#excel-excel-worksheetchangedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/javascript/api/excel/excel.worksheetchangedeventargs#excel-excel-worksheetchangedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the data changed.| -|[WorksheetCollection](/javascript/api/excel/excel.worksheetcollection)|[onActivated](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-onactivated-member)|Occurs when any worksheet in the workbook is activated.| -||[onAdded](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-onadded-member)|Occurs when a new worksheet is added to the workbook.| -||[onDeactivated](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-ondeactivated-member)|Occurs when any worksheet in the workbook is deactivated.| -||[onDeleted](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-ondeleted-member)|Occurs when a worksheet is deleted from the workbook.| -|[WorksheetDeactivatedEventArgs](/javascript/api/excel/excel.worksheetdeactivatedeventargs)|[type](/javascript/api/excel/excel.worksheetdeactivatedeventargs#excel-excel-worksheetdeactivatedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/javascript/api/excel/excel.worksheetdeactivatedeventargs#excel-excel-worksheetdeactivatedeventargs-worksheetid-member)|Gets the ID of the worksheet that is deactivated.| -|[WorksheetDeletedEventArgs](/javascript/api/excel/excel.worksheetdeletedeventargs)|[source](/javascript/api/excel/excel.worksheetdeletedeventargs#excel-excel-worksheetdeletedeventargs-source-member)|Gets the source of the event.| -||[type](/javascript/api/excel/excel.worksheetdeletedeventargs#excel-excel-worksheetdeletedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/javascript/api/excel/excel.worksheetdeletedeventargs#excel-excel-worksheetdeletedeventargs-worksheetid-member)|Gets the ID of the worksheet that is deleted from the workbook.| -|[WorksheetFreezePanes](/javascript/api/excel/excel.worksheetfreezepanes)|[freezeAt(frozenRange: Range \| string)](/javascript/api/excel/excel.worksheetfreezepanes#excel-excel-worksheetfreezepanes-freezeat-member(1))|Sets the frozen cells in the active worksheet view.| -||[freezeColumns(count?: number)](/javascript/api/excel/excel.worksheetfreezepanes#excel-excel-worksheetfreezepanes-freezecolumns-member(1))|Freeze the first column or columns of the worksheet in place.| -||[freezeRows(count?: number)](/javascript/api/excel/excel.worksheetfreezepanes#excel-excel-worksheetfreezepanes-freezerows-member(1))|Freeze the top row or rows of the worksheet in place.| -||[getLocation()](/javascript/api/excel/excel.worksheetfreezepanes#excel-excel-worksheetfreezepanes-getlocation-member(1))|Gets a range that describes the frozen cells in the active worksheet view.| -||[getLocationOrNullObject()](/javascript/api/excel/excel.worksheetfreezepanes#excel-excel-worksheetfreezepanes-getlocationornullobject-member(1))|Gets a range that describes the frozen cells in the active worksheet view.| -||[unfreeze()](/javascript/api/excel/excel.worksheetfreezepanes#excel-excel-worksheetfreezepanes-unfreeze-member(1))|Removes all frozen panes in the worksheet.| -|[WorksheetProtection](/javascript/api/excel/excel.worksheetprotection)|[unprotect(password?: string)](/javascript/api/excel/excel.worksheetprotection#excel-excel-worksheetprotection-unprotect-member(1))|Unprotects a worksheet.| -|[WorksheetProtectionOptions](/javascript/api/excel/excel.worksheetprotectionoptions)|[allowEditObjects](/javascript/api/excel/excel.worksheetprotectionoptions#excel-excel-worksheetprotectionoptions-alloweditobjects-member)|Represents the worksheet protection option allowing editing of objects.| -||[allowEditScenarios](/javascript/api/excel/excel.worksheetprotectionoptions#excel-excel-worksheetprotectionoptions-alloweditscenarios-member)|Represents the worksheet protection option allowing editing of scenarios.| -||[selectionMode](/javascript/api/excel/excel.worksheetprotectionoptions#excel-excel-worksheetprotectionoptions-selectionmode-member)|Represents the worksheet protection option of selection mode.| -|[WorksheetSelectionChangedEventArgs](/javascript/api/excel/excel.worksheetselectionchangedeventargs)|[address](/javascript/api/excel/excel.worksheetselectionchangedeventargs#excel-excel-worksheetselectionchangedeventargs-address-member)|Gets the range address that represents the selected area of a specific worksheet.| -||[type](/javascript/api/excel/excel.worksheetselectionchangedeventargs#excel-excel-worksheetselectionchangedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/javascript/api/excel/excel.worksheetselectionchangedeventargs#excel-excel-worksheetselectionchangedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the selection changed.| +|[Chart](/.chart)|[chartType](/.chart#excel-javascript/api/excel/-chart-charttype-member)|Specifies the type of the chart.| +||[id](/.chart#excel-javascript/api/excel/-chart-id-member)|The unique ID of chart.| +||[showAllFieldButtons](/.chart#excel-javascript/api/excel/-chart-showallfieldbuttons-member)|Specifies whether to display all field buttons on a PivotChart.| +|[ChartAreaFormat](/.chartareaformat)|[border](/.chartareaformat#excel-javascript/api/excel/-chartareaformat-border-member)|Represents the border format of chart area, which includes color, linestyle, and weight.| +|[ChartAxes](/.chartaxes)|[getItem(type: Excel.ChartAxisType, group?: Excel.ChartAxisGroup)](/.chartaxes#excel-javascript/api/excel/-chartaxes-getitem-member(1))|Returns the specific axis identified by type and group.| +|[ChartAxis](/.chartaxis)|[axisGroup](/.chartaxis#excel-javascript/api/excel/-chartaxis-axisgroup-member)|Specifies the group for the specified axis.| +||[baseTimeUnit](/.chartaxis#excel-javascript/api/excel/-chartaxis-basetimeunit-member)|Specifies the base unit for the specified category axis.| +||[categoryType](/.chartaxis#excel-javascript/api/excel/-chartaxis-categorytype-member)|Specifies the category axis type.| +||[customDisplayUnit](/.chartaxis#excel-javascript/api/excel/-chartaxis-customdisplayunit-member)|Specifies the custom axis display unit value.| +||[displayUnit](/.chartaxis#excel-javascript/api/excel/-chartaxis-displayunit-member)|Represents the axis display unit.| +||[height](/.chartaxis#excel-javascript/api/excel/-chartaxis-height-member)|Specifies the height, in points, of the chart axis.| +||[left](/.chartaxis#excel-javascript/api/excel/-chartaxis-left-member)|Specifies the distance, in points, from the left edge of the axis to the left of chart area.| +||[logBase](/.chartaxis#excel-javascript/api/excel/-chartaxis-logbase-member)|Specifies the base of the logarithm when using logarithmic scales.| +||[majorTickMark](/.chartaxis#excel-javascript/api/excel/-chartaxis-majortickmark-member)|Specifies the type of major tick mark for the specified axis.| +||[majorTimeUnitScale](/.chartaxis#excel-javascript/api/excel/-chartaxis-majortimeunitscale-member)|Specifies the major unit scale value for the category axis when the `categoryType` property is set to `dateAxis`.| +||[minorTickMark](/.chartaxis#excel-javascript/api/excel/-chartaxis-minortickmark-member)|Specifies the type of minor tick mark for the specified axis.| +||[minorTimeUnitScale](/.chartaxis#excel-javascript/api/excel/-chartaxis-minortimeunitscale-member)|Specifies the minor unit scale value for the category axis when the `categoryType` property is set to `dateAxis`.| +||[reversePlotOrder](/.chartaxis#excel-javascript/api/excel/-chartaxis-reverseplotorder-member)|Specifies if Excel plots data points from last to first.| +||[scaleType](/.chartaxis#excel-javascript/api/excel/-chartaxis-scaletype-member)|Specifies the value axis scale type.| +||[setCategoryNames(sourceData: Range)](/.chartaxis#excel-javascript/api/excel/-chartaxis-setcategorynames-member(1))|Sets all the category names for the specified axis.| +||[setCustomDisplayUnit(value: number)](/.chartaxis#excel-javascript/api/excel/-chartaxis-setcustomdisplayunit-member(1))|Sets the axis display unit to a custom value.| +||[showDisplayUnitLabel](/.chartaxis#excel-javascript/api/excel/-chartaxis-showdisplayunitlabel-member)|Specifies if the axis display unit label is visible.| +||[tickLabelPosition](/.chartaxis#excel-javascript/api/excel/-chartaxis-ticklabelposition-member)|Specifies the position of tick-mark labels on the specified axis.| +||[tickLabelSpacing](/.chartaxis#excel-javascript/api/excel/-chartaxis-ticklabelspacing-member)|Specifies the number of categories or series between tick-mark labels.| +||[tickMarkSpacing](/.chartaxis#excel-javascript/api/excel/-chartaxis-tickmarkspacing-member)|Specifies the number of categories or series between tick marks.| +||[top](/.chartaxis#excel-javascript/api/excel/-chartaxis-top-member)|Specifies the distance, in points, from the top edge of the axis to the top of chart area.| +||[type](/.chartaxis#excel-javascript/api/excel/-chartaxis-type-member)|Specifies the axis type.| +||[visible](/.chartaxis#excel-javascript/api/excel/-chartaxis-visible-member)|Specifies if the axis is visible.| +||[width](/.chartaxis#excel-javascript/api/excel/-chartaxis-width-member)|Specifies the width, in points, of the chart axis.| +|[ChartBorder](/.chartborder)|[color](/.chartborder#excel-javascript/api/excel/-chartborder-color-member)|HTML color code representing the color of borders in the chart.| +||[lineStyle](/.chartborder#excel-javascript/api/excel/-chartborder-linestyle-member)|Represents the line style of the border.| +||[weight](/.chartborder#excel-javascript/api/excel/-chartborder-weight-member)|Represents weight of the border, in points.| +|[ChartDataLabel](/.chartdatalabel)|[position](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-position-member)|Value that represents the position of the data label.| +||[separator](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-separator-member)|String representing the separator used for the data label on a chart.| +||[showBubbleSize](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-showbubblesize-member)|Specifies if the data label bubble size is visible.| +||[showCategoryName](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-showcategoryname-member)|Specifies if the data label category name is visible.| +||[showLegendKey](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-showlegendkey-member)|Specifies if the data label legend key is visible.| +||[showPercentage](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-showpercentage-member)|Specifies if the data label percentage is visible.| +||[showSeriesName](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-showseriesname-member)|Specifies if the data label series name is visible.| +||[showValue](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-showvalue-member)|Specifies if the data label value is visible.| +|[ChartFormatString](/.chartformatstring)|[font](/.chartformatstring#excel-javascript/api/excel/-chartformatstring-font-member)|Represents the font attributes, such as font name, font size, and color of a chart characters object.| +|[ChartLegend](/.chartlegend)|[height](/.chartlegend#excel-javascript/api/excel/-chartlegend-height-member)|Specifies the height, in points, of the legend on the chart.| +||[left](/.chartlegend#excel-javascript/api/excel/-chartlegend-left-member)|Specifies the left value, in points, of the legend on the chart.| +||[legendEntries](/.chartlegend#excel-javascript/api/excel/-chartlegend-legendentries-member)|Represents a collection of legendEntries in the legend.| +||[showShadow](/.chartlegend#excel-javascript/api/excel/-chartlegend-showshadow-member)|Specifies if the legend has a shadow on the chart.| +||[top](/.chartlegend#excel-javascript/api/excel/-chartlegend-top-member)|Specifies the top of a chart legend.| +||[width](/.chartlegend#excel-javascript/api/excel/-chartlegend-width-member)|Specifies the width, in points, of the legend on the chart.| +|[ChartLegendEntry](/.chartlegendentry)|[visible](/.chartlegendentry#excel-javascript/api/excel/-chartlegendentry-visible-member)|Represents the visibility of a chart legend entry.| +|[ChartLegendEntryCollection](/.chartlegendentrycollection)|[getCount()](/.chartlegendentrycollection#excel-javascript/api/excel/-chartlegendentrycollection-getcount-member(1))|Returns the number of legend entries in the collection.| +||[getItemAt(index: number)](/.chartlegendentrycollection#excel-javascript/api/excel/-chartlegendentrycollection-getitemat-member(1))|Returns a legend entry at the given index.| +||[items](/.chartlegendentrycollection#excel-javascript/api/excel/-chartlegendentrycollection-items-member)|Gets the loaded child items in this collection.| +|[ChartLineFormat](/.chartlineformat)|[lineStyle](/.chartlineformat#excel-javascript/api/excel/-chartlineformat-linestyle-member)|Represents the line style.| +||[weight](/.chartlineformat#excel-javascript/api/excel/-chartlineformat-weight-member)|Represents weight of the line, in points.| +|[ChartPoint](/.chartpoint)|[dataLabel](/.chartpoint#excel-javascript/api/excel/-chartpoint-datalabel-member)|Returns the data label of a chart point.| +||[hasDataLabel](/.chartpoint#excel-javascript/api/excel/-chartpoint-hasdatalabel-member)|Represents whether a data point has a data label.| +||[markerBackgroundColor](/.chartpoint#excel-javascript/api/excel/-chartpoint-markerbackgroundcolor-member)|HTML color code representation of the marker background color of a data point (e.g., #FF0000 represents Red).| +||[markerForegroundColor](/.chartpoint#excel-javascript/api/excel/-chartpoint-markerforegroundcolor-member)|HTML color code representation of the marker foreground color of a data point (e.g., #FF0000 represents Red).| +||[markerSize](/.chartpoint#excel-javascript/api/excel/-chartpoint-markersize-member)|Represents marker size of a data point.| +||[markerStyle](/.chartpoint#excel-javascript/api/excel/-chartpoint-markerstyle-member)|Represents marker style of a chart data point.| +|[ChartPointFormat](/.chartpointformat)|[border](/.chartpointformat#excel-javascript/api/excel/-chartpointformat-border-member)|Represents the border format of a chart data point, which includes color, style, and weight information.| +|[ChartSeries](/.chartseries)|[chartType](/.chartseries#excel-javascript/api/excel/-chartseries-charttype-member)|Represents the chart type of a series.| +||[delete()](/.chartseries#excel-javascript/api/excel/-chartseries-delete-member(1))|Deletes the chart series.| +||[doughnutHoleSize](/.chartseries#excel-javascript/api/excel/-chartseries-doughnutholesize-member)|Represents the doughnut hole size of a chart series.| +||[filtered](/.chartseries#excel-javascript/api/excel/-chartseries-filtered-member)|Specifies if the series is filtered.| +||[gapWidth](/.chartseries#excel-javascript/api/excel/-chartseries-gapwidth-member)|Represents the gap width of a chart series.| +||[hasDataLabels](/.chartseries#excel-javascript/api/excel/-chartseries-hasdatalabels-member)|Specifies if the series has data labels.| +||[markerBackgroundColor](/.chartseries#excel-javascript/api/excel/-chartseries-markerbackgroundcolor-member)|Specifies the marker background color of a chart series.| +||[markerForegroundColor](/.chartseries#excel-javascript/api/excel/-chartseries-markerforegroundcolor-member)|Specifies the marker foreground color of a chart series.| +||[markerSize](/.chartseries#excel-javascript/api/excel/-chartseries-markersize-member)|Specifies the marker size of a chart series.| +||[markerStyle](/.chartseries#excel-javascript/api/excel/-chartseries-markerstyle-member)|Specifies the marker style of a chart series.| +||[plotOrder](/.chartseries#excel-javascript/api/excel/-chartseries-plotorder-member)|Specifies the plot order of a chart series within the chart group.| +||[setBubbleSizes(sourceData: Range)](/.chartseries#excel-javascript/api/excel/-chartseries-setbubblesizes-member(1))|Sets the bubble sizes for a chart series.| +||[setValues(sourceData: Range)](/.chartseries#excel-javascript/api/excel/-chartseries-setvalues-member(1))|Sets the values for a chart series.| +||[setXAxisValues(sourceData: Range)](/.chartseries#excel-javascript/api/excel/-chartseries-setxaxisvalues-member(1))|Sets the values of the x-axis for a chart series.| +||[showShadow](/.chartseries#excel-javascript/api/excel/-chartseries-showshadow-member)|Specifies if the series has a shadow.| +||[smooth](/.chartseries#excel-javascript/api/excel/-chartseries-smooth-member)|Specifies if the series is smooth.| +||[trendlines](/.chartseries#excel-javascript/api/excel/-chartseries-trendlines-member)|The collection of trendlines in the series.| +|[ChartSeriesCollection](/.chartseriescollection)|[add(name?: string, index?: number)](/.chartseriescollection#excel-javascript/api/excel/-chartseriescollection-add-member(1))|Add a new series to the collection.| +|[ChartTitle](/.charttitle)|[getSubstring(start: number, length: number)](/.charttitle#excel-javascript/api/excel/-charttitle-getsubstring-member(1))|Get the substring of a chart title.| +||[height](/.charttitle#excel-javascript/api/excel/-charttitle-height-member)|Returns the height, in points, of the chart title.| +||[horizontalAlignment](/.charttitle#excel-javascript/api/excel/-charttitle-horizontalalignment-member)|Specifies the horizontal alignment for chart title.| +||[left](/.charttitle#excel-javascript/api/excel/-charttitle-left-member)|Specifies the distance, in points, from the left edge of chart title to the left edge of chart area.| +||[position](/.charttitle#excel-javascript/api/excel/-charttitle-position-member)|Represents the position of chart title.| +||[setFormula(formula: string)](/.charttitle#excel-javascript/api/excel/-charttitle-setformula-member(1))|Sets a string value that represents the formula of chart title using A1-style notation.| +||[showShadow](/.charttitle#excel-javascript/api/excel/-charttitle-showshadow-member)|Represents a boolean value that determines if the chart title has a shadow.| +||[textOrientation](/.charttitle#excel-javascript/api/excel/-charttitle-textorientation-member)|Specifies the angle to which the text is oriented for the chart title.| +||[top](/.charttitle#excel-javascript/api/excel/-charttitle-top-member)|Specifies the distance, in points, from the top edge of chart title to the top of chart area.| +||[verticalAlignment](/.charttitle#excel-javascript/api/excel/-charttitle-verticalalignment-member)|Specifies the vertical alignment of chart title.| +||[width](/.charttitle#excel-javascript/api/excel/-charttitle-width-member)|Specifies the width, in points, of the chart title.| +|[ChartTitleFormat](/.charttitleformat)|[border](/.charttitleformat#excel-javascript/api/excel/-charttitleformat-border-member)|Represents the border format of chart title, which includes color, linestyle, and weight.| +|[ChartTrendline](/.charttrendline)|[delete()](/.charttrendline#excel-javascript/api/excel/-charttrendline-delete-member(1))|Delete the trendline object.| +||[format](/.charttrendline#excel-javascript/api/excel/-charttrendline-format-member)|Represents the formatting of a chart trendline.| +||[intercept](/.charttrendline#excel-javascript/api/excel/-charttrendline-intercept-member)|Represents the intercept value of the trendline.| +||[movingAveragePeriod](/.charttrendline#excel-javascript/api/excel/-charttrendline-movingaverageperiod-member)|Represents the period of a chart trendline.| +||[name](/.charttrendline#excel-javascript/api/excel/-charttrendline-name-member)|Represents the name of the trendline.| +||[polynomialOrder](/.charttrendline#excel-javascript/api/excel/-charttrendline-polynomialorder-member)|Represents the order of a chart trendline.| +||[type](/.charttrendline#excel-javascript/api/excel/-charttrendline-type-member)|Represents the type of a chart trendline.| +|[ChartTrendlineCollection](/.charttrendlinecollection)|[add(type?: Excel.ChartTrendlineType)](/.charttrendlinecollection#excel-javascript/api/excel/-charttrendlinecollection-add-member(1))|Adds a new trendline to trendline collection.| +||[getCount()](/.charttrendlinecollection#excel-javascript/api/excel/-charttrendlinecollection-getcount-member(1))|Returns the number of trendlines in the collection.| +||[getItem(index: number)](/.charttrendlinecollection#excel-javascript/api/excel/-charttrendlinecollection-getitem-member(1))|Gets a trendline object by index, which is the insertion order in the items array.| +||[items](/.charttrendlinecollection#excel-javascript/api/excel/-charttrendlinecollection-items-member)|Gets the loaded child items in this collection.| +|[ChartTrendlineFormat](/.charttrendlineformat)|[line](/.charttrendlineformat#excel-javascript/api/excel/-charttrendlineformat-line-member)|Represents chart line formatting.| +|[CustomProperty](/.customproperty)|[delete()](/.customproperty#excel-javascript/api/excel/-customproperty-delete-member(1))|Deletes the custom property.| +||[key](/.customproperty#excel-javascript/api/excel/-customproperty-key-member)|The key of the custom property.| +||[type](/.customproperty#excel-javascript/api/excel/-customproperty-type-member)|The type of the value used for the custom property.| +||[value](/.customproperty#excel-javascript/api/excel/-customproperty-value-member)|The value of the custom property.| +|[CustomPropertyCollection](/.custompropertycollection)|[add(key: string, value: any)](/.custompropertycollection#excel-javascript/api/excel/-custompropertycollection-add-member(1))|Creates a new or sets an existing custom property.| +||[deleteAll()](/.custompropertycollection#excel-javascript/api/excel/-custompropertycollection-deleteall-member(1))|Deletes all custom properties in this collection.| +||[getCount()](/.custompropertycollection#excel-javascript/api/excel/-custompropertycollection-getcount-member(1))|Gets the count of custom properties.| +||[getItem(key: string)](/.custompropertycollection#excel-javascript/api/excel/-custompropertycollection-getitem-member(1))|Gets a custom property object by its key, which is case-insensitive.| +||[getItemOrNullObject(key: string)](/.custompropertycollection#excel-javascript/api/excel/-custompropertycollection-getitemornullobject-member(1))|Gets a custom property object by its key, which is case-insensitive.| +||[items](/.custompropertycollection#excel-javascript/api/excel/-custompropertycollection-items-member)|Gets the loaded child items in this collection.| +|[DataConnectionCollection](/.dataconnectioncollection)|[refreshAll()](/.dataconnectioncollection#excel-javascript/api/excel/-dataconnectioncollection-refreshall-member(1))|Refreshes data connections in the collection, such as from a PivotTable to a Power BI dataset, or a Data Model to a table or range in the same workbook.| +|[DocumentProperties](/.documentproperties)|[author](/.documentproperties#excel-javascript/api/excel/-documentproperties-author-member)|The author of the workbook.| +||[category](/.documentproperties#excel-javascript/api/excel/-documentproperties-category-member)|The category of the workbook.| +||[comments](/.documentproperties#excel-javascript/api/excel/-documentproperties-comments-member)|The Comments field in the metadata of the workbook.| +||[company](/.documentproperties#excel-javascript/api/excel/-documentproperties-company-member)|The company of the workbook.| +||[creationDate](/.documentproperties#excel-javascript/api/excel/-documentproperties-creationdate-member)|Gets the creation date of the workbook.| +||[custom](/.documentproperties#excel-javascript/api/excel/-documentproperties-custom-member)|Gets the collection of custom properties of the workbook.| +||[keywords](/.documentproperties#excel-javascript/api/excel/-documentproperties-keywords-member)|The keywords of the workbook.| +||[lastAuthor](/.documentproperties#excel-javascript/api/excel/-documentproperties-lastauthor-member)|Gets the last author of the workbook.| +||[manager](/.documentproperties#excel-javascript/api/excel/-documentproperties-manager-member)|The manager of the workbook.| +||[revisionNumber](/.documentproperties#excel-javascript/api/excel/-documentproperties-revisionnumber-member)|Gets the revision number of the workbook.| +||[subject](/.documentproperties#excel-javascript/api/excel/-documentproperties-subject-member)|The subject of the workbook.| +||[title](/.documentproperties#excel-javascript/api/excel/-documentproperties-title-member)|The title of the workbook.| +|[NamedItem](/.nameditem)|[arrayValues](/.nameditem#excel-javascript/api/excel/-nameditem-arrayvalues-member)|Returns an object containing values and types of the named item.| +||[formula](/.nameditem#excel-javascript/api/excel/-nameditem-formula-member)|The formula of the named item.| +|[NamedItemArrayValues](/.nameditemarrayvalues)|[types](/.nameditemarrayvalues#excel-javascript/api/excel/-nameditemarrayvalues-types-member)|Represents the types for each item in the named item array| +||[values](/.nameditemarrayvalues#excel-javascript/api/excel/-nameditemarrayvalues-values-member)|Represents the values of each item in the named item array.| +|[Range](/.range)|[getAbsoluteResizedRange(numRows: number, numColumns: number)](/.range#excel-javascript/api/excel/-range-getabsoluteresizedrange-member(1))|Gets a `Range` object with the same top-left cell as the current `Range` object, but with the specified numbers of rows and columns.| +||[getImage()](/.range#excel-javascript/api/excel/-range-getimage-member(1))|Renders the range as a Base64-encoded PNG image.| +||[getSurroundingRegion()](/.range#excel-javascript/api/excel/-range-getsurroundingregion-member(1))|Returns a `Range` object that represents the surrounding region for the top-left cell in this range.| +||[hyperlink](/.range#excel-javascript/api/excel/-range-hyperlink-member)|Represents the hyperlink for the current range.| +||[isEntireColumn](/.range#excel-javascript/api/excel/-range-isentirecolumn-member)|Represents if the current range is an entire column.| +||[isEntireRow](/.range#excel-javascript/api/excel/-range-isentirerow-member)|Represents if the current range is an entire row.| +||[numberFormatLocal](/.range#excel-javascript/api/excel/-range-numberformatlocal-member)|Represents Excel's number format code for the given range, based on the language settings of the user.| +||[showCard()](/.range#excel-javascript/api/excel/-range-showcard-member(1))|Displays the card for an active cell if it has rich value content.| +||[style](/.range#excel-javascript/api/excel/-range-style-member)|Represents the style of the current range.| +|[RangeFormat](/.rangeformat)|[textOrientation](/.rangeformat#excel-javascript/api/excel/-rangeformat-textorientation-member)|The text orientation of all the cells within the range.| +||[useStandardHeight](/.rangeformat#excel-javascript/api/excel/-rangeformat-usestandardheight-member)|Determines if the row height of the `Range` object equals the standard height of the sheet.| +||[useStandardWidth](/.rangeformat#excel-javascript/api/excel/-rangeformat-usestandardwidth-member)|Specifies if the column width of the `Range` object equals the standard width of the sheet.| +|[RangeHyperlink](/.rangehyperlink)|[address](/.rangehyperlink#excel-javascript/api/excel/-rangehyperlink-address-member)|Represents the URL target for the hyperlink.| +||[documentReference](/.rangehyperlink#excel-javascript/api/excel/-rangehyperlink-documentreference-member)|Represents the document reference target for the hyperlink.| +||[screenTip](/.rangehyperlink#excel-javascript/api/excel/-rangehyperlink-screentip-member)|Represents the string displayed when hovering over the hyperlink.| +||[textToDisplay](/.rangehyperlink#excel-javascript/api/excel/-rangehyperlink-texttodisplay-member)|Represents the string that is displayed in the top left most cell in the range.| +|[Style](/.style)|[borders](/.style#excel-javascript/api/excel/-style-borders-member)|A collection of four border objects that represent the style of the four borders.| +||[builtIn](/.style#excel-javascript/api/excel/-style-builtin-member)|Specifies if the style is a built-in style.| +||[delete()](/.style#excel-javascript/api/excel/-style-delete-member(1))|Deletes this style.| +||[fill](/.style#excel-javascript/api/excel/-style-fill-member)|The fill of the style.| +||[font](/.style#excel-javascript/api/excel/-style-font-member)|A `Font` object that represents the font of the style.| +||[formulaHidden](/.style#excel-javascript/api/excel/-style-formulahidden-member)|Specifies if the formula will be hidden when the worksheet is protected.| +||[horizontalAlignment](/.style#excel-javascript/api/excel/-style-horizontalalignment-member)|Represents the horizontal alignment for the style.| +||[includeAlignment](/.style#excel-javascript/api/excel/-style-includealignment-member)|Specifies if the style includes the auto indent, horizontal alignment, vertical alignment, wrap text, indent level, and text orientation properties.| +||[includeBorder](/.style#excel-javascript/api/excel/-style-includeborder-member)|Specifies if the style includes the color, color index, line style, and weight border properties.| +||[includeFont](/.style#excel-javascript/api/excel/-style-includefont-member)|Specifies if the style includes the background, bold, color, color index, font style, italic, name, size, strikethrough, subscript, superscript, and underline font properties.| +||[includeNumber](/.style#excel-javascript/api/excel/-style-includenumber-member)|Specifies if the style includes the number format property.| +||[includePatterns](/.style#excel-javascript/api/excel/-style-includepatterns-member)|Specifies if the style includes the color, color index, invert if negative, pattern, pattern color, and pattern color index interior properties.| +||[includeProtection](/.style#excel-javascript/api/excel/-style-includeprotection-member)|Specifies if the style includes the formula hidden and locked protection properties.| +||[indentLevel](/.style#excel-javascript/api/excel/-style-indentlevel-member)|An integer from 0 to 250 that indicates the indent level for the style.| +||[locked](/.style#excel-javascript/api/excel/-style-locked-member)|Specifies if the object is locked when the worksheet is protected.| +||[name](/.style#excel-javascript/api/excel/-style-name-member)|The name of the style.| +||[numberFormat](/.style#excel-javascript/api/excel/-style-numberformat-member)|The format code of the number format for the style.| +||[numberFormatLocal](/.style#excel-javascript/api/excel/-style-numberformatlocal-member)|The localized format code of the number format for the style.| +||[readingOrder](/.style#excel-javascript/api/excel/-style-readingorder-member)|The reading order for the style.| +||[shrinkToFit](/.style#excel-javascript/api/excel/-style-shrinktofit-member)|Specifies if text automatically shrinks to fit in the available column width.| +||[verticalAlignment](/.style#excel-javascript/api/excel/-style-verticalalignment-member)|Specifies the vertical alignment for the style.| +||[wrapText](/.style#excel-javascript/api/excel/-style-wraptext-member)|Specifies if Excel wraps the text in the object.| +|[StyleCollection](/.stylecollection)|[add(name: string)](/.stylecollection#excel-javascript/api/excel/-stylecollection-add-member(1))|Adds a new style to the collection.| +||[getItem(name: string)](/.stylecollection#excel-javascript/api/excel/-stylecollection-getitem-member(1))|Gets a `Style` by name.| +||[items](/.stylecollection#excel-javascript/api/excel/-stylecollection-items-member)|Gets the loaded child items in this collection.| +|[Table](/.table)|[onChanged](/.table#excel-javascript/api/excel/-table-onchanged-member)|Occurs when data in cells changes on a specific table.| +||[onSelectionChanged](/.table#excel-javascript/api/excel/-table-onselectionchanged-member)|Occurs when the selection changes on a specific table.| +|[TableChangedEventArgs](/.tablechangedeventargs)|[address](/.tablechangedeventargs#excel-javascript/api/excel/-tablechangedeventargs-address-member)|Gets the address that represents the changed area of a table on a specific worksheet.| +||[changeType](/.tablechangedeventargs#excel-javascript/api/excel/-tablechangedeventargs-changetype-member)|Gets the change type that represents how the changed event is triggered.| +||[source](/.tablechangedeventargs#excel-javascript/api/excel/-tablechangedeventargs-source-member)|Gets the source of the event.| +||[tableId](/.tablechangedeventargs#excel-javascript/api/excel/-tablechangedeventargs-tableid-member)|Gets the ID of the table in which the data changed.| +||[type](/.tablechangedeventargs#excel-javascript/api/excel/-tablechangedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/.tablechangedeventargs#excel-javascript/api/excel/-tablechangedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the data changed.| +|[TableCollection](/.tablecollection)|[onChanged](/.tablecollection#excel-javascript/api/excel/-tablecollection-onchanged-member)|Occurs when data changes on any table in a workbook, or a worksheet.| +|[TableSelectionChangedEventArgs](/.tableselectionchangedeventargs)|[address](/.tableselectionchangedeventargs#excel-javascript/api/excel/-tableselectionchangedeventargs-address-member)|Gets the range address that represents the selected area of the table on a specific worksheet.| +||[isInsideTable](/.tableselectionchangedeventargs#excel-javascript/api/excel/-tableselectionchangedeventargs-isinsidetable-member)|Specifies if the selection is inside a table.| +||[tableId](/.tableselectionchangedeventargs#excel-javascript/api/excel/-tableselectionchangedeventargs-tableid-member)|Gets the ID of the table in which the selection changed.| +||[type](/.tableselectionchangedeventargs#excel-javascript/api/excel/-tableselectionchangedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/.tableselectionchangedeventargs#excel-javascript/api/excel/-tableselectionchangedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the selection changed.| +|[Workbook](/.workbook)|[dataConnections](/.workbook#excel-javascript/api/excel/-workbook-dataconnections-member)|Represents all data connections in the workbook.| +||[getActiveCell()](/.workbook#excel-javascript/api/excel/-workbook-getactivecell-member(1))|Gets the currently active cell from the workbook.| +||[name](/.workbook#excel-javascript/api/excel/-workbook-name-member)|Gets the workbook name.| +||[properties](/.workbook#excel-javascript/api/excel/-workbook-properties-member)|Gets the workbook properties.| +||[protection](/.workbook#excel-javascript/api/excel/-workbook-protection-member)|Returns the protection object for a workbook.| +||[styles](/.workbook#excel-javascript/api/excel/-workbook-styles-member)|Represents a collection of styles associated with the workbook.| +|[WorkbookProtection](/.workbookprotection)|[protect(password?: string)](/.workbookprotection#excel-javascript/api/excel/-workbookprotection-protect-member(1))|Protects the workbook.| +||[protected](/.workbookprotection#excel-javascript/api/excel/-workbookprotection-protected-member)|Specifies if the workbook is protected.| +||[unprotect(password?: string)](/.workbookprotection#excel-javascript/api/excel/-workbookprotection-unprotect-member(1))|Unprotects the workbook.| +|[Worksheet](/.worksheet)|[copy(positionType?: Excel.WorksheetPositionType, relativeTo?: Excel.Worksheet)](/.worksheet#excel-javascript/api/excel/-worksheet-copy-member(1))|Copies a worksheet and places it at the specified position.| +||[freezePanes](/.worksheet#excel-javascript/api/excel/-worksheet-freezepanes-member)|Gets an object that can be used to manipulate frozen panes on the worksheet.| +||[getRangeByIndexes(startRow: number, startColumn: number, rowCount: number, columnCount: number)](/.worksheet#excel-javascript/api/excel/-worksheet-getrangebyindexes-member(1))|Gets the `Range` object beginning at a particular row index and column index, and spanning a certain number of rows and columns.| +||[onActivated](/.worksheet#excel-javascript/api/excel/-worksheet-onactivated-member)|Occurs when the worksheet is activated.| +||[onChanged](/.worksheet#excel-javascript/api/excel/-worksheet-onchanged-member)|Occurs when data changes in a specific worksheet.| +||[onDeactivated](/.worksheet#excel-javascript/api/excel/-worksheet-ondeactivated-member)|Occurs when the worksheet is deactivated.| +||[onSelectionChanged](/.worksheet#excel-javascript/api/excel/-worksheet-onselectionchanged-member)|Occurs when the selection changes on a specific worksheet.| +||[standardHeight](/.worksheet#excel-javascript/api/excel/-worksheet-standardheight-member)|Returns the standard (default) height of all the rows in the worksheet, in points.| +||[standardWidth](/.worksheet#excel-javascript/api/excel/-worksheet-standardwidth-member)|Specifies the standard (default) width of all the columns in the worksheet.| +||[tabColor](/.worksheet#excel-javascript/api/excel/-worksheet-tabcolor-member)|The tab color of the worksheet.| +|[WorksheetActivatedEventArgs](/.worksheetactivatedeventargs)|[type](/.worksheetactivatedeventargs#excel-javascript/api/excel/-worksheetactivatedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/.worksheetactivatedeventargs#excel-javascript/api/excel/-worksheetactivatedeventargs-worksheetid-member)|Gets the ID of the worksheet that is activated.| +|[WorksheetAddedEventArgs](/.worksheetaddedeventargs)|[source](/.worksheetaddedeventargs#excel-javascript/api/excel/-worksheetaddedeventargs-source-member)|Gets the source of the event.| +||[type](/.worksheetaddedeventargs#excel-javascript/api/excel/-worksheetaddedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/.worksheetaddedeventargs#excel-javascript/api/excel/-worksheetaddedeventargs-worksheetid-member)|Gets the ID of the worksheet that is added to the workbook.| +|[WorksheetChangedEventArgs](/.worksheetchangedeventargs)|[address](/.worksheetchangedeventargs#excel-javascript/api/excel/-worksheetchangedeventargs-address-member)|Gets the range address that represents the changed area of a specific worksheet.| +||[changeType](/.worksheetchangedeventargs#excel-javascript/api/excel/-worksheetchangedeventargs-changetype-member)|Gets the change type that represents how the changed event is triggered.| +||[source](/.worksheetchangedeventargs#excel-javascript/api/excel/-worksheetchangedeventargs-source-member)|Gets the source of the event.| +||[type](/.worksheetchangedeventargs#excel-javascript/api/excel/-worksheetchangedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/.worksheetchangedeventargs#excel-javascript/api/excel/-worksheetchangedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the data changed.| +|[WorksheetCollection](/.worksheetcollection)|[onActivated](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-onactivated-member)|Occurs when any worksheet in the workbook is activated.| +||[onAdded](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-onadded-member)|Occurs when a new worksheet is added to the workbook.| +||[onDeactivated](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-ondeactivated-member)|Occurs when any worksheet in the workbook is deactivated.| +||[onDeleted](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-ondeleted-member)|Occurs when a worksheet is deleted from the workbook.| +|[WorksheetDeactivatedEventArgs](/.worksheetdeactivatedeventargs)|[type](/.worksheetdeactivatedeventargs#excel-javascript/api/excel/-worksheetdeactivatedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/.worksheetdeactivatedeventargs#excel-javascript/api/excel/-worksheetdeactivatedeventargs-worksheetid-member)|Gets the ID of the worksheet that is deactivated.| +|[WorksheetDeletedEventArgs](/.worksheetdeletedeventargs)|[source](/.worksheetdeletedeventargs#excel-javascript/api/excel/-worksheetdeletedeventargs-source-member)|Gets the source of the event.| +||[type](/.worksheetdeletedeventargs#excel-javascript/api/excel/-worksheetdeletedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/.worksheetdeletedeventargs#excel-javascript/api/excel/-worksheetdeletedeventargs-worksheetid-member)|Gets the ID of the worksheet that is deleted from the workbook.| +|[WorksheetFreezePanes](/.worksheetfreezepanes)|[freezeAt(frozenRange: Range \| string)](/.worksheetfreezepanes#excel-javascript/api/excel/-worksheetfreezepanes-freezeat-member(1))|Sets the frozen cells in the active worksheet view.| +||[freezeColumns(count?: number)](/.worksheetfreezepanes#excel-javascript/api/excel/-worksheetfreezepanes-freezecolumns-member(1))|Freeze the first column or columns of the worksheet in place.| +||[freezeRows(count?: number)](/.worksheetfreezepanes#excel-javascript/api/excel/-worksheetfreezepanes-freezerows-member(1))|Freeze the top row or rows of the worksheet in place.| +||[getLocation()](/.worksheetfreezepanes#excel-javascript/api/excel/-worksheetfreezepanes-getlocation-member(1))|Gets a range that describes the frozen cells in the active worksheet view.| +||[getLocationOrNullObject()](/.worksheetfreezepanes#excel-javascript/api/excel/-worksheetfreezepanes-getlocationornullobject-member(1))|Gets a range that describes the frozen cells in the active worksheet view.| +||[unfreeze()](/.worksheetfreezepanes#excel-javascript/api/excel/-worksheetfreezepanes-unfreeze-member(1))|Removes all frozen panes in the worksheet.| +|[WorksheetProtection](/.worksheetprotection)|[unprotect(password?: string)](/.worksheetprotection#excel-javascript/api/excel/-worksheetprotection-unprotect-member(1))|Unprotects a worksheet.| +|[WorksheetProtectionOptions](/.worksheetprotectionoptions)|[allowEditObjects](/.worksheetprotectionoptions#excel-javascript/api/excel/-worksheetprotectionoptions-alloweditobjects-member)|Represents the worksheet protection option allowing editing of objects.| +||[allowEditScenarios](/.worksheetprotectionoptions#excel-javascript/api/excel/-worksheetprotectionoptions-alloweditscenarios-member)|Represents the worksheet protection option allowing editing of scenarios.| +||[selectionMode](/.worksheetprotectionoptions#excel-javascript/api/excel/-worksheetprotectionoptions-selectionmode-member)|Represents the worksheet protection option of selection mode.| +|[WorksheetSelectionChangedEventArgs](/.worksheetselectionchangedeventargs)|[address](/.worksheetselectionchangedeventargs#excel-javascript/api/excel/-worksheetselectionchangedeventargs-address-member)|Gets the range address that represents the selected area of a specific worksheet.| +||[type](/.worksheetselectionchangedeventargs#excel-javascript/api/excel/-worksheetselectionchangedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/.worksheetselectionchangedeventargs#excel-javascript/api/excel/-worksheetselectionchangedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the selection changed.| diff --git a/docs/includes/excel-1_8.md b/docs/includes/excel-1_8.md index 8f70ea18d6..39fe3a3fd9 100644 --- a/docs/includes/excel-1_8.md +++ b/docs/includes/excel-1_8.md @@ -1,251 +1,251 @@ | Class | Fields | Description | |:---|:---|:---| -|*global*|[createWorkbook(base64?: string)](/javascript/api/excel/#excel-excel-createworkbook-function(1))|Creates and opens a new workbook.| -|[BasicDataValidation](/javascript/api/excel/excel.basicdatavalidation)|[formula1](/javascript/api/excel/excel.basicdatavalidation#excel-excel-basicdatavalidation-formula1-member)|Specifies the right-hand operand when the operator property is set to a binary operator such as GreaterThan (the left-hand operand is the value the user tries to enter in the cell).| -||[formula2](/javascript/api/excel/excel.basicdatavalidation#excel-excel-basicdatavalidation-formula2-member)|With the ternary operators Between and NotBetween, specifies the upper bound operand.| -||[operator](/javascript/api/excel/excel.basicdatavalidation#excel-excel-basicdatavalidation-operator-member)|The operator to use for validating the data.| -|[Chart](/javascript/api/excel/excel.chart)|[categoryLabelLevel](/javascript/api/excel/excel.chart#excel-excel-chart-categorylabellevel-member)|Specifies a chart category label level enumeration constant, referring to the level of the source category labels.| -||[displayBlanksAs](/javascript/api/excel/excel.chart#excel-excel-chart-displayblanksas-member)|Specifies the way that blank cells are plotted on a chart.| -||[onActivated](/javascript/api/excel/excel.chart#excel-excel-chart-onactivated-member)|Occurs when the chart is activated.| -||[onDeactivated](/javascript/api/excel/excel.chart#excel-excel-chart-ondeactivated-member)|Occurs when the chart is deactivated.| -||[plotArea](/javascript/api/excel/excel.chart#excel-excel-chart-plotarea-member)|Represents the plot area for the chart.| -||[plotBy](/javascript/api/excel/excel.chart#excel-excel-chart-plotby-member)|Specifies the way columns or rows are used as data series on the chart.| -||[plotVisibleOnly](/javascript/api/excel/excel.chart#excel-excel-chart-plotvisibleonly-member)|True if only visible cells are plotted.| -||[seriesNameLevel](/javascript/api/excel/excel.chart#excel-excel-chart-seriesnamelevel-member)|Specifies a chart series name level enumeration constant, referring to the level of the source series names.| -||[showDataLabelsOverMaximum](/javascript/api/excel/excel.chart#excel-excel-chart-showdatalabelsovermaximum-member)|Specifies whether to show the data labels when the value is greater than the maximum value on the value axis.| -||[style](/javascript/api/excel/excel.chart#excel-excel-chart-style-member)|Specifies the chart style for the chart.| -|[ChartActivatedEventArgs](/javascript/api/excel/excel.chartactivatedeventargs)|[chartId](/javascript/api/excel/excel.chartactivatedeventargs#excel-excel-chartactivatedeventargs-chartid-member)|Gets the ID of the chart that is activated.| -||[type](/javascript/api/excel/excel.chartactivatedeventargs#excel-excel-chartactivatedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/javascript/api/excel/excel.chartactivatedeventargs#excel-excel-chartactivatedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the chart is activated.| -|[ChartAddedEventArgs](/javascript/api/excel/excel.chartaddedeventargs)|[chartId](/javascript/api/excel/excel.chartaddedeventargs#excel-excel-chartaddedeventargs-chartid-member)|Gets the ID of the chart that is added to the worksheet.| -||[source](/javascript/api/excel/excel.chartaddedeventargs#excel-excel-chartaddedeventargs-source-member)|Gets the source of the event.| -||[type](/javascript/api/excel/excel.chartaddedeventargs#excel-excel-chartaddedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/javascript/api/excel/excel.chartaddedeventargs#excel-excel-chartaddedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the chart is added.| -|[ChartAxis](/javascript/api/excel/excel.chartaxis)|[alignment](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-alignment-member)|Specifies the alignment for the specified axis tick label.| -||[isBetweenCategories](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-isbetweencategories-member)|Specifies if the value axis crosses the category axis between categories.| -||[multiLevel](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-multilevel-member)|Specifies if an axis is multilevel.| -||[numberFormat](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-numberformat-member)|Specifies the format code for the axis tick label.| -||[offset](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-offset-member)|Specifies the distance between the levels of labels, and the distance between the first level and the axis line.| -||[position](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-position-member)|Specifies the specified axis position where the other axis crosses.| -||[positionAt](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-positionat-member)|Specifies the axis position where the other axis crosses.| -||[setPositionAt(value: number)](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-setpositionat-member(1))|Sets the specified axis position where the other axis crosses.| -||[textOrientation](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-textorientation-member)|Specifies the angle to which the text is oriented for the chart axis tick label.| -|[ChartAxisFormat](/javascript/api/excel/excel.chartaxisformat)|[fill](/javascript/api/excel/excel.chartaxisformat#excel-excel-chartaxisformat-fill-member)|Specifies chart fill formatting.| -|[ChartAxisTitle](/javascript/api/excel/excel.chartaxistitle)|[setFormula(formula: string)](/javascript/api/excel/excel.chartaxistitle#excel-excel-chartaxistitle-setformula-member(1))|A string value that represents the formula of chart axis title using A1-style notation.| -|[ChartAxisTitleFormat](/javascript/api/excel/excel.chartaxistitleformat)|[border](/javascript/api/excel/excel.chartaxistitleformat#excel-excel-chartaxistitleformat-border-member)|Specifies the chart axis title's border format, which includes color, linestyle, and weight.| -||[fill](/javascript/api/excel/excel.chartaxistitleformat#excel-excel-chartaxistitleformat-fill-member)|Specifies the chart axis title's fill formatting.| -|[ChartBorder](/javascript/api/excel/excel.chartborder)|[clear()](/javascript/api/excel/excel.chartborder#excel-excel-chartborder-clear-member(1))|Clear the border format of a chart element.| -|[ChartCollection](/javascript/api/excel/excel.chartcollection)|[onActivated](/javascript/api/excel/excel.chartcollection#excel-excel-chartcollection-onactivated-member)|Occurs when a chart is activated.| -||[onAdded](/javascript/api/excel/excel.chartcollection#excel-excel-chartcollection-onadded-member)|Occurs when a new chart is added to the worksheet.| -||[onDeactivated](/javascript/api/excel/excel.chartcollection#excel-excel-chartcollection-ondeactivated-member)|Occurs when a chart is deactivated.| -||[onDeleted](/javascript/api/excel/excel.chartcollection#excel-excel-chartcollection-ondeleted-member)|Occurs when a chart is deleted.| -|[ChartDataLabel](/javascript/api/excel/excel.chartdatalabel)|[autoText](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-autotext-member)|Specifies if the data label automatically generates appropriate text based on context.| -||[format](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-format-member)|Represents the format of chart data label.| -||[formula](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-formula-member)|String value that represents the formula of chart data label using A1-style notation.| -||[height](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-height-member)|Returns the height, in points, of the chart data label.| -||[horizontalAlignment](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-horizontalalignment-member)|Represents the horizontal alignment for chart data label.| -||[left](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-left-member)|Represents the distance, in points, from the left edge of chart data label to the left edge of chart area.| -||[numberFormat](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-numberformat-member)|Specifies the format code for data label.| -||[text](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-text-member)|String representing the text of the data label on a chart.| -||[textOrientation](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-textorientation-member)|Represents the angle to which the text is oriented for the chart data label.| -||[top](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-top-member)|Represents the distance, in points, from the top edge of chart data label to the top of chart area.| -||[verticalAlignment](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-verticalalignment-member)|Represents the vertical alignment of chart data label.| -||[width](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-width-member)|Returns the width, in points, of the chart data label.| -|[ChartDataLabelFormat](/javascript/api/excel/excel.chartdatalabelformat)|[border](/javascript/api/excel/excel.chartdatalabelformat#excel-excel-chartdatalabelformat-border-member)|Represents the border format, which includes color, linestyle, and weight.| -|[ChartDataLabels](/javascript/api/excel/excel.chartdatalabels)|[autoText](/javascript/api/excel/excel.chartdatalabels#excel-excel-chartdatalabels-autotext-member)|Specifies if data labels automatically generate appropriate text based on context.| -||[horizontalAlignment](/javascript/api/excel/excel.chartdatalabels#excel-excel-chartdatalabels-horizontalalignment-member)|Specifies the horizontal alignment for chart data label.| -||[numberFormat](/javascript/api/excel/excel.chartdatalabels#excel-excel-chartdatalabels-numberformat-member)|Specifies the format code for data labels.| -||[textOrientation](/javascript/api/excel/excel.chartdatalabels#excel-excel-chartdatalabels-textorientation-member)|Represents the angle to which the text is oriented for data labels.| -||[verticalAlignment](/javascript/api/excel/excel.chartdatalabels#excel-excel-chartdatalabels-verticalalignment-member)|Represents the vertical alignment of chart data label.| -|[ChartDeactivatedEventArgs](/javascript/api/excel/excel.chartdeactivatedeventargs)|[chartId](/javascript/api/excel/excel.chartdeactivatedeventargs#excel-excel-chartdeactivatedeventargs-chartid-member)|Gets the ID of the chart that is deactivated.| -||[type](/javascript/api/excel/excel.chartdeactivatedeventargs#excel-excel-chartdeactivatedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/javascript/api/excel/excel.chartdeactivatedeventargs#excel-excel-chartdeactivatedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the chart is deactivated.| -|[ChartDeletedEventArgs](/javascript/api/excel/excel.chartdeletedeventargs)|[chartId](/javascript/api/excel/excel.chartdeletedeventargs#excel-excel-chartdeletedeventargs-chartid-member)|Gets the ID of the chart that is deleted from the worksheet.| -||[source](/javascript/api/excel/excel.chartdeletedeventargs#excel-excel-chartdeletedeventargs-source-member)|Gets the source of the event.| -||[type](/javascript/api/excel/excel.chartdeletedeventargs#excel-excel-chartdeletedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/javascript/api/excel/excel.chartdeletedeventargs#excel-excel-chartdeletedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the chart is deleted.| -|[ChartLegendEntry](/javascript/api/excel/excel.chartlegendentry)|[height](/javascript/api/excel/excel.chartlegendentry#excel-excel-chartlegendentry-height-member)|Specifies the height of the legend entry on the chart legend.| -||[index](/javascript/api/excel/excel.chartlegendentry#excel-excel-chartlegendentry-index-member)|Specifies the index of the legend entry in the chart legend.| -||[left](/javascript/api/excel/excel.chartlegendentry#excel-excel-chartlegendentry-left-member)|Specifies the left value of a chart legend entry.| -||[top](/javascript/api/excel/excel.chartlegendentry#excel-excel-chartlegendentry-top-member)|Specifies the top of a chart legend entry.| -||[width](/javascript/api/excel/excel.chartlegendentry#excel-excel-chartlegendentry-width-member)|Represents the width of the legend entry on the chart Legend.| -|[ChartLegendFormat](/javascript/api/excel/excel.chartlegendformat)|[border](/javascript/api/excel/excel.chartlegendformat#excel-excel-chartlegendformat-border-member)|Represents the border format, which includes color, linestyle, and weight.| -|[ChartPlotArea](/javascript/api/excel/excel.chartplotarea)|[format](/javascript/api/excel/excel.chartplotarea#excel-excel-chartplotarea-format-member)|Specifies the formatting of a chart plot area.| -||[height](/javascript/api/excel/excel.chartplotarea#excel-excel-chartplotarea-height-member)|Specifies the height value of a plot area.| -||[insideHeight](/javascript/api/excel/excel.chartplotarea#excel-excel-chartplotarea-insideheight-member)|Specifies the inside height value of a plot area.| -||[insideLeft](/javascript/api/excel/excel.chartplotarea#excel-excel-chartplotarea-insideleft-member)|Specifies the inside left value of a plot area.| -||[insideTop](/javascript/api/excel/excel.chartplotarea#excel-excel-chartplotarea-insidetop-member)|Specifies the inside top value of a plot area.| -||[insideWidth](/javascript/api/excel/excel.chartplotarea#excel-excel-chartplotarea-insidewidth-member)|Specifies the inside width value of a plot area.| -||[left](/javascript/api/excel/excel.chartplotarea#excel-excel-chartplotarea-left-member)|Specifies the left value of a plot area.| -||[position](/javascript/api/excel/excel.chartplotarea#excel-excel-chartplotarea-position-member)|Specifies the position of a plot area.| -||[top](/javascript/api/excel/excel.chartplotarea#excel-excel-chartplotarea-top-member)|Specifies the top value of a plot area.| -||[width](/javascript/api/excel/excel.chartplotarea#excel-excel-chartplotarea-width-member)|Specifies the width value of a plot area.| -|[ChartPlotAreaFormat](/javascript/api/excel/excel.chartplotareaformat)|[border](/javascript/api/excel/excel.chartplotareaformat#excel-excel-chartplotareaformat-border-member)|Specifies the border attributes of a chart plot area.| -||[fill](/javascript/api/excel/excel.chartplotareaformat#excel-excel-chartplotareaformat-fill-member)|Specifies the fill format of an object, which includes background formatting information.| -|[ChartSeries](/javascript/api/excel/excel.chartseries)|[axisGroup](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-axisgroup-member)|Specifies the group for the specified series.| -||[dataLabels](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-datalabels-member)|Represents a collection of all data labels in the series.| -||[explosion](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-explosion-member)|Specifies the explosion value for a pie-chart or doughnut-chart slice.| -||[firstSliceAngle](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-firstsliceangle-member)|Specifies the angle of the first pie-chart or doughnut-chart slice, in degrees (clockwise from vertical).| -||[invertIfNegative](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-invertifnegative-member)|True if Excel inverts the pattern in the item when it corresponds to a negative number.| -||[overlap](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-overlap-member)|Specifies how bars and columns are positioned.| -||[secondPlotSize](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-secondplotsize-member)|Specifies the size of the secondary section of either a pie-of-pie chart or a bar-of-pie chart, as a percentage of the size of the primary pie.| -||[splitType](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-splittype-member)|Specifies the way the two sections of either a pie-of-pie chart or a bar-of-pie chart are split.| -||[varyByCategories](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-varybycategories-member)|True if Excel assigns a different color or pattern to each data marker.| -|[ChartTrendline](/javascript/api/excel/excel.charttrendline)|[backwardPeriod](/javascript/api/excel/excel.charttrendline#excel-excel-charttrendline-backwardperiod-member)|Represents the number of periods that the trendline extends backward.| -||[forwardPeriod](/javascript/api/excel/excel.charttrendline#excel-excel-charttrendline-forwardperiod-member)|Represents the number of periods that the trendline extends forward.| -||[label](/javascript/api/excel/excel.charttrendline#excel-excel-charttrendline-label-member)|Represents the label of a chart trendline.| -||[showEquation](/javascript/api/excel/excel.charttrendline#excel-excel-charttrendline-showequation-member)|True if the equation for the trendline is displayed on the chart.| -||[showRSquared](/javascript/api/excel/excel.charttrendline#excel-excel-charttrendline-showrsquared-member)|True if the r-squared value for the trendline is displayed on the chart.| -|[ChartTrendlineLabel](/javascript/api/excel/excel.charttrendlinelabel)|[autoText](/javascript/api/excel/excel.charttrendlinelabel#excel-excel-charttrendlinelabel-autotext-member)|Specifies if the trendline label automatically generates appropriate text based on context.| -||[format](/javascript/api/excel/excel.charttrendlinelabel#excel-excel-charttrendlinelabel-format-member)|The format of the chart trendline label.| -||[formula](/javascript/api/excel/excel.charttrendlinelabel#excel-excel-charttrendlinelabel-formula-member)|String value that represents the formula of the chart trendline label using A1-style notation.| -||[height](/javascript/api/excel/excel.charttrendlinelabel#excel-excel-charttrendlinelabel-height-member)|Returns the height, in points, of the chart trendline label.| -||[horizontalAlignment](/javascript/api/excel/excel.charttrendlinelabel#excel-excel-charttrendlinelabel-horizontalalignment-member)|Represents the horizontal alignment of the chart trendline label.| -||[left](/javascript/api/excel/excel.charttrendlinelabel#excel-excel-charttrendlinelabel-left-member)|Represents the distance, in points, from the left edge of the chart trendline label to the left edge of the chart area.| -||[numberFormat](/javascript/api/excel/excel.charttrendlinelabel#excel-excel-charttrendlinelabel-numberformat-member)|String value that represents the format code for the trendline label.| -||[text](/javascript/api/excel/excel.charttrendlinelabel#excel-excel-charttrendlinelabel-text-member)|String representing the text of the trendline label on a chart.| -||[textOrientation](/javascript/api/excel/excel.charttrendlinelabel#excel-excel-charttrendlinelabel-textorientation-member)|Represents the angle to which the text is oriented for the chart trendline label.| -||[top](/javascript/api/excel/excel.charttrendlinelabel#excel-excel-charttrendlinelabel-top-member)|Represents the distance, in points, from the top edge of the chart trendline label to the top of the chart area.| -||[verticalAlignment](/javascript/api/excel/excel.charttrendlinelabel#excel-excel-charttrendlinelabel-verticalalignment-member)|Represents the vertical alignment of the chart trendline label.| -||[width](/javascript/api/excel/excel.charttrendlinelabel#excel-excel-charttrendlinelabel-width-member)|Returns the width, in points, of the chart trendline label.| -|[ChartTrendlineLabelFormat](/javascript/api/excel/excel.charttrendlinelabelformat)|[border](/javascript/api/excel/excel.charttrendlinelabelformat#excel-excel-charttrendlinelabelformat-border-member)|Specifies the border format, which includes color, linestyle, and weight.| -||[fill](/javascript/api/excel/excel.charttrendlinelabelformat#excel-excel-charttrendlinelabelformat-fill-member)|Specifies the fill format of the current chart trendline label.| -||[font](/javascript/api/excel/excel.charttrendlinelabelformat#excel-excel-charttrendlinelabelformat-font-member)|Specifies the font attributes (such as font name, font size, and color) for a chart trendline label.| -|[CustomDataValidation](/javascript/api/excel/excel.customdatavalidation)|[formula](/javascript/api/excel/excel.customdatavalidation#excel-excel-customdatavalidation-formula-member)|A custom data validation formula.| -|[DataPivotHierarchy](/javascript/api/excel/excel.datapivothierarchy)|[field](/javascript/api/excel/excel.datapivothierarchy#excel-excel-datapivothierarchy-field-member)|Returns the PivotFields associated with the DataPivotHierarchy.| -||[id](/javascript/api/excel/excel.datapivothierarchy#excel-excel-datapivothierarchy-id-member)|ID of the DataPivotHierarchy.| -||[name](/javascript/api/excel/excel.datapivothierarchy#excel-excel-datapivothierarchy-name-member)|Name of the DataPivotHierarchy.| -||[numberFormat](/javascript/api/excel/excel.datapivothierarchy#excel-excel-datapivothierarchy-numberformat-member)|Number format of the DataPivotHierarchy.| -||[position](/javascript/api/excel/excel.datapivothierarchy#excel-excel-datapivothierarchy-position-member)|Position of the DataPivotHierarchy.| -||[setToDefault()](/javascript/api/excel/excel.datapivothierarchy#excel-excel-datapivothierarchy-settodefault-member(1))|Reset the DataPivotHierarchy back to its default values.| -||[showAs](/javascript/api/excel/excel.datapivothierarchy#excel-excel-datapivothierarchy-showas-member)|Specifies if the data should be shown as a specific summary calculation.| -||[summarizeBy](/javascript/api/excel/excel.datapivothierarchy#excel-excel-datapivothierarchy-summarizeby-member)|Specifies if all items of the DataPivotHierarchy are shown.| -|[DataPivotHierarchyCollection](/javascript/api/excel/excel.datapivothierarchycollection)|[add(pivotHierarchy: Excel.PivotHierarchy)](/javascript/api/excel/excel.datapivothierarchycollection#excel-excel-datapivothierarchycollection-add-member(1))|Adds the PivotHierarchy to the current axis.| -||[getCount()](/javascript/api/excel/excel.datapivothierarchycollection#excel-excel-datapivothierarchycollection-getcount-member(1))|Gets the number of pivot hierarchies in the collection.| -||[getItem(name: string)](/javascript/api/excel/excel.datapivothierarchycollection#excel-excel-datapivothierarchycollection-getitem-member(1))|Gets a DataPivotHierarchy by its name or ID.| -||[getItemOrNullObject(name: string)](/javascript/api/excel/excel.datapivothierarchycollection#excel-excel-datapivothierarchycollection-getitemornullobject-member(1))|Gets a DataPivotHierarchy by name.| -||[items](/javascript/api/excel/excel.datapivothierarchycollection#excel-excel-datapivothierarchycollection-items-member)|Gets the loaded child items in this collection.| -||[remove(DataPivotHierarchy: Excel.DataPivotHierarchy)](/javascript/api/excel/excel.datapivothierarchycollection#excel-excel-datapivothierarchycollection-remove-member(1))|Removes the PivotHierarchy from the current axis.| -|[DataValidation](/javascript/api/excel/excel.datavalidation)|[clear()](/javascript/api/excel/excel.datavalidation#excel-excel-datavalidation-clear-member(1))|Clears the data validation from the current range.| -||[errorAlert](/javascript/api/excel/excel.datavalidation#excel-excel-datavalidation-erroralert-member)|Error alert when user enters invalid data.| -||[ignoreBlanks](/javascript/api/excel/excel.datavalidation#excel-excel-datavalidation-ignoreblanks-member)|Specifies if data validation will be performed on blank cells.| -||[prompt](/javascript/api/excel/excel.datavalidation#excel-excel-datavalidation-prompt-member)|Prompt when users select a cell.| -||[rule](/javascript/api/excel/excel.datavalidation#excel-excel-datavalidation-rule-member)|Data validation rule that contains different type of data validation criteria.| -||[type](/javascript/api/excel/excel.datavalidation#excel-excel-datavalidation-type-member)|Type of the data validation, see `Excel.DataValidationType` for details.| -||[valid](/javascript/api/excel/excel.datavalidation#excel-excel-datavalidation-valid-member)|Represents if all cell values are valid according to the data validation rules.| -|[DataValidationErrorAlert](/javascript/api/excel/excel.datavalidationerroralert)|[message](/javascript/api/excel/excel.datavalidationerroralert#excel-excel-datavalidationerroralert-message-member)|Represents the error alert message.| -||[showAlert](/javascript/api/excel/excel.datavalidationerroralert#excel-excel-datavalidationerroralert-showalert-member)|Specifies whether to show an error alert dialog when a user enters invalid data.| -||[style](/javascript/api/excel/excel.datavalidationerroralert#excel-excel-datavalidationerroralert-style-member)|The data validation alert type, please see `Excel.DataValidationAlertStyle` for details.| -||[title](/javascript/api/excel/excel.datavalidationerroralert#excel-excel-datavalidationerroralert-title-member)|Represents the error alert dialog title.| -|[DataValidationPrompt](/javascript/api/excel/excel.datavalidationprompt)|[message](/javascript/api/excel/excel.datavalidationprompt#excel-excel-datavalidationprompt-message-member)|Specifies the message of the prompt.| -||[showPrompt](/javascript/api/excel/excel.datavalidationprompt#excel-excel-datavalidationprompt-showprompt-member)|Specifies if a prompt is shown when a user selects a cell with data validation.| -||[title](/javascript/api/excel/excel.datavalidationprompt#excel-excel-datavalidationprompt-title-member)|Specifies the title for the prompt.| -|[DataValidationRule](/javascript/api/excel/excel.datavalidationrule)|[custom](/javascript/api/excel/excel.datavalidationrule#excel-excel-datavalidationrule-custom-member)|Custom data validation criteria.| -||[date](/javascript/api/excel/excel.datavalidationrule#excel-excel-datavalidationrule-date-member)|Date data validation criteria.| -||[decimal](/javascript/api/excel/excel.datavalidationrule#excel-excel-datavalidationrule-decimal-member)|Decimal data validation criteria.| -||[list](/javascript/api/excel/excel.datavalidationrule#excel-excel-datavalidationrule-list-member)|List data validation criteria.| -||[textLength](/javascript/api/excel/excel.datavalidationrule#excel-excel-datavalidationrule-textlength-member)|Text length data validation criteria.| -||[time](/javascript/api/excel/excel.datavalidationrule#excel-excel-datavalidationrule-time-member)|Time data validation criteria.| -||[wholeNumber](/javascript/api/excel/excel.datavalidationrule#excel-excel-datavalidationrule-wholenumber-member)|Whole number data validation criteria.| -|[DateTimeDataValidation](/javascript/api/excel/excel.datetimedatavalidation)|[formula1](/javascript/api/excel/excel.datetimedatavalidation#excel-excel-datetimedatavalidation-formula1-member)|Specifies the right-hand operand when the operator property is set to a binary operator such as GreaterThan (the left-hand operand is the value the user tries to enter in the cell).| -||[formula2](/javascript/api/excel/excel.datetimedatavalidation#excel-excel-datetimedatavalidation-formula2-member)|With the ternary operators Between and NotBetween, specifies the upper bound operand.| -||[operator](/javascript/api/excel/excel.datetimedatavalidation#excel-excel-datetimedatavalidation-operator-member)|The operator to use for validating the data.| -|[FilterPivotHierarchy](/javascript/api/excel/excel.filterpivothierarchy)|[enableMultipleFilterItems](/javascript/api/excel/excel.filterpivothierarchy#excel-excel-filterpivothierarchy-enablemultiplefilteritems-member)|Determines whether to allow multiple filter items.| -||[fields](/javascript/api/excel/excel.filterpivothierarchy#excel-excel-filterpivothierarchy-fields-member)|Returns the PivotFields associated with the FilterPivotHierarchy.| -||[id](/javascript/api/excel/excel.filterpivothierarchy#excel-excel-filterpivothierarchy-id-member)|ID of the FilterPivotHierarchy.| -||[name](/javascript/api/excel/excel.filterpivothierarchy#excel-excel-filterpivothierarchy-name-member)|Name of the FilterPivotHierarchy.| -||[position](/javascript/api/excel/excel.filterpivothierarchy#excel-excel-filterpivothierarchy-position-member)|Position of the FilterPivotHierarchy.| -||[setToDefault()](/javascript/api/excel/excel.filterpivothierarchy#excel-excel-filterpivothierarchy-settodefault-member(1))|Reset the FilterPivotHierarchy back to its default values.| -|[FilterPivotHierarchyCollection](/javascript/api/excel/excel.filterpivothierarchycollection)|[add(pivotHierarchy: Excel.PivotHierarchy)](/javascript/api/excel/excel.filterpivothierarchycollection#excel-excel-filterpivothierarchycollection-add-member(1))|Adds the PivotHierarchy to the current axis.| -||[getCount()](/javascript/api/excel/excel.filterpivothierarchycollection#excel-excel-filterpivothierarchycollection-getcount-member(1))|Gets the number of pivot hierarchies in the collection.| -||[getItem(name: string)](/javascript/api/excel/excel.filterpivothierarchycollection#excel-excel-filterpivothierarchycollection-getitem-member(1))|Gets a FilterPivotHierarchy by its name or ID.| -||[getItemOrNullObject(name: string)](/javascript/api/excel/excel.filterpivothierarchycollection#excel-excel-filterpivothierarchycollection-getitemornullobject-member(1))|Gets a FilterPivotHierarchy by name.| -||[items](/javascript/api/excel/excel.filterpivothierarchycollection#excel-excel-filterpivothierarchycollection-items-member)|Gets the loaded child items in this collection.| -||[remove(filterPivotHierarchy: Excel.FilterPivotHierarchy)](/javascript/api/excel/excel.filterpivothierarchycollection#excel-excel-filterpivothierarchycollection-remove-member(1))|Removes the PivotHierarchy from the current axis.| -|[ListDataValidation](/javascript/api/excel/excel.listdatavalidation)|[inCellDropDown](/javascript/api/excel/excel.listdatavalidation#excel-excel-listdatavalidation-incelldropdown-member)|Specifies whether to display the list in a cell drop-down.| -||[source](/javascript/api/excel/excel.listdatavalidation#excel-excel-listdatavalidation-source-member)|Source of the list for data validation| -|[PivotField](/javascript/api/excel/excel.pivotfield)|[id](/javascript/api/excel/excel.pivotfield#excel-excel-pivotfield-id-member)|ID of the PivotField.| -||[items](/javascript/api/excel/excel.pivotfield#excel-excel-pivotfield-items-member)|Returns the PivotItems associated with the PivotField.| -||[name](/javascript/api/excel/excel.pivotfield#excel-excel-pivotfield-name-member)|Name of the PivotField.| -||[showAllItems](/javascript/api/excel/excel.pivotfield#excel-excel-pivotfield-showallitems-member)|Determines whether to show all items of the PivotField.| -||[sortByLabels(sortBy: SortBy)](/javascript/api/excel/excel.pivotfield#excel-excel-pivotfield-sortbylabels-member(1))|Sorts the PivotField.| -||[subtotals](/javascript/api/excel/excel.pivotfield#excel-excel-pivotfield-subtotals-member)|Subtotals of the PivotField.| -|[PivotFieldCollection](/javascript/api/excel/excel.pivotfieldcollection)|[getCount()](/javascript/api/excel/excel.pivotfieldcollection#excel-excel-pivotfieldcollection-getcount-member(1))|Gets the number of pivot fields in the collection.| -||[getItem(name: string)](/javascript/api/excel/excel.pivotfieldcollection#excel-excel-pivotfieldcollection-getitem-member(1))|Gets a PivotField by its name or ID.| -||[getItemOrNullObject(name: string)](/javascript/api/excel/excel.pivotfieldcollection#excel-excel-pivotfieldcollection-getitemornullobject-member(1))|Gets a PivotField by name.| -||[items](/javascript/api/excel/excel.pivotfieldcollection#excel-excel-pivotfieldcollection-items-member)|Gets the loaded child items in this collection.| -|[PivotHierarchy](/javascript/api/excel/excel.pivothierarchy)|[fields](/javascript/api/excel/excel.pivothierarchy#excel-excel-pivothierarchy-fields-member)|Returns the PivotFields associated with the PivotHierarchy.| -||[id](/javascript/api/excel/excel.pivothierarchy#excel-excel-pivothierarchy-id-member)|ID of the PivotHierarchy.| -||[name](/javascript/api/excel/excel.pivothierarchy#excel-excel-pivothierarchy-name-member)|Name of the PivotHierarchy.| -|[PivotHierarchyCollection](/javascript/api/excel/excel.pivothierarchycollection)|[getCount()](/javascript/api/excel/excel.pivothierarchycollection#excel-excel-pivothierarchycollection-getcount-member(1))|Gets the number of pivot hierarchies in the collection.| -||[getItem(name: string)](/javascript/api/excel/excel.pivothierarchycollection#excel-excel-pivothierarchycollection-getitem-member(1))|Gets a PivotHierarchy by its name or ID.| -||[getItemOrNullObject(name: string)](/javascript/api/excel/excel.pivothierarchycollection#excel-excel-pivothierarchycollection-getitemornullobject-member(1))|Gets a PivotHierarchy by name.| -||[items](/javascript/api/excel/excel.pivothierarchycollection#excel-excel-pivothierarchycollection-items-member)|Gets the loaded child items in this collection.| -|[PivotItem](/javascript/api/excel/excel.pivotitem)|[id](/javascript/api/excel/excel.pivotitem#excel-excel-pivotitem-id-member)|ID of the PivotItem.| -||[isExpanded](/javascript/api/excel/excel.pivotitem#excel-excel-pivotitem-isexpanded-member)|Determines whether the item is expanded to show child items or if it's collapsed and child items are hidden.| -||[name](/javascript/api/excel/excel.pivotitem#excel-excel-pivotitem-name-member)|Name of the PivotItem.| -||[visible](/javascript/api/excel/excel.pivotitem#excel-excel-pivotitem-visible-member)|Specifies if the PivotItem is visible.| -|[PivotItemCollection](/javascript/api/excel/excel.pivotitemcollection)|[getCount()](/javascript/api/excel/excel.pivotitemcollection#excel-excel-pivotitemcollection-getcount-member(1))|Gets the number of PivotItems in the collection.| -||[getItem(name: string)](/javascript/api/excel/excel.pivotitemcollection#excel-excel-pivotitemcollection-getitem-member(1))|Gets a PivotItem by its name or ID.| -||[getItemOrNullObject(name: string)](/javascript/api/excel/excel.pivotitemcollection#excel-excel-pivotitemcollection-getitemornullobject-member(1))|Gets a PivotItem by name.| -||[items](/javascript/api/excel/excel.pivotitemcollection#excel-excel-pivotitemcollection-items-member)|Gets the loaded child items in this collection.| -|[PivotLayout](/javascript/api/excel/excel.pivotlayout)|[getColumnLabelRange()](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-getcolumnlabelrange-member(1))|Returns the range where the PivotTable's column labels reside.| -||[getDataBodyRange()](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-getdatabodyrange-member(1))|Returns the range where the PivotTable's data values reside.| -||[getFilterAxisRange()](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-getfilteraxisrange-member(1))|Returns the range of the PivotTable's filter area.| -||[getRange()](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-getrange-member(1))|Returns the range the PivotTable exists on, excluding the filter area.| -||[getRowLabelRange()](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-getrowlabelrange-member(1))|Returns the range where the PivotTable's row labels reside.| -||[layoutType](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-layouttype-member)|This property indicates the PivotLayoutType of all fields on the PivotTable.| -||[showColumnGrandTotals](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-showcolumngrandtotals-member)|Specifies if the PivotTable report shows grand totals for columns.| -||[showRowGrandTotals](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-showrowgrandtotals-member)|Specifies if the PivotTable report shows grand totals for rows.| -||[subtotalLocation](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-subtotallocation-member)|This property indicates the `SubtotalLocationType` of all fields on the PivotTable.| -|[PivotTable](/javascript/api/excel/excel.pivottable)|[columnHierarchies](/javascript/api/excel/excel.pivottable#excel-excel-pivottable-columnhierarchies-member)|The Column Pivot Hierarchies of the PivotTable.| -||[dataHierarchies](/javascript/api/excel/excel.pivottable#excel-excel-pivottable-datahierarchies-member)|The Data Pivot Hierarchies of the PivotTable.| -||[delete()](/javascript/api/excel/excel.pivottable#excel-excel-pivottable-delete-member(1))|Deletes the PivotTable.| -||[filterHierarchies](/javascript/api/excel/excel.pivottable#excel-excel-pivottable-filterhierarchies-member)|The Filter Pivot Hierarchies of the PivotTable.| -||[hierarchies](/javascript/api/excel/excel.pivottable#excel-excel-pivottable-hierarchies-member)|The Pivot Hierarchies of the PivotTable.| -||[layout](/javascript/api/excel/excel.pivottable#excel-excel-pivottable-layout-member)|The PivotLayout describing the layout and visual structure of the PivotTable.| -||[rowHierarchies](/javascript/api/excel/excel.pivottable#excel-excel-pivottable-rowhierarchies-member)|The Row Pivot Hierarchies of the PivotTable.| -|[PivotTableCollection](/javascript/api/excel/excel.pivottablecollection)|[add(name: string, source: Range \| string \| Table, destination: Range \| string)](/javascript/api/excel/excel.pivottablecollection#excel-excel-pivottablecollection-add-member(1))|Add a PivotTable based on the specified source data and insert it at the top-left cell of the destination range.| -|[Range](/javascript/api/excel/excel.range)|[dataValidation](/javascript/api/excel/excel.range#excel-excel-range-datavalidation-member)|Returns a data validation object.| -|[RowColumnPivotHierarchy](/javascript/api/excel/excel.rowcolumnpivothierarchy)|[fields](/javascript/api/excel/excel.rowcolumnpivothierarchy#excel-excel-rowcolumnpivothierarchy-fields-member)|Returns the PivotFields associated with the RowColumnPivotHierarchy.| -||[id](/javascript/api/excel/excel.rowcolumnpivothierarchy#excel-excel-rowcolumnpivothierarchy-id-member)|ID of the RowColumnPivotHierarchy.| -||[name](/javascript/api/excel/excel.rowcolumnpivothierarchy#excel-excel-rowcolumnpivothierarchy-name-member)|Name of the RowColumnPivotHierarchy.| -||[position](/javascript/api/excel/excel.rowcolumnpivothierarchy#excel-excel-rowcolumnpivothierarchy-position-member)|Position of the RowColumnPivotHierarchy.| -||[setToDefault()](/javascript/api/excel/excel.rowcolumnpivothierarchy#excel-excel-rowcolumnpivothierarchy-settodefault-member(1))|Reset the RowColumnPivotHierarchy back to its default values.| -|[RowColumnPivotHierarchyCollection](/javascript/api/excel/excel.rowcolumnpivothierarchycollection)|[add(pivotHierarchy: Excel.PivotHierarchy)](/javascript/api/excel/excel.rowcolumnpivothierarchycollection#excel-excel-rowcolumnpivothierarchycollection-add-member(1))|Adds the PivotHierarchy to the current axis.| -||[getCount()](/javascript/api/excel/excel.rowcolumnpivothierarchycollection#excel-excel-rowcolumnpivothierarchycollection-getcount-member(1))|Gets the number of pivot hierarchies in the collection.| -||[getItem(name: string)](/javascript/api/excel/excel.rowcolumnpivothierarchycollection#excel-excel-rowcolumnpivothierarchycollection-getitem-member(1))|Gets a RowColumnPivotHierarchy by its name or ID.| -||[getItemOrNullObject(name: string)](/javascript/api/excel/excel.rowcolumnpivothierarchycollection#excel-excel-rowcolumnpivothierarchycollection-getitemornullobject-member(1))|Gets a RowColumnPivotHierarchy by name.| -||[items](/javascript/api/excel/excel.rowcolumnpivothierarchycollection#excel-excel-rowcolumnpivothierarchycollection-items-member)|Gets the loaded child items in this collection.| -||[remove(rowColumnPivotHierarchy: Excel.RowColumnPivotHierarchy)](/javascript/api/excel/excel.rowcolumnpivothierarchycollection#excel-excel-rowcolumnpivothierarchycollection-remove-member(1))|Removes the PivotHierarchy from the current axis.| -|[Runtime](/javascript/api/excel/excel.runtime)|[enableEvents](/javascript/api/excel/excel.runtime#excel-excel-runtime-enableevents-member)|Toggle JavaScript events in the current task pane or content add-in.| -|[ShowAsRule](/javascript/api/excel/excel.showasrule)|[baseField](/javascript/api/excel/excel.showasrule#excel-excel-showasrule-basefield-member)|The PivotField to base the `ShowAs` calculation on, if applicable according to the `ShowAsCalculation` type, else `null`.| -||[baseItem](/javascript/api/excel/excel.showasrule#excel-excel-showasrule-baseitem-member)|The item to base the `ShowAs` calculation on, if applicable according to the `ShowAsCalculation` type, else `null`.| -||[calculation](/javascript/api/excel/excel.showasrule#excel-excel-showasrule-calculation-member)|The `ShowAs` calculation to use for the PivotField.| -|[Style](/javascript/api/excel/excel.style)|[autoIndent](/javascript/api/excel/excel.style#excel-excel-style-autoindent-member)|Specifies if text is automatically indented when the text alignment in a cell is set to equal distribution.| -||[textOrientation](/javascript/api/excel/excel.style#excel-excel-style-textorientation-member)|The text orientation for the style.| -|[Subtotals](/javascript/api/excel/excel.subtotals)|[automatic](/javascript/api/excel/excel.subtotals#excel-excel-subtotals-automatic-member)|If `Automatic` is set to `true`, then all other values will be ignored when setting the `Subtotals`.| -||[average](/javascript/api/excel/excel.subtotals#excel-excel-subtotals-average-member)|| -||[count](/javascript/api/excel/excel.subtotals#excel-excel-subtotals-count-member)|| -||[countNumbers](/javascript/api/excel/excel.subtotals#excel-excel-subtotals-countnumbers-member)|| -||[max](/javascript/api/excel/excel.subtotals#excel-excel-subtotals-max-member)|| -||[min](/javascript/api/excel/excel.subtotals#excel-excel-subtotals-min-member)|| -||[product](/javascript/api/excel/excel.subtotals#excel-excel-subtotals-product-member)|| -||[standardDeviation](/javascript/api/excel/excel.subtotals#excel-excel-subtotals-standarddeviation-member)|| -||[standardDeviationP](/javascript/api/excel/excel.subtotals#excel-excel-subtotals-standarddeviationp-member)|| -||[sum](/javascript/api/excel/excel.subtotals#excel-excel-subtotals-sum-member)|| -||[variance](/javascript/api/excel/excel.subtotals#excel-excel-subtotals-variance-member)|| -||[varianceP](/javascript/api/excel/excel.subtotals#excel-excel-subtotals-variancep-member)|| -|[Table](/javascript/api/excel/excel.table)|[legacyId](/javascript/api/excel/excel.table#excel-excel-table-legacyid-member)|Returns a numeric ID.| -|[TableChangedEventArgs](/javascript/api/excel/excel.tablechangedeventargs)|[getRange(ctx: Excel.RequestContext)](/javascript/api/excel/excel.tablechangedeventargs#excel-excel-tablechangedeventargs-getrange-member(1))|Gets the range that represents the changed area of a table on a specific worksheet.| -||[getRangeOrNullObject(ctx: Excel.RequestContext)](/javascript/api/excel/excel.tablechangedeventargs#excel-excel-tablechangedeventargs-getrangeornullobject-member(1))|Gets the range that represents the changed area of a table on a specific worksheet.| -|[Workbook](/javascript/api/excel/excel.workbook)|[readOnly](/javascript/api/excel/excel.workbook#excel-excel-workbook-readonly-member)|Returns `true` if the workbook is open in read-only mode.| -|[WorkbookCreated](/javascript/api/excel/excel.workbookcreated)||| -|[Worksheet](/javascript/api/excel/excel.worksheet)|[onCalculated](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-oncalculated-member)|Occurs when the worksheet is calculated.| -||[showGridlines](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-showgridlines-member)|Specifies if gridlines are visible to the user.| -||[showHeadings](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-showheadings-member)|Specifies if headings are visible to the user.| -|[WorksheetCalculatedEventArgs](/javascript/api/excel/excel.worksheetcalculatedeventargs)|[type](/javascript/api/excel/excel.worksheetcalculatedeventargs#excel-excel-worksheetcalculatedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/javascript/api/excel/excel.worksheetcalculatedeventargs#excel-excel-worksheetcalculatedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the calculation occurred.| -|[WorksheetChangedEventArgs](/javascript/api/excel/excel.worksheetchangedeventargs)|[getRange(ctx: Excel.RequestContext)](/javascript/api/excel/excel.worksheetchangedeventargs#excel-excel-worksheetchangedeventargs-getrange-member(1))|Gets the range that represents the changed area of a specific worksheet.| -||[getRangeOrNullObject(ctx: Excel.RequestContext)](/javascript/api/excel/excel.worksheetchangedeventargs#excel-excel-worksheetchangedeventargs-getrangeornullobject-member(1))|Gets the range that represents the changed area of a specific worksheet.| -|[WorksheetCollection](/javascript/api/excel/excel.worksheetcollection)|[onCalculated](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-oncalculated-member)|Occurs when any worksheet in the workbook is calculated.| +|*global*|[createWorkbook(base64?: string)](/#excel-javascript/api/excel/-createworkbook-function(1))|Creates and opens a new workbook.| +|[BasicDataValidation](/.basicdatavalidation)|[formula1](/.basicdatavalidation#excel-javascript/api/excel/-basicdatavalidation-formula1-member)|Specifies the right-hand operand when the operator property is set to a binary operator such as GreaterThan (the left-hand operand is the value the user tries to enter in the cell).| +||[formula2](/.basicdatavalidation#excel-javascript/api/excel/-basicdatavalidation-formula2-member)|With the ternary operators Between and NotBetween, specifies the upper bound operand.| +||[operator](/.basicdatavalidation#excel-javascript/api/excel/-basicdatavalidation-operator-member)|The operator to use for validating the data.| +|[Chart](/.chart)|[categoryLabelLevel](/.chart#excel-javascript/api/excel/-chart-categorylabellevel-member)|Specifies a chart category label level enumeration constant, referring to the level of the source category labels.| +||[displayBlanksAs](/.chart#excel-javascript/api/excel/-chart-displayblanksas-member)|Specifies the way that blank cells are plotted on a chart.| +||[onActivated](/.chart#excel-javascript/api/excel/-chart-onactivated-member)|Occurs when the chart is activated.| +||[onDeactivated](/.chart#excel-javascript/api/excel/-chart-ondeactivated-member)|Occurs when the chart is deactivated.| +||[plotArea](/.chart#excel-javascript/api/excel/-chart-plotarea-member)|Represents the plot area for the chart.| +||[plotBy](/.chart#excel-javascript/api/excel/-chart-plotby-member)|Specifies the way columns or rows are used as data series on the chart.| +||[plotVisibleOnly](/.chart#excel-javascript/api/excel/-chart-plotvisibleonly-member)|True if only visible cells are plotted.| +||[seriesNameLevel](/.chart#excel-javascript/api/excel/-chart-seriesnamelevel-member)|Specifies a chart series name level enumeration constant, referring to the level of the source series names.| +||[showDataLabelsOverMaximum](/.chart#excel-javascript/api/excel/-chart-showdatalabelsovermaximum-member)|Specifies whether to show the data labels when the value is greater than the maximum value on the value axis.| +||[style](/.chart#excel-javascript/api/excel/-chart-style-member)|Specifies the chart style for the chart.| +|[ChartActivatedEventArgs](/.chartactivatedeventargs)|[chartId](/.chartactivatedeventargs#excel-javascript/api/excel/-chartactivatedeventargs-chartid-member)|Gets the ID of the chart that is activated.| +||[type](/.chartactivatedeventargs#excel-javascript/api/excel/-chartactivatedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/.chartactivatedeventargs#excel-javascript/api/excel/-chartactivatedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the chart is activated.| +|[ChartAddedEventArgs](/.chartaddedeventargs)|[chartId](/.chartaddedeventargs#excel-javascript/api/excel/-chartaddedeventargs-chartid-member)|Gets the ID of the chart that is added to the worksheet.| +||[source](/.chartaddedeventargs#excel-javascript/api/excel/-chartaddedeventargs-source-member)|Gets the source of the event.| +||[type](/.chartaddedeventargs#excel-javascript/api/excel/-chartaddedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/.chartaddedeventargs#excel-javascript/api/excel/-chartaddedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the chart is added.| +|[ChartAxis](/.chartaxis)|[alignment](/.chartaxis#excel-javascript/api/excel/-chartaxis-alignment-member)|Specifies the alignment for the specified axis tick label.| +||[isBetweenCategories](/.chartaxis#excel-javascript/api/excel/-chartaxis-isbetweencategories-member)|Specifies if the value axis crosses the category axis between categories.| +||[multiLevel](/.chartaxis#excel-javascript/api/excel/-chartaxis-multilevel-member)|Specifies if an axis is multilevel.| +||[numberFormat](/.chartaxis#excel-javascript/api/excel/-chartaxis-numberformat-member)|Specifies the format code for the axis tick label.| +||[offset](/.chartaxis#excel-javascript/api/excel/-chartaxis-offset-member)|Specifies the distance between the levels of labels, and the distance between the first level and the axis line.| +||[position](/.chartaxis#excel-javascript/api/excel/-chartaxis-position-member)|Specifies the specified axis position where the other axis crosses.| +||[positionAt](/.chartaxis#excel-javascript/api/excel/-chartaxis-positionat-member)|Specifies the axis position where the other axis crosses.| +||[setPositionAt(value: number)](/.chartaxis#excel-javascript/api/excel/-chartaxis-setpositionat-member(1))|Sets the specified axis position where the other axis crosses.| +||[textOrientation](/.chartaxis#excel-javascript/api/excel/-chartaxis-textorientation-member)|Specifies the angle to which the text is oriented for the chart axis tick label.| +|[ChartAxisFormat](/.chartaxisformat)|[fill](/.chartaxisformat#excel-javascript/api/excel/-chartaxisformat-fill-member)|Specifies chart fill formatting.| +|[ChartAxisTitle](/.chartaxistitle)|[setFormula(formula: string)](/.chartaxistitle#excel-javascript/api/excel/-chartaxistitle-setformula-member(1))|A string value that represents the formula of chart axis title using A1-style notation.| +|[ChartAxisTitleFormat](/.chartaxistitleformat)|[border](/.chartaxistitleformat#excel-javascript/api/excel/-chartaxistitleformat-border-member)|Specifies the chart axis title's border format, which includes color, linestyle, and weight.| +||[fill](/.chartaxistitleformat#excel-javascript/api/excel/-chartaxistitleformat-fill-member)|Specifies the chart axis title's fill formatting.| +|[ChartBorder](/.chartborder)|[clear()](/.chartborder#excel-javascript/api/excel/-chartborder-clear-member(1))|Clear the border format of a chart element.| +|[ChartCollection](/.chartcollection)|[onActivated](/.chartcollection#excel-javascript/api/excel/-chartcollection-onactivated-member)|Occurs when a chart is activated.| +||[onAdded](/.chartcollection#excel-javascript/api/excel/-chartcollection-onadded-member)|Occurs when a new chart is added to the worksheet.| +||[onDeactivated](/.chartcollection#excel-javascript/api/excel/-chartcollection-ondeactivated-member)|Occurs when a chart is deactivated.| +||[onDeleted](/.chartcollection#excel-javascript/api/excel/-chartcollection-ondeleted-member)|Occurs when a chart is deleted.| +|[ChartDataLabel](/.chartdatalabel)|[autoText](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-autotext-member)|Specifies if the data label automatically generates appropriate text based on context.| +||[format](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-format-member)|Represents the format of chart data label.| +||[formula](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-formula-member)|String value that represents the formula of chart data label using A1-style notation.| +||[height](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-height-member)|Returns the height, in points, of the chart data label.| +||[horizontalAlignment](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-horizontalalignment-member)|Represents the horizontal alignment for chart data label.| +||[left](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-left-member)|Represents the distance, in points, from the left edge of chart data label to the left edge of chart area.| +||[numberFormat](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-numberformat-member)|Specifies the format code for data label.| +||[text](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-text-member)|String representing the text of the data label on a chart.| +||[textOrientation](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-textorientation-member)|Represents the angle to which the text is oriented for the chart data label.| +||[top](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-top-member)|Represents the distance, in points, from the top edge of chart data label to the top of chart area.| +||[verticalAlignment](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-verticalalignment-member)|Represents the vertical alignment of chart data label.| +||[width](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-width-member)|Returns the width, in points, of the chart data label.| +|[ChartDataLabelFormat](/.chartdatalabelformat)|[border](/.chartdatalabelformat#excel-javascript/api/excel/-chartdatalabelformat-border-member)|Represents the border format, which includes color, linestyle, and weight.| +|[ChartDataLabels](/.chartdatalabels)|[autoText](/.chartdatalabels#excel-javascript/api/excel/-chartdatalabels-autotext-member)|Specifies if data labels automatically generate appropriate text based on context.| +||[horizontalAlignment](/.chartdatalabels#excel-javascript/api/excel/-chartdatalabels-horizontalalignment-member)|Specifies the horizontal alignment for chart data label.| +||[numberFormat](/.chartdatalabels#excel-javascript/api/excel/-chartdatalabels-numberformat-member)|Specifies the format code for data labels.| +||[textOrientation](/.chartdatalabels#excel-javascript/api/excel/-chartdatalabels-textorientation-member)|Represents the angle to which the text is oriented for data labels.| +||[verticalAlignment](/.chartdatalabels#excel-javascript/api/excel/-chartdatalabels-verticalalignment-member)|Represents the vertical alignment of chart data label.| +|[ChartDeactivatedEventArgs](/.chartdeactivatedeventargs)|[chartId](/.chartdeactivatedeventargs#excel-javascript/api/excel/-chartdeactivatedeventargs-chartid-member)|Gets the ID of the chart that is deactivated.| +||[type](/.chartdeactivatedeventargs#excel-javascript/api/excel/-chartdeactivatedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/.chartdeactivatedeventargs#excel-javascript/api/excel/-chartdeactivatedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the chart is deactivated.| +|[ChartDeletedEventArgs](/.chartdeletedeventargs)|[chartId](/.chartdeletedeventargs#excel-javascript/api/excel/-chartdeletedeventargs-chartid-member)|Gets the ID of the chart that is deleted from the worksheet.| +||[source](/.chartdeletedeventargs#excel-javascript/api/excel/-chartdeletedeventargs-source-member)|Gets the source of the event.| +||[type](/.chartdeletedeventargs#excel-javascript/api/excel/-chartdeletedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/.chartdeletedeventargs#excel-javascript/api/excel/-chartdeletedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the chart is deleted.| +|[ChartLegendEntry](/.chartlegendentry)|[height](/.chartlegendentry#excel-javascript/api/excel/-chartlegendentry-height-member)|Specifies the height of the legend entry on the chart legend.| +||[index](/.chartlegendentry#excel-javascript/api/excel/-chartlegendentry-index-member)|Specifies the index of the legend entry in the chart legend.| +||[left](/.chartlegendentry#excel-javascript/api/excel/-chartlegendentry-left-member)|Specifies the left value of a chart legend entry.| +||[top](/.chartlegendentry#excel-javascript/api/excel/-chartlegendentry-top-member)|Specifies the top of a chart legend entry.| +||[width](/.chartlegendentry#excel-javascript/api/excel/-chartlegendentry-width-member)|Represents the width of the legend entry on the chart Legend.| +|[ChartLegendFormat](/.chartlegendformat)|[border](/.chartlegendformat#excel-javascript/api/excel/-chartlegendformat-border-member)|Represents the border format, which includes color, linestyle, and weight.| +|[ChartPlotArea](/.chartplotarea)|[format](/.chartplotarea#excel-javascript/api/excel/-chartplotarea-format-member)|Specifies the formatting of a chart plot area.| +||[height](/.chartplotarea#excel-javascript/api/excel/-chartplotarea-height-member)|Specifies the height value of a plot area.| +||[insideHeight](/.chartplotarea#excel-javascript/api/excel/-chartplotarea-insideheight-member)|Specifies the inside height value of a plot area.| +||[insideLeft](/.chartplotarea#excel-javascript/api/excel/-chartplotarea-insideleft-member)|Specifies the inside left value of a plot area.| +||[insideTop](/.chartplotarea#excel-javascript/api/excel/-chartplotarea-insidetop-member)|Specifies the inside top value of a plot area.| +||[insideWidth](/.chartplotarea#excel-javascript/api/excel/-chartplotarea-insidewidth-member)|Specifies the inside width value of a plot area.| +||[left](/.chartplotarea#excel-javascript/api/excel/-chartplotarea-left-member)|Specifies the left value of a plot area.| +||[position](/.chartplotarea#excel-javascript/api/excel/-chartplotarea-position-member)|Specifies the position of a plot area.| +||[top](/.chartplotarea#excel-javascript/api/excel/-chartplotarea-top-member)|Specifies the top value of a plot area.| +||[width](/.chartplotarea#excel-javascript/api/excel/-chartplotarea-width-member)|Specifies the width value of a plot area.| +|[ChartPlotAreaFormat](/.chartplotareaformat)|[border](/.chartplotareaformat#excel-javascript/api/excel/-chartplotareaformat-border-member)|Specifies the border attributes of a chart plot area.| +||[fill](/.chartplotareaformat#excel-javascript/api/excel/-chartplotareaformat-fill-member)|Specifies the fill format of an object, which includes background formatting information.| +|[ChartSeries](/.chartseries)|[axisGroup](/.chartseries#excel-javascript/api/excel/-chartseries-axisgroup-member)|Specifies the group for the specified series.| +||[dataLabels](/.chartseries#excel-javascript/api/excel/-chartseries-datalabels-member)|Represents a collection of all data labels in the series.| +||[explosion](/.chartseries#excel-javascript/api/excel/-chartseries-explosion-member)|Specifies the explosion value for a pie-chart or doughnut-chart slice.| +||[firstSliceAngle](/.chartseries#excel-javascript/api/excel/-chartseries-firstsliceangle-member)|Specifies the angle of the first pie-chart or doughnut-chart slice, in degrees (clockwise from vertical).| +||[invertIfNegative](/.chartseries#excel-javascript/api/excel/-chartseries-invertifnegative-member)|True if Excel inverts the pattern in the item when it corresponds to a negative number.| +||[overlap](/.chartseries#excel-javascript/api/excel/-chartseries-overlap-member)|Specifies how bars and columns are positioned.| +||[secondPlotSize](/.chartseries#excel-javascript/api/excel/-chartseries-secondplotsize-member)|Specifies the size of the secondary section of either a pie-of-pie chart or a bar-of-pie chart, as a percentage of the size of the primary pie.| +||[splitType](/.chartseries#excel-javascript/api/excel/-chartseries-splittype-member)|Specifies the way the two sections of either a pie-of-pie chart or a bar-of-pie chart are split.| +||[varyByCategories](/.chartseries#excel-javascript/api/excel/-chartseries-varybycategories-member)|True if Excel assigns a different color or pattern to each data marker.| +|[ChartTrendline](/.charttrendline)|[backwardPeriod](/.charttrendline#excel-javascript/api/excel/-charttrendline-backwardperiod-member)|Represents the number of periods that the trendline extends backward.| +||[forwardPeriod](/.charttrendline#excel-javascript/api/excel/-charttrendline-forwardperiod-member)|Represents the number of periods that the trendline extends forward.| +||[label](/.charttrendline#excel-javascript/api/excel/-charttrendline-label-member)|Represents the label of a chart trendline.| +||[showEquation](/.charttrendline#excel-javascript/api/excel/-charttrendline-showequation-member)|True if the equation for the trendline is displayed on the chart.| +||[showRSquared](/.charttrendline#excel-javascript/api/excel/-charttrendline-showrsquared-member)|True if the r-squared value for the trendline is displayed on the chart.| +|[ChartTrendlineLabel](/.charttrendlinelabel)|[autoText](/.charttrendlinelabel#excel-javascript/api/excel/-charttrendlinelabel-autotext-member)|Specifies if the trendline label automatically generates appropriate text based on context.| +||[format](/.charttrendlinelabel#excel-javascript/api/excel/-charttrendlinelabel-format-member)|The format of the chart trendline label.| +||[formula](/.charttrendlinelabel#excel-javascript/api/excel/-charttrendlinelabel-formula-member)|String value that represents the formula of the chart trendline label using A1-style notation.| +||[height](/.charttrendlinelabel#excel-javascript/api/excel/-charttrendlinelabel-height-member)|Returns the height, in points, of the chart trendline label.| +||[horizontalAlignment](/.charttrendlinelabel#excel-javascript/api/excel/-charttrendlinelabel-horizontalalignment-member)|Represents the horizontal alignment of the chart trendline label.| +||[left](/.charttrendlinelabel#excel-javascript/api/excel/-charttrendlinelabel-left-member)|Represents the distance, in points, from the left edge of the chart trendline label to the left edge of the chart area.| +||[numberFormat](/.charttrendlinelabel#excel-javascript/api/excel/-charttrendlinelabel-numberformat-member)|String value that represents the format code for the trendline label.| +||[text](/.charttrendlinelabel#excel-javascript/api/excel/-charttrendlinelabel-text-member)|String representing the text of the trendline label on a chart.| +||[textOrientation](/.charttrendlinelabel#excel-javascript/api/excel/-charttrendlinelabel-textorientation-member)|Represents the angle to which the text is oriented for the chart trendline label.| +||[top](/.charttrendlinelabel#excel-javascript/api/excel/-charttrendlinelabel-top-member)|Represents the distance, in points, from the top edge of the chart trendline label to the top of the chart area.| +||[verticalAlignment](/.charttrendlinelabel#excel-javascript/api/excel/-charttrendlinelabel-verticalalignment-member)|Represents the vertical alignment of the chart trendline label.| +||[width](/.charttrendlinelabel#excel-javascript/api/excel/-charttrendlinelabel-width-member)|Returns the width, in points, of the chart trendline label.| +|[ChartTrendlineLabelFormat](/.charttrendlinelabelformat)|[border](/.charttrendlinelabelformat#excel-javascript/api/excel/-charttrendlinelabelformat-border-member)|Specifies the border format, which includes color, linestyle, and weight.| +||[fill](/.charttrendlinelabelformat#excel-javascript/api/excel/-charttrendlinelabelformat-fill-member)|Specifies the fill format of the current chart trendline label.| +||[font](/.charttrendlinelabelformat#excel-javascript/api/excel/-charttrendlinelabelformat-font-member)|Specifies the font attributes (such as font name, font size, and color) for a chart trendline label.| +|[CustomDataValidation](/.customdatavalidation)|[formula](/.customdatavalidation#excel-javascript/api/excel/-customdatavalidation-formula-member)|A custom data validation formula.| +|[DataPivotHierarchy](/.datapivothierarchy)|[field](/.datapivothierarchy#excel-javascript/api/excel/-datapivothierarchy-field-member)|Returns the PivotFields associated with the DataPivotHierarchy.| +||[id](/.datapivothierarchy#excel-javascript/api/excel/-datapivothierarchy-id-member)|ID of the DataPivotHierarchy.| +||[name](/.datapivothierarchy#excel-javascript/api/excel/-datapivothierarchy-name-member)|Name of the DataPivotHierarchy.| +||[numberFormat](/.datapivothierarchy#excel-javascript/api/excel/-datapivothierarchy-numberformat-member)|Number format of the DataPivotHierarchy.| +||[position](/.datapivothierarchy#excel-javascript/api/excel/-datapivothierarchy-position-member)|Position of the DataPivotHierarchy.| +||[setToDefault()](/.datapivothierarchy#excel-javascript/api/excel/-datapivothierarchy-settodefault-member(1))|Reset the DataPivotHierarchy back to its default values.| +||[showAs](/.datapivothierarchy#excel-javascript/api/excel/-datapivothierarchy-showas-member)|Specifies if the data should be shown as a specific summary calculation.| +||[summarizeBy](/.datapivothierarchy#excel-javascript/api/excel/-datapivothierarchy-summarizeby-member)|Specifies if all items of the DataPivotHierarchy are shown.| +|[DataPivotHierarchyCollection](/.datapivothierarchycollection)|[add(pivotHierarchy: Excel.PivotHierarchy)](/.datapivothierarchycollection#excel-javascript/api/excel/-datapivothierarchycollection-add-member(1))|Adds the PivotHierarchy to the current axis.| +||[getCount()](/.datapivothierarchycollection#excel-javascript/api/excel/-datapivothierarchycollection-getcount-member(1))|Gets the number of pivot hierarchies in the collection.| +||[getItem(name: string)](/.datapivothierarchycollection#excel-javascript/api/excel/-datapivothierarchycollection-getitem-member(1))|Gets a DataPivotHierarchy by its name or ID.| +||[getItemOrNullObject(name: string)](/.datapivothierarchycollection#excel-javascript/api/excel/-datapivothierarchycollection-getitemornullobject-member(1))|Gets a DataPivotHierarchy by name.| +||[items](/.datapivothierarchycollection#excel-javascript/api/excel/-datapivothierarchycollection-items-member)|Gets the loaded child items in this collection.| +||[remove(DataPivotHierarchy: Excel.DataPivotHierarchy)](/.datapivothierarchycollection#excel-javascript/api/excel/-datapivothierarchycollection-remove-member(1))|Removes the PivotHierarchy from the current axis.| +|[DataValidation](/.datavalidation)|[clear()](/.datavalidation#excel-javascript/api/excel/-datavalidation-clear-member(1))|Clears the data validation from the current range.| +||[errorAlert](/.datavalidation#excel-javascript/api/excel/-datavalidation-erroralert-member)|Error alert when user enters invalid data.| +||[ignoreBlanks](/.datavalidation#excel-javascript/api/excel/-datavalidation-ignoreblanks-member)|Specifies if data validation will be performed on blank cells.| +||[prompt](/.datavalidation#excel-javascript/api/excel/-datavalidation-prompt-member)|Prompt when users select a cell.| +||[rule](/.datavalidation#excel-javascript/api/excel/-datavalidation-rule-member)|Data validation rule that contains different type of data validation criteria.| +||[type](/.datavalidation#excel-javascript/api/excel/-datavalidation-type-member)|Type of the data validation, see `Excel.DataValidationType` for details.| +||[valid](/.datavalidation#excel-javascript/api/excel/-datavalidation-valid-member)|Represents if all cell values are valid according to the data validation rules.| +|[DataValidationErrorAlert](/.datavalidationerroralert)|[message](/.datavalidationerroralert#excel-javascript/api/excel/-datavalidationerroralert-message-member)|Represents the error alert message.| +||[showAlert](/.datavalidationerroralert#excel-javascript/api/excel/-datavalidationerroralert-showalert-member)|Specifies whether to show an error alert dialog when a user enters invalid data.| +||[style](/.datavalidationerroralert#excel-javascript/api/excel/-datavalidationerroralert-style-member)|The data validation alert type, please see `Excel.DataValidationAlertStyle` for details.| +||[title](/.datavalidationerroralert#excel-javascript/api/excel/-datavalidationerroralert-title-member)|Represents the error alert dialog title.| +|[DataValidationPrompt](/.datavalidationprompt)|[message](/.datavalidationprompt#excel-javascript/api/excel/-datavalidationprompt-message-member)|Specifies the message of the prompt.| +||[showPrompt](/.datavalidationprompt#excel-javascript/api/excel/-datavalidationprompt-showprompt-member)|Specifies if a prompt is shown when a user selects a cell with data validation.| +||[title](/.datavalidationprompt#excel-javascript/api/excel/-datavalidationprompt-title-member)|Specifies the title for the prompt.| +|[DataValidationRule](/.datavalidationrule)|[custom](/.datavalidationrule#excel-javascript/api/excel/-datavalidationrule-custom-member)|Custom data validation criteria.| +||[date](/.datavalidationrule#excel-javascript/api/excel/-datavalidationrule-date-member)|Date data validation criteria.| +||[decimal](/.datavalidationrule#excel-javascript/api/excel/-datavalidationrule-decimal-member)|Decimal data validation criteria.| +||[list](/.datavalidationrule#excel-javascript/api/excel/-datavalidationrule-list-member)|List data validation criteria.| +||[textLength](/.datavalidationrule#excel-javascript/api/excel/-datavalidationrule-textlength-member)|Text length data validation criteria.| +||[time](/.datavalidationrule#excel-javascript/api/excel/-datavalidationrule-time-member)|Time data validation criteria.| +||[wholeNumber](/.datavalidationrule#excel-javascript/api/excel/-datavalidationrule-wholenumber-member)|Whole number data validation criteria.| +|[DateTimeDataValidation](/.datetimedatavalidation)|[formula1](/.datetimedatavalidation#excel-javascript/api/excel/-datetimedatavalidation-formula1-member)|Specifies the right-hand operand when the operator property is set to a binary operator such as GreaterThan (the left-hand operand is the value the user tries to enter in the cell).| +||[formula2](/.datetimedatavalidation#excel-javascript/api/excel/-datetimedatavalidation-formula2-member)|With the ternary operators Between and NotBetween, specifies the upper bound operand.| +||[operator](/.datetimedatavalidation#excel-javascript/api/excel/-datetimedatavalidation-operator-member)|The operator to use for validating the data.| +|[FilterPivotHierarchy](/.filterpivothierarchy)|[enableMultipleFilterItems](/.filterpivothierarchy#excel-javascript/api/excel/-filterpivothierarchy-enablemultiplefilteritems-member)|Determines whether to allow multiple filter items.| +||[fields](/.filterpivothierarchy#excel-javascript/api/excel/-filterpivothierarchy-fields-member)|Returns the PivotFields associated with the FilterPivotHierarchy.| +||[id](/.filterpivothierarchy#excel-javascript/api/excel/-filterpivothierarchy-id-member)|ID of the FilterPivotHierarchy.| +||[name](/.filterpivothierarchy#excel-javascript/api/excel/-filterpivothierarchy-name-member)|Name of the FilterPivotHierarchy.| +||[position](/.filterpivothierarchy#excel-javascript/api/excel/-filterpivothierarchy-position-member)|Position of the FilterPivotHierarchy.| +||[setToDefault()](/.filterpivothierarchy#excel-javascript/api/excel/-filterpivothierarchy-settodefault-member(1))|Reset the FilterPivotHierarchy back to its default values.| +|[FilterPivotHierarchyCollection](/.filterpivothierarchycollection)|[add(pivotHierarchy: Excel.PivotHierarchy)](/.filterpivothierarchycollection#excel-javascript/api/excel/-filterpivothierarchycollection-add-member(1))|Adds the PivotHierarchy to the current axis.| +||[getCount()](/.filterpivothierarchycollection#excel-javascript/api/excel/-filterpivothierarchycollection-getcount-member(1))|Gets the number of pivot hierarchies in the collection.| +||[getItem(name: string)](/.filterpivothierarchycollection#excel-javascript/api/excel/-filterpivothierarchycollection-getitem-member(1))|Gets a FilterPivotHierarchy by its name or ID.| +||[getItemOrNullObject(name: string)](/.filterpivothierarchycollection#excel-javascript/api/excel/-filterpivothierarchycollection-getitemornullobject-member(1))|Gets a FilterPivotHierarchy by name.| +||[items](/.filterpivothierarchycollection#excel-javascript/api/excel/-filterpivothierarchycollection-items-member)|Gets the loaded child items in this collection.| +||[remove(filterPivotHierarchy: Excel.FilterPivotHierarchy)](/.filterpivothierarchycollection#excel-javascript/api/excel/-filterpivothierarchycollection-remove-member(1))|Removes the PivotHierarchy from the current axis.| +|[ListDataValidation](/.listdatavalidation)|[inCellDropDown](/.listdatavalidation#excel-javascript/api/excel/-listdatavalidation-incelldropdown-member)|Specifies whether to display the list in a cell drop-down.| +||[source](/.listdatavalidation#excel-javascript/api/excel/-listdatavalidation-source-member)|Source of the list for data validation| +|[PivotField](/.pivotfield)|[id](/.pivotfield#excel-javascript/api/excel/-pivotfield-id-member)|ID of the PivotField.| +||[items](/.pivotfield#excel-javascript/api/excel/-pivotfield-items-member)|Returns the PivotItems associated with the PivotField.| +||[name](/.pivotfield#excel-javascript/api/excel/-pivotfield-name-member)|Name of the PivotField.| +||[showAllItems](/.pivotfield#excel-javascript/api/excel/-pivotfield-showallitems-member)|Determines whether to show all items of the PivotField.| +||[sortByLabels(sortBy: SortBy)](/.pivotfield#excel-javascript/api/excel/-pivotfield-sortbylabels-member(1))|Sorts the PivotField.| +||[subtotals](/.pivotfield#excel-javascript/api/excel/-pivotfield-subtotals-member)|Subtotals of the PivotField.| +|[PivotFieldCollection](/.pivotfieldcollection)|[getCount()](/.pivotfieldcollection#excel-javascript/api/excel/-pivotfieldcollection-getcount-member(1))|Gets the number of pivot fields in the collection.| +||[getItem(name: string)](/.pivotfieldcollection#excel-javascript/api/excel/-pivotfieldcollection-getitem-member(1))|Gets a PivotField by its name or ID.| +||[getItemOrNullObject(name: string)](/.pivotfieldcollection#excel-javascript/api/excel/-pivotfieldcollection-getitemornullobject-member(1))|Gets a PivotField by name.| +||[items](/.pivotfieldcollection#excel-javascript/api/excel/-pivotfieldcollection-items-member)|Gets the loaded child items in this collection.| +|[PivotHierarchy](/.pivothierarchy)|[fields](/.pivothierarchy#excel-javascript/api/excel/-pivothierarchy-fields-member)|Returns the PivotFields associated with the PivotHierarchy.| +||[id](/.pivothierarchy#excel-javascript/api/excel/-pivothierarchy-id-member)|ID of the PivotHierarchy.| +||[name](/.pivothierarchy#excel-javascript/api/excel/-pivothierarchy-name-member)|Name of the PivotHierarchy.| +|[PivotHierarchyCollection](/.pivothierarchycollection)|[getCount()](/.pivothierarchycollection#excel-javascript/api/excel/-pivothierarchycollection-getcount-member(1))|Gets the number of pivot hierarchies in the collection.| +||[getItem(name: string)](/.pivothierarchycollection#excel-javascript/api/excel/-pivothierarchycollection-getitem-member(1))|Gets a PivotHierarchy by its name or ID.| +||[getItemOrNullObject(name: string)](/.pivothierarchycollection#excel-javascript/api/excel/-pivothierarchycollection-getitemornullobject-member(1))|Gets a PivotHierarchy by name.| +||[items](/.pivothierarchycollection#excel-javascript/api/excel/-pivothierarchycollection-items-member)|Gets the loaded child items in this collection.| +|[PivotItem](/.pivotitem)|[id](/.pivotitem#excel-javascript/api/excel/-pivotitem-id-member)|ID of the PivotItem.| +||[isExpanded](/.pivotitem#excel-javascript/api/excel/-pivotitem-isexpanded-member)|Determines whether the item is expanded to show child items or if it's collapsed and child items are hidden.| +||[name](/.pivotitem#excel-javascript/api/excel/-pivotitem-name-member)|Name of the PivotItem.| +||[visible](/.pivotitem#excel-javascript/api/excel/-pivotitem-visible-member)|Specifies if the PivotItem is visible.| +|[PivotItemCollection](/.pivotitemcollection)|[getCount()](/.pivotitemcollection#excel-javascript/api/excel/-pivotitemcollection-getcount-member(1))|Gets the number of PivotItems in the collection.| +||[getItem(name: string)](/.pivotitemcollection#excel-javascript/api/excel/-pivotitemcollection-getitem-member(1))|Gets a PivotItem by its name or ID.| +||[getItemOrNullObject(name: string)](/.pivotitemcollection#excel-javascript/api/excel/-pivotitemcollection-getitemornullobject-member(1))|Gets a PivotItem by name.| +||[items](/.pivotitemcollection#excel-javascript/api/excel/-pivotitemcollection-items-member)|Gets the loaded child items in this collection.| +|[PivotLayout](/.pivotlayout)|[getColumnLabelRange()](/.pivotlayout#excel-javascript/api/excel/-pivotlayout-getcolumnlabelrange-member(1))|Returns the range where the PivotTable's column labels reside.| +||[getDataBodyRange()](/.pivotlayout#excel-javascript/api/excel/-pivotlayout-getdatabodyrange-member(1))|Returns the range where the PivotTable's data values reside.| +||[getFilterAxisRange()](/.pivotlayout#excel-javascript/api/excel/-pivotlayout-getfilteraxisrange-member(1))|Returns the range of the PivotTable's filter area.| +||[getRange()](/.pivotlayout#excel-javascript/api/excel/-pivotlayout-getrange-member(1))|Returns the range the PivotTable exists on, excluding the filter area.| +||[getRowLabelRange()](/.pivotlayout#excel-javascript/api/excel/-pivotlayout-getrowlabelrange-member(1))|Returns the range where the PivotTable's row labels reside.| +||[layoutType](/.pivotlayout#excel-javascript/api/excel/-pivotlayout-layouttype-member)|This property indicates the PivotLayoutType of all fields on the PivotTable.| +||[showColumnGrandTotals](/.pivotlayout#excel-javascript/api/excel/-pivotlayout-showcolumngrandtotals-member)|Specifies if the PivotTable report shows grand totals for columns.| +||[showRowGrandTotals](/.pivotlayout#excel-javascript/api/excel/-pivotlayout-showrowgrandtotals-member)|Specifies if the PivotTable report shows grand totals for rows.| +||[subtotalLocation](/.pivotlayout#excel-javascript/api/excel/-pivotlayout-subtotallocation-member)|This property indicates the `SubtotalLocationType` of all fields on the PivotTable.| +|[PivotTable](/.pivottable)|[columnHierarchies](/.pivottable#excel-javascript/api/excel/-pivottable-columnhierarchies-member)|The Column Pivot Hierarchies of the PivotTable.| +||[dataHierarchies](/.pivottable#excel-javascript/api/excel/-pivottable-datahierarchies-member)|The Data Pivot Hierarchies of the PivotTable.| +||[delete()](/.pivottable#excel-javascript/api/excel/-pivottable-delete-member(1))|Deletes the PivotTable.| +||[filterHierarchies](/.pivottable#excel-javascript/api/excel/-pivottable-filterhierarchies-member)|The Filter Pivot Hierarchies of the PivotTable.| +||[hierarchies](/.pivottable#excel-javascript/api/excel/-pivottable-hierarchies-member)|The Pivot Hierarchies of the PivotTable.| +||[layout](/.pivottable#excel-javascript/api/excel/-pivottable-layout-member)|The PivotLayout describing the layout and visual structure of the PivotTable.| +||[rowHierarchies](/.pivottable#excel-javascript/api/excel/-pivottable-rowhierarchies-member)|The Row Pivot Hierarchies of the PivotTable.| +|[PivotTableCollection](/.pivottablecollection)|[add(name: string, source: Range \| string \| Table, destination: Range \| string)](/.pivottablecollection#excel-javascript/api/excel/-pivottablecollection-add-member(1))|Add a PivotTable based on the specified source data and insert it at the top-left cell of the destination range.| +|[Range](/.range)|[dataValidation](/.range#excel-javascript/api/excel/-range-datavalidation-member)|Returns a data validation object.| +|[RowColumnPivotHierarchy](/.rowcolumnpivothierarchy)|[fields](/.rowcolumnpivothierarchy#excel-javascript/api/excel/-rowcolumnpivothierarchy-fields-member)|Returns the PivotFields associated with the RowColumnPivotHierarchy.| +||[id](/.rowcolumnpivothierarchy#excel-javascript/api/excel/-rowcolumnpivothierarchy-id-member)|ID of the RowColumnPivotHierarchy.| +||[name](/.rowcolumnpivothierarchy#excel-javascript/api/excel/-rowcolumnpivothierarchy-name-member)|Name of the RowColumnPivotHierarchy.| +||[position](/.rowcolumnpivothierarchy#excel-javascript/api/excel/-rowcolumnpivothierarchy-position-member)|Position of the RowColumnPivotHierarchy.| +||[setToDefault()](/.rowcolumnpivothierarchy#excel-javascript/api/excel/-rowcolumnpivothierarchy-settodefault-member(1))|Reset the RowColumnPivotHierarchy back to its default values.| +|[RowColumnPivotHierarchyCollection](/.rowcolumnpivothierarchycollection)|[add(pivotHierarchy: Excel.PivotHierarchy)](/.rowcolumnpivothierarchycollection#excel-javascript/api/excel/-rowcolumnpivothierarchycollection-add-member(1))|Adds the PivotHierarchy to the current axis.| +||[getCount()](/.rowcolumnpivothierarchycollection#excel-javascript/api/excel/-rowcolumnpivothierarchycollection-getcount-member(1))|Gets the number of pivot hierarchies in the collection.| +||[getItem(name: string)](/.rowcolumnpivothierarchycollection#excel-javascript/api/excel/-rowcolumnpivothierarchycollection-getitem-member(1))|Gets a RowColumnPivotHierarchy by its name or ID.| +||[getItemOrNullObject(name: string)](/.rowcolumnpivothierarchycollection#excel-javascript/api/excel/-rowcolumnpivothierarchycollection-getitemornullobject-member(1))|Gets a RowColumnPivotHierarchy by name.| +||[items](/.rowcolumnpivothierarchycollection#excel-javascript/api/excel/-rowcolumnpivothierarchycollection-items-member)|Gets the loaded child items in this collection.| +||[remove(rowColumnPivotHierarchy: Excel.RowColumnPivotHierarchy)](/.rowcolumnpivothierarchycollection#excel-javascript/api/excel/-rowcolumnpivothierarchycollection-remove-member(1))|Removes the PivotHierarchy from the current axis.| +|[Runtime](/.runtime)|[enableEvents](/.runtime#excel-javascript/api/excel/-runtime-enableevents-member)|Toggle JavaScript events in the current task pane or content add-in.| +|[ShowAsRule](/.showasrule)|[baseField](/.showasrule#excel-javascript/api/excel/-showasrule-basefield-member)|The PivotField to base the `ShowAs` calculation on, if applicable according to the `ShowAsCalculation` type, else `null`.| +||[baseItem](/.showasrule#excel-javascript/api/excel/-showasrule-baseitem-member)|The item to base the `ShowAs` calculation on, if applicable according to the `ShowAsCalculation` type, else `null`.| +||[calculation](/.showasrule#excel-javascript/api/excel/-showasrule-calculation-member)|The `ShowAs` calculation to use for the PivotField.| +|[Style](/.style)|[autoIndent](/.style#excel-javascript/api/excel/-style-autoindent-member)|Specifies if text is automatically indented when the text alignment in a cell is set to equal distribution.| +||[textOrientation](/.style#excel-javascript/api/excel/-style-textorientation-member)|The text orientation for the style.| +|[Subtotals](/.subtotals)|[automatic](/.subtotals#excel-javascript/api/excel/-subtotals-automatic-member)|If `Automatic` is set to `true`, then all other values will be ignored when setting the `Subtotals`.| +||[average](/.subtotals#excel-javascript/api/excel/-subtotals-average-member)|| +||[count](/.subtotals#excel-javascript/api/excel/-subtotals-count-member)|| +||[countNumbers](/.subtotals#excel-javascript/api/excel/-subtotals-countnumbers-member)|| +||[max](/.subtotals#excel-javascript/api/excel/-subtotals-max-member)|| +||[min](/.subtotals#excel-javascript/api/excel/-subtotals-min-member)|| +||[product](/.subtotals#excel-javascript/api/excel/-subtotals-product-member)|| +||[standardDeviation](/.subtotals#excel-javascript/api/excel/-subtotals-standarddeviation-member)|| +||[standardDeviationP](/.subtotals#excel-javascript/api/excel/-subtotals-standarddeviationp-member)|| +||[sum](/.subtotals#excel-javascript/api/excel/-subtotals-sum-member)|| +||[variance](/.subtotals#excel-javascript/api/excel/-subtotals-variance-member)|| +||[varianceP](/.subtotals#excel-javascript/api/excel/-subtotals-variancep-member)|| +|[Table](/.table)|[legacyId](/.table#excel-javascript/api/excel/-table-legacyid-member)|Returns a numeric ID.| +|[TableChangedEventArgs](/.tablechangedeventargs)|[getRange(ctx: Excel.RequestContext)](/.tablechangedeventargs#excel-javascript/api/excel/-tablechangedeventargs-getrange-member(1))|Gets the range that represents the changed area of a table on a specific worksheet.| +||[getRangeOrNullObject(ctx: Excel.RequestContext)](/.tablechangedeventargs#excel-javascript/api/excel/-tablechangedeventargs-getrangeornullobject-member(1))|Gets the range that represents the changed area of a table on a specific worksheet.| +|[Workbook](/.workbook)|[readOnly](/.workbook#excel-javascript/api/excel/-workbook-readonly-member)|Returns `true` if the workbook is open in read-only mode.| +|[WorkbookCreated](/.workbookcreated)||| +|[Worksheet](/.worksheet)|[onCalculated](/.worksheet#excel-javascript/api/excel/-worksheet-oncalculated-member)|Occurs when the worksheet is calculated.| +||[showGridlines](/.worksheet#excel-javascript/api/excel/-worksheet-showgridlines-member)|Specifies if gridlines are visible to the user.| +||[showHeadings](/.worksheet#excel-javascript/api/excel/-worksheet-showheadings-member)|Specifies if headings are visible to the user.| +|[WorksheetCalculatedEventArgs](/.worksheetcalculatedeventargs)|[type](/.worksheetcalculatedeventargs#excel-javascript/api/excel/-worksheetcalculatedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/.worksheetcalculatedeventargs#excel-javascript/api/excel/-worksheetcalculatedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the calculation occurred.| +|[WorksheetChangedEventArgs](/.worksheetchangedeventargs)|[getRange(ctx: Excel.RequestContext)](/.worksheetchangedeventargs#excel-javascript/api/excel/-worksheetchangedeventargs-getrange-member(1))|Gets the range that represents the changed area of a specific worksheet.| +||[getRangeOrNullObject(ctx: Excel.RequestContext)](/.worksheetchangedeventargs#excel-javascript/api/excel/-worksheetchangedeventargs-getrangeornullobject-member(1))|Gets the range that represents the changed area of a specific worksheet.| +|[WorksheetCollection](/.worksheetcollection)|[onCalculated](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-oncalculated-member)|Occurs when any worksheet in the workbook is calculated.| diff --git a/docs/includes/excel-1_9.md b/docs/includes/excel-1_9.md index c144d700d1..f85fc97b84 100644 --- a/docs/includes/excel-1_9.md +++ b/docs/includes/excel-1_9.md @@ -1,450 +1,450 @@ | Class | Fields | Description | |:---|:---|:---| -|[Application](/javascript/api/excel/excel.application)|[calculationEngineVersion](/javascript/api/excel/excel.application#excel-excel-application-calculationengineversion-member)|Returns the Excel calculation engine version used for the last full recalculation.| -||[calculationState](/javascript/api/excel/excel.application#excel-excel-application-calculationstate-member)|Returns the calculation state of the application.| -||[iterativeCalculation](/javascript/api/excel/excel.application#excel-excel-application-iterativecalculation-member)|Returns the iterative calculation settings.| -||[suspendScreenUpdatingUntilNextSync()](/javascript/api/excel/excel.application#excel-excel-application-suspendscreenupdatinguntilnextsync-member(1))|Suspends screen updating until the next `context.sync()` is called.| -|[AutoFilter](/javascript/api/excel/excel.autofilter)|[apply(range: Range \| string, columnIndex?: number, criteria?: Excel.FilterCriteria)](/javascript/api/excel/excel.autofilter#excel-excel-autofilter-apply-member(1))|Applies the AutoFilter to a range.| -||[clearCriteria()](/javascript/api/excel/excel.autofilter#excel-excel-autofilter-clearcriteria-member(1))|Clears the filter criteria and sort state of the AutoFilter.| -||[criteria](/javascript/api/excel/excel.autofilter#excel-excel-autofilter-criteria-member)|An array that holds all the filter criteria in the autofiltered range.| -||[enabled](/javascript/api/excel/excel.autofilter#excel-excel-autofilter-enabled-member)|Specifies if the AutoFilter is enabled.| -||[getRange()](/javascript/api/excel/excel.autofilter#excel-excel-autofilter-getrange-member(1))|Returns the `Range` object that represents the range to which the AutoFilter applies.| -||[getRangeOrNullObject()](/javascript/api/excel/excel.autofilter#excel-excel-autofilter-getrangeornullobject-member(1))|Returns the `Range` object that represents the range to which the AutoFilter applies.| -||[isDataFiltered](/javascript/api/excel/excel.autofilter#excel-excel-autofilter-isdatafiltered-member)|Specifies if the AutoFilter has filter criteria.| -||[reapply()](/javascript/api/excel/excel.autofilter#excel-excel-autofilter-reapply-member(1))|Applies the specified AutoFilter object currently on the range.| -||[remove()](/javascript/api/excel/excel.autofilter#excel-excel-autofilter-remove-member(1))|Removes the AutoFilter for the range.| -|[CellBorder](/javascript/api/excel/excel.cellborder)|[color](/javascript/api/excel/excel.cellborder#excel-excel-cellborder-color-member)|Represents the `color` property of a single border.| -||[style](/javascript/api/excel/excel.cellborder#excel-excel-cellborder-style-member)|Represents the `style` property of a single border.| -||[tintAndShade](/javascript/api/excel/excel.cellborder#excel-excel-cellborder-tintandshade-member)|Represents the `tintAndShade` property of a single border.| -||[weight](/javascript/api/excel/excel.cellborder#excel-excel-cellborder-weight-member)|Represents the `weight` property of a single border.| -|[CellBorderCollection](/javascript/api/excel/excel.cellbordercollection)|[bottom](/javascript/api/excel/excel.cellbordercollection#excel-excel-cellbordercollection-bottom-member)|Represents the `format.borders.bottom` property.| -||[diagonalDown](/javascript/api/excel/excel.cellbordercollection#excel-excel-cellbordercollection-diagonaldown-member)|Represents the `format.borders.diagonalDown` property.| -||[diagonalUp](/javascript/api/excel/excel.cellbordercollection#excel-excel-cellbordercollection-diagonalup-member)|Represents the `format.borders.diagonalUp` property.| -||[horizontal](/javascript/api/excel/excel.cellbordercollection#excel-excel-cellbordercollection-horizontal-member)|Represents the `format.borders.horizontal` property.| -||[left](/javascript/api/excel/excel.cellbordercollection#excel-excel-cellbordercollection-left-member)|Represents the `format.borders.left` property.| -||[right](/javascript/api/excel/excel.cellbordercollection#excel-excel-cellbordercollection-right-member)|Represents the `format.borders.right` property.| -||[top](/javascript/api/excel/excel.cellbordercollection#excel-excel-cellbordercollection-top-member)|Represents the `format.borders.top` property.| -||[vertical](/javascript/api/excel/excel.cellbordercollection#excel-excel-cellbordercollection-vertical-member)|Represents the `format.borders.vertical` property.| -|[CellProperties](/javascript/api/excel/excel.cellproperties)|[address](/javascript/api/excel/excel.cellproperties#excel-excel-cellproperties-address-member)|Represents the `address` property.| -||[addressLocal](/javascript/api/excel/excel.cellproperties#excel-excel-cellproperties-addresslocal-member)|Represents the `addressLocal` property.| -||[hidden](/javascript/api/excel/excel.cellproperties#excel-excel-cellproperties-hidden-member)|Represents the `hidden` property.| -|[CellPropertiesFill](/javascript/api/excel/excel.cellpropertiesfill)|[color](/javascript/api/excel/excel.cellpropertiesfill#excel-excel-cellpropertiesfill-color-member)|Represents the `format.fill.color` property.| -||[pattern](/javascript/api/excel/excel.cellpropertiesfill#excel-excel-cellpropertiesfill-pattern-member)|Represents the `format.fill.pattern` property.| -||[patternColor](/javascript/api/excel/excel.cellpropertiesfill#excel-excel-cellpropertiesfill-patterncolor-member)|Represents the `format.fill.patternColor` property.| -||[patternTintAndShade](/javascript/api/excel/excel.cellpropertiesfill#excel-excel-cellpropertiesfill-patterntintandshade-member)|Represents the `format.fill.patternTintAndShade` property.| -||[tintAndShade](/javascript/api/excel/excel.cellpropertiesfill#excel-excel-cellpropertiesfill-tintandshade-member)|Represents the `format.fill.tintAndShade` property.| -|[CellPropertiesFont](/javascript/api/excel/excel.cellpropertiesfont)|[bold](/javascript/api/excel/excel.cellpropertiesfont#excel-excel-cellpropertiesfont-bold-member)|Represents the `format.font.bold` property.| -||[color](/javascript/api/excel/excel.cellpropertiesfont#excel-excel-cellpropertiesfont-color-member)|Represents the `format.font.color` property.| -||[italic](/javascript/api/excel/excel.cellpropertiesfont#excel-excel-cellpropertiesfont-italic-member)|Represents the `format.font.italic` property.| -||[name](/javascript/api/excel/excel.cellpropertiesfont#excel-excel-cellpropertiesfont-name-member)|Represents the `format.font.name` property.| -||[size](/javascript/api/excel/excel.cellpropertiesfont#excel-excel-cellpropertiesfont-size-member)|Represents the `format.font.size` property.| -||[strikethrough](/javascript/api/excel/excel.cellpropertiesfont#excel-excel-cellpropertiesfont-strikethrough-member)|Represents the `format.font.strikethrough` property.| -||[subscript](/javascript/api/excel/excel.cellpropertiesfont#excel-excel-cellpropertiesfont-subscript-member)|Represents the `format.font.subscript` property.| -||[superscript](/javascript/api/excel/excel.cellpropertiesfont#excel-excel-cellpropertiesfont-superscript-member)|Represents the `format.font.superscript` property.| -||[tintAndShade](/javascript/api/excel/excel.cellpropertiesfont#excel-excel-cellpropertiesfont-tintandshade-member)|Represents the `format.font.tintAndShade` property.| -||[underline](/javascript/api/excel/excel.cellpropertiesfont#excel-excel-cellpropertiesfont-underline-member)|Represents the `format.font.underline` property.| -|[CellPropertiesFormat](/javascript/api/excel/excel.cellpropertiesformat)|[autoIndent](/javascript/api/excel/excel.cellpropertiesformat#excel-excel-cellpropertiesformat-autoindent-member)|Represents the `autoIndent` property.| -||[borders](/javascript/api/excel/excel.cellpropertiesformat#excel-excel-cellpropertiesformat-borders-member)|Represents the `borders` property.| -||[fill](/javascript/api/excel/excel.cellpropertiesformat#excel-excel-cellpropertiesformat-fill-member)|Represents the `fill` property.| -||[font](/javascript/api/excel/excel.cellpropertiesformat#excel-excel-cellpropertiesformat-font-member)|Represents the `font` property.| -||[horizontalAlignment](/javascript/api/excel/excel.cellpropertiesformat#excel-excel-cellpropertiesformat-horizontalalignment-member)|Represents the `horizontalAlignment` property.| -||[indentLevel](/javascript/api/excel/excel.cellpropertiesformat#excel-excel-cellpropertiesformat-indentlevel-member)|Represents the `indentLevel` property.| -||[protection](/javascript/api/excel/excel.cellpropertiesformat#excel-excel-cellpropertiesformat-protection-member)|Represents the `protection` property.| -||[readingOrder](/javascript/api/excel/excel.cellpropertiesformat#excel-excel-cellpropertiesformat-readingorder-member)|Represents the `readingOrder` property.| -||[shrinkToFit](/javascript/api/excel/excel.cellpropertiesformat#excel-excel-cellpropertiesformat-shrinktofit-member)|Represents the `shrinkToFit` property.| -||[textOrientation](/javascript/api/excel/excel.cellpropertiesformat#excel-excel-cellpropertiesformat-textorientation-member)|Represents the `textOrientation` property.| -||[useStandardHeight](/javascript/api/excel/excel.cellpropertiesformat#excel-excel-cellpropertiesformat-usestandardheight-member)|Represents the `useStandardHeight` property.| -||[useStandardWidth](/javascript/api/excel/excel.cellpropertiesformat#excel-excel-cellpropertiesformat-usestandardwidth-member)|Represents the `useStandardWidth` property.| -||[verticalAlignment](/javascript/api/excel/excel.cellpropertiesformat#excel-excel-cellpropertiesformat-verticalalignment-member)|Represents the `verticalAlignment` property.| -||[wrapText](/javascript/api/excel/excel.cellpropertiesformat#excel-excel-cellpropertiesformat-wraptext-member)|Represents the `wrapText` property.| -|[CellPropertiesProtection](/javascript/api/excel/excel.cellpropertiesprotection)|[formulaHidden](/javascript/api/excel/excel.cellpropertiesprotection#excel-excel-cellpropertiesprotection-formulahidden-member)|Represents the `format.protection.formulaHidden` property.| -||[locked](/javascript/api/excel/excel.cellpropertiesprotection#excel-excel-cellpropertiesprotection-locked-member)|Represents the `format.protection.locked` property.| -|[ChangedEventDetail](/javascript/api/excel/excel.changedeventdetail)|[valueAfter](/javascript/api/excel/excel.changedeventdetail#excel-excel-changedeventdetail-valueafter-member)|Represents the value after the change.| -||[valueBefore](/javascript/api/excel/excel.changedeventdetail#excel-excel-changedeventdetail-valuebefore-member)|Represents the value before the change.| -||[valueTypeAfter](/javascript/api/excel/excel.changedeventdetail#excel-excel-changedeventdetail-valuetypeafter-member)|Represents the type of value after the change.| -||[valueTypeBefore](/javascript/api/excel/excel.changedeventdetail#excel-excel-changedeventdetail-valuetypebefore-member)|Represents the type of value before the change.| -|[Chart](/javascript/api/excel/excel.chart)|[activate()](/javascript/api/excel/excel.chart#excel-excel-chart-activate-member(1))|Activates the chart in the Excel UI.| -||[pivotOptions](/javascript/api/excel/excel.chart#excel-excel-chart-pivotoptions-member)|Encapsulates the options for a pivot chart.| -|[ChartAreaFormat](/javascript/api/excel/excel.chartareaformat)|[colorScheme](/javascript/api/excel/excel.chartareaformat#excel-excel-chartareaformat-colorscheme-member)|Specifies the color scheme of the chart.| -||[roundedCorners](/javascript/api/excel/excel.chartareaformat#excel-excel-chartareaformat-roundedcorners-member)|Specifies if the chart area of the chart has rounded corners.| -|[ChartAxis](/javascript/api/excel/excel.chartaxis)|[linkNumberFormat](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-linknumberformat-member)|Specifies if the number format is linked to the cells.| -|[ChartBinOptions](/javascript/api/excel/excel.chartbinoptions)|[allowOverflow](/javascript/api/excel/excel.chartbinoptions#excel-excel-chartbinoptions-allowoverflow-member)|Specifies if bin overflow is enabled in a histogram chart or pareto chart.| -||[allowUnderflow](/javascript/api/excel/excel.chartbinoptions#excel-excel-chartbinoptions-allowunderflow-member)|Specifies if bin underflow is enabled in a histogram chart or pareto chart.| -||[count](/javascript/api/excel/excel.chartbinoptions#excel-excel-chartbinoptions-count-member)|Specifies the bin count of a histogram chart or pareto chart.| -||[overflowValue](/javascript/api/excel/excel.chartbinoptions#excel-excel-chartbinoptions-overflowvalue-member)|Specifies the bin overflow value of a histogram chart or pareto chart.| -||[type](/javascript/api/excel/excel.chartbinoptions#excel-excel-chartbinoptions-type-member)|Specifies the bin's type for a histogram chart or pareto chart.| -||[underflowValue](/javascript/api/excel/excel.chartbinoptions#excel-excel-chartbinoptions-underflowvalue-member)|Specifies the bin underflow value of a histogram chart or pareto chart.| -||[width](/javascript/api/excel/excel.chartbinoptions#excel-excel-chartbinoptions-width-member)|Specifies the bin width value of a histogram chart or pareto chart.| -|[ChartBoxwhiskerOptions](/javascript/api/excel/excel.chartboxwhiskeroptions)|[quartileCalculation](/javascript/api/excel/excel.chartboxwhiskeroptions#excel-excel-chartboxwhiskeroptions-quartilecalculation-member)|Specifies if the quartile calculation type of a box and whisker chart.| -||[showInnerPoints](/javascript/api/excel/excel.chartboxwhiskeroptions#excel-excel-chartboxwhiskeroptions-showinnerpoints-member)|Specifies if inner points are shown in a box and whisker chart.| -||[showMeanLine](/javascript/api/excel/excel.chartboxwhiskeroptions#excel-excel-chartboxwhiskeroptions-showmeanline-member)|Specifies if the mean line is shown in a box and whisker chart.| -||[showMeanMarker](/javascript/api/excel/excel.chartboxwhiskeroptions#excel-excel-chartboxwhiskeroptions-showmeanmarker-member)|Specifies if the mean marker is shown in a box and whisker chart.| -||[showOutlierPoints](/javascript/api/excel/excel.chartboxwhiskeroptions#excel-excel-chartboxwhiskeroptions-showoutlierpoints-member)|Specifies if outlier points are shown in a box and whisker chart.| -|[ChartDataLabel](/javascript/api/excel/excel.chartdatalabel)|[linkNumberFormat](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-linknumberformat-member)|Specifies if the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells).| -|[ChartDataLabels](/javascript/api/excel/excel.chartdatalabels)|[linkNumberFormat](/javascript/api/excel/excel.chartdatalabels#excel-excel-chartdatalabels-linknumberformat-member)|Specifies if the number format is linked to the cells.| -|[ChartErrorBars](/javascript/api/excel/excel.charterrorbars)|[endStyleCap](/javascript/api/excel/excel.charterrorbars#excel-excel-charterrorbars-endstylecap-member)|Specifies if error bars have an end style cap.| -||[format](/javascript/api/excel/excel.charterrorbars#excel-excel-charterrorbars-format-member)|Specifies the formatting type of the error bars.| -||[include](/javascript/api/excel/excel.charterrorbars#excel-excel-charterrorbars-include-member)|Specifies which parts of the error bars to include.| -||[type](/javascript/api/excel/excel.charterrorbars#excel-excel-charterrorbars-type-member)|The type of range marked by the error bars.| -||[visible](/javascript/api/excel/excel.charterrorbars#excel-excel-charterrorbars-visible-member)|Specifies whether the error bars are displayed.| -|[ChartErrorBarsFormat](/javascript/api/excel/excel.charterrorbarsformat)|[line](/javascript/api/excel/excel.charterrorbarsformat#excel-excel-charterrorbarsformat-line-member)|Represents the chart line formatting.| -|[ChartMapOptions](/javascript/api/excel/excel.chartmapoptions)|[labelStrategy](/javascript/api/excel/excel.chartmapoptions#excel-excel-chartmapoptions-labelstrategy-member)|Specifies the series map labels strategy of a region map chart.| -||[level](/javascript/api/excel/excel.chartmapoptions#excel-excel-chartmapoptions-level-member)|Specifies the series mapping level of a region map chart.| -||[projectionType](/javascript/api/excel/excel.chartmapoptions#excel-excel-chartmapoptions-projectiontype-member)|Specifies the series projection type of a region map chart.| -|[ChartPivotOptions](/javascript/api/excel/excel.chartpivotoptions)|[showAxisFieldButtons](/javascript/api/excel/excel.chartpivotoptions#excel-excel-chartpivotoptions-showaxisfieldbuttons-member)|Specifies whether to display the axis field buttons on a PivotChart.| -||[showLegendFieldButtons](/javascript/api/excel/excel.chartpivotoptions#excel-excel-chartpivotoptions-showlegendfieldbuttons-member)|Specifies whether to display the legend field buttons on a PivotChart.| -||[showReportFilterFieldButtons](/javascript/api/excel/excel.chartpivotoptions#excel-excel-chartpivotoptions-showreportfilterfieldbuttons-member)|Specifies whether to display the report filter field buttons on a PivotChart.| -||[showValueFieldButtons](/javascript/api/excel/excel.chartpivotoptions#excel-excel-chartpivotoptions-showvaluefieldbuttons-member)|Specifies whether to display the show value field buttons on a PivotChart.| -|[ChartSeries](/javascript/api/excel/excel.chartseries)|[binOptions](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-binoptions-member)|Encapsulates the bin options for histogram charts and pareto charts.| -||[boxwhiskerOptions](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-boxwhiskeroptions-member)|Encapsulates the options for the box and whisker charts.| -||[bubbleScale](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-bubblescale-member)|This can be an integer value from 0 (zero) to 300, representing the percentage of the default size.| -||[gradientMaximumColor](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-gradientmaximumcolor-member)|Specifies the color for maximum value of a region map chart series.| -||[gradientMaximumType](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-gradientmaximumtype-member)|Specifies the type for maximum value of a region map chart series.| -||[gradientMaximumValue](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-gradientmaximumvalue-member)|Specifies the maximum value of a region map chart series.| -||[gradientMidpointColor](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-gradientmidpointcolor-member)|Specifies the color for the midpoint value of a region map chart series.| -||[gradientMidpointType](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-gradientmidpointtype-member)|Specifies the type for the midpoint value of a region map chart series.| -||[gradientMidpointValue](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-gradientmidpointvalue-member)|Specifies the midpoint value of a region map chart series.| -||[gradientMinimumColor](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-gradientminimumcolor-member)|Specifies the color for the minimum value of a region map chart series.| -||[gradientMinimumType](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-gradientminimumtype-member)|Specifies the type for the minimum value of a region map chart series.| -||[gradientMinimumValue](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-gradientminimumvalue-member)|Specifies the minimum value of a region map chart series.| -||[gradientStyle](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-gradientstyle-member)|Specifies the series gradient style of a region map chart.| -||[invertColor](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-invertcolor-member)|Specifies the fill color for negative data points in a series.| -||[mapOptions](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-mapoptions-member)|Encapsulates the options for a region map chart.| -||[parentLabelStrategy](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-parentlabelstrategy-member)|Specifies the series parent label strategy area for a treemap chart.| -||[showConnectorLines](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-showconnectorlines-member)|Specifies whether connector lines are shown in waterfall charts.| -||[showLeaderLines](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-showleaderlines-member)|Specifies whether leader lines are displayed for each data label in the series.| -||[splitValue](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-splitvalue-member)|Specifies the threshold value that separates two sections of either a pie-of-pie chart or a bar-of-pie chart.| -||[xErrorBars](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-xerrorbars-member)|Represents the error bar object of a chart series.| -||[yErrorBars](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-yerrorbars-member)|Represents the error bar object of a chart series.| -|[ChartTrendlineLabel](/javascript/api/excel/excel.charttrendlinelabel)|[linkNumberFormat](/javascript/api/excel/excel.charttrendlinelabel#excel-excel-charttrendlinelabel-linknumberformat-member)|Specifies if the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells).| -|[ColumnProperties](/javascript/api/excel/excel.columnproperties)|[address](/javascript/api/excel/excel.columnproperties#excel-excel-columnproperties-address-member)|Represents the `address` property.| -||[addressLocal](/javascript/api/excel/excel.columnproperties#excel-excel-columnproperties-addresslocal-member)|Represents the `addressLocal` property.| -||[columnIndex](/javascript/api/excel/excel.columnproperties#excel-excel-columnproperties-columnindex-member)|Represents the `columnIndex` property.| -|[ConditionalFormat](/javascript/api/excel/excel.conditionalformat)|[getRanges()](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-getranges-member(1))|Returns the `RangeAreas`, comprising one or more rectangular ranges, to which the conditional format is applied.| -|[DataValidation](/javascript/api/excel/excel.datavalidation)|[getInvalidCells()](/javascript/api/excel/excel.datavalidation#excel-excel-datavalidation-getinvalidcells-member(1))|Returns a `RangeAreas` object, comprising one or more rectangular ranges, with invalid cell values.| -||[getInvalidCellsOrNullObject()](/javascript/api/excel/excel.datavalidation#excel-excel-datavalidation-getinvalidcellsornullobject-member(1))|Returns a `RangeAreas` object, comprising one or more rectangular ranges, with invalid cell values.| -|[FilterCriteria](/javascript/api/excel/excel.filtercriteria)|[subField](/javascript/api/excel/excel.filtercriteria#excel-excel-filtercriteria-subfield-member)|The property used by the filter to do a rich filter on rich values.| -|[GeometricShape](/javascript/api/excel/excel.geometricshape)|[id](/javascript/api/excel/excel.geometricshape#excel-excel-geometricshape-id-member)|Returns the shape identifier.| -||[shape](/javascript/api/excel/excel.geometricshape#excel-excel-geometricshape-shape-member)|Returns the `Shape` object for the geometric shape.| -|[GroupShapeCollection](/javascript/api/excel/excel.groupshapecollection)|[getCount()](/javascript/api/excel/excel.groupshapecollection#excel-excel-groupshapecollection-getcount-member(1))|Returns the number of shapes in the shape group.| -||[getItem(key: string)](/javascript/api/excel/excel.groupshapecollection#excel-excel-groupshapecollection-getitem-member(1))|Gets a shape using its name or ID.| -||[getItemAt(index: number)](/javascript/api/excel/excel.groupshapecollection#excel-excel-groupshapecollection-getitemat-member(1))|Gets a shape based on its position in the collection.| -||[items](/javascript/api/excel/excel.groupshapecollection#excel-excel-groupshapecollection-items-member)|Gets the loaded child items in this collection.| -|[HeaderFooter](/javascript/api/excel/excel.headerfooter)|[centerFooter](/javascript/api/excel/excel.headerfooter#excel-excel-headerfooter-centerfooter-member)|The center footer of the worksheet.| -||[centerHeader](/javascript/api/excel/excel.headerfooter#excel-excel-headerfooter-centerheader-member)|The center header of the worksheet.| -||[leftFooter](/javascript/api/excel/excel.headerfooter#excel-excel-headerfooter-leftfooter-member)|The left footer of the worksheet.| -||[leftHeader](/javascript/api/excel/excel.headerfooter#excel-excel-headerfooter-leftheader-member)|The left header of the worksheet.| -||[rightFooter](/javascript/api/excel/excel.headerfooter#excel-excel-headerfooter-rightfooter-member)|The right footer of the worksheet.| -||[rightHeader](/javascript/api/excel/excel.headerfooter#excel-excel-headerfooter-rightheader-member)|The right header of the worksheet.| -|[HeaderFooterGroup](/javascript/api/excel/excel.headerfootergroup)|[defaultForAllPages](/javascript/api/excel/excel.headerfootergroup#excel-excel-headerfootergroup-defaultforallpages-member)|The general header/footer, used for all pages unless even/odd or first page is specified.| -||[evenPages](/javascript/api/excel/excel.headerfootergroup#excel-excel-headerfootergroup-evenpages-member)|The header/footer to use for even pages, odd header/footer needs to be specified for odd pages.| -||[firstPage](/javascript/api/excel/excel.headerfootergroup#excel-excel-headerfootergroup-firstpage-member)|The first page header/footer, for all other pages general or even/odd is used.| -||[oddPages](/javascript/api/excel/excel.headerfootergroup#excel-excel-headerfootergroup-oddpages-member)|The header/footer to use for odd pages, even header/footer needs to be specified for even pages.| -||[state](/javascript/api/excel/excel.headerfootergroup#excel-excel-headerfootergroup-state-member)|The state by which headers/footers are set.| -||[useSheetMargins](/javascript/api/excel/excel.headerfootergroup#excel-excel-headerfootergroup-usesheetmargins-member)|Gets or sets a flag indicating if headers/footers are aligned with the page margins set in the page layout options for the worksheet.| -||[useSheetScale](/javascript/api/excel/excel.headerfootergroup#excel-excel-headerfootergroup-usesheetscale-member)|Gets or sets a flag indicating if headers/footers should be scaled by the page percentage scale set in the page layout options for the worksheet.| -|[Image](/javascript/api/excel/excel.image)|[format](/javascript/api/excel/excel.image#excel-excel-image-format-member)|Returns the format of the image.| -||[id](/javascript/api/excel/excel.image#excel-excel-image-id-member)|Specifies the shape identifier for the image object.| -||[shape](/javascript/api/excel/excel.image#excel-excel-image-shape-member)|Returns the `Shape` object associated with the image.| -|[IterativeCalculation](/javascript/api/excel/excel.iterativecalculation)|[enabled](/javascript/api/excel/excel.iterativecalculation#excel-excel-iterativecalculation-enabled-member)|True if Excel will use iteration to resolve circular references.| -||[maxChange](/javascript/api/excel/excel.iterativecalculation#excel-excel-iterativecalculation-maxchange-member)|Specifies the maximum amount of change between each iteration as Excel resolves circular references.| -||[maxIteration](/javascript/api/excel/excel.iterativecalculation#excel-excel-iterativecalculation-maxiteration-member)|Specifies the maximum number of iterations that Excel can use to resolve a circular reference.| -|[Line](/javascript/api/excel/excel.line)|[beginArrowheadLength](/javascript/api/excel/excel.line#excel-excel-line-beginarrowheadlength-member)|Represents the length of the arrowhead at the beginning of the specified line.| -||[beginArrowheadStyle](/javascript/api/excel/excel.line#excel-excel-line-beginarrowheadstyle-member)|Represents the style of the arrowhead at the beginning of the specified line.| -||[beginArrowheadWidth](/javascript/api/excel/excel.line#excel-excel-line-beginarrowheadwidth-member)|Represents the width of the arrowhead at the beginning of the specified line.| -||[beginConnectedShape](/javascript/api/excel/excel.line#excel-excel-line-beginconnectedshape-member)|Represents the shape to which the beginning of the specified line is attached.| -||[beginConnectedSite](/javascript/api/excel/excel.line#excel-excel-line-beginconnectedsite-member)|Represents the connection site to which the beginning of a connector is connected.| -||[connectBeginShape(shape: Excel.Shape, connectionSite: number)](/javascript/api/excel/excel.line#excel-excel-line-connectbeginshape-member(1))|Attaches the beginning of the specified connector to a specified shape.| -||[connectEndShape(shape: Excel.Shape, connectionSite: number)](/javascript/api/excel/excel.line#excel-excel-line-connectendshape-member(1))|Attaches the end of the specified connector to a specified shape.| -||[connectorType](/javascript/api/excel/excel.line#excel-excel-line-connectortype-member)|Represents the connector type for the line.| -||[disconnectBeginShape()](/javascript/api/excel/excel.line#excel-excel-line-disconnectbeginshape-member(1))|Detaches the beginning of the specified connector from a shape.| -||[disconnectEndShape()](/javascript/api/excel/excel.line#excel-excel-line-disconnectendshape-member(1))|Detaches the end of the specified connector from a shape.| -||[endArrowheadLength](/javascript/api/excel/excel.line#excel-excel-line-endarrowheadlength-member)|Represents the length of the arrowhead at the end of the specified line.| -||[endArrowheadStyle](/javascript/api/excel/excel.line#excel-excel-line-endarrowheadstyle-member)|Represents the style of the arrowhead at the end of the specified line.| -||[endArrowheadWidth](/javascript/api/excel/excel.line#excel-excel-line-endarrowheadwidth-member)|Represents the width of the arrowhead at the end of the specified line.| -||[endConnectedShape](/javascript/api/excel/excel.line#excel-excel-line-endconnectedshape-member)|Represents the shape to which the end of the specified line is attached.| -||[endConnectedSite](/javascript/api/excel/excel.line#excel-excel-line-endconnectedsite-member)|Represents the connection site to which the end of a connector is connected.| -||[id](/javascript/api/excel/excel.line#excel-excel-line-id-member)|Specifies the shape identifier.| -||[isBeginConnected](/javascript/api/excel/excel.line#excel-excel-line-isbeginconnected-member)|Specifies if the beginning of the specified line is connected to a shape.| -||[isEndConnected](/javascript/api/excel/excel.line#excel-excel-line-isendconnected-member)|Specifies if the end of the specified line is connected to a shape.| -||[shape](/javascript/api/excel/excel.line#excel-excel-line-shape-member)|Returns the `Shape` object associated with the line.| -|[PageBreak](/javascript/api/excel/excel.pagebreak)|[columnIndex](/javascript/api/excel/excel.pagebreak#excel-excel-pagebreak-columnindex-member)|Specifies the column index for the page break.| -||[delete()](/javascript/api/excel/excel.pagebreak#excel-excel-pagebreak-delete-member(1))|Deletes a page break object.| -||[getCellAfterBreak()](/javascript/api/excel/excel.pagebreak#excel-excel-pagebreak-getcellafterbreak-member(1))|Gets the first cell after the page break.| -||[rowIndex](/javascript/api/excel/excel.pagebreak#excel-excel-pagebreak-rowindex-member)|Specifies the row index for the page break.| -|[PageBreakCollection](/javascript/api/excel/excel.pagebreakcollection)|[add(pageBreakRange: Range \| string)](/javascript/api/excel/excel.pagebreakcollection#excel-excel-pagebreakcollection-add-member(1))|Adds a page break before the top-left cell of the range specified.| -||[getCount()](/javascript/api/excel/excel.pagebreakcollection#excel-excel-pagebreakcollection-getcount-member(1))|Gets the number of page breaks in the collection.| -||[getItem(index: number)](/javascript/api/excel/excel.pagebreakcollection#excel-excel-pagebreakcollection-getitem-member(1))|Gets a page break object via the index.| -||[items](/javascript/api/excel/excel.pagebreakcollection#excel-excel-pagebreakcollection-items-member)|Gets the loaded child items in this collection.| -||[removePageBreaks()](/javascript/api/excel/excel.pagebreakcollection#excel-excel-pagebreakcollection-removepagebreaks-member(1))|Resets all manual page breaks in the collection.| -|[PageLayout](/javascript/api/excel/excel.pagelayout)|[blackAndWhite](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-blackandwhite-member)|The worksheet's black and white print option.| -||[bottomMargin](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-bottommargin-member)|The worksheet's bottom page margin to use for printing in points.| -||[centerHorizontally](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-centerhorizontally-member)|The worksheet's center horizontally flag.| -||[centerVertically](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-centervertically-member)|The worksheet's center vertically flag.| -||[draftMode](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-draftmode-member)|The worksheet's draft mode option.| -||[firstPageNumber](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-firstpagenumber-member)|The worksheet's first page number to print.| -||[footerMargin](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-footermargin-member)|The worksheet's footer margin, in points, for use when printing.| -||[getPrintArea()](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-getprintarea-member(1))|Gets the `RangeAreas` object, comprising one or more rectangular ranges, that represents the print area for the worksheet.| -||[getPrintAreaOrNullObject()](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-getprintareaornullobject-member(1))|Gets the `RangeAreas` object, comprising one or more rectangular ranges, that represents the print area for the worksheet.| -||[getPrintTitleColumns()](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-getprinttitlecolumns-member(1))|Gets the range object representing the title columns.| -||[getPrintTitleColumnsOrNullObject()](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-getprinttitlecolumnsornullobject-member(1))|Gets the range object representing the title columns.| -||[getPrintTitleRows()](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-getprinttitlerows-member(1))|Gets the range object representing the title rows.| -||[getPrintTitleRowsOrNullObject()](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-getprinttitlerowsornullobject-member(1))|Gets the range object representing the title rows.| -||[headerMargin](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-headermargin-member)|The worksheet's header margin, in points, for use when printing.| -||[headersFooters](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-headersfooters-member)|Header and footer configuration for the worksheet.| -||[leftMargin](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-leftmargin-member)|The worksheet's left margin, in points, for use when printing.| -||[orientation](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-orientation-member)|The worksheet's orientation of the page.| -||[paperSize](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-papersize-member)|The worksheet's paper size of the page.| -||[printComments](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-printcomments-member)|Specifies if the worksheet's comments should be displayed when printing.| -||[printErrors](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-printerrors-member)|The worksheet's print errors option.| -||[printGridlines](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-printgridlines-member)|Specifies if the worksheet's gridlines will be printed.| -||[printHeadings](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-printheadings-member)|Specifies if the worksheet's headings will be printed.| -||[printOrder](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-printorder-member)|The worksheet's page print order option.| -||[rightMargin](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-rightmargin-member)|The worksheet's right margin, in points, for use when printing.| -||[setPrintArea(printArea: Range \| RangeAreas \| string)](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-setprintarea-member(1))|Sets the worksheet's print area.| -||[setPrintMargins(unit: Excel.PrintMarginUnit, marginOptions: Excel.PageLayoutMarginOptions)](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-setprintmargins-member(1))|Sets the worksheet's page margins with units.| -||[setPrintTitleColumns(printTitleColumns: Range \| string)](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-setprinttitlecolumns-member(1))|Sets the columns that contain the cells to be repeated at the left of each page of the worksheet for printing.| -||[setPrintTitleRows(printTitleRows: Range \| string)](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-setprinttitlerows-member(1))|Sets the rows that contain the cells to be repeated at the top of each page of the worksheet for printing.| -||[topMargin](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-topmargin-member)|The worksheet's top margin, in points, for use when printing.| -||[zoom](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-zoom-member)|The worksheet's print zoom options.| -|[PageLayoutMarginOptions](/javascript/api/excel/excel.pagelayoutmarginoptions)|[bottom](/javascript/api/excel/excel.pagelayoutmarginoptions#excel-excel-pagelayoutmarginoptions-bottom-member)|Specifies the page layout bottom margin in the unit specified to use for printing.| -||[footer](/javascript/api/excel/excel.pagelayoutmarginoptions#excel-excel-pagelayoutmarginoptions-footer-member)|Specifies the page layout footer margin in the unit specified to use for printing.| -||[header](/javascript/api/excel/excel.pagelayoutmarginoptions#excel-excel-pagelayoutmarginoptions-header-member)|Specifies the page layout header margin in the unit specified to use for printing.| -||[left](/javascript/api/excel/excel.pagelayoutmarginoptions#excel-excel-pagelayoutmarginoptions-left-member)|Specifies the page layout left margin in the unit specified to use for printing.| -||[right](/javascript/api/excel/excel.pagelayoutmarginoptions#excel-excel-pagelayoutmarginoptions-right-member)|Specifies the page layout right margin in the unit specified to use for printing.| -||[top](/javascript/api/excel/excel.pagelayoutmarginoptions#excel-excel-pagelayoutmarginoptions-top-member)|Specifies the page layout top margin in the unit specified to use for printing.| -|[PageLayoutZoomOptions](/javascript/api/excel/excel.pagelayoutzoomoptions)|[horizontalFitToPages](/javascript/api/excel/excel.pagelayoutzoomoptions#excel-excel-pagelayoutzoomoptions-horizontalfittopages-member)|Number of pages to fit horizontally.| -||[scale](/javascript/api/excel/excel.pagelayoutzoomoptions#excel-excel-pagelayoutzoomoptions-scale-member)|Print page scale value can be between 10 and 400.| -||[verticalFitToPages](/javascript/api/excel/excel.pagelayoutzoomoptions#excel-excel-pagelayoutzoomoptions-verticalfittopages-member)|Number of pages to fit vertically.| -|[PivotField](/javascript/api/excel/excel.pivotfield)|[sortByValues(sortBy: Excel.SortBy, valuesHierarchy: Excel.DataPivotHierarchy, pivotItemScope?: Array)](/javascript/api/excel/excel.pivotfield#excel-excel-pivotfield-sortbyvalues-member(1))|Sorts the PivotField by specified values in a given scope.| -|[PivotLayout](/javascript/api/excel/excel.pivotlayout)|[autoFormat](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-autoformat-member)|Specifies if formatting will be automatically formatted when it's refreshed or when fields are moved.| -||[getDataHierarchy(cell: Range \| string)](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-getdatahierarchy-member(1))|Gets the DataHierarchy that is used to calculate the value in a specified range within the PivotTable.| -||[getPivotItems(axis: Excel.PivotAxis, cell: Range \| string)](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-getpivotitems-member(1))|Gets the PivotItems from an axis that make up the value in a specified range within the PivotTable.| -||[preserveFormatting](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-preserveformatting-member)|Specifies if formatting is preserved when the report is refreshed or recalculated by operations such as pivoting, sorting, or changing page field items.| -||[setAutoSortOnCell(cell: Range \| string, sortBy: Excel.SortBy)](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-setautosortoncell-member(1))|Sets the PivotTable to automatically sort using the specified cell to automatically select all necessary criteria and context.| -|[PivotTable](/javascript/api/excel/excel.pivottable)|[enableDataValueEditing](/javascript/api/excel/excel.pivottable#excel-excel-pivottable-enabledatavalueediting-member)|Specifies if the PivotTable allows values in the data body to be edited by the user.| -||[useCustomSortLists](/javascript/api/excel/excel.pivottable#excel-excel-pivottable-usecustomsortlists-member)|Specifies if the PivotTable uses custom lists when sorting.| -|[Range](/javascript/api/excel/excel.range)|[autoFill(destinationRange?: Range \| string, autoFillType?: Excel.AutoFillType)](/javascript/api/excel/excel.range#excel-excel-range-autofill-member(1))|Fills a range from the current range to the destination range using the specified AutoFill logic.| -||[convertDataTypeToText()](/javascript/api/excel/excel.range#excel-excel-range-convertdatatypetotext-member(1))|Converts the range cells with data types into text.| -||[convertToLinkedDataType(serviceID: number, languageCulture: string)](/javascript/api/excel/excel.range#excel-excel-range-converttolinkeddatatype-member(1))|Converts the range cells into linked data types in the worksheet.| -||[copyFrom(sourceRange: Range \| RangeAreas \| string, copyType?: Excel.RangeCopyType, skipBlanks?: boolean, transpose?: boolean)](/javascript/api/excel/excel.range#excel-excel-range-copyfrom-member(1))|Copies cell data or formatting from the source range or `RangeAreas` to the current range.| -||[find(text: string, criteria: Excel.SearchCriteria)](/javascript/api/excel/excel.range#excel-excel-range-find-member(1))|Finds the given string based on the criteria specified.| -||[findOrNullObject(text: string, criteria: Excel.SearchCriteria)](/javascript/api/excel/excel.range#excel-excel-range-findornullobject-member(1))|Finds the given string based on the criteria specified.| -||[flashFill()](/javascript/api/excel/excel.range#excel-excel-range-flashfill-member(1))|Does a Flash Fill to the current range.| -||[getCellProperties(cellPropertiesLoadOptions: CellPropertiesLoadOptions)](/javascript/api/excel/excel.range#excel-excel-range-getcellproperties-member(1))|Returns a 2D array, encapsulating the data for each cell's font, fill, borders, alignment, and other properties.| -||[getColumnProperties(columnPropertiesLoadOptions: ColumnPropertiesLoadOptions)](/javascript/api/excel/excel.range#excel-excel-range-getcolumnproperties-member(1))|Returns a single-dimensional array, encapsulating the data for each column's font, fill, borders, alignment, and other properties.| -||[getRowProperties(rowPropertiesLoadOptions: RowPropertiesLoadOptions)](/javascript/api/excel/excel.range#excel-excel-range-getrowproperties-member(1))|Returns a single-dimensional array, encapsulating the data for each row's font, fill, borders, alignment, and other properties.| -||[getSpecialCells(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType)](/javascript/api/excel/excel.range#excel-excel-range-getspecialcells-member(1))|Gets the `RangeAreas` object, comprising one or more rectangular ranges, that represents all the cells that match the specified type and value.| -||[getSpecialCellsOrNullObject(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType)](/javascript/api/excel/excel.range#excel-excel-range-getspecialcellsornullobject-member(1))|Gets the `RangeAreas` object, comprising one or more ranges, that represents all the cells that match the specified type and value.| -||[getTables(fullyContained?: boolean)](/javascript/api/excel/excel.range#excel-excel-range-gettables-member(1))|Gets a scoped collection of tables that overlap with the range.| -||[linkedDataTypeState](/javascript/api/excel/excel.range#excel-excel-range-linkeddatatypestate-member)|Represents the data type state of each cell.| -||[removeDuplicates(columns: number[], includesHeader: boolean)](/javascript/api/excel/excel.range#excel-excel-range-removeduplicates-member(1))|Removes duplicate values from the range specified by the columns.| -||[replaceAll(text: string, replacement: string, criteria: Excel.ReplaceCriteria)](/javascript/api/excel/excel.range#excel-excel-range-replaceall-member(1))|Finds and replaces the given string based on the criteria specified within the current range.| -||[setCellProperties(cellPropertiesData: SettableCellProperties[][])](/javascript/api/excel/excel.range#excel-excel-range-setcellproperties-member(1))|Updates the range based on a 2D array of cell properties, encapsulating things like font, fill, borders, and alignment.| -||[setColumnProperties(columnPropertiesData: SettableColumnProperties[])](/javascript/api/excel/excel.range#excel-excel-range-setcolumnproperties-member(1))|Updates the range based on a single-dimensional array of column properties, encapsulating things like font, fill, borders, and alignment.| -||[setDirty()](/javascript/api/excel/excel.range#excel-excel-range-setdirty-member(1))|Set a range to be recalculated when the next recalculation occurs.| -||[setRowProperties(rowPropertiesData: SettableRowProperties[])](/javascript/api/excel/excel.range#excel-excel-range-setrowproperties-member(1))|Updates the range based on a single-dimensional array of row properties, encapsulating things like font, fill, borders, and alignment.| -|[RangeAreas](/javascript/api/excel/excel.rangeareas)|[address](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-address-member)|Returns the `RangeAreas` reference in A1-style.| -||[addressLocal](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-addresslocal-member)|Returns the `RangeAreas` reference in the user locale.| -||[areaCount](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-areacount-member)|Returns the number of rectangular ranges that comprise this `RangeAreas` object.| -||[areas](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-areas-member)|Returns a collection of rectangular ranges that comprise this `RangeAreas` object.| -||[calculate()](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-calculate-member(1))|Calculates all cells in the `RangeAreas`.| -||[cellCount](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-cellcount-member)|Returns the number of cells in the `RangeAreas` object, summing up the cell counts of all of the individual rectangular ranges.| -||[clear(applyTo?: Excel.ClearApplyTo)](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-clear-member(1))|Clears values, format, fill, border, and other properties on each of the areas that comprise this `RangeAreas` object.| -||[conditionalFormats](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-conditionalformats-member)|Returns a collection of conditional formats that intersect with any cells in this `RangeAreas` object.| -||[convertDataTypeToText()](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-convertdatatypetotext-member(1))|Converts all cells in the `RangeAreas` with data types into text.| -||[convertToLinkedDataType(serviceID: number, languageCulture: string)](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-converttolinkeddatatype-member(1))|Converts all cells in the `RangeAreas` into linked data types.| -||[copyFrom(sourceRange: Range \| RangeAreas \| string, copyType?: Excel.RangeCopyType, skipBlanks?: boolean, transpose?: boolean)](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-copyfrom-member(1))|Copies cell data or formatting from the source range or `RangeAreas` to the current `RangeAreas`.| -||[dataValidation](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-datavalidation-member)|Returns a data validation object for all ranges in the `RangeAreas`.| -||[format](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-format-member)|Returns a `RangeFormat` object, encapsulating the font, fill, borders, alignment, and other properties for all ranges in the `RangeAreas` object.| -||[getEntireColumn()](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-getentirecolumn-member(1))|Returns a `RangeAreas` object that represents the entire columns of the `RangeAreas` (for example, if the current `RangeAreas` represents cells "B4:E11, H2", it returns a `RangeAreas` that represents columns "B:E, H:H").| -||[getEntireRow()](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-getentirerow-member(1))|Returns a `RangeAreas` object that represents the entire rows of the `RangeAreas` (for example, if the current `RangeAreas` represents cells "B4:E11", it returns a `RangeAreas` that represents rows "4:11").| -||[getIntersection(anotherRange: Range \| RangeAreas \| string)](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-getintersection-member(1))|Returns the `RangeAreas` object that represents the intersection of the given ranges or `RangeAreas`.| -||[getIntersectionOrNullObject(anotherRange: Range \| RangeAreas \| string)](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-getintersectionornullobject-member(1))|Returns the `RangeAreas` object that represents the intersection of the given ranges or `RangeAreas`.| -||[getOffsetRangeAreas(rowOffset: number, columnOffset: number)](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-getoffsetrangeareas-member(1))|Returns a `RangeAreas` object that is shifted by the specific row and column offset.| -||[getSpecialCells(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType)](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-getspecialcells-member(1))|Returns a `RangeAreas` object that represents all the cells that match the specified type and value.| -||[getSpecialCellsOrNullObject(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType)](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-getspecialcellsornullobject-member(1))|Returns a `RangeAreas` object that represents all the cells that match the specified type and value.| -||[getTables(fullyContained?: boolean)](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-gettables-member(1))|Returns a scoped collection of tables that overlap with any range in this `RangeAreas` object.| -||[getUsedRangeAreas(valuesOnly?: boolean)](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-getusedrangeareas-member(1))|Returns the used `RangeAreas` that comprises all the used areas of individual rectangular ranges in the `RangeAreas` object.| -||[getUsedRangeAreasOrNullObject(valuesOnly?: boolean)](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-getusedrangeareasornullobject-member(1))|Returns the used `RangeAreas` that comprises all the used areas of individual rectangular ranges in the `RangeAreas` object.| -||[isEntireColumn](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-isentirecolumn-member)|Specifies if all the ranges on this `RangeAreas` object represent entire columns (e.g., "A:C, Q:Z").| -||[isEntireRow](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-isentirerow-member)|Specifies if all the ranges on this `RangeAreas` object represent entire rows (e.g., "1:3, 5:7").| -||[setDirty()](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-setdirty-member(1))|Sets the `RangeAreas` to be recalculated when the next recalculation occurs.| -||[style](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-style-member)|Represents the style for all ranges in this `RangeAreas` object.| -||[worksheet](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-worksheet-member)|Returns the worksheet for the current `RangeAreas`.| -|[RangeBorder](/javascript/api/excel/excel.rangeborder)|[tintAndShade](/javascript/api/excel/excel.rangeborder#excel-excel-rangeborder-tintandshade-member)|Specifies a double that lightens or darkens a color for the range border, the value is between -1 (darkest) and 1 (brightest), with 0 for the original color.| -|[RangeBorderCollection](/javascript/api/excel/excel.rangebordercollection)|[tintAndShade](/javascript/api/excel/excel.rangebordercollection#excel-excel-rangebordercollection-tintandshade-member)|Specifies a double that lightens or darkens a color for range borders.| -|[RangeCollection](/javascript/api/excel/excel.rangecollection)|[getCount()](/javascript/api/excel/excel.rangecollection#excel-excel-rangecollection-getcount-member(1))|Returns the number of ranges in the `RangeCollection`.| -||[getItemAt(index: number)](/javascript/api/excel/excel.rangecollection#excel-excel-rangecollection-getitemat-member(1))|Returns the range object based on its position in the `RangeCollection`.| -||[items](/javascript/api/excel/excel.rangecollection#excel-excel-rangecollection-items-member)|Gets the loaded child items in this collection.| -|[RangeFill](/javascript/api/excel/excel.rangefill)|[pattern](/javascript/api/excel/excel.rangefill#excel-excel-rangefill-pattern-member)|The pattern of a range.| -||[patternColor](/javascript/api/excel/excel.rangefill#excel-excel-rangefill-patterncolor-member)|The HTML color code representing the color of the range pattern, in the form #RRGGBB (e.g., "FFA500"), or as a named HTML color (e.g., "orange").| -||[patternTintAndShade](/javascript/api/excel/excel.rangefill#excel-excel-rangefill-patterntintandshade-member)|Specifies a double that lightens or darkens a pattern color for the range fill.| -||[tintAndShade](/javascript/api/excel/excel.rangefill#excel-excel-rangefill-tintandshade-member)|Specifies a double that lightens or darkens a color for the range fill.| -|[RangeFont](/javascript/api/excel/excel.rangefont)|[strikethrough](/javascript/api/excel/excel.rangefont#excel-excel-rangefont-strikethrough-member)|Specifies the strikethrough status of font.| -||[subscript](/javascript/api/excel/excel.rangefont#excel-excel-rangefont-subscript-member)|Specifies the subscript status of font.| -||[superscript](/javascript/api/excel/excel.rangefont#excel-excel-rangefont-superscript-member)|Specifies the superscript status of font.| -||[tintAndShade](/javascript/api/excel/excel.rangefont#excel-excel-rangefont-tintandshade-member)|Specifies a double that lightens or darkens a color for the range font.| -|[RangeFormat](/javascript/api/excel/excel.rangeformat)|[autoIndent](/javascript/api/excel/excel.rangeformat#excel-excel-rangeformat-autoindent-member)|Specifies if text is automatically indented when text alignment is set to equal distribution.| -||[indentLevel](/javascript/api/excel/excel.rangeformat#excel-excel-rangeformat-indentlevel-member)|An integer from 0 to 250 that indicates the indent level.| -||[readingOrder](/javascript/api/excel/excel.rangeformat#excel-excel-rangeformat-readingorder-member)|The reading order for the range.| -||[shrinkToFit](/javascript/api/excel/excel.rangeformat#excel-excel-rangeformat-shrinktofit-member)|Specifies if text automatically shrinks to fit in the available column width.| -|[RemoveDuplicatesResult](/javascript/api/excel/excel.removeduplicatesresult)|[removed](/javascript/api/excel/excel.removeduplicatesresult#excel-excel-removeduplicatesresult-removed-member)|Number of duplicated rows removed by the operation.| -||[uniqueRemaining](/javascript/api/excel/excel.removeduplicatesresult#excel-excel-removeduplicatesresult-uniqueremaining-member)|Number of remaining unique rows present in the resulting range.| -|[ReplaceCriteria](/javascript/api/excel/excel.replacecriteria)|[completeMatch](/javascript/api/excel/excel.replacecriteria#excel-excel-replacecriteria-completematch-member)|Specifies if the match needs to be complete or partial.| -||[matchCase](/javascript/api/excel/excel.replacecriteria#excel-excel-replacecriteria-matchcase-member)|Specifies if the match is case-sensitive.| -|[RowProperties](/javascript/api/excel/excel.rowproperties)|[address](/javascript/api/excel/excel.rowproperties#excel-excel-rowproperties-address-member)|Represents the `address` property.| -||[addressLocal](/javascript/api/excel/excel.rowproperties#excel-excel-rowproperties-addresslocal-member)|Represents the `addressLocal` property.| -||[rowIndex](/javascript/api/excel/excel.rowproperties#excel-excel-rowproperties-rowindex-member)|Represents the `rowIndex` property.| -|[SearchCriteria](/javascript/api/excel/excel.searchcriteria)|[completeMatch](/javascript/api/excel/excel.searchcriteria#excel-excel-searchcriteria-completematch-member)|Specifies if the match needs to be complete or partial.| -||[matchCase](/javascript/api/excel/excel.searchcriteria#excel-excel-searchcriteria-matchcase-member)|Specifies if the match is case-sensitive.| -||[searchDirection](/javascript/api/excel/excel.searchcriteria#excel-excel-searchcriteria-searchdirection-member)|Specifies the search direction.| -|[SettableCellProperties](/javascript/api/excel/excel.settablecellproperties)|[format](/javascript/api/excel/excel.settablecellproperties#excel-excel-settablecellproperties-format-member)|Represents the `format` property.| -||[hyperlink](/javascript/api/excel/excel.settablecellproperties#excel-excel-settablecellproperties-hyperlink-member)|Represents the `hyperlink` property.| -||[style](/javascript/api/excel/excel.settablecellproperties#excel-excel-settablecellproperties-style-member)|Represents the `style` property.| -|[SettableColumnProperties](/javascript/api/excel/excel.settablecolumnproperties)|[columnHidden](/javascript/api/excel/excel.settablecolumnproperties#excel-excel-settablecolumnproperties-columnhidden-member)|Represents the `columnHidden` property.| -||[format](/javascript/api/excel/excel.settablecolumnproperties#excel-excel-settablecolumnproperties-format-member)|Represents the `format` property.| -|[SettableRowProperties](/javascript/api/excel/excel.settablerowproperties)|[format](/javascript/api/excel/excel.settablerowproperties#excel-excel-settablerowproperties-format-member)|Represents the `format` property.| -||[rowHidden](/javascript/api/excel/excel.settablerowproperties#excel-excel-settablerowproperties-rowhidden-member)|Represents the `rowHidden` property.| -|[Shape](/javascript/api/excel/excel.shape)|[altTextDescription](/javascript/api/excel/excel.shape#excel-excel-shape-alttextdescription-member)|Specifies the alternative description text for a `Shape` object.| -||[altTextTitle](/javascript/api/excel/excel.shape#excel-excel-shape-alttexttitle-member)|Specifies the alternative title text for a `Shape` object.| -||[connectionSiteCount](/javascript/api/excel/excel.shape#excel-excel-shape-connectionsitecount-member)|Returns the number of connection sites on this shape.| -||[delete()](/javascript/api/excel/excel.shape#excel-excel-shape-delete-member(1))|Removes the shape from the worksheet.| -||[fill](/javascript/api/excel/excel.shape#excel-excel-shape-fill-member)|Returns the fill formatting of this shape.| -||[geometricShape](/javascript/api/excel/excel.shape#excel-excel-shape-geometricshape-member)|Returns the geometric shape associated with the shape.| -||[geometricShapeType](/javascript/api/excel/excel.shape#excel-excel-shape-geometricshapetype-member)|Specifies the geometric shape type of this geometric shape.| -||[getAsImage(format: Excel.PictureFormat)](/javascript/api/excel/excel.shape#excel-excel-shape-getasimage-member(1))|Converts the shape to an image and returns the image as a Base64-encoded string.| -||[group](/javascript/api/excel/excel.shape#excel-excel-shape-group-member)|Returns the shape group associated with the shape.| -||[height](/javascript/api/excel/excel.shape#excel-excel-shape-height-member)|Specifies the height, in points, of the shape.| -||[id](/javascript/api/excel/excel.shape#excel-excel-shape-id-member)|Specifies the shape identifier.| -||[image](/javascript/api/excel/excel.shape#excel-excel-shape-image-member)|Returns the image associated with the shape.| -||[incrementLeft(increment: number)](/javascript/api/excel/excel.shape#excel-excel-shape-incrementleft-member(1))|Moves the shape horizontally by the specified number of points.| -||[incrementRotation(increment: number)](/javascript/api/excel/excel.shape#excel-excel-shape-incrementrotation-member(1))|Rotates the shape clockwise around the z-axis by the specified number of degrees.| -||[incrementTop(increment: number)](/javascript/api/excel/excel.shape#excel-excel-shape-incrementtop-member(1))|Moves the shape vertically by the specified number of points.| -||[left](/javascript/api/excel/excel.shape#excel-excel-shape-left-member)|The distance, in points, from the left side of the shape to the left side of the worksheet.| -||[level](/javascript/api/excel/excel.shape#excel-excel-shape-level-member)|Specifies the level of the specified shape.| -||[line](/javascript/api/excel/excel.shape#excel-excel-shape-line-member)|Returns the line associated with the shape.| -||[lineFormat](/javascript/api/excel/excel.shape#excel-excel-shape-lineformat-member)|Returns the line formatting of this shape.| -||[lockAspectRatio](/javascript/api/excel/excel.shape#excel-excel-shape-lockaspectratio-member)|Specifies if the aspect ratio of this shape is locked.| -||[name](/javascript/api/excel/excel.shape#excel-excel-shape-name-member)|Specifies the name of the shape.| -||[onActivated](/javascript/api/excel/excel.shape#excel-excel-shape-onactivated-member)|Occurs when the shape is activated.| -||[onDeactivated](/javascript/api/excel/excel.shape#excel-excel-shape-ondeactivated-member)|Occurs when the shape is deactivated.| -||[parentGroup](/javascript/api/excel/excel.shape#excel-excel-shape-parentgroup-member)|Specifies the parent group of this shape.| -||[rotation](/javascript/api/excel/excel.shape#excel-excel-shape-rotation-member)|Specifies the rotation, in degrees, of the shape.| -||[scaleHeight(scaleFactor: number, scaleType: Excel.ShapeScaleType, scaleFrom?: Excel.ShapeScaleFrom)](/javascript/api/excel/excel.shape#excel-excel-shape-scaleheight-member(1))|Scales the height of the shape by a specified factor.| -||[scaleWidth(scaleFactor: number, scaleType: Excel.ShapeScaleType, scaleFrom?: Excel.ShapeScaleFrom)](/javascript/api/excel/excel.shape#excel-excel-shape-scalewidth-member(1))|Scales the width of the shape by a specified factor.| -||[setZOrder(position: Excel.ShapeZOrder)](/javascript/api/excel/excel.shape#excel-excel-shape-setzorder-member(1))|Moves the specified shape up or down the collection's z-order, which shifts it in front of or behind other shapes.| -||[textFrame](/javascript/api/excel/excel.shape#excel-excel-shape-textframe-member)|Returns the text frame object of this shape.| -||[top](/javascript/api/excel/excel.shape#excel-excel-shape-top-member)|The distance, in points, from the top edge of the shape to the top edge of the worksheet.| -||[type](/javascript/api/excel/excel.shape#excel-excel-shape-type-member)|Returns the type of this shape.| -||[visible](/javascript/api/excel/excel.shape#excel-excel-shape-visible-member)|Specifies if the shape is visible.| -||[width](/javascript/api/excel/excel.shape#excel-excel-shape-width-member)|Specifies the width, in points, of the shape.| -||[zOrderPosition](/javascript/api/excel/excel.shape#excel-excel-shape-zorderposition-member)|Returns the position of the specified shape in the z-order, with 0 representing the bottom of the order stack.| -|[ShapeActivatedEventArgs](/javascript/api/excel/excel.shapeactivatedeventargs)|[shapeId](/javascript/api/excel/excel.shapeactivatedeventargs#excel-excel-shapeactivatedeventargs-shapeid-member)|Gets the ID of the activated shape.| -||[type](/javascript/api/excel/excel.shapeactivatedeventargs#excel-excel-shapeactivatedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/javascript/api/excel/excel.shapeactivatedeventargs#excel-excel-shapeactivatedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the shape is activated.| -|[ShapeCollection](/javascript/api/excel/excel.shapecollection)|[addGeometricShape(geometricShapeType: Excel.GeometricShapeType)](/javascript/api/excel/excel.shapecollection#excel-excel-shapecollection-addgeometricshape-member(1))|Adds a geometric shape to the worksheet.| -||[addGroup(values: Array)](/javascript/api/excel/excel.shapecollection#excel-excel-shapecollection-addgroup-member(1))|Groups a subset of shapes in this collection's worksheet.| -||[addImage(base64ImageString: string)](/javascript/api/excel/excel.shapecollection#excel-excel-shapecollection-addimage-member(1))|Creates an image from a Base64-encoded string and adds it to the worksheet.| -||[addLine(startLeft: number, startTop: number, endLeft: number, endTop: number, connectorType?: Excel.ConnectorType)](/javascript/api/excel/excel.shapecollection#excel-excel-shapecollection-addline-member(1))|Adds a line to worksheet.| -||[addTextBox(text?: string)](/javascript/api/excel/excel.shapecollection#excel-excel-shapecollection-addtextbox-member(1))|Adds a text box to the worksheet with the provided text as the content.| -||[getCount()](/javascript/api/excel/excel.shapecollection#excel-excel-shapecollection-getcount-member(1))|Returns the number of shapes in the worksheet.| -||[getItem(key: string)](/javascript/api/excel/excel.shapecollection#excel-excel-shapecollection-getitem-member(1))|Gets a shape using its name or ID.| -||[getItemAt(index: number)](/javascript/api/excel/excel.shapecollection#excel-excel-shapecollection-getitemat-member(1))|Gets a shape using its position in the collection.| -||[items](/javascript/api/excel/excel.shapecollection#excel-excel-shapecollection-items-member)|Gets the loaded child items in this collection.| -|[ShapeDeactivatedEventArgs](/javascript/api/excel/excel.shapedeactivatedeventargs)|[shapeId](/javascript/api/excel/excel.shapedeactivatedeventargs#excel-excel-shapedeactivatedeventargs-shapeid-member)|Gets the ID of the shape deactivated shape.| -||[type](/javascript/api/excel/excel.shapedeactivatedeventargs#excel-excel-shapedeactivatedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/javascript/api/excel/excel.shapedeactivatedeventargs#excel-excel-shapedeactivatedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the shape is deactivated.| -|[ShapeFill](/javascript/api/excel/excel.shapefill)|[clear()](/javascript/api/excel/excel.shapefill#excel-excel-shapefill-clear-member(1))|Clears the fill formatting of this shape.| -||[foregroundColor](/javascript/api/excel/excel.shapefill#excel-excel-shapefill-foregroundcolor-member)|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")| -||[setSolidColor(color: string)](/javascript/api/excel/excel.shapefill#excel-excel-shapefill-setsolidcolor-member(1))|Sets the fill formatting of the shape to a uniform color.| -||[transparency](/javascript/api/excel/excel.shapefill#excel-excel-shapefill-transparency-member)|Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).| -||[type](/javascript/api/excel/excel.shapefill#excel-excel-shapefill-type-member)|Returns the fill type of the shape.| -|[ShapeFont](/javascript/api/excel/excel.shapefont)|[bold](/javascript/api/excel/excel.shapefont#excel-excel-shapefont-bold-member)|Represents the bold status of font.| -||[color](/javascript/api/excel/excel.shapefont#excel-excel-shapefont-color-member)|HTML color code representation of the text color (e.g., "#FF0000" represents red).| -||[italic](/javascript/api/excel/excel.shapefont#excel-excel-shapefont-italic-member)|Represents the italic status of font.| -||[name](/javascript/api/excel/excel.shapefont#excel-excel-shapefont-name-member)|Represents font name (e.g., "Calibri").| -||[size](/javascript/api/excel/excel.shapefont#excel-excel-shapefont-size-member)|Represents font size in points (e.g., 11).| -||[underline](/javascript/api/excel/excel.shapefont#excel-excel-shapefont-underline-member)|Type of underline applied to the font.| -|[ShapeGroup](/javascript/api/excel/excel.shapegroup)|[id](/javascript/api/excel/excel.shapegroup#excel-excel-shapegroup-id-member)|Specifies the shape identifier.| -||[shape](/javascript/api/excel/excel.shapegroup#excel-excel-shapegroup-shape-member)|Returns the `Shape` object associated with the group.| -||[shapes](/javascript/api/excel/excel.shapegroup#excel-excel-shapegroup-shapes-member)|Returns the collection of `Shape` objects.| -||[ungroup()](/javascript/api/excel/excel.shapegroup#excel-excel-shapegroup-ungroup-member(1))|Ungroups any grouped shapes in the specified shape group.| -|[ShapeLineFormat](/javascript/api/excel/excel.shapelineformat)|[color](/javascript/api/excel/excel.shapelineformat#excel-excel-shapelineformat-color-member)|Represents the line color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").| -||[dashStyle](/javascript/api/excel/excel.shapelineformat#excel-excel-shapelineformat-dashstyle-member)|Represents the line style of the shape.| -||[style](/javascript/api/excel/excel.shapelineformat#excel-excel-shapelineformat-style-member)|Represents the line style of the shape.| -||[transparency](/javascript/api/excel/excel.shapelineformat#excel-excel-shapelineformat-transparency-member)|Represents the degree of transparency of the specified line as a value from 0.0 (opaque) through 1.0 (clear).| -||[visible](/javascript/api/excel/excel.shapelineformat#excel-excel-shapelineformat-visible-member)|Specifies if the line formatting of a shape element is visible.| -||[weight](/javascript/api/excel/excel.shapelineformat#excel-excel-shapelineformat-weight-member)|Represents the weight of the line, in points.| -|[SortField](/javascript/api/excel/excel.sortfield)|[subField](/javascript/api/excel/excel.sortfield#excel-excel-sortfield-subfield-member)|Specifies the subfield that is the target property name of a rich value to sort on.| -|[StyleCollection](/javascript/api/excel/excel.stylecollection)|[getCount()](/javascript/api/excel/excel.stylecollection#excel-excel-stylecollection-getcount-member(1))|Gets the number of styles in the collection.| -||[getItemAt(index: number)](/javascript/api/excel/excel.stylecollection#excel-excel-stylecollection-getitemat-member(1))|Gets a style based on its position in the collection.| -|[Table](/javascript/api/excel/excel.table)|[autoFilter](/javascript/api/excel/excel.table#excel-excel-table-autofilter-member)|Represents the `AutoFilter` object of the table.| -|[TableAddedEventArgs](/javascript/api/excel/excel.tableaddedeventargs)|[source](/javascript/api/excel/excel.tableaddedeventargs#excel-excel-tableaddedeventargs-source-member)|Gets the source of the event.| -||[tableId](/javascript/api/excel/excel.tableaddedeventargs#excel-excel-tableaddedeventargs-tableid-member)|Gets the ID of the table that is added.| -||[type](/javascript/api/excel/excel.tableaddedeventargs#excel-excel-tableaddedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/javascript/api/excel/excel.tableaddedeventargs#excel-excel-tableaddedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the table is added.| -|[TableChangedEventArgs](/javascript/api/excel/excel.tablechangedeventargs)|[details](/javascript/api/excel/excel.tablechangedeventargs#excel-excel-tablechangedeventargs-details-member)|Gets the information about the change detail.| -|[TableCollection](/javascript/api/excel/excel.tablecollection)|[onAdded](/javascript/api/excel/excel.tablecollection#excel-excel-tablecollection-onadded-member)|Occurs when a new table is added in a workbook.| -||[onDeleted](/javascript/api/excel/excel.tablecollection#excel-excel-tablecollection-ondeleted-member)|Occurs when the specified table is deleted in a workbook.| -|[TableDeletedEventArgs](/javascript/api/excel/excel.tabledeletedeventargs)|[source](/javascript/api/excel/excel.tabledeletedeventargs#excel-excel-tabledeletedeventargs-source-member)|Gets the source of the event.| -||[tableId](/javascript/api/excel/excel.tabledeletedeventargs#excel-excel-tabledeletedeventargs-tableid-member)|Gets the ID of the table that is deleted.| -||[tableName](/javascript/api/excel/excel.tabledeletedeventargs#excel-excel-tabledeletedeventargs-tablename-member)|Gets the name of the table that is deleted.| -||[type](/javascript/api/excel/excel.tabledeletedeventargs#excel-excel-tabledeletedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/javascript/api/excel/excel.tabledeletedeventargs#excel-excel-tabledeletedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the table is deleted.| -|[TableScopedCollection](/javascript/api/excel/excel.tablescopedcollection)|[getCount()](/javascript/api/excel/excel.tablescopedcollection#excel-excel-tablescopedcollection-getcount-member(1))|Gets the number of tables in the collection.| -||[getFirst()](/javascript/api/excel/excel.tablescopedcollection#excel-excel-tablescopedcollection-getfirst-member(1))|Gets the first table in the collection.| -||[getItem(key: string)](/javascript/api/excel/excel.tablescopedcollection#excel-excel-tablescopedcollection-getitem-member(1))|Gets a table by name or ID.| -||[items](/javascript/api/excel/excel.tablescopedcollection#excel-excel-tablescopedcollection-items-member)|Gets the loaded child items in this collection.| -|[TextFrame](/javascript/api/excel/excel.textframe)|[autoSizeSetting](/javascript/api/excel/excel.textframe#excel-excel-textframe-autosizesetting-member)|The automatic sizing settings for the text frame.| -||[bottomMargin](/javascript/api/excel/excel.textframe#excel-excel-textframe-bottommargin-member)|Represents the bottom margin, in points, of the text frame.| -||[deleteText()](/javascript/api/excel/excel.textframe#excel-excel-textframe-deletetext-member(1))|Deletes all the text in the text frame.| -||[hasText](/javascript/api/excel/excel.textframe#excel-excel-textframe-hastext-member)|Specifies if the text frame contains text.| -||[horizontalAlignment](/javascript/api/excel/excel.textframe#excel-excel-textframe-horizontalalignment-member)|Represents the horizontal alignment of the text frame.| -||[horizontalOverflow](/javascript/api/excel/excel.textframe#excel-excel-textframe-horizontaloverflow-member)|Represents the horizontal overflow behavior of the text frame.| -||[leftMargin](/javascript/api/excel/excel.textframe#excel-excel-textframe-leftmargin-member)|Represents the left margin, in points, of the text frame.| -||[orientation](/javascript/api/excel/excel.textframe#excel-excel-textframe-orientation-member)|Represents the angle to which the text is oriented for the text frame.| -||[readingOrder](/javascript/api/excel/excel.textframe#excel-excel-textframe-readingorder-member)|Represents the reading order of the text frame, either left-to-right or right-to-left.| -||[rightMargin](/javascript/api/excel/excel.textframe#excel-excel-textframe-rightmargin-member)|Represents the right margin, in points, of the text frame.| -||[textRange](/javascript/api/excel/excel.textframe#excel-excel-textframe-textrange-member)|Represents the text that is attached to a shape in the text frame, and properties and methods for manipulating the text.| -||[topMargin](/javascript/api/excel/excel.textframe#excel-excel-textframe-topmargin-member)|Represents the top margin, in points, of the text frame.| -||[verticalAlignment](/javascript/api/excel/excel.textframe#excel-excel-textframe-verticalalignment-member)|Represents the vertical alignment of the text frame.| -||[verticalOverflow](/javascript/api/excel/excel.textframe#excel-excel-textframe-verticaloverflow-member)|Represents the vertical overflow behavior of the text frame.| -|[TextRange](/javascript/api/excel/excel.textrange)|[font](/javascript/api/excel/excel.textrange#excel-excel-textrange-font-member)|Returns a `ShapeFont` object that represents the font attributes for the text range.| -||[getSubstring(start: number, length?: number)](/javascript/api/excel/excel.textrange#excel-excel-textrange-getsubstring-member(1))|Returns a TextRange object for the substring in the given range.| -||[text](/javascript/api/excel/excel.textrange#excel-excel-textrange-text-member)|Represents the plain text content of the text range.| -|[Workbook](/javascript/api/excel/excel.workbook)|[autoSave](/javascript/api/excel/excel.workbook#excel-excel-workbook-autosave-member)|Specifies if the workbook is in AutoSave mode.| -||[calculationEngineVersion](/javascript/api/excel/excel.workbook#excel-excel-workbook-calculationengineversion-member)|Returns a number about the version of Excel Calculation Engine.| -||[chartDataPointTrack](/javascript/api/excel/excel.workbook#excel-excel-workbook-chartdatapointtrack-member)|True if all charts in the workbook are tracking the actual data points to which they are attached.| -||[getActiveChart()](/javascript/api/excel/excel.workbook#excel-excel-workbook-getactivechart-member(1))|Gets the currently active chart in the workbook.| -||[getActiveChartOrNullObject()](/javascript/api/excel/excel.workbook#excel-excel-workbook-getactivechartornullobject-member(1))|Gets the currently active chart in the workbook.| -||[getIsActiveCollabSession()](/javascript/api/excel/excel.workbook#excel-excel-workbook-getisactivecollabsession-member(1))|Returns `true` if the workbook is being edited by multiple users (through co-authoring).| -||[getSelectedRanges()](/javascript/api/excel/excel.workbook#excel-excel-workbook-getselectedranges-member(1))|Gets the currently selected one or more ranges from the workbook.| -||[isDirty](/javascript/api/excel/excel.workbook#excel-excel-workbook-isdirty-member)|Specifies if changes have been made since the workbook was last saved.| -||[onAutoSaveSettingChanged](/javascript/api/excel/excel.workbook#excel-excel-workbook-onautosavesettingchanged-member)|Occurs when the AutoSave setting is changed on the workbook.| -||[previouslySaved](/javascript/api/excel/excel.workbook#excel-excel-workbook-previouslysaved-member)|Specifies if the workbook has ever been saved locally or online.| -||[usePrecisionAsDisplayed](/javascript/api/excel/excel.workbook#excel-excel-workbook-useprecisionasdisplayed-member)|True if calculations in this workbook will be done using only the precision of the numbers as they're displayed.| -|[WorkbookAutoSaveSettingChangedEventArgs](/javascript/api/excel/excel.workbookautosavesettingchangedeventargs)|[type](/javascript/api/excel/excel.workbookautosavesettingchangedeventargs#excel-excel-workbookautosavesettingchangedeventargs-type-member)|Gets the type of the event.| -|[Worksheet](/javascript/api/excel/excel.worksheet)|[autoFilter](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-autofilter-member)|Represents the `AutoFilter` object of the worksheet.| -||[enableCalculation](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-enablecalculation-member)|Determines if Excel should recalculate the worksheet when necessary.| -||[findAll(text: string, criteria: Excel.WorksheetSearchCriteria)](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-findall-member(1))|Finds all occurrences of the given string based on the criteria specified and returns them as a `RangeAreas` object, comprising one or more rectangular ranges.| -||[findAllOrNullObject(text: string, criteria: Excel.WorksheetSearchCriteria)](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-findallornullobject-member(1))|Finds all occurrences of the given string based on the criteria specified and returns them as a `RangeAreas` object, comprising one or more rectangular ranges.| -||[getRanges(address?: string)](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-getranges-member(1))|Gets the `RangeAreas` object, representing one or more blocks of rectangular ranges, specified by the address or name.| -||[horizontalPageBreaks](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-horizontalpagebreaks-member)|Gets the horizontal page break collection for the worksheet.| -||[onFormatChanged](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-onformatchanged-member)|Occurs when format changed on a specific worksheet.| -||[pageLayout](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-pagelayout-member)|Gets the `PageLayout` object of the worksheet.| -||[replaceAll(text: string, replacement: string, criteria: Excel.ReplaceCriteria)](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-replaceall-member(1))|Finds and replaces the given string based on the criteria specified within the current worksheet.| -||[shapes](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-shapes-member)|Returns the collection of all the Shape objects on the worksheet.| -||[verticalPageBreaks](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-verticalpagebreaks-member)|Gets the vertical page break collection for the worksheet.| -|[WorksheetChangedEventArgs](/javascript/api/excel/excel.worksheetchangedeventargs)|[details](/javascript/api/excel/excel.worksheetchangedeventargs#excel-excel-worksheetchangedeventargs-details-member)|Represents the information about the change detail.| -|[WorksheetCollection](/javascript/api/excel/excel.worksheetcollection)|[onChanged](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-onchanged-member)|Occurs when any worksheet in the workbook is changed.| -||[onFormatChanged](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-onformatchanged-member)|Occurs when any worksheet in the workbook has a format changed.| -||[onSelectionChanged](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-onselectionchanged-member)|Occurs when the selection changes on any worksheet.| -|[WorksheetFormatChangedEventArgs](/javascript/api/excel/excel.worksheetformatchangedeventargs)|[address](/javascript/api/excel/excel.worksheetformatchangedeventargs#excel-excel-worksheetformatchangedeventargs-address-member)|Gets the range address that represents the changed area of a specific worksheet.| -||[getRange(ctx: Excel.RequestContext)](/javascript/api/excel/excel.worksheetformatchangedeventargs#excel-excel-worksheetformatchangedeventargs-getrange-member(1))|Gets the range that represents the changed area of a specific worksheet.| -||[getRangeOrNullObject(ctx: Excel.RequestContext)](/javascript/api/excel/excel.worksheetformatchangedeventargs#excel-excel-worksheetformatchangedeventargs-getrangeornullobject-member(1))|Gets the range that represents the changed area of a specific worksheet.| -||[source](/javascript/api/excel/excel.worksheetformatchangedeventargs#excel-excel-worksheetformatchangedeventargs-source-member)|Gets the source of the event.| -||[type](/javascript/api/excel/excel.worksheetformatchangedeventargs#excel-excel-worksheetformatchangedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/javascript/api/excel/excel.worksheetformatchangedeventargs#excel-excel-worksheetformatchangedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the data changed.| -|[WorksheetSearchCriteria](/javascript/api/excel/excel.worksheetsearchcriteria)|[completeMatch](/javascript/api/excel/excel.worksheetsearchcriteria#excel-excel-worksheetsearchcriteria-completematch-member)|Specifies if the match needs to be complete or partial.| -||[matchCase](/javascript/api/excel/excel.worksheetsearchcriteria#excel-excel-worksheetsearchcriteria-matchcase-member)|Specifies if the match is case-sensitive.| +|[Application](/.application)|[calculationEngineVersion](/.application#excel-javascript/api/excel/-application-calculationengineversion-member)|Returns the Excel calculation engine version used for the last full recalculation.| +||[calculationState](/.application#excel-javascript/api/excel/-application-calculationstate-member)|Returns the calculation state of the application.| +||[iterativeCalculation](/.application#excel-javascript/api/excel/-application-iterativecalculation-member)|Returns the iterative calculation settings.| +||[suspendScreenUpdatingUntilNextSync()](/.application#excel-javascript/api/excel/-application-suspendscreenupdatinguntilnextsync-member(1))|Suspends screen updating until the next `context.sync()` is called.| +|[AutoFilter](/.autofilter)|[apply(range: Range \| string, columnIndex?: number, criteria?: Excel.FilterCriteria)](/.autofilter#excel-javascript/api/excel/-autofilter-apply-member(1))|Applies the AutoFilter to a range.| +||[clearCriteria()](/.autofilter#excel-javascript/api/excel/-autofilter-clearcriteria-member(1))|Clears the filter criteria and sort state of the AutoFilter.| +||[criteria](/.autofilter#excel-javascript/api/excel/-autofilter-criteria-member)|An array that holds all the filter criteria in the autofiltered range.| +||[enabled](/.autofilter#excel-javascript/api/excel/-autofilter-enabled-member)|Specifies if the AutoFilter is enabled.| +||[getRange()](/.autofilter#excel-javascript/api/excel/-autofilter-getrange-member(1))|Returns the `Range` object that represents the range to which the AutoFilter applies.| +||[getRangeOrNullObject()](/.autofilter#excel-javascript/api/excel/-autofilter-getrangeornullobject-member(1))|Returns the `Range` object that represents the range to which the AutoFilter applies.| +||[isDataFiltered](/.autofilter#excel-javascript/api/excel/-autofilter-isdatafiltered-member)|Specifies if the AutoFilter has filter criteria.| +||[reapply()](/.autofilter#excel-javascript/api/excel/-autofilter-reapply-member(1))|Applies the specified AutoFilter object currently on the range.| +||[remove()](/.autofilter#excel-javascript/api/excel/-autofilter-remove-member(1))|Removes the AutoFilter for the range.| +|[CellBorder](/.cellborder)|[color](/.cellborder#excel-javascript/api/excel/-cellborder-color-member)|Represents the `color` property of a single border.| +||[style](/.cellborder#excel-javascript/api/excel/-cellborder-style-member)|Represents the `style` property of a single border.| +||[tintAndShade](/.cellborder#excel-javascript/api/excel/-cellborder-tintandshade-member)|Represents the `tintAndShade` property of a single border.| +||[weight](/.cellborder#excel-javascript/api/excel/-cellborder-weight-member)|Represents the `weight` property of a single border.| +|[CellBorderCollection](/.cellbordercollection)|[bottom](/.cellbordercollection#excel-javascript/api/excel/-cellbordercollection-bottom-member)|Represents the `format.borders.bottom` property.| +||[diagonalDown](/.cellbordercollection#excel-javascript/api/excel/-cellbordercollection-diagonaldown-member)|Represents the `format.borders.diagonalDown` property.| +||[diagonalUp](/.cellbordercollection#excel-javascript/api/excel/-cellbordercollection-diagonalup-member)|Represents the `format.borders.diagonalUp` property.| +||[horizontal](/.cellbordercollection#excel-javascript/api/excel/-cellbordercollection-horizontal-member)|Represents the `format.borders.horizontal` property.| +||[left](/.cellbordercollection#excel-javascript/api/excel/-cellbordercollection-left-member)|Represents the `format.borders.left` property.| +||[right](/.cellbordercollection#excel-javascript/api/excel/-cellbordercollection-right-member)|Represents the `format.borders.right` property.| +||[top](/.cellbordercollection#excel-javascript/api/excel/-cellbordercollection-top-member)|Represents the `format.borders.top` property.| +||[vertical](/.cellbordercollection#excel-javascript/api/excel/-cellbordercollection-vertical-member)|Represents the `format.borders.vertical` property.| +|[CellProperties](/.cellproperties)|[address](/.cellproperties#excel-javascript/api/excel/-cellproperties-address-member)|Represents the `address` property.| +||[addressLocal](/.cellproperties#excel-javascript/api/excel/-cellproperties-addresslocal-member)|Represents the `addressLocal` property.| +||[hidden](/.cellproperties#excel-javascript/api/excel/-cellproperties-hidden-member)|Represents the `hidden` property.| +|[CellPropertiesFill](/.cellpropertiesfill)|[color](/.cellpropertiesfill#excel-javascript/api/excel/-cellpropertiesfill-color-member)|Represents the `format.fill.color` property.| +||[pattern](/.cellpropertiesfill#excel-javascript/api/excel/-cellpropertiesfill-pattern-member)|Represents the `format.fill.pattern` property.| +||[patternColor](/.cellpropertiesfill#excel-javascript/api/excel/-cellpropertiesfill-patterncolor-member)|Represents the `format.fill.patternColor` property.| +||[patternTintAndShade](/.cellpropertiesfill#excel-javascript/api/excel/-cellpropertiesfill-patterntintandshade-member)|Represents the `format.fill.patternTintAndShade` property.| +||[tintAndShade](/.cellpropertiesfill#excel-javascript/api/excel/-cellpropertiesfill-tintandshade-member)|Represents the `format.fill.tintAndShade` property.| +|[CellPropertiesFont](/.cellpropertiesfont)|[bold](/.cellpropertiesfont#excel-javascript/api/excel/-cellpropertiesfont-bold-member)|Represents the `format.font.bold` property.| +||[color](/.cellpropertiesfont#excel-javascript/api/excel/-cellpropertiesfont-color-member)|Represents the `format.font.color` property.| +||[italic](/.cellpropertiesfont#excel-javascript/api/excel/-cellpropertiesfont-italic-member)|Represents the `format.font.italic` property.| +||[name](/.cellpropertiesfont#excel-javascript/api/excel/-cellpropertiesfont-name-member)|Represents the `format.font.name` property.| +||[size](/.cellpropertiesfont#excel-javascript/api/excel/-cellpropertiesfont-size-member)|Represents the `format.font.size` property.| +||[strikethrough](/.cellpropertiesfont#excel-javascript/api/excel/-cellpropertiesfont-strikethrough-member)|Represents the `format.font.strikethrough` property.| +||[subscript](/.cellpropertiesfont#excel-javascript/api/excel/-cellpropertiesfont-subscript-member)|Represents the `format.font.subscript` property.| +||[superscript](/.cellpropertiesfont#excel-javascript/api/excel/-cellpropertiesfont-superscript-member)|Represents the `format.font.superscript` property.| +||[tintAndShade](/.cellpropertiesfont#excel-javascript/api/excel/-cellpropertiesfont-tintandshade-member)|Represents the `format.font.tintAndShade` property.| +||[underline](/.cellpropertiesfont#excel-javascript/api/excel/-cellpropertiesfont-underline-member)|Represents the `format.font.underline` property.| +|[CellPropertiesFormat](/.cellpropertiesformat)|[autoIndent](/.cellpropertiesformat#excel-javascript/api/excel/-cellpropertiesformat-autoindent-member)|Represents the `autoIndent` property.| +||[borders](/.cellpropertiesformat#excel-javascript/api/excel/-cellpropertiesformat-borders-member)|Represents the `borders` property.| +||[fill](/.cellpropertiesformat#excel-javascript/api/excel/-cellpropertiesformat-fill-member)|Represents the `fill` property.| +||[font](/.cellpropertiesformat#excel-javascript/api/excel/-cellpropertiesformat-font-member)|Represents the `font` property.| +||[horizontalAlignment](/.cellpropertiesformat#excel-javascript/api/excel/-cellpropertiesformat-horizontalalignment-member)|Represents the `horizontalAlignment` property.| +||[indentLevel](/.cellpropertiesformat#excel-javascript/api/excel/-cellpropertiesformat-indentlevel-member)|Represents the `indentLevel` property.| +||[protection](/.cellpropertiesformat#excel-javascript/api/excel/-cellpropertiesformat-protection-member)|Represents the `protection` property.| +||[readingOrder](/.cellpropertiesformat#excel-javascript/api/excel/-cellpropertiesformat-readingorder-member)|Represents the `readingOrder` property.| +||[shrinkToFit](/.cellpropertiesformat#excel-javascript/api/excel/-cellpropertiesformat-shrinktofit-member)|Represents the `shrinkToFit` property.| +||[textOrientation](/.cellpropertiesformat#excel-javascript/api/excel/-cellpropertiesformat-textorientation-member)|Represents the `textOrientation` property.| +||[useStandardHeight](/.cellpropertiesformat#excel-javascript/api/excel/-cellpropertiesformat-usestandardheight-member)|Represents the `useStandardHeight` property.| +||[useStandardWidth](/.cellpropertiesformat#excel-javascript/api/excel/-cellpropertiesformat-usestandardwidth-member)|Represents the `useStandardWidth` property.| +||[verticalAlignment](/.cellpropertiesformat#excel-javascript/api/excel/-cellpropertiesformat-verticalalignment-member)|Represents the `verticalAlignment` property.| +||[wrapText](/.cellpropertiesformat#excel-javascript/api/excel/-cellpropertiesformat-wraptext-member)|Represents the `wrapText` property.| +|[CellPropertiesProtection](/.cellpropertiesprotection)|[formulaHidden](/.cellpropertiesprotection#excel-javascript/api/excel/-cellpropertiesprotection-formulahidden-member)|Represents the `format.protection.formulaHidden` property.| +||[locked](/.cellpropertiesprotection#excel-javascript/api/excel/-cellpropertiesprotection-locked-member)|Represents the `format.protection.locked` property.| +|[ChangedEventDetail](/.changedeventdetail)|[valueAfter](/.changedeventdetail#excel-javascript/api/excel/-changedeventdetail-valueafter-member)|Represents the value after the change.| +||[valueBefore](/.changedeventdetail#excel-javascript/api/excel/-changedeventdetail-valuebefore-member)|Represents the value before the change.| +||[valueTypeAfter](/.changedeventdetail#excel-javascript/api/excel/-changedeventdetail-valuetypeafter-member)|Represents the type of value after the change.| +||[valueTypeBefore](/.changedeventdetail#excel-javascript/api/excel/-changedeventdetail-valuetypebefore-member)|Represents the type of value before the change.| +|[Chart](/.chart)|[activate()](/.chart#excel-javascript/api/excel/-chart-activate-member(1))|Activates the chart in the Excel UI.| +||[pivotOptions](/.chart#excel-javascript/api/excel/-chart-pivotoptions-member)|Encapsulates the options for a pivot chart.| +|[ChartAreaFormat](/.chartareaformat)|[colorScheme](/.chartareaformat#excel-javascript/api/excel/-chartareaformat-colorscheme-member)|Specifies the color scheme of the chart.| +||[roundedCorners](/.chartareaformat#excel-javascript/api/excel/-chartareaformat-roundedcorners-member)|Specifies if the chart area of the chart has rounded corners.| +|[ChartAxis](/.chartaxis)|[linkNumberFormat](/.chartaxis#excel-javascript/api/excel/-chartaxis-linknumberformat-member)|Specifies if the number format is linked to the cells.| +|[ChartBinOptions](/.chartbinoptions)|[allowOverflow](/.chartbinoptions#excel-javascript/api/excel/-chartbinoptions-allowoverflow-member)|Specifies if bin overflow is enabled in a histogram chart or pareto chart.| +||[allowUnderflow](/.chartbinoptions#excel-javascript/api/excel/-chartbinoptions-allowunderflow-member)|Specifies if bin underflow is enabled in a histogram chart or pareto chart.| +||[count](/.chartbinoptions#excel-javascript/api/excel/-chartbinoptions-count-member)|Specifies the bin count of a histogram chart or pareto chart.| +||[overflowValue](/.chartbinoptions#excel-javascript/api/excel/-chartbinoptions-overflowvalue-member)|Specifies the bin overflow value of a histogram chart or pareto chart.| +||[type](/.chartbinoptions#excel-javascript/api/excel/-chartbinoptions-type-member)|Specifies the bin's type for a histogram chart or pareto chart.| +||[underflowValue](/.chartbinoptions#excel-javascript/api/excel/-chartbinoptions-underflowvalue-member)|Specifies the bin underflow value of a histogram chart or pareto chart.| +||[width](/.chartbinoptions#excel-javascript/api/excel/-chartbinoptions-width-member)|Specifies the bin width value of a histogram chart or pareto chart.| +|[ChartBoxwhiskerOptions](/.chartboxwhiskeroptions)|[quartileCalculation](/.chartboxwhiskeroptions#excel-javascript/api/excel/-chartboxwhiskeroptions-quartilecalculation-member)|Specifies if the quartile calculation type of a box and whisker chart.| +||[showInnerPoints](/.chartboxwhiskeroptions#excel-javascript/api/excel/-chartboxwhiskeroptions-showinnerpoints-member)|Specifies if inner points are shown in a box and whisker chart.| +||[showMeanLine](/.chartboxwhiskeroptions#excel-javascript/api/excel/-chartboxwhiskeroptions-showmeanline-member)|Specifies if the mean line is shown in a box and whisker chart.| +||[showMeanMarker](/.chartboxwhiskeroptions#excel-javascript/api/excel/-chartboxwhiskeroptions-showmeanmarker-member)|Specifies if the mean marker is shown in a box and whisker chart.| +||[showOutlierPoints](/.chartboxwhiskeroptions#excel-javascript/api/excel/-chartboxwhiskeroptions-showoutlierpoints-member)|Specifies if outlier points are shown in a box and whisker chart.| +|[ChartDataLabel](/.chartdatalabel)|[linkNumberFormat](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-linknumberformat-member)|Specifies if the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells).| +|[ChartDataLabels](/.chartdatalabels)|[linkNumberFormat](/.chartdatalabels#excel-javascript/api/excel/-chartdatalabels-linknumberformat-member)|Specifies if the number format is linked to the cells.| +|[ChartErrorBars](/.charterrorbars)|[endStyleCap](/.charterrorbars#excel-javascript/api/excel/-charterrorbars-endstylecap-member)|Specifies if error bars have an end style cap.| +||[format](/.charterrorbars#excel-javascript/api/excel/-charterrorbars-format-member)|Specifies the formatting type of the error bars.| +||[include](/.charterrorbars#excel-javascript/api/excel/-charterrorbars-include-member)|Specifies which parts of the error bars to include.| +||[type](/.charterrorbars#excel-javascript/api/excel/-charterrorbars-type-member)|The type of range marked by the error bars.| +||[visible](/.charterrorbars#excel-javascript/api/excel/-charterrorbars-visible-member)|Specifies whether the error bars are displayed.| +|[ChartErrorBarsFormat](/.charterrorbarsformat)|[line](/.charterrorbarsformat#excel-javascript/api/excel/-charterrorbarsformat-line-member)|Represents the chart line formatting.| +|[ChartMapOptions](/.chartmapoptions)|[labelStrategy](/.chartmapoptions#excel-javascript/api/excel/-chartmapoptions-labelstrategy-member)|Specifies the series map labels strategy of a region map chart.| +||[level](/.chartmapoptions#excel-javascript/api/excel/-chartmapoptions-level-member)|Specifies the series mapping level of a region map chart.| +||[projectionType](/.chartmapoptions#excel-javascript/api/excel/-chartmapoptions-projectiontype-member)|Specifies the series projection type of a region map chart.| +|[ChartPivotOptions](/.chartpivotoptions)|[showAxisFieldButtons](/.chartpivotoptions#excel-javascript/api/excel/-chartpivotoptions-showaxisfieldbuttons-member)|Specifies whether to display the axis field buttons on a PivotChart.| +||[showLegendFieldButtons](/.chartpivotoptions#excel-javascript/api/excel/-chartpivotoptions-showlegendfieldbuttons-member)|Specifies whether to display the legend field buttons on a PivotChart.| +||[showReportFilterFieldButtons](/.chartpivotoptions#excel-javascript/api/excel/-chartpivotoptions-showreportfilterfieldbuttons-member)|Specifies whether to display the report filter field buttons on a PivotChart.| +||[showValueFieldButtons](/.chartpivotoptions#excel-javascript/api/excel/-chartpivotoptions-showvaluefieldbuttons-member)|Specifies whether to display the show value field buttons on a PivotChart.| +|[ChartSeries](/.chartseries)|[binOptions](/.chartseries#excel-javascript/api/excel/-chartseries-binoptions-member)|Encapsulates the bin options for histogram charts and pareto charts.| +||[boxwhiskerOptions](/.chartseries#excel-javascript/api/excel/-chartseries-boxwhiskeroptions-member)|Encapsulates the options for the box and whisker charts.| +||[bubbleScale](/.chartseries#excel-javascript/api/excel/-chartseries-bubblescale-member)|This can be an integer value from 0 (zero) to 300, representing the percentage of the default size.| +||[gradientMaximumColor](/.chartseries#excel-javascript/api/excel/-chartseries-gradientmaximumcolor-member)|Specifies the color for maximum value of a region map chart series.| +||[gradientMaximumType](/.chartseries#excel-javascript/api/excel/-chartseries-gradientmaximumtype-member)|Specifies the type for maximum value of a region map chart series.| +||[gradientMaximumValue](/.chartseries#excel-javascript/api/excel/-chartseries-gradientmaximumvalue-member)|Specifies the maximum value of a region map chart series.| +||[gradientMidpointColor](/.chartseries#excel-javascript/api/excel/-chartseries-gradientmidpointcolor-member)|Specifies the color for the midpoint value of a region map chart series.| +||[gradientMidpointType](/.chartseries#excel-javascript/api/excel/-chartseries-gradientmidpointtype-member)|Specifies the type for the midpoint value of a region map chart series.| +||[gradientMidpointValue](/.chartseries#excel-javascript/api/excel/-chartseries-gradientmidpointvalue-member)|Specifies the midpoint value of a region map chart series.| +||[gradientMinimumColor](/.chartseries#excel-javascript/api/excel/-chartseries-gradientminimumcolor-member)|Specifies the color for the minimum value of a region map chart series.| +||[gradientMinimumType](/.chartseries#excel-javascript/api/excel/-chartseries-gradientminimumtype-member)|Specifies the type for the minimum value of a region map chart series.| +||[gradientMinimumValue](/.chartseries#excel-javascript/api/excel/-chartseries-gradientminimumvalue-member)|Specifies the minimum value of a region map chart series.| +||[gradientStyle](/.chartseries#excel-javascript/api/excel/-chartseries-gradientstyle-member)|Specifies the series gradient style of a region map chart.| +||[invertColor](/.chartseries#excel-javascript/api/excel/-chartseries-invertcolor-member)|Specifies the fill color for negative data points in a series.| +||[mapOptions](/.chartseries#excel-javascript/api/excel/-chartseries-mapoptions-member)|Encapsulates the options for a region map chart.| +||[parentLabelStrategy](/.chartseries#excel-javascript/api/excel/-chartseries-parentlabelstrategy-member)|Specifies the series parent label strategy area for a treemap chart.| +||[showConnectorLines](/.chartseries#excel-javascript/api/excel/-chartseries-showconnectorlines-member)|Specifies whether connector lines are shown in waterfall charts.| +||[showLeaderLines](/.chartseries#excel-javascript/api/excel/-chartseries-showleaderlines-member)|Specifies whether leader lines are displayed for each data label in the series.| +||[splitValue](/.chartseries#excel-javascript/api/excel/-chartseries-splitvalue-member)|Specifies the threshold value that separates two sections of either a pie-of-pie chart or a bar-of-pie chart.| +||[xErrorBars](/.chartseries#excel-javascript/api/excel/-chartseries-xerrorbars-member)|Represents the error bar object of a chart series.| +||[yErrorBars](/.chartseries#excel-javascript/api/excel/-chartseries-yerrorbars-member)|Represents the error bar object of a chart series.| +|[ChartTrendlineLabel](/.charttrendlinelabel)|[linkNumberFormat](/.charttrendlinelabel#excel-javascript/api/excel/-charttrendlinelabel-linknumberformat-member)|Specifies if the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells).| +|[ColumnProperties](/.columnproperties)|[address](/.columnproperties#excel-javascript/api/excel/-columnproperties-address-member)|Represents the `address` property.| +||[addressLocal](/.columnproperties#excel-javascript/api/excel/-columnproperties-addresslocal-member)|Represents the `addressLocal` property.| +||[columnIndex](/.columnproperties#excel-javascript/api/excel/-columnproperties-columnindex-member)|Represents the `columnIndex` property.| +|[ConditionalFormat](/.conditionalformat)|[getRanges()](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-getranges-member(1))|Returns the `RangeAreas`, comprising one or more rectangular ranges, to which the conditional format is applied.| +|[DataValidation](/.datavalidation)|[getInvalidCells()](/.datavalidation#excel-javascript/api/excel/-datavalidation-getinvalidcells-member(1))|Returns a `RangeAreas` object, comprising one or more rectangular ranges, with invalid cell values.| +||[getInvalidCellsOrNullObject()](/.datavalidation#excel-javascript/api/excel/-datavalidation-getinvalidcellsornullobject-member(1))|Returns a `RangeAreas` object, comprising one or more rectangular ranges, with invalid cell values.| +|[FilterCriteria](/.filtercriteria)|[subField](/.filtercriteria#excel-javascript/api/excel/-filtercriteria-subfield-member)|The property used by the filter to do a rich filter on rich values.| +|[GeometricShape](/.geometricshape)|[id](/.geometricshape#excel-javascript/api/excel/-geometricshape-id-member)|Returns the shape identifier.| +||[shape](/.geometricshape#excel-javascript/api/excel/-geometricshape-shape-member)|Returns the `Shape` object for the geometric shape.| +|[GroupShapeCollection](/.groupshapecollection)|[getCount()](/.groupshapecollection#excel-javascript/api/excel/-groupshapecollection-getcount-member(1))|Returns the number of shapes in the shape group.| +||[getItem(key: string)](/.groupshapecollection#excel-javascript/api/excel/-groupshapecollection-getitem-member(1))|Gets a shape using its name or ID.| +||[getItemAt(index: number)](/.groupshapecollection#excel-javascript/api/excel/-groupshapecollection-getitemat-member(1))|Gets a shape based on its position in the collection.| +||[items](/.groupshapecollection#excel-javascript/api/excel/-groupshapecollection-items-member)|Gets the loaded child items in this collection.| +|[HeaderFooter](/.headerfooter)|[centerFooter](/.headerfooter#excel-javascript/api/excel/-headerfooter-centerfooter-member)|The center footer of the worksheet.| +||[centerHeader](/.headerfooter#excel-javascript/api/excel/-headerfooter-centerheader-member)|The center header of the worksheet.| +||[leftFooter](/.headerfooter#excel-javascript/api/excel/-headerfooter-leftfooter-member)|The left footer of the worksheet.| +||[leftHeader](/.headerfooter#excel-javascript/api/excel/-headerfooter-leftheader-member)|The left header of the worksheet.| +||[rightFooter](/.headerfooter#excel-javascript/api/excel/-headerfooter-rightfooter-member)|The right footer of the worksheet.| +||[rightHeader](/.headerfooter#excel-javascript/api/excel/-headerfooter-rightheader-member)|The right header of the worksheet.| +|[HeaderFooterGroup](/.headerfootergroup)|[defaultForAllPages](/.headerfootergroup#excel-javascript/api/excel/-headerfootergroup-defaultforallpages-member)|The general header/footer, used for all pages unless even/odd or first page is specified.| +||[evenPages](/.headerfootergroup#excel-javascript/api/excel/-headerfootergroup-evenpages-member)|The header/footer to use for even pages, odd header/footer needs to be specified for odd pages.| +||[firstPage](/.headerfootergroup#excel-javascript/api/excel/-headerfootergroup-firstpage-member)|The first page header/footer, for all other pages general or even/odd is used.| +||[oddPages](/.headerfootergroup#excel-javascript/api/excel/-headerfootergroup-oddpages-member)|The header/footer to use for odd pages, even header/footer needs to be specified for even pages.| +||[state](/.headerfootergroup#excel-javascript/api/excel/-headerfootergroup-state-member)|The state by which headers/footers are set.| +||[useSheetMargins](/.headerfootergroup#excel-javascript/api/excel/-headerfootergroup-usesheetmargins-member)|Gets or sets a flag indicating if headers/footers are aligned with the page margins set in the page layout options for the worksheet.| +||[useSheetScale](/.headerfootergroup#excel-javascript/api/excel/-headerfootergroup-usesheetscale-member)|Gets or sets a flag indicating if headers/footers should be scaled by the page percentage scale set in the page layout options for the worksheet.| +|[Image](/.image)|[format](/.image#excel-javascript/api/excel/-image-format-member)|Returns the format of the image.| +||[id](/.image#excel-javascript/api/excel/-image-id-member)|Specifies the shape identifier for the image object.| +||[shape](/.image#excel-javascript/api/excel/-image-shape-member)|Returns the `Shape` object associated with the image.| +|[IterativeCalculation](/.iterativecalculation)|[enabled](/.iterativecalculation#excel-javascript/api/excel/-iterativecalculation-enabled-member)|True if Excel will use iteration to resolve circular references.| +||[maxChange](/.iterativecalculation#excel-javascript/api/excel/-iterativecalculation-maxchange-member)|Specifies the maximum amount of change between each iteration as Excel resolves circular references.| +||[maxIteration](/.iterativecalculation#excel-javascript/api/excel/-iterativecalculation-maxiteration-member)|Specifies the maximum number of iterations that Excel can use to resolve a circular reference.| +|[Line](/.line)|[beginArrowheadLength](/.line#excel-javascript/api/excel/-line-beginarrowheadlength-member)|Represents the length of the arrowhead at the beginning of the specified line.| +||[beginArrowheadStyle](/.line#excel-javascript/api/excel/-line-beginarrowheadstyle-member)|Represents the style of the arrowhead at the beginning of the specified line.| +||[beginArrowheadWidth](/.line#excel-javascript/api/excel/-line-beginarrowheadwidth-member)|Represents the width of the arrowhead at the beginning of the specified line.| +||[beginConnectedShape](/.line#excel-javascript/api/excel/-line-beginconnectedshape-member)|Represents the shape to which the beginning of the specified line is attached.| +||[beginConnectedSite](/.line#excel-javascript/api/excel/-line-beginconnectedsite-member)|Represents the connection site to which the beginning of a connector is connected.| +||[connectBeginShape(shape: Excel.Shape, connectionSite: number)](/.line#excel-javascript/api/excel/-line-connectbeginshape-member(1))|Attaches the beginning of the specified connector to a specified shape.| +||[connectEndShape(shape: Excel.Shape, connectionSite: number)](/.line#excel-javascript/api/excel/-line-connectendshape-member(1))|Attaches the end of the specified connector to a specified shape.| +||[connectorType](/.line#excel-javascript/api/excel/-line-connectortype-member)|Represents the connector type for the line.| +||[disconnectBeginShape()](/.line#excel-javascript/api/excel/-line-disconnectbeginshape-member(1))|Detaches the beginning of the specified connector from a shape.| +||[disconnectEndShape()](/.line#excel-javascript/api/excel/-line-disconnectendshape-member(1))|Detaches the end of the specified connector from a shape.| +||[endArrowheadLength](/.line#excel-javascript/api/excel/-line-endarrowheadlength-member)|Represents the length of the arrowhead at the end of the specified line.| +||[endArrowheadStyle](/.line#excel-javascript/api/excel/-line-endarrowheadstyle-member)|Represents the style of the arrowhead at the end of the specified line.| +||[endArrowheadWidth](/.line#excel-javascript/api/excel/-line-endarrowheadwidth-member)|Represents the width of the arrowhead at the end of the specified line.| +||[endConnectedShape](/.line#excel-javascript/api/excel/-line-endconnectedshape-member)|Represents the shape to which the end of the specified line is attached.| +||[endConnectedSite](/.line#excel-javascript/api/excel/-line-endconnectedsite-member)|Represents the connection site to which the end of a connector is connected.| +||[id](/.line#excel-javascript/api/excel/-line-id-member)|Specifies the shape identifier.| +||[isBeginConnected](/.line#excel-javascript/api/excel/-line-isbeginconnected-member)|Specifies if the beginning of the specified line is connected to a shape.| +||[isEndConnected](/.line#excel-javascript/api/excel/-line-isendconnected-member)|Specifies if the end of the specified line is connected to a shape.| +||[shape](/.line#excel-javascript/api/excel/-line-shape-member)|Returns the `Shape` object associated with the line.| +|[PageBreak](/.pagebreak)|[columnIndex](/.pagebreak#excel-javascript/api/excel/-pagebreak-columnindex-member)|Specifies the column index for the page break.| +||[delete()](/.pagebreak#excel-javascript/api/excel/-pagebreak-delete-member(1))|Deletes a page break object.| +||[getCellAfterBreak()](/.pagebreak#excel-javascript/api/excel/-pagebreak-getcellafterbreak-member(1))|Gets the first cell after the page break.| +||[rowIndex](/.pagebreak#excel-javascript/api/excel/-pagebreak-rowindex-member)|Specifies the row index for the page break.| +|[PageBreakCollection](/.pagebreakcollection)|[add(pageBreakRange: Range \| string)](/.pagebreakcollection#excel-javascript/api/excel/-pagebreakcollection-add-member(1))|Adds a page break before the top-left cell of the range specified.| +||[getCount()](/.pagebreakcollection#excel-javascript/api/excel/-pagebreakcollection-getcount-member(1))|Gets the number of page breaks in the collection.| +||[getItem(index: number)](/.pagebreakcollection#excel-javascript/api/excel/-pagebreakcollection-getitem-member(1))|Gets a page break object via the index.| +||[items](/.pagebreakcollection#excel-javascript/api/excel/-pagebreakcollection-items-member)|Gets the loaded child items in this collection.| +||[removePageBreaks()](/.pagebreakcollection#excel-javascript/api/excel/-pagebreakcollection-removepagebreaks-member(1))|Resets all manual page breaks in the collection.| +|[PageLayout](/.pagelayout)|[blackAndWhite](/.pagelayout#excel-javascript/api/excel/-pagelayout-blackandwhite-member)|The worksheet's black and white print option.| +||[bottomMargin](/.pagelayout#excel-javascript/api/excel/-pagelayout-bottommargin-member)|The worksheet's bottom page margin to use for printing in points.| +||[centerHorizontally](/.pagelayout#excel-javascript/api/excel/-pagelayout-centerhorizontally-member)|The worksheet's center horizontally flag.| +||[centerVertically](/.pagelayout#excel-javascript/api/excel/-pagelayout-centervertically-member)|The worksheet's center vertically flag.| +||[draftMode](/.pagelayout#excel-javascript/api/excel/-pagelayout-draftmode-member)|The worksheet's draft mode option.| +||[firstPageNumber](/.pagelayout#excel-javascript/api/excel/-pagelayout-firstpagenumber-member)|The worksheet's first page number to print.| +||[footerMargin](/.pagelayout#excel-javascript/api/excel/-pagelayout-footermargin-member)|The worksheet's footer margin, in points, for use when printing.| +||[getPrintArea()](/.pagelayout#excel-javascript/api/excel/-pagelayout-getprintarea-member(1))|Gets the `RangeAreas` object, comprising one or more rectangular ranges, that represents the print area for the worksheet.| +||[getPrintAreaOrNullObject()](/.pagelayout#excel-javascript/api/excel/-pagelayout-getprintareaornullobject-member(1))|Gets the `RangeAreas` object, comprising one or more rectangular ranges, that represents the print area for the worksheet.| +||[getPrintTitleColumns()](/.pagelayout#excel-javascript/api/excel/-pagelayout-getprinttitlecolumns-member(1))|Gets the range object representing the title columns.| +||[getPrintTitleColumnsOrNullObject()](/.pagelayout#excel-javascript/api/excel/-pagelayout-getprinttitlecolumnsornullobject-member(1))|Gets the range object representing the title columns.| +||[getPrintTitleRows()](/.pagelayout#excel-javascript/api/excel/-pagelayout-getprinttitlerows-member(1))|Gets the range object representing the title rows.| +||[getPrintTitleRowsOrNullObject()](/.pagelayout#excel-javascript/api/excel/-pagelayout-getprinttitlerowsornullobject-member(1))|Gets the range object representing the title rows.| +||[headerMargin](/.pagelayout#excel-javascript/api/excel/-pagelayout-headermargin-member)|The worksheet's header margin, in points, for use when printing.| +||[headersFooters](/.pagelayout#excel-javascript/api/excel/-pagelayout-headersfooters-member)|Header and footer configuration for the worksheet.| +||[leftMargin](/.pagelayout#excel-javascript/api/excel/-pagelayout-leftmargin-member)|The worksheet's left margin, in points, for use when printing.| +||[orientation](/.pagelayout#excel-javascript/api/excel/-pagelayout-orientation-member)|The worksheet's orientation of the page.| +||[paperSize](/.pagelayout#excel-javascript/api/excel/-pagelayout-papersize-member)|The worksheet's paper size of the page.| +||[printComments](/.pagelayout#excel-javascript/api/excel/-pagelayout-printcomments-member)|Specifies if the worksheet's comments should be displayed when printing.| +||[printErrors](/.pagelayout#excel-javascript/api/excel/-pagelayout-printerrors-member)|The worksheet's print errors option.| +||[printGridlines](/.pagelayout#excel-javascript/api/excel/-pagelayout-printgridlines-member)|Specifies if the worksheet's gridlines will be printed.| +||[printHeadings](/.pagelayout#excel-javascript/api/excel/-pagelayout-printheadings-member)|Specifies if the worksheet's headings will be printed.| +||[printOrder](/.pagelayout#excel-javascript/api/excel/-pagelayout-printorder-member)|The worksheet's page print order option.| +||[rightMargin](/.pagelayout#excel-javascript/api/excel/-pagelayout-rightmargin-member)|The worksheet's right margin, in points, for use when printing.| +||[setPrintArea(printArea: Range \| RangeAreas \| string)](/.pagelayout#excel-javascript/api/excel/-pagelayout-setprintarea-member(1))|Sets the worksheet's print area.| +||[setPrintMargins(unit: Excel.PrintMarginUnit, marginOptions: Excel.PageLayoutMarginOptions)](/.pagelayout#excel-javascript/api/excel/-pagelayout-setprintmargins-member(1))|Sets the worksheet's page margins with units.| +||[setPrintTitleColumns(printTitleColumns: Range \| string)](/.pagelayout#excel-javascript/api/excel/-pagelayout-setprinttitlecolumns-member(1))|Sets the columns that contain the cells to be repeated at the left of each page of the worksheet for printing.| +||[setPrintTitleRows(printTitleRows: Range \| string)](/.pagelayout#excel-javascript/api/excel/-pagelayout-setprinttitlerows-member(1))|Sets the rows that contain the cells to be repeated at the top of each page of the worksheet for printing.| +||[topMargin](/.pagelayout#excel-javascript/api/excel/-pagelayout-topmargin-member)|The worksheet's top margin, in points, for use when printing.| +||[zoom](/.pagelayout#excel-javascript/api/excel/-pagelayout-zoom-member)|The worksheet's print zoom options.| +|[PageLayoutMarginOptions](/.pagelayoutmarginoptions)|[bottom](/.pagelayoutmarginoptions#excel-javascript/api/excel/-pagelayoutmarginoptions-bottom-member)|Specifies the page layout bottom margin in the unit specified to use for printing.| +||[footer](/.pagelayoutmarginoptions#excel-javascript/api/excel/-pagelayoutmarginoptions-footer-member)|Specifies the page layout footer margin in the unit specified to use for printing.| +||[header](/.pagelayoutmarginoptions#excel-javascript/api/excel/-pagelayoutmarginoptions-header-member)|Specifies the page layout header margin in the unit specified to use for printing.| +||[left](/.pagelayoutmarginoptions#excel-javascript/api/excel/-pagelayoutmarginoptions-left-member)|Specifies the page layout left margin in the unit specified to use for printing.| +||[right](/.pagelayoutmarginoptions#excel-javascript/api/excel/-pagelayoutmarginoptions-right-member)|Specifies the page layout right margin in the unit specified to use for printing.| +||[top](/.pagelayoutmarginoptions#excel-javascript/api/excel/-pagelayoutmarginoptions-top-member)|Specifies the page layout top margin in the unit specified to use for printing.| +|[PageLayoutZoomOptions](/.pagelayoutzoomoptions)|[horizontalFitToPages](/.pagelayoutzoomoptions#excel-javascript/api/excel/-pagelayoutzoomoptions-horizontalfittopages-member)|Number of pages to fit horizontally.| +||[scale](/.pagelayoutzoomoptions#excel-javascript/api/excel/-pagelayoutzoomoptions-scale-member)|Print page scale value can be between 10 and 400.| +||[verticalFitToPages](/.pagelayoutzoomoptions#excel-javascript/api/excel/-pagelayoutzoomoptions-verticalfittopages-member)|Number of pages to fit vertically.| +|[PivotField](/.pivotfield)|[sortByValues(sortBy: Excel.SortBy, valuesHierarchy: Excel.DataPivotHierarchy, pivotItemScope?: Array)](/.pivotfield#excel-javascript/api/excel/-pivotfield-sortbyvalues-member(1))|Sorts the PivotField by specified values in a given scope.| +|[PivotLayout](/.pivotlayout)|[autoFormat](/.pivotlayout#excel-javascript/api/excel/-pivotlayout-autoformat-member)|Specifies if formatting will be automatically formatted when it's refreshed or when fields are moved.| +||[getDataHierarchy(cell: Range \| string)](/.pivotlayout#excel-javascript/api/excel/-pivotlayout-getdatahierarchy-member(1))|Gets the DataHierarchy that is used to calculate the value in a specified range within the PivotTable.| +||[getPivotItems(axis: Excel.PivotAxis, cell: Range \| string)](/.pivotlayout#excel-javascript/api/excel/-pivotlayout-getpivotitems-member(1))|Gets the PivotItems from an axis that make up the value in a specified range within the PivotTable.| +||[preserveFormatting](/.pivotlayout#excel-javascript/api/excel/-pivotlayout-preserveformatting-member)|Specifies if formatting is preserved when the report is refreshed or recalculated by operations such as pivoting, sorting, or changing page field items.| +||[setAutoSortOnCell(cell: Range \| string, sortBy: Excel.SortBy)](/.pivotlayout#excel-javascript/api/excel/-pivotlayout-setautosortoncell-member(1))|Sets the PivotTable to automatically sort using the specified cell to automatically select all necessary criteria and context.| +|[PivotTable](/.pivottable)|[enableDataValueEditing](/.pivottable#excel-javascript/api/excel/-pivottable-enabledatavalueediting-member)|Specifies if the PivotTable allows values in the data body to be edited by the user.| +||[useCustomSortLists](/.pivottable#excel-javascript/api/excel/-pivottable-usecustomsortlists-member)|Specifies if the PivotTable uses custom lists when sorting.| +|[Range](/.range)|[autoFill(destinationRange?: Range \| string, autoFillType?: Excel.AutoFillType)](/.range#excel-javascript/api/excel/-range-autofill-member(1))|Fills a range from the current range to the destination range using the specified AutoFill logic.| +||[convertDataTypeToText()](/.range#excel-javascript/api/excel/-range-convertdatatypetotext-member(1))|Converts the range cells with data types into text.| +||[convertToLinkedDataType(serviceID: number, languageCulture: string)](/.range#excel-javascript/api/excel/-range-converttolinkeddatatype-member(1))|Converts the range cells into linked data types in the worksheet.| +||[copyFrom(sourceRange: Range \| RangeAreas \| string, copyType?: Excel.RangeCopyType, skipBlanks?: boolean, transpose?: boolean)](/.range#excel-javascript/api/excel/-range-copyfrom-member(1))|Copies cell data or formatting from the source range or `RangeAreas` to the current range.| +||[find(text: string, criteria: Excel.SearchCriteria)](/.range#excel-javascript/api/excel/-range-find-member(1))|Finds the given string based on the criteria specified.| +||[findOrNullObject(text: string, criteria: Excel.SearchCriteria)](/.range#excel-javascript/api/excel/-range-findornullobject-member(1))|Finds the given string based on the criteria specified.| +||[flashFill()](/.range#excel-javascript/api/excel/-range-flashfill-member(1))|Does a Flash Fill to the current range.| +||[getCellProperties(cellPropertiesLoadOptions: CellPropertiesLoadOptions)](/.range#excel-javascript/api/excel/-range-getcellproperties-member(1))|Returns a 2D array, encapsulating the data for each cell's font, fill, borders, alignment, and other properties.| +||[getColumnProperties(columnPropertiesLoadOptions: ColumnPropertiesLoadOptions)](/.range#excel-javascript/api/excel/-range-getcolumnproperties-member(1))|Returns a single-dimensional array, encapsulating the data for each column's font, fill, borders, alignment, and other properties.| +||[getRowProperties(rowPropertiesLoadOptions: RowPropertiesLoadOptions)](/.range#excel-javascript/api/excel/-range-getrowproperties-member(1))|Returns a single-dimensional array, encapsulating the data for each row's font, fill, borders, alignment, and other properties.| +||[getSpecialCells(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType)](/.range#excel-javascript/api/excel/-range-getspecialcells-member(1))|Gets the `RangeAreas` object, comprising one or more rectangular ranges, that represents all the cells that match the specified type and value.| +||[getSpecialCellsOrNullObject(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType)](/.range#excel-javascript/api/excel/-range-getspecialcellsornullobject-member(1))|Gets the `RangeAreas` object, comprising one or more ranges, that represents all the cells that match the specified type and value.| +||[getTables(fullyContained?: boolean)](/.range#excel-javascript/api/excel/-range-gettables-member(1))|Gets a scoped collection of tables that overlap with the range.| +||[linkedDataTypeState](/.range#excel-javascript/api/excel/-range-linkeddatatypestate-member)|Represents the data type state of each cell.| +||[removeDuplicates(columns: number[], includesHeader: boolean)](/.range#excel-javascript/api/excel/-range-removeduplicates-member(1))|Removes duplicate values from the range specified by the columns.| +||[replaceAll(text: string, replacement: string, criteria: Excel.ReplaceCriteria)](/.range#excel-javascript/api/excel/-range-replaceall-member(1))|Finds and replaces the given string based on the criteria specified within the current range.| +||[setCellProperties(cellPropertiesData: SettableCellProperties[][])](/.range#excel-javascript/api/excel/-range-setcellproperties-member(1))|Updates the range based on a 2D array of cell properties, encapsulating things like font, fill, borders, and alignment.| +||[setColumnProperties(columnPropertiesData: SettableColumnProperties[])](/.range#excel-javascript/api/excel/-range-setcolumnproperties-member(1))|Updates the range based on a single-dimensional array of column properties, encapsulating things like font, fill, borders, and alignment.| +||[setDirty()](/.range#excel-javascript/api/excel/-range-setdirty-member(1))|Set a range to be recalculated when the next recalculation occurs.| +||[setRowProperties(rowPropertiesData: SettableRowProperties[])](/.range#excel-javascript/api/excel/-range-setrowproperties-member(1))|Updates the range based on a single-dimensional array of row properties, encapsulating things like font, fill, borders, and alignment.| +|[RangeAreas](/.rangeareas)|[address](/.rangeareas#excel-javascript/api/excel/-rangeareas-address-member)|Returns the `RangeAreas` reference in A1-style.| +||[addressLocal](/.rangeareas#excel-javascript/api/excel/-rangeareas-addresslocal-member)|Returns the `RangeAreas` reference in the user locale.| +||[areaCount](/.rangeareas#excel-javascript/api/excel/-rangeareas-areacount-member)|Returns the number of rectangular ranges that comprise this `RangeAreas` object.| +||[areas](/.rangeareas#excel-javascript/api/excel/-rangeareas-areas-member)|Returns a collection of rectangular ranges that comprise this `RangeAreas` object.| +||[calculate()](/.rangeareas#excel-javascript/api/excel/-rangeareas-calculate-member(1))|Calculates all cells in the `RangeAreas`.| +||[cellCount](/.rangeareas#excel-javascript/api/excel/-rangeareas-cellcount-member)|Returns the number of cells in the `RangeAreas` object, summing up the cell counts of all of the individual rectangular ranges.| +||[clear(applyTo?: Excel.ClearApplyTo)](/.rangeareas#excel-javascript/api/excel/-rangeareas-clear-member(1))|Clears values, format, fill, border, and other properties on each of the areas that comprise this `RangeAreas` object.| +||[conditionalFormats](/.rangeareas#excel-javascript/api/excel/-rangeareas-conditionalformats-member)|Returns a collection of conditional formats that intersect with any cells in this `RangeAreas` object.| +||[convertDataTypeToText()](/.rangeareas#excel-javascript/api/excel/-rangeareas-convertdatatypetotext-member(1))|Converts all cells in the `RangeAreas` with data types into text.| +||[convertToLinkedDataType(serviceID: number, languageCulture: string)](/.rangeareas#excel-javascript/api/excel/-rangeareas-converttolinkeddatatype-member(1))|Converts all cells in the `RangeAreas` into linked data types.| +||[copyFrom(sourceRange: Range \| RangeAreas \| string, copyType?: Excel.RangeCopyType, skipBlanks?: boolean, transpose?: boolean)](/.rangeareas#excel-javascript/api/excel/-rangeareas-copyfrom-member(1))|Copies cell data or formatting from the source range or `RangeAreas` to the current `RangeAreas`.| +||[dataValidation](/.rangeareas#excel-javascript/api/excel/-rangeareas-datavalidation-member)|Returns a data validation object for all ranges in the `RangeAreas`.| +||[format](/.rangeareas#excel-javascript/api/excel/-rangeareas-format-member)|Returns a `RangeFormat` object, encapsulating the font, fill, borders, alignment, and other properties for all ranges in the `RangeAreas` object.| +||[getEntireColumn()](/.rangeareas#excel-javascript/api/excel/-rangeareas-getentirecolumn-member(1))|Returns a `RangeAreas` object that represents the entire columns of the `RangeAreas` (for example, if the current `RangeAreas` represents cells "B4:E11, H2", it returns a `RangeAreas` that represents columns "B:E, H:H").| +||[getEntireRow()](/.rangeareas#excel-javascript/api/excel/-rangeareas-getentirerow-member(1))|Returns a `RangeAreas` object that represents the entire rows of the `RangeAreas` (for example, if the current `RangeAreas` represents cells "B4:E11", it returns a `RangeAreas` that represents rows "4:11").| +||[getIntersection(anotherRange: Range \| RangeAreas \| string)](/.rangeareas#excel-javascript/api/excel/-rangeareas-getintersection-member(1))|Returns the `RangeAreas` object that represents the intersection of the given ranges or `RangeAreas`.| +||[getIntersectionOrNullObject(anotherRange: Range \| RangeAreas \| string)](/.rangeareas#excel-javascript/api/excel/-rangeareas-getintersectionornullobject-member(1))|Returns the `RangeAreas` object that represents the intersection of the given ranges or `RangeAreas`.| +||[getOffsetRangeAreas(rowOffset: number, columnOffset: number)](/.rangeareas#excel-javascript/api/excel/-rangeareas-getoffsetrangeareas-member(1))|Returns a `RangeAreas` object that is shifted by the specific row and column offset.| +||[getSpecialCells(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType)](/.rangeareas#excel-javascript/api/excel/-rangeareas-getspecialcells-member(1))|Returns a `RangeAreas` object that represents all the cells that match the specified type and value.| +||[getSpecialCellsOrNullObject(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType)](/.rangeareas#excel-javascript/api/excel/-rangeareas-getspecialcellsornullobject-member(1))|Returns a `RangeAreas` object that represents all the cells that match the specified type and value.| +||[getTables(fullyContained?: boolean)](/.rangeareas#excel-javascript/api/excel/-rangeareas-gettables-member(1))|Returns a scoped collection of tables that overlap with any range in this `RangeAreas` object.| +||[getUsedRangeAreas(valuesOnly?: boolean)](/.rangeareas#excel-javascript/api/excel/-rangeareas-getusedrangeareas-member(1))|Returns the used `RangeAreas` that comprises all the used areas of individual rectangular ranges in the `RangeAreas` object.| +||[getUsedRangeAreasOrNullObject(valuesOnly?: boolean)](/.rangeareas#excel-javascript/api/excel/-rangeareas-getusedrangeareasornullobject-member(1))|Returns the used `RangeAreas` that comprises all the used areas of individual rectangular ranges in the `RangeAreas` object.| +||[isEntireColumn](/.rangeareas#excel-javascript/api/excel/-rangeareas-isentirecolumn-member)|Specifies if all the ranges on this `RangeAreas` object represent entire columns (e.g., "A:C, Q:Z").| +||[isEntireRow](/.rangeareas#excel-javascript/api/excel/-rangeareas-isentirerow-member)|Specifies if all the ranges on this `RangeAreas` object represent entire rows (e.g., "1:3, 5:7").| +||[setDirty()](/.rangeareas#excel-javascript/api/excel/-rangeareas-setdirty-member(1))|Sets the `RangeAreas` to be recalculated when the next recalculation occurs.| +||[style](/.rangeareas#excel-javascript/api/excel/-rangeareas-style-member)|Represents the style for all ranges in this `RangeAreas` object.| +||[worksheet](/.rangeareas#excel-javascript/api/excel/-rangeareas-worksheet-member)|Returns the worksheet for the current `RangeAreas`.| +|[RangeBorder](/.rangeborder)|[tintAndShade](/.rangeborder#excel-javascript/api/excel/-rangeborder-tintandshade-member)|Specifies a double that lightens or darkens a color for the range border, the value is between -1 (darkest) and 1 (brightest), with 0 for the original color.| +|[RangeBorderCollection](/.rangebordercollection)|[tintAndShade](/.rangebordercollection#excel-javascript/api/excel/-rangebordercollection-tintandshade-member)|Specifies a double that lightens or darkens a color for range borders.| +|[RangeCollection](/.rangecollection)|[getCount()](/.rangecollection#excel-javascript/api/excel/-rangecollection-getcount-member(1))|Returns the number of ranges in the `RangeCollection`.| +||[getItemAt(index: number)](/.rangecollection#excel-javascript/api/excel/-rangecollection-getitemat-member(1))|Returns the range object based on its position in the `RangeCollection`.| +||[items](/.rangecollection#excel-javascript/api/excel/-rangecollection-items-member)|Gets the loaded child items in this collection.| +|[RangeFill](/.rangefill)|[pattern](/.rangefill#excel-javascript/api/excel/-rangefill-pattern-member)|The pattern of a range.| +||[patternColor](/.rangefill#excel-javascript/api/excel/-rangefill-patterncolor-member)|The HTML color code representing the color of the range pattern, in the form #RRGGBB (e.g., "FFA500"), or as a named HTML color (e.g., "orange").| +||[patternTintAndShade](/.rangefill#excel-javascript/api/excel/-rangefill-patterntintandshade-member)|Specifies a double that lightens or darkens a pattern color for the range fill.| +||[tintAndShade](/.rangefill#excel-javascript/api/excel/-rangefill-tintandshade-member)|Specifies a double that lightens or darkens a color for the range fill.| +|[RangeFont](/.rangefont)|[strikethrough](/.rangefont#excel-javascript/api/excel/-rangefont-strikethrough-member)|Specifies the strikethrough status of font.| +||[subscript](/.rangefont#excel-javascript/api/excel/-rangefont-subscript-member)|Specifies the subscript status of font.| +||[superscript](/.rangefont#excel-javascript/api/excel/-rangefont-superscript-member)|Specifies the superscript status of font.| +||[tintAndShade](/.rangefont#excel-javascript/api/excel/-rangefont-tintandshade-member)|Specifies a double that lightens or darkens a color for the range font.| +|[RangeFormat](/.rangeformat)|[autoIndent](/.rangeformat#excel-javascript/api/excel/-rangeformat-autoindent-member)|Specifies if text is automatically indented when text alignment is set to equal distribution.| +||[indentLevel](/.rangeformat#excel-javascript/api/excel/-rangeformat-indentlevel-member)|An integer from 0 to 250 that indicates the indent level.| +||[readingOrder](/.rangeformat#excel-javascript/api/excel/-rangeformat-readingorder-member)|The reading order for the range.| +||[shrinkToFit](/.rangeformat#excel-javascript/api/excel/-rangeformat-shrinktofit-member)|Specifies if text automatically shrinks to fit in the available column width.| +|[RemoveDuplicatesResult](/.removeduplicatesresult)|[removed](/.removeduplicatesresult#excel-javascript/api/excel/-removeduplicatesresult-removed-member)|Number of duplicated rows removed by the operation.| +||[uniqueRemaining](/.removeduplicatesresult#excel-javascript/api/excel/-removeduplicatesresult-uniqueremaining-member)|Number of remaining unique rows present in the resulting range.| +|[ReplaceCriteria](/.replacecriteria)|[completeMatch](/.replacecriteria#excel-javascript/api/excel/-replacecriteria-completematch-member)|Specifies if the match needs to be complete or partial.| +||[matchCase](/.replacecriteria#excel-javascript/api/excel/-replacecriteria-matchcase-member)|Specifies if the match is case-sensitive.| +|[RowProperties](/.rowproperties)|[address](/.rowproperties#excel-javascript/api/excel/-rowproperties-address-member)|Represents the `address` property.| +||[addressLocal](/.rowproperties#excel-javascript/api/excel/-rowproperties-addresslocal-member)|Represents the `addressLocal` property.| +||[rowIndex](/.rowproperties#excel-javascript/api/excel/-rowproperties-rowindex-member)|Represents the `rowIndex` property.| +|[SearchCriteria](/.searchcriteria)|[completeMatch](/.searchcriteria#excel-javascript/api/excel/-searchcriteria-completematch-member)|Specifies if the match needs to be complete or partial.| +||[matchCase](/.searchcriteria#excel-javascript/api/excel/-searchcriteria-matchcase-member)|Specifies if the match is case-sensitive.| +||[searchDirection](/.searchcriteria#excel-javascript/api/excel/-searchcriteria-searchdirection-member)|Specifies the search direction.| +|[SettableCellProperties](/.settablecellproperties)|[format](/.settablecellproperties#excel-javascript/api/excel/-settablecellproperties-format-member)|Represents the `format` property.| +||[hyperlink](/.settablecellproperties#excel-javascript/api/excel/-settablecellproperties-hyperlink-member)|Represents the `hyperlink` property.| +||[style](/.settablecellproperties#excel-javascript/api/excel/-settablecellproperties-style-member)|Represents the `style` property.| +|[SettableColumnProperties](/.settablecolumnproperties)|[columnHidden](/.settablecolumnproperties#excel-javascript/api/excel/-settablecolumnproperties-columnhidden-member)|Represents the `columnHidden` property.| +||[format](/.settablecolumnproperties#excel-javascript/api/excel/-settablecolumnproperties-format-member)|Represents the `format` property.| +|[SettableRowProperties](/.settablerowproperties)|[format](/.settablerowproperties#excel-javascript/api/excel/-settablerowproperties-format-member)|Represents the `format` property.| +||[rowHidden](/.settablerowproperties#excel-javascript/api/excel/-settablerowproperties-rowhidden-member)|Represents the `rowHidden` property.| +|[Shape](/.shape)|[altTextDescription](/.shape#excel-javascript/api/excel/-shape-alttextdescription-member)|Specifies the alternative description text for a `Shape` object.| +||[altTextTitle](/.shape#excel-javascript/api/excel/-shape-alttexttitle-member)|Specifies the alternative title text for a `Shape` object.| +||[connectionSiteCount](/.shape#excel-javascript/api/excel/-shape-connectionsitecount-member)|Returns the number of connection sites on this shape.| +||[delete()](/.shape#excel-javascript/api/excel/-shape-delete-member(1))|Removes the shape from the worksheet.| +||[fill](/.shape#excel-javascript/api/excel/-shape-fill-member)|Returns the fill formatting of this shape.| +||[geometricShape](/.shape#excel-javascript/api/excel/-shape-geometricshape-member)|Returns the geometric shape associated with the shape.| +||[geometricShapeType](/.shape#excel-javascript/api/excel/-shape-geometricshapetype-member)|Specifies the geometric shape type of this geometric shape.| +||[getAsImage(format: Excel.PictureFormat)](/.shape#excel-javascript/api/excel/-shape-getasimage-member(1))|Converts the shape to an image and returns the image as a Base64-encoded string.| +||[group](/.shape#excel-javascript/api/excel/-shape-group-member)|Returns the shape group associated with the shape.| +||[height](/.shape#excel-javascript/api/excel/-shape-height-member)|Specifies the height, in points, of the shape.| +||[id](/.shape#excel-javascript/api/excel/-shape-id-member)|Specifies the shape identifier.| +||[image](/.shape#excel-javascript/api/excel/-shape-image-member)|Returns the image associated with the shape.| +||[incrementLeft(increment: number)](/.shape#excel-javascript/api/excel/-shape-incrementleft-member(1))|Moves the shape horizontally by the specified number of points.| +||[incrementRotation(increment: number)](/.shape#excel-javascript/api/excel/-shape-incrementrotation-member(1))|Rotates the shape clockwise around the z-axis by the specified number of degrees.| +||[incrementTop(increment: number)](/.shape#excel-javascript/api/excel/-shape-incrementtop-member(1))|Moves the shape vertically by the specified number of points.| +||[left](/.shape#excel-javascript/api/excel/-shape-left-member)|The distance, in points, from the left side of the shape to the left side of the worksheet.| +||[level](/.shape#excel-javascript/api/excel/-shape-level-member)|Specifies the level of the specified shape.| +||[line](/.shape#excel-javascript/api/excel/-shape-line-member)|Returns the line associated with the shape.| +||[lineFormat](/.shape#excel-javascript/api/excel/-shape-lineformat-member)|Returns the line formatting of this shape.| +||[lockAspectRatio](/.shape#excel-javascript/api/excel/-shape-lockaspectratio-member)|Specifies if the aspect ratio of this shape is locked.| +||[name](/.shape#excel-javascript/api/excel/-shape-name-member)|Specifies the name of the shape.| +||[onActivated](/.shape#excel-javascript/api/excel/-shape-onactivated-member)|Occurs when the shape is activated.| +||[onDeactivated](/.shape#excel-javascript/api/excel/-shape-ondeactivated-member)|Occurs when the shape is deactivated.| +||[parentGroup](/.shape#excel-javascript/api/excel/-shape-parentgroup-member)|Specifies the parent group of this shape.| +||[rotation](/.shape#excel-javascript/api/excel/-shape-rotation-member)|Specifies the rotation, in degrees, of the shape.| +||[scaleHeight(scaleFactor: number, scaleType: Excel.ShapeScaleType, scaleFrom?: Excel.ShapeScaleFrom)](/.shape#excel-javascript/api/excel/-shape-scaleheight-member(1))|Scales the height of the shape by a specified factor.| +||[scaleWidth(scaleFactor: number, scaleType: Excel.ShapeScaleType, scaleFrom?: Excel.ShapeScaleFrom)](/.shape#excel-javascript/api/excel/-shape-scalewidth-member(1))|Scales the width of the shape by a specified factor.| +||[setZOrder(position: Excel.ShapeZOrder)](/.shape#excel-javascript/api/excel/-shape-setzorder-member(1))|Moves the specified shape up or down the collection's z-order, which shifts it in front of or behind other shapes.| +||[textFrame](/.shape#excel-javascript/api/excel/-shape-textframe-member)|Returns the text frame object of this shape.| +||[top](/.shape#excel-javascript/api/excel/-shape-top-member)|The distance, in points, from the top edge of the shape to the top edge of the worksheet.| +||[type](/.shape#excel-javascript/api/excel/-shape-type-member)|Returns the type of this shape.| +||[visible](/.shape#excel-javascript/api/excel/-shape-visible-member)|Specifies if the shape is visible.| +||[width](/.shape#excel-javascript/api/excel/-shape-width-member)|Specifies the width, in points, of the shape.| +||[zOrderPosition](/.shape#excel-javascript/api/excel/-shape-zorderposition-member)|Returns the position of the specified shape in the z-order, with 0 representing the bottom of the order stack.| +|[ShapeActivatedEventArgs](/.shapeactivatedeventargs)|[shapeId](/.shapeactivatedeventargs#excel-javascript/api/excel/-shapeactivatedeventargs-shapeid-member)|Gets the ID of the activated shape.| +||[type](/.shapeactivatedeventargs#excel-javascript/api/excel/-shapeactivatedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/.shapeactivatedeventargs#excel-javascript/api/excel/-shapeactivatedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the shape is activated.| +|[ShapeCollection](/.shapecollection)|[addGeometricShape(geometricShapeType: Excel.GeometricShapeType)](/.shapecollection#excel-javascript/api/excel/-shapecollection-addgeometricshape-member(1))|Adds a geometric shape to the worksheet.| +||[addGroup(values: Array)](/.shapecollection#excel-javascript/api/excel/-shapecollection-addgroup-member(1))|Groups a subset of shapes in this collection's worksheet.| +||[addImage(base64ImageString: string)](/.shapecollection#excel-javascript/api/excel/-shapecollection-addimage-member(1))|Creates an image from a Base64-encoded string and adds it to the worksheet.| +||[addLine(startLeft: number, startTop: number, endLeft: number, endTop: number, connectorType?: Excel.ConnectorType)](/.shapecollection#excel-javascript/api/excel/-shapecollection-addline-member(1))|Adds a line to worksheet.| +||[addTextBox(text?: string)](/.shapecollection#excel-javascript/api/excel/-shapecollection-addtextbox-member(1))|Adds a text box to the worksheet with the provided text as the content.| +||[getCount()](/.shapecollection#excel-javascript/api/excel/-shapecollection-getcount-member(1))|Returns the number of shapes in the worksheet.| +||[getItem(key: string)](/.shapecollection#excel-javascript/api/excel/-shapecollection-getitem-member(1))|Gets a shape using its name or ID.| +||[getItemAt(index: number)](/.shapecollection#excel-javascript/api/excel/-shapecollection-getitemat-member(1))|Gets a shape using its position in the collection.| +||[items](/.shapecollection#excel-javascript/api/excel/-shapecollection-items-member)|Gets the loaded child items in this collection.| +|[ShapeDeactivatedEventArgs](/.shapedeactivatedeventargs)|[shapeId](/.shapedeactivatedeventargs#excel-javascript/api/excel/-shapedeactivatedeventargs-shapeid-member)|Gets the ID of the shape deactivated shape.| +||[type](/.shapedeactivatedeventargs#excel-javascript/api/excel/-shapedeactivatedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/.shapedeactivatedeventargs#excel-javascript/api/excel/-shapedeactivatedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the shape is deactivated.| +|[ShapeFill](/.shapefill)|[clear()](/.shapefill#excel-javascript/api/excel/-shapefill-clear-member(1))|Clears the fill formatting of this shape.| +||[foregroundColor](/.shapefill#excel-javascript/api/excel/-shapefill-foregroundcolor-member)|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")| +||[setSolidColor(color: string)](/.shapefill#excel-javascript/api/excel/-shapefill-setsolidcolor-member(1))|Sets the fill formatting of the shape to a uniform color.| +||[transparency](/.shapefill#excel-javascript/api/excel/-shapefill-transparency-member)|Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).| +||[type](/.shapefill#excel-javascript/api/excel/-shapefill-type-member)|Returns the fill type of the shape.| +|[ShapeFont](/.shapefont)|[bold](/.shapefont#excel-javascript/api/excel/-shapefont-bold-member)|Represents the bold status of font.| +||[color](/.shapefont#excel-javascript/api/excel/-shapefont-color-member)|HTML color code representation of the text color (e.g., "#FF0000" represents red).| +||[italic](/.shapefont#excel-javascript/api/excel/-shapefont-italic-member)|Represents the italic status of font.| +||[name](/.shapefont#excel-javascript/api/excel/-shapefont-name-member)|Represents font name (e.g., "Calibri").| +||[size](/.shapefont#excel-javascript/api/excel/-shapefont-size-member)|Represents font size in points (e.g., 11).| +||[underline](/.shapefont#excel-javascript/api/excel/-shapefont-underline-member)|Type of underline applied to the font.| +|[ShapeGroup](/.shapegroup)|[id](/.shapegroup#excel-javascript/api/excel/-shapegroup-id-member)|Specifies the shape identifier.| +||[shape](/.shapegroup#excel-javascript/api/excel/-shapegroup-shape-member)|Returns the `Shape` object associated with the group.| +||[shapes](/.shapegroup#excel-javascript/api/excel/-shapegroup-shapes-member)|Returns the collection of `Shape` objects.| +||[ungroup()](/.shapegroup#excel-javascript/api/excel/-shapegroup-ungroup-member(1))|Ungroups any grouped shapes in the specified shape group.| +|[ShapeLineFormat](/.shapelineformat)|[color](/.shapelineformat#excel-javascript/api/excel/-shapelineformat-color-member)|Represents the line color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").| +||[dashStyle](/.shapelineformat#excel-javascript/api/excel/-shapelineformat-dashstyle-member)|Represents the line style of the shape.| +||[style](/.shapelineformat#excel-javascript/api/excel/-shapelineformat-style-member)|Represents the line style of the shape.| +||[transparency](/.shapelineformat#excel-javascript/api/excel/-shapelineformat-transparency-member)|Represents the degree of transparency of the specified line as a value from 0.0 (opaque) through 1.0 (clear).| +||[visible](/.shapelineformat#excel-javascript/api/excel/-shapelineformat-visible-member)|Specifies if the line formatting of a shape element is visible.| +||[weight](/.shapelineformat#excel-javascript/api/excel/-shapelineformat-weight-member)|Represents the weight of the line, in points.| +|[SortField](/.sortfield)|[subField](/.sortfield#excel-javascript/api/excel/-sortfield-subfield-member)|Specifies the subfield that is the target property name of a rich value to sort on.| +|[StyleCollection](/.stylecollection)|[getCount()](/.stylecollection#excel-javascript/api/excel/-stylecollection-getcount-member(1))|Gets the number of styles in the collection.| +||[getItemAt(index: number)](/.stylecollection#excel-javascript/api/excel/-stylecollection-getitemat-member(1))|Gets a style based on its position in the collection.| +|[Table](/.table)|[autoFilter](/.table#excel-javascript/api/excel/-table-autofilter-member)|Represents the `AutoFilter` object of the table.| +|[TableAddedEventArgs](/.tableaddedeventargs)|[source](/.tableaddedeventargs#excel-javascript/api/excel/-tableaddedeventargs-source-member)|Gets the source of the event.| +||[tableId](/.tableaddedeventargs#excel-javascript/api/excel/-tableaddedeventargs-tableid-member)|Gets the ID of the table that is added.| +||[type](/.tableaddedeventargs#excel-javascript/api/excel/-tableaddedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/.tableaddedeventargs#excel-javascript/api/excel/-tableaddedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the table is added.| +|[TableChangedEventArgs](/.tablechangedeventargs)|[details](/.tablechangedeventargs#excel-javascript/api/excel/-tablechangedeventargs-details-member)|Gets the information about the change detail.| +|[TableCollection](/.tablecollection)|[onAdded](/.tablecollection#excel-javascript/api/excel/-tablecollection-onadded-member)|Occurs when a new table is added in a workbook.| +||[onDeleted](/.tablecollection#excel-javascript/api/excel/-tablecollection-ondeleted-member)|Occurs when the specified table is deleted in a workbook.| +|[TableDeletedEventArgs](/.tabledeletedeventargs)|[source](/.tabledeletedeventargs#excel-javascript/api/excel/-tabledeletedeventargs-source-member)|Gets the source of the event.| +||[tableId](/.tabledeletedeventargs#excel-javascript/api/excel/-tabledeletedeventargs-tableid-member)|Gets the ID of the table that is deleted.| +||[tableName](/.tabledeletedeventargs#excel-javascript/api/excel/-tabledeletedeventargs-tablename-member)|Gets the name of the table that is deleted.| +||[type](/.tabledeletedeventargs#excel-javascript/api/excel/-tabledeletedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/.tabledeletedeventargs#excel-javascript/api/excel/-tabledeletedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the table is deleted.| +|[TableScopedCollection](/.tablescopedcollection)|[getCount()](/.tablescopedcollection#excel-javascript/api/excel/-tablescopedcollection-getcount-member(1))|Gets the number of tables in the collection.| +||[getFirst()](/.tablescopedcollection#excel-javascript/api/excel/-tablescopedcollection-getfirst-member(1))|Gets the first table in the collection.| +||[getItem(key: string)](/.tablescopedcollection#excel-javascript/api/excel/-tablescopedcollection-getitem-member(1))|Gets a table by name or ID.| +||[items](/.tablescopedcollection#excel-javascript/api/excel/-tablescopedcollection-items-member)|Gets the loaded child items in this collection.| +|[TextFrame](/.textframe)|[autoSizeSetting](/.textframe#excel-javascript/api/excel/-textframe-autosizesetting-member)|The automatic sizing settings for the text frame.| +||[bottomMargin](/.textframe#excel-javascript/api/excel/-textframe-bottommargin-member)|Represents the bottom margin, in points, of the text frame.| +||[deleteText()](/.textframe#excel-javascript/api/excel/-textframe-deletetext-member(1))|Deletes all the text in the text frame.| +||[hasText](/.textframe#excel-javascript/api/excel/-textframe-hastext-member)|Specifies if the text frame contains text.| +||[horizontalAlignment](/.textframe#excel-javascript/api/excel/-textframe-horizontalalignment-member)|Represents the horizontal alignment of the text frame.| +||[horizontalOverflow](/.textframe#excel-javascript/api/excel/-textframe-horizontaloverflow-member)|Represents the horizontal overflow behavior of the text frame.| +||[leftMargin](/.textframe#excel-javascript/api/excel/-textframe-leftmargin-member)|Represents the left margin, in points, of the text frame.| +||[orientation](/.textframe#excel-javascript/api/excel/-textframe-orientation-member)|Represents the angle to which the text is oriented for the text frame.| +||[readingOrder](/.textframe#excel-javascript/api/excel/-textframe-readingorder-member)|Represents the reading order of the text frame, either left-to-right or right-to-left.| +||[rightMargin](/.textframe#excel-javascript/api/excel/-textframe-rightmargin-member)|Represents the right margin, in points, of the text frame.| +||[textRange](/.textframe#excel-javascript/api/excel/-textframe-textrange-member)|Represents the text that is attached to a shape in the text frame, and properties and methods for manipulating the text.| +||[topMargin](/.textframe#excel-javascript/api/excel/-textframe-topmargin-member)|Represents the top margin, in points, of the text frame.| +||[verticalAlignment](/.textframe#excel-javascript/api/excel/-textframe-verticalalignment-member)|Represents the vertical alignment of the text frame.| +||[verticalOverflow](/.textframe#excel-javascript/api/excel/-textframe-verticaloverflow-member)|Represents the vertical overflow behavior of the text frame.| +|[TextRange](/.textrange)|[font](/.textrange#excel-javascript/api/excel/-textrange-font-member)|Returns a `ShapeFont` object that represents the font attributes for the text range.| +||[getSubstring(start: number, length?: number)](/.textrange#excel-javascript/api/excel/-textrange-getsubstring-member(1))|Returns a TextRange object for the substring in the given range.| +||[text](/.textrange#excel-javascript/api/excel/-textrange-text-member)|Represents the plain text content of the text range.| +|[Workbook](/.workbook)|[autoSave](/.workbook#excel-javascript/api/excel/-workbook-autosave-member)|Specifies if the workbook is in AutoSave mode.| +||[calculationEngineVersion](/.workbook#excel-javascript/api/excel/-workbook-calculationengineversion-member)|Returns a number about the version of Excel Calculation Engine.| +||[chartDataPointTrack](/.workbook#excel-javascript/api/excel/-workbook-chartdatapointtrack-member)|True if all charts in the workbook are tracking the actual data points to which they are attached.| +||[getActiveChart()](/.workbook#excel-javascript/api/excel/-workbook-getactivechart-member(1))|Gets the currently active chart in the workbook.| +||[getActiveChartOrNullObject()](/.workbook#excel-javascript/api/excel/-workbook-getactivechartornullobject-member(1))|Gets the currently active chart in the workbook.| +||[getIsActiveCollabSession()](/.workbook#excel-javascript/api/excel/-workbook-getisactivecollabsession-member(1))|Returns `true` if the workbook is being edited by multiple users (through co-authoring).| +||[getSelectedRanges()](/.workbook#excel-javascript/api/excel/-workbook-getselectedranges-member(1))|Gets the currently selected one or more ranges from the workbook.| +||[isDirty](/.workbook#excel-javascript/api/excel/-workbook-isdirty-member)|Specifies if changes have been made since the workbook was last saved.| +||[onAutoSaveSettingChanged](/.workbook#excel-javascript/api/excel/-workbook-onautosavesettingchanged-member)|Occurs when the AutoSave setting is changed on the workbook.| +||[previouslySaved](/.workbook#excel-javascript/api/excel/-workbook-previouslysaved-member)|Specifies if the workbook has ever been saved locally or online.| +||[usePrecisionAsDisplayed](/.workbook#excel-javascript/api/excel/-workbook-useprecisionasdisplayed-member)|True if calculations in this workbook will be done using only the precision of the numbers as they're displayed.| +|[WorkbookAutoSaveSettingChangedEventArgs](/.workbookautosavesettingchangedeventargs)|[type](/.workbookautosavesettingchangedeventargs#excel-javascript/api/excel/-workbookautosavesettingchangedeventargs-type-member)|Gets the type of the event.| +|[Worksheet](/.worksheet)|[autoFilter](/.worksheet#excel-javascript/api/excel/-worksheet-autofilter-member)|Represents the `AutoFilter` object of the worksheet.| +||[enableCalculation](/.worksheet#excel-javascript/api/excel/-worksheet-enablecalculation-member)|Determines if Excel should recalculate the worksheet when necessary.| +||[findAll(text: string, criteria: Excel.WorksheetSearchCriteria)](/.worksheet#excel-javascript/api/excel/-worksheet-findall-member(1))|Finds all occurrences of the given string based on the criteria specified and returns them as a `RangeAreas` object, comprising one or more rectangular ranges.| +||[findAllOrNullObject(text: string, criteria: Excel.WorksheetSearchCriteria)](/.worksheet#excel-javascript/api/excel/-worksheet-findallornullobject-member(1))|Finds all occurrences of the given string based on the criteria specified and returns them as a `RangeAreas` object, comprising one or more rectangular ranges.| +||[getRanges(address?: string)](/.worksheet#excel-javascript/api/excel/-worksheet-getranges-member(1))|Gets the `RangeAreas` object, representing one or more blocks of rectangular ranges, specified by the address or name.| +||[horizontalPageBreaks](/.worksheet#excel-javascript/api/excel/-worksheet-horizontalpagebreaks-member)|Gets the horizontal page break collection for the worksheet.| +||[onFormatChanged](/.worksheet#excel-javascript/api/excel/-worksheet-onformatchanged-member)|Occurs when format changed on a specific worksheet.| +||[pageLayout](/.worksheet#excel-javascript/api/excel/-worksheet-pagelayout-member)|Gets the `PageLayout` object of the worksheet.| +||[replaceAll(text: string, replacement: string, criteria: Excel.ReplaceCriteria)](/.worksheet#excel-javascript/api/excel/-worksheet-replaceall-member(1))|Finds and replaces the given string based on the criteria specified within the current worksheet.| +||[shapes](/.worksheet#excel-javascript/api/excel/-worksheet-shapes-member)|Returns the collection of all the Shape objects on the worksheet.| +||[verticalPageBreaks](/.worksheet#excel-javascript/api/excel/-worksheet-verticalpagebreaks-member)|Gets the vertical page break collection for the worksheet.| +|[WorksheetChangedEventArgs](/.worksheetchangedeventargs)|[details](/.worksheetchangedeventargs#excel-javascript/api/excel/-worksheetchangedeventargs-details-member)|Represents the information about the change detail.| +|[WorksheetCollection](/.worksheetcollection)|[onChanged](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-onchanged-member)|Occurs when any worksheet in the workbook is changed.| +||[onFormatChanged](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-onformatchanged-member)|Occurs when any worksheet in the workbook has a format changed.| +||[onSelectionChanged](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-onselectionchanged-member)|Occurs when the selection changes on any worksheet.| +|[WorksheetFormatChangedEventArgs](/.worksheetformatchangedeventargs)|[address](/.worksheetformatchangedeventargs#excel-javascript/api/excel/-worksheetformatchangedeventargs-address-member)|Gets the range address that represents the changed area of a specific worksheet.| +||[getRange(ctx: Excel.RequestContext)](/.worksheetformatchangedeventargs#excel-javascript/api/excel/-worksheetformatchangedeventargs-getrange-member(1))|Gets the range that represents the changed area of a specific worksheet.| +||[getRangeOrNullObject(ctx: Excel.RequestContext)](/.worksheetformatchangedeventargs#excel-javascript/api/excel/-worksheetformatchangedeventargs-getrangeornullobject-member(1))|Gets the range that represents the changed area of a specific worksheet.| +||[source](/.worksheetformatchangedeventargs#excel-javascript/api/excel/-worksheetformatchangedeventargs-source-member)|Gets the source of the event.| +||[type](/.worksheetformatchangedeventargs#excel-javascript/api/excel/-worksheetformatchangedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/.worksheetformatchangedeventargs#excel-javascript/api/excel/-worksheetformatchangedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the data changed.| +|[WorksheetSearchCriteria](/.worksheetsearchcriteria)|[completeMatch](/.worksheetsearchcriteria#excel-javascript/api/excel/-worksheetsearchcriteria-completematch-member)|Specifies if the match needs to be complete or partial.| +||[matchCase](/.worksheetsearchcriteria#excel-javascript/api/excel/-worksheetsearchcriteria-matchcase-member)|Specifies if the match is case-sensitive.| diff --git a/docs/includes/excel-online.md b/docs/includes/excel-online.md index cbb699217f..07f37712b2 100644 --- a/docs/includes/excel-online.md +++ b/docs/includes/excel-online.md @@ -1,54 +1,54 @@ | Class | Fields | Description | |:---|:---|:---| -|[AllowEditRange](/javascript/api/excel/excel.alloweditrange)|[address](/javascript/api/excel/excel.alloweditrange#excel-excel-alloweditrange-address-member)|Specifies the range associated with the object.| -||[delete()](/javascript/api/excel/excel.alloweditrange#excel-excel-alloweditrange-delete-member(1))|Deletes the object from the `AllowEditRangeCollection`.| -||[isPasswordProtected](/javascript/api/excel/excel.alloweditrange#excel-excel-alloweditrange-ispasswordprotected-member)|Specifies if the object is password protected.| -||[pauseProtection(password?: string)](/javascript/api/excel/excel.alloweditrange#excel-excel-alloweditrange-pauseprotection-member(1))|Pauses worksheet protection for the object for the user in the current session.| -||[setPassword(password?: string)](/javascript/api/excel/excel.alloweditrange#excel-excel-alloweditrange-setpassword-member(1))|Changes the password associated with the object.| -||[title](/javascript/api/excel/excel.alloweditrange#excel-excel-alloweditrange-title-member)|Specifies the title of the object.| -|[AllowEditRangeCollection](/javascript/api/excel/excel.alloweditrangecollection)|[add(title: string, rangeAddress: string, options?: Excel.AllowEditRangeOptions)](/javascript/api/excel/excel.alloweditrangecollection#excel-excel-alloweditrangecollection-add-member(1))|Adds an `AllowEditRange` object to the worksheet.| -||[getCount()](/javascript/api/excel/excel.alloweditrangecollection#excel-excel-alloweditrangecollection-getcount-member(1))|Returns the number of `AllowEditRange` objects in the collection.| -||[getItem(key: string)](/javascript/api/excel/excel.alloweditrangecollection#excel-excel-alloweditrangecollection-getitem-member(1))|Gets the `AllowEditRange` object by its title.| -||[getItemAt(index: number)](/javascript/api/excel/excel.alloweditrangecollection#excel-excel-alloweditrangecollection-getitemat-member(1))|Returns an `AllowEditRange` object by its index in the collection.| -||[getItemOrNullObject(key: string)](/javascript/api/excel/excel.alloweditrangecollection#excel-excel-alloweditrangecollection-getitemornullobject-member(1))|Gets the `AllowEditRange` object by its title.| -||[items](/javascript/api/excel/excel.alloweditrangecollection#excel-excel-alloweditrangecollection-items-member)|Gets the loaded child items in this collection.| -||[pauseProtection(password: string)](/javascript/api/excel/excel.alloweditrangecollection#excel-excel-alloweditrangecollection-pauseprotection-member(1))|Pauses worksheet protection for all `AllowEditRange` objects found in this worksheet that have the given password for the user in the current session.| -|[AllowEditRangeOptions](/javascript/api/excel/excel.alloweditrangeoptions)|[password](/javascript/api/excel/excel.alloweditrangeoptions#excel-excel-alloweditrangeoptions-password-member)|The password associated with the `AllowEditRange`.| -|[LinkedWorkbook](/javascript/api/excel/excel.linkedworkbook)|[breakLinks()](/javascript/api/excel/excel.linkedworkbook#excel-excel-linkedworkbook-breaklinks-member(1))|Makes a request to break the links pointing to the linked workbook.| -||[id](/javascript/api/excel/excel.linkedworkbook#excel-excel-linkedworkbook-id-member)|The original URL pointing to the linked workbook.| -||[refresh()](/javascript/api/excel/excel.linkedworkbook#excel-excel-linkedworkbook-refresh-member(1))|Makes a request to refresh the data retrieved from the linked workbook.| -|[LinkedWorkbookCollection](/javascript/api/excel/excel.linkedworkbookcollection)|[breakAllLinks()](/javascript/api/excel/excel.linkedworkbookcollection#excel-excel-linkedworkbookcollection-breakalllinks-member(1))|Breaks all the links to the linked workbooks.| -||[getItem(key: string)](/javascript/api/excel/excel.linkedworkbookcollection#excel-excel-linkedworkbookcollection-getitem-member(1))|Gets information about a linked workbook by its URL.| -||[getItemOrNullObject(key: string)](/javascript/api/excel/excel.linkedworkbookcollection#excel-excel-linkedworkbookcollection-getitemornullobject-member(1))|Gets information about a linked workbook by its URL.| -||[items](/javascript/api/excel/excel.linkedworkbookcollection#excel-excel-linkedworkbookcollection-items-member)|Gets the loaded child items in this collection.| -||[refreshAll()](/javascript/api/excel/excel.linkedworkbookcollection#excel-excel-linkedworkbookcollection-refreshall-member(1))|Makes a request to refresh all the workbook links.| -||[workbookLinksRefreshMode](/javascript/api/excel/excel.linkedworkbookcollection#excel-excel-linkedworkbookcollection-workbooklinksrefreshmode-member)|Represents the update mode of the workbook links.| -|[NamedSheetView](/javascript/api/excel/excel.namedsheetview)|[activate()](/javascript/api/excel/excel.namedsheetview#excel-excel-namedsheetview-activate-member(1))|Activates this sheet view.| -||[delete()](/javascript/api/excel/excel.namedsheetview#excel-excel-namedsheetview-delete-member(1))|Removes the sheet view from the worksheet.| -||[duplicate(name?: string)](/javascript/api/excel/excel.namedsheetview#excel-excel-namedsheetview-duplicate-member(1))|Creates a copy of this sheet view.| -||[name](/javascript/api/excel/excel.namedsheetview#excel-excel-namedsheetview-name-member)|Gets or sets the name of the sheet view.| -|[NamedSheetViewCollection](/javascript/api/excel/excel.namedsheetviewcollection)|[add(name: string)](/javascript/api/excel/excel.namedsheetviewcollection#excel-excel-namedsheetviewcollection-add-member(1))|Creates a new sheet view with the given name.| -||[enterTemporary()](/javascript/api/excel/excel.namedsheetviewcollection#excel-excel-namedsheetviewcollection-entertemporary-member(1))|Creates and activates a new temporary sheet view.| -||[exit()](/javascript/api/excel/excel.namedsheetviewcollection#excel-excel-namedsheetviewcollection-exit-member(1))|Exits the currently active sheet view.| -||[getActive()](/javascript/api/excel/excel.namedsheetviewcollection#excel-excel-namedsheetviewcollection-getactive-member(1))|Gets the worksheet's currently active sheet view.| -||[getCount()](/javascript/api/excel/excel.namedsheetviewcollection#excel-excel-namedsheetviewcollection-getcount-member(1))|Gets the number of sheet views in this worksheet.| -||[getItem(key: string)](/javascript/api/excel/excel.namedsheetviewcollection#excel-excel-namedsheetviewcollection-getitem-member(1))|Gets a sheet view using its name.| -||[getItemAt(index: number)](/javascript/api/excel/excel.namedsheetviewcollection#excel-excel-namedsheetviewcollection-getitemat-member(1))|Gets a sheet view by its index in the collection.| -||[items](/javascript/api/excel/excel.namedsheetviewcollection#excel-excel-namedsheetviewcollection-items-member)|Gets the loaded child items in this collection.| -|[TableRowCollection](/javascript/api/excel/excel.tablerowcollection)|[deleteRows(rows: number[] \| TableRow[])](/javascript/api/excel/excel.tablerowcollection#excel-excel-tablerowcollection-deleterows-member(1))|Delete multiple rows from a table.| -||[deleteRowsAt(index: number, count?: number)](/javascript/api/excel/excel.tablerowcollection#excel-excel-tablerowcollection-deleterowsat-member(1))|Delete a specified number of rows from a table, starting at a given index.| -|[Workbook](/javascript/api/excel/excel.workbook)|[linkedWorkbooks](/javascript/api/excel/excel.workbook#excel-excel-workbook-linkedworkbooks-member)|Returns a collection of linked workbooks.| -|[Worksheet](/javascript/api/excel/excel.worksheet)|[namedSheetViews](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-namedsheetviews-member)|Returns a collection of sheet views that are present in the worksheet.| -|[WorksheetProtection](/javascript/api/excel/excel.worksheetprotection)|[allowEditRanges](/javascript/api/excel/excel.worksheetprotection#excel-excel-worksheetprotection-alloweditranges-member)|Specifies the `AllowEditRangeCollection` object found in this worksheet.| -||[canPauseProtection](/javascript/api/excel/excel.worksheetprotection#excel-excel-worksheetprotection-canpauseprotection-member)|Specifies if protection can be paused for this worksheet.| -||[checkPassword(password?: string)](/javascript/api/excel/excel.worksheetprotection#excel-excel-worksheetprotection-checkpassword-member(1))|Specifies if the password can be used to unlock worksheet protection.| -||[isPasswordProtected](/javascript/api/excel/excel.worksheetprotection#excel-excel-worksheetprotection-ispasswordprotected-member)|Specifies if the sheet is password protected.| -||[isPaused](/javascript/api/excel/excel.worksheetprotection#excel-excel-worksheetprotection-ispaused-member)|Specifies if worksheet protection is paused.| -||[pauseProtection(password?: string)](/javascript/api/excel/excel.worksheetprotection#excel-excel-worksheetprotection-pauseprotection-member(1))|Pauses worksheet protection for the given worksheet object for the user in the current session.| -||[resumeProtection()](/javascript/api/excel/excel.worksheetprotection#excel-excel-worksheetprotection-resumeprotection-member(1))|Resumes worksheet protection for the given worksheet object for the user in a given session.| -||[savedOptions](/javascript/api/excel/excel.worksheetprotection#excel-excel-worksheetprotection-savedoptions-member)|Specifies the protection options saved in the worksheet.| -||[setPassword(password?: string)](/javascript/api/excel/excel.worksheetprotection#excel-excel-worksheetprotection-setpassword-member(1))|Changes the password associated with the `WorksheetProtection` object.| -||[updateOptions(options: Excel.WorksheetProtectionOptions)](/javascript/api/excel/excel.worksheetprotection#excel-excel-worksheetprotection-updateoptions-member(1))|Change the worksheet protection options associated with the `WorksheetProtection` object.| -|[WorksheetProtectionChangedEventArgs](/javascript/api/excel/excel.worksheetprotectionchangedeventargs)|[allowEditRangesChanged](/javascript/api/excel/excel.worksheetprotectionchangedeventargs#excel-excel-worksheetprotectionchangedeventargs-alloweditrangeschanged-member)|Specifies if any of the `AllowEditRange` objects have changed.| -||[protectionOptionsChanged](/javascript/api/excel/excel.worksheetprotectionchangedeventargs#excel-excel-worksheetprotectionchangedeventargs-protectionoptionschanged-member)|Specifies if the `WorksheetProtectionOptions` have changed.| -||[sheetPasswordChanged](/javascript/api/excel/excel.worksheetprotectionchangedeventargs#excel-excel-worksheetprotectionchangedeventargs-sheetpasswordchanged-member)|Specifies if the worksheet password has changed.| +|[AllowEditRange](/.alloweditrange)|[address](/.alloweditrange#excel-javascript/api/excel/-alloweditrange-address-member)|Specifies the range associated with the object.| +||[delete()](/.alloweditrange#excel-javascript/api/excel/-alloweditrange-delete-member(1))|Deletes the object from the `AllowEditRangeCollection`.| +||[isPasswordProtected](/.alloweditrange#excel-javascript/api/excel/-alloweditrange-ispasswordprotected-member)|Specifies if the object is password protected.| +||[pauseProtection(password?: string)](/.alloweditrange#excel-javascript/api/excel/-alloweditrange-pauseprotection-member(1))|Pauses worksheet protection for the object for the user in the current session.| +||[setPassword(password?: string)](/.alloweditrange#excel-javascript/api/excel/-alloweditrange-setpassword-member(1))|Changes the password associated with the object.| +||[title](/.alloweditrange#excel-javascript/api/excel/-alloweditrange-title-member)|Specifies the title of the object.| +|[AllowEditRangeCollection](/.alloweditrangecollection)|[add(title: string, rangeAddress: string, options?: Excel.AllowEditRangeOptions)](/.alloweditrangecollection#excel-javascript/api/excel/-alloweditrangecollection-add-member(1))|Adds an `AllowEditRange` object to the worksheet.| +||[getCount()](/.alloweditrangecollection#excel-javascript/api/excel/-alloweditrangecollection-getcount-member(1))|Returns the number of `AllowEditRange` objects in the collection.| +||[getItem(key: string)](/.alloweditrangecollection#excel-javascript/api/excel/-alloweditrangecollection-getitem-member(1))|Gets the `AllowEditRange` object by its title.| +||[getItemAt(index: number)](/.alloweditrangecollection#excel-javascript/api/excel/-alloweditrangecollection-getitemat-member(1))|Returns an `AllowEditRange` object by its index in the collection.| +||[getItemOrNullObject(key: string)](/.alloweditrangecollection#excel-javascript/api/excel/-alloweditrangecollection-getitemornullobject-member(1))|Gets the `AllowEditRange` object by its title.| +||[items](/.alloweditrangecollection#excel-javascript/api/excel/-alloweditrangecollection-items-member)|Gets the loaded child items in this collection.| +||[pauseProtection(password: string)](/.alloweditrangecollection#excel-javascript/api/excel/-alloweditrangecollection-pauseprotection-member(1))|Pauses worksheet protection for all `AllowEditRange` objects found in this worksheet that have the given password for the user in the current session.| +|[AllowEditRangeOptions](/.alloweditrangeoptions)|[password](/.alloweditrangeoptions#excel-javascript/api/excel/-alloweditrangeoptions-password-member)|The password associated with the `AllowEditRange`.| +|[LinkedWorkbook](/.linkedworkbook)|[breakLinks()](/.linkedworkbook#excel-javascript/api/excel/-linkedworkbook-breaklinks-member(1))|Makes a request to break the links pointing to the linked workbook.| +||[id](/.linkedworkbook#excel-javascript/api/excel/-linkedworkbook-id-member)|The original URL pointing to the linked workbook.| +||[refresh()](/.linkedworkbook#excel-javascript/api/excel/-linkedworkbook-refresh-member(1))|Makes a request to refresh the data retrieved from the linked workbook.| +|[LinkedWorkbookCollection](/.linkedworkbookcollection)|[breakAllLinks()](/.linkedworkbookcollection#excel-javascript/api/excel/-linkedworkbookcollection-breakalllinks-member(1))|Breaks all the links to the linked workbooks.| +||[getItem(key: string)](/.linkedworkbookcollection#excel-javascript/api/excel/-linkedworkbookcollection-getitem-member(1))|Gets information about a linked workbook by its URL.| +||[getItemOrNullObject(key: string)](/.linkedworkbookcollection#excel-javascript/api/excel/-linkedworkbookcollection-getitemornullobject-member(1))|Gets information about a linked workbook by its URL.| +||[items](/.linkedworkbookcollection#excel-javascript/api/excel/-linkedworkbookcollection-items-member)|Gets the loaded child items in this collection.| +||[refreshAll()](/.linkedworkbookcollection#excel-javascript/api/excel/-linkedworkbookcollection-refreshall-member(1))|Makes a request to refresh all the workbook links.| +||[workbookLinksRefreshMode](/.linkedworkbookcollection#excel-javascript/api/excel/-linkedworkbookcollection-workbooklinksrefreshmode-member)|Represents the update mode of the workbook links.| +|[NamedSheetView](/.namedsheetview)|[activate()](/.namedsheetview#excel-javascript/api/excel/-namedsheetview-activate-member(1))|Activates this sheet view.| +||[delete()](/.namedsheetview#excel-javascript/api/excel/-namedsheetview-delete-member(1))|Removes the sheet view from the worksheet.| +||[duplicate(name?: string)](/.namedsheetview#excel-javascript/api/excel/-namedsheetview-duplicate-member(1))|Creates a copy of this sheet view.| +||[name](/.namedsheetview#excel-javascript/api/excel/-namedsheetview-name-member)|Gets or sets the name of the sheet view.| +|[NamedSheetViewCollection](/.namedsheetviewcollection)|[add(name: string)](/.namedsheetviewcollection#excel-javascript/api/excel/-namedsheetviewcollection-add-member(1))|Creates a new sheet view with the given name.| +||[enterTemporary()](/.namedsheetviewcollection#excel-javascript/api/excel/-namedsheetviewcollection-entertemporary-member(1))|Creates and activates a new temporary sheet view.| +||[exit()](/.namedsheetviewcollection#excel-javascript/api/excel/-namedsheetviewcollection-exit-member(1))|Exits the currently active sheet view.| +||[getActive()](/.namedsheetviewcollection#excel-javascript/api/excel/-namedsheetviewcollection-getactive-member(1))|Gets the worksheet's currently active sheet view.| +||[getCount()](/.namedsheetviewcollection#excel-javascript/api/excel/-namedsheetviewcollection-getcount-member(1))|Gets the number of sheet views in this worksheet.| +||[getItem(key: string)](/.namedsheetviewcollection#excel-javascript/api/excel/-namedsheetviewcollection-getitem-member(1))|Gets a sheet view using its name.| +||[getItemAt(index: number)](/.namedsheetviewcollection#excel-javascript/api/excel/-namedsheetviewcollection-getitemat-member(1))|Gets a sheet view by its index in the collection.| +||[items](/.namedsheetviewcollection#excel-javascript/api/excel/-namedsheetviewcollection-items-member)|Gets the loaded child items in this collection.| +|[TableRowCollection](/.tablerowcollection)|[deleteRows(rows: number[] \| TableRow[])](/.tablerowcollection#excel-javascript/api/excel/-tablerowcollection-deleterows-member(1))|Delete multiple rows from a table.| +||[deleteRowsAt(index: number, count?: number)](/.tablerowcollection#excel-javascript/api/excel/-tablerowcollection-deleterowsat-member(1))|Delete a specified number of rows from a table, starting at a given index.| +|[Workbook](/.workbook)|[linkedWorkbooks](/.workbook#excel-javascript/api/excel/-workbook-linkedworkbooks-member)|Returns a collection of linked workbooks.| +|[Worksheet](/.worksheet)|[namedSheetViews](/.worksheet#excel-javascript/api/excel/-worksheet-namedsheetviews-member)|Returns a collection of sheet views that are present in the worksheet.| +|[WorksheetProtection](/.worksheetprotection)|[allowEditRanges](/.worksheetprotection#excel-javascript/api/excel/-worksheetprotection-alloweditranges-member)|Specifies the `AllowEditRangeCollection` object found in this worksheet.| +||[canPauseProtection](/.worksheetprotection#excel-javascript/api/excel/-worksheetprotection-canpauseprotection-member)|Specifies if protection can be paused for this worksheet.| +||[checkPassword(password?: string)](/.worksheetprotection#excel-javascript/api/excel/-worksheetprotection-checkpassword-member(1))|Specifies if the password can be used to unlock worksheet protection.| +||[isPasswordProtected](/.worksheetprotection#excel-javascript/api/excel/-worksheetprotection-ispasswordprotected-member)|Specifies if the sheet is password protected.| +||[isPaused](/.worksheetprotection#excel-javascript/api/excel/-worksheetprotection-ispaused-member)|Specifies if worksheet protection is paused.| +||[pauseProtection(password?: string)](/.worksheetprotection#excel-javascript/api/excel/-worksheetprotection-pauseprotection-member(1))|Pauses worksheet protection for the given worksheet object for the user in the current session.| +||[resumeProtection()](/.worksheetprotection#excel-javascript/api/excel/-worksheetprotection-resumeprotection-member(1))|Resumes worksheet protection for the given worksheet object for the user in a given session.| +||[savedOptions](/.worksheetprotection#excel-javascript/api/excel/-worksheetprotection-savedoptions-member)|Specifies the protection options saved in the worksheet.| +||[setPassword(password?: string)](/.worksheetprotection#excel-javascript/api/excel/-worksheetprotection-setpassword-member(1))|Changes the password associated with the `WorksheetProtection` object.| +||[updateOptions(options: Excel.WorksheetProtectionOptions)](/.worksheetprotection#excel-javascript/api/excel/-worksheetprotection-updateoptions-member(1))|Change the worksheet protection options associated with the `WorksheetProtection` object.| +|[WorksheetProtectionChangedEventArgs](/.worksheetprotectionchangedeventargs)|[allowEditRangesChanged](/.worksheetprotectionchangedeventargs#excel-javascript/api/excel/-worksheetprotectionchangedeventargs-alloweditrangeschanged-member)|Specifies if any of the `AllowEditRange` objects have changed.| +||[protectionOptionsChanged](/.worksheetprotectionchangedeventargs#excel-javascript/api/excel/-worksheetprotectionchangedeventargs-protectionoptionschanged-member)|Specifies if the `WorksheetProtectionOptions` have changed.| +||[sheetPasswordChanged](/.worksheetprotectionchangedeventargs#excel-javascript/api/excel/-worksheetprotectionchangedeventargs-sheetpasswordchanged-member)|Specifies if the worksheet password has changed.| diff --git a/docs/includes/excel-preview.md b/docs/includes/excel-preview.md index 91a9538bee..dd946a4aa3 100644 --- a/docs/includes/excel-preview.md +++ b/docs/includes/excel-preview.md @@ -1,165 +1,165 @@ | Class | Fields | Description | |:---|:---|:---| -|[Application](/javascript/api/excel/excel.application)|[formatStaleValues](/javascript/api/excel/excel.application#excel-excel-application-formatstalevalues-member)|Specifies whether the Format Stale Values option within Calculation Options is enabled or disabled.| -|[Base64EncodedImage](/javascript/api/excel/excel.base64encodedimage)|[data](/javascript/api/excel/excel.base64encodedimage#excel-excel-base64encodedimage-data-member)|The Base64-encoded string.| -||[type](/javascript/api/excel/excel.base64encodedimage#excel-excel-base64encodedimage-type-member)|The file type of the Base64-encoded image.| -|[BlockedErrorCellValue](/javascript/api/excel/excel.blockederrorcellvalue)|[errorSubType](/javascript/api/excel/excel.blockederrorcellvalue#excel-excel-blockederrorcellvalue-errorsubtype-member)|Represents the type of `BlockedErrorCellValue`.| -|[BooleanCellValue](/javascript/api/excel/excel.booleancellvalue)|[type](/javascript/api/excel/excel.booleancellvalue#excel-excel-booleancellvalue-type-member)|Represents the type of this cell value.| -|[BusyErrorCellValue](/javascript/api/excel/excel.busyerrorcellvalue)|[errorSubType](/javascript/api/excel/excel.busyerrorcellvalue#excel-excel-busyerrorcellvalue-errorsubtype-member)|Represents the type of `BusyErrorCellValue`.| -|[CalcErrorCellValue](/javascript/api/excel/excel.calcerrorcellvalue)|[errorSubType](/javascript/api/excel/excel.calcerrorcellvalue#excel-excel-calcerrorcellvalue-errorsubtype-member)|Represents the type of `CalcErrorCellValue`.| -|[Chart](/javascript/api/excel/excel.chart)|[getDataRange()](/javascript/api/excel/excel.chart#excel-excel-chart-getdatarange-member(1))|Gets the data source of the whole chart.| -||[getDataRangeOrNullObject()](/javascript/api/excel/excel.chart#excel-excel-chart-getdatarangeornullobject-member(1))|Gets the data source of the whole chart.| -|[Comment](/javascript/api/excel/excel.comment)|[assignTask(assignee: Excel.EmailIdentity)](/javascript/api/excel/excel.comment#excel-excel-comment-assigntask-member(1))|Assigns the task attached to the comment to the given user as an assignee.| -||[getTask()](/javascript/api/excel/excel.comment#excel-excel-comment-gettask-member(1))|Gets the task associated with this comment.| -||[getTaskOrNullObject()](/javascript/api/excel/excel.comment#excel-excel-comment-gettaskornullobject-member(1))|Gets the task associated with this comment.| -|[CommentReply](/javascript/api/excel/excel.commentreply)|[assignTask(assignee: Excel.EmailIdentity)](/javascript/api/excel/excel.commentreply#excel-excel-commentreply-assigntask-member(1))|Assigns the task attached to the comment to the given user as the sole assignee.| -||[getTask()](/javascript/api/excel/excel.commentreply#excel-excel-commentreply-gettask-member(1))|Gets the task associated with this comment reply's thread.| -||[getTaskOrNullObject()](/javascript/api/excel/excel.commentreply#excel-excel-commentreply-gettaskornullobject-member(1))|Gets the task associated with this comment reply's thread.| -|[ConnectErrorCellValue](/javascript/api/excel/excel.connecterrorcellvalue)|[errorSubType](/javascript/api/excel/excel.connecterrorcellvalue#excel-excel-connecterrorcellvalue-errorsubtype-member)|Represents the type of `ConnectErrorCellValue`.| -|[DatetimeFormatInfo](/javascript/api/excel/excel.datetimeformatinfo)|[shortDateTimePattern](/javascript/api/excel/excel.datetimeformatinfo#excel-excel-datetimeformatinfo-shortdatetimepattern-member)|Gets the format string for a short date and time value.| -|[DocumentTask](/javascript/api/excel/excel.documenttask)|[assign(assignee: Excel.EmailIdentity)](/javascript/api/excel/excel.documenttask#excel-excel-documenttask-assign-member(1))|Adds the given user to the list of assignees attached to the task.| -||[assignees](/javascript/api/excel/excel.documenttask#excel-excel-documenttask-assignees-member)|Returns a collection of assignees of the task.| -||[changes](/javascript/api/excel/excel.documenttask#excel-excel-documenttask-changes-member)|Gets the change records of the task.| -||[comment](/javascript/api/excel/excel.documenttask#excel-excel-documenttask-comment-member)|Gets the comment associated with the task.| -||[completedBy](/javascript/api/excel/excel.documenttask#excel-excel-documenttask-completedby-member)|Gets the most recent user to have completed the task.| -||[completedDateTime](/javascript/api/excel/excel.documenttask#excel-excel-documenttask-completeddatetime-member)|Gets the date and time that the task was completed.| -||[createdBy](/javascript/api/excel/excel.documenttask#excel-excel-documenttask-createdby-member)|Gets the user who created the task.| -||[createdDateTime](/javascript/api/excel/excel.documenttask#excel-excel-documenttask-createddatetime-member)|Gets the date and time that the task was created.| -||[id](/javascript/api/excel/excel.documenttask#excel-excel-documenttask-id-member)|Gets the ID of the task.| -||[percentComplete](/javascript/api/excel/excel.documenttask#excel-excel-documenttask-percentcomplete-member)|Specifies the completion percentage of the task.| -||[priority](/javascript/api/excel/excel.documenttask#excel-excel-documenttask-priority-member)|Specifies the priority of the task.| -||[startAndDueDateTime](/javascript/api/excel/excel.documenttask#excel-excel-documenttask-startandduedatetime-member)|Gets or sets the date and time the task should start and is due.| -||[title](/javascript/api/excel/excel.documenttask#excel-excel-documenttask-title-member)|Specifies title of the task.| -||[unassign(assignee: Excel.EmailIdentity)](/javascript/api/excel/excel.documenttask#excel-excel-documenttask-unassign-member(1))|Removes the given user from the list of assignees attached to the task.| -||[unassignAll()](/javascript/api/excel/excel.documenttask#excel-excel-documenttask-unassignall-member(1))|Removes all users from the list of assignees attached to the task.| -|[DocumentTaskChange](/javascript/api/excel/excel.documenttaskchange)|[assignee](/javascript/api/excel/excel.documenttaskchange#excel-excel-documenttaskchange-assignee-member)|Represents the user assigned to the task for an `assign` change action, or the user unassigned from the task for an `unassign` change action.| -||[changedBy](/javascript/api/excel/excel.documenttaskchange#excel-excel-documenttaskchange-changedby-member)|Represents the identity of the user who made the task change.| -||[commentId](/javascript/api/excel/excel.documenttaskchange#excel-excel-documenttaskchange-commentid-member)|Represents the ID of the comment or comment reply to which the task change is anchored.| -||[createdDateTime](/javascript/api/excel/excel.documenttaskchange#excel-excel-documenttaskchange-createddatetime-member)|Represents the creation date and time of the task change record.| -||[dueDateTime](/javascript/api/excel/excel.documenttaskchange#excel-excel-documenttaskchange-duedatetime-member)|Represents the task's due date and time.| -||[id](/javascript/api/excel/excel.documenttaskchange#excel-excel-documenttaskchange-id-member)|The unique GUID of the task change.| -||[percentComplete](/javascript/api/excel/excel.documenttaskchange#excel-excel-documenttaskchange-percentcomplete-member)|Represents the task's completion percentage.| -||[priority](/javascript/api/excel/excel.documenttaskchange#excel-excel-documenttaskchange-priority-member)|Represents the task's priority.| -||[startDateTime](/javascript/api/excel/excel.documenttaskchange#excel-excel-documenttaskchange-startdatetime-member)|Represents the task's start date and time.| -||[title](/javascript/api/excel/excel.documenttaskchange#excel-excel-documenttaskchange-title-member)|Represents the task's title.| -||[type](/javascript/api/excel/excel.documenttaskchange#excel-excel-documenttaskchange-type-member)|Represents the action type of the task change record.| -||[undoChangeId](/javascript/api/excel/excel.documenttaskchange#excel-excel-documenttaskchange-undochangeid-member)|Represents the `DocumentTaskChange.id` property that was undone for the `undo` change action.| -|[DocumentTaskChangeCollection](/javascript/api/excel/excel.documenttaskchangecollection)|[getCount()](/javascript/api/excel/excel.documenttaskchangecollection#excel-excel-documenttaskchangecollection-getcount-member(1))|Gets the number of change records in the collection for the task.| -||[getItemAt(index: number)](/javascript/api/excel/excel.documenttaskchangecollection#excel-excel-documenttaskchangecollection-getitemat-member(1))|Gets a task change record by using its index in the collection.| -||[items](/javascript/api/excel/excel.documenttaskchangecollection#excel-excel-documenttaskchangecollection-items-member)|Gets the loaded child items in this collection.| -|[DocumentTaskCollection](/javascript/api/excel/excel.documenttaskcollection)|[getCount()](/javascript/api/excel/excel.documenttaskcollection#excel-excel-documenttaskcollection-getcount-member(1))|Gets the number of tasks in the collection.| -||[getItem(key: string)](/javascript/api/excel/excel.documenttaskcollection#excel-excel-documenttaskcollection-getitem-member(1))|Gets a task using its ID.| -||[getItemAt(index: number)](/javascript/api/excel/excel.documenttaskcollection#excel-excel-documenttaskcollection-getitemat-member(1))|Gets a task by its index in the collection.| -||[getItemOrNullObject(key: string)](/javascript/api/excel/excel.documenttaskcollection#excel-excel-documenttaskcollection-getitemornullobject-member(1))|Gets a task using its ID.| -||[items](/javascript/api/excel/excel.documenttaskcollection#excel-excel-documenttaskcollection-items-member)|Gets the loaded child items in this collection.| -|[DocumentTaskSchedule](/javascript/api/excel/excel.documenttaskschedule)|[dueDateTime](/javascript/api/excel/excel.documenttaskschedule#excel-excel-documenttaskschedule-duedatetime-member)|Gets the date and time that the task is due.| -||[startDateTime](/javascript/api/excel/excel.documenttaskschedule#excel-excel-documenttaskschedule-startdatetime-member)|Gets the date and time that the task should start.| -|[DoubleCellValue](/javascript/api/excel/excel.doublecellvalue)|[type](/javascript/api/excel/excel.doublecellvalue#excel-excel-doublecellvalue-type-member)|Represents the type of this cell value.| -|[EmailIdentity](/javascript/api/excel/excel.emailidentity)|[displayName](/javascript/api/excel/excel.emailidentity#excel-excel-emailidentity-displayname-member)|Represents the user's display name.| -||[email](/javascript/api/excel/excel.emailidentity#excel-excel-emailidentity-email-member)|Represents the user's email.| -||[id](/javascript/api/excel/excel.emailidentity#excel-excel-emailidentity-id-member)|Represents the user's unique ID.| -|[EntityArrayCardLayout](/javascript/api/excel/excel.entityarraycardlayout)|[arrayProperty](/javascript/api/excel/excel.entityarraycardlayout#excel-excel-entityarraycardlayout-arrayproperty-member)|Represents name of the property that contains the array shown in the card.| -||[columnsToReport](/javascript/api/excel/excel.entityarraycardlayout#excel-excel-entityarraycardlayout-columnstoreport-member)|Represents the count of columns which the card claims are in the array.| -||[displayName](/javascript/api/excel/excel.entityarraycardlayout#excel-excel-entityarraycardlayout-displayname-member)|Represents name of the property that contains the array shown in the card.| -||[firstRowIsHeader](/javascript/api/excel/excel.entityarraycardlayout#excel-excel-entityarraycardlayout-firstrowisheader-member)|Represents whether the first row of the array is treated as a header.| -||[layout](/javascript/api/excel/excel.entityarraycardlayout#excel-excel-entityarraycardlayout-layout-member)|Represents the type of this layout.| -||[rowsToReport](/javascript/api/excel/excel.entityarraycardlayout#excel-excel-entityarraycardlayout-rowstoreport-member)|Represents the count of rows which the card claims are in the array.| -|[EntityCardLayout](/javascript/api/excel/excel.entitycardlayout)|[layout](/javascript/api/excel/excel.entitycardlayout#excel-excel-entitycardlayout-layout-member)|Represents the type of this layout.| -|[ExternalCodeServiceObjectCellValue](/javascript/api/excel/excel.externalcodeserviceobjectcellvalue)|[Python_str](/javascript/api/excel/excel.externalcodeserviceobjectcellvalue#excel-excel-externalcodeserviceobjectcellvalue-python_str-member)|Represents the output of the `str()` function when used on this object.| -||[Python_type](/javascript/api/excel/excel.externalcodeserviceobjectcellvalue#excel-excel-externalcodeserviceobjectcellvalue-python_type-member)|Represents the full type name of this object.| -||[Python_typeName](/javascript/api/excel/excel.externalcodeserviceobjectcellvalue#excel-excel-externalcodeserviceobjectcellvalue-python_typename-member)|Represents the short type name of this object.| -||[basicType](/javascript/api/excel/excel.externalcodeserviceobjectcellvalue#excel-excel-externalcodeserviceobjectcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/javascript/api/excel/excel.externalcodeserviceobjectcellvalue#excel-excel-externalcodeserviceobjectcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[language](/javascript/api/excel/excel.externalcodeserviceobjectcellvalue#excel-excel-externalcodeserviceobjectcellvalue-language-member)|Represents the runtime language of this external code service.| -||[preview](/javascript/api/excel/excel.externalcodeserviceobjectcellvalue#excel-excel-externalcodeserviceobjectcellvalue-preview-member)|Represents the preview value shown in the cell.| -||[provider](/javascript/api/excel/excel.externalcodeserviceobjectcellvalue#excel-excel-externalcodeserviceobjectcellvalue-provider-member)|Represents information about the service that provided the data in this `ExternalCodeServiceObjectCellValue`.| -||[type](/javascript/api/excel/excel.externalcodeserviceobjectcellvalue#excel-excel-externalcodeserviceobjectcellvalue-type-member)|Represents the type of this cell value.| -|[Identity](/javascript/api/excel/excel.identity)|[displayName](/javascript/api/excel/excel.identity#excel-excel-identity-displayname-member)|Represents the user's display name.| -||[id](/javascript/api/excel/excel.identity#excel-excel-identity-id-member)|Represents the user's unique ID.| -|[LinkedDataType](/javascript/api/excel/excel.linkeddatatype)|[dataProvider](/javascript/api/excel/excel.linkeddatatype#excel-excel-linkeddatatype-dataprovider-member)|The name of the data provider for the linked data type.| -||[lastRefreshed](/javascript/api/excel/excel.linkeddatatype#excel-excel-linkeddatatype-lastrefreshed-member)|The local time-zone date and time since the workbook was opened when the linked data type was last refreshed.| -||[name](/javascript/api/excel/excel.linkeddatatype#excel-excel-linkeddatatype-name-member)|The name of the linked data type.| -||[periodicRefreshInterval](/javascript/api/excel/excel.linkeddatatype#excel-excel-linkeddatatype-periodicrefreshinterval-member)|The frequency, in seconds, at which the linked data type is refreshed if `refreshMode` is set to "Periodic".| -||[refreshMode](/javascript/api/excel/excel.linkeddatatype#excel-excel-linkeddatatype-refreshmode-member)|The mechanism by which the data for the linked data type is retrieved.| -||[requestRefresh()](/javascript/api/excel/excel.linkeddatatype#excel-excel-linkeddatatype-requestrefresh-member(1))|Makes a request to refresh the linked data type.| -||[requestSetRefreshMode(refreshMode: Excel.LinkedDataTypeRefreshMode)](/javascript/api/excel/excel.linkeddatatype#excel-excel-linkeddatatype-requestsetrefreshmode-member(1))|Makes a request to change the refresh mode for this linked data type.| -||[serviceId](/javascript/api/excel/excel.linkeddatatype#excel-excel-linkeddatatype-serviceid-member)|The unique ID of the linked data type.| -||[supportedRefreshModes](/javascript/api/excel/excel.linkeddatatype#excel-excel-linkeddatatype-supportedrefreshmodes-member)|Returns an array with all the refresh modes supported by the linked data type.| -|[LinkedDataTypeAddedEventArgs](/javascript/api/excel/excel.linkeddatatypeaddedeventargs)|[serviceId](/javascript/api/excel/excel.linkeddatatypeaddedeventargs#excel-excel-linkeddatatypeaddedeventargs-serviceid-member)|The unique ID of the new linked data type.| -||[source](/javascript/api/excel/excel.linkeddatatypeaddedeventargs#excel-excel-linkeddatatypeaddedeventargs-source-member)|Gets the source of the event.| -||[type](/javascript/api/excel/excel.linkeddatatypeaddedeventargs#excel-excel-linkeddatatypeaddedeventargs-type-member)|Gets the type of the event.| -|[LinkedDataTypeCollection](/javascript/api/excel/excel.linkeddatatypecollection)|[getCount()](/javascript/api/excel/excel.linkeddatatypecollection#excel-excel-linkeddatatypecollection-getcount-member(1))|Gets the number of linked data types in the collection.| -||[getItem(key: number)](/javascript/api/excel/excel.linkeddatatypecollection#excel-excel-linkeddatatypecollection-getitem-member(1))|Gets a linked data type by service ID.| -||[getItemAt(index: number)](/javascript/api/excel/excel.linkeddatatypecollection#excel-excel-linkeddatatypecollection-getitemat-member(1))|Gets a linked data type by its index in the collection.| -||[getItemOrNullObject(key: number)](/javascript/api/excel/excel.linkeddatatypecollection#excel-excel-linkeddatatypecollection-getitemornullobject-member(1))|Gets a linked data type by ID.| -||[items](/javascript/api/excel/excel.linkeddatatypecollection#excel-excel-linkeddatatypecollection-items-member)|Gets the loaded child items in this collection.| -||[requestRefreshAll()](/javascript/api/excel/excel.linkeddatatypecollection#excel-excel-linkeddatatypecollection-requestrefreshall-member(1))|Makes a request to refresh all the linked data types in the collection.| -|[LocalImage](/javascript/api/excel/excel.localimage)|[getBase64EncodedImageData(cacheUid: string)](/javascript/api/excel/excel.localimage#excel-excel-localimage-getbase64encodedimagedata-member(1))|Gets the Base64-encoded image data stored in the shared image cache with the cache unique identifier (UID).| -|[LocalImageCellValue](/javascript/api/excel/excel.localimagecellvalue)|[altText](/javascript/api/excel/excel.localimagecellvalue#excel-excel-localimagecellvalue-alttext-member)|Represents the alternate text used in accessibility scenarios to describe what the image represents.| -||[attribution](/javascript/api/excel/excel.localimagecellvalue#excel-excel-localimagecellvalue-attribution-member)|Represents attribution information to describe the source and license requirements for this image.| -||[basicType](/javascript/api/excel/excel.localimagecellvalue#excel-excel-localimagecellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/javascript/api/excel/excel.localimagecellvalue#excel-excel-localimagecellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[image](/javascript/api/excel/excel.localimagecellvalue#excel-excel-localimagecellvalue-image-member)|Represents the image itself, either cached or encoded.| -||[provider](/javascript/api/excel/excel.localimagecellvalue#excel-excel-localimagecellvalue-provider-member)|Represents information that describes the entity or individual who provided the image.| -||[type](/javascript/api/excel/excel.localimagecellvalue#excel-excel-localimagecellvalue-type-member)|Represents the type of this cell value.| -|[LocalImageCellValueCacheId](/javascript/api/excel/excel.localimagecellvaluecacheid)|[cachedUid](/javascript/api/excel/excel.localimagecellvaluecacheid#excel-excel-localimagecellvaluecacheid-cacheduid-member)|Represents the image's UID as it appears in the cache.| -|[NameErrorCellValue](/javascript/api/excel/excel.nameerrorcellvalue)|[errorSubType](/javascript/api/excel/excel.nameerrorcellvalue#excel-excel-nameerrorcellvalue-errorsubtype-member)|Represents the type of `NameErrorCellValue`.| -|[NamedSheetViewCollection](/javascript/api/excel/excel.namedsheetviewcollection)|[getItemOrNullObject(key: string)](/javascript/api/excel/excel.namedsheetviewcollection#excel-excel-namedsheetviewcollection-getitemornullobject-member(1))|Gets a sheet view using its name.| -|[NotAvailableErrorCellValue](/javascript/api/excel/excel.notavailableerrorcellvalue)|[errorSubType](/javascript/api/excel/excel.notavailableerrorcellvalue#excel-excel-notavailableerrorcellvalue-errorsubtype-member)|Represents the type of `NotAvailableErrorCellValue`.| -|[PivotLayout](/javascript/api/excel/excel.pivotlayout)|[getCell(dataHierarchy: DataPivotHierarchy \| string, rowItems: Array, columnItems: Array)](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-getcell-member(1))|Gets a unique cell in the PivotTable based on a data hierarchy and the row and column items of their respective hierarchies.| -||[pivotStyle](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-pivotstyle-member)|The style applied to the PivotTable.| -||[setStyle(style: string \| PivotTableStyle \| BuiltInPivotTableStyle)](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-setstyle-member(1))|Sets the style applied to the PivotTable.| -|[PivotTable](/javascript/api/excel/excel.pivottable)|[autoRefresh](/javascript/api/excel/excel.pivottable#excel-excel-pivottable-autorefresh-member)|Specifies whether the PivotTable auto refreshes when the source data changes.| -|[PythonErrorCellValue](/javascript/api/excel/excel.pythonerrorcellvalue)|[basicType](/javascript/api/excel/excel.pythonerrorcellvalue#excel-excel-pythonerrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/javascript/api/excel/excel.pythonerrorcellvalue#excel-excel-pythonerrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[errorType](/javascript/api/excel/excel.pythonerrorcellvalue#excel-excel-pythonerrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| -||[type](/javascript/api/excel/excel.pythonerrorcellvalue#excel-excel-pythonerrorcellvalue-type-member)|Represents the type of this cell value.| -|[Query](/javascript/api/excel/excel.query)|[delete()](/javascript/api/excel/excel.query#excel-excel-query-delete-member(1))|Deletes the query and associated connection.| -||[refresh()](/javascript/api/excel/excel.query#excel-excel-query-refresh-member(1))|Refreshes the query.| -|[QueryCollection](/javascript/api/excel/excel.querycollection)|[refreshAll()](/javascript/api/excel/excel.querycollection#excel-excel-querycollection-refreshall-member(1))|Refresh all queries.| -|[Range](/javascript/api/excel/excel.range)|[togglePythonMarshalMode(marshalMode?: Excel.PythonMarshalMode)](/javascript/api/excel/excel.range#excel-excel-range-togglepythonmarshalmode-member(1))|Sets the marshaling mode of the Python in Excel formula =PY.| -|[RangeAreas](/javascript/api/excel/excel.rangeareas)||| -|[RefErrorCellValue](/javascript/api/excel/excel.referrorcellvalue)|[errorSubType](/javascript/api/excel/excel.referrorcellvalue#excel-excel-referrorcellvalue-errorsubtype-member)|Represents the type of `RefErrorCellValue`.| -|[RefreshModeChangedEventArgs](/javascript/api/excel/excel.refreshmodechangedeventargs)|[refreshMode](/javascript/api/excel/excel.refreshmodechangedeventargs#excel-excel-refreshmodechangedeventargs-refreshmode-member)|The linked data type refresh mode.| -||[serviceId](/javascript/api/excel/excel.refreshmodechangedeventargs#excel-excel-refreshmodechangedeventargs-serviceid-member)|The unique ID of the object whose refresh mode was changed.| -||[source](/javascript/api/excel/excel.refreshmodechangedeventargs#excel-excel-refreshmodechangedeventargs-source-member)|Gets the source of the event.| -||[type](/javascript/api/excel/excel.refreshmodechangedeventargs#excel-excel-refreshmodechangedeventargs-type-member)|Gets the type of the event.| -|[RefreshRequestCompletedEventArgs](/javascript/api/excel/excel.refreshrequestcompletedeventargs)|[refreshed](/javascript/api/excel/excel.refreshrequestcompletedeventargs#excel-excel-refreshrequestcompletedeventargs-refreshed-member)|Indicates if the request to refresh was successful.| -||[serviceId](/javascript/api/excel/excel.refreshrequestcompletedeventargs#excel-excel-refreshrequestcompletedeventargs-serviceid-member)|The unique ID of the object whose refresh request was completed.| -||[source](/javascript/api/excel/excel.refreshrequestcompletedeventargs#excel-excel-refreshrequestcompletedeventargs-source-member)|Gets the source of the event.| -||[type](/javascript/api/excel/excel.refreshrequestcompletedeventargs#excel-excel-refreshrequestcompletedeventargs-type-member)|Gets the type of the event.| -||[warnings](/javascript/api/excel/excel.refreshrequestcompletedeventargs#excel-excel-refreshrequestcompletedeventargs-warnings-member)|An array that contains any warnings generated from the refresh request.| -|[ShapeCollection](/javascript/api/excel/excel.shapecollection)|[addLocalImageReference(address: string)](/javascript/api/excel/excel.shapecollection#excel-excel-shapecollection-addlocalimagereference-member(1))|Creates a reference for the local image stored in the cell address and displays it as a floating shape over cells.| -||[addSvg(xml: string)](/javascript/api/excel/excel.shapecollection#excel-excel-shapecollection-addsvg-member(1))|Creates a scalable vector graphic (SVG) from an XML string and adds it to the worksheet.| -|[Slicer](/javascript/api/excel/excel.slicer)|[nameInFormula](/javascript/api/excel/excel.slicer#excel-excel-slicer-nameinformula-member)|Specifies the slicer name used in the formula.| -||[setStyle(style: string \| SlicerStyle \| BuiltInSlicerStyle)](/javascript/api/excel/excel.slicer#excel-excel-slicer-setstyle-member(1))|Sets the style applied to the slicer.| -||[slicerStyle](/javascript/api/excel/excel.slicer#excel-excel-slicer-slicerstyle-member)|The style applied to the slicer.| -|[StringCellValue](/javascript/api/excel/excel.stringcellvalue)|[type](/javascript/api/excel/excel.stringcellvalue#excel-excel-stringcellvalue-type-member)|Represents the type of this cell value.| -|[Table](/javascript/api/excel/excel.table)|[clearStyle()](/javascript/api/excel/excel.table#excel-excel-table-clearstyle-member(1))|Changes the table to use the default table style.| -||[onFiltered](/javascript/api/excel/excel.table#excel-excel-table-onfiltered-member)|Occurs when a filter is applied on a specific table.| -||[setStyle(style: string \| TableStyle \| BuiltInTableStyle)](/javascript/api/excel/excel.table#excel-excel-table-setstyle-member(1))|Sets the style applied to the table.| -||[tableStyle](/javascript/api/excel/excel.table#excel-excel-table-tablestyle-member)|The style applied to the table.| -|[TableCollection](/javascript/api/excel/excel.tablecollection)|[onFiltered](/javascript/api/excel/excel.tablecollection#excel-excel-tablecollection-onfiltered-member)|Occurs when a filter is applied on any table in a workbook, or a worksheet.| -|[TableFilteredEventArgs](/javascript/api/excel/excel.tablefilteredeventargs)|[tableId](/javascript/api/excel/excel.tablefilteredeventargs#excel-excel-tablefilteredeventargs-tableid-member)|Gets the ID of the table in which the filter is applied.| -||[type](/javascript/api/excel/excel.tablefilteredeventargs#excel-excel-tablefilteredeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/javascript/api/excel/excel.tablefilteredeventargs#excel-excel-tablefilteredeventargs-worksheetid-member)|Gets the ID of the worksheet which contains the table.| -|[TimeoutErrorCellValue](/javascript/api/excel/excel.timeouterrorcellvalue)|[basicType](/javascript/api/excel/excel.timeouterrorcellvalue#excel-excel-timeouterrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/javascript/api/excel/excel.timeouterrorcellvalue#excel-excel-timeouterrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[errorSubType](/javascript/api/excel/excel.timeouterrorcellvalue#excel-excel-timeouterrorcellvalue-errorsubtype-member)|Represents the type of `TimeoutErrorCellValue`.| -||[errorType](/javascript/api/excel/excel.timeouterrorcellvalue#excel-excel-timeouterrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| -||[type](/javascript/api/excel/excel.timeouterrorcellvalue#excel-excel-timeouterrorcellvalue-type-member)|Represents the type of this cell value.| -|[ValueErrorCellValue](/javascript/api/excel/excel.valueerrorcellvalue)|[errorSubType](/javascript/api/excel/excel.valueerrorcellvalue#excel-excel-valueerrorcellvalue-errorsubtype-member)|Represents the type of `ValueErrorCellValue`.| -|[Workbook](/javascript/api/excel/excel.workbook)|[enterPreviewMode()](/javascript/api/excel/excel.workbook#excel-excel-workbook-enterpreviewmode-member(1))|Enters Scratchpad Preview Mode for the workbook, showing changes suggested by Copilot to the user.| -||[exitPreviewMode(applyChanges: boolean)](/javascript/api/excel/excel.workbook#excel-excel-workbook-exitpreviewmode-member(1))|Exits Scratchpad Preview Mode for the workbook.| -||[externalCodeServiceTimeout](/javascript/api/excel/excel.workbook#excel-excel-workbook-externalcodeservicetimeout-member)|Specifies the maximum length of time, in seconds, allotted for a formula that depends on an external code service to complete.| -||[linkedDataTypes](/javascript/api/excel/excel.workbook#excel-excel-workbook-linkeddatatypes-member)|Returns a collection of linked data types that are part of the workbook.| -||[localImage](/javascript/api/excel/excel.workbook#excel-excel-workbook-localimage-member)|Returns the `LocalImage` object associated with the workbook.| -||[showPivotFieldList](/javascript/api/excel/excel.workbook#excel-excel-workbook-showpivotfieldlist-member)|Specifies whether the PivotTable's field list pane is shown at the workbook level.| -||[tasks](/javascript/api/excel/excel.workbook#excel-excel-workbook-tasks-member)|Returns a collection of tasks that are present in the workbook.| -||[use1904DateSystem](/javascript/api/excel/excel.workbook#excel-excel-workbook-use1904datesystem-member)|True if the workbook uses the 1904 date system.| -|[Worksheet](/javascript/api/excel/excel.worksheet)|[onFiltered](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-onfiltered-member)|Occurs when a filter is applied on a specific worksheet.| -||[tasks](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-tasks-member)|Returns a collection of tasks that are present in the worksheet.| -|[WorksheetCollection](/javascript/api/excel/excel.worksheetcollection)|[addFromBase64(base64File: string, sheetNamesToInsert?: string[], positionType?: Excel.WorksheetPositionType, relativeTo?: Worksheet \| string)](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-addfrombase64-member(1))|Inserts the specified worksheets of a workbook into the current workbook.| -||[onFiltered](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-onfiltered-member)|Occurs when any worksheet's filter is applied in the workbook.| -|[WorksheetFilteredEventArgs](/javascript/api/excel/excel.worksheetfilteredeventargs)|[type](/javascript/api/excel/excel.worksheetfilteredeventargs#excel-excel-worksheetfilteredeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/javascript/api/excel/excel.worksheetfilteredeventargs#excel-excel-worksheetfilteredeventargs-worksheetid-member)|Gets the ID of the worksheet in which the filter is applied.| +|[Application](/.application)|[formatStaleValues](/.application#excel-javascript/api/excel/-application-formatstalevalues-member)|Specifies whether the Format Stale Values option within Calculation Options is enabled or disabled.| +|[Base64EncodedImage](/.base64encodedimage)|[data](/.base64encodedimage#excel-javascript/api/excel/-base64encodedimage-data-member)|The Base64-encoded string.| +||[type](/.base64encodedimage#excel-javascript/api/excel/-base64encodedimage-type-member)|The file type of the Base64-encoded image.| +|[BlockedErrorCellValue](/.blockederrorcellvalue)|[errorSubType](/.blockederrorcellvalue#excel-javascript/api/excel/-blockederrorcellvalue-errorsubtype-member)|Represents the type of `BlockedErrorCellValue`.| +|[BooleanCellValue](/.booleancellvalue)|[type](/.booleancellvalue#excel-javascript/api/excel/-booleancellvalue-type-member)|Represents the type of this cell value.| +|[BusyErrorCellValue](/.busyerrorcellvalue)|[errorSubType](/.busyerrorcellvalue#excel-javascript/api/excel/-busyerrorcellvalue-errorsubtype-member)|Represents the type of `BusyErrorCellValue`.| +|[CalcErrorCellValue](/.calcerrorcellvalue)|[errorSubType](/.calcerrorcellvalue#excel-javascript/api/excel/-calcerrorcellvalue-errorsubtype-member)|Represents the type of `CalcErrorCellValue`.| +|[Chart](/.chart)|[getDataRange()](/.chart#excel-javascript/api/excel/-chart-getdatarange-member(1))|Gets the data source of the whole chart.| +||[getDataRangeOrNullObject()](/.chart#excel-javascript/api/excel/-chart-getdatarangeornullobject-member(1))|Gets the data source of the whole chart.| +|[Comment](/.comment)|[assignTask(assignee: Excel.EmailIdentity)](/.comment#excel-javascript/api/excel/-comment-assigntask-member(1))|Assigns the task attached to the comment to the given user as an assignee.| +||[getTask()](/.comment#excel-javascript/api/excel/-comment-gettask-member(1))|Gets the task associated with this comment.| +||[getTaskOrNullObject()](/.comment#excel-javascript/api/excel/-comment-gettaskornullobject-member(1))|Gets the task associated with this comment.| +|[CommentReply](/.commentreply)|[assignTask(assignee: Excel.EmailIdentity)](/.commentreply#excel-javascript/api/excel/-commentreply-assigntask-member(1))|Assigns the task attached to the comment to the given user as the sole assignee.| +||[getTask()](/.commentreply#excel-javascript/api/excel/-commentreply-gettask-member(1))|Gets the task associated with this comment reply's thread.| +||[getTaskOrNullObject()](/.commentreply#excel-javascript/api/excel/-commentreply-gettaskornullobject-member(1))|Gets the task associated with this comment reply's thread.| +|[ConnectErrorCellValue](/.connecterrorcellvalue)|[errorSubType](/.connecterrorcellvalue#excel-javascript/api/excel/-connecterrorcellvalue-errorsubtype-member)|Represents the type of `ConnectErrorCellValue`.| +|[DatetimeFormatInfo](/.datetimeformatinfo)|[shortDateTimePattern](/.datetimeformatinfo#excel-javascript/api/excel/-datetimeformatinfo-shortdatetimepattern-member)|Gets the format string for a short date and time value.| +|[DocumentTask](/.documenttask)|[assign(assignee: Excel.EmailIdentity)](/.documenttask#excel-javascript/api/excel/-documenttask-assign-member(1))|Adds the given user to the list of assignees attached to the task.| +||[assignees](/.documenttask#excel-javascript/api/excel/-documenttask-assignees-member)|Returns a collection of assignees of the task.| +||[changes](/.documenttask#excel-javascript/api/excel/-documenttask-changes-member)|Gets the change records of the task.| +||[comment](/.documenttask#excel-javascript/api/excel/-documenttask-comment-member)|Gets the comment associated with the task.| +||[completedBy](/.documenttask#excel-javascript/api/excel/-documenttask-completedby-member)|Gets the most recent user to have completed the task.| +||[completedDateTime](/.documenttask#excel-javascript/api/excel/-documenttask-completeddatetime-member)|Gets the date and time that the task was completed.| +||[createdBy](/.documenttask#excel-javascript/api/excel/-documenttask-createdby-member)|Gets the user who created the task.| +||[createdDateTime](/.documenttask#excel-javascript/api/excel/-documenttask-createddatetime-member)|Gets the date and time that the task was created.| +||[id](/.documenttask#excel-javascript/api/excel/-documenttask-id-member)|Gets the ID of the task.| +||[percentComplete](/.documenttask#excel-javascript/api/excel/-documenttask-percentcomplete-member)|Specifies the completion percentage of the task.| +||[priority](/.documenttask#excel-javascript/api/excel/-documenttask-priority-member)|Specifies the priority of the task.| +||[startAndDueDateTime](/.documenttask#excel-javascript/api/excel/-documenttask-startandduedatetime-member)|Gets or sets the date and time the task should start and is due.| +||[title](/.documenttask#excel-javascript/api/excel/-documenttask-title-member)|Specifies title of the task.| +||[unassign(assignee: Excel.EmailIdentity)](/.documenttask#excel-javascript/api/excel/-documenttask-unassign-member(1))|Removes the given user from the list of assignees attached to the task.| +||[unassignAll()](/.documenttask#excel-javascript/api/excel/-documenttask-unassignall-member(1))|Removes all users from the list of assignees attached to the task.| +|[DocumentTaskChange](/.documenttaskchange)|[assignee](/.documenttaskchange#excel-javascript/api/excel/-documenttaskchange-assignee-member)|Represents the user assigned to the task for an `assign` change action, or the user unassigned from the task for an `unassign` change action.| +||[changedBy](/.documenttaskchange#excel-javascript/api/excel/-documenttaskchange-changedby-member)|Represents the identity of the user who made the task change.| +||[commentId](/.documenttaskchange#excel-javascript/api/excel/-documenttaskchange-commentid-member)|Represents the ID of the comment or comment reply to which the task change is anchored.| +||[createdDateTime](/.documenttaskchange#excel-javascript/api/excel/-documenttaskchange-createddatetime-member)|Represents the creation date and time of the task change record.| +||[dueDateTime](/.documenttaskchange#excel-javascript/api/excel/-documenttaskchange-duedatetime-member)|Represents the task's due date and time.| +||[id](/.documenttaskchange#excel-javascript/api/excel/-documenttaskchange-id-member)|The unique GUID of the task change.| +||[percentComplete](/.documenttaskchange#excel-javascript/api/excel/-documenttaskchange-percentcomplete-member)|Represents the task's completion percentage.| +||[priority](/.documenttaskchange#excel-javascript/api/excel/-documenttaskchange-priority-member)|Represents the task's priority.| +||[startDateTime](/.documenttaskchange#excel-javascript/api/excel/-documenttaskchange-startdatetime-member)|Represents the task's start date and time.| +||[title](/.documenttaskchange#excel-javascript/api/excel/-documenttaskchange-title-member)|Represents the task's title.| +||[type](/.documenttaskchange#excel-javascript/api/excel/-documenttaskchange-type-member)|Represents the action type of the task change record.| +||[undoChangeId](/.documenttaskchange#excel-javascript/api/excel/-documenttaskchange-undochangeid-member)|Represents the `DocumentTaskChange.id` property that was undone for the `undo` change action.| +|[DocumentTaskChangeCollection](/.documenttaskchangecollection)|[getCount()](/.documenttaskchangecollection#excel-javascript/api/excel/-documenttaskchangecollection-getcount-member(1))|Gets the number of change records in the collection for the task.| +||[getItemAt(index: number)](/.documenttaskchangecollection#excel-javascript/api/excel/-documenttaskchangecollection-getitemat-member(1))|Gets a task change record by using its index in the collection.| +||[items](/.documenttaskchangecollection#excel-javascript/api/excel/-documenttaskchangecollection-items-member)|Gets the loaded child items in this collection.| +|[DocumentTaskCollection](/.documenttaskcollection)|[getCount()](/.documenttaskcollection#excel-javascript/api/excel/-documenttaskcollection-getcount-member(1))|Gets the number of tasks in the collection.| +||[getItem(key: string)](/.documenttaskcollection#excel-javascript/api/excel/-documenttaskcollection-getitem-member(1))|Gets a task using its ID.| +||[getItemAt(index: number)](/.documenttaskcollection#excel-javascript/api/excel/-documenttaskcollection-getitemat-member(1))|Gets a task by its index in the collection.| +||[getItemOrNullObject(key: string)](/.documenttaskcollection#excel-javascript/api/excel/-documenttaskcollection-getitemornullobject-member(1))|Gets a task using its ID.| +||[items](/.documenttaskcollection#excel-javascript/api/excel/-documenttaskcollection-items-member)|Gets the loaded child items in this collection.| +|[DocumentTaskSchedule](/.documenttaskschedule)|[dueDateTime](/.documenttaskschedule#excel-javascript/api/excel/-documenttaskschedule-duedatetime-member)|Gets the date and time that the task is due.| +||[startDateTime](/.documenttaskschedule#excel-javascript/api/excel/-documenttaskschedule-startdatetime-member)|Gets the date and time that the task should start.| +|[DoubleCellValue](/.doublecellvalue)|[type](/.doublecellvalue#excel-javascript/api/excel/-doublecellvalue-type-member)|Represents the type of this cell value.| +|[EmailIdentity](/.emailidentity)|[displayName](/.emailidentity#excel-javascript/api/excel/-emailidentity-displayname-member)|Represents the user's display name.| +||[email](/.emailidentity#excel-javascript/api/excel/-emailidentity-email-member)|Represents the user's email.| +||[id](/.emailidentity#excel-javascript/api/excel/-emailidentity-id-member)|Represents the user's unique ID.| +|[EntityArrayCardLayout](/.entityarraycardlayout)|[arrayProperty](/.entityarraycardlayout#excel-javascript/api/excel/-entityarraycardlayout-arrayproperty-member)|Represents name of the property that contains the array shown in the card.| +||[columnsToReport](/.entityarraycardlayout#excel-javascript/api/excel/-entityarraycardlayout-columnstoreport-member)|Represents the count of columns which the card claims are in the array.| +||[displayName](/.entityarraycardlayout#excel-javascript/api/excel/-entityarraycardlayout-displayname-member)|Represents name of the property that contains the array shown in the card.| +||[firstRowIsHeader](/.entityarraycardlayout#excel-javascript/api/excel/-entityarraycardlayout-firstrowisheader-member)|Represents whether the first row of the array is treated as a header.| +||[layout](/.entityarraycardlayout#excel-javascript/api/excel/-entityarraycardlayout-layout-member)|Represents the type of this layout.| +||[rowsToReport](/.entityarraycardlayout#excel-javascript/api/excel/-entityarraycardlayout-rowstoreport-member)|Represents the count of rows which the card claims are in the array.| +|[EntityCardLayout](/.entitycardlayout)|[layout](/.entitycardlayout#excel-javascript/api/excel/-entitycardlayout-layout-member)|Represents the type of this layout.| +|[ExternalCodeServiceObjectCellValue](/.externalcodeserviceobjectcellvalue)|[Python_str](/.externalcodeserviceobjectcellvalue#excel-javascript/api/excel/-externalcodeserviceobjectcellvalue-python_str-member)|Represents the output of the `str()` function when used on this object.| +||[Python_type](/.externalcodeserviceobjectcellvalue#excel-javascript/api/excel/-externalcodeserviceobjectcellvalue-python_type-member)|Represents the full type name of this object.| +||[Python_typeName](/.externalcodeserviceobjectcellvalue#excel-javascript/api/excel/-externalcodeserviceobjectcellvalue-python_typename-member)|Represents the short type name of this object.| +||[basicType](/.externalcodeserviceobjectcellvalue#excel-javascript/api/excel/-externalcodeserviceobjectcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/.externalcodeserviceobjectcellvalue#excel-javascript/api/excel/-externalcodeserviceobjectcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[language](/.externalcodeserviceobjectcellvalue#excel-javascript/api/excel/-externalcodeserviceobjectcellvalue-language-member)|Represents the runtime language of this external code service.| +||[preview](/.externalcodeserviceobjectcellvalue#excel-javascript/api/excel/-externalcodeserviceobjectcellvalue-preview-member)|Represents the preview value shown in the cell.| +||[provider](/.externalcodeserviceobjectcellvalue#excel-javascript/api/excel/-externalcodeserviceobjectcellvalue-provider-member)|Represents information about the service that provided the data in this `ExternalCodeServiceObjectCellValue`.| +||[type](/.externalcodeserviceobjectcellvalue#excel-javascript/api/excel/-externalcodeserviceobjectcellvalue-type-member)|Represents the type of this cell value.| +|[Identity](/.identity)|[displayName](/.identity#excel-javascript/api/excel/-identity-displayname-member)|Represents the user's display name.| +||[id](/.identity#excel-javascript/api/excel/-identity-id-member)|Represents the user's unique ID.| +|[LinkedDataType](/.linkeddatatype)|[dataProvider](/.linkeddatatype#excel-javascript/api/excel/-linkeddatatype-dataprovider-member)|The name of the data provider for the linked data type.| +||[lastRefreshed](/.linkeddatatype#excel-javascript/api/excel/-linkeddatatype-lastrefreshed-member)|The local time-zone date and time since the workbook was opened when the linked data type was last refreshed.| +||[name](/.linkeddatatype#excel-javascript/api/excel/-linkeddatatype-name-member)|The name of the linked data type.| +||[periodicRefreshInterval](/.linkeddatatype#excel-javascript/api/excel/-linkeddatatype-periodicrefreshinterval-member)|The frequency, in seconds, at which the linked data type is refreshed if `refreshMode` is set to "Periodic".| +||[refreshMode](/.linkeddatatype#excel-javascript/api/excel/-linkeddatatype-refreshmode-member)|The mechanism by which the data for the linked data type is retrieved.| +||[requestRefresh()](/.linkeddatatype#excel-javascript/api/excel/-linkeddatatype-requestrefresh-member(1))|Makes a request to refresh the linked data type.| +||[requestSetRefreshMode(refreshMode: Excel.LinkedDataTypeRefreshMode)](/.linkeddatatype#excel-javascript/api/excel/-linkeddatatype-requestsetrefreshmode-member(1))|Makes a request to change the refresh mode for this linked data type.| +||[serviceId](/.linkeddatatype#excel-javascript/api/excel/-linkeddatatype-serviceid-member)|The unique ID of the linked data type.| +||[supportedRefreshModes](/.linkeddatatype#excel-javascript/api/excel/-linkeddatatype-supportedrefreshmodes-member)|Returns an array with all the refresh modes supported by the linked data type.| +|[LinkedDataTypeAddedEventArgs](/.linkeddatatypeaddedeventargs)|[serviceId](/.linkeddatatypeaddedeventargs#excel-javascript/api/excel/-linkeddatatypeaddedeventargs-serviceid-member)|The unique ID of the new linked data type.| +||[source](/.linkeddatatypeaddedeventargs#excel-javascript/api/excel/-linkeddatatypeaddedeventargs-source-member)|Gets the source of the event.| +||[type](/.linkeddatatypeaddedeventargs#excel-javascript/api/excel/-linkeddatatypeaddedeventargs-type-member)|Gets the type of the event.| +|[LinkedDataTypeCollection](/.linkeddatatypecollection)|[getCount()](/.linkeddatatypecollection#excel-javascript/api/excel/-linkeddatatypecollection-getcount-member(1))|Gets the number of linked data types in the collection.| +||[getItem(key: number)](/.linkeddatatypecollection#excel-javascript/api/excel/-linkeddatatypecollection-getitem-member(1))|Gets a linked data type by service ID.| +||[getItemAt(index: number)](/.linkeddatatypecollection#excel-javascript/api/excel/-linkeddatatypecollection-getitemat-member(1))|Gets a linked data type by its index in the collection.| +||[getItemOrNullObject(key: number)](/.linkeddatatypecollection#excel-javascript/api/excel/-linkeddatatypecollection-getitemornullobject-member(1))|Gets a linked data type by ID.| +||[items](/.linkeddatatypecollection#excel-javascript/api/excel/-linkeddatatypecollection-items-member)|Gets the loaded child items in this collection.| +||[requestRefreshAll()](/.linkeddatatypecollection#excel-javascript/api/excel/-linkeddatatypecollection-requestrefreshall-member(1))|Makes a request to refresh all the linked data types in the collection.| +|[LocalImage](/.localimage)|[getBase64EncodedImageData(cacheUid: string)](/.localimage#excel-javascript/api/excel/-localimage-getbase64encodedimagedata-member(1))|Gets the Base64-encoded image data stored in the shared image cache with the cache unique identifier (UID).| +|[LocalImageCellValue](/.localimagecellvalue)|[altText](/.localimagecellvalue#excel-javascript/api/excel/-localimagecellvalue-alttext-member)|Represents the alternate text used in accessibility scenarios to describe what the image represents.| +||[attribution](/.localimagecellvalue#excel-javascript/api/excel/-localimagecellvalue-attribution-member)|Represents attribution information to describe the source and license requirements for this image.| +||[basicType](/.localimagecellvalue#excel-javascript/api/excel/-localimagecellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/.localimagecellvalue#excel-javascript/api/excel/-localimagecellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[image](/.localimagecellvalue#excel-javascript/api/excel/-localimagecellvalue-image-member)|Represents the image itself, either cached or encoded.| +||[provider](/.localimagecellvalue#excel-javascript/api/excel/-localimagecellvalue-provider-member)|Represents information that describes the entity or individual who provided the image.| +||[type](/.localimagecellvalue#excel-javascript/api/excel/-localimagecellvalue-type-member)|Represents the type of this cell value.| +|[LocalImageCellValueCacheId](/.localimagecellvaluecacheid)|[cachedUid](/.localimagecellvaluecacheid#excel-javascript/api/excel/-localimagecellvaluecacheid-cacheduid-member)|Represents the image's UID as it appears in the cache.| +|[NameErrorCellValue](/.nameerrorcellvalue)|[errorSubType](/.nameerrorcellvalue#excel-javascript/api/excel/-nameerrorcellvalue-errorsubtype-member)|Represents the type of `NameErrorCellValue`.| +|[NamedSheetViewCollection](/.namedsheetviewcollection)|[getItemOrNullObject(key: string)](/.namedsheetviewcollection#excel-javascript/api/excel/-namedsheetviewcollection-getitemornullobject-member(1))|Gets a sheet view using its name.| +|[NotAvailableErrorCellValue](/.notavailableerrorcellvalue)|[errorSubType](/.notavailableerrorcellvalue#excel-javascript/api/excel/-notavailableerrorcellvalue-errorsubtype-member)|Represents the type of `NotAvailableErrorCellValue`.| +|[PivotLayout](/.pivotlayout)|[getCell(dataHierarchy: DataPivotHierarchy \| string, rowItems: Array, columnItems: Array)](/.pivotlayout#excel-javascript/api/excel/-pivotlayout-getcell-member(1))|Gets a unique cell in the PivotTable based on a data hierarchy and the row and column items of their respective hierarchies.| +||[pivotStyle](/.pivotlayout#excel-javascript/api/excel/-pivotlayout-pivotstyle-member)|The style applied to the PivotTable.| +||[setStyle(style: string \| PivotTableStyle \| BuiltInPivotTableStyle)](/.pivotlayout#excel-javascript/api/excel/-pivotlayout-setstyle-member(1))|Sets the style applied to the PivotTable.| +|[PivotTable](/.pivottable)|[autoRefresh](/.pivottable#excel-javascript/api/excel/-pivottable-autorefresh-member)|Specifies whether the PivotTable auto refreshes when the source data changes.| +|[PythonErrorCellValue](/.pythonerrorcellvalue)|[basicType](/.pythonerrorcellvalue#excel-javascript/api/excel/-pythonerrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/.pythonerrorcellvalue#excel-javascript/api/excel/-pythonerrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[errorType](/.pythonerrorcellvalue#excel-javascript/api/excel/-pythonerrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| +||[type](/.pythonerrorcellvalue#excel-javascript/api/excel/-pythonerrorcellvalue-type-member)|Represents the type of this cell value.| +|[Query](/.query)|[delete()](/.query#excel-javascript/api/excel/-query-delete-member(1))|Deletes the query and associated connection.| +||[refresh()](/.query#excel-javascript/api/excel/-query-refresh-member(1))|Refreshes the query.| +|[QueryCollection](/.querycollection)|[refreshAll()](/.querycollection#excel-javascript/api/excel/-querycollection-refreshall-member(1))|Refresh all queries.| +|[Range](/.range)|[togglePythonMarshalMode(marshalMode?: Excel.PythonMarshalMode)](/.range#excel-javascript/api/excel/-range-togglepythonmarshalmode-member(1))|Sets the marshaling mode of the Python in Excel formula =PY.| +|[RangeAreas](/.rangeareas)||| +|[RefErrorCellValue](/.referrorcellvalue)|[errorSubType](/.referrorcellvalue#excel-javascript/api/excel/-referrorcellvalue-errorsubtype-member)|Represents the type of `RefErrorCellValue`.| +|[RefreshModeChangedEventArgs](/.refreshmodechangedeventargs)|[refreshMode](/.refreshmodechangedeventargs#excel-javascript/api/excel/-refreshmodechangedeventargs-refreshmode-member)|The linked data type refresh mode.| +||[serviceId](/.refreshmodechangedeventargs#excel-javascript/api/excel/-refreshmodechangedeventargs-serviceid-member)|The unique ID of the object whose refresh mode was changed.| +||[source](/.refreshmodechangedeventargs#excel-javascript/api/excel/-refreshmodechangedeventargs-source-member)|Gets the source of the event.| +||[type](/.refreshmodechangedeventargs#excel-javascript/api/excel/-refreshmodechangedeventargs-type-member)|Gets the type of the event.| +|[RefreshRequestCompletedEventArgs](/.refreshrequestcompletedeventargs)|[refreshed](/.refreshrequestcompletedeventargs#excel-javascript/api/excel/-refreshrequestcompletedeventargs-refreshed-member)|Indicates if the request to refresh was successful.| +||[serviceId](/.refreshrequestcompletedeventargs#excel-javascript/api/excel/-refreshrequestcompletedeventargs-serviceid-member)|The unique ID of the object whose refresh request was completed.| +||[source](/.refreshrequestcompletedeventargs#excel-javascript/api/excel/-refreshrequestcompletedeventargs-source-member)|Gets the source of the event.| +||[type](/.refreshrequestcompletedeventargs#excel-javascript/api/excel/-refreshrequestcompletedeventargs-type-member)|Gets the type of the event.| +||[warnings](/.refreshrequestcompletedeventargs#excel-javascript/api/excel/-refreshrequestcompletedeventargs-warnings-member)|An array that contains any warnings generated from the refresh request.| +|[ShapeCollection](/.shapecollection)|[addLocalImageReference(address: string)](/.shapecollection#excel-javascript/api/excel/-shapecollection-addlocalimagereference-member(1))|Creates a reference for the local image stored in the cell address and displays it as a floating shape over cells.| +||[addSvg(xml: string)](/.shapecollection#excel-javascript/api/excel/-shapecollection-addsvg-member(1))|Creates a scalable vector graphic (SVG) from an XML string and adds it to the worksheet.| +|[Slicer](/.slicer)|[nameInFormula](/.slicer#excel-javascript/api/excel/-slicer-nameinformula-member)|Specifies the slicer name used in the formula.| +||[setStyle(style: string \| SlicerStyle \| BuiltInSlicerStyle)](/.slicer#excel-javascript/api/excel/-slicer-setstyle-member(1))|Sets the style applied to the slicer.| +||[slicerStyle](/.slicer#excel-javascript/api/excel/-slicer-slicerstyle-member)|The style applied to the slicer.| +|[StringCellValue](/.stringcellvalue)|[type](/.stringcellvalue#excel-javascript/api/excel/-stringcellvalue-type-member)|Represents the type of this cell value.| +|[Table](/.table)|[clearStyle()](/.table#excel-javascript/api/excel/-table-clearstyle-member(1))|Changes the table to use the default table style.| +||[onFiltered](/.table#excel-javascript/api/excel/-table-onfiltered-member)|Occurs when a filter is applied on a specific table.| +||[setStyle(style: string \| TableStyle \| BuiltInTableStyle)](/.table#excel-javascript/api/excel/-table-setstyle-member(1))|Sets the style applied to the table.| +||[tableStyle](/.table#excel-javascript/api/excel/-table-tablestyle-member)|The style applied to the table.| +|[TableCollection](/.tablecollection)|[onFiltered](/.tablecollection#excel-javascript/api/excel/-tablecollection-onfiltered-member)|Occurs when a filter is applied on any table in a workbook, or a worksheet.| +|[TableFilteredEventArgs](/.tablefilteredeventargs)|[tableId](/.tablefilteredeventargs#excel-javascript/api/excel/-tablefilteredeventargs-tableid-member)|Gets the ID of the table in which the filter is applied.| +||[type](/.tablefilteredeventargs#excel-javascript/api/excel/-tablefilteredeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/.tablefilteredeventargs#excel-javascript/api/excel/-tablefilteredeventargs-worksheetid-member)|Gets the ID of the worksheet which contains the table.| +|[TimeoutErrorCellValue](/.timeouterrorcellvalue)|[basicType](/.timeouterrorcellvalue#excel-javascript/api/excel/-timeouterrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/.timeouterrorcellvalue#excel-javascript/api/excel/-timeouterrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[errorSubType](/.timeouterrorcellvalue#excel-javascript/api/excel/-timeouterrorcellvalue-errorsubtype-member)|Represents the type of `TimeoutErrorCellValue`.| +||[errorType](/.timeouterrorcellvalue#excel-javascript/api/excel/-timeouterrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| +||[type](/.timeouterrorcellvalue#excel-javascript/api/excel/-timeouterrorcellvalue-type-member)|Represents the type of this cell value.| +|[ValueErrorCellValue](/.valueerrorcellvalue)|[errorSubType](/.valueerrorcellvalue#excel-javascript/api/excel/-valueerrorcellvalue-errorsubtype-member)|Represents the type of `ValueErrorCellValue`.| +|[Workbook](/.workbook)|[enterPreviewMode()](/.workbook#excel-javascript/api/excel/-workbook-enterpreviewmode-member(1))|Enters Scratchpad Preview Mode for the workbook, showing changes suggested by Copilot to the user.| +||[exitPreviewMode(applyChanges: boolean)](/.workbook#excel-javascript/api/excel/-workbook-exitpreviewmode-member(1))|Exits Scratchpad Preview Mode for the workbook.| +||[externalCodeServiceTimeout](/.workbook#excel-javascript/api/excel/-workbook-externalcodeservicetimeout-member)|Specifies the maximum length of time, in seconds, allotted for a formula that depends on an external code service to complete.| +||[linkedDataTypes](/.workbook#excel-javascript/api/excel/-workbook-linkeddatatypes-member)|Returns a collection of linked data types that are part of the workbook.| +||[localImage](/.workbook#excel-javascript/api/excel/-workbook-localimage-member)|Returns the `LocalImage` object associated with the workbook.| +||[showPivotFieldList](/.workbook#excel-javascript/api/excel/-workbook-showpivotfieldlist-member)|Specifies whether the PivotTable's field list pane is shown at the workbook level.| +||[tasks](/.workbook#excel-javascript/api/excel/-workbook-tasks-member)|Returns a collection of tasks that are present in the workbook.| +||[use1904DateSystem](/.workbook#excel-javascript/api/excel/-workbook-use1904datesystem-member)|True if the workbook uses the 1904 date system.| +|[Worksheet](/.worksheet)|[onFiltered](/.worksheet#excel-javascript/api/excel/-worksheet-onfiltered-member)|Occurs when a filter is applied on a specific worksheet.| +||[tasks](/.worksheet#excel-javascript/api/excel/-worksheet-tasks-member)|Returns a collection of tasks that are present in the worksheet.| +|[WorksheetCollection](/.worksheetcollection)|[addFromBase64(base64File: string, sheetNamesToInsert?: string[], positionType?: Excel.WorksheetPositionType, relativeTo?: Worksheet \| string)](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-addfrombase64-member(1))|Inserts the specified worksheets of a workbook into the current workbook.| +||[onFiltered](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-onfiltered-member)|Occurs when any worksheet's filter is applied in the workbook.| +|[WorksheetFilteredEventArgs](/.worksheetfilteredeventargs)|[type](/.worksheetfilteredeventargs#excel-javascript/api/excel/-worksheetfilteredeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/.worksheetfilteredeventargs#excel-javascript/api/excel/-worksheetfilteredeventargs-worksheetid-member)|Gets the ID of the worksheet in which the filter is applied.| diff --git a/docs/includes/outlook-1_1.md b/docs/includes/outlook-1_1.md index f09ba4fafc..04ff4f3e18 100644 --- a/docs/includes/outlook-1_1.md +++ b/docs/includes/outlook-1_1.md @@ -1,85 +1,87 @@ | Class | Fields | Description | |:---|:---|:---| -|[AppointmentCompose](/javascript/api/outlook/office.appointmentcompose)|[addFileAttachmentAsync(uri: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-addfileattachmentasync-member(1))|Adds a file to a message or appointment as an attachment.| -||[addFileAttachmentAsync(uri: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-addfileattachmentasync-member(1))|Adds a file to a message or appointment as an attachment.| -||[addItemAttachmentAsync(itemId: any, attachmentName: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-additemattachmentasync-member(1))|Adds an Exchange item, such as a message, as an attachment to the message or appointment.| -||[addItemAttachmentAsync(itemId: any, attachmentName: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-additemattachmentasync-member(1))|Adds an Exchange item, such as a message, as an attachment to the message or appointment.| -||[body](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-body-member)|Gets an object that provides methods for manipulating the body of an item.| -||[loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void, userContext?: any)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-loadcustompropertiesasync-member(1))|Asynchronously loads custom properties for this add-in on the selected item.| -||[removeAttachmentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-removeattachmentasync-member(1))|Removes an attachment from a message or appointment.| -||[removeAttachmentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-removeattachmentasync-member(1))|Removes an attachment from a message or appointment.| -|[AppointmentForm](/javascript/api/outlook/office.appointmentform)|[body](/javascript/api/outlook/office.appointmentform#outlook-office-appointmentform-body-member)|Gets an object that provides methods for manipulating the body of an item.| -|[AppointmentRead](/javascript/api/outlook/office.appointmentread)|[body](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-body-member)|Gets an object that provides methods for manipulating the body of an item.| -||[dateTimeModified](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-datetimemodified-member)|Gets the date and time that an item was last modified.| -||[displayReplyAllForm(formData: string \| ReplyFormData)](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-displayreplyallform-member(1))|Displays a reply form that includes either the sender and all recipients of the selected message or the organizer and all attendees of the| -||[displayReplyForm(formData: string \| ReplyFormData)](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-displayreplyform-member(1))|Displays a reply form that includes only the sender of the selected message or the organizer of the selected appointment.| -||[getEntities()](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-getentities-member(1))|Gets the entities found in the selected item's body.| -||[getEntitiesByType(entityType: MailboxEnums.EntityType \| string)](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-getentitiesbytype-member(1))|Gets an array of all the entities of the specified entity type found in the selected item's body.| -||[getFilteredEntitiesByName(name: string)](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-getfilteredentitiesbyname-member(1))|Returns well-known entities in the selected item that pass the named filter defined in an add-in only manifest file.| -||[getRegExMatches()](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-getregexmatches-member(1))|Returns string values in the selected item that match the regular expressions defined in an add-in only manifest file.| -||[getRegExMatchesByName(name: string)](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-getregexmatchesbyname-member(1))|Returns string values in the selected item that match the named regular expression defined in an add-in only manifest file.| -||[loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void, userContext?: any)](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-loadcustompropertiesasync-member(1))|Asynchronously loads custom properties for this add-in on the selected item.| -|[AttachmentDetails](/javascript/api/outlook/office.attachmentdetails)|[attachmentType](/javascript/api/outlook/office.attachmentdetails#outlook-office-attachmentdetails-attachmenttype-member)|Gets a value that indicates the attachment's type.| -||[contentType](/javascript/api/outlook/office.attachmentdetails#outlook-office-attachmentdetails-contenttype-member)|Gets the MIME content type of the attachment.| -||[id](/javascript/api/outlook/office.attachmentdetails#outlook-office-attachmentdetails-id-member)|Gets the Exchange attachment ID of the attachment.| -||[isInline](/javascript/api/outlook/office.attachmentdetails#outlook-office-attachmentdetails-isinline-member)|Gets a value that indicates whether the attachment appears as an image in the body of the item instead of in the attachment list.| -||[name](/javascript/api/outlook/office.attachmentdetails#outlook-office-attachmentdetails-name-member)|Gets the name of the attachment.| -||[size](/javascript/api/outlook/office.attachmentdetails#outlook-office-attachmentdetails-size-member)|Gets the size of the attachment in bytes.| -|[Body](/javascript/api/outlook/office.body)|[getTypeAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.body#outlook-office-body-gettypeasync-member(1))|Gets a value that indicates whether the content is in HTML or text format.| -||[getTypeAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.body#outlook-office-body-gettypeasync-member(1))|Gets a value that indicates whether the content is in HTML or text format.| -||[prependAsync(data: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.body#outlook-office-body-prependasync-member(1))|Adds the specified content to the beginning of the item body.| -||[prependAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.body#outlook-office-body-prependasync-member(1))|Adds the specified content to the beginning of the item body.| -||[setSelectedDataAsync(data: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.body#outlook-office-body-setselecteddataasync-member(1))|Replaces the selection in the body with the specified text.| -||[setSelectedDataAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.body#outlook-office-body-setselecteddataasync-member(1))|Replaces the selection in the body with the specified text.| -|[CustomProperties](/javascript/api/outlook/office.customproperties)|[get(name: string)](/javascript/api/outlook/office.customproperties#outlook-office-customproperties-get-member(1))|Returns the value of the specified custom property.| -||[remove(name: string)](/javascript/api/outlook/office.customproperties#outlook-office-customproperties-remove-member(1))|Removes the specified property from the custom property collection.| -||[saveAsync(asyncContext?: any)](/javascript/api/outlook/office.customproperties#outlook-office-customproperties-saveasync-member(1))|Saves custom properties to a message or appointment.| -||[saveAsync(callback: (asyncResult: Office.AsyncResult) => void, asyncContext?: any)](/javascript/api/outlook/office.customproperties#outlook-office-customproperties-saveasync-member(1))|Saves custom properties to a message or appointment.| -|[Diagnostics](/javascript/api/outlook/office.diagnostics)|[OWAView](/javascript/api/outlook/office.diagnostics#outlook-office-diagnostics-owaview-member)|Gets a string that represents the current view of Outlook on the web.| -||[hostName](/javascript/api/outlook/office.diagnostics#outlook-office-diagnostics-hostname-member)|Gets a string that represents the type of Outlook client.| -||[hostVersion](/javascript/api/outlook/office.diagnostics#outlook-office-diagnostics-hostversion-member)|Gets a string that represents the version of either the Outlook client or the Exchange Server (for example, "15.0.468.0").| -|[Location](/javascript/api/outlook/office.location)|[getAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.location#outlook-office-location-getasync-member(1))|Gets the location of an appointment.| -||[getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.location#outlook-office-location-getasync-member(1))|Gets the location of an appointment.| -||[setAsync(location: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.location#outlook-office-location-setasync-member(1))|Sets the location of an appointment.| -||[setAsync(location: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.location#outlook-office-location-setasync-member(1))|Sets the location of an appointment.| -|[Mailbox](/javascript/api/outlook/office.mailbox)|[displayAppointmentForm(itemId: string)](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-displayappointmentform-member(1))|Displays an existing calendar appointment.| -||[displayMessageForm(itemId: string)](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-displaymessageform-member(1))|Displays an existing message.| -||[displayNewAppointmentForm(parameters: AppointmentForm)](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-displaynewappointmentform-member(1))|Displays a form for creating a new calendar appointment.| -||[ewsUrl](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-ewsurl-member)|Gets the URL of the Exchange Web Services (EWS) endpoint for this email account.| -||[makeEwsRequestAsync(data: any, callback: (asyncResult: Office.AsyncResult) => void, userContext?: any)](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-makeewsrequestasync-member(1))|Makes an asynchronous request to an Exchange Web Services (EWS) service on the Exchange server that hosts the user's mailbox.| -|[MessageCompose](/javascript/api/outlook/office.messagecompose)|[addFileAttachmentAsync(uri: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-addfileattachmentasync-member(1))|Adds a file to a message or appointment as an attachment.| -||[addFileAttachmentAsync(uri: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-addfileattachmentasync-member(1))|Adds a file to a message or appointment as an attachment.| -||[addItemAttachmentAsync(itemId: any, attachmentName: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-additemattachmentasync-member(1))|Adds an Exchange item, such as a message, as an attachment to the message or appointment.| -||[addItemAttachmentAsync(itemId: any, attachmentName: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-additemattachmentasync-member(1))|Adds an Exchange item, such as a message, as an attachment to the message or appointment.| -||[bcc](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-bcc-member)|Gets an object that provides methods to get or update the recipients on the **Bcc** (blind carbon copy) line of a message.| -||[body](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-body-member)|Gets an object that provides methods for manipulating the body of an item.| -||[loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void, userContext?: any)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-loadcustompropertiesasync-member(1))|Asynchronously loads custom properties for this add-in on the selected item.| -||[removeAttachmentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-removeattachmentasync-member(1))|Removes an attachment from a message or appointment.| -||[removeAttachmentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-removeattachmentasync-member(1))|Removes an attachment from a message or appointment.| -|[MessageRead](/javascript/api/outlook/office.messageread)|[body](/javascript/api/outlook/office.messageread#outlook-office-messageread-body-member)|Gets an object that provides methods for manipulating the body of an item.| -||[dateTimeModified](/javascript/api/outlook/office.messageread#outlook-office-messageread-datetimemodified-member)|Gets the date and time that an item was last modified.| -||[displayReplyAllForm(formData: string \| ReplyFormData)](/javascript/api/outlook/office.messageread#outlook-office-messageread-displayreplyallform-member(1))|Displays a reply form that includes either the sender and all recipients of the selected message or the organizer and all attendees of the| -||[displayReplyForm(formData: string \| ReplyFormData)](/javascript/api/outlook/office.messageread#outlook-office-messageread-displayreplyform-member(1))|Displays a reply form that includes only the sender of the selected message or the organizer of the selected appointment.| -||[getEntities()](/javascript/api/outlook/office.messageread#outlook-office-messageread-getentities-member(1))|Gets the entities found in the selected item's body.| -||[getEntitiesByType(entityType: MailboxEnums.EntityType \| string)](/javascript/api/outlook/office.messageread#outlook-office-messageread-getentitiesbytype-member(1))|Gets an array of all the entities of the specified entity type found in the selected item's body.| -||[getFilteredEntitiesByName(name: string)](/javascript/api/outlook/office.messageread#outlook-office-messageread-getfilteredentitiesbyname-member(1))|Returns well-known entities in the selected item that pass the named filter defined in an add-in only manifest file.| -||[getRegExMatches()](/javascript/api/outlook/office.messageread#outlook-office-messageread-getregexmatches-member(1))|Returns string values in the selected item that match the regular expressions defined in an add-in only manifest file.| -||[getRegExMatchesByName(name: string)](/javascript/api/outlook/office.messageread#outlook-office-messageread-getregexmatchesbyname-member(1))|Returns string values in the selected item that match the named regular expression defined in an add-in only manifest file.| -||[loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void, userContext?: any)](/javascript/api/outlook/office.messageread#outlook-office-messageread-loadcustompropertiesasync-member(1))|Asynchronously loads custom properties for this add-in on the selected item.| -|[Recipients](/javascript/api/outlook/office.recipients)|[addAsync(recipients: Array, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.recipients#outlook-office-recipients-addasync-member(1))|Adds a recipient list to the existing recipients for an appointment or message.| -||[addAsync(recipients: Array, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.recipients#outlook-office-recipients-addasync-member(1))|Adds a recipient list to the existing recipients for an appointment or message.| -||[getAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.recipients#outlook-office-recipients-getasync-member(1))|Gets a recipient list for an appointment or message.| -||[getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.recipients#outlook-office-recipients-getasync-member(1))|Gets a recipient list for an appointment or message.| -||[setAsync(recipients: Array, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.recipients#outlook-office-recipients-setasync-member(1))|Sets a recipient list for an appointment or message.| -||[setAsync(recipients: Array, options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.recipients#outlook-office-recipients-setasync-member(1))|Sets a recipient list for an appointment or message.| -|[RoamingSettings](/javascript/api/outlook/office.roamingsettings)|[get(name: string)](/javascript/api/outlook/office.roamingsettings#outlook-office-roamingsettings-get-member(1))|Retrieves the specified setting.| -||[remove(name: string)](/javascript/api/outlook/office.roamingsettings#outlook-office-roamingsettings-remove-member(1))|Removes the specified setting.| -||[saveAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.roamingsettings#outlook-office-roamingsettings-saveasync-member(1))|Saves the settings.| -|[Subject](/javascript/api/outlook/office.subject)|[getAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.subject#outlook-office-subject-getasync-member(1))|Gets the subject of an appointment or message.| -||[getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.subject#outlook-office-subject-getasync-member(1))|Gets the subject of an appointment or message.| -||[setAsync(subject: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.subject#outlook-office-subject-setasync-member(1))|Sets the subject of an appointment or message.| -||[setAsync(subject: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.subject#outlook-office-subject-setasync-member(1))|Sets the subject of an appointment or message.| -|[Time](/javascript/api/outlook/office.time)|[getAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.time#outlook-office-time-getasync-member(1))|Gets the start or end time of an appointment.| -||[getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.time#outlook-office-time-getasync-member(1))|Gets the start or end time of an appointment.| -||[setAsync(dateTime: Date, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.time#outlook-office-time-setasync-member(1))|Sets the start or end time of an appointment.| -||[setAsync(dateTime: Date, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.time#outlook-office-time-setasync-member(1))|Sets the start or end time of an appointment.| +|[AppointmentCompose](/.appointmentcompose)|[addFileAttachmentAsync(uri: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-addfileattachmentasync-member(1))|Adds a file to a message or appointment as an attachment.| +||[addFileAttachmentAsync(uri: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-addfileattachmentasync-member(1))|Adds a file to a message or appointment as an attachment.| +||[addItemAttachmentAsync(itemId: any, attachmentName: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-additemattachmentasync-member(1))|Adds an Exchange item, such as a message, as an attachment to the message or appointment.| +||[addItemAttachmentAsync(itemId: any, attachmentName: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-additemattachmentasync-member(1))|Adds an Exchange item, such as a message, as an attachment to the message or appointment.| +||[body](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-body-member)|Gets an object that provides methods for manipulating the body of an item.| +||[loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void, userContext?: any)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-loadcustompropertiesasync-member(1))|Asynchronously loads custom properties for this add-in on the selected item.| +||[removeAttachmentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-removeattachmentasync-member(1))|Removes an attachment from a message or appointment.| +||[removeAttachmentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-removeattachmentasync-member(1))|Removes an attachment from a message or appointment.| +|[AppointmentForm](/.appointmentform)|[body](/.appointmentform#outlook-javascript/api/outlook/-appointmentform-body-member)|Gets an object that provides methods for manipulating the body of an item.| +|[AppointmentRead](/.appointmentread)|[body](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-body-member)|Gets an object that provides methods for manipulating the body of an item.| +||[dateTimeModified](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-datetimemodified-member)|Gets the date and time that an item was last modified.| +||[displayReplyAllForm(formData: string \| ReplyFormData)](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-displayreplyallform-member(1))|Displays a reply form that includes either the sender and all recipients of the selected message or the organizer and all attendees of the| +||[displayReplyForm(formData: string \| ReplyFormData)](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-displayreplyform-member(1))|Displays a reply form that includes only the sender of the selected message or the organizer of the selected appointment.| +||[getEntities()](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-getentities-member(1))|Gets the entities found in the selected item's body.| +||[getEntitiesByType(entityType: MailboxEnums.EntityType \| string)](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-getentitiesbytype-member(1))|Gets an array of all the entities of the specified entity type found in the selected item's body.| +||[getFilteredEntitiesByName(name: string)](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-getfilteredentitiesbyname-member(1))|Returns well-known entities in the selected item that pass the named filter defined in an add-in only manifest file.| +||[getRegExMatches()](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-getregexmatches-member(1))|Returns string values in the selected item that match the regular expressions defined in an add-in only manifest file.| +||[getRegExMatchesByName(name: string)](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-getregexmatchesbyname-member(1))|Returns string values in the selected item that match the named regular expression defined in an add-in only manifest file.| +||[loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void, userContext?: any)](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-loadcustompropertiesasync-member(1))|Asynchronously loads custom properties for this add-in on the selected item.| +|[AttachmentDetails](/.attachmentdetails)|[attachmentType](/.attachmentdetails#outlook-javascript/api/outlook/-attachmentdetails-attachmenttype-member)|Gets a value that indicates the attachment's type.| +||[contentType](/.attachmentdetails#outlook-javascript/api/outlook/-attachmentdetails-contenttype-member)|Gets the MIME content type of the attachment.| +||[id](/.attachmentdetails#outlook-javascript/api/outlook/-attachmentdetails-id-member)|Gets the Exchange attachment ID of the attachment.| +||[isInline](/.attachmentdetails#outlook-javascript/api/outlook/-attachmentdetails-isinline-member)|Gets a value that indicates whether the attachment appears as an image in the body of the item instead of in the attachment list.| +||[name](/.attachmentdetails#outlook-javascript/api/outlook/-attachmentdetails-name-member)|Gets the name of the attachment.| +||[size](/.attachmentdetails#outlook-javascript/api/outlook/-attachmentdetails-size-member)|Gets the size of the attachment in bytes.| +|[Body](/.body)|[getTypeAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/.body#outlook-javascript/api/outlook/-body-gettypeasync-member(1))|Gets a value that indicates whether the content is in HTML or text format.| +||[getTypeAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.body#outlook-javascript/api/outlook/-body-gettypeasync-member(1))|Gets a value that indicates whether the content is in HTML or text format.| +||[prependAsync(data: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.body#outlook-javascript/api/outlook/-body-prependasync-member(1))|Adds the specified content to the beginning of the item body.| +||[prependAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.body#outlook-javascript/api/outlook/-body-prependasync-member(1))|Adds the specified content to the beginning of the item body.| +||[setSelectedDataAsync(data: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.body#outlook-javascript/api/outlook/-body-setselecteddataasync-member(1))|Replaces the selection in the body with the specified text.| +||[setSelectedDataAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.body#outlook-javascript/api/outlook/-body-setselecteddataasync-member(1))|Replaces the selection in the body with the specified text.| +|[CustomProperties](/.customproperties)|[get(name: string)](/.customproperties#outlook-javascript/api/outlook/-customproperties-get-member(1))|Returns the value of the specified custom property.| +||[remove(name: string)](/.customproperties#outlook-javascript/api/outlook/-customproperties-remove-member(1))|Removes the specified property from the custom property collection.| +||[saveAsync(asyncContext?: any)](/.customproperties#outlook-javascript/api/outlook/-customproperties-saveasync-member(1))|Saves custom properties to a message or appointment.| +||[saveAsync(callback: (asyncResult: Office.AsyncResult) => void, asyncContext?: any)](/.customproperties#outlook-javascript/api/outlook/-customproperties-saveasync-member(1))|Saves custom properties to a message or appointment.| +||[set(name: string, value: string)](/.customproperties#outlook-javascript/api/outlook/-customproperties-set-member(1))|Sets the specified property to the specified value.| +|[Diagnostics](/.diagnostics)|[OWAView](/.diagnostics#outlook-javascript/api/outlook/-diagnostics-owaview-member)|Gets a string that represents the current view of Outlook on the web.| +||[hostName](/.diagnostics#outlook-javascript/api/outlook/-diagnostics-hostname-member)|Gets a string that represents the type of Outlook client.| +||[hostVersion](/.diagnostics#outlook-javascript/api/outlook/-diagnostics-hostversion-member)|Gets a string that represents the version of either the Outlook client or the Exchange Server (for example, "15.0.468.0").| +|[Location](/.location)|[getAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.location#outlook-javascript/api/outlook/-location-getasync-member(1))|Gets the location of an appointment.| +||[getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.location#outlook-javascript/api/outlook/-location-getasync-member(1))|Gets the location of an appointment.| +||[setAsync(location: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.location#outlook-javascript/api/outlook/-location-setasync-member(1))|Sets the location of an appointment.| +||[setAsync(location: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.location#outlook-javascript/api/outlook/-location-setasync-member(1))|Sets the location of an appointment.| +|[Mailbox](/.mailbox)|[displayAppointmentForm(itemId: string)](/.mailbox#outlook-javascript/api/outlook/-mailbox-displayappointmentform-member(1))|Displays an existing calendar appointment.| +||[displayMessageForm(itemId: string)](/.mailbox#outlook-javascript/api/outlook/-mailbox-displaymessageform-member(1))|Displays an existing message.| +||[displayNewAppointmentForm(parameters: AppointmentForm)](/.mailbox#outlook-javascript/api/outlook/-mailbox-displaynewappointmentform-member(1))|Displays a form for creating a new calendar appointment.| +||[ewsUrl](/.mailbox#outlook-javascript/api/outlook/-mailbox-ewsurl-member)|Gets the URL of the Exchange Web Services (EWS) endpoint for this email account.| +||[makeEwsRequestAsync(data: any, callback: (asyncResult: Office.AsyncResult) => void, userContext?: any)](/.mailbox#outlook-javascript/api/outlook/-mailbox-makeewsrequestasync-member(1))|Makes an asynchronous request to an Exchange Web Services (EWS) service on the Exchange server that hosts the user's mailbox.| +|[MessageCompose](/.messagecompose)|[addFileAttachmentAsync(uri: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-addfileattachmentasync-member(1))|Adds a file to a message or appointment as an attachment.| +||[addFileAttachmentAsync(uri: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-addfileattachmentasync-member(1))|Adds a file to a message or appointment as an attachment.| +||[addItemAttachmentAsync(itemId: any, attachmentName: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-additemattachmentasync-member(1))|Adds an Exchange item, such as a message, as an attachment to the message or appointment.| +||[addItemAttachmentAsync(itemId: any, attachmentName: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-additemattachmentasync-member(1))|Adds an Exchange item, such as a message, as an attachment to the message or appointment.| +||[bcc](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-bcc-member)|Gets an object that provides methods to get or update the recipients on the **Bcc** (blind carbon copy) line of a message.| +||[body](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-body-member)|Gets an object that provides methods for manipulating the body of an item.| +||[loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void, userContext?: any)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-loadcustompropertiesasync-member(1))|Asynchronously loads custom properties for this add-in on the selected item.| +||[removeAttachmentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-removeattachmentasync-member(1))|Removes an attachment from a message or appointment.| +||[removeAttachmentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-removeattachmentasync-member(1))|Removes an attachment from a message or appointment.| +|[MessageRead](/.messageread)|[body](/.messageread#outlook-javascript/api/outlook/-messageread-body-member)|Gets an object that provides methods for manipulating the body of an item.| +||[dateTimeModified](/.messageread#outlook-javascript/api/outlook/-messageread-datetimemodified-member)|Gets the date and time that an item was last modified.| +||[displayReplyAllForm(formData: string \| ReplyFormData)](/.messageread#outlook-javascript/api/outlook/-messageread-displayreplyallform-member(1))|Displays a reply form that includes either the sender and all recipients of the selected message or the organizer and all attendees of the| +||[displayReplyForm(formData: string \| ReplyFormData)](/.messageread#outlook-javascript/api/outlook/-messageread-displayreplyform-member(1))|Displays a reply form that includes only the sender of the selected message or the organizer of the selected appointment.| +||[getEntities()](/.messageread#outlook-javascript/api/outlook/-messageread-getentities-member(1))|Gets the entities found in the selected item's body.| +||[getEntitiesByType(entityType: MailboxEnums.EntityType \| string)](/.messageread#outlook-javascript/api/outlook/-messageread-getentitiesbytype-member(1))|Gets an array of all the entities of the specified entity type found in the selected item's body.| +||[getFilteredEntitiesByName(name: string)](/.messageread#outlook-javascript/api/outlook/-messageread-getfilteredentitiesbyname-member(1))|Returns well-known entities in the selected item that pass the named filter defined in an add-in only manifest file.| +||[getRegExMatches()](/.messageread#outlook-javascript/api/outlook/-messageread-getregexmatches-member(1))|Returns string values in the selected item that match the regular expressions defined in an add-in only manifest file.| +||[getRegExMatchesByName(name: string)](/.messageread#outlook-javascript/api/outlook/-messageread-getregexmatchesbyname-member(1))|Returns string values in the selected item that match the named regular expression defined in an add-in only manifest file.| +||[loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void, userContext?: any)](/.messageread#outlook-javascript/api/outlook/-messageread-loadcustompropertiesasync-member(1))|Asynchronously loads custom properties for this add-in on the selected item.| +|[Recipients](/.recipients)|[addAsync(recipients: Array, callback?: (asyncResult: Office.AsyncResult) => void)](/.recipients#outlook-javascript/api/outlook/-recipients-addasync-member(1))|Adds a recipient list to the existing recipients for an appointment or message.| +||[addAsync(recipients: Array, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.recipients#outlook-javascript/api/outlook/-recipients-addasync-member(1))|Adds a recipient list to the existing recipients for an appointment or message.| +||[getAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.recipients#outlook-javascript/api/outlook/-recipients-getasync-member(1))|Gets a recipient list for an appointment or message.| +||[getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.recipients#outlook-javascript/api/outlook/-recipients-getasync-member(1))|Gets a recipient list for an appointment or message.| +||[setAsync(recipients: Array, callback: (asyncResult: Office.AsyncResult) => void)](/.recipients#outlook-javascript/api/outlook/-recipients-setasync-member(1))|Sets a recipient list for an appointment or message.| +||[setAsync(recipients: Array, options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.recipients#outlook-javascript/api/outlook/-recipients-setasync-member(1))|Sets a recipient list for an appointment or message.| +|[RoamingSettings](/.roamingsettings)|[get(name: string)](/.roamingsettings#outlook-javascript/api/outlook/-roamingsettings-get-member(1))|Retrieves the specified setting.| +||[remove(name: string)](/.roamingsettings#outlook-javascript/api/outlook/-roamingsettings-remove-member(1))|Removes the specified setting.| +||[saveAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/.roamingsettings#outlook-javascript/api/outlook/-roamingsettings-saveasync-member(1))|Saves the settings.| +||[set(name: string, value: any)](/.roamingsettings#outlook-javascript/api/outlook/-roamingsettings-set-member(1))|Sets or creates the specified setting.| +|[Subject](/.subject)|[getAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.subject#outlook-javascript/api/outlook/-subject-getasync-member(1))|Gets the subject of an appointment or message.| +||[getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.subject#outlook-javascript/api/outlook/-subject-getasync-member(1))|Gets the subject of an appointment or message.| +||[setAsync(subject: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.subject#outlook-javascript/api/outlook/-subject-setasync-member(1))|Sets the subject of an appointment or message.| +||[setAsync(subject: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.subject#outlook-javascript/api/outlook/-subject-setasync-member(1))|Sets the subject of an appointment or message.| +|[Time](/.time)|[getAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.time#outlook-javascript/api/outlook/-time-getasync-member(1))|Gets the start or end time of an appointment.| +||[getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.time#outlook-javascript/api/outlook/-time-getasync-member(1))|Gets the start or end time of an appointment.| +||[setAsync(dateTime: Date, callback?: (asyncResult: Office.AsyncResult) => void)](/.time#outlook-javascript/api/outlook/-time-setasync-member(1))|Sets the start or end time of an appointment.| +||[setAsync(dateTime: Date, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.time#outlook-javascript/api/outlook/-time-setasync-member(1))|Sets the start or end time of an appointment.| diff --git a/docs/includes/outlook-1_10.md b/docs/includes/outlook-1_10.md index ac7bca22cb..ef0476bab2 100644 --- a/docs/includes/outlook-1_10.md +++ b/docs/includes/outlook-1_10.md @@ -1,24 +1,24 @@ | Class | Fields | Description | |:---|:---|:---| -|[AppointmentCompose](/javascript/api/outlook/office.appointmentcompose)|[disableClientSignatureAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-disableclientsignatureasync-member(1))|Disables the Outlook client signature.| -||[disableClientSignatureAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-disableclientsignatureasync-member(1))|Disables the Outlook client signature.| -||[isClientSignatureEnabledAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-isclientsignatureenabledasync-member(1))|Gets if the client signature is enabled.| -||[isClientSignatureEnabledAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-isclientsignatureenabledasync-member(1))|Gets if the client signature is enabled.| -|[Body](/javascript/api/outlook/office.body)|[setSignatureAsync(data: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.body#outlook-office-body-setsignatureasync-member(1))|Adds a signature to the item body if it doesn't have an existing signature.| -||[setSignatureAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.body#outlook-office-body-setsignatureasync-member(1))|Adds a signature to the item body if it doesn't have an existing signature.| -|[InfobarClickedEventArgs](/javascript/api/outlook/office.infobarclickedeventargs)|[infobarDetails](/javascript/api/outlook/office.infobarclickedeventargs#outlook-office-infobarclickedeventargs-infobardetails-member)|Gets additional details about the notification message.| -||[type](/javascript/api/outlook/office.infobarclickedeventargs#outlook-office-infobarclickedeventargs-type-member)|Gets the type of the event.| -|[InfobarDetails](/javascript/api/outlook/office.infobardetails)|[actionType](/javascript/api/outlook/office.infobardetails#outlook-office-infobardetails-actiontype-member)|The action type.| -||[infobarType](/javascript/api/outlook/office.infobardetails#outlook-office-infobardetails-infobartype-member)|The notification type.| -|[MailboxEvent](/javascript/api/outlook/office.mailboxevent)|[completed()](/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1))|Indicates that the event-based or spam-reporting add-in has completed processing an event.| -|[MessageCompose](/javascript/api/outlook/office.messagecompose)|[disableClientSignatureAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-disableclientsignatureasync-member(1))|Disables the Outlook client signature.| -||[disableClientSignatureAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-disableclientsignatureasync-member(1))|Disables the Outlook client signature.| -||[getComposeTypeAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-getcomposetypeasync-member(1))|Specifies the type of message compose and its coercion type.| -||[getComposeTypeAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-getcomposetypeasync-member(1))|Specifies the type of message compose and its coercion type.| -||[isClientSignatureEnabledAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-isclientsignatureenabledasync-member(1))|Gets if the client signature is enabled.| -||[isClientSignatureEnabledAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-isclientsignatureenabledasync-member(1))|Gets if the client signature is enabled.| -|[NotificationMessageAction](/javascript/api/outlook/office.notificationmessageaction)|[actionText](/javascript/api/outlook/office.notificationmessageaction#outlook-office-notificationmessageaction-actiontext-member)|The text of the action link.| -||[actionType](/javascript/api/outlook/office.notificationmessageaction#outlook-office-notificationmessageaction-actiontype-member)|The type of action to be performed.| -||[commandId](/javascript/api/outlook/office.notificationmessageaction#outlook-office-notificationmessageaction-commandid-member)|The button defined in the manifest.| -||[contextData](/javascript/api/outlook/office.notificationmessageaction#outlook-office-notificationmessageaction-contextdata-member)|Any JSON data the action button needs to pass on to the add-in.| -|[NotificationMessageDetails](/javascript/api/outlook/office.notificationmessagedetails)|[actions](/javascript/api/outlook/office.notificationmessagedetails#outlook-office-notificationmessagedetails-actions-member)|Specifies actions for the message.| +|[AppointmentCompose](/.appointmentcompose)|[disableClientSignatureAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-disableclientsignatureasync-member(1))|Disables the Outlook client signature.| +||[disableClientSignatureAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-disableclientsignatureasync-member(1))|Disables the Outlook client signature.| +||[isClientSignatureEnabledAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-isclientsignatureenabledasync-member(1))|Gets if the client signature is enabled.| +||[isClientSignatureEnabledAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-isclientsignatureenabledasync-member(1))|Gets if the client signature is enabled.| +|[Body](/.body)|[setSignatureAsync(data: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.body#outlook-javascript/api/outlook/-body-setsignatureasync-member(1))|Adds a signature to the item body if it doesn't have an existing signature.| +||[setSignatureAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.body#outlook-javascript/api/outlook/-body-setsignatureasync-member(1))|Adds a signature to the item body if it doesn't have an existing signature.| +|[InfobarClickedEventArgs](/.infobarclickedeventargs)|[infobarDetails](/.infobarclickedeventargs#outlook-javascript/api/outlook/-infobarclickedeventargs-infobardetails-member)|Gets additional details about the notification message.| +||[type](/.infobarclickedeventargs#outlook-javascript/api/outlook/-infobarclickedeventargs-type-member)|Gets the type of the event.| +|[InfobarDetails](/.infobardetails)|[actionType](/.infobardetails#outlook-javascript/api/outlook/-infobardetails-actiontype-member)|The action type.| +||[infobarType](/.infobardetails#outlook-javascript/api/outlook/-infobardetails-infobartype-member)|The notification type.| +|[MailboxEvent](/.mailboxevent)|[completed()](/.mailboxevent#outlook-javascript/api/outlook/-mailboxevent-completed-member(1))|Indicates that the event-based or spam-reporting add-in has completed processing an event.| +|[MessageCompose](/.messagecompose)|[disableClientSignatureAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-disableclientsignatureasync-member(1))|Disables the Outlook client signature.| +||[disableClientSignatureAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-disableclientsignatureasync-member(1))|Disables the Outlook client signature.| +||[getComposeTypeAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-getcomposetypeasync-member(1))|Specifies the type of message compose and its coercion type.| +||[getComposeTypeAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-getcomposetypeasync-member(1))|Specifies the type of message compose and its coercion type.| +||[isClientSignatureEnabledAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-isclientsignatureenabledasync-member(1))|Gets if the client signature is enabled.| +||[isClientSignatureEnabledAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-isclientsignatureenabledasync-member(1))|Gets if the client signature is enabled.| +|[NotificationMessageAction](/.notificationmessageaction)|[actionText](/.notificationmessageaction#outlook-javascript/api/outlook/-notificationmessageaction-actiontext-member)|The text of the action link.| +||[actionType](/.notificationmessageaction#outlook-javascript/api/outlook/-notificationmessageaction-actiontype-member)|The type of action to be performed.| +||[commandId](/.notificationmessageaction#outlook-javascript/api/outlook/-notificationmessageaction-commandid-member)|The button defined in the manifest.| +||[contextData](/.notificationmessageaction#outlook-javascript/api/outlook/-notificationmessageaction-contextdata-member)|Any JSON data the action button needs to pass on to the add-in.| +|[NotificationMessageDetails](/.notificationmessagedetails)|[actions](/.notificationmessagedetails#outlook-javascript/api/outlook/-notificationmessagedetails-actions-member)|Specifies actions for the message.| diff --git a/docs/includes/outlook-1_11.md b/docs/includes/outlook-1_11.md index 921763367e..4d0067cde3 100644 --- a/docs/includes/outlook-1_11.md +++ b/docs/includes/outlook-1_11.md @@ -1,4 +1,12 @@ | Class | Fields | Description | |:---|:---|:---| -|[AppointmentCompose](/javascript/api/outlook/office.appointmentcompose)|[sessionData](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-sessiondata-member)|Manages the {@link Office.SessionData | SessionData} of an item in Compose mode.| -|[MessageCompose](/javascript/api/outlook/office.messagecompose)|[sessionData](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-sessiondata-member)|Manages the {@link Office.SessionData | SessionData} of an item in Compose mode.| +|[AppointmentCompose](/.appointmentcompose)|[sessionData](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-sessiondata-member)|Manages the {@link Office.SessionData | SessionData} of an item in Compose mode.| +|[MessageCompose](/.messagecompose)|[sessionData](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-sessiondata-member)|Manages the {@link Office.SessionData | SessionData} of an item in Compose mode.| +|[SessionData](/.sessiondata)|[clearAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/.sessiondata#outlook-javascript/api/outlook/-sessiondata-clearasync-member(1))|Clears all session data key-value pairs.| +||[clearAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.sessiondata#outlook-javascript/api/outlook/-sessiondata-clearasync-member(1))|Clears all session data key-value pairs.| +||[getAllAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.sessiondata#outlook-javascript/api/outlook/-sessiondata-getallasync-member(1))|Gets all session data key-value pairs.| +||[getAsync(name: string, callback: (asyncResult: Office.AsyncResult) => void)](/.sessiondata#outlook-javascript/api/outlook/-sessiondata-getasync-member(1))|Gets the session data value of the specified key.| +||[removeAsync(name: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.sessiondata#outlook-javascript/api/outlook/-sessiondata-removeasync-member(1))|Removes a session data key-value pair.| +||[removeAsync(name: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.sessiondata#outlook-javascript/api/outlook/-sessiondata-removeasync-member(1))|Removes a session data key-value pair.| +||[setAsync(name: string, value: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.sessiondata#outlook-javascript/api/outlook/-sessiondata-setasync-member(1))|Sets a session data key-value pair.| +||[setAsync(name: string, value: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.sessiondata#outlook-javascript/api/outlook/-sessiondata-setasync-member(1))|Sets a session data key-value pair.| diff --git a/docs/includes/outlook-1_12.md b/docs/includes/outlook-1_12.md index 4cd63cc5a2..851c987e27 100644 --- a/docs/includes/outlook-1_12.md +++ b/docs/includes/outlook-1_12.md @@ -1,5 +1,5 @@ | Class | Fields | Description | |:---|:---|:---| -|[MailboxEvent](/javascript/api/outlook/office.mailboxevent)|[completed(options?: SmartAlertsEventCompletedOptions)](/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1))|Indicates that the event-based or spam-reporting add-in has completed processing an event.| -|[SmartAlertsEventCompletedOptions](/javascript/api/outlook/office.smartalertseventcompletedoptions)|[allowEvent](/javascript/api/outlook/office.smartalertseventcompletedoptions#outlook-office-smartalertseventcompletedoptions-allowevent-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal completion of an event handler,| -||[errorMessage](/javascript/api/outlook/office.smartalertseventcompletedoptions#outlook-office-smartalertseventcompletedoptions-errormessage-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal completion of an event handler and set its `allowEvent` property| +|[MailboxEvent](/.mailboxevent)|[completed(options?: SmartAlertsEventCompletedOptions)](/.mailboxevent#outlook-javascript/api/outlook/-mailboxevent-completed-member(1))|Indicates that the event-based or spam-reporting add-in has completed processing an event.| +|[SmartAlertsEventCompletedOptions](/.smartalertseventcompletedoptions)|[allowEvent](/.smartalertseventcompletedoptions#outlook-javascript/api/outlook/-smartalertseventcompletedoptions-allowevent-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal completion of an event handler,| +||[errorMessage](/.smartalertseventcompletedoptions#outlook-javascript/api/outlook/-smartalertseventcompletedoptions-errormessage-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal completion of an event handler and set its `allowEvent` property| diff --git a/docs/includes/outlook-1_13.md b/docs/includes/outlook-1_13.md index 73151965de..3edf1ec1fd 100644 --- a/docs/includes/outlook-1_13.md +++ b/docs/includes/outlook-1_13.md @@ -1,31 +1,31 @@ | Class | Fields | Description | |:---|:---|:---| -|[AppointmentCompose](/javascript/api/outlook/office.appointmentcompose)|[sensitivityLabel](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-sensitivitylabel-member)|Gets the object to get or set the {@link Office.SensitivityLabel | sensitivity label} of an appointment.| -|[Body](/javascript/api/outlook/office.body)|[prependOnSendAsync(data: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.body#outlook-office-body-prependonsendasync-member(1))|Prepends HTML or plain text to the beginning of a message or appointment body when the mail item is sent.| -||[prependOnSendAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.body#outlook-office-body-prependonsendasync-member(1))|Prepends HTML or plain text to the beginning of a message or appointment body when the mail item is sent.| -|[DelayDeliveryTime](/javascript/api/outlook/office.delaydeliverytime)|[getAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.delaydeliverytime#outlook-office-delaydeliverytime-getasync-member(1))|Gets the delivery date and time of a message.| -||[getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.delaydeliverytime#outlook-office-delaydeliverytime-getasync-member(1))|Gets the delivery date and time of a message.| -||[setAsync(datetime: Date, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.delaydeliverytime#outlook-office-delaydeliverytime-setasync-member(1))|Sets the delivery date and time of a message.| -||[setAsync(datetime: Date, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.delaydeliverytime#outlook-office-delaydeliverytime-setasync-member(1))|Sets the delivery date and time of a message.| -|[Mailbox](/javascript/api/outlook/office.mailbox)|[getSelectedItemsAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-getselecteditemsasync-member(1))|Gets currently selected messages on which an add-in can activate and perform operations.| -||[getSelectedItemsAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-getselecteditemsasync-member(1))|Gets currently selected messages on which an add-in can activate and perform operations.| -|[MessageCompose](/javascript/api/outlook/office.messagecompose)|[delayDeliveryTime](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-delaydeliverytime-member)|Gets or sets the delayed delivery date and time of a message.| -||[sensitivityLabel](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-sensitivitylabel-member)|Gets the object to get or set the {@link Office.SensitivityLabel | sensitivity label} of a message.| -|[SelectedItemDetails](/javascript/api/outlook/office.selecteditemdetails)|[itemId](/javascript/api/outlook/office.selecteditemdetails#outlook-office-selecteditemdetails-itemid-member)|The Exchange Web Services (EWS) item identifier of the message that's currently selected.| -||[itemMode](/javascript/api/outlook/office.selecteditemdetails#outlook-office-selecteditemdetails-itemmode-member)|The Outlook mode (`Read` or `Compose`) of the message that's currently selected.| -||[itemType](/javascript/api/outlook/office.selecteditemdetails#outlook-office-selecteditemdetails-itemtype-member)|The type of the item that's currently selected.| -||[subject](/javascript/api/outlook/office.selecteditemdetails#outlook-office-selecteditemdetails-subject-member)|The description that appears in the subject field of the message that's currently selected.| -|[SensitivityLabel](/javascript/api/outlook/office.sensitivitylabel)|[getAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.sensitivitylabel#outlook-office-sensitivitylabel-getasync-member(1))|Gets the unique identifier (GUID) of the sensitivity label applied to a message or appointment being composed.| -||[getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.sensitivitylabel#outlook-office-sensitivitylabel-getasync-member(1))|Gets the unique identifier (GUID) of the sensitivity label applied to a message or appointment being composed.| -||[setAsync(sensitivityLabel: string \| SensitivityLabelDetails, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.sensitivitylabel#outlook-office-sensitivitylabel-setasync-member(1))|Applies the specified sensitivity label to the message or appointment being composed.| -||[setAsync(sensitivityLabel: string \| SensitivityLabelDetails, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.sensitivitylabel#outlook-office-sensitivitylabel-setasync-member(1))|Applies the specified sensitivity label to the message or appointment being composed.| -|[SensitivityLabelChangedEventArgs](/javascript/api/outlook/office.sensitivitylabelchangedeventargs)|[type](/javascript/api/outlook/office.sensitivitylabelchangedeventargs#outlook-office-sensitivitylabelchangedeventargs-type-member)|The type of event that was raised.| -|[SensitivityLabelDetails](/javascript/api/outlook/office.sensitivitylabeldetails)|[children](/javascript/api/outlook/office.sensitivitylabeldetails#outlook-office-sensitivitylabeldetails-children-member)|The {@link https://learn.microsoft.com/microsoft-365/compliance/sensitivity-labels#sublabels-grouping-labels | sublabels} of the sensitivity label.| -||[color](/javascript/api/outlook/office.sensitivitylabeldetails#outlook-office-sensitivitylabeldetails-color-member)|The color of the sensitivity label.| -||[id](/javascript/api/outlook/office.sensitivitylabeldetails#outlook-office-sensitivitylabeldetails-id-member)|The unique identifier (GUID) of the sensitivity label.| -||[name](/javascript/api/outlook/office.sensitivitylabeldetails#outlook-office-sensitivitylabeldetails-name-member)|The name of the sensitivity label.| -||[tooltip](/javascript/api/outlook/office.sensitivitylabeldetails#outlook-office-sensitivitylabeldetails-tooltip-member)|The description of the sensitivity label.| -|[SensitivityLabelsCatalog](/javascript/api/outlook/office.sensitivitylabelscatalog)|[getAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.sensitivitylabelscatalog#outlook-office-sensitivitylabelscatalog-getasync-member(1))|Gets all the sensitivity labels that are enabled in Outlook.| -||[getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.sensitivitylabelscatalog#outlook-office-sensitivitylabelscatalog-getasync-member(1))|Gets all the sensitivity labels that are enabled in Outlook.| -||[getIsEnabledAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.sensitivitylabelscatalog#outlook-office-sensitivitylabelscatalog-getisenabledasync-member(1))|Checks whether the catalog of sensitivity labels is enabled in Outlook.| -||[getIsEnabledAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.sensitivitylabelscatalog#outlook-office-sensitivitylabelscatalog-getisenabledasync-member(1))|Checks whether the catalog of sensitivity labels is enabled in Outlook.| +|[AppointmentCompose](/.appointmentcompose)|[sensitivityLabel](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-sensitivitylabel-member)|Gets the object to get or set the {@link Office.SensitivityLabel | sensitivity label} of an appointment.| +|[Body](/.body)|[prependOnSendAsync(data: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.body#outlook-javascript/api/outlook/-body-prependonsendasync-member(1))|Prepends HTML or plain text to the beginning of a message or appointment body when the mail item is sent.| +||[prependOnSendAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.body#outlook-javascript/api/outlook/-body-prependonsendasync-member(1))|Prepends HTML or plain text to the beginning of a message or appointment body when the mail item is sent.| +|[DelayDeliveryTime](/.delaydeliverytime)|[getAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/.delaydeliverytime#outlook-javascript/api/outlook/-delaydeliverytime-getasync-member(1))|Gets the delivery date and time of a message.| +||[getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.delaydeliverytime#outlook-javascript/api/outlook/-delaydeliverytime-getasync-member(1))|Gets the delivery date and time of a message.| +||[setAsync(datetime: Date, callback?: (asyncResult: Office.AsyncResult) => void)](/.delaydeliverytime#outlook-javascript/api/outlook/-delaydeliverytime-setasync-member(1))|Sets the delivery date and time of a message.| +||[setAsync(datetime: Date, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.delaydeliverytime#outlook-javascript/api/outlook/-delaydeliverytime-setasync-member(1))|Sets the delivery date and time of a message.| +|[Mailbox](/.mailbox)|[getSelectedItemsAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.mailbox#outlook-javascript/api/outlook/-mailbox-getselecteditemsasync-member(1))|Gets currently selected messages on which an add-in can activate and perform operations.| +||[getSelectedItemsAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.mailbox#outlook-javascript/api/outlook/-mailbox-getselecteditemsasync-member(1))|Gets currently selected messages on which an add-in can activate and perform operations.| +|[MessageCompose](/.messagecompose)|[delayDeliveryTime](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-delaydeliverytime-member)|Gets or sets the delayed delivery date and time of a message.| +||[sensitivityLabel](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-sensitivitylabel-member)|Gets the object to get or set the {@link Office.SensitivityLabel | sensitivity label} of a message.| +|[SelectedItemDetails](/.selecteditemdetails)|[itemId](/.selecteditemdetails#outlook-javascript/api/outlook/-selecteditemdetails-itemid-member)|The Exchange Web Services (EWS) item identifier of the message that's currently selected.| +||[itemMode](/.selecteditemdetails#outlook-javascript/api/outlook/-selecteditemdetails-itemmode-member)|The Outlook mode (`Read` or `Compose`) of the message that's currently selected.| +||[itemType](/.selecteditemdetails#outlook-javascript/api/outlook/-selecteditemdetails-itemtype-member)|The type of the item that's currently selected.| +||[subject](/.selecteditemdetails#outlook-javascript/api/outlook/-selecteditemdetails-subject-member)|The description that appears in the subject field of the message that's currently selected.| +|[SensitivityLabel](/.sensitivitylabel)|[getAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.sensitivitylabel#outlook-javascript/api/outlook/-sensitivitylabel-getasync-member(1))|Gets the unique identifier (GUID) of the sensitivity label applied to a message or appointment being composed.| +||[getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.sensitivitylabel#outlook-javascript/api/outlook/-sensitivitylabel-getasync-member(1))|Gets the unique identifier (GUID) of the sensitivity label applied to a message or appointment being composed.| +||[setAsync(sensitivityLabel: string \| SensitivityLabelDetails, callback?: (asyncResult: Office.AsyncResult) => void)](/.sensitivitylabel#outlook-javascript/api/outlook/-sensitivitylabel-setasync-member(1))|Applies the specified sensitivity label to the message or appointment being composed.| +||[setAsync(sensitivityLabel: string \| SensitivityLabelDetails, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.sensitivitylabel#outlook-javascript/api/outlook/-sensitivitylabel-setasync-member(1))|Applies the specified sensitivity label to the message or appointment being composed.| +|[SensitivityLabelChangedEventArgs](/.sensitivitylabelchangedeventargs)|[type](/.sensitivitylabelchangedeventargs#outlook-javascript/api/outlook/-sensitivitylabelchangedeventargs-type-member)|The type of event that was raised.| +|[SensitivityLabelDetails](/.sensitivitylabeldetails)|[children](/.sensitivitylabeldetails#outlook-javascript/api/outlook/-sensitivitylabeldetails-children-member)|The {@link https://learn.microsoft.com/microsoft-365/compliance/sensitivity-labels#sublabels-grouping-labels | sublabels} of the sensitivity label.| +||[color](/.sensitivitylabeldetails#outlook-javascript/api/outlook/-sensitivitylabeldetails-color-member)|The color of the sensitivity label.| +||[id](/.sensitivitylabeldetails#outlook-javascript/api/outlook/-sensitivitylabeldetails-id-member)|The unique identifier (GUID) of the sensitivity label.| +||[name](/.sensitivitylabeldetails#outlook-javascript/api/outlook/-sensitivitylabeldetails-name-member)|The name of the sensitivity label.| +||[tooltip](/.sensitivitylabeldetails#outlook-javascript/api/outlook/-sensitivitylabeldetails-tooltip-member)|The description of the sensitivity label.| +|[SensitivityLabelsCatalog](/.sensitivitylabelscatalog)|[getAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.sensitivitylabelscatalog#outlook-javascript/api/outlook/-sensitivitylabelscatalog-getasync-member(1))|Gets all the sensitivity labels that are enabled in Outlook.| +||[getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.sensitivitylabelscatalog#outlook-javascript/api/outlook/-sensitivitylabelscatalog-getasync-member(1))|Gets all the sensitivity labels that are enabled in Outlook.| +||[getIsEnabledAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.sensitivitylabelscatalog#outlook-javascript/api/outlook/-sensitivitylabelscatalog-getisenabledasync-member(1))|Checks whether the catalog of sensitivity labels is enabled in Outlook.| +||[getIsEnabledAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.sensitivitylabelscatalog#outlook-javascript/api/outlook/-sensitivitylabelscatalog-getisenabledasync-member(1))|Checks whether the catalog of sensitivity labels is enabled in Outlook.| diff --git a/docs/includes/outlook-1_14.md b/docs/includes/outlook-1_14.md index af03710175..1ba19ed9fa 100644 --- a/docs/includes/outlook-1_14.md +++ b/docs/includes/outlook-1_14.md @@ -1,35 +1,35 @@ | Class | Fields | Description | |:---|:---|:---| -|[AppointmentCompose](/javascript/api/outlook/office.appointmentcompose)|[sensitivity](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-sensitivity-member)|Gets or sets the {@link Office.Sensitivity | sensitivity level} of an appointment.| -|[AppointmentRead](/javascript/api/outlook/office.appointmentread)|[sensitivity](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-sensitivity-member)|Provides the sensitivity value of the appointment.| -|[MailboxEvent](/javascript/api/outlook/office.mailboxevent)|[completed(options?: SmartAlertsEventCompletedOptions \| SpamReportingEventCompletedOptions)](/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1))|Indicates that the event-based or spam-reporting add-in has completed processing an event.| -|[MessageCompose](/javascript/api/outlook/office.messagecompose)|[closeAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-closeasync-member(1))|Closes the current new message being composed.| -||[closeAsync(options: Office.AsyncContextOptions & { discardItem: boolean }, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-closeasync-member(1))|Closes the current message being composed with the option to discard unsaved changes.| -||[getConversationIndexAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-getconversationindexasync-member(1))|Gets the Base64-encoded position of the current message in a conversation thread.| -||[getConversationIndexAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-getconversationindexasync-member(1))|Gets the Base64-encoded position of the current message in a conversation thread.| -||[getItemClassAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-getitemclassasync-member(1))|Gets the Exchange Web Services item class of the selected message.| -||[getItemClassAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-getitemclassasync-member(1))|Gets the Exchange Web Services item class of the selected message.| -||[inReplyTo](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-inreplyto-member)|Gets the internet message ID of the original message being replied to by the current message.| -|[MessageRead](/javascript/api/outlook/office.messageread)|[getAsFileAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messageread#outlook-office-messageread-getasfileasync-member(1))|Gets the current message in EML format encoded in Base64.| -||[getAsFileAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messageread#outlook-office-messageread-getasfileasync-member(1))|Gets the current message in EML format encoded in Base64.| -|[OfficeThemeChangedEventArgs](/javascript/api/outlook/office.officethemechangedeventargs)|[officeTheme](/javascript/api/outlook/office.officethemechangedeventargs#outlook-office-officethemechangedeventargs-officetheme-member)|Gets the updated Office theme.| -||[type](/javascript/api/outlook/office.officethemechangedeventargs#outlook-office-officethemechangedeventargs-type-member)|Gets the type of the event.| -|[SelectedItemDetails](/javascript/api/outlook/office.selecteditemdetails)|[conversationId](/javascript/api/outlook/office.selecteditemdetails#outlook-office-selecteditemdetails-conversationid-member)|The identifier of the message conversation that contains the message that's currently selected.| -||[hasAttachment](/javascript/api/outlook/office.selecteditemdetails#outlook-office-selecteditemdetails-hasattachment-member)|Returns `true` if the message that's currently selected contains an attachment.| -||[internetMessageId](/javascript/api/outlook/office.selecteditemdetails#outlook-office-selecteditemdetails-internetmessageid-member)|The internet message identifier of the message that's currently selected.| -|[Sensitivity](/javascript/api/outlook/office.sensitivity)|[getAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.sensitivity#outlook-office-sensitivity-getasync-member(1))|Gets the sensitivity level of an appointment.| -||[getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.sensitivity#outlook-office-sensitivity-getasync-member(1))|Gets the sensitivity level of an appointment.| -||[setAsync(sensitivity: MailboxEnums.AppointmentSensitivityType \| string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.sensitivity#outlook-office-sensitivity-setasync-member(1))|Sets the sensitivity level of an appointment.| -||[setAsync(sensitivity: MailboxEnums.AppointmentSensitivityType \| string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.sensitivity#outlook-office-sensitivity-setasync-member(1))|Sets the sensitivity level of an appointment.| -|[SmartAlertsEventCompletedOptions](/javascript/api/outlook/office.smartalertseventcompletedoptions)|[cancelLabel](/javascript/api/outlook/office.smartalertseventcompletedoptions#outlook-office-smartalertseventcompletedoptions-cancellabel-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal completion of an event handler and set its `allowEvent` property to `false`,| -||[commandId](/javascript/api/outlook/office.smartalertseventcompletedoptions#outlook-office-smartalertseventcompletedoptions-commandid-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal completion of an event handler and set its `allowEvent` property to `false`,| -||[contextData](/javascript/api/outlook/office.smartalertseventcompletedoptions#outlook-office-smartalertseventcompletedoptions-contextdata-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to| -||[sendModeOverride](/javascript/api/outlook/office.smartalertseventcompletedoptions#outlook-office-smartalertseventcompletedoptions-sendmodeoverride-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal completion of an event handler| -|[SpamReportingEventArgs](/javascript/api/outlook/office.spamreportingeventargs)|[freeText](/javascript/api/outlook/office.spamreportingeventargs#outlook-office-spamreportingeventargs-freetext-member)|The text provided by the user in the preprocessing dialog of a spam-reporting add-in.| -||[options](/javascript/api/outlook/office.spamreportingeventargs#outlook-office-spamreportingeventargs-options-member)|Returns `true` for each reporting option selected by the user in the preprocessing dialog of a spam-reporting add-in.| -||[type](/javascript/api/outlook/office.spamreportingeventargs#outlook-office-spamreportingeventargs-type-member)|The type of event that was raised.| -|[SpamReportingEventCompletedOptions](/javascript/api/outlook/office.spamreportingeventcompletedoptions)|[folderName](/javascript/api/outlook/office.spamreportingeventcompletedoptions#outlook-office-spamreportingeventcompletedoptions-foldername-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal that a reported message has finished processing,| -||[moveItemTo](/javascript/api/outlook/office.spamreportingeventcompletedoptions#outlook-office-spamreportingeventcompletedoptions-moveitemto-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal that a reported message has finished processing,| -||[onErrorDeleteItem](/javascript/api/outlook/office.spamreportingeventcompletedoptions#outlook-office-spamreportingeventcompletedoptions-onerrordeleteitem-member)|When set to `true`, deletes a reported message if an error occurs while the message is processed.| -||[postProcessingAction](/javascript/api/outlook/office.spamreportingeventcompletedoptions#outlook-office-spamreportingeventcompletedoptions-postprocessingaction-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal that a reported message has finished processing,| -||[showPostProcessingDialog](/javascript/api/outlook/office.spamreportingeventcompletedoptions#outlook-office-spamreportingeventcompletedoptions-showpostprocessingdialog-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal that a reported message has finished processing,| +|[AppointmentCompose](/.appointmentcompose)|[sensitivity](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-sensitivity-member)|Gets or sets the {@link Office.Sensitivity | sensitivity level} of an appointment.| +|[AppointmentRead](/.appointmentread)|[sensitivity](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-sensitivity-member)|Provides the sensitivity value of the appointment.| +|[MailboxEvent](/.mailboxevent)|[completed(options?: SmartAlertsEventCompletedOptions \| SpamReportingEventCompletedOptions)](/.mailboxevent#outlook-javascript/api/outlook/-mailboxevent-completed-member(1))|Indicates that the event-based or spam-reporting add-in has completed processing an event.| +|[MessageCompose](/.messagecompose)|[closeAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-closeasync-member(1))|Closes the current new message being composed.| +||[closeAsync(options: Office.AsyncContextOptions & { discardItem: boolean }, callback?: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-closeasync-member(1))|Closes the current message being composed with the option to discard unsaved changes.| +||[getConversationIndexAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-getconversationindexasync-member(1))|Gets the Base64-encoded position of the current message in a conversation thread.| +||[getConversationIndexAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-getconversationindexasync-member(1))|Gets the Base64-encoded position of the current message in a conversation thread.| +||[getItemClassAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-getitemclassasync-member(1))|Gets the Exchange Web Services item class of the selected message.| +||[getItemClassAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-getitemclassasync-member(1))|Gets the Exchange Web Services item class of the selected message.| +||[inReplyTo](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-inreplyto-member)|Gets the internet message ID of the original message being replied to by the current message.| +|[MessageRead](/.messageread)|[getAsFileAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.messageread#outlook-javascript/api/outlook/-messageread-getasfileasync-member(1))|Gets the current message in EML format encoded in Base64.| +||[getAsFileAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.messageread#outlook-javascript/api/outlook/-messageread-getasfileasync-member(1))|Gets the current message in EML format encoded in Base64.| +|[OfficeThemeChangedEventArgs](/.officethemechangedeventargs)|[officeTheme](/.officethemechangedeventargs#outlook-javascript/api/outlook/-officethemechangedeventargs-officetheme-member)|Gets the updated Office theme.| +||[type](/.officethemechangedeventargs#outlook-javascript/api/outlook/-officethemechangedeventargs-type-member)|Gets the type of the event.| +|[SelectedItemDetails](/.selecteditemdetails)|[conversationId](/.selecteditemdetails#outlook-javascript/api/outlook/-selecteditemdetails-conversationid-member)|The identifier of the message conversation that contains the message that's currently selected.| +||[hasAttachment](/.selecteditemdetails#outlook-javascript/api/outlook/-selecteditemdetails-hasattachment-member)|Returns `true` if the message that's currently selected contains an attachment.| +||[internetMessageId](/.selecteditemdetails#outlook-javascript/api/outlook/-selecteditemdetails-internetmessageid-member)|The internet message identifier of the message that's currently selected.| +|[Sensitivity](/.sensitivity)|[getAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.sensitivity#outlook-javascript/api/outlook/-sensitivity-getasync-member(1))|Gets the sensitivity level of an appointment.| +||[getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.sensitivity#outlook-javascript/api/outlook/-sensitivity-getasync-member(1))|Gets the sensitivity level of an appointment.| +||[setAsync(sensitivity: MailboxEnums.AppointmentSensitivityType \| string, callback?: (asyncResult: Office.AsyncResult) => void)](/.sensitivity#outlook-javascript/api/outlook/-sensitivity-setasync-member(1))|Sets the sensitivity level of an appointment.| +||[setAsync(sensitivity: MailboxEnums.AppointmentSensitivityType \| string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.sensitivity#outlook-javascript/api/outlook/-sensitivity-setasync-member(1))|Sets the sensitivity level of an appointment.| +|[SmartAlertsEventCompletedOptions](/.smartalertseventcompletedoptions)|[cancelLabel](/.smartalertseventcompletedoptions#outlook-javascript/api/outlook/-smartalertseventcompletedoptions-cancellabel-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal completion of an event handler and set its `allowEvent` property to `false`,| +||[commandId](/.smartalertseventcompletedoptions#outlook-javascript/api/outlook/-smartalertseventcompletedoptions-commandid-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal completion of an event handler and set its `allowEvent` property to `false`,| +||[contextData](/.smartalertseventcompletedoptions#outlook-javascript/api/outlook/-smartalertseventcompletedoptions-contextdata-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to| +||[sendModeOverride](/.smartalertseventcompletedoptions#outlook-javascript/api/outlook/-smartalertseventcompletedoptions-sendmodeoverride-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal completion of an event handler| +|[SpamReportingEventArgs](/.spamreportingeventargs)|[freeText](/.spamreportingeventargs#outlook-javascript/api/outlook/-spamreportingeventargs-freetext-member)|The text provided by the user in the preprocessing dialog of a spam-reporting add-in.| +||[options](/.spamreportingeventargs#outlook-javascript/api/outlook/-spamreportingeventargs-options-member)|Returns `true` for each reporting option selected by the user in the preprocessing dialog of a spam-reporting add-in.| +||[type](/.spamreportingeventargs#outlook-javascript/api/outlook/-spamreportingeventargs-type-member)|The type of event that was raised.| +|[SpamReportingEventCompletedOptions](/.spamreportingeventcompletedoptions)|[folderName](/.spamreportingeventcompletedoptions#outlook-javascript/api/outlook/-spamreportingeventcompletedoptions-foldername-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal that a reported message has finished processing,| +||[moveItemTo](/.spamreportingeventcompletedoptions#outlook-javascript/api/outlook/-spamreportingeventcompletedoptions-moveitemto-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal that a reported message has finished processing,| +||[onErrorDeleteItem](/.spamreportingeventcompletedoptions#outlook-javascript/api/outlook/-spamreportingeventcompletedoptions-onerrordeleteitem-member)|When set to `true`, deletes a reported message if an error occurs while the message is processed.| +||[postProcessingAction](/.spamreportingeventcompletedoptions#outlook-javascript/api/outlook/-spamreportingeventcompletedoptions-postprocessingaction-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal that a reported message has finished processing,| +||[showPostProcessingDialog](/.spamreportingeventcompletedoptions#outlook-javascript/api/outlook/-spamreportingeventcompletedoptions-showpostprocessingdialog-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal that a reported message has finished processing,| diff --git a/docs/includes/outlook-1_15.md b/docs/includes/outlook-1_15.md index 672de5e92c..80ed95ba41 100644 --- a/docs/includes/outlook-1_15.md +++ b/docs/includes/outlook-1_15.md @@ -1,94 +1,94 @@ | Class | Fields | Description | |:---|:---|:---| -|[AppointmentCompose](/javascript/api/outlook/office.appointmentcompose)|[sendAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-sendasync-member(1))|Sends the appointment being composed.| -||[sendAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-sendasync-member(1))|Sends the appointment being composed.| -|[InitializationContextChangedEventArgs](/javascript/api/outlook/office.initializationcontextchangedeventargs)|[initializationContextData](/javascript/api/outlook/office.initializationcontextchangedeventargs#outlook-office-initializationcontextchangedeventargs-initializationcontextdata-member)|Represents the data to be passed to an add-in's task pane from an actionable message, notification message, Smart Alerts dialog, or integrated| -||[type](/javascript/api/outlook/office.initializationcontextchangedeventargs#outlook-office-initializationcontextchangedeventargs-type-member)|Represents the type of the event.| -|[LoadedMessageCompose](/javascript/api/outlook/office.loadedmessagecompose)|[bcc](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-bcc-member)|Gets the recipients on the **Bcc** (blind carbon copy) line of a message.| -||[body](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-body-member)|Gets the item's body and format.| -||[categories](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-categories-member)|Gets an object that provides methods to manage the item's categories.| -||[cc](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-cc-member)|Gets recipients on the **Cc** (carbon copy) line of a message.| -||[conversationId](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-conversationid-member)|Gets an identifier for the email conversation that contains a particular message.| -||[delayDeliveryTime](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-delaydeliverytime-member)|Gets the delayed delivery date and time of a message.| -||[from](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-from-member)|Gets the email address of the sender of a message.| -||[getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-getattachmentcontentasync-member(1))|Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.| -||[getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-getattachmentcontentasync-member(1))|Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.| -||[getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-getattachmentsasync-member(1))|Gets the item's attachments as an array.| -||[getAttachmentsAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-getattachmentsasync-member(1))|Gets the item's attachments as an array.| -||[getComposeTypeAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-getcomposetypeasync-member(1))|Specifies the type of message compose and its coercion type.| -||[getComposeTypeAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-getcomposetypeasync-member(1))|Specifies the type of message compose and its coercion type.| -||[getConversationIndexAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-getconversationindexasync-member(1))|Gets the Base64-encoded position of the current message in a conversation thread.| -||[getConversationIndexAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-getconversationindexasync-member(1))|Gets the Base64-encoded position of the current message in a conversation thread.| -||[getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-getinitializationcontextasync-member(1))|Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.| -||[getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-getinitializationcontextasync-member(1))|Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.| -||[getItemClassAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-getitemclassasync-member(1))|Gets the Exchange Web Services item class of the selected message.| -||[getItemClassAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-getitemclassasync-member(1))|Gets the Exchange Web Services item class of the selected message.| -||[getItemIdAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-getitemidasync-member(1))|Asynchronously gets the ID of a saved item.| -||[getItemIdAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-getitemidasync-member(1))|Asynchronously gets the {@link https://learn.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | Exchange Web Services (EWS) item identifier}| -||[getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-getsharedpropertiesasync-member(1))|Gets the properties of an appointment or message in a shared folder or shared mailbox.| -||[getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-getsharedpropertiesasync-member(1))|Gets the properties of an appointment or message in a shared folder or shared mailbox.| -||[inReplyTo](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-inreplyto-member)|Gets the message ID of the original message being replied to by the current message.| -||[internetHeaders](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-internetheaders-member)|Gets the custom internet headers of a message.| -||[isClientSignatureEnabledAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-isclientsignatureenabledasync-member(1))|Gets if the client signature is enabled.| -||[isClientSignatureEnabledAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-isclientsignatureenabledasync-member(1))|Gets if the client signature is enabled.| -||[itemType](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-itemtype-member)|Gets the type of item that an instance represents.| -||[loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void, userContext?: any)](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-loadcustompropertiesasync-member(1))|Asynchronously loads custom properties for this add-in on the selected item.| -||[notificationMessages](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-notificationmessages-member)|Gets the notification messages of the item.| -||[saveAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-saveasync-member(1))|Asynchronously saves the current message as a draft.| -||[saveAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-saveasync-member(1))|Asynchronously saves the current message as a draft.| -||[sensitivityLabel](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-sensitivitylabel-member)|Gets the sensitivity label of a message.| -||[seriesId](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-seriesid-member)|Gets the ID of the series that an instance belongs to.| -||[subject](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-subject-member)|Gets the description that appears in the subject field of an item.| -||[to](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-to-member)|Gets the recipients on the **To** line of a message.| -||[unloadAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-unloadasync-member(1))|When multiple mail items are selected, closes the currently loaded item, so that another selected mail item can be loaded for processing.| -||[unloadAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-unloadasync-member(1))|When multiple mail items are selected, closes the currently loaded item, so that another selected mail item can be loaded for processing.| -|[LoadedMessageRead](/javascript/api/outlook/office.loadedmessageread)|[attachments](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-attachments-member)|Gets the item's attachments as an array.| -||[body](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-body-member)|Gets the item's body and its format.| -||[categories](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-categories-member)|Gets an object that provides methods to manage the item's categories.| -||[cc](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-cc-member)|Gets recipients on the **Cc** (carbon copy) line of a message.| -||[conversationId](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-conversationid-member)|Gets an identifier for the email conversation that contains a particular message.| -||[dateTimeCreated](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-datetimecreated-member)|Gets the date and time that an item was created.| -||[dateTimeModified](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-datetimemodified-member)|Gets the date and time that an item was last modified.| -||[displayReplyAllFormAsync(formData: string \| ReplyFormData, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-displayreplyallformasync-member(1))|Displays a reply form that includes either the sender and all recipients of the selected message or the organizer and all attendees of the| -||[displayReplyAllFormAsync(formData: string \| ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-displayreplyallformasync-member(1))|Displays a reply form that includes either the sender and all recipients of the selected message or the organizer and all attendees of the| -||[displayReplyFormAsync(formData: string \| ReplyFormData, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-displayreplyformasync-member(1))|Displays a reply form that includes only the sender of the selected message or the organizer of the selected appointment.| -||[displayReplyFormAsync(formData: string \| ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-displayreplyformasync-member(1))|Displays a reply form that includes only the sender of the selected message or the organizer of the selected appointment.| -||[end](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-end-member)|Gets the date and time that the appointment is to end.| -||[from](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-from-member)|Gets the email address of the sender of a message.| -||[getAllInternetHeadersAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-getallinternetheadersasync-member(1))|Gets all the internet headers for the message as a string.| -||[getAllInternetHeadersAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-getallinternetheadersasync-member(1))|Gets all the internet headers for the message as a string.| -||[getAsFileAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-getasfileasync-member(1))|Gets the current message in EML format encoded in Base64.| -||[getAsFileAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-getasfileasync-member(1))|Gets the current message in EML format encoded in Base64.| -||[getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-getattachmentcontentasync-member(1))|Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.| -||[getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-getattachmentcontentasync-member(1))|Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.| -||[getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-getinitializationcontextasync-member(1))|Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.| -||[getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-getinitializationcontextasync-member(1))|Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.| -||[getRegExMatches()](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-getregexmatches-member(1))|Returns string values in the selected item that match the regular expressions defined in an XML manifest file.| -||[getRegExMatchesByName(name: string)](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-getregexmatchesbyname-member(1))|Returns string values in the selected item that match the named regular expression defined in an XML manifest file.| -||[getSelectedRegExMatches()](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-getselectedregexmatches-member(1))|Returns string values in a highlighted match that match the regular expressions defined in an XML manifest file.| -||[getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-getsharedpropertiesasync-member(1))|Gets the properties of an appointment or message in a shared folder or shared mailbox.| -||[getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-getsharedpropertiesasync-member(1))|Gets the properties of an appointment or message in a shared folder or shared mailbox.| -||[internetMessageId](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-internetmessageid-member)|Gets the internet message identifier of a message.| -||[itemClass](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-itemclass-member)|Gets the Exchange Web Services item class of the selected message.| -||[itemId](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-itemid-member)|Gets the {@link https://learn.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | Exchange Web Services item identifier}| -||[itemType](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-itemtype-member)|Gets the type of item that an instance represents.| -||[loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void, userContext?: any)](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-loadcustompropertiesasync-member(1))|Asynchronously loads custom properties for this add-in on the selected item.| -||[location](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-location-member)|Gets the location of a meeting request.| -||[normalizedSubject](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-normalizedsubject-member)|Gets the subject of an item, with all prefixes removed (including RE: and FWD:).| -||[notificationMessages](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-notificationmessages-member)|Gets the notification messages of the item.| -||[recurrence](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-recurrence-member)|Gets the recurrence pattern of an appointment.| -||[sender](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-sender-member)|Gets the email address of the sender of an email message.| -||[seriesId](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-seriesid-member)|Gets the ID of the series that an instance belongs to.| -||[start](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-start-member)|Gets the date and time that the appointment is to begin.| -||[subject](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-subject-member)|Gets the description that appears in the subject field of an item.| -||[to](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-to-member)|Gets the recipients on the **To** line of a message.| -||[unloadAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-unloadasync-member(1))|When multiple mail items are selected, closes the currently loaded item, so that another selected mail item can be loaded for processing.| -||[unloadAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-unloadasync-member(1))|When multiple mail items are selected, closes the currently loaded item, so that another selected mail item can be loaded for processing.| -|[Mailbox](/javascript/api/outlook/office.mailbox)|[loadItemByIdAsync(itemId: string, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-loaditembyidasync-member(1))|Loads a single mail item by its Exchange Web Services (EWS) ID.| -||[loadItemByIdAsync(itemId: string, options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-loaditembyidasync-member(1))|Loads a single mail item by its Exchange Web Services (EWS) ID.| -|[MessageCompose](/javascript/api/outlook/office.messagecompose)|[sendAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-sendasync-member(1))|Sends the message being composed.| -||[sendAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-sendasync-member(1))|Sends the message being composed.| -|[ReplyFormAttachment](/javascript/api/outlook/office.replyformattachment)|[base64file](/javascript/api/outlook/office.replyformattachment#outlook-office-replyformattachment-base64file-member)|The Base64-encoded string of the file to be attached.| -|[SmartAlertsEventCompletedOptions](/javascript/api/outlook/office.smartalertseventcompletedoptions)|[errorMessageMarkdown](/javascript/api/outlook/office.smartalertseventcompletedoptions#outlook-office-smartalertseventcompletedoptions-errormessagemarkdown-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal completion of an event handler| -|[SpamReportingEventCompletedOptions](/javascript/api/outlook/office.spamreportingeventcompletedoptions)|[commandId](/javascript/api/outlook/office.spamreportingeventcompletedoptions#outlook-office-spamreportingeventcompletedoptions-commandid-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal that a reported message has finished processing,| -||[contextData](/javascript/api/outlook/office.spamreportingeventcompletedoptions#outlook-office-spamreportingeventcompletedoptions-contextdata-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal that a reported message has finished processing,| +|[AppointmentCompose](/.appointmentcompose)|[sendAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-sendasync-member(1))|Sends the appointment being composed.| +||[sendAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-sendasync-member(1))|Sends the appointment being composed.| +|[InitializationContextChangedEventArgs](/.initializationcontextchangedeventargs)|[initializationContextData](/.initializationcontextchangedeventargs#outlook-javascript/api/outlook/-initializationcontextchangedeventargs-initializationcontextdata-member)|Represents the data to be passed to an add-in's task pane from an actionable message, notification message, Smart Alerts dialog, or integrated| +||[type](/.initializationcontextchangedeventargs#outlook-javascript/api/outlook/-initializationcontextchangedeventargs-type-member)|Represents the type of the event.| +|[LoadedMessageCompose](/.loadedmessagecompose)|[bcc](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-bcc-member)|Gets the recipients on the **Bcc** (blind carbon copy) line of a message.| +||[body](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-body-member)|Gets the item's body and format.| +||[categories](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-categories-member)|Gets an object that provides methods to manage the item's categories.| +||[cc](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-cc-member)|Gets recipients on the **Cc** (carbon copy) line of a message.| +||[conversationId](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-conversationid-member)|Gets an identifier for the email conversation that contains a particular message.| +||[delayDeliveryTime](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-delaydeliverytime-member)|Gets the delayed delivery date and time of a message.| +||[from](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-from-member)|Gets the email address of the sender of a message.| +||[getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-getattachmentcontentasync-member(1))|Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.| +||[getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-getattachmentcontentasync-member(1))|Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.| +||[getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-getattachmentsasync-member(1))|Gets the item's attachments as an array.| +||[getAttachmentsAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-getattachmentsasync-member(1))|Gets the item's attachments as an array.| +||[getComposeTypeAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-getcomposetypeasync-member(1))|Specifies the type of message compose and its coercion type.| +||[getComposeTypeAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-getcomposetypeasync-member(1))|Specifies the type of message compose and its coercion type.| +||[getConversationIndexAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-getconversationindexasync-member(1))|Gets the Base64-encoded position of the current message in a conversation thread.| +||[getConversationIndexAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-getconversationindexasync-member(1))|Gets the Base64-encoded position of the current message in a conversation thread.| +||[getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-getinitializationcontextasync-member(1))|Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.| +||[getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-getinitializationcontextasync-member(1))|Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.| +||[getItemClassAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-getitemclassasync-member(1))|Gets the Exchange Web Services item class of the selected message.| +||[getItemClassAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-getitemclassasync-member(1))|Gets the Exchange Web Services item class of the selected message.| +||[getItemIdAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-getitemidasync-member(1))|Asynchronously gets the ID of a saved item.| +||[getItemIdAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-getitemidasync-member(1))|Asynchronously gets the {@link https://learn.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | Exchange Web Services (EWS) item identifier}| +||[getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-getsharedpropertiesasync-member(1))|Gets the properties of an appointment or message in a shared folder or shared mailbox.| +||[getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-getsharedpropertiesasync-member(1))|Gets the properties of an appointment or message in a shared folder or shared mailbox.| +||[inReplyTo](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-inreplyto-member)|Gets the message ID of the original message being replied to by the current message.| +||[internetHeaders](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-internetheaders-member)|Gets the custom internet headers of a message.| +||[isClientSignatureEnabledAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-isclientsignatureenabledasync-member(1))|Gets if the client signature is enabled.| +||[isClientSignatureEnabledAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-isclientsignatureenabledasync-member(1))|Gets if the client signature is enabled.| +||[itemType](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-itemtype-member)|Gets the type of item that an instance represents.| +||[loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void, userContext?: any)](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-loadcustompropertiesasync-member(1))|Asynchronously loads custom properties for this add-in on the selected item.| +||[notificationMessages](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-notificationmessages-member)|Gets the notification messages of the item.| +||[saveAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-saveasync-member(1))|Asynchronously saves the current message as a draft.| +||[saveAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-saveasync-member(1))|Asynchronously saves the current message as a draft.| +||[sensitivityLabel](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-sensitivitylabel-member)|Gets the sensitivity label of a message.| +||[seriesId](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-seriesid-member)|Gets the ID of the series that an instance belongs to.| +||[subject](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-subject-member)|Gets the description that appears in the subject field of an item.| +||[to](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-to-member)|Gets the recipients on the **To** line of a message.| +||[unloadAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-unloadasync-member(1))|When multiple mail items are selected, closes the currently loaded item, so that another selected mail item can be loaded for processing.| +||[unloadAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-unloadasync-member(1))|When multiple mail items are selected, closes the currently loaded item, so that another selected mail item can be loaded for processing.| +|[LoadedMessageRead](/.loadedmessageread)|[attachments](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-attachments-member)|Gets the item's attachments as an array.| +||[body](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-body-member)|Gets the item's body and its format.| +||[categories](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-categories-member)|Gets an object that provides methods to manage the item's categories.| +||[cc](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-cc-member)|Gets recipients on the **Cc** (carbon copy) line of a message.| +||[conversationId](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-conversationid-member)|Gets an identifier for the email conversation that contains a particular message.| +||[dateTimeCreated](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-datetimecreated-member)|Gets the date and time that an item was created.| +||[dateTimeModified](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-datetimemodified-member)|Gets the date and time that an item was last modified.| +||[displayReplyAllFormAsync(formData: string \| ReplyFormData, callback?: (asyncResult: Office.AsyncResult) => void)](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-displayreplyallformasync-member(1))|Displays a reply form that includes either the sender and all recipients of the selected message or the organizer and all attendees of the| +||[displayReplyAllFormAsync(formData: string \| ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-displayreplyallformasync-member(1))|Displays a reply form that includes either the sender and all recipients of the selected message or the organizer and all attendees of the| +||[displayReplyFormAsync(formData: string \| ReplyFormData, callback?: (asyncResult: Office.AsyncResult) => void)](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-displayreplyformasync-member(1))|Displays a reply form that includes only the sender of the selected message or the organizer of the selected appointment.| +||[displayReplyFormAsync(formData: string \| ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-displayreplyformasync-member(1))|Displays a reply form that includes only the sender of the selected message or the organizer of the selected appointment.| +||[end](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-end-member)|Gets the date and time that the appointment is to end.| +||[from](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-from-member)|Gets the email address of the sender of a message.| +||[getAllInternetHeadersAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-getallinternetheadersasync-member(1))|Gets all the internet headers for the message as a string.| +||[getAllInternetHeadersAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-getallinternetheadersasync-member(1))|Gets all the internet headers for the message as a string.| +||[getAsFileAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-getasfileasync-member(1))|Gets the current message in EML format encoded in Base64.| +||[getAsFileAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-getasfileasync-member(1))|Gets the current message in EML format encoded in Base64.| +||[getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-getattachmentcontentasync-member(1))|Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.| +||[getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-getattachmentcontentasync-member(1))|Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.| +||[getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-getinitializationcontextasync-member(1))|Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.| +||[getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-getinitializationcontextasync-member(1))|Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.| +||[getRegExMatches()](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-getregexmatches-member(1))|Returns string values in the selected item that match the regular expressions defined in an XML manifest file.| +||[getRegExMatchesByName(name: string)](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-getregexmatchesbyname-member(1))|Returns string values in the selected item that match the named regular expression defined in an XML manifest file.| +||[getSelectedRegExMatches()](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-getselectedregexmatches-member(1))|Returns string values in a highlighted match that match the regular expressions defined in an XML manifest file.| +||[getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-getsharedpropertiesasync-member(1))|Gets the properties of an appointment or message in a shared folder or shared mailbox.| +||[getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-getsharedpropertiesasync-member(1))|Gets the properties of an appointment or message in a shared folder or shared mailbox.| +||[internetMessageId](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-internetmessageid-member)|Gets the internet message identifier of a message.| +||[itemClass](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-itemclass-member)|Gets the Exchange Web Services item class of the selected message.| +||[itemId](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-itemid-member)|Gets the {@link https://learn.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | Exchange Web Services item identifier}| +||[itemType](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-itemtype-member)|Gets the type of item that an instance represents.| +||[loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void, userContext?: any)](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-loadcustompropertiesasync-member(1))|Asynchronously loads custom properties for this add-in on the selected item.| +||[location](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-location-member)|Gets the location of a meeting request.| +||[normalizedSubject](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-normalizedsubject-member)|Gets the subject of an item, with all prefixes removed (including RE: and FWD:).| +||[notificationMessages](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-notificationmessages-member)|Gets the notification messages of the item.| +||[recurrence](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-recurrence-member)|Gets the recurrence pattern of an appointment.| +||[sender](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-sender-member)|Gets the email address of the sender of an email message.| +||[seriesId](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-seriesid-member)|Gets the ID of the series that an instance belongs to.| +||[start](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-start-member)|Gets the date and time that the appointment is to begin.| +||[subject](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-subject-member)|Gets the description that appears in the subject field of an item.| +||[to](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-to-member)|Gets the recipients on the **To** line of a message.| +||[unloadAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-unloadasync-member(1))|When multiple mail items are selected, closes the currently loaded item, so that another selected mail item can be loaded for processing.| +||[unloadAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-unloadasync-member(1))|When multiple mail items are selected, closes the currently loaded item, so that another selected mail item can be loaded for processing.| +|[Mailbox](/.mailbox)|[loadItemByIdAsync(itemId: string, callback: (asyncResult: Office.AsyncResult) => void)](/.mailbox#outlook-javascript/api/outlook/-mailbox-loaditembyidasync-member(1))|Loads a single mail item by its Exchange Web Services (EWS) ID.| +||[loadItemByIdAsync(itemId: string, options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.mailbox#outlook-javascript/api/outlook/-mailbox-loaditembyidasync-member(1))|Loads a single mail item by its Exchange Web Services (EWS) ID.| +|[MessageCompose](/.messagecompose)|[sendAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-sendasync-member(1))|Sends the message being composed.| +||[sendAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-sendasync-member(1))|Sends the message being composed.| +|[ReplyFormAttachment](/.replyformattachment)|[base64file](/.replyformattachment#outlook-javascript/api/outlook/-replyformattachment-base64file-member)|The Base64-encoded string of the file to be attached.| +|[SmartAlertsEventCompletedOptions](/.smartalertseventcompletedoptions)|[errorMessageMarkdown](/.smartalertseventcompletedoptions#outlook-javascript/api/outlook/-smartalertseventcompletedoptions-errormessagemarkdown-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal completion of an event handler| +|[SpamReportingEventCompletedOptions](/.spamreportingeventcompletedoptions)|[commandId](/.spamreportingeventcompletedoptions#outlook-javascript/api/outlook/-spamreportingeventcompletedoptions-commandid-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal that a reported message has finished processing,| +||[contextData](/.spamreportingeventcompletedoptions#outlook-javascript/api/outlook/-spamreportingeventcompletedoptions-contextdata-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal that a reported message has finished processing,| diff --git a/docs/includes/outlook-1_2.md b/docs/includes/outlook-1_2.md index 5dfe7c90f6..53e7d4494e 100644 --- a/docs/includes/outlook-1_2.md +++ b/docs/includes/outlook-1_2.md @@ -1,10 +1,10 @@ | Class | Fields | Description | |:---|:---|:---| -|[AppointmentCompose](/javascript/api/outlook/office.appointmentcompose)|[getSelectedDataAsync(coercionType: Office.CoercionType \| string, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-getselecteddataasync-member(1))|Asynchronously returns selected data from the subject or body of a message.| -||[getSelectedDataAsync(coercionType: Office.CoercionType \| string, options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-getselecteddataasync-member(1))|Asynchronously returns selected data from the subject or body of a message.| -||[setSelectedDataAsync(data: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-setselecteddataasync-member(1))|Asynchronously inserts data into the body or subject of a message.| -||[setSelectedDataAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-setselecteddataasync-member(1))|Asynchronously inserts data into the body or subject of a message.| -|[MessageCompose](/javascript/api/outlook/office.messagecompose)|[getSelectedDataAsync(coercionType: Office.CoercionType \| string, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-getselecteddataasync-member(1))|Asynchronously returns selected data from the subject or body of a message.| -||[getSelectedDataAsync(coercionType: Office.CoercionType \| string, options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-getselecteddataasync-member(1))|Asynchronously returns selected data from the subject or body of a message.| -||[setSelectedDataAsync(data: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-setselecteddataasync-member(1))|Asynchronously inserts data into the body or subject of a message.| -||[setSelectedDataAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-setselecteddataasync-member(1))|Asynchronously inserts data into the body or subject of a message.| +|[AppointmentCompose](/.appointmentcompose)|[getSelectedDataAsync(coercionType: Office.CoercionType \| string, callback: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-getselecteddataasync-member(1))|Asynchronously returns selected data from the subject or body of a message.| +||[getSelectedDataAsync(coercionType: Office.CoercionType \| string, options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-getselecteddataasync-member(1))|Asynchronously returns selected data from the subject or body of a message.| +||[setSelectedDataAsync(data: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-setselecteddataasync-member(1))|Asynchronously inserts data into the body or subject of a message.| +||[setSelectedDataAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-setselecteddataasync-member(1))|Asynchronously inserts data into the body or subject of a message.| +|[MessageCompose](/.messagecompose)|[getSelectedDataAsync(coercionType: Office.CoercionType \| string, callback: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-getselecteddataasync-member(1))|Asynchronously returns selected data from the subject or body of a message.| +||[getSelectedDataAsync(coercionType: Office.CoercionType \| string, options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-getselecteddataasync-member(1))|Asynchronously returns selected data from the subject or body of a message.| +||[setSelectedDataAsync(data: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-setselecteddataasync-member(1))|Asynchronously inserts data into the body or subject of a message.| +||[setSelectedDataAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-setselecteddataasync-member(1))|Asynchronously inserts data into the body or subject of a message.| diff --git a/docs/includes/outlook-1_3.md b/docs/includes/outlook-1_3.md index 9bb49ef1fe..1ecac7bab2 100644 --- a/docs/includes/outlook-1_3.md +++ b/docs/includes/outlook-1_3.md @@ -1,31 +1,31 @@ | Class | Fields | Description | |:---|:---|:---| -|[AppointmentCompose](/javascript/api/outlook/office.appointmentcompose)|[close()](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-close-member(1))|Closes the current item that is being composed.| -||[notificationMessages](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-notificationmessages-member)|Gets the notification messages for an item.| -||[saveAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-saveasync-member(1))|Asynchronously saves an item.| -||[saveAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-saveasync-member(1))|Asynchronously saves an item.| -|[AppointmentRead](/javascript/api/outlook/office.appointmentread)|[notificationMessages](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-notificationmessages-member)|Gets the notification messages for an item.| -|[Body](/javascript/api/outlook/office.body)|[getAsync(coercionType: Office.CoercionType \| string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.body#outlook-office-body-getasync-member(1))|Returns the entire current body in the format specified by `coercionType`.| -||[getAsync(coercionType: Office.CoercionType \| string, options: Office.AsyncContextOptions & { bodyMode?: MailboxEnums.BodyMode }, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.body#outlook-office-body-getasync-member(1))|Returns the entire current body in the format specified by `coercionType`.| -||[setAsync(data: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.body#outlook-office-body-setasync-member(1))|Replaces the entire body with the specified text.| -||[setAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions & { bodyMode?: MailboxEnums.BodyMode }, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.body#outlook-office-body-setasync-member(1))|Replaces the entire body with the specified text.| -|[Mailbox](/javascript/api/outlook/office.mailbox)|[convertToEwsId(id: string, restVersion: MailboxEnums.RestVersion \| string)](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-converttoewsid-member(1))|Converts a supported ID into the Exchange Web Services (EWS) format.| -||[convertToRestId(id: string, restVersion: MailboxEnums.RestVersion \| string)](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-converttorestid-member(1))|Converts a supported ID into REST format.| -|[MessageCompose](/javascript/api/outlook/office.messagecompose)|[close()](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-close-member(1))|Closes the current item that is being composed.| -||[notificationMessages](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-notificationmessages-member)|Gets the notification messages for an item.| -||[saveAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-saveasync-member(1))|Asynchronously saves the current message as a draft.| -||[saveAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-saveasync-member(1))|Asynchronously saves the current message as a draft.| -|[MessageRead](/javascript/api/outlook/office.messageread)|[notificationMessages](/javascript/api/outlook/office.messageread#outlook-office-messageread-notificationmessages-member)|Gets the notification messages for an item.| -|[NotificationMessageDetails](/javascript/api/outlook/office.notificationmessagedetails)|[icon](/javascript/api/outlook/office.notificationmessagedetails#outlook-office-notificationmessagedetails-icon-member)|A reference to a custom icon that's defined in the manifest.| -||[key](/javascript/api/outlook/office.notificationmessagedetails#outlook-office-notificationmessagedetails-key-member)|The identifier for the notification message.| -||[message](/javascript/api/outlook/office.notificationmessagedetails#outlook-office-notificationmessagedetails-message-member)|The text of the notification message.| -||[persistent](/javascript/api/outlook/office.notificationmessagedetails#outlook-office-notificationmessagedetails-persistent-member)|Specifies if the message should be persistent.| -||[type](/javascript/api/outlook/office.notificationmessagedetails#outlook-office-notificationmessagedetails-type-member)|Specifies the `ItemNotificationMessageType` of message.| -|[NotificationMessages](/javascript/api/outlook/office.notificationmessages)|[addAsync(key: string, JSONmessage: NotificationMessageDetails, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.notificationmessages#outlook-office-notificationmessages-addasync-member(1))|Adds a notification to an item.| -||[addAsync(key: string, JSONmessage: NotificationMessageDetails, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.notificationmessages#outlook-office-notificationmessages-addasync-member(1))|Adds a notification to an item.| -||[getAllAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.notificationmessages#outlook-office-notificationmessages-getallasync-member(1))|Returns all keys and messages for an item.| -||[getAllAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.notificationmessages#outlook-office-notificationmessages-getallasync-member(1))|Returns all keys and messages for an item.| -||[removeAsync(key: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.notificationmessages#outlook-office-notificationmessages-removeasync-member(1))|Removes a notification message for an item.| -||[removeAsync(key: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.notificationmessages#outlook-office-notificationmessages-removeasync-member(1))|Removes a notification message for an item.| -||[replaceAsync(key: string, JSONmessage: NotificationMessageDetails, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.notificationmessages#outlook-office-notificationmessages-replaceasync-member(1))|Replaces a notification message that has a given key with another message.| -||[replaceAsync(key: string, JSONmessage: NotificationMessageDetails, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.notificationmessages#outlook-office-notificationmessages-replaceasync-member(1))|Replaces a notification message that has a given key with another message.| +|[AppointmentCompose](/.appointmentcompose)|[close()](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-close-member(1))|Closes the current item that is being composed.| +||[notificationMessages](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-notificationmessages-member)|Gets the notification messages for an item.| +||[saveAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-saveasync-member(1))|Asynchronously saves an item.| +||[saveAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-saveasync-member(1))|Asynchronously saves an item.| +|[AppointmentRead](/.appointmentread)|[notificationMessages](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-notificationmessages-member)|Gets the notification messages for an item.| +|[Body](/.body)|[getAsync(coercionType: Office.CoercionType \| string, callback?: (asyncResult: Office.AsyncResult) => void)](/.body#outlook-javascript/api/outlook/-body-getasync-member(1))|Returns the entire current body in the format specified by `coercionType`.| +||[getAsync(coercionType: Office.CoercionType \| string, options: Office.AsyncContextOptions & { bodyMode?: MailboxEnums.BodyMode }, callback?: (asyncResult: Office.AsyncResult) => void)](/.body#outlook-javascript/api/outlook/-body-getasync-member(1))|Returns the entire current body in the format specified by `coercionType`.| +||[setAsync(data: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.body#outlook-javascript/api/outlook/-body-setasync-member(1))|Replaces the entire body with the specified text.| +||[setAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions & { bodyMode?: MailboxEnums.BodyMode }, callback?: (asyncResult: Office.AsyncResult) => void)](/.body#outlook-javascript/api/outlook/-body-setasync-member(1))|Replaces the entire body with the specified text.| +|[Mailbox](/.mailbox)|[convertToEwsId(id: string, restVersion: MailboxEnums.RestVersion \| string)](/.mailbox#outlook-javascript/api/outlook/-mailbox-converttoewsid-member(1))|Converts a supported ID into the Exchange Web Services (EWS) format.| +||[convertToRestId(id: string, restVersion: MailboxEnums.RestVersion \| string)](/.mailbox#outlook-javascript/api/outlook/-mailbox-converttorestid-member(1))|Converts a supported ID into REST format.| +|[MessageCompose](/.messagecompose)|[close()](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-close-member(1))|Closes the current item that is being composed.| +||[notificationMessages](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-notificationmessages-member)|Gets the notification messages for an item.| +||[saveAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-saveasync-member(1))|Asynchronously saves the current message as a draft.| +||[saveAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-saveasync-member(1))|Asynchronously saves the current message as a draft.| +|[MessageRead](/.messageread)|[notificationMessages](/.messageread#outlook-javascript/api/outlook/-messageread-notificationmessages-member)|Gets the notification messages for an item.| +|[NotificationMessageDetails](/.notificationmessagedetails)|[icon](/.notificationmessagedetails#outlook-javascript/api/outlook/-notificationmessagedetails-icon-member)|A reference to a custom icon that's defined in the manifest.| +||[key](/.notificationmessagedetails#outlook-javascript/api/outlook/-notificationmessagedetails-key-member)|The identifier for the notification message.| +||[message](/.notificationmessagedetails#outlook-javascript/api/outlook/-notificationmessagedetails-message-member)|The text of the notification message.| +||[persistent](/.notificationmessagedetails#outlook-javascript/api/outlook/-notificationmessagedetails-persistent-member)|Specifies if the message should be persistent.| +||[type](/.notificationmessagedetails#outlook-javascript/api/outlook/-notificationmessagedetails-type-member)|Specifies the `ItemNotificationMessageType` of message.| +|[NotificationMessages](/.notificationmessages)|[addAsync(key: string, JSONmessage: NotificationMessageDetails, callback?: (asyncResult: Office.AsyncResult) => void)](/.notificationmessages#outlook-javascript/api/outlook/-notificationmessages-addasync-member(1))|Adds a notification to an item.| +||[addAsync(key: string, JSONmessage: NotificationMessageDetails, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.notificationmessages#outlook-javascript/api/outlook/-notificationmessages-addasync-member(1))|Adds a notification to an item.| +||[getAllAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/.notificationmessages#outlook-javascript/api/outlook/-notificationmessages-getallasync-member(1))|Returns all keys and messages for an item.| +||[getAllAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.notificationmessages#outlook-javascript/api/outlook/-notificationmessages-getallasync-member(1))|Returns all keys and messages for an item.| +||[removeAsync(key: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.notificationmessages#outlook-javascript/api/outlook/-notificationmessages-removeasync-member(1))|Removes a notification message for an item.| +||[removeAsync(key: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.notificationmessages#outlook-javascript/api/outlook/-notificationmessages-removeasync-member(1))|Removes a notification message for an item.| +||[replaceAsync(key: string, JSONmessage: NotificationMessageDetails, callback?: (asyncResult: Office.AsyncResult) => void)](/.notificationmessages#outlook-javascript/api/outlook/-notificationmessages-replaceasync-member(1))|Replaces a notification message that has a given key with another message.| +||[replaceAsync(key: string, JSONmessage: NotificationMessageDetails, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.notificationmessages#outlook-javascript/api/outlook/-notificationmessages-replaceasync-member(1))|Replaces a notification message that has a given key with another message.| diff --git a/docs/includes/outlook-1_5.md b/docs/includes/outlook-1_5.md index 70130dbab6..bfdbe46607 100644 --- a/docs/includes/outlook-1_5.md +++ b/docs/includes/outlook-1_5.md @@ -1,14 +1,21 @@ | Class | Fields | Description | |:---|:---|:---| -|[DragAndDropEventArgs](/javascript/api/outlook/office.draganddropeventargs)|[dragAndDropEventData](/javascript/api/outlook/office.draganddropeventargs#outlook-office-draganddropeventargs-draganddropeventdata-member)|Gets the details about the mouse pointer position within an add-in's task pane and the messages or file attachments being dragged and dropped into the task pane.| -||[type](/javascript/api/outlook/office.draganddropeventargs#outlook-office-draganddropeventargs-type-member)|Gets the type of the event.| -|[DroppedItemDetails](/javascript/api/outlook/office.droppeditemdetails)|[fileContent](/javascript/api/outlook/office.droppeditemdetails#outlook-office-droppeditemdetails-filecontent-member)|Gets the contents of the file being dragged and dropped.| -||[name](/javascript/api/outlook/office.droppeditemdetails#outlook-office-droppeditemdetails-name-member)|Gets the name of the file being dragged and dropped.| -||[type](/javascript/api/outlook/office.droppeditemdetails#outlook-office-droppeditemdetails-type-member)|Gets the type of the file being dragged and dropped.| -|[DroppedItems](/javascript/api/outlook/office.droppeditems)|[files](/javascript/api/outlook/office.droppeditems#outlook-office-droppeditems-files-member)|Gets an array of the messages or file attachments being dragged and dropped into an add-in's task pane.| -|[Mailbox](/javascript/api/outlook/office.mailbox)|[addHandlerAsync(eventType: Office.EventType \| string, handler: any, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-addhandlerasync-member(1))|Adds an event handler for a supported event.| -||[addHandlerAsync(eventType: Office.EventType \| string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-addhandlerasync-member(1))|Adds an event handler for a supported event.| -||[getCallbackTokenAsync(options: Office.AsyncContextOptions & { isRest?: boolean }, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-getcallbacktokenasync-member(1))|Gets a string that contains a token used to call REST APIs or Exchange Web Services (EWS).| -||[removeHandlerAsync(eventType: Office.EventType \| string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-removehandlerasync-member(1))|Removes the event handlers for a supported event type.| -||[removeHandlerAsync(eventType: Office.EventType \| string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-removehandlerasync-member(1))|Removes the event handlers for a supported event type.| -||[restUrl](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-resturl-member)|Gets the URL of the REST endpoint for this email account.| +|[DragAndDropEventArgs](/.draganddropeventargs)|[dragAndDropEventData](/.draganddropeventargs#outlook-javascript/api/outlook/-draganddropeventargs-draganddropeventdata-member)|Gets the details about the mouse pointer position within an add-in's task pane and the messages or file attachments being dragged and dropped into the task pane.| +||[type](/.draganddropeventargs#outlook-javascript/api/outlook/-draganddropeventargs-type-member)|Gets the type of the event.| +|[DragoverEventData](/.dragovereventdata)|[pageX](/.dragovereventdata#outlook-javascript/api/outlook/-dragovereventdata-pagex-member)|Gets the x-coordinate of the mouse pointer that represents the horizontal position in pixels.| +||[pageY](/.dragovereventdata#outlook-javascript/api/outlook/-dragovereventdata-pagey-member)|Gets the y-coordinate of the mouse pointer that represents the vertical position in pixels.| +||[type](/.dragovereventdata#outlook-javascript/api/outlook/-dragovereventdata-type-member)|Gets the type of drag-and-drop event.| +|[DropEventData](/.dropeventdata)|[dataTransfer](/.dropeventdata#outlook-javascript/api/outlook/-dropeventdata-datatransfer-member)|Gets the messages or file attachments being dragged and dropped into an add-in's task pane.| +||[pageX](/.dropeventdata#outlook-javascript/api/outlook/-dropeventdata-pagex-member)|Gets the x-coordinate of the mouse pointer that represents the horizontal position in pixels.| +||[pageY](/.dropeventdata#outlook-javascript/api/outlook/-dropeventdata-pagey-member)|Gets the y-coordinate of the mouse pointer that represents the vertical position in pixels.| +||[type](/.dropeventdata#outlook-javascript/api/outlook/-dropeventdata-type-member)|Gets the type of drag-and-drop event.| +|[DroppedItemDetails](/.droppeditemdetails)|[fileContent](/.droppeditemdetails#outlook-javascript/api/outlook/-droppeditemdetails-filecontent-member)|Gets the contents of the file being dragged and dropped.| +||[name](/.droppeditemdetails#outlook-javascript/api/outlook/-droppeditemdetails-name-member)|Gets the name of the file being dragged and dropped.| +||[type](/.droppeditemdetails#outlook-javascript/api/outlook/-droppeditemdetails-type-member)|Gets the type of the file being dragged and dropped.| +|[DroppedItems](/.droppeditems)|[files](/.droppeditems#outlook-javascript/api/outlook/-droppeditems-files-member)|Gets an array of the messages or file attachments being dragged and dropped into an add-in's task pane.| +|[Mailbox](/.mailbox)|[addHandlerAsync(eventType: Office.EventType \| string, handler: any, callback?: (asyncResult: Office.AsyncResult) => void)](/.mailbox#outlook-javascript/api/outlook/-mailbox-addhandlerasync-member(1))|Adds an event handler for a supported event.| +||[addHandlerAsync(eventType: Office.EventType \| string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.mailbox#outlook-javascript/api/outlook/-mailbox-addhandlerasync-member(1))|Adds an event handler for a supported event.| +||[getCallbackTokenAsync(options: Office.AsyncContextOptions & { isRest?: boolean }, callback: (asyncResult: Office.AsyncResult) => void)](/.mailbox#outlook-javascript/api/outlook/-mailbox-getcallbacktokenasync-member(1))|Gets a string that contains a token used to call REST APIs or Exchange Web Services (EWS).| +||[removeHandlerAsync(eventType: Office.EventType \| string, callback?: (asyncResult: Office.AsyncResult) => void)](/.mailbox#outlook-javascript/api/outlook/-mailbox-removehandlerasync-member(1))|Removes the event handlers for a supported event type.| +||[removeHandlerAsync(eventType: Office.EventType \| string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.mailbox#outlook-javascript/api/outlook/-mailbox-removehandlerasync-member(1))|Removes the event handlers for a supported event type.| +||[restUrl](/.mailbox#outlook-javascript/api/outlook/-mailbox-resturl-member)|Gets the URL of the REST endpoint for this email account.| diff --git a/docs/includes/outlook-1_6.md b/docs/includes/outlook-1_6.md index 57378ca8a3..5be42bb3b7 100644 --- a/docs/includes/outlook-1_6.md +++ b/docs/includes/outlook-1_6.md @@ -1,8 +1,8 @@ | Class | Fields | Description | |:---|:---|:---| -|[AppointmentRead](/javascript/api/outlook/office.appointmentread)|[getSelectedEntities()](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-getselectedentities-member(1))|Gets the entities found in a highlighted match a user has selected.| -||[getSelectedRegExMatches()](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-getselectedregexmatches-member(1))|Returns string values in a highlighted match that match the regular expressions defined in an add-in only manifest file.| -|[Mailbox](/javascript/api/outlook/office.mailbox)|[displayNewMessageForm(parameters: any)](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-displaynewmessageform-member(1))|Displays a form for creating a new message.| -|[MessageRead](/javascript/api/outlook/office.messageread)|[getSelectedEntities()](/javascript/api/outlook/office.messageread#outlook-office-messageread-getselectedentities-member(1))|Gets the entities found in a highlighted match a user has selected.| -||[getSelectedRegExMatches()](/javascript/api/outlook/office.messageread#outlook-office-messageread-getselectedregexmatches-member(1))|Returns string values in a highlighted match that match the regular expressions defined in an add-in only manifest file.| -|[UserProfile](/javascript/api/outlook/office.userprofile)|[accountType](/javascript/api/outlook/office.userprofile#outlook-office-userprofile-accounttype-member)|Gets the account type of the user associated with the mailbox.| +|[AppointmentRead](/.appointmentread)|[getSelectedEntities()](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-getselectedentities-member(1))|Gets the entities found in a highlighted match a user has selected.| +||[getSelectedRegExMatches()](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-getselectedregexmatches-member(1))|Returns string values in a highlighted match that match the regular expressions defined in an add-in only manifest file.| +|[Mailbox](/.mailbox)|[displayNewMessageForm(parameters: any)](/.mailbox#outlook-javascript/api/outlook/-mailbox-displaynewmessageform-member(1))|Displays a form for creating a new message.| +|[MessageRead](/.messageread)|[getSelectedEntities()](/.messageread#outlook-javascript/api/outlook/-messageread-getselectedentities-member(1))|Gets the entities found in a highlighted match a user has selected.| +||[getSelectedRegExMatches()](/.messageread#outlook-javascript/api/outlook/-messageread-getselectedregexmatches-member(1))|Returns string values in a highlighted match that match the regular expressions defined in an add-in only manifest file.| +|[UserProfile](/.userprofile)|[accountType](/.userprofile#outlook-javascript/api/outlook/-userprofile-accounttype-member)|Gets the account type of the user associated with the mailbox.| diff --git a/docs/includes/outlook-1_7.md b/docs/includes/outlook-1_7.md index 55ae134ebf..86cd3ce342 100644 --- a/docs/includes/outlook-1_7.md +++ b/docs/includes/outlook-1_7.md @@ -1,73 +1,73 @@ | Class | Fields | Description | |:---|:---|:---| -|[AppointmentCompose](/javascript/api/outlook/office.appointmentcompose)|[addHandlerAsync(eventType: Office.EventType \| string, handler: any, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-addhandlerasync-member(1))|Adds an event handler for a supported event.| -||[addHandlerAsync(eventType: Office.EventType \| string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-addhandlerasync-member(1))|Adds an event handler for a supported event.| -||[organizer](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-organizer-member)|Gets the organizer for the specified meeting.| -||[recurrence](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-recurrence-member)|Gets or sets the recurrence pattern of an appointment.| -||[removeHandlerAsync(eventType: Office.EventType \| string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-removehandlerasync-member(1))|Removes the event handlers for a supported event type.| -||[removeHandlerAsync(eventType: Office.EventType \| string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-removehandlerasync-member(1))|Removes the event handlers for a supported event type.| -||[seriesId](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-seriesid-member)|Gets the ID of the series that an instance belongs to.| -|[AppointmentRead](/javascript/api/outlook/office.appointmentread)|[addHandlerAsync(eventType: Office.EventType \| string, handler: any, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-addhandlerasync-member(1))|Adds an event handler for a supported event.| -||[addHandlerAsync(eventType: Office.EventType \| string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-addhandlerasync-member(1))|Adds an event handler for a supported event.| -||[recurrence](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-recurrence-member)|Gets the recurrence pattern of an appointment.| -||[removeHandlerAsync(eventType: Office.EventType \| string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-removehandlerasync-member(1))|Removes the event handlers for a supported event type.| -||[removeHandlerAsync(eventType: Office.EventType \| string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-removehandlerasync-member(1))|Removes the event handlers for a supported event type.| -||[seriesId](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-seriesid-member)|Gets the ID of the series that an instance belongs to.| -|[AppointmentTimeChangedEventArgs](/javascript/api/outlook/office.appointmenttimechangedeventargs)|[end](/javascript/api/outlook/office.appointmenttimechangedeventargs#outlook-office-appointmenttimechangedeventargs-end-member)|Gets the appointment end date and time.| -||[start](/javascript/api/outlook/office.appointmenttimechangedeventargs#outlook-office-appointmenttimechangedeventargs-start-member)|Gets the appointment start date and time.| -||[type](/javascript/api/outlook/office.appointmenttimechangedeventargs#outlook-office-appointmenttimechangedeventargs-type-member)|Gets the type of the event.| -|[From](/javascript/api/outlook/office.from)|[getAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.from#outlook-office-from-getasync-member(1))|Gets the from value of a message.| -||[getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.from#outlook-office-from-getasync-member(1))|Gets the from value of a message.| -|[MessageCompose](/javascript/api/outlook/office.messagecompose)|[addHandlerAsync(eventType: Office.EventType \| string, handler: any, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-addhandlerasync-member(1))|Adds an event handler for a supported event.| -||[addHandlerAsync(eventType: Office.EventType \| string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-addhandlerasync-member(1))|Adds an event handler for a supported event.| -||[from](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-from-member)|Gets the email address of the sender of a message.| -||[removeHandlerAsync(eventType: Office.EventType \| string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-removehandlerasync-member(1))|Removes the event handlers for a supported event type.| -||[removeHandlerAsync(eventType: Office.EventType \| string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-removehandlerasync-member(1))|Removes the event handlers for a supported event type.| -||[seriesId](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-seriesid-member)|Gets the ID of the series that an instance belongs to.| -|[MessageRead](/javascript/api/outlook/office.messageread)|[addHandlerAsync(eventType: Office.EventType \| string, handler: any, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messageread#outlook-office-messageread-addhandlerasync-member(1))|Adds an event handler for a supported event.| -||[addHandlerAsync(eventType: Office.EventType \| string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messageread#outlook-office-messageread-addhandlerasync-member(1))|Adds an event handler for a supported event.| -||[recurrence](/javascript/api/outlook/office.messageread#outlook-office-messageread-recurrence-member)|Gets the recurrence pattern of an appointment.| -||[removeHandlerAsync(eventType: Office.EventType \| string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messageread#outlook-office-messageread-removehandlerasync-member(1))|Removes the event handlers for a supported event type.| -||[removeHandlerAsync(eventType: Office.EventType \| string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messageread#outlook-office-messageread-removehandlerasync-member(1))|Removes the event handlers for a supported event type.| -||[seriesId](/javascript/api/outlook/office.messageread#outlook-office-messageread-seriesid-member)|Gets the ID of the series that an instance belongs to.| -|[Organizer](/javascript/api/outlook/office.organizer)|[getAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.organizer#outlook-office-organizer-getasync-member(1))|Gets the organizer value of an appointment as an {@link Office.EmailAddressDetails | EmailAddressDetails} object| -||[getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.organizer#outlook-office-organizer-getasync-member(1))|Gets the organizer value of an appointment as an {@link Office.EmailAddressDetails | EmailAddressDetails} object| -|[RecipientsChangedEventArgs](/javascript/api/outlook/office.recipientschangedeventargs)|[changedRecipientFields](/javascript/api/outlook/office.recipientschangedeventargs#outlook-office-recipientschangedeventargs-changedrecipientfields-member)|Gets an object that indicates change state of recipients fields.| -||[type](/javascript/api/outlook/office.recipientschangedeventargs#outlook-office-recipientschangedeventargs-type-member)|Gets the type of the event.| -|[RecipientsChangedFields](/javascript/api/outlook/office.recipientschangedfields)|[bcc](/javascript/api/outlook/office.recipientschangedfields#outlook-office-recipientschangedfields-bcc-member)|Gets if recipients in the **bcc** field were changed.| -||[cc](/javascript/api/outlook/office.recipientschangedfields#outlook-office-recipientschangedfields-cc-member)|Gets if recipients in the **cc** field were changed.| -||[optionalAttendees](/javascript/api/outlook/office.recipientschangedfields#outlook-office-recipientschangedfields-optionalattendees-member)|Gets if optional attendees were changed.| -||[requiredAttendees](/javascript/api/outlook/office.recipientschangedfields#outlook-office-recipientschangedfields-requiredattendees-member)|Gets if required attendees were changed.| -||[resources](/javascript/api/outlook/office.recipientschangedfields#outlook-office-recipientschangedfields-resources-member)|Gets if resources were changed.| -||[to](/javascript/api/outlook/office.recipientschangedfields#outlook-office-recipientschangedfields-to-member)|Gets if recipients in the **to** field were changed.| -|[Recurrence](/javascript/api/outlook/office.recurrence)|[getAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.recurrence#outlook-office-recurrence-getasync-member(1))|Returns the current recurrence object of an appointment series.| -||[getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.recurrence#outlook-office-recurrence-getasync-member(1))|Returns the current recurrence object of an appointment series.| -||[recurrenceProperties](/javascript/api/outlook/office.recurrence#outlook-office-recurrence-recurrenceproperties-member)|Gets or sets the properties of the recurring appointment series.| -||[recurrenceTimeZone](/javascript/api/outlook/office.recurrence#outlook-office-recurrence-recurrencetimezone-member)|Gets or sets the properties of the recurring appointment series.| -||[recurrenceType](/javascript/api/outlook/office.recurrence#outlook-office-recurrence-recurrencetype-member)|Gets or sets the type of the recurring appointment series.| -||[seriesTime](/javascript/api/outlook/office.recurrence#outlook-office-recurrence-seriestime-member)|The {@link Office.SeriesTime | SeriesTime} object enables you to manage the start and end dates of the recurring appointment series and| -||[setAsync(recurrencePattern: Recurrence, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.recurrence#outlook-office-recurrence-setasync-member(1))|Sets the recurrence pattern of an appointment series.| -||[setAsync(recurrencePattern: Recurrence, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.recurrence#outlook-office-recurrence-setasync-member(1))|Sets the recurrence pattern of an appointment series.| -|[RecurrenceChangedEventArgs](/javascript/api/outlook/office.recurrencechangedeventargs)|[recurrence](/javascript/api/outlook/office.recurrencechangedeventargs#outlook-office-recurrencechangedeventargs-recurrence-member)|Gets the updated recurrence object.| -||[type](/javascript/api/outlook/office.recurrencechangedeventargs#outlook-office-recurrencechangedeventargs-type-member)|Gets the type of the event.| -|[RecurrenceProperties](/javascript/api/outlook/office.recurrenceproperties)|[dayOfMonth](/javascript/api/outlook/office.recurrenceproperties#outlook-office-recurrenceproperties-dayofmonth-member)|Represents the day of the month.| -||[dayOfWeek](/javascript/api/outlook/office.recurrenceproperties#outlook-office-recurrenceproperties-dayofweek-member)|Represents the day of the week or type of day, for example, weekend day vs weekday.| -||[days](/javascript/api/outlook/office.recurrenceproperties#outlook-office-recurrenceproperties-days-member)|Represents the set of days for this recurrence.| -||[firstDayOfWeek](/javascript/api/outlook/office.recurrenceproperties#outlook-office-recurrenceproperties-firstdayofweek-member)|Represents your chosen first day of the week otherwise the default is the value in the current user's settings.| -||[interval](/javascript/api/outlook/office.recurrenceproperties#outlook-office-recurrenceproperties-interval-member)|Represents the period between instances of the same recurring series.| -||[month](/javascript/api/outlook/office.recurrenceproperties#outlook-office-recurrenceproperties-month-member)|Represents the month.| -||[weekNumber](/javascript/api/outlook/office.recurrenceproperties#outlook-office-recurrenceproperties-weeknumber-member)|Represents the number of the week in the selected month e.g., 'first' for first week of the month.| -|[RecurrenceTimeZone](/javascript/api/outlook/office.recurrencetimezone)|[name](/javascript/api/outlook/office.recurrencetimezone#outlook-office-recurrencetimezone-name-member)|Represents the name of the recurrence time zone.| -||[offset](/javascript/api/outlook/office.recurrencetimezone#outlook-office-recurrencetimezone-offset-member)|Integer value representing the difference in minutes between the local time zone and UTC at the date that the meeting series began.| -|[SeriesTime](/javascript/api/outlook/office.seriestime)|[getDuration()](/javascript/api/outlook/office.seriestime#outlook-office-seriestime-getduration-member(1))|Gets the duration in minutes of a usual instance in a recurring appointment series.| -||[getEndDate()](/javascript/api/outlook/office.seriestime#outlook-office-seriestime-getenddate-member(1))|Gets the end date of a recurrence pattern in the following| -||[getEndTime()](/javascript/api/outlook/office.seriestime#outlook-office-seriestime-getendtime-member(1))|Gets the end time of a usual appointment or meeting request instance of a recurrence pattern in whichever time zone that the user or| -||[getStartDate()](/javascript/api/outlook/office.seriestime#outlook-office-seriestime-getstartdate-member(1))|Gets the start date of a recurrence pattern in the following| -||[getStartTime()](/javascript/api/outlook/office.seriestime#outlook-office-seriestime-getstarttime-member(1))|Gets the start time of a usual appointment instance of a recurrence pattern in whichever time zone that the user/add-in set the| -||[setDuration(minutes: number)](/javascript/api/outlook/office.seriestime#outlook-office-seriestime-setduration-member(1))|Sets the duration of all appointments in a recurrence pattern.| -||[setEndDate(date: string)](/javascript/api/outlook/office.seriestime#outlook-office-seriestime-setenddate-member(1))|Sets the end date of a recurring appointment series.| -||[setEndDate(year: number, month: number, day: number)](/javascript/api/outlook/office.seriestime#outlook-office-seriestime-setenddate-member(1))|Sets the end date of a recurring appointment series.| -||[setStartDate(date:string)](/javascript/api/outlook/office.seriestime#outlook-office-seriestime-setstartdate-member(1))|Sets the start date of a recurring appointment series.| -||[setStartDate(year:number, month:number, day:number)](/javascript/api/outlook/office.seriestime#outlook-office-seriestime-setstartdate-member(1))|Sets the start date of a recurring appointment series.| -||[setStartTime(hours: number, minutes: number)](/javascript/api/outlook/office.seriestime#outlook-office-seriestime-setstarttime-member(1))|Sets the start time of all instances of a recurring appointment series in whichever time zone the recurrence pattern is set| -||[setStartTime(time: string)](/javascript/api/outlook/office.seriestime#outlook-office-seriestime-setstarttime-member(1))|Sets the start time of all instances of a recurring appointment series in whichever time zone the recurrence pattern is set| +|[AppointmentCompose](/.appointmentcompose)|[addHandlerAsync(eventType: Office.EventType \| string, handler: any, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-addhandlerasync-member(1))|Adds an event handler for a supported event.| +||[addHandlerAsync(eventType: Office.EventType \| string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-addhandlerasync-member(1))|Adds an event handler for a supported event.| +||[organizer](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-organizer-member)|Gets the organizer for the specified meeting.| +||[recurrence](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-recurrence-member)|Gets or sets the recurrence pattern of an appointment.| +||[removeHandlerAsync(eventType: Office.EventType \| string, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-removehandlerasync-member(1))|Removes the event handlers for a supported event type.| +||[removeHandlerAsync(eventType: Office.EventType \| string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-removehandlerasync-member(1))|Removes the event handlers for a supported event type.| +||[seriesId](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-seriesid-member)|Gets the ID of the series that an instance belongs to.| +|[AppointmentRead](/.appointmentread)|[addHandlerAsync(eventType: Office.EventType \| string, handler: any, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-addhandlerasync-member(1))|Adds an event handler for a supported event.| +||[addHandlerAsync(eventType: Office.EventType \| string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-addhandlerasync-member(1))|Adds an event handler for a supported event.| +||[recurrence](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-recurrence-member)|Gets the recurrence pattern of an appointment.| +||[removeHandlerAsync(eventType: Office.EventType \| string, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-removehandlerasync-member(1))|Removes the event handlers for a supported event type.| +||[removeHandlerAsync(eventType: Office.EventType \| string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-removehandlerasync-member(1))|Removes the event handlers for a supported event type.| +||[seriesId](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-seriesid-member)|Gets the ID of the series that an instance belongs to.| +|[AppointmentTimeChangedEventArgs](/.appointmenttimechangedeventargs)|[end](/.appointmenttimechangedeventargs#outlook-javascript/api/outlook/-appointmenttimechangedeventargs-end-member)|Gets the appointment end date and time.| +||[start](/.appointmenttimechangedeventargs#outlook-javascript/api/outlook/-appointmenttimechangedeventargs-start-member)|Gets the appointment start date and time.| +||[type](/.appointmenttimechangedeventargs#outlook-javascript/api/outlook/-appointmenttimechangedeventargs-type-member)|Gets the type of the event.| +|[From](/.from)|[getAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/.from#outlook-javascript/api/outlook/-from-getasync-member(1))|Gets the from value of a message.| +||[getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.from#outlook-javascript/api/outlook/-from-getasync-member(1))|Gets the from value of a message.| +|[MessageCompose](/.messagecompose)|[addHandlerAsync(eventType: Office.EventType \| string, handler: any, callback?: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-addhandlerasync-member(1))|Adds an event handler for a supported event.| +||[addHandlerAsync(eventType: Office.EventType \| string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-addhandlerasync-member(1))|Adds an event handler for a supported event.| +||[from](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-from-member)|Gets the email address of the sender of a message.| +||[removeHandlerAsync(eventType: Office.EventType \| string, callback?: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-removehandlerasync-member(1))|Removes the event handlers for a supported event type.| +||[removeHandlerAsync(eventType: Office.EventType \| string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-removehandlerasync-member(1))|Removes the event handlers for a supported event type.| +||[seriesId](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-seriesid-member)|Gets the ID of the series that an instance belongs to.| +|[MessageRead](/.messageread)|[addHandlerAsync(eventType: Office.EventType \| string, handler: any, callback?: (asyncResult: Office.AsyncResult) => void)](/.messageread#outlook-javascript/api/outlook/-messageread-addhandlerasync-member(1))|Adds an event handler for a supported event.| +||[addHandlerAsync(eventType: Office.EventType \| string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.messageread#outlook-javascript/api/outlook/-messageread-addhandlerasync-member(1))|Adds an event handler for a supported event.| +||[recurrence](/.messageread#outlook-javascript/api/outlook/-messageread-recurrence-member)|Gets the recurrence pattern of an appointment.| +||[removeHandlerAsync(eventType: Office.EventType \| string, callback?: (asyncResult: Office.AsyncResult) => void)](/.messageread#outlook-javascript/api/outlook/-messageread-removehandlerasync-member(1))|Removes the event handlers for a supported event type.| +||[removeHandlerAsync(eventType: Office.EventType \| string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.messageread#outlook-javascript/api/outlook/-messageread-removehandlerasync-member(1))|Removes the event handlers for a supported event type.| +||[seriesId](/.messageread#outlook-javascript/api/outlook/-messageread-seriesid-member)|Gets the ID of the series that an instance belongs to.| +|[Organizer](/.organizer)|[getAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/.organizer#outlook-javascript/api/outlook/-organizer-getasync-member(1))|Gets the organizer value of an appointment as an {@link Office.EmailAddressDetails | EmailAddressDetails} object| +||[getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.organizer#outlook-javascript/api/outlook/-organizer-getasync-member(1))|Gets the organizer value of an appointment as an {@link Office.EmailAddressDetails | EmailAddressDetails} object| +|[RecipientsChangedEventArgs](/.recipientschangedeventargs)|[changedRecipientFields](/.recipientschangedeventargs#outlook-javascript/api/outlook/-recipientschangedeventargs-changedrecipientfields-member)|Gets an object that indicates change state of recipients fields.| +||[type](/.recipientschangedeventargs#outlook-javascript/api/outlook/-recipientschangedeventargs-type-member)|Gets the type of the event.| +|[RecipientsChangedFields](/.recipientschangedfields)|[bcc](/.recipientschangedfields#outlook-javascript/api/outlook/-recipientschangedfields-bcc-member)|Gets if recipients in the **bcc** field were changed.| +||[cc](/.recipientschangedfields#outlook-javascript/api/outlook/-recipientschangedfields-cc-member)|Gets if recipients in the **cc** field were changed.| +||[optionalAttendees](/.recipientschangedfields#outlook-javascript/api/outlook/-recipientschangedfields-optionalattendees-member)|Gets if optional attendees were changed.| +||[requiredAttendees](/.recipientschangedfields#outlook-javascript/api/outlook/-recipientschangedfields-requiredattendees-member)|Gets if required attendees were changed.| +||[resources](/.recipientschangedfields#outlook-javascript/api/outlook/-recipientschangedfields-resources-member)|Gets if resources were changed.| +||[to](/.recipientschangedfields#outlook-javascript/api/outlook/-recipientschangedfields-to-member)|Gets if recipients in the **to** field were changed.| +|[Recurrence](/.recurrence)|[getAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/.recurrence#outlook-javascript/api/outlook/-recurrence-getasync-member(1))|Returns the current recurrence object of an appointment series.| +||[getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.recurrence#outlook-javascript/api/outlook/-recurrence-getasync-member(1))|Returns the current recurrence object of an appointment series.| +||[recurrenceProperties](/.recurrence#outlook-javascript/api/outlook/-recurrence-recurrenceproperties-member)|Gets or sets the properties of the recurring appointment series.| +||[recurrenceTimeZone](/.recurrence#outlook-javascript/api/outlook/-recurrence-recurrencetimezone-member)|Gets or sets the properties of the recurring appointment series.| +||[recurrenceType](/.recurrence#outlook-javascript/api/outlook/-recurrence-recurrencetype-member)|Gets or sets the type of the recurring appointment series.| +||[seriesTime](/.recurrence#outlook-javascript/api/outlook/-recurrence-seriestime-member)|The {@link Office.SeriesTime | SeriesTime} object enables you to manage the start and end dates of the recurring appointment series and| +||[setAsync(recurrencePattern: Recurrence, callback?: (asyncResult: Office.AsyncResult) => void)](/.recurrence#outlook-javascript/api/outlook/-recurrence-setasync-member(1))|Sets the recurrence pattern of an appointment series.| +||[setAsync(recurrencePattern: Recurrence, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.recurrence#outlook-javascript/api/outlook/-recurrence-setasync-member(1))|Sets the recurrence pattern of an appointment series.| +|[RecurrenceChangedEventArgs](/.recurrencechangedeventargs)|[recurrence](/.recurrencechangedeventargs#outlook-javascript/api/outlook/-recurrencechangedeventargs-recurrence-member)|Gets the updated recurrence object.| +||[type](/.recurrencechangedeventargs#outlook-javascript/api/outlook/-recurrencechangedeventargs-type-member)|Gets the type of the event.| +|[RecurrenceProperties](/.recurrenceproperties)|[dayOfMonth](/.recurrenceproperties#outlook-javascript/api/outlook/-recurrenceproperties-dayofmonth-member)|Represents the day of the month.| +||[dayOfWeek](/.recurrenceproperties#outlook-javascript/api/outlook/-recurrenceproperties-dayofweek-member)|Represents the day of the week or type of day, for example, weekend day vs weekday.| +||[days](/.recurrenceproperties#outlook-javascript/api/outlook/-recurrenceproperties-days-member)|Represents the set of days for this recurrence.| +||[firstDayOfWeek](/.recurrenceproperties#outlook-javascript/api/outlook/-recurrenceproperties-firstdayofweek-member)|Represents your chosen first day of the week otherwise the default is the value in the current user's settings.| +||[interval](/.recurrenceproperties#outlook-javascript/api/outlook/-recurrenceproperties-interval-member)|Represents the period between instances of the same recurring series.| +||[month](/.recurrenceproperties#outlook-javascript/api/outlook/-recurrenceproperties-month-member)|Represents the month.| +||[weekNumber](/.recurrenceproperties#outlook-javascript/api/outlook/-recurrenceproperties-weeknumber-member)|Represents the number of the week in the selected month e.g., 'first' for first week of the month.| +|[RecurrenceTimeZone](/.recurrencetimezone)|[name](/.recurrencetimezone#outlook-javascript/api/outlook/-recurrencetimezone-name-member)|Represents the name of the recurrence time zone.| +||[offset](/.recurrencetimezone#outlook-javascript/api/outlook/-recurrencetimezone-offset-member)|Integer value representing the difference in minutes between the local time zone and UTC at the date that the meeting series began.| +|[SeriesTime](/.seriestime)|[getDuration()](/.seriestime#outlook-javascript/api/outlook/-seriestime-getduration-member(1))|Gets the duration in minutes of a usual instance in a recurring appointment series.| +||[getEndDate()](/.seriestime#outlook-javascript/api/outlook/-seriestime-getenddate-member(1))|Gets the end date of a recurrence pattern in the following| +||[getEndTime()](/.seriestime#outlook-javascript/api/outlook/-seriestime-getendtime-member(1))|Gets the end time of a usual appointment or meeting request instance of a recurrence pattern in whichever time zone that the user or| +||[getStartDate()](/.seriestime#outlook-javascript/api/outlook/-seriestime-getstartdate-member(1))|Gets the start date of a recurrence pattern in the following| +||[getStartTime()](/.seriestime#outlook-javascript/api/outlook/-seriestime-getstarttime-member(1))|Gets the start time of a usual appointment instance of a recurrence pattern in whichever time zone that the user/add-in set the| +||[setDuration(minutes: number)](/.seriestime#outlook-javascript/api/outlook/-seriestime-setduration-member(1))|Sets the duration of all appointments in a recurrence pattern.| +||[setEndDate(date: string)](/.seriestime#outlook-javascript/api/outlook/-seriestime-setenddate-member(1))|Sets the end date of a recurring appointment series.| +||[setEndDate(year: number, month: number, day: number)](/.seriestime#outlook-javascript/api/outlook/-seriestime-setenddate-member(1))|Sets the end date of a recurring appointment series.| +||[setStartDate(date:string)](/.seriestime#outlook-javascript/api/outlook/-seriestime-setstartdate-member(1))|Sets the start date of a recurring appointment series.| +||[setStartDate(year:number, month:number, day:number)](/.seriestime#outlook-javascript/api/outlook/-seriestime-setstartdate-member(1))|Sets the start date of a recurring appointment series.| +||[setStartTime(hours: number, minutes: number)](/.seriestime#outlook-javascript/api/outlook/-seriestime-setstarttime-member(1))|Sets the start time of all instances of a recurring appointment series in whichever time zone the recurrence pattern is set| +||[setStartTime(time: string)](/.seriestime#outlook-javascript/api/outlook/-seriestime-setstarttime-member(1))|Sets the start time of all instances of a recurring appointment series in whichever time zone the recurrence pattern is set| diff --git a/docs/includes/outlook-1_8.md b/docs/includes/outlook-1_8.md index 21ae3454e8..6f3b5d54f2 100644 --- a/docs/includes/outlook-1_8.md +++ b/docs/includes/outlook-1_8.md @@ -1,96 +1,96 @@ | Class | Fields | Description | |:---|:---|:---| -|[AppointmentCompose](/javascript/api/outlook/office.appointmentcompose)|[addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-addfileattachmentfrombase64async-member(1))|Adds a file to a message or appointment as an attachment.| -||[addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-addfileattachmentfrombase64async-member(1))|Adds a file to a message or appointment as an attachment.| -||[categories](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-categories-member)|Gets an object that provides methods for managing the item's categories.| -||[enhancedLocation](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-enhancedlocation-member)|Gets or sets the locations of the appointment.| -||[getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-getattachmentcontentasync-member(1))|Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.| -||[getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-getattachmentcontentasync-member(1))|Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.| -||[getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-getattachmentsasync-member(1))|Gets the item's attachments as an array.| -||[getAttachmentsAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-getattachmentsasync-member(1))|Gets the item's attachments as an array.| -||[getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-getinitializationcontextasync-member(1))|Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.| -||[getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-getinitializationcontextasync-member(1))|Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.| -||[getItemIdAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-getitemidasync-member(1))|Asynchronously gets the {@link https://learn.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | Exchange Web Services (EWS) item identifier}| -||[getItemIdAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-getitemidasync-member(1))|Asynchronously gets the {@link https://learn.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | Exchange Web Services (EWS) item identifier}| -||[getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-getsharedpropertiesasync-member(1))|Gets the properties of an appointment or message in a shared folder or shared mailbox.| -||[getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-getsharedpropertiesasync-member(1))|Gets the properties of an appointment or message in a shared folder or shared mailbox.| -|[AppointmentRead](/javascript/api/outlook/office.appointmentread)|[categories](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-categories-member)|Gets an object that provides methods for managing the item's categories.| -||[enhancedLocation](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-enhancedlocation-member)|Gets the locations of an appointment.| -||[getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-getattachmentcontentasync-member(1))|Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.| -||[getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-getattachmentcontentasync-member(1))|Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.| -||[getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-getinitializationcontextasync-member(1))|Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.| -||[getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-getinitializationcontextasync-member(1))|Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.| -||[getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-getsharedpropertiesasync-member(1))|Gets the properties of an appointment or message in a shared folder or shared mailbox.| -||[getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-getsharedpropertiesasync-member(1))|Gets the properties of an appointment or message in a shared folder or shared mailbox.| -|[AttachmentContent](/javascript/api/outlook/office.attachmentcontent)|[content](/javascript/api/outlook/office.attachmentcontent#outlook-office-attachmentcontent-content-member)|The content of an attachment as a string.| -||[format](/javascript/api/outlook/office.attachmentcontent#outlook-office-attachmentcontent-format-member)|The string format to use for an attachment's content.| -|[AttachmentDetailsCompose](/javascript/api/outlook/office.attachmentdetailscompose)|[attachmentType](/javascript/api/outlook/office.attachmentdetailscompose#outlook-office-attachmentdetailscompose-attachmenttype-member)|Gets a value that indicates the attachment's type.| -||[id](/javascript/api/outlook/office.attachmentdetailscompose#outlook-office-attachmentdetailscompose-id-member)|Gets the index of the attachment.| -||[isInline](/javascript/api/outlook/office.attachmentdetailscompose#outlook-office-attachmentdetailscompose-isinline-member)|Gets a value that indicates whether the attachment appears as an image in the body of the item instead of in the attachment list.| -||[name](/javascript/api/outlook/office.attachmentdetailscompose#outlook-office-attachmentdetailscompose-name-member)|Gets the name of the attachment.| -||[size](/javascript/api/outlook/office.attachmentdetailscompose#outlook-office-attachmentdetailscompose-size-member)|Gets the size of the attachment in bytes.| -||[url](/javascript/api/outlook/office.attachmentdetailscompose#outlook-office-attachmentdetailscompose-url-member)|Gets the url of the attachment if its type is `MailboxEnums.AttachmentType.Cloud`.| -|[AttachmentsChangedEventArgs](/javascript/api/outlook/office.attachmentschangedeventargs)|[attachmentDetails](/javascript/api/outlook/office.attachmentschangedeventargs#outlook-office-attachmentschangedeventargs-attachmentdetails-member)|Gets the object that represents the attachment that was added or removed from| -||[attachmentStatus](/javascript/api/outlook/office.attachmentschangedeventargs#outlook-office-attachmentschangedeventargs-attachmentstatus-member)|Specifies whether the attachment was added or removed from a mail item.| -||[type](/javascript/api/outlook/office.attachmentschangedeventargs#outlook-office-attachmentschangedeventargs-type-member)|Gets the type of event that was raised.| -|[Categories](/javascript/api/outlook/office.categories)|[addAsync(categories: string[], callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.categories#outlook-office-categories-addasync-member(1))|Adds categories to an item.| -||[addAsync(categories: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.categories#outlook-office-categories-addasync-member(1))|Adds categories to an item.| -||[getAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.categories#outlook-office-categories-getasync-member(1))|Gets an item's categories.| -||[getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.categories#outlook-office-categories-getasync-member(1))|Gets an item's categories.| -||[removeAsync(categories: string[], callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.categories#outlook-office-categories-removeasync-member(1))|Removes categories from an item.| -||[removeAsync(categories: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.categories#outlook-office-categories-removeasync-member(1))|Removes categories from an item.| -|[CategoryDetails](/javascript/api/outlook/office.categorydetails)|[color](/javascript/api/outlook/office.categorydetails#outlook-office-categorydetails-color-member)|The color of the category.| -||[displayName](/javascript/api/outlook/office.categorydetails#outlook-office-categorydetails-displayname-member)|The name of the category.| -|[EnhancedLocation](/javascript/api/outlook/office.enhancedlocation)|[addAsync(locationIdentifiers: LocationIdentifier[], callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.enhancedlocation#outlook-office-enhancedlocation-addasync-member(1))|Adds to the set of locations associated with the appointment.| -||[addAsync(locationIdentifiers: LocationIdentifier[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.enhancedlocation#outlook-office-enhancedlocation-addasync-member(1))|Adds to the set of locations associated with the appointment.| -||[getAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.enhancedlocation#outlook-office-enhancedlocation-getasync-member(1))|Gets the set of locations associated with the appointment.| -||[getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.enhancedlocation#outlook-office-enhancedlocation-getasync-member(1))|Gets the set of locations associated with the appointment.| -||[removeAsync(locationIdentifiers: LocationIdentifier[], callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.enhancedlocation#outlook-office-enhancedlocation-removeasync-member(1))|Removes the set of locations associated with the appointment.| -||[removeAsync(locationIdentifiers: LocationIdentifier[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.enhancedlocation#outlook-office-enhancedlocation-removeasync-member(1))|Removes the set of locations associated with the appointment.| -|[EnhancedLocationsChangedEventArgs](/javascript/api/outlook/office.enhancedlocationschangedeventargs)|[enhancedLocations](/javascript/api/outlook/office.enhancedlocationschangedeventargs#outlook-office-enhancedlocationschangedeventargs-enhancedlocations-member)|Gets the set of enhanced locations.| -||[type](/javascript/api/outlook/office.enhancedlocationschangedeventargs#outlook-office-enhancedlocationschangedeventargs-type-member)|Gets the type of the event.| -|[InternetHeaders](/javascript/api/outlook/office.internetheaders)|[getAsync(names: string[], callback: (asyncResult: Office.AsyncResult>) => void)](/javascript/api/outlook/office.internetheaders#outlook-office-internetheaders-getasync-member(1))|Given an array of internet header names, this method returns a record containing those internet headers and their values.| -||[getAsync(names: string[], options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult>) => void)](/javascript/api/outlook/office.internetheaders#outlook-office-internetheaders-getasync-member(1))|Given an array of internet header names, this method returns a record containing those internet headers and their values.| -||[removeAsync(names: string[], callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.internetheaders#outlook-office-internetheaders-removeasync-member(1))|Given an array of internet header names, this method removes the specified headers from the internet header collection.| -||[removeAsync(names: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.internetheaders#outlook-office-internetheaders-removeasync-member(1))|Given an array of internet header names, this method removes the specified headers from the internet header collection.| -||[setAsync(headers: Record, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.internetheaders#outlook-office-internetheaders-setasync-member(1))|Sets the specified internet headers to the specified values.| -||[setAsync(headers: Record, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.internetheaders#outlook-office-internetheaders-setasync-member(1))|Sets the specified internet headers to the specified values.| -|[LocationDetails](/javascript/api/outlook/office.locationdetails)|[displayName](/javascript/api/outlook/office.locationdetails#outlook-office-locationdetails-displayname-member)|The location's display name.| -||[emailAddress](/javascript/api/outlook/office.locationdetails#outlook-office-locationdetails-emailaddress-member)|The email address associated with the location.| -||[locationIdentifier](/javascript/api/outlook/office.locationdetails#outlook-office-locationdetails-locationidentifier-member)|The `LocationIdentifier` of the location.| -|[LocationIdentifier](/javascript/api/outlook/office.locationidentifier)|[id](/javascript/api/outlook/office.locationidentifier#outlook-office-locationidentifier-id-member)|The location's unique ID.| -||[type](/javascript/api/outlook/office.locationidentifier#outlook-office-locationidentifier-type-member)|The location's type.| -|[Mailbox](/javascript/api/outlook/office.mailbox)|[masterCategories](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-mastercategories-member)|Gets an object that provides methods to manage the categories master list associated with a mailbox.| -|[MasterCategories](/javascript/api/outlook/office.mastercategories)|[addAsync(categories: CategoryDetails[], callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.mastercategories#outlook-office-mastercategories-addasync-member(1))|Adds categories to the master list on a mailbox.| -||[addAsync(categories: CategoryDetails[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.mastercategories#outlook-office-mastercategories-addasync-member(1))|Adds categories to the master list on a mailbox.| -||[getAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.mastercategories#outlook-office-mastercategories-getasync-member(1))|Gets the master list of categories on a mailbox.| -||[getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.mastercategories#outlook-office-mastercategories-getasync-member(1))|Gets the master list of categories on a mailbox.| -||[removeAsync(categories: string[], callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.mastercategories#outlook-office-mastercategories-removeasync-member(1))|Removes categories from the master list on a mailbox.| -||[removeAsync(categories: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.mastercategories#outlook-office-mastercategories-removeasync-member(1))|Removes categories from the master list on a mailbox.| -|[MessageCompose](/javascript/api/outlook/office.messagecompose)|[addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-addfileattachmentfrombase64async-member(1))|Adds a file to a message or appointment as an attachment.| -||[addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-addfileattachmentfrombase64async-member(1))|Adds a file to a message or appointment as an attachment.| -||[categories](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-categories-member)|Gets an object that provides methods for managing the item's categories.| -||[getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-getattachmentcontentasync-member(1))|Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.| -||[getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-getattachmentcontentasync-member(1))|Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.| -||[getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-getattachmentsasync-member(1))|Gets the item's attachments as an array.| -||[getAttachmentsAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-getattachmentsasync-member(1))|Gets the item's attachments as an array.| -||[getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-getinitializationcontextasync-member(1))|Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.| -||[getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-getinitializationcontextasync-member(1))|Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.| -||[getItemIdAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-getitemidasync-member(1))|Asynchronously gets the {@link https://learn.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | Exchange Web Services (EWS) item identifier}| -||[getItemIdAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-getitemidasync-member(1))|Asynchronously gets the {@link https://learn.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | Exchange Web Services (EWS) item identifier}| -||[getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-getsharedpropertiesasync-member(1))|Gets the properties of an appointment or message in a shared folder or shared mailbox.| -||[getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-getsharedpropertiesasync-member(1))|Gets the properties of an appointment or message in a shared folder or shared mailbox.| -||[internetHeaders](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-internetheaders-member)|Gets or sets the custom internet headers of a message.| -|[MessageRead](/javascript/api/outlook/office.messageread)|[categories](/javascript/api/outlook/office.messageread#outlook-office-messageread-categories-member)|Gets an object that provides methods for managing the item's categories.| -||[getAllInternetHeadersAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messageread#outlook-office-messageread-getallinternetheadersasync-member(1))|Gets all the internet headers for the message as a string.| -||[getAllInternetHeadersAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messageread#outlook-office-messageread-getallinternetheadersasync-member(1))|Gets all the internet headers for the message as a string.| -||[getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messageread#outlook-office-messageread-getattachmentcontentasync-member(1))|Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.| -||[getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messageread#outlook-office-messageread-getattachmentcontentasync-member(1))|Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.| -||[getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messageread#outlook-office-messageread-getinitializationcontextasync-member(1))|Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.| -||[getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messageread#outlook-office-messageread-getinitializationcontextasync-member(1))|Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.| -||[getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messageread#outlook-office-messageread-getsharedpropertiesasync-member(1))|Gets the properties of an appointment or message in a shared folder or shared mailbox.| -||[getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messageread#outlook-office-messageread-getsharedpropertiesasync-member(1))|Gets the properties of an appointment or message in a shared folder or shared mailbox.| -|[SharedProperties](/javascript/api/outlook/office.sharedproperties)|[delegatePermissions](/javascript/api/outlook/office.sharedproperties#outlook-office-sharedproperties-delegatepermissions-member)|The permissions that the delegate has on a shared folder, or the user has on a shared mailbox.| -||[owner](/javascript/api/outlook/office.sharedproperties#outlook-office-sharedproperties-owner-member)|The email address of the owner of a shared item.| -||[targetMailbox](/javascript/api/outlook/office.sharedproperties#outlook-office-sharedproperties-targetmailbox-member)|The location of the owner's mailbox for the delegate's access.| -||[targetRestUrl](/javascript/api/outlook/office.sharedproperties#outlook-office-sharedproperties-targetresturl-member)|The REST API's base URL (currently `https://outlook.office.com/api`).| +|[AppointmentCompose](/.appointmentcompose)|[addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-addfileattachmentfrombase64async-member(1))|Adds a file to a message or appointment as an attachment.| +||[addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-addfileattachmentfrombase64async-member(1))|Adds a file to a message or appointment as an attachment.| +||[categories](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-categories-member)|Gets an object that provides methods for managing the item's categories.| +||[enhancedLocation](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-enhancedlocation-member)|Gets or sets the locations of the appointment.| +||[getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-getattachmentcontentasync-member(1))|Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.| +||[getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-getattachmentcontentasync-member(1))|Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.| +||[getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-getattachmentsasync-member(1))|Gets the item's attachments as an array.| +||[getAttachmentsAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-getattachmentsasync-member(1))|Gets the item's attachments as an array.| +||[getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-getinitializationcontextasync-member(1))|Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.| +||[getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-getinitializationcontextasync-member(1))|Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.| +||[getItemIdAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-getitemidasync-member(1))|Asynchronously gets the {@link https://learn.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | Exchange Web Services (EWS) item identifier}| +||[getItemIdAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-getitemidasync-member(1))|Asynchronously gets the {@link https://learn.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | Exchange Web Services (EWS) item identifier}| +||[getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-getsharedpropertiesasync-member(1))|Gets the properties of an appointment or message in a shared folder or shared mailbox.| +||[getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-getsharedpropertiesasync-member(1))|Gets the properties of an appointment or message in a shared folder or shared mailbox.| +|[AppointmentRead](/.appointmentread)|[categories](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-categories-member)|Gets an object that provides methods for managing the item's categories.| +||[enhancedLocation](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-enhancedlocation-member)|Gets the locations of an appointment.| +||[getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-getattachmentcontentasync-member(1))|Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.| +||[getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-getattachmentcontentasync-member(1))|Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.| +||[getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-getinitializationcontextasync-member(1))|Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.| +||[getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-getinitializationcontextasync-member(1))|Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.| +||[getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-getsharedpropertiesasync-member(1))|Gets the properties of an appointment or message in a shared folder or shared mailbox.| +||[getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-getsharedpropertiesasync-member(1))|Gets the properties of an appointment or message in a shared folder or shared mailbox.| +|[AttachmentContent](/.attachmentcontent)|[content](/.attachmentcontent#outlook-javascript/api/outlook/-attachmentcontent-content-member)|The content of an attachment as a string.| +||[format](/.attachmentcontent#outlook-javascript/api/outlook/-attachmentcontent-format-member)|The string format to use for an attachment's content.| +|[AttachmentDetailsCompose](/.attachmentdetailscompose)|[attachmentType](/.attachmentdetailscompose#outlook-javascript/api/outlook/-attachmentdetailscompose-attachmenttype-member)|Gets a value that indicates the attachment's type.| +||[id](/.attachmentdetailscompose#outlook-javascript/api/outlook/-attachmentdetailscompose-id-member)|Gets the index of the attachment.| +||[isInline](/.attachmentdetailscompose#outlook-javascript/api/outlook/-attachmentdetailscompose-isinline-member)|Gets a value that indicates whether the attachment appears as an image in the body of the item instead of in the attachment list.| +||[name](/.attachmentdetailscompose#outlook-javascript/api/outlook/-attachmentdetailscompose-name-member)|Gets the name of the attachment.| +||[size](/.attachmentdetailscompose#outlook-javascript/api/outlook/-attachmentdetailscompose-size-member)|Gets the size of the attachment in bytes.| +||[url](/.attachmentdetailscompose#outlook-javascript/api/outlook/-attachmentdetailscompose-url-member)|Gets the url of the attachment if its type is `MailboxEnums.AttachmentType.Cloud`.| +|[AttachmentsChangedEventArgs](/.attachmentschangedeventargs)|[attachmentDetails](/.attachmentschangedeventargs#outlook-javascript/api/outlook/-attachmentschangedeventargs-attachmentdetails-member)|Gets the object that represents the attachment that was added or removed from| +||[attachmentStatus](/.attachmentschangedeventargs#outlook-javascript/api/outlook/-attachmentschangedeventargs-attachmentstatus-member)|Specifies whether the attachment was added or removed from a mail item.| +||[type](/.attachmentschangedeventargs#outlook-javascript/api/outlook/-attachmentschangedeventargs-type-member)|Gets the type of event that was raised.| +|[Categories](/.categories)|[addAsync(categories: string[], callback?: (asyncResult: Office.AsyncResult) => void)](/.categories#outlook-javascript/api/outlook/-categories-addasync-member(1))|Adds categories to an item.| +||[addAsync(categories: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.categories#outlook-javascript/api/outlook/-categories-addasync-member(1))|Adds categories to an item.| +||[getAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.categories#outlook-javascript/api/outlook/-categories-getasync-member(1))|Gets an item's categories.| +||[getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.categories#outlook-javascript/api/outlook/-categories-getasync-member(1))|Gets an item's categories.| +||[removeAsync(categories: string[], callback?: (asyncResult: Office.AsyncResult) => void)](/.categories#outlook-javascript/api/outlook/-categories-removeasync-member(1))|Removes categories from an item.| +||[removeAsync(categories: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.categories#outlook-javascript/api/outlook/-categories-removeasync-member(1))|Removes categories from an item.| +|[CategoryDetails](/.categorydetails)|[color](/.categorydetails#outlook-javascript/api/outlook/-categorydetails-color-member)|The color of the category.| +||[displayName](/.categorydetails#outlook-javascript/api/outlook/-categorydetails-displayname-member)|The name of the category.| +|[EnhancedLocation](/.enhancedlocation)|[addAsync(locationIdentifiers: LocationIdentifier[], callback?: (asyncResult: Office.AsyncResult) => void)](/.enhancedlocation#outlook-javascript/api/outlook/-enhancedlocation-addasync-member(1))|Adds to the set of locations associated with the appointment.| +||[addAsync(locationIdentifiers: LocationIdentifier[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.enhancedlocation#outlook-javascript/api/outlook/-enhancedlocation-addasync-member(1))|Adds to the set of locations associated with the appointment.| +||[getAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/.enhancedlocation#outlook-javascript/api/outlook/-enhancedlocation-getasync-member(1))|Gets the set of locations associated with the appointment.| +||[getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.enhancedlocation#outlook-javascript/api/outlook/-enhancedlocation-getasync-member(1))|Gets the set of locations associated with the appointment.| +||[removeAsync(locationIdentifiers: LocationIdentifier[], callback?: (asyncResult: Office.AsyncResult) => void)](/.enhancedlocation#outlook-javascript/api/outlook/-enhancedlocation-removeasync-member(1))|Removes the set of locations associated with the appointment.| +||[removeAsync(locationIdentifiers: LocationIdentifier[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.enhancedlocation#outlook-javascript/api/outlook/-enhancedlocation-removeasync-member(1))|Removes the set of locations associated with the appointment.| +|[EnhancedLocationsChangedEventArgs](/.enhancedlocationschangedeventargs)|[enhancedLocations](/.enhancedlocationschangedeventargs#outlook-javascript/api/outlook/-enhancedlocationschangedeventargs-enhancedlocations-member)|Gets the set of enhanced locations.| +||[type](/.enhancedlocationschangedeventargs#outlook-javascript/api/outlook/-enhancedlocationschangedeventargs-type-member)|Gets the type of the event.| +|[InternetHeaders](/.internetheaders)|[getAsync(names: string[], callback: (asyncResult: Office.AsyncResult>) => void)](/.internetheaders#outlook-javascript/api/outlook/-internetheaders-getasync-member(1))|Given an array of internet header names, this method returns a record containing those internet headers and their values.| +||[getAsync(names: string[], options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult>) => void)](/.internetheaders#outlook-javascript/api/outlook/-internetheaders-getasync-member(1))|Given an array of internet header names, this method returns a record containing those internet headers and their values.| +||[removeAsync(names: string[], callback?: (asyncResult: Office.AsyncResult) => void)](/.internetheaders#outlook-javascript/api/outlook/-internetheaders-removeasync-member(1))|Given an array of internet header names, this method removes the specified headers from the internet header collection.| +||[removeAsync(names: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.internetheaders#outlook-javascript/api/outlook/-internetheaders-removeasync-member(1))|Given an array of internet header names, this method removes the specified headers from the internet header collection.| +||[setAsync(headers: Record, callback?: (asyncResult: Office.AsyncResult) => void)](/.internetheaders#outlook-javascript/api/outlook/-internetheaders-setasync-member(1))|Sets the specified internet headers to the specified values.| +||[setAsync(headers: Record, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.internetheaders#outlook-javascript/api/outlook/-internetheaders-setasync-member(1))|Sets the specified internet headers to the specified values.| +|[LocationDetails](/.locationdetails)|[displayName](/.locationdetails#outlook-javascript/api/outlook/-locationdetails-displayname-member)|The location's display name.| +||[emailAddress](/.locationdetails#outlook-javascript/api/outlook/-locationdetails-emailaddress-member)|The email address associated with the location.| +||[locationIdentifier](/.locationdetails#outlook-javascript/api/outlook/-locationdetails-locationidentifier-member)|The `LocationIdentifier` of the location.| +|[LocationIdentifier](/.locationidentifier)|[id](/.locationidentifier#outlook-javascript/api/outlook/-locationidentifier-id-member)|The location's unique ID.| +||[type](/.locationidentifier#outlook-javascript/api/outlook/-locationidentifier-type-member)|The location's type.| +|[Mailbox](/.mailbox)|[masterCategories](/.mailbox#outlook-javascript/api/outlook/-mailbox-mastercategories-member)|Gets an object that provides methods to manage the categories master list associated with a mailbox.| +|[MasterCategories](/.mastercategories)|[addAsync(categories: CategoryDetails[], callback?: (asyncResult: Office.AsyncResult) => void)](/.mastercategories#outlook-javascript/api/outlook/-mastercategories-addasync-member(1))|Adds categories to the master list on a mailbox.| +||[addAsync(categories: CategoryDetails[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.mastercategories#outlook-javascript/api/outlook/-mastercategories-addasync-member(1))|Adds categories to the master list on a mailbox.| +||[getAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.mastercategories#outlook-javascript/api/outlook/-mastercategories-getasync-member(1))|Gets the master list of categories on a mailbox.| +||[getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.mastercategories#outlook-javascript/api/outlook/-mastercategories-getasync-member(1))|Gets the master list of categories on a mailbox.| +||[removeAsync(categories: string[], callback?: (asyncResult: Office.AsyncResult) => void)](/.mastercategories#outlook-javascript/api/outlook/-mastercategories-removeasync-member(1))|Removes categories from the master list on a mailbox.| +||[removeAsync(categories: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.mastercategories#outlook-javascript/api/outlook/-mastercategories-removeasync-member(1))|Removes categories from the master list on a mailbox.| +|[MessageCompose](/.messagecompose)|[addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-addfileattachmentfrombase64async-member(1))|Adds a file to a message or appointment as an attachment.| +||[addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-addfileattachmentfrombase64async-member(1))|Adds a file to a message or appointment as an attachment.| +||[categories](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-categories-member)|Gets an object that provides methods for managing the item's categories.| +||[getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-getattachmentcontentasync-member(1))|Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.| +||[getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-getattachmentcontentasync-member(1))|Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.| +||[getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-getattachmentsasync-member(1))|Gets the item's attachments as an array.| +||[getAttachmentsAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-getattachmentsasync-member(1))|Gets the item's attachments as an array.| +||[getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-getinitializationcontextasync-member(1))|Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.| +||[getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-getinitializationcontextasync-member(1))|Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.| +||[getItemIdAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-getitemidasync-member(1))|Asynchronously gets the {@link https://learn.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | Exchange Web Services (EWS) item identifier}| +||[getItemIdAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-getitemidasync-member(1))|Asynchronously gets the {@link https://learn.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | Exchange Web Services (EWS) item identifier}| +||[getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-getsharedpropertiesasync-member(1))|Gets the properties of an appointment or message in a shared folder or shared mailbox.| +||[getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-getsharedpropertiesasync-member(1))|Gets the properties of an appointment or message in a shared folder or shared mailbox.| +||[internetHeaders](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-internetheaders-member)|Gets or sets the custom internet headers of a message.| +|[MessageRead](/.messageread)|[categories](/.messageread#outlook-javascript/api/outlook/-messageread-categories-member)|Gets an object that provides methods for managing the item's categories.| +||[getAllInternetHeadersAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/.messageread#outlook-javascript/api/outlook/-messageread-getallinternetheadersasync-member(1))|Gets all the internet headers for the message as a string.| +||[getAllInternetHeadersAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.messageread#outlook-javascript/api/outlook/-messageread-getallinternetheadersasync-member(1))|Gets all the internet headers for the message as a string.| +||[getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.messageread#outlook-javascript/api/outlook/-messageread-getattachmentcontentasync-member(1))|Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.| +||[getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.messageread#outlook-javascript/api/outlook/-messageread-getattachmentcontentasync-member(1))|Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.| +||[getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.messageread#outlook-javascript/api/outlook/-messageread-getinitializationcontextasync-member(1))|Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.| +||[getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.messageread#outlook-javascript/api/outlook/-messageread-getinitializationcontextasync-member(1))|Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.| +||[getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.messageread#outlook-javascript/api/outlook/-messageread-getsharedpropertiesasync-member(1))|Gets the properties of an appointment or message in a shared folder or shared mailbox.| +||[getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.messageread#outlook-javascript/api/outlook/-messageread-getsharedpropertiesasync-member(1))|Gets the properties of an appointment or message in a shared folder or shared mailbox.| +|[SharedProperties](/.sharedproperties)|[delegatePermissions](/.sharedproperties#outlook-javascript/api/outlook/-sharedproperties-delegatepermissions-member)|The permissions that the delegate has on a shared folder, or the user has on a shared mailbox.| +||[owner](/.sharedproperties#outlook-javascript/api/outlook/-sharedproperties-owner-member)|The email address of the owner of a shared item.| +||[targetMailbox](/.sharedproperties#outlook-javascript/api/outlook/-sharedproperties-targetmailbox-member)|The location of the owner's mailbox for the delegate's access.| +||[targetRestUrl](/.sharedproperties#outlook-javascript/api/outlook/-sharedproperties-targetresturl-member)|The REST API's base URL (currently `https://outlook.office.com/api`).| diff --git a/docs/includes/outlook-1_9.md b/docs/includes/outlook-1_9.md index fc97e7686d..b9f4128593 100644 --- a/docs/includes/outlook-1_9.md +++ b/docs/includes/outlook-1_9.md @@ -1,21 +1,21 @@ | Class | Fields | Description | |:---|:---|:---| -|[AppointmentRead](/javascript/api/outlook/office.appointmentread)|[displayReplyAllFormAsync(formData: string \| ReplyFormData, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-displayreplyallformasync-member(1))|Displays a reply form that includes either the sender and all recipients of the selected message or the organizer and all attendees of the| -||[displayReplyAllFormAsync(formData: string \| ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-displayreplyallformasync-member(1))|Displays a reply form that includes either the sender and all recipients of the selected message or the organizer and all attendees of the| -||[displayReplyFormAsync(formData: string \| ReplyFormData, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-displayreplyformasync-member(1))|Displays a reply form that includes only the sender of the selected message or the organizer of the selected appointment.| -||[displayReplyFormAsync(formData: string \| ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-displayreplyformasync-member(1))|Displays a reply form that includes only the sender of the selected message or the organizer of the selected appointment.| -|[Body](/javascript/api/outlook/office.body)|[appendOnSendAsync(data: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.body#outlook-office-body-appendonsendasync-member(1))|Appends on send the specified content to the end of the item body, after any signature.| -||[appendOnSendAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.body#outlook-office-body-appendonsendasync-member(1))|Appends on send the specified content to the end of the item body, after any signature.| -|[CustomProperties](/javascript/api/outlook/office.customproperties)|[getAll()](/javascript/api/outlook/office.customproperties#outlook-office-customproperties-getall-member(1))|Returns an object with all custom properties in a collection of name/value pairs.| -|[Mailbox](/javascript/api/outlook/office.mailbox)|[displayAppointmentFormAsync(itemId: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-displayappointmentformasync-member(1))|Displays an existing calendar appointment.| -||[displayAppointmentFormAsync(itemId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-displayappointmentformasync-member(1))|Displays an existing calendar appointment.| -||[displayMessageFormAsync(itemId: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-displaymessageformasync-member(1))|Displays an existing message.| -||[displayMessageFormAsync(itemId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-displaymessageformasync-member(1))|Displays an existing message.| -||[displayNewAppointmentFormAsync(parameters: AppointmentForm, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-displaynewappointmentformasync-member(1))|Displays a form for creating a new calendar appointment.| -||[displayNewAppointmentFormAsync(parameters: AppointmentForm, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-displaynewappointmentformasync-member(1))|Displays a form for creating a new calendar appointment.| -||[displayNewMessageFormAsync(parameters: any, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-displaynewmessageformasync-member(1))|Displays a form for creating a new message.| -||[displayNewMessageFormAsync(parameters: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-displaynewmessageformasync-member(1))|Displays a form for creating a new message.| -|[MessageRead](/javascript/api/outlook/office.messageread)|[displayReplyAllFormAsync(formData: string \| ReplyFormData, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messageread#outlook-office-messageread-displayreplyallformasync-member(1))|Displays a reply form that includes either the sender and all recipients of the selected message or the organizer and all attendees of the| -||[displayReplyAllFormAsync(formData: string \| ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messageread#outlook-office-messageread-displayreplyallformasync-member(1))|Displays a reply form that includes either the sender and all recipients of the selected message or the organizer and all attendees of the| -||[displayReplyFormAsync(formData: string \| ReplyFormData, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messageread#outlook-office-messageread-displayreplyformasync-member(1))|Displays a reply form that includes only the sender of the selected message or the organizer of the selected appointment.| -||[displayReplyFormAsync(formData: string \| ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messageread#outlook-office-messageread-displayreplyformasync-member(1))|Displays a reply form that includes only the sender of the selected message or the organizer of the selected appointment.| +|[AppointmentRead](/.appointmentread)|[displayReplyAllFormAsync(formData: string \| ReplyFormData, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-displayreplyallformasync-member(1))|Displays a reply form that includes either the sender and all recipients of the selected message or the organizer and all attendees of the| +||[displayReplyAllFormAsync(formData: string \| ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-displayreplyallformasync-member(1))|Displays a reply form that includes either the sender and all recipients of the selected message or the organizer and all attendees of the| +||[displayReplyFormAsync(formData: string \| ReplyFormData, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-displayreplyformasync-member(1))|Displays a reply form that includes only the sender of the selected message or the organizer of the selected appointment.| +||[displayReplyFormAsync(formData: string \| ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-displayreplyformasync-member(1))|Displays a reply form that includes only the sender of the selected message or the organizer of the selected appointment.| +|[Body](/.body)|[appendOnSendAsync(data: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.body#outlook-javascript/api/outlook/-body-appendonsendasync-member(1))|Appends on send the specified content to the end of the item body, after any signature.| +||[appendOnSendAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.body#outlook-javascript/api/outlook/-body-appendonsendasync-member(1))|Appends on send the specified content to the end of the item body, after any signature.| +|[CustomProperties](/.customproperties)|[getAll()](/.customproperties#outlook-javascript/api/outlook/-customproperties-getall-member(1))|Returns an object with all custom properties in a collection of name/value pairs.| +|[Mailbox](/.mailbox)|[displayAppointmentFormAsync(itemId: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.mailbox#outlook-javascript/api/outlook/-mailbox-displayappointmentformasync-member(1))|Displays an existing calendar appointment.| +||[displayAppointmentFormAsync(itemId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.mailbox#outlook-javascript/api/outlook/-mailbox-displayappointmentformasync-member(1))|Displays an existing calendar appointment.| +||[displayMessageFormAsync(itemId: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.mailbox#outlook-javascript/api/outlook/-mailbox-displaymessageformasync-member(1))|Displays an existing message.| +||[displayMessageFormAsync(itemId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.mailbox#outlook-javascript/api/outlook/-mailbox-displaymessageformasync-member(1))|Displays an existing message.| +||[displayNewAppointmentFormAsync(parameters: AppointmentForm, callback?: (asyncResult: Office.AsyncResult) => void)](/.mailbox#outlook-javascript/api/outlook/-mailbox-displaynewappointmentformasync-member(1))|Displays a form for creating a new calendar appointment.| +||[displayNewAppointmentFormAsync(parameters: AppointmentForm, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.mailbox#outlook-javascript/api/outlook/-mailbox-displaynewappointmentformasync-member(1))|Displays a form for creating a new calendar appointment.| +||[displayNewMessageFormAsync(parameters: any, callback?: (asyncResult: Office.AsyncResult) => void)](/.mailbox#outlook-javascript/api/outlook/-mailbox-displaynewmessageformasync-member(1))|Displays a form for creating a new message.| +||[displayNewMessageFormAsync(parameters: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.mailbox#outlook-javascript/api/outlook/-mailbox-displaynewmessageformasync-member(1))|Displays a form for creating a new message.| +|[MessageRead](/.messageread)|[displayReplyAllFormAsync(formData: string \| ReplyFormData, callback?: (asyncResult: Office.AsyncResult) => void)](/.messageread#outlook-javascript/api/outlook/-messageread-displayreplyallformasync-member(1))|Displays a reply form that includes either the sender and all recipients of the selected message or the organizer and all attendees of the| +||[displayReplyAllFormAsync(formData: string \| ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.messageread#outlook-javascript/api/outlook/-messageread-displayreplyallformasync-member(1))|Displays a reply form that includes either the sender and all recipients of the selected message or the organizer and all attendees of the| +||[displayReplyFormAsync(formData: string \| ReplyFormData, callback?: (asyncResult: Office.AsyncResult) => void)](/.messageread#outlook-javascript/api/outlook/-messageread-displayreplyformasync-member(1))|Displays a reply form that includes only the sender of the selected message or the organizer of the selected appointment.| +||[displayReplyFormAsync(formData: string \| ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.messageread#outlook-javascript/api/outlook/-messageread-displayreplyformasync-member(1))|Displays a reply form that includes only the sender of the selected message or the organizer of the selected appointment.| diff --git a/docs/includes/outlook-preview.md b/docs/includes/outlook-preview.md index 21f1a57fe5..e7412de771 100644 --- a/docs/includes/outlook-preview.md +++ b/docs/includes/outlook-preview.md @@ -1,15 +1,15 @@ | Class | Fields | Description | |:---|:---|:---| -|[AppointmentCompose](/javascript/api/outlook/office.appointmentcompose)|[isAllDayEvent](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-isalldayevent-member)|Gets or sets the Office.IsAllDayEvent property of an appointment.| -|[AppointmentRead](/javascript/api/outlook/office.appointmentread)|[isAllDayEvent](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-isalldayevent-member)|Returns a boolean value indicating whether the event is all day.| -|[Display](/javascript/api/outlook/office.display)|[body](/javascript/api/outlook/office.display#outlook-office-display-body-member)|Gets an object to temporarily set the content displayed in the body of a message in read mode.| -||[subject](/javascript/api/outlook/office.display#outlook-office-display-subject-member)|Gets an object to temporarily set the content displayed in the subject of a message in read mode.| -|[DisplayedBody](/javascript/api/outlook/office.displayedbody)|[setAsync(data: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.displayedbody#outlook-office-displayedbody-setasync-member(1))|Temporarily sets the content displayed in the body of a message in read mode.| -||[setAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.displayedbody#outlook-office-displayedbody-setasync-member(1))|Temporarily sets the content displayed in the body of a message in read mode.| -|[DisplayedSubject](/javascript/api/outlook/office.displayedsubject)|[setAsync(data: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.displayedsubject#outlook-office-displayedsubject-setasync-member(1))|Temporarily sets the content displayed in the subject of a message in read mode.| -||[setAsync(data: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.displayedsubject#outlook-office-displayedsubject-setasync-member(1))|Temporarily sets the content displayed in the subject of a message in read mode.| -|[IsAllDayEvent](/javascript/api/outlook/office.isalldayevent)|[getAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.isalldayevent#outlook-office-isalldayevent-getasync-member(1))|Gets the boolean value indicating whether the event is all day or not.| -||[getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.isalldayevent#outlook-office-isalldayevent-getasync-member(1))|Gets the boolean value indicating whether the event is all day or not.| -||[setAsync(isAllDayEvent: boolean, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.isalldayevent#outlook-office-isalldayevent-setasync-member(1))|Sets the all-day event status of an appointment.| -||[setAsync(isAllDayEvent: boolean, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.isalldayevent#outlook-office-isalldayevent-setasync-member(1))|Sets the all-day event status of an appointment.| -|[MessageRead](/javascript/api/outlook/office.messageread)|[display](/javascript/api/outlook/office.messageread#outlook-office-messageread-display-member)|Gets an object to temporarily set the content displayed in the body or subject of a message in read mode.| +|[AppointmentCompose](/.appointmentcompose)|[isAllDayEvent](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-isalldayevent-member)|Gets or sets the Office.IsAllDayEvent property of an appointment.| +|[AppointmentRead](/.appointmentread)|[isAllDayEvent](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-isalldayevent-member)|Returns a boolean value indicating whether the event is all day.| +|[Display](/.display)|[body](/.display#outlook-javascript/api/outlook/-display-body-member)|Gets an object to temporarily set the content displayed in the body of a message in read mode.| +||[subject](/.display#outlook-javascript/api/outlook/-display-subject-member)|Gets an object to temporarily set the content displayed in the subject of a message in read mode.| +|[DisplayedBody](/.displayedbody)|[setAsync(data: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.displayedbody#outlook-javascript/api/outlook/-displayedbody-setasync-member(1))|Temporarily sets the content displayed in the body of a message in read mode.| +||[setAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.displayedbody#outlook-javascript/api/outlook/-displayedbody-setasync-member(1))|Temporarily sets the content displayed in the body of a message in read mode.| +|[DisplayedSubject](/.displayedsubject)|[setAsync(data: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.displayedsubject#outlook-javascript/api/outlook/-displayedsubject-setasync-member(1))|Temporarily sets the content displayed in the subject of a message in read mode.| +||[setAsync(data: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.displayedsubject#outlook-javascript/api/outlook/-displayedsubject-setasync-member(1))|Temporarily sets the content displayed in the subject of a message in read mode.| +|[IsAllDayEvent](/.isalldayevent)|[getAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.isalldayevent#outlook-javascript/api/outlook/-isalldayevent-getasync-member(1))|Gets the boolean value indicating whether the event is all day or not.| +||[getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.isalldayevent#outlook-javascript/api/outlook/-isalldayevent-getasync-member(1))|Gets the boolean value indicating whether the event is all day or not.| +||[setAsync(isAllDayEvent: boolean, callback?: (asyncResult: Office.AsyncResult) => void)](/.isalldayevent#outlook-javascript/api/outlook/-isalldayevent-setasync-member(1))|Sets the all-day event status of an appointment.| +||[setAsync(isAllDayEvent: boolean, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.isalldayevent#outlook-javascript/api/outlook/-isalldayevent-setasync-member(1))|Sets the all-day event status of an appointment.| +|[MessageRead](/.messageread)|[display](/.messageread#outlook-javascript/api/outlook/-messageread-display-member)|Gets an object to temporarily set the content displayed in the body or subject of a message in read mode.| diff --git a/docs/includes/powerpoint-1_1.md b/docs/includes/powerpoint-1_1.md index 81cd966fe4..3234af6236 100644 --- a/docs/includes/powerpoint-1_1.md +++ b/docs/includes/powerpoint-1_1.md @@ -1,3 +1,3 @@ | Class | Fields | Description | |:---|:---|:---| -|*global*|[createPresentation(base64File?: string)](/javascript/api/powerpoint/powerpoint#createpresentation)|Creates and opens a new presentation.| +|*global*|[createPresentation(base64File?: string)](/#powerpoint-javascript/api/powerpoint/-createpresentation-function(1))|Creates and opens a new presentation.| diff --git a/docs/includes/powerpoint-1_2.md b/docs/includes/powerpoint-1_2.md index 04f464e6ce..2d5b9fa749 100644 --- a/docs/includes/powerpoint-1_2.md +++ b/docs/includes/powerpoint-1_2.md @@ -1,14 +1,14 @@ | Class | Fields | Description | |:---|:---|:---| -|[InsertSlideOptions](/javascript/api/powerpoint/powerpoint.insertslideoptions)|[formatting](/javascript/api/powerpoint/powerpoint.insertslideoptions#powerpoint-powerpoint-insertslideoptions-formatting-member)|Specifies which formatting to use during slide insertion.| -||[sourceSlideIds](/javascript/api/powerpoint/powerpoint.insertslideoptions#powerpoint-powerpoint-insertslideoptions-sourceslideids-member)|Specifies the slides from the source presentation that will be inserted into the current presentation.| -||[targetSlideId](/javascript/api/powerpoint/powerpoint.insertslideoptions#powerpoint-powerpoint-insertslideoptions-targetslideid-member)|Specifies where in the presentation the new slides will be inserted.| -|[Presentation](/javascript/api/powerpoint/powerpoint.presentation)|[insertSlidesFromBase64(base64File: string, options?: PowerPoint.InsertSlideOptions)](/javascript/api/powerpoint/powerpoint.presentation#powerpoint-powerpoint-presentation-insertslidesfrombase64-member(1))|Inserts the specified slides from a presentation into the current presentation.| -||[slides](/javascript/api/powerpoint/powerpoint.presentation#powerpoint-powerpoint-presentation-slides-member)|Returns an ordered collection of slides in the presentation.| -|[Slide](/javascript/api/powerpoint/powerpoint.slide)|[delete()](/javascript/api/powerpoint/powerpoint.slide#powerpoint-powerpoint-slide-delete-member(1))|Deletes the slide from the presentation.| -||[id](/javascript/api/powerpoint/powerpoint.slide#powerpoint-powerpoint-slide-id-member)|Gets the unique ID of the slide.| -|[SlideCollection](/javascript/api/powerpoint/powerpoint.slidecollection)|[getCount()](/javascript/api/powerpoint/powerpoint.slidecollection#powerpoint-powerpoint-slidecollection-getcount-member(1))|Gets the number of slides in the collection.| -||[getItem(key: string)](/javascript/api/powerpoint/powerpoint.slidecollection#powerpoint-powerpoint-slidecollection-getitem-member(1))|Gets a slide using its unique ID.| -||[getItemAt(index: number)](/javascript/api/powerpoint/powerpoint.slidecollection#powerpoint-powerpoint-slidecollection-getitemat-member(1))|Gets a slide using its zero-based index in the collection.| -||[getItemOrNullObject(id: string)](/javascript/api/powerpoint/powerpoint.slidecollection#powerpoint-powerpoint-slidecollection-getitemornullobject-member(1))|Gets a slide using its unique ID.| -||[items](/javascript/api/powerpoint/powerpoint.slidecollection#powerpoint-powerpoint-slidecollection-items-member)|Gets the loaded child items in this collection.| +|[InsertSlideOptions](/.insertslideoptions)|[formatting](/.insertslideoptions#powerpoint-javascript/api/powerpoint/-insertslideoptions-formatting-member)|Specifies which formatting to use during slide insertion.| +||[sourceSlideIds](/.insertslideoptions#powerpoint-javascript/api/powerpoint/-insertslideoptions-sourceslideids-member)|Specifies the slides from the source presentation that will be inserted into the current presentation.| +||[targetSlideId](/.insertslideoptions#powerpoint-javascript/api/powerpoint/-insertslideoptions-targetslideid-member)|Specifies where in the presentation the new slides will be inserted.| +|[Presentation](/.presentation)|[insertSlidesFromBase64(base64File: string, options?: PowerPoint.InsertSlideOptions)](/.presentation#powerpoint-javascript/api/powerpoint/-presentation-insertslidesfrombase64-member(1))|Inserts the specified slides from a presentation into the current presentation.| +||[slides](/.presentation#powerpoint-javascript/api/powerpoint/-presentation-slides-member)|Returns an ordered collection of slides in the presentation.| +|[Slide](/.slide)|[delete()](/.slide#powerpoint-javascript/api/powerpoint/-slide-delete-member(1))|Deletes the slide from the presentation.| +||[id](/.slide#powerpoint-javascript/api/powerpoint/-slide-id-member)|Gets the unique ID of the slide.| +|[SlideCollection](/.slidecollection)|[getCount()](/.slidecollection#powerpoint-javascript/api/powerpoint/-slidecollection-getcount-member(1))|Gets the number of slides in the collection.| +||[getItem(key: string)](/.slidecollection#powerpoint-javascript/api/powerpoint/-slidecollection-getitem-member(1))|Gets a slide using its unique ID.| +||[getItemAt(index: number)](/.slidecollection#powerpoint-javascript/api/powerpoint/-slidecollection-getitemat-member(1))|Gets a slide using its zero-based index in the collection.| +||[getItemOrNullObject(id: string)](/.slidecollection#powerpoint-javascript/api/powerpoint/-slidecollection-getitemornullobject-member(1))|Gets a slide using its unique ID.| +||[items](/.slidecollection#powerpoint-javascript/api/powerpoint/-slidecollection-items-member)|Gets the loaded child items in this collection.| diff --git a/docs/includes/powerpoint-1_3.md b/docs/includes/powerpoint-1_3.md index 280868c8e1..52255cf26a 100644 --- a/docs/includes/powerpoint-1_3.md +++ b/docs/includes/powerpoint-1_3.md @@ -1,45 +1,45 @@ | Class | Fields | Description | |:---|:---|:---| -|[AddSlideOptions](/javascript/api/powerpoint/powerpoint.addslideoptions)|[layoutId](/javascript/api/powerpoint/powerpoint.addslideoptions#powerpoint-powerpoint-addslideoptions-layoutid-member)|Specifies the ID of a Slide Layout to be used for the new slide.| -||[slideMasterId](/javascript/api/powerpoint/powerpoint.addslideoptions#powerpoint-powerpoint-addslideoptions-slidemasterid-member)|Specifies the ID of a Slide Master to be used for the new slide.| -|[Presentation](/javascript/api/powerpoint/powerpoint.presentation)|[slideMasters](/javascript/api/powerpoint/powerpoint.presentation#powerpoint-powerpoint-presentation-slidemasters-member)|Returns the collection of `SlideMaster` objects that are in the presentation.| -||[tags](/javascript/api/powerpoint/powerpoint.presentation#powerpoint-powerpoint-presentation-tags-member)|Returns a collection of tags attached to the presentation.| -|[Shape](/javascript/api/powerpoint/powerpoint.shape)|[delete()](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-delete-member(1))|Deletes the shape from the shape collection.| -||[id](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-id-member)|Gets the unique ID of the shape.| -||[tags](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-tags-member)|Returns a collection of tags in the shape.| -|[ShapeCollection](/javascript/api/powerpoint/powerpoint.shapecollection)|[getCount()](/javascript/api/powerpoint/powerpoint.shapecollection#powerpoint-powerpoint-shapecollection-getcount-member(1))|Gets the number of shapes in the collection.| -||[getItem(key: string)](/javascript/api/powerpoint/powerpoint.shapecollection#powerpoint-powerpoint-shapecollection-getitem-member(1))|Gets a shape using its unique ID.| -||[getItemAt(index: number)](/javascript/api/powerpoint/powerpoint.shapecollection#powerpoint-powerpoint-shapecollection-getitemat-member(1))|Gets a shape using its zero-based index in the collection.| -||[getItemOrNullObject(id: string)](/javascript/api/powerpoint/powerpoint.shapecollection#powerpoint-powerpoint-shapecollection-getitemornullobject-member(1))|Gets a shape using its unique ID.| -||[items](/javascript/api/powerpoint/powerpoint.shapecollection#powerpoint-powerpoint-shapecollection-items-member)|Gets the loaded child items in this collection.| -|[Slide](/javascript/api/powerpoint/powerpoint.slide)|[layout](/javascript/api/powerpoint/powerpoint.slide#powerpoint-powerpoint-slide-layout-member)|Gets the layout of the slide.| -||[shapes](/javascript/api/powerpoint/powerpoint.slide#powerpoint-powerpoint-slide-shapes-member)|Returns a collection of shapes in the slide.| -||[slideMaster](/javascript/api/powerpoint/powerpoint.slide#powerpoint-powerpoint-slide-slidemaster-member)|Gets the `SlideMaster` object that represents the slide's default content.| -||[tags](/javascript/api/powerpoint/powerpoint.slide#powerpoint-powerpoint-slide-tags-member)|Returns a collection of tags in the slide.| -|[SlideCollection](/javascript/api/powerpoint/powerpoint.slidecollection)|[add(options?: PowerPoint.AddSlideOptions)](/javascript/api/powerpoint/powerpoint.slidecollection#powerpoint-powerpoint-slidecollection-add-member(1))|Adds a new slide at the end of the collection.| -|[SlideLayout](/javascript/api/powerpoint/powerpoint.slidelayout)|[id](/javascript/api/powerpoint/powerpoint.slidelayout#powerpoint-powerpoint-slidelayout-id-member)|Gets the unique ID of the slide layout.| -||[name](/javascript/api/powerpoint/powerpoint.slidelayout#powerpoint-powerpoint-slidelayout-name-member)|Gets the name of the slide layout.| -||[shapes](/javascript/api/powerpoint/powerpoint.slidelayout#powerpoint-powerpoint-slidelayout-shapes-member)|Returns a collection of shapes in the slide layout.| -|[SlideLayoutCollection](/javascript/api/powerpoint/powerpoint.slidelayoutcollection)|[getCount()](/javascript/api/powerpoint/powerpoint.slidelayoutcollection#powerpoint-powerpoint-slidelayoutcollection-getcount-member(1))|Gets the number of layouts in the collection.| -||[getItem(key: string)](/javascript/api/powerpoint/powerpoint.slidelayoutcollection#powerpoint-powerpoint-slidelayoutcollection-getitem-member(1))|Gets a layout using its unique ID.| -||[getItemAt(index: number)](/javascript/api/powerpoint/powerpoint.slidelayoutcollection#powerpoint-powerpoint-slidelayoutcollection-getitemat-member(1))|Gets a layout using its zero-based index in the collection.| -||[getItemOrNullObject(id: string)](/javascript/api/powerpoint/powerpoint.slidelayoutcollection#powerpoint-powerpoint-slidelayoutcollection-getitemornullobject-member(1))|Gets a layout using its unique ID.| -||[items](/javascript/api/powerpoint/powerpoint.slidelayoutcollection#powerpoint-powerpoint-slidelayoutcollection-items-member)|Gets the loaded child items in this collection.| -|[SlideMaster](/javascript/api/powerpoint/powerpoint.slidemaster)|[id](/javascript/api/powerpoint/powerpoint.slidemaster#powerpoint-powerpoint-slidemaster-id-member)|Gets the unique ID of the Slide Master.| -||[layouts](/javascript/api/powerpoint/powerpoint.slidemaster#powerpoint-powerpoint-slidemaster-layouts-member)|Gets the collection of layouts provided by the Slide Master for slides.| -||[name](/javascript/api/powerpoint/powerpoint.slidemaster#powerpoint-powerpoint-slidemaster-name-member)|Gets the unique name of the Slide Master.| -||[shapes](/javascript/api/powerpoint/powerpoint.slidemaster#powerpoint-powerpoint-slidemaster-shapes-member)|Returns a collection of shapes in the Slide Master.| -|[SlideMasterCollection](/javascript/api/powerpoint/powerpoint.slidemastercollection)|[getCount()](/javascript/api/powerpoint/powerpoint.slidemastercollection#powerpoint-powerpoint-slidemastercollection-getcount-member(1))|Gets the number of Slide Masters in the collection.| -||[getItem(key: string)](/javascript/api/powerpoint/powerpoint.slidemastercollection#powerpoint-powerpoint-slidemastercollection-getitem-member(1))|Gets a Slide Master using its unique ID.| -||[getItemAt(index: number)](/javascript/api/powerpoint/powerpoint.slidemastercollection#powerpoint-powerpoint-slidemastercollection-getitemat-member(1))|Gets a Slide Master using its zero-based index in the collection.| -||[getItemOrNullObject(id: string)](/javascript/api/powerpoint/powerpoint.slidemastercollection#powerpoint-powerpoint-slidemastercollection-getitemornullobject-member(1))|Gets a Slide Master using its unique ID.| -||[items](/javascript/api/powerpoint/powerpoint.slidemastercollection#powerpoint-powerpoint-slidemastercollection-items-member)|Gets the loaded child items in this collection.| -|[Tag](/javascript/api/powerpoint/powerpoint.tag)|[key](/javascript/api/powerpoint/powerpoint.tag#powerpoint-powerpoint-tag-key-member)|Gets the unique ID of the tag.| -||[value](/javascript/api/powerpoint/powerpoint.tag#powerpoint-powerpoint-tag-value-member)|Gets the value of the tag.| -|[TagCollection](/javascript/api/powerpoint/powerpoint.tagcollection)|[add(key: string, value: string)](/javascript/api/powerpoint/powerpoint.tagcollection#powerpoint-powerpoint-tagcollection-add-member(1))|Adds a new tag at the end of the collection.| -||[delete(key: string)](/javascript/api/powerpoint/powerpoint.tagcollection#powerpoint-powerpoint-tagcollection-delete-member(1))|Deletes the tag with the given `key` in this collection.| -||[getCount()](/javascript/api/powerpoint/powerpoint.tagcollection#powerpoint-powerpoint-tagcollection-getcount-member(1))|Gets the number of tags in the collection.| -||[getItem(key: string)](/javascript/api/powerpoint/powerpoint.tagcollection#powerpoint-powerpoint-tagcollection-getitem-member(1))|Gets a tag using its unique ID.| -||[getItemAt(index: number)](/javascript/api/powerpoint/powerpoint.tagcollection#powerpoint-powerpoint-tagcollection-getitemat-member(1))|Gets a tag using its zero-based index in the collection.| -||[getItemOrNullObject(key: string)](/javascript/api/powerpoint/powerpoint.tagcollection#powerpoint-powerpoint-tagcollection-getitemornullobject-member(1))|Gets a tag using its unique ID.| -||[items](/javascript/api/powerpoint/powerpoint.tagcollection#powerpoint-powerpoint-tagcollection-items-member)|Gets the loaded child items in this collection.| +|[AddSlideOptions](/.addslideoptions)|[layoutId](/.addslideoptions#powerpoint-javascript/api/powerpoint/-addslideoptions-layoutid-member)|Specifies the ID of a Slide Layout to be used for the new slide.| +||[slideMasterId](/.addslideoptions#powerpoint-javascript/api/powerpoint/-addslideoptions-slidemasterid-member)|Specifies the ID of a Slide Master to be used for the new slide.| +|[Presentation](/.presentation)|[slideMasters](/.presentation#powerpoint-javascript/api/powerpoint/-presentation-slidemasters-member)|Returns the collection of `SlideMaster` objects that are in the presentation.| +||[tags](/.presentation#powerpoint-javascript/api/powerpoint/-presentation-tags-member)|Returns a collection of tags attached to the presentation.| +|[Shape](/.shape)|[delete()](/.shape#powerpoint-javascript/api/powerpoint/-shape-delete-member(1))|Deletes the shape from the shape collection.| +||[id](/.shape#powerpoint-javascript/api/powerpoint/-shape-id-member)|Gets the unique ID of the shape.| +||[tags](/.shape#powerpoint-javascript/api/powerpoint/-shape-tags-member)|Returns a collection of tags in the shape.| +|[ShapeCollection](/.shapecollection)|[getCount()](/.shapecollection#powerpoint-javascript/api/powerpoint/-shapecollection-getcount-member(1))|Gets the number of shapes in the collection.| +||[getItem(key: string)](/.shapecollection#powerpoint-javascript/api/powerpoint/-shapecollection-getitem-member(1))|Gets a shape using its unique ID.| +||[getItemAt(index: number)](/.shapecollection#powerpoint-javascript/api/powerpoint/-shapecollection-getitemat-member(1))|Gets a shape using its zero-based index in the collection.| +||[getItemOrNullObject(id: string)](/.shapecollection#powerpoint-javascript/api/powerpoint/-shapecollection-getitemornullobject-member(1))|Gets a shape using its unique ID.| +||[items](/.shapecollection#powerpoint-javascript/api/powerpoint/-shapecollection-items-member)|Gets the loaded child items in this collection.| +|[Slide](/.slide)|[layout](/.slide#powerpoint-javascript/api/powerpoint/-slide-layout-member)|Gets the layout of the slide.| +||[shapes](/.slide#powerpoint-javascript/api/powerpoint/-slide-shapes-member)|Returns a collection of shapes in the slide.| +||[slideMaster](/.slide#powerpoint-javascript/api/powerpoint/-slide-slidemaster-member)|Gets the `SlideMaster` object that represents the slide's default content.| +||[tags](/.slide#powerpoint-javascript/api/powerpoint/-slide-tags-member)|Returns a collection of tags in the slide.| +|[SlideCollection](/.slidecollection)|[add(options?: PowerPoint.AddSlideOptions)](/.slidecollection#powerpoint-javascript/api/powerpoint/-slidecollection-add-member(1))|Adds a new slide at the end of the collection.| +|[SlideLayout](/.slidelayout)|[id](/.slidelayout#powerpoint-javascript/api/powerpoint/-slidelayout-id-member)|Gets the unique ID of the slide layout.| +||[name](/.slidelayout#powerpoint-javascript/api/powerpoint/-slidelayout-name-member)|Gets the name of the slide layout.| +||[shapes](/.slidelayout#powerpoint-javascript/api/powerpoint/-slidelayout-shapes-member)|Returns a collection of shapes in the slide layout.| +|[SlideLayoutCollection](/.slidelayoutcollection)|[getCount()](/.slidelayoutcollection#powerpoint-javascript/api/powerpoint/-slidelayoutcollection-getcount-member(1))|Gets the number of layouts in the collection.| +||[getItem(key: string)](/.slidelayoutcollection#powerpoint-javascript/api/powerpoint/-slidelayoutcollection-getitem-member(1))|Gets a layout using its unique ID.| +||[getItemAt(index: number)](/.slidelayoutcollection#powerpoint-javascript/api/powerpoint/-slidelayoutcollection-getitemat-member(1))|Gets a layout using its zero-based index in the collection.| +||[getItemOrNullObject(id: string)](/.slidelayoutcollection#powerpoint-javascript/api/powerpoint/-slidelayoutcollection-getitemornullobject-member(1))|Gets a layout using its unique ID.| +||[items](/.slidelayoutcollection#powerpoint-javascript/api/powerpoint/-slidelayoutcollection-items-member)|Gets the loaded child items in this collection.| +|[SlideMaster](/.slidemaster)|[id](/.slidemaster#powerpoint-javascript/api/powerpoint/-slidemaster-id-member)|Gets the unique ID of the Slide Master.| +||[layouts](/.slidemaster#powerpoint-javascript/api/powerpoint/-slidemaster-layouts-member)|Gets the collection of layouts provided by the Slide Master for slides.| +||[name](/.slidemaster#powerpoint-javascript/api/powerpoint/-slidemaster-name-member)|Gets the unique name of the Slide Master.| +||[shapes](/.slidemaster#powerpoint-javascript/api/powerpoint/-slidemaster-shapes-member)|Returns a collection of shapes in the Slide Master.| +|[SlideMasterCollection](/.slidemastercollection)|[getCount()](/.slidemastercollection#powerpoint-javascript/api/powerpoint/-slidemastercollection-getcount-member(1))|Gets the number of Slide Masters in the collection.| +||[getItem(key: string)](/.slidemastercollection#powerpoint-javascript/api/powerpoint/-slidemastercollection-getitem-member(1))|Gets a Slide Master using its unique ID.| +||[getItemAt(index: number)](/.slidemastercollection#powerpoint-javascript/api/powerpoint/-slidemastercollection-getitemat-member(1))|Gets a Slide Master using its zero-based index in the collection.| +||[getItemOrNullObject(id: string)](/.slidemastercollection#powerpoint-javascript/api/powerpoint/-slidemastercollection-getitemornullobject-member(1))|Gets a Slide Master using its unique ID.| +||[items](/.slidemastercollection#powerpoint-javascript/api/powerpoint/-slidemastercollection-items-member)|Gets the loaded child items in this collection.| +|[Tag](/.tag)|[key](/.tag#powerpoint-javascript/api/powerpoint/-tag-key-member)|Gets the unique ID of the tag.| +||[value](/.tag#powerpoint-javascript/api/powerpoint/-tag-value-member)|Gets the value of the tag.| +|[TagCollection](/.tagcollection)|[add(key: string, value: string)](/.tagcollection#powerpoint-javascript/api/powerpoint/-tagcollection-add-member(1))|Adds a new tag at the end of the collection.| +||[delete(key: string)](/.tagcollection#powerpoint-javascript/api/powerpoint/-tagcollection-delete-member(1))|Deletes the tag with the given `key` in this collection.| +||[getCount()](/.tagcollection#powerpoint-javascript/api/powerpoint/-tagcollection-getcount-member(1))|Gets the number of tags in the collection.| +||[getItem(key: string)](/.tagcollection#powerpoint-javascript/api/powerpoint/-tagcollection-getitem-member(1))|Gets a tag using its unique ID.| +||[getItemAt(index: number)](/.tagcollection#powerpoint-javascript/api/powerpoint/-tagcollection-getitemat-member(1))|Gets a tag using its zero-based index in the collection.| +||[getItemOrNullObject(key: string)](/.tagcollection#powerpoint-javascript/api/powerpoint/-tagcollection-getitemornullobject-member(1))|Gets a tag using its unique ID.| +||[items](/.tagcollection#powerpoint-javascript/api/powerpoint/-tagcollection-items-member)|Gets the loaded child items in this collection.| diff --git a/docs/includes/powerpoint-1_4.md b/docs/includes/powerpoint-1_4.md index e5e7d943a1..8b0323fd78 100644 --- a/docs/includes/powerpoint-1_4.md +++ b/docs/includes/powerpoint-1_4.md @@ -1,52 +1,52 @@ | Class | Fields | Description | |:---|:---|:---| -|[BulletFormat](/javascript/api/powerpoint/powerpoint.bulletformat)|[visible](/javascript/api/powerpoint/powerpoint.bulletformat#powerpoint-powerpoint-bulletformat-visible-member)|Specifies if the bullets in the paragraph are visible.| -|[ParagraphFormat](/javascript/api/powerpoint/powerpoint.paragraphformat)|[bulletFormat](/javascript/api/powerpoint/powerpoint.paragraphformat#powerpoint-powerpoint-paragraphformat-bulletformat-member)|Represents the bullet format of the paragraph.| -||[horizontalAlignment](/javascript/api/powerpoint/powerpoint.paragraphformat#powerpoint-powerpoint-paragraphformat-horizontalalignment-member)|Represents the horizontal alignment of the paragraph.| -|[Shape](/javascript/api/powerpoint/powerpoint.shape)|[fill](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-fill-member)|Returns the fill formatting of this shape.| -||[height](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-height-member)|Specifies the height, in points, of the shape.| -||[left](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-left-member)|The distance, in points, from the left side of the shape to the left side of the slide.| -||[lineFormat](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-lineformat-member)|Returns the line formatting of this shape.| -||[name](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-name-member)|Specifies the name of this shape.| -||[textFrame](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-textframe-member)|Returns the PowerPoint.TextFrame object of this `Shape`.| -||[top](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-top-member)|The distance, in points, from the top edge of the shape to the top edge of the slide.| -||[type](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-type-member)|Returns the type of this shape.| -||[width](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-width-member)|Specifies the width, in points, of the shape.| -|[ShapeAddOptions](/javascript/api/powerpoint/powerpoint.shapeaddoptions)|[height](/javascript/api/powerpoint/powerpoint.shapeaddoptions#powerpoint-powerpoint-shapeaddoptions-height-member)|Specifies the height, in points, of the shape.| -||[left](/javascript/api/powerpoint/powerpoint.shapeaddoptions#powerpoint-powerpoint-shapeaddoptions-left-member)|Specifies the distance, in points, from the left side of the shape to the left side of the slide.| -||[top](/javascript/api/powerpoint/powerpoint.shapeaddoptions#powerpoint-powerpoint-shapeaddoptions-top-member)|Specifies the distance, in points, from the top edge of the shape to the top edge of the slide.| -||[width](/javascript/api/powerpoint/powerpoint.shapeaddoptions#powerpoint-powerpoint-shapeaddoptions-width-member)|Specifies the width, in points, of the shape.| -|[ShapeCollection](/javascript/api/powerpoint/powerpoint.shapecollection)|[addGeometricShape(geometricShapeType: PowerPoint.GeometricShapeType, options?: PowerPoint.ShapeAddOptions)](/javascript/api/powerpoint/powerpoint.shapecollection#powerpoint-powerpoint-shapecollection-addgeometricshape-member(1))|Adds a geometric shape to the slide.| -||[addLine(connectorType?: PowerPoint.ConnectorType, options?: PowerPoint.ShapeAddOptions)](/javascript/api/powerpoint/powerpoint.shapecollection#powerpoint-powerpoint-shapecollection-addline-member(1))|Adds a line to the slide.| -||[addTextBox(text: string, options?: PowerPoint.ShapeAddOptions)](/javascript/api/powerpoint/powerpoint.shapecollection#powerpoint-powerpoint-shapecollection-addtextbox-member(1))|Adds a text box to the slide with the provided text as the content.| -|[ShapeFill](/javascript/api/powerpoint/powerpoint.shapefill)|[clear()](/javascript/api/powerpoint/powerpoint.shapefill#powerpoint-powerpoint-shapefill-clear-member(1))|Clears the fill formatting of this shape.| -||[foregroundColor](/javascript/api/powerpoint/powerpoint.shapefill#powerpoint-powerpoint-shapefill-foregroundcolor-member)|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").| -||[setSolidColor(color: string)](/javascript/api/powerpoint/powerpoint.shapefill#powerpoint-powerpoint-shapefill-setsolidcolor-member(1))|Sets the fill formatting of the shape to a uniform color.| -||[transparency](/javascript/api/powerpoint/powerpoint.shapefill#powerpoint-powerpoint-shapefill-transparency-member)|Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).| -||[type](/javascript/api/powerpoint/powerpoint.shapefill#powerpoint-powerpoint-shapefill-type-member)|Returns the fill type of the shape.| -|[ShapeFont](/javascript/api/powerpoint/powerpoint.shapefont)|[bold](/javascript/api/powerpoint/powerpoint.shapefont#powerpoint-powerpoint-shapefont-bold-member)|Specifies whether the text in the `TextRange` is set to bold.| -||[color](/javascript/api/powerpoint/powerpoint.shapefont#powerpoint-powerpoint-shapefont-color-member)|Specifies the HTML color code representation of the text color (e.g., "#FF0000" represents red).| -||[italic](/javascript/api/powerpoint/powerpoint.shapefont#powerpoint-powerpoint-shapefont-italic-member)|Specifies whether the text in the `TextRange` is set to italic.| -||[name](/javascript/api/powerpoint/powerpoint.shapefont#powerpoint-powerpoint-shapefont-name-member)|Specifies the font name (e.g., "Calibri").| -||[size](/javascript/api/powerpoint/powerpoint.shapefont#powerpoint-powerpoint-shapefont-size-member)|Specifies the font size in points (e.g., 11).| -||[underline](/javascript/api/powerpoint/powerpoint.shapefont#powerpoint-powerpoint-shapefont-underline-member)|Specifies the type of underline applied to the font.| -|[ShapeLineFormat](/javascript/api/powerpoint/powerpoint.shapelineformat)|[color](/javascript/api/powerpoint/powerpoint.shapelineformat#powerpoint-powerpoint-shapelineformat-color-member)|Represents the line color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").| -||[dashStyle](/javascript/api/powerpoint/powerpoint.shapelineformat#powerpoint-powerpoint-shapelineformat-dashstyle-member)|Represents the dash style of the line.| -||[style](/javascript/api/powerpoint/powerpoint.shapelineformat#powerpoint-powerpoint-shapelineformat-style-member)|Represents the line style of the shape.| -||[transparency](/javascript/api/powerpoint/powerpoint.shapelineformat#powerpoint-powerpoint-shapelineformat-transparency-member)|Specifies the transparency percentage of the line as a value from 0.0 (opaque) through 1.0 (clear).| -||[visible](/javascript/api/powerpoint/powerpoint.shapelineformat#powerpoint-powerpoint-shapelineformat-visible-member)|Specifies if the line formatting of a shape element is visible.| -||[weight](/javascript/api/powerpoint/powerpoint.shapelineformat#powerpoint-powerpoint-shapelineformat-weight-member)|Represents the weight of the line, in points.| -|[TextFrame](/javascript/api/powerpoint/powerpoint.textframe)|[autoSizeSetting](/javascript/api/powerpoint/powerpoint.textframe#powerpoint-powerpoint-textframe-autosizesetting-member)|The automatic sizing settings for the text frame.| -||[bottomMargin](/javascript/api/powerpoint/powerpoint.textframe#powerpoint-powerpoint-textframe-bottommargin-member)|Represents the bottom margin, in points, of the text frame.| -||[deleteText()](/javascript/api/powerpoint/powerpoint.textframe#powerpoint-powerpoint-textframe-deletetext-member(1))|Deletes all the text in the text frame.| -||[hasText](/javascript/api/powerpoint/powerpoint.textframe#powerpoint-powerpoint-textframe-hastext-member)|Specifies if the text frame contains text.| -||[leftMargin](/javascript/api/powerpoint/powerpoint.textframe#powerpoint-powerpoint-textframe-leftmargin-member)|Represents the left margin, in points, of the text frame.| -||[rightMargin](/javascript/api/powerpoint/powerpoint.textframe#powerpoint-powerpoint-textframe-rightmargin-member)|Represents the right margin, in points, of the text frame.| -||[textRange](/javascript/api/powerpoint/powerpoint.textframe#powerpoint-powerpoint-textframe-textrange-member)|Represents the text that is attached to a shape in the text frame, and properties and methods for manipulating the text.| -||[topMargin](/javascript/api/powerpoint/powerpoint.textframe#powerpoint-powerpoint-textframe-topmargin-member)|Represents the top margin, in points, of the text frame.| -||[verticalAlignment](/javascript/api/powerpoint/powerpoint.textframe#powerpoint-powerpoint-textframe-verticalalignment-member)|Represents the vertical alignment of the text frame.| -||[wordWrap](/javascript/api/powerpoint/powerpoint.textframe#powerpoint-powerpoint-textframe-wordwrap-member)|Determines whether lines break automatically to fit text inside the shape.| -|[TextRange](/javascript/api/powerpoint/powerpoint.textrange)|[font](/javascript/api/powerpoint/powerpoint.textrange#powerpoint-powerpoint-textrange-font-member)|Returns a `ShapeFont` object that represents the font attributes for the text range.| -||[getSubstring(start: number, length?: number)](/javascript/api/powerpoint/powerpoint.textrange#powerpoint-powerpoint-textrange-getsubstring-member(1))|Returns a `TextRange` object for the substring in the given range.| -||[paragraphFormat](/javascript/api/powerpoint/powerpoint.textrange#powerpoint-powerpoint-textrange-paragraphformat-member)|Represents the paragraph format of the text range.| -||[text](/javascript/api/powerpoint/powerpoint.textrange#powerpoint-powerpoint-textrange-text-member)|Represents the plain text content of the text range.| +|[BulletFormat](/.bulletformat)|[visible](/.bulletformat#powerpoint-javascript/api/powerpoint/-bulletformat-visible-member)|Specifies if the bullets in the paragraph are visible.| +|[ParagraphFormat](/.paragraphformat)|[bulletFormat](/.paragraphformat#powerpoint-javascript/api/powerpoint/-paragraphformat-bulletformat-member)|Represents the bullet format of the paragraph.| +||[horizontalAlignment](/.paragraphformat#powerpoint-javascript/api/powerpoint/-paragraphformat-horizontalalignment-member)|Represents the horizontal alignment of the paragraph.| +|[Shape](/.shape)|[fill](/.shape#powerpoint-javascript/api/powerpoint/-shape-fill-member)|Returns the fill formatting of this shape.| +||[height](/.shape#powerpoint-javascript/api/powerpoint/-shape-height-member)|Specifies the height, in points, of the shape.| +||[left](/.shape#powerpoint-javascript/api/powerpoint/-shape-left-member)|The distance, in points, from the left side of the shape to the left side of the slide.| +||[lineFormat](/.shape#powerpoint-javascript/api/powerpoint/-shape-lineformat-member)|Returns the line formatting of this shape.| +||[name](/.shape#powerpoint-javascript/api/powerpoint/-shape-name-member)|Specifies the name of this shape.| +||[textFrame](/.shape#powerpoint-javascript/api/powerpoint/-shape-textframe-member)|Returns the PowerPoint.TextFrame object of this `Shape`.| +||[top](/.shape#powerpoint-javascript/api/powerpoint/-shape-top-member)|The distance, in points, from the top edge of the shape to the top edge of the slide.| +||[type](/.shape#powerpoint-javascript/api/powerpoint/-shape-type-member)|Returns the type of this shape.| +||[width](/.shape#powerpoint-javascript/api/powerpoint/-shape-width-member)|Specifies the width, in points, of the shape.| +|[ShapeAddOptions](/.shapeaddoptions)|[height](/.shapeaddoptions#powerpoint-javascript/api/powerpoint/-shapeaddoptions-height-member)|Specifies the height, in points, of the shape.| +||[left](/.shapeaddoptions#powerpoint-javascript/api/powerpoint/-shapeaddoptions-left-member)|Specifies the distance, in points, from the left side of the shape to the left side of the slide.| +||[top](/.shapeaddoptions#powerpoint-javascript/api/powerpoint/-shapeaddoptions-top-member)|Specifies the distance, in points, from the top edge of the shape to the top edge of the slide.| +||[width](/.shapeaddoptions#powerpoint-javascript/api/powerpoint/-shapeaddoptions-width-member)|Specifies the width, in points, of the shape.| +|[ShapeCollection](/.shapecollection)|[addGeometricShape(geometricShapeType: PowerPoint.GeometricShapeType, options?: PowerPoint.ShapeAddOptions)](/.shapecollection#powerpoint-javascript/api/powerpoint/-shapecollection-addgeometricshape-member(1))|Adds a geometric shape to the slide.| +||[addLine(connectorType?: PowerPoint.ConnectorType, options?: PowerPoint.ShapeAddOptions)](/.shapecollection#powerpoint-javascript/api/powerpoint/-shapecollection-addline-member(1))|Adds a line to the slide.| +||[addTextBox(text: string, options?: PowerPoint.ShapeAddOptions)](/.shapecollection#powerpoint-javascript/api/powerpoint/-shapecollection-addtextbox-member(1))|Adds a text box to the slide with the provided text as the content.| +|[ShapeFill](/.shapefill)|[clear()](/.shapefill#powerpoint-javascript/api/powerpoint/-shapefill-clear-member(1))|Clears the fill formatting of this shape.| +||[foregroundColor](/.shapefill#powerpoint-javascript/api/powerpoint/-shapefill-foregroundcolor-member)|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").| +||[setSolidColor(color: string)](/.shapefill#powerpoint-javascript/api/powerpoint/-shapefill-setsolidcolor-member(1))|Sets the fill formatting of the shape to a uniform color.| +||[transparency](/.shapefill#powerpoint-javascript/api/powerpoint/-shapefill-transparency-member)|Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).| +||[type](/.shapefill#powerpoint-javascript/api/powerpoint/-shapefill-type-member)|Returns the fill type of the shape.| +|[ShapeFont](/.shapefont)|[bold](/.shapefont#powerpoint-javascript/api/powerpoint/-shapefont-bold-member)|Specifies whether the text in the `TextRange` is set to bold.| +||[color](/.shapefont#powerpoint-javascript/api/powerpoint/-shapefont-color-member)|Specifies the HTML color code representation of the text color (e.g., "#FF0000" represents red).| +||[italic](/.shapefont#powerpoint-javascript/api/powerpoint/-shapefont-italic-member)|Specifies whether the text in the `TextRange` is set to italic.| +||[name](/.shapefont#powerpoint-javascript/api/powerpoint/-shapefont-name-member)|Specifies the font name (e.g., "Calibri").| +||[size](/.shapefont#powerpoint-javascript/api/powerpoint/-shapefont-size-member)|Specifies the font size in points (e.g., 11).| +||[underline](/.shapefont#powerpoint-javascript/api/powerpoint/-shapefont-underline-member)|Specifies the type of underline applied to the font.| +|[ShapeLineFormat](/.shapelineformat)|[color](/.shapelineformat#powerpoint-javascript/api/powerpoint/-shapelineformat-color-member)|Represents the line color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").| +||[dashStyle](/.shapelineformat#powerpoint-javascript/api/powerpoint/-shapelineformat-dashstyle-member)|Represents the dash style of the line.| +||[style](/.shapelineformat#powerpoint-javascript/api/powerpoint/-shapelineformat-style-member)|Represents the line style of the shape.| +||[transparency](/.shapelineformat#powerpoint-javascript/api/powerpoint/-shapelineformat-transparency-member)|Specifies the transparency percentage of the line as a value from 0.0 (opaque) through 1.0 (clear).| +||[visible](/.shapelineformat#powerpoint-javascript/api/powerpoint/-shapelineformat-visible-member)|Specifies if the line formatting of a shape element is visible.| +||[weight](/.shapelineformat#powerpoint-javascript/api/powerpoint/-shapelineformat-weight-member)|Represents the weight of the line, in points.| +|[TextFrame](/.textframe)|[autoSizeSetting](/.textframe#powerpoint-javascript/api/powerpoint/-textframe-autosizesetting-member)|The automatic sizing settings for the text frame.| +||[bottomMargin](/.textframe#powerpoint-javascript/api/powerpoint/-textframe-bottommargin-member)|Represents the bottom margin, in points, of the text frame.| +||[deleteText()](/.textframe#powerpoint-javascript/api/powerpoint/-textframe-deletetext-member(1))|Deletes all the text in the text frame.| +||[hasText](/.textframe#powerpoint-javascript/api/powerpoint/-textframe-hastext-member)|Specifies if the text frame contains text.| +||[leftMargin](/.textframe#powerpoint-javascript/api/powerpoint/-textframe-leftmargin-member)|Represents the left margin, in points, of the text frame.| +||[rightMargin](/.textframe#powerpoint-javascript/api/powerpoint/-textframe-rightmargin-member)|Represents the right margin, in points, of the text frame.| +||[textRange](/.textframe#powerpoint-javascript/api/powerpoint/-textframe-textrange-member)|Represents the text that is attached to a shape in the text frame, and properties and methods for manipulating the text.| +||[topMargin](/.textframe#powerpoint-javascript/api/powerpoint/-textframe-topmargin-member)|Represents the top margin, in points, of the text frame.| +||[verticalAlignment](/.textframe#powerpoint-javascript/api/powerpoint/-textframe-verticalalignment-member)|Represents the vertical alignment of the text frame.| +||[wordWrap](/.textframe#powerpoint-javascript/api/powerpoint/-textframe-wordwrap-member)|Determines whether lines break automatically to fit text inside the shape.| +|[TextRange](/.textrange)|[font](/.textrange#powerpoint-javascript/api/powerpoint/-textrange-font-member)|Returns a `ShapeFont` object that represents the font attributes for the text range.| +||[getSubstring(start: number, length?: number)](/.textrange#powerpoint-javascript/api/powerpoint/-textrange-getsubstring-member(1))|Returns a `TextRange` object for the substring in the given range.| +||[paragraphFormat](/.textrange#powerpoint-javascript/api/powerpoint/-textrange-paragraphformat-member)|Represents the paragraph format of the text range.| +||[text](/.textrange#powerpoint-javascript/api/powerpoint/-textrange-text-member)|Represents the plain text content of the text range.| diff --git a/docs/includes/powerpoint-1_5.md b/docs/includes/powerpoint-1_5.md index b089d487a1..7dc592c644 100644 --- a/docs/includes/powerpoint-1_5.md +++ b/docs/includes/powerpoint-1_5.md @@ -1,30 +1,30 @@ | Class | Fields | Description | |:---|:---|:---| -|[Presentation](/javascript/api/powerpoint/powerpoint.presentation)|[getSelectedShapes()](/javascript/api/powerpoint/powerpoint.presentation#powerpoint-powerpoint-presentation-getselectedshapes-member(1))|Returns the selected shapes in the current slide of the presentation.| -||[getSelectedSlides()](/javascript/api/powerpoint/powerpoint.presentation#powerpoint-powerpoint-presentation-getselectedslides-member(1))|Returns the selected slides in the current view of the presentation.| -||[getSelectedTextRange()](/javascript/api/powerpoint/powerpoint.presentation#powerpoint-powerpoint-presentation-getselectedtextrange-member(1))|Returns the selected PowerPoint.TextRange in the current view of the presentation.| -||[getSelectedTextRangeOrNullObject()](/javascript/api/powerpoint/powerpoint.presentation#powerpoint-powerpoint-presentation-getselectedtextrangeornullobject-member(1))|Returns the selected PowerPoint.TextRange in the current view of the presentation.| -||[id](/javascript/api/powerpoint/powerpoint.presentation#powerpoint-powerpoint-presentation-id-member)|Gets the ID of the presentation.| -||[setSelectedSlides(slideIds: string[])](/javascript/api/powerpoint/powerpoint.presentation#powerpoint-powerpoint-presentation-setselectedslides-member(1))|Selects the slides in the current view of the presentation.| -|[Shape](/javascript/api/powerpoint/powerpoint.shape)|[getParentSlide()](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-getparentslide-member(1))|Returns the parent PowerPoint.Slide object that holds this `Shape`.| -||[getParentSlideLayout()](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-getparentslidelayout-member(1))|Returns the parent PowerPoint.SlideLayout object that holds this `Shape`.| -||[getParentSlideLayoutOrNullObject()](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-getparentslidelayoutornullobject-member(1))|Returns the parent PowerPoint.SlideLayout object that holds this `Shape`.| -||[getParentSlideMaster()](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-getparentslidemaster-member(1))|Returns the parent PowerPoint.SlideMaster object that holds this `Shape`.| -||[getParentSlideMasterOrNullObject()](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-getparentslidemasterornullobject-member(1))|Returns the parent PowerPoint.SlideMaster object that holds this `Shape`.| -||[getParentSlideOrNullObject()](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-getparentslideornullobject-member(1))|Returns the parent PowerPoint.Slide object that holds this `Shape`.| -|[ShapeScopedCollection](/javascript/api/powerpoint/powerpoint.shapescopedcollection)|[getCount()](/javascript/api/powerpoint/powerpoint.shapescopedcollection#powerpoint-powerpoint-shapescopedcollection-getcount-member(1))|Gets the number of shapes in the collection.| -||[getItem(key: string)](/javascript/api/powerpoint/powerpoint.shapescopedcollection#powerpoint-powerpoint-shapescopedcollection-getitem-member(1))|Gets a shape using its unique ID.| -||[getItemAt(index: number)](/javascript/api/powerpoint/powerpoint.shapescopedcollection#powerpoint-powerpoint-shapescopedcollection-getitemat-member(1))|Gets a shape using its zero-based index in the collection.| -||[getItemOrNullObject(id: string)](/javascript/api/powerpoint/powerpoint.shapescopedcollection#powerpoint-powerpoint-shapescopedcollection-getitemornullobject-member(1))|Gets a shape using its unique ID.| -||[items](/javascript/api/powerpoint/powerpoint.shapescopedcollection#powerpoint-powerpoint-shapescopedcollection-items-member)|Gets the loaded child items in this collection.| -|[Slide](/javascript/api/powerpoint/powerpoint.slide)|[setSelectedShapes(shapeIds: string[])](/javascript/api/powerpoint/powerpoint.slide#powerpoint-powerpoint-slide-setselectedshapes-member(1))|Selects the specified shapes.| -|[SlideScopedCollection](/javascript/api/powerpoint/powerpoint.slidescopedcollection)|[getCount()](/javascript/api/powerpoint/powerpoint.slidescopedcollection#powerpoint-powerpoint-slidescopedcollection-getcount-member(1))|Gets the number of slides in the collection.| -||[getItem(key: string)](/javascript/api/powerpoint/powerpoint.slidescopedcollection#powerpoint-powerpoint-slidescopedcollection-getitem-member(1))|Gets a slide using its unique ID.| -||[getItemAt(index: number)](/javascript/api/powerpoint/powerpoint.slidescopedcollection#powerpoint-powerpoint-slidescopedcollection-getitemat-member(1))|Gets a slide using its zero-based index in the collection.| -||[getItemOrNullObject(id: string)](/javascript/api/powerpoint/powerpoint.slidescopedcollection#powerpoint-powerpoint-slidescopedcollection-getitemornullobject-member(1))|Gets a slide using its unique ID.| -||[items](/javascript/api/powerpoint/powerpoint.slidescopedcollection#powerpoint-powerpoint-slidescopedcollection-items-member)|Gets the loaded child items in this collection.| -|[TextFrame](/javascript/api/powerpoint/powerpoint.textframe)|[getParentShape()](/javascript/api/powerpoint/powerpoint.textframe#powerpoint-powerpoint-textframe-getparentshape-member(1))|Returns the parent PowerPoint.Shape object that holds this `TextFrame`.| -|[TextRange](/javascript/api/powerpoint/powerpoint.textrange)|[getParentTextFrame()](/javascript/api/powerpoint/powerpoint.textrange#powerpoint-powerpoint-textrange-getparenttextframe-member(1))|Returns the parent PowerPoint.TextFrame object that holds this `TextRange`.| -||[length](/javascript/api/powerpoint/powerpoint.textrange#powerpoint-powerpoint-textrange-length-member)|Gets or sets the length of the range that this `TextRange` represents.| -||[setSelected()](/javascript/api/powerpoint/powerpoint.textrange#powerpoint-powerpoint-textrange-setselected-member(1))|Selects this `TextRange` in the current view.| -||[start](/javascript/api/powerpoint/powerpoint.textrange#powerpoint-powerpoint-textrange-start-member)|Gets or sets zero-based index, relative to the parent text frame, for the starting position of the range that this `TextRange` represents.| +|[Presentation](/.presentation)|[getSelectedShapes()](/.presentation#powerpoint-javascript/api/powerpoint/-presentation-getselectedshapes-member(1))|Returns the selected shapes in the current slide of the presentation.| +||[getSelectedSlides()](/.presentation#powerpoint-javascript/api/powerpoint/-presentation-getselectedslides-member(1))|Returns the selected slides in the current view of the presentation.| +||[getSelectedTextRange()](/.presentation#powerpoint-javascript/api/powerpoint/-presentation-getselectedtextrange-member(1))|Returns the selected PowerPoint.TextRange in the current view of the presentation.| +||[getSelectedTextRangeOrNullObject()](/.presentation#powerpoint-javascript/api/powerpoint/-presentation-getselectedtextrangeornullobject-member(1))|Returns the selected PowerPoint.TextRange in the current view of the presentation.| +||[id](/.presentation#powerpoint-javascript/api/powerpoint/-presentation-id-member)|Gets the ID of the presentation.| +||[setSelectedSlides(slideIds: string[])](/.presentation#powerpoint-javascript/api/powerpoint/-presentation-setselectedslides-member(1))|Selects the slides in the current view of the presentation.| +|[Shape](/.shape)|[getParentSlide()](/.shape#powerpoint-javascript/api/powerpoint/-shape-getparentslide-member(1))|Returns the parent PowerPoint.Slide object that holds this `Shape`.| +||[getParentSlideLayout()](/.shape#powerpoint-javascript/api/powerpoint/-shape-getparentslidelayout-member(1))|Returns the parent PowerPoint.SlideLayout object that holds this `Shape`.| +||[getParentSlideLayoutOrNullObject()](/.shape#powerpoint-javascript/api/powerpoint/-shape-getparentslidelayoutornullobject-member(1))|Returns the parent PowerPoint.SlideLayout object that holds this `Shape`.| +||[getParentSlideMaster()](/.shape#powerpoint-javascript/api/powerpoint/-shape-getparentslidemaster-member(1))|Returns the parent PowerPoint.SlideMaster object that holds this `Shape`.| +||[getParentSlideMasterOrNullObject()](/.shape#powerpoint-javascript/api/powerpoint/-shape-getparentslidemasterornullobject-member(1))|Returns the parent PowerPoint.SlideMaster object that holds this `Shape`.| +||[getParentSlideOrNullObject()](/.shape#powerpoint-javascript/api/powerpoint/-shape-getparentslideornullobject-member(1))|Returns the parent PowerPoint.Slide object that holds this `Shape`.| +|[ShapeScopedCollection](/.shapescopedcollection)|[getCount()](/.shapescopedcollection#powerpoint-javascript/api/powerpoint/-shapescopedcollection-getcount-member(1))|Gets the number of shapes in the collection.| +||[getItem(key: string)](/.shapescopedcollection#powerpoint-javascript/api/powerpoint/-shapescopedcollection-getitem-member(1))|Gets a shape using its unique ID.| +||[getItemAt(index: number)](/.shapescopedcollection#powerpoint-javascript/api/powerpoint/-shapescopedcollection-getitemat-member(1))|Gets a shape using its zero-based index in the collection.| +||[getItemOrNullObject(id: string)](/.shapescopedcollection#powerpoint-javascript/api/powerpoint/-shapescopedcollection-getitemornullobject-member(1))|Gets a shape using its unique ID.| +||[items](/.shapescopedcollection#powerpoint-javascript/api/powerpoint/-shapescopedcollection-items-member)|Gets the loaded child items in this collection.| +|[Slide](/.slide)|[setSelectedShapes(shapeIds: string[])](/.slide#powerpoint-javascript/api/powerpoint/-slide-setselectedshapes-member(1))|Selects the specified shapes.| +|[SlideScopedCollection](/.slidescopedcollection)|[getCount()](/.slidescopedcollection#powerpoint-javascript/api/powerpoint/-slidescopedcollection-getcount-member(1))|Gets the number of slides in the collection.| +||[getItem(key: string)](/.slidescopedcollection#powerpoint-javascript/api/powerpoint/-slidescopedcollection-getitem-member(1))|Gets a slide using its unique ID.| +||[getItemAt(index: number)](/.slidescopedcollection#powerpoint-javascript/api/powerpoint/-slidescopedcollection-getitemat-member(1))|Gets a slide using its zero-based index in the collection.| +||[getItemOrNullObject(id: string)](/.slidescopedcollection#powerpoint-javascript/api/powerpoint/-slidescopedcollection-getitemornullobject-member(1))|Gets a slide using its unique ID.| +||[items](/.slidescopedcollection#powerpoint-javascript/api/powerpoint/-slidescopedcollection-items-member)|Gets the loaded child items in this collection.| +|[TextFrame](/.textframe)|[getParentShape()](/.textframe#powerpoint-javascript/api/powerpoint/-textframe-getparentshape-member(1))|Returns the parent PowerPoint.Shape object that holds this `TextFrame`.| +|[TextRange](/.textrange)|[getParentTextFrame()](/.textrange#powerpoint-javascript/api/powerpoint/-textrange-getparenttextframe-member(1))|Returns the parent PowerPoint.TextFrame object that holds this `TextRange`.| +||[length](/.textrange#powerpoint-javascript/api/powerpoint/-textrange-length-member)|Gets or sets the length of the range that this `TextRange` represents.| +||[setSelected()](/.textrange#powerpoint-javascript/api/powerpoint/-textrange-setselected-member(1))|Selects this `TextRange` in the current view.| +||[start](/.textrange#powerpoint-javascript/api/powerpoint/-textrange-start-member)|Gets or sets zero-based index, relative to the parent text frame, for the starting position of the range that this `TextRange` represents.| diff --git a/docs/includes/powerpoint-1_6.md b/docs/includes/powerpoint-1_6.md index 40378a4c54..1241204692 100644 --- a/docs/includes/powerpoint-1_6.md +++ b/docs/includes/powerpoint-1_6.md @@ -1,8 +1,8 @@ | Class | Fields | Description | |:---|:---|:---| -|[Hyperlink](/javascript/api/powerpoint/powerpoint.hyperlink)|[address](/javascript/api/powerpoint/powerpoint.hyperlink#powerpoint-powerpoint-hyperlink-address-member)|Specifies the URL target of the hyperlink.| -||[screenTip](/javascript/api/powerpoint/powerpoint.hyperlink#powerpoint-powerpoint-hyperlink-screentip-member)|Specifies the string displayed when hovering over the hyperlink.| -|[HyperlinkCollection](/javascript/api/powerpoint/powerpoint.hyperlinkcollection)|[getCount()](/javascript/api/powerpoint/powerpoint.hyperlinkcollection#powerpoint-powerpoint-hyperlinkcollection-getcount-member(1))|Gets the number of hyperlinks in the collection.| -||[getItemAt(index: number)](/javascript/api/powerpoint/powerpoint.hyperlinkcollection#powerpoint-powerpoint-hyperlinkcollection-getitemat-member(1))|Gets a hyperlink using its zero-based index in the collection.| -||[items](/javascript/api/powerpoint/powerpoint.hyperlinkcollection#powerpoint-powerpoint-hyperlinkcollection-items-member)|Gets the loaded child items in this collection.| -|[Slide](/javascript/api/powerpoint/powerpoint.slide)|[hyperlinks](/javascript/api/powerpoint/powerpoint.slide#powerpoint-powerpoint-slide-hyperlinks-member)|Returns a collection of hyperlinks in the slide.| +|[Hyperlink](/.hyperlink)|[address](/.hyperlink#powerpoint-javascript/api/powerpoint/-hyperlink-address-member)|Specifies the URL target of the hyperlink.| +||[screenTip](/.hyperlink#powerpoint-javascript/api/powerpoint/-hyperlink-screentip-member)|Specifies the string displayed when hovering over the hyperlink.| +|[HyperlinkCollection](/.hyperlinkcollection)|[getCount()](/.hyperlinkcollection#powerpoint-javascript/api/powerpoint/-hyperlinkcollection-getcount-member(1))|Gets the number of hyperlinks in the collection.| +||[getItemAt(index: number)](/.hyperlinkcollection#powerpoint-javascript/api/powerpoint/-hyperlinkcollection-getitemat-member(1))|Gets a hyperlink using its zero-based index in the collection.| +||[items](/.hyperlinkcollection#powerpoint-javascript/api/powerpoint/-hyperlinkcollection-items-member)|Gets the loaded child items in this collection.| +|[Slide](/.slide)|[hyperlinks](/.slide#powerpoint-javascript/api/powerpoint/-slide-hyperlinks-member)|Returns a collection of hyperlinks in the slide.| diff --git a/docs/includes/powerpoint-1_7.md b/docs/includes/powerpoint-1_7.md index 01fda263b8..1aacb347c8 100644 --- a/docs/includes/powerpoint-1_7.md +++ b/docs/includes/powerpoint-1_7.md @@ -1,47 +1,47 @@ | Class | Fields | Description | |:---|:---|:---| -|[CustomProperty](/javascript/api/powerpoint/powerpoint.customproperty)|[delete()](/javascript/api/powerpoint/powerpoint.customproperty#powerpoint-powerpoint-customproperty-delete-member(1))|Deletes the custom property.| -||[key](/javascript/api/powerpoint/powerpoint.customproperty#powerpoint-powerpoint-customproperty-key-member)|The string that uniquely identifies the custom property.| -||[type](/javascript/api/powerpoint/powerpoint.customproperty#powerpoint-powerpoint-customproperty-type-member)|The type of the value used for the custom property.| -||[value](/javascript/api/powerpoint/powerpoint.customproperty#powerpoint-powerpoint-customproperty-value-member)|The value of the custom property.| -|[CustomPropertyCollection](/javascript/api/powerpoint/powerpoint.custompropertycollection)|[add(key: string, value: boolean \| Date \| number \| string)](/javascript/api/powerpoint/powerpoint.custompropertycollection#powerpoint-powerpoint-custompropertycollection-add-member(1))|Creates a new `CustomProperty` or updates the property with the given key.| -||[deleteAll()](/javascript/api/powerpoint/powerpoint.custompropertycollection#powerpoint-powerpoint-custompropertycollection-deleteall-member(1))|Deletes all custom properties in this collection.| -||[getCount()](/javascript/api/powerpoint/powerpoint.custompropertycollection#powerpoint-powerpoint-custompropertycollection-getcount-member(1))|Gets the number of custom properties in the collection.| -||[getItem(key: string)](/javascript/api/powerpoint/powerpoint.custompropertycollection#powerpoint-powerpoint-custompropertycollection-getitem-member(1))|Gets a `CustomProperty` by its key.| -||[getItemOrNullObject(key: string)](/javascript/api/powerpoint/powerpoint.custompropertycollection#powerpoint-powerpoint-custompropertycollection-getitemornullobject-member(1))|Gets a `CustomProperty` by its key.| -||[items](/javascript/api/powerpoint/powerpoint.custompropertycollection#powerpoint-powerpoint-custompropertycollection-items-member)|Gets the loaded child items in this collection.| -|[CustomXmlPart](/javascript/api/powerpoint/powerpoint.customxmlpart)|[delete()](/javascript/api/powerpoint/powerpoint.customxmlpart#powerpoint-powerpoint-customxmlpart-delete-member(1))|Deletes the custom XML part.| -||[getXml()](/javascript/api/powerpoint/powerpoint.customxmlpart#powerpoint-powerpoint-customxmlpart-getxml-member(1))|Gets the XML content of the custom XML part.| -||[id](/javascript/api/powerpoint/powerpoint.customxmlpart#powerpoint-powerpoint-customxmlpart-id-member)|The ID of the custom XML part.| -||[namespaceUri](/javascript/api/powerpoint/powerpoint.customxmlpart#powerpoint-powerpoint-customxmlpart-namespaceuri-member)|The namespace URI of the custom XML part.| -||[setXml(xml: string)](/javascript/api/powerpoint/powerpoint.customxmlpart#powerpoint-powerpoint-customxmlpart-setxml-member(1))|Sets the XML content for the custom XML part.| -|[CustomXmlPartCollection](/javascript/api/powerpoint/powerpoint.customxmlpartcollection)|[add(xml: string)](/javascript/api/powerpoint/powerpoint.customxmlpartcollection#powerpoint-powerpoint-customxmlpartcollection-add-member(1))|Adds a new `CustomXmlPart` to the collection.| -||[getByNamespace(namespaceUri: string)](/javascript/api/powerpoint/powerpoint.customxmlpartcollection#powerpoint-powerpoint-customxmlpartcollection-getbynamespace-member(1))|Gets a new scoped collection of custom XML parts whose namespaces match the given namespace.| -||[getCount()](/javascript/api/powerpoint/powerpoint.customxmlpartcollection#powerpoint-powerpoint-customxmlpartcollection-getcount-member(1))|Gets the number of custom XML parts in the collection.| -||[getItem(id: string)](/javascript/api/powerpoint/powerpoint.customxmlpartcollection#powerpoint-powerpoint-customxmlpartcollection-getitem-member(1))|Gets a `CustomXmlPart` based on its ID.| -||[getItemOrNullObject(id: string)](/javascript/api/powerpoint/powerpoint.customxmlpartcollection#powerpoint-powerpoint-customxmlpartcollection-getitemornullobject-member(1))|Gets a `CustomXmlPart` based on its ID.| -||[items](/javascript/api/powerpoint/powerpoint.customxmlpartcollection#powerpoint-powerpoint-customxmlpartcollection-items-member)|Gets the loaded child items in this collection.| -|[CustomXmlPartScopedCollection](/javascript/api/powerpoint/powerpoint.customxmlpartscopedcollection)|[getCount()](/javascript/api/powerpoint/powerpoint.customxmlpartscopedcollection#powerpoint-powerpoint-customxmlpartscopedcollection-getcount-member(1))|Gets the number of custom XML parts in this collection.| -||[getItem(id: string)](/javascript/api/powerpoint/powerpoint.customxmlpartscopedcollection#powerpoint-powerpoint-customxmlpartscopedcollection-getitem-member(1))|Gets a `CustomXmlPart` based on its ID.| -||[getItemOrNullObject(id: string)](/javascript/api/powerpoint/powerpoint.customxmlpartscopedcollection#powerpoint-powerpoint-customxmlpartscopedcollection-getitemornullobject-member(1))|Gets a `CustomXmlPart` based on its ID.| -||[getOnlyItem()](/javascript/api/powerpoint/powerpoint.customxmlpartscopedcollection#powerpoint-powerpoint-customxmlpartscopedcollection-getonlyitem-member(1))|If the collection contains exactly one item, this method returns it.| -||[getOnlyItemOrNullObject()](/javascript/api/powerpoint/powerpoint.customxmlpartscopedcollection#powerpoint-powerpoint-customxmlpartscopedcollection-getonlyitemornullobject-member(1))|If the collection contains exactly one item, this method returns it.| -||[items](/javascript/api/powerpoint/powerpoint.customxmlpartscopedcollection#powerpoint-powerpoint-customxmlpartscopedcollection-items-member)|Gets the loaded child items in this collection.| -|[DocumentProperties](/javascript/api/powerpoint/powerpoint.documentproperties)|[author](/javascript/api/powerpoint/powerpoint.documentproperties#powerpoint-powerpoint-documentproperties-author-member)|The author of the presentation.| -||[category](/javascript/api/powerpoint/powerpoint.documentproperties#powerpoint-powerpoint-documentproperties-category-member)|The category of the presentation.| -||[comments](/javascript/api/powerpoint/powerpoint.documentproperties#powerpoint-powerpoint-documentproperties-comments-member)|The Comments field in the metadata of the presentation.| -||[company](/javascript/api/powerpoint/powerpoint.documentproperties#powerpoint-powerpoint-documentproperties-company-member)|The company of the presentation.| -||[creationDate](/javascript/api/powerpoint/powerpoint.documentproperties#powerpoint-powerpoint-documentproperties-creationdate-member)|The creation date of the presentation.| -||[customProperties](/javascript/api/powerpoint/powerpoint.documentproperties#powerpoint-powerpoint-documentproperties-customproperties-member)|The collection of custom properties of the presentation.| -||[keywords](/javascript/api/powerpoint/powerpoint.documentproperties#powerpoint-powerpoint-documentproperties-keywords-member)|The keywords of the presentation.| -||[lastAuthor](/javascript/api/powerpoint/powerpoint.documentproperties#powerpoint-powerpoint-documentproperties-lastauthor-member)|The last author of the presentation.| -||[manager](/javascript/api/powerpoint/powerpoint.documentproperties#powerpoint-powerpoint-documentproperties-manager-member)|The manager of the presentation.| -||[revisionNumber](/javascript/api/powerpoint/powerpoint.documentproperties#powerpoint-powerpoint-documentproperties-revisionnumber-member)|The revision number of the presentation.| -||[subject](/javascript/api/powerpoint/powerpoint.documentproperties#powerpoint-powerpoint-documentproperties-subject-member)|The subject of the presentation.| -||[title](/javascript/api/powerpoint/powerpoint.documentproperties#powerpoint-powerpoint-documentproperties-title-member)|The title of the presentation.| -|[Presentation](/javascript/api/powerpoint/powerpoint.presentation)|[customXmlParts](/javascript/api/powerpoint/powerpoint.presentation#powerpoint-powerpoint-presentation-customxmlparts-member)|Returns a collection of custom XML parts that are associated with the presentation.| -||[properties](/javascript/api/powerpoint/powerpoint.presentation#powerpoint-powerpoint-presentation-properties-member)|Gets the properties of the presentation.| -|[Shape](/javascript/api/powerpoint/powerpoint.shape)|[customXmlParts](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-customxmlparts-member)|Returns a collection of custom XML parts in the shape.| -|[Slide](/javascript/api/powerpoint/powerpoint.slide)|[customXmlParts](/javascript/api/powerpoint/powerpoint.slide#powerpoint-powerpoint-slide-customxmlparts-member)|Returns a collection of custom XML parts in the slide.| -|[SlideLayout](/javascript/api/powerpoint/powerpoint.slidelayout)|[customXmlParts](/javascript/api/powerpoint/powerpoint.slidelayout#powerpoint-powerpoint-slidelayout-customxmlparts-member)|Returns a collection of custom XML parts in the slide layout.| -|[SlideMaster](/javascript/api/powerpoint/powerpoint.slidemaster)|[customXmlParts](/javascript/api/powerpoint/powerpoint.slidemaster#powerpoint-powerpoint-slidemaster-customxmlparts-member)|Returns a collection of custom XML parts in the Slide Master.| +|[CustomProperty](/.customproperty)|[delete()](/.customproperty#powerpoint-javascript/api/powerpoint/-customproperty-delete-member(1))|Deletes the custom property.| +||[key](/.customproperty#powerpoint-javascript/api/powerpoint/-customproperty-key-member)|The string that uniquely identifies the custom property.| +||[type](/.customproperty#powerpoint-javascript/api/powerpoint/-customproperty-type-member)|The type of the value used for the custom property.| +||[value](/.customproperty#powerpoint-javascript/api/powerpoint/-customproperty-value-member)|The value of the custom property.| +|[CustomPropertyCollection](/.custompropertycollection)|[add(key: string, value: boolean \| Date \| number \| string)](/.custompropertycollection#powerpoint-javascript/api/powerpoint/-custompropertycollection-add-member(1))|Creates a new `CustomProperty` or updates the property with the given key.| +||[deleteAll()](/.custompropertycollection#powerpoint-javascript/api/powerpoint/-custompropertycollection-deleteall-member(1))|Deletes all custom properties in this collection.| +||[getCount()](/.custompropertycollection#powerpoint-javascript/api/powerpoint/-custompropertycollection-getcount-member(1))|Gets the number of custom properties in the collection.| +||[getItem(key: string)](/.custompropertycollection#powerpoint-javascript/api/powerpoint/-custompropertycollection-getitem-member(1))|Gets a `CustomProperty` by its key.| +||[getItemOrNullObject(key: string)](/.custompropertycollection#powerpoint-javascript/api/powerpoint/-custompropertycollection-getitemornullobject-member(1))|Gets a `CustomProperty` by its key.| +||[items](/.custompropertycollection#powerpoint-javascript/api/powerpoint/-custompropertycollection-items-member)|Gets the loaded child items in this collection.| +|[CustomXmlPart](/.customxmlpart)|[delete()](/.customxmlpart#powerpoint-javascript/api/powerpoint/-customxmlpart-delete-member(1))|Deletes the custom XML part.| +||[getXml()](/.customxmlpart#powerpoint-javascript/api/powerpoint/-customxmlpart-getxml-member(1))|Gets the XML content of the custom XML part.| +||[id](/.customxmlpart#powerpoint-javascript/api/powerpoint/-customxmlpart-id-member)|The ID of the custom XML part.| +||[namespaceUri](/.customxmlpart#powerpoint-javascript/api/powerpoint/-customxmlpart-namespaceuri-member)|The namespace URI of the custom XML part.| +||[setXml(xml: string)](/.customxmlpart#powerpoint-javascript/api/powerpoint/-customxmlpart-setxml-member(1))|Sets the XML content for the custom XML part.| +|[CustomXmlPartCollection](/.customxmlpartcollection)|[add(xml: string)](/.customxmlpartcollection#powerpoint-javascript/api/powerpoint/-customxmlpartcollection-add-member(1))|Adds a new `CustomXmlPart` to the collection.| +||[getByNamespace(namespaceUri: string)](/.customxmlpartcollection#powerpoint-javascript/api/powerpoint/-customxmlpartcollection-getbynamespace-member(1))|Gets a new scoped collection of custom XML parts whose namespaces match the given namespace.| +||[getCount()](/.customxmlpartcollection#powerpoint-javascript/api/powerpoint/-customxmlpartcollection-getcount-member(1))|Gets the number of custom XML parts in the collection.| +||[getItem(id: string)](/.customxmlpartcollection#powerpoint-javascript/api/powerpoint/-customxmlpartcollection-getitem-member(1))|Gets a `CustomXmlPart` based on its ID.| +||[getItemOrNullObject(id: string)](/.customxmlpartcollection#powerpoint-javascript/api/powerpoint/-customxmlpartcollection-getitemornullobject-member(1))|Gets a `CustomXmlPart` based on its ID.| +||[items](/.customxmlpartcollection#powerpoint-javascript/api/powerpoint/-customxmlpartcollection-items-member)|Gets the loaded child items in this collection.| +|[CustomXmlPartScopedCollection](/.customxmlpartscopedcollection)|[getCount()](/.customxmlpartscopedcollection#powerpoint-javascript/api/powerpoint/-customxmlpartscopedcollection-getcount-member(1))|Gets the number of custom XML parts in this collection.| +||[getItem(id: string)](/.customxmlpartscopedcollection#powerpoint-javascript/api/powerpoint/-customxmlpartscopedcollection-getitem-member(1))|Gets a `CustomXmlPart` based on its ID.| +||[getItemOrNullObject(id: string)](/.customxmlpartscopedcollection#powerpoint-javascript/api/powerpoint/-customxmlpartscopedcollection-getitemornullobject-member(1))|Gets a `CustomXmlPart` based on its ID.| +||[getOnlyItem()](/.customxmlpartscopedcollection#powerpoint-javascript/api/powerpoint/-customxmlpartscopedcollection-getonlyitem-member(1))|If the collection contains exactly one item, this method returns it.| +||[getOnlyItemOrNullObject()](/.customxmlpartscopedcollection#powerpoint-javascript/api/powerpoint/-customxmlpartscopedcollection-getonlyitemornullobject-member(1))|If the collection contains exactly one item, this method returns it.| +||[items](/.customxmlpartscopedcollection#powerpoint-javascript/api/powerpoint/-customxmlpartscopedcollection-items-member)|Gets the loaded child items in this collection.| +|[DocumentProperties](/.documentproperties)|[author](/.documentproperties#powerpoint-javascript/api/powerpoint/-documentproperties-author-member)|The author of the presentation.| +||[category](/.documentproperties#powerpoint-javascript/api/powerpoint/-documentproperties-category-member)|The category of the presentation.| +||[comments](/.documentproperties#powerpoint-javascript/api/powerpoint/-documentproperties-comments-member)|The Comments field in the metadata of the presentation.| +||[company](/.documentproperties#powerpoint-javascript/api/powerpoint/-documentproperties-company-member)|The company of the presentation.| +||[creationDate](/.documentproperties#powerpoint-javascript/api/powerpoint/-documentproperties-creationdate-member)|The creation date of the presentation.| +||[customProperties](/.documentproperties#powerpoint-javascript/api/powerpoint/-documentproperties-customproperties-member)|The collection of custom properties of the presentation.| +||[keywords](/.documentproperties#powerpoint-javascript/api/powerpoint/-documentproperties-keywords-member)|The keywords of the presentation.| +||[lastAuthor](/.documentproperties#powerpoint-javascript/api/powerpoint/-documentproperties-lastauthor-member)|The last author of the presentation.| +||[manager](/.documentproperties#powerpoint-javascript/api/powerpoint/-documentproperties-manager-member)|The manager of the presentation.| +||[revisionNumber](/.documentproperties#powerpoint-javascript/api/powerpoint/-documentproperties-revisionnumber-member)|The revision number of the presentation.| +||[subject](/.documentproperties#powerpoint-javascript/api/powerpoint/-documentproperties-subject-member)|The subject of the presentation.| +||[title](/.documentproperties#powerpoint-javascript/api/powerpoint/-documentproperties-title-member)|The title of the presentation.| +|[Presentation](/.presentation)|[customXmlParts](/.presentation#powerpoint-javascript/api/powerpoint/-presentation-customxmlparts-member)|Returns a collection of custom XML parts that are associated with the presentation.| +||[properties](/.presentation#powerpoint-javascript/api/powerpoint/-presentation-properties-member)|Gets the properties of the presentation.| +|[Shape](/.shape)|[customXmlParts](/.shape#powerpoint-javascript/api/powerpoint/-shape-customxmlparts-member)|Returns a collection of custom XML parts in the shape.| +|[Slide](/.slide)|[customXmlParts](/.slide#powerpoint-javascript/api/powerpoint/-slide-customxmlparts-member)|Returns a collection of custom XML parts in the slide.| +|[SlideLayout](/.slidelayout)|[customXmlParts](/.slidelayout#powerpoint-javascript/api/powerpoint/-slidelayout-customxmlparts-member)|Returns a collection of custom XML parts in the slide layout.| +|[SlideMaster](/.slidemaster)|[customXmlParts](/.slidemaster#powerpoint-javascript/api/powerpoint/-slidemaster-customxmlparts-member)|Returns a collection of custom XML parts in the Slide Master.| diff --git a/docs/includes/powerpoint-1_8.md b/docs/includes/powerpoint-1_8.md index 9635cf1a04..6b7ec31020 100644 --- a/docs/includes/powerpoint-1_8.md +++ b/docs/includes/powerpoint-1_8.md @@ -1,114 +1,114 @@ | Class | Fields | Description | |:---|:---|:---| -|[Binding](/javascript/api/powerpoint/powerpoint.binding)|[delete()](/javascript/api/powerpoint/powerpoint.binding#powerpoint-powerpoint-binding-delete-member(1))|Deletes the binding.| -||[getShape()](/javascript/api/powerpoint/powerpoint.binding#powerpoint-powerpoint-binding-getshape-member(1))|Returns the shape represented by the binding.| -||[id](/javascript/api/powerpoint/powerpoint.binding#powerpoint-powerpoint-binding-id-member)|Represents the binding identifier.| -||[type](/javascript/api/powerpoint/powerpoint.binding#powerpoint-powerpoint-binding-type-member)|Returns the type of the binding.| -|[BindingCollection](/javascript/api/powerpoint/powerpoint.bindingcollection)|[add(shape: PowerPoint.Shape, bindingType: PowerPoint.BindingType, id: string)](/javascript/api/powerpoint/powerpoint.bindingcollection#powerpoint-powerpoint-bindingcollection-add-member(1))|Adds a new binding to a particular Shape.| -||[addFromSelection(bindingType: PowerPoint.BindingType, id: string)](/javascript/api/powerpoint/powerpoint.bindingcollection#powerpoint-powerpoint-bindingcollection-addfromselection-member(1))|Adds a new binding based on the current selection.| -||[getCount()](/javascript/api/powerpoint/powerpoint.bindingcollection#powerpoint-powerpoint-bindingcollection-getcount-member(1))|Gets the number of bindings in the collection.| -||[getItem(key: string)](/javascript/api/powerpoint/powerpoint.bindingcollection#powerpoint-powerpoint-bindingcollection-getitem-member(1))|Gets a binding object by ID.| -||[getItemAt(index: number)](/javascript/api/powerpoint/powerpoint.bindingcollection#powerpoint-powerpoint-bindingcollection-getitemat-member(1))|Gets a binding object based on its position in the items array.| -||[getItemOrNullObject(id: string)](/javascript/api/powerpoint/powerpoint.bindingcollection#powerpoint-powerpoint-bindingcollection-getitemornullobject-member(1))|Gets a binding object by ID.| -||[items](/javascript/api/powerpoint/powerpoint.bindingcollection#powerpoint-powerpoint-bindingcollection-items-member)|Gets the loaded child items in this collection.| -|[BorderProperties](/javascript/api/powerpoint/powerpoint.borderproperties)|[color](/javascript/api/powerpoint/powerpoint.borderproperties#powerpoint-powerpoint-borderproperties-color-member)|Represents the line color in the hexadecimal format #RRGGBB (e.g., "FFA500") or as a named HTML color value (e.g., "orange").| -||[dashStyle](/javascript/api/powerpoint/powerpoint.borderproperties#powerpoint-powerpoint-borderproperties-dashstyle-member)|Represents the dash style of the line.| -||[transparency](/javascript/api/powerpoint/powerpoint.borderproperties#powerpoint-powerpoint-borderproperties-transparency-member)|Specifies the transparency percentage of the line as a value from 0.0 (opaque) through 1.0 (clear).| -||[weight](/javascript/api/powerpoint/powerpoint.borderproperties#powerpoint-powerpoint-borderproperties-weight-member)|Represents the weight of the line, in points.| -|[FillProperties](/javascript/api/powerpoint/powerpoint.fillproperties)|[color](/javascript/api/powerpoint/powerpoint.fillproperties#powerpoint-powerpoint-fillproperties-color-member)|Represents the shape fill color in the hexadecimal format #RRGGBB (e.g., "FFA500") or as a named HTML color value (e.g., "orange").| -||[transparency](/javascript/api/powerpoint/powerpoint.fillproperties#powerpoint-powerpoint-fillproperties-transparency-member)|Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).| -|[FontProperties](/javascript/api/powerpoint/powerpoint.fontproperties)|[allCaps](/javascript/api/powerpoint/powerpoint.fontproperties#powerpoint-powerpoint-fontproperties-allcaps-member)|Represents whether the font uses all caps, where lowercase letters are shown as capital letters.| -||[bold](/javascript/api/powerpoint/powerpoint.fontproperties#powerpoint-powerpoint-fontproperties-bold-member)|Represents the bold status of font.| -||[color](/javascript/api/powerpoint/powerpoint.fontproperties#powerpoint-powerpoint-fontproperties-color-member)|Represents the HTML color in the hexadecimal format (e.g., "#FF0000" represents red) or as a named HTML color value (e.g., "red").| -||[doubleStrikethrough](/javascript/api/powerpoint/powerpoint.fontproperties#powerpoint-powerpoint-fontproperties-doublestrikethrough-member)|Represents the double-strikethrough status of the font.| -||[italic](/javascript/api/powerpoint/powerpoint.fontproperties#powerpoint-powerpoint-fontproperties-italic-member)|Represents the italic status of font.| -||[name](/javascript/api/powerpoint/powerpoint.fontproperties#powerpoint-powerpoint-fontproperties-name-member)|Represents the font name (e.g., "Calibri").| -||[size](/javascript/api/powerpoint/powerpoint.fontproperties#powerpoint-powerpoint-fontproperties-size-member)|Represents the font size in points (e.g., 11).| -||[smallCaps](/javascript/api/powerpoint/powerpoint.fontproperties#powerpoint-powerpoint-fontproperties-smallcaps-member)|Represents whether the text uses small caps, where lowercase letters are shown as small capital letters.| -||[strikethrough](/javascript/api/powerpoint/powerpoint.fontproperties#powerpoint-powerpoint-fontproperties-strikethrough-member)|Represents the strikethrough status of the font.| -||[subscript](/javascript/api/powerpoint/powerpoint.fontproperties#powerpoint-powerpoint-fontproperties-subscript-member)|Represents the subscript status of the font.| -||[superscript](/javascript/api/powerpoint/powerpoint.fontproperties#powerpoint-powerpoint-fontproperties-superscript-member)|Represents the superscript status of the font.| -||[underline](/javascript/api/powerpoint/powerpoint.fontproperties#powerpoint-powerpoint-fontproperties-underline-member)|Type of underline applied to the font.| -|[PlaceholderFormat](/javascript/api/powerpoint/powerpoint.placeholderformat)|[containedType](/javascript/api/powerpoint/powerpoint.placeholderformat#powerpoint-powerpoint-placeholderformat-containedtype-member)|Gets the type of the shape contained within the placeholder.| -||[type](/javascript/api/powerpoint/powerpoint.placeholderformat#powerpoint-powerpoint-placeholderformat-type-member)|Returns the type of this placeholder.| -|[Presentation](/javascript/api/powerpoint/powerpoint.presentation)|[bindings](/javascript/api/powerpoint/powerpoint.presentation#powerpoint-powerpoint-presentation-bindings-member)|Returns a collection of bindings that are associated with the presentation.| -|[Shape](/javascript/api/powerpoint/powerpoint.shape)|[getTable()](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-gettable-member(1))|Returns the `Table` object if this shape is a table.| -||[group](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-group-member)|Returns the `ShapeGroup` associated with the shape.| -||[level](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-level-member)|Returns the level of the specified shape.| -||[parentGroup](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-parentgroup-member)|Returns the parent group of this shape.| -||[placeholderFormat](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-placeholderformat-member)|Returns the properties that apply specifically to this placeholder.| -||[setZOrder(position: PowerPoint.ShapeZOrder)](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-setzorder-member(1))|Moves the specified shape up or down the collection's z-order, which shifts it in front of or behind other shapes.| -||[zOrderPosition](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-zorderposition-member)|Returns the z-order position of the shape, with 0 representing the bottom of the order stack.| -|[ShapeCollection](/javascript/api/powerpoint/powerpoint.shapecollection)|[addGroup(values: Array)](/javascript/api/powerpoint/powerpoint.shapecollection#powerpoint-powerpoint-shapecollection-addgroup-member(1))|Create a shape group for several shapes.| -||[addTable(rowCount: number, columnCount: number, options?: PowerPoint.TableAddOptions)](/javascript/api/powerpoint/powerpoint.shapecollection#powerpoint-powerpoint-shapecollection-addtable-member(1))|Adds a table to the slide.| -|[ShapeFill](/javascript/api/powerpoint/powerpoint.shapefill)|[setImage(base64EncodedImage: string)](/javascript/api/powerpoint/powerpoint.shapefill#powerpoint-powerpoint-shapefill-setimage-member(1))|Sets the fill formatting of the shape to an image.| -|[ShapeFont](/javascript/api/powerpoint/powerpoint.shapefont)|[allCaps](/javascript/api/powerpoint/powerpoint.shapefont#powerpoint-powerpoint-shapefont-allcaps-member)|Specifies whether the text in the `TextRange` is set to use the **All Caps** attribute which makes lowercase letters appear as uppercase letters.| -||[doubleStrikethrough](/javascript/api/powerpoint/powerpoint.shapefont#powerpoint-powerpoint-shapefont-doublestrikethrough-member)|Specifies whether the text in the `TextRange` is set to use the **Double strikethrough** attribute.| -||[smallCaps](/javascript/api/powerpoint/powerpoint.shapefont#powerpoint-powerpoint-shapefont-smallcaps-member)|Specifies whether the text in the `TextRange` is set to use the **Small Caps** attribute which makes lowercase letters appear as small uppercase letters.| -||[strikethrough](/javascript/api/powerpoint/powerpoint.shapefont#powerpoint-powerpoint-shapefont-strikethrough-member)|Specifies whether the text in the `TextRange` is set to use the **Strikethrough** attribute.| -||[subscript](/javascript/api/powerpoint/powerpoint.shapefont#powerpoint-powerpoint-shapefont-subscript-member)|Specifies whether the text in the `TextRange` is set to use the **Subscript** attribute.| -||[superscript](/javascript/api/powerpoint/powerpoint.shapefont#powerpoint-powerpoint-shapefont-superscript-member)|Specifies whether the text in the `TextRange` is set to use the **Superscript** attribute.| -|[ShapeGroup](/javascript/api/powerpoint/powerpoint.shapegroup)|[id](/javascript/api/powerpoint/powerpoint.shapegroup#powerpoint-powerpoint-shapegroup-id-member)|Gets the unique ID of the shape group.| -||[shape](/javascript/api/powerpoint/powerpoint.shapegroup#powerpoint-powerpoint-shapegroup-shape-member)|Returns the `Shape` object associated with the group.| -||[shapes](/javascript/api/powerpoint/powerpoint.shapegroup#powerpoint-powerpoint-shapegroup-shapes-member)|Returns the collection of `Shape` objects in the group.| -||[ungroup()](/javascript/api/powerpoint/powerpoint.shapegroup#powerpoint-powerpoint-shapegroup-ungroup-member(1))|Ungroups any grouped shapes in the specified shape group.| -|[ShapeScopedCollection](/javascript/api/powerpoint/powerpoint.shapescopedcollection)|[group()](/javascript/api/powerpoint/powerpoint.shapescopedcollection#powerpoint-powerpoint-shapescopedcollection-group-member(1))|Groups all shapes in this collection into a single shape.| -|[Slide](/javascript/api/powerpoint/powerpoint.slide)|[applyLayout(slideLayout: PowerPoint.SlideLayout)](/javascript/api/powerpoint/powerpoint.slide#powerpoint-powerpoint-slide-applylayout-member(1))|Applies the specified layout to the slide, changing its design and structure according to the chosen layout.| -||[exportAsBase64()](/javascript/api/powerpoint/powerpoint.slide#powerpoint-powerpoint-slide-exportasbase64-member(1))|Exports the slide to its own presentation file, returned as Base64-encoded data.| -||[getImageAsBase64(options?: PowerPoint.SlideGetImageOptions)](/javascript/api/powerpoint/powerpoint.slide#powerpoint-powerpoint-slide-getimageasbase64-member(1))|Renders an image of the slide.| -||[index](/javascript/api/powerpoint/powerpoint.slide#powerpoint-powerpoint-slide-index-member)|Returns the zero-based index of the slide representing its position in the presentation.| -||[moveTo(slideIndex: number)](/javascript/api/powerpoint/powerpoint.slide#powerpoint-powerpoint-slide-moveto-member(1))|Moves the slide to a new position within the presentation.| -|[SlideGetImageOptions](/javascript/api/powerpoint/powerpoint.slidegetimageoptions)|[height](/javascript/api/powerpoint/powerpoint.slidegetimageoptions#powerpoint-powerpoint-slidegetimageoptions-height-member)|The desired height of the resulting image in pixels.| -||[width](/javascript/api/powerpoint/powerpoint.slidegetimageoptions#powerpoint-powerpoint-slidegetimageoptions-width-member)|The desired width of the resulting image in pixels.| -|[SlideLayout](/javascript/api/powerpoint/powerpoint.slidelayout)|[type](/javascript/api/powerpoint/powerpoint.slidelayout#powerpoint-powerpoint-slidelayout-type-member)|Returns the type of the slide layout.| -|[Table](/javascript/api/powerpoint/powerpoint.table)|[columnCount](/javascript/api/powerpoint/powerpoint.table#powerpoint-powerpoint-table-columncount-member)|Gets the number of columns in the table.| -||[getCellOrNullObject(rowIndex: number, columnIndex: number)](/javascript/api/powerpoint/powerpoint.table#powerpoint-powerpoint-table-getcellornullobject-member(1))|Gets the cell at the specified `rowIndex` and `columnIndex`.| -||[getMergedAreas()](/javascript/api/powerpoint/powerpoint.table#powerpoint-powerpoint-table-getmergedareas-member(1))|Gets a collection of cells that represent the merged areas of the table.| -||[getShape()](/javascript/api/powerpoint/powerpoint.table#powerpoint-powerpoint-table-getshape-member(1))|Gets the shape object for the table.| -||[rowCount](/javascript/api/powerpoint/powerpoint.table#powerpoint-powerpoint-table-rowcount-member)|Gets the number of rows in the table.| -||[values](/javascript/api/powerpoint/powerpoint.table#powerpoint-powerpoint-table-values-member)|Gets all of the values in the table.| -|[TableAddOptions](/javascript/api/powerpoint/powerpoint.tableaddoptions)|[columns](/javascript/api/powerpoint/powerpoint.tableaddoptions#powerpoint-powerpoint-tableaddoptions-columns-member)|If provided, specifies properties for each column in the table.| -||[height](/javascript/api/powerpoint/powerpoint.tableaddoptions#powerpoint-powerpoint-tableaddoptions-height-member)|Specifies the height, in points, of the table.| -||[left](/javascript/api/powerpoint/powerpoint.tableaddoptions#powerpoint-powerpoint-tableaddoptions-left-member)|Specifies the distance, in points, from the left side of the table to the left side of the slide.| -||[mergedAreas](/javascript/api/powerpoint/powerpoint.tableaddoptions#powerpoint-powerpoint-tableaddoptions-mergedareas-member)|If specified, represents an rectangular area where multiple cells appear as a single cell.| -||[rows](/javascript/api/powerpoint/powerpoint.tableaddoptions#powerpoint-powerpoint-tableaddoptions-rows-member)|If provided, specifies properties for each row in the table.| -||[specificCellProperties](/javascript/api/powerpoint/powerpoint.tableaddoptions#powerpoint-powerpoint-tableaddoptions-specificcellproperties-member)|If provided, specifies properties for each cell in the table.| -||[top](/javascript/api/powerpoint/powerpoint.tableaddoptions#powerpoint-powerpoint-tableaddoptions-top-member)|Specifies the distance, in points, from the top edge of the table to the top edge of the slide.| -||[uniformCellProperties](/javascript/api/powerpoint/powerpoint.tableaddoptions#powerpoint-powerpoint-tableaddoptions-uniformcellproperties-member)|Specifies the formatting which applies uniformly to all of the table cells.| -||[values](/javascript/api/powerpoint/powerpoint.tableaddoptions#powerpoint-powerpoint-tableaddoptions-values-member)|If provided, specifies the values for the table.| -||[width](/javascript/api/powerpoint/powerpoint.tableaddoptions#powerpoint-powerpoint-tableaddoptions-width-member)|Specifies the width, in points, of the table.| -|[TableCell](/javascript/api/powerpoint/powerpoint.tablecell)|[columnCount](/javascript/api/powerpoint/powerpoint.tablecell#powerpoint-powerpoint-tablecell-columncount-member)|Gets the number of table columns this cell spans across.| -||[columnIndex](/javascript/api/powerpoint/powerpoint.tablecell#powerpoint-powerpoint-tablecell-columnindex-member)|Gets the zero-based column index of the cell within the table.| -||[rowCount](/javascript/api/powerpoint/powerpoint.tablecell#powerpoint-powerpoint-tablecell-rowcount-member)|Gets the number of table rows this cell spans across.| -||[rowIndex](/javascript/api/powerpoint/powerpoint.tablecell#powerpoint-powerpoint-tablecell-rowindex-member)|Gets the zero-based row index of the cell within the table.| -||[text](/javascript/api/powerpoint/powerpoint.tablecell#powerpoint-powerpoint-tablecell-text-member)|Specifies the text content of the table cell.| -|[TableCellBorders](/javascript/api/powerpoint/powerpoint.tablecellborders)|[bottom](/javascript/api/powerpoint/powerpoint.tablecellborders#powerpoint-powerpoint-tablecellborders-bottom-member)|Represents the bottom border.| -||[diagonalDown](/javascript/api/powerpoint/powerpoint.tablecellborders#powerpoint-powerpoint-tablecellborders-diagonaldown-member)|Represents the diagonal border (top-left to bottom-right).| -||[diagonalUp](/javascript/api/powerpoint/powerpoint.tablecellborders#powerpoint-powerpoint-tablecellborders-diagonalup-member)|Represents the diagonal border (bottom-left to top-right).| -||[left](/javascript/api/powerpoint/powerpoint.tablecellborders#powerpoint-powerpoint-tablecellborders-left-member)|Represents the left border.| -||[right](/javascript/api/powerpoint/powerpoint.tablecellborders#powerpoint-powerpoint-tablecellborders-right-member)|Represents the right border.| -||[top](/javascript/api/powerpoint/powerpoint.tablecellborders#powerpoint-powerpoint-tablecellborders-top-member)|Represents the top border.| -|[TableCellCollection](/javascript/api/powerpoint/powerpoint.tablecellcollection)|[getCount()](/javascript/api/powerpoint/powerpoint.tablecellcollection#powerpoint-powerpoint-tablecellcollection-getcount-member(1))|Gets the number of table cells in the collection.| -||[getItemAtOrNullObject(row: number, column: number)](/javascript/api/powerpoint/powerpoint.tablecellcollection#powerpoint-powerpoint-tablecellcollection-getitematornullobject-member(1))|Gets the table cell using its zero-based index in the collection.| -||[items](/javascript/api/powerpoint/powerpoint.tablecellcollection#powerpoint-powerpoint-tablecellcollection-items-member)|Gets the loaded child items in this collection.| -|[TableCellMargins](/javascript/api/powerpoint/powerpoint.tablecellmargins)|[bottom](/javascript/api/powerpoint/powerpoint.tablecellmargins#powerpoint-powerpoint-tablecellmargins-bottom-member)|Specifies the bottom margin in points.| -||[left](/javascript/api/powerpoint/powerpoint.tablecellmargins#powerpoint-powerpoint-tablecellmargins-left-member)|Specifies the left margin in points.| -||[right](/javascript/api/powerpoint/powerpoint.tablecellmargins#powerpoint-powerpoint-tablecellmargins-right-member)|Specifies the right margin in points.| -||[top](/javascript/api/powerpoint/powerpoint.tablecellmargins#powerpoint-powerpoint-tablecellmargins-top-member)|Specifies the top margin in points.| -|[TableCellProperties](/javascript/api/powerpoint/powerpoint.tablecellproperties)|[borders](/javascript/api/powerpoint/powerpoint.tablecellproperties#powerpoint-powerpoint-tablecellproperties-borders-member)|Specifies the border formatting of the table cell.| -||[fill](/javascript/api/powerpoint/powerpoint.tablecellproperties#powerpoint-powerpoint-tablecellproperties-fill-member)|Specifies the fill formatting of the table cell.| -||[font](/javascript/api/powerpoint/powerpoint.tablecellproperties#powerpoint-powerpoint-tablecellproperties-font-member)|Specifies the font formatting of the table cell.| -||[horizontalAlignment](/javascript/api/powerpoint/powerpoint.tablecellproperties#powerpoint-powerpoint-tablecellproperties-horizontalalignment-member)|Represents the horizontal alignment of the table cell.| -||[indentLevel](/javascript/api/powerpoint/powerpoint.tablecellproperties#powerpoint-powerpoint-tablecellproperties-indentlevel-member)|Represents the indent level of the text in the table cell.| -||[margins](/javascript/api/powerpoint/powerpoint.tablecellproperties#powerpoint-powerpoint-tablecellproperties-margins-member)|Specifies the margin settings in the table cell.| -||[text](/javascript/api/powerpoint/powerpoint.tablecellproperties#powerpoint-powerpoint-tablecellproperties-text-member)|Specifies the text content of the table cell.| -||[textRuns](/javascript/api/powerpoint/powerpoint.tablecellproperties#powerpoint-powerpoint-tablecellproperties-textruns-member)|Specifies the contents of the table cell as an array of PowerPoint.TextRun objects.| -||[verticalAlignment](/javascript/api/powerpoint/powerpoint.tablecellproperties#powerpoint-powerpoint-tablecellproperties-verticalalignment-member)|Represents the vertical alignment of the table cell.| -|[TableColumnProperties](/javascript/api/powerpoint/powerpoint.tablecolumnproperties)|[columnWidth](/javascript/api/powerpoint/powerpoint.tablecolumnproperties#powerpoint-powerpoint-tablecolumnproperties-columnwidth-member)|Represents the desired width of each column in points, or is undefined.| -|[TableMergedAreaProperties](/javascript/api/powerpoint/powerpoint.tablemergedareaproperties)|[columnCount](/javascript/api/powerpoint/powerpoint.tablemergedareaproperties#powerpoint-powerpoint-tablemergedareaproperties-columncount-member)|Specifies the number of columns for the merged cells area.| -||[columnIndex](/javascript/api/powerpoint/powerpoint.tablemergedareaproperties#powerpoint-powerpoint-tablemergedareaproperties-columnindex-member)|Specifies the zero-based index of the column of the top left cell of the merged area.| -||[rowCount](/javascript/api/powerpoint/powerpoint.tablemergedareaproperties#powerpoint-powerpoint-tablemergedareaproperties-rowcount-member)|Specifies the number of rows for the merged cells area.| -||[rowIndex](/javascript/api/powerpoint/powerpoint.tablemergedareaproperties#powerpoint-powerpoint-tablemergedareaproperties-rowindex-member)|Specifies the zero-based index of the row of the top left cell of the merged area.| -|[TableRowProperties](/javascript/api/powerpoint/powerpoint.tablerowproperties)|[rowHeight](/javascript/api/powerpoint/powerpoint.tablerowproperties#powerpoint-powerpoint-tablerowproperties-rowheight-member)|Represents the desired height of each row in points, or is undefined.| -|[TextRun](/javascript/api/powerpoint/powerpoint.textrun)|[font](/javascript/api/powerpoint/powerpoint.textrun#powerpoint-powerpoint-textrun-font-member)|The font attributes (such as font name, font size, and color) applied to this text run.| -||[text](/javascript/api/powerpoint/powerpoint.textrun#powerpoint-powerpoint-textrun-text-member)|The text of this text run.| +|[Binding](/.binding)|[delete()](/.binding#powerpoint-javascript/api/powerpoint/-binding-delete-member(1))|Deletes the binding.| +||[getShape()](/.binding#powerpoint-javascript/api/powerpoint/-binding-getshape-member(1))|Returns the shape represented by the binding.| +||[id](/.binding#powerpoint-javascript/api/powerpoint/-binding-id-member)|Represents the binding identifier.| +||[type](/.binding#powerpoint-javascript/api/powerpoint/-binding-type-member)|Returns the type of the binding.| +|[BindingCollection](/.bindingcollection)|[add(shape: PowerPoint.Shape, bindingType: PowerPoint.BindingType, id: string)](/.bindingcollection#powerpoint-javascript/api/powerpoint/-bindingcollection-add-member(1))|Adds a new binding to a particular Shape.| +||[addFromSelection(bindingType: PowerPoint.BindingType, id: string)](/.bindingcollection#powerpoint-javascript/api/powerpoint/-bindingcollection-addfromselection-member(1))|Adds a new binding based on the current selection.| +||[getCount()](/.bindingcollection#powerpoint-javascript/api/powerpoint/-bindingcollection-getcount-member(1))|Gets the number of bindings in the collection.| +||[getItem(key: string)](/.bindingcollection#powerpoint-javascript/api/powerpoint/-bindingcollection-getitem-member(1))|Gets a binding object by ID.| +||[getItemAt(index: number)](/.bindingcollection#powerpoint-javascript/api/powerpoint/-bindingcollection-getitemat-member(1))|Gets a binding object based on its position in the items array.| +||[getItemOrNullObject(id: string)](/.bindingcollection#powerpoint-javascript/api/powerpoint/-bindingcollection-getitemornullobject-member(1))|Gets a binding object by ID.| +||[items](/.bindingcollection#powerpoint-javascript/api/powerpoint/-bindingcollection-items-member)|Gets the loaded child items in this collection.| +|[BorderProperties](/.borderproperties)|[color](/.borderproperties#powerpoint-javascript/api/powerpoint/-borderproperties-color-member)|Represents the line color in the hexadecimal format #RRGGBB (e.g., "FFA500") or as a named HTML color value (e.g., "orange").| +||[dashStyle](/.borderproperties#powerpoint-javascript/api/powerpoint/-borderproperties-dashstyle-member)|Represents the dash style of the line.| +||[transparency](/.borderproperties#powerpoint-javascript/api/powerpoint/-borderproperties-transparency-member)|Specifies the transparency percentage of the line as a value from 0.0 (opaque) through 1.0 (clear).| +||[weight](/.borderproperties#powerpoint-javascript/api/powerpoint/-borderproperties-weight-member)|Represents the weight of the line, in points.| +|[FillProperties](/.fillproperties)|[color](/.fillproperties#powerpoint-javascript/api/powerpoint/-fillproperties-color-member)|Represents the shape fill color in the hexadecimal format #RRGGBB (e.g., "FFA500") or as a named HTML color value (e.g., "orange").| +||[transparency](/.fillproperties#powerpoint-javascript/api/powerpoint/-fillproperties-transparency-member)|Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).| +|[FontProperties](/.fontproperties)|[allCaps](/.fontproperties#powerpoint-javascript/api/powerpoint/-fontproperties-allcaps-member)|Represents whether the font uses all caps, where lowercase letters are shown as capital letters.| +||[bold](/.fontproperties#powerpoint-javascript/api/powerpoint/-fontproperties-bold-member)|Represents the bold status of font.| +||[color](/.fontproperties#powerpoint-javascript/api/powerpoint/-fontproperties-color-member)|Represents the HTML color in the hexadecimal format (e.g., "#FF0000" represents red) or as a named HTML color value (e.g., "red").| +||[doubleStrikethrough](/.fontproperties#powerpoint-javascript/api/powerpoint/-fontproperties-doublestrikethrough-member)|Represents the double-strikethrough status of the font.| +||[italic](/.fontproperties#powerpoint-javascript/api/powerpoint/-fontproperties-italic-member)|Represents the italic status of font.| +||[name](/.fontproperties#powerpoint-javascript/api/powerpoint/-fontproperties-name-member)|Represents the font name (e.g., "Calibri").| +||[size](/.fontproperties#powerpoint-javascript/api/powerpoint/-fontproperties-size-member)|Represents the font size in points (e.g., 11).| +||[smallCaps](/.fontproperties#powerpoint-javascript/api/powerpoint/-fontproperties-smallcaps-member)|Represents whether the text uses small caps, where lowercase letters are shown as small capital letters.| +||[strikethrough](/.fontproperties#powerpoint-javascript/api/powerpoint/-fontproperties-strikethrough-member)|Represents the strikethrough status of the font.| +||[subscript](/.fontproperties#powerpoint-javascript/api/powerpoint/-fontproperties-subscript-member)|Represents the subscript status of the font.| +||[superscript](/.fontproperties#powerpoint-javascript/api/powerpoint/-fontproperties-superscript-member)|Represents the superscript status of the font.| +||[underline](/.fontproperties#powerpoint-javascript/api/powerpoint/-fontproperties-underline-member)|Type of underline applied to the font.| +|[PlaceholderFormat](/.placeholderformat)|[containedType](/.placeholderformat#powerpoint-javascript/api/powerpoint/-placeholderformat-containedtype-member)|Gets the type of the shape contained within the placeholder.| +||[type](/.placeholderformat#powerpoint-javascript/api/powerpoint/-placeholderformat-type-member)|Returns the type of this placeholder.| +|[Presentation](/.presentation)|[bindings](/.presentation#powerpoint-javascript/api/powerpoint/-presentation-bindings-member)|Returns a collection of bindings that are associated with the presentation.| +|[Shape](/.shape)|[getTable()](/.shape#powerpoint-javascript/api/powerpoint/-shape-gettable-member(1))|Returns the `Table` object if this shape is a table.| +||[group](/.shape#powerpoint-javascript/api/powerpoint/-shape-group-member)|Returns the `ShapeGroup` associated with the shape.| +||[level](/.shape#powerpoint-javascript/api/powerpoint/-shape-level-member)|Returns the level of the specified shape.| +||[parentGroup](/.shape#powerpoint-javascript/api/powerpoint/-shape-parentgroup-member)|Returns the parent group of this shape.| +||[placeholderFormat](/.shape#powerpoint-javascript/api/powerpoint/-shape-placeholderformat-member)|Returns the properties that apply specifically to this placeholder.| +||[setZOrder(position: PowerPoint.ShapeZOrder)](/.shape#powerpoint-javascript/api/powerpoint/-shape-setzorder-member(1))|Moves the specified shape up or down the collection's z-order, which shifts it in front of or behind other shapes.| +||[zOrderPosition](/.shape#powerpoint-javascript/api/powerpoint/-shape-zorderposition-member)|Returns the z-order position of the shape, with 0 representing the bottom of the order stack.| +|[ShapeCollection](/.shapecollection)|[addGroup(values: Array)](/.shapecollection#powerpoint-javascript/api/powerpoint/-shapecollection-addgroup-member(1))|Create a shape group for several shapes.| +||[addTable(rowCount: number, columnCount: number, options?: PowerPoint.TableAddOptions)](/.shapecollection#powerpoint-javascript/api/powerpoint/-shapecollection-addtable-member(1))|Adds a table to the slide.| +|[ShapeFill](/.shapefill)|[setImage(base64EncodedImage: string)](/.shapefill#powerpoint-javascript/api/powerpoint/-shapefill-setimage-member(1))|Sets the fill formatting of the shape to an image.| +|[ShapeFont](/.shapefont)|[allCaps](/.shapefont#powerpoint-javascript/api/powerpoint/-shapefont-allcaps-member)|Specifies whether the text in the `TextRange` is set to use the **All Caps** attribute which makes lowercase letters appear as uppercase letters.| +||[doubleStrikethrough](/.shapefont#powerpoint-javascript/api/powerpoint/-shapefont-doublestrikethrough-member)|Specifies whether the text in the `TextRange` is set to use the **Double strikethrough** attribute.| +||[smallCaps](/.shapefont#powerpoint-javascript/api/powerpoint/-shapefont-smallcaps-member)|Specifies whether the text in the `TextRange` is set to use the **Small Caps** attribute which makes lowercase letters appear as small uppercase letters.| +||[strikethrough](/.shapefont#powerpoint-javascript/api/powerpoint/-shapefont-strikethrough-member)|Specifies whether the text in the `TextRange` is set to use the **Strikethrough** attribute.| +||[subscript](/.shapefont#powerpoint-javascript/api/powerpoint/-shapefont-subscript-member)|Specifies whether the text in the `TextRange` is set to use the **Subscript** attribute.| +||[superscript](/.shapefont#powerpoint-javascript/api/powerpoint/-shapefont-superscript-member)|Specifies whether the text in the `TextRange` is set to use the **Superscript** attribute.| +|[ShapeGroup](/.shapegroup)|[id](/.shapegroup#powerpoint-javascript/api/powerpoint/-shapegroup-id-member)|Gets the unique ID of the shape group.| +||[shape](/.shapegroup#powerpoint-javascript/api/powerpoint/-shapegroup-shape-member)|Returns the `Shape` object associated with the group.| +||[shapes](/.shapegroup#powerpoint-javascript/api/powerpoint/-shapegroup-shapes-member)|Returns the collection of `Shape` objects in the group.| +||[ungroup()](/.shapegroup#powerpoint-javascript/api/powerpoint/-shapegroup-ungroup-member(1))|Ungroups any grouped shapes in the specified shape group.| +|[ShapeScopedCollection](/.shapescopedcollection)|[group()](/.shapescopedcollection#powerpoint-javascript/api/powerpoint/-shapescopedcollection-group-member(1))|Groups all shapes in this collection into a single shape.| +|[Slide](/.slide)|[applyLayout(slideLayout: PowerPoint.SlideLayout)](/.slide#powerpoint-javascript/api/powerpoint/-slide-applylayout-member(1))|Applies the specified layout to the slide, changing its design and structure according to the chosen layout.| +||[exportAsBase64()](/.slide#powerpoint-javascript/api/powerpoint/-slide-exportasbase64-member(1))|Exports the slide to its own presentation file, returned as Base64-encoded data.| +||[getImageAsBase64(options?: PowerPoint.SlideGetImageOptions)](/.slide#powerpoint-javascript/api/powerpoint/-slide-getimageasbase64-member(1))|Renders an image of the slide.| +||[index](/.slide#powerpoint-javascript/api/powerpoint/-slide-index-member)|Returns the zero-based index of the slide representing its position in the presentation.| +||[moveTo(slideIndex: number)](/.slide#powerpoint-javascript/api/powerpoint/-slide-moveto-member(1))|Moves the slide to a new position within the presentation.| +|[SlideGetImageOptions](/.slidegetimageoptions)|[height](/.slidegetimageoptions#powerpoint-javascript/api/powerpoint/-slidegetimageoptions-height-member)|The desired height of the resulting image in pixels.| +||[width](/.slidegetimageoptions#powerpoint-javascript/api/powerpoint/-slidegetimageoptions-width-member)|The desired width of the resulting image in pixels.| +|[SlideLayout](/.slidelayout)|[type](/.slidelayout#powerpoint-javascript/api/powerpoint/-slidelayout-type-member)|Returns the type of the slide layout.| +|[Table](/.table)|[columnCount](/.table#powerpoint-javascript/api/powerpoint/-table-columncount-member)|Gets the number of columns in the table.| +||[getCellOrNullObject(rowIndex: number, columnIndex: number)](/.table#powerpoint-javascript/api/powerpoint/-table-getcellornullobject-member(1))|Gets the cell at the specified `rowIndex` and `columnIndex`.| +||[getMergedAreas()](/.table#powerpoint-javascript/api/powerpoint/-table-getmergedareas-member(1))|Gets a collection of cells that represent the merged areas of the table.| +||[getShape()](/.table#powerpoint-javascript/api/powerpoint/-table-getshape-member(1))|Gets the shape object for the table.| +||[rowCount](/.table#powerpoint-javascript/api/powerpoint/-table-rowcount-member)|Gets the number of rows in the table.| +||[values](/.table#powerpoint-javascript/api/powerpoint/-table-values-member)|Gets all of the values in the table.| +|[TableAddOptions](/.tableaddoptions)|[columns](/.tableaddoptions#powerpoint-javascript/api/powerpoint/-tableaddoptions-columns-member)|If provided, specifies properties for each column in the table.| +||[height](/.tableaddoptions#powerpoint-javascript/api/powerpoint/-tableaddoptions-height-member)|Specifies the height, in points, of the table.| +||[left](/.tableaddoptions#powerpoint-javascript/api/powerpoint/-tableaddoptions-left-member)|Specifies the distance, in points, from the left side of the table to the left side of the slide.| +||[mergedAreas](/.tableaddoptions#powerpoint-javascript/api/powerpoint/-tableaddoptions-mergedareas-member)|If specified, represents an rectangular area where multiple cells appear as a single cell.| +||[rows](/.tableaddoptions#powerpoint-javascript/api/powerpoint/-tableaddoptions-rows-member)|If provided, specifies properties for each row in the table.| +||[specificCellProperties](/.tableaddoptions#powerpoint-javascript/api/powerpoint/-tableaddoptions-specificcellproperties-member)|If provided, specifies properties for each cell in the table.| +||[top](/.tableaddoptions#powerpoint-javascript/api/powerpoint/-tableaddoptions-top-member)|Specifies the distance, in points, from the top edge of the table to the top edge of the slide.| +||[uniformCellProperties](/.tableaddoptions#powerpoint-javascript/api/powerpoint/-tableaddoptions-uniformcellproperties-member)|Specifies the formatting which applies uniformly to all of the table cells.| +||[values](/.tableaddoptions#powerpoint-javascript/api/powerpoint/-tableaddoptions-values-member)|If provided, specifies the values for the table.| +||[width](/.tableaddoptions#powerpoint-javascript/api/powerpoint/-tableaddoptions-width-member)|Specifies the width, in points, of the table.| +|[TableCell](/.tablecell)|[columnCount](/.tablecell#powerpoint-javascript/api/powerpoint/-tablecell-columncount-member)|Gets the number of table columns this cell spans across.| +||[columnIndex](/.tablecell#powerpoint-javascript/api/powerpoint/-tablecell-columnindex-member)|Gets the zero-based column index of the cell within the table.| +||[rowCount](/.tablecell#powerpoint-javascript/api/powerpoint/-tablecell-rowcount-member)|Gets the number of table rows this cell spans across.| +||[rowIndex](/.tablecell#powerpoint-javascript/api/powerpoint/-tablecell-rowindex-member)|Gets the zero-based row index of the cell within the table.| +||[text](/.tablecell#powerpoint-javascript/api/powerpoint/-tablecell-text-member)|Specifies the text content of the table cell.| +|[TableCellBorders](/.tablecellborders)|[bottom](/.tablecellborders#powerpoint-javascript/api/powerpoint/-tablecellborders-bottom-member)|Represents the bottom border.| +||[diagonalDown](/.tablecellborders#powerpoint-javascript/api/powerpoint/-tablecellborders-diagonaldown-member)|Represents the diagonal border (top-left to bottom-right).| +||[diagonalUp](/.tablecellborders#powerpoint-javascript/api/powerpoint/-tablecellborders-diagonalup-member)|Represents the diagonal border (bottom-left to top-right).| +||[left](/.tablecellborders#powerpoint-javascript/api/powerpoint/-tablecellborders-left-member)|Represents the left border.| +||[right](/.tablecellborders#powerpoint-javascript/api/powerpoint/-tablecellborders-right-member)|Represents the right border.| +||[top](/.tablecellborders#powerpoint-javascript/api/powerpoint/-tablecellborders-top-member)|Represents the top border.| +|[TableCellCollection](/.tablecellcollection)|[getCount()](/.tablecellcollection#powerpoint-javascript/api/powerpoint/-tablecellcollection-getcount-member(1))|Gets the number of table cells in the collection.| +||[getItemAtOrNullObject(row: number, column: number)](/.tablecellcollection#powerpoint-javascript/api/powerpoint/-tablecellcollection-getitematornullobject-member(1))|Gets the table cell using its zero-based index in the collection.| +||[items](/.tablecellcollection#powerpoint-javascript/api/powerpoint/-tablecellcollection-items-member)|Gets the loaded child items in this collection.| +|[TableCellMargins](/.tablecellmargins)|[bottom](/.tablecellmargins#powerpoint-javascript/api/powerpoint/-tablecellmargins-bottom-member)|Specifies the bottom margin in points.| +||[left](/.tablecellmargins#powerpoint-javascript/api/powerpoint/-tablecellmargins-left-member)|Specifies the left margin in points.| +||[right](/.tablecellmargins#powerpoint-javascript/api/powerpoint/-tablecellmargins-right-member)|Specifies the right margin in points.| +||[top](/.tablecellmargins#powerpoint-javascript/api/powerpoint/-tablecellmargins-top-member)|Specifies the top margin in points.| +|[TableCellProperties](/.tablecellproperties)|[borders](/.tablecellproperties#powerpoint-javascript/api/powerpoint/-tablecellproperties-borders-member)|Specifies the border formatting of the table cell.| +||[fill](/.tablecellproperties#powerpoint-javascript/api/powerpoint/-tablecellproperties-fill-member)|Specifies the fill formatting of the table cell.| +||[font](/.tablecellproperties#powerpoint-javascript/api/powerpoint/-tablecellproperties-font-member)|Specifies the font formatting of the table cell.| +||[horizontalAlignment](/.tablecellproperties#powerpoint-javascript/api/powerpoint/-tablecellproperties-horizontalalignment-member)|Represents the horizontal alignment of the table cell.| +||[indentLevel](/.tablecellproperties#powerpoint-javascript/api/powerpoint/-tablecellproperties-indentlevel-member)|Represents the indent level of the text in the table cell.| +||[margins](/.tablecellproperties#powerpoint-javascript/api/powerpoint/-tablecellproperties-margins-member)|Specifies the margin settings in the table cell.| +||[text](/.tablecellproperties#powerpoint-javascript/api/powerpoint/-tablecellproperties-text-member)|Specifies the text content of the table cell.| +||[textRuns](/.tablecellproperties#powerpoint-javascript/api/powerpoint/-tablecellproperties-textruns-member)|Specifies the contents of the table cell as an array of PowerPoint.TextRun objects.| +||[verticalAlignment](/.tablecellproperties#powerpoint-javascript/api/powerpoint/-tablecellproperties-verticalalignment-member)|Represents the vertical alignment of the table cell.| +|[TableColumnProperties](/.tablecolumnproperties)|[columnWidth](/.tablecolumnproperties#powerpoint-javascript/api/powerpoint/-tablecolumnproperties-columnwidth-member)|Represents the desired width of each column in points, or is undefined.| +|[TableMergedAreaProperties](/.tablemergedareaproperties)|[columnCount](/.tablemergedareaproperties#powerpoint-javascript/api/powerpoint/-tablemergedareaproperties-columncount-member)|Specifies the number of columns for the merged cells area.| +||[columnIndex](/.tablemergedareaproperties#powerpoint-javascript/api/powerpoint/-tablemergedareaproperties-columnindex-member)|Specifies the zero-based index of the column of the top left cell of the merged area.| +||[rowCount](/.tablemergedareaproperties#powerpoint-javascript/api/powerpoint/-tablemergedareaproperties-rowcount-member)|Specifies the number of rows for the merged cells area.| +||[rowIndex](/.tablemergedareaproperties#powerpoint-javascript/api/powerpoint/-tablemergedareaproperties-rowindex-member)|Specifies the zero-based index of the row of the top left cell of the merged area.| +|[TableRowProperties](/.tablerowproperties)|[rowHeight](/.tablerowproperties#powerpoint-javascript/api/powerpoint/-tablerowproperties-rowheight-member)|Represents the desired height of each row in points, or is undefined.| +|[TextRun](/.textrun)|[font](/.textrun#powerpoint-javascript/api/powerpoint/-textrun-font-member)|The font attributes (such as font name, font size, and color) applied to this text run.| +||[text](/.textrun#powerpoint-javascript/api/powerpoint/-textrun-text-member)|The text of this text run.| diff --git a/docs/includes/powerpoint-1_9.md b/docs/includes/powerpoint-1_9.md index 60a54f4c51..da61604c58 100644 --- a/docs/includes/powerpoint-1_9.md +++ b/docs/includes/powerpoint-1_9.md @@ -1,51 +1,51 @@ | Class | Fields | Description | |:---|:---|:---| -|[Border](/javascript/api/powerpoint/powerpoint.border)|[color](/javascript/api/powerpoint/powerpoint.border#powerpoint-powerpoint-border-color-member)|Represents the line color in the hexadecimal format #RRGGBB (e.g., "FFA500") or as a named HTML color value (e.g., "orange").| -||[dashStyle](/javascript/api/powerpoint/powerpoint.border#powerpoint-powerpoint-border-dashstyle-member)|Represents the dash style of the line.| -||[transparency](/javascript/api/powerpoint/powerpoint.border#powerpoint-powerpoint-border-transparency-member)|Specifies the transparency percentage of the line as a value from 0.0 (opaque) through 1.0 (clear).| -||[weight](/javascript/api/powerpoint/powerpoint.border#powerpoint-powerpoint-border-weight-member)|Represents the weight of the line, in points.| -|[Borders](/javascript/api/powerpoint/powerpoint.borders)|[bottom](/javascript/api/powerpoint/powerpoint.borders#powerpoint-powerpoint-borders-bottom-member)|Gets the bottom border.| -||[diagonalDown](/javascript/api/powerpoint/powerpoint.borders#powerpoint-powerpoint-borders-diagonaldown-member)|Gets the diagonal border (top-left to bottom-right).| -||[diagonalUp](/javascript/api/powerpoint/powerpoint.borders#powerpoint-powerpoint-borders-diagonalup-member)|Gets the diagonal border (bottom-left to top-right).| -||[left](/javascript/api/powerpoint/powerpoint.borders#powerpoint-powerpoint-borders-left-member)|Gets the left border.| -||[right](/javascript/api/powerpoint/powerpoint.borders#powerpoint-powerpoint-borders-right-member)|Gets the right border.| -||[top](/javascript/api/powerpoint/powerpoint.borders#powerpoint-powerpoint-borders-top-member)|Gets the top border.| -|[Margins](/javascript/api/powerpoint/powerpoint.margins)|[bottom](/javascript/api/powerpoint/powerpoint.margins#powerpoint-powerpoint-margins-bottom-member)|Specifies the bottom margin in points.| -||[left](/javascript/api/powerpoint/powerpoint.margins#powerpoint-powerpoint-margins-left-member)|Specifies the left margin in points.| -||[right](/javascript/api/powerpoint/powerpoint.margins#powerpoint-powerpoint-margins-right-member)|Specifies the right margin in points.| -||[top](/javascript/api/powerpoint/powerpoint.margins#powerpoint-powerpoint-margins-top-member)|Specifies the top margin in points.| -|[Table](/javascript/api/powerpoint/powerpoint.table)|[clear(options?: PowerPoint.TableClearOptions)](/javascript/api/powerpoint/powerpoint.table#powerpoint-powerpoint-table-clear-member(1))|Clears table values and formatting.| -||[columns](/javascript/api/powerpoint/powerpoint.table#powerpoint-powerpoint-table-columns-member)|Gets the collection of columns in the table.| -||[mergeCells(rowIndex: number, columnIndex: number, rowCount: number, columnCount: number)](/javascript/api/powerpoint/powerpoint.table#powerpoint-powerpoint-table-mergecells-member(1))|Creates a merged area starting at the cell specified by rowIndex and columnIndex.| -||[rows](/javascript/api/powerpoint/powerpoint.table#powerpoint-powerpoint-table-rows-member)|Gets the collection of rows in the table.| -|[TableAddOptions](/javascript/api/powerpoint/powerpoint.tableaddoptions)|[style](/javascript/api/powerpoint/powerpoint.tableaddoptions#powerpoint-powerpoint-tableaddoptions-style-member)|Specifies value that represents the table style.| -|[TableCell](/javascript/api/powerpoint/powerpoint.tablecell)|[borders](/javascript/api/powerpoint/powerpoint.tablecell#powerpoint-powerpoint-tablecell-borders-member)|Gets the collection of borders for the table cell.| -||[fill](/javascript/api/powerpoint/powerpoint.tablecell#powerpoint-powerpoint-tablecell-fill-member)|Gets the fill color of the table cell.| -||[font](/javascript/api/powerpoint/powerpoint.tablecell#powerpoint-powerpoint-tablecell-font-member)|Gets the font of the table cell.| -||[horizontalAlignment](/javascript/api/powerpoint/powerpoint.tablecell#powerpoint-powerpoint-tablecell-horizontalalignment-member)|Specifies the horizontal alignment of the table cell.| -||[indentLevel](/javascript/api/powerpoint/powerpoint.tablecell#powerpoint-powerpoint-tablecell-indentlevel-member)|Specifies the indent level of the table cell.| -||[margins](/javascript/api/powerpoint/powerpoint.tablecell#powerpoint-powerpoint-tablecell-margins-member)|Gets the set of margins in the table cell.| -||[resize(rowCount: number, columnCount: number)](/javascript/api/powerpoint/powerpoint.tablecell#powerpoint-powerpoint-tablecell-resize-member(1))|Resizes the table cell to span across a specified number of rows and columns.| -||[split(rowCount: number, columnCount: number)](/javascript/api/powerpoint/powerpoint.tablecell#powerpoint-powerpoint-tablecell-split-member(1))|Splits the cell into the specified number of rows and columns.| -||[textRuns](/javascript/api/powerpoint/powerpoint.tablecell#powerpoint-powerpoint-tablecell-textruns-member)|Specifies the contents of the table cell as an array of PowerPoint.TextRun objects.| -||[verticalAlignment](/javascript/api/powerpoint/powerpoint.tablecell#powerpoint-powerpoint-tablecell-verticalalignment-member)|Specifies the vertical alignment of the text in the table cell.| -|[TableClearOptions](/javascript/api/powerpoint/powerpoint.tableclearoptions)|[all](/javascript/api/powerpoint/powerpoint.tableclearoptions#powerpoint-powerpoint-tableclearoptions-all-member)|Specifies if both values and formatting of the table should be cleared.| -||[format](/javascript/api/powerpoint/powerpoint.tableclearoptions#powerpoint-powerpoint-tableclearoptions-format-member)|Specifies if the formatting of the table should be cleared.| -||[text](/javascript/api/powerpoint/powerpoint.tableclearoptions#powerpoint-powerpoint-tableclearoptions-text-member)|Specifies if the values of the table should be cleared.| -|[TableColumn](/javascript/api/powerpoint/powerpoint.tablecolumn)|[columnIndex](/javascript/api/powerpoint/powerpoint.tablecolumn#powerpoint-powerpoint-tablecolumn-columnindex-member)|Returns the index number of the column within the column collection of the table.| -||[delete()](/javascript/api/powerpoint/powerpoint.tablecolumn#powerpoint-powerpoint-tablecolumn-delete-member(1))|Deletes the column.| -||[width](/javascript/api/powerpoint/powerpoint.tablecolumn#powerpoint-powerpoint-tablecolumn-width-member)|Retrieves the width of the column in points.| -|[TableColumnCollection](/javascript/api/powerpoint/powerpoint.tablecolumncollection)|[add(index?: number \| null \| undefined, count?: number \| undefined)](/javascript/api/powerpoint/powerpoint.tablecolumncollection#powerpoint-powerpoint-tablecolumncollection-add-member(1))|Adds one or more columns to the table.| -||[deleteColumns(columns: PowerPoint.TableColumn[])](/javascript/api/powerpoint/powerpoint.tablecolumncollection#powerpoint-powerpoint-tablecolumncollection-deletecolumns-member(1))|Deletes the specified columns from the collection.| -||[getCount()](/javascript/api/powerpoint/powerpoint.tablecolumncollection#powerpoint-powerpoint-tablecolumncollection-getcount-member(1))|Gets the number of columns in the collection.| -||[getItemAt(index: number)](/javascript/api/powerpoint/powerpoint.tablecolumncollection#powerpoint-powerpoint-tablecolumncollection-getitemat-member(1))|Gets the column using its zero-based index in the collection.| -||[items](/javascript/api/powerpoint/powerpoint.tablecolumncollection#powerpoint-powerpoint-tablecolumncollection-items-member)|Gets the loaded child items in this collection.| -|[TableRow](/javascript/api/powerpoint/powerpoint.tablerow)|[currentHeight](/javascript/api/powerpoint/powerpoint.tablerow#powerpoint-powerpoint-tablerow-currentheight-member)|Retrieves the current height of the row in points.| -||[delete()](/javascript/api/powerpoint/powerpoint.tablerow#powerpoint-powerpoint-tablerow-delete-member(1))|Deletes the row.| -||[height](/javascript/api/powerpoint/powerpoint.tablerow#powerpoint-powerpoint-tablerow-height-member)|Specifies the height of the row in points.| -||[rowIndex](/javascript/api/powerpoint/powerpoint.tablerow#powerpoint-powerpoint-tablerow-rowindex-member)|Returns the index number of the row within the rows collection of the table.| -|[TableRowCollection](/javascript/api/powerpoint/powerpoint.tablerowcollection)|[add(index?: number \| null \| undefined, count?: number \| undefined)](/javascript/api/powerpoint/powerpoint.tablerowcollection#powerpoint-powerpoint-tablerowcollection-add-member(1))|Adds one or more rows to the table.| -||[deleteRows(rows: PowerPoint.TableRow[])](/javascript/api/powerpoint/powerpoint.tablerowcollection#powerpoint-powerpoint-tablerowcollection-deleterows-member(1))|Deletes the specified rows from the collection.| -||[getCount()](/javascript/api/powerpoint/powerpoint.tablerowcollection#powerpoint-powerpoint-tablerowcollection-getcount-member(1))|Gets the number of rows in the collection.| -||[getItemAt(index: number)](/javascript/api/powerpoint/powerpoint.tablerowcollection#powerpoint-powerpoint-tablerowcollection-getitemat-member(1))|Gets the row using its zero-based index in the collection.| -||[items](/javascript/api/powerpoint/powerpoint.tablerowcollection#powerpoint-powerpoint-tablerowcollection-items-member)|Gets the loaded child items in this collection.| +|[Border](/.border)|[color](/.border#powerpoint-javascript/api/powerpoint/-border-color-member)|Represents the line color in the hexadecimal format #RRGGBB (e.g., "FFA500") or as a named HTML color value (e.g., "orange").| +||[dashStyle](/.border#powerpoint-javascript/api/powerpoint/-border-dashstyle-member)|Represents the dash style of the line.| +||[transparency](/.border#powerpoint-javascript/api/powerpoint/-border-transparency-member)|Specifies the transparency percentage of the line as a value from 0.0 (opaque) through 1.0 (clear).| +||[weight](/.border#powerpoint-javascript/api/powerpoint/-border-weight-member)|Represents the weight of the line, in points.| +|[Borders](/.borders)|[bottom](/.borders#powerpoint-javascript/api/powerpoint/-borders-bottom-member)|Gets the bottom border.| +||[diagonalDown](/.borders#powerpoint-javascript/api/powerpoint/-borders-diagonaldown-member)|Gets the diagonal border (top-left to bottom-right).| +||[diagonalUp](/.borders#powerpoint-javascript/api/powerpoint/-borders-diagonalup-member)|Gets the diagonal border (bottom-left to top-right).| +||[left](/.borders#powerpoint-javascript/api/powerpoint/-borders-left-member)|Gets the left border.| +||[right](/.borders#powerpoint-javascript/api/powerpoint/-borders-right-member)|Gets the right border.| +||[top](/.borders#powerpoint-javascript/api/powerpoint/-borders-top-member)|Gets the top border.| +|[Margins](/.margins)|[bottom](/.margins#powerpoint-javascript/api/powerpoint/-margins-bottom-member)|Specifies the bottom margin in points.| +||[left](/.margins#powerpoint-javascript/api/powerpoint/-margins-left-member)|Specifies the left margin in points.| +||[right](/.margins#powerpoint-javascript/api/powerpoint/-margins-right-member)|Specifies the right margin in points.| +||[top](/.margins#powerpoint-javascript/api/powerpoint/-margins-top-member)|Specifies the top margin in points.| +|[Table](/.table)|[clear(options?: PowerPoint.TableClearOptions)](/.table#powerpoint-javascript/api/powerpoint/-table-clear-member(1))|Clears table values and formatting.| +||[columns](/.table#powerpoint-javascript/api/powerpoint/-table-columns-member)|Gets the collection of columns in the table.| +||[mergeCells(rowIndex: number, columnIndex: number, rowCount: number, columnCount: number)](/.table#powerpoint-javascript/api/powerpoint/-table-mergecells-member(1))|Creates a merged area starting at the cell specified by rowIndex and columnIndex.| +||[rows](/.table#powerpoint-javascript/api/powerpoint/-table-rows-member)|Gets the collection of rows in the table.| +|[TableAddOptions](/.tableaddoptions)|[style](/.tableaddoptions#powerpoint-javascript/api/powerpoint/-tableaddoptions-style-member)|Specifies value that represents the table style.| +|[TableCell](/.tablecell)|[borders](/.tablecell#powerpoint-javascript/api/powerpoint/-tablecell-borders-member)|Gets the collection of borders for the table cell.| +||[fill](/.tablecell#powerpoint-javascript/api/powerpoint/-tablecell-fill-member)|Gets the fill color of the table cell.| +||[font](/.tablecell#powerpoint-javascript/api/powerpoint/-tablecell-font-member)|Gets the font of the table cell.| +||[horizontalAlignment](/.tablecell#powerpoint-javascript/api/powerpoint/-tablecell-horizontalalignment-member)|Specifies the horizontal alignment of the table cell.| +||[indentLevel](/.tablecell#powerpoint-javascript/api/powerpoint/-tablecell-indentlevel-member)|Specifies the indent level of the table cell.| +||[margins](/.tablecell#powerpoint-javascript/api/powerpoint/-tablecell-margins-member)|Gets the set of margins in the table cell.| +||[resize(rowCount: number, columnCount: number)](/.tablecell#powerpoint-javascript/api/powerpoint/-tablecell-resize-member(1))|Resizes the table cell to span across a specified number of rows and columns.| +||[split(rowCount: number, columnCount: number)](/.tablecell#powerpoint-javascript/api/powerpoint/-tablecell-split-member(1))|Splits the cell into the specified number of rows and columns.| +||[textRuns](/.tablecell#powerpoint-javascript/api/powerpoint/-tablecell-textruns-member)|Specifies the contents of the table cell as an array of PowerPoint.TextRun objects.| +||[verticalAlignment](/.tablecell#powerpoint-javascript/api/powerpoint/-tablecell-verticalalignment-member)|Specifies the vertical alignment of the text in the table cell.| +|[TableClearOptions](/.tableclearoptions)|[all](/.tableclearoptions#powerpoint-javascript/api/powerpoint/-tableclearoptions-all-member)|Specifies if both values and formatting of the table should be cleared.| +||[format](/.tableclearoptions#powerpoint-javascript/api/powerpoint/-tableclearoptions-format-member)|Specifies if the formatting of the table should be cleared.| +||[text](/.tableclearoptions#powerpoint-javascript/api/powerpoint/-tableclearoptions-text-member)|Specifies if the values of the table should be cleared.| +|[TableColumn](/.tablecolumn)|[columnIndex](/.tablecolumn#powerpoint-javascript/api/powerpoint/-tablecolumn-columnindex-member)|Returns the index number of the column within the column collection of the table.| +||[delete()](/.tablecolumn#powerpoint-javascript/api/powerpoint/-tablecolumn-delete-member(1))|Deletes the column.| +||[width](/.tablecolumn#powerpoint-javascript/api/powerpoint/-tablecolumn-width-member)|Retrieves the width of the column in points.| +|[TableColumnCollection](/.tablecolumncollection)|[add(index?: number \| null \| undefined, count?: number \| undefined)](/.tablecolumncollection#powerpoint-javascript/api/powerpoint/-tablecolumncollection-add-member(1))|Adds one or more columns to the table.| +||[deleteColumns(columns: PowerPoint.TableColumn[])](/.tablecolumncollection#powerpoint-javascript/api/powerpoint/-tablecolumncollection-deletecolumns-member(1))|Deletes the specified columns from the collection.| +||[getCount()](/.tablecolumncollection#powerpoint-javascript/api/powerpoint/-tablecolumncollection-getcount-member(1))|Gets the number of columns in the collection.| +||[getItemAt(index: number)](/.tablecolumncollection#powerpoint-javascript/api/powerpoint/-tablecolumncollection-getitemat-member(1))|Gets the column using its zero-based index in the collection.| +||[items](/.tablecolumncollection#powerpoint-javascript/api/powerpoint/-tablecolumncollection-items-member)|Gets the loaded child items in this collection.| +|[TableRow](/.tablerow)|[currentHeight](/.tablerow#powerpoint-javascript/api/powerpoint/-tablerow-currentheight-member)|Retrieves the current height of the row in points.| +||[delete()](/.tablerow#powerpoint-javascript/api/powerpoint/-tablerow-delete-member(1))|Deletes the row.| +||[height](/.tablerow#powerpoint-javascript/api/powerpoint/-tablerow-height-member)|Specifies the height of the row in points.| +||[rowIndex](/.tablerow#powerpoint-javascript/api/powerpoint/-tablerow-rowindex-member)|Returns the index number of the row within the rows collection of the table.| +|[TableRowCollection](/.tablerowcollection)|[add(index?: number \| null \| undefined, count?: number \| undefined)](/.tablerowcollection#powerpoint-javascript/api/powerpoint/-tablerowcollection-add-member(1))|Adds one or more rows to the table.| +||[deleteRows(rows: PowerPoint.TableRow[])](/.tablerowcollection#powerpoint-javascript/api/powerpoint/-tablerowcollection-deleterows-member(1))|Deletes the specified rows from the collection.| +||[getCount()](/.tablerowcollection#powerpoint-javascript/api/powerpoint/-tablerowcollection-getcount-member(1))|Gets the number of rows in the collection.| +||[getItemAt(index: number)](/.tablerowcollection#powerpoint-javascript/api/powerpoint/-tablerowcollection-getitemat-member(1))|Gets the row using its zero-based index in the collection.| +||[items](/.tablerowcollection#powerpoint-javascript/api/powerpoint/-tablerowcollection-items-member)|Gets the loaded child items in this collection.| diff --git a/docs/includes/powerpoint-preview.md b/docs/includes/powerpoint-preview.md index bfd7c35008..35be2b749c 100644 --- a/docs/includes/powerpoint-preview.md +++ b/docs/includes/powerpoint-preview.md @@ -1,67 +1,67 @@ | Class | Fields | Description | |:---|:---|:---| -|[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.| -|[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)|[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`.| -||[rotation](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-rotation-member)|Specifies the rotation, in degrees, of the shape around the z-axis.| -||[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.| -|[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.| -|[Table](/javascript/api/powerpoint/powerpoint.table)|[styleOptions](/javascript/api/powerpoint/powerpoint.table#powerpoint-powerpoint-table-styleoptions-member)|Gets the table style options.| -|[TableStyleOptions](/javascript/api/powerpoint/powerpoint.tablestyleoptions)|[areColumnsBanded](/javascript/api/powerpoint/powerpoint.tablestyleoptions#powerpoint-powerpoint-tablestyleoptions-arecolumnsbanded-member)|Specifies if the columns show banded formatting in which odd columns are highlighted differently from even ones, to make reading the table easier.| -||[areRowsBanded](/javascript/api/powerpoint/powerpoint.tablestyleoptions#powerpoint-powerpoint-tablestyleoptions-arerowsbanded-member)|Specifies if the rows show banded formatting in which odd rows are highlighted differently from even ones, to make reading the table easier.| -||[isFirstColumnHighlighted](/javascript/api/powerpoint/powerpoint.tablestyleoptions#powerpoint-powerpoint-tablestyleoptions-isfirstcolumnhighlighted-member)|Specifies if the first column contains special formatting.| -||[isFirstRowHighlighted](/javascript/api/powerpoint/powerpoint.tablestyleoptions#powerpoint-powerpoint-tablestyleoptions-isfirstrowhighlighted-member)|Specifies if the first row contains special formatting.| -||[isLastColumnHighlighted](/javascript/api/powerpoint/powerpoint.tablestyleoptions#powerpoint-powerpoint-tablestyleoptions-islastcolumnhighlighted-member)|Specifies if the last column contains special formatting.| -||[isLastRowHighlighted](/javascript/api/powerpoint/powerpoint.tablestyleoptions#powerpoint-powerpoint-tablestyleoptions-islastrowhighlighted-member)|Specifies if the last row contains special formatting.| -||[style](/javascript/api/powerpoint/powerpoint.tablestyleoptions#powerpoint-powerpoint-tablestyleoptions-style-member)|Specifies the table style.| -|[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`.| +|[BulletFormat](/.bulletformat)|[style](/.bulletformat#powerpoint-javascript/api/powerpoint/-bulletformat-style-member)|Specifies the style of the bullets in the paragraph.| +||[type](/.bulletformat#powerpoint-javascript/api/powerpoint/-bulletformat-type-member)|Specifies the type of the bullets in the paragraph.| +|[PageSetup](/.pagesetup)|[slideHeight](/.pagesetup#powerpoint-javascript/api/powerpoint/-pagesetup-slideheight-member)|Specifies the height of the slides in the presentation, in points.| +||[slideWidth](/.pagesetup#powerpoint-javascript/api/powerpoint/-pagesetup-slidewidth-member)|Specifies the width of the slides in the presentation, in points.| +|[ParagraphFormat](/.paragraphformat)|[indentLevel](/.paragraphformat#powerpoint-javascript/api/powerpoint/-paragraphformat-indentlevel-member)|Represents the indent level of the paragraph.| +|[Presentation](/.presentation)|[pageSetup](/.presentation#powerpoint-javascript/api/powerpoint/-presentation-pagesetup-member)|Returns the page setup information whose properties control slide setup attributes for the presentation.| +|[Shape](/.shape)|[getImageAsBase64(options?: PowerPoint.ShapeGetImageOptions)](/.shape#powerpoint-javascript/api/powerpoint/-shape-getimageasbase64-member(1))|Renders an image of the shape.| +||[getTextFrameOrNullObject()](/.shape#powerpoint-javascript/api/powerpoint/-shape-gettextframeornullobject-member(1))|Returns the PowerPoint.TextFrame object of this `Shape`.| +||[rotation](/.shape#powerpoint-javascript/api/powerpoint/-shape-rotation-member)|Specifies the rotation, in degrees, of the shape around the z-axis.| +||[visible](/.shape#powerpoint-javascript/api/powerpoint/-shape-visible-member)|Specifies if the shape is visible.| +|[ShapeGetImageOptions](/.shapegetimageoptions)|[format](/.shapegetimageoptions#powerpoint-javascript/api/powerpoint/-shapegetimageoptions-format-member)|The desired format of the resulting image.| +||[height](/.shapegetimageoptions#powerpoint-javascript/api/powerpoint/-shapegetimageoptions-height-member)|The desired height of the resulting image in pixels.| +||[width](/.shapegetimageoptions#powerpoint-javascript/api/powerpoint/-shapegetimageoptions-width-member)|The desired width of the resulting image in pixels.| +|[Slide](/.slide)|[background](/.slide#powerpoint-javascript/api/powerpoint/-slide-background-member)|Gets the background of the slide.| +||[themeColorScheme](/.slide#powerpoint-javascript/api/powerpoint/-slide-themecolorscheme-member)|Returns the `ThemeColorScheme` of the slide.| +|[SlideBackground](/.slidebackground)|[areBackgroundGraphicsHidden](/.slidebackground#powerpoint-javascript/api/powerpoint/-slidebackground-arebackgroundgraphicshidden-member)|Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.| +||[fill](/.slidebackground#powerpoint-javascript/api/powerpoint/-slidebackground-fill-member)|Returns the fill formatting of the background.| +||[isMasterBackgroundFollowed](/.slidebackground#powerpoint-javascript/api/powerpoint/-slidebackground-ismasterbackgroundfollowed-member)|Specifies if the slide background follows the slide master background.| +||[reset()](/.slidebackground#powerpoint-javascript/api/powerpoint/-slidebackground-reset-member(1))|Resets the fill formatting of the slide background.| +|[SlideBackgroundFill](/.slidebackgroundfill)|[getGradientFillOrNullObject()](/.slidebackgroundfill#powerpoint-javascript/api/powerpoint/-slidebackgroundfill-getgradientfillornullobject-member(1))|Gets the gradient fill properties.| +||[getPatternFillOrNullObject()](/.slidebackgroundfill#powerpoint-javascript/api/powerpoint/-slidebackgroundfill-getpatternfillornullobject-member(1))|Gets the pattern fill properties.| +||[getPictureOrTextureFillOrNullObject()](/.slidebackgroundfill#powerpoint-javascript/api/powerpoint/-slidebackgroundfill-getpictureortexturefillornullobject-member(1))|Gets the picture or texture fill properties.| +||[getSolidFillOrNullObject()](/.slidebackgroundfill#powerpoint-javascript/api/powerpoint/-slidebackgroundfill-getsolidfillornullobject-member(1))|Gets the solid fill properties.| +||[setGradientFill(options?: PowerPoint.SlideBackgroundGradientFillOptions)](/.slidebackgroundfill#powerpoint-javascript/api/powerpoint/-slidebackgroundfill-setgradientfill-member(1))|Sets the fill formatting of the slide background to a gradient fill.| +||[setPatternFill(options?: PowerPoint.SlideBackgroundPatternFillOptions)](/.slidebackgroundfill#powerpoint-javascript/api/powerpoint/-slidebackgroundfill-setpatternfill-member(1))|Sets the fill formatting of the slide background to a pattern fill.| +||[setPictureOrTextureFill(options?: PowerPoint.SlideBackgroundPictureOrTextureFillOptions)](/.slidebackgroundfill#powerpoint-javascript/api/powerpoint/-slidebackgroundfill-setpictureortexturefill-member(1))|Sets the fill formatting of the slide background to a picture or texture fill.| +||[setSolidFill(options?: PowerPoint.SlideBackgroundSolidFillOptions)](/.slidebackgroundfill#powerpoint-javascript/api/powerpoint/-slidebackgroundfill-setsolidfill-member(1))|Sets the fill formatting of the slide background to a solid fill.| +||[type](/.slidebackgroundfill#powerpoint-javascript/api/powerpoint/-slidebackgroundfill-type-member)|Returns the fill type of the slide background.| +|[SlideBackgroundGradientFill](/.slidebackgroundgradientfill)|[type](/.slidebackgroundgradientfill#powerpoint-javascript/api/powerpoint/-slidebackgroundgradientfill-type-member)|Specifies the type of gradient fill.| +|[SlideBackgroundGradientFillOptions](/.slidebackgroundgradientfilloptions)|[type](/.slidebackgroundgradientfilloptions#powerpoint-javascript/api/powerpoint/-slidebackgroundgradientfilloptions-type-member)|If provided, specifies the type of gradient fill.| +|[SlideBackgroundPatternFill](/.slidebackgroundpatternfill)|[backgroundColor](/.slidebackgroundpatternfill#powerpoint-javascript/api/powerpoint/-slidebackgroundpatternfill-backgroundcolor-member)|Specifies the background color in HTML color format (e.g., "#FFFFFF" or "white").| +||[foregroundColor](/.slidebackgroundpatternfill#powerpoint-javascript/api/powerpoint/-slidebackgroundpatternfill-foregroundcolor-member)|Specifies the foreground color in HTML color format (e.g., "#FFA500" or "orange").| +||[pattern](/.slidebackgroundpatternfill#powerpoint-javascript/api/powerpoint/-slidebackgroundpatternfill-pattern-member)|Specifies the pattern type.| +|[SlideBackgroundPatternFillOptions](/.slidebackgroundpatternfilloptions)|[backgroundColor](/.slidebackgroundpatternfilloptions#powerpoint-javascript/api/powerpoint/-slidebackgroundpatternfilloptions-backgroundcolor-member)|If provided, specifies the background color in HTML color format (e.g., "#FFFFFF" or "white").| +||[foregroundColor](/.slidebackgroundpatternfilloptions#powerpoint-javascript/api/powerpoint/-slidebackgroundpatternfilloptions-foregroundcolor-member)|If provided, specifies the foreground color in HTML color format (e.g., "#FFA500" or "orange").| +||[pattern](/.slidebackgroundpatternfilloptions#powerpoint-javascript/api/powerpoint/-slidebackgroundpatternfilloptions-pattern-member)|If provided, specifies the pattern type.| +|[SlideBackgroundPictureOrTextureFill](/.slidebackgroundpictureortexturefill)|[setImage(base64EncodedImage: string)](/.slidebackgroundpictureortexturefill#powerpoint-javascript/api/powerpoint/-slidebackgroundpictureortexturefill-setimage-member(1))|Sets the image used to fill.| +||[transparency](/.slidebackgroundpictureortexturefill#powerpoint-javascript/api/powerpoint/-slidebackgroundpictureortexturefill-transparency-member)|Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).| +|[SlideBackgroundPictureOrTextureFillOptions](/.slidebackgroundpictureortexturefilloptions)|[imageBase64](/.slidebackgroundpictureortexturefilloptions#powerpoint-javascript/api/powerpoint/-slidebackgroundpictureortexturefilloptions-imagebase64-member)|If provided, specifies the Base64-encoded image data for the fill.| +||[transparency](/.slidebackgroundpictureortexturefilloptions#powerpoint-javascript/api/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](/.slidebackgroundsolidfill)|[color](/.slidebackgroundsolidfill#powerpoint-javascript/api/powerpoint/-slidebackgroundsolidfill-color-member)|Specifies the fill color in HTML color format (e.g., "#FFA500" or "orange").| +||[transparency](/.slidebackgroundsolidfill#powerpoint-javascript/api/powerpoint/-slidebackgroundsolidfill-transparency-member)|Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).| +|[SlideBackgroundSolidFillOptions](/.slidebackgroundsolidfilloptions)|[color](/.slidebackgroundsolidfilloptions#powerpoint-javascript/api/powerpoint/-slidebackgroundsolidfilloptions-color-member)|If provided, specifies the fill color in HTML color format (e.g., "#FFA500" or "orange").| +||[transparency](/.slidebackgroundsolidfilloptions#powerpoint-javascript/api/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](/.slidecollection)|[exportAsBase64Presentation(values: Array)](/.slidecollection#powerpoint-javascript/api/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](/.slidelayout)|[background](/.slidelayout#powerpoint-javascript/api/powerpoint/-slidelayout-background-member)|Gets the background of the slide layout.| +||[themeColorScheme](/.slidelayout#powerpoint-javascript/api/powerpoint/-slidelayout-themecolorscheme-member)|Returns the `ThemeColorScheme` of the slide layout.| +|[SlideLayoutBackground](/.slidelayoutbackground)|[areBackgroundGraphicsHidden](/.slidelayoutbackground#powerpoint-javascript/api/powerpoint/-slidelayoutbackground-arebackgroundgraphicshidden-member)|Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.| +||[fill](/.slidelayoutbackground#powerpoint-javascript/api/powerpoint/-slidelayoutbackground-fill-member)|Returns the fill formatting of the background.| +||[isMasterBackgroundFollowed](/.slidelayoutbackground#powerpoint-javascript/api/powerpoint/-slidelayoutbackground-ismasterbackgroundfollowed-member)|Specifies if the slide layout background follows the slide master background.| +||[reset()](/.slidelayoutbackground#powerpoint-javascript/api/powerpoint/-slidelayoutbackground-reset-member(1))|Resets the fill formatting of the slide layout background.| +|[SlideMaster](/.slidemaster)|[background](/.slidemaster#powerpoint-javascript/api/powerpoint/-slidemaster-background-member)|Gets the background of the Slide Master.| +||[themeColorScheme](/.slidemaster#powerpoint-javascript/api/powerpoint/-slidemaster-themecolorscheme-member)|Returns the `ThemeColorScheme` of the Slide Master.| +|[SlideMasterBackground](/.slidemasterbackground)|[fill](/.slidemasterbackground#powerpoint-javascript/api/powerpoint/-slidemasterbackground-fill-member)|Returns the fill formatting of the background.| +|[SlideScopedCollection](/.slidescopedcollection)|[exportAsBase64Presentation()](/.slidescopedcollection#powerpoint-javascript/api/powerpoint/-slidescopedcollection-exportasbase64presentation-member(1))|Exports all slides in this collection to their own presentation file, returned as Base64-encoded data.| +|[Table](/.table)|[styleOptions](/.table#powerpoint-javascript/api/powerpoint/-table-styleoptions-member)|Gets the table style options.| +|[TableStyleOptions](/.tablestyleoptions)|[areColumnsBanded](/.tablestyleoptions#powerpoint-javascript/api/powerpoint/-tablestyleoptions-arecolumnsbanded-member)|Specifies if the columns show banded formatting in which odd columns are highlighted differently from even ones, to make reading the table easier.| +||[areRowsBanded](/.tablestyleoptions#powerpoint-javascript/api/powerpoint/-tablestyleoptions-arerowsbanded-member)|Specifies if the rows show banded formatting in which odd rows are highlighted differently from even ones, to make reading the table easier.| +||[isFirstColumnHighlighted](/.tablestyleoptions#powerpoint-javascript/api/powerpoint/-tablestyleoptions-isfirstcolumnhighlighted-member)|Specifies if the first column contains special formatting.| +||[isFirstRowHighlighted](/.tablestyleoptions#powerpoint-javascript/api/powerpoint/-tablestyleoptions-isfirstrowhighlighted-member)|Specifies if the first row contains special formatting.| +||[isLastColumnHighlighted](/.tablestyleoptions#powerpoint-javascript/api/powerpoint/-tablestyleoptions-islastcolumnhighlighted-member)|Specifies if the last column contains special formatting.| +||[isLastRowHighlighted](/.tablestyleoptions#powerpoint-javascript/api/powerpoint/-tablestyleoptions-islastrowhighlighted-member)|Specifies if the last row contains special formatting.| +||[style](/.tablestyleoptions#powerpoint-javascript/api/powerpoint/-tablestyleoptions-style-member)|Specifies the table style.| +|[ThemeColorScheme](/.themecolorscheme)|[getThemeColor(color: PowerPoint.ThemeColor)](/.themecolorscheme#powerpoint-javascript/api/powerpoint/-themecolorscheme-getthemecolor-member(1))|Gets the color value for the specified `ThemeColor`.| +||[setThemeColor(color: PowerPoint.ThemeColor, rgbColor: string)](/.themecolorscheme#powerpoint-javascript/api/powerpoint/-themecolorscheme-setthemecolor-member(1))|Sets the color value for the specified `ThemeColor`.| diff --git a/docs/includes/word-1_1.md b/docs/includes/word-1_1.md index 9e8dda311c..06eb395503 100644 --- a/docs/includes/word-1_1.md +++ b/docs/includes/word-1_1.md @@ -1,144 +1,144 @@ | Class | Fields | Description | |:---|:---|:---| -|[Body](/javascript/api/word/word.body)|[clear()](/javascript/api/word/word.body#word-word-body-clear-member(1))|Clears the contents of the body object.| -||[contentControls](/javascript/api/word/word.body#word-word-body-contentcontrols-member)|Gets the collection of rich text content control objects in the body.| -||[font](/javascript/api/word/word.body#word-word-body-font-member)|Gets the text format of the body.| -||[getHtml()](/javascript/api/word/word.body#word-word-body-gethtml-member(1))|Gets an HTML representation of the body object.| -||[getOoxml()](/javascript/api/word/word.body#word-word-body-getooxml-member(1))|Gets the OOXML (Office Open XML) representation of the body object.| -||[inlinePictures](/javascript/api/word/word.body#word-word-body-inlinepictures-member)|Gets the collection of InlinePicture objects in the body.| -||[insertBreak(breakType: Word.BreakType \| "Page" \| "Next" \| "SectionNext" \| "SectionContinuous" \| "SectionEven" \| "SectionOdd" \| "Line", insertLocation: Word.InsertLocation.start \| Word.InsertLocation.end \| "Start" \| "End")](/javascript/api/word/word.body#word-word-body-insertbreak-member(1))|Inserts a break at the specified location in the main document.| -||[insertContentControl(contentControlType?: Word.ContentControlType.richText \| Word.ContentControlType.plainText \| Word.ContentControlType.checkBox \| Word.ContentControlType.dropDownList \| Word.ContentControlType.comboBox \| "RichText" \| "PlainText" \| "CheckBox" \| "DropDownList" \| "ComboBox")](/javascript/api/word/word.body#word-word-body-insertcontentcontrol-member(1))|Wraps the Body object with a content control.| -||[insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/javascript/api/word/word.body#word-word-body-insertfilefrombase64-member(1))|Inserts a document into the body at the specified location.| -||[insertHtml(html: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/javascript/api/word/word.body#word-word-body-inserthtml-member(1))|Inserts HTML at the specified location.| -||[insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/javascript/api/word/word.body#word-word-body-insertooxml-member(1))|Inserts OOXML at the specified location.| -||[insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.start \| Word.InsertLocation.end \| "Start" \| "End")](/javascript/api/word/word.body#word-word-body-insertparagraph-member(1))|Inserts a paragraph at the specified location.| -||[insertText(text: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/javascript/api/word/word.body#word-word-body-inserttext-member(1))|Inserts text into the body at the specified location.| -||[paragraphs](/javascript/api/word/word.body#word-word-body-paragraphs-member)|Gets the collection of paragraph objects in the body.| -||[parentContentControl](/javascript/api/word/word.body#word-word-body-parentcontentcontrol-member)|Gets the content control that contains the body.| -||[search(searchText: string, searchOptions?: Word.SearchOptions \| { ignorePunct?: boolean ignoreSpace?: boolean matchCase?: boolean matchPrefix?: boolean matchSuffix?: boolean matchWholeWord?: boolean matchWildcards?: boolean })](/javascript/api/word/word.body#word-word-body-search-member(1))|Performs a search with the specified SearchOptions on the scope of the body object.| -||[select(selectionMode?: Word.SelectionMode)](/javascript/api/word/word.body#word-word-body-select-member(1))|Selects the body and navigates the Word UI to it.| -||[style](/javascript/api/word/word.body#word-word-body-style-member)|Specifies the style name for the body.| -||[text](/javascript/api/word/word.body#word-word-body-text-member)|Gets the text of the body.| -|[ContentControl](/javascript/api/word/word.contentcontrol)|[appearance](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-appearance-member)|Specifies the appearance of the content control.| -||[cannotDelete](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-cannotdelete-member)|Specifies a value that indicates whether the user can delete the content control.| -||[cannotEdit](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-cannotedit-member)|Specifies a value that indicates whether the user can edit the contents of the content control.| -||[clear()](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-clear-member(1))|Clears the contents of the content control.| -||[color](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-color-member)|Specifies the color of the content control.| -||[contentControls](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-contentcontrols-member)|Gets the collection of content control objects in the content control.| -||[delete(keepContent: boolean)](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-delete-member(1))|Deletes the content control and its content.| -||[font](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-font-member)|Gets the text format of the content control.| -||[getHtml()](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-gethtml-member(1))|Gets an HTML representation of the content control object.| -||[getOoxml()](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-getooxml-member(1))|Gets the Office Open XML (OOXML) representation of the content control object.| -||[id](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-id-member)|Gets an integer that represents the content control identifier.| -||[inlinePictures](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-inlinepictures-member)|Gets the collection of InlinePicture objects in the content control.| -||[insertBreak(breakType: Word.BreakType \| "Page" \| "Next" \| "SectionNext" \| "SectionContinuous" \| "SectionEven" \| "SectionOdd" \| "Line", insertLocation: Word.InsertLocation.start \| Word.InsertLocation.end \| Word.InsertLocation.before \| Word.InsertLocation.after \| "Start" \| "End" \| "Before" \| "After")](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-insertbreak-member(1))|Inserts a break at the specified location in the main document.| -||[insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-insertfilefrombase64-member(1))|Inserts a document into the content control at the specified location.| -||[insertHtml(html: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-inserthtml-member(1))|Inserts HTML into the content control at the specified location.| -||[insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-insertooxml-member(1))|Inserts OOXML into the content control at the specified location.| -||[insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.start \| Word.InsertLocation.end \| Word.InsertLocation.before \| Word.InsertLocation.after \| "Start" \| "End" \| "Before" \| "After")](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-insertparagraph-member(1))|Inserts a paragraph at the specified location.| -||[insertText(text: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-inserttext-member(1))|Inserts text into the content control at the specified location.| -||[paragraphs](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-paragraphs-member)|Gets the collection of paragraph objects in the content control.| -||[parentContentControl](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-parentcontentcontrol-member)|Gets the content control that contains the content control.| -||[placeholderText](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-placeholdertext-member)|Specifies the placeholder text of the content control.| -||[removeWhenEdited](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-removewhenedited-member)|Specifies a value that indicates whether the content control is removed after it is edited.| -||[search(searchText: string, searchOptions?: Word.SearchOptions \| { ignorePunct?: boolean ignoreSpace?: boolean matchCase?: boolean matchPrefix?: boolean matchSuffix?: boolean matchWholeWord?: boolean matchWildcards?: boolean })](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-search-member(1))|Performs a search with the specified SearchOptions on the scope of the content control object.| -||[select(selectionMode?: Word.SelectionMode)](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-select-member(1))|Selects the content control.| -||[style](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-style-member)|Specifies the style name for the content control.| -||[tag](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-tag-member)|Specifies a tag to identify a content control.| -||[text](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-text-member)|Gets the text of the content control.| -||[title](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-title-member)|Specifies the title for a content control.| -||[type](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-type-member)|Gets the content control type.| -|[ContentControlCollection](/javascript/api/word/word.contentcontrolcollection)|[getById(id: number)](/javascript/api/word/word.contentcontrolcollection#word-word-contentcontrolcollection-getbyid-member(1))|Gets a content control by its identifier.| -||[getByTag(tag: string)](/javascript/api/word/word.contentcontrolcollection#word-word-contentcontrolcollection-getbytag-member(1))|Gets the content controls that have the specified tag.| -||[getByTitle(title: string)](/javascript/api/word/word.contentcontrolcollection#word-word-contentcontrolcollection-getbytitle-member(1))|Gets the content controls that have the specified title.| -||[getItem(id: number)](/javascript/api/word/word.contentcontrolcollection#word-word-contentcontrolcollection-getitem-member(1))|Gets a content control by its ID.| -||[items](/javascript/api/word/word.contentcontrolcollection#word-word-contentcontrolcollection-items-member)|Gets the loaded child items in this collection.| -|[Document](/javascript/api/word/word.document)|[body](/javascript/api/word/word.document#word-word-document-body-member)|Gets the body object of the main document.| -||[contentControls](/javascript/api/word/word.document#word-word-document-contentcontrols-member)|Gets the collection of content control objects in the document.| -||[getSelection()](/javascript/api/word/word.document#word-word-document-getselection-member(1))|Gets the current selection of the document.| -||[save(saveBehavior?: Word.SaveBehavior, fileName?: string)](/javascript/api/word/word.document#word-word-document-save-member(1))|Saves the document.| -||[saved](/javascript/api/word/word.document#word-word-document-saved-member)|Indicates whether the changes in the document have been saved.| -||[sections](/javascript/api/word/word.document#word-word-document-sections-member)|Gets the collection of section objects in the document.| -|[Font](/javascript/api/word/word.font)|[bold](/javascript/api/word/word.font#word-word-font-bold-member)|Specifies a value that indicates whether the font is bold.| -||[color](/javascript/api/word/word.font#word-word-font-color-member)|Specifies the color for the specified font.| -||[doubleStrikeThrough](/javascript/api/word/word.font#word-word-font-doublestrikethrough-member)|Specifies a value that indicates whether the font has a double strikethrough.| -||[highlightColor](/javascript/api/word/word.font#word-word-font-highlightcolor-member)|Specifies the highlight color.| -||[italic](/javascript/api/word/word.font#word-word-font-italic-member)|Specifies a value that indicates whether the font is italicized.| -||[name](/javascript/api/word/word.font#word-word-font-name-member)|Specifies a value that represents the name of the font.| -||[size](/javascript/api/word/word.font#word-word-font-size-member)|Specifies a value that represents the font size in points.| -||[strikeThrough](/javascript/api/word/word.font#word-word-font-strikethrough-member)|Specifies a value that indicates whether the font has a strikethrough.| -||[subscript](/javascript/api/word/word.font#word-word-font-subscript-member)|Specifies a value that indicates whether the font is a subscript.| -||[superscript](/javascript/api/word/word.font#word-word-font-superscript-member)|Specifies a value that indicates whether the font is a superscript.| -||[underline](/javascript/api/word/word.font#word-word-font-underline-member)|Specifies a value that indicates the font's underline type.| -|[InlinePicture](/javascript/api/word/word.inlinepicture)|[altTextDescription](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-alttextdescription-member)|Specifies a string that represents the alternative text associated with the inline image.| -||[altTextTitle](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-alttexttitle-member)|Specifies a string that contains the title for the inline image.| -||[getBase64ImageSrc()](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-getbase64imagesrc-member(1))|Gets the Base64-encoded string representation of the inline image.| -||[height](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-height-member)|Specifies a number that describes the height of the inline image.| -||[hyperlink](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-hyperlink-member)|Specifies a hyperlink on the image.| -||[insertContentControl()](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-insertcontentcontrol-member(1))|Wraps the inline picture with a rich text content control.| -||[lockAspectRatio](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-lockaspectratio-member)|Specifies a value that indicates whether the inline image retains its original proportions when you resize it.| -||[parentContentControl](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-parentcontentcontrol-member)|Gets the content control that contains the inline image.| -||[width](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-width-member)|Specifies a number that describes the width of the inline image.| -|[InlinePictureCollection](/javascript/api/word/word.inlinepicturecollection)|[items](/javascript/api/word/word.inlinepicturecollection#word-word-inlinepicturecollection-items-member)|Gets the loaded child items in this collection.| -|[Paragraph](/javascript/api/word/word.paragraph)|[alignment](/javascript/api/word/word.paragraph#word-word-paragraph-alignment-member)|Specifies the alignment for a paragraph.| -||[clear()](/javascript/api/word/word.paragraph#word-word-paragraph-clear-member(1))|Clears the contents of the paragraph object.| -||[contentControls](/javascript/api/word/word.paragraph#word-word-paragraph-contentcontrols-member)|Gets the collection of content control objects in the paragraph.| -||[delete()](/javascript/api/word/word.paragraph#word-word-paragraph-delete-member(1))|Deletes the paragraph and its content from the document.| -||[firstLineIndent](/javascript/api/word/word.paragraph#word-word-paragraph-firstlineindent-member)|Specifies the value, in points, for a first line or hanging indent.| -||[font](/javascript/api/word/word.paragraph#word-word-paragraph-font-member)|Gets the text format of the paragraph.| -||[getHtml()](/javascript/api/word/word.paragraph#word-word-paragraph-gethtml-member(1))|Gets an HTML representation of the paragraph object.| -||[getOoxml()](/javascript/api/word/word.paragraph#word-word-paragraph-getooxml-member(1))|Gets the Office Open XML (OOXML) representation of the paragraph object.| -||[inlinePictures](/javascript/api/word/word.paragraph#word-word-paragraph-inlinepictures-member)|Gets the collection of InlinePicture objects in the paragraph.| -||[insertBreak(breakType: Word.BreakType \| "Page" \| "Next" \| "SectionNext" \| "SectionContinuous" \| "SectionEven" \| "SectionOdd" \| "Line", insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After")](/javascript/api/word/word.paragraph#word-word-paragraph-insertbreak-member(1))|Inserts a break at the specified location in the main document.| -||[insertContentControl(contentControlType?: Word.ContentControlType.richText \| Word.ContentControlType.plainText \| Word.ContentControlType.checkBox \| Word.ContentControlType.dropDownList \| Word.ContentControlType.comboBox \| "RichText" \| "PlainText" \| "CheckBox" \| "DropDownList" \| "ComboBox")](/javascript/api/word/word.paragraph#word-word-paragraph-insertcontentcontrol-member(1))|Wraps the Paragraph object with a content control.| -||[insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/javascript/api/word/word.paragraph#word-word-paragraph-insertfilefrombase64-member(1))|Inserts a document into the paragraph at the specified location.| -||[insertHtml(html: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/javascript/api/word/word.paragraph#word-word-paragraph-inserthtml-member(1))|Inserts HTML into the paragraph at the specified location.| -||[insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/javascript/api/word/word.paragraph#word-word-paragraph-insertinlinepicturefrombase64-member(1))|Inserts a picture into the paragraph at the specified location.| -||[insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/javascript/api/word/word.paragraph#word-word-paragraph-insertooxml-member(1))|Inserts OOXML into the paragraph at the specified location.| -||[insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After")](/javascript/api/word/word.paragraph#word-word-paragraph-insertparagraph-member(1))|Inserts a paragraph at the specified location.| -||[insertText(text: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/javascript/api/word/word.paragraph#word-word-paragraph-inserttext-member(1))|Inserts text into the paragraph at the specified location.| -||[leftIndent](/javascript/api/word/word.paragraph#word-word-paragraph-leftindent-member)|Specifies the left indent value, in points, for the paragraph.| -||[lineSpacing](/javascript/api/word/word.paragraph#word-word-paragraph-linespacing-member)|Specifies the line spacing, in points, for the specified paragraph.| -||[lineUnitAfter](/javascript/api/word/word.paragraph#word-word-paragraph-lineunitafter-member)|Specifies the amount of spacing, in grid lines, after the paragraph.| -||[lineUnitBefore](/javascript/api/word/word.paragraph#word-word-paragraph-lineunitbefore-member)|Specifies the amount of spacing, in grid lines, before the paragraph.| -||[outlineLevel](/javascript/api/word/word.paragraph#word-word-paragraph-outlinelevel-member)|Specifies the outline level for the paragraph.| -||[parentContentControl](/javascript/api/word/word.paragraph#word-word-paragraph-parentcontentcontrol-member)|Gets the content control that contains the paragraph.| -||[rightIndent](/javascript/api/word/word.paragraph#word-word-paragraph-rightindent-member)|Specifies the right indent value, in points, for the paragraph.| -||[search(searchText: string, searchOptions?: Word.SearchOptions \| { ignorePunct?: boolean ignoreSpace?: boolean matchCase?: boolean matchPrefix?: boolean matchSuffix?: boolean matchWholeWord?: boolean matchWildcards?: boolean })](/javascript/api/word/word.paragraph#word-word-paragraph-search-member(1))|Performs a search with the specified SearchOptions on the scope of the paragraph object.| -||[select(selectionMode?: Word.SelectionMode)](/javascript/api/word/word.paragraph#word-word-paragraph-select-member(1))|Selects and navigates the Word UI to the paragraph.| -||[spaceAfter](/javascript/api/word/word.paragraph#word-word-paragraph-spaceafter-member)|Specifies the spacing, in points, after the paragraph.| -||[spaceBefore](/javascript/api/word/word.paragraph#word-word-paragraph-spacebefore-member)|Specifies the spacing, in points, before the paragraph.| -||[style](/javascript/api/word/word.paragraph#word-word-paragraph-style-member)|Specifies the style name for the paragraph.| -||[text](/javascript/api/word/word.paragraph#word-word-paragraph-text-member)|Gets the text of the paragraph.| -|[ParagraphCollection](/javascript/api/word/word.paragraphcollection)|[items](/javascript/api/word/word.paragraphcollection#word-word-paragraphcollection-items-member)|Gets the loaded child items in this collection.| -|[Range](/javascript/api/word/word.range)|[clear()](/javascript/api/word/word.range#word-word-range-clear-member(1))|Clears the contents of the range object.| -||[contentControls](/javascript/api/word/word.range#word-word-range-contentcontrols-member)|Gets the collection of content control objects in the range.| -||[delete()](/javascript/api/word/word.range#word-word-range-delete-member(1))|Deletes the range and its content from the document.| -||[font](/javascript/api/word/word.range#word-word-range-font-member)|Gets the text format of the range.| -||[getHtml()](/javascript/api/word/word.range#word-word-range-gethtml-member(1))|Gets an HTML representation of the range object.| -||[getOoxml()](/javascript/api/word/word.range#word-word-range-getooxml-member(1))|Gets the OOXML representation of the range object.| -||[insertBreak(breakType: Word.BreakType \| "Page" \| "Next" \| "SectionNext" \| "SectionContinuous" \| "SectionEven" \| "SectionOdd" \| "Line", insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After")](/javascript/api/word/word.range#word-word-range-insertbreak-member(1))|Inserts a break at the specified location in the main document.| -||[insertContentControl(contentControlType?: Word.ContentControlType.richText \| Word.ContentControlType.plainText \| Word.ContentControlType.checkBox \| Word.ContentControlType.dropDownList \| Word.ContentControlType.comboBox \| "RichText" \| "PlainText" \| "CheckBox" \| "DropDownList" \| "ComboBox")](/javascript/api/word/word.range#word-word-range-insertcontentcontrol-member(1))|Wraps the Range object with a content control.| -||[insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation \| "Replace" \| "Start" \| "End" \| "Before" \| "After")](/javascript/api/word/word.range#word-word-range-insertfilefrombase64-member(1))|Inserts a document at the specified location.| -||[insertHtml(html: string, insertLocation: Word.InsertLocation \| "Replace" \| "Start" \| "End" \| "Before" \| "After")](/javascript/api/word/word.range#word-word-range-inserthtml-member(1))|Inserts HTML at the specified location.| -||[insertOoxml(ooxml: string, insertLocation: Word.InsertLocation \| "Replace" \| "Start" \| "End" \| "Before" \| "After")](/javascript/api/word/word.range#word-word-range-insertooxml-member(1))|Inserts OOXML at the specified location.| -||[insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After")](/javascript/api/word/word.range#word-word-range-insertparagraph-member(1))|Inserts a paragraph at the specified location.| -||[insertText(text: string, insertLocation: Word.InsertLocation \| "Replace" \| "Start" \| "End" \| "Before" \| "After")](/javascript/api/word/word.range#word-word-range-inserttext-member(1))|Inserts text at the specified location.| -||[paragraphs](/javascript/api/word/word.range#word-word-range-paragraphs-member)|Gets the collection of paragraph objects in the range.| -||[parentContentControl](/javascript/api/word/word.range#word-word-range-parentcontentcontrol-member)|Gets the currently supported content control that contains the range.| -||[search(searchText: string, searchOptions?: Word.SearchOptions \| { ignorePunct?: boolean ignoreSpace?: boolean matchCase?: boolean matchPrefix?: boolean matchSuffix?: boolean matchWholeWord?: boolean matchWildcards?: boolean })](/javascript/api/word/word.range#word-word-range-search-member(1))|Performs a search with the specified SearchOptions on the scope of the range object.| -||[select(selectionMode?: Word.SelectionMode)](/javascript/api/word/word.range#word-word-range-select-member(1))|Selects and navigates the Word UI to the range.| -||[style](/javascript/api/word/word.range#word-word-range-style-member)|Specifies the style name for the range.| -||[text](/javascript/api/word/word.range#word-word-range-text-member)|Gets the text of the range.| -|[RangeCollection](/javascript/api/word/word.rangecollection)|[items](/javascript/api/word/word.rangecollection#word-word-rangecollection-items-member)|Gets the loaded child items in this collection.| -|[SearchOptions](/javascript/api/word/word.searchoptions)|[ignorePunct](/javascript/api/word/word.searchoptions#word-word-searchoptions-ignorepunct-member)|Specifies a value that indicates whether to ignore all punctuation characters between words.| -||[ignoreSpace](/javascript/api/word/word.searchoptions#word-word-searchoptions-ignorespace-member)|Specifies a value that indicates whether to ignore all whitespace between words.| -||[matchCase](/javascript/api/word/word.searchoptions#word-word-searchoptions-matchcase-member)|Specifies a value that indicates whether to perform a case sensitive search.| -||[matchPrefix](/javascript/api/word/word.searchoptions#word-word-searchoptions-matchprefix-member)|Specifies a value that indicates whether to match words that begin with the search string.| -||[matchSuffix](/javascript/api/word/word.searchoptions#word-word-searchoptions-matchsuffix-member)|Specifies a value that indicates whether to match words that end with the search string.| -||[matchWholeWord](/javascript/api/word/word.searchoptions#word-word-searchoptions-matchwholeword-member)|Specifies a value that indicates whether to find operation only entire words, not text that is part of a larger word.| -||[matchWildcards](/javascript/api/word/word.searchoptions#word-word-searchoptions-matchwildcards-member)|Specifies a value that indicates whether the search will be performed using special search operators.| -|[Section](/javascript/api/word/word.section)|[body](/javascript/api/word/word.section#word-word-section-body-member)|Gets the body object of the section.| -||[getFooter(type: Word.HeaderFooterType)](/javascript/api/word/word.section#word-word-section-getfooter-member(1))|Gets one of the section's footers.| -||[getHeader(type: Word.HeaderFooterType)](/javascript/api/word/word.section#word-word-section-getheader-member(1))|Gets one of the section's headers.| -|[SectionCollection](/javascript/api/word/word.sectioncollection)|[items](/javascript/api/word/word.sectioncollection#word-word-sectioncollection-items-member)|Gets the loaded child items in this collection.| +|[Body](/.body)|[clear()](/.body#word-javascript/api/word/-body-clear-member(1))|Clears the contents of the body object.| +||[contentControls](/.body#word-javascript/api/word/-body-contentcontrols-member)|Gets the collection of rich text content control objects in the body.| +||[font](/.body#word-javascript/api/word/-body-font-member)|Gets the text format of the body.| +||[getHtml()](/.body#word-javascript/api/word/-body-gethtml-member(1))|Gets an HTML representation of the body object.| +||[getOoxml()](/.body#word-javascript/api/word/-body-getooxml-member(1))|Gets the OOXML (Office Open XML) representation of the body object.| +||[inlinePictures](/.body#word-javascript/api/word/-body-inlinepictures-member)|Gets the collection of InlinePicture objects in the body.| +||[insertBreak(breakType: Word.BreakType \| "Page" \| "Next" \| "SectionNext" \| "SectionContinuous" \| "SectionEven" \| "SectionOdd" \| "Line", insertLocation: Word.InsertLocation.start \| Word.InsertLocation.end \| "Start" \| "End")](/.body#word-javascript/api/word/-body-insertbreak-member(1))|Inserts a break at the specified location in the main document.| +||[insertContentControl(contentControlType?: Word.ContentControlType.richText \| Word.ContentControlType.plainText \| Word.ContentControlType.checkBox \| Word.ContentControlType.dropDownList \| Word.ContentControlType.comboBox \| "RichText" \| "PlainText" \| "CheckBox" \| "DropDownList" \| "ComboBox")](/.body#word-javascript/api/word/-body-insertcontentcontrol-member(1))|Wraps the Body object with a content control.| +||[insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/.body#word-javascript/api/word/-body-insertfilefrombase64-member(1))|Inserts a document into the body at the specified location.| +||[insertHtml(html: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/.body#word-javascript/api/word/-body-inserthtml-member(1))|Inserts HTML at the specified location.| +||[insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/.body#word-javascript/api/word/-body-insertooxml-member(1))|Inserts OOXML at the specified location.| +||[insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.start \| Word.InsertLocation.end \| "Start" \| "End")](/.body#word-javascript/api/word/-body-insertparagraph-member(1))|Inserts a paragraph at the specified location.| +||[insertText(text: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/.body#word-javascript/api/word/-body-inserttext-member(1))|Inserts text into the body at the specified location.| +||[paragraphs](/.body#word-javascript/api/word/-body-paragraphs-member)|Gets the collection of paragraph objects in the body.| +||[parentContentControl](/.body#word-javascript/api/word/-body-parentcontentcontrol-member)|Gets the content control that contains the body.| +||[search(searchText: string, searchOptions?: Word.SearchOptions \| { ignorePunct?: boolean ignoreSpace?: boolean matchCase?: boolean matchPrefix?: boolean matchSuffix?: boolean matchWholeWord?: boolean matchWildcards?: boolean })](/.body#word-javascript/api/word/-body-search-member(1))|Performs a search with the specified SearchOptions on the scope of the body object.| +||[select(selectionMode?: Word.SelectionMode)](/.body#word-javascript/api/word/-body-select-member(1))|Selects the body and navigates the Word UI to it.| +||[style](/.body#word-javascript/api/word/-body-style-member)|Specifies the style name for the body.| +||[text](/.body#word-javascript/api/word/-body-text-member)|Gets the text of the body.| +|[ContentControl](/.contentcontrol)|[appearance](/.contentcontrol#word-javascript/api/word/-contentcontrol-appearance-member)|Specifies the appearance of the content control.| +||[cannotDelete](/.contentcontrol#word-javascript/api/word/-contentcontrol-cannotdelete-member)|Specifies a value that indicates whether the user can delete the content control.| +||[cannotEdit](/.contentcontrol#word-javascript/api/word/-contentcontrol-cannotedit-member)|Specifies a value that indicates whether the user can edit the contents of the content control.| +||[clear()](/.contentcontrol#word-javascript/api/word/-contentcontrol-clear-member(1))|Clears the contents of the content control.| +||[color](/.contentcontrol#word-javascript/api/word/-contentcontrol-color-member)|Specifies the color of the content control.| +||[contentControls](/.contentcontrol#word-javascript/api/word/-contentcontrol-contentcontrols-member)|Gets the collection of content control objects in the content control.| +||[delete(keepContent: boolean)](/.contentcontrol#word-javascript/api/word/-contentcontrol-delete-member(1))|Deletes the content control and its content.| +||[font](/.contentcontrol#word-javascript/api/word/-contentcontrol-font-member)|Gets the text format of the content control.| +||[getHtml()](/.contentcontrol#word-javascript/api/word/-contentcontrol-gethtml-member(1))|Gets an HTML representation of the content control object.| +||[getOoxml()](/.contentcontrol#word-javascript/api/word/-contentcontrol-getooxml-member(1))|Gets the Office Open XML (OOXML) representation of the content control object.| +||[id](/.contentcontrol#word-javascript/api/word/-contentcontrol-id-member)|Gets an integer that represents the content control identifier.| +||[inlinePictures](/.contentcontrol#word-javascript/api/word/-contentcontrol-inlinepictures-member)|Gets the collection of InlinePicture objects in the content control.| +||[insertBreak(breakType: Word.BreakType \| "Page" \| "Next" \| "SectionNext" \| "SectionContinuous" \| "SectionEven" \| "SectionOdd" \| "Line", insertLocation: Word.InsertLocation.start \| Word.InsertLocation.end \| Word.InsertLocation.before \| Word.InsertLocation.after \| "Start" \| "End" \| "Before" \| "After")](/.contentcontrol#word-javascript/api/word/-contentcontrol-insertbreak-member(1))|Inserts a break at the specified location in the main document.| +||[insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/.contentcontrol#word-javascript/api/word/-contentcontrol-insertfilefrombase64-member(1))|Inserts a document into the content control at the specified location.| +||[insertHtml(html: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/.contentcontrol#word-javascript/api/word/-contentcontrol-inserthtml-member(1))|Inserts HTML into the content control at the specified location.| +||[insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/.contentcontrol#word-javascript/api/word/-contentcontrol-insertooxml-member(1))|Inserts OOXML into the content control at the specified location.| +||[insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.start \| Word.InsertLocation.end \| Word.InsertLocation.before \| Word.InsertLocation.after \| "Start" \| "End" \| "Before" \| "After")](/.contentcontrol#word-javascript/api/word/-contentcontrol-insertparagraph-member(1))|Inserts a paragraph at the specified location.| +||[insertText(text: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/.contentcontrol#word-javascript/api/word/-contentcontrol-inserttext-member(1))|Inserts text into the content control at the specified location.| +||[paragraphs](/.contentcontrol#word-javascript/api/word/-contentcontrol-paragraphs-member)|Gets the collection of paragraph objects in the content control.| +||[parentContentControl](/.contentcontrol#word-javascript/api/word/-contentcontrol-parentcontentcontrol-member)|Gets the content control that contains the content control.| +||[placeholderText](/.contentcontrol#word-javascript/api/word/-contentcontrol-placeholdertext-member)|Specifies the placeholder text of the content control.| +||[removeWhenEdited](/.contentcontrol#word-javascript/api/word/-contentcontrol-removewhenedited-member)|Specifies a value that indicates whether the content control is removed after it is edited.| +||[search(searchText: string, searchOptions?: Word.SearchOptions \| { ignorePunct?: boolean ignoreSpace?: boolean matchCase?: boolean matchPrefix?: boolean matchSuffix?: boolean matchWholeWord?: boolean matchWildcards?: boolean })](/.contentcontrol#word-javascript/api/word/-contentcontrol-search-member(1))|Performs a search with the specified SearchOptions on the scope of the content control object.| +||[select(selectionMode?: Word.SelectionMode)](/.contentcontrol#word-javascript/api/word/-contentcontrol-select-member(1))|Selects the content control.| +||[style](/.contentcontrol#word-javascript/api/word/-contentcontrol-style-member)|Specifies the style name for the content control.| +||[tag](/.contentcontrol#word-javascript/api/word/-contentcontrol-tag-member)|Specifies a tag to identify a content control.| +||[text](/.contentcontrol#word-javascript/api/word/-contentcontrol-text-member)|Gets the text of the content control.| +||[title](/.contentcontrol#word-javascript/api/word/-contentcontrol-title-member)|Specifies the title for a content control.| +||[type](/.contentcontrol#word-javascript/api/word/-contentcontrol-type-member)|Gets the content control type.| +|[ContentControlCollection](/.contentcontrolcollection)|[getById(id: number)](/.contentcontrolcollection#word-javascript/api/word/-contentcontrolcollection-getbyid-member(1))|Gets a content control by its identifier.| +||[getByTag(tag: string)](/.contentcontrolcollection#word-javascript/api/word/-contentcontrolcollection-getbytag-member(1))|Gets the content controls that have the specified tag.| +||[getByTitle(title: string)](/.contentcontrolcollection#word-javascript/api/word/-contentcontrolcollection-getbytitle-member(1))|Gets the content controls that have the specified title.| +||[getItem(id: number)](/.contentcontrolcollection#word-javascript/api/word/-contentcontrolcollection-getitem-member(1))|Gets a content control by its ID.| +||[items](/.contentcontrolcollection#word-javascript/api/word/-contentcontrolcollection-items-member)|Gets the loaded child items in this collection.| +|[Document](/.document)|[body](/.document#word-javascript/api/word/-document-body-member)|Gets the body object of the main document.| +||[contentControls](/.document#word-javascript/api/word/-document-contentcontrols-member)|Gets the collection of content control objects in the document.| +||[getSelection()](/.document#word-javascript/api/word/-document-getselection-member(1))|Gets the current selection of the document.| +||[save(saveBehavior?: Word.SaveBehavior, fileName?: string)](/.document#word-javascript/api/word/-document-save-member(1))|Saves the document.| +||[saved](/.document#word-javascript/api/word/-document-saved-member)|Indicates whether the changes in the document have been saved.| +||[sections](/.document#word-javascript/api/word/-document-sections-member)|Gets the collection of section objects in the document.| +|[Font](/.font)|[bold](/.font#word-javascript/api/word/-font-bold-member)|Specifies a value that indicates whether the font is bold.| +||[color](/.font#word-javascript/api/word/-font-color-member)|Specifies the color for the specified font.| +||[doubleStrikeThrough](/.font#word-javascript/api/word/-font-doublestrikethrough-member)|Specifies a value that indicates whether the font has a double strikethrough.| +||[highlightColor](/.font#word-javascript/api/word/-font-highlightcolor-member)|Specifies the highlight color.| +||[italic](/.font#word-javascript/api/word/-font-italic-member)|Specifies a value that indicates whether the font is italicized.| +||[name](/.font#word-javascript/api/word/-font-name-member)|Specifies a value that represents the name of the font.| +||[size](/.font#word-javascript/api/word/-font-size-member)|Specifies a value that represents the font size in points.| +||[strikeThrough](/.font#word-javascript/api/word/-font-strikethrough-member)|Specifies a value that indicates whether the font has a strikethrough.| +||[subscript](/.font#word-javascript/api/word/-font-subscript-member)|Specifies a value that indicates whether the font is a subscript.| +||[superscript](/.font#word-javascript/api/word/-font-superscript-member)|Specifies a value that indicates whether the font is a superscript.| +||[underline](/.font#word-javascript/api/word/-font-underline-member)|Specifies a value that indicates the font's underline type.| +|[InlinePicture](/.inlinepicture)|[altTextDescription](/.inlinepicture#word-javascript/api/word/-inlinepicture-alttextdescription-member)|Specifies a string that represents the alternative text associated with the inline image.| +||[altTextTitle](/.inlinepicture#word-javascript/api/word/-inlinepicture-alttexttitle-member)|Specifies a string that contains the title for the inline image.| +||[getBase64ImageSrc()](/.inlinepicture#word-javascript/api/word/-inlinepicture-getbase64imagesrc-member(1))|Gets the Base64-encoded string representation of the inline image.| +||[height](/.inlinepicture#word-javascript/api/word/-inlinepicture-height-member)|Specifies a number that describes the height of the inline image.| +||[hyperlink](/.inlinepicture#word-javascript/api/word/-inlinepicture-hyperlink-member)|Specifies a hyperlink on the image.| +||[insertContentControl()](/.inlinepicture#word-javascript/api/word/-inlinepicture-insertcontentcontrol-member(1))|Wraps the inline picture with a rich text content control.| +||[lockAspectRatio](/.inlinepicture#word-javascript/api/word/-inlinepicture-lockaspectratio-member)|Specifies a value that indicates whether the inline image retains its original proportions when you resize it.| +||[parentContentControl](/.inlinepicture#word-javascript/api/word/-inlinepicture-parentcontentcontrol-member)|Gets the content control that contains the inline image.| +||[width](/.inlinepicture#word-javascript/api/word/-inlinepicture-width-member)|Specifies a number that describes the width of the inline image.| +|[InlinePictureCollection](/.inlinepicturecollection)|[items](/.inlinepicturecollection#word-javascript/api/word/-inlinepicturecollection-items-member)|Gets the loaded child items in this collection.| +|[Paragraph](/.paragraph)|[alignment](/.paragraph#word-javascript/api/word/-paragraph-alignment-member)|Specifies the alignment for a paragraph.| +||[clear()](/.paragraph#word-javascript/api/word/-paragraph-clear-member(1))|Clears the contents of the paragraph object.| +||[contentControls](/.paragraph#word-javascript/api/word/-paragraph-contentcontrols-member)|Gets the collection of content control objects in the paragraph.| +||[delete()](/.paragraph#word-javascript/api/word/-paragraph-delete-member(1))|Deletes the paragraph and its content from the document.| +||[firstLineIndent](/.paragraph#word-javascript/api/word/-paragraph-firstlineindent-member)|Specifies the value, in points, for a first line or hanging indent.| +||[font](/.paragraph#word-javascript/api/word/-paragraph-font-member)|Gets the text format of the paragraph.| +||[getHtml()](/.paragraph#word-javascript/api/word/-paragraph-gethtml-member(1))|Gets an HTML representation of the paragraph object.| +||[getOoxml()](/.paragraph#word-javascript/api/word/-paragraph-getooxml-member(1))|Gets the Office Open XML (OOXML) representation of the paragraph object.| +||[inlinePictures](/.paragraph#word-javascript/api/word/-paragraph-inlinepictures-member)|Gets the collection of InlinePicture objects in the paragraph.| +||[insertBreak(breakType: Word.BreakType \| "Page" \| "Next" \| "SectionNext" \| "SectionContinuous" \| "SectionEven" \| "SectionOdd" \| "Line", insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After")](/.paragraph#word-javascript/api/word/-paragraph-insertbreak-member(1))|Inserts a break at the specified location in the main document.| +||[insertContentControl(contentControlType?: Word.ContentControlType.richText \| Word.ContentControlType.plainText \| Word.ContentControlType.checkBox \| Word.ContentControlType.dropDownList \| Word.ContentControlType.comboBox \| "RichText" \| "PlainText" \| "CheckBox" \| "DropDownList" \| "ComboBox")](/.paragraph#word-javascript/api/word/-paragraph-insertcontentcontrol-member(1))|Wraps the Paragraph object with a content control.| +||[insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/.paragraph#word-javascript/api/word/-paragraph-insertfilefrombase64-member(1))|Inserts a document into the paragraph at the specified location.| +||[insertHtml(html: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/.paragraph#word-javascript/api/word/-paragraph-inserthtml-member(1))|Inserts HTML into the paragraph at the specified location.| +||[insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/.paragraph#word-javascript/api/word/-paragraph-insertinlinepicturefrombase64-member(1))|Inserts a picture into the paragraph at the specified location.| +||[insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/.paragraph#word-javascript/api/word/-paragraph-insertooxml-member(1))|Inserts OOXML into the paragraph at the specified location.| +||[insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After")](/.paragraph#word-javascript/api/word/-paragraph-insertparagraph-member(1))|Inserts a paragraph at the specified location.| +||[insertText(text: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/.paragraph#word-javascript/api/word/-paragraph-inserttext-member(1))|Inserts text into the paragraph at the specified location.| +||[leftIndent](/.paragraph#word-javascript/api/word/-paragraph-leftindent-member)|Specifies the left indent value, in points, for the paragraph.| +||[lineSpacing](/.paragraph#word-javascript/api/word/-paragraph-linespacing-member)|Specifies the line spacing, in points, for the specified paragraph.| +||[lineUnitAfter](/.paragraph#word-javascript/api/word/-paragraph-lineunitafter-member)|Specifies the amount of spacing, in grid lines, after the paragraph.| +||[lineUnitBefore](/.paragraph#word-javascript/api/word/-paragraph-lineunitbefore-member)|Specifies the amount of spacing, in grid lines, before the paragraph.| +||[outlineLevel](/.paragraph#word-javascript/api/word/-paragraph-outlinelevel-member)|Specifies the outline level for the paragraph.| +||[parentContentControl](/.paragraph#word-javascript/api/word/-paragraph-parentcontentcontrol-member)|Gets the content control that contains the paragraph.| +||[rightIndent](/.paragraph#word-javascript/api/word/-paragraph-rightindent-member)|Specifies the right indent value, in points, for the paragraph.| +||[search(searchText: string, searchOptions?: Word.SearchOptions \| { ignorePunct?: boolean ignoreSpace?: boolean matchCase?: boolean matchPrefix?: boolean matchSuffix?: boolean matchWholeWord?: boolean matchWildcards?: boolean })](/.paragraph#word-javascript/api/word/-paragraph-search-member(1))|Performs a search with the specified SearchOptions on the scope of the paragraph object.| +||[select(selectionMode?: Word.SelectionMode)](/.paragraph#word-javascript/api/word/-paragraph-select-member(1))|Selects and navigates the Word UI to the paragraph.| +||[spaceAfter](/.paragraph#word-javascript/api/word/-paragraph-spaceafter-member)|Specifies the spacing, in points, after the paragraph.| +||[spaceBefore](/.paragraph#word-javascript/api/word/-paragraph-spacebefore-member)|Specifies the spacing, in points, before the paragraph.| +||[style](/.paragraph#word-javascript/api/word/-paragraph-style-member)|Specifies the style name for the paragraph.| +||[text](/.paragraph#word-javascript/api/word/-paragraph-text-member)|Gets the text of the paragraph.| +|[ParagraphCollection](/.paragraphcollection)|[items](/.paragraphcollection#word-javascript/api/word/-paragraphcollection-items-member)|Gets the loaded child items in this collection.| +|[Range](/.range)|[clear()](/.range#word-javascript/api/word/-range-clear-member(1))|Clears the contents of the range object.| +||[contentControls](/.range#word-javascript/api/word/-range-contentcontrols-member)|Gets the collection of content control objects in the range.| +||[delete()](/.range#word-javascript/api/word/-range-delete-member(1))|Deletes the range and its content from the document.| +||[font](/.range#word-javascript/api/word/-range-font-member)|Gets the text format of the range.| +||[getHtml()](/.range#word-javascript/api/word/-range-gethtml-member(1))|Gets an HTML representation of the range object.| +||[getOoxml()](/.range#word-javascript/api/word/-range-getooxml-member(1))|Gets the OOXML representation of the range object.| +||[insertBreak(breakType: Word.BreakType \| "Page" \| "Next" \| "SectionNext" \| "SectionContinuous" \| "SectionEven" \| "SectionOdd" \| "Line", insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After")](/.range#word-javascript/api/word/-range-insertbreak-member(1))|Inserts a break at the specified location in the main document.| +||[insertContentControl(contentControlType?: Word.ContentControlType.richText \| Word.ContentControlType.plainText \| Word.ContentControlType.checkBox \| Word.ContentControlType.dropDownList \| Word.ContentControlType.comboBox \| "RichText" \| "PlainText" \| "CheckBox" \| "DropDownList" \| "ComboBox")](/.range#word-javascript/api/word/-range-insertcontentcontrol-member(1))|Wraps the Range object with a content control.| +||[insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation \| "Replace" \| "Start" \| "End" \| "Before" \| "After")](/.range#word-javascript/api/word/-range-insertfilefrombase64-member(1))|Inserts a document at the specified location.| +||[insertHtml(html: string, insertLocation: Word.InsertLocation \| "Replace" \| "Start" \| "End" \| "Before" \| "After")](/.range#word-javascript/api/word/-range-inserthtml-member(1))|Inserts HTML at the specified location.| +||[insertOoxml(ooxml: string, insertLocation: Word.InsertLocation \| "Replace" \| "Start" \| "End" \| "Before" \| "After")](/.range#word-javascript/api/word/-range-insertooxml-member(1))|Inserts OOXML at the specified location.| +||[insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After")](/.range#word-javascript/api/word/-range-insertparagraph-member(1))|Inserts a paragraph at the specified location.| +||[insertText(text: string, insertLocation: Word.InsertLocation \| "Replace" \| "Start" \| "End" \| "Before" \| "After")](/.range#word-javascript/api/word/-range-inserttext-member(1))|Inserts text at the specified location.| +||[paragraphs](/.range#word-javascript/api/word/-range-paragraphs-member)|Gets the collection of paragraph objects in the range.| +||[parentContentControl](/.range#word-javascript/api/word/-range-parentcontentcontrol-member)|Gets the currently supported content control that contains the range.| +||[search(searchText: string, searchOptions?: Word.SearchOptions \| { ignorePunct?: boolean ignoreSpace?: boolean matchCase?: boolean matchPrefix?: boolean matchSuffix?: boolean matchWholeWord?: boolean matchWildcards?: boolean })](/.range#word-javascript/api/word/-range-search-member(1))|Performs a search with the specified SearchOptions on the scope of the range object.| +||[select(selectionMode?: Word.SelectionMode)](/.range#word-javascript/api/word/-range-select-member(1))|Selects and navigates the Word UI to the range.| +||[style](/.range#word-javascript/api/word/-range-style-member)|Specifies the style name for the range.| +||[text](/.range#word-javascript/api/word/-range-text-member)|Gets the text of the range.| +|[RangeCollection](/.rangecollection)|[items](/.rangecollection#word-javascript/api/word/-rangecollection-items-member)|Gets the loaded child items in this collection.| +|[SearchOptions](/.searchoptions)|[ignorePunct](/.searchoptions#word-javascript/api/word/-searchoptions-ignorepunct-member)|Specifies a value that indicates whether to ignore all punctuation characters between words.| +||[ignoreSpace](/.searchoptions#word-javascript/api/word/-searchoptions-ignorespace-member)|Specifies a value that indicates whether to ignore all whitespace between words.| +||[matchCase](/.searchoptions#word-javascript/api/word/-searchoptions-matchcase-member)|Specifies a value that indicates whether to perform a case sensitive search.| +||[matchPrefix](/.searchoptions#word-javascript/api/word/-searchoptions-matchprefix-member)|Specifies a value that indicates whether to match words that begin with the search string.| +||[matchSuffix](/.searchoptions#word-javascript/api/word/-searchoptions-matchsuffix-member)|Specifies a value that indicates whether to match words that end with the search string.| +||[matchWholeWord](/.searchoptions#word-javascript/api/word/-searchoptions-matchwholeword-member)|Specifies a value that indicates whether to find operation only entire words, not text that is part of a larger word.| +||[matchWildcards](/.searchoptions#word-javascript/api/word/-searchoptions-matchwildcards-member)|Specifies a value that indicates whether the search will be performed using special search operators.| +|[Section](/.section)|[body](/.section#word-javascript/api/word/-section-body-member)|Gets the body object of the section.| +||[getFooter(type: Word.HeaderFooterType)](/.section#word-javascript/api/word/-section-getfooter-member(1))|Gets one of the section's footers.| +||[getHeader(type: Word.HeaderFooterType)](/.section#word-javascript/api/word/-section-getheader-member(1))|Gets one of the section's headers.| +|[SectionCollection](/.sectioncollection)|[items](/.sectioncollection#word-javascript/api/word/-sectioncollection-items-member)|Gets the loaded child items in this collection.| diff --git a/docs/includes/word-1_2.md b/docs/includes/word-1_2.md index 870fc1ff4d..2569c64db5 100644 --- a/docs/includes/word-1_2.md +++ b/docs/includes/word-1_2.md @@ -1,16 +1,16 @@ | Class | Fields | Description | |:---|:---|:---| -|[Body](/javascript/api/word/word.body)|[insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.start \| Word.InsertLocation.end \| "Start" \| "End")](/javascript/api/word/word.body#word-word-body-insertinlinepicturefrombase64-member(1))|Inserts a picture into the body at the specified location.| -|[ContentControl](/javascript/api/word/word.contentcontrol)|[insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-insertinlinepicturefrombase64-member(1))|Inserts an inline picture into the content control at the specified location.| -|[InlinePicture](/javascript/api/word/word.inlinepicture)|[delete()](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-delete-member(1))|Deletes the inline picture from the document.| -||[insertBreak(breakType: Word.BreakType \| "Page" \| "Next" \| "SectionNext" \| "SectionContinuous" \| "SectionEven" \| "SectionOdd" \| "Line", insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After")](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-insertbreak-member(1))|Inserts a break at the specified location in the main document.| -||[insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After")](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-insertfilefrombase64-member(1))|Inserts a document at the specified location.| -||[insertHtml(html: string, insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After")](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-inserthtml-member(1))|Inserts HTML at the specified location.| -||[insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.before \| Word.InsertLocation.after \| "Replace" \| "Before" \| "After")](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-insertinlinepicturefrombase64-member(1))|Inserts an inline picture at the specified location.| -||[insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After")](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-insertooxml-member(1))|Inserts OOXML at the specified location.| -||[insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After")](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-insertparagraph-member(1))|Inserts a paragraph at the specified location.| -||[insertText(text: string, insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After")](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-inserttext-member(1))|Inserts text at the specified location.| -||[paragraph](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-paragraph-member)|Gets the parent paragraph that contains the inline image.| -||[select(selectionMode?: Word.SelectionMode)](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-select-member(1))|Selects the inline picture.| -|[Range](/javascript/api/word/word.range)|[inlinePictures](/javascript/api/word/word.range#word-word-range-inlinepictures-member)|Gets the collection of inline picture objects in the range.| -||[insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation \| "Replace" \| "Start" \| "End" \| "Before" \| "After")](/javascript/api/word/word.range#word-word-range-insertinlinepicturefrombase64-member(1))|Inserts a picture at the specified location.| +|[Body](/.body)|[insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.start \| Word.InsertLocation.end \| "Start" \| "End")](/.body#word-javascript/api/word/-body-insertinlinepicturefrombase64-member(1))|Inserts a picture into the body at the specified location.| +|[ContentControl](/.contentcontrol)|[insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/.contentcontrol#word-javascript/api/word/-contentcontrol-insertinlinepicturefrombase64-member(1))|Inserts an inline picture into the content control at the specified location.| +|[InlinePicture](/.inlinepicture)|[delete()](/.inlinepicture#word-javascript/api/word/-inlinepicture-delete-member(1))|Deletes the inline picture from the document.| +||[insertBreak(breakType: Word.BreakType \| "Page" \| "Next" \| "SectionNext" \| "SectionContinuous" \| "SectionEven" \| "SectionOdd" \| "Line", insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After")](/.inlinepicture#word-javascript/api/word/-inlinepicture-insertbreak-member(1))|Inserts a break at the specified location in the main document.| +||[insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After")](/.inlinepicture#word-javascript/api/word/-inlinepicture-insertfilefrombase64-member(1))|Inserts a document at the specified location.| +||[insertHtml(html: string, insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After")](/.inlinepicture#word-javascript/api/word/-inlinepicture-inserthtml-member(1))|Inserts HTML at the specified location.| +||[insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.before \| Word.InsertLocation.after \| "Replace" \| "Before" \| "After")](/.inlinepicture#word-javascript/api/word/-inlinepicture-insertinlinepicturefrombase64-member(1))|Inserts an inline picture at the specified location.| +||[insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After")](/.inlinepicture#word-javascript/api/word/-inlinepicture-insertooxml-member(1))|Inserts OOXML at the specified location.| +||[insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After")](/.inlinepicture#word-javascript/api/word/-inlinepicture-insertparagraph-member(1))|Inserts a paragraph at the specified location.| +||[insertText(text: string, insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After")](/.inlinepicture#word-javascript/api/word/-inlinepicture-inserttext-member(1))|Inserts text at the specified location.| +||[paragraph](/.inlinepicture#word-javascript/api/word/-inlinepicture-paragraph-member)|Gets the parent paragraph that contains the inline image.| +||[select(selectionMode?: Word.SelectionMode)](/.inlinepicture#word-javascript/api/word/-inlinepicture-select-member(1))|Selects the inline picture.| +|[Range](/.range)|[inlinePictures](/.range#word-javascript/api/word/-range-inlinepictures-member)|Gets the collection of inline picture objects in the range.| +||[insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation \| "Replace" \| "Start" \| "End" \| "Before" \| "After")](/.range#word-javascript/api/word/-range-insertinlinepicturefrombase64-member(1))|Inserts a picture at the specified location.| diff --git a/docs/includes/word-1_3.md b/docs/includes/word-1_3.md index 2da6e62de5..6b600c76d1 100644 --- a/docs/includes/word-1_3.md +++ b/docs/includes/word-1_3.md @@ -1,261 +1,261 @@ | Class | Fields | Description | |:---|:---|:---| -|[Application](/javascript/api/word/word.application)|[createDocument(base64File?: string)](/javascript/api/word/word.application#word-word-application-createdocument-member(1))|Creates a new document by using an optional Base64-encoded .docx file.| -|[Body](/javascript/api/word/word.body)|[getRange(rangeLocation?: Word.RangeLocation.whole \| Word.RangeLocation.start \| Word.RangeLocation.end \| Word.RangeLocation.after \| Word.RangeLocation.content \| "Whole" \| "Start" \| "End" \| "After" \| "Content")](/javascript/api/word/word.body#word-word-body-getrange-member(1))|Gets the whole body, or the starting or ending point of the body, as a range.| -||[insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.start \| Word.InsertLocation.end \| "Start" \| "End", values?: string[][])](/javascript/api/word/word.body#word-word-body-inserttable-member(1))|Inserts a table with the specified number of rows and columns.| -||[lists](/javascript/api/word/word.body#word-word-body-lists-member)|Gets the collection of list objects in the body.| -||[parentBody](/javascript/api/word/word.body#word-word-body-parentbody-member)|Gets the parent body of the body.| -||[parentBodyOrNullObject](/javascript/api/word/word.body#word-word-body-parentbodyornullobject-member)|Gets the parent body of the body.| -||[parentContentControlOrNullObject](/javascript/api/word/word.body#word-word-body-parentcontentcontrolornullobject-member)|Gets the content control that contains the body.| -||[parentSection](/javascript/api/word/word.body#word-word-body-parentsection-member)|Gets the parent section of the body.| -||[parentSectionOrNullObject](/javascript/api/word/word.body#word-word-body-parentsectionornullobject-member)|Gets the parent section of the body.| -||[styleBuiltIn](/javascript/api/word/word.body#word-word-body-stylebuiltin-member)|Specifies the built-in style name for the body.| -||[tables](/javascript/api/word/word.body#word-word-body-tables-member)|Gets the collection of table objects in the body.| -||[type](/javascript/api/word/word.body#word-word-body-type-member)|Gets the type of the body.| -|[ContentControl](/javascript/api/word/word.contentcontrol)|[getRange(rangeLocation?: Word.RangeLocation \| "Whole" \| "Start" \| "End" \| "Before" \| "After" \| "Content")](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-getrange-member(1))|Gets the whole content control, or the starting or ending point of the content control, as a range.| -||[getTextRanges(endingMarks: string[], trimSpacing?: boolean)](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-gettextranges-member(1))|Gets the text ranges in the content control by using punctuation marks and/or other ending marks.| -||[insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.start \| Word.InsertLocation.end \| Word.InsertLocation.before \| Word.InsertLocation.after \| "Start" \| "End" \| "Before" \| "After", values?: string[][])](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-inserttable-member(1))|Inserts a table with the specified number of rows and columns into, or next to, a content control.| -||[lists](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-lists-member)|Gets the collection of list objects in the content control.| -||[parentBody](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-parentbody-member)|Gets the parent body of the content control.| -||[parentContentControlOrNullObject](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-parentcontentcontrolornullobject-member)|Gets the content control that contains the content control.| -||[parentTable](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-parenttable-member)|Gets the table that contains the content control.| -||[parentTableCell](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-parenttablecell-member)|Gets the table cell that contains the content control.| -||[parentTableCellOrNullObject](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-parenttablecellornullobject-member)|Gets the table cell that contains the content control.| -||[parentTableOrNullObject](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-parenttableornullobject-member)|Gets the table that contains the content control.| -||[split(delimiters: string[], multiParagraphs?: boolean, trimDelimiters?: boolean, trimSpacing?: boolean)](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-split-member(1))|Splits the content control into child ranges by using delimiters.| -||[styleBuiltIn](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-stylebuiltin-member)|Specifies the built-in style name for the content control.| -||[subtype](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-subtype-member)|Gets the content control subtype.| -||[tables](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-tables-member)|Gets the collection of table objects in the content control.| -|[ContentControlCollection](/javascript/api/word/word.contentcontrolcollection)|[getByIdOrNullObject(id: number)](/javascript/api/word/word.contentcontrolcollection#word-word-contentcontrolcollection-getbyidornullobject-member(1))|Gets a content control by its identifier.| -||[getByTypes(types: Word.ContentControlType[])](/javascript/api/word/word.contentcontrolcollection#word-word-contentcontrolcollection-getbytypes-member(1))|Gets the content controls that have the specified types.| -||[getFirst()](/javascript/api/word/word.contentcontrolcollection#word-word-contentcontrolcollection-getfirst-member(1))|Gets the first content control in this collection.| -||[getFirstOrNullObject()](/javascript/api/word/word.contentcontrolcollection#word-word-contentcontrolcollection-getfirstornullobject-member(1))|Gets the first content control in this collection.| -|[CustomProperty](/javascript/api/word/word.customproperty)|[delete()](/javascript/api/word/word.customproperty#word-word-customproperty-delete-member(1))|Deletes the custom property.| -||[key](/javascript/api/word/word.customproperty#word-word-customproperty-key-member)|Gets the key of the custom property.| -||[type](/javascript/api/word/word.customproperty#word-word-customproperty-type-member)|Gets the value type of the custom property.| -||[value](/javascript/api/word/word.customproperty#word-word-customproperty-value-member)|Specifies the value of the custom property.| -|[CustomPropertyCollection](/javascript/api/word/word.custompropertycollection)|[add(key: string, value: any)](/javascript/api/word/word.custompropertycollection#word-word-custompropertycollection-add-member(1))|Creates a new or sets an existing custom property.| -||[deleteAll()](/javascript/api/word/word.custompropertycollection#word-word-custompropertycollection-deleteall-member(1))|Deletes all custom properties in this collection.| -||[getCount()](/javascript/api/word/word.custompropertycollection#word-word-custompropertycollection-getcount-member(1))|Gets the count of custom properties.| -||[getItem(key: string)](/javascript/api/word/word.custompropertycollection#word-word-custompropertycollection-getitem-member(1))|Gets a custom property object by its key, which is case-insensitive.| -||[getItemOrNullObject(key: string)](/javascript/api/word/word.custompropertycollection#word-word-custompropertycollection-getitemornullobject-member(1))|Gets a custom property object by its key, which is case-insensitive.| -||[items](/javascript/api/word/word.custompropertycollection#word-word-custompropertycollection-items-member)|Gets the loaded child items in this collection.| -|[Document](/javascript/api/word/word.document)|[properties](/javascript/api/word/word.document#word-word-document-properties-member)|Gets the properties of the document.| -|[DocumentCreated](/javascript/api/word/word.documentcreated)|[open()](/javascript/api/word/word.documentcreated#word-word-documentcreated-open-member(1))|Opens the document.| -|[DocumentProperties](/javascript/api/word/word.documentproperties)|[applicationName](/javascript/api/word/word.documentproperties#word-word-documentproperties-applicationname-member)|Gets the application name of the document.| -||[author](/javascript/api/word/word.documentproperties#word-word-documentproperties-author-member)|Specifies the author of the document.| -||[category](/javascript/api/word/word.documentproperties#word-word-documentproperties-category-member)|Specifies the category of the document.| -||[comments](/javascript/api/word/word.documentproperties#word-word-documentproperties-comments-member)|Specifies the Comments field in the metadata of the document.| -||[company](/javascript/api/word/word.documentproperties#word-word-documentproperties-company-member)|Specifies the company of the document.| -||[creationDate](/javascript/api/word/word.documentproperties#word-word-documentproperties-creationdate-member)|Gets the creation date of the document.| -||[customProperties](/javascript/api/word/word.documentproperties#word-word-documentproperties-customproperties-member)|Gets the collection of custom properties of the document.| -||[format](/javascript/api/word/word.documentproperties#word-word-documentproperties-format-member)|Specifies the format of the document.| -||[keywords](/javascript/api/word/word.documentproperties#word-word-documentproperties-keywords-member)|Specifies the keywords of the document.| -||[lastAuthor](/javascript/api/word/word.documentproperties#word-word-documentproperties-lastauthor-member)|Gets the last author of the document.| -||[lastPrintDate](/javascript/api/word/word.documentproperties#word-word-documentproperties-lastprintdate-member)|Gets the last print date of the document.| -||[lastSaveTime](/javascript/api/word/word.documentproperties#word-word-documentproperties-lastsavetime-member)|Gets the last save time of the document.| -||[manager](/javascript/api/word/word.documentproperties#word-word-documentproperties-manager-member)|Specifies the manager of the document.| -||[revisionNumber](/javascript/api/word/word.documentproperties#word-word-documentproperties-revisionnumber-member)|Gets the revision number of the document.| -||[security](/javascript/api/word/word.documentproperties#word-word-documentproperties-security-member)|Gets security settings of the document.| -||[subject](/javascript/api/word/word.documentproperties#word-word-documentproperties-subject-member)|Specifies the subject of the document.| -||[template](/javascript/api/word/word.documentproperties#word-word-documentproperties-template-member)|Gets the template of the document.| -||[title](/javascript/api/word/word.documentproperties#word-word-documentproperties-title-member)|Specifies the title of the document.| -|[InlinePicture](/javascript/api/word/word.inlinepicture)|[getNext()](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-getnext-member(1))|Gets the next inline image.| -||[getNextOrNullObject()](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-getnextornullobject-member(1))|Gets the next inline image.| -||[getRange(rangeLocation?: Word.RangeLocation.whole \| Word.RangeLocation.start \| Word.RangeLocation.end \| "Whole" \| "Start" \| "End")](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-getrange-member(1))|Gets the picture, or the starting or ending point of the picture, as a range.| -||[parentContentControlOrNullObject](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-parentcontentcontrolornullobject-member)|Gets the content control that contains the inline image.| -||[parentTable](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-parenttable-member)|Gets the table that contains the inline image.| -||[parentTableCell](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-parenttablecell-member)|Gets the table cell that contains the inline image.| -||[parentTableCellOrNullObject](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-parenttablecellornullobject-member)|Gets the table cell that contains the inline image.| -||[parentTableOrNullObject](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-parenttableornullobject-member)|Gets the table that contains the inline image.| -|[InlinePictureCollection](/javascript/api/word/word.inlinepicturecollection)|[getFirst()](/javascript/api/word/word.inlinepicturecollection#word-word-inlinepicturecollection-getfirst-member(1))|Gets the first inline image in this collection.| -||[getFirstOrNullObject()](/javascript/api/word/word.inlinepicturecollection#word-word-inlinepicturecollection-getfirstornullobject-member(1))|Gets the first inline image in this collection.| -|[List](/javascript/api/word/word.list)|[getLevelParagraphs(level: number)](/javascript/api/word/word.list#word-word-list-getlevelparagraphs-member(1))|Gets the paragraphs that occur at the specified level in the list.| -||[getLevelString(level: number)](/javascript/api/word/word.list#word-word-list-getlevelstring-member(1))|Gets the bullet, number, or picture at the specified level as a string.| -||[id](/javascript/api/word/word.list#word-word-list-id-member)|Gets the list's id.| -||[insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.start \| Word.InsertLocation.end \| Word.InsertLocation.before \| Word.InsertLocation.after \| "Start" \| "End" \| "Before" \| "After")](/javascript/api/word/word.list#word-word-list-insertparagraph-member(1))|Inserts a paragraph at the specified location.| -||[levelExistences](/javascript/api/word/word.list#word-word-list-levelexistences-member)|Checks whether each of the 9 levels exists in the list.| -||[levelTypes](/javascript/api/word/word.list#word-word-list-leveltypes-member)|Gets all 9 level types in the list.| -||[paragraphs](/javascript/api/word/word.list#word-word-list-paragraphs-member)|Gets paragraphs in the list.| -||[setLevelAlignment(level: number, alignment: Word.Alignment)](/javascript/api/word/word.list#word-word-list-setlevelalignment-member(1))|Sets the alignment of the bullet, number, or picture at the specified level in the list.| -||[setLevelBullet(level: number, listBullet: Word.ListBullet, charCode?: number, fontName?: string)](/javascript/api/word/word.list#word-word-list-setlevelbullet-member(1))|Sets the bullet format at the specified level in the list.| -||[setLevelIndents(level: number, textIndent: number, bulletNumberPictureIndent: number)](/javascript/api/word/word.list#word-word-list-setlevelindents-member(1))|Sets the two indents of the specified level in the list.| -||[setLevelNumbering(level: number, listNumbering: Word.ListNumbering, formatString?: Array)](/javascript/api/word/word.list#word-word-list-setlevelnumbering-member(1))|Sets the numbering format at the specified level in the list.| -||[setLevelStartingNumber(level: number, startingNumber: number)](/javascript/api/word/word.list#word-word-list-setlevelstartingnumber-member(1))|Sets the starting number at the specified level in the list.| -|[ListCollection](/javascript/api/word/word.listcollection)|[getById(id: number)](/javascript/api/word/word.listcollection#word-word-listcollection-getbyid-member(1))|Gets a list by its identifier.| -||[getByIdOrNullObject(id: number)](/javascript/api/word/word.listcollection#word-word-listcollection-getbyidornullobject-member(1))|Gets a list by its identifier.| -||[getFirst()](/javascript/api/word/word.listcollection#word-word-listcollection-getfirst-member(1))|Gets the first list in this collection.| -||[getFirstOrNullObject()](/javascript/api/word/word.listcollection#word-word-listcollection-getfirstornullobject-member(1))|Gets the first list in this collection.| -||[getItem(id: number)](/javascript/api/word/word.listcollection#word-word-listcollection-getitem-member(1))|Gets a list object by its ID.| -||[items](/javascript/api/word/word.listcollection#word-word-listcollection-items-member)|Gets the loaded child items in this collection.| -|[ListItem](/javascript/api/word/word.listitem)|[getAncestor(parentOnly?: boolean)](/javascript/api/word/word.listitem#word-word-listitem-getancestor-member(1))|Gets the list item parent, or the closest ancestor if the parent doesn't exist.| -||[getAncestorOrNullObject(parentOnly?: boolean)](/javascript/api/word/word.listitem#word-word-listitem-getancestorornullobject-member(1))|Gets the list item parent, or the closest ancestor if the parent doesn't exist.| -||[getDescendants(directChildrenOnly?: boolean)](/javascript/api/word/word.listitem#word-word-listitem-getdescendants-member(1))|Gets all descendant list items of the list item.| -||[level](/javascript/api/word/word.listitem#word-word-listitem-level-member)|Specifies the level of the item in the list.| -||[listString](/javascript/api/word/word.listitem#word-word-listitem-liststring-member)|Gets the list item bullet, number, or picture as a string.| -||[siblingIndex](/javascript/api/word/word.listitem#word-word-listitem-siblingindex-member)|Gets the list item order number in relation to its siblings.| -|[Paragraph](/javascript/api/word/word.paragraph)|[attachToList(listId: number, level: number)](/javascript/api/word/word.paragraph#word-word-paragraph-attachtolist-member(1))|Lets the paragraph join an existing list at the specified level.| -||[detachFromList()](/javascript/api/word/word.paragraph#word-word-paragraph-detachfromlist-member(1))|Moves this paragraph out of its list, if the paragraph is a list item.| -||[getNext()](/javascript/api/word/word.paragraph#word-word-paragraph-getnext-member(1))|Gets the next paragraph.| -||[getNextOrNullObject()](/javascript/api/word/word.paragraph#word-word-paragraph-getnextornullobject-member(1))|Gets the next paragraph.| -||[getPrevious()](/javascript/api/word/word.paragraph#word-word-paragraph-getprevious-member(1))|Gets the previous paragraph.| -||[getPreviousOrNullObject()](/javascript/api/word/word.paragraph#word-word-paragraph-getpreviousornullobject-member(1))|Gets the previous paragraph.| -||[getRange(rangeLocation?: Word.RangeLocation.whole \| Word.RangeLocation.start \| Word.RangeLocation.end \| Word.RangeLocation.after \| Word.RangeLocation.content \| "Whole" \| "Start" \| "End" \| "After" \| "Content")](/javascript/api/word/word.paragraph#word-word-paragraph-getrange-member(1))|Gets the whole paragraph, or the starting or ending point of the paragraph, as a range.| -||[getTextRanges(endingMarks: string[], trimSpacing?: boolean)](/javascript/api/word/word.paragraph#word-word-paragraph-gettextranges-member(1))|Gets the text ranges in the paragraph by using punctuation marks and/or other ending marks.| -||[insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After", values?: string[][])](/javascript/api/word/word.paragraph#word-word-paragraph-inserttable-member(1))|Inserts a table with the specified number of rows and columns.| -||[isLastParagraph](/javascript/api/word/word.paragraph#word-word-paragraph-islastparagraph-member)|Indicates the paragraph is the last one inside its parent body.| -||[isListItem](/javascript/api/word/word.paragraph#word-word-paragraph-islistitem-member)|Checks whether the paragraph is a list item.| -||[list](/javascript/api/word/word.paragraph#word-word-paragraph-list-member)|Gets the List to which this paragraph belongs.| -||[listItem](/javascript/api/word/word.paragraph#word-word-paragraph-listitem-member)|Gets the ListItem for the paragraph.| -||[listItemOrNullObject](/javascript/api/word/word.paragraph#word-word-paragraph-listitemornullobject-member)|Gets the ListItem for the paragraph.| -||[listOrNullObject](/javascript/api/word/word.paragraph#word-word-paragraph-listornullobject-member)|Gets the List to which this paragraph belongs.| -||[parentBody](/javascript/api/word/word.paragraph#word-word-paragraph-parentbody-member)|Gets the parent body of the paragraph.| -||[parentContentControlOrNullObject](/javascript/api/word/word.paragraph#word-word-paragraph-parentcontentcontrolornullobject-member)|Gets the content control that contains the paragraph.| -||[parentTable](/javascript/api/word/word.paragraph#word-word-paragraph-parenttable-member)|Gets the table that contains the paragraph.| -||[parentTableCell](/javascript/api/word/word.paragraph#word-word-paragraph-parenttablecell-member)|Gets the table cell that contains the paragraph.| -||[parentTableCellOrNullObject](/javascript/api/word/word.paragraph#word-word-paragraph-parenttablecellornullobject-member)|Gets the table cell that contains the paragraph.| -||[parentTableOrNullObject](/javascript/api/word/word.paragraph#word-word-paragraph-parenttableornullobject-member)|Gets the table that contains the paragraph.| -||[split(delimiters: string[], trimDelimiters?: boolean, trimSpacing?: boolean)](/javascript/api/word/word.paragraph#word-word-paragraph-split-member(1))|Splits the paragraph into child ranges by using delimiters.| -||[startNewList()](/javascript/api/word/word.paragraph#word-word-paragraph-startnewlist-member(1))|Starts a new list with this paragraph.| -||[styleBuiltIn](/javascript/api/word/word.paragraph#word-word-paragraph-stylebuiltin-member)|Specifies the built-in style name for the paragraph.| -||[tableNestingLevel](/javascript/api/word/word.paragraph#word-word-paragraph-tablenestinglevel-member)|Gets the level of the paragraph's table.| -|[ParagraphCollection](/javascript/api/word/word.paragraphcollection)|[getFirst()](/javascript/api/word/word.paragraphcollection#word-word-paragraphcollection-getfirst-member(1))|Gets the first paragraph in this collection.| -||[getFirstOrNullObject()](/javascript/api/word/word.paragraphcollection#word-word-paragraphcollection-getfirstornullobject-member(1))|Gets the first paragraph in this collection.| -||[getLast()](/javascript/api/word/word.paragraphcollection#word-word-paragraphcollection-getlast-member(1))|Gets the last paragraph in this collection.| -||[getLastOrNullObject()](/javascript/api/word/word.paragraphcollection#word-word-paragraphcollection-getlastornullobject-member(1))|Gets the last paragraph in this collection.| -|[Range](/javascript/api/word/word.range)|[compareLocationWith(range: Word.Range)](/javascript/api/word/word.range#word-word-range-comparelocationwith-member(1))|Compares this range's location with another range's location.| -||[expandTo(range: Word.Range)](/javascript/api/word/word.range#word-word-range-expandto-member(1))|Returns a new range that extends from this range in either direction to cover another range.| -||[expandToOrNullObject(range: Word.Range)](/javascript/api/word/word.range#word-word-range-expandtoornullobject-member(1))|Returns a new range that extends from this range in either direction to cover another range.| -||[getHyperlinkRanges()](/javascript/api/word/word.range#word-word-range-gethyperlinkranges-member(1))|Gets hyperlink child ranges within the range.| -||[getNextTextRange(endingMarks: string[], trimSpacing?: boolean)](/javascript/api/word/word.range#word-word-range-getnexttextrange-member(1))|Gets the next text range by using punctuation marks and/or other ending marks.| -||[getNextTextRangeOrNullObject(endingMarks: string[], trimSpacing?: boolean)](/javascript/api/word/word.range#word-word-range-getnexttextrangeornullobject-member(1))|Gets the next text range by using punctuation marks and/or other ending marks.| -||[getRange(rangeLocation?: Word.RangeLocation.whole \| Word.RangeLocation.start \| Word.RangeLocation.end \| Word.RangeLocation.after \| Word.RangeLocation.content \| "Whole" \| "Start" \| "End" \| "After" \| "Content")](/javascript/api/word/word.range#word-word-range-getrange-member(1))|Clones the range, or gets the starting or ending point of the range as a new range.| -||[getTextRanges(endingMarks: string[], trimSpacing?: boolean)](/javascript/api/word/word.range#word-word-range-gettextranges-member(1))|Gets the text child ranges in the range by using punctuation marks and/or other ending marks.| -||[hyperlink](/javascript/api/word/word.range#word-word-range-hyperlink-member)|Gets the first hyperlink in the range, or sets a hyperlink on the range.| -||[insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After", values?: string[][])](/javascript/api/word/word.range#word-word-range-inserttable-member(1))|Inserts a table with the specified number of rows and columns.| -||[intersectWith(range: Word.Range)](/javascript/api/word/word.range#word-word-range-intersectwith-member(1))|Returns a new range as the intersection of this range with another range.| -||[intersectWithOrNullObject(range: Word.Range)](/javascript/api/word/word.range#word-word-range-intersectwithornullobject-member(1))|Returns a new range as the intersection of this range with another range.| -||[isEmpty](/javascript/api/word/word.range#word-word-range-isempty-member)|Checks whether the range length is zero.| -||[lists](/javascript/api/word/word.range#word-word-range-lists-member)|Gets the collection of list objects in the range.| -||[parentBody](/javascript/api/word/word.range#word-word-range-parentbody-member)|Gets the parent body of the range.| -||[parentContentControlOrNullObject](/javascript/api/word/word.range#word-word-range-parentcontentcontrolornullobject-member)|Gets the currently supported content control that contains the range.| -||[parentTable](/javascript/api/word/word.range#word-word-range-parenttable-member)|Gets the table that contains the range.| -||[parentTableCell](/javascript/api/word/word.range#word-word-range-parenttablecell-member)|Gets the table cell that contains the range.| -||[parentTableCellOrNullObject](/javascript/api/word/word.range#word-word-range-parenttablecellornullobject-member)|Gets the table cell that contains the range.| -||[parentTableOrNullObject](/javascript/api/word/word.range#word-word-range-parenttableornullobject-member)|Gets the table that contains the range.| -||[split(delimiters: string[], multiParagraphs?: boolean, trimDelimiters?: boolean, trimSpacing?: boolean)](/javascript/api/word/word.range#word-word-range-split-member(1))|Splits the range into child ranges by using delimiters.| -||[styleBuiltIn](/javascript/api/word/word.range#word-word-range-stylebuiltin-member)|Specifies the built-in style name for the range.| -||[tables](/javascript/api/word/word.range#word-word-range-tables-member)|Gets the collection of table objects in the range.| -|[RangeCollection](/javascript/api/word/word.rangecollection)|[getFirst()](/javascript/api/word/word.rangecollection#word-word-rangecollection-getfirst-member(1))|Gets the first range in this collection.| -||[getFirstOrNullObject()](/javascript/api/word/word.rangecollection#word-word-rangecollection-getfirstornullobject-member(1))|Gets the first range in this collection.| -|[RequestContext](/javascript/api/word/word.requestcontext)|[application](/javascript/api/word/word.requestcontext#word-word-requestcontext-application-member)|[Api set: WordApi 1.3] *| -|[Section](/javascript/api/word/word.section)|[getNext()](/javascript/api/word/word.section#word-word-section-getnext-member(1))|Gets the next section.| -||[getNextOrNullObject()](/javascript/api/word/word.section#word-word-section-getnextornullobject-member(1))|Gets the next section.| -|[SectionCollection](/javascript/api/word/word.sectioncollection)|[getFirst()](/javascript/api/word/word.sectioncollection#word-word-sectioncollection-getfirst-member(1))|Gets the first section in this collection.| -||[getFirstOrNullObject()](/javascript/api/word/word.sectioncollection#word-word-sectioncollection-getfirstornullobject-member(1))|Gets the first section in this collection.| -|[Style](/javascript/api/word/word.style)||| -|[Table](/javascript/api/word/word.table)|[addColumns(insertLocation: Word.InsertLocation.start \| Word.InsertLocation.end \| "Start" \| "End", columnCount: number, values?: string[][])](/javascript/api/word/word.table#word-word-table-addcolumns-member(1))|Adds columns to the start or end of the table, using the first or last existing column as a template.| -||[addRows(insertLocation: Word.InsertLocation.start \| Word.InsertLocation.end \| "Start" \| "End", rowCount: number, values?: string[][])](/javascript/api/word/word.table#word-word-table-addrows-member(1))|Adds rows to the start or end of the table, using the first or last existing row as a template.| -||[alignment](/javascript/api/word/word.table#word-word-table-alignment-member)|Specifies the alignment of the table against the page column.| -||[autoFitWindow()](/javascript/api/word/word.table#word-word-table-autofitwindow-member(1))|Autofits the table columns to the width of the window.| -||[clear()](/javascript/api/word/word.table#word-word-table-clear-member(1))|Clears the contents of the table.| -||[delete()](/javascript/api/word/word.table#word-word-table-delete-member(1))|Deletes the entire table.| -||[deleteColumns(columnIndex: number, columnCount?: number)](/javascript/api/word/word.table#word-word-table-deletecolumns-member(1))|Deletes specific columns.| -||[deleteRows(rowIndex: number, rowCount?: number)](/javascript/api/word/word.table#word-word-table-deleterows-member(1))|Deletes specific rows.| -||[distributeColumns()](/javascript/api/word/word.table#word-word-table-distributecolumns-member(1))|Distributes the column widths evenly.| -||[font](/javascript/api/word/word.table#word-word-table-font-member)|Gets the font.| -||[getBorder(borderLocation: Word.BorderLocation)](/javascript/api/word/word.table#word-word-table-getborder-member(1))|Gets the border style for the specified border.| -||[getCell(rowIndex: number, cellIndex: number)](/javascript/api/word/word.table#word-word-table-getcell-member(1))|Gets the table cell at a specified row and column.| -||[getCellOrNullObject(rowIndex: number, cellIndex: number)](/javascript/api/word/word.table#word-word-table-getcellornullobject-member(1))|Gets the table cell at a specified row and column.| -||[getCellPadding(cellPaddingLocation: Word.CellPaddingLocation)](/javascript/api/word/word.table#word-word-table-getcellpadding-member(1))|Gets cell padding in points.| -||[getNext()](/javascript/api/word/word.table#word-word-table-getnext-member(1))|Gets the next table.| -||[getNextOrNullObject()](/javascript/api/word/word.table#word-word-table-getnextornullobject-member(1))|Gets the next table.| -||[getParagraphAfter()](/javascript/api/word/word.table#word-word-table-getparagraphafter-member(1))|Gets the paragraph after the table.| -||[getParagraphAfterOrNullObject()](/javascript/api/word/word.table#word-word-table-getparagraphafterornullobject-member(1))|Gets the paragraph after the table.| -||[getParagraphBefore()](/javascript/api/word/word.table#word-word-table-getparagraphbefore-member(1))|Gets the paragraph before the table.| -||[getParagraphBeforeOrNullObject()](/javascript/api/word/word.table#word-word-table-getparagraphbeforeornullobject-member(1))|Gets the paragraph before the table.| -||[getRange(rangeLocation?: Word.RangeLocation.whole \| Word.RangeLocation.start \| Word.RangeLocation.end \| Word.RangeLocation.after \| "Whole" \| "Start" \| "End" \| "After")](/javascript/api/word/word.table#word-word-table-getrange-member(1))|Gets the range that contains this table, or the range at the start or end of the table.| -||[headerRowCount](/javascript/api/word/word.table#word-word-table-headerrowcount-member)|Specifies the number of header rows.| -||[horizontalAlignment](/javascript/api/word/word.table#word-word-table-horizontalalignment-member)|Specifies the horizontal alignment of every cell in the table.| -||[insertContentControl()](/javascript/api/word/word.table#word-word-table-insertcontentcontrol-member(1))|Inserts a content control on the table.| -||[insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After")](/javascript/api/word/word.table#word-word-table-insertparagraph-member(1))|Inserts a paragraph at the specified location.| -||[insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After", values?: string[][])](/javascript/api/word/word.table#word-word-table-inserttable-member(1))|Inserts a table with the specified number of rows and columns.| -||[isUniform](/javascript/api/word/word.table#word-word-table-isuniform-member)|Indicates whether all of the table rows are uniform.| -||[nestingLevel](/javascript/api/word/word.table#word-word-table-nestinglevel-member)|Gets the nesting level of the table.| -||[parentBody](/javascript/api/word/word.table#word-word-table-parentbody-member)|Gets the parent body of the table.| -||[parentContentControl](/javascript/api/word/word.table#word-word-table-parentcontentcontrol-member)|Gets the content control that contains the table.| -||[parentContentControlOrNullObject](/javascript/api/word/word.table#word-word-table-parentcontentcontrolornullobject-member)|Gets the content control that contains the table.| -||[parentTable](/javascript/api/word/word.table#word-word-table-parenttable-member)|Gets the table that contains this table.| -||[parentTableCell](/javascript/api/word/word.table#word-word-table-parenttablecell-member)|Gets the table cell that contains this table.| -||[parentTableCellOrNullObject](/javascript/api/word/word.table#word-word-table-parenttablecellornullobject-member)|Gets the table cell that contains this table.| -||[parentTableOrNullObject](/javascript/api/word/word.table#word-word-table-parenttableornullobject-member)|Gets the table that contains this table.| -||[rowCount](/javascript/api/word/word.table#word-word-table-rowcount-member)|Gets the number of rows in the table.| -||[rows](/javascript/api/word/word.table#word-word-table-rows-member)|Gets all of the table rows.| -||[search(searchText: string, searchOptions?: Word.SearchOptions \| { ignorePunct?: boolean ignoreSpace?: boolean matchCase?: boolean matchPrefix?: boolean matchSuffix?: boolean matchWholeWord?: boolean matchWildcards?: boolean })](/javascript/api/word/word.table#word-word-table-search-member(1))|Performs a search with the specified SearchOptions on the scope of the table object.| -||[select(selectionMode?: Word.SelectionMode)](/javascript/api/word/word.table#word-word-table-select-member(1))|Selects the table, or the position at the start or end of the table, and navigates the Word UI to it.| -||[setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number)](/javascript/api/word/word.table#word-word-table-setcellpadding-member(1))|Sets cell padding in points.| -||[shadingColor](/javascript/api/word/word.table#word-word-table-shadingcolor-member)|Specifies the shading color.| -||[style](/javascript/api/word/word.table#word-word-table-style-member)|Specifies the style name for the table.| -||[styleBandedColumns](/javascript/api/word/word.table#word-word-table-stylebandedcolumns-member)|Specifies whether the table has banded columns.| -||[styleBandedRows](/javascript/api/word/word.table#word-word-table-stylebandedrows-member)|Specifies whether the table has banded rows.| -||[styleBuiltIn](/javascript/api/word/word.table#word-word-table-stylebuiltin-member)|Specifies the built-in style name for the table.| -||[styleFirstColumn](/javascript/api/word/word.table#word-word-table-stylefirstcolumn-member)|Specifies whether the table has a first column with a special style.| -||[styleLastColumn](/javascript/api/word/word.table#word-word-table-stylelastcolumn-member)|Specifies whether the table has a last column with a special style.| -||[styleTotalRow](/javascript/api/word/word.table#word-word-table-styletotalrow-member)|Specifies whether the table has a total (last) row with a special style.| -||[tables](/javascript/api/word/word.table#word-word-table-tables-member)|Gets the child tables nested one level deeper.| -||[values](/javascript/api/word/word.table#word-word-table-values-member)|Specifies the text values in the table, as a 2D JavaScript array.| -||[verticalAlignment](/javascript/api/word/word.table#word-word-table-verticalalignment-member)|Specifies the vertical alignment of every cell in the table.| -||[width](/javascript/api/word/word.table#word-word-table-width-member)|Specifies the width of the table in points.| -|[TableBorder](/javascript/api/word/word.tableborder)|[color](/javascript/api/word/word.tableborder#word-word-tableborder-color-member)|Specifies the table border color.| -||[type](/javascript/api/word/word.tableborder#word-word-tableborder-type-member)|Specifies the type of the table border.| -||[width](/javascript/api/word/word.tableborder#word-word-tableborder-width-member)|Specifies the width, in points, of the table border.| -|[TableCell](/javascript/api/word/word.tablecell)|[body](/javascript/api/word/word.tablecell#word-word-tablecell-body-member)|Gets the body object of the cell.| -||[cellIndex](/javascript/api/word/word.tablecell#word-word-tablecell-cellindex-member)|Gets the index of the cell in its row.| -||[columnWidth](/javascript/api/word/word.tablecell#word-word-tablecell-columnwidth-member)|Specifies the width of the cell's column in points.| -||[deleteColumn()](/javascript/api/word/word.tablecell#word-word-tablecell-deletecolumn-member(1))|Deletes the column containing this cell.| -||[deleteRow()](/javascript/api/word/word.tablecell#word-word-tablecell-deleterow-member(1))|Deletes the row containing this cell.| -||[getBorder(borderLocation: Word.BorderLocation)](/javascript/api/word/word.tablecell#word-word-tablecell-getborder-member(1))|Gets the border style for the specified border.| -||[getCellPadding(cellPaddingLocation: Word.CellPaddingLocation)](/javascript/api/word/word.tablecell#word-word-tablecell-getcellpadding-member(1))|Gets cell padding in points.| -||[getNext()](/javascript/api/word/word.tablecell#word-word-tablecell-getnext-member(1))|Gets the next cell.| -||[getNextOrNullObject()](/javascript/api/word/word.tablecell#word-word-tablecell-getnextornullobject-member(1))|Gets the next cell.| -||[horizontalAlignment](/javascript/api/word/word.tablecell#word-word-tablecell-horizontalalignment-member)|Specifies the horizontal alignment of the cell.| -||[insertColumns(insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After", columnCount: number, values?: string[][])](/javascript/api/word/word.tablecell#word-word-tablecell-insertcolumns-member(1))|Adds columns to the left or right of the cell, using the cell's column as a template.| -||[insertRows(insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After", rowCount: number, values?: string[][])](/javascript/api/word/word.tablecell#word-word-tablecell-insertrows-member(1))|Inserts rows above or below the cell, using the cell's row as a template.| -||[parentRow](/javascript/api/word/word.tablecell#word-word-tablecell-parentrow-member)|Gets the parent row of the cell.| -||[parentTable](/javascript/api/word/word.tablecell#word-word-tablecell-parenttable-member)|Gets the parent table of the cell.| -||[rowIndex](/javascript/api/word/word.tablecell#word-word-tablecell-rowindex-member)|Gets the index of the cell's row in the table.| -||[setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number)](/javascript/api/word/word.tablecell#word-word-tablecell-setcellpadding-member(1))|Sets cell padding in points.| -||[shadingColor](/javascript/api/word/word.tablecell#word-word-tablecell-shadingcolor-member)|Specifies the shading color of the cell.| -||[value](/javascript/api/word/word.tablecell#word-word-tablecell-value-member)|Specifies the text of the cell.| -||[verticalAlignment](/javascript/api/word/word.tablecell#word-word-tablecell-verticalalignment-member)|Specifies the vertical alignment of the cell.| -||[width](/javascript/api/word/word.tablecell#word-word-tablecell-width-member)|Gets the width of the cell in points.| -|[TableCellCollection](/javascript/api/word/word.tablecellcollection)|[getFirst()](/javascript/api/word/word.tablecellcollection#word-word-tablecellcollection-getfirst-member(1))|Gets the first table cell in this collection.| -||[getFirstOrNullObject()](/javascript/api/word/word.tablecellcollection#word-word-tablecellcollection-getfirstornullobject-member(1))|Gets the first table cell in this collection.| -||[items](/javascript/api/word/word.tablecellcollection#word-word-tablecellcollection-items-member)|Gets the loaded child items in this collection.| -|[TableCollection](/javascript/api/word/word.tablecollection)|[getFirst()](/javascript/api/word/word.tablecollection#word-word-tablecollection-getfirst-member(1))|Gets the first table in this collection.| -||[getFirstOrNullObject()](/javascript/api/word/word.tablecollection#word-word-tablecollection-getfirstornullobject-member(1))|Gets the first table in this collection.| -||[items](/javascript/api/word/word.tablecollection#word-word-tablecollection-items-member)|Gets the loaded child items in this collection.| -|[TableRow](/javascript/api/word/word.tablerow)|[cellCount](/javascript/api/word/word.tablerow#word-word-tablerow-cellcount-member)|Gets the number of cells in the row.| -||[cells](/javascript/api/word/word.tablerow#word-word-tablerow-cells-member)|Gets cells.| -||[clear()](/javascript/api/word/word.tablerow#word-word-tablerow-clear-member(1))|Clears the contents of the row.| -||[delete()](/javascript/api/word/word.tablerow#word-word-tablerow-delete-member(1))|Deletes the entire row.| -||[font](/javascript/api/word/word.tablerow#word-word-tablerow-font-member)|Gets the font.| -||[getBorder(borderLocation: Word.BorderLocation)](/javascript/api/word/word.tablerow#word-word-tablerow-getborder-member(1))|Gets the border style of the cells in the row.| -||[getCellPadding(cellPaddingLocation: Word.CellPaddingLocation)](/javascript/api/word/word.tablerow#word-word-tablerow-getcellpadding-member(1))|Gets cell padding in points.| -||[getNext()](/javascript/api/word/word.tablerow#word-word-tablerow-getnext-member(1))|Gets the next row.| -||[getNextOrNullObject()](/javascript/api/word/word.tablerow#word-word-tablerow-getnextornullobject-member(1))|Gets the next row.| -||[horizontalAlignment](/javascript/api/word/word.tablerow#word-word-tablerow-horizontalalignment-member)|Specifies the horizontal alignment of every cell in the row.| -||[insertRows(insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After", rowCount: number, values?: string[][])](/javascript/api/word/word.tablerow#word-word-tablerow-insertrows-member(1))|Inserts rows using this row as a template.| -||[isHeader](/javascript/api/word/word.tablerow#word-word-tablerow-isheader-member)|Checks whether the row is a header row.| -||[parentTable](/javascript/api/word/word.tablerow#word-word-tablerow-parenttable-member)|Gets parent table.| -||[preferredHeight](/javascript/api/word/word.tablerow#word-word-tablerow-preferredheight-member)|Specifies the preferred height of the row in points.| -||[rowIndex](/javascript/api/word/word.tablerow#word-word-tablerow-rowindex-member)|Gets the index of the row in its parent table.| -||[search(searchText: string, searchOptions?: Word.SearchOptions \| { ignorePunct?: boolean ignoreSpace?: boolean matchCase?: boolean matchPrefix?: boolean matchSuffix?: boolean matchWholeWord?: boolean matchWildcards?: boolean })](/javascript/api/word/word.tablerow#word-word-tablerow-search-member(1))|Performs a search with the specified SearchOptions on the scope of the row.| -||[select(selectionMode?: Word.SelectionMode)](/javascript/api/word/word.tablerow#word-word-tablerow-select-member(1))|Selects the row and navigates the Word UI to it.| -||[setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number)](/javascript/api/word/word.tablerow#word-word-tablerow-setcellpadding-member(1))|Sets cell padding in points.| -||[shadingColor](/javascript/api/word/word.tablerow#word-word-tablerow-shadingcolor-member)|Specifies the shading color.| -||[values](/javascript/api/word/word.tablerow#word-word-tablerow-values-member)|Specifies the text values in the row, as a 2D JavaScript array.| -||[verticalAlignment](/javascript/api/word/word.tablerow#word-word-tablerow-verticalalignment-member)|Specifies the vertical alignment of the cells in the row.| -|[TableRowCollection](/javascript/api/word/word.tablerowcollection)|[getFirst()](/javascript/api/word/word.tablerowcollection#word-word-tablerowcollection-getfirst-member(1))|Gets the first row in this collection.| -||[getFirstOrNullObject()](/javascript/api/word/word.tablerowcollection#word-word-tablerowcollection-getfirstornullobject-member(1))|Gets the first row in this collection.| -||[items](/javascript/api/word/word.tablerowcollection#word-word-tablerowcollection-items-member)|Gets the loaded child items in this collection.| +|[Application](/.application)|[createDocument(base64File?: string)](/.application#word-javascript/api/word/-application-createdocument-member(1))|Creates a new document by using an optional Base64-encoded .docx file.| +|[Body](/.body)|[getRange(rangeLocation?: Word.RangeLocation.whole \| Word.RangeLocation.start \| Word.RangeLocation.end \| Word.RangeLocation.after \| Word.RangeLocation.content \| "Whole" \| "Start" \| "End" \| "After" \| "Content")](/.body#word-javascript/api/word/-body-getrange-member(1))|Gets the whole body, or the starting or ending point of the body, as a range.| +||[insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.start \| Word.InsertLocation.end \| "Start" \| "End", values?: string[][])](/.body#word-javascript/api/word/-body-inserttable-member(1))|Inserts a table with the specified number of rows and columns.| +||[lists](/.body#word-javascript/api/word/-body-lists-member)|Gets the collection of list objects in the body.| +||[parentBody](/.body#word-javascript/api/word/-body-parentbody-member)|Gets the parent body of the body.| +||[parentBodyOrNullObject](/.body#word-javascript/api/word/-body-parentbodyornullobject-member)|Gets the parent body of the body.| +||[parentContentControlOrNullObject](/.body#word-javascript/api/word/-body-parentcontentcontrolornullobject-member)|Gets the content control that contains the body.| +||[parentSection](/.body#word-javascript/api/word/-body-parentsection-member)|Gets the parent section of the body.| +||[parentSectionOrNullObject](/.body#word-javascript/api/word/-body-parentsectionornullobject-member)|Gets the parent section of the body.| +||[styleBuiltIn](/.body#word-javascript/api/word/-body-stylebuiltin-member)|Specifies the built-in style name for the body.| +||[tables](/.body#word-javascript/api/word/-body-tables-member)|Gets the collection of table objects in the body.| +||[type](/.body#word-javascript/api/word/-body-type-member)|Gets the type of the body.| +|[ContentControl](/.contentcontrol)|[getRange(rangeLocation?: Word.RangeLocation \| "Whole" \| "Start" \| "End" \| "Before" \| "After" \| "Content")](/.contentcontrol#word-javascript/api/word/-contentcontrol-getrange-member(1))|Gets the whole content control, or the starting or ending point of the content control, as a range.| +||[getTextRanges(endingMarks: string[], trimSpacing?: boolean)](/.contentcontrol#word-javascript/api/word/-contentcontrol-gettextranges-member(1))|Gets the text ranges in the content control by using punctuation marks and/or other ending marks.| +||[insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.start \| Word.InsertLocation.end \| Word.InsertLocation.before \| Word.InsertLocation.after \| "Start" \| "End" \| "Before" \| "After", values?: string[][])](/.contentcontrol#word-javascript/api/word/-contentcontrol-inserttable-member(1))|Inserts a table with the specified number of rows and columns into, or next to, a content control.| +||[lists](/.contentcontrol#word-javascript/api/word/-contentcontrol-lists-member)|Gets the collection of list objects in the content control.| +||[parentBody](/.contentcontrol#word-javascript/api/word/-contentcontrol-parentbody-member)|Gets the parent body of the content control.| +||[parentContentControlOrNullObject](/.contentcontrol#word-javascript/api/word/-contentcontrol-parentcontentcontrolornullobject-member)|Gets the content control that contains the content control.| +||[parentTable](/.contentcontrol#word-javascript/api/word/-contentcontrol-parenttable-member)|Gets the table that contains the content control.| +||[parentTableCell](/.contentcontrol#word-javascript/api/word/-contentcontrol-parenttablecell-member)|Gets the table cell that contains the content control.| +||[parentTableCellOrNullObject](/.contentcontrol#word-javascript/api/word/-contentcontrol-parenttablecellornullobject-member)|Gets the table cell that contains the content control.| +||[parentTableOrNullObject](/.contentcontrol#word-javascript/api/word/-contentcontrol-parenttableornullobject-member)|Gets the table that contains the content control.| +||[split(delimiters: string[], multiParagraphs?: boolean, trimDelimiters?: boolean, trimSpacing?: boolean)](/.contentcontrol#word-javascript/api/word/-contentcontrol-split-member(1))|Splits the content control into child ranges by using delimiters.| +||[styleBuiltIn](/.contentcontrol#word-javascript/api/word/-contentcontrol-stylebuiltin-member)|Specifies the built-in style name for the content control.| +||[subtype](/.contentcontrol#word-javascript/api/word/-contentcontrol-subtype-member)|Gets the content control subtype.| +||[tables](/.contentcontrol#word-javascript/api/word/-contentcontrol-tables-member)|Gets the collection of table objects in the content control.| +|[ContentControlCollection](/.contentcontrolcollection)|[getByIdOrNullObject(id: number)](/.contentcontrolcollection#word-javascript/api/word/-contentcontrolcollection-getbyidornullobject-member(1))|Gets a content control by its identifier.| +||[getByTypes(types: Word.ContentControlType[])](/.contentcontrolcollection#word-javascript/api/word/-contentcontrolcollection-getbytypes-member(1))|Gets the content controls that have the specified types.| +||[getFirst()](/.contentcontrolcollection#word-javascript/api/word/-contentcontrolcollection-getfirst-member(1))|Gets the first content control in this collection.| +||[getFirstOrNullObject()](/.contentcontrolcollection#word-javascript/api/word/-contentcontrolcollection-getfirstornullobject-member(1))|Gets the first content control in this collection.| +|[CustomProperty](/.customproperty)|[delete()](/.customproperty#word-javascript/api/word/-customproperty-delete-member(1))|Deletes the custom property.| +||[key](/.customproperty#word-javascript/api/word/-customproperty-key-member)|Gets the key of the custom property.| +||[type](/.customproperty#word-javascript/api/word/-customproperty-type-member)|Gets the value type of the custom property.| +||[value](/.customproperty#word-javascript/api/word/-customproperty-value-member)|Specifies the value of the custom property.| +|[CustomPropertyCollection](/.custompropertycollection)|[add(key: string, value: any)](/.custompropertycollection#word-javascript/api/word/-custompropertycollection-add-member(1))|Creates a new or sets an existing custom property.| +||[deleteAll()](/.custompropertycollection#word-javascript/api/word/-custompropertycollection-deleteall-member(1))|Deletes all custom properties in this collection.| +||[getCount()](/.custompropertycollection#word-javascript/api/word/-custompropertycollection-getcount-member(1))|Gets the count of custom properties.| +||[getItem(key: string)](/.custompropertycollection#word-javascript/api/word/-custompropertycollection-getitem-member(1))|Gets a custom property object by its key, which is case-insensitive.| +||[getItemOrNullObject(key: string)](/.custompropertycollection#word-javascript/api/word/-custompropertycollection-getitemornullobject-member(1))|Gets a custom property object by its key, which is case-insensitive.| +||[items](/.custompropertycollection#word-javascript/api/word/-custompropertycollection-items-member)|Gets the loaded child items in this collection.| +|[Document](/.document)|[properties](/.document#word-javascript/api/word/-document-properties-member)|Gets the properties of the document.| +|[DocumentCreated](/.documentcreated)|[open()](/.documentcreated#word-javascript/api/word/-documentcreated-open-member(1))|Opens the document.| +|[DocumentProperties](/.documentproperties)|[applicationName](/.documentproperties#word-javascript/api/word/-documentproperties-applicationname-member)|Gets the application name of the document.| +||[author](/.documentproperties#word-javascript/api/word/-documentproperties-author-member)|Specifies the author of the document.| +||[category](/.documentproperties#word-javascript/api/word/-documentproperties-category-member)|Specifies the category of the document.| +||[comments](/.documentproperties#word-javascript/api/word/-documentproperties-comments-member)|Specifies the Comments field in the metadata of the document.| +||[company](/.documentproperties#word-javascript/api/word/-documentproperties-company-member)|Specifies the company of the document.| +||[creationDate](/.documentproperties#word-javascript/api/word/-documentproperties-creationdate-member)|Gets the creation date of the document.| +||[customProperties](/.documentproperties#word-javascript/api/word/-documentproperties-customproperties-member)|Gets the collection of custom properties of the document.| +||[format](/.documentproperties#word-javascript/api/word/-documentproperties-format-member)|Specifies the format of the document.| +||[keywords](/.documentproperties#word-javascript/api/word/-documentproperties-keywords-member)|Specifies the keywords of the document.| +||[lastAuthor](/.documentproperties#word-javascript/api/word/-documentproperties-lastauthor-member)|Gets the last author of the document.| +||[lastPrintDate](/.documentproperties#word-javascript/api/word/-documentproperties-lastprintdate-member)|Gets the last print date of the document.| +||[lastSaveTime](/.documentproperties#word-javascript/api/word/-documentproperties-lastsavetime-member)|Gets the last save time of the document.| +||[manager](/.documentproperties#word-javascript/api/word/-documentproperties-manager-member)|Specifies the manager of the document.| +||[revisionNumber](/.documentproperties#word-javascript/api/word/-documentproperties-revisionnumber-member)|Gets the revision number of the document.| +||[security](/.documentproperties#word-javascript/api/word/-documentproperties-security-member)|Gets security settings of the document.| +||[subject](/.documentproperties#word-javascript/api/word/-documentproperties-subject-member)|Specifies the subject of the document.| +||[template](/.documentproperties#word-javascript/api/word/-documentproperties-template-member)|Gets the template of the document.| +||[title](/.documentproperties#word-javascript/api/word/-documentproperties-title-member)|Specifies the title of the document.| +|[InlinePicture](/.inlinepicture)|[getNext()](/.inlinepicture#word-javascript/api/word/-inlinepicture-getnext-member(1))|Gets the next inline image.| +||[getNextOrNullObject()](/.inlinepicture#word-javascript/api/word/-inlinepicture-getnextornullobject-member(1))|Gets the next inline image.| +||[getRange(rangeLocation?: Word.RangeLocation.whole \| Word.RangeLocation.start \| Word.RangeLocation.end \| "Whole" \| "Start" \| "End")](/.inlinepicture#word-javascript/api/word/-inlinepicture-getrange-member(1))|Gets the picture, or the starting or ending point of the picture, as a range.| +||[parentContentControlOrNullObject](/.inlinepicture#word-javascript/api/word/-inlinepicture-parentcontentcontrolornullobject-member)|Gets the content control that contains the inline image.| +||[parentTable](/.inlinepicture#word-javascript/api/word/-inlinepicture-parenttable-member)|Gets the table that contains the inline image.| +||[parentTableCell](/.inlinepicture#word-javascript/api/word/-inlinepicture-parenttablecell-member)|Gets the table cell that contains the inline image.| +||[parentTableCellOrNullObject](/.inlinepicture#word-javascript/api/word/-inlinepicture-parenttablecellornullobject-member)|Gets the table cell that contains the inline image.| +||[parentTableOrNullObject](/.inlinepicture#word-javascript/api/word/-inlinepicture-parenttableornullobject-member)|Gets the table that contains the inline image.| +|[InlinePictureCollection](/.inlinepicturecollection)|[getFirst()](/.inlinepicturecollection#word-javascript/api/word/-inlinepicturecollection-getfirst-member(1))|Gets the first inline image in this collection.| +||[getFirstOrNullObject()](/.inlinepicturecollection#word-javascript/api/word/-inlinepicturecollection-getfirstornullobject-member(1))|Gets the first inline image in this collection.| +|[List](/.list)|[getLevelParagraphs(level: number)](/.list#word-javascript/api/word/-list-getlevelparagraphs-member(1))|Gets the paragraphs that occur at the specified level in the list.| +||[getLevelString(level: number)](/.list#word-javascript/api/word/-list-getlevelstring-member(1))|Gets the bullet, number, or picture at the specified level as a string.| +||[id](/.list#word-javascript/api/word/-list-id-member)|Gets the list's id.| +||[insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.start \| Word.InsertLocation.end \| Word.InsertLocation.before \| Word.InsertLocation.after \| "Start" \| "End" \| "Before" \| "After")](/.list#word-javascript/api/word/-list-insertparagraph-member(1))|Inserts a paragraph at the specified location.| +||[levelExistences](/.list#word-javascript/api/word/-list-levelexistences-member)|Checks whether each of the 9 levels exists in the list.| +||[levelTypes](/.list#word-javascript/api/word/-list-leveltypes-member)|Gets all 9 level types in the list.| +||[paragraphs](/.list#word-javascript/api/word/-list-paragraphs-member)|Gets paragraphs in the list.| +||[setLevelAlignment(level: number, alignment: Word.Alignment)](/.list#word-javascript/api/word/-list-setlevelalignment-member(1))|Sets the alignment of the bullet, number, or picture at the specified level in the list.| +||[setLevelBullet(level: number, listBullet: Word.ListBullet, charCode?: number, fontName?: string)](/.list#word-javascript/api/word/-list-setlevelbullet-member(1))|Sets the bullet format at the specified level in the list.| +||[setLevelIndents(level: number, textIndent: number, bulletNumberPictureIndent: number)](/.list#word-javascript/api/word/-list-setlevelindents-member(1))|Sets the two indents of the specified level in the list.| +||[setLevelNumbering(level: number, listNumbering: Word.ListNumbering, formatString?: Array)](/.list#word-javascript/api/word/-list-setlevelnumbering-member(1))|Sets the numbering format at the specified level in the list.| +||[setLevelStartingNumber(level: number, startingNumber: number)](/.list#word-javascript/api/word/-list-setlevelstartingnumber-member(1))|Sets the starting number at the specified level in the list.| +|[ListCollection](/.listcollection)|[getById(id: number)](/.listcollection#word-javascript/api/word/-listcollection-getbyid-member(1))|Gets a list by its identifier.| +||[getByIdOrNullObject(id: number)](/.listcollection#word-javascript/api/word/-listcollection-getbyidornullobject-member(1))|Gets a list by its identifier.| +||[getFirst()](/.listcollection#word-javascript/api/word/-listcollection-getfirst-member(1))|Gets the first list in this collection.| +||[getFirstOrNullObject()](/.listcollection#word-javascript/api/word/-listcollection-getfirstornullobject-member(1))|Gets the first list in this collection.| +||[getItem(id: number)](/.listcollection#word-javascript/api/word/-listcollection-getitem-member(1))|Gets a list object by its ID.| +||[items](/.listcollection#word-javascript/api/word/-listcollection-items-member)|Gets the loaded child items in this collection.| +|[ListItem](/.listitem)|[getAncestor(parentOnly?: boolean)](/.listitem#word-javascript/api/word/-listitem-getancestor-member(1))|Gets the list item parent, or the closest ancestor if the parent doesn't exist.| +||[getAncestorOrNullObject(parentOnly?: boolean)](/.listitem#word-javascript/api/word/-listitem-getancestorornullobject-member(1))|Gets the list item parent, or the closest ancestor if the parent doesn't exist.| +||[getDescendants(directChildrenOnly?: boolean)](/.listitem#word-javascript/api/word/-listitem-getdescendants-member(1))|Gets all descendant list items of the list item.| +||[level](/.listitem#word-javascript/api/word/-listitem-level-member)|Specifies the level of the item in the list.| +||[listString](/.listitem#word-javascript/api/word/-listitem-liststring-member)|Gets the list item bullet, number, or picture as a string.| +||[siblingIndex](/.listitem#word-javascript/api/word/-listitem-siblingindex-member)|Gets the list item order number in relation to its siblings.| +|[Paragraph](/.paragraph)|[attachToList(listId: number, level: number)](/.paragraph#word-javascript/api/word/-paragraph-attachtolist-member(1))|Lets the paragraph join an existing list at the specified level.| +||[detachFromList()](/.paragraph#word-javascript/api/word/-paragraph-detachfromlist-member(1))|Moves this paragraph out of its list, if the paragraph is a list item.| +||[getNext()](/.paragraph#word-javascript/api/word/-paragraph-getnext-member(1))|Gets the next paragraph.| +||[getNextOrNullObject()](/.paragraph#word-javascript/api/word/-paragraph-getnextornullobject-member(1))|Gets the next paragraph.| +||[getPrevious()](/.paragraph#word-javascript/api/word/-paragraph-getprevious-member(1))|Gets the previous paragraph.| +||[getPreviousOrNullObject()](/.paragraph#word-javascript/api/word/-paragraph-getpreviousornullobject-member(1))|Gets the previous paragraph.| +||[getRange(rangeLocation?: Word.RangeLocation.whole \| Word.RangeLocation.start \| Word.RangeLocation.end \| Word.RangeLocation.after \| Word.RangeLocation.content \| "Whole" \| "Start" \| "End" \| "After" \| "Content")](/.paragraph#word-javascript/api/word/-paragraph-getrange-member(1))|Gets the whole paragraph, or the starting or ending point of the paragraph, as a range.| +||[getTextRanges(endingMarks: string[], trimSpacing?: boolean)](/.paragraph#word-javascript/api/word/-paragraph-gettextranges-member(1))|Gets the text ranges in the paragraph by using punctuation marks and/or other ending marks.| +||[insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After", values?: string[][])](/.paragraph#word-javascript/api/word/-paragraph-inserttable-member(1))|Inserts a table with the specified number of rows and columns.| +||[isLastParagraph](/.paragraph#word-javascript/api/word/-paragraph-islastparagraph-member)|Indicates the paragraph is the last one inside its parent body.| +||[isListItem](/.paragraph#word-javascript/api/word/-paragraph-islistitem-member)|Checks whether the paragraph is a list item.| +||[list](/.paragraph#word-javascript/api/word/-paragraph-list-member)|Gets the List to which this paragraph belongs.| +||[listItem](/.paragraph#word-javascript/api/word/-paragraph-listitem-member)|Gets the ListItem for the paragraph.| +||[listItemOrNullObject](/.paragraph#word-javascript/api/word/-paragraph-listitemornullobject-member)|Gets the ListItem for the paragraph.| +||[listOrNullObject](/.paragraph#word-javascript/api/word/-paragraph-listornullobject-member)|Gets the List to which this paragraph belongs.| +||[parentBody](/.paragraph#word-javascript/api/word/-paragraph-parentbody-member)|Gets the parent body of the paragraph.| +||[parentContentControlOrNullObject](/.paragraph#word-javascript/api/word/-paragraph-parentcontentcontrolornullobject-member)|Gets the content control that contains the paragraph.| +||[parentTable](/.paragraph#word-javascript/api/word/-paragraph-parenttable-member)|Gets the table that contains the paragraph.| +||[parentTableCell](/.paragraph#word-javascript/api/word/-paragraph-parenttablecell-member)|Gets the table cell that contains the paragraph.| +||[parentTableCellOrNullObject](/.paragraph#word-javascript/api/word/-paragraph-parenttablecellornullobject-member)|Gets the table cell that contains the paragraph.| +||[parentTableOrNullObject](/.paragraph#word-javascript/api/word/-paragraph-parenttableornullobject-member)|Gets the table that contains the paragraph.| +||[split(delimiters: string[], trimDelimiters?: boolean, trimSpacing?: boolean)](/.paragraph#word-javascript/api/word/-paragraph-split-member(1))|Splits the paragraph into child ranges by using delimiters.| +||[startNewList()](/.paragraph#word-javascript/api/word/-paragraph-startnewlist-member(1))|Starts a new list with this paragraph.| +||[styleBuiltIn](/.paragraph#word-javascript/api/word/-paragraph-stylebuiltin-member)|Specifies the built-in style name for the paragraph.| +||[tableNestingLevel](/.paragraph#word-javascript/api/word/-paragraph-tablenestinglevel-member)|Gets the level of the paragraph's table.| +|[ParagraphCollection](/.paragraphcollection)|[getFirst()](/.paragraphcollection#word-javascript/api/word/-paragraphcollection-getfirst-member(1))|Gets the first paragraph in this collection.| +||[getFirstOrNullObject()](/.paragraphcollection#word-javascript/api/word/-paragraphcollection-getfirstornullobject-member(1))|Gets the first paragraph in this collection.| +||[getLast()](/.paragraphcollection#word-javascript/api/word/-paragraphcollection-getlast-member(1))|Gets the last paragraph in this collection.| +||[getLastOrNullObject()](/.paragraphcollection#word-javascript/api/word/-paragraphcollection-getlastornullobject-member(1))|Gets the last paragraph in this collection.| +|[Range](/.range)|[compareLocationWith(range: Word.Range)](/.range#word-javascript/api/word/-range-comparelocationwith-member(1))|Compares this range's location with another range's location.| +||[expandTo(range: Word.Range)](/.range#word-javascript/api/word/-range-expandto-member(1))|Returns a new range that extends from this range in either direction to cover another range.| +||[expandToOrNullObject(range: Word.Range)](/.range#word-javascript/api/word/-range-expandtoornullobject-member(1))|Returns a new range that extends from this range in either direction to cover another range.| +||[getHyperlinkRanges()](/.range#word-javascript/api/word/-range-gethyperlinkranges-member(1))|Gets hyperlink child ranges within the range.| +||[getNextTextRange(endingMarks: string[], trimSpacing?: boolean)](/.range#word-javascript/api/word/-range-getnexttextrange-member(1))|Gets the next text range by using punctuation marks and/or other ending marks.| +||[getNextTextRangeOrNullObject(endingMarks: string[], trimSpacing?: boolean)](/.range#word-javascript/api/word/-range-getnexttextrangeornullobject-member(1))|Gets the next text range by using punctuation marks and/or other ending marks.| +||[getRange(rangeLocation?: Word.RangeLocation.whole \| Word.RangeLocation.start \| Word.RangeLocation.end \| Word.RangeLocation.after \| Word.RangeLocation.content \| "Whole" \| "Start" \| "End" \| "After" \| "Content")](/.range#word-javascript/api/word/-range-getrange-member(1))|Clones the range, or gets the starting or ending point of the range as a new range.| +||[getTextRanges(endingMarks: string[], trimSpacing?: boolean)](/.range#word-javascript/api/word/-range-gettextranges-member(1))|Gets the text child ranges in the range by using punctuation marks and/or other ending marks.| +||[hyperlink](/.range#word-javascript/api/word/-range-hyperlink-member)|Gets the first hyperlink in the range, or sets a hyperlink on the range.| +||[insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After", values?: string[][])](/.range#word-javascript/api/word/-range-inserttable-member(1))|Inserts a table with the specified number of rows and columns.| +||[intersectWith(range: Word.Range)](/.range#word-javascript/api/word/-range-intersectwith-member(1))|Returns a new range as the intersection of this range with another range.| +||[intersectWithOrNullObject(range: Word.Range)](/.range#word-javascript/api/word/-range-intersectwithornullobject-member(1))|Returns a new range as the intersection of this range with another range.| +||[isEmpty](/.range#word-javascript/api/word/-range-isempty-member)|Checks whether the range length is zero.| +||[lists](/.range#word-javascript/api/word/-range-lists-member)|Gets the collection of list objects in the range.| +||[parentBody](/.range#word-javascript/api/word/-range-parentbody-member)|Gets the parent body of the range.| +||[parentContentControlOrNullObject](/.range#word-javascript/api/word/-range-parentcontentcontrolornullobject-member)|Gets the currently supported content control that contains the range.| +||[parentTable](/.range#word-javascript/api/word/-range-parenttable-member)|Gets the table that contains the range.| +||[parentTableCell](/.range#word-javascript/api/word/-range-parenttablecell-member)|Gets the table cell that contains the range.| +||[parentTableCellOrNullObject](/.range#word-javascript/api/word/-range-parenttablecellornullobject-member)|Gets the table cell that contains the range.| +||[parentTableOrNullObject](/.range#word-javascript/api/word/-range-parenttableornullobject-member)|Gets the table that contains the range.| +||[split(delimiters: string[], multiParagraphs?: boolean, trimDelimiters?: boolean, trimSpacing?: boolean)](/.range#word-javascript/api/word/-range-split-member(1))|Splits the range into child ranges by using delimiters.| +||[styleBuiltIn](/.range#word-javascript/api/word/-range-stylebuiltin-member)|Specifies the built-in style name for the range.| +||[tables](/.range#word-javascript/api/word/-range-tables-member)|Gets the collection of table objects in the range.| +|[RangeCollection](/.rangecollection)|[getFirst()](/.rangecollection#word-javascript/api/word/-rangecollection-getfirst-member(1))|Gets the first range in this collection.| +||[getFirstOrNullObject()](/.rangecollection#word-javascript/api/word/-rangecollection-getfirstornullobject-member(1))|Gets the first range in this collection.| +|[RequestContext](/.requestcontext)|[application](/.requestcontext#word-javascript/api/word/-requestcontext-application-member)|[Api set: WordApi 1.3] *| +|[Section](/.section)|[getNext()](/.section#word-javascript/api/word/-section-getnext-member(1))|Gets the next section.| +||[getNextOrNullObject()](/.section#word-javascript/api/word/-section-getnextornullobject-member(1))|Gets the next section.| +|[SectionCollection](/.sectioncollection)|[getFirst()](/.sectioncollection#word-javascript/api/word/-sectioncollection-getfirst-member(1))|Gets the first section in this collection.| +||[getFirstOrNullObject()](/.sectioncollection#word-javascript/api/word/-sectioncollection-getfirstornullobject-member(1))|Gets the first section in this collection.| +|[Style](/.style)||| +|[Table](/.table)|[addColumns(insertLocation: Word.InsertLocation.start \| Word.InsertLocation.end \| "Start" \| "End", columnCount: number, values?: string[][])](/.table#word-javascript/api/word/-table-addcolumns-member(1))|Adds columns to the start or end of the table, using the first or last existing column as a template.| +||[addRows(insertLocation: Word.InsertLocation.start \| Word.InsertLocation.end \| "Start" \| "End", rowCount: number, values?: string[][])](/.table#word-javascript/api/word/-table-addrows-member(1))|Adds rows to the start or end of the table, using the first or last existing row as a template.| +||[alignment](/.table#word-javascript/api/word/-table-alignment-member)|Specifies the alignment of the table against the page column.| +||[autoFitWindow()](/.table#word-javascript/api/word/-table-autofitwindow-member(1))|Autofits the table columns to the width of the window.| +||[clear()](/.table#word-javascript/api/word/-table-clear-member(1))|Clears the contents of the table.| +||[delete()](/.table#word-javascript/api/word/-table-delete-member(1))|Deletes the entire table.| +||[deleteColumns(columnIndex: number, columnCount?: number)](/.table#word-javascript/api/word/-table-deletecolumns-member(1))|Deletes specific columns.| +||[deleteRows(rowIndex: number, rowCount?: number)](/.table#word-javascript/api/word/-table-deleterows-member(1))|Deletes specific rows.| +||[distributeColumns()](/.table#word-javascript/api/word/-table-distributecolumns-member(1))|Distributes the column widths evenly.| +||[font](/.table#word-javascript/api/word/-table-font-member)|Gets the font.| +||[getBorder(borderLocation: Word.BorderLocation)](/.table#word-javascript/api/word/-table-getborder-member(1))|Gets the border style for the specified border.| +||[getCell(rowIndex: number, cellIndex: number)](/.table#word-javascript/api/word/-table-getcell-member(1))|Gets the table cell at a specified row and column.| +||[getCellOrNullObject(rowIndex: number, cellIndex: number)](/.table#word-javascript/api/word/-table-getcellornullobject-member(1))|Gets the table cell at a specified row and column.| +||[getCellPadding(cellPaddingLocation: Word.CellPaddingLocation)](/.table#word-javascript/api/word/-table-getcellpadding-member(1))|Gets cell padding in points.| +||[getNext()](/.table#word-javascript/api/word/-table-getnext-member(1))|Gets the next table.| +||[getNextOrNullObject()](/.table#word-javascript/api/word/-table-getnextornullobject-member(1))|Gets the next table.| +||[getParagraphAfter()](/.table#word-javascript/api/word/-table-getparagraphafter-member(1))|Gets the paragraph after the table.| +||[getParagraphAfterOrNullObject()](/.table#word-javascript/api/word/-table-getparagraphafterornullobject-member(1))|Gets the paragraph after the table.| +||[getParagraphBefore()](/.table#word-javascript/api/word/-table-getparagraphbefore-member(1))|Gets the paragraph before the table.| +||[getParagraphBeforeOrNullObject()](/.table#word-javascript/api/word/-table-getparagraphbeforeornullobject-member(1))|Gets the paragraph before the table.| +||[getRange(rangeLocation?: Word.RangeLocation.whole \| Word.RangeLocation.start \| Word.RangeLocation.end \| Word.RangeLocation.after \| "Whole" \| "Start" \| "End" \| "After")](/.table#word-javascript/api/word/-table-getrange-member(1))|Gets the range that contains this table, or the range at the start or end of the table.| +||[headerRowCount](/.table#word-javascript/api/word/-table-headerrowcount-member)|Specifies the number of header rows.| +||[horizontalAlignment](/.table#word-javascript/api/word/-table-horizontalalignment-member)|Specifies the horizontal alignment of every cell in the table.| +||[insertContentControl()](/.table#word-javascript/api/word/-table-insertcontentcontrol-member(1))|Inserts a content control on the table.| +||[insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After")](/.table#word-javascript/api/word/-table-insertparagraph-member(1))|Inserts a paragraph at the specified location.| +||[insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After", values?: string[][])](/.table#word-javascript/api/word/-table-inserttable-member(1))|Inserts a table with the specified number of rows and columns.| +||[isUniform](/.table#word-javascript/api/word/-table-isuniform-member)|Indicates whether all of the table rows are uniform.| +||[nestingLevel](/.table#word-javascript/api/word/-table-nestinglevel-member)|Gets the nesting level of the table.| +||[parentBody](/.table#word-javascript/api/word/-table-parentbody-member)|Gets the parent body of the table.| +||[parentContentControl](/.table#word-javascript/api/word/-table-parentcontentcontrol-member)|Gets the content control that contains the table.| +||[parentContentControlOrNullObject](/.table#word-javascript/api/word/-table-parentcontentcontrolornullobject-member)|Gets the content control that contains the table.| +||[parentTable](/.table#word-javascript/api/word/-table-parenttable-member)|Gets the table that contains this table.| +||[parentTableCell](/.table#word-javascript/api/word/-table-parenttablecell-member)|Gets the table cell that contains this table.| +||[parentTableCellOrNullObject](/.table#word-javascript/api/word/-table-parenttablecellornullobject-member)|Gets the table cell that contains this table.| +||[parentTableOrNullObject](/.table#word-javascript/api/word/-table-parenttableornullobject-member)|Gets the table that contains this table.| +||[rowCount](/.table#word-javascript/api/word/-table-rowcount-member)|Gets the number of rows in the table.| +||[rows](/.table#word-javascript/api/word/-table-rows-member)|Gets all of the table rows.| +||[search(searchText: string, searchOptions?: Word.SearchOptions \| { ignorePunct?: boolean ignoreSpace?: boolean matchCase?: boolean matchPrefix?: boolean matchSuffix?: boolean matchWholeWord?: boolean matchWildcards?: boolean })](/.table#word-javascript/api/word/-table-search-member(1))|Performs a search with the specified SearchOptions on the scope of the table object.| +||[select(selectionMode?: Word.SelectionMode)](/.table#word-javascript/api/word/-table-select-member(1))|Selects the table, or the position at the start or end of the table, and navigates the Word UI to it.| +||[setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number)](/.table#word-javascript/api/word/-table-setcellpadding-member(1))|Sets cell padding in points.| +||[shadingColor](/.table#word-javascript/api/word/-table-shadingcolor-member)|Specifies the shading color.| +||[style](/.table#word-javascript/api/word/-table-style-member)|Specifies the style name for the table.| +||[styleBandedColumns](/.table#word-javascript/api/word/-table-stylebandedcolumns-member)|Specifies whether the table has banded columns.| +||[styleBandedRows](/.table#word-javascript/api/word/-table-stylebandedrows-member)|Specifies whether the table has banded rows.| +||[styleBuiltIn](/.table#word-javascript/api/word/-table-stylebuiltin-member)|Specifies the built-in style name for the table.| +||[styleFirstColumn](/.table#word-javascript/api/word/-table-stylefirstcolumn-member)|Specifies whether the table has a first column with a special style.| +||[styleLastColumn](/.table#word-javascript/api/word/-table-stylelastcolumn-member)|Specifies whether the table has a last column with a special style.| +||[styleTotalRow](/.table#word-javascript/api/word/-table-styletotalrow-member)|Specifies whether the table has a total (last) row with a special style.| +||[tables](/.table#word-javascript/api/word/-table-tables-member)|Gets the child tables nested one level deeper.| +||[values](/.table#word-javascript/api/word/-table-values-member)|Specifies the text values in the table, as a 2D JavaScript array.| +||[verticalAlignment](/.table#word-javascript/api/word/-table-verticalalignment-member)|Specifies the vertical alignment of every cell in the table.| +||[width](/.table#word-javascript/api/word/-table-width-member)|Specifies the width of the table in points.| +|[TableBorder](/.tableborder)|[color](/.tableborder#word-javascript/api/word/-tableborder-color-member)|Specifies the table border color.| +||[type](/.tableborder#word-javascript/api/word/-tableborder-type-member)|Specifies the type of the table border.| +||[width](/.tableborder#word-javascript/api/word/-tableborder-width-member)|Specifies the width, in points, of the table border.| +|[TableCell](/.tablecell)|[body](/.tablecell#word-javascript/api/word/-tablecell-body-member)|Gets the body object of the cell.| +||[cellIndex](/.tablecell#word-javascript/api/word/-tablecell-cellindex-member)|Gets the index of the cell in its row.| +||[columnWidth](/.tablecell#word-javascript/api/word/-tablecell-columnwidth-member)|Specifies the width of the cell's column in points.| +||[deleteColumn()](/.tablecell#word-javascript/api/word/-tablecell-deletecolumn-member(1))|Deletes the column containing this cell.| +||[deleteRow()](/.tablecell#word-javascript/api/word/-tablecell-deleterow-member(1))|Deletes the row containing this cell.| +||[getBorder(borderLocation: Word.BorderLocation)](/.tablecell#word-javascript/api/word/-tablecell-getborder-member(1))|Gets the border style for the specified border.| +||[getCellPadding(cellPaddingLocation: Word.CellPaddingLocation)](/.tablecell#word-javascript/api/word/-tablecell-getcellpadding-member(1))|Gets cell padding in points.| +||[getNext()](/.tablecell#word-javascript/api/word/-tablecell-getnext-member(1))|Gets the next cell.| +||[getNextOrNullObject()](/.tablecell#word-javascript/api/word/-tablecell-getnextornullobject-member(1))|Gets the next cell.| +||[horizontalAlignment](/.tablecell#word-javascript/api/word/-tablecell-horizontalalignment-member)|Specifies the horizontal alignment of the cell.| +||[insertColumns(insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After", columnCount: number, values?: string[][])](/.tablecell#word-javascript/api/word/-tablecell-insertcolumns-member(1))|Adds columns to the left or right of the cell, using the cell's column as a template.| +||[insertRows(insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After", rowCount: number, values?: string[][])](/.tablecell#word-javascript/api/word/-tablecell-insertrows-member(1))|Inserts rows above or below the cell, using the cell's row as a template.| +||[parentRow](/.tablecell#word-javascript/api/word/-tablecell-parentrow-member)|Gets the parent row of the cell.| +||[parentTable](/.tablecell#word-javascript/api/word/-tablecell-parenttable-member)|Gets the parent table of the cell.| +||[rowIndex](/.tablecell#word-javascript/api/word/-tablecell-rowindex-member)|Gets the index of the cell's row in the table.| +||[setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number)](/.tablecell#word-javascript/api/word/-tablecell-setcellpadding-member(1))|Sets cell padding in points.| +||[shadingColor](/.tablecell#word-javascript/api/word/-tablecell-shadingcolor-member)|Specifies the shading color of the cell.| +||[value](/.tablecell#word-javascript/api/word/-tablecell-value-member)|Specifies the text of the cell.| +||[verticalAlignment](/.tablecell#word-javascript/api/word/-tablecell-verticalalignment-member)|Specifies the vertical alignment of the cell.| +||[width](/.tablecell#word-javascript/api/word/-tablecell-width-member)|Gets the width of the cell in points.| +|[TableCellCollection](/.tablecellcollection)|[getFirst()](/.tablecellcollection#word-javascript/api/word/-tablecellcollection-getfirst-member(1))|Gets the first table cell in this collection.| +||[getFirstOrNullObject()](/.tablecellcollection#word-javascript/api/word/-tablecellcollection-getfirstornullobject-member(1))|Gets the first table cell in this collection.| +||[items](/.tablecellcollection#word-javascript/api/word/-tablecellcollection-items-member)|Gets the loaded child items in this collection.| +|[TableCollection](/.tablecollection)|[getFirst()](/.tablecollection#word-javascript/api/word/-tablecollection-getfirst-member(1))|Gets the first table in this collection.| +||[getFirstOrNullObject()](/.tablecollection#word-javascript/api/word/-tablecollection-getfirstornullobject-member(1))|Gets the first table in this collection.| +||[items](/.tablecollection#word-javascript/api/word/-tablecollection-items-member)|Gets the loaded child items in this collection.| +|[TableRow](/.tablerow)|[cellCount](/.tablerow#word-javascript/api/word/-tablerow-cellcount-member)|Gets the number of cells in the row.| +||[cells](/.tablerow#word-javascript/api/word/-tablerow-cells-member)|Gets cells.| +||[clear()](/.tablerow#word-javascript/api/word/-tablerow-clear-member(1))|Clears the contents of the row.| +||[delete()](/.tablerow#word-javascript/api/word/-tablerow-delete-member(1))|Deletes the entire row.| +||[font](/.tablerow#word-javascript/api/word/-tablerow-font-member)|Gets the font.| +||[getBorder(borderLocation: Word.BorderLocation)](/.tablerow#word-javascript/api/word/-tablerow-getborder-member(1))|Gets the border style of the cells in the row.| +||[getCellPadding(cellPaddingLocation: Word.CellPaddingLocation)](/.tablerow#word-javascript/api/word/-tablerow-getcellpadding-member(1))|Gets cell padding in points.| +||[getNext()](/.tablerow#word-javascript/api/word/-tablerow-getnext-member(1))|Gets the next row.| +||[getNextOrNullObject()](/.tablerow#word-javascript/api/word/-tablerow-getnextornullobject-member(1))|Gets the next row.| +||[horizontalAlignment](/.tablerow#word-javascript/api/word/-tablerow-horizontalalignment-member)|Specifies the horizontal alignment of every cell in the row.| +||[insertRows(insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After", rowCount: number, values?: string[][])](/.tablerow#word-javascript/api/word/-tablerow-insertrows-member(1))|Inserts rows using this row as a template.| +||[isHeader](/.tablerow#word-javascript/api/word/-tablerow-isheader-member)|Checks whether the row is a header row.| +||[parentTable](/.tablerow#word-javascript/api/word/-tablerow-parenttable-member)|Gets parent table.| +||[preferredHeight](/.tablerow#word-javascript/api/word/-tablerow-preferredheight-member)|Specifies the preferred height of the row in points.| +||[rowIndex](/.tablerow#word-javascript/api/word/-tablerow-rowindex-member)|Gets the index of the row in its parent table.| +||[search(searchText: string, searchOptions?: Word.SearchOptions \| { ignorePunct?: boolean ignoreSpace?: boolean matchCase?: boolean matchPrefix?: boolean matchSuffix?: boolean matchWholeWord?: boolean matchWildcards?: boolean })](/.tablerow#word-javascript/api/word/-tablerow-search-member(1))|Performs a search with the specified SearchOptions on the scope of the row.| +||[select(selectionMode?: Word.SelectionMode)](/.tablerow#word-javascript/api/word/-tablerow-select-member(1))|Selects the row and navigates the Word UI to it.| +||[setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number)](/.tablerow#word-javascript/api/word/-tablerow-setcellpadding-member(1))|Sets cell padding in points.| +||[shadingColor](/.tablerow#word-javascript/api/word/-tablerow-shadingcolor-member)|Specifies the shading color.| +||[values](/.tablerow#word-javascript/api/word/-tablerow-values-member)|Specifies the text values in the row, as a 2D JavaScript array.| +||[verticalAlignment](/.tablerow#word-javascript/api/word/-tablerow-verticalalignment-member)|Specifies the vertical alignment of the cells in the row.| +|[TableRowCollection](/.tablerowcollection)|[getFirst()](/.tablerowcollection#word-javascript/api/word/-tablerowcollection-getfirst-member(1))|Gets the first row in this collection.| +||[getFirstOrNullObject()](/.tablerowcollection#word-javascript/api/word/-tablerowcollection-getfirstornullobject-member(1))|Gets the first row in this collection.| +||[items](/.tablerowcollection#word-javascript/api/word/-tablerowcollection-items-member)|Gets the loaded child items in this collection.| diff --git a/docs/includes/word-1_3_hidden_document.md b/docs/includes/word-1_3_hidden_document.md index 640d340516..5340b389bd 100644 --- a/docs/includes/word-1_3_hidden_document.md +++ b/docs/includes/word-1_3_hidden_document.md @@ -1,8 +1,8 @@ | Class | Fields | Description | |:---|:---|:---| -|[DocumentCreated](/javascript/api/word/word.documentcreated)|[body](/javascript/api/word/word.documentcreated#word-word-documentcreated-body-member)|Gets the body object of the document.| -||[contentControls](/javascript/api/word/word.documentcreated#word-word-documentcreated-contentcontrols-member)|Gets the collection of content control objects in the document.| -||[properties](/javascript/api/word/word.documentcreated#word-word-documentcreated-properties-member)|Gets the properties of the document.| -||[save(saveBehavior?: Word.SaveBehavior, fileName?: string)](/javascript/api/word/word.documentcreated#word-word-documentcreated-save-member(1))|Saves the document.| -||[saved](/javascript/api/word/word.documentcreated#word-word-documentcreated-saved-member)|Indicates whether the changes in the document have been saved.| -||[sections](/javascript/api/word/word.documentcreated#word-word-documentcreated-sections-member)|Gets the collection of section objects in the document.| +|[DocumentCreated](/.documentcreated)|[body](/.documentcreated#word-javascript/api/word/-documentcreated-body-member)|Gets the body object of the document.| +||[contentControls](/.documentcreated#word-javascript/api/word/-documentcreated-contentcontrols-member)|Gets the collection of content control objects in the document.| +||[properties](/.documentcreated#word-javascript/api/word/-documentcreated-properties-member)|Gets the properties of the document.| +||[save(saveBehavior?: Word.SaveBehavior, fileName?: string)](/.documentcreated#word-javascript/api/word/-documentcreated-save-member(1))|Saves the document.| +||[saved](/.documentcreated#word-javascript/api/word/-documentcreated-saved-member)|Indicates whether the changes in the document have been saved.| +||[sections](/.documentcreated#word-javascript/api/word/-documentcreated-sections-member)|Gets the collection of section objects in the document.| diff --git a/docs/includes/word-1_4.md b/docs/includes/word-1_4.md index fc65168a22..8c04995ff8 100644 --- a/docs/includes/word-1_4.md +++ b/docs/includes/word-1_4.md @@ -1,108 +1,108 @@ | Class | Fields | Description | |:---|:---|:---| -|[Body](/javascript/api/word/word.body)|[fields](/javascript/api/word/word.body#word-word-body-fields-member)|Gets the collection of field objects in the body.| -||[getComments()](/javascript/api/word/word.body#word-word-body-getcomments-member(1))|Gets comments associated with the body.| -||[getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion)](/javascript/api/word/word.body#word-word-body-getreviewedtext-member(1))|Gets reviewed text based on ChangeTrackingVersion selection.| -|[Comment](/javascript/api/word/word.comment)|[authorEmail](/javascript/api/word/word.comment#word-word-comment-authoremail-member)|Gets the email of the comment's author.| -||[authorName](/javascript/api/word/word.comment#word-word-comment-authorname-member)|Gets the name of the comment's author.| -||[content](/javascript/api/word/word.comment#word-word-comment-content-member)|Specifies the comment's content as plain text.| -||[contentRange](/javascript/api/word/word.comment#word-word-comment-contentrange-member)|Specifies the comment's content range.| -||[creationDate](/javascript/api/word/word.comment#word-word-comment-creationdate-member)|Gets the creation date of the comment.| -||[delete()](/javascript/api/word/word.comment#word-word-comment-delete-member(1))|Deletes the comment and its replies.| -||[getRange()](/javascript/api/word/word.comment#word-word-comment-getrange-member(1))|Gets the range in the main document where the comment is on.| -||[id](/javascript/api/word/word.comment#word-word-comment-id-member)|Gets the ID of the comment.| -||[replies](/javascript/api/word/word.comment#word-word-comment-replies-member)|Gets the collection of reply objects associated with the comment.| -||[reply(replyText: string)](/javascript/api/word/word.comment#word-word-comment-reply-member(1))|Adds a new reply to the end of the comment thread.| -||[resolved](/javascript/api/word/word.comment#word-word-comment-resolved-member)|Specifies the comment thread's status.| -|[CommentCollection](/javascript/api/word/word.commentcollection)|[getFirst()](/javascript/api/word/word.commentcollection#word-word-commentcollection-getfirst-member(1))|Gets the first comment in the collection.| -||[getFirstOrNullObject()](/javascript/api/word/word.commentcollection#word-word-commentcollection-getfirstornullobject-member(1))|Gets the first comment in the collection.| -||[items](/javascript/api/word/word.commentcollection#word-word-commentcollection-items-member)|Gets the loaded child items in this collection.| -|[CommentContentRange](/javascript/api/word/word.commentcontentrange)|[bold](/javascript/api/word/word.commentcontentrange#word-word-commentcontentrange-bold-member)|Specifies a value that indicates whether the comment text is bold.| -||[hyperlink](/javascript/api/word/word.commentcontentrange#word-word-commentcontentrange-hyperlink-member)|Gets the first hyperlink in the range, or sets a hyperlink on the range.| -||[insertText(text: string, insertLocation: Word.InsertLocation \| "Replace" \| "Start" \| "End" \| "Before" \| "After")](/javascript/api/word/word.commentcontentrange#word-word-commentcontentrange-inserttext-member(1))|Inserts text into at the specified location.| -||[isEmpty](/javascript/api/word/word.commentcontentrange#word-word-commentcontentrange-isempty-member)|Checks whether the range length is zero.| -||[italic](/javascript/api/word/word.commentcontentrange#word-word-commentcontentrange-italic-member)|Specifies a value that indicates whether the comment text is italicized.| -||[strikeThrough](/javascript/api/word/word.commentcontentrange#word-word-commentcontentrange-strikethrough-member)|Specifies a value that indicates whether the comment text has a strikethrough.| -||[text](/javascript/api/word/word.commentcontentrange#word-word-commentcontentrange-text-member)|Gets the text of the comment range.| -||[underline](/javascript/api/word/word.commentcontentrange#word-word-commentcontentrange-underline-member)|Specifies a value that indicates the comment text's underline type.| -|[CommentReply](/javascript/api/word/word.commentreply)|[authorEmail](/javascript/api/word/word.commentreply#word-word-commentreply-authoremail-member)|Gets the email of the comment reply's author.| -||[authorName](/javascript/api/word/word.commentreply#word-word-commentreply-authorname-member)|Gets the name of the comment reply's author.| -||[content](/javascript/api/word/word.commentreply#word-word-commentreply-content-member)|Specifies the comment reply's content.| -||[contentRange](/javascript/api/word/word.commentreply#word-word-commentreply-contentrange-member)|Specifies the commentReply's content range.| -||[creationDate](/javascript/api/word/word.commentreply#word-word-commentreply-creationdate-member)|Gets the creation date of the comment reply.| -||[delete()](/javascript/api/word/word.commentreply#word-word-commentreply-delete-member(1))|Deletes the comment reply.| -||[id](/javascript/api/word/word.commentreply#word-word-commentreply-id-member)|Gets the ID of the comment reply.| -||[parentComment](/javascript/api/word/word.commentreply#word-word-commentreply-parentcomment-member)|Gets the parent comment of this reply.| -|[CommentReplyCollection](/javascript/api/word/word.commentreplycollection)|[getFirst()](/javascript/api/word/word.commentreplycollection#word-word-commentreplycollection-getfirst-member(1))|Gets the first comment reply in the collection.| -||[getFirstOrNullObject()](/javascript/api/word/word.commentreplycollection#word-word-commentreplycollection-getfirstornullobject-member(1))|Gets the first comment reply in the collection.| -||[items](/javascript/api/word/word.commentreplycollection#word-word-commentreplycollection-items-member)|Gets the loaded child items in this collection.| -|[ContentControl](/javascript/api/word/word.contentcontrol)|[fields](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-fields-member)|Gets the collection of field objects in the content control.| -||[getComments()](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-getcomments-member(1))|Gets comments associated with the content control.| -||[getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion)](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-getreviewedtext-member(1))|Gets reviewed text based on ChangeTrackingVersion selection.| -|[CustomXmlPart](/javascript/api/word/word.customxmlpart)|[delete()](/javascript/api/word/word.customxmlpart#word-word-customxmlpart-delete-member(1))|Deletes the custom XML part.| -||[deleteAttribute(xpath: string, namespaceMappings: { [key: string]: string }, name: string)](/javascript/api/word/word.customxmlpart#word-word-customxmlpart-deleteattribute-member(1))|Deletes an attribute with the given name from the element identified by xpath.| -||[deleteElement(xpath: string, namespaceMappings: { [key: string]: string })](/javascript/api/word/word.customxmlpart#word-word-customxmlpart-deleteelement-member(1))|Deletes the element identified by xpath.| -||[getXml()](/javascript/api/word/word.customxmlpart#word-word-customxmlpart-getxml-member(1))|Gets the full XML content of the custom XML part.| -||[id](/javascript/api/word/word.customxmlpart#word-word-customxmlpart-id-member)|Gets the ID of the custom XML part.| -||[insertAttribute(xpath: string, namespaceMappings: { [key: string]: string }, name: string, value: string)](/javascript/api/word/word.customxmlpart#word-word-customxmlpart-insertattribute-member(1))|Inserts an attribute with the given name and value to the element identified by xpath.| -||[insertElement(xpath: string, xml: string, namespaceMappings: { [key: string]: string }, index?: number)](/javascript/api/word/word.customxmlpart#word-word-customxmlpart-insertelement-member(1))|Inserts the given XML under the parent element identified by xpath at child position index.| -||[namespaceUri](/javascript/api/word/word.customxmlpart#word-word-customxmlpart-namespaceuri-member)|Gets the namespace URI of the custom XML part.| -||[query(xpath: string, namespaceMappings: { [key: string]: string })](/javascript/api/word/word.customxmlpart#word-word-customxmlpart-query-member(1))|Queries the XML content of the custom XML part.| -||[setXml(xml: string)](/javascript/api/word/word.customxmlpart#word-word-customxmlpart-setxml-member(1))|Sets the full XML content of the custom XML part.| -||[updateAttribute(xpath: string, namespaceMappings: { [key: string]: string }, name: string, value: string)](/javascript/api/word/word.customxmlpart#word-word-customxmlpart-updateattribute-member(1))|Updates the value of an attribute with the given name of the element identified by xpath.| -||[updateElement(xpath: string, xml: string, namespaceMappings: { [key: string]: string })](/javascript/api/word/word.customxmlpart#word-word-customxmlpart-updateelement-member(1))|Updates the XML of the element identified by xpath.| -|[CustomXmlPartCollection](/javascript/api/word/word.customxmlpartcollection)|[add(xml: string)](/javascript/api/word/word.customxmlpartcollection#word-word-customxmlpartcollection-add-member(1))|Adds a new custom XML part to the document.| -||[getByNamespace(namespaceUri: string)](/javascript/api/word/word.customxmlpartcollection#word-word-customxmlpartcollection-getbynamespace-member(1))|Gets a new scoped collection of custom XML parts whose namespaces match the given namespace.| -||[getCount()](/javascript/api/word/word.customxmlpartcollection#word-word-customxmlpartcollection-getcount-member(1))|Gets the number of items in the collection.| -||[getItem(id: string)](/javascript/api/word/word.customxmlpartcollection#word-word-customxmlpartcollection-getitem-member(1))|Gets a custom XML part based on its ID.| -||[getItemOrNullObject(id: string)](/javascript/api/word/word.customxmlpartcollection#word-word-customxmlpartcollection-getitemornullobject-member(1))|Gets a custom XML part based on its ID.| -||[items](/javascript/api/word/word.customxmlpartcollection#word-word-customxmlpartcollection-items-member)|Gets the loaded child items in this collection.| -|[CustomXmlPartScopedCollection](/javascript/api/word/word.customxmlpartscopedcollection)|[getCount()](/javascript/api/word/word.customxmlpartscopedcollection#word-word-customxmlpartscopedcollection-getcount-member(1))|Gets the number of items in the collection.| -||[getItem(id: string)](/javascript/api/word/word.customxmlpartscopedcollection#word-word-customxmlpartscopedcollection-getitem-member(1))|Gets a custom XML part based on its ID.| -||[getItemOrNullObject(id: string)](/javascript/api/word/word.customxmlpartscopedcollection#word-word-customxmlpartscopedcollection-getitemornullobject-member(1))|Gets a custom XML part based on its ID.| -||[getOnlyItem()](/javascript/api/word/word.customxmlpartscopedcollection#word-word-customxmlpartscopedcollection-getonlyitem-member(1))|If the collection contains exactly one item, this method returns it.| -||[getOnlyItemOrNullObject()](/javascript/api/word/word.customxmlpartscopedcollection#word-word-customxmlpartscopedcollection-getonlyitemornullobject-member(1))|If the collection contains exactly one item, this method returns it.| -||[items](/javascript/api/word/word.customxmlpartscopedcollection#word-word-customxmlpartscopedcollection-items-member)|Gets the loaded child items in this collection.| -|[Document](/javascript/api/word/word.document)|[changeTrackingMode](/javascript/api/word/word.document#word-word-document-changetrackingmode-member)|Specifies the ChangeTracking mode.| -||[customXmlParts](/javascript/api/word/word.document#word-word-document-customxmlparts-member)|Gets the custom XML parts in the document.| -||[deleteBookmark(name: string)](/javascript/api/word/word.document#word-word-document-deletebookmark-member(1))|Deletes a bookmark, if it exists, from the document.| -||[getBookmarkRange(name: string)](/javascript/api/word/word.document#word-word-document-getbookmarkrange-member(1))|Gets a bookmark's range.| -||[getBookmarkRangeOrNullObject(name: string)](/javascript/api/word/word.document#word-word-document-getbookmarkrangeornullobject-member(1))|Gets a bookmark's range.| -||[settings](/javascript/api/word/word.document#word-word-document-settings-member)|Gets the add-in's settings in the document.| -|[Field](/javascript/api/word/word.field)|[code](/javascript/api/word/word.field#word-word-field-code-member)|Specifies the field's code instruction.| -||[getNext()](/javascript/api/word/word.field#word-word-field-getnext-member(1))|Gets the next field.| -||[getNextOrNullObject()](/javascript/api/word/word.field#word-word-field-getnextornullobject-member(1))|Gets the next field.| -||[parentBody](/javascript/api/word/word.field#word-word-field-parentbody-member)|Gets the parent body of the field.| -||[parentContentControl](/javascript/api/word/word.field#word-word-field-parentcontentcontrol-member)|Gets the content control that contains the field.| -||[parentContentControlOrNullObject](/javascript/api/word/word.field#word-word-field-parentcontentcontrolornullobject-member)|Gets the content control that contains the field.| -||[parentTable](/javascript/api/word/word.field#word-word-field-parenttable-member)|Gets the table that contains the field.| -||[parentTableCell](/javascript/api/word/word.field#word-word-field-parenttablecell-member)|Gets the table cell that contains the field.| -||[parentTableCellOrNullObject](/javascript/api/word/word.field#word-word-field-parenttablecellornullobject-member)|Gets the table cell that contains the field.| -||[parentTableOrNullObject](/javascript/api/word/word.field#word-word-field-parenttableornullobject-member)|Gets the table that contains the field.| -||[result](/javascript/api/word/word.field#word-word-field-result-member)|Gets the field's result data.| -|[FieldCollection](/javascript/api/word/word.fieldcollection)|[getFirst()](/javascript/api/word/word.fieldcollection#word-word-fieldcollection-getfirst-member(1))|Gets the first field in this collection.| -||[getFirstOrNullObject()](/javascript/api/word/word.fieldcollection#word-word-fieldcollection-getfirstornullobject-member(1))|Gets the first field in this collection.| -||[items](/javascript/api/word/word.fieldcollection#word-word-fieldcollection-items-member)|Gets the loaded child items in this collection.| -|[Paragraph](/javascript/api/word/word.paragraph)|[fields](/javascript/api/word/word.paragraph#word-word-paragraph-fields-member)|Gets the collection of fields in the paragraph.| -||[getComments()](/javascript/api/word/word.paragraph#word-word-paragraph-getcomments-member(1))|Gets comments associated with the paragraph.| -||[getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion)](/javascript/api/word/word.paragraph#word-word-paragraph-getreviewedtext-member(1))|Gets reviewed text based on ChangeTrackingVersion selection.| -|[Range](/javascript/api/word/word.range)|[fields](/javascript/api/word/word.range#word-word-range-fields-member)|Gets the collection of field objects in the range.| -||[getBookmarks(includeHidden?: boolean, includeAdjacent?: boolean)](/javascript/api/word/word.range#word-word-range-getbookmarks-member(1))|Gets the names all bookmarks in or overlapping the range.| -||[getComments()](/javascript/api/word/word.range#word-word-range-getcomments-member(1))|Gets comments associated with the range.| -||[getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion)](/javascript/api/word/word.range#word-word-range-getreviewedtext-member(1))|Gets reviewed text based on ChangeTrackingVersion selection.| -||[insertBookmark(name: string)](/javascript/api/word/word.range#word-word-range-insertbookmark-member(1))|Inserts a bookmark on the range.| -||[insertComment(commentText: string)](/javascript/api/word/word.range#word-word-range-insertcomment-member(1))|Insert a comment on the range.| -|[Setting](/javascript/api/word/word.setting)|[delete()](/javascript/api/word/word.setting#word-word-setting-delete-member(1))|Deletes the setting.| -||[key](/javascript/api/word/word.setting#word-word-setting-key-member)|Gets the key of the setting.| -||[value](/javascript/api/word/word.setting#word-word-setting-value-member)|Specifies the value of the setting.| -|[SettingCollection](/javascript/api/word/word.settingcollection)|[add(key: string, value: any)](/javascript/api/word/word.settingcollection#word-word-settingcollection-add-member(1))|Creates a new setting or sets an existing setting.| -||[deleteAll()](/javascript/api/word/word.settingcollection#word-word-settingcollection-deleteall-member(1))|Deletes all settings in this add-in.| -||[getCount()](/javascript/api/word/word.settingcollection#word-word-settingcollection-getcount-member(1))|Gets the count of settings.| -||[getItem(key: string)](/javascript/api/word/word.settingcollection#word-word-settingcollection-getitem-member(1))|Gets a setting object by its key, which is case-sensitive.| -||[getItemOrNullObject(key: string)](/javascript/api/word/word.settingcollection#word-word-settingcollection-getitemornullobject-member(1))|Gets a setting object by its key, which is case-sensitive.| -||[items](/javascript/api/word/word.settingcollection#word-word-settingcollection-items-member)|Gets the loaded child items in this collection.| -|[Table](/javascript/api/word/word.table)|[fields](/javascript/api/word/word.table#word-word-table-fields-member)|Gets the collection of field objects in the table.| -||[mergeCells(topRow: number, firstCell: number, bottomRow: number, lastCell: number)](/javascript/api/word/word.table#word-word-table-mergecells-member(1))|Merges the cells bounded inclusively by a first and last cell.| -|[TableCell](/javascript/api/word/word.tablecell)|[split(rowCount: number, columnCount: number)](/javascript/api/word/word.tablecell#word-word-tablecell-split-member(1))|Splits the cell into the specified number of rows and columns.| -|[TableRow](/javascript/api/word/word.tablerow)|[fields](/javascript/api/word/word.tablerow#word-word-tablerow-fields-member)|Gets the collection of field objects in the table row.| -||[merge()](/javascript/api/word/word.tablerow#word-word-tablerow-merge-member(1))|Merges the row into one cell.| +|[Body](/.body)|[fields](/.body#word-javascript/api/word/-body-fields-member)|Gets the collection of field objects in the body.| +||[getComments()](/.body#word-javascript/api/word/-body-getcomments-member(1))|Gets comments associated with the body.| +||[getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion)](/.body#word-javascript/api/word/-body-getreviewedtext-member(1))|Gets reviewed text based on ChangeTrackingVersion selection.| +|[Comment](/.comment)|[authorEmail](/.comment#word-javascript/api/word/-comment-authoremail-member)|Gets the email of the comment's author.| +||[authorName](/.comment#word-javascript/api/word/-comment-authorname-member)|Gets the name of the comment's author.| +||[content](/.comment#word-javascript/api/word/-comment-content-member)|Specifies the comment's content as plain text.| +||[contentRange](/.comment#word-javascript/api/word/-comment-contentrange-member)|Specifies the comment's content range.| +||[creationDate](/.comment#word-javascript/api/word/-comment-creationdate-member)|Gets the creation date of the comment.| +||[delete()](/.comment#word-javascript/api/word/-comment-delete-member(1))|Deletes the comment and its replies.| +||[getRange()](/.comment#word-javascript/api/word/-comment-getrange-member(1))|Gets the range in the main document where the comment is on.| +||[id](/.comment#word-javascript/api/word/-comment-id-member)|Gets the ID of the comment.| +||[replies](/.comment#word-javascript/api/word/-comment-replies-member)|Gets the collection of reply objects associated with the comment.| +||[reply(replyText: string)](/.comment#word-javascript/api/word/-comment-reply-member(1))|Adds a new reply to the end of the comment thread.| +||[resolved](/.comment#word-javascript/api/word/-comment-resolved-member)|Specifies the comment thread's status.| +|[CommentCollection](/.commentcollection)|[getFirst()](/.commentcollection#word-javascript/api/word/-commentcollection-getfirst-member(1))|Gets the first comment in the collection.| +||[getFirstOrNullObject()](/.commentcollection#word-javascript/api/word/-commentcollection-getfirstornullobject-member(1))|Gets the first comment in the collection.| +||[items](/.commentcollection#word-javascript/api/word/-commentcollection-items-member)|Gets the loaded child items in this collection.| +|[CommentContentRange](/.commentcontentrange)|[bold](/.commentcontentrange#word-javascript/api/word/-commentcontentrange-bold-member)|Specifies a value that indicates whether the comment text is bold.| +||[hyperlink](/.commentcontentrange#word-javascript/api/word/-commentcontentrange-hyperlink-member)|Gets the first hyperlink in the range, or sets a hyperlink on the range.| +||[insertText(text: string, insertLocation: Word.InsertLocation \| "Replace" \| "Start" \| "End" \| "Before" \| "After")](/.commentcontentrange#word-javascript/api/word/-commentcontentrange-inserttext-member(1))|Inserts text into at the specified location.| +||[isEmpty](/.commentcontentrange#word-javascript/api/word/-commentcontentrange-isempty-member)|Checks whether the range length is zero.| +||[italic](/.commentcontentrange#word-javascript/api/word/-commentcontentrange-italic-member)|Specifies a value that indicates whether the comment text is italicized.| +||[strikeThrough](/.commentcontentrange#word-javascript/api/word/-commentcontentrange-strikethrough-member)|Specifies a value that indicates whether the comment text has a strikethrough.| +||[text](/.commentcontentrange#word-javascript/api/word/-commentcontentrange-text-member)|Gets the text of the comment range.| +||[underline](/.commentcontentrange#word-javascript/api/word/-commentcontentrange-underline-member)|Specifies a value that indicates the comment text's underline type.| +|[CommentReply](/.commentreply)|[authorEmail](/.commentreply#word-javascript/api/word/-commentreply-authoremail-member)|Gets the email of the comment reply's author.| +||[authorName](/.commentreply#word-javascript/api/word/-commentreply-authorname-member)|Gets the name of the comment reply's author.| +||[content](/.commentreply#word-javascript/api/word/-commentreply-content-member)|Specifies the comment reply's content.| +||[contentRange](/.commentreply#word-javascript/api/word/-commentreply-contentrange-member)|Specifies the commentReply's content range.| +||[creationDate](/.commentreply#word-javascript/api/word/-commentreply-creationdate-member)|Gets the creation date of the comment reply.| +||[delete()](/.commentreply#word-javascript/api/word/-commentreply-delete-member(1))|Deletes the comment reply.| +||[id](/.commentreply#word-javascript/api/word/-commentreply-id-member)|Gets the ID of the comment reply.| +||[parentComment](/.commentreply#word-javascript/api/word/-commentreply-parentcomment-member)|Gets the parent comment of this reply.| +|[CommentReplyCollection](/.commentreplycollection)|[getFirst()](/.commentreplycollection#word-javascript/api/word/-commentreplycollection-getfirst-member(1))|Gets the first comment reply in the collection.| +||[getFirstOrNullObject()](/.commentreplycollection#word-javascript/api/word/-commentreplycollection-getfirstornullobject-member(1))|Gets the first comment reply in the collection.| +||[items](/.commentreplycollection#word-javascript/api/word/-commentreplycollection-items-member)|Gets the loaded child items in this collection.| +|[ContentControl](/.contentcontrol)|[fields](/.contentcontrol#word-javascript/api/word/-contentcontrol-fields-member)|Gets the collection of field objects in the content control.| +||[getComments()](/.contentcontrol#word-javascript/api/word/-contentcontrol-getcomments-member(1))|Gets comments associated with the content control.| +||[getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion)](/.contentcontrol#word-javascript/api/word/-contentcontrol-getreviewedtext-member(1))|Gets reviewed text based on ChangeTrackingVersion selection.| +|[CustomXmlPart](/.customxmlpart)|[delete()](/.customxmlpart#word-javascript/api/word/-customxmlpart-delete-member(1))|Deletes the custom XML part.| +||[deleteAttribute(xpath: string, namespaceMappings: { [key: string]: string }, name: string)](/.customxmlpart#word-javascript/api/word/-customxmlpart-deleteattribute-member(1))|Deletes an attribute with the given name from the element identified by xpath.| +||[deleteElement(xpath: string, namespaceMappings: { [key: string]: string })](/.customxmlpart#word-javascript/api/word/-customxmlpart-deleteelement-member(1))|Deletes the element identified by xpath.| +||[getXml()](/.customxmlpart#word-javascript/api/word/-customxmlpart-getxml-member(1))|Gets the full XML content of the custom XML part.| +||[id](/.customxmlpart#word-javascript/api/word/-customxmlpart-id-member)|Gets the ID of the custom XML part.| +||[insertAttribute(xpath: string, namespaceMappings: { [key: string]: string }, name: string, value: string)](/.customxmlpart#word-javascript/api/word/-customxmlpart-insertattribute-member(1))|Inserts an attribute with the given name and value to the element identified by xpath.| +||[insertElement(xpath: string, xml: string, namespaceMappings: { [key: string]: string }, index?: number)](/.customxmlpart#word-javascript/api/word/-customxmlpart-insertelement-member(1))|Inserts the given XML under the parent element identified by xpath at child position index.| +||[namespaceUri](/.customxmlpart#word-javascript/api/word/-customxmlpart-namespaceuri-member)|Gets the namespace URI of the custom XML part.| +||[query(xpath: string, namespaceMappings: { [key: string]: string })](/.customxmlpart#word-javascript/api/word/-customxmlpart-query-member(1))|Queries the XML content of the custom XML part.| +||[setXml(xml: string)](/.customxmlpart#word-javascript/api/word/-customxmlpart-setxml-member(1))|Sets the full XML content of the custom XML part.| +||[updateAttribute(xpath: string, namespaceMappings: { [key: string]: string }, name: string, value: string)](/.customxmlpart#word-javascript/api/word/-customxmlpart-updateattribute-member(1))|Updates the value of an attribute with the given name of the element identified by xpath.| +||[updateElement(xpath: string, xml: string, namespaceMappings: { [key: string]: string })](/.customxmlpart#word-javascript/api/word/-customxmlpart-updateelement-member(1))|Updates the XML of the element identified by xpath.| +|[CustomXmlPartCollection](/.customxmlpartcollection)|[add(xml: string)](/.customxmlpartcollection#word-javascript/api/word/-customxmlpartcollection-add-member(1))|Adds a new custom XML part to the document.| +||[getByNamespace(namespaceUri: string)](/.customxmlpartcollection#word-javascript/api/word/-customxmlpartcollection-getbynamespace-member(1))|Gets a new scoped collection of custom XML parts whose namespaces match the given namespace.| +||[getCount()](/.customxmlpartcollection#word-javascript/api/word/-customxmlpartcollection-getcount-member(1))|Gets the number of items in the collection.| +||[getItem(id: string)](/.customxmlpartcollection#word-javascript/api/word/-customxmlpartcollection-getitem-member(1))|Gets a custom XML part based on its ID.| +||[getItemOrNullObject(id: string)](/.customxmlpartcollection#word-javascript/api/word/-customxmlpartcollection-getitemornullobject-member(1))|Gets a custom XML part based on its ID.| +||[items](/.customxmlpartcollection#word-javascript/api/word/-customxmlpartcollection-items-member)|Gets the loaded child items in this collection.| +|[CustomXmlPartScopedCollection](/.customxmlpartscopedcollection)|[getCount()](/.customxmlpartscopedcollection#word-javascript/api/word/-customxmlpartscopedcollection-getcount-member(1))|Gets the number of items in the collection.| +||[getItem(id: string)](/.customxmlpartscopedcollection#word-javascript/api/word/-customxmlpartscopedcollection-getitem-member(1))|Gets a custom XML part based on its ID.| +||[getItemOrNullObject(id: string)](/.customxmlpartscopedcollection#word-javascript/api/word/-customxmlpartscopedcollection-getitemornullobject-member(1))|Gets a custom XML part based on its ID.| +||[getOnlyItem()](/.customxmlpartscopedcollection#word-javascript/api/word/-customxmlpartscopedcollection-getonlyitem-member(1))|If the collection contains exactly one item, this method returns it.| +||[getOnlyItemOrNullObject()](/.customxmlpartscopedcollection#word-javascript/api/word/-customxmlpartscopedcollection-getonlyitemornullobject-member(1))|If the collection contains exactly one item, this method returns it.| +||[items](/.customxmlpartscopedcollection#word-javascript/api/word/-customxmlpartscopedcollection-items-member)|Gets the loaded child items in this collection.| +|[Document](/.document)|[changeTrackingMode](/.document#word-javascript/api/word/-document-changetrackingmode-member)|Specifies the ChangeTracking mode.| +||[customXmlParts](/.document#word-javascript/api/word/-document-customxmlparts-member)|Gets the custom XML parts in the document.| +||[deleteBookmark(name: string)](/.document#word-javascript/api/word/-document-deletebookmark-member(1))|Deletes a bookmark, if it exists, from the document.| +||[getBookmarkRange(name: string)](/.document#word-javascript/api/word/-document-getbookmarkrange-member(1))|Gets a bookmark's range.| +||[getBookmarkRangeOrNullObject(name: string)](/.document#word-javascript/api/word/-document-getbookmarkrangeornullobject-member(1))|Gets a bookmark's range.| +||[settings](/.document#word-javascript/api/word/-document-settings-member)|Gets the add-in's settings in the document.| +|[Field](/.field)|[code](/.field#word-javascript/api/word/-field-code-member)|Specifies the field's code instruction.| +||[getNext()](/.field#word-javascript/api/word/-field-getnext-member(1))|Gets the next field.| +||[getNextOrNullObject()](/.field#word-javascript/api/word/-field-getnextornullobject-member(1))|Gets the next field.| +||[parentBody](/.field#word-javascript/api/word/-field-parentbody-member)|Gets the parent body of the field.| +||[parentContentControl](/.field#word-javascript/api/word/-field-parentcontentcontrol-member)|Gets the content control that contains the field.| +||[parentContentControlOrNullObject](/.field#word-javascript/api/word/-field-parentcontentcontrolornullobject-member)|Gets the content control that contains the field.| +||[parentTable](/.field#word-javascript/api/word/-field-parenttable-member)|Gets the table that contains the field.| +||[parentTableCell](/.field#word-javascript/api/word/-field-parenttablecell-member)|Gets the table cell that contains the field.| +||[parentTableCellOrNullObject](/.field#word-javascript/api/word/-field-parenttablecellornullobject-member)|Gets the table cell that contains the field.| +||[parentTableOrNullObject](/.field#word-javascript/api/word/-field-parenttableornullobject-member)|Gets the table that contains the field.| +||[result](/.field#word-javascript/api/word/-field-result-member)|Gets the field's result data.| +|[FieldCollection](/.fieldcollection)|[getFirst()](/.fieldcollection#word-javascript/api/word/-fieldcollection-getfirst-member(1))|Gets the first field in this collection.| +||[getFirstOrNullObject()](/.fieldcollection#word-javascript/api/word/-fieldcollection-getfirstornullobject-member(1))|Gets the first field in this collection.| +||[items](/.fieldcollection#word-javascript/api/word/-fieldcollection-items-member)|Gets the loaded child items in this collection.| +|[Paragraph](/.paragraph)|[fields](/.paragraph#word-javascript/api/word/-paragraph-fields-member)|Gets the collection of fields in the paragraph.| +||[getComments()](/.paragraph#word-javascript/api/word/-paragraph-getcomments-member(1))|Gets comments associated with the paragraph.| +||[getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion)](/.paragraph#word-javascript/api/word/-paragraph-getreviewedtext-member(1))|Gets reviewed text based on ChangeTrackingVersion selection.| +|[Range](/.range)|[fields](/.range#word-javascript/api/word/-range-fields-member)|Gets the collection of field objects in the range.| +||[getBookmarks(includeHidden?: boolean, includeAdjacent?: boolean)](/.range#word-javascript/api/word/-range-getbookmarks-member(1))|Gets the names all bookmarks in or overlapping the range.| +||[getComments()](/.range#word-javascript/api/word/-range-getcomments-member(1))|Gets comments associated with the range.| +||[getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion)](/.range#word-javascript/api/word/-range-getreviewedtext-member(1))|Gets reviewed text based on ChangeTrackingVersion selection.| +||[insertBookmark(name: string)](/.range#word-javascript/api/word/-range-insertbookmark-member(1))|Inserts a bookmark on the range.| +||[insertComment(commentText: string)](/.range#word-javascript/api/word/-range-insertcomment-member(1))|Insert a comment on the range.| +|[Setting](/.setting)|[delete()](/.setting#word-javascript/api/word/-setting-delete-member(1))|Deletes the setting.| +||[key](/.setting#word-javascript/api/word/-setting-key-member)|Gets the key of the setting.| +||[value](/.setting#word-javascript/api/word/-setting-value-member)|Specifies the value of the setting.| +|[SettingCollection](/.settingcollection)|[add(key: string, value: any)](/.settingcollection#word-javascript/api/word/-settingcollection-add-member(1))|Creates a new setting or sets an existing setting.| +||[deleteAll()](/.settingcollection#word-javascript/api/word/-settingcollection-deleteall-member(1))|Deletes all settings in this add-in.| +||[getCount()](/.settingcollection#word-javascript/api/word/-settingcollection-getcount-member(1))|Gets the count of settings.| +||[getItem(key: string)](/.settingcollection#word-javascript/api/word/-settingcollection-getitem-member(1))|Gets a setting object by its key, which is case-sensitive.| +||[getItemOrNullObject(key: string)](/.settingcollection#word-javascript/api/word/-settingcollection-getitemornullobject-member(1))|Gets a setting object by its key, which is case-sensitive.| +||[items](/.settingcollection#word-javascript/api/word/-settingcollection-items-member)|Gets the loaded child items in this collection.| +|[Table](/.table)|[fields](/.table#word-javascript/api/word/-table-fields-member)|Gets the collection of field objects in the table.| +||[mergeCells(topRow: number, firstCell: number, bottomRow: number, lastCell: number)](/.table#word-javascript/api/word/-table-mergecells-member(1))|Merges the cells bounded inclusively by a first and last cell.| +|[TableCell](/.tablecell)|[split(rowCount: number, columnCount: number)](/.tablecell#word-javascript/api/word/-tablecell-split-member(1))|Splits the cell into the specified number of rows and columns.| +|[TableRow](/.tablerow)|[fields](/.tablerow#word-javascript/api/word/-tablerow-fields-member)|Gets the collection of field objects in the table row.| +||[merge()](/.tablerow#word-javascript/api/word/-tablerow-merge-member(1))|Merges the row into one cell.| diff --git a/docs/includes/word-1_4_hidden_document.md b/docs/includes/word-1_4_hidden_document.md index 484d3a55bc..60e5445606 100644 --- a/docs/includes/word-1_4_hidden_document.md +++ b/docs/includes/word-1_4_hidden_document.md @@ -1,7 +1,7 @@ | Class | Fields | Description | |:---|:---|:---| -|[DocumentCreated](/javascript/api/word/word.documentcreated)|[customXmlParts](/javascript/api/word/word.documentcreated#word-word-documentcreated-customxmlparts-member)|Gets the custom XML parts in the document.| -||[deleteBookmark(name: string)](/javascript/api/word/word.documentcreated#word-word-documentcreated-deletebookmark-member(1))|Deletes a bookmark, if it exists, from the document.| -||[getBookmarkRange(name: string)](/javascript/api/word/word.documentcreated#word-word-documentcreated-getbookmarkrange-member(1))|Gets a bookmark's range.| -||[getBookmarkRangeOrNullObject(name: string)](/javascript/api/word/word.documentcreated#word-word-documentcreated-getbookmarkrangeornullobject-member(1))|Gets a bookmark's range.| -||[settings](/javascript/api/word/word.documentcreated#word-word-documentcreated-settings-member)|Gets the add-in's settings in the document.| +|[DocumentCreated](/.documentcreated)|[customXmlParts](/.documentcreated#word-javascript/api/word/-documentcreated-customxmlparts-member)|Gets the custom XML parts in the document.| +||[deleteBookmark(name: string)](/.documentcreated#word-javascript/api/word/-documentcreated-deletebookmark-member(1))|Deletes a bookmark, if it exists, from the document.| +||[getBookmarkRange(name: string)](/.documentcreated#word-javascript/api/word/-documentcreated-getbookmarkrange-member(1))|Gets a bookmark's range.| +||[getBookmarkRangeOrNullObject(name: string)](/.documentcreated#word-javascript/api/word/-documentcreated-getbookmarkrangeornullobject-member(1))|Gets a bookmark's range.| +||[settings](/.documentcreated#word-javascript/api/word/-documentcreated-settings-member)|Gets the add-in's settings in the document.| diff --git a/docs/includes/word-1_5.md b/docs/includes/word-1_5.md index 84fa765f4c..7419fc741b 100644 --- a/docs/includes/word-1_5.md +++ b/docs/includes/word-1_5.md @@ -1,110 +1,110 @@ | Class | Fields | Description | |:---|:---|:---| -|[Application](/javascript/api/word/word.application)|[retrieveStylesFromBase64(base64File: string)](/javascript/api/word/word.application#word-word-application-retrievestylesfrombase64-member(1))|Parse styles from template Base64 file and return JSON format of retrieved styles as a string.| -|[Body](/javascript/api/word/word.body)|[endnotes](/javascript/api/word/word.body#word-word-body-endnotes-member)|Gets the collection of endnotes in the body.| -||[footnotes](/javascript/api/word/word.body#word-word-body-footnotes-member)|Gets the collection of footnotes in the body.| -||[getContentControls(options?: Word.ContentControlOptions)](/javascript/api/word/word.body#word-word-body-getcontentcontrols-member(1))|Gets the currently supported content controls in the body.| -|[ContentControl](/javascript/api/word/word.contentcontrol)|[endnotes](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-endnotes-member)|Gets the collection of endnotes in the content control.| -||[footnotes](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-footnotes-member)|Gets the collection of footnotes in the content control.| -||[getContentControls(options?: Word.ContentControlOptions)](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-getcontentcontrols-member(1))|Gets the currently supported child content controls in this content control.| -||[onDataChanged](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-ondatachanged-member)|Occurs when data within the content control are changed.| -||[onDeleted](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-ondeleted-member)|Occurs when the content control is deleted.| -||[onEntered](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-onentered-member)|Occurs when the content control is entered.| -||[onExited](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-onexited-member)|Occurs when the content control is exited, for example, when the cursor leaves the content control.| -||[onSelectionChanged](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-onselectionchanged-member)|Occurs when selection within the content control is changed.| -|[ContentControlAddedEventArgs](/javascript/api/word/word.contentcontroladdedeventargs)|[eventType](/javascript/api/word/word.contentcontroladdedeventargs#word-word-contentcontroladdedeventargs-eventtype-member)|The event type.| -||[ids](/javascript/api/word/word.contentcontroladdedeventargs#word-word-contentcontroladdedeventargs-ids-member)|Gets the content control IDs.| -||[source](/javascript/api/word/word.contentcontroladdedeventargs#word-word-contentcontroladdedeventargs-source-member)|The source of the event.| -|[ContentControlCollection](/javascript/api/word/word.contentcontrolcollection)|[getByChangeTrackingStates(changeTrackingStates: Word.ChangeTrackingState[])](/javascript/api/word/word.contentcontrolcollection#word-word-contentcontrolcollection-getbychangetrackingstates-member(1))|Gets the content controls that have the specified tracking state.| -|[ContentControlDataChangedEventArgs](/javascript/api/word/word.contentcontroldatachangedeventargs)|[eventType](/javascript/api/word/word.contentcontroldatachangedeventargs#word-word-contentcontroldatachangedeventargs-eventtype-member)|The event type.| -||[ids](/javascript/api/word/word.contentcontroldatachangedeventargs#word-word-contentcontroldatachangedeventargs-ids-member)|Gets the content control IDs.| -||[source](/javascript/api/word/word.contentcontroldatachangedeventargs#word-word-contentcontroldatachangedeventargs-source-member)|The source of the event.| -|[ContentControlDeletedEventArgs](/javascript/api/word/word.contentcontroldeletedeventargs)|[eventType](/javascript/api/word/word.contentcontroldeletedeventargs#word-word-contentcontroldeletedeventargs-eventtype-member)|The event type.| -||[ids](/javascript/api/word/word.contentcontroldeletedeventargs#word-word-contentcontroldeletedeventargs-ids-member)|Gets the content control IDs.| -||[source](/javascript/api/word/word.contentcontroldeletedeventargs#word-word-contentcontroldeletedeventargs-source-member)|The source of the event.| -|[ContentControlEnteredEventArgs](/javascript/api/word/word.contentcontrolenteredeventargs)|[eventType](/javascript/api/word/word.contentcontrolenteredeventargs#word-word-contentcontrolenteredeventargs-eventtype-member)|The event type.| -||[ids](/javascript/api/word/word.contentcontrolenteredeventargs#word-word-contentcontrolenteredeventargs-ids-member)|Gets the content control IDs.| -||[source](/javascript/api/word/word.contentcontrolenteredeventargs#word-word-contentcontrolenteredeventargs-source-member)|The source of the event.| -|[ContentControlExitedEventArgs](/javascript/api/word/word.contentcontrolexitedeventargs)|[eventType](/javascript/api/word/word.contentcontrolexitedeventargs#word-word-contentcontrolexitedeventargs-eventtype-member)|The event type.| -||[ids](/javascript/api/word/word.contentcontrolexitedeventargs#word-word-contentcontrolexitedeventargs-ids-member)|Gets the content control IDs.| -||[source](/javascript/api/word/word.contentcontrolexitedeventargs#word-word-contentcontrolexitedeventargs-source-member)|The source of the event.| -|[ContentControlOptions](/javascript/api/word/word.contentcontroloptions)|[types](/javascript/api/word/word.contentcontroloptions#word-word-contentcontroloptions-types-member)|An array of content control types, item must be 'RichText', 'PlainText', 'CheckBox', 'DropDownList', or 'ComboBox'.| -|[ContentControlSelectionChangedEventArgs](/javascript/api/word/word.contentcontrolselectionchangedeventargs)|[eventType](/javascript/api/word/word.contentcontrolselectionchangedeventargs#word-word-contentcontrolselectionchangedeventargs-eventtype-member)|The event type.| -||[ids](/javascript/api/word/word.contentcontrolselectionchangedeventargs#word-word-contentcontrolselectionchangedeventargs-ids-member)|Gets the content control IDs.| -||[source](/javascript/api/word/word.contentcontrolselectionchangedeventargs#word-word-contentcontrolselectionchangedeventargs-source-member)|The source of the event.| -|[Document](/javascript/api/word/word.document)|[addStyle(name: string, type: Word.StyleType)](/javascript/api/word/word.document#word-word-document-addstyle-member(1))|Adds a style into the document by name and type.| -||[close(closeBehavior?: Word.CloseBehavior)](/javascript/api/word/word.document#word-word-document-close-member(1))|Closes the current document.| -||[getContentControls(options?: Word.ContentControlOptions)](/javascript/api/word/word.document#word-word-document-getcontentcontrols-member(1))|Gets the currently supported content controls in the document.| -||[getEndnoteBody()](/javascript/api/word/word.document#word-word-document-getendnotebody-member(1))|Gets the document's endnotes in a single body.| -||[getFootnoteBody()](/javascript/api/word/word.document#word-word-document-getfootnotebody-member(1))|Gets the document's footnotes in a single body.| -||[getStyles()](/javascript/api/word/word.document#word-word-document-getstyles-member(1))|Gets a StyleCollection object that represents the whole style set of the document.| -||[insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End", insertFileOptions?: Word.InsertFileOptions)](/javascript/api/word/word.document#word-word-document-insertfilefrombase64-member(1))|Inserts a document into the target document at a specific location with additional properties.| -||[onContentControlAdded](/javascript/api/word/word.document#word-word-document-oncontentcontroladded-member)|Occurs when a content control is added.| -|[Field](/javascript/api/word/word.field)|[data](/javascript/api/word/word.field#word-word-field-data-member)|Specifies data in an "Addin" field.| -||[delete()](/javascript/api/word/word.field#word-word-field-delete-member(1))|Deletes the field.| -||[kind](/javascript/api/word/word.field#word-word-field-kind-member)|Gets the field's kind.| -||[locked](/javascript/api/word/word.field#word-word-field-locked-member)|Specifies whether the field is locked.| -||[select(selectionMode?: Word.SelectionMode)](/javascript/api/word/word.field#word-word-field-select-member(1))|Selects the field.| -||[type](/javascript/api/word/word.field#word-word-field-type-member)|Gets the field's type.| -||[updateResult()](/javascript/api/word/word.field#word-word-field-updateresult-member(1))|Updates the field.| -|[FieldCollection](/javascript/api/word/word.fieldcollection)|[getByTypes(types: Word.FieldType[])](/javascript/api/word/word.fieldcollection#word-word-fieldcollection-getbytypes-member(1))|Gets the Field object collection including the specified types of fields.| -|[InsertFileOptions](/javascript/api/word/word.insertfileoptions)|[importChangeTrackingMode](/javascript/api/word/word.insertfileoptions#word-word-insertfileoptions-importchangetrackingmode-member)|Represents whether the change tracking mode status from the source document should be imported.| -||[importPageColor](/javascript/api/word/word.insertfileoptions#word-word-insertfileoptions-importpagecolor-member)|Represents whether the page color and other background information from the source document should be imported.| -||[importParagraphSpacing](/javascript/api/word/word.insertfileoptions#word-word-insertfileoptions-importparagraphspacing-member)|Represents whether the paragraph spacing from the source document should be imported.| -||[importStyles](/javascript/api/word/word.insertfileoptions#word-word-insertfileoptions-importstyles-member)|Represents whether the styles from the source document should be imported.| -||[importTheme](/javascript/api/word/word.insertfileoptions#word-word-insertfileoptions-importtheme-member)|Represents whether the theme from the source document should be imported.| -|[NoteItem](/javascript/api/word/word.noteitem)|[body](/javascript/api/word/word.noteitem#word-word-noteitem-body-member)|Represents the body object of the note item.| -||[delete()](/javascript/api/word/word.noteitem#word-word-noteitem-delete-member(1))|Deletes the note item.| -||[getNext()](/javascript/api/word/word.noteitem#word-word-noteitem-getnext-member(1))|Gets the next note item of the same type.| -||[getNextOrNullObject()](/javascript/api/word/word.noteitem#word-word-noteitem-getnextornullobject-member(1))|Gets the next note item of the same type.| -||[reference](/javascript/api/word/word.noteitem#word-word-noteitem-reference-member)|Represents a footnote or endnote reference in the main document.| -||[type](/javascript/api/word/word.noteitem#word-word-noteitem-type-member)|Represents the note item type: footnote or endnote.| -|[NoteItemCollection](/javascript/api/word/word.noteitemcollection)|[getFirst()](/javascript/api/word/word.noteitemcollection#word-word-noteitemcollection-getfirst-member(1))|Gets the first note item in this collection.| -||[getFirstOrNullObject()](/javascript/api/word/word.noteitemcollection#word-word-noteitemcollection-getfirstornullobject-member(1))|Gets the first note item in this collection.| -||[items](/javascript/api/word/word.noteitemcollection#word-word-noteitemcollection-items-member)|Gets the loaded child items in this collection.| -|[Paragraph](/javascript/api/word/word.paragraph)|[endnotes](/javascript/api/word/word.paragraph#word-word-paragraph-endnotes-member)|Gets the collection of endnotes in the paragraph.| -||[footnotes](/javascript/api/word/word.paragraph#word-word-paragraph-footnotes-member)|Gets the collection of footnotes in the paragraph.| -||[getContentControls(options?: Word.ContentControlOptions)](/javascript/api/word/word.paragraph#word-word-paragraph-getcontentcontrols-member(1))|Gets the currently supported content controls in the paragraph.| -|[ParagraphFormat](/javascript/api/word/word.paragraphformat)|[alignment](/javascript/api/word/word.paragraphformat#word-word-paragraphformat-alignment-member)|Specifies the alignment for the specified paragraphs.| -||[firstLineIndent](/javascript/api/word/word.paragraphformat#word-word-paragraphformat-firstlineindent-member)|Specifies the value (in points) for a first line or hanging indent.| -||[keepTogether](/javascript/api/word/word.paragraphformat#word-word-paragraphformat-keeptogether-member)|Specifies whether all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document.| -||[keepWithNext](/javascript/api/word/word.paragraphformat#word-word-paragraphformat-keepwithnext-member)|Specifies whether the specified paragraph remains on the same page as the paragraph that follows it when Microsoft Word repaginates the document.| -||[leftIndent](/javascript/api/word/word.paragraphformat#word-word-paragraphformat-leftindent-member)|Specifies the left indent.| -||[lineSpacing](/javascript/api/word/word.paragraphformat#word-word-paragraphformat-linespacing-member)|Specifies the line spacing (in points) for the specified paragraphs.| -||[lineUnitAfter](/javascript/api/word/word.paragraphformat#word-word-paragraphformat-lineunitafter-member)|Specifies the amount of spacing (in gridlines) after the specified paragraphs.| -||[lineUnitBefore](/javascript/api/word/word.paragraphformat#word-word-paragraphformat-lineunitbefore-member)|Specifies the amount of spacing (in gridlines) before the specified paragraphs.| -||[mirrorIndents](/javascript/api/word/word.paragraphformat#word-word-paragraphformat-mirrorindents-member)|Specifies whether left and right indents are the same width.| -||[outlineLevel](/javascript/api/word/word.paragraphformat#word-word-paragraphformat-outlinelevel-member)|Specifies the outline level for the specified paragraphs.| -||[rightIndent](/javascript/api/word/word.paragraphformat#word-word-paragraphformat-rightindent-member)|Specifies the right indent (in points) for the specified paragraphs.| -||[spaceAfter](/javascript/api/word/word.paragraphformat#word-word-paragraphformat-spaceafter-member)|Specifies the amount of spacing (in points) after the specified paragraph or text column.| -||[spaceBefore](/javascript/api/word/word.paragraphformat#word-word-paragraphformat-spacebefore-member)|Specifies the spacing (in points) before the specified paragraphs.| -||[widowControl](/javascript/api/word/word.paragraphformat#word-word-paragraphformat-widowcontrol-member)|Specifies whether the first and last lines in the specified paragraph remain on the same page as the rest of the paragraph when Microsoft Word repaginates the document.| -|[Range](/javascript/api/word/word.range)|[endnotes](/javascript/api/word/word.range#word-word-range-endnotes-member)|Gets the collection of endnotes in the range.| -||[footnotes](/javascript/api/word/word.range#word-word-range-footnotes-member)|Gets the collection of footnotes in the range.| -||[getContentControls(options?: Word.ContentControlOptions)](/javascript/api/word/word.range#word-word-range-getcontentcontrols-member(1))|Gets the currently supported content controls in the range.| -||[insertEndnote(insertText?: string)](/javascript/api/word/word.range#word-word-range-insertendnote-member(1))|Inserts an endnote.| -||[insertField(insertLocation: Word.InsertLocation \| "Replace" \| "Start" \| "End" \| "Before" \| "After", fieldType?: Word.FieldType, text?: string, removeFormatting?: boolean)](/javascript/api/word/word.range#word-word-range-insertfield-member(1))|Inserts a field at the specified location.| -||[insertFootnote(insertText?: string)](/javascript/api/word/word.range#word-word-range-insertfootnote-member(1))|Inserts a footnote.| -|[Style](/javascript/api/word/word.style)|[baseStyle](/javascript/api/word/word.style#word-word-style-basestyle-member)|Specifies the name of an existing style to use as the base formatting of another style.| -||[builtIn](/javascript/api/word/word.style#word-word-style-builtin-member)|Gets whether the specified style is a built-in style.| -||[delete()](/javascript/api/word/word.style#word-word-style-delete-member(1))|Deletes the style.| -||[font](/javascript/api/word/word.style#word-word-style-font-member)|Gets a font object that represents the character formatting of the specified style.| -||[inUse](/javascript/api/word/word.style#word-word-style-inuse-member)|Gets whether the specified style is a built-in style that has been modified or applied in the document or a new style that has been created in the document.| -||[linked](/javascript/api/word/word.style#word-word-style-linked-member)|Gets whether a style is a linked style that can be used for both paragraph and character formatting.| -||[nameLocal](/javascript/api/word/word.style#word-word-style-namelocal-member)|Gets the name of a style in the language of the user.| -||[nextParagraphStyle](/javascript/api/word/word.style#word-word-style-nextparagraphstyle-member)|Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style.| -||[paragraphFormat](/javascript/api/word/word.style#word-word-style-paragraphformat-member)|Gets a ParagraphFormat object that represents the paragraph settings for the specified style.| -||[priority](/javascript/api/word/word.style#word-word-style-priority-member)|Specifies the priority.| -||[quickStyle](/javascript/api/word/word.style#word-word-style-quickstyle-member)|Specifies whether the style corresponds to an available quick style.| -||[type](/javascript/api/word/word.style#word-word-style-type-member)|Gets the style type.| -||[unhideWhenUsed](/javascript/api/word/word.style#word-word-style-unhidewhenused-member)|Specifies whether the specified style is made visible as a recommended style in the Styles and in the Styles task pane in Microsoft Word after it's used in the document.| -||[visibility](/javascript/api/word/word.style#word-word-style-visibility-member)|Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane.| -|[StyleCollection](/javascript/api/word/word.stylecollection)|[getByName(name: string)](/javascript/api/word/word.stylecollection#word-word-stylecollection-getbyname-member(1))|Get the style object by its name.| -||[getByNameOrNullObject(name: string)](/javascript/api/word/word.stylecollection#word-word-stylecollection-getbynameornullobject-member(1))|If the corresponding style doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.| -||[getCount()](/javascript/api/word/word.stylecollection#word-word-stylecollection-getcount-member(1))|Gets the number of the styles in the collection.| -||[getItem(index: number)](/javascript/api/word/word.stylecollection#word-word-stylecollection-getitem-member(1))|Gets a style object by its index in the collection.| -||[items](/javascript/api/word/word.stylecollection#word-word-stylecollection-items-member)|Gets the loaded child items in this collection.| -|[Table](/javascript/api/word/word.table)|[endnotes](/javascript/api/word/word.table#word-word-table-endnotes-member)|Gets the collection of endnotes in the table.| -||[footnotes](/javascript/api/word/word.table#word-word-table-footnotes-member)|Gets the collection of footnotes in the table.| -|[TableRow](/javascript/api/word/word.tablerow)|[endnotes](/javascript/api/word/word.tablerow#word-word-tablerow-endnotes-member)|Gets the collection of endnotes in the table row.| -||[footnotes](/javascript/api/word/word.tablerow#word-word-tablerow-footnotes-member)|Gets the collection of footnotes in the table row.| +|[Application](/.application)|[retrieveStylesFromBase64(base64File: string)](/.application#word-javascript/api/word/-application-retrievestylesfrombase64-member(1))|Parse styles from template Base64 file and return JSON format of retrieved styles as a string.| +|[Body](/.body)|[endnotes](/.body#word-javascript/api/word/-body-endnotes-member)|Gets the collection of endnotes in the body.| +||[footnotes](/.body#word-javascript/api/word/-body-footnotes-member)|Gets the collection of footnotes in the body.| +||[getContentControls(options?: Word.ContentControlOptions)](/.body#word-javascript/api/word/-body-getcontentcontrols-member(1))|Gets the currently supported content controls in the body.| +|[ContentControl](/.contentcontrol)|[endnotes](/.contentcontrol#word-javascript/api/word/-contentcontrol-endnotes-member)|Gets the collection of endnotes in the content control.| +||[footnotes](/.contentcontrol#word-javascript/api/word/-contentcontrol-footnotes-member)|Gets the collection of footnotes in the content control.| +||[getContentControls(options?: Word.ContentControlOptions)](/.contentcontrol#word-javascript/api/word/-contentcontrol-getcontentcontrols-member(1))|Gets the currently supported child content controls in this content control.| +||[onDataChanged](/.contentcontrol#word-javascript/api/word/-contentcontrol-ondatachanged-member)|Occurs when data within the content control are changed.| +||[onDeleted](/.contentcontrol#word-javascript/api/word/-contentcontrol-ondeleted-member)|Occurs when the content control is deleted.| +||[onEntered](/.contentcontrol#word-javascript/api/word/-contentcontrol-onentered-member)|Occurs when the content control is entered.| +||[onExited](/.contentcontrol#word-javascript/api/word/-contentcontrol-onexited-member)|Occurs when the content control is exited, for example, when the cursor leaves the content control.| +||[onSelectionChanged](/.contentcontrol#word-javascript/api/word/-contentcontrol-onselectionchanged-member)|Occurs when selection within the content control is changed.| +|[ContentControlAddedEventArgs](/.contentcontroladdedeventargs)|[eventType](/.contentcontroladdedeventargs#word-javascript/api/word/-contentcontroladdedeventargs-eventtype-member)|The event type.| +||[ids](/.contentcontroladdedeventargs#word-javascript/api/word/-contentcontroladdedeventargs-ids-member)|Gets the content control IDs.| +||[source](/.contentcontroladdedeventargs#word-javascript/api/word/-contentcontroladdedeventargs-source-member)|The source of the event.| +|[ContentControlCollection](/.contentcontrolcollection)|[getByChangeTrackingStates(changeTrackingStates: Word.ChangeTrackingState[])](/.contentcontrolcollection#word-javascript/api/word/-contentcontrolcollection-getbychangetrackingstates-member(1))|Gets the content controls that have the specified tracking state.| +|[ContentControlDataChangedEventArgs](/.contentcontroldatachangedeventargs)|[eventType](/.contentcontroldatachangedeventargs#word-javascript/api/word/-contentcontroldatachangedeventargs-eventtype-member)|The event type.| +||[ids](/.contentcontroldatachangedeventargs#word-javascript/api/word/-contentcontroldatachangedeventargs-ids-member)|Gets the content control IDs.| +||[source](/.contentcontroldatachangedeventargs#word-javascript/api/word/-contentcontroldatachangedeventargs-source-member)|The source of the event.| +|[ContentControlDeletedEventArgs](/.contentcontroldeletedeventargs)|[eventType](/.contentcontroldeletedeventargs#word-javascript/api/word/-contentcontroldeletedeventargs-eventtype-member)|The event type.| +||[ids](/.contentcontroldeletedeventargs#word-javascript/api/word/-contentcontroldeletedeventargs-ids-member)|Gets the content control IDs.| +||[source](/.contentcontroldeletedeventargs#word-javascript/api/word/-contentcontroldeletedeventargs-source-member)|The source of the event.| +|[ContentControlEnteredEventArgs](/.contentcontrolenteredeventargs)|[eventType](/.contentcontrolenteredeventargs#word-javascript/api/word/-contentcontrolenteredeventargs-eventtype-member)|The event type.| +||[ids](/.contentcontrolenteredeventargs#word-javascript/api/word/-contentcontrolenteredeventargs-ids-member)|Gets the content control IDs.| +||[source](/.contentcontrolenteredeventargs#word-javascript/api/word/-contentcontrolenteredeventargs-source-member)|The source of the event.| +|[ContentControlExitedEventArgs](/.contentcontrolexitedeventargs)|[eventType](/.contentcontrolexitedeventargs#word-javascript/api/word/-contentcontrolexitedeventargs-eventtype-member)|The event type.| +||[ids](/.contentcontrolexitedeventargs#word-javascript/api/word/-contentcontrolexitedeventargs-ids-member)|Gets the content control IDs.| +||[source](/.contentcontrolexitedeventargs#word-javascript/api/word/-contentcontrolexitedeventargs-source-member)|The source of the event.| +|[ContentControlOptions](/.contentcontroloptions)|[types](/.contentcontroloptions#word-javascript/api/word/-contentcontroloptions-types-member)|An array of content control types, item must be 'RichText', 'PlainText', 'CheckBox', 'DropDownList', or 'ComboBox'.| +|[ContentControlSelectionChangedEventArgs](/.contentcontrolselectionchangedeventargs)|[eventType](/.contentcontrolselectionchangedeventargs#word-javascript/api/word/-contentcontrolselectionchangedeventargs-eventtype-member)|The event type.| +||[ids](/.contentcontrolselectionchangedeventargs#word-javascript/api/word/-contentcontrolselectionchangedeventargs-ids-member)|Gets the content control IDs.| +||[source](/.contentcontrolselectionchangedeventargs#word-javascript/api/word/-contentcontrolselectionchangedeventargs-source-member)|The source of the event.| +|[Document](/.document)|[addStyle(name: string, type: Word.StyleType)](/.document#word-javascript/api/word/-document-addstyle-member(1))|Adds a style into the document by name and type.| +||[close(closeBehavior?: Word.CloseBehavior)](/.document#word-javascript/api/word/-document-close-member(1))|Closes the current document.| +||[getContentControls(options?: Word.ContentControlOptions)](/.document#word-javascript/api/word/-document-getcontentcontrols-member(1))|Gets the currently supported content controls in the document.| +||[getEndnoteBody()](/.document#word-javascript/api/word/-document-getendnotebody-member(1))|Gets the document's endnotes in a single body.| +||[getFootnoteBody()](/.document#word-javascript/api/word/-document-getfootnotebody-member(1))|Gets the document's footnotes in a single body.| +||[getStyles()](/.document#word-javascript/api/word/-document-getstyles-member(1))|Gets a StyleCollection object that represents the whole style set of the document.| +||[insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End", insertFileOptions?: Word.InsertFileOptions)](/.document#word-javascript/api/word/-document-insertfilefrombase64-member(1))|Inserts a document into the target document at a specific location with additional properties.| +||[onContentControlAdded](/.document#word-javascript/api/word/-document-oncontentcontroladded-member)|Occurs when a content control is added.| +|[Field](/.field)|[data](/.field#word-javascript/api/word/-field-data-member)|Specifies data in an "Addin" field.| +||[delete()](/.field#word-javascript/api/word/-field-delete-member(1))|Deletes the field.| +||[kind](/.field#word-javascript/api/word/-field-kind-member)|Gets the field's kind.| +||[locked](/.field#word-javascript/api/word/-field-locked-member)|Specifies whether the field is locked.| +||[select(selectionMode?: Word.SelectionMode)](/.field#word-javascript/api/word/-field-select-member(1))|Selects the field.| +||[type](/.field#word-javascript/api/word/-field-type-member)|Gets the field's type.| +||[updateResult()](/.field#word-javascript/api/word/-field-updateresult-member(1))|Updates the field.| +|[FieldCollection](/.fieldcollection)|[getByTypes(types: Word.FieldType[])](/.fieldcollection#word-javascript/api/word/-fieldcollection-getbytypes-member(1))|Gets the Field object collection including the specified types of fields.| +|[InsertFileOptions](/.insertfileoptions)|[importChangeTrackingMode](/.insertfileoptions#word-javascript/api/word/-insertfileoptions-importchangetrackingmode-member)|Represents whether the change tracking mode status from the source document should be imported.| +||[importPageColor](/.insertfileoptions#word-javascript/api/word/-insertfileoptions-importpagecolor-member)|Represents whether the page color and other background information from the source document should be imported.| +||[importParagraphSpacing](/.insertfileoptions#word-javascript/api/word/-insertfileoptions-importparagraphspacing-member)|Represents whether the paragraph spacing from the source document should be imported.| +||[importStyles](/.insertfileoptions#word-javascript/api/word/-insertfileoptions-importstyles-member)|Represents whether the styles from the source document should be imported.| +||[importTheme](/.insertfileoptions#word-javascript/api/word/-insertfileoptions-importtheme-member)|Represents whether the theme from the source document should be imported.| +|[NoteItem](/.noteitem)|[body](/.noteitem#word-javascript/api/word/-noteitem-body-member)|Represents the body object of the note item.| +||[delete()](/.noteitem#word-javascript/api/word/-noteitem-delete-member(1))|Deletes the note item.| +||[getNext()](/.noteitem#word-javascript/api/word/-noteitem-getnext-member(1))|Gets the next note item of the same type.| +||[getNextOrNullObject()](/.noteitem#word-javascript/api/word/-noteitem-getnextornullobject-member(1))|Gets the next note item of the same type.| +||[reference](/.noteitem#word-javascript/api/word/-noteitem-reference-member)|Represents a footnote or endnote reference in the main document.| +||[type](/.noteitem#word-javascript/api/word/-noteitem-type-member)|Represents the note item type: footnote or endnote.| +|[NoteItemCollection](/.noteitemcollection)|[getFirst()](/.noteitemcollection#word-javascript/api/word/-noteitemcollection-getfirst-member(1))|Gets the first note item in this collection.| +||[getFirstOrNullObject()](/.noteitemcollection#word-javascript/api/word/-noteitemcollection-getfirstornullobject-member(1))|Gets the first note item in this collection.| +||[items](/.noteitemcollection#word-javascript/api/word/-noteitemcollection-items-member)|Gets the loaded child items in this collection.| +|[Paragraph](/.paragraph)|[endnotes](/.paragraph#word-javascript/api/word/-paragraph-endnotes-member)|Gets the collection of endnotes in the paragraph.| +||[footnotes](/.paragraph#word-javascript/api/word/-paragraph-footnotes-member)|Gets the collection of footnotes in the paragraph.| +||[getContentControls(options?: Word.ContentControlOptions)](/.paragraph#word-javascript/api/word/-paragraph-getcontentcontrols-member(1))|Gets the currently supported content controls in the paragraph.| +|[ParagraphFormat](/.paragraphformat)|[alignment](/.paragraphformat#word-javascript/api/word/-paragraphformat-alignment-member)|Specifies the alignment for the specified paragraphs.| +||[firstLineIndent](/.paragraphformat#word-javascript/api/word/-paragraphformat-firstlineindent-member)|Specifies the value (in points) for a first line or hanging indent.| +||[keepTogether](/.paragraphformat#word-javascript/api/word/-paragraphformat-keeptogether-member)|Specifies whether all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document.| +||[keepWithNext](/.paragraphformat#word-javascript/api/word/-paragraphformat-keepwithnext-member)|Specifies whether the specified paragraph remains on the same page as the paragraph that follows it when Microsoft Word repaginates the document.| +||[leftIndent](/.paragraphformat#word-javascript/api/word/-paragraphformat-leftindent-member)|Specifies the left indent.| +||[lineSpacing](/.paragraphformat#word-javascript/api/word/-paragraphformat-linespacing-member)|Specifies the line spacing (in points) for the specified paragraphs.| +||[lineUnitAfter](/.paragraphformat#word-javascript/api/word/-paragraphformat-lineunitafter-member)|Specifies the amount of spacing (in gridlines) after the specified paragraphs.| +||[lineUnitBefore](/.paragraphformat#word-javascript/api/word/-paragraphformat-lineunitbefore-member)|Specifies the amount of spacing (in gridlines) before the specified paragraphs.| +||[mirrorIndents](/.paragraphformat#word-javascript/api/word/-paragraphformat-mirrorindents-member)|Specifies whether left and right indents are the same width.| +||[outlineLevel](/.paragraphformat#word-javascript/api/word/-paragraphformat-outlinelevel-member)|Specifies the outline level for the specified paragraphs.| +||[rightIndent](/.paragraphformat#word-javascript/api/word/-paragraphformat-rightindent-member)|Specifies the right indent (in points) for the specified paragraphs.| +||[spaceAfter](/.paragraphformat#word-javascript/api/word/-paragraphformat-spaceafter-member)|Specifies the amount of spacing (in points) after the specified paragraph or text column.| +||[spaceBefore](/.paragraphformat#word-javascript/api/word/-paragraphformat-spacebefore-member)|Specifies the spacing (in points) before the specified paragraphs.| +||[widowControl](/.paragraphformat#word-javascript/api/word/-paragraphformat-widowcontrol-member)|Specifies whether the first and last lines in the specified paragraph remain on the same page as the rest of the paragraph when Microsoft Word repaginates the document.| +|[Range](/.range)|[endnotes](/.range#word-javascript/api/word/-range-endnotes-member)|Gets the collection of endnotes in the range.| +||[footnotes](/.range#word-javascript/api/word/-range-footnotes-member)|Gets the collection of footnotes in the range.| +||[getContentControls(options?: Word.ContentControlOptions)](/.range#word-javascript/api/word/-range-getcontentcontrols-member(1))|Gets the currently supported content controls in the range.| +||[insertEndnote(insertText?: string)](/.range#word-javascript/api/word/-range-insertendnote-member(1))|Inserts an endnote.| +||[insertField(insertLocation: Word.InsertLocation \| "Replace" \| "Start" \| "End" \| "Before" \| "After", fieldType?: Word.FieldType, text?: string, removeFormatting?: boolean)](/.range#word-javascript/api/word/-range-insertfield-member(1))|Inserts a field at the specified location.| +||[insertFootnote(insertText?: string)](/.range#word-javascript/api/word/-range-insertfootnote-member(1))|Inserts a footnote.| +|[Style](/.style)|[baseStyle](/.style#word-javascript/api/word/-style-basestyle-member)|Specifies the name of an existing style to use as the base formatting of another style.| +||[builtIn](/.style#word-javascript/api/word/-style-builtin-member)|Gets whether the specified style is a built-in style.| +||[delete()](/.style#word-javascript/api/word/-style-delete-member(1))|Deletes the style.| +||[font](/.style#word-javascript/api/word/-style-font-member)|Gets a font object that represents the character formatting of the specified style.| +||[inUse](/.style#word-javascript/api/word/-style-inuse-member)|Gets whether the specified style is a built-in style that has been modified or applied in the document or a new style that has been created in the document.| +||[linked](/.style#word-javascript/api/word/-style-linked-member)|Gets whether a style is a linked style that can be used for both paragraph and character formatting.| +||[nameLocal](/.style#word-javascript/api/word/-style-namelocal-member)|Gets the name of a style in the language of the user.| +||[nextParagraphStyle](/.style#word-javascript/api/word/-style-nextparagraphstyle-member)|Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style.| +||[paragraphFormat](/.style#word-javascript/api/word/-style-paragraphformat-member)|Gets a ParagraphFormat object that represents the paragraph settings for the specified style.| +||[priority](/.style#word-javascript/api/word/-style-priority-member)|Specifies the priority.| +||[quickStyle](/.style#word-javascript/api/word/-style-quickstyle-member)|Specifies whether the style corresponds to an available quick style.| +||[type](/.style#word-javascript/api/word/-style-type-member)|Gets the style type.| +||[unhideWhenUsed](/.style#word-javascript/api/word/-style-unhidewhenused-member)|Specifies whether the specified style is made visible as a recommended style in the Styles and in the Styles task pane in Microsoft Word after it's used in the document.| +||[visibility](/.style#word-javascript/api/word/-style-visibility-member)|Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane.| +|[StyleCollection](/.stylecollection)|[getByName(name: string)](/.stylecollection#word-javascript/api/word/-stylecollection-getbyname-member(1))|Get the style object by its name.| +||[getByNameOrNullObject(name: string)](/.stylecollection#word-javascript/api/word/-stylecollection-getbynameornullobject-member(1))|If the corresponding style doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.| +||[getCount()](/.stylecollection#word-javascript/api/word/-stylecollection-getcount-member(1))|Gets the number of the styles in the collection.| +||[getItem(index: number)](/.stylecollection#word-javascript/api/word/-stylecollection-getitem-member(1))|Gets a style object by its index in the collection.| +||[items](/.stylecollection#word-javascript/api/word/-stylecollection-items-member)|Gets the loaded child items in this collection.| +|[Table](/.table)|[endnotes](/.table#word-javascript/api/word/-table-endnotes-member)|Gets the collection of endnotes in the table.| +||[footnotes](/.table#word-javascript/api/word/-table-footnotes-member)|Gets the collection of footnotes in the table.| +|[TableRow](/.tablerow)|[endnotes](/.tablerow#word-javascript/api/word/-tablerow-endnotes-member)|Gets the collection of endnotes in the table row.| +||[footnotes](/.tablerow#word-javascript/api/word/-tablerow-footnotes-member)|Gets the collection of footnotes in the table row.| diff --git a/docs/includes/word-1_5_hidden_document.md b/docs/includes/word-1_5_hidden_document.md index e27707ab9c..7cfda2baca 100644 --- a/docs/includes/word-1_5_hidden_document.md +++ b/docs/includes/word-1_5_hidden_document.md @@ -1,6 +1,6 @@ | Class | Fields | Description | |:---|:---|:---| -|[DocumentCreated](/javascript/api/word/word.documentcreated)|[addStyle(name: string, type: Word.StyleType)](/javascript/api/word/word.documentcreated#word-word-documentcreated-addstyle-member(1))|Adds a style into the document by name and type.| -||[getContentControls(options?: Word.ContentControlOptions)](/javascript/api/word/word.documentcreated#word-word-documentcreated-getcontentcontrols-member(1))|Gets the currently supported content controls in the document.| -||[getStyles()](/javascript/api/word/word.documentcreated#word-word-documentcreated-getstyles-member(1))|Gets a StyleCollection object that represents the whole style set of the document.| -||[insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End", insertFileOptions?: Word.InsertFileOptions)](/javascript/api/word/word.documentcreated#word-word-documentcreated-insertfilefrombase64-member(1))|Inserts a document into the target document at a specific location with additional properties.| +|[DocumentCreated](/.documentcreated)|[addStyle(name: string, type: Word.StyleType)](/.documentcreated#word-javascript/api/word/-documentcreated-addstyle-member(1))|Adds a style into the document by name and type.| +||[getContentControls(options?: Word.ContentControlOptions)](/.documentcreated#word-javascript/api/word/-documentcreated-getcontentcontrols-member(1))|Gets the currently supported content controls in the document.| +||[getStyles()](/.documentcreated#word-javascript/api/word/-documentcreated-getstyles-member(1))|Gets a StyleCollection object that represents the whole style set of the document.| +||[insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End", insertFileOptions?: Word.InsertFileOptions)](/.documentcreated#word-javascript/api/word/-documentcreated-insertfilefrombase64-member(1))|Inserts a document into the target document at a specific location with additional properties.| diff --git a/docs/includes/word-1_6.md b/docs/includes/word-1_6.md index 96e7bceabf..da729510e2 100644 --- a/docs/includes/word-1_6.md +++ b/docs/includes/word-1_6.md @@ -1,46 +1,46 @@ | Class | Fields | Description | |:---|:---|:---| -|[Application](/javascript/api/word/word.application)|[openDocument(filePath: string)](/javascript/api/word/word.application#word-word-application-opendocument-member(1))|Opens a document and displays it in a new tab or window.| -|[Body](/javascript/api/word/word.body)|[getTrackedChanges()](/javascript/api/word/word.body#word-word-body-gettrackedchanges-member(1))|Gets the collection of the TrackedChange objects in the body.| -|[ContentControl](/javascript/api/word/word.contentcontrol)|[getTrackedChanges()](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-gettrackedchanges-member(1))|Gets the collection of the TrackedChange objects in the content control.| -|[Document](/javascript/api/word/word.document)|[getParagraphByUniqueLocalId(id: string)](/javascript/api/word/word.document#word-word-document-getparagraphbyuniquelocalid-member(1))|Gets the paragraph by its unique local ID.| -||[importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior)](/javascript/api/word/word.document#word-word-document-importstylesfromjson-member(1))|Import styles from a JSON-formatted string.| -||[onParagraphAdded](/javascript/api/word/word.document#word-word-document-onparagraphadded-member)|Occurs when the user adds new paragraphs.| -||[onParagraphChanged](/javascript/api/word/word.document#word-word-document-onparagraphchanged-member)|Occurs when the user changes paragraphs.| -||[onParagraphDeleted](/javascript/api/word/word.document#word-word-document-onparagraphdeleted-member)|Occurs when the user deletes paragraphs.| -|[InsertFileOptions](/javascript/api/word/word.insertfileoptions)|[importCustomProperties](/javascript/api/word/word.insertfileoptions#word-word-insertfileoptions-importcustomproperties-member)|Represents whether the custom properties from the source document should be imported.| -||[importCustomXmlParts](/javascript/api/word/word.insertfileoptions#word-word-insertfileoptions-importcustomxmlparts-member)|Represents whether the custom XML parts from the source document should be imported.| -|[Paragraph](/javascript/api/word/word.paragraph)|[getTrackedChanges()](/javascript/api/word/word.paragraph#word-word-paragraph-gettrackedchanges-member(1))|Gets the collection of the TrackedChange objects in the paragraph.| -||[uniqueLocalId](/javascript/api/word/word.paragraph#word-word-paragraph-uniquelocalid-member)|Gets a string that represents the paragraph identifier in the current session.| -|[ParagraphAddedEventArgs](/javascript/api/word/word.paragraphaddedeventargs)|[source](/javascript/api/word/word.paragraphaddedeventargs#word-word-paragraphaddedeventargs-source-member)|The source of the event.| -||[type](/javascript/api/word/word.paragraphaddedeventargs#word-word-paragraphaddedeventargs-type-member)|The event type.| -||[uniqueLocalIds](/javascript/api/word/word.paragraphaddedeventargs#word-word-paragraphaddedeventargs-uniquelocalids-member)|Gets the unique IDs of the involved paragraphs.| -|[ParagraphChangedEventArgs](/javascript/api/word/word.paragraphchangedeventargs)|[source](/javascript/api/word/word.paragraphchangedeventargs#word-word-paragraphchangedeventargs-source-member)|The source of the event.| -||[type](/javascript/api/word/word.paragraphchangedeventargs#word-word-paragraphchangedeventargs-type-member)|The event type.| -||[uniqueLocalIds](/javascript/api/word/word.paragraphchangedeventargs#word-word-paragraphchangedeventargs-uniquelocalids-member)|Gets the unique IDs of the involved paragraphs.| -|[ParagraphDeletedEventArgs](/javascript/api/word/word.paragraphdeletedeventargs)|[source](/javascript/api/word/word.paragraphdeletedeventargs#word-word-paragraphdeletedeventargs-source-member)|The source of the event.| -||[type](/javascript/api/word/word.paragraphdeletedeventargs#word-word-paragraphdeletedeventargs-type-member)|The event type.| -||[uniqueLocalIds](/javascript/api/word/word.paragraphdeletedeventargs#word-word-paragraphdeletedeventargs-uniquelocalids-member)|Gets the unique IDs of the involved paragraphs.| -|[Range](/javascript/api/word/word.range)|[getTrackedChanges()](/javascript/api/word/word.range#word-word-range-gettrackedchanges-member(1))|Gets the collection of the TrackedChange objects in the range.| -|[Shading](/javascript/api/word/word.shading)|[backgroundPatternColor](/javascript/api/word/word.shading#word-word-shading-backgroundpatterncolor-member)|Specifies the color for the background of the object.| -|[Style](/javascript/api/word/word.style)|[shading](/javascript/api/word/word.style#word-word-style-shading-member)|Gets a Shading object that represents the shading for the specified style.| -||[tableStyle](/javascript/api/word/word.style#word-word-style-tablestyle-member)|Gets a TableStyle object representing Style properties that can be applied to a table.| -|[TableStyle](/javascript/api/word/word.tablestyle)|[bottomCellMargin](/javascript/api/word/word.tablestyle#word-word-tablestyle-bottomcellmargin-member)|Specifies the amount of space to add between the contents and the bottom borders of the cells.| -||[cellSpacing](/javascript/api/word/word.tablestyle#word-word-tablestyle-cellspacing-member)|Specifies the spacing (in points) between the cells in a table style.| -||[leftCellMargin](/javascript/api/word/word.tablestyle#word-word-tablestyle-leftcellmargin-member)|Specifies the amount of space to add between the contents and the left borders of the cells.| -||[rightCellMargin](/javascript/api/word/word.tablestyle#word-word-tablestyle-rightcellmargin-member)|Specifies the amount of space to add between the contents and the right borders of the cells.| -||[topCellMargin](/javascript/api/word/word.tablestyle#word-word-tablestyle-topcellmargin-member)|Specifies the amount of space to add between the contents and the top borders of the cells.| -|[TrackedChange](/javascript/api/word/word.trackedchange)|[accept()](/javascript/api/word/word.trackedchange#word-word-trackedchange-accept-member(1))|Accepts the tracked change.| -||[author](/javascript/api/word/word.trackedchange#word-word-trackedchange-author-member)|Gets the author of the tracked change.| -||[date](/javascript/api/word/word.trackedchange#word-word-trackedchange-date-member)|Gets the date of the tracked change.| -||[getNext()](/javascript/api/word/word.trackedchange#word-word-trackedchange-getnext-member(1))|Gets the next tracked change.| -||[getNextOrNullObject()](/javascript/api/word/word.trackedchange#word-word-trackedchange-getnextornullobject-member(1))|Gets the next tracked change.| -||[getRange(rangeLocation?: Word.RangeLocation.whole \| Word.RangeLocation.start \| Word.RangeLocation.end \| "Whole" \| "Start" \| "End")](/javascript/api/word/word.trackedchange#word-word-trackedchange-getrange-member(1))|Gets the range of the tracked change.| -||[reject()](/javascript/api/word/word.trackedchange#word-word-trackedchange-reject-member(1))|Rejects the tracked change.| -||[text](/javascript/api/word/word.trackedchange#word-word-trackedchange-text-member)|Gets the text of the tracked change.| -||[type](/javascript/api/word/word.trackedchange#word-word-trackedchange-type-member)|Gets the type of the tracked change.| -|[TrackedChangeCollection](/javascript/api/word/word.trackedchangecollection)|[acceptAll()](/javascript/api/word/word.trackedchangecollection#word-word-trackedchangecollection-acceptall-member(1))|Accepts all the tracked changes in the collection.| -||[getFirst()](/javascript/api/word/word.trackedchangecollection#word-word-trackedchangecollection-getfirst-member(1))|Gets the first TrackedChange in this collection.| -||[getFirstOrNullObject()](/javascript/api/word/word.trackedchangecollection#word-word-trackedchangecollection-getfirstornullobject-member(1))|Gets the first TrackedChange in this collection.| -||[items](/javascript/api/word/word.trackedchangecollection#word-word-trackedchangecollection-items-member)|Gets the loaded child items in this collection.| -||[rejectAll()](/javascript/api/word/word.trackedchangecollection#word-word-trackedchangecollection-rejectall-member(1))|Rejects all the tracked changes in the collection.| +|[Application](/.application)|[openDocument(filePath: string)](/.application#word-javascript/api/word/-application-opendocument-member(1))|Opens a document and displays it in a new tab or window.| +|[Body](/.body)|[getTrackedChanges()](/.body#word-javascript/api/word/-body-gettrackedchanges-member(1))|Gets the collection of the TrackedChange objects in the body.| +|[ContentControl](/.contentcontrol)|[getTrackedChanges()](/.contentcontrol#word-javascript/api/word/-contentcontrol-gettrackedchanges-member(1))|Gets the collection of the TrackedChange objects in the content control.| +|[Document](/.document)|[getParagraphByUniqueLocalId(id: string)](/.document#word-javascript/api/word/-document-getparagraphbyuniquelocalid-member(1))|Gets the paragraph by its unique local ID.| +||[importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior)](/.document#word-javascript/api/word/-document-importstylesfromjson-member(1))|Import styles from a JSON-formatted string.| +||[onParagraphAdded](/.document#word-javascript/api/word/-document-onparagraphadded-member)|Occurs when the user adds new paragraphs.| +||[onParagraphChanged](/.document#word-javascript/api/word/-document-onparagraphchanged-member)|Occurs when the user changes paragraphs.| +||[onParagraphDeleted](/.document#word-javascript/api/word/-document-onparagraphdeleted-member)|Occurs when the user deletes paragraphs.| +|[InsertFileOptions](/.insertfileoptions)|[importCustomProperties](/.insertfileoptions#word-javascript/api/word/-insertfileoptions-importcustomproperties-member)|Represents whether the custom properties from the source document should be imported.| +||[importCustomXmlParts](/.insertfileoptions#word-javascript/api/word/-insertfileoptions-importcustomxmlparts-member)|Represents whether the custom XML parts from the source document should be imported.| +|[Paragraph](/.paragraph)|[getTrackedChanges()](/.paragraph#word-javascript/api/word/-paragraph-gettrackedchanges-member(1))|Gets the collection of the TrackedChange objects in the paragraph.| +||[uniqueLocalId](/.paragraph#word-javascript/api/word/-paragraph-uniquelocalid-member)|Gets a string that represents the paragraph identifier in the current session.| +|[ParagraphAddedEventArgs](/.paragraphaddedeventargs)|[source](/.paragraphaddedeventargs#word-javascript/api/word/-paragraphaddedeventargs-source-member)|The source of the event.| +||[type](/.paragraphaddedeventargs#word-javascript/api/word/-paragraphaddedeventargs-type-member)|The event type.| +||[uniqueLocalIds](/.paragraphaddedeventargs#word-javascript/api/word/-paragraphaddedeventargs-uniquelocalids-member)|Gets the unique IDs of the involved paragraphs.| +|[ParagraphChangedEventArgs](/.paragraphchangedeventargs)|[source](/.paragraphchangedeventargs#word-javascript/api/word/-paragraphchangedeventargs-source-member)|The source of the event.| +||[type](/.paragraphchangedeventargs#word-javascript/api/word/-paragraphchangedeventargs-type-member)|The event type.| +||[uniqueLocalIds](/.paragraphchangedeventargs#word-javascript/api/word/-paragraphchangedeventargs-uniquelocalids-member)|Gets the unique IDs of the involved paragraphs.| +|[ParagraphDeletedEventArgs](/.paragraphdeletedeventargs)|[source](/.paragraphdeletedeventargs#word-javascript/api/word/-paragraphdeletedeventargs-source-member)|The source of the event.| +||[type](/.paragraphdeletedeventargs#word-javascript/api/word/-paragraphdeletedeventargs-type-member)|The event type.| +||[uniqueLocalIds](/.paragraphdeletedeventargs#word-javascript/api/word/-paragraphdeletedeventargs-uniquelocalids-member)|Gets the unique IDs of the involved paragraphs.| +|[Range](/.range)|[getTrackedChanges()](/.range#word-javascript/api/word/-range-gettrackedchanges-member(1))|Gets the collection of the TrackedChange objects in the range.| +|[Shading](/.shading)|[backgroundPatternColor](/.shading#word-javascript/api/word/-shading-backgroundpatterncolor-member)|Specifies the color for the background of the object.| +|[Style](/.style)|[shading](/.style#word-javascript/api/word/-style-shading-member)|Gets a Shading object that represents the shading for the specified style.| +||[tableStyle](/.style#word-javascript/api/word/-style-tablestyle-member)|Gets a TableStyle object representing Style properties that can be applied to a table.| +|[TableStyle](/.tablestyle)|[bottomCellMargin](/.tablestyle#word-javascript/api/word/-tablestyle-bottomcellmargin-member)|Specifies the amount of space to add between the contents and the bottom borders of the cells.| +||[cellSpacing](/.tablestyle#word-javascript/api/word/-tablestyle-cellspacing-member)|Specifies the spacing (in points) between the cells in a table style.| +||[leftCellMargin](/.tablestyle#word-javascript/api/word/-tablestyle-leftcellmargin-member)|Specifies the amount of space to add between the contents and the left borders of the cells.| +||[rightCellMargin](/.tablestyle#word-javascript/api/word/-tablestyle-rightcellmargin-member)|Specifies the amount of space to add between the contents and the right borders of the cells.| +||[topCellMargin](/.tablestyle#word-javascript/api/word/-tablestyle-topcellmargin-member)|Specifies the amount of space to add between the contents and the top borders of the cells.| +|[TrackedChange](/.trackedchange)|[accept()](/.trackedchange#word-javascript/api/word/-trackedchange-accept-member(1))|Accepts the tracked change.| +||[author](/.trackedchange#word-javascript/api/word/-trackedchange-author-member)|Gets the author of the tracked change.| +||[date](/.trackedchange#word-javascript/api/word/-trackedchange-date-member)|Gets the date of the tracked change.| +||[getNext()](/.trackedchange#word-javascript/api/word/-trackedchange-getnext-member(1))|Gets the next tracked change.| +||[getNextOrNullObject()](/.trackedchange#word-javascript/api/word/-trackedchange-getnextornullobject-member(1))|Gets the next tracked change.| +||[getRange(rangeLocation?: Word.RangeLocation.whole \| Word.RangeLocation.start \| Word.RangeLocation.end \| "Whole" \| "Start" \| "End")](/.trackedchange#word-javascript/api/word/-trackedchange-getrange-member(1))|Gets the range of the tracked change.| +||[reject()](/.trackedchange#word-javascript/api/word/-trackedchange-reject-member(1))|Rejects the tracked change.| +||[text](/.trackedchange#word-javascript/api/word/-trackedchange-text-member)|Gets the text of the tracked change.| +||[type](/.trackedchange#word-javascript/api/word/-trackedchange-type-member)|Gets the type of the tracked change.| +|[TrackedChangeCollection](/.trackedchangecollection)|[acceptAll()](/.trackedchangecollection#word-javascript/api/word/-trackedchangecollection-acceptall-member(1))|Accepts all the tracked changes in the collection.| +||[getFirst()](/.trackedchangecollection#word-javascript/api/word/-trackedchangecollection-getfirst-member(1))|Gets the first TrackedChange in this collection.| +||[getFirstOrNullObject()](/.trackedchangecollection#word-javascript/api/word/-trackedchangecollection-getfirstornullobject-member(1))|Gets the first TrackedChange in this collection.| +||[items](/.trackedchangecollection#word-javascript/api/word/-trackedchangecollection-items-member)|Gets the loaded child items in this collection.| +||[rejectAll()](/.trackedchangecollection#word-javascript/api/word/-trackedchangecollection-rejectall-member(1))|Rejects all the tracked changes in the collection.| diff --git a/docs/includes/word-1_7.md b/docs/includes/word-1_7.md index 883fe9cf5e..cdf77e66ec 100644 --- a/docs/includes/word-1_7.md +++ b/docs/includes/word-1_7.md @@ -1,35 +1,35 @@ | Class | Fields | Description | |:---|:---|:---| -|[Annotation](/javascript/api/word/word.annotation)|[critiqueAnnotation](/javascript/api/word/word.annotation#word-word-annotation-critiqueannotation-member)|Gets the critique annotation object.| -||[delete()](/javascript/api/word/word.annotation#word-word-annotation-delete-member(1))|Deletes the annotation.| -||[id](/javascript/api/word/word.annotation#word-word-annotation-id-member)|Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects.| -||[state](/javascript/api/word/word.annotation#word-word-annotation-state-member)|Gets the state of the annotation.| -|[AnnotationClickedEventArgs](/javascript/api/word/word.annotationclickedeventargs)|[id](/javascript/api/word/word.annotationclickedeventargs#word-word-annotationclickedeventargs-id-member)|Specifies the annotation ID for which the event was fired.| -|[AnnotationCollection](/javascript/api/word/word.annotationcollection)|[getFirst()](/javascript/api/word/word.annotationcollection#word-word-annotationcollection-getfirst-member(1))|Gets the first annotation in this collection.| -||[getFirstOrNullObject()](/javascript/api/word/word.annotationcollection#word-word-annotationcollection-getfirstornullobject-member(1))|Gets the first annotation in this collection.| -||[items](/javascript/api/word/word.annotationcollection#word-word-annotationcollection-items-member)|Gets the loaded child items in this collection.| -|[AnnotationHoveredEventArgs](/javascript/api/word/word.annotationhoveredeventargs)|[id](/javascript/api/word/word.annotationhoveredeventargs#word-word-annotationhoveredeventargs-id-member)|Specifies the annotation ID for which the event was fired.| -|[AnnotationInsertedEventArgs](/javascript/api/word/word.annotationinsertedeventargs)|[ids](/javascript/api/word/word.annotationinsertedeventargs#word-word-annotationinsertedeventargs-ids-member)|Specifies the annotation IDs for which the event was fired.| -|[AnnotationRemovedEventArgs](/javascript/api/word/word.annotationremovedeventargs)|[ids](/javascript/api/word/word.annotationremovedeventargs#word-word-annotationremovedeventargs-ids-member)|Specifies the annotation IDs for which the event was fired.| -|[AnnotationSet](/javascript/api/word/word.annotationset)|[critiques](/javascript/api/word/word.annotationset#word-word-annotationset-critiques-member)|Critiques.| -|[CheckboxContentControl](/javascript/api/word/word.checkboxcontentcontrol)|[isChecked](/javascript/api/word/word.checkboxcontentcontrol#word-word-checkboxcontentcontrol-ischecked-member)|Specifies the current state of the checkbox.| -|[ContentControl](/javascript/api/word/word.contentcontrol)|[checkboxContentControl](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-checkboxcontentcontrol-member)|Gets the data of the content control when its type is `CheckBox`.| -|[Critique](/javascript/api/word/word.critique)|[colorScheme](/javascript/api/word/word.critique#word-word-critique-colorscheme-member)|Specifies the color scheme of the critique.| -||[length](/javascript/api/word/word.critique#word-word-critique-length-member)|Specifies the length of the critique inside paragraph.| -||[start](/javascript/api/word/word.critique#word-word-critique-start-member)|Specifies the start index of the critique inside paragraph.| -|[CritiqueAnnotation](/javascript/api/word/word.critiqueannotation)|[accept()](/javascript/api/word/word.critiqueannotation#word-word-critiqueannotation-accept-member(1))|Accepts the critique.| -||[critique](/javascript/api/word/word.critiqueannotation#word-word-critiqueannotation-critique-member)|Gets the critique that was passed when the annotation was inserted.| -||[range](/javascript/api/word/word.critiqueannotation#word-word-critiqueannotation-range-member)|Gets the range of text that is annotated.| -||[reject()](/javascript/api/word/word.critiqueannotation#word-word-critiqueannotation-reject-member(1))|Rejects the critique.| -|[Document](/javascript/api/word/word.document)|[getAnnotationById(id: string)](/javascript/api/word/word.document#word-word-document-getannotationbyid-member(1))|Gets the annotation by ID.| -||[onAnnotationClicked](/javascript/api/word/word.document#word-word-document-onannotationclicked-member)|Occurs when the user clicks an annotation (or selects it using **Alt+Down**).| -||[onAnnotationHovered](/javascript/api/word/word.document#word-word-document-onannotationhovered-member)|Occurs when the user hovers the cursor over an annotation.| -||[onAnnotationInserted](/javascript/api/word/word.document#word-word-document-onannotationinserted-member)|Occurs when the user adds one or more annotations.| -||[onAnnotationRemoved](/javascript/api/word/word.document#word-word-document-onannotationremoved-member)|Occurs when the user deletes one or more annotations.| -||[search(searchText: string, searchOptions?: Word.SearchOptions \| { ignorePunct?: boolean ignoreSpace?: boolean matchCase?: boolean matchPrefix?: boolean matchSuffix?: boolean matchWholeWord?: boolean matchWildcards?: boolean })](/javascript/api/word/word.document#word-word-document-search-member(1))|Performs a search with the specified search options on the scope of the whole document.| -|[GetTextOptions](/javascript/api/word/word.gettextoptions)|[includeHiddenText](/javascript/api/word/word.gettextoptions#word-word-gettextoptions-includehiddentext-member)|Specifies a value that indicates whether to include hidden text in the result of the GetText method.| -||[includeTextMarkedAsDeleted](/javascript/api/word/word.gettextoptions#word-word-gettextoptions-includetextmarkedasdeleted-member)|Specifies a value that indicates whether to include text marked as deleted in the result of the GetText method.| -|[InsertFileOptions](/javascript/api/word/word.insertfileoptions)|[importDifferentOddEvenPages](/javascript/api/word/word.insertfileoptions#word-word-insertfileoptions-importdifferentoddevenpages-member)|Represents whether to import the Different Odd and Even Pages setting for the header and footer from the source document.| -|[Paragraph](/javascript/api/word/word.paragraph)|[getAnnotations()](/javascript/api/word/word.paragraph#word-word-paragraph-getannotations-member(1))|Gets annotations set on this Paragraph object.| -||[getText(options?: Word.GetTextOptions \| { IncludeHiddenText?: boolean IncludeTextMarkedAsDeleted?: boolean })](/javascript/api/word/word.paragraph#word-word-paragraph-gettext-member(1))|Returns the text of the paragraph.| -||[insertAnnotations(annotations: Word.AnnotationSet)](/javascript/api/word/word.paragraph#word-word-paragraph-insertannotations-member(1))|Inserts annotations on this Paragraph object.| +|[Annotation](/.annotation)|[critiqueAnnotation](/.annotation#word-javascript/api/word/-annotation-critiqueannotation-member)|Gets the critique annotation object.| +||[delete()](/.annotation#word-javascript/api/word/-annotation-delete-member(1))|Deletes the annotation.| +||[id](/.annotation#word-javascript/api/word/-annotation-id-member)|Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects.| +||[state](/.annotation#word-javascript/api/word/-annotation-state-member)|Gets the state of the annotation.| +|[AnnotationClickedEventArgs](/.annotationclickedeventargs)|[id](/.annotationclickedeventargs#word-javascript/api/word/-annotationclickedeventargs-id-member)|Specifies the annotation ID for which the event was fired.| +|[AnnotationCollection](/.annotationcollection)|[getFirst()](/.annotationcollection#word-javascript/api/word/-annotationcollection-getfirst-member(1))|Gets the first annotation in this collection.| +||[getFirstOrNullObject()](/.annotationcollection#word-javascript/api/word/-annotationcollection-getfirstornullobject-member(1))|Gets the first annotation in this collection.| +||[items](/.annotationcollection#word-javascript/api/word/-annotationcollection-items-member)|Gets the loaded child items in this collection.| +|[AnnotationHoveredEventArgs](/.annotationhoveredeventargs)|[id](/.annotationhoveredeventargs#word-javascript/api/word/-annotationhoveredeventargs-id-member)|Specifies the annotation ID for which the event was fired.| +|[AnnotationInsertedEventArgs](/.annotationinsertedeventargs)|[ids](/.annotationinsertedeventargs#word-javascript/api/word/-annotationinsertedeventargs-ids-member)|Specifies the annotation IDs for which the event was fired.| +|[AnnotationRemovedEventArgs](/.annotationremovedeventargs)|[ids](/.annotationremovedeventargs#word-javascript/api/word/-annotationremovedeventargs-ids-member)|Specifies the annotation IDs for which the event was fired.| +|[AnnotationSet](/.annotationset)|[critiques](/.annotationset#word-javascript/api/word/-annotationset-critiques-member)|Critiques.| +|[CheckboxContentControl](/.checkboxcontentcontrol)|[isChecked](/.checkboxcontentcontrol#word-javascript/api/word/-checkboxcontentcontrol-ischecked-member)|Specifies the current state of the checkbox.| +|[ContentControl](/.contentcontrol)|[checkboxContentControl](/.contentcontrol#word-javascript/api/word/-contentcontrol-checkboxcontentcontrol-member)|Gets the data of the content control when its type is `CheckBox`.| +|[Critique](/.critique)|[colorScheme](/.critique#word-javascript/api/word/-critique-colorscheme-member)|Specifies the color scheme of the critique.| +||[length](/.critique#word-javascript/api/word/-critique-length-member)|Specifies the length of the critique inside paragraph.| +||[start](/.critique#word-javascript/api/word/-critique-start-member)|Specifies the start index of the critique inside paragraph.| +|[CritiqueAnnotation](/.critiqueannotation)|[accept()](/.critiqueannotation#word-javascript/api/word/-critiqueannotation-accept-member(1))|Accepts the critique.| +||[critique](/.critiqueannotation#word-javascript/api/word/-critiqueannotation-critique-member)|Gets the critique that was passed when the annotation was inserted.| +||[range](/.critiqueannotation#word-javascript/api/word/-critiqueannotation-range-member)|Gets the range of text that is annotated.| +||[reject()](/.critiqueannotation#word-javascript/api/word/-critiqueannotation-reject-member(1))|Rejects the critique.| +|[Document](/.document)|[getAnnotationById(id: string)](/.document#word-javascript/api/word/-document-getannotationbyid-member(1))|Gets the annotation by ID.| +||[onAnnotationClicked](/.document#word-javascript/api/word/-document-onannotationclicked-member)|Occurs when the user clicks an annotation (or selects it using **Alt+Down**).| +||[onAnnotationHovered](/.document#word-javascript/api/word/-document-onannotationhovered-member)|Occurs when the user hovers the cursor over an annotation.| +||[onAnnotationInserted](/.document#word-javascript/api/word/-document-onannotationinserted-member)|Occurs when the user adds one or more annotations.| +||[onAnnotationRemoved](/.document#word-javascript/api/word/-document-onannotationremoved-member)|Occurs when the user deletes one or more annotations.| +||[search(searchText: string, searchOptions?: Word.SearchOptions \| { ignorePunct?: boolean ignoreSpace?: boolean matchCase?: boolean matchPrefix?: boolean matchSuffix?: boolean matchWholeWord?: boolean matchWildcards?: boolean })](/.document#word-javascript/api/word/-document-search-member(1))|Performs a search with the specified search options on the scope of the whole document.| +|[GetTextOptions](/.gettextoptions)|[includeHiddenText](/.gettextoptions#word-javascript/api/word/-gettextoptions-includehiddentext-member)|Specifies a value that indicates whether to include hidden text in the result of the GetText method.| +||[includeTextMarkedAsDeleted](/.gettextoptions#word-javascript/api/word/-gettextoptions-includetextmarkedasdeleted-member)|Specifies a value that indicates whether to include text marked as deleted in the result of the GetText method.| +|[InsertFileOptions](/.insertfileoptions)|[importDifferentOddEvenPages](/.insertfileoptions#word-javascript/api/word/-insertfileoptions-importdifferentoddevenpages-member)|Represents whether to import the Different Odd and Even Pages setting for the header and footer from the source document.| +|[Paragraph](/.paragraph)|[getAnnotations()](/.paragraph#word-javascript/api/word/-paragraph-getannotations-member(1))|Gets annotations set on this Paragraph object.| +||[getText(options?: Word.GetTextOptions \| { IncludeHiddenText?: boolean IncludeTextMarkedAsDeleted?: boolean })](/.paragraph#word-javascript/api/word/-paragraph-gettext-member(1))|Returns the text of the paragraph.| +||[insertAnnotations(annotations: Word.AnnotationSet)](/.paragraph#word-javascript/api/word/-paragraph-insertannotations-member(1))|Inserts annotations on this Paragraph object.| diff --git a/docs/includes/word-1_8.md b/docs/includes/word-1_8.md index 7059784241..3dd4b01dd8 100644 --- a/docs/includes/word-1_8.md +++ b/docs/includes/word-1_8.md @@ -1,13 +1,13 @@ | Class | Fields | Description | |:---|:---|:---| -|[AnnotationPopupActionEventArgs](/javascript/api/word/word.annotationpopupactioneventargs)|[action](/javascript/api/word/word.annotationpopupactioneventargs#word-word-annotationpopupactioneventargs-action-member)|Specifies the chosen action in the pop-up menu.| -||[critiqueSuggestion](/javascript/api/word/word.annotationpopupactioneventargs#word-word-annotationpopupactioneventargs-critiquesuggestion-member)|Specifies the accepted suggestion (only populated when accepting a critique suggestion).| -||[id](/javascript/api/word/word.annotationpopupactioneventargs#word-word-annotationpopupactioneventargs-id-member)|Specifies the annotation ID for which the event was fired.| -|[Critique](/javascript/api/word/word.critique)|[popupOptions](/javascript/api/word/word.critique#word-word-critique-popupoptions-member)|Specifies the behavior of the pop-up menu for the critique.| -|[CritiquePopupOptions](/javascript/api/word/word.critiquepopupoptions)|[brandingTextResourceId](/javascript/api/word/word.critiquepopupoptions#word-word-critiquepopupoptions-brandingtextresourceid-member)|Gets the manifest resource ID of the string to use for branding.| -||[subtitleResourceId](/javascript/api/word/word.critiquepopupoptions#word-word-critiquepopupoptions-subtitleresourceid-member)|Gets the manifest resource ID of the string to use as the subtitle.| -||[suggestions](/javascript/api/word/word.critiquepopupoptions#word-word-critiquepopupoptions-suggestions-member)|Gets the suggestions to display in the critique pop-up menu.| -||[titleResourceId](/javascript/api/word/word.critiquepopupoptions#word-word-critiquepopupoptions-titleresourceid-member)|Gets the manifest resource ID of the string to use as the title.| -|[Document](/javascript/api/word/word.document)|[onAnnotationPopupAction](/javascript/api/word/word.document#word-word-document-onannotationpopupaction-member)|Occurs when the user performs an action in an annotation pop-up menu.| -|[Range](/javascript/api/word/word.range)|[highlight()](/javascript/api/word/word.range#word-word-range-highlight-member(1))|Highlights the range temporarily without changing document content.| -||[removeHighlight()](/javascript/api/word/word.range#word-word-range-removehighlight-member(1))|Removes the highlight added by the Highlight function if any.| +|[AnnotationPopupActionEventArgs](/.annotationpopupactioneventargs)|[action](/.annotationpopupactioneventargs#word-javascript/api/word/-annotationpopupactioneventargs-action-member)|Specifies the chosen action in the pop-up menu.| +||[critiqueSuggestion](/.annotationpopupactioneventargs#word-javascript/api/word/-annotationpopupactioneventargs-critiquesuggestion-member)|Specifies the accepted suggestion (only populated when accepting a critique suggestion).| +||[id](/.annotationpopupactioneventargs#word-javascript/api/word/-annotationpopupactioneventargs-id-member)|Specifies the annotation ID for which the event was fired.| +|[Critique](/.critique)|[popupOptions](/.critique#word-javascript/api/word/-critique-popupoptions-member)|Specifies the behavior of the pop-up menu for the critique.| +|[CritiquePopupOptions](/.critiquepopupoptions)|[brandingTextResourceId](/.critiquepopupoptions#word-javascript/api/word/-critiquepopupoptions-brandingtextresourceid-member)|Gets the manifest resource ID of the string to use for branding.| +||[subtitleResourceId](/.critiquepopupoptions#word-javascript/api/word/-critiquepopupoptions-subtitleresourceid-member)|Gets the manifest resource ID of the string to use as the subtitle.| +||[suggestions](/.critiquepopupoptions#word-javascript/api/word/-critiquepopupoptions-suggestions-member)|Gets the suggestions to display in the critique pop-up menu.| +||[titleResourceId](/.critiquepopupoptions#word-javascript/api/word/-critiquepopupoptions-titleresourceid-member)|Gets the manifest resource ID of the string to use as the title.| +|[Document](/.document)|[onAnnotationPopupAction](/.document#word-javascript/api/word/-document-onannotationpopupaction-member)|Occurs when the user performs an action in an annotation pop-up menu.| +|[Range](/.range)|[highlight()](/.range#word-javascript/api/word/-range-highlight-member(1))|Highlights the range temporarily without changing document content.| +||[removeHighlight()](/.range#word-javascript/api/word/-range-removehighlight-member(1))|Removes the highlight added by the Highlight function if any.| diff --git a/docs/includes/word-1_9.md b/docs/includes/word-1_9.md index 66c5486496..273886aece 100644 --- a/docs/includes/word-1_9.md +++ b/docs/includes/word-1_9.md @@ -1,18 +1,62 @@ | Class | Fields | Description | |:---|:---|:---| -|[ComboBoxContentControl](/javascript/api/word/word.comboboxcontentcontrol)|[addListItem(displayText: string, value?: string, index?: number)](/javascript/api/word/word.comboboxcontentcontrol#word-word-comboboxcontentcontrol-addlistitem-member(1))|Adds a new list item to this combo box content control and returns a Word.ContentControlListItem object.| -||[deleteAllListItems()](/javascript/api/word/word.comboboxcontentcontrol#word-word-comboboxcontentcontrol-deletealllistitems-member(1))|Deletes all list items in this combo box content control.| -||[listItems](/javascript/api/word/word.comboboxcontentcontrol#word-word-comboboxcontentcontrol-listitems-member)|Gets the collection of list items in the combo box content control.| -|[ContentControl](/javascript/api/word/word.contentcontrol)|[comboBoxContentControl](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-comboboxcontentcontrol-member)|Gets the data of the content control when its type is `ComboBox`.| -||[dropDownListContentControl](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-dropdownlistcontentcontrol-member)|Gets the data of the content control when its type is `DropDownList`.| -|[ContentControlListItem](/javascript/api/word/word.contentcontrollistitem)|[delete()](/javascript/api/word/word.contentcontrollistitem#word-word-contentcontrollistitem-delete-member(1))|Deletes the list item.| -||[displayText](/javascript/api/word/word.contentcontrollistitem#word-word-contentcontrollistitem-displaytext-member)|Specifies the display text of a list item for a dropdown list or combo box content control.| -||[index](/javascript/api/word/word.contentcontrollistitem#word-word-contentcontrollistitem-index-member)|Specifies the index location of a content control list item in the collection of list items.| -||[select()](/javascript/api/word/word.contentcontrollistitem#word-word-contentcontrollistitem-select-member(1))|Selects the list item and sets the text of the content control to the value of the list item.| -||[value](/javascript/api/word/word.contentcontrollistitem#word-word-contentcontrollistitem-value-member)|Specifies the programmatic value of a list item for a dropdown list or combo box content control.| -|[ContentControlListItemCollection](/javascript/api/word/word.contentcontrollistitemcollection)|[getFirst()](/javascript/api/word/word.contentcontrollistitemcollection#word-word-contentcontrollistitemcollection-getfirst-member(1))|Gets the first list item in this collection.| -||[getFirstOrNullObject()](/javascript/api/word/word.contentcontrollistitemcollection#word-word-contentcontrollistitemcollection-getfirstornullobject-member(1))|Gets the first list item in this collection.| -||[items](/javascript/api/word/word.contentcontrollistitemcollection#word-word-contentcontrollistitemcollection-items-member)|Gets the loaded child items in this collection.| -|[DropDownListContentControl](/javascript/api/word/word.dropdownlistcontentcontrol)|[addListItem(displayText: string, value?: string, index?: number)](/javascript/api/word/word.dropdownlistcontentcontrol#word-word-dropdownlistcontentcontrol-addlistitem-member(1))|Adds a new list item to this dropdown list content control and returns a Word.ContentControlListItem object.| -||[deleteAllListItems()](/javascript/api/word/word.dropdownlistcontentcontrol#word-word-dropdownlistcontentcontrol-deletealllistitems-member(1))|Deletes all list items in this dropdown list content control.| -||[listItems](/javascript/api/word/word.dropdownlistcontentcontrol#word-word-dropdownlistcontentcontrol-listitems-member)|Gets the collection of list items in the dropdown list content control.| +|[ComboBoxContentControl](/.comboboxcontentcontrol)|[addListItem(displayText: string, value?: string, index?: number)](/.comboboxcontentcontrol#word-javascript/api/word/-comboboxcontentcontrol-addlistitem-member(1))|Adds a new list item to this combo box content control and returns a Word.ContentControlListItem object.| +||[context](/.comboboxcontentcontrol#word-javascript/api/word/-comboboxcontentcontrol-context-member)|The request context associated with the object.| +||[deleteAllListItems()](/.comboboxcontentcontrol#word-javascript/api/word/-comboboxcontentcontrol-deletealllistitems-member(1))|Deletes all list items in this combo box content control.| +||[listItems](/.comboboxcontentcontrol#word-javascript/api/word/-comboboxcontentcontrol-listitems-member)|Gets the collection of list items in the combo box content control.| +||[load(propertyNames?: string \| string[])](/.comboboxcontentcontrol#word-javascript/api/word/-comboboxcontentcontrol-load-member(1))|Queues up a command to load the specified properties of the object.| +||[load(propertyNamesAndPaths?: { select?: string expand?: string })](/.comboboxcontentcontrol#word-javascript/api/word/-comboboxcontentcontrol-load-member(1))|Queues up a command to load the specified properties of the object.| +||[toJSON()](/.comboboxcontentcontrol#word-javascript/api/word/-comboboxcontentcontrol-tojson-member(1))|Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`.| +||[track()](/.comboboxcontentcontrol#word-javascript/api/word/-comboboxcontentcontrol-track-member(1))|Track the object for automatic adjustment based on surrounding changes in the document.| +||[untrack()](/.comboboxcontentcontrol#word-javascript/api/word/-comboboxcontentcontrol-untrack-member(1))|Release the memory associated with this object, if it has previously been tracked.| +|[ContentControl](/.contentcontrol)|[comboBoxContentControl](/.contentcontrol#word-javascript/api/word/-contentcontrol-comboboxcontentcontrol-member)|Gets the data of the content control when its type is `ComboBox`.| +||[dropDownListContentControl](/.contentcontrol#word-javascript/api/word/-contentcontrol-dropdownlistcontentcontrol-member)|Gets the data of the content control when its type is `DropDownList`.| +|[ContentControlData](/.contentcontroldata)|[comboBoxContentControl](/.contentcontroldata#word-javascript/api/word/-contentcontroldata-comboboxcontentcontrol-member)|Gets the data of the content control when its type is `ComboBox`.| +||[dropDownListContentControl](/.contentcontroldata#word-javascript/api/word/-contentcontroldata-dropdownlistcontentcontrol-member)|Gets the data of the content control when its type is `DropDownList`.| +|[ContentControlListItem](/.contentcontrollistitem)|[context](/.contentcontrollistitem#word-javascript/api/word/-contentcontrollistitem-context-member)|The request context associated with the object.| +||[delete()](/.contentcontrollistitem#word-javascript/api/word/-contentcontrollistitem-delete-member(1))|Deletes the list item.| +||[displayText](/.contentcontrollistitem#word-javascript/api/word/-contentcontrollistitem-displaytext-member)|Specifies the display text of a list item for a dropdown list or combo box content control.| +||[index](/.contentcontrollistitem#word-javascript/api/word/-contentcontrollistitem-index-member)|Specifies the index location of a content control list item in the collection of list items.| +||[load(options?: Word.Interfaces.ContentControlListItemLoadOptions)](/.contentcontrollistitem#word-javascript/api/word/-contentcontrollistitem-load-member(1))|Queues up a command to load the specified properties of the object.| +||[load(propertyNames?: string \| string[])](/.contentcontrollistitem#word-javascript/api/word/-contentcontrollistitem-load-member(1))|Queues up a command to load the specified properties of the object.| +||[load(propertyNamesAndPaths?: { select?: string expand?: string })](/.contentcontrollistitem#word-javascript/api/word/-contentcontrollistitem-load-member(1))|Queues up a command to load the specified properties of the object.| +||[select()](/.contentcontrollistitem#word-javascript/api/word/-contentcontrollistitem-select-member(1))|Selects the list item and sets the text of the content control to the value of the list item.| +||[set(properties: Interfaces.ContentControlListItemUpdateData, options?: OfficeExtension.UpdateOptions)](/.contentcontrollistitem#word-javascript/api/word/-contentcontrollistitem-set-member(1))|Sets multiple properties of an object at the same time.| +||[set(properties: Word.ContentControlListItem)](/.contentcontrollistitem#word-javascript/api/word/-contentcontrollistitem-set-member(1))|Sets multiple properties on the object at the same time, based on an existing loaded object.| +||[toJSON()](/.contentcontrollistitem#word-javascript/api/word/-contentcontrollistitem-tojson-member(1))|Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`.| +||[track()](/.contentcontrollistitem#word-javascript/api/word/-contentcontrollistitem-track-member(1))|Track the object for automatic adjustment based on surrounding changes in the document.| +||[untrack()](/.contentcontrollistitem#word-javascript/api/word/-contentcontrollistitem-untrack-member(1))|Release the memory associated with this object, if it has previously been tracked.| +||[value](/.contentcontrollistitem#word-javascript/api/word/-contentcontrollistitem-value-member)|Specifies the programmatic value of a list item for a dropdown list or combo box content control.| +|[ContentControlListItemCollection](/.contentcontrollistitemcollection)|[context](/.contentcontrollistitemcollection#word-javascript/api/word/-contentcontrollistitemcollection-context-member)|The request context associated with the object.| +||[getFirst()](/.contentcontrollistitemcollection#word-javascript/api/word/-contentcontrollistitemcollection-getfirst-member(1))|Gets the first list item in this collection.| +||[getFirstOrNullObject()](/.contentcontrollistitemcollection#word-javascript/api/word/-contentcontrollistitemcollection-getfirstornullobject-member(1))|Gets the first list item in this collection.| +||[items](/.contentcontrollistitemcollection#word-javascript/api/word/-contentcontrollistitemcollection-items-member)|Gets the loaded child items in this collection.| +||[load(options?: Word.Interfaces.ContentControlListItemCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions)](/.contentcontrollistitemcollection#word-javascript/api/word/-contentcontrollistitemcollection-load-member(1))|Queues up a command to load the specified properties of the object.| +||[load(propertyNames?: string \| string[])](/.contentcontrollistitemcollection#word-javascript/api/word/-contentcontrollistitemcollection-load-member(1))|Queues up a command to load the specified properties of the object.| +||[load(propertyNamesAndPaths?: OfficeExtension.LoadOption)](/.contentcontrollistitemcollection#word-javascript/api/word/-contentcontrollistitemcollection-load-member(1))|Queues up a command to load the specified properties of the object.| +||[toJSON()](/.contentcontrollistitemcollection#word-javascript/api/word/-contentcontrollistitemcollection-tojson-member(1))|Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`.| +||[track()](/.contentcontrollistitemcollection#word-javascript/api/word/-contentcontrollistitemcollection-track-member(1))|Track the object for automatic adjustment based on surrounding changes in the document.| +||[untrack()](/.contentcontrollistitemcollection#word-javascript/api/word/-contentcontrollistitemcollection-untrack-member(1))|Release the memory associated with this object, if it has previously been tracked.| +|[ContentControlListItemCollectionLoadOptions](/.contentcontrollistitemcollectionloadoptions)|[$all](/.contentcontrollistitemcollectionloadoptions#word-javascript/api/word/-contentcontrollistitemcollectionloadoptions-$all-member)|**| +||[displayText](/.contentcontrollistitemcollectionloadoptions#word-javascript/api/word/-contentcontrollistitemcollectionloadoptions-displaytext-member)|For EACH ITEM in the collection: Specifies the display text of a list item for a dropdown list or combo box content control.| +||[index](/.contentcontrollistitemcollectionloadoptions#word-javascript/api/word/-contentcontrollistitemcollectionloadoptions-index-member)|For EACH ITEM in the collection: Specifies the index location of a content control list item in the collection of list items.| +||[value](/.contentcontrollistitemcollectionloadoptions#word-javascript/api/word/-contentcontrollistitemcollectionloadoptions-value-member)|For EACH ITEM in the collection: Specifies the programmatic value of a list item for a dropdown list or combo box content control.| +|[ContentControlListItemData](/.contentcontrollistitemdata)|[displayText](/.contentcontrollistitemdata#word-javascript/api/word/-contentcontrollistitemdata-displaytext-member)|Specifies the display text of a list item for a dropdown list or combo box content control.| +||[index](/.contentcontrollistitemdata#word-javascript/api/word/-contentcontrollistitemdata-index-member)|Specifies the index location of a content control list item in the collection of list items.| +||[value](/.contentcontrollistitemdata#word-javascript/api/word/-contentcontrollistitemdata-value-member)|Specifies the programmatic value of a list item for a dropdown list or combo box content control.| +|[ContentControlListItemLoadOptions](/.contentcontrollistitemloadoptions)|[$all](/.contentcontrollistitemloadoptions#word-javascript/api/word/-contentcontrollistitemloadoptions-$all-member)|**| +||[displayText](/.contentcontrollistitemloadoptions#word-javascript/api/word/-contentcontrollistitemloadoptions-displaytext-member)|Specifies the display text of a list item for a dropdown list or combo box content control.| +||[index](/.contentcontrollistitemloadoptions#word-javascript/api/word/-contentcontrollistitemloadoptions-index-member)|Specifies the index location of a content control list item in the collection of list items.| +||[value](/.contentcontrollistitemloadoptions#word-javascript/api/word/-contentcontrollistitemloadoptions-value-member)|Specifies the programmatic value of a list item for a dropdown list or combo box content control.| +|[ContentControlListItemUpdateData](/.contentcontrollistitemupdatedata)|[displayText](/.contentcontrollistitemupdatedata#word-javascript/api/word/-contentcontrollistitemupdatedata-displaytext-member)|Specifies the display text of a list item for a dropdown list or combo box content control.| +||[index](/.contentcontrollistitemupdatedata#word-javascript/api/word/-contentcontrollistitemupdatedata-index-member)|Specifies the index location of a content control list item in the collection of list items.| +||[value](/.contentcontrollistitemupdatedata#word-javascript/api/word/-contentcontrollistitemupdatedata-value-member)|Specifies the programmatic value of a list item for a dropdown list or combo box content control.| +|[DropDownListContentControl](/.dropdownlistcontentcontrol)|[addListItem(displayText: string, value?: string, index?: number)](/.dropdownlistcontentcontrol#word-javascript/api/word/-dropdownlistcontentcontrol-addlistitem-member(1))|Adds a new list item to this dropdown list content control and returns a Word.ContentControlListItem object.| +||[context](/.dropdownlistcontentcontrol#word-javascript/api/word/-dropdownlistcontentcontrol-context-member)|The request context associated with the object.| +||[deleteAllListItems()](/.dropdownlistcontentcontrol#word-javascript/api/word/-dropdownlistcontentcontrol-deletealllistitems-member(1))|Deletes all list items in this dropdown list content control.| +||[listItems](/.dropdownlistcontentcontrol#word-javascript/api/word/-dropdownlistcontentcontrol-listitems-member)|Gets the collection of list items in the dropdown list content control.| +||[load(propertyNames?: string \| string[])](/.dropdownlistcontentcontrol#word-javascript/api/word/-dropdownlistcontentcontrol-load-member(1))|Queues up a command to load the specified properties of the object.| +||[load(propertyNamesAndPaths?: { select?: string expand?: string })](/.dropdownlistcontentcontrol#word-javascript/api/word/-dropdownlistcontentcontrol-load-member(1))|Queues up a command to load the specified properties of the object.| +||[toJSON()](/.dropdownlistcontentcontrol#word-javascript/api/word/-dropdownlistcontentcontrol-tojson-member(1))|Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`.| +||[track()](/.dropdownlistcontentcontrol#word-javascript/api/word/-dropdownlistcontentcontrol-track-member(1))|Track the object for automatic adjustment based on surrounding changes in the document.| +||[untrack()](/.dropdownlistcontentcontrol#word-javascript/api/word/-dropdownlistcontentcontrol-untrack-member(1))|Release the memory associated with this object, if it has previously been tracked.| diff --git a/docs/includes/word-desktop-1_1.md b/docs/includes/word-desktop-1_1.md index 65488d2c8a..03457fe9c5 100644 --- a/docs/includes/word-desktop-1_1.md +++ b/docs/includes/word-desktop-1_1.md @@ -1,55 +1,55 @@ | Class | Fields | Description | |:---|:---|:---| -|[Border](/javascript/api/word/word.border)|[color](/javascript/api/word/word.border#word-word-border-color-member)|Specifies the color for the border.| -||[location](/javascript/api/word/word.border#word-word-border-location-member)|Gets the location of the border.| -||[type](/javascript/api/word/word.border#word-word-border-type-member)|Specifies the border type for the border.| -||[visible](/javascript/api/word/word.border#word-word-border-visible-member)|Specifies whether the border is visible.| -||[width](/javascript/api/word/word.border#word-word-border-width-member)|Specifies the width for the border.| -|[BorderCollection](/javascript/api/word/word.bordercollection)|[getByLocation(borderLocation: Word.BorderLocation.top \| Word.BorderLocation.left \| Word.BorderLocation.bottom \| Word.BorderLocation.right \| Word.BorderLocation.insideHorizontal \| Word.BorderLocation.insideVertical \| "Top" \| "Left" \| "Bottom" \| "Right" \| "InsideHorizontal" \| "InsideVertical")](/javascript/api/word/word.bordercollection#word-word-bordercollection-getbylocation-member(1))|Gets the border that has the specified location.| -||[getFirst()](/javascript/api/word/word.bordercollection#word-word-bordercollection-getfirst-member(1))|Gets the first border in this collection.| -||[getFirstOrNullObject()](/javascript/api/word/word.bordercollection#word-word-bordercollection-getfirstornullobject-member(1))|Gets the first border in this collection.| -||[getItem(index: number)](/javascript/api/word/word.bordercollection#word-word-bordercollection-getitem-member(1))|Gets a Border object by its index in the collection.| -||[insideBorderColor](/javascript/api/word/word.bordercollection#word-word-bordercollection-insidebordercolor-member)|Specifies the 24-bit color of the inside borders.| -||[insideBorderType](/javascript/api/word/word.bordercollection#word-word-bordercollection-insidebordertype-member)|Specifies the border type of the inside borders.| -||[insideBorderWidth](/javascript/api/word/word.bordercollection#word-word-bordercollection-insideborderwidth-member)|Specifies the width of the inside borders.| -||[items](/javascript/api/word/word.bordercollection#word-word-bordercollection-items-member)|Gets the loaded child items in this collection.| -||[outsideBorderColor](/javascript/api/word/word.bordercollection#word-word-bordercollection-outsidebordercolor-member)|Specifies the 24-bit color of the outside borders.| -||[outsideBorderType](/javascript/api/word/word.bordercollection#word-word-bordercollection-outsidebordertype-member)|Specifies the border type of the outside borders.| -||[outsideBorderWidth](/javascript/api/word/word.bordercollection#word-word-bordercollection-outsideborderwidth-member)|Specifies the width of the outside borders.| -|[Document](/javascript/api/word/word.document)|[compare(filePath: string, documentCompareOptions?: Word.DocumentCompareOptions)](/javascript/api/word/word.document#word-word-document-compare-member(1))|Displays revision marks that indicate where the specified document differs from another document.| -|[DocumentCompareOptions](/javascript/api/word/word.documentcompareoptions)|[addToRecentFiles](/javascript/api/word/word.documentcompareoptions#word-word-documentcompareoptions-addtorecentfiles-member)|True adds the document to the list of recently used files on the File menu.| -||[authorName](/javascript/api/word/word.documentcompareoptions#word-word-documentcompareoptions-authorname-member)|The reviewer name associated with the differences generated by the comparison.| -||[compareTarget](/javascript/api/word/word.documentcompareoptions#word-word-documentcompareoptions-comparetarget-member)|The target document for the comparison.| -||[detectFormatChanges](/javascript/api/word/word.documentcompareoptions#word-word-documentcompareoptions-detectformatchanges-member)|True (default) for the comparison to include detection of format changes.| -||[ignoreAllComparisonWarnings](/javascript/api/word/word.documentcompareoptions#word-word-documentcompareoptions-ignoreallcomparisonwarnings-member)|True compares the documents without notifying a user of problems.| -||[removeDateAndTime](/javascript/api/word/word.documentcompareoptions#word-word-documentcompareoptions-removedateandtime-member)|True removes date and time stamp information from tracked changes in the returned Document object.| -||[removePersonalInformation](/javascript/api/word/word.documentcompareoptions#word-word-documentcompareoptions-removepersonalinformation-member)|True removes all user information from comments, revisions, and the properties dialog box in the returned Document object.| -|[Field](/javascript/api/word/word.field)|[showCodes](/javascript/api/word/word.field#word-word-field-showcodes-member)|Specifies whether the field codes are displayed for the specified field.| -|[InlinePicture](/javascript/api/word/word.inlinepicture)|[imageFormat](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-imageformat-member)|Gets the format of the inline image.| -|[List](/javascript/api/word/word.list)|[getLevelFont(level: number)](/javascript/api/word/word.list#word-word-list-getlevelfont-member(1))|Gets the font of the bullet, number, or picture at the specified level in the list.| -||[getLevelPicture(level: number)](/javascript/api/word/word.list#word-word-list-getlevelpicture-member(1))|Gets the Base64-encoded string representation of the picture at the specified level in the list.| -||[resetLevelFont(level: number, resetFontName?: boolean)](/javascript/api/word/word.list#word-word-list-resetlevelfont-member(1))|Resets the font of the bullet, number, or picture at the specified level in the list.| -||[setLevelPicture(level: number, base64EncodedImage?: string)](/javascript/api/word/word.list#word-word-list-setlevelpicture-member(1))|Sets the picture at the specified level in the list.| -|[ListLevel](/javascript/api/word/word.listlevel)|[alignment](/javascript/api/word/word.listlevel#word-word-listlevel-alignment-member)|Specifies the horizontal alignment of the list level.| -||[font](/javascript/api/word/word.listlevel#word-word-listlevel-font-member)|Gets a Font object that represents the character formatting of the specified object.| -||[linkedStyle](/javascript/api/word/word.listlevel#word-word-listlevel-linkedstyle-member)|Specifies the name of the style that's linked to the specified list level object.| -||[numberFormat](/javascript/api/word/word.listlevel#word-word-listlevel-numberformat-member)|Specifies the number format for the specified list level.| -||[numberPosition](/javascript/api/word/word.listlevel#word-word-listlevel-numberposition-member)|Specifies the position (in points) of the number or bullet for the specified list level object.| -||[numberStyle](/javascript/api/word/word.listlevel#word-word-listlevel-numberstyle-member)|Specifies the number style for the list level object.| -||[resetOnHigher](/javascript/api/word/word.listlevel#word-word-listlevel-resetonhigher-member)|Specifies the list level that must appear before the specified list level restarts numbering at 1.| -||[startAt](/javascript/api/word/word.listlevel#word-word-listlevel-startat-member)|Specifies the starting number for the specified list level object.| -||[tabPosition](/javascript/api/word/word.listlevel#word-word-listlevel-tabposition-member)|Specifies the tab position for the specified list level object.| -||[textPosition](/javascript/api/word/word.listlevel#word-word-listlevel-textposition-member)|Specifies the position (in points) for the second line of wrapping text for the specified list level object.| -||[trailingCharacter](/javascript/api/word/word.listlevel#word-word-listlevel-trailingcharacter-member)|Specifies the character inserted after the number for the specified list level.| -|[ListLevelCollection](/javascript/api/word/word.listlevelcollection)|[getFirst()](/javascript/api/word/word.listlevelcollection#word-word-listlevelcollection-getfirst-member(1))|Gets the first list level in this collection.| -||[getFirstOrNullObject()](/javascript/api/word/word.listlevelcollection#word-word-listlevelcollection-getfirstornullobject-member(1))|Gets the first list level in this collection.| -||[items](/javascript/api/word/word.listlevelcollection#word-word-listlevelcollection-items-member)|Gets the loaded child items in this collection.| -|[ListTemplate](/javascript/api/word/word.listtemplate)|[listLevels](/javascript/api/word/word.listtemplate#word-word-listtemplate-listlevels-member)|Gets a `ListLevelCollection` object that represents all the levels for the list template.| -||[outlineNumbered](/javascript/api/word/word.listtemplate#word-word-listtemplate-outlinenumbered-member)|Specifies whether the list template is outline numbered.| -|[Shading](/javascript/api/word/word.shading)|[foregroundPatternColor](/javascript/api/word/word.shading#word-word-shading-foregroundpatterncolor-member)|Specifies the color for the foreground of the object.| -||[texture](/javascript/api/word/word.shading#word-word-shading-texture-member)|Specifies the shading texture of the object.| -|[Style](/javascript/api/word/word.style)|[borders](/javascript/api/word/word.style#word-word-style-borders-member)|Specifies a BorderCollection object that represents all the borders for the specified style.| -||[listTemplate](/javascript/api/word/word.style#word-word-style-listtemplate-member)|Gets a ListTemplate object that represents the list formatting for the specified Style object.| -|[TableRow](/javascript/api/word/word.tablerow)|[insertContentControl()](/javascript/api/word/word.tablerow#word-word-tablerow-insertcontentcontrol-member(1))|Inserts a content control on the row.| -|[TableStyle](/javascript/api/word/word.tablestyle)|[alignment](/javascript/api/word/word.tablestyle#word-word-tablestyle-alignment-member)|Specifies the table's alignment against the page margin.| -||[allowBreakAcrossPage](/javascript/api/word/word.tablestyle#word-word-tablestyle-allowbreakacrosspage-member)|Specifies whether lines in tables formatted with a specified style break across pages.| +|[Border](/.border)|[color](/.border#word-javascript/api/word/-border-color-member)|Specifies the color for the border.| +||[location](/.border#word-javascript/api/word/-border-location-member)|Gets the location of the border.| +||[type](/.border#word-javascript/api/word/-border-type-member)|Specifies the border type for the border.| +||[visible](/.border#word-javascript/api/word/-border-visible-member)|Specifies whether the border is visible.| +||[width](/.border#word-javascript/api/word/-border-width-member)|Specifies the width for the border.| +|[BorderCollection](/.bordercollection)|[getByLocation(borderLocation: Word.BorderLocation.top \| Word.BorderLocation.left \| Word.BorderLocation.bottom \| Word.BorderLocation.right \| Word.BorderLocation.insideHorizontal \| Word.BorderLocation.insideVertical \| "Top" \| "Left" \| "Bottom" \| "Right" \| "InsideHorizontal" \| "InsideVertical")](/.bordercollection#word-javascript/api/word/-bordercollection-getbylocation-member(1))|Gets the border that has the specified location.| +||[getFirst()](/.bordercollection#word-javascript/api/word/-bordercollection-getfirst-member(1))|Gets the first border in this collection.| +||[getFirstOrNullObject()](/.bordercollection#word-javascript/api/word/-bordercollection-getfirstornullobject-member(1))|Gets the first border in this collection.| +||[getItem(index: number)](/.bordercollection#word-javascript/api/word/-bordercollection-getitem-member(1))|Gets a Border object by its index in the collection.| +||[insideBorderColor](/.bordercollection#word-javascript/api/word/-bordercollection-insidebordercolor-member)|Specifies the 24-bit color of the inside borders.| +||[insideBorderType](/.bordercollection#word-javascript/api/word/-bordercollection-insidebordertype-member)|Specifies the border type of the inside borders.| +||[insideBorderWidth](/.bordercollection#word-javascript/api/word/-bordercollection-insideborderwidth-member)|Specifies the width of the inside borders.| +||[items](/.bordercollection#word-javascript/api/word/-bordercollection-items-member)|Gets the loaded child items in this collection.| +||[outsideBorderColor](/.bordercollection#word-javascript/api/word/-bordercollection-outsidebordercolor-member)|Specifies the 24-bit color of the outside borders.| +||[outsideBorderType](/.bordercollection#word-javascript/api/word/-bordercollection-outsidebordertype-member)|Specifies the border type of the outside borders.| +||[outsideBorderWidth](/.bordercollection#word-javascript/api/word/-bordercollection-outsideborderwidth-member)|Specifies the width of the outside borders.| +|[Document](/.document)|[compare(filePath: string, documentCompareOptions?: Word.DocumentCompareOptions)](/.document#word-javascript/api/word/-document-compare-member(1))|Displays revision marks that indicate where the specified document differs from another document.| +|[DocumentCompareOptions](/.documentcompareoptions)|[addToRecentFiles](/.documentcompareoptions#word-javascript/api/word/-documentcompareoptions-addtorecentfiles-member)|True adds the document to the list of recently used files on the File menu.| +||[authorName](/.documentcompareoptions#word-javascript/api/word/-documentcompareoptions-authorname-member)|The reviewer name associated with the differences generated by the comparison.| +||[compareTarget](/.documentcompareoptions#word-javascript/api/word/-documentcompareoptions-comparetarget-member)|The target document for the comparison.| +||[detectFormatChanges](/.documentcompareoptions#word-javascript/api/word/-documentcompareoptions-detectformatchanges-member)|True (default) for the comparison to include detection of format changes.| +||[ignoreAllComparisonWarnings](/.documentcompareoptions#word-javascript/api/word/-documentcompareoptions-ignoreallcomparisonwarnings-member)|True compares the documents without notifying a user of problems.| +||[removeDateAndTime](/.documentcompareoptions#word-javascript/api/word/-documentcompareoptions-removedateandtime-member)|True removes date and time stamp information from tracked changes in the returned Document object.| +||[removePersonalInformation](/.documentcompareoptions#word-javascript/api/word/-documentcompareoptions-removepersonalinformation-member)|True removes all user information from comments, revisions, and the properties dialog box in the returned Document object.| +|[Field](/.field)|[showCodes](/.field#word-javascript/api/word/-field-showcodes-member)|Specifies whether the field codes are displayed for the specified field.| +|[InlinePicture](/.inlinepicture)|[imageFormat](/.inlinepicture#word-javascript/api/word/-inlinepicture-imageformat-member)|Gets the format of the inline image.| +|[List](/.list)|[getLevelFont(level: number)](/.list#word-javascript/api/word/-list-getlevelfont-member(1))|Gets the font of the bullet, number, or picture at the specified level in the list.| +||[getLevelPicture(level: number)](/.list#word-javascript/api/word/-list-getlevelpicture-member(1))|Gets the Base64-encoded string representation of the picture at the specified level in the list.| +||[resetLevelFont(level: number, resetFontName?: boolean)](/.list#word-javascript/api/word/-list-resetlevelfont-member(1))|Resets the font of the bullet, number, or picture at the specified level in the list.| +||[setLevelPicture(level: number, base64EncodedImage?: string)](/.list#word-javascript/api/word/-list-setlevelpicture-member(1))|Sets the picture at the specified level in the list.| +|[ListLevel](/.listlevel)|[alignment](/.listlevel#word-javascript/api/word/-listlevel-alignment-member)|Specifies the horizontal alignment of the list level.| +||[font](/.listlevel#word-javascript/api/word/-listlevel-font-member)|Gets a Font object that represents the character formatting of the specified object.| +||[linkedStyle](/.listlevel#word-javascript/api/word/-listlevel-linkedstyle-member)|Specifies the name of the style that's linked to the specified list level object.| +||[numberFormat](/.listlevel#word-javascript/api/word/-listlevel-numberformat-member)|Specifies the number format for the specified list level.| +||[numberPosition](/.listlevel#word-javascript/api/word/-listlevel-numberposition-member)|Specifies the position (in points) of the number or bullet for the specified list level object.| +||[numberStyle](/.listlevel#word-javascript/api/word/-listlevel-numberstyle-member)|Specifies the number style for the list level object.| +||[resetOnHigher](/.listlevel#word-javascript/api/word/-listlevel-resetonhigher-member)|Specifies the list level that must appear before the specified list level restarts numbering at 1.| +||[startAt](/.listlevel#word-javascript/api/word/-listlevel-startat-member)|Specifies the starting number for the specified list level object.| +||[tabPosition](/.listlevel#word-javascript/api/word/-listlevel-tabposition-member)|Specifies the tab position for the specified list level object.| +||[textPosition](/.listlevel#word-javascript/api/word/-listlevel-textposition-member)|Specifies the position (in points) for the second line of wrapping text for the specified list level object.| +||[trailingCharacter](/.listlevel#word-javascript/api/word/-listlevel-trailingcharacter-member)|Specifies the character inserted after the number for the specified list level.| +|[ListLevelCollection](/.listlevelcollection)|[getFirst()](/.listlevelcollection#word-javascript/api/word/-listlevelcollection-getfirst-member(1))|Gets the first list level in this collection.| +||[getFirstOrNullObject()](/.listlevelcollection#word-javascript/api/word/-listlevelcollection-getfirstornullobject-member(1))|Gets the first list level in this collection.| +||[items](/.listlevelcollection#word-javascript/api/word/-listlevelcollection-items-member)|Gets the loaded child items in this collection.| +|[ListTemplate](/.listtemplate)|[listLevels](/.listtemplate#word-javascript/api/word/-listtemplate-listlevels-member)|Gets a `ListLevelCollection` object that represents all the levels for the list template.| +||[outlineNumbered](/.listtemplate#word-javascript/api/word/-listtemplate-outlinenumbered-member)|Specifies whether the list template is outline numbered.| +|[Shading](/.shading)|[foregroundPatternColor](/.shading#word-javascript/api/word/-shading-foregroundpatterncolor-member)|Specifies the color for the foreground of the object.| +||[texture](/.shading#word-javascript/api/word/-shading-texture-member)|Specifies the shading texture of the object.| +|[Style](/.style)|[borders](/.style#word-javascript/api/word/-style-borders-member)|Specifies a BorderCollection object that represents all the borders for the specified style.| +||[listTemplate](/.style#word-javascript/api/word/-style-listtemplate-member)|Gets a ListTemplate object that represents the list formatting for the specified Style object.| +|[TableRow](/.tablerow)|[insertContentControl()](/.tablerow#word-javascript/api/word/-tablerow-insertcontentcontrol-member(1))|Inserts a content control on the row.| +|[TableStyle](/.tablestyle)|[alignment](/.tablestyle#word-javascript/api/word/-tablestyle-alignment-member)|Specifies the table's alignment against the page margin.| +||[allowBreakAcrossPage](/.tablestyle#word-javascript/api/word/-tablestyle-allowbreakacrosspage-member)|Specifies whether lines in tables formatted with a specified style break across pages.| diff --git a/docs/includes/word-desktop-1_2.md b/docs/includes/word-desktop-1_2.md index ca68208941..1e6d852597 100644 --- a/docs/includes/word-desktop-1_2.md +++ b/docs/includes/word-desktop-1_2.md @@ -1,118 +1,118 @@ | Class | Fields | Description | |:---|:---|:---| -|[Body](/javascript/api/word/word.body)|[shapes](/javascript/api/word/word.body#word-word-body-shapes-member)|Gets the collection of shape objects in the body, including both inline and floating shapes.| -|[Canvas](/javascript/api/word/word.canvas)|[id](/javascript/api/word/word.canvas#word-word-canvas-id-member)|Gets an integer that represents the canvas identifier.| -||[shape](/javascript/api/word/word.canvas#word-word-canvas-shape-member)|Gets the Shape object associated with the canvas.| -||[shapes](/javascript/api/word/word.canvas#word-word-canvas-shapes-member)|Gets the collection of Shape objects.| -|[Document](/javascript/api/word/word.document)|[activeWindow](/javascript/api/word/word.document#word-word-document-activewindow-member)|Gets the active window for the document.| -||[compareFromBase64(base64File: string, documentCompareOptions?: Word.DocumentCompareOptions)](/javascript/api/word/word.document#word-word-document-comparefrombase64-member(1))|Displays revision marks that indicate where the specified document differs from another document.| -||[windows](/javascript/api/word/word.document#word-word-document-windows-member)|Gets the collection of `Word.Window` objects for the document.| -|[Font](/javascript/api/word/word.font)|[hidden](/javascript/api/word/word.font#word-word-font-hidden-member)|Specifies a value that indicates whether the font is tagged as hidden.| -|[InsertShapeOptions](/javascript/api/word/word.insertshapeoptions)|[height](/javascript/api/word/word.insertshapeoptions#word-word-insertshapeoptions-height-member)|Represents the height of the shape being inserted.| -||[left](/javascript/api/word/word.insertshapeoptions#word-word-insertshapeoptions-left-member)|Represents the left position of the shape being inserted.| -||[top](/javascript/api/word/word.insertshapeoptions#word-word-insertshapeoptions-top-member)|Represents the top position of the shape being inserted.| -||[width](/javascript/api/word/word.insertshapeoptions#word-word-insertshapeoptions-width-member)|Represents the width of the shape being inserted.| -|[Page](/javascript/api/word/word.page)|[getNext()](/javascript/api/word/word.page#word-word-page-getnext-member(1))|Gets the next page in the pane.| -||[getNextOrNullObject()](/javascript/api/word/word.page#word-word-page-getnextornullobject-member(1))|Gets the next page.| -||[getRange(rangeLocation?: Word.RangeLocation.whole \| Word.RangeLocation.start \| Word.RangeLocation.end \| "Whole" \| "Start" \| "End")](/javascript/api/word/word.page#word-word-page-getrange-member(1))|Gets the whole page, or the starting or ending point of the page, as a range.| -||[height](/javascript/api/word/word.page#word-word-page-height-member)|Gets the height, in points, of the paper defined in the Page Setup dialog box.| -||[index](/javascript/api/word/word.page#word-word-page-index-member)|Gets the index of the page.| -||[width](/javascript/api/word/word.page#word-word-page-width-member)|Gets the width, in points, of the paper defined in the Page Setup dialog box.| -|[PageCollection](/javascript/api/word/word.pagecollection)|[getFirst()](/javascript/api/word/word.pagecollection#word-word-pagecollection-getfirst-member(1))|Gets the first page in this collection.| -||[getFirstOrNullObject()](/javascript/api/word/word.pagecollection#word-word-pagecollection-getfirstornullobject-member(1))|Gets the first page in this collection.| -||[items](/javascript/api/word/word.pagecollection#word-word-pagecollection-items-member)|Gets the loaded child items in this collection.| -|[Pane](/javascript/api/word/word.pane)|[getNext()](/javascript/api/word/word.pane#word-word-pane-getnext-member(1))|Gets the next pane in the window.| -||[getNextOrNullObject()](/javascript/api/word/word.pane#word-word-pane-getnextornullobject-member(1))|Gets the next pane.| -||[pages](/javascript/api/word/word.pane#word-word-pane-pages-member)|Gets the collection of pages in the pane.| -||[pagesEnclosingViewport](/javascript/api/word/word.pane#word-word-pane-pagesenclosingviewport-member)|Gets the `PageCollection` shown in the viewport of the pane.| -|[PaneCollection](/javascript/api/word/word.panecollection)|[getFirst()](/javascript/api/word/word.panecollection#word-word-panecollection-getfirst-member(1))|Gets the first pane in this collection.| -||[getFirstOrNullObject()](/javascript/api/word/word.panecollection#word-word-panecollection-getfirstornullobject-member(1))|Gets the first pane in this collection.| -||[items](/javascript/api/word/word.panecollection#word-word-panecollection-items-member)|Gets the loaded child items in this collection.| -|[Paragraph](/javascript/api/word/word.paragraph)|[insertCanvas(insertShapeOptions?: Word.InsertShapeOptions)](/javascript/api/word/word.paragraph#word-word-paragraph-insertcanvas-member(1))|Inserts a floating canvas in front of text with its anchor at the beginning of the paragraph.| -||[insertGeometricShape(geometricShapeType: Word.GeometricShapeType, insertShapeOptions?: Word.InsertShapeOptions)](/javascript/api/word/word.paragraph#word-word-paragraph-insertgeometricshape-member(1))|Inserts a geometric shape in front of text with its anchor at the beginning of the paragraph.| -||[insertPictureFromBase64(base64EncodedImage: string, insertShapeOptions?: Word.InsertShapeOptions)](/javascript/api/word/word.paragraph#word-word-paragraph-insertpicturefrombase64-member(1))|Inserts a floating picture in front of text with its anchor at the beginning of the paragraph.| -||[insertTextBox(text?: string, insertShapeOptions?: Word.InsertShapeOptions)](/javascript/api/word/word.paragraph#word-word-paragraph-inserttextbox-member(1))|Inserts a floating text box in front of text with its anchor at the beginning of the paragraph.| -||[shapes](/javascript/api/word/word.paragraph#word-word-paragraph-shapes-member)|Gets the collection of shape objects anchored in the paragraph, including both inline and floating shapes.| -|[Range](/javascript/api/word/word.range)|[insertCanvas(insertShapeOptions?: Word.InsertShapeOptions)](/javascript/api/word/word.range#word-word-range-insertcanvas-member(1))|Inserts a floating canvas in front of text with its anchor at the beginning of the range.| -||[insertGeometricShape(geometricShapeType: Word.GeometricShapeType, insertShapeOptions?: Word.InsertShapeOptions)](/javascript/api/word/word.range#word-word-range-insertgeometricshape-member(1))|Inserts a geometric shape in front of text with its anchor at the beginning of the range.| -||[insertPictureFromBase64(base64EncodedImage: string, insertShapeOptions?: Word.InsertShapeOptions)](/javascript/api/word/word.range#word-word-range-insertpicturefrombase64-member(1))|Inserts a floating picture in front of text with its anchor at the beginning of the range.| -||[insertTextBox(text?: string, insertShapeOptions?: Word.InsertShapeOptions)](/javascript/api/word/word.range#word-word-range-inserttextbox-member(1))|Inserts a floating text box in front of text with its anchor at the beginning of the range.| -||[pages](/javascript/api/word/word.range#word-word-range-pages-member)|Gets the collection of pages in the range.| -||[shapes](/javascript/api/word/word.range#word-word-range-shapes-member)|Gets the collection of shape objects anchored in the range, including both inline and floating shapes.| -|[Shape](/javascript/api/word/word.shape)|[allowOverlap](/javascript/api/word/word.shape#word-word-shape-allowoverlap-member)|Specifies whether a given shape can overlap other shapes.| -||[altTextDescription](/javascript/api/word/word.shape#word-word-shape-alttextdescription-member)|Specifies a string that represents the alternative text associated with the shape.| -||[body](/javascript/api/word/word.shape#word-word-shape-body-member)|Represents the body object of the shape.| -||[canvas](/javascript/api/word/word.shape#word-word-shape-canvas-member)|Gets the canvas associated with the shape.| -||[delete()](/javascript/api/word/word.shape#word-word-shape-delete-member(1))|Deletes the shape and its content.| -||[fill](/javascript/api/word/word.shape#word-word-shape-fill-member)|Returns the fill formatting of the shape.| -||[geometricShapeType](/javascript/api/word/word.shape#word-word-shape-geometricshapetype-member)|The geometric shape type of the shape.| -||[height](/javascript/api/word/word.shape#word-word-shape-height-member)|The height, in points, of the shape.| -||[heightRelative](/javascript/api/word/word.shape#word-word-shape-heightrelative-member)|The percentage of shape height to vertical relative size, see Word.RelativeSize.| -||[id](/javascript/api/word/word.shape#word-word-shape-id-member)|Gets an integer that represents the shape identifier.| -||[isChild](/javascript/api/word/word.shape#word-word-shape-ischild-member)|Check whether this shape is a child of a group shape or a canvas shape.| -||[left](/javascript/api/word/word.shape#word-word-shape-left-member)|The distance, in points, from the left side of the shape to the horizontal relative position, see Word.RelativeHorizontalPosition.| -||[leftRelative](/javascript/api/word/word.shape#word-word-shape-leftrelative-member)|The relative left position as a percentage from the left side of the shape to the horizontal relative position, see Word.RelativeHorizontalPosition.| -||[lockAspectRatio](/javascript/api/word/word.shape#word-word-shape-lockaspectratio-member)|Specifies if the aspect ratio of this shape is locked.| -||[moveHorizontally(distance: number)](/javascript/api/word/word.shape#word-word-shape-movehorizontally-member(1))|Moves the shape horizontally by the number of points.| -||[moveVertically(distance: number)](/javascript/api/word/word.shape#word-word-shape-movevertically-member(1))|Moves the shape vertically by the number of points.| -||[name](/javascript/api/word/word.shape#word-word-shape-name-member)|The name of the shape.| -||[parentCanvas](/javascript/api/word/word.shape#word-word-shape-parentcanvas-member)|Gets the top-level parent canvas shape of this child shape.| -||[parentGroup](/javascript/api/word/word.shape#word-word-shape-parentgroup-member)|Gets the top-level parent group shape of this child shape.| -||[relativeHorizontalPosition](/javascript/api/word/word.shape#word-word-shape-relativehorizontalposition-member)|The relative horizontal position of the shape.| -||[relativeHorizontalSize](/javascript/api/word/word.shape#word-word-shape-relativehorizontalsize-member)|The relative horizontal size of the shape.| -||[relativeVerticalPosition](/javascript/api/word/word.shape#word-word-shape-relativeverticalposition-member)|The relative vertical position of the shape.| -||[relativeVerticalSize](/javascript/api/word/word.shape#word-word-shape-relativeverticalsize-member)|The relative vertical size of the shape.| -||[rotation](/javascript/api/word/word.shape#word-word-shape-rotation-member)|Specifies the rotation, in degrees, of the shape.| -||[scaleHeight(scaleFactor: number, scaleType: Word.ShapeScaleType, scaleFrom?: Word.ShapeScaleFrom)](/javascript/api/word/word.shape#word-word-shape-scaleheight-member(1))|Scales the height of the shape by a specified factor.| -||[scaleWidth(scaleFactor: number, scaleType: Word.ShapeScaleType, scaleFrom?: Word.ShapeScaleFrom)](/javascript/api/word/word.shape#word-word-shape-scalewidth-member(1))|Scales the width of the shape by a specified factor.| -||[select(selectMultipleShapes?: boolean)](/javascript/api/word/word.shape#word-word-shape-select-member(1))|Selects the shape.| -||[shapeGroup](/javascript/api/word/word.shape#word-word-shape-shapegroup-member)|Gets the shape group associated with the shape.| -||[textFrame](/javascript/api/word/word.shape#word-word-shape-textframe-member)|Gets the text frame object of the shape.| -||[textWrap](/javascript/api/word/word.shape#word-word-shape-textwrap-member)|Returns the text wrap formatting of the shape.| -||[top](/javascript/api/word/word.shape#word-word-shape-top-member)|The distance, in points, from the top edge of the shape to the vertical relative position (see Word.RelativeVerticalPosition).| -||[topRelative](/javascript/api/word/word.shape#word-word-shape-toprelative-member)|The relative top position as a percentage from the top edge of the shape to the vertical relative position, see Word.RelativeVerticalPosition.| -||[type](/javascript/api/word/word.shape#word-word-shape-type-member)|Gets the shape type.| -||[visible](/javascript/api/word/word.shape#word-word-shape-visible-member)|Specifies if the shape is visible.| -||[width](/javascript/api/word/word.shape#word-word-shape-width-member)|The width, in points, of the shape.| -||[widthRelative](/javascript/api/word/word.shape#word-word-shape-widthrelative-member)|The percentage of shape width to horizontal relative size, see Word.RelativeSize.| -|[ShapeCollection](/javascript/api/word/word.shapecollection)|[getByGeometricTypes(types: Word.GeometricShapeType[])](/javascript/api/word/word.shapecollection#word-word-shapecollection-getbygeometrictypes-member(1))|Gets the shapes that have the specified geometric types.| -||[getById(id: number)](/javascript/api/word/word.shapecollection#word-word-shapecollection-getbyid-member(1))|Gets a shape by its identifier.| -||[getByIdOrNullObject(id: number)](/javascript/api/word/word.shapecollection#word-word-shapecollection-getbyidornullobject-member(1))|Gets a shape by its identifier.| -||[getByIds(ids: number[])](/javascript/api/word/word.shapecollection#word-word-shapecollection-getbyids-member(1))|Gets the shapes by the identifiers.| -||[getByNames(names: string[])](/javascript/api/word/word.shapecollection#word-word-shapecollection-getbynames-member(1))|Gets the shapes that have the specified names.| -||[getByTypes(types: Word.ShapeType[])](/javascript/api/word/word.shapecollection#word-word-shapecollection-getbytypes-member(1))|Gets the shapes that have the specified types.| -||[getFirst()](/javascript/api/word/word.shapecollection#word-word-shapecollection-getfirst-member(1))|Gets the first shape in this collection.| -||[getFirstOrNullObject()](/javascript/api/word/word.shapecollection#word-word-shapecollection-getfirstornullobject-member(1))|Gets the first shape in this collection.| -||[group()](/javascript/api/word/word.shapecollection#word-word-shapecollection-group-member(1))|Groups floating shapes in this collection, inline shapes will be skipped.| -||[items](/javascript/api/word/word.shapecollection#word-word-shapecollection-items-member)|Gets the loaded child items in this collection.| -|[ShapeFill](/javascript/api/word/word.shapefill)|[backgroundColor](/javascript/api/word/word.shapefill#word-word-shapefill-backgroundcolor-member)|Specifies the shape fill background color.| -||[clear()](/javascript/api/word/word.shapefill#word-word-shapefill-clear-member(1))|Clears the fill formatting of this shape and set it to `Word.ShapeFillType.NoFill`;| -||[foregroundColor](/javascript/api/word/word.shapefill#word-word-shapefill-foregroundcolor-member)|Specifies the shape fill foreground color.| -||[setSolidColor(color: string)](/javascript/api/word/word.shapefill#word-word-shapefill-setsolidcolor-member(1))|Sets the fill formatting of the shape to a uniform color.| -||[transparency](/javascript/api/word/word.shapefill#word-word-shapefill-transparency-member)|Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).| -||[type](/javascript/api/word/word.shapefill#word-word-shapefill-type-member)|Returns the fill type of the shape.| -|[ShapeGroup](/javascript/api/word/word.shapegroup)|[id](/javascript/api/word/word.shapegroup#word-word-shapegroup-id-member)|Gets an integer that represents the shape group identifier.| -||[shape](/javascript/api/word/word.shapegroup#word-word-shapegroup-shape-member)|Gets the Shape object associated with the group.| -||[shapes](/javascript/api/word/word.shapegroup#word-word-shapegroup-shapes-member)|Gets the collection of Shape objects.| -||[ungroup()](/javascript/api/word/word.shapegroup#word-word-shapegroup-ungroup-member(1))|Ungroups any grouped shapes in the specified shape group.| -|[ShapeTextWrap](/javascript/api/word/word.shapetextwrap)|[bottomDistance](/javascript/api/word/word.shapetextwrap#word-word-shapetextwrap-bottomdistance-member)|Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape.| -||[leftDistance](/javascript/api/word/word.shapetextwrap#word-word-shapetextwrap-leftdistance-member)|Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape.| -||[rightDistance](/javascript/api/word/word.shapetextwrap#word-word-shapetextwrap-rightdistance-member)|Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape.| -||[side](/javascript/api/word/word.shapetextwrap#word-word-shapetextwrap-side-member)|Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farthest from the page margin.| -||[topDistance](/javascript/api/word/word.shapetextwrap#word-word-shapetextwrap-topdistance-member)|Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape.| -||[type](/javascript/api/word/word.shapetextwrap#word-word-shapetextwrap-type-member)|Specifies the text wrap type around the shape.| -|[TextFrame](/javascript/api/word/word.textframe)|[autoSizeSetting](/javascript/api/word/word.textframe#word-word-textframe-autosizesetting-member)|The automatic sizing settings for the text frame.| -||[bottomMargin](/javascript/api/word/word.textframe#word-word-textframe-bottommargin-member)|Represents the bottom margin, in points, of the text frame.| -||[hasText](/javascript/api/word/word.textframe#word-word-textframe-hastext-member)|Specifies if the text frame contains text.| -||[leftMargin](/javascript/api/word/word.textframe#word-word-textframe-leftmargin-member)|Represents the left margin, in points, of the text frame.| -||[noTextRotation](/javascript/api/word/word.textframe#word-word-textframe-notextrotation-member)|Returns True if text in the text frame shouldn't rotate when the shape is rotated.| -||[orientation](/javascript/api/word/word.textframe#word-word-textframe-orientation-member)|Represents the angle to which the text is oriented for the text frame.| -||[rightMargin](/javascript/api/word/word.textframe#word-word-textframe-rightmargin-member)|Represents the right margin, in points, of the text frame.| -||[topMargin](/javascript/api/word/word.textframe#word-word-textframe-topmargin-member)|Represents the top margin, in points, of the text frame.| -||[verticalAlignment](/javascript/api/word/word.textframe#word-word-textframe-verticalalignment-member)|Represents the vertical alignment of the text frame.| -||[wordWrap](/javascript/api/word/word.textframe#word-word-textframe-wordwrap-member)|Determines whether lines break automatically to fit text inside the shape.| -|[Window](/javascript/api/word/word.window)|[activePane](/javascript/api/word/word.window#word-word-window-activepane-member)|Gets the active pane in the window.| -||[panes](/javascript/api/word/word.window#word-word-window-panes-member)|Gets the collection of panes in the window.| -|[WindowCollection](/javascript/api/word/word.windowcollection)|[getFirst()](/javascript/api/word/word.windowcollection#word-word-windowcollection-getfirst-member(1))|Gets the first window in this collection.| -||[getFirstOrNullObject()](/javascript/api/word/word.windowcollection#word-word-windowcollection-getfirstornullobject-member(1))|Gets the first window in this collection.| -||[items](/javascript/api/word/word.windowcollection#word-word-windowcollection-items-member)|Gets the loaded child items in this collection.| +|[Body](/.body)|[shapes](/.body#word-javascript/api/word/-body-shapes-member)|Gets the collection of shape objects in the body, including both inline and floating shapes.| +|[Canvas](/.canvas)|[id](/.canvas#word-javascript/api/word/-canvas-id-member)|Gets an integer that represents the canvas identifier.| +||[shape](/.canvas#word-javascript/api/word/-canvas-shape-member)|Gets the Shape object associated with the canvas.| +||[shapes](/.canvas#word-javascript/api/word/-canvas-shapes-member)|Gets the collection of Shape objects.| +|[Document](/.document)|[activeWindow](/.document#word-javascript/api/word/-document-activewindow-member)|Gets the active window for the document.| +||[compareFromBase64(base64File: string, documentCompareOptions?: Word.DocumentCompareOptions)](/.document#word-javascript/api/word/-document-comparefrombase64-member(1))|Displays revision marks that indicate where the specified document differs from another document.| +||[windows](/.document#word-javascript/api/word/-document-windows-member)|Gets the collection of `Word.Window` objects for the document.| +|[Font](/.font)|[hidden](/.font#word-javascript/api/word/-font-hidden-member)|Specifies a value that indicates whether the font is tagged as hidden.| +|[InsertShapeOptions](/.insertshapeoptions)|[height](/.insertshapeoptions#word-javascript/api/word/-insertshapeoptions-height-member)|Represents the height of the shape being inserted.| +||[left](/.insertshapeoptions#word-javascript/api/word/-insertshapeoptions-left-member)|Represents the left position of the shape being inserted.| +||[top](/.insertshapeoptions#word-javascript/api/word/-insertshapeoptions-top-member)|Represents the top position of the shape being inserted.| +||[width](/.insertshapeoptions#word-javascript/api/word/-insertshapeoptions-width-member)|Represents the width of the shape being inserted.| +|[Page](/.page)|[getNext()](/.page#word-javascript/api/word/-page-getnext-member(1))|Gets the next page in the pane.| +||[getNextOrNullObject()](/.page#word-javascript/api/word/-page-getnextornullobject-member(1))|Gets the next page.| +||[getRange(rangeLocation?: Word.RangeLocation.whole \| Word.RangeLocation.start \| Word.RangeLocation.end \| "Whole" \| "Start" \| "End")](/.page#word-javascript/api/word/-page-getrange-member(1))|Gets the whole page, or the starting or ending point of the page, as a range.| +||[height](/.page#word-javascript/api/word/-page-height-member)|Gets the height, in points, of the paper defined in the Page Setup dialog box.| +||[index](/.page#word-javascript/api/word/-page-index-member)|Gets the index of the page.| +||[width](/.page#word-javascript/api/word/-page-width-member)|Gets the width, in points, of the paper defined in the Page Setup dialog box.| +|[PageCollection](/.pagecollection)|[getFirst()](/.pagecollection#word-javascript/api/word/-pagecollection-getfirst-member(1))|Gets the first page in this collection.| +||[getFirstOrNullObject()](/.pagecollection#word-javascript/api/word/-pagecollection-getfirstornullobject-member(1))|Gets the first page in this collection.| +||[items](/.pagecollection#word-javascript/api/word/-pagecollection-items-member)|Gets the loaded child items in this collection.| +|[Pane](/.pane)|[getNext()](/.pane#word-javascript/api/word/-pane-getnext-member(1))|Gets the next pane in the window.| +||[getNextOrNullObject()](/.pane#word-javascript/api/word/-pane-getnextornullobject-member(1))|Gets the next pane.| +||[pages](/.pane#word-javascript/api/word/-pane-pages-member)|Gets the collection of pages in the pane.| +||[pagesEnclosingViewport](/.pane#word-javascript/api/word/-pane-pagesenclosingviewport-member)|Gets the `PageCollection` shown in the viewport of the pane.| +|[PaneCollection](/.panecollection)|[getFirst()](/.panecollection#word-javascript/api/word/-panecollection-getfirst-member(1))|Gets the first pane in this collection.| +||[getFirstOrNullObject()](/.panecollection#word-javascript/api/word/-panecollection-getfirstornullobject-member(1))|Gets the first pane in this collection.| +||[items](/.panecollection#word-javascript/api/word/-panecollection-items-member)|Gets the loaded child items in this collection.| +|[Paragraph](/.paragraph)|[insertCanvas(insertShapeOptions?: Word.InsertShapeOptions)](/.paragraph#word-javascript/api/word/-paragraph-insertcanvas-member(1))|Inserts a floating canvas in front of text with its anchor at the beginning of the paragraph.| +||[insertGeometricShape(geometricShapeType: Word.GeometricShapeType, insertShapeOptions?: Word.InsertShapeOptions)](/.paragraph#word-javascript/api/word/-paragraph-insertgeometricshape-member(1))|Inserts a geometric shape in front of text with its anchor at the beginning of the paragraph.| +||[insertPictureFromBase64(base64EncodedImage: string, insertShapeOptions?: Word.InsertShapeOptions)](/.paragraph#word-javascript/api/word/-paragraph-insertpicturefrombase64-member(1))|Inserts a floating picture in front of text with its anchor at the beginning of the paragraph.| +||[insertTextBox(text?: string, insertShapeOptions?: Word.InsertShapeOptions)](/.paragraph#word-javascript/api/word/-paragraph-inserttextbox-member(1))|Inserts a floating text box in front of text with its anchor at the beginning of the paragraph.| +||[shapes](/.paragraph#word-javascript/api/word/-paragraph-shapes-member)|Gets the collection of shape objects anchored in the paragraph, including both inline and floating shapes.| +|[Range](/.range)|[insertCanvas(insertShapeOptions?: Word.InsertShapeOptions)](/.range#word-javascript/api/word/-range-insertcanvas-member(1))|Inserts a floating canvas in front of text with its anchor at the beginning of the range.| +||[insertGeometricShape(geometricShapeType: Word.GeometricShapeType, insertShapeOptions?: Word.InsertShapeOptions)](/.range#word-javascript/api/word/-range-insertgeometricshape-member(1))|Inserts a geometric shape in front of text with its anchor at the beginning of the range.| +||[insertPictureFromBase64(base64EncodedImage: string, insertShapeOptions?: Word.InsertShapeOptions)](/.range#word-javascript/api/word/-range-insertpicturefrombase64-member(1))|Inserts a floating picture in front of text with its anchor at the beginning of the range.| +||[insertTextBox(text?: string, insertShapeOptions?: Word.InsertShapeOptions)](/.range#word-javascript/api/word/-range-inserttextbox-member(1))|Inserts a floating text box in front of text with its anchor at the beginning of the range.| +||[pages](/.range#word-javascript/api/word/-range-pages-member)|Gets the collection of pages in the range.| +||[shapes](/.range#word-javascript/api/word/-range-shapes-member)|Gets the collection of shape objects anchored in the range, including both inline and floating shapes.| +|[Shape](/.shape)|[allowOverlap](/.shape#word-javascript/api/word/-shape-allowoverlap-member)|Specifies whether a given shape can overlap other shapes.| +||[altTextDescription](/.shape#word-javascript/api/word/-shape-alttextdescription-member)|Specifies a string that represents the alternative text associated with the shape.| +||[body](/.shape#word-javascript/api/word/-shape-body-member)|Represents the body object of the shape.| +||[canvas](/.shape#word-javascript/api/word/-shape-canvas-member)|Gets the canvas associated with the shape.| +||[delete()](/.shape#word-javascript/api/word/-shape-delete-member(1))|Deletes the shape and its content.| +||[fill](/.shape#word-javascript/api/word/-shape-fill-member)|Returns the fill formatting of the shape.| +||[geometricShapeType](/.shape#word-javascript/api/word/-shape-geometricshapetype-member)|The geometric shape type of the shape.| +||[height](/.shape#word-javascript/api/word/-shape-height-member)|The height, in points, of the shape.| +||[heightRelative](/.shape#word-javascript/api/word/-shape-heightrelative-member)|The percentage of shape height to vertical relative size, see Word.RelativeSize.| +||[id](/.shape#word-javascript/api/word/-shape-id-member)|Gets an integer that represents the shape identifier.| +||[isChild](/.shape#word-javascript/api/word/-shape-ischild-member)|Check whether this shape is a child of a group shape or a canvas shape.| +||[left](/.shape#word-javascript/api/word/-shape-left-member)|The distance, in points, from the left side of the shape to the horizontal relative position, see Word.RelativeHorizontalPosition.| +||[leftRelative](/.shape#word-javascript/api/word/-shape-leftrelative-member)|The relative left position as a percentage from the left side of the shape to the horizontal relative position, see Word.RelativeHorizontalPosition.| +||[lockAspectRatio](/.shape#word-javascript/api/word/-shape-lockaspectratio-member)|Specifies if the aspect ratio of this shape is locked.| +||[moveHorizontally(distance: number)](/.shape#word-javascript/api/word/-shape-movehorizontally-member(1))|Moves the shape horizontally by the number of points.| +||[moveVertically(distance: number)](/.shape#word-javascript/api/word/-shape-movevertically-member(1))|Moves the shape vertically by the number of points.| +||[name](/.shape#word-javascript/api/word/-shape-name-member)|The name of the shape.| +||[parentCanvas](/.shape#word-javascript/api/word/-shape-parentcanvas-member)|Gets the top-level parent canvas shape of this child shape.| +||[parentGroup](/.shape#word-javascript/api/word/-shape-parentgroup-member)|Gets the top-level parent group shape of this child shape.| +||[relativeHorizontalPosition](/.shape#word-javascript/api/word/-shape-relativehorizontalposition-member)|The relative horizontal position of the shape.| +||[relativeHorizontalSize](/.shape#word-javascript/api/word/-shape-relativehorizontalsize-member)|The relative horizontal size of the shape.| +||[relativeVerticalPosition](/.shape#word-javascript/api/word/-shape-relativeverticalposition-member)|The relative vertical position of the shape.| +||[relativeVerticalSize](/.shape#word-javascript/api/word/-shape-relativeverticalsize-member)|The relative vertical size of the shape.| +||[rotation](/.shape#word-javascript/api/word/-shape-rotation-member)|Specifies the rotation, in degrees, of the shape.| +||[scaleHeight(scaleFactor: number, scaleType: Word.ShapeScaleType, scaleFrom?: Word.ShapeScaleFrom)](/.shape#word-javascript/api/word/-shape-scaleheight-member(1))|Scales the height of the shape by a specified factor.| +||[scaleWidth(scaleFactor: number, scaleType: Word.ShapeScaleType, scaleFrom?: Word.ShapeScaleFrom)](/.shape#word-javascript/api/word/-shape-scalewidth-member(1))|Scales the width of the shape by a specified factor.| +||[select(selectMultipleShapes?: boolean)](/.shape#word-javascript/api/word/-shape-select-member(1))|Selects the shape.| +||[shapeGroup](/.shape#word-javascript/api/word/-shape-shapegroup-member)|Gets the shape group associated with the shape.| +||[textFrame](/.shape#word-javascript/api/word/-shape-textframe-member)|Gets the text frame object of the shape.| +||[textWrap](/.shape#word-javascript/api/word/-shape-textwrap-member)|Returns the text wrap formatting of the shape.| +||[top](/.shape#word-javascript/api/word/-shape-top-member)|The distance, in points, from the top edge of the shape to the vertical relative position (see Word.RelativeVerticalPosition).| +||[topRelative](/.shape#word-javascript/api/word/-shape-toprelative-member)|The relative top position as a percentage from the top edge of the shape to the vertical relative position, see Word.RelativeVerticalPosition.| +||[type](/.shape#word-javascript/api/word/-shape-type-member)|Gets the shape type.| +||[visible](/.shape#word-javascript/api/word/-shape-visible-member)|Specifies if the shape is visible.| +||[width](/.shape#word-javascript/api/word/-shape-width-member)|The width, in points, of the shape.| +||[widthRelative](/.shape#word-javascript/api/word/-shape-widthrelative-member)|The percentage of shape width to horizontal relative size, see Word.RelativeSize.| +|[ShapeCollection](/.shapecollection)|[getByGeometricTypes(types: Word.GeometricShapeType[])](/.shapecollection#word-javascript/api/word/-shapecollection-getbygeometrictypes-member(1))|Gets the shapes that have the specified geometric types.| +||[getById(id: number)](/.shapecollection#word-javascript/api/word/-shapecollection-getbyid-member(1))|Gets a shape by its identifier.| +||[getByIdOrNullObject(id: number)](/.shapecollection#word-javascript/api/word/-shapecollection-getbyidornullobject-member(1))|Gets a shape by its identifier.| +||[getByIds(ids: number[])](/.shapecollection#word-javascript/api/word/-shapecollection-getbyids-member(1))|Gets the shapes by the identifiers.| +||[getByNames(names: string[])](/.shapecollection#word-javascript/api/word/-shapecollection-getbynames-member(1))|Gets the shapes that have the specified names.| +||[getByTypes(types: Word.ShapeType[])](/.shapecollection#word-javascript/api/word/-shapecollection-getbytypes-member(1))|Gets the shapes that have the specified types.| +||[getFirst()](/.shapecollection#word-javascript/api/word/-shapecollection-getfirst-member(1))|Gets the first shape in this collection.| +||[getFirstOrNullObject()](/.shapecollection#word-javascript/api/word/-shapecollection-getfirstornullobject-member(1))|Gets the first shape in this collection.| +||[group()](/.shapecollection#word-javascript/api/word/-shapecollection-group-member(1))|Groups floating shapes in this collection, inline shapes will be skipped.| +||[items](/.shapecollection#word-javascript/api/word/-shapecollection-items-member)|Gets the loaded child items in this collection.| +|[ShapeFill](/.shapefill)|[backgroundColor](/.shapefill#word-javascript/api/word/-shapefill-backgroundcolor-member)|Specifies the shape fill background color.| +||[clear()](/.shapefill#word-javascript/api/word/-shapefill-clear-member(1))|Clears the fill formatting of this shape and set it to `Word.ShapeFillType.NoFill`;| +||[foregroundColor](/.shapefill#word-javascript/api/word/-shapefill-foregroundcolor-member)|Specifies the shape fill foreground color.| +||[setSolidColor(color: string)](/.shapefill#word-javascript/api/word/-shapefill-setsolidcolor-member(1))|Sets the fill formatting of the shape to a uniform color.| +||[transparency](/.shapefill#word-javascript/api/word/-shapefill-transparency-member)|Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).| +||[type](/.shapefill#word-javascript/api/word/-shapefill-type-member)|Returns the fill type of the shape.| +|[ShapeGroup](/.shapegroup)|[id](/.shapegroup#word-javascript/api/word/-shapegroup-id-member)|Gets an integer that represents the shape group identifier.| +||[shape](/.shapegroup#word-javascript/api/word/-shapegroup-shape-member)|Gets the Shape object associated with the group.| +||[shapes](/.shapegroup#word-javascript/api/word/-shapegroup-shapes-member)|Gets the collection of Shape objects.| +||[ungroup()](/.shapegroup#word-javascript/api/word/-shapegroup-ungroup-member(1))|Ungroups any grouped shapes in the specified shape group.| +|[ShapeTextWrap](/.shapetextwrap)|[bottomDistance](/.shapetextwrap#word-javascript/api/word/-shapetextwrap-bottomdistance-member)|Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape.| +||[leftDistance](/.shapetextwrap#word-javascript/api/word/-shapetextwrap-leftdistance-member)|Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape.| +||[rightDistance](/.shapetextwrap#word-javascript/api/word/-shapetextwrap-rightdistance-member)|Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape.| +||[side](/.shapetextwrap#word-javascript/api/word/-shapetextwrap-side-member)|Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farthest from the page margin.| +||[topDistance](/.shapetextwrap#word-javascript/api/word/-shapetextwrap-topdistance-member)|Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape.| +||[type](/.shapetextwrap#word-javascript/api/word/-shapetextwrap-type-member)|Specifies the text wrap type around the shape.| +|[TextFrame](/.textframe)|[autoSizeSetting](/.textframe#word-javascript/api/word/-textframe-autosizesetting-member)|The automatic sizing settings for the text frame.| +||[bottomMargin](/.textframe#word-javascript/api/word/-textframe-bottommargin-member)|Represents the bottom margin, in points, of the text frame.| +||[hasText](/.textframe#word-javascript/api/word/-textframe-hastext-member)|Specifies if the text frame contains text.| +||[leftMargin](/.textframe#word-javascript/api/word/-textframe-leftmargin-member)|Represents the left margin, in points, of the text frame.| +||[noTextRotation](/.textframe#word-javascript/api/word/-textframe-notextrotation-member)|Returns True if text in the text frame shouldn't rotate when the shape is rotated.| +||[orientation](/.textframe#word-javascript/api/word/-textframe-orientation-member)|Represents the angle to which the text is oriented for the text frame.| +||[rightMargin](/.textframe#word-javascript/api/word/-textframe-rightmargin-member)|Represents the right margin, in points, of the text frame.| +||[topMargin](/.textframe#word-javascript/api/word/-textframe-topmargin-member)|Represents the top margin, in points, of the text frame.| +||[verticalAlignment](/.textframe#word-javascript/api/word/-textframe-verticalalignment-member)|Represents the vertical alignment of the text frame.| +||[wordWrap](/.textframe#word-javascript/api/word/-textframe-wordwrap-member)|Determines whether lines break automatically to fit text inside the shape.| +|[Window](/.window)|[activePane](/.window#word-javascript/api/word/-window-activepane-member)|Gets the active pane in the window.| +||[panes](/.window#word-javascript/api/word/-window-panes-member)|Gets the collection of panes in the window.| +|[WindowCollection](/.windowcollection)|[getFirst()](/.windowcollection#word-javascript/api/word/-windowcollection-getfirst-member(1))|Gets the first window in this collection.| +||[getFirstOrNullObject()](/.windowcollection#word-javascript/api/word/-windowcollection-getfirstornullobject-member(1))|Gets the first window in this collection.| +||[items](/.windowcollection#word-javascript/api/word/-windowcollection-items-member)|Gets the loaded child items in this collection.| diff --git a/docs/includes/word-preview.md b/docs/includes/word-preview.md index 1ebed989a3..16b0f532b8 100644 --- a/docs/includes/word-preview.md +++ b/docs/includes/word-preview.md @@ -1,952 +1,952 @@ | Class | Fields | Description | |:---|:---|:---| -|[Application](/javascript/api/word/word.application)|[bibliography](/javascript/api/word/word.application#word-word-application-bibliography-member)|Returns a `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word.| -||[checkLanguage](/javascript/api/word/word.application#word-word-application-checklanguage-member)|Specifies if Microsoft Word automatically detects the language you are using as you type.| -||[language](/javascript/api/word/word.application#word-word-application-language-member)|Gets a `LanguageId` value that represents the language selected for the Microsoft Word user interface.| -||[templates](/javascript/api/word/word.application#word-word-application-templates-member)|Returns a `TemplateCollection` object that represents all the available templates: global templates and those attached to open documents.| -|[Bibliography](/javascript/api/word/word.bibliography)|[bibliographyStyle](/javascript/api/word/word.bibliography#word-word-bibliography-bibliographystyle-member)|Specifies the name of the active style to use for the bibliography.| -||[generateUniqueTag()](/javascript/api/word/word.bibliography#word-word-bibliography-generateuniquetag-member(1))|Generates a unique identification tag for a bibliography source and returns a string that represents the tag.| -||[sources](/javascript/api/word/word.bibliography#word-word-bibliography-sources-member)|Returns a `SourceCollection` object that represents all the sources contained in the bibliography.| -|[Body](/javascript/api/word/word.body)|[onCommentAdded](/javascript/api/word/word.body#word-word-body-oncommentadded-member)|Occurs when new comments are added.| -||[onCommentChanged](/javascript/api/word/word.body#word-word-body-oncommentchanged-member)|Occurs when a comment or its reply is changed.| -||[onCommentDeleted](/javascript/api/word/word.body#word-word-body-oncommentdeleted-member)|Occurs when comments are deleted.| -||[onCommentDeselected](/javascript/api/word/word.body#word-word-body-oncommentdeselected-member)|Occurs when a comment is deselected.| -||[onCommentSelected](/javascript/api/word/word.body#word-word-body-oncommentselected-member)|Occurs when a comment is selected.| -||[type](/javascript/api/word/word.body#word-word-body-type-member)|Gets the type of the body.| -|[Bookmark](/javascript/api/word/word.bookmark)|[copyTo(name: string)](/javascript/api/word/word.bookmark#word-word-bookmark-copyto-member(1))|Copies this bookmark to the new bookmark specified in the `name` argument and returns a `Bookmark` object.| -||[delete()](/javascript/api/word/word.bookmark#word-word-bookmark-delete-member(1))|Deletes the bookmark.| -||[end](/javascript/api/word/word.bookmark#word-word-bookmark-end-member)|Specifies the ending character position of the bookmark.| -||[isColumn](/javascript/api/word/word.bookmark#word-word-bookmark-iscolumn-member)|Returns `true` if the bookmark is a table column.| -||[isEmpty](/javascript/api/word/word.bookmark#word-word-bookmark-isempty-member)|Returns `true` if the bookmark is empty.| -||[name](/javascript/api/word/word.bookmark#word-word-bookmark-name-member)|Returns the name of the `Bookmark` object.| -||[range](/javascript/api/word/word.bookmark#word-word-bookmark-range-member)|Returns a `Range` object that represents the portion of the document that's contained in the `Bookmark` object.| -||[select()](/javascript/api/word/word.bookmark#word-word-bookmark-select-member(1))|Selects the bookmark.| -||[start](/javascript/api/word/word.bookmark#word-word-bookmark-start-member)|Specifies the starting character position of the bookmark.| -||[storyType](/javascript/api/word/word.bookmark#word-word-bookmark-storytype-member)|Returns the story type for the bookmark.| -|[BookmarkCollection](/javascript/api/word/word.bookmarkcollection)|[exists(name: string)](/javascript/api/word/word.bookmarkcollection#word-word-bookmarkcollection-exists-member(1))|Determines whether the specified bookmark exists.| -||[getItem(index: number)](/javascript/api/word/word.bookmarkcollection#word-word-bookmarkcollection-getitem-member(1))|Gets a `Bookmark` object by its index in the collection.| -||[items](/javascript/api/word/word.bookmarkcollection#word-word-bookmarkcollection-items-member)|Gets the loaded child items in this collection.| -|[BorderUniversal](/javascript/api/word/word.borderuniversal)|[artStyle](/javascript/api/word/word.borderuniversal#word-word-borderuniversal-artstyle-member)|Specifies the graphical page-border design for the document.| -||[artWidth](/javascript/api/word/word.borderuniversal#word-word-borderuniversal-artwidth-member)|Specifies the width (in points) of the graphical page border specified in the `artStyle` property.| -||[color](/javascript/api/word/word.borderuniversal#word-word-borderuniversal-color-member)|Specifies the color for the `BorderUniversal` object.| -||[colorIndex](/javascript/api/word/word.borderuniversal#word-word-borderuniversal-colorindex-member)|Specifies the color for the `BorderUniversal` or Word.Font object.| -||[inside](/javascript/api/word/word.borderuniversal#word-word-borderuniversal-inside-member)|Returns `true` if an inside border can be applied to the specified object.| -||[isVisible](/javascript/api/word/word.borderuniversal#word-word-borderuniversal-isvisible-member)|Specifies whether the border is visible.| -||[lineStyle](/javascript/api/word/word.borderuniversal#word-word-borderuniversal-linestyle-member)|Specifies the line style of the border.| -||[lineWidth](/javascript/api/word/word.borderuniversal#word-word-borderuniversal-linewidth-member)|Specifies the line width of an object's border.| -|[BorderUniversalCollection](/javascript/api/word/word.borderuniversalcollection)|[applyPageBordersToAllSections()](/javascript/api/word/word.borderuniversalcollection#word-word-borderuniversalcollection-applypageborderstoallsections-member(1))|Applies the specified page-border formatting to all sections in the document.| -||[getItem(index: number)](/javascript/api/word/word.borderuniversalcollection#word-word-borderuniversalcollection-getitem-member(1))|Gets a `Border` object by its index in the collection.| -||[items](/javascript/api/word/word.borderuniversalcollection#word-word-borderuniversalcollection-items-member)|Gets the loaded child items in this collection.| -|[Break](/javascript/api/word/word.break)|[pageIndex](/javascript/api/word/word.break#word-word-break-pageindex-member)|Returns the page number on which the break occurs.| -||[range](/javascript/api/word/word.break#word-word-break-range-member)|Returns a `Range` object that represents the portion of the document that's contained in the break.| -|[BreakCollection](/javascript/api/word/word.breakcollection)|[items](/javascript/api/word/word.breakcollection#word-word-breakcollection-items-member)|Gets the loaded child items in this collection.| -|[BuildingBlock](/javascript/api/word/word.buildingblock)|[category](/javascript/api/word/word.buildingblock#word-word-buildingblock-category-member)|Returns a `BuildingBlockCategory` object that represents the category for the building block.| -||[delete()](/javascript/api/word/word.buildingblock#word-word-buildingblock-delete-member(1))|Deletes the building block.| -||[description](/javascript/api/word/word.buildingblock#word-word-buildingblock-description-member)|Specifies the description for the building block.| -||[id](/javascript/api/word/word.buildingblock#word-word-buildingblock-id-member)|Returns the internal identification number for the building block.| -||[index](/javascript/api/word/word.buildingblock#word-word-buildingblock-index-member)|Returns the position of this building block in a collection.| -||[insert(range: Word.Range, richText: boolean)](/javascript/api/word/word.buildingblock#word-word-buildingblock-insert-member(1))|Inserts the value of the building block into the document and returns a `Range` object that represents the contents of the building block within the document.| -||[insertType](/javascript/api/word/word.buildingblock#word-word-buildingblock-inserttype-member)|Specifies a `DocPartInsertType` value that represents how to insert the contents of the building block into the document.| -||[name](/javascript/api/word/word.buildingblock#word-word-buildingblock-name-member)|Specifies the name of the building block.| -||[type](/javascript/api/word/word.buildingblock#word-word-buildingblock-type-member)|Returns a `BuildingBlockTypeItem` object that represents the type for the building block.| -||[value](/javascript/api/word/word.buildingblock#word-word-buildingblock-value-member)|Specifies the contents of the building block.| -|[BuildingBlockCategory](/javascript/api/word/word.buildingblockcategory)|[buildingBlocks](/javascript/api/word/word.buildingblockcategory#word-word-buildingblockcategory-buildingblocks-member)|Returns a `BuildingBlockCollection` object that represents the building blocks for the category.| -||[index](/javascript/api/word/word.buildingblockcategory#word-word-buildingblockcategory-index-member)|Returns the position of the `BuildingBlockCategory` object in a collection.| -||[name](/javascript/api/word/word.buildingblockcategory#word-word-buildingblockcategory-name-member)|Returns the name of the `BuildingBlockCategory` object.| -||[type](/javascript/api/word/word.buildingblockcategory#word-word-buildingblockcategory-type-member)|Returns a `BuildingBlockTypeItem` object that represents the type of building block for the building block category.| -|[BuildingBlockCategoryCollection](/javascript/api/word/word.buildingblockcategorycollection)|[getCount()](/javascript/api/word/word.buildingblockcategorycollection#word-word-buildingblockcategorycollection-getcount-member(1))|Returns the number of items in the collection.| -||[getItemAt(index: number)](/javascript/api/word/word.buildingblockcategorycollection#word-word-buildingblockcategorycollection-getitemat-member(1))|Returns a `BuildingBlockCategory` object that represents the specified item in the collection.| -|[BuildingBlockCollection](/javascript/api/word/word.buildingblockcollection)|[add(name: string, range: Word.Range, description: string, insertType: Word.DocPartInsertType)](/javascript/api/word/word.buildingblockcollection#word-word-buildingblockcollection-add-member(1))|Creates a new building block and returns a `BuildingBlock` object.| -||[getCount()](/javascript/api/word/word.buildingblockcollection#word-word-buildingblockcollection-getcount-member(1))|Returns the number of items in the collection.| -||[getItemAt(index: number)](/javascript/api/word/word.buildingblockcollection#word-word-buildingblockcollection-getitemat-member(1))|Returns a `BuildingBlock` object that represents the specified item in the collection.| -|[BuildingBlockEntryCollection](/javascript/api/word/word.buildingblockentrycollection)|[add(name: string, type: Word.BuildingBlockType, category: string, range: Word.Range, description: string, insertType: Word.DocPartInsertType)](/javascript/api/word/word.buildingblockentrycollection#word-word-buildingblockentrycollection-add-member(1))|Creates a new building block entry in a template and returns a `BuildingBlock` object that represents the new building block entry.| -||[getCount()](/javascript/api/word/word.buildingblockentrycollection#word-word-buildingblockentrycollection-getcount-member(1))|Returns the number of items in the collection.| -||[getItemAt(index: number)](/javascript/api/word/word.buildingblockentrycollection#word-word-buildingblockentrycollection-getitemat-member(1))|Returns a `BuildingBlock` object that represents the specified item in the collection.| -|[BuildingBlockGalleryContentControl](/javascript/api/word/word.buildingblockgallerycontentcontrol)|[appearance](/javascript/api/word/word.buildingblockgallerycontentcontrol#word-word-buildingblockgallerycontentcontrol-appearance-member)|Specifies the appearance of the content control.| -||[buildingBlockCategory](/javascript/api/word/word.buildingblockgallerycontentcontrol#word-word-buildingblockgallerycontentcontrol-buildingblockcategory-member)|Specifies the category for the building block content control.| -||[buildingBlockType](/javascript/api/word/word.buildingblockgallerycontentcontrol#word-word-buildingblockgallerycontentcontrol-buildingblocktype-member)|Specifies a `BuildingBlockType` value that represents the type of building block for the building block content control.| -||[color](/javascript/api/word/word.buildingblockgallerycontentcontrol#word-word-buildingblockgallerycontentcontrol-color-member)|Specifies the red-green-blue (RGB) value of the color of the content control.| -||[copy()](/javascript/api/word/word.buildingblockgallerycontentcontrol#word-word-buildingblockgallerycontentcontrol-copy-member(1))|Copies the content control from the active document to the Clipboard.| -||[cut()](/javascript/api/word/word.buildingblockgallerycontentcontrol#word-word-buildingblockgallerycontentcontrol-cut-member(1))|Removes the content control from the active document and moves the content control to the Clipboard.| -||[delete(deleteContents?: boolean)](/javascript/api/word/word.buildingblockgallerycontentcontrol#word-word-buildingblockgallerycontentcontrol-delete-member(1))|Deletes the content control and optionally its contents.| -||[id](/javascript/api/word/word.buildingblockgallerycontentcontrol#word-word-buildingblockgallerycontentcontrol-id-member)|Gets the identification for the content control.| -||[isTemporary](/javascript/api/word/word.buildingblockgallerycontentcontrol#word-word-buildingblockgallerycontentcontrol-istemporary-member)|Specifies whether to remove the content control from the active document when the user edits the contents of the control.| -||[level](/javascript/api/word/word.buildingblockgallerycontentcontrol#word-word-buildingblockgallerycontentcontrol-level-member)|Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline.| -||[lockContentControl](/javascript/api/word/word.buildingblockgallerycontentcontrol#word-word-buildingblockgallerycontentcontrol-lockcontentcontrol-member)|Specifies if the content control is locked (can't be deleted).| -||[lockContents](/javascript/api/word/word.buildingblockgallerycontentcontrol#word-word-buildingblockgallerycontentcontrol-lockcontents-member)|Specifies if the contents of the content control are locked (not editable).| -||[placeholderText](/javascript/api/word/word.buildingblockgallerycontentcontrol#word-word-buildingblockgallerycontentcontrol-placeholdertext-member)|Returns a `BuildingBlock` object that represents the placeholder text for the content control.| -||[range](/javascript/api/word/word.buildingblockgallerycontentcontrol#word-word-buildingblockgallerycontentcontrol-range-member)|Returns a `Range` object that represents the contents of the content control in the active document.| -||[setPlaceholderText(options?: Word.ContentControlPlaceholderOptions)](/javascript/api/word/word.buildingblockgallerycontentcontrol#word-word-buildingblockgallerycontentcontrol-setplaceholdertext-member(1))|Sets the placeholder text that displays in the content control until a user enters their own text.| -||[showingPlaceholderText](/javascript/api/word/word.buildingblockgallerycontentcontrol#word-word-buildingblockgallerycontentcontrol-showingplaceholdertext-member)|Gets if the placeholder text for the content control is being displayed.| -||[tag](/javascript/api/word/word.buildingblockgallerycontentcontrol#word-word-buildingblockgallerycontentcontrol-tag-member)|Specifies a tag to identify the content control.| -||[title](/javascript/api/word/word.buildingblockgallerycontentcontrol#word-word-buildingblockgallerycontentcontrol-title-member)|Specifies the title for the content control.| -||[xmlMapping](/javascript/api/word/word.buildingblockgallerycontentcontrol#word-word-buildingblockgallerycontentcontrol-xmlmapping-member)|Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document.| -|[BuildingBlockTypeItem](/javascript/api/word/word.buildingblocktypeitem)|[categories](/javascript/api/word/word.buildingblocktypeitem#word-word-buildingblocktypeitem-categories-member)|Returns a `BuildingBlockCategoryCollection` object that represents the categories for a building block type.| -||[index](/javascript/api/word/word.buildingblocktypeitem#word-word-buildingblocktypeitem-index-member)|Returns the position of an item in a collection.| -||[name](/javascript/api/word/word.buildingblocktypeitem#word-word-buildingblocktypeitem-name-member)|Returns the localized name of a building block type.| -|[BuildingBlockTypeItemCollection](/javascript/api/word/word.buildingblocktypeitemcollection)|[getByType(type: Word.BuildingBlockType)](/javascript/api/word/word.buildingblocktypeitemcollection#word-word-buildingblocktypeitemcollection-getbytype-member(1))|Gets a `BuildingBlockTypeItem` object by its type in the collection.| -||[getCount()](/javascript/api/word/word.buildingblocktypeitemcollection#word-word-buildingblocktypeitemcollection-getcount-member(1))|Returns the number of items in the collection.| -|[ColorFormat](/javascript/api/word/word.colorformat)|[brightness](/javascript/api/word/word.colorformat#word-word-colorformat-brightness-member)|Specifies the brightness of a specified shape color.| -||[objectThemeColor](/javascript/api/word/word.colorformat#word-word-colorformat-objectthemecolor-member)|Specifies the theme color for a color format.| -||[rgb](/javascript/api/word/word.colorformat#word-word-colorformat-rgb-member)|Specifies the red-green-blue (RGB) value of the specified color.| -||[tintAndShade](/javascript/api/word/word.colorformat#word-word-colorformat-tintandshade-member)|Specifies the lightening or darkening of a specified shape's color.| -||[type](/javascript/api/word/word.colorformat#word-word-colorformat-type-member)|Returns the shape color type.| -|[CommentDetail](/javascript/api/word/word.commentdetail)|[id](/javascript/api/word/word.commentdetail#word-word-commentdetail-id-member)|Represents the ID of this comment.| -||[replyIds](/javascript/api/word/word.commentdetail#word-word-commentdetail-replyids-member)|Represents the IDs of the replies to this comment.| -|[CommentEventArgs](/javascript/api/word/word.commenteventargs)|[changeType](/javascript/api/word/word.commenteventargs#word-word-commenteventargs-changetype-member)|Represents how the comment changed event is triggered.| -||[commentDetails](/javascript/api/word/word.commenteventargs#word-word-commenteventargs-commentdetails-member)|Gets the CommentDetail array which contains the IDs and reply IDs of the involved comments.| -||[source](/javascript/api/word/word.commenteventargs#word-word-commenteventargs-source-member)|The source of the event.| -||[type](/javascript/api/word/word.commenteventargs#word-word-commenteventargs-type-member)|The event type.| -|[ContentControl](/javascript/api/word/word.contentcontrol)|[buildingBlockGalleryContentControl](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-buildingblockgallerycontentcontrol-member)|Gets the building block gallery-related data if the content control's Word.ContentControlType is `BuildingBlockGallery`.| -||[datePickerContentControl](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-datepickercontentcontrol-member)|Gets the date picker-related data if the content control's Word.ContentControlType is `DatePicker`.| -||[groupContentControl](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-groupcontentcontrol-member)|Gets the group-related data if the content control's Word.ContentControlType is `Group`.| -||[onCommentAdded](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-oncommentadded-member)|Occurs when new comments are added.| -||[onCommentChanged](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-oncommentchanged-member)|Occurs when a comment or its reply is changed.| -||[onCommentDeselected](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-oncommentdeselected-member)|Occurs when a comment is deselected.| -||[onCommentSelected](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-oncommentselected-member)|Occurs when a comment is selected.| -||[pictureContentControl](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-picturecontentcontrol-member)|Gets the picture-related data if the content control's Word.ContentControlType is `Picture`.| -||[repeatingSectionContentControl](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-repeatingsectioncontentcontrol-member)|Gets the repeating section-related data if the content control's Word.ContentControlType is `RepeatingSection`.| -||[resetState()](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-resetstate-member(1))|Resets the state of the content control.| -||[setState(contentControlState: Word.ContentControlState)](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-setstate-member(1))|Sets the state of the content control.| -||[xmlMapping](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-xmlmapping-member)|Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document.| -|[ContentControlAddedEventArgs](/javascript/api/word/word.contentcontroladdedeventargs)|[eventType](/javascript/api/word/word.contentcontroladdedeventargs#word-word-contentcontroladdedeventargs-eventtype-member)|The event type.| -|[ContentControlDataChangedEventArgs](/javascript/api/word/word.contentcontroldatachangedeventargs)|[eventType](/javascript/api/word/word.contentcontroldatachangedeventargs#word-word-contentcontroldatachangedeventargs-eventtype-member)|The event type.| -|[ContentControlDeletedEventArgs](/javascript/api/word/word.contentcontroldeletedeventargs)|[eventType](/javascript/api/word/word.contentcontroldeletedeventargs#word-word-contentcontroldeletedeventargs-eventtype-member)|The event type.| -|[ContentControlEnteredEventArgs](/javascript/api/word/word.contentcontrolenteredeventargs)|[eventType](/javascript/api/word/word.contentcontrolenteredeventargs#word-word-contentcontrolenteredeventargs-eventtype-member)|The event type.| -|[ContentControlExitedEventArgs](/javascript/api/word/word.contentcontrolexitedeventargs)|[eventType](/javascript/api/word/word.contentcontrolexitedeventargs#word-word-contentcontrolexitedeventargs-eventtype-member)|The event type.| -|[ContentControlPlaceholderOptions](/javascript/api/word/word.contentcontrolplaceholderoptions)|[buildingBlock](/javascript/api/word/word.contentcontrolplaceholderoptions#word-word-contentcontrolplaceholderoptions-buildingblock-member)|If provided, specifies the `BuildingBlock` object to use as placeholder.| -||[range](/javascript/api/word/word.contentcontrolplaceholderoptions#word-word-contentcontrolplaceholderoptions-range-member)|If provided, specifies the `Range` object to use as placeholder.| -||[text](/javascript/api/word/word.contentcontrolplaceholderoptions#word-word-contentcontrolplaceholderoptions-text-member)|If provided, specifies the text to use as placeholder.| -|[ContentControlSelectionChangedEventArgs](/javascript/api/word/word.contentcontrolselectionchangedeventargs)|[eventType](/javascript/api/word/word.contentcontrolselectionchangedeventargs#word-word-contentcontrolselectionchangedeventargs-eventtype-member)|The event type.| -|[CustomXmlAddNodeOptions](/javascript/api/word/word.customxmladdnodeoptions)|[name](/javascript/api/word/word.customxmladdnodeoptions#word-word-customxmladdnodeoptions-name-member)|If provided, specifies the base name of the element to be added.| -||[namespaceUri](/javascript/api/word/word.customxmladdnodeoptions#word-word-customxmladdnodeoptions-namespaceuri-member)|If provided, specifies the namespace of the element to be appended.| -||[nextSibling](/javascript/api/word/word.customxmladdnodeoptions#word-word-customxmladdnodeoptions-nextsibling-member)|If provided, specifies the node which should become the next sibling of the new node.| -||[nodeType](/javascript/api/word/word.customxmladdnodeoptions#word-word-customxmladdnodeoptions-nodetype-member)|If provided, specifies the type of node to add.| -||[nodeValue](/javascript/api/word/word.customxmladdnodeoptions#word-word-customxmladdnodeoptions-nodevalue-member)|If provided, specifies the value of the added node for those nodes that allow text.| -|[CustomXmlAddSchemaOptions](/javascript/api/word/word.customxmladdschemaoptions)|[alias](/javascript/api/word/word.customxmladdschemaoptions#word-word-customxmladdschemaoptions-alias-member)|If provided, specifies the alias of the schema to be added to the collection.| -||[fileName](/javascript/api/word/word.customxmladdschemaoptions#word-word-customxmladdschemaoptions-filename-member)|If provided, specifies the location of the schema on a disk.| -||[installForAllUsers](/javascript/api/word/word.customxmladdschemaoptions#word-word-customxmladdschemaoptions-installforallusers-member)|If provided, specifies whether, in the case where the schema is being added to the Schema Library, the Schema Library keys should be written to the registry (`HKEY_LOCAL_MACHINE` for all users or `HKEY_CURRENT_USER` for just the current user).| -||[namespaceUri](/javascript/api/word/word.customxmladdschemaoptions#word-word-customxmladdschemaoptions-namespaceuri-member)|If provided, specifies the namespace of the schema to be added to the collection.| -|[CustomXmlAddValidationErrorOptions](/javascript/api/word/word.customxmladdvalidationerroroptions)|[clearedOnUpdate](/javascript/api/word/word.customxmladdvalidationerroroptions#word-word-customxmladdvalidationerroroptions-clearedonupdate-member)|If provided, specifies whether the error is to be cleared from the Word.CustomXmlValidationErrorCollection when the XML is corrected and updated.| -||[errorText](/javascript/api/word/word.customxmladdvalidationerroroptions#word-word-customxmladdvalidationerroroptions-errortext-member)|If provided, specifies the descriptive error text.| -|[CustomXmlAppendChildNodeOptions](/javascript/api/word/word.customxmlappendchildnodeoptions)|[name](/javascript/api/word/word.customxmlappendchildnodeoptions#word-word-customxmlappendchildnodeoptions-name-member)|If provided, specifies the base name of the element to be appended.| -||[namespaceUri](/javascript/api/word/word.customxmlappendchildnodeoptions#word-word-customxmlappendchildnodeoptions-namespaceuri-member)|If provided, specifies the namespace of the element to be appended.| -||[nodeType](/javascript/api/word/word.customxmlappendchildnodeoptions#word-word-customxmlappendchildnodeoptions-nodetype-member)|If provided, specifies the type of node to append.| -||[nodeValue](/javascript/api/word/word.customxmlappendchildnodeoptions#word-word-customxmlappendchildnodeoptions-nodevalue-member)|If provided, specifies the value of the appended node for those nodes that allow text.| -|[CustomXmlInsertNodeBeforeOptions](/javascript/api/word/word.customxmlinsertnodebeforeoptions)|[name](/javascript/api/word/word.customxmlinsertnodebeforeoptions#word-word-customxmlinsertnodebeforeoptions-name-member)|If provided, specifies the base name of the element to be inserted.| -||[namespaceUri](/javascript/api/word/word.customxmlinsertnodebeforeoptions#word-word-customxmlinsertnodebeforeoptions-namespaceuri-member)|If provided, specifies the namespace of the element to be inserted.| -||[nextSibling](/javascript/api/word/word.customxmlinsertnodebeforeoptions#word-word-customxmlinsertnodebeforeoptions-nextsibling-member)|If provided, specifies the context node.| -||[nodeType](/javascript/api/word/word.customxmlinsertnodebeforeoptions#word-word-customxmlinsertnodebeforeoptions-nodetype-member)|If provided, specifies the type of node to append.| -||[nodeValue](/javascript/api/word/word.customxmlinsertnodebeforeoptions#word-word-customxmlinsertnodebeforeoptions-nodevalue-member)|If provided, specifies the value of the inserted node for those nodes that allow text.| -|[CustomXmlInsertSubtreeBeforeOptions](/javascript/api/word/word.customxmlinsertsubtreebeforeoptions)|[nextSibling](/javascript/api/word/word.customxmlinsertsubtreebeforeoptions#word-word-customxmlinsertsubtreebeforeoptions-nextsibling-member)|If provided, specifies the context node.| -|[CustomXmlNode](/javascript/api/word/word.customxmlnode)|[appendChildNode(options?: Word.CustomXmlAppendChildNodeOptions)](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-appendchildnode-member(1))|Appends a single node as the last child under the context element node in the tree.| -||[appendChildSubtree(xml: string)](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-appendchildsubtree-member(1))|Adds a subtree as the last child under the context element node in the tree.| -||[attributes](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-attributes-member)|Gets a `CustomXmlNodeCollection` object representing the attributes of the current element in the current node.| -||[baseName](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-basename-member)|Gets the base name of the node without the namespace prefix, if one exists.| -||[childNodes](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-childnodes-member)|Gets a `CustomXmlNodeCollection` object containing all of the child elements of the current node.| -||[delete()](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-delete-member(1))|Deletes the current node from the tree (including all of its children, if any exist).| -||[firstChild](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-firstchild-member)|Gets a `CustomXmlNode` object corresponding to the first child element of the current node.| -||[hasChildNodes()](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-haschildnodes-member(1))|Specifies if the current element node has child element nodes.| -||[insertNodeBefore(options?: Word.CustomXmlInsertNodeBeforeOptions)](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-insertnodebefore-member(1))|Inserts a new node just before the context node in the tree.| -||[insertSubtreeBefore(xml: string, options?: Word.CustomXmlInsertSubtreeBeforeOptions)](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-insertsubtreebefore-member(1))|Inserts the specified subtree into the location just before the context node.| -||[lastChild](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-lastchild-member)|Gets a `CustomXmlNode` object corresponding to the last child element of the current node.| -||[namespaceUri](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-namespaceuri-member)|Gets the unique address identifier for the namespace of the node.| -||[nextSibling](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-nextsibling-member)|Gets the next sibling node (element, comment, or processing instruction) of the current node.| -||[nodeType](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-nodetype-member)|Gets the type of the current node.| -||[nodeValue](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-nodevalue-member)|Specifies the value of the current node.| -||[ownerPart](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-ownerpart-member)|Gets the object representing the part associated with this node.| -||[parentNode](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-parentnode-member)|Gets the parent element node of the current node.| -||[previousSibling](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-previoussibling-member)|Gets the previous sibling node (element, comment, or processing instruction) of the current node.| -||[removeChild(child: Word.CustomXmlNode)](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-removechild-member(1))|Removes the specified child node from the tree.| -||[replaceChildNode(oldNode: Word.CustomXmlNode, options?: Word.CustomXmlReplaceChildNodeOptions)](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-replacechildnode-member(1))|Removes the specified child node and replaces it with a different node in the same location.| -||[replaceChildSubtree(xml: string, oldNode: Word.CustomXmlNode)](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-replacechildsubtree-member(1))|Removes the specified node and replaces it with a different subtree in the same location.| -||[selectNodes(xPath: string)](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-selectnodes-member(1))|Selects a collection of nodes matching an XPath expression.| -||[selectSingleNode(xPath: string)](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-selectsinglenode-member(1))|Selects a single node from a collection matching an XPath expression.| -||[text](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-text-member)|Specifies the text for the current node.| -||[xml](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-xml-member)|Gets the XML representation of the current node and its children.| -||[xpath](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-xpath-member)|Gets a string with the canonicalized XPath for the current node.| -|[CustomXmlNodeCollection](/javascript/api/word/word.customxmlnodecollection)|[getCount()](/javascript/api/word/word.customxmlnodecollection#word-word-customxmlnodecollection-getcount-member(1))|Returns the number of items in the collection.| -||[getItem(index: number)](/javascript/api/word/word.customxmlnodecollection#word-word-customxmlnodecollection-getitem-member(1))|Returns a `CustomXmlNode` object that represents the specified item in the collection.| -||[items](/javascript/api/word/word.customxmlnodecollection#word-word-customxmlnodecollection-items-member)|Gets the loaded child items in this collection.| -|[CustomXmlPart](/javascript/api/word/word.customxmlpart)|[addNode(parent: Word.CustomXmlNode, options?: Word.CustomXmlAddNodeOptions)](/javascript/api/word/word.customxmlpart#word-word-customxmlpart-addnode-member(1))|Adds a node to the XML tree.| -||[builtIn](/javascript/api/word/word.customxmlpart#word-word-customxmlpart-builtin-member)|Gets a value that indicates whether the `CustomXmlPart` is built-in.| -||[documentElement](/javascript/api/word/word.customxmlpart#word-word-customxmlpart-documentelement-member)|Gets the root element of a bound region of data in the document.| -||[errors](/javascript/api/word/word.customxmlpart#word-word-customxmlpart-errors-member)|Gets a `CustomXmlValidationErrorCollection` object that provides access to any XML validation errors.| -||[loadXml(xml: string)](/javascript/api/word/word.customxmlpart#word-word-customxmlpart-loadxml-member(1))|Populates the `CustomXmlPart` object from an XML string.| -||[namespaceManager](/javascript/api/word/word.customxmlpart#word-word-customxmlpart-namespacemanager-member)|Gets the set of namespace prefix mappings used against the current `CustomXmlPart` object.| -||[schemaCollection](/javascript/api/word/word.customxmlpart#word-word-customxmlpart-schemacollection-member)|Specifies a `CustomXmlSchemaCollection` object representing the set of schemas attached to a bound region of data in the document.| -||[selectNodes(xPath: string)](/javascript/api/word/word.customxmlpart#word-word-customxmlpart-selectnodes-member(1))|Selects a collection of nodes from a custom XML part.| -||[selectSingleNode(xPath: string)](/javascript/api/word/word.customxmlpart#word-word-customxmlpart-selectsinglenode-member(1))|Selects a single node within a custom XML part matching an XPath expression.| -||[xml](/javascript/api/word/word.customxmlpart#word-word-customxmlpart-xml-member)|Gets the XML representation of the current `CustomXmlPart` object.| -|[CustomXmlPrefixMapping](/javascript/api/word/word.customxmlprefixmapping)|[namespaceUri](/javascript/api/word/word.customxmlprefixmapping#word-word-customxmlprefixmapping-namespaceuri-member)|Gets the unique address identifier for the namespace of the `CustomXmlPrefixMapping` object.| -||[prefix](/javascript/api/word/word.customxmlprefixmapping#word-word-customxmlprefixmapping-prefix-member)|Gets the prefix for the `CustomXmlPrefixMapping` object.| -|[CustomXmlPrefixMappingCollection](/javascript/api/word/word.customxmlprefixmappingcollection)|[addNamespace(prefix: string, namespaceUri: string)](/javascript/api/word/word.customxmlprefixmappingcollection#word-word-customxmlprefixmappingcollection-addnamespace-member(1))|Adds a custom namespace/prefix mapping to use when querying an item.| -||[getCount()](/javascript/api/word/word.customxmlprefixmappingcollection#word-word-customxmlprefixmappingcollection-getcount-member(1))|Returns the number of items in the collection.| -||[getItem(index: number)](/javascript/api/word/word.customxmlprefixmappingcollection#word-word-customxmlprefixmappingcollection-getitem-member(1))|Returns a `CustomXmlPrefixMapping` object that represents the specified item in the collection.| -||[items](/javascript/api/word/word.customxmlprefixmappingcollection#word-word-customxmlprefixmappingcollection-items-member)|Gets the loaded child items in this collection.| -||[lookupNamespace(prefix: string)](/javascript/api/word/word.customxmlprefixmappingcollection#word-word-customxmlprefixmappingcollection-lookupnamespace-member(1))|Gets the namespace corresponding to the specified prefix.| -||[lookupPrefix(namespaceUri: string)](/javascript/api/word/word.customxmlprefixmappingcollection#word-word-customxmlprefixmappingcollection-lookupprefix-member(1))|Gets the prefix corresponding to the specified namespace.| -|[CustomXmlReplaceChildNodeOptions](/javascript/api/word/word.customxmlreplacechildnodeoptions)|[name](/javascript/api/word/word.customxmlreplacechildnodeoptions#word-word-customxmlreplacechildnodeoptions-name-member)|If provided, specifies the base name of the replacement element.| -||[namespaceUri](/javascript/api/word/word.customxmlreplacechildnodeoptions#word-word-customxmlreplacechildnodeoptions-namespaceuri-member)|If provided, specifies the namespace of the replacement element.| -||[nodeType](/javascript/api/word/word.customxmlreplacechildnodeoptions#word-word-customxmlreplacechildnodeoptions-nodetype-member)|If provided, specifies the type of the replacement node.| -||[nodeValue](/javascript/api/word/word.customxmlreplacechildnodeoptions#word-word-customxmlreplacechildnodeoptions-nodevalue-member)|If provided, specifies the value of the replacement node for those nodes that allow text.| -|[CustomXmlSchema](/javascript/api/word/word.customxmlschema)|[delete()](/javascript/api/word/word.customxmlschema#word-word-customxmlschema-delete-member(1))|Deletes this schema from the Word.CustomXmlSchemaCollection object.| -||[location](/javascript/api/word/word.customxmlschema#word-word-customxmlschema-location-member)|Gets the location of the schema on a computer.| -||[namespaceUri](/javascript/api/word/word.customxmlschema#word-word-customxmlschema-namespaceuri-member)|Gets the unique address identifier for the namespace of the `CustomXmlSchema` object.| -||[reload()](/javascript/api/word/word.customxmlschema#word-word-customxmlschema-reload-member(1))|Reloads the schema from a file.| -|[CustomXmlSchemaCollection](/javascript/api/word/word.customxmlschemacollection)|[add(options?: Word.CustomXmlAddSchemaOptions)](/javascript/api/word/word.customxmlschemacollection#word-word-customxmlschemacollection-add-member(1))|Adds one or more schemas to the schema collection that can then be added to a stream in the data store and to the schema library.| -||[addCollection(schemaCollection: Word.CustomXmlSchemaCollection)](/javascript/api/word/word.customxmlschemacollection#word-word-customxmlschemacollection-addcollection-member(1))|Adds an existing schema collection to the current schema collection.| -||[getCount()](/javascript/api/word/word.customxmlschemacollection#word-word-customxmlschemacollection-getcount-member(1))|Returns the number of items in the collection.| -||[getItem(index: number)](/javascript/api/word/word.customxmlschemacollection#word-word-customxmlschemacollection-getitem-member(1))|Returns a `CustomXmlSchema` object that represents the specified item in the collection.| -||[getNamespaceUri()](/javascript/api/word/word.customxmlschemacollection#word-word-customxmlschemacollection-getnamespaceuri-member(1))|Returns the number of items in the collection.| -||[items](/javascript/api/word/word.customxmlschemacollection#word-word-customxmlschemacollection-items-member)|Gets the loaded child items in this collection.| -||[validate()](/javascript/api/word/word.customxmlschemacollection#word-word-customxmlschemacollection-validate-member(1))|Specifies whether the schemas in the schema collection are valid (conforms to the syntactic rules of XML and the rules for a specified vocabulary).| -|[CustomXmlValidationError](/javascript/api/word/word.customxmlvalidationerror)|[delete()](/javascript/api/word/word.customxmlvalidationerror#word-word-customxmlvalidationerror-delete-member(1))|Deletes this `CustomXmlValidationError` object.| -||[errorCode](/javascript/api/word/word.customxmlvalidationerror#word-word-customxmlvalidationerror-errorcode-member)|Gets an integer representing the validation error in the `CustomXmlValidationError` object.| -||[name](/javascript/api/word/word.customxmlvalidationerror#word-word-customxmlvalidationerror-name-member)|Gets the name of the error in the `CustomXmlValidationError` object.If no errors exist, the property returns `Nothing`| -||[node](/javascript/api/word/word.customxmlvalidationerror#word-word-customxmlvalidationerror-node-member)|Gets the node associated with this `CustomXmlValidationError` object, if any exist.If no nodes exist, the property returns `Nothing`.| -||[text](/javascript/api/word/word.customxmlvalidationerror#word-word-customxmlvalidationerror-text-member)|Gets the text in the `CustomXmlValidationError` object.| -||[type](/javascript/api/word/word.customxmlvalidationerror#word-word-customxmlvalidationerror-type-member)|Gets the type of error generated from the `CustomXmlValidationError` object.| -|[CustomXmlValidationErrorCollection](/javascript/api/word/word.customxmlvalidationerrorcollection)|[add(node: Word.CustomXmlNode, errorName: string, options?: Word.CustomXmlAddValidationErrorOptions)](/javascript/api/word/word.customxmlvalidationerrorcollection#word-word-customxmlvalidationerrorcollection-add-member(1))|Adds a `CustomXmlValidationError` object containing an XML validation error to the `CustomXmlValidationErrorCollection` object.| -||[getCount()](/javascript/api/word/word.customxmlvalidationerrorcollection#word-word-customxmlvalidationerrorcollection-getcount-member(1))|Returns the number of items in the collection.| -||[getItem(index: number)](/javascript/api/word/word.customxmlvalidationerrorcollection#word-word-customxmlvalidationerrorcollection-getitem-member(1))|Returns a `CustomXmlValidationError` object that represents the specified item in the collection.| -||[items](/javascript/api/word/word.customxmlvalidationerrorcollection#word-word-customxmlvalidationerrorcollection-items-member)|Gets the loaded child items in this collection.| -|[DatePickerContentControl](/javascript/api/word/word.datepickercontentcontrol)|[appearance](/javascript/api/word/word.datepickercontentcontrol#word-word-datepickercontentcontrol-appearance-member)|Specifies the appearance of the content control.| -||[color](/javascript/api/word/word.datepickercontentcontrol#word-word-datepickercontentcontrol-color-member)|Specifies the red-green-blue (RGB) value of the color of the content control.| -||[copy()](/javascript/api/word/word.datepickercontentcontrol#word-word-datepickercontentcontrol-copy-member(1))|Copies the content control from the active document to the Clipboard.| -||[cut()](/javascript/api/word/word.datepickercontentcontrol#word-word-datepickercontentcontrol-cut-member(1))|Removes the content control from the active document and moves the content control to the Clipboard.| -||[dateCalendarType](/javascript/api/word/word.datepickercontentcontrol#word-word-datepickercontentcontrol-datecalendartype-member)|Specifies a `CalendarType` value that represents the calendar type for the date picker content control.| -||[dateDisplayFormat](/javascript/api/word/word.datepickercontentcontrol#word-word-datepickercontentcontrol-datedisplayformat-member)|Specifies the format in which dates are displayed.| -||[dateDisplayLocale](/javascript/api/word/word.datepickercontentcontrol#word-word-datepickercontentcontrol-datedisplaylocale-member)|Specifies a `LanguageId` that represents the language format for the date displayed in the date picker content control.| -||[dateStorageFormat](/javascript/api/word/word.datepickercontentcontrol#word-word-datepickercontentcontrol-datestorageformat-member)|Specifies a `ContentControlDateStorageFormat` value that represents the format for storage and retrieval of dates when the date picker content control is bound to the XML data store of the active document.| -||[delete(deleteContents?: boolean)](/javascript/api/word/word.datepickercontentcontrol#word-word-datepickercontentcontrol-delete-member(1))|Deletes this content control and the contents of the content control.| -||[id](/javascript/api/word/word.datepickercontentcontrol#word-word-datepickercontentcontrol-id-member)|Gets the identification for the content control.| -||[isTemporary](/javascript/api/word/word.datepickercontentcontrol#word-word-datepickercontentcontrol-istemporary-member)|Specifies whether to remove the content control from the active document when the user edits the contents of the control.| -||[level](/javascript/api/word/word.datepickercontentcontrol#word-word-datepickercontentcontrol-level-member)|Specifies the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline.| -||[lockContentControl](/javascript/api/word/word.datepickercontentcontrol#word-word-datepickercontentcontrol-lockcontentcontrol-member)|Specifies if the content control is locked (can't be deleted).| -||[lockContents](/javascript/api/word/word.datepickercontentcontrol#word-word-datepickercontentcontrol-lockcontents-member)|Specifies if the contents of the content control are locked (not editable).| -||[placeholderText](/javascript/api/word/word.datepickercontentcontrol#word-word-datepickercontentcontrol-placeholdertext-member)|Returns a `BuildingBlock` object that represents the placeholder text for the content control.| -||[range](/javascript/api/word/word.datepickercontentcontrol#word-word-datepickercontentcontrol-range-member)|Gets a `Range` object that represents the contents of the content control in the active document.| -||[setPlaceholderText(options?: Word.ContentControlPlaceholderOptions)](/javascript/api/word/word.datepickercontentcontrol#word-word-datepickercontentcontrol-setplaceholdertext-member(1))|Sets the placeholder text that displays in the content control until a user enters their own text.| -||[showingPlaceholderText](/javascript/api/word/word.datepickercontentcontrol#word-word-datepickercontentcontrol-showingplaceholdertext-member)|Gets whether the placeholder text for the content control is being displayed.| -||[tag](/javascript/api/word/word.datepickercontentcontrol#word-word-datepickercontentcontrol-tag-member)|Specifies a tag to identify the content control.| -||[title](/javascript/api/word/word.datepickercontentcontrol#word-word-datepickercontentcontrol-title-member)|Specifies the title for the content control.| -||[xmlMapping](/javascript/api/word/word.datepickercontentcontrol#word-word-datepickercontentcontrol-xmlmapping-member)|Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document.| -|[Document](/javascript/api/word/word.document)|[attachedTemplate](/javascript/api/word/word.document#word-word-document-attachedtemplate-member)|Specifies a `Template` object that represents the template attached to the document.| -||[autoHyphenation](/javascript/api/word/word.document#word-word-document-autohyphenation-member)|Specifies if automatic hyphenation is turned on for the document.| -||[autoSaveOn](/javascript/api/word/word.document#word-word-document-autosaveon-member)|Specifies if the edits in the document are automatically saved.| -||[bibliography](/javascript/api/word/word.document#word-word-document-bibliography-member)|Returns a `Bibliography` object that represents the bibliography references contained within the document.| -||[bookmarks](/javascript/api/word/word.document#word-word-document-bookmarks-member)|Returns a `BookmarkCollection` object that represents all the bookmarks in the document.| -||[consecutiveHyphensLimit](/javascript/api/word/word.document#word-word-document-consecutivehyphenslimit-member)|Specifies the maximum number of consecutive lines that can end with hyphens.| -||[detectLanguage()](/javascript/api/word/word.document#word-word-document-detectlanguage-member(1))|Analyzes the document text to determine the language.| -||[documentLibraryVersions](/javascript/api/word/word.document#word-word-document-documentlibraryversions-member)|Returns a `DocumentLibraryVersionCollection` object that represents the collection of versions of a shared document that has versioning enabled and that's stored in a document library on a server.| -||[frames](/javascript/api/word/word.document#word-word-document-frames-member)|Returns a `FrameCollection` object that represents all the frames in the document.| -||[hyperlinks](/javascript/api/word/word.document#word-word-document-hyperlinks-member)|Returns a `HyperlinkCollection` object that represents all the hyperlinks in the document.| -||[hyphenateCaps](/javascript/api/word/word.document#word-word-document-hyphenatecaps-member)|Specifies whether words in all capital letters can be hyphenated.| -||[indexes](/javascript/api/word/word.document#word-word-document-indexes-member)|Returns an `IndexCollection` object that represents all the indexes in the document.| -||[languageDetected](/javascript/api/word/word.document#word-word-document-languagedetected-member)|Specifies whether Microsoft Word has detected the language of the document text.| -||[manualHyphenation()](/javascript/api/word/word.document#word-word-document-manualhyphenation-member(1))|Initiates manual hyphenation of a document, one line at a time.| -||[pageSetup](/javascript/api/word/word.document#word-word-document-pagesetup-member)|Returns a `PageSetup` object that's associated with the document.| -|[DocumentLibraryVersion](/javascript/api/word/word.documentlibraryversion)|[comments](/javascript/api/word/word.documentlibraryversion#word-word-documentlibraryversion-comments-member)|Gets any optional comments associated with this version of the shared document.| -||[modified](/javascript/api/word/word.documentlibraryversion#word-word-documentlibraryversion-modified-member)|Gets the date and time at which this version of the shared document was last saved to the server.| -||[modifiedBy](/javascript/api/word/word.documentlibraryversion#word-word-documentlibraryversion-modifiedby-member)|Gets the name of the user who last saved this version of the shared document to the server.| -|[DocumentLibraryVersionCollection](/javascript/api/word/word.documentlibraryversioncollection)|[getItem(index: number)](/javascript/api/word/word.documentlibraryversioncollection#word-word-documentlibraryversioncollection-getitem-member(1))|Gets a `DocumentLibraryVersion` object by its index in the collection.| -||[isVersioningEnabled()](/javascript/api/word/word.documentlibraryversioncollection#word-word-documentlibraryversioncollection-isversioningenabled-member(1))|Returns whether the document library in which the active document is saved on the server is configured to create a backup copy, or version, each time the file is edited on the website.| -||[items](/javascript/api/word/word.documentlibraryversioncollection#word-word-documentlibraryversioncollection-items-member)|Gets the loaded child items in this collection.| -|[DropCap](/javascript/api/word/word.dropcap)|[clear()](/javascript/api/word/word.dropcap#word-word-dropcap-clear-member(1))|Removes the dropped capital letter formatting.| -||[distanceFromText](/javascript/api/word/word.dropcap#word-word-dropcap-distancefromtext-member)|Gets the distance (in points) between the dropped capital letter and the paragraph text.| -||[enable()](/javascript/api/word/word.dropcap#word-word-dropcap-enable-member(1))|Formats the first character in the specified paragraph as a dropped capital letter.| -||[fontName](/javascript/api/word/word.dropcap#word-word-dropcap-fontname-member)|Gets the name of the font for the dropped capital letter.| -||[linesToDrop](/javascript/api/word/word.dropcap#word-word-dropcap-linestodrop-member)|Gets the height (in lines) of the dropped capital letter.| -||[position](/javascript/api/word/word.dropcap#word-word-dropcap-position-member)|Gets the position of the dropped capital letter.| -|[Field](/javascript/api/word/word.field)|[copyToClipboard()](/javascript/api/word/word.field#word-word-field-copytoclipboard-member(1))|Copies the field to the Clipboard.| -||[cut()](/javascript/api/word/word.field#word-word-field-cut-member(1))|Removes the field from the document and places it on the Clipboard.| -||[doClick()](/javascript/api/word/word.field#word-word-field-doclick-member(1))|Clicks the field.| -||[linkFormat](/javascript/api/word/word.field#word-word-field-linkformat-member)|Gets a `LinkFormat` object that represents the link options of the field.| -||[oleFormat](/javascript/api/word/word.field#word-word-field-oleformat-member)|Gets an `OleFormat` object that represents the OLE characteristics (other than linking) for the field.| -||[unlink()](/javascript/api/word/word.field#word-word-field-unlink-member(1))|Replaces the field with its most recent result.| -||[updateSource()](/javascript/api/word/word.field#word-word-field-updatesource-member(1))|Saves the changes made to the results of an {@link https://support.microsoft.com/office/1c34d6d6-0de3-4b5c-916a-2ff950fb629e | INCLUDETEXT field} back to the source document.| -|[FillFormat](/javascript/api/word/word.fillformat)|[backgroundColor](/javascript/api/word/word.fillformat#word-word-fillformat-backgroundcolor-member)|Returns a `ColorFormat` object that represents the background color for the fill.| -||[foregroundColor](/javascript/api/word/word.fillformat#word-word-fillformat-foregroundcolor-member)|Returns a `ColorFormat` object that represents the foreground color for the fill.| -||[gradientAngle](/javascript/api/word/word.fillformat#word-word-fillformat-gradientangle-member)|Specifies the angle of the gradient fill.| -||[gradientColorType](/javascript/api/word/word.fillformat#word-word-fillformat-gradientcolortype-member)|Gets the gradient color type.| -||[gradientDegree](/javascript/api/word/word.fillformat#word-word-fillformat-gradientdegree-member)|Returns how dark or light a one-color gradient fill is.| -||[gradientStyle](/javascript/api/word/word.fillformat#word-word-fillformat-gradientstyle-member)|Returns the gradient style for the fill.| -||[gradientVariant](/javascript/api/word/word.fillformat#word-word-fillformat-gradientvariant-member)|Returns the gradient variant for the fill as an integer value from 1 to 4 for most gradient fills.| -||[isVisible](/javascript/api/word/word.fillformat#word-word-fillformat-isvisible-member)|Specifies if the object, or the formatting applied to it, is visible.| -||[pattern](/javascript/api/word/word.fillformat#word-word-fillformat-pattern-member)|Returns a `PatternType` value that represents the pattern applied to the fill or line.| -||[presetGradientType](/javascript/api/word/word.fillformat#word-word-fillformat-presetgradienttype-member)|Returns the preset gradient type for the fill.| -||[presetTexture](/javascript/api/word/word.fillformat#word-word-fillformat-presettexture-member)|Gets the preset texture.| -||[rotateWithObject](/javascript/api/word/word.fillformat#word-word-fillformat-rotatewithobject-member)|Specifies whether the fill rotates with the shape.| -||[setOneColorGradient(style: Word.GradientStyle, variant: number, degree: number)](/javascript/api/word/word.fillformat#word-word-fillformat-setonecolorgradient-member(1))|Sets the fill to a one-color gradient.| -||[setPatterned(pattern: Word.PatternType)](/javascript/api/word/word.fillformat#word-word-fillformat-setpatterned-member(1))|Sets the fill to a pattern.| -||[setPresetGradient(style: Word.GradientStyle, variant: number, presetGradientType: Word.PresetGradientType)](/javascript/api/word/word.fillformat#word-word-fillformat-setpresetgradient-member(1))|Sets the fill to a preset gradient.| -||[setPresetTextured(presetTexture: Word.PresetTexture)](/javascript/api/word/word.fillformat#word-word-fillformat-setpresettextured-member(1))|Sets the fill to a preset texture.| -||[setTwoColorGradient(style: Word.GradientStyle, variant: number)](/javascript/api/word/word.fillformat#word-word-fillformat-settwocolorgradient-member(1))|Sets the fill to a two-color gradient.| -||[solid()](/javascript/api/word/word.fillformat#word-word-fillformat-solid-member(1))|Sets the fill to a uniform color.| -||[textureAlignment](/javascript/api/word/word.fillformat#word-word-fillformat-texturealignment-member)|Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill.| -||[textureHorizontalScale](/javascript/api/word/word.fillformat#word-word-fillformat-texturehorizontalscale-member)|Specifies the horizontal scaling factor for the texture fill.| -||[textureName](/javascript/api/word/word.fillformat#word-word-fillformat-texturename-member)|Returns the name of the custom texture file for the fill.| -||[textureOffsetX](/javascript/api/word/word.fillformat#word-word-fillformat-textureoffsetx-member)|Specifies the horizontal offset of the texture from the origin in points.| -||[textureOffsetY](/javascript/api/word/word.fillformat#word-word-fillformat-textureoffsety-member)|Specifies the vertical offset of the texture.| -||[textureTile](/javascript/api/word/word.fillformat#word-word-fillformat-texturetile-member)|Specifies whether the texture is tiled.| -||[textureType](/javascript/api/word/word.fillformat#word-word-fillformat-texturetype-member)|Returns the texture type for the fill.| -||[textureVerticalScale](/javascript/api/word/word.fillformat#word-word-fillformat-textureverticalscale-member)|Specifies the vertical scaling factor for the texture fill as a value between 0.0 and 1.0.| -||[transparency](/javascript/api/word/word.fillformat#word-word-fillformat-transparency-member)|Specifies the degree of transparency of the fill for a shape as a value between 0.0 (opaque) and 1.0 (clear).| -||[type](/javascript/api/word/word.fillformat#word-word-fillformat-type-member)|Gets the fill format type.| -|[Font](/javascript/api/word/word.font)|[allCaps](/javascript/api/word/word.font#word-word-font-allcaps-member)|Specifies whether the font is formatted as all capital letters, which makes lowercase letters appear as uppercase letters.| -||[boldBidirectional](/javascript/api/word/word.font#word-word-font-boldbidirectional-member)|Specifies whether the font is formatted as bold in a right-to-left language document.| -||[borders](/javascript/api/word/word.font#word-word-font-borders-member)|Returns a `BorderUniversalCollection` object that represents all the borders for the font.| -||[colorIndex](/javascript/api/word/word.font#word-word-font-colorindex-member)|Specifies a `ColorIndex` value that represents the color for the font.| -||[colorIndexBidirectional](/javascript/api/word/word.font#word-word-font-colorindexbidirectional-member)|Specifies the color for the `Font` object in a right-to-left language document.| -||[contextualAlternates](/javascript/api/word/word.font#word-word-font-contextualalternates-member)|Specifies whether contextual alternates are enabled for the font.| -||[decreaseFontSize()](/javascript/api/word/word.font#word-word-font-decreasefontsize-member(1))|Decreases the font size to the next available size.| -||[diacriticColor](/javascript/api/word/word.font#word-word-font-diacriticcolor-member)|Specifies the color to be used for diacritics for the `Font` object.| -||[disableCharacterSpaceGrid](/javascript/api/word/word.font#word-word-font-disablecharacterspacegrid-member)|Specifies whether Microsoft Word ignores the number of characters per line for the corresponding `Font` object.| -||[emboss](/javascript/api/word/word.font#word-word-font-emboss-member)|Specifies whether the font is formatted as embossed.| -||[emphasisMark](/javascript/api/word/word.font#word-word-font-emphasismark-member)|Specifies an `EmphasisMark` value that represents the emphasis mark for a character or designated character string.| -||[engrave](/javascript/api/word/word.font#word-word-font-engrave-member)|Specifies whether the font is formatted as engraved.| -||[fill](/javascript/api/word/word.font#word-word-font-fill-member)|Returns a `FillFormat` object that contains fill formatting properties for the font used by the range of text.| -||[glow](/javascript/api/word/word.font#word-word-font-glow-member)|Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text.| -||[increaseFontSize()](/javascript/api/word/word.font#word-word-font-increasefontsize-member(1))|Increases the font size to the next available size.| -||[italicBidirectional](/javascript/api/word/word.font#word-word-font-italicbidirectional-member)|Specifies whether the font is italicized in a right-to-left language document.| -||[kerning](/javascript/api/word/word.font#word-word-font-kerning-member)|Specifies the minimum font size for which Microsoft Word will adjust kerning automatically.| -||[ligature](/javascript/api/word/word.font#word-word-font-ligature-member)|Specifies the ligature setting for the `Font` object.| -||[line](/javascript/api/word/word.font#word-word-font-line-member)|Returns a `LineFormat` object that specifies the formatting for a line.| -||[nameAscii](/javascript/api/word/word.font#word-word-font-nameascii-member)|Specifies the font used for Latin text (characters with character codes from 0 (zero) through 127).| -||[nameBidirectional](/javascript/api/word/word.font#word-word-font-namebidirectional-member)|Specifies the font name in a right-to-left language document.| -||[nameFarEast](/javascript/api/word/word.font#word-word-font-namefareast-member)|Specifies the East Asian font name.| -||[nameOther](/javascript/api/word/word.font#word-word-font-nameother-member)|Specifies the font used for characters with codes from 128 through 255.| -||[numberForm](/javascript/api/word/word.font#word-word-font-numberform-member)|Specifies the number form setting for an OpenType font.| -||[numberSpacing](/javascript/api/word/word.font#word-word-font-numberspacing-member)|Specifies the number spacing setting for the font.| -||[outline](/javascript/api/word/word.font#word-word-font-outline-member)|Specifies if the font is formatted as outlined.| -||[position](/javascript/api/word/word.font#word-word-font-position-member)|Specifies the position of text (in points) relative to the base line.| -||[reflection](/javascript/api/word/word.font#word-word-font-reflection-member)|Returns a `ReflectionFormat` object that represents the reflection formatting for a shape.| -||[reset()](/javascript/api/word/word.font#word-word-font-reset-member(1))|Removes manual character formatting.| -||[scaling](/javascript/api/word/word.font#word-word-font-scaling-member)|Specifies the scaling percentage applied to the font.| -||[setAsTemplateDefault()](/javascript/api/word/word.font#word-word-font-setastemplatedefault-member(1))|Sets the specified font formatting as the default for the active document and all new documents based on the active template.| -||[shadow](/javascript/api/word/word.font#word-word-font-shadow-member)|Specifies if the font is formatted as shadowed.| -||[sizeBidirectional](/javascript/api/word/word.font#word-word-font-sizebidirectional-member)|Specifies the font size in points for right-to-left text.| -||[smallCaps](/javascript/api/word/word.font#word-word-font-smallcaps-member)|Specifies whether the font is formatted as small caps, which makes lowercase letters appear as small uppercase letters.| -||[spacing](/javascript/api/word/word.font#word-word-font-spacing-member)|Specifies the spacing between characters.| -||[stylisticSet](/javascript/api/word/word.font#word-word-font-stylisticset-member)|Specifies the stylistic set for the font.| -||[textColor](/javascript/api/word/word.font#word-word-font-textcolor-member)|Returns a `ColorFormat` object that represents the color for the font.| -||[textShadow](/javascript/api/word/word.font#word-word-font-textshadow-member)|Returns a `ShadowFormat` object that specifies the shadow formatting for the font.| -||[threeDimensionalFormat](/javascript/api/word/word.font#word-word-font-threedimensionalformat-member)|Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font.| -||[underlineColor](/javascript/api/word/word.font#word-word-font-underlinecolor-member)|Specifies the color of the underline for the `Font` object.| -|[Frame](/javascript/api/word/word.frame)|[borders](/javascript/api/word/word.frame#word-word-frame-borders-member)|Returns a `BorderUniversalCollection` object that represents all the borders for the frame.| -||[copy()](/javascript/api/word/word.frame#word-word-frame-copy-member(1))|Copies the frame to the Clipboard.| -||[cut()](/javascript/api/word/word.frame#word-word-frame-cut-member(1))|Removes the frame from the document and places it on the Clipboard.| -||[delete()](/javascript/api/word/word.frame#word-word-frame-delete-member(1))|Deletes the frame.| -||[height](/javascript/api/word/word.frame#word-word-frame-height-member)|Specifies the height (in points) of the frame.| -||[heightRule](/javascript/api/word/word.frame#word-word-frame-heightrule-member)|Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame.| -||[horizontalDistanceFromText](/javascript/api/word/word.frame#word-word-frame-horizontaldistancefromtext-member)|Specifies the horizontal distance between the frame and the surrounding text, in points.| -||[horizontalPosition](/javascript/api/word/word.frame#word-word-frame-horizontalposition-member)|Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property.| -||[lockAnchor](/javascript/api/word/word.frame#word-word-frame-lockanchor-member)|Specifies if the frame is locked.| -||[range](/javascript/api/word/word.frame#word-word-frame-range-member)|Returns a `Range` object that represents the portion of the document that's contained within the frame.| -||[relativeHorizontalPosition](/javascript/api/word/word.frame#word-word-frame-relativehorizontalposition-member)|Specifies the relative horizontal position of the frame.| -||[relativeVerticalPosition](/javascript/api/word/word.frame#word-word-frame-relativeverticalposition-member)|Specifies the relative vertical position of the frame.| -||[select()](/javascript/api/word/word.frame#word-word-frame-select-member(1))|Selects the frame.| -||[shading](/javascript/api/word/word.frame#word-word-frame-shading-member)|Returns a `ShadingUniversal` object that refers to the shading formatting for the frame.| -||[textWrap](/javascript/api/word/word.frame#word-word-frame-textwrap-member)|Specifies if document text wraps around the frame.| -||[verticalDistanceFromText](/javascript/api/word/word.frame#word-word-frame-verticaldistancefromtext-member)|Specifies the vertical distance (in points) between the frame and the surrounding text.| -||[verticalPosition](/javascript/api/word/word.frame#word-word-frame-verticalposition-member)|Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property.| -||[width](/javascript/api/word/word.frame#word-word-frame-width-member)|Specifies the width (in points) of the frame.| -||[widthRule](/javascript/api/word/word.frame#word-word-frame-widthrule-member)|Specifies the rule used to determine the width of the frame.| -|[FrameCollection](/javascript/api/word/word.framecollection)|[add(range: Word.Range)](/javascript/api/word/word.framecollection#word-word-framecollection-add-member(1))|Returns a `Frame` object that represents a new frame added to a range, selection, or document.| -||[delete()](/javascript/api/word/word.framecollection#word-word-framecollection-delete-member(1))|Deletes the `FrameCollection` object.| -||[getItem(index: number)](/javascript/api/word/word.framecollection#word-word-framecollection-getitem-member(1))|Gets a `Frame` object by its index in the collection.| -||[items](/javascript/api/word/word.framecollection#word-word-framecollection-items-member)|Gets the loaded child items in this collection.| -|[GlowFormat](/javascript/api/word/word.glowformat)|[color](/javascript/api/word/word.glowformat#word-word-glowformat-color-member)|Returns a `ColorFormat` object that represents the color for a glow effect.| -||[radius](/javascript/api/word/word.glowformat#word-word-glowformat-radius-member)|Specifies the length of the radius for a glow effect.| -||[transparency](/javascript/api/word/word.glowformat#word-word-glowformat-transparency-member)|Specifies the degree of transparency for the glow effect as a value between 0.0 (opaque) and 1.0 (clear).| -|[GroupContentControl](/javascript/api/word/word.groupcontentcontrol)|[appearance](/javascript/api/word/word.groupcontentcontrol#word-word-groupcontentcontrol-appearance-member)|Specifies the appearance of the content control.| -||[color](/javascript/api/word/word.groupcontentcontrol#word-word-groupcontentcontrol-color-member)|Specifies the red-green-blue (RGB) value of the color of the content control.| -||[copy()](/javascript/api/word/word.groupcontentcontrol#word-word-groupcontentcontrol-copy-member(1))|Copies the content control from the active document to the Clipboard.| -||[cut()](/javascript/api/word/word.groupcontentcontrol#word-word-groupcontentcontrol-cut-member(1))|Removes the content control from the active document and moves the content control to the Clipboard.| -||[delete(deleteContents: boolean)](/javascript/api/word/word.groupcontentcontrol#word-word-groupcontentcontrol-delete-member(1))|Deletes the content control and optionally its contents.| -||[id](/javascript/api/word/word.groupcontentcontrol#word-word-groupcontentcontrol-id-member)|Returns the identification for the content control.| -||[isTemporary](/javascript/api/word/word.groupcontentcontrol#word-word-groupcontentcontrol-istemporary-member)|Specifies whether to remove the content control from the active document when the user edits the contents of the control.| -||[level](/javascript/api/word/word.groupcontentcontrol#word-word-groupcontentcontrol-level-member)|Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline.| -||[lockContentControl](/javascript/api/word/word.groupcontentcontrol#word-word-groupcontentcontrol-lockcontentcontrol-member)|Specifies if the content control is locked (can't be deleted).| -||[lockContents](/javascript/api/word/word.groupcontentcontrol#word-word-groupcontentcontrol-lockcontents-member)|Specifies if the contents of the content control are locked (not editable).| -||[placeholderText](/javascript/api/word/word.groupcontentcontrol#word-word-groupcontentcontrol-placeholdertext-member)|Returns a `BuildingBlock` object that represents the placeholder text for the content control.| -||[range](/javascript/api/word/word.groupcontentcontrol#word-word-groupcontentcontrol-range-member)|Gets a `Range` object that represents the contents of the content control in the active document.| -||[setPlaceholderText(options?: Word.ContentControlPlaceholderOptions)](/javascript/api/word/word.groupcontentcontrol#word-word-groupcontentcontrol-setplaceholdertext-member(1))|Sets the placeholder text that displays in the content control until a user enters their own text.| -||[showingPlaceholderText](/javascript/api/word/word.groupcontentcontrol#word-word-groupcontentcontrol-showingplaceholdertext-member)|Returns whether the placeholder text for the content control is being displayed.| -||[tag](/javascript/api/word/word.groupcontentcontrol#word-word-groupcontentcontrol-tag-member)|Specifies a tag to identify the content control.| -||[title](/javascript/api/word/word.groupcontentcontrol#word-word-groupcontentcontrol-title-member)|Specifies the title for the content control.| -||[ungroup()](/javascript/api/word/word.groupcontentcontrol#word-word-groupcontentcontrol-ungroup-member(1))|Removes the group content control from the document so that its child content controls are no longer nested and can be freely edited.| -||[xmlMapping](/javascript/api/word/word.groupcontentcontrol#word-word-groupcontentcontrol-xmlmapping-member)|Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document.| -|[Hyperlink](/javascript/api/word/word.hyperlink)|[addToFavorites()](/javascript/api/word/word.hyperlink#word-word-hyperlink-addtofavorites-member(1))|Creates a shortcut to the document or hyperlink and adds it to the **Favorites** folder.| -||[address](/javascript/api/word/word.hyperlink#word-word-hyperlink-address-member)|Specifies the address (for example, a file name or URL) of the hyperlink.| -||[createNewDocument(fileName: string, editNow: boolean, overwrite: boolean)](/javascript/api/word/word.hyperlink#word-word-hyperlink-createnewdocument-member(1))|Creates a new document linked to the hyperlink.| -||[delete()](/javascript/api/word/word.hyperlink#word-word-hyperlink-delete-member(1))|Deletes the hyperlink.| -||[emailSubject](/javascript/api/word/word.hyperlink#word-word-hyperlink-emailsubject-member)|Specifies the text string for the hyperlink's subject line.| -||[isExtraInfoRequired](/javascript/api/word/word.hyperlink#word-word-hyperlink-isextrainforequired-member)|Returns `true` if extra information is required to resolve the hyperlink.| -||[name](/javascript/api/word/word.hyperlink#word-word-hyperlink-name-member)|Returns the name of the `Hyperlink` object.| -||[range](/javascript/api/word/word.hyperlink#word-word-hyperlink-range-member)|Returns a `Range` object that represents the portion of the document that's contained within the hyperlink.| -||[screenTip](/javascript/api/word/word.hyperlink#word-word-hyperlink-screentip-member)|Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink.| -||[subAddress](/javascript/api/word/word.hyperlink#word-word-hyperlink-subaddress-member)|Specifies a named location in the destination of the hyperlink.| -||[target](/javascript/api/word/word.hyperlink#word-word-hyperlink-target-member)|Specifies the name of the frame or window in which to load the hyperlink.| -||[textToDisplay](/javascript/api/word/word.hyperlink#word-word-hyperlink-texttodisplay-member)|Specifies the hyperlink's visible text in the document.| -||[type](/javascript/api/word/word.hyperlink#word-word-hyperlink-type-member)|Returns the hyperlink type.| -|[HyperlinkAddOptions](/javascript/api/word/word.hyperlinkaddoptions)|[address](/javascript/api/word/word.hyperlinkaddoptions#word-word-hyperlinkaddoptions-address-member)|If provided, specifies the address (e.g., URL or file path) of the hyperlink.| -||[screenTip](/javascript/api/word/word.hyperlinkaddoptions#word-word-hyperlinkaddoptions-screentip-member)|If provided, specifies the text that appears as a tooltip.| -||[subAddress](/javascript/api/word/word.hyperlinkaddoptions#word-word-hyperlinkaddoptions-subaddress-member)|If provided, specifies the location within the file or document.| -||[target](/javascript/api/word/word.hyperlinkaddoptions#word-word-hyperlinkaddoptions-target-member)|If provided, specifies the name of the frame or window in which to load the hyperlink.| -||[textToDisplay](/javascript/api/word/word.hyperlinkaddoptions#word-word-hyperlinkaddoptions-texttodisplay-member)|If provided, specifies the visible text of the hyperlink.| -|[HyperlinkCollection](/javascript/api/word/word.hyperlinkcollection)|[add(anchor: Word.Range, options?: Word.HyperlinkAddOptions)](/javascript/api/word/word.hyperlinkcollection#word-word-hyperlinkcollection-add-member(1))|Returns a `Hyperlink` object that represents a new hyperlink added to a range, selection, or document.| -||[items](/javascript/api/word/word.hyperlinkcollection#word-word-hyperlinkcollection-items-member)|Gets the loaded child items in this collection.| -|[Index](/javascript/api/word/word.index)|[delete()](/javascript/api/word/word.index#word-word-index-delete-member(1))|Deletes this index.| -||[filter](/javascript/api/word/word.index#word-word-index-filter-member)|Gets a value that represents how Microsoft Word classifies the first character of entries in the index.| -||[headingSeparator](/javascript/api/word/word.index#word-word-index-headingseparator-member)|Gets the text between alphabetical groups (entries that start with the same letter) in the index.| -||[indexLanguage](/javascript/api/word/word.index#word-word-index-indexlanguage-member)|Gets a `LanguageId` value that represents the sorting language to use for the index.| -||[numberOfColumns](/javascript/api/word/word.index#word-word-index-numberofcolumns-member)|Gets the number of columns for each page of the index.| -||[range](/javascript/api/word/word.index#word-word-index-range-member)|Returns a `Range` object that represents the portion of the document that is contained within the index.| -||[rightAlignPageNumbers](/javascript/api/word/word.index#word-word-index-rightalignpagenumbers-member)|Specifies if page numbers are aligned with the right margin in the index.| -||[separateAccentedLetterHeadings](/javascript/api/word/word.index#word-word-index-separateaccentedletterheadings-member)|Gets if the index contains separate headings for accented letters (for example, words that begin with "À" are under| -||[sortBy](/javascript/api/word/word.index#word-word-index-sortby-member)|Specifies the sorting criteria for the index.| -||[tabLeader](/javascript/api/word/word.index#word-word-index-tableader-member)|Specifies the leader character between entries in the index and their associated page numbers.| -||[type](/javascript/api/word/word.index#word-word-index-type-member)|Gets the index type.| -|[IndexAddOptions](/javascript/api/word/word.indexaddoptions)|[headingSeparator](/javascript/api/word/word.indexaddoptions#word-word-indexaddoptions-headingseparator-member)|If provided, specifies the text between alphabetical groups (entries that start with the same letter) in the index.| -||[indexLanguage](/javascript/api/word/word.indexaddoptions#word-word-indexaddoptions-indexlanguage-member)|If provided, specifies the sorting language to be used for the index being added.| -||[numberOfColumns](/javascript/api/word/word.indexaddoptions#word-word-indexaddoptions-numberofcolumns-member)|If provided, specifies the number of columns for each page of the index.| -||[rightAlignPageNumbers](/javascript/api/word/word.indexaddoptions#word-word-indexaddoptions-rightalignpagenumbers-member)|If provided, specifies whether the page numbers in the generated index are aligned with the right margin.| -||[separateAccentedLetterHeadings](/javascript/api/word/word.indexaddoptions#word-word-indexaddoptions-separateaccentedletterheadings-member)|If provided, specifies whether to include separate headings for accented letters in the index.| -||[sortBy](/javascript/api/word/word.indexaddoptions#word-word-indexaddoptions-sortby-member)|If provided, specifies the sorting criteria to be used for the index being added.| -||[type](/javascript/api/word/word.indexaddoptions#word-word-indexaddoptions-type-member)|If provided, specifies whether subentries are on the same line (run-in) as the main entry or on a separate line (indented) from the main entry.| -|[IndexCollection](/javascript/api/word/word.indexcollection)|[add(range: Word.Range, indexAddOptions?: Word.IndexAddOptions)](/javascript/api/word/word.indexcollection#word-word-indexcollection-add-member(1))|Returns an `Index` object that represents a new index added to the document.| -||[getFormat()](/javascript/api/word/word.indexcollection#word-word-indexcollection-getformat-member(1))|Gets the `IndexFormat` value that represents the formatting for the indexes in the document.| -||[getItem(index: number)](/javascript/api/word/word.indexcollection#word-word-indexcollection-getitem-member(1))|Gets an `Index` object by its index in the collection.| -||[items](/javascript/api/word/word.indexcollection#word-word-indexcollection-items-member)|Gets the loaded child items in this collection.| -||[markAllEntries(range: Word.Range, markAllEntriesOptions?: Word.IndexMarkAllEntriesOptions)](/javascript/api/word/word.indexcollection#word-word-indexcollection-markallentries-member(1))|Inserts an {@link https://support.microsoft.com/office/abaf7c78-6e21-418d-bf8b-f8186d2e4d08 | XE (Index Entry) field} after all instances of the text in the range.| -|[IndexMarkAllEntriesOptions](/javascript/api/word/word.indexmarkallentriesoptions)|[bold](/javascript/api/word/word.indexmarkallentriesoptions#word-word-indexmarkallentriesoptions-bold-member)|If provided, specifies whether to add bold formatting to page numbers for index entries.| -||[bookmarkName](/javascript/api/word/word.indexmarkallentriesoptions#word-word-indexmarkallentriesoptions-bookmarkname-member)|If provided, specifies the bookmark name that marks the range of pages you want to appear in the index.| -||[crossReference](/javascript/api/word/word.indexmarkallentriesoptions#word-word-indexmarkallentriesoptions-crossreference-member)|If provided, specifies the cross-reference that will appear in the index.| -||[crossReferenceAutoText](/javascript/api/word/word.indexmarkallentriesoptions#word-word-indexmarkallentriesoptions-crossreferenceautotext-member)|If provided, specifies the name of the `AutoText` entry that contains the text for a cross-reference (if this property is specified, `crossReference` is ignored).| -||[entry](/javascript/api/word/word.indexmarkallentriesoptions#word-word-indexmarkallentriesoptions-entry-member)|If provided, specifies the text you want to appear in the index, in the form `MainEntry[:Subentry]`.| -||[entryAutoText](/javascript/api/word/word.indexmarkallentriesoptions#word-word-indexmarkallentriesoptions-entryautotext-member)|If provided, specifies the `AutoText` entry that contains the text you want to appear in the index (if this property is specified, `entry` is ignored).| -||[italic](/javascript/api/word/word.indexmarkallentriesoptions#word-word-indexmarkallentriesoptions-italic-member)|If provided, specifies whether to add italic formatting to page numbers for index entries.| -|[IndexMarkEntryOptions](/javascript/api/word/word.indexmarkentryoptions)|[bold](/javascript/api/word/word.indexmarkentryoptions#word-word-indexmarkentryoptions-bold-member)|If provided, specifies whether to add bold formatting to page numbers for index entries.| -||[bookmarkName](/javascript/api/word/word.indexmarkentryoptions#word-word-indexmarkentryoptions-bookmarkname-member)|If provided, specifies the bookmark name that marks the range of pages you want to appear in the index.| -||[crossReference](/javascript/api/word/word.indexmarkentryoptions#word-word-indexmarkentryoptions-crossreference-member)|If provided, specifies the cross-reference that will appear in the index.| -||[crossReferenceAutoText](/javascript/api/word/word.indexmarkentryoptions#word-word-indexmarkentryoptions-crossreferenceautotext-member)|If provided, specifies the name of the `AutoText` entry that contains the text for a cross-reference (if this property is specified, `crossReference` is ignored).| -||[entry](/javascript/api/word/word.indexmarkentryoptions#word-word-indexmarkentryoptions-entry-member)|If provided, specifies the text you want to appear in the index, in the form `MainEntry[:Subentry]`.| -||[entryAutoText](/javascript/api/word/word.indexmarkentryoptions#word-word-indexmarkentryoptions-entryautotext-member)|If provided, specifies the `AutoText` entry that contains the text you want to appear in the index (if this property is specified, `entry` is ignored).| -||[italic](/javascript/api/word/word.indexmarkentryoptions#word-word-indexmarkentryoptions-italic-member)|If provided, specifies whether to add italic formatting to page numbers for index entries.| -||[reading](/javascript/api/word/word.indexmarkentryoptions#word-word-indexmarkentryoptions-reading-member)|If provided, specifies whether to show an index entry in the right location when indexes are sorted phonetically (East Asian languages only).| -|[LineFormat](/javascript/api/word/word.lineformat)|[backgroundColor](/javascript/api/word/word.lineformat#word-word-lineformat-backgroundcolor-member)|Gets a `ColorFormat` object that represents the background color for a patterned line.| -||[beginArrowheadLength](/javascript/api/word/word.lineformat#word-word-lineformat-beginarrowheadlength-member)|Specifies the length of the arrowhead at the beginning of the line.| -||[beginArrowheadStyle](/javascript/api/word/word.lineformat#word-word-lineformat-beginarrowheadstyle-member)|Specifies the style of the arrowhead at the beginning of the line.| -||[beginArrowheadWidth](/javascript/api/word/word.lineformat#word-word-lineformat-beginarrowheadwidth-member)|Specifies the width of the arrowhead at the beginning of the line.| -||[dashStyle](/javascript/api/word/word.lineformat#word-word-lineformat-dashstyle-member)|Specifies the dash style for the line.| -||[endArrowheadLength](/javascript/api/word/word.lineformat#word-word-lineformat-endarrowheadlength-member)|Specifies the length of the arrowhead at the end of the line.| -||[endArrowheadStyle](/javascript/api/word/word.lineformat#word-word-lineformat-endarrowheadstyle-member)|Specifies the style of the arrowhead at the end of the line.| -||[endArrowheadWidth](/javascript/api/word/word.lineformat#word-word-lineformat-endarrowheadwidth-member)|Specifies the width of the arrowhead at the end of the line.| -||[foregroundColor](/javascript/api/word/word.lineformat#word-word-lineformat-foregroundcolor-member)|Gets a `ColorFormat` object that represents the foreground color for the line.| -||[insetPen](/javascript/api/word/word.lineformat#word-word-lineformat-insetpen-member)|Specifies if to draw lines inside a shape.| -||[isVisible](/javascript/api/word/word.lineformat#word-word-lineformat-isvisible-member)|Specifies if the object, or the formatting applied to it, is visible.| -||[pattern](/javascript/api/word/word.lineformat#word-word-lineformat-pattern-member)|Specifies the pattern applied to the line.| -||[style](/javascript/api/word/word.lineformat#word-word-lineformat-style-member)|Specifies the line format style.| -||[transparency](/javascript/api/word/word.lineformat#word-word-lineformat-transparency-member)|Specifies the degree of transparency of the line as a value between 0.0 (opaque) and 1.0 (clear).| -||[weight](/javascript/api/word/word.lineformat#word-word-lineformat-weight-member)|Specifies the thickness of the line in points.| -|[LineNumbering](/javascript/api/word/word.linenumbering)|[countBy](/javascript/api/word/word.linenumbering#word-word-linenumbering-countby-member)|Specifies the numeric increment for line numbers.| -||[distanceFromText](/javascript/api/word/word.linenumbering#word-word-linenumbering-distancefromtext-member)|Specifies the distance (in points) between the right edge of line numbers and the left edge of the document text.| -||[isActive](/javascript/api/word/word.linenumbering#word-word-linenumbering-isactive-member)|Specifies if line numbering is active for the specified document, section, or sections.| -||[restartMode](/javascript/api/word/word.linenumbering#word-word-linenumbering-restartmode-member)|Specifies the way line numbering runs; that is, whether it starts over at the beginning of a new page or section, or runs continuously.| -||[startingNumber](/javascript/api/word/word.linenumbering#word-word-linenumbering-startingnumber-member)|Specifies the starting line number.| -|[LinkFormat](/javascript/api/word/word.linkformat)|[breakLink()](/javascript/api/word/word.linkformat#word-word-linkformat-breaklink-member(1))|Breaks the link between the source file and the OLE object, picture, or linked field.| -||[isAutoUpdated](/javascript/api/word/word.linkformat#word-word-linkformat-isautoupdated-member)|Specifies if the link is updated automatically when the container file is opened or when the source file is changed.| -||[isLocked](/javascript/api/word/word.linkformat#word-word-linkformat-islocked-member)|Specifies if a `Field`, `InlineShape`, or `Shape` object is locked to prevent automatic updating.| -||[isPictureSavedWithDocument](/javascript/api/word/word.linkformat#word-word-linkformat-ispicturesavedwithdocument-member)|Specifies if the linked picture is saved with the document.| -||[sourceFullName](/javascript/api/word/word.linkformat#word-word-linkformat-sourcefullname-member)|Specifies the path and name of the source file for the linked OLE object, picture, or field.| -||[sourceName](/javascript/api/word/word.linkformat#word-word-linkformat-sourcename-member)|Gets the name of the source file for the linked OLE object, picture, or field.| -||[sourcePath](/javascript/api/word/word.linkformat#word-word-linkformat-sourcepath-member)|Gets the path of the source file for the linked OLE object, picture, or field.| -||[type](/javascript/api/word/word.linkformat#word-word-linkformat-type-member)|Gets the link type.| -|[ListFormat](/javascript/api/word/word.listformat)|[applyBulletDefault(defaultListBehavior: Word.DefaultListBehavior)](/javascript/api/word/word.listformat#word-word-listformat-applybulletdefault-member(1))|Adds bullets and formatting to the paragraphs in the range.| -||[applyListTemplateWithLevel(listTemplate: Word.ListTemplate, options?: Word.ListTemplateApplyOptions)](/javascript/api/word/word.listformat#word-word-listformat-applylisttemplatewithlevel-member(1))|Applies a list template with a specific level to the paragraphs in the range.| -||[applyNumberDefault(defaultListBehavior: Word.DefaultListBehavior)](/javascript/api/word/word.listformat#word-word-listformat-applynumberdefault-member(1))|Adds numbering and formatting to the paragraphs in the range.| -||[applyOutlineNumberDefault(defaultListBehavior: Word.DefaultListBehavior)](/javascript/api/word/word.listformat#word-word-listformat-applyoutlinenumberdefault-member(1))|Adds outline numbering and formatting to the paragraphs in the range.| -||[canContinuePreviousList(listTemplate: Word.ListTemplate)](/javascript/api/word/word.listformat#word-word-listformat-cancontinuepreviouslist-member(1))|Determines whether the `ListFormat` object can continue a previous list.| -||[convertNumbersToText(numberType: Word.NumberType)](/javascript/api/word/word.listformat#word-word-listformat-convertnumberstotext-member(1))|Converts numbers in the list to plain text.| -||[countNumberedItems(options?: Word.ListFormatCountNumberedItemsOptions)](/javascript/api/word/word.listformat#word-word-listformat-countnumbereditems-member(1))|Counts the numbered items in the list.| -||[isSingleList](/javascript/api/word/word.listformat#word-word-listformat-issinglelist-member)|Indicates whether the `ListFormat` object contains a single list.| -||[isSingleListTemplate](/javascript/api/word/word.listformat#word-word-listformat-issinglelisttemplate-member)|Indicates whether the `ListFormat` object contains a single list template.| -||[list](/javascript/api/word/word.listformat#word-word-listformat-list-member)|Returns a `List` object that represents the first formatted list contained in the `ListFormat` object.| -||[listIndent()](/javascript/api/word/word.listformat#word-word-listformat-listindent-member(1))|Indents the list by one level.| -||[listLevelNumber](/javascript/api/word/word.listformat#word-word-listformat-listlevelnumber-member)|Specifies the list level number for the first paragraph for the `ListFormat` object.| -||[listOutdent()](/javascript/api/word/word.listformat#word-word-listformat-listoutdent-member(1))|Outdents the list by one level.| -||[listString](/javascript/api/word/word.listformat#word-word-listformat-liststring-member)|Gets the string representation of the list value of the first paragraph in the range for the `ListFormat` object.| -||[listTemplate](/javascript/api/word/word.listformat#word-word-listformat-listtemplate-member)|Gets the list template associated with the `ListFormat` object.| -||[listType](/javascript/api/word/word.listformat#word-word-listformat-listtype-member)|Gets the type of the list for the `ListFormat` object.| -||[listValue](/javascript/api/word/word.listformat#word-word-listformat-listvalue-member)|Gets the numeric value of the the first paragraph in the range for the `ListFormat` object.| -||[removeNumbers(numberType: Word.NumberType)](/javascript/api/word/word.listformat#word-word-listformat-removenumbers-member(1))|Removes numbering from the list.| -|[ListFormatCountNumberedItemsOptions](/javascript/api/word/word.listformatcountnumbereditemsoptions)|[level](/javascript/api/word/word.listformatcountnumbereditemsoptions#word-word-listformatcountnumbereditemsoptions-level-member)|If provided, specifies the level to count.| -||[numberType](/javascript/api/word/word.listformatcountnumbereditemsoptions#word-word-listformatcountnumbereditemsoptions-numbertype-member)|If provided, specifies the type of number to count.| -|[ListTemplateApplyOptions](/javascript/api/word/word.listtemplateapplyoptions)|[applyLevel](/javascript/api/word/word.listtemplateapplyoptions#word-word-listtemplateapplyoptions-applylevel-member)|If provided, specifies the level to apply in the list template.| -||[applyTo](/javascript/api/word/word.listtemplateapplyoptions#word-word-listtemplateapplyoptions-applyto-member)|If provided, specifies which part of the list to apply the template to.| -||[continuePreviousList](/javascript/api/word/word.listtemplateapplyoptions#word-word-listtemplateapplyoptions-continuepreviouslist-member)|If provided, specifies whether to continue the previous list.| -||[defaultListBehavior](/javascript/api/word/word.listtemplateapplyoptions#word-word-listtemplateapplyoptions-defaultlistbehavior-member)|If provided, specifies the default list behavior.| -|[OleFormat](/javascript/api/word/word.oleformat)|[activate()](/javascript/api/word/word.oleformat#word-word-oleformat-activate-member(1))|Activates the `OleFormat` object.| -||[activateAs(classType: string)](/javascript/api/word/word.oleformat#word-word-oleformat-activateas-member(1))|Sets the Windows registry value that determines the default application used to activate the specified OLE object.| -||[classType](/javascript/api/word/word.oleformat#word-word-oleformat-classtype-member)|Specifies the class type for the specified OLE object, picture, or field.| -||[doVerb(verbIndex: Word.OleVerb)](/javascript/api/word/word.oleformat#word-word-oleformat-doverb-member(1))|Requests that the OLE object perform one of its available verbs.| -||[edit()](/javascript/api/word/word.oleformat#word-word-oleformat-edit-member(1))|Opens the OLE object for editing in the application it was created in.| -||[iconIndex](/javascript/api/word/word.oleformat#word-word-oleformat-iconindex-member)|Specifies the icon that is used when the `displayAsIcon` property is `true`.| -||[iconLabel](/javascript/api/word/word.oleformat#word-word-oleformat-iconlabel-member)|Specifies the text displayed below the icon for the OLE object.| -||[iconName](/javascript/api/word/word.oleformat#word-word-oleformat-iconname-member)|Specifies the program file in which the icon for the OLE object is stored.| -||[iconPath](/javascript/api/word/word.oleformat#word-word-oleformat-iconpath-member)|Gets the path of the file in which the icon for the OLE object is stored.| -||[isDisplayedAsIcon](/javascript/api/word/word.oleformat#word-word-oleformat-isdisplayedasicon-member)|Gets whether the specified object is displayed as an icon.| -||[isFormattingPreservedOnUpdate](/javascript/api/word/word.oleformat#word-word-oleformat-isformattingpreservedonupdate-member)|Specifies whether formatting done in Microsoft Word to the linked OLE object is preserved.| -||[label](/javascript/api/word/word.oleformat#word-word-oleformat-label-member)|Gets a string that's used to identify the portion of the source file that's being linked.| -||[open()](/javascript/api/word/word.oleformat#word-word-oleformat-open-member(1))|Opens the `OleFormat` object.| -||[progID](/javascript/api/word/word.oleformat#word-word-oleformat-progid-member)|Gets the programmatic identifier (`ProgId`) for the specified OLE object.| -|[Page](/javascript/api/word/word.page)|[breaks](/javascript/api/word/word.page#word-word-page-breaks-member)|Gets a `BreakCollection` object that represents the breaks on the page.| -|[PageSetup](/javascript/api/word/word.pagesetup)|[bookFoldPrinting](/javascript/api/word/word.pagesetup#word-word-pagesetup-bookfoldprinting-member)|Specifies whether Microsoft Word prints the document as a booklet.| -||[bookFoldPrintingSheets](/javascript/api/word/word.pagesetup#word-word-pagesetup-bookfoldprintingsheets-member)|Specifies the number of pages for each booklet.| -||[bookFoldReversePrinting](/javascript/api/word/word.pagesetup#word-word-pagesetup-bookfoldreverseprinting-member)|Specifies if Microsoft Word reverses the printing order for book fold printing of bidirectional or Asian language documents.| -||[bottomMargin](/javascript/api/word/word.pagesetup#word-word-pagesetup-bottommargin-member)|Specifies the distance (in points) between the bottom edge of the page and the bottom boundary of the body text.| -||[charsLine](/javascript/api/word/word.pagesetup#word-word-pagesetup-charsline-member)|Specifies the number of characters per line in the document grid.| -||[differentFirstPageHeaderFooter](/javascript/api/word/word.pagesetup#word-word-pagesetup-differentfirstpageheaderfooter-member)|Specifies whether the first page has a different header and footer.| -||[footerDistance](/javascript/api/word/word.pagesetup#word-word-pagesetup-footerdistance-member)|Specifies the distance between the footer and the bottom of the page in points.| -||[gutter](/javascript/api/word/word.pagesetup#word-word-pagesetup-gutter-member)|Specifies the amount (in points) of extra margin space added to each page in a document or section for binding.| -||[gutterPosition](/javascript/api/word/word.pagesetup#word-word-pagesetup-gutterposition-member)|Specifies on which side the gutter appears in a document.| -||[gutterStyle](/javascript/api/word/word.pagesetup#word-word-pagesetup-gutterstyle-member)|Specifies whether Microsoft Word uses gutters for the current document based on a right-to-left language or a left-to-right language.| -||[headerDistance](/javascript/api/word/word.pagesetup#word-word-pagesetup-headerdistance-member)|Specifies the distance between the header and the top of the page in points.| -||[layoutMode](/javascript/api/word/word.pagesetup#word-word-pagesetup-layoutmode-member)|Specifies the layout mode for the current document.| -||[leftMargin](/javascript/api/word/word.pagesetup#word-word-pagesetup-leftmargin-member)|Specifies the distance (in points) between the left edge of the page and the left boundary of the body text.| -||[lineNumbering](/javascript/api/word/word.pagesetup#word-word-pagesetup-linenumbering-member)|Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object.| -||[linesPage](/javascript/api/word/word.pagesetup#word-word-pagesetup-linespage-member)|Specifies the number of lines per page in the document grid.| -||[mirrorMargins](/javascript/api/word/word.pagesetup#word-word-pagesetup-mirrormargins-member)|Specifies if the inside and outside margins of facing pages are the same width.| -||[oddAndEvenPagesHeaderFooter](/javascript/api/word/word.pagesetup#word-word-pagesetup-oddandevenpagesheaderfooter-member)|Specifies whether odd and even pages have different headers and footers.| -||[orientation](/javascript/api/word/word.pagesetup#word-word-pagesetup-orientation-member)|Specifies the orientation of the page.| -||[pageHeight](/javascript/api/word/word.pagesetup#word-word-pagesetup-pageheight-member)|Specifies the page height in points.| -||[pageWidth](/javascript/api/word/word.pagesetup#word-word-pagesetup-pagewidth-member)|Specifies the page width in points.| -||[paperSize](/javascript/api/word/word.pagesetup#word-word-pagesetup-papersize-member)|Specifies the paper size of the page.| -||[rightMargin](/javascript/api/word/word.pagesetup#word-word-pagesetup-rightmargin-member)|Specifies the distance (in points) between the right edge of the page and the right boundary of the body text.| -||[sectionDirection](/javascript/api/word/word.pagesetup#word-word-pagesetup-sectiondirection-member)|Specifies the reading order and alignment for the specified sections.| -||[sectionStart](/javascript/api/word/word.pagesetup#word-word-pagesetup-sectionstart-member)|Specifies the type of section break for the specified object.| -||[setAsTemplateDefault()](/javascript/api/word/word.pagesetup#word-word-pagesetup-setastemplatedefault-member(1))|Sets the specified page setup formatting as the default for the active document and all new documents based on the active template.| -||[showGrid](/javascript/api/word/word.pagesetup#word-word-pagesetup-showgrid-member)|Specifies whether to show the grid.| -||[suppressEndnotes](/javascript/api/word/word.pagesetup#word-word-pagesetup-suppressendnotes-member)|Specifies if endnotes are printed at the end of the next section that doesn't suppress endnotes.| -||[textColumns](/javascript/api/word/word.pagesetup#word-word-pagesetup-textcolumns-member)|Gets a `TextColumnCollection` object that represents the set of text columns for the `PageSetup` object.| -||[togglePortrait()](/javascript/api/word/word.pagesetup#word-word-pagesetup-toggleportrait-member(1))|Switches between portrait and landscape page orientations for a document or section.| -||[topMargin](/javascript/api/word/word.pagesetup#word-word-pagesetup-topmargin-member)|Specifies the top margin of the page in points.| -||[twoPagesOnOne](/javascript/api/word/word.pagesetup#word-word-pagesetup-twopagesonone-member)|Specifies whether to print two pages per sheet.| -||[verticalAlignment](/javascript/api/word/word.pagesetup#word-word-pagesetup-verticalalignment-member)|Specifies the vertical alignment of text on each page in a document or section.| -|[Paragraph](/javascript/api/word/word.paragraph)|[borders](/javascript/api/word/word.paragraph#word-word-paragraph-borders-member)|Returns a `BorderUniversalCollection` object that represents all the borders for the paragraph.| -||[closeUp()](/javascript/api/word/word.paragraph#word-word-paragraph-closeup-member(1))|Removes any spacing before the paragraph.| -||[indent()](/javascript/api/word/word.paragraph#word-word-paragraph-indent-member(1))|Indents the paragraph by one level.| -||[indentCharacterWidth(count: number)](/javascript/api/word/word.paragraph#word-word-paragraph-indentcharacterwidth-member(1))|Indents the paragraph by a specified number of characters.| -||[indentFirstLineCharacterWidth(count: number)](/javascript/api/word/word.paragraph#word-word-paragraph-indentfirstlinecharacterwidth-member(1))|Indents the first line of the paragraph by the specified number of characters.| -||[joinList()](/javascript/api/word/word.paragraph#word-word-paragraph-joinlist-member(1))|Joins a list paragraph with the closest list above or below this paragraph.| -||[next(count: number)](/javascript/api/word/word.paragraph#word-word-paragraph-next-member(1))|Returns a `Paragraph` object that represents the next paragraph.| -||[onCommentAdded](/javascript/api/word/word.paragraph#word-word-paragraph-oncommentadded-member)|Occurs when new comments are added.| -||[onCommentChanged](/javascript/api/word/word.paragraph#word-word-paragraph-oncommentchanged-member)|Occurs when a comment or its reply is changed.| -||[onCommentDeleted](/javascript/api/word/word.paragraph#word-word-paragraph-oncommentdeleted-member)|Occurs when comments are deleted.| -||[onCommentDeselected](/javascript/api/word/word.paragraph#word-word-paragraph-oncommentdeselected-member)|Occurs when a comment is deselected.| -||[onCommentSelected](/javascript/api/word/word.paragraph#word-word-paragraph-oncommentselected-member)|Occurs when a comment is selected.| -||[openOrCloseUp()](/javascript/api/word/word.paragraph#word-word-paragraph-openorcloseup-member(1))|Toggles the spacing before the paragraph.| -||[openUp()](/javascript/api/word/word.paragraph#word-word-paragraph-openup-member(1))|Sets spacing before the paragraph to 12 points.| -||[outdent()](/javascript/api/word/word.paragraph#word-word-paragraph-outdent-member(1))|Removes one level of indent for the paragraph.| -||[outlineDemote()](/javascript/api/word/word.paragraph#word-word-paragraph-outlinedemote-member(1))|Applies the next heading level style (Heading 1 through Heading 8) to the paragraph.| -||[outlineDemoteToBody()](/javascript/api/word/word.paragraph#word-word-paragraph-outlinedemotetobody-member(1))|Demotes the paragraph to body text by applying the Normal style.| -||[outlinePromote()](/javascript/api/word/word.paragraph#word-word-paragraph-outlinepromote-member(1))|Applies the previous heading level style (Heading 1 through Heading 8) to the paragraph.| -||[previous(count: number)](/javascript/api/word/word.paragraph#word-word-paragraph-previous-member(1))|Returns the previous paragraph as a `Paragraph` object.| -||[range](/javascript/api/word/word.paragraph#word-word-paragraph-range-member)|Gets a `Range` object that represents the portion of the document that's contained within the paragraph.| -||[reset()](/javascript/api/word/word.paragraph#word-word-paragraph-reset-member(1))|Removes manual paragraph formatting (formatting not applied using a style).| -||[resetAdvanceTo()](/javascript/api/word/word.paragraph#word-word-paragraph-resetadvanceto-member(1))|Resets the paragraph that uses custom list levels to the original level settings.| -||[selectNumber()](/javascript/api/word/word.paragraph#word-word-paragraph-selectnumber-member(1))|Selects the number or bullet in a list.| -||[separateList()](/javascript/api/word/word.paragraph#word-word-paragraph-separatelist-member(1))|Separates a list into two separate lists.| -||[shading](/javascript/api/word/word.paragraph#word-word-paragraph-shading-member)|Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph.| -||[space1()](/javascript/api/word/word.paragraph#word-word-paragraph-space1-member(1))|Sets the paragraph to single spacing.| -||[space1Pt5()](/javascript/api/word/word.paragraph#word-word-paragraph-space1pt5-member(1))|Sets the paragraph to 1.5-line spacing.| -||[space2()](/javascript/api/word/word.paragraph#word-word-paragraph-space2-member(1))|Sets the paragraph to double spacing.| -||[tabHangingIndent(count: number)](/javascript/api/word/word.paragraph#word-word-paragraph-tabhangingindent-member(1))|Sets a hanging indent to a specified number of tab stops.| -||[tabIndent(count: number)](/javascript/api/word/word.paragraph#word-word-paragraph-tabindent-member(1))|Sets the left indent for the paragraph to a specified number of tab stops.| -|[ParagraphAddedEventArgs](/javascript/api/word/word.paragraphaddedeventargs)|[type](/javascript/api/word/word.paragraphaddedeventargs#word-word-paragraphaddedeventargs-type-member)|The event type.| -|[ParagraphChangedEventArgs](/javascript/api/word/word.paragraphchangedeventargs)|[type](/javascript/api/word/word.paragraphchangedeventargs#word-word-paragraphchangedeventargs-type-member)|The event type.| -|[ParagraphCollection](/javascript/api/word/word.paragraphcollection)|[add(range: Word.Range)](/javascript/api/word/word.paragraphcollection#word-word-paragraphcollection-add-member(1))|Returns a `Paragraph` object that represents a new, blank paragraph added to the document.| -||[closeUp()](/javascript/api/word/word.paragraphcollection#word-word-paragraphcollection-closeup-member(1))|Removes any spacing before the specified paragraphs.| -||[decreaseSpacing()](/javascript/api/word/word.paragraphcollection#word-word-paragraphcollection-decreasespacing-member(1))|Decreases the spacing before and after paragraphs in six-point increments.| -||[increaseSpacing()](/javascript/api/word/word.paragraphcollection#word-word-paragraphcollection-increasespacing-member(1))|Increases the spacing before and after paragraphs in six-point increments.| -||[indent()](/javascript/api/word/word.paragraphcollection#word-word-paragraphcollection-indent-member(1))|Indents the paragraphs by one level.| -||[indentCharacterWidth(count: number)](/javascript/api/word/word.paragraphcollection#word-word-paragraphcollection-indentcharacterwidth-member(1))|Indents the paragraphs in the collection by the specified number of characters.| -||[indentFirstLineCharacterWidth(count: number)](/javascript/api/word/word.paragraphcollection#word-word-paragraphcollection-indentfirstlinecharacterwidth-member(1))|Indents the first line of the paragraphs in the collection by the specified number of characters.| -||[openOrCloseUp()](/javascript/api/word/word.paragraphcollection#word-word-paragraphcollection-openorcloseup-member(1))|Toggles spacing before paragraphs.| -||[openUp()](/javascript/api/word/word.paragraphcollection#word-word-paragraphcollection-openup-member(1))|Sets spacing before the specified paragraphs to 12 points.| -||[outdent()](/javascript/api/word/word.paragraphcollection#word-word-paragraphcollection-outdent-member(1))|Removes one level of indent for the paragraphs.| -||[outlineDemote()](/javascript/api/word/word.paragraphcollection#word-word-paragraphcollection-outlinedemote-member(1))|Applies the next heading level style (Heading 1 through Heading 8) to the specified paragraphs.| -||[outlineDemoteToBody()](/javascript/api/word/word.paragraphcollection#word-word-paragraphcollection-outlinedemotetobody-member(1))|Demotes the specified paragraphs to body text by applying the Normal style.| -||[outlinePromote()](/javascript/api/word/word.paragraphcollection#word-word-paragraphcollection-outlinepromote-member(1))|Applies the previous heading level style (Heading 1 through Heading 8) to the paragraphs in the collection.| -||[space1()](/javascript/api/word/word.paragraphcollection#word-word-paragraphcollection-space1-member(1))|Sets the specified paragraphs to single spacing.| -||[space1Pt5()](/javascript/api/word/word.paragraphcollection#word-word-paragraphcollection-space1pt5-member(1))|Sets the specified paragraphs to 1.5-line spacing.| -||[space2()](/javascript/api/word/word.paragraphcollection#word-word-paragraphcollection-space2-member(1))|Sets the specified paragraphs to double spacing.| -||[tabHangingIndent(count: number)](/javascript/api/word/word.paragraphcollection#word-word-paragraphcollection-tabhangingindent-member(1))|Sets a hanging indent to the specified number of tab stops.| -||[tabIndent(count: number)](/javascript/api/word/word.paragraphcollection#word-word-paragraphcollection-tabindent-member(1))|Sets the left indent for the specified paragraphs to the specified number of tab stops.| -|[ParagraphDeletedEventArgs](/javascript/api/word/word.paragraphdeletedeventargs)|[type](/javascript/api/word/word.paragraphdeletedeventargs#word-word-paragraphdeletedeventargs-type-member)|The event type.| -|[PictureContentControl](/javascript/api/word/word.picturecontentcontrol)|[appearance](/javascript/api/word/word.picturecontentcontrol#word-word-picturecontentcontrol-appearance-member)|Specifies the appearance of the content control.| -||[color](/javascript/api/word/word.picturecontentcontrol#word-word-picturecontentcontrol-color-member)|Specifies the red-green-blue (RGB) value of the color of the content control.| -||[copy()](/javascript/api/word/word.picturecontentcontrol#word-word-picturecontentcontrol-copy-member(1))|Copies the content control from the active document to the Clipboard.| -||[cut()](/javascript/api/word/word.picturecontentcontrol#word-word-picturecontentcontrol-cut-member(1))|Removes the content control from the active document and moves the content control to the Clipboard.| -||[delete(deleteContents?: boolean)](/javascript/api/word/word.picturecontentcontrol#word-word-picturecontentcontrol-delete-member(1))|Deletes the content control and optionally its contents.| -||[id](/javascript/api/word/word.picturecontentcontrol#word-word-picturecontentcontrol-id-member)|Returns the identification for the content control.| -||[isTemporary](/javascript/api/word/word.picturecontentcontrol#word-word-picturecontentcontrol-istemporary-member)|Specifies whether to remove the content control from the active document when the user edits the contents of the control.| -||[level](/javascript/api/word/word.picturecontentcontrol#word-word-picturecontentcontrol-level-member)|Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline.| -||[lockContentControl](/javascript/api/word/word.picturecontentcontrol#word-word-picturecontentcontrol-lockcontentcontrol-member)|Specifies if the content control is locked (can't be deleted).| -||[lockContents](/javascript/api/word/word.picturecontentcontrol#word-word-picturecontentcontrol-lockcontents-member)|Specifies if the contents of the content control are locked (not editable).| -||[placeholderText](/javascript/api/word/word.picturecontentcontrol#word-word-picturecontentcontrol-placeholdertext-member)|Returns a `BuildingBlock` object that represents the placeholder text for the content control.| -||[range](/javascript/api/word/word.picturecontentcontrol#word-word-picturecontentcontrol-range-member)|Returns a `Range` object that represents the contents of the content control in the active document.| -||[setPlaceholderText(options?: Word.ContentControlPlaceholderOptions)](/javascript/api/word/word.picturecontentcontrol#word-word-picturecontentcontrol-setplaceholdertext-member(1))|Sets the placeholder text that displays in the content control until a user enters their own text.| -||[showingPlaceholderText](/javascript/api/word/word.picturecontentcontrol#word-word-picturecontentcontrol-showingplaceholdertext-member)|Returns whether the placeholder text for the content control is being displayed.| -||[tag](/javascript/api/word/word.picturecontentcontrol#word-word-picturecontentcontrol-tag-member)|Specifies a tag to identify the content control.| -||[title](/javascript/api/word/word.picturecontentcontrol#word-word-picturecontentcontrol-title-member)|Specifies the title for the content control.| -||[xmlMapping](/javascript/api/word/word.picturecontentcontrol#word-word-picturecontentcontrol-xmlmapping-member)|Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document.| -|[Range](/javascript/api/word/word.range)|[bold](/javascript/api/word/word.range#word-word-range-bold-member)|Specifies whether the range is formatted as bold.| -||[boldBidirectional](/javascript/api/word/word.range#word-word-range-boldbidirectional-member)|Specifies whether the range is formatted as bold in a right-to-left language document.| -||[bookmarks](/javascript/api/word/word.range#word-word-range-bookmarks-member)|Returns a `BookmarkCollection` object that represents all the bookmarks in the range.| -||[borders](/javascript/api/word/word.range#word-word-range-borders-member)|Returns a `BorderUniversalCollection` object that represents all the borders for the range.| -||[case](/javascript/api/word/word.range#word-word-range-case-member)|Specifies a `CharacterCase` value that represents the case of the text in the range.| -||[characterWidth](/javascript/api/word/word.range#word-word-range-characterwidth-member)|Specifies the character width of the range.| -||[combineCharacters](/javascript/api/word/word.range#word-word-range-combinecharacters-member)|Specifies if the range contains combined characters.| -||[detectLanguage()](/javascript/api/word/word.range#word-word-range-detectlanguage-member(1))|Analyzes the range text to determine the language that it's written in.| -||[disableCharacterSpaceGrid](/javascript/api/word/word.range#word-word-range-disablecharacterspacegrid-member)|Specifies if Microsoft Word ignores the number of characters per line for the corresponding `Range` object.| -||[emphasisMark](/javascript/api/word/word.range#word-word-range-emphasismark-member)|Specifies the emphasis mark for a character or designated character string.| -||[end](/javascript/api/word/word.range#word-word-range-end-member)|Specifies the ending character position of the range.| -||[fitTextWidth](/javascript/api/word/word.range#word-word-range-fittextwidth-member)|Specifies the width (in the current measurement units) in which Microsoft Word fits the text in the current selection or range.| -||[frames](/javascript/api/word/word.range#word-word-range-frames-member)|Gets a `FrameCollection` object that represents all the frames in the range.| -||[grammarChecked](/javascript/api/word/word.range#word-word-range-grammarchecked-member)|Specifies if a grammar check has been run on the range or document.| -||[hasNoProofing](/javascript/api/word/word.range#word-word-range-hasnoproofing-member)|Specifies the proofing status (spelling and grammar checking) of the range.| -||[highlightColorIndex](/javascript/api/word/word.range#word-word-range-highlightcolorindex-member)|Specifies the highlight color for the range.| -||[horizontalInVertical](/javascript/api/word/word.range#word-word-range-horizontalinvertical-member)|Specifies the formatting for horizontal text set within vertical text.| -||[hyperlinks](/javascript/api/word/word.range#word-word-range-hyperlinks-member)|Returns a `HyperlinkCollection` object that represents all the hyperlinks in the range.| -||[id](/javascript/api/word/word.range#word-word-range-id-member)|Specifies the ID for the range.| -||[isEndOfRowMark](/javascript/api/word/word.range#word-word-range-isendofrowmark-member)|Gets if the range is collapsed and is located at the end-of-row mark in a table.| -||[isTextVisibleOnScreen](/javascript/api/word/word.range#word-word-range-istextvisibleonscreen-member)|Gets whether the text in the range is visible on the screen.| -||[italic](/javascript/api/word/word.range#word-word-range-italic-member)|Specifies if the font or range is formatted as italic.| -||[italicBidirectional](/javascript/api/word/word.range#word-word-range-italicbidirectional-member)|Specifies if the font or range is formatted as italic (right-to-left languages).| -||[kana](/javascript/api/word/word.range#word-word-range-kana-member)|Specifies whether the range of Japanese language text is hiragana or katakana.| -||[languageDetected](/javascript/api/word/word.range#word-word-range-languagedetected-member)|Specifies whether Microsoft Word has detected the language of the text in the range.| -||[languageId](/javascript/api/word/word.range#word-word-range-languageid-member)|Specifies a `LanguageId` value that represents the language for the range.| -||[languageIdFarEast](/javascript/api/word/word.range#word-word-range-languageidfareast-member)|Specifies an East Asian language for the range.| -||[languageIdOther](/javascript/api/word/word.range#word-word-range-languageidother-member)|Specifies a language for the range that isn't classified as an East Asian language.| -||[listFormat](/javascript/api/word/word.range#word-word-range-listformat-member)|Returns a `ListFormat` object that represents all the list formatting characteristics of the range.| -||[onCommentAdded](/javascript/api/word/word.range#word-word-range-oncommentadded-member)|Occurs when new comments are added.| -||[onCommentChanged](/javascript/api/word/word.range#word-word-range-oncommentchanged-member)|Occurs when a comment or its reply is changed.| -||[onCommentDeselected](/javascript/api/word/word.range#word-word-range-oncommentdeselected-member)|Occurs when a comment is deselected.| -||[onCommentSelected](/javascript/api/word/word.range#word-word-range-oncommentselected-member)|Occurs when a comment is selected.| -||[sections](/javascript/api/word/word.range#word-word-range-sections-member)|Gets the collection of sections in the range.| -||[shading](/javascript/api/word/word.range#word-word-range-shading-member)|Returns a `ShadingUniversal` object that refers to the shading formatting for the range.| -||[showAll](/javascript/api/word/word.range#word-word-range-showall-member)|Specifies if all nonprinting characters (such as hidden text, tab marks, space marks, and paragraph marks) are displayed.| -||[spellingChecked](/javascript/api/word/word.range#word-word-range-spellingchecked-member)|Specifies if spelling has been checked throughout the range or document.| -||[start](/javascript/api/word/word.range#word-word-range-start-member)|Specifies the starting character position of the range.| -||[storyLength](/javascript/api/word/word.range#word-word-range-storylength-member)|Gets the number of characters in the story that contains the range.| -||[storyType](/javascript/api/word/word.range#word-word-range-storytype-member)|Gets the story type for the range.| -||[tableColumns](/javascript/api/word/word.range#word-word-range-tablecolumns-member)|Gets a `TableColumnCollection` object that represents all the table columns in the range.| -||[twoLinesInOne](/javascript/api/word/word.range#word-word-range-twolinesinone-member)|Specifies whether Microsoft Word sets two lines of text in one and specifies the characters that enclose the text, if any.| -||[underline](/javascript/api/word/word.range#word-word-range-underline-member)|Specifies the type of underline applied to the range.| -|[ReflectionFormat](/javascript/api/word/word.reflectionformat)|[blur](/javascript/api/word/word.reflectionformat#word-word-reflectionformat-blur-member)|Specifies the degree of blur effect applied to the `ReflectionFormat` object as a value between 0.0 and 100.0.| -||[offset](/javascript/api/word/word.reflectionformat#word-word-reflectionformat-offset-member)|Specifies the amount of separation, in points, of the reflected image from the shape.| -||[size](/javascript/api/word/word.reflectionformat#word-word-reflectionformat-size-member)|Specifies the size of the reflection as a percentage of the reflected shape from 0 to 100.| -||[transparency](/javascript/api/word/word.reflectionformat#word-word-reflectionformat-transparency-member)|Specifies the degree of transparency for the reflection effect as a value between 0.0 (opaque) and 1.0 (clear).| -||[type](/javascript/api/word/word.reflectionformat#word-word-reflectionformat-type-member)|Specifies a `ReflectionType` value that represents the type and direction of the lighting for a shape reflection.| -|[RepeatingSectionContentControl](/javascript/api/word/word.repeatingsectioncontentcontrol)|[allowInsertDeleteSection](/javascript/api/word/word.repeatingsectioncontentcontrol#word-word-repeatingsectioncontentcontrol-allowinsertdeletesection-member)|Specifies whether users can add or remove sections from this repeating section content control by using the user interface.| -||[appearance](/javascript/api/word/word.repeatingsectioncontentcontrol#word-word-repeatingsectioncontentcontrol-appearance-member)|Specifies the appearance of the content control.| -||[color](/javascript/api/word/word.repeatingsectioncontentcontrol#word-word-repeatingsectioncontentcontrol-color-member)|Specifies the red-green-blue (RGB) value of the color of the content control.| -||[copy()](/javascript/api/word/word.repeatingsectioncontentcontrol#word-word-repeatingsectioncontentcontrol-copy-member(1))|Copies the content control from the active document to the Clipboard.| -||[cut()](/javascript/api/word/word.repeatingsectioncontentcontrol#word-word-repeatingsectioncontentcontrol-cut-member(1))|Removes the content control from the active document and moves the content control to the Clipboard.| -||[delete(deleteContents?: boolean)](/javascript/api/word/word.repeatingsectioncontentcontrol#word-word-repeatingsectioncontentcontrol-delete-member(1))|Deletes the content control and the contents of the content control.| -||[id](/javascript/api/word/word.repeatingsectioncontentcontrol#word-word-repeatingsectioncontentcontrol-id-member)|Returns the identification for the content control.| -||[isTemporary](/javascript/api/word/word.repeatingsectioncontentcontrol#word-word-repeatingsectioncontentcontrol-istemporary-member)|Specifies whether to remove the content control from the active document when the user edits the contents of the control.| -||[level](/javascript/api/word/word.repeatingsectioncontentcontrol#word-word-repeatingsectioncontentcontrol-level-member)|Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline.| -||[lockContentControl](/javascript/api/word/word.repeatingsectioncontentcontrol#word-word-repeatingsectioncontentcontrol-lockcontentcontrol-member)|Specifies if the content control is locked (can't be deleted).| -||[lockContents](/javascript/api/word/word.repeatingsectioncontentcontrol#word-word-repeatingsectioncontentcontrol-lockcontents-member)|Specifies if the contents of the content control are locked (not editable).| -||[placeholderText](/javascript/api/word/word.repeatingsectioncontentcontrol#word-word-repeatingsectioncontentcontrol-placeholdertext-member)|Returns a `BuildingBlock` object that represents the placeholder text for the content control.| -||[range](/javascript/api/word/word.repeatingsectioncontentcontrol#word-word-repeatingsectioncontentcontrol-range-member)|Gets a `Range` object that represents the contents of the content control in the active document.| -||[repeatingSectionItemTitle](/javascript/api/word/word.repeatingsectioncontentcontrol#word-word-repeatingsectioncontentcontrol-repeatingsectionitemtitle-member)|Specifies the name of the repeating section items used in the context menu associated with this repeating section content control.| -||[repeatingSectionItems](/javascript/api/word/word.repeatingsectioncontentcontrol#word-word-repeatingsectioncontentcontrol-repeatingsectionitems-member)|Returns the collection of repeating section items in this repeating section content control.| -||[setPlaceholderText(options?: Word.ContentControlPlaceholderOptions)](/javascript/api/word/word.repeatingsectioncontentcontrol#word-word-repeatingsectioncontentcontrol-setplaceholdertext-member(1))|Sets the placeholder text that displays in the content control until a user enters their own text.| -||[showingPlaceholderText](/javascript/api/word/word.repeatingsectioncontentcontrol#word-word-repeatingsectioncontentcontrol-showingplaceholdertext-member)|Returns whether the placeholder text for the content control is being displayed.| -||[tag](/javascript/api/word/word.repeatingsectioncontentcontrol#word-word-repeatingsectioncontentcontrol-tag-member)|Specifies a tag to identify the content control.| -||[title](/javascript/api/word/word.repeatingsectioncontentcontrol#word-word-repeatingsectioncontentcontrol-title-member)|Specifies the title for the content control.| -||[xmlapping](/javascript/api/word/word.repeatingsectioncontentcontrol#word-word-repeatingsectioncontentcontrol-xmlapping-member)|Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document.| -|[RepeatingSectionItem](/javascript/api/word/word.repeatingsectionitem)|[delete()](/javascript/api/word/word.repeatingsectionitem#word-word-repeatingsectionitem-delete-member(1))|Deletes this `RepeatingSectionItem` object.| -||[insertItemAfter()](/javascript/api/word/word.repeatingsectionitem#word-word-repeatingsectionitem-insertitemafter-member(1))|Adds a repeating section item after this item and returns the new item.| -||[insertItemBefore()](/javascript/api/word/word.repeatingsectionitem#word-word-repeatingsectionitem-insertitembefore-member(1))|Adds a repeating section item before this item and returns the new item.| -||[range](/javascript/api/word/word.repeatingsectionitem#word-word-repeatingsectionitem-range-member)|Returns the range of this repeating section item, excluding the start and end tags.| -|[RepeatingSectionItemCollection](/javascript/api/word/word.repeatingsectionitemcollection)|[getItemAt(index: number)](/javascript/api/word/word.repeatingsectionitemcollection#word-word-repeatingsectionitemcollection-getitemat-member(1))|Returns an individual repeating section item.| -|[Reviewer](/javascript/api/word/word.reviewer)|[isVisible](/javascript/api/word/word.reviewer#word-word-reviewer-isvisible-member)|Specifies if the `Reviewer` object is visible.| -|[ReviewerCollection](/javascript/api/word/word.reviewercollection)|[getItem(index: number)](/javascript/api/word/word.reviewercollection#word-word-reviewercollection-getitem-member(1))|Returns a `Reviewer` object that represents the specified item in the collection.| -||[items](/javascript/api/word/word.reviewercollection#word-word-reviewercollection-items-member)|Gets the loaded child items in this collection.| -|[RevisionsFilter](/javascript/api/word/word.revisionsfilter)|[markup](/javascript/api/word/word.revisionsfilter#word-word-revisionsfilter-markup-member)|Specifies a `RevisionsMarkup` value that represents the extent of reviewer markup displayed in the document.| -||[reviewers](/javascript/api/word/word.revisionsfilter#word-word-revisionsfilter-reviewers-member)|Gets the `ReviewerCollection` object that represents the collection of reviewers of one or more documents.| -||[toggleShowAllReviewers()](/javascript/api/word/word.revisionsfilter#word-word-revisionsfilter-toggleshowallreviewers-member(1))|Shows or hides all revisions in the document that contain comments and tracked changes.| -||[view](/javascript/api/word/word.revisionsfilter#word-word-revisionsfilter-view-member)|Specifies a `RevisionsView` value that represents globally whether Word displays the original version of the document or the final version, which might have revisions and formatting changes applied.| -|[Section](/javascript/api/word/word.section)|[borders](/javascript/api/word/word.section#word-word-section-borders-member)|Returns a `BorderUniversalCollection` object that represents all the borders in the section.| -||[pageSetup](/javascript/api/word/word.section#word-word-section-pagesetup-member)|Returns a `PageSetup` object that's associated with the section.| -||[protectedForForms](/javascript/api/word/word.section#word-word-section-protectedforforms-member)|Specifies if the section is protected for forms.| -|[ShadingUniversal](/javascript/api/word/word.shadinguniversal)|[backgroundPatternColor](/javascript/api/word/word.shadinguniversal#word-word-shadinguniversal-backgroundpatterncolor-member)|Specifies the color that's applied to the background of the `ShadingUniversal` object.| -||[backgroundPatternColorIndex](/javascript/api/word/word.shadinguniversal#word-word-shadinguniversal-backgroundpatterncolorindex-member)|Specifies the color that's applied to the background of the `ShadingUniversal` object.| -||[foregroundPatternColor](/javascript/api/word/word.shadinguniversal#word-word-shadinguniversal-foregroundpatterncolor-member)|Specifies the color that's applied to the foreground of the `ShadingUniversal` object.| -||[foregroundPatternColorIndex](/javascript/api/word/word.shadinguniversal#word-word-shadinguniversal-foregroundpatterncolorindex-member)|Specifies the color that's applied to the foreground of the `ShadingUniversal` object.| -||[texture](/javascript/api/word/word.shadinguniversal#word-word-shadinguniversal-texture-member)|Specifies the shading texture of the object.| -|[ShadowFormat](/javascript/api/word/word.shadowformat)|[blur](/javascript/api/word/word.shadowformat#word-word-shadowformat-blur-member)|Specifies the blur level for a shadow format as a value between 0.0 and 100.0.| -||[foregroundColor](/javascript/api/word/word.shadowformat#word-word-shadowformat-foregroundcolor-member)|Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow.| -||[incrementOffsetX(increment: number)](/javascript/api/word/word.shadowformat#word-word-shadowformat-incrementoffsetx-member(1))|Changes the horizontal offset of the shadow by the number of points.| -||[incrementOffsetY(increment: number)](/javascript/api/word/word.shadowformat#word-word-shadowformat-incrementoffsety-member(1))|Changes the vertical offset of the shadow by the specified number of points.| -||[isVisible](/javascript/api/word/word.shadowformat#word-word-shadowformat-isvisible-member)|Specifies whether the object or the formatting applied to it is visible.| -||[obscured](/javascript/api/word/word.shadowformat#word-word-shadowformat-obscured-member)|Specifies `true` if the shadow of the shape appears filled in and is obscured by the shape, even if the shape has no fill,| -||[offsetX](/javascript/api/word/word.shadowformat#word-word-shadowformat-offsetx-member)|Specifies the horizontal offset (in points) of the shadow from the shape.| -||[offsetY](/javascript/api/word/word.shadowformat#word-word-shadowformat-offsety-member)|Specifies the vertical offset (in points) of the shadow from the shape.| -||[rotateWithShape](/javascript/api/word/word.shadowformat#word-word-shadowformat-rotatewithshape-member)|Specifies whether to rotate the shadow when rotating the shape.| -||[size](/javascript/api/word/word.shadowformat#word-word-shadowformat-size-member)|Specifies the width of the shadow.| -||[style](/javascript/api/word/word.shadowformat#word-word-shadowformat-style-member)|Specifies the type of shadow formatting to apply to a shape.| -||[transparency](/javascript/api/word/word.shadowformat#word-word-shadowformat-transparency-member)|Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear).| -||[type](/javascript/api/word/word.shadowformat#word-word-shadowformat-type-member)|Specifies the shape shadow type.| -|[Source](/javascript/api/word/word.source)|[delete()](/javascript/api/word/word.source#word-word-source-delete-member(1))|Deletes the `Source` object.| -||[getFieldByName(name: string)](/javascript/api/word/word.source#word-word-source-getfieldbyname-member(1))|Returns the value of a field in the bibliography `Source` object.| -||[isCited](/javascript/api/word/word.source#word-word-source-iscited-member)|Gets if the `Source` object has been cited in the document.| -||[tag](/javascript/api/word/word.source#word-word-source-tag-member)|Gets the tag of the source.| -||[xml](/javascript/api/word/word.source#word-word-source-xml-member)|Gets the XML representation of the source.| -|[SourceCollection](/javascript/api/word/word.sourcecollection)|[add(xml: string)](/javascript/api/word/word.sourcecollection#word-word-sourcecollection-add-member(1))|Adds a new `Source` object to the collection.| -||[getItem(index: number)](/javascript/api/word/word.sourcecollection#word-word-sourcecollection-getitem-member(1))|Gets a `Source` by its index in the collection.| -||[items](/javascript/api/word/word.sourcecollection#word-word-sourcecollection-items-member)|Gets the loaded child items in this collection.| -|[Style](/javascript/api/word/word.style)|[automaticallyUpdate](/javascript/api/word/word.style#word-word-style-automaticallyupdate-member)|Specifies whether the style is automatically redefined based on the selection.| -||[description](/javascript/api/word/word.style#word-word-style-description-member)|Gets the description of the specified style.| -||[frame](/javascript/api/word/word.style#word-word-style-frame-member)|Returns a `Frame` object that represents the frame formatting for the style.| -||[hasProofing](/javascript/api/word/word.style#word-word-style-hasproofing-member)|Specifies whether the spelling and grammar checker ignores text formatted with this style.| -||[languageId](/javascript/api/word/word.style#word-word-style-languageid-member)|Specifies a `LanguageId` value that represents the language for the style.| -||[languageIdFarEast](/javascript/api/word/word.style#word-word-style-languageidfareast-member)|Specifies an East Asian language for the style.| -||[linkStyle](/javascript/api/word/word.style#word-word-style-linkstyle-member)|Specifies a link between a paragraph and a character style.| -||[linkToListTemplate(listTemplate: Word.ListTemplate)](/javascript/api/word/word.style#word-word-style-linktolisttemplate-member(1))|Links this style to a list template so that the style's formatting can be applied to lists.| -||[listLevelNumber](/javascript/api/word/word.style#word-word-style-listlevelnumber-member)|Returns the list level for the style.| -||[locked](/javascript/api/word/word.style#word-word-style-locked-member)|Specifies whether the style cannot be changed or edited.| -||[noSpaceBetweenParagraphsOfSameStyle](/javascript/api/word/word.style#word-word-style-nospacebetweenparagraphsofsamestyle-member)|Specifies whether to remove spacing between paragraphs that are formatted using the same style.| -|[TabStop](/javascript/api/word/word.tabstop)|[alignment](/javascript/api/word/word.tabstop#word-word-tabstop-alignment-member)|Gets a `TabAlignment` value that represents the alignment for the tab stop.| -||[clear()](/javascript/api/word/word.tabstop#word-word-tabstop-clear-member(1))|Removes this custom tab stop.| -||[customTab](/javascript/api/word/word.tabstop#word-word-tabstop-customtab-member)|Gets whether this tab stop is a custom tab stop.| -||[leader](/javascript/api/word/word.tabstop#word-word-tabstop-leader-member)|Gets a `TabLeader` value that represents the leader for this `TabStop` object.| -||[next](/javascript/api/word/word.tabstop#word-word-tabstop-next-member)|Gets the next tab stop in the collection.| -||[position](/javascript/api/word/word.tabstop#word-word-tabstop-position-member)|Gets the position of the tab stop relative to the left margin.| -||[previous](/javascript/api/word/word.tabstop#word-word-tabstop-previous-member)|Gets the previous tab stop in the collection.| -|[TabStopAddOptions](/javascript/api/word/word.tabstopaddoptions)|[alignment](/javascript/api/word/word.tabstopaddoptions#word-word-tabstopaddoptions-alignment-member)|If provided, specifies the alignment of the tab stop.| -||[leader](/javascript/api/word/word.tabstopaddoptions#word-word-tabstopaddoptions-leader-member)|If provided, specifies the leader character for the tab stop.| -|[TabStopCollection](/javascript/api/word/word.tabstopcollection)|[add(position: number, options?: Word.TabStopAddOptions)](/javascript/api/word/word.tabstopcollection#word-word-tabstopcollection-add-member(1))|Returns a `TabStop` object that represents a custom tab stop added to the paragraph.| -||[after(Position: number)](/javascript/api/word/word.tabstopcollection#word-word-tabstopcollection-after-member(1))|Returns the next `TabStop` object to the right of the specified position.| -||[before(Position: number)](/javascript/api/word/word.tabstopcollection#word-word-tabstopcollection-before-member(1))|Returns the next `TabStop` object to the left of the specified position.| -||[clearAll()](/javascript/api/word/word.tabstopcollection#word-word-tabstopcollection-clearall-member(1))|Clears all the custom tab stops from the paragraph.| -||[getItem(index: number)](/javascript/api/word/word.tabstopcollection#word-word-tabstopcollection-getitem-member(1))|Gets a `TabStop` object by its index in the collection.| -||[items](/javascript/api/word/word.tabstopcollection#word-word-tabstopcollection-items-member)|Gets the loaded child items in this collection.| -|[TableColumn](/javascript/api/word/word.tablecolumn)|[autoFit()](/javascript/api/word/word.tablecolumn#word-word-tablecolumn-autofit-member(1))|Changes the width of the table column to accommodate the width of the text without changing the way text wraps in the cells.| -||[borders](/javascript/api/word/word.tablecolumn#word-word-tablecolumn-borders-member)|Returns a `BorderUniversalCollection` object that represents all the borders for the table column.| -||[columnIndex](/javascript/api/word/word.tablecolumn#word-word-tablecolumn-columnindex-member)|Returns the position of this column in a collection.| -||[delete()](/javascript/api/word/word.tablecolumn#word-word-tablecolumn-delete-member(1))|Deletes the column.| -||[isFirst](/javascript/api/word/word.tablecolumn#word-word-tablecolumn-isfirst-member)|Returns `true` if the column or row is the first one in the table; `false` otherwise.| -||[isLast](/javascript/api/word/word.tablecolumn#word-word-tablecolumn-islast-member)|Returns `true` if the column or row is the last one in the table; `false` otherwise.| -||[nestingLevel](/javascript/api/word/word.tablecolumn#word-word-tablecolumn-nestinglevel-member)|Returns the nesting level of the column.| -||[preferredWidth](/javascript/api/word/word.tablecolumn#word-word-tablecolumn-preferredwidth-member)|Specifies the preferred width (in points or as a percentage of the window width) for the column.| -||[preferredWidthType](/javascript/api/word/word.tablecolumn#word-word-tablecolumn-preferredwidthtype-member)|Specifies the preferred unit of measurement to use for the width of the table column.| -||[select()](/javascript/api/word/word.tablecolumn#word-word-tablecolumn-select-member(1))|Selects the table column.| -||[setWidth(columnWidth: number, rulerStyle: Word.RulerStyle)](/javascript/api/word/word.tablecolumn#word-word-tablecolumn-setwidth-member(1))|Sets the width of the column in a table.| -||[shading](/javascript/api/word/word.tablecolumn#word-word-tablecolumn-shading-member)|Returns a `ShadingUniversal` object that refers to the shading formatting for the column.| -||[sort()](/javascript/api/word/word.tablecolumn#word-word-tablecolumn-sort-member(1))|Sorts the table column.| -||[width](/javascript/api/word/word.tablecolumn#word-word-tablecolumn-width-member)|Specifies the width of the column, in points.| -|[TableColumnCollection](/javascript/api/word/word.tablecolumncollection)|[add(beforeColumn?: Word.TableColumn)](/javascript/api/word/word.tablecolumncollection#word-word-tablecolumncollection-add-member(1))|Returns a `TableColumn` object that represents a column added to a table.| -||[autoFit()](/javascript/api/word/word.tablecolumncollection#word-word-tablecolumncollection-autofit-member(1))|Changes the width of a table column to accommodate the width of the text without changing the way text wraps in the cells.| -||[delete()](/javascript/api/word/word.tablecolumncollection#word-word-tablecolumncollection-delete-member(1))|Deletes the specified columns.| -||[distributeWidth()](/javascript/api/word/word.tablecolumncollection#word-word-tablecolumncollection-distributewidth-member(1))|Adjusts the width of the specified columns so that they are equal.| -||[items](/javascript/api/word/word.tablecolumncollection#word-word-tablecolumncollection-items-member)|Gets the loaded child items in this collection.| -||[select()](/javascript/api/word/word.tablecolumncollection#word-word-tablecolumncollection-select-member(1))|Selects the specified table columns.| -||[setWidth(columnWidth: number, rulerStyle: Word.RulerStyle)](/javascript/api/word/word.tablecolumncollection#word-word-tablecolumncollection-setwidth-member(1))|Sets the width of columns in a table.| -|[Template](/javascript/api/word/word.template)|[buildingBlockEntries](/javascript/api/word/word.template#word-word-template-buildingblockentries-member)|Returns a `BuildingBlockEntryCollection` object that represents the collection of building block entries in the template.| -||[buildingBlockTypes](/javascript/api/word/word.template#word-word-template-buildingblocktypes-member)|Returns a `BuildingBlockTypeItemCollection` object that represents the collection of building block types that are contained in the template.| -||[farEastLineBreakLanguage](/javascript/api/word/word.template#word-word-template-fareastlinebreaklanguage-member)|Specifies the East Asian language to use when breaking lines of text in the document or template.| -||[farEastLineBreakLevel](/javascript/api/word/word.template#word-word-template-fareastlinebreaklevel-member)|Specifies the line break control level for the document.| -||[fullName](/javascript/api/word/word.template#word-word-template-fullname-member)|Returns the name of the template, including the drive or Web path.| -||[hasNoProofing](/javascript/api/word/word.template#word-word-template-hasnoproofing-member)|Specifies whether the spelling and grammar checker ignores documents based on this template.| -||[justificationMode](/javascript/api/word/word.template#word-word-template-justificationmode-member)|Specifies the character spacing adjustment for the template.| -||[kerningByAlgorithm](/javascript/api/word/word.template#word-word-template-kerningbyalgorithm-member)|Specifies if Microsoft Word kerns half-width Latin characters and punctuation marks in the document.| -||[languageId](/javascript/api/word/word.template#word-word-template-languageid-member)|Specifies a `LanguageId` value that represents the language in the template.| -||[languageIdFarEast](/javascript/api/word/word.template#word-word-template-languageidfareast-member)|Specifies an East Asian language for the language in the template.| -||[name](/javascript/api/word/word.template#word-word-template-name-member)|Returns only the name of the document template (excluding any path or other location information).| -||[noLineBreakAfter](/javascript/api/word/word.template#word-word-template-nolinebreakafter-member)|Specifies the kinsoku characters after which Microsoft Word will not break a line.| -||[noLineBreakBefore](/javascript/api/word/word.template#word-word-template-nolinebreakbefore-member)|Specifies the kinsoku characters before which Microsoft Word will not break a line.| -||[path](/javascript/api/word/word.template#word-word-template-path-member)|Returns the path to the document template.| -||[save()](/javascript/api/word/word.template#word-word-template-save-member(1))|Saves the template.| -||[saved](/javascript/api/word/word.template#word-word-template-saved-member)|Specifies `true` if the template has not changed since it was last saved, `false` if Microsoft Word displays a prompt to save changes when the document is closed.| -||[type](/javascript/api/word/word.template#word-word-template-type-member)|Returns the template type.| -|[TemplateCollection](/javascript/api/word/word.templatecollection)|[getCount()](/javascript/api/word/word.templatecollection#word-word-templatecollection-getcount-member(1))|Returns the number of items in the collection.| -||[getItemAt(index: number)](/javascript/api/word/word.templatecollection#word-word-templatecollection-getitemat-member(1))|Gets a `Template` object by its index in the collection.| -||[importBuildingBlocks()](/javascript/api/word/word.templatecollection#word-word-templatecollection-importbuildingblocks-member(1))|Imports the building blocks for all templates into Microsoft Word.| -||[items](/javascript/api/word/word.templatecollection#word-word-templatecollection-items-member)|Gets the loaded child items in this collection.| -|[TextColumn](/javascript/api/word/word.textcolumn)|[spaceAfter](/javascript/api/word/word.textcolumn#word-word-textcolumn-spaceafter-member)|Specifies the amount of spacing (in points) after the specified paragraph or text column.| -||[width](/javascript/api/word/word.textcolumn#word-word-textcolumn-width-member)|Specifies the width, in points, of the specified text columns.| -|[TextColumnAddOptions](/javascript/api/word/word.textcolumnaddoptions)|[isEvenlySpaced](/javascript/api/word/word.textcolumnaddoptions#word-word-textcolumnaddoptions-isevenlyspaced-member)|If provided, specifies whether to evenly space all the text columns in the document.| -||[spacing](/javascript/api/word/word.textcolumnaddoptions#word-word-textcolumnaddoptions-spacing-member)|If provided, specifies the spacing between the text columns in the document, in points.| -||[width](/javascript/api/word/word.textcolumnaddoptions#word-word-textcolumnaddoptions-width-member)|If provided, specifies the width of the new text column in the document, in points.| -|[TextColumnCollection](/javascript/api/word/word.textcolumncollection)|[add(options?: Word.TextColumnAddOptions)](/javascript/api/word/word.textcolumncollection#word-word-textcolumncollection-add-member(1))|Returns a `TextColumn` object that represents a new text column added to a section or document.| -||[getFlowDirection()](/javascript/api/word/word.textcolumncollection#word-word-textcolumncollection-getflowdirection-member(1))|Gets the direction in which text flows from one text column to the next.| -||[getHasLineBetween()](/javascript/api/word/word.textcolumncollection#word-word-textcolumncollection-gethaslinebetween-member(1))|Gets whether vertical lines appear between all the columns in the `TextColumnCollection` object.| -||[getIsEvenlySpaced()](/javascript/api/word/word.textcolumncollection#word-word-textcolumncollection-getisevenlyspaced-member(1))|Gets whether text columns are evenly spaced.| -||[getItem(index: number)](/javascript/api/word/word.textcolumncollection#word-word-textcolumncollection-getitem-member(1))|Gets a `TextColumn` by its index in the collection.| -||[items](/javascript/api/word/word.textcolumncollection#word-word-textcolumncollection-items-member)|Gets the loaded child items in this collection.| -||[setCount(numColumns: number)](/javascript/api/word/word.textcolumncollection#word-word-textcolumncollection-setcount-member(1))|Arranges text into the specified number of text columns.| -||[setFlowDirection(value: Word.FlowDirection)](/javascript/api/word/word.textcolumncollection#word-word-textcolumncollection-setflowdirection-member(1))|Sets the direction in which text flows from one text column to the next.| -||[setHasLineBetween(value: boolean)](/javascript/api/word/word.textcolumncollection#word-word-textcolumncollection-sethaslinebetween-member(1))|Sets whether vertical lines appear between all the columns in the `TextColumnCollection` object.| -||[setIsEvenlySpaced(value: boolean)](/javascript/api/word/word.textcolumncollection#word-word-textcolumncollection-setisevenlyspaced-member(1))|Sets whether text columns are evenly spaced.| -|[ThreeDimensionalFormat](/javascript/api/word/word.threedimensionalformat)|[bevelBottomDepth](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-bevelbottomdepth-member)|Specifies the depth of the bottom bevel.| -||[bevelBottomInset](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-bevelbottominset-member)|Specifies the inset size for the bottom bevel.| -||[bevelBottomType](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-bevelbottomtype-member)|Specifies a `BevelType` value that represents the bevel type for the bottom bevel.| -||[bevelTopDepth](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-beveltopdepth-member)|Specifies the depth of the top bevel.| -||[bevelTopInset](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-beveltopinset-member)|Specifies the inset size for the top bevel.| -||[bevelTopType](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-beveltoptype-member)|Specifies a `BevelType` value that represents the bevel type for the top bevel.| -||[contourColor](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-contourcolor-member)|Returns a `ColorFormat` object that represents color of the contour of a shape.| -||[contourWidth](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-contourwidth-member)|Specifies the width of the contour of a shape.| -||[depth](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-depth-member)|Specifies the depth of the shape's extrusion.| -||[extrusionColor](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-extrusioncolor-member)|Returns a `ColorFormat` object that represents the color of the shape's extrusion.| -||[extrusionColorType](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-extrusioncolortype-member)|Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion)| -||[fieldOfView](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-fieldofview-member)|Specifies the amount of perspective for a shape.| -||[incrementRotationHorizontal(increment: number)](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-incrementrotationhorizontal-member(1))|Horizontally rotates a shape on the x-axis.| -||[incrementRotationVertical(increment: number)](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-incrementrotationvertical-member(1))|Vertically rotates a shape on the y-axis.| -||[incrementRotationX(increment: number)](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-incrementrotationx-member(1))|Changes the rotation around the x-axis.| -||[incrementRotationY(increment: number)](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-incrementrotationy-member(1))|Changes the rotation around the y-axis.| -||[incrementRotationZ(increment: number)](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-incrementrotationz-member(1))|Rotates a shape on the z-axis.| -||[isPerspective](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-isperspective-member)|Specifies `true` if the extrusion appears in perspective — that is, if the walls of the extrusion narrow toward a vanishing point,| -||[isVisible](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-isvisible-member)|Specifies if the specified object, or the formatting applied to it, is visible.| -||[lightAngle](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-lightangle-member)|Specifies the angle of the lighting.| -||[presetCamera](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-presetcamera-member)|Returns a `PresetCamera` value that represents the camera presets.| -||[presetExtrusionDirection](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-presetextrusiondirection-member)|Returns the direction taken by the extrusion's sweep path leading away from the extruded shape (the front face of the extrusion).| -||[presetLighting](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-presetlighting-member)|Specifies a `LightRigType` value that represents the lighting preset.| -||[presetLightingDirection](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-presetlightingdirection-member)|Specifies the position of the light source relative to the extrusion.| -||[presetLightingSoftness](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-presetlightingsoftness-member)|Specifies the intensity of the extrusion lighting.| -||[presetMaterial](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-presetmaterial-member)|Specifies the extrusion surface material.| -||[presetThreeDimensionalFormat](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-presetthreedimensionalformat-member)|Returns the preset extrusion format.| -||[projectText](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-projecttext-member)|Specifies whether text on a shape rotates with shape.| -||[resetRotation()](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-resetrotation-member(1))|Resets the extrusion rotation around the x-axis, y-axis, and z-axis to 0.| -||[rotationX](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-rotationx-member)|Specifies the rotation of the extruded shape around the x-axis in degrees.| -||[rotationY](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-rotationy-member)|Specifies the rotation of the extruded shape around the y-axis in degrees.| -||[rotationZ](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-rotationz-member)|Specifies the z-axis rotation of the camera.| -||[setExtrusionDirection(presetExtrusionDirection: Word.PresetExtrusionDirection)](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-setextrusiondirection-member(1))|Sets the direction of the extrusion's sweep path.| -||[setPresetCamera(presetCamera: Word.PresetCamera)](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-setpresetcamera-member(1))|Sets the camera preset for the shape.| -||[setThreeDimensionalFormat(presetThreeDimensionalFormat: Word.PresetThreeDimensionalFormat)](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-setthreedimensionalformat-member(1))|Sets the preset extrusion format.| -||[z](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-z-member)|Specifies the position on the z-axis for the shape.| -|[View](/javascript/api/word/word.view)|[areAllNonprintingCharactersDisplayed](/javascript/api/word/word.view#word-word-view-areallnonprintingcharactersdisplayed-member)|Specifies whether all nonprinting characters are displayed.| -||[areBackgroundsDisplayed](/javascript/api/word/word.view#word-word-view-arebackgroundsdisplayed-member)|Gets whether background colors and images are shown when the document is displayed in print layout view.| -||[areBookmarksIndicated](/javascript/api/word/word.view#word-word-view-arebookmarksindicated-member)|Gets whether square brackets are displayed at the beginning and end of each bookmark.| -||[areCommentsDisplayed](/javascript/api/word/word.view#word-word-view-arecommentsdisplayed-member)|Specifies whether Microsoft Word displays the comments in the document.| -||[areConnectingLinesToRevisionsBalloonDisplayed](/javascript/api/word/word.view#word-word-view-areconnectinglinestorevisionsballoondisplayed-member)|Specifies whether Microsoft Word displays connecting lines from the text to the revision and comment balloons.| -||[areCropMarksDisplayed](/javascript/api/word/word.view#word-word-view-arecropmarksdisplayed-member)|Gets whether crop marks are shown in the corners of pages to indicate where margins are located.| -||[areDrawingsDisplayed](/javascript/api/word/word.view#word-word-view-aredrawingsdisplayed-member)|Gets whether objects created with the drawing tools are displayed in print layout view.| -||[areEditableRangesShaded](/javascript/api/word/word.view#word-word-view-areeditablerangesshaded-member)|Specifies whether shading is applied to the ranges in the document that users have permission to modify.| -||[areFieldCodesDisplayed](/javascript/api/word/word.view#word-word-view-arefieldcodesdisplayed-member)|Specifies whether field codes are displayed.| -||[areFormatChangesDisplayed](/javascript/api/word/word.view#word-word-view-areformatchangesdisplayed-member)|Specifies whether Microsoft Word displays formatting changes made to the document with Track Changes enabled.| -||[areInkAnnotationsDisplayed](/javascript/api/word/word.view#word-word-view-areinkannotationsdisplayed-member)|Specifies whether handwritten ink annotations are shown or hidden.| -||[areInsertionsAndDeletionsDisplayed](/javascript/api/word/word.view#word-word-view-areinsertionsanddeletionsdisplayed-member)|Specifies whether Microsoft Word displays insertions and deletions made to the document with Track Changes enabled.| -||[areLinesWrappedToWindow](/javascript/api/word/word.view#word-word-view-arelineswrappedtowindow-member)|Gets whether lines wrap at the right edge of the document window rather than at the right margin or the right column boundary.| -||[areObjectAnchorsDisplayed](/javascript/api/word/word.view#word-word-view-areobjectanchorsdisplayed-member)|Gets whether object anchors are displayed next to items that can be positioned in print layout view.| -||[areOptionalBreaksDisplayed](/javascript/api/word/word.view#word-word-view-areoptionalbreaksdisplayed-member)|Gets whether Microsoft Word displays optional line breaks.| -||[areOptionalHyphensDisplayed](/javascript/api/word/word.view#word-word-view-areoptionalhyphensdisplayed-member)|Gets whether optional hyphens are displayed.| -||[areOtherAuthorsVisible](/javascript/api/word/word.view#word-word-view-areotherauthorsvisible-member)|Gets whether other authors' presence should be visible in the document.| -||[arePageBoundariesDisplayed](/javascript/api/word/word.view#word-word-view-arepageboundariesdisplayed-member)|Gets whether the top and bottom margins and the gray area between pages in the document are displayed.| -||[areParagraphsMarksDisplayed](/javascript/api/word/word.view#word-word-view-areparagraphsmarksdisplayed-member)|Gets whether paragraph marks are displayed.| -||[arePicturePlaceholdersDisplayed](/javascript/api/word/word.view#word-word-view-arepictureplaceholdersdisplayed-member)|Gets whether blank boxes are displayed as placeholders for pictures.| -||[areRevisionsAndCommentsDisplayed](/javascript/api/word/word.view#word-word-view-arerevisionsandcommentsdisplayed-member)|Specifies whether Microsoft Word displays revisions and comments made to the document with Track Changes enabled.| -||[areSpacesIndicated](/javascript/api/word/word.view#word-word-view-arespacesindicated-member)|Gets whether space characters are displayed.| -||[areTableGridlinesDisplayed](/javascript/api/word/word.view#word-word-view-aretablegridlinesdisplayed-member)|Specifies whether table gridlines are displayed.| -||[areTabsDisplayed](/javascript/api/word/word.view#word-word-view-aretabsdisplayed-member)|Gets whether tab characters are displayed.| -||[areTextBoundariesDisplayed](/javascript/api/word/word.view#word-word-view-aretextboundariesdisplayed-member)|Gets whether dotted lines are displayed around page margins, text columns, objects, and frames in print layout view.| -||[collapseAllHeadings()](/javascript/api/word/word.view#word-word-view-collapseallheadings-member(1))|Collapses all the headings in the document.| -||[collapseOutline(range: Word.Range)](/javascript/api/word/word.view#word-word-view-collapseoutline-member(1))|Collapses the text under the selection or the specified range by one heading level.| -||[columnWidth](/javascript/api/word/word.view#word-word-view-columnwidth-member)|Specifies the column width in Reading mode.| -||[expandAllHeadings()](/javascript/api/word/word.view#word-word-view-expandallheadings-member(1))|Expands all the headings in the document.| -||[expandOutline(range: Word.Range)](/javascript/api/word/word.view#word-word-view-expandoutline-member(1))|Expands the text under the selection by one heading level.| -||[fieldShading](/javascript/api/word/word.view#word-word-view-fieldshading-member)|Gets on-screen shading for fields.| -||[isDraft](/javascript/api/word/word.view#word-word-view-isdraft-member)|Specifies whether all the text in a window is displayed in the same sans-serif font with minimal formatting to speed up display.| -||[isFirstLineOnlyDisplayed](/javascript/api/word/word.view#word-word-view-isfirstlineonlydisplayed-member)|Specifies whether only the first line of body text is shown in outline view.| -||[isFormatDisplayed](/javascript/api/word/word.view#word-word-view-isformatdisplayed-member)|Specifies whether character formatting is visible in outline view.| -||[isFullScreen](/javascript/api/word/word.view#word-word-view-isfullscreen-member)|Specifies whether the window is in full-screen view.| -||[isHiddenTextDisplayed](/javascript/api/word/word.view#word-word-view-ishiddentextdisplayed-member)|Gets whether text formatted as hidden text is displayed.| -||[isHighlightingDisplayed](/javascript/api/word/word.view#word-word-view-ishighlightingdisplayed-member)|Gets whether highlight formatting is displayed and printed with the document.| -||[isInConflictMode](/javascript/api/word/word.view#word-word-view-isinconflictmode-member)|Specifies whether the document is in conflict mode view.| -||[isInPanning](/javascript/api/word/word.view#word-word-view-isinpanning-member)|Specifies whether Microsoft Word is in Panning mode.| -||[isInReadingLayout](/javascript/api/word/word.view#word-word-view-isinreadinglayout-member)|Specifies whether the document is being viewed in reading layout view.| -||[isMailMergeDataView](/javascript/api/word/word.view#word-word-view-ismailmergedataview-member)|Specifies whether mail merge data is displayed instead of mail merge fields.| -||[isMainTextLayerVisible](/javascript/api/word/word.view#word-word-view-ismaintextlayervisible-member)|Specifies whether the text in the document is visible when the header and footer areas are displayed.| -||[isPointerShownAsMagnifier](/javascript/api/word/word.view#word-word-view-ispointershownasmagnifier-member)|Specifies whether the pointer is displayed as a magnifying glass in print preview.| -||[isReadingLayoutActualView](/javascript/api/word/word.view#word-word-view-isreadinglayoutactualview-member)|Specifies whether pages displayed in reading layout view are displayed using the same layout as printed pages.| -||[isXmlMarkupVisible](/javascript/api/word/word.view#word-word-view-isxmlmarkupvisible-member)|Specifies whether XML tags are visible in the document.| -||[markupMode](/javascript/api/word/word.view#word-word-view-markupmode-member)|Specifies the display mode for tracked changes.| -||[nextHeaderFooter()](/javascript/api/word/word.view#word-word-view-nextheaderfooter-member(1))|Moves to the next header or footer, depending on whether a header or footer is displayed in the view.| -||[pageColor](/javascript/api/word/word.view#word-word-view-pagecolor-member)|Specifies the page color in Reading mode.| -||[pageMovementType](/javascript/api/word/word.view#word-word-view-pagemovementtype-member)|Specifies the page movement type.| -||[previousHeaderFooter()](/javascript/api/word/word.view#word-word-view-previousheaderfooter-member(1))|Moves to the previous header or footer, depending on whether a header or footer is displayed in the view.| -||[readingLayoutTruncateMargins](/javascript/api/word/word.view#word-word-view-readinglayouttruncatemargins-member)|Specifies whether margins are visible or hidden when the document is viewed in Full Screen Reading view.| -||[revisionsBalloonSide](/javascript/api/word/word.view#word-word-view-revisionsballoonside-member)|Gets whether Word displays revision balloons in the left or right margin in the document.| -||[revisionsBalloonWidth](/javascript/api/word/word.view#word-word-view-revisionsballoonwidth-member)|Specifies the width of the revision balloons.| -||[revisionsBalloonWidthType](/javascript/api/word/word.view#word-word-view-revisionsballoonwidthtype-member)|Specifies how Microsoft Word measures the width of revision balloons.| -||[revisionsFilter](/javascript/api/word/word.view#word-word-view-revisionsfilter-member)|Gets the instance of a `RevisionsFilter` object.| -||[seekView](/javascript/api/word/word.view#word-word-view-seekview-member)|Specifies the document element displayed in print layout view.| -||[showAllHeadings()](/javascript/api/word/word.view#word-word-view-showallheadings-member(1))|Switches between showing all text (headings and body text) and showing only headings.| -||[showHeading(level: number)](/javascript/api/word/word.view#word-word-view-showheading-member(1))|Shows all headings up to the specified heading level and hides subordinate headings and body text.| -||[splitSpecial](/javascript/api/word/word.view#word-word-view-splitspecial-member)|Specifies the active window pane.| -||[type](/javascript/api/word/word.view#word-word-view-type-member)|Specifies the view type.| -|[Window](/javascript/api/word/word.window)|[activate()](/javascript/api/word/word.window#word-word-window-activate-member(1))|Activates the window.| -||[areRulersDisplayed](/javascript/api/word/word.window#word-word-window-arerulersdisplayed-member)|Specifies whether rulers are displayed for the window or pane.| -||[areScreenTipsDisplayed](/javascript/api/word/word.window#word-word-window-arescreentipsdisplayed-member)|Specifies whether comments, footnotes, endnotes, and hyperlinks are displayed as tips.| -||[areThumbnailsDisplayed](/javascript/api/word/word.window#word-word-window-arethumbnailsdisplayed-member)|Specifies whether thumbnail images of the pages in a document are displayed along the left side of the Microsoft Word document window.| -||[caption](/javascript/api/word/word.window#word-word-window-caption-member)|Specifies the caption text for the window that is displayed in the title bar of the document or application window.| -||[close(options?: Word.WindowCloseOptions)](/javascript/api/word/word.window#word-word-window-close-member(1))|Closes the window.| -||[height](/javascript/api/word/word.window#word-word-window-height-member)|Specifies the height of the window (in points).| -||[horizontalPercentScrolled](/javascript/api/word/word.window#word-word-window-horizontalpercentscrolled-member)|Specifies the horizontal scroll position as a percentage of the document width.| -||[imemode](/javascript/api/word/word.window#word-word-window-imemode-member)|Specifies the default start-up mode for the Japanese Input Method Editor (IME).| -||[index](/javascript/api/word/word.window#word-word-window-index-member)|Gets the position of an item in a collection.| -||[isActive](/javascript/api/word/word.window#word-word-window-isactive-member)|Specifies whether the window is active.| -||[isDocumentMapVisible](/javascript/api/word/word.window#word-word-window-isdocumentmapvisible-member)|Specifies whether the document map is visible.| -||[isEnvelopeVisible](/javascript/api/word/word.window#word-word-window-isenvelopevisible-member)|Specifies whether the email message header is visible in the document window.| -||[isHorizontalScrollBarDisplayed](/javascript/api/word/word.window#word-word-window-ishorizontalscrollbardisplayed-member)|Specifies whether a horizontal scroll bar is displayed for the window.| -||[isLeftScrollBarDisplayed](/javascript/api/word/word.window#word-word-window-isleftscrollbardisplayed-member)|Specifies whether the vertical scroll bar appears on the left side of the document window.| -||[isRightRulerDisplayed](/javascript/api/word/word.window#word-word-window-isrightrulerdisplayed-member)|Specifies whether the vertical ruler appears on the right side of the document window in print layout view.| -||[isSplit](/javascript/api/word/word.window#word-word-window-issplit-member)|Specifies whether the window is split into multiple panes.| -||[isVerticalRulerDisplayed](/javascript/api/word/word.window#word-word-window-isverticalrulerdisplayed-member)|Specifies whether a vertical ruler is displayed for the window or pane.| -||[isVerticalScrollBarDisplayed](/javascript/api/word/word.window#word-word-window-isverticalscrollbardisplayed-member)|Specifies whether a vertical scroll bar is displayed for the window.| -||[isVisible](/javascript/api/word/word.window#word-word-window-isvisible-member)|Specifies whether the window is visible.| -||[largeScroll(options?: Word.WindowScrollOptions)](/javascript/api/word/word.window#word-word-window-largescroll-member(1))|Scrolls the window by the specified number of screens.| -||[left](/javascript/api/word/word.window#word-word-window-left-member)|Specifies the horizontal position of the window, measured in points.| -||[next](/javascript/api/word/word.window#word-word-window-next-member)|Gets the next document window in the collection of open document windows.| -||[pageScroll(options?: Word.WindowPageScrollOptions)](/javascript/api/word/word.window#word-word-window-pagescroll-member(1))|Scrolls through the window page by page.| -||[previous](/javascript/api/word/word.window#word-word-window-previous-member)|Gets the previous document window in the collection open document windows.| -||[setFocus()](/javascript/api/word/word.window#word-word-window-setfocus-member(1))|Sets the focus of the document window to the body of an email message.| -||[showSourceDocuments](/javascript/api/word/word.window#word-word-window-showsourcedocuments-member)|Specifies how Microsoft Word displays source documents after a compare and merge process.| -||[smallScroll(options?: Word.WindowScrollOptions)](/javascript/api/word/word.window#word-word-window-smallscroll-member(1))|Scrolls the window by the specified number of lines.| -||[splitVertical](/javascript/api/word/word.window#word-word-window-splitvertical-member)|Specifies the vertical split percentage for the window.| -||[styleAreaWidth](/javascript/api/word/word.window#word-word-window-styleareawidth-member)|Specifies the width of the style area in points.| -||[toggleRibbon()](/javascript/api/word/word.window#word-word-window-toggleribbon-member(1))|Shows or hides the ribbon.| -||[top](/javascript/api/word/word.window#word-word-window-top-member)|Specifies the vertical position of the document window, in points.| -||[type](/javascript/api/word/word.window#word-word-window-type-member)|Gets the window type.| -||[usableHeight](/javascript/api/word/word.window#word-word-window-usableheight-member)|Gets the height (in points) of the active working area in the document window.| -||[usableWidth](/javascript/api/word/word.window#word-word-window-usablewidth-member)|Gets the width (in points) of the active working area in the document window.| -||[verticalPercentScrolled](/javascript/api/word/word.window#word-word-window-verticalpercentscrolled-member)|Specifies the vertical scroll position as a percentage of the document length.| -||[view](/javascript/api/word/word.window#word-word-window-view-member)|Gets the `View` object that represents the view for the window.| -||[width](/javascript/api/word/word.window#word-word-window-width-member)|Specifies the width of the document window, in points.| -||[windowNumber](/javascript/api/word/word.window#word-word-window-windownumber-member)|Gets an integer that represents the position of the window.| -||[windowState](/javascript/api/word/word.window#word-word-window-windowstate-member)|Specifies the state of the document window or task window.| -|[WindowCloseOptions](/javascript/api/word/word.windowcloseoptions)|[routeDocument](/javascript/api/word/word.windowcloseoptions#word-word-windowcloseoptions-routedocument-member)|If provided, specifies whether to route the document to the next recipient.| -||[saveChanges](/javascript/api/word/word.windowcloseoptions#word-word-windowcloseoptions-savechanges-member)|If provided, specifies the save action for the document.| -|[WindowCollection](/javascript/api/word/word.windowcollection)||| -|[WindowPageScrollOptions](/javascript/api/word/word.windowpagescrolloptions)|[down](/javascript/api/word/word.windowpagescrolloptions#word-word-windowpagescrolloptions-down-member)|If provided, specifies the number of pages to scroll the window down.| -||[up](/javascript/api/word/word.windowpagescrolloptions#word-word-windowpagescrolloptions-up-member)|If provided, specifies the number of pages to scroll the window up.| -|[WindowScrollOptions](/javascript/api/word/word.windowscrolloptions)|[down](/javascript/api/word/word.windowscrolloptions#word-word-windowscrolloptions-down-member)|If provided, specifies the number of units to scroll the window down.| -||[left](/javascript/api/word/word.windowscrolloptions#word-word-windowscrolloptions-left-member)|If provided, specifies the number of screens to scroll the window to the left.| -||[right](/javascript/api/word/word.windowscrolloptions#word-word-windowscrolloptions-right-member)|If provided, specifies the number of screens to scroll the window to the right.| -||[up](/javascript/api/word/word.windowscrolloptions#word-word-windowscrolloptions-up-member)|If provided, specifies the number of units to scroll the window up.| -|[XmlMapping](/javascript/api/word/word.xmlmapping)|[customXmlNode](/javascript/api/word/word.xmlmapping#word-word-xmlmapping-customxmlnode-member)|Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to.| -||[customXmlPart](/javascript/api/word/word.xmlmapping#word-word-xmlmapping-customxmlpart-member)|Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps.| -||[delete()](/javascript/api/word/word.xmlmapping#word-word-xmlmapping-delete-member(1))|Deletes the XML mapping from the parent content control.| -||[isMapped](/javascript/api/word/word.xmlmapping#word-word-xmlmapping-ismapped-member)|Returns whether the content control in the document is mapped to an XML node in the document's XML data store.| -||[prefixMappings](/javascript/api/word/word.xmlmapping#word-word-xmlmapping-prefixmappings-member)|Returns the prefix mappings used to evaluate the XPath for the current XML mapping.| -||[setMapping(xPath: string, options?: Word.XmlSetMappingOptions)](/javascript/api/word/word.xmlmapping#word-word-xmlmapping-setmapping-member(1))|Allows creating or changing the XML mapping on the content control.| -||[setMappingByNode(node: Word.CustomXmlNode)](/javascript/api/word/word.xmlmapping#word-word-xmlmapping-setmappingbynode-member(1))|Allows creating or changing the XML data mapping on the content control.| -||[xpath](/javascript/api/word/word.xmlmapping#word-word-xmlmapping-xpath-member)|Returns the XPath for the XML mapping, which evaluates to the currently mapped XML node.| -|[XmlSetMappingOptions](/javascript/api/word/word.xmlsetmappingoptions)|[prefixMapping](/javascript/api/word/word.xmlsetmappingoptions#word-word-xmlsetmappingoptions-prefixmapping-member)|If provided, specifies the prefix mappings to use when querying the expression provided in the `xPath` parameter of the `XmlMapping.setMapping` calling method.| -||[source](/javascript/api/word/word.xmlsetmappingoptions#word-word-xmlsetmappingoptions-source-member)|If provided, specifies the desired custom XML data to map the content control to.| +|[Application](/.application)|[bibliography](/.application#word-javascript/api/word/-application-bibliography-member)|Returns a `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word.| +||[checkLanguage](/.application#word-javascript/api/word/-application-checklanguage-member)|Specifies if Microsoft Word automatically detects the language you are using as you type.| +||[language](/.application#word-javascript/api/word/-application-language-member)|Gets a `LanguageId` value that represents the language selected for the Microsoft Word user interface.| +||[templates](/.application#word-javascript/api/word/-application-templates-member)|Returns a `TemplateCollection` object that represents all the available templates: global templates and those attached to open documents.| +|[Bibliography](/.bibliography)|[bibliographyStyle](/.bibliography#word-javascript/api/word/-bibliography-bibliographystyle-member)|Specifies the name of the active style to use for the bibliography.| +||[generateUniqueTag()](/.bibliography#word-javascript/api/word/-bibliography-generateuniquetag-member(1))|Generates a unique identification tag for a bibliography source and returns a string that represents the tag.| +||[sources](/.bibliography#word-javascript/api/word/-bibliography-sources-member)|Returns a `SourceCollection` object that represents all the sources contained in the bibliography.| +|[Body](/.body)|[onCommentAdded](/.body#word-javascript/api/word/-body-oncommentadded-member)|Occurs when new comments are added.| +||[onCommentChanged](/.body#word-javascript/api/word/-body-oncommentchanged-member)|Occurs when a comment or its reply is changed.| +||[onCommentDeleted](/.body#word-javascript/api/word/-body-oncommentdeleted-member)|Occurs when comments are deleted.| +||[onCommentDeselected](/.body#word-javascript/api/word/-body-oncommentdeselected-member)|Occurs when a comment is deselected.| +||[onCommentSelected](/.body#word-javascript/api/word/-body-oncommentselected-member)|Occurs when a comment is selected.| +||[type](/.body#word-javascript/api/word/-body-type-member)|Gets the type of the body.| +|[Bookmark](/.bookmark)|[copyTo(name: string)](/.bookmark#word-javascript/api/word/-bookmark-copyto-member(1))|Copies this bookmark to the new bookmark specified in the `name` argument and returns a `Bookmark` object.| +||[delete()](/.bookmark#word-javascript/api/word/-bookmark-delete-member(1))|Deletes the bookmark.| +||[end](/.bookmark#word-javascript/api/word/-bookmark-end-member)|Specifies the ending character position of the bookmark.| +||[isColumn](/.bookmark#word-javascript/api/word/-bookmark-iscolumn-member)|Returns `true` if the bookmark is a table column.| +||[isEmpty](/.bookmark#word-javascript/api/word/-bookmark-isempty-member)|Returns `true` if the bookmark is empty.| +||[name](/.bookmark#word-javascript/api/word/-bookmark-name-member)|Returns the name of the `Bookmark` object.| +||[range](/.bookmark#word-javascript/api/word/-bookmark-range-member)|Returns a `Range` object that represents the portion of the document that's contained in the `Bookmark` object.| +||[select()](/.bookmark#word-javascript/api/word/-bookmark-select-member(1))|Selects the bookmark.| +||[start](/.bookmark#word-javascript/api/word/-bookmark-start-member)|Specifies the starting character position of the bookmark.| +||[storyType](/.bookmark#word-javascript/api/word/-bookmark-storytype-member)|Returns the story type for the bookmark.| +|[BookmarkCollection](/.bookmarkcollection)|[exists(name: string)](/.bookmarkcollection#word-javascript/api/word/-bookmarkcollection-exists-member(1))|Determines whether the specified bookmark exists.| +||[getItem(index: number)](/.bookmarkcollection#word-javascript/api/word/-bookmarkcollection-getitem-member(1))|Gets a `Bookmark` object by its index in the collection.| +||[items](/.bookmarkcollection#word-javascript/api/word/-bookmarkcollection-items-member)|Gets the loaded child items in this collection.| +|[BorderUniversal](/.borderuniversal)|[artStyle](/.borderuniversal#word-javascript/api/word/-borderuniversal-artstyle-member)|Specifies the graphical page-border design for the document.| +||[artWidth](/.borderuniversal#word-javascript/api/word/-borderuniversal-artwidth-member)|Specifies the width (in points) of the graphical page border specified in the `artStyle` property.| +||[color](/.borderuniversal#word-javascript/api/word/-borderuniversal-color-member)|Specifies the color for the `BorderUniversal` object.| +||[colorIndex](/.borderuniversal#word-javascript/api/word/-borderuniversal-colorindex-member)|Specifies the color for the `BorderUniversal` or Word.Font object.| +||[inside](/.borderuniversal#word-javascript/api/word/-borderuniversal-inside-member)|Returns `true` if an inside border can be applied to the specified object.| +||[isVisible](/.borderuniversal#word-javascript/api/word/-borderuniversal-isvisible-member)|Specifies whether the border is visible.| +||[lineStyle](/.borderuniversal#word-javascript/api/word/-borderuniversal-linestyle-member)|Specifies the line style of the border.| +||[lineWidth](/.borderuniversal#word-javascript/api/word/-borderuniversal-linewidth-member)|Specifies the line width of an object's border.| +|[BorderUniversalCollection](/.borderuniversalcollection)|[applyPageBordersToAllSections()](/.borderuniversalcollection#word-javascript/api/word/-borderuniversalcollection-applypageborderstoallsections-member(1))|Applies the specified page-border formatting to all sections in the document.| +||[getItem(index: number)](/.borderuniversalcollection#word-javascript/api/word/-borderuniversalcollection-getitem-member(1))|Gets a `Border` object by its index in the collection.| +||[items](/.borderuniversalcollection#word-javascript/api/word/-borderuniversalcollection-items-member)|Gets the loaded child items in this collection.| +|[Break](/.break)|[pageIndex](/.break#word-javascript/api/word/-break-pageindex-member)|Returns the page number on which the break occurs.| +||[range](/.break#word-javascript/api/word/-break-range-member)|Returns a `Range` object that represents the portion of the document that's contained in the break.| +|[BreakCollection](/.breakcollection)|[items](/.breakcollection#word-javascript/api/word/-breakcollection-items-member)|Gets the loaded child items in this collection.| +|[BuildingBlock](/.buildingblock)|[category](/.buildingblock#word-javascript/api/word/-buildingblock-category-member)|Returns a `BuildingBlockCategory` object that represents the category for the building block.| +||[delete()](/.buildingblock#word-javascript/api/word/-buildingblock-delete-member(1))|Deletes the building block.| +||[description](/.buildingblock#word-javascript/api/word/-buildingblock-description-member)|Specifies the description for the building block.| +||[id](/.buildingblock#word-javascript/api/word/-buildingblock-id-member)|Returns the internal identification number for the building block.| +||[index](/.buildingblock#word-javascript/api/word/-buildingblock-index-member)|Returns the position of this building block in a collection.| +||[insert(range: Word.Range, richText: boolean)](/.buildingblock#word-javascript/api/word/-buildingblock-insert-member(1))|Inserts the value of the building block into the document and returns a `Range` object that represents the contents of the building block within the document.| +||[insertType](/.buildingblock#word-javascript/api/word/-buildingblock-inserttype-member)|Specifies a `DocPartInsertType` value that represents how to insert the contents of the building block into the document.| +||[name](/.buildingblock#word-javascript/api/word/-buildingblock-name-member)|Specifies the name of the building block.| +||[type](/.buildingblock#word-javascript/api/word/-buildingblock-type-member)|Returns a `BuildingBlockTypeItem` object that represents the type for the building block.| +||[value](/.buildingblock#word-javascript/api/word/-buildingblock-value-member)|Specifies the contents of the building block.| +|[BuildingBlockCategory](/.buildingblockcategory)|[buildingBlocks](/.buildingblockcategory#word-javascript/api/word/-buildingblockcategory-buildingblocks-member)|Returns a `BuildingBlockCollection` object that represents the building blocks for the category.| +||[index](/.buildingblockcategory#word-javascript/api/word/-buildingblockcategory-index-member)|Returns the position of the `BuildingBlockCategory` object in a collection.| +||[name](/.buildingblockcategory#word-javascript/api/word/-buildingblockcategory-name-member)|Returns the name of the `BuildingBlockCategory` object.| +||[type](/.buildingblockcategory#word-javascript/api/word/-buildingblockcategory-type-member)|Returns a `BuildingBlockTypeItem` object that represents the type of building block for the building block category.| +|[BuildingBlockCategoryCollection](/.buildingblockcategorycollection)|[getCount()](/.buildingblockcategorycollection#word-javascript/api/word/-buildingblockcategorycollection-getcount-member(1))|Returns the number of items in the collection.| +||[getItemAt(index: number)](/.buildingblockcategorycollection#word-javascript/api/word/-buildingblockcategorycollection-getitemat-member(1))|Returns a `BuildingBlockCategory` object that represents the specified item in the collection.| +|[BuildingBlockCollection](/.buildingblockcollection)|[add(name: string, range: Word.Range, description: string, insertType: Word.DocPartInsertType)](/.buildingblockcollection#word-javascript/api/word/-buildingblockcollection-add-member(1))|Creates a new building block and returns a `BuildingBlock` object.| +||[getCount()](/.buildingblockcollection#word-javascript/api/word/-buildingblockcollection-getcount-member(1))|Returns the number of items in the collection.| +||[getItemAt(index: number)](/.buildingblockcollection#word-javascript/api/word/-buildingblockcollection-getitemat-member(1))|Returns a `BuildingBlock` object that represents the specified item in the collection.| +|[BuildingBlockEntryCollection](/.buildingblockentrycollection)|[add(name: string, type: Word.BuildingBlockType, category: string, range: Word.Range, description: string, insertType: Word.DocPartInsertType)](/.buildingblockentrycollection#word-javascript/api/word/-buildingblockentrycollection-add-member(1))|Creates a new building block entry in a template and returns a `BuildingBlock` object that represents the new building block entry.| +||[getCount()](/.buildingblockentrycollection#word-javascript/api/word/-buildingblockentrycollection-getcount-member(1))|Returns the number of items in the collection.| +||[getItemAt(index: number)](/.buildingblockentrycollection#word-javascript/api/word/-buildingblockentrycollection-getitemat-member(1))|Returns a `BuildingBlock` object that represents the specified item in the collection.| +|[BuildingBlockGalleryContentControl](/.buildingblockgallerycontentcontrol)|[appearance](/.buildingblockgallerycontentcontrol#word-javascript/api/word/-buildingblockgallerycontentcontrol-appearance-member)|Specifies the appearance of the content control.| +||[buildingBlockCategory](/.buildingblockgallerycontentcontrol#word-javascript/api/word/-buildingblockgallerycontentcontrol-buildingblockcategory-member)|Specifies the category for the building block content control.| +||[buildingBlockType](/.buildingblockgallerycontentcontrol#word-javascript/api/word/-buildingblockgallerycontentcontrol-buildingblocktype-member)|Specifies a `BuildingBlockType` value that represents the type of building block for the building block content control.| +||[color](/.buildingblockgallerycontentcontrol#word-javascript/api/word/-buildingblockgallerycontentcontrol-color-member)|Specifies the red-green-blue (RGB) value of the color of the content control.| +||[copy()](/.buildingblockgallerycontentcontrol#word-javascript/api/word/-buildingblockgallerycontentcontrol-copy-member(1))|Copies the content control from the active document to the Clipboard.| +||[cut()](/.buildingblockgallerycontentcontrol#word-javascript/api/word/-buildingblockgallerycontentcontrol-cut-member(1))|Removes the content control from the active document and moves the content control to the Clipboard.| +||[delete(deleteContents?: boolean)](/.buildingblockgallerycontentcontrol#word-javascript/api/word/-buildingblockgallerycontentcontrol-delete-member(1))|Deletes the content control and optionally its contents.| +||[id](/.buildingblockgallerycontentcontrol#word-javascript/api/word/-buildingblockgallerycontentcontrol-id-member)|Gets the identification for the content control.| +||[isTemporary](/.buildingblockgallerycontentcontrol#word-javascript/api/word/-buildingblockgallerycontentcontrol-istemporary-member)|Specifies whether to remove the content control from the active document when the user edits the contents of the control.| +||[level](/.buildingblockgallerycontentcontrol#word-javascript/api/word/-buildingblockgallerycontentcontrol-level-member)|Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline.| +||[lockContentControl](/.buildingblockgallerycontentcontrol#word-javascript/api/word/-buildingblockgallerycontentcontrol-lockcontentcontrol-member)|Specifies if the content control is locked (can't be deleted).| +||[lockContents](/.buildingblockgallerycontentcontrol#word-javascript/api/word/-buildingblockgallerycontentcontrol-lockcontents-member)|Specifies if the contents of the content control are locked (not editable).| +||[placeholderText](/.buildingblockgallerycontentcontrol#word-javascript/api/word/-buildingblockgallerycontentcontrol-placeholdertext-member)|Returns a `BuildingBlock` object that represents the placeholder text for the content control.| +||[range](/.buildingblockgallerycontentcontrol#word-javascript/api/word/-buildingblockgallerycontentcontrol-range-member)|Returns a `Range` object that represents the contents of the content control in the active document.| +||[setPlaceholderText(options?: Word.ContentControlPlaceholderOptions)](/.buildingblockgallerycontentcontrol#word-javascript/api/word/-buildingblockgallerycontentcontrol-setplaceholdertext-member(1))|Sets the placeholder text that displays in the content control until a user enters their own text.| +||[showingPlaceholderText](/.buildingblockgallerycontentcontrol#word-javascript/api/word/-buildingblockgallerycontentcontrol-showingplaceholdertext-member)|Gets if the placeholder text for the content control is being displayed.| +||[tag](/.buildingblockgallerycontentcontrol#word-javascript/api/word/-buildingblockgallerycontentcontrol-tag-member)|Specifies a tag to identify the content control.| +||[title](/.buildingblockgallerycontentcontrol#word-javascript/api/word/-buildingblockgallerycontentcontrol-title-member)|Specifies the title for the content control.| +||[xmlMapping](/.buildingblockgallerycontentcontrol#word-javascript/api/word/-buildingblockgallerycontentcontrol-xmlmapping-member)|Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document.| +|[BuildingBlockTypeItem](/.buildingblocktypeitem)|[categories](/.buildingblocktypeitem#word-javascript/api/word/-buildingblocktypeitem-categories-member)|Returns a `BuildingBlockCategoryCollection` object that represents the categories for a building block type.| +||[index](/.buildingblocktypeitem#word-javascript/api/word/-buildingblocktypeitem-index-member)|Returns the position of an item in a collection.| +||[name](/.buildingblocktypeitem#word-javascript/api/word/-buildingblocktypeitem-name-member)|Returns the localized name of a building block type.| +|[BuildingBlockTypeItemCollection](/.buildingblocktypeitemcollection)|[getByType(type: Word.BuildingBlockType)](/.buildingblocktypeitemcollection#word-javascript/api/word/-buildingblocktypeitemcollection-getbytype-member(1))|Gets a `BuildingBlockTypeItem` object by its type in the collection.| +||[getCount()](/.buildingblocktypeitemcollection#word-javascript/api/word/-buildingblocktypeitemcollection-getcount-member(1))|Returns the number of items in the collection.| +|[ColorFormat](/.colorformat)|[brightness](/.colorformat#word-javascript/api/word/-colorformat-brightness-member)|Specifies the brightness of a specified shape color.| +||[objectThemeColor](/.colorformat#word-javascript/api/word/-colorformat-objectthemecolor-member)|Specifies the theme color for a color format.| +||[rgb](/.colorformat#word-javascript/api/word/-colorformat-rgb-member)|Specifies the red-green-blue (RGB) value of the specified color.| +||[tintAndShade](/.colorformat#word-javascript/api/word/-colorformat-tintandshade-member)|Specifies the lightening or darkening of a specified shape's color.| +||[type](/.colorformat#word-javascript/api/word/-colorformat-type-member)|Returns the shape color type.| +|[CommentDetail](/.commentdetail)|[id](/.commentdetail#word-javascript/api/word/-commentdetail-id-member)|Represents the ID of this comment.| +||[replyIds](/.commentdetail#word-javascript/api/word/-commentdetail-replyids-member)|Represents the IDs of the replies to this comment.| +|[CommentEventArgs](/.commenteventargs)|[changeType](/.commenteventargs#word-javascript/api/word/-commenteventargs-changetype-member)|Represents how the comment changed event is triggered.| +||[commentDetails](/.commenteventargs#word-javascript/api/word/-commenteventargs-commentdetails-member)|Gets the CommentDetail array which contains the IDs and reply IDs of the involved comments.| +||[source](/.commenteventargs#word-javascript/api/word/-commenteventargs-source-member)|The source of the event.| +||[type](/.commenteventargs#word-javascript/api/word/-commenteventargs-type-member)|The event type.| +|[ContentControl](/.contentcontrol)|[buildingBlockGalleryContentControl](/.contentcontrol#word-javascript/api/word/-contentcontrol-buildingblockgallerycontentcontrol-member)|Gets the building block gallery-related data if the content control's Word.ContentControlType is `BuildingBlockGallery`.| +||[datePickerContentControl](/.contentcontrol#word-javascript/api/word/-contentcontrol-datepickercontentcontrol-member)|Gets the date picker-related data if the content control's Word.ContentControlType is `DatePicker`.| +||[groupContentControl](/.contentcontrol#word-javascript/api/word/-contentcontrol-groupcontentcontrol-member)|Gets the group-related data if the content control's Word.ContentControlType is `Group`.| +||[onCommentAdded](/.contentcontrol#word-javascript/api/word/-contentcontrol-oncommentadded-member)|Occurs when new comments are added.| +||[onCommentChanged](/.contentcontrol#word-javascript/api/word/-contentcontrol-oncommentchanged-member)|Occurs when a comment or its reply is changed.| +||[onCommentDeselected](/.contentcontrol#word-javascript/api/word/-contentcontrol-oncommentdeselected-member)|Occurs when a comment is deselected.| +||[onCommentSelected](/.contentcontrol#word-javascript/api/word/-contentcontrol-oncommentselected-member)|Occurs when a comment is selected.| +||[pictureContentControl](/.contentcontrol#word-javascript/api/word/-contentcontrol-picturecontentcontrol-member)|Gets the picture-related data if the content control's Word.ContentControlType is `Picture`.| +||[repeatingSectionContentControl](/.contentcontrol#word-javascript/api/word/-contentcontrol-repeatingsectioncontentcontrol-member)|Gets the repeating section-related data if the content control's Word.ContentControlType is `RepeatingSection`.| +||[resetState()](/.contentcontrol#word-javascript/api/word/-contentcontrol-resetstate-member(1))|Resets the state of the content control.| +||[setState(contentControlState: Word.ContentControlState)](/.contentcontrol#word-javascript/api/word/-contentcontrol-setstate-member(1))|Sets the state of the content control.| +||[xmlMapping](/.contentcontrol#word-javascript/api/word/-contentcontrol-xmlmapping-member)|Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document.| +|[ContentControlAddedEventArgs](/.contentcontroladdedeventargs)|[eventType](/.contentcontroladdedeventargs#word-javascript/api/word/-contentcontroladdedeventargs-eventtype-member)|The event type.| +|[ContentControlDataChangedEventArgs](/.contentcontroldatachangedeventargs)|[eventType](/.contentcontroldatachangedeventargs#word-javascript/api/word/-contentcontroldatachangedeventargs-eventtype-member)|The event type.| +|[ContentControlDeletedEventArgs](/.contentcontroldeletedeventargs)|[eventType](/.contentcontroldeletedeventargs#word-javascript/api/word/-contentcontroldeletedeventargs-eventtype-member)|The event type.| +|[ContentControlEnteredEventArgs](/.contentcontrolenteredeventargs)|[eventType](/.contentcontrolenteredeventargs#word-javascript/api/word/-contentcontrolenteredeventargs-eventtype-member)|The event type.| +|[ContentControlExitedEventArgs](/.contentcontrolexitedeventargs)|[eventType](/.contentcontrolexitedeventargs#word-javascript/api/word/-contentcontrolexitedeventargs-eventtype-member)|The event type.| +|[ContentControlPlaceholderOptions](/.contentcontrolplaceholderoptions)|[buildingBlock](/.contentcontrolplaceholderoptions#word-javascript/api/word/-contentcontrolplaceholderoptions-buildingblock-member)|If provided, specifies the `BuildingBlock` object to use as placeholder.| +||[range](/.contentcontrolplaceholderoptions#word-javascript/api/word/-contentcontrolplaceholderoptions-range-member)|If provided, specifies the `Range` object to use as placeholder.| +||[text](/.contentcontrolplaceholderoptions#word-javascript/api/word/-contentcontrolplaceholderoptions-text-member)|If provided, specifies the text to use as placeholder.| +|[ContentControlSelectionChangedEventArgs](/.contentcontrolselectionchangedeventargs)|[eventType](/.contentcontrolselectionchangedeventargs#word-javascript/api/word/-contentcontrolselectionchangedeventargs-eventtype-member)|The event type.| +|[CustomXmlAddNodeOptions](/.customxmladdnodeoptions)|[name](/.customxmladdnodeoptions#word-javascript/api/word/-customxmladdnodeoptions-name-member)|If provided, specifies the base name of the element to be added.| +||[namespaceUri](/.customxmladdnodeoptions#word-javascript/api/word/-customxmladdnodeoptions-namespaceuri-member)|If provided, specifies the namespace of the element to be appended.| +||[nextSibling](/.customxmladdnodeoptions#word-javascript/api/word/-customxmladdnodeoptions-nextsibling-member)|If provided, specifies the node which should become the next sibling of the new node.| +||[nodeType](/.customxmladdnodeoptions#word-javascript/api/word/-customxmladdnodeoptions-nodetype-member)|If provided, specifies the type of node to add.| +||[nodeValue](/.customxmladdnodeoptions#word-javascript/api/word/-customxmladdnodeoptions-nodevalue-member)|If provided, specifies the value of the added node for those nodes that allow text.| +|[CustomXmlAddSchemaOptions](/.customxmladdschemaoptions)|[alias](/.customxmladdschemaoptions#word-javascript/api/word/-customxmladdschemaoptions-alias-member)|If provided, specifies the alias of the schema to be added to the collection.| +||[fileName](/.customxmladdschemaoptions#word-javascript/api/word/-customxmladdschemaoptions-filename-member)|If provided, specifies the location of the schema on a disk.| +||[installForAllUsers](/.customxmladdschemaoptions#word-javascript/api/word/-customxmladdschemaoptions-installforallusers-member)|If provided, specifies whether, in the case where the schema is being added to the Schema Library, the Schema Library keys should be written to the registry (`HKEY_LOCAL_MACHINE` for all users or `HKEY_CURRENT_USER` for just the current user).| +||[namespaceUri](/.customxmladdschemaoptions#word-javascript/api/word/-customxmladdschemaoptions-namespaceuri-member)|If provided, specifies the namespace of the schema to be added to the collection.| +|[CustomXmlAddValidationErrorOptions](/.customxmladdvalidationerroroptions)|[clearedOnUpdate](/.customxmladdvalidationerroroptions#word-javascript/api/word/-customxmladdvalidationerroroptions-clearedonupdate-member)|If provided, specifies whether the error is to be cleared from the Word.CustomXmlValidationErrorCollection when the XML is corrected and updated.| +||[errorText](/.customxmladdvalidationerroroptions#word-javascript/api/word/-customxmladdvalidationerroroptions-errortext-member)|If provided, specifies the descriptive error text.| +|[CustomXmlAppendChildNodeOptions](/.customxmlappendchildnodeoptions)|[name](/.customxmlappendchildnodeoptions#word-javascript/api/word/-customxmlappendchildnodeoptions-name-member)|If provided, specifies the base name of the element to be appended.| +||[namespaceUri](/.customxmlappendchildnodeoptions#word-javascript/api/word/-customxmlappendchildnodeoptions-namespaceuri-member)|If provided, specifies the namespace of the element to be appended.| +||[nodeType](/.customxmlappendchildnodeoptions#word-javascript/api/word/-customxmlappendchildnodeoptions-nodetype-member)|If provided, specifies the type of node to append.| +||[nodeValue](/.customxmlappendchildnodeoptions#word-javascript/api/word/-customxmlappendchildnodeoptions-nodevalue-member)|If provided, specifies the value of the appended node for those nodes that allow text.| +|[CustomXmlInsertNodeBeforeOptions](/.customxmlinsertnodebeforeoptions)|[name](/.customxmlinsertnodebeforeoptions#word-javascript/api/word/-customxmlinsertnodebeforeoptions-name-member)|If provided, specifies the base name of the element to be inserted.| +||[namespaceUri](/.customxmlinsertnodebeforeoptions#word-javascript/api/word/-customxmlinsertnodebeforeoptions-namespaceuri-member)|If provided, specifies the namespace of the element to be inserted.| +||[nextSibling](/.customxmlinsertnodebeforeoptions#word-javascript/api/word/-customxmlinsertnodebeforeoptions-nextsibling-member)|If provided, specifies the context node.| +||[nodeType](/.customxmlinsertnodebeforeoptions#word-javascript/api/word/-customxmlinsertnodebeforeoptions-nodetype-member)|If provided, specifies the type of node to append.| +||[nodeValue](/.customxmlinsertnodebeforeoptions#word-javascript/api/word/-customxmlinsertnodebeforeoptions-nodevalue-member)|If provided, specifies the value of the inserted node for those nodes that allow text.| +|[CustomXmlInsertSubtreeBeforeOptions](/.customxmlinsertsubtreebeforeoptions)|[nextSibling](/.customxmlinsertsubtreebeforeoptions#word-javascript/api/word/-customxmlinsertsubtreebeforeoptions-nextsibling-member)|If provided, specifies the context node.| +|[CustomXmlNode](/.customxmlnode)|[appendChildNode(options?: Word.CustomXmlAppendChildNodeOptions)](/.customxmlnode#word-javascript/api/word/-customxmlnode-appendchildnode-member(1))|Appends a single node as the last child under the context element node in the tree.| +||[appendChildSubtree(xml: string)](/.customxmlnode#word-javascript/api/word/-customxmlnode-appendchildsubtree-member(1))|Adds a subtree as the last child under the context element node in the tree.| +||[attributes](/.customxmlnode#word-javascript/api/word/-customxmlnode-attributes-member)|Gets a `CustomXmlNodeCollection` object representing the attributes of the current element in the current node.| +||[baseName](/.customxmlnode#word-javascript/api/word/-customxmlnode-basename-member)|Gets the base name of the node without the namespace prefix, if one exists.| +||[childNodes](/.customxmlnode#word-javascript/api/word/-customxmlnode-childnodes-member)|Gets a `CustomXmlNodeCollection` object containing all of the child elements of the current node.| +||[delete()](/.customxmlnode#word-javascript/api/word/-customxmlnode-delete-member(1))|Deletes the current node from the tree (including all of its children, if any exist).| +||[firstChild](/.customxmlnode#word-javascript/api/word/-customxmlnode-firstchild-member)|Gets a `CustomXmlNode` object corresponding to the first child element of the current node.| +||[hasChildNodes()](/.customxmlnode#word-javascript/api/word/-customxmlnode-haschildnodes-member(1))|Specifies if the current element node has child element nodes.| +||[insertNodeBefore(options?: Word.CustomXmlInsertNodeBeforeOptions)](/.customxmlnode#word-javascript/api/word/-customxmlnode-insertnodebefore-member(1))|Inserts a new node just before the context node in the tree.| +||[insertSubtreeBefore(xml: string, options?: Word.CustomXmlInsertSubtreeBeforeOptions)](/.customxmlnode#word-javascript/api/word/-customxmlnode-insertsubtreebefore-member(1))|Inserts the specified subtree into the location just before the context node.| +||[lastChild](/.customxmlnode#word-javascript/api/word/-customxmlnode-lastchild-member)|Gets a `CustomXmlNode` object corresponding to the last child element of the current node.| +||[namespaceUri](/.customxmlnode#word-javascript/api/word/-customxmlnode-namespaceuri-member)|Gets the unique address identifier for the namespace of the node.| +||[nextSibling](/.customxmlnode#word-javascript/api/word/-customxmlnode-nextsibling-member)|Gets the next sibling node (element, comment, or processing instruction) of the current node.| +||[nodeType](/.customxmlnode#word-javascript/api/word/-customxmlnode-nodetype-member)|Gets the type of the current node.| +||[nodeValue](/.customxmlnode#word-javascript/api/word/-customxmlnode-nodevalue-member)|Specifies the value of the current node.| +||[ownerPart](/.customxmlnode#word-javascript/api/word/-customxmlnode-ownerpart-member)|Gets the object representing the part associated with this node.| +||[parentNode](/.customxmlnode#word-javascript/api/word/-customxmlnode-parentnode-member)|Gets the parent element node of the current node.| +||[previousSibling](/.customxmlnode#word-javascript/api/word/-customxmlnode-previoussibling-member)|Gets the previous sibling node (element, comment, or processing instruction) of the current node.| +||[removeChild(child: Word.CustomXmlNode)](/.customxmlnode#word-javascript/api/word/-customxmlnode-removechild-member(1))|Removes the specified child node from the tree.| +||[replaceChildNode(oldNode: Word.CustomXmlNode, options?: Word.CustomXmlReplaceChildNodeOptions)](/.customxmlnode#word-javascript/api/word/-customxmlnode-replacechildnode-member(1))|Removes the specified child node and replaces it with a different node in the same location.| +||[replaceChildSubtree(xml: string, oldNode: Word.CustomXmlNode)](/.customxmlnode#word-javascript/api/word/-customxmlnode-replacechildsubtree-member(1))|Removes the specified node and replaces it with a different subtree in the same location.| +||[selectNodes(xPath: string)](/.customxmlnode#word-javascript/api/word/-customxmlnode-selectnodes-member(1))|Selects a collection of nodes matching an XPath expression.| +||[selectSingleNode(xPath: string)](/.customxmlnode#word-javascript/api/word/-customxmlnode-selectsinglenode-member(1))|Selects a single node from a collection matching an XPath expression.| +||[text](/.customxmlnode#word-javascript/api/word/-customxmlnode-text-member)|Specifies the text for the current node.| +||[xml](/.customxmlnode#word-javascript/api/word/-customxmlnode-xml-member)|Gets the XML representation of the current node and its children.| +||[xpath](/.customxmlnode#word-javascript/api/word/-customxmlnode-xpath-member)|Gets a string with the canonicalized XPath for the current node.| +|[CustomXmlNodeCollection](/.customxmlnodecollection)|[getCount()](/.customxmlnodecollection#word-javascript/api/word/-customxmlnodecollection-getcount-member(1))|Returns the number of items in the collection.| +||[getItem(index: number)](/.customxmlnodecollection#word-javascript/api/word/-customxmlnodecollection-getitem-member(1))|Returns a `CustomXmlNode` object that represents the specified item in the collection.| +||[items](/.customxmlnodecollection#word-javascript/api/word/-customxmlnodecollection-items-member)|Gets the loaded child items in this collection.| +|[CustomXmlPart](/.customxmlpart)|[addNode(parent: Word.CustomXmlNode, options?: Word.CustomXmlAddNodeOptions)](/.customxmlpart#word-javascript/api/word/-customxmlpart-addnode-member(1))|Adds a node to the XML tree.| +||[builtIn](/.customxmlpart#word-javascript/api/word/-customxmlpart-builtin-member)|Gets a value that indicates whether the `CustomXmlPart` is built-in.| +||[documentElement](/.customxmlpart#word-javascript/api/word/-customxmlpart-documentelement-member)|Gets the root element of a bound region of data in the document.| +||[errors](/.customxmlpart#word-javascript/api/word/-customxmlpart-errors-member)|Gets a `CustomXmlValidationErrorCollection` object that provides access to any XML validation errors.| +||[loadXml(xml: string)](/.customxmlpart#word-javascript/api/word/-customxmlpart-loadxml-member(1))|Populates the `CustomXmlPart` object from an XML string.| +||[namespaceManager](/.customxmlpart#word-javascript/api/word/-customxmlpart-namespacemanager-member)|Gets the set of namespace prefix mappings used against the current `CustomXmlPart` object.| +||[schemaCollection](/.customxmlpart#word-javascript/api/word/-customxmlpart-schemacollection-member)|Specifies a `CustomXmlSchemaCollection` object representing the set of schemas attached to a bound region of data in the document.| +||[selectNodes(xPath: string)](/.customxmlpart#word-javascript/api/word/-customxmlpart-selectnodes-member(1))|Selects a collection of nodes from a custom XML part.| +||[selectSingleNode(xPath: string)](/.customxmlpart#word-javascript/api/word/-customxmlpart-selectsinglenode-member(1))|Selects a single node within a custom XML part matching an XPath expression.| +||[xml](/.customxmlpart#word-javascript/api/word/-customxmlpart-xml-member)|Gets the XML representation of the current `CustomXmlPart` object.| +|[CustomXmlPrefixMapping](/.customxmlprefixmapping)|[namespaceUri](/.customxmlprefixmapping#word-javascript/api/word/-customxmlprefixmapping-namespaceuri-member)|Gets the unique address identifier for the namespace of the `CustomXmlPrefixMapping` object.| +||[prefix](/.customxmlprefixmapping#word-javascript/api/word/-customxmlprefixmapping-prefix-member)|Gets the prefix for the `CustomXmlPrefixMapping` object.| +|[CustomXmlPrefixMappingCollection](/.customxmlprefixmappingcollection)|[addNamespace(prefix: string, namespaceUri: string)](/.customxmlprefixmappingcollection#word-javascript/api/word/-customxmlprefixmappingcollection-addnamespace-member(1))|Adds a custom namespace/prefix mapping to use when querying an item.| +||[getCount()](/.customxmlprefixmappingcollection#word-javascript/api/word/-customxmlprefixmappingcollection-getcount-member(1))|Returns the number of items in the collection.| +||[getItem(index: number)](/.customxmlprefixmappingcollection#word-javascript/api/word/-customxmlprefixmappingcollection-getitem-member(1))|Returns a `CustomXmlPrefixMapping` object that represents the specified item in the collection.| +||[items](/.customxmlprefixmappingcollection#word-javascript/api/word/-customxmlprefixmappingcollection-items-member)|Gets the loaded child items in this collection.| +||[lookupNamespace(prefix: string)](/.customxmlprefixmappingcollection#word-javascript/api/word/-customxmlprefixmappingcollection-lookupnamespace-member(1))|Gets the namespace corresponding to the specified prefix.| +||[lookupPrefix(namespaceUri: string)](/.customxmlprefixmappingcollection#word-javascript/api/word/-customxmlprefixmappingcollection-lookupprefix-member(1))|Gets the prefix corresponding to the specified namespace.| +|[CustomXmlReplaceChildNodeOptions](/.customxmlreplacechildnodeoptions)|[name](/.customxmlreplacechildnodeoptions#word-javascript/api/word/-customxmlreplacechildnodeoptions-name-member)|If provided, specifies the base name of the replacement element.| +||[namespaceUri](/.customxmlreplacechildnodeoptions#word-javascript/api/word/-customxmlreplacechildnodeoptions-namespaceuri-member)|If provided, specifies the namespace of the replacement element.| +||[nodeType](/.customxmlreplacechildnodeoptions#word-javascript/api/word/-customxmlreplacechildnodeoptions-nodetype-member)|If provided, specifies the type of the replacement node.| +||[nodeValue](/.customxmlreplacechildnodeoptions#word-javascript/api/word/-customxmlreplacechildnodeoptions-nodevalue-member)|If provided, specifies the value of the replacement node for those nodes that allow text.| +|[CustomXmlSchema](/.customxmlschema)|[delete()](/.customxmlschema#word-javascript/api/word/-customxmlschema-delete-member(1))|Deletes this schema from the Word.CustomXmlSchemaCollection object.| +||[location](/.customxmlschema#word-javascript/api/word/-customxmlschema-location-member)|Gets the location of the schema on a computer.| +||[namespaceUri](/.customxmlschema#word-javascript/api/word/-customxmlschema-namespaceuri-member)|Gets the unique address identifier for the namespace of the `CustomXmlSchema` object.| +||[reload()](/.customxmlschema#word-javascript/api/word/-customxmlschema-reload-member(1))|Reloads the schema from a file.| +|[CustomXmlSchemaCollection](/.customxmlschemacollection)|[add(options?: Word.CustomXmlAddSchemaOptions)](/.customxmlschemacollection#word-javascript/api/word/-customxmlschemacollection-add-member(1))|Adds one or more schemas to the schema collection that can then be added to a stream in the data store and to the schema library.| +||[addCollection(schemaCollection: Word.CustomXmlSchemaCollection)](/.customxmlschemacollection#word-javascript/api/word/-customxmlschemacollection-addcollection-member(1))|Adds an existing schema collection to the current schema collection.| +||[getCount()](/.customxmlschemacollection#word-javascript/api/word/-customxmlschemacollection-getcount-member(1))|Returns the number of items in the collection.| +||[getItem(index: number)](/.customxmlschemacollection#word-javascript/api/word/-customxmlschemacollection-getitem-member(1))|Returns a `CustomXmlSchema` object that represents the specified item in the collection.| +||[getNamespaceUri()](/.customxmlschemacollection#word-javascript/api/word/-customxmlschemacollection-getnamespaceuri-member(1))|Returns the number of items in the collection.| +||[items](/.customxmlschemacollection#word-javascript/api/word/-customxmlschemacollection-items-member)|Gets the loaded child items in this collection.| +||[validate()](/.customxmlschemacollection#word-javascript/api/word/-customxmlschemacollection-validate-member(1))|Specifies whether the schemas in the schema collection are valid (conforms to the syntactic rules of XML and the rules for a specified vocabulary).| +|[CustomXmlValidationError](/.customxmlvalidationerror)|[delete()](/.customxmlvalidationerror#word-javascript/api/word/-customxmlvalidationerror-delete-member(1))|Deletes this `CustomXmlValidationError` object.| +||[errorCode](/.customxmlvalidationerror#word-javascript/api/word/-customxmlvalidationerror-errorcode-member)|Gets an integer representing the validation error in the `CustomXmlValidationError` object.| +||[name](/.customxmlvalidationerror#word-javascript/api/word/-customxmlvalidationerror-name-member)|Gets the name of the error in the `CustomXmlValidationError` object.If no errors exist, the property returns `Nothing`| +||[node](/.customxmlvalidationerror#word-javascript/api/word/-customxmlvalidationerror-node-member)|Gets the node associated with this `CustomXmlValidationError` object, if any exist.If no nodes exist, the property returns `Nothing`.| +||[text](/.customxmlvalidationerror#word-javascript/api/word/-customxmlvalidationerror-text-member)|Gets the text in the `CustomXmlValidationError` object.| +||[type](/.customxmlvalidationerror#word-javascript/api/word/-customxmlvalidationerror-type-member)|Gets the type of error generated from the `CustomXmlValidationError` object.| +|[CustomXmlValidationErrorCollection](/.customxmlvalidationerrorcollection)|[add(node: Word.CustomXmlNode, errorName: string, options?: Word.CustomXmlAddValidationErrorOptions)](/.customxmlvalidationerrorcollection#word-javascript/api/word/-customxmlvalidationerrorcollection-add-member(1))|Adds a `CustomXmlValidationError` object containing an XML validation error to the `CustomXmlValidationErrorCollection` object.| +||[getCount()](/.customxmlvalidationerrorcollection#word-javascript/api/word/-customxmlvalidationerrorcollection-getcount-member(1))|Returns the number of items in the collection.| +||[getItem(index: number)](/.customxmlvalidationerrorcollection#word-javascript/api/word/-customxmlvalidationerrorcollection-getitem-member(1))|Returns a `CustomXmlValidationError` object that represents the specified item in the collection.| +||[items](/.customxmlvalidationerrorcollection#word-javascript/api/word/-customxmlvalidationerrorcollection-items-member)|Gets the loaded child items in this collection.| +|[DatePickerContentControl](/.datepickercontentcontrol)|[appearance](/.datepickercontentcontrol#word-javascript/api/word/-datepickercontentcontrol-appearance-member)|Specifies the appearance of the content control.| +||[color](/.datepickercontentcontrol#word-javascript/api/word/-datepickercontentcontrol-color-member)|Specifies the red-green-blue (RGB) value of the color of the content control.| +||[copy()](/.datepickercontentcontrol#word-javascript/api/word/-datepickercontentcontrol-copy-member(1))|Copies the content control from the active document to the Clipboard.| +||[cut()](/.datepickercontentcontrol#word-javascript/api/word/-datepickercontentcontrol-cut-member(1))|Removes the content control from the active document and moves the content control to the Clipboard.| +||[dateCalendarType](/.datepickercontentcontrol#word-javascript/api/word/-datepickercontentcontrol-datecalendartype-member)|Specifies a `CalendarType` value that represents the calendar type for the date picker content control.| +||[dateDisplayFormat](/.datepickercontentcontrol#word-javascript/api/word/-datepickercontentcontrol-datedisplayformat-member)|Specifies the format in which dates are displayed.| +||[dateDisplayLocale](/.datepickercontentcontrol#word-javascript/api/word/-datepickercontentcontrol-datedisplaylocale-member)|Specifies a `LanguageId` that represents the language format for the date displayed in the date picker content control.| +||[dateStorageFormat](/.datepickercontentcontrol#word-javascript/api/word/-datepickercontentcontrol-datestorageformat-member)|Specifies a `ContentControlDateStorageFormat` value that represents the format for storage and retrieval of dates when the date picker content control is bound to the XML data store of the active document.| +||[delete(deleteContents?: boolean)](/.datepickercontentcontrol#word-javascript/api/word/-datepickercontentcontrol-delete-member(1))|Deletes this content control and the contents of the content control.| +||[id](/.datepickercontentcontrol#word-javascript/api/word/-datepickercontentcontrol-id-member)|Gets the identification for the content control.| +||[isTemporary](/.datepickercontentcontrol#word-javascript/api/word/-datepickercontentcontrol-istemporary-member)|Specifies whether to remove the content control from the active document when the user edits the contents of the control.| +||[level](/.datepickercontentcontrol#word-javascript/api/word/-datepickercontentcontrol-level-member)|Specifies the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline.| +||[lockContentControl](/.datepickercontentcontrol#word-javascript/api/word/-datepickercontentcontrol-lockcontentcontrol-member)|Specifies if the content control is locked (can't be deleted).| +||[lockContents](/.datepickercontentcontrol#word-javascript/api/word/-datepickercontentcontrol-lockcontents-member)|Specifies if the contents of the content control are locked (not editable).| +||[placeholderText](/.datepickercontentcontrol#word-javascript/api/word/-datepickercontentcontrol-placeholdertext-member)|Returns a `BuildingBlock` object that represents the placeholder text for the content control.| +||[range](/.datepickercontentcontrol#word-javascript/api/word/-datepickercontentcontrol-range-member)|Gets a `Range` object that represents the contents of the content control in the active document.| +||[setPlaceholderText(options?: Word.ContentControlPlaceholderOptions)](/.datepickercontentcontrol#word-javascript/api/word/-datepickercontentcontrol-setplaceholdertext-member(1))|Sets the placeholder text that displays in the content control until a user enters their own text.| +||[showingPlaceholderText](/.datepickercontentcontrol#word-javascript/api/word/-datepickercontentcontrol-showingplaceholdertext-member)|Gets whether the placeholder text for the content control is being displayed.| +||[tag](/.datepickercontentcontrol#word-javascript/api/word/-datepickercontentcontrol-tag-member)|Specifies a tag to identify the content control.| +||[title](/.datepickercontentcontrol#word-javascript/api/word/-datepickercontentcontrol-title-member)|Specifies the title for the content control.| +||[xmlMapping](/.datepickercontentcontrol#word-javascript/api/word/-datepickercontentcontrol-xmlmapping-member)|Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document.| +|[Document](/.document)|[attachedTemplate](/.document#word-javascript/api/word/-document-attachedtemplate-member)|Specifies a `Template` object that represents the template attached to the document.| +||[autoHyphenation](/.document#word-javascript/api/word/-document-autohyphenation-member)|Specifies if automatic hyphenation is turned on for the document.| +||[autoSaveOn](/.document#word-javascript/api/word/-document-autosaveon-member)|Specifies if the edits in the document are automatically saved.| +||[bibliography](/.document#word-javascript/api/word/-document-bibliography-member)|Returns a `Bibliography` object that represents the bibliography references contained within the document.| +||[bookmarks](/.document#word-javascript/api/word/-document-bookmarks-member)|Returns a `BookmarkCollection` object that represents all the bookmarks in the document.| +||[consecutiveHyphensLimit](/.document#word-javascript/api/word/-document-consecutivehyphenslimit-member)|Specifies the maximum number of consecutive lines that can end with hyphens.| +||[detectLanguage()](/.document#word-javascript/api/word/-document-detectlanguage-member(1))|Analyzes the document text to determine the language.| +||[documentLibraryVersions](/.document#word-javascript/api/word/-document-documentlibraryversions-member)|Returns a `DocumentLibraryVersionCollection` object that represents the collection of versions of a shared document that has versioning enabled and that's stored in a document library on a server.| +||[frames](/.document#word-javascript/api/word/-document-frames-member)|Returns a `FrameCollection` object that represents all the frames in the document.| +||[hyperlinks](/.document#word-javascript/api/word/-document-hyperlinks-member)|Returns a `HyperlinkCollection` object that represents all the hyperlinks in the document.| +||[hyphenateCaps](/.document#word-javascript/api/word/-document-hyphenatecaps-member)|Specifies whether words in all capital letters can be hyphenated.| +||[indexes](/.document#word-javascript/api/word/-document-indexes-member)|Returns an `IndexCollection` object that represents all the indexes in the document.| +||[languageDetected](/.document#word-javascript/api/word/-document-languagedetected-member)|Specifies whether Microsoft Word has detected the language of the document text.| +||[manualHyphenation()](/.document#word-javascript/api/word/-document-manualhyphenation-member(1))|Initiates manual hyphenation of a document, one line at a time.| +||[pageSetup](/.document#word-javascript/api/word/-document-pagesetup-member)|Returns a `PageSetup` object that's associated with the document.| +|[DocumentLibraryVersion](/.documentlibraryversion)|[comments](/.documentlibraryversion#word-javascript/api/word/-documentlibraryversion-comments-member)|Gets any optional comments associated with this version of the shared document.| +||[modified](/.documentlibraryversion#word-javascript/api/word/-documentlibraryversion-modified-member)|Gets the date and time at which this version of the shared document was last saved to the server.| +||[modifiedBy](/.documentlibraryversion#word-javascript/api/word/-documentlibraryversion-modifiedby-member)|Gets the name of the user who last saved this version of the shared document to the server.| +|[DocumentLibraryVersionCollection](/.documentlibraryversioncollection)|[getItem(index: number)](/.documentlibraryversioncollection#word-javascript/api/word/-documentlibraryversioncollection-getitem-member(1))|Gets a `DocumentLibraryVersion` object by its index in the collection.| +||[isVersioningEnabled()](/.documentlibraryversioncollection#word-javascript/api/word/-documentlibraryversioncollection-isversioningenabled-member(1))|Returns whether the document library in which the active document is saved on the server is configured to create a backup copy, or version, each time the file is edited on the website.| +||[items](/.documentlibraryversioncollection#word-javascript/api/word/-documentlibraryversioncollection-items-member)|Gets the loaded child items in this collection.| +|[DropCap](/.dropcap)|[clear()](/.dropcap#word-javascript/api/word/-dropcap-clear-member(1))|Removes the dropped capital letter formatting.| +||[distanceFromText](/.dropcap#word-javascript/api/word/-dropcap-distancefromtext-member)|Gets the distance (in points) between the dropped capital letter and the paragraph text.| +||[enable()](/.dropcap#word-javascript/api/word/-dropcap-enable-member(1))|Formats the first character in the specified paragraph as a dropped capital letter.| +||[fontName](/.dropcap#word-javascript/api/word/-dropcap-fontname-member)|Gets the name of the font for the dropped capital letter.| +||[linesToDrop](/.dropcap#word-javascript/api/word/-dropcap-linestodrop-member)|Gets the height (in lines) of the dropped capital letter.| +||[position](/.dropcap#word-javascript/api/word/-dropcap-position-member)|Gets the position of the dropped capital letter.| +|[Field](/.field)|[copyToClipboard()](/.field#word-javascript/api/word/-field-copytoclipboard-member(1))|Copies the field to the Clipboard.| +||[cut()](/.field#word-javascript/api/word/-field-cut-member(1))|Removes the field from the document and places it on the Clipboard.| +||[doClick()](/.field#word-javascript/api/word/-field-doclick-member(1))|Clicks the field.| +||[linkFormat](/.field#word-javascript/api/word/-field-linkformat-member)|Gets a `LinkFormat` object that represents the link options of the field.| +||[oleFormat](/.field#word-javascript/api/word/-field-oleformat-member)|Gets an `OleFormat` object that represents the OLE characteristics (other than linking) for the field.| +||[unlink()](/.field#word-javascript/api/word/-field-unlink-member(1))|Replaces the field with its most recent result.| +||[updateSource()](/.field#word-javascript/api/word/-field-updatesource-member(1))|Saves the changes made to the results of an {@link https://support.microsoft.com/office/1c34d6d6-0de3-4b5c-916a-2ff950fb629e | INCLUDETEXT field} back to the source document.| +|[FillFormat](/.fillformat)|[backgroundColor](/.fillformat#word-javascript/api/word/-fillformat-backgroundcolor-member)|Returns a `ColorFormat` object that represents the background color for the fill.| +||[foregroundColor](/.fillformat#word-javascript/api/word/-fillformat-foregroundcolor-member)|Returns a `ColorFormat` object that represents the foreground color for the fill.| +||[gradientAngle](/.fillformat#word-javascript/api/word/-fillformat-gradientangle-member)|Specifies the angle of the gradient fill.| +||[gradientColorType](/.fillformat#word-javascript/api/word/-fillformat-gradientcolortype-member)|Gets the gradient color type.| +||[gradientDegree](/.fillformat#word-javascript/api/word/-fillformat-gradientdegree-member)|Returns how dark or light a one-color gradient fill is.| +||[gradientStyle](/.fillformat#word-javascript/api/word/-fillformat-gradientstyle-member)|Returns the gradient style for the fill.| +||[gradientVariant](/.fillformat#word-javascript/api/word/-fillformat-gradientvariant-member)|Returns the gradient variant for the fill as an integer value from 1 to 4 for most gradient fills.| +||[isVisible](/.fillformat#word-javascript/api/word/-fillformat-isvisible-member)|Specifies if the object, or the formatting applied to it, is visible.| +||[pattern](/.fillformat#word-javascript/api/word/-fillformat-pattern-member)|Returns a `PatternType` value that represents the pattern applied to the fill or line.| +||[presetGradientType](/.fillformat#word-javascript/api/word/-fillformat-presetgradienttype-member)|Returns the preset gradient type for the fill.| +||[presetTexture](/.fillformat#word-javascript/api/word/-fillformat-presettexture-member)|Gets the preset texture.| +||[rotateWithObject](/.fillformat#word-javascript/api/word/-fillformat-rotatewithobject-member)|Specifies whether the fill rotates with the shape.| +||[setOneColorGradient(style: Word.GradientStyle, variant: number, degree: number)](/.fillformat#word-javascript/api/word/-fillformat-setonecolorgradient-member(1))|Sets the fill to a one-color gradient.| +||[setPatterned(pattern: Word.PatternType)](/.fillformat#word-javascript/api/word/-fillformat-setpatterned-member(1))|Sets the fill to a pattern.| +||[setPresetGradient(style: Word.GradientStyle, variant: number, presetGradientType: Word.PresetGradientType)](/.fillformat#word-javascript/api/word/-fillformat-setpresetgradient-member(1))|Sets the fill to a preset gradient.| +||[setPresetTextured(presetTexture: Word.PresetTexture)](/.fillformat#word-javascript/api/word/-fillformat-setpresettextured-member(1))|Sets the fill to a preset texture.| +||[setTwoColorGradient(style: Word.GradientStyle, variant: number)](/.fillformat#word-javascript/api/word/-fillformat-settwocolorgradient-member(1))|Sets the fill to a two-color gradient.| +||[solid()](/.fillformat#word-javascript/api/word/-fillformat-solid-member(1))|Sets the fill to a uniform color.| +||[textureAlignment](/.fillformat#word-javascript/api/word/-fillformat-texturealignment-member)|Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill.| +||[textureHorizontalScale](/.fillformat#word-javascript/api/word/-fillformat-texturehorizontalscale-member)|Specifies the horizontal scaling factor for the texture fill.| +||[textureName](/.fillformat#word-javascript/api/word/-fillformat-texturename-member)|Returns the name of the custom texture file for the fill.| +||[textureOffsetX](/.fillformat#word-javascript/api/word/-fillformat-textureoffsetx-member)|Specifies the horizontal offset of the texture from the origin in points.| +||[textureOffsetY](/.fillformat#word-javascript/api/word/-fillformat-textureoffsety-member)|Specifies the vertical offset of the texture.| +||[textureTile](/.fillformat#word-javascript/api/word/-fillformat-texturetile-member)|Specifies whether the texture is tiled.| +||[textureType](/.fillformat#word-javascript/api/word/-fillformat-texturetype-member)|Returns the texture type for the fill.| +||[textureVerticalScale](/.fillformat#word-javascript/api/word/-fillformat-textureverticalscale-member)|Specifies the vertical scaling factor for the texture fill as a value between 0.0 and 1.0.| +||[transparency](/.fillformat#word-javascript/api/word/-fillformat-transparency-member)|Specifies the degree of transparency of the fill for a shape as a value between 0.0 (opaque) and 1.0 (clear).| +||[type](/.fillformat#word-javascript/api/word/-fillformat-type-member)|Gets the fill format type.| +|[Font](/.font)|[allCaps](/.font#word-javascript/api/word/-font-allcaps-member)|Specifies whether the font is formatted as all capital letters, which makes lowercase letters appear as uppercase letters.| +||[boldBidirectional](/.font#word-javascript/api/word/-font-boldbidirectional-member)|Specifies whether the font is formatted as bold in a right-to-left language document.| +||[borders](/.font#word-javascript/api/word/-font-borders-member)|Returns a `BorderUniversalCollection` object that represents all the borders for the font.| +||[colorIndex](/.font#word-javascript/api/word/-font-colorindex-member)|Specifies a `ColorIndex` value that represents the color for the font.| +||[colorIndexBidirectional](/.font#word-javascript/api/word/-font-colorindexbidirectional-member)|Specifies the color for the `Font` object in a right-to-left language document.| +||[contextualAlternates](/.font#word-javascript/api/word/-font-contextualalternates-member)|Specifies whether contextual alternates are enabled for the font.| +||[decreaseFontSize()](/.font#word-javascript/api/word/-font-decreasefontsize-member(1))|Decreases the font size to the next available size.| +||[diacriticColor](/.font#word-javascript/api/word/-font-diacriticcolor-member)|Specifies the color to be used for diacritics for the `Font` object.| +||[disableCharacterSpaceGrid](/.font#word-javascript/api/word/-font-disablecharacterspacegrid-member)|Specifies whether Microsoft Word ignores the number of characters per line for the corresponding `Font` object.| +||[emboss](/.font#word-javascript/api/word/-font-emboss-member)|Specifies whether the font is formatted as embossed.| +||[emphasisMark](/.font#word-javascript/api/word/-font-emphasismark-member)|Specifies an `EmphasisMark` value that represents the emphasis mark for a character or designated character string.| +||[engrave](/.font#word-javascript/api/word/-font-engrave-member)|Specifies whether the font is formatted as engraved.| +||[fill](/.font#word-javascript/api/word/-font-fill-member)|Returns a `FillFormat` object that contains fill formatting properties for the font used by the range of text.| +||[glow](/.font#word-javascript/api/word/-font-glow-member)|Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text.| +||[increaseFontSize()](/.font#word-javascript/api/word/-font-increasefontsize-member(1))|Increases the font size to the next available size.| +||[italicBidirectional](/.font#word-javascript/api/word/-font-italicbidirectional-member)|Specifies whether the font is italicized in a right-to-left language document.| +||[kerning](/.font#word-javascript/api/word/-font-kerning-member)|Specifies the minimum font size for which Microsoft Word will adjust kerning automatically.| +||[ligature](/.font#word-javascript/api/word/-font-ligature-member)|Specifies the ligature setting for the `Font` object.| +||[line](/.font#word-javascript/api/word/-font-line-member)|Returns a `LineFormat` object that specifies the formatting for a line.| +||[nameAscii](/.font#word-javascript/api/word/-font-nameascii-member)|Specifies the font used for Latin text (characters with character codes from 0 (zero) through 127).| +||[nameBidirectional](/.font#word-javascript/api/word/-font-namebidirectional-member)|Specifies the font name in a right-to-left language document.| +||[nameFarEast](/.font#word-javascript/api/word/-font-namefareast-member)|Specifies the East Asian font name.| +||[nameOther](/.font#word-javascript/api/word/-font-nameother-member)|Specifies the font used for characters with codes from 128 through 255.| +||[numberForm](/.font#word-javascript/api/word/-font-numberform-member)|Specifies the number form setting for an OpenType font.| +||[numberSpacing](/.font#word-javascript/api/word/-font-numberspacing-member)|Specifies the number spacing setting for the font.| +||[outline](/.font#word-javascript/api/word/-font-outline-member)|Specifies if the font is formatted as outlined.| +||[position](/.font#word-javascript/api/word/-font-position-member)|Specifies the position of text (in points) relative to the base line.| +||[reflection](/.font#word-javascript/api/word/-font-reflection-member)|Returns a `ReflectionFormat` object that represents the reflection formatting for a shape.| +||[reset()](/.font#word-javascript/api/word/-font-reset-member(1))|Removes manual character formatting.| +||[scaling](/.font#word-javascript/api/word/-font-scaling-member)|Specifies the scaling percentage applied to the font.| +||[setAsTemplateDefault()](/.font#word-javascript/api/word/-font-setastemplatedefault-member(1))|Sets the specified font formatting as the default for the active document and all new documents based on the active template.| +||[shadow](/.font#word-javascript/api/word/-font-shadow-member)|Specifies if the font is formatted as shadowed.| +||[sizeBidirectional](/.font#word-javascript/api/word/-font-sizebidirectional-member)|Specifies the font size in points for right-to-left text.| +||[smallCaps](/.font#word-javascript/api/word/-font-smallcaps-member)|Specifies whether the font is formatted as small caps, which makes lowercase letters appear as small uppercase letters.| +||[spacing](/.font#word-javascript/api/word/-font-spacing-member)|Specifies the spacing between characters.| +||[stylisticSet](/.font#word-javascript/api/word/-font-stylisticset-member)|Specifies the stylistic set for the font.| +||[textColor](/.font#word-javascript/api/word/-font-textcolor-member)|Returns a `ColorFormat` object that represents the color for the font.| +||[textShadow](/.font#word-javascript/api/word/-font-textshadow-member)|Returns a `ShadowFormat` object that specifies the shadow formatting for the font.| +||[threeDimensionalFormat](/.font#word-javascript/api/word/-font-threedimensionalformat-member)|Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font.| +||[underlineColor](/.font#word-javascript/api/word/-font-underlinecolor-member)|Specifies the color of the underline for the `Font` object.| +|[Frame](/.frame)|[borders](/.frame#word-javascript/api/word/-frame-borders-member)|Returns a `BorderUniversalCollection` object that represents all the borders for the frame.| +||[copy()](/.frame#word-javascript/api/word/-frame-copy-member(1))|Copies the frame to the Clipboard.| +||[cut()](/.frame#word-javascript/api/word/-frame-cut-member(1))|Removes the frame from the document and places it on the Clipboard.| +||[delete()](/.frame#word-javascript/api/word/-frame-delete-member(1))|Deletes the frame.| +||[height](/.frame#word-javascript/api/word/-frame-height-member)|Specifies the height (in points) of the frame.| +||[heightRule](/.frame#word-javascript/api/word/-frame-heightrule-member)|Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame.| +||[horizontalDistanceFromText](/.frame#word-javascript/api/word/-frame-horizontaldistancefromtext-member)|Specifies the horizontal distance between the frame and the surrounding text, in points.| +||[horizontalPosition](/.frame#word-javascript/api/word/-frame-horizontalposition-member)|Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property.| +||[lockAnchor](/.frame#word-javascript/api/word/-frame-lockanchor-member)|Specifies if the frame is locked.| +||[range](/.frame#word-javascript/api/word/-frame-range-member)|Returns a `Range` object that represents the portion of the document that's contained within the frame.| +||[relativeHorizontalPosition](/.frame#word-javascript/api/word/-frame-relativehorizontalposition-member)|Specifies the relative horizontal position of the frame.| +||[relativeVerticalPosition](/.frame#word-javascript/api/word/-frame-relativeverticalposition-member)|Specifies the relative vertical position of the frame.| +||[select()](/.frame#word-javascript/api/word/-frame-select-member(1))|Selects the frame.| +||[shading](/.frame#word-javascript/api/word/-frame-shading-member)|Returns a `ShadingUniversal` object that refers to the shading formatting for the frame.| +||[textWrap](/.frame#word-javascript/api/word/-frame-textwrap-member)|Specifies if document text wraps around the frame.| +||[verticalDistanceFromText](/.frame#word-javascript/api/word/-frame-verticaldistancefromtext-member)|Specifies the vertical distance (in points) between the frame and the surrounding text.| +||[verticalPosition](/.frame#word-javascript/api/word/-frame-verticalposition-member)|Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property.| +||[width](/.frame#word-javascript/api/word/-frame-width-member)|Specifies the width (in points) of the frame.| +||[widthRule](/.frame#word-javascript/api/word/-frame-widthrule-member)|Specifies the rule used to determine the width of the frame.| +|[FrameCollection](/.framecollection)|[add(range: Word.Range)](/.framecollection#word-javascript/api/word/-framecollection-add-member(1))|Returns a `Frame` object that represents a new frame added to a range, selection, or document.| +||[delete()](/.framecollection#word-javascript/api/word/-framecollection-delete-member(1))|Deletes the `FrameCollection` object.| +||[getItem(index: number)](/.framecollection#word-javascript/api/word/-framecollection-getitem-member(1))|Gets a `Frame` object by its index in the collection.| +||[items](/.framecollection#word-javascript/api/word/-framecollection-items-member)|Gets the loaded child items in this collection.| +|[GlowFormat](/.glowformat)|[color](/.glowformat#word-javascript/api/word/-glowformat-color-member)|Returns a `ColorFormat` object that represents the color for a glow effect.| +||[radius](/.glowformat#word-javascript/api/word/-glowformat-radius-member)|Specifies the length of the radius for a glow effect.| +||[transparency](/.glowformat#word-javascript/api/word/-glowformat-transparency-member)|Specifies the degree of transparency for the glow effect as a value between 0.0 (opaque) and 1.0 (clear).| +|[GroupContentControl](/.groupcontentcontrol)|[appearance](/.groupcontentcontrol#word-javascript/api/word/-groupcontentcontrol-appearance-member)|Specifies the appearance of the content control.| +||[color](/.groupcontentcontrol#word-javascript/api/word/-groupcontentcontrol-color-member)|Specifies the red-green-blue (RGB) value of the color of the content control.| +||[copy()](/.groupcontentcontrol#word-javascript/api/word/-groupcontentcontrol-copy-member(1))|Copies the content control from the active document to the Clipboard.| +||[cut()](/.groupcontentcontrol#word-javascript/api/word/-groupcontentcontrol-cut-member(1))|Removes the content control from the active document and moves the content control to the Clipboard.| +||[delete(deleteContents: boolean)](/.groupcontentcontrol#word-javascript/api/word/-groupcontentcontrol-delete-member(1))|Deletes the content control and optionally its contents.| +||[id](/.groupcontentcontrol#word-javascript/api/word/-groupcontentcontrol-id-member)|Returns the identification for the content control.| +||[isTemporary](/.groupcontentcontrol#word-javascript/api/word/-groupcontentcontrol-istemporary-member)|Specifies whether to remove the content control from the active document when the user edits the contents of the control.| +||[level](/.groupcontentcontrol#word-javascript/api/word/-groupcontentcontrol-level-member)|Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline.| +||[lockContentControl](/.groupcontentcontrol#word-javascript/api/word/-groupcontentcontrol-lockcontentcontrol-member)|Specifies if the content control is locked (can't be deleted).| +||[lockContents](/.groupcontentcontrol#word-javascript/api/word/-groupcontentcontrol-lockcontents-member)|Specifies if the contents of the content control are locked (not editable).| +||[placeholderText](/.groupcontentcontrol#word-javascript/api/word/-groupcontentcontrol-placeholdertext-member)|Returns a `BuildingBlock` object that represents the placeholder text for the content control.| +||[range](/.groupcontentcontrol#word-javascript/api/word/-groupcontentcontrol-range-member)|Gets a `Range` object that represents the contents of the content control in the active document.| +||[setPlaceholderText(options?: Word.ContentControlPlaceholderOptions)](/.groupcontentcontrol#word-javascript/api/word/-groupcontentcontrol-setplaceholdertext-member(1))|Sets the placeholder text that displays in the content control until a user enters their own text.| +||[showingPlaceholderText](/.groupcontentcontrol#word-javascript/api/word/-groupcontentcontrol-showingplaceholdertext-member)|Returns whether the placeholder text for the content control is being displayed.| +||[tag](/.groupcontentcontrol#word-javascript/api/word/-groupcontentcontrol-tag-member)|Specifies a tag to identify the content control.| +||[title](/.groupcontentcontrol#word-javascript/api/word/-groupcontentcontrol-title-member)|Specifies the title for the content control.| +||[ungroup()](/.groupcontentcontrol#word-javascript/api/word/-groupcontentcontrol-ungroup-member(1))|Removes the group content control from the document so that its child content controls are no longer nested and can be freely edited.| +||[xmlMapping](/.groupcontentcontrol#word-javascript/api/word/-groupcontentcontrol-xmlmapping-member)|Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document.| +|[Hyperlink](/.hyperlink)|[addToFavorites()](/.hyperlink#word-javascript/api/word/-hyperlink-addtofavorites-member(1))|Creates a shortcut to the document or hyperlink and adds it to the **Favorites** folder.| +||[address](/.hyperlink#word-javascript/api/word/-hyperlink-address-member)|Specifies the address (for example, a file name or URL) of the hyperlink.| +||[createNewDocument(fileName: string, editNow: boolean, overwrite: boolean)](/.hyperlink#word-javascript/api/word/-hyperlink-createnewdocument-member(1))|Creates a new document linked to the hyperlink.| +||[delete()](/.hyperlink#word-javascript/api/word/-hyperlink-delete-member(1))|Deletes the hyperlink.| +||[emailSubject](/.hyperlink#word-javascript/api/word/-hyperlink-emailsubject-member)|Specifies the text string for the hyperlink's subject line.| +||[isExtraInfoRequired](/.hyperlink#word-javascript/api/word/-hyperlink-isextrainforequired-member)|Returns `true` if extra information is required to resolve the hyperlink.| +||[name](/.hyperlink#word-javascript/api/word/-hyperlink-name-member)|Returns the name of the `Hyperlink` object.| +||[range](/.hyperlink#word-javascript/api/word/-hyperlink-range-member)|Returns a `Range` object that represents the portion of the document that's contained within the hyperlink.| +||[screenTip](/.hyperlink#word-javascript/api/word/-hyperlink-screentip-member)|Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink.| +||[subAddress](/.hyperlink#word-javascript/api/word/-hyperlink-subaddress-member)|Specifies a named location in the destination of the hyperlink.| +||[target](/.hyperlink#word-javascript/api/word/-hyperlink-target-member)|Specifies the name of the frame or window in which to load the hyperlink.| +||[textToDisplay](/.hyperlink#word-javascript/api/word/-hyperlink-texttodisplay-member)|Specifies the hyperlink's visible text in the document.| +||[type](/.hyperlink#word-javascript/api/word/-hyperlink-type-member)|Returns the hyperlink type.| +|[HyperlinkAddOptions](/.hyperlinkaddoptions)|[address](/.hyperlinkaddoptions#word-javascript/api/word/-hyperlinkaddoptions-address-member)|If provided, specifies the address (e.g., URL or file path) of the hyperlink.| +||[screenTip](/.hyperlinkaddoptions#word-javascript/api/word/-hyperlinkaddoptions-screentip-member)|If provided, specifies the text that appears as a tooltip.| +||[subAddress](/.hyperlinkaddoptions#word-javascript/api/word/-hyperlinkaddoptions-subaddress-member)|If provided, specifies the location within the file or document.| +||[target](/.hyperlinkaddoptions#word-javascript/api/word/-hyperlinkaddoptions-target-member)|If provided, specifies the name of the frame or window in which to load the hyperlink.| +||[textToDisplay](/.hyperlinkaddoptions#word-javascript/api/word/-hyperlinkaddoptions-texttodisplay-member)|If provided, specifies the visible text of the hyperlink.| +|[HyperlinkCollection](/.hyperlinkcollection)|[add(anchor: Word.Range, options?: Word.HyperlinkAddOptions)](/.hyperlinkcollection#word-javascript/api/word/-hyperlinkcollection-add-member(1))|Returns a `Hyperlink` object that represents a new hyperlink added to a range, selection, or document.| +||[items](/.hyperlinkcollection#word-javascript/api/word/-hyperlinkcollection-items-member)|Gets the loaded child items in this collection.| +|[Index](/.index)|[delete()](/.index#word-javascript/api/word/-index-delete-member(1))|Deletes this index.| +||[filter](/.index#word-javascript/api/word/-index-filter-member)|Gets a value that represents how Microsoft Word classifies the first character of entries in the index.| +||[headingSeparator](/.index#word-javascript/api/word/-index-headingseparator-member)|Gets the text between alphabetical groups (entries that start with the same letter) in the index.| +||[indexLanguage](/.index#word-javascript/api/word/-index-indexlanguage-member)|Gets a `LanguageId` value that represents the sorting language to use for the index.| +||[numberOfColumns](/.index#word-javascript/api/word/-index-numberofcolumns-member)|Gets the number of columns for each page of the index.| +||[range](/.index#word-javascript/api/word/-index-range-member)|Returns a `Range` object that represents the portion of the document that is contained within the index.| +||[rightAlignPageNumbers](/.index#word-javascript/api/word/-index-rightalignpagenumbers-member)|Specifies if page numbers are aligned with the right margin in the index.| +||[separateAccentedLetterHeadings](/.index#word-javascript/api/word/-index-separateaccentedletterheadings-member)|Gets if the index contains separate headings for accented letters (for example, words that begin with "À" are under| +||[sortBy](/.index#word-javascript/api/word/-index-sortby-member)|Specifies the sorting criteria for the index.| +||[tabLeader](/.index#word-javascript/api/word/-index-tableader-member)|Specifies the leader character between entries in the index and their associated page numbers.| +||[type](/.index#word-javascript/api/word/-index-type-member)|Gets the index type.| +|[IndexAddOptions](/.indexaddoptions)|[headingSeparator](/.indexaddoptions#word-javascript/api/word/-indexaddoptions-headingseparator-member)|If provided, specifies the text between alphabetical groups (entries that start with the same letter) in the index.| +||[indexLanguage](/.indexaddoptions#word-javascript/api/word/-indexaddoptions-indexlanguage-member)|If provided, specifies the sorting language to be used for the index being added.| +||[numberOfColumns](/.indexaddoptions#word-javascript/api/word/-indexaddoptions-numberofcolumns-member)|If provided, specifies the number of columns for each page of the index.| +||[rightAlignPageNumbers](/.indexaddoptions#word-javascript/api/word/-indexaddoptions-rightalignpagenumbers-member)|If provided, specifies whether the page numbers in the generated index are aligned with the right margin.| +||[separateAccentedLetterHeadings](/.indexaddoptions#word-javascript/api/word/-indexaddoptions-separateaccentedletterheadings-member)|If provided, specifies whether to include separate headings for accented letters in the index.| +||[sortBy](/.indexaddoptions#word-javascript/api/word/-indexaddoptions-sortby-member)|If provided, specifies the sorting criteria to be used for the index being added.| +||[type](/.indexaddoptions#word-javascript/api/word/-indexaddoptions-type-member)|If provided, specifies whether subentries are on the same line (run-in) as the main entry or on a separate line (indented) from the main entry.| +|[IndexCollection](/.indexcollection)|[add(range: Word.Range, indexAddOptions?: Word.IndexAddOptions)](/.indexcollection#word-javascript/api/word/-indexcollection-add-member(1))|Returns an `Index` object that represents a new index added to the document.| +||[getFormat()](/.indexcollection#word-javascript/api/word/-indexcollection-getformat-member(1))|Gets the `IndexFormat` value that represents the formatting for the indexes in the document.| +||[getItem(index: number)](/.indexcollection#word-javascript/api/word/-indexcollection-getitem-member(1))|Gets an `Index` object by its index in the collection.| +||[items](/.indexcollection#word-javascript/api/word/-indexcollection-items-member)|Gets the loaded child items in this collection.| +||[markAllEntries(range: Word.Range, markAllEntriesOptions?: Word.IndexMarkAllEntriesOptions)](/.indexcollection#word-javascript/api/word/-indexcollection-markallentries-member(1))|Inserts an {@link https://support.microsoft.com/office/abaf7c78-6e21-418d-bf8b-f8186d2e4d08 | XE (Index Entry) field} after all instances of the text in the range.| +|[IndexMarkAllEntriesOptions](/.indexmarkallentriesoptions)|[bold](/.indexmarkallentriesoptions#word-javascript/api/word/-indexmarkallentriesoptions-bold-member)|If provided, specifies whether to add bold formatting to page numbers for index entries.| +||[bookmarkName](/.indexmarkallentriesoptions#word-javascript/api/word/-indexmarkallentriesoptions-bookmarkname-member)|If provided, specifies the bookmark name that marks the range of pages you want to appear in the index.| +||[crossReference](/.indexmarkallentriesoptions#word-javascript/api/word/-indexmarkallentriesoptions-crossreference-member)|If provided, specifies the cross-reference that will appear in the index.| +||[crossReferenceAutoText](/.indexmarkallentriesoptions#word-javascript/api/word/-indexmarkallentriesoptions-crossreferenceautotext-member)|If provided, specifies the name of the `AutoText` entry that contains the text for a cross-reference (if this property is specified, `crossReference` is ignored).| +||[entry](/.indexmarkallentriesoptions#word-javascript/api/word/-indexmarkallentriesoptions-entry-member)|If provided, specifies the text you want to appear in the index, in the form `MainEntry[:Subentry]`.| +||[entryAutoText](/.indexmarkallentriesoptions#word-javascript/api/word/-indexmarkallentriesoptions-entryautotext-member)|If provided, specifies the `AutoText` entry that contains the text you want to appear in the index (if this property is specified, `entry` is ignored).| +||[italic](/.indexmarkallentriesoptions#word-javascript/api/word/-indexmarkallentriesoptions-italic-member)|If provided, specifies whether to add italic formatting to page numbers for index entries.| +|[IndexMarkEntryOptions](/.indexmarkentryoptions)|[bold](/.indexmarkentryoptions#word-javascript/api/word/-indexmarkentryoptions-bold-member)|If provided, specifies whether to add bold formatting to page numbers for index entries.| +||[bookmarkName](/.indexmarkentryoptions#word-javascript/api/word/-indexmarkentryoptions-bookmarkname-member)|If provided, specifies the bookmark name that marks the range of pages you want to appear in the index.| +||[crossReference](/.indexmarkentryoptions#word-javascript/api/word/-indexmarkentryoptions-crossreference-member)|If provided, specifies the cross-reference that will appear in the index.| +||[crossReferenceAutoText](/.indexmarkentryoptions#word-javascript/api/word/-indexmarkentryoptions-crossreferenceautotext-member)|If provided, specifies the name of the `AutoText` entry that contains the text for a cross-reference (if this property is specified, `crossReference` is ignored).| +||[entry](/.indexmarkentryoptions#word-javascript/api/word/-indexmarkentryoptions-entry-member)|If provided, specifies the text you want to appear in the index, in the form `MainEntry[:Subentry]`.| +||[entryAutoText](/.indexmarkentryoptions#word-javascript/api/word/-indexmarkentryoptions-entryautotext-member)|If provided, specifies the `AutoText` entry that contains the text you want to appear in the index (if this property is specified, `entry` is ignored).| +||[italic](/.indexmarkentryoptions#word-javascript/api/word/-indexmarkentryoptions-italic-member)|If provided, specifies whether to add italic formatting to page numbers for index entries.| +||[reading](/.indexmarkentryoptions#word-javascript/api/word/-indexmarkentryoptions-reading-member)|If provided, specifies whether to show an index entry in the right location when indexes are sorted phonetically (East Asian languages only).| +|[LineFormat](/.lineformat)|[backgroundColor](/.lineformat#word-javascript/api/word/-lineformat-backgroundcolor-member)|Gets a `ColorFormat` object that represents the background color for a patterned line.| +||[beginArrowheadLength](/.lineformat#word-javascript/api/word/-lineformat-beginarrowheadlength-member)|Specifies the length of the arrowhead at the beginning of the line.| +||[beginArrowheadStyle](/.lineformat#word-javascript/api/word/-lineformat-beginarrowheadstyle-member)|Specifies the style of the arrowhead at the beginning of the line.| +||[beginArrowheadWidth](/.lineformat#word-javascript/api/word/-lineformat-beginarrowheadwidth-member)|Specifies the width of the arrowhead at the beginning of the line.| +||[dashStyle](/.lineformat#word-javascript/api/word/-lineformat-dashstyle-member)|Specifies the dash style for the line.| +||[endArrowheadLength](/.lineformat#word-javascript/api/word/-lineformat-endarrowheadlength-member)|Specifies the length of the arrowhead at the end of the line.| +||[endArrowheadStyle](/.lineformat#word-javascript/api/word/-lineformat-endarrowheadstyle-member)|Specifies the style of the arrowhead at the end of the line.| +||[endArrowheadWidth](/.lineformat#word-javascript/api/word/-lineformat-endarrowheadwidth-member)|Specifies the width of the arrowhead at the end of the line.| +||[foregroundColor](/.lineformat#word-javascript/api/word/-lineformat-foregroundcolor-member)|Gets a `ColorFormat` object that represents the foreground color for the line.| +||[insetPen](/.lineformat#word-javascript/api/word/-lineformat-insetpen-member)|Specifies if to draw lines inside a shape.| +||[isVisible](/.lineformat#word-javascript/api/word/-lineformat-isvisible-member)|Specifies if the object, or the formatting applied to it, is visible.| +||[pattern](/.lineformat#word-javascript/api/word/-lineformat-pattern-member)|Specifies the pattern applied to the line.| +||[style](/.lineformat#word-javascript/api/word/-lineformat-style-member)|Specifies the line format style.| +||[transparency](/.lineformat#word-javascript/api/word/-lineformat-transparency-member)|Specifies the degree of transparency of the line as a value between 0.0 (opaque) and 1.0 (clear).| +||[weight](/.lineformat#word-javascript/api/word/-lineformat-weight-member)|Specifies the thickness of the line in points.| +|[LineNumbering](/.linenumbering)|[countBy](/.linenumbering#word-javascript/api/word/-linenumbering-countby-member)|Specifies the numeric increment for line numbers.| +||[distanceFromText](/.linenumbering#word-javascript/api/word/-linenumbering-distancefromtext-member)|Specifies the distance (in points) between the right edge of line numbers and the left edge of the document text.| +||[isActive](/.linenumbering#word-javascript/api/word/-linenumbering-isactive-member)|Specifies if line numbering is active for the specified document, section, or sections.| +||[restartMode](/.linenumbering#word-javascript/api/word/-linenumbering-restartmode-member)|Specifies the way line numbering runs; that is, whether it starts over at the beginning of a new page or section, or runs continuously.| +||[startingNumber](/.linenumbering#word-javascript/api/word/-linenumbering-startingnumber-member)|Specifies the starting line number.| +|[LinkFormat](/.linkformat)|[breakLink()](/.linkformat#word-javascript/api/word/-linkformat-breaklink-member(1))|Breaks the link between the source file and the OLE object, picture, or linked field.| +||[isAutoUpdated](/.linkformat#word-javascript/api/word/-linkformat-isautoupdated-member)|Specifies if the link is updated automatically when the container file is opened or when the source file is changed.| +||[isLocked](/.linkformat#word-javascript/api/word/-linkformat-islocked-member)|Specifies if a `Field`, `InlineShape`, or `Shape` object is locked to prevent automatic updating.| +||[isPictureSavedWithDocument](/.linkformat#word-javascript/api/word/-linkformat-ispicturesavedwithdocument-member)|Specifies if the linked picture is saved with the document.| +||[sourceFullName](/.linkformat#word-javascript/api/word/-linkformat-sourcefullname-member)|Specifies the path and name of the source file for the linked OLE object, picture, or field.| +||[sourceName](/.linkformat#word-javascript/api/word/-linkformat-sourcename-member)|Gets the name of the source file for the linked OLE object, picture, or field.| +||[sourcePath](/.linkformat#word-javascript/api/word/-linkformat-sourcepath-member)|Gets the path of the source file for the linked OLE object, picture, or field.| +||[type](/.linkformat#word-javascript/api/word/-linkformat-type-member)|Gets the link type.| +|[ListFormat](/.listformat)|[applyBulletDefault(defaultListBehavior: Word.DefaultListBehavior)](/.listformat#word-javascript/api/word/-listformat-applybulletdefault-member(1))|Adds bullets and formatting to the paragraphs in the range.| +||[applyListTemplateWithLevel(listTemplate: Word.ListTemplate, options?: Word.ListTemplateApplyOptions)](/.listformat#word-javascript/api/word/-listformat-applylisttemplatewithlevel-member(1))|Applies a list template with a specific level to the paragraphs in the range.| +||[applyNumberDefault(defaultListBehavior: Word.DefaultListBehavior)](/.listformat#word-javascript/api/word/-listformat-applynumberdefault-member(1))|Adds numbering and formatting to the paragraphs in the range.| +||[applyOutlineNumberDefault(defaultListBehavior: Word.DefaultListBehavior)](/.listformat#word-javascript/api/word/-listformat-applyoutlinenumberdefault-member(1))|Adds outline numbering and formatting to the paragraphs in the range.| +||[canContinuePreviousList(listTemplate: Word.ListTemplate)](/.listformat#word-javascript/api/word/-listformat-cancontinuepreviouslist-member(1))|Determines whether the `ListFormat` object can continue a previous list.| +||[convertNumbersToText(numberType: Word.NumberType)](/.listformat#word-javascript/api/word/-listformat-convertnumberstotext-member(1))|Converts numbers in the list to plain text.| +||[countNumberedItems(options?: Word.ListFormatCountNumberedItemsOptions)](/.listformat#word-javascript/api/word/-listformat-countnumbereditems-member(1))|Counts the numbered items in the list.| +||[isSingleList](/.listformat#word-javascript/api/word/-listformat-issinglelist-member)|Indicates whether the `ListFormat` object contains a single list.| +||[isSingleListTemplate](/.listformat#word-javascript/api/word/-listformat-issinglelisttemplate-member)|Indicates whether the `ListFormat` object contains a single list template.| +||[list](/.listformat#word-javascript/api/word/-listformat-list-member)|Returns a `List` object that represents the first formatted list contained in the `ListFormat` object.| +||[listIndent()](/.listformat#word-javascript/api/word/-listformat-listindent-member(1))|Indents the list by one level.| +||[listLevelNumber](/.listformat#word-javascript/api/word/-listformat-listlevelnumber-member)|Specifies the list level number for the first paragraph for the `ListFormat` object.| +||[listOutdent()](/.listformat#word-javascript/api/word/-listformat-listoutdent-member(1))|Outdents the list by one level.| +||[listString](/.listformat#word-javascript/api/word/-listformat-liststring-member)|Gets the string representation of the list value of the first paragraph in the range for the `ListFormat` object.| +||[listTemplate](/.listformat#word-javascript/api/word/-listformat-listtemplate-member)|Gets the list template associated with the `ListFormat` object.| +||[listType](/.listformat#word-javascript/api/word/-listformat-listtype-member)|Gets the type of the list for the `ListFormat` object.| +||[listValue](/.listformat#word-javascript/api/word/-listformat-listvalue-member)|Gets the numeric value of the the first paragraph in the range for the `ListFormat` object.| +||[removeNumbers(numberType: Word.NumberType)](/.listformat#word-javascript/api/word/-listformat-removenumbers-member(1))|Removes numbering from the list.| +|[ListFormatCountNumberedItemsOptions](/.listformatcountnumbereditemsoptions)|[level](/.listformatcountnumbereditemsoptions#word-javascript/api/word/-listformatcountnumbereditemsoptions-level-member)|If provided, specifies the level to count.| +||[numberType](/.listformatcountnumbereditemsoptions#word-javascript/api/word/-listformatcountnumbereditemsoptions-numbertype-member)|If provided, specifies the type of number to count.| +|[ListTemplateApplyOptions](/.listtemplateapplyoptions)|[applyLevel](/.listtemplateapplyoptions#word-javascript/api/word/-listtemplateapplyoptions-applylevel-member)|If provided, specifies the level to apply in the list template.| +||[applyTo](/.listtemplateapplyoptions#word-javascript/api/word/-listtemplateapplyoptions-applyto-member)|If provided, specifies which part of the list to apply the template to.| +||[continuePreviousList](/.listtemplateapplyoptions#word-javascript/api/word/-listtemplateapplyoptions-continuepreviouslist-member)|If provided, specifies whether to continue the previous list.| +||[defaultListBehavior](/.listtemplateapplyoptions#word-javascript/api/word/-listtemplateapplyoptions-defaultlistbehavior-member)|If provided, specifies the default list behavior.| +|[OleFormat](/.oleformat)|[activate()](/.oleformat#word-javascript/api/word/-oleformat-activate-member(1))|Activates the `OleFormat` object.| +||[activateAs(classType: string)](/.oleformat#word-javascript/api/word/-oleformat-activateas-member(1))|Sets the Windows registry value that determines the default application used to activate the specified OLE object.| +||[classType](/.oleformat#word-javascript/api/word/-oleformat-classtype-member)|Specifies the class type for the specified OLE object, picture, or field.| +||[doVerb(verbIndex: Word.OleVerb)](/.oleformat#word-javascript/api/word/-oleformat-doverb-member(1))|Requests that the OLE object perform one of its available verbs.| +||[edit()](/.oleformat#word-javascript/api/word/-oleformat-edit-member(1))|Opens the OLE object for editing in the application it was created in.| +||[iconIndex](/.oleformat#word-javascript/api/word/-oleformat-iconindex-member)|Specifies the icon that is used when the `displayAsIcon` property is `true`.| +||[iconLabel](/.oleformat#word-javascript/api/word/-oleformat-iconlabel-member)|Specifies the text displayed below the icon for the OLE object.| +||[iconName](/.oleformat#word-javascript/api/word/-oleformat-iconname-member)|Specifies the program file in which the icon for the OLE object is stored.| +||[iconPath](/.oleformat#word-javascript/api/word/-oleformat-iconpath-member)|Gets the path of the file in which the icon for the OLE object is stored.| +||[isDisplayedAsIcon](/.oleformat#word-javascript/api/word/-oleformat-isdisplayedasicon-member)|Gets whether the specified object is displayed as an icon.| +||[isFormattingPreservedOnUpdate](/.oleformat#word-javascript/api/word/-oleformat-isformattingpreservedonupdate-member)|Specifies whether formatting done in Microsoft Word to the linked OLE object is preserved.| +||[label](/.oleformat#word-javascript/api/word/-oleformat-label-member)|Gets a string that's used to identify the portion of the source file that's being linked.| +||[open()](/.oleformat#word-javascript/api/word/-oleformat-open-member(1))|Opens the `OleFormat` object.| +||[progID](/.oleformat#word-javascript/api/word/-oleformat-progid-member)|Gets the programmatic identifier (`ProgId`) for the specified OLE object.| +|[Page](/.page)|[breaks](/.page#word-javascript/api/word/-page-breaks-member)|Gets a `BreakCollection` object that represents the breaks on the page.| +|[PageSetup](/.pagesetup)|[bookFoldPrinting](/.pagesetup#word-javascript/api/word/-pagesetup-bookfoldprinting-member)|Specifies whether Microsoft Word prints the document as a booklet.| +||[bookFoldPrintingSheets](/.pagesetup#word-javascript/api/word/-pagesetup-bookfoldprintingsheets-member)|Specifies the number of pages for each booklet.| +||[bookFoldReversePrinting](/.pagesetup#word-javascript/api/word/-pagesetup-bookfoldreverseprinting-member)|Specifies if Microsoft Word reverses the printing order for book fold printing of bidirectional or Asian language documents.| +||[bottomMargin](/.pagesetup#word-javascript/api/word/-pagesetup-bottommargin-member)|Specifies the distance (in points) between the bottom edge of the page and the bottom boundary of the body text.| +||[charsLine](/.pagesetup#word-javascript/api/word/-pagesetup-charsline-member)|Specifies the number of characters per line in the document grid.| +||[differentFirstPageHeaderFooter](/.pagesetup#word-javascript/api/word/-pagesetup-differentfirstpageheaderfooter-member)|Specifies whether the first page has a different header and footer.| +||[footerDistance](/.pagesetup#word-javascript/api/word/-pagesetup-footerdistance-member)|Specifies the distance between the footer and the bottom of the page in points.| +||[gutter](/.pagesetup#word-javascript/api/word/-pagesetup-gutter-member)|Specifies the amount (in points) of extra margin space added to each page in a document or section for binding.| +||[gutterPosition](/.pagesetup#word-javascript/api/word/-pagesetup-gutterposition-member)|Specifies on which side the gutter appears in a document.| +||[gutterStyle](/.pagesetup#word-javascript/api/word/-pagesetup-gutterstyle-member)|Specifies whether Microsoft Word uses gutters for the current document based on a right-to-left language or a left-to-right language.| +||[headerDistance](/.pagesetup#word-javascript/api/word/-pagesetup-headerdistance-member)|Specifies the distance between the header and the top of the page in points.| +||[layoutMode](/.pagesetup#word-javascript/api/word/-pagesetup-layoutmode-member)|Specifies the layout mode for the current document.| +||[leftMargin](/.pagesetup#word-javascript/api/word/-pagesetup-leftmargin-member)|Specifies the distance (in points) between the left edge of the page and the left boundary of the body text.| +||[lineNumbering](/.pagesetup#word-javascript/api/word/-pagesetup-linenumbering-member)|Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object.| +||[linesPage](/.pagesetup#word-javascript/api/word/-pagesetup-linespage-member)|Specifies the number of lines per page in the document grid.| +||[mirrorMargins](/.pagesetup#word-javascript/api/word/-pagesetup-mirrormargins-member)|Specifies if the inside and outside margins of facing pages are the same width.| +||[oddAndEvenPagesHeaderFooter](/.pagesetup#word-javascript/api/word/-pagesetup-oddandevenpagesheaderfooter-member)|Specifies whether odd and even pages have different headers and footers.| +||[orientation](/.pagesetup#word-javascript/api/word/-pagesetup-orientation-member)|Specifies the orientation of the page.| +||[pageHeight](/.pagesetup#word-javascript/api/word/-pagesetup-pageheight-member)|Specifies the page height in points.| +||[pageWidth](/.pagesetup#word-javascript/api/word/-pagesetup-pagewidth-member)|Specifies the page width in points.| +||[paperSize](/.pagesetup#word-javascript/api/word/-pagesetup-papersize-member)|Specifies the paper size of the page.| +||[rightMargin](/.pagesetup#word-javascript/api/word/-pagesetup-rightmargin-member)|Specifies the distance (in points) between the right edge of the page and the right boundary of the body text.| +||[sectionDirection](/.pagesetup#word-javascript/api/word/-pagesetup-sectiondirection-member)|Specifies the reading order and alignment for the specified sections.| +||[sectionStart](/.pagesetup#word-javascript/api/word/-pagesetup-sectionstart-member)|Specifies the type of section break for the specified object.| +||[setAsTemplateDefault()](/.pagesetup#word-javascript/api/word/-pagesetup-setastemplatedefault-member(1))|Sets the specified page setup formatting as the default for the active document and all new documents based on the active template.| +||[showGrid](/.pagesetup#word-javascript/api/word/-pagesetup-showgrid-member)|Specifies whether to show the grid.| +||[suppressEndnotes](/.pagesetup#word-javascript/api/word/-pagesetup-suppressendnotes-member)|Specifies if endnotes are printed at the end of the next section that doesn't suppress endnotes.| +||[textColumns](/.pagesetup#word-javascript/api/word/-pagesetup-textcolumns-member)|Gets a `TextColumnCollection` object that represents the set of text columns for the `PageSetup` object.| +||[togglePortrait()](/.pagesetup#word-javascript/api/word/-pagesetup-toggleportrait-member(1))|Switches between portrait and landscape page orientations for a document or section.| +||[topMargin](/.pagesetup#word-javascript/api/word/-pagesetup-topmargin-member)|Specifies the top margin of the page in points.| +||[twoPagesOnOne](/.pagesetup#word-javascript/api/word/-pagesetup-twopagesonone-member)|Specifies whether to print two pages per sheet.| +||[verticalAlignment](/.pagesetup#word-javascript/api/word/-pagesetup-verticalalignment-member)|Specifies the vertical alignment of text on each page in a document or section.| +|[Paragraph](/.paragraph)|[borders](/.paragraph#word-javascript/api/word/-paragraph-borders-member)|Returns a `BorderUniversalCollection` object that represents all the borders for the paragraph.| +||[closeUp()](/.paragraph#word-javascript/api/word/-paragraph-closeup-member(1))|Removes any spacing before the paragraph.| +||[indent()](/.paragraph#word-javascript/api/word/-paragraph-indent-member(1))|Indents the paragraph by one level.| +||[indentCharacterWidth(count: number)](/.paragraph#word-javascript/api/word/-paragraph-indentcharacterwidth-member(1))|Indents the paragraph by a specified number of characters.| +||[indentFirstLineCharacterWidth(count: number)](/.paragraph#word-javascript/api/word/-paragraph-indentfirstlinecharacterwidth-member(1))|Indents the first line of the paragraph by the specified number of characters.| +||[joinList()](/.paragraph#word-javascript/api/word/-paragraph-joinlist-member(1))|Joins a list paragraph with the closest list above or below this paragraph.| +||[next(count: number)](/.paragraph#word-javascript/api/word/-paragraph-next-member(1))|Returns a `Paragraph` object that represents the next paragraph.| +||[onCommentAdded](/.paragraph#word-javascript/api/word/-paragraph-oncommentadded-member)|Occurs when new comments are added.| +||[onCommentChanged](/.paragraph#word-javascript/api/word/-paragraph-oncommentchanged-member)|Occurs when a comment or its reply is changed.| +||[onCommentDeleted](/.paragraph#word-javascript/api/word/-paragraph-oncommentdeleted-member)|Occurs when comments are deleted.| +||[onCommentDeselected](/.paragraph#word-javascript/api/word/-paragraph-oncommentdeselected-member)|Occurs when a comment is deselected.| +||[onCommentSelected](/.paragraph#word-javascript/api/word/-paragraph-oncommentselected-member)|Occurs when a comment is selected.| +||[openOrCloseUp()](/.paragraph#word-javascript/api/word/-paragraph-openorcloseup-member(1))|Toggles the spacing before the paragraph.| +||[openUp()](/.paragraph#word-javascript/api/word/-paragraph-openup-member(1))|Sets spacing before the paragraph to 12 points.| +||[outdent()](/.paragraph#word-javascript/api/word/-paragraph-outdent-member(1))|Removes one level of indent for the paragraph.| +||[outlineDemote()](/.paragraph#word-javascript/api/word/-paragraph-outlinedemote-member(1))|Applies the next heading level style (Heading 1 through Heading 8) to the paragraph.| +||[outlineDemoteToBody()](/.paragraph#word-javascript/api/word/-paragraph-outlinedemotetobody-member(1))|Demotes the paragraph to body text by applying the Normal style.| +||[outlinePromote()](/.paragraph#word-javascript/api/word/-paragraph-outlinepromote-member(1))|Applies the previous heading level style (Heading 1 through Heading 8) to the paragraph.| +||[previous(count: number)](/.paragraph#word-javascript/api/word/-paragraph-previous-member(1))|Returns the previous paragraph as a `Paragraph` object.| +||[range](/.paragraph#word-javascript/api/word/-paragraph-range-member)|Gets a `Range` object that represents the portion of the document that's contained within the paragraph.| +||[reset()](/.paragraph#word-javascript/api/word/-paragraph-reset-member(1))|Removes manual paragraph formatting (formatting not applied using a style).| +||[resetAdvanceTo()](/.paragraph#word-javascript/api/word/-paragraph-resetadvanceto-member(1))|Resets the paragraph that uses custom list levels to the original level settings.| +||[selectNumber()](/.paragraph#word-javascript/api/word/-paragraph-selectnumber-member(1))|Selects the number or bullet in a list.| +||[separateList()](/.paragraph#word-javascript/api/word/-paragraph-separatelist-member(1))|Separates a list into two separate lists.| +||[shading](/.paragraph#word-javascript/api/word/-paragraph-shading-member)|Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph.| +||[space1()](/.paragraph#word-javascript/api/word/-paragraph-space1-member(1))|Sets the paragraph to single spacing.| +||[space1Pt5()](/.paragraph#word-javascript/api/word/-paragraph-space1pt5-member(1))|Sets the paragraph to 1.5-line spacing.| +||[space2()](/.paragraph#word-javascript/api/word/-paragraph-space2-member(1))|Sets the paragraph to double spacing.| +||[tabHangingIndent(count: number)](/.paragraph#word-javascript/api/word/-paragraph-tabhangingindent-member(1))|Sets a hanging indent to a specified number of tab stops.| +||[tabIndent(count: number)](/.paragraph#word-javascript/api/word/-paragraph-tabindent-member(1))|Sets the left indent for the paragraph to a specified number of tab stops.| +|[ParagraphAddedEventArgs](/.paragraphaddedeventargs)|[type](/.paragraphaddedeventargs#word-javascript/api/word/-paragraphaddedeventargs-type-member)|The event type.| +|[ParagraphChangedEventArgs](/.paragraphchangedeventargs)|[type](/.paragraphchangedeventargs#word-javascript/api/word/-paragraphchangedeventargs-type-member)|The event type.| +|[ParagraphCollection](/.paragraphcollection)|[add(range: Word.Range)](/.paragraphcollection#word-javascript/api/word/-paragraphcollection-add-member(1))|Returns a `Paragraph` object that represents a new, blank paragraph added to the document.| +||[closeUp()](/.paragraphcollection#word-javascript/api/word/-paragraphcollection-closeup-member(1))|Removes any spacing before the specified paragraphs.| +||[decreaseSpacing()](/.paragraphcollection#word-javascript/api/word/-paragraphcollection-decreasespacing-member(1))|Decreases the spacing before and after paragraphs in six-point increments.| +||[increaseSpacing()](/.paragraphcollection#word-javascript/api/word/-paragraphcollection-increasespacing-member(1))|Increases the spacing before and after paragraphs in six-point increments.| +||[indent()](/.paragraphcollection#word-javascript/api/word/-paragraphcollection-indent-member(1))|Indents the paragraphs by one level.| +||[indentCharacterWidth(count: number)](/.paragraphcollection#word-javascript/api/word/-paragraphcollection-indentcharacterwidth-member(1))|Indents the paragraphs in the collection by the specified number of characters.| +||[indentFirstLineCharacterWidth(count: number)](/.paragraphcollection#word-javascript/api/word/-paragraphcollection-indentfirstlinecharacterwidth-member(1))|Indents the first line of the paragraphs in the collection by the specified number of characters.| +||[openOrCloseUp()](/.paragraphcollection#word-javascript/api/word/-paragraphcollection-openorcloseup-member(1))|Toggles spacing before paragraphs.| +||[openUp()](/.paragraphcollection#word-javascript/api/word/-paragraphcollection-openup-member(1))|Sets spacing before the specified paragraphs to 12 points.| +||[outdent()](/.paragraphcollection#word-javascript/api/word/-paragraphcollection-outdent-member(1))|Removes one level of indent for the paragraphs.| +||[outlineDemote()](/.paragraphcollection#word-javascript/api/word/-paragraphcollection-outlinedemote-member(1))|Applies the next heading level style (Heading 1 through Heading 8) to the specified paragraphs.| +||[outlineDemoteToBody()](/.paragraphcollection#word-javascript/api/word/-paragraphcollection-outlinedemotetobody-member(1))|Demotes the specified paragraphs to body text by applying the Normal style.| +||[outlinePromote()](/.paragraphcollection#word-javascript/api/word/-paragraphcollection-outlinepromote-member(1))|Applies the previous heading level style (Heading 1 through Heading 8) to the paragraphs in the collection.| +||[space1()](/.paragraphcollection#word-javascript/api/word/-paragraphcollection-space1-member(1))|Sets the specified paragraphs to single spacing.| +||[space1Pt5()](/.paragraphcollection#word-javascript/api/word/-paragraphcollection-space1pt5-member(1))|Sets the specified paragraphs to 1.5-line spacing.| +||[space2()](/.paragraphcollection#word-javascript/api/word/-paragraphcollection-space2-member(1))|Sets the specified paragraphs to double spacing.| +||[tabHangingIndent(count: number)](/.paragraphcollection#word-javascript/api/word/-paragraphcollection-tabhangingindent-member(1))|Sets a hanging indent to the specified number of tab stops.| +||[tabIndent(count: number)](/.paragraphcollection#word-javascript/api/word/-paragraphcollection-tabindent-member(1))|Sets the left indent for the specified paragraphs to the specified number of tab stops.| +|[ParagraphDeletedEventArgs](/.paragraphdeletedeventargs)|[type](/.paragraphdeletedeventargs#word-javascript/api/word/-paragraphdeletedeventargs-type-member)|The event type.| +|[PictureContentControl](/.picturecontentcontrol)|[appearance](/.picturecontentcontrol#word-javascript/api/word/-picturecontentcontrol-appearance-member)|Specifies the appearance of the content control.| +||[color](/.picturecontentcontrol#word-javascript/api/word/-picturecontentcontrol-color-member)|Specifies the red-green-blue (RGB) value of the color of the content control.| +||[copy()](/.picturecontentcontrol#word-javascript/api/word/-picturecontentcontrol-copy-member(1))|Copies the content control from the active document to the Clipboard.| +||[cut()](/.picturecontentcontrol#word-javascript/api/word/-picturecontentcontrol-cut-member(1))|Removes the content control from the active document and moves the content control to the Clipboard.| +||[delete(deleteContents?: boolean)](/.picturecontentcontrol#word-javascript/api/word/-picturecontentcontrol-delete-member(1))|Deletes the content control and optionally its contents.| +||[id](/.picturecontentcontrol#word-javascript/api/word/-picturecontentcontrol-id-member)|Returns the identification for the content control.| +||[isTemporary](/.picturecontentcontrol#word-javascript/api/word/-picturecontentcontrol-istemporary-member)|Specifies whether to remove the content control from the active document when the user edits the contents of the control.| +||[level](/.picturecontentcontrol#word-javascript/api/word/-picturecontentcontrol-level-member)|Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline.| +||[lockContentControl](/.picturecontentcontrol#word-javascript/api/word/-picturecontentcontrol-lockcontentcontrol-member)|Specifies if the content control is locked (can't be deleted).| +||[lockContents](/.picturecontentcontrol#word-javascript/api/word/-picturecontentcontrol-lockcontents-member)|Specifies if the contents of the content control are locked (not editable).| +||[placeholderText](/.picturecontentcontrol#word-javascript/api/word/-picturecontentcontrol-placeholdertext-member)|Returns a `BuildingBlock` object that represents the placeholder text for the content control.| +||[range](/.picturecontentcontrol#word-javascript/api/word/-picturecontentcontrol-range-member)|Returns a `Range` object that represents the contents of the content control in the active document.| +||[setPlaceholderText(options?: Word.ContentControlPlaceholderOptions)](/.picturecontentcontrol#word-javascript/api/word/-picturecontentcontrol-setplaceholdertext-member(1))|Sets the placeholder text that displays in the content control until a user enters their own text.| +||[showingPlaceholderText](/.picturecontentcontrol#word-javascript/api/word/-picturecontentcontrol-showingplaceholdertext-member)|Returns whether the placeholder text for the content control is being displayed.| +||[tag](/.picturecontentcontrol#word-javascript/api/word/-picturecontentcontrol-tag-member)|Specifies a tag to identify the content control.| +||[title](/.picturecontentcontrol#word-javascript/api/word/-picturecontentcontrol-title-member)|Specifies the title for the content control.| +||[xmlMapping](/.picturecontentcontrol#word-javascript/api/word/-picturecontentcontrol-xmlmapping-member)|Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document.| +|[Range](/.range)|[bold](/.range#word-javascript/api/word/-range-bold-member)|Specifies whether the range is formatted as bold.| +||[boldBidirectional](/.range#word-javascript/api/word/-range-boldbidirectional-member)|Specifies whether the range is formatted as bold in a right-to-left language document.| +||[bookmarks](/.range#word-javascript/api/word/-range-bookmarks-member)|Returns a `BookmarkCollection` object that represents all the bookmarks in the range.| +||[borders](/.range#word-javascript/api/word/-range-borders-member)|Returns a `BorderUniversalCollection` object that represents all the borders for the range.| +||[case](/.range#word-javascript/api/word/-range-case-member)|Specifies a `CharacterCase` value that represents the case of the text in the range.| +||[characterWidth](/.range#word-javascript/api/word/-range-characterwidth-member)|Specifies the character width of the range.| +||[combineCharacters](/.range#word-javascript/api/word/-range-combinecharacters-member)|Specifies if the range contains combined characters.| +||[detectLanguage()](/.range#word-javascript/api/word/-range-detectlanguage-member(1))|Analyzes the range text to determine the language that it's written in.| +||[disableCharacterSpaceGrid](/.range#word-javascript/api/word/-range-disablecharacterspacegrid-member)|Specifies if Microsoft Word ignores the number of characters per line for the corresponding `Range` object.| +||[emphasisMark](/.range#word-javascript/api/word/-range-emphasismark-member)|Specifies the emphasis mark for a character or designated character string.| +||[end](/.range#word-javascript/api/word/-range-end-member)|Specifies the ending character position of the range.| +||[fitTextWidth](/.range#word-javascript/api/word/-range-fittextwidth-member)|Specifies the width (in the current measurement units) in which Microsoft Word fits the text in the current selection or range.| +||[frames](/.range#word-javascript/api/word/-range-frames-member)|Gets a `FrameCollection` object that represents all the frames in the range.| +||[grammarChecked](/.range#word-javascript/api/word/-range-grammarchecked-member)|Specifies if a grammar check has been run on the range or document.| +||[hasNoProofing](/.range#word-javascript/api/word/-range-hasnoproofing-member)|Specifies the proofing status (spelling and grammar checking) of the range.| +||[highlightColorIndex](/.range#word-javascript/api/word/-range-highlightcolorindex-member)|Specifies the highlight color for the range.| +||[horizontalInVertical](/.range#word-javascript/api/word/-range-horizontalinvertical-member)|Specifies the formatting for horizontal text set within vertical text.| +||[hyperlinks](/.range#word-javascript/api/word/-range-hyperlinks-member)|Returns a `HyperlinkCollection` object that represents all the hyperlinks in the range.| +||[id](/.range#word-javascript/api/word/-range-id-member)|Specifies the ID for the range.| +||[isEndOfRowMark](/.range#word-javascript/api/word/-range-isendofrowmark-member)|Gets if the range is collapsed and is located at the end-of-row mark in a table.| +||[isTextVisibleOnScreen](/.range#word-javascript/api/word/-range-istextvisibleonscreen-member)|Gets whether the text in the range is visible on the screen.| +||[italic](/.range#word-javascript/api/word/-range-italic-member)|Specifies if the font or range is formatted as italic.| +||[italicBidirectional](/.range#word-javascript/api/word/-range-italicbidirectional-member)|Specifies if the font or range is formatted as italic (right-to-left languages).| +||[kana](/.range#word-javascript/api/word/-range-kana-member)|Specifies whether the range of Japanese language text is hiragana or katakana.| +||[languageDetected](/.range#word-javascript/api/word/-range-languagedetected-member)|Specifies whether Microsoft Word has detected the language of the text in the range.| +||[languageId](/.range#word-javascript/api/word/-range-languageid-member)|Specifies a `LanguageId` value that represents the language for the range.| +||[languageIdFarEast](/.range#word-javascript/api/word/-range-languageidfareast-member)|Specifies an East Asian language for the range.| +||[languageIdOther](/.range#word-javascript/api/word/-range-languageidother-member)|Specifies a language for the range that isn't classified as an East Asian language.| +||[listFormat](/.range#word-javascript/api/word/-range-listformat-member)|Returns a `ListFormat` object that represents all the list formatting characteristics of the range.| +||[onCommentAdded](/.range#word-javascript/api/word/-range-oncommentadded-member)|Occurs when new comments are added.| +||[onCommentChanged](/.range#word-javascript/api/word/-range-oncommentchanged-member)|Occurs when a comment or its reply is changed.| +||[onCommentDeselected](/.range#word-javascript/api/word/-range-oncommentdeselected-member)|Occurs when a comment is deselected.| +||[onCommentSelected](/.range#word-javascript/api/word/-range-oncommentselected-member)|Occurs when a comment is selected.| +||[sections](/.range#word-javascript/api/word/-range-sections-member)|Gets the collection of sections in the range.| +||[shading](/.range#word-javascript/api/word/-range-shading-member)|Returns a `ShadingUniversal` object that refers to the shading formatting for the range.| +||[showAll](/.range#word-javascript/api/word/-range-showall-member)|Specifies if all nonprinting characters (such as hidden text, tab marks, space marks, and paragraph marks) are displayed.| +||[spellingChecked](/.range#word-javascript/api/word/-range-spellingchecked-member)|Specifies if spelling has been checked throughout the range or document.| +||[start](/.range#word-javascript/api/word/-range-start-member)|Specifies the starting character position of the range.| +||[storyLength](/.range#word-javascript/api/word/-range-storylength-member)|Gets the number of characters in the story that contains the range.| +||[storyType](/.range#word-javascript/api/word/-range-storytype-member)|Gets the story type for the range.| +||[tableColumns](/.range#word-javascript/api/word/-range-tablecolumns-member)|Gets a `TableColumnCollection` object that represents all the table columns in the range.| +||[twoLinesInOne](/.range#word-javascript/api/word/-range-twolinesinone-member)|Specifies whether Microsoft Word sets two lines of text in one and specifies the characters that enclose the text, if any.| +||[underline](/.range#word-javascript/api/word/-range-underline-member)|Specifies the type of underline applied to the range.| +|[ReflectionFormat](/.reflectionformat)|[blur](/.reflectionformat#word-javascript/api/word/-reflectionformat-blur-member)|Specifies the degree of blur effect applied to the `ReflectionFormat` object as a value between 0.0 and 100.0.| +||[offset](/.reflectionformat#word-javascript/api/word/-reflectionformat-offset-member)|Specifies the amount of separation, in points, of the reflected image from the shape.| +||[size](/.reflectionformat#word-javascript/api/word/-reflectionformat-size-member)|Specifies the size of the reflection as a percentage of the reflected shape from 0 to 100.| +||[transparency](/.reflectionformat#word-javascript/api/word/-reflectionformat-transparency-member)|Specifies the degree of transparency for the reflection effect as a value between 0.0 (opaque) and 1.0 (clear).| +||[type](/.reflectionformat#word-javascript/api/word/-reflectionformat-type-member)|Specifies a `ReflectionType` value that represents the type and direction of the lighting for a shape reflection.| +|[RepeatingSectionContentControl](/.repeatingsectioncontentcontrol)|[allowInsertDeleteSection](/.repeatingsectioncontentcontrol#word-javascript/api/word/-repeatingsectioncontentcontrol-allowinsertdeletesection-member)|Specifies whether users can add or remove sections from this repeating section content control by using the user interface.| +||[appearance](/.repeatingsectioncontentcontrol#word-javascript/api/word/-repeatingsectioncontentcontrol-appearance-member)|Specifies the appearance of the content control.| +||[color](/.repeatingsectioncontentcontrol#word-javascript/api/word/-repeatingsectioncontentcontrol-color-member)|Specifies the red-green-blue (RGB) value of the color of the content control.| +||[copy()](/.repeatingsectioncontentcontrol#word-javascript/api/word/-repeatingsectioncontentcontrol-copy-member(1))|Copies the content control from the active document to the Clipboard.| +||[cut()](/.repeatingsectioncontentcontrol#word-javascript/api/word/-repeatingsectioncontentcontrol-cut-member(1))|Removes the content control from the active document and moves the content control to the Clipboard.| +||[delete(deleteContents?: boolean)](/.repeatingsectioncontentcontrol#word-javascript/api/word/-repeatingsectioncontentcontrol-delete-member(1))|Deletes the content control and the contents of the content control.| +||[id](/.repeatingsectioncontentcontrol#word-javascript/api/word/-repeatingsectioncontentcontrol-id-member)|Returns the identification for the content control.| +||[isTemporary](/.repeatingsectioncontentcontrol#word-javascript/api/word/-repeatingsectioncontentcontrol-istemporary-member)|Specifies whether to remove the content control from the active document when the user edits the contents of the control.| +||[level](/.repeatingsectioncontentcontrol#word-javascript/api/word/-repeatingsectioncontentcontrol-level-member)|Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline.| +||[lockContentControl](/.repeatingsectioncontentcontrol#word-javascript/api/word/-repeatingsectioncontentcontrol-lockcontentcontrol-member)|Specifies if the content control is locked (can't be deleted).| +||[lockContents](/.repeatingsectioncontentcontrol#word-javascript/api/word/-repeatingsectioncontentcontrol-lockcontents-member)|Specifies if the contents of the content control are locked (not editable).| +||[placeholderText](/.repeatingsectioncontentcontrol#word-javascript/api/word/-repeatingsectioncontentcontrol-placeholdertext-member)|Returns a `BuildingBlock` object that represents the placeholder text for the content control.| +||[range](/.repeatingsectioncontentcontrol#word-javascript/api/word/-repeatingsectioncontentcontrol-range-member)|Gets a `Range` object that represents the contents of the content control in the active document.| +||[repeatingSectionItemTitle](/.repeatingsectioncontentcontrol#word-javascript/api/word/-repeatingsectioncontentcontrol-repeatingsectionitemtitle-member)|Specifies the name of the repeating section items used in the context menu associated with this repeating section content control.| +||[repeatingSectionItems](/.repeatingsectioncontentcontrol#word-javascript/api/word/-repeatingsectioncontentcontrol-repeatingsectionitems-member)|Returns the collection of repeating section items in this repeating section content control.| +||[setPlaceholderText(options?: Word.ContentControlPlaceholderOptions)](/.repeatingsectioncontentcontrol#word-javascript/api/word/-repeatingsectioncontentcontrol-setplaceholdertext-member(1))|Sets the placeholder text that displays in the content control until a user enters their own text.| +||[showingPlaceholderText](/.repeatingsectioncontentcontrol#word-javascript/api/word/-repeatingsectioncontentcontrol-showingplaceholdertext-member)|Returns whether the placeholder text for the content control is being displayed.| +||[tag](/.repeatingsectioncontentcontrol#word-javascript/api/word/-repeatingsectioncontentcontrol-tag-member)|Specifies a tag to identify the content control.| +||[title](/.repeatingsectioncontentcontrol#word-javascript/api/word/-repeatingsectioncontentcontrol-title-member)|Specifies the title for the content control.| +||[xmlapping](/.repeatingsectioncontentcontrol#word-javascript/api/word/-repeatingsectioncontentcontrol-xmlapping-member)|Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document.| +|[RepeatingSectionItem](/.repeatingsectionitem)|[delete()](/.repeatingsectionitem#word-javascript/api/word/-repeatingsectionitem-delete-member(1))|Deletes this `RepeatingSectionItem` object.| +||[insertItemAfter()](/.repeatingsectionitem#word-javascript/api/word/-repeatingsectionitem-insertitemafter-member(1))|Adds a repeating section item after this item and returns the new item.| +||[insertItemBefore()](/.repeatingsectionitem#word-javascript/api/word/-repeatingsectionitem-insertitembefore-member(1))|Adds a repeating section item before this item and returns the new item.| +||[range](/.repeatingsectionitem#word-javascript/api/word/-repeatingsectionitem-range-member)|Returns the range of this repeating section item, excluding the start and end tags.| +|[RepeatingSectionItemCollection](/.repeatingsectionitemcollection)|[getItemAt(index: number)](/.repeatingsectionitemcollection#word-javascript/api/word/-repeatingsectionitemcollection-getitemat-member(1))|Returns an individual repeating section item.| +|[Reviewer](/.reviewer)|[isVisible](/.reviewer#word-javascript/api/word/-reviewer-isvisible-member)|Specifies if the `Reviewer` object is visible.| +|[ReviewerCollection](/.reviewercollection)|[getItem(index: number)](/.reviewercollection#word-javascript/api/word/-reviewercollection-getitem-member(1))|Returns a `Reviewer` object that represents the specified item in the collection.| +||[items](/.reviewercollection#word-javascript/api/word/-reviewercollection-items-member)|Gets the loaded child items in this collection.| +|[RevisionsFilter](/.revisionsfilter)|[markup](/.revisionsfilter#word-javascript/api/word/-revisionsfilter-markup-member)|Specifies a `RevisionsMarkup` value that represents the extent of reviewer markup displayed in the document.| +||[reviewers](/.revisionsfilter#word-javascript/api/word/-revisionsfilter-reviewers-member)|Gets the `ReviewerCollection` object that represents the collection of reviewers of one or more documents.| +||[toggleShowAllReviewers()](/.revisionsfilter#word-javascript/api/word/-revisionsfilter-toggleshowallreviewers-member(1))|Shows or hides all revisions in the document that contain comments and tracked changes.| +||[view](/.revisionsfilter#word-javascript/api/word/-revisionsfilter-view-member)|Specifies a `RevisionsView` value that represents globally whether Word displays the original version of the document or the final version, which might have revisions and formatting changes applied.| +|[Section](/.section)|[borders](/.section#word-javascript/api/word/-section-borders-member)|Returns a `BorderUniversalCollection` object that represents all the borders in the section.| +||[pageSetup](/.section#word-javascript/api/word/-section-pagesetup-member)|Returns a `PageSetup` object that's associated with the section.| +||[protectedForForms](/.section#word-javascript/api/word/-section-protectedforforms-member)|Specifies if the section is protected for forms.| +|[ShadingUniversal](/.shadinguniversal)|[backgroundPatternColor](/.shadinguniversal#word-javascript/api/word/-shadinguniversal-backgroundpatterncolor-member)|Specifies the color that's applied to the background of the `ShadingUniversal` object.| +||[backgroundPatternColorIndex](/.shadinguniversal#word-javascript/api/word/-shadinguniversal-backgroundpatterncolorindex-member)|Specifies the color that's applied to the background of the `ShadingUniversal` object.| +||[foregroundPatternColor](/.shadinguniversal#word-javascript/api/word/-shadinguniversal-foregroundpatterncolor-member)|Specifies the color that's applied to the foreground of the `ShadingUniversal` object.| +||[foregroundPatternColorIndex](/.shadinguniversal#word-javascript/api/word/-shadinguniversal-foregroundpatterncolorindex-member)|Specifies the color that's applied to the foreground of the `ShadingUniversal` object.| +||[texture](/.shadinguniversal#word-javascript/api/word/-shadinguniversal-texture-member)|Specifies the shading texture of the object.| +|[ShadowFormat](/.shadowformat)|[blur](/.shadowformat#word-javascript/api/word/-shadowformat-blur-member)|Specifies the blur level for a shadow format as a value between 0.0 and 100.0.| +||[foregroundColor](/.shadowformat#word-javascript/api/word/-shadowformat-foregroundcolor-member)|Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow.| +||[incrementOffsetX(increment: number)](/.shadowformat#word-javascript/api/word/-shadowformat-incrementoffsetx-member(1))|Changes the horizontal offset of the shadow by the number of points.| +||[incrementOffsetY(increment: number)](/.shadowformat#word-javascript/api/word/-shadowformat-incrementoffsety-member(1))|Changes the vertical offset of the shadow by the specified number of points.| +||[isVisible](/.shadowformat#word-javascript/api/word/-shadowformat-isvisible-member)|Specifies whether the object or the formatting applied to it is visible.| +||[obscured](/.shadowformat#word-javascript/api/word/-shadowformat-obscured-member)|Specifies `true` if the shadow of the shape appears filled in and is obscured by the shape, even if the shape has no fill,| +||[offsetX](/.shadowformat#word-javascript/api/word/-shadowformat-offsetx-member)|Specifies the horizontal offset (in points) of the shadow from the shape.| +||[offsetY](/.shadowformat#word-javascript/api/word/-shadowformat-offsety-member)|Specifies the vertical offset (in points) of the shadow from the shape.| +||[rotateWithShape](/.shadowformat#word-javascript/api/word/-shadowformat-rotatewithshape-member)|Specifies whether to rotate the shadow when rotating the shape.| +||[size](/.shadowformat#word-javascript/api/word/-shadowformat-size-member)|Specifies the width of the shadow.| +||[style](/.shadowformat#word-javascript/api/word/-shadowformat-style-member)|Specifies the type of shadow formatting to apply to a shape.| +||[transparency](/.shadowformat#word-javascript/api/word/-shadowformat-transparency-member)|Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear).| +||[type](/.shadowformat#word-javascript/api/word/-shadowformat-type-member)|Specifies the shape shadow type.| +|[Source](/.source)|[delete()](/.source#word-javascript/api/word/-source-delete-member(1))|Deletes the `Source` object.| +||[getFieldByName(name: string)](/.source#word-javascript/api/word/-source-getfieldbyname-member(1))|Returns the value of a field in the bibliography `Source` object.| +||[isCited](/.source#word-javascript/api/word/-source-iscited-member)|Gets if the `Source` object has been cited in the document.| +||[tag](/.source#word-javascript/api/word/-source-tag-member)|Gets the tag of the source.| +||[xml](/.source#word-javascript/api/word/-source-xml-member)|Gets the XML representation of the source.| +|[SourceCollection](/.sourcecollection)|[add(xml: string)](/.sourcecollection#word-javascript/api/word/-sourcecollection-add-member(1))|Adds a new `Source` object to the collection.| +||[getItem(index: number)](/.sourcecollection#word-javascript/api/word/-sourcecollection-getitem-member(1))|Gets a `Source` by its index in the collection.| +||[items](/.sourcecollection#word-javascript/api/word/-sourcecollection-items-member)|Gets the loaded child items in this collection.| +|[Style](/.style)|[automaticallyUpdate](/.style#word-javascript/api/word/-style-automaticallyupdate-member)|Specifies whether the style is automatically redefined based on the selection.| +||[description](/.style#word-javascript/api/word/-style-description-member)|Gets the description of the specified style.| +||[frame](/.style#word-javascript/api/word/-style-frame-member)|Returns a `Frame` object that represents the frame formatting for the style.| +||[hasProofing](/.style#word-javascript/api/word/-style-hasproofing-member)|Specifies whether the spelling and grammar checker ignores text formatted with this style.| +||[languageId](/.style#word-javascript/api/word/-style-languageid-member)|Specifies a `LanguageId` value that represents the language for the style.| +||[languageIdFarEast](/.style#word-javascript/api/word/-style-languageidfareast-member)|Specifies an East Asian language for the style.| +||[linkStyle](/.style#word-javascript/api/word/-style-linkstyle-member)|Specifies a link between a paragraph and a character style.| +||[linkToListTemplate(listTemplate: Word.ListTemplate)](/.style#word-javascript/api/word/-style-linktolisttemplate-member(1))|Links this style to a list template so that the style's formatting can be applied to lists.| +||[listLevelNumber](/.style#word-javascript/api/word/-style-listlevelnumber-member)|Returns the list level for the style.| +||[locked](/.style#word-javascript/api/word/-style-locked-member)|Specifies whether the style cannot be changed or edited.| +||[noSpaceBetweenParagraphsOfSameStyle](/.style#word-javascript/api/word/-style-nospacebetweenparagraphsofsamestyle-member)|Specifies whether to remove spacing between paragraphs that are formatted using the same style.| +|[TabStop](/.tabstop)|[alignment](/.tabstop#word-javascript/api/word/-tabstop-alignment-member)|Gets a `TabAlignment` value that represents the alignment for the tab stop.| +||[clear()](/.tabstop#word-javascript/api/word/-tabstop-clear-member(1))|Removes this custom tab stop.| +||[customTab](/.tabstop#word-javascript/api/word/-tabstop-customtab-member)|Gets whether this tab stop is a custom tab stop.| +||[leader](/.tabstop#word-javascript/api/word/-tabstop-leader-member)|Gets a `TabLeader` value that represents the leader for this `TabStop` object.| +||[next](/.tabstop#word-javascript/api/word/-tabstop-next-member)|Gets the next tab stop in the collection.| +||[position](/.tabstop#word-javascript/api/word/-tabstop-position-member)|Gets the position of the tab stop relative to the left margin.| +||[previous](/.tabstop#word-javascript/api/word/-tabstop-previous-member)|Gets the previous tab stop in the collection.| +|[TabStopAddOptions](/.tabstopaddoptions)|[alignment](/.tabstopaddoptions#word-javascript/api/word/-tabstopaddoptions-alignment-member)|If provided, specifies the alignment of the tab stop.| +||[leader](/.tabstopaddoptions#word-javascript/api/word/-tabstopaddoptions-leader-member)|If provided, specifies the leader character for the tab stop.| +|[TabStopCollection](/.tabstopcollection)|[add(position: number, options?: Word.TabStopAddOptions)](/.tabstopcollection#word-javascript/api/word/-tabstopcollection-add-member(1))|Returns a `TabStop` object that represents a custom tab stop added to the paragraph.| +||[after(Position: number)](/.tabstopcollection#word-javascript/api/word/-tabstopcollection-after-member(1))|Returns the next `TabStop` object to the right of the specified position.| +||[before(Position: number)](/.tabstopcollection#word-javascript/api/word/-tabstopcollection-before-member(1))|Returns the next `TabStop` object to the left of the specified position.| +||[clearAll()](/.tabstopcollection#word-javascript/api/word/-tabstopcollection-clearall-member(1))|Clears all the custom tab stops from the paragraph.| +||[getItem(index: number)](/.tabstopcollection#word-javascript/api/word/-tabstopcollection-getitem-member(1))|Gets a `TabStop` object by its index in the collection.| +||[items](/.tabstopcollection#word-javascript/api/word/-tabstopcollection-items-member)|Gets the loaded child items in this collection.| +|[TableColumn](/.tablecolumn)|[autoFit()](/.tablecolumn#word-javascript/api/word/-tablecolumn-autofit-member(1))|Changes the width of the table column to accommodate the width of the text without changing the way text wraps in the cells.| +||[borders](/.tablecolumn#word-javascript/api/word/-tablecolumn-borders-member)|Returns a `BorderUniversalCollection` object that represents all the borders for the table column.| +||[columnIndex](/.tablecolumn#word-javascript/api/word/-tablecolumn-columnindex-member)|Returns the position of this column in a collection.| +||[delete()](/.tablecolumn#word-javascript/api/word/-tablecolumn-delete-member(1))|Deletes the column.| +||[isFirst](/.tablecolumn#word-javascript/api/word/-tablecolumn-isfirst-member)|Returns `true` if the column or row is the first one in the table; `false` otherwise.| +||[isLast](/.tablecolumn#word-javascript/api/word/-tablecolumn-islast-member)|Returns `true` if the column or row is the last one in the table; `false` otherwise.| +||[nestingLevel](/.tablecolumn#word-javascript/api/word/-tablecolumn-nestinglevel-member)|Returns the nesting level of the column.| +||[preferredWidth](/.tablecolumn#word-javascript/api/word/-tablecolumn-preferredwidth-member)|Specifies the preferred width (in points or as a percentage of the window width) for the column.| +||[preferredWidthType](/.tablecolumn#word-javascript/api/word/-tablecolumn-preferredwidthtype-member)|Specifies the preferred unit of measurement to use for the width of the table column.| +||[select()](/.tablecolumn#word-javascript/api/word/-tablecolumn-select-member(1))|Selects the table column.| +||[setWidth(columnWidth: number, rulerStyle: Word.RulerStyle)](/.tablecolumn#word-javascript/api/word/-tablecolumn-setwidth-member(1))|Sets the width of the column in a table.| +||[shading](/.tablecolumn#word-javascript/api/word/-tablecolumn-shading-member)|Returns a `ShadingUniversal` object that refers to the shading formatting for the column.| +||[sort()](/.tablecolumn#word-javascript/api/word/-tablecolumn-sort-member(1))|Sorts the table column.| +||[width](/.tablecolumn#word-javascript/api/word/-tablecolumn-width-member)|Specifies the width of the column, in points.| +|[TableColumnCollection](/.tablecolumncollection)|[add(beforeColumn?: Word.TableColumn)](/.tablecolumncollection#word-javascript/api/word/-tablecolumncollection-add-member(1))|Returns a `TableColumn` object that represents a column added to a table.| +||[autoFit()](/.tablecolumncollection#word-javascript/api/word/-tablecolumncollection-autofit-member(1))|Changes the width of a table column to accommodate the width of the text without changing the way text wraps in the cells.| +||[delete()](/.tablecolumncollection#word-javascript/api/word/-tablecolumncollection-delete-member(1))|Deletes the specified columns.| +||[distributeWidth()](/.tablecolumncollection#word-javascript/api/word/-tablecolumncollection-distributewidth-member(1))|Adjusts the width of the specified columns so that they are equal.| +||[items](/.tablecolumncollection#word-javascript/api/word/-tablecolumncollection-items-member)|Gets the loaded child items in this collection.| +||[select()](/.tablecolumncollection#word-javascript/api/word/-tablecolumncollection-select-member(1))|Selects the specified table columns.| +||[setWidth(columnWidth: number, rulerStyle: Word.RulerStyle)](/.tablecolumncollection#word-javascript/api/word/-tablecolumncollection-setwidth-member(1))|Sets the width of columns in a table.| +|[Template](/.template)|[buildingBlockEntries](/.template#word-javascript/api/word/-template-buildingblockentries-member)|Returns a `BuildingBlockEntryCollection` object that represents the collection of building block entries in the template.| +||[buildingBlockTypes](/.template#word-javascript/api/word/-template-buildingblocktypes-member)|Returns a `BuildingBlockTypeItemCollection` object that represents the collection of building block types that are contained in the template.| +||[farEastLineBreakLanguage](/.template#word-javascript/api/word/-template-fareastlinebreaklanguage-member)|Specifies the East Asian language to use when breaking lines of text in the document or template.| +||[farEastLineBreakLevel](/.template#word-javascript/api/word/-template-fareastlinebreaklevel-member)|Specifies the line break control level for the document.| +||[fullName](/.template#word-javascript/api/word/-template-fullname-member)|Returns the name of the template, including the drive or Web path.| +||[hasNoProofing](/.template#word-javascript/api/word/-template-hasnoproofing-member)|Specifies whether the spelling and grammar checker ignores documents based on this template.| +||[justificationMode](/.template#word-javascript/api/word/-template-justificationmode-member)|Specifies the character spacing adjustment for the template.| +||[kerningByAlgorithm](/.template#word-javascript/api/word/-template-kerningbyalgorithm-member)|Specifies if Microsoft Word kerns half-width Latin characters and punctuation marks in the document.| +||[languageId](/.template#word-javascript/api/word/-template-languageid-member)|Specifies a `LanguageId` value that represents the language in the template.| +||[languageIdFarEast](/.template#word-javascript/api/word/-template-languageidfareast-member)|Specifies an East Asian language for the language in the template.| +||[name](/.template#word-javascript/api/word/-template-name-member)|Returns only the name of the document template (excluding any path or other location information).| +||[noLineBreakAfter](/.template#word-javascript/api/word/-template-nolinebreakafter-member)|Specifies the kinsoku characters after which Microsoft Word will not break a line.| +||[noLineBreakBefore](/.template#word-javascript/api/word/-template-nolinebreakbefore-member)|Specifies the kinsoku characters before which Microsoft Word will not break a line.| +||[path](/.template#word-javascript/api/word/-template-path-member)|Returns the path to the document template.| +||[save()](/.template#word-javascript/api/word/-template-save-member(1))|Saves the template.| +||[saved](/.template#word-javascript/api/word/-template-saved-member)|Specifies `true` if the template has not changed since it was last saved, `false` if Microsoft Word displays a prompt to save changes when the document is closed.| +||[type](/.template#word-javascript/api/word/-template-type-member)|Returns the template type.| +|[TemplateCollection](/.templatecollection)|[getCount()](/.templatecollection#word-javascript/api/word/-templatecollection-getcount-member(1))|Returns the number of items in the collection.| +||[getItemAt(index: number)](/.templatecollection#word-javascript/api/word/-templatecollection-getitemat-member(1))|Gets a `Template` object by its index in the collection.| +||[importBuildingBlocks()](/.templatecollection#word-javascript/api/word/-templatecollection-importbuildingblocks-member(1))|Imports the building blocks for all templates into Microsoft Word.| +||[items](/.templatecollection#word-javascript/api/word/-templatecollection-items-member)|Gets the loaded child items in this collection.| +|[TextColumn](/.textcolumn)|[spaceAfter](/.textcolumn#word-javascript/api/word/-textcolumn-spaceafter-member)|Specifies the amount of spacing (in points) after the specified paragraph or text column.| +||[width](/.textcolumn#word-javascript/api/word/-textcolumn-width-member)|Specifies the width, in points, of the specified text columns.| +|[TextColumnAddOptions](/.textcolumnaddoptions)|[isEvenlySpaced](/.textcolumnaddoptions#word-javascript/api/word/-textcolumnaddoptions-isevenlyspaced-member)|If provided, specifies whether to evenly space all the text columns in the document.| +||[spacing](/.textcolumnaddoptions#word-javascript/api/word/-textcolumnaddoptions-spacing-member)|If provided, specifies the spacing between the text columns in the document, in points.| +||[width](/.textcolumnaddoptions#word-javascript/api/word/-textcolumnaddoptions-width-member)|If provided, specifies the width of the new text column in the document, in points.| +|[TextColumnCollection](/.textcolumncollection)|[add(options?: Word.TextColumnAddOptions)](/.textcolumncollection#word-javascript/api/word/-textcolumncollection-add-member(1))|Returns a `TextColumn` object that represents a new text column added to a section or document.| +||[getFlowDirection()](/.textcolumncollection#word-javascript/api/word/-textcolumncollection-getflowdirection-member(1))|Gets the direction in which text flows from one text column to the next.| +||[getHasLineBetween()](/.textcolumncollection#word-javascript/api/word/-textcolumncollection-gethaslinebetween-member(1))|Gets whether vertical lines appear between all the columns in the `TextColumnCollection` object.| +||[getIsEvenlySpaced()](/.textcolumncollection#word-javascript/api/word/-textcolumncollection-getisevenlyspaced-member(1))|Gets whether text columns are evenly spaced.| +||[getItem(index: number)](/.textcolumncollection#word-javascript/api/word/-textcolumncollection-getitem-member(1))|Gets a `TextColumn` by its index in the collection.| +||[items](/.textcolumncollection#word-javascript/api/word/-textcolumncollection-items-member)|Gets the loaded child items in this collection.| +||[setCount(numColumns: number)](/.textcolumncollection#word-javascript/api/word/-textcolumncollection-setcount-member(1))|Arranges text into the specified number of text columns.| +||[setFlowDirection(value: Word.FlowDirection)](/.textcolumncollection#word-javascript/api/word/-textcolumncollection-setflowdirection-member(1))|Sets the direction in which text flows from one text column to the next.| +||[setHasLineBetween(value: boolean)](/.textcolumncollection#word-javascript/api/word/-textcolumncollection-sethaslinebetween-member(1))|Sets whether vertical lines appear between all the columns in the `TextColumnCollection` object.| +||[setIsEvenlySpaced(value: boolean)](/.textcolumncollection#word-javascript/api/word/-textcolumncollection-setisevenlyspaced-member(1))|Sets whether text columns are evenly spaced.| +|[ThreeDimensionalFormat](/.threedimensionalformat)|[bevelBottomDepth](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-bevelbottomdepth-member)|Specifies the depth of the bottom bevel.| +||[bevelBottomInset](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-bevelbottominset-member)|Specifies the inset size for the bottom bevel.| +||[bevelBottomType](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-bevelbottomtype-member)|Specifies a `BevelType` value that represents the bevel type for the bottom bevel.| +||[bevelTopDepth](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-beveltopdepth-member)|Specifies the depth of the top bevel.| +||[bevelTopInset](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-beveltopinset-member)|Specifies the inset size for the top bevel.| +||[bevelTopType](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-beveltoptype-member)|Specifies a `BevelType` value that represents the bevel type for the top bevel.| +||[contourColor](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-contourcolor-member)|Returns a `ColorFormat` object that represents color of the contour of a shape.| +||[contourWidth](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-contourwidth-member)|Specifies the width of the contour of a shape.| +||[depth](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-depth-member)|Specifies the depth of the shape's extrusion.| +||[extrusionColor](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-extrusioncolor-member)|Returns a `ColorFormat` object that represents the color of the shape's extrusion.| +||[extrusionColorType](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-extrusioncolortype-member)|Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion)| +||[fieldOfView](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-fieldofview-member)|Specifies the amount of perspective for a shape.| +||[incrementRotationHorizontal(increment: number)](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-incrementrotationhorizontal-member(1))|Horizontally rotates a shape on the x-axis.| +||[incrementRotationVertical(increment: number)](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-incrementrotationvertical-member(1))|Vertically rotates a shape on the y-axis.| +||[incrementRotationX(increment: number)](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-incrementrotationx-member(1))|Changes the rotation around the x-axis.| +||[incrementRotationY(increment: number)](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-incrementrotationy-member(1))|Changes the rotation around the y-axis.| +||[incrementRotationZ(increment: number)](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-incrementrotationz-member(1))|Rotates a shape on the z-axis.| +||[isPerspective](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-isperspective-member)|Specifies `true` if the extrusion appears in perspective — that is, if the walls of the extrusion narrow toward a vanishing point,| +||[isVisible](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-isvisible-member)|Specifies if the specified object, or the formatting applied to it, is visible.| +||[lightAngle](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-lightangle-member)|Specifies the angle of the lighting.| +||[presetCamera](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-presetcamera-member)|Returns a `PresetCamera` value that represents the camera presets.| +||[presetExtrusionDirection](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-presetextrusiondirection-member)|Returns the direction taken by the extrusion's sweep path leading away from the extruded shape (the front face of the extrusion).| +||[presetLighting](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-presetlighting-member)|Specifies a `LightRigType` value that represents the lighting preset.| +||[presetLightingDirection](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-presetlightingdirection-member)|Specifies the position of the light source relative to the extrusion.| +||[presetLightingSoftness](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-presetlightingsoftness-member)|Specifies the intensity of the extrusion lighting.| +||[presetMaterial](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-presetmaterial-member)|Specifies the extrusion surface material.| +||[presetThreeDimensionalFormat](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-presetthreedimensionalformat-member)|Returns the preset extrusion format.| +||[projectText](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-projecttext-member)|Specifies whether text on a shape rotates with shape.| +||[resetRotation()](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-resetrotation-member(1))|Resets the extrusion rotation around the x-axis, y-axis, and z-axis to 0.| +||[rotationX](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-rotationx-member)|Specifies the rotation of the extruded shape around the x-axis in degrees.| +||[rotationY](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-rotationy-member)|Specifies the rotation of the extruded shape around the y-axis in degrees.| +||[rotationZ](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-rotationz-member)|Specifies the z-axis rotation of the camera.| +||[setExtrusionDirection(presetExtrusionDirection: Word.PresetExtrusionDirection)](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-setextrusiondirection-member(1))|Sets the direction of the extrusion's sweep path.| +||[setPresetCamera(presetCamera: Word.PresetCamera)](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-setpresetcamera-member(1))|Sets the camera preset for the shape.| +||[setThreeDimensionalFormat(presetThreeDimensionalFormat: Word.PresetThreeDimensionalFormat)](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-setthreedimensionalformat-member(1))|Sets the preset extrusion format.| +||[z](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-z-member)|Specifies the position on the z-axis for the shape.| +|[View](/.view)|[areAllNonprintingCharactersDisplayed](/.view#word-javascript/api/word/-view-areallnonprintingcharactersdisplayed-member)|Specifies whether all nonprinting characters are displayed.| +||[areBackgroundsDisplayed](/.view#word-javascript/api/word/-view-arebackgroundsdisplayed-member)|Gets whether background colors and images are shown when the document is displayed in print layout view.| +||[areBookmarksIndicated](/.view#word-javascript/api/word/-view-arebookmarksindicated-member)|Gets whether square brackets are displayed at the beginning and end of each bookmark.| +||[areCommentsDisplayed](/.view#word-javascript/api/word/-view-arecommentsdisplayed-member)|Specifies whether Microsoft Word displays the comments in the document.| +||[areConnectingLinesToRevisionsBalloonDisplayed](/.view#word-javascript/api/word/-view-areconnectinglinestorevisionsballoondisplayed-member)|Specifies whether Microsoft Word displays connecting lines from the text to the revision and comment balloons.| +||[areCropMarksDisplayed](/.view#word-javascript/api/word/-view-arecropmarksdisplayed-member)|Gets whether crop marks are shown in the corners of pages to indicate where margins are located.| +||[areDrawingsDisplayed](/.view#word-javascript/api/word/-view-aredrawingsdisplayed-member)|Gets whether objects created with the drawing tools are displayed in print layout view.| +||[areEditableRangesShaded](/.view#word-javascript/api/word/-view-areeditablerangesshaded-member)|Specifies whether shading is applied to the ranges in the document that users have permission to modify.| +||[areFieldCodesDisplayed](/.view#word-javascript/api/word/-view-arefieldcodesdisplayed-member)|Specifies whether field codes are displayed.| +||[areFormatChangesDisplayed](/.view#word-javascript/api/word/-view-areformatchangesdisplayed-member)|Specifies whether Microsoft Word displays formatting changes made to the document with Track Changes enabled.| +||[areInkAnnotationsDisplayed](/.view#word-javascript/api/word/-view-areinkannotationsdisplayed-member)|Specifies whether handwritten ink annotations are shown or hidden.| +||[areInsertionsAndDeletionsDisplayed](/.view#word-javascript/api/word/-view-areinsertionsanddeletionsdisplayed-member)|Specifies whether Microsoft Word displays insertions and deletions made to the document with Track Changes enabled.| +||[areLinesWrappedToWindow](/.view#word-javascript/api/word/-view-arelineswrappedtowindow-member)|Gets whether lines wrap at the right edge of the document window rather than at the right margin or the right column boundary.| +||[areObjectAnchorsDisplayed](/.view#word-javascript/api/word/-view-areobjectanchorsdisplayed-member)|Gets whether object anchors are displayed next to items that can be positioned in print layout view.| +||[areOptionalBreaksDisplayed](/.view#word-javascript/api/word/-view-areoptionalbreaksdisplayed-member)|Gets whether Microsoft Word displays optional line breaks.| +||[areOptionalHyphensDisplayed](/.view#word-javascript/api/word/-view-areoptionalhyphensdisplayed-member)|Gets whether optional hyphens are displayed.| +||[areOtherAuthorsVisible](/.view#word-javascript/api/word/-view-areotherauthorsvisible-member)|Gets whether other authors' presence should be visible in the document.| +||[arePageBoundariesDisplayed](/.view#word-javascript/api/word/-view-arepageboundariesdisplayed-member)|Gets whether the top and bottom margins and the gray area between pages in the document are displayed.| +||[areParagraphsMarksDisplayed](/.view#word-javascript/api/word/-view-areparagraphsmarksdisplayed-member)|Gets whether paragraph marks are displayed.| +||[arePicturePlaceholdersDisplayed](/.view#word-javascript/api/word/-view-arepictureplaceholdersdisplayed-member)|Gets whether blank boxes are displayed as placeholders for pictures.| +||[areRevisionsAndCommentsDisplayed](/.view#word-javascript/api/word/-view-arerevisionsandcommentsdisplayed-member)|Specifies whether Microsoft Word displays revisions and comments made to the document with Track Changes enabled.| +||[areSpacesIndicated](/.view#word-javascript/api/word/-view-arespacesindicated-member)|Gets whether space characters are displayed.| +||[areTableGridlinesDisplayed](/.view#word-javascript/api/word/-view-aretablegridlinesdisplayed-member)|Specifies whether table gridlines are displayed.| +||[areTabsDisplayed](/.view#word-javascript/api/word/-view-aretabsdisplayed-member)|Gets whether tab characters are displayed.| +||[areTextBoundariesDisplayed](/.view#word-javascript/api/word/-view-aretextboundariesdisplayed-member)|Gets whether dotted lines are displayed around page margins, text columns, objects, and frames in print layout view.| +||[collapseAllHeadings()](/.view#word-javascript/api/word/-view-collapseallheadings-member(1))|Collapses all the headings in the document.| +||[collapseOutline(range: Word.Range)](/.view#word-javascript/api/word/-view-collapseoutline-member(1))|Collapses the text under the selection or the specified range by one heading level.| +||[columnWidth](/.view#word-javascript/api/word/-view-columnwidth-member)|Specifies the column width in Reading mode.| +||[expandAllHeadings()](/.view#word-javascript/api/word/-view-expandallheadings-member(1))|Expands all the headings in the document.| +||[expandOutline(range: Word.Range)](/.view#word-javascript/api/word/-view-expandoutline-member(1))|Expands the text under the selection by one heading level.| +||[fieldShading](/.view#word-javascript/api/word/-view-fieldshading-member)|Gets on-screen shading for fields.| +||[isDraft](/.view#word-javascript/api/word/-view-isdraft-member)|Specifies whether all the text in a window is displayed in the same sans-serif font with minimal formatting to speed up display.| +||[isFirstLineOnlyDisplayed](/.view#word-javascript/api/word/-view-isfirstlineonlydisplayed-member)|Specifies whether only the first line of body text is shown in outline view.| +||[isFormatDisplayed](/.view#word-javascript/api/word/-view-isformatdisplayed-member)|Specifies whether character formatting is visible in outline view.| +||[isFullScreen](/.view#word-javascript/api/word/-view-isfullscreen-member)|Specifies whether the window is in full-screen view.| +||[isHiddenTextDisplayed](/.view#word-javascript/api/word/-view-ishiddentextdisplayed-member)|Gets whether text formatted as hidden text is displayed.| +||[isHighlightingDisplayed](/.view#word-javascript/api/word/-view-ishighlightingdisplayed-member)|Gets whether highlight formatting is displayed and printed with the document.| +||[isInConflictMode](/.view#word-javascript/api/word/-view-isinconflictmode-member)|Specifies whether the document is in conflict mode view.| +||[isInPanning](/.view#word-javascript/api/word/-view-isinpanning-member)|Specifies whether Microsoft Word is in Panning mode.| +||[isInReadingLayout](/.view#word-javascript/api/word/-view-isinreadinglayout-member)|Specifies whether the document is being viewed in reading layout view.| +||[isMailMergeDataView](/.view#word-javascript/api/word/-view-ismailmergedataview-member)|Specifies whether mail merge data is displayed instead of mail merge fields.| +||[isMainTextLayerVisible](/.view#word-javascript/api/word/-view-ismaintextlayervisible-member)|Specifies whether the text in the document is visible when the header and footer areas are displayed.| +||[isPointerShownAsMagnifier](/.view#word-javascript/api/word/-view-ispointershownasmagnifier-member)|Specifies whether the pointer is displayed as a magnifying glass in print preview.| +||[isReadingLayoutActualView](/.view#word-javascript/api/word/-view-isreadinglayoutactualview-member)|Specifies whether pages displayed in reading layout view are displayed using the same layout as printed pages.| +||[isXmlMarkupVisible](/.view#word-javascript/api/word/-view-isxmlmarkupvisible-member)|Specifies whether XML tags are visible in the document.| +||[markupMode](/.view#word-javascript/api/word/-view-markupmode-member)|Specifies the display mode for tracked changes.| +||[nextHeaderFooter()](/.view#word-javascript/api/word/-view-nextheaderfooter-member(1))|Moves to the next header or footer, depending on whether a header or footer is displayed in the view.| +||[pageColor](/.view#word-javascript/api/word/-view-pagecolor-member)|Specifies the page color in Reading mode.| +||[pageMovementType](/.view#word-javascript/api/word/-view-pagemovementtype-member)|Specifies the page movement type.| +||[previousHeaderFooter()](/.view#word-javascript/api/word/-view-previousheaderfooter-member(1))|Moves to the previous header or footer, depending on whether a header or footer is displayed in the view.| +||[readingLayoutTruncateMargins](/.view#word-javascript/api/word/-view-readinglayouttruncatemargins-member)|Specifies whether margins are visible or hidden when the document is viewed in Full Screen Reading view.| +||[revisionsBalloonSide](/.view#word-javascript/api/word/-view-revisionsballoonside-member)|Gets whether Word displays revision balloons in the left or right margin in the document.| +||[revisionsBalloonWidth](/.view#word-javascript/api/word/-view-revisionsballoonwidth-member)|Specifies the width of the revision balloons.| +||[revisionsBalloonWidthType](/.view#word-javascript/api/word/-view-revisionsballoonwidthtype-member)|Specifies how Microsoft Word measures the width of revision balloons.| +||[revisionsFilter](/.view#word-javascript/api/word/-view-revisionsfilter-member)|Gets the instance of a `RevisionsFilter` object.| +||[seekView](/.view#word-javascript/api/word/-view-seekview-member)|Specifies the document element displayed in print layout view.| +||[showAllHeadings()](/.view#word-javascript/api/word/-view-showallheadings-member(1))|Switches between showing all text (headings and body text) and showing only headings.| +||[showHeading(level: number)](/.view#word-javascript/api/word/-view-showheading-member(1))|Shows all headings up to the specified heading level and hides subordinate headings and body text.| +||[splitSpecial](/.view#word-javascript/api/word/-view-splitspecial-member)|Specifies the active window pane.| +||[type](/.view#word-javascript/api/word/-view-type-member)|Specifies the view type.| +|[Window](/.window)|[activate()](/.window#word-javascript/api/word/-window-activate-member(1))|Activates the window.| +||[areRulersDisplayed](/.window#word-javascript/api/word/-window-arerulersdisplayed-member)|Specifies whether rulers are displayed for the window or pane.| +||[areScreenTipsDisplayed](/.window#word-javascript/api/word/-window-arescreentipsdisplayed-member)|Specifies whether comments, footnotes, endnotes, and hyperlinks are displayed as tips.| +||[areThumbnailsDisplayed](/.window#word-javascript/api/word/-window-arethumbnailsdisplayed-member)|Specifies whether thumbnail images of the pages in a document are displayed along the left side of the Microsoft Word document window.| +||[caption](/.window#word-javascript/api/word/-window-caption-member)|Specifies the caption text for the window that is displayed in the title bar of the document or application window.| +||[close(options?: Word.WindowCloseOptions)](/.window#word-javascript/api/word/-window-close-member(1))|Closes the window.| +||[height](/.window#word-javascript/api/word/-window-height-member)|Specifies the height of the window (in points).| +||[horizontalPercentScrolled](/.window#word-javascript/api/word/-window-horizontalpercentscrolled-member)|Specifies the horizontal scroll position as a percentage of the document width.| +||[imemode](/.window#word-javascript/api/word/-window-imemode-member)|Specifies the default start-up mode for the Japanese Input Method Editor (IME).| +||[index](/.window#word-javascript/api/word/-window-index-member)|Gets the position of an item in a collection.| +||[isActive](/.window#word-javascript/api/word/-window-isactive-member)|Specifies whether the window is active.| +||[isDocumentMapVisible](/.window#word-javascript/api/word/-window-isdocumentmapvisible-member)|Specifies whether the document map is visible.| +||[isEnvelopeVisible](/.window#word-javascript/api/word/-window-isenvelopevisible-member)|Specifies whether the email message header is visible in the document window.| +||[isHorizontalScrollBarDisplayed](/.window#word-javascript/api/word/-window-ishorizontalscrollbardisplayed-member)|Specifies whether a horizontal scroll bar is displayed for the window.| +||[isLeftScrollBarDisplayed](/.window#word-javascript/api/word/-window-isleftscrollbardisplayed-member)|Specifies whether the vertical scroll bar appears on the left side of the document window.| +||[isRightRulerDisplayed](/.window#word-javascript/api/word/-window-isrightrulerdisplayed-member)|Specifies whether the vertical ruler appears on the right side of the document window in print layout view.| +||[isSplit](/.window#word-javascript/api/word/-window-issplit-member)|Specifies whether the window is split into multiple panes.| +||[isVerticalRulerDisplayed](/.window#word-javascript/api/word/-window-isverticalrulerdisplayed-member)|Specifies whether a vertical ruler is displayed for the window or pane.| +||[isVerticalScrollBarDisplayed](/.window#word-javascript/api/word/-window-isverticalscrollbardisplayed-member)|Specifies whether a vertical scroll bar is displayed for the window.| +||[isVisible](/.window#word-javascript/api/word/-window-isvisible-member)|Specifies whether the window is visible.| +||[largeScroll(options?: Word.WindowScrollOptions)](/.window#word-javascript/api/word/-window-largescroll-member(1))|Scrolls the window by the specified number of screens.| +||[left](/.window#word-javascript/api/word/-window-left-member)|Specifies the horizontal position of the window, measured in points.| +||[next](/.window#word-javascript/api/word/-window-next-member)|Gets the next document window in the collection of open document windows.| +||[pageScroll(options?: Word.WindowPageScrollOptions)](/.window#word-javascript/api/word/-window-pagescroll-member(1))|Scrolls through the window page by page.| +||[previous](/.window#word-javascript/api/word/-window-previous-member)|Gets the previous document window in the collection open document windows.| +||[setFocus()](/.window#word-javascript/api/word/-window-setfocus-member(1))|Sets the focus of the document window to the body of an email message.| +||[showSourceDocuments](/.window#word-javascript/api/word/-window-showsourcedocuments-member)|Specifies how Microsoft Word displays source documents after a compare and merge process.| +||[smallScroll(options?: Word.WindowScrollOptions)](/.window#word-javascript/api/word/-window-smallscroll-member(1))|Scrolls the window by the specified number of lines.| +||[splitVertical](/.window#word-javascript/api/word/-window-splitvertical-member)|Specifies the vertical split percentage for the window.| +||[styleAreaWidth](/.window#word-javascript/api/word/-window-styleareawidth-member)|Specifies the width of the style area in points.| +||[toggleRibbon()](/.window#word-javascript/api/word/-window-toggleribbon-member(1))|Shows or hides the ribbon.| +||[top](/.window#word-javascript/api/word/-window-top-member)|Specifies the vertical position of the document window, in points.| +||[type](/.window#word-javascript/api/word/-window-type-member)|Gets the window type.| +||[usableHeight](/.window#word-javascript/api/word/-window-usableheight-member)|Gets the height (in points) of the active working area in the document window.| +||[usableWidth](/.window#word-javascript/api/word/-window-usablewidth-member)|Gets the width (in points) of the active working area in the document window.| +||[verticalPercentScrolled](/.window#word-javascript/api/word/-window-verticalpercentscrolled-member)|Specifies the vertical scroll position as a percentage of the document length.| +||[view](/.window#word-javascript/api/word/-window-view-member)|Gets the `View` object that represents the view for the window.| +||[width](/.window#word-javascript/api/word/-window-width-member)|Specifies the width of the document window, in points.| +||[windowNumber](/.window#word-javascript/api/word/-window-windownumber-member)|Gets an integer that represents the position of the window.| +||[windowState](/.window#word-javascript/api/word/-window-windowstate-member)|Specifies the state of the document window or task window.| +|[WindowCloseOptions](/.windowcloseoptions)|[routeDocument](/.windowcloseoptions#word-javascript/api/word/-windowcloseoptions-routedocument-member)|If provided, specifies whether to route the document to the next recipient.| +||[saveChanges](/.windowcloseoptions#word-javascript/api/word/-windowcloseoptions-savechanges-member)|If provided, specifies the save action for the document.| +|[WindowCollection](/.windowcollection)||| +|[WindowPageScrollOptions](/.windowpagescrolloptions)|[down](/.windowpagescrolloptions#word-javascript/api/word/-windowpagescrolloptions-down-member)|If provided, specifies the number of pages to scroll the window down.| +||[up](/.windowpagescrolloptions#word-javascript/api/word/-windowpagescrolloptions-up-member)|If provided, specifies the number of pages to scroll the window up.| +|[WindowScrollOptions](/.windowscrolloptions)|[down](/.windowscrolloptions#word-javascript/api/word/-windowscrolloptions-down-member)|If provided, specifies the number of units to scroll the window down.| +||[left](/.windowscrolloptions#word-javascript/api/word/-windowscrolloptions-left-member)|If provided, specifies the number of screens to scroll the window to the left.| +||[right](/.windowscrolloptions#word-javascript/api/word/-windowscrolloptions-right-member)|If provided, specifies the number of screens to scroll the window to the right.| +||[up](/.windowscrolloptions#word-javascript/api/word/-windowscrolloptions-up-member)|If provided, specifies the number of units to scroll the window up.| +|[XmlMapping](/.xmlmapping)|[customXmlNode](/.xmlmapping#word-javascript/api/word/-xmlmapping-customxmlnode-member)|Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to.| +||[customXmlPart](/.xmlmapping#word-javascript/api/word/-xmlmapping-customxmlpart-member)|Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps.| +||[delete()](/.xmlmapping#word-javascript/api/word/-xmlmapping-delete-member(1))|Deletes the XML mapping from the parent content control.| +||[isMapped](/.xmlmapping#word-javascript/api/word/-xmlmapping-ismapped-member)|Returns whether the content control in the document is mapped to an XML node in the document's XML data store.| +||[prefixMappings](/.xmlmapping#word-javascript/api/word/-xmlmapping-prefixmappings-member)|Returns the prefix mappings used to evaluate the XPath for the current XML mapping.| +||[setMapping(xPath: string, options?: Word.XmlSetMappingOptions)](/.xmlmapping#word-javascript/api/word/-xmlmapping-setmapping-member(1))|Allows creating or changing the XML mapping on the content control.| +||[setMappingByNode(node: Word.CustomXmlNode)](/.xmlmapping#word-javascript/api/word/-xmlmapping-setmappingbynode-member(1))|Allows creating or changing the XML data mapping on the content control.| +||[xpath](/.xmlmapping#word-javascript/api/word/-xmlmapping-xpath-member)|Returns the XPath for the XML mapping, which evaluates to the currently mapped XML node.| +|[XmlSetMappingOptions](/.xmlsetmappingoptions)|[prefixMapping](/.xmlsetmappingoptions#word-javascript/api/word/-xmlsetmappingoptions-prefixmapping-member)|If provided, specifies the prefix mappings to use when querying the expression provided in the `xPath` parameter of the `XmlMapping.setMapping` calling method.| +||[source](/.xmlsetmappingoptions#word-javascript/api/word/-xmlsetmappingoptions-source-member)|If provided, specifies the desired custom XML data to map the content control to.| From ad7ed900044c9418c82d420a708a33ee719e85be Mon Sep 17 00:00:00 2001 From: Alex Jerabek <38896772+AlexJerabek@users.noreply.github.com> Date: Mon, 15 Sep 2025 15:42:20 -0700 Subject: [PATCH 3/5] Restore old config file link paths --- docs/docs-ref-autogen/word/toc.yml | 178 + docs/docs-ref-autogen/word/word.yml | 171 + .../word/word/word.application.yml | 34 + .../word/word/word.autofitbehavior.yml | 43 + .../word/word.calendartypebidirectional.yml | 33 + .../word/word/word.captionlabeltype.yml | 43 + .../word/word/word.captionposition.yml | 33 + .../word/word/word.coauthor.yml | 247 + .../word/word/word.coauthorcollection.yml | 187 + .../word/word/word.coauthoring.yml | 302 + .../word/word/word.coauthoringlock.yml | 295 + .../word/word.coauthoringlockaddoptions.yml | 56 + .../word/word.coauthoringlockcollection.yml | 225 + .../word/word/word.coauthoringlocktype.yml | 55 + .../word/word/word.coauthoringupdate.yml | 245 + .../word/word.coauthoringupdatecollection.yml | 193 + .../word/word/word.collapsedirection.yml | 33 + .../word/word/word.conditionalstyle.yml | 313 + .../word/word/word.conditioncode.yml | 133 + .../word/word/word.conflict.yml | 299 + .../word/word/word.conflictcollection.yml | 241 + .../word/word/word.datelanguage.yml | 33 + .../word/word/word.defaulttablebehavior.yml | 33 + .../word/word/word.deletecells.yml | 57 + .../word/word/word.document.yml | 137 + .../word/word/word.editor.yml | 344 + .../word/word/word.editorcollection.yml | 263 + .../word/word/word.editortype.yml | 57 + .../word/word/word.endnotelocation.yml | 33 + .../word/word/word.fontbias.yml | 43 + .../word/word/word.fontnamecollection.yml | 193 + .../word/word/word.footnotelocation.yml | 33 + .../word/word/word.gotodirection.yml | 55 + .../word/word/word.gotoitem.yml | 185 + .../word/word/word.headingstyle.yml | 273 + .../word/word/word.headingstylecollection.yml | 213 + .../word/word.interfaces.applicationdata.yml | 19 + ...word.interfaces.coauthorcollectiondata.yml | 27 + ...terfaces.coauthorcollectionloadoptions.yml | 96 + ...nterfaces.coauthorcollectionupdatedata.yml | 27 + .../word/word.interfaces.coauthordata.yml | 91 + .../word/word.interfaces.coauthoringdata.yml | 142 + ...word.interfaces.coauthoringloadoptions.yml | 92 + ...terfaces.coauthoringlockcollectiondata.yml | 27 + ...s.coauthoringlockcollectionloadoptions.yml | 79 + ...es.coauthoringlockcollectionupdatedata.yml | 27 + .../word.interfaces.coauthoringlockdata.yml | 65 + ....interfaces.coauthoringlockloadoptions.yml | 77 + ...d.interfaces.coauthoringlockupdatedata.yml | 31 + ...rfaces.coauthoringupdatecollectiondata.yml | 27 + ...coauthoringupdatecollectionloadoptions.yml | 50 + ....coauthoringupdatecollectionupdatedata.yml | 27 + .../word.interfaces.coauthoringupdatedata.yml | 31 + ...nterfaces.coauthoringupdateloadoptions.yml | 47 + ...interfaces.coauthoringupdateupdatedata.yml | 31 + .../word.interfaces.coauthorloadoptions.yml | 90 + .../word.interfaces.conditionalstyledata.yml | 82 + ...interfaces.conditionalstyleloadoptions.yml | 155 + ....interfaces.conditionalstyleupdatedata.yml | 82 + ...word.interfaces.conflictcollectiondata.yml | 27 + ...terfaces.conflictcollectionloadoptions.yml | 64 + ...nterfaces.conflictcollectionupdatedata.yml | 27 + .../word/word.interfaces.conflictdata.yml | 58 + .../word.interfaces.conflictloadoptions.yml | 62 + .../word.interfaces.conflictupdatedata.yml | 31 + .../word/word.interfaces.documentdata.yml | 49 + .../word.interfaces.documentloadoptions.yml | 32 + .../word/word/word.interfaces.editordata.yml | 80 + .../word.interfaces.editorloadoptions.yml | 101 + .../word/word.interfaces.editorupdatedata.yml | 48 + ....interfaces.headingstylecollectiondata.yml | 27 + ...aces.headingstylecollectionloadoptions.yml | 67 + ...faces.headingstylecollectionupdatedata.yml | 27 + .../word/word.interfaces.headingstyledata.yml | 46 + ...ord.interfaces.headingstyleloadoptions.yml | 62 + ...word.interfaces.headingstyleupdatedata.yml | 46 + ....interfaces.listtemplatecollectiondata.yml | 27 + ...aces.listtemplatecollectionloadoptions.yml | 66 + ...faces.listtemplatecollectionupdatedata.yml | 27 + .../word/word.interfaces.listtemplatedata.yml | 15 + ...aces.listtemplategallerycollectiondata.yml | 29 + ...isttemplategallerycollectionupdatedata.yml | 29 + ...ord.interfaces.listtemplategallerydata.yml | 13 + ...ord.interfaces.listtemplateloadoptions.yml | 15 + ...word.interfaces.listtemplateupdatedata.yml | 15 + ...d.interfaces.panecollectionloadoptions.yml | 47 + .../word/word.interfaces.paneloadoptions.yml | 50 + .../word/word/word.interfaces.rangedata.yml | 17 + ...d.interfaces.rangescopedcollectiondata.yml | 27 + ...faces.rangescopedcollectionloadoptions.yml | 838 + ...rfaces.rangescopedcollectionupdatedata.yml | 27 + ...word.interfaces.revisioncollectiondata.yml | 27 + ...terfaces.revisioncollectionloadoptions.yml | 159 + ...nterfaces.revisioncollectionupdatedata.yml | 27 + .../word/word.interfaces.revisiondata.yml | 142 + .../word.interfaces.revisionloadoptions.yml | 147 + .../word.interfaces.revisionupdatedata.yml | 50 + .../word/word.interfaces.selectiondata.yml | 621 + .../word.interfaces.selectionloadoptions.yml | 398 + .../word.interfaces.selectionupdatedata.yml | 155 + ...erfaces.tablecellcollectionloadoptions.yml | 36 + .../word.interfaces.tablecellloadoptions.yml | 36 + ....interfaces.tablecollectionloadoptions.yml | 49 + .../word/word/word.interfaces.tabledata.yml | 30 + .../word/word.interfaces.tableloadoptions.yml | 49 + ...bleofauthoritiescategorycollectiondata.yml | 30 + ...thoritiescategorycollectionloadoptions.yml | 55 + ...uthoritiescategorycollectionupdatedata.yml | 32 + ...erfaces.tableofauthoritiescategorydata.yml | 33 + ....tableofauthoritiescategoryloadoptions.yml | 49 + ...faces.tableofauthoritiescollectiondata.yml | 27 + ...ableofauthoritiescollectionloadoptions.yml | 259 + ...tableofauthoritiescollectionupdatedata.yml | 27 + ...word.interfaces.tableofauthoritiesdata.yml | 211 + ...terfaces.tableofauthoritiesloadoptions.yml | 242 + ...nterfaces.tableofauthoritiesupdatedata.yml | 214 + ...terfaces.tableofcontentscollectiondata.yml | 27 + ...s.tableofcontentscollectionloadoptions.yml | 234 + ...es.tableofcontentscollectionupdatedata.yml | 27 + .../word.interfaces.tableofcontentsdata.yml | 189 + ....interfaces.tableofcontentsloadoptions.yml | 220 + ...d.interfaces.tableofcontentsupdatedata.yml | 193 + ...nterfaces.tableoffigurescollectiondata.yml | 27 + ...es.tableoffigurescollectionloadoptions.yml | 270 + ...ces.tableoffigurescollectionupdatedata.yml | 27 + .../word.interfaces.tableoffiguresdata.yml | 222 + ...d.interfaces.tableoffiguresloadoptions.yml | 254 + ...rd.interfaces.tableoffiguresupdatedata.yml | 227 + ...terfaces.tablerowcollectionloadoptions.yml | 36 + .../word.interfaces.tablerowloadoptions.yml | 34 + .../word/word.interfaces.tablestyledata.yml | 87 + .../word.interfaces.tablestyleloadoptions.yml | 103 + .../word.interfaces.tablestyleupdatedata.yml | 87 + .../word/word.interfaces.tableupdatedata.yml | 30 + ...interfaces.windowcollectionloadoptions.yml | 23 +- .../word/word/word.interfaces.windowdata.yml | 8 +- .../word.interfaces.windowloadoptions.yml | 23 +- .../word/word.interfaces.windowupdatedata.yml | 8 +- .../word/word/word.listtemplate.yml | 15 + .../word/word/word.listtemplatecollection.yml | 236 + .../word.listtemplatecollectionaddoptions.yml | 49 + .../word/word/word.listtemplategallery.yml | 171 + .../word.listtemplategallerycollection.yml | 234 + .../word/word.listtemplategallerytype.yml | 43 + .../word/word/word.movementtype.yml | 33 + .../word/word/word.notenumberstyle.yml | 303 + .../word/word/word.operationunit.yml | 173 + docs/docs-ref-autogen/word/word/word.pane.yml | 41 +- .../word/word/word.panecollection.yml | 29 +- .../word/word/word.paragraph.yml | 17 - .../word/word/word.pastedatatype.yml | 113 + .../word/word/word.pasteformattype.yml | 193 + .../docs-ref-autogen/word/word/word.range.yml | 53 + .../word/word/word.rangescopedcollection.yml | 209 + .../word/word/word.referencekind.yml | 143 + .../word/word/word.referencetype.yml | 63 + .../word/word/word.revision.yml | 388 + .../word/word/word.revisioncollection.yml | 247 + .../word/word/word.rowheightrule.yml | 43 + .../word/word/word.selection.yml | 2892 + .../word.selectionconverttotableoptions.yml | 316 + .../word/word/word.selectiondeleteoptions.yml | 60 + .../word/word/word.selectiongotooptions.yml | 95 + ...d.selectioninsertcrossreferenceoptions.yml | 90 + .../word.selectioninsertdatetimeoptions.yml | 116 + .../word.selectioninsertformulaoptions.yml | 78 + .../word.selectioninsertsymboloptions.yml | 71 + .../word.selectionmoveleftrightoptions.yml | 78 + .../word/word/word.selectionmoveoptions.yml | 66 + .../word.selectionmovestartendoptions.yml | 63 + .../word/word.selectionmoveupdownoptions.yml | 78 + .../word/word/word.selectionnextoptions.yml | 58 + .../word/word.selectionpreviousoptions.yml | 58 + .../word/word/word.selectiontype.yml | 103 + .../word/word/word.sortfieldtype.yml | 83 + .../word/word/word.sortorder.yml | 33 + .../docs-ref-autogen/word/word/word.table.yml | 217 + .../word/word/word.tableautoformatoptions.yml | 205 + .../word/word/word.tablecell.yml | 137 + .../word/word/word.tablecellcollection.yml | 232 + .../word.tablecellcollectionsplitoptions.yml | 67 + .../word/word.tablecellformulaoptions.yml | 56 + .../word/word.tablecellinsertionlocation.yml | 54 + .../word/word.tableconverttotextoptions.yml | 59 + .../word/word/word.tabledirection.yml | 35 + .../word/word/word.tablefieldseparator.yml | 53 + .../word/word/word.tableformat.yml | 443 + .../word/word/word.tableformattype.yml | 443 + .../word/word/word.tableofauthorities.yml | 456 + .../word.tableofauthoritiesaddoptions.yml | 222 + .../word/word.tableofauthoritiescategory.yml | 199 + ...d.tableofauthoritiescategorycollection.yml | 233 + .../word.tableofauthoritiescollection.yml | 304 + ....tableofauthoritiesmarkcitationoptions.yml | 75 + .../word/word/word.tableofcontents.yml | 466 + .../word/word.tableofcontentsaddoptions.yml | 226 + .../word/word.tableofcontentscollection.yml | 245 + .../word.tableofcontentsmarkentryoptions.yml | 89 + .../word/word/word.tableoffigures.yml | 500 + .../word/word.tableoffiguresaddoptions.yml | 173 + .../word/word.tableoffigurescollection.yml | 245 + .../word/word/word.tablerow.yml | 154 + .../word/word/word.tablerowcollection.yml | 170 + .../word/word/word.tablesortoptions.yml | 421 + .../word/word/word.tablestyle.yml | 173 + .../word/word/word.template.yml | 17 + .../word/word/word.textorientation.yml | 74 + .../word/word/word.window.yml | 8 +- docs/includes/excel-1_1.md | 434 +- docs/includes/excel-1_10.md | 288 +- docs/includes/excel-1_11.md | 70 +- docs/includes/excel-1_12.md | 180 +- docs/includes/excel-1_13.md | 54 +- docs/includes/excel-1_14.md | 82 +- docs/includes/excel-1_15.md | 14 +- docs/includes/excel-1_16.md | 370 +- docs/includes/excel-1_17.md | 62 +- docs/includes/excel-1_18.md | 52 +- docs/includes/excel-1_19.md | 194 +- docs/includes/excel-1_2.md | 1112 +- docs/includes/excel-1_20.md | 8 +- docs/includes/excel-1_3.md | 66 +- docs/includes/excel-1_4.md | 82 +- docs/includes/excel-1_5.md | 54 +- docs/includes/excel-1_6.md | 220 +- docs/includes/excel-1_7.md | 470 +- docs/includes/excel-1_8.md | 498 +- docs/includes/excel-1_9.md | 896 +- docs/includes/excel-online.md | 104 +- docs/includes/excel-preview.md | 326 +- docs/includes/outlook-1_1.md | 170 +- docs/includes/outlook-1_10.md | 44 +- docs/includes/outlook-1_11.md | 20 +- docs/includes/outlook-1_12.md | 6 +- docs/includes/outlook-1_13.md | 58 +- docs/includes/outlook-1_14.md | 66 +- docs/includes/outlook-1_15.md | 184 +- docs/includes/outlook-1_2.md | 16 +- docs/includes/outlook-1_3.md | 58 +- docs/includes/outlook-1_5.md | 38 +- docs/includes/outlook-1_6.md | 12 +- docs/includes/outlook-1_7.md | 142 +- docs/includes/outlook-1_8.md | 188 +- docs/includes/outlook-1_9.md | 38 +- docs/includes/outlook-preview.md | 26 +- docs/includes/powerpoint-1_1.md | 2 +- docs/includes/powerpoint-1_2.md | 24 +- docs/includes/powerpoint-1_3.md | 86 +- docs/includes/powerpoint-1_4.md | 100 +- docs/includes/powerpoint-1_5.md | 56 +- docs/includes/powerpoint-1_6.md | 12 +- docs/includes/powerpoint-1_7.md | 90 +- docs/includes/powerpoint-1_8.md | 224 +- docs/includes/powerpoint-1_9.md | 98 +- docs/includes/powerpoint-preview.md | 130 +- docs/includes/word-1_1.md | 284 +- docs/includes/word-1_2.md | 28 +- docs/includes/word-1_3.md | 518 +- docs/includes/word-1_3_hidden_document.md | 12 +- docs/includes/word-1_4.md | 212 +- docs/includes/word-1_4_hidden_document.md | 10 +- docs/includes/word-1_5.md | 216 +- docs/includes/word-1_5_hidden_document.md | 8 +- docs/includes/word-1_6.md | 88 +- docs/includes/word-1_7.md | 66 +- docs/includes/word-1_8.md | 22 +- docs/includes/word-desktop-1_1.md | 106 +- docs/includes/word-desktop-1_2.md | 232 +- docs/includes/word-preview.md | 2341 +- generate-docs/API Coverage Report.csv | 1066 +- .../api-extractor-inputs-word/word.d.ts | 50447 +++++++++------ generate-docs/configs/excel-1_1-config.json | 51 +- generate-docs/configs/excel-1_10-config.json | 49 +- generate-docs/configs/excel-1_11-config.json | 63 +- generate-docs/configs/excel-1_12-config.json | 49 +- generate-docs/configs/excel-1_13-config.json | 49 +- generate-docs/configs/excel-1_14-config.json | 49 +- generate-docs/configs/excel-1_15-config.json | 49 +- generate-docs/configs/excel-1_16-config.json | 49 +- generate-docs/configs/excel-1_17-config.json | 49 +- generate-docs/configs/excel-1_18-config.json | 49 +- generate-docs/configs/excel-1_19-config.json | 83 +- generate-docs/configs/excel-1_2-config.json | 51 +- generate-docs/configs/excel-1_20-config.json | 49 +- generate-docs/configs/excel-1_3-config.json | 51 +- generate-docs/configs/excel-1_4-config.json | 49 +- generate-docs/configs/excel-1_5-config.json | 49 +- generate-docs/configs/excel-1_6-config.json | 49 +- generate-docs/configs/excel-1_7-config.json | 49 +- generate-docs/configs/excel-1_8-config.json | 49 +- generate-docs/configs/excel-1_9-config.json | 49 +- .../configs/excel-online-config.json | 51 +- .../configs/excel-preview-config.json | 51 +- generate-docs/configs/outlook-1.1-config.json | 35 +- .../configs/outlook-1.10-config.json | 17 +- .../configs/outlook-1.11-config.json | 17 +- .../configs/outlook-1.12-config.json | 17 +- .../configs/outlook-1.13-config.json | 17 +- .../configs/outlook-1.14-config.json | 17 +- .../configs/outlook-1.15-config.json | 17 +- generate-docs/configs/outlook-1.2-config.json | 17 +- generate-docs/configs/outlook-1.3-config.json | 17 +- generate-docs/configs/outlook-1.4-config.json | 17 +- generate-docs/configs/outlook-1.5-config.json | 17 +- generate-docs/configs/outlook-1.6-config.json | 17 +- generate-docs/configs/outlook-1.7-config.json | 17 +- generate-docs/configs/outlook-1.8-config.json | 17 +- generate-docs/configs/outlook-1.9-config.json | 17 +- .../configs/outlook-preview-config.json | 37 +- .../configs/powerpoint-1_1-config.json | 49 +- .../configs/powerpoint-1_2-config.json | 49 +- .../configs/powerpoint-1_3-config.json | 49 +- .../configs/powerpoint-1_4-config.json | 49 +- .../configs/powerpoint-1_5-config.json | 49 +- .../configs/powerpoint-1_6-config.json | 49 +- .../configs/powerpoint-1_7-config.json | 49 +- .../configs/powerpoint-1_8-config.json | 49 +- .../configs/powerpoint-1_9-config.json | 49 +- .../configs/powerpoint-preview-config.json | 51 +- generate-docs/configs/word-1_1-config.json | 49 +- generate-docs/configs/word-1_2-config.json | 49 +- generate-docs/configs/word-1_3-config.json | 49 +- .../word-1_3_hidden_document-config.json | 51 +- generate-docs/configs/word-1_4-config.json | 49 +- .../word-1_4_hidden_document-config.json | 51 +- generate-docs/configs/word-1_5-config.json | 49 +- .../word-1_5_hidden_document-config.json | 51 +- generate-docs/configs/word-1_6-config.json | 49 +- generate-docs/configs/word-1_7-config.json | 49 +- generate-docs/configs/word-1_8-config.json | 49 +- .../configs/word-desktop-1_1-config.json | 85 +- .../configs/word-desktop-1_2-config.json | 51 +- generate-docs/configs/word-online-config.json | 51 +- .../configs/word-preview-config.json | 51 +- .../script-inputs/office_preview.d.ts | 50817 ++++++++++------ 335 files changed, 98815 insertions(+), 45778 deletions(-) create mode 100644 docs/docs-ref-autogen/word/word/word.autofitbehavior.yml create mode 100644 docs/docs-ref-autogen/word/word/word.calendartypebidirectional.yml create mode 100644 docs/docs-ref-autogen/word/word/word.captionlabeltype.yml create mode 100644 docs/docs-ref-autogen/word/word/word.captionposition.yml create mode 100644 docs/docs-ref-autogen/word/word/word.coauthor.yml create mode 100644 docs/docs-ref-autogen/word/word/word.coauthorcollection.yml create mode 100644 docs/docs-ref-autogen/word/word/word.coauthoring.yml create mode 100644 docs/docs-ref-autogen/word/word/word.coauthoringlock.yml create mode 100644 docs/docs-ref-autogen/word/word/word.coauthoringlockaddoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.coauthoringlockcollection.yml create mode 100644 docs/docs-ref-autogen/word/word/word.coauthoringlocktype.yml create mode 100644 docs/docs-ref-autogen/word/word/word.coauthoringupdate.yml create mode 100644 docs/docs-ref-autogen/word/word/word.coauthoringupdatecollection.yml create mode 100644 docs/docs-ref-autogen/word/word/word.collapsedirection.yml create mode 100644 docs/docs-ref-autogen/word/word/word.conditionalstyle.yml create mode 100644 docs/docs-ref-autogen/word/word/word.conditioncode.yml create mode 100644 docs/docs-ref-autogen/word/word/word.conflict.yml create mode 100644 docs/docs-ref-autogen/word/word/word.conflictcollection.yml create mode 100644 docs/docs-ref-autogen/word/word/word.datelanguage.yml create mode 100644 docs/docs-ref-autogen/word/word/word.defaulttablebehavior.yml create mode 100644 docs/docs-ref-autogen/word/word/word.deletecells.yml create mode 100644 docs/docs-ref-autogen/word/word/word.editor.yml create mode 100644 docs/docs-ref-autogen/word/word/word.editorcollection.yml create mode 100644 docs/docs-ref-autogen/word/word/word.editortype.yml create mode 100644 docs/docs-ref-autogen/word/word/word.endnotelocation.yml create mode 100644 docs/docs-ref-autogen/word/word/word.fontbias.yml create mode 100644 docs/docs-ref-autogen/word/word/word.fontnamecollection.yml create mode 100644 docs/docs-ref-autogen/word/word/word.footnotelocation.yml create mode 100644 docs/docs-ref-autogen/word/word/word.gotodirection.yml create mode 100644 docs/docs-ref-autogen/word/word/word.gotoitem.yml create mode 100644 docs/docs-ref-autogen/word/word/word.headingstyle.yml create mode 100644 docs/docs-ref-autogen/word/word/word.headingstylecollection.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.coauthorcollectiondata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.coauthorcollectionloadoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.coauthorcollectionupdatedata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.coauthordata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.coauthoringdata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.coauthoringloadoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.coauthoringlockcollectiondata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.coauthoringlockcollectionloadoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.coauthoringlockcollectionupdatedata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.coauthoringlockdata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.coauthoringlockloadoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.coauthoringlockupdatedata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.coauthoringupdatecollectiondata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.coauthoringupdatecollectionloadoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.coauthoringupdatecollectionupdatedata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.coauthoringupdatedata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.coauthoringupdateloadoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.coauthoringupdateupdatedata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.coauthorloadoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.conditionalstyledata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.conditionalstyleloadoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.conditionalstyleupdatedata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.conflictcollectiondata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.conflictcollectionloadoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.conflictcollectionupdatedata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.conflictdata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.conflictloadoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.conflictupdatedata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.editordata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.editorloadoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.editorupdatedata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.headingstylecollectiondata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.headingstylecollectionloadoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.headingstylecollectionupdatedata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.headingstyledata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.headingstyleloadoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.headingstyleupdatedata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.listtemplatecollectiondata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.listtemplatecollectionloadoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.listtemplatecollectionupdatedata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.listtemplategallerycollectiondata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.listtemplategallerycollectionupdatedata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.listtemplategallerydata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.panecollectionloadoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.paneloadoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.rangescopedcollectiondata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.rangescopedcollectionloadoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.rangescopedcollectionupdatedata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.revisioncollectiondata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.revisioncollectionloadoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.revisioncollectionupdatedata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.revisiondata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.revisionloadoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.revisionupdatedata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.selectiondata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.selectionloadoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.selectionupdatedata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.tableofauthoritiescategorycollectiondata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.tableofauthoritiescategorycollectionloadoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.tableofauthoritiescategorycollectionupdatedata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.tableofauthoritiescategorydata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.tableofauthoritiescategoryloadoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.tableofauthoritiescollectiondata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.tableofauthoritiescollectionloadoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.tableofauthoritiescollectionupdatedata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.tableofauthoritiesdata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.tableofauthoritiesloadoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.tableofauthoritiesupdatedata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.tableofcontentscollectiondata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.tableofcontentscollectionloadoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.tableofcontentscollectionupdatedata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.tableofcontentsdata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.tableofcontentsloadoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.tableofcontentsupdatedata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.tableoffigurescollectiondata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.tableoffigurescollectionloadoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.tableoffigurescollectionupdatedata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.tableoffiguresdata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.tableoffiguresloadoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.interfaces.tableoffiguresupdatedata.yml create mode 100644 docs/docs-ref-autogen/word/word/word.listtemplatecollection.yml create mode 100644 docs/docs-ref-autogen/word/word/word.listtemplatecollectionaddoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.listtemplategallery.yml create mode 100644 docs/docs-ref-autogen/word/word/word.listtemplategallerycollection.yml create mode 100644 docs/docs-ref-autogen/word/word/word.listtemplategallerytype.yml create mode 100644 docs/docs-ref-autogen/word/word/word.movementtype.yml create mode 100644 docs/docs-ref-autogen/word/word/word.notenumberstyle.yml create mode 100644 docs/docs-ref-autogen/word/word/word.operationunit.yml create mode 100644 docs/docs-ref-autogen/word/word/word.pastedatatype.yml create mode 100644 docs/docs-ref-autogen/word/word/word.pasteformattype.yml create mode 100644 docs/docs-ref-autogen/word/word/word.rangescopedcollection.yml create mode 100644 docs/docs-ref-autogen/word/word/word.referencekind.yml create mode 100644 docs/docs-ref-autogen/word/word/word.referencetype.yml create mode 100644 docs/docs-ref-autogen/word/word/word.revision.yml create mode 100644 docs/docs-ref-autogen/word/word/word.revisioncollection.yml create mode 100644 docs/docs-ref-autogen/word/word/word.rowheightrule.yml create mode 100644 docs/docs-ref-autogen/word/word/word.selection.yml create mode 100644 docs/docs-ref-autogen/word/word/word.selectionconverttotableoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.selectiondeleteoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.selectiongotooptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.selectioninsertcrossreferenceoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.selectioninsertdatetimeoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.selectioninsertformulaoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.selectioninsertsymboloptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.selectionmoveleftrightoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.selectionmoveoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.selectionmovestartendoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.selectionmoveupdownoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.selectionnextoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.selectionpreviousoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.selectiontype.yml create mode 100644 docs/docs-ref-autogen/word/word/word.sortfieldtype.yml create mode 100644 docs/docs-ref-autogen/word/word/word.sortorder.yml create mode 100644 docs/docs-ref-autogen/word/word/word.tableautoformatoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.tablecellcollectionsplitoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.tablecellformulaoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.tablecellinsertionlocation.yml create mode 100644 docs/docs-ref-autogen/word/word/word.tableconverttotextoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.tabledirection.yml create mode 100644 docs/docs-ref-autogen/word/word/word.tablefieldseparator.yml create mode 100644 docs/docs-ref-autogen/word/word/word.tableformat.yml create mode 100644 docs/docs-ref-autogen/word/word/word.tableformattype.yml create mode 100644 docs/docs-ref-autogen/word/word/word.tableofauthorities.yml create mode 100644 docs/docs-ref-autogen/word/word/word.tableofauthoritiesaddoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.tableofauthoritiescategory.yml create mode 100644 docs/docs-ref-autogen/word/word/word.tableofauthoritiescategorycollection.yml create mode 100644 docs/docs-ref-autogen/word/word/word.tableofauthoritiescollection.yml create mode 100644 docs/docs-ref-autogen/word/word/word.tableofauthoritiesmarkcitationoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.tableofcontents.yml create mode 100644 docs/docs-ref-autogen/word/word/word.tableofcontentsaddoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.tableofcontentscollection.yml create mode 100644 docs/docs-ref-autogen/word/word/word.tableofcontentsmarkentryoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.tableoffigures.yml create mode 100644 docs/docs-ref-autogen/word/word/word.tableoffiguresaddoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.tableoffigurescollection.yml create mode 100644 docs/docs-ref-autogen/word/word/word.tablesortoptions.yml create mode 100644 docs/docs-ref-autogen/word/word/word.textorientation.yml diff --git a/docs/docs-ref-autogen/word/toc.yml b/docs/docs-ref-autogen/word/toc.yml index 5563e4799d..6fb05f0081 100644 --- a/docs/docs-ref-autogen/word/toc.yml +++ b/docs/docs-ref-autogen/word/toc.yml @@ -29,6 +29,8 @@ items: uid: word!Word.ArrowheadStyle:enum - name: ArrowheadWidth uid: word!Word.ArrowheadWidth:enum + - name: AutoFitBehavior + uid: word!Word.AutoFitBehavior:enum - name: BaselineAlignment uid: word!Word.BaselineAlignment:enum - name: BevelType @@ -51,6 +53,12 @@ items: uid: word!Word.BuiltInStyleName:enum - name: CalendarType uid: word!Word.CalendarType:enum + - name: CalendarTypeBidirectional + uid: word!Word.CalendarTypeBidirectional:enum + - name: CaptionLabelType + uid: word!Word.CaptionLabelType:enum + - name: CaptionPosition + uid: word!Word.CaptionPosition:enum - name: CellPaddingLocation uid: word!Word.CellPaddingLocation:enum - name: ChangeTrackingMode @@ -65,6 +73,10 @@ items: uid: word!Word.CharacterWidth:enum - name: CloseBehavior uid: word!Word.CloseBehavior:enum + - name: CoauthoringLockType + uid: word!Word.CoauthoringLockType:enum + - name: CollapseDirection + uid: word!Word.CollapseDirection:enum - name: ColorIndex uid: word!Word.ColorIndex:enum - name: ColorType @@ -75,6 +87,8 @@ items: uid: word!Word.CommentChangeType:enum - name: CompareTarget uid: word!Word.CompareTarget:enum + - name: ConditionCode + uid: word!Word.ConditionCode:enum - name: ContentControlAppearance uid: word!Word.ContentControlAppearance:enum - name: ContentControlDateStorageFormat @@ -93,16 +107,26 @@ items: uid: word!Word.CustomXmlNodeType:enum - name: CustomXmlValidationErrorType uid: word!Word.CustomXmlValidationErrorType:enum + - name: DateLanguage + uid: word!Word.DateLanguage:enum - name: DefaultListBehavior uid: word!Word.DefaultListBehavior:enum + - name: DefaultTableBehavior + uid: word!Word.DefaultTableBehavior:enum + - name: DeleteCells + uid: word!Word.DeleteCells:enum - name: DocPartInsertType uid: word!Word.DocPartInsertType:enum - name: DocumentPropertyType uid: word!Word.DocumentPropertyType:enum - name: DropPosition uid: word!Word.DropPosition:enum + - name: EditorType + uid: word!Word.EditorType:enum - name: EmphasisMark uid: word!Word.EmphasisMark:enum + - name: EndnoteLocation + uid: word!Word.EndnoteLocation:enum - name: ErrorCodes uid: word!Word.ErrorCodes:enum - name: EventSource @@ -125,10 +149,18 @@ items: uid: word!Word.FillType:enum - name: FlowDirection uid: word!Word.FlowDirection:enum + - name: FontBias + uid: word!Word.FontBias:enum + - name: FootnoteLocation + uid: word!Word.FootnoteLocation:enum - name: FrameSizeRule uid: word!Word.FrameSizeRule:enum - name: GeometricShapeType uid: word!Word.GeometricShapeType:enum + - name: GoToDirection + uid: word!Word.GoToDirection:enum + - name: GoToItem + uid: word!Word.GoToItem:enum - name: GradientColorType uid: word!Word.GradientColorType:enum - name: GradientStyle @@ -193,12 +225,18 @@ items: uid: word!Word.ListLevelType:enum - name: ListNumbering uid: word!Word.ListNumbering:enum + - name: ListTemplateGalleryType + uid: word!Word.ListTemplateGalleryType:enum - name: ListType uid: word!Word.ListType:enum - name: LocationRelation uid: word!Word.LocationRelation:enum + - name: MovementType + uid: word!Word.MovementType:enum - name: NoteItemType uid: word!Word.NoteItemType:enum + - name: NoteNumberStyle + uid: word!Word.NoteNumberStyle:enum - name: NumberForm uid: word!Word.NumberForm:enum - name: NumberingRule @@ -209,6 +247,8 @@ items: uid: word!Word.NumberType:enum - name: OleVerb uid: word!Word.OleVerb:enum + - name: OperationUnit + uid: word!Word.OperationUnit:enum - name: OutlineLevel uid: word!Word.OutlineLevel:enum - name: PageBorderArt @@ -223,6 +263,10 @@ items: uid: word!Word.PageSetupVerticalAlignment:enum - name: PaperSize uid: word!Word.PaperSize:enum + - name: PasteDataType + uid: word!Word.PasteDataType:enum + - name: PasteFormatType + uid: word!Word.PasteFormatType:enum - name: PatternType uid: word!Word.PatternType:enum - name: PreferredWidthType @@ -249,6 +293,10 @@ items: uid: word!Word.ReadingLayoutMargin:enum - name: ReadingOrder uid: word!Word.ReadingOrder:enum + - name: ReferenceKind + uid: word!Word.ReferenceKind:enum + - name: ReferenceType + uid: word!Word.ReferenceType:enum - name: ReflectionType uid: word!Word.ReflectionType:enum - name: RelativeHorizontalPosition @@ -269,6 +317,8 @@ items: uid: word!Word.RevisionsView:enum - name: RevisionType uid: word!Word.RevisionType:enum + - name: RowHeightRule + uid: word!Word.RowHeightRule:enum - name: RulerStyle uid: word!Word.RulerStyle:enum - name: SaveBehavior @@ -283,6 +333,8 @@ items: uid: word!Word.SeekView:enum - name: SelectionMode uid: word!Word.SelectionMode:enum + - name: SelectionType + uid: word!Word.SelectionType:enum - name: ShadingTextureType uid: word!Word.ShadingTextureType:enum - name: ShadowStyle @@ -309,6 +361,10 @@ items: uid: word!Word.ShapeType:enum - name: ShowSourceDocuments uid: word!Word.ShowSourceDocuments:enum + - name: SortFieldType + uid: word!Word.SortFieldType:enum + - name: SortOrder + uid: word!Word.SortOrder:enum - name: SpecialPane uid: word!Word.SpecialPane:enum - name: StoryType @@ -321,10 +377,22 @@ items: uid: word!Word.TabAlignment:enum - name: TabLeader uid: word!Word.TabLeader:enum + - name: TableCellInsertionLocation + uid: word!Word.TableCellInsertionLocation:enum + - name: TableDirection + uid: word!Word.TableDirection:enum + - name: TableFieldSeparator + uid: word!Word.TableFieldSeparator:enum + - name: TableFormat + uid: word!Word.TableFormat:enum + - name: TableFormatType + uid: word!Word.TableFormatType:enum - name: TemplateType uid: word!Word.TemplateType:enum - name: TextboxTightWrap uid: word!Word.TextboxTightWrap:enum + - name: TextOrientation + uid: word!Word.TextOrientation:enum - name: TextureAlignment uid: word!Word.TextureAlignment:enum - name: TextureType @@ -407,6 +475,22 @@ items: uid: word!Word.Canvas:class - name: CheckboxContentControl uid: word!Word.CheckboxContentControl:class + - name: Coauthor + uid: word!Word.Coauthor:class + - name: CoauthorCollection + uid: word!Word.CoauthorCollection:class + - name: Coauthoring + uid: word!Word.Coauthoring:class + - name: CoauthoringLock + uid: word!Word.CoauthoringLock:class + - name: CoauthoringLockAddOptions + uid: word!Word.CoauthoringLockAddOptions:interface + - name: CoauthoringLockCollection + uid: word!Word.CoauthoringLockCollection:class + - name: CoauthoringUpdate + uid: word!Word.CoauthoringUpdate:class + - name: CoauthoringUpdateCollection + uid: word!Word.CoauthoringUpdateCollection:class - name: ColorFormat uid: word!Word.ColorFormat:class - name: ComboBoxContentControl @@ -425,6 +509,12 @@ items: uid: word!Word.CommentReply:class - name: CommentReplyCollection uid: word!Word.CommentReplyCollection:class + - name: ConditionalStyle + uid: word!Word.ConditionalStyle:class + - name: Conflict + uid: word!Word.Conflict:class + - name: ConflictCollection + uid: word!Word.ConflictCollection:class - name: ContentControl uid: word!Word.ContentControl:class - name: ContentControlAddedEventArgs @@ -513,6 +603,10 @@ items: uid: word!Word.DropCap:class - name: DropDownListContentControl uid: word!Word.DropDownListContentControl:class + - name: Editor + uid: word!Word.Editor:class + - name: EditorCollection + uid: word!Word.EditorCollection:class - name: Field uid: word!Word.Field:class - name: FieldCollection @@ -521,6 +615,8 @@ items: uid: word!Word.FillFormat:class - name: Font uid: word!Word.Font:class + - name: FontNameCollection + uid: word!Word.FontNameCollection:class - name: Frame uid: word!Word.Frame:class - name: FrameCollection @@ -531,6 +627,10 @@ items: uid: word!Word.GlowFormat:class - name: GroupContentControl uid: word!Word.GroupContentControl:class + - name: HeadingStyle + uid: word!Word.HeadingStyle:class + - name: HeadingStyleCollection + uid: word!Word.HeadingStyleCollection:class - name: Hyperlink uid: word!Word.Hyperlink:class - name: HyperlinkAddOptions @@ -579,6 +679,14 @@ items: uid: word!Word.ListTemplate:class - name: ListTemplateApplyOptions uid: word!Word.ListTemplateApplyOptions:interface + - name: ListTemplateCollection + uid: word!Word.ListTemplateCollection:class + - name: ListTemplateCollectionAddOptions + uid: word!Word.ListTemplateCollectionAddOptions:interface + - name: ListTemplateGallery + uid: word!Word.ListTemplateGallery:class + - name: ListTemplateGalleryCollection + uid: word!Word.ListTemplateGalleryCollection:class - name: NoteItem uid: word!Word.NoteItem:class - name: NoteItemCollection @@ -613,6 +721,8 @@ items: uid: word!Word.Range:class - name: RangeCollection uid: word!Word.RangeCollection:class + - name: RangeScopedCollection + uid: word!Word.RangeScopedCollection:class - name: ReflectionFormat uid: word!Word.ReflectionFormat:class - name: RepeatingSectionContentControl @@ -627,6 +737,10 @@ items: uid: word!Word.Reviewer:class - name: ReviewerCollection uid: word!Word.ReviewerCollection:class + - name: Revision + uid: word!Word.Revision:class + - name: RevisionCollection + uid: word!Word.RevisionCollection:class - name: RevisionsFilter uid: word!Word.RevisionsFilter:class - name: SearchOptions @@ -635,6 +749,34 @@ items: uid: word!Word.Section:class - name: SectionCollection uid: word!Word.SectionCollection:class + - name: Selection + uid: word!Word.Selection:class + - name: SelectionConvertToTableOptions + uid: word!Word.SelectionConvertToTableOptions:interface + - name: SelectionDeleteOptions + uid: word!Word.SelectionDeleteOptions:interface + - name: SelectionGoToOptions + uid: word!Word.SelectionGoToOptions:interface + - name: SelectionInsertCrossReferenceOptions + uid: word!Word.SelectionInsertCrossReferenceOptions:interface + - name: SelectionInsertDateTimeOptions + uid: word!Word.SelectionInsertDateTimeOptions:interface + - name: SelectionInsertFormulaOptions + uid: word!Word.SelectionInsertFormulaOptions:interface + - name: SelectionInsertSymbolOptions + uid: word!Word.SelectionInsertSymbolOptions:interface + - name: SelectionMoveLeftRightOptions + uid: word!Word.SelectionMoveLeftRightOptions:interface + - name: SelectionMoveOptions + uid: word!Word.SelectionMoveOptions:interface + - name: SelectionMoveStartEndOptions + uid: word!Word.SelectionMoveStartEndOptions:interface + - name: SelectionMoveUpDownOptions + uid: word!Word.SelectionMoveUpDownOptions:interface + - name: SelectionNextOptions + uid: word!Word.SelectionNextOptions:interface + - name: SelectionPreviousOptions + uid: word!Word.SelectionPreviousOptions:interface - name: Setting uid: word!Word.Setting:class - name: SettingCollection @@ -665,22 +807,58 @@ items: uid: word!Word.StyleCollection:class - name: Table uid: word!Word.Table:class + - name: TableAutoFormatOptions + uid: word!Word.TableAutoFormatOptions:interface - name: TableBorder uid: word!Word.TableBorder:class - name: TableCell uid: word!Word.TableCell:class - name: TableCellCollection uid: word!Word.TableCellCollection:class + - name: TableCellCollectionSplitOptions + uid: word!Word.TableCellCollectionSplitOptions:interface + - name: TableCellFormulaOptions + uid: word!Word.TableCellFormulaOptions:interface - name: TableCollection uid: word!Word.TableCollection:class - name: TableColumn uid: word!Word.TableColumn:class - name: TableColumnCollection uid: word!Word.TableColumnCollection:class + - name: TableConvertToTextOptions + uid: word!Word.TableConvertToTextOptions:interface + - name: TableOfAuthorities + uid: word!Word.TableOfAuthorities:class + - name: TableOfAuthoritiesAddOptions + uid: word!Word.TableOfAuthoritiesAddOptions:interface + - name: TableOfAuthoritiesCategory + uid: word!Word.TableOfAuthoritiesCategory:class + - name: TableOfAuthoritiesCategoryCollection + uid: word!Word.TableOfAuthoritiesCategoryCollection:class + - name: TableOfAuthoritiesCollection + uid: word!Word.TableOfAuthoritiesCollection:class + - name: TableOfAuthoritiesMarkCitationOptions + uid: word!Word.TableOfAuthoritiesMarkCitationOptions:interface + - name: TableOfContents + uid: word!Word.TableOfContents:class + - name: TableOfContentsAddOptions + uid: word!Word.TableOfContentsAddOptions:interface + - name: TableOfContentsCollection + uid: word!Word.TableOfContentsCollection:class + - name: TableOfContentsMarkEntryOptions + uid: word!Word.TableOfContentsMarkEntryOptions:interface + - name: TableOfFigures + uid: word!Word.TableOfFigures:class + - name: TableOfFiguresAddOptions + uid: word!Word.TableOfFiguresAddOptions:interface + - name: TableOfFiguresCollection + uid: word!Word.TableOfFiguresCollection:class - name: TableRow uid: word!Word.TableRow:class - name: TableRowCollection uid: word!Word.TableRowCollection:class + - name: TableSortOptions + uid: word!Word.TableSortOptions:interface - name: TableStyle uid: word!Word.TableStyle:class - name: TabStop diff --git a/docs/docs-ref-autogen/word/word.yml b/docs/docs-ref-autogen/word/word.yml index 03da487b9a..007b6ca362 100644 --- a/docs/docs-ref-autogen/word/word.yml +++ b/docs/docs-ref-autogen/word/word.yml @@ -9,6 +9,7 @@ enums: - word!Word.ArrowheadLength:enum - word!Word.ArrowheadStyle:enum - word!Word.ArrowheadWidth:enum + - word!Word.AutoFitBehavior:enum - word!Word.BaselineAlignment:enum - word!Word.BevelType:enum - word!Word.BodyType:enum @@ -20,6 +21,9 @@ enums: - word!Word.BuildingBlockType:enum - word!Word.BuiltInStyleName:enum - word!Word.CalendarType:enum + - word!Word.CalendarTypeBidirectional:enum + - word!Word.CaptionLabelType:enum + - word!Word.CaptionPosition:enum - word!Word.CellPaddingLocation:enum - word!Word.ChangeTrackingMode:enum - word!Word.ChangeTrackingState:enum @@ -27,11 +31,14 @@ enums: - word!Word.CharacterCase:enum - word!Word.CharacterWidth:enum - word!Word.CloseBehavior:enum + - word!Word.CoauthoringLockType:enum + - word!Word.CollapseDirection:enum - word!Word.ColorIndex:enum - word!Word.ColorType:enum - word!Word.ColumnWidth:enum - word!Word.CommentChangeType:enum - word!Word.CompareTarget:enum + - word!Word.ConditionCode:enum - word!Word.ContentControlAppearance:enum - word!Word.ContentControlDateStorageFormat:enum - word!Word.ContentControlLevel:enum @@ -41,11 +48,16 @@ enums: - word!Word.CritiqueColorScheme:enum - word!Word.CustomXmlNodeType:enum - word!Word.CustomXmlValidationErrorType:enum + - word!Word.DateLanguage:enum - word!Word.DefaultListBehavior:enum + - word!Word.DefaultTableBehavior:enum + - word!Word.DeleteCells:enum - word!Word.DocPartInsertType:enum - word!Word.DocumentPropertyType:enum - word!Word.DropPosition:enum + - word!Word.EditorType:enum - word!Word.EmphasisMark:enum + - word!Word.EndnoteLocation:enum - word!Word.ErrorCodes:enum - word!Word.EventSource:enum - word!Word.EventType:enum @@ -57,8 +69,12 @@ enums: - word!Word.FieldType:enum - word!Word.FillType:enum - word!Word.FlowDirection:enum + - word!Word.FontBias:enum + - word!Word.FootnoteLocation:enum - word!Word.FrameSizeRule:enum - word!Word.GeometricShapeType:enum + - word!Word.GoToDirection:enum + - word!Word.GoToItem:enum - word!Word.GradientColorType:enum - word!Word.GradientStyle:enum - word!Word.GutterPosition:enum @@ -91,14 +107,18 @@ enums: - word!Word.ListBullet:enum - word!Word.ListLevelType:enum - word!Word.ListNumbering:enum + - word!Word.ListTemplateGalleryType:enum - word!Word.ListType:enum - word!Word.LocationRelation:enum + - word!Word.MovementType:enum - word!Word.NoteItemType:enum + - word!Word.NoteNumberStyle:enum - word!Word.NumberForm:enum - word!Word.NumberingRule:enum - word!Word.NumberSpacing:enum - word!Word.NumberType:enum - word!Word.OleVerb:enum + - word!Word.OperationUnit:enum - word!Word.OutlineLevel:enum - word!Word.PageBorderArt:enum - word!Word.PageColor:enum @@ -106,6 +126,8 @@ enums: - word!Word.PageOrientation:enum - word!Word.PageSetupVerticalAlignment:enum - word!Word.PaperSize:enum + - word!Word.PasteDataType:enum + - word!Word.PasteFormatType:enum - word!Word.PatternType:enum - word!Word.PreferredWidthType:enum - word!Word.PresetCamera:enum @@ -119,6 +141,8 @@ enums: - word!Word.RangeLocation:enum - word!Word.ReadingLayoutMargin:enum - word!Word.ReadingOrder:enum + - word!Word.ReferenceKind:enum + - word!Word.ReferenceType:enum - word!Word.ReflectionType:enum - word!Word.RelativeHorizontalPosition:enum - word!Word.RelativeSize:enum @@ -129,6 +153,7 @@ enums: - word!Word.RevisionsMode:enum - word!Word.RevisionsView:enum - word!Word.RevisionType:enum + - word!Word.RowHeightRule:enum - word!Word.RulerStyle:enum - word!Word.SaveBehavior:enum - word!Word.SaveConfiguration:enum @@ -136,6 +161,7 @@ enums: - word!Word.SectionStart:enum - word!Word.SeekView:enum - word!Word.SelectionMode:enum + - word!Word.SelectionType:enum - word!Word.ShadingTextureType:enum - word!Word.ShadowStyle:enum - word!Word.ShadowType:enum @@ -149,14 +175,22 @@ enums: - word!Word.ShapeTextWrapType:enum - word!Word.ShapeType:enum - word!Word.ShowSourceDocuments:enum + - word!Word.SortFieldType:enum + - word!Word.SortOrder:enum - word!Word.SpecialPane:enum - word!Word.StoryType:enum - word!Word.StyleType:enum - word!Word.StylisticSet:enum - word!Word.TabAlignment:enum - word!Word.TabLeader:enum + - word!Word.TableCellInsertionLocation:enum + - word!Word.TableDirection:enum + - word!Word.TableFieldSeparator:enum + - word!Word.TableFormat:enum + - word!Word.TableFormatType:enum - word!Word.TemplateType:enum - word!Word.TextboxTightWrap:enum + - word!Word.TextOrientation:enum - word!Word.TextureAlignment:enum - word!Word.TextureType:enum - word!Word.ThemeColorIndex:enum @@ -193,6 +227,13 @@ classes: - word!Word.BuildingBlockTypeItemCollection:class - word!Word.Canvas:class - word!Word.CheckboxContentControl:class + - word!Word.Coauthor:class + - word!Word.CoauthorCollection:class + - word!Word.Coauthoring:class + - word!Word.CoauthoringLock:class + - word!Word.CoauthoringLockCollection:class + - word!Word.CoauthoringUpdate:class + - word!Word.CoauthoringUpdateCollection:class - word!Word.ColorFormat:class - word!Word.ComboBoxContentControl:class - word!Word.Comment:class @@ -200,6 +241,9 @@ classes: - word!Word.CommentContentRange:class - word!Word.CommentReply:class - word!Word.CommentReplyCollection:class + - word!Word.ConditionalStyle:class + - word!Word.Conflict:class + - word!Word.ConflictCollection:class - word!Word.ContentControl:class - word!Word.ContentControlCollection:class - word!Word.ContentControlListItem:class @@ -226,14 +270,19 @@ classes: - word!Word.DocumentProperties:class - word!Word.DropCap:class - word!Word.DropDownListContentControl:class + - word!Word.Editor:class + - word!Word.EditorCollection:class - word!Word.Field:class - word!Word.FieldCollection:class - word!Word.FillFormat:class - word!Word.Font:class + - word!Word.FontNameCollection:class - word!Word.Frame:class - word!Word.FrameCollection:class - word!Word.GlowFormat:class - word!Word.GroupContentControl:class + - word!Word.HeadingStyle:class + - word!Word.HeadingStyleCollection:class - word!Word.Hyperlink:class - word!Word.HyperlinkCollection:class - word!Word.Index:class @@ -250,6 +299,9 @@ classes: - word!Word.ListLevel:class - word!Word.ListLevelCollection:class - word!Word.ListTemplate:class + - word!Word.ListTemplateCollection:class + - word!Word.ListTemplateGallery:class + - word!Word.ListTemplateGalleryCollection:class - word!Word.NoteItem:class - word!Word.NoteItemCollection:class - word!Word.OleFormat:class @@ -264,6 +316,7 @@ classes: - word!Word.PictureContentControl:class - word!Word.Range:class - word!Word.RangeCollection:class + - word!Word.RangeScopedCollection:class - word!Word.ReflectionFormat:class - word!Word.RepeatingSectionContentControl:class - word!Word.RepeatingSectionItem:class @@ -271,10 +324,13 @@ classes: - word!Word.RequestContext:class - word!Word.Reviewer:class - word!Word.ReviewerCollection:class + - word!Word.Revision:class + - word!Word.RevisionCollection:class - word!Word.RevisionsFilter:class - word!Word.SearchOptions:class - word!Word.Section:class - word!Word.SectionCollection:class + - word!Word.Selection:class - word!Word.Setting:class - word!Word.SettingCollection:class - word!Word.Shading:class @@ -296,6 +352,14 @@ classes: - word!Word.TableCollection:class - word!Word.TableColumn:class - word!Word.TableColumnCollection:class + - word!Word.TableOfAuthorities:class + - word!Word.TableOfAuthoritiesCategory:class + - word!Word.TableOfAuthoritiesCategoryCollection:class + - word!Word.TableOfAuthoritiesCollection:class + - word!Word.TableOfContents:class + - word!Word.TableOfContentsCollection:class + - word!Word.TableOfFigures:class + - word!Word.TableOfFiguresCollection:class - word!Word.TableRow:class - word!Word.TableRowCollection:class - word!Word.TableStyle:class @@ -320,6 +384,7 @@ interfaces: - word!Word.AnnotationPopupActionEventArgs:interface - word!Word.AnnotationRemovedEventArgs:interface - word!Word.AnnotationSet:interface + - word!Word.CoauthoringLockAddOptions:interface - word!Word.CommentDetail:interface - word!Word.CommentEventArgs:interface - word!Word.ContentControlAddedEventArgs:interface @@ -401,6 +466,25 @@ interfaces: - word!Word.Interfaces.CheckboxContentControlData:interface - word!Word.Interfaces.CheckboxContentControlLoadOptions:interface - word!Word.Interfaces.CheckboxContentControlUpdateData:interface + - word!Word.Interfaces.CoauthorCollectionData:interface + - word!Word.Interfaces.CoauthorCollectionLoadOptions:interface + - word!Word.Interfaces.CoauthorCollectionUpdateData:interface + - word!Word.Interfaces.CoauthorData:interface + - word!Word.Interfaces.CoauthoringData:interface + - word!Word.Interfaces.CoauthoringLoadOptions:interface + - word!Word.Interfaces.CoauthoringLockCollectionData:interface + - word!Word.Interfaces.CoauthoringLockCollectionLoadOptions:interface + - word!Word.Interfaces.CoauthoringLockCollectionUpdateData:interface + - word!Word.Interfaces.CoauthoringLockData:interface + - word!Word.Interfaces.CoauthoringLockLoadOptions:interface + - word!Word.Interfaces.CoauthoringLockUpdateData:interface + - word!Word.Interfaces.CoauthoringUpdateCollectionData:interface + - word!Word.Interfaces.CoauthoringUpdateCollectionLoadOptions:interface + - word!Word.Interfaces.CoauthoringUpdateCollectionUpdateData:interface + - word!Word.Interfaces.CoauthoringUpdateData:interface + - word!Word.Interfaces.CoauthoringUpdateLoadOptions:interface + - word!Word.Interfaces.CoauthoringUpdateUpdateData:interface + - word!Word.Interfaces.CoauthorLoadOptions:interface - word!Word.Interfaces.CollectionLoadOptions:interface - word!Word.Interfaces.ColorFormatData:interface - word!Word.Interfaces.ColorFormatLoadOptions:interface @@ -421,6 +505,15 @@ interfaces: - word!Word.Interfaces.CommentReplyLoadOptions:interface - word!Word.Interfaces.CommentReplyUpdateData:interface - word!Word.Interfaces.CommentUpdateData:interface + - word!Word.Interfaces.ConditionalStyleData:interface + - word!Word.Interfaces.ConditionalStyleLoadOptions:interface + - word!Word.Interfaces.ConditionalStyleUpdateData:interface + - word!Word.Interfaces.ConflictCollectionData:interface + - word!Word.Interfaces.ConflictCollectionLoadOptions:interface + - word!Word.Interfaces.ConflictCollectionUpdateData:interface + - word!Word.Interfaces.ConflictData:interface + - word!Word.Interfaces.ConflictLoadOptions:interface + - word!Word.Interfaces.ConflictUpdateData:interface - word!Word.Interfaces.ContentControlCollectionData:interface - word!Word.Interfaces.ContentControlCollectionLoadOptions:interface - word!Word.Interfaces.ContentControlCollectionUpdateData:interface @@ -492,6 +585,9 @@ interfaces: - word!Word.Interfaces.DropCapData:interface - word!Word.Interfaces.DropCapLoadOptions:interface - word!Word.Interfaces.DropDownListContentControlData:interface + - word!Word.Interfaces.EditorData:interface + - word!Word.Interfaces.EditorLoadOptions:interface + - word!Word.Interfaces.EditorUpdateData:interface - word!Word.Interfaces.FieldCollectionData:interface - word!Word.Interfaces.FieldCollectionLoadOptions:interface - word!Word.Interfaces.FieldCollectionUpdateData:interface @@ -516,6 +612,12 @@ interfaces: - word!Word.Interfaces.GroupContentControlData:interface - word!Word.Interfaces.GroupContentControlLoadOptions:interface - word!Word.Interfaces.GroupContentControlUpdateData:interface + - word!Word.Interfaces.HeadingStyleCollectionData:interface + - word!Word.Interfaces.HeadingStyleCollectionLoadOptions:interface + - word!Word.Interfaces.HeadingStyleCollectionUpdateData:interface + - word!Word.Interfaces.HeadingStyleData:interface + - word!Word.Interfaces.HeadingStyleLoadOptions:interface + - word!Word.Interfaces.HeadingStyleUpdateData:interface - word!Word.Interfaces.HyperlinkCollectionData:interface - word!Word.Interfaces.HyperlinkCollectionLoadOptions:interface - word!Word.Interfaces.HyperlinkCollectionUpdateData:interface @@ -560,7 +662,13 @@ interfaces: - word!Word.Interfaces.ListLevelLoadOptions:interface - word!Word.Interfaces.ListLevelUpdateData:interface - word!Word.Interfaces.ListLoadOptions:interface + - word!Word.Interfaces.ListTemplateCollectionData:interface + - word!Word.Interfaces.ListTemplateCollectionLoadOptions:interface + - word!Word.Interfaces.ListTemplateCollectionUpdateData:interface - word!Word.Interfaces.ListTemplateData:interface + - word!Word.Interfaces.ListTemplateGalleryCollectionData:interface + - word!Word.Interfaces.ListTemplateGalleryCollectionUpdateData:interface + - word!Word.Interfaces.ListTemplateGalleryData:interface - word!Word.Interfaces.ListTemplateLoadOptions:interface - word!Word.Interfaces.ListTemplateUpdateData:interface - word!Word.Interfaces.NoteItemCollectionData:interface @@ -581,8 +689,10 @@ interfaces: - word!Word.Interfaces.PageSetupLoadOptions:interface - word!Word.Interfaces.PageSetupUpdateData:interface - word!Word.Interfaces.PaneCollectionData:interface + - word!Word.Interfaces.PaneCollectionLoadOptions:interface - word!Word.Interfaces.PaneCollectionUpdateData:interface - word!Word.Interfaces.PaneData:interface + - word!Word.Interfaces.PaneLoadOptions:interface - word!Word.Interfaces.ParagraphCollectionData:interface - word!Word.Interfaces.ParagraphCollectionLoadOptions:interface - word!Word.Interfaces.ParagraphCollectionUpdateData:interface @@ -600,6 +710,9 @@ interfaces: - word!Word.Interfaces.RangeCollectionUpdateData:interface - word!Word.Interfaces.RangeData:interface - word!Word.Interfaces.RangeLoadOptions:interface + - word!Word.Interfaces.RangeScopedCollectionData:interface + - word!Word.Interfaces.RangeScopedCollectionLoadOptions:interface + - word!Word.Interfaces.RangeScopedCollectionUpdateData:interface - word!Word.Interfaces.RangeUpdateData:interface - word!Word.Interfaces.ReflectionFormatData:interface - word!Word.Interfaces.ReflectionFormatLoadOptions:interface @@ -616,9 +729,15 @@ interfaces: - word!Word.Interfaces.ReviewerData:interface - word!Word.Interfaces.ReviewerLoadOptions:interface - word!Word.Interfaces.ReviewerUpdateData:interface + - word!Word.Interfaces.RevisionCollectionData:interface + - word!Word.Interfaces.RevisionCollectionLoadOptions:interface + - word!Word.Interfaces.RevisionCollectionUpdateData:interface + - word!Word.Interfaces.RevisionData:interface + - word!Word.Interfaces.RevisionLoadOptions:interface - word!Word.Interfaces.RevisionsFilterData:interface - word!Word.Interfaces.RevisionsFilterLoadOptions:interface - word!Word.Interfaces.RevisionsFilterUpdateData:interface + - word!Word.Interfaces.RevisionUpdateData:interface - word!Word.Interfaces.SearchOptionsData:interface - word!Word.Interfaces.SearchOptionsLoadOptions:interface - word!Word.Interfaces.SearchOptionsUpdateData:interface @@ -628,6 +747,9 @@ interfaces: - word!Word.Interfaces.SectionData:interface - word!Word.Interfaces.SectionLoadOptions:interface - word!Word.Interfaces.SectionUpdateData:interface + - word!Word.Interfaces.SelectionData:interface + - word!Word.Interfaces.SelectionLoadOptions:interface + - word!Word.Interfaces.SelectionUpdateData:interface - word!Word.Interfaces.SettingCollectionData:interface - word!Word.Interfaces.SettingCollectionLoadOptions:interface - word!Word.Interfaces.SettingCollectionUpdateData:interface @@ -689,6 +811,31 @@ interfaces: - word!Word.Interfaces.TableColumnUpdateData:interface - word!Word.Interfaces.TableData:interface - word!Word.Interfaces.TableLoadOptions:interface + - word!Word.Interfaces.TableOfAuthoritiesCategoryCollectionData:interface + - >- + word!Word.Interfaces.TableOfAuthoritiesCategoryCollectionLoadOptions:interface + - >- + word!Word.Interfaces.TableOfAuthoritiesCategoryCollectionUpdateData:interface + - word!Word.Interfaces.TableOfAuthoritiesCategoryData:interface + - word!Word.Interfaces.TableOfAuthoritiesCategoryLoadOptions:interface + - word!Word.Interfaces.TableOfAuthoritiesCollectionData:interface + - word!Word.Interfaces.TableOfAuthoritiesCollectionLoadOptions:interface + - word!Word.Interfaces.TableOfAuthoritiesCollectionUpdateData:interface + - word!Word.Interfaces.TableOfAuthoritiesData:interface + - word!Word.Interfaces.TableOfAuthoritiesLoadOptions:interface + - word!Word.Interfaces.TableOfAuthoritiesUpdateData:interface + - word!Word.Interfaces.TableOfContentsCollectionData:interface + - word!Word.Interfaces.TableOfContentsCollectionLoadOptions:interface + - word!Word.Interfaces.TableOfContentsCollectionUpdateData:interface + - word!Word.Interfaces.TableOfContentsData:interface + - word!Word.Interfaces.TableOfContentsLoadOptions:interface + - word!Word.Interfaces.TableOfContentsUpdateData:interface + - word!Word.Interfaces.TableOfFiguresCollectionData:interface + - word!Word.Interfaces.TableOfFiguresCollectionLoadOptions:interface + - word!Word.Interfaces.TableOfFiguresCollectionUpdateData:interface + - word!Word.Interfaces.TableOfFiguresData:interface + - word!Word.Interfaces.TableOfFiguresLoadOptions:interface + - word!Word.Interfaces.TableOfFiguresUpdateData:interface - word!Word.Interfaces.TableRowCollectionData:interface - word!Word.Interfaces.TableRowCollectionLoadOptions:interface - word!Word.Interfaces.TableRowCollectionUpdateData:interface @@ -741,9 +888,33 @@ interfaces: - word!Word.Interfaces.XmlMappingUpdateData:interface - word!Word.ListFormatCountNumberedItemsOptions:interface - word!Word.ListTemplateApplyOptions:interface + - word!Word.ListTemplateCollectionAddOptions:interface - word!Word.ParagraphAddedEventArgs:interface - word!Word.ParagraphChangedEventArgs:interface - word!Word.ParagraphDeletedEventArgs:interface + - word!Word.SelectionConvertToTableOptions:interface + - word!Word.SelectionDeleteOptions:interface + - word!Word.SelectionGoToOptions:interface + - word!Word.SelectionInsertCrossReferenceOptions:interface + - word!Word.SelectionInsertDateTimeOptions:interface + - word!Word.SelectionInsertFormulaOptions:interface + - word!Word.SelectionInsertSymbolOptions:interface + - word!Word.SelectionMoveLeftRightOptions:interface + - word!Word.SelectionMoveOptions:interface + - word!Word.SelectionMoveStartEndOptions:interface + - word!Word.SelectionMoveUpDownOptions:interface + - word!Word.SelectionNextOptions:interface + - word!Word.SelectionPreviousOptions:interface + - word!Word.TableAutoFormatOptions:interface + - word!Word.TableCellCollectionSplitOptions:interface + - word!Word.TableCellFormulaOptions:interface + - word!Word.TableConvertToTextOptions:interface + - word!Word.TableOfAuthoritiesAddOptions:interface + - word!Word.TableOfAuthoritiesMarkCitationOptions:interface + - word!Word.TableOfContentsAddOptions:interface + - word!Word.TableOfContentsMarkEntryOptions:interface + - word!Word.TableOfFiguresAddOptions:interface + - word!Word.TableSortOptions:interface - word!Word.TabStopAddOptions:interface - word!Word.TextColumnAddOptions:interface - word!Word.WindowCloseOptions:interface diff --git a/docs/docs-ref-autogen/word/word/word.application.yml b/docs/docs-ref-autogen/word/word/word.application.yml index 51b3b97d9a..97b5095465 100644 --- a/docs/docs-ref-autogen/word/word/word.application.yml +++ b/docs/docs-ref-autogen/word/word/word.application.yml @@ -97,6 +97,23 @@ properties: content: 'context: RequestContext;' return: type: + - name: fontNames + uid: word!Word.Application#fontNames:member + package: word! + fullName: fontNames + summary: >- + Returns a `FontNameCollection` object that represents all the available + font names in Microsoft Word. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly fontNames: Word.FontNameCollection;' + return: + type: - name: language uid: word!Word.Application#language:member package: word! @@ -211,6 +228,23 @@ properties: "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu" + - name: listTemplateGalleries + uid: word!Word.Application#listTemplateGalleries:member + package: word! + fullName: listTemplateGalleries + summary: >- + Returns a `ListTemplateGalleryCollection` object that represents all the + list template galleries in Microsoft Word. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly listTemplateGalleries: Word.ListTemplateGalleryCollection;' + return: + type: - name: templates uid: word!Word.Application#templates:member package: word! diff --git a/docs/docs-ref-autogen/word/word/word.autofitbehavior.yml b/docs/docs-ref-autogen/word/word/word.autofitbehavior.yml new file mode 100644 index 0000000000..ef3b4254f9 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.autofitbehavior.yml @@ -0,0 +1,43 @@ +### YamlMime:TSEnum +name: Word.AutoFitBehavior +uid: word!Word.AutoFitBehavior:enum +package: word! +fullName: Word.AutoFitBehavior +summary: Specifies how a table is resized to fit its contents or the window. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: content + uid: word!Word.AutoFitBehavior.content:member + package: word! + summary: >- + Automatically resizes the table columns to fit the contents. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Content"' + - name: fixedSize + uid: word!Word.AutoFitBehavior.fixedSize:member + package: word! + summary: >- + Disables automatic resizing. The table retains its current size. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"FixedSize"' + - name: window + uid: word!Word.AutoFitBehavior.window:member + package: word! + summary: >- + Automatically resizes the table to fit the window width. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Window"' diff --git a/docs/docs-ref-autogen/word/word/word.calendartypebidirectional.yml b/docs/docs-ref-autogen/word/word/word.calendartypebidirectional.yml new file mode 100644 index 0000000000..5ff0f6ad8f --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.calendartypebidirectional.yml @@ -0,0 +1,33 @@ +### YamlMime:TSEnum +name: Word.CalendarTypeBidirectional +uid: word!Word.CalendarTypeBidirectional:enum +package: word! +fullName: Word.CalendarTypeBidirectional +summary: Specifies the type of bidirectional calendar to use. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: bidirectional + uid: word!Word.CalendarTypeBidirectional.bidirectional:member + package: word! + summary: >- + Uses the Bidirectional calendar. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Bidirectional"' + - name: gregorian + uid: word!Word.CalendarTypeBidirectional.gregorian:member + package: word! + summary: >- + Uses the Gregorian calendar. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Gregorian"' diff --git a/docs/docs-ref-autogen/word/word/word.captionlabeltype.yml b/docs/docs-ref-autogen/word/word/word.captionlabeltype.yml new file mode 100644 index 0000000000..9b39421179 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.captionlabeltype.yml @@ -0,0 +1,43 @@ +### YamlMime:TSEnum +name: Word.CaptionLabelType +uid: word!Word.CaptionLabelType:enum +package: word! +fullName: Word.CaptionLabelType +summary: Specifies the type of caption label to use. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: equation + uid: word!Word.CaptionLabelType.equation:member + package: word! + summary: >- + Specifies an equation caption label. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Equation"' + - name: figure + uid: word!Word.CaptionLabelType.figure:member + package: word! + summary: >- + Specifies a figure caption label. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Figure"' + - name: table + uid: word!Word.CaptionLabelType.table:member + package: word! + summary: >- + Specifies a table caption label. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Table"' diff --git a/docs/docs-ref-autogen/word/word/word.captionposition.yml b/docs/docs-ref-autogen/word/word/word.captionposition.yml new file mode 100644 index 0000000000..35d0e5af91 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.captionposition.yml @@ -0,0 +1,33 @@ +### YamlMime:TSEnum +name: Word.CaptionPosition +uid: word!Word.CaptionPosition:enum +package: word! +fullName: Word.CaptionPosition +summary: Specifies the position of a caption relative to the object it describes. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: above + uid: word!Word.CaptionPosition.above:member + package: word! + summary: >- + Places the caption above the selected item. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Above"' + - name: below + uid: word!Word.CaptionPosition.below:member + package: word! + summary: >- + Places the caption below the selected item. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Below"' diff --git a/docs/docs-ref-autogen/word/word/word.coauthor.yml b/docs/docs-ref-autogen/word/word/word.coauthor.yml new file mode 100644 index 0000000000..5da5868b01 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.coauthor.yml @@ -0,0 +1,247 @@ +### YamlMime:TSType +name: Word.Coauthor +uid: word!Word.Coauthor:class +package: word! +fullName: Word.Coauthor +summary: Represents a coauthor in a Word document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: class +properties: + - name: context + uid: word!Word.Coauthor#context:member + package: word! + 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: true + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: emailAddress + uid: word!Word.Coauthor#emailAddress:member + package: word! + fullName: emailAddress + summary: Gets the email address of the coauthor. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly emailAddress: string;' + return: + type: string + - name: id + uid: word!Word.Coauthor#id:member + package: word! + fullName: id + summary: Gets the unique identifier for the `Coauthor` object. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly id: string;' + return: + type: string + - name: isMe + uid: word!Word.Coauthor#isMe:member + package: word! + fullName: isMe + summary: Gets whether this author represents the current user. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly isMe: boolean;' + return: + type: boolean + - name: locks + uid: word!Word.Coauthor#locks:member + package: word! + fullName: locks + summary: >- + Gets a `CoauthoringLockCollection` object that represents the locks in the + document that are associated with this coauthor. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly locks: Word.CoauthoringLockCollection;' + return: + type: + - name: name + uid: word!Word.Coauthor#name:member + package: word! + fullName: name + summary: Gets the display name of the coauthor. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly name: string;' + return: + type: string +methods: + - name: load(options) + uid: word!Word.Coauthor#load:member(1) + package: word! + 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: true + isDeprecated: false + syntax: + content: 'load(options?: Word.Interfaces.CoauthorLoadOptions): Word.Coauthor;' + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: + return: + type: + description: '' + - name: load(propertyNames) + uid: word!Word.Coauthor#load:member(2) + package: word! + 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: true + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Word.Coauthor;' + 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: word!Word.Coauthor#load:member(3) + package: word! + 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: true + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Coauthor; + 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: word!Word.Coauthor#toJSON:member(1) + package: word! + 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 `Word.Coauthor` object + is an API object, the `toJSON` method returns a plain JavaScript object + (typed as `Word.Interfaces.CoauthorData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'toJSON(): Word.Interfaces.CoauthorData;' + return: + type: + description: '' + - name: track() + uid: word!Word.Coauthor#track:member(1) + package: word! + fullName: track() + summary: >- + Track the object for automatic adjustment based on surrounding changes in + the document. This call is a shorthand for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). If you're using this object across `.sync` calls and outside the + sequential execution of a ".run" batch, and get an "InvalidObjectPath" + error when setting a property or invoking a method on the object, you need + to add the object to the tracked object collection when the object was + first created. If this object is part of a collection, you should also + track the parent collection. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'track(): Word.Coauthor;' + return: + type: + description: '' + - name: untrack() + uid: word!Word.Coauthor#untrack:member(1) + package: word! + fullName: untrack() + summary: >- + Release the memory associated with this object, if it has previously been + tracked. This call is shorthand for + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). Having many tracked objects slows down the host application, so + please remember to free any objects you add, once you're done using them. + You'll need to call `context.sync()` before the memory release takes + effect. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'untrack(): Word.Coauthor;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/word/word/word.coauthorcollection.yml b/docs/docs-ref-autogen/word/word/word.coauthorcollection.yml new file mode 100644 index 0000000000..4325da9f4a --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.coauthorcollection.yml @@ -0,0 +1,187 @@ +### YamlMime:TSType +name: Word.CoauthorCollection +uid: word!Word.CoauthorCollection:class +package: word! +fullName: Word.CoauthorCollection +summary: >- + Contains a collection of [Word.Coauthor](xref:word!Word.Coauthor:class) + objects. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: class +properties: + - name: context + uid: word!Word.CoauthorCollection#context:member + package: word! + 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: true + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: word!Word.CoauthorCollection#items:member + package: word! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly items: Word.Coauthor[];' + return: + type: [] +methods: + - name: load(options) + uid: word!Word.CoauthorCollection#load:member(1) + package: word! + 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: true + isDeprecated: false + syntax: + content: >- + load(options?: Word.Interfaces.CoauthorCollectionLoadOptions & + Word.Interfaces.CollectionLoadOptions): Word.CoauthorCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: word!Word.CoauthorCollection#load:member(2) + package: word! + 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: true + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Word.CoauthorCollection;' + 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: word!Word.CoauthorCollection#load:member(3) + package: word! + 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: true + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Word.CoauthorCollection; + 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: word!Word.CoauthorCollection#toJSON:member(1) + package: word! + 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 + `Word.CoauthorCollection` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Word.Interfaces.CoauthorCollectionData`) that contains an "items" + array with shallow copies of any loaded properties from the collection's + items. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'toJSON(): Word.Interfaces.CoauthorCollectionData;' + return: + type: + description: '' + - name: track() + uid: word!Word.CoauthorCollection#track:member(1) + package: word! + fullName: track() + summary: >- + Track the object for automatic adjustment based on surrounding changes in + the document. This call is a shorthand for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). If you're using this object across `.sync` calls and outside the + sequential execution of a ".run" batch, and get an "InvalidObjectPath" + error when setting a property or invoking a method on the object, you need + to add the object to the tracked object collection when the object was + first created. If this object is part of a collection, you should also + track the parent collection. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'track(): Word.CoauthorCollection;' + return: + type: + description: '' + - name: untrack() + uid: word!Word.CoauthorCollection#untrack:member(1) + package: word! + fullName: untrack() + summary: >- + Release the memory associated with this object, if it has previously been + tracked. This call is shorthand for + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). Having many tracked objects slows down the host application, so + please remember to free any objects you add, once you're done using them. + You'll need to call `context.sync()` before the memory release takes + effect. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'untrack(): Word.CoauthorCollection;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/word/word/word.coauthoring.yml b/docs/docs-ref-autogen/word/word/word.coauthoring.yml new file mode 100644 index 0000000000..b4aa19a96c --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.coauthoring.yml @@ -0,0 +1,302 @@ +### YamlMime:TSType +name: Word.Coauthoring +uid: word!Word.Coauthoring:class +package: word! +fullName: Word.Coauthoring +summary: >- + Represents the `Coauthoring` object. This tracks the updates, changes, + conflicts, and other interactions in the document done through coauthoring. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: class +properties: + - name: authors + uid: word!Word.Coauthoring#authors:member + package: word! + fullName: authors + summary: >- + Gets a `CoauthorCollection` object that represents all the coauthors + currently editing the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly authors: Word.CoauthorCollection;' + return: + type: + - name: canCoauthor + uid: word!Word.Coauthoring#canCoauthor:member + package: word! + fullName: canCoauthor + summary: Gets whether this document can be coauthored. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly canCoauthor: boolean;' + return: + type: boolean + - name: canMerge + uid: word!Word.Coauthoring#canMerge:member + package: word! + fullName: canMerge + summary: Gets whether the document can be automatically merged. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly canMerge: boolean;' + return: + type: boolean + - name: conflicts + uid: word!Word.Coauthoring#conflicts:member + package: word! + fullName: conflicts + summary: >- + Gets a `ConflictCollection` object that represents all the conflicts in + the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly conflicts: Word.ConflictCollection;' + return: + type: + - name: context + uid: word!Word.Coauthoring#context:member + package: word! + 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: true + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: locks + uid: word!Word.Coauthoring#locks:member + package: word! + fullName: locks + summary: >- + Gets a `CoauthoringLockCollection` object that represents the locks in the + document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly locks: Word.CoauthoringLockCollection;' + return: + type: + - name: me + uid: word!Word.Coauthoring#me:member + package: word! + fullName: me + summary: Gets a `Coauthor` object that represents the current user. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly me: Word.Coauthor;' + return: + type: + - name: pendingUpdates + uid: word!Word.Coauthoring#pendingUpdates:member + package: word! + fullName: pendingUpdates + summary: Gets whether the document has pending updates that have not been accepted. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly pendingUpdates: boolean;' + return: + type: boolean + - name: updates + uid: word!Word.Coauthoring#updates:member + package: word! + fullName: updates + summary: >- + Gets a `CoauthoringUpdateCollection` object that represents the most + recent updates that were merged into the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly updates: Word.CoauthoringUpdateCollection;' + return: + type: +methods: + - name: load(options) + uid: word!Word.Coauthoring#load:member(1) + package: word! + 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: true + isDeprecated: false + syntax: + content: >- + load(options?: Word.Interfaces.CoauthoringLoadOptions): + Word.Coauthoring; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: + return: + type: + description: '' + - name: load(propertyNames) + uid: word!Word.Coauthoring#load:member(2) + package: word! + 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: true + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Word.Coauthoring;' + 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: word!Word.Coauthoring#load:member(3) + package: word! + 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: true + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Coauthoring; + 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: word!Word.Coauthoring#toJSON:member(1) + package: word! + 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 `Word.Coauthoring` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Word.Interfaces.CoauthoringData`) that contains + shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'toJSON(): Word.Interfaces.CoauthoringData;' + return: + type: + description: '' + - name: track() + uid: word!Word.Coauthoring#track:member(1) + package: word! + fullName: track() + summary: >- + Track the object for automatic adjustment based on surrounding changes in + the document. This call is a shorthand for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). If you're using this object across `.sync` calls and outside the + sequential execution of a ".run" batch, and get an "InvalidObjectPath" + error when setting a property or invoking a method on the object, you need + to add the object to the tracked object collection when the object was + first created. If this object is part of a collection, you should also + track the parent collection. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'track(): Word.Coauthoring;' + return: + type: + description: '' + - name: untrack() + uid: word!Word.Coauthoring#untrack:member(1) + package: word! + fullName: untrack() + summary: >- + Release the memory associated with this object, if it has previously been + tracked. This call is shorthand for + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). Having many tracked objects slows down the host application, so + please remember to free any objects you add, once you're done using them. + You'll need to call `context.sync()` before the memory release takes + effect. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'untrack(): Word.Coauthoring;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/word/word/word.coauthoringlock.yml b/docs/docs-ref-autogen/word/word/word.coauthoringlock.yml new file mode 100644 index 0000000000..567dd45fbc --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.coauthoringlock.yml @@ -0,0 +1,295 @@ +### YamlMime:TSType +name: Word.CoauthoringLock +uid: word!Word.CoauthoringLock:class +package: word! +fullName: Word.CoauthoringLock +summary: Represents a coauthoring lock in a Word document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: class +properties: + - name: context + uid: word!Word.CoauthoringLock#context:member + package: word! + 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: true + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: owner + uid: word!Word.CoauthoringLock#owner:member + package: word! + fullName: owner + summary: Gets the owner of the lock. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly owner: Word.Coauthor;' + return: + type: + - name: range + uid: word!Word.CoauthoringLock#range:member + package: word! + fullName: range + summary: >- + Gets a `Range` object that represents the portion of the document that's + contained in the `CoauthoringLock` object. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly range: Word.Range;' + return: + type: + - name: type + uid: word!Word.CoauthoringLock#type:member + package: word! + fullName: type + summary: Gets a `CoauthoringLockType` value that represents the lock type. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + readonly type: Word.CoauthoringLockType | "None" | "Reservation" | + "Ephemeral" | "Changed"; + return: + type: >- + | "None" | + "Reservation" | "Ephemeral" | "Changed" +methods: + - name: load(options) + uid: word!Word.CoauthoringLock#load:member(1) + package: word! + 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: true + isDeprecated: false + syntax: + content: >- + load(options?: Word.Interfaces.CoauthoringLockLoadOptions): + Word.CoauthoringLock; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: word!Word.CoauthoringLock#load:member(2) + package: word! + 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: true + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Word.CoauthoringLock;' + 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: word!Word.CoauthoringLock#load:member(3) + package: word! + 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: true + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.CoauthoringLock; + 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(properties, options) + uid: word!Word.CoauthoringLock#set:member(1) + package: word! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.CoauthoringLockUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: word!Word.CoauthoringLock#set:member(2) + package: word! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'set(properties: Word.CoauthoringLock): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: word!Word.CoauthoringLock#toJSON:member(1) + package: word! + 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 `Word.CoauthoringLock` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Word.Interfaces.CoauthoringLockData`) that + contains shallow copies of any loaded child properties from the original + object. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'toJSON(): Word.Interfaces.CoauthoringLockData;' + return: + type: + description: '' + - name: track() + uid: word!Word.CoauthoringLock#track:member(1) + package: word! + fullName: track() + summary: >- + Track the object for automatic adjustment based on surrounding changes in + the document. This call is a shorthand for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). If you're using this object across `.sync` calls and outside the + sequential execution of a ".run" batch, and get an "InvalidObjectPath" + error when setting a property or invoking a method on the object, you need + to add the object to the tracked object collection when the object was + first created. If this object is part of a collection, you should also + track the parent collection. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'track(): Word.CoauthoringLock;' + return: + type: + description: '' + - name: unlock() + uid: word!Word.CoauthoringLock#unlock:member(1) + package: word! + fullName: unlock() + summary: Removes this lock, even if it belongs to a different user. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'unlock(): void;' + return: + type: void + description: '' + - name: untrack() + uid: word!Word.CoauthoringLock#untrack:member(1) + package: word! + fullName: untrack() + summary: >- + Release the memory associated with this object, if it has previously been + tracked. This call is shorthand for + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). Having many tracked objects slows down the host application, so + please remember to free any objects you add, once you're done using them. + You'll need to call `context.sync()` before the memory release takes + effect. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'untrack(): Word.CoauthoringLock;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/word/word/word.coauthoringlockaddoptions.yml b/docs/docs-ref-autogen/word/word/word.coauthoringlockaddoptions.yml new file mode 100644 index 0000000000..ba19e798f1 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.coauthoringlockaddoptions.yml @@ -0,0 +1,56 @@ +### YamlMime:TSType +name: Word.CoauthoringLockAddOptions +uid: word!Word.CoauthoringLockAddOptions:interface +package: word! +fullName: Word.CoauthoringLockAddOptions +summary: >- + Specifies the options for adding to a + [Word.CoauthoringLockCollection](xref:word!Word.CoauthoringLockCollection:class) + object. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: range + uid: word!Word.CoauthoringLockAddOptions#range:member + package: word! + fullName: range + summary: >- + If provided, specifies the range to which the lock is added. If not + provided, the new lock is placed on the paragraph that contains the + insertion point. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'range?: Word.Range;' + return: + type: + - name: type + uid: word!Word.CoauthoringLockAddOptions#type:member + package: word! + fullName: type + summary: >- + If provided, specifies the type of lock. If not provided, the lock type is + set to `reservation`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + type?: Word.CoauthoringLockType | "None" | "Reservation" | "Ephemeral" | + "Changed"; + return: + type: >- + | "None" | + "Reservation" | "Ephemeral" | "Changed" diff --git a/docs/docs-ref-autogen/word/word/word.coauthoringlockcollection.yml b/docs/docs-ref-autogen/word/word/word.coauthoringlockcollection.yml new file mode 100644 index 0000000000..c2d02af3fb --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.coauthoringlockcollection.yml @@ -0,0 +1,225 @@ +### YamlMime:TSType +name: Word.CoauthoringLockCollection +uid: word!Word.CoauthoringLockCollection:class +package: word! +fullName: Word.CoauthoringLockCollection +summary: Represents a collection of coauthoring locks in a Word document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: class +properties: + - name: context + uid: word!Word.CoauthoringLockCollection#context:member + package: word! + 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: true + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: word!Word.CoauthoringLockCollection#items:member + package: word! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly items: Word.CoauthoringLock[];' + return: + type: [] +methods: + - name: add(options) + uid: word!Word.CoauthoringLockCollection#add:member(1) + package: word! + fullName: add(options) + summary: >- + Returns a `CoauthoringLock` object that represents a lock added to a + specified range. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'add(options?: Word.CoauthoringLockAddOptions): Word.CoauthoringLock;' + parameters: + - id: options + description: Optional. The options to further configure the coauthoring lock. + type: + return: + type: + description: '' + - name: load(options) + uid: word!Word.CoauthoringLockCollection#load:member(1) + package: word! + 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: true + isDeprecated: false + syntax: + content: >- + load(options?: Word.Interfaces.CoauthoringLockCollectionLoadOptions & + Word.Interfaces.CollectionLoadOptions): Word.CoauthoringLockCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: word!Word.CoauthoringLockCollection#load:member(2) + package: word! + 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: true + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Word.CoauthoringLockCollection;' + 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: word!Word.CoauthoringLockCollection#load:member(3) + package: word! + 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: true + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Word.CoauthoringLockCollection; + 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: word!Word.CoauthoringLockCollection#toJSON:member(1) + package: word! + 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 + `Word.CoauthoringLockCollection` object is an API object, the `toJSON` + method returns a plain JavaScript object (typed as + `Word.Interfaces.CoauthoringLockCollectionData`) that contains an + "items" array with shallow copies of any loaded properties from the + collection's items. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'toJSON(): Word.Interfaces.CoauthoringLockCollectionData;' + return: + type: >- + + description: '' + - name: track() + uid: word!Word.CoauthoringLockCollection#track:member(1) + package: word! + fullName: track() + summary: >- + Track the object for automatic adjustment based on surrounding changes in + the document. This call is a shorthand for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). If you're using this object across `.sync` calls and outside the + sequential execution of a ".run" batch, and get an "InvalidObjectPath" + error when setting a property or invoking a method on the object, you need + to add the object to the tracked object collection when the object was + first created. If this object is part of a collection, you should also + track the parent collection. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'track(): Word.CoauthoringLockCollection;' + return: + type: + description: '' + - name: unlockEphemeralLocks() + uid: word!Word.CoauthoringLockCollection#unlockEphemeralLocks:member(1) + package: word! + fullName: unlockEphemeralLocks() + summary: Removes all ephemeral locks from the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'unlockEphemeralLocks(): void;' + return: + type: void + description: '' + - name: untrack() + uid: word!Word.CoauthoringLockCollection#untrack:member(1) + package: word! + fullName: untrack() + summary: >- + Release the memory associated with this object, if it has previously been + tracked. This call is shorthand for + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). Having many tracked objects slows down the host application, so + please remember to free any objects you add, once you're done using them. + You'll need to call `context.sync()` before the memory release takes + effect. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'untrack(): Word.CoauthoringLockCollection;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/word/word/word.coauthoringlocktype.yml b/docs/docs-ref-autogen/word/word/word.coauthoringlocktype.yml new file mode 100644 index 0000000000..8a1200b549 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.coauthoringlocktype.yml @@ -0,0 +1,55 @@ +### YamlMime:TSEnum +name: Word.CoauthoringLockType +uid: word!Word.CoauthoringLockType:enum +package: word! +fullName: Word.CoauthoringLockType +summary: >- + Represents the types of [coauthoring + locks](xref:word!Word.CoauthoringLock:class). +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: changed + uid: word!Word.CoauthoringLockType.changed:member + package: word! + summary: >- + Represents that the lock has changed. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Changed"' + - name: ephemeral + uid: word!Word.CoauthoringLockType.ephemeral:member + package: word! + summary: >- + Represents that the lock is ephemeral. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Ephemeral"' + - name: none + uid: word!Word.CoauthoringLockType.none:member + package: word! + summary: >- + Reserved for future use. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"None"' + - name: reservation + uid: word!Word.CoauthoringLockType.reservation:member + package: word! + summary: >- + Represents that the lock is a reservation. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Reservation"' diff --git a/docs/docs-ref-autogen/word/word/word.coauthoringupdate.yml b/docs/docs-ref-autogen/word/word/word.coauthoringupdate.yml new file mode 100644 index 0000000000..8727602796 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.coauthoringupdate.yml @@ -0,0 +1,245 @@ +### YamlMime:TSType +name: Word.CoauthoringUpdate +uid: word!Word.CoauthoringUpdate:class +package: word! +fullName: Word.CoauthoringUpdate +summary: Represents a coauthoring update in a Word document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: class +properties: + - name: context + uid: word!Word.CoauthoringUpdate#context:member + package: word! + 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: true + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: range + uid: word!Word.CoauthoringUpdate#range:member + package: word! + fullName: range + summary: >- + Gets a `Range` object that represents the portion of the document that's + contained in the `CoauthoringUpdate` object. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly range: Word.Range;' + return: + type: +methods: + - name: load(options) + uid: word!Word.CoauthoringUpdate#load:member(1) + package: word! + 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: true + isDeprecated: false + syntax: + content: >- + load(options?: Word.Interfaces.CoauthoringUpdateLoadOptions): + Word.CoauthoringUpdate; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: word!Word.CoauthoringUpdate#load:member(2) + package: word! + 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: true + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Word.CoauthoringUpdate;' + 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: word!Word.CoauthoringUpdate#load:member(3) + package: word! + 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: true + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.CoauthoringUpdate; + 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(properties, options) + uid: word!Word.CoauthoringUpdate#set:member(1) + package: word! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.CoauthoringUpdateUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: word!Word.CoauthoringUpdate#set:member(2) + package: word! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'set(properties: Word.CoauthoringUpdate): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: word!Word.CoauthoringUpdate#toJSON:member(1) + package: word! + 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 `Word.CoauthoringUpdate` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Word.Interfaces.CoauthoringUpdateData`) that + contains shallow copies of any loaded child properties from the original + object. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'toJSON(): Word.Interfaces.CoauthoringUpdateData;' + return: + type: + description: '' + - name: track() + uid: word!Word.CoauthoringUpdate#track:member(1) + package: word! + fullName: track() + summary: >- + Track the object for automatic adjustment based on surrounding changes in + the document. This call is a shorthand for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). If you're using this object across `.sync` calls and outside the + sequential execution of a ".run" batch, and get an "InvalidObjectPath" + error when setting a property or invoking a method on the object, you need + to add the object to the tracked object collection when the object was + first created. If this object is part of a collection, you should also + track the parent collection. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'track(): Word.CoauthoringUpdate;' + return: + type: + description: '' + - name: untrack() + uid: word!Word.CoauthoringUpdate#untrack:member(1) + package: word! + fullName: untrack() + summary: >- + Release the memory associated with this object, if it has previously been + tracked. This call is shorthand for + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). Having many tracked objects slows down the host application, so + please remember to free any objects you add, once you're done using them. + You'll need to call `context.sync()` before the memory release takes + effect. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'untrack(): Word.CoauthoringUpdate;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/word/word/word.coauthoringupdatecollection.yml b/docs/docs-ref-autogen/word/word/word.coauthoringupdatecollection.yml new file mode 100644 index 0000000000..98b0e0abcd --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.coauthoringupdatecollection.yml @@ -0,0 +1,193 @@ +### YamlMime:TSType +name: Word.CoauthoringUpdateCollection +uid: word!Word.CoauthoringUpdateCollection:class +package: word! +fullName: Word.CoauthoringUpdateCollection +summary: >- + Contains a collection of + [Word.CoauthoringUpdate](xref:word!Word.CoauthoringUpdate:class) objects. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: class +properties: + - name: context + uid: word!Word.CoauthoringUpdateCollection#context:member + package: word! + 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: true + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: word!Word.CoauthoringUpdateCollection#items:member + package: word! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly items: Word.CoauthoringUpdate[];' + return: + type: [] +methods: + - name: load(options) + uid: word!Word.CoauthoringUpdateCollection#load:member(1) + package: word! + 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: true + isDeprecated: false + syntax: + content: >- + load(options?: Word.Interfaces.CoauthoringUpdateCollectionLoadOptions & + Word.Interfaces.CollectionLoadOptions): + Word.CoauthoringUpdateCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: word!Word.CoauthoringUpdateCollection#load:member(2) + package: word! + 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: true + isDeprecated: false + syntax: + content: >- + load(propertyNames?: string | string[]): + Word.CoauthoringUpdateCollection; + 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: word!Word.CoauthoringUpdateCollection#load:member(3) + package: word! + 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: true + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Word.CoauthoringUpdateCollection; + 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: word!Word.CoauthoringUpdateCollection#toJSON:member(1) + package: word! + 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 + `Word.CoauthoringUpdateCollection` object is an API object, the `toJSON` + method returns a plain JavaScript object (typed as + `Word.Interfaces.CoauthoringUpdateCollectionData`) that contains + an "items" array with shallow copies of any loaded properties from the + collection's items. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'toJSON(): Word.Interfaces.CoauthoringUpdateCollectionData;' + return: + type: >- + + description: '' + - name: track() + uid: word!Word.CoauthoringUpdateCollection#track:member(1) + package: word! + fullName: track() + summary: >- + Track the object for automatic adjustment based on surrounding changes in + the document. This call is a shorthand for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). If you're using this object across `.sync` calls and outside the + sequential execution of a ".run" batch, and get an "InvalidObjectPath" + error when setting a property or invoking a method on the object, you need + to add the object to the tracked object collection when the object was + first created. If this object is part of a collection, you should also + track the parent collection. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'track(): Word.CoauthoringUpdateCollection;' + return: + type: + description: '' + - name: untrack() + uid: word!Word.CoauthoringUpdateCollection#untrack:member(1) + package: word! + fullName: untrack() + summary: >- + Release the memory associated with this object, if it has previously been + tracked. This call is shorthand for + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). Having many tracked objects slows down the host application, so + please remember to free any objects you add, once you're done using them. + You'll need to call `context.sync()` before the memory release takes + effect. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'untrack(): Word.CoauthoringUpdateCollection;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/word/word/word.collapsedirection.yml b/docs/docs-ref-autogen/word/word/word.collapsedirection.yml new file mode 100644 index 0000000000..f3447680cd --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.collapsedirection.yml @@ -0,0 +1,33 @@ +### YamlMime:TSEnum +name: Word.CollapseDirection +uid: word!Word.CollapseDirection:enum +package: word! +fullName: Word.CollapseDirection +summary: Specifies the direction in which to collapse a selection. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: end + uid: word!Word.CollapseDirection.end:member + package: word! + summary: >- + Collapses the selection to the end position. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"End"' + - name: start + uid: word!Word.CollapseDirection.start:member + package: word! + summary: >- + Collapses the selection to the start position. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Start"' diff --git a/docs/docs-ref-autogen/word/word/word.conditionalstyle.yml b/docs/docs-ref-autogen/word/word/word.conditionalstyle.yml new file mode 100644 index 0000000000..453d390d56 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.conditionalstyle.yml @@ -0,0 +1,313 @@ +### YamlMime:TSType +name: Word.ConditionalStyle +uid: word!Word.ConditionalStyle:class +package: word! +fullName: Word.ConditionalStyle +summary: >- + Represents special formatting applied to specified areas of a table when the + selected table is formatted with a specified table style. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: class +properties: + - name: borders + uid: word!Word.ConditionalStyle#borders:member + package: word! + fullName: borders + summary: >- + Returns a `BorderUniversalCollection` object that represents all the + borders for the conditional style. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly borders: Word.BorderUniversalCollection;' + return: + type: + - name: bottomPadding + uid: word!Word.ConditionalStyle#bottomPadding:member + package: word! + fullName: bottomPadding + summary: >- + Specifies the amount of space (in points) to add below the contents of a + single cell or all the cells in a table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'bottomPadding: number;' + return: + type: number + - name: context + uid: word!Word.ConditionalStyle#context:member + package: word! + 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: true + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: font + uid: word!Word.ConditionalStyle#font:member + package: word! + fullName: font + summary: >- + Returns a `Font` object that represents the font formatting for the + conditional style. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly font: Word.Font;' + return: + type: + - name: leftPadding + uid: word!Word.ConditionalStyle#leftPadding:member + package: word! + fullName: leftPadding + summary: >- + Specifies the amount of space (in points) to add to the left of the + contents of a single cell or all the cells in a table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'leftPadding: number;' + return: + type: number + - name: paragraphFormat + uid: word!Word.ConditionalStyle#paragraphFormat:member + package: word! + fullName: paragraphFormat + summary: >- + Returns a `ParagraphFormat` object that represents the paragraph + formatting for the conditional style. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly paragraphFormat: Word.ParagraphFormat;' + return: + type: + - name: rightPadding + uid: word!Word.ConditionalStyle#rightPadding:member + package: word! + fullName: rightPadding + summary: >- + Specifies the amount of space (in points) to add to the right of the + contents of a single cell or all the cells in a table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'rightPadding: number;' + return: + type: number + - name: shading + uid: word!Word.ConditionalStyle#shading:member + package: word! + fullName: shading + summary: >- + Returns a `ShadingUniversal` object that represents the shading of the + conditional style. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly shading: Word.ShadingUniversal;' + return: + type: + - name: topPadding + uid: word!Word.ConditionalStyle#topPadding:member + package: word! + fullName: topPadding + summary: >- + Specifies the amount of space (in points) to add above the contents of a + single cell or all the cells in a table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'topPadding: number;' + return: + type: number +methods: + - name: load(options) + uid: word!Word.ConditionalStyle#load:member(1) + package: word! + 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: true + isDeprecated: false + syntax: + content: >- + load(options?: Word.Interfaces.ConditionalStyleLoadOptions): + Word.ConditionalStyle; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: word!Word.ConditionalStyle#load:member(2) + package: word! + 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: true + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Word.ConditionalStyle;' + 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: word!Word.ConditionalStyle#load:member(3) + package: word! + 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: true + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.ConditionalStyle; + 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: word!Word.ConditionalStyle#toJSON:member(1) + package: word! + 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 `Word.ConditionalStyle` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Word.Interfaces.ConditionalStyleData`) that + contains shallow copies of any loaded child properties from the original + object. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'toJSON(): Word.Interfaces.ConditionalStyleData;' + return: + type: + description: '' + - name: track() + uid: word!Word.ConditionalStyle#track:member(1) + package: word! + fullName: track() + summary: >- + Track the object for automatic adjustment based on surrounding changes in + the document. This call is a shorthand for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). If you're using this object across `.sync` calls and outside the + sequential execution of a ".run" batch, and get an "InvalidObjectPath" + error when setting a property or invoking a method on the object, you need + to add the object to the tracked object collection when the object was + first created. If this object is part of a collection, you should also + track the parent collection. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'track(): Word.ConditionalStyle;' + return: + type: + description: '' + - name: untrack() + uid: word!Word.ConditionalStyle#untrack:member(1) + package: word! + fullName: untrack() + summary: >- + Release the memory associated with this object, if it has previously been + tracked. This call is shorthand for + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). Having many tracked objects slows down the host application, so + please remember to free any objects you add, once you're done using them. + You'll need to call `context.sync()` before the memory release takes + effect. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'untrack(): Word.ConditionalStyle;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/word/word/word.conditioncode.yml b/docs/docs-ref-autogen/word/word/word.conditioncode.yml new file mode 100644 index 0000000000..f0a69c774e --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.conditioncode.yml @@ -0,0 +1,133 @@ +### YamlMime:TSEnum +name: Word.ConditionCode +uid: word!Word.ConditionCode:enum +package: word! +fullName: Word.ConditionCode +summary: Specifies the area of a table to which to apply special style formatting. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: bottomLeftCell + uid: word!Word.ConditionCode.bottomLeftCell:member + package: word! + summary: >- + Applies formatting to first cell in the last row of the table. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"BottomLeftCell"' + - name: bottomRightCell + uid: word!Word.ConditionCode.bottomRightCell:member + package: word! + summary: >- + Applies formatting to the last cell in the table. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"BottomRightCell"' + - name: evenColumnBanding + uid: word!Word.ConditionCode.evenColumnBanding:member + package: word! + summary: >- + Applies formatting to even-numbered columns. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"EvenColumnBanding"' + - name: evenRowBanding + uid: word!Word.ConditionCode.evenRowBanding:member + package: word! + summary: >- + Applies formatting to even-numbered rows. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"EvenRowBanding"' + - name: firstColumn + uid: word!Word.ConditionCode.firstColumn:member + package: word! + summary: >- + Applies formatting to the first column in a table. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"FirstColumn"' + - name: firstRow + uid: word!Word.ConditionCode.firstRow:member + package: word! + summary: >- + Applies formatting to the first row in a table. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"FirstRow"' + - name: lastColumn + uid: word!Word.ConditionCode.lastColumn:member + package: word! + summary: >- + Applies formatting to the last column in a table. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"LastColumn"' + - name: lastRow + uid: word!Word.ConditionCode.lastRow:member + package: word! + summary: >- + Applies formatting to the last row in a table. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"LastRow"' + - name: oddColumnBanding + uid: word!Word.ConditionCode.oddColumnBanding:member + package: word! + summary: >- + Applies formatting to odd-numbered columns. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"OddColumnBanding"' + - name: oddRowBanding + uid: word!Word.ConditionCode.oddRowBanding:member + package: word! + summary: >- + Applies formatting to odd-numbered rows. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"OddRowBanding"' + - name: topLeftCell + uid: word!Word.ConditionCode.topLeftCell:member + package: word! + summary: >- + Applies formatting to the first cell in the first row. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"TopLeftCell"' + - name: topRightCell + uid: word!Word.ConditionCode.topRightCell:member + package: word! + summary: >- + Applies formatting to the last cell in the first row. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"TopRightCell"' diff --git a/docs/docs-ref-autogen/word/word/word.conflict.yml b/docs/docs-ref-autogen/word/word/word.conflict.yml new file mode 100644 index 0000000000..1bc4f130cf --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.conflict.yml @@ -0,0 +1,299 @@ +### YamlMime:TSType +name: Word.Conflict +uid: word!Word.Conflict:class +package: word! +fullName: Word.Conflict +summary: Represents a coauthoring conflict in a Word document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: class +properties: + - name: context + uid: word!Word.Conflict#context:member + package: word! + 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: true + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: range + uid: word!Word.Conflict#range:member + package: word! + fullName: range + summary: >- + Gets a `Range` object that represents the portion of the document that's + contained in the `Conflict` object. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly range: Word.Range;' + return: + type: + - name: type + uid: word!Word.Conflict#type:member + package: word! + fullName: type + summary: Gets the `RevisionType` for the `Conflict` object. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + readonly type: Word.RevisionType | "None" | "Insert" | "Delete" | + "Property" | "ParagraphNumber" | "DisplayField" | "Reconcile" | + "Conflict" | "Style" | "Replace" | "ParagraphProperty" | "TableProperty" + | "SectionProperty" | "StyleDefinition" | "MovedFrom" | "MovedTo" | + "CellInsertion" | "CellDeletion" | "CellMerge" | "CellSplit" | + "ConflictInsert" | "ConflictDelete"; + return: + type: >- + | "None" | "Insert" | + "Delete" | "Property" | "ParagraphNumber" | "DisplayField" | + "Reconcile" | "Conflict" | "Style" | "Replace" | "ParagraphProperty" | + "TableProperty" | "SectionProperty" | "StyleDefinition" | "MovedFrom" + | "MovedTo" | "CellInsertion" | "CellDeletion" | "CellMerge" | + "CellSplit" | "ConflictInsert" | "ConflictDelete" +methods: + - name: accept() + uid: word!Word.Conflict#accept:member(1) + package: word! + fullName: accept() + summary: Accepts the user's change and removes the conflict. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'accept(): void;' + return: + type: void + description: '' + - name: load(options) + uid: word!Word.Conflict#load:member(1) + package: word! + 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: true + isDeprecated: false + syntax: + content: 'load(options?: Word.Interfaces.ConflictLoadOptions): Word.Conflict;' + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: + return: + type: + description: '' + - name: load(propertyNames) + uid: word!Word.Conflict#load:member(2) + package: word! + 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: true + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Word.Conflict;' + 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: word!Word.Conflict#load:member(3) + package: word! + 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: true + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Conflict; + 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: reject() + uid: word!Word.Conflict#reject:member(1) + package: word! + fullName: reject() + summary: >- + Rejects the user's change, removes the conflict, and accepts the server + copy of the change for the conflict. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'reject(): void;' + return: + type: void + description: '' + - name: set(properties, options) + uid: word!Word.Conflict#set:member(1) + package: word! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.ConflictUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: word!Word.Conflict#set:member(2) + package: word! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'set(properties: Word.Conflict): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: word!Word.Conflict#toJSON:member(1) + package: word! + 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 `Word.Conflict` object + is an API object, the `toJSON` method returns a plain JavaScript object + (typed as `Word.Interfaces.ConflictData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'toJSON(): Word.Interfaces.ConflictData;' + return: + type: + description: '' + - name: track() + uid: word!Word.Conflict#track:member(1) + package: word! + fullName: track() + summary: >- + Track the object for automatic adjustment based on surrounding changes in + the document. This call is a shorthand for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). If you're using this object across `.sync` calls and outside the + sequential execution of a ".run" batch, and get an "InvalidObjectPath" + error when setting a property or invoking a method on the object, you need + to add the object to the tracked object collection when the object was + first created. If this object is part of a collection, you should also + track the parent collection. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'track(): Word.Conflict;' + return: + type: + description: '' + - name: untrack() + uid: word!Word.Conflict#untrack:member(1) + package: word! + fullName: untrack() + summary: >- + Release the memory associated with this object, if it has previously been + tracked. This call is shorthand for + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). Having many tracked objects slows down the host application, so + please remember to free any objects you add, once you're done using them. + You'll need to call `context.sync()` before the memory release takes + effect. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'untrack(): Word.Conflict;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/word/word/word.conflictcollection.yml b/docs/docs-ref-autogen/word/word/word.conflictcollection.yml new file mode 100644 index 0000000000..171fdb068a --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.conflictcollection.yml @@ -0,0 +1,241 @@ +### YamlMime:TSType +name: Word.ConflictCollection +uid: word!Word.ConflictCollection:class +package: word! +fullName: Word.ConflictCollection +summary: Represents the coauthoring conflicts in a Word document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: class +properties: + - name: context + uid: word!Word.ConflictCollection#context:member + package: word! + 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: true + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: word!Word.ConflictCollection#items:member + package: word! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly items: Word.Conflict[];' + return: + type: [] +methods: + - name: acceptAll() + uid: word!Word.ConflictCollection#acceptAll:member(1) + package: word! + fullName: acceptAll() + summary: >- + Accepts all of the user's changes, removes the conflicts, and merges the + changes into the server copy of the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'acceptAll(): void;' + return: + type: void + description: '' + - name: getItem(index) + uid: word!Word.ConflictCollection#getItem:member(1) + package: word! + fullName: getItem(index) + summary: Gets a `Conflict` object by its index in the collection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'getItem(index: number): Word.Conflict;' + parameters: + - id: index + description: A number that identifies the index location of a `Conflict` object. + type: number + return: + type: + description: '' + - name: load(options) + uid: word!Word.ConflictCollection#load:member(1) + package: word! + 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: true + isDeprecated: false + syntax: + content: >- + load(options?: Word.Interfaces.ConflictCollectionLoadOptions & + Word.Interfaces.CollectionLoadOptions): Word.ConflictCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: word!Word.ConflictCollection#load:member(2) + package: word! + 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: true + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Word.ConflictCollection;' + 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: word!Word.ConflictCollection#load:member(3) + package: word! + 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: true + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Word.ConflictCollection; + 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: rejectAll() + uid: word!Word.ConflictCollection#rejectAll:member(1) + package: word! + fullName: rejectAll() + summary: >- + Rejects all of the user's changes and retains the server copy of the + document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'rejectAll(): void;' + return: + type: void + description: '' + - name: toJSON() + uid: word!Word.ConflictCollection#toJSON:member(1) + package: word! + 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 + `Word.ConflictCollection` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Word.Interfaces.ConflictCollectionData`) that contains an "items" + array with shallow copies of any loaded properties from the collection's + items. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'toJSON(): Word.Interfaces.ConflictCollectionData;' + return: + type: + description: '' + - name: track() + uid: word!Word.ConflictCollection#track:member(1) + package: word! + fullName: track() + summary: >- + Track the object for automatic adjustment based on surrounding changes in + the document. This call is a shorthand for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). If you're using this object across `.sync` calls and outside the + sequential execution of a ".run" batch, and get an "InvalidObjectPath" + error when setting a property or invoking a method on the object, you need + to add the object to the tracked object collection when the object was + first created. If this object is part of a collection, you should also + track the parent collection. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'track(): Word.ConflictCollection;' + return: + type: + description: '' + - name: untrack() + uid: word!Word.ConflictCollection#untrack:member(1) + package: word! + fullName: untrack() + summary: >- + Release the memory associated with this object, if it has previously been + tracked. This call is shorthand for + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). Having many tracked objects slows down the host application, so + please remember to free any objects you add, once you're done using them. + You'll need to call `context.sync()` before the memory release takes + effect. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'untrack(): Word.ConflictCollection;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/word/word/word.datelanguage.yml b/docs/docs-ref-autogen/word/word/word.datelanguage.yml new file mode 100644 index 0000000000..91cff3fac1 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.datelanguage.yml @@ -0,0 +1,33 @@ +### YamlMime:TSEnum +name: Word.DateLanguage +uid: word!Word.DateLanguage:enum +package: word! +fullName: Word.DateLanguage +summary: Specifies the language to use for date formatting. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: bidirectional + uid: word!Word.DateLanguage.bidirectional:member + package: word! + summary: >- + Uses the bidirectional date/time format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Bidirectional"' + - name: latin + uid: word!Word.DateLanguage.latin:member + package: word! + summary: >- + Uses the latin date/time format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Latin"' diff --git a/docs/docs-ref-autogen/word/word/word.defaulttablebehavior.yml b/docs/docs-ref-autogen/word/word/word.defaulttablebehavior.yml new file mode 100644 index 0000000000..1fb918f4cc --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.defaulttablebehavior.yml @@ -0,0 +1,33 @@ +### YamlMime:TSEnum +name: Word.DefaultTableBehavior +uid: word!Word.DefaultTableBehavior:enum +package: word! +fullName: Word.DefaultTableBehavior +summary: Specifies the default behavior when inserting a new table. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: disableAutoFit + uid: word!Word.DefaultTableBehavior.disableAutoFit:member + package: word! + summary: >- + Disables AutoFit. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"DisableAutoFit"' + - name: enableAutoFit + uid: word!Word.DefaultTableBehavior.enableAutoFit:member + package: word! + summary: >- + Enables AutoFit. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"EnableAutoFit"' diff --git a/docs/docs-ref-autogen/word/word/word.deletecells.yml b/docs/docs-ref-autogen/word/word/word.deletecells.yml new file mode 100644 index 0000000000..023f21ca29 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.deletecells.yml @@ -0,0 +1,57 @@ +### YamlMime:TSEnum +name: Word.DeleteCells +uid: word!Word.DeleteCells:enum +package: word! +fullName: Word.DeleteCells +summary: >- + Specifies a range of cells to be deleted from a table in a delete cells action + or the behavior of the remaining cells after the deletion has occurred. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: entireColumn + uid: word!Word.DeleteCells.entireColumn:member + package: word! + summary: >- + Delete the entire column of cells from the table. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"EntireColumn"' + - name: entireRow + uid: word!Word.DeleteCells.entireRow:member + package: word! + summary: >- + Delete the entire row of cells from the table. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"EntireRow"' + - name: shiftLeft + uid: word!Word.DeleteCells.shiftLeft:member + package: word! + summary: >- + Shift remaining cells left in the row where the deletion occurred after a + cell or range of cells has been deleted. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"ShiftLeft"' + - name: shiftUp + uid: word!Word.DeleteCells.shiftUp:member + package: word! + summary: >- + Shift remaining cells up in the column where the deletion occurred after a + cell or range of cells has been deleted. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"ShiftUp"' diff --git a/docs/docs-ref-autogen/word/word/word.document.yml b/docs/docs-ref-autogen/word/word/word.document.yml index 8d75575580..1cc1bfadba 100644 --- a/docs/docs-ref-autogen/word/word/word.document.yml +++ b/docs/docs-ref-autogen/word/word/word.document.yml @@ -260,6 +260,21 @@ properties: type: >- | "Off" | "TrackAll" | "TrackMineOnly" + - name: coauthoring + uid: word!Word.Document#coauthoring:member + package: word! + fullName: coauthoring + summary: Gets a `Coauthoring` object for managing coauthoring in the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly coauthoring: Word.Coauthoring;' + return: + type: - name: consecutiveHyphensLimit uid: word!Word.Document#consecutiveHyphensLimit:member package: word! @@ -426,6 +441,23 @@ properties: content: 'languageDetected: boolean;' return: type: boolean + - name: listTemplates + uid: word!Word.Document#listTemplates:member + package: word! + fullName: listTemplates + summary: >- + Returns a `ListTemplateCollection` object that represents all the list + templates in the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly listTemplates: Word.ListTemplateCollection;' + return: + type: - name: pageSetup uid: word!Word.Document#pageSetup:member package: word! @@ -476,6 +508,24 @@ properties: content: 'readonly properties: Word.DocumentProperties;' return: type: + - name: revisions + uid: word!Word.Document#revisions:member + package: word! + fullName: revisions + summary: >- + Gets the collection of revisions that represents the tracked changes in + the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly revisions: Word.RevisionCollection;' + return: + type: - name: saved uid: word!Word.Document#saved:member package: word! @@ -508,6 +558,23 @@ properties: content: 'readonly sections: Word.SectionCollection;' return: type: + - name: selection + uid: word!Word.Document#selection:member + package: word! + fullName: selection + summary: >- + Returns a `Selection` object that represents the current selection in the + document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly selection: Word.Selection;' + return: + type: - name: settings uid: word!Word.Document#settings:member package: word! @@ -552,6 +619,76 @@ properties: content: 'readonly settings: Word.SettingCollection;' return: type: + - name: tableOfAuthoritiesCategories + uid: word!Word.Document#tableOfAuthoritiesCategories:member + package: word! + fullName: tableOfAuthoritiesCategories + summary: >- + Returns a `TableOfAuthoritiesCategoryCollection` object that represents + the available table of authorities categories in the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + readonly tableOfAuthoritiesCategories: + Word.TableOfAuthoritiesCategoryCollection; + return: + type: + - name: tablesOfAuthorities + uid: word!Word.Document#tablesOfAuthorities:member + package: word! + fullName: tablesOfAuthorities + summary: >- + Returns a `TableOfAuthoritiesCollection` object that represents all the + tables of authorities in the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly tablesOfAuthorities: Word.TableOfAuthoritiesCollection;' + return: + type: + - name: tablesOfContents + uid: word!Word.Document#tablesOfContents:member + package: word! + fullName: tablesOfContents + summary: >- + Returns a `TableOfContentsCollection` object that represents all the + tables of contents in the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly tablesOfContents: Word.TableOfContentsCollection;' + return: + type: + - name: tablesOfFigures + uid: word!Word.Document#tablesOfFigures:member + package: word! + fullName: tablesOfFigures + summary: >- + Returns a `TableOfFiguresCollection` object that represents all the tables + of figures in the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly tablesOfFigures: Word.TableOfFiguresCollection;' + return: + type: - name: windows uid: word!Word.Document#windows:member package: word! diff --git a/docs/docs-ref-autogen/word/word/word.editor.yml b/docs/docs-ref-autogen/word/word/word.editor.yml new file mode 100644 index 0000000000..a6d098e970 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.editor.yml @@ -0,0 +1,344 @@ +### YamlMime:TSType +name: Word.Editor +uid: word!Word.Editor:class +package: word! +fullName: Word.Editor +summary: >- + Represents a user with permissions to edit authorized portions of a protected + (read-only) Word document. To learn more, see [Allow changes to parts of a + protected Word + document](https://support.microsoft.com/office/187ed01c-8795-43e1-9fd0-c9fca419dadf). +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: class +properties: + - name: context + uid: word!Word.Editor#context:member + package: word! + 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: true + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: id + uid: word!Word.Editor#id:member + package: word! + fullName: id + summary: >- + Gets the identifier for the `Editor` object when the parent document is + saved as a webpage. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly id: string;' + return: + type: string + - name: name + uid: word!Word.Editor#name:member + package: word! + fullName: name + summary: Gets the name of the editor. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly name: string;' + return: + type: string + - name: nextRange + uid: word!Word.Editor#nextRange:member + package: word! + fullName: nextRange + summary: >- + Gets a `Range` object that represents the next range that the editor has + permissions to modify. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly nextRange: Word.Range;' + return: + type: + - name: range + uid: word!Word.Editor#range:member + package: word! + fullName: range + summary: >- + Gets a `Range` object that represents the portion of the document that's + contained in the `Editor` object. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly range: Word.Range;' + return: + type: +methods: + - name: delete() + uid: word!Word.Editor#delete:member(1) + package: word! + fullName: delete() + summary: Deletes the `Editor` object. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'delete(): void;' + return: + type: void + description: '' + - name: load(options) + uid: word!Word.Editor#load:member(1) + package: word! + 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: true + isDeprecated: false + syntax: + content: 'load(options?: Word.Interfaces.EditorLoadOptions): Word.Editor;' + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: + return: + type: + description: '' + - name: load(propertyNames) + uid: word!Word.Editor#load:member(2) + package: word! + 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: true + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Word.Editor;' + 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: word!Word.Editor#load:member(3) + package: word! + 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: true + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Editor; + 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: removeAllPermissions() + uid: word!Word.Editor#removeAllPermissions:member(1) + package: word! + fullName: removeAllPermissions() + summary: >- + Removes all editing permissions in the document for the editor. The editor + will be deleted next time the document opens. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'removeAllPermissions(): void;' + return: + type: void + description: '' + - name: selectAllShapes() + uid: word!Word.Editor#selectAllShapes:member(1) + package: word! + fullName: selectAllShapes() + summary: >- + Selects all the shapes in the document that were inserted or edited by the + editor. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'selectAllShapes(): void;' + return: + type: void + description: '' + - name: set(properties, options) + uid: word!Word.Editor#set:member(1) + package: word! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.EditorUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: word!Word.Editor#set:member(2) + package: word! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'set(properties: Word.Editor): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: word!Word.Editor#toJSON:member(1) + package: word! + 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 `Word.Editor` object is + an API object, the `toJSON` method returns a plain JavaScript object + (typed as `Word.Interfaces.EditorData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'toJSON(): Word.Interfaces.EditorData;' + return: + type: + description: '' + - name: track() + uid: word!Word.Editor#track:member(1) + package: word! + fullName: track() + summary: >- + Track the object for automatic adjustment based on surrounding changes in + the document. This call is a shorthand for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). If you're using this object across `.sync` calls and outside the + sequential execution of a ".run" batch, and get an "InvalidObjectPath" + error when setting a property or invoking a method on the object, you need + to add the object to the tracked object collection when the object was + first created. If this object is part of a collection, you should also + track the parent collection. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'track(): Word.Editor;' + return: + type: + description: '' + - name: untrack() + uid: word!Word.Editor#untrack:member(1) + package: word! + fullName: untrack() + summary: >- + Release the memory associated with this object, if it has previously been + tracked. This call is shorthand for + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). Having many tracked objects slows down the host application, so + please remember to free any objects you add, once you're done using them. + You'll need to call `context.sync()` before the memory release takes + effect. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'untrack(): Word.Editor;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/word/word/word.editorcollection.yml b/docs/docs-ref-autogen/word/word/word.editorcollection.yml new file mode 100644 index 0000000000..a1dc650487 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.editorcollection.yml @@ -0,0 +1,263 @@ +### YamlMime:TSType +name: Word.EditorCollection +uid: word!Word.EditorCollection:class +package: word! +fullName: Word.EditorCollection +summary: >- + Represents the [editors](xref:word!Word.Editor:class) in a protected + (read-only) Word document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: class +properties: + - name: context + uid: word!Word.EditorCollection#context:member + package: word! + 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: true + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: +methods: + - name: addById(editorId) + uid: word!Word.EditorCollection#addById:member(1) + package: word! + fullName: addById(editorId) + summary: >- + Returns an `Editor` object that represents a new permission for the + specified user to modify a range within the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'addById(editorId: string): Word.Editor;' + parameters: + - id: editorId + description: The user's email alias (if in the same domain) or an email address. + type: string + return: + type: + description: '' + - name: addByType(editorType) + uid: word!Word.EditorCollection#addByType:member(1) + package: word! + fullName: addByType(editorType) + summary: >- + Returns an `Editor` object that represents a new permission for the + specified group of users to modify a range within the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'addByType(editorType: Word.EditorType): Word.Editor;' + parameters: + - id: editorType + description: An `EditorType` that represents a group of users. + type: + return: + type: + description: '' + - name: addByType(editorType) + uid: word!Word.EditorCollection#addByType:member(2) + package: word! + fullName: addByType(editorType) + summary: >- + Returns an `Editor` object that represents a new permission for the + specified group of users to modify a range within the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + addByType(editorType: "Current" | "Editors" | "Everyone" | "Owners"): + Word.Editor; + parameters: + - id: editorType + description: An `EditorType` that represents a group of users. + type: '"Current" | "Editors" | "Everyone" | "Owners"' + return: + type: + description: '' + - name: getCount() + uid: word!Word.EditorCollection#getCount:member(1) + package: word! + fullName: getCount() + summary: Returns the number of items in the collection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'getCount(): OfficeExtension.ClientResult;' + return: + type: <number> + description: '' + - name: getItemAt(index) + uid: word!Word.EditorCollection#getItemAt:member(1) + package: word! + fullName: getItemAt(index) + summary: Gets an `Editor` object by its index in the collection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'getItemAt(index: number): Word.Editor;' + parameters: + - id: index + description: The index of the object in this collection. + type: number + return: + type: + description: '' + - name: load(propertyNames) + uid: word!Word.EditorCollection#load:member(1) + package: word! + 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: true + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Word.EditorCollection;' + 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: word!Word.EditorCollection#load:member(2) + package: word! + 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: true + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.EditorCollection; + 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: word!Word.EditorCollection#toJSON:member(1) + package: word! + 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 `Word.EditorCollection` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Word.Interfaces.EditorCollectionData`) that + contains shallow copies of any loaded child properties from the original + object. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: |- + toJSON(): { + [key: string]: string; + }; + return: + type: |- + { + [key: string]: string; + } + description: '' + - name: track() + uid: word!Word.EditorCollection#track:member(1) + package: word! + fullName: track() + summary: >- + Track the object for automatic adjustment based on surrounding changes in + the document. This call is a shorthand for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). If you're using this object across `.sync` calls and outside the + sequential execution of a ".run" batch, and get an "InvalidObjectPath" + error when setting a property or invoking a method on the object, you need + to add the object to the tracked object collection when the object was + first created. If this object is part of a collection, you should also + track the parent collection. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'track(): Word.EditorCollection;' + return: + type: + description: '' + - name: untrack() + uid: word!Word.EditorCollection#untrack:member(1) + package: word! + fullName: untrack() + summary: >- + Release the memory associated with this object, if it has previously been + tracked. This call is shorthand for + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). Having many tracked objects slows down the host application, so + please remember to free any objects you add, once you're done using them. + You'll need to call `context.sync()` before the memory release takes + effect. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'untrack(): Word.EditorCollection;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/word/word/word.editortype.yml b/docs/docs-ref-autogen/word/word/word.editortype.yml new file mode 100644 index 0000000000..70a0a9a4c3 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.editortype.yml @@ -0,0 +1,57 @@ +### YamlMime:TSEnum +name: Word.EditorType +uid: word!Word.EditorType:enum +package: word! +fullName: Word.EditorType +summary: >- + Represents the classes of users who can edit authorized portions of a + protected (read-only) document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: current + uid: word!Word.EditorType.current:member + package: word! + summary: >- + Represents the current user of the document. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Current"' + - name: editors + uid: word!Word.EditorType.editors:member + package: word! + summary: >- + Represents the Editors group for documents that use Information Rights + Management. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Editors"' + - name: everyone + uid: word!Word.EditorType.everyone:member + package: word! + summary: >- + Represents all users who open a document. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Everyone"' + - name: owners + uid: word!Word.EditorType.owners:member + package: word! + summary: >- + Represents the Owners group for documents that use Information Rights + Management. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Owners"' diff --git a/docs/docs-ref-autogen/word/word/word.endnotelocation.yml b/docs/docs-ref-autogen/word/word/word.endnotelocation.yml new file mode 100644 index 0000000000..e6ff15029f --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.endnotelocation.yml @@ -0,0 +1,33 @@ +### YamlMime:TSEnum +name: Word.EndnoteLocation +uid: word!Word.EndnoteLocation:enum +package: word! +fullName: Word.EndnoteLocation +summary: Specifies the location of endnotes in a Word document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: endOfDocument + uid: word!Word.EndnoteLocation.endOfDocument:member + package: word! + summary: >- + Places endnotes at the end of the document. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"EndOfDocument"' + - name: endOfSection + uid: word!Word.EndnoteLocation.endOfSection:member + package: word! + summary: >- + Places endnotes at the end of the section. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"EndOfSection"' diff --git a/docs/docs-ref-autogen/word/word/word.fontbias.yml b/docs/docs-ref-autogen/word/word/word.fontbias.yml new file mode 100644 index 0000000000..72d09032e1 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.fontbias.yml @@ -0,0 +1,43 @@ +### YamlMime:TSEnum +name: Word.FontBias +uid: word!Word.FontBias:enum +package: word! +fullName: Word.FontBias +summary: Specifies the font bias to use when formatting East Asian text. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: farEast + uid: word!Word.FontBias.farEast:member + package: word! + summary: >- + Uses the font bias for Far East text. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"FarEast"' + - name: noSpecified + uid: word!Word.FontBias.noSpecified:member + package: word! + summary: >- + No font bias specified. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"NoSpecified"' + - name: standard + uid: word!Word.FontBias.standard:member + package: word! + summary: >- + Uses the default font bias. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Standard"' diff --git a/docs/docs-ref-autogen/word/word/word.fontnamecollection.yml b/docs/docs-ref-autogen/word/word/word.fontnamecollection.yml new file mode 100644 index 0000000000..ffc6dfdf2f --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.fontnamecollection.yml @@ -0,0 +1,193 @@ +### YamlMime:TSType +name: Word.FontNameCollection +uid: word!Word.FontNameCollection:class +package: word! +fullName: Word.FontNameCollection +summary: Represents a list of the names of all the available fonts. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: class +properties: + - name: context + uid: word!Word.FontNameCollection#context:member + package: word! + 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: true + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: +methods: + - name: getCount() + uid: word!Word.FontNameCollection#getCount:member(1) + package: word! + fullName: getCount() + summary: Returns the number of items in the collection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'getCount(): OfficeExtension.ClientResult;' + return: + type: <number> + description: '' + - name: getItemAt(index) + uid: word!Word.FontNameCollection#getItemAt:member(1) + package: word! + fullName: getItemAt(index) + summary: Gets the font name at the specified index. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'getItemAt(index: number): OfficeExtension.ClientResult;' + parameters: + - id: index + description: The zero-based index of the font name to retrieve. + type: number + return: + type: <string> + description: '' + - name: load(propertyNames) + uid: word!Word.FontNameCollection#load:member(1) + package: word! + 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: true + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Word.FontNameCollection;' + 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: word!Word.FontNameCollection#load:member(2) + package: word! + 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: true + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.FontNameCollection; + 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: word!Word.FontNameCollection#toJSON:member(1) + package: word! + 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 + `Word.FontNameCollection` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Word.Interfaces.FontNameCollectionData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: |- + toJSON(): { + [key: string]: string; + }; + return: + type: |- + { + [key: string]: string; + } + description: '' + - name: track() + uid: word!Word.FontNameCollection#track:member(1) + package: word! + fullName: track() + summary: >- + Track the object for automatic adjustment based on surrounding changes in + the document. This call is a shorthand for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). If you're using this object across `.sync` calls and outside the + sequential execution of a ".run" batch, and get an "InvalidObjectPath" + error when setting a property or invoking a method on the object, you need + to add the object to the tracked object collection when the object was + first created. If this object is part of a collection, you should also + track the parent collection. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'track(): Word.FontNameCollection;' + return: + type: + description: '' + - name: untrack() + uid: word!Word.FontNameCollection#untrack:member(1) + package: word! + fullName: untrack() + summary: >- + Release the memory associated with this object, if it has previously been + tracked. This call is shorthand for + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). Having many tracked objects slows down the host application, so + please remember to free any objects you add, once you're done using them. + You'll need to call `context.sync()` before the memory release takes + effect. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'untrack(): Word.FontNameCollection;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/word/word/word.footnotelocation.yml b/docs/docs-ref-autogen/word/word/word.footnotelocation.yml new file mode 100644 index 0000000000..491b231e7b --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.footnotelocation.yml @@ -0,0 +1,33 @@ +### YamlMime:TSEnum +name: Word.FootnoteLocation +uid: word!Word.FootnoteLocation:enum +package: word! +fullName: Word.FootnoteLocation +summary: Specifies the location of footnotes in a Word document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: beneathText + uid: word!Word.FootnoteLocation.beneathText:member + package: word! + summary: >- + Places footnotes below the text on the page. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"BeneathText"' + - name: bottomOfPage + uid: word!Word.FootnoteLocation.bottomOfPage:member + package: word! + summary: >- + Places footnotes at the bottom of the page. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"BottomOfPage"' diff --git a/docs/docs-ref-autogen/word/word/word.gotodirection.yml b/docs/docs-ref-autogen/word/word/word.gotodirection.yml new file mode 100644 index 0000000000..148e6cf0c3 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.gotodirection.yml @@ -0,0 +1,55 @@ +### YamlMime:TSEnum +name: Word.GoToDirection +uid: word!Word.GoToDirection:enum +package: word! +fullName: Word.GoToDirection +summary: >- + Specifies the direction in which to move when using the + [Selection.goTo](xref:word!Word.Selection:class) method. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: first + uid: word!Word.GoToDirection.first:member + package: word! + summary: >- + Moves to the first item. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"First"' + - name: last + uid: word!Word.GoToDirection.last:member + package: word! + summary: >- + Moves to the last item. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Last"' + - name: next + uid: word!Word.GoToDirection.next:member + package: word! + summary: >- + Moves to the next item. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Next"' + - name: previous + uid: word!Word.GoToDirection.previous:member + package: word! + summary: >- + Moves to the previous item. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Previous"' diff --git a/docs/docs-ref-autogen/word/word/word.gotoitem.yml b/docs/docs-ref-autogen/word/word/word.gotoitem.yml new file mode 100644 index 0000000000..c945002d0b --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.gotoitem.yml @@ -0,0 +1,185 @@ +### YamlMime:TSEnum +name: Word.GoToItem +uid: word!Word.GoToItem:enum +package: word! +fullName: Word.GoToItem +summary: >- + Specifies the item or location to which to move or extend a + [selection](xref:word!Word.Selection:class). +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: bookmark + uid: word!Word.GoToItem.bookmark:member + package: word! + summary: >- + Moves to a bookmark. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Bookmark"' + - name: comment + uid: word!Word.GoToItem.comment:member + package: word! + summary: >- + Moves to a comment. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Comment"' + - name: embeddedObject + uid: word!Word.GoToItem.embeddedObject:member + package: word! + summary: >- + Moves to an embedded object. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"EmbeddedObject"' + - name: endnote + uid: word!Word.GoToItem.endnote:member + package: word! + summary: >- + Moves to a endnote. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Endnote"' + - name: equation + uid: word!Word.GoToItem.equation:member + package: word! + summary: >- + Moves to an equation. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Equation"' + - name: field + uid: word!Word.GoToItem.field:member + package: word! + summary: >- + Moves to a field. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Field"' + - name: footnote + uid: word!Word.GoToItem.footnote:member + package: word! + summary: >- + Moves to a footnote. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Footnote"' + - name: grammaticalError + uid: word!Word.GoToItem.grammaticalError:member + package: word! + summary: >- + Moves to a grammatical error. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"GrammaticalError"' + - name: graphic + uid: word!Word.GoToItem.graphic:member + package: word! + summary: >- + Moves to a graphic. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Graphic"' + - name: heading + uid: word!Word.GoToItem.heading:member + package: word! + summary: >- + Moves to a heading. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Heading"' + - name: line + uid: word!Word.GoToItem.line:member + package: word! + summary: >- + Moves to a line. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Line"' + - name: page + uid: word!Word.GoToItem.page:member + package: word! + summary: >- + Moves to a page. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Page"' + - name: percent + uid: word!Word.GoToItem.percent:member + package: word! + summary: >- + Moves to a percent. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Percent"' + - name: proofreadingError + uid: word!Word.GoToItem.proofreadingError:member + package: word! + summary: >- + Moves to a proofreading error. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"ProofreadingError"' + - name: section + uid: word!Word.GoToItem.section:member + package: word! + summary: >- + Moves to a section. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Section"' + - name: spellingError + uid: word!Word.GoToItem.spellingError:member + package: word! + summary: >- + Moves to a spelling error. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"SpellingError"' + - name: table + uid: word!Word.GoToItem.table:member + package: word! + summary: >- + Moves to a table. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Table"' diff --git a/docs/docs-ref-autogen/word/word/word.headingstyle.yml b/docs/docs-ref-autogen/word/word/word.headingstyle.yml new file mode 100644 index 0000000000..e3d7617a9e --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.headingstyle.yml @@ -0,0 +1,273 @@ +### YamlMime:TSType +name: Word.HeadingStyle +uid: word!Word.HeadingStyle:class +package: word! +fullName: Word.HeadingStyle +summary: Represents a heading style used in a table of contents or table of figures. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: class +properties: + - name: context + uid: word!Word.HeadingStyle#context:member + package: word! + 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: true + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: level + uid: word!Word.HeadingStyle#level:member + package: word! + fullName: level + summary: >- + Specifies the level for the heading style in a table of contents or table + of figures. Must be a value from 1 to 9. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'level: number;' + return: + type: number + - name: name + uid: word!Word.HeadingStyle#name:member + package: word! + fullName: name + summary: Specifies the name of style for a heading. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'name: string;' + return: + type: string +methods: + - name: delete() + uid: word!Word.HeadingStyle#delete:member(1) + package: word! + fullName: delete() + summary: Deletes the heading style. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'delete(): void;' + return: + type: void + description: '' + - name: load(options) + uid: word!Word.HeadingStyle#load:member(1) + package: word! + 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: true + isDeprecated: false + syntax: + content: >- + load(options?: Word.Interfaces.HeadingStyleLoadOptions): + Word.HeadingStyle; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: word!Word.HeadingStyle#load:member(2) + package: word! + 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: true + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Word.HeadingStyle;' + 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: word!Word.HeadingStyle#load:member(3) + package: word! + 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: true + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.HeadingStyle; + 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(properties, options) + uid: word!Word.HeadingStyle#set:member(1) + package: word! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.HeadingStyleUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: word!Word.HeadingStyle#set:member(2) + package: word! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'set(properties: Word.HeadingStyle): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: word!Word.HeadingStyle#toJSON:member(1) + package: word! + 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 `Word.HeadingStyle` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Word.Interfaces.HeadingStyleData`) that contains + shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'toJSON(): Word.Interfaces.HeadingStyleData;' + return: + type: + description: '' + - name: track() + uid: word!Word.HeadingStyle#track:member(1) + package: word! + fullName: track() + summary: >- + Track the object for automatic adjustment based on surrounding changes in + the document. This call is a shorthand for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). If you're using this object across `.sync` calls and outside the + sequential execution of a ".run" batch, and get an "InvalidObjectPath" + error when setting a property or invoking a method on the object, you need + to add the object to the tracked object collection when the object was + first created. If this object is part of a collection, you should also + track the parent collection. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'track(): Word.HeadingStyle;' + return: + type: + description: '' + - name: untrack() + uid: word!Word.HeadingStyle#untrack:member(1) + package: word! + fullName: untrack() + summary: >- + Release the memory associated with this object, if it has previously been + tracked. This call is shorthand for + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). Having many tracked objects slows down the host application, so + please remember to free any objects you add, once you're done using them. + You'll need to call `context.sync()` before the memory release takes + effect. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'untrack(): Word.HeadingStyle;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/word/word/word.headingstylecollection.yml b/docs/docs-ref-autogen/word/word/word.headingstylecollection.yml new file mode 100644 index 0000000000..933bb3c806 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.headingstylecollection.yml @@ -0,0 +1,213 @@ +### YamlMime:TSType +name: Word.HeadingStyleCollection +uid: word!Word.HeadingStyleCollection:class +package: word! +fullName: Word.HeadingStyleCollection +summary: >- + Represents a collection of + [Word.HeadingStyle](xref:word!Word.HeadingStyle:class) objects in a Word + document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: class +properties: + - name: context + uid: word!Word.HeadingStyleCollection#context:member + package: word! + 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: true + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: word!Word.HeadingStyleCollection#items:member + package: word! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly items: Word.HeadingStyle[];' + return: + type: [] +methods: + - name: add(name, level) + uid: word!Word.HeadingStyleCollection#add:member(1) + package: word! + fullName: add(name, level) + summary: Adds a new heading style to a document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'add(name: string, level: number): Word.HeadingStyle;' + parameters: + - id: name + description: The style name to be added. + type: string + - id: level + description: The heading level to assign. Must be a value from 1 to 9. + type: number + return: + type: + description: The new `HeadingStyle` object that was added to the collection. + - name: load(options) + uid: word!Word.HeadingStyleCollection#load:member(1) + package: word! + 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: true + isDeprecated: false + syntax: + content: >- + load(options?: Word.Interfaces.HeadingStyleCollectionLoadOptions & + Word.Interfaces.CollectionLoadOptions): Word.HeadingStyleCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: word!Word.HeadingStyleCollection#load:member(2) + package: word! + 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: true + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Word.HeadingStyleCollection;' + 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: word!Word.HeadingStyleCollection#load:member(3) + package: word! + 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: true + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Word.HeadingStyleCollection; + 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: word!Word.HeadingStyleCollection#toJSON:member(1) + package: word! + 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 + `Word.HeadingStyleCollection` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Word.Interfaces.HeadingStyleCollectionData`) that contains an + "items" array with shallow copies of any loaded properties from the + collection's items. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'toJSON(): Word.Interfaces.HeadingStyleCollectionData;' + return: + type: >- + + description: '' + - name: track() + uid: word!Word.HeadingStyleCollection#track:member(1) + package: word! + fullName: track() + summary: >- + Track the object for automatic adjustment based on surrounding changes in + the document. This call is a shorthand for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). If you're using this object across `.sync` calls and outside the + sequential execution of a ".run" batch, and get an "InvalidObjectPath" + error when setting a property or invoking a method on the object, you need + to add the object to the tracked object collection when the object was + first created. If this object is part of a collection, you should also + track the parent collection. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'track(): Word.HeadingStyleCollection;' + return: + type: + description: '' + - name: untrack() + uid: word!Word.HeadingStyleCollection#untrack:member(1) + package: word! + fullName: untrack() + summary: >- + Release the memory associated with this object, if it has previously been + tracked. This call is shorthand for + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). Having many tracked objects slows down the host application, so + please remember to free any objects you add, once you're done using them. + You'll need to call `context.sync()` before the memory release takes + effect. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'untrack(): Word.HeadingStyleCollection;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.applicationdata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.applicationdata.yml index 460cb91e14..0546aa9ce1 100644 --- a/docs/docs-ref-autogen/word/word/word.interfaces.applicationdata.yml +++ b/docs/docs-ref-autogen/word/word/word.interfaces.applicationdata.yml @@ -160,3 +160,22 @@ properties: "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu" + - name: listTemplateGalleries + uid: word!Word.Interfaces.ApplicationData#listTemplateGalleries:member + package: word! + fullName: listTemplateGalleries + summary: >- + Returns a `ListTemplateGalleryCollection` object that represents all the + list template galleries in Microsoft Word. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'listTemplateGalleries?: Word.Interfaces.ListTemplateGalleryData[];' + return: + type: >- + [] diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.coauthorcollectiondata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.coauthorcollectiondata.yml new file mode 100644 index 0000000000..1fee42bdb2 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.coauthorcollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Word.Interfaces.CoauthorCollectionData +uid: word!Word.Interfaces.CoauthorCollectionData:interface +package: word! +fullName: Word.Interfaces.CoauthorCollectionData +summary: >- + An interface describing the data returned by calling + `coauthorCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: word!Word.Interfaces.CoauthorCollectionData#items:member + package: word! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Word.Interfaces.CoauthorData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.coauthorcollectionloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.coauthorcollectionloadoptions.yml new file mode 100644 index 0000000000..c0cca439f3 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.coauthorcollectionloadoptions.yml @@ -0,0 +1,96 @@ +### YamlMime:TSType +name: Word.Interfaces.CoauthorCollectionLoadOptions +uid: word!Word.Interfaces.CoauthorCollectionLoadOptions:interface +package: word! +fullName: Word.Interfaces.CoauthorCollectionLoadOptions +summary: >- + Contains a collection of [Word.Coauthor](xref:word!Word.Coauthor:class) + objects. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: $all + uid: word!Word.Interfaces.CoauthorCollectionLoadOptions#$all:member + package: word! + 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: true + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: emailAddress + uid: word!Word.Interfaces.CoauthorCollectionLoadOptions#emailAddress:member + package: word! + fullName: emailAddress + summary: 'For EACH ITEM in the collection: Gets the email address of the coauthor.' + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'emailAddress?: boolean;' + return: + type: boolean + - name: id + uid: word!Word.Interfaces.CoauthorCollectionLoadOptions#id:member + package: word! + fullName: id + summary: >- + For EACH ITEM in the collection: Gets the unique identifier for the + `Coauthor` object. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: isMe + uid: word!Word.Interfaces.CoauthorCollectionLoadOptions#isMe:member + package: word! + fullName: isMe + summary: >- + For EACH ITEM in the collection: Gets whether this author represents the + current user. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isMe?: boolean;' + return: + type: boolean + - name: name + uid: word!Word.Interfaces.CoauthorCollectionLoadOptions#name:member + package: word! + fullName: name + summary: 'For EACH ITEM in the collection: Gets the display name of the coauthor.' + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.coauthorcollectionupdatedata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.coauthorcollectionupdatedata.yml new file mode 100644 index 0000000000..966122e5b2 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.coauthorcollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Word.Interfaces.CoauthorCollectionUpdateData +uid: word!Word.Interfaces.CoauthorCollectionUpdateData:interface +package: word! +fullName: Word.Interfaces.CoauthorCollectionUpdateData +summary: >- + An interface for updating data on the `CoauthorCollection` object, for use in + `coauthorCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: word!Word.Interfaces.CoauthorCollectionUpdateData#items:member + package: word! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Word.Interfaces.CoauthorData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.coauthordata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.coauthordata.yml new file mode 100644 index 0000000000..cddfc0234a --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.coauthordata.yml @@ -0,0 +1,91 @@ +### YamlMime:TSType +name: Word.Interfaces.CoauthorData +uid: word!Word.Interfaces.CoauthorData:interface +package: word! +fullName: Word.Interfaces.CoauthorData +summary: >- + An interface describing the data returned by calling `coauthor.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: emailAddress + uid: word!Word.Interfaces.CoauthorData#emailAddress:member + package: word! + fullName: emailAddress + summary: Gets the email address of the coauthor. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'emailAddress?: string;' + return: + type: string + - name: id + uid: word!Word.Interfaces.CoauthorData#id:member + package: word! + fullName: id + summary: Gets the unique identifier for the `Coauthor` object. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'id?: string;' + return: + type: string + - name: isMe + uid: word!Word.Interfaces.CoauthorData#isMe:member + package: word! + fullName: isMe + summary: Gets whether this author represents the current user. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isMe?: boolean;' + return: + type: boolean + - name: locks + uid: word!Word.Interfaces.CoauthorData#locks:member + package: word! + fullName: locks + summary: >- + Gets a `CoauthoringLockCollection` object that represents the locks in the + document that are associated with this coauthor. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'locks?: Word.Interfaces.CoauthoringLockData[];' + return: + type: [] + - name: name + uid: word!Word.Interfaces.CoauthorData#name:member + package: word! + fullName: name + summary: Gets the display name of the coauthor. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.coauthoringdata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.coauthoringdata.yml new file mode 100644 index 0000000000..09879c73e3 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.coauthoringdata.yml @@ -0,0 +1,142 @@ +### YamlMime:TSType +name: Word.Interfaces.CoauthoringData +uid: word!Word.Interfaces.CoauthoringData:interface +package: word! +fullName: Word.Interfaces.CoauthoringData +summary: >- + An interface describing the data returned by calling + `coauthoring.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: authors + uid: word!Word.Interfaces.CoauthoringData#authors:member + package: word! + fullName: authors + summary: >- + Gets a `CoauthorCollection` object that represents all the coauthors + currently editing the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'authors?: Word.Interfaces.CoauthorData[];' + return: + type: [] + - name: canCoauthor + uid: word!Word.Interfaces.CoauthoringData#canCoauthor:member + package: word! + fullName: canCoauthor + summary: Gets whether this document can be coauthored. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'canCoauthor?: boolean;' + return: + type: boolean + - name: canMerge + uid: word!Word.Interfaces.CoauthoringData#canMerge:member + package: word! + fullName: canMerge + summary: Gets whether the document can be automatically merged. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'canMerge?: boolean;' + return: + type: boolean + - name: conflicts + uid: word!Word.Interfaces.CoauthoringData#conflicts:member + package: word! + fullName: conflicts + summary: >- + Gets a `ConflictCollection` object that represents all the conflicts in + the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'conflicts?: Word.Interfaces.ConflictData[];' + return: + type: [] + - name: locks + uid: word!Word.Interfaces.CoauthoringData#locks:member + package: word! + fullName: locks + summary: >- + Gets a `CoauthoringLockCollection` object that represents the locks in the + document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'locks?: Word.Interfaces.CoauthoringLockData[];' + return: + type: [] + - name: me + uid: word!Word.Interfaces.CoauthoringData#me:member + package: word! + fullName: me + summary: Gets a `Coauthor` object that represents the current user. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'me?: Word.Interfaces.CoauthorData;' + return: + type: + - name: pendingUpdates + uid: word!Word.Interfaces.CoauthoringData#pendingUpdates:member + package: word! + fullName: pendingUpdates + summary: Gets whether the document has pending updates that have not been accepted. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'pendingUpdates?: boolean;' + return: + type: boolean + - name: updates + uid: word!Word.Interfaces.CoauthoringData#updates:member + package: word! + fullName: updates + summary: >- + Gets a `CoauthoringUpdateCollection` object that represents the most + recent updates that were merged into the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'updates?: Word.Interfaces.CoauthoringUpdateData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.coauthoringloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.coauthoringloadoptions.yml new file mode 100644 index 0000000000..893ac355de --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.coauthoringloadoptions.yml @@ -0,0 +1,92 @@ +### YamlMime:TSType +name: Word.Interfaces.CoauthoringLoadOptions +uid: word!Word.Interfaces.CoauthoringLoadOptions:interface +package: word! +fullName: Word.Interfaces.CoauthoringLoadOptions +summary: >- + Represents the `Coauthoring` object. This tracks the updates, changes, + conflicts, and other interactions in the document done through coauthoring. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: $all + uid: word!Word.Interfaces.CoauthoringLoadOptions#$all:member + package: word! + 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: true + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: canCoauthor + uid: word!Word.Interfaces.CoauthoringLoadOptions#canCoauthor:member + package: word! + fullName: canCoauthor + summary: Gets whether this document can be coauthored. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'canCoauthor?: boolean;' + return: + type: boolean + - name: canMerge + uid: word!Word.Interfaces.CoauthoringLoadOptions#canMerge:member + package: word! + fullName: canMerge + summary: Gets whether the document can be automatically merged. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'canMerge?: boolean;' + return: + type: boolean + - name: me + uid: word!Word.Interfaces.CoauthoringLoadOptions#me:member + package: word! + fullName: me + summary: Gets a `Coauthor` object that represents the current user. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'me?: Word.Interfaces.CoauthorLoadOptions;' + return: + type: + - name: pendingUpdates + uid: word!Word.Interfaces.CoauthoringLoadOptions#pendingUpdates:member + package: word! + fullName: pendingUpdates + summary: Gets whether the document has pending updates that have not been accepted. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'pendingUpdates?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.coauthoringlockcollectiondata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.coauthoringlockcollectiondata.yml new file mode 100644 index 0000000000..f8a3f8abd8 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.coauthoringlockcollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Word.Interfaces.CoauthoringLockCollectionData +uid: word!Word.Interfaces.CoauthoringLockCollectionData:interface +package: word! +fullName: Word.Interfaces.CoauthoringLockCollectionData +summary: >- + An interface describing the data returned by calling + `coauthoringLockCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: word!Word.Interfaces.CoauthoringLockCollectionData#items:member + package: word! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Word.Interfaces.CoauthoringLockData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.coauthoringlockcollectionloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.coauthoringlockcollectionloadoptions.yml new file mode 100644 index 0000000000..36e3cf4436 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.coauthoringlockcollectionloadoptions.yml @@ -0,0 +1,79 @@ +### YamlMime:TSType +name: Word.Interfaces.CoauthoringLockCollectionLoadOptions +uid: word!Word.Interfaces.CoauthoringLockCollectionLoadOptions:interface +package: word! +fullName: Word.Interfaces.CoauthoringLockCollectionLoadOptions +summary: Represents a collection of coauthoring locks in a Word document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: $all + uid: word!Word.Interfaces.CoauthoringLockCollectionLoadOptions#$all:member + package: word! + 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: true + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: owner + uid: word!Word.Interfaces.CoauthoringLockCollectionLoadOptions#owner:member + package: word! + fullName: owner + summary: 'For EACH ITEM in the collection: Gets the owner of the lock.' + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'owner?: Word.Interfaces.CoauthorLoadOptions;' + return: + type: + - name: range + uid: word!Word.Interfaces.CoauthoringLockCollectionLoadOptions#range:member + package: word! + fullName: range + summary: >- + For EACH ITEM in the collection: Gets a `Range` object that represents the + portion of the document that's contained in the `CoauthoringLock` object. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'range?: Word.Interfaces.RangeLoadOptions;' + return: + type: + - name: type + uid: word!Word.Interfaces.CoauthoringLockCollectionLoadOptions#type:member + package: word! + fullName: type + summary: >- + For EACH ITEM in the collection: Gets a `CoauthoringLockType` value that + represents the lock type. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'type?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.coauthoringlockcollectionupdatedata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.coauthoringlockcollectionupdatedata.yml new file mode 100644 index 0000000000..cada40bb6a --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.coauthoringlockcollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Word.Interfaces.CoauthoringLockCollectionUpdateData +uid: word!Word.Interfaces.CoauthoringLockCollectionUpdateData:interface +package: word! +fullName: Word.Interfaces.CoauthoringLockCollectionUpdateData +summary: >- + An interface for updating data on the `CoauthoringLockCollection` object, for + use in `coauthoringLockCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: word!Word.Interfaces.CoauthoringLockCollectionUpdateData#items:member + package: word! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Word.Interfaces.CoauthoringLockData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.coauthoringlockdata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.coauthoringlockdata.yml new file mode 100644 index 0000000000..c32f521c45 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.coauthoringlockdata.yml @@ -0,0 +1,65 @@ +### YamlMime:TSType +name: Word.Interfaces.CoauthoringLockData +uid: word!Word.Interfaces.CoauthoringLockData:interface +package: word! +fullName: Word.Interfaces.CoauthoringLockData +summary: >- + An interface describing the data returned by calling + `coauthoringLock.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: owner + uid: word!Word.Interfaces.CoauthoringLockData#owner:member + package: word! + fullName: owner + summary: Gets the owner of the lock. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'owner?: Word.Interfaces.CoauthorData;' + return: + type: + - name: range + uid: word!Word.Interfaces.CoauthoringLockData#range:member + package: word! + fullName: range + summary: >- + Gets a `Range` object that represents the portion of the document that's + contained in the `CoauthoringLock` object. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'range?: Word.Interfaces.RangeData;' + return: + type: + - name: type + uid: word!Word.Interfaces.CoauthoringLockData#type:member + package: word! + fullName: type + summary: Gets a `CoauthoringLockType` value that represents the lock type. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + type?: Word.CoauthoringLockType | "None" | "Reservation" | "Ephemeral" | + "Changed"; + return: + type: >- + | "None" | + "Reservation" | "Ephemeral" | "Changed" diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.coauthoringlockloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.coauthoringlockloadoptions.yml new file mode 100644 index 0000000000..4d6e218258 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.coauthoringlockloadoptions.yml @@ -0,0 +1,77 @@ +### YamlMime:TSType +name: Word.Interfaces.CoauthoringLockLoadOptions +uid: word!Word.Interfaces.CoauthoringLockLoadOptions:interface +package: word! +fullName: Word.Interfaces.CoauthoringLockLoadOptions +summary: Represents a coauthoring lock in a Word document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: $all + uid: word!Word.Interfaces.CoauthoringLockLoadOptions#$all:member + package: word! + 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: true + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: owner + uid: word!Word.Interfaces.CoauthoringLockLoadOptions#owner:member + package: word! + fullName: owner + summary: Gets the owner of the lock. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'owner?: Word.Interfaces.CoauthorLoadOptions;' + return: + type: + - name: range + uid: word!Word.Interfaces.CoauthoringLockLoadOptions#range:member + package: word! + fullName: range + summary: >- + Gets a `Range` object that represents the portion of the document that's + contained in the `CoauthoringLock` object. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'range?: Word.Interfaces.RangeLoadOptions;' + return: + type: + - name: type + uid: word!Word.Interfaces.CoauthoringLockLoadOptions#type:member + package: word! + fullName: type + summary: Gets a `CoauthoringLockType` value that represents the lock type. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'type?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.coauthoringlockupdatedata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.coauthoringlockupdatedata.yml new file mode 100644 index 0000000000..05f17fc603 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.coauthoringlockupdatedata.yml @@ -0,0 +1,31 @@ +### YamlMime:TSType +name: Word.Interfaces.CoauthoringLockUpdateData +uid: word!Word.Interfaces.CoauthoringLockUpdateData:interface +package: word! +fullName: Word.Interfaces.CoauthoringLockUpdateData +summary: >- + An interface for updating data on the `CoauthoringLock` object, for use in + `coauthoringLock.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: range + uid: word!Word.Interfaces.CoauthoringLockUpdateData#range:member + package: word! + fullName: range + summary: >- + Gets a `Range` object that represents the portion of the document that's + contained in the `CoauthoringLock` object. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'range?: Word.Interfaces.RangeUpdateData;' + return: + type: diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.coauthoringupdatecollectiondata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.coauthoringupdatecollectiondata.yml new file mode 100644 index 0000000000..9fda0ce699 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.coauthoringupdatecollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Word.Interfaces.CoauthoringUpdateCollectionData +uid: word!Word.Interfaces.CoauthoringUpdateCollectionData:interface +package: word! +fullName: Word.Interfaces.CoauthoringUpdateCollectionData +summary: >- + An interface describing the data returned by calling + `coauthoringUpdateCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: word!Word.Interfaces.CoauthoringUpdateCollectionData#items:member + package: word! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Word.Interfaces.CoauthoringUpdateData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.coauthoringupdatecollectionloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.coauthoringupdatecollectionloadoptions.yml new file mode 100644 index 0000000000..5cc31008ce --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.coauthoringupdatecollectionloadoptions.yml @@ -0,0 +1,50 @@ +### YamlMime:TSType +name: Word.Interfaces.CoauthoringUpdateCollectionLoadOptions +uid: word!Word.Interfaces.CoauthoringUpdateCollectionLoadOptions:interface +package: word! +fullName: Word.Interfaces.CoauthoringUpdateCollectionLoadOptions +summary: >- + Contains a collection of + [Word.CoauthoringUpdate](xref:word!Word.CoauthoringUpdate:class) objects. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: $all + uid: word!Word.Interfaces.CoauthoringUpdateCollectionLoadOptions#$all:member + package: word! + 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: true + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: range + uid: word!Word.Interfaces.CoauthoringUpdateCollectionLoadOptions#range:member + package: word! + fullName: range + summary: >- + For EACH ITEM in the collection: Gets a `Range` object that represents the + portion of the document that's contained in the `CoauthoringUpdate` + object. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'range?: Word.Interfaces.RangeLoadOptions;' + return: + type: diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.coauthoringupdatecollectionupdatedata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.coauthoringupdatecollectionupdatedata.yml new file mode 100644 index 0000000000..c311822ac5 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.coauthoringupdatecollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Word.Interfaces.CoauthoringUpdateCollectionUpdateData +uid: word!Word.Interfaces.CoauthoringUpdateCollectionUpdateData:interface +package: word! +fullName: Word.Interfaces.CoauthoringUpdateCollectionUpdateData +summary: >- + An interface for updating data on the `CoauthoringUpdateCollection` object, + for use in `coauthoringUpdateCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: word!Word.Interfaces.CoauthoringUpdateCollectionUpdateData#items:member + package: word! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Word.Interfaces.CoauthoringUpdateData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.coauthoringupdatedata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.coauthoringupdatedata.yml new file mode 100644 index 0000000000..ba5379ff29 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.coauthoringupdatedata.yml @@ -0,0 +1,31 @@ +### YamlMime:TSType +name: Word.Interfaces.CoauthoringUpdateData +uid: word!Word.Interfaces.CoauthoringUpdateData:interface +package: word! +fullName: Word.Interfaces.CoauthoringUpdateData +summary: >- + An interface describing the data returned by calling + `coauthoringUpdate.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: range + uid: word!Word.Interfaces.CoauthoringUpdateData#range:member + package: word! + fullName: range + summary: >- + Gets a `Range` object that represents the portion of the document that's + contained in the `CoauthoringUpdate` object. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'range?: Word.Interfaces.RangeData;' + return: + type: diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.coauthoringupdateloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.coauthoringupdateloadoptions.yml new file mode 100644 index 0000000000..ea34f9acee --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.coauthoringupdateloadoptions.yml @@ -0,0 +1,47 @@ +### YamlMime:TSType +name: Word.Interfaces.CoauthoringUpdateLoadOptions +uid: word!Word.Interfaces.CoauthoringUpdateLoadOptions:interface +package: word! +fullName: Word.Interfaces.CoauthoringUpdateLoadOptions +summary: Represents a coauthoring update in a Word document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: $all + uid: word!Word.Interfaces.CoauthoringUpdateLoadOptions#$all:member + package: word! + 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: true + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: range + uid: word!Word.Interfaces.CoauthoringUpdateLoadOptions#range:member + package: word! + fullName: range + summary: >- + Gets a `Range` object that represents the portion of the document that's + contained in the `CoauthoringUpdate` object. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'range?: Word.Interfaces.RangeLoadOptions;' + return: + type: diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.coauthoringupdateupdatedata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.coauthoringupdateupdatedata.yml new file mode 100644 index 0000000000..e7c7d0a2f6 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.coauthoringupdateupdatedata.yml @@ -0,0 +1,31 @@ +### YamlMime:TSType +name: Word.Interfaces.CoauthoringUpdateUpdateData +uid: word!Word.Interfaces.CoauthoringUpdateUpdateData:interface +package: word! +fullName: Word.Interfaces.CoauthoringUpdateUpdateData +summary: >- + An interface for updating data on the `CoauthoringUpdate` object, for use in + `coauthoringUpdate.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: range + uid: word!Word.Interfaces.CoauthoringUpdateUpdateData#range:member + package: word! + fullName: range + summary: >- + Gets a `Range` object that represents the portion of the document that's + contained in the `CoauthoringUpdate` object. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'range?: Word.Interfaces.RangeUpdateData;' + return: + type: diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.coauthorloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.coauthorloadoptions.yml new file mode 100644 index 0000000000..c70cfd909c --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.coauthorloadoptions.yml @@ -0,0 +1,90 @@ +### YamlMime:TSType +name: Word.Interfaces.CoauthorLoadOptions +uid: word!Word.Interfaces.CoauthorLoadOptions:interface +package: word! +fullName: Word.Interfaces.CoauthorLoadOptions +summary: Represents a coauthor in a Word document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: $all + uid: word!Word.Interfaces.CoauthorLoadOptions#$all:member + package: word! + 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: true + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: emailAddress + uid: word!Word.Interfaces.CoauthorLoadOptions#emailAddress:member + package: word! + fullName: emailAddress + summary: Gets the email address of the coauthor. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'emailAddress?: boolean;' + return: + type: boolean + - name: id + uid: word!Word.Interfaces.CoauthorLoadOptions#id:member + package: word! + fullName: id + summary: Gets the unique identifier for the `Coauthor` object. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: isMe + uid: word!Word.Interfaces.CoauthorLoadOptions#isMe:member + package: word! + fullName: isMe + summary: Gets whether this author represents the current user. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isMe?: boolean;' + return: + type: boolean + - name: name + uid: word!Word.Interfaces.CoauthorLoadOptions#name:member + package: word! + fullName: name + summary: Gets the display name of the coauthor. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.conditionalstyledata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.conditionalstyledata.yml new file mode 100644 index 0000000000..cdede81af8 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.conditionalstyledata.yml @@ -0,0 +1,82 @@ +### YamlMime:TSType +name: Word.Interfaces.ConditionalStyleData +uid: word!Word.Interfaces.ConditionalStyleData:interface +package: word! +fullName: Word.Interfaces.ConditionalStyleData +summary: >- + An interface describing the data returned by calling + `conditionalStyle.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: bottomPadding + uid: word!Word.Interfaces.ConditionalStyleData#bottomPadding:member + package: word! + fullName: bottomPadding + summary: >- + Specifies the amount of space (in points) to add below the contents of a + single cell or all the cells in a table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'bottomPadding?: number;' + return: + type: number + - name: leftPadding + uid: word!Word.Interfaces.ConditionalStyleData#leftPadding:member + package: word! + fullName: leftPadding + summary: >- + Specifies the amount of space (in points) to add to the left of the + contents of a single cell or all the cells in a table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'leftPadding?: number;' + return: + type: number + - name: rightPadding + uid: word!Word.Interfaces.ConditionalStyleData#rightPadding:member + package: word! + fullName: rightPadding + summary: >- + Specifies the amount of space (in points) to add to the right of the + contents of a single cell or all the cells in a table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'rightPadding?: number;' + return: + type: number + - name: topPadding + uid: word!Word.Interfaces.ConditionalStyleData#topPadding:member + package: word! + fullName: topPadding + summary: >- + Specifies the amount of space (in points) to add above the contents of a + single cell or all the cells in a table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'topPadding?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.conditionalstyleloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.conditionalstyleloadoptions.yml new file mode 100644 index 0000000000..0ffa2ee4ff --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.conditionalstyleloadoptions.yml @@ -0,0 +1,155 @@ +### YamlMime:TSType +name: Word.Interfaces.ConditionalStyleLoadOptions +uid: word!Word.Interfaces.ConditionalStyleLoadOptions:interface +package: word! +fullName: Word.Interfaces.ConditionalStyleLoadOptions +summary: >- + Represents special formatting applied to specified areas of a table when the + selected table is formatted with a specified table style. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: $all + uid: word!Word.Interfaces.ConditionalStyleLoadOptions#$all:member + package: word! + 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: true + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: bottomPadding + uid: word!Word.Interfaces.ConditionalStyleLoadOptions#bottomPadding:member + package: word! + fullName: bottomPadding + summary: >- + Specifies the amount of space (in points) to add below the contents of a + single cell or all the cells in a table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'bottomPadding?: boolean;' + return: + type: boolean + - name: font + uid: word!Word.Interfaces.ConditionalStyleLoadOptions#font:member + package: word! + fullName: font + summary: >- + Returns a `Font` object that represents the font formatting for the + conditional style. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'font?: Word.Interfaces.FontLoadOptions;' + return: + type: + - name: leftPadding + uid: word!Word.Interfaces.ConditionalStyleLoadOptions#leftPadding:member + package: word! + fullName: leftPadding + summary: >- + Specifies the amount of space (in points) to add to the left of the + contents of a single cell or all the cells in a table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'leftPadding?: boolean;' + return: + type: boolean + - name: paragraphFormat + uid: word!Word.Interfaces.ConditionalStyleLoadOptions#paragraphFormat:member + package: word! + fullName: paragraphFormat + summary: >- + Returns a `ParagraphFormat` object that represents the paragraph + formatting for the conditional style. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'paragraphFormat?: Word.Interfaces.ParagraphFormatLoadOptions;' + return: + type: >- + + - name: rightPadding + uid: word!Word.Interfaces.ConditionalStyleLoadOptions#rightPadding:member + package: word! + fullName: rightPadding + summary: >- + Specifies the amount of space (in points) to add to the right of the + contents of a single cell or all the cells in a table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'rightPadding?: boolean;' + return: + type: boolean + - name: shading + uid: word!Word.Interfaces.ConditionalStyleLoadOptions#shading:member + package: word! + fullName: shading + summary: >- + Returns a `ShadingUniversal` object that represents the shading of the + conditional style. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'shading?: Word.Interfaces.ShadingUniversalLoadOptions;' + return: + type: >- + + - name: topPadding + uid: word!Word.Interfaces.ConditionalStyleLoadOptions#topPadding:member + package: word! + fullName: topPadding + summary: >- + Specifies the amount of space (in points) to add above the contents of a + single cell or all the cells in a table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'topPadding?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.conditionalstyleupdatedata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.conditionalstyleupdatedata.yml new file mode 100644 index 0000000000..af0a4453b5 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.conditionalstyleupdatedata.yml @@ -0,0 +1,82 @@ +### YamlMime:TSType +name: Word.Interfaces.ConditionalStyleUpdateData +uid: word!Word.Interfaces.ConditionalStyleUpdateData:interface +package: word! +fullName: Word.Interfaces.ConditionalStyleUpdateData +summary: >- + An interface for updating data on the `ConditionalStyle` object, for use in + `conditionalStyle.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: bottomPadding + uid: word!Word.Interfaces.ConditionalStyleUpdateData#bottomPadding:member + package: word! + fullName: bottomPadding + summary: >- + Specifies the amount of space (in points) to add below the contents of a + single cell or all the cells in a table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'bottomPadding?: number;' + return: + type: number + - name: leftPadding + uid: word!Word.Interfaces.ConditionalStyleUpdateData#leftPadding:member + package: word! + fullName: leftPadding + summary: >- + Specifies the amount of space (in points) to add to the left of the + contents of a single cell or all the cells in a table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'leftPadding?: number;' + return: + type: number + - name: rightPadding + uid: word!Word.Interfaces.ConditionalStyleUpdateData#rightPadding:member + package: word! + fullName: rightPadding + summary: >- + Specifies the amount of space (in points) to add to the right of the + contents of a single cell or all the cells in a table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'rightPadding?: number;' + return: + type: number + - name: topPadding + uid: word!Word.Interfaces.ConditionalStyleUpdateData#topPadding:member + package: word! + fullName: topPadding + summary: >- + Specifies the amount of space (in points) to add above the contents of a + single cell or all the cells in a table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'topPadding?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.conflictcollectiondata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.conflictcollectiondata.yml new file mode 100644 index 0000000000..441365d974 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.conflictcollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Word.Interfaces.ConflictCollectionData +uid: word!Word.Interfaces.ConflictCollectionData:interface +package: word! +fullName: Word.Interfaces.ConflictCollectionData +summary: >- + An interface describing the data returned by calling + `conflictCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: word!Word.Interfaces.ConflictCollectionData#items:member + package: word! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Word.Interfaces.ConflictData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.conflictcollectionloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.conflictcollectionloadoptions.yml new file mode 100644 index 0000000000..7bcd6756b6 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.conflictcollectionloadoptions.yml @@ -0,0 +1,64 @@ +### YamlMime:TSType +name: Word.Interfaces.ConflictCollectionLoadOptions +uid: word!Word.Interfaces.ConflictCollectionLoadOptions:interface +package: word! +fullName: Word.Interfaces.ConflictCollectionLoadOptions +summary: Represents the coauthoring conflicts in a Word document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: $all + uid: word!Word.Interfaces.ConflictCollectionLoadOptions#$all:member + package: word! + 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: true + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: range + uid: word!Word.Interfaces.ConflictCollectionLoadOptions#range:member + package: word! + fullName: range + summary: >- + For EACH ITEM in the collection: Gets a `Range` object that represents the + portion of the document that's contained in the `Conflict` object. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'range?: Word.Interfaces.RangeLoadOptions;' + return: + type: + - name: type + uid: word!Word.Interfaces.ConflictCollectionLoadOptions#type:member + package: word! + fullName: type + summary: >- + For EACH ITEM in the collection: Gets the `RevisionType` for the + `Conflict` object. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'type?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.conflictcollectionupdatedata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.conflictcollectionupdatedata.yml new file mode 100644 index 0000000000..792e2bdb31 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.conflictcollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Word.Interfaces.ConflictCollectionUpdateData +uid: word!Word.Interfaces.ConflictCollectionUpdateData:interface +package: word! +fullName: Word.Interfaces.ConflictCollectionUpdateData +summary: >- + An interface for updating data on the `ConflictCollection` object, for use in + `conflictCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: word!Word.Interfaces.ConflictCollectionUpdateData#items:member + package: word! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Word.Interfaces.ConflictData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.conflictdata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.conflictdata.yml new file mode 100644 index 0000000000..c3fcac814b --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.conflictdata.yml @@ -0,0 +1,58 @@ +### YamlMime:TSType +name: Word.Interfaces.ConflictData +uid: word!Word.Interfaces.ConflictData:interface +package: word! +fullName: Word.Interfaces.ConflictData +summary: >- + An interface describing the data returned by calling `conflict.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: range + uid: word!Word.Interfaces.ConflictData#range:member + package: word! + fullName: range + summary: >- + Gets a `Range` object that represents the portion of the document that's + contained in the `Conflict` object. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'range?: Word.Interfaces.RangeData;' + return: + type: + - name: type + uid: word!Word.Interfaces.ConflictData#type:member + package: word! + fullName: type + summary: Gets the `RevisionType` for the `Conflict` object. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + type?: Word.RevisionType | "None" | "Insert" | "Delete" | "Property" | + "ParagraphNumber" | "DisplayField" | "Reconcile" | "Conflict" | "Style" + | "Replace" | "ParagraphProperty" | "TableProperty" | "SectionProperty" + | "StyleDefinition" | "MovedFrom" | "MovedTo" | "CellInsertion" | + "CellDeletion" | "CellMerge" | "CellSplit" | "ConflictInsert" | + "ConflictDelete"; + return: + type: >- + | "None" | "Insert" | + "Delete" | "Property" | "ParagraphNumber" | "DisplayField" | + "Reconcile" | "Conflict" | "Style" | "Replace" | "ParagraphProperty" | + "TableProperty" | "SectionProperty" | "StyleDefinition" | "MovedFrom" + | "MovedTo" | "CellInsertion" | "CellDeletion" | "CellMerge" | + "CellSplit" | "ConflictInsert" | "ConflictDelete" diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.conflictloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.conflictloadoptions.yml new file mode 100644 index 0000000000..84653f389a --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.conflictloadoptions.yml @@ -0,0 +1,62 @@ +### YamlMime:TSType +name: Word.Interfaces.ConflictLoadOptions +uid: word!Word.Interfaces.ConflictLoadOptions:interface +package: word! +fullName: Word.Interfaces.ConflictLoadOptions +summary: Represents a coauthoring conflict in a Word document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: $all + uid: word!Word.Interfaces.ConflictLoadOptions#$all:member + package: word! + 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: true + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: range + uid: word!Word.Interfaces.ConflictLoadOptions#range:member + package: word! + fullName: range + summary: >- + Gets a `Range` object that represents the portion of the document that's + contained in the `Conflict` object. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'range?: Word.Interfaces.RangeLoadOptions;' + return: + type: + - name: type + uid: word!Word.Interfaces.ConflictLoadOptions#type:member + package: word! + fullName: type + summary: Gets the `RevisionType` for the `Conflict` object. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'type?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.conflictupdatedata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.conflictupdatedata.yml new file mode 100644 index 0000000000..5e515f2b43 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.conflictupdatedata.yml @@ -0,0 +1,31 @@ +### YamlMime:TSType +name: Word.Interfaces.ConflictUpdateData +uid: word!Word.Interfaces.ConflictUpdateData:interface +package: word! +fullName: Word.Interfaces.ConflictUpdateData +summary: >- + An interface for updating data on the `Conflict` object, for use in + `conflict.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: range + uid: word!Word.Interfaces.ConflictUpdateData#range:member + package: word! + fullName: range + summary: >- + Gets a `Range` object that represents the portion of the document that's + contained in the `Conflict` object. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'range?: Word.Interfaces.RangeUpdateData;' + return: + type: diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.documentdata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.documentdata.yml index 4ccc5adf8d..43a84aa70d 100644 --- a/docs/docs-ref-autogen/word/word/word.interfaces.documentdata.yml +++ b/docs/docs-ref-autogen/word/word/word.interfaces.documentdata.yml @@ -110,6 +110,21 @@ properties: type: >- | "Off" | "TrackAll" | "TrackMineOnly" + - name: coauthoring + uid: word!Word.Interfaces.DocumentData#coauthoring:member + package: word! + fullName: coauthoring + summary: Gets a `Coauthoring` object for managing coauthoring in the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'coauthoring?: Word.Interfaces.CoauthoringData;' + return: + type: - name: consecutiveHyphensLimit uid: word!Word.Interfaces.DocumentData#consecutiveHyphensLimit:member package: word! @@ -246,6 +261,23 @@ properties: content: 'languageDetected?: boolean;' return: type: boolean + - name: listTemplates + uid: word!Word.Interfaces.DocumentData#listTemplates:member + package: word! + fullName: listTemplates + summary: >- + Returns a `ListTemplateCollection` object that represents all the list + templates in the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'listTemplates?: Word.Interfaces.ListTemplateData[];' + return: + type: [] - name: pageSetup uid: word!Word.Interfaces.DocumentData#pageSetup:member package: word! @@ -308,6 +340,23 @@ properties: content: 'sections?: Word.Interfaces.SectionData[];' return: type: [] + - name: selection + uid: word!Word.Interfaces.DocumentData#selection:member + package: word! + fullName: selection + summary: >- + Returns a `Selection` object that represents the current selection in the + document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'selection?: Word.Interfaces.SelectionData;' + return: + type: - name: settings uid: word!Word.Interfaces.DocumentData#settings:member package: word! diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.documentloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.documentloadoptions.yml index 9cf5d106c5..eb58045f52 100644 --- a/docs/docs-ref-autogen/word/word/word.interfaces.documentloadoptions.yml +++ b/docs/docs-ref-autogen/word/word/word.interfaces.documentloadoptions.yml @@ -142,6 +142,21 @@ properties: content: 'changeTrackingMode?: boolean;' return: type: boolean + - name: coauthoring + uid: word!Word.Interfaces.DocumentLoadOptions#coauthoring:member + package: word! + fullName: coauthoring + summary: Gets a `Coauthoring` object for managing coauthoring in the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'coauthoring?: Word.Interfaces.CoauthoringLoadOptions;' + return: + type: - name: consecutiveHyphensLimit uid: word!Word.Interfaces.DocumentLoadOptions#consecutiveHyphensLimit:member package: word! @@ -240,3 +255,20 @@ properties: content: 'saved?: boolean;' return: type: boolean + - name: selection + uid: word!Word.Interfaces.DocumentLoadOptions#selection:member + package: word! + fullName: selection + summary: >- + Returns a `Selection` object that represents the current selection in the + document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'selection?: Word.Interfaces.SelectionLoadOptions;' + return: + type: diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.editordata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.editordata.yml new file mode 100644 index 0000000000..af8a6a7b00 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.editordata.yml @@ -0,0 +1,80 @@ +### YamlMime:TSType +name: Word.Interfaces.EditorData +uid: word!Word.Interfaces.EditorData:interface +package: word! +fullName: Word.Interfaces.EditorData +summary: >- + An interface describing the data returned by calling `editor.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: id + uid: word!Word.Interfaces.EditorData#id:member + package: word! + fullName: id + summary: >- + Gets the identifier for the `Editor` object when the parent document is + saved as a webpage. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'id?: string;' + return: + type: string + - name: name + uid: word!Word.Interfaces.EditorData#name:member + package: word! + fullName: name + summary: Gets the name of the editor. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string + - name: nextRange + uid: word!Word.Interfaces.EditorData#nextRange:member + package: word! + fullName: nextRange + summary: >- + Gets a `Range` object that represents the next range that the editor has + permissions to modify. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'nextRange?: Word.Interfaces.RangeData;' + return: + type: + - name: range + uid: word!Word.Interfaces.EditorData#range:member + package: word! + fullName: range + summary: >- + Gets a `Range` object that represents the portion of the document that's + contained in the `Editor` object. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'range?: Word.Interfaces.RangeData;' + return: + type: diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.editorloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.editorloadoptions.yml new file mode 100644 index 0000000000..ee0e25baae --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.editorloadoptions.yml @@ -0,0 +1,101 @@ +### YamlMime:TSType +name: Word.Interfaces.EditorLoadOptions +uid: word!Word.Interfaces.EditorLoadOptions:interface +package: word! +fullName: Word.Interfaces.EditorLoadOptions +summary: >- + Represents a user with permissions to edit authorized portions of a protected + (read-only) Word document. To learn more, see [Allow changes to parts of a + protected Word + document](https://support.microsoft.com/office/187ed01c-8795-43e1-9fd0-c9fca419dadf). +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: $all + uid: word!Word.Interfaces.EditorLoadOptions#$all:member + package: word! + 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: true + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: id + uid: word!Word.Interfaces.EditorLoadOptions#id:member + package: word! + fullName: id + summary: >- + Gets the identifier for the `Editor` object when the parent document is + saved as a webpage. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: name + uid: word!Word.Interfaces.EditorLoadOptions#name:member + package: word! + fullName: name + summary: Gets the name of the editor. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: nextRange + uid: word!Word.Interfaces.EditorLoadOptions#nextRange:member + package: word! + fullName: nextRange + summary: >- + Gets a `Range` object that represents the next range that the editor has + permissions to modify. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'nextRange?: Word.Interfaces.RangeLoadOptions;' + return: + type: + - name: range + uid: word!Word.Interfaces.EditorLoadOptions#range:member + package: word! + fullName: range + summary: >- + Gets a `Range` object that represents the portion of the document that's + contained in the `Editor` object. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'range?: Word.Interfaces.RangeLoadOptions;' + return: + type: diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.editorupdatedata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.editorupdatedata.yml new file mode 100644 index 0000000000..33c7cc7ca2 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.editorupdatedata.yml @@ -0,0 +1,48 @@ +### YamlMime:TSType +name: Word.Interfaces.EditorUpdateData +uid: word!Word.Interfaces.EditorUpdateData:interface +package: word! +fullName: Word.Interfaces.EditorUpdateData +summary: >- + An interface for updating data on the `Editor` object, for use in + `editor.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: nextRange + uid: word!Word.Interfaces.EditorUpdateData#nextRange:member + package: word! + fullName: nextRange + summary: >- + Gets a `Range` object that represents the next range that the editor has + permissions to modify. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'nextRange?: Word.Interfaces.RangeUpdateData;' + return: + type: + - name: range + uid: word!Word.Interfaces.EditorUpdateData#range:member + package: word! + fullName: range + summary: >- + Gets a `Range` object that represents the portion of the document that's + contained in the `Editor` object. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'range?: Word.Interfaces.RangeUpdateData;' + return: + type: diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.headingstylecollectiondata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.headingstylecollectiondata.yml new file mode 100644 index 0000000000..6d3fffa6d9 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.headingstylecollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Word.Interfaces.HeadingStyleCollectionData +uid: word!Word.Interfaces.HeadingStyleCollectionData:interface +package: word! +fullName: Word.Interfaces.HeadingStyleCollectionData +summary: >- + An interface describing the data returned by calling + `headingStyleCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: word!Word.Interfaces.HeadingStyleCollectionData#items:member + package: word! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Word.Interfaces.HeadingStyleData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.headingstylecollectionloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.headingstylecollectionloadoptions.yml new file mode 100644 index 0000000000..c218bb574b --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.headingstylecollectionloadoptions.yml @@ -0,0 +1,67 @@ +### YamlMime:TSType +name: Word.Interfaces.HeadingStyleCollectionLoadOptions +uid: word!Word.Interfaces.HeadingStyleCollectionLoadOptions:interface +package: word! +fullName: Word.Interfaces.HeadingStyleCollectionLoadOptions +summary: >- + Represents a collection of + [Word.HeadingStyle](xref:word!Word.HeadingStyle:class) objects in a Word + document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: $all + uid: word!Word.Interfaces.HeadingStyleCollectionLoadOptions#$all:member + package: word! + 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: true + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: level + uid: word!Word.Interfaces.HeadingStyleCollectionLoadOptions#level:member + package: word! + fullName: level + summary: >- + For EACH ITEM in the collection: Specifies the level for the heading style + in a table of contents or table of figures. Must be a value from 1 to 9. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'level?: boolean;' + return: + type: boolean + - name: name + uid: word!Word.Interfaces.HeadingStyleCollectionLoadOptions#name:member + package: word! + fullName: name + summary: >- + For EACH ITEM in the collection: Specifies the name of style for a + heading. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.headingstylecollectionupdatedata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.headingstylecollectionupdatedata.yml new file mode 100644 index 0000000000..97cb5e593b --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.headingstylecollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Word.Interfaces.HeadingStyleCollectionUpdateData +uid: word!Word.Interfaces.HeadingStyleCollectionUpdateData:interface +package: word! +fullName: Word.Interfaces.HeadingStyleCollectionUpdateData +summary: >- + An interface for updating data on the `HeadingStyleCollection` object, for use + in `headingStyleCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: word!Word.Interfaces.HeadingStyleCollectionUpdateData#items:member + package: word! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Word.Interfaces.HeadingStyleData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.headingstyledata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.headingstyledata.yml new file mode 100644 index 0000000000..13aa3f5eb5 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.headingstyledata.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: Word.Interfaces.HeadingStyleData +uid: word!Word.Interfaces.HeadingStyleData:interface +package: word! +fullName: Word.Interfaces.HeadingStyleData +summary: >- + An interface describing the data returned by calling + `headingStyle.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: level + uid: word!Word.Interfaces.HeadingStyleData#level:member + package: word! + fullName: level + summary: >- + Specifies the level for the heading style in a table of contents or table + of figures. Must be a value from 1 to 9. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'level?: number;' + return: + type: number + - name: name + uid: word!Word.Interfaces.HeadingStyleData#name:member + package: word! + fullName: name + summary: Specifies the name of style for a heading. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.headingstyleloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.headingstyleloadoptions.yml new file mode 100644 index 0000000000..d85547d65b --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.headingstyleloadoptions.yml @@ -0,0 +1,62 @@ +### YamlMime:TSType +name: Word.Interfaces.HeadingStyleLoadOptions +uid: word!Word.Interfaces.HeadingStyleLoadOptions:interface +package: word! +fullName: Word.Interfaces.HeadingStyleLoadOptions +summary: Represents a heading style used in a table of contents or table of figures. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: $all + uid: word!Word.Interfaces.HeadingStyleLoadOptions#$all:member + package: word! + 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: true + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: level + uid: word!Word.Interfaces.HeadingStyleLoadOptions#level:member + package: word! + fullName: level + summary: >- + Specifies the level for the heading style in a table of contents or table + of figures. Must be a value from 1 to 9. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'level?: boolean;' + return: + type: boolean + - name: name + uid: word!Word.Interfaces.HeadingStyleLoadOptions#name:member + package: word! + fullName: name + summary: Specifies the name of style for a heading. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.headingstyleupdatedata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.headingstyleupdatedata.yml new file mode 100644 index 0000000000..acfba17f8b --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.headingstyleupdatedata.yml @@ -0,0 +1,46 @@ +### YamlMime:TSType +name: Word.Interfaces.HeadingStyleUpdateData +uid: word!Word.Interfaces.HeadingStyleUpdateData:interface +package: word! +fullName: Word.Interfaces.HeadingStyleUpdateData +summary: >- + An interface for updating data on the `HeadingStyle` object, for use in + `headingStyle.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: level + uid: word!Word.Interfaces.HeadingStyleUpdateData#level:member + package: word! + fullName: level + summary: >- + Specifies the level for the heading style in a table of contents or table + of figures. Must be a value from 1 to 9. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'level?: number;' + return: + type: number + - name: name + uid: word!Word.Interfaces.HeadingStyleUpdateData#name:member + package: word! + fullName: name + summary: Specifies the name of style for a heading. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.listtemplatecollectiondata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.listtemplatecollectiondata.yml new file mode 100644 index 0000000000..c7e08861dd --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.listtemplatecollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Word.Interfaces.ListTemplateCollectionData +uid: word!Word.Interfaces.ListTemplateCollectionData:interface +package: word! +fullName: Word.Interfaces.ListTemplateCollectionData +summary: >- + An interface describing the data returned by calling + `listTemplateCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: word!Word.Interfaces.ListTemplateCollectionData#items:member + package: word! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Word.Interfaces.ListTemplateData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.listtemplatecollectionloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.listtemplatecollectionloadoptions.yml new file mode 100644 index 0000000000..4cb906e582 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.listtemplatecollectionloadoptions.yml @@ -0,0 +1,66 @@ +### YamlMime:TSType +name: Word.Interfaces.ListTemplateCollectionLoadOptions +uid: word!Word.Interfaces.ListTemplateCollectionLoadOptions:interface +package: word! +fullName: Word.Interfaces.ListTemplateCollectionLoadOptions +summary: >- + Contains a collection of + [Word.ListTemplate](xref:word!Word.ListTemplate:class) objects in a document, + list template gallery, or document template. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: $all + uid: word!Word.Interfaces.ListTemplateCollectionLoadOptions#$all:member + package: word! + 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: true + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: name + uid: word!Word.Interfaces.ListTemplateCollectionLoadOptions#name:member + package: word! + fullName: name + summary: 'For EACH ITEM in the collection: Specifies the name of the list template.' + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean + - name: outlineNumbered + uid: >- + word!Word.Interfaces.ListTemplateCollectionLoadOptions#outlineNumbered:member + package: word! + fullName: outlineNumbered + summary: >- + For EACH ITEM in the collection: Specifies whether the list template is + outline numbered. + remarks: >- + \[ [API set: WordApiDesktop + 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'outlineNumbered?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.listtemplatecollectionupdatedata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.listtemplatecollectionupdatedata.yml new file mode 100644 index 0000000000..0fe4cfed3f --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.listtemplatecollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Word.Interfaces.ListTemplateCollectionUpdateData +uid: word!Word.Interfaces.ListTemplateCollectionUpdateData:interface +package: word! +fullName: Word.Interfaces.ListTemplateCollectionUpdateData +summary: >- + An interface for updating data on the `ListTemplateCollection` object, for use + in `listTemplateCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: word!Word.Interfaces.ListTemplateCollectionUpdateData#items:member + package: word! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Word.Interfaces.ListTemplateData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.listtemplatedata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.listtemplatedata.yml index 6d92b43285..a70a47a29d 100644 --- a/docs/docs-ref-autogen/word/word/word.interfaces.listtemplatedata.yml +++ b/docs/docs-ref-autogen/word/word/word.interfaces.listtemplatedata.yml @@ -29,6 +29,21 @@ properties: content: 'listLevels?: Word.Interfaces.ListLevelData[];' return: type: [] + - name: name + uid: word!Word.Interfaces.ListTemplateData#name:member + package: word! + fullName: name + summary: Specifies the name of the list template. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string - name: outlineNumbered uid: word!Word.Interfaces.ListTemplateData#outlineNumbered:member package: word! diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.listtemplategallerycollectiondata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.listtemplategallerycollectiondata.yml new file mode 100644 index 0000000000..8adbd9e3bb --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.listtemplategallerycollectiondata.yml @@ -0,0 +1,29 @@ +### YamlMime:TSType +name: Word.Interfaces.ListTemplateGalleryCollectionData +uid: word!Word.Interfaces.ListTemplateGalleryCollectionData:interface +package: word! +fullName: Word.Interfaces.ListTemplateGalleryCollectionData +summary: >- + An interface describing the data returned by calling + `listTemplateGalleryCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: word!Word.Interfaces.ListTemplateGalleryCollectionData#items:member + package: word! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Word.Interfaces.ListTemplateGalleryData[];' + return: + type: >- + [] diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.listtemplategallerycollectionupdatedata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.listtemplategallerycollectionupdatedata.yml new file mode 100644 index 0000000000..eeb9476cf3 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.listtemplategallerycollectionupdatedata.yml @@ -0,0 +1,29 @@ +### YamlMime:TSType +name: Word.Interfaces.ListTemplateGalleryCollectionUpdateData +uid: word!Word.Interfaces.ListTemplateGalleryCollectionUpdateData:interface +package: word! +fullName: Word.Interfaces.ListTemplateGalleryCollectionUpdateData +summary: >- + An interface for updating data on the `ListTemplateGalleryCollection` object, + for use in `listTemplateGalleryCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: word!Word.Interfaces.ListTemplateGalleryCollectionUpdateData#items:member + package: word! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Word.Interfaces.ListTemplateGalleryData[];' + return: + type: >- + [] diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.listtemplategallerydata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.listtemplategallerydata.yml new file mode 100644 index 0000000000..2d963eaad0 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.listtemplategallerydata.yml @@ -0,0 +1,13 @@ +### YamlMime:TSType +name: Word.Interfaces.ListTemplateGalleryData +uid: word!Word.Interfaces.ListTemplateGalleryData:interface +package: word! +fullName: Word.Interfaces.ListTemplateGalleryData +summary: >- + An interface describing the data returned by calling + `listTemplateGallery.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.listtemplateloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.listtemplateloadoptions.yml index 525395caa3..f8d4542c2b 100644 --- a/docs/docs-ref-autogen/word/word/word.interfaces.listtemplateloadoptions.yml +++ b/docs/docs-ref-autogen/word/word/word.interfaces.listtemplateloadoptions.yml @@ -28,6 +28,21 @@ properties: content: '$all?: boolean;' return: type: boolean + - name: name + uid: word!Word.Interfaces.ListTemplateLoadOptions#name:member + package: word! + fullName: name + summary: Specifies the name of the list template. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean - name: outlineNumbered uid: word!Word.Interfaces.ListTemplateLoadOptions#outlineNumbered:member package: word! diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.listtemplateupdatedata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.listtemplateupdatedata.yml index 2c21f55472..fc7fd460c3 100644 --- a/docs/docs-ref-autogen/word/word/word.interfaces.listtemplateupdatedata.yml +++ b/docs/docs-ref-autogen/word/word/word.interfaces.listtemplateupdatedata.yml @@ -12,6 +12,21 @@ isPreview: false isDeprecated: false type: interface properties: + - name: name + uid: word!Word.Interfaces.ListTemplateUpdateData#name:member + package: word! + fullName: name + summary: Specifies the name of the list template. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string - name: outlineNumbered uid: word!Word.Interfaces.ListTemplateUpdateData#outlineNumbered:member package: word! diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.panecollectionloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.panecollectionloadoptions.yml new file mode 100644 index 0000000000..0dc769ea22 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.panecollectionloadoptions.yml @@ -0,0 +1,47 @@ +### YamlMime:TSType +name: Word.Interfaces.PaneCollectionLoadOptions +uid: word!Word.Interfaces.PaneCollectionLoadOptions:interface +package: word! +fullName: Word.Interfaces.PaneCollectionLoadOptions +summary: Represents the collection of pane. +remarks: >- + \[ [API set: WordApiDesktop + 1.2](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: word!Word.Interfaces.PaneCollectionLoadOptions#$all:member + package: word! + 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: selection + uid: word!Word.Interfaces.PaneCollectionLoadOptions#selection:member + package: word! + fullName: selection + summary: >- + For EACH ITEM in the collection: Returns a `Selection` object that + represents the current selection in the pane. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'selection?: Word.Interfaces.SelectionLoadOptions;' + return: + type: diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.paneloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.paneloadoptions.yml new file mode 100644 index 0000000000..db3d09f2a7 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.paneloadoptions.yml @@ -0,0 +1,50 @@ +### YamlMime:TSType +name: Word.Interfaces.PaneLoadOptions +uid: word!Word.Interfaces.PaneLoadOptions:interface +package: word! +fullName: Word.Interfaces.PaneLoadOptions +summary: >- + Represents a window pane. The `Pane` object is a member of the pane + collection. The pane collection includes all the window panes for a single + window. +remarks: >- + \[ [API set: WordApiDesktop + 1.2](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: $all + uid: word!Word.Interfaces.PaneLoadOptions#$all:member + package: word! + 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: selection + uid: word!Word.Interfaces.PaneLoadOptions#selection:member + package: word! + fullName: selection + summary: >- + Returns a `Selection` object that represents the current selection in the + pane. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'selection?: Word.Interfaces.SelectionLoadOptions;' + return: + type: diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.rangedata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.rangedata.yml index 1d2a9fedf5..2f281e78a7 100644 --- a/docs/docs-ref-autogen/word/word/word.interfaces.rangedata.yml +++ b/docs/docs-ref-autogen/word/word/word.interfaces.rangedata.yml @@ -112,6 +112,23 @@ properties: content: 'combineCharacters?: boolean;' return: type: boolean + - name: conflicts + uid: word!Word.Interfaces.RangeData#conflicts:member + package: word! + fullName: conflicts + summary: >- + Returns a `ConflictCollection` object that contains all the + [Word.Conflict](xref:word!Word.Conflict:class) objects in the range. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'conflicts?: Word.Interfaces.ConflictData[];' + return: + type: [] - name: disableCharacterSpaceGrid uid: word!Word.Interfaces.RangeData#disableCharacterSpaceGrid:member package: word! diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.rangescopedcollectiondata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.rangescopedcollectiondata.yml new file mode 100644 index 0000000000..05f3513a70 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.rangescopedcollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Word.Interfaces.RangeScopedCollectionData +uid: word!Word.Interfaces.RangeScopedCollectionData:interface +package: word! +fullName: Word.Interfaces.RangeScopedCollectionData +summary: >- + An interface describing the data returned by calling + `rangeScopedCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: word!Word.Interfaces.RangeScopedCollectionData#items:member + package: word! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Word.Interfaces.RangeData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.rangescopedcollectionloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.rangescopedcollectionloadoptions.yml new file mode 100644 index 0000000000..c66a64c496 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.rangescopedcollectionloadoptions.yml @@ -0,0 +1,838 @@ +### YamlMime:TSType +name: Word.Interfaces.RangeScopedCollectionLoadOptions +uid: word!Word.Interfaces.RangeScopedCollectionLoadOptions:interface +package: word! +fullName: Word.Interfaces.RangeScopedCollectionLoadOptions +summary: >- + Represents a collection of [Word.Range](xref:word!Word.Range:class) objects + that represents each character, word or sentence. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: $all + uid: word!Word.Interfaces.RangeScopedCollectionLoadOptions#$all:member + package: word! + 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: true + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: bold + uid: word!Word.Interfaces.RangeScopedCollectionLoadOptions#bold:member + package: word! + fullName: bold + summary: >- + For EACH ITEM in the collection: Specifies whether the range is formatted + as bold. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'bold?: boolean;' + return: + type: boolean + - name: boldBidirectional + uid: >- + word!Word.Interfaces.RangeScopedCollectionLoadOptions#boldBidirectional:member + package: word! + fullName: boldBidirectional + summary: >- + For EACH ITEM in the collection: Specifies whether the range is formatted + as bold in a right-to-left language document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'boldBidirectional?: boolean;' + return: + type: boolean + - name: case + uid: word!Word.Interfaces.RangeScopedCollectionLoadOptions#case:member + package: word! + fullName: case + summary: >- + For EACH ITEM in the collection: Specifies a `CharacterCase` value that + represents the case of the text in the range. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'case?: boolean;' + return: + type: boolean + - name: characterWidth + uid: >- + word!Word.Interfaces.RangeScopedCollectionLoadOptions#characterWidth:member + package: word! + fullName: characterWidth + summary: >- + For EACH ITEM in the collection: Specifies the character width of the + range. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'characterWidth?: boolean;' + return: + type: boolean + - name: combineCharacters + uid: >- + word!Word.Interfaces.RangeScopedCollectionLoadOptions#combineCharacters:member + package: word! + fullName: combineCharacters + summary: >- + For EACH ITEM in the collection: Specifies if the range contains combined + characters. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'combineCharacters?: boolean;' + return: + type: boolean + - name: disableCharacterSpaceGrid + uid: >- + word!Word.Interfaces.RangeScopedCollectionLoadOptions#disableCharacterSpaceGrid:member + package: word! + fullName: disableCharacterSpaceGrid + summary: >- + For EACH ITEM in the collection: Specifies if Microsoft Word ignores the + number of characters per line for the corresponding `Range` object. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'disableCharacterSpaceGrid?: boolean;' + return: + type: boolean + - name: emphasisMark + uid: word!Word.Interfaces.RangeScopedCollectionLoadOptions#emphasisMark:member + package: word! + fullName: emphasisMark + summary: >- + For EACH ITEM in the collection: Specifies the emphasis mark for a + character or designated character string. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'emphasisMark?: boolean;' + return: + type: boolean + - name: end + uid: word!Word.Interfaces.RangeScopedCollectionLoadOptions#end:member + package: word! + fullName: end + summary: >- + For EACH ITEM in the collection: Specifies the ending character position + of the range. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'end?: boolean;' + return: + type: boolean + - name: fitTextWidth + uid: word!Word.Interfaces.RangeScopedCollectionLoadOptions#fitTextWidth:member + package: word! + fullName: fitTextWidth + summary: >- + For EACH ITEM in the collection: Specifies the width (in the current + measurement units) in which Microsoft Word fits the text in the current + selection or range. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'fitTextWidth?: boolean;' + return: + type: boolean + - name: font + uid: word!Word.Interfaces.RangeScopedCollectionLoadOptions#font:member + package: word! + fullName: font + summary: >- + For EACH ITEM in the collection: Gets the text format of the range. Use + this to get and set font name, size, color, and other properties. + remarks: >- + \[ [API set: WordApi + 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'font?: Word.Interfaces.FontLoadOptions;' + return: + type: + - name: grammarChecked + uid: >- + word!Word.Interfaces.RangeScopedCollectionLoadOptions#grammarChecked:member + package: word! + fullName: grammarChecked + summary: >- + For EACH ITEM in the collection: Specifies if a grammar check has been run + on the range or document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'grammarChecked?: boolean;' + return: + type: boolean + - name: hasNoProofing + uid: word!Word.Interfaces.RangeScopedCollectionLoadOptions#hasNoProofing:member + package: word! + fullName: hasNoProofing + summary: >- + For EACH ITEM in the collection: Specifies the proofing status (spelling + and grammar checking) of the range. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'hasNoProofing?: boolean;' + return: + type: boolean + - name: highlightColorIndex + uid: >- + word!Word.Interfaces.RangeScopedCollectionLoadOptions#highlightColorIndex:member + package: word! + fullName: highlightColorIndex + summary: >- + For EACH ITEM in the collection: Specifies the highlight color for the + range. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'highlightColorIndex?: boolean;' + return: + type: boolean + - name: horizontalInVertical + uid: >- + word!Word.Interfaces.RangeScopedCollectionLoadOptions#horizontalInVertical:member + package: word! + fullName: horizontalInVertical + summary: >- + For EACH ITEM in the collection: Specifies the formatting for horizontal + text set within vertical text. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'horizontalInVertical?: boolean;' + return: + type: boolean + - name: hyperlink + uid: word!Word.Interfaces.RangeScopedCollectionLoadOptions#hyperlink:member + package: word! + fullName: hyperlink + summary: >- + For EACH ITEM in the collection: Gets the first hyperlink in the range, or + sets a hyperlink on the range. All hyperlinks in the range are deleted + when you set a new hyperlink on the range. Use a '\#' to separate the + address part from the optional location part. + remarks: >- + \[ [API set: WordApi + 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'hyperlink?: boolean;' + return: + type: boolean + - name: id + uid: word!Word.Interfaces.RangeScopedCollectionLoadOptions#id:member + package: word! + fullName: id + summary: 'For EACH ITEM in the collection: Specifies the ID for the range.' + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'id?: boolean;' + return: + type: boolean + - name: isEmpty + uid: word!Word.Interfaces.RangeScopedCollectionLoadOptions#isEmpty:member + package: word! + fullName: isEmpty + summary: 'For EACH ITEM in the collection: Checks whether the range length is zero.' + remarks: >- + \[ [API set: WordApi + 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isEmpty?: boolean;' + return: + type: boolean + - name: isEndOfRowMark + uid: >- + word!Word.Interfaces.RangeScopedCollectionLoadOptions#isEndOfRowMark:member + package: word! + fullName: isEndOfRowMark + summary: >- + For EACH ITEM in the collection: Gets if the range is collapsed and is + located at the end-of-row mark in a table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isEndOfRowMark?: boolean;' + return: + type: boolean + - name: isTextVisibleOnScreen + uid: >- + word!Word.Interfaces.RangeScopedCollectionLoadOptions#isTextVisibleOnScreen:member + package: word! + fullName: isTextVisibleOnScreen + summary: >- + For EACH ITEM in the collection: Gets whether the text in the range is + visible on the screen. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isTextVisibleOnScreen?: boolean;' + return: + type: boolean + - name: italic + uid: word!Word.Interfaces.RangeScopedCollectionLoadOptions#italic:member + package: word! + fullName: italic + summary: >- + For EACH ITEM in the collection: Specifies if the font or range is + formatted as italic. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'italic?: boolean;' + return: + type: boolean + - name: italicBidirectional + uid: >- + word!Word.Interfaces.RangeScopedCollectionLoadOptions#italicBidirectional:member + package: word! + fullName: italicBidirectional + summary: >- + For EACH ITEM in the collection: Specifies if the font or range is + formatted as italic (right-to-left languages). + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'italicBidirectional?: boolean;' + return: + type: boolean + - name: kana + uid: word!Word.Interfaces.RangeScopedCollectionLoadOptions#kana:member + package: word! + fullName: kana + summary: >- + For EACH ITEM in the collection: Specifies whether the range of Japanese + language text is hiragana or katakana. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'kana?: boolean;' + return: + type: boolean + - name: languageDetected + uid: >- + word!Word.Interfaces.RangeScopedCollectionLoadOptions#languageDetected:member + package: word! + fullName: languageDetected + summary: >- + For EACH ITEM in the collection: Specifies whether Microsoft Word has + detected the language of the text in the range. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'languageDetected?: boolean;' + return: + type: boolean + - name: languageId + uid: word!Word.Interfaces.RangeScopedCollectionLoadOptions#languageId:member + package: word! + fullName: languageId + summary: >- + For EACH ITEM in the collection: Specifies a `LanguageId` value that + represents the language for the range. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'languageId?: boolean;' + return: + type: boolean + - name: languageIdFarEast + uid: >- + word!Word.Interfaces.RangeScopedCollectionLoadOptions#languageIdFarEast:member + package: word! + fullName: languageIdFarEast + summary: >- + For EACH ITEM in the collection: Specifies an East Asian language for the + range. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'languageIdFarEast?: boolean;' + return: + type: boolean + - name: languageIdOther + uid: >- + word!Word.Interfaces.RangeScopedCollectionLoadOptions#languageIdOther:member + package: word! + fullName: languageIdOther + summary: >- + For EACH ITEM in the collection: Specifies a language for the range that + isn't classified as an East Asian language. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'languageIdOther?: boolean;' + return: + type: boolean + - name: listFormat + uid: word!Word.Interfaces.RangeScopedCollectionLoadOptions#listFormat:member + package: word! + fullName: listFormat + summary: >- + For EACH ITEM in the collection: Returns a `ListFormat` object that + represents all the list formatting characteristics of the range. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'listFormat?: Word.Interfaces.ListFormatLoadOptions;' + return: + type: + - name: parentBody + uid: word!Word.Interfaces.RangeScopedCollectionLoadOptions#parentBody:member + package: word! + fullName: parentBody + summary: 'For EACH ITEM in the collection: Gets the parent body of the range.' + remarks: >- + \[ [API set: WordApi + 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'parentBody?: Word.Interfaces.BodyLoadOptions;' + return: + type: + - name: parentContentControl + uid: >- + word!Word.Interfaces.RangeScopedCollectionLoadOptions#parentContentControl:member + package: word! + fullName: parentContentControl + summary: >- + For EACH ITEM in the collection: Gets the currently supported content + control that contains the range. Throws an `ItemNotFound` error if there + isn't a parent content control. + remarks: >- + \[ [API set: WordApi + 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'parentContentControl?: Word.Interfaces.ContentControlLoadOptions;' + return: + type: >- + + - name: parentContentControlOrNullObject + uid: >- + word!Word.Interfaces.RangeScopedCollectionLoadOptions#parentContentControlOrNullObject:member + package: word! + fullName: parentContentControlOrNullObject + summary: >- + For EACH ITEM in the collection: Gets the currently supported content + control that contains the range. If there isn't a parent content control, + then this method will return 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: WordApi + 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + parentContentControlOrNullObject?: + Word.Interfaces.ContentControlLoadOptions; + return: + type: >- + + - name: parentTable + uid: word!Word.Interfaces.RangeScopedCollectionLoadOptions#parentTable:member + package: word! + fullName: parentTable + summary: >- + For EACH ITEM in the collection: Gets the table that contains the range. + Throws an `ItemNotFound` error if it isn't contained in a table. + remarks: >- + \[ [API set: WordApi + 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'parentTable?: Word.Interfaces.TableLoadOptions;' + return: + type: + - name: parentTableCell + uid: >- + word!Word.Interfaces.RangeScopedCollectionLoadOptions#parentTableCell:member + package: word! + fullName: parentTableCell + summary: >- + For EACH ITEM in the collection: Gets the table cell that contains the + range. Throws an `ItemNotFound` error if it isn't contained in a table + cell. + remarks: >- + \[ [API set: WordApi + 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'parentTableCell?: Word.Interfaces.TableCellLoadOptions;' + return: + type: + - name: parentTableCellOrNullObject + uid: >- + word!Word.Interfaces.RangeScopedCollectionLoadOptions#parentTableCellOrNullObject:member + package: word! + fullName: parentTableCellOrNullObject + summary: >- + For EACH ITEM in the collection: Gets the table cell that contains the + range. If it isn't contained in a table cell, then this method will return + 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: WordApi + 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;' + return: + type: + - name: parentTableOrNullObject + uid: >- + word!Word.Interfaces.RangeScopedCollectionLoadOptions#parentTableOrNullObject:member + package: word! + fullName: parentTableOrNullObject + summary: >- + For EACH ITEM in the collection: Gets the table that contains the range. + If it isn't contained in a table, then this method will return 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: WordApi + 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;' + return: + type: + - name: shading + uid: word!Word.Interfaces.RangeScopedCollectionLoadOptions#shading:member + package: word! + fullName: shading + summary: >- + For EACH ITEM in the collection: Returns a `ShadingUniversal` object that + refers to the shading formatting for the range. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'shading?: Word.Interfaces.ShadingUniversalLoadOptions;' + return: + type: >- + + - name: showAll + uid: word!Word.Interfaces.RangeScopedCollectionLoadOptions#showAll:member + package: word! + fullName: showAll + summary: >- + For EACH ITEM in the collection: Specifies if all nonprinting characters + (such as hidden text, tab marks, space marks, and paragraph marks) are + displayed. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'showAll?: boolean;' + return: + type: boolean + - name: spellingChecked + uid: >- + word!Word.Interfaces.RangeScopedCollectionLoadOptions#spellingChecked:member + package: word! + fullName: spellingChecked + summary: >- + For EACH ITEM in the collection: Specifies if spelling has been checked + throughout the range or document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'spellingChecked?: boolean;' + return: + type: boolean + - name: start + uid: word!Word.Interfaces.RangeScopedCollectionLoadOptions#start:member + package: word! + fullName: start + summary: >- + For EACH ITEM in the collection: Specifies the starting character position + of the range. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'start?: boolean;' + return: + type: boolean + - name: storyLength + uid: word!Word.Interfaces.RangeScopedCollectionLoadOptions#storyLength:member + package: word! + fullName: storyLength + summary: >- + For EACH ITEM in the collection: Gets the number of characters in the + story that contains the range. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'storyLength?: boolean;' + return: + type: boolean + - name: storyType + uid: word!Word.Interfaces.RangeScopedCollectionLoadOptions#storyType:member + package: word! + fullName: storyType + summary: 'For EACH ITEM in the collection: Gets the story type for the range.' + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'storyType?: boolean;' + return: + type: boolean + - name: style + uid: word!Word.Interfaces.RangeScopedCollectionLoadOptions#style:member + package: word! + fullName: style + summary: >- + For EACH ITEM in the collection: Specifies the style name for the range. + Use this property for custom styles and localized style names. To use the + built-in styles that are portable between locales, see the "styleBuiltIn" + property. + remarks: >- + \[ [API set: WordApi + 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'style?: boolean;' + return: + type: boolean + - name: styleBuiltIn + uid: word!Word.Interfaces.RangeScopedCollectionLoadOptions#styleBuiltIn:member + package: word! + fullName: styleBuiltIn + summary: >- + For EACH ITEM in the collection: Specifies the built-in style name for the + range. Use this property for built-in styles that are portable between + locales. To use custom styles or localized style names, see the "style" + property. + remarks: >- + \[ [API set: WordApi + 1.3](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'styleBuiltIn?: boolean;' + return: + type: boolean + - name: text + uid: word!Word.Interfaces.RangeScopedCollectionLoadOptions#text:member + package: word! + fullName: text + summary: 'For EACH ITEM in the collection: Gets the text of the range.' + remarks: >- + \[ [API set: WordApi + 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'text?: boolean;' + return: + type: boolean + - name: twoLinesInOne + uid: word!Word.Interfaces.RangeScopedCollectionLoadOptions#twoLinesInOne:member + package: word! + fullName: twoLinesInOne + summary: >- + For EACH ITEM in the collection: Specifies whether Microsoft Word sets two + lines of text in one and specifies the characters that enclose the text, + if any. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'twoLinesInOne?: boolean;' + return: + type: boolean + - name: underline + uid: word!Word.Interfaces.RangeScopedCollectionLoadOptions#underline:member + package: word! + fullName: underline + summary: >- + For EACH ITEM in the collection: Specifies the type of underline applied + to the range. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'underline?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.rangescopedcollectionupdatedata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.rangescopedcollectionupdatedata.yml new file mode 100644 index 0000000000..6ccc40d8d6 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.rangescopedcollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Word.Interfaces.RangeScopedCollectionUpdateData +uid: word!Word.Interfaces.RangeScopedCollectionUpdateData:interface +package: word! +fullName: Word.Interfaces.RangeScopedCollectionUpdateData +summary: >- + An interface for updating data on the `RangeScopedCollection` object, for use + in `rangeScopedCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: word!Word.Interfaces.RangeScopedCollectionUpdateData#items:member + package: word! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Word.Interfaces.RangeData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.revisioncollectiondata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.revisioncollectiondata.yml new file mode 100644 index 0000000000..88df6103bc --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.revisioncollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Word.Interfaces.RevisionCollectionData +uid: word!Word.Interfaces.RevisionCollectionData:interface +package: word! +fullName: Word.Interfaces.RevisionCollectionData +summary: >- + An interface describing the data returned by calling + `revisionCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: word!Word.Interfaces.RevisionCollectionData#items:member + package: word! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Word.Interfaces.RevisionData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.revisioncollectionloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.revisioncollectionloadoptions.yml new file mode 100644 index 0000000000..abbf7c1136 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.revisioncollectionloadoptions.yml @@ -0,0 +1,159 @@ +### YamlMime:TSType +name: Word.Interfaces.RevisionCollectionLoadOptions +uid: word!Word.Interfaces.RevisionCollectionLoadOptions:interface +package: word! +fullName: Word.Interfaces.RevisionCollectionLoadOptions +summary: >- + A collection of Revision objects that represent the changes marked with + revision marks in a range or document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: $all + uid: word!Word.Interfaces.RevisionCollectionLoadOptions#$all:member + package: word! + 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: true + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: author + uid: word!Word.Interfaces.RevisionCollectionLoadOptions#author:member + package: word! + fullName: author + summary: >- + For EACH ITEM in the collection: Gets the name of the user who made the + tracked change. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'author?: boolean;' + return: + type: boolean + - name: date + uid: word!Word.Interfaces.RevisionCollectionLoadOptions#date:member + package: word! + fullName: date + summary: >- + For EACH ITEM in the collection: Gets the date and time when the tracked + change was made. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'date?: boolean;' + return: + type: boolean + - name: formatDescription + uid: >- + word!Word.Interfaces.RevisionCollectionLoadOptions#formatDescription:member + package: word! + fullName: formatDescription + summary: >- + For EACH ITEM in the collection: Gets the description of tracked + formatting changes in the revision. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'formatDescription?: boolean;' + return: + type: boolean + - name: index + uid: word!Word.Interfaces.RevisionCollectionLoadOptions#index:member + package: word! + fullName: index + summary: >- + For EACH ITEM in the collection: Gets a number that represents the + position of this item in a collection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'index?: boolean;' + return: + type: boolean + - name: movedRange + uid: word!Word.Interfaces.RevisionCollectionLoadOptions#movedRange:member + package: word! + fullName: movedRange + summary: >- + For EACH ITEM in the collection: Gets a `Range` object that represents the + range of text that was moved from one place to another in the document + with tracked changes. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'movedRange?: Word.Interfaces.RangeLoadOptions;' + return: + type: + - name: range + uid: word!Word.Interfaces.RevisionCollectionLoadOptions#range:member + package: word! + fullName: range + summary: >- + For EACH ITEM in the collection: Gets a `Range` object that represents the + portion of the document that's contained within a revision mark. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'range?: Word.Interfaces.RangeLoadOptions;' + return: + type: + - name: type + uid: word!Word.Interfaces.RevisionCollectionLoadOptions#type:member + package: word! + fullName: type + summary: 'For EACH ITEM in the collection: Gets the revision type.' + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'type?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.revisioncollectionupdatedata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.revisioncollectionupdatedata.yml new file mode 100644 index 0000000000..09d9346622 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.revisioncollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Word.Interfaces.RevisionCollectionUpdateData +uid: word!Word.Interfaces.RevisionCollectionUpdateData:interface +package: word! +fullName: Word.Interfaces.RevisionCollectionUpdateData +summary: >- + An interface for updating data on the `RevisionCollection` object, for use in + `revisionCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: word!Word.Interfaces.RevisionCollectionUpdateData#items:member + package: word! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Word.Interfaces.RevisionData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.revisiondata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.revisiondata.yml new file mode 100644 index 0000000000..8ccaf48602 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.revisiondata.yml @@ -0,0 +1,142 @@ +### YamlMime:TSType +name: Word.Interfaces.RevisionData +uid: word!Word.Interfaces.RevisionData:interface +package: word! +fullName: Word.Interfaces.RevisionData +summary: >- + An interface describing the data returned by calling `revision.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: author + uid: word!Word.Interfaces.RevisionData#author:member + package: word! + fullName: author + summary: Gets the name of the user who made the tracked change. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'author?: string;' + return: + type: string + - name: date + uid: word!Word.Interfaces.RevisionData#date:member + package: word! + fullName: date + summary: Gets the date and time when the tracked change was made. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'date?: Date;' + return: + type: Date + - name: formatDescription + uid: word!Word.Interfaces.RevisionData#formatDescription:member + package: word! + fullName: formatDescription + summary: Gets the description of tracked formatting changes in the revision. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'formatDescription?: string;' + return: + type: string + - name: index + uid: word!Word.Interfaces.RevisionData#index:member + package: word! + fullName: index + summary: Gets a number that represents the position of this item in a collection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'index?: number;' + return: + type: number + - name: movedRange + uid: word!Word.Interfaces.RevisionData#movedRange:member + package: word! + fullName: movedRange + summary: >- + Gets a `Range` object that represents the range of text that was moved + from one place to another in the document with tracked changes. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'movedRange?: Word.Interfaces.RangeData;' + return: + type: + - name: range + uid: word!Word.Interfaces.RevisionData#range:member + package: word! + fullName: range + summary: >- + Gets a `Range` object that represents the portion of the document that's + contained within a revision mark. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'range?: Word.Interfaces.RangeData;' + return: + type: + - name: type + uid: word!Word.Interfaces.RevisionData#type:member + package: word! + fullName: type + summary: Gets the revision type. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + type?: Word.RevisionType | "None" | "Insert" | "Delete" | "Property" | + "ParagraphNumber" | "DisplayField" | "Reconcile" | "Conflict" | "Style" + | "Replace" | "ParagraphProperty" | "TableProperty" | "SectionProperty" + | "StyleDefinition" | "MovedFrom" | "MovedTo" | "CellInsertion" | + "CellDeletion" | "CellMerge" | "CellSplit" | "ConflictInsert" | + "ConflictDelete"; + return: + type: >- + | "None" | "Insert" | + "Delete" | "Property" | "ParagraphNumber" | "DisplayField" | + "Reconcile" | "Conflict" | "Style" | "Replace" | "ParagraphProperty" | + "TableProperty" | "SectionProperty" | "StyleDefinition" | "MovedFrom" + | "MovedTo" | "CellInsertion" | "CellDeletion" | "CellMerge" | + "CellSplit" | "ConflictInsert" | "ConflictDelete" diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.revisionloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.revisionloadoptions.yml new file mode 100644 index 0000000000..6641a8e749 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.revisionloadoptions.yml @@ -0,0 +1,147 @@ +### YamlMime:TSType +name: Word.Interfaces.RevisionLoadOptions +uid: word!Word.Interfaces.RevisionLoadOptions:interface +package: word! +fullName: Word.Interfaces.RevisionLoadOptions +summary: Represents a single tracked change in a document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: $all + uid: word!Word.Interfaces.RevisionLoadOptions#$all:member + package: word! + 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: true + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: author + uid: word!Word.Interfaces.RevisionLoadOptions#author:member + package: word! + fullName: author + summary: Gets the name of the user who made the tracked change. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'author?: boolean;' + return: + type: boolean + - name: date + uid: word!Word.Interfaces.RevisionLoadOptions#date:member + package: word! + fullName: date + summary: Gets the date and time when the tracked change was made. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'date?: boolean;' + return: + type: boolean + - name: formatDescription + uid: word!Word.Interfaces.RevisionLoadOptions#formatDescription:member + package: word! + fullName: formatDescription + summary: Gets the description of tracked formatting changes in the revision. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'formatDescription?: boolean;' + return: + type: boolean + - name: index + uid: word!Word.Interfaces.RevisionLoadOptions#index:member + package: word! + fullName: index + summary: Gets a number that represents the position of this item in a collection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'index?: boolean;' + return: + type: boolean + - name: movedRange + uid: word!Word.Interfaces.RevisionLoadOptions#movedRange:member + package: word! + fullName: movedRange + summary: >- + Gets a `Range` object that represents the range of text that was moved + from one place to another in the document with tracked changes. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'movedRange?: Word.Interfaces.RangeLoadOptions;' + return: + type: + - name: range + uid: word!Word.Interfaces.RevisionLoadOptions#range:member + package: word! + fullName: range + summary: >- + Gets a `Range` object that represents the portion of the document that's + contained within a revision mark. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'range?: Word.Interfaces.RangeLoadOptions;' + return: + type: + - name: type + uid: word!Word.Interfaces.RevisionLoadOptions#type:member + package: word! + fullName: type + summary: Gets the revision type. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'type?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.revisionupdatedata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.revisionupdatedata.yml new file mode 100644 index 0000000000..ff64f5a3e8 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.revisionupdatedata.yml @@ -0,0 +1,50 @@ +### YamlMime:TSType +name: Word.Interfaces.RevisionUpdateData +uid: word!Word.Interfaces.RevisionUpdateData:interface +package: word! +fullName: Word.Interfaces.RevisionUpdateData +summary: >- + An interface for updating data on the `Revision` object, for use in + `revision.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: movedRange + uid: word!Word.Interfaces.RevisionUpdateData#movedRange:member + package: word! + fullName: movedRange + summary: >- + Gets a `Range` object that represents the range of text that was moved + from one place to another in the document with tracked changes. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'movedRange?: Word.Interfaces.RangeUpdateData;' + return: + type: + - name: range + uid: word!Word.Interfaces.RevisionUpdateData#range:member + package: word! + fullName: range + summary: >- + Gets a `Range` object that represents the portion of the document that's + contained within a revision mark. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'range?: Word.Interfaces.RangeUpdateData;' + return: + type: diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.selectiondata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.selectiondata.yml new file mode 100644 index 0000000000..c93be5ef2a --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.selectiondata.yml @@ -0,0 +1,621 @@ +### YamlMime:TSType +name: Word.Interfaces.SelectionData +uid: word!Word.Interfaces.SelectionData:interface +package: word! +fullName: Word.Interfaces.SelectionData +summary: >- + An interface describing the data returned by calling `selection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: end + uid: word!Word.Interfaces.SelectionData#end:member + package: word! + fullName: end + summary: Specifies the ending character position of the selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'end?: number;' + return: + type: number + - name: fitTextWidth + uid: word!Word.Interfaces.SelectionData#fitTextWidth:member + package: word! + fullName: fitTextWidth + summary: Specifies the width in which Word fits the text in the current selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'fitTextWidth?: number;' + return: + type: number + - name: hasNoProofing + uid: word!Word.Interfaces.SelectionData#hasNoProofing:member + package: word! + fullName: hasNoProofing + summary: >- + Returns whether the spelling and grammar checker ignores the selected + text. If the selected text contains a mix of proofed and un-proofed + content, this API returns `null`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'hasNoProofing?: boolean;' + return: + type: boolean + - name: isActive + uid: word!Word.Interfaces.SelectionData#isActive:member + package: word! + fullName: isActive + summary: Returns whether the selection in the specified window or pane is active. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isActive?: boolean;' + return: + type: boolean + - name: isColumnSelectModeActive + uid: word!Word.Interfaces.SelectionData#isColumnSelectModeActive:member + package: word! + fullName: isColumnSelectModeActive + summary: Specifies whether column selection mode is active. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isColumnSelectModeActive?: boolean;' + return: + type: boolean + - name: isEndOfRowMark + uid: word!Word.Interfaces.SelectionData#isEndOfRowMark:member + package: word! + fullName: isEndOfRowMark + summary: Returns whether the selection is at the end-of-row mark in a table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isEndOfRowMark?: boolean;' + return: + type: boolean + - name: isExtendModeActive + uid: word!Word.Interfaces.SelectionData#isExtendModeActive:member + package: word! + fullName: isExtendModeActive + summary: Specifies whether Extend mode is active. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isExtendModeActive?: boolean;' + return: + type: boolean + - name: isInsertionPointAtEndOfLine + uid: word!Word.Interfaces.SelectionData#isInsertionPointAtEndOfLine:member + package: word! + fullName: isInsertionPointAtEndOfLine + summary: Returns whether the insertion point is at the end of a line. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isInsertionPointAtEndOfLine?: boolean;' + return: + type: boolean + - name: isStartActive + uid: word!Word.Interfaces.SelectionData#isStartActive:member + package: word! + fullName: isStartActive + summary: Specifies whether the beginning of the selection is active. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isStartActive?: boolean;' + return: + type: boolean + - name: languageDetected + uid: word!Word.Interfaces.SelectionData#languageDetected:member + package: word! + fullName: languageDetected + summary: Specifies whether Word has detected the language of the selected text. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'languageDetected?: boolean;' + return: + type: boolean + - name: languageId + uid: word!Word.Interfaces.SelectionData#languageId:member + package: word! + fullName: languageId + summary: Returns the language for the selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | + "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | + "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | + "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | + "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | + "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | + "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | + "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | + "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" + | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | + "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | + "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | + "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | + "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" + | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | + "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | + "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | + "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" + | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" + | "Galician" | "Georgian" | "German" | "GermanAustria" | + "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | + "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | + "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" + | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | + "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | + "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | + "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | + "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | + "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | + "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | + "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | + "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | + "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | + "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | + "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | + "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | + "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | + "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | + "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" + | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | + "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" + | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | + "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | + "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | + "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | + "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | + "Yiddish" | "Yoruba" | "Zulu"; + return: + type: >- + | "Afrikaans" | "Albanian" | + "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | + "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | + "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | + "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | + "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | + "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" + | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | + "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | + "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | + "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | + "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | + "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | + "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | + "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" + | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | + "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | + "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | + "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | + "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" + | "Galician" | "Georgian" | "German" | "GermanAustria" | + "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | + "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | + "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | + "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" + | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | + "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | + "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | + "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | + "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | + "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | + "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | + "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | + "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | + "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | + "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | + "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | + "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | + "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | + "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | + "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | + "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | + "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" + | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" + | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | + "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | + "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | + "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | + "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | + "Zulu" + - name: languageIdFarEast + uid: word!Word.Interfaces.SelectionData#languageIdFarEast:member + package: word! + fullName: languageIdFarEast + summary: Returns the East Asian language for the selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | + "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" + | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | + "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | + "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | + "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | + "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | + "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | + "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" + | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | + "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | + "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | + "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | + "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" + | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | + "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | + "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | + "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" + | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" + | "Galician" | "Georgian" | "German" | "GermanAustria" | + "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | + "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | + "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" + | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | + "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | + "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | + "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | + "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | + "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | + "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | + "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | + "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | + "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | + "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | + "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | + "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | + "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | + "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | + "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" + | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | + "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" + | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | + "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | + "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | + "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | + "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | + "Yiddish" | "Yoruba" | "Zulu"; + return: + type: >- + | "Afrikaans" | "Albanian" | + "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | + "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | + "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | + "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | + "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | + "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" + | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | + "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | + "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | + "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | + "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | + "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | + "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | + "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" + | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | + "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | + "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | + "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | + "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" + | "Galician" | "Georgian" | "German" | "GermanAustria" | + "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | + "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | + "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | + "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" + | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | + "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | + "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | + "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | + "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | + "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | + "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | + "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | + "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | + "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | + "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | + "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | + "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | + "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | + "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | + "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | + "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | + "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" + | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" + | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | + "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | + "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | + "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | + "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | + "Zulu" + - name: languageIdOther + uid: word!Word.Interfaces.SelectionData#languageIdOther:member + package: word! + fullName: languageIdOther + summary: >- + Returns the language for the selection that isn't classified as an East + Asian language. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + languageIdOther?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" + | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | + "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | + "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | + "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | + "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | + "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | + "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | + "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" + | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | + "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | + "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | + "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | + "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" + | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | + "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | + "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | + "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" + | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" + | "Galician" | "Georgian" | "German" | "GermanAustria" | + "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | + "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | + "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" + | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | + "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | + "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | + "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | + "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | + "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | + "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | + "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | + "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | + "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | + "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | + "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | + "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | + "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | + "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | + "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" + | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | + "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" + | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | + "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | + "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | + "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | + "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | + "Yiddish" | "Yoruba" | "Zulu"; + return: + type: >- + | "Afrikaans" | "Albanian" | + "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | + "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | + "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | + "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | + "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | + "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" + | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | + "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | + "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | + "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | + "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | + "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | + "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | + "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" + | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | + "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | + "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | + "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | + "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" + | "Galician" | "Georgian" | "German" | "GermanAustria" | + "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | + "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | + "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | + "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" + | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | + "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | + "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | + "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | + "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | + "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | + "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | + "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | + "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | + "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | + "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | + "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | + "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | + "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | + "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | + "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | + "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | + "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" + | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" + | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | + "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | + "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | + "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | + "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | + "Zulu" + - name: orientation + uid: word!Word.Interfaces.SelectionData#orientation:member + package: word! + fullName: orientation + summary: Specifies the orientation of text in the selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + orientation?: Word.TextOrientation | "Horizontal" | "Upward" | + "Downward" | "VerticalFarEast" | "HorizontalRotatedFarEast" | + "Vertical"; + return: + type: >- + | "Horizontal" | + "Upward" | "Downward" | "VerticalFarEast" | "HorizontalRotatedFarEast" + | "Vertical" + - name: start + uid: word!Word.Interfaces.SelectionData#start:member + package: word! + fullName: start + summary: Specifies the starting character position of the selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'start?: number;' + return: + type: number + - name: storyLength + uid: word!Word.Interfaces.SelectionData#storyLength:member + package: word! + fullName: storyLength + summary: Returns the number of characters in the story that contains the selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'storyLength?: number;' + return: + type: number + - name: storyType + uid: word!Word.Interfaces.SelectionData#storyType:member + package: word! + fullName: storyType + summary: Returns the story type for the selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + storyType?: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | + "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | + "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | + "FirstPageFooter" | "FootnoteSeparator" | + "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | + "EndnoteSeparator" | "EndnoteContinuationSeparator" | + "EndnoteContinuationNotice"; + return: + type: >- + | "MainText" | "Footnotes" | + "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | + "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | + "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | + "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | + "EndnoteSeparator" | "EndnoteContinuationSeparator" | + "EndnoteContinuationNotice" + - name: text + uid: word!Word.Interfaces.SelectionData#text:member + package: word! + fullName: text + summary: Specifies the text in the selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'text?: string;' + return: + type: string + - name: type + uid: word!Word.Interfaces.SelectionData#type:member + package: word! + fullName: type + summary: Returns the selection type. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + type?: Word.SelectionType | "NoSelection" | "InsertionPoint" | "Normal" + | "Frame" | "Column" | "Row" | "Block" | "InlineShape" | + "SelectionShape"; + return: + type: >- + | "NoSelection" | + "InsertionPoint" | "Normal" | "Frame" | "Column" | "Row" | "Block" | + "InlineShape" | "SelectionShape" diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.selectionloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.selectionloadoptions.yml new file mode 100644 index 0000000000..38a0d659e2 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.selectionloadoptions.yml @@ -0,0 +1,398 @@ +### YamlMime:TSType +name: Word.Interfaces.SelectionLoadOptions +uid: word!Word.Interfaces.SelectionLoadOptions:interface +package: word! +fullName: Word.Interfaces.SelectionLoadOptions +summary: >- + Represents a selected range or the insertion point in a Word document. + + + - Note: [Range](xref:word!Word.Range:class) objects share many of the same + methods and properties as `Selection` objects. Using `Range` objects is + preferable for manipulating a document when there isn't a reason to physically + change the current selection. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: $all + uid: word!Word.Interfaces.SelectionLoadOptions#$all:member + package: word! + 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: true + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: end + uid: word!Word.Interfaces.SelectionLoadOptions#end:member + package: word! + fullName: end + summary: Specifies the ending character position of the selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'end?: boolean;' + return: + type: boolean + - name: fitTextWidth + uid: word!Word.Interfaces.SelectionLoadOptions#fitTextWidth:member + package: word! + fullName: fitTextWidth + summary: Specifies the width in which Word fits the text in the current selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'fitTextWidth?: boolean;' + return: + type: boolean + - name: font + uid: word!Word.Interfaces.SelectionLoadOptions#font:member + package: word! + fullName: font + summary: >- + Returns the `Font` object that represents the character formatting of the + selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'font?: Word.Interfaces.FontLoadOptions;' + return: + type: + - name: formattedText + uid: word!Word.Interfaces.SelectionLoadOptions#formattedText:member + package: word! + fullName: formattedText + summary: >- + Specifies a `Range` object that includes the formatted text in the range + or selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'formattedText?: Word.Interfaces.RangeLoadOptions;' + return: + type: + - name: hasNoProofing + uid: word!Word.Interfaces.SelectionLoadOptions#hasNoProofing:member + package: word! + fullName: hasNoProofing + summary: >- + Returns whether the spelling and grammar checker ignores the selected + text. If the selected text contains a mix of proofed and un-proofed + content, this API returns `null`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'hasNoProofing?: boolean;' + return: + type: boolean + - name: isActive + uid: word!Word.Interfaces.SelectionLoadOptions#isActive:member + package: word! + fullName: isActive + summary: Returns whether the selection in the specified window or pane is active. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isActive?: boolean;' + return: + type: boolean + - name: isColumnSelectModeActive + uid: word!Word.Interfaces.SelectionLoadOptions#isColumnSelectModeActive:member + package: word! + fullName: isColumnSelectModeActive + summary: Specifies whether column selection mode is active. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isColumnSelectModeActive?: boolean;' + return: + type: boolean + - name: isEndOfRowMark + uid: word!Word.Interfaces.SelectionLoadOptions#isEndOfRowMark:member + package: word! + fullName: isEndOfRowMark + summary: Returns whether the selection is at the end-of-row mark in a table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isEndOfRowMark?: boolean;' + return: + type: boolean + - name: isExtendModeActive + uid: word!Word.Interfaces.SelectionLoadOptions#isExtendModeActive:member + package: word! + fullName: isExtendModeActive + summary: Specifies whether Extend mode is active. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isExtendModeActive?: boolean;' + return: + type: boolean + - name: isInsertionPointAtEndOfLine + uid: >- + word!Word.Interfaces.SelectionLoadOptions#isInsertionPointAtEndOfLine:member + package: word! + fullName: isInsertionPointAtEndOfLine + summary: Returns whether the insertion point is at the end of a line. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isInsertionPointAtEndOfLine?: boolean;' + return: + type: boolean + - name: isStartActive + uid: word!Word.Interfaces.SelectionLoadOptions#isStartActive:member + package: word! + fullName: isStartActive + summary: Specifies whether the beginning of the selection is active. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isStartActive?: boolean;' + return: + type: boolean + - name: languageDetected + uid: word!Word.Interfaces.SelectionLoadOptions#languageDetected:member + package: word! + fullName: languageDetected + summary: Specifies whether Word has detected the language of the selected text. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'languageDetected?: boolean;' + return: + type: boolean + - name: languageId + uid: word!Word.Interfaces.SelectionLoadOptions#languageId:member + package: word! + fullName: languageId + summary: Returns the language for the selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'languageId?: boolean;' + return: + type: boolean + - name: languageIdFarEast + uid: word!Word.Interfaces.SelectionLoadOptions#languageIdFarEast:member + package: word! + fullName: languageIdFarEast + summary: Returns the East Asian language for the selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'languageIdFarEast?: boolean;' + return: + type: boolean + - name: languageIdOther + uid: word!Word.Interfaces.SelectionLoadOptions#languageIdOther:member + package: word! + fullName: languageIdOther + summary: >- + Returns the language for the selection that isn't classified as an East + Asian language. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'languageIdOther?: boolean;' + return: + type: boolean + - name: orientation + uid: word!Word.Interfaces.SelectionLoadOptions#orientation:member + package: word! + fullName: orientation + summary: Specifies the orientation of text in the selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'orientation?: boolean;' + return: + type: boolean + - name: range + uid: word!Word.Interfaces.SelectionLoadOptions#range:member + package: word! + fullName: range + summary: >- + Returns the `Range` object for the portion of the document contained in + the selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'range?: Word.Interfaces.RangeLoadOptions;' + return: + type: + - name: shading + uid: word!Word.Interfaces.SelectionLoadOptions#shading:member + package: word! + fullName: shading + summary: >- + Returns the `ShadingUniversal` object for the shading formatting for the + selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'shading?: Word.Interfaces.ShadingUniversalLoadOptions;' + return: + type: >- + + - name: start + uid: word!Word.Interfaces.SelectionLoadOptions#start:member + package: word! + fullName: start + summary: Specifies the starting character position of the selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'start?: boolean;' + return: + type: boolean + - name: storyLength + uid: word!Word.Interfaces.SelectionLoadOptions#storyLength:member + package: word! + fullName: storyLength + summary: Returns the number of characters in the story that contains the selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'storyLength?: boolean;' + return: + type: boolean + - name: storyType + uid: word!Word.Interfaces.SelectionLoadOptions#storyType:member + package: word! + fullName: storyType + summary: Returns the story type for the selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'storyType?: boolean;' + return: + type: boolean + - name: text + uid: word!Word.Interfaces.SelectionLoadOptions#text:member + package: word! + fullName: text + summary: Specifies the text in the selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'text?: boolean;' + return: + type: boolean + - name: type + uid: word!Word.Interfaces.SelectionLoadOptions#type:member + package: word! + fullName: type + summary: Returns the selection type. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'type?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.selectionupdatedata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.selectionupdatedata.yml new file mode 100644 index 0000000000..4262701cf9 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.selectionupdatedata.yml @@ -0,0 +1,155 @@ +### YamlMime:TSType +name: Word.Interfaces.SelectionUpdateData +uid: word!Word.Interfaces.SelectionUpdateData:interface +package: word! +fullName: Word.Interfaces.SelectionUpdateData +summary: >- + An interface for updating data on the `Selection` object, for use in + `selection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: end + uid: word!Word.Interfaces.SelectionUpdateData#end:member + package: word! + fullName: end + summary: Specifies the ending character position of the selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'end?: number;' + return: + type: number + - name: fitTextWidth + uid: word!Word.Interfaces.SelectionUpdateData#fitTextWidth:member + package: word! + fullName: fitTextWidth + summary: Specifies the width in which Word fits the text in the current selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'fitTextWidth?: number;' + return: + type: number + - name: isColumnSelectModeActive + uid: word!Word.Interfaces.SelectionUpdateData#isColumnSelectModeActive:member + package: word! + fullName: isColumnSelectModeActive + summary: Specifies whether column selection mode is active. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isColumnSelectModeActive?: boolean;' + return: + type: boolean + - name: isExtendModeActive + uid: word!Word.Interfaces.SelectionUpdateData#isExtendModeActive:member + package: word! + fullName: isExtendModeActive + summary: Specifies whether Extend mode is active. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isExtendModeActive?: boolean;' + return: + type: boolean + - name: isStartActive + uid: word!Word.Interfaces.SelectionUpdateData#isStartActive:member + package: word! + fullName: isStartActive + summary: Specifies whether the beginning of the selection is active. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isStartActive?: boolean;' + return: + type: boolean + - name: languageDetected + uid: word!Word.Interfaces.SelectionUpdateData#languageDetected:member + package: word! + fullName: languageDetected + summary: Specifies whether Word has detected the language of the selected text. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'languageDetected?: boolean;' + return: + type: boolean + - name: orientation + uid: word!Word.Interfaces.SelectionUpdateData#orientation:member + package: word! + fullName: orientation + summary: Specifies the orientation of text in the selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + orientation?: Word.TextOrientation | "Horizontal" | "Upward" | + "Downward" | "VerticalFarEast" | "HorizontalRotatedFarEast" | + "Vertical"; + return: + type: >- + | "Horizontal" | + "Upward" | "Downward" | "VerticalFarEast" | "HorizontalRotatedFarEast" + | "Vertical" + - name: start + uid: word!Word.Interfaces.SelectionUpdateData#start:member + package: word! + fullName: start + summary: Specifies the starting character position of the selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'start?: number;' + return: + type: number + - name: text + uid: word!Word.Interfaces.SelectionUpdateData#text:member + package: word! + fullName: text + summary: Specifies the text in the selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'text?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.tablecellcollectionloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.tablecellcollectionloadoptions.yml index fffc9ba746..123c95e85e 100644 --- a/docs/docs-ref-autogen/word/word/word.interfaces.tablecellcollectionloadoptions.yml +++ b/docs/docs-ref-autogen/word/word/word.interfaces.tablecellcollectionloadoptions.yml @@ -58,6 +58,23 @@ properties: content: 'cellIndex?: boolean;' return: type: boolean + - name: column + uid: word!Word.Interfaces.TableCellCollectionLoadOptions#column:member + package: word! + fullName: column + summary: >- + For EACH ITEM in the collection: Returns the `TableColumn` object that + represents the table column that contains this cell. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'column?: Word.Interfaces.TableColumnLoadOptions;' + return: + type: - name: columnWidth uid: word!Word.Interfaces.TableCellCollectionLoadOptions#columnWidth:member package: word! @@ -140,6 +157,25 @@ properties: content: 'rowIndex?: boolean;' return: type: boolean + - name: shading + uid: word!Word.Interfaces.TableCellCollectionLoadOptions#shading:member + package: word! + fullName: shading + summary: >- + For EACH ITEM in the collection: Returns the `ShadingUniversal` object + that represents the shading of the table cell. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'shading?: Word.Interfaces.ShadingUniversalLoadOptions;' + return: + type: >- + - name: shadingColor uid: word!Word.Interfaces.TableCellCollectionLoadOptions#shadingColor:member package: word! diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.tablecellloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.tablecellloadoptions.yml index 7e8bf77b58..193544452c 100644 --- a/docs/docs-ref-autogen/word/word/word.interfaces.tablecellloadoptions.yml +++ b/docs/docs-ref-autogen/word/word/word.interfaces.tablecellloadoptions.yml @@ -58,6 +58,23 @@ properties: content: 'cellIndex?: boolean;' return: type: boolean + - name: column + uid: word!Word.Interfaces.TableCellLoadOptions#column:member + package: word! + fullName: column + summary: >- + Returns the `TableColumn` object that represents the table column that + contains this cell. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'column?: Word.Interfaces.TableColumnLoadOptions;' + return: + type: - name: columnWidth uid: word!Word.Interfaces.TableCellLoadOptions#columnWidth:member package: word! @@ -137,6 +154,25 @@ properties: content: 'rowIndex?: boolean;' return: type: boolean + - name: shading + uid: word!Word.Interfaces.TableCellLoadOptions#shading:member + package: word! + fullName: shading + summary: >- + Returns the `ShadingUniversal` object that represents the shading of the + table cell. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'shading?: Word.Interfaces.ShadingUniversalLoadOptions;' + return: + type: >- + - name: shadingColor uid: word!Word.Interfaces.TableCellLoadOptions#shadingColor:member package: word! diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.tablecollectionloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.tablecollectionloadoptions.yml index 862eaf26ac..02bc6f964d 100644 --- a/docs/docs-ref-autogen/word/word/word.interfaces.tablecollectionloadoptions.yml +++ b/docs/docs-ref-autogen/word/word/word.interfaces.tablecollectionloadoptions.yml @@ -45,6 +45,21 @@ properties: content: 'alignment?: boolean;' return: type: boolean + - name: description + uid: word!Word.Interfaces.TableCollectionLoadOptions#description:member + package: word! + fullName: description + summary: 'For EACH ITEM in the collection: Specifies the description of the table.' + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'description?: boolean;' + return: + type: boolean - name: font uid: word!Word.Interfaces.TableCollectionLoadOptions#font:member package: word! @@ -285,6 +300,25 @@ properties: content: 'rowCount?: boolean;' return: type: boolean + - name: shading + uid: word!Word.Interfaces.TableCollectionLoadOptions#shading:member + package: word! + fullName: shading + summary: >- + For EACH ITEM in the collection: Returns the `ShadingUniversal` object + that represents the shading of the table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'shading?: Word.Interfaces.ShadingUniversalLoadOptions;' + return: + type: >- + - name: shadingColor uid: word!Word.Interfaces.TableCollectionLoadOptions#shadingColor:member package: word! @@ -425,6 +459,21 @@ properties: content: 'styleTotalRow?: boolean;' return: type: boolean + - name: title + uid: word!Word.Interfaces.TableCollectionLoadOptions#title:member + package: word! + fullName: title + summary: 'For EACH ITEM in the collection: Specifies the title of the table.' + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'title?: boolean;' + return: + type: boolean - name: values uid: word!Word.Interfaces.TableCollectionLoadOptions#values:member package: word! diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.tabledata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.tabledata.yml index 5e2e722ebf..bba08bf6df 100644 --- a/docs/docs-ref-autogen/word/word/word.interfaces.tabledata.yml +++ b/docs/docs-ref-autogen/word/word/word.interfaces.tabledata.yml @@ -31,6 +31,21 @@ properties: type: >- | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified" + - name: description + uid: word!Word.Interfaces.TableData#description:member + package: word! + fullName: description + summary: Specifies the description of the table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'description?: string;' + return: + type: string - name: fields uid: word!Word.Interfaces.TableData#fields:member package: word! @@ -406,6 +421,21 @@ properties: content: 'tables?: Word.Interfaces.TableData[];' return: type: [] + - name: title + uid: word!Word.Interfaces.TableData#title:member + package: word! + fullName: title + summary: Specifies the title of the table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'title?: string;' + return: + type: string - name: values uid: word!Word.Interfaces.TableData#values:member package: word! diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.tableloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.tableloadoptions.yml index 5ab74a75e8..bc6d4e60d9 100644 --- a/docs/docs-ref-autogen/word/word/word.interfaces.tableloadoptions.yml +++ b/docs/docs-ref-autogen/word/word/word.interfaces.tableloadoptions.yml @@ -45,6 +45,21 @@ properties: content: 'alignment?: boolean;' return: type: boolean + - name: description + uid: word!Word.Interfaces.TableLoadOptions#description:member + package: word! + fullName: description + summary: Specifies the description of the table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'description?: boolean;' + return: + type: boolean - name: font uid: word!Word.Interfaces.TableLoadOptions#font:member package: word! @@ -275,6 +290,25 @@ properties: content: 'rowCount?: boolean;' return: type: boolean + - name: shading + uid: word!Word.Interfaces.TableLoadOptions#shading:member + package: word! + fullName: shading + summary: >- + Returns the `ShadingUniversal` object that represents the shading of the + table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'shading?: Word.Interfaces.ShadingUniversalLoadOptions;' + return: + type: >- + - name: shadingColor uid: word!Word.Interfaces.TableLoadOptions#shadingColor:member package: word! @@ -403,6 +437,21 @@ properties: content: 'styleTotalRow?: boolean;' return: type: boolean + - name: title + uid: word!Word.Interfaces.TableLoadOptions#title:member + package: word! + fullName: title + summary: Specifies the title of the table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'title?: boolean;' + return: + type: boolean - name: values uid: word!Word.Interfaces.TableLoadOptions#values:member package: word! diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.tableofauthoritiescategorycollectiondata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.tableofauthoritiescategorycollectiondata.yml new file mode 100644 index 0000000000..a8797cb28d --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.tableofauthoritiescategorycollectiondata.yml @@ -0,0 +1,30 @@ +### YamlMime:TSType +name: Word.Interfaces.TableOfAuthoritiesCategoryCollectionData +uid: word!Word.Interfaces.TableOfAuthoritiesCategoryCollectionData:interface +package: word! +fullName: Word.Interfaces.TableOfAuthoritiesCategoryCollectionData +summary: >- + An interface describing the data returned by calling + `tableOfAuthoritiesCategoryCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: word!Word.Interfaces.TableOfAuthoritiesCategoryCollectionData#items:member + package: word! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Word.Interfaces.TableOfAuthoritiesCategoryData[];' + return: + type: >- + [] diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.tableofauthoritiescategorycollectionloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.tableofauthoritiescategorycollectionloadoptions.yml new file mode 100644 index 0000000000..36e3cb35c8 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.tableofauthoritiescategorycollectionloadoptions.yml @@ -0,0 +1,55 @@ +### YamlMime:TSType +name: Word.Interfaces.TableOfAuthoritiesCategoryCollectionLoadOptions +uid: word!Word.Interfaces.TableOfAuthoritiesCategoryCollectionLoadOptions:interface +package: word! +fullName: Word.Interfaces.TableOfAuthoritiesCategoryCollectionLoadOptions +summary: >- + Represents a collection of + [Word.TableOfAuthoritiesCategory](xref:word!Word.TableOfAuthoritiesCategory:class) + objects in a Word document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: $all + uid: >- + word!Word.Interfaces.TableOfAuthoritiesCategoryCollectionLoadOptions#$all:member + package: word! + 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: true + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: name + uid: >- + word!Word.Interfaces.TableOfAuthoritiesCategoryCollectionLoadOptions#name:member + package: word! + fullName: name + summary: >- + For EACH ITEM in the collection: Specifies the name of this table of + authorities category. Changing the name of the category doesn't change the + index in the collection. The value for + [TableOfAuthorities.category](xref:word!Word.TableOfAuthorities:class) + will remain the same. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.tableofauthoritiescategorycollectionupdatedata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.tableofauthoritiescategorycollectionupdatedata.yml new file mode 100644 index 0000000000..127cad25cd --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.tableofauthoritiescategorycollectionupdatedata.yml @@ -0,0 +1,32 @@ +### YamlMime:TSType +name: Word.Interfaces.TableOfAuthoritiesCategoryCollectionUpdateData +uid: word!Word.Interfaces.TableOfAuthoritiesCategoryCollectionUpdateData:interface +package: word! +fullName: Word.Interfaces.TableOfAuthoritiesCategoryCollectionUpdateData +summary: >- + An interface for updating data on the `TableOfAuthoritiesCategoryCollection` + object, for use in `tableOfAuthoritiesCategoryCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: >- + word!Word.Interfaces.TableOfAuthoritiesCategoryCollectionUpdateData#items:member + package: word! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Word.Interfaces.TableOfAuthoritiesCategoryData[];' + return: + type: >- + [] diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.tableofauthoritiescategorydata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.tableofauthoritiescategorydata.yml new file mode 100644 index 0000000000..c52c6c3473 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.tableofauthoritiescategorydata.yml @@ -0,0 +1,33 @@ +### YamlMime:TSType +name: Word.Interfaces.TableOfAuthoritiesCategoryData +uid: word!Word.Interfaces.TableOfAuthoritiesCategoryData:interface +package: word! +fullName: Word.Interfaces.TableOfAuthoritiesCategoryData +summary: >- + An interface describing the data returned by calling + `tableOfAuthoritiesCategory.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: name + uid: word!Word.Interfaces.TableOfAuthoritiesCategoryData#name:member + package: word! + fullName: name + summary: >- + Specifies the name of this table of authorities category. Changing the + name of the category doesn't change the index in the collection. The value + for [TableOfAuthorities.category](xref:word!Word.TableOfAuthorities:class) + will remain the same. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.tableofauthoritiescategoryloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.tableofauthoritiescategoryloadoptions.yml new file mode 100644 index 0000000000..7e97ca1d78 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.tableofauthoritiescategoryloadoptions.yml @@ -0,0 +1,49 @@ +### YamlMime:TSType +name: Word.Interfaces.TableOfAuthoritiesCategoryLoadOptions +uid: word!Word.Interfaces.TableOfAuthoritiesCategoryLoadOptions:interface +package: word! +fullName: Word.Interfaces.TableOfAuthoritiesCategoryLoadOptions +summary: Represents a category used in a table of authorities. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: $all + uid: word!Word.Interfaces.TableOfAuthoritiesCategoryLoadOptions#$all:member + package: word! + 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: true + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: name + uid: word!Word.Interfaces.TableOfAuthoritiesCategoryLoadOptions#name:member + package: word! + fullName: name + summary: >- + Specifies the name of this table of authorities category. Changing the + name of the category doesn't change the index in the collection. The value + for [TableOfAuthorities.category](xref:word!Word.TableOfAuthorities:class) + will remain the same. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'name?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.tableofauthoritiescollectiondata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.tableofauthoritiescollectiondata.yml new file mode 100644 index 0000000000..b9b1aa3f8f --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.tableofauthoritiescollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Word.Interfaces.TableOfAuthoritiesCollectionData +uid: word!Word.Interfaces.TableOfAuthoritiesCollectionData:interface +package: word! +fullName: Word.Interfaces.TableOfAuthoritiesCollectionData +summary: >- + An interface describing the data returned by calling + `tableOfAuthoritiesCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: word!Word.Interfaces.TableOfAuthoritiesCollectionData#items:member + package: word! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Word.Interfaces.TableOfAuthoritiesData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.tableofauthoritiescollectionloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.tableofauthoritiescollectionloadoptions.yml new file mode 100644 index 0000000000..90da0d8e88 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.tableofauthoritiescollectionloadoptions.yml @@ -0,0 +1,259 @@ +### YamlMime:TSType +name: Word.Interfaces.TableOfAuthoritiesCollectionLoadOptions +uid: word!Word.Interfaces.TableOfAuthoritiesCollectionLoadOptions:interface +package: word! +fullName: Word.Interfaces.TableOfAuthoritiesCollectionLoadOptions +summary: >- + Represents a collection of + [Word.TableOfAuthorities](xref:word!Word.TableOfAuthorities:class) objects in + a Word document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: $all + uid: word!Word.Interfaces.TableOfAuthoritiesCollectionLoadOptions#$all:member + package: word! + 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: true + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: bookmark + uid: >- + word!Word.Interfaces.TableOfAuthoritiesCollectionLoadOptions#bookmark:member + package: word! + fullName: bookmark + summary: >- + For EACH ITEM in the collection: Specifies the name of the bookmark from + which to collect table of authorities entries. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'bookmark?: boolean;' + return: + type: boolean + - name: category + uid: >- + word!Word.Interfaces.TableOfAuthoritiesCollectionLoadOptions#category:member + package: word! + fullName: category + summary: >- + For EACH ITEM in the collection: Specifies the category of entries to be + included in the table of authorities. Values 0 through 16 correspond to + the items listed in the Category box of the Table of Authorities dialog. + To learn how to access this through the Word UI, see [Create a table of + authorities](https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0). + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'category?: boolean;' + return: + type: boolean + - name: entrySeparator + uid: >- + word!Word.Interfaces.TableOfAuthoritiesCollectionLoadOptions#entrySeparator:member + package: word! + fullName: entrySeparator + summary: >- + For EACH ITEM in the collection: Specifies a separator of up to five + characters. This appears between the table of authorities entry and its + page number. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'entrySeparator?: boolean;' + return: + type: boolean + - name: isCategoryHeaderIncluded + uid: >- + word!Word.Interfaces.TableOfAuthoritiesCollectionLoadOptions#isCategoryHeaderIncluded:member + package: word! + fullName: isCategoryHeaderIncluded + summary: >- + For EACH ITEM in the collection: Specifies whether the category name for a + group of entries appears in the table of authorities. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isCategoryHeaderIncluded?: boolean;' + return: + type: boolean + - name: isEntryFormattingKept + uid: >- + word!Word.Interfaces.TableOfAuthoritiesCollectionLoadOptions#isEntryFormattingKept:member + package: word! + fullName: isEntryFormattingKept + summary: >- + For EACH ITEM in the collection: Specifies whether the entries in the + table of authorities are displayed with their formatting in the table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isEntryFormattingKept?: boolean;' + return: + type: boolean + - name: isPassimUsed + uid: >- + word!Word.Interfaces.TableOfAuthoritiesCollectionLoadOptions#isPassimUsed:member + package: word! + fullName: isPassimUsed + summary: >- + For EACH ITEM in the collection: Specifies whether references to the same + authority that are repeated on five or more pages are replaced with + "Passim". + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isPassimUsed?: boolean;' + return: + type: boolean + - name: pageNumberSeparator + uid: >- + word!Word.Interfaces.TableOfAuthoritiesCollectionLoadOptions#pageNumberSeparator:member + package: word! + fullName: pageNumberSeparator + summary: >- + For EACH ITEM in the collection: Specifies a separator of up to five + characters. This appears between individual page references in the table + of authorities. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'pageNumberSeparator?: boolean;' + return: + type: boolean + - name: pageRangeSeparator + uid: >- + word!Word.Interfaces.TableOfAuthoritiesCollectionLoadOptions#pageRangeSeparator:member + package: word! + fullName: pageRangeSeparator + summary: >- + For EACH ITEM in the collection: Specifies a separator of up to five + characters. This appears between ranges of pages in the table of + authorities. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'pageRangeSeparator?: boolean;' + return: + type: boolean + - name: range + uid: word!Word.Interfaces.TableOfAuthoritiesCollectionLoadOptions#range:member + package: word! + fullName: range + summary: >- + For EACH ITEM in the collection: Gets the portion of a document that is + this table of authorities. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'range?: Word.Interfaces.RangeLoadOptions;' + return: + type: + - name: sequenceName + uid: >- + word!Word.Interfaces.TableOfAuthoritiesCollectionLoadOptions#sequenceName:member + package: word! + fullName: sequenceName + summary: >- + For EACH ITEM in the collection: Specifies the [Sequence (SEQ) + field](https://support.microsoft.com/office/062a387b-dfc9-4ef8-8235-29ee113d59be) + identifier for the table of authorities. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'sequenceName?: boolean;' + return: + type: boolean + - name: sequenceSeparator + uid: >- + word!Word.Interfaces.TableOfAuthoritiesCollectionLoadOptions#sequenceSeparator:member + package: word! + fullName: sequenceSeparator + summary: >- + For EACH ITEM in the collection: Specifies a separator of up to five + characters. This appears between the sequence number and the page number + in the table of authorities. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'sequenceSeparator?: boolean;' + return: + type: boolean + - name: tabLeader + uid: >- + word!Word.Interfaces.TableOfAuthoritiesCollectionLoadOptions#tabLeader:member + package: word! + fullName: tabLeader + summary: >- + For EACH ITEM in the collection: Specifies the leader character that + appears between entries and their associated page numbers in the table of + authorities. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'tabLeader?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.tableofauthoritiescollectionupdatedata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.tableofauthoritiescollectionupdatedata.yml new file mode 100644 index 0000000000..e48ceafb6c --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.tableofauthoritiescollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Word.Interfaces.TableOfAuthoritiesCollectionUpdateData +uid: word!Word.Interfaces.TableOfAuthoritiesCollectionUpdateData:interface +package: word! +fullName: Word.Interfaces.TableOfAuthoritiesCollectionUpdateData +summary: >- + An interface for updating data on the `TableOfAuthoritiesCollection` object, + for use in `tableOfAuthoritiesCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: word!Word.Interfaces.TableOfAuthoritiesCollectionUpdateData#items:member + package: word! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Word.Interfaces.TableOfAuthoritiesData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.tableofauthoritiesdata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.tableofauthoritiesdata.yml new file mode 100644 index 0000000000..9fdec84132 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.tableofauthoritiesdata.yml @@ -0,0 +1,211 @@ +### YamlMime:TSType +name: Word.Interfaces.TableOfAuthoritiesData +uid: word!Word.Interfaces.TableOfAuthoritiesData:interface +package: word! +fullName: Word.Interfaces.TableOfAuthoritiesData +summary: >- + An interface describing the data returned by calling + `tableOfAuthorities.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: bookmark + uid: word!Word.Interfaces.TableOfAuthoritiesData#bookmark:member + package: word! + fullName: bookmark + summary: >- + Specifies the name of the bookmark from which to collect table of + authorities entries. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'bookmark?: string;' + return: + type: string + - name: category + uid: word!Word.Interfaces.TableOfAuthoritiesData#category:member + package: word! + fullName: category + summary: >- + Specifies the category of entries to be included in the table of + authorities. Values 0 through 16 correspond to the items listed in the + Category box of the Table of Authorities dialog. To learn how to access + this through the Word UI, see [Create a table of + authorities](https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0). + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'category?: number;' + return: + type: number + - name: entrySeparator + uid: word!Word.Interfaces.TableOfAuthoritiesData#entrySeparator:member + package: word! + fullName: entrySeparator + summary: >- + Specifies a separator of up to five characters. This appears between the + table of authorities entry and its page number. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'entrySeparator?: string;' + return: + type: string + - name: isCategoryHeaderIncluded + uid: >- + word!Word.Interfaces.TableOfAuthoritiesData#isCategoryHeaderIncluded:member + package: word! + fullName: isCategoryHeaderIncluded + summary: >- + Specifies whether the category name for a group of entries appears in the + table of authorities. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isCategoryHeaderIncluded?: boolean;' + return: + type: boolean + - name: isEntryFormattingKept + uid: word!Word.Interfaces.TableOfAuthoritiesData#isEntryFormattingKept:member + package: word! + fullName: isEntryFormattingKept + summary: >- + Specifies whether the entries in the table of authorities are displayed + with their formatting in the table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isEntryFormattingKept?: boolean;' + return: + type: boolean + - name: isPassimUsed + uid: word!Word.Interfaces.TableOfAuthoritiesData#isPassimUsed:member + package: word! + fullName: isPassimUsed + summary: >- + Specifies whether references to the same authority that are repeated on + five or more pages are replaced with "Passim". + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isPassimUsed?: boolean;' + return: + type: boolean + - name: pageNumberSeparator + uid: word!Word.Interfaces.TableOfAuthoritiesData#pageNumberSeparator:member + package: word! + fullName: pageNumberSeparator + summary: >- + Specifies a separator of up to five characters. This appears between + individual page references in the table of authorities. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'pageNumberSeparator?: string;' + return: + type: string + - name: pageRangeSeparator + uid: word!Word.Interfaces.TableOfAuthoritiesData#pageRangeSeparator:member + package: word! + fullName: pageRangeSeparator + summary: >- + Specifies a separator of up to five characters. This appears between + ranges of pages in the table of authorities. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'pageRangeSeparator?: string;' + return: + type: string + - name: sequenceName + uid: word!Word.Interfaces.TableOfAuthoritiesData#sequenceName:member + package: word! + fullName: sequenceName + summary: >- + Specifies the [Sequence (SEQ) + field](https://support.microsoft.com/office/062a387b-dfc9-4ef8-8235-29ee113d59be) + identifier for the table of authorities. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'sequenceName?: string;' + return: + type: string + - name: sequenceSeparator + uid: word!Word.Interfaces.TableOfAuthoritiesData#sequenceSeparator:member + package: word! + fullName: sequenceSeparator + summary: >- + Specifies a separator of up to five characters. This appears between the + sequence number and the page number in the table of authorities. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'sequenceSeparator?: string;' + return: + type: string + - name: tabLeader + uid: word!Word.Interfaces.TableOfAuthoritiesData#tabLeader:member + package: word! + fullName: tabLeader + summary: >- + Specifies the leader character that appears between entries and their + associated page numbers in the table of authorities. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | + "Heavy" | "MiddleDot"; + return: + type: >- + | "Spaces" | "Dots" | "Dashes" + | "Lines" | "Heavy" | "MiddleDot" diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.tableofauthoritiesloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.tableofauthoritiesloadoptions.yml new file mode 100644 index 0000000000..9e3497f7b7 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.tableofauthoritiesloadoptions.yml @@ -0,0 +1,242 @@ +### YamlMime:TSType +name: Word.Interfaces.TableOfAuthoritiesLoadOptions +uid: word!Word.Interfaces.TableOfAuthoritiesLoadOptions:interface +package: word! +fullName: Word.Interfaces.TableOfAuthoritiesLoadOptions +summary: Represents a table of authorities in a Word document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: $all + uid: word!Word.Interfaces.TableOfAuthoritiesLoadOptions#$all:member + package: word! + 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: true + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: bookmark + uid: word!Word.Interfaces.TableOfAuthoritiesLoadOptions#bookmark:member + package: word! + fullName: bookmark + summary: >- + Specifies the name of the bookmark from which to collect table of + authorities entries. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'bookmark?: boolean;' + return: + type: boolean + - name: category + uid: word!Word.Interfaces.TableOfAuthoritiesLoadOptions#category:member + package: word! + fullName: category + summary: >- + Specifies the category of entries to be included in the table of + authorities. Values 0 through 16 correspond to the items listed in the + Category box of the Table of Authorities dialog. To learn how to access + this through the Word UI, see [Create a table of + authorities](https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0). + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'category?: boolean;' + return: + type: boolean + - name: entrySeparator + uid: word!Word.Interfaces.TableOfAuthoritiesLoadOptions#entrySeparator:member + package: word! + fullName: entrySeparator + summary: >- + Specifies a separator of up to five characters. This appears between the + table of authorities entry and its page number. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'entrySeparator?: boolean;' + return: + type: boolean + - name: isCategoryHeaderIncluded + uid: >- + word!Word.Interfaces.TableOfAuthoritiesLoadOptions#isCategoryHeaderIncluded:member + package: word! + fullName: isCategoryHeaderIncluded + summary: >- + Specifies whether the category name for a group of entries appears in the + table of authorities. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isCategoryHeaderIncluded?: boolean;' + return: + type: boolean + - name: isEntryFormattingKept + uid: >- + word!Word.Interfaces.TableOfAuthoritiesLoadOptions#isEntryFormattingKept:member + package: word! + fullName: isEntryFormattingKept + summary: >- + Specifies whether the entries in the table of authorities are displayed + with their formatting in the table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isEntryFormattingKept?: boolean;' + return: + type: boolean + - name: isPassimUsed + uid: word!Word.Interfaces.TableOfAuthoritiesLoadOptions#isPassimUsed:member + package: word! + fullName: isPassimUsed + summary: >- + Specifies whether references to the same authority that are repeated on + five or more pages are replaced with "Passim". + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isPassimUsed?: boolean;' + return: + type: boolean + - name: pageNumberSeparator + uid: >- + word!Word.Interfaces.TableOfAuthoritiesLoadOptions#pageNumberSeparator:member + package: word! + fullName: pageNumberSeparator + summary: >- + Specifies a separator of up to five characters. This appears between + individual page references in the table of authorities. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'pageNumberSeparator?: boolean;' + return: + type: boolean + - name: pageRangeSeparator + uid: >- + word!Word.Interfaces.TableOfAuthoritiesLoadOptions#pageRangeSeparator:member + package: word! + fullName: pageRangeSeparator + summary: >- + Specifies a separator of up to five characters. This appears between + ranges of pages in the table of authorities. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'pageRangeSeparator?: boolean;' + return: + type: boolean + - name: range + uid: word!Word.Interfaces.TableOfAuthoritiesLoadOptions#range:member + package: word! + fullName: range + summary: Gets the portion of a document that is this table of authorities. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'range?: Word.Interfaces.RangeLoadOptions;' + return: + type: + - name: sequenceName + uid: word!Word.Interfaces.TableOfAuthoritiesLoadOptions#sequenceName:member + package: word! + fullName: sequenceName + summary: >- + Specifies the [Sequence (SEQ) + field](https://support.microsoft.com/office/062a387b-dfc9-4ef8-8235-29ee113d59be) + identifier for the table of authorities. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'sequenceName?: boolean;' + return: + type: boolean + - name: sequenceSeparator + uid: >- + word!Word.Interfaces.TableOfAuthoritiesLoadOptions#sequenceSeparator:member + package: word! + fullName: sequenceSeparator + summary: >- + Specifies a separator of up to five characters. This appears between the + sequence number and the page number in the table of authorities. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'sequenceSeparator?: boolean;' + return: + type: boolean + - name: tabLeader + uid: word!Word.Interfaces.TableOfAuthoritiesLoadOptions#tabLeader:member + package: word! + fullName: tabLeader + summary: >- + Specifies the leader character that appears between entries and their + associated page numbers in the table of authorities. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'tabLeader?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.tableofauthoritiesupdatedata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.tableofauthoritiesupdatedata.yml new file mode 100644 index 0000000000..9b01a66903 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.tableofauthoritiesupdatedata.yml @@ -0,0 +1,214 @@ +### YamlMime:TSType +name: Word.Interfaces.TableOfAuthoritiesUpdateData +uid: word!Word.Interfaces.TableOfAuthoritiesUpdateData:interface +package: word! +fullName: Word.Interfaces.TableOfAuthoritiesUpdateData +summary: >- + An interface for updating data on the `TableOfAuthorities` object, for use in + `tableOfAuthorities.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: bookmark + uid: word!Word.Interfaces.TableOfAuthoritiesUpdateData#bookmark:member + package: word! + fullName: bookmark + summary: >- + Specifies the name of the bookmark from which to collect table of + authorities entries. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'bookmark?: string;' + return: + type: string + - name: category + uid: word!Word.Interfaces.TableOfAuthoritiesUpdateData#category:member + package: word! + fullName: category + summary: >- + Specifies the category of entries to be included in the table of + authorities. Values 0 through 16 correspond to the items listed in the + Category box of the Table of Authorities dialog. To learn how to access + this through the Word UI, see [Create a table of + authorities](https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0). + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'category?: number;' + return: + type: number + - name: entrySeparator + uid: word!Word.Interfaces.TableOfAuthoritiesUpdateData#entrySeparator:member + package: word! + fullName: entrySeparator + summary: >- + Specifies a separator of up to five characters. This appears between the + table of authorities entry and its page number. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'entrySeparator?: string;' + return: + type: string + - name: isCategoryHeaderIncluded + uid: >- + word!Word.Interfaces.TableOfAuthoritiesUpdateData#isCategoryHeaderIncluded:member + package: word! + fullName: isCategoryHeaderIncluded + summary: >- + Specifies whether the category name for a group of entries appears in the + table of authorities. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isCategoryHeaderIncluded?: boolean;' + return: + type: boolean + - name: isEntryFormattingKept + uid: >- + word!Word.Interfaces.TableOfAuthoritiesUpdateData#isEntryFormattingKept:member + package: word! + fullName: isEntryFormattingKept + summary: >- + Specifies whether the entries in the table of authorities are displayed + with their formatting in the table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isEntryFormattingKept?: boolean;' + return: + type: boolean + - name: isPassimUsed + uid: word!Word.Interfaces.TableOfAuthoritiesUpdateData#isPassimUsed:member + package: word! + fullName: isPassimUsed + summary: >- + Specifies whether references to the same authority that are repeated on + five or more pages are replaced with "Passim". + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isPassimUsed?: boolean;' + return: + type: boolean + - name: pageNumberSeparator + uid: >- + word!Word.Interfaces.TableOfAuthoritiesUpdateData#pageNumberSeparator:member + package: word! + fullName: pageNumberSeparator + summary: >- + Specifies a separator of up to five characters. This appears between + individual page references in the table of authorities. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'pageNumberSeparator?: string;' + return: + type: string + - name: pageRangeSeparator + uid: >- + word!Word.Interfaces.TableOfAuthoritiesUpdateData#pageRangeSeparator:member + package: word! + fullName: pageRangeSeparator + summary: >- + Specifies a separator of up to five characters. This appears between + ranges of pages in the table of authorities. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'pageRangeSeparator?: string;' + return: + type: string + - name: sequenceName + uid: word!Word.Interfaces.TableOfAuthoritiesUpdateData#sequenceName:member + package: word! + fullName: sequenceName + summary: >- + Specifies the [Sequence (SEQ) + field](https://support.microsoft.com/office/062a387b-dfc9-4ef8-8235-29ee113d59be) + identifier for the table of authorities. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'sequenceName?: string;' + return: + type: string + - name: sequenceSeparator + uid: word!Word.Interfaces.TableOfAuthoritiesUpdateData#sequenceSeparator:member + package: word! + fullName: sequenceSeparator + summary: >- + Specifies a separator of up to five characters. This appears between the + sequence number and the page number in the table of authorities. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'sequenceSeparator?: string;' + return: + type: string + - name: tabLeader + uid: word!Word.Interfaces.TableOfAuthoritiesUpdateData#tabLeader:member + package: word! + fullName: tabLeader + summary: >- + Specifies the leader character that appears between entries and their + associated page numbers in the table of authorities. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | + "Heavy" | "MiddleDot"; + return: + type: >- + | "Spaces" | "Dots" | "Dashes" + | "Lines" | "Heavy" | "MiddleDot" diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.tableofcontentscollectiondata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.tableofcontentscollectiondata.yml new file mode 100644 index 0000000000..0a9e29843f --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.tableofcontentscollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Word.Interfaces.TableOfContentsCollectionData +uid: word!Word.Interfaces.TableOfContentsCollectionData:interface +package: word! +fullName: Word.Interfaces.TableOfContentsCollectionData +summary: >- + An interface describing the data returned by calling + `tableOfContentsCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: word!Word.Interfaces.TableOfContentsCollectionData#items:member + package: word! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Word.Interfaces.TableOfContentsData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.tableofcontentscollectionloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.tableofcontentscollectionloadoptions.yml new file mode 100644 index 0000000000..9d73586da9 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.tableofcontentscollectionloadoptions.yml @@ -0,0 +1,234 @@ +### YamlMime:TSType +name: Word.Interfaces.TableOfContentsCollectionLoadOptions +uid: word!Word.Interfaces.TableOfContentsCollectionLoadOptions:interface +package: word! +fullName: Word.Interfaces.TableOfContentsCollectionLoadOptions +summary: >- + Represents a collection of + [Word.TableOfContents](xref:word!Word.TableOfContents:class) objects in a Word + document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: $all + uid: word!Word.Interfaces.TableOfContentsCollectionLoadOptions#$all:member + package: word! + 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: true + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: areBuiltInHeadingStylesUsed + uid: >- + word!Word.Interfaces.TableOfContentsCollectionLoadOptions#areBuiltInHeadingStylesUsed:member + package: word! + fullName: areBuiltInHeadingStylesUsed + summary: >- + For EACH ITEM in the collection: Specifies whether built-in heading styles + are used for the table of contents. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areBuiltInHeadingStylesUsed?: boolean;' + return: + type: boolean + - name: areFieldsUsed + uid: >- + word!Word.Interfaces.TableOfContentsCollectionLoadOptions#areFieldsUsed:member + package: word! + fullName: areFieldsUsed + summary: >- + For EACH ITEM in the collection: Specifies whether [Table of Contents + Entry (TC) + fields](https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3) + are included in the table of contents. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areFieldsUsed?: boolean;' + return: + type: boolean + - name: areHyperlinksUsedOnWeb + uid: >- + word!Word.Interfaces.TableOfContentsCollectionLoadOptions#areHyperlinksUsedOnWeb:member + package: word! + fullName: areHyperlinksUsedOnWeb + summary: >- + For EACH ITEM in the collection: Specifies whether entries in the table of + contents should be formatted as hyperlinks when publishing to the web. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areHyperlinksUsedOnWeb?: boolean;' + return: + type: boolean + - name: arePageNumbersHiddenOnWeb + uid: >- + word!Word.Interfaces.TableOfContentsCollectionLoadOptions#arePageNumbersHiddenOnWeb:member + package: word! + fullName: arePageNumbersHiddenOnWeb + summary: >- + For EACH ITEM in the collection: Specifies whether the page numbers in the + table of contents should be hidden when publishing to the web. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'arePageNumbersHiddenOnWeb?: boolean;' + return: + type: boolean + - name: arePageNumbersIncluded + uid: >- + word!Word.Interfaces.TableOfContentsCollectionLoadOptions#arePageNumbersIncluded:member + package: word! + fullName: arePageNumbersIncluded + summary: >- + For EACH ITEM in the collection: Specifies whether page numbers are + included in the table of contents. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'arePageNumbersIncluded?: boolean;' + return: + type: boolean + - name: arePageNumbersRightAligned + uid: >- + word!Word.Interfaces.TableOfContentsCollectionLoadOptions#arePageNumbersRightAligned:member + package: word! + fullName: arePageNumbersRightAligned + summary: >- + For EACH ITEM in the collection: Specifies whether page numbers are + aligned with the right margin in the table of contents. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'arePageNumbersRightAligned?: boolean;' + return: + type: boolean + - name: lowerHeadingLevel + uid: >- + word!Word.Interfaces.TableOfContentsCollectionLoadOptions#lowerHeadingLevel:member + package: word! + fullName: lowerHeadingLevel + summary: >- + For EACH ITEM in the collection: Specifies the ending heading level for + the table of contents. Must be a value from 1 to 9 and greater than + `upperHeadingLevel`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'lowerHeadingLevel?: boolean;' + return: + type: boolean + - name: range + uid: word!Word.Interfaces.TableOfContentsCollectionLoadOptions#range:member + package: word! + fullName: range + summary: >- + For EACH ITEM in the collection: Gets the portion of a document that is + this table of contents. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'range?: Word.Interfaces.RangeLoadOptions;' + return: + type: + - name: tabLeader + uid: word!Word.Interfaces.TableOfContentsCollectionLoadOptions#tabLeader:member + package: word! + fullName: tabLeader + summary: >- + For EACH ITEM in the collection: Specifies the character between entries + and their page numbers in the table of contents. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'tabLeader?: boolean;' + return: + type: boolean + - name: tableId + uid: word!Word.Interfaces.TableOfContentsCollectionLoadOptions#tableId:member + package: word! + fullName: tableId + summary: >- + For EACH ITEM in the collection: Specifies a one-letter identifier from + [TC + fields](https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3) + that's used for the table of contents. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'tableId?: boolean;' + return: + type: boolean + - name: upperHeadingLevel + uid: >- + word!Word.Interfaces.TableOfContentsCollectionLoadOptions#upperHeadingLevel:member + package: word! + fullName: upperHeadingLevel + summary: >- + For EACH ITEM in the collection: Specifies the starting heading level for + the table of contents. Must be a value from 1 to 9 and smaller than + `lowerHeadingLevel`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'upperHeadingLevel?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.tableofcontentscollectionupdatedata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.tableofcontentscollectionupdatedata.yml new file mode 100644 index 0000000000..90f2cee82c --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.tableofcontentscollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Word.Interfaces.TableOfContentsCollectionUpdateData +uid: word!Word.Interfaces.TableOfContentsCollectionUpdateData:interface +package: word! +fullName: Word.Interfaces.TableOfContentsCollectionUpdateData +summary: >- + An interface for updating data on the `TableOfContentsCollection` object, for + use in `tableOfContentsCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: word!Word.Interfaces.TableOfContentsCollectionUpdateData#items:member + package: word! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Word.Interfaces.TableOfContentsData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.tableofcontentsdata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.tableofcontentsdata.yml new file mode 100644 index 0000000000..e0b7f97a28 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.tableofcontentsdata.yml @@ -0,0 +1,189 @@ +### YamlMime:TSType +name: Word.Interfaces.TableOfContentsData +uid: word!Word.Interfaces.TableOfContentsData:interface +package: word! +fullName: Word.Interfaces.TableOfContentsData +summary: >- + An interface describing the data returned by calling + `tableOfContents.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: areBuiltInHeadingStylesUsed + uid: >- + word!Word.Interfaces.TableOfContentsData#areBuiltInHeadingStylesUsed:member + package: word! + fullName: areBuiltInHeadingStylesUsed + summary: >- + Specifies whether built-in heading styles are used for the table of + contents. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areBuiltInHeadingStylesUsed?: boolean;' + return: + type: boolean + - name: areFieldsUsed + uid: word!Word.Interfaces.TableOfContentsData#areFieldsUsed:member + package: word! + fullName: areFieldsUsed + summary: >- + Specifies whether [Table of Contents Entry (TC) + fields](https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3) + are included in the table of contents. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areFieldsUsed?: boolean;' + return: + type: boolean + - name: areHyperlinksUsedOnWeb + uid: word!Word.Interfaces.TableOfContentsData#areHyperlinksUsedOnWeb:member + package: word! + fullName: areHyperlinksUsedOnWeb + summary: >- + Specifies whether entries in the table of contents should be formatted as + hyperlinks when publishing to the web. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areHyperlinksUsedOnWeb?: boolean;' + return: + type: boolean + - name: arePageNumbersHiddenOnWeb + uid: word!Word.Interfaces.TableOfContentsData#arePageNumbersHiddenOnWeb:member + package: word! + fullName: arePageNumbersHiddenOnWeb + summary: >- + Specifies whether the page numbers in the table of contents should be + hidden when publishing to the web. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'arePageNumbersHiddenOnWeb?: boolean;' + return: + type: boolean + - name: arePageNumbersIncluded + uid: word!Word.Interfaces.TableOfContentsData#arePageNumbersIncluded:member + package: word! + fullName: arePageNumbersIncluded + summary: Specifies whether page numbers are included in the table of contents. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'arePageNumbersIncluded?: boolean;' + return: + type: boolean + - name: arePageNumbersRightAligned + uid: word!Word.Interfaces.TableOfContentsData#arePageNumbersRightAligned:member + package: word! + fullName: arePageNumbersRightAligned + summary: >- + Specifies whether page numbers are aligned with the right margin in the + table of contents. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'arePageNumbersRightAligned?: boolean;' + return: + type: boolean + - name: lowerHeadingLevel + uid: word!Word.Interfaces.TableOfContentsData#lowerHeadingLevel:member + package: word! + fullName: lowerHeadingLevel + summary: >- + Specifies the ending heading level for the table of contents. Must be a + value from 1 to 9 and greater than `upperHeadingLevel`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'lowerHeadingLevel?: number;' + return: + type: number + - name: tabLeader + uid: word!Word.Interfaces.TableOfContentsData#tabLeader:member + package: word! + fullName: tabLeader + summary: >- + Specifies the character between entries and their page numbers in the + table of contents. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | + "Heavy" | "MiddleDot"; + return: + type: >- + | "Spaces" | "Dots" | "Dashes" + | "Lines" | "Heavy" | "MiddleDot" + - name: tableId + uid: word!Word.Interfaces.TableOfContentsData#tableId:member + package: word! + fullName: tableId + summary: >- + Specifies a one-letter identifier from [TC + fields](https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3) + that's used for the table of contents. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'tableId?: string;' + return: + type: string + - name: upperHeadingLevel + uid: word!Word.Interfaces.TableOfContentsData#upperHeadingLevel:member + package: word! + fullName: upperHeadingLevel + summary: >- + Specifies the starting heading level for the table of contents. Must be a + value from 1 to 9 and smaller than `lowerHeadingLevel`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'upperHeadingLevel?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.tableofcontentsloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.tableofcontentsloadoptions.yml new file mode 100644 index 0000000000..6d117fb494 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.tableofcontentsloadoptions.yml @@ -0,0 +1,220 @@ +### YamlMime:TSType +name: Word.Interfaces.TableOfContentsLoadOptions +uid: word!Word.Interfaces.TableOfContentsLoadOptions:interface +package: word! +fullName: Word.Interfaces.TableOfContentsLoadOptions +summary: Represents a table of contents in a Word document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: $all + uid: word!Word.Interfaces.TableOfContentsLoadOptions#$all:member + package: word! + 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: true + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: areBuiltInHeadingStylesUsed + uid: >- + word!Word.Interfaces.TableOfContentsLoadOptions#areBuiltInHeadingStylesUsed:member + package: word! + fullName: areBuiltInHeadingStylesUsed + summary: >- + Specifies whether built-in heading styles are used for the table of + contents. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areBuiltInHeadingStylesUsed?: boolean;' + return: + type: boolean + - name: areFieldsUsed + uid: word!Word.Interfaces.TableOfContentsLoadOptions#areFieldsUsed:member + package: word! + fullName: areFieldsUsed + summary: >- + Specifies whether [Table of Contents Entry (TC) + fields](https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3) + are included in the table of contents. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areFieldsUsed?: boolean;' + return: + type: boolean + - name: areHyperlinksUsedOnWeb + uid: >- + word!Word.Interfaces.TableOfContentsLoadOptions#areHyperlinksUsedOnWeb:member + package: word! + fullName: areHyperlinksUsedOnWeb + summary: >- + Specifies whether entries in the table of contents should be formatted as + hyperlinks when publishing to the web. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areHyperlinksUsedOnWeb?: boolean;' + return: + type: boolean + - name: arePageNumbersHiddenOnWeb + uid: >- + word!Word.Interfaces.TableOfContentsLoadOptions#arePageNumbersHiddenOnWeb:member + package: word! + fullName: arePageNumbersHiddenOnWeb + summary: >- + Specifies whether the page numbers in the table of contents should be + hidden when publishing to the web. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'arePageNumbersHiddenOnWeb?: boolean;' + return: + type: boolean + - name: arePageNumbersIncluded + uid: >- + word!Word.Interfaces.TableOfContentsLoadOptions#arePageNumbersIncluded:member + package: word! + fullName: arePageNumbersIncluded + summary: Specifies whether page numbers are included in the table of contents. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'arePageNumbersIncluded?: boolean;' + return: + type: boolean + - name: arePageNumbersRightAligned + uid: >- + word!Word.Interfaces.TableOfContentsLoadOptions#arePageNumbersRightAligned:member + package: word! + fullName: arePageNumbersRightAligned + summary: >- + Specifies whether page numbers are aligned with the right margin in the + table of contents. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'arePageNumbersRightAligned?: boolean;' + return: + type: boolean + - name: lowerHeadingLevel + uid: word!Word.Interfaces.TableOfContentsLoadOptions#lowerHeadingLevel:member + package: word! + fullName: lowerHeadingLevel + summary: >- + Specifies the ending heading level for the table of contents. Must be a + value from 1 to 9 and greater than `upperHeadingLevel`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'lowerHeadingLevel?: boolean;' + return: + type: boolean + - name: range + uid: word!Word.Interfaces.TableOfContentsLoadOptions#range:member + package: word! + fullName: range + summary: Gets the portion of a document that is this table of contents. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'range?: Word.Interfaces.RangeLoadOptions;' + return: + type: + - name: tabLeader + uid: word!Word.Interfaces.TableOfContentsLoadOptions#tabLeader:member + package: word! + fullName: tabLeader + summary: >- + Specifies the character between entries and their page numbers in the + table of contents. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'tabLeader?: boolean;' + return: + type: boolean + - name: tableId + uid: word!Word.Interfaces.TableOfContentsLoadOptions#tableId:member + package: word! + fullName: tableId + summary: >- + Specifies a one-letter identifier from [TC + fields](https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3) + that's used for the table of contents. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'tableId?: boolean;' + return: + type: boolean + - name: upperHeadingLevel + uid: word!Word.Interfaces.TableOfContentsLoadOptions#upperHeadingLevel:member + package: word! + fullName: upperHeadingLevel + summary: >- + Specifies the starting heading level for the table of contents. Must be a + value from 1 to 9 and smaller than `lowerHeadingLevel`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'upperHeadingLevel?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.tableofcontentsupdatedata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.tableofcontentsupdatedata.yml new file mode 100644 index 0000000000..7d0738e89d --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.tableofcontentsupdatedata.yml @@ -0,0 +1,193 @@ +### YamlMime:TSType +name: Word.Interfaces.TableOfContentsUpdateData +uid: word!Word.Interfaces.TableOfContentsUpdateData:interface +package: word! +fullName: Word.Interfaces.TableOfContentsUpdateData +summary: >- + An interface for updating data on the `TableOfContents` object, for use in + `tableOfContents.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: areBuiltInHeadingStylesUsed + uid: >- + word!Word.Interfaces.TableOfContentsUpdateData#areBuiltInHeadingStylesUsed:member + package: word! + fullName: areBuiltInHeadingStylesUsed + summary: >- + Specifies whether built-in heading styles are used for the table of + contents. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areBuiltInHeadingStylesUsed?: boolean;' + return: + type: boolean + - name: areFieldsUsed + uid: word!Word.Interfaces.TableOfContentsUpdateData#areFieldsUsed:member + package: word! + fullName: areFieldsUsed + summary: >- + Specifies whether [Table of Contents Entry (TC) + fields](https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3) + are included in the table of contents. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areFieldsUsed?: boolean;' + return: + type: boolean + - name: areHyperlinksUsedOnWeb + uid: >- + word!Word.Interfaces.TableOfContentsUpdateData#areHyperlinksUsedOnWeb:member + package: word! + fullName: areHyperlinksUsedOnWeb + summary: >- + Specifies whether entries in the table of contents should be formatted as + hyperlinks when publishing to the web. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areHyperlinksUsedOnWeb?: boolean;' + return: + type: boolean + - name: arePageNumbersHiddenOnWeb + uid: >- + word!Word.Interfaces.TableOfContentsUpdateData#arePageNumbersHiddenOnWeb:member + package: word! + fullName: arePageNumbersHiddenOnWeb + summary: >- + Specifies whether the page numbers in the table of contents should be + hidden when publishing to the web. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'arePageNumbersHiddenOnWeb?: boolean;' + return: + type: boolean + - name: arePageNumbersIncluded + uid: >- + word!Word.Interfaces.TableOfContentsUpdateData#arePageNumbersIncluded:member + package: word! + fullName: arePageNumbersIncluded + summary: Specifies whether page numbers are included in the table of contents. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'arePageNumbersIncluded?: boolean;' + return: + type: boolean + - name: arePageNumbersRightAligned + uid: >- + word!Word.Interfaces.TableOfContentsUpdateData#arePageNumbersRightAligned:member + package: word! + fullName: arePageNumbersRightAligned + summary: >- + Specifies whether page numbers are aligned with the right margin in the + table of contents. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'arePageNumbersRightAligned?: boolean;' + return: + type: boolean + - name: lowerHeadingLevel + uid: word!Word.Interfaces.TableOfContentsUpdateData#lowerHeadingLevel:member + package: word! + fullName: lowerHeadingLevel + summary: >- + Specifies the ending heading level for the table of contents. Must be a + value from 1 to 9 and greater than `upperHeadingLevel`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'lowerHeadingLevel?: number;' + return: + type: number + - name: tabLeader + uid: word!Word.Interfaces.TableOfContentsUpdateData#tabLeader:member + package: word! + fullName: tabLeader + summary: >- + Specifies the character between entries and their page numbers in the + table of contents. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | + "Heavy" | "MiddleDot"; + return: + type: >- + | "Spaces" | "Dots" | "Dashes" + | "Lines" | "Heavy" | "MiddleDot" + - name: tableId + uid: word!Word.Interfaces.TableOfContentsUpdateData#tableId:member + package: word! + fullName: tableId + summary: >- + Specifies a one-letter identifier from [TC + fields](https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3) + that's used for the table of contents. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'tableId?: string;' + return: + type: string + - name: upperHeadingLevel + uid: word!Word.Interfaces.TableOfContentsUpdateData#upperHeadingLevel:member + package: word! + fullName: upperHeadingLevel + summary: >- + Specifies the starting heading level for the table of contents. Must be a + value from 1 to 9 and smaller than `lowerHeadingLevel`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'upperHeadingLevel?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.tableoffigurescollectiondata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.tableoffigurescollectiondata.yml new file mode 100644 index 0000000000..a3c8d9b368 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.tableoffigurescollectiondata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Word.Interfaces.TableOfFiguresCollectionData +uid: word!Word.Interfaces.TableOfFiguresCollectionData:interface +package: word! +fullName: Word.Interfaces.TableOfFiguresCollectionData +summary: >- + An interface describing the data returned by calling + `tableOfFiguresCollection.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: word!Word.Interfaces.TableOfFiguresCollectionData#items:member + package: word! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Word.Interfaces.TableOfFiguresData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.tableoffigurescollectionloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.tableoffigurescollectionloadoptions.yml new file mode 100644 index 0000000000..b040135be2 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.tableoffigurescollectionloadoptions.yml @@ -0,0 +1,270 @@ +### YamlMime:TSType +name: Word.Interfaces.TableOfFiguresCollectionLoadOptions +uid: word!Word.Interfaces.TableOfFiguresCollectionLoadOptions:interface +package: word! +fullName: Word.Interfaces.TableOfFiguresCollectionLoadOptions +summary: >- + Represents a collection of + [Word.TableOfFigures](xref:word!Word.TableOfFigures:class) objects in a Word + document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: $all + uid: word!Word.Interfaces.TableOfFiguresCollectionLoadOptions#$all:member + package: word! + 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: true + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: areBuiltInHeadingStylesUsed + uid: >- + word!Word.Interfaces.TableOfFiguresCollectionLoadOptions#areBuiltInHeadingStylesUsed:member + package: word! + fullName: areBuiltInHeadingStylesUsed + summary: >- + For EACH ITEM in the collection: Specifies whether built-in heading styles + are used for the table of figures. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areBuiltInHeadingStylesUsed?: boolean;' + return: + type: boolean + - name: areFieldsUsed + uid: >- + word!Word.Interfaces.TableOfFiguresCollectionLoadOptions#areFieldsUsed:member + package: word! + fullName: areFieldsUsed + summary: >- + For EACH ITEM in the collection: Specifies whether [Table of Contents + Entry (TC) + fields](https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3) + are included in the table of figures. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areFieldsUsed?: boolean;' + return: + type: boolean + - name: areHyperlinksUsedOnWeb + uid: >- + word!Word.Interfaces.TableOfFiguresCollectionLoadOptions#areHyperlinksUsedOnWeb:member + package: word! + fullName: areHyperlinksUsedOnWeb + summary: >- + For EACH ITEM in the collection: Specifies whether entries in the table of + figures should be formatted as hyperlinks when publishing to the web. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areHyperlinksUsedOnWeb?: boolean;' + return: + type: boolean + - name: arePageNumbersHiddenOnWeb + uid: >- + word!Word.Interfaces.TableOfFiguresCollectionLoadOptions#arePageNumbersHiddenOnWeb:member + package: word! + fullName: arePageNumbersHiddenOnWeb + summary: >- + For EACH ITEM in the collection: Specifies whether the page numbers in the + table of figures should be hidden when publishing to the web. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'arePageNumbersHiddenOnWeb?: boolean;' + return: + type: boolean + - name: arePageNumbersIncluded + uid: >- + word!Word.Interfaces.TableOfFiguresCollectionLoadOptions#arePageNumbersIncluded:member + package: word! + fullName: arePageNumbersIncluded + summary: >- + For EACH ITEM in the collection: Specifies whether page numbers are + included in the table of figures. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'arePageNumbersIncluded?: boolean;' + return: + type: boolean + - name: arePageNumbersRightAligned + uid: >- + word!Word.Interfaces.TableOfFiguresCollectionLoadOptions#arePageNumbersRightAligned:member + package: word! + fullName: arePageNumbersRightAligned + summary: >- + For EACH ITEM in the collection: Specifies whether page numbers are + aligned with the right margin in the table of figures. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'arePageNumbersRightAligned?: boolean;' + return: + type: boolean + - name: captionLabel + uid: >- + word!Word.Interfaces.TableOfFiguresCollectionLoadOptions#captionLabel:member + package: word! + fullName: captionLabel + summary: >- + For EACH ITEM in the collection: Specifies the label that identifies the + items to be included in the table of figures. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'captionLabel?: boolean;' + return: + type: boolean + - name: isLabelIncluded + uid: >- + word!Word.Interfaces.TableOfFiguresCollectionLoadOptions#isLabelIncluded:member + package: word! + fullName: isLabelIncluded + summary: >- + For EACH ITEM in the collection: Specifies whether the caption label and + caption number are included in the table of figures. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isLabelIncluded?: boolean;' + return: + type: boolean + - name: lowerHeadingLevel + uid: >- + word!Word.Interfaces.TableOfFiguresCollectionLoadOptions#lowerHeadingLevel:member + package: word! + fullName: lowerHeadingLevel + summary: >- + For EACH ITEM in the collection: Specifies the ending heading level for + the table of figures. Must be a value from 1 to 9 and greater than + `upperHeadingLevel`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'lowerHeadingLevel?: boolean;' + return: + type: boolean + - name: range + uid: word!Word.Interfaces.TableOfFiguresCollectionLoadOptions#range:member + package: word! + fullName: range + summary: >- + For EACH ITEM in the collection: Gets the portion of a document that is + this table of figures. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'range?: Word.Interfaces.RangeLoadOptions;' + return: + type: + - name: tabLeader + uid: word!Word.Interfaces.TableOfFiguresCollectionLoadOptions#tabLeader:member + package: word! + fullName: tabLeader + summary: >- + For EACH ITEM in the collection: Specifies the character between entries + and their page numbers in the table of figures. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'tabLeader?: boolean;' + return: + type: boolean + - name: tableId + uid: word!Word.Interfaces.TableOfFiguresCollectionLoadOptions#tableId:member + package: word! + fullName: tableId + summary: >- + For EACH ITEM in the collection: Specifies a one-letter identifier from + [TC + fields](https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3) + that's used for the table of figures. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'tableId?: boolean;' + return: + type: boolean + - name: upperHeadingLevel + uid: >- + word!Word.Interfaces.TableOfFiguresCollectionLoadOptions#upperHeadingLevel:member + package: word! + fullName: upperHeadingLevel + summary: >- + For EACH ITEM in the collection: Specifies the starting heading level for + the table of figures. Must be a value from 1 to 9 and smaller than + `lowerHeadingLevel`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'upperHeadingLevel?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.tableoffigurescollectionupdatedata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.tableoffigurescollectionupdatedata.yml new file mode 100644 index 0000000000..e3391932fe --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.tableoffigurescollectionupdatedata.yml @@ -0,0 +1,27 @@ +### YamlMime:TSType +name: Word.Interfaces.TableOfFiguresCollectionUpdateData +uid: word!Word.Interfaces.TableOfFiguresCollectionUpdateData:interface +package: word! +fullName: Word.Interfaces.TableOfFiguresCollectionUpdateData +summary: >- + An interface for updating data on the `TableOfFiguresCollection` object, for + use in `tableOfFiguresCollection.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: items + uid: word!Word.Interfaces.TableOfFiguresCollectionUpdateData#items:member + package: word! + fullName: items + summary: '' + remarks: '' + + isPreview: false + isDeprecated: false + syntax: + content: 'items?: Word.Interfaces.TableOfFiguresData[];' + return: + type: [] diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.tableoffiguresdata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.tableoffiguresdata.yml new file mode 100644 index 0000000000..bcc312bd5c --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.tableoffiguresdata.yml @@ -0,0 +1,222 @@ +### YamlMime:TSType +name: Word.Interfaces.TableOfFiguresData +uid: word!Word.Interfaces.TableOfFiguresData:interface +package: word! +fullName: Word.Interfaces.TableOfFiguresData +summary: >- + An interface describing the data returned by calling + `tableOfFigures.toJSON()`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: areBuiltInHeadingStylesUsed + uid: word!Word.Interfaces.TableOfFiguresData#areBuiltInHeadingStylesUsed:member + package: word! + fullName: areBuiltInHeadingStylesUsed + summary: >- + Specifies whether built-in heading styles are used for the table of + figures. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areBuiltInHeadingStylesUsed?: boolean;' + return: + type: boolean + - name: areFieldsUsed + uid: word!Word.Interfaces.TableOfFiguresData#areFieldsUsed:member + package: word! + fullName: areFieldsUsed + summary: >- + Specifies whether [Table of Contents Entry (TC) + fields](https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3) + are included in the table of figures. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areFieldsUsed?: boolean;' + return: + type: boolean + - name: areHyperlinksUsedOnWeb + uid: word!Word.Interfaces.TableOfFiguresData#areHyperlinksUsedOnWeb:member + package: word! + fullName: areHyperlinksUsedOnWeb + summary: >- + Specifies whether entries in the table of figures should be formatted as + hyperlinks when publishing to the web. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areHyperlinksUsedOnWeb?: boolean;' + return: + type: boolean + - name: arePageNumbersHiddenOnWeb + uid: word!Word.Interfaces.TableOfFiguresData#arePageNumbersHiddenOnWeb:member + package: word! + fullName: arePageNumbersHiddenOnWeb + summary: >- + Specifies whether the page numbers in the table of figures should be + hidden when publishing to the web. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'arePageNumbersHiddenOnWeb?: boolean;' + return: + type: boolean + - name: arePageNumbersIncluded + uid: word!Word.Interfaces.TableOfFiguresData#arePageNumbersIncluded:member + package: word! + fullName: arePageNumbersIncluded + summary: Specifies whether page numbers are included in the table of figures. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'arePageNumbersIncluded?: boolean;' + return: + type: boolean + - name: arePageNumbersRightAligned + uid: word!Word.Interfaces.TableOfFiguresData#arePageNumbersRightAligned:member + package: word! + fullName: arePageNumbersRightAligned + summary: >- + Specifies whether page numbers are aligned with the right margin in the + table of figures. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'arePageNumbersRightAligned?: boolean;' + return: + type: boolean + - name: captionLabel + uid: word!Word.Interfaces.TableOfFiguresData#captionLabel:member + package: word! + fullName: captionLabel + summary: >- + Specifies the label that identifies the items to be included in the table + of figures. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'captionLabel?: string;' + return: + type: string + - name: isLabelIncluded + uid: word!Word.Interfaces.TableOfFiguresData#isLabelIncluded:member + package: word! + fullName: isLabelIncluded + summary: >- + Specifies whether the caption label and caption number are included in the + table of figures. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isLabelIncluded?: boolean;' + return: + type: boolean + - name: lowerHeadingLevel + uid: word!Word.Interfaces.TableOfFiguresData#lowerHeadingLevel:member + package: word! + fullName: lowerHeadingLevel + summary: >- + Specifies the ending heading level for the table of figures. Must be a + value from 1 to 9 and greater than `upperHeadingLevel`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'lowerHeadingLevel?: number;' + return: + type: number + - name: tabLeader + uid: word!Word.Interfaces.TableOfFiguresData#tabLeader:member + package: word! + fullName: tabLeader + summary: >- + Specifies the character between entries and their page numbers in the + table of figures. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | + "Heavy" | "MiddleDot"; + return: + type: >- + | "Spaces" | "Dots" | "Dashes" + | "Lines" | "Heavy" | "MiddleDot" + - name: tableId + uid: word!Word.Interfaces.TableOfFiguresData#tableId:member + package: word! + fullName: tableId + summary: >- + Specifies a one-letter identifier from [TC + fields](https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3) + that's used for the table of figures. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'tableId?: string;' + return: + type: string + - name: upperHeadingLevel + uid: word!Word.Interfaces.TableOfFiguresData#upperHeadingLevel:member + package: word! + fullName: upperHeadingLevel + summary: >- + Specifies the starting heading level for the table of figures. Must be a + value from 1 to 9 and smaller than `lowerHeadingLevel`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'upperHeadingLevel?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.tableoffiguresloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.tableoffiguresloadoptions.yml new file mode 100644 index 0000000000..6be26cc7b4 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.tableoffiguresloadoptions.yml @@ -0,0 +1,254 @@ +### YamlMime:TSType +name: Word.Interfaces.TableOfFiguresLoadOptions +uid: word!Word.Interfaces.TableOfFiguresLoadOptions:interface +package: word! +fullName: Word.Interfaces.TableOfFiguresLoadOptions +summary: Represents a table of figures in a Word document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: $all + uid: word!Word.Interfaces.TableOfFiguresLoadOptions#$all:member + package: word! + 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: true + isDeprecated: false + syntax: + content: '$all?: boolean;' + return: + type: boolean + - name: areBuiltInHeadingStylesUsed + uid: >- + word!Word.Interfaces.TableOfFiguresLoadOptions#areBuiltInHeadingStylesUsed:member + package: word! + fullName: areBuiltInHeadingStylesUsed + summary: >- + Specifies whether built-in heading styles are used for the table of + figures. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areBuiltInHeadingStylesUsed?: boolean;' + return: + type: boolean + - name: areFieldsUsed + uid: word!Word.Interfaces.TableOfFiguresLoadOptions#areFieldsUsed:member + package: word! + fullName: areFieldsUsed + summary: >- + Specifies whether [Table of Contents Entry (TC) + fields](https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3) + are included in the table of figures. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areFieldsUsed?: boolean;' + return: + type: boolean + - name: areHyperlinksUsedOnWeb + uid: >- + word!Word.Interfaces.TableOfFiguresLoadOptions#areHyperlinksUsedOnWeb:member + package: word! + fullName: areHyperlinksUsedOnWeb + summary: >- + Specifies whether entries in the table of figures should be formatted as + hyperlinks when publishing to the web. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areHyperlinksUsedOnWeb?: boolean;' + return: + type: boolean + - name: arePageNumbersHiddenOnWeb + uid: >- + word!Word.Interfaces.TableOfFiguresLoadOptions#arePageNumbersHiddenOnWeb:member + package: word! + fullName: arePageNumbersHiddenOnWeb + summary: >- + Specifies whether the page numbers in the table of figures should be + hidden when publishing to the web. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'arePageNumbersHiddenOnWeb?: boolean;' + return: + type: boolean + - name: arePageNumbersIncluded + uid: >- + word!Word.Interfaces.TableOfFiguresLoadOptions#arePageNumbersIncluded:member + package: word! + fullName: arePageNumbersIncluded + summary: Specifies whether page numbers are included in the table of figures. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'arePageNumbersIncluded?: boolean;' + return: + type: boolean + - name: arePageNumbersRightAligned + uid: >- + word!Word.Interfaces.TableOfFiguresLoadOptions#arePageNumbersRightAligned:member + package: word! + fullName: arePageNumbersRightAligned + summary: >- + Specifies whether page numbers are aligned with the right margin in the + table of figures. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'arePageNumbersRightAligned?: boolean;' + return: + type: boolean + - name: captionLabel + uid: word!Word.Interfaces.TableOfFiguresLoadOptions#captionLabel:member + package: word! + fullName: captionLabel + summary: >- + Specifies the label that identifies the items to be included in the table + of figures. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'captionLabel?: boolean;' + return: + type: boolean + - name: isLabelIncluded + uid: word!Word.Interfaces.TableOfFiguresLoadOptions#isLabelIncluded:member + package: word! + fullName: isLabelIncluded + summary: >- + Specifies whether the caption label and caption number are included in the + table of figures. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isLabelIncluded?: boolean;' + return: + type: boolean + - name: lowerHeadingLevel + uid: word!Word.Interfaces.TableOfFiguresLoadOptions#lowerHeadingLevel:member + package: word! + fullName: lowerHeadingLevel + summary: >- + Specifies the ending heading level for the table of figures. Must be a + value from 1 to 9 and greater than `upperHeadingLevel`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'lowerHeadingLevel?: boolean;' + return: + type: boolean + - name: range + uid: word!Word.Interfaces.TableOfFiguresLoadOptions#range:member + package: word! + fullName: range + summary: Gets the portion of a document that is this table of figures. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'range?: Word.Interfaces.RangeLoadOptions;' + return: + type: + - name: tabLeader + uid: word!Word.Interfaces.TableOfFiguresLoadOptions#tabLeader:member + package: word! + fullName: tabLeader + summary: >- + Specifies the character between entries and their page numbers in the + table of figures. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'tabLeader?: boolean;' + return: + type: boolean + - name: tableId + uid: word!Word.Interfaces.TableOfFiguresLoadOptions#tableId:member + package: word! + fullName: tableId + summary: >- + Specifies a one-letter identifier from [TC + fields](https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3) + that's used for the table of figures. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'tableId?: boolean;' + return: + type: boolean + - name: upperHeadingLevel + uid: word!Word.Interfaces.TableOfFiguresLoadOptions#upperHeadingLevel:member + package: word! + fullName: upperHeadingLevel + summary: >- + Specifies the starting heading level for the table of figures. Must be a + value from 1 to 9 and smaller than `lowerHeadingLevel`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'upperHeadingLevel?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.tableoffiguresupdatedata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.tableoffiguresupdatedata.yml new file mode 100644 index 0000000000..a7e0bb272d --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.interfaces.tableoffiguresupdatedata.yml @@ -0,0 +1,227 @@ +### YamlMime:TSType +name: Word.Interfaces.TableOfFiguresUpdateData +uid: word!Word.Interfaces.TableOfFiguresUpdateData:interface +package: word! +fullName: Word.Interfaces.TableOfFiguresUpdateData +summary: >- + An interface for updating data on the `TableOfFigures` object, for use in + `tableOfFigures.set({ ... })`. +remarks: '' + +isPreview: false +isDeprecated: false +type: interface +properties: + - name: areBuiltInHeadingStylesUsed + uid: >- + word!Word.Interfaces.TableOfFiguresUpdateData#areBuiltInHeadingStylesUsed:member + package: word! + fullName: areBuiltInHeadingStylesUsed + summary: >- + Specifies whether built-in heading styles are used for the table of + figures. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areBuiltInHeadingStylesUsed?: boolean;' + return: + type: boolean + - name: areFieldsUsed + uid: word!Word.Interfaces.TableOfFiguresUpdateData#areFieldsUsed:member + package: word! + fullName: areFieldsUsed + summary: >- + Specifies whether [Table of Contents Entry (TC) + fields](https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3) + are included in the table of figures. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areFieldsUsed?: boolean;' + return: + type: boolean + - name: areHyperlinksUsedOnWeb + uid: >- + word!Word.Interfaces.TableOfFiguresUpdateData#areHyperlinksUsedOnWeb:member + package: word! + fullName: areHyperlinksUsedOnWeb + summary: >- + Specifies whether entries in the table of figures should be formatted as + hyperlinks when publishing to the web. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areHyperlinksUsedOnWeb?: boolean;' + return: + type: boolean + - name: arePageNumbersHiddenOnWeb + uid: >- + word!Word.Interfaces.TableOfFiguresUpdateData#arePageNumbersHiddenOnWeb:member + package: word! + fullName: arePageNumbersHiddenOnWeb + summary: >- + Specifies whether the page numbers in the table of figures should be + hidden when publishing to the web. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'arePageNumbersHiddenOnWeb?: boolean;' + return: + type: boolean + - name: arePageNumbersIncluded + uid: >- + word!Word.Interfaces.TableOfFiguresUpdateData#arePageNumbersIncluded:member + package: word! + fullName: arePageNumbersIncluded + summary: Specifies whether page numbers are included in the table of figures. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'arePageNumbersIncluded?: boolean;' + return: + type: boolean + - name: arePageNumbersRightAligned + uid: >- + word!Word.Interfaces.TableOfFiguresUpdateData#arePageNumbersRightAligned:member + package: word! + fullName: arePageNumbersRightAligned + summary: >- + Specifies whether page numbers are aligned with the right margin in the + table of figures. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'arePageNumbersRightAligned?: boolean;' + return: + type: boolean + - name: captionLabel + uid: word!Word.Interfaces.TableOfFiguresUpdateData#captionLabel:member + package: word! + fullName: captionLabel + summary: >- + Specifies the label that identifies the items to be included in the table + of figures. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'captionLabel?: string;' + return: + type: string + - name: isLabelIncluded + uid: word!Word.Interfaces.TableOfFiguresUpdateData#isLabelIncluded:member + package: word! + fullName: isLabelIncluded + summary: >- + Specifies whether the caption label and caption number are included in the + table of figures. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isLabelIncluded?: boolean;' + return: + type: boolean + - name: lowerHeadingLevel + uid: word!Word.Interfaces.TableOfFiguresUpdateData#lowerHeadingLevel:member + package: word! + fullName: lowerHeadingLevel + summary: >- + Specifies the ending heading level for the table of figures. Must be a + value from 1 to 9 and greater than `upperHeadingLevel`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'lowerHeadingLevel?: number;' + return: + type: number + - name: tabLeader + uid: word!Word.Interfaces.TableOfFiguresUpdateData#tabLeader:member + package: word! + fullName: tabLeader + summary: >- + Specifies the character between entries and their page numbers in the + table of figures. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | + "Heavy" | "MiddleDot"; + return: + type: >- + | "Spaces" | "Dots" | "Dashes" + | "Lines" | "Heavy" | "MiddleDot" + - name: tableId + uid: word!Word.Interfaces.TableOfFiguresUpdateData#tableId:member + package: word! + fullName: tableId + summary: >- + Specifies a one-letter identifier from [TC + fields](https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3) + that's used for the table of figures. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'tableId?: string;' + return: + type: string + - name: upperHeadingLevel + uid: word!Word.Interfaces.TableOfFiguresUpdateData#upperHeadingLevel:member + package: word! + fullName: upperHeadingLevel + summary: >- + Specifies the starting heading level for the table of figures. Must be a + value from 1 to 9 and smaller than `lowerHeadingLevel`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'upperHeadingLevel?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.tablerowcollectionloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.tablerowcollectionloadoptions.yml index 4dd017502d..3e22adcdd9 100644 --- a/docs/docs-ref-autogen/word/word/word.interfaces.tablerowcollectionloadoptions.yml +++ b/docs/docs-ref-autogen/word/word/word.interfaces.tablerowcollectionloadoptions.yml @@ -129,6 +129,23 @@ properties: content: 'preferredHeight?: boolean;' return: type: boolean + - name: range + uid: word!Word.Interfaces.TableRowCollectionLoadOptions#range:member + package: word! + fullName: range + summary: >- + For EACH ITEM in the collection: Returns the `Range` object that + represents the table row. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'range?: Word.Interfaces.RangeLoadOptions;' + return: + type: - name: rowIndex uid: word!Word.Interfaces.TableRowCollectionLoadOptions#rowIndex:member package: word! @@ -146,6 +163,25 @@ properties: content: 'rowIndex?: boolean;' return: type: boolean + - name: shading + uid: word!Word.Interfaces.TableRowCollectionLoadOptions#shading:member + package: word! + fullName: shading + summary: >- + For EACH ITEM in the collection: Returns the `ShadingUniversal` object + that represents the shading of the table row. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'shading?: Word.Interfaces.ShadingUniversalLoadOptions;' + return: + type: >- + - name: shadingColor uid: word!Word.Interfaces.TableRowCollectionLoadOptions#shadingColor:member package: word! diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.tablerowloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.tablerowloadoptions.yml index a7b7ba250b..19219c3dda 100644 --- a/docs/docs-ref-autogen/word/word/word.interfaces.tablerowloadoptions.yml +++ b/docs/docs-ref-autogen/word/word/word.interfaces.tablerowloadoptions.yml @@ -124,6 +124,21 @@ properties: content: 'preferredHeight?: boolean;' return: type: boolean + - name: range + uid: word!Word.Interfaces.TableRowLoadOptions#range:member + package: word! + fullName: range + summary: Returns the `Range` object that represents the table row. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'range?: Word.Interfaces.RangeLoadOptions;' + return: + type: - name: rowIndex uid: word!Word.Interfaces.TableRowLoadOptions#rowIndex:member package: word! @@ -139,6 +154,25 @@ properties: content: 'rowIndex?: boolean;' return: type: boolean + - name: shading + uid: word!Word.Interfaces.TableRowLoadOptions#shading:member + package: word! + fullName: shading + summary: >- + Returns the `ShadingUniversal` object that represents the shading of the + table row. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'shading?: Word.Interfaces.ShadingUniversalLoadOptions;' + return: + type: >- + - name: shadingColor uid: word!Word.Interfaces.TableRowLoadOptions#shadingColor:member package: word! diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.tablestyledata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.tablestyledata.yml index d2d1ed5e68..68aa513308 100644 --- a/docs/docs-ref-autogen/word/word/word.interfaces.tablestyledata.yml +++ b/docs/docs-ref-autogen/word/word/word.interfaces.tablestyledata.yml @@ -80,6 +80,40 @@ properties: content: 'cellSpacing?: number;' return: type: number + - name: columnStripe + uid: word!Word.Interfaces.TableStyleData#columnStripe:member + package: word! + fullName: columnStripe + summary: >- + Specifies the number of columns in the banding when a style specifies odd- + or even-column banding. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'columnStripe?: number;' + return: + type: number + - name: isBreakAcrossPagesAllowed + uid: word!Word.Interfaces.TableStyleData#isBreakAcrossPagesAllowed:member + package: word! + fullName: isBreakAcrossPagesAllowed + summary: >- + Specifies whether Microsoft Word allows to break the specified table + across pages. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isBreakAcrossPagesAllowed?: boolean;' + return: + type: boolean - name: leftCellMargin uid: word!Word.Interfaces.TableStyleData#leftCellMargin:member package: word! @@ -97,6 +131,23 @@ properties: content: 'leftCellMargin?: number;' return: type: number + - name: leftIndent + uid: word!Word.Interfaces.TableStyleData#leftIndent:member + package: word! + fullName: leftIndent + summary: >- + Specifies the left indent value (in points) for the rows in the table + style. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'leftIndent?: number;' + return: + type: number - name: rightCellMargin uid: word!Word.Interfaces.TableStyleData#rightCellMargin:member package: word! @@ -114,6 +165,42 @@ properties: content: 'rightCellMargin?: number;' return: type: number + - name: rowStripe + uid: word!Word.Interfaces.TableStyleData#rowStripe:member + package: word! + fullName: rowStripe + summary: >- + Specifies the number of rows to include in the banding when the style + specifies odd- or even-row banding. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'rowStripe?: number;' + return: + type: number + - name: tableDirection + uid: word!Word.Interfaces.TableStyleData#tableDirection:member + package: word! + fullName: tableDirection + summary: >- + Specifies the direction in which Microsoft Word orders cells in the table + style. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'tableDirection?: Word.TableDirection | "RightToLeft" | "LeftToRight";' + return: + type: >- + | "RightToLeft" | + "LeftToRight" - name: topCellMargin uid: word!Word.Interfaces.TableStyleData#topCellMargin:member package: word! diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.tablestyleloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.tablestyleloadoptions.yml index 260e2b226d..d55a0b28e4 100644 --- a/docs/docs-ref-autogen/word/word/word.interfaces.tablestyleloadoptions.yml +++ b/docs/docs-ref-autogen/word/word/word.interfaces.tablestyleloadoptions.yml @@ -92,6 +92,41 @@ properties: content: 'cellSpacing?: boolean;' return: type: boolean + - name: columnStripe + uid: word!Word.Interfaces.TableStyleLoadOptions#columnStripe:member + package: word! + fullName: columnStripe + summary: >- + Specifies the number of columns in the banding when a style specifies odd- + or even-column banding. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'columnStripe?: boolean;' + return: + type: boolean + - name: isBreakAcrossPagesAllowed + uid: >- + word!Word.Interfaces.TableStyleLoadOptions#isBreakAcrossPagesAllowed:member + package: word! + fullName: isBreakAcrossPagesAllowed + summary: >- + Specifies whether Microsoft Word allows to break the specified table + across pages. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isBreakAcrossPagesAllowed?: boolean;' + return: + type: boolean - name: leftCellMargin uid: word!Word.Interfaces.TableStyleLoadOptions#leftCellMargin:member package: word! @@ -109,6 +144,23 @@ properties: content: 'leftCellMargin?: boolean;' return: type: boolean + - name: leftIndent + uid: word!Word.Interfaces.TableStyleLoadOptions#leftIndent:member + package: word! + fullName: leftIndent + summary: >- + Specifies the left indent value (in points) for the rows in the table + style. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'leftIndent?: boolean;' + return: + type: boolean - name: rightCellMargin uid: word!Word.Interfaces.TableStyleLoadOptions#rightCellMargin:member package: word! @@ -126,6 +178,57 @@ properties: content: 'rightCellMargin?: boolean;' return: type: boolean + - name: rowStripe + uid: word!Word.Interfaces.TableStyleLoadOptions#rowStripe:member + package: word! + fullName: rowStripe + summary: >- + Specifies the number of rows to include in the banding when the style + specifies odd- or even-row banding. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'rowStripe?: boolean;' + return: + type: boolean + - name: shading + uid: word!Word.Interfaces.TableStyleLoadOptions#shading:member + package: word! + fullName: shading + summary: >- + Returns a `ShadingUniversal` object that refers to the shading formatting + for the table style. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'shading?: Word.Interfaces.ShadingLoadOptions;' + return: + type: + - name: tableDirection + uid: word!Word.Interfaces.TableStyleLoadOptions#tableDirection:member + package: word! + fullName: tableDirection + summary: >- + Specifies the direction in which Microsoft Word orders cells in the table + style. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'tableDirection?: boolean;' + return: + type: boolean - name: topCellMargin uid: word!Word.Interfaces.TableStyleLoadOptions#topCellMargin:member package: word! diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.tablestyleupdatedata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.tablestyleupdatedata.yml index eee89b0428..224281271f 100644 --- a/docs/docs-ref-autogen/word/word/word.interfaces.tablestyleupdatedata.yml +++ b/docs/docs-ref-autogen/word/word/word.interfaces.tablestyleupdatedata.yml @@ -80,6 +80,40 @@ properties: content: 'cellSpacing?: number;' return: type: number + - name: columnStripe + uid: word!Word.Interfaces.TableStyleUpdateData#columnStripe:member + package: word! + fullName: columnStripe + summary: >- + Specifies the number of columns in the banding when a style specifies odd- + or even-column banding. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'columnStripe?: number;' + return: + type: number + - name: isBreakAcrossPagesAllowed + uid: word!Word.Interfaces.TableStyleUpdateData#isBreakAcrossPagesAllowed:member + package: word! + fullName: isBreakAcrossPagesAllowed + summary: >- + Specifies whether Microsoft Word allows to break the specified table + across pages. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isBreakAcrossPagesAllowed?: boolean;' + return: + type: boolean - name: leftCellMargin uid: word!Word.Interfaces.TableStyleUpdateData#leftCellMargin:member package: word! @@ -97,6 +131,23 @@ properties: content: 'leftCellMargin?: number;' return: type: number + - name: leftIndent + uid: word!Word.Interfaces.TableStyleUpdateData#leftIndent:member + package: word! + fullName: leftIndent + summary: >- + Specifies the left indent value (in points) for the rows in the table + style. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'leftIndent?: number;' + return: + type: number - name: rightCellMargin uid: word!Word.Interfaces.TableStyleUpdateData#rightCellMargin:member package: word! @@ -114,6 +165,42 @@ properties: content: 'rightCellMargin?: number;' return: type: number + - name: rowStripe + uid: word!Word.Interfaces.TableStyleUpdateData#rowStripe:member + package: word! + fullName: rowStripe + summary: >- + Specifies the number of rows to include in the banding when the style + specifies odd- or even-row banding. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'rowStripe?: number;' + return: + type: number + - name: tableDirection + uid: word!Word.Interfaces.TableStyleUpdateData#tableDirection:member + package: word! + fullName: tableDirection + summary: >- + Specifies the direction in which Microsoft Word orders cells in the table + style. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'tableDirection?: Word.TableDirection | "RightToLeft" | "LeftToRight";' + return: + type: >- + | "RightToLeft" | + "LeftToRight" - name: topCellMargin uid: word!Word.Interfaces.TableStyleUpdateData#topCellMargin:member package: word! diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.tableupdatedata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.tableupdatedata.yml index b259fb1855..39e848383a 100644 --- a/docs/docs-ref-autogen/word/word/word.interfaces.tableupdatedata.yml +++ b/docs/docs-ref-autogen/word/word/word.interfaces.tableupdatedata.yml @@ -33,6 +33,21 @@ properties: type: >- | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified" + - name: description + uid: word!Word.Interfaces.TableUpdateData#description:member + package: word! + fullName: description + summary: Specifies the description of the table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'description?: string;' + return: + type: string - name: font uid: word!Word.Interfaces.TableUpdateData#font:member package: word! @@ -318,6 +333,21 @@ properties: content: 'styleTotalRow?: boolean;' return: type: boolean + - name: title + uid: word!Word.Interfaces.TableUpdateData#title:member + package: word! + fullName: title + summary: Specifies the title of the table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'title?: string;' + return: + type: string - name: values uid: word!Word.Interfaces.TableUpdateData#values:member package: word! diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.windowcollectionloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.windowcollectionloadoptions.yml index 5a1933cf5f..44e2fee688 100644 --- a/docs/docs-ref-autogen/word/word/word.interfaces.windowcollectionloadoptions.yml +++ b/docs/docs-ref-autogen/word/word/word.interfaces.windowcollectionloadoptions.yml @@ -28,6 +28,21 @@ properties: content: '$all?: boolean;' return: type: boolean + - name: activePane + uid: word!Word.Interfaces.WindowCollectionLoadOptions#activePane:member + package: word! + fullName: activePane + summary: 'For EACH ITEM in the collection: Gets the active pane in the window.' + remarks: >- + \[ [API set: WordApiDesktop + 1.2](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'activePane?: Word.Interfaces.PaneLoadOptions;' + return: + type: - name: areRulersDisplayed uid: word!Word.Interfaces.WindowCollectionLoadOptions#areRulersDisplayed:member package: word! @@ -134,10 +149,10 @@ properties: content: 'horizontalPercentScrolled?: boolean;' return: type: boolean - - name: imemode - uid: word!Word.Interfaces.WindowCollectionLoadOptions#imemode:member + - name: imeMode + uid: word!Word.Interfaces.WindowCollectionLoadOptions#imeMode:member package: word! - fullName: imemode + fullName: imeMode summary: >- For EACH ITEM in the collection: Specifies the default start-up mode for the Japanese Input Method Editor (IME). @@ -148,7 +163,7 @@ properties: isPreview: true isDeprecated: false syntax: - content: 'imemode?: boolean;' + content: 'imeMode?: boolean;' return: type: boolean - name: index diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.windowdata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.windowdata.yml index ce89c710eb..1117a64d3f 100644 --- a/docs/docs-ref-autogen/word/word/word.interfaces.windowdata.yml +++ b/docs/docs-ref-autogen/word/word/word.interfaces.windowdata.yml @@ -110,10 +110,10 @@ properties: content: 'horizontalPercentScrolled?: number;' return: type: number - - name: imemode - uid: word!Word.Interfaces.WindowData#imemode:member + - name: imeMode + uid: word!Word.Interfaces.WindowData#imeMode:member package: word! - fullName: imemode + fullName: imeMode summary: >- Specifies the default start-up mode for the Japanese Input Method Editor (IME). @@ -125,7 +125,7 @@ properties: isDeprecated: false syntax: content: >- - imemode?: Word.ImeMode | "NoControl" | "On" | "Off" | "Hiragana" | + imeMode?: Word.ImeMode | "NoControl" | "On" | "Off" | "Hiragana" | "Katakana" | "KatakanaHalf" | "AlphaFull" | "Alpha" | "HangulFull" | "Hangul"; return: diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.windowloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.windowloadoptions.yml index 81c00ef12d..72151a3399 100644 --- a/docs/docs-ref-autogen/word/word/word.interfaces.windowloadoptions.yml +++ b/docs/docs-ref-autogen/word/word/word.interfaces.windowloadoptions.yml @@ -30,6 +30,21 @@ properties: content: '$all?: boolean;' return: type: boolean + - name: activePane + uid: word!Word.Interfaces.WindowLoadOptions#activePane:member + package: word! + fullName: activePane + summary: Gets the active pane in the window. + remarks: >- + \[ [API set: WordApiDesktop + 1.2](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: false + isDeprecated: false + syntax: + content: 'activePane?: Word.Interfaces.PaneLoadOptions;' + return: + type: - name: areRulersDisplayed uid: word!Word.Interfaces.WindowLoadOptions#areRulersDisplayed:member package: word! @@ -128,10 +143,10 @@ properties: content: 'horizontalPercentScrolled?: boolean;' return: type: boolean - - name: imemode - uid: word!Word.Interfaces.WindowLoadOptions#imemode:member + - name: imeMode + uid: word!Word.Interfaces.WindowLoadOptions#imeMode:member package: word! - fullName: imemode + fullName: imeMode summary: >- Specifies the default start-up mode for the Japanese Input Method Editor (IME). @@ -142,7 +157,7 @@ properties: isPreview: true isDeprecated: false syntax: - content: 'imemode?: boolean;' + content: 'imeMode?: boolean;' return: type: boolean - name: index diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.windowupdatedata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.windowupdatedata.yml index 29ea45e03a..e577add1ee 100644 --- a/docs/docs-ref-autogen/word/word/word.interfaces.windowupdatedata.yml +++ b/docs/docs-ref-autogen/word/word/word.interfaces.windowupdatedata.yml @@ -78,10 +78,10 @@ properties: content: 'horizontalPercentScrolled?: number;' return: type: number - - name: imemode - uid: word!Word.Interfaces.WindowUpdateData#imemode:member + - name: imeMode + uid: word!Word.Interfaces.WindowUpdateData#imeMode:member package: word! - fullName: imemode + fullName: imeMode summary: >- Specifies the default start-up mode for the Japanese Input Method Editor (IME). @@ -93,7 +93,7 @@ properties: isDeprecated: false syntax: content: >- - imemode?: Word.ImeMode | "NoControl" | "On" | "Off" | "Hiragana" | + imeMode?: Word.ImeMode | "NoControl" | "On" | "Off" | "Hiragana" | "Katakana" | "KatakanaHalf" | "AlphaFull" | "Alpha" | "HangulFull" | "Hangul"; return: diff --git a/docs/docs-ref-autogen/word/word/word.listtemplate.yml b/docs/docs-ref-autogen/word/word/word.listtemplate.yml index 4b7460e071..c71e3c6148 100644 --- a/docs/docs-ref-autogen/word/word/word.listtemplate.yml +++ b/docs/docs-ref-autogen/word/word/word.listtemplate.yml @@ -87,6 +87,21 @@ properties: content: 'readonly listLevels: Word.ListLevelCollection;' return: type: + - name: name + uid: word!Word.ListTemplate#name:member + package: word! + fullName: name + summary: Specifies the name of the list template. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'name: string;' + return: + type: string - name: outlineNumbered uid: word!Word.ListTemplate#outlineNumbered:member package: word! diff --git a/docs/docs-ref-autogen/word/word/word.listtemplatecollection.yml b/docs/docs-ref-autogen/word/word/word.listtemplatecollection.yml new file mode 100644 index 0000000000..ab0730542b --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.listtemplatecollection.yml @@ -0,0 +1,236 @@ +### YamlMime:TSType +name: Word.ListTemplateCollection +uid: word!Word.ListTemplateCollection:class +package: word! +fullName: Word.ListTemplateCollection +summary: >- + Contains a collection of + [Word.ListTemplate](xref:word!Word.ListTemplate:class) objects in a document, + list template gallery, or document template. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: class +properties: + - name: context + uid: word!Word.ListTemplateCollection#context:member + package: word! + 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: true + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: word!Word.ListTemplateCollection#items:member + package: word! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly items: Word.ListTemplate[];' + return: + type: [] +methods: + - name: add(options) + uid: word!Word.ListTemplateCollection#add:member(1) + package: word! + fullName: add(options) + summary: >- + Adds a new `ListTemplate` object. Note: This operation isn't allowed if + the collection represents list templates from a + [Word.ListTemplateGallery](xref:word!Word.ListTemplateGallery:class). + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'add(options?: Word.ListTemplateCollectionAddOptions): Word.ListTemplate;' + parameters: + - id: options + description: Optional. Options for adding a new list template. + type: + return: + type: + description: '' + - name: getItem(index) + uid: word!Word.ListTemplateCollection#getItem:member(1) + package: word! + fullName: getItem(index) + summary: Gets a `ListTemplate` object by its index in the collection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'getItem(index: number): Word.ListTemplate;' + parameters: + - id: index + description: >- + A number that identifies the index location of a `ListTemplate` + object. + type: number + return: + type: + description: '' + - name: load(options) + uid: word!Word.ListTemplateCollection#load:member(1) + package: word! + 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: true + isDeprecated: false + syntax: + content: >- + load(options?: Word.Interfaces.ListTemplateCollectionLoadOptions & + Word.Interfaces.CollectionLoadOptions): Word.ListTemplateCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: word!Word.ListTemplateCollection#load:member(2) + package: word! + 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: true + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Word.ListTemplateCollection;' + 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: word!Word.ListTemplateCollection#load:member(3) + package: word! + 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: true + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Word.ListTemplateCollection; + 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: word!Word.ListTemplateCollection#toJSON:member(1) + package: word! + 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 + `Word.ListTemplateCollection` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Word.Interfaces.ListTemplateCollectionData`) that contains an + "items" array with shallow copies of any loaded properties from the + collection's items. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'toJSON(): Word.Interfaces.ListTemplateCollectionData;' + return: + type: >- + + description: '' + - name: track() + uid: word!Word.ListTemplateCollection#track:member(1) + package: word! + fullName: track() + summary: >- + Track the object for automatic adjustment based on surrounding changes in + the document. This call is a shorthand for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). If you're using this object across `.sync` calls and outside the + sequential execution of a ".run" batch, and get an "InvalidObjectPath" + error when setting a property or invoking a method on the object, you need + to add the object to the tracked object collection when the object was + first created. If this object is part of a collection, you should also + track the parent collection. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'track(): Word.ListTemplateCollection;' + return: + type: + description: '' + - name: untrack() + uid: word!Word.ListTemplateCollection#untrack:member(1) + package: word! + fullName: untrack() + summary: >- + Release the memory associated with this object, if it has previously been + tracked. This call is shorthand for + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). Having many tracked objects slows down the host application, so + please remember to free any objects you add, once you're done using them. + You'll need to call `context.sync()` before the memory release takes + effect. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'untrack(): Word.ListTemplateCollection;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/word/word/word.listtemplatecollectionaddoptions.yml b/docs/docs-ref-autogen/word/word/word.listtemplatecollectionaddoptions.yml new file mode 100644 index 0000000000..26c6d7170e --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.listtemplatecollectionaddoptions.yml @@ -0,0 +1,49 @@ +### YamlMime:TSType +name: Word.ListTemplateCollectionAddOptions +uid: word!Word.ListTemplateCollectionAddOptions:interface +package: word! +fullName: Word.ListTemplateCollectionAddOptions +summary: >- + Represents the options for the + [ListTemplateCollection.add](xref:word!Word.ListTemplateCollection:class) + method. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: name + uid: word!Word.ListTemplateCollectionAddOptions#name:member + package: word! + fullName: name + summary: If provided, specifies the name of the list template to be added. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string + - name: outlineNumbered + uid: word!Word.ListTemplateCollectionAddOptions#outlineNumbered:member + package: word! + fullName: outlineNumbered + summary: >- + If provided, specifies whether to apply outline numbering to the new list + template. The default value is `false`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'outlineNumbered?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.listtemplategallery.yml b/docs/docs-ref-autogen/word/word/word.listtemplategallery.yml new file mode 100644 index 0000000000..05ba732e8d --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.listtemplategallery.yml @@ -0,0 +1,171 @@ +### YamlMime:TSType +name: Word.ListTemplateGallery +uid: word!Word.ListTemplateGallery:class +package: word! +fullName: Word.ListTemplateGallery +summary: >- + Represents a gallery of list templates of the same + [Word.ListTemplateGalleryType](xref:word!Word.ListTemplateGalleryType:enum). +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: class +properties: + - name: context + uid: word!Word.ListTemplateGallery#context:member + package: word! + 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: true + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: listTemplates + uid: word!Word.ListTemplateGallery#listTemplates:member + package: word! + fullName: listTemplates + summary: >- + Returns a `ListTemplateCollection` object that represents all the list + templates for the specified list gallery. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly listTemplates: Word.ListTemplateCollection;' + return: + type: +methods: + - name: load(propertyNames) + uid: word!Word.ListTemplateGallery#load:member(1) + package: word! + 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: true + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Word.ListTemplateGallery;' + 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: word!Word.ListTemplateGallery#load:member(2) + package: word! + 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: true + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.ListTemplateGallery; + 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: word!Word.ListTemplateGallery#toJSON:member(1) + package: word! + 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 + `Word.ListTemplateGallery` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Word.Interfaces.ListTemplateGalleryData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'toJSON(): Word.Interfaces.ListTemplateGalleryData;' + return: + type: + description: '' + - name: track() + uid: word!Word.ListTemplateGallery#track:member(1) + package: word! + fullName: track() + summary: >- + Track the object for automatic adjustment based on surrounding changes in + the document. This call is a shorthand for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). If you're using this object across `.sync` calls and outside the + sequential execution of a ".run" batch, and get an "InvalidObjectPath" + error when setting a property or invoking a method on the object, you need + to add the object to the tracked object collection when the object was + first created. If this object is part of a collection, you should also + track the parent collection. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'track(): Word.ListTemplateGallery;' + return: + type: + description: '' + - name: untrack() + uid: word!Word.ListTemplateGallery#untrack:member(1) + package: word! + fullName: untrack() + summary: >- + Release the memory associated with this object, if it has previously been + tracked. This call is shorthand for + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). Having many tracked objects slows down the host application, so + please remember to free any objects you add, once you're done using them. + You'll need to call `context.sync()` before the memory release takes + effect. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'untrack(): Word.ListTemplateGallery;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/word/word/word.listtemplategallerycollection.yml b/docs/docs-ref-autogen/word/word/word.listtemplategallerycollection.yml new file mode 100644 index 0000000000..d8b03c97d7 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.listtemplategallerycollection.yml @@ -0,0 +1,234 @@ +### YamlMime:TSType +name: Word.ListTemplateGalleryCollection +uid: word!Word.ListTemplateGalleryCollection:class +package: word! +fullName: Word.ListTemplateGalleryCollection +summary: >- + Contains a collection of + [Word.ListTemplateGallery](xref:word!Word.ListTemplateGallery:class) objects + available through the three bullets-and-numbering buttons on the **Home** + tab (see [Define new bullets, numbers, and multilevel + lists](https://support.microsoft.com/office/6c06ef65-27ad-4893-80c9-0b944cb81f5f) + for how to access in the Word UI). +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: class +properties: + - name: context + uid: word!Word.ListTemplateGalleryCollection#context:member + package: word! + 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: true + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: word!Word.ListTemplateGalleryCollection#items:member + package: word! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly items: Word.ListTemplateGallery[];' + return: + type: [] +methods: + - name: getByType(type) + uid: word!Word.ListTemplateGalleryCollection#getByType:member(1) + package: word! + fullName: getByType(type) + summary: Gets a `ListTemplateGallery` object by its type in the collection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'getByType(type: Word.ListTemplateGalleryType): Word.ListTemplateGallery;' + parameters: + - id: type + description: The type of list template gallery to retrieve. + type: + return: + type: + description: '' + - name: getByType(type) + uid: word!Word.ListTemplateGalleryCollection#getByType:member(2) + package: word! + fullName: getByType(type) + summary: Gets a `ListTemplateGallery` object by its type in the collection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + getByType(type: "Bullets" | "Number" | "OutlineNumbered"): + Word.ListTemplateGallery; + parameters: + - id: type + description: The type of list template gallery to retrieve. + type: '"Bullets" | "Number" | "OutlineNumbered"' + return: + type: + description: '' + - name: getItem(index) + uid: word!Word.ListTemplateGalleryCollection#getItem:member(1) + package: word! + fullName: getItem(index) + summary: Gets a `ListTemplateGallery` object by its index in the collection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'getItem(index: number): Word.ListTemplateGallery;' + parameters: + - id: index + description: >- + A number that identifies the index location of a + `ListTemplateGallery` object. + type: number + return: + type: + description: '' + - name: load(propertyNames) + uid: word!Word.ListTemplateGalleryCollection#load:member(1) + package: word! + 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: true + isDeprecated: false + syntax: + content: >- + load(propertyNames?: string | string[]): + Word.ListTemplateGalleryCollection; + 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: word!Word.ListTemplateGalleryCollection#load:member(2) + package: word! + 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: true + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Word.ListTemplateGalleryCollection; + 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: word!Word.ListTemplateGalleryCollection#toJSON:member(1) + package: word! + 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 + `Word.ListTemplateGalleryCollection` object is an API object, the `toJSON` + method returns a plain JavaScript object (typed as + `Word.Interfaces.ListTemplateGalleryCollectionData`) that contains + an "items" array with shallow copies of any loaded properties from the + collection's items. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'toJSON(): Word.Interfaces.ListTemplateGalleryCollectionData;' + return: + type: >- + + description: '' + - name: track() + uid: word!Word.ListTemplateGalleryCollection#track:member(1) + package: word! + fullName: track() + summary: >- + Track the object for automatic adjustment based on surrounding changes in + the document. This call is a shorthand for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). If you're using this object across `.sync` calls and outside the + sequential execution of a ".run" batch, and get an "InvalidObjectPath" + error when setting a property or invoking a method on the object, you need + to add the object to the tracked object collection when the object was + first created. If this object is part of a collection, you should also + track the parent collection. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'track(): Word.ListTemplateGalleryCollection;' + return: + type: + description: '' + - name: untrack() + uid: word!Word.ListTemplateGalleryCollection#untrack:member(1) + package: word! + fullName: untrack() + summary: >- + Release the memory associated with this object, if it has previously been + tracked. This call is shorthand for + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). Having many tracked objects slows down the host application, so + please remember to free any objects you add, once you're done using them. + You'll need to call `context.sync()` before the memory release takes + effect. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'untrack(): Word.ListTemplateGalleryCollection;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/word/word/word.listtemplategallerytype.yml b/docs/docs-ref-autogen/word/word/word.listtemplategallerytype.yml new file mode 100644 index 0000000000..da9cc01daa --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.listtemplategallerytype.yml @@ -0,0 +1,43 @@ +### YamlMime:TSEnum +name: Word.ListTemplateGalleryType +uid: word!Word.ListTemplateGalleryType:enum +package: word! +fullName: Word.ListTemplateGalleryType +summary: Describes the types of list template galleries available. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: bullets + uid: word!Word.ListTemplateGalleryType.bullets:member + package: word! + summary: >- + Represents the bullet list gallery. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Bullets"' + - name: number + uid: word!Word.ListTemplateGalleryType.number:member + package: word! + summary: >- + Represents the number list gallery. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Number"' + - name: outlineNumbered + uid: word!Word.ListTemplateGalleryType.outlineNumbered:member + package: word! + summary: >- + Represents the outline number list gallery. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"OutlineNumbered"' diff --git a/docs/docs-ref-autogen/word/word/word.movementtype.yml b/docs/docs-ref-autogen/word/word/word.movementtype.yml new file mode 100644 index 0000000000..a41dcf4c89 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.movementtype.yml @@ -0,0 +1,33 @@ +### YamlMime:TSEnum +name: Word.MovementType +uid: word!Word.MovementType:enum +package: word! +fullName: Word.MovementType +summary: Specifies the type of movement when navigating through a document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: extend + uid: word!Word.MovementType.extend:member + package: word! + summary: >- + Extends the selection. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Extend"' + - name: move + uid: word!Word.MovementType.move:member + package: word! + summary: >- + Moves the insertion point or selection. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Move"' diff --git a/docs/docs-ref-autogen/word/word/word.notenumberstyle.yml b/docs/docs-ref-autogen/word/word/word.notenumberstyle.yml new file mode 100644 index 0000000000..56de949d41 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.notenumberstyle.yml @@ -0,0 +1,303 @@ +### YamlMime:TSEnum +name: Word.NoteNumberStyle +uid: word!Word.NoteNumberStyle:enum +package: word! +fullName: Word.NoteNumberStyle +summary: Specifies the numbering style to use for footnotes or endnotes. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: arabic + uid: word!Word.NoteNumberStyle.arabic:member + package: word! + summary: >- + Uses Arabic numerals (1, 2, 3...). + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Arabic"' + - name: arabicFullWidth + uid: word!Word.NoteNumberStyle.arabicFullWidth:member + package: word! + summary: >- + Uses full-width Arabic numerals. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"ArabicFullWidth"' + - name: arabicLetter1 + uid: word!Word.NoteNumberStyle.arabicLetter1:member + package: word! + summary: >- + Uses Arabic letters (style 1). + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"ArabicLetter1"' + - name: arabicLetter2 + uid: word!Word.NoteNumberStyle.arabicLetter2:member + package: word! + summary: >- + Uses Arabic letters (style 2). + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"ArabicLetter2"' + - name: hanjaRead + uid: word!Word.NoteNumberStyle.hanjaRead:member + package: word! + summary: >- + Uses Hanja characters with phonetic reading. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"HanjaRead"' + - name: hanjaReadDigit + uid: word!Word.NoteNumberStyle.hanjaReadDigit:member + package: word! + summary: >- + Uses Hanja digits with phonetic reading. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"HanjaReadDigit"' + - name: hebrewLetter1 + uid: word!Word.NoteNumberStyle.hebrewLetter1:member + package: word! + summary: >- + Uses Hebrew letters (style 1). + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"HebrewLetter1"' + - name: hebrewLetter2 + uid: word!Word.NoteNumberStyle.hebrewLetter2:member + package: word! + summary: >- + Uses Hebrew letters (style 2). + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"HebrewLetter2"' + - name: hindiArabic + uid: word!Word.NoteNumberStyle.hindiArabic:member + package: word! + summary: >- + Uses Hindi Arabic numerals. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"HindiArabic"' + - name: hindiCardinalText + uid: word!Word.NoteNumberStyle.hindiCardinalText:member + package: word! + summary: >- + Uses Hindi cardinal text. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"HindiCardinalText"' + - name: hindiLetter1 + uid: word!Word.NoteNumberStyle.hindiLetter1:member + package: word! + summary: >- + Uses Hindi letters (style 1). + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"HindiLetter1"' + - name: hindiLetter2 + uid: word!Word.NoteNumberStyle.hindiLetter2:member + package: word! + summary: >- + Uses Hindi letters (style 2). + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"HindiLetter2"' + - name: kanji + uid: word!Word.NoteNumberStyle.kanji:member + package: word! + summary: >- + Uses Kanji characters. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Kanji"' + - name: kanjiDigit + uid: word!Word.NoteNumberStyle.kanjiDigit:member + package: word! + summary: >- + Uses Kanji digits. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"KanjiDigit"' + - name: kanjiTraditional + uid: word!Word.NoteNumberStyle.kanjiTraditional:member + package: word! + summary: >- + Uses traditional Kanji characters. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"KanjiTraditional"' + - name: lowercaseLetter + uid: word!Word.NoteNumberStyle.lowercaseLetter:member + package: word! + summary: >- + Uses lowercase letters (a, b, c...). + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"LowercaseLetter"' + - name: lowercaseRoman + uid: word!Word.NoteNumberStyle.lowercaseRoman:member + package: word! + summary: >- + Uses lowercase Roman numerals (i, ii, iii...). + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"LowercaseRoman"' + - name: numberInCircle + uid: word!Word.NoteNumberStyle.numberInCircle:member + package: word! + summary: >- + Uses numbers enclosed in circles. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"NumberInCircle"' + - name: simplifiedChineseNumeral1 + uid: word!Word.NoteNumberStyle.simplifiedChineseNumeral1:member + package: word! + summary: >- + Uses simplified Chinese numerals (style 1). + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"simplifiedChineseNumeral1"' + - name: simplifiedChineseNumeral2 + uid: word!Word.NoteNumberStyle.simplifiedChineseNumeral2:member + package: word! + summary: >- + Uses simplified Chinese numerals (style 2). + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"simplifiedChineseNumeral2"' + - name: symbol + uid: word!Word.NoteNumberStyle.symbol:member + package: word! + summary: >- + Uses a symbol instead of a number. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Symbol"' + - name: thaiArabic + uid: word!Word.NoteNumberStyle.thaiArabic:member + package: word! + summary: >- + Uses Thai Arabic numerals. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"ThaiArabic"' + - name: thaiCardinalText + uid: word!Word.NoteNumberStyle.thaiCardinalText:member + package: word! + summary: >- + Uses Thai cardinal text. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"ThaiCardinalText"' + - name: thaiLetter + uid: word!Word.NoteNumberStyle.thaiLetter:member + package: word! + summary: >- + Uses Thai letters. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"ThaiLetter"' + - name: traditionalChineseNumeral1 + uid: word!Word.NoteNumberStyle.traditionalChineseNumeral1:member + package: word! + summary: >- + Uses traditional Chinese numerals (style 1). + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"traditionalChineseNumeral1"' + - name: traditionalChineseNumeral2 + uid: word!Word.NoteNumberStyle.traditionalChineseNumeral2:member + package: word! + summary: >- + Uses traditional Chinese numerals (style 2). + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"traditionalChineseNumeral2"' + - name: uppercaseLetter + uid: word!Word.NoteNumberStyle.uppercaseLetter:member + package: word! + summary: >- + Uses uppercase letters (A, B, C...). + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"UppercaseLetter"' + - name: uppercaseRoman + uid: word!Word.NoteNumberStyle.uppercaseRoman:member + package: word! + summary: >- + Uses uppercase Roman numerals (I, II, III...). + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"UppercaseRoman"' + - name: vietnameseCardinalText + uid: word!Word.NoteNumberStyle.vietnameseCardinalText:member + package: word! + summary: >- + Uses Vietnamese cardinal text. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"vietnameseCardinalText"' diff --git a/docs/docs-ref-autogen/word/word/word.operationunit.yml b/docs/docs-ref-autogen/word/word/word.operationunit.yml new file mode 100644 index 0000000000..2103b55d75 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.operationunit.yml @@ -0,0 +1,173 @@ +### YamlMime:TSEnum +name: Word.OperationUnit +uid: word!Word.OperationUnit:enum +package: word! +fullName: Word.OperationUnit +summary: Specifies the unit of measurement used in Word operations. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: cell + uid: word!Word.OperationUnit.cell:member + package: word! + summary: >- + Specifies a cell unit. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Cell"' + - name: character + uid: word!Word.OperationUnit.character:member + package: word! + summary: >- + Specifies a character unit. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Character"' + - name: characterFormat + uid: word!Word.OperationUnit.characterFormat:member + package: word! + summary: >- + Specifies a character format unit. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"CharacterFormat"' + - name: column + uid: word!Word.OperationUnit.column:member + package: word! + summary: >- + Specifies a column unit. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Column"' + - name: item + uid: word!Word.OperationUnit.item:member + package: word! + summary: >- + Specifies an item unit. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Item"' + - name: line + uid: word!Word.OperationUnit.line:member + package: word! + summary: >- + Specifies a line unit. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Line"' + - name: paragraph + uid: word!Word.OperationUnit.paragraph:member + package: word! + summary: >- + Specifies a paragraph unit. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Paragraph"' + - name: paragraphFormat + uid: word!Word.OperationUnit.paragraphFormat:member + package: word! + summary: >- + Specifies a paragraph format unit. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"ParagraphFormat"' + - name: row + uid: word!Word.OperationUnit.row:member + package: word! + summary: >- + Specifies a row unit. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Row"' + - name: screen + uid: word!Word.OperationUnit.screen:member + package: word! + summary: >- + Specifies a screen unit. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Screen"' + - name: section + uid: word!Word.OperationUnit.section:member + package: word! + summary: >- + Specifies a section unit. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Section"' + - name: sentence + uid: word!Word.OperationUnit.sentence:member + package: word! + summary: >- + Specifies a sentence unit. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Sentence"' + - name: story + uid: word!Word.OperationUnit.story:member + package: word! + summary: >- + Specifies a story unit. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Story"' + - name: table + uid: word!Word.OperationUnit.table:member + package: word! + summary: >- + Specifies a table unit. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Table"' + - name: window + uid: word!Word.OperationUnit.window:member + package: word! + summary: >- + Specifies a window unit. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Window"' + - name: word + uid: word!Word.OperationUnit.word:member + package: word! + summary: >- + Specifies a word unit. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Word"' diff --git a/docs/docs-ref-autogen/word/word/word.pane.yml b/docs/docs-ref-autogen/word/word/word.pane.yml index eb1bb7a62a..6da00c828b 100644 --- a/docs/docs-ref-autogen/word/word/word.pane.yml +++ b/docs/docs-ref-autogen/word/word/word.pane.yml @@ -224,6 +224,23 @@ properties: content: 'readonly pagesEnclosingViewport: Word.PageCollection;' return: type: + - name: selection + uid: word!Word.Pane#selection:member + package: word! + fullName: selection + summary: >- + Returns a `Selection` object that represents the current selection in the + pane. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly selection: Word.Selection;' + return: + type: methods: - name: getNext() uid: word!Word.Pane#getNext:member(1) @@ -264,9 +281,29 @@ methods: return: type: description: '' - - name: load(propertyNames) + - name: load(options) uid: word!Word.Pane#load:member(1) package: word! + 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?: Word.Interfaces.PaneLoadOptions): Word.Pane;' + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: + return: + type: + description: '' + - name: load(propertyNames) + uid: word!Word.Pane#load:member(2) + package: word! fullName: load(propertyNames) summary: >- Queues up a command to load the specified properties of the object. You @@ -287,7 +324,7 @@ methods: type: description: '' - name: load(propertyNamesAndPaths) - uid: word!Word.Pane#load:member(2) + uid: word!Word.Pane#load:member(3) package: word! fullName: load(propertyNamesAndPaths) summary: >- diff --git a/docs/docs-ref-autogen/word/word/word.panecollection.yml b/docs/docs-ref-autogen/word/word/word.panecollection.yml index a7f960cd96..e1d56f75f6 100644 --- a/docs/docs-ref-autogen/word/word/word.panecollection.yml +++ b/docs/docs-ref-autogen/word/word/word.panecollection.yml @@ -80,9 +80,34 @@ methods: return: type: description: '' - - name: load(propertyNames) + - name: load(options) uid: word!Word.PaneCollection#load:member(1) package: word! + 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?: Word.Interfaces.PaneCollectionLoadOptions & + Word.Interfaces.CollectionLoadOptions): Word.PaneCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: word!Word.PaneCollection#load:member(2) + package: word! fullName: load(propertyNames) summary: >- Queues up a command to load the specified properties of the object. You @@ -103,7 +128,7 @@ methods: type: description: '' - name: load(propertyNamesAndPaths) - uid: word!Word.PaneCollection#load:member(2) + uid: word!Word.PaneCollection#load:member(3) package: word! fullName: load(propertyNamesAndPaths) summary: >- diff --git a/docs/docs-ref-autogen/word/word/word.paragraph.yml b/docs/docs-ref-autogen/word/word/word.paragraph.yml index 8a0b270f8c..39be5c651c 100644 --- a/docs/docs-ref-autogen/word/word/word.paragraph.yml +++ b/docs/docs-ref-autogen/word/word/word.paragraph.yml @@ -607,23 +607,6 @@ properties: content: 'readonly parentTableOrNullObject: Word.Table;' return: type: - - name: range - uid: word!Word.Paragraph#range:member - package: word! - fullName: range - summary: >- - Gets a `Range` object that represents the portion of the document that's - contained within the paragraph. - remarks: >- - \[ [API set: WordApi BETA (PREVIEW - ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] - - isPreview: true - isDeprecated: false - syntax: - content: 'readonly range: Word.Range;' - return: - type: - name: rightIndent uid: word!Word.Paragraph#rightIndent:member package: word! diff --git a/docs/docs-ref-autogen/word/word/word.pastedatatype.yml b/docs/docs-ref-autogen/word/word/word.pastedatatype.yml new file mode 100644 index 0000000000..cb5c2171b5 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.pastedatatype.yml @@ -0,0 +1,113 @@ +### YamlMime:TSEnum +name: Word.PasteDataType +uid: word!Word.PasteDataType:enum +package: word! +fullName: Word.PasteDataType +summary: Specifies the format to use when pasting data. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: bitmap + uid: word!Word.PasteDataType.bitmap:member + package: word! + summary: >- + Pastes the data as a bitmap. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Bitmap"' + - name: deviceIndependentBitmap + uid: word!Word.PasteDataType.deviceIndependentBitmap:member + package: word! + summary: >- + Pastes the data as a device-independent bitmap (DIB). + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"DeviceIndependentBitmap"' + - name: enhancedMetafile + uid: word!Word.PasteDataType.enhancedMetafile:member + package: word! + summary: >- + Pastes the data as an enhanced metafile. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"EnhancedMetafile"' + - name: html + uid: word!Word.PasteDataType.html:member + package: word! + summary: >- + Pastes the data as HTML. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Html"' + - name: hyperlink + uid: word!Word.PasteDataType.hyperlink:member + package: word! + summary: >- + Pastes the data as a hyperlink. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Hyperlink"' + - name: metafilePicture + uid: word!Word.PasteDataType.metafilePicture:member + package: word! + summary: >- + Pastes the data as a metafile picture. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"MetafilePicture"' + - name: oleObject + uid: word!Word.PasteDataType.oleObject:member + package: word! + summary: >- + Pastes the data as an OLE object. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"OleObject"' + - name: rtf + uid: word!Word.PasteDataType.rtf:member + package: word! + summary: >- + Pastes the data as rich text format (RTF). + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Rtf"' + - name: shape + uid: word!Word.PasteDataType.shape:member + package: word! + summary: >- + Pastes the data as a shape. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Shape"' + - name: text + uid: word!Word.PasteDataType.text:member + package: word! + summary: >- + Pastes the data as plain text. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Text"' diff --git a/docs/docs-ref-autogen/word/word/word.pasteformattype.yml b/docs/docs-ref-autogen/word/word/word.pasteformattype.yml new file mode 100644 index 0000000000..00426b4803 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.pasteformattype.yml @@ -0,0 +1,193 @@ +### YamlMime:TSEnum +name: Word.PasteFormatType +uid: word!Word.PasteFormatType:enum +package: word! +fullName: Word.PasteFormatType +summary: Specifies the type of formatting when paste to a document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: chart + uid: word!Word.PasteFormatType.chart:member + package: word! + summary: >- + Pastes a chart as an editable chart. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Chart"' + - name: chartLinked + uid: word!Word.PasteFormatType.chartLinked:member + package: word! + summary: >- + Pastes a chart with a link to the source data. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"ChartLinked"' + - name: chartPicture + uid: word!Word.PasteFormatType.chartPicture:member + package: word! + summary: >- + Pastes a chart as a picture. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"ChartPicture"' + - name: formatOriginalFormatting + uid: word!Word.PasteFormatType.formatOriginalFormatting:member + package: word! + summary: >- + Applies the original formatting of the pasted content. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"FormatOriginalFormatting"' + - name: formatPlainText + uid: word!Word.PasteFormatType.formatPlainText:member + package: word! + summary: >- + Pastes content as plain text. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"FormatPlainText"' + - name: formatSurroundingFormattingWithEmphasis + uid: word!Word.PasteFormatType.formatSurroundingFormattingWithEmphasis:member + package: word! + summary: >- + Applies surrounding formatting with emphasis. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"FormatSurroundingFormattingWithEmphasis"' + - name: listCombineWithExistingList + uid: word!Word.PasteFormatType.listCombineWithExistingList:member + package: word! + summary: >- + Combines the pasted list with an existing list. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"ListCombineWithExistingList"' + - name: listContinueNumbering + uid: word!Word.PasteFormatType.listContinueNumbering:member + package: word! + summary: >- + Continues numbering from the previous list. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"ListContinueNumbering"' + - name: listDontMerge + uid: word!Word.PasteFormatType.listDontMerge:member + package: word! + summary: >- + Prevents merging the pasted list with an existing list. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"ListDontMerge"' + - name: listRestartNumbering + uid: word!Word.PasteFormatType.listRestartNumbering:member + package: word! + summary: >- + Restarts numbering for the new list. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"ListRestartNumbering"' + - name: pasteDefault + uid: word!Word.PasteFormatType.pasteDefault:member + package: word! + summary: >- + Uses the default paste behavior. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"PasteDefault"' + - name: singleCellTable + uid: word!Word.PasteFormatType.singleCellTable:member + package: word! + summary: >- + Pastes a table into a single cell. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"SingleCellTable"' + - name: singleCellText + uid: word!Word.PasteFormatType.singleCellText:member + package: word! + summary: >- + Pastes text into a single cell. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"SingleCellText"' + - name: tableAppendTable + uid: word!Word.PasteFormatType.tableAppendTable:member + package: word! + summary: >- + Appends the pasted table to the existing table. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"TableAppendTable"' + - name: tableInsertAsRows + uid: word!Word.PasteFormatType.tableInsertAsRows:member + package: word! + summary: >- + Inserts the pasted table as new rows. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"TableInsertAsRows"' + - name: tableOriginalFormatting + uid: word!Word.PasteFormatType.tableOriginalFormatting:member + package: word! + summary: >- + Inserts the pasted table with its original formatting. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"TableOriginalFormatting"' + - name: tableOverwriteCells + uid: word!Word.PasteFormatType.tableOverwriteCells:member + package: word! + summary: >- + Overwrites existing cells with the pasted table. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"TableOverwriteCells"' + - name: useDestinationStylesRecovery + uid: word!Word.PasteFormatType.useDestinationStylesRecovery:member + package: word! + summary: >- + Uses the destination styles for the pasted content. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"UseDestinationStylesRecovery"' diff --git a/docs/docs-ref-autogen/word/word/word.range.yml b/docs/docs-ref-autogen/word/word/word.range.yml index 6bb0542de7..ac88cff86c 100644 --- a/docs/docs-ref-autogen/word/word/word.range.yml +++ b/docs/docs-ref-autogen/word/word/word.range.yml @@ -162,6 +162,23 @@ properties: content: 'combineCharacters: boolean;' return: type: boolean + - name: conflicts + uid: word!Word.Range#conflicts:member + package: word! + fullName: conflicts + summary: >- + Returns a `ConflictCollection` object that contains all the + [Word.Conflict](xref:word!Word.Conflict:class) objects in the range. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly conflicts: Word.ConflictCollection;' + return: + type: - name: contentControls uid: word!Word.Range#contentControls:member package: word! @@ -209,6 +226,24 @@ properties: content: 'readonly disableCharacterSpaceGrid: boolean;' return: type: boolean + - name: editors + uid: word!Word.Range#editors:member + package: word! + fullName: editors + summary: >- + Returns an `EditorCollection` object that represents all the users + authorized to modify the range when the document is in protected + (read-only) mode. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly editors: Word.EditorCollection;' + return: + type: - name: emphasisMark uid: word!Word.Range#emphasisMark:member package: word! @@ -1203,6 +1238,24 @@ properties: content: 'readonly parentTableOrNullObject: Word.Table;' return: type: + - name: revisions + uid: word!Word.Range#revisions:member + package: word! + fullName: revisions + summary: >- + Gets the collection of revisions that represents the tracked changes in + the range. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly revisions: Word.RevisionCollection;' + return: + type: - name: sections uid: word!Word.Range#sections:member package: word! diff --git a/docs/docs-ref-autogen/word/word/word.rangescopedcollection.yml b/docs/docs-ref-autogen/word/word/word.rangescopedcollection.yml new file mode 100644 index 0000000000..0f5b03b774 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.rangescopedcollection.yml @@ -0,0 +1,209 @@ +### YamlMime:TSType +name: Word.RangeScopedCollection +uid: word!Word.RangeScopedCollection:class +package: word! +fullName: Word.RangeScopedCollection +summary: >- + Represents a collection of [Word.Range](xref:word!Word.Range:class) objects + that represents each character, word or sentence. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: class +properties: + - name: context + uid: word!Word.RangeScopedCollection#context:member + package: word! + 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: true + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: word!Word.RangeScopedCollection#items:member + package: word! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly items: Word.Range[];' + return: + type: [] +methods: + - name: getItem(index) + uid: word!Word.RangeScopedCollection#getItem:member(1) + package: word! + fullName: getItem(index) + summary: Gets a `Range` object by its index in the collection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'getItem(index: number): Word.Range;' + parameters: + - id: index + description: The location of a `Range` object in the collection. + type: number + return: + type: + description: '' + - name: load(options) + uid: word!Word.RangeScopedCollection#load:member(1) + package: word! + 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: true + isDeprecated: false + syntax: + content: >- + load(options?: Word.Interfaces.RangeScopedCollectionLoadOptions & + Word.Interfaces.CollectionLoadOptions): Word.RangeScopedCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: word!Word.RangeScopedCollection#load:member(2) + package: word! + 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: true + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Word.RangeScopedCollection;' + 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: word!Word.RangeScopedCollection#load:member(3) + package: word! + 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: true + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Word.RangeScopedCollection; + 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: word!Word.RangeScopedCollection#toJSON:member(1) + package: word! + 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 + `Word.RangeScopedCollection` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Word.Interfaces.RangeScopedCollectionData`) that contains an + "items" array with shallow copies of any loaded properties from the + collection's items. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'toJSON(): Word.Interfaces.RangeScopedCollectionData;' + return: + type: >- + + description: '' + - name: track() + uid: word!Word.RangeScopedCollection#track:member(1) + package: word! + fullName: track() + summary: >- + Track the object for automatic adjustment based on surrounding changes in + the document. This call is a shorthand for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). If you're using this object across `.sync` calls and outside the + sequential execution of a ".run" batch, and get an "InvalidObjectPath" + error when setting a property or invoking a method on the object, you need + to add the object to the tracked object collection when the object was + first created. If this object is part of a collection, you should also + track the parent collection. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'track(): Word.RangeScopedCollection;' + return: + type: + description: '' + - name: untrack() + uid: word!Word.RangeScopedCollection#untrack:member(1) + package: word! + fullName: untrack() + summary: >- + Release the memory associated with this object, if it has previously been + tracked. This call is shorthand for + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). Having many tracked objects slows down the host application, so + please remember to free any objects you add, once you're done using them. + You'll need to call `context.sync()` before the memory release takes + effect. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'untrack(): Word.RangeScopedCollection;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/word/word/word.referencekind.yml b/docs/docs-ref-autogen/word/word/word.referencekind.yml new file mode 100644 index 0000000000..3320855841 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.referencekind.yml @@ -0,0 +1,143 @@ +### YamlMime:TSEnum +name: Word.ReferenceKind +uid: word!Word.ReferenceKind:enum +package: word! +fullName: Word.ReferenceKind +summary: Specifies the kind of reference to insert. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: contentText + uid: word!Word.ReferenceKind.contentText:member + package: word! + summary: >- + Inserts the full text of the referenced item. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"ContentText"' + - name: endnoteNumber + uid: word!Word.ReferenceKind.endnoteNumber:member + package: word! + summary: >- + Inserts the endnote number of the referenced item. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"EndnoteNumber"' + - name: endnoteNumberFormatted + uid: word!Word.ReferenceKind.endnoteNumberFormatted:member + package: word! + summary: >- + Inserts the formatted endnote number of the referenced item. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"EndnoteNumberFormatted"' + - name: entireCaption + uid: word!Word.ReferenceKind.entireCaption:member + package: word! + summary: >- + Inserts the entire caption of the referenced item. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"EntireCaption"' + - name: footnoteNumber + uid: word!Word.ReferenceKind.footnoteNumber:member + package: word! + summary: >- + Inserts the footnote number of the referenced item. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"FootnoteNumber"' + - name: footnoteNumberFormatted + uid: word!Word.ReferenceKind.footnoteNumberFormatted:member + package: word! + summary: >- + Inserts the formatted footnote number of the referenced item. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"FootnoteNumberFormatted"' + - name: numberFullContext + uid: word!Word.ReferenceKind.numberFullContext:member + package: word! + summary: >- + Inserts the number of the referenced item with full context. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"NumberFullContext"' + - name: numberNoContext + uid: word!Word.ReferenceKind.numberNoContext:member + package: word! + summary: >- + Inserts only the number of the referenced item without context. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"NumberNoContext"' + - name: numberRelativeContext + uid: word!Word.ReferenceKind.numberRelativeContext:member + package: word! + summary: >- + Inserts the number of the referenced item with relative context. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"NumberRelativeContext"' + - name: onlyCaptionText + uid: word!Word.ReferenceKind.onlyCaptionText:member + package: word! + summary: >- + Inserts only the caption text of the referenced item. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"OnlyCaptionText"' + - name: onlyLabelAndNumber + uid: word!Word.ReferenceKind.onlyLabelAndNumber:member + package: word! + summary: >- + Inserts only the label and number of the referenced item. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"OnlyLabelAndNumber"' + - name: pageNumber + uid: word!Word.ReferenceKind.pageNumber:member + package: word! + summary: >- + Inserts the page number of the referenced item. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"PageNumber"' + - name: position + uid: word!Word.ReferenceKind.position:member + package: word! + summary: >- + Inserts the position of the referenced item. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Position"' diff --git a/docs/docs-ref-autogen/word/word/word.referencetype.yml b/docs/docs-ref-autogen/word/word/word.referencetype.yml new file mode 100644 index 0000000000..cd57ccbad7 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.referencetype.yml @@ -0,0 +1,63 @@ +### YamlMime:TSEnum +name: Word.ReferenceType +uid: word!Word.ReferenceType:enum +package: word! +fullName: Word.ReferenceType +summary: Specifies the type of reference to insert. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: bookmark + uid: word!Word.ReferenceType.bookmark:member + package: word! + summary: >- + Refers to a bookmark in the document. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Bookmark"' + - name: endnote + uid: word!Word.ReferenceType.endnote:member + package: word! + summary: >- + Refers to an endnote in the document. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Endnote"' + - name: footnote + uid: word!Word.ReferenceType.footnote:member + package: word! + summary: >- + Refers to a footnote in the document. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Footnote"' + - name: heading + uid: word!Word.ReferenceType.heading:member + package: word! + summary: >- + Refers to a heading in the document. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Heading"' + - name: numberedItem + uid: word!Word.ReferenceType.numberedItem:member + package: word! + summary: >- + Refers to a numbered item in the document. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"NumberedItem"' diff --git a/docs/docs-ref-autogen/word/word/word.revision.yml b/docs/docs-ref-autogen/word/word/word.revision.yml new file mode 100644 index 0000000000..e281a5cc8c --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.revision.yml @@ -0,0 +1,388 @@ +### YamlMime:TSType +name: Word.Revision +uid: word!Word.Revision:class +package: word! +fullName: Word.Revision +summary: Represents a single tracked change in a document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + +isPreview: true +isDeprecated: false +type: class +properties: + - name: author + uid: word!Word.Revision#author:member + package: word! + fullName: author + summary: Gets the name of the user who made the tracked change. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly author: string;' + return: + type: string + - name: context + uid: word!Word.Revision#context:member + package: word! + 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: true + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: date + uid: word!Word.Revision#date:member + package: word! + fullName: date + summary: Gets the date and time when the tracked change was made. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly date: Date;' + return: + type: Date + - name: formatDescription + uid: word!Word.Revision#formatDescription:member + package: word! + fullName: formatDescription + summary: Gets the description of tracked formatting changes in the revision. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly formatDescription: string;' + return: + type: string + - name: index + uid: word!Word.Revision#index:member + package: word! + fullName: index + summary: Gets a number that represents the position of this item in a collection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly index: number;' + return: + type: number + - name: movedRange + uid: word!Word.Revision#movedRange:member + package: word! + fullName: movedRange + summary: >- + Gets a `Range` object that represents the range of text that was moved + from one place to another in the document with tracked changes. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly movedRange: Word.Range;' + return: + type: + - name: range + uid: word!Word.Revision#range:member + package: word! + fullName: range + summary: >- + Gets a `Range` object that represents the portion of the document that's + contained within a revision mark. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly range: Word.Range;' + return: + type: + - name: type + uid: word!Word.Revision#type:member + package: word! + fullName: type + summary: Gets the revision type. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + readonly type: Word.RevisionType | "None" | "Insert" | "Delete" | + "Property" | "ParagraphNumber" | "DisplayField" | "Reconcile" | + "Conflict" | "Style" | "Replace" | "ParagraphProperty" | "TableProperty" + | "SectionProperty" | "StyleDefinition" | "MovedFrom" | "MovedTo" | + "CellInsertion" | "CellDeletion" | "CellMerge" | "CellSplit" | + "ConflictInsert" | "ConflictDelete"; + return: + type: >- + | "None" | "Insert" | + "Delete" | "Property" | "ParagraphNumber" | "DisplayField" | + "Reconcile" | "Conflict" | "Style" | "Replace" | "ParagraphProperty" | + "TableProperty" | "SectionProperty" | "StyleDefinition" | "MovedFrom" + | "MovedTo" | "CellInsertion" | "CellDeletion" | "CellMerge" | + "CellSplit" | "ConflictInsert" | "ConflictDelete" +methods: + - name: accept() + uid: word!Word.Revision#accept:member(1) + package: word! + fullName: accept() + summary: >- + Accepts the tracked change, removes the revision mark, and incorporates + the change into the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'accept(): void;' + return: + type: void + description: '' + - name: load(options) + uid: word!Word.Revision#load:member(1) + package: word! + 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: true + isDeprecated: false + syntax: + content: 'load(options?: Word.Interfaces.RevisionLoadOptions): Word.Revision;' + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: + return: + type: + description: '' + - name: load(propertyNames) + uid: word!Word.Revision#load:member(2) + package: word! + 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: true + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Word.Revision;' + 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: word!Word.Revision#load:member(3) + package: word! + 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: true + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Revision; + 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: reject() + uid: word!Word.Revision#reject:member(1) + package: word! + fullName: reject() + summary: >- + Rejects the tracked change. The revision marks are removed, leaving the + original text intact. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'reject(): void;' + return: + type: void + description: '' + - name: set(properties, options) + uid: word!Word.Revision#set:member(1) + package: word! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.RevisionUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: word!Word.Revision#set:member(2) + package: word! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'set(properties: Word.Revision): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: word!Word.Revision#toJSON:member(1) + package: word! + 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 `Word.Revision` object + is an API object, the `toJSON` method returns a plain JavaScript object + (typed as `Word.Interfaces.RevisionData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'toJSON(): Word.Interfaces.RevisionData;' + return: + type: + description: '' + - name: track() + uid: word!Word.Revision#track:member(1) + package: word! + fullName: track() + summary: >- + Track the object for automatic adjustment based on surrounding changes in + the document. This call is a shorthand for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). If you're using this object across `.sync` calls and outside the + sequential execution of a ".run" batch, and get an "InvalidObjectPath" + error when setting a property or invoking a method on the object, you need + to add the object to the tracked object collection when the object was + first created. If this object is part of a collection, you should also + track the parent collection. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'track(): Word.Revision;' + return: + type: + description: '' + - name: untrack() + uid: word!Word.Revision#untrack:member(1) + package: word! + fullName: untrack() + summary: >- + Release the memory associated with this object, if it has previously been + tracked. This call is shorthand for + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). Having many tracked objects slows down the host application, so + please remember to free any objects you add, once you're done using them. + You'll need to call `context.sync()` before the memory release takes + effect. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'untrack(): Word.Revision;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/word/word/word.revisioncollection.yml b/docs/docs-ref-autogen/word/word/word.revisioncollection.yml new file mode 100644 index 0000000000..35559b0ef9 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.revisioncollection.yml @@ -0,0 +1,247 @@ +### YamlMime:TSType +name: Word.RevisionCollection +uid: word!Word.RevisionCollection:class +package: word! +fullName: Word.RevisionCollection +summary: >- + A collection of Revision objects that represent the changes marked with + revision marks in a range or document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + +isPreview: true +isDeprecated: false +type: class +properties: + - name: context + uid: word!Word.RevisionCollection#context:member + package: word! + 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: true + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: word!Word.RevisionCollection#items:member + package: word! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly items: Word.Revision[];' + return: + type: [] +methods: + - name: acceptAll() + uid: word!Word.RevisionCollection#acceptAll:member(1) + package: word! + fullName: acceptAll() + summary: >- + Accepts all the tracked changes in the document or range, removes all + revision marks, and incorporates the changes into the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'acceptAll(): void;' + return: + type: void + description: '' + - name: getItem(index) + uid: word!Word.RevisionCollection#getItem:member(1) + package: word! + fullName: getItem(index) + summary: >- + Returns a `Revision` object that represents the specified item in the + collection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'getItem(index: number): Word.Revision;' + parameters: + - id: index + description: The index of the item to retrieve. + type: number + return: + type: + description: '' + - name: load(options) + uid: word!Word.RevisionCollection#load:member(1) + package: word! + 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: true + isDeprecated: false + syntax: + content: >- + load(options?: Word.Interfaces.RevisionCollectionLoadOptions & + Word.Interfaces.CollectionLoadOptions): Word.RevisionCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: word!Word.RevisionCollection#load:member(2) + package: word! + 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: true + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Word.RevisionCollection;' + 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: word!Word.RevisionCollection#load:member(3) + package: word! + 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: true + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Word.RevisionCollection; + 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: rejectAll() + uid: word!Word.RevisionCollection#rejectAll:member(1) + package: word! + fullName: rejectAll() + summary: Rejects all the tracked changes in the document or range. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/office/dev/add-ins/reference/overview/visio-javascript-reference-overview) + \] + + isPreview: true + isDeprecated: false + syntax: + content: 'rejectAll(): void;' + return: + type: void + description: '' + - name: toJSON() + uid: word!Word.RevisionCollection#toJSON:member(1) + package: word! + 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 + `Word.RevisionCollection` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Word.Interfaces.RevisionCollectionData`) that contains an "items" + array with shallow copies of any loaded properties from the collection's + items. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'toJSON(): Word.Interfaces.RevisionCollectionData;' + return: + type: + description: '' + - name: track() + uid: word!Word.RevisionCollection#track:member(1) + package: word! + fullName: track() + summary: >- + Track the object for automatic adjustment based on surrounding changes in + the document. This call is a shorthand for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). If you're using this object across `.sync` calls and outside the + sequential execution of a ".run" batch, and get an "InvalidObjectPath" + error when setting a property or invoking a method on the object, you need + to add the object to the tracked object collection when the object was + first created. If this object is part of a collection, you should also + track the parent collection. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'track(): Word.RevisionCollection;' + return: + type: + description: '' + - name: untrack() + uid: word!Word.RevisionCollection#untrack:member(1) + package: word! + fullName: untrack() + summary: >- + Release the memory associated with this object, if it has previously been + tracked. This call is shorthand for + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). Having many tracked objects slows down the host application, so + please remember to free any objects you add, once you're done using them. + You'll need to call `context.sync()` before the memory release takes + effect. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'untrack(): Word.RevisionCollection;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/word/word/word.rowheightrule.yml b/docs/docs-ref-autogen/word/word/word.rowheightrule.yml new file mode 100644 index 0000000000..a00a63c1b3 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.rowheightrule.yml @@ -0,0 +1,43 @@ +### YamlMime:TSEnum +name: Word.RowHeightRule +uid: word!Word.RowHeightRule:enum +package: word! +fullName: Word.RowHeightRule +summary: Specifies the rule for determining the height of the specified cells or rows. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: atLeast + uid: word!Word.RowHeightRule.atLeast:member + package: word! + summary: >- + The row height is set to a minimum value. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"AtLeast"' + - name: auto + uid: word!Word.RowHeightRule.auto:member + package: word! + summary: >- + The row height is adjusted to accommodate the tallest value in the row. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Auto"' + - name: exactly + uid: word!Word.RowHeightRule.exactly:member + package: word! + summary: >- + The row height is set to an exact value. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Exactly"' diff --git a/docs/docs-ref-autogen/word/word/word.selection.yml b/docs/docs-ref-autogen/word/word/word.selection.yml new file mode 100644 index 0000000000..ee16e6a422 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.selection.yml @@ -0,0 +1,2892 @@ +### YamlMime:TSType +name: Word.Selection +uid: word!Word.Selection:class +package: word! +fullName: Word.Selection +summary: >- + Represents a selected range or the insertion point in a Word document. + + + - Note: [Range](xref:word!Word.Range:class) objects share many of the same + methods and properties as `Selection` objects. Using `Range` objects is + preferable for manipulating a document when there isn't a reason to physically + change the current selection. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: class +properties: + - name: borders + uid: word!Word.Selection#borders:member + package: word! + fullName: borders + summary: >- + Returns a `BorderUniversalCollection` object that represents all the + borders for the objects in the selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly borders: Word.BorderUniversalCollection;' + return: + type: + - name: characters + uid: word!Word.Selection#characters:member + package: word! + fullName: characters + summary: >- + Returns a `RangeScopedCollection` object that represents each character in + the selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly characters: Word.RangeScopedCollection;' + return: + type: + - name: comments + uid: word!Word.Selection#comments:member + package: word! + fullName: comments + summary: >- + Returns a `CommentCollection` object that represents all the comments in + the selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly comments: Word.CommentCollection;' + return: + type: + - name: context + uid: word!Word.Selection#context:member + package: word! + 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: true + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: end + uid: word!Word.Selection#end:member + package: word! + fullName: end + summary: Specifies the ending character position of the selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'end: number;' + return: + type: number + - name: fields + uid: word!Word.Selection#fields:member + package: word! + fullName: fields + summary: >- + Returns a `FieldCollection` object that represents all the fields in the + selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly fields: Word.FieldCollection;' + return: + type: + - name: fitTextWidth + uid: word!Word.Selection#fitTextWidth:member + package: word! + fullName: fitTextWidth + summary: Specifies the width in which Word fits the text in the current selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'fitTextWidth: number;' + return: + type: number + - name: font + uid: word!Word.Selection#font:member + package: word! + fullName: font + summary: >- + Returns the `Font` object that represents the character formatting of the + selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly font: Word.Font;' + return: + type: + - name: formattedText + uid: word!Word.Selection#formattedText:member + package: word! + fullName: formattedText + summary: >- + Specifies a `Range` object that includes the formatted text in the range + or selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'formattedText: Word.Range;' + return: + type: + - name: hasNoProofing + uid: word!Word.Selection#hasNoProofing:member + package: word! + fullName: hasNoProofing + summary: >- + Returns whether the spelling and grammar checker ignores the selected + text. If the selected text contains a mix of proofed and un-proofed + content, this API returns `null`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly hasNoProofing: boolean;' + return: + type: boolean + - name: isActive + uid: word!Word.Selection#isActive:member + package: word! + fullName: isActive + summary: Returns whether the selection in the specified window or pane is active. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly isActive: boolean;' + return: + type: boolean + - name: isColumnSelectModeActive + uid: word!Word.Selection#isColumnSelectModeActive:member + package: word! + fullName: isColumnSelectModeActive + summary: Specifies whether column selection mode is active. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isColumnSelectModeActive: boolean;' + return: + type: boolean + - name: isEndOfRowMark + uid: word!Word.Selection#isEndOfRowMark:member + package: word! + fullName: isEndOfRowMark + summary: Returns whether the selection is at the end-of-row mark in a table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly isEndOfRowMark: boolean;' + return: + type: boolean + - name: isExtendModeActive + uid: word!Word.Selection#isExtendModeActive:member + package: word! + fullName: isExtendModeActive + summary: Specifies whether Extend mode is active. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isExtendModeActive: boolean;' + return: + type: boolean + - name: isInsertionPointAtEndOfLine + uid: word!Word.Selection#isInsertionPointAtEndOfLine:member + package: word! + fullName: isInsertionPointAtEndOfLine + summary: Returns whether the insertion point is at the end of a line. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly isInsertionPointAtEndOfLine: boolean;' + return: + type: boolean + - name: isStartActive + uid: word!Word.Selection#isStartActive:member + package: word! + fullName: isStartActive + summary: Specifies whether the beginning of the selection is active. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isStartActive: boolean;' + return: + type: boolean + - name: languageDetected + uid: word!Word.Selection#languageDetected:member + package: word! + fullName: languageDetected + summary: Specifies whether Word has detected the language of the selected text. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'languageDetected: boolean;' + return: + type: boolean + - name: languageId + uid: word!Word.Selection#languageId:member + package: word! + fullName: languageId + summary: Returns the language for the selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + readonly languageId: Word.LanguageId | "Afrikaans" | "Albanian" | + "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" + | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | + "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | + "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | + "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | + "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | + "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | + "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" + | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | + "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | + "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | + "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | + "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" + | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | + "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | + "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | + "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" + | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" + | "Galician" | "Georgian" | "German" | "GermanAustria" | + "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | + "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | + "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" + | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | + "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | + "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | + "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | + "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | + "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | + "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | + "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | + "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | + "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | + "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | + "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | + "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | + "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | + "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | + "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" + | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | + "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" + | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | + "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | + "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | + "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | + "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | + "Yiddish" | "Yoruba" | "Zulu"; + return: + type: >- + | "Afrikaans" | "Albanian" | + "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | + "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | + "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | + "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | + "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | + "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" + | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | + "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | + "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | + "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | + "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | + "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | + "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | + "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" + | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | + "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | + "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | + "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | + "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" + | "Galician" | "Georgian" | "German" | "GermanAustria" | + "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | + "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | + "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | + "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" + | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | + "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | + "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | + "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | + "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | + "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | + "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | + "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | + "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | + "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | + "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | + "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | + "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | + "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | + "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | + "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | + "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | + "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" + | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" + | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | + "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | + "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | + "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | + "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | + "Zulu" + - name: languageIdFarEast + uid: word!Word.Selection#languageIdFarEast:member + package: word! + fullName: languageIdFarEast + summary: Returns the East Asian language for the selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + readonly languageIdFarEast: Word.LanguageId | "Afrikaans" | "Albanian" | + "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" + | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | + "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | + "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | + "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | + "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | + "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | + "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" + | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | + "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | + "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | + "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | + "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" + | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | + "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | + "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | + "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" + | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" + | "Galician" | "Georgian" | "German" | "GermanAustria" | + "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | + "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | + "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" + | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | + "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | + "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | + "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | + "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | + "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | + "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | + "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | + "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | + "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | + "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | + "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | + "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | + "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | + "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | + "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" + | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | + "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" + | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | + "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | + "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | + "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | + "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | + "Yiddish" | "Yoruba" | "Zulu"; + return: + type: >- + | "Afrikaans" | "Albanian" | + "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | + "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | + "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | + "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | + "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | + "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" + | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | + "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | + "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | + "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | + "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | + "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | + "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | + "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" + | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | + "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | + "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | + "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | + "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" + | "Galician" | "Georgian" | "German" | "GermanAustria" | + "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | + "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | + "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | + "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" + | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | + "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | + "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | + "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | + "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | + "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | + "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | + "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | + "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | + "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | + "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | + "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | + "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | + "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | + "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | + "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | + "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | + "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" + | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" + | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | + "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | + "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | + "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | + "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | + "Zulu" + - name: languageIdOther + uid: word!Word.Selection#languageIdOther:member + package: word! + fullName: languageIdOther + summary: >- + Returns the language for the selection that isn't classified as an East + Asian language. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + readonly languageIdOther: Word.LanguageId | "Afrikaans" | "Albanian" | + "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" + | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | + "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | + "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | + "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | + "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | + "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | + "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" + | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | + "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | + "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | + "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | + "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" + | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | + "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | + "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | + "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" + | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" + | "Galician" | "Georgian" | "German" | "GermanAustria" | + "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | + "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | + "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" + | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | + "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | + "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | + "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | + "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | + "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | + "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | + "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | + "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | + "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | + "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | + "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | + "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | + "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | + "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | + "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" + | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | + "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" + | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | + "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | + "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | + "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | + "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | + "Yiddish" | "Yoruba" | "Zulu"; + return: + type: >- + | "Afrikaans" | "Albanian" | + "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | + "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | + "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | + "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | + "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | + "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" + | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | + "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | + "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | + "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | + "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | + "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | + "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | + "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" + | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | + "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | + "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | + "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | + "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" + | "Galician" | "Georgian" | "German" | "GermanAustria" | + "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | + "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | + "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | + "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" + | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | + "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | + "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | + "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | + "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | + "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | + "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | + "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | + "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | + "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | + "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | + "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | + "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | + "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | + "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | + "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | + "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | + "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" + | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" + | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | + "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | + "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | + "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | + "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | + "Zulu" + - name: orientation + uid: word!Word.Selection#orientation:member + package: word! + fullName: orientation + summary: Specifies the orientation of text in the selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + orientation: Word.TextOrientation | "Horizontal" | "Upward" | "Downward" + | "VerticalFarEast" | "HorizontalRotatedFarEast" | "Vertical"; + return: + type: >- + | "Horizontal" | + "Upward" | "Downward" | "VerticalFarEast" | "HorizontalRotatedFarEast" + | "Vertical" + - name: paragraphs + uid: word!Word.Selection#paragraphs:member + package: word! + fullName: paragraphs + summary: >- + Returns a `ParagraphCollection` object that represents all the paragraphs + in the selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly paragraphs: Word.ParagraphCollection;' + return: + type: + - name: range + uid: word!Word.Selection#range:member + package: word! + fullName: range + summary: >- + Returns the `Range` object for the portion of the document contained in + the selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly range: Word.Range;' + return: + type: + - name: sections + uid: word!Word.Selection#sections:member + package: word! + fullName: sections + summary: Returns the `SectionCollection` object in the selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly sections: Word.SectionCollection;' + return: + type: + - name: sentences + uid: word!Word.Selection#sentences:member + package: word! + fullName: sentences + summary: >- + Returns the `RangeScopedCollection` object for each sentence in the + selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly sentences: Word.RangeScopedCollection;' + return: + type: + - name: shading + uid: word!Word.Selection#shading:member + package: word! + fullName: shading + summary: >- + Returns the `ShadingUniversal` object for the shading formatting for the + selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly shading: Word.ShadingUniversal;' + return: + type: + - name: start + uid: word!Word.Selection#start:member + package: word! + fullName: start + summary: Specifies the starting character position of the selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'start: number;' + return: + type: number + - name: storyLength + uid: word!Word.Selection#storyLength:member + package: word! + fullName: storyLength + summary: Returns the number of characters in the story that contains the selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly storyLength: number;' + return: + type: number + - name: storyType + uid: word!Word.Selection#storyType:member + package: word! + fullName: storyType + summary: Returns the story type for the selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + readonly storyType: Word.StoryType | "MainText" | "Footnotes" | + "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | + "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | + "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | + "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | + "EndnoteSeparator" | "EndnoteContinuationSeparator" | + "EndnoteContinuationNotice"; + return: + type: >- + | "MainText" | "Footnotes" | + "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | + "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | + "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | + "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | + "EndnoteSeparator" | "EndnoteContinuationSeparator" | + "EndnoteContinuationNotice" + - name: tables + uid: word!Word.Selection#tables:member + package: word! + fullName: tables + summary: Returns the `TableCollection` object in the selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly tables: Word.TableCollection;' + return: + type: + - name: text + uid: word!Word.Selection#text:member + package: word! + fullName: text + summary: Specifies the text in the selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'text: string;' + return: + type: string + - name: topLevelTables + uid: word!Word.Selection#topLevelTables:member + package: word! + fullName: topLevelTables + summary: >- + Returns the tables at the outermost nesting level in the current + selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly topLevelTables: Word.TableCollection;' + return: + type: + - name: type + uid: word!Word.Selection#type:member + package: word! + fullName: type + summary: Returns the selection type. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + readonly type: Word.SelectionType | "NoSelection" | "InsertionPoint" | + "Normal" | "Frame" | "Column" | "Row" | "Block" | "InlineShape" | + "SelectionShape"; + return: + type: >- + | "NoSelection" | + "InsertionPoint" | "Normal" | "Frame" | "Column" | "Row" | "Block" | + "InlineShape" | "SelectionShape" + - name: words + uid: word!Word.Selection#words:member + package: word! + fullName: words + summary: >- + Returns the `RangeScopedCollection` object that represents each word in + the selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly words: Word.RangeScopedCollection;' + return: + type: +methods: + - name: calculate() + uid: word!Word.Selection#calculate:member(1) + package: word! + fullName: calculate() + summary: Calculates the first mathematical expression within the selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'calculate(): OfficeExtension.ClientResult;' + return: + type: <number> + description: The result of the calculation. + - name: cancelMode() + uid: word!Word.Selection#cancelMode:member(1) + package: word! + fullName: cancelMode() + summary: >- + Cancels a mode such as extend or column select. This is equivalent to + pressing the Esc key. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'cancelMode(): void;' + return: + type: void + description: '' + - name: clearCharacterStyleFormatting() + uid: word!Word.Selection#clearCharacterStyleFormatting:member(1) + package: word! + fullName: clearCharacterStyleFormatting() + summary: Removes character formatting applied through character styles. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'clearCharacterStyleFormatting(): void;' + return: + type: void + description: '' + - name: clearFormatting() + uid: word!Word.Selection#clearFormatting:member(1) + package: word! + fullName: clearFormatting() + summary: Removes character and paragraph formatting from the selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'clearFormatting(): void;' + return: + type: void + description: '' + - name: clearManualCharacterFormatting() + uid: word!Word.Selection#clearManualCharacterFormatting:member(1) + package: word! + fullName: clearManualCharacterFormatting() + summary: Removes manually applied character formatting from the selected text. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'clearManualCharacterFormatting(): void;' + return: + type: void + description: '' + - name: clearManualParagraphFormatting() + uid: word!Word.Selection#clearManualParagraphFormatting:member(1) + package: word! + fullName: clearManualParagraphFormatting() + summary: Removes manually applied paragraph formatting from the selected text. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'clearManualParagraphFormatting(): void;' + return: + type: void + description: '' + - name: clearParagraphFormatting() + uid: word!Word.Selection#clearParagraphFormatting:member(1) + package: word! + fullName: clearParagraphFormatting() + summary: Removes all paragraph formatting from the selected text. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'clearParagraphFormatting(): void;' + return: + type: void + description: '' + - name: clearParagraphStyle() + uid: word!Word.Selection#clearParagraphStyle:member(1) + package: word! + fullName: clearParagraphStyle() + summary: Removes paragraph formatting applied through paragraph styles. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'clearParagraphStyle(): void;' + return: + type: void + description: '' + - name: collapse(direction) + uid: word!Word.Selection#collapse:member(1) + package: word! + fullName: collapse(direction) + summary: Collapses the selection to the starting or ending position. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'collapse(direction?: Word.CollapseDirection): void;' + parameters: + - id: direction + description: Optional. Direction to collapse. + type: + return: + type: void + description: '' + - name: collapse(direction) + uid: word!Word.Selection#collapse:member(2) + package: word! + fullName: collapse(direction) + summary: Collapses the selection to the starting or ending position. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'collapse(direction?: "Start" | "End"): void;' + parameters: + - id: direction + description: Optional. Direction to collapse. + type: '"Start" | "End"' + return: + type: void + description: '' + - name: convertToTable(options) + uid: word!Word.Selection#convertToTable:member(1) + package: word! + fullName: convertToTable(options) + summary: Converts text within a range to a table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + convertToTable(options?: Word.SelectionConvertToTableOptions): + Word.Table; + parameters: + - id: options + description: Optional. Options for converting text to a table. + type: + return: + type: + description: A `Table` object that represents the newly created table. + - name: copyAsPictureToClipboard() + uid: word!Word.Selection#copyAsPictureToClipboard:member(1) + package: word! + fullName: copyAsPictureToClipboard() + summary: Copies the selection to the Clipboard as a picture. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'copyAsPictureToClipboard(): void;' + return: + type: void + description: '' + - name: copyFormat() + uid: word!Word.Selection#copyFormat:member(1) + package: word! + fullName: copyFormat() + summary: >- + Copies the character formatting of the first character in the selected + text. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'copyFormat(): void;' + return: + type: void + description: '' + - name: copyToClipboard() + uid: word!Word.Selection#copyToClipboard:member(1) + package: word! + fullName: copyToClipboard() + summary: Copies the selection to the Clipboard. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'copyToClipboard(): void;' + return: + type: void + description: '' + - name: createTextBox() + uid: word!Word.Selection#createTextBox:member(1) + package: word! + fullName: createTextBox() + summary: Adds a default-sized text box around the selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'createTextBox(): void;' + return: + type: void + description: '' + - name: cut() + uid: word!Word.Selection#cut:member(1) + package: word! + fullName: cut() + summary: >- + Removes the selected content from the document and moves it to the + Clipboard. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'cut(): void;' + return: + type: void + description: '' + - name: delete(options) + uid: word!Word.Selection#delete:member(1) + package: word! + fullName: delete(options) + summary: Deletes the specified number of characters or words. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + delete(options?: Word.SelectionDeleteOptions): + OfficeExtension.ClientResult; + parameters: + - id: options + description: Optional. Options for deleting text. + type: + return: + type: <number> + description: The number of characters deleted. + - name: detectLanguage() + uid: word!Word.Selection#detectLanguage:member(1) + package: word! + fullName: detectLanguage() + summary: Analyzes the selected text to determine the language that it's written in. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'detectLanguage(): void;' + return: + type: void + description: '' + - name: expand(unit) + uid: word!Word.Selection#expand:member(1) + package: word! + fullName: expand(unit) + summary: Expands the selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'expand(unit?: Word.OperationUnit): OfficeExtension.ClientResult;' + parameters: + - id: unit + description: Optional. The unit to expand. + type: + return: + type: <number> + description: The number of characters added to the range or selection. + - name: expand(unit) + uid: word!Word.Selection#expand:member(2) + package: word! + fullName: expand(unit) + summary: Expands the selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + expand(unit?: "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | + "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | + "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"): + OfficeExtension.ClientResult; + parameters: + - id: unit + description: Optional. The unit to expand. + type: >- + "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | + "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | + "CharacterFormat" | "ParagraphFormat" | "Table" | "Item" + return: + type: <number> + description: The number of characters added to the range or selection. + - name: expandToWholeStory() + uid: word!Word.Selection#expandToWholeStory:member(1) + package: word! + fullName: expandToWholeStory() + summary: Expands the selection to include the entire story. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'expandToWholeStory(): void;' + return: + type: void + description: '' + - name: extend(character) + uid: word!Word.Selection#extend:member(1) + package: word! + fullName: extend(character) + summary: >- + Turns on extend mode, or if extend mode is already on, extends the + selection to the next larger unit of text. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'extend(character?: Word.OperationUnit): void;' + parameters: + - id: character + description: >- + Optional. The character through which the selection is extended. + This argument is case-sensitive and must evaluate to a string or an + error occurs. Also, if the value of this argument is longer than a + single character, Microsoft Word ignores the command entirely. + type: + return: + type: void + description: '' + - name: extend(character) + uid: word!Word.Selection#extend:member(2) + package: word! + fullName: extend(character) + summary: >- + Turns on extend mode, or if extend mode is already on, extends the + selection to the next larger unit of text. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + extend(character?: "Character" | "Word" | "Sentence" | "Paragraph" | + "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | + "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"): + void; + parameters: + - id: character + description: >- + Optional. The character through which the selection is extended. + This argument is case-sensitive and must evaluate to a string or an + error occurs. Also, if the value of this argument is longer than a + single character, Microsoft Word ignores the command entirely. + type: >- + "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | + "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | + "CharacterFormat" | "ParagraphFormat" | "Table" | "Item" + return: + type: void + description: '' + - name: getNextRange(options) + uid: word!Word.Selection#getNextRange:member(1) + package: word! + fullName: getNextRange(options) + summary: >- + Returns a `Range` object that represents the next unit relative to the + selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'getNextRange(options?: Word.SelectionNextOptions): Word.Range;' + parameters: + - id: options + description: Optional. Options for the `next` operation. + type: + return: + type: + description: >- + A `Range` object that represents the next unit relative to the + selection. + - name: getPreviousRange(options) + uid: word!Word.Selection#getPreviousRange:member(1) + package: word! + fullName: getPreviousRange(options) + summary: >- + Returns a `Range` object that represents the previous unit relative to the + selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'getPreviousRange(options?: Word.SelectionPreviousOptions): Word.Range;' + parameters: + - id: options + description: Optional. Options for the `previous` operation. + type: + return: + type: + description: >- + A `Range` object that represents the previous unit relative to the + selection. + - name: goTo(options) + uid: word!Word.Selection#goTo:member(1) + package: word! + fullName: goTo(options) + summary: >- + Returns a `Range` object that represents the area specified by the + `options` and moves the insertion point to the character position + immediately preceding the specified item. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'goTo(options?: Word.SelectionGoToOptions): Word.Range;' + parameters: + - id: options + description: Optional. Options for the `goTo` operation. + type: + return: + type: + description: A `Range` object that is now selected. + - name: goToNext(what) + uid: word!Word.Selection#goToNext:member(1) + package: word! + fullName: goToNext(what) + summary: >- + Returns a `Range` object that refers to the start position of the next + item or location specified by the `what` argument and moves the selection + to the specified item. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'goToNext(what: Word.GoToItem): Word.Range;' + parameters: + - id: what + description: The item type to go to. + type: + return: + type: + description: >- + A `Range` object that refers to the start position of the next item or + location specified by the `what` argument. + - name: goToNext(what) + uid: word!Word.Selection#goToNext:member(2) + package: word! + fullName: goToNext(what) + summary: >- + Returns a `Range` object that refers to the start position of the next + item or location specified by the `what` argument and moves the selection + to the specified item. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + goToNext(what: "Bookmark" | "Comment" | "Endnote" | "Field" | "Footnote" + | "Graphic" | "Heading" | "Line" | "Page" | "Section" | "Table" | + "EmbeddedObject" | "Equation" | "Percent" | "SpellingError" | + "GrammaticalError" | "ProofreadingError"): Word.Range; + parameters: + - id: what + description: The item type to go to. + type: >- + "Bookmark" | "Comment" | "Endnote" | "Field" | "Footnote" | + "Graphic" | "Heading" | "Line" | "Page" | "Section" | "Table" | + "EmbeddedObject" | "Equation" | "Percent" | "SpellingError" | + "GrammaticalError" | "ProofreadingError" + return: + type: + description: >- + A `Range` object that refers to the start position of the next item or + location specified by the `what` argument. + - name: goToPrevious(what) + uid: word!Word.Selection#goToPrevious:member(1) + package: word! + fullName: goToPrevious(what) + summary: >- + Returns a `Range` object that refers to the start position of the previous + item or location specified by the `what` argument and moves the selection + to the specified item. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'goToPrevious(what: Word.GoToItem): Word.Range;' + parameters: + - id: what + description: The item type to go to. + type: + return: + type: + description: >- + A `Range` object that refers to the start position of the previous + item or location specified by the `what` argument. + - name: goToPrevious(what) + uid: word!Word.Selection#goToPrevious:member(2) + package: word! + fullName: goToPrevious(what) + summary: >- + Returns a `Range` object that refers to the start position of the previous + item or location specified by the `what` argument and moves the selection + to the specified item. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + goToPrevious(what: "Bookmark" | "Comment" | "Endnote" | "Field" | + "Footnote" | "Graphic" | "Heading" | "Line" | "Page" | "Section" | + "Table" | "EmbeddedObject" | "Equation" | "Percent" | "SpellingError" | + "GrammaticalError" | "ProofreadingError"): Word.Range; + parameters: + - id: what + description: The item type to go to. + type: >- + "Bookmark" | "Comment" | "Endnote" | "Field" | "Footnote" | + "Graphic" | "Heading" | "Line" | "Page" | "Section" | "Table" | + "EmbeddedObject" | "Equation" | "Percent" | "SpellingError" | + "GrammaticalError" | "ProofreadingError" + return: + type: + description: >- + A `Range` object that refers to the start position of the previous + item or location specified by the `what` argument. + - name: insertAfter(text) + uid: word!Word.Selection#insertAfter:member(1) + package: word! + fullName: insertAfter(text) + summary: Inserts the specified text at the end of the range or selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'insertAfter(text: string): void;' + parameters: + - id: text + description: Text to insert. + type: string + return: + type: void + description: '' + - name: insertBefore(text) + uid: word!Word.Selection#insertBefore:member(1) + package: word! + fullName: insertBefore(text) + summary: Inserts the specified text before the selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'insertBefore(text: string): void;' + parameters: + - id: text + description: Text to insert. + type: string + return: + type: void + description: '' + - name: insertCells(shiftCells) + uid: word!Word.Selection#insertCells:member(1) + package: word! + fullName: insertCells(shiftCells) + summary: Adds cells to an existing table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'insertCells(shiftCells?: Word.TableCellInsertionLocation): void;' + parameters: + - id: shiftCells + description: >- + Optional. Specifies how to insert the cells into the existing + columns and rows of the table. The default value is `shiftDown`. + type: + return: + type: void + description: '' + - name: insertCells(shiftCells) + uid: word!Word.Selection#insertCells:member(2) + package: word! + fullName: insertCells(shiftCells) + summary: Adds cells to an existing table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + insertCells(shiftCells?: "ShiftRight" | "ShiftDown" | "ShiftRowDown" | + "ShiftColumnRight"): void; + parameters: + - id: shiftCells + description: >- + Optional. Specifies how to insert the cells into the existing + columns and rows of the table. The default value is `shiftDown`. + type: '"ShiftRight" | "ShiftDown" | "ShiftRowDown" | "ShiftColumnRight"' + return: + type: void + description: '' + - name: insertColumnsLeft() + uid: word!Word.Selection#insertColumnsLeft:member(1) + package: word! + fullName: insertColumnsLeft() + summary: Inserts columns to the left of the column that contains the selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'insertColumnsLeft(): void;' + return: + type: void + description: '' + - name: insertColumnsRight() + uid: word!Word.Selection#insertColumnsRight:member(1) + package: word! + fullName: insertColumnsRight() + summary: Inserts columns to the right of the current selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'insertColumnsRight(): void;' + return: + type: void + description: '' + - name: insertDateTime(options) + uid: word!Word.Selection#insertDateTime:member(1) + package: word! + fullName: insertDateTime(options) + summary: >- + Inserts the current date or time, or both, either as text or as a [TIME + field](https://support.microsoft.com/office/6cb8fcef-310a-4646-ae6b-886d88335c90). + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'insertDateTime(options?: Word.SelectionInsertDateTimeOptions): void;' + parameters: + - id: options + description: Options for inserting the date or time. + type: + return: + type: void + description: '' + - name: insertFormula(options) + uid: word!Word.Selection#insertFormula:member(1) + package: word! + fullName: insertFormula(options) + summary: >- + Inserts a [Formula + field](https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d) + at the selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'insertFormula(options?: Word.SelectionInsertFormulaOptions): void;' + parameters: + - id: options + description: Optional. Options for inserting the formula. + type: + return: + type: void + description: '' + - name: insertNewPage() + uid: word!Word.Selection#insertNewPage:member(1) + package: word! + fullName: insertNewPage() + summary: Inserts a new page at the position of the insertion point. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'insertNewPage(): void;' + return: + type: void + description: '' + - name: insertParagraphAfter() + uid: word!Word.Selection#insertParagraphAfter:member(1) + package: word! + fullName: insertParagraphAfter() + summary: Inserts a paragraph mark after the selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'insertParagraphAfter(): void;' + return: + type: void + description: '' + - name: insertParagraphBefore() + uid: word!Word.Selection#insertParagraphBefore:member(1) + package: word! + fullName: insertParagraphBefore() + summary: Inserts a new paragraph before the selection or range. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'insertParagraphBefore(): void;' + return: + type: void + description: '' + - name: insertParagraphStyleSeparator() + uid: word!Word.Selection#insertParagraphStyleSeparator:member(1) + package: word! + fullName: insertParagraphStyleSeparator() + summary: >- + Inserts a special hidden paragraph mark that allows Word to join + paragraphs formatted using different paragraph styles. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'insertParagraphStyleSeparator(): void;' + return: + type: void + description: '' + - name: insertRowsAbove(numRows) + uid: word!Word.Selection#insertRowsAbove:member(1) + package: word! + fullName: insertRowsAbove(numRows) + summary: Inserts rows above the current selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'insertRowsAbove(numRows: number): void;' + parameters: + - id: numRows + description: Optional. Number of rows to insert. + type: number + return: + type: void + description: '' + - name: insertRowsBelow(numRows) + uid: word!Word.Selection#insertRowsBelow:member(1) + package: word! + fullName: insertRowsBelow(numRows) + summary: Inserts rows below the current selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'insertRowsBelow(numRows: number): void;' + parameters: + - id: numRows + description: Optional. Number of rows to insert. + type: number + return: + type: void + description: '' + - name: insertSymbol(characterNumber, options) + uid: word!Word.Selection#insertSymbol:member(1) + package: word! + fullName: insertSymbol(characterNumber, options) + summary: Inserts a symbol in place of the specified selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + insertSymbol(characterNumber: number, options?: + Word.SelectionInsertSymbolOptions): void; + parameters: + - id: characterNumber + description: The character number of the symbol. + type: number + - id: options + description: Optional. Options for inserting the symbol. + type: + return: + type: void + description: '' + - name: insertText(Text) + uid: word!Word.Selection#insertText:member(1) + package: word! + fullName: insertText(Text) + summary: Inserts the specified text. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'insertText(Text: string): void;' + parameters: + - id: Text + description: The text to insert. + type: string + return: + type: void + description: '' + - name: insertXML(xml, transform) + uid: word!Word.Selection#insertXML:member(1) + package: word! + fullName: insertXML(xml, transform) + summary: >- + Inserts the specified XML into the document at the cursor, replacing any + selected text. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'insertXML(xml: string, transform?: string): void;' + parameters: + - id: xml + description: The XML string to insert. + type: string + - id: transform + description: Optional. XSL transform to apply. + type: string + return: + type: void + description: '' + - name: isEqual(range) + uid: word!Word.Selection#isEqual:member(1) + package: word! + fullName: isEqual(range) + summary: Returns whether the selection is equal to the specified range. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isEqual(range: Word.Range): OfficeExtension.ClientResult;' + parameters: + - id: range + description: The range to compare. + type: + return: + type: >- + <boolean> + description: '`true` if the selection is equal to the specified range.' + - name: isInRange(range) + uid: word!Word.Selection#isInRange:member(1) + package: word! + fullName: isInRange(range) + summary: Returns `true` if the selection is contained within the specified range. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isInRange(range: Word.Range): OfficeExtension.ClientResult;' + parameters: + - id: range + description: The range to compare. + type: + return: + type: >- + <boolean> + description: '`true` if the selection is contained within the specified range.' + - name: isInStory(range) + uid: word!Word.Selection#isInStory:member(1) + package: word! + fullName: isInStory(range) + summary: Returns whether the selection is in the same story as the specified range. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isInStory(range: Word.Range): OfficeExtension.ClientResult;' + parameters: + - id: range + description: The range to compare. + type: + return: + type: >- + <boolean> + description: '`true` if the selection is in the same story as the specified range.' + - name: load(options) + uid: word!Word.Selection#load:member(1) + package: word! + 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: true + isDeprecated: false + syntax: + content: 'load(options?: Word.Interfaces.SelectionLoadOptions): Word.Selection;' + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: + return: + type: + description: '' + - name: load(propertyNames) + uid: word!Word.Selection#load:member(2) + package: word! + 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: true + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Word.Selection;' + 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: word!Word.Selection#load:member(3) + package: word! + 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: true + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Selection; + 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: move(options) + uid: word!Word.Selection#move:member(1) + package: word! + fullName: move(options) + summary: >- + Collapses the selection to its start or end position and then moves the + collapsed object by the specified number of units. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + move(options?: Word.SelectionMoveOptions): + OfficeExtension.ClientResult; + parameters: + - id: options + description: Optional. Options for moving the selection. + type: + return: + type: <number> + description: The number of characters by which the selection was moved. + - name: moveDown(options) + uid: word!Word.Selection#moveDown:member(1) + package: word! + fullName: moveDown(options) + summary: Moves the selection down. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + moveDown(options?: Word.SelectionMoveUpDownOptions): + OfficeExtension.ClientResult; + parameters: + - id: options + description: Optional. Options for moving down. + type: + return: + type: <number> + description: The number of characters by which the selection was moved. + - name: moveEnd(options) + uid: word!Word.Selection#moveEnd:member(1) + package: word! + fullName: moveEnd(options) + summary: Moves the ending character position of the range or selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + moveEnd(options?: Word.SelectionMoveStartEndOptions): + OfficeExtension.ClientResult; + parameters: + - id: options + description: Optional. Options for moving end. + type: + return: + type: <number> + description: The number of characters by which the selection was moved. + - name: moveEndUntil(characters, count) + uid: word!Word.Selection#moveEndUntil:member(1) + package: word! + fullName: moveEndUntil(characters, count) + summary: >- + Moves the end position of the selection until any of the specified + characters are found in the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + moveEndUntil(characters: string, count?: number): + OfficeExtension.ClientResult; + parameters: + - id: characters + description: >- + Characters to search for. For example. If you specify "a", the + selection moves the end position to before the first "a" character. + type: string + - id: count + description: Optional. Maximum number of characters to search. + type: number + return: + type: <number> + description: The number of characters by which the selection was moved. + - name: moveEndWhile(characters, count) + uid: word!Word.Selection#moveEndWhile:member(1) + package: word! + fullName: moveEndWhile(characters, count) + summary: >- + Moves the ending character position of the selection while any of the + specified characters are found in the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + moveEndWhile(characters: string, count?: number): + OfficeExtension.ClientResult; + parameters: + - id: characters + description: >- + Characters to search for. For example. If you specify "abcd", the + selection moves the end position when any letter from "abcd" is + found. + type: string + - id: count + description: Optional. Maximum number of characters to search. + type: number + return: + type: <number> + description: The number of characters by which the selection was moved. + - name: moveLeft(options) + uid: word!Word.Selection#moveLeft:member(1) + package: word! + fullName: moveLeft(options) + summary: Moves the selection to the left. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + moveLeft(options?: Word.SelectionMoveLeftRightOptions): + OfficeExtension.ClientResult; + parameters: + - id: options + description: Optional. Options for moving left. + type: + return: + type: <number> + description: The number of characters by which the selection was moved. + - name: moveRight(options) + uid: word!Word.Selection#moveRight:member(1) + package: word! + fullName: moveRight(options) + summary: Moves the selection to the right. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + moveRight(options?: Word.SelectionMoveLeftRightOptions): + OfficeExtension.ClientResult; + parameters: + - id: options + description: Optional. Options for moving right. + type: + return: + type: <number> + description: The number of characters by which the selection was moved. + - name: moveStart(options) + uid: word!Word.Selection#moveStart:member(1) + package: word! + fullName: moveStart(options) + summary: Moves the start position of the selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + moveStart(options?: Word.SelectionMoveStartEndOptions): + OfficeExtension.ClientResult; + parameters: + - id: options + description: Optional. Options for the `moveStart` operation. + type: + return: + type: <number> + description: The number of characters by which the selection was moved. + - name: moveStartUntil(characters, count) + uid: word!Word.Selection#moveStartUntil:member(1) + package: word! + fullName: moveStartUntil(characters, count) + summary: >- + Moves the start position of the selection until one of the specified + characters is found in the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + moveStartUntil(characters: string, count?: number): + OfficeExtension.ClientResult; + parameters: + - id: characters + description: >- + Characters to search for. If you specify "a", the selection moves + the start position to before the first "a" character. + type: string + - id: count + description: Optional. Maximum number of characters to search. + type: number + return: + type: <number> + description: The number of characters by which the selection was moved. + - name: moveStartWhile(characters, count) + uid: word!Word.Selection#moveStartWhile:member(1) + package: word! + fullName: moveStartWhile(characters, count) + summary: >- + Moves the start position of the selection while any of the specified + characters are found in the document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + moveStartWhile(characters: string, count?: number): + OfficeExtension.ClientResult; + parameters: + - id: characters + description: >- + Characters to search for. For example. If you specify "abcd", the + selection moves the start position when any letter from "abcd" is + found. + type: string + - id: count + description: Optional. Maximum number of characters to search. + type: number + return: + type: <number> + description: The number of characters by which the selection was moved. + - name: moveUntil(characters, count) + uid: word!Word.Selection#moveUntil:member(1) + package: word! + fullName: moveUntil(characters, count) + summary: >- + Moves the selection until one of the specified characters is found in the + document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + moveUntil(characters: string, count?: number): + OfficeExtension.ClientResult; + parameters: + - id: characters + description: >- + Characters to search for. For example. If you specify "a", the + selection moves to the position before the first "a" character. + type: string + - id: count + description: Optional. Maximum number of characters to search. + type: number + return: + type: <number> + description: The number of characters by which the selection was moved. + - name: moveUp(options) + uid: word!Word.Selection#moveUp:member(1) + package: word! + fullName: moveUp(options) + summary: Moves the selection up. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + moveUp(options?: Word.SelectionMoveUpDownOptions): + OfficeExtension.ClientResult; + parameters: + - id: options + description: Optional. Options for moving up. + type: + return: + type: <number> + description: The number of characters by which the selection was moved. + - name: moveWhile(characters, count) + uid: word!Word.Selection#moveWhile:member(1) + package: word! + fullName: moveWhile(characters, count) + summary: >- + Moves the selection while any of the specified characters are found in the + document. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + moveWhile(characters: string, count?: number): + OfficeExtension.ClientResult; + parameters: + - id: characters + description: >- + Characters to search for. For example. If you specify "abcd", the + selection moves to the position when any letter from "abcd" is + found. + type: string + - id: count + description: Optional. Maximum number of characters to search. + type: number + return: + type: <number> + description: The number of characters by which the selection was moved. + - name: nextField() + uid: word!Word.Selection#nextField:member(1) + package: word! + fullName: nextField() + summary: Selects the next field. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'nextField(): Word.Field;' + return: + type: + description: The next field. + - name: nextSubdocument() + uid: word!Word.Selection#nextSubdocument:member(1) + package: word! + fullName: nextSubdocument() + summary: Moves the selection to the next subDocument. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'nextSubdocument(): void;' + return: + type: void + description: '' + - name: pasteAndFormat(type) + uid: word!Word.Selection#pasteAndFormat:member(1) + package: word! + fullName: pasteAndFormat(type) + summary: Pastes the content from clipboard and formats them as specified. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'pasteAndFormat(type: Word.PasteFormatType): void;' + parameters: + - id: type + description: The format paste type for table cells + type: + return: + type: void + description: '' + - name: pasteAndFormat(type) + uid: word!Word.Selection#pasteAndFormat:member(2) + package: word! + fullName: pasteAndFormat(type) + summary: Pastes the content from clipboard and formats them as specified. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + pasteAndFormat(type: "PasteDefault" | "SingleCellText" | + "SingleCellTable" | "ListContinueNumbering" | "ListRestartNumbering" | + "TableAppendTable" | "TableInsertAsRows" | "TableOriginalFormatting" | + "ChartPicture" | "Chart" | "ChartLinked" | "FormatOriginalFormatting" | + "FormatSurroundingFormattingWithEmphasis" | "FormatPlainText" | + "TableOverwriteCells" | "ListCombineWithExistingList" | "ListDontMerge" + | "UseDestinationStylesRecovery"): void; + parameters: + - id: type + description: The format paste type for table cells + type: >- + "PasteDefault" | "SingleCellText" | "SingleCellTable" | + "ListContinueNumbering" | "ListRestartNumbering" | + "TableAppendTable" | "TableInsertAsRows" | "TableOriginalFormatting" + | "ChartPicture" | "Chart" | "ChartLinked" | + "FormatOriginalFormatting" | + "FormatSurroundingFormattingWithEmphasis" | "FormatPlainText" | + "TableOverwriteCells" | "ListCombineWithExistingList" | + "ListDontMerge" | "UseDestinationStylesRecovery" + return: + type: void + description: '' + - name: pasteExcelTable(linkedToExcel, wordFormatting, rtf) + uid: word!Word.Selection#pasteExcelTable:member(1) + package: word! + fullName: pasteExcelTable(linkedToExcel, wordFormatting, rtf) + summary: Pastes and formats a Microsoft Excel table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) + \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + pasteExcelTable(linkedToExcel: boolean, wordFormatting: boolean, rtf: + boolean): void; + parameters: + - id: linkedToExcel + description: Whether the table is linked to Excel. + type: boolean + - id: wordFormatting + description: Whether to apply Word formatting. + type: boolean + - id: rtf + description: Whether to paste as Rich Text Format (RTF). + type: boolean + return: + type: void + description: '' + - name: pasteFormat() + uid: word!Word.Selection#pasteFormat:member(1) + package: word! + fullName: pasteFormat() + summary: Applies formatting copied with the `copyFormat` method to the selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'pasteFormat(): void;' + return: + type: void + description: '' + - name: pasteTableCellsAppendTable() + uid: word!Word.Selection#pasteTableCellsAppendTable:member(1) + package: word! + fullName: pasteTableCellsAppendTable() + summary: >- + Merges pasted cells into an existing table by inserting the pasted rows + between the selected rows. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'pasteTableCellsAppendTable(): void;' + return: + type: void + description: '' + - name: pasteTableCellsAsNestedTable() + uid: word!Word.Selection#pasteTableCellsAsNestedTable:member(1) + package: word! + fullName: pasteTableCellsAsNestedTable() + summary: Pastes a cell or group of cells as a nested table into the selection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'pasteTableCellsAsNestedTable(): void;' + return: + type: void + description: '' + - name: previousField() + uid: word!Word.Selection#previousField:member(1) + package: word! + fullName: previousField() + summary: Selects and returns the previous field. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'previousField(): Word.Field;' + return: + type: + description: The previous field. + - name: previousSubdocument() + uid: word!Word.Selection#previousSubdocument:member(1) + package: word! + fullName: previousSubdocument() + summary: Moves the selection to the previous subDocument. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'previousSubdocument(): void;' + return: + type: void + description: '' + - name: replaceParagraph() + uid: word!Word.Selection#replaceParagraph:member(1) + package: word! + fullName: replaceParagraph() + summary: Replaces the selection with a new paragraph. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'replaceParagraph(): void;' + return: + type: void + description: '' + - name: select() + uid: word!Word.Selection#select:member(1) + package: word! + fullName: select() + summary: Selects the current text. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'select(): void;' + return: + type: void + description: '' + - name: selectCell() + uid: word!Word.Selection#selectCell:member(1) + package: word! + fullName: selectCell() + summary: >- + Selects the entire cell containing the current selection when the + selection is in a table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'selectCell(): void;' + return: + type: void + description: '' + - name: selectColumn() + uid: word!Word.Selection#selectColumn:member(1) + package: word! + fullName: selectColumn() + summary: >- + Selects the column that contains the insertion point, or selects all + columns that contain the selection when the selection is in a table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'selectColumn(): void;' + return: + type: void + description: '' + - name: selectCurrentAlignment() + uid: word!Word.Selection#selectCurrentAlignment:member(1) + package: word! + fullName: selectCurrentAlignment() + summary: >- + Extends the selection forward until text with a different paragraph + alignment is encountered. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'selectCurrentAlignment(): void;' + return: + type: void + description: '' + - name: selectCurrentColor() + uid: word!Word.Selection#selectCurrentColor:member(1) + package: word! + fullName: selectCurrentColor() + summary: >- + Extends the selection forward until text with a different color is + encountered. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'selectCurrentColor(): void;' + return: + type: void + description: '' + - name: selectCurrentFont() + uid: word!Word.Selection#selectCurrentFont:member(1) + package: word! + fullName: selectCurrentFont() + summary: >- + Extends the selection forward until text in a different font or font size + is encountered. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'selectCurrentFont(): void;' + return: + type: void + description: '' + - name: selectCurrentIndent() + uid: word!Word.Selection#selectCurrentIndent:member(1) + package: word! + fullName: selectCurrentIndent() + summary: >- + Extends the selection forward until text with different left or right + paragraph indents is encountered. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'selectCurrentIndent(): void;' + return: + type: void + description: '' + - name: selectCurrentSpacing() + uid: word!Word.Selection#selectCurrentSpacing:member(1) + package: word! + fullName: selectCurrentSpacing() + summary: >- + Extends the selection forward until a paragraph with different line + spacing is encountered. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'selectCurrentSpacing(): void;' + return: + type: void + description: '' + - name: selectCurrentTabs() + uid: word!Word.Selection#selectCurrentTabs:member(1) + package: word! + fullName: selectCurrentTabs() + summary: >- + Extends the selection forward until a paragraph with different tab stops + is encountered. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'selectCurrentTabs(): void;' + return: + type: void + description: '' + - name: selectRow() + uid: word!Word.Selection#selectRow:member(1) + package: word! + fullName: selectRow() + summary: >- + Selects the row that contains the insertion point, or selects all rows + that contain the selection when the selection is in a table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'selectRow(): void;' + return: + type: void + description: '' + - name: setRange(start, end) + uid: word!Word.Selection#setRange:member(1) + package: word! + fullName: setRange(start, end) + summary: >- + Sets the starting and ending character positions for the selection. + Character position values start at the beginning of the story, with the + first value being 0. All characters are counted, including nonprinting + characters. Hidden characters are counted even if they're not displayed. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'setRange(start: number, end: number): void;' + parameters: + - id: start + description: The starting character position of the current story. + type: number + - id: end + description: The ending character position of the current story. + type: number + return: + type: void + description: '' + - name: shrink() + uid: word!Word.Selection#shrink:member(1) + package: word! + fullName: shrink() + summary: >- + Shrinks the selection to the next smaller unit of text. The unit + progression for this method is as follows: entire document, section, + paragraph, sentence, word, insertion point. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'shrink(): void;' + return: + type: void + description: '' + - name: shrinkDiscontiguousSelection() + uid: word!Word.Selection#shrinkDiscontiguousSelection:member(1) + package: word! + fullName: shrinkDiscontiguousSelection() + summary: >- + Cancels the selection of all but the most recently selected text when the + current selection contains multiple, unconnected selections. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'shrinkDiscontiguousSelection(): void;' + return: + type: void + description: '' + - name: splitTable() + uid: word!Word.Selection#splitTable:member(1) + package: word! + fullName: splitTable() + summary: >- + Inserts an empty paragraph above the first row in the selection. If the + selection isn't in the first row of the table, the table is split into two + tables. If the selection isn't in a table, an error occurs. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'splitTable(): void;' + return: + type: void + description: '' + - name: toggleCharacterCode() + uid: word!Word.Selection#toggleCharacterCode:member(1) + package: word! + fullName: toggleCharacterCode() + summary: >- + Switches the selection between a Unicode character and its corresponding + hexadecimal value. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'toggleCharacterCode(): void;' + return: + type: void + description: '' + - name: toJSON() + uid: word!Word.Selection#toJSON:member(1) + package: word! + 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 `Word.Selection` object + is an API object, the `toJSON` method returns a plain JavaScript object + (typed as `Word.Interfaces.SelectionData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'toJSON(): Word.Interfaces.SelectionData;' + return: + type: + description: '' + - name: track() + uid: word!Word.Selection#track:member(1) + package: word! + fullName: track() + summary: >- + Track the object for automatic adjustment based on surrounding changes in + the document. This call is a shorthand for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). If you're using this object across `.sync` calls and outside the + sequential execution of a ".run" batch, and get an "InvalidObjectPath" + error when setting a property or invoking a method on the object, you need + to add the object to the tracked object collection when the object was + first created. If this object is part of a collection, you should also + track the parent collection. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'track(): Word.Selection;' + return: + type: + description: '' + - name: typeBackspace() + uid: word!Word.Selection#typeBackspace:member(1) + package: word! + fullName: typeBackspace() + summary: >- + Deletes the character preceding the selection (if collapsed) or the + insertion point. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'typeBackspace(): void;' + return: + type: void + description: '' + - name: untrack() + uid: word!Word.Selection#untrack:member(1) + package: word! + fullName: untrack() + summary: >- + Release the memory associated with this object, if it has previously been + tracked. This call is shorthand for + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). Having many tracked objects slows down the host application, so + please remember to free any objects you add, once you're done using them. + You'll need to call `context.sync()` before the memory release takes + effect. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'untrack(): Word.Selection;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/word/word/word.selectionconverttotableoptions.yml b/docs/docs-ref-autogen/word/word/word.selectionconverttotableoptions.yml new file mode 100644 index 0000000000..252eea544e --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.selectionconverttotableoptions.yml @@ -0,0 +1,316 @@ +### YamlMime:TSType +name: Word.SelectionConvertToTableOptions +uid: word!Word.SelectionConvertToTableOptions:interface +package: word! +fullName: Word.SelectionConvertToTableOptions +summary: >- + Represents the options for the + [Selection.convertToTable](xref:word!Word.Selection:class) method. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: applyBorders + uid: word!Word.SelectionConvertToTableOptions#applyBorders:member + package: word! + fullName: applyBorders + summary: >- + If provided, specifies whether to apply borders to the table of the + specified format. Default value is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'applyBorders?: boolean;' + return: + type: boolean + - name: applyColor + uid: word!Word.SelectionConvertToTableOptions#applyColor:member + package: word! + fullName: applyColor + summary: >- + If provided, specifies whether to apply color formatting to the table of + the specified format. Default value is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'applyColor?: boolean;' + return: + type: boolean + - name: applyFirstColumn + uid: word!Word.SelectionConvertToTableOptions#applyFirstColumn:member + package: word! + fullName: applyFirstColumn + summary: >- + If provided, specifies whether to apply special formatting to the first + column of the specified format. Default value is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'applyFirstColumn?: boolean;' + return: + type: boolean + - name: applyFont + uid: word!Word.SelectionConvertToTableOptions#applyFont:member + package: word! + fullName: applyFont + summary: >- + If provided, specifies whether to apply font formatting to the table of + the specified format. Default value is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'applyFont?: boolean;' + return: + type: boolean + - name: applyHeadingRows + uid: word!Word.SelectionConvertToTableOptions#applyHeadingRows:member + package: word! + fullName: applyHeadingRows + summary: >- + If provided, specifies whether to format the first row as a header row of + the specified format. Default value is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'applyHeadingRows?: boolean;' + return: + type: boolean + - name: applyLastColumn + uid: word!Word.SelectionConvertToTableOptions#applyLastColumn:member + package: word! + fullName: applyLastColumn + summary: >- + If provided, specifies whether to apply special formatting to the last + column of the specified format. Default value is `false`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'applyLastColumn?: boolean;' + return: + type: boolean + - name: applyLastRow + uid: word!Word.SelectionConvertToTableOptions#applyLastRow:member + package: word! + fullName: applyLastRow + summary: >- + If provided, specifies whether to apply special formatting to the last row + of the specified format. Default value is `false`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'applyLastRow?: boolean;' + return: + type: boolean + - name: applyShading + uid: word!Word.SelectionConvertToTableOptions#applyShading:member + package: word! + fullName: applyShading + summary: >- + If provided, specifies whether to apply shading to the table of the + specified format. Default value is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'applyShading?: boolean;' + return: + type: boolean + - name: autoFit + uid: word!Word.SelectionConvertToTableOptions#autoFit:member + package: word! + fullName: autoFit + summary: >- + If provided, specifies whether to automatically resize the table to fit + the contents. Default value is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'autoFit?: boolean;' + return: + type: boolean + - name: autoFitBehavior + uid: word!Word.SelectionConvertToTableOptions#autoFitBehavior:member + package: word! + fullName: autoFitBehavior + summary: >- + If provided, specifies the auto-fit behavior for the table. Used when the + `defaultTableBehavior` property is `enableAutoFit`. The default + value is `fixed`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + autoFitBehavior?: Word.AutoFitBehavior | "FixedSize" | "Content" | + "Window"; + return: + type: >- + | "FixedSize" | + "Content" | "Window" + - name: defaultTableBehavior + uid: word!Word.SelectionConvertToTableOptions#defaultTableBehavior:member + package: word! + fullName: defaultTableBehavior + summary: >- + If provided, specifies whether Microsoft Word automatically resizes cells + in a table to fit the contents. The default value is `disableAutoFit`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + defaultTableBehavior?: Word.DefaultTableBehavior | "DisableAutoFit" | + "EnableAutoFit"; + return: + type: >- + | "DisableAutoFit" + | "EnableAutoFit" + - name: format + uid: word!Word.SelectionConvertToTableOptions#format:member + package: word! + fullName: format + summary: >- + If provided, specifies a preset format to apply to the table. If omitted, + Word applies the default table format. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + format?: Word.TableFormat | "None" | "Simple1" | "Simple2" | "Simple3" | + "Classic1" | "Classic2" | "Classic3" | "Classic4" | "Colorful1" | + "Colorful2" | "Colorful3" | "Columns1" | "Columns2" | "Columns3" | + "Columns4" | "Columns5" | "Grid1" | "Grid2" | "Grid3" | "Grid4" | + "Grid5" | "Grid6" | "Grid7" | "Grid8" | "List1" | "List2" | "List3" | + "List4" | "List5" | "List6" | "List7" | "List8" | "ThreeDEffects1" | + "ThreeDEffects2" | "ThreeDEffects3" | "Contemporary" | "Elegant" | + "Professional" | "Subtle1" | "Subtle2" | "Web1" | "Web2" | "Web3"; + return: + type: >- + | "None" | "Simple1" | + "Simple2" | "Simple3" | "Classic1" | "Classic2" | "Classic3" | + "Classic4" | "Colorful1" | "Colorful2" | "Colorful3" | "Columns1" | + "Columns2" | "Columns3" | "Columns4" | "Columns5" | "Grid1" | "Grid2" + | "Grid3" | "Grid4" | "Grid5" | "Grid6" | "Grid7" | "Grid8" | "List1" + | "List2" | "List3" | "List4" | "List5" | "List6" | "List7" | "List8" + | "ThreeDEffects1" | "ThreeDEffects2" | "ThreeDEffects3" | + "Contemporary" | "Elegant" | "Professional" | "Subtle1" | "Subtle2" | + "Web1" | "Web2" | "Web3" + - name: initialColumnWidth + uid: word!Word.SelectionConvertToTableOptions#initialColumnWidth:member + package: word! + fullName: initialColumnWidth + summary: >- + If provided, specifies the initial width of each column in the table, in + points. If omitted, Word calculates and adjusts the column width so that + the table stretches from margin to margin. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'initialColumnWidth?: number;' + return: + type: number + - name: numColumns + uid: word!Word.SelectionConvertToTableOptions#numColumns:member + package: word! + fullName: numColumns + summary: >- + If provided, specifies the number of columns in the table. If omitted, + Word determines the number of columns based on the contents of the range. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'numColumns?: number;' + return: + type: number + - name: numRows + uid: word!Word.SelectionConvertToTableOptions#numRows:member + package: word! + fullName: numRows + summary: >- + If provided, specifies the number of rows in the table. If omitted, Word + determines the number of rows based on the contents of the range. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'numRows?: number;' + return: + type: number + - name: separator + uid: word!Word.SelectionConvertToTableOptions#separator:member + package: word! + fullName: separator + summary: >- + If provided, specifies the character used to separate text into cells. The + default value is `-`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'separator?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/word/word/word.selectiondeleteoptions.yml b/docs/docs-ref-autogen/word/word/word.selectiondeleteoptions.yml new file mode 100644 index 0000000000..0bdc1a66a8 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.selectiondeleteoptions.yml @@ -0,0 +1,60 @@ +### YamlMime:TSType +name: Word.SelectionDeleteOptions +uid: word!Word.SelectionDeleteOptions:interface +package: word! +fullName: Word.SelectionDeleteOptions +summary: >- + Represents the options for the + [Selection.delete](xref:word!Word.Selection:class) method. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: count + uid: word!Word.SelectionDeleteOptions#count:member + package: word! + fullName: count + summary: >- + If provided, specifies the number of units to be deleted. To delete units + after the selection, collapse the selection and use a positive number. To + delete units before the selection, collapse the selection and use a + negative number. The default value is 1. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'count?: number;' + return: + type: number + - name: unit + uid: word!Word.SelectionDeleteOptions#unit:member + package: word! + fullName: unit + summary: >- + If provided, specifies the unit by which the collapsed selection is to be + deleted. The default value is `character`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | + "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" + | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | + "Item"; + return: + type: >- + | "Character" | "Word" | + "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | + "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | + "ParagraphFormat" | "Table" | "Item" diff --git a/docs/docs-ref-autogen/word/word/word.selectiongotooptions.yml b/docs/docs-ref-autogen/word/word/word.selectiongotooptions.yml new file mode 100644 index 0000000000..b380b95281 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.selectiongotooptions.yml @@ -0,0 +1,95 @@ +### YamlMime:TSType +name: Word.SelectionGoToOptions +uid: word!Word.SelectionGoToOptions:interface +package: word! +fullName: Word.SelectionGoToOptions +summary: >- + Represents the options for the + [Selection.goTo](xref:word!Word.Selection:class) method. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: count + uid: word!Word.SelectionGoToOptions#count:member + package: word! + fullName: count + summary: >- + If provided, specifies the number of the item in the document. Only + positive values are valid. The default value is 1. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'count?: number;' + return: + type: number + - name: direction + uid: word!Word.SelectionGoToOptions#direction:member + package: word! + fullName: direction + summary: >- + If provided, specifies the direction the range or selection is moved to. + The default value is `next`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'direction?: Word.GoToDirection | "First" | "Last" | "Next" | "Previous";' + return: + type: >- + | "First" | "Last" | + "Next" | "Previous" + - name: item + uid: word!Word.SelectionGoToOptions#item:member + package: word! + fullName: item + summary: >- + If provided, specifies the kind of item the range or selection is moved + to. The default value is `page`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + item?: Word.GoToItem | "Bookmark" | "Comment" | "Endnote" | "Field" | + "Footnote" | "Graphic" | "Heading" | "Line" | "Page" | "Section" | + "Table" | "EmbeddedObject" | "Equation" | "Percent" | "SpellingError" | + "GrammaticalError" | "ProofreadingError"; + return: + type: >- + | "Bookmark" | "Comment" | + "Endnote" | "Field" | "Footnote" | "Graphic" | "Heading" | "Line" | + "Page" | "Section" | "Table" | "EmbeddedObject" | "Equation" | + "Percent" | "SpellingError" | "GrammaticalError" | "ProofreadingError" + - name: name + uid: word!Word.SelectionGoToOptions#name:member + package: word! + fullName: name + summary: >- + If provided, specifies the name if the `item` property is set to + [Word.GoToItem](xref:word!Word.GoToItem:enum) type `bookmark`, + `comment`, `field`, or `object`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'name?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/word/word/word.selectioninsertcrossreferenceoptions.yml b/docs/docs-ref-autogen/word/word/word.selectioninsertcrossreferenceoptions.yml new file mode 100644 index 0000000000..c25a091019 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.selectioninsertcrossreferenceoptions.yml @@ -0,0 +1,90 @@ +### YamlMime:TSType +name: Word.SelectionInsertCrossReferenceOptions +uid: word!Word.SelectionInsertCrossReferenceOptions:interface +package: word! +fullName: Word.SelectionInsertCrossReferenceOptions +summary: >- + Represents the options for the + [Selection.insertCrossReference](xref:word!Word.Selection:class) method. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: includePosition + uid: word!Word.SelectionInsertCrossReferenceOptions#includePosition:member + package: word! + fullName: includePosition + summary: >- + If provided, specifies whether to include position. `true` to insert + "above" or "below," depending on the location of the reference item in + relation to the cross-reference. The default value is `false`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'includePosition?: boolean;' + return: + type: boolean + - name: insertAsHyperlink + uid: word!Word.SelectionInsertCrossReferenceOptions#insertAsHyperlink:member + package: word! + fullName: insertAsHyperlink + summary: >- + If provided, specifies whether to insert the cross-reference as a + hyperlink. The default value is `false`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'insertAsHyperlink?: boolean;' + return: + type: boolean + - name: separateNumbers + uid: word!Word.SelectionInsertCrossReferenceOptions#separateNumbers:member + package: word! + fullName: separateNumbers + summary: >- + If provided, specifies whether to use a separator to separate the numbers + from the associated text. The default value is `false`. (Use only + if the `referenceType` parameter is set to `numberedItem` and the + `referenceKind` parameter is set to `numberFullContext` when the + `Selection.insertCrossReference` method is called.) + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'separateNumbers?: boolean;' + return: + type: boolean + - name: separatorString + uid: word!Word.SelectionInsertCrossReferenceOptions#separatorString:member + package: word! + fullName: separatorString + summary: >- + If provided, specifies the string to use as a separator if the + `separateNumbers` parameter is set to `true` when the + `Selection.insertCrossReference` method is called. The default value is " + ". + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'separatorString?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/word/word/word.selectioninsertdatetimeoptions.yml b/docs/docs-ref-autogen/word/word/word.selectioninsertdatetimeoptions.yml new file mode 100644 index 0000000000..3568624c5e --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.selectioninsertdatetimeoptions.yml @@ -0,0 +1,116 @@ +### YamlMime:TSType +name: Word.SelectionInsertDateTimeOptions +uid: word!Word.SelectionInsertDateTimeOptions:interface +package: word! +fullName: Word.SelectionInsertDateTimeOptions +summary: >- + Represents the options for the + [Selection.insertDateTime](xref:word!Word.Selection:class) method. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: calendarType + uid: word!Word.SelectionInsertDateTimeOptions#calendarType:member + package: word! + fullName: calendarType + summary: >- + If provided, specifies the calendar type to use when displaying the date + or time. This property may not be available to you, depending on the + language support (U.S. English, for example) that you have selected or + installed. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + calendarType?: Word.CalendarTypeBidirectional | "Gregorian" | + "Bidirectional"; + return: + type: >- + | "Gregorian" + | "Bidirectional" + - name: dateLanguage + uid: word!Word.SelectionInsertDateTimeOptions#dateLanguage:member + package: word! + fullName: dateLanguage + summary: >- + If provided, specifies the language in which to display the date or time. + This property may not be available to you, depending on the language + support (U.S. English, for example) that you have selected or installed. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'dateLanguage?: Word.DateLanguage | "Bidirectional" | "Latin";' + return: + type: | "Bidirectional" | "Latin" + - name: dateTimeFormat + uid: word!Word.SelectionInsertDateTimeOptions#dateTimeFormat:member + package: word! + fullName: dateTimeFormat + summary: >- + If provided, specifies the format to be used for displaying the date or + time, or both. If this property is omitted, Microsoft Word uses the + short-date style from the Windows Control Panel (Regional Settings icon). + See [Date/Time data + type](https://support.microsoft.com/office/47fbbdc1-52fa-416a-b8d5-ba24d881b698) + for format symbols. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'dateTimeFormat?: string;' + return: + type: string + - name: insertAsField + uid: word!Word.SelectionInsertDateTimeOptions#insertAsField:member + package: word! + fullName: insertAsField + summary: >- + If provided, specifies whether to insert the specified information as a + [TIME + field](https://support.microsoft.com/office/6cb8fcef-310a-4646-ae6b-886d88335c90). The default value is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'insertAsField?: boolean;' + return: + type: boolean + - name: insertAsFullWidth + uid: word!Word.SelectionInsertDateTimeOptions#insertAsFullWidth:member + package: word! + fullName: insertAsFullWidth + summary: >- + If provided, specifies whether to insert the specified information as + full-width (double-byte) digits. This property may not be available to + you, depending on the language support (U.S. English, for example) that + you have selected or installed. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'insertAsFullWidth?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.selectioninsertformulaoptions.yml b/docs/docs-ref-autogen/word/word/word.selectioninsertformulaoptions.yml new file mode 100644 index 0000000000..f8b785a7f9 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.selectioninsertformulaoptions.yml @@ -0,0 +1,78 @@ +### YamlMime:TSType +name: Word.SelectionInsertFormulaOptions +uid: word!Word.SelectionInsertFormulaOptions:interface +package: word! +fullName: Word.SelectionInsertFormulaOptions +summary: >- + Represents the options for the + [Selection.insertFormula](xref:word!Word.Selection:class) method +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: formula + uid: word!Word.SelectionInsertFormulaOptions#formula:member + package: word! + fullName: formula + summary: >- + If provided, specifies the mathematical formula you want the [= (Formula) + field](https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d) + to evaluate. The `formula` property is optional only if the selection is + in a cell and there is at least one cell that contains a value above or to + the left of the cell that contains the insertion point. If the cells above + the insertion point contain values, the inserted field is + `{=SUM(ABOVE)}`; if the cells to the left of the insertion point + contain values, the inserted field is `{=SUM(LEFT)}`. If both the + cells above the insertion point and the cells to the left of it contain + values, Microsoft Word uses the following rules to determine which `SUM` + function to insert. + + + - If the cell immediately above the insertion point contains a value, Word + inserts `{=SUM(ABOVE)}`. + + + - If the cell immediately above the insertion point doesn't contain a + value but the cell immediately to the left of the insertion point does, + Word inserts `{=SUM(LEFT)}`. + + + - If neither cell immediately above the insertion point nor the cell + immediately below it contains a value, Word inserts `{=SUM(ABOVE)}`. + + + - If you don't specify the `formula` property and all the cells above and + to the left of the insertion point are empty, using the `= (Formula)` + field causes an error. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'formula?: string;' + return: + type: string + - name: numberFormat + uid: word!Word.SelectionInsertFormulaOptions#numberFormat:member + package: word! + fullName: numberFormat + summary: >- + If provided, specifies the format for the result of the `= (Formula)` + field. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'numberFormat?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/word/word/word.selectioninsertsymboloptions.yml b/docs/docs-ref-autogen/word/word/word.selectioninsertsymboloptions.yml new file mode 100644 index 0000000000..f3cfb891fa --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.selectioninsertsymboloptions.yml @@ -0,0 +1,71 @@ +### YamlMime:TSType +name: Word.SelectionInsertSymbolOptions +uid: word!Word.SelectionInsertSymbolOptions:interface +package: word! +fullName: Word.SelectionInsertSymbolOptions +summary: >- + Represents the options for the + [Selection.insertSymbol](xref:word!Word.Selection:class) method. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: bias + uid: word!Word.SelectionInsertSymbolOptions#bias:member + package: word! + fullName: bias + summary: >- + If provided, specifies the font bias for symbols. This argument is useful + for setting the correct font bias for East Asian characters. The default + value is `default`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'bias?: Word.FontBias | "Standard" | "FarEast" | "NoSpecified";' + return: + type: >- + | "Standard" | "FarEast" | + "NoSpecified" + - name: font + uid: word!Word.SelectionInsertSymbolOptions#font:member + package: word! + fullName: font + summary: If provided, specifies the name of the font that contains the symbol. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'font?: string;' + return: + type: string + - name: unicode + uid: word!Word.SelectionInsertSymbolOptions#unicode:member + package: word! + fullName: unicode + summary: >- + If provided, specifies whether the character is Unicode. `true` to insert + the Unicode character specified by the `characterNumber` property when the + `Selection.insertSymbol` method is called; `false` to instead insert the + ANSI character specified by the `characterNumber` property. The default + value is `false`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'unicode?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.selectionmoveleftrightoptions.yml b/docs/docs-ref-autogen/word/word/word.selectionmoveleftrightoptions.yml new file mode 100644 index 0000000000..62a1b5d8a5 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.selectionmoveleftrightoptions.yml @@ -0,0 +1,78 @@ +### YamlMime:TSType +name: Word.SelectionMoveLeftRightOptions +uid: word!Word.SelectionMoveLeftRightOptions:interface +package: word! +fullName: Word.SelectionMoveLeftRightOptions +summary: >- + Represents the options for the [Selection.moveLeft and + Selection.moveRight](xref:word!Word.Selection:class) methods. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: count + uid: word!Word.SelectionMoveLeftRightOptions#count:member + package: word! + fullName: count + summary: >- + If provided, specifies the number of units the selection is to be moved. + The default value is 1. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'count?: number;' + return: + type: number + - name: extend + uid: word!Word.SelectionMoveLeftRightOptions#extend:member + package: word! + fullName: extend + summary: >- + If provided, specifies the type of movement. The movement direction (left + or right) is according to the calling method. If set to `move`, + the selection is collapsed to the endpoint and moved in the appropriate + direction. If set to `extend`, the selection is extended in the + appropriate direction. The default value is `move`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'extend?: Word.MovementType | "Move" | "Extend";' + return: + type: | "Move" | "Extend" + - name: unit + uid: word!Word.SelectionMoveLeftRightOptions#unit:member + package: word! + fullName: unit + summary: >- + If provided, specifies the unit by which the selection is to be moved. The + default value is `character`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | + "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" + | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | + "Item"; + return: + type: >- + | "Character" | "Word" | + "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | + "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | + "ParagraphFormat" | "Table" | "Item" diff --git a/docs/docs-ref-autogen/word/word/word.selectionmoveoptions.yml b/docs/docs-ref-autogen/word/word/word.selectionmoveoptions.yml new file mode 100644 index 0000000000..a21c4cc241 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.selectionmoveoptions.yml @@ -0,0 +1,66 @@ +### YamlMime:TSType +name: Word.SelectionMoveOptions +uid: word!Word.SelectionMoveOptions:interface +package: word! +fullName: Word.SelectionMoveOptions +summary: >- + Represents the options for the + [Selection.move](xref:word!Word.Selection:class) method. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: count + uid: word!Word.SelectionMoveOptions#count:member + package: word! + fullName: count + summary: >- + If provided, specifies the number of units by which the range or selection + is to be moved. If `count` is a positive number, the object is collapsed + to its end position and moved backward in the document by the specified + number of units. If `count` is a negative number, the object is collapsed + to its start position and moved forward by the specified number of units. + The default value is 1. You can also control the collapse direction by + using the [Selection.collapse](xref:word!Word.Selection:class) method + before using the `move` method. If the range or selection is in the middle + of a unit or isn't collapsed, moving it to the beginning or end of the + unit counts as moving it one full unit. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'count?: number;' + return: + type: number + - name: unit + uid: word!Word.SelectionMoveOptions#unit:member + package: word! + fullName: unit + summary: >- + If provided, specifies the unit by which to move the ending character + position. The default value is `character`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | + "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" + | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | + "Item"; + return: + type: >- + | "Character" | "Word" | + "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | + "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | + "ParagraphFormat" | "Table" | "Item" diff --git a/docs/docs-ref-autogen/word/word/word.selectionmovestartendoptions.yml b/docs/docs-ref-autogen/word/word/word.selectionmovestartendoptions.yml new file mode 100644 index 0000000000..21028c9d32 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.selectionmovestartendoptions.yml @@ -0,0 +1,63 @@ +### YamlMime:TSType +name: Word.SelectionMoveStartEndOptions +uid: word!Word.SelectionMoveStartEndOptions:interface +package: word! +fullName: Word.SelectionMoveStartEndOptions +summary: >- + Represents the options for the [Selection.moveEnd and + Selection.moveStart](xref:word!Word.Selection:class) methods. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: count + uid: word!Word.SelectionMoveStartEndOptions#count:member + package: word! + fullName: count + summary: >- + If provided, specifies the number of units to move. The affected character + position (start or end) is according to the calling method. If this number + is positive, the position is moved forward in the document. If this number + is negative, the position is moved backward. If the affected position + encounters the other position, the selection is collapsed and both the + start and end positions move together. The default value is 1. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'count?: number;' + return: + type: number + - name: unit + uid: word!Word.SelectionMoveStartEndOptions#unit:member + package: word! + fullName: unit + summary: >- + If provided, specifies the unit by which the selection's start or end + position (per the calling method) is to be moved. The default value is + `character`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | + "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" + | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | + "Item"; + return: + type: >- + | "Character" | "Word" | + "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | + "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | + "ParagraphFormat" | "Table" | "Item" diff --git a/docs/docs-ref-autogen/word/word/word.selectionmoveupdownoptions.yml b/docs/docs-ref-autogen/word/word/word.selectionmoveupdownoptions.yml new file mode 100644 index 0000000000..b5ed66e1ca --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.selectionmoveupdownoptions.yml @@ -0,0 +1,78 @@ +### YamlMime:TSType +name: Word.SelectionMoveUpDownOptions +uid: word!Word.SelectionMoveUpDownOptions:interface +package: word! +fullName: Word.SelectionMoveUpDownOptions +summary: >- + Represents the options for the [Selection.moveUp and + Selection.moveDown](xref:word!Word.Selection:class) methods. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: count + uid: word!Word.SelectionMoveUpDownOptions#count:member + package: word! + fullName: count + summary: >- + If provided, specifies the number of units the selection is to be moved. + The default value is 1. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'count?: number;' + return: + type: number + - name: extend + uid: word!Word.SelectionMoveUpDownOptions#extend:member + package: word! + fullName: extend + summary: >- + If provided, specifies the type of movement. The movement direction (up or + down) is according to the calling method. If set to `move`, the + selection is collapsed to the endpoint and moved in the appropriate + direction. If set to `extend`, the selection is extended in the + appropriate direction. The default value is `move`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'extend?: Word.MovementType | "Move" | "Extend";' + return: + type: | "Move" | "Extend" + - name: unit + uid: word!Word.SelectionMoveUpDownOptions#unit:member + package: word! + fullName: unit + summary: >- + If provided, specifies the unit by which to move the selection. The + default value is `line`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | + "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" + | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | + "Item"; + return: + type: >- + | "Character" | "Word" | + "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | + "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | + "ParagraphFormat" | "Table" | "Item" diff --git a/docs/docs-ref-autogen/word/word/word.selectionnextoptions.yml b/docs/docs-ref-autogen/word/word/word.selectionnextoptions.yml new file mode 100644 index 0000000000..aee9a9ede7 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.selectionnextoptions.yml @@ -0,0 +1,58 @@ +### YamlMime:TSType +name: Word.SelectionNextOptions +uid: word!Word.SelectionNextOptions:interface +package: word! +fullName: Word.SelectionNextOptions +summary: >- + Represents the options for the + [Selection.next](xref:word!Word.Selection:class) method. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: count + uid: word!Word.SelectionNextOptions#count:member + package: word! + fullName: count + summary: >- + If provided, specifies the number of units by which you want to move + ahead. The default value is 1. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'count?: number;' + return: + type: number + - name: unit + uid: word!Word.SelectionNextOptions#unit:member + package: word! + fullName: unit + summary: >- + If provided, specifies the type of units by which to move the selection. + The default value is `character`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | + "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" + | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | + "Item"; + return: + type: >- + | "Character" | "Word" | + "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | + "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | + "ParagraphFormat" | "Table" | "Item" diff --git a/docs/docs-ref-autogen/word/word/word.selectionpreviousoptions.yml b/docs/docs-ref-autogen/word/word/word.selectionpreviousoptions.yml new file mode 100644 index 0000000000..3a0cefb6c9 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.selectionpreviousoptions.yml @@ -0,0 +1,58 @@ +### YamlMime:TSType +name: Word.SelectionPreviousOptions +uid: word!Word.SelectionPreviousOptions:interface +package: word! +fullName: Word.SelectionPreviousOptions +summary: >- + Represents the options for the + [Selection.previous](xref:word!Word.Selection:class) method. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: count + uid: word!Word.SelectionPreviousOptions#count:member + package: word! + fullName: count + summary: >- + If provided, specifies the number of units by which you want to move. The + default value is 1. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'count?: number;' + return: + type: number + - name: unit + uid: word!Word.SelectionPreviousOptions#unit:member + package: word! + fullName: unit + summary: >- + If provided, specifies the type of unit by which to move the selection. + The default value is `character`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | + "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" + | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | + "Item"; + return: + type: >- + | "Character" | "Word" | + "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | + "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | + "ParagraphFormat" | "Table" | "Item" diff --git a/docs/docs-ref-autogen/word/word/word.selectiontype.yml b/docs/docs-ref-autogen/word/word/word.selectiontype.yml new file mode 100644 index 0000000000..9981baa0c4 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.selectiontype.yml @@ -0,0 +1,103 @@ +### YamlMime:TSEnum +name: Word.SelectionType +uid: word!Word.SelectionType:enum +package: word! +fullName: Word.SelectionType +summary: Specifies the type of selection in the document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: block + uid: word!Word.SelectionType.block:member + package: word! + summary: >- + Represents a block selection. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Block"' + - name: column + uid: word!Word.SelectionType.column:member + package: word! + summary: >- + Represents a column selection. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Column"' + - name: frame + uid: word!Word.SelectionType.frame:member + package: word! + summary: >- + Represents a frame selection. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Frame"' + - name: inlineShape + uid: word!Word.SelectionType.inlineShape:member + package: word! + summary: >- + Represents an inline shape selection. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"InlineShape"' + - name: insertionPoint + uid: word!Word.SelectionType.insertionPoint:member + package: word! + summary: >- + Represents an insertion point (IP) selection. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"InsertionPoint"' + - name: normal + uid: word!Word.SelectionType.normal:member + package: word! + summary: >- + Represents a normal selection. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Normal"' + - name: noSelection + uid: word!Word.SelectionType.noSelection:member + package: word! + summary: >- + No selection is made. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"NoSelection"' + - name: row + uid: word!Word.SelectionType.row:member + package: word! + summary: >- + Represents a row selection. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Row"' + - name: selectionShape + uid: word!Word.SelectionType.selectionShape:member + package: word! + summary: >- + Represents a shape selection. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"SelectionShape"' diff --git a/docs/docs-ref-autogen/word/word/word.sortfieldtype.yml b/docs/docs-ref-autogen/word/word/word.sortfieldtype.yml new file mode 100644 index 0000000000..89d0d660de --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.sortfieldtype.yml @@ -0,0 +1,83 @@ +### YamlMime:TSEnum +name: Word.SortFieldType +uid: word!Word.SortFieldType:enum +package: word! +fullName: Word.SortFieldType +summary: Specifies the type of field to sort by. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: alphanumeric + uid: word!Word.SortFieldType.alphanumeric:member + package: word! + summary: >- + Sorts content alphanumerically. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Alphanumeric"' + - name: date + uid: word!Word.SortFieldType.date:member + package: word! + summary: >- + Sorts content by date. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Date"' + - name: japanJis + uid: word!Word.SortFieldType.japanJis:member + package: word! + summary: >- + Sorts content using the Japanese JIS standard. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"JapanJis"' + - name: koreaKs + uid: word!Word.SortFieldType.koreaKs:member + package: word! + summary: >- + Sorts content using the Korean KS standard. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"KoreaKs"' + - name: numeric + uid: word!Word.SortFieldType.numeric:member + package: word! + summary: >- + Sorts content numerically. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Numeric"' + - name: stroke + uid: word!Word.SortFieldType.stroke:member + package: word! + summary: >- + Sorts content by stroke count. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Stroke"' + - name: syllable + uid: word!Word.SortFieldType.syllable:member + package: word! + summary: >- + Sorts content by syllables. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Syllable"' diff --git a/docs/docs-ref-autogen/word/word/word.sortorder.yml b/docs/docs-ref-autogen/word/word/word.sortorder.yml new file mode 100644 index 0000000000..5fb7905283 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.sortorder.yml @@ -0,0 +1,33 @@ +### YamlMime:TSEnum +name: Word.SortOrder +uid: word!Word.SortOrder:enum +package: word! +fullName: Word.SortOrder +summary: Specifies the sort order. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: ascending + uid: word!Word.SortOrder.ascending:member + package: word! + summary: >- + Sorts in ascending order. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Ascending"' + - name: descending + uid: word!Word.SortOrder.descending:member + package: word! + summary: >- + Sorts in descending order. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Descending"' diff --git a/docs/docs-ref-autogen/word/word/word.table.yml b/docs/docs-ref-autogen/word/word/word.table.yml index deb03cfbc1..26c8e19d1a 100644 --- a/docs/docs-ref-autogen/word/word/word.table.yml +++ b/docs/docs-ref-autogen/word/word/word.table.yml @@ -80,6 +80,23 @@ properties: type: >- | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified" + - name: columns + uid: word!Word.Table#columns:member + package: word! + fullName: columns + summary: >- + Returns the `TableColumnCollection` object that represents the columns in + the table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly columns: Word.TableColumnCollection;' + return: + type: - name: context uid: word!Word.Table#context:member package: word! @@ -95,6 +112,21 @@ properties: content: 'context: RequestContext;' return: type: + - name: description + uid: word!Word.Table#description:member + package: word! + fullName: description + summary: Specifies the description of the table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'description: string;' + return: + type: string - name: endnotes uid: word!Word.Table#endnotes:member package: word! @@ -428,6 +460,23 @@ properties: content: 'readonly rows: Word.TableRowCollection;' return: type: + - name: shading + uid: word!Word.Table#shading:member + package: word! + fullName: shading + summary: >- + Returns the `ShadingUniversal` object that represents the shading of the + table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly shading: Word.ShadingUniversal;' + return: + type: - name: shadingColor uid: word!Word.Table#shadingColor:member package: word! @@ -675,6 +724,21 @@ properties: content: 'readonly tables: Word.TableCollection;' return: type: + - name: title + uid: word!Word.Table#title:member + package: word! + fullName: title + summary: Specifies the title of the table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'title: string;' + return: + type: string - name: values uid: word!Word.Table#values:member package: word! @@ -823,6 +887,76 @@ methods: return: type: description: '' + - name: applyStyleDirectFormatting(styleName) + uid: word!Word.Table#applyStyleDirectFormatting:member(1) + package: word! + fullName: applyStyleDirectFormatting(styleName) + summary: >- + Applies the specified style but maintains any formatting that a user + directly applies. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'applyStyleDirectFormatting(styleName: string): void;' + parameters: + - id: styleName + description: The name of the style to apply. + type: string + return: + type: void + description: '' + - name: autoFitBehavior(behavior) + uid: word!Word.Table#autoFitBehavior:member(1) + package: word! + fullName: autoFitBehavior(behavior) + summary: >- + Determines how Microsoft Word resizes a table when the AutoFit feature is + used. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'autoFitBehavior(behavior: Word.AutoFitBehavior): void;' + parameters: + - id: behavior + description: >- + How Word resizes the specified table with the AutoFit feature is + used. + type: + return: + type: void + description: '' + - name: autoFitBehavior(behavior) + uid: word!Word.Table#autoFitBehavior:member(2) + package: word! + fullName: autoFitBehavior(behavior) + summary: >- + Determines how Microsoft Word resizes a table when the AutoFit feature is + used. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'autoFitBehavior(behavior: "FixedSize" | "Content" | "Window"): void;' + parameters: + - id: behavior + description: >- + How Word resizes the specified table with the AutoFit feature is + used. + type: '"FixedSize" | "Content" | "Window"' + return: + type: void + description: '' - name: autoFitWindow() uid: word!Word.Table#autoFitWindow:member(1) package: word! @@ -839,6 +973,28 @@ methods: return: type: void description: '' + - name: autoFormat(options) + uid: word!Word.Table#autoFormat:member(1) + package: word! + fullName: autoFormat(options) + summary: Applies a predefined look to a table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'autoFormat(options?: Word.TableAutoFormatOptions): void;' + parameters: + - id: options + description: >- + Optional. An object that specifies the options for applying the + table format. + type: + return: + type: void + description: '' - name: clear() uid: word!Word.Table#clear:member(1) package: word! @@ -855,6 +1011,28 @@ methods: return: type: void description: '' + - name: convertToText(options) + uid: word!Word.Table#convertToText:member(1) + package: word! + fullName: convertToText(options) + summary: Converts a table to text. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'convertToText(options?: Word.TableConvertToTextOptions): Word.Range;' + parameters: + - id: options + description: >- + An object that specifies the options for converting the table to + text. + type: + return: + type: + description: A `Range` object that represents the converted text. - name: delete() uid: word!Word.Table#delete:member(1) package: word! @@ -1492,6 +1670,25 @@ methods: return: type: description: '' + - name: reapplyAutoFormat() + uid: word!Word.Table#reapplyAutoFormat:member(1) + package: word! + fullName: reapplyAutoFormat() + summary: >- + Updates the table with the characteristics of the predefined table format + set when the `autoFormat` method was called. The default predefined format + is [TableFormatType.none](xref:word!Word.TableFormatType:enum). + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'reapplyAutoFormat(): void;' + return: + type: void + description: '' - name: search(searchText, searchOptions) uid: word!Word.Table#search:member(1) package: word! @@ -1688,6 +1885,26 @@ methods: return: type: void description: '' + - name: sort(options) + uid: word!Word.Table#sort:member(1) + package: word! + fullName: sort(options) + summary: Sorts the specified table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'sort(options?: Word.TableSortOptions): void;' + parameters: + - id: options + description: An object that specifies the options for sorting the table. + type: + return: + type: void + description: '' - name: toJSON() uid: word!Word.Table#toJSON:member(1) package: word! diff --git a/docs/docs-ref-autogen/word/word/word.tableautoformatoptions.yml b/docs/docs-ref-autogen/word/word/word.tableautoformatoptions.yml new file mode 100644 index 0000000000..69f06127ab --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.tableautoformatoptions.yml @@ -0,0 +1,205 @@ +### YamlMime:TSType +name: Word.TableAutoFormatOptions +uid: word!Word.TableAutoFormatOptions:interface +package: word! +fullName: Word.TableAutoFormatOptions +summary: >- + Represents the options for the [Table.autoFormat](xref:word!Word.Table:class) + method. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: applyBorders + uid: word!Word.TableAutoFormatOptions#applyBorders:member + package: word! + fullName: applyBorders + summary: >- + If provided, specifies whether to apply borders of the specified format. + The default value is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'applyBorders?: boolean;' + return: + type: boolean + - name: applyColor + uid: word!Word.TableAutoFormatOptions#applyColor:member + package: word! + fullName: applyColor + summary: >- + If provided, specifies whether to apply color of the specified format. The + default value is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'applyColor?: boolean;' + return: + type: boolean + - name: applyFirstColumn + uid: word!Word.TableAutoFormatOptions#applyFirstColumn:member + package: word! + fullName: applyFirstColumn + summary: >- + If provided, specifies whether to apply first column formatting of the + specified format. The default value is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'applyFirstColumn?: boolean;' + return: + type: boolean + - name: applyFont + uid: word!Word.TableAutoFormatOptions#applyFont:member + package: word! + fullName: applyFont + summary: >- + If provided, specifies whether to apply font of the specified format. The + default value is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'applyFont?: boolean;' + return: + type: boolean + - name: applyHeadingRows + uid: word!Word.TableAutoFormatOptions#applyHeadingRows:member + package: word! + fullName: applyHeadingRows + summary: >- + If provided, specifies whether to apply heading row formatting of the + specified format. The default value is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'applyHeadingRows?: boolean;' + return: + type: boolean + - name: applyLastColumn + uid: word!Word.TableAutoFormatOptions#applyLastColumn:member + package: word! + fullName: applyLastColumn + summary: >- + If provided, specifies whether to apply last column formatting of the + specified format. The default value is `false`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'applyLastColumn?: boolean;' + return: + type: boolean + - name: applyLastRow + uid: word!Word.TableAutoFormatOptions#applyLastRow:member + package: word! + fullName: applyLastRow + summary: >- + If provided, specifies whether to apply last row formatting of the + specified format. The default value is `false`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'applyLastRow?: boolean;' + return: + type: boolean + - name: applyShading + uid: word!Word.TableAutoFormatOptions#applyShading:member + package: word! + fullName: applyShading + summary: >- + If provided, specifies whether to apply shading of the specified format. + The default value is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'applyShading?: boolean;' + return: + type: boolean + - name: autoFit + uid: word!Word.TableAutoFormatOptions#autoFit:member + package: word! + fullName: autoFit + summary: >- + If provided, specifies whether to decrease the width of the table columns + as much as possible without changing the way text wraps in the cells. The + default value is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'autoFit?: boolean;' + return: + type: boolean + - name: format + uid: word!Word.TableAutoFormatOptions#format:member + package: word! + fullName: format + summary: >- + If provided, specifies the format to apply. The default value is + `simple1`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + format?: Word.TableFormatType | "None" | "Simple1" | "Simple2" | + "Simple3" | "Classic1" | "Classic2" | "Classic3" | "Classic4" | + "Colorful1" | "Colorful2" | "Colorful3" | "Columns1" | "Columns2" | + "Columns3" | "Columns4" | "Columns5" | "Grid1" | "Grid2" | "Grid3" | + "Grid4" | "Grid5" | "Grid6" | "Grid7" | "Grid8" | "List1" | "List2" | + "List3" | "List4" | "List5" | "List6" | "List7" | "List8" | + "ThreeDEffects1" | "ThreeDEffects2" | "ThreeDEffects3" | "Contemporary" + | "Elegant" | "Professional" | "Subtle1" | "Subtle2" | "Web1" | "Web2" | + "Web3"; + return: + type: >- + | "None" | "Simple1" | + "Simple2" | "Simple3" | "Classic1" | "Classic2" | "Classic3" | + "Classic4" | "Colorful1" | "Colorful2" | "Colorful3" | "Columns1" | + "Columns2" | "Columns3" | "Columns4" | "Columns5" | "Grid1" | "Grid2" + | "Grid3" | "Grid4" | "Grid5" | "Grid6" | "Grid7" | "Grid8" | "List1" + | "List2" | "List3" | "List4" | "List5" | "List6" | "List7" | "List8" + | "ThreeDEffects1" | "ThreeDEffects2" | "ThreeDEffects3" | + "Contemporary" | "Elegant" | "Professional" | "Subtle1" | "Subtle2" | + "Web1" | "Web2" | "Web3" diff --git a/docs/docs-ref-autogen/word/word/word.tablecell.yml b/docs/docs-ref-autogen/word/word/word.tablecell.yml index 679d9d9420..759af04e2a 100644 --- a/docs/docs-ref-autogen/word/word/word.tablecell.yml +++ b/docs/docs-ref-autogen/word/word/word.tablecell.yml @@ -67,6 +67,23 @@ properties: content: 'readonly cellIndex: number;' return: type: number + - name: column + uid: word!Word.TableCell#column:member + package: word! + fullName: column + summary: >- + Returns the `TableColumn` object that represents the table column that + contains this cell. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly column: Word.TableColumn;' + return: + type: - name: columnWidth uid: word!Word.TableCell#columnWidth:member package: word! @@ -190,6 +207,23 @@ properties: content: 'readonly rowIndex: number;' return: type: number + - name: shading + uid: word!Word.TableCell#shading:member + package: word! + fullName: shading + summary: >- + Returns the `ShadingUniversal` object that represents the shading of the + table cell. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly shading: Word.ShadingUniversal;' + return: + type: - name: shadingColor uid: word!Word.TableCell#shadingColor:member package: word! @@ -284,6 +318,50 @@ properties: return: type: number methods: + - name: autoSum() + uid: word!Word.TableCell#autoSum:member(1) + package: word! + fullName: autoSum() + summary: >- + Inserts a [= (Formula) + field](https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d) + that calculates and displays the sum of the values in table cells above or + to the left of the cell specified in the expression. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'autoSum(): void;' + return: + type: void + description: '' + - name: delete(shiftCells) + uid: word!Word.TableCell#delete:member(1) + package: word! + fullName: delete(shiftCells) + summary: >- + Deletes the table cell and optionally controls how the remaining cells are + shifted. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'delete(shiftCells: any): void;' + parameters: + - id: shiftCells + description: >- + Optional. Specifies how the remaining cells are shifted after the + deletion. The default is `shiftLeft`. + type: any + return: + type: void + description: '' - name: deleteColumn() uid: word!Word.TableCell#deleteColumn:member(1) package: word! @@ -318,6 +396,29 @@ methods: return: type: void description: '' + - name: formula(options) + uid: word!Word.TableCell#formula:member(1) + package: word! + fullName: formula(options) + summary: >- + Inserts a [= (Formula) + field](https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d) + that contains the specified formula into a table cell. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'formula(options?: Word.TableCellFormulaOptions): void;' + parameters: + - id: options + description: Optional. An object that specifies the options for the formula. + type: + return: + type: void + description: '' - name: getBorder(borderLocation) uid: word!Word.TableCell#getBorder:member(1) package: word! @@ -647,6 +748,42 @@ methods: return: type: description: '' + - name: merge(mergeTo) + uid: word!Word.TableCell#merge:member(1) + package: word! + fullName: merge(mergeTo) + summary: Merges this table cell with the specified table cell. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'merge(mergeTo: Word.TableCell): void;' + parameters: + - id: mergeTo + description: The cell to be merged with. + type: + return: + type: void + description: '' + - name: select() + uid: word!Word.TableCell#select:member(1) + package: word! + fullName: select() + summary: Selects the table cell. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'select(): void;' + return: + type: void + description: '' - name: set(properties, options) uid: word!Word.TableCell#set:member(1) package: word! diff --git a/docs/docs-ref-autogen/word/word/word.tablecellcollection.yml b/docs/docs-ref-autogen/word/word/word.tablecellcollection.yml index 1982effcc7..85ada027df 100644 --- a/docs/docs-ref-autogen/word/word/word.tablecellcollection.yml +++ b/docs/docs-ref-autogen/word/word/word.tablecellcollection.yml @@ -66,6 +66,106 @@ properties: return: type: [] methods: + - name: autoFit() + uid: word!Word.TableCellCollection#autoFit:member(1) + package: word! + fullName: autoFit() + summary: >- + Changes the width of a table column to accommodate the width of the text + without changing the way text wraps in the cells. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'autoFit(): void;' + return: + type: void + description: '' + - name: delete(shiftCells) + uid: word!Word.TableCellCollection#delete:member(1) + package: word! + fullName: delete(shiftCells) + summary: >- + Deletes the table cells and optionally controls how the remaining cells + are shifted. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'delete(shiftCells?: Word.DeleteCells): void;' + parameters: + - id: shiftCells + description: >- + Optional. Specifies how the remaining cells are shifted after the + deletion. The default is `shiftLeft`. + type: + return: + type: void + description: '' + - name: delete(shiftCells) + uid: word!Word.TableCellCollection#delete:member(2) + package: word! + fullName: delete(shiftCells) + summary: >- + Deletes the table cells and optionally controls how the remaining cells + are shifted. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + delete(shiftCells?: "ShiftLeft" | "ShiftUp" | "EntireRow" | + "EntireColumn"): void; + parameters: + - id: shiftCells + description: >- + Optional. Specifies how the remaining cells are shifted after the + deletion. The default is `shiftLeft`. + type: '"ShiftLeft" | "ShiftUp" | "EntireRow" | "EntireColumn"' + return: + type: void + description: '' + - name: distributeHeight() + uid: word!Word.TableCellCollection#distributeHeight:member(1) + package: word! + fullName: distributeHeight() + summary: Adjusts the height of the specified cells so that they are equal. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'distributeHeight(): void;' + return: + type: void + description: '' + - name: distributeWidth() + uid: word!Word.TableCellCollection#distributeWidth:member(1) + package: word! + fullName: distributeWidth() + summary: Adjusts the width of the specified cells so that they are equal. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'distributeWidth(): void;' + return: + type: void + description: '' - name: getFirst() uid: word!Word.TableCellCollection#getFirst:member(1) package: word! @@ -180,6 +280,138 @@ methods: return: type: description: '' + - name: merge() + uid: word!Word.TableCellCollection#merge:member(1) + package: word! + fullName: merge() + summary: Merges the specified cells into a single cell. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'merge(): void;' + return: + type: void + description: '' + - name: setHeight(rowHeight, heightRule) + uid: word!Word.TableCellCollection#setHeight:member(1) + package: word! + fullName: setHeight(rowHeight, heightRule) + summary: Sets the height of the cells in a table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'setHeight(rowHeight: number, heightRule: Word.RowHeightRule): void;' + parameters: + - id: rowHeight + description: The height of the row to set, in points. + type: number + - id: heightRule + description: The rule for determining the height of the specified rows. + type: + return: + type: void + description: '' + - name: setHeight(rowHeight, heightRule) + uid: word!Word.TableCellCollection#setHeight:member(2) + package: word! + fullName: setHeight(rowHeight, heightRule) + summary: Sets the height of the cells in a table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + setHeight(rowHeight: number, heightRule: "Auto" | "AtLeast" | + "Exactly"): void; + parameters: + - id: rowHeight + description: The height of the row to set, in points. + type: number + - id: heightRule + description: The rule for determining the height of the specified rows. + type: '"Auto" | "AtLeast" | "Exactly"' + return: + type: void + description: '' + - name: setWidth(columnWidth, rulerStyle) + uid: word!Word.TableCellCollection#setWidth:member(1) + package: word! + fullName: setWidth(columnWidth, rulerStyle) + summary: Sets the width of the cells in a table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'setWidth(columnWidth: number, rulerStyle: Word.RulerStyle): void;' + parameters: + - id: columnWidth + description: The width of the row to set, in points. + type: number + - id: rulerStyle + description: The ruler style to apply. + type: + return: + type: void + description: '' + - name: setWidth(columnWidth, rulerStyle) + uid: word!Word.TableCellCollection#setWidth:member(2) + package: word! + fullName: setWidth(columnWidth, rulerStyle) + summary: Sets the width of the cells in a table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + setWidth(columnWidth: number, rulerStyle: "None" | "Proportional" | + "FirstColumn" | "SameWidth"): void; + parameters: + - id: columnWidth + description: The width of the row to set, in points. + type: number + - id: rulerStyle + description: The ruler style to apply. + type: '"None" | "Proportional" | "FirstColumn" | "SameWidth"' + return: + type: void + description: '' + - name: split(options) + uid: word!Word.TableCellCollection#split:member(1) + package: word! + fullName: split(options) + summary: Splits this range of table cells. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'split(options?: Word.TableCellCollectionSplitOptions): void;' + parameters: + - id: options + description: TableCellCollectionSplitOptions. + type: + return: + type: void + description: '' - name: toJSON() uid: word!Word.TableCellCollection#toJSON:member(1) package: word! diff --git a/docs/docs-ref-autogen/word/word/word.tablecellcollectionsplitoptions.yml b/docs/docs-ref-autogen/word/word/word.tablecellcollectionsplitoptions.yml new file mode 100644 index 0000000000..6b9efc4c2b --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.tablecellcollectionsplitoptions.yml @@ -0,0 +1,67 @@ +### YamlMime:TSType +name: Word.TableCellCollectionSplitOptions +uid: word!Word.TableCellCollectionSplitOptions:interface +package: word! +fullName: Word.TableCellCollectionSplitOptions +summary: >- + Represents the options for the + [TableCellCollection.split](xref:word!Word.TableCellCollection:class) method. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: mergeBeforeSplit + uid: word!Word.TableCellCollectionSplitOptions#mergeBeforeSplit:member + package: word! + fullName: mergeBeforeSplit + summary: >- + If provided, specifies whether to merge the cells with one another before + splitting them. The default value is `false`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'mergeBeforeSplit?: boolean;' + return: + type: boolean + - name: numColumns + uid: word!Word.TableCellCollectionSplitOptions#numColumns:member + package: word! + fullName: numColumns + summary: >- + If provided, specifies the number of columns that the group of cells is to + be split into. The default value is 1. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'numColumns?: number;' + return: + type: number + - name: numRows + uid: word!Word.TableCellCollectionSplitOptions#numRows:member + package: word! + fullName: numRows + summary: >- + If provided, specifies the number of rows that the group of cells is to be + split into. The default value is 1. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'numRows?: number;' + return: + type: number diff --git a/docs/docs-ref-autogen/word/word/word.tablecellformulaoptions.yml b/docs/docs-ref-autogen/word/word/word.tablecellformulaoptions.yml new file mode 100644 index 0000000000..24b24a9b96 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.tablecellformulaoptions.yml @@ -0,0 +1,56 @@ +### YamlMime:TSType +name: Word.TableCellFormulaOptions +uid: word!Word.TableCellFormulaOptions:interface +package: word! +fullName: Word.TableCellFormulaOptions +summary: >- + Represents the options for the + [TableCell.formula](xref:word!Word.TableCell:class) method. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: formula + uid: word!Word.TableCellFormulaOptions#formula:member + package: word! + fullName: formula + summary: >- + The mathematical formula you want the = (Formula) field to evaluate. + Spreadsheet-type references to table cells are valid. For example, + "=SUM(A4:C4)" specifies the first three values in the fourth row. For more + information about the = (Formula) field, see [Field codes: = (Formula) + field](https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d). + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'formula?: string;' + return: + type: string + - name: numFormat + uid: word!Word.TableCellFormulaOptions#numFormat:member + package: word! + fullName: numFormat + summary: >- + A format for the result of the [= (Formula) + field](https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d). For information about the types of formats you can apply, see the + Numeric Picture (\#) field switch. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'numFormat?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/word/word/word.tablecellinsertionlocation.yml b/docs/docs-ref-autogen/word/word/word.tablecellinsertionlocation.yml new file mode 100644 index 0000000000..a9d9f5934d --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.tablecellinsertionlocation.yml @@ -0,0 +1,54 @@ +### YamlMime:TSEnum +name: Word.TableCellInsertionLocation +uid: word!Word.TableCellInsertionLocation:enum +package: word! +fullName: Word.TableCellInsertionLocation +summary: Specifies where and what type of cells to add to an existing table. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: shiftColumnRight + uid: word!Word.TableCellInsertionLocation.shiftColumnRight:member + package: word! + summary: >- + Inserts an entire column to the left of the column that contains the + selection. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"ShiftColumnRight"' + - name: shiftDown + uid: word!Word.TableCellInsertionLocation.shiftDown:member + package: word! + summary: >- + Inserts new cells above the selected cells. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"ShiftDown"' + - name: shiftRight + uid: word!Word.TableCellInsertionLocation.shiftRight:member + package: word! + summary: >- + Inserts new cells to the left of the selected cells. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"ShiftRight"' + - name: shiftRowDown + uid: word!Word.TableCellInsertionLocation.shiftRowDown:member + package: word! + summary: >- + Inserts an entire row above the row that contains the selection. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"ShiftRowDown"' diff --git a/docs/docs-ref-autogen/word/word/word.tableconverttotextoptions.yml b/docs/docs-ref-autogen/word/word/word.tableconverttotextoptions.yml new file mode 100644 index 0000000000..c282fe44d4 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.tableconverttotextoptions.yml @@ -0,0 +1,59 @@ +### YamlMime:TSType +name: Word.TableConvertToTextOptions +uid: word!Word.TableConvertToTextOptions:interface +package: word! +fullName: Word.TableConvertToTextOptions +summary: >- + Represents the options for the + [Table.convertToText](xref:word!Word.Table:class), + [TableRow.convertToText](xref:word!Word.TableRow:class), and + [TableRowCollection.convertToText](xref:word!Word.TableRowCollection:class) + methods. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: nestedTables + uid: word!Word.TableConvertToTextOptions#nestedTables:member + package: word! + fullName: nestedTables + summary: >- + If provided, specifies whether to convert the nested tables to text. This + property is ignored if the `separator` property isn't set to + `paragraph`. The default is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'nestedTables?: boolean;' + return: + type: boolean + - name: separator + uid: word!Word.TableConvertToTextOptions#separator:member + package: word! + fullName: separator + summary: >- + If provided, specifies the character that delimits the converted columns + (paragraph marks delimit the converted rows). The default is `tab`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + separator?: Word.TableFieldSeparator | "Paragraph" | "Tab" | "Comma" | + "DefaultListSeparator"; + return: + type: >- + | "Paragraph" | + "Tab" | "Comma" | "DefaultListSeparator" diff --git a/docs/docs-ref-autogen/word/word/word.tabledirection.yml b/docs/docs-ref-autogen/word/word/word.tabledirection.yml new file mode 100644 index 0000000000..bcaa236590 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.tabledirection.yml @@ -0,0 +1,35 @@ +### YamlMime:TSEnum +name: Word.TableDirection +uid: word!Word.TableDirection:enum +package: word! +fullName: Word.TableDirection +summary: >- + Specifies the direction in which Microsoft Word orders cells in the specified + table or row. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: leftToRight + uid: word!Word.TableDirection.leftToRight:member + package: word! + summary: >- + The table is arranged with the first column in the leftmost position. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"LeftToRight"' + - name: rightToLeft + uid: word!Word.TableDirection.rightToLeft:member + package: word! + summary: >- + The table is arranged with the first column in the rightmost position. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"RightToLeft"' diff --git a/docs/docs-ref-autogen/word/word/word.tablefieldseparator.yml b/docs/docs-ref-autogen/word/word/word.tablefieldseparator.yml new file mode 100644 index 0000000000..59e568a97d --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.tablefieldseparator.yml @@ -0,0 +1,53 @@ +### YamlMime:TSEnum +name: Word.TableFieldSeparator +uid: word!Word.TableFieldSeparator:enum +package: word! +fullName: Word.TableFieldSeparator +summary: Specifies the character used to separate fields in a table. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: comma + uid: word!Word.TableFieldSeparator.comma:member + package: word! + summary: >- + Uses the comma. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Comma"' + - name: defaultListSeparator + uid: word!Word.TableFieldSeparator.defaultListSeparator:member + package: word! + summary: >- + Uses the default list separator. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"DefaultListSeparator"' + - name: paragraph + uid: word!Word.TableFieldSeparator.paragraph:member + package: word! + summary: >- + Uses the paragraph marker. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Paragraph"' + - name: tab + uid: word!Word.TableFieldSeparator.tab:member + package: word! + summary: >- + Uses the tab. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Tab"' diff --git a/docs/docs-ref-autogen/word/word/word.tableformat.yml b/docs/docs-ref-autogen/word/word/word.tableformat.yml new file mode 100644 index 0000000000..1313fdba0f --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.tableformat.yml @@ -0,0 +1,443 @@ +### YamlMime:TSEnum +name: Word.TableFormat +uid: word!Word.TableFormat:enum +package: word! +fullName: Word.TableFormat +summary: Specifies the predefined table formatting options. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: classic1 + uid: word!Word.TableFormat.classic1:member + package: word! + summary: >- + Applies the classic 1 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Classic1"' + - name: classic2 + uid: word!Word.TableFormat.classic2:member + package: word! + summary: >- + Applies the classic 2 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Classic2"' + - name: classic3 + uid: word!Word.TableFormat.classic3:member + package: word! + summary: >- + Applies the classic 3 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Classic3"' + - name: classic4 + uid: word!Word.TableFormat.classic4:member + package: word! + summary: >- + Applies the classic 4 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Classic4"' + - name: colorful1 + uid: word!Word.TableFormat.colorful1:member + package: word! + summary: >- + Applies the colorful 1 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Colorful1"' + - name: colorful2 + uid: word!Word.TableFormat.colorful2:member + package: word! + summary: >- + Applies the colorful 2 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Colorful2"' + - name: colorful3 + uid: word!Word.TableFormat.colorful3:member + package: word! + summary: >- + Applies the colorful 3 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Colorful3"' + - name: columns1 + uid: word!Word.TableFormat.columns1:member + package: word! + summary: >- + Applies the columns 1 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Columns1"' + - name: columns2 + uid: word!Word.TableFormat.columns2:member + package: word! + summary: >- + Applies the columns 2 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Columns2"' + - name: columns3 + uid: word!Word.TableFormat.columns3:member + package: word! + summary: >- + Applies the columns 3 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Columns3"' + - name: columns4 + uid: word!Word.TableFormat.columns4:member + package: word! + summary: >- + Applies the columns 4 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Columns4"' + - name: columns5 + uid: word!Word.TableFormat.columns5:member + package: word! + summary: >- + Applies the columns 5 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Columns5"' + - name: contemporary + uid: word!Word.TableFormat.contemporary:member + package: word! + summary: >- + Applies the contemporary table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Contemporary"' + - name: elegant + uid: word!Word.TableFormat.elegant:member + package: word! + summary: >- + Applies the elegant table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Elegant"' + - name: grid1 + uid: word!Word.TableFormat.grid1:member + package: word! + summary: >- + Applies the grid 1 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Grid1"' + - name: grid2 + uid: word!Word.TableFormat.grid2:member + package: word! + summary: >- + Applies the grid 2 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Grid2"' + - name: grid3 + uid: word!Word.TableFormat.grid3:member + package: word! + summary: >- + Applies the grid 3 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Grid3"' + - name: grid4 + uid: word!Word.TableFormat.grid4:member + package: word! + summary: >- + Applies the grid 4 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Grid4"' + - name: grid5 + uid: word!Word.TableFormat.grid5:member + package: word! + summary: >- + Applies the grid 5 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Grid5"' + - name: grid6 + uid: word!Word.TableFormat.grid6:member + package: word! + summary: >- + Applies the grid 6 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Grid6"' + - name: grid7 + uid: word!Word.TableFormat.grid7:member + package: word! + summary: >- + Applies the grid 7 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Grid7"' + - name: grid8 + uid: word!Word.TableFormat.grid8:member + package: word! + summary: >- + Applies the grid 8 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Grid8"' + - name: list1 + uid: word!Word.TableFormat.list1:member + package: word! + summary: >- + Applies the list 1 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"List1"' + - name: list2 + uid: word!Word.TableFormat.list2:member + package: word! + summary: >- + Applies the list 2 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"List2"' + - name: list3 + uid: word!Word.TableFormat.list3:member + package: word! + summary: >- + Applies the list 3 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"List3"' + - name: list4 + uid: word!Word.TableFormat.list4:member + package: word! + summary: >- + Applies the list 4 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"List4"' + - name: list5 + uid: word!Word.TableFormat.list5:member + package: word! + summary: >- + Applies the list 5 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"List5"' + - name: list6 + uid: word!Word.TableFormat.list6:member + package: word! + summary: >- + Applies the list 6 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"List6"' + - name: list7 + uid: word!Word.TableFormat.list7:member + package: word! + summary: >- + Applies the list 7 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"List7"' + - name: list8 + uid: word!Word.TableFormat.list8:member + package: word! + summary: >- + Applies the list 8 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"List8"' + - name: none + uid: word!Word.TableFormat.none:member + package: word! + summary: >- + No table format is applied. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"None"' + - name: professional + uid: word!Word.TableFormat.professional:member + package: word! + summary: >- + Applies the professional table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Professional"' + - name: simple1 + uid: word!Word.TableFormat.simple1:member + package: word! + summary: >- + Applies the simple 1 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Simple1"' + - name: simple2 + uid: word!Word.TableFormat.simple2:member + package: word! + summary: >- + Applies the simple 2 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Simple2"' + - name: simple3 + uid: word!Word.TableFormat.simple3:member + package: word! + summary: >- + Applies the simple 3 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Simple3"' + - name: subtle1 + uid: word!Word.TableFormat.subtle1:member + package: word! + summary: >- + Applies the subtle 1 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Subtle1"' + - name: subtle2 + uid: word!Word.TableFormat.subtle2:member + package: word! + summary: >- + Applies the subtle 2 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Subtle2"' + - name: threeDEffects1 + uid: word!Word.TableFormat.threeDEffects1:member + package: word! + summary: >- + Applies the 3D effects 1 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"ThreeDEffects1"' + - name: threeDEffects2 + uid: word!Word.TableFormat.threeDEffects2:member + package: word! + summary: >- + Applies the 3D effects 2 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"ThreeDEffects2"' + - name: threeDEffects3 + uid: word!Word.TableFormat.threeDEffects3:member + package: word! + summary: >- + Applies the 3D effects 3 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"ThreeDEffects3"' + - name: web1 + uid: word!Word.TableFormat.web1:member + package: word! + summary: >- + Applies the web 1 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Web1"' + - name: web2 + uid: word!Word.TableFormat.web2:member + package: word! + summary: >- + Applies the web 2 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Web2"' + - name: web3 + uid: word!Word.TableFormat.web3:member + package: word! + summary: >- + Applies the web 3 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Web3"' diff --git a/docs/docs-ref-autogen/word/word/word.tableformattype.yml b/docs/docs-ref-autogen/word/word/word.tableformattype.yml new file mode 100644 index 0000000000..629856d29d --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.tableformattype.yml @@ -0,0 +1,443 @@ +### YamlMime:TSEnum +name: Word.TableFormatType +uid: word!Word.TableFormatType:enum +package: word! +fullName: Word.TableFormatType +summary: Specifies the table format to apply. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: classic1 + uid: word!Word.TableFormatType.classic1:member + package: word! + summary: >- + Applies the Classic1 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Classic1"' + - name: classic2 + uid: word!Word.TableFormatType.classic2:member + package: word! + summary: >- + Applies the Classic2 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Classic2"' + - name: classic3 + uid: word!Word.TableFormatType.classic3:member + package: word! + summary: >- + Applies the Classic3 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Classic3"' + - name: classic4 + uid: word!Word.TableFormatType.classic4:member + package: word! + summary: >- + Applies the Classic4 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Classic4"' + - name: colorful1 + uid: word!Word.TableFormatType.colorful1:member + package: word! + summary: >- + Applies the Colorful1 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Colorful1"' + - name: colorful2 + uid: word!Word.TableFormatType.colorful2:member + package: word! + summary: >- + Applies the Colorful2 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Colorful2"' + - name: colorful3 + uid: word!Word.TableFormatType.colorful3:member + package: word! + summary: >- + Applies the Colorful3 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Colorful3"' + - name: columns1 + uid: word!Word.TableFormatType.columns1:member + package: word! + summary: >- + Applies the Columns1 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Columns1"' + - name: columns2 + uid: word!Word.TableFormatType.columns2:member + package: word! + summary: >- + Applies the Columns2 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Columns2"' + - name: columns3 + uid: word!Word.TableFormatType.columns3:member + package: word! + summary: >- + Applies the Columns3 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Columns3"' + - name: columns4 + uid: word!Word.TableFormatType.columns4:member + package: word! + summary: >- + Applies the Columns4 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Columns4"' + - name: columns5 + uid: word!Word.TableFormatType.columns5:member + package: word! + summary: >- + Applies the Columns5 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Columns5"' + - name: contemporary + uid: word!Word.TableFormatType.contemporary:member + package: word! + summary: >- + Applies the Contemporary table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Contemporary"' + - name: elegant + uid: word!Word.TableFormatType.elegant:member + package: word! + summary: >- + Applies the Elegant table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Elegant"' + - name: grid1 + uid: word!Word.TableFormatType.grid1:member + package: word! + summary: >- + Applies the Grid1 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Grid1"' + - name: grid2 + uid: word!Word.TableFormatType.grid2:member + package: word! + summary: >- + Applies the Grid2 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Grid2"' + - name: grid3 + uid: word!Word.TableFormatType.grid3:member + package: word! + summary: >- + Applies the Grid3 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Grid3"' + - name: grid4 + uid: word!Word.TableFormatType.grid4:member + package: word! + summary: >- + Applies the Grid4 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Grid4"' + - name: grid5 + uid: word!Word.TableFormatType.grid5:member + package: word! + summary: >- + Applies the Grid5 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Grid5"' + - name: grid6 + uid: word!Word.TableFormatType.grid6:member + package: word! + summary: >- + Applies the Grid6 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Grid6"' + - name: grid7 + uid: word!Word.TableFormatType.grid7:member + package: word! + summary: >- + Applies the Grid7 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Grid7"' + - name: grid8 + uid: word!Word.TableFormatType.grid8:member + package: word! + summary: >- + Applies the Grid8 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Grid8"' + - name: list1 + uid: word!Word.TableFormatType.list1:member + package: word! + summary: >- + Applies the List1 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"List1"' + - name: list2 + uid: word!Word.TableFormatType.list2:member + package: word! + summary: >- + Applies the List2 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"List2"' + - name: list3 + uid: word!Word.TableFormatType.list3:member + package: word! + summary: >- + Applies the List3 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"List3"' + - name: list4 + uid: word!Word.TableFormatType.list4:member + package: word! + summary: >- + Applies the List4 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"List4"' + - name: list5 + uid: word!Word.TableFormatType.list5:member + package: word! + summary: >- + Applies the List5 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"List5"' + - name: list6 + uid: word!Word.TableFormatType.list6:member + package: word! + summary: >- + Applies the List6 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"List6"' + - name: list7 + uid: word!Word.TableFormatType.list7:member + package: word! + summary: >- + Applies the List7 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"List7"' + - name: list8 + uid: word!Word.TableFormatType.list8:member + package: word! + summary: >- + Applies the List8 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"List8"' + - name: none + uid: word!Word.TableFormatType.none:member + package: word! + summary: >- + Applies no formatting to the table. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"None"' + - name: professional + uid: word!Word.TableFormatType.professional:member + package: word! + summary: >- + Applies the Professional table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Professional"' + - name: simple1 + uid: word!Word.TableFormatType.simple1:member + package: word! + summary: >- + Applies the Simple1 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Simple1"' + - name: simple2 + uid: word!Word.TableFormatType.simple2:member + package: word! + summary: >- + Applies the Simple2 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Simple2"' + - name: simple3 + uid: word!Word.TableFormatType.simple3:member + package: word! + summary: >- + Applies the Simple3 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Simple3"' + - name: subtle1 + uid: word!Word.TableFormatType.subtle1:member + package: word! + summary: >- + Applies the Subtle1 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Subtle1"' + - name: subtle2 + uid: word!Word.TableFormatType.subtle2:member + package: word! + summary: >- + Applies the Subtle2 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Subtle2"' + - name: threeDEffects1 + uid: word!Word.TableFormatType.threeDEffects1:member + package: word! + summary: >- + Applies the 3D Effects1 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"ThreeDEffects1"' + - name: threeDEffects2 + uid: word!Word.TableFormatType.threeDEffects2:member + package: word! + summary: >- + Applies the 3D Effects2 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"ThreeDEffects2"' + - name: threeDEffects3 + uid: word!Word.TableFormatType.threeDEffects3:member + package: word! + summary: >- + Applies the 3D Effects3 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"ThreeDEffects3"' + - name: web1 + uid: word!Word.TableFormatType.web1:member + package: word! + summary: >- + Applies the Web1 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Web1"' + - name: web2 + uid: word!Word.TableFormatType.web2:member + package: word! + summary: >- + Applies the Web2 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Web2"' + - name: web3 + uid: word!Word.TableFormatType.web3:member + package: word! + summary: >- + Applies the Web3 table format. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Web3"' diff --git a/docs/docs-ref-autogen/word/word/word.tableofauthorities.yml b/docs/docs-ref-autogen/word/word/word.tableofauthorities.yml new file mode 100644 index 0000000000..d258dfe184 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.tableofauthorities.yml @@ -0,0 +1,456 @@ +### YamlMime:TSType +name: Word.TableOfAuthorities +uid: word!Word.TableOfAuthorities:class +package: word! +fullName: Word.TableOfAuthorities +summary: Represents a table of authorities in a Word document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: class +properties: + - name: bookmark + uid: word!Word.TableOfAuthorities#bookmark:member + package: word! + fullName: bookmark + summary: >- + Specifies the name of the bookmark from which to collect table of + authorities entries. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'bookmark: string;' + return: + type: string + - name: category + uid: word!Word.TableOfAuthorities#category:member + package: word! + fullName: category + summary: >- + Specifies the category of entries to be included in the table of + authorities. Values 0 through 16 correspond to the items listed in the + Category box of the Table of Authorities dialog. To learn how to access + this through the Word UI, see [Create a table of + authorities](https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0). + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'category: number;' + return: + type: number + - name: context + uid: word!Word.TableOfAuthorities#context:member + package: word! + 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: true + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: entrySeparator + uid: word!Word.TableOfAuthorities#entrySeparator:member + package: word! + fullName: entrySeparator + summary: >- + Specifies a separator of up to five characters. This appears between the + table of authorities entry and its page number. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'entrySeparator: string;' + return: + type: string + - name: isCategoryHeaderIncluded + uid: word!Word.TableOfAuthorities#isCategoryHeaderIncluded:member + package: word! + fullName: isCategoryHeaderIncluded + summary: >- + Specifies whether the category name for a group of entries appears in the + table of authorities. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isCategoryHeaderIncluded: boolean;' + return: + type: boolean + - name: isEntryFormattingKept + uid: word!Word.TableOfAuthorities#isEntryFormattingKept:member + package: word! + fullName: isEntryFormattingKept + summary: >- + Specifies whether the entries in the table of authorities are displayed + with their formatting in the table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isEntryFormattingKept: boolean;' + return: + type: boolean + - name: isPassimUsed + uid: word!Word.TableOfAuthorities#isPassimUsed:member + package: word! + fullName: isPassimUsed + summary: >- + Specifies whether references to the same authority that are repeated on + five or more pages are replaced with "Passim". + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isPassimUsed: boolean;' + return: + type: boolean + - name: pageNumberSeparator + uid: word!Word.TableOfAuthorities#pageNumberSeparator:member + package: word! + fullName: pageNumberSeparator + summary: >- + Specifies a separator of up to five characters. This appears between + individual page references in the table of authorities. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'pageNumberSeparator: string;' + return: + type: string + - name: pageRangeSeparator + uid: word!Word.TableOfAuthorities#pageRangeSeparator:member + package: word! + fullName: pageRangeSeparator + summary: >- + Specifies a separator of up to five characters. This appears between + ranges of pages in the table of authorities. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'pageRangeSeparator: string;' + return: + type: string + - name: range + uid: word!Word.TableOfAuthorities#range:member + package: word! + fullName: range + summary: Gets the portion of a document that is this table of authorities. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly range: Word.Range;' + return: + type: + - name: sequenceName + uid: word!Word.TableOfAuthorities#sequenceName:member + package: word! + fullName: sequenceName + summary: >- + Specifies the [Sequence (SEQ) + field](https://support.microsoft.com/office/062a387b-dfc9-4ef8-8235-29ee113d59be) + identifier for the table of authorities. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'sequenceName: string;' + return: + type: string + - name: sequenceSeparator + uid: word!Word.TableOfAuthorities#sequenceSeparator:member + package: word! + fullName: sequenceSeparator + summary: >- + Specifies a separator of up to five characters. This appears between the + sequence number and the page number in the table of authorities. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'sequenceSeparator: string;' + return: + type: string + - name: tabLeader + uid: word!Word.TableOfAuthorities#tabLeader:member + package: word! + fullName: tabLeader + summary: >- + Specifies the leader character that appears between entries and their + associated page numbers in the table of authorities. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | + "Heavy" | "MiddleDot"; + return: + type: >- + | "Spaces" | "Dots" | "Dashes" + | "Lines" | "Heavy" | "MiddleDot" +methods: + - name: delete() + uid: word!Word.TableOfAuthorities#delete:member(1) + package: word! + fullName: delete() + summary: Deletes this table of authorities. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'delete(): void;' + return: + type: void + description: '' + - name: load(options) + uid: word!Word.TableOfAuthorities#load:member(1) + package: word! + 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: true + isDeprecated: false + syntax: + content: >- + load(options?: Word.Interfaces.TableOfAuthoritiesLoadOptions): + Word.TableOfAuthorities; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: word!Word.TableOfAuthorities#load:member(2) + package: word! + 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: true + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Word.TableOfAuthorities;' + 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: word!Word.TableOfAuthorities#load:member(3) + package: word! + 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: true + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.TableOfAuthorities; + 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(properties, options) + uid: word!Word.TableOfAuthorities#set:member(1) + package: word! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.TableOfAuthoritiesUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: word!Word.TableOfAuthorities#set:member(2) + package: word! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'set(properties: Word.TableOfAuthorities): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: word!Word.TableOfAuthorities#toJSON:member(1) + package: word! + 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 + `Word.TableOfAuthorities` object is an API object, the `toJSON` method + returns a plain JavaScript object (typed as + `Word.Interfaces.TableOfAuthoritiesData`) that contains shallow + copies of any loaded child properties from the original object. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'toJSON(): Word.Interfaces.TableOfAuthoritiesData;' + return: + type: + description: '' + - name: track() + uid: word!Word.TableOfAuthorities#track:member(1) + package: word! + fullName: track() + summary: >- + Track the object for automatic adjustment based on surrounding changes in + the document. This call is a shorthand for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). If you're using this object across `.sync` calls and outside the + sequential execution of a ".run" batch, and get an "InvalidObjectPath" + error when setting a property or invoking a method on the object, you need + to add the object to the tracked object collection when the object was + first created. If this object is part of a collection, you should also + track the parent collection. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'track(): Word.TableOfAuthorities;' + return: + type: + description: '' + - name: untrack() + uid: word!Word.TableOfAuthorities#untrack:member(1) + package: word! + fullName: untrack() + summary: >- + Release the memory associated with this object, if it has previously been + tracked. This call is shorthand for + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). Having many tracked objects slows down the host application, so + please remember to free any objects you add, once you're done using them. + You'll need to call `context.sync()` before the memory release takes + effect. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'untrack(): Word.TableOfAuthorities;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/word/word/word.tableofauthoritiesaddoptions.yml b/docs/docs-ref-autogen/word/word/word.tableofauthoritiesaddoptions.yml new file mode 100644 index 0000000000..0f08d5eddf --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.tableofauthoritiesaddoptions.yml @@ -0,0 +1,222 @@ +### YamlMime:TSType +name: Word.TableOfAuthoritiesAddOptions +uid: word!Word.TableOfAuthoritiesAddOptions:interface +package: word! +fullName: Word.TableOfAuthoritiesAddOptions +summary: >- + Specifies the options for adding to a + [Word.TableOfAuthoritiesCollection](xref:word!Word.TableOfAuthoritiesCollection:class) + object. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: bookmark + uid: word!Word.TableOfAuthoritiesAddOptions#bookmark:member + package: word! + fullName: bookmark + summary: >- + If provided, specifies the string name of the bookmark from which to + collect entries for a table of authorities. When specified, the entries + are collected only from the portion of the document marked by the + bookmark. Corresponds to the `\b` switch for a [Table of Authorities (TOA) + field](https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958). + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'bookmark?: string;' + return: + type: string + - name: category + uid: word!Word.TableOfAuthoritiesAddOptions#category:member + package: word! + fullName: category + summary: >- + If provided, specifies the category of entries to include in a table of + authorities. Corresponds to the `\c` switch for a [Table of Authorities + (TOA) + field](https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958). Values 0 through 16 correspond to the items listed in the Category + box of the Table of Authorities dialog. To learn how to access this + through the Word UI, see [Create a table of + authorities](https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0). The default value is `1`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'category?: number;' + return: + type: number + - name: entrySeparator + uid: word!Word.TableOfAuthoritiesAddOptions#entrySeparator:member + package: word! + fullName: entrySeparator + summary: >- + If provided, specifies a separator of up to five characters. This appears + between the table of authorities entry and its page number. Corresponds to + the `\e` switch for a [Table of Authorities (TOA) + field](https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958). If omitted, no separator is used. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'entrySeparator?: string;' + return: + type: string + - name: includeCategoryHeader + uid: word!Word.TableOfAuthoritiesAddOptions#includeCategoryHeader:member + package: word! + fullName: includeCategoryHeader + summary: >- + If provided, specifies whether the category name for each group of entries + appears in a table of authorities (e.g., "Cases"). Corresponds to the `\h` + switch for a [Table of Authorities (TOA) + field](https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958). The default value is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'includeCategoryHeader?: boolean;' + return: + type: boolean + - name: keepEntryFormatting + uid: word!Word.TableOfAuthoritiesAddOptions#keepEntryFormatting:member + package: word! + fullName: keepEntryFormatting + summary: >- + If provided, specifies whether the entries in a table of authorities are + displayed with their formatting in the table. Corresponds to the `\f` + switch for a [Table of Authorities (TOA) + field](https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958). The default value is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'keepEntryFormatting?: boolean;' + return: + type: boolean + - name: pageNumberSeparator + uid: word!Word.TableOfAuthoritiesAddOptions#pageNumberSeparator:member + package: word! + fullName: pageNumberSeparator + summary: >- + If provided, specifies a separator of up to five characters. This appears + between individual page references in a table of authorities. Corresponds + to the `\l` switch for a [Table of Authorities (TOA) + field](https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958). If omitted, a comma and a space (", ") are used. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'pageNumberSeparator?: string;' + return: + type: string + - name: pageRangeSeparator + uid: word!Word.TableOfAuthoritiesAddOptions#pageRangeSeparator:member + package: word! + fullName: pageRangeSeparator + summary: >- + If provided, specifies a separator of up to five characters. This appears + between ranges of pages in a table of authorities. Corresponds to the `\g` + switch for a [Table of Authorities (TOA) + field](https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958). If omitted, an en dash ("–") is used. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'pageRangeSeparator?: string;' + return: + type: string + - name: sequenceName + uid: word!Word.TableOfAuthoritiesAddOptions#sequenceName:member + package: word! + fullName: sequenceName + summary: >- + If provided, specifies the string that identifies the Sequence (SEQ) field + identifier for a table of authorities. Corresponds to the `\s` switch for + a [Table of Authorities (TOA) + field](https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958). + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'sequenceName?: string;' + return: + type: string + - name: sequenceSeparator + uid: word!Word.TableOfAuthoritiesAddOptions#sequenceSeparator:member + package: word! + fullName: sequenceSeparator + summary: >- + If provided, specifies a separator of up to five characters. This appears + between the sequence number and the page number in a table of authorities. + Corresponds to the `\d` switch for a [Table of Authorities (TOA) + field](https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958). If omitted, a hyphen ("-") is used. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'sequenceSeparator?: string;' + return: + type: string + - name: usePassim + uid: word!Word.TableOfAuthoritiesAddOptions#usePassim:member + package: word! + fullName: usePassim + summary: >- + If provided, specifies whether references to the same authority that are + repeated on five or more pages are replaced with "Passim". Corresponds to + the `\p` switch for a [Table of Authorities (TOA) + field](https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958). The default value is `false`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'usePassim?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.tableofauthoritiescategory.yml b/docs/docs-ref-autogen/word/word/word.tableofauthoritiescategory.yml new file mode 100644 index 0000000000..f6261b6f7f --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.tableofauthoritiescategory.yml @@ -0,0 +1,199 @@ +### YamlMime:TSType +name: Word.TableOfAuthoritiesCategory +uid: word!Word.TableOfAuthoritiesCategory:class +package: word! +fullName: Word.TableOfAuthoritiesCategory +summary: Represents a category used in a table of authorities. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: class +properties: + - name: context + uid: word!Word.TableOfAuthoritiesCategory#context:member + package: word! + 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: true + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: name + uid: word!Word.TableOfAuthoritiesCategory#name:member + package: word! + fullName: name + summary: >- + Specifies the name of this table of authorities category. Changing the + name of the category doesn't change the index in the collection. The value + for [TableOfAuthorities.category](xref:word!Word.TableOfAuthorities:class) + will remain the same. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly name: string;' + return: + type: string +methods: + - name: load(options) + uid: word!Word.TableOfAuthoritiesCategory#load:member(1) + package: word! + 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: true + isDeprecated: false + syntax: + content: >- + load(options?: Word.Interfaces.TableOfAuthoritiesCategoryLoadOptions): + Word.TableOfAuthoritiesCategory; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: word!Word.TableOfAuthoritiesCategory#load:member(2) + package: word! + 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: true + isDeprecated: false + syntax: + content: >- + load(propertyNames?: string | string[]): + Word.TableOfAuthoritiesCategory; + 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: word!Word.TableOfAuthoritiesCategory#load:member(3) + package: word! + 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: true + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.TableOfAuthoritiesCategory; + 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: word!Word.TableOfAuthoritiesCategory#toJSON:member(1) + package: word! + 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 + `Word.TableOfAuthoritiesCategory` object is an API object, the `toJSON` + method returns a plain JavaScript object (typed as + `Word.Interfaces.TableOfAuthoritiesCategoryData`) that contains + shallow copies of any loaded child properties from the original object. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'toJSON(): Word.Interfaces.TableOfAuthoritiesCategoryData;' + return: + type: >- + + description: '' + - name: track() + uid: word!Word.TableOfAuthoritiesCategory#track:member(1) + package: word! + fullName: track() + summary: >- + Track the object for automatic adjustment based on surrounding changes in + the document. This call is a shorthand for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). If you're using this object across `.sync` calls and outside the + sequential execution of a ".run" batch, and get an "InvalidObjectPath" + error when setting a property or invoking a method on the object, you need + to add the object to the tracked object collection when the object was + first created. If this object is part of a collection, you should also + track the parent collection. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'track(): Word.TableOfAuthoritiesCategory;' + return: + type: + description: '' + - name: untrack() + uid: word!Word.TableOfAuthoritiesCategory#untrack:member(1) + package: word! + fullName: untrack() + summary: >- + Release the memory associated with this object, if it has previously been + tracked. This call is shorthand for + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). Having many tracked objects slows down the host application, so + please remember to free any objects you add, once you're done using them. + You'll need to call `context.sync()` before the memory release takes + effect. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'untrack(): Word.TableOfAuthoritiesCategory;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/word/word/word.tableofauthoritiescategorycollection.yml b/docs/docs-ref-autogen/word/word/word.tableofauthoritiescategorycollection.yml new file mode 100644 index 0000000000..36b7e6c941 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.tableofauthoritiescategorycollection.yml @@ -0,0 +1,233 @@ +### YamlMime:TSType +name: Word.TableOfAuthoritiesCategoryCollection +uid: word!Word.TableOfAuthoritiesCategoryCollection:class +package: word! +fullName: Word.TableOfAuthoritiesCategoryCollection +summary: >- + Represents a collection of + [Word.TableOfAuthoritiesCategory](xref:word!Word.TableOfAuthoritiesCategory:class) + objects in a Word document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: class +properties: + - name: context + uid: word!Word.TableOfAuthoritiesCategoryCollection#context:member + package: word! + 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: true + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: word!Word.TableOfAuthoritiesCategoryCollection#items:member + package: word! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly items: Word.TableOfAuthoritiesCategory[];' + return: + type: [] +methods: + - name: getCount() + uid: word!Word.TableOfAuthoritiesCategoryCollection#getCount:member(1) + package: word! + fullName: getCount() + summary: Returns the number of items in the collection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'getCount(): OfficeExtension.ClientResult;' + return: + type: <number> + description: '' + - name: getItemAt(index) + uid: word!Word.TableOfAuthoritiesCategoryCollection#getItemAt:member(1) + package: word! + fullName: getItemAt(index) + summary: >- + Returns a `TableOfAuthoritiesCategory` object that represents the + specified item in the collection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'getItemAt(index: number): Word.TableOfAuthoritiesCategory;' + parameters: + - id: index + description: The index of the item to retrieve. + type: number + return: + type: + description: '' + - name: load(options) + uid: word!Word.TableOfAuthoritiesCategoryCollection#load:member(1) + package: word! + 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: true + isDeprecated: false + syntax: + content: >- + load(options?: + Word.Interfaces.TableOfAuthoritiesCategoryCollectionLoadOptions & + Word.Interfaces.CollectionLoadOptions): + Word.TableOfAuthoritiesCategoryCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: word!Word.TableOfAuthoritiesCategoryCollection#load:member(2) + package: word! + 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: true + isDeprecated: false + syntax: + content: >- + load(propertyNames?: string | string[]): + Word.TableOfAuthoritiesCategoryCollection; + 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: word!Word.TableOfAuthoritiesCategoryCollection#load:member(3) + package: word! + 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: true + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Word.TableOfAuthoritiesCategoryCollection; + 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: word!Word.TableOfAuthoritiesCategoryCollection#toJSON:member(1) + package: word! + 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 + `Word.TableOfAuthoritiesCategoryCollection` object is an API object, the + `toJSON` method returns a plain JavaScript object (typed as + `Word.Interfaces.TableOfAuthoritiesCategoryCollectionData`) that + contains an "items" array with shallow copies of any loaded properties + from the collection's items. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'toJSON(): Word.Interfaces.TableOfAuthoritiesCategoryCollectionData;' + return: + type: >- + + description: '' + - name: track() + uid: word!Word.TableOfAuthoritiesCategoryCollection#track:member(1) + package: word! + fullName: track() + summary: >- + Track the object for automatic adjustment based on surrounding changes in + the document. This call is a shorthand for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). If you're using this object across `.sync` calls and outside the + sequential execution of a ".run" batch, and get an "InvalidObjectPath" + error when setting a property or invoking a method on the object, you need + to add the object to the tracked object collection when the object was + first created. If this object is part of a collection, you should also + track the parent collection. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'track(): Word.TableOfAuthoritiesCategoryCollection;' + return: + type: + description: '' + - name: untrack() + uid: word!Word.TableOfAuthoritiesCategoryCollection#untrack:member(1) + package: word! + fullName: untrack() + summary: >- + Release the memory associated with this object, if it has previously been + tracked. This call is shorthand for + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). Having many tracked objects slows down the host application, so + please remember to free any objects you add, once you're done using them. + You'll need to call `context.sync()` before the memory release takes + effect. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'untrack(): Word.TableOfAuthoritiesCategoryCollection;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/word/word/word.tableofauthoritiescollection.yml b/docs/docs-ref-autogen/word/word/word.tableofauthoritiescollection.yml new file mode 100644 index 0000000000..bd5e1d975e --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.tableofauthoritiescollection.yml @@ -0,0 +1,304 @@ +### YamlMime:TSType +name: Word.TableOfAuthoritiesCollection +uid: word!Word.TableOfAuthoritiesCollection:class +package: word! +fullName: Word.TableOfAuthoritiesCollection +summary: >- + Represents a collection of + [Word.TableOfAuthorities](xref:word!Word.TableOfAuthorities:class) objects in + a Word document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: class +properties: + - name: context + uid: word!Word.TableOfAuthoritiesCollection#context:member + package: word! + 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: true + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: word!Word.TableOfAuthoritiesCollection#items:member + package: word! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly items: Word.TableOfAuthorities[];' + return: + type: [] +methods: + - name: add(range, options) + uid: word!Word.TableOfAuthoritiesCollection#add:member(1) + package: word! + fullName: add(range, options) + summary: Adds a table of authorities to the document at the specified range. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + add(range: Word.Range, options?: Word.TableOfAuthoritiesAddOptions): + Word.TableOfAuthorities; + parameters: + - id: range + description: >- + The range where the table of authorities will appear. The table of + authorities replaces the range if the range isn't collapsed. + type: + - id: options + description: Optional. The options to configure the table of authorities. + type: + return: + type: + description: '' + - name: load(options) + uid: word!Word.TableOfAuthoritiesCollection#load:member(1) + package: word! + 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: true + isDeprecated: false + syntax: + content: >- + load(options?: Word.Interfaces.TableOfAuthoritiesCollectionLoadOptions & + Word.Interfaces.CollectionLoadOptions): + Word.TableOfAuthoritiesCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: word!Word.TableOfAuthoritiesCollection#load:member(2) + package: word! + 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: true + isDeprecated: false + syntax: + content: >- + load(propertyNames?: string | string[]): + Word.TableOfAuthoritiesCollection; + 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: word!Word.TableOfAuthoritiesCollection#load:member(3) + package: word! + 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: true + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Word.TableOfAuthoritiesCollection; + 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: markAllCitations(shortCitation, options) + uid: word!Word.TableOfAuthoritiesCollection#markAllCitations:member(1) + package: word! + fullName: markAllCitations(shortCitation, options) + summary: >- + Inserts a [Table of Authorities Entry (TA) + field](https://support.microsoft.com/office/2a90ad2b-4169-475d-8a09-e62521d4159c) + after all instances of the specified citation text. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + markAllCitations(shortCitation: string, options?: + Word.TableOfAuthoritiesMarkCitationOptions): void; + parameters: + - id: shortCitation + description: The citation text to mark. + type: string + - id: options + description: Optional. The options for marking the citation. + type: >- + + return: + type: void + description: '' + - name: markCitation(range, shortCitation, options) + uid: word!Word.TableOfAuthoritiesCollection#markCitation:member(1) + package: word! + fullName: markCitation(range, shortCitation, options) + summary: >- + Inserts a [Table of Authorities Entry (TA) + field](https://support.microsoft.com/office/2a90ad2b-4169-475d-8a09-e62521d4159c) + at the specified range. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + markCitation(range: Word.Range, shortCitation: string, options?: + Word.TableOfAuthoritiesMarkCitationOptions): Word.Field; + parameters: + - id: range + description: The range where the citation will be inserted. + type: + - id: shortCitation + description: The short citation text. + type: string + - id: options + description: Optional. The options for marking the citation. + type: >- + + return: + type: + description: '' + - name: selectNextCitation(shortCitation) + uid: word!Word.TableOfAuthoritiesCollection#selectNextCitation:member(1) + package: word! + fullName: selectNextCitation(shortCitation) + summary: Finds and selects the next instance of the specified citation text. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'selectNextCitation(shortCitation: string): void;' + parameters: + - id: shortCitation + description: The citation text to search for. + type: string + return: + type: void + description: '' + - name: toJSON() + uid: word!Word.TableOfAuthoritiesCollection#toJSON:member(1) + package: word! + 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 + `Word.TableOfAuthoritiesCollection` object is an API object, the `toJSON` + method returns a plain JavaScript object (typed as + `Word.Interfaces.TableOfAuthoritiesCollectionData`) that contains + an "items" array with shallow copies of any loaded properties from the + collection's items. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'toJSON(): Word.Interfaces.TableOfAuthoritiesCollectionData;' + return: + type: >- + + description: '' + - name: track() + uid: word!Word.TableOfAuthoritiesCollection#track:member(1) + package: word! + fullName: track() + summary: >- + Track the object for automatic adjustment based on surrounding changes in + the document. This call is a shorthand for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). If you're using this object across `.sync` calls and outside the + sequential execution of a ".run" batch, and get an "InvalidObjectPath" + error when setting a property or invoking a method on the object, you need + to add the object to the tracked object collection when the object was + first created. If this object is part of a collection, you should also + track the parent collection. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'track(): Word.TableOfAuthoritiesCollection;' + return: + type: + description: '' + - name: untrack() + uid: word!Word.TableOfAuthoritiesCollection#untrack:member(1) + package: word! + fullName: untrack() + summary: >- + Release the memory associated with this object, if it has previously been + tracked. This call is shorthand for + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). Having many tracked objects slows down the host application, so + please remember to free any objects you add, once you're done using them. + You'll need to call `context.sync()` before the memory release takes + effect. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'untrack(): Word.TableOfAuthoritiesCollection;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/word/word/word.tableofauthoritiesmarkcitationoptions.yml b/docs/docs-ref-autogen/word/word/word.tableofauthoritiesmarkcitationoptions.yml new file mode 100644 index 0000000000..a57609dc1e --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.tableofauthoritiesmarkcitationoptions.yml @@ -0,0 +1,75 @@ +### YamlMime:TSType +name: Word.TableOfAuthoritiesMarkCitationOptions +uid: word!Word.TableOfAuthoritiesMarkCitationOptions:interface +package: word! +fullName: Word.TableOfAuthoritiesMarkCitationOptions +summary: >- + Specifies the options for inserting a [Table of Authorities Entry (TA) + field](https://support.microsoft.com/office/2a90ad2b-4169-475d-8a09-e62521d4159c). +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: category + uid: word!Word.TableOfAuthoritiesMarkCitationOptions#category:member + package: word! + fullName: category + summary: >- + If provided, specifies the category number to be associated with the + entry. Values 1 through 16 correspond to the items listed in the Category + dropdown list of the Mark Citation dialog. The value `1` corresponds to + the first category listed, `2` corresponds to the second category, and so + on. To learn how to access this through the Word UI, see [Create a table + of + authorities](https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0). + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'category?: number;' + return: + type: number + - name: longCitation + uid: word!Word.TableOfAuthoritiesMarkCitationOptions#longCitation:member + package: word! + fullName: longCitation + summary: >- + If provided, specifies the long citation for the entry as it will appear + in a table of authorities. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'longCitation?: string;' + return: + type: string + - name: longCitationAutoText + uid: >- + word!Word.TableOfAuthoritiesMarkCitationOptions#longCitationAutoText:member + package: word! + fullName: longCitationAutoText + summary: >- + If provided, specifies the name of the AutoText entry that contains the + text of the long citation as it will appear in a table of authorities. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'longCitationAutoText?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/word/word/word.tableofcontents.yml b/docs/docs-ref-autogen/word/word/word.tableofcontents.yml new file mode 100644 index 0000000000..c76265a3b4 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.tableofcontents.yml @@ -0,0 +1,466 @@ +### YamlMime:TSType +name: Word.TableOfContents +uid: word!Word.TableOfContents:class +package: word! +fullName: Word.TableOfContents +summary: Represents a table of contents in a Word document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: class +properties: + - name: additionalHeadingStyles + uid: word!Word.TableOfContents#additionalHeadingStyles:member + package: word! + fullName: additionalHeadingStyles + summary: >- + Gets the additional styles used for the table of contents. The default + "Heading 1" - "Heading 9" styles aren't included in this collection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly additionalHeadingStyles: Word.HeadingStyleCollection;' + return: + type: + - name: areBuiltInHeadingStylesUsed + uid: word!Word.TableOfContents#areBuiltInHeadingStylesUsed:member + package: word! + fullName: areBuiltInHeadingStylesUsed + summary: >- + Specifies whether built-in heading styles are used for the table of + contents. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areBuiltInHeadingStylesUsed: boolean;' + return: + type: boolean + - name: areFieldsUsed + uid: word!Word.TableOfContents#areFieldsUsed:member + package: word! + fullName: areFieldsUsed + summary: >- + Specifies whether [Table of Contents Entry (TC) + fields](https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3) + are included in the table of contents. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areFieldsUsed: boolean;' + return: + type: boolean + - name: areHyperlinksUsedOnWeb + uid: word!Word.TableOfContents#areHyperlinksUsedOnWeb:member + package: word! + fullName: areHyperlinksUsedOnWeb + summary: >- + Specifies whether entries in the table of contents should be formatted as + hyperlinks when publishing to the web. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areHyperlinksUsedOnWeb: boolean;' + return: + type: boolean + - name: arePageNumbersHiddenOnWeb + uid: word!Word.TableOfContents#arePageNumbersHiddenOnWeb:member + package: word! + fullName: arePageNumbersHiddenOnWeb + summary: >- + Specifies whether the page numbers in the table of contents should be + hidden when publishing to the web. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'arePageNumbersHiddenOnWeb: boolean;' + return: + type: boolean + - name: arePageNumbersIncluded + uid: word!Word.TableOfContents#arePageNumbersIncluded:member + package: word! + fullName: arePageNumbersIncluded + summary: Specifies whether page numbers are included in the table of contents. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'arePageNumbersIncluded: boolean;' + return: + type: boolean + - name: arePageNumbersRightAligned + uid: word!Word.TableOfContents#arePageNumbersRightAligned:member + package: word! + fullName: arePageNumbersRightAligned + summary: >- + Specifies whether page numbers are aligned with the right margin in the + table of contents. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'arePageNumbersRightAligned: boolean;' + return: + type: boolean + - name: context + uid: word!Word.TableOfContents#context:member + package: word! + 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: true + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: lowerHeadingLevel + uid: word!Word.TableOfContents#lowerHeadingLevel:member + package: word! + fullName: lowerHeadingLevel + summary: >- + Specifies the ending heading level for the table of contents. Must be a + value from 1 to 9 and greater than `upperHeadingLevel`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'lowerHeadingLevel: number;' + return: + type: number + - name: range + uid: word!Word.TableOfContents#range:member + package: word! + fullName: range + summary: Gets the portion of a document that is this table of contents. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly range: Word.Range;' + return: + type: + - name: tabLeader + uid: word!Word.TableOfContents#tabLeader:member + package: word! + fullName: tabLeader + summary: >- + Specifies the character between entries and their page numbers in the + table of contents. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | + "Heavy" | "MiddleDot"; + return: + type: >- + | "Spaces" | "Dots" | "Dashes" + | "Lines" | "Heavy" | "MiddleDot" + - name: tableId + uid: word!Word.TableOfContents#tableId:member + package: word! + fullName: tableId + summary: >- + Specifies a one-letter identifier from [TC + fields](https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3) + that's used for the table of contents. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'tableId: string;' + return: + type: string + - name: upperHeadingLevel + uid: word!Word.TableOfContents#upperHeadingLevel:member + package: word! + fullName: upperHeadingLevel + summary: >- + Specifies the starting heading level for the table of contents. Must be a + value from 1 to 9 and smaller than `lowerHeadingLevel`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'upperHeadingLevel: number;' + return: + type: number +methods: + - name: delete() + uid: word!Word.TableOfContents#delete:member(1) + package: word! + fullName: delete() + summary: Deletes this table of contents. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'delete(): void;' + return: + type: void + description: '' + - name: load(options) + uid: word!Word.TableOfContents#load:member(1) + package: word! + 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: true + isDeprecated: false + syntax: + content: >- + load(options?: Word.Interfaces.TableOfContentsLoadOptions): + Word.TableOfContents; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: word!Word.TableOfContents#load:member(2) + package: word! + 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: true + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Word.TableOfContents;' + 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: word!Word.TableOfContents#load:member(3) + package: word! + 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: true + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.TableOfContents; + 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(properties, options) + uid: word!Word.TableOfContents#set:member(1) + package: word! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.TableOfContentsUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: word!Word.TableOfContents#set:member(2) + package: word! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'set(properties: Word.TableOfContents): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: word!Word.TableOfContents#toJSON:member(1) + package: word! + 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 `Word.TableOfContents` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Word.Interfaces.TableOfContentsData`) that + contains shallow copies of any loaded child properties from the original + object. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'toJSON(): Word.Interfaces.TableOfContentsData;' + return: + type: + description: '' + - name: track() + uid: word!Word.TableOfContents#track:member(1) + package: word! + fullName: track() + summary: >- + Track the object for automatic adjustment based on surrounding changes in + the document. This call is a shorthand for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). If you're using this object across `.sync` calls and outside the + sequential execution of a ".run" batch, and get an "InvalidObjectPath" + error when setting a property or invoking a method on the object, you need + to add the object to the tracked object collection when the object was + first created. If this object is part of a collection, you should also + track the parent collection. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'track(): Word.TableOfContents;' + return: + type: + description: '' + - name: untrack() + uid: word!Word.TableOfContents#untrack:member(1) + package: word! + fullName: untrack() + summary: >- + Release the memory associated with this object, if it has previously been + tracked. This call is shorthand for + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). Having many tracked objects slows down the host application, so + please remember to free any objects you add, once you're done using them. + You'll need to call `context.sync()` before the memory release takes + effect. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'untrack(): Word.TableOfContents;' + return: + type: + description: '' + - name: updatePageNumbers() + uid: word!Word.TableOfContents#updatePageNumbers:member(1) + package: word! + fullName: updatePageNumbers() + summary: Updates the entire table of contents. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'updatePageNumbers(): void;' + return: + type: void + description: '' +extends: diff --git a/docs/docs-ref-autogen/word/word/word.tableofcontentsaddoptions.yml b/docs/docs-ref-autogen/word/word/word.tableofcontentsaddoptions.yml new file mode 100644 index 0000000000..cb440b6341 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.tableofcontentsaddoptions.yml @@ -0,0 +1,226 @@ +### YamlMime:TSType +name: Word.TableOfContentsAddOptions +uid: word!Word.TableOfContentsAddOptions:interface +package: word! +fullName: Word.TableOfContentsAddOptions +summary: >- + Specifies the options for adding to a + [Word.TableOfContentsCollection](xref:word!Word.TableOfContentsCollection:class) + object. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: addedStyles + uid: word!Word.TableOfContentsAddOptions#addedStyles:member + package: word! + fullName: addedStyles + summary: >- + If provided, specifies the string names of additional styles to use for + the table of contents. Use + [HeadingStyleCollection.add](xref:word!Word.HeadingStyleCollection:class) + to create new heading styles. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'addedStyles?: string;' + return: + type: string + - name: hidePageNumbersOnWeb + uid: word!Word.TableOfContentsAddOptions#hidePageNumbersOnWeb:member + package: word! + fullName: hidePageNumbersOnWeb + summary: >- + If provided, specifies whether the page numbers in a table of contents + should be hidden when publishing to the web. The default value is + `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'hidePageNumbersOnWeb?: boolean;' + return: + type: boolean + - name: includePageNumbers + uid: word!Word.TableOfContentsAddOptions#includePageNumbers:member + package: word! + fullName: includePageNumbers + summary: >- + If provided, specifies whether to include page numbers in a table of + contents. The default value is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'includePageNumbers?: boolean;' + return: + type: boolean + - name: lowerHeadingLevel + uid: word!Word.TableOfContentsAddOptions#lowerHeadingLevel:member + package: word! + fullName: lowerHeadingLevel + summary: >- + If provided, specifies the ending heading level for a table of contents + and must be a value from 1 to 9. Must be greater than + `upperHeadingLevel`. Corresponds to the ending value used with the + `\o` switch for a [Table of Contents (TOC) + field](https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c). The default value is `9`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'lowerHeadingLevel?: number;' + return: + type: number + - name: rightAlignPageNumbers + uid: word!Word.TableOfContentsAddOptions#rightAlignPageNumbers:member + package: word! + fullName: rightAlignPageNumbers + summary: >- + If provided, specifies whether page numbers in a table of contents are + aligned with the right margin. The default value is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'rightAlignPageNumbers?: boolean;' + return: + type: boolean + - name: tableId + uid: word!Word.TableOfContentsAddOptions#tableId:member + package: word! + fullName: tableId + summary: >- + If provided, specifies a one-letter identifier from [TC + fields](https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3) + that's used for a table of contents. Corresponds to the `\f` switch for a + [Table of Contents (TOC) + field](https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c). For example, "T" indicates a table of contents includes TC fields + that use the table identifier T. If this argument is omitted, TC fields + aren't used. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'tableId?: string;' + return: + type: string + - name: upperHeadingLevel + uid: word!Word.TableOfContentsAddOptions#upperHeadingLevel:member + package: word! + fullName: upperHeadingLevel + summary: >- + If provided, specifies the starting heading level for a table of contents + and must be a value from 1 to 9. Should be smaller than + `lowerHeadingLevel`. Corresponds to the starting value used with + the `\o` switch for a [Table of Contents (TOC) + field](https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c). The default value is `1`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'upperHeadingLevel?: number;' + return: + type: number + - name: useBuiltInHeadingStyles + uid: word!Word.TableOfContentsAddOptions#useBuiltInHeadingStyles:member + package: word! + fullName: useBuiltInHeadingStyles + summary: >- + If provided, specifies whether to use built-in heading styles to create a + table of contents. The default value is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'useBuiltInHeadingStyles?: boolean;' + return: + type: boolean + - name: useFields + uid: word!Word.TableOfContentsAddOptions#useFields:member + package: word! + fullName: useFields + summary: >- + If provided, specifies whether [Table of Contents Entry (TC) + fields](https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3) + are used to create a table of contents. Use the + [TableOfContentsCollection.markTocEntry](xref:word!Word.TableOfContentsCollection:class) + method to mark entries to be included in a table of contents. The default + value is `false`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'useFields?: boolean;' + return: + type: boolean + - name: useHyperlinksOnWeb + uid: word!Word.TableOfContentsAddOptions#useHyperlinksOnWeb:member + package: word! + fullName: useHyperlinksOnWeb + summary: >- + If provided, specifies whether entries in a table of contents should be + formatted as hyperlinks when the document is published to the web. The + default value is `true`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'useHyperlinksOnWeb?: boolean;' + return: + type: boolean + - name: useOutlineLevels + uid: word!Word.TableOfContentsAddOptions#useOutlineLevels:member + package: word! + fullName: useOutlineLevels + summary: >- + If provided, specifies whether to use outline levels to create a table of + contents. The default value is `false`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'useOutlineLevels?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.tableofcontentscollection.yml b/docs/docs-ref-autogen/word/word/word.tableofcontentscollection.yml new file mode 100644 index 0000000000..310f93cc0b --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.tableofcontentscollection.yml @@ -0,0 +1,245 @@ +### YamlMime:TSType +name: Word.TableOfContentsCollection +uid: word!Word.TableOfContentsCollection:class +package: word! +fullName: Word.TableOfContentsCollection +summary: >- + Represents a collection of + [Word.TableOfContents](xref:word!Word.TableOfContents:class) objects in a Word + document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: class +properties: + - name: context + uid: word!Word.TableOfContentsCollection#context:member + package: word! + 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: true + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: word!Word.TableOfContentsCollection#items:member + package: word! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly items: Word.TableOfContents[];' + return: + type: [] +methods: + - name: add(range, options) + uid: word!Word.TableOfContentsCollection#add:member(1) + package: word! + fullName: add(range, options) + summary: Adds a table of contents to the document at the specified range. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + add(range: Word.Range, options?: Word.TableOfContentsAddOptions): + Word.TableOfContents; + parameters: + - id: range + description: >- + The range where the table of contents will be added. The table of + contents replaces the range if the range isn't collapsed. + type: + - id: options + description: Optional. The options for configuring the table of contents. + type: + return: + type: + description: '' + - name: load(options) + uid: word!Word.TableOfContentsCollection#load:member(1) + package: word! + 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: true + isDeprecated: false + syntax: + content: >- + load(options?: Word.Interfaces.TableOfContentsCollectionLoadOptions & + Word.Interfaces.CollectionLoadOptions): Word.TableOfContentsCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: word!Word.TableOfContentsCollection#load:member(2) + package: word! + 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: true + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Word.TableOfContentsCollection;' + 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: word!Word.TableOfContentsCollection#load:member(3) + package: word! + 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: true + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Word.TableOfContentsCollection; + 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: markTocEntry(range, options) + uid: word!Word.TableOfContentsCollection#markTocEntry:member(1) + package: word! + fullName: markTocEntry(range, options) + summary: >- + Inserts a [Table of Contents Entry (TC) + field](https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3) + after the specified range. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + markTocEntry(range: Word.Range, options?: + Word.TableOfContentsMarkEntryOptions): Word.Field; + parameters: + - id: range + description: The range where the entry will be inserted. + type: + - id: options + description: Optional. The options for marking the table of contents entry. + type: + return: + type: + description: '' + - name: toJSON() + uid: word!Word.TableOfContentsCollection#toJSON:member(1) + package: word! + 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 + `Word.TableOfContentsCollection` object is an API object, the `toJSON` + method returns a plain JavaScript object (typed as + `Word.Interfaces.TableOfContentsCollectionData`) that contains an + "items" array with shallow copies of any loaded properties from the + collection's items. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'toJSON(): Word.Interfaces.TableOfContentsCollectionData;' + return: + type: >- + + description: '' + - name: track() + uid: word!Word.TableOfContentsCollection#track:member(1) + package: word! + fullName: track() + summary: >- + Track the object for automatic adjustment based on surrounding changes in + the document. This call is a shorthand for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). If you're using this object across `.sync` calls and outside the + sequential execution of a ".run" batch, and get an "InvalidObjectPath" + error when setting a property or invoking a method on the object, you need + to add the object to the tracked object collection when the object was + first created. If this object is part of a collection, you should also + track the parent collection. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'track(): Word.TableOfContentsCollection;' + return: + type: + description: '' + - name: untrack() + uid: word!Word.TableOfContentsCollection#untrack:member(1) + package: word! + fullName: untrack() + summary: >- + Release the memory associated with this object, if it has previously been + tracked. This call is shorthand for + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). Having many tracked objects slows down the host application, so + please remember to free any objects you add, once you're done using them. + You'll need to call `context.sync()` before the memory release takes + effect. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'untrack(): Word.TableOfContentsCollection;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/word/word/word.tableofcontentsmarkentryoptions.yml b/docs/docs-ref-autogen/word/word/word.tableofcontentsmarkentryoptions.yml new file mode 100644 index 0000000000..a17e68ebe9 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.tableofcontentsmarkentryoptions.yml @@ -0,0 +1,89 @@ +### YamlMime:TSType +name: Word.TableOfContentsMarkEntryOptions +uid: word!Word.TableOfContentsMarkEntryOptions:interface +package: word! +fullName: Word.TableOfContentsMarkEntryOptions +summary: >- + Specifies the options for inserting a [Table of Contents Entry (TC) + field](https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3). +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: entry + uid: word!Word.TableOfContentsMarkEntryOptions#entry:member + package: word! + fullName: entry + summary: >- + If provided, specifies the text that appears in a table of contents or + table of figures. To indicate a subentry, include the main entry text and + the subentry text, separated by a colon (":") (e.g., "Introduction:The + Product"). When the `entryAutoText` property is set, this property is + ignored. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'entry?: string;' + return: + type: string + - name: entryAutoText + uid: word!Word.TableOfContentsMarkEntryOptions#entryAutoText:member + package: word! + fullName: entryAutoText + summary: >- + If provided, specifies the AutoText entry name that includes text for the + table of figures, or table of contents. When this property is used, the + `entry` property is ignored. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'entryAutoText?: string;' + return: + type: string + - name: level + uid: word!Word.TableOfContentsMarkEntryOptions#level:member + package: word! + fullName: level + summary: >- + If provided, specifies the level for the entry in a table of contents or + table of figures and should be a value from 1 to 9. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'level?: number;' + return: + type: number + - name: tableId + uid: word!Word.TableOfContentsMarkEntryOptions#tableId:member + package: word! + fullName: tableId + summary: >- + If provided, specifies a one-letter identifier for a table of contents or + table of figures (e.g., "i" for an "illustration"). + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'tableId?: string;' + return: + type: string diff --git a/docs/docs-ref-autogen/word/word/word.tableoffigures.yml b/docs/docs-ref-autogen/word/word/word.tableoffigures.yml new file mode 100644 index 0000000000..b32e2d260b --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.tableoffigures.yml @@ -0,0 +1,500 @@ +### YamlMime:TSType +name: Word.TableOfFigures +uid: word!Word.TableOfFigures:class +package: word! +fullName: Word.TableOfFigures +summary: Represents a table of figures in a Word document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: class +properties: + - name: additionalHeadingStyles + uid: word!Word.TableOfFigures#additionalHeadingStyles:member + package: word! + fullName: additionalHeadingStyles + summary: >- + Gets the additional styles used for the table of figures. The default + "Heading 1" - "Heading 9" styles aren't included in this collection. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly additionalHeadingStyles: Word.HeadingStyleCollection;' + return: + type: + - name: areBuiltInHeadingStylesUsed + uid: word!Word.TableOfFigures#areBuiltInHeadingStylesUsed:member + package: word! + fullName: areBuiltInHeadingStylesUsed + summary: >- + Specifies whether built-in heading styles are used for the table of + figures. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areBuiltInHeadingStylesUsed: boolean;' + return: + type: boolean + - name: areFieldsUsed + uid: word!Word.TableOfFigures#areFieldsUsed:member + package: word! + fullName: areFieldsUsed + summary: >- + Specifies whether [Table of Contents Entry (TC) + fields](https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3) + are included in the table of figures. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areFieldsUsed: boolean;' + return: + type: boolean + - name: areHyperlinksUsedOnWeb + uid: word!Word.TableOfFigures#areHyperlinksUsedOnWeb:member + package: word! + fullName: areHyperlinksUsedOnWeb + summary: >- + Specifies whether entries in the table of figures should be formatted as + hyperlinks when publishing to the web. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'areHyperlinksUsedOnWeb: boolean;' + return: + type: boolean + - name: arePageNumbersHiddenOnWeb + uid: word!Word.TableOfFigures#arePageNumbersHiddenOnWeb:member + package: word! + fullName: arePageNumbersHiddenOnWeb + summary: >- + Specifies whether the page numbers in the table of figures should be + hidden when publishing to the web. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'arePageNumbersHiddenOnWeb: boolean;' + return: + type: boolean + - name: arePageNumbersIncluded + uid: word!Word.TableOfFigures#arePageNumbersIncluded:member + package: word! + fullName: arePageNumbersIncluded + summary: Specifies whether page numbers are included in the table of figures. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'arePageNumbersIncluded: boolean;' + return: + type: boolean + - name: arePageNumbersRightAligned + uid: word!Word.TableOfFigures#arePageNumbersRightAligned:member + package: word! + fullName: arePageNumbersRightAligned + summary: >- + Specifies whether page numbers are aligned with the right margin in the + table of figures. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'arePageNumbersRightAligned: boolean;' + return: + type: boolean + - name: captionLabel + uid: word!Word.TableOfFigures#captionLabel:member + package: word! + fullName: captionLabel + summary: >- + Specifies the label that identifies the items to be included in the table + of figures. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'captionLabel: string;' + return: + type: string + - name: context + uid: word!Word.TableOfFigures#context:member + package: word! + 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: true + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: isLabelIncluded + uid: word!Word.TableOfFigures#isLabelIncluded:member + package: word! + fullName: isLabelIncluded + summary: >- + Specifies whether the caption label and caption number are included in the + table of figures. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isLabelIncluded: boolean;' + return: + type: boolean + - name: lowerHeadingLevel + uid: word!Word.TableOfFigures#lowerHeadingLevel:member + package: word! + fullName: lowerHeadingLevel + summary: >- + Specifies the ending heading level for the table of figures. Must be a + value from 1 to 9 and greater than `upperHeadingLevel`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'lowerHeadingLevel: number;' + return: + type: number + - name: range + uid: word!Word.TableOfFigures#range:member + package: word! + fullName: range + summary: Gets the portion of a document that is this table of figures. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly range: Word.Range;' + return: + type: + - name: tabLeader + uid: word!Word.TableOfFigures#tabLeader:member + package: word! + fullName: tabLeader + summary: >- + Specifies the character between entries and their page numbers in the + table of figures. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | + "Heavy" | "MiddleDot"; + return: + type: >- + | "Spaces" | "Dots" | "Dashes" + | "Lines" | "Heavy" | "MiddleDot" + - name: tableId + uid: word!Word.TableOfFigures#tableId:member + package: word! + fullName: tableId + summary: >- + Specifies a one-letter identifier from [TC + fields](https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3) + that's used for the table of figures. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'tableId: string;' + return: + type: string + - name: upperHeadingLevel + uid: word!Word.TableOfFigures#upperHeadingLevel:member + package: word! + fullName: upperHeadingLevel + summary: >- + Specifies the starting heading level for the table of figures. Must be a + value from 1 to 9 and smaller than `lowerHeadingLevel`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'upperHeadingLevel: number;' + return: + type: number +methods: + - name: delete() + uid: word!Word.TableOfFigures#delete:member(1) + package: word! + fullName: delete() + summary: Deletes this table of figures. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'delete(): void;' + return: + type: void + description: '' + - name: load(options) + uid: word!Word.TableOfFigures#load:member(1) + package: word! + 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: true + isDeprecated: false + syntax: + content: >- + load(options?: Word.Interfaces.TableOfFiguresLoadOptions): + Word.TableOfFigures; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + + return: + type: + description: '' + - name: load(propertyNames) + uid: word!Word.TableOfFigures#load:member(2) + package: word! + 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: true + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Word.TableOfFigures;' + 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: word!Word.TableOfFigures#load:member(3) + package: word! + 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: true + isDeprecated: false + syntax: + content: |- + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.TableOfFigures; + 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(properties, options) + uid: word!Word.TableOfFigures#set:member(1) + package: word! + fullName: set(properties, options) + summary: >- + Sets multiple properties of an object at the same time. You can pass + either a plain object with the appropriate properties, or another API + object of the same type. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: >- + set(properties: Interfaces.TableOfFiguresUpdateData, options?: + OfficeExtension.UpdateOptions): void; + parameters: + - id: properties + description: >- + A JavaScript object with properties that are structured + isomorphically to the properties of the object on which the method + is called. + type: >- + + - id: options + description: >- + Provides an option to suppress errors if the properties object tries + to set any read-only properties. + type: + return: + type: void + description: '' + - name: set(properties) + uid: word!Word.TableOfFigures#set:member(2) + package: word! + fullName: set(properties) + summary: >- + Sets multiple properties on the object at the same time, based on an + existing loaded object. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'set(properties: Word.TableOfFigures): void;' + parameters: + - id: properties + description: '' + type: + return: + type: void + description: '' + - name: toJSON() + uid: word!Word.TableOfFigures#toJSON:member(1) + package: word! + 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 `Word.TableOfFigures` + object is an API object, the `toJSON` method returns a plain JavaScript + object (typed as `Word.Interfaces.TableOfFiguresData`) that + contains shallow copies of any loaded child properties from the original + object. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'toJSON(): Word.Interfaces.TableOfFiguresData;' + return: + type: + description: '' + - name: track() + uid: word!Word.TableOfFigures#track:member(1) + package: word! + fullName: track() + summary: >- + Track the object for automatic adjustment based on surrounding changes in + the document. This call is a shorthand for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). If you're using this object across `.sync` calls and outside the + sequential execution of a ".run" batch, and get an "InvalidObjectPath" + error when setting a property or invoking a method on the object, you need + to add the object to the tracked object collection when the object was + first created. If this object is part of a collection, you should also + track the parent collection. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'track(): Word.TableOfFigures;' + return: + type: + description: '' + - name: untrack() + uid: word!Word.TableOfFigures#untrack:member(1) + package: word! + fullName: untrack() + summary: >- + Release the memory associated with this object, if it has previously been + tracked. This call is shorthand for + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). Having many tracked objects slows down the host application, so + please remember to free any objects you add, once you're done using them. + You'll need to call `context.sync()` before the memory release takes + effect. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'untrack(): Word.TableOfFigures;' + return: + type: + description: '' + - name: updatePageNumbers() + uid: word!Word.TableOfFigures#updatePageNumbers:member(1) + package: word! + fullName: updatePageNumbers() + summary: Updates the entire table of figures. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'updatePageNumbers(): void;' + return: + type: void + description: '' +extends: diff --git a/docs/docs-ref-autogen/word/word/word.tableoffiguresaddoptions.yml b/docs/docs-ref-autogen/word/word/word.tableoffiguresaddoptions.yml new file mode 100644 index 0000000000..5bdd8650ee --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.tableoffiguresaddoptions.yml @@ -0,0 +1,173 @@ +### YamlMime:TSType +name: Word.TableOfFiguresAddOptions +uid: word!Word.TableOfFiguresAddOptions:interface +package: word! +fullName: Word.TableOfFiguresAddOptions +summary: >- + Specifies the options for adding to a + [Word.TableOfFiguresCollection](xref:word!Word.TableOfFiguresCollection:class) + object. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: addedStyles + uid: word!Word.TableOfFiguresAddOptions#addedStyles:member + package: word! + fullName: addedStyles + summary: '' + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'addedStyles?: string;' + return: + type: string + - name: captionLabel + uid: word!Word.TableOfFiguresAddOptions#captionLabel:member + package: word! + fullName: captionLabel + summary: '' + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'captionLabel?: string;' + return: + type: string + - name: hidePageNumbersOnWeb + uid: word!Word.TableOfFiguresAddOptions#hidePageNumbersOnWeb:member + package: word! + fullName: hidePageNumbersOnWeb + summary: '' + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'hidePageNumbersOnWeb?: boolean;' + return: + type: boolean + - name: includeLabel + uid: word!Word.TableOfFiguresAddOptions#includeLabel:member + package: word! + fullName: includeLabel + summary: '' + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'includeLabel?: boolean;' + return: + type: boolean + - name: includePageNumbers + uid: word!Word.TableOfFiguresAddOptions#includePageNumbers:member + package: word! + fullName: includePageNumbers + summary: '' + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'includePageNumbers?: boolean;' + return: + type: boolean + - name: lowerHeadingLevel + uid: word!Word.TableOfFiguresAddOptions#lowerHeadingLevel:member + package: word! + fullName: lowerHeadingLevel + summary: '' + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'lowerHeadingLevel?: number;' + return: + type: number + - name: rightAlignPageNumbers + uid: word!Word.TableOfFiguresAddOptions#rightAlignPageNumbers:member + package: word! + fullName: rightAlignPageNumbers + summary: '' + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'rightAlignPageNumbers?: boolean;' + return: + type: boolean + - name: tableId + uid: word!Word.TableOfFiguresAddOptions#tableId:member + package: word! + fullName: tableId + summary: '' + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'tableId?: string;' + return: + type: string + - name: upperHeadingLevel + uid: word!Word.TableOfFiguresAddOptions#upperHeadingLevel:member + package: word! + fullName: upperHeadingLevel + summary: '' + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'upperHeadingLevel?: number;' + return: + type: number + - name: useBuiltInHeadingStyles + uid: word!Word.TableOfFiguresAddOptions#useBuiltInHeadingStyles:member + package: word! + fullName: useBuiltInHeadingStyles + summary: '' + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'useBuiltInHeadingStyles?: boolean;' + return: + type: boolean + - name: useFields + uid: word!Word.TableOfFiguresAddOptions#useFields:member + package: word! + fullName: useFields + summary: '' + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'useFields?: boolean;' + return: + type: boolean + - name: useHyperlinksOnWeb + uid: word!Word.TableOfFiguresAddOptions#useHyperlinksOnWeb:member + package: word! + fullName: useHyperlinksOnWeb + summary: '' + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'useHyperlinksOnWeb?: boolean;' + return: + type: boolean diff --git a/docs/docs-ref-autogen/word/word/word.tableoffigurescollection.yml b/docs/docs-ref-autogen/word/word/word.tableoffigurescollection.yml new file mode 100644 index 0000000000..0df3e96285 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.tableoffigurescollection.yml @@ -0,0 +1,245 @@ +### YamlMime:TSType +name: Word.TableOfFiguresCollection +uid: word!Word.TableOfFiguresCollection:class +package: word! +fullName: Word.TableOfFiguresCollection +summary: >- + Represents a collection of + [Word.TableOfFigures](xref:word!Word.TableOfFigures:class) objects in a Word + document. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: class +properties: + - name: context + uid: word!Word.TableOfFiguresCollection#context:member + package: word! + 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: true + isDeprecated: false + syntax: + content: 'context: RequestContext;' + return: + type: + - name: items + uid: word!Word.TableOfFiguresCollection#items:member + package: word! + fullName: items + summary: Gets the loaded child items in this collection. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly items: Word.TableOfFigures[];' + return: + type: [] +methods: + - name: add(range, options) + uid: word!Word.TableOfFiguresCollection#add:member(1) + package: word! + fullName: add(range, options) + summary: Adds a table of figures to the document at the specified range. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + add(range: Word.Range, options?: Word.TableOfFiguresAddOptions): + Word.TableOfFigures; + parameters: + - id: range + description: >- + The range where the table of figures will be added. The table of + figures replaces the range if the range isn't collapsed. + type: + - id: options + description: Optional. The options for configuring the table of figures. + type: + return: + type: + description: '' + - name: load(options) + uid: word!Word.TableOfFiguresCollection#load:member(1) + package: word! + 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: true + isDeprecated: false + syntax: + content: >- + load(options?: Word.Interfaces.TableOfFiguresCollectionLoadOptions & + Word.Interfaces.CollectionLoadOptions): Word.TableOfFiguresCollection; + parameters: + - id: options + description: Provides options for which properties of the object to load. + type: >- + & + return: + type: + description: '' + - name: load(propertyNames) + uid: word!Word.TableOfFiguresCollection#load:member(2) + package: word! + 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: true + isDeprecated: false + syntax: + content: 'load(propertyNames?: string | string[]): Word.TableOfFiguresCollection;' + 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: word!Word.TableOfFiguresCollection#load:member(3) + package: word! + 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: true + isDeprecated: false + syntax: + content: >- + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): + Word.TableOfFiguresCollection; + 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: markTocEntry(range, options) + uid: word!Word.TableOfFiguresCollection#markTocEntry:member(1) + package: word! + fullName: markTocEntry(range, options) + summary: >- + Inserts a [Table of Contents Entry (TC) + field](https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3) + after the specified range for marking entries in a table of figures. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + markTocEntry(range: Word.Range, options?: + Word.TableOfContentsMarkEntryOptions): Word.Field; + parameters: + - id: range + description: The range where the TC field will be inserted. + type: + - id: options + description: Optional. The options for marking the entry. + type: + return: + type: + description: '' + - name: toJSON() + uid: word!Word.TableOfFiguresCollection#toJSON:member(1) + package: word! + 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 + `Word.TableOfFiguresCollection` object is an API object, the `toJSON` + method returns a plain JavaScript object (typed as + `Word.Interfaces.TableOfFiguresCollectionData`) that contains an + "items" array with shallow copies of any loaded properties from the + collection's items. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'toJSON(): Word.Interfaces.TableOfFiguresCollectionData;' + return: + type: >- + + description: '' + - name: track() + uid: word!Word.TableOfFiguresCollection#track:member(1) + package: word! + fullName: track() + summary: >- + Track the object for automatic adjustment based on surrounding changes in + the document. This call is a shorthand for + [context.trackedObjects.add(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). If you're using this object across `.sync` calls and outside the + sequential execution of a ".run" batch, and get an "InvalidObjectPath" + error when setting a property or invoking a method on the object, you need + to add the object to the tracked object collection when the object was + first created. If this object is part of a collection, you should also + track the parent collection. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'track(): Word.TableOfFiguresCollection;' + return: + type: + description: '' + - name: untrack() + uid: word!Word.TableOfFiguresCollection#untrack:member(1) + package: word! + fullName: untrack() + summary: >- + Release the memory associated with this object, if it has previously been + tracked. This call is shorthand for + [context.trackedObjects.remove(thisObject)](https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member). Having many tracked objects slows down the host application, so + please remember to free any objects you add, once you're done using them. + You'll need to call `context.sync()` before the memory release takes + effect. + remarks: '' + + isPreview: true + isDeprecated: false + syntax: + content: 'untrack(): Word.TableOfFiguresCollection;' + return: + type: + description: '' +extends: diff --git a/docs/docs-ref-autogen/word/word/word.tablerow.yml b/docs/docs-ref-autogen/word/word/word.tablerow.yml index 232600cc76..4c97d6d117 100644 --- a/docs/docs-ref-autogen/word/word/word.tablerow.yml +++ b/docs/docs-ref-autogen/word/word/word.tablerow.yml @@ -237,6 +237,21 @@ properties: content: 'preferredHeight: number;' return: type: number + - name: range + uid: word!Word.TableRow#range:member + package: word! + fullName: range + summary: Returns the `Range` object that represents the table row. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly range: Word.Range;' + return: + type: - name: rowIndex uid: word!Word.TableRow#rowIndex:member package: word! @@ -252,6 +267,23 @@ properties: content: 'readonly rowIndex: number;' return: type: number + - name: shading + uid: word!Word.TableRow#shading:member + package: word! + fullName: shading + summary: >- + Returns the `ShadingUniversal` object that represents the shading of the + table row. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly shading: Word.ShadingUniversal;' + return: + type: - name: shadingColor uid: word!Word.TableRow#shadingColor:member package: word! @@ -322,6 +354,28 @@ methods: return: type: void description: '' + - name: convertToText(options) + uid: word!Word.TableRow#convertToText:member(1) + package: word! + fullName: convertToText(options) + summary: Converts the table row to text. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'convertToText(options?: Word.TableConvertToTextOptions): Word.Range;' + parameters: + - id: options + description: >- + Optional. An object that specifies the options for converting the + table row to text. + type: + return: + type: + description: '' - name: delete() uid: word!Word.TableRow#delete:member(1) package: word! @@ -859,6 +913,106 @@ methods: return: type: void description: '' + - name: setHeight(rowHeight, heightRule) + uid: word!Word.TableRow#setHeight:member(1) + package: word! + fullName: setHeight(rowHeight, heightRule) + summary: Sets the height of the row. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'setHeight(rowHeight: number, heightRule: Word.RowHeightRule): void;' + parameters: + - id: rowHeight + description: The height of the row, in points. + type: number + - id: heightRule + description: The rule for determining the height of the table row. + type: + return: + type: void + description: '' + - name: setHeight(rowHeight, heightRule) + uid: word!Word.TableRow#setHeight:member(2) + package: word! + fullName: setHeight(rowHeight, heightRule) + summary: Sets the height of the row. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + setHeight(rowHeight: number, heightRule: "Auto" | "AtLeast" | + "Exactly"): void; + parameters: + - id: rowHeight + description: The height of the row, in points. + type: number + - id: heightRule + description: The rule for determining the height of the table row. + type: '"Auto" | "AtLeast" | "Exactly"' + return: + type: void + description: '' + - name: setLeftIndent(leftIndent, rulerStyle) + uid: word!Word.TableRow#setLeftIndent:member(1) + package: word! + fullName: setLeftIndent(leftIndent, rulerStyle) + summary: Sets the left indent for the table row. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'setLeftIndent(leftIndent: number, rulerStyle: Word.RulerStyle): void;' + parameters: + - id: leftIndent + description: >- + The distance (in points) between the current left edge of the table + row and the desired left edge. + type: number + - id: rulerStyle + description: The ruler style to apply. + type: + return: + type: void + description: '' + - name: setLeftIndent(leftIndent, rulerStyle) + uid: word!Word.TableRow#setLeftIndent:member(2) + package: word! + fullName: setLeftIndent(leftIndent, rulerStyle) + summary: Sets the left indent for the table row. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + setLeftIndent(leftIndent: number, rulerStyle: "None" | "Proportional" | + "FirstColumn" | "SameWidth"): void; + parameters: + - id: leftIndent + description: >- + The distance (in points) between the current left edge of the table + row and the desired left edge. + type: number + - id: rulerStyle + description: The ruler style to apply. + type: '"None" | "Proportional" | "FirstColumn" | "SameWidth"' + return: + type: void + description: '' - name: toJSON() uid: word!Word.TableRow#toJSON:member(1) package: word! diff --git a/docs/docs-ref-autogen/word/word/word.tablerowcollection.yml b/docs/docs-ref-autogen/word/word/word.tablerowcollection.yml index 0f8303ab58..7287cbe39b 100644 --- a/docs/docs-ref-autogen/word/word/word.tablerowcollection.yml +++ b/docs/docs-ref-autogen/word/word/word.tablerowcollection.yml @@ -65,6 +65,60 @@ properties: return: type: [] methods: + - name: convertToText(options) + uid: word!Word.TableRowCollection#convertToText:member(1) + package: word! + fullName: convertToText(options) + summary: Converts rows in a table to text. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'convertToText(options?: Word.TableConvertToTextOptions): Word.Range;' + parameters: + - id: options + description: >- + Optional. An object that specifies the options for converting the + table rows to text. + type: + return: + type: + description: A `Range` object that represents the converted text. + - name: delete() + uid: word!Word.TableRowCollection#delete:member(1) + package: word! + fullName: delete() + summary: Deletes the table rows. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'delete(): void;' + return: + type: void + description: '' + - name: distributeHeight() + uid: word!Word.TableRowCollection#distributeHeight:member(1) + package: word! + fullName: distributeHeight() + summary: Adjusts the height of the rows so that they're equal. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'distributeHeight(): void;' + return: + type: void + description: '' - name: getFirst() uid: word!Word.TableRowCollection#getFirst:member(1) package: word! @@ -204,6 +258,122 @@ methods: return: type: description: '' + - name: select() + uid: word!Word.TableRowCollection#select:member(1) + package: word! + fullName: select() + summary: Selects the table rows. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'select(): void;' + return: + type: void + description: '' + - name: setHeight(rowHeight, heightRule) + uid: word!Word.TableRowCollection#setHeight:member(1) + package: word! + fullName: setHeight(rowHeight, heightRule) + summary: Sets the height of the cells in a table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'setHeight(rowHeight: number, heightRule: Word.RowHeightRule): void;' + parameters: + - id: rowHeight + description: The height of the row, in points. + type: number + - id: heightRule + description: The rule for determining the height of the specified rows. + type: + return: + type: void + description: '' + - name: setHeight(rowHeight, heightRule) + uid: word!Word.TableRowCollection#setHeight:member(2) + package: word! + fullName: setHeight(rowHeight, heightRule) + summary: Sets the height of the cells in a table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + setHeight(rowHeight: number, heightRule: "Auto" | "AtLeast" | + "Exactly"): void; + parameters: + - id: rowHeight + description: The height of the row, in points. + type: number + - id: heightRule + description: The rule for determining the height of the specified rows. + type: '"Auto" | "AtLeast" | "Exactly"' + return: + type: void + description: '' + - name: setLeftIndent(leftIndent, rulerStyle) + uid: word!Word.TableRowCollection#setLeftIndent:member(1) + package: word! + fullName: setLeftIndent(leftIndent, rulerStyle) + summary: Sets the left indent for the table row. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'setLeftIndent(leftIndent: number, rulerStyle: Word.RulerStyle): void;' + parameters: + - id: leftIndent + description: >- + The distance (in points) between the current left edge of the + specified rows and the desired left edge. + type: number + - id: rulerStyle + description: The ruler style to apply. + type: + return: + type: void + description: '' + - name: setLeftIndent(leftIndent, rulerStyle) + uid: word!Word.TableRowCollection#setLeftIndent:member(2) + package: word! + fullName: setLeftIndent(leftIndent, rulerStyle) + summary: Sets the left indent for the table row. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + setLeftIndent(leftIndent: number, rulerStyle: "None" | "Proportional" | + "FirstColumn" | "SameWidth"): void; + parameters: + - id: leftIndent + description: >- + The distance (in points) between the current left edge of the + specified rows and the desired left edge. + type: number + - id: rulerStyle + description: The ruler style to apply. + type: '"None" | "Proportional" | "FirstColumn" | "SameWidth"' + return: + type: void + description: '' - name: toJSON() uid: word!Word.TableRowCollection#toJSON:member(1) package: word! diff --git a/docs/docs-ref-autogen/word/word/word.tablesortoptions.yml b/docs/docs-ref-autogen/word/word/word.tablesortoptions.yml new file mode 100644 index 0000000000..37abf2dc34 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.tablesortoptions.yml @@ -0,0 +1,421 @@ +### YamlMime:TSType +name: Word.TableSortOptions +uid: word!Word.TableSortOptions:interface +package: word! +fullName: Word.TableSortOptions +summary: >- + Represents the options for the [Table.sort](xref:word!Word.Table:class) + method. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +type: interface +properties: + - name: bidirectionalSort + uid: word!Word.TableSortOptions#bidirectionalSort:member + package: word! + fullName: bidirectionalSort + summary: >- + If provided, specifies whether to use bidirectional sort. `true` means to + sort based on right-to-left language rules. This property may not be + available to you, depending on the language support (U.S. English, for + example) that you have selected or installed. The default value is + `false`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'bidirectionalSort?: boolean;' + return: + type: boolean + - name: caseSensitive + uid: word!Word.TableSortOptions#caseSensitive:member + package: word! + fullName: caseSensitive + summary: >- + If provided, specifies whether sorting is case-sensitive. The default + value is `false`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'caseSensitive?: boolean;' + return: + type: boolean + - name: excludeHeader + uid: word!Word.TableSortOptions#excludeHeader:member + package: word! + fullName: excludeHeader + summary: >- + If provided, specifies whether to exclude the header row from the sort + operation. The default value is `false`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'excludeHeader?: boolean;' + return: + type: boolean + - name: fieldNumber + uid: word!Word.TableSortOptions#fieldNumber:member + package: word! + fullName: fieldNumber + summary: >- + If provided, specifies the first field to sort by. Microsoft Word sorts by + `fieldNumber`, then by `fieldNumber2`, and finally by + `fieldNumber3`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'fieldNumber?: string;' + return: + type: string + - name: fieldNumber2 + uid: word!Word.TableSortOptions#fieldNumber2:member + package: word! + fullName: fieldNumber2 + summary: If provided, specifies the second field to sort by. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'fieldNumber2?: string;' + return: + type: string + - name: fieldNumber3 + uid: word!Word.TableSortOptions#fieldNumber3:member + package: word! + fullName: fieldNumber3 + summary: If provided, specifies the third field to sort by. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'fieldNumber3?: string;' + return: + type: string + - name: ignoreArabicThe + uid: word!Word.TableSortOptions#ignoreArabicThe:member + package: word! + fullName: ignoreArabicThe + summary: >- + If provided, specifies whether to ignore Arabic character alef lam when + sorting right-to-left language text. This property may not be available to + you, depending on the language support (U.S. English, for example) that + you have selected or installed. The default value is `false`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'ignoreArabicThe?: boolean;' + return: + type: boolean + - name: ignoreDiacritics + uid: word!Word.TableSortOptions#ignoreDiacritics:member + package: word! + fullName: ignoreDiacritics + summary: >- + If provided, specifies whether to ignore bidirectional control characters + when sorting right-to-left language text. This property may not be + available to you, depending on the language support (U.S. English, for + example) that you have selected or installed. The default value is + `false`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'ignoreDiacritics?: boolean;' + return: + type: boolean + - name: ignoreHebrew + uid: word!Word.TableSortOptions#ignoreHebrew:member + package: word! + fullName: ignoreHebrew + summary: >- + If provided, specifies whether to ignore Hebrew characters when sorting + right-to-left language text. This property may not be available to you, + depending on the language support (U.S. English, for example) that you + have selected or installed. The default value is `false`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'ignoreHebrew?: boolean;' + return: + type: boolean + - name: ignoreKashida + uid: word!Word.TableSortOptions#ignoreKashida:member + package: word! + fullName: ignoreKashida + summary: >- + If provided, specifies whether to ignore kashida when sorting + right-to-left language text. This property may not be available to you, + depending on the language support (U.S. English, for example) that you + have selected or installed. The default value is `false`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'ignoreKashida?: boolean;' + return: + type: boolean + - name: languageId + uid: word!Word.TableSortOptions#languageId:member + package: word! + fullName: languageId + summary: If provided, specifies the sorting language. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | + "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | + "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | + "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | + "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | + "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | + "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | + "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | + "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" + | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | + "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | + "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | + "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | + "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" + | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | + "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | + "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | + "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" + | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" + | "Galician" | "Georgian" | "German" | "GermanAustria" | + "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | + "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | + "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" + | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | + "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | + "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | + "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | + "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | + "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | + "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | + "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | + "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | + "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | + "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | + "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | + "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | + "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | + "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | + "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" + | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | + "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" + | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | + "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | + "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | + "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | + "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | + "Yiddish" | "Yoruba" | "Zulu"; + return: + type: >- + | "Afrikaans" | "Albanian" | + "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | + "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | + "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | + "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | + "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | + "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" + | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | + "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | + "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | + "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | + "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | + "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | + "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | + "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" + | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | + "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | + "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | + "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | + "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" + | "Galician" | "Georgian" | "German" | "GermanAustria" | + "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | + "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | + "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | + "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" + | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | + "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | + "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | + "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | + "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | + "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | + "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | + "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | + "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | + "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | + "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | + "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | + "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | + "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | + "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | + "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | + "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | + "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" + | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" + | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | + "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | + "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | + "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | + "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | + "Zulu" + - name: sortFieldType + uid: word!Word.TableSortOptions#sortFieldType:member + package: word! + fullName: sortFieldType + summary: >- + If provided, specifies the type of the first field to sort by. The default + value is `alphanumeric`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + sortFieldType?: Word.SortFieldType | "Alphanumeric" | "Numeric" | "Date" + | "Syllable" | "JapanJis" | "Stroke" | "KoreaKs"; + return: + type: >- + | "Alphanumeric" | + "Numeric" | "Date" | "Syllable" | "JapanJis" | "Stroke" | "KoreaKs" + - name: sortFieldType2 + uid: word!Word.TableSortOptions#sortFieldType2:member + package: word! + fullName: sortFieldType2 + summary: >- + If provided, specifies the type of the second field to sort by. The + default value is `alphanumeric`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + sortFieldType2?: Word.SortFieldType | "Alphanumeric" | "Numeric" | + "Date" | "Syllable" | "JapanJis" | "Stroke" | "KoreaKs"; + return: + type: >- + | "Alphanumeric" | + "Numeric" | "Date" | "Syllable" | "JapanJis" | "Stroke" | "KoreaKs" + - name: sortFieldType3 + uid: word!Word.TableSortOptions#sortFieldType3:member + package: word! + fullName: sortFieldType3 + summary: >- + If provided, specifies the type of the third field to sort by. The default + value is `alphanumeric`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + sortFieldType3?: Word.SortFieldType | "Alphanumeric" | "Numeric" | + "Date" | "Syllable" | "JapanJis" | "Stroke" | "KoreaKs"; + return: + type: >- + | "Alphanumeric" | + "Numeric" | "Date" | "Syllable" | "JapanJis" | "Stroke" | "KoreaKs" + - name: sortOrder + uid: word!Word.TableSortOptions#sortOrder:member + package: word! + fullName: sortOrder + summary: >- + If provided, specifies the sort order of the first field to sort by. The + default value is `ascending`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'sortOrder?: Word.SortOrder | "Ascending" | "Descending";' + return: + type: | "Ascending" | "Descending" + - name: sortOrder2 + uid: word!Word.TableSortOptions#sortOrder2:member + package: word! + fullName: sortOrder2 + summary: >- + If provided, specifies the sort order of the second field to sort by. The + default value is `ascending`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'sortOrder2?: Word.SortOrder | "Ascending" | "Descending";' + return: + type: | "Ascending" | "Descending" + - name: sortOrder3 + uid: word!Word.TableSortOptions#sortOrder3:member + package: word! + fullName: sortOrder3 + summary: >- + If provided, specifies the sort order of the third field to sort by. The + default value is `ascending`. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'sortOrder3?: Word.SortOrder | "Ascending" | "Descending";' + return: + type: | "Ascending" | "Descending" diff --git a/docs/docs-ref-autogen/word/word/word.tablestyle.yml b/docs/docs-ref-autogen/word/word/word.tablestyle.yml index 7afeeb7762..f2019f87c6 100644 --- a/docs/docs-ref-autogen/word/word/word.tablestyle.yml +++ b/docs/docs-ref-autogen/word/word/word.tablestyle.yml @@ -91,6 +91,23 @@ properties: content: 'allowBreakAcrossPage: boolean;' return: type: boolean + - name: borders + uid: word!Word.TableStyle#borders:member + package: word! + fullName: borders + summary: >- + Returns a `BorderUniversalCollection` that represents all the borders for + the table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly borders: Word.BorderUniversalCollection;' + return: + type: - name: bottomCellMargin uid: word!Word.TableStyle#bottomCellMargin:member package: word! @@ -123,6 +140,23 @@ properties: content: 'cellSpacing: number;' return: type: number + - name: columnStripe + uid: word!Word.TableStyle#columnStripe:member + package: word! + fullName: columnStripe + summary: >- + Specifies the number of columns in the banding when a style specifies odd- + or even-column banding. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'columnStripe: number;' + return: + type: number - name: context uid: word!Word.TableStyle#context:member package: word! @@ -138,6 +172,23 @@ properties: content: 'context: RequestContext;' return: type: + - name: isBreakAcrossPagesAllowed + uid: word!Word.TableStyle#isBreakAcrossPagesAllowed:member + package: word! + fullName: isBreakAcrossPagesAllowed + summary: >- + Specifies whether Microsoft Word allows to break the specified table + across pages. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'isBreakAcrossPagesAllowed: boolean;' + return: + type: boolean - name: leftCellMargin uid: word!Word.TableStyle#leftCellMargin:member package: word! @@ -155,6 +206,23 @@ properties: content: 'leftCellMargin: number;' return: type: number + - name: leftIndent + uid: word!Word.TableStyle#leftIndent:member + package: word! + fullName: leftIndent + summary: >- + Specifies the left indent value (in points) for the rows in the table + style. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'leftIndent: number;' + return: + type: number - name: rightCellMargin uid: word!Word.TableStyle#rightCellMargin:member package: word! @@ -172,6 +240,59 @@ properties: content: 'rightCellMargin: number;' return: type: number + - name: rowStripe + uid: word!Word.TableStyle#rowStripe:member + package: word! + fullName: rowStripe + summary: >- + Specifies the number of rows to include in the banding when the style + specifies odd- or even-row banding. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'rowStripe: number;' + return: + type: number + - name: shading + uid: word!Word.TableStyle#shading:member + package: word! + fullName: shading + summary: >- + Returns a `ShadingUniversal` object that refers to the shading formatting + for the table style. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly shading: Word.Shading;' + return: + type: + - name: tableDirection + uid: word!Word.TableStyle#tableDirection:member + package: word! + fullName: tableDirection + summary: >- + Specifies the direction in which Microsoft Word orders cells in the table + style. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'tableDirection: Word.TableDirection | "RightToLeft" | "LeftToRight";' + return: + type: >- + | "RightToLeft" | + "LeftToRight" - name: topCellMargin uid: word!Word.TableStyle#topCellMargin:member package: word! @@ -190,6 +311,58 @@ properties: return: type: number methods: + - name: condition(conditionCode) + uid: word!Word.TableStyle#condition:member(1) + package: word! + fullName: condition(conditionCode) + summary: >- + Returns a `ConditionalStyle` object that represents special style + formatting for a portion of a table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'condition(conditionCode: Word.ConditionCode): Word.ConditionalStyle;' + parameters: + - id: conditionCode + description: The area of the table to which to apply the formatting. + type: + return: + type: + description: '' + - name: condition(conditionCode) + uid: word!Word.TableStyle#condition:member(2) + package: word! + fullName: condition(conditionCode) + summary: >- + Returns a `ConditionalStyle` object that represents special style + formatting for a portion of a table. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: >- + condition(conditionCode: "FirstRow" | "LastRow" | "OddRowBanding" | + "EvenRowBanding" | "FirstColumn" | "LastColumn" | "OddColumnBanding" | + "EvenColumnBanding" | "TopRightCell" | "TopLeftCell" | "BottomRightCell" + | "BottomLeftCell"): Word.ConditionalStyle; + parameters: + - id: conditionCode + description: The area of the table to which to apply the formatting. + type: >- + "FirstRow" | "LastRow" | "OddRowBanding" | "EvenRowBanding" | + "FirstColumn" | "LastColumn" | "OddColumnBanding" | + "EvenColumnBanding" | "TopRightCell" | "TopLeftCell" | + "BottomRightCell" | "BottomLeftCell" + return: + type: + description: '' - name: load(options) uid: word!Word.TableStyle#load:member(1) package: word! diff --git a/docs/docs-ref-autogen/word/word/word.template.yml b/docs/docs-ref-autogen/word/word/word.template.yml index ab1f3f2e1c..373e12c225 100644 --- a/docs/docs-ref-autogen/word/word/word.template.yml +++ b/docs/docs-ref-autogen/word/word/word.template.yml @@ -395,6 +395,23 @@ properties: "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu" + - name: listTemplates + uid: word!Word.Template#listTemplates:member + package: word! + fullName: listTemplates + summary: >- + Returns a `ListTemplateCollection` object that represents all the list + templates in the template. + remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + + isPreview: true + isDeprecated: false + syntax: + content: 'readonly listTemplates: Word.ListTemplateCollection;' + return: + type: - name: name uid: word!Word.Template#name:member package: word! diff --git a/docs/docs-ref-autogen/word/word/word.textorientation.yml b/docs/docs-ref-autogen/word/word/word.textorientation.yml new file mode 100644 index 0000000000..475b363ac4 --- /dev/null +++ b/docs/docs-ref-autogen/word/word/word.textorientation.yml @@ -0,0 +1,74 @@ +### YamlMime:TSEnum +name: Word.TextOrientation +uid: word!Word.TextOrientation:enum +package: word! +fullName: Word.TextOrientation +summary: Specifies the orientation of text in a text frame or shape. +remarks: >- + \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + +isPreview: true +isDeprecated: false +fields: + - name: downward + uid: word!Word.TextOrientation.downward:member + package: word! + summary: >- + Text is vertical with letters rotated 90 degrees counterclockwise. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Downward"' + - name: horizontal + uid: word!Word.TextOrientation.horizontal:member + package: word! + summary: >- + Text is horizontal. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Horizontal"' + - name: horizontalRotatedFarEast + uid: word!Word.TextOrientation.horizontalRotatedFarEast:member + package: word! + summary: >- + Text is horizontal but from right to left to accommodate right-to-left + languages. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"HorizontalRotatedFarEast"' + - name: upward + uid: word!Word.TextOrientation.upward:member + package: word! + summary: >- + Text is vertical with letters rotated 90 degrees clockwise. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Upward"' + - name: vertical + uid: word!Word.TextOrientation.vertical:member + package: word! + summary: >- + Text is vertical and reads downward from the top, left to right. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"Vertical"' + - name: verticalFarEast + uid: word!Word.TextOrientation.verticalFarEast:member + package: word! + summary: >- + Text is vertical and reads downward from the top, right to left. + + + * \[ [API set: WordApi BETA (PREVIEW + ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] + value: '"VerticalFarEast"' diff --git a/docs/docs-ref-autogen/word/word/word.window.yml b/docs/docs-ref-autogen/word/word/word.window.yml index 62dffeddc6..e36d6688ed 100644 --- a/docs/docs-ref-autogen/word/word/word.window.yml +++ b/docs/docs-ref-autogen/word/word/word.window.yml @@ -247,10 +247,10 @@ properties: content: 'horizontalPercentScrolled: number;' return: type: number - - name: imemode - uid: word!Word.Window#imemode:member + - name: imeMode + uid: word!Word.Window#imeMode:member package: word! - fullName: imemode + fullName: imeMode summary: >- Specifies the default start-up mode for the Japanese Input Method Editor (IME). @@ -262,7 +262,7 @@ properties: isDeprecated: false syntax: content: >- - imemode: Word.ImeMode | "NoControl" | "On" | "Off" | "Hiragana" | + imeMode: Word.ImeMode | "NoControl" | "On" | "Off" | "Hiragana" | "Katakana" | "KatakanaHalf" | "AlphaFull" | "Alpha" | "HangulFull" | "Hangul"; return: diff --git a/docs/includes/excel-1_1.md b/docs/includes/excel-1_1.md index a10a15841b..7b5da6c0ad 100644 --- a/docs/includes/excel-1_1.md +++ b/docs/includes/excel-1_1.md @@ -1,219 +1,219 @@ | Class | Fields | Description | |:---|:---|:---| -|[Application](/.application)|[calculate(calculationType: Excel.CalculationType)](/.application#excel-javascript/api/excel/-application-calculate-member(1))|Recalculate all currently opened workbooks in Excel.| -||[calculationMode](/.application#excel-javascript/api/excel/-application-calculationmode-member)|Returns the calculation mode used in the workbook, as defined by the constants in `Excel.CalculationMode`.| -|[Binding](/.binding)|[getRange()](/.binding#excel-javascript/api/excel/-binding-getrange-member(1))|Returns the range represented by the binding.| -||[getTable()](/.binding#excel-javascript/api/excel/-binding-gettable-member(1))|Returns the table represented by the binding.| -||[getText()](/.binding#excel-javascript/api/excel/-binding-gettext-member(1))|Returns the text represented by the binding.| -||[id](/.binding#excel-javascript/api/excel/-binding-id-member)|Represents the binding identifier.| -||[type](/.binding#excel-javascript/api/excel/-binding-type-member)|Returns the type of the binding.| -|[BindingCollection](/.bindingcollection)|[count](/.bindingcollection#excel-javascript/api/excel/-bindingcollection-count-member)|Returns the number of bindings in the collection.| -||[getItem(id: string)](/.bindingcollection#excel-javascript/api/excel/-bindingcollection-getitem-member(1))|Gets a binding object by ID.| -||[getItemAt(index: number)](/.bindingcollection#excel-javascript/api/excel/-bindingcollection-getitemat-member(1))|Gets a binding object based on its position in the items array.| -||[items](/.bindingcollection#excel-javascript/api/excel/-bindingcollection-items-member)|Gets the loaded child items in this collection.| -|[Chart](/.chart)|[axes](/.chart#excel-javascript/api/excel/-chart-axes-member)|Represents chart axes.| -||[dataLabels](/.chart#excel-javascript/api/excel/-chart-datalabels-member)|Represents the data labels on the chart.| -||[delete()](/.chart#excel-javascript/api/excel/-chart-delete-member(1))|Deletes the chart object.| -||[format](/.chart#excel-javascript/api/excel/-chart-format-member)|Encapsulates the format properties for the chart area.| -||[height](/.chart#excel-javascript/api/excel/-chart-height-member)|Specifies the height, in points, of the chart object.| -||[left](/.chart#excel-javascript/api/excel/-chart-left-member)|The distance, in points, from the left side of the chart to the worksheet origin.| -||[legend](/.chart#excel-javascript/api/excel/-chart-legend-member)|Represents the legend for the chart.| -||[name](/.chart#excel-javascript/api/excel/-chart-name-member)|Specifies the name of a chart object.| -||[series](/.chart#excel-javascript/api/excel/-chart-series-member)|Represents either a single series or collection of series in the chart.| -||[setData(sourceData: Range, seriesBy?: Excel.ChartSeriesBy)](/.chart#excel-javascript/api/excel/-chart-setdata-member(1))|Resets the source data for the chart.| -||[setPosition(startCell: Range \| string, endCell?: Range \| string)](/.chart#excel-javascript/api/excel/-chart-setposition-member(1))|Positions the chart relative to cells on the worksheet.| -||[title](/.chart#excel-javascript/api/excel/-chart-title-member)|Represents the title of the specified chart, including the text, visibility, position, and formatting of the title.| -||[top](/.chart#excel-javascript/api/excel/-chart-top-member)|Specifies the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top of the chart area (on a chart).| -||[width](/.chart#excel-javascript/api/excel/-chart-width-member)|Specifies the width, in points, of the chart object.| -|[ChartAreaFormat](/.chartareaformat)|[fill](/.chartareaformat#excel-javascript/api/excel/-chartareaformat-fill-member)|Represents the fill format of an object, which includes background formatting information.| -||[font](/.chartareaformat#excel-javascript/api/excel/-chartareaformat-font-member)|Represents the font attributes (font name, font size, color, etc.) for the current object.| -|[ChartAxes](/.chartaxes)|[categoryAxis](/.chartaxes#excel-javascript/api/excel/-chartaxes-categoryaxis-member)|Represents the category axis in a chart.| -||[seriesAxis](/.chartaxes#excel-javascript/api/excel/-chartaxes-seriesaxis-member)|Represents the series axis of a 3-D chart.| -||[valueAxis](/.chartaxes#excel-javascript/api/excel/-chartaxes-valueaxis-member)|Represents the value axis in an axis.| -|[ChartAxis](/.chartaxis)|[format](/.chartaxis#excel-javascript/api/excel/-chartaxis-format-member)|Represents the formatting of a chart object, which includes line and font formatting.| -||[majorGridlines](/.chartaxis#excel-javascript/api/excel/-chartaxis-majorgridlines-member)|Returns an object that represents the major gridlines for the specified axis.| -||[majorUnit](/.chartaxis#excel-javascript/api/excel/-chartaxis-majorunit-member)|Represents the interval between two major tick marks.| -||[maximum](/.chartaxis#excel-javascript/api/excel/-chartaxis-maximum-member)|Represents the maximum value on the value axis.| -||[minimum](/.chartaxis#excel-javascript/api/excel/-chartaxis-minimum-member)|Represents the minimum value on the value axis.| -||[minorGridlines](/.chartaxis#excel-javascript/api/excel/-chartaxis-minorgridlines-member)|Returns an object that represents the minor gridlines for the specified axis.| -||[minorUnit](/.chartaxis#excel-javascript/api/excel/-chartaxis-minorunit-member)|Represents the interval between two minor tick marks.| -||[title](/.chartaxis#excel-javascript/api/excel/-chartaxis-title-member)|Represents the axis title.| -|[ChartAxisFormat](/.chartaxisformat)|[font](/.chartaxisformat#excel-javascript/api/excel/-chartaxisformat-font-member)|Specifies the font attributes (font name, font size, color, etc.) for a chart axis element.| -||[line](/.chartaxisformat#excel-javascript/api/excel/-chartaxisformat-line-member)|Specifies chart line formatting.| -|[ChartAxisTitle](/.chartaxistitle)|[format](/.chartaxistitle#excel-javascript/api/excel/-chartaxistitle-format-member)|Specifies the formatting of the chart axis title.| -||[text](/.chartaxistitle#excel-javascript/api/excel/-chartaxistitle-text-member)|Specifies the axis title.| -||[visible](/.chartaxistitle#excel-javascript/api/excel/-chartaxistitle-visible-member)|Specifies if the axis title is visible.| -|[ChartAxisTitleFormat](/.chartaxistitleformat)|[font](/.chartaxistitleformat#excel-javascript/api/excel/-chartaxistitleformat-font-member)|Specifies the chart axis title's font attributes, such as font name, font size, or color, of the chart axis title object.| -|[ChartCollection](/.chartcollection)|[add(type: Excel.ChartType, sourceData: Range, seriesBy?: Excel.ChartSeriesBy)](/.chartcollection#excel-javascript/api/excel/-chartcollection-add-member(1))|Creates a new chart.| -||[count](/.chartcollection#excel-javascript/api/excel/-chartcollection-count-member)|Returns the number of charts in the worksheet.| -||[getItem(name: string)](/.chartcollection#excel-javascript/api/excel/-chartcollection-getitem-member(1))|Gets a chart using its name.| -||[getItemAt(index: number)](/.chartcollection#excel-javascript/api/excel/-chartcollection-getitemat-member(1))|Gets a chart based on its position in the collection.| -||[items](/.chartcollection#excel-javascript/api/excel/-chartcollection-items-member)|Gets the loaded child items in this collection.| -|[ChartDataLabelFormat](/.chartdatalabelformat)|[fill](/.chartdatalabelformat#excel-javascript/api/excel/-chartdatalabelformat-fill-member)|Represents the fill format of the current chart data label.| -||[font](/.chartdatalabelformat#excel-javascript/api/excel/-chartdatalabelformat-font-member)|Represents the font attributes (such as font name, font size, and color) for a chart data label.| -|[ChartDataLabels](/.chartdatalabels)|[format](/.chartdatalabels#excel-javascript/api/excel/-chartdatalabels-format-member)|Specifies the format of chart data labels, which includes fill and font formatting.| -||[position](/.chartdatalabels#excel-javascript/api/excel/-chartdatalabels-position-member)|Value that represents the position of the data label.| -||[separator](/.chartdatalabels#excel-javascript/api/excel/-chartdatalabels-separator-member)|String representing the separator used for the data labels on a chart.| -||[showBubbleSize](/.chartdatalabels#excel-javascript/api/excel/-chartdatalabels-showbubblesize-member)|Specifies if the data label bubble size is visible.| -||[showCategoryName](/.chartdatalabels#excel-javascript/api/excel/-chartdatalabels-showcategoryname-member)|Specifies if the data label category name is visible.| -||[showLegendKey](/.chartdatalabels#excel-javascript/api/excel/-chartdatalabels-showlegendkey-member)|Specifies if the data label legend key is visible.| -||[showPercentage](/.chartdatalabels#excel-javascript/api/excel/-chartdatalabels-showpercentage-member)|Specifies if the data label percentage is visible.| -||[showSeriesName](/.chartdatalabels#excel-javascript/api/excel/-chartdatalabels-showseriesname-member)|Specifies if the data label series name is visible.| -||[showValue](/.chartdatalabels#excel-javascript/api/excel/-chartdatalabels-showvalue-member)|Specifies if the data label value is visible.| -|[ChartFill](/.chartfill)|[clear()](/.chartfill#excel-javascript/api/excel/-chartfill-clear-member(1))|Clears the fill color of a chart element.| -||[setSolidColor(color: string)](/.chartfill#excel-javascript/api/excel/-chartfill-setsolidcolor-member(1))|Sets the fill formatting of a chart element to a uniform color.| -|[ChartFont](/.chartfont)|[bold](/.chartfont#excel-javascript/api/excel/-chartfont-bold-member)|Represents the bold status of font.| -||[color](/.chartfont#excel-javascript/api/excel/-chartfont-color-member)|HTML color code representation of the text color (e.g., #FF0000 represents Red).| -||[italic](/.chartfont#excel-javascript/api/excel/-chartfont-italic-member)|Represents the italic status of the font.| -||[name](/.chartfont#excel-javascript/api/excel/-chartfont-name-member)|Font name (e.g., "Calibri")| -||[size](/.chartfont#excel-javascript/api/excel/-chartfont-size-member)|Size of the font (e.g., 11)| -||[underline](/.chartfont#excel-javascript/api/excel/-chartfont-underline-member)|Type of underline applied to the font.| -|[ChartGridlines](/.chartgridlines)|[format](/.chartgridlines#excel-javascript/api/excel/-chartgridlines-format-member)|Represents the formatting of chart gridlines.| -||[visible](/.chartgridlines#excel-javascript/api/excel/-chartgridlines-visible-member)|Specifies if the axis gridlines are visible.| -|[ChartGridlinesFormat](/.chartgridlinesformat)|[line](/.chartgridlinesformat#excel-javascript/api/excel/-chartgridlinesformat-line-member)|Represents chart line formatting.| -|[ChartLegend](/.chartlegend)|[format](/.chartlegend#excel-javascript/api/excel/-chartlegend-format-member)|Represents the formatting of a chart legend, which includes fill and font formatting.| -||[overlay](/.chartlegend#excel-javascript/api/excel/-chartlegend-overlay-member)|Specifies if the chart legend should overlap with the main body of the chart.| -||[position](/.chartlegend#excel-javascript/api/excel/-chartlegend-position-member)|Specifies the position of the legend on the chart.| -||[visible](/.chartlegend#excel-javascript/api/excel/-chartlegend-visible-member)|Specifies if the chart legend is visible.| -|[ChartLegendFormat](/.chartlegendformat)|[fill](/.chartlegendformat#excel-javascript/api/excel/-chartlegendformat-fill-member)|Represents the fill format of an object, which includes background formatting information.| -||[font](/.chartlegendformat#excel-javascript/api/excel/-chartlegendformat-font-member)|Represents the font attributes such as font name, font size, and color of a chart legend.| -|[ChartLineFormat](/.chartlineformat)|[clear()](/.chartlineformat#excel-javascript/api/excel/-chartlineformat-clear-member(1))|Clears the line format of a chart element.| -||[color](/.chartlineformat#excel-javascript/api/excel/-chartlineformat-color-member)|HTML color code representing the color of lines in the chart.| -|[ChartPoint](/.chartpoint)|[format](/.chartpoint#excel-javascript/api/excel/-chartpoint-format-member)|Encapsulates the format properties chart point.| -||[value](/.chartpoint#excel-javascript/api/excel/-chartpoint-value-member)|Returns the value of a chart point.| -|[ChartPointFormat](/.chartpointformat)|[fill](/.chartpointformat#excel-javascript/api/excel/-chartpointformat-fill-member)|Represents the fill format of a chart, which includes background formatting information.| -|[ChartPointsCollection](/.chartpointscollection)|[count](/.chartpointscollection#excel-javascript/api/excel/-chartpointscollection-count-member)|Returns the number of chart points in the series.| -||[getItemAt(index: number)](/.chartpointscollection#excel-javascript/api/excel/-chartpointscollection-getitemat-member(1))|Retrieve a point based on its position within the series.| -||[items](/.chartpointscollection#excel-javascript/api/excel/-chartpointscollection-items-member)|Gets the loaded child items in this collection.| -|[ChartSeries](/.chartseries)|[format](/.chartseries#excel-javascript/api/excel/-chartseries-format-member)|Represents the formatting of a chart series, which includes fill and line formatting.| -||[name](/.chartseries#excel-javascript/api/excel/-chartseries-name-member)|Specifies the name of a series in a chart.| -||[points](/.chartseries#excel-javascript/api/excel/-chartseries-points-member)|Returns a collection of all points in the series.| -|[ChartSeriesCollection](/.chartseriescollection)|[count](/.chartseriescollection#excel-javascript/api/excel/-chartseriescollection-count-member)|Returns the number of series in the collection.| -||[getItemAt(index: number)](/.chartseriescollection#excel-javascript/api/excel/-chartseriescollection-getitemat-member(1))|Retrieves a series based on its position in the collection.| -||[items](/.chartseriescollection#excel-javascript/api/excel/-chartseriescollection-items-member)|Gets the loaded child items in this collection.| -|[ChartSeriesFormat](/.chartseriesformat)|[fill](/.chartseriesformat#excel-javascript/api/excel/-chartseriesformat-fill-member)|Represents the fill format of a chart series, which includes background formatting information.| -||[line](/.chartseriesformat#excel-javascript/api/excel/-chartseriesformat-line-member)|Represents line formatting.| -|[ChartTitle](/.charttitle)|[format](/.charttitle#excel-javascript/api/excel/-charttitle-format-member)|Represents the formatting of a chart title, which includes fill and font formatting.| -||[overlay](/.charttitle#excel-javascript/api/excel/-charttitle-overlay-member)|Specifies if the chart title will overlay the chart.| -||[text](/.charttitle#excel-javascript/api/excel/-charttitle-text-member)|Specifies the chart's title text.| -||[visible](/.charttitle#excel-javascript/api/excel/-charttitle-visible-member)|Specifies if the chart title is visible.| -|[ChartTitleFormat](/.charttitleformat)|[fill](/.charttitleformat#excel-javascript/api/excel/-charttitleformat-fill-member)|Represents the fill format of an object, which includes background formatting information.| -||[font](/.charttitleformat#excel-javascript/api/excel/-charttitleformat-font-member)|Represents the font attributes (such as font name, font size, and color) for an object.| -|[NamedItem](/.nameditem)|[getRange()](/.nameditem#excel-javascript/api/excel/-nameditem-getrange-member(1))|Returns the range object that is associated with the name.| -||[name](/.nameditem#excel-javascript/api/excel/-nameditem-name-member)|The name of the object.| -||[type](/.nameditem#excel-javascript/api/excel/-nameditem-type-member)|Specifies the type of the value returned by the name's formula.| -||[value](/.nameditem#excel-javascript/api/excel/-nameditem-value-member)|Represents the value computed by the name's formula.| -||[visible](/.nameditem#excel-javascript/api/excel/-nameditem-visible-member)|Specifies if the object is visible.| -|[NamedItemCollection](/.nameditemcollection)|[getItem(name: string)](/.nameditemcollection#excel-javascript/api/excel/-nameditemcollection-getitem-member(1))|Gets a `NamedItem` object using its name.| -||[items](/.nameditemcollection#excel-javascript/api/excel/-nameditemcollection-items-member)|Gets the loaded child items in this collection.| -|[Range](/.range)|[address](/.range#excel-javascript/api/excel/-range-address-member)|Specifies the range reference in A1-style.| -||[addressLocal](/.range#excel-javascript/api/excel/-range-addresslocal-member)|Represents the range reference for the specified range in the language of the user.| -||[cellCount](/.range#excel-javascript/api/excel/-range-cellcount-member)|Specifies the number of cells in the range.| -||[clear(applyTo?: Excel.ClearApplyTo)](/.range#excel-javascript/api/excel/-range-clear-member(1))|Clear range values and formatting, such as fill and border.| -||[columnCount](/.range#excel-javascript/api/excel/-range-columncount-member)|Specifies the total number of columns in the range.| -||[columnIndex](/.range#excel-javascript/api/excel/-range-columnindex-member)|Specifies the column number of the first cell in the range.| -||[delete(shift: Excel.DeleteShiftDirection)](/.range#excel-javascript/api/excel/-range-delete-member(1))|Deletes the cells associated with the range.| -||[format](/.range#excel-javascript/api/excel/-range-format-member)|Returns a format object, encapsulating the range's font, fill, borders, alignment, and other properties.| -||[formulas](/.range#excel-javascript/api/excel/-range-formulas-member)|Represents the formula in A1-style notation.| -||[formulasLocal](/.range#excel-javascript/api/excel/-range-formulaslocal-member)|Represents the formula in A1-style notation, in the user's language and number-formatting locale.| -||[getBoundingRect(anotherRange: Range \| string)](/.range#excel-javascript/api/excel/-range-getboundingrect-member(1))|Gets the smallest range object that encompasses the given ranges.| -||[getCell(row: number, column: number)](/.range#excel-javascript/api/excel/-range-getcell-member(1))|Gets the range object containing the single cell based on row and column numbers.| -||[getColumn(column: number)](/.range#excel-javascript/api/excel/-range-getcolumn-member(1))|Gets a column contained in the range.| -||[getEntireColumn()](/.range#excel-javascript/api/excel/-range-getentirecolumn-member(1))|Gets an object that represents the entire column of the range (for example, if the current range represents cells "B4:E11", its `getEntireColumn` is a range that represents columns "B:E").| -||[getEntireRow()](/.range#excel-javascript/api/excel/-range-getentirerow-member(1))|Gets an object that represents the entire row of the range (for example, if the current range represents cells "B4:E11", its `GetEntireRow` is a range that represents rows "4:11").| -||[getIntersection(anotherRange: Range \| string)](/.range#excel-javascript/api/excel/-range-getintersection-member(1))|Gets the range object that represents the rectangular intersection of the given ranges.| -||[getLastCell()](/.range#excel-javascript/api/excel/-range-getlastcell-member(1))|Gets the last cell within the range.| -||[getLastColumn()](/.range#excel-javascript/api/excel/-range-getlastcolumn-member(1))|Gets the last column within the range.| -||[getLastRow()](/.range#excel-javascript/api/excel/-range-getlastrow-member(1))|Gets the last row within the range.| -||[getOffsetRange(rowOffset: number, columnOffset: number)](/.range#excel-javascript/api/excel/-range-getoffsetrange-member(1))|Gets an object which represents a range that's offset from the specified range.| -||[getRow(row: number)](/.range#excel-javascript/api/excel/-range-getrow-member(1))|Gets a row contained in the range.| -||[insert(shift: Excel.InsertShiftDirection)](/.range#excel-javascript/api/excel/-range-insert-member(1))|Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space.| -||[numberFormat](/.range#excel-javascript/api/excel/-range-numberformat-member)|Represents Excel's number format code for the given range.| -||[rowCount](/.range#excel-javascript/api/excel/-range-rowcount-member)|Returns the total number of rows in the range.| -||[rowIndex](/.range#excel-javascript/api/excel/-range-rowindex-member)|Returns the row number of the first cell in the range.| -||[select()](/.range#excel-javascript/api/excel/-range-select-member(1))|Selects the specified range in the Excel UI.| -||[text](/.range#excel-javascript/api/excel/-range-text-member)|Text values of the specified range.| -||[valueTypes](/.range#excel-javascript/api/excel/-range-valuetypes-member)|Specifies the type of data in each cell.| -||[values](/.range#excel-javascript/api/excel/-range-values-member)|Represents the raw values of the specified range.| -||[worksheet](/.range#excel-javascript/api/excel/-range-worksheet-member)|The worksheet containing the current range.| -|[RangeBorder](/.rangeborder)|[color](/.rangeborder#excel-javascript/api/excel/-rangeborder-color-member)|HTML color code representing the color of the border line, in the form #RRGGBB (e.g., "FFA500"), or as a named HTML color (e.g., "orange").| -||[sideIndex](/.rangeborder#excel-javascript/api/excel/-rangeborder-sideindex-member)|Constant value that indicates the specific side of the border.| -||[style](/.rangeborder#excel-javascript/api/excel/-rangeborder-style-member)|One of the constants of line style specifying the line style for the border.| -||[weight](/.rangeborder#excel-javascript/api/excel/-rangeborder-weight-member)|Specifies the weight of the border around a range.| -|[RangeBorderCollection](/.rangebordercollection)|[count](/.rangebordercollection#excel-javascript/api/excel/-rangebordercollection-count-member)|Number of border objects in the collection.| -||[getItem(index: Excel.BorderIndex)](/.rangebordercollection#excel-javascript/api/excel/-rangebordercollection-getitem-member(1))|Gets a border object using its name.| -||[getItemAt(index: number)](/.rangebordercollection#excel-javascript/api/excel/-rangebordercollection-getitemat-member(1))|Gets a border object using its index.| -||[items](/.rangebordercollection#excel-javascript/api/excel/-rangebordercollection-items-member)|Gets the loaded child items in this collection.| -|[RangeFill](/.rangefill)|[clear()](/.rangefill#excel-javascript/api/excel/-rangefill-clear-member(1))|Resets the range background.| -||[color](/.rangefill#excel-javascript/api/excel/-rangefill-color-member)|HTML color code representing the color of the background, in the form #RRGGBB (e.g., "FFA500"), or as a named HTML color (e.g., "orange")| -|[RangeFont](/.rangefont)|[bold](/.rangefont#excel-javascript/api/excel/-rangefont-bold-member)|Represents the bold status of the font.| -||[color](/.rangefont#excel-javascript/api/excel/-rangefont-color-member)|HTML color code representation of the text color (e.g., #FF0000 represents Red).| -||[italic](/.rangefont#excel-javascript/api/excel/-rangefont-italic-member)|Specifies the italic status of the font.| -||[name](/.rangefont#excel-javascript/api/excel/-rangefont-name-member)|Font name (e.g., "Calibri").| -||[size](/.rangefont#excel-javascript/api/excel/-rangefont-size-member)|Font size.| -||[underline](/.rangefont#excel-javascript/api/excel/-rangefont-underline-member)|Type of underline applied to the font.| -|[RangeFormat](/.rangeformat)|[borders](/.rangeformat#excel-javascript/api/excel/-rangeformat-borders-member)|Collection of border objects that apply to the overall range.| -||[fill](/.rangeformat#excel-javascript/api/excel/-rangeformat-fill-member)|Returns the fill object defined on the overall range.| -||[font](/.rangeformat#excel-javascript/api/excel/-rangeformat-font-member)|Returns the font object defined on the overall range.| -||[horizontalAlignment](/.rangeformat#excel-javascript/api/excel/-rangeformat-horizontalalignment-member)|Represents the horizontal alignment for the specified object.| -||[verticalAlignment](/.rangeformat#excel-javascript/api/excel/-rangeformat-verticalalignment-member)|Represents the vertical alignment for the specified object.| -||[wrapText](/.rangeformat#excel-javascript/api/excel/-rangeformat-wraptext-member)|Specifies if Excel wraps the text in the object.| -|[Table](/.table)|[columns](/.table#excel-javascript/api/excel/-table-columns-member)|Represents a collection of all the columns in the table.| -||[delete()](/.table#excel-javascript/api/excel/-table-delete-member(1))|Deletes the table.| -||[getDataBodyRange()](/.table#excel-javascript/api/excel/-table-getdatabodyrange-member(1))|Gets the range object associated with the data body of the table.| -||[getHeaderRowRange()](/.table#excel-javascript/api/excel/-table-getheaderrowrange-member(1))|Gets the range object associated with the header row of the table.| -||[getRange()](/.table#excel-javascript/api/excel/-table-getrange-member(1))|Gets the range object associated with the entire table.| -||[getTotalRowRange()](/.table#excel-javascript/api/excel/-table-gettotalrowrange-member(1))|Gets the range object associated with the totals row of the table.| -||[id](/.table#excel-javascript/api/excel/-table-id-member)|Returns a value that uniquely identifies the table in a given workbook.| -||[name](/.table#excel-javascript/api/excel/-table-name-member)|Name of the table.| -||[rows](/.table#excel-javascript/api/excel/-table-rows-member)|Represents a collection of all the rows in the table.| -||[showHeaders](/.table#excel-javascript/api/excel/-table-showheaders-member)|Specifies if the header row is visible.| -||[showTotals](/.table#excel-javascript/api/excel/-table-showtotals-member)|Specifies if the total row is visible.| -||[style](/.table#excel-javascript/api/excel/-table-style-member)|Constant value that represents the table style.| -|[TableCollection](/.tablecollection)|[add(address: Range \| string, hasHeaders: boolean)](/.tablecollection#excel-javascript/api/excel/-tablecollection-add-member(1))|Creates a new table.| -||[count](/.tablecollection#excel-javascript/api/excel/-tablecollection-count-member)|Returns the number of tables in the workbook.| -||[getItem(key: string)](/.tablecollection#excel-javascript/api/excel/-tablecollection-getitem-member(1))|Gets a table by name or ID.| -||[getItemAt(index: number)](/.tablecollection#excel-javascript/api/excel/-tablecollection-getitemat-member(1))|Gets a table based on its position in the collection.| -||[items](/.tablecollection#excel-javascript/api/excel/-tablecollection-items-member)|Gets the loaded child items in this collection.| -|[TableColumn](/.tablecolumn)|[delete()](/.tablecolumn#excel-javascript/api/excel/-tablecolumn-delete-member(1))|Deletes the column from the table.| -||[getDataBodyRange()](/.tablecolumn#excel-javascript/api/excel/-tablecolumn-getdatabodyrange-member(1))|Gets the range object associated with the data body of the column.| -||[getHeaderRowRange()](/.tablecolumn#excel-javascript/api/excel/-tablecolumn-getheaderrowrange-member(1))|Gets the range object associated with the header row of the column.| -||[getRange()](/.tablecolumn#excel-javascript/api/excel/-tablecolumn-getrange-member(1))|Gets the range object associated with the entire column.| -||[getTotalRowRange()](/.tablecolumn#excel-javascript/api/excel/-tablecolumn-gettotalrowrange-member(1))|Gets the range object associated with the totals row of the column.| -||[id](/.tablecolumn#excel-javascript/api/excel/-tablecolumn-id-member)|Returns a unique key that identifies the column within the table.| -||[index](/.tablecolumn#excel-javascript/api/excel/-tablecolumn-index-member)|Returns the index number of the column within the columns collection of the table.| -||[name](/.tablecolumn#excel-javascript/api/excel/-tablecolumn-name-member)|Specifies the name of the table column.| -||[values](/.tablecolumn#excel-javascript/api/excel/-tablecolumn-values-member)|Represents the raw values of the specified range.| -|[TableColumnCollection](/.tablecolumncollection)|[add(index?: number, values?: Array> \| boolean \| string \| number, name?: string)](/.tablecolumncollection#excel-javascript/api/excel/-tablecolumncollection-add-member(1))|Adds a new column to the table.| -||[count](/.tablecolumncollection#excel-javascript/api/excel/-tablecolumncollection-count-member)|Returns the number of columns in the table.| -||[getItem(key: number \| string)](/.tablecolumncollection#excel-javascript/api/excel/-tablecolumncollection-getitem-member(1))|Gets a column object by name or ID.| -||[getItemAt(index: number)](/.tablecolumncollection#excel-javascript/api/excel/-tablecolumncollection-getitemat-member(1))|Gets a column based on its position in the collection.| -||[items](/.tablecolumncollection#excel-javascript/api/excel/-tablecolumncollection-items-member)|Gets the loaded child items in this collection.| -|[TableRow](/.tablerow)|[delete()](/.tablerow#excel-javascript/api/excel/-tablerow-delete-member(1))|Deletes the row from the table.| -||[getRange()](/.tablerow#excel-javascript/api/excel/-tablerow-getrange-member(1))|Returns the range object associated with the entire row.| -||[index](/.tablerow#excel-javascript/api/excel/-tablerow-index-member)|Returns the index number of the row within the rows collection of the table.| -||[values](/.tablerow#excel-javascript/api/excel/-tablerow-values-member)|Represents the raw values of the specified range.| -|[TableRowCollection](/.tablerowcollection)|[add(index?: number, values?: Array> \| boolean \| string \| number, alwaysInsert?: boolean)](/.tablerowcollection#excel-javascript/api/excel/-tablerowcollection-add-member(1))|Adds one or more rows to the table.| -||[count](/.tablerowcollection#excel-javascript/api/excel/-tablerowcollection-count-member)|Returns the number of rows in the table.| -||[getItemAt(index: number)](/.tablerowcollection#excel-javascript/api/excel/-tablerowcollection-getitemat-member(1))|Gets a row based on its position in the collection.| -||[items](/.tablerowcollection#excel-javascript/api/excel/-tablerowcollection-items-member)|Gets the loaded child items in this collection.| -|[Workbook](/.workbook)|[application](/.workbook#excel-javascript/api/excel/-workbook-application-member)|Represents the Excel application instance that contains this workbook.| -||[bindings](/.workbook#excel-javascript/api/excel/-workbook-bindings-member)|Represents a collection of bindings that are part of the workbook.| -||[getSelectedRange()](/.workbook#excel-javascript/api/excel/-workbook-getselectedrange-member(1))|Gets the currently selected single range from the workbook.| -||[names](/.workbook#excel-javascript/api/excel/-workbook-names-member)|Represents a collection of workbook-scoped named items (named ranges and constants).| -||[tables](/.workbook#excel-javascript/api/excel/-workbook-tables-member)|Represents a collection of tables associated with the workbook.| -||[worksheets](/.workbook#excel-javascript/api/excel/-workbook-worksheets-member)|Represents a collection of worksheets associated with the workbook.| -|[Worksheet](/.worksheet)|[activate()](/.worksheet#excel-javascript/api/excel/-worksheet-activate-member(1))|Activate the worksheet in the Excel UI.| -||[charts](/.worksheet#excel-javascript/api/excel/-worksheet-charts-member)|Returns a collection of charts that are part of the worksheet.| -||[delete()](/.worksheet#excel-javascript/api/excel/-worksheet-delete-member(1))|Deletes the worksheet from the workbook.| -||[getCell(row: number, column: number)](/.worksheet#excel-javascript/api/excel/-worksheet-getcell-member(1))|Gets the `Range` object containing the single cell based on row and column numbers.| -||[getRange(address?: string)](/.worksheet#excel-javascript/api/excel/-worksheet-getrange-member(1))|Gets the `Range` object, representing a single rectangular block of cells, specified by the address or name.| -||[id](/.worksheet#excel-javascript/api/excel/-worksheet-id-member)|Returns a value that uniquely identifies the worksheet in a given workbook.| -||[name](/.worksheet#excel-javascript/api/excel/-worksheet-name-member)|The display name of the worksheet.| -||[position](/.worksheet#excel-javascript/api/excel/-worksheet-position-member)|The zero-based position of the worksheet within the workbook.| -||[tables](/.worksheet#excel-javascript/api/excel/-worksheet-tables-member)|Collection of tables that are part of the worksheet.| -||[visibility](/.worksheet#excel-javascript/api/excel/-worksheet-visibility-member)|The visibility of the worksheet.| -|[WorksheetCollection](/.worksheetcollection)|[add(name?: string)](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-add-member(1))|Adds a new worksheet to the workbook.| -||[getActiveWorksheet()](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-getactiveworksheet-member(1))|Gets the currently active worksheet in the workbook.| -||[getItem(key: string)](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-getitem-member(1))|Gets a worksheet object using its name or ID.| -||[items](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-items-member)|Gets the loaded child items in this collection.| +|[Application](/javascript/api/excel/excel.application)|[calculate(calculationType: Excel.CalculationType)](/javascript/api/excel/excel.application#excel-excel-application-calculate-member(1))|Recalculate all currently opened workbooks in Excel.| +||[calculationMode](/javascript/api/excel/excel.application#excel-excel-application-calculationmode-member)|Returns the calculation mode used in the workbook, as defined by the constants in `Excel.CalculationMode`.| +|[Binding](/javascript/api/excel/excel.binding)|[getRange()](/javascript/api/excel/excel.binding#excel-excel-binding-getrange-member(1))|Returns the range represented by the binding.| +||[getTable()](/javascript/api/excel/excel.binding#excel-excel-binding-gettable-member(1))|Returns the table represented by the binding.| +||[getText()](/javascript/api/excel/excel.binding#excel-excel-binding-gettext-member(1))|Returns the text represented by the binding.| +||[id](/javascript/api/excel/excel.binding#excel-excel-binding-id-member)|Represents the binding identifier.| +||[type](/javascript/api/excel/excel.binding#excel-excel-binding-type-member)|Returns the type of the binding.| +|[BindingCollection](/javascript/api/excel/excel.bindingcollection)|[count](/javascript/api/excel/excel.bindingcollection#excel-excel-bindingcollection-count-member)|Returns the number of bindings in the collection.| +||[getItem(id: string)](/javascript/api/excel/excel.bindingcollection#excel-excel-bindingcollection-getitem-member(1))|Gets a binding object by ID.| +||[getItemAt(index: number)](/javascript/api/excel/excel.bindingcollection#excel-excel-bindingcollection-getitemat-member(1))|Gets a binding object based on its position in the items array.| +||[items](/javascript/api/excel/excel.bindingcollection#excel-excel-bindingcollection-items-member)|Gets the loaded child items in this collection.| +|[Chart](/javascript/api/excel/excel.chart)|[axes](/javascript/api/excel/excel.chart#excel-excel-chart-axes-member)|Represents chart axes.| +||[dataLabels](/javascript/api/excel/excel.chart#excel-excel-chart-datalabels-member)|Represents the data labels on the chart.| +||[delete()](/javascript/api/excel/excel.chart#excel-excel-chart-delete-member(1))|Deletes the chart object.| +||[format](/javascript/api/excel/excel.chart#excel-excel-chart-format-member)|Encapsulates the format properties for the chart area.| +||[height](/javascript/api/excel/excel.chart#excel-excel-chart-height-member)|Specifies the height, in points, of the chart object.| +||[left](/javascript/api/excel/excel.chart#excel-excel-chart-left-member)|The distance, in points, from the left side of the chart to the worksheet origin.| +||[legend](/javascript/api/excel/excel.chart#excel-excel-chart-legend-member)|Represents the legend for the chart.| +||[name](/javascript/api/excel/excel.chart#excel-excel-chart-name-member)|Specifies the name of a chart object.| +||[series](/javascript/api/excel/excel.chart#excel-excel-chart-series-member)|Represents either a single series or collection of series in the chart.| +||[setData(sourceData: Range, seriesBy?: Excel.ChartSeriesBy)](/javascript/api/excel/excel.chart#excel-excel-chart-setdata-member(1))|Resets the source data for the chart.| +||[setPosition(startCell: Range \| string, endCell?: Range \| string)](/javascript/api/excel/excel.chart#excel-excel-chart-setposition-member(1))|Positions the chart relative to cells on the worksheet.| +||[title](/javascript/api/excel/excel.chart#excel-excel-chart-title-member)|Represents the title of the specified chart, including the text, visibility, position, and formatting of the title.| +||[top](/javascript/api/excel/excel.chart#excel-excel-chart-top-member)|Specifies the distance, in points, from the top edge of the object to the top of row 1 (on a worksheet) or the top of the chart area (on a chart).| +||[width](/javascript/api/excel/excel.chart#excel-excel-chart-width-member)|Specifies the width, in points, of the chart object.| +|[ChartAreaFormat](/javascript/api/excel/excel.chartareaformat)|[fill](/javascript/api/excel/excel.chartareaformat#excel-excel-chartareaformat-fill-member)|Represents the fill format of an object, which includes background formatting information.| +||[font](/javascript/api/excel/excel.chartareaformat#excel-excel-chartareaformat-font-member)|Represents the font attributes (font name, font size, color, etc.) for the current object.| +|[ChartAxes](/javascript/api/excel/excel.chartaxes)|[categoryAxis](/javascript/api/excel/excel.chartaxes#excel-excel-chartaxes-categoryaxis-member)|Represents the category axis in a chart.| +||[seriesAxis](/javascript/api/excel/excel.chartaxes#excel-excel-chartaxes-seriesaxis-member)|Represents the series axis of a 3-D chart.| +||[valueAxis](/javascript/api/excel/excel.chartaxes#excel-excel-chartaxes-valueaxis-member)|Represents the value axis in an axis.| +|[ChartAxis](/javascript/api/excel/excel.chartaxis)|[format](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-format-member)|Represents the formatting of a chart object, which includes line and font formatting.| +||[majorGridlines](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-majorgridlines-member)|Returns an object that represents the major gridlines for the specified axis.| +||[majorUnit](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-majorunit-member)|Represents the interval between two major tick marks.| +||[maximum](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-maximum-member)|Represents the maximum value on the value axis.| +||[minimum](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-minimum-member)|Represents the minimum value on the value axis.| +||[minorGridlines](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-minorgridlines-member)|Returns an object that represents the minor gridlines for the specified axis.| +||[minorUnit](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-minorunit-member)|Represents the interval between two minor tick marks.| +||[title](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-title-member)|Represents the axis title.| +|[ChartAxisFormat](/javascript/api/excel/excel.chartaxisformat)|[font](/javascript/api/excel/excel.chartaxisformat#excel-excel-chartaxisformat-font-member)|Specifies the font attributes (font name, font size, color, etc.) for a chart axis element.| +||[line](/javascript/api/excel/excel.chartaxisformat#excel-excel-chartaxisformat-line-member)|Specifies chart line formatting.| +|[ChartAxisTitle](/javascript/api/excel/excel.chartaxistitle)|[format](/javascript/api/excel/excel.chartaxistitle#excel-excel-chartaxistitle-format-member)|Specifies the formatting of the chart axis title.| +||[text](/javascript/api/excel/excel.chartaxistitle#excel-excel-chartaxistitle-text-member)|Specifies the axis title.| +||[visible](/javascript/api/excel/excel.chartaxistitle#excel-excel-chartaxistitle-visible-member)|Specifies if the axis title is visible.| +|[ChartAxisTitleFormat](/javascript/api/excel/excel.chartaxistitleformat)|[font](/javascript/api/excel/excel.chartaxistitleformat#excel-excel-chartaxistitleformat-font-member)|Specifies the chart axis title's font attributes, such as font name, font size, or color, of the chart axis title object.| +|[ChartCollection](/javascript/api/excel/excel.chartcollection)|[add(type: Excel.ChartType, sourceData: Range, seriesBy?: Excel.ChartSeriesBy)](/javascript/api/excel/excel.chartcollection#excel-excel-chartcollection-add-member(1))|Creates a new chart.| +||[count](/javascript/api/excel/excel.chartcollection#excel-excel-chartcollection-count-member)|Returns the number of charts in the worksheet.| +||[getItem(name: string)](/javascript/api/excel/excel.chartcollection#excel-excel-chartcollection-getitem-member(1))|Gets a chart using its name.| +||[getItemAt(index: number)](/javascript/api/excel/excel.chartcollection#excel-excel-chartcollection-getitemat-member(1))|Gets a chart based on its position in the collection.| +||[items](/javascript/api/excel/excel.chartcollection#excel-excel-chartcollection-items-member)|Gets the loaded child items in this collection.| +|[ChartDataLabelFormat](/javascript/api/excel/excel.chartdatalabelformat)|[fill](/javascript/api/excel/excel.chartdatalabelformat#excel-excel-chartdatalabelformat-fill-member)|Represents the fill format of the current chart data label.| +||[font](/javascript/api/excel/excel.chartdatalabelformat#excel-excel-chartdatalabelformat-font-member)|Represents the font attributes (such as font name, font size, and color) for a chart data label.| +|[ChartDataLabels](/javascript/api/excel/excel.chartdatalabels)|[format](/javascript/api/excel/excel.chartdatalabels#excel-excel-chartdatalabels-format-member)|Specifies the format of chart data labels, which includes fill and font formatting.| +||[position](/javascript/api/excel/excel.chartdatalabels#excel-excel-chartdatalabels-position-member)|Value that represents the position of the data label.| +||[separator](/javascript/api/excel/excel.chartdatalabels#excel-excel-chartdatalabels-separator-member)|String representing the separator used for the data labels on a chart.| +||[showBubbleSize](/javascript/api/excel/excel.chartdatalabels#excel-excel-chartdatalabels-showbubblesize-member)|Specifies if the data label bubble size is visible.| +||[showCategoryName](/javascript/api/excel/excel.chartdatalabels#excel-excel-chartdatalabels-showcategoryname-member)|Specifies if the data label category name is visible.| +||[showLegendKey](/javascript/api/excel/excel.chartdatalabels#excel-excel-chartdatalabels-showlegendkey-member)|Specifies if the data label legend key is visible.| +||[showPercentage](/javascript/api/excel/excel.chartdatalabels#excel-excel-chartdatalabels-showpercentage-member)|Specifies if the data label percentage is visible.| +||[showSeriesName](/javascript/api/excel/excel.chartdatalabels#excel-excel-chartdatalabels-showseriesname-member)|Specifies if the data label series name is visible.| +||[showValue](/javascript/api/excel/excel.chartdatalabels#excel-excel-chartdatalabels-showvalue-member)|Specifies if the data label value is visible.| +|[ChartFill](/javascript/api/excel/excel.chartfill)|[clear()](/javascript/api/excel/excel.chartfill#excel-excel-chartfill-clear-member(1))|Clears the fill color of a chart element.| +||[setSolidColor(color: string)](/javascript/api/excel/excel.chartfill#excel-excel-chartfill-setsolidcolor-member(1))|Sets the fill formatting of a chart element to a uniform color.| +|[ChartFont](/javascript/api/excel/excel.chartfont)|[bold](/javascript/api/excel/excel.chartfont#excel-excel-chartfont-bold-member)|Represents the bold status of font.| +||[color](/javascript/api/excel/excel.chartfont#excel-excel-chartfont-color-member)|HTML color code representation of the text color (e.g., #FF0000 represents Red).| +||[italic](/javascript/api/excel/excel.chartfont#excel-excel-chartfont-italic-member)|Represents the italic status of the font.| +||[name](/javascript/api/excel/excel.chartfont#excel-excel-chartfont-name-member)|Font name (e.g., "Calibri")| +||[size](/javascript/api/excel/excel.chartfont#excel-excel-chartfont-size-member)|Size of the font (e.g., 11)| +||[underline](/javascript/api/excel/excel.chartfont#excel-excel-chartfont-underline-member)|Type of underline applied to the font.| +|[ChartGridlines](/javascript/api/excel/excel.chartgridlines)|[format](/javascript/api/excel/excel.chartgridlines#excel-excel-chartgridlines-format-member)|Represents the formatting of chart gridlines.| +||[visible](/javascript/api/excel/excel.chartgridlines#excel-excel-chartgridlines-visible-member)|Specifies if the axis gridlines are visible.| +|[ChartGridlinesFormat](/javascript/api/excel/excel.chartgridlinesformat)|[line](/javascript/api/excel/excel.chartgridlinesformat#excel-excel-chartgridlinesformat-line-member)|Represents chart line formatting.| +|[ChartLegend](/javascript/api/excel/excel.chartlegend)|[format](/javascript/api/excel/excel.chartlegend#excel-excel-chartlegend-format-member)|Represents the formatting of a chart legend, which includes fill and font formatting.| +||[overlay](/javascript/api/excel/excel.chartlegend#excel-excel-chartlegend-overlay-member)|Specifies if the chart legend should overlap with the main body of the chart.| +||[position](/javascript/api/excel/excel.chartlegend#excel-excel-chartlegend-position-member)|Specifies the position of the legend on the chart.| +||[visible](/javascript/api/excel/excel.chartlegend#excel-excel-chartlegend-visible-member)|Specifies if the chart legend is visible.| +|[ChartLegendFormat](/javascript/api/excel/excel.chartlegendformat)|[fill](/javascript/api/excel/excel.chartlegendformat#excel-excel-chartlegendformat-fill-member)|Represents the fill format of an object, which includes background formatting information.| +||[font](/javascript/api/excel/excel.chartlegendformat#excel-excel-chartlegendformat-font-member)|Represents the font attributes such as font name, font size, and color of a chart legend.| +|[ChartLineFormat](/javascript/api/excel/excel.chartlineformat)|[clear()](/javascript/api/excel/excel.chartlineformat#excel-excel-chartlineformat-clear-member(1))|Clears the line format of a chart element.| +||[color](/javascript/api/excel/excel.chartlineformat#excel-excel-chartlineformat-color-member)|HTML color code representing the color of lines in the chart.| +|[ChartPoint](/javascript/api/excel/excel.chartpoint)|[format](/javascript/api/excel/excel.chartpoint#excel-excel-chartpoint-format-member)|Encapsulates the format properties chart point.| +||[value](/javascript/api/excel/excel.chartpoint#excel-excel-chartpoint-value-member)|Returns the value of a chart point.| +|[ChartPointFormat](/javascript/api/excel/excel.chartpointformat)|[fill](/javascript/api/excel/excel.chartpointformat#excel-excel-chartpointformat-fill-member)|Represents the fill format of a chart, which includes background formatting information.| +|[ChartPointsCollection](/javascript/api/excel/excel.chartpointscollection)|[count](/javascript/api/excel/excel.chartpointscollection#excel-excel-chartpointscollection-count-member)|Returns the number of chart points in the series.| +||[getItemAt(index: number)](/javascript/api/excel/excel.chartpointscollection#excel-excel-chartpointscollection-getitemat-member(1))|Retrieve a point based on its position within the series.| +||[items](/javascript/api/excel/excel.chartpointscollection#excel-excel-chartpointscollection-items-member)|Gets the loaded child items in this collection.| +|[ChartSeries](/javascript/api/excel/excel.chartseries)|[format](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-format-member)|Represents the formatting of a chart series, which includes fill and line formatting.| +||[name](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-name-member)|Specifies the name of a series in a chart.| +||[points](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-points-member)|Returns a collection of all points in the series.| +|[ChartSeriesCollection](/javascript/api/excel/excel.chartseriescollection)|[count](/javascript/api/excel/excel.chartseriescollection#excel-excel-chartseriescollection-count-member)|Returns the number of series in the collection.| +||[getItemAt(index: number)](/javascript/api/excel/excel.chartseriescollection#excel-excel-chartseriescollection-getitemat-member(1))|Retrieves a series based on its position in the collection.| +||[items](/javascript/api/excel/excel.chartseriescollection#excel-excel-chartseriescollection-items-member)|Gets the loaded child items in this collection.| +|[ChartSeriesFormat](/javascript/api/excel/excel.chartseriesformat)|[fill](/javascript/api/excel/excel.chartseriesformat#excel-excel-chartseriesformat-fill-member)|Represents the fill format of a chart series, which includes background formatting information.| +||[line](/javascript/api/excel/excel.chartseriesformat#excel-excel-chartseriesformat-line-member)|Represents line formatting.| +|[ChartTitle](/javascript/api/excel/excel.charttitle)|[format](/javascript/api/excel/excel.charttitle#excel-excel-charttitle-format-member)|Represents the formatting of a chart title, which includes fill and font formatting.| +||[overlay](/javascript/api/excel/excel.charttitle#excel-excel-charttitle-overlay-member)|Specifies if the chart title will overlay the chart.| +||[text](/javascript/api/excel/excel.charttitle#excel-excel-charttitle-text-member)|Specifies the chart's title text.| +||[visible](/javascript/api/excel/excel.charttitle#excel-excel-charttitle-visible-member)|Specifies if the chart title is visible.| +|[ChartTitleFormat](/javascript/api/excel/excel.charttitleformat)|[fill](/javascript/api/excel/excel.charttitleformat#excel-excel-charttitleformat-fill-member)|Represents the fill format of an object, which includes background formatting information.| +||[font](/javascript/api/excel/excel.charttitleformat#excel-excel-charttitleformat-font-member)|Represents the font attributes (such as font name, font size, and color) for an object.| +|[NamedItem](/javascript/api/excel/excel.nameditem)|[getRange()](/javascript/api/excel/excel.nameditem#excel-excel-nameditem-getrange-member(1))|Returns the range object that is associated with the name.| +||[name](/javascript/api/excel/excel.nameditem#excel-excel-nameditem-name-member)|The name of the object.| +||[type](/javascript/api/excel/excel.nameditem#excel-excel-nameditem-type-member)|Specifies the type of the value returned by the name's formula.| +||[value](/javascript/api/excel/excel.nameditem#excel-excel-nameditem-value-member)|Represents the value computed by the name's formula.| +||[visible](/javascript/api/excel/excel.nameditem#excel-excel-nameditem-visible-member)|Specifies if the object is visible.| +|[NamedItemCollection](/javascript/api/excel/excel.nameditemcollection)|[getItem(name: string)](/javascript/api/excel/excel.nameditemcollection#excel-excel-nameditemcollection-getitem-member(1))|Gets a `NamedItem` object using its name.| +||[items](/javascript/api/excel/excel.nameditemcollection#excel-excel-nameditemcollection-items-member)|Gets the loaded child items in this collection.| +|[Range](/javascript/api/excel/excel.range)|[address](/javascript/api/excel/excel.range#excel-excel-range-address-member)|Specifies the range reference in A1-style.| +||[addressLocal](/javascript/api/excel/excel.range#excel-excel-range-addresslocal-member)|Represents the range reference for the specified range in the language of the user.| +||[cellCount](/javascript/api/excel/excel.range#excel-excel-range-cellcount-member)|Specifies the number of cells in the range.| +||[clear(applyTo?: Excel.ClearApplyTo)](/javascript/api/excel/excel.range#excel-excel-range-clear-member(1))|Clear range values and formatting, such as fill and border.| +||[columnCount](/javascript/api/excel/excel.range#excel-excel-range-columncount-member)|Specifies the total number of columns in the range.| +||[columnIndex](/javascript/api/excel/excel.range#excel-excel-range-columnindex-member)|Specifies the column number of the first cell in the range.| +||[delete(shift: Excel.DeleteShiftDirection)](/javascript/api/excel/excel.range#excel-excel-range-delete-member(1))|Deletes the cells associated with the range.| +||[format](/javascript/api/excel/excel.range#excel-excel-range-format-member)|Returns a format object, encapsulating the range's font, fill, borders, alignment, and other properties.| +||[formulas](/javascript/api/excel/excel.range#excel-excel-range-formulas-member)|Represents the formula in A1-style notation.| +||[formulasLocal](/javascript/api/excel/excel.range#excel-excel-range-formulaslocal-member)|Represents the formula in A1-style notation, in the user's language and number-formatting locale.| +||[getBoundingRect(anotherRange: Range \| string)](/javascript/api/excel/excel.range#excel-excel-range-getboundingrect-member(1))|Gets the smallest range object that encompasses the given ranges.| +||[getCell(row: number, column: number)](/javascript/api/excel/excel.range#excel-excel-range-getcell-member(1))|Gets the range object containing the single cell based on row and column numbers.| +||[getColumn(column: number)](/javascript/api/excel/excel.range#excel-excel-range-getcolumn-member(1))|Gets a column contained in the range.| +||[getEntireColumn()](/javascript/api/excel/excel.range#excel-excel-range-getentirecolumn-member(1))|Gets an object that represents the entire column of the range (for example, if the current range represents cells "B4:E11", its `getEntireColumn` is a range that represents columns "B:E").| +||[getEntireRow()](/javascript/api/excel/excel.range#excel-excel-range-getentirerow-member(1))|Gets an object that represents the entire row of the range (for example, if the current range represents cells "B4:E11", its `GetEntireRow` is a range that represents rows "4:11").| +||[getIntersection(anotherRange: Range \| string)](/javascript/api/excel/excel.range#excel-excel-range-getintersection-member(1))|Gets the range object that represents the rectangular intersection of the given ranges.| +||[getLastCell()](/javascript/api/excel/excel.range#excel-excel-range-getlastcell-member(1))|Gets the last cell within the range.| +||[getLastColumn()](/javascript/api/excel/excel.range#excel-excel-range-getlastcolumn-member(1))|Gets the last column within the range.| +||[getLastRow()](/javascript/api/excel/excel.range#excel-excel-range-getlastrow-member(1))|Gets the last row within the range.| +||[getOffsetRange(rowOffset: number, columnOffset: number)](/javascript/api/excel/excel.range#excel-excel-range-getoffsetrange-member(1))|Gets an object which represents a range that's offset from the specified range.| +||[getRow(row: number)](/javascript/api/excel/excel.range#excel-excel-range-getrow-member(1))|Gets a row contained in the range.| +||[insert(shift: Excel.InsertShiftDirection)](/javascript/api/excel/excel.range#excel-excel-range-insert-member(1))|Inserts a cell or a range of cells into the worksheet in place of this range, and shifts the other cells to make space.| +||[numberFormat](/javascript/api/excel/excel.range#excel-excel-range-numberformat-member)|Represents Excel's number format code for the given range.| +||[rowCount](/javascript/api/excel/excel.range#excel-excel-range-rowcount-member)|Returns the total number of rows in the range.| +||[rowIndex](/javascript/api/excel/excel.range#excel-excel-range-rowindex-member)|Returns the row number of the first cell in the range.| +||[select()](/javascript/api/excel/excel.range#excel-excel-range-select-member(1))|Selects the specified range in the Excel UI.| +||[text](/javascript/api/excel/excel.range#excel-excel-range-text-member)|Text values of the specified range.| +||[valueTypes](/javascript/api/excel/excel.range#excel-excel-range-valuetypes-member)|Specifies the type of data in each cell.| +||[values](/javascript/api/excel/excel.range#excel-excel-range-values-member)|Represents the raw values of the specified range.| +||[worksheet](/javascript/api/excel/excel.range#excel-excel-range-worksheet-member)|The worksheet containing the current range.| +|[RangeBorder](/javascript/api/excel/excel.rangeborder)|[color](/javascript/api/excel/excel.rangeborder#excel-excel-rangeborder-color-member)|HTML color code representing the color of the border line, in the form #RRGGBB (e.g., "FFA500"), or as a named HTML color (e.g., "orange").| +||[sideIndex](/javascript/api/excel/excel.rangeborder#excel-excel-rangeborder-sideindex-member)|Constant value that indicates the specific side of the border.| +||[style](/javascript/api/excel/excel.rangeborder#excel-excel-rangeborder-style-member)|One of the constants of line style specifying the line style for the border.| +||[weight](/javascript/api/excel/excel.rangeborder#excel-excel-rangeborder-weight-member)|Specifies the weight of the border around a range.| +|[RangeBorderCollection](/javascript/api/excel/excel.rangebordercollection)|[count](/javascript/api/excel/excel.rangebordercollection#excel-excel-rangebordercollection-count-member)|Number of border objects in the collection.| +||[getItem(index: Excel.BorderIndex)](/javascript/api/excel/excel.rangebordercollection#excel-excel-rangebordercollection-getitem-member(1))|Gets a border object using its name.| +||[getItemAt(index: number)](/javascript/api/excel/excel.rangebordercollection#excel-excel-rangebordercollection-getitemat-member(1))|Gets a border object using its index.| +||[items](/javascript/api/excel/excel.rangebordercollection#excel-excel-rangebordercollection-items-member)|Gets the loaded child items in this collection.| +|[RangeFill](/javascript/api/excel/excel.rangefill)|[clear()](/javascript/api/excel/excel.rangefill#excel-excel-rangefill-clear-member(1))|Resets the range background.| +||[color](/javascript/api/excel/excel.rangefill#excel-excel-rangefill-color-member)|HTML color code representing the color of the background, in the form #RRGGBB (e.g., "FFA500"), or as a named HTML color (e.g., "orange")| +|[RangeFont](/javascript/api/excel/excel.rangefont)|[bold](/javascript/api/excel/excel.rangefont#excel-excel-rangefont-bold-member)|Represents the bold status of the font.| +||[color](/javascript/api/excel/excel.rangefont#excel-excel-rangefont-color-member)|HTML color code representation of the text color (e.g., #FF0000 represents Red).| +||[italic](/javascript/api/excel/excel.rangefont#excel-excel-rangefont-italic-member)|Specifies the italic status of the font.| +||[name](/javascript/api/excel/excel.rangefont#excel-excel-rangefont-name-member)|Font name (e.g., "Calibri").| +||[size](/javascript/api/excel/excel.rangefont#excel-excel-rangefont-size-member)|Font size.| +||[underline](/javascript/api/excel/excel.rangefont#excel-excel-rangefont-underline-member)|Type of underline applied to the font.| +|[RangeFormat](/javascript/api/excel/excel.rangeformat)|[borders](/javascript/api/excel/excel.rangeformat#excel-excel-rangeformat-borders-member)|Collection of border objects that apply to the overall range.| +||[fill](/javascript/api/excel/excel.rangeformat#excel-excel-rangeformat-fill-member)|Returns the fill object defined on the overall range.| +||[font](/javascript/api/excel/excel.rangeformat#excel-excel-rangeformat-font-member)|Returns the font object defined on the overall range.| +||[horizontalAlignment](/javascript/api/excel/excel.rangeformat#excel-excel-rangeformat-horizontalalignment-member)|Represents the horizontal alignment for the specified object.| +||[verticalAlignment](/javascript/api/excel/excel.rangeformat#excel-excel-rangeformat-verticalalignment-member)|Represents the vertical alignment for the specified object.| +||[wrapText](/javascript/api/excel/excel.rangeformat#excel-excel-rangeformat-wraptext-member)|Specifies if Excel wraps the text in the object.| +|[Table](/javascript/api/excel/excel.table)|[columns](/javascript/api/excel/excel.table#excel-excel-table-columns-member)|Represents a collection of all the columns in the table.| +||[delete()](/javascript/api/excel/excel.table#excel-excel-table-delete-member(1))|Deletes the table.| +||[getDataBodyRange()](/javascript/api/excel/excel.table#excel-excel-table-getdatabodyrange-member(1))|Gets the range object associated with the data body of the table.| +||[getHeaderRowRange()](/javascript/api/excel/excel.table#excel-excel-table-getheaderrowrange-member(1))|Gets the range object associated with the header row of the table.| +||[getRange()](/javascript/api/excel/excel.table#excel-excel-table-getrange-member(1))|Gets the range object associated with the entire table.| +||[getTotalRowRange()](/javascript/api/excel/excel.table#excel-excel-table-gettotalrowrange-member(1))|Gets the range object associated with the totals row of the table.| +||[id](/javascript/api/excel/excel.table#excel-excel-table-id-member)|Returns a value that uniquely identifies the table in a given workbook.| +||[name](/javascript/api/excel/excel.table#excel-excel-table-name-member)|Name of the table.| +||[rows](/javascript/api/excel/excel.table#excel-excel-table-rows-member)|Represents a collection of all the rows in the table.| +||[showHeaders](/javascript/api/excel/excel.table#excel-excel-table-showheaders-member)|Specifies if the header row is visible.| +||[showTotals](/javascript/api/excel/excel.table#excel-excel-table-showtotals-member)|Specifies if the total row is visible.| +||[style](/javascript/api/excel/excel.table#excel-excel-table-style-member)|Constant value that represents the table style.| +|[TableCollection](/javascript/api/excel/excel.tablecollection)|[add(address: Range \| string, hasHeaders: boolean)](/javascript/api/excel/excel.tablecollection#excel-excel-tablecollection-add-member(1))|Creates a new table.| +||[count](/javascript/api/excel/excel.tablecollection#excel-excel-tablecollection-count-member)|Returns the number of tables in the workbook.| +||[getItem(key: string)](/javascript/api/excel/excel.tablecollection#excel-excel-tablecollection-getitem-member(1))|Gets a table by name or ID.| +||[getItemAt(index: number)](/javascript/api/excel/excel.tablecollection#excel-excel-tablecollection-getitemat-member(1))|Gets a table based on its position in the collection.| +||[items](/javascript/api/excel/excel.tablecollection#excel-excel-tablecollection-items-member)|Gets the loaded child items in this collection.| +|[TableColumn](/javascript/api/excel/excel.tablecolumn)|[delete()](/javascript/api/excel/excel.tablecolumn#excel-excel-tablecolumn-delete-member(1))|Deletes the column from the table.| +||[getDataBodyRange()](/javascript/api/excel/excel.tablecolumn#excel-excel-tablecolumn-getdatabodyrange-member(1))|Gets the range object associated with the data body of the column.| +||[getHeaderRowRange()](/javascript/api/excel/excel.tablecolumn#excel-excel-tablecolumn-getheaderrowrange-member(1))|Gets the range object associated with the header row of the column.| +||[getRange()](/javascript/api/excel/excel.tablecolumn#excel-excel-tablecolumn-getrange-member(1))|Gets the range object associated with the entire column.| +||[getTotalRowRange()](/javascript/api/excel/excel.tablecolumn#excel-excel-tablecolumn-gettotalrowrange-member(1))|Gets the range object associated with the totals row of the column.| +||[id](/javascript/api/excel/excel.tablecolumn#excel-excel-tablecolumn-id-member)|Returns a unique key that identifies the column within the table.| +||[index](/javascript/api/excel/excel.tablecolumn#excel-excel-tablecolumn-index-member)|Returns the index number of the column within the columns collection of the table.| +||[name](/javascript/api/excel/excel.tablecolumn#excel-excel-tablecolumn-name-member)|Specifies the name of the table column.| +||[values](/javascript/api/excel/excel.tablecolumn#excel-excel-tablecolumn-values-member)|Represents the raw values of the specified range.| +|[TableColumnCollection](/javascript/api/excel/excel.tablecolumncollection)|[add(index?: number, values?: Array> \| boolean \| string \| number, name?: string)](/javascript/api/excel/excel.tablecolumncollection#excel-excel-tablecolumncollection-add-member(1))|Adds a new column to the table.| +||[count](/javascript/api/excel/excel.tablecolumncollection#excel-excel-tablecolumncollection-count-member)|Returns the number of columns in the table.| +||[getItem(key: number \| string)](/javascript/api/excel/excel.tablecolumncollection#excel-excel-tablecolumncollection-getitem-member(1))|Gets a column object by name or ID.| +||[getItemAt(index: number)](/javascript/api/excel/excel.tablecolumncollection#excel-excel-tablecolumncollection-getitemat-member(1))|Gets a column based on its position in the collection.| +||[items](/javascript/api/excel/excel.tablecolumncollection#excel-excel-tablecolumncollection-items-member)|Gets the loaded child items in this collection.| +|[TableRow](/javascript/api/excel/excel.tablerow)|[delete()](/javascript/api/excel/excel.tablerow#excel-excel-tablerow-delete-member(1))|Deletes the row from the table.| +||[getRange()](/javascript/api/excel/excel.tablerow#excel-excel-tablerow-getrange-member(1))|Returns the range object associated with the entire row.| +||[index](/javascript/api/excel/excel.tablerow#excel-excel-tablerow-index-member)|Returns the index number of the row within the rows collection of the table.| +||[values](/javascript/api/excel/excel.tablerow#excel-excel-tablerow-values-member)|Represents the raw values of the specified range.| +|[TableRowCollection](/javascript/api/excel/excel.tablerowcollection)|[add(index?: number, values?: Array> \| boolean \| string \| number, alwaysInsert?: boolean)](/javascript/api/excel/excel.tablerowcollection#excel-excel-tablerowcollection-add-member(1))|Adds one or more rows to the table.| +||[count](/javascript/api/excel/excel.tablerowcollection#excel-excel-tablerowcollection-count-member)|Returns the number of rows in the table.| +||[getItemAt(index: number)](/javascript/api/excel/excel.tablerowcollection#excel-excel-tablerowcollection-getitemat-member(1))|Gets a row based on its position in the collection.| +||[items](/javascript/api/excel/excel.tablerowcollection#excel-excel-tablerowcollection-items-member)|Gets the loaded child items in this collection.| +|[Workbook](/javascript/api/excel/excel.workbook)|[application](/javascript/api/excel/excel.workbook#excel-excel-workbook-application-member)|Represents the Excel application instance that contains this workbook.| +||[bindings](/javascript/api/excel/excel.workbook#excel-excel-workbook-bindings-member)|Represents a collection of bindings that are part of the workbook.| +||[getSelectedRange()](/javascript/api/excel/excel.workbook#excel-excel-workbook-getselectedrange-member(1))|Gets the currently selected single range from the workbook.| +||[names](/javascript/api/excel/excel.workbook#excel-excel-workbook-names-member)|Represents a collection of workbook-scoped named items (named ranges and constants).| +||[tables](/javascript/api/excel/excel.workbook#excel-excel-workbook-tables-member)|Represents a collection of tables associated with the workbook.| +||[worksheets](/javascript/api/excel/excel.workbook#excel-excel-workbook-worksheets-member)|Represents a collection of worksheets associated with the workbook.| +|[Worksheet](/javascript/api/excel/excel.worksheet)|[activate()](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-activate-member(1))|Activate the worksheet in the Excel UI.| +||[charts](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-charts-member)|Returns a collection of charts that are part of the worksheet.| +||[delete()](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-delete-member(1))|Deletes the worksheet from the workbook.| +||[getCell(row: number, column: number)](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-getcell-member(1))|Gets the `Range` object containing the single cell based on row and column numbers.| +||[getRange(address?: string)](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-getrange-member(1))|Gets the `Range` object, representing a single rectangular block of cells, specified by the address or name.| +||[id](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-id-member)|Returns a value that uniquely identifies the worksheet in a given workbook.| +||[name](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-name-member)|The display name of the worksheet.| +||[position](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-position-member)|The zero-based position of the worksheet within the workbook.| +||[tables](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-tables-member)|Collection of tables that are part of the worksheet.| +||[visibility](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-visibility-member)|The visibility of the worksheet.| +|[WorksheetCollection](/javascript/api/excel/excel.worksheetcollection)|[add(name?: string)](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-add-member(1))|Adds a new worksheet to the workbook.| +||[getActiveWorksheet()](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-getactiveworksheet-member(1))|Gets the currently active worksheet in the workbook.| +||[getItem(key: string)](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-getitem-member(1))|Gets a worksheet object using its name or ID.| +||[items](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-items-member)|Gets the loaded child items in this collection.| diff --git a/docs/includes/excel-1_10.md b/docs/includes/excel-1_10.md index 052cc841f7..2c06934ef5 100644 --- a/docs/includes/excel-1_10.md +++ b/docs/includes/excel-1_10.md @@ -1,146 +1,146 @@ | Class | Fields | Description | |:---|:---|:---| -|[Comment](/.comment)|[authorEmail](/.comment#excel-javascript/api/excel/-comment-authoremail-member)|Gets the email of the comment's author.| -||[authorName](/.comment#excel-javascript/api/excel/-comment-authorname-member)|Gets the name of the comment's author.| -||[content](/.comment#excel-javascript/api/excel/-comment-content-member)|The comment's content.| -||[creationDate](/.comment#excel-javascript/api/excel/-comment-creationdate-member)|Gets the creation time of the comment.| -||[delete()](/.comment#excel-javascript/api/excel/-comment-delete-member(1))|Deletes the comment and all the connected replies.| -||[getLocation()](/.comment#excel-javascript/api/excel/-comment-getlocation-member(1))|Gets the cell where this comment is located.| -||[id](/.comment#excel-javascript/api/excel/-comment-id-member)|Specifies the comment identifier.| -||[replies](/.comment#excel-javascript/api/excel/-comment-replies-member)|Represents a collection of reply objects associated with the comment.| -|[CommentCollection](/.commentcollection)|[add(cellAddress: Range \| string, content: string, contentType?: Excel.ContentType)](/.commentcollection#excel-javascript/api/excel/-commentcollection-add-member(1))|Creates a new comment with the given content on the given cell.| -||[getCount()](/.commentcollection#excel-javascript/api/excel/-commentcollection-getcount-member(1))|Gets the number of comments in the collection.| -||[getItem(commentId: string)](/.commentcollection#excel-javascript/api/excel/-commentcollection-getitem-member(1))|Gets a comment from the collection based on its ID.| -||[getItemAt(index: number)](/.commentcollection#excel-javascript/api/excel/-commentcollection-getitemat-member(1))|Gets a comment from the collection based on its position.| -||[getItemByCell(cellAddress: Range \| string)](/.commentcollection#excel-javascript/api/excel/-commentcollection-getitembycell-member(1))|Gets the comment from the specified cell.| -||[getItemByReplyId(replyId: string)](/.commentcollection#excel-javascript/api/excel/-commentcollection-getitembyreplyid-member(1))|Gets the comment to which the given reply is connected.| -||[items](/.commentcollection#excel-javascript/api/excel/-commentcollection-items-member)|Gets the loaded child items in this collection.| -|[CommentReply](/.commentreply)|[authorEmail](/.commentreply#excel-javascript/api/excel/-commentreply-authoremail-member)|Gets the email of the comment reply's author.| -||[authorName](/.commentreply#excel-javascript/api/excel/-commentreply-authorname-member)|Gets the name of the comment reply's author.| -||[content](/.commentreply#excel-javascript/api/excel/-commentreply-content-member)|The comment reply's content.| -||[creationDate](/.commentreply#excel-javascript/api/excel/-commentreply-creationdate-member)|Gets the creation time of the comment reply.| -||[delete()](/.commentreply#excel-javascript/api/excel/-commentreply-delete-member(1))|Deletes the comment reply.| -||[getLocation()](/.commentreply#excel-javascript/api/excel/-commentreply-getlocation-member(1))|Gets the cell where this comment reply is located.| -||[getParentComment()](/.commentreply#excel-javascript/api/excel/-commentreply-getparentcomment-member(1))|Gets the parent comment of this reply.| -||[id](/.commentreply#excel-javascript/api/excel/-commentreply-id-member)|Specifies the comment reply identifier.| -|[CommentReplyCollection](/.commentreplycollection)|[add(content: string, contentType?: Excel.ContentType)](/.commentreplycollection#excel-javascript/api/excel/-commentreplycollection-add-member(1))|Creates a comment reply for a comment.| -||[getCount()](/.commentreplycollection#excel-javascript/api/excel/-commentreplycollection-getcount-member(1))|Gets the number of comment replies in the collection.| -||[getItem(commentReplyId: string)](/.commentreplycollection#excel-javascript/api/excel/-commentreplycollection-getitem-member(1))|Returns a comment reply identified by its ID.| -||[getItemAt(index: number)](/.commentreplycollection#excel-javascript/api/excel/-commentreplycollection-getitemat-member(1))|Gets a comment reply based on its position in the collection.| -||[items](/.commentreplycollection#excel-javascript/api/excel/-commentreplycollection-items-member)|Gets the loaded child items in this collection.| -|[PivotLayout](/.pivotlayout)|[enableFieldList](/.pivotlayout#excel-javascript/api/excel/-pivotlayout-enablefieldlist-member)|Specifies if the field list can be shown in the UI.| -|[PivotTableStyle](/.pivottablestyle)|[delete()](/.pivottablestyle#excel-javascript/api/excel/-pivottablestyle-delete-member(1))|Deletes the PivotTable style.| -||[duplicate()](/.pivottablestyle#excel-javascript/api/excel/-pivottablestyle-duplicate-member(1))|Creates a duplicate of this PivotTable style with copies of all the style elements.| -||[name](/.pivottablestyle#excel-javascript/api/excel/-pivottablestyle-name-member)|Specifies the name of the PivotTable style.| -||[readOnly](/.pivottablestyle#excel-javascript/api/excel/-pivottablestyle-readonly-member)|Specifies if this `PivotTableStyle` object is read-only.| -|[PivotTableStyleCollection](/.pivottablestylecollection)|[add(name: string, makeUniqueName?: boolean)](/.pivottablestylecollection#excel-javascript/api/excel/-pivottablestylecollection-add-member(1))|Creates a blank `PivotTableStyle` with the specified name.| -||[getCount()](/.pivottablestylecollection#excel-javascript/api/excel/-pivottablestylecollection-getcount-member(1))|Gets the number of PivotTable styles in the collection.| -||[getDefault()](/.pivottablestylecollection#excel-javascript/api/excel/-pivottablestylecollection-getdefault-member(1))|Gets the default PivotTable style for the parent object's scope.| -||[getItem(name: string)](/.pivottablestylecollection#excel-javascript/api/excel/-pivottablestylecollection-getitem-member(1))|Gets a `PivotTableStyle` by name.| -||[getItemOrNullObject(name: string)](/.pivottablestylecollection#excel-javascript/api/excel/-pivottablestylecollection-getitemornullobject-member(1))|Gets a `PivotTableStyle` by name.| -||[items](/.pivottablestylecollection#excel-javascript/api/excel/-pivottablestylecollection-items-member)|Gets the loaded child items in this collection.| -||[setDefault(newDefaultStyle: PivotTableStyle \| string)](/.pivottablestylecollection#excel-javascript/api/excel/-pivottablestylecollection-setdefault-member(1))|Sets the default PivotTable style for use in the parent object's scope.| -|[Range](/.range)|[group(groupOption: Excel.GroupOption)](/.range#excel-javascript/api/excel/-range-group-member(1))|Groups columns and rows for an outline.| -||[height](/.range#excel-javascript/api/excel/-range-height-member)|Returns the distance in points, for 100% zoom, from the top edge of the range to the bottom edge of the range.| -||[hideGroupDetails(groupOption: Excel.GroupOption)](/.range#excel-javascript/api/excel/-range-hidegroupdetails-member(1))|Hides the details of the row or column group.| -||[left](/.range#excel-javascript/api/excel/-range-left-member)|Returns the distance in points, for 100% zoom, from the left edge of the worksheet to the left edge of the range.| -||[showGroupDetails(groupOption: Excel.GroupOption)](/.range#excel-javascript/api/excel/-range-showgroupdetails-member(1))|Shows the details of the row or column group.| -||[top](/.range#excel-javascript/api/excel/-range-top-member)|Returns the distance in points, for 100% zoom, from the top edge of the worksheet to the top edge of the range.| -||[ungroup(groupOption: Excel.GroupOption)](/.range#excel-javascript/api/excel/-range-ungroup-member(1))|Ungroups columns and rows for an outline.| -||[width](/.range#excel-javascript/api/excel/-range-width-member)|Returns the distance in points, for 100% zoom, from the left edge of the range to the right edge of the range.| -|[Shape](/.shape)|[copyTo(destinationSheet?: Worksheet \| string)](/.shape#excel-javascript/api/excel/-shape-copyto-member(1))|Copies and pastes a `Shape` object.| -||[placement](/.shape#excel-javascript/api/excel/-shape-placement-member)|Represents how the object is attached to the cells below it.| -|[Slicer](/.slicer)|[caption](/.slicer#excel-javascript/api/excel/-slicer-caption-member)|Represents the caption of the slicer.| -||[clearFilters()](/.slicer#excel-javascript/api/excel/-slicer-clearfilters-member(1))|Clears all the filters currently applied on the slicer.| -||[delete()](/.slicer#excel-javascript/api/excel/-slicer-delete-member(1))|Deletes the slicer.| -||[getSelectedItems()](/.slicer#excel-javascript/api/excel/-slicer-getselecteditems-member(1))|Returns an array of selected items' keys.| -||[height](/.slicer#excel-javascript/api/excel/-slicer-height-member)|Specifies the height, in points, of the slicer.| -||[id](/.slicer#excel-javascript/api/excel/-slicer-id-member)|Represents the unique ID of the slicer.| -||[isFilterCleared](/.slicer#excel-javascript/api/excel/-slicer-isfiltercleared-member)|Value is `true` if all filters currently applied on the slicer are cleared.| -||[left](/.slicer#excel-javascript/api/excel/-slicer-left-member)|Represents the distance, in points, from the left side of the slicer to the left of the worksheet.| -||[name](/.slicer#excel-javascript/api/excel/-slicer-name-member)|Represents the name of the slicer.| -||[selectItems(items?: string[])](/.slicer#excel-javascript/api/excel/-slicer-selectitems-member(1))|Selects slicer items based on their keys.| -||[slicerItems](/.slicer#excel-javascript/api/excel/-slicer-sliceritems-member)|Represents the collection of slicer items that are part of the slicer.| -||[sortBy](/.slicer#excel-javascript/api/excel/-slicer-sortby-member)|Specifies the sort order of the items in the slicer.| -||[style](/.slicer#excel-javascript/api/excel/-slicer-style-member)|Constant value that represents the slicer style.| -||[top](/.slicer#excel-javascript/api/excel/-slicer-top-member)|Represents the distance, in points, from the top edge of the slicer to the top of the worksheet.| -||[width](/.slicer#excel-javascript/api/excel/-slicer-width-member)|Represents the width, in points, of the slicer.| -||[worksheet](/.slicer#excel-javascript/api/excel/-slicer-worksheet-member)|Represents the worksheet containing the slicer.| -|[SlicerCollection](/.slicercollection)|[add(slicerSource: string \| PivotTable \| Table, sourceField: string \| PivotField \| number \| TableColumn, slicerDestination?: string \| Worksheet)](/.slicercollection#excel-javascript/api/excel/-slicercollection-add-member(1))|Adds a new slicer to the workbook.| -||[getCount()](/.slicercollection#excel-javascript/api/excel/-slicercollection-getcount-member(1))|Returns the number of slicers in the collection.| -||[getItem(key: string)](/.slicercollection#excel-javascript/api/excel/-slicercollection-getitem-member(1))|Gets a slicer object using its name or ID.| -||[getItemAt(index: number)](/.slicercollection#excel-javascript/api/excel/-slicercollection-getitemat-member(1))|Gets a slicer based on its position in the collection.| -||[getItemOrNullObject(key: string)](/.slicercollection#excel-javascript/api/excel/-slicercollection-getitemornullobject-member(1))|Gets a slicer using its name or ID.| -||[items](/.slicercollection#excel-javascript/api/excel/-slicercollection-items-member)|Gets the loaded child items in this collection.| -|[SlicerItem](/.sliceritem)|[hasData](/.sliceritem#excel-javascript/api/excel/-sliceritem-hasdata-member)|Value is `true` if the slicer item has data.| -||[isSelected](/.sliceritem#excel-javascript/api/excel/-sliceritem-isselected-member)|Value is `true` if the slicer item is selected.| -||[key](/.sliceritem#excel-javascript/api/excel/-sliceritem-key-member)|Represents the unique value representing the slicer item.| -||[name](/.sliceritem#excel-javascript/api/excel/-sliceritem-name-member)|Represents the title displayed in the Excel UI.| -|[SlicerItemCollection](/.sliceritemcollection)|[getCount()](/.sliceritemcollection#excel-javascript/api/excel/-sliceritemcollection-getcount-member(1))|Returns the number of slicer items in the slicer.| -||[getItem(key: string)](/.sliceritemcollection#excel-javascript/api/excel/-sliceritemcollection-getitem-member(1))|Gets a slicer item object using its key or name.| -||[getItemAt(index: number)](/.sliceritemcollection#excel-javascript/api/excel/-sliceritemcollection-getitemat-member(1))|Gets a slicer item based on its position in the collection.| -||[getItemOrNullObject(key: string)](/.sliceritemcollection#excel-javascript/api/excel/-sliceritemcollection-getitemornullobject-member(1))|Gets a slicer item using its key or name.| -||[items](/.sliceritemcollection#excel-javascript/api/excel/-sliceritemcollection-items-member)|Gets the loaded child items in this collection.| -|[SlicerStyle](/.slicerstyle)|[delete()](/.slicerstyle#excel-javascript/api/excel/-slicerstyle-delete-member(1))|Deletes the slicer style.| -||[duplicate()](/.slicerstyle#excel-javascript/api/excel/-slicerstyle-duplicate-member(1))|Creates a duplicate of this slicer style with copies of all the style elements.| -||[name](/.slicerstyle#excel-javascript/api/excel/-slicerstyle-name-member)|Specifies the name of the slicer style.| -||[readOnly](/.slicerstyle#excel-javascript/api/excel/-slicerstyle-readonly-member)|Specifies if this `SlicerStyle` object is read-only.| -|[SlicerStyleCollection](/.slicerstylecollection)|[add(name: string, makeUniqueName?: boolean)](/.slicerstylecollection#excel-javascript/api/excel/-slicerstylecollection-add-member(1))|Creates a blank slicer style with the specified name.| -||[getCount()](/.slicerstylecollection#excel-javascript/api/excel/-slicerstylecollection-getcount-member(1))|Gets the number of slicer styles in the collection.| -||[getDefault()](/.slicerstylecollection#excel-javascript/api/excel/-slicerstylecollection-getdefault-member(1))|Gets the default `SlicerStyle` for the parent object's scope.| -||[getItem(name: string)](/.slicerstylecollection#excel-javascript/api/excel/-slicerstylecollection-getitem-member(1))|Gets a `SlicerStyle` by name.| -||[getItemOrNullObject(name: string)](/.slicerstylecollection#excel-javascript/api/excel/-slicerstylecollection-getitemornullobject-member(1))|Gets a `SlicerStyle` by name.| -||[items](/.slicerstylecollection#excel-javascript/api/excel/-slicerstylecollection-items-member)|Gets the loaded child items in this collection.| -||[setDefault(newDefaultStyle: SlicerStyle \| string)](/.slicerstylecollection#excel-javascript/api/excel/-slicerstylecollection-setdefault-member(1))|Sets the default slicer style for use in the parent object's scope.| -|[TableStyle](/.tablestyle)|[delete()](/.tablestyle#excel-javascript/api/excel/-tablestyle-delete-member(1))|Deletes the table style.| -||[duplicate()](/.tablestyle#excel-javascript/api/excel/-tablestyle-duplicate-member(1))|Creates a duplicate of this table style with copies of all the style elements.| -||[name](/.tablestyle#excel-javascript/api/excel/-tablestyle-name-member)|Specifies the name of the table style.| -||[readOnly](/.tablestyle#excel-javascript/api/excel/-tablestyle-readonly-member)|Specifies if this `TableStyle` object is read-only.| -|[TableStyleCollection](/.tablestylecollection)|[add(name: string, makeUniqueName?: boolean)](/.tablestylecollection#excel-javascript/api/excel/-tablestylecollection-add-member(1))|Creates a blank `TableStyle` with the specified name.| -||[getCount()](/.tablestylecollection#excel-javascript/api/excel/-tablestylecollection-getcount-member(1))|Gets the number of table styles in the collection.| -||[getDefault()](/.tablestylecollection#excel-javascript/api/excel/-tablestylecollection-getdefault-member(1))|Gets the default table style for the parent object's scope.| -||[getItem(name: string)](/.tablestylecollection#excel-javascript/api/excel/-tablestylecollection-getitem-member(1))|Gets a `TableStyle` by name.| -||[getItemOrNullObject(name: string)](/.tablestylecollection#excel-javascript/api/excel/-tablestylecollection-getitemornullobject-member(1))|Gets a `TableStyle` by name.| -||[items](/.tablestylecollection#excel-javascript/api/excel/-tablestylecollection-items-member)|Gets the loaded child items in this collection.| -||[setDefault(newDefaultStyle: TableStyle \| string)](/.tablestylecollection#excel-javascript/api/excel/-tablestylecollection-setdefault-member(1))|Sets the default table style for use in the parent object's scope.| -|[TimelineStyle](/.timelinestyle)|[delete()](/.timelinestyle#excel-javascript/api/excel/-timelinestyle-delete-member(1))|Deletes the table style.| -||[duplicate()](/.timelinestyle#excel-javascript/api/excel/-timelinestyle-duplicate-member(1))|Creates a duplicate of this timeline style with copies of all the style elements.| -||[name](/.timelinestyle#excel-javascript/api/excel/-timelinestyle-name-member)|Specifies the name of the timeline style.| -||[readOnly](/.timelinestyle#excel-javascript/api/excel/-timelinestyle-readonly-member)|Specifies if this `TimelineStyle` object is read-only.| -|[TimelineStyleCollection](/.timelinestylecollection)|[add(name: string, makeUniqueName?: boolean)](/.timelinestylecollection#excel-javascript/api/excel/-timelinestylecollection-add-member(1))|Creates a blank `TimelineStyle` with the specified name.| -||[getCount()](/.timelinestylecollection#excel-javascript/api/excel/-timelinestylecollection-getcount-member(1))|Gets the number of timeline styles in the collection.| -||[getDefault()](/.timelinestylecollection#excel-javascript/api/excel/-timelinestylecollection-getdefault-member(1))|Gets the default timeline style for the parent object's scope.| -||[getItem(name: string)](/.timelinestylecollection#excel-javascript/api/excel/-timelinestylecollection-getitem-member(1))|Gets a `TimelineStyle` by name.| -||[getItemOrNullObject(name: string)](/.timelinestylecollection#excel-javascript/api/excel/-timelinestylecollection-getitemornullobject-member(1))|Gets a `TimelineStyle` by name.| -||[items](/.timelinestylecollection#excel-javascript/api/excel/-timelinestylecollection-items-member)|Gets the loaded child items in this collection.| -||[setDefault(newDefaultStyle: TimelineStyle \| string)](/.timelinestylecollection#excel-javascript/api/excel/-timelinestylecollection-setdefault-member(1))|Sets the default timeline style for use in the parent object's scope.| -|[Workbook](/.workbook)|[comments](/.workbook#excel-javascript/api/excel/-workbook-comments-member)|Represents a collection of comments associated with the workbook.| -||[getActiveSlicer()](/.workbook#excel-javascript/api/excel/-workbook-getactiveslicer-member(1))|Gets the currently active slicer in the workbook.| -||[getActiveSlicerOrNullObject()](/.workbook#excel-javascript/api/excel/-workbook-getactiveslicerornullobject-member(1))|Gets the currently active slicer in the workbook.| -||[pivotTableStyles](/.workbook#excel-javascript/api/excel/-workbook-pivottablestyles-member)|Represents a collection of PivotTableStyles associated with the workbook.| -||[slicerStyles](/.workbook#excel-javascript/api/excel/-workbook-slicerstyles-member)|Represents a collection of SlicerStyles associated with the workbook.| -||[slicers](/.workbook#excel-javascript/api/excel/-workbook-slicers-member)|Represents a collection of slicers associated with the workbook.| -||[tableStyles](/.workbook#excel-javascript/api/excel/-workbook-tablestyles-member)|Represents a collection of TableStyles associated with the workbook.| -||[timelineStyles](/.workbook#excel-javascript/api/excel/-workbook-timelinestyles-member)|Represents a collection of TimelineStyles associated with the workbook.| -|[Worksheet](/.worksheet)|[comments](/.worksheet#excel-javascript/api/excel/-worksheet-comments-member)|Returns a collection of all the Comments objects on the worksheet.| -||[onColumnSorted](/.worksheet#excel-javascript/api/excel/-worksheet-oncolumnsorted-member)|Occurs when one or more columns have been sorted.| -||[onRowSorted](/.worksheet#excel-javascript/api/excel/-worksheet-onrowsorted-member)|Occurs when one or more rows have been sorted.| -||[onSingleClicked](/.worksheet#excel-javascript/api/excel/-worksheet-onsingleclicked-member)|Occurs when a left-clicked/tapped action happens in the worksheet.| -||[showOutlineLevels(rowLevels: number, columnLevels: number)](/.worksheet#excel-javascript/api/excel/-worksheet-showoutlinelevels-member(1))|Shows row or column groups by their outline levels.| -||[slicers](/.worksheet#excel-javascript/api/excel/-worksheet-slicers-member)|Returns a collection of slicers that are part of the worksheet.| -|[WorksheetCollection](/.worksheetcollection)|[onColumnSorted](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-oncolumnsorted-member)|Occurs when one or more columns have been sorted.| -||[onRowSorted](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-onrowsorted-member)|Occurs when one or more rows have been sorted.| -||[onSingleClicked](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-onsingleclicked-member)|Occurs when left-clicked/tapped operation happens in the worksheet collection.| -|[WorksheetColumnSortedEventArgs](/.worksheetcolumnsortedeventargs)|[address](/.worksheetcolumnsortedeventargs#excel-javascript/api/excel/-worksheetcolumnsortedeventargs-address-member)|Gets the range address that represents the sorted areas of a specific worksheet.| -||[source](/.worksheetcolumnsortedeventargs#excel-javascript/api/excel/-worksheetcolumnsortedeventargs-source-member)|Gets the source of the event.| -||[type](/.worksheetcolumnsortedeventargs#excel-javascript/api/excel/-worksheetcolumnsortedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/.worksheetcolumnsortedeventargs#excel-javascript/api/excel/-worksheetcolumnsortedeventargs-worksheetid-member)|Gets the ID of the worksheet where the sorting happened.| -|[WorksheetRowSortedEventArgs](/.worksheetrowsortedeventargs)|[address](/.worksheetrowsortedeventargs#excel-javascript/api/excel/-worksheetrowsortedeventargs-address-member)|Gets the range address that represents the sorted areas of a specific worksheet.| -||[source](/.worksheetrowsortedeventargs#excel-javascript/api/excel/-worksheetrowsortedeventargs-source-member)|Gets the source of the event.| -||[type](/.worksheetrowsortedeventargs#excel-javascript/api/excel/-worksheetrowsortedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/.worksheetrowsortedeventargs#excel-javascript/api/excel/-worksheetrowsortedeventargs-worksheetid-member)|Gets the ID of the worksheet where the sorting happened.| -|[WorksheetSingleClickedEventArgs](/.worksheetsingleclickedeventargs)|[address](/.worksheetsingleclickedeventargs#excel-javascript/api/excel/-worksheetsingleclickedeventargs-address-member)|Gets the address that represents the cell which was left-clicked/tapped for a specific worksheet.| -||[offsetX](/.worksheetsingleclickedeventargs#excel-javascript/api/excel/-worksheetsingleclickedeventargs-offsetx-member)|The distance, in points, from the left-clicked/tapped point to the left (or right for right-to-left languages) gridline edge of the left-clicked/tapped cell.| -||[offsetY](/.worksheetsingleclickedeventargs#excel-javascript/api/excel/-worksheetsingleclickedeventargs-offsety-member)|The distance, in points, from the left-clicked/tapped point to the top gridline edge of the left-clicked/tapped cell.| -||[type](/.worksheetsingleclickedeventargs#excel-javascript/api/excel/-worksheetsingleclickedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/.worksheetsingleclickedeventargs#excel-javascript/api/excel/-worksheetsingleclickedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the cell was left-clicked/tapped.| +|[Comment](/javascript/api/excel/excel.comment)|[authorEmail](/javascript/api/excel/excel.comment#excel-excel-comment-authoremail-member)|Gets the email of the comment's author.| +||[authorName](/javascript/api/excel/excel.comment#excel-excel-comment-authorname-member)|Gets the name of the comment's author.| +||[content](/javascript/api/excel/excel.comment#excel-excel-comment-content-member)|The comment's content.| +||[creationDate](/javascript/api/excel/excel.comment#excel-excel-comment-creationdate-member)|Gets the creation time of the comment.| +||[delete()](/javascript/api/excel/excel.comment#excel-excel-comment-delete-member(1))|Deletes the comment and all the connected replies.| +||[getLocation()](/javascript/api/excel/excel.comment#excel-excel-comment-getlocation-member(1))|Gets the cell where this comment is located.| +||[id](/javascript/api/excel/excel.comment#excel-excel-comment-id-member)|Specifies the comment identifier.| +||[replies](/javascript/api/excel/excel.comment#excel-excel-comment-replies-member)|Represents a collection of reply objects associated with the comment.| +|[CommentCollection](/javascript/api/excel/excel.commentcollection)|[add(cellAddress: Range \| string, content: string, contentType?: Excel.ContentType)](/javascript/api/excel/excel.commentcollection#excel-excel-commentcollection-add-member(1))|Creates a new comment with the given content on the given cell.| +||[getCount()](/javascript/api/excel/excel.commentcollection#excel-excel-commentcollection-getcount-member(1))|Gets the number of comments in the collection.| +||[getItem(commentId: string)](/javascript/api/excel/excel.commentcollection#excel-excel-commentcollection-getitem-member(1))|Gets a comment from the collection based on its ID.| +||[getItemAt(index: number)](/javascript/api/excel/excel.commentcollection#excel-excel-commentcollection-getitemat-member(1))|Gets a comment from the collection based on its position.| +||[getItemByCell(cellAddress: Range \| string)](/javascript/api/excel/excel.commentcollection#excel-excel-commentcollection-getitembycell-member(1))|Gets the comment from the specified cell.| +||[getItemByReplyId(replyId: string)](/javascript/api/excel/excel.commentcollection#excel-excel-commentcollection-getitembyreplyid-member(1))|Gets the comment to which the given reply is connected.| +||[items](/javascript/api/excel/excel.commentcollection#excel-excel-commentcollection-items-member)|Gets the loaded child items in this collection.| +|[CommentReply](/javascript/api/excel/excel.commentreply)|[authorEmail](/javascript/api/excel/excel.commentreply#excel-excel-commentreply-authoremail-member)|Gets the email of the comment reply's author.| +||[authorName](/javascript/api/excel/excel.commentreply#excel-excel-commentreply-authorname-member)|Gets the name of the comment reply's author.| +||[content](/javascript/api/excel/excel.commentreply#excel-excel-commentreply-content-member)|The comment reply's content.| +||[creationDate](/javascript/api/excel/excel.commentreply#excel-excel-commentreply-creationdate-member)|Gets the creation time of the comment reply.| +||[delete()](/javascript/api/excel/excel.commentreply#excel-excel-commentreply-delete-member(1))|Deletes the comment reply.| +||[getLocation()](/javascript/api/excel/excel.commentreply#excel-excel-commentreply-getlocation-member(1))|Gets the cell where this comment reply is located.| +||[getParentComment()](/javascript/api/excel/excel.commentreply#excel-excel-commentreply-getparentcomment-member(1))|Gets the parent comment of this reply.| +||[id](/javascript/api/excel/excel.commentreply#excel-excel-commentreply-id-member)|Specifies the comment reply identifier.| +|[CommentReplyCollection](/javascript/api/excel/excel.commentreplycollection)|[add(content: string, contentType?: Excel.ContentType)](/javascript/api/excel/excel.commentreplycollection#excel-excel-commentreplycollection-add-member(1))|Creates a comment reply for a comment.| +||[getCount()](/javascript/api/excel/excel.commentreplycollection#excel-excel-commentreplycollection-getcount-member(1))|Gets the number of comment replies in the collection.| +||[getItem(commentReplyId: string)](/javascript/api/excel/excel.commentreplycollection#excel-excel-commentreplycollection-getitem-member(1))|Returns a comment reply identified by its ID.| +||[getItemAt(index: number)](/javascript/api/excel/excel.commentreplycollection#excel-excel-commentreplycollection-getitemat-member(1))|Gets a comment reply based on its position in the collection.| +||[items](/javascript/api/excel/excel.commentreplycollection#excel-excel-commentreplycollection-items-member)|Gets the loaded child items in this collection.| +|[PivotLayout](/javascript/api/excel/excel.pivotlayout)|[enableFieldList](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-enablefieldlist-member)|Specifies if the field list can be shown in the UI.| +|[PivotTableStyle](/javascript/api/excel/excel.pivottablestyle)|[delete()](/javascript/api/excel/excel.pivottablestyle#excel-excel-pivottablestyle-delete-member(1))|Deletes the PivotTable style.| +||[duplicate()](/javascript/api/excel/excel.pivottablestyle#excel-excel-pivottablestyle-duplicate-member(1))|Creates a duplicate of this PivotTable style with copies of all the style elements.| +||[name](/javascript/api/excel/excel.pivottablestyle#excel-excel-pivottablestyle-name-member)|Specifies the name of the PivotTable style.| +||[readOnly](/javascript/api/excel/excel.pivottablestyle#excel-excel-pivottablestyle-readonly-member)|Specifies if this `PivotTableStyle` object is read-only.| +|[PivotTableStyleCollection](/javascript/api/excel/excel.pivottablestylecollection)|[add(name: string, makeUniqueName?: boolean)](/javascript/api/excel/excel.pivottablestylecollection#excel-excel-pivottablestylecollection-add-member(1))|Creates a blank `PivotTableStyle` with the specified name.| +||[getCount()](/javascript/api/excel/excel.pivottablestylecollection#excel-excel-pivottablestylecollection-getcount-member(1))|Gets the number of PivotTable styles in the collection.| +||[getDefault()](/javascript/api/excel/excel.pivottablestylecollection#excel-excel-pivottablestylecollection-getdefault-member(1))|Gets the default PivotTable style for the parent object's scope.| +||[getItem(name: string)](/javascript/api/excel/excel.pivottablestylecollection#excel-excel-pivottablestylecollection-getitem-member(1))|Gets a `PivotTableStyle` by name.| +||[getItemOrNullObject(name: string)](/javascript/api/excel/excel.pivottablestylecollection#excel-excel-pivottablestylecollection-getitemornullobject-member(1))|Gets a `PivotTableStyle` by name.| +||[items](/javascript/api/excel/excel.pivottablestylecollection#excel-excel-pivottablestylecollection-items-member)|Gets the loaded child items in this collection.| +||[setDefault(newDefaultStyle: PivotTableStyle \| string)](/javascript/api/excel/excel.pivottablestylecollection#excel-excel-pivottablestylecollection-setdefault-member(1))|Sets the default PivotTable style for use in the parent object's scope.| +|[Range](/javascript/api/excel/excel.range)|[group(groupOption: Excel.GroupOption)](/javascript/api/excel/excel.range#excel-excel-range-group-member(1))|Groups columns and rows for an outline.| +||[height](/javascript/api/excel/excel.range#excel-excel-range-height-member)|Returns the distance in points, for 100% zoom, from the top edge of the range to the bottom edge of the range.| +||[hideGroupDetails(groupOption: Excel.GroupOption)](/javascript/api/excel/excel.range#excel-excel-range-hidegroupdetails-member(1))|Hides the details of the row or column group.| +||[left](/javascript/api/excel/excel.range#excel-excel-range-left-member)|Returns the distance in points, for 100% zoom, from the left edge of the worksheet to the left edge of the range.| +||[showGroupDetails(groupOption: Excel.GroupOption)](/javascript/api/excel/excel.range#excel-excel-range-showgroupdetails-member(1))|Shows the details of the row or column group.| +||[top](/javascript/api/excel/excel.range#excel-excel-range-top-member)|Returns the distance in points, for 100% zoom, from the top edge of the worksheet to the top edge of the range.| +||[ungroup(groupOption: Excel.GroupOption)](/javascript/api/excel/excel.range#excel-excel-range-ungroup-member(1))|Ungroups columns and rows for an outline.| +||[width](/javascript/api/excel/excel.range#excel-excel-range-width-member)|Returns the distance in points, for 100% zoom, from the left edge of the range to the right edge of the range.| +|[Shape](/javascript/api/excel/excel.shape)|[copyTo(destinationSheet?: Worksheet \| string)](/javascript/api/excel/excel.shape#excel-excel-shape-copyto-member(1))|Copies and pastes a `Shape` object.| +||[placement](/javascript/api/excel/excel.shape#excel-excel-shape-placement-member)|Represents how the object is attached to the cells below it.| +|[Slicer](/javascript/api/excel/excel.slicer)|[caption](/javascript/api/excel/excel.slicer#excel-excel-slicer-caption-member)|Represents the caption of the slicer.| +||[clearFilters()](/javascript/api/excel/excel.slicer#excel-excel-slicer-clearfilters-member(1))|Clears all the filters currently applied on the slicer.| +||[delete()](/javascript/api/excel/excel.slicer#excel-excel-slicer-delete-member(1))|Deletes the slicer.| +||[getSelectedItems()](/javascript/api/excel/excel.slicer#excel-excel-slicer-getselecteditems-member(1))|Returns an array of selected items' keys.| +||[height](/javascript/api/excel/excel.slicer#excel-excel-slicer-height-member)|Specifies the height, in points, of the slicer.| +||[id](/javascript/api/excel/excel.slicer#excel-excel-slicer-id-member)|Represents the unique ID of the slicer.| +||[isFilterCleared](/javascript/api/excel/excel.slicer#excel-excel-slicer-isfiltercleared-member)|Value is `true` if all filters currently applied on the slicer are cleared.| +||[left](/javascript/api/excel/excel.slicer#excel-excel-slicer-left-member)|Represents the distance, in points, from the left side of the slicer to the left of the worksheet.| +||[name](/javascript/api/excel/excel.slicer#excel-excel-slicer-name-member)|Represents the name of the slicer.| +||[selectItems(items?: string[])](/javascript/api/excel/excel.slicer#excel-excel-slicer-selectitems-member(1))|Selects slicer items based on their keys.| +||[slicerItems](/javascript/api/excel/excel.slicer#excel-excel-slicer-sliceritems-member)|Represents the collection of slicer items that are part of the slicer.| +||[sortBy](/javascript/api/excel/excel.slicer#excel-excel-slicer-sortby-member)|Specifies the sort order of the items in the slicer.| +||[style](/javascript/api/excel/excel.slicer#excel-excel-slicer-style-member)|Constant value that represents the slicer style.| +||[top](/javascript/api/excel/excel.slicer#excel-excel-slicer-top-member)|Represents the distance, in points, from the top edge of the slicer to the top of the worksheet.| +||[width](/javascript/api/excel/excel.slicer#excel-excel-slicer-width-member)|Represents the width, in points, of the slicer.| +||[worksheet](/javascript/api/excel/excel.slicer#excel-excel-slicer-worksheet-member)|Represents the worksheet containing the slicer.| +|[SlicerCollection](/javascript/api/excel/excel.slicercollection)|[add(slicerSource: string \| PivotTable \| Table, sourceField: string \| PivotField \| number \| TableColumn, slicerDestination?: string \| Worksheet)](/javascript/api/excel/excel.slicercollection#excel-excel-slicercollection-add-member(1))|Adds a new slicer to the workbook.| +||[getCount()](/javascript/api/excel/excel.slicercollection#excel-excel-slicercollection-getcount-member(1))|Returns the number of slicers in the collection.| +||[getItem(key: string)](/javascript/api/excel/excel.slicercollection#excel-excel-slicercollection-getitem-member(1))|Gets a slicer object using its name or ID.| +||[getItemAt(index: number)](/javascript/api/excel/excel.slicercollection#excel-excel-slicercollection-getitemat-member(1))|Gets a slicer based on its position in the collection.| +||[getItemOrNullObject(key: string)](/javascript/api/excel/excel.slicercollection#excel-excel-slicercollection-getitemornullobject-member(1))|Gets a slicer using its name or ID.| +||[items](/javascript/api/excel/excel.slicercollection#excel-excel-slicercollection-items-member)|Gets the loaded child items in this collection.| +|[SlicerItem](/javascript/api/excel/excel.sliceritem)|[hasData](/javascript/api/excel/excel.sliceritem#excel-excel-sliceritem-hasdata-member)|Value is `true` if the slicer item has data.| +||[isSelected](/javascript/api/excel/excel.sliceritem#excel-excel-sliceritem-isselected-member)|Value is `true` if the slicer item is selected.| +||[key](/javascript/api/excel/excel.sliceritem#excel-excel-sliceritem-key-member)|Represents the unique value representing the slicer item.| +||[name](/javascript/api/excel/excel.sliceritem#excel-excel-sliceritem-name-member)|Represents the title displayed in the Excel UI.| +|[SlicerItemCollection](/javascript/api/excel/excel.sliceritemcollection)|[getCount()](/javascript/api/excel/excel.sliceritemcollection#excel-excel-sliceritemcollection-getcount-member(1))|Returns the number of slicer items in the slicer.| +||[getItem(key: string)](/javascript/api/excel/excel.sliceritemcollection#excel-excel-sliceritemcollection-getitem-member(1))|Gets a slicer item object using its key or name.| +||[getItemAt(index: number)](/javascript/api/excel/excel.sliceritemcollection#excel-excel-sliceritemcollection-getitemat-member(1))|Gets a slicer item based on its position in the collection.| +||[getItemOrNullObject(key: string)](/javascript/api/excel/excel.sliceritemcollection#excel-excel-sliceritemcollection-getitemornullobject-member(1))|Gets a slicer item using its key or name.| +||[items](/javascript/api/excel/excel.sliceritemcollection#excel-excel-sliceritemcollection-items-member)|Gets the loaded child items in this collection.| +|[SlicerStyle](/javascript/api/excel/excel.slicerstyle)|[delete()](/javascript/api/excel/excel.slicerstyle#excel-excel-slicerstyle-delete-member(1))|Deletes the slicer style.| +||[duplicate()](/javascript/api/excel/excel.slicerstyle#excel-excel-slicerstyle-duplicate-member(1))|Creates a duplicate of this slicer style with copies of all the style elements.| +||[name](/javascript/api/excel/excel.slicerstyle#excel-excel-slicerstyle-name-member)|Specifies the name of the slicer style.| +||[readOnly](/javascript/api/excel/excel.slicerstyle#excel-excel-slicerstyle-readonly-member)|Specifies if this `SlicerStyle` object is read-only.| +|[SlicerStyleCollection](/javascript/api/excel/excel.slicerstylecollection)|[add(name: string, makeUniqueName?: boolean)](/javascript/api/excel/excel.slicerstylecollection#excel-excel-slicerstylecollection-add-member(1))|Creates a blank slicer style with the specified name.| +||[getCount()](/javascript/api/excel/excel.slicerstylecollection#excel-excel-slicerstylecollection-getcount-member(1))|Gets the number of slicer styles in the collection.| +||[getDefault()](/javascript/api/excel/excel.slicerstylecollection#excel-excel-slicerstylecollection-getdefault-member(1))|Gets the default `SlicerStyle` for the parent object's scope.| +||[getItem(name: string)](/javascript/api/excel/excel.slicerstylecollection#excel-excel-slicerstylecollection-getitem-member(1))|Gets a `SlicerStyle` by name.| +||[getItemOrNullObject(name: string)](/javascript/api/excel/excel.slicerstylecollection#excel-excel-slicerstylecollection-getitemornullobject-member(1))|Gets a `SlicerStyle` by name.| +||[items](/javascript/api/excel/excel.slicerstylecollection#excel-excel-slicerstylecollection-items-member)|Gets the loaded child items in this collection.| +||[setDefault(newDefaultStyle: SlicerStyle \| string)](/javascript/api/excel/excel.slicerstylecollection#excel-excel-slicerstylecollection-setdefault-member(1))|Sets the default slicer style for use in the parent object's scope.| +|[TableStyle](/javascript/api/excel/excel.tablestyle)|[delete()](/javascript/api/excel/excel.tablestyle#excel-excel-tablestyle-delete-member(1))|Deletes the table style.| +||[duplicate()](/javascript/api/excel/excel.tablestyle#excel-excel-tablestyle-duplicate-member(1))|Creates a duplicate of this table style with copies of all the style elements.| +||[name](/javascript/api/excel/excel.tablestyle#excel-excel-tablestyle-name-member)|Specifies the name of the table style.| +||[readOnly](/javascript/api/excel/excel.tablestyle#excel-excel-tablestyle-readonly-member)|Specifies if this `TableStyle` object is read-only.| +|[TableStyleCollection](/javascript/api/excel/excel.tablestylecollection)|[add(name: string, makeUniqueName?: boolean)](/javascript/api/excel/excel.tablestylecollection#excel-excel-tablestylecollection-add-member(1))|Creates a blank `TableStyle` with the specified name.| +||[getCount()](/javascript/api/excel/excel.tablestylecollection#excel-excel-tablestylecollection-getcount-member(1))|Gets the number of table styles in the collection.| +||[getDefault()](/javascript/api/excel/excel.tablestylecollection#excel-excel-tablestylecollection-getdefault-member(1))|Gets the default table style for the parent object's scope.| +||[getItem(name: string)](/javascript/api/excel/excel.tablestylecollection#excel-excel-tablestylecollection-getitem-member(1))|Gets a `TableStyle` by name.| +||[getItemOrNullObject(name: string)](/javascript/api/excel/excel.tablestylecollection#excel-excel-tablestylecollection-getitemornullobject-member(1))|Gets a `TableStyle` by name.| +||[items](/javascript/api/excel/excel.tablestylecollection#excel-excel-tablestylecollection-items-member)|Gets the loaded child items in this collection.| +||[setDefault(newDefaultStyle: TableStyle \| string)](/javascript/api/excel/excel.tablestylecollection#excel-excel-tablestylecollection-setdefault-member(1))|Sets the default table style for use in the parent object's scope.| +|[TimelineStyle](/javascript/api/excel/excel.timelinestyle)|[delete()](/javascript/api/excel/excel.timelinestyle#excel-excel-timelinestyle-delete-member(1))|Deletes the table style.| +||[duplicate()](/javascript/api/excel/excel.timelinestyle#excel-excel-timelinestyle-duplicate-member(1))|Creates a duplicate of this timeline style with copies of all the style elements.| +||[name](/javascript/api/excel/excel.timelinestyle#excel-excel-timelinestyle-name-member)|Specifies the name of the timeline style.| +||[readOnly](/javascript/api/excel/excel.timelinestyle#excel-excel-timelinestyle-readonly-member)|Specifies if this `TimelineStyle` object is read-only.| +|[TimelineStyleCollection](/javascript/api/excel/excel.timelinestylecollection)|[add(name: string, makeUniqueName?: boolean)](/javascript/api/excel/excel.timelinestylecollection#excel-excel-timelinestylecollection-add-member(1))|Creates a blank `TimelineStyle` with the specified name.| +||[getCount()](/javascript/api/excel/excel.timelinestylecollection#excel-excel-timelinestylecollection-getcount-member(1))|Gets the number of timeline styles in the collection.| +||[getDefault()](/javascript/api/excel/excel.timelinestylecollection#excel-excel-timelinestylecollection-getdefault-member(1))|Gets the default timeline style for the parent object's scope.| +||[getItem(name: string)](/javascript/api/excel/excel.timelinestylecollection#excel-excel-timelinestylecollection-getitem-member(1))|Gets a `TimelineStyle` by name.| +||[getItemOrNullObject(name: string)](/javascript/api/excel/excel.timelinestylecollection#excel-excel-timelinestylecollection-getitemornullobject-member(1))|Gets a `TimelineStyle` by name.| +||[items](/javascript/api/excel/excel.timelinestylecollection#excel-excel-timelinestylecollection-items-member)|Gets the loaded child items in this collection.| +||[setDefault(newDefaultStyle: TimelineStyle \| string)](/javascript/api/excel/excel.timelinestylecollection#excel-excel-timelinestylecollection-setdefault-member(1))|Sets the default timeline style for use in the parent object's scope.| +|[Workbook](/javascript/api/excel/excel.workbook)|[comments](/javascript/api/excel/excel.workbook#excel-excel-workbook-comments-member)|Represents a collection of comments associated with the workbook.| +||[getActiveSlicer()](/javascript/api/excel/excel.workbook#excel-excel-workbook-getactiveslicer-member(1))|Gets the currently active slicer in the workbook.| +||[getActiveSlicerOrNullObject()](/javascript/api/excel/excel.workbook#excel-excel-workbook-getactiveslicerornullobject-member(1))|Gets the currently active slicer in the workbook.| +||[pivotTableStyles](/javascript/api/excel/excel.workbook#excel-excel-workbook-pivottablestyles-member)|Represents a collection of PivotTableStyles associated with the workbook.| +||[slicerStyles](/javascript/api/excel/excel.workbook#excel-excel-workbook-slicerstyles-member)|Represents a collection of SlicerStyles associated with the workbook.| +||[slicers](/javascript/api/excel/excel.workbook#excel-excel-workbook-slicers-member)|Represents a collection of slicers associated with the workbook.| +||[tableStyles](/javascript/api/excel/excel.workbook#excel-excel-workbook-tablestyles-member)|Represents a collection of TableStyles associated with the workbook.| +||[timelineStyles](/javascript/api/excel/excel.workbook#excel-excel-workbook-timelinestyles-member)|Represents a collection of TimelineStyles associated with the workbook.| +|[Worksheet](/javascript/api/excel/excel.worksheet)|[comments](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-comments-member)|Returns a collection of all the Comments objects on the worksheet.| +||[onColumnSorted](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-oncolumnsorted-member)|Occurs when one or more columns have been sorted.| +||[onRowSorted](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-onrowsorted-member)|Occurs when one or more rows have been sorted.| +||[onSingleClicked](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-onsingleclicked-member)|Occurs when a left-clicked/tapped action happens in the worksheet.| +||[showOutlineLevels(rowLevels: number, columnLevels: number)](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-showoutlinelevels-member(1))|Shows row or column groups by their outline levels.| +||[slicers](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-slicers-member)|Returns a collection of slicers that are part of the worksheet.| +|[WorksheetCollection](/javascript/api/excel/excel.worksheetcollection)|[onColumnSorted](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-oncolumnsorted-member)|Occurs when one or more columns have been sorted.| +||[onRowSorted](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-onrowsorted-member)|Occurs when one or more rows have been sorted.| +||[onSingleClicked](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-onsingleclicked-member)|Occurs when left-clicked/tapped operation happens in the worksheet collection.| +|[WorksheetColumnSortedEventArgs](/javascript/api/excel/excel.worksheetcolumnsortedeventargs)|[address](/javascript/api/excel/excel.worksheetcolumnsortedeventargs#excel-excel-worksheetcolumnsortedeventargs-address-member)|Gets the range address that represents the sorted areas of a specific worksheet.| +||[source](/javascript/api/excel/excel.worksheetcolumnsortedeventargs#excel-excel-worksheetcolumnsortedeventargs-source-member)|Gets the source of the event.| +||[type](/javascript/api/excel/excel.worksheetcolumnsortedeventargs#excel-excel-worksheetcolumnsortedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/javascript/api/excel/excel.worksheetcolumnsortedeventargs#excel-excel-worksheetcolumnsortedeventargs-worksheetid-member)|Gets the ID of the worksheet where the sorting happened.| +|[WorksheetRowSortedEventArgs](/javascript/api/excel/excel.worksheetrowsortedeventargs)|[address](/javascript/api/excel/excel.worksheetrowsortedeventargs#excel-excel-worksheetrowsortedeventargs-address-member)|Gets the range address that represents the sorted areas of a specific worksheet.| +||[source](/javascript/api/excel/excel.worksheetrowsortedeventargs#excel-excel-worksheetrowsortedeventargs-source-member)|Gets the source of the event.| +||[type](/javascript/api/excel/excel.worksheetrowsortedeventargs#excel-excel-worksheetrowsortedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/javascript/api/excel/excel.worksheetrowsortedeventargs#excel-excel-worksheetrowsortedeventargs-worksheetid-member)|Gets the ID of the worksheet where the sorting happened.| +|[WorksheetSingleClickedEventArgs](/javascript/api/excel/excel.worksheetsingleclickedeventargs)|[address](/javascript/api/excel/excel.worksheetsingleclickedeventargs#excel-excel-worksheetsingleclickedeventargs-address-member)|Gets the address that represents the cell which was left-clicked/tapped for a specific worksheet.| +||[offsetX](/javascript/api/excel/excel.worksheetsingleclickedeventargs#excel-excel-worksheetsingleclickedeventargs-offsetx-member)|The distance, in points, from the left-clicked/tapped point to the left (or right for right-to-left languages) gridline edge of the left-clicked/tapped cell.| +||[offsetY](/javascript/api/excel/excel.worksheetsingleclickedeventargs#excel-excel-worksheetsingleclickedeventargs-offsety-member)|The distance, in points, from the left-clicked/tapped point to the top gridline edge of the left-clicked/tapped cell.| +||[type](/javascript/api/excel/excel.worksheetsingleclickedeventargs#excel-excel-worksheetsingleclickedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/javascript/api/excel/excel.worksheetsingleclickedeventargs#excel-excel-worksheetsingleclickedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the cell was left-clicked/tapped.| diff --git a/docs/includes/excel-1_11.md b/docs/includes/excel-1_11.md index 2e0c21cdaf..f8850e4d27 100644 --- a/docs/includes/excel-1_11.md +++ b/docs/includes/excel-1_11.md @@ -1,37 +1,37 @@ | Class | Fields | Description | |:---|:---|:---| -|[Application](/.application)|[cultureInfo](/.application#excel-javascript/api/excel/-application-cultureinfo-member)|Provides information based on current system culture settings.| -||[decimalSeparator](/.application#excel-javascript/api/excel/-application-decimalseparator-member)|Gets the string used as the decimal separator for numeric values.| -||[thousandsSeparator](/.application#excel-javascript/api/excel/-application-thousandsseparator-member)|Gets the string used to separate groups of digits to the left of the decimal for numeric values.| -||[useSystemSeparators](/.application#excel-javascript/api/excel/-application-usesystemseparators-member)|Specifies if the system separators of Excel are enabled.| -|[Comment](/.comment)|[mentions](/.comment#excel-javascript/api/excel/-comment-mentions-member)|Gets the entities (e.g., people) that are mentioned in comments.| -||[resolved](/.comment#excel-javascript/api/excel/-comment-resolved-member)|The comment thread status.| -||[richContent](/.comment#excel-javascript/api/excel/-comment-richcontent-member)|Gets the rich comment content (e.g., mentions in comments).| -||[updateMentions(contentWithMentions: Excel.CommentRichContent)](/.comment#excel-javascript/api/excel/-comment-updatementions-member(1))|Updates the comment content with a specially formatted string and a list of mentions.| -|[CommentCollection](/.commentcollection)|[add(cellAddress: Range \| string, content: CommentRichContent \| string, contentType?: Excel.ContentType)](/.commentcollection#excel-javascript/api/excel/-commentcollection-add-member(1))|Creates a new comment with the given content on the given cell.| -|[CommentMention](/.commentmention)|[email](/.commentmention#excel-javascript/api/excel/-commentmention-email-member)|The email address of the entity that is mentioned in a comment.| -||[id](/.commentmention#excel-javascript/api/excel/-commentmention-id-member)|The ID of the entity.| -||[name](/.commentmention#excel-javascript/api/excel/-commentmention-name-member)|The name of the entity that is mentioned in a comment.| -|[CommentReply](/.commentreply)|[mentions](/.commentreply#excel-javascript/api/excel/-commentreply-mentions-member)|The entities (e.g., people) that are mentioned in comments.| -||[resolved](/.commentreply#excel-javascript/api/excel/-commentreply-resolved-member)|The comment reply status.| -||[richContent](/.commentreply#excel-javascript/api/excel/-commentreply-richcontent-member)|The rich comment content (e.g., mentions in comments).| -||[updateMentions(contentWithMentions: Excel.CommentRichContent)](/.commentreply#excel-javascript/api/excel/-commentreply-updatementions-member(1))|Updates the comment content with a specially formatted string and a list of mentions.| -|[CommentReplyCollection](/.commentreplycollection)|[add(content: CommentRichContent \| string, contentType?: Excel.ContentType)](/.commentreplycollection#excel-javascript/api/excel/-commentreplycollection-add-member(1))|Creates a comment reply for a comment.| -|[CommentRichContent](/.commentrichcontent)|[mentions](/.commentrichcontent#excel-javascript/api/excel/-commentrichcontent-mentions-member)|An array containing all the entities (e.g., people) mentioned within the comment.| -||[richContent](/.commentrichcontent#excel-javascript/api/excel/-commentrichcontent-richcontent-member)|Specifies the rich content of the comment (e.g., comment content with mentions, the first mentioned entity has an ID attribute of 0, and the second mentioned entity has an ID attribute of 1).| -|[CultureInfo](/.cultureinfo)|[name](/.cultureinfo#excel-javascript/api/excel/-cultureinfo-name-member)|Gets the culture name in the format languagecode2-country/regioncode2 (e.g., "zh-cn" or "en-us").| -||[numberFormat](/.cultureinfo#excel-javascript/api/excel/-cultureinfo-numberformat-member)|Defines the culturally appropriate format of displaying numbers.| -|[NumberFormatInfo](/.numberformatinfo)|[numberDecimalSeparator](/.numberformatinfo#excel-javascript/api/excel/-numberformatinfo-numberdecimalseparator-member)|Gets the string used as the decimal separator for numeric values.| -||[numberGroupSeparator](/.numberformatinfo#excel-javascript/api/excel/-numberformatinfo-numbergroupseparator-member)|Gets the string used to separate groups of digits to the left of the decimal for numeric values.| -|[Range](/.range)|[moveTo(destinationRange: Range \| string)](/.range#excel-javascript/api/excel/-range-moveto-member(1))|Moves cell values, formatting, and formulas from current range to the destination range, replacing the old information in those cells.| -|[RangeFormat](/.rangeformat)|[adjustIndent(amount: number)](/.rangeformat#excel-javascript/api/excel/-rangeformat-adjustindent-member(1))|Adjusts the indentation of the range formatting.| -|[Workbook](/.workbook)|[close(closeBehavior?: Excel.CloseBehavior)](/.workbook#excel-javascript/api/excel/-workbook-close-member(1))|Close current workbook.| -||[save(saveBehavior?: Excel.SaveBehavior)](/.workbook#excel-javascript/api/excel/-workbook-save-member(1))|Save current workbook.| -|[Worksheet](/.worksheet)|[onRowHiddenChanged](/.worksheet#excel-javascript/api/excel/-worksheet-onrowhiddenchanged-member)|Occurs when the hidden state of one or more rows has changed on a specific worksheet.| -|[WorksheetCalculatedEventArgs](/.worksheetcalculatedeventargs)|[address](/.worksheetcalculatedeventargs#excel-javascript/api/excel/-worksheetcalculatedeventargs-address-member)|The address of the range that completed calculation.| -|[WorksheetCollection](/.worksheetcollection)|[onRowHiddenChanged](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-onrowhiddenchanged-member)|Occurs when the hidden state of one or more rows has changed on a specific worksheet.| -|[WorksheetRowHiddenChangedEventArgs](/.worksheetrowhiddenchangedeventargs)|[address](/.worksheetrowhiddenchangedeventargs#excel-javascript/api/excel/-worksheetrowhiddenchangedeventargs-address-member)|Gets the range address that represents the changed area of a specific worksheet.| -||[changeType](/.worksheetrowhiddenchangedeventargs#excel-javascript/api/excel/-worksheetrowhiddenchangedeventargs-changetype-member)|Gets the type of change that represents how the event was triggered.| -||[source](/.worksheetrowhiddenchangedeventargs#excel-javascript/api/excel/-worksheetrowhiddenchangedeventargs-source-member)|Gets the source of the event.| -||[type](/.worksheetrowhiddenchangedeventargs#excel-javascript/api/excel/-worksheetrowhiddenchangedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/.worksheetrowhiddenchangedeventargs#excel-javascript/api/excel/-worksheetrowhiddenchangedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the data changed.| +|[Application](/javascript/api/excel/excel.application)|[cultureInfo](/javascript/api/excel/excel.application#excel-excel-application-cultureinfo-member)|Provides information based on current system culture settings.| +||[decimalSeparator](/javascript/api/excel/excel.application#excel-excel-application-decimalseparator-member)|Gets the string used as the decimal separator for numeric values.| +||[thousandsSeparator](/javascript/api/excel/excel.application#excel-excel-application-thousandsseparator-member)|Gets the string used to separate groups of digits to the left of the decimal for numeric values.| +||[useSystemSeparators](/javascript/api/excel/excel.application#excel-excel-application-usesystemseparators-member)|Specifies if the system separators of Excel are enabled.| +|[Comment](/javascript/api/excel/excel.comment)|[mentions](/javascript/api/excel/excel.comment#excel-excel-comment-mentions-member)|Gets the entities (e.g., people) that are mentioned in comments.| +||[resolved](/javascript/api/excel/excel.comment#excel-excel-comment-resolved-member)|The comment thread status.| +||[richContent](/javascript/api/excel/excel.comment#excel-excel-comment-richcontent-member)|Gets the rich comment content (e.g., mentions in comments).| +||[updateMentions(contentWithMentions: Excel.CommentRichContent)](/javascript/api/excel/excel.comment#excel-excel-comment-updatementions-member(1))|Updates the comment content with a specially formatted string and a list of mentions.| +|[CommentCollection](/javascript/api/excel/excel.commentcollection)|[add(cellAddress: Range \| string, content: CommentRichContent \| string, contentType?: Excel.ContentType)](/javascript/api/excel/excel.commentcollection#excel-excel-commentcollection-add-member(1))|Creates a new comment with the given content on the given cell.| +|[CommentMention](/javascript/api/excel/excel.commentmention)|[email](/javascript/api/excel/excel.commentmention#excel-excel-commentmention-email-member)|The email address of the entity that is mentioned in a comment.| +||[id](/javascript/api/excel/excel.commentmention#excel-excel-commentmention-id-member)|The ID of the entity.| +||[name](/javascript/api/excel/excel.commentmention#excel-excel-commentmention-name-member)|The name of the entity that is mentioned in a comment.| +|[CommentReply](/javascript/api/excel/excel.commentreply)|[mentions](/javascript/api/excel/excel.commentreply#excel-excel-commentreply-mentions-member)|The entities (e.g., people) that are mentioned in comments.| +||[resolved](/javascript/api/excel/excel.commentreply#excel-excel-commentreply-resolved-member)|The comment reply status.| +||[richContent](/javascript/api/excel/excel.commentreply#excel-excel-commentreply-richcontent-member)|The rich comment content (e.g., mentions in comments).| +||[updateMentions(contentWithMentions: Excel.CommentRichContent)](/javascript/api/excel/excel.commentreply#excel-excel-commentreply-updatementions-member(1))|Updates the comment content with a specially formatted string and a list of mentions.| +|[CommentReplyCollection](/javascript/api/excel/excel.commentreplycollection)|[add(content: CommentRichContent \| string, contentType?: Excel.ContentType)](/javascript/api/excel/excel.commentreplycollection#excel-excel-commentreplycollection-add-member(1))|Creates a comment reply for a comment.| +|[CommentRichContent](/javascript/api/excel/excel.commentrichcontent)|[mentions](/javascript/api/excel/excel.commentrichcontent#excel-excel-commentrichcontent-mentions-member)|An array containing all the entities (e.g., people) mentioned within the comment.| +||[richContent](/javascript/api/excel/excel.commentrichcontent#excel-excel-commentrichcontent-richcontent-member)|Specifies the rich content of the comment (e.g., comment content with mentions, the first mentioned entity has an ID attribute of 0, and the second mentioned entity has an ID attribute of 1).| +|[CultureInfo](/javascript/api/excel/excel.cultureinfo)|[name](/javascript/api/excel/excel.cultureinfo#excel-excel-cultureinfo-name-member)|Gets the culture name in the format languagecode2-country/regioncode2 (e.g., "zh-cn" or "en-us").| +||[numberFormat](/javascript/api/excel/excel.cultureinfo#excel-excel-cultureinfo-numberformat-member)|Defines the culturally appropriate format of displaying numbers.| +|[NumberFormatInfo](/javascript/api/excel/excel.numberformatinfo)|[numberDecimalSeparator](/javascript/api/excel/excel.numberformatinfo#excel-excel-numberformatinfo-numberdecimalseparator-member)|Gets the string used as the decimal separator for numeric values.| +||[numberGroupSeparator](/javascript/api/excel/excel.numberformatinfo#excel-excel-numberformatinfo-numbergroupseparator-member)|Gets the string used to separate groups of digits to the left of the decimal for numeric values.| +|[Range](/javascript/api/excel/excel.range)|[moveTo(destinationRange: Range \| string)](/javascript/api/excel/excel.range#excel-excel-range-moveto-member(1))|Moves cell values, formatting, and formulas from current range to the destination range, replacing the old information in those cells.| +|[RangeFormat](/javascript/api/excel/excel.rangeformat)|[adjustIndent(amount: number)](/javascript/api/excel/excel.rangeformat#excel-excel-rangeformat-adjustindent-member(1))|Adjusts the indentation of the range formatting.| +|[Workbook](/javascript/api/excel/excel.workbook)|[close(closeBehavior?: Excel.CloseBehavior)](/javascript/api/excel/excel.workbook#excel-excel-workbook-close-member(1))|Close current workbook.| +||[save(saveBehavior?: Excel.SaveBehavior)](/javascript/api/excel/excel.workbook#excel-excel-workbook-save-member(1))|Save current workbook.| +|[Worksheet](/javascript/api/excel/excel.worksheet)|[onRowHiddenChanged](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-onrowhiddenchanged-member)|Occurs when the hidden state of one or more rows has changed on a specific worksheet.| +|[WorksheetCalculatedEventArgs](/javascript/api/excel/excel.worksheetcalculatedeventargs)|[address](/javascript/api/excel/excel.worksheetcalculatedeventargs#excel-excel-worksheetcalculatedeventargs-address-member)|The address of the range that completed calculation.| +|[WorksheetCollection](/javascript/api/excel/excel.worksheetcollection)|[onRowHiddenChanged](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-onrowhiddenchanged-member)|Occurs when the hidden state of one or more rows has changed on a specific worksheet.| +|[WorksheetRowHiddenChangedEventArgs](/javascript/api/excel/excel.worksheetrowhiddenchangedeventargs)|[address](/javascript/api/excel/excel.worksheetrowhiddenchangedeventargs#excel-excel-worksheetrowhiddenchangedeventargs-address-member)|Gets the range address that represents the changed area of a specific worksheet.| +||[changeType](/javascript/api/excel/excel.worksheetrowhiddenchangedeventargs#excel-excel-worksheetrowhiddenchangedeventargs-changetype-member)|Gets the type of change that represents how the event was triggered.| +||[source](/javascript/api/excel/excel.worksheetrowhiddenchangedeventargs#excel-excel-worksheetrowhiddenchangedeventargs-source-member)|Gets the source of the event.| +||[type](/javascript/api/excel/excel.worksheetrowhiddenchangedeventargs#excel-excel-worksheetrowhiddenchangedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/javascript/api/excel/excel.worksheetrowhiddenchangedeventargs#excel-excel-worksheetrowhiddenchangedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the data changed.| diff --git a/docs/includes/excel-1_12.md b/docs/includes/excel-1_12.md index 826efd2c89..14790a9d21 100644 --- a/docs/includes/excel-1_12.md +++ b/docs/includes/excel-1_12.md @@ -1,92 +1,92 @@ | Class | Fields | Description | |:---|:---|:---| -|[ChartAxisTitle](/.chartaxistitle)|[textOrientation](/.chartaxistitle#excel-javascript/api/excel/-chartaxistitle-textorientation-member)|Specifies the angle to which the text is oriented for the chart axis title.| -|[ChartSeries](/.chartseries)|[getDimensionValues(dimension: Excel.ChartSeriesDimension)](/.chartseries#excel-javascript/api/excel/-chartseries-getdimensionvalues-member(1))|Gets the values from a single dimension of the chart series.| -|[Comment](/.comment)|[contentType](/.comment#excel-javascript/api/excel/-comment-contenttype-member)|Gets the content type of the comment.| -|[CommentAddedEventArgs](/.commentaddedeventargs)|[commentDetails](/.commentaddedeventargs#excel-javascript/api/excel/-commentaddedeventargs-commentdetails-member)|Gets the `CommentDetail` array that contains the comment ID and IDs of its related replies.| -||[source](/.commentaddedeventargs#excel-javascript/api/excel/-commentaddedeventargs-source-member)|Specifies the source of the event.| -||[type](/.commentaddedeventargs#excel-javascript/api/excel/-commentaddedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/.commentaddedeventargs#excel-javascript/api/excel/-commentaddedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the event happened.| -|[CommentChangedEventArgs](/.commentchangedeventargs)|[changeType](/.commentchangedeventargs#excel-javascript/api/excel/-commentchangedeventargs-changetype-member)|Gets the change type that represents how the changed event is triggered.| -||[commentDetails](/.commentchangedeventargs#excel-javascript/api/excel/-commentchangedeventargs-commentdetails-member)|Get the `CommentDetail` array which contains the comment ID and IDs of its related replies.| -||[source](/.commentchangedeventargs#excel-javascript/api/excel/-commentchangedeventargs-source-member)|Specifies the source of the event.| -||[type](/.commentchangedeventargs#excel-javascript/api/excel/-commentchangedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/.commentchangedeventargs#excel-javascript/api/excel/-commentchangedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the event happened.| -|[CommentCollection](/.commentcollection)|[onAdded](/.commentcollection#excel-javascript/api/excel/-commentcollection-onadded-member)|Occurs when the comments are added.| -||[onChanged](/.commentcollection#excel-javascript/api/excel/-commentcollection-onchanged-member)|Occurs when comments or replies in a comment collection are changed, including when replies are deleted.| -||[onDeleted](/.commentcollection#excel-javascript/api/excel/-commentcollection-ondeleted-member)|Occurs when comments are deleted in the comment collection.| -|[CommentDeletedEventArgs](/.commentdeletedeventargs)|[commentDetails](/.commentdeletedeventargs#excel-javascript/api/excel/-commentdeletedeventargs-commentdetails-member)|Gets the `CommentDetail` array that contains the comment ID and IDs of its related replies.| -||[source](/.commentdeletedeventargs#excel-javascript/api/excel/-commentdeletedeventargs-source-member)|Specifies the source of the event.| -||[type](/.commentdeletedeventargs#excel-javascript/api/excel/-commentdeletedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/.commentdeletedeventargs#excel-javascript/api/excel/-commentdeletedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the event happened.| -|[CommentDetail](/.commentdetail)|[commentId](/.commentdetail#excel-javascript/api/excel/-commentdetail-commentid-member)|Represents the ID of the comment.| -||[replyIds](/.commentdetail#excel-javascript/api/excel/-commentdetail-replyids-member)|Represents the IDs of the related replies that belong to the comment.| -|[CommentReply](/.commentreply)|[contentType](/.commentreply#excel-javascript/api/excel/-commentreply-contenttype-member)|The content type of the reply.| -|[CultureInfo](/.cultureinfo)|[datetimeFormat](/.cultureinfo#excel-javascript/api/excel/-cultureinfo-datetimeformat-member)|Defines the culturally appropriate format of displaying date and time.| -|[DatetimeFormatInfo](/.datetimeformatinfo)|[dateSeparator](/.datetimeformatinfo#excel-javascript/api/excel/-datetimeformatinfo-dateseparator-member)|Gets the string used as the date separator.| -||[longDatePattern](/.datetimeformatinfo#excel-javascript/api/excel/-datetimeformatinfo-longdatepattern-member)|Gets the format string for a long date value.| -||[longTimePattern](/.datetimeformatinfo#excel-javascript/api/excel/-datetimeformatinfo-longtimepattern-member)|Gets the format string for a long time value.| -||[shortDatePattern](/.datetimeformatinfo#excel-javascript/api/excel/-datetimeformatinfo-shortdatepattern-member)|Gets the format string for a short date value.| -||[timeSeparator](/.datetimeformatinfo#excel-javascript/api/excel/-datetimeformatinfo-timeseparator-member)|Gets the string used as the time separator.| -|[PivotDateFilter](/.pivotdatefilter)|[comparator](/.pivotdatefilter#excel-javascript/api/excel/-pivotdatefilter-comparator-member)|The comparator is the static value to which other values are compared.| -||[condition](/.pivotdatefilter#excel-javascript/api/excel/-pivotdatefilter-condition-member)|Specifies the condition for the filter, which defines the necessary filtering criteria.| -||[exclusive](/.pivotdatefilter#excel-javascript/api/excel/-pivotdatefilter-exclusive-member)|If `true`, filter *excludes* items that meet criteria.| -||[lowerBound](/.pivotdatefilter#excel-javascript/api/excel/-pivotdatefilter-lowerbound-member)|The lower-bound of the range for the `between` filter condition.| -||[upperBound](/.pivotdatefilter#excel-javascript/api/excel/-pivotdatefilter-upperbound-member)|The upper-bound of the range for the `between` filter condition.| -||[wholeDays](/.pivotdatefilter#excel-javascript/api/excel/-pivotdatefilter-wholedays-member)|For `equals`, `before`, `after`, and `between` filter conditions, indicates if comparisons should be made as whole days.| -|[PivotField](/.pivotfield)|[applyFilter(filter: Excel.PivotFilters)](/.pivotfield#excel-javascript/api/excel/-pivotfield-applyfilter-member(1))|Sets one or more of the field's current PivotFilters and applies them to the field.| -||[clearAllFilters()](/.pivotfield#excel-javascript/api/excel/-pivotfield-clearallfilters-member(1))|Clears all criteria from all of the field's filters.| -||[clearFilter(filterType: Excel.PivotFilterType)](/.pivotfield#excel-javascript/api/excel/-pivotfield-clearfilter-member(1))|Clears all existing criteria from the field's filter of the given type (if one is currently applied).| -||[getFilters()](/.pivotfield#excel-javascript/api/excel/-pivotfield-getfilters-member(1))|Gets all filters currently applied on the field.| -||[isFiltered(filterType?: Excel.PivotFilterType)](/.pivotfield#excel-javascript/api/excel/-pivotfield-isfiltered-member(1))|Checks if there are any applied filters on the field.| -|[PivotFilters](/.pivotfilters)|[dateFilter](/.pivotfilters#excel-javascript/api/excel/-pivotfilters-datefilter-member)|The PivotField's currently applied date filter.| -||[labelFilter](/.pivotfilters#excel-javascript/api/excel/-pivotfilters-labelfilter-member)|The PivotField's currently applied label filter.| -||[manualFilter](/.pivotfilters#excel-javascript/api/excel/-pivotfilters-manualfilter-member)|The PivotField's currently applied manual filter.| -||[valueFilter](/.pivotfilters#excel-javascript/api/excel/-pivotfilters-valuefilter-member)|The PivotField's currently applied value filter.| -|[PivotLabelFilter](/.pivotlabelfilter)|[comparator](/.pivotlabelfilter#excel-javascript/api/excel/-pivotlabelfilter-comparator-member)|The comparator is the static value to which other values are compared.| -||[condition](/.pivotlabelfilter#excel-javascript/api/excel/-pivotlabelfilter-condition-member)|Specifies the condition for the filter, which defines the necessary filtering criteria.| -||[exclusive](/.pivotlabelfilter#excel-javascript/api/excel/-pivotlabelfilter-exclusive-member)|If `true`, filter *excludes* items that meet criteria.| -||[lowerBound](/.pivotlabelfilter#excel-javascript/api/excel/-pivotlabelfilter-lowerbound-member)|The lower-bound of the range for the `between` filter condition.| -||[substring](/.pivotlabelfilter#excel-javascript/api/excel/-pivotlabelfilter-substring-member)|The substring used for the `beginsWith`, `endsWith`, and `contains` filter conditions.| -||[upperBound](/.pivotlabelfilter#excel-javascript/api/excel/-pivotlabelfilter-upperbound-member)|The upper-bound of the range for the `between` filter condition.| -|[PivotManualFilter](/.pivotmanualfilter)|[selectedItems](/.pivotmanualfilter#excel-javascript/api/excel/-pivotmanualfilter-selecteditems-member)|A list of selected items to manually filter.| -|[PivotTable](/.pivottable)|[allowMultipleFiltersPerField](/.pivottable#excel-javascript/api/excel/-pivottable-allowmultiplefiltersperfield-member)|Specifies if the PivotTable allows the application of multiple PivotFilters on a given PivotField in the table.| -|[PivotTableScopedCollection](/.pivottablescopedcollection)|[getCount()](/.pivottablescopedcollection#excel-javascript/api/excel/-pivottablescopedcollection-getcount-member(1))|Gets the number of PivotTables in the collection.| -||[getFirst()](/.pivottablescopedcollection#excel-javascript/api/excel/-pivottablescopedcollection-getfirst-member(1))|Gets the first PivotTable in the collection.| -||[getItem(key: string)](/.pivottablescopedcollection#excel-javascript/api/excel/-pivottablescopedcollection-getitem-member(1))|Gets a PivotTable by name.| -||[getItemOrNullObject(name: string)](/.pivottablescopedcollection#excel-javascript/api/excel/-pivottablescopedcollection-getitemornullobject-member(1))|Gets a PivotTable by name.| -||[items](/.pivottablescopedcollection#excel-javascript/api/excel/-pivottablescopedcollection-items-member)|Gets the loaded child items in this collection.| -|[PivotValueFilter](/.pivotvaluefilter)|[comparator](/.pivotvaluefilter#excel-javascript/api/excel/-pivotvaluefilter-comparator-member)|The comparator is the static value to which other values are compared.| -||[condition](/.pivotvaluefilter#excel-javascript/api/excel/-pivotvaluefilter-condition-member)|Specifies the condition for the filter, which defines the necessary filtering criteria.| -||[exclusive](/.pivotvaluefilter#excel-javascript/api/excel/-pivotvaluefilter-exclusive-member)|If `true`, filter *excludes* items that meet criteria.| -||[lowerBound](/.pivotvaluefilter#excel-javascript/api/excel/-pivotvaluefilter-lowerbound-member)|The lower-bound of the range for the `between` filter condition.| -||[selectionType](/.pivotvaluefilter#excel-javascript/api/excel/-pivotvaluefilter-selectiontype-member)|Specifies if the filter is for the top/bottom N items, top/bottom N percent, or top/bottom N sum.| -||[threshold](/.pivotvaluefilter#excel-javascript/api/excel/-pivotvaluefilter-threshold-member)|The "N" threshold number of items, percent, or sum to be filtered for a top/bottom filter condition.| -||[upperBound](/.pivotvaluefilter#excel-javascript/api/excel/-pivotvaluefilter-upperbound-member)|The upper-bound of the range for the `between` filter condition.| -||[value](/.pivotvaluefilter#excel-javascript/api/excel/-pivotvaluefilter-value-member)|Name of the chosen "value" in the field by which to filter.| -|[Range](/.range)|[getDirectPrecedents()](/.range#excel-javascript/api/excel/-range-getdirectprecedents-member(1))|Returns a `WorkbookRangeAreas` object that represents the range containing all the direct precedent cells of a specified range in the same worksheet or across multiple worksheets.| -||[getPivotTables(fullyContained?: boolean)](/.range#excel-javascript/api/excel/-range-getpivottables-member(1))|Gets a scoped collection of PivotTables that overlap with the range.| -||[getSpillParent()](/.range#excel-javascript/api/excel/-range-getspillparent-member(1))|Gets the range object containing the anchor cell for a cell getting spilled into.| -||[getSpillParentOrNullObject()](/.range#excel-javascript/api/excel/-range-getspillparentornullobject-member(1))|Gets the range object containing the anchor cell for the cell getting spilled into.| -||[getSpillingToRange()](/.range#excel-javascript/api/excel/-range-getspillingtorange-member(1))|Gets the range object containing the spill range when called on an anchor cell.| -||[getSpillingToRangeOrNullObject()](/.range#excel-javascript/api/excel/-range-getspillingtorangeornullobject-member(1))|Gets the range object containing the spill range when called on an anchor cell.| -||[hasSpill](/.range#excel-javascript/api/excel/-range-hasspill-member)|Represents if all cells have a spill border.| -||[numberFormatCategories](/.range#excel-javascript/api/excel/-range-numberformatcategories-member)|Represents the category of number format of each cell.| -||[savedAsArray](/.range#excel-javascript/api/excel/-range-savedasarray-member)|Represents if all the cells would be saved as an array formula.| -|[RangeAreasCollection](/.rangeareascollection)|[getCount()](/.rangeareascollection#excel-javascript/api/excel/-rangeareascollection-getcount-member(1))|Gets the number of `RangeAreas` objects in this collection.| -||[getItemAt(index: number)](/.rangeareascollection#excel-javascript/api/excel/-rangeareascollection-getitemat-member(1))|Returns the `RangeAreas` object based on position in the collection.| -||[items](/.rangeareascollection#excel-javascript/api/excel/-rangeareascollection-items-member)|Gets the loaded child items in this collection.| -|[WorkbookRangeAreas](/.workbookrangeareas)|[addresses](/.workbookrangeareas#excel-javascript/api/excel/-workbookrangeareas-addresses-member)|Returns an array of addresses in A1-style.| -||[areas](/.workbookrangeareas#excel-javascript/api/excel/-workbookrangeareas-areas-member)|Returns the `RangeAreasCollection` object.| -||[getRangeAreasBySheet(key: string)](/.workbookrangeareas#excel-javascript/api/excel/-workbookrangeareas-getrangeareasbysheet-member(1))|Returns the `RangeAreas` object based on worksheet ID or name in the collection.| -||[getRangeAreasOrNullObjectBySheet(key: string)](/.workbookrangeareas#excel-javascript/api/excel/-workbookrangeareas-getrangeareasornullobjectbysheet-member(1))|Returns the `RangeAreas` object based on worksheet name or ID in the collection.| -||[ranges](/.workbookrangeareas#excel-javascript/api/excel/-workbookrangeareas-ranges-member)|Returns ranges that comprise this object in a `RangeCollection` object.| -|[Worksheet](/.worksheet)|[customProperties](/.worksheet#excel-javascript/api/excel/-worksheet-customproperties-member)|Gets a collection of worksheet-level custom properties.| -|[WorksheetCustomProperty](/.worksheetcustomproperty)|[delete()](/.worksheetcustomproperty#excel-javascript/api/excel/-worksheetcustomproperty-delete-member(1))|Deletes the custom property.| -||[key](/.worksheetcustomproperty#excel-javascript/api/excel/-worksheetcustomproperty-key-member)|Gets the key of the custom property.| -||[value](/.worksheetcustomproperty#excel-javascript/api/excel/-worksheetcustomproperty-value-member)|Gets or sets the value of the custom property.| -|[WorksheetCustomPropertyCollection](/.worksheetcustompropertycollection)|[add(key: string, value: string)](/.worksheetcustompropertycollection#excel-javascript/api/excel/-worksheetcustompropertycollection-add-member(1))|Adds a new custom property that maps to the provided key.| -||[getCount()](/.worksheetcustompropertycollection#excel-javascript/api/excel/-worksheetcustompropertycollection-getcount-member(1))|Gets the number of custom properties on this worksheet.| -||[getItem(key: string)](/.worksheetcustompropertycollection#excel-javascript/api/excel/-worksheetcustompropertycollection-getitem-member(1))|Gets a custom property object by its key, which is case-insensitive.| -||[getItemOrNullObject(key: string)](/.worksheetcustompropertycollection#excel-javascript/api/excel/-worksheetcustompropertycollection-getitemornullobject-member(1))|Gets a custom property object by its key, which is case-insensitive.| -||[items](/.worksheetcustompropertycollection#excel-javascript/api/excel/-worksheetcustompropertycollection-items-member)|Gets the loaded child items in this collection.| +|[ChartAxisTitle](/javascript/api/excel/excel.chartaxistitle)|[textOrientation](/javascript/api/excel/excel.chartaxistitle#excel-excel-chartaxistitle-textorientation-member)|Specifies the angle to which the text is oriented for the chart axis title.| +|[ChartSeries](/javascript/api/excel/excel.chartseries)|[getDimensionValues(dimension: Excel.ChartSeriesDimension)](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-getdimensionvalues-member(1))|Gets the values from a single dimension of the chart series.| +|[Comment](/javascript/api/excel/excel.comment)|[contentType](/javascript/api/excel/excel.comment#excel-excel-comment-contenttype-member)|Gets the content type of the comment.| +|[CommentAddedEventArgs](/javascript/api/excel/excel.commentaddedeventargs)|[commentDetails](/javascript/api/excel/excel.commentaddedeventargs#excel-excel-commentaddedeventargs-commentdetails-member)|Gets the `CommentDetail` array that contains the comment ID and IDs of its related replies.| +||[source](/javascript/api/excel/excel.commentaddedeventargs#excel-excel-commentaddedeventargs-source-member)|Specifies the source of the event.| +||[type](/javascript/api/excel/excel.commentaddedeventargs#excel-excel-commentaddedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/javascript/api/excel/excel.commentaddedeventargs#excel-excel-commentaddedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the event happened.| +|[CommentChangedEventArgs](/javascript/api/excel/excel.commentchangedeventargs)|[changeType](/javascript/api/excel/excel.commentchangedeventargs#excel-excel-commentchangedeventargs-changetype-member)|Gets the change type that represents how the changed event is triggered.| +||[commentDetails](/javascript/api/excel/excel.commentchangedeventargs#excel-excel-commentchangedeventargs-commentdetails-member)|Get the `CommentDetail` array which contains the comment ID and IDs of its related replies.| +||[source](/javascript/api/excel/excel.commentchangedeventargs#excel-excel-commentchangedeventargs-source-member)|Specifies the source of the event.| +||[type](/javascript/api/excel/excel.commentchangedeventargs#excel-excel-commentchangedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/javascript/api/excel/excel.commentchangedeventargs#excel-excel-commentchangedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the event happened.| +|[CommentCollection](/javascript/api/excel/excel.commentcollection)|[onAdded](/javascript/api/excel/excel.commentcollection#excel-excel-commentcollection-onadded-member)|Occurs when the comments are added.| +||[onChanged](/javascript/api/excel/excel.commentcollection#excel-excel-commentcollection-onchanged-member)|Occurs when comments or replies in a comment collection are changed, including when replies are deleted.| +||[onDeleted](/javascript/api/excel/excel.commentcollection#excel-excel-commentcollection-ondeleted-member)|Occurs when comments are deleted in the comment collection.| +|[CommentDeletedEventArgs](/javascript/api/excel/excel.commentdeletedeventargs)|[commentDetails](/javascript/api/excel/excel.commentdeletedeventargs#excel-excel-commentdeletedeventargs-commentdetails-member)|Gets the `CommentDetail` array that contains the comment ID and IDs of its related replies.| +||[source](/javascript/api/excel/excel.commentdeletedeventargs#excel-excel-commentdeletedeventargs-source-member)|Specifies the source of the event.| +||[type](/javascript/api/excel/excel.commentdeletedeventargs#excel-excel-commentdeletedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/javascript/api/excel/excel.commentdeletedeventargs#excel-excel-commentdeletedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the event happened.| +|[CommentDetail](/javascript/api/excel/excel.commentdetail)|[commentId](/javascript/api/excel/excel.commentdetail#excel-excel-commentdetail-commentid-member)|Represents the ID of the comment.| +||[replyIds](/javascript/api/excel/excel.commentdetail#excel-excel-commentdetail-replyids-member)|Represents the IDs of the related replies that belong to the comment.| +|[CommentReply](/javascript/api/excel/excel.commentreply)|[contentType](/javascript/api/excel/excel.commentreply#excel-excel-commentreply-contenttype-member)|The content type of the reply.| +|[CultureInfo](/javascript/api/excel/excel.cultureinfo)|[datetimeFormat](/javascript/api/excel/excel.cultureinfo#excel-excel-cultureinfo-datetimeformat-member)|Defines the culturally appropriate format of displaying date and time.| +|[DatetimeFormatInfo](/javascript/api/excel/excel.datetimeformatinfo)|[dateSeparator](/javascript/api/excel/excel.datetimeformatinfo#excel-excel-datetimeformatinfo-dateseparator-member)|Gets the string used as the date separator.| +||[longDatePattern](/javascript/api/excel/excel.datetimeformatinfo#excel-excel-datetimeformatinfo-longdatepattern-member)|Gets the format string for a long date value.| +||[longTimePattern](/javascript/api/excel/excel.datetimeformatinfo#excel-excel-datetimeformatinfo-longtimepattern-member)|Gets the format string for a long time value.| +||[shortDatePattern](/javascript/api/excel/excel.datetimeformatinfo#excel-excel-datetimeformatinfo-shortdatepattern-member)|Gets the format string for a short date value.| +||[timeSeparator](/javascript/api/excel/excel.datetimeformatinfo#excel-excel-datetimeformatinfo-timeseparator-member)|Gets the string used as the time separator.| +|[PivotDateFilter](/javascript/api/excel/excel.pivotdatefilter)|[comparator](/javascript/api/excel/excel.pivotdatefilter#excel-excel-pivotdatefilter-comparator-member)|The comparator is the static value to which other values are compared.| +||[condition](/javascript/api/excel/excel.pivotdatefilter#excel-excel-pivotdatefilter-condition-member)|Specifies the condition for the filter, which defines the necessary filtering criteria.| +||[exclusive](/javascript/api/excel/excel.pivotdatefilter#excel-excel-pivotdatefilter-exclusive-member)|If `true`, filter *excludes* items that meet criteria.| +||[lowerBound](/javascript/api/excel/excel.pivotdatefilter#excel-excel-pivotdatefilter-lowerbound-member)|The lower-bound of the range for the `between` filter condition.| +||[upperBound](/javascript/api/excel/excel.pivotdatefilter#excel-excel-pivotdatefilter-upperbound-member)|The upper-bound of the range for the `between` filter condition.| +||[wholeDays](/javascript/api/excel/excel.pivotdatefilter#excel-excel-pivotdatefilter-wholedays-member)|For `equals`, `before`, `after`, and `between` filter conditions, indicates if comparisons should be made as whole days.| +|[PivotField](/javascript/api/excel/excel.pivotfield)|[applyFilter(filter: Excel.PivotFilters)](/javascript/api/excel/excel.pivotfield#excel-excel-pivotfield-applyfilter-member(1))|Sets one or more of the field's current PivotFilters and applies them to the field.| +||[clearAllFilters()](/javascript/api/excel/excel.pivotfield#excel-excel-pivotfield-clearallfilters-member(1))|Clears all criteria from all of the field's filters.| +||[clearFilter(filterType: Excel.PivotFilterType)](/javascript/api/excel/excel.pivotfield#excel-excel-pivotfield-clearfilter-member(1))|Clears all existing criteria from the field's filter of the given type (if one is currently applied).| +||[getFilters()](/javascript/api/excel/excel.pivotfield#excel-excel-pivotfield-getfilters-member(1))|Gets all filters currently applied on the field.| +||[isFiltered(filterType?: Excel.PivotFilterType)](/javascript/api/excel/excel.pivotfield#excel-excel-pivotfield-isfiltered-member(1))|Checks if there are any applied filters on the field.| +|[PivotFilters](/javascript/api/excel/excel.pivotfilters)|[dateFilter](/javascript/api/excel/excel.pivotfilters#excel-excel-pivotfilters-datefilter-member)|The PivotField's currently applied date filter.| +||[labelFilter](/javascript/api/excel/excel.pivotfilters#excel-excel-pivotfilters-labelfilter-member)|The PivotField's currently applied label filter.| +||[manualFilter](/javascript/api/excel/excel.pivotfilters#excel-excel-pivotfilters-manualfilter-member)|The PivotField's currently applied manual filter.| +||[valueFilter](/javascript/api/excel/excel.pivotfilters#excel-excel-pivotfilters-valuefilter-member)|The PivotField's currently applied value filter.| +|[PivotLabelFilter](/javascript/api/excel/excel.pivotlabelfilter)|[comparator](/javascript/api/excel/excel.pivotlabelfilter#excel-excel-pivotlabelfilter-comparator-member)|The comparator is the static value to which other values are compared.| +||[condition](/javascript/api/excel/excel.pivotlabelfilter#excel-excel-pivotlabelfilter-condition-member)|Specifies the condition for the filter, which defines the necessary filtering criteria.| +||[exclusive](/javascript/api/excel/excel.pivotlabelfilter#excel-excel-pivotlabelfilter-exclusive-member)|If `true`, filter *excludes* items that meet criteria.| +||[lowerBound](/javascript/api/excel/excel.pivotlabelfilter#excel-excel-pivotlabelfilter-lowerbound-member)|The lower-bound of the range for the `between` filter condition.| +||[substring](/javascript/api/excel/excel.pivotlabelfilter#excel-excel-pivotlabelfilter-substring-member)|The substring used for the `beginsWith`, `endsWith`, and `contains` filter conditions.| +||[upperBound](/javascript/api/excel/excel.pivotlabelfilter#excel-excel-pivotlabelfilter-upperbound-member)|The upper-bound of the range for the `between` filter condition.| +|[PivotManualFilter](/javascript/api/excel/excel.pivotmanualfilter)|[selectedItems](/javascript/api/excel/excel.pivotmanualfilter#excel-excel-pivotmanualfilter-selecteditems-member)|A list of selected items to manually filter.| +|[PivotTable](/javascript/api/excel/excel.pivottable)|[allowMultipleFiltersPerField](/javascript/api/excel/excel.pivottable#excel-excel-pivottable-allowmultiplefiltersperfield-member)|Specifies if the PivotTable allows the application of multiple PivotFilters on a given PivotField in the table.| +|[PivotTableScopedCollection](/javascript/api/excel/excel.pivottablescopedcollection)|[getCount()](/javascript/api/excel/excel.pivottablescopedcollection#excel-excel-pivottablescopedcollection-getcount-member(1))|Gets the number of PivotTables in the collection.| +||[getFirst()](/javascript/api/excel/excel.pivottablescopedcollection#excel-excel-pivottablescopedcollection-getfirst-member(1))|Gets the first PivotTable in the collection.| +||[getItem(key: string)](/javascript/api/excel/excel.pivottablescopedcollection#excel-excel-pivottablescopedcollection-getitem-member(1))|Gets a PivotTable by name.| +||[getItemOrNullObject(name: string)](/javascript/api/excel/excel.pivottablescopedcollection#excel-excel-pivottablescopedcollection-getitemornullobject-member(1))|Gets a PivotTable by name.| +||[items](/javascript/api/excel/excel.pivottablescopedcollection#excel-excel-pivottablescopedcollection-items-member)|Gets the loaded child items in this collection.| +|[PivotValueFilter](/javascript/api/excel/excel.pivotvaluefilter)|[comparator](/javascript/api/excel/excel.pivotvaluefilter#excel-excel-pivotvaluefilter-comparator-member)|The comparator is the static value to which other values are compared.| +||[condition](/javascript/api/excel/excel.pivotvaluefilter#excel-excel-pivotvaluefilter-condition-member)|Specifies the condition for the filter, which defines the necessary filtering criteria.| +||[exclusive](/javascript/api/excel/excel.pivotvaluefilter#excel-excel-pivotvaluefilter-exclusive-member)|If `true`, filter *excludes* items that meet criteria.| +||[lowerBound](/javascript/api/excel/excel.pivotvaluefilter#excel-excel-pivotvaluefilter-lowerbound-member)|The lower-bound of the range for the `between` filter condition.| +||[selectionType](/javascript/api/excel/excel.pivotvaluefilter#excel-excel-pivotvaluefilter-selectiontype-member)|Specifies if the filter is for the top/bottom N items, top/bottom N percent, or top/bottom N sum.| +||[threshold](/javascript/api/excel/excel.pivotvaluefilter#excel-excel-pivotvaluefilter-threshold-member)|The "N" threshold number of items, percent, or sum to be filtered for a top/bottom filter condition.| +||[upperBound](/javascript/api/excel/excel.pivotvaluefilter#excel-excel-pivotvaluefilter-upperbound-member)|The upper-bound of the range for the `between` filter condition.| +||[value](/javascript/api/excel/excel.pivotvaluefilter#excel-excel-pivotvaluefilter-value-member)|Name of the chosen "value" in the field by which to filter.| +|[Range](/javascript/api/excel/excel.range)|[getDirectPrecedents()](/javascript/api/excel/excel.range#excel-excel-range-getdirectprecedents-member(1))|Returns a `WorkbookRangeAreas` object that represents the range containing all the direct precedent cells of a specified range in the same worksheet or across multiple worksheets.| +||[getPivotTables(fullyContained?: boolean)](/javascript/api/excel/excel.range#excel-excel-range-getpivottables-member(1))|Gets a scoped collection of PivotTables that overlap with the range.| +||[getSpillParent()](/javascript/api/excel/excel.range#excel-excel-range-getspillparent-member(1))|Gets the range object containing the anchor cell for a cell getting spilled into.| +||[getSpillParentOrNullObject()](/javascript/api/excel/excel.range#excel-excel-range-getspillparentornullobject-member(1))|Gets the range object containing the anchor cell for the cell getting spilled into.| +||[getSpillingToRange()](/javascript/api/excel/excel.range#excel-excel-range-getspillingtorange-member(1))|Gets the range object containing the spill range when called on an anchor cell.| +||[getSpillingToRangeOrNullObject()](/javascript/api/excel/excel.range#excel-excel-range-getspillingtorangeornullobject-member(1))|Gets the range object containing the spill range when called on an anchor cell.| +||[hasSpill](/javascript/api/excel/excel.range#excel-excel-range-hasspill-member)|Represents if all cells have a spill border.| +||[numberFormatCategories](/javascript/api/excel/excel.range#excel-excel-range-numberformatcategories-member)|Represents the category of number format of each cell.| +||[savedAsArray](/javascript/api/excel/excel.range#excel-excel-range-savedasarray-member)|Represents if all the cells would be saved as an array formula.| +|[RangeAreasCollection](/javascript/api/excel/excel.rangeareascollection)|[getCount()](/javascript/api/excel/excel.rangeareascollection#excel-excel-rangeareascollection-getcount-member(1))|Gets the number of `RangeAreas` objects in this collection.| +||[getItemAt(index: number)](/javascript/api/excel/excel.rangeareascollection#excel-excel-rangeareascollection-getitemat-member(1))|Returns the `RangeAreas` object based on position in the collection.| +||[items](/javascript/api/excel/excel.rangeareascollection#excel-excel-rangeareascollection-items-member)|Gets the loaded child items in this collection.| +|[WorkbookRangeAreas](/javascript/api/excel/excel.workbookrangeareas)|[addresses](/javascript/api/excel/excel.workbookrangeareas#excel-excel-workbookrangeareas-addresses-member)|Returns an array of addresses in A1-style.| +||[areas](/javascript/api/excel/excel.workbookrangeareas#excel-excel-workbookrangeareas-areas-member)|Returns the `RangeAreasCollection` object.| +||[getRangeAreasBySheet(key: string)](/javascript/api/excel/excel.workbookrangeareas#excel-excel-workbookrangeareas-getrangeareasbysheet-member(1))|Returns the `RangeAreas` object based on worksheet ID or name in the collection.| +||[getRangeAreasOrNullObjectBySheet(key: string)](/javascript/api/excel/excel.workbookrangeareas#excel-excel-workbookrangeareas-getrangeareasornullobjectbysheet-member(1))|Returns the `RangeAreas` object based on worksheet name or ID in the collection.| +||[ranges](/javascript/api/excel/excel.workbookrangeareas#excel-excel-workbookrangeareas-ranges-member)|Returns ranges that comprise this object in a `RangeCollection` object.| +|[Worksheet](/javascript/api/excel/excel.worksheet)|[customProperties](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-customproperties-member)|Gets a collection of worksheet-level custom properties.| +|[WorksheetCustomProperty](/javascript/api/excel/excel.worksheetcustomproperty)|[delete()](/javascript/api/excel/excel.worksheetcustomproperty#excel-excel-worksheetcustomproperty-delete-member(1))|Deletes the custom property.| +||[key](/javascript/api/excel/excel.worksheetcustomproperty#excel-excel-worksheetcustomproperty-key-member)|Gets the key of the custom property.| +||[value](/javascript/api/excel/excel.worksheetcustomproperty#excel-excel-worksheetcustomproperty-value-member)|Gets or sets the value of the custom property.| +|[WorksheetCustomPropertyCollection](/javascript/api/excel/excel.worksheetcustompropertycollection)|[add(key: string, value: string)](/javascript/api/excel/excel.worksheetcustompropertycollection#excel-excel-worksheetcustompropertycollection-add-member(1))|Adds a new custom property that maps to the provided key.| +||[getCount()](/javascript/api/excel/excel.worksheetcustompropertycollection#excel-excel-worksheetcustompropertycollection-getcount-member(1))|Gets the number of custom properties on this worksheet.| +||[getItem(key: string)](/javascript/api/excel/excel.worksheetcustompropertycollection#excel-excel-worksheetcustompropertycollection-getitem-member(1))|Gets a custom property object by its key, which is case-insensitive.| +||[getItemOrNullObject(key: string)](/javascript/api/excel/excel.worksheetcustompropertycollection#excel-excel-worksheetcustompropertycollection-getitemornullobject-member(1))|Gets a custom property object by its key, which is case-insensitive.| +||[items](/javascript/api/excel/excel.worksheetcustompropertycollection#excel-excel-worksheetcustompropertycollection-items-member)|Gets the loaded child items in this collection.| diff --git a/docs/includes/excel-1_13.md b/docs/includes/excel-1_13.md index 9d6932a571..f904b101b9 100644 --- a/docs/includes/excel-1_13.md +++ b/docs/includes/excel-1_13.md @@ -1,29 +1,29 @@ | Class | Fields | Description | |:---|:---|:---| -|[FormulaChangedEventDetail](/.formulachangedeventdetail)|[cellAddress](/.formulachangedeventdetail#excel-javascript/api/excel/-formulachangedeventdetail-celladdress-member)|The address of the cell that contains the changed formula.| -||[previousFormula](/.formulachangedeventdetail#excel-javascript/api/excel/-formulachangedeventdetail-previousformula-member)|Represents the previous formula, before it was changed.| -|[InsertWorksheetOptions](/.insertworksheetoptions)|[positionType](/.insertworksheetoptions#excel-javascript/api/excel/-insertworksheetoptions-positiontype-member)|The insert position, in the current workbook, of the new worksheets.| -||[relativeTo](/.insertworksheetoptions#excel-javascript/api/excel/-insertworksheetoptions-relativeto-member)|The worksheet in the current workbook that is referenced for the `WorksheetPositionType` parameter.| -||[sheetNamesToInsert](/.insertworksheetoptions#excel-javascript/api/excel/-insertworksheetoptions-sheetnamestoinsert-member)|The names of individual worksheets to insert.| -|[PivotLayout](/.pivotlayout)|[altTextDescription](/.pivotlayout#excel-javascript/api/excel/-pivotlayout-alttextdescription-member)|The alt text description of the PivotTable.| -||[altTextTitle](/.pivotlayout#excel-javascript/api/excel/-pivotlayout-alttexttitle-member)|The alt text title of the PivotTable.| -||[displayBlankLineAfterEachItem(display: boolean)](/.pivotlayout#excel-javascript/api/excel/-pivotlayout-displayblanklineaftereachitem-member(1))|Sets whether or not to display a blank line after each item.| -||[emptyCellText](/.pivotlayout#excel-javascript/api/excel/-pivotlayout-emptycelltext-member)|The text that is automatically filled into any empty cell in the PivotTable if `fillEmptyCells == true`.| -||[fillEmptyCells](/.pivotlayout#excel-javascript/api/excel/-pivotlayout-fillemptycells-member)|Specifies whether empty cells in the PivotTable should be populated with the `emptyCellText`.| -||[repeatAllItemLabels(repeatLabels: boolean)](/.pivotlayout#excel-javascript/api/excel/-pivotlayout-repeatallitemlabels-member(1))|Sets the "repeat all item labels" setting across all fields in the PivotTable.| -||[showFieldHeaders](/.pivotlayout#excel-javascript/api/excel/-pivotlayout-showfieldheaders-member)|Specifies whether the PivotTable displays field headers (field captions and filter drop-downs).| -|[PivotTable](/.pivottable)|[refreshOnOpen](/.pivottable#excel-javascript/api/excel/-pivottable-refreshonopen-member)|Specifies whether the PivotTable refreshes when the workbook opens.| -|[Range](/.range)|[getDirectDependents()](/.range#excel-javascript/api/excel/-range-getdirectdependents-member(1))|Returns a `WorkbookRangeAreas` object that represents the range containing all the direct dependent cells of a specified range in the same worksheet or across multiple worksheets.| -||[getExtendedRange(direction: Excel.KeyboardDirection, activeCell?: Range \| string)](/.range#excel-javascript/api/excel/-range-getextendedrange-member(1))|Returns a range object that includes the current range and up to the edge of the range, based on the provided direction.| -||[getMergedAreasOrNullObject()](/.range#excel-javascript/api/excel/-range-getmergedareasornullobject-member(1))|Returns a `RangeAreas` object that represents the merged areas in this range.| -||[getRangeEdge(direction: Excel.KeyboardDirection, activeCell?: Range \| string)](/.range#excel-javascript/api/excel/-range-getrangeedge-member(1))|Returns a range object that is the edge cell of the data region that corresponds to the provided direction.| -|[Table](/.table)|[resize(newRange: Range \| string)](/.table#excel-javascript/api/excel/-table-resize-member(1))|Resize the table to the new range.| -|[Workbook](/.workbook)|[insertWorksheetsFromBase64(base64File: string, options?: Excel.InsertWorksheetOptions)](/.workbook#excel-javascript/api/excel/-workbook-insertworksheetsfrombase64-member(1))|Inserts the specified worksheets from a source workbook into the current workbook.| -||[onActivated](/.workbook#excel-javascript/api/excel/-workbook-onactivated-member)|Occurs when the workbook is activated.| -|[WorkbookActivatedEventArgs](/.workbookactivatedeventargs)|[type](/.workbookactivatedeventargs#excel-javascript/api/excel/-workbookactivatedeventargs-type-member)|Gets the type of the event.| -|[Worksheet](/.worksheet)|[onFormulaChanged](/.worksheet#excel-javascript/api/excel/-worksheet-onformulachanged-member)|Occurs when one or more formulas are changed in this worksheet.| -|[WorksheetCollection](/.worksheetcollection)|[onFormulaChanged](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-onformulachanged-member)|Occurs when one or more formulas are changed in any worksheet of this collection.| -|[WorksheetFormulaChangedEventArgs](/.worksheetformulachangedeventargs)|[formulaDetails](/.worksheetformulachangedeventargs#excel-javascript/api/excel/-worksheetformulachangedeventargs-formuladetails-member)|Gets an array of `FormulaChangedEventDetail` objects, which contain the details about the all of the changed formulas.| -||[source](/.worksheetformulachangedeventargs#excel-javascript/api/excel/-worksheetformulachangedeventargs-source-member)|The source of the event.| -||[type](/.worksheetformulachangedeventargs#excel-javascript/api/excel/-worksheetformulachangedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/.worksheetformulachangedeventargs#excel-javascript/api/excel/-worksheetformulachangedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the formula changed.| +|[FormulaChangedEventDetail](/javascript/api/excel/excel.formulachangedeventdetail)|[cellAddress](/javascript/api/excel/excel.formulachangedeventdetail#excel-excel-formulachangedeventdetail-celladdress-member)|The address of the cell that contains the changed formula.| +||[previousFormula](/javascript/api/excel/excel.formulachangedeventdetail#excel-excel-formulachangedeventdetail-previousformula-member)|Represents the previous formula, before it was changed.| +|[InsertWorksheetOptions](/javascript/api/excel/excel.insertworksheetoptions)|[positionType](/javascript/api/excel/excel.insertworksheetoptions#excel-excel-insertworksheetoptions-positiontype-member)|The insert position, in the current workbook, of the new worksheets.| +||[relativeTo](/javascript/api/excel/excel.insertworksheetoptions#excel-excel-insertworksheetoptions-relativeto-member)|The worksheet in the current workbook that is referenced for the `WorksheetPositionType` parameter.| +||[sheetNamesToInsert](/javascript/api/excel/excel.insertworksheetoptions#excel-excel-insertworksheetoptions-sheetnamestoinsert-member)|The names of individual worksheets to insert.| +|[PivotLayout](/javascript/api/excel/excel.pivotlayout)|[altTextDescription](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-alttextdescription-member)|The alt text description of the PivotTable.| +||[altTextTitle](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-alttexttitle-member)|The alt text title of the PivotTable.| +||[displayBlankLineAfterEachItem(display: boolean)](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-displayblanklineaftereachitem-member(1))|Sets whether or not to display a blank line after each item.| +||[emptyCellText](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-emptycelltext-member)|The text that is automatically filled into any empty cell in the PivotTable if `fillEmptyCells == true`.| +||[fillEmptyCells](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-fillemptycells-member)|Specifies whether empty cells in the PivotTable should be populated with the `emptyCellText`.| +||[repeatAllItemLabels(repeatLabels: boolean)](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-repeatallitemlabels-member(1))|Sets the "repeat all item labels" setting across all fields in the PivotTable.| +||[showFieldHeaders](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-showfieldheaders-member)|Specifies whether the PivotTable displays field headers (field captions and filter drop-downs).| +|[PivotTable](/javascript/api/excel/excel.pivottable)|[refreshOnOpen](/javascript/api/excel/excel.pivottable#excel-excel-pivottable-refreshonopen-member)|Specifies whether the PivotTable refreshes when the workbook opens.| +|[Range](/javascript/api/excel/excel.range)|[getDirectDependents()](/javascript/api/excel/excel.range#excel-excel-range-getdirectdependents-member(1))|Returns a `WorkbookRangeAreas` object that represents the range containing all the direct dependent cells of a specified range in the same worksheet or across multiple worksheets.| +||[getExtendedRange(direction: Excel.KeyboardDirection, activeCell?: Range \| string)](/javascript/api/excel/excel.range#excel-excel-range-getextendedrange-member(1))|Returns a range object that includes the current range and up to the edge of the range, based on the provided direction.| +||[getMergedAreasOrNullObject()](/javascript/api/excel/excel.range#excel-excel-range-getmergedareasornullobject-member(1))|Returns a `RangeAreas` object that represents the merged areas in this range.| +||[getRangeEdge(direction: Excel.KeyboardDirection, activeCell?: Range \| string)](/javascript/api/excel/excel.range#excel-excel-range-getrangeedge-member(1))|Returns a range object that is the edge cell of the data region that corresponds to the provided direction.| +|[Table](/javascript/api/excel/excel.table)|[resize(newRange: Range \| string)](/javascript/api/excel/excel.table#excel-excel-table-resize-member(1))|Resize the table to the new range.| +|[Workbook](/javascript/api/excel/excel.workbook)|[insertWorksheetsFromBase64(base64File: string, options?: Excel.InsertWorksheetOptions)](/javascript/api/excel/excel.workbook#excel-excel-workbook-insertworksheetsfrombase64-member(1))|Inserts the specified worksheets from a source workbook into the current workbook.| +||[onActivated](/javascript/api/excel/excel.workbook#excel-excel-workbook-onactivated-member)|Occurs when the workbook is activated.| +|[WorkbookActivatedEventArgs](/javascript/api/excel/excel.workbookactivatedeventargs)|[type](/javascript/api/excel/excel.workbookactivatedeventargs#excel-excel-workbookactivatedeventargs-type-member)|Gets the type of the event.| +|[Worksheet](/javascript/api/excel/excel.worksheet)|[onFormulaChanged](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-onformulachanged-member)|Occurs when one or more formulas are changed in this worksheet.| +|[WorksheetCollection](/javascript/api/excel/excel.worksheetcollection)|[onFormulaChanged](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-onformulachanged-member)|Occurs when one or more formulas are changed in any worksheet of this collection.| +|[WorksheetFormulaChangedEventArgs](/javascript/api/excel/excel.worksheetformulachangedeventargs)|[formulaDetails](/javascript/api/excel/excel.worksheetformulachangedeventargs#excel-excel-worksheetformulachangedeventargs-formuladetails-member)|Gets an array of `FormulaChangedEventDetail` objects, which contain the details about the all of the changed formulas.| +||[source](/javascript/api/excel/excel.worksheetformulachangedeventargs#excel-excel-worksheetformulachangedeventargs-source-member)|The source of the event.| +||[type](/javascript/api/excel/excel.worksheetformulachangedeventargs#excel-excel-worksheetformulachangedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/javascript/api/excel/excel.worksheetformulachangedeventargs#excel-excel-worksheetformulachangedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the formula changed.| diff --git a/docs/includes/excel-1_14.md b/docs/includes/excel-1_14.md index 4a2bbbbd64..e7b098cb31 100644 --- a/docs/includes/excel-1_14.md +++ b/docs/includes/excel-1_14.md @@ -1,43 +1,43 @@ | Class | Fields | Description | |:---|:---|:---| -|[AutoFilter](/.autofilter)|[clearColumnCriteria(columnIndex: number)](/.autofilter#excel-javascript/api/excel/-autofilter-clearcolumncriteria-member(1))|Clears the column filter criteria of the AutoFilter.| -|[ChangeDirectionState](/.changedirectionstate)|[deleteShiftDirection](/.changedirectionstate#excel-javascript/api/excel/-changedirectionstate-deleteshiftdirection-member)|Represents the direction (such as up or to the left) that the remaining cells will shift when a cell or cells are deleted.| -||[insertShiftDirection](/.changedirectionstate#excel-javascript/api/excel/-changedirectionstate-insertshiftdirection-member)|Represents the direction (such as down or to the right) that the existing cells will shift when a new cell or cells are inserted.| -|[Chart](/.chart)|[getDataTable()](/.chart#excel-javascript/api/excel/-chart-getdatatable-member(1))|Gets the data table on the chart.| -||[getDataTableOrNullObject()](/.chart#excel-javascript/api/excel/-chart-getdatatableornullobject-member(1))|Gets the data table on the chart.| -|[ChartDataTable](/.chartdatatable)|[format](/.chartdatatable#excel-javascript/api/excel/-chartdatatable-format-member)|Represents the format of a chart data table, which includes fill, font, and border format.| -||[showHorizontalBorder](/.chartdatatable#excel-javascript/api/excel/-chartdatatable-showhorizontalborder-member)|Specifies whether to display the horizontal border of the data table.| -||[showLegendKey](/.chartdatatable#excel-javascript/api/excel/-chartdatatable-showlegendkey-member)|Specifies whether to show the legend key of the data table.| -||[showOutlineBorder](/.chartdatatable#excel-javascript/api/excel/-chartdatatable-showoutlineborder-member)|Specifies whether to display the outline border of the data table.| -||[showVerticalBorder](/.chartdatatable#excel-javascript/api/excel/-chartdatatable-showverticalborder-member)|Specifies whether to display the vertical border of the data table.| -||[visible](/.chartdatatable#excel-javascript/api/excel/-chartdatatable-visible-member)|Specifies whether to show the data table of the chart.| -|[ChartDataTableFormat](/.chartdatatableformat)|[border](/.chartdatatableformat#excel-javascript/api/excel/-chartdatatableformat-border-member)|Represents the border format of chart data table, which includes color, line style, and weight.| -||[fill](/.chartdatatableformat#excel-javascript/api/excel/-chartdatatableformat-fill-member)|Represents the fill format of an object, which includes background formatting information.| -||[font](/.chartdatatableformat#excel-javascript/api/excel/-chartdatatableformat-font-member)|Represents the font attributes (such as font name, font size, and color) for the current object.| -|[CommentCollection](/.commentcollection)|[getItemOrNullObject(commentId: string)](/.commentcollection#excel-javascript/api/excel/-commentcollection-getitemornullobject-member(1))|Gets a comment from the collection based on its ID.| -|[CommentReplyCollection](/.commentreplycollection)|[getItemOrNullObject(commentReplyId: string)](/.commentreplycollection#excel-javascript/api/excel/-commentreplycollection-getitemornullobject-member(1))|Returns a comment reply identified by its ID.| -|[ConditionalFormatCollection](/.conditionalformatcollection)|[getItemOrNullObject(id: string)](/.conditionalformatcollection#excel-javascript/api/excel/-conditionalformatcollection-getitemornullobject-member(1))|Returns a conditional format identified by its ID.| -|[GroupShapeCollection](/.groupshapecollection)|[getItemOrNullObject(key: string)](/.groupshapecollection#excel-javascript/api/excel/-groupshapecollection-getitemornullobject-member(1))|Gets a shape using its name or ID.| -|[Query](/.query)|[error](/.query#excel-javascript/api/excel/-query-error-member)|Gets the query error message from when the query was last refreshed.| -||[loadedTo](/.query#excel-javascript/api/excel/-query-loadedto-member)|Gets the query loaded to object type.| -||[loadedToDataModel](/.query#excel-javascript/api/excel/-query-loadedtodatamodel-member)|Specifies if the query loaded to the data model.| -||[name](/.query#excel-javascript/api/excel/-query-name-member)|Gets the name of the query.| -||[refreshDate](/.query#excel-javascript/api/excel/-query-refreshdate-member)|Gets the date and time when the query was last refreshed.| -||[rowsLoadedCount](/.query#excel-javascript/api/excel/-query-rowsloadedcount-member)|Gets the number of rows that were loaded when the query was last refreshed.| -|[QueryCollection](/.querycollection)|[getCount()](/.querycollection#excel-javascript/api/excel/-querycollection-getcount-member(1))|Gets the number of queries in the workbook.| -||[getItem(key: string)](/.querycollection#excel-javascript/api/excel/-querycollection-getitem-member(1))|Gets a query from the collection based on its name.| -||[items](/.querycollection#excel-javascript/api/excel/-querycollection-items-member)|Gets the loaded child items in this collection.| -|[Range](/.range)|[getPrecedents()](/.range#excel-javascript/api/excel/-range-getprecedents-member(1))|Returns a `WorkbookRangeAreas` object that represents the range containing all the precedent cells of a specified range in the same worksheet or across multiple worksheets.| -|[ShapeCollection](/.shapecollection)|[getItemOrNullObject(key: string)](/.shapecollection#excel-javascript/api/excel/-shapecollection-getitemornullobject-member(1))|Gets a shape using its name or ID.| -|[StyleCollection](/.stylecollection)|[getItemOrNullObject(name: string)](/.stylecollection#excel-javascript/api/excel/-stylecollection-getitemornullobject-member(1))|Gets a style by name.| -|[TableScopedCollection](/.tablescopedcollection)|[getItemOrNullObject(key: string)](/.tablescopedcollection#excel-javascript/api/excel/-tablescopedcollection-getitemornullobject-member(1))|Gets a table by name or ID.| -|[Workbook](/.workbook)|[queries](/.workbook#excel-javascript/api/excel/-workbook-queries-member)|Returns a collection of Power Query queries that are part of the workbook.| -|[Worksheet](/.worksheet)|[onProtectionChanged](/.worksheet#excel-javascript/api/excel/-worksheet-onprotectionchanged-member)|Occurs when the worksheet protection state is changed.| -||[tabId](/.worksheet#excel-javascript/api/excel/-worksheet-tabid-member)|Returns a value representing this worksheet that can be read by Open Office XML.| -|[WorksheetChangedEventArgs](/.worksheetchangedeventargs)|[changeDirectionState](/.worksheetchangedeventargs#excel-javascript/api/excel/-worksheetchangedeventargs-changedirectionstate-member)|Represents a change to the direction that the cells in a worksheet will shift when a cell or cells are deleted or inserted.| -||[triggerSource](/.worksheetchangedeventargs#excel-javascript/api/excel/-worksheetchangedeventargs-triggersource-member)|Represents the trigger source of the event.| -|[WorksheetCollection](/.worksheetcollection)|[onProtectionChanged](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-onprotectionchanged-member)|Occurs when the worksheet protection state is changed.| -|[WorksheetProtectionChangedEventArgs](/.worksheetprotectionchangedeventargs)|[isProtected](/.worksheetprotectionchangedeventargs#excel-javascript/api/excel/-worksheetprotectionchangedeventargs-isprotected-member)|Gets the current protection status of the worksheet.| -||[source](/.worksheetprotectionchangedeventargs#excel-javascript/api/excel/-worksheetprotectionchangedeventargs-source-member)|The source of the event.| -||[type](/.worksheetprotectionchangedeventargs#excel-javascript/api/excel/-worksheetprotectionchangedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/.worksheetprotectionchangedeventargs#excel-javascript/api/excel/-worksheetprotectionchangedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the protection status is changed.| +|[AutoFilter](/javascript/api/excel/excel.autofilter)|[clearColumnCriteria(columnIndex: number)](/javascript/api/excel/excel.autofilter#excel-excel-autofilter-clearcolumncriteria-member(1))|Clears the column filter criteria of the AutoFilter.| +|[ChangeDirectionState](/javascript/api/excel/excel.changedirectionstate)|[deleteShiftDirection](/javascript/api/excel/excel.changedirectionstate#excel-excel-changedirectionstate-deleteshiftdirection-member)|Represents the direction (such as up or to the left) that the remaining cells will shift when a cell or cells are deleted.| +||[insertShiftDirection](/javascript/api/excel/excel.changedirectionstate#excel-excel-changedirectionstate-insertshiftdirection-member)|Represents the direction (such as down or to the right) that the existing cells will shift when a new cell or cells are inserted.| +|[Chart](/javascript/api/excel/excel.chart)|[getDataTable()](/javascript/api/excel/excel.chart#excel-excel-chart-getdatatable-member(1))|Gets the data table on the chart.| +||[getDataTableOrNullObject()](/javascript/api/excel/excel.chart#excel-excel-chart-getdatatableornullobject-member(1))|Gets the data table on the chart.| +|[ChartDataTable](/javascript/api/excel/excel.chartdatatable)|[format](/javascript/api/excel/excel.chartdatatable#excel-excel-chartdatatable-format-member)|Represents the format of a chart data table, which includes fill, font, and border format.| +||[showHorizontalBorder](/javascript/api/excel/excel.chartdatatable#excel-excel-chartdatatable-showhorizontalborder-member)|Specifies whether to display the horizontal border of the data table.| +||[showLegendKey](/javascript/api/excel/excel.chartdatatable#excel-excel-chartdatatable-showlegendkey-member)|Specifies whether to show the legend key of the data table.| +||[showOutlineBorder](/javascript/api/excel/excel.chartdatatable#excel-excel-chartdatatable-showoutlineborder-member)|Specifies whether to display the outline border of the data table.| +||[showVerticalBorder](/javascript/api/excel/excel.chartdatatable#excel-excel-chartdatatable-showverticalborder-member)|Specifies whether to display the vertical border of the data table.| +||[visible](/javascript/api/excel/excel.chartdatatable#excel-excel-chartdatatable-visible-member)|Specifies whether to show the data table of the chart.| +|[ChartDataTableFormat](/javascript/api/excel/excel.chartdatatableformat)|[border](/javascript/api/excel/excel.chartdatatableformat#excel-excel-chartdatatableformat-border-member)|Represents the border format of chart data table, which includes color, line style, and weight.| +||[fill](/javascript/api/excel/excel.chartdatatableformat#excel-excel-chartdatatableformat-fill-member)|Represents the fill format of an object, which includes background formatting information.| +||[font](/javascript/api/excel/excel.chartdatatableformat#excel-excel-chartdatatableformat-font-member)|Represents the font attributes (such as font name, font size, and color) for the current object.| +|[CommentCollection](/javascript/api/excel/excel.commentcollection)|[getItemOrNullObject(commentId: string)](/javascript/api/excel/excel.commentcollection#excel-excel-commentcollection-getitemornullobject-member(1))|Gets a comment from the collection based on its ID.| +|[CommentReplyCollection](/javascript/api/excel/excel.commentreplycollection)|[getItemOrNullObject(commentReplyId: string)](/javascript/api/excel/excel.commentreplycollection#excel-excel-commentreplycollection-getitemornullobject-member(1))|Returns a comment reply identified by its ID.| +|[ConditionalFormatCollection](/javascript/api/excel/excel.conditionalformatcollection)|[getItemOrNullObject(id: string)](/javascript/api/excel/excel.conditionalformatcollection#excel-excel-conditionalformatcollection-getitemornullobject-member(1))|Returns a conditional format identified by its ID.| +|[GroupShapeCollection](/javascript/api/excel/excel.groupshapecollection)|[getItemOrNullObject(key: string)](/javascript/api/excel/excel.groupshapecollection#excel-excel-groupshapecollection-getitemornullobject-member(1))|Gets a shape using its name or ID.| +|[Query](/javascript/api/excel/excel.query)|[error](/javascript/api/excel/excel.query#excel-excel-query-error-member)|Gets the query error message from when the query was last refreshed.| +||[loadedTo](/javascript/api/excel/excel.query#excel-excel-query-loadedto-member)|Gets the query loaded to object type.| +||[loadedToDataModel](/javascript/api/excel/excel.query#excel-excel-query-loadedtodatamodel-member)|Specifies if the query loaded to the data model.| +||[name](/javascript/api/excel/excel.query#excel-excel-query-name-member)|Gets the name of the query.| +||[refreshDate](/javascript/api/excel/excel.query#excel-excel-query-refreshdate-member)|Gets the date and time when the query was last refreshed.| +||[rowsLoadedCount](/javascript/api/excel/excel.query#excel-excel-query-rowsloadedcount-member)|Gets the number of rows that were loaded when the query was last refreshed.| +|[QueryCollection](/javascript/api/excel/excel.querycollection)|[getCount()](/javascript/api/excel/excel.querycollection#excel-excel-querycollection-getcount-member(1))|Gets the number of queries in the workbook.| +||[getItem(key: string)](/javascript/api/excel/excel.querycollection#excel-excel-querycollection-getitem-member(1))|Gets a query from the collection based on its name.| +||[items](/javascript/api/excel/excel.querycollection#excel-excel-querycollection-items-member)|Gets the loaded child items in this collection.| +|[Range](/javascript/api/excel/excel.range)|[getPrecedents()](/javascript/api/excel/excel.range#excel-excel-range-getprecedents-member(1))|Returns a `WorkbookRangeAreas` object that represents the range containing all the precedent cells of a specified range in the same worksheet or across multiple worksheets.| +|[ShapeCollection](/javascript/api/excel/excel.shapecollection)|[getItemOrNullObject(key: string)](/javascript/api/excel/excel.shapecollection#excel-excel-shapecollection-getitemornullobject-member(1))|Gets a shape using its name or ID.| +|[StyleCollection](/javascript/api/excel/excel.stylecollection)|[getItemOrNullObject(name: string)](/javascript/api/excel/excel.stylecollection#excel-excel-stylecollection-getitemornullobject-member(1))|Gets a style by name.| +|[TableScopedCollection](/javascript/api/excel/excel.tablescopedcollection)|[getItemOrNullObject(key: string)](/javascript/api/excel/excel.tablescopedcollection#excel-excel-tablescopedcollection-getitemornullobject-member(1))|Gets a table by name or ID.| +|[Workbook](/javascript/api/excel/excel.workbook)|[queries](/javascript/api/excel/excel.workbook#excel-excel-workbook-queries-member)|Returns a collection of Power Query queries that are part of the workbook.| +|[Worksheet](/javascript/api/excel/excel.worksheet)|[onProtectionChanged](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-onprotectionchanged-member)|Occurs when the worksheet protection state is changed.| +||[tabId](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-tabid-member)|Returns a value representing this worksheet that can be read by Open Office XML.| +|[WorksheetChangedEventArgs](/javascript/api/excel/excel.worksheetchangedeventargs)|[changeDirectionState](/javascript/api/excel/excel.worksheetchangedeventargs#excel-excel-worksheetchangedeventargs-changedirectionstate-member)|Represents a change to the direction that the cells in a worksheet will shift when a cell or cells are deleted or inserted.| +||[triggerSource](/javascript/api/excel/excel.worksheetchangedeventargs#excel-excel-worksheetchangedeventargs-triggersource-member)|Represents the trigger source of the event.| +|[WorksheetCollection](/javascript/api/excel/excel.worksheetcollection)|[onProtectionChanged](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-onprotectionchanged-member)|Occurs when the worksheet protection state is changed.| +|[WorksheetProtectionChangedEventArgs](/javascript/api/excel/excel.worksheetprotectionchangedeventargs)|[isProtected](/javascript/api/excel/excel.worksheetprotectionchangedeventargs#excel-excel-worksheetprotectionchangedeventargs-isprotected-member)|Gets the current protection status of the worksheet.| +||[source](/javascript/api/excel/excel.worksheetprotectionchangedeventargs#excel-excel-worksheetprotectionchangedeventargs-source-member)|The source of the event.| +||[type](/javascript/api/excel/excel.worksheetprotectionchangedeventargs#excel-excel-worksheetprotectionchangedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/javascript/api/excel/excel.worksheetprotectionchangedeventargs#excel-excel-worksheetprotectionchangedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the protection status is changed.| diff --git a/docs/includes/excel-1_15.md b/docs/includes/excel-1_15.md index 741bbb0740..70ef8c608e 100644 --- a/docs/includes/excel-1_15.md +++ b/docs/includes/excel-1_15.md @@ -1,9 +1,9 @@ | Class | Fields | Description | |:---|:---|:---| -|[ChartSeries](/.chartseries)|[getDimensionDataSourceString(dimension: Excel.ChartSeriesDimension)](/.chartseries#excel-javascript/api/excel/-chartseries-getdimensiondatasourcestring-member(1))|Gets the string representation of the data source of the chart series.| -||[getDimensionDataSourceType(dimension: Excel.ChartSeriesDimension)](/.chartseries#excel-javascript/api/excel/-chartseries-getdimensiondatasourcetype-member(1))|Gets the data source type of the chart series.| -|[PivotTable](/.pivottable)|[getDataSourceString()](/.pivottable#excel-javascript/api/excel/-pivottable-getdatasourcestring-member(1))|Returns the string representation of the data source for the PivotTable.| -||[getDataSourceType()](/.pivottable#excel-javascript/api/excel/-pivottable-getdatasourcetype-member(1))|Gets the type of the data source for the PivotTable.| -|[PivotTableScopedCollection](/.pivottablescopedcollection)|[getFirstOrNullObject()](/.pivottablescopedcollection#excel-javascript/api/excel/-pivottablescopedcollection-getfirstornullobject-member(1))|Gets the first PivotTable in the collection.| -|[Range](/.range)|[getDependents()](/.range#excel-javascript/api/excel/-range-getdependents-member(1))|Returns a `WorkbookRangeAreas` object that represents the range containing all the dependent cells of a specified range in the same worksheet or across multiple worksheets.| -|[Shape](/.shape)|[displayName](/.shape#excel-javascript/api/excel/-shape-displayname-member)|Gets the display name of the shape.| +|[ChartSeries](/javascript/api/excel/excel.chartseries)|[getDimensionDataSourceString(dimension: Excel.ChartSeriesDimension)](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-getdimensiondatasourcestring-member(1))|Gets the string representation of the data source of the chart series.| +||[getDimensionDataSourceType(dimension: Excel.ChartSeriesDimension)](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-getdimensiondatasourcetype-member(1))|Gets the data source type of the chart series.| +|[PivotTable](/javascript/api/excel/excel.pivottable)|[getDataSourceString()](/javascript/api/excel/excel.pivottable#excel-excel-pivottable-getdatasourcestring-member(1))|Returns the string representation of the data source for the PivotTable.| +||[getDataSourceType()](/javascript/api/excel/excel.pivottable#excel-excel-pivottable-getdatasourcetype-member(1))|Gets the type of the data source for the PivotTable.| +|[PivotTableScopedCollection](/javascript/api/excel/excel.pivottablescopedcollection)|[getFirstOrNullObject()](/javascript/api/excel/excel.pivottablescopedcollection#excel-excel-pivottablescopedcollection-getfirstornullobject-member(1))|Gets the first PivotTable in the collection.| +|[Range](/javascript/api/excel/excel.range)|[getDependents()](/javascript/api/excel/excel.range#excel-excel-range-getdependents-member(1))|Returns a `WorkbookRangeAreas` object that represents the range containing all the dependent cells of a specified range in the same worksheet or across multiple worksheets.| +|[Shape](/javascript/api/excel/excel.shape)|[displayName](/javascript/api/excel/excel.shape#excel-excel-shape-displayname-member)|Gets the display name of the shape.| diff --git a/docs/includes/excel-1_16.md b/docs/includes/excel-1_16.md index 4d7f2ddb61..0fe64560f9 100644 --- a/docs/includes/excel-1_16.md +++ b/docs/includes/excel-1_16.md @@ -1,187 +1,187 @@ | Class | Fields | Description | |:---|:---|:---| -|[ArrayCellValue](/.arraycellvalue)|[basicType](/.arraycellvalue#excel-javascript/api/excel/-arraycellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/.arraycellvalue#excel-javascript/api/excel/-arraycellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[elements](/.arraycellvalue#excel-javascript/api/excel/-arraycellvalue-elements-member)|Represents the elements of the array.| -||[referencedValues](/.arraycellvalue#excel-javascript/api/excel/-arraycellvalue-referencedvalues-member)|Represents the cell values which are referenced within `ArrayCellValue.elements`.| -||[type](/.arraycellvalue#excel-javascript/api/excel/-arraycellvalue-type-member)|Represents the type of this cell value.| -|[BlockedErrorCellValue](/.blockederrorcellvalue)|[basicType](/.blockederrorcellvalue#excel-javascript/api/excel/-blockederrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/.blockederrorcellvalue#excel-javascript/api/excel/-blockederrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[errorSubType](/.blockederrorcellvalue#excel-javascript/api/excel/-blockederrorcellvalue-errorsubtype-member)|Represents the type of `BlockedErrorCellValue`.| -||[errorType](/.blockederrorcellvalue#excel-javascript/api/excel/-blockederrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| -||[type](/.blockederrorcellvalue#excel-javascript/api/excel/-blockederrorcellvalue-type-member)|Represents the type of this cell value.| -|[BooleanCellValue](/.booleancellvalue)|[basicType](/.booleancellvalue#excel-javascript/api/excel/-booleancellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/.booleancellvalue#excel-javascript/api/excel/-booleancellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[type](/.booleancellvalue#excel-javascript/api/excel/-booleancellvalue-type-member)|Represents the type of this cell value.| -|[BusyErrorCellValue](/.busyerrorcellvalue)|[basicType](/.busyerrorcellvalue#excel-javascript/api/excel/-busyerrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/.busyerrorcellvalue#excel-javascript/api/excel/-busyerrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[errorSubType](/.busyerrorcellvalue#excel-javascript/api/excel/-busyerrorcellvalue-errorsubtype-member)|Represents the type of `BusyErrorCellValue`.| -||[errorType](/.busyerrorcellvalue#excel-javascript/api/excel/-busyerrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| -||[type](/.busyerrorcellvalue#excel-javascript/api/excel/-busyerrorcellvalue-type-member)|Represents the type of this cell value.| -|[CalcErrorCellValue](/.calcerrorcellvalue)|[basicType](/.calcerrorcellvalue#excel-javascript/api/excel/-calcerrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/.calcerrorcellvalue#excel-javascript/api/excel/-calcerrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[errorSubType](/.calcerrorcellvalue#excel-javascript/api/excel/-calcerrorcellvalue-errorsubtype-member)|Represents the type of `CalcErrorCellValue`.| -||[errorType](/.calcerrorcellvalue#excel-javascript/api/excel/-calcerrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| -||[functionName](/.calcerrorcellvalue#excel-javascript/api/excel/-calcerrorcellvalue-functionname-member)|Represents the name of the function causing the error.| -||[type](/.calcerrorcellvalue#excel-javascript/api/excel/-calcerrorcellvalue-type-member)|Represents the type of this cell value.| -|[CardLayoutListSection](/.cardlayoutlistsection)|[layout](/.cardlayoutlistsection#excel-javascript/api/excel/-cardlayoutlistsection-layout-member)|Represents the type of layout for this section.| -|[CardLayoutPropertyReference](/.cardlayoutpropertyreference)|[property](/.cardlayoutpropertyreference#excel-javascript/api/excel/-cardlayoutpropertyreference-property-member)|Represents the name of the property referenced by the card layout.| -|[CardLayoutSectionStandardProperties](/.cardlayoutsectionstandardproperties)|[collapsed](/.cardlayoutsectionstandardproperties#excel-javascript/api/excel/-cardlayoutsectionstandardproperties-collapsed-member)|Represents whether this section of the card is initially collapsed.| -||[collapsible](/.cardlayoutsectionstandardproperties#excel-javascript/api/excel/-cardlayoutsectionstandardproperties-collapsible-member)|Represents whether this section of the card is collapsible.| -||[properties](/.cardlayoutsectionstandardproperties#excel-javascript/api/excel/-cardlayoutsectionstandardproperties-properties-member)|Represents the names of the properties in this section.| -||[title](/.cardlayoutsectionstandardproperties#excel-javascript/api/excel/-cardlayoutsectionstandardproperties-title-member)|Represents the title of this section of the card.| -|[CardLayoutStandardProperties](/.cardlayoutstandardproperties)|[mainImage](/.cardlayoutstandardproperties#excel-javascript/api/excel/-cardlayoutstandardproperties-mainimage-member)|Specifies a property which will be used as the main image of the card.| -||[sections](/.cardlayoutstandardproperties#excel-javascript/api/excel/-cardlayoutstandardproperties-sections-member)|Represents the sections of the card.| -||[subTitle](/.cardlayoutstandardproperties#excel-javascript/api/excel/-cardlayoutstandardproperties-subtitle-member)|Represents a specification of which property contains the subtitle of the card.| -||[title](/.cardlayoutstandardproperties#excel-javascript/api/excel/-cardlayoutstandardproperties-title-member)|Represents the title of the card or the specification of which property contains the title of the card.| -|[CardLayoutTableSection](/.cardlayouttablesection)|[layout](/.cardlayouttablesection#excel-javascript/api/excel/-cardlayouttablesection-layout-member)|Represents the type of layout for this section.| -|[CellValueAttributionAttributes](/.cellvalueattributionattributes)|[licenseAddress](/.cellvalueattributionattributes#excel-javascript/api/excel/-cellvalueattributionattributes-licenseaddress-member)|Represents a URL to a license or source that describes how this property can be used.| -||[licenseText](/.cellvalueattributionattributes#excel-javascript/api/excel/-cellvalueattributionattributes-licensetext-member)|Represents a name for the license that governs this property.| -||[sourceAddress](/.cellvalueattributionattributes#excel-javascript/api/excel/-cellvalueattributionattributes-sourceaddress-member)|Represents a URL to the source of the `CellValue`.| -||[sourceText](/.cellvalueattributionattributes#excel-javascript/api/excel/-cellvalueattributionattributes-sourcetext-member)|Represents a name for the source of the `CellValue`.| -|[CellValueExtraProperties](/.cellvalueextraproperties)|[writable](/.cellvalueextraproperties#excel-javascript/api/excel/-cellvalueextraproperties-writable-member)|Represents whether this `CellValue` will be used to overwrite a cell.| -||[writableNote](/.cellvalueextraproperties#excel-javascript/api/excel/-cellvalueextraproperties-writablenote-member)|Represents an explanation about why `CellValue.writable` is specified as false.| -|[CellValuePropertyMetadata](/.cellvaluepropertymetadata)|[attribution](/.cellvaluepropertymetadata#excel-javascript/api/excel/-cellvaluepropertymetadata-attribution-member)|Represents attribution information to describe the source and license requirements for using this property.| -||[excludeFrom](/.cellvaluepropertymetadata#excel-javascript/api/excel/-cellvaluepropertymetadata-excludefrom-member)|Represents which features this property is excluded from.| -||[sublabel](/.cellvaluepropertymetadata#excel-javascript/api/excel/-cellvaluepropertymetadata-sublabel-member)|Represents the sublabel for this property shown in card view.| -|[CellValuePropertyMetadataExclusions](/.cellvaluepropertymetadataexclusions)|[autoComplete](/.cellvaluepropertymetadataexclusions#excel-javascript/api/excel/-cellvaluepropertymetadataexclusions-autocomplete-member)|True represents that the property is excluded from the properties shown by auto complete.| -||[calcCompare](/.cellvaluepropertymetadataexclusions#excel-javascript/api/excel/-cellvaluepropertymetadataexclusions-calccompare-member)|True represents that the property is excluded from the properties used to compare cell values during recalc.| -||[cardView](/.cellvaluepropertymetadataexclusions#excel-javascript/api/excel/-cellvaluepropertymetadataexclusions-cardview-member)|True represents that the property is excluded from the properties shown by card view.| -||[dotNotation](/.cellvaluepropertymetadataexclusions#excel-javascript/api/excel/-cellvaluepropertymetadataexclusions-dotnotation-member)|True represents that the property is excluded from the properties which can be accessed via the FIELDVALUE function.| -|[CellValueProviderAttributes](/.cellvalueproviderattributes)|[description](/.cellvalueproviderattributes#excel-javascript/api/excel/-cellvalueproviderattributes-description-member)|Represents the provider description property that is used in card view if no logo is specified.| -||[logoSourceAddress](/.cellvalueproviderattributes#excel-javascript/api/excel/-cellvalueproviderattributes-logosourceaddress-member)|Represents a URL used to download an image that will be used as a logo in card view.| -||[logoTargetAddress](/.cellvalueproviderattributes#excel-javascript/api/excel/-cellvalueproviderattributes-logotargetaddress-member)|Represents a URL that is the navigation target if the user clicks on the logo element in card view.| -|[ChangedEventDetail](/.changedeventdetail)|[valueAsJsonAfter](/.changedeventdetail#excel-javascript/api/excel/-changedeventdetail-valueasjsonafter-member)|Represents the type of value after the change.| -||[valueAsJsonBefore](/.changedeventdetail#excel-javascript/api/excel/-changedeventdetail-valueasjsonbefore-member)|Represents the type of value before the change.| -|[ChartFill](/.chartfill)|[getSolidColor()](/.chartfill#excel-javascript/api/excel/-chartfill-getsolidcolor-member(1))|Gets the uniform color fill formatting of a chart element.| -|[ConnectErrorCellValue](/.connecterrorcellvalue)|[basicType](/.connecterrorcellvalue#excel-javascript/api/excel/-connecterrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/.connecterrorcellvalue#excel-javascript/api/excel/-connecterrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[errorSubType](/.connecterrorcellvalue#excel-javascript/api/excel/-connecterrorcellvalue-errorsubtype-member)|Represents the type of `ConnectErrorCellValue`.| -||[errorType](/.connecterrorcellvalue#excel-javascript/api/excel/-connecterrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| -||[type](/.connecterrorcellvalue#excel-javascript/api/excel/-connecterrorcellvalue-type-member)|Represents the type of this cell value.| -|[Div0ErrorCellValue](/.div0errorcellvalue)|[basicType](/.div0errorcellvalue#excel-javascript/api/excel/-div0errorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/.div0errorcellvalue#excel-javascript/api/excel/-div0errorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[errorType](/.div0errorcellvalue#excel-javascript/api/excel/-div0errorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| -||[type](/.div0errorcellvalue#excel-javascript/api/excel/-div0errorcellvalue-type-member)|Represents the type of this cell value.| -|[DoubleCellValue](/.doublecellvalue)|[basicType](/.doublecellvalue#excel-javascript/api/excel/-doublecellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/.doublecellvalue#excel-javascript/api/excel/-doublecellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[type](/.doublecellvalue#excel-javascript/api/excel/-doublecellvalue-type-member)|Represents the type of this cell value.| -|[EmptyCellValue](/.emptycellvalue)|[basicType](/.emptycellvalue#excel-javascript/api/excel/-emptycellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/.emptycellvalue#excel-javascript/api/excel/-emptycellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[type](/.emptycellvalue#excel-javascript/api/excel/-emptycellvalue-type-member)|Represents the type of this cell value.| -|[EntityCardLayout](/.entitycardlayout)|[layout](/.entitycardlayout#excel-javascript/api/excel/-entitycardlayout-layout-member)|Represents the type of this layout.| -|[EntityCellValue](/.entitycellvalue)|[basicType](/.entitycellvalue#excel-javascript/api/excel/-entitycellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/.entitycellvalue#excel-javascript/api/excel/-entitycellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[layouts](/.entitycellvalue#excel-javascript/api/excel/-entitycellvalue-layouts-member)|Represents layout information for views of this entity.| -||[properties](/.entitycellvalue#excel-javascript/api/excel/-entitycellvalue-properties-member)|Represents the properties of this entity and their metadata.| -||[provider](/.entitycellvalue#excel-javascript/api/excel/-entitycellvalue-provider-member)|Represents information that describes the service that provided the data in this `EntityCellValue`.| -||[referencedValues](/.entitycellvalue#excel-javascript/api/excel/-entitycellvalue-referencedvalues-member)|Represents the cell values which are referenced within `EntityCellValue.properties`.| -||[text](/.entitycellvalue#excel-javascript/api/excel/-entitycellvalue-text-member)|Represents the text shown when a cell with this value is rendered.| -||[type](/.entitycellvalue#excel-javascript/api/excel/-entitycellvalue-type-member)|Represents the type of this cell value.| -|[EntityCompactLayout](/.entitycompactlayout)|[icon](/.entitycompactlayout#excel-javascript/api/excel/-entitycompactlayout-icon-member)|Specifies the name of the icon which is used to open the card.| -|[EntityPropertyExtraProperties](/.entitypropertyextraproperties)|[propertyMetadata](/.entitypropertyextraproperties#excel-javascript/api/excel/-entitypropertyextraproperties-propertymetadata-member)|Represents metadata about the property.| -|[EntityViewLayouts](/.entityviewlayouts)|[card](/.entityviewlayouts#excel-javascript/api/excel/-entityviewlayouts-card-member)|Represents the layout of this entity in card view.| -||[compact](/.entityviewlayouts#excel-javascript/api/excel/-entityviewlayouts-compact-member)|Represents the layout used when there is limited space to represent the entity.| -|[ExternalErrorCellValue](/.externalerrorcellvalue)|[basicType](/.externalerrorcellvalue#excel-javascript/api/excel/-externalerrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/.externalerrorcellvalue#excel-javascript/api/excel/-externalerrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[errorSubType](/.externalerrorcellvalue#excel-javascript/api/excel/-externalerrorcellvalue-errorsubtype-member)|Represents the type of `ExternalErrorCellValue`.| -||[errorType](/.externalerrorcellvalue#excel-javascript/api/excel/-externalerrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| -||[type](/.externalerrorcellvalue#excel-javascript/api/excel/-externalerrorcellvalue-type-member)|Represents the type of this cell value.| -|[FieldErrorCellValue](/.fielderrorcellvalue)|[basicType](/.fielderrorcellvalue#excel-javascript/api/excel/-fielderrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/.fielderrorcellvalue#excel-javascript/api/excel/-fielderrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[errorSubType](/.fielderrorcellvalue#excel-javascript/api/excel/-fielderrorcellvalue-errorsubtype-member)|Represents the type of `FieldErrorCellValue`.| -||[errorType](/.fielderrorcellvalue#excel-javascript/api/excel/-fielderrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| -||[fieldName](/.fielderrorcellvalue#excel-javascript/api/excel/-fielderrorcellvalue-fieldname-member)|Represents the field which was not found by FIELDVALUE.| -||[type](/.fielderrorcellvalue#excel-javascript/api/excel/-fielderrorcellvalue-type-member)|Represents the type of this cell value.| -|[GettingDataErrorCellValue](/.gettingdataerrorcellvalue)|[basicType](/.gettingdataerrorcellvalue#excel-javascript/api/excel/-gettingdataerrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/.gettingdataerrorcellvalue#excel-javascript/api/excel/-gettingdataerrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[errorType](/.gettingdataerrorcellvalue#excel-javascript/api/excel/-gettingdataerrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| -||[type](/.gettingdataerrorcellvalue#excel-javascript/api/excel/-gettingdataerrorcellvalue-type-member)|Represents the type of this cell value.| -|[LinkedEntityCellValue](/.linkedentitycellvalue)|[basicType](/.linkedentitycellvalue#excel-javascript/api/excel/-linkedentitycellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/.linkedentitycellvalue#excel-javascript/api/excel/-linkedentitycellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[id](/.linkedentitycellvalue#excel-javascript/api/excel/-linkedentitycellvalue-id-member)|Represents the service source that provided the information in this value.| -||[layouts](/.linkedentitycellvalue#excel-javascript/api/excel/-linkedentitycellvalue-layouts-member)|Represents layout information for views of this linked entity.| -||[properties](/.linkedentitycellvalue#excel-javascript/api/excel/-linkedentitycellvalue-properties-member)|Represents the properties of this linked entity and their metadata.| -||[provider](/.linkedentitycellvalue#excel-javascript/api/excel/-linkedentitycellvalue-provider-member)|Represents information that describes the service that provided data in this `LinkedEntityCellValue`.| -||[text](/.linkedentitycellvalue#excel-javascript/api/excel/-linkedentitycellvalue-text-member)|Represents the text shown when a cell with this value is rendered.| -||[type](/.linkedentitycellvalue#excel-javascript/api/excel/-linkedentitycellvalue-type-member)|Represents the type of this cell value.| -|[LinkedEntityId](/.linkedentityid)|[culture](/.linkedentityid#excel-javascript/api/excel/-linkedentityid-culture-member)|Represents which language culture was used to create this `CellValue`.| -||[domainId](/.linkedentityid#excel-javascript/api/excel/-linkedentityid-domainid-member)|Represents a domain specific to a service used to create the `CellValue`.| -||[entityId](/.linkedentityid#excel-javascript/api/excel/-linkedentityid-entityid-member)|Represents an identifier specific to a service used to create the `CellValue`.| -||[serviceId](/.linkedentityid#excel-javascript/api/excel/-linkedentityid-serviceid-member)|Represents which service was used to create the `CellValue`.| -|[NameErrorCellValue](/.nameerrorcellvalue)|[basicType](/.nameerrorcellvalue#excel-javascript/api/excel/-nameerrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/.nameerrorcellvalue#excel-javascript/api/excel/-nameerrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[errorType](/.nameerrorcellvalue#excel-javascript/api/excel/-nameerrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| -||[type](/.nameerrorcellvalue#excel-javascript/api/excel/-nameerrorcellvalue-type-member)|Represents the type of this cell value.| -|[NamedItem](/.nameditem)|[valueAsJson](/.nameditem#excel-javascript/api/excel/-nameditem-valueasjson-member)|A JSON representation of the values in this named item.| -||[valueAsJsonLocal](/.nameditem#excel-javascript/api/excel/-nameditem-valueasjsonlocal-member)|A JSON representation of the values in this named item.| -|[NamedItemArrayValues](/.nameditemarrayvalues)|[valuesAsJson](/.nameditemarrayvalues#excel-javascript/api/excel/-nameditemarrayvalues-valuesasjson-member)|A JSON representation of the values in this named item array.| -||[valuesAsJsonLocal](/.nameditemarrayvalues#excel-javascript/api/excel/-nameditemarrayvalues-valuesasjsonlocal-member)|A JSON representation of the values in this named item array.| -|[NotAvailableErrorCellValue](/.notavailableerrorcellvalue)|[basicType](/.notavailableerrorcellvalue#excel-javascript/api/excel/-notavailableerrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/.notavailableerrorcellvalue#excel-javascript/api/excel/-notavailableerrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[errorType](/.notavailableerrorcellvalue#excel-javascript/api/excel/-notavailableerrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| -||[type](/.notavailableerrorcellvalue#excel-javascript/api/excel/-notavailableerrorcellvalue-type-member)|Represents the type of this cell value.| -|[NullErrorCellValue](/.nullerrorcellvalue)|[basicType](/.nullerrorcellvalue#excel-javascript/api/excel/-nullerrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/.nullerrorcellvalue#excel-javascript/api/excel/-nullerrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[errorType](/.nullerrorcellvalue#excel-javascript/api/excel/-nullerrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| -||[type](/.nullerrorcellvalue#excel-javascript/api/excel/-nullerrorcellvalue-type-member)|Represents the type of this cell value.| -|[NumErrorCellValue](/.numerrorcellvalue)|[basicType](/.numerrorcellvalue#excel-javascript/api/excel/-numerrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/.numerrorcellvalue#excel-javascript/api/excel/-numerrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[errorSubType](/.numerrorcellvalue#excel-javascript/api/excel/-numerrorcellvalue-errorsubtype-member)|Represents the type of `NumErrorCellValue`.| -||[errorType](/.numerrorcellvalue#excel-javascript/api/excel/-numerrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| -||[functionName](/.numerrorcellvalue#excel-javascript/api/excel/-numerrorcellvalue-functionname-member)|Represents the name of the function causing the error.| -||[type](/.numerrorcellvalue#excel-javascript/api/excel/-numerrorcellvalue-type-member)|Represents the type of this cell value.| -|[PlaceholderErrorCellValue](/.placeholdererrorcellvalue)|[basicType](/.placeholdererrorcellvalue#excel-javascript/api/excel/-placeholdererrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/.placeholdererrorcellvalue#excel-javascript/api/excel/-placeholdererrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[errorType](/.placeholdererrorcellvalue#excel-javascript/api/excel/-placeholdererrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| -||[target](/.placeholdererrorcellvalue#excel-javascript/api/excel/-placeholdererrorcellvalue-target-member)|`PlaceholderErrorCellValue` is used during processing, while data is downloaded.| -||[type](/.placeholdererrorcellvalue#excel-javascript/api/excel/-placeholdererrorcellvalue-type-member)|Represents the type of this cell value.| -|[Range](/.range)|[valuesAsJson](/.range#excel-javascript/api/excel/-range-valuesasjson-member)|A JSON representation of the values in the cells in this range.| -||[valuesAsJsonLocal](/.range#excel-javascript/api/excel/-range-valuesasjsonlocal-member)|A JSON representation of the values in the cells in this range.| -|[RangeView](/.rangeview)|[valuesAsJson](/.rangeview#excel-javascript/api/excel/-rangeview-valuesasjson-member)|A JSON representation of the values in the cells in this range.| -||[valuesAsJsonLocal](/.rangeview#excel-javascript/api/excel/-rangeview-valuesasjsonlocal-member)|A JSON representation of the values in the cells in this range.| -|[RefErrorCellValue](/.referrorcellvalue)|[basicType](/.referrorcellvalue#excel-javascript/api/excel/-referrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/.referrorcellvalue#excel-javascript/api/excel/-referrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[errorSubType](/.referrorcellvalue#excel-javascript/api/excel/-referrorcellvalue-errorsubtype-member)|Represents the type of `RefErrorCellValue`.| -||[errorType](/.referrorcellvalue#excel-javascript/api/excel/-referrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| -||[type](/.referrorcellvalue#excel-javascript/api/excel/-referrorcellvalue-type-member)|Represents the type of this cell value.| -|[ReferenceCellValue](/.referencecellvalue)|[basicType](/.referencecellvalue#excel-javascript/api/excel/-referencecellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/.referencecellvalue#excel-javascript/api/excel/-referencecellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[reference](/.referencecellvalue#excel-javascript/api/excel/-referencecellvalue-reference-member)|Represents the index into the `referencedValues` properties of cell values such as `EntityCellValue` and `ArrayCellValue`.| -||[type](/.referencecellvalue#excel-javascript/api/excel/-referencecellvalue-type-member)|Represents the type of this cell value.| -|[RootReferenceCellValue](/.rootreferencecellvalue)|[basicType](/.rootreferencecellvalue#excel-javascript/api/excel/-rootreferencecellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/.rootreferencecellvalue#excel-javascript/api/excel/-rootreferencecellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[type](/.rootreferencecellvalue#excel-javascript/api/excel/-rootreferencecellvalue-type-member)|Represents the type of this cell value.| -|[SpillErrorCellValue](/.spillerrorcellvalue)|[basicType](/.spillerrorcellvalue#excel-javascript/api/excel/-spillerrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/.spillerrorcellvalue#excel-javascript/api/excel/-spillerrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[columnCount](/.spillerrorcellvalue#excel-javascript/api/excel/-spillerrorcellvalue-columncount-member)|Represents the number of columns that would spill if there were no #SPILL! error.| -||[errorSubType](/.spillerrorcellvalue#excel-javascript/api/excel/-spillerrorcellvalue-errorsubtype-member)|Represents the type of `SpillErrorCellValue`.| -||[errorType](/.spillerrorcellvalue#excel-javascript/api/excel/-spillerrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| -||[rowCount](/.spillerrorcellvalue#excel-javascript/api/excel/-spillerrorcellvalue-rowcount-member)|Represents the number of rows that would spill if there were no #SPILL! error.| -||[type](/.spillerrorcellvalue#excel-javascript/api/excel/-spillerrorcellvalue-type-member)|Represents the type of this cell value.| -|[StringCellValue](/.stringcellvalue)|[basicType](/.stringcellvalue#excel-javascript/api/excel/-stringcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/.stringcellvalue#excel-javascript/api/excel/-stringcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[type](/.stringcellvalue#excel-javascript/api/excel/-stringcellvalue-type-member)|Represents the type of this cell value.| -|[TableColumn](/.tablecolumn)|[valuesAsJson](/.tablecolumn#excel-javascript/api/excel/-tablecolumn-valuesasjson-member)|A JSON representation of the values in the cells in this table column.| -||[valuesAsJsonLocal](/.tablecolumn#excel-javascript/api/excel/-tablecolumn-valuesasjsonlocal-member)|A JSON representation of the values in the cells in this table column.| -|[TableColumnCollection](/.tablecolumncollection)|[addAsJson(index?: number, values?: CellValue[][], name?: string)](/.tablecolumncollection#excel-javascript/api/excel/-tablecolumncollection-addasjson-member(1))|Adds a new column to the table.| -|[TableRow](/.tablerow)|[valuesAsJson](/.tablerow#excel-javascript/api/excel/-tablerow-valuesasjson-member)|A JSON representation of the values in the cells in this table row.| -||[valuesAsJsonLocal](/.tablerow#excel-javascript/api/excel/-tablerow-valuesasjsonlocal-member)|A JSON representation of the values in the cells in this table row.| -|[TableRowCollection](/.tablerowcollection)|[addAsJson(index?: number, values?: CellValue[][], alwaysInsert?: boolean)](/.tablerowcollection#excel-javascript/api/excel/-tablerowcollection-addasjson-member(1))|Adds one or more rows to the table.| -|[ValueErrorCellValue](/.valueerrorcellvalue)|[basicType](/.valueerrorcellvalue#excel-javascript/api/excel/-valueerrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/.valueerrorcellvalue#excel-javascript/api/excel/-valueerrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[errorSubType](/.valueerrorcellvalue#excel-javascript/api/excel/-valueerrorcellvalue-errorsubtype-member)|Represents the type of `ValueErrorCellValue`.| -||[errorType](/.valueerrorcellvalue#excel-javascript/api/excel/-valueerrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| -||[type](/.valueerrorcellvalue#excel-javascript/api/excel/-valueerrorcellvalue-type-member)|Represents the type of this cell value.| -|[ValueTypeNotAvailableCellValue](/.valuetypenotavailablecellvalue)|[basicType](/.valuetypenotavailablecellvalue#excel-javascript/api/excel/-valuetypenotavailablecellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/.valuetypenotavailablecellvalue#excel-javascript/api/excel/-valuetypenotavailablecellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[type](/.valuetypenotavailablecellvalue#excel-javascript/api/excel/-valuetypenotavailablecellvalue-type-member)|Represents the type of this cell value.| -|[WebImageCellValue](/.webimagecellvalue)|[address](/.webimagecellvalue#excel-javascript/api/excel/-webimagecellvalue-address-member)|Represents the URL from which the image will be downloaded.| -||[altText](/.webimagecellvalue#excel-javascript/api/excel/-webimagecellvalue-alttext-member)|Represents the alternate text that can be used in accessibility scenarios to describe what the image represents.| -||[attribution](/.webimagecellvalue#excel-javascript/api/excel/-webimagecellvalue-attribution-member)|Represents attribution information to describe the source and license requirements for using this image.| -||[basicType](/.webimagecellvalue#excel-javascript/api/excel/-webimagecellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/.webimagecellvalue#excel-javascript/api/excel/-webimagecellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[provider](/.webimagecellvalue#excel-javascript/api/excel/-webimagecellvalue-provider-member)|Represents information that describes the entity or individual who provided the image.| -||[relatedImagesAddress](/.webimagecellvalue#excel-javascript/api/excel/-webimagecellvalue-relatedimagesaddress-member)|Represents the URL of a webpage with images that are considered related to this `WebImageCellValue`.| -||[type](/.webimagecellvalue#excel-javascript/api/excel/-webimagecellvalue-type-member)|Represents the type of this cell value.| -|[Workbook](/.workbook)|[getLinkedEntityCellValue(linkedEntityCellValueId: LinkedEntityId)](/.workbook#excel-javascript/api/excel/-workbook-getlinkedentitycellvalue-member(1))|Returns a `LinkedEntityCellValue` based on the provided `LinkedEntityId`.| +|[ArrayCellValue](/javascript/api/excel/excel.arraycellvalue)|[basicType](/javascript/api/excel/excel.arraycellvalue#excel-excel-arraycellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/javascript/api/excel/excel.arraycellvalue#excel-excel-arraycellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[elements](/javascript/api/excel/excel.arraycellvalue#excel-excel-arraycellvalue-elements-member)|Represents the elements of the array.| +||[referencedValues](/javascript/api/excel/excel.arraycellvalue#excel-excel-arraycellvalue-referencedvalues-member)|Represents the cell values which are referenced within `ArrayCellValue.elements`.| +||[type](/javascript/api/excel/excel.arraycellvalue#excel-excel-arraycellvalue-type-member)|Represents the type of this cell value.| +|[BlockedErrorCellValue](/javascript/api/excel/excel.blockederrorcellvalue)|[basicType](/javascript/api/excel/excel.blockederrorcellvalue#excel-excel-blockederrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/javascript/api/excel/excel.blockederrorcellvalue#excel-excel-blockederrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[errorSubType](/javascript/api/excel/excel.blockederrorcellvalue#excel-excel-blockederrorcellvalue-errorsubtype-member)|Represents the type of `BlockedErrorCellValue`.| +||[errorType](/javascript/api/excel/excel.blockederrorcellvalue#excel-excel-blockederrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| +||[type](/javascript/api/excel/excel.blockederrorcellvalue#excel-excel-blockederrorcellvalue-type-member)|Represents the type of this cell value.| +|[BooleanCellValue](/javascript/api/excel/excel.booleancellvalue)|[basicType](/javascript/api/excel/excel.booleancellvalue#excel-excel-booleancellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/javascript/api/excel/excel.booleancellvalue#excel-excel-booleancellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[type](/javascript/api/excel/excel.booleancellvalue#excel-excel-booleancellvalue-type-member)|Represents the type of this cell value.| +|[BusyErrorCellValue](/javascript/api/excel/excel.busyerrorcellvalue)|[basicType](/javascript/api/excel/excel.busyerrorcellvalue#excel-excel-busyerrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/javascript/api/excel/excel.busyerrorcellvalue#excel-excel-busyerrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[errorSubType](/javascript/api/excel/excel.busyerrorcellvalue#excel-excel-busyerrorcellvalue-errorsubtype-member)|Represents the type of `BusyErrorCellValue`.| +||[errorType](/javascript/api/excel/excel.busyerrorcellvalue#excel-excel-busyerrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| +||[type](/javascript/api/excel/excel.busyerrorcellvalue#excel-excel-busyerrorcellvalue-type-member)|Represents the type of this cell value.| +|[CalcErrorCellValue](/javascript/api/excel/excel.calcerrorcellvalue)|[basicType](/javascript/api/excel/excel.calcerrorcellvalue#excel-excel-calcerrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/javascript/api/excel/excel.calcerrorcellvalue#excel-excel-calcerrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[errorSubType](/javascript/api/excel/excel.calcerrorcellvalue#excel-excel-calcerrorcellvalue-errorsubtype-member)|Represents the type of `CalcErrorCellValue`.| +||[errorType](/javascript/api/excel/excel.calcerrorcellvalue#excel-excel-calcerrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| +||[functionName](/javascript/api/excel/excel.calcerrorcellvalue#excel-excel-calcerrorcellvalue-functionname-member)|Represents the name of the function causing the error.| +||[type](/javascript/api/excel/excel.calcerrorcellvalue#excel-excel-calcerrorcellvalue-type-member)|Represents the type of this cell value.| +|[CardLayoutListSection](/javascript/api/excel/excel.cardlayoutlistsection)|[layout](/javascript/api/excel/excel.cardlayoutlistsection#excel-excel-cardlayoutlistsection-layout-member)|Represents the type of layout for this section.| +|[CardLayoutPropertyReference](/javascript/api/excel/excel.cardlayoutpropertyreference)|[property](/javascript/api/excel/excel.cardlayoutpropertyreference#excel-excel-cardlayoutpropertyreference-property-member)|Represents the name of the property referenced by the card layout.| +|[CardLayoutSectionStandardProperties](/javascript/api/excel/excel.cardlayoutsectionstandardproperties)|[collapsed](/javascript/api/excel/excel.cardlayoutsectionstandardproperties#excel-excel-cardlayoutsectionstandardproperties-collapsed-member)|Represents whether this section of the card is initially collapsed.| +||[collapsible](/javascript/api/excel/excel.cardlayoutsectionstandardproperties#excel-excel-cardlayoutsectionstandardproperties-collapsible-member)|Represents whether this section of the card is collapsible.| +||[properties](/javascript/api/excel/excel.cardlayoutsectionstandardproperties#excel-excel-cardlayoutsectionstandardproperties-properties-member)|Represents the names of the properties in this section.| +||[title](/javascript/api/excel/excel.cardlayoutsectionstandardproperties#excel-excel-cardlayoutsectionstandardproperties-title-member)|Represents the title of this section of the card.| +|[CardLayoutStandardProperties](/javascript/api/excel/excel.cardlayoutstandardproperties)|[mainImage](/javascript/api/excel/excel.cardlayoutstandardproperties#excel-excel-cardlayoutstandardproperties-mainimage-member)|Specifies a property which will be used as the main image of the card.| +||[sections](/javascript/api/excel/excel.cardlayoutstandardproperties#excel-excel-cardlayoutstandardproperties-sections-member)|Represents the sections of the card.| +||[subTitle](/javascript/api/excel/excel.cardlayoutstandardproperties#excel-excel-cardlayoutstandardproperties-subtitle-member)|Represents a specification of which property contains the subtitle of the card.| +||[title](/javascript/api/excel/excel.cardlayoutstandardproperties#excel-excel-cardlayoutstandardproperties-title-member)|Represents the title of the card or the specification of which property contains the title of the card.| +|[CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection)|[layout](/javascript/api/excel/excel.cardlayouttablesection#excel-excel-cardlayouttablesection-layout-member)|Represents the type of layout for this section.| +|[CellValueAttributionAttributes](/javascript/api/excel/excel.cellvalueattributionattributes)|[licenseAddress](/javascript/api/excel/excel.cellvalueattributionattributes#excel-excel-cellvalueattributionattributes-licenseaddress-member)|Represents a URL to a license or source that describes how this property can be used.| +||[licenseText](/javascript/api/excel/excel.cellvalueattributionattributes#excel-excel-cellvalueattributionattributes-licensetext-member)|Represents a name for the license that governs this property.| +||[sourceAddress](/javascript/api/excel/excel.cellvalueattributionattributes#excel-excel-cellvalueattributionattributes-sourceaddress-member)|Represents a URL to the source of the `CellValue`.| +||[sourceText](/javascript/api/excel/excel.cellvalueattributionattributes#excel-excel-cellvalueattributionattributes-sourcetext-member)|Represents a name for the source of the `CellValue`.| +|[CellValueExtraProperties](/javascript/api/excel/excel.cellvalueextraproperties)|[writable](/javascript/api/excel/excel.cellvalueextraproperties#excel-excel-cellvalueextraproperties-writable-member)|Represents whether this `CellValue` will be used to overwrite a cell.| +||[writableNote](/javascript/api/excel/excel.cellvalueextraproperties#excel-excel-cellvalueextraproperties-writablenote-member)|Represents an explanation about why `CellValue.writable` is specified as false.| +|[CellValuePropertyMetadata](/javascript/api/excel/excel.cellvaluepropertymetadata)|[attribution](/javascript/api/excel/excel.cellvaluepropertymetadata#excel-excel-cellvaluepropertymetadata-attribution-member)|Represents attribution information to describe the source and license requirements for using this property.| +||[excludeFrom](/javascript/api/excel/excel.cellvaluepropertymetadata#excel-excel-cellvaluepropertymetadata-excludefrom-member)|Represents which features this property is excluded from.| +||[sublabel](/javascript/api/excel/excel.cellvaluepropertymetadata#excel-excel-cellvaluepropertymetadata-sublabel-member)|Represents the sublabel for this property shown in card view.| +|[CellValuePropertyMetadataExclusions](/javascript/api/excel/excel.cellvaluepropertymetadataexclusions)|[autoComplete](/javascript/api/excel/excel.cellvaluepropertymetadataexclusions#excel-excel-cellvaluepropertymetadataexclusions-autocomplete-member)|True represents that the property is excluded from the properties shown by auto complete.| +||[calcCompare](/javascript/api/excel/excel.cellvaluepropertymetadataexclusions#excel-excel-cellvaluepropertymetadataexclusions-calccompare-member)|True represents that the property is excluded from the properties used to compare cell values during recalc.| +||[cardView](/javascript/api/excel/excel.cellvaluepropertymetadataexclusions#excel-excel-cellvaluepropertymetadataexclusions-cardview-member)|True represents that the property is excluded from the properties shown by card view.| +||[dotNotation](/javascript/api/excel/excel.cellvaluepropertymetadataexclusions#excel-excel-cellvaluepropertymetadataexclusions-dotnotation-member)|True represents that the property is excluded from the properties which can be accessed via the FIELDVALUE function.| +|[CellValueProviderAttributes](/javascript/api/excel/excel.cellvalueproviderattributes)|[description](/javascript/api/excel/excel.cellvalueproviderattributes#excel-excel-cellvalueproviderattributes-description-member)|Represents the provider description property that is used in card view if no logo is specified.| +||[logoSourceAddress](/javascript/api/excel/excel.cellvalueproviderattributes#excel-excel-cellvalueproviderattributes-logosourceaddress-member)|Represents a URL used to download an image that will be used as a logo in card view.| +||[logoTargetAddress](/javascript/api/excel/excel.cellvalueproviderattributes#excel-excel-cellvalueproviderattributes-logotargetaddress-member)|Represents a URL that is the navigation target if the user clicks on the logo element in card view.| +|[ChangedEventDetail](/javascript/api/excel/excel.changedeventdetail)|[valueAsJsonAfter](/javascript/api/excel/excel.changedeventdetail#excel-excel-changedeventdetail-valueasjsonafter-member)|Represents the type of value after the change.| +||[valueAsJsonBefore](/javascript/api/excel/excel.changedeventdetail#excel-excel-changedeventdetail-valueasjsonbefore-member)|Represents the type of value before the change.| +|[ChartFill](/javascript/api/excel/excel.chartfill)|[getSolidColor()](/javascript/api/excel/excel.chartfill#excel-excel-chartfill-getsolidcolor-member(1))|Gets the uniform color fill formatting of a chart element.| +|[ConnectErrorCellValue](/javascript/api/excel/excel.connecterrorcellvalue)|[basicType](/javascript/api/excel/excel.connecterrorcellvalue#excel-excel-connecterrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/javascript/api/excel/excel.connecterrorcellvalue#excel-excel-connecterrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[errorSubType](/javascript/api/excel/excel.connecterrorcellvalue#excel-excel-connecterrorcellvalue-errorsubtype-member)|Represents the type of `ConnectErrorCellValue`.| +||[errorType](/javascript/api/excel/excel.connecterrorcellvalue#excel-excel-connecterrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| +||[type](/javascript/api/excel/excel.connecterrorcellvalue#excel-excel-connecterrorcellvalue-type-member)|Represents the type of this cell value.| +|[Div0ErrorCellValue](/javascript/api/excel/excel.div0errorcellvalue)|[basicType](/javascript/api/excel/excel.div0errorcellvalue#excel-excel-div0errorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/javascript/api/excel/excel.div0errorcellvalue#excel-excel-div0errorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[errorType](/javascript/api/excel/excel.div0errorcellvalue#excel-excel-div0errorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| +||[type](/javascript/api/excel/excel.div0errorcellvalue#excel-excel-div0errorcellvalue-type-member)|Represents the type of this cell value.| +|[DoubleCellValue](/javascript/api/excel/excel.doublecellvalue)|[basicType](/javascript/api/excel/excel.doublecellvalue#excel-excel-doublecellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/javascript/api/excel/excel.doublecellvalue#excel-excel-doublecellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[type](/javascript/api/excel/excel.doublecellvalue#excel-excel-doublecellvalue-type-member)|Represents the type of this cell value.| +|[EmptyCellValue](/javascript/api/excel/excel.emptycellvalue)|[basicType](/javascript/api/excel/excel.emptycellvalue#excel-excel-emptycellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/javascript/api/excel/excel.emptycellvalue#excel-excel-emptycellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[type](/javascript/api/excel/excel.emptycellvalue#excel-excel-emptycellvalue-type-member)|Represents the type of this cell value.| +|[EntityCardLayout](/javascript/api/excel/excel.entitycardlayout)|[layout](/javascript/api/excel/excel.entitycardlayout#excel-excel-entitycardlayout-layout-member)|Represents the type of this layout.| +|[EntityCellValue](/javascript/api/excel/excel.entitycellvalue)|[basicType](/javascript/api/excel/excel.entitycellvalue#excel-excel-entitycellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/javascript/api/excel/excel.entitycellvalue#excel-excel-entitycellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[layouts](/javascript/api/excel/excel.entitycellvalue#excel-excel-entitycellvalue-layouts-member)|Represents layout information for views of this entity.| +||[properties](/javascript/api/excel/excel.entitycellvalue#excel-excel-entitycellvalue-properties-member)|Represents the properties of this entity and their metadata.| +||[provider](/javascript/api/excel/excel.entitycellvalue#excel-excel-entitycellvalue-provider-member)|Represents information that describes the service that provided the data in this `EntityCellValue`.| +||[referencedValues](/javascript/api/excel/excel.entitycellvalue#excel-excel-entitycellvalue-referencedvalues-member)|Represents the cell values which are referenced within `EntityCellValue.properties`.| +||[text](/javascript/api/excel/excel.entitycellvalue#excel-excel-entitycellvalue-text-member)|Represents the text shown when a cell with this value is rendered.| +||[type](/javascript/api/excel/excel.entitycellvalue#excel-excel-entitycellvalue-type-member)|Represents the type of this cell value.| +|[EntityCompactLayout](/javascript/api/excel/excel.entitycompactlayout)|[icon](/javascript/api/excel/excel.entitycompactlayout#excel-excel-entitycompactlayout-icon-member)|Specifies the name of the icon which is used to open the card.| +|[EntityPropertyExtraProperties](/javascript/api/excel/excel.entitypropertyextraproperties)|[propertyMetadata](/javascript/api/excel/excel.entitypropertyextraproperties#excel-excel-entitypropertyextraproperties-propertymetadata-member)|Represents metadata about the property.| +|[EntityViewLayouts](/javascript/api/excel/excel.entityviewlayouts)|[card](/javascript/api/excel/excel.entityviewlayouts#excel-excel-entityviewlayouts-card-member)|Represents the layout of this entity in card view.| +||[compact](/javascript/api/excel/excel.entityviewlayouts#excel-excel-entityviewlayouts-compact-member)|Represents the layout used when there is limited space to represent the entity.| +|[ExternalErrorCellValue](/javascript/api/excel/excel.externalerrorcellvalue)|[basicType](/javascript/api/excel/excel.externalerrorcellvalue#excel-excel-externalerrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/javascript/api/excel/excel.externalerrorcellvalue#excel-excel-externalerrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[errorSubType](/javascript/api/excel/excel.externalerrorcellvalue#excel-excel-externalerrorcellvalue-errorsubtype-member)|Represents the type of `ExternalErrorCellValue`.| +||[errorType](/javascript/api/excel/excel.externalerrorcellvalue#excel-excel-externalerrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| +||[type](/javascript/api/excel/excel.externalerrorcellvalue#excel-excel-externalerrorcellvalue-type-member)|Represents the type of this cell value.| +|[FieldErrorCellValue](/javascript/api/excel/excel.fielderrorcellvalue)|[basicType](/javascript/api/excel/excel.fielderrorcellvalue#excel-excel-fielderrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/javascript/api/excel/excel.fielderrorcellvalue#excel-excel-fielderrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[errorSubType](/javascript/api/excel/excel.fielderrorcellvalue#excel-excel-fielderrorcellvalue-errorsubtype-member)|Represents the type of `FieldErrorCellValue`.| +||[errorType](/javascript/api/excel/excel.fielderrorcellvalue#excel-excel-fielderrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| +||[fieldName](/javascript/api/excel/excel.fielderrorcellvalue#excel-excel-fielderrorcellvalue-fieldname-member)|Represents the field which was not found by FIELDVALUE.| +||[type](/javascript/api/excel/excel.fielderrorcellvalue#excel-excel-fielderrorcellvalue-type-member)|Represents the type of this cell value.| +|[GettingDataErrorCellValue](/javascript/api/excel/excel.gettingdataerrorcellvalue)|[basicType](/javascript/api/excel/excel.gettingdataerrorcellvalue#excel-excel-gettingdataerrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/javascript/api/excel/excel.gettingdataerrorcellvalue#excel-excel-gettingdataerrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[errorType](/javascript/api/excel/excel.gettingdataerrorcellvalue#excel-excel-gettingdataerrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| +||[type](/javascript/api/excel/excel.gettingdataerrorcellvalue#excel-excel-gettingdataerrorcellvalue-type-member)|Represents the type of this cell value.| +|[LinkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalue)|[basicType](/javascript/api/excel/excel.linkedentitycellvalue#excel-excel-linkedentitycellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/javascript/api/excel/excel.linkedentitycellvalue#excel-excel-linkedentitycellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[id](/javascript/api/excel/excel.linkedentitycellvalue#excel-excel-linkedentitycellvalue-id-member)|Represents the service source that provided the information in this value.| +||[layouts](/javascript/api/excel/excel.linkedentitycellvalue#excel-excel-linkedentitycellvalue-layouts-member)|Represents layout information for views of this linked entity.| +||[properties](/javascript/api/excel/excel.linkedentitycellvalue#excel-excel-linkedentitycellvalue-properties-member)|Represents the properties of this linked entity and their metadata.| +||[provider](/javascript/api/excel/excel.linkedentitycellvalue#excel-excel-linkedentitycellvalue-provider-member)|Represents information that describes the service that provided data in this `LinkedEntityCellValue`.| +||[text](/javascript/api/excel/excel.linkedentitycellvalue#excel-excel-linkedentitycellvalue-text-member)|Represents the text shown when a cell with this value is rendered.| +||[type](/javascript/api/excel/excel.linkedentitycellvalue#excel-excel-linkedentitycellvalue-type-member)|Represents the type of this cell value.| +|[LinkedEntityId](/javascript/api/excel/excel.linkedentityid)|[culture](/javascript/api/excel/excel.linkedentityid#excel-excel-linkedentityid-culture-member)|Represents which language culture was used to create this `CellValue`.| +||[domainId](/javascript/api/excel/excel.linkedentityid#excel-excel-linkedentityid-domainid-member)|Represents a domain specific to a service used to create the `CellValue`.| +||[entityId](/javascript/api/excel/excel.linkedentityid#excel-excel-linkedentityid-entityid-member)|Represents an identifier specific to a service used to create the `CellValue`.| +||[serviceId](/javascript/api/excel/excel.linkedentityid#excel-excel-linkedentityid-serviceid-member)|Represents which service was used to create the `CellValue`.| +|[NameErrorCellValue](/javascript/api/excel/excel.nameerrorcellvalue)|[basicType](/javascript/api/excel/excel.nameerrorcellvalue#excel-excel-nameerrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/javascript/api/excel/excel.nameerrorcellvalue#excel-excel-nameerrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[errorType](/javascript/api/excel/excel.nameerrorcellvalue#excel-excel-nameerrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| +||[type](/javascript/api/excel/excel.nameerrorcellvalue#excel-excel-nameerrorcellvalue-type-member)|Represents the type of this cell value.| +|[NamedItem](/javascript/api/excel/excel.nameditem)|[valueAsJson](/javascript/api/excel/excel.nameditem#excel-excel-nameditem-valueasjson-member)|A JSON representation of the values in this named item.| +||[valueAsJsonLocal](/javascript/api/excel/excel.nameditem#excel-excel-nameditem-valueasjsonlocal-member)|A JSON representation of the values in this named item.| +|[NamedItemArrayValues](/javascript/api/excel/excel.nameditemarrayvalues)|[valuesAsJson](/javascript/api/excel/excel.nameditemarrayvalues#excel-excel-nameditemarrayvalues-valuesasjson-member)|A JSON representation of the values in this named item array.| +||[valuesAsJsonLocal](/javascript/api/excel/excel.nameditemarrayvalues#excel-excel-nameditemarrayvalues-valuesasjsonlocal-member)|A JSON representation of the values in this named item array.| +|[NotAvailableErrorCellValue](/javascript/api/excel/excel.notavailableerrorcellvalue)|[basicType](/javascript/api/excel/excel.notavailableerrorcellvalue#excel-excel-notavailableerrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/javascript/api/excel/excel.notavailableerrorcellvalue#excel-excel-notavailableerrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[errorType](/javascript/api/excel/excel.notavailableerrorcellvalue#excel-excel-notavailableerrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| +||[type](/javascript/api/excel/excel.notavailableerrorcellvalue#excel-excel-notavailableerrorcellvalue-type-member)|Represents the type of this cell value.| +|[NullErrorCellValue](/javascript/api/excel/excel.nullerrorcellvalue)|[basicType](/javascript/api/excel/excel.nullerrorcellvalue#excel-excel-nullerrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/javascript/api/excel/excel.nullerrorcellvalue#excel-excel-nullerrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[errorType](/javascript/api/excel/excel.nullerrorcellvalue#excel-excel-nullerrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| +||[type](/javascript/api/excel/excel.nullerrorcellvalue#excel-excel-nullerrorcellvalue-type-member)|Represents the type of this cell value.| +|[NumErrorCellValue](/javascript/api/excel/excel.numerrorcellvalue)|[basicType](/javascript/api/excel/excel.numerrorcellvalue#excel-excel-numerrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/javascript/api/excel/excel.numerrorcellvalue#excel-excel-numerrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[errorSubType](/javascript/api/excel/excel.numerrorcellvalue#excel-excel-numerrorcellvalue-errorsubtype-member)|Represents the type of `NumErrorCellValue`.| +||[errorType](/javascript/api/excel/excel.numerrorcellvalue#excel-excel-numerrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| +||[functionName](/javascript/api/excel/excel.numerrorcellvalue#excel-excel-numerrorcellvalue-functionname-member)|Represents the name of the function causing the error.| +||[type](/javascript/api/excel/excel.numerrorcellvalue#excel-excel-numerrorcellvalue-type-member)|Represents the type of this cell value.| +|[PlaceholderErrorCellValue](/javascript/api/excel/excel.placeholdererrorcellvalue)|[basicType](/javascript/api/excel/excel.placeholdererrorcellvalue#excel-excel-placeholdererrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/javascript/api/excel/excel.placeholdererrorcellvalue#excel-excel-placeholdererrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[errorType](/javascript/api/excel/excel.placeholdererrorcellvalue#excel-excel-placeholdererrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| +||[target](/javascript/api/excel/excel.placeholdererrorcellvalue#excel-excel-placeholdererrorcellvalue-target-member)|`PlaceholderErrorCellValue` is used during processing, while data is downloaded.| +||[type](/javascript/api/excel/excel.placeholdererrorcellvalue#excel-excel-placeholdererrorcellvalue-type-member)|Represents the type of this cell value.| +|[Range](/javascript/api/excel/excel.range)|[valuesAsJson](/javascript/api/excel/excel.range#excel-excel-range-valuesasjson-member)|A JSON representation of the values in the cells in this range.| +||[valuesAsJsonLocal](/javascript/api/excel/excel.range#excel-excel-range-valuesasjsonlocal-member)|A JSON representation of the values in the cells in this range.| +|[RangeView](/javascript/api/excel/excel.rangeview)|[valuesAsJson](/javascript/api/excel/excel.rangeview#excel-excel-rangeview-valuesasjson-member)|A JSON representation of the values in the cells in this range.| +||[valuesAsJsonLocal](/javascript/api/excel/excel.rangeview#excel-excel-rangeview-valuesasjsonlocal-member)|A JSON representation of the values in the cells in this range.| +|[RefErrorCellValue](/javascript/api/excel/excel.referrorcellvalue)|[basicType](/javascript/api/excel/excel.referrorcellvalue#excel-excel-referrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/javascript/api/excel/excel.referrorcellvalue#excel-excel-referrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[errorSubType](/javascript/api/excel/excel.referrorcellvalue#excel-excel-referrorcellvalue-errorsubtype-member)|Represents the type of `RefErrorCellValue`.| +||[errorType](/javascript/api/excel/excel.referrorcellvalue#excel-excel-referrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| +||[type](/javascript/api/excel/excel.referrorcellvalue#excel-excel-referrorcellvalue-type-member)|Represents the type of this cell value.| +|[ReferenceCellValue](/javascript/api/excel/excel.referencecellvalue)|[basicType](/javascript/api/excel/excel.referencecellvalue#excel-excel-referencecellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/javascript/api/excel/excel.referencecellvalue#excel-excel-referencecellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[reference](/javascript/api/excel/excel.referencecellvalue#excel-excel-referencecellvalue-reference-member)|Represents the index into the `referencedValues` properties of cell values such as `EntityCellValue` and `ArrayCellValue`.| +||[type](/javascript/api/excel/excel.referencecellvalue#excel-excel-referencecellvalue-type-member)|Represents the type of this cell value.| +|[RootReferenceCellValue](/javascript/api/excel/excel.rootreferencecellvalue)|[basicType](/javascript/api/excel/excel.rootreferencecellvalue#excel-excel-rootreferencecellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/javascript/api/excel/excel.rootreferencecellvalue#excel-excel-rootreferencecellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[type](/javascript/api/excel/excel.rootreferencecellvalue#excel-excel-rootreferencecellvalue-type-member)|Represents the type of this cell value.| +|[SpillErrorCellValue](/javascript/api/excel/excel.spillerrorcellvalue)|[basicType](/javascript/api/excel/excel.spillerrorcellvalue#excel-excel-spillerrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/javascript/api/excel/excel.spillerrorcellvalue#excel-excel-spillerrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[columnCount](/javascript/api/excel/excel.spillerrorcellvalue#excel-excel-spillerrorcellvalue-columncount-member)|Represents the number of columns that would spill if there were no #SPILL! error.| +||[errorSubType](/javascript/api/excel/excel.spillerrorcellvalue#excel-excel-spillerrorcellvalue-errorsubtype-member)|Represents the type of `SpillErrorCellValue`.| +||[errorType](/javascript/api/excel/excel.spillerrorcellvalue#excel-excel-spillerrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| +||[rowCount](/javascript/api/excel/excel.spillerrorcellvalue#excel-excel-spillerrorcellvalue-rowcount-member)|Represents the number of rows that would spill if there were no #SPILL! error.| +||[type](/javascript/api/excel/excel.spillerrorcellvalue#excel-excel-spillerrorcellvalue-type-member)|Represents the type of this cell value.| +|[StringCellValue](/javascript/api/excel/excel.stringcellvalue)|[basicType](/javascript/api/excel/excel.stringcellvalue#excel-excel-stringcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/javascript/api/excel/excel.stringcellvalue#excel-excel-stringcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[type](/javascript/api/excel/excel.stringcellvalue#excel-excel-stringcellvalue-type-member)|Represents the type of this cell value.| +|[TableColumn](/javascript/api/excel/excel.tablecolumn)|[valuesAsJson](/javascript/api/excel/excel.tablecolumn#excel-excel-tablecolumn-valuesasjson-member)|A JSON representation of the values in the cells in this table column.| +||[valuesAsJsonLocal](/javascript/api/excel/excel.tablecolumn#excel-excel-tablecolumn-valuesasjsonlocal-member)|A JSON representation of the values in the cells in this table column.| +|[TableColumnCollection](/javascript/api/excel/excel.tablecolumncollection)|[addAsJson(index?: number, values?: CellValue[][], name?: string)](/javascript/api/excel/excel.tablecolumncollection#excel-excel-tablecolumncollection-addasjson-member(1))|Adds a new column to the table.| +|[TableRow](/javascript/api/excel/excel.tablerow)|[valuesAsJson](/javascript/api/excel/excel.tablerow#excel-excel-tablerow-valuesasjson-member)|A JSON representation of the values in the cells in this table row.| +||[valuesAsJsonLocal](/javascript/api/excel/excel.tablerow#excel-excel-tablerow-valuesasjsonlocal-member)|A JSON representation of the values in the cells in this table row.| +|[TableRowCollection](/javascript/api/excel/excel.tablerowcollection)|[addAsJson(index?: number, values?: CellValue[][], alwaysInsert?: boolean)](/javascript/api/excel/excel.tablerowcollection#excel-excel-tablerowcollection-addasjson-member(1))|Adds one or more rows to the table.| +|[ValueErrorCellValue](/javascript/api/excel/excel.valueerrorcellvalue)|[basicType](/javascript/api/excel/excel.valueerrorcellvalue#excel-excel-valueerrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/javascript/api/excel/excel.valueerrorcellvalue#excel-excel-valueerrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[errorSubType](/javascript/api/excel/excel.valueerrorcellvalue#excel-excel-valueerrorcellvalue-errorsubtype-member)|Represents the type of `ValueErrorCellValue`.| +||[errorType](/javascript/api/excel/excel.valueerrorcellvalue#excel-excel-valueerrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| +||[type](/javascript/api/excel/excel.valueerrorcellvalue#excel-excel-valueerrorcellvalue-type-member)|Represents the type of this cell value.| +|[ValueTypeNotAvailableCellValue](/javascript/api/excel/excel.valuetypenotavailablecellvalue)|[basicType](/javascript/api/excel/excel.valuetypenotavailablecellvalue#excel-excel-valuetypenotavailablecellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/javascript/api/excel/excel.valuetypenotavailablecellvalue#excel-excel-valuetypenotavailablecellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[type](/javascript/api/excel/excel.valuetypenotavailablecellvalue#excel-excel-valuetypenotavailablecellvalue-type-member)|Represents the type of this cell value.| +|[WebImageCellValue](/javascript/api/excel/excel.webimagecellvalue)|[address](/javascript/api/excel/excel.webimagecellvalue#excel-excel-webimagecellvalue-address-member)|Represents the URL from which the image will be downloaded.| +||[altText](/javascript/api/excel/excel.webimagecellvalue#excel-excel-webimagecellvalue-alttext-member)|Represents the alternate text that can be used in accessibility scenarios to describe what the image represents.| +||[attribution](/javascript/api/excel/excel.webimagecellvalue#excel-excel-webimagecellvalue-attribution-member)|Represents attribution information to describe the source and license requirements for using this image.| +||[basicType](/javascript/api/excel/excel.webimagecellvalue#excel-excel-webimagecellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/javascript/api/excel/excel.webimagecellvalue#excel-excel-webimagecellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[provider](/javascript/api/excel/excel.webimagecellvalue#excel-excel-webimagecellvalue-provider-member)|Represents information that describes the entity or individual who provided the image.| +||[relatedImagesAddress](/javascript/api/excel/excel.webimagecellvalue#excel-excel-webimagecellvalue-relatedimagesaddress-member)|Represents the URL of a webpage with images that are considered related to this `WebImageCellValue`.| +||[type](/javascript/api/excel/excel.webimagecellvalue#excel-excel-webimagecellvalue-type-member)|Represents the type of this cell value.| +|[Workbook](/javascript/api/excel/excel.workbook)|[getLinkedEntityCellValue(linkedEntityCellValueId: LinkedEntityId)](/javascript/api/excel/excel.workbook#excel-excel-workbook-getlinkedentitycellvalue-member(1))|Returns a `LinkedEntityCellValue` based on the provided `LinkedEntityId`.| diff --git a/docs/includes/excel-1_17.md b/docs/includes/excel-1_17.md index 18f7ec43d9..d1f861946d 100644 --- a/docs/includes/excel-1_17.md +++ b/docs/includes/excel-1_17.md @@ -1,33 +1,33 @@ | Class | Fields | Description | |:---|:---|:---| -|[ConditionalFormat](/.conditionalformat)|[changeRuleToCellValue(properties: Excel.ConditionalCellValueRule)](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-changeruletocellvalue-member(1))|Change the conditional format rule type to cell value.| -||[changeRuleToColorScale()](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-changeruletocolorscale-member(1))|Change the conditional format rule type to color scale.| -||[changeRuleToContainsText(properties: Excel.ConditionalTextComparisonRule)](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-changeruletocontainstext-member(1))|Change the conditional format rule type to text comparison.| -||[changeRuleToCustom(formula: string)](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-changeruletocustom-member(1))|Change the conditional format rule type to custom.| -||[changeRuleToDataBar()](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-changeruletodatabar-member(1))|Change the conditional format rule type to data bar.| -||[changeRuleToIconSet()](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-changeruletoiconset-member(1))|Change the conditional format rule type to icon set.| -||[changeRuleToPresetCriteria(properties: Excel.ConditionalPresetCriteriaRule)](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-changeruletopresetcriteria-member(1))|Change the conditional format rule type to preset criteria.| -||[changeRuleToTopBottom(properties: Excel.ConditionalTopBottomRule)](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-changeruletotopbottom-member(1))|Change the conditional format rule type to top/bottom.| -||[setRanges(ranges: Range \| RangeAreas \| string)](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-setranges-member(1))|Set the ranges that the conditional format rule is applied to.| -|[ConditionalRangeFormat](/.conditionalrangeformat)|[clearFormat()](/.conditionalrangeformat#excel-javascript/api/excel/-conditionalrangeformat-clearformat-member(1))|Remove the format properties from a conditional format rule.| -|[NumberFormatInfo](/.numberformatinfo)|[currencySymbol](/.numberformatinfo#excel-javascript/api/excel/-numberformatinfo-currencysymbol-member)|Gets the currency symbol for currency values.| -|[Worksheet](/.worksheet)|[onNameChanged](/.worksheet#excel-javascript/api/excel/-worksheet-onnamechanged-member)|Occurs when the worksheet name is changed.| -||[onVisibilityChanged](/.worksheet#excel-javascript/api/excel/-worksheet-onvisibilitychanged-member)|Occurs when the worksheet visibility is changed.| -|[WorksheetCollection](/.worksheetcollection)|[onMoved](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-onmoved-member)|Occurs when a worksheet is moved within a workbook.| -||[onNameChanged](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-onnamechanged-member)|Occurs when the worksheet name is changed in the worksheet collection.| -||[onVisibilityChanged](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-onvisibilitychanged-member)|Occurs when the worksheet visibility is changed in the worksheet collection.| -|[WorksheetMovedEventArgs](/.worksheetmovedeventargs)|[positionAfter](/.worksheetmovedeventargs#excel-javascript/api/excel/-worksheetmovedeventargs-positionafter-member)|Gets the new position of the worksheet, after the move.| -||[positionBefore](/.worksheetmovedeventargs#excel-javascript/api/excel/-worksheetmovedeventargs-positionbefore-member)|Gets the previous position of the worksheet, prior to the move.| -||[source](/.worksheetmovedeventargs#excel-javascript/api/excel/-worksheetmovedeventargs-source-member)|The source of the event.| -||[type](/.worksheetmovedeventargs#excel-javascript/api/excel/-worksheetmovedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/.worksheetmovedeventargs#excel-javascript/api/excel/-worksheetmovedeventargs-worksheetid-member)|Gets the ID of the worksheet that was moved.| -|[WorksheetNameChangedEventArgs](/.worksheetnamechangedeventargs)|[nameAfter](/.worksheetnamechangedeventargs#excel-javascript/api/excel/-worksheetnamechangedeventargs-nameafter-member)|Gets the new name of the worksheet, after the name change.| -||[nameBefore](/.worksheetnamechangedeventargs#excel-javascript/api/excel/-worksheetnamechangedeventargs-namebefore-member)|Gets the previous name of the worksheet, before the name changed.| -||[source](/.worksheetnamechangedeventargs#excel-javascript/api/excel/-worksheetnamechangedeventargs-source-member)|The source of the event.| -||[type](/.worksheetnamechangedeventargs#excel-javascript/api/excel/-worksheetnamechangedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/.worksheetnamechangedeventargs#excel-javascript/api/excel/-worksheetnamechangedeventargs-worksheetid-member)|Gets the ID of the worksheet with the new name.| -|[WorksheetVisibilityChangedEventArgs](/.worksheetvisibilitychangedeventargs)|[source](/.worksheetvisibilitychangedeventargs#excel-javascript/api/excel/-worksheetvisibilitychangedeventargs-source-member)|The source of the event.| -||[type](/.worksheetvisibilitychangedeventargs#excel-javascript/api/excel/-worksheetvisibilitychangedeventargs-type-member)|Gets the type of the event.| -||[visibilityAfter](/.worksheetvisibilitychangedeventargs#excel-javascript/api/excel/-worksheetvisibilitychangedeventargs-visibilityafter-member)|Gets the new visibility setting of the worksheet, after the visibility change.| -||[visibilityBefore](/.worksheetvisibilitychangedeventargs#excel-javascript/api/excel/-worksheetvisibilitychangedeventargs-visibilitybefore-member)|Gets the previous visibility setting of the worksheet, before the visibility change.| -||[worksheetId](/.worksheetvisibilitychangedeventargs#excel-javascript/api/excel/-worksheetvisibilitychangedeventargs-worksheetid-member)|Gets the ID of the worksheet whose visibility has changed.| +|[ConditionalFormat](/javascript/api/excel/excel.conditionalformat)|[changeRuleToCellValue(properties: Excel.ConditionalCellValueRule)](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-changeruletocellvalue-member(1))|Change the conditional format rule type to cell value.| +||[changeRuleToColorScale()](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-changeruletocolorscale-member(1))|Change the conditional format rule type to color scale.| +||[changeRuleToContainsText(properties: Excel.ConditionalTextComparisonRule)](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-changeruletocontainstext-member(1))|Change the conditional format rule type to text comparison.| +||[changeRuleToCustom(formula: string)](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-changeruletocustom-member(1))|Change the conditional format rule type to custom.| +||[changeRuleToDataBar()](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-changeruletodatabar-member(1))|Change the conditional format rule type to data bar.| +||[changeRuleToIconSet()](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-changeruletoiconset-member(1))|Change the conditional format rule type to icon set.| +||[changeRuleToPresetCriteria(properties: Excel.ConditionalPresetCriteriaRule)](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-changeruletopresetcriteria-member(1))|Change the conditional format rule type to preset criteria.| +||[changeRuleToTopBottom(properties: Excel.ConditionalTopBottomRule)](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-changeruletotopbottom-member(1))|Change the conditional format rule type to top/bottom.| +||[setRanges(ranges: Range \| RangeAreas \| string)](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-setranges-member(1))|Set the ranges that the conditional format rule is applied to.| +|[ConditionalRangeFormat](/javascript/api/excel/excel.conditionalrangeformat)|[clearFormat()](/javascript/api/excel/excel.conditionalrangeformat#excel-excel-conditionalrangeformat-clearformat-member(1))|Remove the format properties from a conditional format rule.| +|[NumberFormatInfo](/javascript/api/excel/excel.numberformatinfo)|[currencySymbol](/javascript/api/excel/excel.numberformatinfo#excel-excel-numberformatinfo-currencysymbol-member)|Gets the currency symbol for currency values.| +|[Worksheet](/javascript/api/excel/excel.worksheet)|[onNameChanged](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-onnamechanged-member)|Occurs when the worksheet name is changed.| +||[onVisibilityChanged](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-onvisibilitychanged-member)|Occurs when the worksheet visibility is changed.| +|[WorksheetCollection](/javascript/api/excel/excel.worksheetcollection)|[onMoved](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-onmoved-member)|Occurs when a worksheet is moved within a workbook.| +||[onNameChanged](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-onnamechanged-member)|Occurs when the worksheet name is changed in the worksheet collection.| +||[onVisibilityChanged](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-onvisibilitychanged-member)|Occurs when the worksheet visibility is changed in the worksheet collection.| +|[WorksheetMovedEventArgs](/javascript/api/excel/excel.worksheetmovedeventargs)|[positionAfter](/javascript/api/excel/excel.worksheetmovedeventargs#excel-excel-worksheetmovedeventargs-positionafter-member)|Gets the new position of the worksheet, after the move.| +||[positionBefore](/javascript/api/excel/excel.worksheetmovedeventargs#excel-excel-worksheetmovedeventargs-positionbefore-member)|Gets the previous position of the worksheet, prior to the move.| +||[source](/javascript/api/excel/excel.worksheetmovedeventargs#excel-excel-worksheetmovedeventargs-source-member)|The source of the event.| +||[type](/javascript/api/excel/excel.worksheetmovedeventargs#excel-excel-worksheetmovedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/javascript/api/excel/excel.worksheetmovedeventargs#excel-excel-worksheetmovedeventargs-worksheetid-member)|Gets the ID of the worksheet that was moved.| +|[WorksheetNameChangedEventArgs](/javascript/api/excel/excel.worksheetnamechangedeventargs)|[nameAfter](/javascript/api/excel/excel.worksheetnamechangedeventargs#excel-excel-worksheetnamechangedeventargs-nameafter-member)|Gets the new name of the worksheet, after the name change.| +||[nameBefore](/javascript/api/excel/excel.worksheetnamechangedeventargs#excel-excel-worksheetnamechangedeventargs-namebefore-member)|Gets the previous name of the worksheet, before the name changed.| +||[source](/javascript/api/excel/excel.worksheetnamechangedeventargs#excel-excel-worksheetnamechangedeventargs-source-member)|The source of the event.| +||[type](/javascript/api/excel/excel.worksheetnamechangedeventargs#excel-excel-worksheetnamechangedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/javascript/api/excel/excel.worksheetnamechangedeventargs#excel-excel-worksheetnamechangedeventargs-worksheetid-member)|Gets the ID of the worksheet with the new name.| +|[WorksheetVisibilityChangedEventArgs](/javascript/api/excel/excel.worksheetvisibilitychangedeventargs)|[source](/javascript/api/excel/excel.worksheetvisibilitychangedeventargs#excel-excel-worksheetvisibilitychangedeventargs-source-member)|The source of the event.| +||[type](/javascript/api/excel/excel.worksheetvisibilitychangedeventargs#excel-excel-worksheetvisibilitychangedeventargs-type-member)|Gets the type of the event.| +||[visibilityAfter](/javascript/api/excel/excel.worksheetvisibilitychangedeventargs#excel-excel-worksheetvisibilitychangedeventargs-visibilityafter-member)|Gets the new visibility setting of the worksheet, after the visibility change.| +||[visibilityBefore](/javascript/api/excel/excel.worksheetvisibilitychangedeventargs#excel-excel-worksheetvisibilitychangedeventargs-visibilitybefore-member)|Gets the previous visibility setting of the worksheet, before the visibility change.| +||[worksheetId](/javascript/api/excel/excel.worksheetvisibilitychangedeventargs#excel-excel-worksheetvisibilitychangedeventargs-worksheetid-member)|Gets the ID of the worksheet whose visibility has changed.| diff --git a/docs/includes/excel-1_18.md b/docs/includes/excel-1_18.md index 03dada1f01..2fad74c650 100644 --- a/docs/includes/excel-1_18.md +++ b/docs/includes/excel-1_18.md @@ -1,28 +1,28 @@ | Class | Fields | Description | |:---|:---|:---| -|[CheckboxCellControl](/.checkboxcellcontrol)|[type](/.checkboxcellcontrol#excel-javascript/api/excel/-checkboxcellcontrol-type-member)|Represents an interactable control inside of a cell.| -|[EmptyCellControl](/.emptycellcontrol)|[type](/.emptycellcontrol#excel-javascript/api/excel/-emptycellcontrol-type-member)|| -|[MixedCellControl](/.mixedcellcontrol)|[type](/.mixedcellcontrol#excel-javascript/api/excel/-mixedcellcontrol-type-member)|| -|[Note](/.note)|[authorName](/.note#excel-javascript/api/excel/-note-authorname-member)|Gets the author of the note.| -||[content](/.note#excel-javascript/api/excel/-note-content-member)|Specifies the text of the note.| -||[delete()](/.note#excel-javascript/api/excel/-note-delete-member(1))|Deletes the note.| -||[getLocation()](/.note#excel-javascript/api/excel/-note-getlocation-member(1))|Gets the cell where this note is located.| -||[height](/.note#excel-javascript/api/excel/-note-height-member)|Specifies the height of the note.| -||[visible](/.note#excel-javascript/api/excel/-note-visible-member)|Specifies the visibility of the note.| -||[width](/.note#excel-javascript/api/excel/-note-width-member)|Specifies the width of the note.| -|[NoteCollection](/.notecollection)|[add(cellAddress: Range \| string, content: any)](/.notecollection#excel-javascript/api/excel/-notecollection-add-member(1))|Adds a new note with the given content on the given cell.| -||[getCount()](/.notecollection#excel-javascript/api/excel/-notecollection-getcount-member(1))|Gets the number of notes in the collection.| -||[getItem(key: string)](/.notecollection#excel-javascript/api/excel/-notecollection-getitem-member(1))|Gets a note by its cell address.| -||[getItemAt(index: number)](/.notecollection#excel-javascript/api/excel/-notecollection-getitemat-member(1))|Gets a note from the collection based on its position.| -||[getItemOrNullObject(key: string)](/.notecollection#excel-javascript/api/excel/-notecollection-getitemornullobject-member(1))|Gets a note by its cell address.| -||[items](/.notecollection#excel-javascript/api/excel/-notecollection-items-member)|Gets the loaded child items in this collection.| -|[Range](/.range)|[clearOrResetContents()](/.range#excel-javascript/api/excel/-range-clearorresetcontents-member(1))|Clears the values of the cells in the range, with special consideration given to cells containing controls.| -||[control](/.range#excel-javascript/api/excel/-range-control-member)|Accesses the cell control applied to this range.| -|[RangeAreas](/.rangeareas)|[clearOrResetContents()](/.rangeareas#excel-javascript/api/excel/-rangeareas-clearorresetcontents-member(1))|Clears the values of the cells in the ranges, with special consideration given to cells containing controls.| -||[select()](/.rangeareas#excel-javascript/api/excel/-rangeareas-select-member(1))|Selects the specified range areas in the Excel UI.| -|[RangeTextRun](/.rangetextrun)|[font](/.rangetextrun#excel-javascript/api/excel/-rangetextrun-font-member)|The font attributes (such as font name, font size, and color) applied to this text run.| -||[text](/.rangetextrun#excel-javascript/api/excel/-rangetextrun-text-member)|The text of this text run.| -|[SettableCellProperties](/.settablecellproperties)|[textRuns](/.settablecellproperties#excel-javascript/api/excel/-settablecellproperties-textruns-member)|Represents the `textRuns` property.| -|[UnknownCellControl](/.unknowncellcontrol)|[type](/.unknowncellcontrol#excel-javascript/api/excel/-unknowncellcontrol-type-member)|| -|[Workbook](/.workbook)|[notes](/.workbook#excel-javascript/api/excel/-workbook-notes-member)|Returns a collection of all the notes objects in the workbook.| -|[Worksheet](/.worksheet)|[notes](/.worksheet#excel-javascript/api/excel/-worksheet-notes-member)|Returns a collection of all the notes objects in the worksheet.| +|[CheckboxCellControl](/javascript/api/excel/excel.checkboxcellcontrol)|[type](/javascript/api/excel/excel.checkboxcellcontrol#excel-excel-checkboxcellcontrol-type-member)|Represents an interactable control inside of a cell.| +|[EmptyCellControl](/javascript/api/excel/excel.emptycellcontrol)|[type](/javascript/api/excel/excel.emptycellcontrol#excel-excel-emptycellcontrol-type-member)|| +|[MixedCellControl](/javascript/api/excel/excel.mixedcellcontrol)|[type](/javascript/api/excel/excel.mixedcellcontrol#excel-excel-mixedcellcontrol-type-member)|| +|[Note](/javascript/api/excel/excel.note)|[authorName](/javascript/api/excel/excel.note#excel-excel-note-authorname-member)|Gets the author of the note.| +||[content](/javascript/api/excel/excel.note#excel-excel-note-content-member)|Specifies the text of the note.| +||[delete()](/javascript/api/excel/excel.note#excel-excel-note-delete-member(1))|Deletes the note.| +||[getLocation()](/javascript/api/excel/excel.note#excel-excel-note-getlocation-member(1))|Gets the cell where this note is located.| +||[height](/javascript/api/excel/excel.note#excel-excel-note-height-member)|Specifies the height of the note.| +||[visible](/javascript/api/excel/excel.note#excel-excel-note-visible-member)|Specifies the visibility of the note.| +||[width](/javascript/api/excel/excel.note#excel-excel-note-width-member)|Specifies the width of the note.| +|[NoteCollection](/javascript/api/excel/excel.notecollection)|[add(cellAddress: Range \| string, content: any)](/javascript/api/excel/excel.notecollection#excel-excel-notecollection-add-member(1))|Adds a new note with the given content on the given cell.| +||[getCount()](/javascript/api/excel/excel.notecollection#excel-excel-notecollection-getcount-member(1))|Gets the number of notes in the collection.| +||[getItem(key: string)](/javascript/api/excel/excel.notecollection#excel-excel-notecollection-getitem-member(1))|Gets a note by its cell address.| +||[getItemAt(index: number)](/javascript/api/excel/excel.notecollection#excel-excel-notecollection-getitemat-member(1))|Gets a note from the collection based on its position.| +||[getItemOrNullObject(key: string)](/javascript/api/excel/excel.notecollection#excel-excel-notecollection-getitemornullobject-member(1))|Gets a note by its cell address.| +||[items](/javascript/api/excel/excel.notecollection#excel-excel-notecollection-items-member)|Gets the loaded child items in this collection.| +|[Range](/javascript/api/excel/excel.range)|[clearOrResetContents()](/javascript/api/excel/excel.range#excel-excel-range-clearorresetcontents-member(1))|Clears the values of the cells in the range, with special consideration given to cells containing controls.| +||[control](/javascript/api/excel/excel.range#excel-excel-range-control-member)|Accesses the cell control applied to this range.| +|[RangeAreas](/javascript/api/excel/excel.rangeareas)|[clearOrResetContents()](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-clearorresetcontents-member(1))|Clears the values of the cells in the ranges, with special consideration given to cells containing controls.| +||[select()](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-select-member(1))|Selects the specified range areas in the Excel UI.| +|[RangeTextRun](/javascript/api/excel/excel.rangetextrun)|[font](/javascript/api/excel/excel.rangetextrun#excel-excel-rangetextrun-font-member)|The font attributes (such as font name, font size, and color) applied to this text run.| +||[text](/javascript/api/excel/excel.rangetextrun#excel-excel-rangetextrun-text-member)|The text of this text run.| +|[SettableCellProperties](/javascript/api/excel/excel.settablecellproperties)|[textRuns](/javascript/api/excel/excel.settablecellproperties#excel-excel-settablecellproperties-textruns-member)|Represents the `textRuns` property.| +|[UnknownCellControl](/javascript/api/excel/excel.unknowncellcontrol)|[type](/javascript/api/excel/excel.unknowncellcontrol#excel-excel-unknowncellcontrol-type-member)|| +|[Workbook](/javascript/api/excel/excel.workbook)|[notes](/javascript/api/excel/excel.workbook#excel-excel-workbook-notes-member)|Returns a collection of all the notes objects in the workbook.| +|[Worksheet](/javascript/api/excel/excel.worksheet)|[notes](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-notes-member)|Returns a collection of all the notes objects in the worksheet.| diff --git a/docs/includes/excel-1_19.md b/docs/includes/excel-1_19.md index cb9a1aa076..453e9457c4 100644 --- a/docs/includes/excel-1_19.md +++ b/docs/includes/excel-1_19.md @@ -1,99 +1,99 @@ | Class | Fields | Description | |:---|:---|:---| -|[BasicCardLayout](/.basiccardlayout)|[layout](/.basiccardlayout#excel-javascript/api/excel/-basiccardlayout-layout-member)|Represents the type of this layout.| -|[BasicCompactLayout](/.basiccompactlayout)|[icon](/.basiccompactlayout#excel-javascript/api/excel/-basiccompactlayout-icon-member)|Specifies the name of the icon which is used to open the card.| -|[BasicViewLayouts](/.basicviewlayouts)|[card](/.basicviewlayouts#excel-javascript/api/excel/-basicviewlayouts-card-member)|Represents the layout of this value and its properties in card view.| -||[compact](/.basicviewlayouts#excel-javascript/api/excel/-basicviewlayouts-compact-member)|Represents the layout used when there is limited space to represent the value.| -|[BooleanCellValue](/.booleancellvalue)|[layouts](/.booleancellvalue#excel-javascript/api/excel/-booleancellvalue-layouts-member)|Represents layout information for views of this Boolean value.| -||[properties](/.booleancellvalue#excel-javascript/api/excel/-booleancellvalue-properties-member)|Represents additional properties of this Boolean value.| -||[provider](/.booleancellvalue#excel-javascript/api/excel/-booleancellvalue-provider-member)|Represents information that describes the service that provided the data in this `BooleanCellValue`.| -||[referencedValues](/.booleancellvalue#excel-javascript/api/excel/-booleancellvalue-referencedvalues-member)|Represents the cell values which are referenced within `BooleanCellValue.properties`.| -|[CardLayoutTwoColumnSection](/.cardlayouttwocolumnsection)|[layout](/.cardlayouttwocolumnsection#excel-javascript/api/excel/-cardlayouttwocolumnsection-layout-member)|Represents the type of layout for this section.| -|[ChartDataLabel](/.chartdatalabel)|[geometricShapeType](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-geometricshapetype-member)|Specifies the geometric shape type of the data label.| -||[getSubstring(start: number, length?: number)](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-getsubstring-member(1))|Returns a substring of the data label.| -||[getTailAnchor()](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-gettailanchor-member(1))|Returns the tail anchor of the data label which is shown as a sticky callout.| -||[setHeight(height: number)](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-setheight-member(1))|Sets the height of the data label in points.| -||[setWidth(width: number)](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-setwidth-member(1))|Sets the width of the data label in points.| -||[showAsStickyCallout](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-showasstickycallout-member)|Specifies if the data label is shown as a callout with the tail anchor attached to the data point.| -|[ChartDataLabelAnchor](/.chartdatalabelanchor)|[left](/.chartdatalabelanchor#excel-javascript/api/excel/-chartdatalabelanchor-left-member)|Specifies the distance, in points, from the anchor to the left edge of the chart data label.| -||[top](/.chartdatalabelanchor#excel-javascript/api/excel/-chartdatalabelanchor-top-member)|Specifies the distance, in points, from the anchor to the top edge of the chart data label.| -|[ChartDataLabels](/.chartdatalabels)|[geometricShapeType](/.chartdatalabels#excel-javascript/api/excel/-chartdatalabels-geometricshapetype-member)|Specifies the geometric shape type of the data labels.| -||[leaderLines](/.chartdatalabels#excel-javascript/api/excel/-chartdatalabels-leaderlines-member)|Gets an object that represents the leader lines of the data labels.| -||[showAsStickyCallout](/.chartdatalabels#excel-javascript/api/excel/-chartdatalabels-showasstickycallout-member)|Specifies if the data labels are shown as a callout with the tail anchor attached to the data point.| -||[showLeaderLines](/.chartdatalabels#excel-javascript/api/excel/-chartdatalabels-showleaderlines-member)|Specifies if leader lines are displayed for the data labels.| -|[ChartLeaderLines](/.chartleaderlines)|[format](/.chartleaderlines#excel-javascript/api/excel/-chartleaderlines-format-member)|Represents the formatting of leader lines of data labels in a series.| -|[ChartLeaderLinesFormat](/.chartleaderlinesformat)|[line](/.chartleaderlinesformat#excel-javascript/api/excel/-chartleaderlinesformat-line-member)|Gets an object that represents the line formatting of chart leader lines.| -|[DoubleCellValue](/.doublecellvalue)|[layouts](/.doublecellvalue#excel-javascript/api/excel/-doublecellvalue-layouts-member)|Represents layout information for views of this double value.| -||[numberFormat](/.doublecellvalue#excel-javascript/api/excel/-doublecellvalue-numberformat-member)|Returns the number format string that is used to display this value.| -||[properties](/.doublecellvalue#excel-javascript/api/excel/-doublecellvalue-properties-member)|Represents additional properties of this double value.| -||[provider](/.doublecellvalue#excel-javascript/api/excel/-doublecellvalue-provider-member)|Represents information that describes the service that provided the data in this `DoubleCellValue`.| -||[referencedValues](/.doublecellvalue#excel-javascript/api/excel/-doublecellvalue-referencedvalues-member)|Represents the cell values which are referenced within `DoubleCellValue.properties`.| -|[EntityCompactLayout](/.entitycompactlayout)|[icon](/.entitycompactlayout#excel-javascript/api/excel/-entitycompactlayout-icon-member)|Specifies the name of the icon which is used to open the card.| -|[FormattedNumberCellValue](/.formattednumbercellvalue)|[basicType](/.formattednumbercellvalue#excel-javascript/api/excel/-formattednumbercellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/.formattednumbercellvalue#excel-javascript/api/excel/-formattednumbercellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[numberFormat](/.formattednumbercellvalue#excel-javascript/api/excel/-formattednumbercellvalue-numberformat-member)|Returns the number format string that is used to display this value.| -||[type](/.formattednumbercellvalue#excel-javascript/api/excel/-formattednumbercellvalue-type-member)|Represents the type of this cell value.| -|[JavaScriptCustomFunctionReferenceCellValue](/.javascriptcustomfunctionreferencecellvalue)|[basicType](/.javascriptcustomfunctionreferencecellvalue#excel-javascript/api/excel/-javascriptcustomfunctionreferencecellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/.javascriptcustomfunctionreferencecellvalue#excel-javascript/api/excel/-javascriptcustomfunctionreferencecellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[functionType](/.javascriptcustomfunctionreferencecellvalue#excel-javascript/api/excel/-javascriptcustomfunctionreferencecellvalue-functiontype-member)|Represents the type of `FunctionCellValue`.| -||[id](/.javascriptcustomfunctionreferencecellvalue#excel-javascript/api/excel/-javascriptcustomfunctionreferencecellvalue-id-member)|Represents the ID of the custom function.| -||[namespace](/.javascriptcustomfunctionreferencecellvalue#excel-javascript/api/excel/-javascriptcustomfunctionreferencecellvalue-namespace-member)|Represents the namespace used by the custom function.| -||[type](/.javascriptcustomfunctionreferencecellvalue#excel-javascript/api/excel/-javascriptcustomfunctionreferencecellvalue-type-member)|Represents the type of this cell value.| -|[LinkedEntityDataDomain](/.linkedentitydatadomain)|[dataProvider](/.linkedentitydatadomain#excel-javascript/api/excel/-linkedentitydatadomain-dataprovider-member)|Gets the name of the data provider for the linked entity data domain.| -||[delete()](/.linkedentitydatadomain#excel-javascript/api/excel/-linkedentitydatadomain-delete-member(1))|Deletes this object from the `LinkedEntityDataDomainCollection`.| -||[id](/.linkedentitydatadomain#excel-javascript/api/excel/-linkedentitydatadomain-id-member)|Gets the ID of the linked entity data domain defined by Office Add-ins.| -||[lastRefreshed](/.linkedentitydatadomain#excel-javascript/api/excel/-linkedentitydatadomain-lastrefreshed-member)|Gets the date and time (in the local time zone) since the workbook was opened and the `LinkedEntityCellValue` objects of this linked entity data domain were last refreshed.| -||[loadFunctionId](/.linkedentitydatadomain#excel-javascript/api/excel/-linkedentitydatadomain-loadfunctionid-member)|Gets the ID of the custom function that is called on demand to resolve or refresh the `LinkedEntityCellValue` objects of the linked entity data domain defined by Office Add-ins.| -||[name](/.linkedentitydatadomain#excel-javascript/api/excel/-linkedentitydatadomain-name-member)|Gets the name of the linked entity data domain.| -||[periodicRefreshInterval](/.linkedentitydatadomain#excel-javascript/api/excel/-linkedentitydatadomain-periodicrefreshinterval-member)|Gets the frequency, in seconds, at which `LinkedEntityCellValue` objects of this linked entity data domain are refreshed automatically.| -||[refresh()](/.linkedentitydatadomain#excel-javascript/api/excel/-linkedentitydatadomain-refresh-member(1))|Refreshes all `LinkedEntityCellValue` objects of this linked entity data domain.| -||[refreshMode](/.linkedentitydatadomain#excel-javascript/api/excel/-linkedentitydatadomain-refreshmode-member)|Specifies the refresh mode that defines how and when the `LinkedEntityCellValue` objects of this linked entity data domain are refreshed.| -||[serviceId](/.linkedentitydatadomain#excel-javascript/api/excel/-linkedentitydatadomain-serviceid-member)|Gets the service ID of the linked entity data domain.| -||[supportedRefreshModes](/.linkedentitydatadomain#excel-javascript/api/excel/-linkedentitydatadomain-supportedrefreshmodes-member)|Gets all the refresh modes supported by the linked entity data domain.| -|[LinkedEntityDataDomainAddedEventArgs](/.linkedentitydatadomainaddedeventargs)|[id](/.linkedentitydatadomainaddedeventargs#excel-javascript/api/excel/-linkedentitydatadomainaddedeventargs-id-member)|Gets the ID of the linked entity data domain that was just added to the workbook.| -||[serviceId](/.linkedentitydatadomainaddedeventargs#excel-javascript/api/excel/-linkedentitydatadomainaddedeventargs-serviceid-member)|Gets the service ID of the linked entity data domain that was just added to the workbook.| -||[source](/.linkedentitydatadomainaddedeventargs#excel-javascript/api/excel/-linkedentitydatadomainaddedeventargs-source-member)|Gets the source of the event.| -||[type](/.linkedentitydatadomainaddedeventargs#excel-javascript/api/excel/-linkedentitydatadomainaddedeventargs-type-member)|Gets the type of the event.| -|[LinkedEntityDataDomainCollection](/.linkedentitydatadomaincollection)|[add(options: Excel.LinkedEntityDataDomainCreateOptions)](/.linkedentitydatadomaincollection#excel-javascript/api/excel/-linkedentitydatadomaincollection-add-member(1))|Adds a linked entity data domain object defined by the Office Add-in to the collection.| -||[getCount()](/.linkedentitydatadomaincollection#excel-javascript/api/excel/-linkedentitydatadomaincollection-getcount-member(1))|Gets the number of linked entity data domains in the collection.| -||[getItem(id: string)](/.linkedentitydatadomaincollection#excel-javascript/api/excel/-linkedentitydatadomaincollection-getitem-member(1))|Gets a linked entity data domain by its `id`.| -||[getItemAt(index: number)](/.linkedentitydatadomaincollection#excel-javascript/api/excel/-linkedentitydatadomaincollection-getitemat-member(1))|Gets a linked entity data domain by its index in the collection.| -||[getItemByName(name: string)](/.linkedentitydatadomaincollection#excel-javascript/api/excel/-linkedentitydatadomaincollection-getitembyname-member(1))|Gets a linked entity data domain by its `name`.| -||[getItemByNameOrNullObject(name: string)](/.linkedentitydatadomaincollection#excel-javascript/api/excel/-linkedentitydatadomaincollection-getitembynameornullobject-member(1))|Gets a linked entity data domain by its `name`.| -||[getItemOrNullObject(id: string)](/.linkedentitydatadomaincollection#excel-javascript/api/excel/-linkedentitydatadomaincollection-getitemornullobject-member(1))|Gets a linked entity data domain by its `id`.| -||[items](/.linkedentitydatadomaincollection#excel-javascript/api/excel/-linkedentitydatadomaincollection-items-member)|Gets the loaded child items in this collection.| -||[onLinkedEntityDataDomainAdded](/.linkedentitydatadomaincollection#excel-javascript/api/excel/-linkedentitydatadomaincollection-onlinkedentitydatadomainadded-member)|Occurs when a new linked entity data domain is added to the workbook.| -||[onRefreshCompleted](/.linkedentitydatadomaincollection#excel-javascript/api/excel/-linkedentitydatadomaincollection-onrefreshcompleted-member)|Occurs when the request to refresh `LinkedEntityCellValue` objects of a linked entity data domain is completed.| -||[onRefreshModeChanged](/.linkedentitydatadomaincollection#excel-javascript/api/excel/-linkedentitydatadomaincollection-onrefreshmodechanged-member)|Occurs when the `refreshMode` of a linked entity data domain is changed.| -||[refreshAll()](/.linkedentitydatadomaincollection#excel-javascript/api/excel/-linkedentitydatadomaincollection-refreshall-member(1))|Refreshes all `LinkedEntityCellValue` objects of all linked entity data domains in this collection.| -|[LinkedEntityDataDomainCreateOptions](/.linkedentitydatadomaincreateoptions)|[dataProvider](/.linkedentitydatadomaincreateoptions#excel-javascript/api/excel/-linkedentitydatadomaincreateoptions-dataprovider-member)|Specifies the name of the data provider for the linked entity data domain.| -||[id](/.linkedentitydatadomaincreateoptions#excel-javascript/api/excel/-linkedentitydatadomaincreateoptions-id-member)|Specifies the ID of the linked entity data domain.| -||[loadFunctionId](/.linkedentitydatadomaincreateoptions#excel-javascript/api/excel/-linkedentitydatadomaincreateoptions-loadfunctionid-member)|Specifies the ID of the custom function that will be called on demand to resolve or refresh the `LinkedEntityCellValue` objects of this linked entity data domain.| -||[name](/.linkedentitydatadomaincreateoptions#excel-javascript/api/excel/-linkedentitydatadomaincreateoptions-name-member)|Specifies the name of the linked entity data domain.| -||[periodicRefreshInterval](/.linkedentitydatadomaincreateoptions#excel-javascript/api/excel/-linkedentitydatadomaincreateoptions-periodicrefreshinterval-member)|Specifies the frequency, in seconds, at which `LinkedEntityCellValue` objects of this linked entity data domain are refreshed automatically.| -||[supportedRefreshModes](/.linkedentitydatadomaincreateoptions#excel-javascript/api/excel/-linkedentitydatadomaincreateoptions-supportedrefreshmodes-member)|Specifies all the refresh modes supported by the linked entity data domain.| -|[LinkedEntityDataDomainRefreshCompletedEventArgs](/.linkedentitydatadomainrefreshcompletedeventargs)|[errors](/.linkedentitydatadomainrefreshcompletedeventargs#excel-javascript/api/excel/-linkedentitydatadomainrefreshcompletedeventargs-errors-member)|Gets any errors encountered during the request to refresh `LinkedEntityCellValue` objects of the linked entity data domain.| -||[id](/.linkedentitydatadomainrefreshcompletedeventargs#excel-javascript/api/excel/-linkedentitydatadomainrefreshcompletedeventargs-id-member)|Gets the ID of the linked entity data domain whose `LinkedEntityCellValue` objects were refreshed.| -||[refreshed](/.linkedentitydatadomainrefreshcompletedeventargs#excel-javascript/api/excel/-linkedentitydatadomainrefreshcompletedeventargs-refreshed-member)|Returns `true` if the `LinkedEntityCellValue` objects of the linked entity data domain were refreshed successfully, otherwise returns `false`.| -||[serviceId](/.linkedentitydatadomainrefreshcompletedeventargs#excel-javascript/api/excel/-linkedentitydatadomainrefreshcompletedeventargs-serviceid-member)|Gets the service ID of the linked entity data domain whose `LinkedEntityCellValue` objects were refreshed.| -||[source](/.linkedentitydatadomainrefreshcompletedeventargs#excel-javascript/api/excel/-linkedentitydatadomainrefreshcompletedeventargs-source-member)|Gets the source of the event.| -||[type](/.linkedentitydatadomainrefreshcompletedeventargs#excel-javascript/api/excel/-linkedentitydatadomainrefreshcompletedeventargs-type-member)|Gets the type of the event.| -|[LinkedEntityDataDomainRefreshModeChangedEventArgs](/.linkedentitydatadomainrefreshmodechangedeventargs)|[id](/.linkedentitydatadomainrefreshmodechangedeventargs#excel-javascript/api/excel/-linkedentitydatadomainrefreshmodechangedeventargs-id-member)|Gets the ID of the linked entity data domain whose refresh mode was changed.| -||[refreshMode](/.linkedentitydatadomainrefreshmodechangedeventargs#excel-javascript/api/excel/-linkedentitydatadomainrefreshmodechangedeventargs-refreshmode-member)|Gets the new refresh mode of the linked entity data domain.| -||[serviceId](/.linkedentitydatadomainrefreshmodechangedeventargs#excel-javascript/api/excel/-linkedentitydatadomainrefreshmodechangedeventargs-serviceid-member)|Gets the service ID of the linked entity data domain whose refresh mode was changed.| -||[source](/.linkedentitydatadomainrefreshmodechangedeventargs#excel-javascript/api/excel/-linkedentitydatadomainrefreshmodechangedeventargs-source-member)|Gets the source of the event.| -||[type](/.linkedentitydatadomainrefreshmodechangedeventargs#excel-javascript/api/excel/-linkedentitydatadomainrefreshmodechangedeventargs-type-member)|Gets the type of the event.| -|[LinkedEntityIdCulture](/.linkedentityidculture)|[culture](/.linkedentityidculture#excel-javascript/api/excel/-linkedentityidculture-culture-member)|Represents the language culture used to create the `LinkedEntityCellValue` object.| -||[entityId](/.linkedentityidculture#excel-javascript/api/excel/-linkedentityidculture-entityid-member)|Represents the identifier specific to a service used to create the `LinkedEntityCellValue` object.| -|[LinkedEntityLoadServiceRequest](/.linkedentityloadservicerequest)|[domainId](/.linkedentityloadservicerequest#excel-javascript/api/excel/-linkedentityloadservicerequest-domainid-member)|Represents the domain specific to the service used to create the `LinkedEntityCellValue` objects.| -||[entities](/.linkedentityloadservicerequest#excel-javascript/api/excel/-linkedentityloadservicerequest-entities-member)|Represents the entity IDs and cultures of the `LinkedEntityCellValue` objects to load.| -|[LinkedEntityLoadServiceResult](/.linkedentityloadserviceresult)|[entities](/.linkedentityloadserviceresult#excel-javascript/api/excel/-linkedentityloadserviceresult-entities-member)|Represents the loaded `LinkedEntityCellValue` objects.| -|[Range](/.range)|[getDisplayedCellProperties(cellPropertiesLoadOptions: CellPropertiesLoadOptions)](/.range#excel-javascript/api/excel/-range-getdisplayedcellproperties-member(1))|Returns a 2D array, encapsulating the display data for each cell's font, fill, borders, alignment, and other properties.| -|[StringCellValue](/.stringcellvalue)|[layouts](/.stringcellvalue#excel-javascript/api/excel/-stringcellvalue-layouts-member)|Represents layout information for views of this string value.| -||[properties](/.stringcellvalue#excel-javascript/api/excel/-stringcellvalue-properties-member)|Represents additional properties of this string value.| -||[provider](/.stringcellvalue#excel-javascript/api/excel/-stringcellvalue-provider-member)|Represents information that describes the service that provided the data in this `StringCellValue`.| -||[referencedValues](/.stringcellvalue#excel-javascript/api/excel/-stringcellvalue-referencedvalues-member)|Represents the cell values which are referenced within `StringCellValue.properties`.| -|[Workbook](/.workbook)|[getActiveShape()](/.workbook#excel-javascript/api/excel/-workbook-getactiveshape-member(1))|Gets the active shape in the workbook.| -||[getActiveShapeOrNullObject()](/.workbook#excel-javascript/api/excel/-workbook-getactiveshapeornullobject-member(1))|Gets the active shape in the workbook.| -||[linkedEntityDataDomains](/.workbook#excel-javascript/api/excel/-workbook-linkedentitydatadomains-member)|Returns a collection of linked entity data domains that are available in the workbook.| -|[Worksheet](/.worksheet)|[showDataTypeIcons](/.worksheet#excel-javascript/api/excel/-worksheet-showdatatypeicons-member)|Specifies if data type icons are visible on the worksheet.| +|[BasicCardLayout](/javascript/api/excel/excel.basiccardlayout)|[layout](/javascript/api/excel/excel.basiccardlayout#excel-excel-basiccardlayout-layout-member)|Represents the type of this layout.| +|[BasicCompactLayout](/javascript/api/excel/excel.basiccompactlayout)|[icon](/javascript/api/excel/excel.basiccompactlayout#excel-excel-basiccompactlayout-icon-member)|Specifies the name of the icon which is used to open the card.| +|[BasicViewLayouts](/javascript/api/excel/excel.basicviewlayouts)|[card](/javascript/api/excel/excel.basicviewlayouts#excel-excel-basicviewlayouts-card-member)|Represents the layout of this value and its properties in card view.| +||[compact](/javascript/api/excel/excel.basicviewlayouts#excel-excel-basicviewlayouts-compact-member)|Represents the layout used when there is limited space to represent the value.| +|[BooleanCellValue](/javascript/api/excel/excel.booleancellvalue)|[layouts](/javascript/api/excel/excel.booleancellvalue#excel-excel-booleancellvalue-layouts-member)|Represents layout information for views of this Boolean value.| +||[properties](/javascript/api/excel/excel.booleancellvalue#excel-excel-booleancellvalue-properties-member)|Represents additional properties of this Boolean value.| +||[provider](/javascript/api/excel/excel.booleancellvalue#excel-excel-booleancellvalue-provider-member)|Represents information that describes the service that provided the data in this `BooleanCellValue`.| +||[referencedValues](/javascript/api/excel/excel.booleancellvalue#excel-excel-booleancellvalue-referencedvalues-member)|Represents the cell values which are referenced within `BooleanCellValue.properties`.| +|[CardLayoutTwoColumnSection](/javascript/api/excel/excel.cardlayouttwocolumnsection)|[layout](/javascript/api/excel/excel.cardlayouttwocolumnsection#excel-excel-cardlayouttwocolumnsection-layout-member)|Represents the type of layout for this section.| +|[ChartDataLabel](/javascript/api/excel/excel.chartdatalabel)|[geometricShapeType](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-geometricshapetype-member)|Specifies the geometric shape type of the data label.| +||[getSubstring(start: number, length?: number)](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-getsubstring-member(1))|Returns a substring of the data label.| +||[getTailAnchor()](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-gettailanchor-member(1))|Returns the tail anchor of the data label which is shown as a sticky callout.| +||[setHeight(height: number)](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-setheight-member(1))|Sets the height of the data label in points.| +||[setWidth(width: number)](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-setwidth-member(1))|Sets the width of the data label in points.| +||[showAsStickyCallout](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-showasstickycallout-member)|Specifies if the data label is shown as a callout with the tail anchor attached to the data point.| +|[ChartDataLabelAnchor](/javascript/api/excel/excel.chartdatalabelanchor)|[left](/javascript/api/excel/excel.chartdatalabelanchor#excel-excel-chartdatalabelanchor-left-member)|Specifies the distance, in points, from the anchor to the left edge of the chart data label.| +||[top](/javascript/api/excel/excel.chartdatalabelanchor#excel-excel-chartdatalabelanchor-top-member)|Specifies the distance, in points, from the anchor to the top edge of the chart data label.| +|[ChartDataLabels](/javascript/api/excel/excel.chartdatalabels)|[geometricShapeType](/javascript/api/excel/excel.chartdatalabels#excel-excel-chartdatalabels-geometricshapetype-member)|Specifies the geometric shape type of the data labels.| +||[leaderLines](/javascript/api/excel/excel.chartdatalabels#excel-excel-chartdatalabels-leaderlines-member)|Gets an object that represents the leader lines of the data labels.| +||[showAsStickyCallout](/javascript/api/excel/excel.chartdatalabels#excel-excel-chartdatalabels-showasstickycallout-member)|Specifies if the data labels are shown as a callout with the tail anchor attached to the data point.| +||[showLeaderLines](/javascript/api/excel/excel.chartdatalabels#excel-excel-chartdatalabels-showleaderlines-member)|Specifies if leader lines are displayed for the data labels.| +|[ChartLeaderLines](/javascript/api/excel/excel.chartleaderlines)|[format](/javascript/api/excel/excel.chartleaderlines#excel-excel-chartleaderlines-format-member)|Represents the formatting of leader lines of data labels in a series.| +|[ChartLeaderLinesFormat](/javascript/api/excel/excel.chartleaderlinesformat)|[line](/javascript/api/excel/excel.chartleaderlinesformat#excel-excel-chartleaderlinesformat-line-member)|Gets an object that represents the line formatting of chart leader lines.| +|[DoubleCellValue](/javascript/api/excel/excel.doublecellvalue)|[layouts](/javascript/api/excel/excel.doublecellvalue#excel-excel-doublecellvalue-layouts-member)|Represents layout information for views of this double value.| +||[numberFormat](/javascript/api/excel/excel.doublecellvalue#excel-excel-doublecellvalue-numberformat-member)|Returns the number format string that is used to display this value.| +||[properties](/javascript/api/excel/excel.doublecellvalue#excel-excel-doublecellvalue-properties-member)|Represents additional properties of this double value.| +||[provider](/javascript/api/excel/excel.doublecellvalue#excel-excel-doublecellvalue-provider-member)|Represents information that describes the service that provided the data in this `DoubleCellValue`.| +||[referencedValues](/javascript/api/excel/excel.doublecellvalue#excel-excel-doublecellvalue-referencedvalues-member)|Represents the cell values which are referenced within `DoubleCellValue.properties`.| +|[EntityCompactLayout](/javascript/api/excel/excel.entitycompactlayout)|[icon](/javascript/api/excel/excel.entitycompactlayout#excel-excel-entitycompactlayout-icon-member)|Specifies the name of the icon which is used to open the card.| +|[FormattedNumberCellValue](/javascript/api/excel/excel.formattednumbercellvalue)|[basicType](/javascript/api/excel/excel.formattednumbercellvalue#excel-excel-formattednumbercellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/javascript/api/excel/excel.formattednumbercellvalue#excel-excel-formattednumbercellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[numberFormat](/javascript/api/excel/excel.formattednumbercellvalue#excel-excel-formattednumbercellvalue-numberformat-member)|Returns the number format string that is used to display this value.| +||[type](/javascript/api/excel/excel.formattednumbercellvalue#excel-excel-formattednumbercellvalue-type-member)|Represents the type of this cell value.| +|[JavaScriptCustomFunctionReferenceCellValue](/javascript/api/excel/excel.javascriptcustomfunctionreferencecellvalue)|[basicType](/javascript/api/excel/excel.javascriptcustomfunctionreferencecellvalue#excel-excel-javascriptcustomfunctionreferencecellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/javascript/api/excel/excel.javascriptcustomfunctionreferencecellvalue#excel-excel-javascriptcustomfunctionreferencecellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[functionType](/javascript/api/excel/excel.javascriptcustomfunctionreferencecellvalue#excel-excel-javascriptcustomfunctionreferencecellvalue-functiontype-member)|Represents the type of `FunctionCellValue`.| +||[id](/javascript/api/excel/excel.javascriptcustomfunctionreferencecellvalue#excel-excel-javascriptcustomfunctionreferencecellvalue-id-member)|Represents the ID of the custom function.| +||[namespace](/javascript/api/excel/excel.javascriptcustomfunctionreferencecellvalue#excel-excel-javascriptcustomfunctionreferencecellvalue-namespace-member)|Represents the namespace used by the custom function.| +||[type](/javascript/api/excel/excel.javascriptcustomfunctionreferencecellvalue#excel-excel-javascriptcustomfunctionreferencecellvalue-type-member)|Represents the type of this cell value.| +|[LinkedEntityDataDomain](/javascript/api/excel/excel.linkedentitydatadomain)|[dataProvider](/javascript/api/excel/excel.linkedentitydatadomain#excel-excel-linkedentitydatadomain-dataprovider-member)|Gets the name of the data provider for the linked entity data domain.| +||[delete()](/javascript/api/excel/excel.linkedentitydatadomain#excel-excel-linkedentitydatadomain-delete-member(1))|Deletes this object from the `LinkedEntityDataDomainCollection`.| +||[id](/javascript/api/excel/excel.linkedentitydatadomain#excel-excel-linkedentitydatadomain-id-member)|Gets the ID of the linked entity data domain defined by Office Add-ins.| +||[lastRefreshed](/javascript/api/excel/excel.linkedentitydatadomain#excel-excel-linkedentitydatadomain-lastrefreshed-member)|Gets the date and time (in the local time zone) since the workbook was opened and the `LinkedEntityCellValue` objects of this linked entity data domain were last refreshed.| +||[loadFunctionId](/javascript/api/excel/excel.linkedentitydatadomain#excel-excel-linkedentitydatadomain-loadfunctionid-member)|Gets the ID of the custom function that is called on demand to resolve or refresh the `LinkedEntityCellValue` objects of the linked entity data domain defined by Office Add-ins.| +||[name](/javascript/api/excel/excel.linkedentitydatadomain#excel-excel-linkedentitydatadomain-name-member)|Gets the name of the linked entity data domain.| +||[periodicRefreshInterval](/javascript/api/excel/excel.linkedentitydatadomain#excel-excel-linkedentitydatadomain-periodicrefreshinterval-member)|Gets the frequency, in seconds, at which `LinkedEntityCellValue` objects of this linked entity data domain are refreshed automatically.| +||[refresh()](/javascript/api/excel/excel.linkedentitydatadomain#excel-excel-linkedentitydatadomain-refresh-member(1))|Refreshes all `LinkedEntityCellValue` objects of this linked entity data domain.| +||[refreshMode](/javascript/api/excel/excel.linkedentitydatadomain#excel-excel-linkedentitydatadomain-refreshmode-member)|Specifies the refresh mode that defines how and when the `LinkedEntityCellValue` objects of this linked entity data domain are refreshed.| +||[serviceId](/javascript/api/excel/excel.linkedentitydatadomain#excel-excel-linkedentitydatadomain-serviceid-member)|Gets the service ID of the linked entity data domain.| +||[supportedRefreshModes](/javascript/api/excel/excel.linkedentitydatadomain#excel-excel-linkedentitydatadomain-supportedrefreshmodes-member)|Gets all the refresh modes supported by the linked entity data domain.| +|[LinkedEntityDataDomainAddedEventArgs](/javascript/api/excel/excel.linkedentitydatadomainaddedeventargs)|[id](/javascript/api/excel/excel.linkedentitydatadomainaddedeventargs#excel-excel-linkedentitydatadomainaddedeventargs-id-member)|Gets the ID of the linked entity data domain that was just added to the workbook.| +||[serviceId](/javascript/api/excel/excel.linkedentitydatadomainaddedeventargs#excel-excel-linkedentitydatadomainaddedeventargs-serviceid-member)|Gets the service ID of the linked entity data domain that was just added to the workbook.| +||[source](/javascript/api/excel/excel.linkedentitydatadomainaddedeventargs#excel-excel-linkedentitydatadomainaddedeventargs-source-member)|Gets the source of the event.| +||[type](/javascript/api/excel/excel.linkedentitydatadomainaddedeventargs#excel-excel-linkedentitydatadomainaddedeventargs-type-member)|Gets the type of the event.| +|[LinkedEntityDataDomainCollection](/javascript/api/excel/excel.linkedentitydatadomaincollection)|[add(options: Excel.LinkedEntityDataDomainCreateOptions)](/javascript/api/excel/excel.linkedentitydatadomaincollection#excel-excel-linkedentitydatadomaincollection-add-member(1))|Adds a linked entity data domain object defined by the Office Add-in to the collection.| +||[getCount()](/javascript/api/excel/excel.linkedentitydatadomaincollection#excel-excel-linkedentitydatadomaincollection-getcount-member(1))|Gets the number of linked entity data domains in the collection.| +||[getItem(id: string)](/javascript/api/excel/excel.linkedentitydatadomaincollection#excel-excel-linkedentitydatadomaincollection-getitem-member(1))|Gets a linked entity data domain by its `id`.| +||[getItemAt(index: number)](/javascript/api/excel/excel.linkedentitydatadomaincollection#excel-excel-linkedentitydatadomaincollection-getitemat-member(1))|Gets a linked entity data domain by its index in the collection.| +||[getItemByName(name: string)](/javascript/api/excel/excel.linkedentitydatadomaincollection#excel-excel-linkedentitydatadomaincollection-getitembyname-member(1))|Gets a linked entity data domain by its `name`.| +||[getItemByNameOrNullObject(name: string)](/javascript/api/excel/excel.linkedentitydatadomaincollection#excel-excel-linkedentitydatadomaincollection-getitembynameornullobject-member(1))|Gets a linked entity data domain by its `name`.| +||[getItemOrNullObject(id: string)](/javascript/api/excel/excel.linkedentitydatadomaincollection#excel-excel-linkedentitydatadomaincollection-getitemornullobject-member(1))|Gets a linked entity data domain by its `id`.| +||[items](/javascript/api/excel/excel.linkedentitydatadomaincollection#excel-excel-linkedentitydatadomaincollection-items-member)|Gets the loaded child items in this collection.| +||[onLinkedEntityDataDomainAdded](/javascript/api/excel/excel.linkedentitydatadomaincollection#excel-excel-linkedentitydatadomaincollection-onlinkedentitydatadomainadded-member)|Occurs when a new linked entity data domain is added to the workbook.| +||[onRefreshCompleted](/javascript/api/excel/excel.linkedentitydatadomaincollection#excel-excel-linkedentitydatadomaincollection-onrefreshcompleted-member)|Occurs when the request to refresh `LinkedEntityCellValue` objects of a linked entity data domain is completed.| +||[onRefreshModeChanged](/javascript/api/excel/excel.linkedentitydatadomaincollection#excel-excel-linkedentitydatadomaincollection-onrefreshmodechanged-member)|Occurs when the `refreshMode` of a linked entity data domain is changed.| +||[refreshAll()](/javascript/api/excel/excel.linkedentitydatadomaincollection#excel-excel-linkedentitydatadomaincollection-refreshall-member(1))|Refreshes all `LinkedEntityCellValue` objects of all linked entity data domains in this collection.| +|[LinkedEntityDataDomainCreateOptions](/javascript/api/excel/excel.linkedentitydatadomaincreateoptions)|[dataProvider](/javascript/api/excel/excel.linkedentitydatadomaincreateoptions#excel-excel-linkedentitydatadomaincreateoptions-dataprovider-member)|Specifies the name of the data provider for the linked entity data domain.| +||[id](/javascript/api/excel/excel.linkedentitydatadomaincreateoptions#excel-excel-linkedentitydatadomaincreateoptions-id-member)|Specifies the ID of the linked entity data domain.| +||[loadFunctionId](/javascript/api/excel/excel.linkedentitydatadomaincreateoptions#excel-excel-linkedentitydatadomaincreateoptions-loadfunctionid-member)|Specifies the ID of the custom function that will be called on demand to resolve or refresh the `LinkedEntityCellValue` objects of this linked entity data domain.| +||[name](/javascript/api/excel/excel.linkedentitydatadomaincreateoptions#excel-excel-linkedentitydatadomaincreateoptions-name-member)|Specifies the name of the linked entity data domain.| +||[periodicRefreshInterval](/javascript/api/excel/excel.linkedentitydatadomaincreateoptions#excel-excel-linkedentitydatadomaincreateoptions-periodicrefreshinterval-member)|Specifies the frequency, in seconds, at which `LinkedEntityCellValue` objects of this linked entity data domain are refreshed automatically.| +||[supportedRefreshModes](/javascript/api/excel/excel.linkedentitydatadomaincreateoptions#excel-excel-linkedentitydatadomaincreateoptions-supportedrefreshmodes-member)|Specifies all the refresh modes supported by the linked entity data domain.| +|[LinkedEntityDataDomainRefreshCompletedEventArgs](/javascript/api/excel/excel.linkedentitydatadomainrefreshcompletedeventargs)|[errors](/javascript/api/excel/excel.linkedentitydatadomainrefreshcompletedeventargs#excel-excel-linkedentitydatadomainrefreshcompletedeventargs-errors-member)|Gets any errors encountered during the request to refresh `LinkedEntityCellValue` objects of the linked entity data domain.| +||[id](/javascript/api/excel/excel.linkedentitydatadomainrefreshcompletedeventargs#excel-excel-linkedentitydatadomainrefreshcompletedeventargs-id-member)|Gets the ID of the linked entity data domain whose `LinkedEntityCellValue` objects were refreshed.| +||[refreshed](/javascript/api/excel/excel.linkedentitydatadomainrefreshcompletedeventargs#excel-excel-linkedentitydatadomainrefreshcompletedeventargs-refreshed-member)|Returns `true` if the `LinkedEntityCellValue` objects of the linked entity data domain were refreshed successfully, otherwise returns `false`.| +||[serviceId](/javascript/api/excel/excel.linkedentitydatadomainrefreshcompletedeventargs#excel-excel-linkedentitydatadomainrefreshcompletedeventargs-serviceid-member)|Gets the service ID of the linked entity data domain whose `LinkedEntityCellValue` objects were refreshed.| +||[source](/javascript/api/excel/excel.linkedentitydatadomainrefreshcompletedeventargs#excel-excel-linkedentitydatadomainrefreshcompletedeventargs-source-member)|Gets the source of the event.| +||[type](/javascript/api/excel/excel.linkedentitydatadomainrefreshcompletedeventargs#excel-excel-linkedentitydatadomainrefreshcompletedeventargs-type-member)|Gets the type of the event.| +|[LinkedEntityDataDomainRefreshModeChangedEventArgs](/javascript/api/excel/excel.linkedentitydatadomainrefreshmodechangedeventargs)|[id](/javascript/api/excel/excel.linkedentitydatadomainrefreshmodechangedeventargs#excel-excel-linkedentitydatadomainrefreshmodechangedeventargs-id-member)|Gets the ID of the linked entity data domain whose refresh mode was changed.| +||[refreshMode](/javascript/api/excel/excel.linkedentitydatadomainrefreshmodechangedeventargs#excel-excel-linkedentitydatadomainrefreshmodechangedeventargs-refreshmode-member)|Gets the new refresh mode of the linked entity data domain.| +||[serviceId](/javascript/api/excel/excel.linkedentitydatadomainrefreshmodechangedeventargs#excel-excel-linkedentitydatadomainrefreshmodechangedeventargs-serviceid-member)|Gets the service ID of the linked entity data domain whose refresh mode was changed.| +||[source](/javascript/api/excel/excel.linkedentitydatadomainrefreshmodechangedeventargs#excel-excel-linkedentitydatadomainrefreshmodechangedeventargs-source-member)|Gets the source of the event.| +||[type](/javascript/api/excel/excel.linkedentitydatadomainrefreshmodechangedeventargs#excel-excel-linkedentitydatadomainrefreshmodechangedeventargs-type-member)|Gets the type of the event.| +|[LinkedEntityIdCulture](/javascript/api/excel/excel.linkedentityidculture)|[culture](/javascript/api/excel/excel.linkedentityidculture#excel-excel-linkedentityidculture-culture-member)|Represents the language culture used to create the `LinkedEntityCellValue` object.| +||[entityId](/javascript/api/excel/excel.linkedentityidculture#excel-excel-linkedentityidculture-entityid-member)|Represents the identifier specific to a service used to create the `LinkedEntityCellValue` object.| +|[LinkedEntityLoadServiceRequest](/javascript/api/excel/excel.linkedentityloadservicerequest)|[domainId](/javascript/api/excel/excel.linkedentityloadservicerequest#excel-excel-linkedentityloadservicerequest-domainid-member)|Represents the domain specific to the service used to create the `LinkedEntityCellValue` objects.| +||[entities](/javascript/api/excel/excel.linkedentityloadservicerequest#excel-excel-linkedentityloadservicerequest-entities-member)|Represents the entity IDs and cultures of the `LinkedEntityCellValue` objects to load.| +|[LinkedEntityLoadServiceResult](/javascript/api/excel/excel.linkedentityloadserviceresult)|[entities](/javascript/api/excel/excel.linkedentityloadserviceresult#excel-excel-linkedentityloadserviceresult-entities-member)|Represents the loaded `LinkedEntityCellValue` objects.| +|[Range](/javascript/api/excel/excel.range)|[getDisplayedCellProperties(cellPropertiesLoadOptions: CellPropertiesLoadOptions)](/javascript/api/excel/excel.range#excel-excel-range-getdisplayedcellproperties-member(1))|Returns a 2D array, encapsulating the display data for each cell's font, fill, borders, alignment, and other properties.| +|[StringCellValue](/javascript/api/excel/excel.stringcellvalue)|[layouts](/javascript/api/excel/excel.stringcellvalue#excel-excel-stringcellvalue-layouts-member)|Represents layout information for views of this string value.| +||[properties](/javascript/api/excel/excel.stringcellvalue#excel-excel-stringcellvalue-properties-member)|Represents additional properties of this string value.| +||[provider](/javascript/api/excel/excel.stringcellvalue#excel-excel-stringcellvalue-provider-member)|Represents information that describes the service that provided the data in this `StringCellValue`.| +||[referencedValues](/javascript/api/excel/excel.stringcellvalue#excel-excel-stringcellvalue-referencedvalues-member)|Represents the cell values which are referenced within `StringCellValue.properties`.| +|[Workbook](/javascript/api/excel/excel.workbook)|[getActiveShape()](/javascript/api/excel/excel.workbook#excel-excel-workbook-getactiveshape-member(1))|Gets the active shape in the workbook.| +||[getActiveShapeOrNullObject()](/javascript/api/excel/excel.workbook#excel-excel-workbook-getactiveshapeornullobject-member(1))|Gets the active shape in the workbook.| +||[linkedEntityDataDomains](/javascript/api/excel/excel.workbook#excel-excel-workbook-linkedentitydatadomains-member)|Returns a collection of linked entity data domains that are available in the workbook.| +|[Worksheet](/javascript/api/excel/excel.worksheet)|[showDataTypeIcons](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-showdatatypeicons-member)|Specifies if data type icons are visible on the worksheet.| diff --git a/docs/includes/excel-1_2.md b/docs/includes/excel-1_2.md index 814c25f977..5532cdfbd5 100644 --- a/docs/includes/excel-1_2.md +++ b/docs/includes/excel-1_2.md @@ -1,558 +1,558 @@ | Class | Fields | Description | |:---|:---|:---| -|[Binding](/.binding)|[onDataChanged](/.binding#excel-javascript/api/excel/-binding-ondatachanged-member)|Occurs when data or formatting within the binding is changed.| -||[onSelectionChanged](/.binding#excel-javascript/api/excel/-binding-onselectionchanged-member)|Occurs when the selected content in the binding is changed.| -|[BindingDataChangedEventArgs](/.bindingdatachangedeventargs)|[binding](/.bindingdatachangedeventargs#excel-javascript/api/excel/-bindingdatachangedeventargs-binding-member)|Gets a temporary `Binding` object that contains the ID of the `Binding` object that raised the event.| -|[BindingSelectionChangedEventArgs](/.bindingselectionchangedeventargs)|[binding](/.bindingselectionchangedeventargs#excel-javascript/api/excel/-bindingselectionchangedeventargs-binding-member)|Gets a temporary `Binding` object that contains the ID of the `Binding` object that raised the event.| -||[columnCount](/.bindingselectionchangedeventargs#excel-javascript/api/excel/-bindingselectionchangedeventargs-columncount-member)|Gets the number of columns selected.| -||[rowCount](/.bindingselectionchangedeventargs#excel-javascript/api/excel/-bindingselectionchangedeventargs-rowcount-member)|Gets the number of rows selected.| -||[startColumn](/.bindingselectionchangedeventargs#excel-javascript/api/excel/-bindingselectionchangedeventargs-startcolumn-member)|Gets the index of the first column of the selection (zero-based).| -||[startRow](/.bindingselectionchangedeventargs#excel-javascript/api/excel/-bindingselectionchangedeventargs-startrow-member)|Gets the index of the first row of the selection (zero-based).| -|[Chart](/.chart)|[getImage(width?: number, height?: number, fittingMode?: Excel.ImageFittingMode)](/.chart#excel-javascript/api/excel/-chart-getimage-member(1))|Renders the chart as a Base64-encoded image by scaling the chart to fit the specified dimensions.| -||[worksheet](/.chart#excel-javascript/api/excel/-chart-worksheet-member)|The worksheet containing the current chart.| -|[Filter](/.filter)|[apply(criteria: Excel.FilterCriteria)](/.filter#excel-javascript/api/excel/-filter-apply-member(1))|Apply the given filter criteria on the given column.| -||[applyBottomItemsFilter(count: number)](/.filter#excel-javascript/api/excel/-filter-applybottomitemsfilter-member(1))|Apply a "Bottom Item" filter to the column for the given number of elements.| -||[applyBottomPercentFilter(percent: number)](/.filter#excel-javascript/api/excel/-filter-applybottompercentfilter-member(1))|Apply a "Bottom Percent" filter to the column for the given percentage of elements.| -||[applyCellColorFilter(color: string)](/.filter#excel-javascript/api/excel/-filter-applycellcolorfilter-member(1))|Apply a "Cell Color" filter to the column for the given color.| -||[applyCustomFilter(criteria1: string, criteria2?: string, oper?: Excel.FilterOperator)](/.filter#excel-javascript/api/excel/-filter-applycustomfilter-member(1))|Apply an "Icon" filter to the column for the given criteria strings.| -||[applyDynamicFilter(criteria: Excel.DynamicFilterCriteria)](/.filter#excel-javascript/api/excel/-filter-applydynamicfilter-member(1))|Apply a "Dynamic" filter to the column.| -||[applyFontColorFilter(color: string)](/.filter#excel-javascript/api/excel/-filter-applyfontcolorfilter-member(1))|Apply a "Font Color" filter to the column for the given color.| -||[applyIconFilter(icon: Excel.Icon)](/.filter#excel-javascript/api/excel/-filter-applyiconfilter-member(1))|Apply an "Icon" filter to the column for the given icon.| -||[applyTopItemsFilter(count: number)](/.filter#excel-javascript/api/excel/-filter-applytopitemsfilter-member(1))|Apply a "Top Item" filter to the column for the given number of elements.| -||[applyTopPercentFilter(percent: number)](/.filter#excel-javascript/api/excel/-filter-applytoppercentfilter-member(1))|Apply a "Top Percent" filter to the column for the given percentage of elements.| -||[applyValuesFilter(values: Array)](/.filter#excel-javascript/api/excel/-filter-applyvaluesfilter-member(1))|Apply a "Values" filter to the column for the given values.| -||[clear()](/.filter#excel-javascript/api/excel/-filter-clear-member(1))|Clear the filter on the given column.| -||[criteria](/.filter#excel-javascript/api/excel/-filter-criteria-member)|The currently applied filter on the given column.| -|[FilterCriteria](/.filtercriteria)|[color](/.filtercriteria#excel-javascript/api/excel/-filtercriteria-color-member)|The HTML color string used to filter cells.| -||[criterion1](/.filtercriteria#excel-javascript/api/excel/-filtercriteria-criterion1-member)|The first criterion used to filter data.| -||[criterion2](/.filtercriteria#excel-javascript/api/excel/-filtercriteria-criterion2-member)|The second criterion used to filter data.| -||[dynamicCriteria](/.filtercriteria#excel-javascript/api/excel/-filtercriteria-dynamiccriteria-member)|The dynamic criteria from the `Excel.DynamicFilterCriteria` set to apply on this column.| -||[filterOn](/.filtercriteria#excel-javascript/api/excel/-filtercriteria-filteron-member)|The property used by the filter to determine whether the values should stay visible.| -||[icon](/.filtercriteria#excel-javascript/api/excel/-filtercriteria-icon-member)|The icon used to filter cells.| -||[operator](/.filtercriteria#excel-javascript/api/excel/-filtercriteria-operator-member)|The operator used to combine criterion 1 and 2 when using `custom` filtering.| -||[values](/.filtercriteria#excel-javascript/api/excel/-filtercriteria-values-member)|The set of values to be used as part of `values` filtering.| -|[FilterDatetime](/.filterdatetime)|[date](/.filterdatetime#excel-javascript/api/excel/-filterdatetime-date-member)|The date in ISO8601 format used to filter data.| -||[specificity](/.filterdatetime#excel-javascript/api/excel/-filterdatetime-specificity-member)|How specific the date should be used to keep data.| -|[FiveArrowsGraySet](/.fivearrowsgrayset)|[grayDownArrow](/.fivearrowsgrayset#excel-javascript/api/excel/-fivearrowsgrayset-graydownarrow-member)|| -||[grayDownInclineArrow](/.fivearrowsgrayset#excel-javascript/api/excel/-fivearrowsgrayset-graydowninclinearrow-member)|| -||[graySideArrow](/.fivearrowsgrayset#excel-javascript/api/excel/-fivearrowsgrayset-graysidearrow-member)|| -||[grayUpArrow](/.fivearrowsgrayset#excel-javascript/api/excel/-fivearrowsgrayset-grayuparrow-member)|| -||[grayUpInclineArrow](/.fivearrowsgrayset#excel-javascript/api/excel/-fivearrowsgrayset-grayupinclinearrow-member)|| -|[FiveArrowsSet](/.fivearrowsset)|[greenUpArrow](/.fivearrowsset#excel-javascript/api/excel/-fivearrowsset-greenuparrow-member)|| -||[redDownArrow](/.fivearrowsset#excel-javascript/api/excel/-fivearrowsset-reddownarrow-member)|| -||[yellowDownInclineArrow](/.fivearrowsset#excel-javascript/api/excel/-fivearrowsset-yellowdowninclinearrow-member)|| -||[yellowSideArrow](/.fivearrowsset#excel-javascript/api/excel/-fivearrowsset-yellowsidearrow-member)|| -||[yellowUpInclineArrow](/.fivearrowsset#excel-javascript/api/excel/-fivearrowsset-yellowupinclinearrow-member)|| -|[FiveBoxesSet](/.fiveboxesset)|[fourFilledBoxes](/.fiveboxesset#excel-javascript/api/excel/-fiveboxesset-fourfilledboxes-member)|| -||[noFilledBoxes](/.fiveboxesset#excel-javascript/api/excel/-fiveboxesset-nofilledboxes-member)|| -||[oneFilledBox](/.fiveboxesset#excel-javascript/api/excel/-fiveboxesset-onefilledbox-member)|| -||[threeFilledBoxes](/.fiveboxesset#excel-javascript/api/excel/-fiveboxesset-threefilledboxes-member)|| -||[twoFilledBoxes](/.fiveboxesset#excel-javascript/api/excel/-fiveboxesset-twofilledboxes-member)|| -|[FiveQuartersSet](/.fivequartersset)|[blackCircle](/.fivequartersset#excel-javascript/api/excel/-fivequartersset-blackcircle-member)|| -||[circleWithOneWhiteQuarter](/.fivequartersset#excel-javascript/api/excel/-fivequartersset-circlewithonewhitequarter-member)|| -||[circleWithThreeWhiteQuarters](/.fivequartersset#excel-javascript/api/excel/-fivequartersset-circlewiththreewhitequarters-member)|| -||[circleWithTwoWhiteQuarters](/.fivequartersset#excel-javascript/api/excel/-fivequartersset-circlewithtwowhitequarters-member)|| -||[whiteCircleAllWhiteQuarters](/.fivequartersset#excel-javascript/api/excel/-fivequartersset-whitecircleallwhitequarters-member)|| -|[FiveRatingSet](/.fiveratingset)|[fourBars](/.fiveratingset#excel-javascript/api/excel/-fiveratingset-fourbars-member)|| -||[noBars](/.fiveratingset#excel-javascript/api/excel/-fiveratingset-nobars-member)|| -||[oneBar](/.fiveratingset#excel-javascript/api/excel/-fiveratingset-onebar-member)|| -||[threeBars](/.fiveratingset#excel-javascript/api/excel/-fiveratingset-threebars-member)|| -||[twoBars](/.fiveratingset#excel-javascript/api/excel/-fiveratingset-twobars-member)|| -|[FormatProtection](/.formatprotection)|[formulaHidden](/.formatprotection#excel-javascript/api/excel/-formatprotection-formulahidden-member)|Specifies if Excel hides the formula for the cells in the range.| -||[locked](/.formatprotection#excel-javascript/api/excel/-formatprotection-locked-member)|Specifies if Excel locks the cells in the object.| -|[FourArrowsGraySet](/.fourarrowsgrayset)|[grayDownArrow](/.fourarrowsgrayset#excel-javascript/api/excel/-fourarrowsgrayset-graydownarrow-member)|| -||[grayDownInclineArrow](/.fourarrowsgrayset#excel-javascript/api/excel/-fourarrowsgrayset-graydowninclinearrow-member)|| -||[grayUpArrow](/.fourarrowsgrayset#excel-javascript/api/excel/-fourarrowsgrayset-grayuparrow-member)|| -||[grayUpInclineArrow](/.fourarrowsgrayset#excel-javascript/api/excel/-fourarrowsgrayset-grayupinclinearrow-member)|| -|[FourArrowsSet](/.fourarrowsset)|[greenUpArrow](/.fourarrowsset#excel-javascript/api/excel/-fourarrowsset-greenuparrow-member)|| -||[redDownArrow](/.fourarrowsset#excel-javascript/api/excel/-fourarrowsset-reddownarrow-member)|| -||[yellowDownInclineArrow](/.fourarrowsset#excel-javascript/api/excel/-fourarrowsset-yellowdowninclinearrow-member)|| -||[yellowUpInclineArrow](/.fourarrowsset#excel-javascript/api/excel/-fourarrowsset-yellowupinclinearrow-member)|| -|[FourRatingSet](/.fourratingset)|[fourBars](/.fourratingset#excel-javascript/api/excel/-fourratingset-fourbars-member)|| -||[oneBar](/.fourratingset#excel-javascript/api/excel/-fourratingset-onebar-member)|| -||[threeBars](/.fourratingset#excel-javascript/api/excel/-fourratingset-threebars-member)|| -||[twoBars](/.fourratingset#excel-javascript/api/excel/-fourratingset-twobars-member)|| -|[FourRedToBlackSet](/.fourredtoblackset)|[blackCircle](/.fourredtoblackset#excel-javascript/api/excel/-fourredtoblackset-blackcircle-member)|| -||[grayCircle](/.fourredtoblackset#excel-javascript/api/excel/-fourredtoblackset-graycircle-member)|| -||[pinkCircle](/.fourredtoblackset#excel-javascript/api/excel/-fourredtoblackset-pinkcircle-member)|| -||[redCircle](/.fourredtoblackset#excel-javascript/api/excel/-fourredtoblackset-redcircle-member)|| -|[FourTrafficLightsSet](/.fourtrafficlightsset)|[blackCircleWithBorder](/.fourtrafficlightsset#excel-javascript/api/excel/-fourtrafficlightsset-blackcirclewithborder-member)|| -||[greenCircle](/.fourtrafficlightsset#excel-javascript/api/excel/-fourtrafficlightsset-greencircle-member)|| -||[redCircleWithBorder](/.fourtrafficlightsset#excel-javascript/api/excel/-fourtrafficlightsset-redcirclewithborder-member)|| -||[yellowCircle](/.fourtrafficlightsset#excel-javascript/api/excel/-fourtrafficlightsset-yellowcircle-member)|| -|[FunctionResult](/.functionresult)|[error](/.functionresult#excel-javascript/api/excel/-functionresult-error-member)|Error value (such as "#DIV/0") representing the error.| -||[value](/.functionresult#excel-javascript/api/excel/-functionresult-value-member)|The value of function evaluation.| -|[Functions](/.functions)|[abs(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-abs-member(1))|Returns the absolute value of a number, a number without its sign.| -||[accrInt(issue: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, firstInterest: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, par: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, calcMethod?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-accrint-member(1))|Returns the accrued interest for a security that pays periodic interest.| -||[accrIntM(issue: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, par: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-accrintm-member(1))|Returns the accrued interest for a security that pays interest at maturity.| -||[acos(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-acos-member(1))|Returns the arccosine of a number, in radians in the range 0 to Pi.| -||[acosh(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-acosh-member(1))|Returns the inverse hyperbolic cosine of a number.| -||[acot(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-acot-member(1))|Returns the arccotangent of a number, in radians in the range 0 to Pi.| -||[acoth(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-acoth-member(1))|Returns the inverse hyperbolic cotangent of a number.| -||[amorDegrc(cost: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, datePurchased: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, firstPeriod: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, salvage: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, period: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-amordegrc-member(1))|Returns the prorated linear depreciation of an asset for each accounting period.| -||[amorLinc(cost: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, datePurchased: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, firstPeriod: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, salvage: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, period: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-amorlinc-member(1))|Returns the prorated linear depreciation of an asset for each accounting period.| -||[and(...values: Array)](/.functions#excel-javascript/api/excel/-functions-and-member(1))|Checks whether all arguments are TRUE, and returns TRUE if all arguments are TRUE.| -||[arabic(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-arabic-member(1))|Converts a Roman numeral to Arabic.| -||[areas(reference: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-areas-member(1))|Returns the number of areas in a reference.| -||[asc(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-asc-member(1))|Changes full-width (double-byte) characters to half-width (single-byte) characters.| -||[asin(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-asin-member(1))|Returns the arcsine of a number in radians, in the range -Pi/2 to Pi/2.| -||[asinh(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-asinh-member(1))|Returns the inverse hyperbolic sine of a number.| -||[atan(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-atan-member(1))|Returns the arctangent of a number in radians, in the range -Pi/2 to Pi/2.| -||[atan2(xNum: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, yNum: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-atan2-member(1))|Returns the arctangent of the specified x- and y- coordinates, in radians between -Pi and Pi, excluding -Pi.| -||[atanh(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-atanh-member(1))|Returns the inverse hyperbolic tangent of a number.| -||[aveDev(...values: Array)](/.functions#excel-javascript/api/excel/-functions-avedev-member(1))|Returns the average of the absolute deviations of data points from their mean.| -||[average(...values: Array)](/.functions#excel-javascript/api/excel/-functions-average-member(1))|Returns the average (arithmetic mean) of its arguments, which can be numbers or names, arrays, or references that contain numbers.| -||[averageA(...values: Array)](/.functions#excel-javascript/api/excel/-functions-averagea-member(1))|Returns the average (arithmetic mean) of its arguments, evaluating text and FALSE in arguments as 0; TRUE evaluates as 1.| -||[averageIf(range: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, averageRange?: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-averageif-member(1))|Finds average(arithmetic mean) for the cells specified by a given condition or criteria.| -||[averageIfs(averageRange: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, ...values: Array)](/.functions#excel-javascript/api/excel/-functions-averageifs-member(1))|Finds average(arithmetic mean) for the cells specified by a given set of conditions or criteria.| -||[bahtText(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-bahttext-member(1))|Converts a number to text (baht).| -||[base(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, radix: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, minLength?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-base-member(1))|Converts a number into a text representation with the given radix (base).| -||[besselI(x: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, n: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-besseli-member(1))|Returns the modified Bessel function In(x).| -||[besselJ(x: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, n: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-besselj-member(1))|Returns the Bessel function Jn(x).| -||[besselK(x: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, n: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-besselk-member(1))|Returns the modified Bessel function Kn(x).| -||[besselY(x: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, n: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-bessely-member(1))|Returns the Bessel function Yn(x).| -||[beta_Dist(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, alpha: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, beta: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, A?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, B?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-beta_dist-member(1))|Returns the beta probability distribution function.| -||[beta_Inv(probability: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, alpha: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, beta: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, A?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, B?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-beta_inv-member(1))|Returns the inverse of the cumulative beta probability density function (BETA.DIST).| -||[bin2Dec(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-bin2dec-member(1))|Converts a binary number to decimal.| -||[bin2Hex(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, places?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-bin2hex-member(1))|Converts a binary number to hexadecimal.| -||[bin2Oct(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, places?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-bin2oct-member(1))|Converts a binary number to octal.| -||[binom_Dist(numberS: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, trials: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, probabilityS: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-binom_dist-member(1))|Returns the individual term binomial distribution probability.| -||[binom_Dist_Range(trials: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, probabilityS: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numberS: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numberS2?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-binom_dist_range-member(1))|Returns the probability of a trial result using a binomial distribution.| -||[binom_Inv(trials: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, probabilityS: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, alpha: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-binom_inv-member(1))|Returns the smallest value for which the cumulative binomial distribution is greater than or equal to a criterion value.| -||[bitand(number1: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, number2: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-bitand-member(1))|Returns a bitwise 'And' of two numbers.| -||[bitlshift(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, shiftAmount: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-bitlshift-member(1))|Returns a number shifted left by shift_amount bits.| -||[bitor(number1: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, number2: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-bitor-member(1))|Returns a bitwise 'Or' of two numbers.| -||[bitrshift(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, shiftAmount: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-bitrshift-member(1))|Returns a number shifted right by shift_amount bits.| -||[bitxor(number1: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, number2: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-bitxor-member(1))|Returns a bitwise 'Exclusive Or' of two numbers.| -||[ceiling_Math(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, significance?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, mode?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-ceiling_math-member(1))|Rounds a number up, to the nearest integer or to the nearest multiple of significance.| -||[ceiling_Precise(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, significance?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-ceiling_precise-member(1))|Rounds a number up, to the nearest integer or to the nearest multiple of significance.| -||[char(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-char-member(1))|Returns the character specified by the code number from the character set for your computer.| -||[chiSq_Dist(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-chisq_dist-member(1))|Returns the left-tailed probability of the chi-squared distribution.| -||[chiSq_Dist_RT(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-chisq_dist_rt-member(1))|Returns the right-tailed probability of the chi-squared distribution.| -||[chiSq_Inv(probability: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-chisq_inv-member(1))|Returns the inverse of the left-tailed probability of the chi-squared distribution.| -||[chiSq_Inv_RT(probability: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-chisq_inv_rt-member(1))|Returns the inverse of the right-tailed probability of the chi-squared distribution.| -||[choose(indexNum: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, ...values: Array)](/.functions#excel-javascript/api/excel/-functions-choose-member(1))|Chooses a value or action to perform from a list of values, based on an index number.| -||[clean(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-clean-member(1))|Removes all nonprintable characters from text.| -||[code(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-code-member(1))|Returns a numeric code for the first character in a text string, in the character set used by your computer.| -||[columns(array: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-columns-member(1))|Returns the number of columns in an array or reference.| -||[combin(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numberChosen: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-combin-member(1))|Returns the number of combinations for a given number of items.| -||[combina(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numberChosen: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-combina-member(1))|Returns the number of combinations with repetitions for a given number of items.| -||[complex(realNum: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, iNum: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, suffix?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-complex-member(1))|Converts real and imaginary coefficients into a complex number.| -||[concatenate(...values: Array)](/.functions#excel-javascript/api/excel/-functions-concatenate-member(1))|Joins several text strings into one text string.| -||[confidence_Norm(alpha: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, standardDev: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, size: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-confidence_norm-member(1))|Returns the confidence interval for a population mean, using a normal distribution.| -||[confidence_T(alpha: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, standardDev: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, size: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-confidence_t-member(1))|Returns the confidence interval for a population mean, using a Student's T distribution.| -||[convert(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, fromUnit: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, toUnit: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-convert-member(1))|Converts a number from one measurement system to another.| -||[cos(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-cos-member(1))|Returns the cosine of an angle.| -||[cosh(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-cosh-member(1))|Returns the hyperbolic cosine of a number.| -||[cot(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-cot-member(1))|Returns the cotangent of an angle.| -||[coth(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-coth-member(1))|Returns the hyperbolic cotangent of a number.| -||[count(...values: Array)](/.functions#excel-javascript/api/excel/-functions-count-member(1))|Counts the number of cells in a range that contain numbers.| -||[countA(...values: Array)](/.functions#excel-javascript/api/excel/-functions-counta-member(1))|Counts the number of cells in a range that are not empty.| -||[countBlank(range: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-countblank-member(1))|Counts the number of empty cells in a specified range of cells.| -||[countIf(range: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-countif-member(1))|Counts the number of cells within a range that meet the given condition.| -||[countIfs(...values: Array)](/.functions#excel-javascript/api/excel/-functions-countifs-member(1))|Counts the number of cells specified by a given set of conditions or criteria.| -||[coupDayBs(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-coupdaybs-member(1))|Returns the number of days from the beginning of the coupon period to the settlement date.| -||[coupDays(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-coupdays-member(1))|Returns the number of days in the coupon period that contains the settlement date.| -||[coupDaysNc(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-coupdaysnc-member(1))|Returns the number of days from the settlement date to the next coupon date.| -||[coupNcd(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-coupncd-member(1))|Returns the next coupon date after the settlement date.| -||[coupNum(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-coupnum-member(1))|Returns the number of coupons payable between the settlement date and maturity date.| -||[coupPcd(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-couppcd-member(1))|Returns the previous coupon date before the settlement date.| -||[csc(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-csc-member(1))|Returns the cosecant of an angle.| -||[csch(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-csch-member(1))|Returns the hyperbolic cosecant of an angle.| -||[cumIPmt(rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, nper: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pv: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, startPeriod: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, endPeriod: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, type: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-cumipmt-member(1))|Returns the cumulative interest paid between two periods.| -||[cumPrinc(rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, nper: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pv: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, startPeriod: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, endPeriod: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, type: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-cumprinc-member(1))|Returns the cumulative principal paid on a loan between two periods.| -||[date(year: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, month: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, day: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-date-member(1))|Returns the number that represents the date in Microsoft Excel date-time code.| -||[datevalue(dateText: string \| number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-datevalue-member(1))|Converts a date in the form of text to a number that represents the date in Microsoft Excel date-time code.| -||[daverage(database: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, field: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-daverage-member(1))|Averages the values in a column in a list or database that match conditions you specify.| -||[day(serialNumber: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-day-member(1))|Returns the day of the month, a number from 1 to 31.| -||[days(endDate: string \| number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, startDate: string \| number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-days-member(1))|Returns the number of days between the two dates.| -||[days360(startDate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, endDate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, method?: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-days360-member(1))|Returns the number of days between two dates based on a 360-day year (twelve 30-day months).| -||[db(cost: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, salvage: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, life: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, period: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, month?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-db-member(1))|Returns the depreciation of an asset for a specified period using the fixed-declining balance method.| -||[dbcs(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-dbcs-member(1))|Changes half-width (single-byte) characters within a character string to full-width (double-byte) characters.| -||[dcount(database: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, field: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-dcount-member(1))|Counts the cells containing numbers in the field (column) of records in the database that match the conditions you specify.| -||[dcountA(database: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, field: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-dcounta-member(1))|Counts nonblank cells in the field (column) of records in the database that match the conditions you specify.| -||[ddb(cost: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, salvage: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, life: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, period: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, factor?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-ddb-member(1))|Returns the depreciation of an asset for a specified period using the double-declining balance method or some other method you specify.| -||[dec2Bin(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, places?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-dec2bin-member(1))|Converts a decimal number to binary.| -||[dec2Hex(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, places?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-dec2hex-member(1))|Converts a decimal number to hexadecimal.| -||[dec2Oct(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, places?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-dec2oct-member(1))|Converts a decimal number to octal.| -||[decimal(number: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, radix: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-decimal-member(1))|Converts a text representation of a number in a given base into a decimal number.| -||[degrees(angle: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-degrees-member(1))|Converts radians to degrees.| -||[delta(number1: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, number2?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-delta-member(1))|Tests whether two numbers are equal.| -||[devSq(...values: Array)](/.functions#excel-javascript/api/excel/-functions-devsq-member(1))|Returns the sum of squares of deviations of data points from their sample mean.| -||[dget(database: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, field: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-dget-member(1))|Extracts from a database a single record that matches the conditions you specify.| -||[disc(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pr: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, redemption: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-disc-member(1))|Returns the discount rate for a security.| -||[dmax(database: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, field: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-dmax-member(1))|Returns the largest number in the field (column) of records in the database that match the conditions you specify.| -||[dmin(database: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, field: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-dmin-member(1))|Returns the smallest number in the field (column) of records in the database that match the conditions you specify.| -||[dollar(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, decimals?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-dollar-member(1))|Converts a number to text, using currency format.| -||[dollarDe(fractionalDollar: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, fraction: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-dollarde-member(1))|Converts a dollar price, expressed as a fraction, into a dollar price, expressed as a decimal number.| -||[dollarFr(decimalDollar: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, fraction: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-dollarfr-member(1))|Converts a dollar price, expressed as a decimal number, into a dollar price, expressed as a fraction.| -||[dproduct(database: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, field: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-dproduct-member(1))|Multiplies the values in the field (column) of records in the database that match the conditions you specify.| -||[dstDev(database: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, field: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-dstdev-member(1))|Estimates the standard deviation based on a sample from selected database entries.| -||[dstDevP(database: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, field: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-dstdevp-member(1))|Calculates the standard deviation based on the entire population of selected database entries.| -||[dsum(database: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, field: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-dsum-member(1))|Adds the numbers in the field (column) of records in the database that match the conditions you specify.| -||[duration(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, coupon: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, yld: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-duration-member(1))|Returns the annual duration of a security with periodic interest payments.| -||[dvar(database: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, field: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-dvar-member(1))|Estimates variance based on a sample from selected database entries.| -||[dvarP(database: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, field: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-dvarp-member(1))|Calculates variance based on the entire population of selected database entries.| -||[ecma_Ceiling(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, significance: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-ecma_ceiling-member(1))|Rounds a number up, to the nearest integer or to the nearest multiple of significance.| -||[edate(startDate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, months: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-edate-member(1))|Returns the serial number of the date that is the indicated number of months before or after the start date.| -||[effect(nominalRate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, npery: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-effect-member(1))|Returns the effective annual interest rate.| -||[eoMonth(startDate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, months: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-eomonth-member(1))|Returns the serial number of the last day of the month before or after a specified number of months.| -||[erf(lowerLimit: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, upperLimit?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-erf-member(1))|Returns the error function.| -||[erfC(x: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-erfc-member(1))|Returns the complementary error function.| -||[erfC_Precise(X: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-erfc_precise-member(1))|Returns the complementary error function.| -||[erf_Precise(X: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-erf_precise-member(1))|Returns the error function.| -||[error_Type(errorVal: string \| number \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-error_type-member(1))|Returns a number matching an error value.| -||[even(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-even-member(1))|Rounds a positive number up and negative number down to the nearest even integer.| -||[exact(text1: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, text2: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-exact-member(1))|Checks whether two text strings are exactly the same, and returns TRUE or FALSE.| -||[exp(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-exp-member(1))|Returns e raised to the power of a given number.| -||[expon_Dist(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, lambda: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-expon_dist-member(1))|Returns the exponential distribution.| -||[f_Dist(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom1: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom2: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-f_dist-member(1))|Returns the (left-tailed) F probability distribution (degree of diversity) for two data sets.| -||[f_Dist_RT(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom1: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom2: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-f_dist_rt-member(1))|Returns the (right-tailed) F probability distribution (degree of diversity) for two data sets.| -||[f_Inv(probability: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom1: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom2: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-f_inv-member(1))|Returns the inverse of the (left-tailed) F probability distribution: if p = F.DIST(x,...), then F.INV(p,...) = x.| -||[f_Inv_RT(probability: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom1: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom2: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-f_inv_rt-member(1))|Returns the inverse of the (right-tailed) F probability distribution: if p = F.DIST.RT(x,...), then F.INV.RT(p,...) = x.| -||[fact(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-fact-member(1))|Returns the factorial of a number, equal to 1*2*3*...* Number.| -||[factDouble(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-factdouble-member(1))|Returns the double factorial of a number.| -||[false()](/.functions#excel-javascript/api/excel/-functions-false-member(1))|Returns the logical value FALSE.| -||[find(findText: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, withinText: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, startNum?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-find-member(1))|Returns the starting position of one text string within another text string.| -||[findB(findText: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, withinText: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, startNum?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-findb-member(1))|Finds the starting position of one text string within another text string.| -||[fisher(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-fisher-member(1))|Returns the Fisher transformation.| -||[fisherInv(y: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-fisherinv-member(1))|Returns the inverse of the Fisher transformation: if y = FISHER(x), then FISHERINV(y) = x.| -||[fixed(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, decimals?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, noCommas?: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-fixed-member(1))|Rounds a number to the specified number of decimals and returns the result as text with or without commas.| -||[floor_Math(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, significance?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, mode?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-floor_math-member(1))|Rounds a number down, to the nearest integer or to the nearest multiple of significance.| -||[floor_Precise(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, significance?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-floor_precise-member(1))|Rounds a number down, to the nearest integer or to the nearest multiple of significance.| -||[fv(rate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, nper: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pmt: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pv?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, type?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-fv-member(1))|Returns the future value of an investment based on periodic, constant payments and a constant interest rate.| -||[fvschedule(principal: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, schedule: number \| string \| Excel.Range \| boolean \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-fvschedule-member(1))|Returns the future value of an initial principal after applying a series of compound interest rates.| -||[gamma(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-gamma-member(1))|Returns the Gamma function value.| -||[gammaLn(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-gammaln-member(1))|Returns the natural logarithm of the gamma function.| -||[gammaLn_Precise(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-gammaln_precise-member(1))|Returns the natural logarithm of the gamma function.| -||[gamma_Dist(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, alpha: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, beta: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-gamma_dist-member(1))|Returns the gamma distribution.| -||[gamma_Inv(probability: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, alpha: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, beta: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-gamma_inv-member(1))|Returns the inverse of the gamma cumulative distribution: if p = GAMMA.DIST(x,...), then GAMMA.INV(p,...) = x.| -||[gauss(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-gauss-member(1))|Returns 0.5 less than the standard normal cumulative distribution.| -||[gcd(...values: Array)](/.functions#excel-javascript/api/excel/-functions-gcd-member(1))|Returns the greatest common divisor.| -||[geStep(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, step?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-gestep-member(1))|Tests whether a number is greater than a threshold value.| -||[geoMean(...values: Array)](/.functions#excel-javascript/api/excel/-functions-geomean-member(1))|Returns the geometric mean of an array or range of positive numeric data.| -||[harMean(...values: Array)](/.functions#excel-javascript/api/excel/-functions-harmean-member(1))|Returns the harmonic mean of a data set of positive numbers: the reciprocal of the arithmetic mean of reciprocals.| -||[hex2Bin(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, places?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-hex2bin-member(1))|Converts a Hexadecimal number to binary.| -||[hex2Dec(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-hex2dec-member(1))|Converts a hexadecimal number to decimal.| -||[hex2Oct(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, places?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-hex2oct-member(1))|Converts a hexadecimal number to octal.| -||[hlookup(lookupValue: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, tableArray: Excel.Range \| number \| Excel.RangeReference \| Excel.FunctionResult, rowIndexNum: Excel.Range \| number \| Excel.RangeReference \| Excel.FunctionResult, rangeLookup?: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-hlookup-member(1))|Looks for a value in the top row of a table or array of values and returns the value in the same column from a row you specify.| -||[hour(serialNumber: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-hour-member(1))|Returns the hour as a number from 0 (12:00 A.M.) to 23 (11:00 P.M.).| -||[hypGeom_Dist(sampleS: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numberSample: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, populationS: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numberPop: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-hypgeom_dist-member(1))|Returns the hypergeometric distribution.| -||[hyperlink(linkLocation: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, friendlyName?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-hyperlink-member(1))|Creates a shortcut or jump that opens a document stored on your hard drive, a network server, or on the Internet.| -||[if(logicalTest: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, valueIfTrue?: Excel.Range \| number \| string \| boolean \| Excel.RangeReference \| Excel.FunctionResult, valueIfFalse?: Excel.Range \| number \| string \| boolean \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-if-member(1))|Checks whether a condition is met, and returns one value if TRUE, and another value if FALSE.| -||[imAbs(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-imabs-member(1))|Returns the absolute value (modulus) of a complex number.| -||[imArgument(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-imargument-member(1))|Returns the argument q, an angle expressed in radians.| -||[imConjugate(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-imconjugate-member(1))|Returns the complex conjugate of a complex number.| -||[imCos(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-imcos-member(1))|Returns the cosine of a complex number.| -||[imCosh(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-imcosh-member(1))|Returns the hyperbolic cosine of a complex number.| -||[imCot(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-imcot-member(1))|Returns the cotangent of a complex number.| -||[imCsc(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-imcsc-member(1))|Returns the cosecant of a complex number.| -||[imCsch(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-imcsch-member(1))|Returns the hyperbolic cosecant of a complex number.| -||[imDiv(inumber1: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, inumber2: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-imdiv-member(1))|Returns the quotient of two complex numbers.| -||[imExp(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-imexp-member(1))|Returns the exponential of a complex number.| -||[imLn(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-imln-member(1))|Returns the natural logarithm of a complex number.| -||[imLog10(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-imlog10-member(1))|Returns the base-10 logarithm of a complex number.| -||[imLog2(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-imlog2-member(1))|Returns the base-2 logarithm of a complex number.| -||[imPower(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-impower-member(1))|Returns a complex number raised to an integer power.| -||[imProduct(...values: Array)](/.functions#excel-javascript/api/excel/-functions-improduct-member(1))|Returns the product of 1 to 255 complex numbers.| -||[imReal(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-imreal-member(1))|Returns the real coefficient of a complex number.| -||[imSec(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-imsec-member(1))|Returns the secant of a complex number.| -||[imSech(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-imsech-member(1))|Returns the hyperbolic secant of a complex number.| -||[imSin(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-imsin-member(1))|Returns the sine of a complex number.| -||[imSinh(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-imsinh-member(1))|Returns the hyperbolic sine of a complex number.| -||[imSqrt(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-imsqrt-member(1))|Returns the square root of a complex number.| -||[imSub(inumber1: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, inumber2: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-imsub-member(1))|Returns the difference of two complex numbers.| -||[imSum(...values: Array)](/.functions#excel-javascript/api/excel/-functions-imsum-member(1))|Returns the sum of complex numbers.| -||[imTan(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-imtan-member(1))|Returns the tangent of a complex number.| -||[imaginary(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-imaginary-member(1))|Returns the imaginary coefficient of a complex number.| -||[int(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-int-member(1))|Rounds a number down to the nearest integer.| -||[intRate(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, investment: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, redemption: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-intrate-member(1))|Returns the interest rate for a fully invested security.| -||[ipmt(rate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, per: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, nper: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pv: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, fv?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, type?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-ipmt-member(1))|Returns the interest payment for a given period for an investment, based on periodic, constant payments and a constant interest rate.| -||[irr(values: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, guess?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-irr-member(1))|Returns the internal rate of return for a series of cash flows.| -||[isErr(value: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-iserr-member(1))|Checks whether a value is an error other than #N/A, and returns TRUE or FALSE.| -||[isError(value: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-iserror-member(1))|Checks whether a value is an error, and returns TRUE or FALSE.| -||[isEven(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-iseven-member(1))|Returns TRUE if the number is even.| -||[isFormula(reference: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-isformula-member(1))|Checks whether a reference is to a cell containing a formula, and returns TRUE or FALSE.| -||[isLogical(value: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-islogical-member(1))|Checks whether a value is a logical value (TRUE or FALSE), and returns TRUE or FALSE.| -||[isNA(value: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-isna-member(1))|Checks whether a value is #N/A, and returns TRUE or FALSE.| -||[isNonText(value: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-isnontext-member(1))|Checks whether a value is not text (blank cells are not text), and returns TRUE or FALSE.| -||[isNumber(value: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-isnumber-member(1))|Checks whether a value is a number, and returns TRUE or FALSE.| -||[isOdd(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-isodd-member(1))|Returns TRUE if the number is odd.| -||[isText(value: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-istext-member(1))|Checks whether a value is text, and returns TRUE or FALSE.| -||[isoWeekNum(date: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-isoweeknum-member(1))|Returns the ISO week number in the year for a given date.| -||[iso_Ceiling(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, significance?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-iso_ceiling-member(1))|Rounds a number up, to the nearest integer or to the nearest multiple of significance.| -||[ispmt(rate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, per: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, nper: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pv: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-ispmt-member(1))|Returns the interest paid during a specific period of an investment.| -||[isref(value: Excel.Range \| number \| string \| boolean \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-isref-member(1))|Checks whether a value is a reference, and returns TRUE or FALSE.| -||[kurt(...values: Array)](/.functions#excel-javascript/api/excel/-functions-kurt-member(1))|Returns the kurtosis of a data set.| -||[large(array: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, k: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-large-member(1))|Returns the k-th largest value in a data set.| -||[lcm(...values: Array)](/.functions#excel-javascript/api/excel/-functions-lcm-member(1))|Returns the least common multiple.| -||[left(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numChars?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-left-member(1))|Returns the specified number of characters from the start of a text string.| -||[leftb(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numBytes?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-leftb-member(1))|Returns the specified number of characters from the start of a text string.| -||[len(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-len-member(1))|Returns the number of characters in a text string.| -||[lenb(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-lenb-member(1))|Returns the number of characters in a text string.| -||[ln(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-ln-member(1))|Returns the natural logarithm of a number.| -||[log(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, base?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-log-member(1))|Returns the logarithm of a number to the base you specify.| -||[log10(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-log10-member(1))|Returns the base-10 logarithm of a number.| -||[logNorm_Dist(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, mean: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, standardDev: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-lognorm_dist-member(1))|Returns the lognormal distribution of x, where ln(x) is normally distributed with parameters Mean and Standard_dev.| -||[logNorm_Inv(probability: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, mean: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, standardDev: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-lognorm_inv-member(1))|Returns the inverse of the lognormal cumulative distribution function of x, where ln(x) is normally distributed with parameters Mean and Standard_dev.| -||[lookup(lookupValue: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, lookupVector: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, resultVector?: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-lookup-member(1))|Looks up a value either from a one-row or one-column range or from an array.| -||[lower(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-lower-member(1))|Converts all letters in a text string to lowercase.| -||[match(lookupValue: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, lookupArray: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, matchType?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-match-member(1))|Returns the relative position of an item in an array that matches a specified value in a specified order.| -||[max(...values: Array)](/.functions#excel-javascript/api/excel/-functions-max-member(1))|Returns the largest value in a set of values.| -||[maxA(...values: Array)](/.functions#excel-javascript/api/excel/-functions-maxa-member(1))|Returns the largest value in a set of values.| -||[mduration(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, coupon: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, yld: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-mduration-member(1))|Returns the Macauley modified duration for a security with an assumed par value of $100.| -||[median(...values: Array)](/.functions#excel-javascript/api/excel/-functions-median-member(1))|Returns the median, or the number in the middle of the set of given numbers.| -||[mid(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, startNum: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numChars: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-mid-member(1))|Returns the characters from the middle of a text string, given a starting position and length.| -||[midb(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, startNum: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numBytes: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-midb-member(1))|Returns characters from the middle of a text string, given a starting position and length.| -||[min(...values: Array)](/.functions#excel-javascript/api/excel/-functions-min-member(1))|Returns the smallest number in a set of values.| -||[minA(...values: Array)](/.functions#excel-javascript/api/excel/-functions-mina-member(1))|Returns the smallest value in a set of values.| -||[minute(serialNumber: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-minute-member(1))|Returns the minute, a number from 0 to 59.| -||[mirr(values: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, financeRate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, reinvestRate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-mirr-member(1))|Returns the internal rate of return for a series of periodic cash flows, considering both cost of investment and interest on reinvestment of cash.| -||[mod(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, divisor: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-mod-member(1))|Returns the remainder after a number is divided by a divisor.| -||[month(serialNumber: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-month-member(1))|Returns the month, a number from 1 (January) to 12 (December).| -||[mround(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, multiple: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-mround-member(1))|Returns a number rounded to the desired multiple.| -||[multiNomial(...values: Array)](/.functions#excel-javascript/api/excel/-functions-multinomial-member(1))|Returns the multinomial of a set of numbers.| -||[n(value: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-n-member(1))|Converts non-number value to a number, dates to serial numbers, TRUE to 1, anything else to 0 (zero).| -||[na()](/.functions#excel-javascript/api/excel/-functions-na-member(1))|Returns the error value #N/A (value not available).| -||[negBinom_Dist(numberF: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numberS: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, probabilityS: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-negbinom_dist-member(1))|Returns the negative binomial distribution, the probability that there will be Number_f failures before the Number_s-th success, with Probability_s probability of a success.| -||[networkDays(startDate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, endDate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, holidays?: number \| string \| Excel.Range \| boolean \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-networkdays-member(1))|Returns the number of whole workdays between two dates.| -||[networkDays_Intl(startDate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, endDate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, weekend?: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, holidays?: number \| string \| Excel.Range \| boolean \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-networkdays_intl-member(1))|Returns the number of whole workdays between two dates with custom weekend parameters.| -||[nominal(effectRate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, npery: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-nominal-member(1))|Returns the annual nominal interest rate.| -||[norm_Dist(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, mean: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, standardDev: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-norm_dist-member(1))|Returns the normal distribution for the specified mean and standard deviation.| -||[norm_Inv(probability: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, mean: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, standardDev: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-norm_inv-member(1))|Returns the inverse of the normal cumulative distribution for the specified mean and standard deviation.| -||[norm_S_Dist(z: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-norm_s_dist-member(1))|Returns the standard normal distribution (has a mean of zero and a standard deviation of one).| -||[norm_S_Inv(probability: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-norm_s_inv-member(1))|Returns the inverse of the standard normal cumulative distribution (has a mean of zero and a standard deviation of one).| -||[not(logical: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-not-member(1))|Changes FALSE to TRUE, or TRUE to FALSE.| -||[now()](/.functions#excel-javascript/api/excel/-functions-now-member(1))|Returns the current date and time formatted as a date and time.| -||[nper(rate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pmt: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pv: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, fv?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, type?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-nper-member(1))|Returns the number of periods for an investment based on periodic, constant payments and a constant interest rate.| -||[npv(rate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, ...values: Array)](/.functions#excel-javascript/api/excel/-functions-npv-member(1))|Returns the net present value of an investment based on a discount rate and a series of future payments (negative values) and income (positive values).| -||[numberValue(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, decimalSeparator?: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, groupSeparator?: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-numbervalue-member(1))|Converts text to number in a locale-independent manner.| -||[oct2Bin(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, places?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-oct2bin-member(1))|Converts an octal number to binary.| -||[oct2Dec(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-oct2dec-member(1))|Converts an octal number to decimal.| -||[oct2Hex(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, places?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-oct2hex-member(1))|Converts an octal number to hexadecimal.| -||[odd(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-odd-member(1))|Rounds a positive number up and negative number down to the nearest odd integer.| -||[oddFPrice(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, issue: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, firstCoupon: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, yld: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, redemption: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-oddfprice-member(1))|Returns the price per $100 face value of a security with an odd first period.| -||[oddFYield(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, issue: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, firstCoupon: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pr: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, redemption: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-oddfyield-member(1))|Returns the yield of a security with an odd first period.| -||[oddLPrice(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, lastInterest: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, yld: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, redemption: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-oddlprice-member(1))|Returns the price per $100 face value of a security with an odd last period.| -||[oddLYield(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, lastInterest: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pr: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, redemption: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-oddlyield-member(1))|Returns the yield of a security with an odd last period.| -||[or(...values: Array)](/.functions#excel-javascript/api/excel/-functions-or-member(1))|Checks whether any of the arguments are TRUE, and returns TRUE or FALSE.| -||[pduration(rate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pv: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, fv: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-pduration-member(1))|Returns the number of periods required by an investment to reach a specified value.| -||[percentRank_Exc(array: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, significance?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-percentrank_exc-member(1))|Returns the rank of a value in a data set as a percentage (0..1, exclusive) of the data set.| -||[percentRank_Inc(array: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, significance?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-percentrank_inc-member(1))|Returns the rank of a value in a data set as a percentage (0..1, inclusive) of the data set.| -||[percentile_Exc(array: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, k: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-percentile_exc-member(1))|Returns the k-th percentile of values in a range, where k is in the range 0..1, exclusive.| -||[percentile_Inc(array: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, k: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-percentile_inc-member(1))|Returns the k-th percentile of values in a range, where k is in the range 0..1, inclusive.| -||[permut(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numberChosen: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-permut-member(1))|Returns the number of permutations for a given number of objects that can be selected from the total objects.| -||[permutationa(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numberChosen: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-permutationa-member(1))|Returns the number of permutations for a given number of objects (with repetitions) that can be selected from the total objects.| -||[phi(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-phi-member(1))|Returns the value of the density function for a standard normal distribution.| -||[pi()](/.functions#excel-javascript/api/excel/-functions-pi-member(1))|Returns the value of Pi, 3.14159265358979, accurate to 15 digits.| -||[pmt(rate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, nper: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pv: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, fv?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, type?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-pmt-member(1))|Calculates the payment for a loan based on constant payments and a constant interest rate.| -||[poisson_Dist(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, mean: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-poisson_dist-member(1))|Returns the Poisson distribution.| -||[power(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, power: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-power-member(1))|Returns the result of a number raised to a power.| -||[ppmt(rate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, per: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, nper: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pv: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, fv?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, type?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-ppmt-member(1))|Returns the payment on the principal for a given investment based on periodic, constant payments and a constant interest rate.| -||[price(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, yld: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, redemption: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-price-member(1))|Returns the price per $100 face value of a security that pays periodic interest.| -||[priceDisc(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, discount: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, redemption: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-pricedisc-member(1))|Returns the price per $100 face value of a discounted security.| -||[priceMat(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, issue: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, yld: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-pricemat-member(1))|Returns the price per $100 face value of a security that pays interest at maturity.| -||[product(...values: Array)](/.functions#excel-javascript/api/excel/-functions-product-member(1))|Multiplies all the numbers given as arguments.| -||[proper(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-proper-member(1))|Converts a text string to proper case; the first letter in each word to uppercase, and all other letters to lowercase.| -||[pv(rate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, nper: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pmt: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, fv?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, type?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-pv-member(1))|Returns the present value of an investment: the total amount that a series of future payments is worth now.| -||[quartile_Exc(array: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, quart: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-quartile_exc-member(1))|Returns the quartile of a data set, based on percentile values from 0..1, exclusive.| -||[quartile_Inc(array: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, quart: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-quartile_inc-member(1))|Returns the quartile of a data set, based on percentile values from 0..1, inclusive.| -||[quotient(numerator: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, denominator: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-quotient-member(1))|Returns the integer portion of a division.| -||[radians(angle: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-radians-member(1))|Converts degrees to radians.| -||[rand()](/.functions#excel-javascript/api/excel/-functions-rand-member(1))|Returns a random number greater than or equal to 0 and less than 1, evenly distributed (changes on recalculation).| -||[randBetween(bottom: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, top: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-randbetween-member(1))|Returns a random number between the numbers you specify.| -||[rank_Avg(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, ref: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, order?: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-rank_avg-member(1))|Returns the rank of a number in a list of numbers: its size relative to other values in the list; if more than one value has the same rank, the average rank is returned.| -||[rank_Eq(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, ref: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, order?: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-rank_eq-member(1))|Returns the rank of a number in a list of numbers: its size relative to other values in the list; if more than one value has the same rank, the top rank of that set of values is returned.| -||[rate(nper: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pmt: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pv: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, fv?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, type?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, guess?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-rate-member(1))|Returns the interest rate per period of a loan or an investment.| -||[received(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, investment: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, discount: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-received-member(1))|Returns the amount received at maturity for a fully invested security.| -||[replace(oldText: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, startNum: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numChars: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, newText: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-replace-member(1))|Replaces part of a text string with a different text string.| -||[replaceB(oldText: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, startNum: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numBytes: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, newText: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-replaceb-member(1))|Replaces part of a text string with a different text string.| -||[rept(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numberTimes: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-rept-member(1))|Repeats text a given number of times.| -||[right(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numChars?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-right-member(1))|Returns the specified number of characters from the end of a text string.| -||[rightb(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numBytes?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-rightb-member(1))|Returns the specified number of characters from the end of a text string.| -||[roman(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, form?: boolean \| number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-roman-member(1))|Converts an Arabic numeral to Roman, as text.| -||[round(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numDigits: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-round-member(1))|Rounds a number to a specified number of digits.| -||[roundDown(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numDigits: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-rounddown-member(1))|Rounds a number down, toward zero.| -||[roundUp(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numDigits: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-roundup-member(1))|Rounds a number up, away from zero.| -||[rows(array: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-rows-member(1))|Returns the number of rows in a reference or array.| -||[rri(nper: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pv: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, fv: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-rri-member(1))|Returns an equivalent interest rate for the growth of an investment.| -||[sec(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-sec-member(1))|Returns the secant of an angle.| -||[sech(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-sech-member(1))|Returns the hyperbolic secant of an angle.| -||[second(serialNumber: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-second-member(1))|Returns the second, a number from 0 to 59.| -||[seriesSum(x: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, n: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, m: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, coefficients: Excel.Range \| string \| number \| boolean \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-seriessum-member(1))|Returns the sum of a power series based on the formula.| -||[sheet(value?: Excel.Range \| string \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-sheet-member(1))|Returns the sheet number of the referenced sheet.| -||[sheets(reference?: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-sheets-member(1))|Returns the number of sheets in a reference.| -||[sign(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-sign-member(1))|Returns the sign of a number: 1 if the number is positive, zero if the number is zero, or -1 if the number is negative.| -||[sin(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-sin-member(1))|Returns the sine of an angle.| -||[sinh(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-sinh-member(1))|Returns the hyperbolic sine of a number.| -||[skew(...values: Array)](/.functions#excel-javascript/api/excel/-functions-skew-member(1))|Returns the skewness of a distribution: a characterization of the degree of asymmetry of a distribution around its mean.| -||[skew_p(...values: Array)](/.functions#excel-javascript/api/excel/-functions-skew_p-member(1))|Returns the skewness of a distribution based on a population: a characterization of the degree of asymmetry of a distribution around its mean.| -||[sln(cost: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, salvage: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, life: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-sln-member(1))|Returns the straight-line depreciation of an asset for one period.| -||[small(array: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, k: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-small-member(1))|Returns the k-th smallest value in a data set.| -||[sqrt(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-sqrt-member(1))|Returns the square root of a number.| -||[sqrtPi(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-sqrtpi-member(1))|Returns the square root of (number * Pi).| -||[stDevA(...values: Array)](/.functions#excel-javascript/api/excel/-functions-stdeva-member(1))|Estimates standard deviation based on a sample, including logical values and text.| -||[stDevPA(...values: Array)](/.functions#excel-javascript/api/excel/-functions-stdevpa-member(1))|Calculates standard deviation based on an entire population, including logical values and text.| -||[stDev_P(...values: Array)](/.functions#excel-javascript/api/excel/-functions-stdev_p-member(1))|Calculates standard deviation based on the entire population given as arguments (ignores logical values and text).| -||[stDev_S(...values: Array)](/.functions#excel-javascript/api/excel/-functions-stdev_s-member(1))|Estimates standard deviation based on a sample (ignores logical values and text in the sample).| -||[standardize(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, mean: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, standardDev: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-standardize-member(1))|Returns a normalized value from a distribution characterized by a mean and standard deviation.| -||[substitute(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, oldText: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, newText: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, instanceNum?: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-substitute-member(1))|Replaces existing text with new text in a text string.| -||[subtotal(functionNum: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, ...values: Array)](/.functions#excel-javascript/api/excel/-functions-subtotal-member(1))|Returns a subtotal in a list or database.| -||[sum(...values: Array)](/.functions#excel-javascript/api/excel/-functions-sum-member(1))|Adds all the numbers in a range of cells.| -||[sumIf(range: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, sumRange?: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-sumif-member(1))|Adds the cells specified by a given condition or criteria.| -||[sumIfs(sumRange: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, ...values: Array)](/.functions#excel-javascript/api/excel/-functions-sumifs-member(1))|Adds the cells specified by a given set of conditions or criteria.| -||[sumSq(...values: Array)](/.functions#excel-javascript/api/excel/-functions-sumsq-member(1))|Returns the sum of the squares of the arguments.| -||[syd(cost: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, salvage: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, life: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, per: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-syd-member(1))|Returns the sum-of-years' digits depreciation of an asset for a specified period.| -||[t(value: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-t-member(1))|Checks whether a value is text, and returns the text if it is, or returns double quotes (empty text) if it is not.| -||[t_Dist(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-t_dist-member(1))|Returns the left-tailed Student's t-distribution.| -||[t_Dist_2T(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-t_dist_2t-member(1))|Returns the two-tailed Student's t-distribution.| -||[t_Dist_RT(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-t_dist_rt-member(1))|Returns the right-tailed Student's t-distribution.| -||[t_Inv(probability: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-t_inv-member(1))|Returns the left-tailed inverse of the Student's t-distribution.| -||[t_Inv_2T(probability: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-t_inv_2t-member(1))|Returns the two-tailed inverse of the Student's t-distribution.| -||[tan(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-tan-member(1))|Returns the tangent of an angle.| -||[tanh(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-tanh-member(1))|Returns the hyperbolic tangent of a number.| -||[tbillEq(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, discount: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-tbilleq-member(1))|Returns the bond-equivalent yield for a treasury bill.| -||[tbillPrice(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, discount: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-tbillprice-member(1))|Returns the price per $100 face value for a treasury bill.| -||[tbillYield(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pr: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-tbillyield-member(1))|Returns the yield for a treasury bill.| -||[text(value: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, formatText: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-text-member(1))|Converts a value to text in a specific number format.| -||[time(hour: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, minute: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, second: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-time-member(1))|Converts hours, minutes, and seconds given as numbers to an Excel serial number, formatted with a time format.| -||[timevalue(timeText: string \| number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-timevalue-member(1))|Converts a text time to an Excel serial number for a time, a number from 0 (12:00:00 AM) to 0.999988426 (11:59:59 PM).| -||[today()](/.functions#excel-javascript/api/excel/-functions-today-member(1))|Returns the current date formatted as a date.| -||[trim(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-trim-member(1))|Removes all spaces from a text string except for single spaces between words.| -||[trimMean(array: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, percent: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-trimmean-member(1))|Returns the mean of the interior portion of a set of data values.| -||[true()](/.functions#excel-javascript/api/excel/-functions-true-member(1))|Returns the logical value TRUE.| -||[trunc(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numDigits?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-trunc-member(1))|Truncates a number to an integer by removing the decimal, or fractional, part of the number.| -||[type(value: boolean \| string \| number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-type-member(1))|Returns an integer representing the data type of a value: number = 1; text = 2; logical value = 4; error value = 16; array = 64; compound data = 128.| -||[unichar(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-unichar-member(1))|Returns the Unicode character referenced by the given numeric value.| -||[unicode(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-unicode-member(1))|Returns the number (code point) corresponding to the first character of the text.| -||[upper(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-upper-member(1))|Converts a text string to all uppercase letters.| -||[usdollar(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, decimals?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-usdollar-member(1))|Converts a number to text, using currency format.| -||[value(text: string \| boolean \| number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-value-member(1))|Converts a text string that represents a number to a number.| -||[varA(...values: Array)](/.functions#excel-javascript/api/excel/-functions-vara-member(1))|Estimates variance based on a sample, including logical values and text.| -||[varPA(...values: Array)](/.functions#excel-javascript/api/excel/-functions-varpa-member(1))|Calculates variance based on the entire population, including logical values and text.| -||[var_P(...values: Array)](/.functions#excel-javascript/api/excel/-functions-var_p-member(1))|Calculates variance based on the entire population (ignores logical values and text in the population).| -||[var_S(...values: Array)](/.functions#excel-javascript/api/excel/-functions-var_s-member(1))|Estimates variance based on a sample (ignores logical values and text in the sample).| -||[vdb(cost: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, salvage: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, life: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, startPeriod: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, endPeriod: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, factor?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, noSwitch?: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-vdb-member(1))|Returns the depreciation of an asset for any period you specify, including partial periods, using the double-declining balance method or some other method you specify.| -||[vlookup(lookupValue: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, tableArray: Excel.Range \| number \| Excel.RangeReference \| Excel.FunctionResult, colIndexNum: Excel.Range \| number \| Excel.RangeReference \| Excel.FunctionResult, rangeLookup?: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-vlookup-member(1))|Looks for a value in the leftmost column of a table, and then returns a value in the same row from a column you specify.| -||[weekNum(serialNumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, returnType?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-weeknum-member(1))|Returns the week number in the year.| -||[weekday(serialNumber: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, returnType?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-weekday-member(1))|Returns a number from 1 to 7 identifying the day of the week of a date.| -||[weibull_Dist(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, alpha: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, beta: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-weibull_dist-member(1))|Returns the Weibull distribution.| -||[workDay(startDate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, days: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, holidays?: number \| string \| Excel.Range \| boolean \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-workday-member(1))|Returns the serial number of the date before or after a specified number of workdays.| -||[workDay_Intl(startDate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, days: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, weekend?: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, holidays?: number \| string \| Excel.Range \| boolean \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-workday_intl-member(1))|Returns the serial number of the date before or after a specified number of workdays with custom weekend parameters.| -||[xirr(values: number \| string \| Excel.Range \| boolean \| Excel.RangeReference \| Excel.FunctionResult, dates: number \| string \| Excel.Range \| boolean \| Excel.RangeReference \| Excel.FunctionResult, guess?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-xirr-member(1))|Returns the internal rate of return for a schedule of cash flows.| -||[xnpv(rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, values: number \| string \| Excel.Range \| boolean \| Excel.RangeReference \| Excel.FunctionResult, dates: number \| string \| Excel.Range \| boolean \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-xnpv-member(1))|Returns the net present value for a schedule of cash flows.| -||[xor(...values: Array)](/.functions#excel-javascript/api/excel/-functions-xor-member(1))|Returns a logical 'Exclusive Or' of all arguments.| -||[year(serialNumber: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-year-member(1))|Returns the year of a date, an integer in the range 1900 - 9999.| -||[yearFrac(startDate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, endDate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-yearfrac-member(1))|Returns the year fraction representing the number of whole days between start_date and end_date.| -||[yield(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pr: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, redemption: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-yield-member(1))|Returns the yield on a security that pays periodic interest.| -||[yieldDisc(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pr: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, redemption: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-yielddisc-member(1))|Returns the annual yield for a discounted security.| -||[yieldMat(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, issue: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pr: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-yieldmat-member(1))|Returns the annual yield of a security that pays interest at maturity.| -||[z_Test(array: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, sigma?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/.functions#excel-javascript/api/excel/-functions-z_test-member(1))|Returns the one-tailed P-value of a z-test.| -|[Icon](/.icon)|[index](/.icon#excel-javascript/api/excel/-icon-index-member)|Specifies the index of the icon in the given set.| -|[IconCollections](/.iconcollections)|[fiveArrows](/.iconcollections#excel-javascript/api/excel/-iconcollections-fivearrows-member)|| -||[fiveArrowsGray](/.iconcollections#excel-javascript/api/excel/-iconcollections-fivearrowsgray-member)|| -||[fiveBoxes](/.iconcollections#excel-javascript/api/excel/-iconcollections-fiveboxes-member)|[Api set: ExcelApi 1.2]| -||[fiveQuarters](/.iconcollections#excel-javascript/api/excel/-iconcollections-fivequarters-member)|| -||[fiveRating](/.iconcollections#excel-javascript/api/excel/-iconcollections-fiverating-member)|| -||[fourArrows](/.iconcollections#excel-javascript/api/excel/-iconcollections-fourarrows-member)|| -||[fourArrowsGray](/.iconcollections#excel-javascript/api/excel/-iconcollections-fourarrowsgray-member)|| -||[fourRating](/.iconcollections#excel-javascript/api/excel/-iconcollections-fourrating-member)|| -||[fourRedToBlack](/.iconcollections#excel-javascript/api/excel/-iconcollections-fourredtoblack-member)|| -||[fourTrafficLights](/.iconcollections#excel-javascript/api/excel/-iconcollections-fourtrafficlights-member)|| -||[threeArrows](/.iconcollections#excel-javascript/api/excel/-iconcollections-threearrows-member)|| -||[threeArrowsGray](/.iconcollections#excel-javascript/api/excel/-iconcollections-threearrowsgray-member)|| -||[threeFlags](/.iconcollections#excel-javascript/api/excel/-iconcollections-threeflags-member)|| -||[threeSigns](/.iconcollections#excel-javascript/api/excel/-iconcollections-threesigns-member)|| -||[threeStars](/.iconcollections#excel-javascript/api/excel/-iconcollections-threestars-member)|| -||[threeSymbols2](/.iconcollections#excel-javascript/api/excel/-iconcollections-threesymbols2-member)|| -||[threeSymbols](/.iconcollections#excel-javascript/api/excel/-iconcollections-threesymbols-member)|| -||[threeTrafficLights1](/.iconcollections#excel-javascript/api/excel/-iconcollections-threetrafficlights1-member)|| -||[threeTrafficLights2](/.iconcollections#excel-javascript/api/excel/-iconcollections-threetrafficlights2-member)|| -||[threeTriangles](/.iconcollections#excel-javascript/api/excel/-iconcollections-threetriangles-member)|| -|[Range](/.range)|[columnHidden](/.range#excel-javascript/api/excel/-range-columnhidden-member)|Represents if all columns in the current range are hidden.| -||[formulasR1C1](/.range#excel-javascript/api/excel/-range-formulasr1c1-member)|Represents the formula in R1C1-style notation.| -||[getColumnsAfter(count?: number)](/.range#excel-javascript/api/excel/-range-getcolumnsafter-member(1))|Gets a certain number of columns to the right of the current `Range` object.| -||[getColumnsBefore(count?: number)](/.range#excel-javascript/api/excel/-range-getcolumnsbefore-member(1))|Gets a certain number of columns to the left of the current `Range` object.| -||[getResizedRange(deltaRows: number, deltaColumns: number)](/.range#excel-javascript/api/excel/-range-getresizedrange-member(1))|Gets a `Range` object similar to the current `Range` object, but with its bottom-right corner expanded (or contracted) by some number of rows and columns.| -||[getRowsAbove(count?: number)](/.range#excel-javascript/api/excel/-range-getrowsabove-member(1))|Gets a certain number of rows above the current `Range` object.| -||[getRowsBelow(count?: number)](/.range#excel-javascript/api/excel/-range-getrowsbelow-member(1))|Gets a certain number of rows below the current `Range` object.| -||[getUsedRange(valuesOnly?: boolean)](/.range#excel-javascript/api/excel/-range-getusedrange-member(1))|Returns the used range of the given range object.| -||[hidden](/.range#excel-javascript/api/excel/-range-hidden-member)|Represents if all cells in the current range are hidden.| -||[merge(across?: boolean)](/.range#excel-javascript/api/excel/-range-merge-member(1))|Merge the range cells into one region in the worksheet.| -||[rowHidden](/.range#excel-javascript/api/excel/-range-rowhidden-member)|Represents if all rows in the current range are hidden.| -||[sort](/.range#excel-javascript/api/excel/-range-sort-member)|Represents the range sort of the current range.| -||[unmerge()](/.range#excel-javascript/api/excel/-range-unmerge-member(1))|Unmerge the range cells into separate cells.| -|[RangeFormat](/.rangeformat)|[autofitColumns()](/.rangeformat#excel-javascript/api/excel/-rangeformat-autofitcolumns-member(1))|Changes the width of the columns of the current range to achieve the best fit, based on the current data in the columns.| -||[autofitRows()](/.rangeformat#excel-javascript/api/excel/-rangeformat-autofitrows-member(1))|Changes the height of the rows of the current range to achieve the best fit, based on the current data in the columns.| -||[columnWidth](/.rangeformat#excel-javascript/api/excel/-rangeformat-columnwidth-member)|Specifies the width of all columns within the range.| -||[protection](/.rangeformat#excel-javascript/api/excel/-rangeformat-protection-member)|Returns the format protection object for a range.| -||[rowHeight](/.rangeformat#excel-javascript/api/excel/-rangeformat-rowheight-member)|The height of all rows in the range.| -|[RangeReference](/.rangereference)|[address](/.rangereference#excel-javascript/api/excel/-rangereference-address-member)|The address of the range, for example "SheetName!A1:B5".| -|[RangeSort](/.rangesort)|[apply(fields: Excel.SortField[], matchCase?: boolean, hasHeaders?: boolean, orientation?: Excel.SortOrientation, method?: Excel.SortMethod)](/.rangesort#excel-javascript/api/excel/-rangesort-apply-member(1))|Perform a sort operation.| -|[SelectionChangedEventArgs](/.selectionchangedeventargs)|[workbook](/.selectionchangedeventargs#excel-javascript/api/excel/-selectionchangedeventargs-workbook-member)|Gets the workbook object that raised the selection changed event.| -|[SortField](/.sortfield)|[ascending](/.sortfield#excel-javascript/api/excel/-sortfield-ascending-member)|Specifies if the sorting is done in an ascending fashion.| -||[color](/.sortfield#excel-javascript/api/excel/-sortfield-color-member)|Specifies the color that is the target of the condition if the sorting is on font or cell color.| -||[dataOption](/.sortfield#excel-javascript/api/excel/-sortfield-dataoption-member)|Represents additional sorting options for this field.| -||[icon](/.sortfield#excel-javascript/api/excel/-sortfield-icon-member)|Specifies the icon that is the target of the condition, if the sorting is on the cell's icon.| -||[key](/.sortfield#excel-javascript/api/excel/-sortfield-key-member)|Specifies the column (or row, depending on the sort orientation) that the condition is on.| -||[sortOn](/.sortfield#excel-javascript/api/excel/-sortfield-sorton-member)|Specifies the type of sorting of this condition.| -|[Table](/.table)|[clearFilters()](/.table#excel-javascript/api/excel/-table-clearfilters-member(1))|Clears all the filters currently applied on the table.| -||[convertToRange()](/.table#excel-javascript/api/excel/-table-converttorange-member(1))|Converts the table into a normal range of cells.| -||[reapplyFilters()](/.table#excel-javascript/api/excel/-table-reapplyfilters-member(1))|Reapplies all the filters currently on the table.| -||[sort](/.table#excel-javascript/api/excel/-table-sort-member)|Represents the sorting for the table.| -||[worksheet](/.table#excel-javascript/api/excel/-table-worksheet-member)|The worksheet containing the current table.| -|[TableColumn](/.tablecolumn)|[filter](/.tablecolumn#excel-javascript/api/excel/-tablecolumn-filter-member)|Retrieves the filter applied to the column.| -|[TableSort](/.tablesort)|[apply(fields: Excel.SortField[], matchCase?: boolean, method?: Excel.SortMethod)](/.tablesort#excel-javascript/api/excel/-tablesort-apply-member(1))|Perform a sort operation.| -||[clear()](/.tablesort#excel-javascript/api/excel/-tablesort-clear-member(1))|Clears the sorting that is currently on the table.| -||[fields](/.tablesort#excel-javascript/api/excel/-tablesort-fields-member)|Specifies the current conditions used to last sort the table.| -||[matchCase](/.tablesort#excel-javascript/api/excel/-tablesort-matchcase-member)|Specifies if the casing impacts the last sort of the table.| -||[method](/.tablesort#excel-javascript/api/excel/-tablesort-method-member)|Represents the Chinese character ordering method last used to sort the table.| -||[reapply()](/.tablesort#excel-javascript/api/excel/-tablesort-reapply-member(1))|Reapplies the current sorting parameters to the table.| -|[ThreeArrowsGraySet](/.threearrowsgrayset)|[grayDownArrow](/.threearrowsgrayset#excel-javascript/api/excel/-threearrowsgrayset-graydownarrow-member)|| -||[graySideArrow](/.threearrowsgrayset#excel-javascript/api/excel/-threearrowsgrayset-graysidearrow-member)|| -||[grayUpArrow](/.threearrowsgrayset#excel-javascript/api/excel/-threearrowsgrayset-grayuparrow-member)|| -|[ThreeArrowsSet](/.threearrowsset)|[greenUpArrow](/.threearrowsset#excel-javascript/api/excel/-threearrowsset-greenuparrow-member)|| -||[redDownArrow](/.threearrowsset#excel-javascript/api/excel/-threearrowsset-reddownarrow-member)|| -||[yellowSideArrow](/.threearrowsset#excel-javascript/api/excel/-threearrowsset-yellowsidearrow-member)|| -|[ThreeFlagsSet](/.threeflagsset)|[greenFlag](/.threeflagsset#excel-javascript/api/excel/-threeflagsset-greenflag-member)|| -||[redFlag](/.threeflagsset#excel-javascript/api/excel/-threeflagsset-redflag-member)|| -||[yellowFlag](/.threeflagsset#excel-javascript/api/excel/-threeflagsset-yellowflag-member)|| -|[ThreeSignsSet](/.threesignsset)|[greenCircle](/.threesignsset#excel-javascript/api/excel/-threesignsset-greencircle-member)|| -||[redDiamond](/.threesignsset#excel-javascript/api/excel/-threesignsset-reddiamond-member)|| -||[yellowTriangle](/.threesignsset#excel-javascript/api/excel/-threesignsset-yellowtriangle-member)|| -|[ThreeStarsSet](/.threestarsset)|[goldStar](/.threestarsset#excel-javascript/api/excel/-threestarsset-goldstar-member)|| -||[halfGoldStar](/.threestarsset#excel-javascript/api/excel/-threestarsset-halfgoldstar-member)|| -||[silverStar](/.threestarsset#excel-javascript/api/excel/-threestarsset-silverstar-member)|| -|[ThreeSymbols2Set](/.threesymbols2set)|[greenCheck](/.threesymbols2set#excel-javascript/api/excel/-threesymbols2set-greencheck-member)|| -||[redCross](/.threesymbols2set#excel-javascript/api/excel/-threesymbols2set-redcross-member)|| -||[yellowExclamation](/.threesymbols2set#excel-javascript/api/excel/-threesymbols2set-yellowexclamation-member)|| -|[ThreeSymbolsSet](/.threesymbolsset)|[greenCheckSymbol](/.threesymbolsset#excel-javascript/api/excel/-threesymbolsset-greenchecksymbol-member)|| -||[redCrossSymbol](/.threesymbolsset#excel-javascript/api/excel/-threesymbolsset-redcrosssymbol-member)|| -||[yellowExclamationSymbol](/.threesymbolsset#excel-javascript/api/excel/-threesymbolsset-yellowexclamationsymbol-member)|| -|[ThreeTrafficLights1Set](/.threetrafficlights1set)|[greenCircle](/.threetrafficlights1set#excel-javascript/api/excel/-threetrafficlights1set-greencircle-member)|| -||[redCircleWithBorder](/.threetrafficlights1set#excel-javascript/api/excel/-threetrafficlights1set-redcirclewithborder-member)|| -||[yellowCircle](/.threetrafficlights1set#excel-javascript/api/excel/-threetrafficlights1set-yellowcircle-member)|| -|[ThreeTrafficLights2Set](/.threetrafficlights2set)|[greenTrafficLight](/.threetrafficlights2set#excel-javascript/api/excel/-threetrafficlights2set-greentrafficlight-member)|| -||[redTrafficLight](/.threetrafficlights2set#excel-javascript/api/excel/-threetrafficlights2set-redtrafficlight-member)|| -||[yellowTrafficLight](/.threetrafficlights2set#excel-javascript/api/excel/-threetrafficlights2set-yellowtrafficlight-member)|| -|[ThreeTrianglesSet](/.threetrianglesset)|[greenUpTriangle](/.threetrianglesset#excel-javascript/api/excel/-threetrianglesset-greenuptriangle-member)|| -||[redDownTriangle](/.threetrianglesset#excel-javascript/api/excel/-threetrianglesset-reddowntriangle-member)|| -||[yellowDash](/.threetrianglesset#excel-javascript/api/excel/-threetrianglesset-yellowdash-member)|| -|[Workbook](/.workbook)|[functions](/.workbook#excel-javascript/api/excel/-workbook-functions-member)|Represents a collection of worksheet functions that can be used for computation.| -||[onSelectionChanged](/.workbook#excel-javascript/api/excel/-workbook-onselectionchanged-member)|Occurs when the selection in the document is changed.| -|[Worksheet](/.worksheet)|[getUsedRange(valuesOnly?: boolean)](/.worksheet#excel-javascript/api/excel/-worksheet-getusedrange-member(1))|The used range is the smallest range that encompasses any cells that have a value or formatting assigned to them.| -||[protection](/.worksheet#excel-javascript/api/excel/-worksheet-protection-member)|Returns the sheet protection object for a worksheet.| -|[WorksheetProtection](/.worksheetprotection)|[options](/.worksheetprotection#excel-javascript/api/excel/-worksheetprotection-options-member)|Specifies the protection options for the worksheet.| -||[protect(options?: Excel.WorksheetProtectionOptions, password?: string)](/.worksheetprotection#excel-javascript/api/excel/-worksheetprotection-protect-member(1))|Protects a worksheet.| -||[protected](/.worksheetprotection#excel-javascript/api/excel/-worksheetprotection-protected-member)|Specifies if the worksheet is protected.| -|[WorksheetProtectionOptions](/.worksheetprotectionoptions)|[allowAutoFilter](/.worksheetprotectionoptions#excel-javascript/api/excel/-worksheetprotectionoptions-allowautofilter-member)|Represents the worksheet protection option allowing use of the AutoFilter feature.| -||[allowDeleteColumns](/.worksheetprotectionoptions#excel-javascript/api/excel/-worksheetprotectionoptions-allowdeletecolumns-member)|Represents the worksheet protection option allowing deleting of columns.| -||[allowDeleteRows](/.worksheetprotectionoptions#excel-javascript/api/excel/-worksheetprotectionoptions-allowdeleterows-member)|Represents the worksheet protection option allowing deleting of rows.| -||[allowFormatCells](/.worksheetprotectionoptions#excel-javascript/api/excel/-worksheetprotectionoptions-allowformatcells-member)|Represents the worksheet protection option allowing formatting of cells.| -||[allowFormatColumns](/.worksheetprotectionoptions#excel-javascript/api/excel/-worksheetprotectionoptions-allowformatcolumns-member)|Represents the worksheet protection option allowing formatting of columns.| -||[allowFormatRows](/.worksheetprotectionoptions#excel-javascript/api/excel/-worksheetprotectionoptions-allowformatrows-member)|Represents the worksheet protection option allowing formatting of rows.| -||[allowInsertColumns](/.worksheetprotectionoptions#excel-javascript/api/excel/-worksheetprotectionoptions-allowinsertcolumns-member)|Represents the worksheet protection option allowing inserting of columns.| -||[allowInsertHyperlinks](/.worksheetprotectionoptions#excel-javascript/api/excel/-worksheetprotectionoptions-allowinserthyperlinks-member)|Represents the worksheet protection option allowing inserting of hyperlinks.| -||[allowInsertRows](/.worksheetprotectionoptions#excel-javascript/api/excel/-worksheetprotectionoptions-allowinsertrows-member)|Represents the worksheet protection option allowing inserting of rows.| -||[allowPivotTables](/.worksheetprotectionoptions#excel-javascript/api/excel/-worksheetprotectionoptions-allowpivottables-member)|Represents the worksheet protection option allowing use of the PivotTable feature.| -||[allowSort](/.worksheetprotectionoptions#excel-javascript/api/excel/-worksheetprotectionoptions-allowsort-member)|Represents the worksheet protection option allowing use of the sort feature.| +|[Binding](/javascript/api/excel/excel.binding)|[onDataChanged](/javascript/api/excel/excel.binding#excel-excel-binding-ondatachanged-member)|Occurs when data or formatting within the binding is changed.| +||[onSelectionChanged](/javascript/api/excel/excel.binding#excel-excel-binding-onselectionchanged-member)|Occurs when the selected content in the binding is changed.| +|[BindingDataChangedEventArgs](/javascript/api/excel/excel.bindingdatachangedeventargs)|[binding](/javascript/api/excel/excel.bindingdatachangedeventargs#excel-excel-bindingdatachangedeventargs-binding-member)|Gets a temporary `Binding` object that contains the ID of the `Binding` object that raised the event.| +|[BindingSelectionChangedEventArgs](/javascript/api/excel/excel.bindingselectionchangedeventargs)|[binding](/javascript/api/excel/excel.bindingselectionchangedeventargs#excel-excel-bindingselectionchangedeventargs-binding-member)|Gets a temporary `Binding` object that contains the ID of the `Binding` object that raised the event.| +||[columnCount](/javascript/api/excel/excel.bindingselectionchangedeventargs#excel-excel-bindingselectionchangedeventargs-columncount-member)|Gets the number of columns selected.| +||[rowCount](/javascript/api/excel/excel.bindingselectionchangedeventargs#excel-excel-bindingselectionchangedeventargs-rowcount-member)|Gets the number of rows selected.| +||[startColumn](/javascript/api/excel/excel.bindingselectionchangedeventargs#excel-excel-bindingselectionchangedeventargs-startcolumn-member)|Gets the index of the first column of the selection (zero-based).| +||[startRow](/javascript/api/excel/excel.bindingselectionchangedeventargs#excel-excel-bindingselectionchangedeventargs-startrow-member)|Gets the index of the first row of the selection (zero-based).| +|[Chart](/javascript/api/excel/excel.chart)|[getImage(width?: number, height?: number, fittingMode?: Excel.ImageFittingMode)](/javascript/api/excel/excel.chart#excel-excel-chart-getimage-member(1))|Renders the chart as a Base64-encoded image by scaling the chart to fit the specified dimensions.| +||[worksheet](/javascript/api/excel/excel.chart#excel-excel-chart-worksheet-member)|The worksheet containing the current chart.| +|[Filter](/javascript/api/excel/excel.filter)|[apply(criteria: Excel.FilterCriteria)](/javascript/api/excel/excel.filter#excel-excel-filter-apply-member(1))|Apply the given filter criteria on the given column.| +||[applyBottomItemsFilter(count: number)](/javascript/api/excel/excel.filter#excel-excel-filter-applybottomitemsfilter-member(1))|Apply a "Bottom Item" filter to the column for the given number of elements.| +||[applyBottomPercentFilter(percent: number)](/javascript/api/excel/excel.filter#excel-excel-filter-applybottompercentfilter-member(1))|Apply a "Bottom Percent" filter to the column for the given percentage of elements.| +||[applyCellColorFilter(color: string)](/javascript/api/excel/excel.filter#excel-excel-filter-applycellcolorfilter-member(1))|Apply a "Cell Color" filter to the column for the given color.| +||[applyCustomFilter(criteria1: string, criteria2?: string, oper?: Excel.FilterOperator)](/javascript/api/excel/excel.filter#excel-excel-filter-applycustomfilter-member(1))|Apply an "Icon" filter to the column for the given criteria strings.| +||[applyDynamicFilter(criteria: Excel.DynamicFilterCriteria)](/javascript/api/excel/excel.filter#excel-excel-filter-applydynamicfilter-member(1))|Apply a "Dynamic" filter to the column.| +||[applyFontColorFilter(color: string)](/javascript/api/excel/excel.filter#excel-excel-filter-applyfontcolorfilter-member(1))|Apply a "Font Color" filter to the column for the given color.| +||[applyIconFilter(icon: Excel.Icon)](/javascript/api/excel/excel.filter#excel-excel-filter-applyiconfilter-member(1))|Apply an "Icon" filter to the column for the given icon.| +||[applyTopItemsFilter(count: number)](/javascript/api/excel/excel.filter#excel-excel-filter-applytopitemsfilter-member(1))|Apply a "Top Item" filter to the column for the given number of elements.| +||[applyTopPercentFilter(percent: number)](/javascript/api/excel/excel.filter#excel-excel-filter-applytoppercentfilter-member(1))|Apply a "Top Percent" filter to the column for the given percentage of elements.| +||[applyValuesFilter(values: Array)](/javascript/api/excel/excel.filter#excel-excel-filter-applyvaluesfilter-member(1))|Apply a "Values" filter to the column for the given values.| +||[clear()](/javascript/api/excel/excel.filter#excel-excel-filter-clear-member(1))|Clear the filter on the given column.| +||[criteria](/javascript/api/excel/excel.filter#excel-excel-filter-criteria-member)|The currently applied filter on the given column.| +|[FilterCriteria](/javascript/api/excel/excel.filtercriteria)|[color](/javascript/api/excel/excel.filtercriteria#excel-excel-filtercriteria-color-member)|The HTML color string used to filter cells.| +||[criterion1](/javascript/api/excel/excel.filtercriteria#excel-excel-filtercriteria-criterion1-member)|The first criterion used to filter data.| +||[criterion2](/javascript/api/excel/excel.filtercriteria#excel-excel-filtercriteria-criterion2-member)|The second criterion used to filter data.| +||[dynamicCriteria](/javascript/api/excel/excel.filtercriteria#excel-excel-filtercriteria-dynamiccriteria-member)|The dynamic criteria from the `Excel.DynamicFilterCriteria` set to apply on this column.| +||[filterOn](/javascript/api/excel/excel.filtercriteria#excel-excel-filtercriteria-filteron-member)|The property used by the filter to determine whether the values should stay visible.| +||[icon](/javascript/api/excel/excel.filtercriteria#excel-excel-filtercriteria-icon-member)|The icon used to filter cells.| +||[operator](/javascript/api/excel/excel.filtercriteria#excel-excel-filtercriteria-operator-member)|The operator used to combine criterion 1 and 2 when using `custom` filtering.| +||[values](/javascript/api/excel/excel.filtercriteria#excel-excel-filtercriteria-values-member)|The set of values to be used as part of `values` filtering.| +|[FilterDatetime](/javascript/api/excel/excel.filterdatetime)|[date](/javascript/api/excel/excel.filterdatetime#excel-excel-filterdatetime-date-member)|The date in ISO8601 format used to filter data.| +||[specificity](/javascript/api/excel/excel.filterdatetime#excel-excel-filterdatetime-specificity-member)|How specific the date should be used to keep data.| +|[FiveArrowsGraySet](/javascript/api/excel/excel.fivearrowsgrayset)|[grayDownArrow](/javascript/api/excel/excel.fivearrowsgrayset#excel-excel-fivearrowsgrayset-graydownarrow-member)|| +||[grayDownInclineArrow](/javascript/api/excel/excel.fivearrowsgrayset#excel-excel-fivearrowsgrayset-graydowninclinearrow-member)|| +||[graySideArrow](/javascript/api/excel/excel.fivearrowsgrayset#excel-excel-fivearrowsgrayset-graysidearrow-member)|| +||[grayUpArrow](/javascript/api/excel/excel.fivearrowsgrayset#excel-excel-fivearrowsgrayset-grayuparrow-member)|| +||[grayUpInclineArrow](/javascript/api/excel/excel.fivearrowsgrayset#excel-excel-fivearrowsgrayset-grayupinclinearrow-member)|| +|[FiveArrowsSet](/javascript/api/excel/excel.fivearrowsset)|[greenUpArrow](/javascript/api/excel/excel.fivearrowsset#excel-excel-fivearrowsset-greenuparrow-member)|| +||[redDownArrow](/javascript/api/excel/excel.fivearrowsset#excel-excel-fivearrowsset-reddownarrow-member)|| +||[yellowDownInclineArrow](/javascript/api/excel/excel.fivearrowsset#excel-excel-fivearrowsset-yellowdowninclinearrow-member)|| +||[yellowSideArrow](/javascript/api/excel/excel.fivearrowsset#excel-excel-fivearrowsset-yellowsidearrow-member)|| +||[yellowUpInclineArrow](/javascript/api/excel/excel.fivearrowsset#excel-excel-fivearrowsset-yellowupinclinearrow-member)|| +|[FiveBoxesSet](/javascript/api/excel/excel.fiveboxesset)|[fourFilledBoxes](/javascript/api/excel/excel.fiveboxesset#excel-excel-fiveboxesset-fourfilledboxes-member)|| +||[noFilledBoxes](/javascript/api/excel/excel.fiveboxesset#excel-excel-fiveboxesset-nofilledboxes-member)|| +||[oneFilledBox](/javascript/api/excel/excel.fiveboxesset#excel-excel-fiveboxesset-onefilledbox-member)|| +||[threeFilledBoxes](/javascript/api/excel/excel.fiveboxesset#excel-excel-fiveboxesset-threefilledboxes-member)|| +||[twoFilledBoxes](/javascript/api/excel/excel.fiveboxesset#excel-excel-fiveboxesset-twofilledboxes-member)|| +|[FiveQuartersSet](/javascript/api/excel/excel.fivequartersset)|[blackCircle](/javascript/api/excel/excel.fivequartersset#excel-excel-fivequartersset-blackcircle-member)|| +||[circleWithOneWhiteQuarter](/javascript/api/excel/excel.fivequartersset#excel-excel-fivequartersset-circlewithonewhitequarter-member)|| +||[circleWithThreeWhiteQuarters](/javascript/api/excel/excel.fivequartersset#excel-excel-fivequartersset-circlewiththreewhitequarters-member)|| +||[circleWithTwoWhiteQuarters](/javascript/api/excel/excel.fivequartersset#excel-excel-fivequartersset-circlewithtwowhitequarters-member)|| +||[whiteCircleAllWhiteQuarters](/javascript/api/excel/excel.fivequartersset#excel-excel-fivequartersset-whitecircleallwhitequarters-member)|| +|[FiveRatingSet](/javascript/api/excel/excel.fiveratingset)|[fourBars](/javascript/api/excel/excel.fiveratingset#excel-excel-fiveratingset-fourbars-member)|| +||[noBars](/javascript/api/excel/excel.fiveratingset#excel-excel-fiveratingset-nobars-member)|| +||[oneBar](/javascript/api/excel/excel.fiveratingset#excel-excel-fiveratingset-onebar-member)|| +||[threeBars](/javascript/api/excel/excel.fiveratingset#excel-excel-fiveratingset-threebars-member)|| +||[twoBars](/javascript/api/excel/excel.fiveratingset#excel-excel-fiveratingset-twobars-member)|| +|[FormatProtection](/javascript/api/excel/excel.formatprotection)|[formulaHidden](/javascript/api/excel/excel.formatprotection#excel-excel-formatprotection-formulahidden-member)|Specifies if Excel hides the formula for the cells in the range.| +||[locked](/javascript/api/excel/excel.formatprotection#excel-excel-formatprotection-locked-member)|Specifies if Excel locks the cells in the object.| +|[FourArrowsGraySet](/javascript/api/excel/excel.fourarrowsgrayset)|[grayDownArrow](/javascript/api/excel/excel.fourarrowsgrayset#excel-excel-fourarrowsgrayset-graydownarrow-member)|| +||[grayDownInclineArrow](/javascript/api/excel/excel.fourarrowsgrayset#excel-excel-fourarrowsgrayset-graydowninclinearrow-member)|| +||[grayUpArrow](/javascript/api/excel/excel.fourarrowsgrayset#excel-excel-fourarrowsgrayset-grayuparrow-member)|| +||[grayUpInclineArrow](/javascript/api/excel/excel.fourarrowsgrayset#excel-excel-fourarrowsgrayset-grayupinclinearrow-member)|| +|[FourArrowsSet](/javascript/api/excel/excel.fourarrowsset)|[greenUpArrow](/javascript/api/excel/excel.fourarrowsset#excel-excel-fourarrowsset-greenuparrow-member)|| +||[redDownArrow](/javascript/api/excel/excel.fourarrowsset#excel-excel-fourarrowsset-reddownarrow-member)|| +||[yellowDownInclineArrow](/javascript/api/excel/excel.fourarrowsset#excel-excel-fourarrowsset-yellowdowninclinearrow-member)|| +||[yellowUpInclineArrow](/javascript/api/excel/excel.fourarrowsset#excel-excel-fourarrowsset-yellowupinclinearrow-member)|| +|[FourRatingSet](/javascript/api/excel/excel.fourratingset)|[fourBars](/javascript/api/excel/excel.fourratingset#excel-excel-fourratingset-fourbars-member)|| +||[oneBar](/javascript/api/excel/excel.fourratingset#excel-excel-fourratingset-onebar-member)|| +||[threeBars](/javascript/api/excel/excel.fourratingset#excel-excel-fourratingset-threebars-member)|| +||[twoBars](/javascript/api/excel/excel.fourratingset#excel-excel-fourratingset-twobars-member)|| +|[FourRedToBlackSet](/javascript/api/excel/excel.fourredtoblackset)|[blackCircle](/javascript/api/excel/excel.fourredtoblackset#excel-excel-fourredtoblackset-blackcircle-member)|| +||[grayCircle](/javascript/api/excel/excel.fourredtoblackset#excel-excel-fourredtoblackset-graycircle-member)|| +||[pinkCircle](/javascript/api/excel/excel.fourredtoblackset#excel-excel-fourredtoblackset-pinkcircle-member)|| +||[redCircle](/javascript/api/excel/excel.fourredtoblackset#excel-excel-fourredtoblackset-redcircle-member)|| +|[FourTrafficLightsSet](/javascript/api/excel/excel.fourtrafficlightsset)|[blackCircleWithBorder](/javascript/api/excel/excel.fourtrafficlightsset#excel-excel-fourtrafficlightsset-blackcirclewithborder-member)|| +||[greenCircle](/javascript/api/excel/excel.fourtrafficlightsset#excel-excel-fourtrafficlightsset-greencircle-member)|| +||[redCircleWithBorder](/javascript/api/excel/excel.fourtrafficlightsset#excel-excel-fourtrafficlightsset-redcirclewithborder-member)|| +||[yellowCircle](/javascript/api/excel/excel.fourtrafficlightsset#excel-excel-fourtrafficlightsset-yellowcircle-member)|| +|[FunctionResult](/javascript/api/excel/excel.functionresult)|[error](/javascript/api/excel/excel.functionresult#excel-excel-functionresult-error-member)|Error value (such as "#DIV/0") representing the error.| +||[value](/javascript/api/excel/excel.functionresult#excel-excel-functionresult-value-member)|The value of function evaluation.| +|[Functions](/javascript/api/excel/excel.functions)|[abs(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-abs-member(1))|Returns the absolute value of a number, a number without its sign.| +||[accrInt(issue: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, firstInterest: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, par: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, calcMethod?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-accrint-member(1))|Returns the accrued interest for a security that pays periodic interest.| +||[accrIntM(issue: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, par: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-accrintm-member(1))|Returns the accrued interest for a security that pays interest at maturity.| +||[acos(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-acos-member(1))|Returns the arccosine of a number, in radians in the range 0 to Pi.| +||[acosh(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-acosh-member(1))|Returns the inverse hyperbolic cosine of a number.| +||[acot(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-acot-member(1))|Returns the arccotangent of a number, in radians in the range 0 to Pi.| +||[acoth(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-acoth-member(1))|Returns the inverse hyperbolic cotangent of a number.| +||[amorDegrc(cost: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, datePurchased: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, firstPeriod: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, salvage: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, period: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-amordegrc-member(1))|Returns the prorated linear depreciation of an asset for each accounting period.| +||[amorLinc(cost: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, datePurchased: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, firstPeriod: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, salvage: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, period: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-amorlinc-member(1))|Returns the prorated linear depreciation of an asset for each accounting period.| +||[and(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-and-member(1))|Checks whether all arguments are TRUE, and returns TRUE if all arguments are TRUE.| +||[arabic(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-arabic-member(1))|Converts a Roman numeral to Arabic.| +||[areas(reference: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-areas-member(1))|Returns the number of areas in a reference.| +||[asc(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-asc-member(1))|Changes full-width (double-byte) characters to half-width (single-byte) characters.| +||[asin(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-asin-member(1))|Returns the arcsine of a number in radians, in the range -Pi/2 to Pi/2.| +||[asinh(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-asinh-member(1))|Returns the inverse hyperbolic sine of a number.| +||[atan(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-atan-member(1))|Returns the arctangent of a number in radians, in the range -Pi/2 to Pi/2.| +||[atan2(xNum: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, yNum: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-atan2-member(1))|Returns the arctangent of the specified x- and y- coordinates, in radians between -Pi and Pi, excluding -Pi.| +||[atanh(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-atanh-member(1))|Returns the inverse hyperbolic tangent of a number.| +||[aveDev(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-avedev-member(1))|Returns the average of the absolute deviations of data points from their mean.| +||[average(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-average-member(1))|Returns the average (arithmetic mean) of its arguments, which can be numbers or names, arrays, or references that contain numbers.| +||[averageA(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-averagea-member(1))|Returns the average (arithmetic mean) of its arguments, evaluating text and FALSE in arguments as 0; TRUE evaluates as 1.| +||[averageIf(range: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, averageRange?: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-averageif-member(1))|Finds average(arithmetic mean) for the cells specified by a given condition or criteria.| +||[averageIfs(averageRange: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, ...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-averageifs-member(1))|Finds average(arithmetic mean) for the cells specified by a given set of conditions or criteria.| +||[bahtText(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-bahttext-member(1))|Converts a number to text (baht).| +||[base(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, radix: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, minLength?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-base-member(1))|Converts a number into a text representation with the given radix (base).| +||[besselI(x: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, n: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-besseli-member(1))|Returns the modified Bessel function In(x).| +||[besselJ(x: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, n: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-besselj-member(1))|Returns the Bessel function Jn(x).| +||[besselK(x: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, n: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-besselk-member(1))|Returns the modified Bessel function Kn(x).| +||[besselY(x: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, n: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-bessely-member(1))|Returns the Bessel function Yn(x).| +||[beta_Dist(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, alpha: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, beta: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, A?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, B?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-beta_dist-member(1))|Returns the beta probability distribution function.| +||[beta_Inv(probability: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, alpha: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, beta: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, A?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, B?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-beta_inv-member(1))|Returns the inverse of the cumulative beta probability density function (BETA.DIST).| +||[bin2Dec(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-bin2dec-member(1))|Converts a binary number to decimal.| +||[bin2Hex(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, places?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-bin2hex-member(1))|Converts a binary number to hexadecimal.| +||[bin2Oct(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, places?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-bin2oct-member(1))|Converts a binary number to octal.| +||[binom_Dist(numberS: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, trials: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, probabilityS: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-binom_dist-member(1))|Returns the individual term binomial distribution probability.| +||[binom_Dist_Range(trials: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, probabilityS: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numberS: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numberS2?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-binom_dist_range-member(1))|Returns the probability of a trial result using a binomial distribution.| +||[binom_Inv(trials: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, probabilityS: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, alpha: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-binom_inv-member(1))|Returns the smallest value for which the cumulative binomial distribution is greater than or equal to a criterion value.| +||[bitand(number1: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, number2: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-bitand-member(1))|Returns a bitwise 'And' of two numbers.| +||[bitlshift(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, shiftAmount: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-bitlshift-member(1))|Returns a number shifted left by shift_amount bits.| +||[bitor(number1: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, number2: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-bitor-member(1))|Returns a bitwise 'Or' of two numbers.| +||[bitrshift(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, shiftAmount: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-bitrshift-member(1))|Returns a number shifted right by shift_amount bits.| +||[bitxor(number1: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, number2: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-bitxor-member(1))|Returns a bitwise 'Exclusive Or' of two numbers.| +||[ceiling_Math(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, significance?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, mode?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-ceiling_math-member(1))|Rounds a number up, to the nearest integer or to the nearest multiple of significance.| +||[ceiling_Precise(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, significance?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-ceiling_precise-member(1))|Rounds a number up, to the nearest integer or to the nearest multiple of significance.| +||[char(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-char-member(1))|Returns the character specified by the code number from the character set for your computer.| +||[chiSq_Dist(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-chisq_dist-member(1))|Returns the left-tailed probability of the chi-squared distribution.| +||[chiSq_Dist_RT(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-chisq_dist_rt-member(1))|Returns the right-tailed probability of the chi-squared distribution.| +||[chiSq_Inv(probability: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-chisq_inv-member(1))|Returns the inverse of the left-tailed probability of the chi-squared distribution.| +||[chiSq_Inv_RT(probability: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-chisq_inv_rt-member(1))|Returns the inverse of the right-tailed probability of the chi-squared distribution.| +||[choose(indexNum: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, ...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-choose-member(1))|Chooses a value or action to perform from a list of values, based on an index number.| +||[clean(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-clean-member(1))|Removes all nonprintable characters from text.| +||[code(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-code-member(1))|Returns a numeric code for the first character in a text string, in the character set used by your computer.| +||[columns(array: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-columns-member(1))|Returns the number of columns in an array or reference.| +||[combin(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numberChosen: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-combin-member(1))|Returns the number of combinations for a given number of items.| +||[combina(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numberChosen: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-combina-member(1))|Returns the number of combinations with repetitions for a given number of items.| +||[complex(realNum: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, iNum: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, suffix?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-complex-member(1))|Converts real and imaginary coefficients into a complex number.| +||[concatenate(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-concatenate-member(1))|Joins several text strings into one text string.| +||[confidence_Norm(alpha: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, standardDev: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, size: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-confidence_norm-member(1))|Returns the confidence interval for a population mean, using a normal distribution.| +||[confidence_T(alpha: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, standardDev: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, size: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-confidence_t-member(1))|Returns the confidence interval for a population mean, using a Student's T distribution.| +||[convert(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, fromUnit: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, toUnit: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-convert-member(1))|Converts a number from one measurement system to another.| +||[cos(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-cos-member(1))|Returns the cosine of an angle.| +||[cosh(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-cosh-member(1))|Returns the hyperbolic cosine of a number.| +||[cot(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-cot-member(1))|Returns the cotangent of an angle.| +||[coth(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-coth-member(1))|Returns the hyperbolic cotangent of a number.| +||[count(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-count-member(1))|Counts the number of cells in a range that contain numbers.| +||[countA(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-counta-member(1))|Counts the number of cells in a range that are not empty.| +||[countBlank(range: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-countblank-member(1))|Counts the number of empty cells in a specified range of cells.| +||[countIf(range: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-countif-member(1))|Counts the number of cells within a range that meet the given condition.| +||[countIfs(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-countifs-member(1))|Counts the number of cells specified by a given set of conditions or criteria.| +||[coupDayBs(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-coupdaybs-member(1))|Returns the number of days from the beginning of the coupon period to the settlement date.| +||[coupDays(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-coupdays-member(1))|Returns the number of days in the coupon period that contains the settlement date.| +||[coupDaysNc(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-coupdaysnc-member(1))|Returns the number of days from the settlement date to the next coupon date.| +||[coupNcd(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-coupncd-member(1))|Returns the next coupon date after the settlement date.| +||[coupNum(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-coupnum-member(1))|Returns the number of coupons payable between the settlement date and maturity date.| +||[coupPcd(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-couppcd-member(1))|Returns the previous coupon date before the settlement date.| +||[csc(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-csc-member(1))|Returns the cosecant of an angle.| +||[csch(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-csch-member(1))|Returns the hyperbolic cosecant of an angle.| +||[cumIPmt(rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, nper: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pv: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, startPeriod: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, endPeriod: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, type: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-cumipmt-member(1))|Returns the cumulative interest paid between two periods.| +||[cumPrinc(rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, nper: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pv: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, startPeriod: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, endPeriod: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, type: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-cumprinc-member(1))|Returns the cumulative principal paid on a loan between two periods.| +||[date(year: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, month: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, day: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-date-member(1))|Returns the number that represents the date in Microsoft Excel date-time code.| +||[datevalue(dateText: string \| number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-datevalue-member(1))|Converts a date in the form of text to a number that represents the date in Microsoft Excel date-time code.| +||[daverage(database: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, field: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-daverage-member(1))|Averages the values in a column in a list or database that match conditions you specify.| +||[day(serialNumber: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-day-member(1))|Returns the day of the month, a number from 1 to 31.| +||[days(endDate: string \| number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, startDate: string \| number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-days-member(1))|Returns the number of days between the two dates.| +||[days360(startDate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, endDate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, method?: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-days360-member(1))|Returns the number of days between two dates based on a 360-day year (twelve 30-day months).| +||[db(cost: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, salvage: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, life: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, period: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, month?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-db-member(1))|Returns the depreciation of an asset for a specified period using the fixed-declining balance method.| +||[dbcs(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-dbcs-member(1))|Changes half-width (single-byte) characters within a character string to full-width (double-byte) characters.| +||[dcount(database: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, field: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-dcount-member(1))|Counts the cells containing numbers in the field (column) of records in the database that match the conditions you specify.| +||[dcountA(database: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, field: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-dcounta-member(1))|Counts nonblank cells in the field (column) of records in the database that match the conditions you specify.| +||[ddb(cost: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, salvage: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, life: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, period: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, factor?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-ddb-member(1))|Returns the depreciation of an asset for a specified period using the double-declining balance method or some other method you specify.| +||[dec2Bin(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, places?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-dec2bin-member(1))|Converts a decimal number to binary.| +||[dec2Hex(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, places?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-dec2hex-member(1))|Converts a decimal number to hexadecimal.| +||[dec2Oct(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, places?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-dec2oct-member(1))|Converts a decimal number to octal.| +||[decimal(number: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, radix: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-decimal-member(1))|Converts a text representation of a number in a given base into a decimal number.| +||[degrees(angle: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-degrees-member(1))|Converts radians to degrees.| +||[delta(number1: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, number2?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-delta-member(1))|Tests whether two numbers are equal.| +||[devSq(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-devsq-member(1))|Returns the sum of squares of deviations of data points from their sample mean.| +||[dget(database: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, field: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-dget-member(1))|Extracts from a database a single record that matches the conditions you specify.| +||[disc(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pr: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, redemption: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-disc-member(1))|Returns the discount rate for a security.| +||[dmax(database: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, field: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-dmax-member(1))|Returns the largest number in the field (column) of records in the database that match the conditions you specify.| +||[dmin(database: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, field: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-dmin-member(1))|Returns the smallest number in the field (column) of records in the database that match the conditions you specify.| +||[dollar(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, decimals?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-dollar-member(1))|Converts a number to text, using currency format.| +||[dollarDe(fractionalDollar: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, fraction: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-dollarde-member(1))|Converts a dollar price, expressed as a fraction, into a dollar price, expressed as a decimal number.| +||[dollarFr(decimalDollar: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, fraction: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-dollarfr-member(1))|Converts a dollar price, expressed as a decimal number, into a dollar price, expressed as a fraction.| +||[dproduct(database: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, field: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-dproduct-member(1))|Multiplies the values in the field (column) of records in the database that match the conditions you specify.| +||[dstDev(database: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, field: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-dstdev-member(1))|Estimates the standard deviation based on a sample from selected database entries.| +||[dstDevP(database: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, field: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-dstdevp-member(1))|Calculates the standard deviation based on the entire population of selected database entries.| +||[dsum(database: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, field: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-dsum-member(1))|Adds the numbers in the field (column) of records in the database that match the conditions you specify.| +||[duration(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, coupon: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, yld: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-duration-member(1))|Returns the annual duration of a security with periodic interest payments.| +||[dvar(database: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, field: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-dvar-member(1))|Estimates variance based on a sample from selected database entries.| +||[dvarP(database: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, field: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-dvarp-member(1))|Calculates variance based on the entire population of selected database entries.| +||[ecma_Ceiling(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, significance: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-ecma_ceiling-member(1))|Rounds a number up, to the nearest integer or to the nearest multiple of significance.| +||[edate(startDate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, months: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-edate-member(1))|Returns the serial number of the date that is the indicated number of months before or after the start date.| +||[effect(nominalRate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, npery: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-effect-member(1))|Returns the effective annual interest rate.| +||[eoMonth(startDate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, months: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-eomonth-member(1))|Returns the serial number of the last day of the month before or after a specified number of months.| +||[erf(lowerLimit: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, upperLimit?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-erf-member(1))|Returns the error function.| +||[erfC(x: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-erfc-member(1))|Returns the complementary error function.| +||[erfC_Precise(X: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-erfc_precise-member(1))|Returns the complementary error function.| +||[erf_Precise(X: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-erf_precise-member(1))|Returns the error function.| +||[error_Type(errorVal: string \| number \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-error_type-member(1))|Returns a number matching an error value.| +||[even(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-even-member(1))|Rounds a positive number up and negative number down to the nearest even integer.| +||[exact(text1: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, text2: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-exact-member(1))|Checks whether two text strings are exactly the same, and returns TRUE or FALSE.| +||[exp(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-exp-member(1))|Returns e raised to the power of a given number.| +||[expon_Dist(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, lambda: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-expon_dist-member(1))|Returns the exponential distribution.| +||[f_Dist(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom1: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom2: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-f_dist-member(1))|Returns the (left-tailed) F probability distribution (degree of diversity) for two data sets.| +||[f_Dist_RT(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom1: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom2: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-f_dist_rt-member(1))|Returns the (right-tailed) F probability distribution (degree of diversity) for two data sets.| +||[f_Inv(probability: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom1: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom2: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-f_inv-member(1))|Returns the inverse of the (left-tailed) F probability distribution: if p = F.DIST(x,...), then F.INV(p,...) = x.| +||[f_Inv_RT(probability: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom1: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom2: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-f_inv_rt-member(1))|Returns the inverse of the (right-tailed) F probability distribution: if p = F.DIST.RT(x,...), then F.INV.RT(p,...) = x.| +||[fact(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-fact-member(1))|Returns the factorial of a number, equal to 1*2*3*...* Number.| +||[factDouble(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-factdouble-member(1))|Returns the double factorial of a number.| +||[false()](/javascript/api/excel/excel.functions#excel-excel-functions-false-member(1))|Returns the logical value FALSE.| +||[find(findText: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, withinText: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, startNum?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-find-member(1))|Returns the starting position of one text string within another text string.| +||[findB(findText: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, withinText: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, startNum?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-findb-member(1))|Finds the starting position of one text string within another text string.| +||[fisher(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-fisher-member(1))|Returns the Fisher transformation.| +||[fisherInv(y: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-fisherinv-member(1))|Returns the inverse of the Fisher transformation: if y = FISHER(x), then FISHERINV(y) = x.| +||[fixed(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, decimals?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, noCommas?: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-fixed-member(1))|Rounds a number to the specified number of decimals and returns the result as text with or without commas.| +||[floor_Math(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, significance?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, mode?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-floor_math-member(1))|Rounds a number down, to the nearest integer or to the nearest multiple of significance.| +||[floor_Precise(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, significance?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-floor_precise-member(1))|Rounds a number down, to the nearest integer or to the nearest multiple of significance.| +||[fv(rate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, nper: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pmt: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pv?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, type?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-fv-member(1))|Returns the future value of an investment based on periodic, constant payments and a constant interest rate.| +||[fvschedule(principal: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, schedule: number \| string \| Excel.Range \| boolean \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-fvschedule-member(1))|Returns the future value of an initial principal after applying a series of compound interest rates.| +||[gamma(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-gamma-member(1))|Returns the Gamma function value.| +||[gammaLn(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-gammaln-member(1))|Returns the natural logarithm of the gamma function.| +||[gammaLn_Precise(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-gammaln_precise-member(1))|Returns the natural logarithm of the gamma function.| +||[gamma_Dist(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, alpha: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, beta: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-gamma_dist-member(1))|Returns the gamma distribution.| +||[gamma_Inv(probability: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, alpha: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, beta: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-gamma_inv-member(1))|Returns the inverse of the gamma cumulative distribution: if p = GAMMA.DIST(x,...), then GAMMA.INV(p,...) = x.| +||[gauss(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-gauss-member(1))|Returns 0.5 less than the standard normal cumulative distribution.| +||[gcd(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-gcd-member(1))|Returns the greatest common divisor.| +||[geStep(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, step?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-gestep-member(1))|Tests whether a number is greater than a threshold value.| +||[geoMean(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-geomean-member(1))|Returns the geometric mean of an array or range of positive numeric data.| +||[harMean(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-harmean-member(1))|Returns the harmonic mean of a data set of positive numbers: the reciprocal of the arithmetic mean of reciprocals.| +||[hex2Bin(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, places?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-hex2bin-member(1))|Converts a Hexadecimal number to binary.| +||[hex2Dec(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-hex2dec-member(1))|Converts a hexadecimal number to decimal.| +||[hex2Oct(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, places?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-hex2oct-member(1))|Converts a hexadecimal number to octal.| +||[hlookup(lookupValue: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, tableArray: Excel.Range \| number \| Excel.RangeReference \| Excel.FunctionResult, rowIndexNum: Excel.Range \| number \| Excel.RangeReference \| Excel.FunctionResult, rangeLookup?: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-hlookup-member(1))|Looks for a value in the top row of a table or array of values and returns the value in the same column from a row you specify.| +||[hour(serialNumber: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-hour-member(1))|Returns the hour as a number from 0 (12:00 A.M.) to 23 (11:00 P.M.).| +||[hypGeom_Dist(sampleS: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numberSample: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, populationS: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numberPop: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-hypgeom_dist-member(1))|Returns the hypergeometric distribution.| +||[hyperlink(linkLocation: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, friendlyName?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-hyperlink-member(1))|Creates a shortcut or jump that opens a document stored on your hard drive, a network server, or on the Internet.| +||[if(logicalTest: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, valueIfTrue?: Excel.Range \| number \| string \| boolean \| Excel.RangeReference \| Excel.FunctionResult, valueIfFalse?: Excel.Range \| number \| string \| boolean \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-if-member(1))|Checks whether a condition is met, and returns one value if TRUE, and another value if FALSE.| +||[imAbs(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-imabs-member(1))|Returns the absolute value (modulus) of a complex number.| +||[imArgument(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-imargument-member(1))|Returns the argument q, an angle expressed in radians.| +||[imConjugate(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-imconjugate-member(1))|Returns the complex conjugate of a complex number.| +||[imCos(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-imcos-member(1))|Returns the cosine of a complex number.| +||[imCosh(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-imcosh-member(1))|Returns the hyperbolic cosine of a complex number.| +||[imCot(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-imcot-member(1))|Returns the cotangent of a complex number.| +||[imCsc(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-imcsc-member(1))|Returns the cosecant of a complex number.| +||[imCsch(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-imcsch-member(1))|Returns the hyperbolic cosecant of a complex number.| +||[imDiv(inumber1: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, inumber2: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-imdiv-member(1))|Returns the quotient of two complex numbers.| +||[imExp(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-imexp-member(1))|Returns the exponential of a complex number.| +||[imLn(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-imln-member(1))|Returns the natural logarithm of a complex number.| +||[imLog10(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-imlog10-member(1))|Returns the base-10 logarithm of a complex number.| +||[imLog2(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-imlog2-member(1))|Returns the base-2 logarithm of a complex number.| +||[imPower(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-impower-member(1))|Returns a complex number raised to an integer power.| +||[imProduct(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-improduct-member(1))|Returns the product of 1 to 255 complex numbers.| +||[imReal(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-imreal-member(1))|Returns the real coefficient of a complex number.| +||[imSec(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-imsec-member(1))|Returns the secant of a complex number.| +||[imSech(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-imsech-member(1))|Returns the hyperbolic secant of a complex number.| +||[imSin(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-imsin-member(1))|Returns the sine of a complex number.| +||[imSinh(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-imsinh-member(1))|Returns the hyperbolic sine of a complex number.| +||[imSqrt(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-imsqrt-member(1))|Returns the square root of a complex number.| +||[imSub(inumber1: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, inumber2: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-imsub-member(1))|Returns the difference of two complex numbers.| +||[imSum(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-imsum-member(1))|Returns the sum of complex numbers.| +||[imTan(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-imtan-member(1))|Returns the tangent of a complex number.| +||[imaginary(inumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-imaginary-member(1))|Returns the imaginary coefficient of a complex number.| +||[int(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-int-member(1))|Rounds a number down to the nearest integer.| +||[intRate(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, investment: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, redemption: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-intrate-member(1))|Returns the interest rate for a fully invested security.| +||[ipmt(rate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, per: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, nper: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pv: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, fv?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, type?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-ipmt-member(1))|Returns the interest payment for a given period for an investment, based on periodic, constant payments and a constant interest rate.| +||[irr(values: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, guess?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-irr-member(1))|Returns the internal rate of return for a series of cash flows.| +||[isErr(value: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-iserr-member(1))|Checks whether a value is an error other than #N/A, and returns TRUE or FALSE.| +||[isError(value: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-iserror-member(1))|Checks whether a value is an error, and returns TRUE or FALSE.| +||[isEven(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-iseven-member(1))|Returns TRUE if the number is even.| +||[isFormula(reference: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-isformula-member(1))|Checks whether a reference is to a cell containing a formula, and returns TRUE or FALSE.| +||[isLogical(value: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-islogical-member(1))|Checks whether a value is a logical value (TRUE or FALSE), and returns TRUE or FALSE.| +||[isNA(value: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-isna-member(1))|Checks whether a value is #N/A, and returns TRUE or FALSE.| +||[isNonText(value: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-isnontext-member(1))|Checks whether a value is not text (blank cells are not text), and returns TRUE or FALSE.| +||[isNumber(value: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-isnumber-member(1))|Checks whether a value is a number, and returns TRUE or FALSE.| +||[isOdd(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-isodd-member(1))|Returns TRUE if the number is odd.| +||[isText(value: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-istext-member(1))|Checks whether a value is text, and returns TRUE or FALSE.| +||[isoWeekNum(date: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-isoweeknum-member(1))|Returns the ISO week number in the year for a given date.| +||[iso_Ceiling(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, significance?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-iso_ceiling-member(1))|Rounds a number up, to the nearest integer or to the nearest multiple of significance.| +||[ispmt(rate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, per: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, nper: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pv: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-ispmt-member(1))|Returns the interest paid during a specific period of an investment.| +||[isref(value: Excel.Range \| number \| string \| boolean \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-isref-member(1))|Checks whether a value is a reference, and returns TRUE or FALSE.| +||[kurt(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-kurt-member(1))|Returns the kurtosis of a data set.| +||[large(array: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, k: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-large-member(1))|Returns the k-th largest value in a data set.| +||[lcm(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-lcm-member(1))|Returns the least common multiple.| +||[left(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numChars?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-left-member(1))|Returns the specified number of characters from the start of a text string.| +||[leftb(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numBytes?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-leftb-member(1))|Returns the specified number of characters from the start of a text string.| +||[len(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-len-member(1))|Returns the number of characters in a text string.| +||[lenb(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-lenb-member(1))|Returns the number of characters in a text string.| +||[ln(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-ln-member(1))|Returns the natural logarithm of a number.| +||[log(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, base?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-log-member(1))|Returns the logarithm of a number to the base you specify.| +||[log10(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-log10-member(1))|Returns the base-10 logarithm of a number.| +||[logNorm_Dist(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, mean: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, standardDev: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-lognorm_dist-member(1))|Returns the lognormal distribution of x, where ln(x) is normally distributed with parameters Mean and Standard_dev.| +||[logNorm_Inv(probability: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, mean: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, standardDev: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-lognorm_inv-member(1))|Returns the inverse of the lognormal cumulative distribution function of x, where ln(x) is normally distributed with parameters Mean and Standard_dev.| +||[lookup(lookupValue: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, lookupVector: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, resultVector?: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-lookup-member(1))|Looks up a value either from a one-row or one-column range or from an array.| +||[lower(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-lower-member(1))|Converts all letters in a text string to lowercase.| +||[match(lookupValue: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, lookupArray: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, matchType?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-match-member(1))|Returns the relative position of an item in an array that matches a specified value in a specified order.| +||[max(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-max-member(1))|Returns the largest value in a set of values.| +||[maxA(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-maxa-member(1))|Returns the largest value in a set of values.| +||[mduration(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, coupon: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, yld: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-mduration-member(1))|Returns the Macauley modified duration for a security with an assumed par value of $100.| +||[median(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-median-member(1))|Returns the median, or the number in the middle of the set of given numbers.| +||[mid(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, startNum: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numChars: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-mid-member(1))|Returns the characters from the middle of a text string, given a starting position and length.| +||[midb(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, startNum: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numBytes: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-midb-member(1))|Returns characters from the middle of a text string, given a starting position and length.| +||[min(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-min-member(1))|Returns the smallest number in a set of values.| +||[minA(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-mina-member(1))|Returns the smallest value in a set of values.| +||[minute(serialNumber: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-minute-member(1))|Returns the minute, a number from 0 to 59.| +||[mirr(values: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, financeRate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, reinvestRate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-mirr-member(1))|Returns the internal rate of return for a series of periodic cash flows, considering both cost of investment and interest on reinvestment of cash.| +||[mod(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, divisor: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-mod-member(1))|Returns the remainder after a number is divided by a divisor.| +||[month(serialNumber: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-month-member(1))|Returns the month, a number from 1 (January) to 12 (December).| +||[mround(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, multiple: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-mround-member(1))|Returns a number rounded to the desired multiple.| +||[multiNomial(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-multinomial-member(1))|Returns the multinomial of a set of numbers.| +||[n(value: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-n-member(1))|Converts non-number value to a number, dates to serial numbers, TRUE to 1, anything else to 0 (zero).| +||[na()](/javascript/api/excel/excel.functions#excel-excel-functions-na-member(1))|Returns the error value #N/A (value not available).| +||[negBinom_Dist(numberF: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numberS: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, probabilityS: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-negbinom_dist-member(1))|Returns the negative binomial distribution, the probability that there will be Number_f failures before the Number_s-th success, with Probability_s probability of a success.| +||[networkDays(startDate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, endDate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, holidays?: number \| string \| Excel.Range \| boolean \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-networkdays-member(1))|Returns the number of whole workdays between two dates.| +||[networkDays_Intl(startDate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, endDate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, weekend?: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, holidays?: number \| string \| Excel.Range \| boolean \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-networkdays_intl-member(1))|Returns the number of whole workdays between two dates with custom weekend parameters.| +||[nominal(effectRate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, npery: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-nominal-member(1))|Returns the annual nominal interest rate.| +||[norm_Dist(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, mean: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, standardDev: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-norm_dist-member(1))|Returns the normal distribution for the specified mean and standard deviation.| +||[norm_Inv(probability: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, mean: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, standardDev: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-norm_inv-member(1))|Returns the inverse of the normal cumulative distribution for the specified mean and standard deviation.| +||[norm_S_Dist(z: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-norm_s_dist-member(1))|Returns the standard normal distribution (has a mean of zero and a standard deviation of one).| +||[norm_S_Inv(probability: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-norm_s_inv-member(1))|Returns the inverse of the standard normal cumulative distribution (has a mean of zero and a standard deviation of one).| +||[not(logical: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-not-member(1))|Changes FALSE to TRUE, or TRUE to FALSE.| +||[now()](/javascript/api/excel/excel.functions#excel-excel-functions-now-member(1))|Returns the current date and time formatted as a date and time.| +||[nper(rate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pmt: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pv: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, fv?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, type?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-nper-member(1))|Returns the number of periods for an investment based on periodic, constant payments and a constant interest rate.| +||[npv(rate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, ...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-npv-member(1))|Returns the net present value of an investment based on a discount rate and a series of future payments (negative values) and income (positive values).| +||[numberValue(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, decimalSeparator?: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, groupSeparator?: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-numbervalue-member(1))|Converts text to number in a locale-independent manner.| +||[oct2Bin(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, places?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-oct2bin-member(1))|Converts an octal number to binary.| +||[oct2Dec(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-oct2dec-member(1))|Converts an octal number to decimal.| +||[oct2Hex(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, places?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-oct2hex-member(1))|Converts an octal number to hexadecimal.| +||[odd(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-odd-member(1))|Rounds a positive number up and negative number down to the nearest odd integer.| +||[oddFPrice(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, issue: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, firstCoupon: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, yld: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, redemption: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-oddfprice-member(1))|Returns the price per $100 face value of a security with an odd first period.| +||[oddFYield(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, issue: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, firstCoupon: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pr: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, redemption: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-oddfyield-member(1))|Returns the yield of a security with an odd first period.| +||[oddLPrice(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, lastInterest: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, yld: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, redemption: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-oddlprice-member(1))|Returns the price per $100 face value of a security with an odd last period.| +||[oddLYield(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, lastInterest: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pr: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, redemption: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-oddlyield-member(1))|Returns the yield of a security with an odd last period.| +||[or(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-or-member(1))|Checks whether any of the arguments are TRUE, and returns TRUE or FALSE.| +||[pduration(rate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pv: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, fv: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-pduration-member(1))|Returns the number of periods required by an investment to reach a specified value.| +||[percentRank_Exc(array: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, significance?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-percentrank_exc-member(1))|Returns the rank of a value in a data set as a percentage (0..1, exclusive) of the data set.| +||[percentRank_Inc(array: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, significance?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-percentrank_inc-member(1))|Returns the rank of a value in a data set as a percentage (0..1, inclusive) of the data set.| +||[percentile_Exc(array: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, k: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-percentile_exc-member(1))|Returns the k-th percentile of values in a range, where k is in the range 0..1, exclusive.| +||[percentile_Inc(array: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, k: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-percentile_inc-member(1))|Returns the k-th percentile of values in a range, where k is in the range 0..1, inclusive.| +||[permut(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numberChosen: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-permut-member(1))|Returns the number of permutations for a given number of objects that can be selected from the total objects.| +||[permutationa(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numberChosen: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-permutationa-member(1))|Returns the number of permutations for a given number of objects (with repetitions) that can be selected from the total objects.| +||[phi(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-phi-member(1))|Returns the value of the density function for a standard normal distribution.| +||[pi()](/javascript/api/excel/excel.functions#excel-excel-functions-pi-member(1))|Returns the value of Pi, 3.14159265358979, accurate to 15 digits.| +||[pmt(rate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, nper: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pv: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, fv?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, type?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-pmt-member(1))|Calculates the payment for a loan based on constant payments and a constant interest rate.| +||[poisson_Dist(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, mean: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-poisson_dist-member(1))|Returns the Poisson distribution.| +||[power(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, power: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-power-member(1))|Returns the result of a number raised to a power.| +||[ppmt(rate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, per: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, nper: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pv: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, fv?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, type?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-ppmt-member(1))|Returns the payment on the principal for a given investment based on periodic, constant payments and a constant interest rate.| +||[price(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, yld: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, redemption: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-price-member(1))|Returns the price per $100 face value of a security that pays periodic interest.| +||[priceDisc(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, discount: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, redemption: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-pricedisc-member(1))|Returns the price per $100 face value of a discounted security.| +||[priceMat(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, issue: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, yld: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-pricemat-member(1))|Returns the price per $100 face value of a security that pays interest at maturity.| +||[product(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-product-member(1))|Multiplies all the numbers given as arguments.| +||[proper(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-proper-member(1))|Converts a text string to proper case; the first letter in each word to uppercase, and all other letters to lowercase.| +||[pv(rate: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, nper: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pmt: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, fv?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, type?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-pv-member(1))|Returns the present value of an investment: the total amount that a series of future payments is worth now.| +||[quartile_Exc(array: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, quart: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-quartile_exc-member(1))|Returns the quartile of a data set, based on percentile values from 0..1, exclusive.| +||[quartile_Inc(array: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, quart: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-quartile_inc-member(1))|Returns the quartile of a data set, based on percentile values from 0..1, inclusive.| +||[quotient(numerator: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, denominator: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-quotient-member(1))|Returns the integer portion of a division.| +||[radians(angle: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-radians-member(1))|Converts degrees to radians.| +||[rand()](/javascript/api/excel/excel.functions#excel-excel-functions-rand-member(1))|Returns a random number greater than or equal to 0 and less than 1, evenly distributed (changes on recalculation).| +||[randBetween(bottom: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, top: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-randbetween-member(1))|Returns a random number between the numbers you specify.| +||[rank_Avg(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, ref: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, order?: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-rank_avg-member(1))|Returns the rank of a number in a list of numbers: its size relative to other values in the list; if more than one value has the same rank, the average rank is returned.| +||[rank_Eq(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, ref: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, order?: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-rank_eq-member(1))|Returns the rank of a number in a list of numbers: its size relative to other values in the list; if more than one value has the same rank, the top rank of that set of values is returned.| +||[rate(nper: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pmt: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pv: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, fv?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, type?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, guess?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-rate-member(1))|Returns the interest rate per period of a loan or an investment.| +||[received(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, investment: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, discount: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-received-member(1))|Returns the amount received at maturity for a fully invested security.| +||[replace(oldText: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, startNum: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numChars: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, newText: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-replace-member(1))|Replaces part of a text string with a different text string.| +||[replaceB(oldText: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, startNum: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numBytes: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, newText: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-replaceb-member(1))|Replaces part of a text string with a different text string.| +||[rept(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numberTimes: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-rept-member(1))|Repeats text a given number of times.| +||[right(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numChars?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-right-member(1))|Returns the specified number of characters from the end of a text string.| +||[rightb(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numBytes?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-rightb-member(1))|Returns the specified number of characters from the end of a text string.| +||[roman(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, form?: boolean \| number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-roman-member(1))|Converts an Arabic numeral to Roman, as text.| +||[round(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numDigits: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-round-member(1))|Rounds a number to a specified number of digits.| +||[roundDown(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numDigits: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-rounddown-member(1))|Rounds a number down, toward zero.| +||[roundUp(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numDigits: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-roundup-member(1))|Rounds a number up, away from zero.| +||[rows(array: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-rows-member(1))|Returns the number of rows in a reference or array.| +||[rri(nper: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pv: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, fv: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-rri-member(1))|Returns an equivalent interest rate for the growth of an investment.| +||[sec(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-sec-member(1))|Returns the secant of an angle.| +||[sech(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-sech-member(1))|Returns the hyperbolic secant of an angle.| +||[second(serialNumber: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-second-member(1))|Returns the second, a number from 0 to 59.| +||[seriesSum(x: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, n: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, m: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, coefficients: Excel.Range \| string \| number \| boolean \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-seriessum-member(1))|Returns the sum of a power series based on the formula.| +||[sheet(value?: Excel.Range \| string \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-sheet-member(1))|Returns the sheet number of the referenced sheet.| +||[sheets(reference?: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-sheets-member(1))|Returns the number of sheets in a reference.| +||[sign(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-sign-member(1))|Returns the sign of a number: 1 if the number is positive, zero if the number is zero, or -1 if the number is negative.| +||[sin(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-sin-member(1))|Returns the sine of an angle.| +||[sinh(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-sinh-member(1))|Returns the hyperbolic sine of a number.| +||[skew(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-skew-member(1))|Returns the skewness of a distribution: a characterization of the degree of asymmetry of a distribution around its mean.| +||[skew_p(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-skew_p-member(1))|Returns the skewness of a distribution based on a population: a characterization of the degree of asymmetry of a distribution around its mean.| +||[sln(cost: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, salvage: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, life: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-sln-member(1))|Returns the straight-line depreciation of an asset for one period.| +||[small(array: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, k: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-small-member(1))|Returns the k-th smallest value in a data set.| +||[sqrt(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-sqrt-member(1))|Returns the square root of a number.| +||[sqrtPi(number: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-sqrtpi-member(1))|Returns the square root of (number * Pi).| +||[stDevA(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-stdeva-member(1))|Estimates standard deviation based on a sample, including logical values and text.| +||[stDevPA(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-stdevpa-member(1))|Calculates standard deviation based on an entire population, including logical values and text.| +||[stDev_P(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-stdev_p-member(1))|Calculates standard deviation based on the entire population given as arguments (ignores logical values and text).| +||[stDev_S(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-stdev_s-member(1))|Estimates standard deviation based on a sample (ignores logical values and text in the sample).| +||[standardize(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, mean: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, standardDev: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-standardize-member(1))|Returns a normalized value from a distribution characterized by a mean and standard deviation.| +||[substitute(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, oldText: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, newText: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, instanceNum?: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-substitute-member(1))|Replaces existing text with new text in a text string.| +||[subtotal(functionNum: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, ...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-subtotal-member(1))|Returns a subtotal in a list or database.| +||[sum(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-sum-member(1))|Adds all the numbers in a range of cells.| +||[sumIf(range: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, criteria: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, sumRange?: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-sumif-member(1))|Adds the cells specified by a given condition or criteria.| +||[sumIfs(sumRange: Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, ...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-sumifs-member(1))|Adds the cells specified by a given set of conditions or criteria.| +||[sumSq(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-sumsq-member(1))|Returns the sum of the squares of the arguments.| +||[syd(cost: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, salvage: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, life: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, per: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-syd-member(1))|Returns the sum-of-years' digits depreciation of an asset for a specified period.| +||[t(value: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-t-member(1))|Checks whether a value is text, and returns the text if it is, or returns double quotes (empty text) if it is not.| +||[t_Dist(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-t_dist-member(1))|Returns the left-tailed Student's t-distribution.| +||[t_Dist_2T(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-t_dist_2t-member(1))|Returns the two-tailed Student's t-distribution.| +||[t_Dist_RT(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-t_dist_rt-member(1))|Returns the right-tailed Student's t-distribution.| +||[t_Inv(probability: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-t_inv-member(1))|Returns the left-tailed inverse of the Student's t-distribution.| +||[t_Inv_2T(probability: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, degFreedom: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-t_inv_2t-member(1))|Returns the two-tailed inverse of the Student's t-distribution.| +||[tan(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-tan-member(1))|Returns the tangent of an angle.| +||[tanh(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-tanh-member(1))|Returns the hyperbolic tangent of a number.| +||[tbillEq(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, discount: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-tbilleq-member(1))|Returns the bond-equivalent yield for a treasury bill.| +||[tbillPrice(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, discount: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-tbillprice-member(1))|Returns the price per $100 face value for a treasury bill.| +||[tbillYield(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pr: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-tbillyield-member(1))|Returns the yield for a treasury bill.| +||[text(value: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, formatText: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-text-member(1))|Converts a value to text in a specific number format.| +||[time(hour: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, minute: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, second: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-time-member(1))|Converts hours, minutes, and seconds given as numbers to an Excel serial number, formatted with a time format.| +||[timevalue(timeText: string \| number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-timevalue-member(1))|Converts a text time to an Excel serial number for a time, a number from 0 (12:00:00 AM) to 0.999988426 (11:59:59 PM).| +||[today()](/javascript/api/excel/excel.functions#excel-excel-functions-today-member(1))|Returns the current date formatted as a date.| +||[trim(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-trim-member(1))|Removes all spaces from a text string except for single spaces between words.| +||[trimMean(array: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, percent: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-trimmean-member(1))|Returns the mean of the interior portion of a set of data values.| +||[true()](/javascript/api/excel/excel.functions#excel-excel-functions-true-member(1))|Returns the logical value TRUE.| +||[trunc(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, numDigits?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-trunc-member(1))|Truncates a number to an integer by removing the decimal, or fractional, part of the number.| +||[type(value: boolean \| string \| number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-type-member(1))|Returns an integer representing the data type of a value: number = 1; text = 2; logical value = 4; error value = 16; array = 64; compound data = 128.| +||[unichar(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-unichar-member(1))|Returns the Unicode character referenced by the given numeric value.| +||[unicode(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-unicode-member(1))|Returns the number (code point) corresponding to the first character of the text.| +||[upper(text: string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-upper-member(1))|Converts a text string to all uppercase letters.| +||[usdollar(number: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, decimals?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-usdollar-member(1))|Converts a number to text, using currency format.| +||[value(text: string \| boolean \| number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-value-member(1))|Converts a text string that represents a number to a number.| +||[varA(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-vara-member(1))|Estimates variance based on a sample, including logical values and text.| +||[varPA(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-varpa-member(1))|Calculates variance based on the entire population, including logical values and text.| +||[var_P(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-var_p-member(1))|Calculates variance based on the entire population (ignores logical values and text in the population).| +||[var_S(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-var_s-member(1))|Estimates variance based on a sample (ignores logical values and text in the sample).| +||[vdb(cost: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, salvage: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, life: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, startPeriod: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, endPeriod: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, factor?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, noSwitch?: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-vdb-member(1))|Returns the depreciation of an asset for any period you specify, including partial periods, using the double-declining balance method or some other method you specify.| +||[vlookup(lookupValue: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, tableArray: Excel.Range \| number \| Excel.RangeReference \| Excel.FunctionResult, colIndexNum: Excel.Range \| number \| Excel.RangeReference \| Excel.FunctionResult, rangeLookup?: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-vlookup-member(1))|Looks for a value in the leftmost column of a table, and then returns a value in the same row from a column you specify.| +||[weekNum(serialNumber: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, returnType?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-weeknum-member(1))|Returns the week number in the year.| +||[weekday(serialNumber: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, returnType?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-weekday-member(1))|Returns a number from 1 to 7 identifying the day of the week of a date.| +||[weibull_Dist(x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, alpha: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, beta: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, cumulative: boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-weibull_dist-member(1))|Returns the Weibull distribution.| +||[workDay(startDate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, days: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, holidays?: number \| string \| Excel.Range \| boolean \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-workday-member(1))|Returns the serial number of the date before or after a specified number of workdays.| +||[workDay_Intl(startDate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, days: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, weekend?: number \| string \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, holidays?: number \| string \| Excel.Range \| boolean \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-workday_intl-member(1))|Returns the serial number of the date before or after a specified number of workdays with custom weekend parameters.| +||[xirr(values: number \| string \| Excel.Range \| boolean \| Excel.RangeReference \| Excel.FunctionResult, dates: number \| string \| Excel.Range \| boolean \| Excel.RangeReference \| Excel.FunctionResult, guess?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-xirr-member(1))|Returns the internal rate of return for a schedule of cash flows.| +||[xnpv(rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, values: number \| string \| Excel.Range \| boolean \| Excel.RangeReference \| Excel.FunctionResult, dates: number \| string \| Excel.Range \| boolean \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-xnpv-member(1))|Returns the net present value for a schedule of cash flows.| +||[xor(...values: Array)](/javascript/api/excel/excel.functions#excel-excel-functions-xor-member(1))|Returns a logical 'Exclusive Or' of all arguments.| +||[year(serialNumber: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-year-member(1))|Returns the year of a date, an integer in the range 1900 - 9999.| +||[yearFrac(startDate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, endDate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-yearfrac-member(1))|Returns the year fraction representing the number of whole days between start_date and end_date.| +||[yield(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pr: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, redemption: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, frequency: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-yield-member(1))|Returns the yield on a security that pays periodic interest.| +||[yieldDisc(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pr: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, redemption: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-yielddisc-member(1))|Returns the annual yield for a discounted security.| +||[yieldMat(settlement: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, maturity: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, issue: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, rate: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, pr: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, basis?: number \| string \| boolean \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-yieldmat-member(1))|Returns the annual yield of a security that pays interest at maturity.| +||[z_Test(array: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, x: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult, sigma?: number \| Excel.Range \| Excel.RangeReference \| Excel.FunctionResult)](/javascript/api/excel/excel.functions#excel-excel-functions-z_test-member(1))|Returns the one-tailed P-value of a z-test.| +|[Icon](/javascript/api/excel/excel.icon)|[index](/javascript/api/excel/excel.icon#excel-excel-icon-index-member)|Specifies the index of the icon in the given set.| +|[IconCollections](/javascript/api/excel/excel.iconcollections)|[fiveArrows](/javascript/api/excel/excel.iconcollections#excel-excel-iconcollections-fivearrows-member)|| +||[fiveArrowsGray](/javascript/api/excel/excel.iconcollections#excel-excel-iconcollections-fivearrowsgray-member)|| +||[fiveBoxes](/javascript/api/excel/excel.iconcollections#excel-excel-iconcollections-fiveboxes-member)|[Api set: ExcelApi 1.2]| +||[fiveQuarters](/javascript/api/excel/excel.iconcollections#excel-excel-iconcollections-fivequarters-member)|| +||[fiveRating](/javascript/api/excel/excel.iconcollections#excel-excel-iconcollections-fiverating-member)|| +||[fourArrows](/javascript/api/excel/excel.iconcollections#excel-excel-iconcollections-fourarrows-member)|| +||[fourArrowsGray](/javascript/api/excel/excel.iconcollections#excel-excel-iconcollections-fourarrowsgray-member)|| +||[fourRating](/javascript/api/excel/excel.iconcollections#excel-excel-iconcollections-fourrating-member)|| +||[fourRedToBlack](/javascript/api/excel/excel.iconcollections#excel-excel-iconcollections-fourredtoblack-member)|| +||[fourTrafficLights](/javascript/api/excel/excel.iconcollections#excel-excel-iconcollections-fourtrafficlights-member)|| +||[threeArrows](/javascript/api/excel/excel.iconcollections#excel-excel-iconcollections-threearrows-member)|| +||[threeArrowsGray](/javascript/api/excel/excel.iconcollections#excel-excel-iconcollections-threearrowsgray-member)|| +||[threeFlags](/javascript/api/excel/excel.iconcollections#excel-excel-iconcollections-threeflags-member)|| +||[threeSigns](/javascript/api/excel/excel.iconcollections#excel-excel-iconcollections-threesigns-member)|| +||[threeStars](/javascript/api/excel/excel.iconcollections#excel-excel-iconcollections-threestars-member)|| +||[threeSymbols2](/javascript/api/excel/excel.iconcollections#excel-excel-iconcollections-threesymbols2-member)|| +||[threeSymbols](/javascript/api/excel/excel.iconcollections#excel-excel-iconcollections-threesymbols-member)|| +||[threeTrafficLights1](/javascript/api/excel/excel.iconcollections#excel-excel-iconcollections-threetrafficlights1-member)|| +||[threeTrafficLights2](/javascript/api/excel/excel.iconcollections#excel-excel-iconcollections-threetrafficlights2-member)|| +||[threeTriangles](/javascript/api/excel/excel.iconcollections#excel-excel-iconcollections-threetriangles-member)|| +|[Range](/javascript/api/excel/excel.range)|[columnHidden](/javascript/api/excel/excel.range#excel-excel-range-columnhidden-member)|Represents if all columns in the current range are hidden.| +||[formulasR1C1](/javascript/api/excel/excel.range#excel-excel-range-formulasr1c1-member)|Represents the formula in R1C1-style notation.| +||[getColumnsAfter(count?: number)](/javascript/api/excel/excel.range#excel-excel-range-getcolumnsafter-member(1))|Gets a certain number of columns to the right of the current `Range` object.| +||[getColumnsBefore(count?: number)](/javascript/api/excel/excel.range#excel-excel-range-getcolumnsbefore-member(1))|Gets a certain number of columns to the left of the current `Range` object.| +||[getResizedRange(deltaRows: number, deltaColumns: number)](/javascript/api/excel/excel.range#excel-excel-range-getresizedrange-member(1))|Gets a `Range` object similar to the current `Range` object, but with its bottom-right corner expanded (or contracted) by some number of rows and columns.| +||[getRowsAbove(count?: number)](/javascript/api/excel/excel.range#excel-excel-range-getrowsabove-member(1))|Gets a certain number of rows above the current `Range` object.| +||[getRowsBelow(count?: number)](/javascript/api/excel/excel.range#excel-excel-range-getrowsbelow-member(1))|Gets a certain number of rows below the current `Range` object.| +||[getUsedRange(valuesOnly?: boolean)](/javascript/api/excel/excel.range#excel-excel-range-getusedrange-member(1))|Returns the used range of the given range object.| +||[hidden](/javascript/api/excel/excel.range#excel-excel-range-hidden-member)|Represents if all cells in the current range are hidden.| +||[merge(across?: boolean)](/javascript/api/excel/excel.range#excel-excel-range-merge-member(1))|Merge the range cells into one region in the worksheet.| +||[rowHidden](/javascript/api/excel/excel.range#excel-excel-range-rowhidden-member)|Represents if all rows in the current range are hidden.| +||[sort](/javascript/api/excel/excel.range#excel-excel-range-sort-member)|Represents the range sort of the current range.| +||[unmerge()](/javascript/api/excel/excel.range#excel-excel-range-unmerge-member(1))|Unmerge the range cells into separate cells.| +|[RangeFormat](/javascript/api/excel/excel.rangeformat)|[autofitColumns()](/javascript/api/excel/excel.rangeformat#excel-excel-rangeformat-autofitcolumns-member(1))|Changes the width of the columns of the current range to achieve the best fit, based on the current data in the columns.| +||[autofitRows()](/javascript/api/excel/excel.rangeformat#excel-excel-rangeformat-autofitrows-member(1))|Changes the height of the rows of the current range to achieve the best fit, based on the current data in the columns.| +||[columnWidth](/javascript/api/excel/excel.rangeformat#excel-excel-rangeformat-columnwidth-member)|Specifies the width of all columns within the range.| +||[protection](/javascript/api/excel/excel.rangeformat#excel-excel-rangeformat-protection-member)|Returns the format protection object for a range.| +||[rowHeight](/javascript/api/excel/excel.rangeformat#excel-excel-rangeformat-rowheight-member)|The height of all rows in the range.| +|[RangeReference](/javascript/api/excel/excel.rangereference)|[address](/javascript/api/excel/excel.rangereference#excel-excel-rangereference-address-member)|The address of the range, for example "SheetName!A1:B5".| +|[RangeSort](/javascript/api/excel/excel.rangesort)|[apply(fields: Excel.SortField[], matchCase?: boolean, hasHeaders?: boolean, orientation?: Excel.SortOrientation, method?: Excel.SortMethod)](/javascript/api/excel/excel.rangesort#excel-excel-rangesort-apply-member(1))|Perform a sort operation.| +|[SelectionChangedEventArgs](/javascript/api/excel/excel.selectionchangedeventargs)|[workbook](/javascript/api/excel/excel.selectionchangedeventargs#excel-excel-selectionchangedeventargs-workbook-member)|Gets the workbook object that raised the selection changed event.| +|[SortField](/javascript/api/excel/excel.sortfield)|[ascending](/javascript/api/excel/excel.sortfield#excel-excel-sortfield-ascending-member)|Specifies if the sorting is done in an ascending fashion.| +||[color](/javascript/api/excel/excel.sortfield#excel-excel-sortfield-color-member)|Specifies the color that is the target of the condition if the sorting is on font or cell color.| +||[dataOption](/javascript/api/excel/excel.sortfield#excel-excel-sortfield-dataoption-member)|Represents additional sorting options for this field.| +||[icon](/javascript/api/excel/excel.sortfield#excel-excel-sortfield-icon-member)|Specifies the icon that is the target of the condition, if the sorting is on the cell's icon.| +||[key](/javascript/api/excel/excel.sortfield#excel-excel-sortfield-key-member)|Specifies the column (or row, depending on the sort orientation) that the condition is on.| +||[sortOn](/javascript/api/excel/excel.sortfield#excel-excel-sortfield-sorton-member)|Specifies the type of sorting of this condition.| +|[Table](/javascript/api/excel/excel.table)|[clearFilters()](/javascript/api/excel/excel.table#excel-excel-table-clearfilters-member(1))|Clears all the filters currently applied on the table.| +||[convertToRange()](/javascript/api/excel/excel.table#excel-excel-table-converttorange-member(1))|Converts the table into a normal range of cells.| +||[reapplyFilters()](/javascript/api/excel/excel.table#excel-excel-table-reapplyfilters-member(1))|Reapplies all the filters currently on the table.| +||[sort](/javascript/api/excel/excel.table#excel-excel-table-sort-member)|Represents the sorting for the table.| +||[worksheet](/javascript/api/excel/excel.table#excel-excel-table-worksheet-member)|The worksheet containing the current table.| +|[TableColumn](/javascript/api/excel/excel.tablecolumn)|[filter](/javascript/api/excel/excel.tablecolumn#excel-excel-tablecolumn-filter-member)|Retrieves the filter applied to the column.| +|[TableSort](/javascript/api/excel/excel.tablesort)|[apply(fields: Excel.SortField[], matchCase?: boolean, method?: Excel.SortMethod)](/javascript/api/excel/excel.tablesort#excel-excel-tablesort-apply-member(1))|Perform a sort operation.| +||[clear()](/javascript/api/excel/excel.tablesort#excel-excel-tablesort-clear-member(1))|Clears the sorting that is currently on the table.| +||[fields](/javascript/api/excel/excel.tablesort#excel-excel-tablesort-fields-member)|Specifies the current conditions used to last sort the table.| +||[matchCase](/javascript/api/excel/excel.tablesort#excel-excel-tablesort-matchcase-member)|Specifies if the casing impacts the last sort of the table.| +||[method](/javascript/api/excel/excel.tablesort#excel-excel-tablesort-method-member)|Represents the Chinese character ordering method last used to sort the table.| +||[reapply()](/javascript/api/excel/excel.tablesort#excel-excel-tablesort-reapply-member(1))|Reapplies the current sorting parameters to the table.| +|[ThreeArrowsGraySet](/javascript/api/excel/excel.threearrowsgrayset)|[grayDownArrow](/javascript/api/excel/excel.threearrowsgrayset#excel-excel-threearrowsgrayset-graydownarrow-member)|| +||[graySideArrow](/javascript/api/excel/excel.threearrowsgrayset#excel-excel-threearrowsgrayset-graysidearrow-member)|| +||[grayUpArrow](/javascript/api/excel/excel.threearrowsgrayset#excel-excel-threearrowsgrayset-grayuparrow-member)|| +|[ThreeArrowsSet](/javascript/api/excel/excel.threearrowsset)|[greenUpArrow](/javascript/api/excel/excel.threearrowsset#excel-excel-threearrowsset-greenuparrow-member)|| +||[redDownArrow](/javascript/api/excel/excel.threearrowsset#excel-excel-threearrowsset-reddownarrow-member)|| +||[yellowSideArrow](/javascript/api/excel/excel.threearrowsset#excel-excel-threearrowsset-yellowsidearrow-member)|| +|[ThreeFlagsSet](/javascript/api/excel/excel.threeflagsset)|[greenFlag](/javascript/api/excel/excel.threeflagsset#excel-excel-threeflagsset-greenflag-member)|| +||[redFlag](/javascript/api/excel/excel.threeflagsset#excel-excel-threeflagsset-redflag-member)|| +||[yellowFlag](/javascript/api/excel/excel.threeflagsset#excel-excel-threeflagsset-yellowflag-member)|| +|[ThreeSignsSet](/javascript/api/excel/excel.threesignsset)|[greenCircle](/javascript/api/excel/excel.threesignsset#excel-excel-threesignsset-greencircle-member)|| +||[redDiamond](/javascript/api/excel/excel.threesignsset#excel-excel-threesignsset-reddiamond-member)|| +||[yellowTriangle](/javascript/api/excel/excel.threesignsset#excel-excel-threesignsset-yellowtriangle-member)|| +|[ThreeStarsSet](/javascript/api/excel/excel.threestarsset)|[goldStar](/javascript/api/excel/excel.threestarsset#excel-excel-threestarsset-goldstar-member)|| +||[halfGoldStar](/javascript/api/excel/excel.threestarsset#excel-excel-threestarsset-halfgoldstar-member)|| +||[silverStar](/javascript/api/excel/excel.threestarsset#excel-excel-threestarsset-silverstar-member)|| +|[ThreeSymbols2Set](/javascript/api/excel/excel.threesymbols2set)|[greenCheck](/javascript/api/excel/excel.threesymbols2set#excel-excel-threesymbols2set-greencheck-member)|| +||[redCross](/javascript/api/excel/excel.threesymbols2set#excel-excel-threesymbols2set-redcross-member)|| +||[yellowExclamation](/javascript/api/excel/excel.threesymbols2set#excel-excel-threesymbols2set-yellowexclamation-member)|| +|[ThreeSymbolsSet](/javascript/api/excel/excel.threesymbolsset)|[greenCheckSymbol](/javascript/api/excel/excel.threesymbolsset#excel-excel-threesymbolsset-greenchecksymbol-member)|| +||[redCrossSymbol](/javascript/api/excel/excel.threesymbolsset#excel-excel-threesymbolsset-redcrosssymbol-member)|| +||[yellowExclamationSymbol](/javascript/api/excel/excel.threesymbolsset#excel-excel-threesymbolsset-yellowexclamationsymbol-member)|| +|[ThreeTrafficLights1Set](/javascript/api/excel/excel.threetrafficlights1set)|[greenCircle](/javascript/api/excel/excel.threetrafficlights1set#excel-excel-threetrafficlights1set-greencircle-member)|| +||[redCircleWithBorder](/javascript/api/excel/excel.threetrafficlights1set#excel-excel-threetrafficlights1set-redcirclewithborder-member)|| +||[yellowCircle](/javascript/api/excel/excel.threetrafficlights1set#excel-excel-threetrafficlights1set-yellowcircle-member)|| +|[ThreeTrafficLights2Set](/javascript/api/excel/excel.threetrafficlights2set)|[greenTrafficLight](/javascript/api/excel/excel.threetrafficlights2set#excel-excel-threetrafficlights2set-greentrafficlight-member)|| +||[redTrafficLight](/javascript/api/excel/excel.threetrafficlights2set#excel-excel-threetrafficlights2set-redtrafficlight-member)|| +||[yellowTrafficLight](/javascript/api/excel/excel.threetrafficlights2set#excel-excel-threetrafficlights2set-yellowtrafficlight-member)|| +|[ThreeTrianglesSet](/javascript/api/excel/excel.threetrianglesset)|[greenUpTriangle](/javascript/api/excel/excel.threetrianglesset#excel-excel-threetrianglesset-greenuptriangle-member)|| +||[redDownTriangle](/javascript/api/excel/excel.threetrianglesset#excel-excel-threetrianglesset-reddowntriangle-member)|| +||[yellowDash](/javascript/api/excel/excel.threetrianglesset#excel-excel-threetrianglesset-yellowdash-member)|| +|[Workbook](/javascript/api/excel/excel.workbook)|[functions](/javascript/api/excel/excel.workbook#excel-excel-workbook-functions-member)|Represents a collection of worksheet functions that can be used for computation.| +||[onSelectionChanged](/javascript/api/excel/excel.workbook#excel-excel-workbook-onselectionchanged-member)|Occurs when the selection in the document is changed.| +|[Worksheet](/javascript/api/excel/excel.worksheet)|[getUsedRange(valuesOnly?: boolean)](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-getusedrange-member(1))|The used range is the smallest range that encompasses any cells that have a value or formatting assigned to them.| +||[protection](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-protection-member)|Returns the sheet protection object for a worksheet.| +|[WorksheetProtection](/javascript/api/excel/excel.worksheetprotection)|[options](/javascript/api/excel/excel.worksheetprotection#excel-excel-worksheetprotection-options-member)|Specifies the protection options for the worksheet.| +||[protect(options?: Excel.WorksheetProtectionOptions, password?: string)](/javascript/api/excel/excel.worksheetprotection#excel-excel-worksheetprotection-protect-member(1))|Protects a worksheet.| +||[protected](/javascript/api/excel/excel.worksheetprotection#excel-excel-worksheetprotection-protected-member)|Specifies if the worksheet is protected.| +|[WorksheetProtectionOptions](/javascript/api/excel/excel.worksheetprotectionoptions)|[allowAutoFilter](/javascript/api/excel/excel.worksheetprotectionoptions#excel-excel-worksheetprotectionoptions-allowautofilter-member)|Represents the worksheet protection option allowing use of the AutoFilter feature.| +||[allowDeleteColumns](/javascript/api/excel/excel.worksheetprotectionoptions#excel-excel-worksheetprotectionoptions-allowdeletecolumns-member)|Represents the worksheet protection option allowing deleting of columns.| +||[allowDeleteRows](/javascript/api/excel/excel.worksheetprotectionoptions#excel-excel-worksheetprotectionoptions-allowdeleterows-member)|Represents the worksheet protection option allowing deleting of rows.| +||[allowFormatCells](/javascript/api/excel/excel.worksheetprotectionoptions#excel-excel-worksheetprotectionoptions-allowformatcells-member)|Represents the worksheet protection option allowing formatting of cells.| +||[allowFormatColumns](/javascript/api/excel/excel.worksheetprotectionoptions#excel-excel-worksheetprotectionoptions-allowformatcolumns-member)|Represents the worksheet protection option allowing formatting of columns.| +||[allowFormatRows](/javascript/api/excel/excel.worksheetprotectionoptions#excel-excel-worksheetprotectionoptions-allowformatrows-member)|Represents the worksheet protection option allowing formatting of rows.| +||[allowInsertColumns](/javascript/api/excel/excel.worksheetprotectionoptions#excel-excel-worksheetprotectionoptions-allowinsertcolumns-member)|Represents the worksheet protection option allowing inserting of columns.| +||[allowInsertHyperlinks](/javascript/api/excel/excel.worksheetprotectionoptions#excel-excel-worksheetprotectionoptions-allowinserthyperlinks-member)|Represents the worksheet protection option allowing inserting of hyperlinks.| +||[allowInsertRows](/javascript/api/excel/excel.worksheetprotectionoptions#excel-excel-worksheetprotectionoptions-allowinsertrows-member)|Represents the worksheet protection option allowing inserting of rows.| +||[allowPivotTables](/javascript/api/excel/excel.worksheetprotectionoptions#excel-excel-worksheetprotectionoptions-allowpivottables-member)|Represents the worksheet protection option allowing use of the PivotTable feature.| +||[allowSort](/javascript/api/excel/excel.worksheetprotectionoptions#excel-excel-worksheetprotectionoptions-allowsort-member)|Represents the worksheet protection option allowing use of the sort feature.| diff --git a/docs/includes/excel-1_20.md b/docs/includes/excel-1_20.md index 71f1261c73..739f05f521 100644 --- a/docs/includes/excel-1_20.md +++ b/docs/includes/excel-1_20.md @@ -1,6 +1,6 @@ | Class | Fields | Description | |:---|:---|:---| -|[CustomFunctionManager](/.customfunctionmanager)||| -|[CustomFunctionVisibilityOptions](/.customfunctionvisibilityoptions)|[hide](/.customfunctionvisibilityoptions#excel-javascript/api/excel/-customfunctionvisibilityoptions-hide-member)|A list of custom functions to hide from Excel AutoComplete.| -||[show](/.customfunctionvisibilityoptions#excel-javascript/api/excel/-customfunctionvisibilityoptions-show-member)|A list of custom functions to show in Excel AutoComplete.| -|[RunOptions](/.runoptions)|[mergeUndoGroup](/.runoptions#excel-javascript/api/excel/-runoptions-mergeundogroup-member)|Determines whether the batch requests should be merged to one undo group.| +|[CustomFunctionManager](/javascript/api/excel/excel.customfunctionmanager)||| +|[CustomFunctionVisibilityOptions](/javascript/api/excel/excel.customfunctionvisibilityoptions)|[hide](/javascript/api/excel/excel.customfunctionvisibilityoptions#excel-excel-customfunctionvisibilityoptions-hide-member)|A list of custom functions to hide from Excel AutoComplete.| +||[show](/javascript/api/excel/excel.customfunctionvisibilityoptions#excel-excel-customfunctionvisibilityoptions-show-member)|A list of custom functions to show in Excel AutoComplete.| +|[RunOptions](/javascript/api/excel/excel.runoptions)|[mergeUndoGroup](/javascript/api/excel/excel.runoptions#excel-excel-runoptions-mergeundogroup-member)|Determines whether the batch requests should be merged to one undo group.| diff --git a/docs/includes/excel-1_3.md b/docs/includes/excel-1_3.md index ce1e76293a..b0fcd43e4d 100644 --- a/docs/includes/excel-1_3.md +++ b/docs/includes/excel-1_3.md @@ -1,35 +1,35 @@ | Class | Fields | Description | |:---|:---|:---| -|[Binding](/.binding)|[delete()](/.binding#excel-javascript/api/excel/-binding-delete-member(1))|Deletes the binding.| -|[BindingCollection](/.bindingcollection)|[add(range: Range \| string, bindingType: Excel.BindingType, id: string)](/.bindingcollection#excel-javascript/api/excel/-bindingcollection-add-member(1))|Add a new binding to a particular Range.| -||[addFromNamedItem(name: string, bindingType: Excel.BindingType, id: string)](/.bindingcollection#excel-javascript/api/excel/-bindingcollection-addfromnameditem-member(1))|Add a new binding based on a named item in the workbook.| -||[addFromSelection(bindingType: Excel.BindingType, id: string)](/.bindingcollection#excel-javascript/api/excel/-bindingcollection-addfromselection-member(1))|Add a new binding based on the current selection.| -|[PivotTable](/.pivottable)|[name](/.pivottable#excel-javascript/api/excel/-pivottable-name-member)|Name of the PivotTable.| -||[refresh()](/.pivottable#excel-javascript/api/excel/-pivottable-refresh-member(1))|Refreshes the PivotTable.| -||[worksheet](/.pivottable#excel-javascript/api/excel/-pivottable-worksheet-member)|The worksheet containing the current PivotTable.| -|[PivotTableCollection](/.pivottablecollection)|[getItem(name: string)](/.pivottablecollection#excel-javascript/api/excel/-pivottablecollection-getitem-member(1))|Gets a PivotTable by name.| -||[items](/.pivottablecollection#excel-javascript/api/excel/-pivottablecollection-items-member)|Gets the loaded child items in this collection.| -||[refreshAll()](/.pivottablecollection#excel-javascript/api/excel/-pivottablecollection-refreshall-member(1))|Refreshes all the pivot tables in the collection.| -|[Range](/.range)|[getVisibleView()](/.range#excel-javascript/api/excel/-range-getvisibleview-member(1))|Represents the visible rows of the current range.| -|[RangeView](/.rangeview)|[cellAddresses](/.rangeview#excel-javascript/api/excel/-rangeview-celladdresses-member)|Represents the cell addresses of the `RangeView`.| -||[columnCount](/.rangeview#excel-javascript/api/excel/-rangeview-columncount-member)|The number of visible columns.| -||[formulas](/.rangeview#excel-javascript/api/excel/-rangeview-formulas-member)|Represents the formula in A1-style notation.| -||[formulasLocal](/.rangeview#excel-javascript/api/excel/-rangeview-formulaslocal-member)|Represents the formula in A1-style notation, in the user's language and number-formatting locale.| -||[formulasR1C1](/.rangeview#excel-javascript/api/excel/-rangeview-formulasr1c1-member)|Represents the formula in R1C1-style notation.| -||[getRange()](/.rangeview#excel-javascript/api/excel/-rangeview-getrange-member(1))|Gets the parent range associated with the current `RangeView`.| -||[index](/.rangeview#excel-javascript/api/excel/-rangeview-index-member)|Returns a value that represents the index of the `RangeView`.| -||[numberFormat](/.rangeview#excel-javascript/api/excel/-rangeview-numberformat-member)|Represents Excel's number format code for the given cell.| -||[rowCount](/.rangeview#excel-javascript/api/excel/-rangeview-rowcount-member)|The number of visible rows.| -||[rows](/.rangeview#excel-javascript/api/excel/-rangeview-rows-member)|Represents a collection of range views associated with the range.| -||[text](/.rangeview#excel-javascript/api/excel/-rangeview-text-member)|Text values of the specified range.| -||[valueTypes](/.rangeview#excel-javascript/api/excel/-rangeview-valuetypes-member)|Represents the type of data of each cell.| -||[values](/.rangeview#excel-javascript/api/excel/-rangeview-values-member)|Represents the raw values of the specified range view.| -|[RangeViewCollection](/.rangeviewcollection)|[getItemAt(index: number)](/.rangeviewcollection#excel-javascript/api/excel/-rangeviewcollection-getitemat-member(1))|Gets a `RangeView` row via its index.| -||[items](/.rangeviewcollection#excel-javascript/api/excel/-rangeviewcollection-items-member)|Gets the loaded child items in this collection.| -|[Table](/.table)|[highlightFirstColumn](/.table#excel-javascript/api/excel/-table-highlightfirstcolumn-member)|Specifies if the first column contains special formatting.| -||[highlightLastColumn](/.table#excel-javascript/api/excel/-table-highlightlastcolumn-member)|Specifies if the last column contains special formatting.| -||[showBandedColumns](/.table#excel-javascript/api/excel/-table-showbandedcolumns-member)|Specifies if the columns show banded formatting in which odd columns are highlighted differently from even ones, to make reading the table easier.| -||[showBandedRows](/.table#excel-javascript/api/excel/-table-showbandedrows-member)|Specifies if the rows show banded formatting in which odd rows are highlighted differently from even ones, to make reading the table easier.| -||[showFilterButton](/.table#excel-javascript/api/excel/-table-showfilterbutton-member)|Specifies if the filter buttons are visible at the top of each column header.| -|[Workbook](/.workbook)|[pivotTables](/.workbook#excel-javascript/api/excel/-workbook-pivottables-member)|Represents a collection of PivotTables associated with the workbook.| -|[Worksheet](/.worksheet)|[pivotTables](/.worksheet#excel-javascript/api/excel/-worksheet-pivottables-member)|Collection of PivotTables that are part of the worksheet.| +|[Binding](/javascript/api/excel/excel.binding)|[delete()](/javascript/api/excel/excel.binding#excel-excel-binding-delete-member(1))|Deletes the binding.| +|[BindingCollection](/javascript/api/excel/excel.bindingcollection)|[add(range: Range \| string, bindingType: Excel.BindingType, id: string)](/javascript/api/excel/excel.bindingcollection#excel-excel-bindingcollection-add-member(1))|Add a new binding to a particular Range.| +||[addFromNamedItem(name: string, bindingType: Excel.BindingType, id: string)](/javascript/api/excel/excel.bindingcollection#excel-excel-bindingcollection-addfromnameditem-member(1))|Add a new binding based on a named item in the workbook.| +||[addFromSelection(bindingType: Excel.BindingType, id: string)](/javascript/api/excel/excel.bindingcollection#excel-excel-bindingcollection-addfromselection-member(1))|Add a new binding based on the current selection.| +|[PivotTable](/javascript/api/excel/excel.pivottable)|[name](/javascript/api/excel/excel.pivottable#excel-excel-pivottable-name-member)|Name of the PivotTable.| +||[refresh()](/javascript/api/excel/excel.pivottable#excel-excel-pivottable-refresh-member(1))|Refreshes the PivotTable.| +||[worksheet](/javascript/api/excel/excel.pivottable#excel-excel-pivottable-worksheet-member)|The worksheet containing the current PivotTable.| +|[PivotTableCollection](/javascript/api/excel/excel.pivottablecollection)|[getItem(name: string)](/javascript/api/excel/excel.pivottablecollection#excel-excel-pivottablecollection-getitem-member(1))|Gets a PivotTable by name.| +||[items](/javascript/api/excel/excel.pivottablecollection#excel-excel-pivottablecollection-items-member)|Gets the loaded child items in this collection.| +||[refreshAll()](/javascript/api/excel/excel.pivottablecollection#excel-excel-pivottablecollection-refreshall-member(1))|Refreshes all the pivot tables in the collection.| +|[Range](/javascript/api/excel/excel.range)|[getVisibleView()](/javascript/api/excel/excel.range#excel-excel-range-getvisibleview-member(1))|Represents the visible rows of the current range.| +|[RangeView](/javascript/api/excel/excel.rangeview)|[cellAddresses](/javascript/api/excel/excel.rangeview#excel-excel-rangeview-celladdresses-member)|Represents the cell addresses of the `RangeView`.| +||[columnCount](/javascript/api/excel/excel.rangeview#excel-excel-rangeview-columncount-member)|The number of visible columns.| +||[formulas](/javascript/api/excel/excel.rangeview#excel-excel-rangeview-formulas-member)|Represents the formula in A1-style notation.| +||[formulasLocal](/javascript/api/excel/excel.rangeview#excel-excel-rangeview-formulaslocal-member)|Represents the formula in A1-style notation, in the user's language and number-formatting locale.| +||[formulasR1C1](/javascript/api/excel/excel.rangeview#excel-excel-rangeview-formulasr1c1-member)|Represents the formula in R1C1-style notation.| +||[getRange()](/javascript/api/excel/excel.rangeview#excel-excel-rangeview-getrange-member(1))|Gets the parent range associated with the current `RangeView`.| +||[index](/javascript/api/excel/excel.rangeview#excel-excel-rangeview-index-member)|Returns a value that represents the index of the `RangeView`.| +||[numberFormat](/javascript/api/excel/excel.rangeview#excel-excel-rangeview-numberformat-member)|Represents Excel's number format code for the given cell.| +||[rowCount](/javascript/api/excel/excel.rangeview#excel-excel-rangeview-rowcount-member)|The number of visible rows.| +||[rows](/javascript/api/excel/excel.rangeview#excel-excel-rangeview-rows-member)|Represents a collection of range views associated with the range.| +||[text](/javascript/api/excel/excel.rangeview#excel-excel-rangeview-text-member)|Text values of the specified range.| +||[valueTypes](/javascript/api/excel/excel.rangeview#excel-excel-rangeview-valuetypes-member)|Represents the type of data of each cell.| +||[values](/javascript/api/excel/excel.rangeview#excel-excel-rangeview-values-member)|Represents the raw values of the specified range view.| +|[RangeViewCollection](/javascript/api/excel/excel.rangeviewcollection)|[getItemAt(index: number)](/javascript/api/excel/excel.rangeviewcollection#excel-excel-rangeviewcollection-getitemat-member(1))|Gets a `RangeView` row via its index.| +||[items](/javascript/api/excel/excel.rangeviewcollection#excel-excel-rangeviewcollection-items-member)|Gets the loaded child items in this collection.| +|[Table](/javascript/api/excel/excel.table)|[highlightFirstColumn](/javascript/api/excel/excel.table#excel-excel-table-highlightfirstcolumn-member)|Specifies if the first column contains special formatting.| +||[highlightLastColumn](/javascript/api/excel/excel.table#excel-excel-table-highlightlastcolumn-member)|Specifies if the last column contains special formatting.| +||[showBandedColumns](/javascript/api/excel/excel.table#excel-excel-table-showbandedcolumns-member)|Specifies if the columns show banded formatting in which odd columns are highlighted differently from even ones, to make reading the table easier.| +||[showBandedRows](/javascript/api/excel/excel.table#excel-excel-table-showbandedrows-member)|Specifies if the rows show banded formatting in which odd rows are highlighted differently from even ones, to make reading the table easier.| +||[showFilterButton](/javascript/api/excel/excel.table#excel-excel-table-showfilterbutton-member)|Specifies if the filter buttons are visible at the top of each column header.| +|[Workbook](/javascript/api/excel/excel.workbook)|[pivotTables](/javascript/api/excel/excel.workbook#excel-excel-workbook-pivottables-member)|Represents a collection of PivotTables associated with the workbook.| +|[Worksheet](/javascript/api/excel/excel.worksheet)|[pivotTables](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-pivottables-member)|Collection of PivotTables that are part of the worksheet.| diff --git a/docs/includes/excel-1_4.md b/docs/includes/excel-1_4.md index 9f9d704e7c..95c773bad7 100644 --- a/docs/includes/excel-1_4.md +++ b/docs/includes/excel-1_4.md @@ -1,43 +1,43 @@ | Class | Fields | Description | |:---|:---|:---| -|[BindingCollection](/.bindingcollection)|[getCount()](/.bindingcollection#excel-javascript/api/excel/-bindingcollection-getcount-member(1))|Gets the number of bindings in the collection.| -||[getItemOrNullObject(id: string)](/.bindingcollection#excel-javascript/api/excel/-bindingcollection-getitemornullobject-member(1))|Gets a binding object by ID.| -|[ChartCollection](/.chartcollection)|[getCount()](/.chartcollection#excel-javascript/api/excel/-chartcollection-getcount-member(1))|Returns the number of charts in the worksheet.| -||[getItemOrNullObject(name: string)](/.chartcollection#excel-javascript/api/excel/-chartcollection-getitemornullobject-member(1))|Gets a chart using its name.| -|[ChartPointsCollection](/.chartpointscollection)|[getCount()](/.chartpointscollection#excel-javascript/api/excel/-chartpointscollection-getcount-member(1))|Returns the number of chart points in the series.| -|[ChartSeriesCollection](/.chartseriescollection)|[getCount()](/.chartseriescollection#excel-javascript/api/excel/-chartseriescollection-getcount-member(1))|Returns the number of series in the collection.| -|[NamedItem](/.nameditem)|[comment](/.nameditem#excel-javascript/api/excel/-nameditem-comment-member)|Specifies the comment associated with this name.| -||[delete()](/.nameditem#excel-javascript/api/excel/-nameditem-delete-member(1))|Deletes the given name.| -||[getRangeOrNullObject()](/.nameditem#excel-javascript/api/excel/-nameditem-getrangeornullobject-member(1))|Returns the range object that is associated with the name.| -||[scope](/.nameditem#excel-javascript/api/excel/-nameditem-scope-member)|Specifies if the name is scoped to the workbook or to a specific worksheet.| -||[worksheet](/.nameditem#excel-javascript/api/excel/-nameditem-worksheet-member)|Returns the worksheet on which the named item is scoped to.| -||[worksheetOrNullObject](/.nameditem#excel-javascript/api/excel/-nameditem-worksheetornullobject-member)|Returns the worksheet to which the named item is scoped.| -|[NamedItemCollection](/.nameditemcollection)|[add(name: string, reference: Range \| string, comment?: string)](/.nameditemcollection#excel-javascript/api/excel/-nameditemcollection-add-member(1))|Adds a new name to the collection of the given scope.| -||[addFormulaLocal(name: string, formula: string, comment?: string)](/.nameditemcollection#excel-javascript/api/excel/-nameditemcollection-addformulalocal-member(1))|Adds a new name to the collection of the given scope using the user's locale for the formula.| -||[getCount()](/.nameditemcollection#excel-javascript/api/excel/-nameditemcollection-getcount-member(1))|Gets the number of named items in the collection.| -||[getItemOrNullObject(name: string)](/.nameditemcollection#excel-javascript/api/excel/-nameditemcollection-getitemornullobject-member(1))|Gets a `NamedItem` object using its name.| -|[PivotTableCollection](/.pivottablecollection)|[getCount()](/.pivottablecollection#excel-javascript/api/excel/-pivottablecollection-getcount-member(1))|Gets the number of pivot tables in the collection.| -||[getItemOrNullObject(name: string)](/.pivottablecollection#excel-javascript/api/excel/-pivottablecollection-getitemornullobject-member(1))|Gets a PivotTable by name.| -|[Range](/.range)|[getIntersectionOrNullObject(anotherRange: Range \| string)](/.range#excel-javascript/api/excel/-range-getintersectionornullobject-member(1))|Gets the range object that represents the rectangular intersection of the given ranges.| -||[getUsedRangeOrNullObject(valuesOnly?: boolean)](/.range#excel-javascript/api/excel/-range-getusedrangeornullobject-member(1))|Returns the used range of the given range object.| -|[RangeViewCollection](/.rangeviewcollection)|[getCount()](/.rangeviewcollection#excel-javascript/api/excel/-rangeviewcollection-getcount-member(1))|Gets the number of `RangeView` objects in the collection.| -|[Setting](/.setting)|[delete()](/.setting#excel-javascript/api/excel/-setting-delete-member(1))|Deletes the setting.| -||[key](/.setting#excel-javascript/api/excel/-setting-key-member)|The key that represents the ID of the setting.| -||[value](/.setting#excel-javascript/api/excel/-setting-value-member)|Represents the value stored for this setting.| -|[SettingCollection](/.settingcollection)|[add(key: string, value: string \| number \| boolean \| Date \| any[] \| any)](/.settingcollection#excel-javascript/api/excel/-settingcollection-add-member(1))|Sets or adds the specified setting to the workbook.| -||[getCount()](/.settingcollection#excel-javascript/api/excel/-settingcollection-getcount-member(1))|Gets the number of settings in the collection.| -||[getItem(key: string)](/.settingcollection#excel-javascript/api/excel/-settingcollection-getitem-member(1))|Gets a setting entry via the key.| -||[getItemOrNullObject(key: string)](/.settingcollection#excel-javascript/api/excel/-settingcollection-getitemornullobject-member(1))|Gets a setting entry via the key.| -||[items](/.settingcollection#excel-javascript/api/excel/-settingcollection-items-member)|Gets the loaded child items in this collection.| -||[onSettingsChanged](/.settingcollection#excel-javascript/api/excel/-settingcollection-onsettingschanged-member)|Occurs when the settings in the document are changed.| -|[SettingsChangedEventArgs](/.settingschangedeventargs)|[settings](/.settingschangedeventargs#excel-javascript/api/excel/-settingschangedeventargs-settings-member)|Gets the `Setting` object that represents the binding that raised the settings changed event| -|[TableCollection](/.tablecollection)|[getCount()](/.tablecollection#excel-javascript/api/excel/-tablecollection-getcount-member(1))|Gets the number of tables in the collection.| -||[getItemOrNullObject(key: string)](/.tablecollection#excel-javascript/api/excel/-tablecollection-getitemornullobject-member(1))|Gets a table by name or ID.| -|[TableColumnCollection](/.tablecolumncollection)|[getCount()](/.tablecolumncollection#excel-javascript/api/excel/-tablecolumncollection-getcount-member(1))|Gets the number of columns in the table.| -||[getItemOrNullObject(key: number \| string)](/.tablecolumncollection#excel-javascript/api/excel/-tablecolumncollection-getitemornullobject-member(1))|Gets a column object by name or ID.| -|[TableRowCollection](/.tablerowcollection)|[getCount()](/.tablerowcollection#excel-javascript/api/excel/-tablerowcollection-getcount-member(1))|Gets the number of rows in the table.| -|[Workbook](/.workbook)|[settings](/.workbook#excel-javascript/api/excel/-workbook-settings-member)|Represents a collection of settings associated with the workbook.| -|[Worksheet](/.worksheet)|[getUsedRangeOrNullObject(valuesOnly?: boolean)](/.worksheet#excel-javascript/api/excel/-worksheet-getusedrangeornullobject-member(1))|The used range is the smallest range that encompasses any cells that have a value or formatting assigned to them.| -||[names](/.worksheet#excel-javascript/api/excel/-worksheet-names-member)|Collection of names scoped to the current worksheet.| -|[WorksheetCollection](/.worksheetcollection)|[getCount(visibleOnly?: boolean)](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-getcount-member(1))|Gets the number of worksheets in the collection.| -||[getItemOrNullObject(key: string)](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-getitemornullobject-member(1))|Gets a worksheet object using its name or ID.| +|[BindingCollection](/javascript/api/excel/excel.bindingcollection)|[getCount()](/javascript/api/excel/excel.bindingcollection#excel-excel-bindingcollection-getcount-member(1))|Gets the number of bindings in the collection.| +||[getItemOrNullObject(id: string)](/javascript/api/excel/excel.bindingcollection#excel-excel-bindingcollection-getitemornullobject-member(1))|Gets a binding object by ID.| +|[ChartCollection](/javascript/api/excel/excel.chartcollection)|[getCount()](/javascript/api/excel/excel.chartcollection#excel-excel-chartcollection-getcount-member(1))|Returns the number of charts in the worksheet.| +||[getItemOrNullObject(name: string)](/javascript/api/excel/excel.chartcollection#excel-excel-chartcollection-getitemornullobject-member(1))|Gets a chart using its name.| +|[ChartPointsCollection](/javascript/api/excel/excel.chartpointscollection)|[getCount()](/javascript/api/excel/excel.chartpointscollection#excel-excel-chartpointscollection-getcount-member(1))|Returns the number of chart points in the series.| +|[ChartSeriesCollection](/javascript/api/excel/excel.chartseriescollection)|[getCount()](/javascript/api/excel/excel.chartseriescollection#excel-excel-chartseriescollection-getcount-member(1))|Returns the number of series in the collection.| +|[NamedItem](/javascript/api/excel/excel.nameditem)|[comment](/javascript/api/excel/excel.nameditem#excel-excel-nameditem-comment-member)|Specifies the comment associated with this name.| +||[delete()](/javascript/api/excel/excel.nameditem#excel-excel-nameditem-delete-member(1))|Deletes the given name.| +||[getRangeOrNullObject()](/javascript/api/excel/excel.nameditem#excel-excel-nameditem-getrangeornullobject-member(1))|Returns the range object that is associated with the name.| +||[scope](/javascript/api/excel/excel.nameditem#excel-excel-nameditem-scope-member)|Specifies if the name is scoped to the workbook or to a specific worksheet.| +||[worksheet](/javascript/api/excel/excel.nameditem#excel-excel-nameditem-worksheet-member)|Returns the worksheet on which the named item is scoped to.| +||[worksheetOrNullObject](/javascript/api/excel/excel.nameditem#excel-excel-nameditem-worksheetornullobject-member)|Returns the worksheet to which the named item is scoped.| +|[NamedItemCollection](/javascript/api/excel/excel.nameditemcollection)|[add(name: string, reference: Range \| string, comment?: string)](/javascript/api/excel/excel.nameditemcollection#excel-excel-nameditemcollection-add-member(1))|Adds a new name to the collection of the given scope.| +||[addFormulaLocal(name: string, formula: string, comment?: string)](/javascript/api/excel/excel.nameditemcollection#excel-excel-nameditemcollection-addformulalocal-member(1))|Adds a new name to the collection of the given scope using the user's locale for the formula.| +||[getCount()](/javascript/api/excel/excel.nameditemcollection#excel-excel-nameditemcollection-getcount-member(1))|Gets the number of named items in the collection.| +||[getItemOrNullObject(name: string)](/javascript/api/excel/excel.nameditemcollection#excel-excel-nameditemcollection-getitemornullobject-member(1))|Gets a `NamedItem` object using its name.| +|[PivotTableCollection](/javascript/api/excel/excel.pivottablecollection)|[getCount()](/javascript/api/excel/excel.pivottablecollection#excel-excel-pivottablecollection-getcount-member(1))|Gets the number of pivot tables in the collection.| +||[getItemOrNullObject(name: string)](/javascript/api/excel/excel.pivottablecollection#excel-excel-pivottablecollection-getitemornullobject-member(1))|Gets a PivotTable by name.| +|[Range](/javascript/api/excel/excel.range)|[getIntersectionOrNullObject(anotherRange: Range \| string)](/javascript/api/excel/excel.range#excel-excel-range-getintersectionornullobject-member(1))|Gets the range object that represents the rectangular intersection of the given ranges.| +||[getUsedRangeOrNullObject(valuesOnly?: boolean)](/javascript/api/excel/excel.range#excel-excel-range-getusedrangeornullobject-member(1))|Returns the used range of the given range object.| +|[RangeViewCollection](/javascript/api/excel/excel.rangeviewcollection)|[getCount()](/javascript/api/excel/excel.rangeviewcollection#excel-excel-rangeviewcollection-getcount-member(1))|Gets the number of `RangeView` objects in the collection.| +|[Setting](/javascript/api/excel/excel.setting)|[delete()](/javascript/api/excel/excel.setting#excel-excel-setting-delete-member(1))|Deletes the setting.| +||[key](/javascript/api/excel/excel.setting#excel-excel-setting-key-member)|The key that represents the ID of the setting.| +||[value](/javascript/api/excel/excel.setting#excel-excel-setting-value-member)|Represents the value stored for this setting.| +|[SettingCollection](/javascript/api/excel/excel.settingcollection)|[add(key: string, value: string \| number \| boolean \| Date \| any[] \| any)](/javascript/api/excel/excel.settingcollection#excel-excel-settingcollection-add-member(1))|Sets or adds the specified setting to the workbook.| +||[getCount()](/javascript/api/excel/excel.settingcollection#excel-excel-settingcollection-getcount-member(1))|Gets the number of settings in the collection.| +||[getItem(key: string)](/javascript/api/excel/excel.settingcollection#excel-excel-settingcollection-getitem-member(1))|Gets a setting entry via the key.| +||[getItemOrNullObject(key: string)](/javascript/api/excel/excel.settingcollection#excel-excel-settingcollection-getitemornullobject-member(1))|Gets a setting entry via the key.| +||[items](/javascript/api/excel/excel.settingcollection#excel-excel-settingcollection-items-member)|Gets the loaded child items in this collection.| +||[onSettingsChanged](/javascript/api/excel/excel.settingcollection#excel-excel-settingcollection-onsettingschanged-member)|Occurs when the settings in the document are changed.| +|[SettingsChangedEventArgs](/javascript/api/excel/excel.settingschangedeventargs)|[settings](/javascript/api/excel/excel.settingschangedeventargs#excel-excel-settingschangedeventargs-settings-member)|Gets the `Setting` object that represents the binding that raised the settings changed event| +|[TableCollection](/javascript/api/excel/excel.tablecollection)|[getCount()](/javascript/api/excel/excel.tablecollection#excel-excel-tablecollection-getcount-member(1))|Gets the number of tables in the collection.| +||[getItemOrNullObject(key: string)](/javascript/api/excel/excel.tablecollection#excel-excel-tablecollection-getitemornullobject-member(1))|Gets a table by name or ID.| +|[TableColumnCollection](/javascript/api/excel/excel.tablecolumncollection)|[getCount()](/javascript/api/excel/excel.tablecolumncollection#excel-excel-tablecolumncollection-getcount-member(1))|Gets the number of columns in the table.| +||[getItemOrNullObject(key: number \| string)](/javascript/api/excel/excel.tablecolumncollection#excel-excel-tablecolumncollection-getitemornullobject-member(1))|Gets a column object by name or ID.| +|[TableRowCollection](/javascript/api/excel/excel.tablerowcollection)|[getCount()](/javascript/api/excel/excel.tablerowcollection#excel-excel-tablerowcollection-getcount-member(1))|Gets the number of rows in the table.| +|[Workbook](/javascript/api/excel/excel.workbook)|[settings](/javascript/api/excel/excel.workbook#excel-excel-workbook-settings-member)|Represents a collection of settings associated with the workbook.| +|[Worksheet](/javascript/api/excel/excel.worksheet)|[getUsedRangeOrNullObject(valuesOnly?: boolean)](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-getusedrangeornullobject-member(1))|The used range is the smallest range that encompasses any cells that have a value or formatting assigned to them.| +||[names](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-names-member)|Collection of names scoped to the current worksheet.| +|[WorksheetCollection](/javascript/api/excel/excel.worksheetcollection)|[getCount(visibleOnly?: boolean)](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-getcount-member(1))|Gets the number of worksheets in the collection.| +||[getItemOrNullObject(key: string)](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-getitemornullobject-member(1))|Gets a worksheet object using its name or ID.| diff --git a/docs/includes/excel-1_5.md b/docs/includes/excel-1_5.md index f90a4b2ee9..f9467a6c3f 100644 --- a/docs/includes/excel-1_5.md +++ b/docs/includes/excel-1_5.md @@ -1,29 +1,29 @@ | Class | Fields | Description | |:---|:---|:---| -|[CustomXmlPart](/.customxmlpart)|[delete()](/.customxmlpart#excel-javascript/api/excel/-customxmlpart-delete-member(1))|Deletes the custom XML part.| -||[getXml()](/.customxmlpart#excel-javascript/api/excel/-customxmlpart-getxml-member(1))|Gets the custom XML part's full XML content.| -||[id](/.customxmlpart#excel-javascript/api/excel/-customxmlpart-id-member)|The custom XML part's ID.| -||[namespaceUri](/.customxmlpart#excel-javascript/api/excel/-customxmlpart-namespaceuri-member)|The custom XML part's namespace URI.| -||[setXml(xml: string)](/.customxmlpart#excel-javascript/api/excel/-customxmlpart-setxml-member(1))|Sets the custom XML part's full XML content.| -|[CustomXmlPartCollection](/.customxmlpartcollection)|[add(xml: string)](/.customxmlpartcollection#excel-javascript/api/excel/-customxmlpartcollection-add-member(1))|Adds a new custom XML part to the workbook.| -||[getByNamespace(namespaceUri: string)](/.customxmlpartcollection#excel-javascript/api/excel/-customxmlpartcollection-getbynamespace-member(1))|Gets a new scoped collection of custom XML parts whose namespaces match the given namespace.| -||[getCount()](/.customxmlpartcollection#excel-javascript/api/excel/-customxmlpartcollection-getcount-member(1))|Gets the number of custom XML parts in the collection.| -||[getItem(id: string)](/.customxmlpartcollection#excel-javascript/api/excel/-customxmlpartcollection-getitem-member(1))|Gets a custom XML part based on its ID.| -||[getItemOrNullObject(id: string)](/.customxmlpartcollection#excel-javascript/api/excel/-customxmlpartcollection-getitemornullobject-member(1))|Gets a custom XML part based on its ID.| -||[items](/.customxmlpartcollection#excel-javascript/api/excel/-customxmlpartcollection-items-member)|Gets the loaded child items in this collection.| -|[CustomXmlPartScopedCollection](/.customxmlpartscopedcollection)|[getCount()](/.customxmlpartscopedcollection#excel-javascript/api/excel/-customxmlpartscopedcollection-getcount-member(1))|Gets the number of CustomXML parts in this collection.| -||[getItem(id: string)](/.customxmlpartscopedcollection#excel-javascript/api/excel/-customxmlpartscopedcollection-getitem-member(1))|Gets a custom XML part based on its ID.| -||[getItemOrNullObject(id: string)](/.customxmlpartscopedcollection#excel-javascript/api/excel/-customxmlpartscopedcollection-getitemornullobject-member(1))|Gets a custom XML part based on its ID.| -||[getOnlyItem()](/.customxmlpartscopedcollection#excel-javascript/api/excel/-customxmlpartscopedcollection-getonlyitem-member(1))|If the collection contains exactly one item, this method returns it.| -||[getOnlyItemOrNullObject()](/.customxmlpartscopedcollection#excel-javascript/api/excel/-customxmlpartscopedcollection-getonlyitemornullobject-member(1))|If the collection contains exactly one item, this method returns it.| -||[items](/.customxmlpartscopedcollection#excel-javascript/api/excel/-customxmlpartscopedcollection-items-member)|Gets the loaded child items in this collection.| -|[PivotTable](/.pivottable)|[id](/.pivottable#excel-javascript/api/excel/-pivottable-id-member)|ID of the PivotTable.| -|[RequestContext](/.requestcontext)|[runtime](/.requestcontext#excel-javascript/api/excel/-requestcontext-runtime-member)|[Api set: ExcelApi 1.5]| -|[Runtime](/.runtime)||| -|[Workbook](/.workbook)|[customXmlParts](/.workbook#excel-javascript/api/excel/-workbook-customxmlparts-member)|Represents the collection of custom XML parts contained by this workbook.| -|[Worksheet](/.worksheet)|[getNext(visibleOnly?: boolean)](/.worksheet#excel-javascript/api/excel/-worksheet-getnext-member(1))|Gets the worksheet that follows this one.| -||[getNextOrNullObject(visibleOnly?: boolean)](/.worksheet#excel-javascript/api/excel/-worksheet-getnextornullobject-member(1))|Gets the worksheet that follows this one.| -||[getPrevious(visibleOnly?: boolean)](/.worksheet#excel-javascript/api/excel/-worksheet-getprevious-member(1))|Gets the worksheet that precedes this one.| -||[getPreviousOrNullObject(visibleOnly?: boolean)](/.worksheet#excel-javascript/api/excel/-worksheet-getpreviousornullobject-member(1))|Gets the worksheet that precedes this one.| -|[WorksheetCollection](/.worksheetcollection)|[getFirst(visibleOnly?: boolean)](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-getfirst-member(1))|Gets the first worksheet in the collection.| -||[getLast(visibleOnly?: boolean)](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-getlast-member(1))|Gets the last worksheet in the collection.| +|[CustomXmlPart](/javascript/api/excel/excel.customxmlpart)|[delete()](/javascript/api/excel/excel.customxmlpart#excel-excel-customxmlpart-delete-member(1))|Deletes the custom XML part.| +||[getXml()](/javascript/api/excel/excel.customxmlpart#excel-excel-customxmlpart-getxml-member(1))|Gets the custom XML part's full XML content.| +||[id](/javascript/api/excel/excel.customxmlpart#excel-excel-customxmlpart-id-member)|The custom XML part's ID.| +||[namespaceUri](/javascript/api/excel/excel.customxmlpart#excel-excel-customxmlpart-namespaceuri-member)|The custom XML part's namespace URI.| +||[setXml(xml: string)](/javascript/api/excel/excel.customxmlpart#excel-excel-customxmlpart-setxml-member(1))|Sets the custom XML part's full XML content.| +|[CustomXmlPartCollection](/javascript/api/excel/excel.customxmlpartcollection)|[add(xml: string)](/javascript/api/excel/excel.customxmlpartcollection#excel-excel-customxmlpartcollection-add-member(1))|Adds a new custom XML part to the workbook.| +||[getByNamespace(namespaceUri: string)](/javascript/api/excel/excel.customxmlpartcollection#excel-excel-customxmlpartcollection-getbynamespace-member(1))|Gets a new scoped collection of custom XML parts whose namespaces match the given namespace.| +||[getCount()](/javascript/api/excel/excel.customxmlpartcollection#excel-excel-customxmlpartcollection-getcount-member(1))|Gets the number of custom XML parts in the collection.| +||[getItem(id: string)](/javascript/api/excel/excel.customxmlpartcollection#excel-excel-customxmlpartcollection-getitem-member(1))|Gets a custom XML part based on its ID.| +||[getItemOrNullObject(id: string)](/javascript/api/excel/excel.customxmlpartcollection#excel-excel-customxmlpartcollection-getitemornullobject-member(1))|Gets a custom XML part based on its ID.| +||[items](/javascript/api/excel/excel.customxmlpartcollection#excel-excel-customxmlpartcollection-items-member)|Gets the loaded child items in this collection.| +|[CustomXmlPartScopedCollection](/javascript/api/excel/excel.customxmlpartscopedcollection)|[getCount()](/javascript/api/excel/excel.customxmlpartscopedcollection#excel-excel-customxmlpartscopedcollection-getcount-member(1))|Gets the number of CustomXML parts in this collection.| +||[getItem(id: string)](/javascript/api/excel/excel.customxmlpartscopedcollection#excel-excel-customxmlpartscopedcollection-getitem-member(1))|Gets a custom XML part based on its ID.| +||[getItemOrNullObject(id: string)](/javascript/api/excel/excel.customxmlpartscopedcollection#excel-excel-customxmlpartscopedcollection-getitemornullobject-member(1))|Gets a custom XML part based on its ID.| +||[getOnlyItem()](/javascript/api/excel/excel.customxmlpartscopedcollection#excel-excel-customxmlpartscopedcollection-getonlyitem-member(1))|If the collection contains exactly one item, this method returns it.| +||[getOnlyItemOrNullObject()](/javascript/api/excel/excel.customxmlpartscopedcollection#excel-excel-customxmlpartscopedcollection-getonlyitemornullobject-member(1))|If the collection contains exactly one item, this method returns it.| +||[items](/javascript/api/excel/excel.customxmlpartscopedcollection#excel-excel-customxmlpartscopedcollection-items-member)|Gets the loaded child items in this collection.| +|[PivotTable](/javascript/api/excel/excel.pivottable)|[id](/javascript/api/excel/excel.pivottable#excel-excel-pivottable-id-member)|ID of the PivotTable.| +|[RequestContext](/javascript/api/excel/excel.requestcontext)|[runtime](/javascript/api/excel/excel.requestcontext#excel-excel-requestcontext-runtime-member)|[Api set: ExcelApi 1.5]| +|[Runtime](/javascript/api/excel/excel.runtime)||| +|[Workbook](/javascript/api/excel/excel.workbook)|[customXmlParts](/javascript/api/excel/excel.workbook#excel-excel-workbook-customxmlparts-member)|Represents the collection of custom XML parts contained by this workbook.| +|[Worksheet](/javascript/api/excel/excel.worksheet)|[getNext(visibleOnly?: boolean)](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-getnext-member(1))|Gets the worksheet that follows this one.| +||[getNextOrNullObject(visibleOnly?: boolean)](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-getnextornullobject-member(1))|Gets the worksheet that follows this one.| +||[getPrevious(visibleOnly?: boolean)](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-getprevious-member(1))|Gets the worksheet that precedes this one.| +||[getPreviousOrNullObject(visibleOnly?: boolean)](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-getpreviousornullobject-member(1))|Gets the worksheet that precedes this one.| +|[WorksheetCollection](/javascript/api/excel/excel.worksheetcollection)|[getFirst(visibleOnly?: boolean)](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-getfirst-member(1))|Gets the first worksheet in the collection.| +||[getLast(visibleOnly?: boolean)](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-getlast-member(1))|Gets the last worksheet in the collection.| diff --git a/docs/includes/excel-1_6.md b/docs/includes/excel-1_6.md index 133604be10..b1f8a6cbfc 100644 --- a/docs/includes/excel-1_6.md +++ b/docs/includes/excel-1_6.md @@ -1,112 +1,112 @@ | Class | Fields | Description | |:---|:---|:---| -|[Application](/.application)|[suspendApiCalculationUntilNextSync()](/.application#excel-javascript/api/excel/-application-suspendapicalculationuntilnextsync-member(1))|Suspends calculation until the next `context.sync()` is called.| -|[CellValueConditionalFormat](/.cellvalueconditionalformat)|[format](/.cellvalueconditionalformat#excel-javascript/api/excel/-cellvalueconditionalformat-format-member)|Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties.| -||[rule](/.cellvalueconditionalformat#excel-javascript/api/excel/-cellvalueconditionalformat-rule-member)|Specifies the rule object on this conditional format.| -|[ColorScaleConditionalFormat](/.colorscaleconditionalformat)|[criteria](/.colorscaleconditionalformat#excel-javascript/api/excel/-colorscaleconditionalformat-criteria-member)|The criteria of the color scale.| -||[threeColorScale](/.colorscaleconditionalformat#excel-javascript/api/excel/-colorscaleconditionalformat-threecolorscale-member)|If `true`, the color scale will have three points (minimum, midpoint, maximum), otherwise it will have two (minimum, maximum).| -|[ConditionalCellValueRule](/.conditionalcellvaluerule)|[formula1](/.conditionalcellvaluerule#excel-javascript/api/excel/-conditionalcellvaluerule-formula1-member)|The formula, if required, on which to evaluate the conditional format rule.| -||[formula2](/.conditionalcellvaluerule#excel-javascript/api/excel/-conditionalcellvaluerule-formula2-member)|The formula, if required, on which to evaluate the conditional format rule.| -||[operator](/.conditionalcellvaluerule#excel-javascript/api/excel/-conditionalcellvaluerule-operator-member)|The operator of the cell value conditional format.| -|[ConditionalColorScaleCriteria](/.conditionalcolorscalecriteria)|[maximum](/.conditionalcolorscalecriteria#excel-javascript/api/excel/-conditionalcolorscalecriteria-maximum-member)|The maximum point of the color scale criterion.| -||[midpoint](/.conditionalcolorscalecriteria#excel-javascript/api/excel/-conditionalcolorscalecriteria-midpoint-member)|The midpoint of the color scale criterion, if the color scale is a 3-color scale.| -||[minimum](/.conditionalcolorscalecriteria#excel-javascript/api/excel/-conditionalcolorscalecriteria-minimum-member)|The minimum point of the color scale criterion.| -|[ConditionalColorScaleCriterion](/.conditionalcolorscalecriterion)|[color](/.conditionalcolorscalecriterion#excel-javascript/api/excel/-conditionalcolorscalecriterion-color-member)|HTML color code representation of the color scale color (e.g., #FF0000 represents Red).| -||[formula](/.conditionalcolorscalecriterion#excel-javascript/api/excel/-conditionalcolorscalecriterion-formula-member)|A number, a formula, or `null` (if `type` is `lowestValue`).| -||[type](/.conditionalcolorscalecriterion#excel-javascript/api/excel/-conditionalcolorscalecriterion-type-member)|What the criterion conditional formula should be based on.| -|[ConditionalDataBarNegativeFormat](/.conditionaldatabarnegativeformat)|[borderColor](/.conditionaldatabarnegativeformat#excel-javascript/api/excel/-conditionaldatabarnegativeformat-bordercolor-member)|HTML color code representing the color of the border line, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").| -||[fillColor](/.conditionaldatabarnegativeformat#excel-javascript/api/excel/-conditionaldatabarnegativeformat-fillcolor-member)|HTML color code representing the fill color, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").| -||[matchPositiveBorderColor](/.conditionaldatabarnegativeformat#excel-javascript/api/excel/-conditionaldatabarnegativeformat-matchpositivebordercolor-member)|Specifies if the negative data bar has the same border color as the positive data bar.| -||[matchPositiveFillColor](/.conditionaldatabarnegativeformat#excel-javascript/api/excel/-conditionaldatabarnegativeformat-matchpositivefillcolor-member)|Specifies if the negative data bar has the same fill color as the positive data bar.| -|[ConditionalDataBarPositiveFormat](/.conditionaldatabarpositiveformat)|[borderColor](/.conditionaldatabarpositiveformat#excel-javascript/api/excel/-conditionaldatabarpositiveformat-bordercolor-member)|HTML color code representing the color of the border line, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").| -||[fillColor](/.conditionaldatabarpositiveformat#excel-javascript/api/excel/-conditionaldatabarpositiveformat-fillcolor-member)|HTML color code representing the fill color, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").| -||[gradientFill](/.conditionaldatabarpositiveformat#excel-javascript/api/excel/-conditionaldatabarpositiveformat-gradientfill-member)|Specifies if the data bar has a gradient.| -|[ConditionalDataBarRule](/.conditionaldatabarrule)|[formula](/.conditionaldatabarrule#excel-javascript/api/excel/-conditionaldatabarrule-formula-member)|The formula, if required, on which to evaluate the data bar rule.| -||[type](/.conditionaldatabarrule#excel-javascript/api/excel/-conditionaldatabarrule-type-member)|The type of rule for the data bar.| -|[ConditionalFormat](/.conditionalformat)|[cellValue](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-cellvalue-member)|Returns the cell value conditional format properties if the current conditional format is a `CellValue` type.| -||[cellValueOrNullObject](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-cellvalueornullobject-member)|Returns the cell value conditional format properties if the current conditional format is a `CellValue` type.| -||[colorScale](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-colorscale-member)|Returns the color scale conditional format properties if the current conditional format is a `ColorScale` type.| -||[colorScaleOrNullObject](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-colorscaleornullobject-member)|Returns the color scale conditional format properties if the current conditional format is a `ColorScale` type.| -||[custom](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-custom-member)|Returns the custom conditional format properties if the current conditional format is a custom type.| -||[customOrNullObject](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-customornullobject-member)|Returns the custom conditional format properties if the current conditional format is a custom type.| -||[dataBar](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-databar-member)|Returns the data bar properties if the current conditional format is a data bar.| -||[dataBarOrNullObject](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-databarornullobject-member)|Returns the data bar properties if the current conditional format is a data bar.| -||[delete()](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-delete-member(1))|Deletes this conditional format.| -||[getRange()](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-getrange-member(1))|Returns the range the conditional format is applied to.| -||[getRangeOrNullObject()](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-getrangeornullobject-member(1))|Returns the range to which the conditional format is applied.| -||[iconSet](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-iconset-member)|Returns the icon set conditional format properties if the current conditional format is an `IconSet` type.| -||[iconSetOrNullObject](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-iconsetornullobject-member)|Returns the icon set conditional format properties if the current conditional format is an `IconSet` type.| -||[id](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-id-member)|The priority of the conditional format in the current `ConditionalFormatCollection`.| -||[preset](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-preset-member)|Returns the preset criteria conditional format.| -||[presetOrNullObject](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-presetornullobject-member)|Returns the preset criteria conditional format.| -||[priority](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-priority-member)|The priority (or index) within the conditional format collection that this conditional format currently exists in.| -||[stopIfTrue](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-stopiftrue-member)|If the conditions of this conditional format are met, no lower-priority formats shall take effect on that cell.| -||[textComparison](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-textcomparison-member)|Returns the specific text conditional format properties if the current conditional format is a text type.| -||[textComparisonOrNullObject](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-textcomparisonornullobject-member)|Returns the specific text conditional format properties if the current conditional format is a text type.| -||[topBottom](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-topbottom-member)|Returns the top/bottom conditional format properties if the current conditional format is a `TopBottom` type.| -||[topBottomOrNullObject](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-topbottomornullobject-member)|Returns the top/bottom conditional format properties if the current conditional format is a `TopBottom` type.| -||[type](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-type-member)|A type of conditional format.| -|[ConditionalFormatCollection](/.conditionalformatcollection)|[add(type: Excel.ConditionalFormatType)](/.conditionalformatcollection#excel-javascript/api/excel/-conditionalformatcollection-add-member(1))|Adds a new conditional format to the collection at the first/top priority.| -||[clearAll()](/.conditionalformatcollection#excel-javascript/api/excel/-conditionalformatcollection-clearall-member(1))|Clears all conditional formats active on the current specified range.| -||[getCount()](/.conditionalformatcollection#excel-javascript/api/excel/-conditionalformatcollection-getcount-member(1))|Returns the number of conditional formats in the workbook.| -||[getItem(id: string)](/.conditionalformatcollection#excel-javascript/api/excel/-conditionalformatcollection-getitem-member(1))|Returns a conditional format for the given ID.| -||[getItemAt(index: number)](/.conditionalformatcollection#excel-javascript/api/excel/-conditionalformatcollection-getitemat-member(1))|Returns a conditional format at the given index.| -||[items](/.conditionalformatcollection#excel-javascript/api/excel/-conditionalformatcollection-items-member)|Gets the loaded child items in this collection.| -|[ConditionalFormatRule](/.conditionalformatrule)|[formula](/.conditionalformatrule#excel-javascript/api/excel/-conditionalformatrule-formula-member)|The formula, if required, on which to evaluate the conditional format rule.| -||[formulaLocal](/.conditionalformatrule#excel-javascript/api/excel/-conditionalformatrule-formulalocal-member)|The formula, if required, on which to evaluate the conditional format rule in the user's language.| -||[formulaR1C1](/.conditionalformatrule#excel-javascript/api/excel/-conditionalformatrule-formular1c1-member)|The formula, if required, on which to evaluate the conditional format rule in R1C1-style notation.| -|[ConditionalIconCriterion](/.conditionaliconcriterion)|[customIcon](/.conditionaliconcriterion#excel-javascript/api/excel/-conditionaliconcriterion-customicon-member)|The custom icon for the current criterion, if different from the default icon set, else `null` will be returned.| -||[formula](/.conditionaliconcriterion#excel-javascript/api/excel/-conditionaliconcriterion-formula-member)|A number or a formula depending on the type.| -||[operator](/.conditionaliconcriterion#excel-javascript/api/excel/-conditionaliconcriterion-operator-member)|`greaterThan` or `greaterThanOrEqual` for each of the rule types for the icon conditional format.| -||[type](/.conditionaliconcriterion#excel-javascript/api/excel/-conditionaliconcriterion-type-member)|What the icon conditional formula should be based on.| -|[ConditionalPresetCriteriaRule](/.conditionalpresetcriteriarule)|[criterion](/.conditionalpresetcriteriarule#excel-javascript/api/excel/-conditionalpresetcriteriarule-criterion-member)|The criterion of the conditional format.| -|[ConditionalRangeBorder](/.conditionalrangeborder)|[color](/.conditionalrangeborder#excel-javascript/api/excel/-conditionalrangeborder-color-member)|HTML color code representing the color of the border line, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").| -||[sideIndex](/.conditionalrangeborder#excel-javascript/api/excel/-conditionalrangeborder-sideindex-member)|Constant value that indicates the specific side of the border.| -||[style](/.conditionalrangeborder#excel-javascript/api/excel/-conditionalrangeborder-style-member)|One of the constants of line style specifying the line style for the border.| -|[ConditionalRangeBorderCollection](/.conditionalrangebordercollection)|[bottom](/.conditionalrangebordercollection#excel-javascript/api/excel/-conditionalrangebordercollection-bottom-member)|Gets the bottom border.| -||[count](/.conditionalrangebordercollection#excel-javascript/api/excel/-conditionalrangebordercollection-count-member)|Number of border objects in the collection.| -||[getItem(index: Excel.ConditionalRangeBorderIndex)](/.conditionalrangebordercollection#excel-javascript/api/excel/-conditionalrangebordercollection-getitem-member(1))|Gets a border object using its name.| -||[getItemAt(index: number)](/.conditionalrangebordercollection#excel-javascript/api/excel/-conditionalrangebordercollection-getitemat-member(1))|Gets a border object using its index.| -||[items](/.conditionalrangebordercollection#excel-javascript/api/excel/-conditionalrangebordercollection-items-member)|Gets the loaded child items in this collection.| -||[left](/.conditionalrangebordercollection#excel-javascript/api/excel/-conditionalrangebordercollection-left-member)|Gets the left border.| -||[right](/.conditionalrangebordercollection#excel-javascript/api/excel/-conditionalrangebordercollection-right-member)|Gets the right border.| -||[top](/.conditionalrangebordercollection#excel-javascript/api/excel/-conditionalrangebordercollection-top-member)|Gets the top border.| -|[ConditionalRangeFill](/.conditionalrangefill)|[clear()](/.conditionalrangefill#excel-javascript/api/excel/-conditionalrangefill-clear-member(1))|Resets the fill.| -||[color](/.conditionalrangefill#excel-javascript/api/excel/-conditionalrangefill-color-member)|HTML color code representing the color of the fill, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").| -|[ConditionalRangeFont](/.conditionalrangefont)|[bold](/.conditionalrangefont#excel-javascript/api/excel/-conditionalrangefont-bold-member)|Specifies if the font is bold.| -||[clear()](/.conditionalrangefont#excel-javascript/api/excel/-conditionalrangefont-clear-member(1))|Resets the font formats.| -||[color](/.conditionalrangefont#excel-javascript/api/excel/-conditionalrangefont-color-member)|HTML color code representation of the text color (e.g., #FF0000 represents Red).| -||[italic](/.conditionalrangefont#excel-javascript/api/excel/-conditionalrangefont-italic-member)|Specifies if the font is italic.| -||[strikethrough](/.conditionalrangefont#excel-javascript/api/excel/-conditionalrangefont-strikethrough-member)|Specifies the strikethrough status of the font.| -||[underline](/.conditionalrangefont#excel-javascript/api/excel/-conditionalrangefont-underline-member)|The type of underline applied to the font.| -|[ConditionalRangeFormat](/.conditionalrangeformat)|[borders](/.conditionalrangeformat#excel-javascript/api/excel/-conditionalrangeformat-borders-member)|Collection of border objects that apply to the overall conditional format range.| -||[fill](/.conditionalrangeformat#excel-javascript/api/excel/-conditionalrangeformat-fill-member)|Returns the fill object defined on the overall conditional format range.| -||[font](/.conditionalrangeformat#excel-javascript/api/excel/-conditionalrangeformat-font-member)|Returns the font object defined on the overall conditional format range.| -||[numberFormat](/.conditionalrangeformat#excel-javascript/api/excel/-conditionalrangeformat-numberformat-member)|Represents Excel's number format code for the given range.| -|[ConditionalTextComparisonRule](/.conditionaltextcomparisonrule)|[operator](/.conditionaltextcomparisonrule#excel-javascript/api/excel/-conditionaltextcomparisonrule-operator-member)|The operator of the text conditional format.| -||[text](/.conditionaltextcomparisonrule#excel-javascript/api/excel/-conditionaltextcomparisonrule-text-member)|The text value of the conditional format.| -|[ConditionalTopBottomRule](/.conditionaltopbottomrule)|[rank](/.conditionaltopbottomrule#excel-javascript/api/excel/-conditionaltopbottomrule-rank-member)|The rank between 1 and 1000 for numeric ranks or 1 and 100 for percent ranks.| -||[type](/.conditionaltopbottomrule#excel-javascript/api/excel/-conditionaltopbottomrule-type-member)|Format values based on the top or bottom rank.| -|[CustomConditionalFormat](/.customconditionalformat)|[format](/.customconditionalformat#excel-javascript/api/excel/-customconditionalformat-format-member)|Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties.| -||[rule](/.customconditionalformat#excel-javascript/api/excel/-customconditionalformat-rule-member)|Specifies the `Rule` object on this conditional format.| -|[DataBarConditionalFormat](/.databarconditionalformat)|[axisColor](/.databarconditionalformat#excel-javascript/api/excel/-databarconditionalformat-axiscolor-member)|HTML color code representing the color of the Axis line, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").| -||[axisFormat](/.databarconditionalformat#excel-javascript/api/excel/-databarconditionalformat-axisformat-member)|Representation of how the axis is determined for an Excel data bar.| -||[barDirection](/.databarconditionalformat#excel-javascript/api/excel/-databarconditionalformat-bardirection-member)|Specifies the direction that the data bar graphic should be based on.| -||[lowerBoundRule](/.databarconditionalformat#excel-javascript/api/excel/-databarconditionalformat-lowerboundrule-member)|The rule for what constitutes the lower bound (and how to calculate it, if applicable) for a data bar.| -||[negativeFormat](/.databarconditionalformat#excel-javascript/api/excel/-databarconditionalformat-negativeformat-member)|Representation of all values to the left of the axis in an Excel data bar.| -||[positiveFormat](/.databarconditionalformat#excel-javascript/api/excel/-databarconditionalformat-positiveformat-member)|Representation of all values to the right of the axis in an Excel data bar.| -||[showDataBarOnly](/.databarconditionalformat#excel-javascript/api/excel/-databarconditionalformat-showdatabaronly-member)|If `true`, hides the values from the cells where the data bar is applied.| -||[upperBoundRule](/.databarconditionalformat#excel-javascript/api/excel/-databarconditionalformat-upperboundrule-member)|The rule for what constitutes the upper bound (and how to calculate it, if applicable) for a data bar.| -|[IconSetConditionalFormat](/.iconsetconditionalformat)|[criteria](/.iconsetconditionalformat#excel-javascript/api/excel/-iconsetconditionalformat-criteria-member)|An array of criteria and icon sets for the rules and potential custom icons for conditional icons.| -||[reverseIconOrder](/.iconsetconditionalformat#excel-javascript/api/excel/-iconsetconditionalformat-reverseiconorder-member)|If `true`, reverses the icon orders for the icon set.| -||[showIconOnly](/.iconsetconditionalformat#excel-javascript/api/excel/-iconsetconditionalformat-showicononly-member)|If `true`, hides the values and only shows icons.| -||[style](/.iconsetconditionalformat#excel-javascript/api/excel/-iconsetconditionalformat-style-member)|If set, displays the icon set option for the conditional format.| -|[PresetCriteriaConditionalFormat](/.presetcriteriaconditionalformat)|[format](/.presetcriteriaconditionalformat#excel-javascript/api/excel/-presetcriteriaconditionalformat-format-member)|Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties.| -||[rule](/.presetcriteriaconditionalformat#excel-javascript/api/excel/-presetcriteriaconditionalformat-rule-member)|The rule of the conditional format.| -|[Range](/.range)|[calculate()](/.range#excel-javascript/api/excel/-range-calculate-member(1))|Calculates a range of cells on a worksheet.| -||[conditionalFormats](/.range#excel-javascript/api/excel/-range-conditionalformats-member)|The collection of `ConditionalFormats` that intersect the range.| -|[TextConditionalFormat](/.textconditionalformat)|[format](/.textconditionalformat#excel-javascript/api/excel/-textconditionalformat-format-member)|Returns a format object, encapsulating the conditional format's font, fill, borders, and other properties.| -||[rule](/.textconditionalformat#excel-javascript/api/excel/-textconditionalformat-rule-member)|The rule of the conditional format.| -|[TopBottomConditionalFormat](/.topbottomconditionalformat)|[format](/.topbottomconditionalformat#excel-javascript/api/excel/-topbottomconditionalformat-format-member)|Returns a format object, encapsulating the conditional format's font, fill, borders, and other properties.| -||[rule](/.topbottomconditionalformat#excel-javascript/api/excel/-topbottomconditionalformat-rule-member)|The criteria of the top/bottom conditional format.| -|[Worksheet](/.worksheet)|[calculate(markAllDirty: boolean)](/.worksheet#excel-javascript/api/excel/-worksheet-calculate-member(1))|Calculates all cells on a worksheet.| +|[Application](/javascript/api/excel/excel.application)|[suspendApiCalculationUntilNextSync()](/javascript/api/excel/excel.application#excel-excel-application-suspendapicalculationuntilnextsync-member(1))|Suspends calculation until the next `context.sync()` is called.| +|[CellValueConditionalFormat](/javascript/api/excel/excel.cellvalueconditionalformat)|[format](/javascript/api/excel/excel.cellvalueconditionalformat#excel-excel-cellvalueconditionalformat-format-member)|Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties.| +||[rule](/javascript/api/excel/excel.cellvalueconditionalformat#excel-excel-cellvalueconditionalformat-rule-member)|Specifies the rule object on this conditional format.| +|[ColorScaleConditionalFormat](/javascript/api/excel/excel.colorscaleconditionalformat)|[criteria](/javascript/api/excel/excel.colorscaleconditionalformat#excel-excel-colorscaleconditionalformat-criteria-member)|The criteria of the color scale.| +||[threeColorScale](/javascript/api/excel/excel.colorscaleconditionalformat#excel-excel-colorscaleconditionalformat-threecolorscale-member)|If `true`, the color scale will have three points (minimum, midpoint, maximum), otherwise it will have two (minimum, maximum).| +|[ConditionalCellValueRule](/javascript/api/excel/excel.conditionalcellvaluerule)|[formula1](/javascript/api/excel/excel.conditionalcellvaluerule#excel-excel-conditionalcellvaluerule-formula1-member)|The formula, if required, on which to evaluate the conditional format rule.| +||[formula2](/javascript/api/excel/excel.conditionalcellvaluerule#excel-excel-conditionalcellvaluerule-formula2-member)|The formula, if required, on which to evaluate the conditional format rule.| +||[operator](/javascript/api/excel/excel.conditionalcellvaluerule#excel-excel-conditionalcellvaluerule-operator-member)|The operator of the cell value conditional format.| +|[ConditionalColorScaleCriteria](/javascript/api/excel/excel.conditionalcolorscalecriteria)|[maximum](/javascript/api/excel/excel.conditionalcolorscalecriteria#excel-excel-conditionalcolorscalecriteria-maximum-member)|The maximum point of the color scale criterion.| +||[midpoint](/javascript/api/excel/excel.conditionalcolorscalecriteria#excel-excel-conditionalcolorscalecriteria-midpoint-member)|The midpoint of the color scale criterion, if the color scale is a 3-color scale.| +||[minimum](/javascript/api/excel/excel.conditionalcolorscalecriteria#excel-excel-conditionalcolorscalecriteria-minimum-member)|The minimum point of the color scale criterion.| +|[ConditionalColorScaleCriterion](/javascript/api/excel/excel.conditionalcolorscalecriterion)|[color](/javascript/api/excel/excel.conditionalcolorscalecriterion#excel-excel-conditionalcolorscalecriterion-color-member)|HTML color code representation of the color scale color (e.g., #FF0000 represents Red).| +||[formula](/javascript/api/excel/excel.conditionalcolorscalecriterion#excel-excel-conditionalcolorscalecriterion-formula-member)|A number, a formula, or `null` (if `type` is `lowestValue`).| +||[type](/javascript/api/excel/excel.conditionalcolorscalecriterion#excel-excel-conditionalcolorscalecriterion-type-member)|What the criterion conditional formula should be based on.| +|[ConditionalDataBarNegativeFormat](/javascript/api/excel/excel.conditionaldatabarnegativeformat)|[borderColor](/javascript/api/excel/excel.conditionaldatabarnegativeformat#excel-excel-conditionaldatabarnegativeformat-bordercolor-member)|HTML color code representing the color of the border line, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").| +||[fillColor](/javascript/api/excel/excel.conditionaldatabarnegativeformat#excel-excel-conditionaldatabarnegativeformat-fillcolor-member)|HTML color code representing the fill color, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").| +||[matchPositiveBorderColor](/javascript/api/excel/excel.conditionaldatabarnegativeformat#excel-excel-conditionaldatabarnegativeformat-matchpositivebordercolor-member)|Specifies if the negative data bar has the same border color as the positive data bar.| +||[matchPositiveFillColor](/javascript/api/excel/excel.conditionaldatabarnegativeformat#excel-excel-conditionaldatabarnegativeformat-matchpositivefillcolor-member)|Specifies if the negative data bar has the same fill color as the positive data bar.| +|[ConditionalDataBarPositiveFormat](/javascript/api/excel/excel.conditionaldatabarpositiveformat)|[borderColor](/javascript/api/excel/excel.conditionaldatabarpositiveformat#excel-excel-conditionaldatabarpositiveformat-bordercolor-member)|HTML color code representing the color of the border line, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").| +||[fillColor](/javascript/api/excel/excel.conditionaldatabarpositiveformat#excel-excel-conditionaldatabarpositiveformat-fillcolor-member)|HTML color code representing the fill color, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").| +||[gradientFill](/javascript/api/excel/excel.conditionaldatabarpositiveformat#excel-excel-conditionaldatabarpositiveformat-gradientfill-member)|Specifies if the data bar has a gradient.| +|[ConditionalDataBarRule](/javascript/api/excel/excel.conditionaldatabarrule)|[formula](/javascript/api/excel/excel.conditionaldatabarrule#excel-excel-conditionaldatabarrule-formula-member)|The formula, if required, on which to evaluate the data bar rule.| +||[type](/javascript/api/excel/excel.conditionaldatabarrule#excel-excel-conditionaldatabarrule-type-member)|The type of rule for the data bar.| +|[ConditionalFormat](/javascript/api/excel/excel.conditionalformat)|[cellValue](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-cellvalue-member)|Returns the cell value conditional format properties if the current conditional format is a `CellValue` type.| +||[cellValueOrNullObject](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-cellvalueornullobject-member)|Returns the cell value conditional format properties if the current conditional format is a `CellValue` type.| +||[colorScale](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-colorscale-member)|Returns the color scale conditional format properties if the current conditional format is a `ColorScale` type.| +||[colorScaleOrNullObject](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-colorscaleornullobject-member)|Returns the color scale conditional format properties if the current conditional format is a `ColorScale` type.| +||[custom](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-custom-member)|Returns the custom conditional format properties if the current conditional format is a custom type.| +||[customOrNullObject](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-customornullobject-member)|Returns the custom conditional format properties if the current conditional format is a custom type.| +||[dataBar](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-databar-member)|Returns the data bar properties if the current conditional format is a data bar.| +||[dataBarOrNullObject](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-databarornullobject-member)|Returns the data bar properties if the current conditional format is a data bar.| +||[delete()](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-delete-member(1))|Deletes this conditional format.| +||[getRange()](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-getrange-member(1))|Returns the range the conditional format is applied to.| +||[getRangeOrNullObject()](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-getrangeornullobject-member(1))|Returns the range to which the conditional format is applied.| +||[iconSet](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-iconset-member)|Returns the icon set conditional format properties if the current conditional format is an `IconSet` type.| +||[iconSetOrNullObject](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-iconsetornullobject-member)|Returns the icon set conditional format properties if the current conditional format is an `IconSet` type.| +||[id](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-id-member)|The priority of the conditional format in the current `ConditionalFormatCollection`.| +||[preset](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-preset-member)|Returns the preset criteria conditional format.| +||[presetOrNullObject](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-presetornullobject-member)|Returns the preset criteria conditional format.| +||[priority](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-priority-member)|The priority (or index) within the conditional format collection that this conditional format currently exists in.| +||[stopIfTrue](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-stopiftrue-member)|If the conditions of this conditional format are met, no lower-priority formats shall take effect on that cell.| +||[textComparison](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-textcomparison-member)|Returns the specific text conditional format properties if the current conditional format is a text type.| +||[textComparisonOrNullObject](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-textcomparisonornullobject-member)|Returns the specific text conditional format properties if the current conditional format is a text type.| +||[topBottom](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-topbottom-member)|Returns the top/bottom conditional format properties if the current conditional format is a `TopBottom` type.| +||[topBottomOrNullObject](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-topbottomornullobject-member)|Returns the top/bottom conditional format properties if the current conditional format is a `TopBottom` type.| +||[type](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-type-member)|A type of conditional format.| +|[ConditionalFormatCollection](/javascript/api/excel/excel.conditionalformatcollection)|[add(type: Excel.ConditionalFormatType)](/javascript/api/excel/excel.conditionalformatcollection#excel-excel-conditionalformatcollection-add-member(1))|Adds a new conditional format to the collection at the first/top priority.| +||[clearAll()](/javascript/api/excel/excel.conditionalformatcollection#excel-excel-conditionalformatcollection-clearall-member(1))|Clears all conditional formats active on the current specified range.| +||[getCount()](/javascript/api/excel/excel.conditionalformatcollection#excel-excel-conditionalformatcollection-getcount-member(1))|Returns the number of conditional formats in the workbook.| +||[getItem(id: string)](/javascript/api/excel/excel.conditionalformatcollection#excel-excel-conditionalformatcollection-getitem-member(1))|Returns a conditional format for the given ID.| +||[getItemAt(index: number)](/javascript/api/excel/excel.conditionalformatcollection#excel-excel-conditionalformatcollection-getitemat-member(1))|Returns a conditional format at the given index.| +||[items](/javascript/api/excel/excel.conditionalformatcollection#excel-excel-conditionalformatcollection-items-member)|Gets the loaded child items in this collection.| +|[ConditionalFormatRule](/javascript/api/excel/excel.conditionalformatrule)|[formula](/javascript/api/excel/excel.conditionalformatrule#excel-excel-conditionalformatrule-formula-member)|The formula, if required, on which to evaluate the conditional format rule.| +||[formulaLocal](/javascript/api/excel/excel.conditionalformatrule#excel-excel-conditionalformatrule-formulalocal-member)|The formula, if required, on which to evaluate the conditional format rule in the user's language.| +||[formulaR1C1](/javascript/api/excel/excel.conditionalformatrule#excel-excel-conditionalformatrule-formular1c1-member)|The formula, if required, on which to evaluate the conditional format rule in R1C1-style notation.| +|[ConditionalIconCriterion](/javascript/api/excel/excel.conditionaliconcriterion)|[customIcon](/javascript/api/excel/excel.conditionaliconcriterion#excel-excel-conditionaliconcriterion-customicon-member)|The custom icon for the current criterion, if different from the default icon set, else `null` will be returned.| +||[formula](/javascript/api/excel/excel.conditionaliconcriterion#excel-excel-conditionaliconcriterion-formula-member)|A number or a formula depending on the type.| +||[operator](/javascript/api/excel/excel.conditionaliconcriterion#excel-excel-conditionaliconcriterion-operator-member)|`greaterThan` or `greaterThanOrEqual` for each of the rule types for the icon conditional format.| +||[type](/javascript/api/excel/excel.conditionaliconcriterion#excel-excel-conditionaliconcriterion-type-member)|What the icon conditional formula should be based on.| +|[ConditionalPresetCriteriaRule](/javascript/api/excel/excel.conditionalpresetcriteriarule)|[criterion](/javascript/api/excel/excel.conditionalpresetcriteriarule#excel-excel-conditionalpresetcriteriarule-criterion-member)|The criterion of the conditional format.| +|[ConditionalRangeBorder](/javascript/api/excel/excel.conditionalrangeborder)|[color](/javascript/api/excel/excel.conditionalrangeborder#excel-excel-conditionalrangeborder-color-member)|HTML color code representing the color of the border line, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").| +||[sideIndex](/javascript/api/excel/excel.conditionalrangeborder#excel-excel-conditionalrangeborder-sideindex-member)|Constant value that indicates the specific side of the border.| +||[style](/javascript/api/excel/excel.conditionalrangeborder#excel-excel-conditionalrangeborder-style-member)|One of the constants of line style specifying the line style for the border.| +|[ConditionalRangeBorderCollection](/javascript/api/excel/excel.conditionalrangebordercollection)|[bottom](/javascript/api/excel/excel.conditionalrangebordercollection#excel-excel-conditionalrangebordercollection-bottom-member)|Gets the bottom border.| +||[count](/javascript/api/excel/excel.conditionalrangebordercollection#excel-excel-conditionalrangebordercollection-count-member)|Number of border objects in the collection.| +||[getItem(index: Excel.ConditionalRangeBorderIndex)](/javascript/api/excel/excel.conditionalrangebordercollection#excel-excel-conditionalrangebordercollection-getitem-member(1))|Gets a border object using its name.| +||[getItemAt(index: number)](/javascript/api/excel/excel.conditionalrangebordercollection#excel-excel-conditionalrangebordercollection-getitemat-member(1))|Gets a border object using its index.| +||[items](/javascript/api/excel/excel.conditionalrangebordercollection#excel-excel-conditionalrangebordercollection-items-member)|Gets the loaded child items in this collection.| +||[left](/javascript/api/excel/excel.conditionalrangebordercollection#excel-excel-conditionalrangebordercollection-left-member)|Gets the left border.| +||[right](/javascript/api/excel/excel.conditionalrangebordercollection#excel-excel-conditionalrangebordercollection-right-member)|Gets the right border.| +||[top](/javascript/api/excel/excel.conditionalrangebordercollection#excel-excel-conditionalrangebordercollection-top-member)|Gets the top border.| +|[ConditionalRangeFill](/javascript/api/excel/excel.conditionalrangefill)|[clear()](/javascript/api/excel/excel.conditionalrangefill#excel-excel-conditionalrangefill-clear-member(1))|Resets the fill.| +||[color](/javascript/api/excel/excel.conditionalrangefill#excel-excel-conditionalrangefill-color-member)|HTML color code representing the color of the fill, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").| +|[ConditionalRangeFont](/javascript/api/excel/excel.conditionalrangefont)|[bold](/javascript/api/excel/excel.conditionalrangefont#excel-excel-conditionalrangefont-bold-member)|Specifies if the font is bold.| +||[clear()](/javascript/api/excel/excel.conditionalrangefont#excel-excel-conditionalrangefont-clear-member(1))|Resets the font formats.| +||[color](/javascript/api/excel/excel.conditionalrangefont#excel-excel-conditionalrangefont-color-member)|HTML color code representation of the text color (e.g., #FF0000 represents Red).| +||[italic](/javascript/api/excel/excel.conditionalrangefont#excel-excel-conditionalrangefont-italic-member)|Specifies if the font is italic.| +||[strikethrough](/javascript/api/excel/excel.conditionalrangefont#excel-excel-conditionalrangefont-strikethrough-member)|Specifies the strikethrough status of the font.| +||[underline](/javascript/api/excel/excel.conditionalrangefont#excel-excel-conditionalrangefont-underline-member)|The type of underline applied to the font.| +|[ConditionalRangeFormat](/javascript/api/excel/excel.conditionalrangeformat)|[borders](/javascript/api/excel/excel.conditionalrangeformat#excel-excel-conditionalrangeformat-borders-member)|Collection of border objects that apply to the overall conditional format range.| +||[fill](/javascript/api/excel/excel.conditionalrangeformat#excel-excel-conditionalrangeformat-fill-member)|Returns the fill object defined on the overall conditional format range.| +||[font](/javascript/api/excel/excel.conditionalrangeformat#excel-excel-conditionalrangeformat-font-member)|Returns the font object defined on the overall conditional format range.| +||[numberFormat](/javascript/api/excel/excel.conditionalrangeformat#excel-excel-conditionalrangeformat-numberformat-member)|Represents Excel's number format code for the given range.| +|[ConditionalTextComparisonRule](/javascript/api/excel/excel.conditionaltextcomparisonrule)|[operator](/javascript/api/excel/excel.conditionaltextcomparisonrule#excel-excel-conditionaltextcomparisonrule-operator-member)|The operator of the text conditional format.| +||[text](/javascript/api/excel/excel.conditionaltextcomparisonrule#excel-excel-conditionaltextcomparisonrule-text-member)|The text value of the conditional format.| +|[ConditionalTopBottomRule](/javascript/api/excel/excel.conditionaltopbottomrule)|[rank](/javascript/api/excel/excel.conditionaltopbottomrule#excel-excel-conditionaltopbottomrule-rank-member)|The rank between 1 and 1000 for numeric ranks or 1 and 100 for percent ranks.| +||[type](/javascript/api/excel/excel.conditionaltopbottomrule#excel-excel-conditionaltopbottomrule-type-member)|Format values based on the top or bottom rank.| +|[CustomConditionalFormat](/javascript/api/excel/excel.customconditionalformat)|[format](/javascript/api/excel/excel.customconditionalformat#excel-excel-customconditionalformat-format-member)|Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties.| +||[rule](/javascript/api/excel/excel.customconditionalformat#excel-excel-customconditionalformat-rule-member)|Specifies the `Rule` object on this conditional format.| +|[DataBarConditionalFormat](/javascript/api/excel/excel.databarconditionalformat)|[axisColor](/javascript/api/excel/excel.databarconditionalformat#excel-excel-databarconditionalformat-axiscolor-member)|HTML color code representing the color of the Axis line, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").| +||[axisFormat](/javascript/api/excel/excel.databarconditionalformat#excel-excel-databarconditionalformat-axisformat-member)|Representation of how the axis is determined for an Excel data bar.| +||[barDirection](/javascript/api/excel/excel.databarconditionalformat#excel-excel-databarconditionalformat-bardirection-member)|Specifies the direction that the data bar graphic should be based on.| +||[lowerBoundRule](/javascript/api/excel/excel.databarconditionalformat#excel-excel-databarconditionalformat-lowerboundrule-member)|The rule for what constitutes the lower bound (and how to calculate it, if applicable) for a data bar.| +||[negativeFormat](/javascript/api/excel/excel.databarconditionalformat#excel-excel-databarconditionalformat-negativeformat-member)|Representation of all values to the left of the axis in an Excel data bar.| +||[positiveFormat](/javascript/api/excel/excel.databarconditionalformat#excel-excel-databarconditionalformat-positiveformat-member)|Representation of all values to the right of the axis in an Excel data bar.| +||[showDataBarOnly](/javascript/api/excel/excel.databarconditionalformat#excel-excel-databarconditionalformat-showdatabaronly-member)|If `true`, hides the values from the cells where the data bar is applied.| +||[upperBoundRule](/javascript/api/excel/excel.databarconditionalformat#excel-excel-databarconditionalformat-upperboundrule-member)|The rule for what constitutes the upper bound (and how to calculate it, if applicable) for a data bar.| +|[IconSetConditionalFormat](/javascript/api/excel/excel.iconsetconditionalformat)|[criteria](/javascript/api/excel/excel.iconsetconditionalformat#excel-excel-iconsetconditionalformat-criteria-member)|An array of criteria and icon sets for the rules and potential custom icons for conditional icons.| +||[reverseIconOrder](/javascript/api/excel/excel.iconsetconditionalformat#excel-excel-iconsetconditionalformat-reverseiconorder-member)|If `true`, reverses the icon orders for the icon set.| +||[showIconOnly](/javascript/api/excel/excel.iconsetconditionalformat#excel-excel-iconsetconditionalformat-showicononly-member)|If `true`, hides the values and only shows icons.| +||[style](/javascript/api/excel/excel.iconsetconditionalformat#excel-excel-iconsetconditionalformat-style-member)|If set, displays the icon set option for the conditional format.| +|[PresetCriteriaConditionalFormat](/javascript/api/excel/excel.presetcriteriaconditionalformat)|[format](/javascript/api/excel/excel.presetcriteriaconditionalformat#excel-excel-presetcriteriaconditionalformat-format-member)|Returns a format object, encapsulating the conditional formats font, fill, borders, and other properties.| +||[rule](/javascript/api/excel/excel.presetcriteriaconditionalformat#excel-excel-presetcriteriaconditionalformat-rule-member)|The rule of the conditional format.| +|[Range](/javascript/api/excel/excel.range)|[calculate()](/javascript/api/excel/excel.range#excel-excel-range-calculate-member(1))|Calculates a range of cells on a worksheet.| +||[conditionalFormats](/javascript/api/excel/excel.range#excel-excel-range-conditionalformats-member)|The collection of `ConditionalFormats` that intersect the range.| +|[TextConditionalFormat](/javascript/api/excel/excel.textconditionalformat)|[format](/javascript/api/excel/excel.textconditionalformat#excel-excel-textconditionalformat-format-member)|Returns a format object, encapsulating the conditional format's font, fill, borders, and other properties.| +||[rule](/javascript/api/excel/excel.textconditionalformat#excel-excel-textconditionalformat-rule-member)|The rule of the conditional format.| +|[TopBottomConditionalFormat](/javascript/api/excel/excel.topbottomconditionalformat)|[format](/javascript/api/excel/excel.topbottomconditionalformat#excel-excel-topbottomconditionalformat-format-member)|Returns a format object, encapsulating the conditional format's font, fill, borders, and other properties.| +||[rule](/javascript/api/excel/excel.topbottomconditionalformat#excel-excel-topbottomconditionalformat-rule-member)|The criteria of the top/bottom conditional format.| +|[Worksheet](/javascript/api/excel/excel.worksheet)|[calculate(markAllDirty: boolean)](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-calculate-member(1))|Calculates all cells on a worksheet.| diff --git a/docs/includes/excel-1_7.md b/docs/includes/excel-1_7.md index 7735f9eebb..1bae916d0c 100644 --- a/docs/includes/excel-1_7.md +++ b/docs/includes/excel-1_7.md @@ -1,237 +1,237 @@ | Class | Fields | Description | |:---|:---|:---| -|[Chart](/.chart)|[chartType](/.chart#excel-javascript/api/excel/-chart-charttype-member)|Specifies the type of the chart.| -||[id](/.chart#excel-javascript/api/excel/-chart-id-member)|The unique ID of chart.| -||[showAllFieldButtons](/.chart#excel-javascript/api/excel/-chart-showallfieldbuttons-member)|Specifies whether to display all field buttons on a PivotChart.| -|[ChartAreaFormat](/.chartareaformat)|[border](/.chartareaformat#excel-javascript/api/excel/-chartareaformat-border-member)|Represents the border format of chart area, which includes color, linestyle, and weight.| -|[ChartAxes](/.chartaxes)|[getItem(type: Excel.ChartAxisType, group?: Excel.ChartAxisGroup)](/.chartaxes#excel-javascript/api/excel/-chartaxes-getitem-member(1))|Returns the specific axis identified by type and group.| -|[ChartAxis](/.chartaxis)|[axisGroup](/.chartaxis#excel-javascript/api/excel/-chartaxis-axisgroup-member)|Specifies the group for the specified axis.| -||[baseTimeUnit](/.chartaxis#excel-javascript/api/excel/-chartaxis-basetimeunit-member)|Specifies the base unit for the specified category axis.| -||[categoryType](/.chartaxis#excel-javascript/api/excel/-chartaxis-categorytype-member)|Specifies the category axis type.| -||[customDisplayUnit](/.chartaxis#excel-javascript/api/excel/-chartaxis-customdisplayunit-member)|Specifies the custom axis display unit value.| -||[displayUnit](/.chartaxis#excel-javascript/api/excel/-chartaxis-displayunit-member)|Represents the axis display unit.| -||[height](/.chartaxis#excel-javascript/api/excel/-chartaxis-height-member)|Specifies the height, in points, of the chart axis.| -||[left](/.chartaxis#excel-javascript/api/excel/-chartaxis-left-member)|Specifies the distance, in points, from the left edge of the axis to the left of chart area.| -||[logBase](/.chartaxis#excel-javascript/api/excel/-chartaxis-logbase-member)|Specifies the base of the logarithm when using logarithmic scales.| -||[majorTickMark](/.chartaxis#excel-javascript/api/excel/-chartaxis-majortickmark-member)|Specifies the type of major tick mark for the specified axis.| -||[majorTimeUnitScale](/.chartaxis#excel-javascript/api/excel/-chartaxis-majortimeunitscale-member)|Specifies the major unit scale value for the category axis when the `categoryType` property is set to `dateAxis`.| -||[minorTickMark](/.chartaxis#excel-javascript/api/excel/-chartaxis-minortickmark-member)|Specifies the type of minor tick mark for the specified axis.| -||[minorTimeUnitScale](/.chartaxis#excel-javascript/api/excel/-chartaxis-minortimeunitscale-member)|Specifies the minor unit scale value for the category axis when the `categoryType` property is set to `dateAxis`.| -||[reversePlotOrder](/.chartaxis#excel-javascript/api/excel/-chartaxis-reverseplotorder-member)|Specifies if Excel plots data points from last to first.| -||[scaleType](/.chartaxis#excel-javascript/api/excel/-chartaxis-scaletype-member)|Specifies the value axis scale type.| -||[setCategoryNames(sourceData: Range)](/.chartaxis#excel-javascript/api/excel/-chartaxis-setcategorynames-member(1))|Sets all the category names for the specified axis.| -||[setCustomDisplayUnit(value: number)](/.chartaxis#excel-javascript/api/excel/-chartaxis-setcustomdisplayunit-member(1))|Sets the axis display unit to a custom value.| -||[showDisplayUnitLabel](/.chartaxis#excel-javascript/api/excel/-chartaxis-showdisplayunitlabel-member)|Specifies if the axis display unit label is visible.| -||[tickLabelPosition](/.chartaxis#excel-javascript/api/excel/-chartaxis-ticklabelposition-member)|Specifies the position of tick-mark labels on the specified axis.| -||[tickLabelSpacing](/.chartaxis#excel-javascript/api/excel/-chartaxis-ticklabelspacing-member)|Specifies the number of categories or series between tick-mark labels.| -||[tickMarkSpacing](/.chartaxis#excel-javascript/api/excel/-chartaxis-tickmarkspacing-member)|Specifies the number of categories or series between tick marks.| -||[top](/.chartaxis#excel-javascript/api/excel/-chartaxis-top-member)|Specifies the distance, in points, from the top edge of the axis to the top of chart area.| -||[type](/.chartaxis#excel-javascript/api/excel/-chartaxis-type-member)|Specifies the axis type.| -||[visible](/.chartaxis#excel-javascript/api/excel/-chartaxis-visible-member)|Specifies if the axis is visible.| -||[width](/.chartaxis#excel-javascript/api/excel/-chartaxis-width-member)|Specifies the width, in points, of the chart axis.| -|[ChartBorder](/.chartborder)|[color](/.chartborder#excel-javascript/api/excel/-chartborder-color-member)|HTML color code representing the color of borders in the chart.| -||[lineStyle](/.chartborder#excel-javascript/api/excel/-chartborder-linestyle-member)|Represents the line style of the border.| -||[weight](/.chartborder#excel-javascript/api/excel/-chartborder-weight-member)|Represents weight of the border, in points.| -|[ChartDataLabel](/.chartdatalabel)|[position](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-position-member)|Value that represents the position of the data label.| -||[separator](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-separator-member)|String representing the separator used for the data label on a chart.| -||[showBubbleSize](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-showbubblesize-member)|Specifies if the data label bubble size is visible.| -||[showCategoryName](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-showcategoryname-member)|Specifies if the data label category name is visible.| -||[showLegendKey](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-showlegendkey-member)|Specifies if the data label legend key is visible.| -||[showPercentage](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-showpercentage-member)|Specifies if the data label percentage is visible.| -||[showSeriesName](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-showseriesname-member)|Specifies if the data label series name is visible.| -||[showValue](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-showvalue-member)|Specifies if the data label value is visible.| -|[ChartFormatString](/.chartformatstring)|[font](/.chartformatstring#excel-javascript/api/excel/-chartformatstring-font-member)|Represents the font attributes, such as font name, font size, and color of a chart characters object.| -|[ChartLegend](/.chartlegend)|[height](/.chartlegend#excel-javascript/api/excel/-chartlegend-height-member)|Specifies the height, in points, of the legend on the chart.| -||[left](/.chartlegend#excel-javascript/api/excel/-chartlegend-left-member)|Specifies the left value, in points, of the legend on the chart.| -||[legendEntries](/.chartlegend#excel-javascript/api/excel/-chartlegend-legendentries-member)|Represents a collection of legendEntries in the legend.| -||[showShadow](/.chartlegend#excel-javascript/api/excel/-chartlegend-showshadow-member)|Specifies if the legend has a shadow on the chart.| -||[top](/.chartlegend#excel-javascript/api/excel/-chartlegend-top-member)|Specifies the top of a chart legend.| -||[width](/.chartlegend#excel-javascript/api/excel/-chartlegend-width-member)|Specifies the width, in points, of the legend on the chart.| -|[ChartLegendEntry](/.chartlegendentry)|[visible](/.chartlegendentry#excel-javascript/api/excel/-chartlegendentry-visible-member)|Represents the visibility of a chart legend entry.| -|[ChartLegendEntryCollection](/.chartlegendentrycollection)|[getCount()](/.chartlegendentrycollection#excel-javascript/api/excel/-chartlegendentrycollection-getcount-member(1))|Returns the number of legend entries in the collection.| -||[getItemAt(index: number)](/.chartlegendentrycollection#excel-javascript/api/excel/-chartlegendentrycollection-getitemat-member(1))|Returns a legend entry at the given index.| -||[items](/.chartlegendentrycollection#excel-javascript/api/excel/-chartlegendentrycollection-items-member)|Gets the loaded child items in this collection.| -|[ChartLineFormat](/.chartlineformat)|[lineStyle](/.chartlineformat#excel-javascript/api/excel/-chartlineformat-linestyle-member)|Represents the line style.| -||[weight](/.chartlineformat#excel-javascript/api/excel/-chartlineformat-weight-member)|Represents weight of the line, in points.| -|[ChartPoint](/.chartpoint)|[dataLabel](/.chartpoint#excel-javascript/api/excel/-chartpoint-datalabel-member)|Returns the data label of a chart point.| -||[hasDataLabel](/.chartpoint#excel-javascript/api/excel/-chartpoint-hasdatalabel-member)|Represents whether a data point has a data label.| -||[markerBackgroundColor](/.chartpoint#excel-javascript/api/excel/-chartpoint-markerbackgroundcolor-member)|HTML color code representation of the marker background color of a data point (e.g., #FF0000 represents Red).| -||[markerForegroundColor](/.chartpoint#excel-javascript/api/excel/-chartpoint-markerforegroundcolor-member)|HTML color code representation of the marker foreground color of a data point (e.g., #FF0000 represents Red).| -||[markerSize](/.chartpoint#excel-javascript/api/excel/-chartpoint-markersize-member)|Represents marker size of a data point.| -||[markerStyle](/.chartpoint#excel-javascript/api/excel/-chartpoint-markerstyle-member)|Represents marker style of a chart data point.| -|[ChartPointFormat](/.chartpointformat)|[border](/.chartpointformat#excel-javascript/api/excel/-chartpointformat-border-member)|Represents the border format of a chart data point, which includes color, style, and weight information.| -|[ChartSeries](/.chartseries)|[chartType](/.chartseries#excel-javascript/api/excel/-chartseries-charttype-member)|Represents the chart type of a series.| -||[delete()](/.chartseries#excel-javascript/api/excel/-chartseries-delete-member(1))|Deletes the chart series.| -||[doughnutHoleSize](/.chartseries#excel-javascript/api/excel/-chartseries-doughnutholesize-member)|Represents the doughnut hole size of a chart series.| -||[filtered](/.chartseries#excel-javascript/api/excel/-chartseries-filtered-member)|Specifies if the series is filtered.| -||[gapWidth](/.chartseries#excel-javascript/api/excel/-chartseries-gapwidth-member)|Represents the gap width of a chart series.| -||[hasDataLabels](/.chartseries#excel-javascript/api/excel/-chartseries-hasdatalabels-member)|Specifies if the series has data labels.| -||[markerBackgroundColor](/.chartseries#excel-javascript/api/excel/-chartseries-markerbackgroundcolor-member)|Specifies the marker background color of a chart series.| -||[markerForegroundColor](/.chartseries#excel-javascript/api/excel/-chartseries-markerforegroundcolor-member)|Specifies the marker foreground color of a chart series.| -||[markerSize](/.chartseries#excel-javascript/api/excel/-chartseries-markersize-member)|Specifies the marker size of a chart series.| -||[markerStyle](/.chartseries#excel-javascript/api/excel/-chartseries-markerstyle-member)|Specifies the marker style of a chart series.| -||[plotOrder](/.chartseries#excel-javascript/api/excel/-chartseries-plotorder-member)|Specifies the plot order of a chart series within the chart group.| -||[setBubbleSizes(sourceData: Range)](/.chartseries#excel-javascript/api/excel/-chartseries-setbubblesizes-member(1))|Sets the bubble sizes for a chart series.| -||[setValues(sourceData: Range)](/.chartseries#excel-javascript/api/excel/-chartseries-setvalues-member(1))|Sets the values for a chart series.| -||[setXAxisValues(sourceData: Range)](/.chartseries#excel-javascript/api/excel/-chartseries-setxaxisvalues-member(1))|Sets the values of the x-axis for a chart series.| -||[showShadow](/.chartseries#excel-javascript/api/excel/-chartseries-showshadow-member)|Specifies if the series has a shadow.| -||[smooth](/.chartseries#excel-javascript/api/excel/-chartseries-smooth-member)|Specifies if the series is smooth.| -||[trendlines](/.chartseries#excel-javascript/api/excel/-chartseries-trendlines-member)|The collection of trendlines in the series.| -|[ChartSeriesCollection](/.chartseriescollection)|[add(name?: string, index?: number)](/.chartseriescollection#excel-javascript/api/excel/-chartseriescollection-add-member(1))|Add a new series to the collection.| -|[ChartTitle](/.charttitle)|[getSubstring(start: number, length: number)](/.charttitle#excel-javascript/api/excel/-charttitle-getsubstring-member(1))|Get the substring of a chart title.| -||[height](/.charttitle#excel-javascript/api/excel/-charttitle-height-member)|Returns the height, in points, of the chart title.| -||[horizontalAlignment](/.charttitle#excel-javascript/api/excel/-charttitle-horizontalalignment-member)|Specifies the horizontal alignment for chart title.| -||[left](/.charttitle#excel-javascript/api/excel/-charttitle-left-member)|Specifies the distance, in points, from the left edge of chart title to the left edge of chart area.| -||[position](/.charttitle#excel-javascript/api/excel/-charttitle-position-member)|Represents the position of chart title.| -||[setFormula(formula: string)](/.charttitle#excel-javascript/api/excel/-charttitle-setformula-member(1))|Sets a string value that represents the formula of chart title using A1-style notation.| -||[showShadow](/.charttitle#excel-javascript/api/excel/-charttitle-showshadow-member)|Represents a boolean value that determines if the chart title has a shadow.| -||[textOrientation](/.charttitle#excel-javascript/api/excel/-charttitle-textorientation-member)|Specifies the angle to which the text is oriented for the chart title.| -||[top](/.charttitle#excel-javascript/api/excel/-charttitle-top-member)|Specifies the distance, in points, from the top edge of chart title to the top of chart area.| -||[verticalAlignment](/.charttitle#excel-javascript/api/excel/-charttitle-verticalalignment-member)|Specifies the vertical alignment of chart title.| -||[width](/.charttitle#excel-javascript/api/excel/-charttitle-width-member)|Specifies the width, in points, of the chart title.| -|[ChartTitleFormat](/.charttitleformat)|[border](/.charttitleformat#excel-javascript/api/excel/-charttitleformat-border-member)|Represents the border format of chart title, which includes color, linestyle, and weight.| -|[ChartTrendline](/.charttrendline)|[delete()](/.charttrendline#excel-javascript/api/excel/-charttrendline-delete-member(1))|Delete the trendline object.| -||[format](/.charttrendline#excel-javascript/api/excel/-charttrendline-format-member)|Represents the formatting of a chart trendline.| -||[intercept](/.charttrendline#excel-javascript/api/excel/-charttrendline-intercept-member)|Represents the intercept value of the trendline.| -||[movingAveragePeriod](/.charttrendline#excel-javascript/api/excel/-charttrendline-movingaverageperiod-member)|Represents the period of a chart trendline.| -||[name](/.charttrendline#excel-javascript/api/excel/-charttrendline-name-member)|Represents the name of the trendline.| -||[polynomialOrder](/.charttrendline#excel-javascript/api/excel/-charttrendline-polynomialorder-member)|Represents the order of a chart trendline.| -||[type](/.charttrendline#excel-javascript/api/excel/-charttrendline-type-member)|Represents the type of a chart trendline.| -|[ChartTrendlineCollection](/.charttrendlinecollection)|[add(type?: Excel.ChartTrendlineType)](/.charttrendlinecollection#excel-javascript/api/excel/-charttrendlinecollection-add-member(1))|Adds a new trendline to trendline collection.| -||[getCount()](/.charttrendlinecollection#excel-javascript/api/excel/-charttrendlinecollection-getcount-member(1))|Returns the number of trendlines in the collection.| -||[getItem(index: number)](/.charttrendlinecollection#excel-javascript/api/excel/-charttrendlinecollection-getitem-member(1))|Gets a trendline object by index, which is the insertion order in the items array.| -||[items](/.charttrendlinecollection#excel-javascript/api/excel/-charttrendlinecollection-items-member)|Gets the loaded child items in this collection.| -|[ChartTrendlineFormat](/.charttrendlineformat)|[line](/.charttrendlineformat#excel-javascript/api/excel/-charttrendlineformat-line-member)|Represents chart line formatting.| -|[CustomProperty](/.customproperty)|[delete()](/.customproperty#excel-javascript/api/excel/-customproperty-delete-member(1))|Deletes the custom property.| -||[key](/.customproperty#excel-javascript/api/excel/-customproperty-key-member)|The key of the custom property.| -||[type](/.customproperty#excel-javascript/api/excel/-customproperty-type-member)|The type of the value used for the custom property.| -||[value](/.customproperty#excel-javascript/api/excel/-customproperty-value-member)|The value of the custom property.| -|[CustomPropertyCollection](/.custompropertycollection)|[add(key: string, value: any)](/.custompropertycollection#excel-javascript/api/excel/-custompropertycollection-add-member(1))|Creates a new or sets an existing custom property.| -||[deleteAll()](/.custompropertycollection#excel-javascript/api/excel/-custompropertycollection-deleteall-member(1))|Deletes all custom properties in this collection.| -||[getCount()](/.custompropertycollection#excel-javascript/api/excel/-custompropertycollection-getcount-member(1))|Gets the count of custom properties.| -||[getItem(key: string)](/.custompropertycollection#excel-javascript/api/excel/-custompropertycollection-getitem-member(1))|Gets a custom property object by its key, which is case-insensitive.| -||[getItemOrNullObject(key: string)](/.custompropertycollection#excel-javascript/api/excel/-custompropertycollection-getitemornullobject-member(1))|Gets a custom property object by its key, which is case-insensitive.| -||[items](/.custompropertycollection#excel-javascript/api/excel/-custompropertycollection-items-member)|Gets the loaded child items in this collection.| -|[DataConnectionCollection](/.dataconnectioncollection)|[refreshAll()](/.dataconnectioncollection#excel-javascript/api/excel/-dataconnectioncollection-refreshall-member(1))|Refreshes data connections in the collection, such as from a PivotTable to a Power BI dataset, or a Data Model to a table or range in the same workbook.| -|[DocumentProperties](/.documentproperties)|[author](/.documentproperties#excel-javascript/api/excel/-documentproperties-author-member)|The author of the workbook.| -||[category](/.documentproperties#excel-javascript/api/excel/-documentproperties-category-member)|The category of the workbook.| -||[comments](/.documentproperties#excel-javascript/api/excel/-documentproperties-comments-member)|The Comments field in the metadata of the workbook.| -||[company](/.documentproperties#excel-javascript/api/excel/-documentproperties-company-member)|The company of the workbook.| -||[creationDate](/.documentproperties#excel-javascript/api/excel/-documentproperties-creationdate-member)|Gets the creation date of the workbook.| -||[custom](/.documentproperties#excel-javascript/api/excel/-documentproperties-custom-member)|Gets the collection of custom properties of the workbook.| -||[keywords](/.documentproperties#excel-javascript/api/excel/-documentproperties-keywords-member)|The keywords of the workbook.| -||[lastAuthor](/.documentproperties#excel-javascript/api/excel/-documentproperties-lastauthor-member)|Gets the last author of the workbook.| -||[manager](/.documentproperties#excel-javascript/api/excel/-documentproperties-manager-member)|The manager of the workbook.| -||[revisionNumber](/.documentproperties#excel-javascript/api/excel/-documentproperties-revisionnumber-member)|Gets the revision number of the workbook.| -||[subject](/.documentproperties#excel-javascript/api/excel/-documentproperties-subject-member)|The subject of the workbook.| -||[title](/.documentproperties#excel-javascript/api/excel/-documentproperties-title-member)|The title of the workbook.| -|[NamedItem](/.nameditem)|[arrayValues](/.nameditem#excel-javascript/api/excel/-nameditem-arrayvalues-member)|Returns an object containing values and types of the named item.| -||[formula](/.nameditem#excel-javascript/api/excel/-nameditem-formula-member)|The formula of the named item.| -|[NamedItemArrayValues](/.nameditemarrayvalues)|[types](/.nameditemarrayvalues#excel-javascript/api/excel/-nameditemarrayvalues-types-member)|Represents the types for each item in the named item array| -||[values](/.nameditemarrayvalues#excel-javascript/api/excel/-nameditemarrayvalues-values-member)|Represents the values of each item in the named item array.| -|[Range](/.range)|[getAbsoluteResizedRange(numRows: number, numColumns: number)](/.range#excel-javascript/api/excel/-range-getabsoluteresizedrange-member(1))|Gets a `Range` object with the same top-left cell as the current `Range` object, but with the specified numbers of rows and columns.| -||[getImage()](/.range#excel-javascript/api/excel/-range-getimage-member(1))|Renders the range as a Base64-encoded PNG image.| -||[getSurroundingRegion()](/.range#excel-javascript/api/excel/-range-getsurroundingregion-member(1))|Returns a `Range` object that represents the surrounding region for the top-left cell in this range.| -||[hyperlink](/.range#excel-javascript/api/excel/-range-hyperlink-member)|Represents the hyperlink for the current range.| -||[isEntireColumn](/.range#excel-javascript/api/excel/-range-isentirecolumn-member)|Represents if the current range is an entire column.| -||[isEntireRow](/.range#excel-javascript/api/excel/-range-isentirerow-member)|Represents if the current range is an entire row.| -||[numberFormatLocal](/.range#excel-javascript/api/excel/-range-numberformatlocal-member)|Represents Excel's number format code for the given range, based on the language settings of the user.| -||[showCard()](/.range#excel-javascript/api/excel/-range-showcard-member(1))|Displays the card for an active cell if it has rich value content.| -||[style](/.range#excel-javascript/api/excel/-range-style-member)|Represents the style of the current range.| -|[RangeFormat](/.rangeformat)|[textOrientation](/.rangeformat#excel-javascript/api/excel/-rangeformat-textorientation-member)|The text orientation of all the cells within the range.| -||[useStandardHeight](/.rangeformat#excel-javascript/api/excel/-rangeformat-usestandardheight-member)|Determines if the row height of the `Range` object equals the standard height of the sheet.| -||[useStandardWidth](/.rangeformat#excel-javascript/api/excel/-rangeformat-usestandardwidth-member)|Specifies if the column width of the `Range` object equals the standard width of the sheet.| -|[RangeHyperlink](/.rangehyperlink)|[address](/.rangehyperlink#excel-javascript/api/excel/-rangehyperlink-address-member)|Represents the URL target for the hyperlink.| -||[documentReference](/.rangehyperlink#excel-javascript/api/excel/-rangehyperlink-documentreference-member)|Represents the document reference target for the hyperlink.| -||[screenTip](/.rangehyperlink#excel-javascript/api/excel/-rangehyperlink-screentip-member)|Represents the string displayed when hovering over the hyperlink.| -||[textToDisplay](/.rangehyperlink#excel-javascript/api/excel/-rangehyperlink-texttodisplay-member)|Represents the string that is displayed in the top left most cell in the range.| -|[Style](/.style)|[borders](/.style#excel-javascript/api/excel/-style-borders-member)|A collection of four border objects that represent the style of the four borders.| -||[builtIn](/.style#excel-javascript/api/excel/-style-builtin-member)|Specifies if the style is a built-in style.| -||[delete()](/.style#excel-javascript/api/excel/-style-delete-member(1))|Deletes this style.| -||[fill](/.style#excel-javascript/api/excel/-style-fill-member)|The fill of the style.| -||[font](/.style#excel-javascript/api/excel/-style-font-member)|A `Font` object that represents the font of the style.| -||[formulaHidden](/.style#excel-javascript/api/excel/-style-formulahidden-member)|Specifies if the formula will be hidden when the worksheet is protected.| -||[horizontalAlignment](/.style#excel-javascript/api/excel/-style-horizontalalignment-member)|Represents the horizontal alignment for the style.| -||[includeAlignment](/.style#excel-javascript/api/excel/-style-includealignment-member)|Specifies if the style includes the auto indent, horizontal alignment, vertical alignment, wrap text, indent level, and text orientation properties.| -||[includeBorder](/.style#excel-javascript/api/excel/-style-includeborder-member)|Specifies if the style includes the color, color index, line style, and weight border properties.| -||[includeFont](/.style#excel-javascript/api/excel/-style-includefont-member)|Specifies if the style includes the background, bold, color, color index, font style, italic, name, size, strikethrough, subscript, superscript, and underline font properties.| -||[includeNumber](/.style#excel-javascript/api/excel/-style-includenumber-member)|Specifies if the style includes the number format property.| -||[includePatterns](/.style#excel-javascript/api/excel/-style-includepatterns-member)|Specifies if the style includes the color, color index, invert if negative, pattern, pattern color, and pattern color index interior properties.| -||[includeProtection](/.style#excel-javascript/api/excel/-style-includeprotection-member)|Specifies if the style includes the formula hidden and locked protection properties.| -||[indentLevel](/.style#excel-javascript/api/excel/-style-indentlevel-member)|An integer from 0 to 250 that indicates the indent level for the style.| -||[locked](/.style#excel-javascript/api/excel/-style-locked-member)|Specifies if the object is locked when the worksheet is protected.| -||[name](/.style#excel-javascript/api/excel/-style-name-member)|The name of the style.| -||[numberFormat](/.style#excel-javascript/api/excel/-style-numberformat-member)|The format code of the number format for the style.| -||[numberFormatLocal](/.style#excel-javascript/api/excel/-style-numberformatlocal-member)|The localized format code of the number format for the style.| -||[readingOrder](/.style#excel-javascript/api/excel/-style-readingorder-member)|The reading order for the style.| -||[shrinkToFit](/.style#excel-javascript/api/excel/-style-shrinktofit-member)|Specifies if text automatically shrinks to fit in the available column width.| -||[verticalAlignment](/.style#excel-javascript/api/excel/-style-verticalalignment-member)|Specifies the vertical alignment for the style.| -||[wrapText](/.style#excel-javascript/api/excel/-style-wraptext-member)|Specifies if Excel wraps the text in the object.| -|[StyleCollection](/.stylecollection)|[add(name: string)](/.stylecollection#excel-javascript/api/excel/-stylecollection-add-member(1))|Adds a new style to the collection.| -||[getItem(name: string)](/.stylecollection#excel-javascript/api/excel/-stylecollection-getitem-member(1))|Gets a `Style` by name.| -||[items](/.stylecollection#excel-javascript/api/excel/-stylecollection-items-member)|Gets the loaded child items in this collection.| -|[Table](/.table)|[onChanged](/.table#excel-javascript/api/excel/-table-onchanged-member)|Occurs when data in cells changes on a specific table.| -||[onSelectionChanged](/.table#excel-javascript/api/excel/-table-onselectionchanged-member)|Occurs when the selection changes on a specific table.| -|[TableChangedEventArgs](/.tablechangedeventargs)|[address](/.tablechangedeventargs#excel-javascript/api/excel/-tablechangedeventargs-address-member)|Gets the address that represents the changed area of a table on a specific worksheet.| -||[changeType](/.tablechangedeventargs#excel-javascript/api/excel/-tablechangedeventargs-changetype-member)|Gets the change type that represents how the changed event is triggered.| -||[source](/.tablechangedeventargs#excel-javascript/api/excel/-tablechangedeventargs-source-member)|Gets the source of the event.| -||[tableId](/.tablechangedeventargs#excel-javascript/api/excel/-tablechangedeventargs-tableid-member)|Gets the ID of the table in which the data changed.| -||[type](/.tablechangedeventargs#excel-javascript/api/excel/-tablechangedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/.tablechangedeventargs#excel-javascript/api/excel/-tablechangedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the data changed.| -|[TableCollection](/.tablecollection)|[onChanged](/.tablecollection#excel-javascript/api/excel/-tablecollection-onchanged-member)|Occurs when data changes on any table in a workbook, or a worksheet.| -|[TableSelectionChangedEventArgs](/.tableselectionchangedeventargs)|[address](/.tableselectionchangedeventargs#excel-javascript/api/excel/-tableselectionchangedeventargs-address-member)|Gets the range address that represents the selected area of the table on a specific worksheet.| -||[isInsideTable](/.tableselectionchangedeventargs#excel-javascript/api/excel/-tableselectionchangedeventargs-isinsidetable-member)|Specifies if the selection is inside a table.| -||[tableId](/.tableselectionchangedeventargs#excel-javascript/api/excel/-tableselectionchangedeventargs-tableid-member)|Gets the ID of the table in which the selection changed.| -||[type](/.tableselectionchangedeventargs#excel-javascript/api/excel/-tableselectionchangedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/.tableselectionchangedeventargs#excel-javascript/api/excel/-tableselectionchangedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the selection changed.| -|[Workbook](/.workbook)|[dataConnections](/.workbook#excel-javascript/api/excel/-workbook-dataconnections-member)|Represents all data connections in the workbook.| -||[getActiveCell()](/.workbook#excel-javascript/api/excel/-workbook-getactivecell-member(1))|Gets the currently active cell from the workbook.| -||[name](/.workbook#excel-javascript/api/excel/-workbook-name-member)|Gets the workbook name.| -||[properties](/.workbook#excel-javascript/api/excel/-workbook-properties-member)|Gets the workbook properties.| -||[protection](/.workbook#excel-javascript/api/excel/-workbook-protection-member)|Returns the protection object for a workbook.| -||[styles](/.workbook#excel-javascript/api/excel/-workbook-styles-member)|Represents a collection of styles associated with the workbook.| -|[WorkbookProtection](/.workbookprotection)|[protect(password?: string)](/.workbookprotection#excel-javascript/api/excel/-workbookprotection-protect-member(1))|Protects the workbook.| -||[protected](/.workbookprotection#excel-javascript/api/excel/-workbookprotection-protected-member)|Specifies if the workbook is protected.| -||[unprotect(password?: string)](/.workbookprotection#excel-javascript/api/excel/-workbookprotection-unprotect-member(1))|Unprotects the workbook.| -|[Worksheet](/.worksheet)|[copy(positionType?: Excel.WorksheetPositionType, relativeTo?: Excel.Worksheet)](/.worksheet#excel-javascript/api/excel/-worksheet-copy-member(1))|Copies a worksheet and places it at the specified position.| -||[freezePanes](/.worksheet#excel-javascript/api/excel/-worksheet-freezepanes-member)|Gets an object that can be used to manipulate frozen panes on the worksheet.| -||[getRangeByIndexes(startRow: number, startColumn: number, rowCount: number, columnCount: number)](/.worksheet#excel-javascript/api/excel/-worksheet-getrangebyindexes-member(1))|Gets the `Range` object beginning at a particular row index and column index, and spanning a certain number of rows and columns.| -||[onActivated](/.worksheet#excel-javascript/api/excel/-worksheet-onactivated-member)|Occurs when the worksheet is activated.| -||[onChanged](/.worksheet#excel-javascript/api/excel/-worksheet-onchanged-member)|Occurs when data changes in a specific worksheet.| -||[onDeactivated](/.worksheet#excel-javascript/api/excel/-worksheet-ondeactivated-member)|Occurs when the worksheet is deactivated.| -||[onSelectionChanged](/.worksheet#excel-javascript/api/excel/-worksheet-onselectionchanged-member)|Occurs when the selection changes on a specific worksheet.| -||[standardHeight](/.worksheet#excel-javascript/api/excel/-worksheet-standardheight-member)|Returns the standard (default) height of all the rows in the worksheet, in points.| -||[standardWidth](/.worksheet#excel-javascript/api/excel/-worksheet-standardwidth-member)|Specifies the standard (default) width of all the columns in the worksheet.| -||[tabColor](/.worksheet#excel-javascript/api/excel/-worksheet-tabcolor-member)|The tab color of the worksheet.| -|[WorksheetActivatedEventArgs](/.worksheetactivatedeventargs)|[type](/.worksheetactivatedeventargs#excel-javascript/api/excel/-worksheetactivatedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/.worksheetactivatedeventargs#excel-javascript/api/excel/-worksheetactivatedeventargs-worksheetid-member)|Gets the ID of the worksheet that is activated.| -|[WorksheetAddedEventArgs](/.worksheetaddedeventargs)|[source](/.worksheetaddedeventargs#excel-javascript/api/excel/-worksheetaddedeventargs-source-member)|Gets the source of the event.| -||[type](/.worksheetaddedeventargs#excel-javascript/api/excel/-worksheetaddedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/.worksheetaddedeventargs#excel-javascript/api/excel/-worksheetaddedeventargs-worksheetid-member)|Gets the ID of the worksheet that is added to the workbook.| -|[WorksheetChangedEventArgs](/.worksheetchangedeventargs)|[address](/.worksheetchangedeventargs#excel-javascript/api/excel/-worksheetchangedeventargs-address-member)|Gets the range address that represents the changed area of a specific worksheet.| -||[changeType](/.worksheetchangedeventargs#excel-javascript/api/excel/-worksheetchangedeventargs-changetype-member)|Gets the change type that represents how the changed event is triggered.| -||[source](/.worksheetchangedeventargs#excel-javascript/api/excel/-worksheetchangedeventargs-source-member)|Gets the source of the event.| -||[type](/.worksheetchangedeventargs#excel-javascript/api/excel/-worksheetchangedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/.worksheetchangedeventargs#excel-javascript/api/excel/-worksheetchangedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the data changed.| -|[WorksheetCollection](/.worksheetcollection)|[onActivated](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-onactivated-member)|Occurs when any worksheet in the workbook is activated.| -||[onAdded](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-onadded-member)|Occurs when a new worksheet is added to the workbook.| -||[onDeactivated](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-ondeactivated-member)|Occurs when any worksheet in the workbook is deactivated.| -||[onDeleted](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-ondeleted-member)|Occurs when a worksheet is deleted from the workbook.| -|[WorksheetDeactivatedEventArgs](/.worksheetdeactivatedeventargs)|[type](/.worksheetdeactivatedeventargs#excel-javascript/api/excel/-worksheetdeactivatedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/.worksheetdeactivatedeventargs#excel-javascript/api/excel/-worksheetdeactivatedeventargs-worksheetid-member)|Gets the ID of the worksheet that is deactivated.| -|[WorksheetDeletedEventArgs](/.worksheetdeletedeventargs)|[source](/.worksheetdeletedeventargs#excel-javascript/api/excel/-worksheetdeletedeventargs-source-member)|Gets the source of the event.| -||[type](/.worksheetdeletedeventargs#excel-javascript/api/excel/-worksheetdeletedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/.worksheetdeletedeventargs#excel-javascript/api/excel/-worksheetdeletedeventargs-worksheetid-member)|Gets the ID of the worksheet that is deleted from the workbook.| -|[WorksheetFreezePanes](/.worksheetfreezepanes)|[freezeAt(frozenRange: Range \| string)](/.worksheetfreezepanes#excel-javascript/api/excel/-worksheetfreezepanes-freezeat-member(1))|Sets the frozen cells in the active worksheet view.| -||[freezeColumns(count?: number)](/.worksheetfreezepanes#excel-javascript/api/excel/-worksheetfreezepanes-freezecolumns-member(1))|Freeze the first column or columns of the worksheet in place.| -||[freezeRows(count?: number)](/.worksheetfreezepanes#excel-javascript/api/excel/-worksheetfreezepanes-freezerows-member(1))|Freeze the top row or rows of the worksheet in place.| -||[getLocation()](/.worksheetfreezepanes#excel-javascript/api/excel/-worksheetfreezepanes-getlocation-member(1))|Gets a range that describes the frozen cells in the active worksheet view.| -||[getLocationOrNullObject()](/.worksheetfreezepanes#excel-javascript/api/excel/-worksheetfreezepanes-getlocationornullobject-member(1))|Gets a range that describes the frozen cells in the active worksheet view.| -||[unfreeze()](/.worksheetfreezepanes#excel-javascript/api/excel/-worksheetfreezepanes-unfreeze-member(1))|Removes all frozen panes in the worksheet.| -|[WorksheetProtection](/.worksheetprotection)|[unprotect(password?: string)](/.worksheetprotection#excel-javascript/api/excel/-worksheetprotection-unprotect-member(1))|Unprotects a worksheet.| -|[WorksheetProtectionOptions](/.worksheetprotectionoptions)|[allowEditObjects](/.worksheetprotectionoptions#excel-javascript/api/excel/-worksheetprotectionoptions-alloweditobjects-member)|Represents the worksheet protection option allowing editing of objects.| -||[allowEditScenarios](/.worksheetprotectionoptions#excel-javascript/api/excel/-worksheetprotectionoptions-alloweditscenarios-member)|Represents the worksheet protection option allowing editing of scenarios.| -||[selectionMode](/.worksheetprotectionoptions#excel-javascript/api/excel/-worksheetprotectionoptions-selectionmode-member)|Represents the worksheet protection option of selection mode.| -|[WorksheetSelectionChangedEventArgs](/.worksheetselectionchangedeventargs)|[address](/.worksheetselectionchangedeventargs#excel-javascript/api/excel/-worksheetselectionchangedeventargs-address-member)|Gets the range address that represents the selected area of a specific worksheet.| -||[type](/.worksheetselectionchangedeventargs#excel-javascript/api/excel/-worksheetselectionchangedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/.worksheetselectionchangedeventargs#excel-javascript/api/excel/-worksheetselectionchangedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the selection changed.| +|[Chart](/javascript/api/excel/excel.chart)|[chartType](/javascript/api/excel/excel.chart#excel-excel-chart-charttype-member)|Specifies the type of the chart.| +||[id](/javascript/api/excel/excel.chart#excel-excel-chart-id-member)|The unique ID of chart.| +||[showAllFieldButtons](/javascript/api/excel/excel.chart#excel-excel-chart-showallfieldbuttons-member)|Specifies whether to display all field buttons on a PivotChart.| +|[ChartAreaFormat](/javascript/api/excel/excel.chartareaformat)|[border](/javascript/api/excel/excel.chartareaformat#excel-excel-chartareaformat-border-member)|Represents the border format of chart area, which includes color, linestyle, and weight.| +|[ChartAxes](/javascript/api/excel/excel.chartaxes)|[getItem(type: Excel.ChartAxisType, group?: Excel.ChartAxisGroup)](/javascript/api/excel/excel.chartaxes#excel-excel-chartaxes-getitem-member(1))|Returns the specific axis identified by type and group.| +|[ChartAxis](/javascript/api/excel/excel.chartaxis)|[axisGroup](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-axisgroup-member)|Specifies the group for the specified axis.| +||[baseTimeUnit](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-basetimeunit-member)|Specifies the base unit for the specified category axis.| +||[categoryType](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-categorytype-member)|Specifies the category axis type.| +||[customDisplayUnit](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-customdisplayunit-member)|Specifies the custom axis display unit value.| +||[displayUnit](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-displayunit-member)|Represents the axis display unit.| +||[height](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-height-member)|Specifies the height, in points, of the chart axis.| +||[left](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-left-member)|Specifies the distance, in points, from the left edge of the axis to the left of chart area.| +||[logBase](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-logbase-member)|Specifies the base of the logarithm when using logarithmic scales.| +||[majorTickMark](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-majortickmark-member)|Specifies the type of major tick mark for the specified axis.| +||[majorTimeUnitScale](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-majortimeunitscale-member)|Specifies the major unit scale value for the category axis when the `categoryType` property is set to `dateAxis`.| +||[minorTickMark](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-minortickmark-member)|Specifies the type of minor tick mark for the specified axis.| +||[minorTimeUnitScale](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-minortimeunitscale-member)|Specifies the minor unit scale value for the category axis when the `categoryType` property is set to `dateAxis`.| +||[reversePlotOrder](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-reverseplotorder-member)|Specifies if Excel plots data points from last to first.| +||[scaleType](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-scaletype-member)|Specifies the value axis scale type.| +||[setCategoryNames(sourceData: Range)](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-setcategorynames-member(1))|Sets all the category names for the specified axis.| +||[setCustomDisplayUnit(value: number)](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-setcustomdisplayunit-member(1))|Sets the axis display unit to a custom value.| +||[showDisplayUnitLabel](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-showdisplayunitlabel-member)|Specifies if the axis display unit label is visible.| +||[tickLabelPosition](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-ticklabelposition-member)|Specifies the position of tick-mark labels on the specified axis.| +||[tickLabelSpacing](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-ticklabelspacing-member)|Specifies the number of categories or series between tick-mark labels.| +||[tickMarkSpacing](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-tickmarkspacing-member)|Specifies the number of categories or series between tick marks.| +||[top](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-top-member)|Specifies the distance, in points, from the top edge of the axis to the top of chart area.| +||[type](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-type-member)|Specifies the axis type.| +||[visible](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-visible-member)|Specifies if the axis is visible.| +||[width](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-width-member)|Specifies the width, in points, of the chart axis.| +|[ChartBorder](/javascript/api/excel/excel.chartborder)|[color](/javascript/api/excel/excel.chartborder#excel-excel-chartborder-color-member)|HTML color code representing the color of borders in the chart.| +||[lineStyle](/javascript/api/excel/excel.chartborder#excel-excel-chartborder-linestyle-member)|Represents the line style of the border.| +||[weight](/javascript/api/excel/excel.chartborder#excel-excel-chartborder-weight-member)|Represents weight of the border, in points.| +|[ChartDataLabel](/javascript/api/excel/excel.chartdatalabel)|[position](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-position-member)|Value that represents the position of the data label.| +||[separator](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-separator-member)|String representing the separator used for the data label on a chart.| +||[showBubbleSize](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-showbubblesize-member)|Specifies if the data label bubble size is visible.| +||[showCategoryName](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-showcategoryname-member)|Specifies if the data label category name is visible.| +||[showLegendKey](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-showlegendkey-member)|Specifies if the data label legend key is visible.| +||[showPercentage](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-showpercentage-member)|Specifies if the data label percentage is visible.| +||[showSeriesName](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-showseriesname-member)|Specifies if the data label series name is visible.| +||[showValue](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-showvalue-member)|Specifies if the data label value is visible.| +|[ChartFormatString](/javascript/api/excel/excel.chartformatstring)|[font](/javascript/api/excel/excel.chartformatstring#excel-excel-chartformatstring-font-member)|Represents the font attributes, such as font name, font size, and color of a chart characters object.| +|[ChartLegend](/javascript/api/excel/excel.chartlegend)|[height](/javascript/api/excel/excel.chartlegend#excel-excel-chartlegend-height-member)|Specifies the height, in points, of the legend on the chart.| +||[left](/javascript/api/excel/excel.chartlegend#excel-excel-chartlegend-left-member)|Specifies the left value, in points, of the legend on the chart.| +||[legendEntries](/javascript/api/excel/excel.chartlegend#excel-excel-chartlegend-legendentries-member)|Represents a collection of legendEntries in the legend.| +||[showShadow](/javascript/api/excel/excel.chartlegend#excel-excel-chartlegend-showshadow-member)|Specifies if the legend has a shadow on the chart.| +||[top](/javascript/api/excel/excel.chartlegend#excel-excel-chartlegend-top-member)|Specifies the top of a chart legend.| +||[width](/javascript/api/excel/excel.chartlegend#excel-excel-chartlegend-width-member)|Specifies the width, in points, of the legend on the chart.| +|[ChartLegendEntry](/javascript/api/excel/excel.chartlegendentry)|[visible](/javascript/api/excel/excel.chartlegendentry#excel-excel-chartlegendentry-visible-member)|Represents the visibility of a chart legend entry.| +|[ChartLegendEntryCollection](/javascript/api/excel/excel.chartlegendentrycollection)|[getCount()](/javascript/api/excel/excel.chartlegendentrycollection#excel-excel-chartlegendentrycollection-getcount-member(1))|Returns the number of legend entries in the collection.| +||[getItemAt(index: number)](/javascript/api/excel/excel.chartlegendentrycollection#excel-excel-chartlegendentrycollection-getitemat-member(1))|Returns a legend entry at the given index.| +||[items](/javascript/api/excel/excel.chartlegendentrycollection#excel-excel-chartlegendentrycollection-items-member)|Gets the loaded child items in this collection.| +|[ChartLineFormat](/javascript/api/excel/excel.chartlineformat)|[lineStyle](/javascript/api/excel/excel.chartlineformat#excel-excel-chartlineformat-linestyle-member)|Represents the line style.| +||[weight](/javascript/api/excel/excel.chartlineformat#excel-excel-chartlineformat-weight-member)|Represents weight of the line, in points.| +|[ChartPoint](/javascript/api/excel/excel.chartpoint)|[dataLabel](/javascript/api/excel/excel.chartpoint#excel-excel-chartpoint-datalabel-member)|Returns the data label of a chart point.| +||[hasDataLabel](/javascript/api/excel/excel.chartpoint#excel-excel-chartpoint-hasdatalabel-member)|Represents whether a data point has a data label.| +||[markerBackgroundColor](/javascript/api/excel/excel.chartpoint#excel-excel-chartpoint-markerbackgroundcolor-member)|HTML color code representation of the marker background color of a data point (e.g., #FF0000 represents Red).| +||[markerForegroundColor](/javascript/api/excel/excel.chartpoint#excel-excel-chartpoint-markerforegroundcolor-member)|HTML color code representation of the marker foreground color of a data point (e.g., #FF0000 represents Red).| +||[markerSize](/javascript/api/excel/excel.chartpoint#excel-excel-chartpoint-markersize-member)|Represents marker size of a data point.| +||[markerStyle](/javascript/api/excel/excel.chartpoint#excel-excel-chartpoint-markerstyle-member)|Represents marker style of a chart data point.| +|[ChartPointFormat](/javascript/api/excel/excel.chartpointformat)|[border](/javascript/api/excel/excel.chartpointformat#excel-excel-chartpointformat-border-member)|Represents the border format of a chart data point, which includes color, style, and weight information.| +|[ChartSeries](/javascript/api/excel/excel.chartseries)|[chartType](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-charttype-member)|Represents the chart type of a series.| +||[delete()](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-delete-member(1))|Deletes the chart series.| +||[doughnutHoleSize](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-doughnutholesize-member)|Represents the doughnut hole size of a chart series.| +||[filtered](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-filtered-member)|Specifies if the series is filtered.| +||[gapWidth](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-gapwidth-member)|Represents the gap width of a chart series.| +||[hasDataLabels](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-hasdatalabels-member)|Specifies if the series has data labels.| +||[markerBackgroundColor](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-markerbackgroundcolor-member)|Specifies the marker background color of a chart series.| +||[markerForegroundColor](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-markerforegroundcolor-member)|Specifies the marker foreground color of a chart series.| +||[markerSize](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-markersize-member)|Specifies the marker size of a chart series.| +||[markerStyle](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-markerstyle-member)|Specifies the marker style of a chart series.| +||[plotOrder](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-plotorder-member)|Specifies the plot order of a chart series within the chart group.| +||[setBubbleSizes(sourceData: Range)](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-setbubblesizes-member(1))|Sets the bubble sizes for a chart series.| +||[setValues(sourceData: Range)](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-setvalues-member(1))|Sets the values for a chart series.| +||[setXAxisValues(sourceData: Range)](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-setxaxisvalues-member(1))|Sets the values of the x-axis for a chart series.| +||[showShadow](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-showshadow-member)|Specifies if the series has a shadow.| +||[smooth](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-smooth-member)|Specifies if the series is smooth.| +||[trendlines](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-trendlines-member)|The collection of trendlines in the series.| +|[ChartSeriesCollection](/javascript/api/excel/excel.chartseriescollection)|[add(name?: string, index?: number)](/javascript/api/excel/excel.chartseriescollection#excel-excel-chartseriescollection-add-member(1))|Add a new series to the collection.| +|[ChartTitle](/javascript/api/excel/excel.charttitle)|[getSubstring(start: number, length: number)](/javascript/api/excel/excel.charttitle#excel-excel-charttitle-getsubstring-member(1))|Get the substring of a chart title.| +||[height](/javascript/api/excel/excel.charttitle#excel-excel-charttitle-height-member)|Returns the height, in points, of the chart title.| +||[horizontalAlignment](/javascript/api/excel/excel.charttitle#excel-excel-charttitle-horizontalalignment-member)|Specifies the horizontal alignment for chart title.| +||[left](/javascript/api/excel/excel.charttitle#excel-excel-charttitle-left-member)|Specifies the distance, in points, from the left edge of chart title to the left edge of chart area.| +||[position](/javascript/api/excel/excel.charttitle#excel-excel-charttitle-position-member)|Represents the position of chart title.| +||[setFormula(formula: string)](/javascript/api/excel/excel.charttitle#excel-excel-charttitle-setformula-member(1))|Sets a string value that represents the formula of chart title using A1-style notation.| +||[showShadow](/javascript/api/excel/excel.charttitle#excel-excel-charttitle-showshadow-member)|Represents a boolean value that determines if the chart title has a shadow.| +||[textOrientation](/javascript/api/excel/excel.charttitle#excel-excel-charttitle-textorientation-member)|Specifies the angle to which the text is oriented for the chart title.| +||[top](/javascript/api/excel/excel.charttitle#excel-excel-charttitle-top-member)|Specifies the distance, in points, from the top edge of chart title to the top of chart area.| +||[verticalAlignment](/javascript/api/excel/excel.charttitle#excel-excel-charttitle-verticalalignment-member)|Specifies the vertical alignment of chart title.| +||[width](/javascript/api/excel/excel.charttitle#excel-excel-charttitle-width-member)|Specifies the width, in points, of the chart title.| +|[ChartTitleFormat](/javascript/api/excel/excel.charttitleformat)|[border](/javascript/api/excel/excel.charttitleformat#excel-excel-charttitleformat-border-member)|Represents the border format of chart title, which includes color, linestyle, and weight.| +|[ChartTrendline](/javascript/api/excel/excel.charttrendline)|[delete()](/javascript/api/excel/excel.charttrendline#excel-excel-charttrendline-delete-member(1))|Delete the trendline object.| +||[format](/javascript/api/excel/excel.charttrendline#excel-excel-charttrendline-format-member)|Represents the formatting of a chart trendline.| +||[intercept](/javascript/api/excel/excel.charttrendline#excel-excel-charttrendline-intercept-member)|Represents the intercept value of the trendline.| +||[movingAveragePeriod](/javascript/api/excel/excel.charttrendline#excel-excel-charttrendline-movingaverageperiod-member)|Represents the period of a chart trendline.| +||[name](/javascript/api/excel/excel.charttrendline#excel-excel-charttrendline-name-member)|Represents the name of the trendline.| +||[polynomialOrder](/javascript/api/excel/excel.charttrendline#excel-excel-charttrendline-polynomialorder-member)|Represents the order of a chart trendline.| +||[type](/javascript/api/excel/excel.charttrendline#excel-excel-charttrendline-type-member)|Represents the type of a chart trendline.| +|[ChartTrendlineCollection](/javascript/api/excel/excel.charttrendlinecollection)|[add(type?: Excel.ChartTrendlineType)](/javascript/api/excel/excel.charttrendlinecollection#excel-excel-charttrendlinecollection-add-member(1))|Adds a new trendline to trendline collection.| +||[getCount()](/javascript/api/excel/excel.charttrendlinecollection#excel-excel-charttrendlinecollection-getcount-member(1))|Returns the number of trendlines in the collection.| +||[getItem(index: number)](/javascript/api/excel/excel.charttrendlinecollection#excel-excel-charttrendlinecollection-getitem-member(1))|Gets a trendline object by index, which is the insertion order in the items array.| +||[items](/javascript/api/excel/excel.charttrendlinecollection#excel-excel-charttrendlinecollection-items-member)|Gets the loaded child items in this collection.| +|[ChartTrendlineFormat](/javascript/api/excel/excel.charttrendlineformat)|[line](/javascript/api/excel/excel.charttrendlineformat#excel-excel-charttrendlineformat-line-member)|Represents chart line formatting.| +|[CustomProperty](/javascript/api/excel/excel.customproperty)|[delete()](/javascript/api/excel/excel.customproperty#excel-excel-customproperty-delete-member(1))|Deletes the custom property.| +||[key](/javascript/api/excel/excel.customproperty#excel-excel-customproperty-key-member)|The key of the custom property.| +||[type](/javascript/api/excel/excel.customproperty#excel-excel-customproperty-type-member)|The type of the value used for the custom property.| +||[value](/javascript/api/excel/excel.customproperty#excel-excel-customproperty-value-member)|The value of the custom property.| +|[CustomPropertyCollection](/javascript/api/excel/excel.custompropertycollection)|[add(key: string, value: any)](/javascript/api/excel/excel.custompropertycollection#excel-excel-custompropertycollection-add-member(1))|Creates a new or sets an existing custom property.| +||[deleteAll()](/javascript/api/excel/excel.custompropertycollection#excel-excel-custompropertycollection-deleteall-member(1))|Deletes all custom properties in this collection.| +||[getCount()](/javascript/api/excel/excel.custompropertycollection#excel-excel-custompropertycollection-getcount-member(1))|Gets the count of custom properties.| +||[getItem(key: string)](/javascript/api/excel/excel.custompropertycollection#excel-excel-custompropertycollection-getitem-member(1))|Gets a custom property object by its key, which is case-insensitive.| +||[getItemOrNullObject(key: string)](/javascript/api/excel/excel.custompropertycollection#excel-excel-custompropertycollection-getitemornullobject-member(1))|Gets a custom property object by its key, which is case-insensitive.| +||[items](/javascript/api/excel/excel.custompropertycollection#excel-excel-custompropertycollection-items-member)|Gets the loaded child items in this collection.| +|[DataConnectionCollection](/javascript/api/excel/excel.dataconnectioncollection)|[refreshAll()](/javascript/api/excel/excel.dataconnectioncollection#excel-excel-dataconnectioncollection-refreshall-member(1))|Refreshes data connections in the collection, such as from a PivotTable to a Power BI dataset, or a Data Model to a table or range in the same workbook.| +|[DocumentProperties](/javascript/api/excel/excel.documentproperties)|[author](/javascript/api/excel/excel.documentproperties#excel-excel-documentproperties-author-member)|The author of the workbook.| +||[category](/javascript/api/excel/excel.documentproperties#excel-excel-documentproperties-category-member)|The category of the workbook.| +||[comments](/javascript/api/excel/excel.documentproperties#excel-excel-documentproperties-comments-member)|The Comments field in the metadata of the workbook.| +||[company](/javascript/api/excel/excel.documentproperties#excel-excel-documentproperties-company-member)|The company of the workbook.| +||[creationDate](/javascript/api/excel/excel.documentproperties#excel-excel-documentproperties-creationdate-member)|Gets the creation date of the workbook.| +||[custom](/javascript/api/excel/excel.documentproperties#excel-excel-documentproperties-custom-member)|Gets the collection of custom properties of the workbook.| +||[keywords](/javascript/api/excel/excel.documentproperties#excel-excel-documentproperties-keywords-member)|The keywords of the workbook.| +||[lastAuthor](/javascript/api/excel/excel.documentproperties#excel-excel-documentproperties-lastauthor-member)|Gets the last author of the workbook.| +||[manager](/javascript/api/excel/excel.documentproperties#excel-excel-documentproperties-manager-member)|The manager of the workbook.| +||[revisionNumber](/javascript/api/excel/excel.documentproperties#excel-excel-documentproperties-revisionnumber-member)|Gets the revision number of the workbook.| +||[subject](/javascript/api/excel/excel.documentproperties#excel-excel-documentproperties-subject-member)|The subject of the workbook.| +||[title](/javascript/api/excel/excel.documentproperties#excel-excel-documentproperties-title-member)|The title of the workbook.| +|[NamedItem](/javascript/api/excel/excel.nameditem)|[arrayValues](/javascript/api/excel/excel.nameditem#excel-excel-nameditem-arrayvalues-member)|Returns an object containing values and types of the named item.| +||[formula](/javascript/api/excel/excel.nameditem#excel-excel-nameditem-formula-member)|The formula of the named item.| +|[NamedItemArrayValues](/javascript/api/excel/excel.nameditemarrayvalues)|[types](/javascript/api/excel/excel.nameditemarrayvalues#excel-excel-nameditemarrayvalues-types-member)|Represents the types for each item in the named item array| +||[values](/javascript/api/excel/excel.nameditemarrayvalues#excel-excel-nameditemarrayvalues-values-member)|Represents the values of each item in the named item array.| +|[Range](/javascript/api/excel/excel.range)|[getAbsoluteResizedRange(numRows: number, numColumns: number)](/javascript/api/excel/excel.range#excel-excel-range-getabsoluteresizedrange-member(1))|Gets a `Range` object with the same top-left cell as the current `Range` object, but with the specified numbers of rows and columns.| +||[getImage()](/javascript/api/excel/excel.range#excel-excel-range-getimage-member(1))|Renders the range as a Base64-encoded PNG image.| +||[getSurroundingRegion()](/javascript/api/excel/excel.range#excel-excel-range-getsurroundingregion-member(1))|Returns a `Range` object that represents the surrounding region for the top-left cell in this range.| +||[hyperlink](/javascript/api/excel/excel.range#excel-excel-range-hyperlink-member)|Represents the hyperlink for the current range.| +||[isEntireColumn](/javascript/api/excel/excel.range#excel-excel-range-isentirecolumn-member)|Represents if the current range is an entire column.| +||[isEntireRow](/javascript/api/excel/excel.range#excel-excel-range-isentirerow-member)|Represents if the current range is an entire row.| +||[numberFormatLocal](/javascript/api/excel/excel.range#excel-excel-range-numberformatlocal-member)|Represents Excel's number format code for the given range, based on the language settings of the user.| +||[showCard()](/javascript/api/excel/excel.range#excel-excel-range-showcard-member(1))|Displays the card for an active cell if it has rich value content.| +||[style](/javascript/api/excel/excel.range#excel-excel-range-style-member)|Represents the style of the current range.| +|[RangeFormat](/javascript/api/excel/excel.rangeformat)|[textOrientation](/javascript/api/excel/excel.rangeformat#excel-excel-rangeformat-textorientation-member)|The text orientation of all the cells within the range.| +||[useStandardHeight](/javascript/api/excel/excel.rangeformat#excel-excel-rangeformat-usestandardheight-member)|Determines if the row height of the `Range` object equals the standard height of the sheet.| +||[useStandardWidth](/javascript/api/excel/excel.rangeformat#excel-excel-rangeformat-usestandardwidth-member)|Specifies if the column width of the `Range` object equals the standard width of the sheet.| +|[RangeHyperlink](/javascript/api/excel/excel.rangehyperlink)|[address](/javascript/api/excel/excel.rangehyperlink#excel-excel-rangehyperlink-address-member)|Represents the URL target for the hyperlink.| +||[documentReference](/javascript/api/excel/excel.rangehyperlink#excel-excel-rangehyperlink-documentreference-member)|Represents the document reference target for the hyperlink.| +||[screenTip](/javascript/api/excel/excel.rangehyperlink#excel-excel-rangehyperlink-screentip-member)|Represents the string displayed when hovering over the hyperlink.| +||[textToDisplay](/javascript/api/excel/excel.rangehyperlink#excel-excel-rangehyperlink-texttodisplay-member)|Represents the string that is displayed in the top left most cell in the range.| +|[Style](/javascript/api/excel/excel.style)|[borders](/javascript/api/excel/excel.style#excel-excel-style-borders-member)|A collection of four border objects that represent the style of the four borders.| +||[builtIn](/javascript/api/excel/excel.style#excel-excel-style-builtin-member)|Specifies if the style is a built-in style.| +||[delete()](/javascript/api/excel/excel.style#excel-excel-style-delete-member(1))|Deletes this style.| +||[fill](/javascript/api/excel/excel.style#excel-excel-style-fill-member)|The fill of the style.| +||[font](/javascript/api/excel/excel.style#excel-excel-style-font-member)|A `Font` object that represents the font of the style.| +||[formulaHidden](/javascript/api/excel/excel.style#excel-excel-style-formulahidden-member)|Specifies if the formula will be hidden when the worksheet is protected.| +||[horizontalAlignment](/javascript/api/excel/excel.style#excel-excel-style-horizontalalignment-member)|Represents the horizontal alignment for the style.| +||[includeAlignment](/javascript/api/excel/excel.style#excel-excel-style-includealignment-member)|Specifies if the style includes the auto indent, horizontal alignment, vertical alignment, wrap text, indent level, and text orientation properties.| +||[includeBorder](/javascript/api/excel/excel.style#excel-excel-style-includeborder-member)|Specifies if the style includes the color, color index, line style, and weight border properties.| +||[includeFont](/javascript/api/excel/excel.style#excel-excel-style-includefont-member)|Specifies if the style includes the background, bold, color, color index, font style, italic, name, size, strikethrough, subscript, superscript, and underline font properties.| +||[includeNumber](/javascript/api/excel/excel.style#excel-excel-style-includenumber-member)|Specifies if the style includes the number format property.| +||[includePatterns](/javascript/api/excel/excel.style#excel-excel-style-includepatterns-member)|Specifies if the style includes the color, color index, invert if negative, pattern, pattern color, and pattern color index interior properties.| +||[includeProtection](/javascript/api/excel/excel.style#excel-excel-style-includeprotection-member)|Specifies if the style includes the formula hidden and locked protection properties.| +||[indentLevel](/javascript/api/excel/excel.style#excel-excel-style-indentlevel-member)|An integer from 0 to 250 that indicates the indent level for the style.| +||[locked](/javascript/api/excel/excel.style#excel-excel-style-locked-member)|Specifies if the object is locked when the worksheet is protected.| +||[name](/javascript/api/excel/excel.style#excel-excel-style-name-member)|The name of the style.| +||[numberFormat](/javascript/api/excel/excel.style#excel-excel-style-numberformat-member)|The format code of the number format for the style.| +||[numberFormatLocal](/javascript/api/excel/excel.style#excel-excel-style-numberformatlocal-member)|The localized format code of the number format for the style.| +||[readingOrder](/javascript/api/excel/excel.style#excel-excel-style-readingorder-member)|The reading order for the style.| +||[shrinkToFit](/javascript/api/excel/excel.style#excel-excel-style-shrinktofit-member)|Specifies if text automatically shrinks to fit in the available column width.| +||[verticalAlignment](/javascript/api/excel/excel.style#excel-excel-style-verticalalignment-member)|Specifies the vertical alignment for the style.| +||[wrapText](/javascript/api/excel/excel.style#excel-excel-style-wraptext-member)|Specifies if Excel wraps the text in the object.| +|[StyleCollection](/javascript/api/excel/excel.stylecollection)|[add(name: string)](/javascript/api/excel/excel.stylecollection#excel-excel-stylecollection-add-member(1))|Adds a new style to the collection.| +||[getItem(name: string)](/javascript/api/excel/excel.stylecollection#excel-excel-stylecollection-getitem-member(1))|Gets a `Style` by name.| +||[items](/javascript/api/excel/excel.stylecollection#excel-excel-stylecollection-items-member)|Gets the loaded child items in this collection.| +|[Table](/javascript/api/excel/excel.table)|[onChanged](/javascript/api/excel/excel.table#excel-excel-table-onchanged-member)|Occurs when data in cells changes on a specific table.| +||[onSelectionChanged](/javascript/api/excel/excel.table#excel-excel-table-onselectionchanged-member)|Occurs when the selection changes on a specific table.| +|[TableChangedEventArgs](/javascript/api/excel/excel.tablechangedeventargs)|[address](/javascript/api/excel/excel.tablechangedeventargs#excel-excel-tablechangedeventargs-address-member)|Gets the address that represents the changed area of a table on a specific worksheet.| +||[changeType](/javascript/api/excel/excel.tablechangedeventargs#excel-excel-tablechangedeventargs-changetype-member)|Gets the change type that represents how the changed event is triggered.| +||[source](/javascript/api/excel/excel.tablechangedeventargs#excel-excel-tablechangedeventargs-source-member)|Gets the source of the event.| +||[tableId](/javascript/api/excel/excel.tablechangedeventargs#excel-excel-tablechangedeventargs-tableid-member)|Gets the ID of the table in which the data changed.| +||[type](/javascript/api/excel/excel.tablechangedeventargs#excel-excel-tablechangedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/javascript/api/excel/excel.tablechangedeventargs#excel-excel-tablechangedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the data changed.| +|[TableCollection](/javascript/api/excel/excel.tablecollection)|[onChanged](/javascript/api/excel/excel.tablecollection#excel-excel-tablecollection-onchanged-member)|Occurs when data changes on any table in a workbook, or a worksheet.| +|[TableSelectionChangedEventArgs](/javascript/api/excel/excel.tableselectionchangedeventargs)|[address](/javascript/api/excel/excel.tableselectionchangedeventargs#excel-excel-tableselectionchangedeventargs-address-member)|Gets the range address that represents the selected area of the table on a specific worksheet.| +||[isInsideTable](/javascript/api/excel/excel.tableselectionchangedeventargs#excel-excel-tableselectionchangedeventargs-isinsidetable-member)|Specifies if the selection is inside a table.| +||[tableId](/javascript/api/excel/excel.tableselectionchangedeventargs#excel-excel-tableselectionchangedeventargs-tableid-member)|Gets the ID of the table in which the selection changed.| +||[type](/javascript/api/excel/excel.tableselectionchangedeventargs#excel-excel-tableselectionchangedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/javascript/api/excel/excel.tableselectionchangedeventargs#excel-excel-tableselectionchangedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the selection changed.| +|[Workbook](/javascript/api/excel/excel.workbook)|[dataConnections](/javascript/api/excel/excel.workbook#excel-excel-workbook-dataconnections-member)|Represents all data connections in the workbook.| +||[getActiveCell()](/javascript/api/excel/excel.workbook#excel-excel-workbook-getactivecell-member(1))|Gets the currently active cell from the workbook.| +||[name](/javascript/api/excel/excel.workbook#excel-excel-workbook-name-member)|Gets the workbook name.| +||[properties](/javascript/api/excel/excel.workbook#excel-excel-workbook-properties-member)|Gets the workbook properties.| +||[protection](/javascript/api/excel/excel.workbook#excel-excel-workbook-protection-member)|Returns the protection object for a workbook.| +||[styles](/javascript/api/excel/excel.workbook#excel-excel-workbook-styles-member)|Represents a collection of styles associated with the workbook.| +|[WorkbookProtection](/javascript/api/excel/excel.workbookprotection)|[protect(password?: string)](/javascript/api/excel/excel.workbookprotection#excel-excel-workbookprotection-protect-member(1))|Protects the workbook.| +||[protected](/javascript/api/excel/excel.workbookprotection#excel-excel-workbookprotection-protected-member)|Specifies if the workbook is protected.| +||[unprotect(password?: string)](/javascript/api/excel/excel.workbookprotection#excel-excel-workbookprotection-unprotect-member(1))|Unprotects the workbook.| +|[Worksheet](/javascript/api/excel/excel.worksheet)|[copy(positionType?: Excel.WorksheetPositionType, relativeTo?: Excel.Worksheet)](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-copy-member(1))|Copies a worksheet and places it at the specified position.| +||[freezePanes](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-freezepanes-member)|Gets an object that can be used to manipulate frozen panes on the worksheet.| +||[getRangeByIndexes(startRow: number, startColumn: number, rowCount: number, columnCount: number)](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-getrangebyindexes-member(1))|Gets the `Range` object beginning at a particular row index and column index, and spanning a certain number of rows and columns.| +||[onActivated](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-onactivated-member)|Occurs when the worksheet is activated.| +||[onChanged](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-onchanged-member)|Occurs when data changes in a specific worksheet.| +||[onDeactivated](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-ondeactivated-member)|Occurs when the worksheet is deactivated.| +||[onSelectionChanged](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-onselectionchanged-member)|Occurs when the selection changes on a specific worksheet.| +||[standardHeight](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-standardheight-member)|Returns the standard (default) height of all the rows in the worksheet, in points.| +||[standardWidth](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-standardwidth-member)|Specifies the standard (default) width of all the columns in the worksheet.| +||[tabColor](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-tabcolor-member)|The tab color of the worksheet.| +|[WorksheetActivatedEventArgs](/javascript/api/excel/excel.worksheetactivatedeventargs)|[type](/javascript/api/excel/excel.worksheetactivatedeventargs#excel-excel-worksheetactivatedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/javascript/api/excel/excel.worksheetactivatedeventargs#excel-excel-worksheetactivatedeventargs-worksheetid-member)|Gets the ID of the worksheet that is activated.| +|[WorksheetAddedEventArgs](/javascript/api/excel/excel.worksheetaddedeventargs)|[source](/javascript/api/excel/excel.worksheetaddedeventargs#excel-excel-worksheetaddedeventargs-source-member)|Gets the source of the event.| +||[type](/javascript/api/excel/excel.worksheetaddedeventargs#excel-excel-worksheetaddedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/javascript/api/excel/excel.worksheetaddedeventargs#excel-excel-worksheetaddedeventargs-worksheetid-member)|Gets the ID of the worksheet that is added to the workbook.| +|[WorksheetChangedEventArgs](/javascript/api/excel/excel.worksheetchangedeventargs)|[address](/javascript/api/excel/excel.worksheetchangedeventargs#excel-excel-worksheetchangedeventargs-address-member)|Gets the range address that represents the changed area of a specific worksheet.| +||[changeType](/javascript/api/excel/excel.worksheetchangedeventargs#excel-excel-worksheetchangedeventargs-changetype-member)|Gets the change type that represents how the changed event is triggered.| +||[source](/javascript/api/excel/excel.worksheetchangedeventargs#excel-excel-worksheetchangedeventargs-source-member)|Gets the source of the event.| +||[type](/javascript/api/excel/excel.worksheetchangedeventargs#excel-excel-worksheetchangedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/javascript/api/excel/excel.worksheetchangedeventargs#excel-excel-worksheetchangedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the data changed.| +|[WorksheetCollection](/javascript/api/excel/excel.worksheetcollection)|[onActivated](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-onactivated-member)|Occurs when any worksheet in the workbook is activated.| +||[onAdded](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-onadded-member)|Occurs when a new worksheet is added to the workbook.| +||[onDeactivated](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-ondeactivated-member)|Occurs when any worksheet in the workbook is deactivated.| +||[onDeleted](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-ondeleted-member)|Occurs when a worksheet is deleted from the workbook.| +|[WorksheetDeactivatedEventArgs](/javascript/api/excel/excel.worksheetdeactivatedeventargs)|[type](/javascript/api/excel/excel.worksheetdeactivatedeventargs#excel-excel-worksheetdeactivatedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/javascript/api/excel/excel.worksheetdeactivatedeventargs#excel-excel-worksheetdeactivatedeventargs-worksheetid-member)|Gets the ID of the worksheet that is deactivated.| +|[WorksheetDeletedEventArgs](/javascript/api/excel/excel.worksheetdeletedeventargs)|[source](/javascript/api/excel/excel.worksheetdeletedeventargs#excel-excel-worksheetdeletedeventargs-source-member)|Gets the source of the event.| +||[type](/javascript/api/excel/excel.worksheetdeletedeventargs#excel-excel-worksheetdeletedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/javascript/api/excel/excel.worksheetdeletedeventargs#excel-excel-worksheetdeletedeventargs-worksheetid-member)|Gets the ID of the worksheet that is deleted from the workbook.| +|[WorksheetFreezePanes](/javascript/api/excel/excel.worksheetfreezepanes)|[freezeAt(frozenRange: Range \| string)](/javascript/api/excel/excel.worksheetfreezepanes#excel-excel-worksheetfreezepanes-freezeat-member(1))|Sets the frozen cells in the active worksheet view.| +||[freezeColumns(count?: number)](/javascript/api/excel/excel.worksheetfreezepanes#excel-excel-worksheetfreezepanes-freezecolumns-member(1))|Freeze the first column or columns of the worksheet in place.| +||[freezeRows(count?: number)](/javascript/api/excel/excel.worksheetfreezepanes#excel-excel-worksheetfreezepanes-freezerows-member(1))|Freeze the top row or rows of the worksheet in place.| +||[getLocation()](/javascript/api/excel/excel.worksheetfreezepanes#excel-excel-worksheetfreezepanes-getlocation-member(1))|Gets a range that describes the frozen cells in the active worksheet view.| +||[getLocationOrNullObject()](/javascript/api/excel/excel.worksheetfreezepanes#excel-excel-worksheetfreezepanes-getlocationornullobject-member(1))|Gets a range that describes the frozen cells in the active worksheet view.| +||[unfreeze()](/javascript/api/excel/excel.worksheetfreezepanes#excel-excel-worksheetfreezepanes-unfreeze-member(1))|Removes all frozen panes in the worksheet.| +|[WorksheetProtection](/javascript/api/excel/excel.worksheetprotection)|[unprotect(password?: string)](/javascript/api/excel/excel.worksheetprotection#excel-excel-worksheetprotection-unprotect-member(1))|Unprotects a worksheet.| +|[WorksheetProtectionOptions](/javascript/api/excel/excel.worksheetprotectionoptions)|[allowEditObjects](/javascript/api/excel/excel.worksheetprotectionoptions#excel-excel-worksheetprotectionoptions-alloweditobjects-member)|Represents the worksheet protection option allowing editing of objects.| +||[allowEditScenarios](/javascript/api/excel/excel.worksheetprotectionoptions#excel-excel-worksheetprotectionoptions-alloweditscenarios-member)|Represents the worksheet protection option allowing editing of scenarios.| +||[selectionMode](/javascript/api/excel/excel.worksheetprotectionoptions#excel-excel-worksheetprotectionoptions-selectionmode-member)|Represents the worksheet protection option of selection mode.| +|[WorksheetSelectionChangedEventArgs](/javascript/api/excel/excel.worksheetselectionchangedeventargs)|[address](/javascript/api/excel/excel.worksheetselectionchangedeventargs#excel-excel-worksheetselectionchangedeventargs-address-member)|Gets the range address that represents the selected area of a specific worksheet.| +||[type](/javascript/api/excel/excel.worksheetselectionchangedeventargs#excel-excel-worksheetselectionchangedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/javascript/api/excel/excel.worksheetselectionchangedeventargs#excel-excel-worksheetselectionchangedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the selection changed.| diff --git a/docs/includes/excel-1_8.md b/docs/includes/excel-1_8.md index 39fe3a3fd9..8f70ea18d6 100644 --- a/docs/includes/excel-1_8.md +++ b/docs/includes/excel-1_8.md @@ -1,251 +1,251 @@ | Class | Fields | Description | |:---|:---|:---| -|*global*|[createWorkbook(base64?: string)](/#excel-javascript/api/excel/-createworkbook-function(1))|Creates and opens a new workbook.| -|[BasicDataValidation](/.basicdatavalidation)|[formula1](/.basicdatavalidation#excel-javascript/api/excel/-basicdatavalidation-formula1-member)|Specifies the right-hand operand when the operator property is set to a binary operator such as GreaterThan (the left-hand operand is the value the user tries to enter in the cell).| -||[formula2](/.basicdatavalidation#excel-javascript/api/excel/-basicdatavalidation-formula2-member)|With the ternary operators Between and NotBetween, specifies the upper bound operand.| -||[operator](/.basicdatavalidation#excel-javascript/api/excel/-basicdatavalidation-operator-member)|The operator to use for validating the data.| -|[Chart](/.chart)|[categoryLabelLevel](/.chart#excel-javascript/api/excel/-chart-categorylabellevel-member)|Specifies a chart category label level enumeration constant, referring to the level of the source category labels.| -||[displayBlanksAs](/.chart#excel-javascript/api/excel/-chart-displayblanksas-member)|Specifies the way that blank cells are plotted on a chart.| -||[onActivated](/.chart#excel-javascript/api/excel/-chart-onactivated-member)|Occurs when the chart is activated.| -||[onDeactivated](/.chart#excel-javascript/api/excel/-chart-ondeactivated-member)|Occurs when the chart is deactivated.| -||[plotArea](/.chart#excel-javascript/api/excel/-chart-plotarea-member)|Represents the plot area for the chart.| -||[plotBy](/.chart#excel-javascript/api/excel/-chart-plotby-member)|Specifies the way columns or rows are used as data series on the chart.| -||[plotVisibleOnly](/.chart#excel-javascript/api/excel/-chart-plotvisibleonly-member)|True if only visible cells are plotted.| -||[seriesNameLevel](/.chart#excel-javascript/api/excel/-chart-seriesnamelevel-member)|Specifies a chart series name level enumeration constant, referring to the level of the source series names.| -||[showDataLabelsOverMaximum](/.chart#excel-javascript/api/excel/-chart-showdatalabelsovermaximum-member)|Specifies whether to show the data labels when the value is greater than the maximum value on the value axis.| -||[style](/.chart#excel-javascript/api/excel/-chart-style-member)|Specifies the chart style for the chart.| -|[ChartActivatedEventArgs](/.chartactivatedeventargs)|[chartId](/.chartactivatedeventargs#excel-javascript/api/excel/-chartactivatedeventargs-chartid-member)|Gets the ID of the chart that is activated.| -||[type](/.chartactivatedeventargs#excel-javascript/api/excel/-chartactivatedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/.chartactivatedeventargs#excel-javascript/api/excel/-chartactivatedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the chart is activated.| -|[ChartAddedEventArgs](/.chartaddedeventargs)|[chartId](/.chartaddedeventargs#excel-javascript/api/excel/-chartaddedeventargs-chartid-member)|Gets the ID of the chart that is added to the worksheet.| -||[source](/.chartaddedeventargs#excel-javascript/api/excel/-chartaddedeventargs-source-member)|Gets the source of the event.| -||[type](/.chartaddedeventargs#excel-javascript/api/excel/-chartaddedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/.chartaddedeventargs#excel-javascript/api/excel/-chartaddedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the chart is added.| -|[ChartAxis](/.chartaxis)|[alignment](/.chartaxis#excel-javascript/api/excel/-chartaxis-alignment-member)|Specifies the alignment for the specified axis tick label.| -||[isBetweenCategories](/.chartaxis#excel-javascript/api/excel/-chartaxis-isbetweencategories-member)|Specifies if the value axis crosses the category axis between categories.| -||[multiLevel](/.chartaxis#excel-javascript/api/excel/-chartaxis-multilevel-member)|Specifies if an axis is multilevel.| -||[numberFormat](/.chartaxis#excel-javascript/api/excel/-chartaxis-numberformat-member)|Specifies the format code for the axis tick label.| -||[offset](/.chartaxis#excel-javascript/api/excel/-chartaxis-offset-member)|Specifies the distance between the levels of labels, and the distance between the first level and the axis line.| -||[position](/.chartaxis#excel-javascript/api/excel/-chartaxis-position-member)|Specifies the specified axis position where the other axis crosses.| -||[positionAt](/.chartaxis#excel-javascript/api/excel/-chartaxis-positionat-member)|Specifies the axis position where the other axis crosses.| -||[setPositionAt(value: number)](/.chartaxis#excel-javascript/api/excel/-chartaxis-setpositionat-member(1))|Sets the specified axis position where the other axis crosses.| -||[textOrientation](/.chartaxis#excel-javascript/api/excel/-chartaxis-textorientation-member)|Specifies the angle to which the text is oriented for the chart axis tick label.| -|[ChartAxisFormat](/.chartaxisformat)|[fill](/.chartaxisformat#excel-javascript/api/excel/-chartaxisformat-fill-member)|Specifies chart fill formatting.| -|[ChartAxisTitle](/.chartaxistitle)|[setFormula(formula: string)](/.chartaxistitle#excel-javascript/api/excel/-chartaxistitle-setformula-member(1))|A string value that represents the formula of chart axis title using A1-style notation.| -|[ChartAxisTitleFormat](/.chartaxistitleformat)|[border](/.chartaxistitleformat#excel-javascript/api/excel/-chartaxistitleformat-border-member)|Specifies the chart axis title's border format, which includes color, linestyle, and weight.| -||[fill](/.chartaxistitleformat#excel-javascript/api/excel/-chartaxistitleformat-fill-member)|Specifies the chart axis title's fill formatting.| -|[ChartBorder](/.chartborder)|[clear()](/.chartborder#excel-javascript/api/excel/-chartborder-clear-member(1))|Clear the border format of a chart element.| -|[ChartCollection](/.chartcollection)|[onActivated](/.chartcollection#excel-javascript/api/excel/-chartcollection-onactivated-member)|Occurs when a chart is activated.| -||[onAdded](/.chartcollection#excel-javascript/api/excel/-chartcollection-onadded-member)|Occurs when a new chart is added to the worksheet.| -||[onDeactivated](/.chartcollection#excel-javascript/api/excel/-chartcollection-ondeactivated-member)|Occurs when a chart is deactivated.| -||[onDeleted](/.chartcollection#excel-javascript/api/excel/-chartcollection-ondeleted-member)|Occurs when a chart is deleted.| -|[ChartDataLabel](/.chartdatalabel)|[autoText](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-autotext-member)|Specifies if the data label automatically generates appropriate text based on context.| -||[format](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-format-member)|Represents the format of chart data label.| -||[formula](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-formula-member)|String value that represents the formula of chart data label using A1-style notation.| -||[height](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-height-member)|Returns the height, in points, of the chart data label.| -||[horizontalAlignment](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-horizontalalignment-member)|Represents the horizontal alignment for chart data label.| -||[left](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-left-member)|Represents the distance, in points, from the left edge of chart data label to the left edge of chart area.| -||[numberFormat](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-numberformat-member)|Specifies the format code for data label.| -||[text](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-text-member)|String representing the text of the data label on a chart.| -||[textOrientation](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-textorientation-member)|Represents the angle to which the text is oriented for the chart data label.| -||[top](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-top-member)|Represents the distance, in points, from the top edge of chart data label to the top of chart area.| -||[verticalAlignment](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-verticalalignment-member)|Represents the vertical alignment of chart data label.| -||[width](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-width-member)|Returns the width, in points, of the chart data label.| -|[ChartDataLabelFormat](/.chartdatalabelformat)|[border](/.chartdatalabelformat#excel-javascript/api/excel/-chartdatalabelformat-border-member)|Represents the border format, which includes color, linestyle, and weight.| -|[ChartDataLabels](/.chartdatalabels)|[autoText](/.chartdatalabels#excel-javascript/api/excel/-chartdatalabels-autotext-member)|Specifies if data labels automatically generate appropriate text based on context.| -||[horizontalAlignment](/.chartdatalabels#excel-javascript/api/excel/-chartdatalabels-horizontalalignment-member)|Specifies the horizontal alignment for chart data label.| -||[numberFormat](/.chartdatalabels#excel-javascript/api/excel/-chartdatalabels-numberformat-member)|Specifies the format code for data labels.| -||[textOrientation](/.chartdatalabels#excel-javascript/api/excel/-chartdatalabels-textorientation-member)|Represents the angle to which the text is oriented for data labels.| -||[verticalAlignment](/.chartdatalabels#excel-javascript/api/excel/-chartdatalabels-verticalalignment-member)|Represents the vertical alignment of chart data label.| -|[ChartDeactivatedEventArgs](/.chartdeactivatedeventargs)|[chartId](/.chartdeactivatedeventargs#excel-javascript/api/excel/-chartdeactivatedeventargs-chartid-member)|Gets the ID of the chart that is deactivated.| -||[type](/.chartdeactivatedeventargs#excel-javascript/api/excel/-chartdeactivatedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/.chartdeactivatedeventargs#excel-javascript/api/excel/-chartdeactivatedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the chart is deactivated.| -|[ChartDeletedEventArgs](/.chartdeletedeventargs)|[chartId](/.chartdeletedeventargs#excel-javascript/api/excel/-chartdeletedeventargs-chartid-member)|Gets the ID of the chart that is deleted from the worksheet.| -||[source](/.chartdeletedeventargs#excel-javascript/api/excel/-chartdeletedeventargs-source-member)|Gets the source of the event.| -||[type](/.chartdeletedeventargs#excel-javascript/api/excel/-chartdeletedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/.chartdeletedeventargs#excel-javascript/api/excel/-chartdeletedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the chart is deleted.| -|[ChartLegendEntry](/.chartlegendentry)|[height](/.chartlegendentry#excel-javascript/api/excel/-chartlegendentry-height-member)|Specifies the height of the legend entry on the chart legend.| -||[index](/.chartlegendentry#excel-javascript/api/excel/-chartlegendentry-index-member)|Specifies the index of the legend entry in the chart legend.| -||[left](/.chartlegendentry#excel-javascript/api/excel/-chartlegendentry-left-member)|Specifies the left value of a chart legend entry.| -||[top](/.chartlegendentry#excel-javascript/api/excel/-chartlegendentry-top-member)|Specifies the top of a chart legend entry.| -||[width](/.chartlegendentry#excel-javascript/api/excel/-chartlegendentry-width-member)|Represents the width of the legend entry on the chart Legend.| -|[ChartLegendFormat](/.chartlegendformat)|[border](/.chartlegendformat#excel-javascript/api/excel/-chartlegendformat-border-member)|Represents the border format, which includes color, linestyle, and weight.| -|[ChartPlotArea](/.chartplotarea)|[format](/.chartplotarea#excel-javascript/api/excel/-chartplotarea-format-member)|Specifies the formatting of a chart plot area.| -||[height](/.chartplotarea#excel-javascript/api/excel/-chartplotarea-height-member)|Specifies the height value of a plot area.| -||[insideHeight](/.chartplotarea#excel-javascript/api/excel/-chartplotarea-insideheight-member)|Specifies the inside height value of a plot area.| -||[insideLeft](/.chartplotarea#excel-javascript/api/excel/-chartplotarea-insideleft-member)|Specifies the inside left value of a plot area.| -||[insideTop](/.chartplotarea#excel-javascript/api/excel/-chartplotarea-insidetop-member)|Specifies the inside top value of a plot area.| -||[insideWidth](/.chartplotarea#excel-javascript/api/excel/-chartplotarea-insidewidth-member)|Specifies the inside width value of a plot area.| -||[left](/.chartplotarea#excel-javascript/api/excel/-chartplotarea-left-member)|Specifies the left value of a plot area.| -||[position](/.chartplotarea#excel-javascript/api/excel/-chartplotarea-position-member)|Specifies the position of a plot area.| -||[top](/.chartplotarea#excel-javascript/api/excel/-chartplotarea-top-member)|Specifies the top value of a plot area.| -||[width](/.chartplotarea#excel-javascript/api/excel/-chartplotarea-width-member)|Specifies the width value of a plot area.| -|[ChartPlotAreaFormat](/.chartplotareaformat)|[border](/.chartplotareaformat#excel-javascript/api/excel/-chartplotareaformat-border-member)|Specifies the border attributes of a chart plot area.| -||[fill](/.chartplotareaformat#excel-javascript/api/excel/-chartplotareaformat-fill-member)|Specifies the fill format of an object, which includes background formatting information.| -|[ChartSeries](/.chartseries)|[axisGroup](/.chartseries#excel-javascript/api/excel/-chartseries-axisgroup-member)|Specifies the group for the specified series.| -||[dataLabels](/.chartseries#excel-javascript/api/excel/-chartseries-datalabels-member)|Represents a collection of all data labels in the series.| -||[explosion](/.chartseries#excel-javascript/api/excel/-chartseries-explosion-member)|Specifies the explosion value for a pie-chart or doughnut-chart slice.| -||[firstSliceAngle](/.chartseries#excel-javascript/api/excel/-chartseries-firstsliceangle-member)|Specifies the angle of the first pie-chart or doughnut-chart slice, in degrees (clockwise from vertical).| -||[invertIfNegative](/.chartseries#excel-javascript/api/excel/-chartseries-invertifnegative-member)|True if Excel inverts the pattern in the item when it corresponds to a negative number.| -||[overlap](/.chartseries#excel-javascript/api/excel/-chartseries-overlap-member)|Specifies how bars and columns are positioned.| -||[secondPlotSize](/.chartseries#excel-javascript/api/excel/-chartseries-secondplotsize-member)|Specifies the size of the secondary section of either a pie-of-pie chart or a bar-of-pie chart, as a percentage of the size of the primary pie.| -||[splitType](/.chartseries#excel-javascript/api/excel/-chartseries-splittype-member)|Specifies the way the two sections of either a pie-of-pie chart or a bar-of-pie chart are split.| -||[varyByCategories](/.chartseries#excel-javascript/api/excel/-chartseries-varybycategories-member)|True if Excel assigns a different color or pattern to each data marker.| -|[ChartTrendline](/.charttrendline)|[backwardPeriod](/.charttrendline#excel-javascript/api/excel/-charttrendline-backwardperiod-member)|Represents the number of periods that the trendline extends backward.| -||[forwardPeriod](/.charttrendline#excel-javascript/api/excel/-charttrendline-forwardperiod-member)|Represents the number of periods that the trendline extends forward.| -||[label](/.charttrendline#excel-javascript/api/excel/-charttrendline-label-member)|Represents the label of a chart trendline.| -||[showEquation](/.charttrendline#excel-javascript/api/excel/-charttrendline-showequation-member)|True if the equation for the trendline is displayed on the chart.| -||[showRSquared](/.charttrendline#excel-javascript/api/excel/-charttrendline-showrsquared-member)|True if the r-squared value for the trendline is displayed on the chart.| -|[ChartTrendlineLabel](/.charttrendlinelabel)|[autoText](/.charttrendlinelabel#excel-javascript/api/excel/-charttrendlinelabel-autotext-member)|Specifies if the trendline label automatically generates appropriate text based on context.| -||[format](/.charttrendlinelabel#excel-javascript/api/excel/-charttrendlinelabel-format-member)|The format of the chart trendline label.| -||[formula](/.charttrendlinelabel#excel-javascript/api/excel/-charttrendlinelabel-formula-member)|String value that represents the formula of the chart trendline label using A1-style notation.| -||[height](/.charttrendlinelabel#excel-javascript/api/excel/-charttrendlinelabel-height-member)|Returns the height, in points, of the chart trendline label.| -||[horizontalAlignment](/.charttrendlinelabel#excel-javascript/api/excel/-charttrendlinelabel-horizontalalignment-member)|Represents the horizontal alignment of the chart trendline label.| -||[left](/.charttrendlinelabel#excel-javascript/api/excel/-charttrendlinelabel-left-member)|Represents the distance, in points, from the left edge of the chart trendline label to the left edge of the chart area.| -||[numberFormat](/.charttrendlinelabel#excel-javascript/api/excel/-charttrendlinelabel-numberformat-member)|String value that represents the format code for the trendline label.| -||[text](/.charttrendlinelabel#excel-javascript/api/excel/-charttrendlinelabel-text-member)|String representing the text of the trendline label on a chart.| -||[textOrientation](/.charttrendlinelabel#excel-javascript/api/excel/-charttrendlinelabel-textorientation-member)|Represents the angle to which the text is oriented for the chart trendline label.| -||[top](/.charttrendlinelabel#excel-javascript/api/excel/-charttrendlinelabel-top-member)|Represents the distance, in points, from the top edge of the chart trendline label to the top of the chart area.| -||[verticalAlignment](/.charttrendlinelabel#excel-javascript/api/excel/-charttrendlinelabel-verticalalignment-member)|Represents the vertical alignment of the chart trendline label.| -||[width](/.charttrendlinelabel#excel-javascript/api/excel/-charttrendlinelabel-width-member)|Returns the width, in points, of the chart trendline label.| -|[ChartTrendlineLabelFormat](/.charttrendlinelabelformat)|[border](/.charttrendlinelabelformat#excel-javascript/api/excel/-charttrendlinelabelformat-border-member)|Specifies the border format, which includes color, linestyle, and weight.| -||[fill](/.charttrendlinelabelformat#excel-javascript/api/excel/-charttrendlinelabelformat-fill-member)|Specifies the fill format of the current chart trendline label.| -||[font](/.charttrendlinelabelformat#excel-javascript/api/excel/-charttrendlinelabelformat-font-member)|Specifies the font attributes (such as font name, font size, and color) for a chart trendline label.| -|[CustomDataValidation](/.customdatavalidation)|[formula](/.customdatavalidation#excel-javascript/api/excel/-customdatavalidation-formula-member)|A custom data validation formula.| -|[DataPivotHierarchy](/.datapivothierarchy)|[field](/.datapivothierarchy#excel-javascript/api/excel/-datapivothierarchy-field-member)|Returns the PivotFields associated with the DataPivotHierarchy.| -||[id](/.datapivothierarchy#excel-javascript/api/excel/-datapivothierarchy-id-member)|ID of the DataPivotHierarchy.| -||[name](/.datapivothierarchy#excel-javascript/api/excel/-datapivothierarchy-name-member)|Name of the DataPivotHierarchy.| -||[numberFormat](/.datapivothierarchy#excel-javascript/api/excel/-datapivothierarchy-numberformat-member)|Number format of the DataPivotHierarchy.| -||[position](/.datapivothierarchy#excel-javascript/api/excel/-datapivothierarchy-position-member)|Position of the DataPivotHierarchy.| -||[setToDefault()](/.datapivothierarchy#excel-javascript/api/excel/-datapivothierarchy-settodefault-member(1))|Reset the DataPivotHierarchy back to its default values.| -||[showAs](/.datapivothierarchy#excel-javascript/api/excel/-datapivothierarchy-showas-member)|Specifies if the data should be shown as a specific summary calculation.| -||[summarizeBy](/.datapivothierarchy#excel-javascript/api/excel/-datapivothierarchy-summarizeby-member)|Specifies if all items of the DataPivotHierarchy are shown.| -|[DataPivotHierarchyCollection](/.datapivothierarchycollection)|[add(pivotHierarchy: Excel.PivotHierarchy)](/.datapivothierarchycollection#excel-javascript/api/excel/-datapivothierarchycollection-add-member(1))|Adds the PivotHierarchy to the current axis.| -||[getCount()](/.datapivothierarchycollection#excel-javascript/api/excel/-datapivothierarchycollection-getcount-member(1))|Gets the number of pivot hierarchies in the collection.| -||[getItem(name: string)](/.datapivothierarchycollection#excel-javascript/api/excel/-datapivothierarchycollection-getitem-member(1))|Gets a DataPivotHierarchy by its name or ID.| -||[getItemOrNullObject(name: string)](/.datapivothierarchycollection#excel-javascript/api/excel/-datapivothierarchycollection-getitemornullobject-member(1))|Gets a DataPivotHierarchy by name.| -||[items](/.datapivothierarchycollection#excel-javascript/api/excel/-datapivothierarchycollection-items-member)|Gets the loaded child items in this collection.| -||[remove(DataPivotHierarchy: Excel.DataPivotHierarchy)](/.datapivothierarchycollection#excel-javascript/api/excel/-datapivothierarchycollection-remove-member(1))|Removes the PivotHierarchy from the current axis.| -|[DataValidation](/.datavalidation)|[clear()](/.datavalidation#excel-javascript/api/excel/-datavalidation-clear-member(1))|Clears the data validation from the current range.| -||[errorAlert](/.datavalidation#excel-javascript/api/excel/-datavalidation-erroralert-member)|Error alert when user enters invalid data.| -||[ignoreBlanks](/.datavalidation#excel-javascript/api/excel/-datavalidation-ignoreblanks-member)|Specifies if data validation will be performed on blank cells.| -||[prompt](/.datavalidation#excel-javascript/api/excel/-datavalidation-prompt-member)|Prompt when users select a cell.| -||[rule](/.datavalidation#excel-javascript/api/excel/-datavalidation-rule-member)|Data validation rule that contains different type of data validation criteria.| -||[type](/.datavalidation#excel-javascript/api/excel/-datavalidation-type-member)|Type of the data validation, see `Excel.DataValidationType` for details.| -||[valid](/.datavalidation#excel-javascript/api/excel/-datavalidation-valid-member)|Represents if all cell values are valid according to the data validation rules.| -|[DataValidationErrorAlert](/.datavalidationerroralert)|[message](/.datavalidationerroralert#excel-javascript/api/excel/-datavalidationerroralert-message-member)|Represents the error alert message.| -||[showAlert](/.datavalidationerroralert#excel-javascript/api/excel/-datavalidationerroralert-showalert-member)|Specifies whether to show an error alert dialog when a user enters invalid data.| -||[style](/.datavalidationerroralert#excel-javascript/api/excel/-datavalidationerroralert-style-member)|The data validation alert type, please see `Excel.DataValidationAlertStyle` for details.| -||[title](/.datavalidationerroralert#excel-javascript/api/excel/-datavalidationerroralert-title-member)|Represents the error alert dialog title.| -|[DataValidationPrompt](/.datavalidationprompt)|[message](/.datavalidationprompt#excel-javascript/api/excel/-datavalidationprompt-message-member)|Specifies the message of the prompt.| -||[showPrompt](/.datavalidationprompt#excel-javascript/api/excel/-datavalidationprompt-showprompt-member)|Specifies if a prompt is shown when a user selects a cell with data validation.| -||[title](/.datavalidationprompt#excel-javascript/api/excel/-datavalidationprompt-title-member)|Specifies the title for the prompt.| -|[DataValidationRule](/.datavalidationrule)|[custom](/.datavalidationrule#excel-javascript/api/excel/-datavalidationrule-custom-member)|Custom data validation criteria.| -||[date](/.datavalidationrule#excel-javascript/api/excel/-datavalidationrule-date-member)|Date data validation criteria.| -||[decimal](/.datavalidationrule#excel-javascript/api/excel/-datavalidationrule-decimal-member)|Decimal data validation criteria.| -||[list](/.datavalidationrule#excel-javascript/api/excel/-datavalidationrule-list-member)|List data validation criteria.| -||[textLength](/.datavalidationrule#excel-javascript/api/excel/-datavalidationrule-textlength-member)|Text length data validation criteria.| -||[time](/.datavalidationrule#excel-javascript/api/excel/-datavalidationrule-time-member)|Time data validation criteria.| -||[wholeNumber](/.datavalidationrule#excel-javascript/api/excel/-datavalidationrule-wholenumber-member)|Whole number data validation criteria.| -|[DateTimeDataValidation](/.datetimedatavalidation)|[formula1](/.datetimedatavalidation#excel-javascript/api/excel/-datetimedatavalidation-formula1-member)|Specifies the right-hand operand when the operator property is set to a binary operator such as GreaterThan (the left-hand operand is the value the user tries to enter in the cell).| -||[formula2](/.datetimedatavalidation#excel-javascript/api/excel/-datetimedatavalidation-formula2-member)|With the ternary operators Between and NotBetween, specifies the upper bound operand.| -||[operator](/.datetimedatavalidation#excel-javascript/api/excel/-datetimedatavalidation-operator-member)|The operator to use for validating the data.| -|[FilterPivotHierarchy](/.filterpivothierarchy)|[enableMultipleFilterItems](/.filterpivothierarchy#excel-javascript/api/excel/-filterpivothierarchy-enablemultiplefilteritems-member)|Determines whether to allow multiple filter items.| -||[fields](/.filterpivothierarchy#excel-javascript/api/excel/-filterpivothierarchy-fields-member)|Returns the PivotFields associated with the FilterPivotHierarchy.| -||[id](/.filterpivothierarchy#excel-javascript/api/excel/-filterpivothierarchy-id-member)|ID of the FilterPivotHierarchy.| -||[name](/.filterpivothierarchy#excel-javascript/api/excel/-filterpivothierarchy-name-member)|Name of the FilterPivotHierarchy.| -||[position](/.filterpivothierarchy#excel-javascript/api/excel/-filterpivothierarchy-position-member)|Position of the FilterPivotHierarchy.| -||[setToDefault()](/.filterpivothierarchy#excel-javascript/api/excel/-filterpivothierarchy-settodefault-member(1))|Reset the FilterPivotHierarchy back to its default values.| -|[FilterPivotHierarchyCollection](/.filterpivothierarchycollection)|[add(pivotHierarchy: Excel.PivotHierarchy)](/.filterpivothierarchycollection#excel-javascript/api/excel/-filterpivothierarchycollection-add-member(1))|Adds the PivotHierarchy to the current axis.| -||[getCount()](/.filterpivothierarchycollection#excel-javascript/api/excel/-filterpivothierarchycollection-getcount-member(1))|Gets the number of pivot hierarchies in the collection.| -||[getItem(name: string)](/.filterpivothierarchycollection#excel-javascript/api/excel/-filterpivothierarchycollection-getitem-member(1))|Gets a FilterPivotHierarchy by its name or ID.| -||[getItemOrNullObject(name: string)](/.filterpivothierarchycollection#excel-javascript/api/excel/-filterpivothierarchycollection-getitemornullobject-member(1))|Gets a FilterPivotHierarchy by name.| -||[items](/.filterpivothierarchycollection#excel-javascript/api/excel/-filterpivothierarchycollection-items-member)|Gets the loaded child items in this collection.| -||[remove(filterPivotHierarchy: Excel.FilterPivotHierarchy)](/.filterpivothierarchycollection#excel-javascript/api/excel/-filterpivothierarchycollection-remove-member(1))|Removes the PivotHierarchy from the current axis.| -|[ListDataValidation](/.listdatavalidation)|[inCellDropDown](/.listdatavalidation#excel-javascript/api/excel/-listdatavalidation-incelldropdown-member)|Specifies whether to display the list in a cell drop-down.| -||[source](/.listdatavalidation#excel-javascript/api/excel/-listdatavalidation-source-member)|Source of the list for data validation| -|[PivotField](/.pivotfield)|[id](/.pivotfield#excel-javascript/api/excel/-pivotfield-id-member)|ID of the PivotField.| -||[items](/.pivotfield#excel-javascript/api/excel/-pivotfield-items-member)|Returns the PivotItems associated with the PivotField.| -||[name](/.pivotfield#excel-javascript/api/excel/-pivotfield-name-member)|Name of the PivotField.| -||[showAllItems](/.pivotfield#excel-javascript/api/excel/-pivotfield-showallitems-member)|Determines whether to show all items of the PivotField.| -||[sortByLabels(sortBy: SortBy)](/.pivotfield#excel-javascript/api/excel/-pivotfield-sortbylabels-member(1))|Sorts the PivotField.| -||[subtotals](/.pivotfield#excel-javascript/api/excel/-pivotfield-subtotals-member)|Subtotals of the PivotField.| -|[PivotFieldCollection](/.pivotfieldcollection)|[getCount()](/.pivotfieldcollection#excel-javascript/api/excel/-pivotfieldcollection-getcount-member(1))|Gets the number of pivot fields in the collection.| -||[getItem(name: string)](/.pivotfieldcollection#excel-javascript/api/excel/-pivotfieldcollection-getitem-member(1))|Gets a PivotField by its name or ID.| -||[getItemOrNullObject(name: string)](/.pivotfieldcollection#excel-javascript/api/excel/-pivotfieldcollection-getitemornullobject-member(1))|Gets a PivotField by name.| -||[items](/.pivotfieldcollection#excel-javascript/api/excel/-pivotfieldcollection-items-member)|Gets the loaded child items in this collection.| -|[PivotHierarchy](/.pivothierarchy)|[fields](/.pivothierarchy#excel-javascript/api/excel/-pivothierarchy-fields-member)|Returns the PivotFields associated with the PivotHierarchy.| -||[id](/.pivothierarchy#excel-javascript/api/excel/-pivothierarchy-id-member)|ID of the PivotHierarchy.| -||[name](/.pivothierarchy#excel-javascript/api/excel/-pivothierarchy-name-member)|Name of the PivotHierarchy.| -|[PivotHierarchyCollection](/.pivothierarchycollection)|[getCount()](/.pivothierarchycollection#excel-javascript/api/excel/-pivothierarchycollection-getcount-member(1))|Gets the number of pivot hierarchies in the collection.| -||[getItem(name: string)](/.pivothierarchycollection#excel-javascript/api/excel/-pivothierarchycollection-getitem-member(1))|Gets a PivotHierarchy by its name or ID.| -||[getItemOrNullObject(name: string)](/.pivothierarchycollection#excel-javascript/api/excel/-pivothierarchycollection-getitemornullobject-member(1))|Gets a PivotHierarchy by name.| -||[items](/.pivothierarchycollection#excel-javascript/api/excel/-pivothierarchycollection-items-member)|Gets the loaded child items in this collection.| -|[PivotItem](/.pivotitem)|[id](/.pivotitem#excel-javascript/api/excel/-pivotitem-id-member)|ID of the PivotItem.| -||[isExpanded](/.pivotitem#excel-javascript/api/excel/-pivotitem-isexpanded-member)|Determines whether the item is expanded to show child items or if it's collapsed and child items are hidden.| -||[name](/.pivotitem#excel-javascript/api/excel/-pivotitem-name-member)|Name of the PivotItem.| -||[visible](/.pivotitem#excel-javascript/api/excel/-pivotitem-visible-member)|Specifies if the PivotItem is visible.| -|[PivotItemCollection](/.pivotitemcollection)|[getCount()](/.pivotitemcollection#excel-javascript/api/excel/-pivotitemcollection-getcount-member(1))|Gets the number of PivotItems in the collection.| -||[getItem(name: string)](/.pivotitemcollection#excel-javascript/api/excel/-pivotitemcollection-getitem-member(1))|Gets a PivotItem by its name or ID.| -||[getItemOrNullObject(name: string)](/.pivotitemcollection#excel-javascript/api/excel/-pivotitemcollection-getitemornullobject-member(1))|Gets a PivotItem by name.| -||[items](/.pivotitemcollection#excel-javascript/api/excel/-pivotitemcollection-items-member)|Gets the loaded child items in this collection.| -|[PivotLayout](/.pivotlayout)|[getColumnLabelRange()](/.pivotlayout#excel-javascript/api/excel/-pivotlayout-getcolumnlabelrange-member(1))|Returns the range where the PivotTable's column labels reside.| -||[getDataBodyRange()](/.pivotlayout#excel-javascript/api/excel/-pivotlayout-getdatabodyrange-member(1))|Returns the range where the PivotTable's data values reside.| -||[getFilterAxisRange()](/.pivotlayout#excel-javascript/api/excel/-pivotlayout-getfilteraxisrange-member(1))|Returns the range of the PivotTable's filter area.| -||[getRange()](/.pivotlayout#excel-javascript/api/excel/-pivotlayout-getrange-member(1))|Returns the range the PivotTable exists on, excluding the filter area.| -||[getRowLabelRange()](/.pivotlayout#excel-javascript/api/excel/-pivotlayout-getrowlabelrange-member(1))|Returns the range where the PivotTable's row labels reside.| -||[layoutType](/.pivotlayout#excel-javascript/api/excel/-pivotlayout-layouttype-member)|This property indicates the PivotLayoutType of all fields on the PivotTable.| -||[showColumnGrandTotals](/.pivotlayout#excel-javascript/api/excel/-pivotlayout-showcolumngrandtotals-member)|Specifies if the PivotTable report shows grand totals for columns.| -||[showRowGrandTotals](/.pivotlayout#excel-javascript/api/excel/-pivotlayout-showrowgrandtotals-member)|Specifies if the PivotTable report shows grand totals for rows.| -||[subtotalLocation](/.pivotlayout#excel-javascript/api/excel/-pivotlayout-subtotallocation-member)|This property indicates the `SubtotalLocationType` of all fields on the PivotTable.| -|[PivotTable](/.pivottable)|[columnHierarchies](/.pivottable#excel-javascript/api/excel/-pivottable-columnhierarchies-member)|The Column Pivot Hierarchies of the PivotTable.| -||[dataHierarchies](/.pivottable#excel-javascript/api/excel/-pivottable-datahierarchies-member)|The Data Pivot Hierarchies of the PivotTable.| -||[delete()](/.pivottable#excel-javascript/api/excel/-pivottable-delete-member(1))|Deletes the PivotTable.| -||[filterHierarchies](/.pivottable#excel-javascript/api/excel/-pivottable-filterhierarchies-member)|The Filter Pivot Hierarchies of the PivotTable.| -||[hierarchies](/.pivottable#excel-javascript/api/excel/-pivottable-hierarchies-member)|The Pivot Hierarchies of the PivotTable.| -||[layout](/.pivottable#excel-javascript/api/excel/-pivottable-layout-member)|The PivotLayout describing the layout and visual structure of the PivotTable.| -||[rowHierarchies](/.pivottable#excel-javascript/api/excel/-pivottable-rowhierarchies-member)|The Row Pivot Hierarchies of the PivotTable.| -|[PivotTableCollection](/.pivottablecollection)|[add(name: string, source: Range \| string \| Table, destination: Range \| string)](/.pivottablecollection#excel-javascript/api/excel/-pivottablecollection-add-member(1))|Add a PivotTable based on the specified source data and insert it at the top-left cell of the destination range.| -|[Range](/.range)|[dataValidation](/.range#excel-javascript/api/excel/-range-datavalidation-member)|Returns a data validation object.| -|[RowColumnPivotHierarchy](/.rowcolumnpivothierarchy)|[fields](/.rowcolumnpivothierarchy#excel-javascript/api/excel/-rowcolumnpivothierarchy-fields-member)|Returns the PivotFields associated with the RowColumnPivotHierarchy.| -||[id](/.rowcolumnpivothierarchy#excel-javascript/api/excel/-rowcolumnpivothierarchy-id-member)|ID of the RowColumnPivotHierarchy.| -||[name](/.rowcolumnpivothierarchy#excel-javascript/api/excel/-rowcolumnpivothierarchy-name-member)|Name of the RowColumnPivotHierarchy.| -||[position](/.rowcolumnpivothierarchy#excel-javascript/api/excel/-rowcolumnpivothierarchy-position-member)|Position of the RowColumnPivotHierarchy.| -||[setToDefault()](/.rowcolumnpivothierarchy#excel-javascript/api/excel/-rowcolumnpivothierarchy-settodefault-member(1))|Reset the RowColumnPivotHierarchy back to its default values.| -|[RowColumnPivotHierarchyCollection](/.rowcolumnpivothierarchycollection)|[add(pivotHierarchy: Excel.PivotHierarchy)](/.rowcolumnpivothierarchycollection#excel-javascript/api/excel/-rowcolumnpivothierarchycollection-add-member(1))|Adds the PivotHierarchy to the current axis.| -||[getCount()](/.rowcolumnpivothierarchycollection#excel-javascript/api/excel/-rowcolumnpivothierarchycollection-getcount-member(1))|Gets the number of pivot hierarchies in the collection.| -||[getItem(name: string)](/.rowcolumnpivothierarchycollection#excel-javascript/api/excel/-rowcolumnpivothierarchycollection-getitem-member(1))|Gets a RowColumnPivotHierarchy by its name or ID.| -||[getItemOrNullObject(name: string)](/.rowcolumnpivothierarchycollection#excel-javascript/api/excel/-rowcolumnpivothierarchycollection-getitemornullobject-member(1))|Gets a RowColumnPivotHierarchy by name.| -||[items](/.rowcolumnpivothierarchycollection#excel-javascript/api/excel/-rowcolumnpivothierarchycollection-items-member)|Gets the loaded child items in this collection.| -||[remove(rowColumnPivotHierarchy: Excel.RowColumnPivotHierarchy)](/.rowcolumnpivothierarchycollection#excel-javascript/api/excel/-rowcolumnpivothierarchycollection-remove-member(1))|Removes the PivotHierarchy from the current axis.| -|[Runtime](/.runtime)|[enableEvents](/.runtime#excel-javascript/api/excel/-runtime-enableevents-member)|Toggle JavaScript events in the current task pane or content add-in.| -|[ShowAsRule](/.showasrule)|[baseField](/.showasrule#excel-javascript/api/excel/-showasrule-basefield-member)|The PivotField to base the `ShowAs` calculation on, if applicable according to the `ShowAsCalculation` type, else `null`.| -||[baseItem](/.showasrule#excel-javascript/api/excel/-showasrule-baseitem-member)|The item to base the `ShowAs` calculation on, if applicable according to the `ShowAsCalculation` type, else `null`.| -||[calculation](/.showasrule#excel-javascript/api/excel/-showasrule-calculation-member)|The `ShowAs` calculation to use for the PivotField.| -|[Style](/.style)|[autoIndent](/.style#excel-javascript/api/excel/-style-autoindent-member)|Specifies if text is automatically indented when the text alignment in a cell is set to equal distribution.| -||[textOrientation](/.style#excel-javascript/api/excel/-style-textorientation-member)|The text orientation for the style.| -|[Subtotals](/.subtotals)|[automatic](/.subtotals#excel-javascript/api/excel/-subtotals-automatic-member)|If `Automatic` is set to `true`, then all other values will be ignored when setting the `Subtotals`.| -||[average](/.subtotals#excel-javascript/api/excel/-subtotals-average-member)|| -||[count](/.subtotals#excel-javascript/api/excel/-subtotals-count-member)|| -||[countNumbers](/.subtotals#excel-javascript/api/excel/-subtotals-countnumbers-member)|| -||[max](/.subtotals#excel-javascript/api/excel/-subtotals-max-member)|| -||[min](/.subtotals#excel-javascript/api/excel/-subtotals-min-member)|| -||[product](/.subtotals#excel-javascript/api/excel/-subtotals-product-member)|| -||[standardDeviation](/.subtotals#excel-javascript/api/excel/-subtotals-standarddeviation-member)|| -||[standardDeviationP](/.subtotals#excel-javascript/api/excel/-subtotals-standarddeviationp-member)|| -||[sum](/.subtotals#excel-javascript/api/excel/-subtotals-sum-member)|| -||[variance](/.subtotals#excel-javascript/api/excel/-subtotals-variance-member)|| -||[varianceP](/.subtotals#excel-javascript/api/excel/-subtotals-variancep-member)|| -|[Table](/.table)|[legacyId](/.table#excel-javascript/api/excel/-table-legacyid-member)|Returns a numeric ID.| -|[TableChangedEventArgs](/.tablechangedeventargs)|[getRange(ctx: Excel.RequestContext)](/.tablechangedeventargs#excel-javascript/api/excel/-tablechangedeventargs-getrange-member(1))|Gets the range that represents the changed area of a table on a specific worksheet.| -||[getRangeOrNullObject(ctx: Excel.RequestContext)](/.tablechangedeventargs#excel-javascript/api/excel/-tablechangedeventargs-getrangeornullobject-member(1))|Gets the range that represents the changed area of a table on a specific worksheet.| -|[Workbook](/.workbook)|[readOnly](/.workbook#excel-javascript/api/excel/-workbook-readonly-member)|Returns `true` if the workbook is open in read-only mode.| -|[WorkbookCreated](/.workbookcreated)||| -|[Worksheet](/.worksheet)|[onCalculated](/.worksheet#excel-javascript/api/excel/-worksheet-oncalculated-member)|Occurs when the worksheet is calculated.| -||[showGridlines](/.worksheet#excel-javascript/api/excel/-worksheet-showgridlines-member)|Specifies if gridlines are visible to the user.| -||[showHeadings](/.worksheet#excel-javascript/api/excel/-worksheet-showheadings-member)|Specifies if headings are visible to the user.| -|[WorksheetCalculatedEventArgs](/.worksheetcalculatedeventargs)|[type](/.worksheetcalculatedeventargs#excel-javascript/api/excel/-worksheetcalculatedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/.worksheetcalculatedeventargs#excel-javascript/api/excel/-worksheetcalculatedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the calculation occurred.| -|[WorksheetChangedEventArgs](/.worksheetchangedeventargs)|[getRange(ctx: Excel.RequestContext)](/.worksheetchangedeventargs#excel-javascript/api/excel/-worksheetchangedeventargs-getrange-member(1))|Gets the range that represents the changed area of a specific worksheet.| -||[getRangeOrNullObject(ctx: Excel.RequestContext)](/.worksheetchangedeventargs#excel-javascript/api/excel/-worksheetchangedeventargs-getrangeornullobject-member(1))|Gets the range that represents the changed area of a specific worksheet.| -|[WorksheetCollection](/.worksheetcollection)|[onCalculated](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-oncalculated-member)|Occurs when any worksheet in the workbook is calculated.| +|*global*|[createWorkbook(base64?: string)](/javascript/api/excel/#excel-excel-createworkbook-function(1))|Creates and opens a new workbook.| +|[BasicDataValidation](/javascript/api/excel/excel.basicdatavalidation)|[formula1](/javascript/api/excel/excel.basicdatavalidation#excel-excel-basicdatavalidation-formula1-member)|Specifies the right-hand operand when the operator property is set to a binary operator such as GreaterThan (the left-hand operand is the value the user tries to enter in the cell).| +||[formula2](/javascript/api/excel/excel.basicdatavalidation#excel-excel-basicdatavalidation-formula2-member)|With the ternary operators Between and NotBetween, specifies the upper bound operand.| +||[operator](/javascript/api/excel/excel.basicdatavalidation#excel-excel-basicdatavalidation-operator-member)|The operator to use for validating the data.| +|[Chart](/javascript/api/excel/excel.chart)|[categoryLabelLevel](/javascript/api/excel/excel.chart#excel-excel-chart-categorylabellevel-member)|Specifies a chart category label level enumeration constant, referring to the level of the source category labels.| +||[displayBlanksAs](/javascript/api/excel/excel.chart#excel-excel-chart-displayblanksas-member)|Specifies the way that blank cells are plotted on a chart.| +||[onActivated](/javascript/api/excel/excel.chart#excel-excel-chart-onactivated-member)|Occurs when the chart is activated.| +||[onDeactivated](/javascript/api/excel/excel.chart#excel-excel-chart-ondeactivated-member)|Occurs when the chart is deactivated.| +||[plotArea](/javascript/api/excel/excel.chart#excel-excel-chart-plotarea-member)|Represents the plot area for the chart.| +||[plotBy](/javascript/api/excel/excel.chart#excel-excel-chart-plotby-member)|Specifies the way columns or rows are used as data series on the chart.| +||[plotVisibleOnly](/javascript/api/excel/excel.chart#excel-excel-chart-plotvisibleonly-member)|True if only visible cells are plotted.| +||[seriesNameLevel](/javascript/api/excel/excel.chart#excel-excel-chart-seriesnamelevel-member)|Specifies a chart series name level enumeration constant, referring to the level of the source series names.| +||[showDataLabelsOverMaximum](/javascript/api/excel/excel.chart#excel-excel-chart-showdatalabelsovermaximum-member)|Specifies whether to show the data labels when the value is greater than the maximum value on the value axis.| +||[style](/javascript/api/excel/excel.chart#excel-excel-chart-style-member)|Specifies the chart style for the chart.| +|[ChartActivatedEventArgs](/javascript/api/excel/excel.chartactivatedeventargs)|[chartId](/javascript/api/excel/excel.chartactivatedeventargs#excel-excel-chartactivatedeventargs-chartid-member)|Gets the ID of the chart that is activated.| +||[type](/javascript/api/excel/excel.chartactivatedeventargs#excel-excel-chartactivatedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/javascript/api/excel/excel.chartactivatedeventargs#excel-excel-chartactivatedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the chart is activated.| +|[ChartAddedEventArgs](/javascript/api/excel/excel.chartaddedeventargs)|[chartId](/javascript/api/excel/excel.chartaddedeventargs#excel-excel-chartaddedeventargs-chartid-member)|Gets the ID of the chart that is added to the worksheet.| +||[source](/javascript/api/excel/excel.chartaddedeventargs#excel-excel-chartaddedeventargs-source-member)|Gets the source of the event.| +||[type](/javascript/api/excel/excel.chartaddedeventargs#excel-excel-chartaddedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/javascript/api/excel/excel.chartaddedeventargs#excel-excel-chartaddedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the chart is added.| +|[ChartAxis](/javascript/api/excel/excel.chartaxis)|[alignment](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-alignment-member)|Specifies the alignment for the specified axis tick label.| +||[isBetweenCategories](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-isbetweencategories-member)|Specifies if the value axis crosses the category axis between categories.| +||[multiLevel](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-multilevel-member)|Specifies if an axis is multilevel.| +||[numberFormat](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-numberformat-member)|Specifies the format code for the axis tick label.| +||[offset](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-offset-member)|Specifies the distance between the levels of labels, and the distance between the first level and the axis line.| +||[position](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-position-member)|Specifies the specified axis position where the other axis crosses.| +||[positionAt](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-positionat-member)|Specifies the axis position where the other axis crosses.| +||[setPositionAt(value: number)](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-setpositionat-member(1))|Sets the specified axis position where the other axis crosses.| +||[textOrientation](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-textorientation-member)|Specifies the angle to which the text is oriented for the chart axis tick label.| +|[ChartAxisFormat](/javascript/api/excel/excel.chartaxisformat)|[fill](/javascript/api/excel/excel.chartaxisformat#excel-excel-chartaxisformat-fill-member)|Specifies chart fill formatting.| +|[ChartAxisTitle](/javascript/api/excel/excel.chartaxistitle)|[setFormula(formula: string)](/javascript/api/excel/excel.chartaxistitle#excel-excel-chartaxistitle-setformula-member(1))|A string value that represents the formula of chart axis title using A1-style notation.| +|[ChartAxisTitleFormat](/javascript/api/excel/excel.chartaxistitleformat)|[border](/javascript/api/excel/excel.chartaxistitleformat#excel-excel-chartaxistitleformat-border-member)|Specifies the chart axis title's border format, which includes color, linestyle, and weight.| +||[fill](/javascript/api/excel/excel.chartaxistitleformat#excel-excel-chartaxistitleformat-fill-member)|Specifies the chart axis title's fill formatting.| +|[ChartBorder](/javascript/api/excel/excel.chartborder)|[clear()](/javascript/api/excel/excel.chartborder#excel-excel-chartborder-clear-member(1))|Clear the border format of a chart element.| +|[ChartCollection](/javascript/api/excel/excel.chartcollection)|[onActivated](/javascript/api/excel/excel.chartcollection#excel-excel-chartcollection-onactivated-member)|Occurs when a chart is activated.| +||[onAdded](/javascript/api/excel/excel.chartcollection#excel-excel-chartcollection-onadded-member)|Occurs when a new chart is added to the worksheet.| +||[onDeactivated](/javascript/api/excel/excel.chartcollection#excel-excel-chartcollection-ondeactivated-member)|Occurs when a chart is deactivated.| +||[onDeleted](/javascript/api/excel/excel.chartcollection#excel-excel-chartcollection-ondeleted-member)|Occurs when a chart is deleted.| +|[ChartDataLabel](/javascript/api/excel/excel.chartdatalabel)|[autoText](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-autotext-member)|Specifies if the data label automatically generates appropriate text based on context.| +||[format](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-format-member)|Represents the format of chart data label.| +||[formula](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-formula-member)|String value that represents the formula of chart data label using A1-style notation.| +||[height](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-height-member)|Returns the height, in points, of the chart data label.| +||[horizontalAlignment](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-horizontalalignment-member)|Represents the horizontal alignment for chart data label.| +||[left](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-left-member)|Represents the distance, in points, from the left edge of chart data label to the left edge of chart area.| +||[numberFormat](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-numberformat-member)|Specifies the format code for data label.| +||[text](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-text-member)|String representing the text of the data label on a chart.| +||[textOrientation](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-textorientation-member)|Represents the angle to which the text is oriented for the chart data label.| +||[top](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-top-member)|Represents the distance, in points, from the top edge of chart data label to the top of chart area.| +||[verticalAlignment](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-verticalalignment-member)|Represents the vertical alignment of chart data label.| +||[width](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-width-member)|Returns the width, in points, of the chart data label.| +|[ChartDataLabelFormat](/javascript/api/excel/excel.chartdatalabelformat)|[border](/javascript/api/excel/excel.chartdatalabelformat#excel-excel-chartdatalabelformat-border-member)|Represents the border format, which includes color, linestyle, and weight.| +|[ChartDataLabels](/javascript/api/excel/excel.chartdatalabels)|[autoText](/javascript/api/excel/excel.chartdatalabels#excel-excel-chartdatalabels-autotext-member)|Specifies if data labels automatically generate appropriate text based on context.| +||[horizontalAlignment](/javascript/api/excel/excel.chartdatalabels#excel-excel-chartdatalabels-horizontalalignment-member)|Specifies the horizontal alignment for chart data label.| +||[numberFormat](/javascript/api/excel/excel.chartdatalabels#excel-excel-chartdatalabels-numberformat-member)|Specifies the format code for data labels.| +||[textOrientation](/javascript/api/excel/excel.chartdatalabels#excel-excel-chartdatalabels-textorientation-member)|Represents the angle to which the text is oriented for data labels.| +||[verticalAlignment](/javascript/api/excel/excel.chartdatalabels#excel-excel-chartdatalabels-verticalalignment-member)|Represents the vertical alignment of chart data label.| +|[ChartDeactivatedEventArgs](/javascript/api/excel/excel.chartdeactivatedeventargs)|[chartId](/javascript/api/excel/excel.chartdeactivatedeventargs#excel-excel-chartdeactivatedeventargs-chartid-member)|Gets the ID of the chart that is deactivated.| +||[type](/javascript/api/excel/excel.chartdeactivatedeventargs#excel-excel-chartdeactivatedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/javascript/api/excel/excel.chartdeactivatedeventargs#excel-excel-chartdeactivatedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the chart is deactivated.| +|[ChartDeletedEventArgs](/javascript/api/excel/excel.chartdeletedeventargs)|[chartId](/javascript/api/excel/excel.chartdeletedeventargs#excel-excel-chartdeletedeventargs-chartid-member)|Gets the ID of the chart that is deleted from the worksheet.| +||[source](/javascript/api/excel/excel.chartdeletedeventargs#excel-excel-chartdeletedeventargs-source-member)|Gets the source of the event.| +||[type](/javascript/api/excel/excel.chartdeletedeventargs#excel-excel-chartdeletedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/javascript/api/excel/excel.chartdeletedeventargs#excel-excel-chartdeletedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the chart is deleted.| +|[ChartLegendEntry](/javascript/api/excel/excel.chartlegendentry)|[height](/javascript/api/excel/excel.chartlegendentry#excel-excel-chartlegendentry-height-member)|Specifies the height of the legend entry on the chart legend.| +||[index](/javascript/api/excel/excel.chartlegendentry#excel-excel-chartlegendentry-index-member)|Specifies the index of the legend entry in the chart legend.| +||[left](/javascript/api/excel/excel.chartlegendentry#excel-excel-chartlegendentry-left-member)|Specifies the left value of a chart legend entry.| +||[top](/javascript/api/excel/excel.chartlegendentry#excel-excel-chartlegendentry-top-member)|Specifies the top of a chart legend entry.| +||[width](/javascript/api/excel/excel.chartlegendentry#excel-excel-chartlegendentry-width-member)|Represents the width of the legend entry on the chart Legend.| +|[ChartLegendFormat](/javascript/api/excel/excel.chartlegendformat)|[border](/javascript/api/excel/excel.chartlegendformat#excel-excel-chartlegendformat-border-member)|Represents the border format, which includes color, linestyle, and weight.| +|[ChartPlotArea](/javascript/api/excel/excel.chartplotarea)|[format](/javascript/api/excel/excel.chartplotarea#excel-excel-chartplotarea-format-member)|Specifies the formatting of a chart plot area.| +||[height](/javascript/api/excel/excel.chartplotarea#excel-excel-chartplotarea-height-member)|Specifies the height value of a plot area.| +||[insideHeight](/javascript/api/excel/excel.chartplotarea#excel-excel-chartplotarea-insideheight-member)|Specifies the inside height value of a plot area.| +||[insideLeft](/javascript/api/excel/excel.chartplotarea#excel-excel-chartplotarea-insideleft-member)|Specifies the inside left value of a plot area.| +||[insideTop](/javascript/api/excel/excel.chartplotarea#excel-excel-chartplotarea-insidetop-member)|Specifies the inside top value of a plot area.| +||[insideWidth](/javascript/api/excel/excel.chartplotarea#excel-excel-chartplotarea-insidewidth-member)|Specifies the inside width value of a plot area.| +||[left](/javascript/api/excel/excel.chartplotarea#excel-excel-chartplotarea-left-member)|Specifies the left value of a plot area.| +||[position](/javascript/api/excel/excel.chartplotarea#excel-excel-chartplotarea-position-member)|Specifies the position of a plot area.| +||[top](/javascript/api/excel/excel.chartplotarea#excel-excel-chartplotarea-top-member)|Specifies the top value of a plot area.| +||[width](/javascript/api/excel/excel.chartplotarea#excel-excel-chartplotarea-width-member)|Specifies the width value of a plot area.| +|[ChartPlotAreaFormat](/javascript/api/excel/excel.chartplotareaformat)|[border](/javascript/api/excel/excel.chartplotareaformat#excel-excel-chartplotareaformat-border-member)|Specifies the border attributes of a chart plot area.| +||[fill](/javascript/api/excel/excel.chartplotareaformat#excel-excel-chartplotareaformat-fill-member)|Specifies the fill format of an object, which includes background formatting information.| +|[ChartSeries](/javascript/api/excel/excel.chartseries)|[axisGroup](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-axisgroup-member)|Specifies the group for the specified series.| +||[dataLabels](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-datalabels-member)|Represents a collection of all data labels in the series.| +||[explosion](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-explosion-member)|Specifies the explosion value for a pie-chart or doughnut-chart slice.| +||[firstSliceAngle](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-firstsliceangle-member)|Specifies the angle of the first pie-chart or doughnut-chart slice, in degrees (clockwise from vertical).| +||[invertIfNegative](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-invertifnegative-member)|True if Excel inverts the pattern in the item when it corresponds to a negative number.| +||[overlap](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-overlap-member)|Specifies how bars and columns are positioned.| +||[secondPlotSize](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-secondplotsize-member)|Specifies the size of the secondary section of either a pie-of-pie chart or a bar-of-pie chart, as a percentage of the size of the primary pie.| +||[splitType](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-splittype-member)|Specifies the way the two sections of either a pie-of-pie chart or a bar-of-pie chart are split.| +||[varyByCategories](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-varybycategories-member)|True if Excel assigns a different color or pattern to each data marker.| +|[ChartTrendline](/javascript/api/excel/excel.charttrendline)|[backwardPeriod](/javascript/api/excel/excel.charttrendline#excel-excel-charttrendline-backwardperiod-member)|Represents the number of periods that the trendline extends backward.| +||[forwardPeriod](/javascript/api/excel/excel.charttrendline#excel-excel-charttrendline-forwardperiod-member)|Represents the number of periods that the trendline extends forward.| +||[label](/javascript/api/excel/excel.charttrendline#excel-excel-charttrendline-label-member)|Represents the label of a chart trendline.| +||[showEquation](/javascript/api/excel/excel.charttrendline#excel-excel-charttrendline-showequation-member)|True if the equation for the trendline is displayed on the chart.| +||[showRSquared](/javascript/api/excel/excel.charttrendline#excel-excel-charttrendline-showrsquared-member)|True if the r-squared value for the trendline is displayed on the chart.| +|[ChartTrendlineLabel](/javascript/api/excel/excel.charttrendlinelabel)|[autoText](/javascript/api/excel/excel.charttrendlinelabel#excel-excel-charttrendlinelabel-autotext-member)|Specifies if the trendline label automatically generates appropriate text based on context.| +||[format](/javascript/api/excel/excel.charttrendlinelabel#excel-excel-charttrendlinelabel-format-member)|The format of the chart trendline label.| +||[formula](/javascript/api/excel/excel.charttrendlinelabel#excel-excel-charttrendlinelabel-formula-member)|String value that represents the formula of the chart trendline label using A1-style notation.| +||[height](/javascript/api/excel/excel.charttrendlinelabel#excel-excel-charttrendlinelabel-height-member)|Returns the height, in points, of the chart trendline label.| +||[horizontalAlignment](/javascript/api/excel/excel.charttrendlinelabel#excel-excel-charttrendlinelabel-horizontalalignment-member)|Represents the horizontal alignment of the chart trendline label.| +||[left](/javascript/api/excel/excel.charttrendlinelabel#excel-excel-charttrendlinelabel-left-member)|Represents the distance, in points, from the left edge of the chart trendline label to the left edge of the chart area.| +||[numberFormat](/javascript/api/excel/excel.charttrendlinelabel#excel-excel-charttrendlinelabel-numberformat-member)|String value that represents the format code for the trendline label.| +||[text](/javascript/api/excel/excel.charttrendlinelabel#excel-excel-charttrendlinelabel-text-member)|String representing the text of the trendline label on a chart.| +||[textOrientation](/javascript/api/excel/excel.charttrendlinelabel#excel-excel-charttrendlinelabel-textorientation-member)|Represents the angle to which the text is oriented for the chart trendline label.| +||[top](/javascript/api/excel/excel.charttrendlinelabel#excel-excel-charttrendlinelabel-top-member)|Represents the distance, in points, from the top edge of the chart trendline label to the top of the chart area.| +||[verticalAlignment](/javascript/api/excel/excel.charttrendlinelabel#excel-excel-charttrendlinelabel-verticalalignment-member)|Represents the vertical alignment of the chart trendline label.| +||[width](/javascript/api/excel/excel.charttrendlinelabel#excel-excel-charttrendlinelabel-width-member)|Returns the width, in points, of the chart trendline label.| +|[ChartTrendlineLabelFormat](/javascript/api/excel/excel.charttrendlinelabelformat)|[border](/javascript/api/excel/excel.charttrendlinelabelformat#excel-excel-charttrendlinelabelformat-border-member)|Specifies the border format, which includes color, linestyle, and weight.| +||[fill](/javascript/api/excel/excel.charttrendlinelabelformat#excel-excel-charttrendlinelabelformat-fill-member)|Specifies the fill format of the current chart trendline label.| +||[font](/javascript/api/excel/excel.charttrendlinelabelformat#excel-excel-charttrendlinelabelformat-font-member)|Specifies the font attributes (such as font name, font size, and color) for a chart trendline label.| +|[CustomDataValidation](/javascript/api/excel/excel.customdatavalidation)|[formula](/javascript/api/excel/excel.customdatavalidation#excel-excel-customdatavalidation-formula-member)|A custom data validation formula.| +|[DataPivotHierarchy](/javascript/api/excel/excel.datapivothierarchy)|[field](/javascript/api/excel/excel.datapivothierarchy#excel-excel-datapivothierarchy-field-member)|Returns the PivotFields associated with the DataPivotHierarchy.| +||[id](/javascript/api/excel/excel.datapivothierarchy#excel-excel-datapivothierarchy-id-member)|ID of the DataPivotHierarchy.| +||[name](/javascript/api/excel/excel.datapivothierarchy#excel-excel-datapivothierarchy-name-member)|Name of the DataPivotHierarchy.| +||[numberFormat](/javascript/api/excel/excel.datapivothierarchy#excel-excel-datapivothierarchy-numberformat-member)|Number format of the DataPivotHierarchy.| +||[position](/javascript/api/excel/excel.datapivothierarchy#excel-excel-datapivothierarchy-position-member)|Position of the DataPivotHierarchy.| +||[setToDefault()](/javascript/api/excel/excel.datapivothierarchy#excel-excel-datapivothierarchy-settodefault-member(1))|Reset the DataPivotHierarchy back to its default values.| +||[showAs](/javascript/api/excel/excel.datapivothierarchy#excel-excel-datapivothierarchy-showas-member)|Specifies if the data should be shown as a specific summary calculation.| +||[summarizeBy](/javascript/api/excel/excel.datapivothierarchy#excel-excel-datapivothierarchy-summarizeby-member)|Specifies if all items of the DataPivotHierarchy are shown.| +|[DataPivotHierarchyCollection](/javascript/api/excel/excel.datapivothierarchycollection)|[add(pivotHierarchy: Excel.PivotHierarchy)](/javascript/api/excel/excel.datapivothierarchycollection#excel-excel-datapivothierarchycollection-add-member(1))|Adds the PivotHierarchy to the current axis.| +||[getCount()](/javascript/api/excel/excel.datapivothierarchycollection#excel-excel-datapivothierarchycollection-getcount-member(1))|Gets the number of pivot hierarchies in the collection.| +||[getItem(name: string)](/javascript/api/excel/excel.datapivothierarchycollection#excel-excel-datapivothierarchycollection-getitem-member(1))|Gets a DataPivotHierarchy by its name or ID.| +||[getItemOrNullObject(name: string)](/javascript/api/excel/excel.datapivothierarchycollection#excel-excel-datapivothierarchycollection-getitemornullobject-member(1))|Gets a DataPivotHierarchy by name.| +||[items](/javascript/api/excel/excel.datapivothierarchycollection#excel-excel-datapivothierarchycollection-items-member)|Gets the loaded child items in this collection.| +||[remove(DataPivotHierarchy: Excel.DataPivotHierarchy)](/javascript/api/excel/excel.datapivothierarchycollection#excel-excel-datapivothierarchycollection-remove-member(1))|Removes the PivotHierarchy from the current axis.| +|[DataValidation](/javascript/api/excel/excel.datavalidation)|[clear()](/javascript/api/excel/excel.datavalidation#excel-excel-datavalidation-clear-member(1))|Clears the data validation from the current range.| +||[errorAlert](/javascript/api/excel/excel.datavalidation#excel-excel-datavalidation-erroralert-member)|Error alert when user enters invalid data.| +||[ignoreBlanks](/javascript/api/excel/excel.datavalidation#excel-excel-datavalidation-ignoreblanks-member)|Specifies if data validation will be performed on blank cells.| +||[prompt](/javascript/api/excel/excel.datavalidation#excel-excel-datavalidation-prompt-member)|Prompt when users select a cell.| +||[rule](/javascript/api/excel/excel.datavalidation#excel-excel-datavalidation-rule-member)|Data validation rule that contains different type of data validation criteria.| +||[type](/javascript/api/excel/excel.datavalidation#excel-excel-datavalidation-type-member)|Type of the data validation, see `Excel.DataValidationType` for details.| +||[valid](/javascript/api/excel/excel.datavalidation#excel-excel-datavalidation-valid-member)|Represents if all cell values are valid according to the data validation rules.| +|[DataValidationErrorAlert](/javascript/api/excel/excel.datavalidationerroralert)|[message](/javascript/api/excel/excel.datavalidationerroralert#excel-excel-datavalidationerroralert-message-member)|Represents the error alert message.| +||[showAlert](/javascript/api/excel/excel.datavalidationerroralert#excel-excel-datavalidationerroralert-showalert-member)|Specifies whether to show an error alert dialog when a user enters invalid data.| +||[style](/javascript/api/excel/excel.datavalidationerroralert#excel-excel-datavalidationerroralert-style-member)|The data validation alert type, please see `Excel.DataValidationAlertStyle` for details.| +||[title](/javascript/api/excel/excel.datavalidationerroralert#excel-excel-datavalidationerroralert-title-member)|Represents the error alert dialog title.| +|[DataValidationPrompt](/javascript/api/excel/excel.datavalidationprompt)|[message](/javascript/api/excel/excel.datavalidationprompt#excel-excel-datavalidationprompt-message-member)|Specifies the message of the prompt.| +||[showPrompt](/javascript/api/excel/excel.datavalidationprompt#excel-excel-datavalidationprompt-showprompt-member)|Specifies if a prompt is shown when a user selects a cell with data validation.| +||[title](/javascript/api/excel/excel.datavalidationprompt#excel-excel-datavalidationprompt-title-member)|Specifies the title for the prompt.| +|[DataValidationRule](/javascript/api/excel/excel.datavalidationrule)|[custom](/javascript/api/excel/excel.datavalidationrule#excel-excel-datavalidationrule-custom-member)|Custom data validation criteria.| +||[date](/javascript/api/excel/excel.datavalidationrule#excel-excel-datavalidationrule-date-member)|Date data validation criteria.| +||[decimal](/javascript/api/excel/excel.datavalidationrule#excel-excel-datavalidationrule-decimal-member)|Decimal data validation criteria.| +||[list](/javascript/api/excel/excel.datavalidationrule#excel-excel-datavalidationrule-list-member)|List data validation criteria.| +||[textLength](/javascript/api/excel/excel.datavalidationrule#excel-excel-datavalidationrule-textlength-member)|Text length data validation criteria.| +||[time](/javascript/api/excel/excel.datavalidationrule#excel-excel-datavalidationrule-time-member)|Time data validation criteria.| +||[wholeNumber](/javascript/api/excel/excel.datavalidationrule#excel-excel-datavalidationrule-wholenumber-member)|Whole number data validation criteria.| +|[DateTimeDataValidation](/javascript/api/excel/excel.datetimedatavalidation)|[formula1](/javascript/api/excel/excel.datetimedatavalidation#excel-excel-datetimedatavalidation-formula1-member)|Specifies the right-hand operand when the operator property is set to a binary operator such as GreaterThan (the left-hand operand is the value the user tries to enter in the cell).| +||[formula2](/javascript/api/excel/excel.datetimedatavalidation#excel-excel-datetimedatavalidation-formula2-member)|With the ternary operators Between and NotBetween, specifies the upper bound operand.| +||[operator](/javascript/api/excel/excel.datetimedatavalidation#excel-excel-datetimedatavalidation-operator-member)|The operator to use for validating the data.| +|[FilterPivotHierarchy](/javascript/api/excel/excel.filterpivothierarchy)|[enableMultipleFilterItems](/javascript/api/excel/excel.filterpivothierarchy#excel-excel-filterpivothierarchy-enablemultiplefilteritems-member)|Determines whether to allow multiple filter items.| +||[fields](/javascript/api/excel/excel.filterpivothierarchy#excel-excel-filterpivothierarchy-fields-member)|Returns the PivotFields associated with the FilterPivotHierarchy.| +||[id](/javascript/api/excel/excel.filterpivothierarchy#excel-excel-filterpivothierarchy-id-member)|ID of the FilterPivotHierarchy.| +||[name](/javascript/api/excel/excel.filterpivothierarchy#excel-excel-filterpivothierarchy-name-member)|Name of the FilterPivotHierarchy.| +||[position](/javascript/api/excel/excel.filterpivothierarchy#excel-excel-filterpivothierarchy-position-member)|Position of the FilterPivotHierarchy.| +||[setToDefault()](/javascript/api/excel/excel.filterpivothierarchy#excel-excel-filterpivothierarchy-settodefault-member(1))|Reset the FilterPivotHierarchy back to its default values.| +|[FilterPivotHierarchyCollection](/javascript/api/excel/excel.filterpivothierarchycollection)|[add(pivotHierarchy: Excel.PivotHierarchy)](/javascript/api/excel/excel.filterpivothierarchycollection#excel-excel-filterpivothierarchycollection-add-member(1))|Adds the PivotHierarchy to the current axis.| +||[getCount()](/javascript/api/excel/excel.filterpivothierarchycollection#excel-excel-filterpivothierarchycollection-getcount-member(1))|Gets the number of pivot hierarchies in the collection.| +||[getItem(name: string)](/javascript/api/excel/excel.filterpivothierarchycollection#excel-excel-filterpivothierarchycollection-getitem-member(1))|Gets a FilterPivotHierarchy by its name or ID.| +||[getItemOrNullObject(name: string)](/javascript/api/excel/excel.filterpivothierarchycollection#excel-excel-filterpivothierarchycollection-getitemornullobject-member(1))|Gets a FilterPivotHierarchy by name.| +||[items](/javascript/api/excel/excel.filterpivothierarchycollection#excel-excel-filterpivothierarchycollection-items-member)|Gets the loaded child items in this collection.| +||[remove(filterPivotHierarchy: Excel.FilterPivotHierarchy)](/javascript/api/excel/excel.filterpivothierarchycollection#excel-excel-filterpivothierarchycollection-remove-member(1))|Removes the PivotHierarchy from the current axis.| +|[ListDataValidation](/javascript/api/excel/excel.listdatavalidation)|[inCellDropDown](/javascript/api/excel/excel.listdatavalidation#excel-excel-listdatavalidation-incelldropdown-member)|Specifies whether to display the list in a cell drop-down.| +||[source](/javascript/api/excel/excel.listdatavalidation#excel-excel-listdatavalidation-source-member)|Source of the list for data validation| +|[PivotField](/javascript/api/excel/excel.pivotfield)|[id](/javascript/api/excel/excel.pivotfield#excel-excel-pivotfield-id-member)|ID of the PivotField.| +||[items](/javascript/api/excel/excel.pivotfield#excel-excel-pivotfield-items-member)|Returns the PivotItems associated with the PivotField.| +||[name](/javascript/api/excel/excel.pivotfield#excel-excel-pivotfield-name-member)|Name of the PivotField.| +||[showAllItems](/javascript/api/excel/excel.pivotfield#excel-excel-pivotfield-showallitems-member)|Determines whether to show all items of the PivotField.| +||[sortByLabels(sortBy: SortBy)](/javascript/api/excel/excel.pivotfield#excel-excel-pivotfield-sortbylabels-member(1))|Sorts the PivotField.| +||[subtotals](/javascript/api/excel/excel.pivotfield#excel-excel-pivotfield-subtotals-member)|Subtotals of the PivotField.| +|[PivotFieldCollection](/javascript/api/excel/excel.pivotfieldcollection)|[getCount()](/javascript/api/excel/excel.pivotfieldcollection#excel-excel-pivotfieldcollection-getcount-member(1))|Gets the number of pivot fields in the collection.| +||[getItem(name: string)](/javascript/api/excel/excel.pivotfieldcollection#excel-excel-pivotfieldcollection-getitem-member(1))|Gets a PivotField by its name or ID.| +||[getItemOrNullObject(name: string)](/javascript/api/excel/excel.pivotfieldcollection#excel-excel-pivotfieldcollection-getitemornullobject-member(1))|Gets a PivotField by name.| +||[items](/javascript/api/excel/excel.pivotfieldcollection#excel-excel-pivotfieldcollection-items-member)|Gets the loaded child items in this collection.| +|[PivotHierarchy](/javascript/api/excel/excel.pivothierarchy)|[fields](/javascript/api/excel/excel.pivothierarchy#excel-excel-pivothierarchy-fields-member)|Returns the PivotFields associated with the PivotHierarchy.| +||[id](/javascript/api/excel/excel.pivothierarchy#excel-excel-pivothierarchy-id-member)|ID of the PivotHierarchy.| +||[name](/javascript/api/excel/excel.pivothierarchy#excel-excel-pivothierarchy-name-member)|Name of the PivotHierarchy.| +|[PivotHierarchyCollection](/javascript/api/excel/excel.pivothierarchycollection)|[getCount()](/javascript/api/excel/excel.pivothierarchycollection#excel-excel-pivothierarchycollection-getcount-member(1))|Gets the number of pivot hierarchies in the collection.| +||[getItem(name: string)](/javascript/api/excel/excel.pivothierarchycollection#excel-excel-pivothierarchycollection-getitem-member(1))|Gets a PivotHierarchy by its name or ID.| +||[getItemOrNullObject(name: string)](/javascript/api/excel/excel.pivothierarchycollection#excel-excel-pivothierarchycollection-getitemornullobject-member(1))|Gets a PivotHierarchy by name.| +||[items](/javascript/api/excel/excel.pivothierarchycollection#excel-excel-pivothierarchycollection-items-member)|Gets the loaded child items in this collection.| +|[PivotItem](/javascript/api/excel/excel.pivotitem)|[id](/javascript/api/excel/excel.pivotitem#excel-excel-pivotitem-id-member)|ID of the PivotItem.| +||[isExpanded](/javascript/api/excel/excel.pivotitem#excel-excel-pivotitem-isexpanded-member)|Determines whether the item is expanded to show child items or if it's collapsed and child items are hidden.| +||[name](/javascript/api/excel/excel.pivotitem#excel-excel-pivotitem-name-member)|Name of the PivotItem.| +||[visible](/javascript/api/excel/excel.pivotitem#excel-excel-pivotitem-visible-member)|Specifies if the PivotItem is visible.| +|[PivotItemCollection](/javascript/api/excel/excel.pivotitemcollection)|[getCount()](/javascript/api/excel/excel.pivotitemcollection#excel-excel-pivotitemcollection-getcount-member(1))|Gets the number of PivotItems in the collection.| +||[getItem(name: string)](/javascript/api/excel/excel.pivotitemcollection#excel-excel-pivotitemcollection-getitem-member(1))|Gets a PivotItem by its name or ID.| +||[getItemOrNullObject(name: string)](/javascript/api/excel/excel.pivotitemcollection#excel-excel-pivotitemcollection-getitemornullobject-member(1))|Gets a PivotItem by name.| +||[items](/javascript/api/excel/excel.pivotitemcollection#excel-excel-pivotitemcollection-items-member)|Gets the loaded child items in this collection.| +|[PivotLayout](/javascript/api/excel/excel.pivotlayout)|[getColumnLabelRange()](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-getcolumnlabelrange-member(1))|Returns the range where the PivotTable's column labels reside.| +||[getDataBodyRange()](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-getdatabodyrange-member(1))|Returns the range where the PivotTable's data values reside.| +||[getFilterAxisRange()](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-getfilteraxisrange-member(1))|Returns the range of the PivotTable's filter area.| +||[getRange()](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-getrange-member(1))|Returns the range the PivotTable exists on, excluding the filter area.| +||[getRowLabelRange()](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-getrowlabelrange-member(1))|Returns the range where the PivotTable's row labels reside.| +||[layoutType](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-layouttype-member)|This property indicates the PivotLayoutType of all fields on the PivotTable.| +||[showColumnGrandTotals](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-showcolumngrandtotals-member)|Specifies if the PivotTable report shows grand totals for columns.| +||[showRowGrandTotals](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-showrowgrandtotals-member)|Specifies if the PivotTable report shows grand totals for rows.| +||[subtotalLocation](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-subtotallocation-member)|This property indicates the `SubtotalLocationType` of all fields on the PivotTable.| +|[PivotTable](/javascript/api/excel/excel.pivottable)|[columnHierarchies](/javascript/api/excel/excel.pivottable#excel-excel-pivottable-columnhierarchies-member)|The Column Pivot Hierarchies of the PivotTable.| +||[dataHierarchies](/javascript/api/excel/excel.pivottable#excel-excel-pivottable-datahierarchies-member)|The Data Pivot Hierarchies of the PivotTable.| +||[delete()](/javascript/api/excel/excel.pivottable#excel-excel-pivottable-delete-member(1))|Deletes the PivotTable.| +||[filterHierarchies](/javascript/api/excel/excel.pivottable#excel-excel-pivottable-filterhierarchies-member)|The Filter Pivot Hierarchies of the PivotTable.| +||[hierarchies](/javascript/api/excel/excel.pivottable#excel-excel-pivottable-hierarchies-member)|The Pivot Hierarchies of the PivotTable.| +||[layout](/javascript/api/excel/excel.pivottable#excel-excel-pivottable-layout-member)|The PivotLayout describing the layout and visual structure of the PivotTable.| +||[rowHierarchies](/javascript/api/excel/excel.pivottable#excel-excel-pivottable-rowhierarchies-member)|The Row Pivot Hierarchies of the PivotTable.| +|[PivotTableCollection](/javascript/api/excel/excel.pivottablecollection)|[add(name: string, source: Range \| string \| Table, destination: Range \| string)](/javascript/api/excel/excel.pivottablecollection#excel-excel-pivottablecollection-add-member(1))|Add a PivotTable based on the specified source data and insert it at the top-left cell of the destination range.| +|[Range](/javascript/api/excel/excel.range)|[dataValidation](/javascript/api/excel/excel.range#excel-excel-range-datavalidation-member)|Returns a data validation object.| +|[RowColumnPivotHierarchy](/javascript/api/excel/excel.rowcolumnpivothierarchy)|[fields](/javascript/api/excel/excel.rowcolumnpivothierarchy#excel-excel-rowcolumnpivothierarchy-fields-member)|Returns the PivotFields associated with the RowColumnPivotHierarchy.| +||[id](/javascript/api/excel/excel.rowcolumnpivothierarchy#excel-excel-rowcolumnpivothierarchy-id-member)|ID of the RowColumnPivotHierarchy.| +||[name](/javascript/api/excel/excel.rowcolumnpivothierarchy#excel-excel-rowcolumnpivothierarchy-name-member)|Name of the RowColumnPivotHierarchy.| +||[position](/javascript/api/excel/excel.rowcolumnpivothierarchy#excel-excel-rowcolumnpivothierarchy-position-member)|Position of the RowColumnPivotHierarchy.| +||[setToDefault()](/javascript/api/excel/excel.rowcolumnpivothierarchy#excel-excel-rowcolumnpivothierarchy-settodefault-member(1))|Reset the RowColumnPivotHierarchy back to its default values.| +|[RowColumnPivotHierarchyCollection](/javascript/api/excel/excel.rowcolumnpivothierarchycollection)|[add(pivotHierarchy: Excel.PivotHierarchy)](/javascript/api/excel/excel.rowcolumnpivothierarchycollection#excel-excel-rowcolumnpivothierarchycollection-add-member(1))|Adds the PivotHierarchy to the current axis.| +||[getCount()](/javascript/api/excel/excel.rowcolumnpivothierarchycollection#excel-excel-rowcolumnpivothierarchycollection-getcount-member(1))|Gets the number of pivot hierarchies in the collection.| +||[getItem(name: string)](/javascript/api/excel/excel.rowcolumnpivothierarchycollection#excel-excel-rowcolumnpivothierarchycollection-getitem-member(1))|Gets a RowColumnPivotHierarchy by its name or ID.| +||[getItemOrNullObject(name: string)](/javascript/api/excel/excel.rowcolumnpivothierarchycollection#excel-excel-rowcolumnpivothierarchycollection-getitemornullobject-member(1))|Gets a RowColumnPivotHierarchy by name.| +||[items](/javascript/api/excel/excel.rowcolumnpivothierarchycollection#excel-excel-rowcolumnpivothierarchycollection-items-member)|Gets the loaded child items in this collection.| +||[remove(rowColumnPivotHierarchy: Excel.RowColumnPivotHierarchy)](/javascript/api/excel/excel.rowcolumnpivothierarchycollection#excel-excel-rowcolumnpivothierarchycollection-remove-member(1))|Removes the PivotHierarchy from the current axis.| +|[Runtime](/javascript/api/excel/excel.runtime)|[enableEvents](/javascript/api/excel/excel.runtime#excel-excel-runtime-enableevents-member)|Toggle JavaScript events in the current task pane or content add-in.| +|[ShowAsRule](/javascript/api/excel/excel.showasrule)|[baseField](/javascript/api/excel/excel.showasrule#excel-excel-showasrule-basefield-member)|The PivotField to base the `ShowAs` calculation on, if applicable according to the `ShowAsCalculation` type, else `null`.| +||[baseItem](/javascript/api/excel/excel.showasrule#excel-excel-showasrule-baseitem-member)|The item to base the `ShowAs` calculation on, if applicable according to the `ShowAsCalculation` type, else `null`.| +||[calculation](/javascript/api/excel/excel.showasrule#excel-excel-showasrule-calculation-member)|The `ShowAs` calculation to use for the PivotField.| +|[Style](/javascript/api/excel/excel.style)|[autoIndent](/javascript/api/excel/excel.style#excel-excel-style-autoindent-member)|Specifies if text is automatically indented when the text alignment in a cell is set to equal distribution.| +||[textOrientation](/javascript/api/excel/excel.style#excel-excel-style-textorientation-member)|The text orientation for the style.| +|[Subtotals](/javascript/api/excel/excel.subtotals)|[automatic](/javascript/api/excel/excel.subtotals#excel-excel-subtotals-automatic-member)|If `Automatic` is set to `true`, then all other values will be ignored when setting the `Subtotals`.| +||[average](/javascript/api/excel/excel.subtotals#excel-excel-subtotals-average-member)|| +||[count](/javascript/api/excel/excel.subtotals#excel-excel-subtotals-count-member)|| +||[countNumbers](/javascript/api/excel/excel.subtotals#excel-excel-subtotals-countnumbers-member)|| +||[max](/javascript/api/excel/excel.subtotals#excel-excel-subtotals-max-member)|| +||[min](/javascript/api/excel/excel.subtotals#excel-excel-subtotals-min-member)|| +||[product](/javascript/api/excel/excel.subtotals#excel-excel-subtotals-product-member)|| +||[standardDeviation](/javascript/api/excel/excel.subtotals#excel-excel-subtotals-standarddeviation-member)|| +||[standardDeviationP](/javascript/api/excel/excel.subtotals#excel-excel-subtotals-standarddeviationp-member)|| +||[sum](/javascript/api/excel/excel.subtotals#excel-excel-subtotals-sum-member)|| +||[variance](/javascript/api/excel/excel.subtotals#excel-excel-subtotals-variance-member)|| +||[varianceP](/javascript/api/excel/excel.subtotals#excel-excel-subtotals-variancep-member)|| +|[Table](/javascript/api/excel/excel.table)|[legacyId](/javascript/api/excel/excel.table#excel-excel-table-legacyid-member)|Returns a numeric ID.| +|[TableChangedEventArgs](/javascript/api/excel/excel.tablechangedeventargs)|[getRange(ctx: Excel.RequestContext)](/javascript/api/excel/excel.tablechangedeventargs#excel-excel-tablechangedeventargs-getrange-member(1))|Gets the range that represents the changed area of a table on a specific worksheet.| +||[getRangeOrNullObject(ctx: Excel.RequestContext)](/javascript/api/excel/excel.tablechangedeventargs#excel-excel-tablechangedeventargs-getrangeornullobject-member(1))|Gets the range that represents the changed area of a table on a specific worksheet.| +|[Workbook](/javascript/api/excel/excel.workbook)|[readOnly](/javascript/api/excel/excel.workbook#excel-excel-workbook-readonly-member)|Returns `true` if the workbook is open in read-only mode.| +|[WorkbookCreated](/javascript/api/excel/excel.workbookcreated)||| +|[Worksheet](/javascript/api/excel/excel.worksheet)|[onCalculated](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-oncalculated-member)|Occurs when the worksheet is calculated.| +||[showGridlines](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-showgridlines-member)|Specifies if gridlines are visible to the user.| +||[showHeadings](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-showheadings-member)|Specifies if headings are visible to the user.| +|[WorksheetCalculatedEventArgs](/javascript/api/excel/excel.worksheetcalculatedeventargs)|[type](/javascript/api/excel/excel.worksheetcalculatedeventargs#excel-excel-worksheetcalculatedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/javascript/api/excel/excel.worksheetcalculatedeventargs#excel-excel-worksheetcalculatedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the calculation occurred.| +|[WorksheetChangedEventArgs](/javascript/api/excel/excel.worksheetchangedeventargs)|[getRange(ctx: Excel.RequestContext)](/javascript/api/excel/excel.worksheetchangedeventargs#excel-excel-worksheetchangedeventargs-getrange-member(1))|Gets the range that represents the changed area of a specific worksheet.| +||[getRangeOrNullObject(ctx: Excel.RequestContext)](/javascript/api/excel/excel.worksheetchangedeventargs#excel-excel-worksheetchangedeventargs-getrangeornullobject-member(1))|Gets the range that represents the changed area of a specific worksheet.| +|[WorksheetCollection](/javascript/api/excel/excel.worksheetcollection)|[onCalculated](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-oncalculated-member)|Occurs when any worksheet in the workbook is calculated.| diff --git a/docs/includes/excel-1_9.md b/docs/includes/excel-1_9.md index f85fc97b84..c144d700d1 100644 --- a/docs/includes/excel-1_9.md +++ b/docs/includes/excel-1_9.md @@ -1,450 +1,450 @@ | Class | Fields | Description | |:---|:---|:---| -|[Application](/.application)|[calculationEngineVersion](/.application#excel-javascript/api/excel/-application-calculationengineversion-member)|Returns the Excel calculation engine version used for the last full recalculation.| -||[calculationState](/.application#excel-javascript/api/excel/-application-calculationstate-member)|Returns the calculation state of the application.| -||[iterativeCalculation](/.application#excel-javascript/api/excel/-application-iterativecalculation-member)|Returns the iterative calculation settings.| -||[suspendScreenUpdatingUntilNextSync()](/.application#excel-javascript/api/excel/-application-suspendscreenupdatinguntilnextsync-member(1))|Suspends screen updating until the next `context.sync()` is called.| -|[AutoFilter](/.autofilter)|[apply(range: Range \| string, columnIndex?: number, criteria?: Excel.FilterCriteria)](/.autofilter#excel-javascript/api/excel/-autofilter-apply-member(1))|Applies the AutoFilter to a range.| -||[clearCriteria()](/.autofilter#excel-javascript/api/excel/-autofilter-clearcriteria-member(1))|Clears the filter criteria and sort state of the AutoFilter.| -||[criteria](/.autofilter#excel-javascript/api/excel/-autofilter-criteria-member)|An array that holds all the filter criteria in the autofiltered range.| -||[enabled](/.autofilter#excel-javascript/api/excel/-autofilter-enabled-member)|Specifies if the AutoFilter is enabled.| -||[getRange()](/.autofilter#excel-javascript/api/excel/-autofilter-getrange-member(1))|Returns the `Range` object that represents the range to which the AutoFilter applies.| -||[getRangeOrNullObject()](/.autofilter#excel-javascript/api/excel/-autofilter-getrangeornullobject-member(1))|Returns the `Range` object that represents the range to which the AutoFilter applies.| -||[isDataFiltered](/.autofilter#excel-javascript/api/excel/-autofilter-isdatafiltered-member)|Specifies if the AutoFilter has filter criteria.| -||[reapply()](/.autofilter#excel-javascript/api/excel/-autofilter-reapply-member(1))|Applies the specified AutoFilter object currently on the range.| -||[remove()](/.autofilter#excel-javascript/api/excel/-autofilter-remove-member(1))|Removes the AutoFilter for the range.| -|[CellBorder](/.cellborder)|[color](/.cellborder#excel-javascript/api/excel/-cellborder-color-member)|Represents the `color` property of a single border.| -||[style](/.cellborder#excel-javascript/api/excel/-cellborder-style-member)|Represents the `style` property of a single border.| -||[tintAndShade](/.cellborder#excel-javascript/api/excel/-cellborder-tintandshade-member)|Represents the `tintAndShade` property of a single border.| -||[weight](/.cellborder#excel-javascript/api/excel/-cellborder-weight-member)|Represents the `weight` property of a single border.| -|[CellBorderCollection](/.cellbordercollection)|[bottom](/.cellbordercollection#excel-javascript/api/excel/-cellbordercollection-bottom-member)|Represents the `format.borders.bottom` property.| -||[diagonalDown](/.cellbordercollection#excel-javascript/api/excel/-cellbordercollection-diagonaldown-member)|Represents the `format.borders.diagonalDown` property.| -||[diagonalUp](/.cellbordercollection#excel-javascript/api/excel/-cellbordercollection-diagonalup-member)|Represents the `format.borders.diagonalUp` property.| -||[horizontal](/.cellbordercollection#excel-javascript/api/excel/-cellbordercollection-horizontal-member)|Represents the `format.borders.horizontal` property.| -||[left](/.cellbordercollection#excel-javascript/api/excel/-cellbordercollection-left-member)|Represents the `format.borders.left` property.| -||[right](/.cellbordercollection#excel-javascript/api/excel/-cellbordercollection-right-member)|Represents the `format.borders.right` property.| -||[top](/.cellbordercollection#excel-javascript/api/excel/-cellbordercollection-top-member)|Represents the `format.borders.top` property.| -||[vertical](/.cellbordercollection#excel-javascript/api/excel/-cellbordercollection-vertical-member)|Represents the `format.borders.vertical` property.| -|[CellProperties](/.cellproperties)|[address](/.cellproperties#excel-javascript/api/excel/-cellproperties-address-member)|Represents the `address` property.| -||[addressLocal](/.cellproperties#excel-javascript/api/excel/-cellproperties-addresslocal-member)|Represents the `addressLocal` property.| -||[hidden](/.cellproperties#excel-javascript/api/excel/-cellproperties-hidden-member)|Represents the `hidden` property.| -|[CellPropertiesFill](/.cellpropertiesfill)|[color](/.cellpropertiesfill#excel-javascript/api/excel/-cellpropertiesfill-color-member)|Represents the `format.fill.color` property.| -||[pattern](/.cellpropertiesfill#excel-javascript/api/excel/-cellpropertiesfill-pattern-member)|Represents the `format.fill.pattern` property.| -||[patternColor](/.cellpropertiesfill#excel-javascript/api/excel/-cellpropertiesfill-patterncolor-member)|Represents the `format.fill.patternColor` property.| -||[patternTintAndShade](/.cellpropertiesfill#excel-javascript/api/excel/-cellpropertiesfill-patterntintandshade-member)|Represents the `format.fill.patternTintAndShade` property.| -||[tintAndShade](/.cellpropertiesfill#excel-javascript/api/excel/-cellpropertiesfill-tintandshade-member)|Represents the `format.fill.tintAndShade` property.| -|[CellPropertiesFont](/.cellpropertiesfont)|[bold](/.cellpropertiesfont#excel-javascript/api/excel/-cellpropertiesfont-bold-member)|Represents the `format.font.bold` property.| -||[color](/.cellpropertiesfont#excel-javascript/api/excel/-cellpropertiesfont-color-member)|Represents the `format.font.color` property.| -||[italic](/.cellpropertiesfont#excel-javascript/api/excel/-cellpropertiesfont-italic-member)|Represents the `format.font.italic` property.| -||[name](/.cellpropertiesfont#excel-javascript/api/excel/-cellpropertiesfont-name-member)|Represents the `format.font.name` property.| -||[size](/.cellpropertiesfont#excel-javascript/api/excel/-cellpropertiesfont-size-member)|Represents the `format.font.size` property.| -||[strikethrough](/.cellpropertiesfont#excel-javascript/api/excel/-cellpropertiesfont-strikethrough-member)|Represents the `format.font.strikethrough` property.| -||[subscript](/.cellpropertiesfont#excel-javascript/api/excel/-cellpropertiesfont-subscript-member)|Represents the `format.font.subscript` property.| -||[superscript](/.cellpropertiesfont#excel-javascript/api/excel/-cellpropertiesfont-superscript-member)|Represents the `format.font.superscript` property.| -||[tintAndShade](/.cellpropertiesfont#excel-javascript/api/excel/-cellpropertiesfont-tintandshade-member)|Represents the `format.font.tintAndShade` property.| -||[underline](/.cellpropertiesfont#excel-javascript/api/excel/-cellpropertiesfont-underline-member)|Represents the `format.font.underline` property.| -|[CellPropertiesFormat](/.cellpropertiesformat)|[autoIndent](/.cellpropertiesformat#excel-javascript/api/excel/-cellpropertiesformat-autoindent-member)|Represents the `autoIndent` property.| -||[borders](/.cellpropertiesformat#excel-javascript/api/excel/-cellpropertiesformat-borders-member)|Represents the `borders` property.| -||[fill](/.cellpropertiesformat#excel-javascript/api/excel/-cellpropertiesformat-fill-member)|Represents the `fill` property.| -||[font](/.cellpropertiesformat#excel-javascript/api/excel/-cellpropertiesformat-font-member)|Represents the `font` property.| -||[horizontalAlignment](/.cellpropertiesformat#excel-javascript/api/excel/-cellpropertiesformat-horizontalalignment-member)|Represents the `horizontalAlignment` property.| -||[indentLevel](/.cellpropertiesformat#excel-javascript/api/excel/-cellpropertiesformat-indentlevel-member)|Represents the `indentLevel` property.| -||[protection](/.cellpropertiesformat#excel-javascript/api/excel/-cellpropertiesformat-protection-member)|Represents the `protection` property.| -||[readingOrder](/.cellpropertiesformat#excel-javascript/api/excel/-cellpropertiesformat-readingorder-member)|Represents the `readingOrder` property.| -||[shrinkToFit](/.cellpropertiesformat#excel-javascript/api/excel/-cellpropertiesformat-shrinktofit-member)|Represents the `shrinkToFit` property.| -||[textOrientation](/.cellpropertiesformat#excel-javascript/api/excel/-cellpropertiesformat-textorientation-member)|Represents the `textOrientation` property.| -||[useStandardHeight](/.cellpropertiesformat#excel-javascript/api/excel/-cellpropertiesformat-usestandardheight-member)|Represents the `useStandardHeight` property.| -||[useStandardWidth](/.cellpropertiesformat#excel-javascript/api/excel/-cellpropertiesformat-usestandardwidth-member)|Represents the `useStandardWidth` property.| -||[verticalAlignment](/.cellpropertiesformat#excel-javascript/api/excel/-cellpropertiesformat-verticalalignment-member)|Represents the `verticalAlignment` property.| -||[wrapText](/.cellpropertiesformat#excel-javascript/api/excel/-cellpropertiesformat-wraptext-member)|Represents the `wrapText` property.| -|[CellPropertiesProtection](/.cellpropertiesprotection)|[formulaHidden](/.cellpropertiesprotection#excel-javascript/api/excel/-cellpropertiesprotection-formulahidden-member)|Represents the `format.protection.formulaHidden` property.| -||[locked](/.cellpropertiesprotection#excel-javascript/api/excel/-cellpropertiesprotection-locked-member)|Represents the `format.protection.locked` property.| -|[ChangedEventDetail](/.changedeventdetail)|[valueAfter](/.changedeventdetail#excel-javascript/api/excel/-changedeventdetail-valueafter-member)|Represents the value after the change.| -||[valueBefore](/.changedeventdetail#excel-javascript/api/excel/-changedeventdetail-valuebefore-member)|Represents the value before the change.| -||[valueTypeAfter](/.changedeventdetail#excel-javascript/api/excel/-changedeventdetail-valuetypeafter-member)|Represents the type of value after the change.| -||[valueTypeBefore](/.changedeventdetail#excel-javascript/api/excel/-changedeventdetail-valuetypebefore-member)|Represents the type of value before the change.| -|[Chart](/.chart)|[activate()](/.chart#excel-javascript/api/excel/-chart-activate-member(1))|Activates the chart in the Excel UI.| -||[pivotOptions](/.chart#excel-javascript/api/excel/-chart-pivotoptions-member)|Encapsulates the options for a pivot chart.| -|[ChartAreaFormat](/.chartareaformat)|[colorScheme](/.chartareaformat#excel-javascript/api/excel/-chartareaformat-colorscheme-member)|Specifies the color scheme of the chart.| -||[roundedCorners](/.chartareaformat#excel-javascript/api/excel/-chartareaformat-roundedcorners-member)|Specifies if the chart area of the chart has rounded corners.| -|[ChartAxis](/.chartaxis)|[linkNumberFormat](/.chartaxis#excel-javascript/api/excel/-chartaxis-linknumberformat-member)|Specifies if the number format is linked to the cells.| -|[ChartBinOptions](/.chartbinoptions)|[allowOverflow](/.chartbinoptions#excel-javascript/api/excel/-chartbinoptions-allowoverflow-member)|Specifies if bin overflow is enabled in a histogram chart or pareto chart.| -||[allowUnderflow](/.chartbinoptions#excel-javascript/api/excel/-chartbinoptions-allowunderflow-member)|Specifies if bin underflow is enabled in a histogram chart or pareto chart.| -||[count](/.chartbinoptions#excel-javascript/api/excel/-chartbinoptions-count-member)|Specifies the bin count of a histogram chart or pareto chart.| -||[overflowValue](/.chartbinoptions#excel-javascript/api/excel/-chartbinoptions-overflowvalue-member)|Specifies the bin overflow value of a histogram chart or pareto chart.| -||[type](/.chartbinoptions#excel-javascript/api/excel/-chartbinoptions-type-member)|Specifies the bin's type for a histogram chart or pareto chart.| -||[underflowValue](/.chartbinoptions#excel-javascript/api/excel/-chartbinoptions-underflowvalue-member)|Specifies the bin underflow value of a histogram chart or pareto chart.| -||[width](/.chartbinoptions#excel-javascript/api/excel/-chartbinoptions-width-member)|Specifies the bin width value of a histogram chart or pareto chart.| -|[ChartBoxwhiskerOptions](/.chartboxwhiskeroptions)|[quartileCalculation](/.chartboxwhiskeroptions#excel-javascript/api/excel/-chartboxwhiskeroptions-quartilecalculation-member)|Specifies if the quartile calculation type of a box and whisker chart.| -||[showInnerPoints](/.chartboxwhiskeroptions#excel-javascript/api/excel/-chartboxwhiskeroptions-showinnerpoints-member)|Specifies if inner points are shown in a box and whisker chart.| -||[showMeanLine](/.chartboxwhiskeroptions#excel-javascript/api/excel/-chartboxwhiskeroptions-showmeanline-member)|Specifies if the mean line is shown in a box and whisker chart.| -||[showMeanMarker](/.chartboxwhiskeroptions#excel-javascript/api/excel/-chartboxwhiskeroptions-showmeanmarker-member)|Specifies if the mean marker is shown in a box and whisker chart.| -||[showOutlierPoints](/.chartboxwhiskeroptions#excel-javascript/api/excel/-chartboxwhiskeroptions-showoutlierpoints-member)|Specifies if outlier points are shown in a box and whisker chart.| -|[ChartDataLabel](/.chartdatalabel)|[linkNumberFormat](/.chartdatalabel#excel-javascript/api/excel/-chartdatalabel-linknumberformat-member)|Specifies if the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells).| -|[ChartDataLabels](/.chartdatalabels)|[linkNumberFormat](/.chartdatalabels#excel-javascript/api/excel/-chartdatalabels-linknumberformat-member)|Specifies if the number format is linked to the cells.| -|[ChartErrorBars](/.charterrorbars)|[endStyleCap](/.charterrorbars#excel-javascript/api/excel/-charterrorbars-endstylecap-member)|Specifies if error bars have an end style cap.| -||[format](/.charterrorbars#excel-javascript/api/excel/-charterrorbars-format-member)|Specifies the formatting type of the error bars.| -||[include](/.charterrorbars#excel-javascript/api/excel/-charterrorbars-include-member)|Specifies which parts of the error bars to include.| -||[type](/.charterrorbars#excel-javascript/api/excel/-charterrorbars-type-member)|The type of range marked by the error bars.| -||[visible](/.charterrorbars#excel-javascript/api/excel/-charterrorbars-visible-member)|Specifies whether the error bars are displayed.| -|[ChartErrorBarsFormat](/.charterrorbarsformat)|[line](/.charterrorbarsformat#excel-javascript/api/excel/-charterrorbarsformat-line-member)|Represents the chart line formatting.| -|[ChartMapOptions](/.chartmapoptions)|[labelStrategy](/.chartmapoptions#excel-javascript/api/excel/-chartmapoptions-labelstrategy-member)|Specifies the series map labels strategy of a region map chart.| -||[level](/.chartmapoptions#excel-javascript/api/excel/-chartmapoptions-level-member)|Specifies the series mapping level of a region map chart.| -||[projectionType](/.chartmapoptions#excel-javascript/api/excel/-chartmapoptions-projectiontype-member)|Specifies the series projection type of a region map chart.| -|[ChartPivotOptions](/.chartpivotoptions)|[showAxisFieldButtons](/.chartpivotoptions#excel-javascript/api/excel/-chartpivotoptions-showaxisfieldbuttons-member)|Specifies whether to display the axis field buttons on a PivotChart.| -||[showLegendFieldButtons](/.chartpivotoptions#excel-javascript/api/excel/-chartpivotoptions-showlegendfieldbuttons-member)|Specifies whether to display the legend field buttons on a PivotChart.| -||[showReportFilterFieldButtons](/.chartpivotoptions#excel-javascript/api/excel/-chartpivotoptions-showreportfilterfieldbuttons-member)|Specifies whether to display the report filter field buttons on a PivotChart.| -||[showValueFieldButtons](/.chartpivotoptions#excel-javascript/api/excel/-chartpivotoptions-showvaluefieldbuttons-member)|Specifies whether to display the show value field buttons on a PivotChart.| -|[ChartSeries](/.chartseries)|[binOptions](/.chartseries#excel-javascript/api/excel/-chartseries-binoptions-member)|Encapsulates the bin options for histogram charts and pareto charts.| -||[boxwhiskerOptions](/.chartseries#excel-javascript/api/excel/-chartseries-boxwhiskeroptions-member)|Encapsulates the options for the box and whisker charts.| -||[bubbleScale](/.chartseries#excel-javascript/api/excel/-chartseries-bubblescale-member)|This can be an integer value from 0 (zero) to 300, representing the percentage of the default size.| -||[gradientMaximumColor](/.chartseries#excel-javascript/api/excel/-chartseries-gradientmaximumcolor-member)|Specifies the color for maximum value of a region map chart series.| -||[gradientMaximumType](/.chartseries#excel-javascript/api/excel/-chartseries-gradientmaximumtype-member)|Specifies the type for maximum value of a region map chart series.| -||[gradientMaximumValue](/.chartseries#excel-javascript/api/excel/-chartseries-gradientmaximumvalue-member)|Specifies the maximum value of a region map chart series.| -||[gradientMidpointColor](/.chartseries#excel-javascript/api/excel/-chartseries-gradientmidpointcolor-member)|Specifies the color for the midpoint value of a region map chart series.| -||[gradientMidpointType](/.chartseries#excel-javascript/api/excel/-chartseries-gradientmidpointtype-member)|Specifies the type for the midpoint value of a region map chart series.| -||[gradientMidpointValue](/.chartseries#excel-javascript/api/excel/-chartseries-gradientmidpointvalue-member)|Specifies the midpoint value of a region map chart series.| -||[gradientMinimumColor](/.chartseries#excel-javascript/api/excel/-chartseries-gradientminimumcolor-member)|Specifies the color for the minimum value of a region map chart series.| -||[gradientMinimumType](/.chartseries#excel-javascript/api/excel/-chartseries-gradientminimumtype-member)|Specifies the type for the minimum value of a region map chart series.| -||[gradientMinimumValue](/.chartseries#excel-javascript/api/excel/-chartseries-gradientminimumvalue-member)|Specifies the minimum value of a region map chart series.| -||[gradientStyle](/.chartseries#excel-javascript/api/excel/-chartseries-gradientstyle-member)|Specifies the series gradient style of a region map chart.| -||[invertColor](/.chartseries#excel-javascript/api/excel/-chartseries-invertcolor-member)|Specifies the fill color for negative data points in a series.| -||[mapOptions](/.chartseries#excel-javascript/api/excel/-chartseries-mapoptions-member)|Encapsulates the options for a region map chart.| -||[parentLabelStrategy](/.chartseries#excel-javascript/api/excel/-chartseries-parentlabelstrategy-member)|Specifies the series parent label strategy area for a treemap chart.| -||[showConnectorLines](/.chartseries#excel-javascript/api/excel/-chartseries-showconnectorlines-member)|Specifies whether connector lines are shown in waterfall charts.| -||[showLeaderLines](/.chartseries#excel-javascript/api/excel/-chartseries-showleaderlines-member)|Specifies whether leader lines are displayed for each data label in the series.| -||[splitValue](/.chartseries#excel-javascript/api/excel/-chartseries-splitvalue-member)|Specifies the threshold value that separates two sections of either a pie-of-pie chart or a bar-of-pie chart.| -||[xErrorBars](/.chartseries#excel-javascript/api/excel/-chartseries-xerrorbars-member)|Represents the error bar object of a chart series.| -||[yErrorBars](/.chartseries#excel-javascript/api/excel/-chartseries-yerrorbars-member)|Represents the error bar object of a chart series.| -|[ChartTrendlineLabel](/.charttrendlinelabel)|[linkNumberFormat](/.charttrendlinelabel#excel-javascript/api/excel/-charttrendlinelabel-linknumberformat-member)|Specifies if the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells).| -|[ColumnProperties](/.columnproperties)|[address](/.columnproperties#excel-javascript/api/excel/-columnproperties-address-member)|Represents the `address` property.| -||[addressLocal](/.columnproperties#excel-javascript/api/excel/-columnproperties-addresslocal-member)|Represents the `addressLocal` property.| -||[columnIndex](/.columnproperties#excel-javascript/api/excel/-columnproperties-columnindex-member)|Represents the `columnIndex` property.| -|[ConditionalFormat](/.conditionalformat)|[getRanges()](/.conditionalformat#excel-javascript/api/excel/-conditionalformat-getranges-member(1))|Returns the `RangeAreas`, comprising one or more rectangular ranges, to which the conditional format is applied.| -|[DataValidation](/.datavalidation)|[getInvalidCells()](/.datavalidation#excel-javascript/api/excel/-datavalidation-getinvalidcells-member(1))|Returns a `RangeAreas` object, comprising one or more rectangular ranges, with invalid cell values.| -||[getInvalidCellsOrNullObject()](/.datavalidation#excel-javascript/api/excel/-datavalidation-getinvalidcellsornullobject-member(1))|Returns a `RangeAreas` object, comprising one or more rectangular ranges, with invalid cell values.| -|[FilterCriteria](/.filtercriteria)|[subField](/.filtercriteria#excel-javascript/api/excel/-filtercriteria-subfield-member)|The property used by the filter to do a rich filter on rich values.| -|[GeometricShape](/.geometricshape)|[id](/.geometricshape#excel-javascript/api/excel/-geometricshape-id-member)|Returns the shape identifier.| -||[shape](/.geometricshape#excel-javascript/api/excel/-geometricshape-shape-member)|Returns the `Shape` object for the geometric shape.| -|[GroupShapeCollection](/.groupshapecollection)|[getCount()](/.groupshapecollection#excel-javascript/api/excel/-groupshapecollection-getcount-member(1))|Returns the number of shapes in the shape group.| -||[getItem(key: string)](/.groupshapecollection#excel-javascript/api/excel/-groupshapecollection-getitem-member(1))|Gets a shape using its name or ID.| -||[getItemAt(index: number)](/.groupshapecollection#excel-javascript/api/excel/-groupshapecollection-getitemat-member(1))|Gets a shape based on its position in the collection.| -||[items](/.groupshapecollection#excel-javascript/api/excel/-groupshapecollection-items-member)|Gets the loaded child items in this collection.| -|[HeaderFooter](/.headerfooter)|[centerFooter](/.headerfooter#excel-javascript/api/excel/-headerfooter-centerfooter-member)|The center footer of the worksheet.| -||[centerHeader](/.headerfooter#excel-javascript/api/excel/-headerfooter-centerheader-member)|The center header of the worksheet.| -||[leftFooter](/.headerfooter#excel-javascript/api/excel/-headerfooter-leftfooter-member)|The left footer of the worksheet.| -||[leftHeader](/.headerfooter#excel-javascript/api/excel/-headerfooter-leftheader-member)|The left header of the worksheet.| -||[rightFooter](/.headerfooter#excel-javascript/api/excel/-headerfooter-rightfooter-member)|The right footer of the worksheet.| -||[rightHeader](/.headerfooter#excel-javascript/api/excel/-headerfooter-rightheader-member)|The right header of the worksheet.| -|[HeaderFooterGroup](/.headerfootergroup)|[defaultForAllPages](/.headerfootergroup#excel-javascript/api/excel/-headerfootergroup-defaultforallpages-member)|The general header/footer, used for all pages unless even/odd or first page is specified.| -||[evenPages](/.headerfootergroup#excel-javascript/api/excel/-headerfootergroup-evenpages-member)|The header/footer to use for even pages, odd header/footer needs to be specified for odd pages.| -||[firstPage](/.headerfootergroup#excel-javascript/api/excel/-headerfootergroup-firstpage-member)|The first page header/footer, for all other pages general or even/odd is used.| -||[oddPages](/.headerfootergroup#excel-javascript/api/excel/-headerfootergroup-oddpages-member)|The header/footer to use for odd pages, even header/footer needs to be specified for even pages.| -||[state](/.headerfootergroup#excel-javascript/api/excel/-headerfootergroup-state-member)|The state by which headers/footers are set.| -||[useSheetMargins](/.headerfootergroup#excel-javascript/api/excel/-headerfootergroup-usesheetmargins-member)|Gets or sets a flag indicating if headers/footers are aligned with the page margins set in the page layout options for the worksheet.| -||[useSheetScale](/.headerfootergroup#excel-javascript/api/excel/-headerfootergroup-usesheetscale-member)|Gets or sets a flag indicating if headers/footers should be scaled by the page percentage scale set in the page layout options for the worksheet.| -|[Image](/.image)|[format](/.image#excel-javascript/api/excel/-image-format-member)|Returns the format of the image.| -||[id](/.image#excel-javascript/api/excel/-image-id-member)|Specifies the shape identifier for the image object.| -||[shape](/.image#excel-javascript/api/excel/-image-shape-member)|Returns the `Shape` object associated with the image.| -|[IterativeCalculation](/.iterativecalculation)|[enabled](/.iterativecalculation#excel-javascript/api/excel/-iterativecalculation-enabled-member)|True if Excel will use iteration to resolve circular references.| -||[maxChange](/.iterativecalculation#excel-javascript/api/excel/-iterativecalculation-maxchange-member)|Specifies the maximum amount of change between each iteration as Excel resolves circular references.| -||[maxIteration](/.iterativecalculation#excel-javascript/api/excel/-iterativecalculation-maxiteration-member)|Specifies the maximum number of iterations that Excel can use to resolve a circular reference.| -|[Line](/.line)|[beginArrowheadLength](/.line#excel-javascript/api/excel/-line-beginarrowheadlength-member)|Represents the length of the arrowhead at the beginning of the specified line.| -||[beginArrowheadStyle](/.line#excel-javascript/api/excel/-line-beginarrowheadstyle-member)|Represents the style of the arrowhead at the beginning of the specified line.| -||[beginArrowheadWidth](/.line#excel-javascript/api/excel/-line-beginarrowheadwidth-member)|Represents the width of the arrowhead at the beginning of the specified line.| -||[beginConnectedShape](/.line#excel-javascript/api/excel/-line-beginconnectedshape-member)|Represents the shape to which the beginning of the specified line is attached.| -||[beginConnectedSite](/.line#excel-javascript/api/excel/-line-beginconnectedsite-member)|Represents the connection site to which the beginning of a connector is connected.| -||[connectBeginShape(shape: Excel.Shape, connectionSite: number)](/.line#excel-javascript/api/excel/-line-connectbeginshape-member(1))|Attaches the beginning of the specified connector to a specified shape.| -||[connectEndShape(shape: Excel.Shape, connectionSite: number)](/.line#excel-javascript/api/excel/-line-connectendshape-member(1))|Attaches the end of the specified connector to a specified shape.| -||[connectorType](/.line#excel-javascript/api/excel/-line-connectortype-member)|Represents the connector type for the line.| -||[disconnectBeginShape()](/.line#excel-javascript/api/excel/-line-disconnectbeginshape-member(1))|Detaches the beginning of the specified connector from a shape.| -||[disconnectEndShape()](/.line#excel-javascript/api/excel/-line-disconnectendshape-member(1))|Detaches the end of the specified connector from a shape.| -||[endArrowheadLength](/.line#excel-javascript/api/excel/-line-endarrowheadlength-member)|Represents the length of the arrowhead at the end of the specified line.| -||[endArrowheadStyle](/.line#excel-javascript/api/excel/-line-endarrowheadstyle-member)|Represents the style of the arrowhead at the end of the specified line.| -||[endArrowheadWidth](/.line#excel-javascript/api/excel/-line-endarrowheadwidth-member)|Represents the width of the arrowhead at the end of the specified line.| -||[endConnectedShape](/.line#excel-javascript/api/excel/-line-endconnectedshape-member)|Represents the shape to which the end of the specified line is attached.| -||[endConnectedSite](/.line#excel-javascript/api/excel/-line-endconnectedsite-member)|Represents the connection site to which the end of a connector is connected.| -||[id](/.line#excel-javascript/api/excel/-line-id-member)|Specifies the shape identifier.| -||[isBeginConnected](/.line#excel-javascript/api/excel/-line-isbeginconnected-member)|Specifies if the beginning of the specified line is connected to a shape.| -||[isEndConnected](/.line#excel-javascript/api/excel/-line-isendconnected-member)|Specifies if the end of the specified line is connected to a shape.| -||[shape](/.line#excel-javascript/api/excel/-line-shape-member)|Returns the `Shape` object associated with the line.| -|[PageBreak](/.pagebreak)|[columnIndex](/.pagebreak#excel-javascript/api/excel/-pagebreak-columnindex-member)|Specifies the column index for the page break.| -||[delete()](/.pagebreak#excel-javascript/api/excel/-pagebreak-delete-member(1))|Deletes a page break object.| -||[getCellAfterBreak()](/.pagebreak#excel-javascript/api/excel/-pagebreak-getcellafterbreak-member(1))|Gets the first cell after the page break.| -||[rowIndex](/.pagebreak#excel-javascript/api/excel/-pagebreak-rowindex-member)|Specifies the row index for the page break.| -|[PageBreakCollection](/.pagebreakcollection)|[add(pageBreakRange: Range \| string)](/.pagebreakcollection#excel-javascript/api/excel/-pagebreakcollection-add-member(1))|Adds a page break before the top-left cell of the range specified.| -||[getCount()](/.pagebreakcollection#excel-javascript/api/excel/-pagebreakcollection-getcount-member(1))|Gets the number of page breaks in the collection.| -||[getItem(index: number)](/.pagebreakcollection#excel-javascript/api/excel/-pagebreakcollection-getitem-member(1))|Gets a page break object via the index.| -||[items](/.pagebreakcollection#excel-javascript/api/excel/-pagebreakcollection-items-member)|Gets the loaded child items in this collection.| -||[removePageBreaks()](/.pagebreakcollection#excel-javascript/api/excel/-pagebreakcollection-removepagebreaks-member(1))|Resets all manual page breaks in the collection.| -|[PageLayout](/.pagelayout)|[blackAndWhite](/.pagelayout#excel-javascript/api/excel/-pagelayout-blackandwhite-member)|The worksheet's black and white print option.| -||[bottomMargin](/.pagelayout#excel-javascript/api/excel/-pagelayout-bottommargin-member)|The worksheet's bottom page margin to use for printing in points.| -||[centerHorizontally](/.pagelayout#excel-javascript/api/excel/-pagelayout-centerhorizontally-member)|The worksheet's center horizontally flag.| -||[centerVertically](/.pagelayout#excel-javascript/api/excel/-pagelayout-centervertically-member)|The worksheet's center vertically flag.| -||[draftMode](/.pagelayout#excel-javascript/api/excel/-pagelayout-draftmode-member)|The worksheet's draft mode option.| -||[firstPageNumber](/.pagelayout#excel-javascript/api/excel/-pagelayout-firstpagenumber-member)|The worksheet's first page number to print.| -||[footerMargin](/.pagelayout#excel-javascript/api/excel/-pagelayout-footermargin-member)|The worksheet's footer margin, in points, for use when printing.| -||[getPrintArea()](/.pagelayout#excel-javascript/api/excel/-pagelayout-getprintarea-member(1))|Gets the `RangeAreas` object, comprising one or more rectangular ranges, that represents the print area for the worksheet.| -||[getPrintAreaOrNullObject()](/.pagelayout#excel-javascript/api/excel/-pagelayout-getprintareaornullobject-member(1))|Gets the `RangeAreas` object, comprising one or more rectangular ranges, that represents the print area for the worksheet.| -||[getPrintTitleColumns()](/.pagelayout#excel-javascript/api/excel/-pagelayout-getprinttitlecolumns-member(1))|Gets the range object representing the title columns.| -||[getPrintTitleColumnsOrNullObject()](/.pagelayout#excel-javascript/api/excel/-pagelayout-getprinttitlecolumnsornullobject-member(1))|Gets the range object representing the title columns.| -||[getPrintTitleRows()](/.pagelayout#excel-javascript/api/excel/-pagelayout-getprinttitlerows-member(1))|Gets the range object representing the title rows.| -||[getPrintTitleRowsOrNullObject()](/.pagelayout#excel-javascript/api/excel/-pagelayout-getprinttitlerowsornullobject-member(1))|Gets the range object representing the title rows.| -||[headerMargin](/.pagelayout#excel-javascript/api/excel/-pagelayout-headermargin-member)|The worksheet's header margin, in points, for use when printing.| -||[headersFooters](/.pagelayout#excel-javascript/api/excel/-pagelayout-headersfooters-member)|Header and footer configuration for the worksheet.| -||[leftMargin](/.pagelayout#excel-javascript/api/excel/-pagelayout-leftmargin-member)|The worksheet's left margin, in points, for use when printing.| -||[orientation](/.pagelayout#excel-javascript/api/excel/-pagelayout-orientation-member)|The worksheet's orientation of the page.| -||[paperSize](/.pagelayout#excel-javascript/api/excel/-pagelayout-papersize-member)|The worksheet's paper size of the page.| -||[printComments](/.pagelayout#excel-javascript/api/excel/-pagelayout-printcomments-member)|Specifies if the worksheet's comments should be displayed when printing.| -||[printErrors](/.pagelayout#excel-javascript/api/excel/-pagelayout-printerrors-member)|The worksheet's print errors option.| -||[printGridlines](/.pagelayout#excel-javascript/api/excel/-pagelayout-printgridlines-member)|Specifies if the worksheet's gridlines will be printed.| -||[printHeadings](/.pagelayout#excel-javascript/api/excel/-pagelayout-printheadings-member)|Specifies if the worksheet's headings will be printed.| -||[printOrder](/.pagelayout#excel-javascript/api/excel/-pagelayout-printorder-member)|The worksheet's page print order option.| -||[rightMargin](/.pagelayout#excel-javascript/api/excel/-pagelayout-rightmargin-member)|The worksheet's right margin, in points, for use when printing.| -||[setPrintArea(printArea: Range \| RangeAreas \| string)](/.pagelayout#excel-javascript/api/excel/-pagelayout-setprintarea-member(1))|Sets the worksheet's print area.| -||[setPrintMargins(unit: Excel.PrintMarginUnit, marginOptions: Excel.PageLayoutMarginOptions)](/.pagelayout#excel-javascript/api/excel/-pagelayout-setprintmargins-member(1))|Sets the worksheet's page margins with units.| -||[setPrintTitleColumns(printTitleColumns: Range \| string)](/.pagelayout#excel-javascript/api/excel/-pagelayout-setprinttitlecolumns-member(1))|Sets the columns that contain the cells to be repeated at the left of each page of the worksheet for printing.| -||[setPrintTitleRows(printTitleRows: Range \| string)](/.pagelayout#excel-javascript/api/excel/-pagelayout-setprinttitlerows-member(1))|Sets the rows that contain the cells to be repeated at the top of each page of the worksheet for printing.| -||[topMargin](/.pagelayout#excel-javascript/api/excel/-pagelayout-topmargin-member)|The worksheet's top margin, in points, for use when printing.| -||[zoom](/.pagelayout#excel-javascript/api/excel/-pagelayout-zoom-member)|The worksheet's print zoom options.| -|[PageLayoutMarginOptions](/.pagelayoutmarginoptions)|[bottom](/.pagelayoutmarginoptions#excel-javascript/api/excel/-pagelayoutmarginoptions-bottom-member)|Specifies the page layout bottom margin in the unit specified to use for printing.| -||[footer](/.pagelayoutmarginoptions#excel-javascript/api/excel/-pagelayoutmarginoptions-footer-member)|Specifies the page layout footer margin in the unit specified to use for printing.| -||[header](/.pagelayoutmarginoptions#excel-javascript/api/excel/-pagelayoutmarginoptions-header-member)|Specifies the page layout header margin in the unit specified to use for printing.| -||[left](/.pagelayoutmarginoptions#excel-javascript/api/excel/-pagelayoutmarginoptions-left-member)|Specifies the page layout left margin in the unit specified to use for printing.| -||[right](/.pagelayoutmarginoptions#excel-javascript/api/excel/-pagelayoutmarginoptions-right-member)|Specifies the page layout right margin in the unit specified to use for printing.| -||[top](/.pagelayoutmarginoptions#excel-javascript/api/excel/-pagelayoutmarginoptions-top-member)|Specifies the page layout top margin in the unit specified to use for printing.| -|[PageLayoutZoomOptions](/.pagelayoutzoomoptions)|[horizontalFitToPages](/.pagelayoutzoomoptions#excel-javascript/api/excel/-pagelayoutzoomoptions-horizontalfittopages-member)|Number of pages to fit horizontally.| -||[scale](/.pagelayoutzoomoptions#excel-javascript/api/excel/-pagelayoutzoomoptions-scale-member)|Print page scale value can be between 10 and 400.| -||[verticalFitToPages](/.pagelayoutzoomoptions#excel-javascript/api/excel/-pagelayoutzoomoptions-verticalfittopages-member)|Number of pages to fit vertically.| -|[PivotField](/.pivotfield)|[sortByValues(sortBy: Excel.SortBy, valuesHierarchy: Excel.DataPivotHierarchy, pivotItemScope?: Array)](/.pivotfield#excel-javascript/api/excel/-pivotfield-sortbyvalues-member(1))|Sorts the PivotField by specified values in a given scope.| -|[PivotLayout](/.pivotlayout)|[autoFormat](/.pivotlayout#excel-javascript/api/excel/-pivotlayout-autoformat-member)|Specifies if formatting will be automatically formatted when it's refreshed or when fields are moved.| -||[getDataHierarchy(cell: Range \| string)](/.pivotlayout#excel-javascript/api/excel/-pivotlayout-getdatahierarchy-member(1))|Gets the DataHierarchy that is used to calculate the value in a specified range within the PivotTable.| -||[getPivotItems(axis: Excel.PivotAxis, cell: Range \| string)](/.pivotlayout#excel-javascript/api/excel/-pivotlayout-getpivotitems-member(1))|Gets the PivotItems from an axis that make up the value in a specified range within the PivotTable.| -||[preserveFormatting](/.pivotlayout#excel-javascript/api/excel/-pivotlayout-preserveformatting-member)|Specifies if formatting is preserved when the report is refreshed or recalculated by operations such as pivoting, sorting, or changing page field items.| -||[setAutoSortOnCell(cell: Range \| string, sortBy: Excel.SortBy)](/.pivotlayout#excel-javascript/api/excel/-pivotlayout-setautosortoncell-member(1))|Sets the PivotTable to automatically sort using the specified cell to automatically select all necessary criteria and context.| -|[PivotTable](/.pivottable)|[enableDataValueEditing](/.pivottable#excel-javascript/api/excel/-pivottable-enabledatavalueediting-member)|Specifies if the PivotTable allows values in the data body to be edited by the user.| -||[useCustomSortLists](/.pivottable#excel-javascript/api/excel/-pivottable-usecustomsortlists-member)|Specifies if the PivotTable uses custom lists when sorting.| -|[Range](/.range)|[autoFill(destinationRange?: Range \| string, autoFillType?: Excel.AutoFillType)](/.range#excel-javascript/api/excel/-range-autofill-member(1))|Fills a range from the current range to the destination range using the specified AutoFill logic.| -||[convertDataTypeToText()](/.range#excel-javascript/api/excel/-range-convertdatatypetotext-member(1))|Converts the range cells with data types into text.| -||[convertToLinkedDataType(serviceID: number, languageCulture: string)](/.range#excel-javascript/api/excel/-range-converttolinkeddatatype-member(1))|Converts the range cells into linked data types in the worksheet.| -||[copyFrom(sourceRange: Range \| RangeAreas \| string, copyType?: Excel.RangeCopyType, skipBlanks?: boolean, transpose?: boolean)](/.range#excel-javascript/api/excel/-range-copyfrom-member(1))|Copies cell data or formatting from the source range or `RangeAreas` to the current range.| -||[find(text: string, criteria: Excel.SearchCriteria)](/.range#excel-javascript/api/excel/-range-find-member(1))|Finds the given string based on the criteria specified.| -||[findOrNullObject(text: string, criteria: Excel.SearchCriteria)](/.range#excel-javascript/api/excel/-range-findornullobject-member(1))|Finds the given string based on the criteria specified.| -||[flashFill()](/.range#excel-javascript/api/excel/-range-flashfill-member(1))|Does a Flash Fill to the current range.| -||[getCellProperties(cellPropertiesLoadOptions: CellPropertiesLoadOptions)](/.range#excel-javascript/api/excel/-range-getcellproperties-member(1))|Returns a 2D array, encapsulating the data for each cell's font, fill, borders, alignment, and other properties.| -||[getColumnProperties(columnPropertiesLoadOptions: ColumnPropertiesLoadOptions)](/.range#excel-javascript/api/excel/-range-getcolumnproperties-member(1))|Returns a single-dimensional array, encapsulating the data for each column's font, fill, borders, alignment, and other properties.| -||[getRowProperties(rowPropertiesLoadOptions: RowPropertiesLoadOptions)](/.range#excel-javascript/api/excel/-range-getrowproperties-member(1))|Returns a single-dimensional array, encapsulating the data for each row's font, fill, borders, alignment, and other properties.| -||[getSpecialCells(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType)](/.range#excel-javascript/api/excel/-range-getspecialcells-member(1))|Gets the `RangeAreas` object, comprising one or more rectangular ranges, that represents all the cells that match the specified type and value.| -||[getSpecialCellsOrNullObject(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType)](/.range#excel-javascript/api/excel/-range-getspecialcellsornullobject-member(1))|Gets the `RangeAreas` object, comprising one or more ranges, that represents all the cells that match the specified type and value.| -||[getTables(fullyContained?: boolean)](/.range#excel-javascript/api/excel/-range-gettables-member(1))|Gets a scoped collection of tables that overlap with the range.| -||[linkedDataTypeState](/.range#excel-javascript/api/excel/-range-linkeddatatypestate-member)|Represents the data type state of each cell.| -||[removeDuplicates(columns: number[], includesHeader: boolean)](/.range#excel-javascript/api/excel/-range-removeduplicates-member(1))|Removes duplicate values from the range specified by the columns.| -||[replaceAll(text: string, replacement: string, criteria: Excel.ReplaceCriteria)](/.range#excel-javascript/api/excel/-range-replaceall-member(1))|Finds and replaces the given string based on the criteria specified within the current range.| -||[setCellProperties(cellPropertiesData: SettableCellProperties[][])](/.range#excel-javascript/api/excel/-range-setcellproperties-member(1))|Updates the range based on a 2D array of cell properties, encapsulating things like font, fill, borders, and alignment.| -||[setColumnProperties(columnPropertiesData: SettableColumnProperties[])](/.range#excel-javascript/api/excel/-range-setcolumnproperties-member(1))|Updates the range based on a single-dimensional array of column properties, encapsulating things like font, fill, borders, and alignment.| -||[setDirty()](/.range#excel-javascript/api/excel/-range-setdirty-member(1))|Set a range to be recalculated when the next recalculation occurs.| -||[setRowProperties(rowPropertiesData: SettableRowProperties[])](/.range#excel-javascript/api/excel/-range-setrowproperties-member(1))|Updates the range based on a single-dimensional array of row properties, encapsulating things like font, fill, borders, and alignment.| -|[RangeAreas](/.rangeareas)|[address](/.rangeareas#excel-javascript/api/excel/-rangeareas-address-member)|Returns the `RangeAreas` reference in A1-style.| -||[addressLocal](/.rangeareas#excel-javascript/api/excel/-rangeareas-addresslocal-member)|Returns the `RangeAreas` reference in the user locale.| -||[areaCount](/.rangeareas#excel-javascript/api/excel/-rangeareas-areacount-member)|Returns the number of rectangular ranges that comprise this `RangeAreas` object.| -||[areas](/.rangeareas#excel-javascript/api/excel/-rangeareas-areas-member)|Returns a collection of rectangular ranges that comprise this `RangeAreas` object.| -||[calculate()](/.rangeareas#excel-javascript/api/excel/-rangeareas-calculate-member(1))|Calculates all cells in the `RangeAreas`.| -||[cellCount](/.rangeareas#excel-javascript/api/excel/-rangeareas-cellcount-member)|Returns the number of cells in the `RangeAreas` object, summing up the cell counts of all of the individual rectangular ranges.| -||[clear(applyTo?: Excel.ClearApplyTo)](/.rangeareas#excel-javascript/api/excel/-rangeareas-clear-member(1))|Clears values, format, fill, border, and other properties on each of the areas that comprise this `RangeAreas` object.| -||[conditionalFormats](/.rangeareas#excel-javascript/api/excel/-rangeareas-conditionalformats-member)|Returns a collection of conditional formats that intersect with any cells in this `RangeAreas` object.| -||[convertDataTypeToText()](/.rangeareas#excel-javascript/api/excel/-rangeareas-convertdatatypetotext-member(1))|Converts all cells in the `RangeAreas` with data types into text.| -||[convertToLinkedDataType(serviceID: number, languageCulture: string)](/.rangeareas#excel-javascript/api/excel/-rangeareas-converttolinkeddatatype-member(1))|Converts all cells in the `RangeAreas` into linked data types.| -||[copyFrom(sourceRange: Range \| RangeAreas \| string, copyType?: Excel.RangeCopyType, skipBlanks?: boolean, transpose?: boolean)](/.rangeareas#excel-javascript/api/excel/-rangeareas-copyfrom-member(1))|Copies cell data or formatting from the source range or `RangeAreas` to the current `RangeAreas`.| -||[dataValidation](/.rangeareas#excel-javascript/api/excel/-rangeareas-datavalidation-member)|Returns a data validation object for all ranges in the `RangeAreas`.| -||[format](/.rangeareas#excel-javascript/api/excel/-rangeareas-format-member)|Returns a `RangeFormat` object, encapsulating the font, fill, borders, alignment, and other properties for all ranges in the `RangeAreas` object.| -||[getEntireColumn()](/.rangeareas#excel-javascript/api/excel/-rangeareas-getentirecolumn-member(1))|Returns a `RangeAreas` object that represents the entire columns of the `RangeAreas` (for example, if the current `RangeAreas` represents cells "B4:E11, H2", it returns a `RangeAreas` that represents columns "B:E, H:H").| -||[getEntireRow()](/.rangeareas#excel-javascript/api/excel/-rangeareas-getentirerow-member(1))|Returns a `RangeAreas` object that represents the entire rows of the `RangeAreas` (for example, if the current `RangeAreas` represents cells "B4:E11", it returns a `RangeAreas` that represents rows "4:11").| -||[getIntersection(anotherRange: Range \| RangeAreas \| string)](/.rangeareas#excel-javascript/api/excel/-rangeareas-getintersection-member(1))|Returns the `RangeAreas` object that represents the intersection of the given ranges or `RangeAreas`.| -||[getIntersectionOrNullObject(anotherRange: Range \| RangeAreas \| string)](/.rangeareas#excel-javascript/api/excel/-rangeareas-getintersectionornullobject-member(1))|Returns the `RangeAreas` object that represents the intersection of the given ranges or `RangeAreas`.| -||[getOffsetRangeAreas(rowOffset: number, columnOffset: number)](/.rangeareas#excel-javascript/api/excel/-rangeareas-getoffsetrangeareas-member(1))|Returns a `RangeAreas` object that is shifted by the specific row and column offset.| -||[getSpecialCells(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType)](/.rangeareas#excel-javascript/api/excel/-rangeareas-getspecialcells-member(1))|Returns a `RangeAreas` object that represents all the cells that match the specified type and value.| -||[getSpecialCellsOrNullObject(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType)](/.rangeareas#excel-javascript/api/excel/-rangeareas-getspecialcellsornullobject-member(1))|Returns a `RangeAreas` object that represents all the cells that match the specified type and value.| -||[getTables(fullyContained?: boolean)](/.rangeareas#excel-javascript/api/excel/-rangeareas-gettables-member(1))|Returns a scoped collection of tables that overlap with any range in this `RangeAreas` object.| -||[getUsedRangeAreas(valuesOnly?: boolean)](/.rangeareas#excel-javascript/api/excel/-rangeareas-getusedrangeareas-member(1))|Returns the used `RangeAreas` that comprises all the used areas of individual rectangular ranges in the `RangeAreas` object.| -||[getUsedRangeAreasOrNullObject(valuesOnly?: boolean)](/.rangeareas#excel-javascript/api/excel/-rangeareas-getusedrangeareasornullobject-member(1))|Returns the used `RangeAreas` that comprises all the used areas of individual rectangular ranges in the `RangeAreas` object.| -||[isEntireColumn](/.rangeareas#excel-javascript/api/excel/-rangeareas-isentirecolumn-member)|Specifies if all the ranges on this `RangeAreas` object represent entire columns (e.g., "A:C, Q:Z").| -||[isEntireRow](/.rangeareas#excel-javascript/api/excel/-rangeareas-isentirerow-member)|Specifies if all the ranges on this `RangeAreas` object represent entire rows (e.g., "1:3, 5:7").| -||[setDirty()](/.rangeareas#excel-javascript/api/excel/-rangeareas-setdirty-member(1))|Sets the `RangeAreas` to be recalculated when the next recalculation occurs.| -||[style](/.rangeareas#excel-javascript/api/excel/-rangeareas-style-member)|Represents the style for all ranges in this `RangeAreas` object.| -||[worksheet](/.rangeareas#excel-javascript/api/excel/-rangeareas-worksheet-member)|Returns the worksheet for the current `RangeAreas`.| -|[RangeBorder](/.rangeborder)|[tintAndShade](/.rangeborder#excel-javascript/api/excel/-rangeborder-tintandshade-member)|Specifies a double that lightens or darkens a color for the range border, the value is between -1 (darkest) and 1 (brightest), with 0 for the original color.| -|[RangeBorderCollection](/.rangebordercollection)|[tintAndShade](/.rangebordercollection#excel-javascript/api/excel/-rangebordercollection-tintandshade-member)|Specifies a double that lightens or darkens a color for range borders.| -|[RangeCollection](/.rangecollection)|[getCount()](/.rangecollection#excel-javascript/api/excel/-rangecollection-getcount-member(1))|Returns the number of ranges in the `RangeCollection`.| -||[getItemAt(index: number)](/.rangecollection#excel-javascript/api/excel/-rangecollection-getitemat-member(1))|Returns the range object based on its position in the `RangeCollection`.| -||[items](/.rangecollection#excel-javascript/api/excel/-rangecollection-items-member)|Gets the loaded child items in this collection.| -|[RangeFill](/.rangefill)|[pattern](/.rangefill#excel-javascript/api/excel/-rangefill-pattern-member)|The pattern of a range.| -||[patternColor](/.rangefill#excel-javascript/api/excel/-rangefill-patterncolor-member)|The HTML color code representing the color of the range pattern, in the form #RRGGBB (e.g., "FFA500"), or as a named HTML color (e.g., "orange").| -||[patternTintAndShade](/.rangefill#excel-javascript/api/excel/-rangefill-patterntintandshade-member)|Specifies a double that lightens or darkens a pattern color for the range fill.| -||[tintAndShade](/.rangefill#excel-javascript/api/excel/-rangefill-tintandshade-member)|Specifies a double that lightens or darkens a color for the range fill.| -|[RangeFont](/.rangefont)|[strikethrough](/.rangefont#excel-javascript/api/excel/-rangefont-strikethrough-member)|Specifies the strikethrough status of font.| -||[subscript](/.rangefont#excel-javascript/api/excel/-rangefont-subscript-member)|Specifies the subscript status of font.| -||[superscript](/.rangefont#excel-javascript/api/excel/-rangefont-superscript-member)|Specifies the superscript status of font.| -||[tintAndShade](/.rangefont#excel-javascript/api/excel/-rangefont-tintandshade-member)|Specifies a double that lightens or darkens a color for the range font.| -|[RangeFormat](/.rangeformat)|[autoIndent](/.rangeformat#excel-javascript/api/excel/-rangeformat-autoindent-member)|Specifies if text is automatically indented when text alignment is set to equal distribution.| -||[indentLevel](/.rangeformat#excel-javascript/api/excel/-rangeformat-indentlevel-member)|An integer from 0 to 250 that indicates the indent level.| -||[readingOrder](/.rangeformat#excel-javascript/api/excel/-rangeformat-readingorder-member)|The reading order for the range.| -||[shrinkToFit](/.rangeformat#excel-javascript/api/excel/-rangeformat-shrinktofit-member)|Specifies if text automatically shrinks to fit in the available column width.| -|[RemoveDuplicatesResult](/.removeduplicatesresult)|[removed](/.removeduplicatesresult#excel-javascript/api/excel/-removeduplicatesresult-removed-member)|Number of duplicated rows removed by the operation.| -||[uniqueRemaining](/.removeduplicatesresult#excel-javascript/api/excel/-removeduplicatesresult-uniqueremaining-member)|Number of remaining unique rows present in the resulting range.| -|[ReplaceCriteria](/.replacecriteria)|[completeMatch](/.replacecriteria#excel-javascript/api/excel/-replacecriteria-completematch-member)|Specifies if the match needs to be complete or partial.| -||[matchCase](/.replacecriteria#excel-javascript/api/excel/-replacecriteria-matchcase-member)|Specifies if the match is case-sensitive.| -|[RowProperties](/.rowproperties)|[address](/.rowproperties#excel-javascript/api/excel/-rowproperties-address-member)|Represents the `address` property.| -||[addressLocal](/.rowproperties#excel-javascript/api/excel/-rowproperties-addresslocal-member)|Represents the `addressLocal` property.| -||[rowIndex](/.rowproperties#excel-javascript/api/excel/-rowproperties-rowindex-member)|Represents the `rowIndex` property.| -|[SearchCriteria](/.searchcriteria)|[completeMatch](/.searchcriteria#excel-javascript/api/excel/-searchcriteria-completematch-member)|Specifies if the match needs to be complete or partial.| -||[matchCase](/.searchcriteria#excel-javascript/api/excel/-searchcriteria-matchcase-member)|Specifies if the match is case-sensitive.| -||[searchDirection](/.searchcriteria#excel-javascript/api/excel/-searchcriteria-searchdirection-member)|Specifies the search direction.| -|[SettableCellProperties](/.settablecellproperties)|[format](/.settablecellproperties#excel-javascript/api/excel/-settablecellproperties-format-member)|Represents the `format` property.| -||[hyperlink](/.settablecellproperties#excel-javascript/api/excel/-settablecellproperties-hyperlink-member)|Represents the `hyperlink` property.| -||[style](/.settablecellproperties#excel-javascript/api/excel/-settablecellproperties-style-member)|Represents the `style` property.| -|[SettableColumnProperties](/.settablecolumnproperties)|[columnHidden](/.settablecolumnproperties#excel-javascript/api/excel/-settablecolumnproperties-columnhidden-member)|Represents the `columnHidden` property.| -||[format](/.settablecolumnproperties#excel-javascript/api/excel/-settablecolumnproperties-format-member)|Represents the `format` property.| -|[SettableRowProperties](/.settablerowproperties)|[format](/.settablerowproperties#excel-javascript/api/excel/-settablerowproperties-format-member)|Represents the `format` property.| -||[rowHidden](/.settablerowproperties#excel-javascript/api/excel/-settablerowproperties-rowhidden-member)|Represents the `rowHidden` property.| -|[Shape](/.shape)|[altTextDescription](/.shape#excel-javascript/api/excel/-shape-alttextdescription-member)|Specifies the alternative description text for a `Shape` object.| -||[altTextTitle](/.shape#excel-javascript/api/excel/-shape-alttexttitle-member)|Specifies the alternative title text for a `Shape` object.| -||[connectionSiteCount](/.shape#excel-javascript/api/excel/-shape-connectionsitecount-member)|Returns the number of connection sites on this shape.| -||[delete()](/.shape#excel-javascript/api/excel/-shape-delete-member(1))|Removes the shape from the worksheet.| -||[fill](/.shape#excel-javascript/api/excel/-shape-fill-member)|Returns the fill formatting of this shape.| -||[geometricShape](/.shape#excel-javascript/api/excel/-shape-geometricshape-member)|Returns the geometric shape associated with the shape.| -||[geometricShapeType](/.shape#excel-javascript/api/excel/-shape-geometricshapetype-member)|Specifies the geometric shape type of this geometric shape.| -||[getAsImage(format: Excel.PictureFormat)](/.shape#excel-javascript/api/excel/-shape-getasimage-member(1))|Converts the shape to an image and returns the image as a Base64-encoded string.| -||[group](/.shape#excel-javascript/api/excel/-shape-group-member)|Returns the shape group associated with the shape.| -||[height](/.shape#excel-javascript/api/excel/-shape-height-member)|Specifies the height, in points, of the shape.| -||[id](/.shape#excel-javascript/api/excel/-shape-id-member)|Specifies the shape identifier.| -||[image](/.shape#excel-javascript/api/excel/-shape-image-member)|Returns the image associated with the shape.| -||[incrementLeft(increment: number)](/.shape#excel-javascript/api/excel/-shape-incrementleft-member(1))|Moves the shape horizontally by the specified number of points.| -||[incrementRotation(increment: number)](/.shape#excel-javascript/api/excel/-shape-incrementrotation-member(1))|Rotates the shape clockwise around the z-axis by the specified number of degrees.| -||[incrementTop(increment: number)](/.shape#excel-javascript/api/excel/-shape-incrementtop-member(1))|Moves the shape vertically by the specified number of points.| -||[left](/.shape#excel-javascript/api/excel/-shape-left-member)|The distance, in points, from the left side of the shape to the left side of the worksheet.| -||[level](/.shape#excel-javascript/api/excel/-shape-level-member)|Specifies the level of the specified shape.| -||[line](/.shape#excel-javascript/api/excel/-shape-line-member)|Returns the line associated with the shape.| -||[lineFormat](/.shape#excel-javascript/api/excel/-shape-lineformat-member)|Returns the line formatting of this shape.| -||[lockAspectRatio](/.shape#excel-javascript/api/excel/-shape-lockaspectratio-member)|Specifies if the aspect ratio of this shape is locked.| -||[name](/.shape#excel-javascript/api/excel/-shape-name-member)|Specifies the name of the shape.| -||[onActivated](/.shape#excel-javascript/api/excel/-shape-onactivated-member)|Occurs when the shape is activated.| -||[onDeactivated](/.shape#excel-javascript/api/excel/-shape-ondeactivated-member)|Occurs when the shape is deactivated.| -||[parentGroup](/.shape#excel-javascript/api/excel/-shape-parentgroup-member)|Specifies the parent group of this shape.| -||[rotation](/.shape#excel-javascript/api/excel/-shape-rotation-member)|Specifies the rotation, in degrees, of the shape.| -||[scaleHeight(scaleFactor: number, scaleType: Excel.ShapeScaleType, scaleFrom?: Excel.ShapeScaleFrom)](/.shape#excel-javascript/api/excel/-shape-scaleheight-member(1))|Scales the height of the shape by a specified factor.| -||[scaleWidth(scaleFactor: number, scaleType: Excel.ShapeScaleType, scaleFrom?: Excel.ShapeScaleFrom)](/.shape#excel-javascript/api/excel/-shape-scalewidth-member(1))|Scales the width of the shape by a specified factor.| -||[setZOrder(position: Excel.ShapeZOrder)](/.shape#excel-javascript/api/excel/-shape-setzorder-member(1))|Moves the specified shape up or down the collection's z-order, which shifts it in front of or behind other shapes.| -||[textFrame](/.shape#excel-javascript/api/excel/-shape-textframe-member)|Returns the text frame object of this shape.| -||[top](/.shape#excel-javascript/api/excel/-shape-top-member)|The distance, in points, from the top edge of the shape to the top edge of the worksheet.| -||[type](/.shape#excel-javascript/api/excel/-shape-type-member)|Returns the type of this shape.| -||[visible](/.shape#excel-javascript/api/excel/-shape-visible-member)|Specifies if the shape is visible.| -||[width](/.shape#excel-javascript/api/excel/-shape-width-member)|Specifies the width, in points, of the shape.| -||[zOrderPosition](/.shape#excel-javascript/api/excel/-shape-zorderposition-member)|Returns the position of the specified shape in the z-order, with 0 representing the bottom of the order stack.| -|[ShapeActivatedEventArgs](/.shapeactivatedeventargs)|[shapeId](/.shapeactivatedeventargs#excel-javascript/api/excel/-shapeactivatedeventargs-shapeid-member)|Gets the ID of the activated shape.| -||[type](/.shapeactivatedeventargs#excel-javascript/api/excel/-shapeactivatedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/.shapeactivatedeventargs#excel-javascript/api/excel/-shapeactivatedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the shape is activated.| -|[ShapeCollection](/.shapecollection)|[addGeometricShape(geometricShapeType: Excel.GeometricShapeType)](/.shapecollection#excel-javascript/api/excel/-shapecollection-addgeometricshape-member(1))|Adds a geometric shape to the worksheet.| -||[addGroup(values: Array)](/.shapecollection#excel-javascript/api/excel/-shapecollection-addgroup-member(1))|Groups a subset of shapes in this collection's worksheet.| -||[addImage(base64ImageString: string)](/.shapecollection#excel-javascript/api/excel/-shapecollection-addimage-member(1))|Creates an image from a Base64-encoded string and adds it to the worksheet.| -||[addLine(startLeft: number, startTop: number, endLeft: number, endTop: number, connectorType?: Excel.ConnectorType)](/.shapecollection#excel-javascript/api/excel/-shapecollection-addline-member(1))|Adds a line to worksheet.| -||[addTextBox(text?: string)](/.shapecollection#excel-javascript/api/excel/-shapecollection-addtextbox-member(1))|Adds a text box to the worksheet with the provided text as the content.| -||[getCount()](/.shapecollection#excel-javascript/api/excel/-shapecollection-getcount-member(1))|Returns the number of shapes in the worksheet.| -||[getItem(key: string)](/.shapecollection#excel-javascript/api/excel/-shapecollection-getitem-member(1))|Gets a shape using its name or ID.| -||[getItemAt(index: number)](/.shapecollection#excel-javascript/api/excel/-shapecollection-getitemat-member(1))|Gets a shape using its position in the collection.| -||[items](/.shapecollection#excel-javascript/api/excel/-shapecollection-items-member)|Gets the loaded child items in this collection.| -|[ShapeDeactivatedEventArgs](/.shapedeactivatedeventargs)|[shapeId](/.shapedeactivatedeventargs#excel-javascript/api/excel/-shapedeactivatedeventargs-shapeid-member)|Gets the ID of the shape deactivated shape.| -||[type](/.shapedeactivatedeventargs#excel-javascript/api/excel/-shapedeactivatedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/.shapedeactivatedeventargs#excel-javascript/api/excel/-shapedeactivatedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the shape is deactivated.| -|[ShapeFill](/.shapefill)|[clear()](/.shapefill#excel-javascript/api/excel/-shapefill-clear-member(1))|Clears the fill formatting of this shape.| -||[foregroundColor](/.shapefill#excel-javascript/api/excel/-shapefill-foregroundcolor-member)|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")| -||[setSolidColor(color: string)](/.shapefill#excel-javascript/api/excel/-shapefill-setsolidcolor-member(1))|Sets the fill formatting of the shape to a uniform color.| -||[transparency](/.shapefill#excel-javascript/api/excel/-shapefill-transparency-member)|Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).| -||[type](/.shapefill#excel-javascript/api/excel/-shapefill-type-member)|Returns the fill type of the shape.| -|[ShapeFont](/.shapefont)|[bold](/.shapefont#excel-javascript/api/excel/-shapefont-bold-member)|Represents the bold status of font.| -||[color](/.shapefont#excel-javascript/api/excel/-shapefont-color-member)|HTML color code representation of the text color (e.g., "#FF0000" represents red).| -||[italic](/.shapefont#excel-javascript/api/excel/-shapefont-italic-member)|Represents the italic status of font.| -||[name](/.shapefont#excel-javascript/api/excel/-shapefont-name-member)|Represents font name (e.g., "Calibri").| -||[size](/.shapefont#excel-javascript/api/excel/-shapefont-size-member)|Represents font size in points (e.g., 11).| -||[underline](/.shapefont#excel-javascript/api/excel/-shapefont-underline-member)|Type of underline applied to the font.| -|[ShapeGroup](/.shapegroup)|[id](/.shapegroup#excel-javascript/api/excel/-shapegroup-id-member)|Specifies the shape identifier.| -||[shape](/.shapegroup#excel-javascript/api/excel/-shapegroup-shape-member)|Returns the `Shape` object associated with the group.| -||[shapes](/.shapegroup#excel-javascript/api/excel/-shapegroup-shapes-member)|Returns the collection of `Shape` objects.| -||[ungroup()](/.shapegroup#excel-javascript/api/excel/-shapegroup-ungroup-member(1))|Ungroups any grouped shapes in the specified shape group.| -|[ShapeLineFormat](/.shapelineformat)|[color](/.shapelineformat#excel-javascript/api/excel/-shapelineformat-color-member)|Represents the line color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").| -||[dashStyle](/.shapelineformat#excel-javascript/api/excel/-shapelineformat-dashstyle-member)|Represents the line style of the shape.| -||[style](/.shapelineformat#excel-javascript/api/excel/-shapelineformat-style-member)|Represents the line style of the shape.| -||[transparency](/.shapelineformat#excel-javascript/api/excel/-shapelineformat-transparency-member)|Represents the degree of transparency of the specified line as a value from 0.0 (opaque) through 1.0 (clear).| -||[visible](/.shapelineformat#excel-javascript/api/excel/-shapelineformat-visible-member)|Specifies if the line formatting of a shape element is visible.| -||[weight](/.shapelineformat#excel-javascript/api/excel/-shapelineformat-weight-member)|Represents the weight of the line, in points.| -|[SortField](/.sortfield)|[subField](/.sortfield#excel-javascript/api/excel/-sortfield-subfield-member)|Specifies the subfield that is the target property name of a rich value to sort on.| -|[StyleCollection](/.stylecollection)|[getCount()](/.stylecollection#excel-javascript/api/excel/-stylecollection-getcount-member(1))|Gets the number of styles in the collection.| -||[getItemAt(index: number)](/.stylecollection#excel-javascript/api/excel/-stylecollection-getitemat-member(1))|Gets a style based on its position in the collection.| -|[Table](/.table)|[autoFilter](/.table#excel-javascript/api/excel/-table-autofilter-member)|Represents the `AutoFilter` object of the table.| -|[TableAddedEventArgs](/.tableaddedeventargs)|[source](/.tableaddedeventargs#excel-javascript/api/excel/-tableaddedeventargs-source-member)|Gets the source of the event.| -||[tableId](/.tableaddedeventargs#excel-javascript/api/excel/-tableaddedeventargs-tableid-member)|Gets the ID of the table that is added.| -||[type](/.tableaddedeventargs#excel-javascript/api/excel/-tableaddedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/.tableaddedeventargs#excel-javascript/api/excel/-tableaddedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the table is added.| -|[TableChangedEventArgs](/.tablechangedeventargs)|[details](/.tablechangedeventargs#excel-javascript/api/excel/-tablechangedeventargs-details-member)|Gets the information about the change detail.| -|[TableCollection](/.tablecollection)|[onAdded](/.tablecollection#excel-javascript/api/excel/-tablecollection-onadded-member)|Occurs when a new table is added in a workbook.| -||[onDeleted](/.tablecollection#excel-javascript/api/excel/-tablecollection-ondeleted-member)|Occurs when the specified table is deleted in a workbook.| -|[TableDeletedEventArgs](/.tabledeletedeventargs)|[source](/.tabledeletedeventargs#excel-javascript/api/excel/-tabledeletedeventargs-source-member)|Gets the source of the event.| -||[tableId](/.tabledeletedeventargs#excel-javascript/api/excel/-tabledeletedeventargs-tableid-member)|Gets the ID of the table that is deleted.| -||[tableName](/.tabledeletedeventargs#excel-javascript/api/excel/-tabledeletedeventargs-tablename-member)|Gets the name of the table that is deleted.| -||[type](/.tabledeletedeventargs#excel-javascript/api/excel/-tabledeletedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/.tabledeletedeventargs#excel-javascript/api/excel/-tabledeletedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the table is deleted.| -|[TableScopedCollection](/.tablescopedcollection)|[getCount()](/.tablescopedcollection#excel-javascript/api/excel/-tablescopedcollection-getcount-member(1))|Gets the number of tables in the collection.| -||[getFirst()](/.tablescopedcollection#excel-javascript/api/excel/-tablescopedcollection-getfirst-member(1))|Gets the first table in the collection.| -||[getItem(key: string)](/.tablescopedcollection#excel-javascript/api/excel/-tablescopedcollection-getitem-member(1))|Gets a table by name or ID.| -||[items](/.tablescopedcollection#excel-javascript/api/excel/-tablescopedcollection-items-member)|Gets the loaded child items in this collection.| -|[TextFrame](/.textframe)|[autoSizeSetting](/.textframe#excel-javascript/api/excel/-textframe-autosizesetting-member)|The automatic sizing settings for the text frame.| -||[bottomMargin](/.textframe#excel-javascript/api/excel/-textframe-bottommargin-member)|Represents the bottom margin, in points, of the text frame.| -||[deleteText()](/.textframe#excel-javascript/api/excel/-textframe-deletetext-member(1))|Deletes all the text in the text frame.| -||[hasText](/.textframe#excel-javascript/api/excel/-textframe-hastext-member)|Specifies if the text frame contains text.| -||[horizontalAlignment](/.textframe#excel-javascript/api/excel/-textframe-horizontalalignment-member)|Represents the horizontal alignment of the text frame.| -||[horizontalOverflow](/.textframe#excel-javascript/api/excel/-textframe-horizontaloverflow-member)|Represents the horizontal overflow behavior of the text frame.| -||[leftMargin](/.textframe#excel-javascript/api/excel/-textframe-leftmargin-member)|Represents the left margin, in points, of the text frame.| -||[orientation](/.textframe#excel-javascript/api/excel/-textframe-orientation-member)|Represents the angle to which the text is oriented for the text frame.| -||[readingOrder](/.textframe#excel-javascript/api/excel/-textframe-readingorder-member)|Represents the reading order of the text frame, either left-to-right or right-to-left.| -||[rightMargin](/.textframe#excel-javascript/api/excel/-textframe-rightmargin-member)|Represents the right margin, in points, of the text frame.| -||[textRange](/.textframe#excel-javascript/api/excel/-textframe-textrange-member)|Represents the text that is attached to a shape in the text frame, and properties and methods for manipulating the text.| -||[topMargin](/.textframe#excel-javascript/api/excel/-textframe-topmargin-member)|Represents the top margin, in points, of the text frame.| -||[verticalAlignment](/.textframe#excel-javascript/api/excel/-textframe-verticalalignment-member)|Represents the vertical alignment of the text frame.| -||[verticalOverflow](/.textframe#excel-javascript/api/excel/-textframe-verticaloverflow-member)|Represents the vertical overflow behavior of the text frame.| -|[TextRange](/.textrange)|[font](/.textrange#excel-javascript/api/excel/-textrange-font-member)|Returns a `ShapeFont` object that represents the font attributes for the text range.| -||[getSubstring(start: number, length?: number)](/.textrange#excel-javascript/api/excel/-textrange-getsubstring-member(1))|Returns a TextRange object for the substring in the given range.| -||[text](/.textrange#excel-javascript/api/excel/-textrange-text-member)|Represents the plain text content of the text range.| -|[Workbook](/.workbook)|[autoSave](/.workbook#excel-javascript/api/excel/-workbook-autosave-member)|Specifies if the workbook is in AutoSave mode.| -||[calculationEngineVersion](/.workbook#excel-javascript/api/excel/-workbook-calculationengineversion-member)|Returns a number about the version of Excel Calculation Engine.| -||[chartDataPointTrack](/.workbook#excel-javascript/api/excel/-workbook-chartdatapointtrack-member)|True if all charts in the workbook are tracking the actual data points to which they are attached.| -||[getActiveChart()](/.workbook#excel-javascript/api/excel/-workbook-getactivechart-member(1))|Gets the currently active chart in the workbook.| -||[getActiveChartOrNullObject()](/.workbook#excel-javascript/api/excel/-workbook-getactivechartornullobject-member(1))|Gets the currently active chart in the workbook.| -||[getIsActiveCollabSession()](/.workbook#excel-javascript/api/excel/-workbook-getisactivecollabsession-member(1))|Returns `true` if the workbook is being edited by multiple users (through co-authoring).| -||[getSelectedRanges()](/.workbook#excel-javascript/api/excel/-workbook-getselectedranges-member(1))|Gets the currently selected one or more ranges from the workbook.| -||[isDirty](/.workbook#excel-javascript/api/excel/-workbook-isdirty-member)|Specifies if changes have been made since the workbook was last saved.| -||[onAutoSaveSettingChanged](/.workbook#excel-javascript/api/excel/-workbook-onautosavesettingchanged-member)|Occurs when the AutoSave setting is changed on the workbook.| -||[previouslySaved](/.workbook#excel-javascript/api/excel/-workbook-previouslysaved-member)|Specifies if the workbook has ever been saved locally or online.| -||[usePrecisionAsDisplayed](/.workbook#excel-javascript/api/excel/-workbook-useprecisionasdisplayed-member)|True if calculations in this workbook will be done using only the precision of the numbers as they're displayed.| -|[WorkbookAutoSaveSettingChangedEventArgs](/.workbookautosavesettingchangedeventargs)|[type](/.workbookautosavesettingchangedeventargs#excel-javascript/api/excel/-workbookautosavesettingchangedeventargs-type-member)|Gets the type of the event.| -|[Worksheet](/.worksheet)|[autoFilter](/.worksheet#excel-javascript/api/excel/-worksheet-autofilter-member)|Represents the `AutoFilter` object of the worksheet.| -||[enableCalculation](/.worksheet#excel-javascript/api/excel/-worksheet-enablecalculation-member)|Determines if Excel should recalculate the worksheet when necessary.| -||[findAll(text: string, criteria: Excel.WorksheetSearchCriteria)](/.worksheet#excel-javascript/api/excel/-worksheet-findall-member(1))|Finds all occurrences of the given string based on the criteria specified and returns them as a `RangeAreas` object, comprising one or more rectangular ranges.| -||[findAllOrNullObject(text: string, criteria: Excel.WorksheetSearchCriteria)](/.worksheet#excel-javascript/api/excel/-worksheet-findallornullobject-member(1))|Finds all occurrences of the given string based on the criteria specified and returns them as a `RangeAreas` object, comprising one or more rectangular ranges.| -||[getRanges(address?: string)](/.worksheet#excel-javascript/api/excel/-worksheet-getranges-member(1))|Gets the `RangeAreas` object, representing one or more blocks of rectangular ranges, specified by the address or name.| -||[horizontalPageBreaks](/.worksheet#excel-javascript/api/excel/-worksheet-horizontalpagebreaks-member)|Gets the horizontal page break collection for the worksheet.| -||[onFormatChanged](/.worksheet#excel-javascript/api/excel/-worksheet-onformatchanged-member)|Occurs when format changed on a specific worksheet.| -||[pageLayout](/.worksheet#excel-javascript/api/excel/-worksheet-pagelayout-member)|Gets the `PageLayout` object of the worksheet.| -||[replaceAll(text: string, replacement: string, criteria: Excel.ReplaceCriteria)](/.worksheet#excel-javascript/api/excel/-worksheet-replaceall-member(1))|Finds and replaces the given string based on the criteria specified within the current worksheet.| -||[shapes](/.worksheet#excel-javascript/api/excel/-worksheet-shapes-member)|Returns the collection of all the Shape objects on the worksheet.| -||[verticalPageBreaks](/.worksheet#excel-javascript/api/excel/-worksheet-verticalpagebreaks-member)|Gets the vertical page break collection for the worksheet.| -|[WorksheetChangedEventArgs](/.worksheetchangedeventargs)|[details](/.worksheetchangedeventargs#excel-javascript/api/excel/-worksheetchangedeventargs-details-member)|Represents the information about the change detail.| -|[WorksheetCollection](/.worksheetcollection)|[onChanged](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-onchanged-member)|Occurs when any worksheet in the workbook is changed.| -||[onFormatChanged](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-onformatchanged-member)|Occurs when any worksheet in the workbook has a format changed.| -||[onSelectionChanged](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-onselectionchanged-member)|Occurs when the selection changes on any worksheet.| -|[WorksheetFormatChangedEventArgs](/.worksheetformatchangedeventargs)|[address](/.worksheetformatchangedeventargs#excel-javascript/api/excel/-worksheetformatchangedeventargs-address-member)|Gets the range address that represents the changed area of a specific worksheet.| -||[getRange(ctx: Excel.RequestContext)](/.worksheetformatchangedeventargs#excel-javascript/api/excel/-worksheetformatchangedeventargs-getrange-member(1))|Gets the range that represents the changed area of a specific worksheet.| -||[getRangeOrNullObject(ctx: Excel.RequestContext)](/.worksheetformatchangedeventargs#excel-javascript/api/excel/-worksheetformatchangedeventargs-getrangeornullobject-member(1))|Gets the range that represents the changed area of a specific worksheet.| -||[source](/.worksheetformatchangedeventargs#excel-javascript/api/excel/-worksheetformatchangedeventargs-source-member)|Gets the source of the event.| -||[type](/.worksheetformatchangedeventargs#excel-javascript/api/excel/-worksheetformatchangedeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/.worksheetformatchangedeventargs#excel-javascript/api/excel/-worksheetformatchangedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the data changed.| -|[WorksheetSearchCriteria](/.worksheetsearchcriteria)|[completeMatch](/.worksheetsearchcriteria#excel-javascript/api/excel/-worksheetsearchcriteria-completematch-member)|Specifies if the match needs to be complete or partial.| -||[matchCase](/.worksheetsearchcriteria#excel-javascript/api/excel/-worksheetsearchcriteria-matchcase-member)|Specifies if the match is case-sensitive.| +|[Application](/javascript/api/excel/excel.application)|[calculationEngineVersion](/javascript/api/excel/excel.application#excel-excel-application-calculationengineversion-member)|Returns the Excel calculation engine version used for the last full recalculation.| +||[calculationState](/javascript/api/excel/excel.application#excel-excel-application-calculationstate-member)|Returns the calculation state of the application.| +||[iterativeCalculation](/javascript/api/excel/excel.application#excel-excel-application-iterativecalculation-member)|Returns the iterative calculation settings.| +||[suspendScreenUpdatingUntilNextSync()](/javascript/api/excel/excel.application#excel-excel-application-suspendscreenupdatinguntilnextsync-member(1))|Suspends screen updating until the next `context.sync()` is called.| +|[AutoFilter](/javascript/api/excel/excel.autofilter)|[apply(range: Range \| string, columnIndex?: number, criteria?: Excel.FilterCriteria)](/javascript/api/excel/excel.autofilter#excel-excel-autofilter-apply-member(1))|Applies the AutoFilter to a range.| +||[clearCriteria()](/javascript/api/excel/excel.autofilter#excel-excel-autofilter-clearcriteria-member(1))|Clears the filter criteria and sort state of the AutoFilter.| +||[criteria](/javascript/api/excel/excel.autofilter#excel-excel-autofilter-criteria-member)|An array that holds all the filter criteria in the autofiltered range.| +||[enabled](/javascript/api/excel/excel.autofilter#excel-excel-autofilter-enabled-member)|Specifies if the AutoFilter is enabled.| +||[getRange()](/javascript/api/excel/excel.autofilter#excel-excel-autofilter-getrange-member(1))|Returns the `Range` object that represents the range to which the AutoFilter applies.| +||[getRangeOrNullObject()](/javascript/api/excel/excel.autofilter#excel-excel-autofilter-getrangeornullobject-member(1))|Returns the `Range` object that represents the range to which the AutoFilter applies.| +||[isDataFiltered](/javascript/api/excel/excel.autofilter#excel-excel-autofilter-isdatafiltered-member)|Specifies if the AutoFilter has filter criteria.| +||[reapply()](/javascript/api/excel/excel.autofilter#excel-excel-autofilter-reapply-member(1))|Applies the specified AutoFilter object currently on the range.| +||[remove()](/javascript/api/excel/excel.autofilter#excel-excel-autofilter-remove-member(1))|Removes the AutoFilter for the range.| +|[CellBorder](/javascript/api/excel/excel.cellborder)|[color](/javascript/api/excel/excel.cellborder#excel-excel-cellborder-color-member)|Represents the `color` property of a single border.| +||[style](/javascript/api/excel/excel.cellborder#excel-excel-cellborder-style-member)|Represents the `style` property of a single border.| +||[tintAndShade](/javascript/api/excel/excel.cellborder#excel-excel-cellborder-tintandshade-member)|Represents the `tintAndShade` property of a single border.| +||[weight](/javascript/api/excel/excel.cellborder#excel-excel-cellborder-weight-member)|Represents the `weight` property of a single border.| +|[CellBorderCollection](/javascript/api/excel/excel.cellbordercollection)|[bottom](/javascript/api/excel/excel.cellbordercollection#excel-excel-cellbordercollection-bottom-member)|Represents the `format.borders.bottom` property.| +||[diagonalDown](/javascript/api/excel/excel.cellbordercollection#excel-excel-cellbordercollection-diagonaldown-member)|Represents the `format.borders.diagonalDown` property.| +||[diagonalUp](/javascript/api/excel/excel.cellbordercollection#excel-excel-cellbordercollection-diagonalup-member)|Represents the `format.borders.diagonalUp` property.| +||[horizontal](/javascript/api/excel/excel.cellbordercollection#excel-excel-cellbordercollection-horizontal-member)|Represents the `format.borders.horizontal` property.| +||[left](/javascript/api/excel/excel.cellbordercollection#excel-excel-cellbordercollection-left-member)|Represents the `format.borders.left` property.| +||[right](/javascript/api/excel/excel.cellbordercollection#excel-excel-cellbordercollection-right-member)|Represents the `format.borders.right` property.| +||[top](/javascript/api/excel/excel.cellbordercollection#excel-excel-cellbordercollection-top-member)|Represents the `format.borders.top` property.| +||[vertical](/javascript/api/excel/excel.cellbordercollection#excel-excel-cellbordercollection-vertical-member)|Represents the `format.borders.vertical` property.| +|[CellProperties](/javascript/api/excel/excel.cellproperties)|[address](/javascript/api/excel/excel.cellproperties#excel-excel-cellproperties-address-member)|Represents the `address` property.| +||[addressLocal](/javascript/api/excel/excel.cellproperties#excel-excel-cellproperties-addresslocal-member)|Represents the `addressLocal` property.| +||[hidden](/javascript/api/excel/excel.cellproperties#excel-excel-cellproperties-hidden-member)|Represents the `hidden` property.| +|[CellPropertiesFill](/javascript/api/excel/excel.cellpropertiesfill)|[color](/javascript/api/excel/excel.cellpropertiesfill#excel-excel-cellpropertiesfill-color-member)|Represents the `format.fill.color` property.| +||[pattern](/javascript/api/excel/excel.cellpropertiesfill#excel-excel-cellpropertiesfill-pattern-member)|Represents the `format.fill.pattern` property.| +||[patternColor](/javascript/api/excel/excel.cellpropertiesfill#excel-excel-cellpropertiesfill-patterncolor-member)|Represents the `format.fill.patternColor` property.| +||[patternTintAndShade](/javascript/api/excel/excel.cellpropertiesfill#excel-excel-cellpropertiesfill-patterntintandshade-member)|Represents the `format.fill.patternTintAndShade` property.| +||[tintAndShade](/javascript/api/excel/excel.cellpropertiesfill#excel-excel-cellpropertiesfill-tintandshade-member)|Represents the `format.fill.tintAndShade` property.| +|[CellPropertiesFont](/javascript/api/excel/excel.cellpropertiesfont)|[bold](/javascript/api/excel/excel.cellpropertiesfont#excel-excel-cellpropertiesfont-bold-member)|Represents the `format.font.bold` property.| +||[color](/javascript/api/excel/excel.cellpropertiesfont#excel-excel-cellpropertiesfont-color-member)|Represents the `format.font.color` property.| +||[italic](/javascript/api/excel/excel.cellpropertiesfont#excel-excel-cellpropertiesfont-italic-member)|Represents the `format.font.italic` property.| +||[name](/javascript/api/excel/excel.cellpropertiesfont#excel-excel-cellpropertiesfont-name-member)|Represents the `format.font.name` property.| +||[size](/javascript/api/excel/excel.cellpropertiesfont#excel-excel-cellpropertiesfont-size-member)|Represents the `format.font.size` property.| +||[strikethrough](/javascript/api/excel/excel.cellpropertiesfont#excel-excel-cellpropertiesfont-strikethrough-member)|Represents the `format.font.strikethrough` property.| +||[subscript](/javascript/api/excel/excel.cellpropertiesfont#excel-excel-cellpropertiesfont-subscript-member)|Represents the `format.font.subscript` property.| +||[superscript](/javascript/api/excel/excel.cellpropertiesfont#excel-excel-cellpropertiesfont-superscript-member)|Represents the `format.font.superscript` property.| +||[tintAndShade](/javascript/api/excel/excel.cellpropertiesfont#excel-excel-cellpropertiesfont-tintandshade-member)|Represents the `format.font.tintAndShade` property.| +||[underline](/javascript/api/excel/excel.cellpropertiesfont#excel-excel-cellpropertiesfont-underline-member)|Represents the `format.font.underline` property.| +|[CellPropertiesFormat](/javascript/api/excel/excel.cellpropertiesformat)|[autoIndent](/javascript/api/excel/excel.cellpropertiesformat#excel-excel-cellpropertiesformat-autoindent-member)|Represents the `autoIndent` property.| +||[borders](/javascript/api/excel/excel.cellpropertiesformat#excel-excel-cellpropertiesformat-borders-member)|Represents the `borders` property.| +||[fill](/javascript/api/excel/excel.cellpropertiesformat#excel-excel-cellpropertiesformat-fill-member)|Represents the `fill` property.| +||[font](/javascript/api/excel/excel.cellpropertiesformat#excel-excel-cellpropertiesformat-font-member)|Represents the `font` property.| +||[horizontalAlignment](/javascript/api/excel/excel.cellpropertiesformat#excel-excel-cellpropertiesformat-horizontalalignment-member)|Represents the `horizontalAlignment` property.| +||[indentLevel](/javascript/api/excel/excel.cellpropertiesformat#excel-excel-cellpropertiesformat-indentlevel-member)|Represents the `indentLevel` property.| +||[protection](/javascript/api/excel/excel.cellpropertiesformat#excel-excel-cellpropertiesformat-protection-member)|Represents the `protection` property.| +||[readingOrder](/javascript/api/excel/excel.cellpropertiesformat#excel-excel-cellpropertiesformat-readingorder-member)|Represents the `readingOrder` property.| +||[shrinkToFit](/javascript/api/excel/excel.cellpropertiesformat#excel-excel-cellpropertiesformat-shrinktofit-member)|Represents the `shrinkToFit` property.| +||[textOrientation](/javascript/api/excel/excel.cellpropertiesformat#excel-excel-cellpropertiesformat-textorientation-member)|Represents the `textOrientation` property.| +||[useStandardHeight](/javascript/api/excel/excel.cellpropertiesformat#excel-excel-cellpropertiesformat-usestandardheight-member)|Represents the `useStandardHeight` property.| +||[useStandardWidth](/javascript/api/excel/excel.cellpropertiesformat#excel-excel-cellpropertiesformat-usestandardwidth-member)|Represents the `useStandardWidth` property.| +||[verticalAlignment](/javascript/api/excel/excel.cellpropertiesformat#excel-excel-cellpropertiesformat-verticalalignment-member)|Represents the `verticalAlignment` property.| +||[wrapText](/javascript/api/excel/excel.cellpropertiesformat#excel-excel-cellpropertiesformat-wraptext-member)|Represents the `wrapText` property.| +|[CellPropertiesProtection](/javascript/api/excel/excel.cellpropertiesprotection)|[formulaHidden](/javascript/api/excel/excel.cellpropertiesprotection#excel-excel-cellpropertiesprotection-formulahidden-member)|Represents the `format.protection.formulaHidden` property.| +||[locked](/javascript/api/excel/excel.cellpropertiesprotection#excel-excel-cellpropertiesprotection-locked-member)|Represents the `format.protection.locked` property.| +|[ChangedEventDetail](/javascript/api/excel/excel.changedeventdetail)|[valueAfter](/javascript/api/excel/excel.changedeventdetail#excel-excel-changedeventdetail-valueafter-member)|Represents the value after the change.| +||[valueBefore](/javascript/api/excel/excel.changedeventdetail#excel-excel-changedeventdetail-valuebefore-member)|Represents the value before the change.| +||[valueTypeAfter](/javascript/api/excel/excel.changedeventdetail#excel-excel-changedeventdetail-valuetypeafter-member)|Represents the type of value after the change.| +||[valueTypeBefore](/javascript/api/excel/excel.changedeventdetail#excel-excel-changedeventdetail-valuetypebefore-member)|Represents the type of value before the change.| +|[Chart](/javascript/api/excel/excel.chart)|[activate()](/javascript/api/excel/excel.chart#excel-excel-chart-activate-member(1))|Activates the chart in the Excel UI.| +||[pivotOptions](/javascript/api/excel/excel.chart#excel-excel-chart-pivotoptions-member)|Encapsulates the options for a pivot chart.| +|[ChartAreaFormat](/javascript/api/excel/excel.chartareaformat)|[colorScheme](/javascript/api/excel/excel.chartareaformat#excel-excel-chartareaformat-colorscheme-member)|Specifies the color scheme of the chart.| +||[roundedCorners](/javascript/api/excel/excel.chartareaformat#excel-excel-chartareaformat-roundedcorners-member)|Specifies if the chart area of the chart has rounded corners.| +|[ChartAxis](/javascript/api/excel/excel.chartaxis)|[linkNumberFormat](/javascript/api/excel/excel.chartaxis#excel-excel-chartaxis-linknumberformat-member)|Specifies if the number format is linked to the cells.| +|[ChartBinOptions](/javascript/api/excel/excel.chartbinoptions)|[allowOverflow](/javascript/api/excel/excel.chartbinoptions#excel-excel-chartbinoptions-allowoverflow-member)|Specifies if bin overflow is enabled in a histogram chart or pareto chart.| +||[allowUnderflow](/javascript/api/excel/excel.chartbinoptions#excel-excel-chartbinoptions-allowunderflow-member)|Specifies if bin underflow is enabled in a histogram chart or pareto chart.| +||[count](/javascript/api/excel/excel.chartbinoptions#excel-excel-chartbinoptions-count-member)|Specifies the bin count of a histogram chart or pareto chart.| +||[overflowValue](/javascript/api/excel/excel.chartbinoptions#excel-excel-chartbinoptions-overflowvalue-member)|Specifies the bin overflow value of a histogram chart or pareto chart.| +||[type](/javascript/api/excel/excel.chartbinoptions#excel-excel-chartbinoptions-type-member)|Specifies the bin's type for a histogram chart or pareto chart.| +||[underflowValue](/javascript/api/excel/excel.chartbinoptions#excel-excel-chartbinoptions-underflowvalue-member)|Specifies the bin underflow value of a histogram chart or pareto chart.| +||[width](/javascript/api/excel/excel.chartbinoptions#excel-excel-chartbinoptions-width-member)|Specifies the bin width value of a histogram chart or pareto chart.| +|[ChartBoxwhiskerOptions](/javascript/api/excel/excel.chartboxwhiskeroptions)|[quartileCalculation](/javascript/api/excel/excel.chartboxwhiskeroptions#excel-excel-chartboxwhiskeroptions-quartilecalculation-member)|Specifies if the quartile calculation type of a box and whisker chart.| +||[showInnerPoints](/javascript/api/excel/excel.chartboxwhiskeroptions#excel-excel-chartboxwhiskeroptions-showinnerpoints-member)|Specifies if inner points are shown in a box and whisker chart.| +||[showMeanLine](/javascript/api/excel/excel.chartboxwhiskeroptions#excel-excel-chartboxwhiskeroptions-showmeanline-member)|Specifies if the mean line is shown in a box and whisker chart.| +||[showMeanMarker](/javascript/api/excel/excel.chartboxwhiskeroptions#excel-excel-chartboxwhiskeroptions-showmeanmarker-member)|Specifies if the mean marker is shown in a box and whisker chart.| +||[showOutlierPoints](/javascript/api/excel/excel.chartboxwhiskeroptions#excel-excel-chartboxwhiskeroptions-showoutlierpoints-member)|Specifies if outlier points are shown in a box and whisker chart.| +|[ChartDataLabel](/javascript/api/excel/excel.chartdatalabel)|[linkNumberFormat](/javascript/api/excel/excel.chartdatalabel#excel-excel-chartdatalabel-linknumberformat-member)|Specifies if the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells).| +|[ChartDataLabels](/javascript/api/excel/excel.chartdatalabels)|[linkNumberFormat](/javascript/api/excel/excel.chartdatalabels#excel-excel-chartdatalabels-linknumberformat-member)|Specifies if the number format is linked to the cells.| +|[ChartErrorBars](/javascript/api/excel/excel.charterrorbars)|[endStyleCap](/javascript/api/excel/excel.charterrorbars#excel-excel-charterrorbars-endstylecap-member)|Specifies if error bars have an end style cap.| +||[format](/javascript/api/excel/excel.charterrorbars#excel-excel-charterrorbars-format-member)|Specifies the formatting type of the error bars.| +||[include](/javascript/api/excel/excel.charterrorbars#excel-excel-charterrorbars-include-member)|Specifies which parts of the error bars to include.| +||[type](/javascript/api/excel/excel.charterrorbars#excel-excel-charterrorbars-type-member)|The type of range marked by the error bars.| +||[visible](/javascript/api/excel/excel.charterrorbars#excel-excel-charterrorbars-visible-member)|Specifies whether the error bars are displayed.| +|[ChartErrorBarsFormat](/javascript/api/excel/excel.charterrorbarsformat)|[line](/javascript/api/excel/excel.charterrorbarsformat#excel-excel-charterrorbarsformat-line-member)|Represents the chart line formatting.| +|[ChartMapOptions](/javascript/api/excel/excel.chartmapoptions)|[labelStrategy](/javascript/api/excel/excel.chartmapoptions#excel-excel-chartmapoptions-labelstrategy-member)|Specifies the series map labels strategy of a region map chart.| +||[level](/javascript/api/excel/excel.chartmapoptions#excel-excel-chartmapoptions-level-member)|Specifies the series mapping level of a region map chart.| +||[projectionType](/javascript/api/excel/excel.chartmapoptions#excel-excel-chartmapoptions-projectiontype-member)|Specifies the series projection type of a region map chart.| +|[ChartPivotOptions](/javascript/api/excel/excel.chartpivotoptions)|[showAxisFieldButtons](/javascript/api/excel/excel.chartpivotoptions#excel-excel-chartpivotoptions-showaxisfieldbuttons-member)|Specifies whether to display the axis field buttons on a PivotChart.| +||[showLegendFieldButtons](/javascript/api/excel/excel.chartpivotoptions#excel-excel-chartpivotoptions-showlegendfieldbuttons-member)|Specifies whether to display the legend field buttons on a PivotChart.| +||[showReportFilterFieldButtons](/javascript/api/excel/excel.chartpivotoptions#excel-excel-chartpivotoptions-showreportfilterfieldbuttons-member)|Specifies whether to display the report filter field buttons on a PivotChart.| +||[showValueFieldButtons](/javascript/api/excel/excel.chartpivotoptions#excel-excel-chartpivotoptions-showvaluefieldbuttons-member)|Specifies whether to display the show value field buttons on a PivotChart.| +|[ChartSeries](/javascript/api/excel/excel.chartseries)|[binOptions](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-binoptions-member)|Encapsulates the bin options for histogram charts and pareto charts.| +||[boxwhiskerOptions](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-boxwhiskeroptions-member)|Encapsulates the options for the box and whisker charts.| +||[bubbleScale](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-bubblescale-member)|This can be an integer value from 0 (zero) to 300, representing the percentage of the default size.| +||[gradientMaximumColor](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-gradientmaximumcolor-member)|Specifies the color for maximum value of a region map chart series.| +||[gradientMaximumType](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-gradientmaximumtype-member)|Specifies the type for maximum value of a region map chart series.| +||[gradientMaximumValue](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-gradientmaximumvalue-member)|Specifies the maximum value of a region map chart series.| +||[gradientMidpointColor](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-gradientmidpointcolor-member)|Specifies the color for the midpoint value of a region map chart series.| +||[gradientMidpointType](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-gradientmidpointtype-member)|Specifies the type for the midpoint value of a region map chart series.| +||[gradientMidpointValue](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-gradientmidpointvalue-member)|Specifies the midpoint value of a region map chart series.| +||[gradientMinimumColor](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-gradientminimumcolor-member)|Specifies the color for the minimum value of a region map chart series.| +||[gradientMinimumType](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-gradientminimumtype-member)|Specifies the type for the minimum value of a region map chart series.| +||[gradientMinimumValue](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-gradientminimumvalue-member)|Specifies the minimum value of a region map chart series.| +||[gradientStyle](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-gradientstyle-member)|Specifies the series gradient style of a region map chart.| +||[invertColor](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-invertcolor-member)|Specifies the fill color for negative data points in a series.| +||[mapOptions](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-mapoptions-member)|Encapsulates the options for a region map chart.| +||[parentLabelStrategy](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-parentlabelstrategy-member)|Specifies the series parent label strategy area for a treemap chart.| +||[showConnectorLines](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-showconnectorlines-member)|Specifies whether connector lines are shown in waterfall charts.| +||[showLeaderLines](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-showleaderlines-member)|Specifies whether leader lines are displayed for each data label in the series.| +||[splitValue](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-splitvalue-member)|Specifies the threshold value that separates two sections of either a pie-of-pie chart or a bar-of-pie chart.| +||[xErrorBars](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-xerrorbars-member)|Represents the error bar object of a chart series.| +||[yErrorBars](/javascript/api/excel/excel.chartseries#excel-excel-chartseries-yerrorbars-member)|Represents the error bar object of a chart series.| +|[ChartTrendlineLabel](/javascript/api/excel/excel.charttrendlinelabel)|[linkNumberFormat](/javascript/api/excel/excel.charttrendlinelabel#excel-excel-charttrendlinelabel-linknumberformat-member)|Specifies if the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells).| +|[ColumnProperties](/javascript/api/excel/excel.columnproperties)|[address](/javascript/api/excel/excel.columnproperties#excel-excel-columnproperties-address-member)|Represents the `address` property.| +||[addressLocal](/javascript/api/excel/excel.columnproperties#excel-excel-columnproperties-addresslocal-member)|Represents the `addressLocal` property.| +||[columnIndex](/javascript/api/excel/excel.columnproperties#excel-excel-columnproperties-columnindex-member)|Represents the `columnIndex` property.| +|[ConditionalFormat](/javascript/api/excel/excel.conditionalformat)|[getRanges()](/javascript/api/excel/excel.conditionalformat#excel-excel-conditionalformat-getranges-member(1))|Returns the `RangeAreas`, comprising one or more rectangular ranges, to which the conditional format is applied.| +|[DataValidation](/javascript/api/excel/excel.datavalidation)|[getInvalidCells()](/javascript/api/excel/excel.datavalidation#excel-excel-datavalidation-getinvalidcells-member(1))|Returns a `RangeAreas` object, comprising one or more rectangular ranges, with invalid cell values.| +||[getInvalidCellsOrNullObject()](/javascript/api/excel/excel.datavalidation#excel-excel-datavalidation-getinvalidcellsornullobject-member(1))|Returns a `RangeAreas` object, comprising one or more rectangular ranges, with invalid cell values.| +|[FilterCriteria](/javascript/api/excel/excel.filtercriteria)|[subField](/javascript/api/excel/excel.filtercriteria#excel-excel-filtercriteria-subfield-member)|The property used by the filter to do a rich filter on rich values.| +|[GeometricShape](/javascript/api/excel/excel.geometricshape)|[id](/javascript/api/excel/excel.geometricshape#excel-excel-geometricshape-id-member)|Returns the shape identifier.| +||[shape](/javascript/api/excel/excel.geometricshape#excel-excel-geometricshape-shape-member)|Returns the `Shape` object for the geometric shape.| +|[GroupShapeCollection](/javascript/api/excel/excel.groupshapecollection)|[getCount()](/javascript/api/excel/excel.groupshapecollection#excel-excel-groupshapecollection-getcount-member(1))|Returns the number of shapes in the shape group.| +||[getItem(key: string)](/javascript/api/excel/excel.groupshapecollection#excel-excel-groupshapecollection-getitem-member(1))|Gets a shape using its name or ID.| +||[getItemAt(index: number)](/javascript/api/excel/excel.groupshapecollection#excel-excel-groupshapecollection-getitemat-member(1))|Gets a shape based on its position in the collection.| +||[items](/javascript/api/excel/excel.groupshapecollection#excel-excel-groupshapecollection-items-member)|Gets the loaded child items in this collection.| +|[HeaderFooter](/javascript/api/excel/excel.headerfooter)|[centerFooter](/javascript/api/excel/excel.headerfooter#excel-excel-headerfooter-centerfooter-member)|The center footer of the worksheet.| +||[centerHeader](/javascript/api/excel/excel.headerfooter#excel-excel-headerfooter-centerheader-member)|The center header of the worksheet.| +||[leftFooter](/javascript/api/excel/excel.headerfooter#excel-excel-headerfooter-leftfooter-member)|The left footer of the worksheet.| +||[leftHeader](/javascript/api/excel/excel.headerfooter#excel-excel-headerfooter-leftheader-member)|The left header of the worksheet.| +||[rightFooter](/javascript/api/excel/excel.headerfooter#excel-excel-headerfooter-rightfooter-member)|The right footer of the worksheet.| +||[rightHeader](/javascript/api/excel/excel.headerfooter#excel-excel-headerfooter-rightheader-member)|The right header of the worksheet.| +|[HeaderFooterGroup](/javascript/api/excel/excel.headerfootergroup)|[defaultForAllPages](/javascript/api/excel/excel.headerfootergroup#excel-excel-headerfootergroup-defaultforallpages-member)|The general header/footer, used for all pages unless even/odd or first page is specified.| +||[evenPages](/javascript/api/excel/excel.headerfootergroup#excel-excel-headerfootergroup-evenpages-member)|The header/footer to use for even pages, odd header/footer needs to be specified for odd pages.| +||[firstPage](/javascript/api/excel/excel.headerfootergroup#excel-excel-headerfootergroup-firstpage-member)|The first page header/footer, for all other pages general or even/odd is used.| +||[oddPages](/javascript/api/excel/excel.headerfootergroup#excel-excel-headerfootergroup-oddpages-member)|The header/footer to use for odd pages, even header/footer needs to be specified for even pages.| +||[state](/javascript/api/excel/excel.headerfootergroup#excel-excel-headerfootergroup-state-member)|The state by which headers/footers are set.| +||[useSheetMargins](/javascript/api/excel/excel.headerfootergroup#excel-excel-headerfootergroup-usesheetmargins-member)|Gets or sets a flag indicating if headers/footers are aligned with the page margins set in the page layout options for the worksheet.| +||[useSheetScale](/javascript/api/excel/excel.headerfootergroup#excel-excel-headerfootergroup-usesheetscale-member)|Gets or sets a flag indicating if headers/footers should be scaled by the page percentage scale set in the page layout options for the worksheet.| +|[Image](/javascript/api/excel/excel.image)|[format](/javascript/api/excel/excel.image#excel-excel-image-format-member)|Returns the format of the image.| +||[id](/javascript/api/excel/excel.image#excel-excel-image-id-member)|Specifies the shape identifier for the image object.| +||[shape](/javascript/api/excel/excel.image#excel-excel-image-shape-member)|Returns the `Shape` object associated with the image.| +|[IterativeCalculation](/javascript/api/excel/excel.iterativecalculation)|[enabled](/javascript/api/excel/excel.iterativecalculation#excel-excel-iterativecalculation-enabled-member)|True if Excel will use iteration to resolve circular references.| +||[maxChange](/javascript/api/excel/excel.iterativecalculation#excel-excel-iterativecalculation-maxchange-member)|Specifies the maximum amount of change between each iteration as Excel resolves circular references.| +||[maxIteration](/javascript/api/excel/excel.iterativecalculation#excel-excel-iterativecalculation-maxiteration-member)|Specifies the maximum number of iterations that Excel can use to resolve a circular reference.| +|[Line](/javascript/api/excel/excel.line)|[beginArrowheadLength](/javascript/api/excel/excel.line#excel-excel-line-beginarrowheadlength-member)|Represents the length of the arrowhead at the beginning of the specified line.| +||[beginArrowheadStyle](/javascript/api/excel/excel.line#excel-excel-line-beginarrowheadstyle-member)|Represents the style of the arrowhead at the beginning of the specified line.| +||[beginArrowheadWidth](/javascript/api/excel/excel.line#excel-excel-line-beginarrowheadwidth-member)|Represents the width of the arrowhead at the beginning of the specified line.| +||[beginConnectedShape](/javascript/api/excel/excel.line#excel-excel-line-beginconnectedshape-member)|Represents the shape to which the beginning of the specified line is attached.| +||[beginConnectedSite](/javascript/api/excel/excel.line#excel-excel-line-beginconnectedsite-member)|Represents the connection site to which the beginning of a connector is connected.| +||[connectBeginShape(shape: Excel.Shape, connectionSite: number)](/javascript/api/excel/excel.line#excel-excel-line-connectbeginshape-member(1))|Attaches the beginning of the specified connector to a specified shape.| +||[connectEndShape(shape: Excel.Shape, connectionSite: number)](/javascript/api/excel/excel.line#excel-excel-line-connectendshape-member(1))|Attaches the end of the specified connector to a specified shape.| +||[connectorType](/javascript/api/excel/excel.line#excel-excel-line-connectortype-member)|Represents the connector type for the line.| +||[disconnectBeginShape()](/javascript/api/excel/excel.line#excel-excel-line-disconnectbeginshape-member(1))|Detaches the beginning of the specified connector from a shape.| +||[disconnectEndShape()](/javascript/api/excel/excel.line#excel-excel-line-disconnectendshape-member(1))|Detaches the end of the specified connector from a shape.| +||[endArrowheadLength](/javascript/api/excel/excel.line#excel-excel-line-endarrowheadlength-member)|Represents the length of the arrowhead at the end of the specified line.| +||[endArrowheadStyle](/javascript/api/excel/excel.line#excel-excel-line-endarrowheadstyle-member)|Represents the style of the arrowhead at the end of the specified line.| +||[endArrowheadWidth](/javascript/api/excel/excel.line#excel-excel-line-endarrowheadwidth-member)|Represents the width of the arrowhead at the end of the specified line.| +||[endConnectedShape](/javascript/api/excel/excel.line#excel-excel-line-endconnectedshape-member)|Represents the shape to which the end of the specified line is attached.| +||[endConnectedSite](/javascript/api/excel/excel.line#excel-excel-line-endconnectedsite-member)|Represents the connection site to which the end of a connector is connected.| +||[id](/javascript/api/excel/excel.line#excel-excel-line-id-member)|Specifies the shape identifier.| +||[isBeginConnected](/javascript/api/excel/excel.line#excel-excel-line-isbeginconnected-member)|Specifies if the beginning of the specified line is connected to a shape.| +||[isEndConnected](/javascript/api/excel/excel.line#excel-excel-line-isendconnected-member)|Specifies if the end of the specified line is connected to a shape.| +||[shape](/javascript/api/excel/excel.line#excel-excel-line-shape-member)|Returns the `Shape` object associated with the line.| +|[PageBreak](/javascript/api/excel/excel.pagebreak)|[columnIndex](/javascript/api/excel/excel.pagebreak#excel-excel-pagebreak-columnindex-member)|Specifies the column index for the page break.| +||[delete()](/javascript/api/excel/excel.pagebreak#excel-excel-pagebreak-delete-member(1))|Deletes a page break object.| +||[getCellAfterBreak()](/javascript/api/excel/excel.pagebreak#excel-excel-pagebreak-getcellafterbreak-member(1))|Gets the first cell after the page break.| +||[rowIndex](/javascript/api/excel/excel.pagebreak#excel-excel-pagebreak-rowindex-member)|Specifies the row index for the page break.| +|[PageBreakCollection](/javascript/api/excel/excel.pagebreakcollection)|[add(pageBreakRange: Range \| string)](/javascript/api/excel/excel.pagebreakcollection#excel-excel-pagebreakcollection-add-member(1))|Adds a page break before the top-left cell of the range specified.| +||[getCount()](/javascript/api/excel/excel.pagebreakcollection#excel-excel-pagebreakcollection-getcount-member(1))|Gets the number of page breaks in the collection.| +||[getItem(index: number)](/javascript/api/excel/excel.pagebreakcollection#excel-excel-pagebreakcollection-getitem-member(1))|Gets a page break object via the index.| +||[items](/javascript/api/excel/excel.pagebreakcollection#excel-excel-pagebreakcollection-items-member)|Gets the loaded child items in this collection.| +||[removePageBreaks()](/javascript/api/excel/excel.pagebreakcollection#excel-excel-pagebreakcollection-removepagebreaks-member(1))|Resets all manual page breaks in the collection.| +|[PageLayout](/javascript/api/excel/excel.pagelayout)|[blackAndWhite](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-blackandwhite-member)|The worksheet's black and white print option.| +||[bottomMargin](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-bottommargin-member)|The worksheet's bottom page margin to use for printing in points.| +||[centerHorizontally](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-centerhorizontally-member)|The worksheet's center horizontally flag.| +||[centerVertically](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-centervertically-member)|The worksheet's center vertically flag.| +||[draftMode](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-draftmode-member)|The worksheet's draft mode option.| +||[firstPageNumber](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-firstpagenumber-member)|The worksheet's first page number to print.| +||[footerMargin](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-footermargin-member)|The worksheet's footer margin, in points, for use when printing.| +||[getPrintArea()](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-getprintarea-member(1))|Gets the `RangeAreas` object, comprising one or more rectangular ranges, that represents the print area for the worksheet.| +||[getPrintAreaOrNullObject()](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-getprintareaornullobject-member(1))|Gets the `RangeAreas` object, comprising one or more rectangular ranges, that represents the print area for the worksheet.| +||[getPrintTitleColumns()](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-getprinttitlecolumns-member(1))|Gets the range object representing the title columns.| +||[getPrintTitleColumnsOrNullObject()](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-getprinttitlecolumnsornullobject-member(1))|Gets the range object representing the title columns.| +||[getPrintTitleRows()](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-getprinttitlerows-member(1))|Gets the range object representing the title rows.| +||[getPrintTitleRowsOrNullObject()](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-getprinttitlerowsornullobject-member(1))|Gets the range object representing the title rows.| +||[headerMargin](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-headermargin-member)|The worksheet's header margin, in points, for use when printing.| +||[headersFooters](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-headersfooters-member)|Header and footer configuration for the worksheet.| +||[leftMargin](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-leftmargin-member)|The worksheet's left margin, in points, for use when printing.| +||[orientation](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-orientation-member)|The worksheet's orientation of the page.| +||[paperSize](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-papersize-member)|The worksheet's paper size of the page.| +||[printComments](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-printcomments-member)|Specifies if the worksheet's comments should be displayed when printing.| +||[printErrors](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-printerrors-member)|The worksheet's print errors option.| +||[printGridlines](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-printgridlines-member)|Specifies if the worksheet's gridlines will be printed.| +||[printHeadings](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-printheadings-member)|Specifies if the worksheet's headings will be printed.| +||[printOrder](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-printorder-member)|The worksheet's page print order option.| +||[rightMargin](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-rightmargin-member)|The worksheet's right margin, in points, for use when printing.| +||[setPrintArea(printArea: Range \| RangeAreas \| string)](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-setprintarea-member(1))|Sets the worksheet's print area.| +||[setPrintMargins(unit: Excel.PrintMarginUnit, marginOptions: Excel.PageLayoutMarginOptions)](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-setprintmargins-member(1))|Sets the worksheet's page margins with units.| +||[setPrintTitleColumns(printTitleColumns: Range \| string)](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-setprinttitlecolumns-member(1))|Sets the columns that contain the cells to be repeated at the left of each page of the worksheet for printing.| +||[setPrintTitleRows(printTitleRows: Range \| string)](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-setprinttitlerows-member(1))|Sets the rows that contain the cells to be repeated at the top of each page of the worksheet for printing.| +||[topMargin](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-topmargin-member)|The worksheet's top margin, in points, for use when printing.| +||[zoom](/javascript/api/excel/excel.pagelayout#excel-excel-pagelayout-zoom-member)|The worksheet's print zoom options.| +|[PageLayoutMarginOptions](/javascript/api/excel/excel.pagelayoutmarginoptions)|[bottom](/javascript/api/excel/excel.pagelayoutmarginoptions#excel-excel-pagelayoutmarginoptions-bottom-member)|Specifies the page layout bottom margin in the unit specified to use for printing.| +||[footer](/javascript/api/excel/excel.pagelayoutmarginoptions#excel-excel-pagelayoutmarginoptions-footer-member)|Specifies the page layout footer margin in the unit specified to use for printing.| +||[header](/javascript/api/excel/excel.pagelayoutmarginoptions#excel-excel-pagelayoutmarginoptions-header-member)|Specifies the page layout header margin in the unit specified to use for printing.| +||[left](/javascript/api/excel/excel.pagelayoutmarginoptions#excel-excel-pagelayoutmarginoptions-left-member)|Specifies the page layout left margin in the unit specified to use for printing.| +||[right](/javascript/api/excel/excel.pagelayoutmarginoptions#excel-excel-pagelayoutmarginoptions-right-member)|Specifies the page layout right margin in the unit specified to use for printing.| +||[top](/javascript/api/excel/excel.pagelayoutmarginoptions#excel-excel-pagelayoutmarginoptions-top-member)|Specifies the page layout top margin in the unit specified to use for printing.| +|[PageLayoutZoomOptions](/javascript/api/excel/excel.pagelayoutzoomoptions)|[horizontalFitToPages](/javascript/api/excel/excel.pagelayoutzoomoptions#excel-excel-pagelayoutzoomoptions-horizontalfittopages-member)|Number of pages to fit horizontally.| +||[scale](/javascript/api/excel/excel.pagelayoutzoomoptions#excel-excel-pagelayoutzoomoptions-scale-member)|Print page scale value can be between 10 and 400.| +||[verticalFitToPages](/javascript/api/excel/excel.pagelayoutzoomoptions#excel-excel-pagelayoutzoomoptions-verticalfittopages-member)|Number of pages to fit vertically.| +|[PivotField](/javascript/api/excel/excel.pivotfield)|[sortByValues(sortBy: Excel.SortBy, valuesHierarchy: Excel.DataPivotHierarchy, pivotItemScope?: Array)](/javascript/api/excel/excel.pivotfield#excel-excel-pivotfield-sortbyvalues-member(1))|Sorts the PivotField by specified values in a given scope.| +|[PivotLayout](/javascript/api/excel/excel.pivotlayout)|[autoFormat](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-autoformat-member)|Specifies if formatting will be automatically formatted when it's refreshed or when fields are moved.| +||[getDataHierarchy(cell: Range \| string)](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-getdatahierarchy-member(1))|Gets the DataHierarchy that is used to calculate the value in a specified range within the PivotTable.| +||[getPivotItems(axis: Excel.PivotAxis, cell: Range \| string)](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-getpivotitems-member(1))|Gets the PivotItems from an axis that make up the value in a specified range within the PivotTable.| +||[preserveFormatting](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-preserveformatting-member)|Specifies if formatting is preserved when the report is refreshed or recalculated by operations such as pivoting, sorting, or changing page field items.| +||[setAutoSortOnCell(cell: Range \| string, sortBy: Excel.SortBy)](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-setautosortoncell-member(1))|Sets the PivotTable to automatically sort using the specified cell to automatically select all necessary criteria and context.| +|[PivotTable](/javascript/api/excel/excel.pivottable)|[enableDataValueEditing](/javascript/api/excel/excel.pivottable#excel-excel-pivottable-enabledatavalueediting-member)|Specifies if the PivotTable allows values in the data body to be edited by the user.| +||[useCustomSortLists](/javascript/api/excel/excel.pivottable#excel-excel-pivottable-usecustomsortlists-member)|Specifies if the PivotTable uses custom lists when sorting.| +|[Range](/javascript/api/excel/excel.range)|[autoFill(destinationRange?: Range \| string, autoFillType?: Excel.AutoFillType)](/javascript/api/excel/excel.range#excel-excel-range-autofill-member(1))|Fills a range from the current range to the destination range using the specified AutoFill logic.| +||[convertDataTypeToText()](/javascript/api/excel/excel.range#excel-excel-range-convertdatatypetotext-member(1))|Converts the range cells with data types into text.| +||[convertToLinkedDataType(serviceID: number, languageCulture: string)](/javascript/api/excel/excel.range#excel-excel-range-converttolinkeddatatype-member(1))|Converts the range cells into linked data types in the worksheet.| +||[copyFrom(sourceRange: Range \| RangeAreas \| string, copyType?: Excel.RangeCopyType, skipBlanks?: boolean, transpose?: boolean)](/javascript/api/excel/excel.range#excel-excel-range-copyfrom-member(1))|Copies cell data or formatting from the source range or `RangeAreas` to the current range.| +||[find(text: string, criteria: Excel.SearchCriteria)](/javascript/api/excel/excel.range#excel-excel-range-find-member(1))|Finds the given string based on the criteria specified.| +||[findOrNullObject(text: string, criteria: Excel.SearchCriteria)](/javascript/api/excel/excel.range#excel-excel-range-findornullobject-member(1))|Finds the given string based on the criteria specified.| +||[flashFill()](/javascript/api/excel/excel.range#excel-excel-range-flashfill-member(1))|Does a Flash Fill to the current range.| +||[getCellProperties(cellPropertiesLoadOptions: CellPropertiesLoadOptions)](/javascript/api/excel/excel.range#excel-excel-range-getcellproperties-member(1))|Returns a 2D array, encapsulating the data for each cell's font, fill, borders, alignment, and other properties.| +||[getColumnProperties(columnPropertiesLoadOptions: ColumnPropertiesLoadOptions)](/javascript/api/excel/excel.range#excel-excel-range-getcolumnproperties-member(1))|Returns a single-dimensional array, encapsulating the data for each column's font, fill, borders, alignment, and other properties.| +||[getRowProperties(rowPropertiesLoadOptions: RowPropertiesLoadOptions)](/javascript/api/excel/excel.range#excel-excel-range-getrowproperties-member(1))|Returns a single-dimensional array, encapsulating the data for each row's font, fill, borders, alignment, and other properties.| +||[getSpecialCells(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType)](/javascript/api/excel/excel.range#excel-excel-range-getspecialcells-member(1))|Gets the `RangeAreas` object, comprising one or more rectangular ranges, that represents all the cells that match the specified type and value.| +||[getSpecialCellsOrNullObject(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType)](/javascript/api/excel/excel.range#excel-excel-range-getspecialcellsornullobject-member(1))|Gets the `RangeAreas` object, comprising one or more ranges, that represents all the cells that match the specified type and value.| +||[getTables(fullyContained?: boolean)](/javascript/api/excel/excel.range#excel-excel-range-gettables-member(1))|Gets a scoped collection of tables that overlap with the range.| +||[linkedDataTypeState](/javascript/api/excel/excel.range#excel-excel-range-linkeddatatypestate-member)|Represents the data type state of each cell.| +||[removeDuplicates(columns: number[], includesHeader: boolean)](/javascript/api/excel/excel.range#excel-excel-range-removeduplicates-member(1))|Removes duplicate values from the range specified by the columns.| +||[replaceAll(text: string, replacement: string, criteria: Excel.ReplaceCriteria)](/javascript/api/excel/excel.range#excel-excel-range-replaceall-member(1))|Finds and replaces the given string based on the criteria specified within the current range.| +||[setCellProperties(cellPropertiesData: SettableCellProperties[][])](/javascript/api/excel/excel.range#excel-excel-range-setcellproperties-member(1))|Updates the range based on a 2D array of cell properties, encapsulating things like font, fill, borders, and alignment.| +||[setColumnProperties(columnPropertiesData: SettableColumnProperties[])](/javascript/api/excel/excel.range#excel-excel-range-setcolumnproperties-member(1))|Updates the range based on a single-dimensional array of column properties, encapsulating things like font, fill, borders, and alignment.| +||[setDirty()](/javascript/api/excel/excel.range#excel-excel-range-setdirty-member(1))|Set a range to be recalculated when the next recalculation occurs.| +||[setRowProperties(rowPropertiesData: SettableRowProperties[])](/javascript/api/excel/excel.range#excel-excel-range-setrowproperties-member(1))|Updates the range based on a single-dimensional array of row properties, encapsulating things like font, fill, borders, and alignment.| +|[RangeAreas](/javascript/api/excel/excel.rangeareas)|[address](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-address-member)|Returns the `RangeAreas` reference in A1-style.| +||[addressLocal](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-addresslocal-member)|Returns the `RangeAreas` reference in the user locale.| +||[areaCount](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-areacount-member)|Returns the number of rectangular ranges that comprise this `RangeAreas` object.| +||[areas](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-areas-member)|Returns a collection of rectangular ranges that comprise this `RangeAreas` object.| +||[calculate()](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-calculate-member(1))|Calculates all cells in the `RangeAreas`.| +||[cellCount](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-cellcount-member)|Returns the number of cells in the `RangeAreas` object, summing up the cell counts of all of the individual rectangular ranges.| +||[clear(applyTo?: Excel.ClearApplyTo)](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-clear-member(1))|Clears values, format, fill, border, and other properties on each of the areas that comprise this `RangeAreas` object.| +||[conditionalFormats](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-conditionalformats-member)|Returns a collection of conditional formats that intersect with any cells in this `RangeAreas` object.| +||[convertDataTypeToText()](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-convertdatatypetotext-member(1))|Converts all cells in the `RangeAreas` with data types into text.| +||[convertToLinkedDataType(serviceID: number, languageCulture: string)](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-converttolinkeddatatype-member(1))|Converts all cells in the `RangeAreas` into linked data types.| +||[copyFrom(sourceRange: Range \| RangeAreas \| string, copyType?: Excel.RangeCopyType, skipBlanks?: boolean, transpose?: boolean)](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-copyfrom-member(1))|Copies cell data or formatting from the source range or `RangeAreas` to the current `RangeAreas`.| +||[dataValidation](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-datavalidation-member)|Returns a data validation object for all ranges in the `RangeAreas`.| +||[format](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-format-member)|Returns a `RangeFormat` object, encapsulating the font, fill, borders, alignment, and other properties for all ranges in the `RangeAreas` object.| +||[getEntireColumn()](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-getentirecolumn-member(1))|Returns a `RangeAreas` object that represents the entire columns of the `RangeAreas` (for example, if the current `RangeAreas` represents cells "B4:E11, H2", it returns a `RangeAreas` that represents columns "B:E, H:H").| +||[getEntireRow()](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-getentirerow-member(1))|Returns a `RangeAreas` object that represents the entire rows of the `RangeAreas` (for example, if the current `RangeAreas` represents cells "B4:E11", it returns a `RangeAreas` that represents rows "4:11").| +||[getIntersection(anotherRange: Range \| RangeAreas \| string)](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-getintersection-member(1))|Returns the `RangeAreas` object that represents the intersection of the given ranges or `RangeAreas`.| +||[getIntersectionOrNullObject(anotherRange: Range \| RangeAreas \| string)](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-getintersectionornullobject-member(1))|Returns the `RangeAreas` object that represents the intersection of the given ranges or `RangeAreas`.| +||[getOffsetRangeAreas(rowOffset: number, columnOffset: number)](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-getoffsetrangeareas-member(1))|Returns a `RangeAreas` object that is shifted by the specific row and column offset.| +||[getSpecialCells(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType)](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-getspecialcells-member(1))|Returns a `RangeAreas` object that represents all the cells that match the specified type and value.| +||[getSpecialCellsOrNullObject(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType)](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-getspecialcellsornullobject-member(1))|Returns a `RangeAreas` object that represents all the cells that match the specified type and value.| +||[getTables(fullyContained?: boolean)](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-gettables-member(1))|Returns a scoped collection of tables that overlap with any range in this `RangeAreas` object.| +||[getUsedRangeAreas(valuesOnly?: boolean)](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-getusedrangeareas-member(1))|Returns the used `RangeAreas` that comprises all the used areas of individual rectangular ranges in the `RangeAreas` object.| +||[getUsedRangeAreasOrNullObject(valuesOnly?: boolean)](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-getusedrangeareasornullobject-member(1))|Returns the used `RangeAreas` that comprises all the used areas of individual rectangular ranges in the `RangeAreas` object.| +||[isEntireColumn](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-isentirecolumn-member)|Specifies if all the ranges on this `RangeAreas` object represent entire columns (e.g., "A:C, Q:Z").| +||[isEntireRow](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-isentirerow-member)|Specifies if all the ranges on this `RangeAreas` object represent entire rows (e.g., "1:3, 5:7").| +||[setDirty()](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-setdirty-member(1))|Sets the `RangeAreas` to be recalculated when the next recalculation occurs.| +||[style](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-style-member)|Represents the style for all ranges in this `RangeAreas` object.| +||[worksheet](/javascript/api/excel/excel.rangeareas#excel-excel-rangeareas-worksheet-member)|Returns the worksheet for the current `RangeAreas`.| +|[RangeBorder](/javascript/api/excel/excel.rangeborder)|[tintAndShade](/javascript/api/excel/excel.rangeborder#excel-excel-rangeborder-tintandshade-member)|Specifies a double that lightens or darkens a color for the range border, the value is between -1 (darkest) and 1 (brightest), with 0 for the original color.| +|[RangeBorderCollection](/javascript/api/excel/excel.rangebordercollection)|[tintAndShade](/javascript/api/excel/excel.rangebordercollection#excel-excel-rangebordercollection-tintandshade-member)|Specifies a double that lightens or darkens a color for range borders.| +|[RangeCollection](/javascript/api/excel/excel.rangecollection)|[getCount()](/javascript/api/excel/excel.rangecollection#excel-excel-rangecollection-getcount-member(1))|Returns the number of ranges in the `RangeCollection`.| +||[getItemAt(index: number)](/javascript/api/excel/excel.rangecollection#excel-excel-rangecollection-getitemat-member(1))|Returns the range object based on its position in the `RangeCollection`.| +||[items](/javascript/api/excel/excel.rangecollection#excel-excel-rangecollection-items-member)|Gets the loaded child items in this collection.| +|[RangeFill](/javascript/api/excel/excel.rangefill)|[pattern](/javascript/api/excel/excel.rangefill#excel-excel-rangefill-pattern-member)|The pattern of a range.| +||[patternColor](/javascript/api/excel/excel.rangefill#excel-excel-rangefill-patterncolor-member)|The HTML color code representing the color of the range pattern, in the form #RRGGBB (e.g., "FFA500"), or as a named HTML color (e.g., "orange").| +||[patternTintAndShade](/javascript/api/excel/excel.rangefill#excel-excel-rangefill-patterntintandshade-member)|Specifies a double that lightens or darkens a pattern color for the range fill.| +||[tintAndShade](/javascript/api/excel/excel.rangefill#excel-excel-rangefill-tintandshade-member)|Specifies a double that lightens or darkens a color for the range fill.| +|[RangeFont](/javascript/api/excel/excel.rangefont)|[strikethrough](/javascript/api/excel/excel.rangefont#excel-excel-rangefont-strikethrough-member)|Specifies the strikethrough status of font.| +||[subscript](/javascript/api/excel/excel.rangefont#excel-excel-rangefont-subscript-member)|Specifies the subscript status of font.| +||[superscript](/javascript/api/excel/excel.rangefont#excel-excel-rangefont-superscript-member)|Specifies the superscript status of font.| +||[tintAndShade](/javascript/api/excel/excel.rangefont#excel-excel-rangefont-tintandshade-member)|Specifies a double that lightens or darkens a color for the range font.| +|[RangeFormat](/javascript/api/excel/excel.rangeformat)|[autoIndent](/javascript/api/excel/excel.rangeformat#excel-excel-rangeformat-autoindent-member)|Specifies if text is automatically indented when text alignment is set to equal distribution.| +||[indentLevel](/javascript/api/excel/excel.rangeformat#excel-excel-rangeformat-indentlevel-member)|An integer from 0 to 250 that indicates the indent level.| +||[readingOrder](/javascript/api/excel/excel.rangeformat#excel-excel-rangeformat-readingorder-member)|The reading order for the range.| +||[shrinkToFit](/javascript/api/excel/excel.rangeformat#excel-excel-rangeformat-shrinktofit-member)|Specifies if text automatically shrinks to fit in the available column width.| +|[RemoveDuplicatesResult](/javascript/api/excel/excel.removeduplicatesresult)|[removed](/javascript/api/excel/excel.removeduplicatesresult#excel-excel-removeduplicatesresult-removed-member)|Number of duplicated rows removed by the operation.| +||[uniqueRemaining](/javascript/api/excel/excel.removeduplicatesresult#excel-excel-removeduplicatesresult-uniqueremaining-member)|Number of remaining unique rows present in the resulting range.| +|[ReplaceCriteria](/javascript/api/excel/excel.replacecriteria)|[completeMatch](/javascript/api/excel/excel.replacecriteria#excel-excel-replacecriteria-completematch-member)|Specifies if the match needs to be complete or partial.| +||[matchCase](/javascript/api/excel/excel.replacecriteria#excel-excel-replacecriteria-matchcase-member)|Specifies if the match is case-sensitive.| +|[RowProperties](/javascript/api/excel/excel.rowproperties)|[address](/javascript/api/excel/excel.rowproperties#excel-excel-rowproperties-address-member)|Represents the `address` property.| +||[addressLocal](/javascript/api/excel/excel.rowproperties#excel-excel-rowproperties-addresslocal-member)|Represents the `addressLocal` property.| +||[rowIndex](/javascript/api/excel/excel.rowproperties#excel-excel-rowproperties-rowindex-member)|Represents the `rowIndex` property.| +|[SearchCriteria](/javascript/api/excel/excel.searchcriteria)|[completeMatch](/javascript/api/excel/excel.searchcriteria#excel-excel-searchcriteria-completematch-member)|Specifies if the match needs to be complete or partial.| +||[matchCase](/javascript/api/excel/excel.searchcriteria#excel-excel-searchcriteria-matchcase-member)|Specifies if the match is case-sensitive.| +||[searchDirection](/javascript/api/excel/excel.searchcriteria#excel-excel-searchcriteria-searchdirection-member)|Specifies the search direction.| +|[SettableCellProperties](/javascript/api/excel/excel.settablecellproperties)|[format](/javascript/api/excel/excel.settablecellproperties#excel-excel-settablecellproperties-format-member)|Represents the `format` property.| +||[hyperlink](/javascript/api/excel/excel.settablecellproperties#excel-excel-settablecellproperties-hyperlink-member)|Represents the `hyperlink` property.| +||[style](/javascript/api/excel/excel.settablecellproperties#excel-excel-settablecellproperties-style-member)|Represents the `style` property.| +|[SettableColumnProperties](/javascript/api/excel/excel.settablecolumnproperties)|[columnHidden](/javascript/api/excel/excel.settablecolumnproperties#excel-excel-settablecolumnproperties-columnhidden-member)|Represents the `columnHidden` property.| +||[format](/javascript/api/excel/excel.settablecolumnproperties#excel-excel-settablecolumnproperties-format-member)|Represents the `format` property.| +|[SettableRowProperties](/javascript/api/excel/excel.settablerowproperties)|[format](/javascript/api/excel/excel.settablerowproperties#excel-excel-settablerowproperties-format-member)|Represents the `format` property.| +||[rowHidden](/javascript/api/excel/excel.settablerowproperties#excel-excel-settablerowproperties-rowhidden-member)|Represents the `rowHidden` property.| +|[Shape](/javascript/api/excel/excel.shape)|[altTextDescription](/javascript/api/excel/excel.shape#excel-excel-shape-alttextdescription-member)|Specifies the alternative description text for a `Shape` object.| +||[altTextTitle](/javascript/api/excel/excel.shape#excel-excel-shape-alttexttitle-member)|Specifies the alternative title text for a `Shape` object.| +||[connectionSiteCount](/javascript/api/excel/excel.shape#excel-excel-shape-connectionsitecount-member)|Returns the number of connection sites on this shape.| +||[delete()](/javascript/api/excel/excel.shape#excel-excel-shape-delete-member(1))|Removes the shape from the worksheet.| +||[fill](/javascript/api/excel/excel.shape#excel-excel-shape-fill-member)|Returns the fill formatting of this shape.| +||[geometricShape](/javascript/api/excel/excel.shape#excel-excel-shape-geometricshape-member)|Returns the geometric shape associated with the shape.| +||[geometricShapeType](/javascript/api/excel/excel.shape#excel-excel-shape-geometricshapetype-member)|Specifies the geometric shape type of this geometric shape.| +||[getAsImage(format: Excel.PictureFormat)](/javascript/api/excel/excel.shape#excel-excel-shape-getasimage-member(1))|Converts the shape to an image and returns the image as a Base64-encoded string.| +||[group](/javascript/api/excel/excel.shape#excel-excel-shape-group-member)|Returns the shape group associated with the shape.| +||[height](/javascript/api/excel/excel.shape#excel-excel-shape-height-member)|Specifies the height, in points, of the shape.| +||[id](/javascript/api/excel/excel.shape#excel-excel-shape-id-member)|Specifies the shape identifier.| +||[image](/javascript/api/excel/excel.shape#excel-excel-shape-image-member)|Returns the image associated with the shape.| +||[incrementLeft(increment: number)](/javascript/api/excel/excel.shape#excel-excel-shape-incrementleft-member(1))|Moves the shape horizontally by the specified number of points.| +||[incrementRotation(increment: number)](/javascript/api/excel/excel.shape#excel-excel-shape-incrementrotation-member(1))|Rotates the shape clockwise around the z-axis by the specified number of degrees.| +||[incrementTop(increment: number)](/javascript/api/excel/excel.shape#excel-excel-shape-incrementtop-member(1))|Moves the shape vertically by the specified number of points.| +||[left](/javascript/api/excel/excel.shape#excel-excel-shape-left-member)|The distance, in points, from the left side of the shape to the left side of the worksheet.| +||[level](/javascript/api/excel/excel.shape#excel-excel-shape-level-member)|Specifies the level of the specified shape.| +||[line](/javascript/api/excel/excel.shape#excel-excel-shape-line-member)|Returns the line associated with the shape.| +||[lineFormat](/javascript/api/excel/excel.shape#excel-excel-shape-lineformat-member)|Returns the line formatting of this shape.| +||[lockAspectRatio](/javascript/api/excel/excel.shape#excel-excel-shape-lockaspectratio-member)|Specifies if the aspect ratio of this shape is locked.| +||[name](/javascript/api/excel/excel.shape#excel-excel-shape-name-member)|Specifies the name of the shape.| +||[onActivated](/javascript/api/excel/excel.shape#excel-excel-shape-onactivated-member)|Occurs when the shape is activated.| +||[onDeactivated](/javascript/api/excel/excel.shape#excel-excel-shape-ondeactivated-member)|Occurs when the shape is deactivated.| +||[parentGroup](/javascript/api/excel/excel.shape#excel-excel-shape-parentgroup-member)|Specifies the parent group of this shape.| +||[rotation](/javascript/api/excel/excel.shape#excel-excel-shape-rotation-member)|Specifies the rotation, in degrees, of the shape.| +||[scaleHeight(scaleFactor: number, scaleType: Excel.ShapeScaleType, scaleFrom?: Excel.ShapeScaleFrom)](/javascript/api/excel/excel.shape#excel-excel-shape-scaleheight-member(1))|Scales the height of the shape by a specified factor.| +||[scaleWidth(scaleFactor: number, scaleType: Excel.ShapeScaleType, scaleFrom?: Excel.ShapeScaleFrom)](/javascript/api/excel/excel.shape#excel-excel-shape-scalewidth-member(1))|Scales the width of the shape by a specified factor.| +||[setZOrder(position: Excel.ShapeZOrder)](/javascript/api/excel/excel.shape#excel-excel-shape-setzorder-member(1))|Moves the specified shape up or down the collection's z-order, which shifts it in front of or behind other shapes.| +||[textFrame](/javascript/api/excel/excel.shape#excel-excel-shape-textframe-member)|Returns the text frame object of this shape.| +||[top](/javascript/api/excel/excel.shape#excel-excel-shape-top-member)|The distance, in points, from the top edge of the shape to the top edge of the worksheet.| +||[type](/javascript/api/excel/excel.shape#excel-excel-shape-type-member)|Returns the type of this shape.| +||[visible](/javascript/api/excel/excel.shape#excel-excel-shape-visible-member)|Specifies if the shape is visible.| +||[width](/javascript/api/excel/excel.shape#excel-excel-shape-width-member)|Specifies the width, in points, of the shape.| +||[zOrderPosition](/javascript/api/excel/excel.shape#excel-excel-shape-zorderposition-member)|Returns the position of the specified shape in the z-order, with 0 representing the bottom of the order stack.| +|[ShapeActivatedEventArgs](/javascript/api/excel/excel.shapeactivatedeventargs)|[shapeId](/javascript/api/excel/excel.shapeactivatedeventargs#excel-excel-shapeactivatedeventargs-shapeid-member)|Gets the ID of the activated shape.| +||[type](/javascript/api/excel/excel.shapeactivatedeventargs#excel-excel-shapeactivatedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/javascript/api/excel/excel.shapeactivatedeventargs#excel-excel-shapeactivatedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the shape is activated.| +|[ShapeCollection](/javascript/api/excel/excel.shapecollection)|[addGeometricShape(geometricShapeType: Excel.GeometricShapeType)](/javascript/api/excel/excel.shapecollection#excel-excel-shapecollection-addgeometricshape-member(1))|Adds a geometric shape to the worksheet.| +||[addGroup(values: Array)](/javascript/api/excel/excel.shapecollection#excel-excel-shapecollection-addgroup-member(1))|Groups a subset of shapes in this collection's worksheet.| +||[addImage(base64ImageString: string)](/javascript/api/excel/excel.shapecollection#excel-excel-shapecollection-addimage-member(1))|Creates an image from a Base64-encoded string and adds it to the worksheet.| +||[addLine(startLeft: number, startTop: number, endLeft: number, endTop: number, connectorType?: Excel.ConnectorType)](/javascript/api/excel/excel.shapecollection#excel-excel-shapecollection-addline-member(1))|Adds a line to worksheet.| +||[addTextBox(text?: string)](/javascript/api/excel/excel.shapecollection#excel-excel-shapecollection-addtextbox-member(1))|Adds a text box to the worksheet with the provided text as the content.| +||[getCount()](/javascript/api/excel/excel.shapecollection#excel-excel-shapecollection-getcount-member(1))|Returns the number of shapes in the worksheet.| +||[getItem(key: string)](/javascript/api/excel/excel.shapecollection#excel-excel-shapecollection-getitem-member(1))|Gets a shape using its name or ID.| +||[getItemAt(index: number)](/javascript/api/excel/excel.shapecollection#excel-excel-shapecollection-getitemat-member(1))|Gets a shape using its position in the collection.| +||[items](/javascript/api/excel/excel.shapecollection#excel-excel-shapecollection-items-member)|Gets the loaded child items in this collection.| +|[ShapeDeactivatedEventArgs](/javascript/api/excel/excel.shapedeactivatedeventargs)|[shapeId](/javascript/api/excel/excel.shapedeactivatedeventargs#excel-excel-shapedeactivatedeventargs-shapeid-member)|Gets the ID of the shape deactivated shape.| +||[type](/javascript/api/excel/excel.shapedeactivatedeventargs#excel-excel-shapedeactivatedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/javascript/api/excel/excel.shapedeactivatedeventargs#excel-excel-shapedeactivatedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the shape is deactivated.| +|[ShapeFill](/javascript/api/excel/excel.shapefill)|[clear()](/javascript/api/excel/excel.shapefill#excel-excel-shapefill-clear-member(1))|Clears the fill formatting of this shape.| +||[foregroundColor](/javascript/api/excel/excel.shapefill#excel-excel-shapefill-foregroundcolor-member)|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")| +||[setSolidColor(color: string)](/javascript/api/excel/excel.shapefill#excel-excel-shapefill-setsolidcolor-member(1))|Sets the fill formatting of the shape to a uniform color.| +||[transparency](/javascript/api/excel/excel.shapefill#excel-excel-shapefill-transparency-member)|Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).| +||[type](/javascript/api/excel/excel.shapefill#excel-excel-shapefill-type-member)|Returns the fill type of the shape.| +|[ShapeFont](/javascript/api/excel/excel.shapefont)|[bold](/javascript/api/excel/excel.shapefont#excel-excel-shapefont-bold-member)|Represents the bold status of font.| +||[color](/javascript/api/excel/excel.shapefont#excel-excel-shapefont-color-member)|HTML color code representation of the text color (e.g., "#FF0000" represents red).| +||[italic](/javascript/api/excel/excel.shapefont#excel-excel-shapefont-italic-member)|Represents the italic status of font.| +||[name](/javascript/api/excel/excel.shapefont#excel-excel-shapefont-name-member)|Represents font name (e.g., "Calibri").| +||[size](/javascript/api/excel/excel.shapefont#excel-excel-shapefont-size-member)|Represents font size in points (e.g., 11).| +||[underline](/javascript/api/excel/excel.shapefont#excel-excel-shapefont-underline-member)|Type of underline applied to the font.| +|[ShapeGroup](/javascript/api/excel/excel.shapegroup)|[id](/javascript/api/excel/excel.shapegroup#excel-excel-shapegroup-id-member)|Specifies the shape identifier.| +||[shape](/javascript/api/excel/excel.shapegroup#excel-excel-shapegroup-shape-member)|Returns the `Shape` object associated with the group.| +||[shapes](/javascript/api/excel/excel.shapegroup#excel-excel-shapegroup-shapes-member)|Returns the collection of `Shape` objects.| +||[ungroup()](/javascript/api/excel/excel.shapegroup#excel-excel-shapegroup-ungroup-member(1))|Ungroups any grouped shapes in the specified shape group.| +|[ShapeLineFormat](/javascript/api/excel/excel.shapelineformat)|[color](/javascript/api/excel/excel.shapelineformat#excel-excel-shapelineformat-color-member)|Represents the line color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").| +||[dashStyle](/javascript/api/excel/excel.shapelineformat#excel-excel-shapelineformat-dashstyle-member)|Represents the line style of the shape.| +||[style](/javascript/api/excel/excel.shapelineformat#excel-excel-shapelineformat-style-member)|Represents the line style of the shape.| +||[transparency](/javascript/api/excel/excel.shapelineformat#excel-excel-shapelineformat-transparency-member)|Represents the degree of transparency of the specified line as a value from 0.0 (opaque) through 1.0 (clear).| +||[visible](/javascript/api/excel/excel.shapelineformat#excel-excel-shapelineformat-visible-member)|Specifies if the line formatting of a shape element is visible.| +||[weight](/javascript/api/excel/excel.shapelineformat#excel-excel-shapelineformat-weight-member)|Represents the weight of the line, in points.| +|[SortField](/javascript/api/excel/excel.sortfield)|[subField](/javascript/api/excel/excel.sortfield#excel-excel-sortfield-subfield-member)|Specifies the subfield that is the target property name of a rich value to sort on.| +|[StyleCollection](/javascript/api/excel/excel.stylecollection)|[getCount()](/javascript/api/excel/excel.stylecollection#excel-excel-stylecollection-getcount-member(1))|Gets the number of styles in the collection.| +||[getItemAt(index: number)](/javascript/api/excel/excel.stylecollection#excel-excel-stylecollection-getitemat-member(1))|Gets a style based on its position in the collection.| +|[Table](/javascript/api/excel/excel.table)|[autoFilter](/javascript/api/excel/excel.table#excel-excel-table-autofilter-member)|Represents the `AutoFilter` object of the table.| +|[TableAddedEventArgs](/javascript/api/excel/excel.tableaddedeventargs)|[source](/javascript/api/excel/excel.tableaddedeventargs#excel-excel-tableaddedeventargs-source-member)|Gets the source of the event.| +||[tableId](/javascript/api/excel/excel.tableaddedeventargs#excel-excel-tableaddedeventargs-tableid-member)|Gets the ID of the table that is added.| +||[type](/javascript/api/excel/excel.tableaddedeventargs#excel-excel-tableaddedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/javascript/api/excel/excel.tableaddedeventargs#excel-excel-tableaddedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the table is added.| +|[TableChangedEventArgs](/javascript/api/excel/excel.tablechangedeventargs)|[details](/javascript/api/excel/excel.tablechangedeventargs#excel-excel-tablechangedeventargs-details-member)|Gets the information about the change detail.| +|[TableCollection](/javascript/api/excel/excel.tablecollection)|[onAdded](/javascript/api/excel/excel.tablecollection#excel-excel-tablecollection-onadded-member)|Occurs when a new table is added in a workbook.| +||[onDeleted](/javascript/api/excel/excel.tablecollection#excel-excel-tablecollection-ondeleted-member)|Occurs when the specified table is deleted in a workbook.| +|[TableDeletedEventArgs](/javascript/api/excel/excel.tabledeletedeventargs)|[source](/javascript/api/excel/excel.tabledeletedeventargs#excel-excel-tabledeletedeventargs-source-member)|Gets the source of the event.| +||[tableId](/javascript/api/excel/excel.tabledeletedeventargs#excel-excel-tabledeletedeventargs-tableid-member)|Gets the ID of the table that is deleted.| +||[tableName](/javascript/api/excel/excel.tabledeletedeventargs#excel-excel-tabledeletedeventargs-tablename-member)|Gets the name of the table that is deleted.| +||[type](/javascript/api/excel/excel.tabledeletedeventargs#excel-excel-tabledeletedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/javascript/api/excel/excel.tabledeletedeventargs#excel-excel-tabledeletedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the table is deleted.| +|[TableScopedCollection](/javascript/api/excel/excel.tablescopedcollection)|[getCount()](/javascript/api/excel/excel.tablescopedcollection#excel-excel-tablescopedcollection-getcount-member(1))|Gets the number of tables in the collection.| +||[getFirst()](/javascript/api/excel/excel.tablescopedcollection#excel-excel-tablescopedcollection-getfirst-member(1))|Gets the first table in the collection.| +||[getItem(key: string)](/javascript/api/excel/excel.tablescopedcollection#excel-excel-tablescopedcollection-getitem-member(1))|Gets a table by name or ID.| +||[items](/javascript/api/excel/excel.tablescopedcollection#excel-excel-tablescopedcollection-items-member)|Gets the loaded child items in this collection.| +|[TextFrame](/javascript/api/excel/excel.textframe)|[autoSizeSetting](/javascript/api/excel/excel.textframe#excel-excel-textframe-autosizesetting-member)|The automatic sizing settings for the text frame.| +||[bottomMargin](/javascript/api/excel/excel.textframe#excel-excel-textframe-bottommargin-member)|Represents the bottom margin, in points, of the text frame.| +||[deleteText()](/javascript/api/excel/excel.textframe#excel-excel-textframe-deletetext-member(1))|Deletes all the text in the text frame.| +||[hasText](/javascript/api/excel/excel.textframe#excel-excel-textframe-hastext-member)|Specifies if the text frame contains text.| +||[horizontalAlignment](/javascript/api/excel/excel.textframe#excel-excel-textframe-horizontalalignment-member)|Represents the horizontal alignment of the text frame.| +||[horizontalOverflow](/javascript/api/excel/excel.textframe#excel-excel-textframe-horizontaloverflow-member)|Represents the horizontal overflow behavior of the text frame.| +||[leftMargin](/javascript/api/excel/excel.textframe#excel-excel-textframe-leftmargin-member)|Represents the left margin, in points, of the text frame.| +||[orientation](/javascript/api/excel/excel.textframe#excel-excel-textframe-orientation-member)|Represents the angle to which the text is oriented for the text frame.| +||[readingOrder](/javascript/api/excel/excel.textframe#excel-excel-textframe-readingorder-member)|Represents the reading order of the text frame, either left-to-right or right-to-left.| +||[rightMargin](/javascript/api/excel/excel.textframe#excel-excel-textframe-rightmargin-member)|Represents the right margin, in points, of the text frame.| +||[textRange](/javascript/api/excel/excel.textframe#excel-excel-textframe-textrange-member)|Represents the text that is attached to a shape in the text frame, and properties and methods for manipulating the text.| +||[topMargin](/javascript/api/excel/excel.textframe#excel-excel-textframe-topmargin-member)|Represents the top margin, in points, of the text frame.| +||[verticalAlignment](/javascript/api/excel/excel.textframe#excel-excel-textframe-verticalalignment-member)|Represents the vertical alignment of the text frame.| +||[verticalOverflow](/javascript/api/excel/excel.textframe#excel-excel-textframe-verticaloverflow-member)|Represents the vertical overflow behavior of the text frame.| +|[TextRange](/javascript/api/excel/excel.textrange)|[font](/javascript/api/excel/excel.textrange#excel-excel-textrange-font-member)|Returns a `ShapeFont` object that represents the font attributes for the text range.| +||[getSubstring(start: number, length?: number)](/javascript/api/excel/excel.textrange#excel-excel-textrange-getsubstring-member(1))|Returns a TextRange object for the substring in the given range.| +||[text](/javascript/api/excel/excel.textrange#excel-excel-textrange-text-member)|Represents the plain text content of the text range.| +|[Workbook](/javascript/api/excel/excel.workbook)|[autoSave](/javascript/api/excel/excel.workbook#excel-excel-workbook-autosave-member)|Specifies if the workbook is in AutoSave mode.| +||[calculationEngineVersion](/javascript/api/excel/excel.workbook#excel-excel-workbook-calculationengineversion-member)|Returns a number about the version of Excel Calculation Engine.| +||[chartDataPointTrack](/javascript/api/excel/excel.workbook#excel-excel-workbook-chartdatapointtrack-member)|True if all charts in the workbook are tracking the actual data points to which they are attached.| +||[getActiveChart()](/javascript/api/excel/excel.workbook#excel-excel-workbook-getactivechart-member(1))|Gets the currently active chart in the workbook.| +||[getActiveChartOrNullObject()](/javascript/api/excel/excel.workbook#excel-excel-workbook-getactivechartornullobject-member(1))|Gets the currently active chart in the workbook.| +||[getIsActiveCollabSession()](/javascript/api/excel/excel.workbook#excel-excel-workbook-getisactivecollabsession-member(1))|Returns `true` if the workbook is being edited by multiple users (through co-authoring).| +||[getSelectedRanges()](/javascript/api/excel/excel.workbook#excel-excel-workbook-getselectedranges-member(1))|Gets the currently selected one or more ranges from the workbook.| +||[isDirty](/javascript/api/excel/excel.workbook#excel-excel-workbook-isdirty-member)|Specifies if changes have been made since the workbook was last saved.| +||[onAutoSaveSettingChanged](/javascript/api/excel/excel.workbook#excel-excel-workbook-onautosavesettingchanged-member)|Occurs when the AutoSave setting is changed on the workbook.| +||[previouslySaved](/javascript/api/excel/excel.workbook#excel-excel-workbook-previouslysaved-member)|Specifies if the workbook has ever been saved locally or online.| +||[usePrecisionAsDisplayed](/javascript/api/excel/excel.workbook#excel-excel-workbook-useprecisionasdisplayed-member)|True if calculations in this workbook will be done using only the precision of the numbers as they're displayed.| +|[WorkbookAutoSaveSettingChangedEventArgs](/javascript/api/excel/excel.workbookautosavesettingchangedeventargs)|[type](/javascript/api/excel/excel.workbookautosavesettingchangedeventargs#excel-excel-workbookautosavesettingchangedeventargs-type-member)|Gets the type of the event.| +|[Worksheet](/javascript/api/excel/excel.worksheet)|[autoFilter](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-autofilter-member)|Represents the `AutoFilter` object of the worksheet.| +||[enableCalculation](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-enablecalculation-member)|Determines if Excel should recalculate the worksheet when necessary.| +||[findAll(text: string, criteria: Excel.WorksheetSearchCriteria)](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-findall-member(1))|Finds all occurrences of the given string based on the criteria specified and returns them as a `RangeAreas` object, comprising one or more rectangular ranges.| +||[findAllOrNullObject(text: string, criteria: Excel.WorksheetSearchCriteria)](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-findallornullobject-member(1))|Finds all occurrences of the given string based on the criteria specified and returns them as a `RangeAreas` object, comprising one or more rectangular ranges.| +||[getRanges(address?: string)](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-getranges-member(1))|Gets the `RangeAreas` object, representing one or more blocks of rectangular ranges, specified by the address or name.| +||[horizontalPageBreaks](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-horizontalpagebreaks-member)|Gets the horizontal page break collection for the worksheet.| +||[onFormatChanged](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-onformatchanged-member)|Occurs when format changed on a specific worksheet.| +||[pageLayout](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-pagelayout-member)|Gets the `PageLayout` object of the worksheet.| +||[replaceAll(text: string, replacement: string, criteria: Excel.ReplaceCriteria)](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-replaceall-member(1))|Finds and replaces the given string based on the criteria specified within the current worksheet.| +||[shapes](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-shapes-member)|Returns the collection of all the Shape objects on the worksheet.| +||[verticalPageBreaks](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-verticalpagebreaks-member)|Gets the vertical page break collection for the worksheet.| +|[WorksheetChangedEventArgs](/javascript/api/excel/excel.worksheetchangedeventargs)|[details](/javascript/api/excel/excel.worksheetchangedeventargs#excel-excel-worksheetchangedeventargs-details-member)|Represents the information about the change detail.| +|[WorksheetCollection](/javascript/api/excel/excel.worksheetcollection)|[onChanged](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-onchanged-member)|Occurs when any worksheet in the workbook is changed.| +||[onFormatChanged](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-onformatchanged-member)|Occurs when any worksheet in the workbook has a format changed.| +||[onSelectionChanged](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-onselectionchanged-member)|Occurs when the selection changes on any worksheet.| +|[WorksheetFormatChangedEventArgs](/javascript/api/excel/excel.worksheetformatchangedeventargs)|[address](/javascript/api/excel/excel.worksheetformatchangedeventargs#excel-excel-worksheetformatchangedeventargs-address-member)|Gets the range address that represents the changed area of a specific worksheet.| +||[getRange(ctx: Excel.RequestContext)](/javascript/api/excel/excel.worksheetformatchangedeventargs#excel-excel-worksheetformatchangedeventargs-getrange-member(1))|Gets the range that represents the changed area of a specific worksheet.| +||[getRangeOrNullObject(ctx: Excel.RequestContext)](/javascript/api/excel/excel.worksheetformatchangedeventargs#excel-excel-worksheetformatchangedeventargs-getrangeornullobject-member(1))|Gets the range that represents the changed area of a specific worksheet.| +||[source](/javascript/api/excel/excel.worksheetformatchangedeventargs#excel-excel-worksheetformatchangedeventargs-source-member)|Gets the source of the event.| +||[type](/javascript/api/excel/excel.worksheetformatchangedeventargs#excel-excel-worksheetformatchangedeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/javascript/api/excel/excel.worksheetformatchangedeventargs#excel-excel-worksheetformatchangedeventargs-worksheetid-member)|Gets the ID of the worksheet in which the data changed.| +|[WorksheetSearchCriteria](/javascript/api/excel/excel.worksheetsearchcriteria)|[completeMatch](/javascript/api/excel/excel.worksheetsearchcriteria#excel-excel-worksheetsearchcriteria-completematch-member)|Specifies if the match needs to be complete or partial.| +||[matchCase](/javascript/api/excel/excel.worksheetsearchcriteria#excel-excel-worksheetsearchcriteria-matchcase-member)|Specifies if the match is case-sensitive.| diff --git a/docs/includes/excel-online.md b/docs/includes/excel-online.md index 07f37712b2..cbb699217f 100644 --- a/docs/includes/excel-online.md +++ b/docs/includes/excel-online.md @@ -1,54 +1,54 @@ | Class | Fields | Description | |:---|:---|:---| -|[AllowEditRange](/.alloweditrange)|[address](/.alloweditrange#excel-javascript/api/excel/-alloweditrange-address-member)|Specifies the range associated with the object.| -||[delete()](/.alloweditrange#excel-javascript/api/excel/-alloweditrange-delete-member(1))|Deletes the object from the `AllowEditRangeCollection`.| -||[isPasswordProtected](/.alloweditrange#excel-javascript/api/excel/-alloweditrange-ispasswordprotected-member)|Specifies if the object is password protected.| -||[pauseProtection(password?: string)](/.alloweditrange#excel-javascript/api/excel/-alloweditrange-pauseprotection-member(1))|Pauses worksheet protection for the object for the user in the current session.| -||[setPassword(password?: string)](/.alloweditrange#excel-javascript/api/excel/-alloweditrange-setpassword-member(1))|Changes the password associated with the object.| -||[title](/.alloweditrange#excel-javascript/api/excel/-alloweditrange-title-member)|Specifies the title of the object.| -|[AllowEditRangeCollection](/.alloweditrangecollection)|[add(title: string, rangeAddress: string, options?: Excel.AllowEditRangeOptions)](/.alloweditrangecollection#excel-javascript/api/excel/-alloweditrangecollection-add-member(1))|Adds an `AllowEditRange` object to the worksheet.| -||[getCount()](/.alloweditrangecollection#excel-javascript/api/excel/-alloweditrangecollection-getcount-member(1))|Returns the number of `AllowEditRange` objects in the collection.| -||[getItem(key: string)](/.alloweditrangecollection#excel-javascript/api/excel/-alloweditrangecollection-getitem-member(1))|Gets the `AllowEditRange` object by its title.| -||[getItemAt(index: number)](/.alloweditrangecollection#excel-javascript/api/excel/-alloweditrangecollection-getitemat-member(1))|Returns an `AllowEditRange` object by its index in the collection.| -||[getItemOrNullObject(key: string)](/.alloweditrangecollection#excel-javascript/api/excel/-alloweditrangecollection-getitemornullobject-member(1))|Gets the `AllowEditRange` object by its title.| -||[items](/.alloweditrangecollection#excel-javascript/api/excel/-alloweditrangecollection-items-member)|Gets the loaded child items in this collection.| -||[pauseProtection(password: string)](/.alloweditrangecollection#excel-javascript/api/excel/-alloweditrangecollection-pauseprotection-member(1))|Pauses worksheet protection for all `AllowEditRange` objects found in this worksheet that have the given password for the user in the current session.| -|[AllowEditRangeOptions](/.alloweditrangeoptions)|[password](/.alloweditrangeoptions#excel-javascript/api/excel/-alloweditrangeoptions-password-member)|The password associated with the `AllowEditRange`.| -|[LinkedWorkbook](/.linkedworkbook)|[breakLinks()](/.linkedworkbook#excel-javascript/api/excel/-linkedworkbook-breaklinks-member(1))|Makes a request to break the links pointing to the linked workbook.| -||[id](/.linkedworkbook#excel-javascript/api/excel/-linkedworkbook-id-member)|The original URL pointing to the linked workbook.| -||[refresh()](/.linkedworkbook#excel-javascript/api/excel/-linkedworkbook-refresh-member(1))|Makes a request to refresh the data retrieved from the linked workbook.| -|[LinkedWorkbookCollection](/.linkedworkbookcollection)|[breakAllLinks()](/.linkedworkbookcollection#excel-javascript/api/excel/-linkedworkbookcollection-breakalllinks-member(1))|Breaks all the links to the linked workbooks.| -||[getItem(key: string)](/.linkedworkbookcollection#excel-javascript/api/excel/-linkedworkbookcollection-getitem-member(1))|Gets information about a linked workbook by its URL.| -||[getItemOrNullObject(key: string)](/.linkedworkbookcollection#excel-javascript/api/excel/-linkedworkbookcollection-getitemornullobject-member(1))|Gets information about a linked workbook by its URL.| -||[items](/.linkedworkbookcollection#excel-javascript/api/excel/-linkedworkbookcollection-items-member)|Gets the loaded child items in this collection.| -||[refreshAll()](/.linkedworkbookcollection#excel-javascript/api/excel/-linkedworkbookcollection-refreshall-member(1))|Makes a request to refresh all the workbook links.| -||[workbookLinksRefreshMode](/.linkedworkbookcollection#excel-javascript/api/excel/-linkedworkbookcollection-workbooklinksrefreshmode-member)|Represents the update mode of the workbook links.| -|[NamedSheetView](/.namedsheetview)|[activate()](/.namedsheetview#excel-javascript/api/excel/-namedsheetview-activate-member(1))|Activates this sheet view.| -||[delete()](/.namedsheetview#excel-javascript/api/excel/-namedsheetview-delete-member(1))|Removes the sheet view from the worksheet.| -||[duplicate(name?: string)](/.namedsheetview#excel-javascript/api/excel/-namedsheetview-duplicate-member(1))|Creates a copy of this sheet view.| -||[name](/.namedsheetview#excel-javascript/api/excel/-namedsheetview-name-member)|Gets or sets the name of the sheet view.| -|[NamedSheetViewCollection](/.namedsheetviewcollection)|[add(name: string)](/.namedsheetviewcollection#excel-javascript/api/excel/-namedsheetviewcollection-add-member(1))|Creates a new sheet view with the given name.| -||[enterTemporary()](/.namedsheetviewcollection#excel-javascript/api/excel/-namedsheetviewcollection-entertemporary-member(1))|Creates and activates a new temporary sheet view.| -||[exit()](/.namedsheetviewcollection#excel-javascript/api/excel/-namedsheetviewcollection-exit-member(1))|Exits the currently active sheet view.| -||[getActive()](/.namedsheetviewcollection#excel-javascript/api/excel/-namedsheetviewcollection-getactive-member(1))|Gets the worksheet's currently active sheet view.| -||[getCount()](/.namedsheetviewcollection#excel-javascript/api/excel/-namedsheetviewcollection-getcount-member(1))|Gets the number of sheet views in this worksheet.| -||[getItem(key: string)](/.namedsheetviewcollection#excel-javascript/api/excel/-namedsheetviewcollection-getitem-member(1))|Gets a sheet view using its name.| -||[getItemAt(index: number)](/.namedsheetviewcollection#excel-javascript/api/excel/-namedsheetviewcollection-getitemat-member(1))|Gets a sheet view by its index in the collection.| -||[items](/.namedsheetviewcollection#excel-javascript/api/excel/-namedsheetviewcollection-items-member)|Gets the loaded child items in this collection.| -|[TableRowCollection](/.tablerowcollection)|[deleteRows(rows: number[] \| TableRow[])](/.tablerowcollection#excel-javascript/api/excel/-tablerowcollection-deleterows-member(1))|Delete multiple rows from a table.| -||[deleteRowsAt(index: number, count?: number)](/.tablerowcollection#excel-javascript/api/excel/-tablerowcollection-deleterowsat-member(1))|Delete a specified number of rows from a table, starting at a given index.| -|[Workbook](/.workbook)|[linkedWorkbooks](/.workbook#excel-javascript/api/excel/-workbook-linkedworkbooks-member)|Returns a collection of linked workbooks.| -|[Worksheet](/.worksheet)|[namedSheetViews](/.worksheet#excel-javascript/api/excel/-worksheet-namedsheetviews-member)|Returns a collection of sheet views that are present in the worksheet.| -|[WorksheetProtection](/.worksheetprotection)|[allowEditRanges](/.worksheetprotection#excel-javascript/api/excel/-worksheetprotection-alloweditranges-member)|Specifies the `AllowEditRangeCollection` object found in this worksheet.| -||[canPauseProtection](/.worksheetprotection#excel-javascript/api/excel/-worksheetprotection-canpauseprotection-member)|Specifies if protection can be paused for this worksheet.| -||[checkPassword(password?: string)](/.worksheetprotection#excel-javascript/api/excel/-worksheetprotection-checkpassword-member(1))|Specifies if the password can be used to unlock worksheet protection.| -||[isPasswordProtected](/.worksheetprotection#excel-javascript/api/excel/-worksheetprotection-ispasswordprotected-member)|Specifies if the sheet is password protected.| -||[isPaused](/.worksheetprotection#excel-javascript/api/excel/-worksheetprotection-ispaused-member)|Specifies if worksheet protection is paused.| -||[pauseProtection(password?: string)](/.worksheetprotection#excel-javascript/api/excel/-worksheetprotection-pauseprotection-member(1))|Pauses worksheet protection for the given worksheet object for the user in the current session.| -||[resumeProtection()](/.worksheetprotection#excel-javascript/api/excel/-worksheetprotection-resumeprotection-member(1))|Resumes worksheet protection for the given worksheet object for the user in a given session.| -||[savedOptions](/.worksheetprotection#excel-javascript/api/excel/-worksheetprotection-savedoptions-member)|Specifies the protection options saved in the worksheet.| -||[setPassword(password?: string)](/.worksheetprotection#excel-javascript/api/excel/-worksheetprotection-setpassword-member(1))|Changes the password associated with the `WorksheetProtection` object.| -||[updateOptions(options: Excel.WorksheetProtectionOptions)](/.worksheetprotection#excel-javascript/api/excel/-worksheetprotection-updateoptions-member(1))|Change the worksheet protection options associated with the `WorksheetProtection` object.| -|[WorksheetProtectionChangedEventArgs](/.worksheetprotectionchangedeventargs)|[allowEditRangesChanged](/.worksheetprotectionchangedeventargs#excel-javascript/api/excel/-worksheetprotectionchangedeventargs-alloweditrangeschanged-member)|Specifies if any of the `AllowEditRange` objects have changed.| -||[protectionOptionsChanged](/.worksheetprotectionchangedeventargs#excel-javascript/api/excel/-worksheetprotectionchangedeventargs-protectionoptionschanged-member)|Specifies if the `WorksheetProtectionOptions` have changed.| -||[sheetPasswordChanged](/.worksheetprotectionchangedeventargs#excel-javascript/api/excel/-worksheetprotectionchangedeventargs-sheetpasswordchanged-member)|Specifies if the worksheet password has changed.| +|[AllowEditRange](/javascript/api/excel/excel.alloweditrange)|[address](/javascript/api/excel/excel.alloweditrange#excel-excel-alloweditrange-address-member)|Specifies the range associated with the object.| +||[delete()](/javascript/api/excel/excel.alloweditrange#excel-excel-alloweditrange-delete-member(1))|Deletes the object from the `AllowEditRangeCollection`.| +||[isPasswordProtected](/javascript/api/excel/excel.alloweditrange#excel-excel-alloweditrange-ispasswordprotected-member)|Specifies if the object is password protected.| +||[pauseProtection(password?: string)](/javascript/api/excel/excel.alloweditrange#excel-excel-alloweditrange-pauseprotection-member(1))|Pauses worksheet protection for the object for the user in the current session.| +||[setPassword(password?: string)](/javascript/api/excel/excel.alloweditrange#excel-excel-alloweditrange-setpassword-member(1))|Changes the password associated with the object.| +||[title](/javascript/api/excel/excel.alloweditrange#excel-excel-alloweditrange-title-member)|Specifies the title of the object.| +|[AllowEditRangeCollection](/javascript/api/excel/excel.alloweditrangecollection)|[add(title: string, rangeAddress: string, options?: Excel.AllowEditRangeOptions)](/javascript/api/excel/excel.alloweditrangecollection#excel-excel-alloweditrangecollection-add-member(1))|Adds an `AllowEditRange` object to the worksheet.| +||[getCount()](/javascript/api/excel/excel.alloweditrangecollection#excel-excel-alloweditrangecollection-getcount-member(1))|Returns the number of `AllowEditRange` objects in the collection.| +||[getItem(key: string)](/javascript/api/excel/excel.alloweditrangecollection#excel-excel-alloweditrangecollection-getitem-member(1))|Gets the `AllowEditRange` object by its title.| +||[getItemAt(index: number)](/javascript/api/excel/excel.alloweditrangecollection#excel-excel-alloweditrangecollection-getitemat-member(1))|Returns an `AllowEditRange` object by its index in the collection.| +||[getItemOrNullObject(key: string)](/javascript/api/excel/excel.alloweditrangecollection#excel-excel-alloweditrangecollection-getitemornullobject-member(1))|Gets the `AllowEditRange` object by its title.| +||[items](/javascript/api/excel/excel.alloweditrangecollection#excel-excel-alloweditrangecollection-items-member)|Gets the loaded child items in this collection.| +||[pauseProtection(password: string)](/javascript/api/excel/excel.alloweditrangecollection#excel-excel-alloweditrangecollection-pauseprotection-member(1))|Pauses worksheet protection for all `AllowEditRange` objects found in this worksheet that have the given password for the user in the current session.| +|[AllowEditRangeOptions](/javascript/api/excel/excel.alloweditrangeoptions)|[password](/javascript/api/excel/excel.alloweditrangeoptions#excel-excel-alloweditrangeoptions-password-member)|The password associated with the `AllowEditRange`.| +|[LinkedWorkbook](/javascript/api/excel/excel.linkedworkbook)|[breakLinks()](/javascript/api/excel/excel.linkedworkbook#excel-excel-linkedworkbook-breaklinks-member(1))|Makes a request to break the links pointing to the linked workbook.| +||[id](/javascript/api/excel/excel.linkedworkbook#excel-excel-linkedworkbook-id-member)|The original URL pointing to the linked workbook.| +||[refresh()](/javascript/api/excel/excel.linkedworkbook#excel-excel-linkedworkbook-refresh-member(1))|Makes a request to refresh the data retrieved from the linked workbook.| +|[LinkedWorkbookCollection](/javascript/api/excel/excel.linkedworkbookcollection)|[breakAllLinks()](/javascript/api/excel/excel.linkedworkbookcollection#excel-excel-linkedworkbookcollection-breakalllinks-member(1))|Breaks all the links to the linked workbooks.| +||[getItem(key: string)](/javascript/api/excel/excel.linkedworkbookcollection#excel-excel-linkedworkbookcollection-getitem-member(1))|Gets information about a linked workbook by its URL.| +||[getItemOrNullObject(key: string)](/javascript/api/excel/excel.linkedworkbookcollection#excel-excel-linkedworkbookcollection-getitemornullobject-member(1))|Gets information about a linked workbook by its URL.| +||[items](/javascript/api/excel/excel.linkedworkbookcollection#excel-excel-linkedworkbookcollection-items-member)|Gets the loaded child items in this collection.| +||[refreshAll()](/javascript/api/excel/excel.linkedworkbookcollection#excel-excel-linkedworkbookcollection-refreshall-member(1))|Makes a request to refresh all the workbook links.| +||[workbookLinksRefreshMode](/javascript/api/excel/excel.linkedworkbookcollection#excel-excel-linkedworkbookcollection-workbooklinksrefreshmode-member)|Represents the update mode of the workbook links.| +|[NamedSheetView](/javascript/api/excel/excel.namedsheetview)|[activate()](/javascript/api/excel/excel.namedsheetview#excel-excel-namedsheetview-activate-member(1))|Activates this sheet view.| +||[delete()](/javascript/api/excel/excel.namedsheetview#excel-excel-namedsheetview-delete-member(1))|Removes the sheet view from the worksheet.| +||[duplicate(name?: string)](/javascript/api/excel/excel.namedsheetview#excel-excel-namedsheetview-duplicate-member(1))|Creates a copy of this sheet view.| +||[name](/javascript/api/excel/excel.namedsheetview#excel-excel-namedsheetview-name-member)|Gets or sets the name of the sheet view.| +|[NamedSheetViewCollection](/javascript/api/excel/excel.namedsheetviewcollection)|[add(name: string)](/javascript/api/excel/excel.namedsheetviewcollection#excel-excel-namedsheetviewcollection-add-member(1))|Creates a new sheet view with the given name.| +||[enterTemporary()](/javascript/api/excel/excel.namedsheetviewcollection#excel-excel-namedsheetviewcollection-entertemporary-member(1))|Creates and activates a new temporary sheet view.| +||[exit()](/javascript/api/excel/excel.namedsheetviewcollection#excel-excel-namedsheetviewcollection-exit-member(1))|Exits the currently active sheet view.| +||[getActive()](/javascript/api/excel/excel.namedsheetviewcollection#excel-excel-namedsheetviewcollection-getactive-member(1))|Gets the worksheet's currently active sheet view.| +||[getCount()](/javascript/api/excel/excel.namedsheetviewcollection#excel-excel-namedsheetviewcollection-getcount-member(1))|Gets the number of sheet views in this worksheet.| +||[getItem(key: string)](/javascript/api/excel/excel.namedsheetviewcollection#excel-excel-namedsheetviewcollection-getitem-member(1))|Gets a sheet view using its name.| +||[getItemAt(index: number)](/javascript/api/excel/excel.namedsheetviewcollection#excel-excel-namedsheetviewcollection-getitemat-member(1))|Gets a sheet view by its index in the collection.| +||[items](/javascript/api/excel/excel.namedsheetviewcollection#excel-excel-namedsheetviewcollection-items-member)|Gets the loaded child items in this collection.| +|[TableRowCollection](/javascript/api/excel/excel.tablerowcollection)|[deleteRows(rows: number[] \| TableRow[])](/javascript/api/excel/excel.tablerowcollection#excel-excel-tablerowcollection-deleterows-member(1))|Delete multiple rows from a table.| +||[deleteRowsAt(index: number, count?: number)](/javascript/api/excel/excel.tablerowcollection#excel-excel-tablerowcollection-deleterowsat-member(1))|Delete a specified number of rows from a table, starting at a given index.| +|[Workbook](/javascript/api/excel/excel.workbook)|[linkedWorkbooks](/javascript/api/excel/excel.workbook#excel-excel-workbook-linkedworkbooks-member)|Returns a collection of linked workbooks.| +|[Worksheet](/javascript/api/excel/excel.worksheet)|[namedSheetViews](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-namedsheetviews-member)|Returns a collection of sheet views that are present in the worksheet.| +|[WorksheetProtection](/javascript/api/excel/excel.worksheetprotection)|[allowEditRanges](/javascript/api/excel/excel.worksheetprotection#excel-excel-worksheetprotection-alloweditranges-member)|Specifies the `AllowEditRangeCollection` object found in this worksheet.| +||[canPauseProtection](/javascript/api/excel/excel.worksheetprotection#excel-excel-worksheetprotection-canpauseprotection-member)|Specifies if protection can be paused for this worksheet.| +||[checkPassword(password?: string)](/javascript/api/excel/excel.worksheetprotection#excel-excel-worksheetprotection-checkpassword-member(1))|Specifies if the password can be used to unlock worksheet protection.| +||[isPasswordProtected](/javascript/api/excel/excel.worksheetprotection#excel-excel-worksheetprotection-ispasswordprotected-member)|Specifies if the sheet is password protected.| +||[isPaused](/javascript/api/excel/excel.worksheetprotection#excel-excel-worksheetprotection-ispaused-member)|Specifies if worksheet protection is paused.| +||[pauseProtection(password?: string)](/javascript/api/excel/excel.worksheetprotection#excel-excel-worksheetprotection-pauseprotection-member(1))|Pauses worksheet protection for the given worksheet object for the user in the current session.| +||[resumeProtection()](/javascript/api/excel/excel.worksheetprotection#excel-excel-worksheetprotection-resumeprotection-member(1))|Resumes worksheet protection for the given worksheet object for the user in a given session.| +||[savedOptions](/javascript/api/excel/excel.worksheetprotection#excel-excel-worksheetprotection-savedoptions-member)|Specifies the protection options saved in the worksheet.| +||[setPassword(password?: string)](/javascript/api/excel/excel.worksheetprotection#excel-excel-worksheetprotection-setpassword-member(1))|Changes the password associated with the `WorksheetProtection` object.| +||[updateOptions(options: Excel.WorksheetProtectionOptions)](/javascript/api/excel/excel.worksheetprotection#excel-excel-worksheetprotection-updateoptions-member(1))|Change the worksheet protection options associated with the `WorksheetProtection` object.| +|[WorksheetProtectionChangedEventArgs](/javascript/api/excel/excel.worksheetprotectionchangedeventargs)|[allowEditRangesChanged](/javascript/api/excel/excel.worksheetprotectionchangedeventargs#excel-excel-worksheetprotectionchangedeventargs-alloweditrangeschanged-member)|Specifies if any of the `AllowEditRange` objects have changed.| +||[protectionOptionsChanged](/javascript/api/excel/excel.worksheetprotectionchangedeventargs#excel-excel-worksheetprotectionchangedeventargs-protectionoptionschanged-member)|Specifies if the `WorksheetProtectionOptions` have changed.| +||[sheetPasswordChanged](/javascript/api/excel/excel.worksheetprotectionchangedeventargs#excel-excel-worksheetprotectionchangedeventargs-sheetpasswordchanged-member)|Specifies if the worksheet password has changed.| diff --git a/docs/includes/excel-preview.md b/docs/includes/excel-preview.md index dd946a4aa3..91a9538bee 100644 --- a/docs/includes/excel-preview.md +++ b/docs/includes/excel-preview.md @@ -1,165 +1,165 @@ | Class | Fields | Description | |:---|:---|:---| -|[Application](/.application)|[formatStaleValues](/.application#excel-javascript/api/excel/-application-formatstalevalues-member)|Specifies whether the Format Stale Values option within Calculation Options is enabled or disabled.| -|[Base64EncodedImage](/.base64encodedimage)|[data](/.base64encodedimage#excel-javascript/api/excel/-base64encodedimage-data-member)|The Base64-encoded string.| -||[type](/.base64encodedimage#excel-javascript/api/excel/-base64encodedimage-type-member)|The file type of the Base64-encoded image.| -|[BlockedErrorCellValue](/.blockederrorcellvalue)|[errorSubType](/.blockederrorcellvalue#excel-javascript/api/excel/-blockederrorcellvalue-errorsubtype-member)|Represents the type of `BlockedErrorCellValue`.| -|[BooleanCellValue](/.booleancellvalue)|[type](/.booleancellvalue#excel-javascript/api/excel/-booleancellvalue-type-member)|Represents the type of this cell value.| -|[BusyErrorCellValue](/.busyerrorcellvalue)|[errorSubType](/.busyerrorcellvalue#excel-javascript/api/excel/-busyerrorcellvalue-errorsubtype-member)|Represents the type of `BusyErrorCellValue`.| -|[CalcErrorCellValue](/.calcerrorcellvalue)|[errorSubType](/.calcerrorcellvalue#excel-javascript/api/excel/-calcerrorcellvalue-errorsubtype-member)|Represents the type of `CalcErrorCellValue`.| -|[Chart](/.chart)|[getDataRange()](/.chart#excel-javascript/api/excel/-chart-getdatarange-member(1))|Gets the data source of the whole chart.| -||[getDataRangeOrNullObject()](/.chart#excel-javascript/api/excel/-chart-getdatarangeornullobject-member(1))|Gets the data source of the whole chart.| -|[Comment](/.comment)|[assignTask(assignee: Excel.EmailIdentity)](/.comment#excel-javascript/api/excel/-comment-assigntask-member(1))|Assigns the task attached to the comment to the given user as an assignee.| -||[getTask()](/.comment#excel-javascript/api/excel/-comment-gettask-member(1))|Gets the task associated with this comment.| -||[getTaskOrNullObject()](/.comment#excel-javascript/api/excel/-comment-gettaskornullobject-member(1))|Gets the task associated with this comment.| -|[CommentReply](/.commentreply)|[assignTask(assignee: Excel.EmailIdentity)](/.commentreply#excel-javascript/api/excel/-commentreply-assigntask-member(1))|Assigns the task attached to the comment to the given user as the sole assignee.| -||[getTask()](/.commentreply#excel-javascript/api/excel/-commentreply-gettask-member(1))|Gets the task associated with this comment reply's thread.| -||[getTaskOrNullObject()](/.commentreply#excel-javascript/api/excel/-commentreply-gettaskornullobject-member(1))|Gets the task associated with this comment reply's thread.| -|[ConnectErrorCellValue](/.connecterrorcellvalue)|[errorSubType](/.connecterrorcellvalue#excel-javascript/api/excel/-connecterrorcellvalue-errorsubtype-member)|Represents the type of `ConnectErrorCellValue`.| -|[DatetimeFormatInfo](/.datetimeformatinfo)|[shortDateTimePattern](/.datetimeformatinfo#excel-javascript/api/excel/-datetimeformatinfo-shortdatetimepattern-member)|Gets the format string for a short date and time value.| -|[DocumentTask](/.documenttask)|[assign(assignee: Excel.EmailIdentity)](/.documenttask#excel-javascript/api/excel/-documenttask-assign-member(1))|Adds the given user to the list of assignees attached to the task.| -||[assignees](/.documenttask#excel-javascript/api/excel/-documenttask-assignees-member)|Returns a collection of assignees of the task.| -||[changes](/.documenttask#excel-javascript/api/excel/-documenttask-changes-member)|Gets the change records of the task.| -||[comment](/.documenttask#excel-javascript/api/excel/-documenttask-comment-member)|Gets the comment associated with the task.| -||[completedBy](/.documenttask#excel-javascript/api/excel/-documenttask-completedby-member)|Gets the most recent user to have completed the task.| -||[completedDateTime](/.documenttask#excel-javascript/api/excel/-documenttask-completeddatetime-member)|Gets the date and time that the task was completed.| -||[createdBy](/.documenttask#excel-javascript/api/excel/-documenttask-createdby-member)|Gets the user who created the task.| -||[createdDateTime](/.documenttask#excel-javascript/api/excel/-documenttask-createddatetime-member)|Gets the date and time that the task was created.| -||[id](/.documenttask#excel-javascript/api/excel/-documenttask-id-member)|Gets the ID of the task.| -||[percentComplete](/.documenttask#excel-javascript/api/excel/-documenttask-percentcomplete-member)|Specifies the completion percentage of the task.| -||[priority](/.documenttask#excel-javascript/api/excel/-documenttask-priority-member)|Specifies the priority of the task.| -||[startAndDueDateTime](/.documenttask#excel-javascript/api/excel/-documenttask-startandduedatetime-member)|Gets or sets the date and time the task should start and is due.| -||[title](/.documenttask#excel-javascript/api/excel/-documenttask-title-member)|Specifies title of the task.| -||[unassign(assignee: Excel.EmailIdentity)](/.documenttask#excel-javascript/api/excel/-documenttask-unassign-member(1))|Removes the given user from the list of assignees attached to the task.| -||[unassignAll()](/.documenttask#excel-javascript/api/excel/-documenttask-unassignall-member(1))|Removes all users from the list of assignees attached to the task.| -|[DocumentTaskChange](/.documenttaskchange)|[assignee](/.documenttaskchange#excel-javascript/api/excel/-documenttaskchange-assignee-member)|Represents the user assigned to the task for an `assign` change action, or the user unassigned from the task for an `unassign` change action.| -||[changedBy](/.documenttaskchange#excel-javascript/api/excel/-documenttaskchange-changedby-member)|Represents the identity of the user who made the task change.| -||[commentId](/.documenttaskchange#excel-javascript/api/excel/-documenttaskchange-commentid-member)|Represents the ID of the comment or comment reply to which the task change is anchored.| -||[createdDateTime](/.documenttaskchange#excel-javascript/api/excel/-documenttaskchange-createddatetime-member)|Represents the creation date and time of the task change record.| -||[dueDateTime](/.documenttaskchange#excel-javascript/api/excel/-documenttaskchange-duedatetime-member)|Represents the task's due date and time.| -||[id](/.documenttaskchange#excel-javascript/api/excel/-documenttaskchange-id-member)|The unique GUID of the task change.| -||[percentComplete](/.documenttaskchange#excel-javascript/api/excel/-documenttaskchange-percentcomplete-member)|Represents the task's completion percentage.| -||[priority](/.documenttaskchange#excel-javascript/api/excel/-documenttaskchange-priority-member)|Represents the task's priority.| -||[startDateTime](/.documenttaskchange#excel-javascript/api/excel/-documenttaskchange-startdatetime-member)|Represents the task's start date and time.| -||[title](/.documenttaskchange#excel-javascript/api/excel/-documenttaskchange-title-member)|Represents the task's title.| -||[type](/.documenttaskchange#excel-javascript/api/excel/-documenttaskchange-type-member)|Represents the action type of the task change record.| -||[undoChangeId](/.documenttaskchange#excel-javascript/api/excel/-documenttaskchange-undochangeid-member)|Represents the `DocumentTaskChange.id` property that was undone for the `undo` change action.| -|[DocumentTaskChangeCollection](/.documenttaskchangecollection)|[getCount()](/.documenttaskchangecollection#excel-javascript/api/excel/-documenttaskchangecollection-getcount-member(1))|Gets the number of change records in the collection for the task.| -||[getItemAt(index: number)](/.documenttaskchangecollection#excel-javascript/api/excel/-documenttaskchangecollection-getitemat-member(1))|Gets a task change record by using its index in the collection.| -||[items](/.documenttaskchangecollection#excel-javascript/api/excel/-documenttaskchangecollection-items-member)|Gets the loaded child items in this collection.| -|[DocumentTaskCollection](/.documenttaskcollection)|[getCount()](/.documenttaskcollection#excel-javascript/api/excel/-documenttaskcollection-getcount-member(1))|Gets the number of tasks in the collection.| -||[getItem(key: string)](/.documenttaskcollection#excel-javascript/api/excel/-documenttaskcollection-getitem-member(1))|Gets a task using its ID.| -||[getItemAt(index: number)](/.documenttaskcollection#excel-javascript/api/excel/-documenttaskcollection-getitemat-member(1))|Gets a task by its index in the collection.| -||[getItemOrNullObject(key: string)](/.documenttaskcollection#excel-javascript/api/excel/-documenttaskcollection-getitemornullobject-member(1))|Gets a task using its ID.| -||[items](/.documenttaskcollection#excel-javascript/api/excel/-documenttaskcollection-items-member)|Gets the loaded child items in this collection.| -|[DocumentTaskSchedule](/.documenttaskschedule)|[dueDateTime](/.documenttaskschedule#excel-javascript/api/excel/-documenttaskschedule-duedatetime-member)|Gets the date and time that the task is due.| -||[startDateTime](/.documenttaskschedule#excel-javascript/api/excel/-documenttaskschedule-startdatetime-member)|Gets the date and time that the task should start.| -|[DoubleCellValue](/.doublecellvalue)|[type](/.doublecellvalue#excel-javascript/api/excel/-doublecellvalue-type-member)|Represents the type of this cell value.| -|[EmailIdentity](/.emailidentity)|[displayName](/.emailidentity#excel-javascript/api/excel/-emailidentity-displayname-member)|Represents the user's display name.| -||[email](/.emailidentity#excel-javascript/api/excel/-emailidentity-email-member)|Represents the user's email.| -||[id](/.emailidentity#excel-javascript/api/excel/-emailidentity-id-member)|Represents the user's unique ID.| -|[EntityArrayCardLayout](/.entityarraycardlayout)|[arrayProperty](/.entityarraycardlayout#excel-javascript/api/excel/-entityarraycardlayout-arrayproperty-member)|Represents name of the property that contains the array shown in the card.| -||[columnsToReport](/.entityarraycardlayout#excel-javascript/api/excel/-entityarraycardlayout-columnstoreport-member)|Represents the count of columns which the card claims are in the array.| -||[displayName](/.entityarraycardlayout#excel-javascript/api/excel/-entityarraycardlayout-displayname-member)|Represents name of the property that contains the array shown in the card.| -||[firstRowIsHeader](/.entityarraycardlayout#excel-javascript/api/excel/-entityarraycardlayout-firstrowisheader-member)|Represents whether the first row of the array is treated as a header.| -||[layout](/.entityarraycardlayout#excel-javascript/api/excel/-entityarraycardlayout-layout-member)|Represents the type of this layout.| -||[rowsToReport](/.entityarraycardlayout#excel-javascript/api/excel/-entityarraycardlayout-rowstoreport-member)|Represents the count of rows which the card claims are in the array.| -|[EntityCardLayout](/.entitycardlayout)|[layout](/.entitycardlayout#excel-javascript/api/excel/-entitycardlayout-layout-member)|Represents the type of this layout.| -|[ExternalCodeServiceObjectCellValue](/.externalcodeserviceobjectcellvalue)|[Python_str](/.externalcodeserviceobjectcellvalue#excel-javascript/api/excel/-externalcodeserviceobjectcellvalue-python_str-member)|Represents the output of the `str()` function when used on this object.| -||[Python_type](/.externalcodeserviceobjectcellvalue#excel-javascript/api/excel/-externalcodeserviceobjectcellvalue-python_type-member)|Represents the full type name of this object.| -||[Python_typeName](/.externalcodeserviceobjectcellvalue#excel-javascript/api/excel/-externalcodeserviceobjectcellvalue-python_typename-member)|Represents the short type name of this object.| -||[basicType](/.externalcodeserviceobjectcellvalue#excel-javascript/api/excel/-externalcodeserviceobjectcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/.externalcodeserviceobjectcellvalue#excel-javascript/api/excel/-externalcodeserviceobjectcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[language](/.externalcodeserviceobjectcellvalue#excel-javascript/api/excel/-externalcodeserviceobjectcellvalue-language-member)|Represents the runtime language of this external code service.| -||[preview](/.externalcodeserviceobjectcellvalue#excel-javascript/api/excel/-externalcodeserviceobjectcellvalue-preview-member)|Represents the preview value shown in the cell.| -||[provider](/.externalcodeserviceobjectcellvalue#excel-javascript/api/excel/-externalcodeserviceobjectcellvalue-provider-member)|Represents information about the service that provided the data in this `ExternalCodeServiceObjectCellValue`.| -||[type](/.externalcodeserviceobjectcellvalue#excel-javascript/api/excel/-externalcodeserviceobjectcellvalue-type-member)|Represents the type of this cell value.| -|[Identity](/.identity)|[displayName](/.identity#excel-javascript/api/excel/-identity-displayname-member)|Represents the user's display name.| -||[id](/.identity#excel-javascript/api/excel/-identity-id-member)|Represents the user's unique ID.| -|[LinkedDataType](/.linkeddatatype)|[dataProvider](/.linkeddatatype#excel-javascript/api/excel/-linkeddatatype-dataprovider-member)|The name of the data provider for the linked data type.| -||[lastRefreshed](/.linkeddatatype#excel-javascript/api/excel/-linkeddatatype-lastrefreshed-member)|The local time-zone date and time since the workbook was opened when the linked data type was last refreshed.| -||[name](/.linkeddatatype#excel-javascript/api/excel/-linkeddatatype-name-member)|The name of the linked data type.| -||[periodicRefreshInterval](/.linkeddatatype#excel-javascript/api/excel/-linkeddatatype-periodicrefreshinterval-member)|The frequency, in seconds, at which the linked data type is refreshed if `refreshMode` is set to "Periodic".| -||[refreshMode](/.linkeddatatype#excel-javascript/api/excel/-linkeddatatype-refreshmode-member)|The mechanism by which the data for the linked data type is retrieved.| -||[requestRefresh()](/.linkeddatatype#excel-javascript/api/excel/-linkeddatatype-requestrefresh-member(1))|Makes a request to refresh the linked data type.| -||[requestSetRefreshMode(refreshMode: Excel.LinkedDataTypeRefreshMode)](/.linkeddatatype#excel-javascript/api/excel/-linkeddatatype-requestsetrefreshmode-member(1))|Makes a request to change the refresh mode for this linked data type.| -||[serviceId](/.linkeddatatype#excel-javascript/api/excel/-linkeddatatype-serviceid-member)|The unique ID of the linked data type.| -||[supportedRefreshModes](/.linkeddatatype#excel-javascript/api/excel/-linkeddatatype-supportedrefreshmodes-member)|Returns an array with all the refresh modes supported by the linked data type.| -|[LinkedDataTypeAddedEventArgs](/.linkeddatatypeaddedeventargs)|[serviceId](/.linkeddatatypeaddedeventargs#excel-javascript/api/excel/-linkeddatatypeaddedeventargs-serviceid-member)|The unique ID of the new linked data type.| -||[source](/.linkeddatatypeaddedeventargs#excel-javascript/api/excel/-linkeddatatypeaddedeventargs-source-member)|Gets the source of the event.| -||[type](/.linkeddatatypeaddedeventargs#excel-javascript/api/excel/-linkeddatatypeaddedeventargs-type-member)|Gets the type of the event.| -|[LinkedDataTypeCollection](/.linkeddatatypecollection)|[getCount()](/.linkeddatatypecollection#excel-javascript/api/excel/-linkeddatatypecollection-getcount-member(1))|Gets the number of linked data types in the collection.| -||[getItem(key: number)](/.linkeddatatypecollection#excel-javascript/api/excel/-linkeddatatypecollection-getitem-member(1))|Gets a linked data type by service ID.| -||[getItemAt(index: number)](/.linkeddatatypecollection#excel-javascript/api/excel/-linkeddatatypecollection-getitemat-member(1))|Gets a linked data type by its index in the collection.| -||[getItemOrNullObject(key: number)](/.linkeddatatypecollection#excel-javascript/api/excel/-linkeddatatypecollection-getitemornullobject-member(1))|Gets a linked data type by ID.| -||[items](/.linkeddatatypecollection#excel-javascript/api/excel/-linkeddatatypecollection-items-member)|Gets the loaded child items in this collection.| -||[requestRefreshAll()](/.linkeddatatypecollection#excel-javascript/api/excel/-linkeddatatypecollection-requestrefreshall-member(1))|Makes a request to refresh all the linked data types in the collection.| -|[LocalImage](/.localimage)|[getBase64EncodedImageData(cacheUid: string)](/.localimage#excel-javascript/api/excel/-localimage-getbase64encodedimagedata-member(1))|Gets the Base64-encoded image data stored in the shared image cache with the cache unique identifier (UID).| -|[LocalImageCellValue](/.localimagecellvalue)|[altText](/.localimagecellvalue#excel-javascript/api/excel/-localimagecellvalue-alttext-member)|Represents the alternate text used in accessibility scenarios to describe what the image represents.| -||[attribution](/.localimagecellvalue#excel-javascript/api/excel/-localimagecellvalue-attribution-member)|Represents attribution information to describe the source and license requirements for this image.| -||[basicType](/.localimagecellvalue#excel-javascript/api/excel/-localimagecellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/.localimagecellvalue#excel-javascript/api/excel/-localimagecellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[image](/.localimagecellvalue#excel-javascript/api/excel/-localimagecellvalue-image-member)|Represents the image itself, either cached or encoded.| -||[provider](/.localimagecellvalue#excel-javascript/api/excel/-localimagecellvalue-provider-member)|Represents information that describes the entity or individual who provided the image.| -||[type](/.localimagecellvalue#excel-javascript/api/excel/-localimagecellvalue-type-member)|Represents the type of this cell value.| -|[LocalImageCellValueCacheId](/.localimagecellvaluecacheid)|[cachedUid](/.localimagecellvaluecacheid#excel-javascript/api/excel/-localimagecellvaluecacheid-cacheduid-member)|Represents the image's UID as it appears in the cache.| -|[NameErrorCellValue](/.nameerrorcellvalue)|[errorSubType](/.nameerrorcellvalue#excel-javascript/api/excel/-nameerrorcellvalue-errorsubtype-member)|Represents the type of `NameErrorCellValue`.| -|[NamedSheetViewCollection](/.namedsheetviewcollection)|[getItemOrNullObject(key: string)](/.namedsheetviewcollection#excel-javascript/api/excel/-namedsheetviewcollection-getitemornullobject-member(1))|Gets a sheet view using its name.| -|[NotAvailableErrorCellValue](/.notavailableerrorcellvalue)|[errorSubType](/.notavailableerrorcellvalue#excel-javascript/api/excel/-notavailableerrorcellvalue-errorsubtype-member)|Represents the type of `NotAvailableErrorCellValue`.| -|[PivotLayout](/.pivotlayout)|[getCell(dataHierarchy: DataPivotHierarchy \| string, rowItems: Array, columnItems: Array)](/.pivotlayout#excel-javascript/api/excel/-pivotlayout-getcell-member(1))|Gets a unique cell in the PivotTable based on a data hierarchy and the row and column items of their respective hierarchies.| -||[pivotStyle](/.pivotlayout#excel-javascript/api/excel/-pivotlayout-pivotstyle-member)|The style applied to the PivotTable.| -||[setStyle(style: string \| PivotTableStyle \| BuiltInPivotTableStyle)](/.pivotlayout#excel-javascript/api/excel/-pivotlayout-setstyle-member(1))|Sets the style applied to the PivotTable.| -|[PivotTable](/.pivottable)|[autoRefresh](/.pivottable#excel-javascript/api/excel/-pivottable-autorefresh-member)|Specifies whether the PivotTable auto refreshes when the source data changes.| -|[PythonErrorCellValue](/.pythonerrorcellvalue)|[basicType](/.pythonerrorcellvalue#excel-javascript/api/excel/-pythonerrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/.pythonerrorcellvalue#excel-javascript/api/excel/-pythonerrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[errorType](/.pythonerrorcellvalue#excel-javascript/api/excel/-pythonerrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| -||[type](/.pythonerrorcellvalue#excel-javascript/api/excel/-pythonerrorcellvalue-type-member)|Represents the type of this cell value.| -|[Query](/.query)|[delete()](/.query#excel-javascript/api/excel/-query-delete-member(1))|Deletes the query and associated connection.| -||[refresh()](/.query#excel-javascript/api/excel/-query-refresh-member(1))|Refreshes the query.| -|[QueryCollection](/.querycollection)|[refreshAll()](/.querycollection#excel-javascript/api/excel/-querycollection-refreshall-member(1))|Refresh all queries.| -|[Range](/.range)|[togglePythonMarshalMode(marshalMode?: Excel.PythonMarshalMode)](/.range#excel-javascript/api/excel/-range-togglepythonmarshalmode-member(1))|Sets the marshaling mode of the Python in Excel formula =PY.| -|[RangeAreas](/.rangeareas)||| -|[RefErrorCellValue](/.referrorcellvalue)|[errorSubType](/.referrorcellvalue#excel-javascript/api/excel/-referrorcellvalue-errorsubtype-member)|Represents the type of `RefErrorCellValue`.| -|[RefreshModeChangedEventArgs](/.refreshmodechangedeventargs)|[refreshMode](/.refreshmodechangedeventargs#excel-javascript/api/excel/-refreshmodechangedeventargs-refreshmode-member)|The linked data type refresh mode.| -||[serviceId](/.refreshmodechangedeventargs#excel-javascript/api/excel/-refreshmodechangedeventargs-serviceid-member)|The unique ID of the object whose refresh mode was changed.| -||[source](/.refreshmodechangedeventargs#excel-javascript/api/excel/-refreshmodechangedeventargs-source-member)|Gets the source of the event.| -||[type](/.refreshmodechangedeventargs#excel-javascript/api/excel/-refreshmodechangedeventargs-type-member)|Gets the type of the event.| -|[RefreshRequestCompletedEventArgs](/.refreshrequestcompletedeventargs)|[refreshed](/.refreshrequestcompletedeventargs#excel-javascript/api/excel/-refreshrequestcompletedeventargs-refreshed-member)|Indicates if the request to refresh was successful.| -||[serviceId](/.refreshrequestcompletedeventargs#excel-javascript/api/excel/-refreshrequestcompletedeventargs-serviceid-member)|The unique ID of the object whose refresh request was completed.| -||[source](/.refreshrequestcompletedeventargs#excel-javascript/api/excel/-refreshrequestcompletedeventargs-source-member)|Gets the source of the event.| -||[type](/.refreshrequestcompletedeventargs#excel-javascript/api/excel/-refreshrequestcompletedeventargs-type-member)|Gets the type of the event.| -||[warnings](/.refreshrequestcompletedeventargs#excel-javascript/api/excel/-refreshrequestcompletedeventargs-warnings-member)|An array that contains any warnings generated from the refresh request.| -|[ShapeCollection](/.shapecollection)|[addLocalImageReference(address: string)](/.shapecollection#excel-javascript/api/excel/-shapecollection-addlocalimagereference-member(1))|Creates a reference for the local image stored in the cell address and displays it as a floating shape over cells.| -||[addSvg(xml: string)](/.shapecollection#excel-javascript/api/excel/-shapecollection-addsvg-member(1))|Creates a scalable vector graphic (SVG) from an XML string and adds it to the worksheet.| -|[Slicer](/.slicer)|[nameInFormula](/.slicer#excel-javascript/api/excel/-slicer-nameinformula-member)|Specifies the slicer name used in the formula.| -||[setStyle(style: string \| SlicerStyle \| BuiltInSlicerStyle)](/.slicer#excel-javascript/api/excel/-slicer-setstyle-member(1))|Sets the style applied to the slicer.| -||[slicerStyle](/.slicer#excel-javascript/api/excel/-slicer-slicerstyle-member)|The style applied to the slicer.| -|[StringCellValue](/.stringcellvalue)|[type](/.stringcellvalue#excel-javascript/api/excel/-stringcellvalue-type-member)|Represents the type of this cell value.| -|[Table](/.table)|[clearStyle()](/.table#excel-javascript/api/excel/-table-clearstyle-member(1))|Changes the table to use the default table style.| -||[onFiltered](/.table#excel-javascript/api/excel/-table-onfiltered-member)|Occurs when a filter is applied on a specific table.| -||[setStyle(style: string \| TableStyle \| BuiltInTableStyle)](/.table#excel-javascript/api/excel/-table-setstyle-member(1))|Sets the style applied to the table.| -||[tableStyle](/.table#excel-javascript/api/excel/-table-tablestyle-member)|The style applied to the table.| -|[TableCollection](/.tablecollection)|[onFiltered](/.tablecollection#excel-javascript/api/excel/-tablecollection-onfiltered-member)|Occurs when a filter is applied on any table in a workbook, or a worksheet.| -|[TableFilteredEventArgs](/.tablefilteredeventargs)|[tableId](/.tablefilteredeventargs#excel-javascript/api/excel/-tablefilteredeventargs-tableid-member)|Gets the ID of the table in which the filter is applied.| -||[type](/.tablefilteredeventargs#excel-javascript/api/excel/-tablefilteredeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/.tablefilteredeventargs#excel-javascript/api/excel/-tablefilteredeventargs-worksheetid-member)|Gets the ID of the worksheet which contains the table.| -|[TimeoutErrorCellValue](/.timeouterrorcellvalue)|[basicType](/.timeouterrorcellvalue#excel-javascript/api/excel/-timeouterrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| -||[basicValue](/.timeouterrorcellvalue#excel-javascript/api/excel/-timeouterrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| -||[errorSubType](/.timeouterrorcellvalue#excel-javascript/api/excel/-timeouterrorcellvalue-errorsubtype-member)|Represents the type of `TimeoutErrorCellValue`.| -||[errorType](/.timeouterrorcellvalue#excel-javascript/api/excel/-timeouterrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| -||[type](/.timeouterrorcellvalue#excel-javascript/api/excel/-timeouterrorcellvalue-type-member)|Represents the type of this cell value.| -|[ValueErrorCellValue](/.valueerrorcellvalue)|[errorSubType](/.valueerrorcellvalue#excel-javascript/api/excel/-valueerrorcellvalue-errorsubtype-member)|Represents the type of `ValueErrorCellValue`.| -|[Workbook](/.workbook)|[enterPreviewMode()](/.workbook#excel-javascript/api/excel/-workbook-enterpreviewmode-member(1))|Enters Scratchpad Preview Mode for the workbook, showing changes suggested by Copilot to the user.| -||[exitPreviewMode(applyChanges: boolean)](/.workbook#excel-javascript/api/excel/-workbook-exitpreviewmode-member(1))|Exits Scratchpad Preview Mode for the workbook.| -||[externalCodeServiceTimeout](/.workbook#excel-javascript/api/excel/-workbook-externalcodeservicetimeout-member)|Specifies the maximum length of time, in seconds, allotted for a formula that depends on an external code service to complete.| -||[linkedDataTypes](/.workbook#excel-javascript/api/excel/-workbook-linkeddatatypes-member)|Returns a collection of linked data types that are part of the workbook.| -||[localImage](/.workbook#excel-javascript/api/excel/-workbook-localimage-member)|Returns the `LocalImage` object associated with the workbook.| -||[showPivotFieldList](/.workbook#excel-javascript/api/excel/-workbook-showpivotfieldlist-member)|Specifies whether the PivotTable's field list pane is shown at the workbook level.| -||[tasks](/.workbook#excel-javascript/api/excel/-workbook-tasks-member)|Returns a collection of tasks that are present in the workbook.| -||[use1904DateSystem](/.workbook#excel-javascript/api/excel/-workbook-use1904datesystem-member)|True if the workbook uses the 1904 date system.| -|[Worksheet](/.worksheet)|[onFiltered](/.worksheet#excel-javascript/api/excel/-worksheet-onfiltered-member)|Occurs when a filter is applied on a specific worksheet.| -||[tasks](/.worksheet#excel-javascript/api/excel/-worksheet-tasks-member)|Returns a collection of tasks that are present in the worksheet.| -|[WorksheetCollection](/.worksheetcollection)|[addFromBase64(base64File: string, sheetNamesToInsert?: string[], positionType?: Excel.WorksheetPositionType, relativeTo?: Worksheet \| string)](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-addfrombase64-member(1))|Inserts the specified worksheets of a workbook into the current workbook.| -||[onFiltered](/.worksheetcollection#excel-javascript/api/excel/-worksheetcollection-onfiltered-member)|Occurs when any worksheet's filter is applied in the workbook.| -|[WorksheetFilteredEventArgs](/.worksheetfilteredeventargs)|[type](/.worksheetfilteredeventargs#excel-javascript/api/excel/-worksheetfilteredeventargs-type-member)|Gets the type of the event.| -||[worksheetId](/.worksheetfilteredeventargs#excel-javascript/api/excel/-worksheetfilteredeventargs-worksheetid-member)|Gets the ID of the worksheet in which the filter is applied.| +|[Application](/javascript/api/excel/excel.application)|[formatStaleValues](/javascript/api/excel/excel.application#excel-excel-application-formatstalevalues-member)|Specifies whether the Format Stale Values option within Calculation Options is enabled or disabled.| +|[Base64EncodedImage](/javascript/api/excel/excel.base64encodedimage)|[data](/javascript/api/excel/excel.base64encodedimage#excel-excel-base64encodedimage-data-member)|The Base64-encoded string.| +||[type](/javascript/api/excel/excel.base64encodedimage#excel-excel-base64encodedimage-type-member)|The file type of the Base64-encoded image.| +|[BlockedErrorCellValue](/javascript/api/excel/excel.blockederrorcellvalue)|[errorSubType](/javascript/api/excel/excel.blockederrorcellvalue#excel-excel-blockederrorcellvalue-errorsubtype-member)|Represents the type of `BlockedErrorCellValue`.| +|[BooleanCellValue](/javascript/api/excel/excel.booleancellvalue)|[type](/javascript/api/excel/excel.booleancellvalue#excel-excel-booleancellvalue-type-member)|Represents the type of this cell value.| +|[BusyErrorCellValue](/javascript/api/excel/excel.busyerrorcellvalue)|[errorSubType](/javascript/api/excel/excel.busyerrorcellvalue#excel-excel-busyerrorcellvalue-errorsubtype-member)|Represents the type of `BusyErrorCellValue`.| +|[CalcErrorCellValue](/javascript/api/excel/excel.calcerrorcellvalue)|[errorSubType](/javascript/api/excel/excel.calcerrorcellvalue#excel-excel-calcerrorcellvalue-errorsubtype-member)|Represents the type of `CalcErrorCellValue`.| +|[Chart](/javascript/api/excel/excel.chart)|[getDataRange()](/javascript/api/excel/excel.chart#excel-excel-chart-getdatarange-member(1))|Gets the data source of the whole chart.| +||[getDataRangeOrNullObject()](/javascript/api/excel/excel.chart#excel-excel-chart-getdatarangeornullobject-member(1))|Gets the data source of the whole chart.| +|[Comment](/javascript/api/excel/excel.comment)|[assignTask(assignee: Excel.EmailIdentity)](/javascript/api/excel/excel.comment#excel-excel-comment-assigntask-member(1))|Assigns the task attached to the comment to the given user as an assignee.| +||[getTask()](/javascript/api/excel/excel.comment#excel-excel-comment-gettask-member(1))|Gets the task associated with this comment.| +||[getTaskOrNullObject()](/javascript/api/excel/excel.comment#excel-excel-comment-gettaskornullobject-member(1))|Gets the task associated with this comment.| +|[CommentReply](/javascript/api/excel/excel.commentreply)|[assignTask(assignee: Excel.EmailIdentity)](/javascript/api/excel/excel.commentreply#excel-excel-commentreply-assigntask-member(1))|Assigns the task attached to the comment to the given user as the sole assignee.| +||[getTask()](/javascript/api/excel/excel.commentreply#excel-excel-commentreply-gettask-member(1))|Gets the task associated with this comment reply's thread.| +||[getTaskOrNullObject()](/javascript/api/excel/excel.commentreply#excel-excel-commentreply-gettaskornullobject-member(1))|Gets the task associated with this comment reply's thread.| +|[ConnectErrorCellValue](/javascript/api/excel/excel.connecterrorcellvalue)|[errorSubType](/javascript/api/excel/excel.connecterrorcellvalue#excel-excel-connecterrorcellvalue-errorsubtype-member)|Represents the type of `ConnectErrorCellValue`.| +|[DatetimeFormatInfo](/javascript/api/excel/excel.datetimeformatinfo)|[shortDateTimePattern](/javascript/api/excel/excel.datetimeformatinfo#excel-excel-datetimeformatinfo-shortdatetimepattern-member)|Gets the format string for a short date and time value.| +|[DocumentTask](/javascript/api/excel/excel.documenttask)|[assign(assignee: Excel.EmailIdentity)](/javascript/api/excel/excel.documenttask#excel-excel-documenttask-assign-member(1))|Adds the given user to the list of assignees attached to the task.| +||[assignees](/javascript/api/excel/excel.documenttask#excel-excel-documenttask-assignees-member)|Returns a collection of assignees of the task.| +||[changes](/javascript/api/excel/excel.documenttask#excel-excel-documenttask-changes-member)|Gets the change records of the task.| +||[comment](/javascript/api/excel/excel.documenttask#excel-excel-documenttask-comment-member)|Gets the comment associated with the task.| +||[completedBy](/javascript/api/excel/excel.documenttask#excel-excel-documenttask-completedby-member)|Gets the most recent user to have completed the task.| +||[completedDateTime](/javascript/api/excel/excel.documenttask#excel-excel-documenttask-completeddatetime-member)|Gets the date and time that the task was completed.| +||[createdBy](/javascript/api/excel/excel.documenttask#excel-excel-documenttask-createdby-member)|Gets the user who created the task.| +||[createdDateTime](/javascript/api/excel/excel.documenttask#excel-excel-documenttask-createddatetime-member)|Gets the date and time that the task was created.| +||[id](/javascript/api/excel/excel.documenttask#excel-excel-documenttask-id-member)|Gets the ID of the task.| +||[percentComplete](/javascript/api/excel/excel.documenttask#excel-excel-documenttask-percentcomplete-member)|Specifies the completion percentage of the task.| +||[priority](/javascript/api/excel/excel.documenttask#excel-excel-documenttask-priority-member)|Specifies the priority of the task.| +||[startAndDueDateTime](/javascript/api/excel/excel.documenttask#excel-excel-documenttask-startandduedatetime-member)|Gets or sets the date and time the task should start and is due.| +||[title](/javascript/api/excel/excel.documenttask#excel-excel-documenttask-title-member)|Specifies title of the task.| +||[unassign(assignee: Excel.EmailIdentity)](/javascript/api/excel/excel.documenttask#excel-excel-documenttask-unassign-member(1))|Removes the given user from the list of assignees attached to the task.| +||[unassignAll()](/javascript/api/excel/excel.documenttask#excel-excel-documenttask-unassignall-member(1))|Removes all users from the list of assignees attached to the task.| +|[DocumentTaskChange](/javascript/api/excel/excel.documenttaskchange)|[assignee](/javascript/api/excel/excel.documenttaskchange#excel-excel-documenttaskchange-assignee-member)|Represents the user assigned to the task for an `assign` change action, or the user unassigned from the task for an `unassign` change action.| +||[changedBy](/javascript/api/excel/excel.documenttaskchange#excel-excel-documenttaskchange-changedby-member)|Represents the identity of the user who made the task change.| +||[commentId](/javascript/api/excel/excel.documenttaskchange#excel-excel-documenttaskchange-commentid-member)|Represents the ID of the comment or comment reply to which the task change is anchored.| +||[createdDateTime](/javascript/api/excel/excel.documenttaskchange#excel-excel-documenttaskchange-createddatetime-member)|Represents the creation date and time of the task change record.| +||[dueDateTime](/javascript/api/excel/excel.documenttaskchange#excel-excel-documenttaskchange-duedatetime-member)|Represents the task's due date and time.| +||[id](/javascript/api/excel/excel.documenttaskchange#excel-excel-documenttaskchange-id-member)|The unique GUID of the task change.| +||[percentComplete](/javascript/api/excel/excel.documenttaskchange#excel-excel-documenttaskchange-percentcomplete-member)|Represents the task's completion percentage.| +||[priority](/javascript/api/excel/excel.documenttaskchange#excel-excel-documenttaskchange-priority-member)|Represents the task's priority.| +||[startDateTime](/javascript/api/excel/excel.documenttaskchange#excel-excel-documenttaskchange-startdatetime-member)|Represents the task's start date and time.| +||[title](/javascript/api/excel/excel.documenttaskchange#excel-excel-documenttaskchange-title-member)|Represents the task's title.| +||[type](/javascript/api/excel/excel.documenttaskchange#excel-excel-documenttaskchange-type-member)|Represents the action type of the task change record.| +||[undoChangeId](/javascript/api/excel/excel.documenttaskchange#excel-excel-documenttaskchange-undochangeid-member)|Represents the `DocumentTaskChange.id` property that was undone for the `undo` change action.| +|[DocumentTaskChangeCollection](/javascript/api/excel/excel.documenttaskchangecollection)|[getCount()](/javascript/api/excel/excel.documenttaskchangecollection#excel-excel-documenttaskchangecollection-getcount-member(1))|Gets the number of change records in the collection for the task.| +||[getItemAt(index: number)](/javascript/api/excel/excel.documenttaskchangecollection#excel-excel-documenttaskchangecollection-getitemat-member(1))|Gets a task change record by using its index in the collection.| +||[items](/javascript/api/excel/excel.documenttaskchangecollection#excel-excel-documenttaskchangecollection-items-member)|Gets the loaded child items in this collection.| +|[DocumentTaskCollection](/javascript/api/excel/excel.documenttaskcollection)|[getCount()](/javascript/api/excel/excel.documenttaskcollection#excel-excel-documenttaskcollection-getcount-member(1))|Gets the number of tasks in the collection.| +||[getItem(key: string)](/javascript/api/excel/excel.documenttaskcollection#excel-excel-documenttaskcollection-getitem-member(1))|Gets a task using its ID.| +||[getItemAt(index: number)](/javascript/api/excel/excel.documenttaskcollection#excel-excel-documenttaskcollection-getitemat-member(1))|Gets a task by its index in the collection.| +||[getItemOrNullObject(key: string)](/javascript/api/excel/excel.documenttaskcollection#excel-excel-documenttaskcollection-getitemornullobject-member(1))|Gets a task using its ID.| +||[items](/javascript/api/excel/excel.documenttaskcollection#excel-excel-documenttaskcollection-items-member)|Gets the loaded child items in this collection.| +|[DocumentTaskSchedule](/javascript/api/excel/excel.documenttaskschedule)|[dueDateTime](/javascript/api/excel/excel.documenttaskschedule#excel-excel-documenttaskschedule-duedatetime-member)|Gets the date and time that the task is due.| +||[startDateTime](/javascript/api/excel/excel.documenttaskschedule#excel-excel-documenttaskschedule-startdatetime-member)|Gets the date and time that the task should start.| +|[DoubleCellValue](/javascript/api/excel/excel.doublecellvalue)|[type](/javascript/api/excel/excel.doublecellvalue#excel-excel-doublecellvalue-type-member)|Represents the type of this cell value.| +|[EmailIdentity](/javascript/api/excel/excel.emailidentity)|[displayName](/javascript/api/excel/excel.emailidentity#excel-excel-emailidentity-displayname-member)|Represents the user's display name.| +||[email](/javascript/api/excel/excel.emailidentity#excel-excel-emailidentity-email-member)|Represents the user's email.| +||[id](/javascript/api/excel/excel.emailidentity#excel-excel-emailidentity-id-member)|Represents the user's unique ID.| +|[EntityArrayCardLayout](/javascript/api/excel/excel.entityarraycardlayout)|[arrayProperty](/javascript/api/excel/excel.entityarraycardlayout#excel-excel-entityarraycardlayout-arrayproperty-member)|Represents name of the property that contains the array shown in the card.| +||[columnsToReport](/javascript/api/excel/excel.entityarraycardlayout#excel-excel-entityarraycardlayout-columnstoreport-member)|Represents the count of columns which the card claims are in the array.| +||[displayName](/javascript/api/excel/excel.entityarraycardlayout#excel-excel-entityarraycardlayout-displayname-member)|Represents name of the property that contains the array shown in the card.| +||[firstRowIsHeader](/javascript/api/excel/excel.entityarraycardlayout#excel-excel-entityarraycardlayout-firstrowisheader-member)|Represents whether the first row of the array is treated as a header.| +||[layout](/javascript/api/excel/excel.entityarraycardlayout#excel-excel-entityarraycardlayout-layout-member)|Represents the type of this layout.| +||[rowsToReport](/javascript/api/excel/excel.entityarraycardlayout#excel-excel-entityarraycardlayout-rowstoreport-member)|Represents the count of rows which the card claims are in the array.| +|[EntityCardLayout](/javascript/api/excel/excel.entitycardlayout)|[layout](/javascript/api/excel/excel.entitycardlayout#excel-excel-entitycardlayout-layout-member)|Represents the type of this layout.| +|[ExternalCodeServiceObjectCellValue](/javascript/api/excel/excel.externalcodeserviceobjectcellvalue)|[Python_str](/javascript/api/excel/excel.externalcodeserviceobjectcellvalue#excel-excel-externalcodeserviceobjectcellvalue-python_str-member)|Represents the output of the `str()` function when used on this object.| +||[Python_type](/javascript/api/excel/excel.externalcodeserviceobjectcellvalue#excel-excel-externalcodeserviceobjectcellvalue-python_type-member)|Represents the full type name of this object.| +||[Python_typeName](/javascript/api/excel/excel.externalcodeserviceobjectcellvalue#excel-excel-externalcodeserviceobjectcellvalue-python_typename-member)|Represents the short type name of this object.| +||[basicType](/javascript/api/excel/excel.externalcodeserviceobjectcellvalue#excel-excel-externalcodeserviceobjectcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/javascript/api/excel/excel.externalcodeserviceobjectcellvalue#excel-excel-externalcodeserviceobjectcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[language](/javascript/api/excel/excel.externalcodeserviceobjectcellvalue#excel-excel-externalcodeserviceobjectcellvalue-language-member)|Represents the runtime language of this external code service.| +||[preview](/javascript/api/excel/excel.externalcodeserviceobjectcellvalue#excel-excel-externalcodeserviceobjectcellvalue-preview-member)|Represents the preview value shown in the cell.| +||[provider](/javascript/api/excel/excel.externalcodeserviceobjectcellvalue#excel-excel-externalcodeserviceobjectcellvalue-provider-member)|Represents information about the service that provided the data in this `ExternalCodeServiceObjectCellValue`.| +||[type](/javascript/api/excel/excel.externalcodeserviceobjectcellvalue#excel-excel-externalcodeserviceobjectcellvalue-type-member)|Represents the type of this cell value.| +|[Identity](/javascript/api/excel/excel.identity)|[displayName](/javascript/api/excel/excel.identity#excel-excel-identity-displayname-member)|Represents the user's display name.| +||[id](/javascript/api/excel/excel.identity#excel-excel-identity-id-member)|Represents the user's unique ID.| +|[LinkedDataType](/javascript/api/excel/excel.linkeddatatype)|[dataProvider](/javascript/api/excel/excel.linkeddatatype#excel-excel-linkeddatatype-dataprovider-member)|The name of the data provider for the linked data type.| +||[lastRefreshed](/javascript/api/excel/excel.linkeddatatype#excel-excel-linkeddatatype-lastrefreshed-member)|The local time-zone date and time since the workbook was opened when the linked data type was last refreshed.| +||[name](/javascript/api/excel/excel.linkeddatatype#excel-excel-linkeddatatype-name-member)|The name of the linked data type.| +||[periodicRefreshInterval](/javascript/api/excel/excel.linkeddatatype#excel-excel-linkeddatatype-periodicrefreshinterval-member)|The frequency, in seconds, at which the linked data type is refreshed if `refreshMode` is set to "Periodic".| +||[refreshMode](/javascript/api/excel/excel.linkeddatatype#excel-excel-linkeddatatype-refreshmode-member)|The mechanism by which the data for the linked data type is retrieved.| +||[requestRefresh()](/javascript/api/excel/excel.linkeddatatype#excel-excel-linkeddatatype-requestrefresh-member(1))|Makes a request to refresh the linked data type.| +||[requestSetRefreshMode(refreshMode: Excel.LinkedDataTypeRefreshMode)](/javascript/api/excel/excel.linkeddatatype#excel-excel-linkeddatatype-requestsetrefreshmode-member(1))|Makes a request to change the refresh mode for this linked data type.| +||[serviceId](/javascript/api/excel/excel.linkeddatatype#excel-excel-linkeddatatype-serviceid-member)|The unique ID of the linked data type.| +||[supportedRefreshModes](/javascript/api/excel/excel.linkeddatatype#excel-excel-linkeddatatype-supportedrefreshmodes-member)|Returns an array with all the refresh modes supported by the linked data type.| +|[LinkedDataTypeAddedEventArgs](/javascript/api/excel/excel.linkeddatatypeaddedeventargs)|[serviceId](/javascript/api/excel/excel.linkeddatatypeaddedeventargs#excel-excel-linkeddatatypeaddedeventargs-serviceid-member)|The unique ID of the new linked data type.| +||[source](/javascript/api/excel/excel.linkeddatatypeaddedeventargs#excel-excel-linkeddatatypeaddedeventargs-source-member)|Gets the source of the event.| +||[type](/javascript/api/excel/excel.linkeddatatypeaddedeventargs#excel-excel-linkeddatatypeaddedeventargs-type-member)|Gets the type of the event.| +|[LinkedDataTypeCollection](/javascript/api/excel/excel.linkeddatatypecollection)|[getCount()](/javascript/api/excel/excel.linkeddatatypecollection#excel-excel-linkeddatatypecollection-getcount-member(1))|Gets the number of linked data types in the collection.| +||[getItem(key: number)](/javascript/api/excel/excel.linkeddatatypecollection#excel-excel-linkeddatatypecollection-getitem-member(1))|Gets a linked data type by service ID.| +||[getItemAt(index: number)](/javascript/api/excel/excel.linkeddatatypecollection#excel-excel-linkeddatatypecollection-getitemat-member(1))|Gets a linked data type by its index in the collection.| +||[getItemOrNullObject(key: number)](/javascript/api/excel/excel.linkeddatatypecollection#excel-excel-linkeddatatypecollection-getitemornullobject-member(1))|Gets a linked data type by ID.| +||[items](/javascript/api/excel/excel.linkeddatatypecollection#excel-excel-linkeddatatypecollection-items-member)|Gets the loaded child items in this collection.| +||[requestRefreshAll()](/javascript/api/excel/excel.linkeddatatypecollection#excel-excel-linkeddatatypecollection-requestrefreshall-member(1))|Makes a request to refresh all the linked data types in the collection.| +|[LocalImage](/javascript/api/excel/excel.localimage)|[getBase64EncodedImageData(cacheUid: string)](/javascript/api/excel/excel.localimage#excel-excel-localimage-getbase64encodedimagedata-member(1))|Gets the Base64-encoded image data stored in the shared image cache with the cache unique identifier (UID).| +|[LocalImageCellValue](/javascript/api/excel/excel.localimagecellvalue)|[altText](/javascript/api/excel/excel.localimagecellvalue#excel-excel-localimagecellvalue-alttext-member)|Represents the alternate text used in accessibility scenarios to describe what the image represents.| +||[attribution](/javascript/api/excel/excel.localimagecellvalue#excel-excel-localimagecellvalue-attribution-member)|Represents attribution information to describe the source and license requirements for this image.| +||[basicType](/javascript/api/excel/excel.localimagecellvalue#excel-excel-localimagecellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/javascript/api/excel/excel.localimagecellvalue#excel-excel-localimagecellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[image](/javascript/api/excel/excel.localimagecellvalue#excel-excel-localimagecellvalue-image-member)|Represents the image itself, either cached or encoded.| +||[provider](/javascript/api/excel/excel.localimagecellvalue#excel-excel-localimagecellvalue-provider-member)|Represents information that describes the entity or individual who provided the image.| +||[type](/javascript/api/excel/excel.localimagecellvalue#excel-excel-localimagecellvalue-type-member)|Represents the type of this cell value.| +|[LocalImageCellValueCacheId](/javascript/api/excel/excel.localimagecellvaluecacheid)|[cachedUid](/javascript/api/excel/excel.localimagecellvaluecacheid#excel-excel-localimagecellvaluecacheid-cacheduid-member)|Represents the image's UID as it appears in the cache.| +|[NameErrorCellValue](/javascript/api/excel/excel.nameerrorcellvalue)|[errorSubType](/javascript/api/excel/excel.nameerrorcellvalue#excel-excel-nameerrorcellvalue-errorsubtype-member)|Represents the type of `NameErrorCellValue`.| +|[NamedSheetViewCollection](/javascript/api/excel/excel.namedsheetviewcollection)|[getItemOrNullObject(key: string)](/javascript/api/excel/excel.namedsheetviewcollection#excel-excel-namedsheetviewcollection-getitemornullobject-member(1))|Gets a sheet view using its name.| +|[NotAvailableErrorCellValue](/javascript/api/excel/excel.notavailableerrorcellvalue)|[errorSubType](/javascript/api/excel/excel.notavailableerrorcellvalue#excel-excel-notavailableerrorcellvalue-errorsubtype-member)|Represents the type of `NotAvailableErrorCellValue`.| +|[PivotLayout](/javascript/api/excel/excel.pivotlayout)|[getCell(dataHierarchy: DataPivotHierarchy \| string, rowItems: Array, columnItems: Array)](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-getcell-member(1))|Gets a unique cell in the PivotTable based on a data hierarchy and the row and column items of their respective hierarchies.| +||[pivotStyle](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-pivotstyle-member)|The style applied to the PivotTable.| +||[setStyle(style: string \| PivotTableStyle \| BuiltInPivotTableStyle)](/javascript/api/excel/excel.pivotlayout#excel-excel-pivotlayout-setstyle-member(1))|Sets the style applied to the PivotTable.| +|[PivotTable](/javascript/api/excel/excel.pivottable)|[autoRefresh](/javascript/api/excel/excel.pivottable#excel-excel-pivottable-autorefresh-member)|Specifies whether the PivotTable auto refreshes when the source data changes.| +|[PythonErrorCellValue](/javascript/api/excel/excel.pythonerrorcellvalue)|[basicType](/javascript/api/excel/excel.pythonerrorcellvalue#excel-excel-pythonerrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/javascript/api/excel/excel.pythonerrorcellvalue#excel-excel-pythonerrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[errorType](/javascript/api/excel/excel.pythonerrorcellvalue#excel-excel-pythonerrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| +||[type](/javascript/api/excel/excel.pythonerrorcellvalue#excel-excel-pythonerrorcellvalue-type-member)|Represents the type of this cell value.| +|[Query](/javascript/api/excel/excel.query)|[delete()](/javascript/api/excel/excel.query#excel-excel-query-delete-member(1))|Deletes the query and associated connection.| +||[refresh()](/javascript/api/excel/excel.query#excel-excel-query-refresh-member(1))|Refreshes the query.| +|[QueryCollection](/javascript/api/excel/excel.querycollection)|[refreshAll()](/javascript/api/excel/excel.querycollection#excel-excel-querycollection-refreshall-member(1))|Refresh all queries.| +|[Range](/javascript/api/excel/excel.range)|[togglePythonMarshalMode(marshalMode?: Excel.PythonMarshalMode)](/javascript/api/excel/excel.range#excel-excel-range-togglepythonmarshalmode-member(1))|Sets the marshaling mode of the Python in Excel formula =PY.| +|[RangeAreas](/javascript/api/excel/excel.rangeareas)||| +|[RefErrorCellValue](/javascript/api/excel/excel.referrorcellvalue)|[errorSubType](/javascript/api/excel/excel.referrorcellvalue#excel-excel-referrorcellvalue-errorsubtype-member)|Represents the type of `RefErrorCellValue`.| +|[RefreshModeChangedEventArgs](/javascript/api/excel/excel.refreshmodechangedeventargs)|[refreshMode](/javascript/api/excel/excel.refreshmodechangedeventargs#excel-excel-refreshmodechangedeventargs-refreshmode-member)|The linked data type refresh mode.| +||[serviceId](/javascript/api/excel/excel.refreshmodechangedeventargs#excel-excel-refreshmodechangedeventargs-serviceid-member)|The unique ID of the object whose refresh mode was changed.| +||[source](/javascript/api/excel/excel.refreshmodechangedeventargs#excel-excel-refreshmodechangedeventargs-source-member)|Gets the source of the event.| +||[type](/javascript/api/excel/excel.refreshmodechangedeventargs#excel-excel-refreshmodechangedeventargs-type-member)|Gets the type of the event.| +|[RefreshRequestCompletedEventArgs](/javascript/api/excel/excel.refreshrequestcompletedeventargs)|[refreshed](/javascript/api/excel/excel.refreshrequestcompletedeventargs#excel-excel-refreshrequestcompletedeventargs-refreshed-member)|Indicates if the request to refresh was successful.| +||[serviceId](/javascript/api/excel/excel.refreshrequestcompletedeventargs#excel-excel-refreshrequestcompletedeventargs-serviceid-member)|The unique ID of the object whose refresh request was completed.| +||[source](/javascript/api/excel/excel.refreshrequestcompletedeventargs#excel-excel-refreshrequestcompletedeventargs-source-member)|Gets the source of the event.| +||[type](/javascript/api/excel/excel.refreshrequestcompletedeventargs#excel-excel-refreshrequestcompletedeventargs-type-member)|Gets the type of the event.| +||[warnings](/javascript/api/excel/excel.refreshrequestcompletedeventargs#excel-excel-refreshrequestcompletedeventargs-warnings-member)|An array that contains any warnings generated from the refresh request.| +|[ShapeCollection](/javascript/api/excel/excel.shapecollection)|[addLocalImageReference(address: string)](/javascript/api/excel/excel.shapecollection#excel-excel-shapecollection-addlocalimagereference-member(1))|Creates a reference for the local image stored in the cell address and displays it as a floating shape over cells.| +||[addSvg(xml: string)](/javascript/api/excel/excel.shapecollection#excel-excel-shapecollection-addsvg-member(1))|Creates a scalable vector graphic (SVG) from an XML string and adds it to the worksheet.| +|[Slicer](/javascript/api/excel/excel.slicer)|[nameInFormula](/javascript/api/excel/excel.slicer#excel-excel-slicer-nameinformula-member)|Specifies the slicer name used in the formula.| +||[setStyle(style: string \| SlicerStyle \| BuiltInSlicerStyle)](/javascript/api/excel/excel.slicer#excel-excel-slicer-setstyle-member(1))|Sets the style applied to the slicer.| +||[slicerStyle](/javascript/api/excel/excel.slicer#excel-excel-slicer-slicerstyle-member)|The style applied to the slicer.| +|[StringCellValue](/javascript/api/excel/excel.stringcellvalue)|[type](/javascript/api/excel/excel.stringcellvalue#excel-excel-stringcellvalue-type-member)|Represents the type of this cell value.| +|[Table](/javascript/api/excel/excel.table)|[clearStyle()](/javascript/api/excel/excel.table#excel-excel-table-clearstyle-member(1))|Changes the table to use the default table style.| +||[onFiltered](/javascript/api/excel/excel.table#excel-excel-table-onfiltered-member)|Occurs when a filter is applied on a specific table.| +||[setStyle(style: string \| TableStyle \| BuiltInTableStyle)](/javascript/api/excel/excel.table#excel-excel-table-setstyle-member(1))|Sets the style applied to the table.| +||[tableStyle](/javascript/api/excel/excel.table#excel-excel-table-tablestyle-member)|The style applied to the table.| +|[TableCollection](/javascript/api/excel/excel.tablecollection)|[onFiltered](/javascript/api/excel/excel.tablecollection#excel-excel-tablecollection-onfiltered-member)|Occurs when a filter is applied on any table in a workbook, or a worksheet.| +|[TableFilteredEventArgs](/javascript/api/excel/excel.tablefilteredeventargs)|[tableId](/javascript/api/excel/excel.tablefilteredeventargs#excel-excel-tablefilteredeventargs-tableid-member)|Gets the ID of the table in which the filter is applied.| +||[type](/javascript/api/excel/excel.tablefilteredeventargs#excel-excel-tablefilteredeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/javascript/api/excel/excel.tablefilteredeventargs#excel-excel-tablefilteredeventargs-worksheetid-member)|Gets the ID of the worksheet which contains the table.| +|[TimeoutErrorCellValue](/javascript/api/excel/excel.timeouterrorcellvalue)|[basicType](/javascript/api/excel/excel.timeouterrorcellvalue#excel-excel-timeouterrorcellvalue-basictype-member)|Represents the value that would be returned by `Range.valueTypes` for a cell with this value.| +||[basicValue](/javascript/api/excel/excel.timeouterrorcellvalue#excel-excel-timeouterrorcellvalue-basicvalue-member)|Represents the value that would be returned by `Range.values` for a cell with this value.| +||[errorSubType](/javascript/api/excel/excel.timeouterrorcellvalue#excel-excel-timeouterrorcellvalue-errorsubtype-member)|Represents the type of `TimeoutErrorCellValue`.| +||[errorType](/javascript/api/excel/excel.timeouterrorcellvalue#excel-excel-timeouterrorcellvalue-errortype-member)|Represents the type of `ErrorCellValue`.| +||[type](/javascript/api/excel/excel.timeouterrorcellvalue#excel-excel-timeouterrorcellvalue-type-member)|Represents the type of this cell value.| +|[ValueErrorCellValue](/javascript/api/excel/excel.valueerrorcellvalue)|[errorSubType](/javascript/api/excel/excel.valueerrorcellvalue#excel-excel-valueerrorcellvalue-errorsubtype-member)|Represents the type of `ValueErrorCellValue`.| +|[Workbook](/javascript/api/excel/excel.workbook)|[enterPreviewMode()](/javascript/api/excel/excel.workbook#excel-excel-workbook-enterpreviewmode-member(1))|Enters Scratchpad Preview Mode for the workbook, showing changes suggested by Copilot to the user.| +||[exitPreviewMode(applyChanges: boolean)](/javascript/api/excel/excel.workbook#excel-excel-workbook-exitpreviewmode-member(1))|Exits Scratchpad Preview Mode for the workbook.| +||[externalCodeServiceTimeout](/javascript/api/excel/excel.workbook#excel-excel-workbook-externalcodeservicetimeout-member)|Specifies the maximum length of time, in seconds, allotted for a formula that depends on an external code service to complete.| +||[linkedDataTypes](/javascript/api/excel/excel.workbook#excel-excel-workbook-linkeddatatypes-member)|Returns a collection of linked data types that are part of the workbook.| +||[localImage](/javascript/api/excel/excel.workbook#excel-excel-workbook-localimage-member)|Returns the `LocalImage` object associated with the workbook.| +||[showPivotFieldList](/javascript/api/excel/excel.workbook#excel-excel-workbook-showpivotfieldlist-member)|Specifies whether the PivotTable's field list pane is shown at the workbook level.| +||[tasks](/javascript/api/excel/excel.workbook#excel-excel-workbook-tasks-member)|Returns a collection of tasks that are present in the workbook.| +||[use1904DateSystem](/javascript/api/excel/excel.workbook#excel-excel-workbook-use1904datesystem-member)|True if the workbook uses the 1904 date system.| +|[Worksheet](/javascript/api/excel/excel.worksheet)|[onFiltered](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-onfiltered-member)|Occurs when a filter is applied on a specific worksheet.| +||[tasks](/javascript/api/excel/excel.worksheet#excel-excel-worksheet-tasks-member)|Returns a collection of tasks that are present in the worksheet.| +|[WorksheetCollection](/javascript/api/excel/excel.worksheetcollection)|[addFromBase64(base64File: string, sheetNamesToInsert?: string[], positionType?: Excel.WorksheetPositionType, relativeTo?: Worksheet \| string)](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-addfrombase64-member(1))|Inserts the specified worksheets of a workbook into the current workbook.| +||[onFiltered](/javascript/api/excel/excel.worksheetcollection#excel-excel-worksheetcollection-onfiltered-member)|Occurs when any worksheet's filter is applied in the workbook.| +|[WorksheetFilteredEventArgs](/javascript/api/excel/excel.worksheetfilteredeventargs)|[type](/javascript/api/excel/excel.worksheetfilteredeventargs#excel-excel-worksheetfilteredeventargs-type-member)|Gets the type of the event.| +||[worksheetId](/javascript/api/excel/excel.worksheetfilteredeventargs#excel-excel-worksheetfilteredeventargs-worksheetid-member)|Gets the ID of the worksheet in which the filter is applied.| diff --git a/docs/includes/outlook-1_1.md b/docs/includes/outlook-1_1.md index 04ff4f3e18..1574fd5341 100644 --- a/docs/includes/outlook-1_1.md +++ b/docs/includes/outlook-1_1.md @@ -1,87 +1,87 @@ | Class | Fields | Description | |:---|:---|:---| -|[AppointmentCompose](/.appointmentcompose)|[addFileAttachmentAsync(uri: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-addfileattachmentasync-member(1))|Adds a file to a message or appointment as an attachment.| -||[addFileAttachmentAsync(uri: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-addfileattachmentasync-member(1))|Adds a file to a message or appointment as an attachment.| -||[addItemAttachmentAsync(itemId: any, attachmentName: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-additemattachmentasync-member(1))|Adds an Exchange item, such as a message, as an attachment to the message or appointment.| -||[addItemAttachmentAsync(itemId: any, attachmentName: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-additemattachmentasync-member(1))|Adds an Exchange item, such as a message, as an attachment to the message or appointment.| -||[body](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-body-member)|Gets an object that provides methods for manipulating the body of an item.| -||[loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void, userContext?: any)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-loadcustompropertiesasync-member(1))|Asynchronously loads custom properties for this add-in on the selected item.| -||[removeAttachmentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-removeattachmentasync-member(1))|Removes an attachment from a message or appointment.| -||[removeAttachmentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-removeattachmentasync-member(1))|Removes an attachment from a message or appointment.| -|[AppointmentForm](/.appointmentform)|[body](/.appointmentform#outlook-javascript/api/outlook/-appointmentform-body-member)|Gets an object that provides methods for manipulating the body of an item.| -|[AppointmentRead](/.appointmentread)|[body](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-body-member)|Gets an object that provides methods for manipulating the body of an item.| -||[dateTimeModified](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-datetimemodified-member)|Gets the date and time that an item was last modified.| -||[displayReplyAllForm(formData: string \| ReplyFormData)](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-displayreplyallform-member(1))|Displays a reply form that includes either the sender and all recipients of the selected message or the organizer and all attendees of the| -||[displayReplyForm(formData: string \| ReplyFormData)](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-displayreplyform-member(1))|Displays a reply form that includes only the sender of the selected message or the organizer of the selected appointment.| -||[getEntities()](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-getentities-member(1))|Gets the entities found in the selected item's body.| -||[getEntitiesByType(entityType: MailboxEnums.EntityType \| string)](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-getentitiesbytype-member(1))|Gets an array of all the entities of the specified entity type found in the selected item's body.| -||[getFilteredEntitiesByName(name: string)](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-getfilteredentitiesbyname-member(1))|Returns well-known entities in the selected item that pass the named filter defined in an add-in only manifest file.| -||[getRegExMatches()](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-getregexmatches-member(1))|Returns string values in the selected item that match the regular expressions defined in an add-in only manifest file.| -||[getRegExMatchesByName(name: string)](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-getregexmatchesbyname-member(1))|Returns string values in the selected item that match the named regular expression defined in an add-in only manifest file.| -||[loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void, userContext?: any)](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-loadcustompropertiesasync-member(1))|Asynchronously loads custom properties for this add-in on the selected item.| -|[AttachmentDetails](/.attachmentdetails)|[attachmentType](/.attachmentdetails#outlook-javascript/api/outlook/-attachmentdetails-attachmenttype-member)|Gets a value that indicates the attachment's type.| -||[contentType](/.attachmentdetails#outlook-javascript/api/outlook/-attachmentdetails-contenttype-member)|Gets the MIME content type of the attachment.| -||[id](/.attachmentdetails#outlook-javascript/api/outlook/-attachmentdetails-id-member)|Gets the Exchange attachment ID of the attachment.| -||[isInline](/.attachmentdetails#outlook-javascript/api/outlook/-attachmentdetails-isinline-member)|Gets a value that indicates whether the attachment appears as an image in the body of the item instead of in the attachment list.| -||[name](/.attachmentdetails#outlook-javascript/api/outlook/-attachmentdetails-name-member)|Gets the name of the attachment.| -||[size](/.attachmentdetails#outlook-javascript/api/outlook/-attachmentdetails-size-member)|Gets the size of the attachment in bytes.| -|[Body](/.body)|[getTypeAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/.body#outlook-javascript/api/outlook/-body-gettypeasync-member(1))|Gets a value that indicates whether the content is in HTML or text format.| -||[getTypeAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.body#outlook-javascript/api/outlook/-body-gettypeasync-member(1))|Gets a value that indicates whether the content is in HTML or text format.| -||[prependAsync(data: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.body#outlook-javascript/api/outlook/-body-prependasync-member(1))|Adds the specified content to the beginning of the item body.| -||[prependAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.body#outlook-javascript/api/outlook/-body-prependasync-member(1))|Adds the specified content to the beginning of the item body.| -||[setSelectedDataAsync(data: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.body#outlook-javascript/api/outlook/-body-setselecteddataasync-member(1))|Replaces the selection in the body with the specified text.| -||[setSelectedDataAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.body#outlook-javascript/api/outlook/-body-setselecteddataasync-member(1))|Replaces the selection in the body with the specified text.| -|[CustomProperties](/.customproperties)|[get(name: string)](/.customproperties#outlook-javascript/api/outlook/-customproperties-get-member(1))|Returns the value of the specified custom property.| -||[remove(name: string)](/.customproperties#outlook-javascript/api/outlook/-customproperties-remove-member(1))|Removes the specified property from the custom property collection.| -||[saveAsync(asyncContext?: any)](/.customproperties#outlook-javascript/api/outlook/-customproperties-saveasync-member(1))|Saves custom properties to a message or appointment.| -||[saveAsync(callback: (asyncResult: Office.AsyncResult) => void, asyncContext?: any)](/.customproperties#outlook-javascript/api/outlook/-customproperties-saveasync-member(1))|Saves custom properties to a message or appointment.| -||[set(name: string, value: string)](/.customproperties#outlook-javascript/api/outlook/-customproperties-set-member(1))|Sets the specified property to the specified value.| -|[Diagnostics](/.diagnostics)|[OWAView](/.diagnostics#outlook-javascript/api/outlook/-diagnostics-owaview-member)|Gets a string that represents the current view of Outlook on the web.| -||[hostName](/.diagnostics#outlook-javascript/api/outlook/-diagnostics-hostname-member)|Gets a string that represents the type of Outlook client.| -||[hostVersion](/.diagnostics#outlook-javascript/api/outlook/-diagnostics-hostversion-member)|Gets a string that represents the version of either the Outlook client or the Exchange Server (for example, "15.0.468.0").| -|[Location](/.location)|[getAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.location#outlook-javascript/api/outlook/-location-getasync-member(1))|Gets the location of an appointment.| -||[getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.location#outlook-javascript/api/outlook/-location-getasync-member(1))|Gets the location of an appointment.| -||[setAsync(location: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.location#outlook-javascript/api/outlook/-location-setasync-member(1))|Sets the location of an appointment.| -||[setAsync(location: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.location#outlook-javascript/api/outlook/-location-setasync-member(1))|Sets the location of an appointment.| -|[Mailbox](/.mailbox)|[displayAppointmentForm(itemId: string)](/.mailbox#outlook-javascript/api/outlook/-mailbox-displayappointmentform-member(1))|Displays an existing calendar appointment.| -||[displayMessageForm(itemId: string)](/.mailbox#outlook-javascript/api/outlook/-mailbox-displaymessageform-member(1))|Displays an existing message.| -||[displayNewAppointmentForm(parameters: AppointmentForm)](/.mailbox#outlook-javascript/api/outlook/-mailbox-displaynewappointmentform-member(1))|Displays a form for creating a new calendar appointment.| -||[ewsUrl](/.mailbox#outlook-javascript/api/outlook/-mailbox-ewsurl-member)|Gets the URL of the Exchange Web Services (EWS) endpoint for this email account.| -||[makeEwsRequestAsync(data: any, callback: (asyncResult: Office.AsyncResult) => void, userContext?: any)](/.mailbox#outlook-javascript/api/outlook/-mailbox-makeewsrequestasync-member(1))|Makes an asynchronous request to an Exchange Web Services (EWS) service on the Exchange server that hosts the user's mailbox.| -|[MessageCompose](/.messagecompose)|[addFileAttachmentAsync(uri: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-addfileattachmentasync-member(1))|Adds a file to a message or appointment as an attachment.| -||[addFileAttachmentAsync(uri: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-addfileattachmentasync-member(1))|Adds a file to a message or appointment as an attachment.| -||[addItemAttachmentAsync(itemId: any, attachmentName: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-additemattachmentasync-member(1))|Adds an Exchange item, such as a message, as an attachment to the message or appointment.| -||[addItemAttachmentAsync(itemId: any, attachmentName: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-additemattachmentasync-member(1))|Adds an Exchange item, such as a message, as an attachment to the message or appointment.| -||[bcc](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-bcc-member)|Gets an object that provides methods to get or update the recipients on the **Bcc** (blind carbon copy) line of a message.| -||[body](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-body-member)|Gets an object that provides methods for manipulating the body of an item.| -||[loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void, userContext?: any)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-loadcustompropertiesasync-member(1))|Asynchronously loads custom properties for this add-in on the selected item.| -||[removeAttachmentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-removeattachmentasync-member(1))|Removes an attachment from a message or appointment.| -||[removeAttachmentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-removeattachmentasync-member(1))|Removes an attachment from a message or appointment.| -|[MessageRead](/.messageread)|[body](/.messageread#outlook-javascript/api/outlook/-messageread-body-member)|Gets an object that provides methods for manipulating the body of an item.| -||[dateTimeModified](/.messageread#outlook-javascript/api/outlook/-messageread-datetimemodified-member)|Gets the date and time that an item was last modified.| -||[displayReplyAllForm(formData: string \| ReplyFormData)](/.messageread#outlook-javascript/api/outlook/-messageread-displayreplyallform-member(1))|Displays a reply form that includes either the sender and all recipients of the selected message or the organizer and all attendees of the| -||[displayReplyForm(formData: string \| ReplyFormData)](/.messageread#outlook-javascript/api/outlook/-messageread-displayreplyform-member(1))|Displays a reply form that includes only the sender of the selected message or the organizer of the selected appointment.| -||[getEntities()](/.messageread#outlook-javascript/api/outlook/-messageread-getentities-member(1))|Gets the entities found in the selected item's body.| -||[getEntitiesByType(entityType: MailboxEnums.EntityType \| string)](/.messageread#outlook-javascript/api/outlook/-messageread-getentitiesbytype-member(1))|Gets an array of all the entities of the specified entity type found in the selected item's body.| -||[getFilteredEntitiesByName(name: string)](/.messageread#outlook-javascript/api/outlook/-messageread-getfilteredentitiesbyname-member(1))|Returns well-known entities in the selected item that pass the named filter defined in an add-in only manifest file.| -||[getRegExMatches()](/.messageread#outlook-javascript/api/outlook/-messageread-getregexmatches-member(1))|Returns string values in the selected item that match the regular expressions defined in an add-in only manifest file.| -||[getRegExMatchesByName(name: string)](/.messageread#outlook-javascript/api/outlook/-messageread-getregexmatchesbyname-member(1))|Returns string values in the selected item that match the named regular expression defined in an add-in only manifest file.| -||[loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void, userContext?: any)](/.messageread#outlook-javascript/api/outlook/-messageread-loadcustompropertiesasync-member(1))|Asynchronously loads custom properties for this add-in on the selected item.| -|[Recipients](/.recipients)|[addAsync(recipients: Array, callback?: (asyncResult: Office.AsyncResult) => void)](/.recipients#outlook-javascript/api/outlook/-recipients-addasync-member(1))|Adds a recipient list to the existing recipients for an appointment or message.| -||[addAsync(recipients: Array, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.recipients#outlook-javascript/api/outlook/-recipients-addasync-member(1))|Adds a recipient list to the existing recipients for an appointment or message.| -||[getAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.recipients#outlook-javascript/api/outlook/-recipients-getasync-member(1))|Gets a recipient list for an appointment or message.| -||[getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.recipients#outlook-javascript/api/outlook/-recipients-getasync-member(1))|Gets a recipient list for an appointment or message.| -||[setAsync(recipients: Array, callback: (asyncResult: Office.AsyncResult) => void)](/.recipients#outlook-javascript/api/outlook/-recipients-setasync-member(1))|Sets a recipient list for an appointment or message.| -||[setAsync(recipients: Array, options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.recipients#outlook-javascript/api/outlook/-recipients-setasync-member(1))|Sets a recipient list for an appointment or message.| -|[RoamingSettings](/.roamingsettings)|[get(name: string)](/.roamingsettings#outlook-javascript/api/outlook/-roamingsettings-get-member(1))|Retrieves the specified setting.| -||[remove(name: string)](/.roamingsettings#outlook-javascript/api/outlook/-roamingsettings-remove-member(1))|Removes the specified setting.| -||[saveAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/.roamingsettings#outlook-javascript/api/outlook/-roamingsettings-saveasync-member(1))|Saves the settings.| -||[set(name: string, value: any)](/.roamingsettings#outlook-javascript/api/outlook/-roamingsettings-set-member(1))|Sets or creates the specified setting.| -|[Subject](/.subject)|[getAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.subject#outlook-javascript/api/outlook/-subject-getasync-member(1))|Gets the subject of an appointment or message.| -||[getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.subject#outlook-javascript/api/outlook/-subject-getasync-member(1))|Gets the subject of an appointment or message.| -||[setAsync(subject: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.subject#outlook-javascript/api/outlook/-subject-setasync-member(1))|Sets the subject of an appointment or message.| -||[setAsync(subject: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.subject#outlook-javascript/api/outlook/-subject-setasync-member(1))|Sets the subject of an appointment or message.| -|[Time](/.time)|[getAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.time#outlook-javascript/api/outlook/-time-getasync-member(1))|Gets the start or end time of an appointment.| -||[getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.time#outlook-javascript/api/outlook/-time-getasync-member(1))|Gets the start or end time of an appointment.| -||[setAsync(dateTime: Date, callback?: (asyncResult: Office.AsyncResult) => void)](/.time#outlook-javascript/api/outlook/-time-setasync-member(1))|Sets the start or end time of an appointment.| -||[setAsync(dateTime: Date, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.time#outlook-javascript/api/outlook/-time-setasync-member(1))|Sets the start or end time of an appointment.| +|[AppointmentCompose](/javascript/api/outlook/office.appointmentcompose)|[addFileAttachmentAsync(uri: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-addfileattachmentasync-member(1))|Adds a file to a message or appointment as an attachment.| +||[addFileAttachmentAsync(uri: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-addfileattachmentasync-member(1))|Adds a file to a message or appointment as an attachment.| +||[addItemAttachmentAsync(itemId: any, attachmentName: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-additemattachmentasync-member(1))|Adds an Exchange item, such as a message, as an attachment to the message or appointment.| +||[addItemAttachmentAsync(itemId: any, attachmentName: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-additemattachmentasync-member(1))|Adds an Exchange item, such as a message, as an attachment to the message or appointment.| +||[body](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-body-member)|Gets an object that provides methods for manipulating the body of an item.| +||[loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void, userContext?: any)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-loadcustompropertiesasync-member(1))|Asynchronously loads custom properties for this add-in on the selected item.| +||[removeAttachmentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-removeattachmentasync-member(1))|Removes an attachment from a message or appointment.| +||[removeAttachmentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-removeattachmentasync-member(1))|Removes an attachment from a message or appointment.| +|[AppointmentForm](/javascript/api/outlook/office.appointmentform)|[body](/javascript/api/outlook/office.appointmentform#outlook-office-appointmentform-body-member)|Gets an object that provides methods for manipulating the body of an item.| +|[AppointmentRead](/javascript/api/outlook/office.appointmentread)|[body](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-body-member)|Gets an object that provides methods for manipulating the body of an item.| +||[dateTimeModified](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-datetimemodified-member)|Gets the date and time that an item was last modified.| +||[displayReplyAllForm(formData: string \| ReplyFormData)](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-displayreplyallform-member(1))|Displays a reply form that includes either the sender and all recipients of the selected message or the organizer and all attendees of the| +||[displayReplyForm(formData: string \| ReplyFormData)](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-displayreplyform-member(1))|Displays a reply form that includes only the sender of the selected message or the organizer of the selected appointment.| +||[getEntities()](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-getentities-member(1))|Gets the entities found in the selected item's body.| +||[getEntitiesByType(entityType: MailboxEnums.EntityType \| string)](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-getentitiesbytype-member(1))|Gets an array of all the entities of the specified entity type found in the selected item's body.| +||[getFilteredEntitiesByName(name: string)](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-getfilteredentitiesbyname-member(1))|Returns well-known entities in the selected item that pass the named filter defined in an add-in only manifest file.| +||[getRegExMatches()](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-getregexmatches-member(1))|Returns string values in the selected item that match the regular expressions defined in an add-in only manifest file.| +||[getRegExMatchesByName(name: string)](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-getregexmatchesbyname-member(1))|Returns string values in the selected item that match the named regular expression defined in an add-in only manifest file.| +||[loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void, userContext?: any)](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-loadcustompropertiesasync-member(1))|Asynchronously loads custom properties for this add-in on the selected item.| +|[AttachmentDetails](/javascript/api/outlook/office.attachmentdetails)|[attachmentType](/javascript/api/outlook/office.attachmentdetails#outlook-office-attachmentdetails-attachmenttype-member)|Gets a value that indicates the attachment's type.| +||[contentType](/javascript/api/outlook/office.attachmentdetails#outlook-office-attachmentdetails-contenttype-member)|Gets the MIME content type of the attachment.| +||[id](/javascript/api/outlook/office.attachmentdetails#outlook-office-attachmentdetails-id-member)|Gets the Exchange attachment ID of the attachment.| +||[isInline](/javascript/api/outlook/office.attachmentdetails#outlook-office-attachmentdetails-isinline-member)|Gets a value that indicates whether the attachment appears as an image in the body of the item instead of in the attachment list.| +||[name](/javascript/api/outlook/office.attachmentdetails#outlook-office-attachmentdetails-name-member)|Gets the name of the attachment.| +||[size](/javascript/api/outlook/office.attachmentdetails#outlook-office-attachmentdetails-size-member)|Gets the size of the attachment in bytes.| +|[Body](/javascript/api/outlook/office.body)|[getTypeAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.body#outlook-office-body-gettypeasync-member(1))|Gets a value that indicates whether the content is in HTML or text format.| +||[getTypeAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.body#outlook-office-body-gettypeasync-member(1))|Gets a value that indicates whether the content is in HTML or text format.| +||[prependAsync(data: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.body#outlook-office-body-prependasync-member(1))|Adds the specified content to the beginning of the item body.| +||[prependAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.body#outlook-office-body-prependasync-member(1))|Adds the specified content to the beginning of the item body.| +||[setSelectedDataAsync(data: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.body#outlook-office-body-setselecteddataasync-member(1))|Replaces the selection in the body with the specified text.| +||[setSelectedDataAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.body#outlook-office-body-setselecteddataasync-member(1))|Replaces the selection in the body with the specified text.| +|[CustomProperties](/javascript/api/outlook/office.customproperties)|[get(name: string)](/javascript/api/outlook/office.customproperties#outlook-office-customproperties-get-member(1))|Returns the value of the specified custom property.| +||[remove(name: string)](/javascript/api/outlook/office.customproperties#outlook-office-customproperties-remove-member(1))|Removes the specified property from the custom property collection.| +||[saveAsync(asyncContext?: any)](/javascript/api/outlook/office.customproperties#outlook-office-customproperties-saveasync-member(1))|Saves custom properties to a message or appointment.| +||[saveAsync(callback: (asyncResult: Office.AsyncResult) => void, asyncContext?: any)](/javascript/api/outlook/office.customproperties#outlook-office-customproperties-saveasync-member(1))|Saves custom properties to a message or appointment.| +||[set(name: string, value: string)](/javascript/api/outlook/office.customproperties#outlook-office-customproperties-set-member(1))|Sets the specified property to the specified value.| +|[Diagnostics](/javascript/api/outlook/office.diagnostics)|[OWAView](/javascript/api/outlook/office.diagnostics#outlook-office-diagnostics-owaview-member)|Gets a string that represents the current view of Outlook on the web.| +||[hostName](/javascript/api/outlook/office.diagnostics#outlook-office-diagnostics-hostname-member)|Gets a string that represents the type of Outlook client.| +||[hostVersion](/javascript/api/outlook/office.diagnostics#outlook-office-diagnostics-hostversion-member)|Gets a string that represents the version of either the Outlook client or the Exchange Server (for example, "15.0.468.0").| +|[Location](/javascript/api/outlook/office.location)|[getAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.location#outlook-office-location-getasync-member(1))|Gets the location of an appointment.| +||[getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.location#outlook-office-location-getasync-member(1))|Gets the location of an appointment.| +||[setAsync(location: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.location#outlook-office-location-setasync-member(1))|Sets the location of an appointment.| +||[setAsync(location: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.location#outlook-office-location-setasync-member(1))|Sets the location of an appointment.| +|[Mailbox](/javascript/api/outlook/office.mailbox)|[displayAppointmentForm(itemId: string)](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-displayappointmentform-member(1))|Displays an existing calendar appointment.| +||[displayMessageForm(itemId: string)](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-displaymessageform-member(1))|Displays an existing message.| +||[displayNewAppointmentForm(parameters: AppointmentForm)](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-displaynewappointmentform-member(1))|Displays a form for creating a new calendar appointment.| +||[ewsUrl](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-ewsurl-member)|Gets the URL of the Exchange Web Services (EWS) endpoint for this email account.| +||[makeEwsRequestAsync(data: any, callback: (asyncResult: Office.AsyncResult) => void, userContext?: any)](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-makeewsrequestasync-member(1))|Makes an asynchronous request to an Exchange Web Services (EWS) service on the Exchange server that hosts the user's mailbox.| +|[MessageCompose](/javascript/api/outlook/office.messagecompose)|[addFileAttachmentAsync(uri: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-addfileattachmentasync-member(1))|Adds a file to a message or appointment as an attachment.| +||[addFileAttachmentAsync(uri: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-addfileattachmentasync-member(1))|Adds a file to a message or appointment as an attachment.| +||[addItemAttachmentAsync(itemId: any, attachmentName: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-additemattachmentasync-member(1))|Adds an Exchange item, such as a message, as an attachment to the message or appointment.| +||[addItemAttachmentAsync(itemId: any, attachmentName: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-additemattachmentasync-member(1))|Adds an Exchange item, such as a message, as an attachment to the message or appointment.| +||[bcc](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-bcc-member)|Gets an object that provides methods to get or update the recipients on the **Bcc** (blind carbon copy) line of a message.| +||[body](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-body-member)|Gets an object that provides methods for manipulating the body of an item.| +||[loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void, userContext?: any)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-loadcustompropertiesasync-member(1))|Asynchronously loads custom properties for this add-in on the selected item.| +||[removeAttachmentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-removeattachmentasync-member(1))|Removes an attachment from a message or appointment.| +||[removeAttachmentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-removeattachmentasync-member(1))|Removes an attachment from a message or appointment.| +|[MessageRead](/javascript/api/outlook/office.messageread)|[body](/javascript/api/outlook/office.messageread#outlook-office-messageread-body-member)|Gets an object that provides methods for manipulating the body of an item.| +||[dateTimeModified](/javascript/api/outlook/office.messageread#outlook-office-messageread-datetimemodified-member)|Gets the date and time that an item was last modified.| +||[displayReplyAllForm(formData: string \| ReplyFormData)](/javascript/api/outlook/office.messageread#outlook-office-messageread-displayreplyallform-member(1))|Displays a reply form that includes either the sender and all recipients of the selected message or the organizer and all attendees of the| +||[displayReplyForm(formData: string \| ReplyFormData)](/javascript/api/outlook/office.messageread#outlook-office-messageread-displayreplyform-member(1))|Displays a reply form that includes only the sender of the selected message or the organizer of the selected appointment.| +||[getEntities()](/javascript/api/outlook/office.messageread#outlook-office-messageread-getentities-member(1))|Gets the entities found in the selected item's body.| +||[getEntitiesByType(entityType: MailboxEnums.EntityType \| string)](/javascript/api/outlook/office.messageread#outlook-office-messageread-getentitiesbytype-member(1))|Gets an array of all the entities of the specified entity type found in the selected item's body.| +||[getFilteredEntitiesByName(name: string)](/javascript/api/outlook/office.messageread#outlook-office-messageread-getfilteredentitiesbyname-member(1))|Returns well-known entities in the selected item that pass the named filter defined in an add-in only manifest file.| +||[getRegExMatches()](/javascript/api/outlook/office.messageread#outlook-office-messageread-getregexmatches-member(1))|Returns string values in the selected item that match the regular expressions defined in an add-in only manifest file.| +||[getRegExMatchesByName(name: string)](/javascript/api/outlook/office.messageread#outlook-office-messageread-getregexmatchesbyname-member(1))|Returns string values in the selected item that match the named regular expression defined in an add-in only manifest file.| +||[loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void, userContext?: any)](/javascript/api/outlook/office.messageread#outlook-office-messageread-loadcustompropertiesasync-member(1))|Asynchronously loads custom properties for this add-in on the selected item.| +|[Recipients](/javascript/api/outlook/office.recipients)|[addAsync(recipients: Array, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.recipients#outlook-office-recipients-addasync-member(1))|Adds a recipient list to the existing recipients for an appointment or message.| +||[addAsync(recipients: Array, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.recipients#outlook-office-recipients-addasync-member(1))|Adds a recipient list to the existing recipients for an appointment or message.| +||[getAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.recipients#outlook-office-recipients-getasync-member(1))|Gets a recipient list for an appointment or message.| +||[getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.recipients#outlook-office-recipients-getasync-member(1))|Gets a recipient list for an appointment or message.| +||[setAsync(recipients: Array, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.recipients#outlook-office-recipients-setasync-member(1))|Sets a recipient list for an appointment or message.| +||[setAsync(recipients: Array, options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.recipients#outlook-office-recipients-setasync-member(1))|Sets a recipient list for an appointment or message.| +|[RoamingSettings](/javascript/api/outlook/office.roamingsettings)|[get(name: string)](/javascript/api/outlook/office.roamingsettings#outlook-office-roamingsettings-get-member(1))|Retrieves the specified setting.| +||[remove(name: string)](/javascript/api/outlook/office.roamingsettings#outlook-office-roamingsettings-remove-member(1))|Removes the specified setting.| +||[saveAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.roamingsettings#outlook-office-roamingsettings-saveasync-member(1))|Saves the settings.| +||[set(name: string, value: any)](/javascript/api/outlook/office.roamingsettings#outlook-office-roamingsettings-set-member(1))|Sets or creates the specified setting.| +|[Subject](/javascript/api/outlook/office.subject)|[getAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.subject#outlook-office-subject-getasync-member(1))|Gets the subject of an appointment or message.| +||[getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.subject#outlook-office-subject-getasync-member(1))|Gets the subject of an appointment or message.| +||[setAsync(subject: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.subject#outlook-office-subject-setasync-member(1))|Sets the subject of an appointment or message.| +||[setAsync(subject: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.subject#outlook-office-subject-setasync-member(1))|Sets the subject of an appointment or message.| +|[Time](/javascript/api/outlook/office.time)|[getAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.time#outlook-office-time-getasync-member(1))|Gets the start or end time of an appointment.| +||[getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.time#outlook-office-time-getasync-member(1))|Gets the start or end time of an appointment.| +||[setAsync(dateTime: Date, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.time#outlook-office-time-setasync-member(1))|Sets the start or end time of an appointment.| +||[setAsync(dateTime: Date, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.time#outlook-office-time-setasync-member(1))|Sets the start or end time of an appointment.| diff --git a/docs/includes/outlook-1_10.md b/docs/includes/outlook-1_10.md index ef0476bab2..ac7bca22cb 100644 --- a/docs/includes/outlook-1_10.md +++ b/docs/includes/outlook-1_10.md @@ -1,24 +1,24 @@ | Class | Fields | Description | |:---|:---|:---| -|[AppointmentCompose](/.appointmentcompose)|[disableClientSignatureAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-disableclientsignatureasync-member(1))|Disables the Outlook client signature.| -||[disableClientSignatureAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-disableclientsignatureasync-member(1))|Disables the Outlook client signature.| -||[isClientSignatureEnabledAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-isclientsignatureenabledasync-member(1))|Gets if the client signature is enabled.| -||[isClientSignatureEnabledAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-isclientsignatureenabledasync-member(1))|Gets if the client signature is enabled.| -|[Body](/.body)|[setSignatureAsync(data: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.body#outlook-javascript/api/outlook/-body-setsignatureasync-member(1))|Adds a signature to the item body if it doesn't have an existing signature.| -||[setSignatureAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.body#outlook-javascript/api/outlook/-body-setsignatureasync-member(1))|Adds a signature to the item body if it doesn't have an existing signature.| -|[InfobarClickedEventArgs](/.infobarclickedeventargs)|[infobarDetails](/.infobarclickedeventargs#outlook-javascript/api/outlook/-infobarclickedeventargs-infobardetails-member)|Gets additional details about the notification message.| -||[type](/.infobarclickedeventargs#outlook-javascript/api/outlook/-infobarclickedeventargs-type-member)|Gets the type of the event.| -|[InfobarDetails](/.infobardetails)|[actionType](/.infobardetails#outlook-javascript/api/outlook/-infobardetails-actiontype-member)|The action type.| -||[infobarType](/.infobardetails#outlook-javascript/api/outlook/-infobardetails-infobartype-member)|The notification type.| -|[MailboxEvent](/.mailboxevent)|[completed()](/.mailboxevent#outlook-javascript/api/outlook/-mailboxevent-completed-member(1))|Indicates that the event-based or spam-reporting add-in has completed processing an event.| -|[MessageCompose](/.messagecompose)|[disableClientSignatureAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-disableclientsignatureasync-member(1))|Disables the Outlook client signature.| -||[disableClientSignatureAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-disableclientsignatureasync-member(1))|Disables the Outlook client signature.| -||[getComposeTypeAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-getcomposetypeasync-member(1))|Specifies the type of message compose and its coercion type.| -||[getComposeTypeAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-getcomposetypeasync-member(1))|Specifies the type of message compose and its coercion type.| -||[isClientSignatureEnabledAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-isclientsignatureenabledasync-member(1))|Gets if the client signature is enabled.| -||[isClientSignatureEnabledAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-isclientsignatureenabledasync-member(1))|Gets if the client signature is enabled.| -|[NotificationMessageAction](/.notificationmessageaction)|[actionText](/.notificationmessageaction#outlook-javascript/api/outlook/-notificationmessageaction-actiontext-member)|The text of the action link.| -||[actionType](/.notificationmessageaction#outlook-javascript/api/outlook/-notificationmessageaction-actiontype-member)|The type of action to be performed.| -||[commandId](/.notificationmessageaction#outlook-javascript/api/outlook/-notificationmessageaction-commandid-member)|The button defined in the manifest.| -||[contextData](/.notificationmessageaction#outlook-javascript/api/outlook/-notificationmessageaction-contextdata-member)|Any JSON data the action button needs to pass on to the add-in.| -|[NotificationMessageDetails](/.notificationmessagedetails)|[actions](/.notificationmessagedetails#outlook-javascript/api/outlook/-notificationmessagedetails-actions-member)|Specifies actions for the message.| +|[AppointmentCompose](/javascript/api/outlook/office.appointmentcompose)|[disableClientSignatureAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-disableclientsignatureasync-member(1))|Disables the Outlook client signature.| +||[disableClientSignatureAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-disableclientsignatureasync-member(1))|Disables the Outlook client signature.| +||[isClientSignatureEnabledAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-isclientsignatureenabledasync-member(1))|Gets if the client signature is enabled.| +||[isClientSignatureEnabledAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-isclientsignatureenabledasync-member(1))|Gets if the client signature is enabled.| +|[Body](/javascript/api/outlook/office.body)|[setSignatureAsync(data: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.body#outlook-office-body-setsignatureasync-member(1))|Adds a signature to the item body if it doesn't have an existing signature.| +||[setSignatureAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.body#outlook-office-body-setsignatureasync-member(1))|Adds a signature to the item body if it doesn't have an existing signature.| +|[InfobarClickedEventArgs](/javascript/api/outlook/office.infobarclickedeventargs)|[infobarDetails](/javascript/api/outlook/office.infobarclickedeventargs#outlook-office-infobarclickedeventargs-infobardetails-member)|Gets additional details about the notification message.| +||[type](/javascript/api/outlook/office.infobarclickedeventargs#outlook-office-infobarclickedeventargs-type-member)|Gets the type of the event.| +|[InfobarDetails](/javascript/api/outlook/office.infobardetails)|[actionType](/javascript/api/outlook/office.infobardetails#outlook-office-infobardetails-actiontype-member)|The action type.| +||[infobarType](/javascript/api/outlook/office.infobardetails#outlook-office-infobardetails-infobartype-member)|The notification type.| +|[MailboxEvent](/javascript/api/outlook/office.mailboxevent)|[completed()](/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1))|Indicates that the event-based or spam-reporting add-in has completed processing an event.| +|[MessageCompose](/javascript/api/outlook/office.messagecompose)|[disableClientSignatureAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-disableclientsignatureasync-member(1))|Disables the Outlook client signature.| +||[disableClientSignatureAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-disableclientsignatureasync-member(1))|Disables the Outlook client signature.| +||[getComposeTypeAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-getcomposetypeasync-member(1))|Specifies the type of message compose and its coercion type.| +||[getComposeTypeAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-getcomposetypeasync-member(1))|Specifies the type of message compose and its coercion type.| +||[isClientSignatureEnabledAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-isclientsignatureenabledasync-member(1))|Gets if the client signature is enabled.| +||[isClientSignatureEnabledAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-isclientsignatureenabledasync-member(1))|Gets if the client signature is enabled.| +|[NotificationMessageAction](/javascript/api/outlook/office.notificationmessageaction)|[actionText](/javascript/api/outlook/office.notificationmessageaction#outlook-office-notificationmessageaction-actiontext-member)|The text of the action link.| +||[actionType](/javascript/api/outlook/office.notificationmessageaction#outlook-office-notificationmessageaction-actiontype-member)|The type of action to be performed.| +||[commandId](/javascript/api/outlook/office.notificationmessageaction#outlook-office-notificationmessageaction-commandid-member)|The button defined in the manifest.| +||[contextData](/javascript/api/outlook/office.notificationmessageaction#outlook-office-notificationmessageaction-contextdata-member)|Any JSON data the action button needs to pass on to the add-in.| +|[NotificationMessageDetails](/javascript/api/outlook/office.notificationmessagedetails)|[actions](/javascript/api/outlook/office.notificationmessagedetails#outlook-office-notificationmessagedetails-actions-member)|Specifies actions for the message.| diff --git a/docs/includes/outlook-1_11.md b/docs/includes/outlook-1_11.md index 4d0067cde3..ac41ab41af 100644 --- a/docs/includes/outlook-1_11.md +++ b/docs/includes/outlook-1_11.md @@ -1,12 +1,12 @@ | Class | Fields | Description | |:---|:---|:---| -|[AppointmentCompose](/.appointmentcompose)|[sessionData](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-sessiondata-member)|Manages the {@link Office.SessionData | SessionData} of an item in Compose mode.| -|[MessageCompose](/.messagecompose)|[sessionData](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-sessiondata-member)|Manages the {@link Office.SessionData | SessionData} of an item in Compose mode.| -|[SessionData](/.sessiondata)|[clearAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/.sessiondata#outlook-javascript/api/outlook/-sessiondata-clearasync-member(1))|Clears all session data key-value pairs.| -||[clearAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.sessiondata#outlook-javascript/api/outlook/-sessiondata-clearasync-member(1))|Clears all session data key-value pairs.| -||[getAllAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.sessiondata#outlook-javascript/api/outlook/-sessiondata-getallasync-member(1))|Gets all session data key-value pairs.| -||[getAsync(name: string, callback: (asyncResult: Office.AsyncResult) => void)](/.sessiondata#outlook-javascript/api/outlook/-sessiondata-getasync-member(1))|Gets the session data value of the specified key.| -||[removeAsync(name: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.sessiondata#outlook-javascript/api/outlook/-sessiondata-removeasync-member(1))|Removes a session data key-value pair.| -||[removeAsync(name: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.sessiondata#outlook-javascript/api/outlook/-sessiondata-removeasync-member(1))|Removes a session data key-value pair.| -||[setAsync(name: string, value: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.sessiondata#outlook-javascript/api/outlook/-sessiondata-setasync-member(1))|Sets a session data key-value pair.| -||[setAsync(name: string, value: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.sessiondata#outlook-javascript/api/outlook/-sessiondata-setasync-member(1))|Sets a session data key-value pair.| +|[AppointmentCompose](/javascript/api/outlook/office.appointmentcompose)|[sessionData](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-sessiondata-member)|Manages the {@link Office.SessionData | SessionData} of an item in Compose mode.| +|[MessageCompose](/javascript/api/outlook/office.messagecompose)|[sessionData](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-sessiondata-member)|Manages the {@link Office.SessionData | SessionData} of an item in Compose mode.| +|[SessionData](/javascript/api/outlook/office.sessiondata)|[clearAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.sessiondata#outlook-office-sessiondata-clearasync-member(1))|Clears all session data key-value pairs.| +||[clearAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.sessiondata#outlook-office-sessiondata-clearasync-member(1))|Clears all session data key-value pairs.| +||[getAllAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.sessiondata#outlook-office-sessiondata-getallasync-member(1))|Gets all session data key-value pairs.| +||[getAsync(name: string, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.sessiondata#outlook-office-sessiondata-getasync-member(1))|Gets the session data value of the specified key.| +||[removeAsync(name: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.sessiondata#outlook-office-sessiondata-removeasync-member(1))|Removes a session data key-value pair.| +||[removeAsync(name: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.sessiondata#outlook-office-sessiondata-removeasync-member(1))|Removes a session data key-value pair.| +||[setAsync(name: string, value: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.sessiondata#outlook-office-sessiondata-setasync-member(1))|Sets a session data key-value pair.| +||[setAsync(name: string, value: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.sessiondata#outlook-office-sessiondata-setasync-member(1))|Sets a session data key-value pair.| diff --git a/docs/includes/outlook-1_12.md b/docs/includes/outlook-1_12.md index 851c987e27..4cd63cc5a2 100644 --- a/docs/includes/outlook-1_12.md +++ b/docs/includes/outlook-1_12.md @@ -1,5 +1,5 @@ | Class | Fields | Description | |:---|:---|:---| -|[MailboxEvent](/.mailboxevent)|[completed(options?: SmartAlertsEventCompletedOptions)](/.mailboxevent#outlook-javascript/api/outlook/-mailboxevent-completed-member(1))|Indicates that the event-based or spam-reporting add-in has completed processing an event.| -|[SmartAlertsEventCompletedOptions](/.smartalertseventcompletedoptions)|[allowEvent](/.smartalertseventcompletedoptions#outlook-javascript/api/outlook/-smartalertseventcompletedoptions-allowevent-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal completion of an event handler,| -||[errorMessage](/.smartalertseventcompletedoptions#outlook-javascript/api/outlook/-smartalertseventcompletedoptions-errormessage-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal completion of an event handler and set its `allowEvent` property| +|[MailboxEvent](/javascript/api/outlook/office.mailboxevent)|[completed(options?: SmartAlertsEventCompletedOptions)](/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1))|Indicates that the event-based or spam-reporting add-in has completed processing an event.| +|[SmartAlertsEventCompletedOptions](/javascript/api/outlook/office.smartalertseventcompletedoptions)|[allowEvent](/javascript/api/outlook/office.smartalertseventcompletedoptions#outlook-office-smartalertseventcompletedoptions-allowevent-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal completion of an event handler,| +||[errorMessage](/javascript/api/outlook/office.smartalertseventcompletedoptions#outlook-office-smartalertseventcompletedoptions-errormessage-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal completion of an event handler and set its `allowEvent` property| diff --git a/docs/includes/outlook-1_13.md b/docs/includes/outlook-1_13.md index 3edf1ec1fd..73151965de 100644 --- a/docs/includes/outlook-1_13.md +++ b/docs/includes/outlook-1_13.md @@ -1,31 +1,31 @@ | Class | Fields | Description | |:---|:---|:---| -|[AppointmentCompose](/.appointmentcompose)|[sensitivityLabel](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-sensitivitylabel-member)|Gets the object to get or set the {@link Office.SensitivityLabel | sensitivity label} of an appointment.| -|[Body](/.body)|[prependOnSendAsync(data: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.body#outlook-javascript/api/outlook/-body-prependonsendasync-member(1))|Prepends HTML or plain text to the beginning of a message or appointment body when the mail item is sent.| -||[prependOnSendAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.body#outlook-javascript/api/outlook/-body-prependonsendasync-member(1))|Prepends HTML or plain text to the beginning of a message or appointment body when the mail item is sent.| -|[DelayDeliveryTime](/.delaydeliverytime)|[getAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/.delaydeliverytime#outlook-javascript/api/outlook/-delaydeliverytime-getasync-member(1))|Gets the delivery date and time of a message.| -||[getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.delaydeliverytime#outlook-javascript/api/outlook/-delaydeliverytime-getasync-member(1))|Gets the delivery date and time of a message.| -||[setAsync(datetime: Date, callback?: (asyncResult: Office.AsyncResult) => void)](/.delaydeliverytime#outlook-javascript/api/outlook/-delaydeliverytime-setasync-member(1))|Sets the delivery date and time of a message.| -||[setAsync(datetime: Date, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.delaydeliverytime#outlook-javascript/api/outlook/-delaydeliverytime-setasync-member(1))|Sets the delivery date and time of a message.| -|[Mailbox](/.mailbox)|[getSelectedItemsAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.mailbox#outlook-javascript/api/outlook/-mailbox-getselecteditemsasync-member(1))|Gets currently selected messages on which an add-in can activate and perform operations.| -||[getSelectedItemsAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.mailbox#outlook-javascript/api/outlook/-mailbox-getselecteditemsasync-member(1))|Gets currently selected messages on which an add-in can activate and perform operations.| -|[MessageCompose](/.messagecompose)|[delayDeliveryTime](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-delaydeliverytime-member)|Gets or sets the delayed delivery date and time of a message.| -||[sensitivityLabel](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-sensitivitylabel-member)|Gets the object to get or set the {@link Office.SensitivityLabel | sensitivity label} of a message.| -|[SelectedItemDetails](/.selecteditemdetails)|[itemId](/.selecteditemdetails#outlook-javascript/api/outlook/-selecteditemdetails-itemid-member)|The Exchange Web Services (EWS) item identifier of the message that's currently selected.| -||[itemMode](/.selecteditemdetails#outlook-javascript/api/outlook/-selecteditemdetails-itemmode-member)|The Outlook mode (`Read` or `Compose`) of the message that's currently selected.| -||[itemType](/.selecteditemdetails#outlook-javascript/api/outlook/-selecteditemdetails-itemtype-member)|The type of the item that's currently selected.| -||[subject](/.selecteditemdetails#outlook-javascript/api/outlook/-selecteditemdetails-subject-member)|The description that appears in the subject field of the message that's currently selected.| -|[SensitivityLabel](/.sensitivitylabel)|[getAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.sensitivitylabel#outlook-javascript/api/outlook/-sensitivitylabel-getasync-member(1))|Gets the unique identifier (GUID) of the sensitivity label applied to a message or appointment being composed.| -||[getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.sensitivitylabel#outlook-javascript/api/outlook/-sensitivitylabel-getasync-member(1))|Gets the unique identifier (GUID) of the sensitivity label applied to a message or appointment being composed.| -||[setAsync(sensitivityLabel: string \| SensitivityLabelDetails, callback?: (asyncResult: Office.AsyncResult) => void)](/.sensitivitylabel#outlook-javascript/api/outlook/-sensitivitylabel-setasync-member(1))|Applies the specified sensitivity label to the message or appointment being composed.| -||[setAsync(sensitivityLabel: string \| SensitivityLabelDetails, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.sensitivitylabel#outlook-javascript/api/outlook/-sensitivitylabel-setasync-member(1))|Applies the specified sensitivity label to the message or appointment being composed.| -|[SensitivityLabelChangedEventArgs](/.sensitivitylabelchangedeventargs)|[type](/.sensitivitylabelchangedeventargs#outlook-javascript/api/outlook/-sensitivitylabelchangedeventargs-type-member)|The type of event that was raised.| -|[SensitivityLabelDetails](/.sensitivitylabeldetails)|[children](/.sensitivitylabeldetails#outlook-javascript/api/outlook/-sensitivitylabeldetails-children-member)|The {@link https://learn.microsoft.com/microsoft-365/compliance/sensitivity-labels#sublabels-grouping-labels | sublabels} of the sensitivity label.| -||[color](/.sensitivitylabeldetails#outlook-javascript/api/outlook/-sensitivitylabeldetails-color-member)|The color of the sensitivity label.| -||[id](/.sensitivitylabeldetails#outlook-javascript/api/outlook/-sensitivitylabeldetails-id-member)|The unique identifier (GUID) of the sensitivity label.| -||[name](/.sensitivitylabeldetails#outlook-javascript/api/outlook/-sensitivitylabeldetails-name-member)|The name of the sensitivity label.| -||[tooltip](/.sensitivitylabeldetails#outlook-javascript/api/outlook/-sensitivitylabeldetails-tooltip-member)|The description of the sensitivity label.| -|[SensitivityLabelsCatalog](/.sensitivitylabelscatalog)|[getAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.sensitivitylabelscatalog#outlook-javascript/api/outlook/-sensitivitylabelscatalog-getasync-member(1))|Gets all the sensitivity labels that are enabled in Outlook.| -||[getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.sensitivitylabelscatalog#outlook-javascript/api/outlook/-sensitivitylabelscatalog-getasync-member(1))|Gets all the sensitivity labels that are enabled in Outlook.| -||[getIsEnabledAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.sensitivitylabelscatalog#outlook-javascript/api/outlook/-sensitivitylabelscatalog-getisenabledasync-member(1))|Checks whether the catalog of sensitivity labels is enabled in Outlook.| -||[getIsEnabledAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.sensitivitylabelscatalog#outlook-javascript/api/outlook/-sensitivitylabelscatalog-getisenabledasync-member(1))|Checks whether the catalog of sensitivity labels is enabled in Outlook.| +|[AppointmentCompose](/javascript/api/outlook/office.appointmentcompose)|[sensitivityLabel](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-sensitivitylabel-member)|Gets the object to get or set the {@link Office.SensitivityLabel | sensitivity label} of an appointment.| +|[Body](/javascript/api/outlook/office.body)|[prependOnSendAsync(data: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.body#outlook-office-body-prependonsendasync-member(1))|Prepends HTML or plain text to the beginning of a message or appointment body when the mail item is sent.| +||[prependOnSendAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.body#outlook-office-body-prependonsendasync-member(1))|Prepends HTML or plain text to the beginning of a message or appointment body when the mail item is sent.| +|[DelayDeliveryTime](/javascript/api/outlook/office.delaydeliverytime)|[getAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.delaydeliverytime#outlook-office-delaydeliverytime-getasync-member(1))|Gets the delivery date and time of a message.| +||[getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.delaydeliverytime#outlook-office-delaydeliverytime-getasync-member(1))|Gets the delivery date and time of a message.| +||[setAsync(datetime: Date, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.delaydeliverytime#outlook-office-delaydeliverytime-setasync-member(1))|Sets the delivery date and time of a message.| +||[setAsync(datetime: Date, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.delaydeliverytime#outlook-office-delaydeliverytime-setasync-member(1))|Sets the delivery date and time of a message.| +|[Mailbox](/javascript/api/outlook/office.mailbox)|[getSelectedItemsAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-getselecteditemsasync-member(1))|Gets currently selected messages on which an add-in can activate and perform operations.| +||[getSelectedItemsAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-getselecteditemsasync-member(1))|Gets currently selected messages on which an add-in can activate and perform operations.| +|[MessageCompose](/javascript/api/outlook/office.messagecompose)|[delayDeliveryTime](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-delaydeliverytime-member)|Gets or sets the delayed delivery date and time of a message.| +||[sensitivityLabel](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-sensitivitylabel-member)|Gets the object to get or set the {@link Office.SensitivityLabel | sensitivity label} of a message.| +|[SelectedItemDetails](/javascript/api/outlook/office.selecteditemdetails)|[itemId](/javascript/api/outlook/office.selecteditemdetails#outlook-office-selecteditemdetails-itemid-member)|The Exchange Web Services (EWS) item identifier of the message that's currently selected.| +||[itemMode](/javascript/api/outlook/office.selecteditemdetails#outlook-office-selecteditemdetails-itemmode-member)|The Outlook mode (`Read` or `Compose`) of the message that's currently selected.| +||[itemType](/javascript/api/outlook/office.selecteditemdetails#outlook-office-selecteditemdetails-itemtype-member)|The type of the item that's currently selected.| +||[subject](/javascript/api/outlook/office.selecteditemdetails#outlook-office-selecteditemdetails-subject-member)|The description that appears in the subject field of the message that's currently selected.| +|[SensitivityLabel](/javascript/api/outlook/office.sensitivitylabel)|[getAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.sensitivitylabel#outlook-office-sensitivitylabel-getasync-member(1))|Gets the unique identifier (GUID) of the sensitivity label applied to a message or appointment being composed.| +||[getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.sensitivitylabel#outlook-office-sensitivitylabel-getasync-member(1))|Gets the unique identifier (GUID) of the sensitivity label applied to a message or appointment being composed.| +||[setAsync(sensitivityLabel: string \| SensitivityLabelDetails, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.sensitivitylabel#outlook-office-sensitivitylabel-setasync-member(1))|Applies the specified sensitivity label to the message or appointment being composed.| +||[setAsync(sensitivityLabel: string \| SensitivityLabelDetails, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.sensitivitylabel#outlook-office-sensitivitylabel-setasync-member(1))|Applies the specified sensitivity label to the message or appointment being composed.| +|[SensitivityLabelChangedEventArgs](/javascript/api/outlook/office.sensitivitylabelchangedeventargs)|[type](/javascript/api/outlook/office.sensitivitylabelchangedeventargs#outlook-office-sensitivitylabelchangedeventargs-type-member)|The type of event that was raised.| +|[SensitivityLabelDetails](/javascript/api/outlook/office.sensitivitylabeldetails)|[children](/javascript/api/outlook/office.sensitivitylabeldetails#outlook-office-sensitivitylabeldetails-children-member)|The {@link https://learn.microsoft.com/microsoft-365/compliance/sensitivity-labels#sublabels-grouping-labels | sublabels} of the sensitivity label.| +||[color](/javascript/api/outlook/office.sensitivitylabeldetails#outlook-office-sensitivitylabeldetails-color-member)|The color of the sensitivity label.| +||[id](/javascript/api/outlook/office.sensitivitylabeldetails#outlook-office-sensitivitylabeldetails-id-member)|The unique identifier (GUID) of the sensitivity label.| +||[name](/javascript/api/outlook/office.sensitivitylabeldetails#outlook-office-sensitivitylabeldetails-name-member)|The name of the sensitivity label.| +||[tooltip](/javascript/api/outlook/office.sensitivitylabeldetails#outlook-office-sensitivitylabeldetails-tooltip-member)|The description of the sensitivity label.| +|[SensitivityLabelsCatalog](/javascript/api/outlook/office.sensitivitylabelscatalog)|[getAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.sensitivitylabelscatalog#outlook-office-sensitivitylabelscatalog-getasync-member(1))|Gets all the sensitivity labels that are enabled in Outlook.| +||[getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.sensitivitylabelscatalog#outlook-office-sensitivitylabelscatalog-getasync-member(1))|Gets all the sensitivity labels that are enabled in Outlook.| +||[getIsEnabledAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.sensitivitylabelscatalog#outlook-office-sensitivitylabelscatalog-getisenabledasync-member(1))|Checks whether the catalog of sensitivity labels is enabled in Outlook.| +||[getIsEnabledAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.sensitivitylabelscatalog#outlook-office-sensitivitylabelscatalog-getisenabledasync-member(1))|Checks whether the catalog of sensitivity labels is enabled in Outlook.| diff --git a/docs/includes/outlook-1_14.md b/docs/includes/outlook-1_14.md index 1ba19ed9fa..af03710175 100644 --- a/docs/includes/outlook-1_14.md +++ b/docs/includes/outlook-1_14.md @@ -1,35 +1,35 @@ | Class | Fields | Description | |:---|:---|:---| -|[AppointmentCompose](/.appointmentcompose)|[sensitivity](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-sensitivity-member)|Gets or sets the {@link Office.Sensitivity | sensitivity level} of an appointment.| -|[AppointmentRead](/.appointmentread)|[sensitivity](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-sensitivity-member)|Provides the sensitivity value of the appointment.| -|[MailboxEvent](/.mailboxevent)|[completed(options?: SmartAlertsEventCompletedOptions \| SpamReportingEventCompletedOptions)](/.mailboxevent#outlook-javascript/api/outlook/-mailboxevent-completed-member(1))|Indicates that the event-based or spam-reporting add-in has completed processing an event.| -|[MessageCompose](/.messagecompose)|[closeAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-closeasync-member(1))|Closes the current new message being composed.| -||[closeAsync(options: Office.AsyncContextOptions & { discardItem: boolean }, callback?: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-closeasync-member(1))|Closes the current message being composed with the option to discard unsaved changes.| -||[getConversationIndexAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-getconversationindexasync-member(1))|Gets the Base64-encoded position of the current message in a conversation thread.| -||[getConversationIndexAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-getconversationindexasync-member(1))|Gets the Base64-encoded position of the current message in a conversation thread.| -||[getItemClassAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-getitemclassasync-member(1))|Gets the Exchange Web Services item class of the selected message.| -||[getItemClassAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-getitemclassasync-member(1))|Gets the Exchange Web Services item class of the selected message.| -||[inReplyTo](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-inreplyto-member)|Gets the internet message ID of the original message being replied to by the current message.| -|[MessageRead](/.messageread)|[getAsFileAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.messageread#outlook-javascript/api/outlook/-messageread-getasfileasync-member(1))|Gets the current message in EML format encoded in Base64.| -||[getAsFileAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.messageread#outlook-javascript/api/outlook/-messageread-getasfileasync-member(1))|Gets the current message in EML format encoded in Base64.| -|[OfficeThemeChangedEventArgs](/.officethemechangedeventargs)|[officeTheme](/.officethemechangedeventargs#outlook-javascript/api/outlook/-officethemechangedeventargs-officetheme-member)|Gets the updated Office theme.| -||[type](/.officethemechangedeventargs#outlook-javascript/api/outlook/-officethemechangedeventargs-type-member)|Gets the type of the event.| -|[SelectedItemDetails](/.selecteditemdetails)|[conversationId](/.selecteditemdetails#outlook-javascript/api/outlook/-selecteditemdetails-conversationid-member)|The identifier of the message conversation that contains the message that's currently selected.| -||[hasAttachment](/.selecteditemdetails#outlook-javascript/api/outlook/-selecteditemdetails-hasattachment-member)|Returns `true` if the message that's currently selected contains an attachment.| -||[internetMessageId](/.selecteditemdetails#outlook-javascript/api/outlook/-selecteditemdetails-internetmessageid-member)|The internet message identifier of the message that's currently selected.| -|[Sensitivity](/.sensitivity)|[getAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.sensitivity#outlook-javascript/api/outlook/-sensitivity-getasync-member(1))|Gets the sensitivity level of an appointment.| -||[getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.sensitivity#outlook-javascript/api/outlook/-sensitivity-getasync-member(1))|Gets the sensitivity level of an appointment.| -||[setAsync(sensitivity: MailboxEnums.AppointmentSensitivityType \| string, callback?: (asyncResult: Office.AsyncResult) => void)](/.sensitivity#outlook-javascript/api/outlook/-sensitivity-setasync-member(1))|Sets the sensitivity level of an appointment.| -||[setAsync(sensitivity: MailboxEnums.AppointmentSensitivityType \| string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.sensitivity#outlook-javascript/api/outlook/-sensitivity-setasync-member(1))|Sets the sensitivity level of an appointment.| -|[SmartAlertsEventCompletedOptions](/.smartalertseventcompletedoptions)|[cancelLabel](/.smartalertseventcompletedoptions#outlook-javascript/api/outlook/-smartalertseventcompletedoptions-cancellabel-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal completion of an event handler and set its `allowEvent` property to `false`,| -||[commandId](/.smartalertseventcompletedoptions#outlook-javascript/api/outlook/-smartalertseventcompletedoptions-commandid-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal completion of an event handler and set its `allowEvent` property to `false`,| -||[contextData](/.smartalertseventcompletedoptions#outlook-javascript/api/outlook/-smartalertseventcompletedoptions-contextdata-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to| -||[sendModeOverride](/.smartalertseventcompletedoptions#outlook-javascript/api/outlook/-smartalertseventcompletedoptions-sendmodeoverride-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal completion of an event handler| -|[SpamReportingEventArgs](/.spamreportingeventargs)|[freeText](/.spamreportingeventargs#outlook-javascript/api/outlook/-spamreportingeventargs-freetext-member)|The text provided by the user in the preprocessing dialog of a spam-reporting add-in.| -||[options](/.spamreportingeventargs#outlook-javascript/api/outlook/-spamreportingeventargs-options-member)|Returns `true` for each reporting option selected by the user in the preprocessing dialog of a spam-reporting add-in.| -||[type](/.spamreportingeventargs#outlook-javascript/api/outlook/-spamreportingeventargs-type-member)|The type of event that was raised.| -|[SpamReportingEventCompletedOptions](/.spamreportingeventcompletedoptions)|[folderName](/.spamreportingeventcompletedoptions#outlook-javascript/api/outlook/-spamreportingeventcompletedoptions-foldername-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal that a reported message has finished processing,| -||[moveItemTo](/.spamreportingeventcompletedoptions#outlook-javascript/api/outlook/-spamreportingeventcompletedoptions-moveitemto-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal that a reported message has finished processing,| -||[onErrorDeleteItem](/.spamreportingeventcompletedoptions#outlook-javascript/api/outlook/-spamreportingeventcompletedoptions-onerrordeleteitem-member)|When set to `true`, deletes a reported message if an error occurs while the message is processed.| -||[postProcessingAction](/.spamreportingeventcompletedoptions#outlook-javascript/api/outlook/-spamreportingeventcompletedoptions-postprocessingaction-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal that a reported message has finished processing,| -||[showPostProcessingDialog](/.spamreportingeventcompletedoptions#outlook-javascript/api/outlook/-spamreportingeventcompletedoptions-showpostprocessingdialog-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal that a reported message has finished processing,| +|[AppointmentCompose](/javascript/api/outlook/office.appointmentcompose)|[sensitivity](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-sensitivity-member)|Gets or sets the {@link Office.Sensitivity | sensitivity level} of an appointment.| +|[AppointmentRead](/javascript/api/outlook/office.appointmentread)|[sensitivity](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-sensitivity-member)|Provides the sensitivity value of the appointment.| +|[MailboxEvent](/javascript/api/outlook/office.mailboxevent)|[completed(options?: SmartAlertsEventCompletedOptions \| SpamReportingEventCompletedOptions)](/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1))|Indicates that the event-based or spam-reporting add-in has completed processing an event.| +|[MessageCompose](/javascript/api/outlook/office.messagecompose)|[closeAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-closeasync-member(1))|Closes the current new message being composed.| +||[closeAsync(options: Office.AsyncContextOptions & { discardItem: boolean }, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-closeasync-member(1))|Closes the current message being composed with the option to discard unsaved changes.| +||[getConversationIndexAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-getconversationindexasync-member(1))|Gets the Base64-encoded position of the current message in a conversation thread.| +||[getConversationIndexAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-getconversationindexasync-member(1))|Gets the Base64-encoded position of the current message in a conversation thread.| +||[getItemClassAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-getitemclassasync-member(1))|Gets the Exchange Web Services item class of the selected message.| +||[getItemClassAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-getitemclassasync-member(1))|Gets the Exchange Web Services item class of the selected message.| +||[inReplyTo](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-inreplyto-member)|Gets the internet message ID of the original message being replied to by the current message.| +|[MessageRead](/javascript/api/outlook/office.messageread)|[getAsFileAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messageread#outlook-office-messageread-getasfileasync-member(1))|Gets the current message in EML format encoded in Base64.| +||[getAsFileAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messageread#outlook-office-messageread-getasfileasync-member(1))|Gets the current message in EML format encoded in Base64.| +|[OfficeThemeChangedEventArgs](/javascript/api/outlook/office.officethemechangedeventargs)|[officeTheme](/javascript/api/outlook/office.officethemechangedeventargs#outlook-office-officethemechangedeventargs-officetheme-member)|Gets the updated Office theme.| +||[type](/javascript/api/outlook/office.officethemechangedeventargs#outlook-office-officethemechangedeventargs-type-member)|Gets the type of the event.| +|[SelectedItemDetails](/javascript/api/outlook/office.selecteditemdetails)|[conversationId](/javascript/api/outlook/office.selecteditemdetails#outlook-office-selecteditemdetails-conversationid-member)|The identifier of the message conversation that contains the message that's currently selected.| +||[hasAttachment](/javascript/api/outlook/office.selecteditemdetails#outlook-office-selecteditemdetails-hasattachment-member)|Returns `true` if the message that's currently selected contains an attachment.| +||[internetMessageId](/javascript/api/outlook/office.selecteditemdetails#outlook-office-selecteditemdetails-internetmessageid-member)|The internet message identifier of the message that's currently selected.| +|[Sensitivity](/javascript/api/outlook/office.sensitivity)|[getAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.sensitivity#outlook-office-sensitivity-getasync-member(1))|Gets the sensitivity level of an appointment.| +||[getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.sensitivity#outlook-office-sensitivity-getasync-member(1))|Gets the sensitivity level of an appointment.| +||[setAsync(sensitivity: MailboxEnums.AppointmentSensitivityType \| string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.sensitivity#outlook-office-sensitivity-setasync-member(1))|Sets the sensitivity level of an appointment.| +||[setAsync(sensitivity: MailboxEnums.AppointmentSensitivityType \| string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.sensitivity#outlook-office-sensitivity-setasync-member(1))|Sets the sensitivity level of an appointment.| +|[SmartAlertsEventCompletedOptions](/javascript/api/outlook/office.smartalertseventcompletedoptions)|[cancelLabel](/javascript/api/outlook/office.smartalertseventcompletedoptions#outlook-office-smartalertseventcompletedoptions-cancellabel-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal completion of an event handler and set its `allowEvent` property to `false`,| +||[commandId](/javascript/api/outlook/office.smartalertseventcompletedoptions#outlook-office-smartalertseventcompletedoptions-commandid-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal completion of an event handler and set its `allowEvent` property to `false`,| +||[contextData](/javascript/api/outlook/office.smartalertseventcompletedoptions#outlook-office-smartalertseventcompletedoptions-contextdata-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to| +||[sendModeOverride](/javascript/api/outlook/office.smartalertseventcompletedoptions#outlook-office-smartalertseventcompletedoptions-sendmodeoverride-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal completion of an event handler| +|[SpamReportingEventArgs](/javascript/api/outlook/office.spamreportingeventargs)|[freeText](/javascript/api/outlook/office.spamreportingeventargs#outlook-office-spamreportingeventargs-freetext-member)|The text provided by the user in the preprocessing dialog of a spam-reporting add-in.| +||[options](/javascript/api/outlook/office.spamreportingeventargs#outlook-office-spamreportingeventargs-options-member)|Returns `true` for each reporting option selected by the user in the preprocessing dialog of a spam-reporting add-in.| +||[type](/javascript/api/outlook/office.spamreportingeventargs#outlook-office-spamreportingeventargs-type-member)|The type of event that was raised.| +|[SpamReportingEventCompletedOptions](/javascript/api/outlook/office.spamreportingeventcompletedoptions)|[folderName](/javascript/api/outlook/office.spamreportingeventcompletedoptions#outlook-office-spamreportingeventcompletedoptions-foldername-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal that a reported message has finished processing,| +||[moveItemTo](/javascript/api/outlook/office.spamreportingeventcompletedoptions#outlook-office-spamreportingeventcompletedoptions-moveitemto-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal that a reported message has finished processing,| +||[onErrorDeleteItem](/javascript/api/outlook/office.spamreportingeventcompletedoptions#outlook-office-spamreportingeventcompletedoptions-onerrordeleteitem-member)|When set to `true`, deletes a reported message if an error occurs while the message is processed.| +||[postProcessingAction](/javascript/api/outlook/office.spamreportingeventcompletedoptions#outlook-office-spamreportingeventcompletedoptions-postprocessingaction-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal that a reported message has finished processing,| +||[showPostProcessingDialog](/javascript/api/outlook/office.spamreportingeventcompletedoptions#outlook-office-spamreportingeventcompletedoptions-showpostprocessingdialog-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal that a reported message has finished processing,| diff --git a/docs/includes/outlook-1_15.md b/docs/includes/outlook-1_15.md index 80ed95ba41..672de5e92c 100644 --- a/docs/includes/outlook-1_15.md +++ b/docs/includes/outlook-1_15.md @@ -1,94 +1,94 @@ | Class | Fields | Description | |:---|:---|:---| -|[AppointmentCompose](/.appointmentcompose)|[sendAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-sendasync-member(1))|Sends the appointment being composed.| -||[sendAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-sendasync-member(1))|Sends the appointment being composed.| -|[InitializationContextChangedEventArgs](/.initializationcontextchangedeventargs)|[initializationContextData](/.initializationcontextchangedeventargs#outlook-javascript/api/outlook/-initializationcontextchangedeventargs-initializationcontextdata-member)|Represents the data to be passed to an add-in's task pane from an actionable message, notification message, Smart Alerts dialog, or integrated| -||[type](/.initializationcontextchangedeventargs#outlook-javascript/api/outlook/-initializationcontextchangedeventargs-type-member)|Represents the type of the event.| -|[LoadedMessageCompose](/.loadedmessagecompose)|[bcc](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-bcc-member)|Gets the recipients on the **Bcc** (blind carbon copy) line of a message.| -||[body](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-body-member)|Gets the item's body and format.| -||[categories](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-categories-member)|Gets an object that provides methods to manage the item's categories.| -||[cc](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-cc-member)|Gets recipients on the **Cc** (carbon copy) line of a message.| -||[conversationId](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-conversationid-member)|Gets an identifier for the email conversation that contains a particular message.| -||[delayDeliveryTime](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-delaydeliverytime-member)|Gets the delayed delivery date and time of a message.| -||[from](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-from-member)|Gets the email address of the sender of a message.| -||[getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-getattachmentcontentasync-member(1))|Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.| -||[getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-getattachmentcontentasync-member(1))|Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.| -||[getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-getattachmentsasync-member(1))|Gets the item's attachments as an array.| -||[getAttachmentsAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-getattachmentsasync-member(1))|Gets the item's attachments as an array.| -||[getComposeTypeAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-getcomposetypeasync-member(1))|Specifies the type of message compose and its coercion type.| -||[getComposeTypeAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-getcomposetypeasync-member(1))|Specifies the type of message compose and its coercion type.| -||[getConversationIndexAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-getconversationindexasync-member(1))|Gets the Base64-encoded position of the current message in a conversation thread.| -||[getConversationIndexAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-getconversationindexasync-member(1))|Gets the Base64-encoded position of the current message in a conversation thread.| -||[getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-getinitializationcontextasync-member(1))|Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.| -||[getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-getinitializationcontextasync-member(1))|Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.| -||[getItemClassAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-getitemclassasync-member(1))|Gets the Exchange Web Services item class of the selected message.| -||[getItemClassAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-getitemclassasync-member(1))|Gets the Exchange Web Services item class of the selected message.| -||[getItemIdAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-getitemidasync-member(1))|Asynchronously gets the ID of a saved item.| -||[getItemIdAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-getitemidasync-member(1))|Asynchronously gets the {@link https://learn.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | Exchange Web Services (EWS) item identifier}| -||[getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-getsharedpropertiesasync-member(1))|Gets the properties of an appointment or message in a shared folder or shared mailbox.| -||[getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-getsharedpropertiesasync-member(1))|Gets the properties of an appointment or message in a shared folder or shared mailbox.| -||[inReplyTo](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-inreplyto-member)|Gets the message ID of the original message being replied to by the current message.| -||[internetHeaders](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-internetheaders-member)|Gets the custom internet headers of a message.| -||[isClientSignatureEnabledAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-isclientsignatureenabledasync-member(1))|Gets if the client signature is enabled.| -||[isClientSignatureEnabledAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-isclientsignatureenabledasync-member(1))|Gets if the client signature is enabled.| -||[itemType](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-itemtype-member)|Gets the type of item that an instance represents.| -||[loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void, userContext?: any)](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-loadcustompropertiesasync-member(1))|Asynchronously loads custom properties for this add-in on the selected item.| -||[notificationMessages](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-notificationmessages-member)|Gets the notification messages of the item.| -||[saveAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-saveasync-member(1))|Asynchronously saves the current message as a draft.| -||[saveAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-saveasync-member(1))|Asynchronously saves the current message as a draft.| -||[sensitivityLabel](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-sensitivitylabel-member)|Gets the sensitivity label of a message.| -||[seriesId](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-seriesid-member)|Gets the ID of the series that an instance belongs to.| -||[subject](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-subject-member)|Gets the description that appears in the subject field of an item.| -||[to](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-to-member)|Gets the recipients on the **To** line of a message.| -||[unloadAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-unloadasync-member(1))|When multiple mail items are selected, closes the currently loaded item, so that another selected mail item can be loaded for processing.| -||[unloadAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.loadedmessagecompose#outlook-javascript/api/outlook/-loadedmessagecompose-unloadasync-member(1))|When multiple mail items are selected, closes the currently loaded item, so that another selected mail item can be loaded for processing.| -|[LoadedMessageRead](/.loadedmessageread)|[attachments](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-attachments-member)|Gets the item's attachments as an array.| -||[body](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-body-member)|Gets the item's body and its format.| -||[categories](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-categories-member)|Gets an object that provides methods to manage the item's categories.| -||[cc](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-cc-member)|Gets recipients on the **Cc** (carbon copy) line of a message.| -||[conversationId](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-conversationid-member)|Gets an identifier for the email conversation that contains a particular message.| -||[dateTimeCreated](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-datetimecreated-member)|Gets the date and time that an item was created.| -||[dateTimeModified](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-datetimemodified-member)|Gets the date and time that an item was last modified.| -||[displayReplyAllFormAsync(formData: string \| ReplyFormData, callback?: (asyncResult: Office.AsyncResult) => void)](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-displayreplyallformasync-member(1))|Displays a reply form that includes either the sender and all recipients of the selected message or the organizer and all attendees of the| -||[displayReplyAllFormAsync(formData: string \| ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-displayreplyallformasync-member(1))|Displays a reply form that includes either the sender and all recipients of the selected message or the organizer and all attendees of the| -||[displayReplyFormAsync(formData: string \| ReplyFormData, callback?: (asyncResult: Office.AsyncResult) => void)](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-displayreplyformasync-member(1))|Displays a reply form that includes only the sender of the selected message or the organizer of the selected appointment.| -||[displayReplyFormAsync(formData: string \| ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-displayreplyformasync-member(1))|Displays a reply form that includes only the sender of the selected message or the organizer of the selected appointment.| -||[end](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-end-member)|Gets the date and time that the appointment is to end.| -||[from](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-from-member)|Gets the email address of the sender of a message.| -||[getAllInternetHeadersAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-getallinternetheadersasync-member(1))|Gets all the internet headers for the message as a string.| -||[getAllInternetHeadersAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-getallinternetheadersasync-member(1))|Gets all the internet headers for the message as a string.| -||[getAsFileAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-getasfileasync-member(1))|Gets the current message in EML format encoded in Base64.| -||[getAsFileAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-getasfileasync-member(1))|Gets the current message in EML format encoded in Base64.| -||[getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-getattachmentcontentasync-member(1))|Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.| -||[getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-getattachmentcontentasync-member(1))|Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.| -||[getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-getinitializationcontextasync-member(1))|Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.| -||[getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-getinitializationcontextasync-member(1))|Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.| -||[getRegExMatches()](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-getregexmatches-member(1))|Returns string values in the selected item that match the regular expressions defined in an XML manifest file.| -||[getRegExMatchesByName(name: string)](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-getregexmatchesbyname-member(1))|Returns string values in the selected item that match the named regular expression defined in an XML manifest file.| -||[getSelectedRegExMatches()](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-getselectedregexmatches-member(1))|Returns string values in a highlighted match that match the regular expressions defined in an XML manifest file.| -||[getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-getsharedpropertiesasync-member(1))|Gets the properties of an appointment or message in a shared folder or shared mailbox.| -||[getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-getsharedpropertiesasync-member(1))|Gets the properties of an appointment or message in a shared folder or shared mailbox.| -||[internetMessageId](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-internetmessageid-member)|Gets the internet message identifier of a message.| -||[itemClass](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-itemclass-member)|Gets the Exchange Web Services item class of the selected message.| -||[itemId](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-itemid-member)|Gets the {@link https://learn.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | Exchange Web Services item identifier}| -||[itemType](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-itemtype-member)|Gets the type of item that an instance represents.| -||[loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void, userContext?: any)](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-loadcustompropertiesasync-member(1))|Asynchronously loads custom properties for this add-in on the selected item.| -||[location](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-location-member)|Gets the location of a meeting request.| -||[normalizedSubject](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-normalizedsubject-member)|Gets the subject of an item, with all prefixes removed (including RE: and FWD:).| -||[notificationMessages](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-notificationmessages-member)|Gets the notification messages of the item.| -||[recurrence](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-recurrence-member)|Gets the recurrence pattern of an appointment.| -||[sender](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-sender-member)|Gets the email address of the sender of an email message.| -||[seriesId](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-seriesid-member)|Gets the ID of the series that an instance belongs to.| -||[start](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-start-member)|Gets the date and time that the appointment is to begin.| -||[subject](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-subject-member)|Gets the description that appears in the subject field of an item.| -||[to](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-to-member)|Gets the recipients on the **To** line of a message.| -||[unloadAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-unloadasync-member(1))|When multiple mail items are selected, closes the currently loaded item, so that another selected mail item can be loaded for processing.| -||[unloadAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.loadedmessageread#outlook-javascript/api/outlook/-loadedmessageread-unloadasync-member(1))|When multiple mail items are selected, closes the currently loaded item, so that another selected mail item can be loaded for processing.| -|[Mailbox](/.mailbox)|[loadItemByIdAsync(itemId: string, callback: (asyncResult: Office.AsyncResult) => void)](/.mailbox#outlook-javascript/api/outlook/-mailbox-loaditembyidasync-member(1))|Loads a single mail item by its Exchange Web Services (EWS) ID.| -||[loadItemByIdAsync(itemId: string, options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.mailbox#outlook-javascript/api/outlook/-mailbox-loaditembyidasync-member(1))|Loads a single mail item by its Exchange Web Services (EWS) ID.| -|[MessageCompose](/.messagecompose)|[sendAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-sendasync-member(1))|Sends the message being composed.| -||[sendAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-sendasync-member(1))|Sends the message being composed.| -|[ReplyFormAttachment](/.replyformattachment)|[base64file](/.replyformattachment#outlook-javascript/api/outlook/-replyformattachment-base64file-member)|The Base64-encoded string of the file to be attached.| -|[SmartAlertsEventCompletedOptions](/.smartalertseventcompletedoptions)|[errorMessageMarkdown](/.smartalertseventcompletedoptions#outlook-javascript/api/outlook/-smartalertseventcompletedoptions-errormessagemarkdown-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal completion of an event handler| -|[SpamReportingEventCompletedOptions](/.spamreportingeventcompletedoptions)|[commandId](/.spamreportingeventcompletedoptions#outlook-javascript/api/outlook/-spamreportingeventcompletedoptions-commandid-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal that a reported message has finished processing,| -||[contextData](/.spamreportingeventcompletedoptions#outlook-javascript/api/outlook/-spamreportingeventcompletedoptions-contextdata-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal that a reported message has finished processing,| +|[AppointmentCompose](/javascript/api/outlook/office.appointmentcompose)|[sendAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-sendasync-member(1))|Sends the appointment being composed.| +||[sendAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-sendasync-member(1))|Sends the appointment being composed.| +|[InitializationContextChangedEventArgs](/javascript/api/outlook/office.initializationcontextchangedeventargs)|[initializationContextData](/javascript/api/outlook/office.initializationcontextchangedeventargs#outlook-office-initializationcontextchangedeventargs-initializationcontextdata-member)|Represents the data to be passed to an add-in's task pane from an actionable message, notification message, Smart Alerts dialog, or integrated| +||[type](/javascript/api/outlook/office.initializationcontextchangedeventargs#outlook-office-initializationcontextchangedeventargs-type-member)|Represents the type of the event.| +|[LoadedMessageCompose](/javascript/api/outlook/office.loadedmessagecompose)|[bcc](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-bcc-member)|Gets the recipients on the **Bcc** (blind carbon copy) line of a message.| +||[body](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-body-member)|Gets the item's body and format.| +||[categories](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-categories-member)|Gets an object that provides methods to manage the item's categories.| +||[cc](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-cc-member)|Gets recipients on the **Cc** (carbon copy) line of a message.| +||[conversationId](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-conversationid-member)|Gets an identifier for the email conversation that contains a particular message.| +||[delayDeliveryTime](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-delaydeliverytime-member)|Gets the delayed delivery date and time of a message.| +||[from](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-from-member)|Gets the email address of the sender of a message.| +||[getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-getattachmentcontentasync-member(1))|Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.| +||[getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-getattachmentcontentasync-member(1))|Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.| +||[getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-getattachmentsasync-member(1))|Gets the item's attachments as an array.| +||[getAttachmentsAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-getattachmentsasync-member(1))|Gets the item's attachments as an array.| +||[getComposeTypeAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-getcomposetypeasync-member(1))|Specifies the type of message compose and its coercion type.| +||[getComposeTypeAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-getcomposetypeasync-member(1))|Specifies the type of message compose and its coercion type.| +||[getConversationIndexAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-getconversationindexasync-member(1))|Gets the Base64-encoded position of the current message in a conversation thread.| +||[getConversationIndexAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-getconversationindexasync-member(1))|Gets the Base64-encoded position of the current message in a conversation thread.| +||[getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-getinitializationcontextasync-member(1))|Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.| +||[getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-getinitializationcontextasync-member(1))|Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.| +||[getItemClassAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-getitemclassasync-member(1))|Gets the Exchange Web Services item class of the selected message.| +||[getItemClassAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-getitemclassasync-member(1))|Gets the Exchange Web Services item class of the selected message.| +||[getItemIdAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-getitemidasync-member(1))|Asynchronously gets the ID of a saved item.| +||[getItemIdAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-getitemidasync-member(1))|Asynchronously gets the {@link https://learn.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | Exchange Web Services (EWS) item identifier}| +||[getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-getsharedpropertiesasync-member(1))|Gets the properties of an appointment or message in a shared folder or shared mailbox.| +||[getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-getsharedpropertiesasync-member(1))|Gets the properties of an appointment or message in a shared folder or shared mailbox.| +||[inReplyTo](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-inreplyto-member)|Gets the message ID of the original message being replied to by the current message.| +||[internetHeaders](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-internetheaders-member)|Gets the custom internet headers of a message.| +||[isClientSignatureEnabledAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-isclientsignatureenabledasync-member(1))|Gets if the client signature is enabled.| +||[isClientSignatureEnabledAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-isclientsignatureenabledasync-member(1))|Gets if the client signature is enabled.| +||[itemType](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-itemtype-member)|Gets the type of item that an instance represents.| +||[loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void, userContext?: any)](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-loadcustompropertiesasync-member(1))|Asynchronously loads custom properties for this add-in on the selected item.| +||[notificationMessages](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-notificationmessages-member)|Gets the notification messages of the item.| +||[saveAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-saveasync-member(1))|Asynchronously saves the current message as a draft.| +||[saveAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-saveasync-member(1))|Asynchronously saves the current message as a draft.| +||[sensitivityLabel](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-sensitivitylabel-member)|Gets the sensitivity label of a message.| +||[seriesId](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-seriesid-member)|Gets the ID of the series that an instance belongs to.| +||[subject](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-subject-member)|Gets the description that appears in the subject field of an item.| +||[to](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-to-member)|Gets the recipients on the **To** line of a message.| +||[unloadAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-unloadasync-member(1))|When multiple mail items are selected, closes the currently loaded item, so that another selected mail item can be loaded for processing.| +||[unloadAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessagecompose#outlook-office-loadedmessagecompose-unloadasync-member(1))|When multiple mail items are selected, closes the currently loaded item, so that another selected mail item can be loaded for processing.| +|[LoadedMessageRead](/javascript/api/outlook/office.loadedmessageread)|[attachments](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-attachments-member)|Gets the item's attachments as an array.| +||[body](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-body-member)|Gets the item's body and its format.| +||[categories](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-categories-member)|Gets an object that provides methods to manage the item's categories.| +||[cc](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-cc-member)|Gets recipients on the **Cc** (carbon copy) line of a message.| +||[conversationId](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-conversationid-member)|Gets an identifier for the email conversation that contains a particular message.| +||[dateTimeCreated](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-datetimecreated-member)|Gets the date and time that an item was created.| +||[dateTimeModified](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-datetimemodified-member)|Gets the date and time that an item was last modified.| +||[displayReplyAllFormAsync(formData: string \| ReplyFormData, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-displayreplyallformasync-member(1))|Displays a reply form that includes either the sender and all recipients of the selected message or the organizer and all attendees of the| +||[displayReplyAllFormAsync(formData: string \| ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-displayreplyallformasync-member(1))|Displays a reply form that includes either the sender and all recipients of the selected message or the organizer and all attendees of the| +||[displayReplyFormAsync(formData: string \| ReplyFormData, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-displayreplyformasync-member(1))|Displays a reply form that includes only the sender of the selected message or the organizer of the selected appointment.| +||[displayReplyFormAsync(formData: string \| ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-displayreplyformasync-member(1))|Displays a reply form that includes only the sender of the selected message or the organizer of the selected appointment.| +||[end](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-end-member)|Gets the date and time that the appointment is to end.| +||[from](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-from-member)|Gets the email address of the sender of a message.| +||[getAllInternetHeadersAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-getallinternetheadersasync-member(1))|Gets all the internet headers for the message as a string.| +||[getAllInternetHeadersAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-getallinternetheadersasync-member(1))|Gets all the internet headers for the message as a string.| +||[getAsFileAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-getasfileasync-member(1))|Gets the current message in EML format encoded in Base64.| +||[getAsFileAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-getasfileasync-member(1))|Gets the current message in EML format encoded in Base64.| +||[getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-getattachmentcontentasync-member(1))|Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.| +||[getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-getattachmentcontentasync-member(1))|Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.| +||[getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-getinitializationcontextasync-member(1))|Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.| +||[getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-getinitializationcontextasync-member(1))|Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.| +||[getRegExMatches()](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-getregexmatches-member(1))|Returns string values in the selected item that match the regular expressions defined in an XML manifest file.| +||[getRegExMatchesByName(name: string)](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-getregexmatchesbyname-member(1))|Returns string values in the selected item that match the named regular expression defined in an XML manifest file.| +||[getSelectedRegExMatches()](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-getselectedregexmatches-member(1))|Returns string values in a highlighted match that match the regular expressions defined in an XML manifest file.| +||[getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-getsharedpropertiesasync-member(1))|Gets the properties of an appointment or message in a shared folder or shared mailbox.| +||[getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-getsharedpropertiesasync-member(1))|Gets the properties of an appointment or message in a shared folder or shared mailbox.| +||[internetMessageId](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-internetmessageid-member)|Gets the internet message identifier of a message.| +||[itemClass](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-itemclass-member)|Gets the Exchange Web Services item class of the selected message.| +||[itemId](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-itemid-member)|Gets the {@link https://learn.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | Exchange Web Services item identifier}| +||[itemType](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-itemtype-member)|Gets the type of item that an instance represents.| +||[loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void, userContext?: any)](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-loadcustompropertiesasync-member(1))|Asynchronously loads custom properties for this add-in on the selected item.| +||[location](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-location-member)|Gets the location of a meeting request.| +||[normalizedSubject](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-normalizedsubject-member)|Gets the subject of an item, with all prefixes removed (including RE: and FWD:).| +||[notificationMessages](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-notificationmessages-member)|Gets the notification messages of the item.| +||[recurrence](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-recurrence-member)|Gets the recurrence pattern of an appointment.| +||[sender](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-sender-member)|Gets the email address of the sender of an email message.| +||[seriesId](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-seriesid-member)|Gets the ID of the series that an instance belongs to.| +||[start](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-start-member)|Gets the date and time that the appointment is to begin.| +||[subject](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-subject-member)|Gets the description that appears in the subject field of an item.| +||[to](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-to-member)|Gets the recipients on the **To** line of a message.| +||[unloadAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-unloadasync-member(1))|When multiple mail items are selected, closes the currently loaded item, so that another selected mail item can be loaded for processing.| +||[unloadAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.loadedmessageread#outlook-office-loadedmessageread-unloadasync-member(1))|When multiple mail items are selected, closes the currently loaded item, so that another selected mail item can be loaded for processing.| +|[Mailbox](/javascript/api/outlook/office.mailbox)|[loadItemByIdAsync(itemId: string, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-loaditembyidasync-member(1))|Loads a single mail item by its Exchange Web Services (EWS) ID.| +||[loadItemByIdAsync(itemId: string, options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-loaditembyidasync-member(1))|Loads a single mail item by its Exchange Web Services (EWS) ID.| +|[MessageCompose](/javascript/api/outlook/office.messagecompose)|[sendAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-sendasync-member(1))|Sends the message being composed.| +||[sendAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-sendasync-member(1))|Sends the message being composed.| +|[ReplyFormAttachment](/javascript/api/outlook/office.replyformattachment)|[base64file](/javascript/api/outlook/office.replyformattachment#outlook-office-replyformattachment-base64file-member)|The Base64-encoded string of the file to be attached.| +|[SmartAlertsEventCompletedOptions](/javascript/api/outlook/office.smartalertseventcompletedoptions)|[errorMessageMarkdown](/javascript/api/outlook/office.smartalertseventcompletedoptions#outlook-office-smartalertseventcompletedoptions-errormessagemarkdown-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal completion of an event handler| +|[SpamReportingEventCompletedOptions](/javascript/api/outlook/office.spamreportingeventcompletedoptions)|[commandId](/javascript/api/outlook/office.spamreportingeventcompletedoptions#outlook-office-spamreportingeventcompletedoptions-commandid-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal that a reported message has finished processing,| +||[contextData](/javascript/api/outlook/office.spamreportingeventcompletedoptions#outlook-office-spamreportingeventcompletedoptions-contextdata-member)|When you use the {@link https://learn.microsoft.com/javascript/api/outlook/office.mailboxevent#outlook-office-mailboxevent-completed-member(1) | completed method} to signal that a reported message has finished processing,| diff --git a/docs/includes/outlook-1_2.md b/docs/includes/outlook-1_2.md index 53e7d4494e..5dfe7c90f6 100644 --- a/docs/includes/outlook-1_2.md +++ b/docs/includes/outlook-1_2.md @@ -1,10 +1,10 @@ | Class | Fields | Description | |:---|:---|:---| -|[AppointmentCompose](/.appointmentcompose)|[getSelectedDataAsync(coercionType: Office.CoercionType \| string, callback: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-getselecteddataasync-member(1))|Asynchronously returns selected data from the subject or body of a message.| -||[getSelectedDataAsync(coercionType: Office.CoercionType \| string, options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-getselecteddataasync-member(1))|Asynchronously returns selected data from the subject or body of a message.| -||[setSelectedDataAsync(data: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-setselecteddataasync-member(1))|Asynchronously inserts data into the body or subject of a message.| -||[setSelectedDataAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-setselecteddataasync-member(1))|Asynchronously inserts data into the body or subject of a message.| -|[MessageCompose](/.messagecompose)|[getSelectedDataAsync(coercionType: Office.CoercionType \| string, callback: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-getselecteddataasync-member(1))|Asynchronously returns selected data from the subject or body of a message.| -||[getSelectedDataAsync(coercionType: Office.CoercionType \| string, options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-getselecteddataasync-member(1))|Asynchronously returns selected data from the subject or body of a message.| -||[setSelectedDataAsync(data: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-setselecteddataasync-member(1))|Asynchronously inserts data into the body or subject of a message.| -||[setSelectedDataAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-setselecteddataasync-member(1))|Asynchronously inserts data into the body or subject of a message.| +|[AppointmentCompose](/javascript/api/outlook/office.appointmentcompose)|[getSelectedDataAsync(coercionType: Office.CoercionType \| string, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-getselecteddataasync-member(1))|Asynchronously returns selected data from the subject or body of a message.| +||[getSelectedDataAsync(coercionType: Office.CoercionType \| string, options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-getselecteddataasync-member(1))|Asynchronously returns selected data from the subject or body of a message.| +||[setSelectedDataAsync(data: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-setselecteddataasync-member(1))|Asynchronously inserts data into the body or subject of a message.| +||[setSelectedDataAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-setselecteddataasync-member(1))|Asynchronously inserts data into the body or subject of a message.| +|[MessageCompose](/javascript/api/outlook/office.messagecompose)|[getSelectedDataAsync(coercionType: Office.CoercionType \| string, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-getselecteddataasync-member(1))|Asynchronously returns selected data from the subject or body of a message.| +||[getSelectedDataAsync(coercionType: Office.CoercionType \| string, options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-getselecteddataasync-member(1))|Asynchronously returns selected data from the subject or body of a message.| +||[setSelectedDataAsync(data: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-setselecteddataasync-member(1))|Asynchronously inserts data into the body or subject of a message.| +||[setSelectedDataAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-setselecteddataasync-member(1))|Asynchronously inserts data into the body or subject of a message.| diff --git a/docs/includes/outlook-1_3.md b/docs/includes/outlook-1_3.md index 1ecac7bab2..9bb49ef1fe 100644 --- a/docs/includes/outlook-1_3.md +++ b/docs/includes/outlook-1_3.md @@ -1,31 +1,31 @@ | Class | Fields | Description | |:---|:---|:---| -|[AppointmentCompose](/.appointmentcompose)|[close()](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-close-member(1))|Closes the current item that is being composed.| -||[notificationMessages](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-notificationmessages-member)|Gets the notification messages for an item.| -||[saveAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-saveasync-member(1))|Asynchronously saves an item.| -||[saveAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-saveasync-member(1))|Asynchronously saves an item.| -|[AppointmentRead](/.appointmentread)|[notificationMessages](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-notificationmessages-member)|Gets the notification messages for an item.| -|[Body](/.body)|[getAsync(coercionType: Office.CoercionType \| string, callback?: (asyncResult: Office.AsyncResult) => void)](/.body#outlook-javascript/api/outlook/-body-getasync-member(1))|Returns the entire current body in the format specified by `coercionType`.| -||[getAsync(coercionType: Office.CoercionType \| string, options: Office.AsyncContextOptions & { bodyMode?: MailboxEnums.BodyMode }, callback?: (asyncResult: Office.AsyncResult) => void)](/.body#outlook-javascript/api/outlook/-body-getasync-member(1))|Returns the entire current body in the format specified by `coercionType`.| -||[setAsync(data: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.body#outlook-javascript/api/outlook/-body-setasync-member(1))|Replaces the entire body with the specified text.| -||[setAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions & { bodyMode?: MailboxEnums.BodyMode }, callback?: (asyncResult: Office.AsyncResult) => void)](/.body#outlook-javascript/api/outlook/-body-setasync-member(1))|Replaces the entire body with the specified text.| -|[Mailbox](/.mailbox)|[convertToEwsId(id: string, restVersion: MailboxEnums.RestVersion \| string)](/.mailbox#outlook-javascript/api/outlook/-mailbox-converttoewsid-member(1))|Converts a supported ID into the Exchange Web Services (EWS) format.| -||[convertToRestId(id: string, restVersion: MailboxEnums.RestVersion \| string)](/.mailbox#outlook-javascript/api/outlook/-mailbox-converttorestid-member(1))|Converts a supported ID into REST format.| -|[MessageCompose](/.messagecompose)|[close()](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-close-member(1))|Closes the current item that is being composed.| -||[notificationMessages](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-notificationmessages-member)|Gets the notification messages for an item.| -||[saveAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-saveasync-member(1))|Asynchronously saves the current message as a draft.| -||[saveAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-saveasync-member(1))|Asynchronously saves the current message as a draft.| -|[MessageRead](/.messageread)|[notificationMessages](/.messageread#outlook-javascript/api/outlook/-messageread-notificationmessages-member)|Gets the notification messages for an item.| -|[NotificationMessageDetails](/.notificationmessagedetails)|[icon](/.notificationmessagedetails#outlook-javascript/api/outlook/-notificationmessagedetails-icon-member)|A reference to a custom icon that's defined in the manifest.| -||[key](/.notificationmessagedetails#outlook-javascript/api/outlook/-notificationmessagedetails-key-member)|The identifier for the notification message.| -||[message](/.notificationmessagedetails#outlook-javascript/api/outlook/-notificationmessagedetails-message-member)|The text of the notification message.| -||[persistent](/.notificationmessagedetails#outlook-javascript/api/outlook/-notificationmessagedetails-persistent-member)|Specifies if the message should be persistent.| -||[type](/.notificationmessagedetails#outlook-javascript/api/outlook/-notificationmessagedetails-type-member)|Specifies the `ItemNotificationMessageType` of message.| -|[NotificationMessages](/.notificationmessages)|[addAsync(key: string, JSONmessage: NotificationMessageDetails, callback?: (asyncResult: Office.AsyncResult) => void)](/.notificationmessages#outlook-javascript/api/outlook/-notificationmessages-addasync-member(1))|Adds a notification to an item.| -||[addAsync(key: string, JSONmessage: NotificationMessageDetails, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.notificationmessages#outlook-javascript/api/outlook/-notificationmessages-addasync-member(1))|Adds a notification to an item.| -||[getAllAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/.notificationmessages#outlook-javascript/api/outlook/-notificationmessages-getallasync-member(1))|Returns all keys and messages for an item.| -||[getAllAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.notificationmessages#outlook-javascript/api/outlook/-notificationmessages-getallasync-member(1))|Returns all keys and messages for an item.| -||[removeAsync(key: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.notificationmessages#outlook-javascript/api/outlook/-notificationmessages-removeasync-member(1))|Removes a notification message for an item.| -||[removeAsync(key: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.notificationmessages#outlook-javascript/api/outlook/-notificationmessages-removeasync-member(1))|Removes a notification message for an item.| -||[replaceAsync(key: string, JSONmessage: NotificationMessageDetails, callback?: (asyncResult: Office.AsyncResult) => void)](/.notificationmessages#outlook-javascript/api/outlook/-notificationmessages-replaceasync-member(1))|Replaces a notification message that has a given key with another message.| -||[replaceAsync(key: string, JSONmessage: NotificationMessageDetails, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.notificationmessages#outlook-javascript/api/outlook/-notificationmessages-replaceasync-member(1))|Replaces a notification message that has a given key with another message.| +|[AppointmentCompose](/javascript/api/outlook/office.appointmentcompose)|[close()](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-close-member(1))|Closes the current item that is being composed.| +||[notificationMessages](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-notificationmessages-member)|Gets the notification messages for an item.| +||[saveAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-saveasync-member(1))|Asynchronously saves an item.| +||[saveAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-saveasync-member(1))|Asynchronously saves an item.| +|[AppointmentRead](/javascript/api/outlook/office.appointmentread)|[notificationMessages](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-notificationmessages-member)|Gets the notification messages for an item.| +|[Body](/javascript/api/outlook/office.body)|[getAsync(coercionType: Office.CoercionType \| string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.body#outlook-office-body-getasync-member(1))|Returns the entire current body in the format specified by `coercionType`.| +||[getAsync(coercionType: Office.CoercionType \| string, options: Office.AsyncContextOptions & { bodyMode?: MailboxEnums.BodyMode }, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.body#outlook-office-body-getasync-member(1))|Returns the entire current body in the format specified by `coercionType`.| +||[setAsync(data: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.body#outlook-office-body-setasync-member(1))|Replaces the entire body with the specified text.| +||[setAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions & { bodyMode?: MailboxEnums.BodyMode }, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.body#outlook-office-body-setasync-member(1))|Replaces the entire body with the specified text.| +|[Mailbox](/javascript/api/outlook/office.mailbox)|[convertToEwsId(id: string, restVersion: MailboxEnums.RestVersion \| string)](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-converttoewsid-member(1))|Converts a supported ID into the Exchange Web Services (EWS) format.| +||[convertToRestId(id: string, restVersion: MailboxEnums.RestVersion \| string)](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-converttorestid-member(1))|Converts a supported ID into REST format.| +|[MessageCompose](/javascript/api/outlook/office.messagecompose)|[close()](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-close-member(1))|Closes the current item that is being composed.| +||[notificationMessages](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-notificationmessages-member)|Gets the notification messages for an item.| +||[saveAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-saveasync-member(1))|Asynchronously saves the current message as a draft.| +||[saveAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-saveasync-member(1))|Asynchronously saves the current message as a draft.| +|[MessageRead](/javascript/api/outlook/office.messageread)|[notificationMessages](/javascript/api/outlook/office.messageread#outlook-office-messageread-notificationmessages-member)|Gets the notification messages for an item.| +|[NotificationMessageDetails](/javascript/api/outlook/office.notificationmessagedetails)|[icon](/javascript/api/outlook/office.notificationmessagedetails#outlook-office-notificationmessagedetails-icon-member)|A reference to a custom icon that's defined in the manifest.| +||[key](/javascript/api/outlook/office.notificationmessagedetails#outlook-office-notificationmessagedetails-key-member)|The identifier for the notification message.| +||[message](/javascript/api/outlook/office.notificationmessagedetails#outlook-office-notificationmessagedetails-message-member)|The text of the notification message.| +||[persistent](/javascript/api/outlook/office.notificationmessagedetails#outlook-office-notificationmessagedetails-persistent-member)|Specifies if the message should be persistent.| +||[type](/javascript/api/outlook/office.notificationmessagedetails#outlook-office-notificationmessagedetails-type-member)|Specifies the `ItemNotificationMessageType` of message.| +|[NotificationMessages](/javascript/api/outlook/office.notificationmessages)|[addAsync(key: string, JSONmessage: NotificationMessageDetails, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.notificationmessages#outlook-office-notificationmessages-addasync-member(1))|Adds a notification to an item.| +||[addAsync(key: string, JSONmessage: NotificationMessageDetails, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.notificationmessages#outlook-office-notificationmessages-addasync-member(1))|Adds a notification to an item.| +||[getAllAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.notificationmessages#outlook-office-notificationmessages-getallasync-member(1))|Returns all keys and messages for an item.| +||[getAllAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.notificationmessages#outlook-office-notificationmessages-getallasync-member(1))|Returns all keys and messages for an item.| +||[removeAsync(key: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.notificationmessages#outlook-office-notificationmessages-removeasync-member(1))|Removes a notification message for an item.| +||[removeAsync(key: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.notificationmessages#outlook-office-notificationmessages-removeasync-member(1))|Removes a notification message for an item.| +||[replaceAsync(key: string, JSONmessage: NotificationMessageDetails, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.notificationmessages#outlook-office-notificationmessages-replaceasync-member(1))|Replaces a notification message that has a given key with another message.| +||[replaceAsync(key: string, JSONmessage: NotificationMessageDetails, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.notificationmessages#outlook-office-notificationmessages-replaceasync-member(1))|Replaces a notification message that has a given key with another message.| diff --git a/docs/includes/outlook-1_5.md b/docs/includes/outlook-1_5.md index bfdbe46607..c83ac295a3 100644 --- a/docs/includes/outlook-1_5.md +++ b/docs/includes/outlook-1_5.md @@ -1,21 +1,21 @@ | Class | Fields | Description | |:---|:---|:---| -|[DragAndDropEventArgs](/.draganddropeventargs)|[dragAndDropEventData](/.draganddropeventargs#outlook-javascript/api/outlook/-draganddropeventargs-draganddropeventdata-member)|Gets the details about the mouse pointer position within an add-in's task pane and the messages or file attachments being dragged and dropped into the task pane.| -||[type](/.draganddropeventargs#outlook-javascript/api/outlook/-draganddropeventargs-type-member)|Gets the type of the event.| -|[DragoverEventData](/.dragovereventdata)|[pageX](/.dragovereventdata#outlook-javascript/api/outlook/-dragovereventdata-pagex-member)|Gets the x-coordinate of the mouse pointer that represents the horizontal position in pixels.| -||[pageY](/.dragovereventdata#outlook-javascript/api/outlook/-dragovereventdata-pagey-member)|Gets the y-coordinate of the mouse pointer that represents the vertical position in pixels.| -||[type](/.dragovereventdata#outlook-javascript/api/outlook/-dragovereventdata-type-member)|Gets the type of drag-and-drop event.| -|[DropEventData](/.dropeventdata)|[dataTransfer](/.dropeventdata#outlook-javascript/api/outlook/-dropeventdata-datatransfer-member)|Gets the messages or file attachments being dragged and dropped into an add-in's task pane.| -||[pageX](/.dropeventdata#outlook-javascript/api/outlook/-dropeventdata-pagex-member)|Gets the x-coordinate of the mouse pointer that represents the horizontal position in pixels.| -||[pageY](/.dropeventdata#outlook-javascript/api/outlook/-dropeventdata-pagey-member)|Gets the y-coordinate of the mouse pointer that represents the vertical position in pixels.| -||[type](/.dropeventdata#outlook-javascript/api/outlook/-dropeventdata-type-member)|Gets the type of drag-and-drop event.| -|[DroppedItemDetails](/.droppeditemdetails)|[fileContent](/.droppeditemdetails#outlook-javascript/api/outlook/-droppeditemdetails-filecontent-member)|Gets the contents of the file being dragged and dropped.| -||[name](/.droppeditemdetails#outlook-javascript/api/outlook/-droppeditemdetails-name-member)|Gets the name of the file being dragged and dropped.| -||[type](/.droppeditemdetails#outlook-javascript/api/outlook/-droppeditemdetails-type-member)|Gets the type of the file being dragged and dropped.| -|[DroppedItems](/.droppeditems)|[files](/.droppeditems#outlook-javascript/api/outlook/-droppeditems-files-member)|Gets an array of the messages or file attachments being dragged and dropped into an add-in's task pane.| -|[Mailbox](/.mailbox)|[addHandlerAsync(eventType: Office.EventType \| string, handler: any, callback?: (asyncResult: Office.AsyncResult) => void)](/.mailbox#outlook-javascript/api/outlook/-mailbox-addhandlerasync-member(1))|Adds an event handler for a supported event.| -||[addHandlerAsync(eventType: Office.EventType \| string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.mailbox#outlook-javascript/api/outlook/-mailbox-addhandlerasync-member(1))|Adds an event handler for a supported event.| -||[getCallbackTokenAsync(options: Office.AsyncContextOptions & { isRest?: boolean }, callback: (asyncResult: Office.AsyncResult) => void)](/.mailbox#outlook-javascript/api/outlook/-mailbox-getcallbacktokenasync-member(1))|Gets a string that contains a token used to call REST APIs or Exchange Web Services (EWS).| -||[removeHandlerAsync(eventType: Office.EventType \| string, callback?: (asyncResult: Office.AsyncResult) => void)](/.mailbox#outlook-javascript/api/outlook/-mailbox-removehandlerasync-member(1))|Removes the event handlers for a supported event type.| -||[removeHandlerAsync(eventType: Office.EventType \| string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.mailbox#outlook-javascript/api/outlook/-mailbox-removehandlerasync-member(1))|Removes the event handlers for a supported event type.| -||[restUrl](/.mailbox#outlook-javascript/api/outlook/-mailbox-resturl-member)|Gets the URL of the REST endpoint for this email account.| +|[DragAndDropEventArgs](/javascript/api/outlook/office.draganddropeventargs)|[dragAndDropEventData](/javascript/api/outlook/office.draganddropeventargs#outlook-office-draganddropeventargs-draganddropeventdata-member)|Gets the details about the mouse pointer position within an add-in's task pane and the messages or file attachments being dragged and dropped into the task pane.| +||[type](/javascript/api/outlook/office.draganddropeventargs#outlook-office-draganddropeventargs-type-member)|Gets the type of the event.| +|[DragoverEventData](/javascript/api/outlook/office.dragovereventdata)|[pageX](/javascript/api/outlook/office.dragovereventdata#outlook-office-dragovereventdata-pagex-member)|Gets the x-coordinate of the mouse pointer that represents the horizontal position in pixels.| +||[pageY](/javascript/api/outlook/office.dragovereventdata#outlook-office-dragovereventdata-pagey-member)|Gets the y-coordinate of the mouse pointer that represents the vertical position in pixels.| +||[type](/javascript/api/outlook/office.dragovereventdata#outlook-office-dragovereventdata-type-member)|Gets the type of drag-and-drop event.| +|[DropEventData](/javascript/api/outlook/office.dropeventdata)|[dataTransfer](/javascript/api/outlook/office.dropeventdata#outlook-office-dropeventdata-datatransfer-member)|Gets the messages or file attachments being dragged and dropped into an add-in's task pane.| +||[pageX](/javascript/api/outlook/office.dropeventdata#outlook-office-dropeventdata-pagex-member)|Gets the x-coordinate of the mouse pointer that represents the horizontal position in pixels.| +||[pageY](/javascript/api/outlook/office.dropeventdata#outlook-office-dropeventdata-pagey-member)|Gets the y-coordinate of the mouse pointer that represents the vertical position in pixels.| +||[type](/javascript/api/outlook/office.dropeventdata#outlook-office-dropeventdata-type-member)|Gets the type of drag-and-drop event.| +|[DroppedItemDetails](/javascript/api/outlook/office.droppeditemdetails)|[fileContent](/javascript/api/outlook/office.droppeditemdetails#outlook-office-droppeditemdetails-filecontent-member)|Gets the contents of the file being dragged and dropped.| +||[name](/javascript/api/outlook/office.droppeditemdetails#outlook-office-droppeditemdetails-name-member)|Gets the name of the file being dragged and dropped.| +||[type](/javascript/api/outlook/office.droppeditemdetails#outlook-office-droppeditemdetails-type-member)|Gets the type of the file being dragged and dropped.| +|[DroppedItems](/javascript/api/outlook/office.droppeditems)|[files](/javascript/api/outlook/office.droppeditems#outlook-office-droppeditems-files-member)|Gets an array of the messages or file attachments being dragged and dropped into an add-in's task pane.| +|[Mailbox](/javascript/api/outlook/office.mailbox)|[addHandlerAsync(eventType: Office.EventType \| string, handler: any, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-addhandlerasync-member(1))|Adds an event handler for a supported event.| +||[addHandlerAsync(eventType: Office.EventType \| string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-addhandlerasync-member(1))|Adds an event handler for a supported event.| +||[getCallbackTokenAsync(options: Office.AsyncContextOptions & { isRest?: boolean }, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-getcallbacktokenasync-member(1))|Gets a string that contains a token used to call REST APIs or Exchange Web Services (EWS).| +||[removeHandlerAsync(eventType: Office.EventType \| string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-removehandlerasync-member(1))|Removes the event handlers for a supported event type.| +||[removeHandlerAsync(eventType: Office.EventType \| string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-removehandlerasync-member(1))|Removes the event handlers for a supported event type.| +||[restUrl](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-resturl-member)|Gets the URL of the REST endpoint for this email account.| diff --git a/docs/includes/outlook-1_6.md b/docs/includes/outlook-1_6.md index 5be42bb3b7..57378ca8a3 100644 --- a/docs/includes/outlook-1_6.md +++ b/docs/includes/outlook-1_6.md @@ -1,8 +1,8 @@ | Class | Fields | Description | |:---|:---|:---| -|[AppointmentRead](/.appointmentread)|[getSelectedEntities()](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-getselectedentities-member(1))|Gets the entities found in a highlighted match a user has selected.| -||[getSelectedRegExMatches()](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-getselectedregexmatches-member(1))|Returns string values in a highlighted match that match the regular expressions defined in an add-in only manifest file.| -|[Mailbox](/.mailbox)|[displayNewMessageForm(parameters: any)](/.mailbox#outlook-javascript/api/outlook/-mailbox-displaynewmessageform-member(1))|Displays a form for creating a new message.| -|[MessageRead](/.messageread)|[getSelectedEntities()](/.messageread#outlook-javascript/api/outlook/-messageread-getselectedentities-member(1))|Gets the entities found in a highlighted match a user has selected.| -||[getSelectedRegExMatches()](/.messageread#outlook-javascript/api/outlook/-messageread-getselectedregexmatches-member(1))|Returns string values in a highlighted match that match the regular expressions defined in an add-in only manifest file.| -|[UserProfile](/.userprofile)|[accountType](/.userprofile#outlook-javascript/api/outlook/-userprofile-accounttype-member)|Gets the account type of the user associated with the mailbox.| +|[AppointmentRead](/javascript/api/outlook/office.appointmentread)|[getSelectedEntities()](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-getselectedentities-member(1))|Gets the entities found in a highlighted match a user has selected.| +||[getSelectedRegExMatches()](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-getselectedregexmatches-member(1))|Returns string values in a highlighted match that match the regular expressions defined in an add-in only manifest file.| +|[Mailbox](/javascript/api/outlook/office.mailbox)|[displayNewMessageForm(parameters: any)](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-displaynewmessageform-member(1))|Displays a form for creating a new message.| +|[MessageRead](/javascript/api/outlook/office.messageread)|[getSelectedEntities()](/javascript/api/outlook/office.messageread#outlook-office-messageread-getselectedentities-member(1))|Gets the entities found in a highlighted match a user has selected.| +||[getSelectedRegExMatches()](/javascript/api/outlook/office.messageread#outlook-office-messageread-getselectedregexmatches-member(1))|Returns string values in a highlighted match that match the regular expressions defined in an add-in only manifest file.| +|[UserProfile](/javascript/api/outlook/office.userprofile)|[accountType](/javascript/api/outlook/office.userprofile#outlook-office-userprofile-accounttype-member)|Gets the account type of the user associated with the mailbox.| diff --git a/docs/includes/outlook-1_7.md b/docs/includes/outlook-1_7.md index 86cd3ce342..55ae134ebf 100644 --- a/docs/includes/outlook-1_7.md +++ b/docs/includes/outlook-1_7.md @@ -1,73 +1,73 @@ | Class | Fields | Description | |:---|:---|:---| -|[AppointmentCompose](/.appointmentcompose)|[addHandlerAsync(eventType: Office.EventType \| string, handler: any, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-addhandlerasync-member(1))|Adds an event handler for a supported event.| -||[addHandlerAsync(eventType: Office.EventType \| string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-addhandlerasync-member(1))|Adds an event handler for a supported event.| -||[organizer](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-organizer-member)|Gets the organizer for the specified meeting.| -||[recurrence](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-recurrence-member)|Gets or sets the recurrence pattern of an appointment.| -||[removeHandlerAsync(eventType: Office.EventType \| string, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-removehandlerasync-member(1))|Removes the event handlers for a supported event type.| -||[removeHandlerAsync(eventType: Office.EventType \| string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-removehandlerasync-member(1))|Removes the event handlers for a supported event type.| -||[seriesId](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-seriesid-member)|Gets the ID of the series that an instance belongs to.| -|[AppointmentRead](/.appointmentread)|[addHandlerAsync(eventType: Office.EventType \| string, handler: any, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-addhandlerasync-member(1))|Adds an event handler for a supported event.| -||[addHandlerAsync(eventType: Office.EventType \| string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-addhandlerasync-member(1))|Adds an event handler for a supported event.| -||[recurrence](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-recurrence-member)|Gets the recurrence pattern of an appointment.| -||[removeHandlerAsync(eventType: Office.EventType \| string, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-removehandlerasync-member(1))|Removes the event handlers for a supported event type.| -||[removeHandlerAsync(eventType: Office.EventType \| string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-removehandlerasync-member(1))|Removes the event handlers for a supported event type.| -||[seriesId](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-seriesid-member)|Gets the ID of the series that an instance belongs to.| -|[AppointmentTimeChangedEventArgs](/.appointmenttimechangedeventargs)|[end](/.appointmenttimechangedeventargs#outlook-javascript/api/outlook/-appointmenttimechangedeventargs-end-member)|Gets the appointment end date and time.| -||[start](/.appointmenttimechangedeventargs#outlook-javascript/api/outlook/-appointmenttimechangedeventargs-start-member)|Gets the appointment start date and time.| -||[type](/.appointmenttimechangedeventargs#outlook-javascript/api/outlook/-appointmenttimechangedeventargs-type-member)|Gets the type of the event.| -|[From](/.from)|[getAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/.from#outlook-javascript/api/outlook/-from-getasync-member(1))|Gets the from value of a message.| -||[getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.from#outlook-javascript/api/outlook/-from-getasync-member(1))|Gets the from value of a message.| -|[MessageCompose](/.messagecompose)|[addHandlerAsync(eventType: Office.EventType \| string, handler: any, callback?: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-addhandlerasync-member(1))|Adds an event handler for a supported event.| -||[addHandlerAsync(eventType: Office.EventType \| string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-addhandlerasync-member(1))|Adds an event handler for a supported event.| -||[from](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-from-member)|Gets the email address of the sender of a message.| -||[removeHandlerAsync(eventType: Office.EventType \| string, callback?: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-removehandlerasync-member(1))|Removes the event handlers for a supported event type.| -||[removeHandlerAsync(eventType: Office.EventType \| string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-removehandlerasync-member(1))|Removes the event handlers for a supported event type.| -||[seriesId](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-seriesid-member)|Gets the ID of the series that an instance belongs to.| -|[MessageRead](/.messageread)|[addHandlerAsync(eventType: Office.EventType \| string, handler: any, callback?: (asyncResult: Office.AsyncResult) => void)](/.messageread#outlook-javascript/api/outlook/-messageread-addhandlerasync-member(1))|Adds an event handler for a supported event.| -||[addHandlerAsync(eventType: Office.EventType \| string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.messageread#outlook-javascript/api/outlook/-messageread-addhandlerasync-member(1))|Adds an event handler for a supported event.| -||[recurrence](/.messageread#outlook-javascript/api/outlook/-messageread-recurrence-member)|Gets the recurrence pattern of an appointment.| -||[removeHandlerAsync(eventType: Office.EventType \| string, callback?: (asyncResult: Office.AsyncResult) => void)](/.messageread#outlook-javascript/api/outlook/-messageread-removehandlerasync-member(1))|Removes the event handlers for a supported event type.| -||[removeHandlerAsync(eventType: Office.EventType \| string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.messageread#outlook-javascript/api/outlook/-messageread-removehandlerasync-member(1))|Removes the event handlers for a supported event type.| -||[seriesId](/.messageread#outlook-javascript/api/outlook/-messageread-seriesid-member)|Gets the ID of the series that an instance belongs to.| -|[Organizer](/.organizer)|[getAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/.organizer#outlook-javascript/api/outlook/-organizer-getasync-member(1))|Gets the organizer value of an appointment as an {@link Office.EmailAddressDetails | EmailAddressDetails} object| -||[getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.organizer#outlook-javascript/api/outlook/-organizer-getasync-member(1))|Gets the organizer value of an appointment as an {@link Office.EmailAddressDetails | EmailAddressDetails} object| -|[RecipientsChangedEventArgs](/.recipientschangedeventargs)|[changedRecipientFields](/.recipientschangedeventargs#outlook-javascript/api/outlook/-recipientschangedeventargs-changedrecipientfields-member)|Gets an object that indicates change state of recipients fields.| -||[type](/.recipientschangedeventargs#outlook-javascript/api/outlook/-recipientschangedeventargs-type-member)|Gets the type of the event.| -|[RecipientsChangedFields](/.recipientschangedfields)|[bcc](/.recipientschangedfields#outlook-javascript/api/outlook/-recipientschangedfields-bcc-member)|Gets if recipients in the **bcc** field were changed.| -||[cc](/.recipientschangedfields#outlook-javascript/api/outlook/-recipientschangedfields-cc-member)|Gets if recipients in the **cc** field were changed.| -||[optionalAttendees](/.recipientschangedfields#outlook-javascript/api/outlook/-recipientschangedfields-optionalattendees-member)|Gets if optional attendees were changed.| -||[requiredAttendees](/.recipientschangedfields#outlook-javascript/api/outlook/-recipientschangedfields-requiredattendees-member)|Gets if required attendees were changed.| -||[resources](/.recipientschangedfields#outlook-javascript/api/outlook/-recipientschangedfields-resources-member)|Gets if resources were changed.| -||[to](/.recipientschangedfields#outlook-javascript/api/outlook/-recipientschangedfields-to-member)|Gets if recipients in the **to** field were changed.| -|[Recurrence](/.recurrence)|[getAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/.recurrence#outlook-javascript/api/outlook/-recurrence-getasync-member(1))|Returns the current recurrence object of an appointment series.| -||[getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.recurrence#outlook-javascript/api/outlook/-recurrence-getasync-member(1))|Returns the current recurrence object of an appointment series.| -||[recurrenceProperties](/.recurrence#outlook-javascript/api/outlook/-recurrence-recurrenceproperties-member)|Gets or sets the properties of the recurring appointment series.| -||[recurrenceTimeZone](/.recurrence#outlook-javascript/api/outlook/-recurrence-recurrencetimezone-member)|Gets or sets the properties of the recurring appointment series.| -||[recurrenceType](/.recurrence#outlook-javascript/api/outlook/-recurrence-recurrencetype-member)|Gets or sets the type of the recurring appointment series.| -||[seriesTime](/.recurrence#outlook-javascript/api/outlook/-recurrence-seriestime-member)|The {@link Office.SeriesTime | SeriesTime} object enables you to manage the start and end dates of the recurring appointment series and| -||[setAsync(recurrencePattern: Recurrence, callback?: (asyncResult: Office.AsyncResult) => void)](/.recurrence#outlook-javascript/api/outlook/-recurrence-setasync-member(1))|Sets the recurrence pattern of an appointment series.| -||[setAsync(recurrencePattern: Recurrence, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.recurrence#outlook-javascript/api/outlook/-recurrence-setasync-member(1))|Sets the recurrence pattern of an appointment series.| -|[RecurrenceChangedEventArgs](/.recurrencechangedeventargs)|[recurrence](/.recurrencechangedeventargs#outlook-javascript/api/outlook/-recurrencechangedeventargs-recurrence-member)|Gets the updated recurrence object.| -||[type](/.recurrencechangedeventargs#outlook-javascript/api/outlook/-recurrencechangedeventargs-type-member)|Gets the type of the event.| -|[RecurrenceProperties](/.recurrenceproperties)|[dayOfMonth](/.recurrenceproperties#outlook-javascript/api/outlook/-recurrenceproperties-dayofmonth-member)|Represents the day of the month.| -||[dayOfWeek](/.recurrenceproperties#outlook-javascript/api/outlook/-recurrenceproperties-dayofweek-member)|Represents the day of the week or type of day, for example, weekend day vs weekday.| -||[days](/.recurrenceproperties#outlook-javascript/api/outlook/-recurrenceproperties-days-member)|Represents the set of days for this recurrence.| -||[firstDayOfWeek](/.recurrenceproperties#outlook-javascript/api/outlook/-recurrenceproperties-firstdayofweek-member)|Represents your chosen first day of the week otherwise the default is the value in the current user's settings.| -||[interval](/.recurrenceproperties#outlook-javascript/api/outlook/-recurrenceproperties-interval-member)|Represents the period between instances of the same recurring series.| -||[month](/.recurrenceproperties#outlook-javascript/api/outlook/-recurrenceproperties-month-member)|Represents the month.| -||[weekNumber](/.recurrenceproperties#outlook-javascript/api/outlook/-recurrenceproperties-weeknumber-member)|Represents the number of the week in the selected month e.g., 'first' for first week of the month.| -|[RecurrenceTimeZone](/.recurrencetimezone)|[name](/.recurrencetimezone#outlook-javascript/api/outlook/-recurrencetimezone-name-member)|Represents the name of the recurrence time zone.| -||[offset](/.recurrencetimezone#outlook-javascript/api/outlook/-recurrencetimezone-offset-member)|Integer value representing the difference in minutes between the local time zone and UTC at the date that the meeting series began.| -|[SeriesTime](/.seriestime)|[getDuration()](/.seriestime#outlook-javascript/api/outlook/-seriestime-getduration-member(1))|Gets the duration in minutes of a usual instance in a recurring appointment series.| -||[getEndDate()](/.seriestime#outlook-javascript/api/outlook/-seriestime-getenddate-member(1))|Gets the end date of a recurrence pattern in the following| -||[getEndTime()](/.seriestime#outlook-javascript/api/outlook/-seriestime-getendtime-member(1))|Gets the end time of a usual appointment or meeting request instance of a recurrence pattern in whichever time zone that the user or| -||[getStartDate()](/.seriestime#outlook-javascript/api/outlook/-seriestime-getstartdate-member(1))|Gets the start date of a recurrence pattern in the following| -||[getStartTime()](/.seriestime#outlook-javascript/api/outlook/-seriestime-getstarttime-member(1))|Gets the start time of a usual appointment instance of a recurrence pattern in whichever time zone that the user/add-in set the| -||[setDuration(minutes: number)](/.seriestime#outlook-javascript/api/outlook/-seriestime-setduration-member(1))|Sets the duration of all appointments in a recurrence pattern.| -||[setEndDate(date: string)](/.seriestime#outlook-javascript/api/outlook/-seriestime-setenddate-member(1))|Sets the end date of a recurring appointment series.| -||[setEndDate(year: number, month: number, day: number)](/.seriestime#outlook-javascript/api/outlook/-seriestime-setenddate-member(1))|Sets the end date of a recurring appointment series.| -||[setStartDate(date:string)](/.seriestime#outlook-javascript/api/outlook/-seriestime-setstartdate-member(1))|Sets the start date of a recurring appointment series.| -||[setStartDate(year:number, month:number, day:number)](/.seriestime#outlook-javascript/api/outlook/-seriestime-setstartdate-member(1))|Sets the start date of a recurring appointment series.| -||[setStartTime(hours: number, minutes: number)](/.seriestime#outlook-javascript/api/outlook/-seriestime-setstarttime-member(1))|Sets the start time of all instances of a recurring appointment series in whichever time zone the recurrence pattern is set| -||[setStartTime(time: string)](/.seriestime#outlook-javascript/api/outlook/-seriestime-setstarttime-member(1))|Sets the start time of all instances of a recurring appointment series in whichever time zone the recurrence pattern is set| +|[AppointmentCompose](/javascript/api/outlook/office.appointmentcompose)|[addHandlerAsync(eventType: Office.EventType \| string, handler: any, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-addhandlerasync-member(1))|Adds an event handler for a supported event.| +||[addHandlerAsync(eventType: Office.EventType \| string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-addhandlerasync-member(1))|Adds an event handler for a supported event.| +||[organizer](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-organizer-member)|Gets the organizer for the specified meeting.| +||[recurrence](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-recurrence-member)|Gets or sets the recurrence pattern of an appointment.| +||[removeHandlerAsync(eventType: Office.EventType \| string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-removehandlerasync-member(1))|Removes the event handlers for a supported event type.| +||[removeHandlerAsync(eventType: Office.EventType \| string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-removehandlerasync-member(1))|Removes the event handlers for a supported event type.| +||[seriesId](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-seriesid-member)|Gets the ID of the series that an instance belongs to.| +|[AppointmentRead](/javascript/api/outlook/office.appointmentread)|[addHandlerAsync(eventType: Office.EventType \| string, handler: any, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-addhandlerasync-member(1))|Adds an event handler for a supported event.| +||[addHandlerAsync(eventType: Office.EventType \| string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-addhandlerasync-member(1))|Adds an event handler for a supported event.| +||[recurrence](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-recurrence-member)|Gets the recurrence pattern of an appointment.| +||[removeHandlerAsync(eventType: Office.EventType \| string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-removehandlerasync-member(1))|Removes the event handlers for a supported event type.| +||[removeHandlerAsync(eventType: Office.EventType \| string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-removehandlerasync-member(1))|Removes the event handlers for a supported event type.| +||[seriesId](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-seriesid-member)|Gets the ID of the series that an instance belongs to.| +|[AppointmentTimeChangedEventArgs](/javascript/api/outlook/office.appointmenttimechangedeventargs)|[end](/javascript/api/outlook/office.appointmenttimechangedeventargs#outlook-office-appointmenttimechangedeventargs-end-member)|Gets the appointment end date and time.| +||[start](/javascript/api/outlook/office.appointmenttimechangedeventargs#outlook-office-appointmenttimechangedeventargs-start-member)|Gets the appointment start date and time.| +||[type](/javascript/api/outlook/office.appointmenttimechangedeventargs#outlook-office-appointmenttimechangedeventargs-type-member)|Gets the type of the event.| +|[From](/javascript/api/outlook/office.from)|[getAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.from#outlook-office-from-getasync-member(1))|Gets the from value of a message.| +||[getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.from#outlook-office-from-getasync-member(1))|Gets the from value of a message.| +|[MessageCompose](/javascript/api/outlook/office.messagecompose)|[addHandlerAsync(eventType: Office.EventType \| string, handler: any, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-addhandlerasync-member(1))|Adds an event handler for a supported event.| +||[addHandlerAsync(eventType: Office.EventType \| string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-addhandlerasync-member(1))|Adds an event handler for a supported event.| +||[from](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-from-member)|Gets the email address of the sender of a message.| +||[removeHandlerAsync(eventType: Office.EventType \| string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-removehandlerasync-member(1))|Removes the event handlers for a supported event type.| +||[removeHandlerAsync(eventType: Office.EventType \| string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-removehandlerasync-member(1))|Removes the event handlers for a supported event type.| +||[seriesId](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-seriesid-member)|Gets the ID of the series that an instance belongs to.| +|[MessageRead](/javascript/api/outlook/office.messageread)|[addHandlerAsync(eventType: Office.EventType \| string, handler: any, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messageread#outlook-office-messageread-addhandlerasync-member(1))|Adds an event handler for a supported event.| +||[addHandlerAsync(eventType: Office.EventType \| string, handler: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messageread#outlook-office-messageread-addhandlerasync-member(1))|Adds an event handler for a supported event.| +||[recurrence](/javascript/api/outlook/office.messageread#outlook-office-messageread-recurrence-member)|Gets the recurrence pattern of an appointment.| +||[removeHandlerAsync(eventType: Office.EventType \| string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messageread#outlook-office-messageread-removehandlerasync-member(1))|Removes the event handlers for a supported event type.| +||[removeHandlerAsync(eventType: Office.EventType \| string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messageread#outlook-office-messageread-removehandlerasync-member(1))|Removes the event handlers for a supported event type.| +||[seriesId](/javascript/api/outlook/office.messageread#outlook-office-messageread-seriesid-member)|Gets the ID of the series that an instance belongs to.| +|[Organizer](/javascript/api/outlook/office.organizer)|[getAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.organizer#outlook-office-organizer-getasync-member(1))|Gets the organizer value of an appointment as an {@link Office.EmailAddressDetails | EmailAddressDetails} object| +||[getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.organizer#outlook-office-organizer-getasync-member(1))|Gets the organizer value of an appointment as an {@link Office.EmailAddressDetails | EmailAddressDetails} object| +|[RecipientsChangedEventArgs](/javascript/api/outlook/office.recipientschangedeventargs)|[changedRecipientFields](/javascript/api/outlook/office.recipientschangedeventargs#outlook-office-recipientschangedeventargs-changedrecipientfields-member)|Gets an object that indicates change state of recipients fields.| +||[type](/javascript/api/outlook/office.recipientschangedeventargs#outlook-office-recipientschangedeventargs-type-member)|Gets the type of the event.| +|[RecipientsChangedFields](/javascript/api/outlook/office.recipientschangedfields)|[bcc](/javascript/api/outlook/office.recipientschangedfields#outlook-office-recipientschangedfields-bcc-member)|Gets if recipients in the **bcc** field were changed.| +||[cc](/javascript/api/outlook/office.recipientschangedfields#outlook-office-recipientschangedfields-cc-member)|Gets if recipients in the **cc** field were changed.| +||[optionalAttendees](/javascript/api/outlook/office.recipientschangedfields#outlook-office-recipientschangedfields-optionalattendees-member)|Gets if optional attendees were changed.| +||[requiredAttendees](/javascript/api/outlook/office.recipientschangedfields#outlook-office-recipientschangedfields-requiredattendees-member)|Gets if required attendees were changed.| +||[resources](/javascript/api/outlook/office.recipientschangedfields#outlook-office-recipientschangedfields-resources-member)|Gets if resources were changed.| +||[to](/javascript/api/outlook/office.recipientschangedfields#outlook-office-recipientschangedfields-to-member)|Gets if recipients in the **to** field were changed.| +|[Recurrence](/javascript/api/outlook/office.recurrence)|[getAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.recurrence#outlook-office-recurrence-getasync-member(1))|Returns the current recurrence object of an appointment series.| +||[getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.recurrence#outlook-office-recurrence-getasync-member(1))|Returns the current recurrence object of an appointment series.| +||[recurrenceProperties](/javascript/api/outlook/office.recurrence#outlook-office-recurrence-recurrenceproperties-member)|Gets or sets the properties of the recurring appointment series.| +||[recurrenceTimeZone](/javascript/api/outlook/office.recurrence#outlook-office-recurrence-recurrencetimezone-member)|Gets or sets the properties of the recurring appointment series.| +||[recurrenceType](/javascript/api/outlook/office.recurrence#outlook-office-recurrence-recurrencetype-member)|Gets or sets the type of the recurring appointment series.| +||[seriesTime](/javascript/api/outlook/office.recurrence#outlook-office-recurrence-seriestime-member)|The {@link Office.SeriesTime | SeriesTime} object enables you to manage the start and end dates of the recurring appointment series and| +||[setAsync(recurrencePattern: Recurrence, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.recurrence#outlook-office-recurrence-setasync-member(1))|Sets the recurrence pattern of an appointment series.| +||[setAsync(recurrencePattern: Recurrence, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.recurrence#outlook-office-recurrence-setasync-member(1))|Sets the recurrence pattern of an appointment series.| +|[RecurrenceChangedEventArgs](/javascript/api/outlook/office.recurrencechangedeventargs)|[recurrence](/javascript/api/outlook/office.recurrencechangedeventargs#outlook-office-recurrencechangedeventargs-recurrence-member)|Gets the updated recurrence object.| +||[type](/javascript/api/outlook/office.recurrencechangedeventargs#outlook-office-recurrencechangedeventargs-type-member)|Gets the type of the event.| +|[RecurrenceProperties](/javascript/api/outlook/office.recurrenceproperties)|[dayOfMonth](/javascript/api/outlook/office.recurrenceproperties#outlook-office-recurrenceproperties-dayofmonth-member)|Represents the day of the month.| +||[dayOfWeek](/javascript/api/outlook/office.recurrenceproperties#outlook-office-recurrenceproperties-dayofweek-member)|Represents the day of the week or type of day, for example, weekend day vs weekday.| +||[days](/javascript/api/outlook/office.recurrenceproperties#outlook-office-recurrenceproperties-days-member)|Represents the set of days for this recurrence.| +||[firstDayOfWeek](/javascript/api/outlook/office.recurrenceproperties#outlook-office-recurrenceproperties-firstdayofweek-member)|Represents your chosen first day of the week otherwise the default is the value in the current user's settings.| +||[interval](/javascript/api/outlook/office.recurrenceproperties#outlook-office-recurrenceproperties-interval-member)|Represents the period between instances of the same recurring series.| +||[month](/javascript/api/outlook/office.recurrenceproperties#outlook-office-recurrenceproperties-month-member)|Represents the month.| +||[weekNumber](/javascript/api/outlook/office.recurrenceproperties#outlook-office-recurrenceproperties-weeknumber-member)|Represents the number of the week in the selected month e.g., 'first' for first week of the month.| +|[RecurrenceTimeZone](/javascript/api/outlook/office.recurrencetimezone)|[name](/javascript/api/outlook/office.recurrencetimezone#outlook-office-recurrencetimezone-name-member)|Represents the name of the recurrence time zone.| +||[offset](/javascript/api/outlook/office.recurrencetimezone#outlook-office-recurrencetimezone-offset-member)|Integer value representing the difference in minutes between the local time zone and UTC at the date that the meeting series began.| +|[SeriesTime](/javascript/api/outlook/office.seriestime)|[getDuration()](/javascript/api/outlook/office.seriestime#outlook-office-seriestime-getduration-member(1))|Gets the duration in minutes of a usual instance in a recurring appointment series.| +||[getEndDate()](/javascript/api/outlook/office.seriestime#outlook-office-seriestime-getenddate-member(1))|Gets the end date of a recurrence pattern in the following| +||[getEndTime()](/javascript/api/outlook/office.seriestime#outlook-office-seriestime-getendtime-member(1))|Gets the end time of a usual appointment or meeting request instance of a recurrence pattern in whichever time zone that the user or| +||[getStartDate()](/javascript/api/outlook/office.seriestime#outlook-office-seriestime-getstartdate-member(1))|Gets the start date of a recurrence pattern in the following| +||[getStartTime()](/javascript/api/outlook/office.seriestime#outlook-office-seriestime-getstarttime-member(1))|Gets the start time of a usual appointment instance of a recurrence pattern in whichever time zone that the user/add-in set the| +||[setDuration(minutes: number)](/javascript/api/outlook/office.seriestime#outlook-office-seriestime-setduration-member(1))|Sets the duration of all appointments in a recurrence pattern.| +||[setEndDate(date: string)](/javascript/api/outlook/office.seriestime#outlook-office-seriestime-setenddate-member(1))|Sets the end date of a recurring appointment series.| +||[setEndDate(year: number, month: number, day: number)](/javascript/api/outlook/office.seriestime#outlook-office-seriestime-setenddate-member(1))|Sets the end date of a recurring appointment series.| +||[setStartDate(date:string)](/javascript/api/outlook/office.seriestime#outlook-office-seriestime-setstartdate-member(1))|Sets the start date of a recurring appointment series.| +||[setStartDate(year:number, month:number, day:number)](/javascript/api/outlook/office.seriestime#outlook-office-seriestime-setstartdate-member(1))|Sets the start date of a recurring appointment series.| +||[setStartTime(hours: number, minutes: number)](/javascript/api/outlook/office.seriestime#outlook-office-seriestime-setstarttime-member(1))|Sets the start time of all instances of a recurring appointment series in whichever time zone the recurrence pattern is set| +||[setStartTime(time: string)](/javascript/api/outlook/office.seriestime#outlook-office-seriestime-setstarttime-member(1))|Sets the start time of all instances of a recurring appointment series in whichever time zone the recurrence pattern is set| diff --git a/docs/includes/outlook-1_8.md b/docs/includes/outlook-1_8.md index 6f3b5d54f2..21ae3454e8 100644 --- a/docs/includes/outlook-1_8.md +++ b/docs/includes/outlook-1_8.md @@ -1,96 +1,96 @@ | Class | Fields | Description | |:---|:---|:---| -|[AppointmentCompose](/.appointmentcompose)|[addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-addfileattachmentfrombase64async-member(1))|Adds a file to a message or appointment as an attachment.| -||[addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-addfileattachmentfrombase64async-member(1))|Adds a file to a message or appointment as an attachment.| -||[categories](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-categories-member)|Gets an object that provides methods for managing the item's categories.| -||[enhancedLocation](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-enhancedlocation-member)|Gets or sets the locations of the appointment.| -||[getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-getattachmentcontentasync-member(1))|Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.| -||[getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-getattachmentcontentasync-member(1))|Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.| -||[getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-getattachmentsasync-member(1))|Gets the item's attachments as an array.| -||[getAttachmentsAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-getattachmentsasync-member(1))|Gets the item's attachments as an array.| -||[getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-getinitializationcontextasync-member(1))|Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.| -||[getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-getinitializationcontextasync-member(1))|Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.| -||[getItemIdAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-getitemidasync-member(1))|Asynchronously gets the {@link https://learn.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | Exchange Web Services (EWS) item identifier}| -||[getItemIdAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-getitemidasync-member(1))|Asynchronously gets the {@link https://learn.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | Exchange Web Services (EWS) item identifier}| -||[getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-getsharedpropertiesasync-member(1))|Gets the properties of an appointment or message in a shared folder or shared mailbox.| -||[getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-getsharedpropertiesasync-member(1))|Gets the properties of an appointment or message in a shared folder or shared mailbox.| -|[AppointmentRead](/.appointmentread)|[categories](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-categories-member)|Gets an object that provides methods for managing the item's categories.| -||[enhancedLocation](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-enhancedlocation-member)|Gets the locations of an appointment.| -||[getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-getattachmentcontentasync-member(1))|Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.| -||[getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-getattachmentcontentasync-member(1))|Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.| -||[getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-getinitializationcontextasync-member(1))|Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.| -||[getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-getinitializationcontextasync-member(1))|Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.| -||[getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-getsharedpropertiesasync-member(1))|Gets the properties of an appointment or message in a shared folder or shared mailbox.| -||[getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-getsharedpropertiesasync-member(1))|Gets the properties of an appointment or message in a shared folder or shared mailbox.| -|[AttachmentContent](/.attachmentcontent)|[content](/.attachmentcontent#outlook-javascript/api/outlook/-attachmentcontent-content-member)|The content of an attachment as a string.| -||[format](/.attachmentcontent#outlook-javascript/api/outlook/-attachmentcontent-format-member)|The string format to use for an attachment's content.| -|[AttachmentDetailsCompose](/.attachmentdetailscompose)|[attachmentType](/.attachmentdetailscompose#outlook-javascript/api/outlook/-attachmentdetailscompose-attachmenttype-member)|Gets a value that indicates the attachment's type.| -||[id](/.attachmentdetailscompose#outlook-javascript/api/outlook/-attachmentdetailscompose-id-member)|Gets the index of the attachment.| -||[isInline](/.attachmentdetailscompose#outlook-javascript/api/outlook/-attachmentdetailscompose-isinline-member)|Gets a value that indicates whether the attachment appears as an image in the body of the item instead of in the attachment list.| -||[name](/.attachmentdetailscompose#outlook-javascript/api/outlook/-attachmentdetailscompose-name-member)|Gets the name of the attachment.| -||[size](/.attachmentdetailscompose#outlook-javascript/api/outlook/-attachmentdetailscompose-size-member)|Gets the size of the attachment in bytes.| -||[url](/.attachmentdetailscompose#outlook-javascript/api/outlook/-attachmentdetailscompose-url-member)|Gets the url of the attachment if its type is `MailboxEnums.AttachmentType.Cloud`.| -|[AttachmentsChangedEventArgs](/.attachmentschangedeventargs)|[attachmentDetails](/.attachmentschangedeventargs#outlook-javascript/api/outlook/-attachmentschangedeventargs-attachmentdetails-member)|Gets the object that represents the attachment that was added or removed from| -||[attachmentStatus](/.attachmentschangedeventargs#outlook-javascript/api/outlook/-attachmentschangedeventargs-attachmentstatus-member)|Specifies whether the attachment was added or removed from a mail item.| -||[type](/.attachmentschangedeventargs#outlook-javascript/api/outlook/-attachmentschangedeventargs-type-member)|Gets the type of event that was raised.| -|[Categories](/.categories)|[addAsync(categories: string[], callback?: (asyncResult: Office.AsyncResult) => void)](/.categories#outlook-javascript/api/outlook/-categories-addasync-member(1))|Adds categories to an item.| -||[addAsync(categories: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.categories#outlook-javascript/api/outlook/-categories-addasync-member(1))|Adds categories to an item.| -||[getAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.categories#outlook-javascript/api/outlook/-categories-getasync-member(1))|Gets an item's categories.| -||[getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.categories#outlook-javascript/api/outlook/-categories-getasync-member(1))|Gets an item's categories.| -||[removeAsync(categories: string[], callback?: (asyncResult: Office.AsyncResult) => void)](/.categories#outlook-javascript/api/outlook/-categories-removeasync-member(1))|Removes categories from an item.| -||[removeAsync(categories: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.categories#outlook-javascript/api/outlook/-categories-removeasync-member(1))|Removes categories from an item.| -|[CategoryDetails](/.categorydetails)|[color](/.categorydetails#outlook-javascript/api/outlook/-categorydetails-color-member)|The color of the category.| -||[displayName](/.categorydetails#outlook-javascript/api/outlook/-categorydetails-displayname-member)|The name of the category.| -|[EnhancedLocation](/.enhancedlocation)|[addAsync(locationIdentifiers: LocationIdentifier[], callback?: (asyncResult: Office.AsyncResult) => void)](/.enhancedlocation#outlook-javascript/api/outlook/-enhancedlocation-addasync-member(1))|Adds to the set of locations associated with the appointment.| -||[addAsync(locationIdentifiers: LocationIdentifier[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.enhancedlocation#outlook-javascript/api/outlook/-enhancedlocation-addasync-member(1))|Adds to the set of locations associated with the appointment.| -||[getAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/.enhancedlocation#outlook-javascript/api/outlook/-enhancedlocation-getasync-member(1))|Gets the set of locations associated with the appointment.| -||[getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.enhancedlocation#outlook-javascript/api/outlook/-enhancedlocation-getasync-member(1))|Gets the set of locations associated with the appointment.| -||[removeAsync(locationIdentifiers: LocationIdentifier[], callback?: (asyncResult: Office.AsyncResult) => void)](/.enhancedlocation#outlook-javascript/api/outlook/-enhancedlocation-removeasync-member(1))|Removes the set of locations associated with the appointment.| -||[removeAsync(locationIdentifiers: LocationIdentifier[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.enhancedlocation#outlook-javascript/api/outlook/-enhancedlocation-removeasync-member(1))|Removes the set of locations associated with the appointment.| -|[EnhancedLocationsChangedEventArgs](/.enhancedlocationschangedeventargs)|[enhancedLocations](/.enhancedlocationschangedeventargs#outlook-javascript/api/outlook/-enhancedlocationschangedeventargs-enhancedlocations-member)|Gets the set of enhanced locations.| -||[type](/.enhancedlocationschangedeventargs#outlook-javascript/api/outlook/-enhancedlocationschangedeventargs-type-member)|Gets the type of the event.| -|[InternetHeaders](/.internetheaders)|[getAsync(names: string[], callback: (asyncResult: Office.AsyncResult>) => void)](/.internetheaders#outlook-javascript/api/outlook/-internetheaders-getasync-member(1))|Given an array of internet header names, this method returns a record containing those internet headers and their values.| -||[getAsync(names: string[], options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult>) => void)](/.internetheaders#outlook-javascript/api/outlook/-internetheaders-getasync-member(1))|Given an array of internet header names, this method returns a record containing those internet headers and their values.| -||[removeAsync(names: string[], callback?: (asyncResult: Office.AsyncResult) => void)](/.internetheaders#outlook-javascript/api/outlook/-internetheaders-removeasync-member(1))|Given an array of internet header names, this method removes the specified headers from the internet header collection.| -||[removeAsync(names: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.internetheaders#outlook-javascript/api/outlook/-internetheaders-removeasync-member(1))|Given an array of internet header names, this method removes the specified headers from the internet header collection.| -||[setAsync(headers: Record, callback?: (asyncResult: Office.AsyncResult) => void)](/.internetheaders#outlook-javascript/api/outlook/-internetheaders-setasync-member(1))|Sets the specified internet headers to the specified values.| -||[setAsync(headers: Record, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.internetheaders#outlook-javascript/api/outlook/-internetheaders-setasync-member(1))|Sets the specified internet headers to the specified values.| -|[LocationDetails](/.locationdetails)|[displayName](/.locationdetails#outlook-javascript/api/outlook/-locationdetails-displayname-member)|The location's display name.| -||[emailAddress](/.locationdetails#outlook-javascript/api/outlook/-locationdetails-emailaddress-member)|The email address associated with the location.| -||[locationIdentifier](/.locationdetails#outlook-javascript/api/outlook/-locationdetails-locationidentifier-member)|The `LocationIdentifier` of the location.| -|[LocationIdentifier](/.locationidentifier)|[id](/.locationidentifier#outlook-javascript/api/outlook/-locationidentifier-id-member)|The location's unique ID.| -||[type](/.locationidentifier#outlook-javascript/api/outlook/-locationidentifier-type-member)|The location's type.| -|[Mailbox](/.mailbox)|[masterCategories](/.mailbox#outlook-javascript/api/outlook/-mailbox-mastercategories-member)|Gets an object that provides methods to manage the categories master list associated with a mailbox.| -|[MasterCategories](/.mastercategories)|[addAsync(categories: CategoryDetails[], callback?: (asyncResult: Office.AsyncResult) => void)](/.mastercategories#outlook-javascript/api/outlook/-mastercategories-addasync-member(1))|Adds categories to the master list on a mailbox.| -||[addAsync(categories: CategoryDetails[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.mastercategories#outlook-javascript/api/outlook/-mastercategories-addasync-member(1))|Adds categories to the master list on a mailbox.| -||[getAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.mastercategories#outlook-javascript/api/outlook/-mastercategories-getasync-member(1))|Gets the master list of categories on a mailbox.| -||[getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.mastercategories#outlook-javascript/api/outlook/-mastercategories-getasync-member(1))|Gets the master list of categories on a mailbox.| -||[removeAsync(categories: string[], callback?: (asyncResult: Office.AsyncResult) => void)](/.mastercategories#outlook-javascript/api/outlook/-mastercategories-removeasync-member(1))|Removes categories from the master list on a mailbox.| -||[removeAsync(categories: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.mastercategories#outlook-javascript/api/outlook/-mastercategories-removeasync-member(1))|Removes categories from the master list on a mailbox.| -|[MessageCompose](/.messagecompose)|[addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-addfileattachmentfrombase64async-member(1))|Adds a file to a message or appointment as an attachment.| -||[addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-addfileattachmentfrombase64async-member(1))|Adds a file to a message or appointment as an attachment.| -||[categories](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-categories-member)|Gets an object that provides methods for managing the item's categories.| -||[getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-getattachmentcontentasync-member(1))|Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.| -||[getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-getattachmentcontentasync-member(1))|Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.| -||[getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-getattachmentsasync-member(1))|Gets the item's attachments as an array.| -||[getAttachmentsAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-getattachmentsasync-member(1))|Gets the item's attachments as an array.| -||[getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-getinitializationcontextasync-member(1))|Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.| -||[getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-getinitializationcontextasync-member(1))|Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.| -||[getItemIdAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-getitemidasync-member(1))|Asynchronously gets the {@link https://learn.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | Exchange Web Services (EWS) item identifier}| -||[getItemIdAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-getitemidasync-member(1))|Asynchronously gets the {@link https://learn.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | Exchange Web Services (EWS) item identifier}| -||[getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-getsharedpropertiesasync-member(1))|Gets the properties of an appointment or message in a shared folder or shared mailbox.| -||[getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-getsharedpropertiesasync-member(1))|Gets the properties of an appointment or message in a shared folder or shared mailbox.| -||[internetHeaders](/.messagecompose#outlook-javascript/api/outlook/-messagecompose-internetheaders-member)|Gets or sets the custom internet headers of a message.| -|[MessageRead](/.messageread)|[categories](/.messageread#outlook-javascript/api/outlook/-messageread-categories-member)|Gets an object that provides methods for managing the item's categories.| -||[getAllInternetHeadersAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/.messageread#outlook-javascript/api/outlook/-messageread-getallinternetheadersasync-member(1))|Gets all the internet headers for the message as a string.| -||[getAllInternetHeadersAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.messageread#outlook-javascript/api/outlook/-messageread-getallinternetheadersasync-member(1))|Gets all the internet headers for the message as a string.| -||[getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.messageread#outlook-javascript/api/outlook/-messageread-getattachmentcontentasync-member(1))|Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.| -||[getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.messageread#outlook-javascript/api/outlook/-messageread-getattachmentcontentasync-member(1))|Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.| -||[getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.messageread#outlook-javascript/api/outlook/-messageread-getinitializationcontextasync-member(1))|Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.| -||[getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.messageread#outlook-javascript/api/outlook/-messageread-getinitializationcontextasync-member(1))|Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.| -||[getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.messageread#outlook-javascript/api/outlook/-messageread-getsharedpropertiesasync-member(1))|Gets the properties of an appointment or message in a shared folder or shared mailbox.| -||[getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.messageread#outlook-javascript/api/outlook/-messageread-getsharedpropertiesasync-member(1))|Gets the properties of an appointment or message in a shared folder or shared mailbox.| -|[SharedProperties](/.sharedproperties)|[delegatePermissions](/.sharedproperties#outlook-javascript/api/outlook/-sharedproperties-delegatepermissions-member)|The permissions that the delegate has on a shared folder, or the user has on a shared mailbox.| -||[owner](/.sharedproperties#outlook-javascript/api/outlook/-sharedproperties-owner-member)|The email address of the owner of a shared item.| -||[targetMailbox](/.sharedproperties#outlook-javascript/api/outlook/-sharedproperties-targetmailbox-member)|The location of the owner's mailbox for the delegate's access.| -||[targetRestUrl](/.sharedproperties#outlook-javascript/api/outlook/-sharedproperties-targetresturl-member)|The REST API's base URL (currently `https://outlook.office.com/api`).| +|[AppointmentCompose](/javascript/api/outlook/office.appointmentcompose)|[addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-addfileattachmentfrombase64async-member(1))|Adds a file to a message or appointment as an attachment.| +||[addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-addfileattachmentfrombase64async-member(1))|Adds a file to a message or appointment as an attachment.| +||[categories](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-categories-member)|Gets an object that provides methods for managing the item's categories.| +||[enhancedLocation](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-enhancedlocation-member)|Gets or sets the locations of the appointment.| +||[getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-getattachmentcontentasync-member(1))|Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.| +||[getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-getattachmentcontentasync-member(1))|Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.| +||[getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-getattachmentsasync-member(1))|Gets the item's attachments as an array.| +||[getAttachmentsAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-getattachmentsasync-member(1))|Gets the item's attachments as an array.| +||[getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-getinitializationcontextasync-member(1))|Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.| +||[getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-getinitializationcontextasync-member(1))|Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.| +||[getItemIdAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-getitemidasync-member(1))|Asynchronously gets the {@link https://learn.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | Exchange Web Services (EWS) item identifier}| +||[getItemIdAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-getitemidasync-member(1))|Asynchronously gets the {@link https://learn.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | Exchange Web Services (EWS) item identifier}| +||[getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-getsharedpropertiesasync-member(1))|Gets the properties of an appointment or message in a shared folder or shared mailbox.| +||[getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-getsharedpropertiesasync-member(1))|Gets the properties of an appointment or message in a shared folder or shared mailbox.| +|[AppointmentRead](/javascript/api/outlook/office.appointmentread)|[categories](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-categories-member)|Gets an object that provides methods for managing the item's categories.| +||[enhancedLocation](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-enhancedlocation-member)|Gets the locations of an appointment.| +||[getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-getattachmentcontentasync-member(1))|Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.| +||[getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-getattachmentcontentasync-member(1))|Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.| +||[getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-getinitializationcontextasync-member(1))|Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.| +||[getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-getinitializationcontextasync-member(1))|Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.| +||[getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-getsharedpropertiesasync-member(1))|Gets the properties of an appointment or message in a shared folder or shared mailbox.| +||[getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-getsharedpropertiesasync-member(1))|Gets the properties of an appointment or message in a shared folder or shared mailbox.| +|[AttachmentContent](/javascript/api/outlook/office.attachmentcontent)|[content](/javascript/api/outlook/office.attachmentcontent#outlook-office-attachmentcontent-content-member)|The content of an attachment as a string.| +||[format](/javascript/api/outlook/office.attachmentcontent#outlook-office-attachmentcontent-format-member)|The string format to use for an attachment's content.| +|[AttachmentDetailsCompose](/javascript/api/outlook/office.attachmentdetailscompose)|[attachmentType](/javascript/api/outlook/office.attachmentdetailscompose#outlook-office-attachmentdetailscompose-attachmenttype-member)|Gets a value that indicates the attachment's type.| +||[id](/javascript/api/outlook/office.attachmentdetailscompose#outlook-office-attachmentdetailscompose-id-member)|Gets the index of the attachment.| +||[isInline](/javascript/api/outlook/office.attachmentdetailscompose#outlook-office-attachmentdetailscompose-isinline-member)|Gets a value that indicates whether the attachment appears as an image in the body of the item instead of in the attachment list.| +||[name](/javascript/api/outlook/office.attachmentdetailscompose#outlook-office-attachmentdetailscompose-name-member)|Gets the name of the attachment.| +||[size](/javascript/api/outlook/office.attachmentdetailscompose#outlook-office-attachmentdetailscompose-size-member)|Gets the size of the attachment in bytes.| +||[url](/javascript/api/outlook/office.attachmentdetailscompose#outlook-office-attachmentdetailscompose-url-member)|Gets the url of the attachment if its type is `MailboxEnums.AttachmentType.Cloud`.| +|[AttachmentsChangedEventArgs](/javascript/api/outlook/office.attachmentschangedeventargs)|[attachmentDetails](/javascript/api/outlook/office.attachmentschangedeventargs#outlook-office-attachmentschangedeventargs-attachmentdetails-member)|Gets the object that represents the attachment that was added or removed from| +||[attachmentStatus](/javascript/api/outlook/office.attachmentschangedeventargs#outlook-office-attachmentschangedeventargs-attachmentstatus-member)|Specifies whether the attachment was added or removed from a mail item.| +||[type](/javascript/api/outlook/office.attachmentschangedeventargs#outlook-office-attachmentschangedeventargs-type-member)|Gets the type of event that was raised.| +|[Categories](/javascript/api/outlook/office.categories)|[addAsync(categories: string[], callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.categories#outlook-office-categories-addasync-member(1))|Adds categories to an item.| +||[addAsync(categories: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.categories#outlook-office-categories-addasync-member(1))|Adds categories to an item.| +||[getAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.categories#outlook-office-categories-getasync-member(1))|Gets an item's categories.| +||[getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.categories#outlook-office-categories-getasync-member(1))|Gets an item's categories.| +||[removeAsync(categories: string[], callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.categories#outlook-office-categories-removeasync-member(1))|Removes categories from an item.| +||[removeAsync(categories: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.categories#outlook-office-categories-removeasync-member(1))|Removes categories from an item.| +|[CategoryDetails](/javascript/api/outlook/office.categorydetails)|[color](/javascript/api/outlook/office.categorydetails#outlook-office-categorydetails-color-member)|The color of the category.| +||[displayName](/javascript/api/outlook/office.categorydetails#outlook-office-categorydetails-displayname-member)|The name of the category.| +|[EnhancedLocation](/javascript/api/outlook/office.enhancedlocation)|[addAsync(locationIdentifiers: LocationIdentifier[], callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.enhancedlocation#outlook-office-enhancedlocation-addasync-member(1))|Adds to the set of locations associated with the appointment.| +||[addAsync(locationIdentifiers: LocationIdentifier[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.enhancedlocation#outlook-office-enhancedlocation-addasync-member(1))|Adds to the set of locations associated with the appointment.| +||[getAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.enhancedlocation#outlook-office-enhancedlocation-getasync-member(1))|Gets the set of locations associated with the appointment.| +||[getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.enhancedlocation#outlook-office-enhancedlocation-getasync-member(1))|Gets the set of locations associated with the appointment.| +||[removeAsync(locationIdentifiers: LocationIdentifier[], callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.enhancedlocation#outlook-office-enhancedlocation-removeasync-member(1))|Removes the set of locations associated with the appointment.| +||[removeAsync(locationIdentifiers: LocationIdentifier[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.enhancedlocation#outlook-office-enhancedlocation-removeasync-member(1))|Removes the set of locations associated with the appointment.| +|[EnhancedLocationsChangedEventArgs](/javascript/api/outlook/office.enhancedlocationschangedeventargs)|[enhancedLocations](/javascript/api/outlook/office.enhancedlocationschangedeventargs#outlook-office-enhancedlocationschangedeventargs-enhancedlocations-member)|Gets the set of enhanced locations.| +||[type](/javascript/api/outlook/office.enhancedlocationschangedeventargs#outlook-office-enhancedlocationschangedeventargs-type-member)|Gets the type of the event.| +|[InternetHeaders](/javascript/api/outlook/office.internetheaders)|[getAsync(names: string[], callback: (asyncResult: Office.AsyncResult>) => void)](/javascript/api/outlook/office.internetheaders#outlook-office-internetheaders-getasync-member(1))|Given an array of internet header names, this method returns a record containing those internet headers and their values.| +||[getAsync(names: string[], options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult>) => void)](/javascript/api/outlook/office.internetheaders#outlook-office-internetheaders-getasync-member(1))|Given an array of internet header names, this method returns a record containing those internet headers and their values.| +||[removeAsync(names: string[], callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.internetheaders#outlook-office-internetheaders-removeasync-member(1))|Given an array of internet header names, this method removes the specified headers from the internet header collection.| +||[removeAsync(names: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.internetheaders#outlook-office-internetheaders-removeasync-member(1))|Given an array of internet header names, this method removes the specified headers from the internet header collection.| +||[setAsync(headers: Record, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.internetheaders#outlook-office-internetheaders-setasync-member(1))|Sets the specified internet headers to the specified values.| +||[setAsync(headers: Record, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.internetheaders#outlook-office-internetheaders-setasync-member(1))|Sets the specified internet headers to the specified values.| +|[LocationDetails](/javascript/api/outlook/office.locationdetails)|[displayName](/javascript/api/outlook/office.locationdetails#outlook-office-locationdetails-displayname-member)|The location's display name.| +||[emailAddress](/javascript/api/outlook/office.locationdetails#outlook-office-locationdetails-emailaddress-member)|The email address associated with the location.| +||[locationIdentifier](/javascript/api/outlook/office.locationdetails#outlook-office-locationdetails-locationidentifier-member)|The `LocationIdentifier` of the location.| +|[LocationIdentifier](/javascript/api/outlook/office.locationidentifier)|[id](/javascript/api/outlook/office.locationidentifier#outlook-office-locationidentifier-id-member)|The location's unique ID.| +||[type](/javascript/api/outlook/office.locationidentifier#outlook-office-locationidentifier-type-member)|The location's type.| +|[Mailbox](/javascript/api/outlook/office.mailbox)|[masterCategories](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-mastercategories-member)|Gets an object that provides methods to manage the categories master list associated with a mailbox.| +|[MasterCategories](/javascript/api/outlook/office.mastercategories)|[addAsync(categories: CategoryDetails[], callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.mastercategories#outlook-office-mastercategories-addasync-member(1))|Adds categories to the master list on a mailbox.| +||[addAsync(categories: CategoryDetails[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.mastercategories#outlook-office-mastercategories-addasync-member(1))|Adds categories to the master list on a mailbox.| +||[getAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.mastercategories#outlook-office-mastercategories-getasync-member(1))|Gets the master list of categories on a mailbox.| +||[getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.mastercategories#outlook-office-mastercategories-getasync-member(1))|Gets the master list of categories on a mailbox.| +||[removeAsync(categories: string[], callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.mastercategories#outlook-office-mastercategories-removeasync-member(1))|Removes categories from the master list on a mailbox.| +||[removeAsync(categories: string[], options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.mastercategories#outlook-office-mastercategories-removeasync-member(1))|Removes categories from the master list on a mailbox.| +|[MessageCompose](/javascript/api/outlook/office.messagecompose)|[addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-addfileattachmentfrombase64async-member(1))|Adds a file to a message or appointment as an attachment.| +||[addFileAttachmentFromBase64Async(base64File: string, attachmentName: string, options: Office.AsyncContextOptions & { isInline: boolean }, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-addfileattachmentfrombase64async-member(1))|Adds a file to a message or appointment as an attachment.| +||[categories](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-categories-member)|Gets an object that provides methods for managing the item's categories.| +||[getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-getattachmentcontentasync-member(1))|Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.| +||[getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-getattachmentcontentasync-member(1))|Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.| +||[getAttachmentsAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-getattachmentsasync-member(1))|Gets the item's attachments as an array.| +||[getAttachmentsAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-getattachmentsasync-member(1))|Gets the item's attachments as an array.| +||[getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-getinitializationcontextasync-member(1))|Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.| +||[getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-getinitializationcontextasync-member(1))|Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.| +||[getItemIdAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-getitemidasync-member(1))|Asynchronously gets the {@link https://learn.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | Exchange Web Services (EWS) item identifier}| +||[getItemIdAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-getitemidasync-member(1))|Asynchronously gets the {@link https://learn.microsoft.com/exchange/client-developer/exchange-web-services/ews-identifiers-in-exchange | Exchange Web Services (EWS) item identifier}| +||[getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-getsharedpropertiesasync-member(1))|Gets the properties of an appointment or message in a shared folder or shared mailbox.| +||[getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-getsharedpropertiesasync-member(1))|Gets the properties of an appointment or message in a shared folder or shared mailbox.| +||[internetHeaders](/javascript/api/outlook/office.messagecompose#outlook-office-messagecompose-internetheaders-member)|Gets or sets the custom internet headers of a message.| +|[MessageRead](/javascript/api/outlook/office.messageread)|[categories](/javascript/api/outlook/office.messageread#outlook-office-messageread-categories-member)|Gets an object that provides methods for managing the item's categories.| +||[getAllInternetHeadersAsync(callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messageread#outlook-office-messageread-getallinternetheadersasync-member(1))|Gets all the internet headers for the message as a string.| +||[getAllInternetHeadersAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messageread#outlook-office-messageread-getallinternetheadersasync-member(1))|Gets all the internet headers for the message as a string.| +||[getAttachmentContentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messageread#outlook-office-messageread-getattachmentcontentasync-member(1))|Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.| +||[getAttachmentContentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messageread#outlook-office-messageread-getattachmentcontentasync-member(1))|Gets an attachment from a message or appointment and returns it as an `AttachmentContent` object.| +||[getInitializationContextAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messageread#outlook-office-messageread-getinitializationcontextasync-member(1))|Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.| +||[getInitializationContextAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messageread#outlook-office-messageread-getinitializationcontextasync-member(1))|Gets initialization data passed when the add-in is {@link https://learn.microsoft.com/outlook/actionable-messages/invoke-add-in | activated by an actionable message}.| +||[getSharedPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messageread#outlook-office-messageread-getsharedpropertiesasync-member(1))|Gets the properties of an appointment or message in a shared folder or shared mailbox.| +||[getSharedPropertiesAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messageread#outlook-office-messageread-getsharedpropertiesasync-member(1))|Gets the properties of an appointment or message in a shared folder or shared mailbox.| +|[SharedProperties](/javascript/api/outlook/office.sharedproperties)|[delegatePermissions](/javascript/api/outlook/office.sharedproperties#outlook-office-sharedproperties-delegatepermissions-member)|The permissions that the delegate has on a shared folder, or the user has on a shared mailbox.| +||[owner](/javascript/api/outlook/office.sharedproperties#outlook-office-sharedproperties-owner-member)|The email address of the owner of a shared item.| +||[targetMailbox](/javascript/api/outlook/office.sharedproperties#outlook-office-sharedproperties-targetmailbox-member)|The location of the owner's mailbox for the delegate's access.| +||[targetRestUrl](/javascript/api/outlook/office.sharedproperties#outlook-office-sharedproperties-targetresturl-member)|The REST API's base URL (currently `https://outlook.office.com/api`).| diff --git a/docs/includes/outlook-1_9.md b/docs/includes/outlook-1_9.md index b9f4128593..fc97e7686d 100644 --- a/docs/includes/outlook-1_9.md +++ b/docs/includes/outlook-1_9.md @@ -1,21 +1,21 @@ | Class | Fields | Description | |:---|:---|:---| -|[AppointmentRead](/.appointmentread)|[displayReplyAllFormAsync(formData: string \| ReplyFormData, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-displayreplyallformasync-member(1))|Displays a reply form that includes either the sender and all recipients of the selected message or the organizer and all attendees of the| -||[displayReplyAllFormAsync(formData: string \| ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-displayreplyallformasync-member(1))|Displays a reply form that includes either the sender and all recipients of the selected message or the organizer and all attendees of the| -||[displayReplyFormAsync(formData: string \| ReplyFormData, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-displayreplyformasync-member(1))|Displays a reply form that includes only the sender of the selected message or the organizer of the selected appointment.| -||[displayReplyFormAsync(formData: string \| ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-displayreplyformasync-member(1))|Displays a reply form that includes only the sender of the selected message or the organizer of the selected appointment.| -|[Body](/.body)|[appendOnSendAsync(data: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.body#outlook-javascript/api/outlook/-body-appendonsendasync-member(1))|Appends on send the specified content to the end of the item body, after any signature.| -||[appendOnSendAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.body#outlook-javascript/api/outlook/-body-appendonsendasync-member(1))|Appends on send the specified content to the end of the item body, after any signature.| -|[CustomProperties](/.customproperties)|[getAll()](/.customproperties#outlook-javascript/api/outlook/-customproperties-getall-member(1))|Returns an object with all custom properties in a collection of name/value pairs.| -|[Mailbox](/.mailbox)|[displayAppointmentFormAsync(itemId: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.mailbox#outlook-javascript/api/outlook/-mailbox-displayappointmentformasync-member(1))|Displays an existing calendar appointment.| -||[displayAppointmentFormAsync(itemId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.mailbox#outlook-javascript/api/outlook/-mailbox-displayappointmentformasync-member(1))|Displays an existing calendar appointment.| -||[displayMessageFormAsync(itemId: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.mailbox#outlook-javascript/api/outlook/-mailbox-displaymessageformasync-member(1))|Displays an existing message.| -||[displayMessageFormAsync(itemId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.mailbox#outlook-javascript/api/outlook/-mailbox-displaymessageformasync-member(1))|Displays an existing message.| -||[displayNewAppointmentFormAsync(parameters: AppointmentForm, callback?: (asyncResult: Office.AsyncResult) => void)](/.mailbox#outlook-javascript/api/outlook/-mailbox-displaynewappointmentformasync-member(1))|Displays a form for creating a new calendar appointment.| -||[displayNewAppointmentFormAsync(parameters: AppointmentForm, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.mailbox#outlook-javascript/api/outlook/-mailbox-displaynewappointmentformasync-member(1))|Displays a form for creating a new calendar appointment.| -||[displayNewMessageFormAsync(parameters: any, callback?: (asyncResult: Office.AsyncResult) => void)](/.mailbox#outlook-javascript/api/outlook/-mailbox-displaynewmessageformasync-member(1))|Displays a form for creating a new message.| -||[displayNewMessageFormAsync(parameters: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.mailbox#outlook-javascript/api/outlook/-mailbox-displaynewmessageformasync-member(1))|Displays a form for creating a new message.| -|[MessageRead](/.messageread)|[displayReplyAllFormAsync(formData: string \| ReplyFormData, callback?: (asyncResult: Office.AsyncResult) => void)](/.messageread#outlook-javascript/api/outlook/-messageread-displayreplyallformasync-member(1))|Displays a reply form that includes either the sender and all recipients of the selected message or the organizer and all attendees of the| -||[displayReplyAllFormAsync(formData: string \| ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.messageread#outlook-javascript/api/outlook/-messageread-displayreplyallformasync-member(1))|Displays a reply form that includes either the sender and all recipients of the selected message or the organizer and all attendees of the| -||[displayReplyFormAsync(formData: string \| ReplyFormData, callback?: (asyncResult: Office.AsyncResult) => void)](/.messageread#outlook-javascript/api/outlook/-messageread-displayreplyformasync-member(1))|Displays a reply form that includes only the sender of the selected message or the organizer of the selected appointment.| -||[displayReplyFormAsync(formData: string \| ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.messageread#outlook-javascript/api/outlook/-messageread-displayreplyformasync-member(1))|Displays a reply form that includes only the sender of the selected message or the organizer of the selected appointment.| +|[AppointmentRead](/javascript/api/outlook/office.appointmentread)|[displayReplyAllFormAsync(formData: string \| ReplyFormData, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-displayreplyallformasync-member(1))|Displays a reply form that includes either the sender and all recipients of the selected message or the organizer and all attendees of the| +||[displayReplyAllFormAsync(formData: string \| ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-displayreplyallformasync-member(1))|Displays a reply form that includes either the sender and all recipients of the selected message or the organizer and all attendees of the| +||[displayReplyFormAsync(formData: string \| ReplyFormData, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-displayreplyformasync-member(1))|Displays a reply form that includes only the sender of the selected message or the organizer of the selected appointment.| +||[displayReplyFormAsync(formData: string \| ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-displayreplyformasync-member(1))|Displays a reply form that includes only the sender of the selected message or the organizer of the selected appointment.| +|[Body](/javascript/api/outlook/office.body)|[appendOnSendAsync(data: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.body#outlook-office-body-appendonsendasync-member(1))|Appends on send the specified content to the end of the item body, after any signature.| +||[appendOnSendAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.body#outlook-office-body-appendonsendasync-member(1))|Appends on send the specified content to the end of the item body, after any signature.| +|[CustomProperties](/javascript/api/outlook/office.customproperties)|[getAll()](/javascript/api/outlook/office.customproperties#outlook-office-customproperties-getall-member(1))|Returns an object with all custom properties in a collection of name/value pairs.| +|[Mailbox](/javascript/api/outlook/office.mailbox)|[displayAppointmentFormAsync(itemId: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-displayappointmentformasync-member(1))|Displays an existing calendar appointment.| +||[displayAppointmentFormAsync(itemId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-displayappointmentformasync-member(1))|Displays an existing calendar appointment.| +||[displayMessageFormAsync(itemId: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-displaymessageformasync-member(1))|Displays an existing message.| +||[displayMessageFormAsync(itemId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-displaymessageformasync-member(1))|Displays an existing message.| +||[displayNewAppointmentFormAsync(parameters: AppointmentForm, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-displaynewappointmentformasync-member(1))|Displays a form for creating a new calendar appointment.| +||[displayNewAppointmentFormAsync(parameters: AppointmentForm, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-displaynewappointmentformasync-member(1))|Displays a form for creating a new calendar appointment.| +||[displayNewMessageFormAsync(parameters: any, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-displaynewmessageformasync-member(1))|Displays a form for creating a new message.| +||[displayNewMessageFormAsync(parameters: any, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.mailbox#outlook-office-mailbox-displaynewmessageformasync-member(1))|Displays a form for creating a new message.| +|[MessageRead](/javascript/api/outlook/office.messageread)|[displayReplyAllFormAsync(formData: string \| ReplyFormData, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messageread#outlook-office-messageread-displayreplyallformasync-member(1))|Displays a reply form that includes either the sender and all recipients of the selected message or the organizer and all attendees of the| +||[displayReplyAllFormAsync(formData: string \| ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messageread#outlook-office-messageread-displayreplyallformasync-member(1))|Displays a reply form that includes either the sender and all recipients of the selected message or the organizer and all attendees of the| +||[displayReplyFormAsync(formData: string \| ReplyFormData, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messageread#outlook-office-messageread-displayreplyformasync-member(1))|Displays a reply form that includes only the sender of the selected message or the organizer of the selected appointment.| +||[displayReplyFormAsync(formData: string \| ReplyFormData, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.messageread#outlook-office-messageread-displayreplyformasync-member(1))|Displays a reply form that includes only the sender of the selected message or the organizer of the selected appointment.| diff --git a/docs/includes/outlook-preview.md b/docs/includes/outlook-preview.md index e7412de771..21f1a57fe5 100644 --- a/docs/includes/outlook-preview.md +++ b/docs/includes/outlook-preview.md @@ -1,15 +1,15 @@ | Class | Fields | Description | |:---|:---|:---| -|[AppointmentCompose](/.appointmentcompose)|[isAllDayEvent](/.appointmentcompose#outlook-javascript/api/outlook/-appointmentcompose-isalldayevent-member)|Gets or sets the Office.IsAllDayEvent property of an appointment.| -|[AppointmentRead](/.appointmentread)|[isAllDayEvent](/.appointmentread#outlook-javascript/api/outlook/-appointmentread-isalldayevent-member)|Returns a boolean value indicating whether the event is all day.| -|[Display](/.display)|[body](/.display#outlook-javascript/api/outlook/-display-body-member)|Gets an object to temporarily set the content displayed in the body of a message in read mode.| -||[subject](/.display#outlook-javascript/api/outlook/-display-subject-member)|Gets an object to temporarily set the content displayed in the subject of a message in read mode.| -|[DisplayedBody](/.displayedbody)|[setAsync(data: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.displayedbody#outlook-javascript/api/outlook/-displayedbody-setasync-member(1))|Temporarily sets the content displayed in the body of a message in read mode.| -||[setAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.displayedbody#outlook-javascript/api/outlook/-displayedbody-setasync-member(1))|Temporarily sets the content displayed in the body of a message in read mode.| -|[DisplayedSubject](/.displayedsubject)|[setAsync(data: string, callback?: (asyncResult: Office.AsyncResult) => void)](/.displayedsubject#outlook-javascript/api/outlook/-displayedsubject-setasync-member(1))|Temporarily sets the content displayed in the subject of a message in read mode.| -||[setAsync(data: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.displayedsubject#outlook-javascript/api/outlook/-displayedsubject-setasync-member(1))|Temporarily sets the content displayed in the subject of a message in read mode.| -|[IsAllDayEvent](/.isalldayevent)|[getAsync(callback: (asyncResult: Office.AsyncResult) => void)](/.isalldayevent#outlook-javascript/api/outlook/-isalldayevent-getasync-member(1))|Gets the boolean value indicating whether the event is all day or not.| -||[getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/.isalldayevent#outlook-javascript/api/outlook/-isalldayevent-getasync-member(1))|Gets the boolean value indicating whether the event is all day or not.| -||[setAsync(isAllDayEvent: boolean, callback?: (asyncResult: Office.AsyncResult) => void)](/.isalldayevent#outlook-javascript/api/outlook/-isalldayevent-setasync-member(1))|Sets the all-day event status of an appointment.| -||[setAsync(isAllDayEvent: boolean, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/.isalldayevent#outlook-javascript/api/outlook/-isalldayevent-setasync-member(1))|Sets the all-day event status of an appointment.| -|[MessageRead](/.messageread)|[display](/.messageread#outlook-javascript/api/outlook/-messageread-display-member)|Gets an object to temporarily set the content displayed in the body or subject of a message in read mode.| +|[AppointmentCompose](/javascript/api/outlook/office.appointmentcompose)|[isAllDayEvent](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-isalldayevent-member)|Gets or sets the Office.IsAllDayEvent property of an appointment.| +|[AppointmentRead](/javascript/api/outlook/office.appointmentread)|[isAllDayEvent](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-isalldayevent-member)|Returns a boolean value indicating whether the event is all day.| +|[Display](/javascript/api/outlook/office.display)|[body](/javascript/api/outlook/office.display#outlook-office-display-body-member)|Gets an object to temporarily set the content displayed in the body of a message in read mode.| +||[subject](/javascript/api/outlook/office.display#outlook-office-display-subject-member)|Gets an object to temporarily set the content displayed in the subject of a message in read mode.| +|[DisplayedBody](/javascript/api/outlook/office.displayedbody)|[setAsync(data: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.displayedbody#outlook-office-displayedbody-setasync-member(1))|Temporarily sets the content displayed in the body of a message in read mode.| +||[setAsync(data: string, options: Office.AsyncContextOptions & CoercionTypeOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.displayedbody#outlook-office-displayedbody-setasync-member(1))|Temporarily sets the content displayed in the body of a message in read mode.| +|[DisplayedSubject](/javascript/api/outlook/office.displayedsubject)|[setAsync(data: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.displayedsubject#outlook-office-displayedsubject-setasync-member(1))|Temporarily sets the content displayed in the subject of a message in read mode.| +||[setAsync(data: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.displayedsubject#outlook-office-displayedsubject-setasync-member(1))|Temporarily sets the content displayed in the subject of a message in read mode.| +|[IsAllDayEvent](/javascript/api/outlook/office.isalldayevent)|[getAsync(callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.isalldayevent#outlook-office-isalldayevent-getasync-member(1))|Gets the boolean value indicating whether the event is all day or not.| +||[getAsync(options: Office.AsyncContextOptions, callback: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.isalldayevent#outlook-office-isalldayevent-getasync-member(1))|Gets the boolean value indicating whether the event is all day or not.| +||[setAsync(isAllDayEvent: boolean, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.isalldayevent#outlook-office-isalldayevent-setasync-member(1))|Sets the all-day event status of an appointment.| +||[setAsync(isAllDayEvent: boolean, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.isalldayevent#outlook-office-isalldayevent-setasync-member(1))|Sets the all-day event status of an appointment.| +|[MessageRead](/javascript/api/outlook/office.messageread)|[display](/javascript/api/outlook/office.messageread#outlook-office-messageread-display-member)|Gets an object to temporarily set the content displayed in the body or subject of a message in read mode.| diff --git a/docs/includes/powerpoint-1_1.md b/docs/includes/powerpoint-1_1.md index 3234af6236..81cd966fe4 100644 --- a/docs/includes/powerpoint-1_1.md +++ b/docs/includes/powerpoint-1_1.md @@ -1,3 +1,3 @@ | Class | Fields | Description | |:---|:---|:---| -|*global*|[createPresentation(base64File?: string)](/#powerpoint-javascript/api/powerpoint/-createpresentation-function(1))|Creates and opens a new presentation.| +|*global*|[createPresentation(base64File?: string)](/javascript/api/powerpoint/powerpoint#createpresentation)|Creates and opens a new presentation.| diff --git a/docs/includes/powerpoint-1_2.md b/docs/includes/powerpoint-1_2.md index 2d5b9fa749..04f464e6ce 100644 --- a/docs/includes/powerpoint-1_2.md +++ b/docs/includes/powerpoint-1_2.md @@ -1,14 +1,14 @@ | Class | Fields | Description | |:---|:---|:---| -|[InsertSlideOptions](/.insertslideoptions)|[formatting](/.insertslideoptions#powerpoint-javascript/api/powerpoint/-insertslideoptions-formatting-member)|Specifies which formatting to use during slide insertion.| -||[sourceSlideIds](/.insertslideoptions#powerpoint-javascript/api/powerpoint/-insertslideoptions-sourceslideids-member)|Specifies the slides from the source presentation that will be inserted into the current presentation.| -||[targetSlideId](/.insertslideoptions#powerpoint-javascript/api/powerpoint/-insertslideoptions-targetslideid-member)|Specifies where in the presentation the new slides will be inserted.| -|[Presentation](/.presentation)|[insertSlidesFromBase64(base64File: string, options?: PowerPoint.InsertSlideOptions)](/.presentation#powerpoint-javascript/api/powerpoint/-presentation-insertslidesfrombase64-member(1))|Inserts the specified slides from a presentation into the current presentation.| -||[slides](/.presentation#powerpoint-javascript/api/powerpoint/-presentation-slides-member)|Returns an ordered collection of slides in the presentation.| -|[Slide](/.slide)|[delete()](/.slide#powerpoint-javascript/api/powerpoint/-slide-delete-member(1))|Deletes the slide from the presentation.| -||[id](/.slide#powerpoint-javascript/api/powerpoint/-slide-id-member)|Gets the unique ID of the slide.| -|[SlideCollection](/.slidecollection)|[getCount()](/.slidecollection#powerpoint-javascript/api/powerpoint/-slidecollection-getcount-member(1))|Gets the number of slides in the collection.| -||[getItem(key: string)](/.slidecollection#powerpoint-javascript/api/powerpoint/-slidecollection-getitem-member(1))|Gets a slide using its unique ID.| -||[getItemAt(index: number)](/.slidecollection#powerpoint-javascript/api/powerpoint/-slidecollection-getitemat-member(1))|Gets a slide using its zero-based index in the collection.| -||[getItemOrNullObject(id: string)](/.slidecollection#powerpoint-javascript/api/powerpoint/-slidecollection-getitemornullobject-member(1))|Gets a slide using its unique ID.| -||[items](/.slidecollection#powerpoint-javascript/api/powerpoint/-slidecollection-items-member)|Gets the loaded child items in this collection.| +|[InsertSlideOptions](/javascript/api/powerpoint/powerpoint.insertslideoptions)|[formatting](/javascript/api/powerpoint/powerpoint.insertslideoptions#powerpoint-powerpoint-insertslideoptions-formatting-member)|Specifies which formatting to use during slide insertion.| +||[sourceSlideIds](/javascript/api/powerpoint/powerpoint.insertslideoptions#powerpoint-powerpoint-insertslideoptions-sourceslideids-member)|Specifies the slides from the source presentation that will be inserted into the current presentation.| +||[targetSlideId](/javascript/api/powerpoint/powerpoint.insertslideoptions#powerpoint-powerpoint-insertslideoptions-targetslideid-member)|Specifies where in the presentation the new slides will be inserted.| +|[Presentation](/javascript/api/powerpoint/powerpoint.presentation)|[insertSlidesFromBase64(base64File: string, options?: PowerPoint.InsertSlideOptions)](/javascript/api/powerpoint/powerpoint.presentation#powerpoint-powerpoint-presentation-insertslidesfrombase64-member(1))|Inserts the specified slides from a presentation into the current presentation.| +||[slides](/javascript/api/powerpoint/powerpoint.presentation#powerpoint-powerpoint-presentation-slides-member)|Returns an ordered collection of slides in the presentation.| +|[Slide](/javascript/api/powerpoint/powerpoint.slide)|[delete()](/javascript/api/powerpoint/powerpoint.slide#powerpoint-powerpoint-slide-delete-member(1))|Deletes the slide from the presentation.| +||[id](/javascript/api/powerpoint/powerpoint.slide#powerpoint-powerpoint-slide-id-member)|Gets the unique ID of the slide.| +|[SlideCollection](/javascript/api/powerpoint/powerpoint.slidecollection)|[getCount()](/javascript/api/powerpoint/powerpoint.slidecollection#powerpoint-powerpoint-slidecollection-getcount-member(1))|Gets the number of slides in the collection.| +||[getItem(key: string)](/javascript/api/powerpoint/powerpoint.slidecollection#powerpoint-powerpoint-slidecollection-getitem-member(1))|Gets a slide using its unique ID.| +||[getItemAt(index: number)](/javascript/api/powerpoint/powerpoint.slidecollection#powerpoint-powerpoint-slidecollection-getitemat-member(1))|Gets a slide using its zero-based index in the collection.| +||[getItemOrNullObject(id: string)](/javascript/api/powerpoint/powerpoint.slidecollection#powerpoint-powerpoint-slidecollection-getitemornullobject-member(1))|Gets a slide using its unique ID.| +||[items](/javascript/api/powerpoint/powerpoint.slidecollection#powerpoint-powerpoint-slidecollection-items-member)|Gets the loaded child items in this collection.| diff --git a/docs/includes/powerpoint-1_3.md b/docs/includes/powerpoint-1_3.md index 52255cf26a..280868c8e1 100644 --- a/docs/includes/powerpoint-1_3.md +++ b/docs/includes/powerpoint-1_3.md @@ -1,45 +1,45 @@ | Class | Fields | Description | |:---|:---|:---| -|[AddSlideOptions](/.addslideoptions)|[layoutId](/.addslideoptions#powerpoint-javascript/api/powerpoint/-addslideoptions-layoutid-member)|Specifies the ID of a Slide Layout to be used for the new slide.| -||[slideMasterId](/.addslideoptions#powerpoint-javascript/api/powerpoint/-addslideoptions-slidemasterid-member)|Specifies the ID of a Slide Master to be used for the new slide.| -|[Presentation](/.presentation)|[slideMasters](/.presentation#powerpoint-javascript/api/powerpoint/-presentation-slidemasters-member)|Returns the collection of `SlideMaster` objects that are in the presentation.| -||[tags](/.presentation#powerpoint-javascript/api/powerpoint/-presentation-tags-member)|Returns a collection of tags attached to the presentation.| -|[Shape](/.shape)|[delete()](/.shape#powerpoint-javascript/api/powerpoint/-shape-delete-member(1))|Deletes the shape from the shape collection.| -||[id](/.shape#powerpoint-javascript/api/powerpoint/-shape-id-member)|Gets the unique ID of the shape.| -||[tags](/.shape#powerpoint-javascript/api/powerpoint/-shape-tags-member)|Returns a collection of tags in the shape.| -|[ShapeCollection](/.shapecollection)|[getCount()](/.shapecollection#powerpoint-javascript/api/powerpoint/-shapecollection-getcount-member(1))|Gets the number of shapes in the collection.| -||[getItem(key: string)](/.shapecollection#powerpoint-javascript/api/powerpoint/-shapecollection-getitem-member(1))|Gets a shape using its unique ID.| -||[getItemAt(index: number)](/.shapecollection#powerpoint-javascript/api/powerpoint/-shapecollection-getitemat-member(1))|Gets a shape using its zero-based index in the collection.| -||[getItemOrNullObject(id: string)](/.shapecollection#powerpoint-javascript/api/powerpoint/-shapecollection-getitemornullobject-member(1))|Gets a shape using its unique ID.| -||[items](/.shapecollection#powerpoint-javascript/api/powerpoint/-shapecollection-items-member)|Gets the loaded child items in this collection.| -|[Slide](/.slide)|[layout](/.slide#powerpoint-javascript/api/powerpoint/-slide-layout-member)|Gets the layout of the slide.| -||[shapes](/.slide#powerpoint-javascript/api/powerpoint/-slide-shapes-member)|Returns a collection of shapes in the slide.| -||[slideMaster](/.slide#powerpoint-javascript/api/powerpoint/-slide-slidemaster-member)|Gets the `SlideMaster` object that represents the slide's default content.| -||[tags](/.slide#powerpoint-javascript/api/powerpoint/-slide-tags-member)|Returns a collection of tags in the slide.| -|[SlideCollection](/.slidecollection)|[add(options?: PowerPoint.AddSlideOptions)](/.slidecollection#powerpoint-javascript/api/powerpoint/-slidecollection-add-member(1))|Adds a new slide at the end of the collection.| -|[SlideLayout](/.slidelayout)|[id](/.slidelayout#powerpoint-javascript/api/powerpoint/-slidelayout-id-member)|Gets the unique ID of the slide layout.| -||[name](/.slidelayout#powerpoint-javascript/api/powerpoint/-slidelayout-name-member)|Gets the name of the slide layout.| -||[shapes](/.slidelayout#powerpoint-javascript/api/powerpoint/-slidelayout-shapes-member)|Returns a collection of shapes in the slide layout.| -|[SlideLayoutCollection](/.slidelayoutcollection)|[getCount()](/.slidelayoutcollection#powerpoint-javascript/api/powerpoint/-slidelayoutcollection-getcount-member(1))|Gets the number of layouts in the collection.| -||[getItem(key: string)](/.slidelayoutcollection#powerpoint-javascript/api/powerpoint/-slidelayoutcollection-getitem-member(1))|Gets a layout using its unique ID.| -||[getItemAt(index: number)](/.slidelayoutcollection#powerpoint-javascript/api/powerpoint/-slidelayoutcollection-getitemat-member(1))|Gets a layout using its zero-based index in the collection.| -||[getItemOrNullObject(id: string)](/.slidelayoutcollection#powerpoint-javascript/api/powerpoint/-slidelayoutcollection-getitemornullobject-member(1))|Gets a layout using its unique ID.| -||[items](/.slidelayoutcollection#powerpoint-javascript/api/powerpoint/-slidelayoutcollection-items-member)|Gets the loaded child items in this collection.| -|[SlideMaster](/.slidemaster)|[id](/.slidemaster#powerpoint-javascript/api/powerpoint/-slidemaster-id-member)|Gets the unique ID of the Slide Master.| -||[layouts](/.slidemaster#powerpoint-javascript/api/powerpoint/-slidemaster-layouts-member)|Gets the collection of layouts provided by the Slide Master for slides.| -||[name](/.slidemaster#powerpoint-javascript/api/powerpoint/-slidemaster-name-member)|Gets the unique name of the Slide Master.| -||[shapes](/.slidemaster#powerpoint-javascript/api/powerpoint/-slidemaster-shapes-member)|Returns a collection of shapes in the Slide Master.| -|[SlideMasterCollection](/.slidemastercollection)|[getCount()](/.slidemastercollection#powerpoint-javascript/api/powerpoint/-slidemastercollection-getcount-member(1))|Gets the number of Slide Masters in the collection.| -||[getItem(key: string)](/.slidemastercollection#powerpoint-javascript/api/powerpoint/-slidemastercollection-getitem-member(1))|Gets a Slide Master using its unique ID.| -||[getItemAt(index: number)](/.slidemastercollection#powerpoint-javascript/api/powerpoint/-slidemastercollection-getitemat-member(1))|Gets a Slide Master using its zero-based index in the collection.| -||[getItemOrNullObject(id: string)](/.slidemastercollection#powerpoint-javascript/api/powerpoint/-slidemastercollection-getitemornullobject-member(1))|Gets a Slide Master using its unique ID.| -||[items](/.slidemastercollection#powerpoint-javascript/api/powerpoint/-slidemastercollection-items-member)|Gets the loaded child items in this collection.| -|[Tag](/.tag)|[key](/.tag#powerpoint-javascript/api/powerpoint/-tag-key-member)|Gets the unique ID of the tag.| -||[value](/.tag#powerpoint-javascript/api/powerpoint/-tag-value-member)|Gets the value of the tag.| -|[TagCollection](/.tagcollection)|[add(key: string, value: string)](/.tagcollection#powerpoint-javascript/api/powerpoint/-tagcollection-add-member(1))|Adds a new tag at the end of the collection.| -||[delete(key: string)](/.tagcollection#powerpoint-javascript/api/powerpoint/-tagcollection-delete-member(1))|Deletes the tag with the given `key` in this collection.| -||[getCount()](/.tagcollection#powerpoint-javascript/api/powerpoint/-tagcollection-getcount-member(1))|Gets the number of tags in the collection.| -||[getItem(key: string)](/.tagcollection#powerpoint-javascript/api/powerpoint/-tagcollection-getitem-member(1))|Gets a tag using its unique ID.| -||[getItemAt(index: number)](/.tagcollection#powerpoint-javascript/api/powerpoint/-tagcollection-getitemat-member(1))|Gets a tag using its zero-based index in the collection.| -||[getItemOrNullObject(key: string)](/.tagcollection#powerpoint-javascript/api/powerpoint/-tagcollection-getitemornullobject-member(1))|Gets a tag using its unique ID.| -||[items](/.tagcollection#powerpoint-javascript/api/powerpoint/-tagcollection-items-member)|Gets the loaded child items in this collection.| +|[AddSlideOptions](/javascript/api/powerpoint/powerpoint.addslideoptions)|[layoutId](/javascript/api/powerpoint/powerpoint.addslideoptions#powerpoint-powerpoint-addslideoptions-layoutid-member)|Specifies the ID of a Slide Layout to be used for the new slide.| +||[slideMasterId](/javascript/api/powerpoint/powerpoint.addslideoptions#powerpoint-powerpoint-addslideoptions-slidemasterid-member)|Specifies the ID of a Slide Master to be used for the new slide.| +|[Presentation](/javascript/api/powerpoint/powerpoint.presentation)|[slideMasters](/javascript/api/powerpoint/powerpoint.presentation#powerpoint-powerpoint-presentation-slidemasters-member)|Returns the collection of `SlideMaster` objects that are in the presentation.| +||[tags](/javascript/api/powerpoint/powerpoint.presentation#powerpoint-powerpoint-presentation-tags-member)|Returns a collection of tags attached to the presentation.| +|[Shape](/javascript/api/powerpoint/powerpoint.shape)|[delete()](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-delete-member(1))|Deletes the shape from the shape collection.| +||[id](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-id-member)|Gets the unique ID of the shape.| +||[tags](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-tags-member)|Returns a collection of tags in the shape.| +|[ShapeCollection](/javascript/api/powerpoint/powerpoint.shapecollection)|[getCount()](/javascript/api/powerpoint/powerpoint.shapecollection#powerpoint-powerpoint-shapecollection-getcount-member(1))|Gets the number of shapes in the collection.| +||[getItem(key: string)](/javascript/api/powerpoint/powerpoint.shapecollection#powerpoint-powerpoint-shapecollection-getitem-member(1))|Gets a shape using its unique ID.| +||[getItemAt(index: number)](/javascript/api/powerpoint/powerpoint.shapecollection#powerpoint-powerpoint-shapecollection-getitemat-member(1))|Gets a shape using its zero-based index in the collection.| +||[getItemOrNullObject(id: string)](/javascript/api/powerpoint/powerpoint.shapecollection#powerpoint-powerpoint-shapecollection-getitemornullobject-member(1))|Gets a shape using its unique ID.| +||[items](/javascript/api/powerpoint/powerpoint.shapecollection#powerpoint-powerpoint-shapecollection-items-member)|Gets the loaded child items in this collection.| +|[Slide](/javascript/api/powerpoint/powerpoint.slide)|[layout](/javascript/api/powerpoint/powerpoint.slide#powerpoint-powerpoint-slide-layout-member)|Gets the layout of the slide.| +||[shapes](/javascript/api/powerpoint/powerpoint.slide#powerpoint-powerpoint-slide-shapes-member)|Returns a collection of shapes in the slide.| +||[slideMaster](/javascript/api/powerpoint/powerpoint.slide#powerpoint-powerpoint-slide-slidemaster-member)|Gets the `SlideMaster` object that represents the slide's default content.| +||[tags](/javascript/api/powerpoint/powerpoint.slide#powerpoint-powerpoint-slide-tags-member)|Returns a collection of tags in the slide.| +|[SlideCollection](/javascript/api/powerpoint/powerpoint.slidecollection)|[add(options?: PowerPoint.AddSlideOptions)](/javascript/api/powerpoint/powerpoint.slidecollection#powerpoint-powerpoint-slidecollection-add-member(1))|Adds a new slide at the end of the collection.| +|[SlideLayout](/javascript/api/powerpoint/powerpoint.slidelayout)|[id](/javascript/api/powerpoint/powerpoint.slidelayout#powerpoint-powerpoint-slidelayout-id-member)|Gets the unique ID of the slide layout.| +||[name](/javascript/api/powerpoint/powerpoint.slidelayout#powerpoint-powerpoint-slidelayout-name-member)|Gets the name of the slide layout.| +||[shapes](/javascript/api/powerpoint/powerpoint.slidelayout#powerpoint-powerpoint-slidelayout-shapes-member)|Returns a collection of shapes in the slide layout.| +|[SlideLayoutCollection](/javascript/api/powerpoint/powerpoint.slidelayoutcollection)|[getCount()](/javascript/api/powerpoint/powerpoint.slidelayoutcollection#powerpoint-powerpoint-slidelayoutcollection-getcount-member(1))|Gets the number of layouts in the collection.| +||[getItem(key: string)](/javascript/api/powerpoint/powerpoint.slidelayoutcollection#powerpoint-powerpoint-slidelayoutcollection-getitem-member(1))|Gets a layout using its unique ID.| +||[getItemAt(index: number)](/javascript/api/powerpoint/powerpoint.slidelayoutcollection#powerpoint-powerpoint-slidelayoutcollection-getitemat-member(1))|Gets a layout using its zero-based index in the collection.| +||[getItemOrNullObject(id: string)](/javascript/api/powerpoint/powerpoint.slidelayoutcollection#powerpoint-powerpoint-slidelayoutcollection-getitemornullobject-member(1))|Gets a layout using its unique ID.| +||[items](/javascript/api/powerpoint/powerpoint.slidelayoutcollection#powerpoint-powerpoint-slidelayoutcollection-items-member)|Gets the loaded child items in this collection.| +|[SlideMaster](/javascript/api/powerpoint/powerpoint.slidemaster)|[id](/javascript/api/powerpoint/powerpoint.slidemaster#powerpoint-powerpoint-slidemaster-id-member)|Gets the unique ID of the Slide Master.| +||[layouts](/javascript/api/powerpoint/powerpoint.slidemaster#powerpoint-powerpoint-slidemaster-layouts-member)|Gets the collection of layouts provided by the Slide Master for slides.| +||[name](/javascript/api/powerpoint/powerpoint.slidemaster#powerpoint-powerpoint-slidemaster-name-member)|Gets the unique name of the Slide Master.| +||[shapes](/javascript/api/powerpoint/powerpoint.slidemaster#powerpoint-powerpoint-slidemaster-shapes-member)|Returns a collection of shapes in the Slide Master.| +|[SlideMasterCollection](/javascript/api/powerpoint/powerpoint.slidemastercollection)|[getCount()](/javascript/api/powerpoint/powerpoint.slidemastercollection#powerpoint-powerpoint-slidemastercollection-getcount-member(1))|Gets the number of Slide Masters in the collection.| +||[getItem(key: string)](/javascript/api/powerpoint/powerpoint.slidemastercollection#powerpoint-powerpoint-slidemastercollection-getitem-member(1))|Gets a Slide Master using its unique ID.| +||[getItemAt(index: number)](/javascript/api/powerpoint/powerpoint.slidemastercollection#powerpoint-powerpoint-slidemastercollection-getitemat-member(1))|Gets a Slide Master using its zero-based index in the collection.| +||[getItemOrNullObject(id: string)](/javascript/api/powerpoint/powerpoint.slidemastercollection#powerpoint-powerpoint-slidemastercollection-getitemornullobject-member(1))|Gets a Slide Master using its unique ID.| +||[items](/javascript/api/powerpoint/powerpoint.slidemastercollection#powerpoint-powerpoint-slidemastercollection-items-member)|Gets the loaded child items in this collection.| +|[Tag](/javascript/api/powerpoint/powerpoint.tag)|[key](/javascript/api/powerpoint/powerpoint.tag#powerpoint-powerpoint-tag-key-member)|Gets the unique ID of the tag.| +||[value](/javascript/api/powerpoint/powerpoint.tag#powerpoint-powerpoint-tag-value-member)|Gets the value of the tag.| +|[TagCollection](/javascript/api/powerpoint/powerpoint.tagcollection)|[add(key: string, value: string)](/javascript/api/powerpoint/powerpoint.tagcollection#powerpoint-powerpoint-tagcollection-add-member(1))|Adds a new tag at the end of the collection.| +||[delete(key: string)](/javascript/api/powerpoint/powerpoint.tagcollection#powerpoint-powerpoint-tagcollection-delete-member(1))|Deletes the tag with the given `key` in this collection.| +||[getCount()](/javascript/api/powerpoint/powerpoint.tagcollection#powerpoint-powerpoint-tagcollection-getcount-member(1))|Gets the number of tags in the collection.| +||[getItem(key: string)](/javascript/api/powerpoint/powerpoint.tagcollection#powerpoint-powerpoint-tagcollection-getitem-member(1))|Gets a tag using its unique ID.| +||[getItemAt(index: number)](/javascript/api/powerpoint/powerpoint.tagcollection#powerpoint-powerpoint-tagcollection-getitemat-member(1))|Gets a tag using its zero-based index in the collection.| +||[getItemOrNullObject(key: string)](/javascript/api/powerpoint/powerpoint.tagcollection#powerpoint-powerpoint-tagcollection-getitemornullobject-member(1))|Gets a tag using its unique ID.| +||[items](/javascript/api/powerpoint/powerpoint.tagcollection#powerpoint-powerpoint-tagcollection-items-member)|Gets the loaded child items in this collection.| diff --git a/docs/includes/powerpoint-1_4.md b/docs/includes/powerpoint-1_4.md index 8b0323fd78..e5e7d943a1 100644 --- a/docs/includes/powerpoint-1_4.md +++ b/docs/includes/powerpoint-1_4.md @@ -1,52 +1,52 @@ | Class | Fields | Description | |:---|:---|:---| -|[BulletFormat](/.bulletformat)|[visible](/.bulletformat#powerpoint-javascript/api/powerpoint/-bulletformat-visible-member)|Specifies if the bullets in the paragraph are visible.| -|[ParagraphFormat](/.paragraphformat)|[bulletFormat](/.paragraphformat#powerpoint-javascript/api/powerpoint/-paragraphformat-bulletformat-member)|Represents the bullet format of the paragraph.| -||[horizontalAlignment](/.paragraphformat#powerpoint-javascript/api/powerpoint/-paragraphformat-horizontalalignment-member)|Represents the horizontal alignment of the paragraph.| -|[Shape](/.shape)|[fill](/.shape#powerpoint-javascript/api/powerpoint/-shape-fill-member)|Returns the fill formatting of this shape.| -||[height](/.shape#powerpoint-javascript/api/powerpoint/-shape-height-member)|Specifies the height, in points, of the shape.| -||[left](/.shape#powerpoint-javascript/api/powerpoint/-shape-left-member)|The distance, in points, from the left side of the shape to the left side of the slide.| -||[lineFormat](/.shape#powerpoint-javascript/api/powerpoint/-shape-lineformat-member)|Returns the line formatting of this shape.| -||[name](/.shape#powerpoint-javascript/api/powerpoint/-shape-name-member)|Specifies the name of this shape.| -||[textFrame](/.shape#powerpoint-javascript/api/powerpoint/-shape-textframe-member)|Returns the PowerPoint.TextFrame object of this `Shape`.| -||[top](/.shape#powerpoint-javascript/api/powerpoint/-shape-top-member)|The distance, in points, from the top edge of the shape to the top edge of the slide.| -||[type](/.shape#powerpoint-javascript/api/powerpoint/-shape-type-member)|Returns the type of this shape.| -||[width](/.shape#powerpoint-javascript/api/powerpoint/-shape-width-member)|Specifies the width, in points, of the shape.| -|[ShapeAddOptions](/.shapeaddoptions)|[height](/.shapeaddoptions#powerpoint-javascript/api/powerpoint/-shapeaddoptions-height-member)|Specifies the height, in points, of the shape.| -||[left](/.shapeaddoptions#powerpoint-javascript/api/powerpoint/-shapeaddoptions-left-member)|Specifies the distance, in points, from the left side of the shape to the left side of the slide.| -||[top](/.shapeaddoptions#powerpoint-javascript/api/powerpoint/-shapeaddoptions-top-member)|Specifies the distance, in points, from the top edge of the shape to the top edge of the slide.| -||[width](/.shapeaddoptions#powerpoint-javascript/api/powerpoint/-shapeaddoptions-width-member)|Specifies the width, in points, of the shape.| -|[ShapeCollection](/.shapecollection)|[addGeometricShape(geometricShapeType: PowerPoint.GeometricShapeType, options?: PowerPoint.ShapeAddOptions)](/.shapecollection#powerpoint-javascript/api/powerpoint/-shapecollection-addgeometricshape-member(1))|Adds a geometric shape to the slide.| -||[addLine(connectorType?: PowerPoint.ConnectorType, options?: PowerPoint.ShapeAddOptions)](/.shapecollection#powerpoint-javascript/api/powerpoint/-shapecollection-addline-member(1))|Adds a line to the slide.| -||[addTextBox(text: string, options?: PowerPoint.ShapeAddOptions)](/.shapecollection#powerpoint-javascript/api/powerpoint/-shapecollection-addtextbox-member(1))|Adds a text box to the slide with the provided text as the content.| -|[ShapeFill](/.shapefill)|[clear()](/.shapefill#powerpoint-javascript/api/powerpoint/-shapefill-clear-member(1))|Clears the fill formatting of this shape.| -||[foregroundColor](/.shapefill#powerpoint-javascript/api/powerpoint/-shapefill-foregroundcolor-member)|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").| -||[setSolidColor(color: string)](/.shapefill#powerpoint-javascript/api/powerpoint/-shapefill-setsolidcolor-member(1))|Sets the fill formatting of the shape to a uniform color.| -||[transparency](/.shapefill#powerpoint-javascript/api/powerpoint/-shapefill-transparency-member)|Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).| -||[type](/.shapefill#powerpoint-javascript/api/powerpoint/-shapefill-type-member)|Returns the fill type of the shape.| -|[ShapeFont](/.shapefont)|[bold](/.shapefont#powerpoint-javascript/api/powerpoint/-shapefont-bold-member)|Specifies whether the text in the `TextRange` is set to bold.| -||[color](/.shapefont#powerpoint-javascript/api/powerpoint/-shapefont-color-member)|Specifies the HTML color code representation of the text color (e.g., "#FF0000" represents red).| -||[italic](/.shapefont#powerpoint-javascript/api/powerpoint/-shapefont-italic-member)|Specifies whether the text in the `TextRange` is set to italic.| -||[name](/.shapefont#powerpoint-javascript/api/powerpoint/-shapefont-name-member)|Specifies the font name (e.g., "Calibri").| -||[size](/.shapefont#powerpoint-javascript/api/powerpoint/-shapefont-size-member)|Specifies the font size in points (e.g., 11).| -||[underline](/.shapefont#powerpoint-javascript/api/powerpoint/-shapefont-underline-member)|Specifies the type of underline applied to the font.| -|[ShapeLineFormat](/.shapelineformat)|[color](/.shapelineformat#powerpoint-javascript/api/powerpoint/-shapelineformat-color-member)|Represents the line color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").| -||[dashStyle](/.shapelineformat#powerpoint-javascript/api/powerpoint/-shapelineformat-dashstyle-member)|Represents the dash style of the line.| -||[style](/.shapelineformat#powerpoint-javascript/api/powerpoint/-shapelineformat-style-member)|Represents the line style of the shape.| -||[transparency](/.shapelineformat#powerpoint-javascript/api/powerpoint/-shapelineformat-transparency-member)|Specifies the transparency percentage of the line as a value from 0.0 (opaque) through 1.0 (clear).| -||[visible](/.shapelineformat#powerpoint-javascript/api/powerpoint/-shapelineformat-visible-member)|Specifies if the line formatting of a shape element is visible.| -||[weight](/.shapelineformat#powerpoint-javascript/api/powerpoint/-shapelineformat-weight-member)|Represents the weight of the line, in points.| -|[TextFrame](/.textframe)|[autoSizeSetting](/.textframe#powerpoint-javascript/api/powerpoint/-textframe-autosizesetting-member)|The automatic sizing settings for the text frame.| -||[bottomMargin](/.textframe#powerpoint-javascript/api/powerpoint/-textframe-bottommargin-member)|Represents the bottom margin, in points, of the text frame.| -||[deleteText()](/.textframe#powerpoint-javascript/api/powerpoint/-textframe-deletetext-member(1))|Deletes all the text in the text frame.| -||[hasText](/.textframe#powerpoint-javascript/api/powerpoint/-textframe-hastext-member)|Specifies if the text frame contains text.| -||[leftMargin](/.textframe#powerpoint-javascript/api/powerpoint/-textframe-leftmargin-member)|Represents the left margin, in points, of the text frame.| -||[rightMargin](/.textframe#powerpoint-javascript/api/powerpoint/-textframe-rightmargin-member)|Represents the right margin, in points, of the text frame.| -||[textRange](/.textframe#powerpoint-javascript/api/powerpoint/-textframe-textrange-member)|Represents the text that is attached to a shape in the text frame, and properties and methods for manipulating the text.| -||[topMargin](/.textframe#powerpoint-javascript/api/powerpoint/-textframe-topmargin-member)|Represents the top margin, in points, of the text frame.| -||[verticalAlignment](/.textframe#powerpoint-javascript/api/powerpoint/-textframe-verticalalignment-member)|Represents the vertical alignment of the text frame.| -||[wordWrap](/.textframe#powerpoint-javascript/api/powerpoint/-textframe-wordwrap-member)|Determines whether lines break automatically to fit text inside the shape.| -|[TextRange](/.textrange)|[font](/.textrange#powerpoint-javascript/api/powerpoint/-textrange-font-member)|Returns a `ShapeFont` object that represents the font attributes for the text range.| -||[getSubstring(start: number, length?: number)](/.textrange#powerpoint-javascript/api/powerpoint/-textrange-getsubstring-member(1))|Returns a `TextRange` object for the substring in the given range.| -||[paragraphFormat](/.textrange#powerpoint-javascript/api/powerpoint/-textrange-paragraphformat-member)|Represents the paragraph format of the text range.| -||[text](/.textrange#powerpoint-javascript/api/powerpoint/-textrange-text-member)|Represents the plain text content of the text range.| +|[BulletFormat](/javascript/api/powerpoint/powerpoint.bulletformat)|[visible](/javascript/api/powerpoint/powerpoint.bulletformat#powerpoint-powerpoint-bulletformat-visible-member)|Specifies if the bullets in the paragraph are visible.| +|[ParagraphFormat](/javascript/api/powerpoint/powerpoint.paragraphformat)|[bulletFormat](/javascript/api/powerpoint/powerpoint.paragraphformat#powerpoint-powerpoint-paragraphformat-bulletformat-member)|Represents the bullet format of the paragraph.| +||[horizontalAlignment](/javascript/api/powerpoint/powerpoint.paragraphformat#powerpoint-powerpoint-paragraphformat-horizontalalignment-member)|Represents the horizontal alignment of the paragraph.| +|[Shape](/javascript/api/powerpoint/powerpoint.shape)|[fill](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-fill-member)|Returns the fill formatting of this shape.| +||[height](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-height-member)|Specifies the height, in points, of the shape.| +||[left](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-left-member)|The distance, in points, from the left side of the shape to the left side of the slide.| +||[lineFormat](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-lineformat-member)|Returns the line formatting of this shape.| +||[name](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-name-member)|Specifies the name of this shape.| +||[textFrame](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-textframe-member)|Returns the PowerPoint.TextFrame object of this `Shape`.| +||[top](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-top-member)|The distance, in points, from the top edge of the shape to the top edge of the slide.| +||[type](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-type-member)|Returns the type of this shape.| +||[width](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-width-member)|Specifies the width, in points, of the shape.| +|[ShapeAddOptions](/javascript/api/powerpoint/powerpoint.shapeaddoptions)|[height](/javascript/api/powerpoint/powerpoint.shapeaddoptions#powerpoint-powerpoint-shapeaddoptions-height-member)|Specifies the height, in points, of the shape.| +||[left](/javascript/api/powerpoint/powerpoint.shapeaddoptions#powerpoint-powerpoint-shapeaddoptions-left-member)|Specifies the distance, in points, from the left side of the shape to the left side of the slide.| +||[top](/javascript/api/powerpoint/powerpoint.shapeaddoptions#powerpoint-powerpoint-shapeaddoptions-top-member)|Specifies the distance, in points, from the top edge of the shape to the top edge of the slide.| +||[width](/javascript/api/powerpoint/powerpoint.shapeaddoptions#powerpoint-powerpoint-shapeaddoptions-width-member)|Specifies the width, in points, of the shape.| +|[ShapeCollection](/javascript/api/powerpoint/powerpoint.shapecollection)|[addGeometricShape(geometricShapeType: PowerPoint.GeometricShapeType, options?: PowerPoint.ShapeAddOptions)](/javascript/api/powerpoint/powerpoint.shapecollection#powerpoint-powerpoint-shapecollection-addgeometricshape-member(1))|Adds a geometric shape to the slide.| +||[addLine(connectorType?: PowerPoint.ConnectorType, options?: PowerPoint.ShapeAddOptions)](/javascript/api/powerpoint/powerpoint.shapecollection#powerpoint-powerpoint-shapecollection-addline-member(1))|Adds a line to the slide.| +||[addTextBox(text: string, options?: PowerPoint.ShapeAddOptions)](/javascript/api/powerpoint/powerpoint.shapecollection#powerpoint-powerpoint-shapecollection-addtextbox-member(1))|Adds a text box to the slide with the provided text as the content.| +|[ShapeFill](/javascript/api/powerpoint/powerpoint.shapefill)|[clear()](/javascript/api/powerpoint/powerpoint.shapefill#powerpoint-powerpoint-shapefill-clear-member(1))|Clears the fill formatting of this shape.| +||[foregroundColor](/javascript/api/powerpoint/powerpoint.shapefill#powerpoint-powerpoint-shapefill-foregroundcolor-member)|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").| +||[setSolidColor(color: string)](/javascript/api/powerpoint/powerpoint.shapefill#powerpoint-powerpoint-shapefill-setsolidcolor-member(1))|Sets the fill formatting of the shape to a uniform color.| +||[transparency](/javascript/api/powerpoint/powerpoint.shapefill#powerpoint-powerpoint-shapefill-transparency-member)|Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).| +||[type](/javascript/api/powerpoint/powerpoint.shapefill#powerpoint-powerpoint-shapefill-type-member)|Returns the fill type of the shape.| +|[ShapeFont](/javascript/api/powerpoint/powerpoint.shapefont)|[bold](/javascript/api/powerpoint/powerpoint.shapefont#powerpoint-powerpoint-shapefont-bold-member)|Specifies whether the text in the `TextRange` is set to bold.| +||[color](/javascript/api/powerpoint/powerpoint.shapefont#powerpoint-powerpoint-shapefont-color-member)|Specifies the HTML color code representation of the text color (e.g., "#FF0000" represents red).| +||[italic](/javascript/api/powerpoint/powerpoint.shapefont#powerpoint-powerpoint-shapefont-italic-member)|Specifies whether the text in the `TextRange` is set to italic.| +||[name](/javascript/api/powerpoint/powerpoint.shapefont#powerpoint-powerpoint-shapefont-name-member)|Specifies the font name (e.g., "Calibri").| +||[size](/javascript/api/powerpoint/powerpoint.shapefont#powerpoint-powerpoint-shapefont-size-member)|Specifies the font size in points (e.g., 11).| +||[underline](/javascript/api/powerpoint/powerpoint.shapefont#powerpoint-powerpoint-shapefont-underline-member)|Specifies the type of underline applied to the font.| +|[ShapeLineFormat](/javascript/api/powerpoint/powerpoint.shapelineformat)|[color](/javascript/api/powerpoint/powerpoint.shapelineformat#powerpoint-powerpoint-shapelineformat-color-member)|Represents the line color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").| +||[dashStyle](/javascript/api/powerpoint/powerpoint.shapelineformat#powerpoint-powerpoint-shapelineformat-dashstyle-member)|Represents the dash style of the line.| +||[style](/javascript/api/powerpoint/powerpoint.shapelineformat#powerpoint-powerpoint-shapelineformat-style-member)|Represents the line style of the shape.| +||[transparency](/javascript/api/powerpoint/powerpoint.shapelineformat#powerpoint-powerpoint-shapelineformat-transparency-member)|Specifies the transparency percentage of the line as a value from 0.0 (opaque) through 1.0 (clear).| +||[visible](/javascript/api/powerpoint/powerpoint.shapelineformat#powerpoint-powerpoint-shapelineformat-visible-member)|Specifies if the line formatting of a shape element is visible.| +||[weight](/javascript/api/powerpoint/powerpoint.shapelineformat#powerpoint-powerpoint-shapelineformat-weight-member)|Represents the weight of the line, in points.| +|[TextFrame](/javascript/api/powerpoint/powerpoint.textframe)|[autoSizeSetting](/javascript/api/powerpoint/powerpoint.textframe#powerpoint-powerpoint-textframe-autosizesetting-member)|The automatic sizing settings for the text frame.| +||[bottomMargin](/javascript/api/powerpoint/powerpoint.textframe#powerpoint-powerpoint-textframe-bottommargin-member)|Represents the bottom margin, in points, of the text frame.| +||[deleteText()](/javascript/api/powerpoint/powerpoint.textframe#powerpoint-powerpoint-textframe-deletetext-member(1))|Deletes all the text in the text frame.| +||[hasText](/javascript/api/powerpoint/powerpoint.textframe#powerpoint-powerpoint-textframe-hastext-member)|Specifies if the text frame contains text.| +||[leftMargin](/javascript/api/powerpoint/powerpoint.textframe#powerpoint-powerpoint-textframe-leftmargin-member)|Represents the left margin, in points, of the text frame.| +||[rightMargin](/javascript/api/powerpoint/powerpoint.textframe#powerpoint-powerpoint-textframe-rightmargin-member)|Represents the right margin, in points, of the text frame.| +||[textRange](/javascript/api/powerpoint/powerpoint.textframe#powerpoint-powerpoint-textframe-textrange-member)|Represents the text that is attached to a shape in the text frame, and properties and methods for manipulating the text.| +||[topMargin](/javascript/api/powerpoint/powerpoint.textframe#powerpoint-powerpoint-textframe-topmargin-member)|Represents the top margin, in points, of the text frame.| +||[verticalAlignment](/javascript/api/powerpoint/powerpoint.textframe#powerpoint-powerpoint-textframe-verticalalignment-member)|Represents the vertical alignment of the text frame.| +||[wordWrap](/javascript/api/powerpoint/powerpoint.textframe#powerpoint-powerpoint-textframe-wordwrap-member)|Determines whether lines break automatically to fit text inside the shape.| +|[TextRange](/javascript/api/powerpoint/powerpoint.textrange)|[font](/javascript/api/powerpoint/powerpoint.textrange#powerpoint-powerpoint-textrange-font-member)|Returns a `ShapeFont` object that represents the font attributes for the text range.| +||[getSubstring(start: number, length?: number)](/javascript/api/powerpoint/powerpoint.textrange#powerpoint-powerpoint-textrange-getsubstring-member(1))|Returns a `TextRange` object for the substring in the given range.| +||[paragraphFormat](/javascript/api/powerpoint/powerpoint.textrange#powerpoint-powerpoint-textrange-paragraphformat-member)|Represents the paragraph format of the text range.| +||[text](/javascript/api/powerpoint/powerpoint.textrange#powerpoint-powerpoint-textrange-text-member)|Represents the plain text content of the text range.| diff --git a/docs/includes/powerpoint-1_5.md b/docs/includes/powerpoint-1_5.md index 7dc592c644..b089d487a1 100644 --- a/docs/includes/powerpoint-1_5.md +++ b/docs/includes/powerpoint-1_5.md @@ -1,30 +1,30 @@ | Class | Fields | Description | |:---|:---|:---| -|[Presentation](/.presentation)|[getSelectedShapes()](/.presentation#powerpoint-javascript/api/powerpoint/-presentation-getselectedshapes-member(1))|Returns the selected shapes in the current slide of the presentation.| -||[getSelectedSlides()](/.presentation#powerpoint-javascript/api/powerpoint/-presentation-getselectedslides-member(1))|Returns the selected slides in the current view of the presentation.| -||[getSelectedTextRange()](/.presentation#powerpoint-javascript/api/powerpoint/-presentation-getselectedtextrange-member(1))|Returns the selected PowerPoint.TextRange in the current view of the presentation.| -||[getSelectedTextRangeOrNullObject()](/.presentation#powerpoint-javascript/api/powerpoint/-presentation-getselectedtextrangeornullobject-member(1))|Returns the selected PowerPoint.TextRange in the current view of the presentation.| -||[id](/.presentation#powerpoint-javascript/api/powerpoint/-presentation-id-member)|Gets the ID of the presentation.| -||[setSelectedSlides(slideIds: string[])](/.presentation#powerpoint-javascript/api/powerpoint/-presentation-setselectedslides-member(1))|Selects the slides in the current view of the presentation.| -|[Shape](/.shape)|[getParentSlide()](/.shape#powerpoint-javascript/api/powerpoint/-shape-getparentslide-member(1))|Returns the parent PowerPoint.Slide object that holds this `Shape`.| -||[getParentSlideLayout()](/.shape#powerpoint-javascript/api/powerpoint/-shape-getparentslidelayout-member(1))|Returns the parent PowerPoint.SlideLayout object that holds this `Shape`.| -||[getParentSlideLayoutOrNullObject()](/.shape#powerpoint-javascript/api/powerpoint/-shape-getparentslidelayoutornullobject-member(1))|Returns the parent PowerPoint.SlideLayout object that holds this `Shape`.| -||[getParentSlideMaster()](/.shape#powerpoint-javascript/api/powerpoint/-shape-getparentslidemaster-member(1))|Returns the parent PowerPoint.SlideMaster object that holds this `Shape`.| -||[getParentSlideMasterOrNullObject()](/.shape#powerpoint-javascript/api/powerpoint/-shape-getparentslidemasterornullobject-member(1))|Returns the parent PowerPoint.SlideMaster object that holds this `Shape`.| -||[getParentSlideOrNullObject()](/.shape#powerpoint-javascript/api/powerpoint/-shape-getparentslideornullobject-member(1))|Returns the parent PowerPoint.Slide object that holds this `Shape`.| -|[ShapeScopedCollection](/.shapescopedcollection)|[getCount()](/.shapescopedcollection#powerpoint-javascript/api/powerpoint/-shapescopedcollection-getcount-member(1))|Gets the number of shapes in the collection.| -||[getItem(key: string)](/.shapescopedcollection#powerpoint-javascript/api/powerpoint/-shapescopedcollection-getitem-member(1))|Gets a shape using its unique ID.| -||[getItemAt(index: number)](/.shapescopedcollection#powerpoint-javascript/api/powerpoint/-shapescopedcollection-getitemat-member(1))|Gets a shape using its zero-based index in the collection.| -||[getItemOrNullObject(id: string)](/.shapescopedcollection#powerpoint-javascript/api/powerpoint/-shapescopedcollection-getitemornullobject-member(1))|Gets a shape using its unique ID.| -||[items](/.shapescopedcollection#powerpoint-javascript/api/powerpoint/-shapescopedcollection-items-member)|Gets the loaded child items in this collection.| -|[Slide](/.slide)|[setSelectedShapes(shapeIds: string[])](/.slide#powerpoint-javascript/api/powerpoint/-slide-setselectedshapes-member(1))|Selects the specified shapes.| -|[SlideScopedCollection](/.slidescopedcollection)|[getCount()](/.slidescopedcollection#powerpoint-javascript/api/powerpoint/-slidescopedcollection-getcount-member(1))|Gets the number of slides in the collection.| -||[getItem(key: string)](/.slidescopedcollection#powerpoint-javascript/api/powerpoint/-slidescopedcollection-getitem-member(1))|Gets a slide using its unique ID.| -||[getItemAt(index: number)](/.slidescopedcollection#powerpoint-javascript/api/powerpoint/-slidescopedcollection-getitemat-member(1))|Gets a slide using its zero-based index in the collection.| -||[getItemOrNullObject(id: string)](/.slidescopedcollection#powerpoint-javascript/api/powerpoint/-slidescopedcollection-getitemornullobject-member(1))|Gets a slide using its unique ID.| -||[items](/.slidescopedcollection#powerpoint-javascript/api/powerpoint/-slidescopedcollection-items-member)|Gets the loaded child items in this collection.| -|[TextFrame](/.textframe)|[getParentShape()](/.textframe#powerpoint-javascript/api/powerpoint/-textframe-getparentshape-member(1))|Returns the parent PowerPoint.Shape object that holds this `TextFrame`.| -|[TextRange](/.textrange)|[getParentTextFrame()](/.textrange#powerpoint-javascript/api/powerpoint/-textrange-getparenttextframe-member(1))|Returns the parent PowerPoint.TextFrame object that holds this `TextRange`.| -||[length](/.textrange#powerpoint-javascript/api/powerpoint/-textrange-length-member)|Gets or sets the length of the range that this `TextRange` represents.| -||[setSelected()](/.textrange#powerpoint-javascript/api/powerpoint/-textrange-setselected-member(1))|Selects this `TextRange` in the current view.| -||[start](/.textrange#powerpoint-javascript/api/powerpoint/-textrange-start-member)|Gets or sets zero-based index, relative to the parent text frame, for the starting position of the range that this `TextRange` represents.| +|[Presentation](/javascript/api/powerpoint/powerpoint.presentation)|[getSelectedShapes()](/javascript/api/powerpoint/powerpoint.presentation#powerpoint-powerpoint-presentation-getselectedshapes-member(1))|Returns the selected shapes in the current slide of the presentation.| +||[getSelectedSlides()](/javascript/api/powerpoint/powerpoint.presentation#powerpoint-powerpoint-presentation-getselectedslides-member(1))|Returns the selected slides in the current view of the presentation.| +||[getSelectedTextRange()](/javascript/api/powerpoint/powerpoint.presentation#powerpoint-powerpoint-presentation-getselectedtextrange-member(1))|Returns the selected PowerPoint.TextRange in the current view of the presentation.| +||[getSelectedTextRangeOrNullObject()](/javascript/api/powerpoint/powerpoint.presentation#powerpoint-powerpoint-presentation-getselectedtextrangeornullobject-member(1))|Returns the selected PowerPoint.TextRange in the current view of the presentation.| +||[id](/javascript/api/powerpoint/powerpoint.presentation#powerpoint-powerpoint-presentation-id-member)|Gets the ID of the presentation.| +||[setSelectedSlides(slideIds: string[])](/javascript/api/powerpoint/powerpoint.presentation#powerpoint-powerpoint-presentation-setselectedslides-member(1))|Selects the slides in the current view of the presentation.| +|[Shape](/javascript/api/powerpoint/powerpoint.shape)|[getParentSlide()](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-getparentslide-member(1))|Returns the parent PowerPoint.Slide object that holds this `Shape`.| +||[getParentSlideLayout()](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-getparentslidelayout-member(1))|Returns the parent PowerPoint.SlideLayout object that holds this `Shape`.| +||[getParentSlideLayoutOrNullObject()](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-getparentslidelayoutornullobject-member(1))|Returns the parent PowerPoint.SlideLayout object that holds this `Shape`.| +||[getParentSlideMaster()](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-getparentslidemaster-member(1))|Returns the parent PowerPoint.SlideMaster object that holds this `Shape`.| +||[getParentSlideMasterOrNullObject()](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-getparentslidemasterornullobject-member(1))|Returns the parent PowerPoint.SlideMaster object that holds this `Shape`.| +||[getParentSlideOrNullObject()](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-getparentslideornullobject-member(1))|Returns the parent PowerPoint.Slide object that holds this `Shape`.| +|[ShapeScopedCollection](/javascript/api/powerpoint/powerpoint.shapescopedcollection)|[getCount()](/javascript/api/powerpoint/powerpoint.shapescopedcollection#powerpoint-powerpoint-shapescopedcollection-getcount-member(1))|Gets the number of shapes in the collection.| +||[getItem(key: string)](/javascript/api/powerpoint/powerpoint.shapescopedcollection#powerpoint-powerpoint-shapescopedcollection-getitem-member(1))|Gets a shape using its unique ID.| +||[getItemAt(index: number)](/javascript/api/powerpoint/powerpoint.shapescopedcollection#powerpoint-powerpoint-shapescopedcollection-getitemat-member(1))|Gets a shape using its zero-based index in the collection.| +||[getItemOrNullObject(id: string)](/javascript/api/powerpoint/powerpoint.shapescopedcollection#powerpoint-powerpoint-shapescopedcollection-getitemornullobject-member(1))|Gets a shape using its unique ID.| +||[items](/javascript/api/powerpoint/powerpoint.shapescopedcollection#powerpoint-powerpoint-shapescopedcollection-items-member)|Gets the loaded child items in this collection.| +|[Slide](/javascript/api/powerpoint/powerpoint.slide)|[setSelectedShapes(shapeIds: string[])](/javascript/api/powerpoint/powerpoint.slide#powerpoint-powerpoint-slide-setselectedshapes-member(1))|Selects the specified shapes.| +|[SlideScopedCollection](/javascript/api/powerpoint/powerpoint.slidescopedcollection)|[getCount()](/javascript/api/powerpoint/powerpoint.slidescopedcollection#powerpoint-powerpoint-slidescopedcollection-getcount-member(1))|Gets the number of slides in the collection.| +||[getItem(key: string)](/javascript/api/powerpoint/powerpoint.slidescopedcollection#powerpoint-powerpoint-slidescopedcollection-getitem-member(1))|Gets a slide using its unique ID.| +||[getItemAt(index: number)](/javascript/api/powerpoint/powerpoint.slidescopedcollection#powerpoint-powerpoint-slidescopedcollection-getitemat-member(1))|Gets a slide using its zero-based index in the collection.| +||[getItemOrNullObject(id: string)](/javascript/api/powerpoint/powerpoint.slidescopedcollection#powerpoint-powerpoint-slidescopedcollection-getitemornullobject-member(1))|Gets a slide using its unique ID.| +||[items](/javascript/api/powerpoint/powerpoint.slidescopedcollection#powerpoint-powerpoint-slidescopedcollection-items-member)|Gets the loaded child items in this collection.| +|[TextFrame](/javascript/api/powerpoint/powerpoint.textframe)|[getParentShape()](/javascript/api/powerpoint/powerpoint.textframe#powerpoint-powerpoint-textframe-getparentshape-member(1))|Returns the parent PowerPoint.Shape object that holds this `TextFrame`.| +|[TextRange](/javascript/api/powerpoint/powerpoint.textrange)|[getParentTextFrame()](/javascript/api/powerpoint/powerpoint.textrange#powerpoint-powerpoint-textrange-getparenttextframe-member(1))|Returns the parent PowerPoint.TextFrame object that holds this `TextRange`.| +||[length](/javascript/api/powerpoint/powerpoint.textrange#powerpoint-powerpoint-textrange-length-member)|Gets or sets the length of the range that this `TextRange` represents.| +||[setSelected()](/javascript/api/powerpoint/powerpoint.textrange#powerpoint-powerpoint-textrange-setselected-member(1))|Selects this `TextRange` in the current view.| +||[start](/javascript/api/powerpoint/powerpoint.textrange#powerpoint-powerpoint-textrange-start-member)|Gets or sets zero-based index, relative to the parent text frame, for the starting position of the range that this `TextRange` represents.| diff --git a/docs/includes/powerpoint-1_6.md b/docs/includes/powerpoint-1_6.md index 1241204692..40378a4c54 100644 --- a/docs/includes/powerpoint-1_6.md +++ b/docs/includes/powerpoint-1_6.md @@ -1,8 +1,8 @@ | Class | Fields | Description | |:---|:---|:---| -|[Hyperlink](/.hyperlink)|[address](/.hyperlink#powerpoint-javascript/api/powerpoint/-hyperlink-address-member)|Specifies the URL target of the hyperlink.| -||[screenTip](/.hyperlink#powerpoint-javascript/api/powerpoint/-hyperlink-screentip-member)|Specifies the string displayed when hovering over the hyperlink.| -|[HyperlinkCollection](/.hyperlinkcollection)|[getCount()](/.hyperlinkcollection#powerpoint-javascript/api/powerpoint/-hyperlinkcollection-getcount-member(1))|Gets the number of hyperlinks in the collection.| -||[getItemAt(index: number)](/.hyperlinkcollection#powerpoint-javascript/api/powerpoint/-hyperlinkcollection-getitemat-member(1))|Gets a hyperlink using its zero-based index in the collection.| -||[items](/.hyperlinkcollection#powerpoint-javascript/api/powerpoint/-hyperlinkcollection-items-member)|Gets the loaded child items in this collection.| -|[Slide](/.slide)|[hyperlinks](/.slide#powerpoint-javascript/api/powerpoint/-slide-hyperlinks-member)|Returns a collection of hyperlinks in the slide.| +|[Hyperlink](/javascript/api/powerpoint/powerpoint.hyperlink)|[address](/javascript/api/powerpoint/powerpoint.hyperlink#powerpoint-powerpoint-hyperlink-address-member)|Specifies the URL target of the hyperlink.| +||[screenTip](/javascript/api/powerpoint/powerpoint.hyperlink#powerpoint-powerpoint-hyperlink-screentip-member)|Specifies the string displayed when hovering over the hyperlink.| +|[HyperlinkCollection](/javascript/api/powerpoint/powerpoint.hyperlinkcollection)|[getCount()](/javascript/api/powerpoint/powerpoint.hyperlinkcollection#powerpoint-powerpoint-hyperlinkcollection-getcount-member(1))|Gets the number of hyperlinks in the collection.| +||[getItemAt(index: number)](/javascript/api/powerpoint/powerpoint.hyperlinkcollection#powerpoint-powerpoint-hyperlinkcollection-getitemat-member(1))|Gets a hyperlink using its zero-based index in the collection.| +||[items](/javascript/api/powerpoint/powerpoint.hyperlinkcollection#powerpoint-powerpoint-hyperlinkcollection-items-member)|Gets the loaded child items in this collection.| +|[Slide](/javascript/api/powerpoint/powerpoint.slide)|[hyperlinks](/javascript/api/powerpoint/powerpoint.slide#powerpoint-powerpoint-slide-hyperlinks-member)|Returns a collection of hyperlinks in the slide.| diff --git a/docs/includes/powerpoint-1_7.md b/docs/includes/powerpoint-1_7.md index 1aacb347c8..01fda263b8 100644 --- a/docs/includes/powerpoint-1_7.md +++ b/docs/includes/powerpoint-1_7.md @@ -1,47 +1,47 @@ | Class | Fields | Description | |:---|:---|:---| -|[CustomProperty](/.customproperty)|[delete()](/.customproperty#powerpoint-javascript/api/powerpoint/-customproperty-delete-member(1))|Deletes the custom property.| -||[key](/.customproperty#powerpoint-javascript/api/powerpoint/-customproperty-key-member)|The string that uniquely identifies the custom property.| -||[type](/.customproperty#powerpoint-javascript/api/powerpoint/-customproperty-type-member)|The type of the value used for the custom property.| -||[value](/.customproperty#powerpoint-javascript/api/powerpoint/-customproperty-value-member)|The value of the custom property.| -|[CustomPropertyCollection](/.custompropertycollection)|[add(key: string, value: boolean \| Date \| number \| string)](/.custompropertycollection#powerpoint-javascript/api/powerpoint/-custompropertycollection-add-member(1))|Creates a new `CustomProperty` or updates the property with the given key.| -||[deleteAll()](/.custompropertycollection#powerpoint-javascript/api/powerpoint/-custompropertycollection-deleteall-member(1))|Deletes all custom properties in this collection.| -||[getCount()](/.custompropertycollection#powerpoint-javascript/api/powerpoint/-custompropertycollection-getcount-member(1))|Gets the number of custom properties in the collection.| -||[getItem(key: string)](/.custompropertycollection#powerpoint-javascript/api/powerpoint/-custompropertycollection-getitem-member(1))|Gets a `CustomProperty` by its key.| -||[getItemOrNullObject(key: string)](/.custompropertycollection#powerpoint-javascript/api/powerpoint/-custompropertycollection-getitemornullobject-member(1))|Gets a `CustomProperty` by its key.| -||[items](/.custompropertycollection#powerpoint-javascript/api/powerpoint/-custompropertycollection-items-member)|Gets the loaded child items in this collection.| -|[CustomXmlPart](/.customxmlpart)|[delete()](/.customxmlpart#powerpoint-javascript/api/powerpoint/-customxmlpart-delete-member(1))|Deletes the custom XML part.| -||[getXml()](/.customxmlpart#powerpoint-javascript/api/powerpoint/-customxmlpart-getxml-member(1))|Gets the XML content of the custom XML part.| -||[id](/.customxmlpart#powerpoint-javascript/api/powerpoint/-customxmlpart-id-member)|The ID of the custom XML part.| -||[namespaceUri](/.customxmlpart#powerpoint-javascript/api/powerpoint/-customxmlpart-namespaceuri-member)|The namespace URI of the custom XML part.| -||[setXml(xml: string)](/.customxmlpart#powerpoint-javascript/api/powerpoint/-customxmlpart-setxml-member(1))|Sets the XML content for the custom XML part.| -|[CustomXmlPartCollection](/.customxmlpartcollection)|[add(xml: string)](/.customxmlpartcollection#powerpoint-javascript/api/powerpoint/-customxmlpartcollection-add-member(1))|Adds a new `CustomXmlPart` to the collection.| -||[getByNamespace(namespaceUri: string)](/.customxmlpartcollection#powerpoint-javascript/api/powerpoint/-customxmlpartcollection-getbynamespace-member(1))|Gets a new scoped collection of custom XML parts whose namespaces match the given namespace.| -||[getCount()](/.customxmlpartcollection#powerpoint-javascript/api/powerpoint/-customxmlpartcollection-getcount-member(1))|Gets the number of custom XML parts in the collection.| -||[getItem(id: string)](/.customxmlpartcollection#powerpoint-javascript/api/powerpoint/-customxmlpartcollection-getitem-member(1))|Gets a `CustomXmlPart` based on its ID.| -||[getItemOrNullObject(id: string)](/.customxmlpartcollection#powerpoint-javascript/api/powerpoint/-customxmlpartcollection-getitemornullobject-member(1))|Gets a `CustomXmlPart` based on its ID.| -||[items](/.customxmlpartcollection#powerpoint-javascript/api/powerpoint/-customxmlpartcollection-items-member)|Gets the loaded child items in this collection.| -|[CustomXmlPartScopedCollection](/.customxmlpartscopedcollection)|[getCount()](/.customxmlpartscopedcollection#powerpoint-javascript/api/powerpoint/-customxmlpartscopedcollection-getcount-member(1))|Gets the number of custom XML parts in this collection.| -||[getItem(id: string)](/.customxmlpartscopedcollection#powerpoint-javascript/api/powerpoint/-customxmlpartscopedcollection-getitem-member(1))|Gets a `CustomXmlPart` based on its ID.| -||[getItemOrNullObject(id: string)](/.customxmlpartscopedcollection#powerpoint-javascript/api/powerpoint/-customxmlpartscopedcollection-getitemornullobject-member(1))|Gets a `CustomXmlPart` based on its ID.| -||[getOnlyItem()](/.customxmlpartscopedcollection#powerpoint-javascript/api/powerpoint/-customxmlpartscopedcollection-getonlyitem-member(1))|If the collection contains exactly one item, this method returns it.| -||[getOnlyItemOrNullObject()](/.customxmlpartscopedcollection#powerpoint-javascript/api/powerpoint/-customxmlpartscopedcollection-getonlyitemornullobject-member(1))|If the collection contains exactly one item, this method returns it.| -||[items](/.customxmlpartscopedcollection#powerpoint-javascript/api/powerpoint/-customxmlpartscopedcollection-items-member)|Gets the loaded child items in this collection.| -|[DocumentProperties](/.documentproperties)|[author](/.documentproperties#powerpoint-javascript/api/powerpoint/-documentproperties-author-member)|The author of the presentation.| -||[category](/.documentproperties#powerpoint-javascript/api/powerpoint/-documentproperties-category-member)|The category of the presentation.| -||[comments](/.documentproperties#powerpoint-javascript/api/powerpoint/-documentproperties-comments-member)|The Comments field in the metadata of the presentation.| -||[company](/.documentproperties#powerpoint-javascript/api/powerpoint/-documentproperties-company-member)|The company of the presentation.| -||[creationDate](/.documentproperties#powerpoint-javascript/api/powerpoint/-documentproperties-creationdate-member)|The creation date of the presentation.| -||[customProperties](/.documentproperties#powerpoint-javascript/api/powerpoint/-documentproperties-customproperties-member)|The collection of custom properties of the presentation.| -||[keywords](/.documentproperties#powerpoint-javascript/api/powerpoint/-documentproperties-keywords-member)|The keywords of the presentation.| -||[lastAuthor](/.documentproperties#powerpoint-javascript/api/powerpoint/-documentproperties-lastauthor-member)|The last author of the presentation.| -||[manager](/.documentproperties#powerpoint-javascript/api/powerpoint/-documentproperties-manager-member)|The manager of the presentation.| -||[revisionNumber](/.documentproperties#powerpoint-javascript/api/powerpoint/-documentproperties-revisionnumber-member)|The revision number of the presentation.| -||[subject](/.documentproperties#powerpoint-javascript/api/powerpoint/-documentproperties-subject-member)|The subject of the presentation.| -||[title](/.documentproperties#powerpoint-javascript/api/powerpoint/-documentproperties-title-member)|The title of the presentation.| -|[Presentation](/.presentation)|[customXmlParts](/.presentation#powerpoint-javascript/api/powerpoint/-presentation-customxmlparts-member)|Returns a collection of custom XML parts that are associated with the presentation.| -||[properties](/.presentation#powerpoint-javascript/api/powerpoint/-presentation-properties-member)|Gets the properties of the presentation.| -|[Shape](/.shape)|[customXmlParts](/.shape#powerpoint-javascript/api/powerpoint/-shape-customxmlparts-member)|Returns a collection of custom XML parts in the shape.| -|[Slide](/.slide)|[customXmlParts](/.slide#powerpoint-javascript/api/powerpoint/-slide-customxmlparts-member)|Returns a collection of custom XML parts in the slide.| -|[SlideLayout](/.slidelayout)|[customXmlParts](/.slidelayout#powerpoint-javascript/api/powerpoint/-slidelayout-customxmlparts-member)|Returns a collection of custom XML parts in the slide layout.| -|[SlideMaster](/.slidemaster)|[customXmlParts](/.slidemaster#powerpoint-javascript/api/powerpoint/-slidemaster-customxmlparts-member)|Returns a collection of custom XML parts in the Slide Master.| +|[CustomProperty](/javascript/api/powerpoint/powerpoint.customproperty)|[delete()](/javascript/api/powerpoint/powerpoint.customproperty#powerpoint-powerpoint-customproperty-delete-member(1))|Deletes the custom property.| +||[key](/javascript/api/powerpoint/powerpoint.customproperty#powerpoint-powerpoint-customproperty-key-member)|The string that uniquely identifies the custom property.| +||[type](/javascript/api/powerpoint/powerpoint.customproperty#powerpoint-powerpoint-customproperty-type-member)|The type of the value used for the custom property.| +||[value](/javascript/api/powerpoint/powerpoint.customproperty#powerpoint-powerpoint-customproperty-value-member)|The value of the custom property.| +|[CustomPropertyCollection](/javascript/api/powerpoint/powerpoint.custompropertycollection)|[add(key: string, value: boolean \| Date \| number \| string)](/javascript/api/powerpoint/powerpoint.custompropertycollection#powerpoint-powerpoint-custompropertycollection-add-member(1))|Creates a new `CustomProperty` or updates the property with the given key.| +||[deleteAll()](/javascript/api/powerpoint/powerpoint.custompropertycollection#powerpoint-powerpoint-custompropertycollection-deleteall-member(1))|Deletes all custom properties in this collection.| +||[getCount()](/javascript/api/powerpoint/powerpoint.custompropertycollection#powerpoint-powerpoint-custompropertycollection-getcount-member(1))|Gets the number of custom properties in the collection.| +||[getItem(key: string)](/javascript/api/powerpoint/powerpoint.custompropertycollection#powerpoint-powerpoint-custompropertycollection-getitem-member(1))|Gets a `CustomProperty` by its key.| +||[getItemOrNullObject(key: string)](/javascript/api/powerpoint/powerpoint.custompropertycollection#powerpoint-powerpoint-custompropertycollection-getitemornullobject-member(1))|Gets a `CustomProperty` by its key.| +||[items](/javascript/api/powerpoint/powerpoint.custompropertycollection#powerpoint-powerpoint-custompropertycollection-items-member)|Gets the loaded child items in this collection.| +|[CustomXmlPart](/javascript/api/powerpoint/powerpoint.customxmlpart)|[delete()](/javascript/api/powerpoint/powerpoint.customxmlpart#powerpoint-powerpoint-customxmlpart-delete-member(1))|Deletes the custom XML part.| +||[getXml()](/javascript/api/powerpoint/powerpoint.customxmlpart#powerpoint-powerpoint-customxmlpart-getxml-member(1))|Gets the XML content of the custom XML part.| +||[id](/javascript/api/powerpoint/powerpoint.customxmlpart#powerpoint-powerpoint-customxmlpart-id-member)|The ID of the custom XML part.| +||[namespaceUri](/javascript/api/powerpoint/powerpoint.customxmlpart#powerpoint-powerpoint-customxmlpart-namespaceuri-member)|The namespace URI of the custom XML part.| +||[setXml(xml: string)](/javascript/api/powerpoint/powerpoint.customxmlpart#powerpoint-powerpoint-customxmlpart-setxml-member(1))|Sets the XML content for the custom XML part.| +|[CustomXmlPartCollection](/javascript/api/powerpoint/powerpoint.customxmlpartcollection)|[add(xml: string)](/javascript/api/powerpoint/powerpoint.customxmlpartcollection#powerpoint-powerpoint-customxmlpartcollection-add-member(1))|Adds a new `CustomXmlPart` to the collection.| +||[getByNamespace(namespaceUri: string)](/javascript/api/powerpoint/powerpoint.customxmlpartcollection#powerpoint-powerpoint-customxmlpartcollection-getbynamespace-member(1))|Gets a new scoped collection of custom XML parts whose namespaces match the given namespace.| +||[getCount()](/javascript/api/powerpoint/powerpoint.customxmlpartcollection#powerpoint-powerpoint-customxmlpartcollection-getcount-member(1))|Gets the number of custom XML parts in the collection.| +||[getItem(id: string)](/javascript/api/powerpoint/powerpoint.customxmlpartcollection#powerpoint-powerpoint-customxmlpartcollection-getitem-member(1))|Gets a `CustomXmlPart` based on its ID.| +||[getItemOrNullObject(id: string)](/javascript/api/powerpoint/powerpoint.customxmlpartcollection#powerpoint-powerpoint-customxmlpartcollection-getitemornullobject-member(1))|Gets a `CustomXmlPart` based on its ID.| +||[items](/javascript/api/powerpoint/powerpoint.customxmlpartcollection#powerpoint-powerpoint-customxmlpartcollection-items-member)|Gets the loaded child items in this collection.| +|[CustomXmlPartScopedCollection](/javascript/api/powerpoint/powerpoint.customxmlpartscopedcollection)|[getCount()](/javascript/api/powerpoint/powerpoint.customxmlpartscopedcollection#powerpoint-powerpoint-customxmlpartscopedcollection-getcount-member(1))|Gets the number of custom XML parts in this collection.| +||[getItem(id: string)](/javascript/api/powerpoint/powerpoint.customxmlpartscopedcollection#powerpoint-powerpoint-customxmlpartscopedcollection-getitem-member(1))|Gets a `CustomXmlPart` based on its ID.| +||[getItemOrNullObject(id: string)](/javascript/api/powerpoint/powerpoint.customxmlpartscopedcollection#powerpoint-powerpoint-customxmlpartscopedcollection-getitemornullobject-member(1))|Gets a `CustomXmlPart` based on its ID.| +||[getOnlyItem()](/javascript/api/powerpoint/powerpoint.customxmlpartscopedcollection#powerpoint-powerpoint-customxmlpartscopedcollection-getonlyitem-member(1))|If the collection contains exactly one item, this method returns it.| +||[getOnlyItemOrNullObject()](/javascript/api/powerpoint/powerpoint.customxmlpartscopedcollection#powerpoint-powerpoint-customxmlpartscopedcollection-getonlyitemornullobject-member(1))|If the collection contains exactly one item, this method returns it.| +||[items](/javascript/api/powerpoint/powerpoint.customxmlpartscopedcollection#powerpoint-powerpoint-customxmlpartscopedcollection-items-member)|Gets the loaded child items in this collection.| +|[DocumentProperties](/javascript/api/powerpoint/powerpoint.documentproperties)|[author](/javascript/api/powerpoint/powerpoint.documentproperties#powerpoint-powerpoint-documentproperties-author-member)|The author of the presentation.| +||[category](/javascript/api/powerpoint/powerpoint.documentproperties#powerpoint-powerpoint-documentproperties-category-member)|The category of the presentation.| +||[comments](/javascript/api/powerpoint/powerpoint.documentproperties#powerpoint-powerpoint-documentproperties-comments-member)|The Comments field in the metadata of the presentation.| +||[company](/javascript/api/powerpoint/powerpoint.documentproperties#powerpoint-powerpoint-documentproperties-company-member)|The company of the presentation.| +||[creationDate](/javascript/api/powerpoint/powerpoint.documentproperties#powerpoint-powerpoint-documentproperties-creationdate-member)|The creation date of the presentation.| +||[customProperties](/javascript/api/powerpoint/powerpoint.documentproperties#powerpoint-powerpoint-documentproperties-customproperties-member)|The collection of custom properties of the presentation.| +||[keywords](/javascript/api/powerpoint/powerpoint.documentproperties#powerpoint-powerpoint-documentproperties-keywords-member)|The keywords of the presentation.| +||[lastAuthor](/javascript/api/powerpoint/powerpoint.documentproperties#powerpoint-powerpoint-documentproperties-lastauthor-member)|The last author of the presentation.| +||[manager](/javascript/api/powerpoint/powerpoint.documentproperties#powerpoint-powerpoint-documentproperties-manager-member)|The manager of the presentation.| +||[revisionNumber](/javascript/api/powerpoint/powerpoint.documentproperties#powerpoint-powerpoint-documentproperties-revisionnumber-member)|The revision number of the presentation.| +||[subject](/javascript/api/powerpoint/powerpoint.documentproperties#powerpoint-powerpoint-documentproperties-subject-member)|The subject of the presentation.| +||[title](/javascript/api/powerpoint/powerpoint.documentproperties#powerpoint-powerpoint-documentproperties-title-member)|The title of the presentation.| +|[Presentation](/javascript/api/powerpoint/powerpoint.presentation)|[customXmlParts](/javascript/api/powerpoint/powerpoint.presentation#powerpoint-powerpoint-presentation-customxmlparts-member)|Returns a collection of custom XML parts that are associated with the presentation.| +||[properties](/javascript/api/powerpoint/powerpoint.presentation#powerpoint-powerpoint-presentation-properties-member)|Gets the properties of the presentation.| +|[Shape](/javascript/api/powerpoint/powerpoint.shape)|[customXmlParts](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-customxmlparts-member)|Returns a collection of custom XML parts in the shape.| +|[Slide](/javascript/api/powerpoint/powerpoint.slide)|[customXmlParts](/javascript/api/powerpoint/powerpoint.slide#powerpoint-powerpoint-slide-customxmlparts-member)|Returns a collection of custom XML parts in the slide.| +|[SlideLayout](/javascript/api/powerpoint/powerpoint.slidelayout)|[customXmlParts](/javascript/api/powerpoint/powerpoint.slidelayout#powerpoint-powerpoint-slidelayout-customxmlparts-member)|Returns a collection of custom XML parts in the slide layout.| +|[SlideMaster](/javascript/api/powerpoint/powerpoint.slidemaster)|[customXmlParts](/javascript/api/powerpoint/powerpoint.slidemaster#powerpoint-powerpoint-slidemaster-customxmlparts-member)|Returns a collection of custom XML parts in the Slide Master.| diff --git a/docs/includes/powerpoint-1_8.md b/docs/includes/powerpoint-1_8.md index 6b7ec31020..9635cf1a04 100644 --- a/docs/includes/powerpoint-1_8.md +++ b/docs/includes/powerpoint-1_8.md @@ -1,114 +1,114 @@ | Class | Fields | Description | |:---|:---|:---| -|[Binding](/.binding)|[delete()](/.binding#powerpoint-javascript/api/powerpoint/-binding-delete-member(1))|Deletes the binding.| -||[getShape()](/.binding#powerpoint-javascript/api/powerpoint/-binding-getshape-member(1))|Returns the shape represented by the binding.| -||[id](/.binding#powerpoint-javascript/api/powerpoint/-binding-id-member)|Represents the binding identifier.| -||[type](/.binding#powerpoint-javascript/api/powerpoint/-binding-type-member)|Returns the type of the binding.| -|[BindingCollection](/.bindingcollection)|[add(shape: PowerPoint.Shape, bindingType: PowerPoint.BindingType, id: string)](/.bindingcollection#powerpoint-javascript/api/powerpoint/-bindingcollection-add-member(1))|Adds a new binding to a particular Shape.| -||[addFromSelection(bindingType: PowerPoint.BindingType, id: string)](/.bindingcollection#powerpoint-javascript/api/powerpoint/-bindingcollection-addfromselection-member(1))|Adds a new binding based on the current selection.| -||[getCount()](/.bindingcollection#powerpoint-javascript/api/powerpoint/-bindingcollection-getcount-member(1))|Gets the number of bindings in the collection.| -||[getItem(key: string)](/.bindingcollection#powerpoint-javascript/api/powerpoint/-bindingcollection-getitem-member(1))|Gets a binding object by ID.| -||[getItemAt(index: number)](/.bindingcollection#powerpoint-javascript/api/powerpoint/-bindingcollection-getitemat-member(1))|Gets a binding object based on its position in the items array.| -||[getItemOrNullObject(id: string)](/.bindingcollection#powerpoint-javascript/api/powerpoint/-bindingcollection-getitemornullobject-member(1))|Gets a binding object by ID.| -||[items](/.bindingcollection#powerpoint-javascript/api/powerpoint/-bindingcollection-items-member)|Gets the loaded child items in this collection.| -|[BorderProperties](/.borderproperties)|[color](/.borderproperties#powerpoint-javascript/api/powerpoint/-borderproperties-color-member)|Represents the line color in the hexadecimal format #RRGGBB (e.g., "FFA500") or as a named HTML color value (e.g., "orange").| -||[dashStyle](/.borderproperties#powerpoint-javascript/api/powerpoint/-borderproperties-dashstyle-member)|Represents the dash style of the line.| -||[transparency](/.borderproperties#powerpoint-javascript/api/powerpoint/-borderproperties-transparency-member)|Specifies the transparency percentage of the line as a value from 0.0 (opaque) through 1.0 (clear).| -||[weight](/.borderproperties#powerpoint-javascript/api/powerpoint/-borderproperties-weight-member)|Represents the weight of the line, in points.| -|[FillProperties](/.fillproperties)|[color](/.fillproperties#powerpoint-javascript/api/powerpoint/-fillproperties-color-member)|Represents the shape fill color in the hexadecimal format #RRGGBB (e.g., "FFA500") or as a named HTML color value (e.g., "orange").| -||[transparency](/.fillproperties#powerpoint-javascript/api/powerpoint/-fillproperties-transparency-member)|Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).| -|[FontProperties](/.fontproperties)|[allCaps](/.fontproperties#powerpoint-javascript/api/powerpoint/-fontproperties-allcaps-member)|Represents whether the font uses all caps, where lowercase letters are shown as capital letters.| -||[bold](/.fontproperties#powerpoint-javascript/api/powerpoint/-fontproperties-bold-member)|Represents the bold status of font.| -||[color](/.fontproperties#powerpoint-javascript/api/powerpoint/-fontproperties-color-member)|Represents the HTML color in the hexadecimal format (e.g., "#FF0000" represents red) or as a named HTML color value (e.g., "red").| -||[doubleStrikethrough](/.fontproperties#powerpoint-javascript/api/powerpoint/-fontproperties-doublestrikethrough-member)|Represents the double-strikethrough status of the font.| -||[italic](/.fontproperties#powerpoint-javascript/api/powerpoint/-fontproperties-italic-member)|Represents the italic status of font.| -||[name](/.fontproperties#powerpoint-javascript/api/powerpoint/-fontproperties-name-member)|Represents the font name (e.g., "Calibri").| -||[size](/.fontproperties#powerpoint-javascript/api/powerpoint/-fontproperties-size-member)|Represents the font size in points (e.g., 11).| -||[smallCaps](/.fontproperties#powerpoint-javascript/api/powerpoint/-fontproperties-smallcaps-member)|Represents whether the text uses small caps, where lowercase letters are shown as small capital letters.| -||[strikethrough](/.fontproperties#powerpoint-javascript/api/powerpoint/-fontproperties-strikethrough-member)|Represents the strikethrough status of the font.| -||[subscript](/.fontproperties#powerpoint-javascript/api/powerpoint/-fontproperties-subscript-member)|Represents the subscript status of the font.| -||[superscript](/.fontproperties#powerpoint-javascript/api/powerpoint/-fontproperties-superscript-member)|Represents the superscript status of the font.| -||[underline](/.fontproperties#powerpoint-javascript/api/powerpoint/-fontproperties-underline-member)|Type of underline applied to the font.| -|[PlaceholderFormat](/.placeholderformat)|[containedType](/.placeholderformat#powerpoint-javascript/api/powerpoint/-placeholderformat-containedtype-member)|Gets the type of the shape contained within the placeholder.| -||[type](/.placeholderformat#powerpoint-javascript/api/powerpoint/-placeholderformat-type-member)|Returns the type of this placeholder.| -|[Presentation](/.presentation)|[bindings](/.presentation#powerpoint-javascript/api/powerpoint/-presentation-bindings-member)|Returns a collection of bindings that are associated with the presentation.| -|[Shape](/.shape)|[getTable()](/.shape#powerpoint-javascript/api/powerpoint/-shape-gettable-member(1))|Returns the `Table` object if this shape is a table.| -||[group](/.shape#powerpoint-javascript/api/powerpoint/-shape-group-member)|Returns the `ShapeGroup` associated with the shape.| -||[level](/.shape#powerpoint-javascript/api/powerpoint/-shape-level-member)|Returns the level of the specified shape.| -||[parentGroup](/.shape#powerpoint-javascript/api/powerpoint/-shape-parentgroup-member)|Returns the parent group of this shape.| -||[placeholderFormat](/.shape#powerpoint-javascript/api/powerpoint/-shape-placeholderformat-member)|Returns the properties that apply specifically to this placeholder.| -||[setZOrder(position: PowerPoint.ShapeZOrder)](/.shape#powerpoint-javascript/api/powerpoint/-shape-setzorder-member(1))|Moves the specified shape up or down the collection's z-order, which shifts it in front of or behind other shapes.| -||[zOrderPosition](/.shape#powerpoint-javascript/api/powerpoint/-shape-zorderposition-member)|Returns the z-order position of the shape, with 0 representing the bottom of the order stack.| -|[ShapeCollection](/.shapecollection)|[addGroup(values: Array)](/.shapecollection#powerpoint-javascript/api/powerpoint/-shapecollection-addgroup-member(1))|Create a shape group for several shapes.| -||[addTable(rowCount: number, columnCount: number, options?: PowerPoint.TableAddOptions)](/.shapecollection#powerpoint-javascript/api/powerpoint/-shapecollection-addtable-member(1))|Adds a table to the slide.| -|[ShapeFill](/.shapefill)|[setImage(base64EncodedImage: string)](/.shapefill#powerpoint-javascript/api/powerpoint/-shapefill-setimage-member(1))|Sets the fill formatting of the shape to an image.| -|[ShapeFont](/.shapefont)|[allCaps](/.shapefont#powerpoint-javascript/api/powerpoint/-shapefont-allcaps-member)|Specifies whether the text in the `TextRange` is set to use the **All Caps** attribute which makes lowercase letters appear as uppercase letters.| -||[doubleStrikethrough](/.shapefont#powerpoint-javascript/api/powerpoint/-shapefont-doublestrikethrough-member)|Specifies whether the text in the `TextRange` is set to use the **Double strikethrough** attribute.| -||[smallCaps](/.shapefont#powerpoint-javascript/api/powerpoint/-shapefont-smallcaps-member)|Specifies whether the text in the `TextRange` is set to use the **Small Caps** attribute which makes lowercase letters appear as small uppercase letters.| -||[strikethrough](/.shapefont#powerpoint-javascript/api/powerpoint/-shapefont-strikethrough-member)|Specifies whether the text in the `TextRange` is set to use the **Strikethrough** attribute.| -||[subscript](/.shapefont#powerpoint-javascript/api/powerpoint/-shapefont-subscript-member)|Specifies whether the text in the `TextRange` is set to use the **Subscript** attribute.| -||[superscript](/.shapefont#powerpoint-javascript/api/powerpoint/-shapefont-superscript-member)|Specifies whether the text in the `TextRange` is set to use the **Superscript** attribute.| -|[ShapeGroup](/.shapegroup)|[id](/.shapegroup#powerpoint-javascript/api/powerpoint/-shapegroup-id-member)|Gets the unique ID of the shape group.| -||[shape](/.shapegroup#powerpoint-javascript/api/powerpoint/-shapegroup-shape-member)|Returns the `Shape` object associated with the group.| -||[shapes](/.shapegroup#powerpoint-javascript/api/powerpoint/-shapegroup-shapes-member)|Returns the collection of `Shape` objects in the group.| -||[ungroup()](/.shapegroup#powerpoint-javascript/api/powerpoint/-shapegroup-ungroup-member(1))|Ungroups any grouped shapes in the specified shape group.| -|[ShapeScopedCollection](/.shapescopedcollection)|[group()](/.shapescopedcollection#powerpoint-javascript/api/powerpoint/-shapescopedcollection-group-member(1))|Groups all shapes in this collection into a single shape.| -|[Slide](/.slide)|[applyLayout(slideLayout: PowerPoint.SlideLayout)](/.slide#powerpoint-javascript/api/powerpoint/-slide-applylayout-member(1))|Applies the specified layout to the slide, changing its design and structure according to the chosen layout.| -||[exportAsBase64()](/.slide#powerpoint-javascript/api/powerpoint/-slide-exportasbase64-member(1))|Exports the slide to its own presentation file, returned as Base64-encoded data.| -||[getImageAsBase64(options?: PowerPoint.SlideGetImageOptions)](/.slide#powerpoint-javascript/api/powerpoint/-slide-getimageasbase64-member(1))|Renders an image of the slide.| -||[index](/.slide#powerpoint-javascript/api/powerpoint/-slide-index-member)|Returns the zero-based index of the slide representing its position in the presentation.| -||[moveTo(slideIndex: number)](/.slide#powerpoint-javascript/api/powerpoint/-slide-moveto-member(1))|Moves the slide to a new position within the presentation.| -|[SlideGetImageOptions](/.slidegetimageoptions)|[height](/.slidegetimageoptions#powerpoint-javascript/api/powerpoint/-slidegetimageoptions-height-member)|The desired height of the resulting image in pixels.| -||[width](/.slidegetimageoptions#powerpoint-javascript/api/powerpoint/-slidegetimageoptions-width-member)|The desired width of the resulting image in pixels.| -|[SlideLayout](/.slidelayout)|[type](/.slidelayout#powerpoint-javascript/api/powerpoint/-slidelayout-type-member)|Returns the type of the slide layout.| -|[Table](/.table)|[columnCount](/.table#powerpoint-javascript/api/powerpoint/-table-columncount-member)|Gets the number of columns in the table.| -||[getCellOrNullObject(rowIndex: number, columnIndex: number)](/.table#powerpoint-javascript/api/powerpoint/-table-getcellornullobject-member(1))|Gets the cell at the specified `rowIndex` and `columnIndex`.| -||[getMergedAreas()](/.table#powerpoint-javascript/api/powerpoint/-table-getmergedareas-member(1))|Gets a collection of cells that represent the merged areas of the table.| -||[getShape()](/.table#powerpoint-javascript/api/powerpoint/-table-getshape-member(1))|Gets the shape object for the table.| -||[rowCount](/.table#powerpoint-javascript/api/powerpoint/-table-rowcount-member)|Gets the number of rows in the table.| -||[values](/.table#powerpoint-javascript/api/powerpoint/-table-values-member)|Gets all of the values in the table.| -|[TableAddOptions](/.tableaddoptions)|[columns](/.tableaddoptions#powerpoint-javascript/api/powerpoint/-tableaddoptions-columns-member)|If provided, specifies properties for each column in the table.| -||[height](/.tableaddoptions#powerpoint-javascript/api/powerpoint/-tableaddoptions-height-member)|Specifies the height, in points, of the table.| -||[left](/.tableaddoptions#powerpoint-javascript/api/powerpoint/-tableaddoptions-left-member)|Specifies the distance, in points, from the left side of the table to the left side of the slide.| -||[mergedAreas](/.tableaddoptions#powerpoint-javascript/api/powerpoint/-tableaddoptions-mergedareas-member)|If specified, represents an rectangular area where multiple cells appear as a single cell.| -||[rows](/.tableaddoptions#powerpoint-javascript/api/powerpoint/-tableaddoptions-rows-member)|If provided, specifies properties for each row in the table.| -||[specificCellProperties](/.tableaddoptions#powerpoint-javascript/api/powerpoint/-tableaddoptions-specificcellproperties-member)|If provided, specifies properties for each cell in the table.| -||[top](/.tableaddoptions#powerpoint-javascript/api/powerpoint/-tableaddoptions-top-member)|Specifies the distance, in points, from the top edge of the table to the top edge of the slide.| -||[uniformCellProperties](/.tableaddoptions#powerpoint-javascript/api/powerpoint/-tableaddoptions-uniformcellproperties-member)|Specifies the formatting which applies uniformly to all of the table cells.| -||[values](/.tableaddoptions#powerpoint-javascript/api/powerpoint/-tableaddoptions-values-member)|If provided, specifies the values for the table.| -||[width](/.tableaddoptions#powerpoint-javascript/api/powerpoint/-tableaddoptions-width-member)|Specifies the width, in points, of the table.| -|[TableCell](/.tablecell)|[columnCount](/.tablecell#powerpoint-javascript/api/powerpoint/-tablecell-columncount-member)|Gets the number of table columns this cell spans across.| -||[columnIndex](/.tablecell#powerpoint-javascript/api/powerpoint/-tablecell-columnindex-member)|Gets the zero-based column index of the cell within the table.| -||[rowCount](/.tablecell#powerpoint-javascript/api/powerpoint/-tablecell-rowcount-member)|Gets the number of table rows this cell spans across.| -||[rowIndex](/.tablecell#powerpoint-javascript/api/powerpoint/-tablecell-rowindex-member)|Gets the zero-based row index of the cell within the table.| -||[text](/.tablecell#powerpoint-javascript/api/powerpoint/-tablecell-text-member)|Specifies the text content of the table cell.| -|[TableCellBorders](/.tablecellborders)|[bottom](/.tablecellborders#powerpoint-javascript/api/powerpoint/-tablecellborders-bottom-member)|Represents the bottom border.| -||[diagonalDown](/.tablecellborders#powerpoint-javascript/api/powerpoint/-tablecellborders-diagonaldown-member)|Represents the diagonal border (top-left to bottom-right).| -||[diagonalUp](/.tablecellborders#powerpoint-javascript/api/powerpoint/-tablecellborders-diagonalup-member)|Represents the diagonal border (bottom-left to top-right).| -||[left](/.tablecellborders#powerpoint-javascript/api/powerpoint/-tablecellborders-left-member)|Represents the left border.| -||[right](/.tablecellborders#powerpoint-javascript/api/powerpoint/-tablecellborders-right-member)|Represents the right border.| -||[top](/.tablecellborders#powerpoint-javascript/api/powerpoint/-tablecellborders-top-member)|Represents the top border.| -|[TableCellCollection](/.tablecellcollection)|[getCount()](/.tablecellcollection#powerpoint-javascript/api/powerpoint/-tablecellcollection-getcount-member(1))|Gets the number of table cells in the collection.| -||[getItemAtOrNullObject(row: number, column: number)](/.tablecellcollection#powerpoint-javascript/api/powerpoint/-tablecellcollection-getitematornullobject-member(1))|Gets the table cell using its zero-based index in the collection.| -||[items](/.tablecellcollection#powerpoint-javascript/api/powerpoint/-tablecellcollection-items-member)|Gets the loaded child items in this collection.| -|[TableCellMargins](/.tablecellmargins)|[bottom](/.tablecellmargins#powerpoint-javascript/api/powerpoint/-tablecellmargins-bottom-member)|Specifies the bottom margin in points.| -||[left](/.tablecellmargins#powerpoint-javascript/api/powerpoint/-tablecellmargins-left-member)|Specifies the left margin in points.| -||[right](/.tablecellmargins#powerpoint-javascript/api/powerpoint/-tablecellmargins-right-member)|Specifies the right margin in points.| -||[top](/.tablecellmargins#powerpoint-javascript/api/powerpoint/-tablecellmargins-top-member)|Specifies the top margin in points.| -|[TableCellProperties](/.tablecellproperties)|[borders](/.tablecellproperties#powerpoint-javascript/api/powerpoint/-tablecellproperties-borders-member)|Specifies the border formatting of the table cell.| -||[fill](/.tablecellproperties#powerpoint-javascript/api/powerpoint/-tablecellproperties-fill-member)|Specifies the fill formatting of the table cell.| -||[font](/.tablecellproperties#powerpoint-javascript/api/powerpoint/-tablecellproperties-font-member)|Specifies the font formatting of the table cell.| -||[horizontalAlignment](/.tablecellproperties#powerpoint-javascript/api/powerpoint/-tablecellproperties-horizontalalignment-member)|Represents the horizontal alignment of the table cell.| -||[indentLevel](/.tablecellproperties#powerpoint-javascript/api/powerpoint/-tablecellproperties-indentlevel-member)|Represents the indent level of the text in the table cell.| -||[margins](/.tablecellproperties#powerpoint-javascript/api/powerpoint/-tablecellproperties-margins-member)|Specifies the margin settings in the table cell.| -||[text](/.tablecellproperties#powerpoint-javascript/api/powerpoint/-tablecellproperties-text-member)|Specifies the text content of the table cell.| -||[textRuns](/.tablecellproperties#powerpoint-javascript/api/powerpoint/-tablecellproperties-textruns-member)|Specifies the contents of the table cell as an array of PowerPoint.TextRun objects.| -||[verticalAlignment](/.tablecellproperties#powerpoint-javascript/api/powerpoint/-tablecellproperties-verticalalignment-member)|Represents the vertical alignment of the table cell.| -|[TableColumnProperties](/.tablecolumnproperties)|[columnWidth](/.tablecolumnproperties#powerpoint-javascript/api/powerpoint/-tablecolumnproperties-columnwidth-member)|Represents the desired width of each column in points, or is undefined.| -|[TableMergedAreaProperties](/.tablemergedareaproperties)|[columnCount](/.tablemergedareaproperties#powerpoint-javascript/api/powerpoint/-tablemergedareaproperties-columncount-member)|Specifies the number of columns for the merged cells area.| -||[columnIndex](/.tablemergedareaproperties#powerpoint-javascript/api/powerpoint/-tablemergedareaproperties-columnindex-member)|Specifies the zero-based index of the column of the top left cell of the merged area.| -||[rowCount](/.tablemergedareaproperties#powerpoint-javascript/api/powerpoint/-tablemergedareaproperties-rowcount-member)|Specifies the number of rows for the merged cells area.| -||[rowIndex](/.tablemergedareaproperties#powerpoint-javascript/api/powerpoint/-tablemergedareaproperties-rowindex-member)|Specifies the zero-based index of the row of the top left cell of the merged area.| -|[TableRowProperties](/.tablerowproperties)|[rowHeight](/.tablerowproperties#powerpoint-javascript/api/powerpoint/-tablerowproperties-rowheight-member)|Represents the desired height of each row in points, or is undefined.| -|[TextRun](/.textrun)|[font](/.textrun#powerpoint-javascript/api/powerpoint/-textrun-font-member)|The font attributes (such as font name, font size, and color) applied to this text run.| -||[text](/.textrun#powerpoint-javascript/api/powerpoint/-textrun-text-member)|The text of this text run.| +|[Binding](/javascript/api/powerpoint/powerpoint.binding)|[delete()](/javascript/api/powerpoint/powerpoint.binding#powerpoint-powerpoint-binding-delete-member(1))|Deletes the binding.| +||[getShape()](/javascript/api/powerpoint/powerpoint.binding#powerpoint-powerpoint-binding-getshape-member(1))|Returns the shape represented by the binding.| +||[id](/javascript/api/powerpoint/powerpoint.binding#powerpoint-powerpoint-binding-id-member)|Represents the binding identifier.| +||[type](/javascript/api/powerpoint/powerpoint.binding#powerpoint-powerpoint-binding-type-member)|Returns the type of the binding.| +|[BindingCollection](/javascript/api/powerpoint/powerpoint.bindingcollection)|[add(shape: PowerPoint.Shape, bindingType: PowerPoint.BindingType, id: string)](/javascript/api/powerpoint/powerpoint.bindingcollection#powerpoint-powerpoint-bindingcollection-add-member(1))|Adds a new binding to a particular Shape.| +||[addFromSelection(bindingType: PowerPoint.BindingType, id: string)](/javascript/api/powerpoint/powerpoint.bindingcollection#powerpoint-powerpoint-bindingcollection-addfromselection-member(1))|Adds a new binding based on the current selection.| +||[getCount()](/javascript/api/powerpoint/powerpoint.bindingcollection#powerpoint-powerpoint-bindingcollection-getcount-member(1))|Gets the number of bindings in the collection.| +||[getItem(key: string)](/javascript/api/powerpoint/powerpoint.bindingcollection#powerpoint-powerpoint-bindingcollection-getitem-member(1))|Gets a binding object by ID.| +||[getItemAt(index: number)](/javascript/api/powerpoint/powerpoint.bindingcollection#powerpoint-powerpoint-bindingcollection-getitemat-member(1))|Gets a binding object based on its position in the items array.| +||[getItemOrNullObject(id: string)](/javascript/api/powerpoint/powerpoint.bindingcollection#powerpoint-powerpoint-bindingcollection-getitemornullobject-member(1))|Gets a binding object by ID.| +||[items](/javascript/api/powerpoint/powerpoint.bindingcollection#powerpoint-powerpoint-bindingcollection-items-member)|Gets the loaded child items in this collection.| +|[BorderProperties](/javascript/api/powerpoint/powerpoint.borderproperties)|[color](/javascript/api/powerpoint/powerpoint.borderproperties#powerpoint-powerpoint-borderproperties-color-member)|Represents the line color in the hexadecimal format #RRGGBB (e.g., "FFA500") or as a named HTML color value (e.g., "orange").| +||[dashStyle](/javascript/api/powerpoint/powerpoint.borderproperties#powerpoint-powerpoint-borderproperties-dashstyle-member)|Represents the dash style of the line.| +||[transparency](/javascript/api/powerpoint/powerpoint.borderproperties#powerpoint-powerpoint-borderproperties-transparency-member)|Specifies the transparency percentage of the line as a value from 0.0 (opaque) through 1.0 (clear).| +||[weight](/javascript/api/powerpoint/powerpoint.borderproperties#powerpoint-powerpoint-borderproperties-weight-member)|Represents the weight of the line, in points.| +|[FillProperties](/javascript/api/powerpoint/powerpoint.fillproperties)|[color](/javascript/api/powerpoint/powerpoint.fillproperties#powerpoint-powerpoint-fillproperties-color-member)|Represents the shape fill color in the hexadecimal format #RRGGBB (e.g., "FFA500") or as a named HTML color value (e.g., "orange").| +||[transparency](/javascript/api/powerpoint/powerpoint.fillproperties#powerpoint-powerpoint-fillproperties-transparency-member)|Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).| +|[FontProperties](/javascript/api/powerpoint/powerpoint.fontproperties)|[allCaps](/javascript/api/powerpoint/powerpoint.fontproperties#powerpoint-powerpoint-fontproperties-allcaps-member)|Represents whether the font uses all caps, where lowercase letters are shown as capital letters.| +||[bold](/javascript/api/powerpoint/powerpoint.fontproperties#powerpoint-powerpoint-fontproperties-bold-member)|Represents the bold status of font.| +||[color](/javascript/api/powerpoint/powerpoint.fontproperties#powerpoint-powerpoint-fontproperties-color-member)|Represents the HTML color in the hexadecimal format (e.g., "#FF0000" represents red) or as a named HTML color value (e.g., "red").| +||[doubleStrikethrough](/javascript/api/powerpoint/powerpoint.fontproperties#powerpoint-powerpoint-fontproperties-doublestrikethrough-member)|Represents the double-strikethrough status of the font.| +||[italic](/javascript/api/powerpoint/powerpoint.fontproperties#powerpoint-powerpoint-fontproperties-italic-member)|Represents the italic status of font.| +||[name](/javascript/api/powerpoint/powerpoint.fontproperties#powerpoint-powerpoint-fontproperties-name-member)|Represents the font name (e.g., "Calibri").| +||[size](/javascript/api/powerpoint/powerpoint.fontproperties#powerpoint-powerpoint-fontproperties-size-member)|Represents the font size in points (e.g., 11).| +||[smallCaps](/javascript/api/powerpoint/powerpoint.fontproperties#powerpoint-powerpoint-fontproperties-smallcaps-member)|Represents whether the text uses small caps, where lowercase letters are shown as small capital letters.| +||[strikethrough](/javascript/api/powerpoint/powerpoint.fontproperties#powerpoint-powerpoint-fontproperties-strikethrough-member)|Represents the strikethrough status of the font.| +||[subscript](/javascript/api/powerpoint/powerpoint.fontproperties#powerpoint-powerpoint-fontproperties-subscript-member)|Represents the subscript status of the font.| +||[superscript](/javascript/api/powerpoint/powerpoint.fontproperties#powerpoint-powerpoint-fontproperties-superscript-member)|Represents the superscript status of the font.| +||[underline](/javascript/api/powerpoint/powerpoint.fontproperties#powerpoint-powerpoint-fontproperties-underline-member)|Type of underline applied to the font.| +|[PlaceholderFormat](/javascript/api/powerpoint/powerpoint.placeholderformat)|[containedType](/javascript/api/powerpoint/powerpoint.placeholderformat#powerpoint-powerpoint-placeholderformat-containedtype-member)|Gets the type of the shape contained within the placeholder.| +||[type](/javascript/api/powerpoint/powerpoint.placeholderformat#powerpoint-powerpoint-placeholderformat-type-member)|Returns the type of this placeholder.| +|[Presentation](/javascript/api/powerpoint/powerpoint.presentation)|[bindings](/javascript/api/powerpoint/powerpoint.presentation#powerpoint-powerpoint-presentation-bindings-member)|Returns a collection of bindings that are associated with the presentation.| +|[Shape](/javascript/api/powerpoint/powerpoint.shape)|[getTable()](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-gettable-member(1))|Returns the `Table` object if this shape is a table.| +||[group](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-group-member)|Returns the `ShapeGroup` associated with the shape.| +||[level](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-level-member)|Returns the level of the specified shape.| +||[parentGroup](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-parentgroup-member)|Returns the parent group of this shape.| +||[placeholderFormat](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-placeholderformat-member)|Returns the properties that apply specifically to this placeholder.| +||[setZOrder(position: PowerPoint.ShapeZOrder)](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-setzorder-member(1))|Moves the specified shape up or down the collection's z-order, which shifts it in front of or behind other shapes.| +||[zOrderPosition](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-zorderposition-member)|Returns the z-order position of the shape, with 0 representing the bottom of the order stack.| +|[ShapeCollection](/javascript/api/powerpoint/powerpoint.shapecollection)|[addGroup(values: Array)](/javascript/api/powerpoint/powerpoint.shapecollection#powerpoint-powerpoint-shapecollection-addgroup-member(1))|Create a shape group for several shapes.| +||[addTable(rowCount: number, columnCount: number, options?: PowerPoint.TableAddOptions)](/javascript/api/powerpoint/powerpoint.shapecollection#powerpoint-powerpoint-shapecollection-addtable-member(1))|Adds a table to the slide.| +|[ShapeFill](/javascript/api/powerpoint/powerpoint.shapefill)|[setImage(base64EncodedImage: string)](/javascript/api/powerpoint/powerpoint.shapefill#powerpoint-powerpoint-shapefill-setimage-member(1))|Sets the fill formatting of the shape to an image.| +|[ShapeFont](/javascript/api/powerpoint/powerpoint.shapefont)|[allCaps](/javascript/api/powerpoint/powerpoint.shapefont#powerpoint-powerpoint-shapefont-allcaps-member)|Specifies whether the text in the `TextRange` is set to use the **All Caps** attribute which makes lowercase letters appear as uppercase letters.| +||[doubleStrikethrough](/javascript/api/powerpoint/powerpoint.shapefont#powerpoint-powerpoint-shapefont-doublestrikethrough-member)|Specifies whether the text in the `TextRange` is set to use the **Double strikethrough** attribute.| +||[smallCaps](/javascript/api/powerpoint/powerpoint.shapefont#powerpoint-powerpoint-shapefont-smallcaps-member)|Specifies whether the text in the `TextRange` is set to use the **Small Caps** attribute which makes lowercase letters appear as small uppercase letters.| +||[strikethrough](/javascript/api/powerpoint/powerpoint.shapefont#powerpoint-powerpoint-shapefont-strikethrough-member)|Specifies whether the text in the `TextRange` is set to use the **Strikethrough** attribute.| +||[subscript](/javascript/api/powerpoint/powerpoint.shapefont#powerpoint-powerpoint-shapefont-subscript-member)|Specifies whether the text in the `TextRange` is set to use the **Subscript** attribute.| +||[superscript](/javascript/api/powerpoint/powerpoint.shapefont#powerpoint-powerpoint-shapefont-superscript-member)|Specifies whether the text in the `TextRange` is set to use the **Superscript** attribute.| +|[ShapeGroup](/javascript/api/powerpoint/powerpoint.shapegroup)|[id](/javascript/api/powerpoint/powerpoint.shapegroup#powerpoint-powerpoint-shapegroup-id-member)|Gets the unique ID of the shape group.| +||[shape](/javascript/api/powerpoint/powerpoint.shapegroup#powerpoint-powerpoint-shapegroup-shape-member)|Returns the `Shape` object associated with the group.| +||[shapes](/javascript/api/powerpoint/powerpoint.shapegroup#powerpoint-powerpoint-shapegroup-shapes-member)|Returns the collection of `Shape` objects in the group.| +||[ungroup()](/javascript/api/powerpoint/powerpoint.shapegroup#powerpoint-powerpoint-shapegroup-ungroup-member(1))|Ungroups any grouped shapes in the specified shape group.| +|[ShapeScopedCollection](/javascript/api/powerpoint/powerpoint.shapescopedcollection)|[group()](/javascript/api/powerpoint/powerpoint.shapescopedcollection#powerpoint-powerpoint-shapescopedcollection-group-member(1))|Groups all shapes in this collection into a single shape.| +|[Slide](/javascript/api/powerpoint/powerpoint.slide)|[applyLayout(slideLayout: PowerPoint.SlideLayout)](/javascript/api/powerpoint/powerpoint.slide#powerpoint-powerpoint-slide-applylayout-member(1))|Applies the specified layout to the slide, changing its design and structure according to the chosen layout.| +||[exportAsBase64()](/javascript/api/powerpoint/powerpoint.slide#powerpoint-powerpoint-slide-exportasbase64-member(1))|Exports the slide to its own presentation file, returned as Base64-encoded data.| +||[getImageAsBase64(options?: PowerPoint.SlideGetImageOptions)](/javascript/api/powerpoint/powerpoint.slide#powerpoint-powerpoint-slide-getimageasbase64-member(1))|Renders an image of the slide.| +||[index](/javascript/api/powerpoint/powerpoint.slide#powerpoint-powerpoint-slide-index-member)|Returns the zero-based index of the slide representing its position in the presentation.| +||[moveTo(slideIndex: number)](/javascript/api/powerpoint/powerpoint.slide#powerpoint-powerpoint-slide-moveto-member(1))|Moves the slide to a new position within the presentation.| +|[SlideGetImageOptions](/javascript/api/powerpoint/powerpoint.slidegetimageoptions)|[height](/javascript/api/powerpoint/powerpoint.slidegetimageoptions#powerpoint-powerpoint-slidegetimageoptions-height-member)|The desired height of the resulting image in pixels.| +||[width](/javascript/api/powerpoint/powerpoint.slidegetimageoptions#powerpoint-powerpoint-slidegetimageoptions-width-member)|The desired width of the resulting image in pixels.| +|[SlideLayout](/javascript/api/powerpoint/powerpoint.slidelayout)|[type](/javascript/api/powerpoint/powerpoint.slidelayout#powerpoint-powerpoint-slidelayout-type-member)|Returns the type of the slide layout.| +|[Table](/javascript/api/powerpoint/powerpoint.table)|[columnCount](/javascript/api/powerpoint/powerpoint.table#powerpoint-powerpoint-table-columncount-member)|Gets the number of columns in the table.| +||[getCellOrNullObject(rowIndex: number, columnIndex: number)](/javascript/api/powerpoint/powerpoint.table#powerpoint-powerpoint-table-getcellornullobject-member(1))|Gets the cell at the specified `rowIndex` and `columnIndex`.| +||[getMergedAreas()](/javascript/api/powerpoint/powerpoint.table#powerpoint-powerpoint-table-getmergedareas-member(1))|Gets a collection of cells that represent the merged areas of the table.| +||[getShape()](/javascript/api/powerpoint/powerpoint.table#powerpoint-powerpoint-table-getshape-member(1))|Gets the shape object for the table.| +||[rowCount](/javascript/api/powerpoint/powerpoint.table#powerpoint-powerpoint-table-rowcount-member)|Gets the number of rows in the table.| +||[values](/javascript/api/powerpoint/powerpoint.table#powerpoint-powerpoint-table-values-member)|Gets all of the values in the table.| +|[TableAddOptions](/javascript/api/powerpoint/powerpoint.tableaddoptions)|[columns](/javascript/api/powerpoint/powerpoint.tableaddoptions#powerpoint-powerpoint-tableaddoptions-columns-member)|If provided, specifies properties for each column in the table.| +||[height](/javascript/api/powerpoint/powerpoint.tableaddoptions#powerpoint-powerpoint-tableaddoptions-height-member)|Specifies the height, in points, of the table.| +||[left](/javascript/api/powerpoint/powerpoint.tableaddoptions#powerpoint-powerpoint-tableaddoptions-left-member)|Specifies the distance, in points, from the left side of the table to the left side of the slide.| +||[mergedAreas](/javascript/api/powerpoint/powerpoint.tableaddoptions#powerpoint-powerpoint-tableaddoptions-mergedareas-member)|If specified, represents an rectangular area where multiple cells appear as a single cell.| +||[rows](/javascript/api/powerpoint/powerpoint.tableaddoptions#powerpoint-powerpoint-tableaddoptions-rows-member)|If provided, specifies properties for each row in the table.| +||[specificCellProperties](/javascript/api/powerpoint/powerpoint.tableaddoptions#powerpoint-powerpoint-tableaddoptions-specificcellproperties-member)|If provided, specifies properties for each cell in the table.| +||[top](/javascript/api/powerpoint/powerpoint.tableaddoptions#powerpoint-powerpoint-tableaddoptions-top-member)|Specifies the distance, in points, from the top edge of the table to the top edge of the slide.| +||[uniformCellProperties](/javascript/api/powerpoint/powerpoint.tableaddoptions#powerpoint-powerpoint-tableaddoptions-uniformcellproperties-member)|Specifies the formatting which applies uniformly to all of the table cells.| +||[values](/javascript/api/powerpoint/powerpoint.tableaddoptions#powerpoint-powerpoint-tableaddoptions-values-member)|If provided, specifies the values for the table.| +||[width](/javascript/api/powerpoint/powerpoint.tableaddoptions#powerpoint-powerpoint-tableaddoptions-width-member)|Specifies the width, in points, of the table.| +|[TableCell](/javascript/api/powerpoint/powerpoint.tablecell)|[columnCount](/javascript/api/powerpoint/powerpoint.tablecell#powerpoint-powerpoint-tablecell-columncount-member)|Gets the number of table columns this cell spans across.| +||[columnIndex](/javascript/api/powerpoint/powerpoint.tablecell#powerpoint-powerpoint-tablecell-columnindex-member)|Gets the zero-based column index of the cell within the table.| +||[rowCount](/javascript/api/powerpoint/powerpoint.tablecell#powerpoint-powerpoint-tablecell-rowcount-member)|Gets the number of table rows this cell spans across.| +||[rowIndex](/javascript/api/powerpoint/powerpoint.tablecell#powerpoint-powerpoint-tablecell-rowindex-member)|Gets the zero-based row index of the cell within the table.| +||[text](/javascript/api/powerpoint/powerpoint.tablecell#powerpoint-powerpoint-tablecell-text-member)|Specifies the text content of the table cell.| +|[TableCellBorders](/javascript/api/powerpoint/powerpoint.tablecellborders)|[bottom](/javascript/api/powerpoint/powerpoint.tablecellborders#powerpoint-powerpoint-tablecellborders-bottom-member)|Represents the bottom border.| +||[diagonalDown](/javascript/api/powerpoint/powerpoint.tablecellborders#powerpoint-powerpoint-tablecellborders-diagonaldown-member)|Represents the diagonal border (top-left to bottom-right).| +||[diagonalUp](/javascript/api/powerpoint/powerpoint.tablecellborders#powerpoint-powerpoint-tablecellborders-diagonalup-member)|Represents the diagonal border (bottom-left to top-right).| +||[left](/javascript/api/powerpoint/powerpoint.tablecellborders#powerpoint-powerpoint-tablecellborders-left-member)|Represents the left border.| +||[right](/javascript/api/powerpoint/powerpoint.tablecellborders#powerpoint-powerpoint-tablecellborders-right-member)|Represents the right border.| +||[top](/javascript/api/powerpoint/powerpoint.tablecellborders#powerpoint-powerpoint-tablecellborders-top-member)|Represents the top border.| +|[TableCellCollection](/javascript/api/powerpoint/powerpoint.tablecellcollection)|[getCount()](/javascript/api/powerpoint/powerpoint.tablecellcollection#powerpoint-powerpoint-tablecellcollection-getcount-member(1))|Gets the number of table cells in the collection.| +||[getItemAtOrNullObject(row: number, column: number)](/javascript/api/powerpoint/powerpoint.tablecellcollection#powerpoint-powerpoint-tablecellcollection-getitematornullobject-member(1))|Gets the table cell using its zero-based index in the collection.| +||[items](/javascript/api/powerpoint/powerpoint.tablecellcollection#powerpoint-powerpoint-tablecellcollection-items-member)|Gets the loaded child items in this collection.| +|[TableCellMargins](/javascript/api/powerpoint/powerpoint.tablecellmargins)|[bottom](/javascript/api/powerpoint/powerpoint.tablecellmargins#powerpoint-powerpoint-tablecellmargins-bottom-member)|Specifies the bottom margin in points.| +||[left](/javascript/api/powerpoint/powerpoint.tablecellmargins#powerpoint-powerpoint-tablecellmargins-left-member)|Specifies the left margin in points.| +||[right](/javascript/api/powerpoint/powerpoint.tablecellmargins#powerpoint-powerpoint-tablecellmargins-right-member)|Specifies the right margin in points.| +||[top](/javascript/api/powerpoint/powerpoint.tablecellmargins#powerpoint-powerpoint-tablecellmargins-top-member)|Specifies the top margin in points.| +|[TableCellProperties](/javascript/api/powerpoint/powerpoint.tablecellproperties)|[borders](/javascript/api/powerpoint/powerpoint.tablecellproperties#powerpoint-powerpoint-tablecellproperties-borders-member)|Specifies the border formatting of the table cell.| +||[fill](/javascript/api/powerpoint/powerpoint.tablecellproperties#powerpoint-powerpoint-tablecellproperties-fill-member)|Specifies the fill formatting of the table cell.| +||[font](/javascript/api/powerpoint/powerpoint.tablecellproperties#powerpoint-powerpoint-tablecellproperties-font-member)|Specifies the font formatting of the table cell.| +||[horizontalAlignment](/javascript/api/powerpoint/powerpoint.tablecellproperties#powerpoint-powerpoint-tablecellproperties-horizontalalignment-member)|Represents the horizontal alignment of the table cell.| +||[indentLevel](/javascript/api/powerpoint/powerpoint.tablecellproperties#powerpoint-powerpoint-tablecellproperties-indentlevel-member)|Represents the indent level of the text in the table cell.| +||[margins](/javascript/api/powerpoint/powerpoint.tablecellproperties#powerpoint-powerpoint-tablecellproperties-margins-member)|Specifies the margin settings in the table cell.| +||[text](/javascript/api/powerpoint/powerpoint.tablecellproperties#powerpoint-powerpoint-tablecellproperties-text-member)|Specifies the text content of the table cell.| +||[textRuns](/javascript/api/powerpoint/powerpoint.tablecellproperties#powerpoint-powerpoint-tablecellproperties-textruns-member)|Specifies the contents of the table cell as an array of PowerPoint.TextRun objects.| +||[verticalAlignment](/javascript/api/powerpoint/powerpoint.tablecellproperties#powerpoint-powerpoint-tablecellproperties-verticalalignment-member)|Represents the vertical alignment of the table cell.| +|[TableColumnProperties](/javascript/api/powerpoint/powerpoint.tablecolumnproperties)|[columnWidth](/javascript/api/powerpoint/powerpoint.tablecolumnproperties#powerpoint-powerpoint-tablecolumnproperties-columnwidth-member)|Represents the desired width of each column in points, or is undefined.| +|[TableMergedAreaProperties](/javascript/api/powerpoint/powerpoint.tablemergedareaproperties)|[columnCount](/javascript/api/powerpoint/powerpoint.tablemergedareaproperties#powerpoint-powerpoint-tablemergedareaproperties-columncount-member)|Specifies the number of columns for the merged cells area.| +||[columnIndex](/javascript/api/powerpoint/powerpoint.tablemergedareaproperties#powerpoint-powerpoint-tablemergedareaproperties-columnindex-member)|Specifies the zero-based index of the column of the top left cell of the merged area.| +||[rowCount](/javascript/api/powerpoint/powerpoint.tablemergedareaproperties#powerpoint-powerpoint-tablemergedareaproperties-rowcount-member)|Specifies the number of rows for the merged cells area.| +||[rowIndex](/javascript/api/powerpoint/powerpoint.tablemergedareaproperties#powerpoint-powerpoint-tablemergedareaproperties-rowindex-member)|Specifies the zero-based index of the row of the top left cell of the merged area.| +|[TableRowProperties](/javascript/api/powerpoint/powerpoint.tablerowproperties)|[rowHeight](/javascript/api/powerpoint/powerpoint.tablerowproperties#powerpoint-powerpoint-tablerowproperties-rowheight-member)|Represents the desired height of each row in points, or is undefined.| +|[TextRun](/javascript/api/powerpoint/powerpoint.textrun)|[font](/javascript/api/powerpoint/powerpoint.textrun#powerpoint-powerpoint-textrun-font-member)|The font attributes (such as font name, font size, and color) applied to this text run.| +||[text](/javascript/api/powerpoint/powerpoint.textrun#powerpoint-powerpoint-textrun-text-member)|The text of this text run.| diff --git a/docs/includes/powerpoint-1_9.md b/docs/includes/powerpoint-1_9.md index da61604c58..60a54f4c51 100644 --- a/docs/includes/powerpoint-1_9.md +++ b/docs/includes/powerpoint-1_9.md @@ -1,51 +1,51 @@ | Class | Fields | Description | |:---|:---|:---| -|[Border](/.border)|[color](/.border#powerpoint-javascript/api/powerpoint/-border-color-member)|Represents the line color in the hexadecimal format #RRGGBB (e.g., "FFA500") or as a named HTML color value (e.g., "orange").| -||[dashStyle](/.border#powerpoint-javascript/api/powerpoint/-border-dashstyle-member)|Represents the dash style of the line.| -||[transparency](/.border#powerpoint-javascript/api/powerpoint/-border-transparency-member)|Specifies the transparency percentage of the line as a value from 0.0 (opaque) through 1.0 (clear).| -||[weight](/.border#powerpoint-javascript/api/powerpoint/-border-weight-member)|Represents the weight of the line, in points.| -|[Borders](/.borders)|[bottom](/.borders#powerpoint-javascript/api/powerpoint/-borders-bottom-member)|Gets the bottom border.| -||[diagonalDown](/.borders#powerpoint-javascript/api/powerpoint/-borders-diagonaldown-member)|Gets the diagonal border (top-left to bottom-right).| -||[diagonalUp](/.borders#powerpoint-javascript/api/powerpoint/-borders-diagonalup-member)|Gets the diagonal border (bottom-left to top-right).| -||[left](/.borders#powerpoint-javascript/api/powerpoint/-borders-left-member)|Gets the left border.| -||[right](/.borders#powerpoint-javascript/api/powerpoint/-borders-right-member)|Gets the right border.| -||[top](/.borders#powerpoint-javascript/api/powerpoint/-borders-top-member)|Gets the top border.| -|[Margins](/.margins)|[bottom](/.margins#powerpoint-javascript/api/powerpoint/-margins-bottom-member)|Specifies the bottom margin in points.| -||[left](/.margins#powerpoint-javascript/api/powerpoint/-margins-left-member)|Specifies the left margin in points.| -||[right](/.margins#powerpoint-javascript/api/powerpoint/-margins-right-member)|Specifies the right margin in points.| -||[top](/.margins#powerpoint-javascript/api/powerpoint/-margins-top-member)|Specifies the top margin in points.| -|[Table](/.table)|[clear(options?: PowerPoint.TableClearOptions)](/.table#powerpoint-javascript/api/powerpoint/-table-clear-member(1))|Clears table values and formatting.| -||[columns](/.table#powerpoint-javascript/api/powerpoint/-table-columns-member)|Gets the collection of columns in the table.| -||[mergeCells(rowIndex: number, columnIndex: number, rowCount: number, columnCount: number)](/.table#powerpoint-javascript/api/powerpoint/-table-mergecells-member(1))|Creates a merged area starting at the cell specified by rowIndex and columnIndex.| -||[rows](/.table#powerpoint-javascript/api/powerpoint/-table-rows-member)|Gets the collection of rows in the table.| -|[TableAddOptions](/.tableaddoptions)|[style](/.tableaddoptions#powerpoint-javascript/api/powerpoint/-tableaddoptions-style-member)|Specifies value that represents the table style.| -|[TableCell](/.tablecell)|[borders](/.tablecell#powerpoint-javascript/api/powerpoint/-tablecell-borders-member)|Gets the collection of borders for the table cell.| -||[fill](/.tablecell#powerpoint-javascript/api/powerpoint/-tablecell-fill-member)|Gets the fill color of the table cell.| -||[font](/.tablecell#powerpoint-javascript/api/powerpoint/-tablecell-font-member)|Gets the font of the table cell.| -||[horizontalAlignment](/.tablecell#powerpoint-javascript/api/powerpoint/-tablecell-horizontalalignment-member)|Specifies the horizontal alignment of the table cell.| -||[indentLevel](/.tablecell#powerpoint-javascript/api/powerpoint/-tablecell-indentlevel-member)|Specifies the indent level of the table cell.| -||[margins](/.tablecell#powerpoint-javascript/api/powerpoint/-tablecell-margins-member)|Gets the set of margins in the table cell.| -||[resize(rowCount: number, columnCount: number)](/.tablecell#powerpoint-javascript/api/powerpoint/-tablecell-resize-member(1))|Resizes the table cell to span across a specified number of rows and columns.| -||[split(rowCount: number, columnCount: number)](/.tablecell#powerpoint-javascript/api/powerpoint/-tablecell-split-member(1))|Splits the cell into the specified number of rows and columns.| -||[textRuns](/.tablecell#powerpoint-javascript/api/powerpoint/-tablecell-textruns-member)|Specifies the contents of the table cell as an array of PowerPoint.TextRun objects.| -||[verticalAlignment](/.tablecell#powerpoint-javascript/api/powerpoint/-tablecell-verticalalignment-member)|Specifies the vertical alignment of the text in the table cell.| -|[TableClearOptions](/.tableclearoptions)|[all](/.tableclearoptions#powerpoint-javascript/api/powerpoint/-tableclearoptions-all-member)|Specifies if both values and formatting of the table should be cleared.| -||[format](/.tableclearoptions#powerpoint-javascript/api/powerpoint/-tableclearoptions-format-member)|Specifies if the formatting of the table should be cleared.| -||[text](/.tableclearoptions#powerpoint-javascript/api/powerpoint/-tableclearoptions-text-member)|Specifies if the values of the table should be cleared.| -|[TableColumn](/.tablecolumn)|[columnIndex](/.tablecolumn#powerpoint-javascript/api/powerpoint/-tablecolumn-columnindex-member)|Returns the index number of the column within the column collection of the table.| -||[delete()](/.tablecolumn#powerpoint-javascript/api/powerpoint/-tablecolumn-delete-member(1))|Deletes the column.| -||[width](/.tablecolumn#powerpoint-javascript/api/powerpoint/-tablecolumn-width-member)|Retrieves the width of the column in points.| -|[TableColumnCollection](/.tablecolumncollection)|[add(index?: number \| null \| undefined, count?: number \| undefined)](/.tablecolumncollection#powerpoint-javascript/api/powerpoint/-tablecolumncollection-add-member(1))|Adds one or more columns to the table.| -||[deleteColumns(columns: PowerPoint.TableColumn[])](/.tablecolumncollection#powerpoint-javascript/api/powerpoint/-tablecolumncollection-deletecolumns-member(1))|Deletes the specified columns from the collection.| -||[getCount()](/.tablecolumncollection#powerpoint-javascript/api/powerpoint/-tablecolumncollection-getcount-member(1))|Gets the number of columns in the collection.| -||[getItemAt(index: number)](/.tablecolumncollection#powerpoint-javascript/api/powerpoint/-tablecolumncollection-getitemat-member(1))|Gets the column using its zero-based index in the collection.| -||[items](/.tablecolumncollection#powerpoint-javascript/api/powerpoint/-tablecolumncollection-items-member)|Gets the loaded child items in this collection.| -|[TableRow](/.tablerow)|[currentHeight](/.tablerow#powerpoint-javascript/api/powerpoint/-tablerow-currentheight-member)|Retrieves the current height of the row in points.| -||[delete()](/.tablerow#powerpoint-javascript/api/powerpoint/-tablerow-delete-member(1))|Deletes the row.| -||[height](/.tablerow#powerpoint-javascript/api/powerpoint/-tablerow-height-member)|Specifies the height of the row in points.| -||[rowIndex](/.tablerow#powerpoint-javascript/api/powerpoint/-tablerow-rowindex-member)|Returns the index number of the row within the rows collection of the table.| -|[TableRowCollection](/.tablerowcollection)|[add(index?: number \| null \| undefined, count?: number \| undefined)](/.tablerowcollection#powerpoint-javascript/api/powerpoint/-tablerowcollection-add-member(1))|Adds one or more rows to the table.| -||[deleteRows(rows: PowerPoint.TableRow[])](/.tablerowcollection#powerpoint-javascript/api/powerpoint/-tablerowcollection-deleterows-member(1))|Deletes the specified rows from the collection.| -||[getCount()](/.tablerowcollection#powerpoint-javascript/api/powerpoint/-tablerowcollection-getcount-member(1))|Gets the number of rows in the collection.| -||[getItemAt(index: number)](/.tablerowcollection#powerpoint-javascript/api/powerpoint/-tablerowcollection-getitemat-member(1))|Gets the row using its zero-based index in the collection.| -||[items](/.tablerowcollection#powerpoint-javascript/api/powerpoint/-tablerowcollection-items-member)|Gets the loaded child items in this collection.| +|[Border](/javascript/api/powerpoint/powerpoint.border)|[color](/javascript/api/powerpoint/powerpoint.border#powerpoint-powerpoint-border-color-member)|Represents the line color in the hexadecimal format #RRGGBB (e.g., "FFA500") or as a named HTML color value (e.g., "orange").| +||[dashStyle](/javascript/api/powerpoint/powerpoint.border#powerpoint-powerpoint-border-dashstyle-member)|Represents the dash style of the line.| +||[transparency](/javascript/api/powerpoint/powerpoint.border#powerpoint-powerpoint-border-transparency-member)|Specifies the transparency percentage of the line as a value from 0.0 (opaque) through 1.0 (clear).| +||[weight](/javascript/api/powerpoint/powerpoint.border#powerpoint-powerpoint-border-weight-member)|Represents the weight of the line, in points.| +|[Borders](/javascript/api/powerpoint/powerpoint.borders)|[bottom](/javascript/api/powerpoint/powerpoint.borders#powerpoint-powerpoint-borders-bottom-member)|Gets the bottom border.| +||[diagonalDown](/javascript/api/powerpoint/powerpoint.borders#powerpoint-powerpoint-borders-diagonaldown-member)|Gets the diagonal border (top-left to bottom-right).| +||[diagonalUp](/javascript/api/powerpoint/powerpoint.borders#powerpoint-powerpoint-borders-diagonalup-member)|Gets the diagonal border (bottom-left to top-right).| +||[left](/javascript/api/powerpoint/powerpoint.borders#powerpoint-powerpoint-borders-left-member)|Gets the left border.| +||[right](/javascript/api/powerpoint/powerpoint.borders#powerpoint-powerpoint-borders-right-member)|Gets the right border.| +||[top](/javascript/api/powerpoint/powerpoint.borders#powerpoint-powerpoint-borders-top-member)|Gets the top border.| +|[Margins](/javascript/api/powerpoint/powerpoint.margins)|[bottom](/javascript/api/powerpoint/powerpoint.margins#powerpoint-powerpoint-margins-bottom-member)|Specifies the bottom margin in points.| +||[left](/javascript/api/powerpoint/powerpoint.margins#powerpoint-powerpoint-margins-left-member)|Specifies the left margin in points.| +||[right](/javascript/api/powerpoint/powerpoint.margins#powerpoint-powerpoint-margins-right-member)|Specifies the right margin in points.| +||[top](/javascript/api/powerpoint/powerpoint.margins#powerpoint-powerpoint-margins-top-member)|Specifies the top margin in points.| +|[Table](/javascript/api/powerpoint/powerpoint.table)|[clear(options?: PowerPoint.TableClearOptions)](/javascript/api/powerpoint/powerpoint.table#powerpoint-powerpoint-table-clear-member(1))|Clears table values and formatting.| +||[columns](/javascript/api/powerpoint/powerpoint.table#powerpoint-powerpoint-table-columns-member)|Gets the collection of columns in the table.| +||[mergeCells(rowIndex: number, columnIndex: number, rowCount: number, columnCount: number)](/javascript/api/powerpoint/powerpoint.table#powerpoint-powerpoint-table-mergecells-member(1))|Creates a merged area starting at the cell specified by rowIndex and columnIndex.| +||[rows](/javascript/api/powerpoint/powerpoint.table#powerpoint-powerpoint-table-rows-member)|Gets the collection of rows in the table.| +|[TableAddOptions](/javascript/api/powerpoint/powerpoint.tableaddoptions)|[style](/javascript/api/powerpoint/powerpoint.tableaddoptions#powerpoint-powerpoint-tableaddoptions-style-member)|Specifies value that represents the table style.| +|[TableCell](/javascript/api/powerpoint/powerpoint.tablecell)|[borders](/javascript/api/powerpoint/powerpoint.tablecell#powerpoint-powerpoint-tablecell-borders-member)|Gets the collection of borders for the table cell.| +||[fill](/javascript/api/powerpoint/powerpoint.tablecell#powerpoint-powerpoint-tablecell-fill-member)|Gets the fill color of the table cell.| +||[font](/javascript/api/powerpoint/powerpoint.tablecell#powerpoint-powerpoint-tablecell-font-member)|Gets the font of the table cell.| +||[horizontalAlignment](/javascript/api/powerpoint/powerpoint.tablecell#powerpoint-powerpoint-tablecell-horizontalalignment-member)|Specifies the horizontal alignment of the table cell.| +||[indentLevel](/javascript/api/powerpoint/powerpoint.tablecell#powerpoint-powerpoint-tablecell-indentlevel-member)|Specifies the indent level of the table cell.| +||[margins](/javascript/api/powerpoint/powerpoint.tablecell#powerpoint-powerpoint-tablecell-margins-member)|Gets the set of margins in the table cell.| +||[resize(rowCount: number, columnCount: number)](/javascript/api/powerpoint/powerpoint.tablecell#powerpoint-powerpoint-tablecell-resize-member(1))|Resizes the table cell to span across a specified number of rows and columns.| +||[split(rowCount: number, columnCount: number)](/javascript/api/powerpoint/powerpoint.tablecell#powerpoint-powerpoint-tablecell-split-member(1))|Splits the cell into the specified number of rows and columns.| +||[textRuns](/javascript/api/powerpoint/powerpoint.tablecell#powerpoint-powerpoint-tablecell-textruns-member)|Specifies the contents of the table cell as an array of PowerPoint.TextRun objects.| +||[verticalAlignment](/javascript/api/powerpoint/powerpoint.tablecell#powerpoint-powerpoint-tablecell-verticalalignment-member)|Specifies the vertical alignment of the text in the table cell.| +|[TableClearOptions](/javascript/api/powerpoint/powerpoint.tableclearoptions)|[all](/javascript/api/powerpoint/powerpoint.tableclearoptions#powerpoint-powerpoint-tableclearoptions-all-member)|Specifies if both values and formatting of the table should be cleared.| +||[format](/javascript/api/powerpoint/powerpoint.tableclearoptions#powerpoint-powerpoint-tableclearoptions-format-member)|Specifies if the formatting of the table should be cleared.| +||[text](/javascript/api/powerpoint/powerpoint.tableclearoptions#powerpoint-powerpoint-tableclearoptions-text-member)|Specifies if the values of the table should be cleared.| +|[TableColumn](/javascript/api/powerpoint/powerpoint.tablecolumn)|[columnIndex](/javascript/api/powerpoint/powerpoint.tablecolumn#powerpoint-powerpoint-tablecolumn-columnindex-member)|Returns the index number of the column within the column collection of the table.| +||[delete()](/javascript/api/powerpoint/powerpoint.tablecolumn#powerpoint-powerpoint-tablecolumn-delete-member(1))|Deletes the column.| +||[width](/javascript/api/powerpoint/powerpoint.tablecolumn#powerpoint-powerpoint-tablecolumn-width-member)|Retrieves the width of the column in points.| +|[TableColumnCollection](/javascript/api/powerpoint/powerpoint.tablecolumncollection)|[add(index?: number \| null \| undefined, count?: number \| undefined)](/javascript/api/powerpoint/powerpoint.tablecolumncollection#powerpoint-powerpoint-tablecolumncollection-add-member(1))|Adds one or more columns to the table.| +||[deleteColumns(columns: PowerPoint.TableColumn[])](/javascript/api/powerpoint/powerpoint.tablecolumncollection#powerpoint-powerpoint-tablecolumncollection-deletecolumns-member(1))|Deletes the specified columns from the collection.| +||[getCount()](/javascript/api/powerpoint/powerpoint.tablecolumncollection#powerpoint-powerpoint-tablecolumncollection-getcount-member(1))|Gets the number of columns in the collection.| +||[getItemAt(index: number)](/javascript/api/powerpoint/powerpoint.tablecolumncollection#powerpoint-powerpoint-tablecolumncollection-getitemat-member(1))|Gets the column using its zero-based index in the collection.| +||[items](/javascript/api/powerpoint/powerpoint.tablecolumncollection#powerpoint-powerpoint-tablecolumncollection-items-member)|Gets the loaded child items in this collection.| +|[TableRow](/javascript/api/powerpoint/powerpoint.tablerow)|[currentHeight](/javascript/api/powerpoint/powerpoint.tablerow#powerpoint-powerpoint-tablerow-currentheight-member)|Retrieves the current height of the row in points.| +||[delete()](/javascript/api/powerpoint/powerpoint.tablerow#powerpoint-powerpoint-tablerow-delete-member(1))|Deletes the row.| +||[height](/javascript/api/powerpoint/powerpoint.tablerow#powerpoint-powerpoint-tablerow-height-member)|Specifies the height of the row in points.| +||[rowIndex](/javascript/api/powerpoint/powerpoint.tablerow#powerpoint-powerpoint-tablerow-rowindex-member)|Returns the index number of the row within the rows collection of the table.| +|[TableRowCollection](/javascript/api/powerpoint/powerpoint.tablerowcollection)|[add(index?: number \| null \| undefined, count?: number \| undefined)](/javascript/api/powerpoint/powerpoint.tablerowcollection#powerpoint-powerpoint-tablerowcollection-add-member(1))|Adds one or more rows to the table.| +||[deleteRows(rows: PowerPoint.TableRow[])](/javascript/api/powerpoint/powerpoint.tablerowcollection#powerpoint-powerpoint-tablerowcollection-deleterows-member(1))|Deletes the specified rows from the collection.| +||[getCount()](/javascript/api/powerpoint/powerpoint.tablerowcollection#powerpoint-powerpoint-tablerowcollection-getcount-member(1))|Gets the number of rows in the collection.| +||[getItemAt(index: number)](/javascript/api/powerpoint/powerpoint.tablerowcollection#powerpoint-powerpoint-tablerowcollection-getitemat-member(1))|Gets the row using its zero-based index in the collection.| +||[items](/javascript/api/powerpoint/powerpoint.tablerowcollection#powerpoint-powerpoint-tablerowcollection-items-member)|Gets the loaded child items in this collection.| diff --git a/docs/includes/powerpoint-preview.md b/docs/includes/powerpoint-preview.md index 35be2b749c..bfd7c35008 100644 --- a/docs/includes/powerpoint-preview.md +++ b/docs/includes/powerpoint-preview.md @@ -1,67 +1,67 @@ | Class | Fields | Description | |:---|:---|:---| -|[BulletFormat](/.bulletformat)|[style](/.bulletformat#powerpoint-javascript/api/powerpoint/-bulletformat-style-member)|Specifies the style of the bullets in the paragraph.| -||[type](/.bulletformat#powerpoint-javascript/api/powerpoint/-bulletformat-type-member)|Specifies the type of the bullets in the paragraph.| -|[PageSetup](/.pagesetup)|[slideHeight](/.pagesetup#powerpoint-javascript/api/powerpoint/-pagesetup-slideheight-member)|Specifies the height of the slides in the presentation, in points.| -||[slideWidth](/.pagesetup#powerpoint-javascript/api/powerpoint/-pagesetup-slidewidth-member)|Specifies the width of the slides in the presentation, in points.| -|[ParagraphFormat](/.paragraphformat)|[indentLevel](/.paragraphformat#powerpoint-javascript/api/powerpoint/-paragraphformat-indentlevel-member)|Represents the indent level of the paragraph.| -|[Presentation](/.presentation)|[pageSetup](/.presentation#powerpoint-javascript/api/powerpoint/-presentation-pagesetup-member)|Returns the page setup information whose properties control slide setup attributes for the presentation.| -|[Shape](/.shape)|[getImageAsBase64(options?: PowerPoint.ShapeGetImageOptions)](/.shape#powerpoint-javascript/api/powerpoint/-shape-getimageasbase64-member(1))|Renders an image of the shape.| -||[getTextFrameOrNullObject()](/.shape#powerpoint-javascript/api/powerpoint/-shape-gettextframeornullobject-member(1))|Returns the PowerPoint.TextFrame object of this `Shape`.| -||[rotation](/.shape#powerpoint-javascript/api/powerpoint/-shape-rotation-member)|Specifies the rotation, in degrees, of the shape around the z-axis.| -||[visible](/.shape#powerpoint-javascript/api/powerpoint/-shape-visible-member)|Specifies if the shape is visible.| -|[ShapeGetImageOptions](/.shapegetimageoptions)|[format](/.shapegetimageoptions#powerpoint-javascript/api/powerpoint/-shapegetimageoptions-format-member)|The desired format of the resulting image.| -||[height](/.shapegetimageoptions#powerpoint-javascript/api/powerpoint/-shapegetimageoptions-height-member)|The desired height of the resulting image in pixels.| -||[width](/.shapegetimageoptions#powerpoint-javascript/api/powerpoint/-shapegetimageoptions-width-member)|The desired width of the resulting image in pixels.| -|[Slide](/.slide)|[background](/.slide#powerpoint-javascript/api/powerpoint/-slide-background-member)|Gets the background of the slide.| -||[themeColorScheme](/.slide#powerpoint-javascript/api/powerpoint/-slide-themecolorscheme-member)|Returns the `ThemeColorScheme` of the slide.| -|[SlideBackground](/.slidebackground)|[areBackgroundGraphicsHidden](/.slidebackground#powerpoint-javascript/api/powerpoint/-slidebackground-arebackgroundgraphicshidden-member)|Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.| -||[fill](/.slidebackground#powerpoint-javascript/api/powerpoint/-slidebackground-fill-member)|Returns the fill formatting of the background.| -||[isMasterBackgroundFollowed](/.slidebackground#powerpoint-javascript/api/powerpoint/-slidebackground-ismasterbackgroundfollowed-member)|Specifies if the slide background follows the slide master background.| -||[reset()](/.slidebackground#powerpoint-javascript/api/powerpoint/-slidebackground-reset-member(1))|Resets the fill formatting of the slide background.| -|[SlideBackgroundFill](/.slidebackgroundfill)|[getGradientFillOrNullObject()](/.slidebackgroundfill#powerpoint-javascript/api/powerpoint/-slidebackgroundfill-getgradientfillornullobject-member(1))|Gets the gradient fill properties.| -||[getPatternFillOrNullObject()](/.slidebackgroundfill#powerpoint-javascript/api/powerpoint/-slidebackgroundfill-getpatternfillornullobject-member(1))|Gets the pattern fill properties.| -||[getPictureOrTextureFillOrNullObject()](/.slidebackgroundfill#powerpoint-javascript/api/powerpoint/-slidebackgroundfill-getpictureortexturefillornullobject-member(1))|Gets the picture or texture fill properties.| -||[getSolidFillOrNullObject()](/.slidebackgroundfill#powerpoint-javascript/api/powerpoint/-slidebackgroundfill-getsolidfillornullobject-member(1))|Gets the solid fill properties.| -||[setGradientFill(options?: PowerPoint.SlideBackgroundGradientFillOptions)](/.slidebackgroundfill#powerpoint-javascript/api/powerpoint/-slidebackgroundfill-setgradientfill-member(1))|Sets the fill formatting of the slide background to a gradient fill.| -||[setPatternFill(options?: PowerPoint.SlideBackgroundPatternFillOptions)](/.slidebackgroundfill#powerpoint-javascript/api/powerpoint/-slidebackgroundfill-setpatternfill-member(1))|Sets the fill formatting of the slide background to a pattern fill.| -||[setPictureOrTextureFill(options?: PowerPoint.SlideBackgroundPictureOrTextureFillOptions)](/.slidebackgroundfill#powerpoint-javascript/api/powerpoint/-slidebackgroundfill-setpictureortexturefill-member(1))|Sets the fill formatting of the slide background to a picture or texture fill.| -||[setSolidFill(options?: PowerPoint.SlideBackgroundSolidFillOptions)](/.slidebackgroundfill#powerpoint-javascript/api/powerpoint/-slidebackgroundfill-setsolidfill-member(1))|Sets the fill formatting of the slide background to a solid fill.| -||[type](/.slidebackgroundfill#powerpoint-javascript/api/powerpoint/-slidebackgroundfill-type-member)|Returns the fill type of the slide background.| -|[SlideBackgroundGradientFill](/.slidebackgroundgradientfill)|[type](/.slidebackgroundgradientfill#powerpoint-javascript/api/powerpoint/-slidebackgroundgradientfill-type-member)|Specifies the type of gradient fill.| -|[SlideBackgroundGradientFillOptions](/.slidebackgroundgradientfilloptions)|[type](/.slidebackgroundgradientfilloptions#powerpoint-javascript/api/powerpoint/-slidebackgroundgradientfilloptions-type-member)|If provided, specifies the type of gradient fill.| -|[SlideBackgroundPatternFill](/.slidebackgroundpatternfill)|[backgroundColor](/.slidebackgroundpatternfill#powerpoint-javascript/api/powerpoint/-slidebackgroundpatternfill-backgroundcolor-member)|Specifies the background color in HTML color format (e.g., "#FFFFFF" or "white").| -||[foregroundColor](/.slidebackgroundpatternfill#powerpoint-javascript/api/powerpoint/-slidebackgroundpatternfill-foregroundcolor-member)|Specifies the foreground color in HTML color format (e.g., "#FFA500" or "orange").| -||[pattern](/.slidebackgroundpatternfill#powerpoint-javascript/api/powerpoint/-slidebackgroundpatternfill-pattern-member)|Specifies the pattern type.| -|[SlideBackgroundPatternFillOptions](/.slidebackgroundpatternfilloptions)|[backgroundColor](/.slidebackgroundpatternfilloptions#powerpoint-javascript/api/powerpoint/-slidebackgroundpatternfilloptions-backgroundcolor-member)|If provided, specifies the background color in HTML color format (e.g., "#FFFFFF" or "white").| -||[foregroundColor](/.slidebackgroundpatternfilloptions#powerpoint-javascript/api/powerpoint/-slidebackgroundpatternfilloptions-foregroundcolor-member)|If provided, specifies the foreground color in HTML color format (e.g., "#FFA500" or "orange").| -||[pattern](/.slidebackgroundpatternfilloptions#powerpoint-javascript/api/powerpoint/-slidebackgroundpatternfilloptions-pattern-member)|If provided, specifies the pattern type.| -|[SlideBackgroundPictureOrTextureFill](/.slidebackgroundpictureortexturefill)|[setImage(base64EncodedImage: string)](/.slidebackgroundpictureortexturefill#powerpoint-javascript/api/powerpoint/-slidebackgroundpictureortexturefill-setimage-member(1))|Sets the image used to fill.| -||[transparency](/.slidebackgroundpictureortexturefill#powerpoint-javascript/api/powerpoint/-slidebackgroundpictureortexturefill-transparency-member)|Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).| -|[SlideBackgroundPictureOrTextureFillOptions](/.slidebackgroundpictureortexturefilloptions)|[imageBase64](/.slidebackgroundpictureortexturefilloptions#powerpoint-javascript/api/powerpoint/-slidebackgroundpictureortexturefilloptions-imagebase64-member)|If provided, specifies the Base64-encoded image data for the fill.| -||[transparency](/.slidebackgroundpictureortexturefilloptions#powerpoint-javascript/api/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](/.slidebackgroundsolidfill)|[color](/.slidebackgroundsolidfill#powerpoint-javascript/api/powerpoint/-slidebackgroundsolidfill-color-member)|Specifies the fill color in HTML color format (e.g., "#FFA500" or "orange").| -||[transparency](/.slidebackgroundsolidfill#powerpoint-javascript/api/powerpoint/-slidebackgroundsolidfill-transparency-member)|Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).| -|[SlideBackgroundSolidFillOptions](/.slidebackgroundsolidfilloptions)|[color](/.slidebackgroundsolidfilloptions#powerpoint-javascript/api/powerpoint/-slidebackgroundsolidfilloptions-color-member)|If provided, specifies the fill color in HTML color format (e.g., "#FFA500" or "orange").| -||[transparency](/.slidebackgroundsolidfilloptions#powerpoint-javascript/api/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](/.slidecollection)|[exportAsBase64Presentation(values: Array)](/.slidecollection#powerpoint-javascript/api/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](/.slidelayout)|[background](/.slidelayout#powerpoint-javascript/api/powerpoint/-slidelayout-background-member)|Gets the background of the slide layout.| -||[themeColorScheme](/.slidelayout#powerpoint-javascript/api/powerpoint/-slidelayout-themecolorscheme-member)|Returns the `ThemeColorScheme` of the slide layout.| -|[SlideLayoutBackground](/.slidelayoutbackground)|[areBackgroundGraphicsHidden](/.slidelayoutbackground#powerpoint-javascript/api/powerpoint/-slidelayoutbackground-arebackgroundgraphicshidden-member)|Specifies whether the slide layout background fill hides or displays background graphic objects from the slide master.| -||[fill](/.slidelayoutbackground#powerpoint-javascript/api/powerpoint/-slidelayoutbackground-fill-member)|Returns the fill formatting of the background.| -||[isMasterBackgroundFollowed](/.slidelayoutbackground#powerpoint-javascript/api/powerpoint/-slidelayoutbackground-ismasterbackgroundfollowed-member)|Specifies if the slide layout background follows the slide master background.| -||[reset()](/.slidelayoutbackground#powerpoint-javascript/api/powerpoint/-slidelayoutbackground-reset-member(1))|Resets the fill formatting of the slide layout background.| -|[SlideMaster](/.slidemaster)|[background](/.slidemaster#powerpoint-javascript/api/powerpoint/-slidemaster-background-member)|Gets the background of the Slide Master.| -||[themeColorScheme](/.slidemaster#powerpoint-javascript/api/powerpoint/-slidemaster-themecolorscheme-member)|Returns the `ThemeColorScheme` of the Slide Master.| -|[SlideMasterBackground](/.slidemasterbackground)|[fill](/.slidemasterbackground#powerpoint-javascript/api/powerpoint/-slidemasterbackground-fill-member)|Returns the fill formatting of the background.| -|[SlideScopedCollection](/.slidescopedcollection)|[exportAsBase64Presentation()](/.slidescopedcollection#powerpoint-javascript/api/powerpoint/-slidescopedcollection-exportasbase64presentation-member(1))|Exports all slides in this collection to their own presentation file, returned as Base64-encoded data.| -|[Table](/.table)|[styleOptions](/.table#powerpoint-javascript/api/powerpoint/-table-styleoptions-member)|Gets the table style options.| -|[TableStyleOptions](/.tablestyleoptions)|[areColumnsBanded](/.tablestyleoptions#powerpoint-javascript/api/powerpoint/-tablestyleoptions-arecolumnsbanded-member)|Specifies if the columns show banded formatting in which odd columns are highlighted differently from even ones, to make reading the table easier.| -||[areRowsBanded](/.tablestyleoptions#powerpoint-javascript/api/powerpoint/-tablestyleoptions-arerowsbanded-member)|Specifies if the rows show banded formatting in which odd rows are highlighted differently from even ones, to make reading the table easier.| -||[isFirstColumnHighlighted](/.tablestyleoptions#powerpoint-javascript/api/powerpoint/-tablestyleoptions-isfirstcolumnhighlighted-member)|Specifies if the first column contains special formatting.| -||[isFirstRowHighlighted](/.tablestyleoptions#powerpoint-javascript/api/powerpoint/-tablestyleoptions-isfirstrowhighlighted-member)|Specifies if the first row contains special formatting.| -||[isLastColumnHighlighted](/.tablestyleoptions#powerpoint-javascript/api/powerpoint/-tablestyleoptions-islastcolumnhighlighted-member)|Specifies if the last column contains special formatting.| -||[isLastRowHighlighted](/.tablestyleoptions#powerpoint-javascript/api/powerpoint/-tablestyleoptions-islastrowhighlighted-member)|Specifies if the last row contains special formatting.| -||[style](/.tablestyleoptions#powerpoint-javascript/api/powerpoint/-tablestyleoptions-style-member)|Specifies the table style.| -|[ThemeColorScheme](/.themecolorscheme)|[getThemeColor(color: PowerPoint.ThemeColor)](/.themecolorscheme#powerpoint-javascript/api/powerpoint/-themecolorscheme-getthemecolor-member(1))|Gets the color value for the specified `ThemeColor`.| -||[setThemeColor(color: PowerPoint.ThemeColor, rgbColor: string)](/.themecolorscheme#powerpoint-javascript/api/powerpoint/-themecolorscheme-setthemecolor-member(1))|Sets the color value for the specified `ThemeColor`.| +|[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.| +|[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)|[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`.| +||[rotation](/javascript/api/powerpoint/powerpoint.shape#powerpoint-powerpoint-shape-rotation-member)|Specifies the rotation, in degrees, of the shape around the z-axis.| +||[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.| +|[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.| +|[Table](/javascript/api/powerpoint/powerpoint.table)|[styleOptions](/javascript/api/powerpoint/powerpoint.table#powerpoint-powerpoint-table-styleoptions-member)|Gets the table style options.| +|[TableStyleOptions](/javascript/api/powerpoint/powerpoint.tablestyleoptions)|[areColumnsBanded](/javascript/api/powerpoint/powerpoint.tablestyleoptions#powerpoint-powerpoint-tablestyleoptions-arecolumnsbanded-member)|Specifies if the columns show banded formatting in which odd columns are highlighted differently from even ones, to make reading the table easier.| +||[areRowsBanded](/javascript/api/powerpoint/powerpoint.tablestyleoptions#powerpoint-powerpoint-tablestyleoptions-arerowsbanded-member)|Specifies if the rows show banded formatting in which odd rows are highlighted differently from even ones, to make reading the table easier.| +||[isFirstColumnHighlighted](/javascript/api/powerpoint/powerpoint.tablestyleoptions#powerpoint-powerpoint-tablestyleoptions-isfirstcolumnhighlighted-member)|Specifies if the first column contains special formatting.| +||[isFirstRowHighlighted](/javascript/api/powerpoint/powerpoint.tablestyleoptions#powerpoint-powerpoint-tablestyleoptions-isfirstrowhighlighted-member)|Specifies if the first row contains special formatting.| +||[isLastColumnHighlighted](/javascript/api/powerpoint/powerpoint.tablestyleoptions#powerpoint-powerpoint-tablestyleoptions-islastcolumnhighlighted-member)|Specifies if the last column contains special formatting.| +||[isLastRowHighlighted](/javascript/api/powerpoint/powerpoint.tablestyleoptions#powerpoint-powerpoint-tablestyleoptions-islastrowhighlighted-member)|Specifies if the last row contains special formatting.| +||[style](/javascript/api/powerpoint/powerpoint.tablestyleoptions#powerpoint-powerpoint-tablestyleoptions-style-member)|Specifies the table style.| +|[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/word-1_1.md b/docs/includes/word-1_1.md index 06eb395503..9e8dda311c 100644 --- a/docs/includes/word-1_1.md +++ b/docs/includes/word-1_1.md @@ -1,144 +1,144 @@ | Class | Fields | Description | |:---|:---|:---| -|[Body](/.body)|[clear()](/.body#word-javascript/api/word/-body-clear-member(1))|Clears the contents of the body object.| -||[contentControls](/.body#word-javascript/api/word/-body-contentcontrols-member)|Gets the collection of rich text content control objects in the body.| -||[font](/.body#word-javascript/api/word/-body-font-member)|Gets the text format of the body.| -||[getHtml()](/.body#word-javascript/api/word/-body-gethtml-member(1))|Gets an HTML representation of the body object.| -||[getOoxml()](/.body#word-javascript/api/word/-body-getooxml-member(1))|Gets the OOXML (Office Open XML) representation of the body object.| -||[inlinePictures](/.body#word-javascript/api/word/-body-inlinepictures-member)|Gets the collection of InlinePicture objects in the body.| -||[insertBreak(breakType: Word.BreakType \| "Page" \| "Next" \| "SectionNext" \| "SectionContinuous" \| "SectionEven" \| "SectionOdd" \| "Line", insertLocation: Word.InsertLocation.start \| Word.InsertLocation.end \| "Start" \| "End")](/.body#word-javascript/api/word/-body-insertbreak-member(1))|Inserts a break at the specified location in the main document.| -||[insertContentControl(contentControlType?: Word.ContentControlType.richText \| Word.ContentControlType.plainText \| Word.ContentControlType.checkBox \| Word.ContentControlType.dropDownList \| Word.ContentControlType.comboBox \| "RichText" \| "PlainText" \| "CheckBox" \| "DropDownList" \| "ComboBox")](/.body#word-javascript/api/word/-body-insertcontentcontrol-member(1))|Wraps the Body object with a content control.| -||[insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/.body#word-javascript/api/word/-body-insertfilefrombase64-member(1))|Inserts a document into the body at the specified location.| -||[insertHtml(html: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/.body#word-javascript/api/word/-body-inserthtml-member(1))|Inserts HTML at the specified location.| -||[insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/.body#word-javascript/api/word/-body-insertooxml-member(1))|Inserts OOXML at the specified location.| -||[insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.start \| Word.InsertLocation.end \| "Start" \| "End")](/.body#word-javascript/api/word/-body-insertparagraph-member(1))|Inserts a paragraph at the specified location.| -||[insertText(text: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/.body#word-javascript/api/word/-body-inserttext-member(1))|Inserts text into the body at the specified location.| -||[paragraphs](/.body#word-javascript/api/word/-body-paragraphs-member)|Gets the collection of paragraph objects in the body.| -||[parentContentControl](/.body#word-javascript/api/word/-body-parentcontentcontrol-member)|Gets the content control that contains the body.| -||[search(searchText: string, searchOptions?: Word.SearchOptions \| { ignorePunct?: boolean ignoreSpace?: boolean matchCase?: boolean matchPrefix?: boolean matchSuffix?: boolean matchWholeWord?: boolean matchWildcards?: boolean })](/.body#word-javascript/api/word/-body-search-member(1))|Performs a search with the specified SearchOptions on the scope of the body object.| -||[select(selectionMode?: Word.SelectionMode)](/.body#word-javascript/api/word/-body-select-member(1))|Selects the body and navigates the Word UI to it.| -||[style](/.body#word-javascript/api/word/-body-style-member)|Specifies the style name for the body.| -||[text](/.body#word-javascript/api/word/-body-text-member)|Gets the text of the body.| -|[ContentControl](/.contentcontrol)|[appearance](/.contentcontrol#word-javascript/api/word/-contentcontrol-appearance-member)|Specifies the appearance of the content control.| -||[cannotDelete](/.contentcontrol#word-javascript/api/word/-contentcontrol-cannotdelete-member)|Specifies a value that indicates whether the user can delete the content control.| -||[cannotEdit](/.contentcontrol#word-javascript/api/word/-contentcontrol-cannotedit-member)|Specifies a value that indicates whether the user can edit the contents of the content control.| -||[clear()](/.contentcontrol#word-javascript/api/word/-contentcontrol-clear-member(1))|Clears the contents of the content control.| -||[color](/.contentcontrol#word-javascript/api/word/-contentcontrol-color-member)|Specifies the color of the content control.| -||[contentControls](/.contentcontrol#word-javascript/api/word/-contentcontrol-contentcontrols-member)|Gets the collection of content control objects in the content control.| -||[delete(keepContent: boolean)](/.contentcontrol#word-javascript/api/word/-contentcontrol-delete-member(1))|Deletes the content control and its content.| -||[font](/.contentcontrol#word-javascript/api/word/-contentcontrol-font-member)|Gets the text format of the content control.| -||[getHtml()](/.contentcontrol#word-javascript/api/word/-contentcontrol-gethtml-member(1))|Gets an HTML representation of the content control object.| -||[getOoxml()](/.contentcontrol#word-javascript/api/word/-contentcontrol-getooxml-member(1))|Gets the Office Open XML (OOXML) representation of the content control object.| -||[id](/.contentcontrol#word-javascript/api/word/-contentcontrol-id-member)|Gets an integer that represents the content control identifier.| -||[inlinePictures](/.contentcontrol#word-javascript/api/word/-contentcontrol-inlinepictures-member)|Gets the collection of InlinePicture objects in the content control.| -||[insertBreak(breakType: Word.BreakType \| "Page" \| "Next" \| "SectionNext" \| "SectionContinuous" \| "SectionEven" \| "SectionOdd" \| "Line", insertLocation: Word.InsertLocation.start \| Word.InsertLocation.end \| Word.InsertLocation.before \| Word.InsertLocation.after \| "Start" \| "End" \| "Before" \| "After")](/.contentcontrol#word-javascript/api/word/-contentcontrol-insertbreak-member(1))|Inserts a break at the specified location in the main document.| -||[insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/.contentcontrol#word-javascript/api/word/-contentcontrol-insertfilefrombase64-member(1))|Inserts a document into the content control at the specified location.| -||[insertHtml(html: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/.contentcontrol#word-javascript/api/word/-contentcontrol-inserthtml-member(1))|Inserts HTML into the content control at the specified location.| -||[insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/.contentcontrol#word-javascript/api/word/-contentcontrol-insertooxml-member(1))|Inserts OOXML into the content control at the specified location.| -||[insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.start \| Word.InsertLocation.end \| Word.InsertLocation.before \| Word.InsertLocation.after \| "Start" \| "End" \| "Before" \| "After")](/.contentcontrol#word-javascript/api/word/-contentcontrol-insertparagraph-member(1))|Inserts a paragraph at the specified location.| -||[insertText(text: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/.contentcontrol#word-javascript/api/word/-contentcontrol-inserttext-member(1))|Inserts text into the content control at the specified location.| -||[paragraphs](/.contentcontrol#word-javascript/api/word/-contentcontrol-paragraphs-member)|Gets the collection of paragraph objects in the content control.| -||[parentContentControl](/.contentcontrol#word-javascript/api/word/-contentcontrol-parentcontentcontrol-member)|Gets the content control that contains the content control.| -||[placeholderText](/.contentcontrol#word-javascript/api/word/-contentcontrol-placeholdertext-member)|Specifies the placeholder text of the content control.| -||[removeWhenEdited](/.contentcontrol#word-javascript/api/word/-contentcontrol-removewhenedited-member)|Specifies a value that indicates whether the content control is removed after it is edited.| -||[search(searchText: string, searchOptions?: Word.SearchOptions \| { ignorePunct?: boolean ignoreSpace?: boolean matchCase?: boolean matchPrefix?: boolean matchSuffix?: boolean matchWholeWord?: boolean matchWildcards?: boolean })](/.contentcontrol#word-javascript/api/word/-contentcontrol-search-member(1))|Performs a search with the specified SearchOptions on the scope of the content control object.| -||[select(selectionMode?: Word.SelectionMode)](/.contentcontrol#word-javascript/api/word/-contentcontrol-select-member(1))|Selects the content control.| -||[style](/.contentcontrol#word-javascript/api/word/-contentcontrol-style-member)|Specifies the style name for the content control.| -||[tag](/.contentcontrol#word-javascript/api/word/-contentcontrol-tag-member)|Specifies a tag to identify a content control.| -||[text](/.contentcontrol#word-javascript/api/word/-contentcontrol-text-member)|Gets the text of the content control.| -||[title](/.contentcontrol#word-javascript/api/word/-contentcontrol-title-member)|Specifies the title for a content control.| -||[type](/.contentcontrol#word-javascript/api/word/-contentcontrol-type-member)|Gets the content control type.| -|[ContentControlCollection](/.contentcontrolcollection)|[getById(id: number)](/.contentcontrolcollection#word-javascript/api/word/-contentcontrolcollection-getbyid-member(1))|Gets a content control by its identifier.| -||[getByTag(tag: string)](/.contentcontrolcollection#word-javascript/api/word/-contentcontrolcollection-getbytag-member(1))|Gets the content controls that have the specified tag.| -||[getByTitle(title: string)](/.contentcontrolcollection#word-javascript/api/word/-contentcontrolcollection-getbytitle-member(1))|Gets the content controls that have the specified title.| -||[getItem(id: number)](/.contentcontrolcollection#word-javascript/api/word/-contentcontrolcollection-getitem-member(1))|Gets a content control by its ID.| -||[items](/.contentcontrolcollection#word-javascript/api/word/-contentcontrolcollection-items-member)|Gets the loaded child items in this collection.| -|[Document](/.document)|[body](/.document#word-javascript/api/word/-document-body-member)|Gets the body object of the main document.| -||[contentControls](/.document#word-javascript/api/word/-document-contentcontrols-member)|Gets the collection of content control objects in the document.| -||[getSelection()](/.document#word-javascript/api/word/-document-getselection-member(1))|Gets the current selection of the document.| -||[save(saveBehavior?: Word.SaveBehavior, fileName?: string)](/.document#word-javascript/api/word/-document-save-member(1))|Saves the document.| -||[saved](/.document#word-javascript/api/word/-document-saved-member)|Indicates whether the changes in the document have been saved.| -||[sections](/.document#word-javascript/api/word/-document-sections-member)|Gets the collection of section objects in the document.| -|[Font](/.font)|[bold](/.font#word-javascript/api/word/-font-bold-member)|Specifies a value that indicates whether the font is bold.| -||[color](/.font#word-javascript/api/word/-font-color-member)|Specifies the color for the specified font.| -||[doubleStrikeThrough](/.font#word-javascript/api/word/-font-doublestrikethrough-member)|Specifies a value that indicates whether the font has a double strikethrough.| -||[highlightColor](/.font#word-javascript/api/word/-font-highlightcolor-member)|Specifies the highlight color.| -||[italic](/.font#word-javascript/api/word/-font-italic-member)|Specifies a value that indicates whether the font is italicized.| -||[name](/.font#word-javascript/api/word/-font-name-member)|Specifies a value that represents the name of the font.| -||[size](/.font#word-javascript/api/word/-font-size-member)|Specifies a value that represents the font size in points.| -||[strikeThrough](/.font#word-javascript/api/word/-font-strikethrough-member)|Specifies a value that indicates whether the font has a strikethrough.| -||[subscript](/.font#word-javascript/api/word/-font-subscript-member)|Specifies a value that indicates whether the font is a subscript.| -||[superscript](/.font#word-javascript/api/word/-font-superscript-member)|Specifies a value that indicates whether the font is a superscript.| -||[underline](/.font#word-javascript/api/word/-font-underline-member)|Specifies a value that indicates the font's underline type.| -|[InlinePicture](/.inlinepicture)|[altTextDescription](/.inlinepicture#word-javascript/api/word/-inlinepicture-alttextdescription-member)|Specifies a string that represents the alternative text associated with the inline image.| -||[altTextTitle](/.inlinepicture#word-javascript/api/word/-inlinepicture-alttexttitle-member)|Specifies a string that contains the title for the inline image.| -||[getBase64ImageSrc()](/.inlinepicture#word-javascript/api/word/-inlinepicture-getbase64imagesrc-member(1))|Gets the Base64-encoded string representation of the inline image.| -||[height](/.inlinepicture#word-javascript/api/word/-inlinepicture-height-member)|Specifies a number that describes the height of the inline image.| -||[hyperlink](/.inlinepicture#word-javascript/api/word/-inlinepicture-hyperlink-member)|Specifies a hyperlink on the image.| -||[insertContentControl()](/.inlinepicture#word-javascript/api/word/-inlinepicture-insertcontentcontrol-member(1))|Wraps the inline picture with a rich text content control.| -||[lockAspectRatio](/.inlinepicture#word-javascript/api/word/-inlinepicture-lockaspectratio-member)|Specifies a value that indicates whether the inline image retains its original proportions when you resize it.| -||[parentContentControl](/.inlinepicture#word-javascript/api/word/-inlinepicture-parentcontentcontrol-member)|Gets the content control that contains the inline image.| -||[width](/.inlinepicture#word-javascript/api/word/-inlinepicture-width-member)|Specifies a number that describes the width of the inline image.| -|[InlinePictureCollection](/.inlinepicturecollection)|[items](/.inlinepicturecollection#word-javascript/api/word/-inlinepicturecollection-items-member)|Gets the loaded child items in this collection.| -|[Paragraph](/.paragraph)|[alignment](/.paragraph#word-javascript/api/word/-paragraph-alignment-member)|Specifies the alignment for a paragraph.| -||[clear()](/.paragraph#word-javascript/api/word/-paragraph-clear-member(1))|Clears the contents of the paragraph object.| -||[contentControls](/.paragraph#word-javascript/api/word/-paragraph-contentcontrols-member)|Gets the collection of content control objects in the paragraph.| -||[delete()](/.paragraph#word-javascript/api/word/-paragraph-delete-member(1))|Deletes the paragraph and its content from the document.| -||[firstLineIndent](/.paragraph#word-javascript/api/word/-paragraph-firstlineindent-member)|Specifies the value, in points, for a first line or hanging indent.| -||[font](/.paragraph#word-javascript/api/word/-paragraph-font-member)|Gets the text format of the paragraph.| -||[getHtml()](/.paragraph#word-javascript/api/word/-paragraph-gethtml-member(1))|Gets an HTML representation of the paragraph object.| -||[getOoxml()](/.paragraph#word-javascript/api/word/-paragraph-getooxml-member(1))|Gets the Office Open XML (OOXML) representation of the paragraph object.| -||[inlinePictures](/.paragraph#word-javascript/api/word/-paragraph-inlinepictures-member)|Gets the collection of InlinePicture objects in the paragraph.| -||[insertBreak(breakType: Word.BreakType \| "Page" \| "Next" \| "SectionNext" \| "SectionContinuous" \| "SectionEven" \| "SectionOdd" \| "Line", insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After")](/.paragraph#word-javascript/api/word/-paragraph-insertbreak-member(1))|Inserts a break at the specified location in the main document.| -||[insertContentControl(contentControlType?: Word.ContentControlType.richText \| Word.ContentControlType.plainText \| Word.ContentControlType.checkBox \| Word.ContentControlType.dropDownList \| Word.ContentControlType.comboBox \| "RichText" \| "PlainText" \| "CheckBox" \| "DropDownList" \| "ComboBox")](/.paragraph#word-javascript/api/word/-paragraph-insertcontentcontrol-member(1))|Wraps the Paragraph object with a content control.| -||[insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/.paragraph#word-javascript/api/word/-paragraph-insertfilefrombase64-member(1))|Inserts a document into the paragraph at the specified location.| -||[insertHtml(html: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/.paragraph#word-javascript/api/word/-paragraph-inserthtml-member(1))|Inserts HTML into the paragraph at the specified location.| -||[insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/.paragraph#word-javascript/api/word/-paragraph-insertinlinepicturefrombase64-member(1))|Inserts a picture into the paragraph at the specified location.| -||[insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/.paragraph#word-javascript/api/word/-paragraph-insertooxml-member(1))|Inserts OOXML into the paragraph at the specified location.| -||[insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After")](/.paragraph#word-javascript/api/word/-paragraph-insertparagraph-member(1))|Inserts a paragraph at the specified location.| -||[insertText(text: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/.paragraph#word-javascript/api/word/-paragraph-inserttext-member(1))|Inserts text into the paragraph at the specified location.| -||[leftIndent](/.paragraph#word-javascript/api/word/-paragraph-leftindent-member)|Specifies the left indent value, in points, for the paragraph.| -||[lineSpacing](/.paragraph#word-javascript/api/word/-paragraph-linespacing-member)|Specifies the line spacing, in points, for the specified paragraph.| -||[lineUnitAfter](/.paragraph#word-javascript/api/word/-paragraph-lineunitafter-member)|Specifies the amount of spacing, in grid lines, after the paragraph.| -||[lineUnitBefore](/.paragraph#word-javascript/api/word/-paragraph-lineunitbefore-member)|Specifies the amount of spacing, in grid lines, before the paragraph.| -||[outlineLevel](/.paragraph#word-javascript/api/word/-paragraph-outlinelevel-member)|Specifies the outline level for the paragraph.| -||[parentContentControl](/.paragraph#word-javascript/api/word/-paragraph-parentcontentcontrol-member)|Gets the content control that contains the paragraph.| -||[rightIndent](/.paragraph#word-javascript/api/word/-paragraph-rightindent-member)|Specifies the right indent value, in points, for the paragraph.| -||[search(searchText: string, searchOptions?: Word.SearchOptions \| { ignorePunct?: boolean ignoreSpace?: boolean matchCase?: boolean matchPrefix?: boolean matchSuffix?: boolean matchWholeWord?: boolean matchWildcards?: boolean })](/.paragraph#word-javascript/api/word/-paragraph-search-member(1))|Performs a search with the specified SearchOptions on the scope of the paragraph object.| -||[select(selectionMode?: Word.SelectionMode)](/.paragraph#word-javascript/api/word/-paragraph-select-member(1))|Selects and navigates the Word UI to the paragraph.| -||[spaceAfter](/.paragraph#word-javascript/api/word/-paragraph-spaceafter-member)|Specifies the spacing, in points, after the paragraph.| -||[spaceBefore](/.paragraph#word-javascript/api/word/-paragraph-spacebefore-member)|Specifies the spacing, in points, before the paragraph.| -||[style](/.paragraph#word-javascript/api/word/-paragraph-style-member)|Specifies the style name for the paragraph.| -||[text](/.paragraph#word-javascript/api/word/-paragraph-text-member)|Gets the text of the paragraph.| -|[ParagraphCollection](/.paragraphcollection)|[items](/.paragraphcollection#word-javascript/api/word/-paragraphcollection-items-member)|Gets the loaded child items in this collection.| -|[Range](/.range)|[clear()](/.range#word-javascript/api/word/-range-clear-member(1))|Clears the contents of the range object.| -||[contentControls](/.range#word-javascript/api/word/-range-contentcontrols-member)|Gets the collection of content control objects in the range.| -||[delete()](/.range#word-javascript/api/word/-range-delete-member(1))|Deletes the range and its content from the document.| -||[font](/.range#word-javascript/api/word/-range-font-member)|Gets the text format of the range.| -||[getHtml()](/.range#word-javascript/api/word/-range-gethtml-member(1))|Gets an HTML representation of the range object.| -||[getOoxml()](/.range#word-javascript/api/word/-range-getooxml-member(1))|Gets the OOXML representation of the range object.| -||[insertBreak(breakType: Word.BreakType \| "Page" \| "Next" \| "SectionNext" \| "SectionContinuous" \| "SectionEven" \| "SectionOdd" \| "Line", insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After")](/.range#word-javascript/api/word/-range-insertbreak-member(1))|Inserts a break at the specified location in the main document.| -||[insertContentControl(contentControlType?: Word.ContentControlType.richText \| Word.ContentControlType.plainText \| Word.ContentControlType.checkBox \| Word.ContentControlType.dropDownList \| Word.ContentControlType.comboBox \| "RichText" \| "PlainText" \| "CheckBox" \| "DropDownList" \| "ComboBox")](/.range#word-javascript/api/word/-range-insertcontentcontrol-member(1))|Wraps the Range object with a content control.| -||[insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation \| "Replace" \| "Start" \| "End" \| "Before" \| "After")](/.range#word-javascript/api/word/-range-insertfilefrombase64-member(1))|Inserts a document at the specified location.| -||[insertHtml(html: string, insertLocation: Word.InsertLocation \| "Replace" \| "Start" \| "End" \| "Before" \| "After")](/.range#word-javascript/api/word/-range-inserthtml-member(1))|Inserts HTML at the specified location.| -||[insertOoxml(ooxml: string, insertLocation: Word.InsertLocation \| "Replace" \| "Start" \| "End" \| "Before" \| "After")](/.range#word-javascript/api/word/-range-insertooxml-member(1))|Inserts OOXML at the specified location.| -||[insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After")](/.range#word-javascript/api/word/-range-insertparagraph-member(1))|Inserts a paragraph at the specified location.| -||[insertText(text: string, insertLocation: Word.InsertLocation \| "Replace" \| "Start" \| "End" \| "Before" \| "After")](/.range#word-javascript/api/word/-range-inserttext-member(1))|Inserts text at the specified location.| -||[paragraphs](/.range#word-javascript/api/word/-range-paragraphs-member)|Gets the collection of paragraph objects in the range.| -||[parentContentControl](/.range#word-javascript/api/word/-range-parentcontentcontrol-member)|Gets the currently supported content control that contains the range.| -||[search(searchText: string, searchOptions?: Word.SearchOptions \| { ignorePunct?: boolean ignoreSpace?: boolean matchCase?: boolean matchPrefix?: boolean matchSuffix?: boolean matchWholeWord?: boolean matchWildcards?: boolean })](/.range#word-javascript/api/word/-range-search-member(1))|Performs a search with the specified SearchOptions on the scope of the range object.| -||[select(selectionMode?: Word.SelectionMode)](/.range#word-javascript/api/word/-range-select-member(1))|Selects and navigates the Word UI to the range.| -||[style](/.range#word-javascript/api/word/-range-style-member)|Specifies the style name for the range.| -||[text](/.range#word-javascript/api/word/-range-text-member)|Gets the text of the range.| -|[RangeCollection](/.rangecollection)|[items](/.rangecollection#word-javascript/api/word/-rangecollection-items-member)|Gets the loaded child items in this collection.| -|[SearchOptions](/.searchoptions)|[ignorePunct](/.searchoptions#word-javascript/api/word/-searchoptions-ignorepunct-member)|Specifies a value that indicates whether to ignore all punctuation characters between words.| -||[ignoreSpace](/.searchoptions#word-javascript/api/word/-searchoptions-ignorespace-member)|Specifies a value that indicates whether to ignore all whitespace between words.| -||[matchCase](/.searchoptions#word-javascript/api/word/-searchoptions-matchcase-member)|Specifies a value that indicates whether to perform a case sensitive search.| -||[matchPrefix](/.searchoptions#word-javascript/api/word/-searchoptions-matchprefix-member)|Specifies a value that indicates whether to match words that begin with the search string.| -||[matchSuffix](/.searchoptions#word-javascript/api/word/-searchoptions-matchsuffix-member)|Specifies a value that indicates whether to match words that end with the search string.| -||[matchWholeWord](/.searchoptions#word-javascript/api/word/-searchoptions-matchwholeword-member)|Specifies a value that indicates whether to find operation only entire words, not text that is part of a larger word.| -||[matchWildcards](/.searchoptions#word-javascript/api/word/-searchoptions-matchwildcards-member)|Specifies a value that indicates whether the search will be performed using special search operators.| -|[Section](/.section)|[body](/.section#word-javascript/api/word/-section-body-member)|Gets the body object of the section.| -||[getFooter(type: Word.HeaderFooterType)](/.section#word-javascript/api/word/-section-getfooter-member(1))|Gets one of the section's footers.| -||[getHeader(type: Word.HeaderFooterType)](/.section#word-javascript/api/word/-section-getheader-member(1))|Gets one of the section's headers.| -|[SectionCollection](/.sectioncollection)|[items](/.sectioncollection#word-javascript/api/word/-sectioncollection-items-member)|Gets the loaded child items in this collection.| +|[Body](/javascript/api/word/word.body)|[clear()](/javascript/api/word/word.body#word-word-body-clear-member(1))|Clears the contents of the body object.| +||[contentControls](/javascript/api/word/word.body#word-word-body-contentcontrols-member)|Gets the collection of rich text content control objects in the body.| +||[font](/javascript/api/word/word.body#word-word-body-font-member)|Gets the text format of the body.| +||[getHtml()](/javascript/api/word/word.body#word-word-body-gethtml-member(1))|Gets an HTML representation of the body object.| +||[getOoxml()](/javascript/api/word/word.body#word-word-body-getooxml-member(1))|Gets the OOXML (Office Open XML) representation of the body object.| +||[inlinePictures](/javascript/api/word/word.body#word-word-body-inlinepictures-member)|Gets the collection of InlinePicture objects in the body.| +||[insertBreak(breakType: Word.BreakType \| "Page" \| "Next" \| "SectionNext" \| "SectionContinuous" \| "SectionEven" \| "SectionOdd" \| "Line", insertLocation: Word.InsertLocation.start \| Word.InsertLocation.end \| "Start" \| "End")](/javascript/api/word/word.body#word-word-body-insertbreak-member(1))|Inserts a break at the specified location in the main document.| +||[insertContentControl(contentControlType?: Word.ContentControlType.richText \| Word.ContentControlType.plainText \| Word.ContentControlType.checkBox \| Word.ContentControlType.dropDownList \| Word.ContentControlType.comboBox \| "RichText" \| "PlainText" \| "CheckBox" \| "DropDownList" \| "ComboBox")](/javascript/api/word/word.body#word-word-body-insertcontentcontrol-member(1))|Wraps the Body object with a content control.| +||[insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/javascript/api/word/word.body#word-word-body-insertfilefrombase64-member(1))|Inserts a document into the body at the specified location.| +||[insertHtml(html: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/javascript/api/word/word.body#word-word-body-inserthtml-member(1))|Inserts HTML at the specified location.| +||[insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/javascript/api/word/word.body#word-word-body-insertooxml-member(1))|Inserts OOXML at the specified location.| +||[insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.start \| Word.InsertLocation.end \| "Start" \| "End")](/javascript/api/word/word.body#word-word-body-insertparagraph-member(1))|Inserts a paragraph at the specified location.| +||[insertText(text: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/javascript/api/word/word.body#word-word-body-inserttext-member(1))|Inserts text into the body at the specified location.| +||[paragraphs](/javascript/api/word/word.body#word-word-body-paragraphs-member)|Gets the collection of paragraph objects in the body.| +||[parentContentControl](/javascript/api/word/word.body#word-word-body-parentcontentcontrol-member)|Gets the content control that contains the body.| +||[search(searchText: string, searchOptions?: Word.SearchOptions \| { ignorePunct?: boolean ignoreSpace?: boolean matchCase?: boolean matchPrefix?: boolean matchSuffix?: boolean matchWholeWord?: boolean matchWildcards?: boolean })](/javascript/api/word/word.body#word-word-body-search-member(1))|Performs a search with the specified SearchOptions on the scope of the body object.| +||[select(selectionMode?: Word.SelectionMode)](/javascript/api/word/word.body#word-word-body-select-member(1))|Selects the body and navigates the Word UI to it.| +||[style](/javascript/api/word/word.body#word-word-body-style-member)|Specifies the style name for the body.| +||[text](/javascript/api/word/word.body#word-word-body-text-member)|Gets the text of the body.| +|[ContentControl](/javascript/api/word/word.contentcontrol)|[appearance](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-appearance-member)|Specifies the appearance of the content control.| +||[cannotDelete](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-cannotdelete-member)|Specifies a value that indicates whether the user can delete the content control.| +||[cannotEdit](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-cannotedit-member)|Specifies a value that indicates whether the user can edit the contents of the content control.| +||[clear()](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-clear-member(1))|Clears the contents of the content control.| +||[color](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-color-member)|Specifies the color of the content control.| +||[contentControls](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-contentcontrols-member)|Gets the collection of content control objects in the content control.| +||[delete(keepContent: boolean)](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-delete-member(1))|Deletes the content control and its content.| +||[font](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-font-member)|Gets the text format of the content control.| +||[getHtml()](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-gethtml-member(1))|Gets an HTML representation of the content control object.| +||[getOoxml()](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-getooxml-member(1))|Gets the Office Open XML (OOXML) representation of the content control object.| +||[id](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-id-member)|Gets an integer that represents the content control identifier.| +||[inlinePictures](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-inlinepictures-member)|Gets the collection of InlinePicture objects in the content control.| +||[insertBreak(breakType: Word.BreakType \| "Page" \| "Next" \| "SectionNext" \| "SectionContinuous" \| "SectionEven" \| "SectionOdd" \| "Line", insertLocation: Word.InsertLocation.start \| Word.InsertLocation.end \| Word.InsertLocation.before \| Word.InsertLocation.after \| "Start" \| "End" \| "Before" \| "After")](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-insertbreak-member(1))|Inserts a break at the specified location in the main document.| +||[insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-insertfilefrombase64-member(1))|Inserts a document into the content control at the specified location.| +||[insertHtml(html: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-inserthtml-member(1))|Inserts HTML into the content control at the specified location.| +||[insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-insertooxml-member(1))|Inserts OOXML into the content control at the specified location.| +||[insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.start \| Word.InsertLocation.end \| Word.InsertLocation.before \| Word.InsertLocation.after \| "Start" \| "End" \| "Before" \| "After")](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-insertparagraph-member(1))|Inserts a paragraph at the specified location.| +||[insertText(text: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-inserttext-member(1))|Inserts text into the content control at the specified location.| +||[paragraphs](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-paragraphs-member)|Gets the collection of paragraph objects in the content control.| +||[parentContentControl](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-parentcontentcontrol-member)|Gets the content control that contains the content control.| +||[placeholderText](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-placeholdertext-member)|Specifies the placeholder text of the content control.| +||[removeWhenEdited](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-removewhenedited-member)|Specifies a value that indicates whether the content control is removed after it is edited.| +||[search(searchText: string, searchOptions?: Word.SearchOptions \| { ignorePunct?: boolean ignoreSpace?: boolean matchCase?: boolean matchPrefix?: boolean matchSuffix?: boolean matchWholeWord?: boolean matchWildcards?: boolean })](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-search-member(1))|Performs a search with the specified SearchOptions on the scope of the content control object.| +||[select(selectionMode?: Word.SelectionMode)](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-select-member(1))|Selects the content control.| +||[style](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-style-member)|Specifies the style name for the content control.| +||[tag](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-tag-member)|Specifies a tag to identify a content control.| +||[text](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-text-member)|Gets the text of the content control.| +||[title](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-title-member)|Specifies the title for a content control.| +||[type](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-type-member)|Gets the content control type.| +|[ContentControlCollection](/javascript/api/word/word.contentcontrolcollection)|[getById(id: number)](/javascript/api/word/word.contentcontrolcollection#word-word-contentcontrolcollection-getbyid-member(1))|Gets a content control by its identifier.| +||[getByTag(tag: string)](/javascript/api/word/word.contentcontrolcollection#word-word-contentcontrolcollection-getbytag-member(1))|Gets the content controls that have the specified tag.| +||[getByTitle(title: string)](/javascript/api/word/word.contentcontrolcollection#word-word-contentcontrolcollection-getbytitle-member(1))|Gets the content controls that have the specified title.| +||[getItem(id: number)](/javascript/api/word/word.contentcontrolcollection#word-word-contentcontrolcollection-getitem-member(1))|Gets a content control by its ID.| +||[items](/javascript/api/word/word.contentcontrolcollection#word-word-contentcontrolcollection-items-member)|Gets the loaded child items in this collection.| +|[Document](/javascript/api/word/word.document)|[body](/javascript/api/word/word.document#word-word-document-body-member)|Gets the body object of the main document.| +||[contentControls](/javascript/api/word/word.document#word-word-document-contentcontrols-member)|Gets the collection of content control objects in the document.| +||[getSelection()](/javascript/api/word/word.document#word-word-document-getselection-member(1))|Gets the current selection of the document.| +||[save(saveBehavior?: Word.SaveBehavior, fileName?: string)](/javascript/api/word/word.document#word-word-document-save-member(1))|Saves the document.| +||[saved](/javascript/api/word/word.document#word-word-document-saved-member)|Indicates whether the changes in the document have been saved.| +||[sections](/javascript/api/word/word.document#word-word-document-sections-member)|Gets the collection of section objects in the document.| +|[Font](/javascript/api/word/word.font)|[bold](/javascript/api/word/word.font#word-word-font-bold-member)|Specifies a value that indicates whether the font is bold.| +||[color](/javascript/api/word/word.font#word-word-font-color-member)|Specifies the color for the specified font.| +||[doubleStrikeThrough](/javascript/api/word/word.font#word-word-font-doublestrikethrough-member)|Specifies a value that indicates whether the font has a double strikethrough.| +||[highlightColor](/javascript/api/word/word.font#word-word-font-highlightcolor-member)|Specifies the highlight color.| +||[italic](/javascript/api/word/word.font#word-word-font-italic-member)|Specifies a value that indicates whether the font is italicized.| +||[name](/javascript/api/word/word.font#word-word-font-name-member)|Specifies a value that represents the name of the font.| +||[size](/javascript/api/word/word.font#word-word-font-size-member)|Specifies a value that represents the font size in points.| +||[strikeThrough](/javascript/api/word/word.font#word-word-font-strikethrough-member)|Specifies a value that indicates whether the font has a strikethrough.| +||[subscript](/javascript/api/word/word.font#word-word-font-subscript-member)|Specifies a value that indicates whether the font is a subscript.| +||[superscript](/javascript/api/word/word.font#word-word-font-superscript-member)|Specifies a value that indicates whether the font is a superscript.| +||[underline](/javascript/api/word/word.font#word-word-font-underline-member)|Specifies a value that indicates the font's underline type.| +|[InlinePicture](/javascript/api/word/word.inlinepicture)|[altTextDescription](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-alttextdescription-member)|Specifies a string that represents the alternative text associated with the inline image.| +||[altTextTitle](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-alttexttitle-member)|Specifies a string that contains the title for the inline image.| +||[getBase64ImageSrc()](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-getbase64imagesrc-member(1))|Gets the Base64-encoded string representation of the inline image.| +||[height](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-height-member)|Specifies a number that describes the height of the inline image.| +||[hyperlink](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-hyperlink-member)|Specifies a hyperlink on the image.| +||[insertContentControl()](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-insertcontentcontrol-member(1))|Wraps the inline picture with a rich text content control.| +||[lockAspectRatio](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-lockaspectratio-member)|Specifies a value that indicates whether the inline image retains its original proportions when you resize it.| +||[parentContentControl](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-parentcontentcontrol-member)|Gets the content control that contains the inline image.| +||[width](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-width-member)|Specifies a number that describes the width of the inline image.| +|[InlinePictureCollection](/javascript/api/word/word.inlinepicturecollection)|[items](/javascript/api/word/word.inlinepicturecollection#word-word-inlinepicturecollection-items-member)|Gets the loaded child items in this collection.| +|[Paragraph](/javascript/api/word/word.paragraph)|[alignment](/javascript/api/word/word.paragraph#word-word-paragraph-alignment-member)|Specifies the alignment for a paragraph.| +||[clear()](/javascript/api/word/word.paragraph#word-word-paragraph-clear-member(1))|Clears the contents of the paragraph object.| +||[contentControls](/javascript/api/word/word.paragraph#word-word-paragraph-contentcontrols-member)|Gets the collection of content control objects in the paragraph.| +||[delete()](/javascript/api/word/word.paragraph#word-word-paragraph-delete-member(1))|Deletes the paragraph and its content from the document.| +||[firstLineIndent](/javascript/api/word/word.paragraph#word-word-paragraph-firstlineindent-member)|Specifies the value, in points, for a first line or hanging indent.| +||[font](/javascript/api/word/word.paragraph#word-word-paragraph-font-member)|Gets the text format of the paragraph.| +||[getHtml()](/javascript/api/word/word.paragraph#word-word-paragraph-gethtml-member(1))|Gets an HTML representation of the paragraph object.| +||[getOoxml()](/javascript/api/word/word.paragraph#word-word-paragraph-getooxml-member(1))|Gets the Office Open XML (OOXML) representation of the paragraph object.| +||[inlinePictures](/javascript/api/word/word.paragraph#word-word-paragraph-inlinepictures-member)|Gets the collection of InlinePicture objects in the paragraph.| +||[insertBreak(breakType: Word.BreakType \| "Page" \| "Next" \| "SectionNext" \| "SectionContinuous" \| "SectionEven" \| "SectionOdd" \| "Line", insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After")](/javascript/api/word/word.paragraph#word-word-paragraph-insertbreak-member(1))|Inserts a break at the specified location in the main document.| +||[insertContentControl(contentControlType?: Word.ContentControlType.richText \| Word.ContentControlType.plainText \| Word.ContentControlType.checkBox \| Word.ContentControlType.dropDownList \| Word.ContentControlType.comboBox \| "RichText" \| "PlainText" \| "CheckBox" \| "DropDownList" \| "ComboBox")](/javascript/api/word/word.paragraph#word-word-paragraph-insertcontentcontrol-member(1))|Wraps the Paragraph object with a content control.| +||[insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/javascript/api/word/word.paragraph#word-word-paragraph-insertfilefrombase64-member(1))|Inserts a document into the paragraph at the specified location.| +||[insertHtml(html: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/javascript/api/word/word.paragraph#word-word-paragraph-inserthtml-member(1))|Inserts HTML into the paragraph at the specified location.| +||[insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/javascript/api/word/word.paragraph#word-word-paragraph-insertinlinepicturefrombase64-member(1))|Inserts a picture into the paragraph at the specified location.| +||[insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/javascript/api/word/word.paragraph#word-word-paragraph-insertooxml-member(1))|Inserts OOXML into the paragraph at the specified location.| +||[insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After")](/javascript/api/word/word.paragraph#word-word-paragraph-insertparagraph-member(1))|Inserts a paragraph at the specified location.| +||[insertText(text: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/javascript/api/word/word.paragraph#word-word-paragraph-inserttext-member(1))|Inserts text into the paragraph at the specified location.| +||[leftIndent](/javascript/api/word/word.paragraph#word-word-paragraph-leftindent-member)|Specifies the left indent value, in points, for the paragraph.| +||[lineSpacing](/javascript/api/word/word.paragraph#word-word-paragraph-linespacing-member)|Specifies the line spacing, in points, for the specified paragraph.| +||[lineUnitAfter](/javascript/api/word/word.paragraph#word-word-paragraph-lineunitafter-member)|Specifies the amount of spacing, in grid lines, after the paragraph.| +||[lineUnitBefore](/javascript/api/word/word.paragraph#word-word-paragraph-lineunitbefore-member)|Specifies the amount of spacing, in grid lines, before the paragraph.| +||[outlineLevel](/javascript/api/word/word.paragraph#word-word-paragraph-outlinelevel-member)|Specifies the outline level for the paragraph.| +||[parentContentControl](/javascript/api/word/word.paragraph#word-word-paragraph-parentcontentcontrol-member)|Gets the content control that contains the paragraph.| +||[rightIndent](/javascript/api/word/word.paragraph#word-word-paragraph-rightindent-member)|Specifies the right indent value, in points, for the paragraph.| +||[search(searchText: string, searchOptions?: Word.SearchOptions \| { ignorePunct?: boolean ignoreSpace?: boolean matchCase?: boolean matchPrefix?: boolean matchSuffix?: boolean matchWholeWord?: boolean matchWildcards?: boolean })](/javascript/api/word/word.paragraph#word-word-paragraph-search-member(1))|Performs a search with the specified SearchOptions on the scope of the paragraph object.| +||[select(selectionMode?: Word.SelectionMode)](/javascript/api/word/word.paragraph#word-word-paragraph-select-member(1))|Selects and navigates the Word UI to the paragraph.| +||[spaceAfter](/javascript/api/word/word.paragraph#word-word-paragraph-spaceafter-member)|Specifies the spacing, in points, after the paragraph.| +||[spaceBefore](/javascript/api/word/word.paragraph#word-word-paragraph-spacebefore-member)|Specifies the spacing, in points, before the paragraph.| +||[style](/javascript/api/word/word.paragraph#word-word-paragraph-style-member)|Specifies the style name for the paragraph.| +||[text](/javascript/api/word/word.paragraph#word-word-paragraph-text-member)|Gets the text of the paragraph.| +|[ParagraphCollection](/javascript/api/word/word.paragraphcollection)|[items](/javascript/api/word/word.paragraphcollection#word-word-paragraphcollection-items-member)|Gets the loaded child items in this collection.| +|[Range](/javascript/api/word/word.range)|[clear()](/javascript/api/word/word.range#word-word-range-clear-member(1))|Clears the contents of the range object.| +||[contentControls](/javascript/api/word/word.range#word-word-range-contentcontrols-member)|Gets the collection of content control objects in the range.| +||[delete()](/javascript/api/word/word.range#word-word-range-delete-member(1))|Deletes the range and its content from the document.| +||[font](/javascript/api/word/word.range#word-word-range-font-member)|Gets the text format of the range.| +||[getHtml()](/javascript/api/word/word.range#word-word-range-gethtml-member(1))|Gets an HTML representation of the range object.| +||[getOoxml()](/javascript/api/word/word.range#word-word-range-getooxml-member(1))|Gets the OOXML representation of the range object.| +||[insertBreak(breakType: Word.BreakType \| "Page" \| "Next" \| "SectionNext" \| "SectionContinuous" \| "SectionEven" \| "SectionOdd" \| "Line", insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After")](/javascript/api/word/word.range#word-word-range-insertbreak-member(1))|Inserts a break at the specified location in the main document.| +||[insertContentControl(contentControlType?: Word.ContentControlType.richText \| Word.ContentControlType.plainText \| Word.ContentControlType.checkBox \| Word.ContentControlType.dropDownList \| Word.ContentControlType.comboBox \| "RichText" \| "PlainText" \| "CheckBox" \| "DropDownList" \| "ComboBox")](/javascript/api/word/word.range#word-word-range-insertcontentcontrol-member(1))|Wraps the Range object with a content control.| +||[insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation \| "Replace" \| "Start" \| "End" \| "Before" \| "After")](/javascript/api/word/word.range#word-word-range-insertfilefrombase64-member(1))|Inserts a document at the specified location.| +||[insertHtml(html: string, insertLocation: Word.InsertLocation \| "Replace" \| "Start" \| "End" \| "Before" \| "After")](/javascript/api/word/word.range#word-word-range-inserthtml-member(1))|Inserts HTML at the specified location.| +||[insertOoxml(ooxml: string, insertLocation: Word.InsertLocation \| "Replace" \| "Start" \| "End" \| "Before" \| "After")](/javascript/api/word/word.range#word-word-range-insertooxml-member(1))|Inserts OOXML at the specified location.| +||[insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After")](/javascript/api/word/word.range#word-word-range-insertparagraph-member(1))|Inserts a paragraph at the specified location.| +||[insertText(text: string, insertLocation: Word.InsertLocation \| "Replace" \| "Start" \| "End" \| "Before" \| "After")](/javascript/api/word/word.range#word-word-range-inserttext-member(1))|Inserts text at the specified location.| +||[paragraphs](/javascript/api/word/word.range#word-word-range-paragraphs-member)|Gets the collection of paragraph objects in the range.| +||[parentContentControl](/javascript/api/word/word.range#word-word-range-parentcontentcontrol-member)|Gets the currently supported content control that contains the range.| +||[search(searchText: string, searchOptions?: Word.SearchOptions \| { ignorePunct?: boolean ignoreSpace?: boolean matchCase?: boolean matchPrefix?: boolean matchSuffix?: boolean matchWholeWord?: boolean matchWildcards?: boolean })](/javascript/api/word/word.range#word-word-range-search-member(1))|Performs a search with the specified SearchOptions on the scope of the range object.| +||[select(selectionMode?: Word.SelectionMode)](/javascript/api/word/word.range#word-word-range-select-member(1))|Selects and navigates the Word UI to the range.| +||[style](/javascript/api/word/word.range#word-word-range-style-member)|Specifies the style name for the range.| +||[text](/javascript/api/word/word.range#word-word-range-text-member)|Gets the text of the range.| +|[RangeCollection](/javascript/api/word/word.rangecollection)|[items](/javascript/api/word/word.rangecollection#word-word-rangecollection-items-member)|Gets the loaded child items in this collection.| +|[SearchOptions](/javascript/api/word/word.searchoptions)|[ignorePunct](/javascript/api/word/word.searchoptions#word-word-searchoptions-ignorepunct-member)|Specifies a value that indicates whether to ignore all punctuation characters between words.| +||[ignoreSpace](/javascript/api/word/word.searchoptions#word-word-searchoptions-ignorespace-member)|Specifies a value that indicates whether to ignore all whitespace between words.| +||[matchCase](/javascript/api/word/word.searchoptions#word-word-searchoptions-matchcase-member)|Specifies a value that indicates whether to perform a case sensitive search.| +||[matchPrefix](/javascript/api/word/word.searchoptions#word-word-searchoptions-matchprefix-member)|Specifies a value that indicates whether to match words that begin with the search string.| +||[matchSuffix](/javascript/api/word/word.searchoptions#word-word-searchoptions-matchsuffix-member)|Specifies a value that indicates whether to match words that end with the search string.| +||[matchWholeWord](/javascript/api/word/word.searchoptions#word-word-searchoptions-matchwholeword-member)|Specifies a value that indicates whether to find operation only entire words, not text that is part of a larger word.| +||[matchWildcards](/javascript/api/word/word.searchoptions#word-word-searchoptions-matchwildcards-member)|Specifies a value that indicates whether the search will be performed using special search operators.| +|[Section](/javascript/api/word/word.section)|[body](/javascript/api/word/word.section#word-word-section-body-member)|Gets the body object of the section.| +||[getFooter(type: Word.HeaderFooterType)](/javascript/api/word/word.section#word-word-section-getfooter-member(1))|Gets one of the section's footers.| +||[getHeader(type: Word.HeaderFooterType)](/javascript/api/word/word.section#word-word-section-getheader-member(1))|Gets one of the section's headers.| +|[SectionCollection](/javascript/api/word/word.sectioncollection)|[items](/javascript/api/word/word.sectioncollection#word-word-sectioncollection-items-member)|Gets the loaded child items in this collection.| diff --git a/docs/includes/word-1_2.md b/docs/includes/word-1_2.md index 2569c64db5..870fc1ff4d 100644 --- a/docs/includes/word-1_2.md +++ b/docs/includes/word-1_2.md @@ -1,16 +1,16 @@ | Class | Fields | Description | |:---|:---|:---| -|[Body](/.body)|[insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.start \| Word.InsertLocation.end \| "Start" \| "End")](/.body#word-javascript/api/word/-body-insertinlinepicturefrombase64-member(1))|Inserts a picture into the body at the specified location.| -|[ContentControl](/.contentcontrol)|[insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/.contentcontrol#word-javascript/api/word/-contentcontrol-insertinlinepicturefrombase64-member(1))|Inserts an inline picture into the content control at the specified location.| -|[InlinePicture](/.inlinepicture)|[delete()](/.inlinepicture#word-javascript/api/word/-inlinepicture-delete-member(1))|Deletes the inline picture from the document.| -||[insertBreak(breakType: Word.BreakType \| "Page" \| "Next" \| "SectionNext" \| "SectionContinuous" \| "SectionEven" \| "SectionOdd" \| "Line", insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After")](/.inlinepicture#word-javascript/api/word/-inlinepicture-insertbreak-member(1))|Inserts a break at the specified location in the main document.| -||[insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After")](/.inlinepicture#word-javascript/api/word/-inlinepicture-insertfilefrombase64-member(1))|Inserts a document at the specified location.| -||[insertHtml(html: string, insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After")](/.inlinepicture#word-javascript/api/word/-inlinepicture-inserthtml-member(1))|Inserts HTML at the specified location.| -||[insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.before \| Word.InsertLocation.after \| "Replace" \| "Before" \| "After")](/.inlinepicture#word-javascript/api/word/-inlinepicture-insertinlinepicturefrombase64-member(1))|Inserts an inline picture at the specified location.| -||[insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After")](/.inlinepicture#word-javascript/api/word/-inlinepicture-insertooxml-member(1))|Inserts OOXML at the specified location.| -||[insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After")](/.inlinepicture#word-javascript/api/word/-inlinepicture-insertparagraph-member(1))|Inserts a paragraph at the specified location.| -||[insertText(text: string, insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After")](/.inlinepicture#word-javascript/api/word/-inlinepicture-inserttext-member(1))|Inserts text at the specified location.| -||[paragraph](/.inlinepicture#word-javascript/api/word/-inlinepicture-paragraph-member)|Gets the parent paragraph that contains the inline image.| -||[select(selectionMode?: Word.SelectionMode)](/.inlinepicture#word-javascript/api/word/-inlinepicture-select-member(1))|Selects the inline picture.| -|[Range](/.range)|[inlinePictures](/.range#word-javascript/api/word/-range-inlinepictures-member)|Gets the collection of inline picture objects in the range.| -||[insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation \| "Replace" \| "Start" \| "End" \| "Before" \| "After")](/.range#word-javascript/api/word/-range-insertinlinepicturefrombase64-member(1))|Inserts a picture at the specified location.| +|[Body](/javascript/api/word/word.body)|[insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.start \| Word.InsertLocation.end \| "Start" \| "End")](/javascript/api/word/word.body#word-word-body-insertinlinepicturefrombase64-member(1))|Inserts a picture into the body at the specified location.| +|[ContentControl](/javascript/api/word/word.contentcontrol)|[insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End")](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-insertinlinepicturefrombase64-member(1))|Inserts an inline picture into the content control at the specified location.| +|[InlinePicture](/javascript/api/word/word.inlinepicture)|[delete()](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-delete-member(1))|Deletes the inline picture from the document.| +||[insertBreak(breakType: Word.BreakType \| "Page" \| "Next" \| "SectionNext" \| "SectionContinuous" \| "SectionEven" \| "SectionOdd" \| "Line", insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After")](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-insertbreak-member(1))|Inserts a break at the specified location in the main document.| +||[insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After")](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-insertfilefrombase64-member(1))|Inserts a document at the specified location.| +||[insertHtml(html: string, insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After")](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-inserthtml-member(1))|Inserts HTML at the specified location.| +||[insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.before \| Word.InsertLocation.after \| "Replace" \| "Before" \| "After")](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-insertinlinepicturefrombase64-member(1))|Inserts an inline picture at the specified location.| +||[insertOoxml(ooxml: string, insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After")](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-insertooxml-member(1))|Inserts OOXML at the specified location.| +||[insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After")](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-insertparagraph-member(1))|Inserts a paragraph at the specified location.| +||[insertText(text: string, insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After")](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-inserttext-member(1))|Inserts text at the specified location.| +||[paragraph](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-paragraph-member)|Gets the parent paragraph that contains the inline image.| +||[select(selectionMode?: Word.SelectionMode)](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-select-member(1))|Selects the inline picture.| +|[Range](/javascript/api/word/word.range)|[inlinePictures](/javascript/api/word/word.range#word-word-range-inlinepictures-member)|Gets the collection of inline picture objects in the range.| +||[insertInlinePictureFromBase64(base64EncodedImage: string, insertLocation: Word.InsertLocation \| "Replace" \| "Start" \| "End" \| "Before" \| "After")](/javascript/api/word/word.range#word-word-range-insertinlinepicturefrombase64-member(1))|Inserts a picture at the specified location.| diff --git a/docs/includes/word-1_3.md b/docs/includes/word-1_3.md index 6b600c76d1..2da6e62de5 100644 --- a/docs/includes/word-1_3.md +++ b/docs/includes/word-1_3.md @@ -1,261 +1,261 @@ | Class | Fields | Description | |:---|:---|:---| -|[Application](/.application)|[createDocument(base64File?: string)](/.application#word-javascript/api/word/-application-createdocument-member(1))|Creates a new document by using an optional Base64-encoded .docx file.| -|[Body](/.body)|[getRange(rangeLocation?: Word.RangeLocation.whole \| Word.RangeLocation.start \| Word.RangeLocation.end \| Word.RangeLocation.after \| Word.RangeLocation.content \| "Whole" \| "Start" \| "End" \| "After" \| "Content")](/.body#word-javascript/api/word/-body-getrange-member(1))|Gets the whole body, or the starting or ending point of the body, as a range.| -||[insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.start \| Word.InsertLocation.end \| "Start" \| "End", values?: string[][])](/.body#word-javascript/api/word/-body-inserttable-member(1))|Inserts a table with the specified number of rows and columns.| -||[lists](/.body#word-javascript/api/word/-body-lists-member)|Gets the collection of list objects in the body.| -||[parentBody](/.body#word-javascript/api/word/-body-parentbody-member)|Gets the parent body of the body.| -||[parentBodyOrNullObject](/.body#word-javascript/api/word/-body-parentbodyornullobject-member)|Gets the parent body of the body.| -||[parentContentControlOrNullObject](/.body#word-javascript/api/word/-body-parentcontentcontrolornullobject-member)|Gets the content control that contains the body.| -||[parentSection](/.body#word-javascript/api/word/-body-parentsection-member)|Gets the parent section of the body.| -||[parentSectionOrNullObject](/.body#word-javascript/api/word/-body-parentsectionornullobject-member)|Gets the parent section of the body.| -||[styleBuiltIn](/.body#word-javascript/api/word/-body-stylebuiltin-member)|Specifies the built-in style name for the body.| -||[tables](/.body#word-javascript/api/word/-body-tables-member)|Gets the collection of table objects in the body.| -||[type](/.body#word-javascript/api/word/-body-type-member)|Gets the type of the body.| -|[ContentControl](/.contentcontrol)|[getRange(rangeLocation?: Word.RangeLocation \| "Whole" \| "Start" \| "End" \| "Before" \| "After" \| "Content")](/.contentcontrol#word-javascript/api/word/-contentcontrol-getrange-member(1))|Gets the whole content control, or the starting or ending point of the content control, as a range.| -||[getTextRanges(endingMarks: string[], trimSpacing?: boolean)](/.contentcontrol#word-javascript/api/word/-contentcontrol-gettextranges-member(1))|Gets the text ranges in the content control by using punctuation marks and/or other ending marks.| -||[insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.start \| Word.InsertLocation.end \| Word.InsertLocation.before \| Word.InsertLocation.after \| "Start" \| "End" \| "Before" \| "After", values?: string[][])](/.contentcontrol#word-javascript/api/word/-contentcontrol-inserttable-member(1))|Inserts a table with the specified number of rows and columns into, or next to, a content control.| -||[lists](/.contentcontrol#word-javascript/api/word/-contentcontrol-lists-member)|Gets the collection of list objects in the content control.| -||[parentBody](/.contentcontrol#word-javascript/api/word/-contentcontrol-parentbody-member)|Gets the parent body of the content control.| -||[parentContentControlOrNullObject](/.contentcontrol#word-javascript/api/word/-contentcontrol-parentcontentcontrolornullobject-member)|Gets the content control that contains the content control.| -||[parentTable](/.contentcontrol#word-javascript/api/word/-contentcontrol-parenttable-member)|Gets the table that contains the content control.| -||[parentTableCell](/.contentcontrol#word-javascript/api/word/-contentcontrol-parenttablecell-member)|Gets the table cell that contains the content control.| -||[parentTableCellOrNullObject](/.contentcontrol#word-javascript/api/word/-contentcontrol-parenttablecellornullobject-member)|Gets the table cell that contains the content control.| -||[parentTableOrNullObject](/.contentcontrol#word-javascript/api/word/-contentcontrol-parenttableornullobject-member)|Gets the table that contains the content control.| -||[split(delimiters: string[], multiParagraphs?: boolean, trimDelimiters?: boolean, trimSpacing?: boolean)](/.contentcontrol#word-javascript/api/word/-contentcontrol-split-member(1))|Splits the content control into child ranges by using delimiters.| -||[styleBuiltIn](/.contentcontrol#word-javascript/api/word/-contentcontrol-stylebuiltin-member)|Specifies the built-in style name for the content control.| -||[subtype](/.contentcontrol#word-javascript/api/word/-contentcontrol-subtype-member)|Gets the content control subtype.| -||[tables](/.contentcontrol#word-javascript/api/word/-contentcontrol-tables-member)|Gets the collection of table objects in the content control.| -|[ContentControlCollection](/.contentcontrolcollection)|[getByIdOrNullObject(id: number)](/.contentcontrolcollection#word-javascript/api/word/-contentcontrolcollection-getbyidornullobject-member(1))|Gets a content control by its identifier.| -||[getByTypes(types: Word.ContentControlType[])](/.contentcontrolcollection#word-javascript/api/word/-contentcontrolcollection-getbytypes-member(1))|Gets the content controls that have the specified types.| -||[getFirst()](/.contentcontrolcollection#word-javascript/api/word/-contentcontrolcollection-getfirst-member(1))|Gets the first content control in this collection.| -||[getFirstOrNullObject()](/.contentcontrolcollection#word-javascript/api/word/-contentcontrolcollection-getfirstornullobject-member(1))|Gets the first content control in this collection.| -|[CustomProperty](/.customproperty)|[delete()](/.customproperty#word-javascript/api/word/-customproperty-delete-member(1))|Deletes the custom property.| -||[key](/.customproperty#word-javascript/api/word/-customproperty-key-member)|Gets the key of the custom property.| -||[type](/.customproperty#word-javascript/api/word/-customproperty-type-member)|Gets the value type of the custom property.| -||[value](/.customproperty#word-javascript/api/word/-customproperty-value-member)|Specifies the value of the custom property.| -|[CustomPropertyCollection](/.custompropertycollection)|[add(key: string, value: any)](/.custompropertycollection#word-javascript/api/word/-custompropertycollection-add-member(1))|Creates a new or sets an existing custom property.| -||[deleteAll()](/.custompropertycollection#word-javascript/api/word/-custompropertycollection-deleteall-member(1))|Deletes all custom properties in this collection.| -||[getCount()](/.custompropertycollection#word-javascript/api/word/-custompropertycollection-getcount-member(1))|Gets the count of custom properties.| -||[getItem(key: string)](/.custompropertycollection#word-javascript/api/word/-custompropertycollection-getitem-member(1))|Gets a custom property object by its key, which is case-insensitive.| -||[getItemOrNullObject(key: string)](/.custompropertycollection#word-javascript/api/word/-custompropertycollection-getitemornullobject-member(1))|Gets a custom property object by its key, which is case-insensitive.| -||[items](/.custompropertycollection#word-javascript/api/word/-custompropertycollection-items-member)|Gets the loaded child items in this collection.| -|[Document](/.document)|[properties](/.document#word-javascript/api/word/-document-properties-member)|Gets the properties of the document.| -|[DocumentCreated](/.documentcreated)|[open()](/.documentcreated#word-javascript/api/word/-documentcreated-open-member(1))|Opens the document.| -|[DocumentProperties](/.documentproperties)|[applicationName](/.documentproperties#word-javascript/api/word/-documentproperties-applicationname-member)|Gets the application name of the document.| -||[author](/.documentproperties#word-javascript/api/word/-documentproperties-author-member)|Specifies the author of the document.| -||[category](/.documentproperties#word-javascript/api/word/-documentproperties-category-member)|Specifies the category of the document.| -||[comments](/.documentproperties#word-javascript/api/word/-documentproperties-comments-member)|Specifies the Comments field in the metadata of the document.| -||[company](/.documentproperties#word-javascript/api/word/-documentproperties-company-member)|Specifies the company of the document.| -||[creationDate](/.documentproperties#word-javascript/api/word/-documentproperties-creationdate-member)|Gets the creation date of the document.| -||[customProperties](/.documentproperties#word-javascript/api/word/-documentproperties-customproperties-member)|Gets the collection of custom properties of the document.| -||[format](/.documentproperties#word-javascript/api/word/-documentproperties-format-member)|Specifies the format of the document.| -||[keywords](/.documentproperties#word-javascript/api/word/-documentproperties-keywords-member)|Specifies the keywords of the document.| -||[lastAuthor](/.documentproperties#word-javascript/api/word/-documentproperties-lastauthor-member)|Gets the last author of the document.| -||[lastPrintDate](/.documentproperties#word-javascript/api/word/-documentproperties-lastprintdate-member)|Gets the last print date of the document.| -||[lastSaveTime](/.documentproperties#word-javascript/api/word/-documentproperties-lastsavetime-member)|Gets the last save time of the document.| -||[manager](/.documentproperties#word-javascript/api/word/-documentproperties-manager-member)|Specifies the manager of the document.| -||[revisionNumber](/.documentproperties#word-javascript/api/word/-documentproperties-revisionnumber-member)|Gets the revision number of the document.| -||[security](/.documentproperties#word-javascript/api/word/-documentproperties-security-member)|Gets security settings of the document.| -||[subject](/.documentproperties#word-javascript/api/word/-documentproperties-subject-member)|Specifies the subject of the document.| -||[template](/.documentproperties#word-javascript/api/word/-documentproperties-template-member)|Gets the template of the document.| -||[title](/.documentproperties#word-javascript/api/word/-documentproperties-title-member)|Specifies the title of the document.| -|[InlinePicture](/.inlinepicture)|[getNext()](/.inlinepicture#word-javascript/api/word/-inlinepicture-getnext-member(1))|Gets the next inline image.| -||[getNextOrNullObject()](/.inlinepicture#word-javascript/api/word/-inlinepicture-getnextornullobject-member(1))|Gets the next inline image.| -||[getRange(rangeLocation?: Word.RangeLocation.whole \| Word.RangeLocation.start \| Word.RangeLocation.end \| "Whole" \| "Start" \| "End")](/.inlinepicture#word-javascript/api/word/-inlinepicture-getrange-member(1))|Gets the picture, or the starting or ending point of the picture, as a range.| -||[parentContentControlOrNullObject](/.inlinepicture#word-javascript/api/word/-inlinepicture-parentcontentcontrolornullobject-member)|Gets the content control that contains the inline image.| -||[parentTable](/.inlinepicture#word-javascript/api/word/-inlinepicture-parenttable-member)|Gets the table that contains the inline image.| -||[parentTableCell](/.inlinepicture#word-javascript/api/word/-inlinepicture-parenttablecell-member)|Gets the table cell that contains the inline image.| -||[parentTableCellOrNullObject](/.inlinepicture#word-javascript/api/word/-inlinepicture-parenttablecellornullobject-member)|Gets the table cell that contains the inline image.| -||[parentTableOrNullObject](/.inlinepicture#word-javascript/api/word/-inlinepicture-parenttableornullobject-member)|Gets the table that contains the inline image.| -|[InlinePictureCollection](/.inlinepicturecollection)|[getFirst()](/.inlinepicturecollection#word-javascript/api/word/-inlinepicturecollection-getfirst-member(1))|Gets the first inline image in this collection.| -||[getFirstOrNullObject()](/.inlinepicturecollection#word-javascript/api/word/-inlinepicturecollection-getfirstornullobject-member(1))|Gets the first inline image in this collection.| -|[List](/.list)|[getLevelParagraphs(level: number)](/.list#word-javascript/api/word/-list-getlevelparagraphs-member(1))|Gets the paragraphs that occur at the specified level in the list.| -||[getLevelString(level: number)](/.list#word-javascript/api/word/-list-getlevelstring-member(1))|Gets the bullet, number, or picture at the specified level as a string.| -||[id](/.list#word-javascript/api/word/-list-id-member)|Gets the list's id.| -||[insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.start \| Word.InsertLocation.end \| Word.InsertLocation.before \| Word.InsertLocation.after \| "Start" \| "End" \| "Before" \| "After")](/.list#word-javascript/api/word/-list-insertparagraph-member(1))|Inserts a paragraph at the specified location.| -||[levelExistences](/.list#word-javascript/api/word/-list-levelexistences-member)|Checks whether each of the 9 levels exists in the list.| -||[levelTypes](/.list#word-javascript/api/word/-list-leveltypes-member)|Gets all 9 level types in the list.| -||[paragraphs](/.list#word-javascript/api/word/-list-paragraphs-member)|Gets paragraphs in the list.| -||[setLevelAlignment(level: number, alignment: Word.Alignment)](/.list#word-javascript/api/word/-list-setlevelalignment-member(1))|Sets the alignment of the bullet, number, or picture at the specified level in the list.| -||[setLevelBullet(level: number, listBullet: Word.ListBullet, charCode?: number, fontName?: string)](/.list#word-javascript/api/word/-list-setlevelbullet-member(1))|Sets the bullet format at the specified level in the list.| -||[setLevelIndents(level: number, textIndent: number, bulletNumberPictureIndent: number)](/.list#word-javascript/api/word/-list-setlevelindents-member(1))|Sets the two indents of the specified level in the list.| -||[setLevelNumbering(level: number, listNumbering: Word.ListNumbering, formatString?: Array)](/.list#word-javascript/api/word/-list-setlevelnumbering-member(1))|Sets the numbering format at the specified level in the list.| -||[setLevelStartingNumber(level: number, startingNumber: number)](/.list#word-javascript/api/word/-list-setlevelstartingnumber-member(1))|Sets the starting number at the specified level in the list.| -|[ListCollection](/.listcollection)|[getById(id: number)](/.listcollection#word-javascript/api/word/-listcollection-getbyid-member(1))|Gets a list by its identifier.| -||[getByIdOrNullObject(id: number)](/.listcollection#word-javascript/api/word/-listcollection-getbyidornullobject-member(1))|Gets a list by its identifier.| -||[getFirst()](/.listcollection#word-javascript/api/word/-listcollection-getfirst-member(1))|Gets the first list in this collection.| -||[getFirstOrNullObject()](/.listcollection#word-javascript/api/word/-listcollection-getfirstornullobject-member(1))|Gets the first list in this collection.| -||[getItem(id: number)](/.listcollection#word-javascript/api/word/-listcollection-getitem-member(1))|Gets a list object by its ID.| -||[items](/.listcollection#word-javascript/api/word/-listcollection-items-member)|Gets the loaded child items in this collection.| -|[ListItem](/.listitem)|[getAncestor(parentOnly?: boolean)](/.listitem#word-javascript/api/word/-listitem-getancestor-member(1))|Gets the list item parent, or the closest ancestor if the parent doesn't exist.| -||[getAncestorOrNullObject(parentOnly?: boolean)](/.listitem#word-javascript/api/word/-listitem-getancestorornullobject-member(1))|Gets the list item parent, or the closest ancestor if the parent doesn't exist.| -||[getDescendants(directChildrenOnly?: boolean)](/.listitem#word-javascript/api/word/-listitem-getdescendants-member(1))|Gets all descendant list items of the list item.| -||[level](/.listitem#word-javascript/api/word/-listitem-level-member)|Specifies the level of the item in the list.| -||[listString](/.listitem#word-javascript/api/word/-listitem-liststring-member)|Gets the list item bullet, number, or picture as a string.| -||[siblingIndex](/.listitem#word-javascript/api/word/-listitem-siblingindex-member)|Gets the list item order number in relation to its siblings.| -|[Paragraph](/.paragraph)|[attachToList(listId: number, level: number)](/.paragraph#word-javascript/api/word/-paragraph-attachtolist-member(1))|Lets the paragraph join an existing list at the specified level.| -||[detachFromList()](/.paragraph#word-javascript/api/word/-paragraph-detachfromlist-member(1))|Moves this paragraph out of its list, if the paragraph is a list item.| -||[getNext()](/.paragraph#word-javascript/api/word/-paragraph-getnext-member(1))|Gets the next paragraph.| -||[getNextOrNullObject()](/.paragraph#word-javascript/api/word/-paragraph-getnextornullobject-member(1))|Gets the next paragraph.| -||[getPrevious()](/.paragraph#word-javascript/api/word/-paragraph-getprevious-member(1))|Gets the previous paragraph.| -||[getPreviousOrNullObject()](/.paragraph#word-javascript/api/word/-paragraph-getpreviousornullobject-member(1))|Gets the previous paragraph.| -||[getRange(rangeLocation?: Word.RangeLocation.whole \| Word.RangeLocation.start \| Word.RangeLocation.end \| Word.RangeLocation.after \| Word.RangeLocation.content \| "Whole" \| "Start" \| "End" \| "After" \| "Content")](/.paragraph#word-javascript/api/word/-paragraph-getrange-member(1))|Gets the whole paragraph, or the starting or ending point of the paragraph, as a range.| -||[getTextRanges(endingMarks: string[], trimSpacing?: boolean)](/.paragraph#word-javascript/api/word/-paragraph-gettextranges-member(1))|Gets the text ranges in the paragraph by using punctuation marks and/or other ending marks.| -||[insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After", values?: string[][])](/.paragraph#word-javascript/api/word/-paragraph-inserttable-member(1))|Inserts a table with the specified number of rows and columns.| -||[isLastParagraph](/.paragraph#word-javascript/api/word/-paragraph-islastparagraph-member)|Indicates the paragraph is the last one inside its parent body.| -||[isListItem](/.paragraph#word-javascript/api/word/-paragraph-islistitem-member)|Checks whether the paragraph is a list item.| -||[list](/.paragraph#word-javascript/api/word/-paragraph-list-member)|Gets the List to which this paragraph belongs.| -||[listItem](/.paragraph#word-javascript/api/word/-paragraph-listitem-member)|Gets the ListItem for the paragraph.| -||[listItemOrNullObject](/.paragraph#word-javascript/api/word/-paragraph-listitemornullobject-member)|Gets the ListItem for the paragraph.| -||[listOrNullObject](/.paragraph#word-javascript/api/word/-paragraph-listornullobject-member)|Gets the List to which this paragraph belongs.| -||[parentBody](/.paragraph#word-javascript/api/word/-paragraph-parentbody-member)|Gets the parent body of the paragraph.| -||[parentContentControlOrNullObject](/.paragraph#word-javascript/api/word/-paragraph-parentcontentcontrolornullobject-member)|Gets the content control that contains the paragraph.| -||[parentTable](/.paragraph#word-javascript/api/word/-paragraph-parenttable-member)|Gets the table that contains the paragraph.| -||[parentTableCell](/.paragraph#word-javascript/api/word/-paragraph-parenttablecell-member)|Gets the table cell that contains the paragraph.| -||[parentTableCellOrNullObject](/.paragraph#word-javascript/api/word/-paragraph-parenttablecellornullobject-member)|Gets the table cell that contains the paragraph.| -||[parentTableOrNullObject](/.paragraph#word-javascript/api/word/-paragraph-parenttableornullobject-member)|Gets the table that contains the paragraph.| -||[split(delimiters: string[], trimDelimiters?: boolean, trimSpacing?: boolean)](/.paragraph#word-javascript/api/word/-paragraph-split-member(1))|Splits the paragraph into child ranges by using delimiters.| -||[startNewList()](/.paragraph#word-javascript/api/word/-paragraph-startnewlist-member(1))|Starts a new list with this paragraph.| -||[styleBuiltIn](/.paragraph#word-javascript/api/word/-paragraph-stylebuiltin-member)|Specifies the built-in style name for the paragraph.| -||[tableNestingLevel](/.paragraph#word-javascript/api/word/-paragraph-tablenestinglevel-member)|Gets the level of the paragraph's table.| -|[ParagraphCollection](/.paragraphcollection)|[getFirst()](/.paragraphcollection#word-javascript/api/word/-paragraphcollection-getfirst-member(1))|Gets the first paragraph in this collection.| -||[getFirstOrNullObject()](/.paragraphcollection#word-javascript/api/word/-paragraphcollection-getfirstornullobject-member(1))|Gets the first paragraph in this collection.| -||[getLast()](/.paragraphcollection#word-javascript/api/word/-paragraphcollection-getlast-member(1))|Gets the last paragraph in this collection.| -||[getLastOrNullObject()](/.paragraphcollection#word-javascript/api/word/-paragraphcollection-getlastornullobject-member(1))|Gets the last paragraph in this collection.| -|[Range](/.range)|[compareLocationWith(range: Word.Range)](/.range#word-javascript/api/word/-range-comparelocationwith-member(1))|Compares this range's location with another range's location.| -||[expandTo(range: Word.Range)](/.range#word-javascript/api/word/-range-expandto-member(1))|Returns a new range that extends from this range in either direction to cover another range.| -||[expandToOrNullObject(range: Word.Range)](/.range#word-javascript/api/word/-range-expandtoornullobject-member(1))|Returns a new range that extends from this range in either direction to cover another range.| -||[getHyperlinkRanges()](/.range#word-javascript/api/word/-range-gethyperlinkranges-member(1))|Gets hyperlink child ranges within the range.| -||[getNextTextRange(endingMarks: string[], trimSpacing?: boolean)](/.range#word-javascript/api/word/-range-getnexttextrange-member(1))|Gets the next text range by using punctuation marks and/or other ending marks.| -||[getNextTextRangeOrNullObject(endingMarks: string[], trimSpacing?: boolean)](/.range#word-javascript/api/word/-range-getnexttextrangeornullobject-member(1))|Gets the next text range by using punctuation marks and/or other ending marks.| -||[getRange(rangeLocation?: Word.RangeLocation.whole \| Word.RangeLocation.start \| Word.RangeLocation.end \| Word.RangeLocation.after \| Word.RangeLocation.content \| "Whole" \| "Start" \| "End" \| "After" \| "Content")](/.range#word-javascript/api/word/-range-getrange-member(1))|Clones the range, or gets the starting or ending point of the range as a new range.| -||[getTextRanges(endingMarks: string[], trimSpacing?: boolean)](/.range#word-javascript/api/word/-range-gettextranges-member(1))|Gets the text child ranges in the range by using punctuation marks and/or other ending marks.| -||[hyperlink](/.range#word-javascript/api/word/-range-hyperlink-member)|Gets the first hyperlink in the range, or sets a hyperlink on the range.| -||[insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After", values?: string[][])](/.range#word-javascript/api/word/-range-inserttable-member(1))|Inserts a table with the specified number of rows and columns.| -||[intersectWith(range: Word.Range)](/.range#word-javascript/api/word/-range-intersectwith-member(1))|Returns a new range as the intersection of this range with another range.| -||[intersectWithOrNullObject(range: Word.Range)](/.range#word-javascript/api/word/-range-intersectwithornullobject-member(1))|Returns a new range as the intersection of this range with another range.| -||[isEmpty](/.range#word-javascript/api/word/-range-isempty-member)|Checks whether the range length is zero.| -||[lists](/.range#word-javascript/api/word/-range-lists-member)|Gets the collection of list objects in the range.| -||[parentBody](/.range#word-javascript/api/word/-range-parentbody-member)|Gets the parent body of the range.| -||[parentContentControlOrNullObject](/.range#word-javascript/api/word/-range-parentcontentcontrolornullobject-member)|Gets the currently supported content control that contains the range.| -||[parentTable](/.range#word-javascript/api/word/-range-parenttable-member)|Gets the table that contains the range.| -||[parentTableCell](/.range#word-javascript/api/word/-range-parenttablecell-member)|Gets the table cell that contains the range.| -||[parentTableCellOrNullObject](/.range#word-javascript/api/word/-range-parenttablecellornullobject-member)|Gets the table cell that contains the range.| -||[parentTableOrNullObject](/.range#word-javascript/api/word/-range-parenttableornullobject-member)|Gets the table that contains the range.| -||[split(delimiters: string[], multiParagraphs?: boolean, trimDelimiters?: boolean, trimSpacing?: boolean)](/.range#word-javascript/api/word/-range-split-member(1))|Splits the range into child ranges by using delimiters.| -||[styleBuiltIn](/.range#word-javascript/api/word/-range-stylebuiltin-member)|Specifies the built-in style name for the range.| -||[tables](/.range#word-javascript/api/word/-range-tables-member)|Gets the collection of table objects in the range.| -|[RangeCollection](/.rangecollection)|[getFirst()](/.rangecollection#word-javascript/api/word/-rangecollection-getfirst-member(1))|Gets the first range in this collection.| -||[getFirstOrNullObject()](/.rangecollection#word-javascript/api/word/-rangecollection-getfirstornullobject-member(1))|Gets the first range in this collection.| -|[RequestContext](/.requestcontext)|[application](/.requestcontext#word-javascript/api/word/-requestcontext-application-member)|[Api set: WordApi 1.3] *| -|[Section](/.section)|[getNext()](/.section#word-javascript/api/word/-section-getnext-member(1))|Gets the next section.| -||[getNextOrNullObject()](/.section#word-javascript/api/word/-section-getnextornullobject-member(1))|Gets the next section.| -|[SectionCollection](/.sectioncollection)|[getFirst()](/.sectioncollection#word-javascript/api/word/-sectioncollection-getfirst-member(1))|Gets the first section in this collection.| -||[getFirstOrNullObject()](/.sectioncollection#word-javascript/api/word/-sectioncollection-getfirstornullobject-member(1))|Gets the first section in this collection.| -|[Style](/.style)||| -|[Table](/.table)|[addColumns(insertLocation: Word.InsertLocation.start \| Word.InsertLocation.end \| "Start" \| "End", columnCount: number, values?: string[][])](/.table#word-javascript/api/word/-table-addcolumns-member(1))|Adds columns to the start or end of the table, using the first or last existing column as a template.| -||[addRows(insertLocation: Word.InsertLocation.start \| Word.InsertLocation.end \| "Start" \| "End", rowCount: number, values?: string[][])](/.table#word-javascript/api/word/-table-addrows-member(1))|Adds rows to the start or end of the table, using the first or last existing row as a template.| -||[alignment](/.table#word-javascript/api/word/-table-alignment-member)|Specifies the alignment of the table against the page column.| -||[autoFitWindow()](/.table#word-javascript/api/word/-table-autofitwindow-member(1))|Autofits the table columns to the width of the window.| -||[clear()](/.table#word-javascript/api/word/-table-clear-member(1))|Clears the contents of the table.| -||[delete()](/.table#word-javascript/api/word/-table-delete-member(1))|Deletes the entire table.| -||[deleteColumns(columnIndex: number, columnCount?: number)](/.table#word-javascript/api/word/-table-deletecolumns-member(1))|Deletes specific columns.| -||[deleteRows(rowIndex: number, rowCount?: number)](/.table#word-javascript/api/word/-table-deleterows-member(1))|Deletes specific rows.| -||[distributeColumns()](/.table#word-javascript/api/word/-table-distributecolumns-member(1))|Distributes the column widths evenly.| -||[font](/.table#word-javascript/api/word/-table-font-member)|Gets the font.| -||[getBorder(borderLocation: Word.BorderLocation)](/.table#word-javascript/api/word/-table-getborder-member(1))|Gets the border style for the specified border.| -||[getCell(rowIndex: number, cellIndex: number)](/.table#word-javascript/api/word/-table-getcell-member(1))|Gets the table cell at a specified row and column.| -||[getCellOrNullObject(rowIndex: number, cellIndex: number)](/.table#word-javascript/api/word/-table-getcellornullobject-member(1))|Gets the table cell at a specified row and column.| -||[getCellPadding(cellPaddingLocation: Word.CellPaddingLocation)](/.table#word-javascript/api/word/-table-getcellpadding-member(1))|Gets cell padding in points.| -||[getNext()](/.table#word-javascript/api/word/-table-getnext-member(1))|Gets the next table.| -||[getNextOrNullObject()](/.table#word-javascript/api/word/-table-getnextornullobject-member(1))|Gets the next table.| -||[getParagraphAfter()](/.table#word-javascript/api/word/-table-getparagraphafter-member(1))|Gets the paragraph after the table.| -||[getParagraphAfterOrNullObject()](/.table#word-javascript/api/word/-table-getparagraphafterornullobject-member(1))|Gets the paragraph after the table.| -||[getParagraphBefore()](/.table#word-javascript/api/word/-table-getparagraphbefore-member(1))|Gets the paragraph before the table.| -||[getParagraphBeforeOrNullObject()](/.table#word-javascript/api/word/-table-getparagraphbeforeornullobject-member(1))|Gets the paragraph before the table.| -||[getRange(rangeLocation?: Word.RangeLocation.whole \| Word.RangeLocation.start \| Word.RangeLocation.end \| Word.RangeLocation.after \| "Whole" \| "Start" \| "End" \| "After")](/.table#word-javascript/api/word/-table-getrange-member(1))|Gets the range that contains this table, or the range at the start or end of the table.| -||[headerRowCount](/.table#word-javascript/api/word/-table-headerrowcount-member)|Specifies the number of header rows.| -||[horizontalAlignment](/.table#word-javascript/api/word/-table-horizontalalignment-member)|Specifies the horizontal alignment of every cell in the table.| -||[insertContentControl()](/.table#word-javascript/api/word/-table-insertcontentcontrol-member(1))|Inserts a content control on the table.| -||[insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After")](/.table#word-javascript/api/word/-table-insertparagraph-member(1))|Inserts a paragraph at the specified location.| -||[insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After", values?: string[][])](/.table#word-javascript/api/word/-table-inserttable-member(1))|Inserts a table with the specified number of rows and columns.| -||[isUniform](/.table#word-javascript/api/word/-table-isuniform-member)|Indicates whether all of the table rows are uniform.| -||[nestingLevel](/.table#word-javascript/api/word/-table-nestinglevel-member)|Gets the nesting level of the table.| -||[parentBody](/.table#word-javascript/api/word/-table-parentbody-member)|Gets the parent body of the table.| -||[parentContentControl](/.table#word-javascript/api/word/-table-parentcontentcontrol-member)|Gets the content control that contains the table.| -||[parentContentControlOrNullObject](/.table#word-javascript/api/word/-table-parentcontentcontrolornullobject-member)|Gets the content control that contains the table.| -||[parentTable](/.table#word-javascript/api/word/-table-parenttable-member)|Gets the table that contains this table.| -||[parentTableCell](/.table#word-javascript/api/word/-table-parenttablecell-member)|Gets the table cell that contains this table.| -||[parentTableCellOrNullObject](/.table#word-javascript/api/word/-table-parenttablecellornullobject-member)|Gets the table cell that contains this table.| -||[parentTableOrNullObject](/.table#word-javascript/api/word/-table-parenttableornullobject-member)|Gets the table that contains this table.| -||[rowCount](/.table#word-javascript/api/word/-table-rowcount-member)|Gets the number of rows in the table.| -||[rows](/.table#word-javascript/api/word/-table-rows-member)|Gets all of the table rows.| -||[search(searchText: string, searchOptions?: Word.SearchOptions \| { ignorePunct?: boolean ignoreSpace?: boolean matchCase?: boolean matchPrefix?: boolean matchSuffix?: boolean matchWholeWord?: boolean matchWildcards?: boolean })](/.table#word-javascript/api/word/-table-search-member(1))|Performs a search with the specified SearchOptions on the scope of the table object.| -||[select(selectionMode?: Word.SelectionMode)](/.table#word-javascript/api/word/-table-select-member(1))|Selects the table, or the position at the start or end of the table, and navigates the Word UI to it.| -||[setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number)](/.table#word-javascript/api/word/-table-setcellpadding-member(1))|Sets cell padding in points.| -||[shadingColor](/.table#word-javascript/api/word/-table-shadingcolor-member)|Specifies the shading color.| -||[style](/.table#word-javascript/api/word/-table-style-member)|Specifies the style name for the table.| -||[styleBandedColumns](/.table#word-javascript/api/word/-table-stylebandedcolumns-member)|Specifies whether the table has banded columns.| -||[styleBandedRows](/.table#word-javascript/api/word/-table-stylebandedrows-member)|Specifies whether the table has banded rows.| -||[styleBuiltIn](/.table#word-javascript/api/word/-table-stylebuiltin-member)|Specifies the built-in style name for the table.| -||[styleFirstColumn](/.table#word-javascript/api/word/-table-stylefirstcolumn-member)|Specifies whether the table has a first column with a special style.| -||[styleLastColumn](/.table#word-javascript/api/word/-table-stylelastcolumn-member)|Specifies whether the table has a last column with a special style.| -||[styleTotalRow](/.table#word-javascript/api/word/-table-styletotalrow-member)|Specifies whether the table has a total (last) row with a special style.| -||[tables](/.table#word-javascript/api/word/-table-tables-member)|Gets the child tables nested one level deeper.| -||[values](/.table#word-javascript/api/word/-table-values-member)|Specifies the text values in the table, as a 2D JavaScript array.| -||[verticalAlignment](/.table#word-javascript/api/word/-table-verticalalignment-member)|Specifies the vertical alignment of every cell in the table.| -||[width](/.table#word-javascript/api/word/-table-width-member)|Specifies the width of the table in points.| -|[TableBorder](/.tableborder)|[color](/.tableborder#word-javascript/api/word/-tableborder-color-member)|Specifies the table border color.| -||[type](/.tableborder#word-javascript/api/word/-tableborder-type-member)|Specifies the type of the table border.| -||[width](/.tableborder#word-javascript/api/word/-tableborder-width-member)|Specifies the width, in points, of the table border.| -|[TableCell](/.tablecell)|[body](/.tablecell#word-javascript/api/word/-tablecell-body-member)|Gets the body object of the cell.| -||[cellIndex](/.tablecell#word-javascript/api/word/-tablecell-cellindex-member)|Gets the index of the cell in its row.| -||[columnWidth](/.tablecell#word-javascript/api/word/-tablecell-columnwidth-member)|Specifies the width of the cell's column in points.| -||[deleteColumn()](/.tablecell#word-javascript/api/word/-tablecell-deletecolumn-member(1))|Deletes the column containing this cell.| -||[deleteRow()](/.tablecell#word-javascript/api/word/-tablecell-deleterow-member(1))|Deletes the row containing this cell.| -||[getBorder(borderLocation: Word.BorderLocation)](/.tablecell#word-javascript/api/word/-tablecell-getborder-member(1))|Gets the border style for the specified border.| -||[getCellPadding(cellPaddingLocation: Word.CellPaddingLocation)](/.tablecell#word-javascript/api/word/-tablecell-getcellpadding-member(1))|Gets cell padding in points.| -||[getNext()](/.tablecell#word-javascript/api/word/-tablecell-getnext-member(1))|Gets the next cell.| -||[getNextOrNullObject()](/.tablecell#word-javascript/api/word/-tablecell-getnextornullobject-member(1))|Gets the next cell.| -||[horizontalAlignment](/.tablecell#word-javascript/api/word/-tablecell-horizontalalignment-member)|Specifies the horizontal alignment of the cell.| -||[insertColumns(insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After", columnCount: number, values?: string[][])](/.tablecell#word-javascript/api/word/-tablecell-insertcolumns-member(1))|Adds columns to the left or right of the cell, using the cell's column as a template.| -||[insertRows(insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After", rowCount: number, values?: string[][])](/.tablecell#word-javascript/api/word/-tablecell-insertrows-member(1))|Inserts rows above or below the cell, using the cell's row as a template.| -||[parentRow](/.tablecell#word-javascript/api/word/-tablecell-parentrow-member)|Gets the parent row of the cell.| -||[parentTable](/.tablecell#word-javascript/api/word/-tablecell-parenttable-member)|Gets the parent table of the cell.| -||[rowIndex](/.tablecell#word-javascript/api/word/-tablecell-rowindex-member)|Gets the index of the cell's row in the table.| -||[setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number)](/.tablecell#word-javascript/api/word/-tablecell-setcellpadding-member(1))|Sets cell padding in points.| -||[shadingColor](/.tablecell#word-javascript/api/word/-tablecell-shadingcolor-member)|Specifies the shading color of the cell.| -||[value](/.tablecell#word-javascript/api/word/-tablecell-value-member)|Specifies the text of the cell.| -||[verticalAlignment](/.tablecell#word-javascript/api/word/-tablecell-verticalalignment-member)|Specifies the vertical alignment of the cell.| -||[width](/.tablecell#word-javascript/api/word/-tablecell-width-member)|Gets the width of the cell in points.| -|[TableCellCollection](/.tablecellcollection)|[getFirst()](/.tablecellcollection#word-javascript/api/word/-tablecellcollection-getfirst-member(1))|Gets the first table cell in this collection.| -||[getFirstOrNullObject()](/.tablecellcollection#word-javascript/api/word/-tablecellcollection-getfirstornullobject-member(1))|Gets the first table cell in this collection.| -||[items](/.tablecellcollection#word-javascript/api/word/-tablecellcollection-items-member)|Gets the loaded child items in this collection.| -|[TableCollection](/.tablecollection)|[getFirst()](/.tablecollection#word-javascript/api/word/-tablecollection-getfirst-member(1))|Gets the first table in this collection.| -||[getFirstOrNullObject()](/.tablecollection#word-javascript/api/word/-tablecollection-getfirstornullobject-member(1))|Gets the first table in this collection.| -||[items](/.tablecollection#word-javascript/api/word/-tablecollection-items-member)|Gets the loaded child items in this collection.| -|[TableRow](/.tablerow)|[cellCount](/.tablerow#word-javascript/api/word/-tablerow-cellcount-member)|Gets the number of cells in the row.| -||[cells](/.tablerow#word-javascript/api/word/-tablerow-cells-member)|Gets cells.| -||[clear()](/.tablerow#word-javascript/api/word/-tablerow-clear-member(1))|Clears the contents of the row.| -||[delete()](/.tablerow#word-javascript/api/word/-tablerow-delete-member(1))|Deletes the entire row.| -||[font](/.tablerow#word-javascript/api/word/-tablerow-font-member)|Gets the font.| -||[getBorder(borderLocation: Word.BorderLocation)](/.tablerow#word-javascript/api/word/-tablerow-getborder-member(1))|Gets the border style of the cells in the row.| -||[getCellPadding(cellPaddingLocation: Word.CellPaddingLocation)](/.tablerow#word-javascript/api/word/-tablerow-getcellpadding-member(1))|Gets cell padding in points.| -||[getNext()](/.tablerow#word-javascript/api/word/-tablerow-getnext-member(1))|Gets the next row.| -||[getNextOrNullObject()](/.tablerow#word-javascript/api/word/-tablerow-getnextornullobject-member(1))|Gets the next row.| -||[horizontalAlignment](/.tablerow#word-javascript/api/word/-tablerow-horizontalalignment-member)|Specifies the horizontal alignment of every cell in the row.| -||[insertRows(insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After", rowCount: number, values?: string[][])](/.tablerow#word-javascript/api/word/-tablerow-insertrows-member(1))|Inserts rows using this row as a template.| -||[isHeader](/.tablerow#word-javascript/api/word/-tablerow-isheader-member)|Checks whether the row is a header row.| -||[parentTable](/.tablerow#word-javascript/api/word/-tablerow-parenttable-member)|Gets parent table.| -||[preferredHeight](/.tablerow#word-javascript/api/word/-tablerow-preferredheight-member)|Specifies the preferred height of the row in points.| -||[rowIndex](/.tablerow#word-javascript/api/word/-tablerow-rowindex-member)|Gets the index of the row in its parent table.| -||[search(searchText: string, searchOptions?: Word.SearchOptions \| { ignorePunct?: boolean ignoreSpace?: boolean matchCase?: boolean matchPrefix?: boolean matchSuffix?: boolean matchWholeWord?: boolean matchWildcards?: boolean })](/.tablerow#word-javascript/api/word/-tablerow-search-member(1))|Performs a search with the specified SearchOptions on the scope of the row.| -||[select(selectionMode?: Word.SelectionMode)](/.tablerow#word-javascript/api/word/-tablerow-select-member(1))|Selects the row and navigates the Word UI to it.| -||[setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number)](/.tablerow#word-javascript/api/word/-tablerow-setcellpadding-member(1))|Sets cell padding in points.| -||[shadingColor](/.tablerow#word-javascript/api/word/-tablerow-shadingcolor-member)|Specifies the shading color.| -||[values](/.tablerow#word-javascript/api/word/-tablerow-values-member)|Specifies the text values in the row, as a 2D JavaScript array.| -||[verticalAlignment](/.tablerow#word-javascript/api/word/-tablerow-verticalalignment-member)|Specifies the vertical alignment of the cells in the row.| -|[TableRowCollection](/.tablerowcollection)|[getFirst()](/.tablerowcollection#word-javascript/api/word/-tablerowcollection-getfirst-member(1))|Gets the first row in this collection.| -||[getFirstOrNullObject()](/.tablerowcollection#word-javascript/api/word/-tablerowcollection-getfirstornullobject-member(1))|Gets the first row in this collection.| -||[items](/.tablerowcollection#word-javascript/api/word/-tablerowcollection-items-member)|Gets the loaded child items in this collection.| +|[Application](/javascript/api/word/word.application)|[createDocument(base64File?: string)](/javascript/api/word/word.application#word-word-application-createdocument-member(1))|Creates a new document by using an optional Base64-encoded .docx file.| +|[Body](/javascript/api/word/word.body)|[getRange(rangeLocation?: Word.RangeLocation.whole \| Word.RangeLocation.start \| Word.RangeLocation.end \| Word.RangeLocation.after \| Word.RangeLocation.content \| "Whole" \| "Start" \| "End" \| "After" \| "Content")](/javascript/api/word/word.body#word-word-body-getrange-member(1))|Gets the whole body, or the starting or ending point of the body, as a range.| +||[insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.start \| Word.InsertLocation.end \| "Start" \| "End", values?: string[][])](/javascript/api/word/word.body#word-word-body-inserttable-member(1))|Inserts a table with the specified number of rows and columns.| +||[lists](/javascript/api/word/word.body#word-word-body-lists-member)|Gets the collection of list objects in the body.| +||[parentBody](/javascript/api/word/word.body#word-word-body-parentbody-member)|Gets the parent body of the body.| +||[parentBodyOrNullObject](/javascript/api/word/word.body#word-word-body-parentbodyornullobject-member)|Gets the parent body of the body.| +||[parentContentControlOrNullObject](/javascript/api/word/word.body#word-word-body-parentcontentcontrolornullobject-member)|Gets the content control that contains the body.| +||[parentSection](/javascript/api/word/word.body#word-word-body-parentsection-member)|Gets the parent section of the body.| +||[parentSectionOrNullObject](/javascript/api/word/word.body#word-word-body-parentsectionornullobject-member)|Gets the parent section of the body.| +||[styleBuiltIn](/javascript/api/word/word.body#word-word-body-stylebuiltin-member)|Specifies the built-in style name for the body.| +||[tables](/javascript/api/word/word.body#word-word-body-tables-member)|Gets the collection of table objects in the body.| +||[type](/javascript/api/word/word.body#word-word-body-type-member)|Gets the type of the body.| +|[ContentControl](/javascript/api/word/word.contentcontrol)|[getRange(rangeLocation?: Word.RangeLocation \| "Whole" \| "Start" \| "End" \| "Before" \| "After" \| "Content")](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-getrange-member(1))|Gets the whole content control, or the starting or ending point of the content control, as a range.| +||[getTextRanges(endingMarks: string[], trimSpacing?: boolean)](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-gettextranges-member(1))|Gets the text ranges in the content control by using punctuation marks and/or other ending marks.| +||[insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.start \| Word.InsertLocation.end \| Word.InsertLocation.before \| Word.InsertLocation.after \| "Start" \| "End" \| "Before" \| "After", values?: string[][])](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-inserttable-member(1))|Inserts a table with the specified number of rows and columns into, or next to, a content control.| +||[lists](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-lists-member)|Gets the collection of list objects in the content control.| +||[parentBody](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-parentbody-member)|Gets the parent body of the content control.| +||[parentContentControlOrNullObject](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-parentcontentcontrolornullobject-member)|Gets the content control that contains the content control.| +||[parentTable](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-parenttable-member)|Gets the table that contains the content control.| +||[parentTableCell](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-parenttablecell-member)|Gets the table cell that contains the content control.| +||[parentTableCellOrNullObject](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-parenttablecellornullobject-member)|Gets the table cell that contains the content control.| +||[parentTableOrNullObject](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-parenttableornullobject-member)|Gets the table that contains the content control.| +||[split(delimiters: string[], multiParagraphs?: boolean, trimDelimiters?: boolean, trimSpacing?: boolean)](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-split-member(1))|Splits the content control into child ranges by using delimiters.| +||[styleBuiltIn](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-stylebuiltin-member)|Specifies the built-in style name for the content control.| +||[subtype](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-subtype-member)|Gets the content control subtype.| +||[tables](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-tables-member)|Gets the collection of table objects in the content control.| +|[ContentControlCollection](/javascript/api/word/word.contentcontrolcollection)|[getByIdOrNullObject(id: number)](/javascript/api/word/word.contentcontrolcollection#word-word-contentcontrolcollection-getbyidornullobject-member(1))|Gets a content control by its identifier.| +||[getByTypes(types: Word.ContentControlType[])](/javascript/api/word/word.contentcontrolcollection#word-word-contentcontrolcollection-getbytypes-member(1))|Gets the content controls that have the specified types.| +||[getFirst()](/javascript/api/word/word.contentcontrolcollection#word-word-contentcontrolcollection-getfirst-member(1))|Gets the first content control in this collection.| +||[getFirstOrNullObject()](/javascript/api/word/word.contentcontrolcollection#word-word-contentcontrolcollection-getfirstornullobject-member(1))|Gets the first content control in this collection.| +|[CustomProperty](/javascript/api/word/word.customproperty)|[delete()](/javascript/api/word/word.customproperty#word-word-customproperty-delete-member(1))|Deletes the custom property.| +||[key](/javascript/api/word/word.customproperty#word-word-customproperty-key-member)|Gets the key of the custom property.| +||[type](/javascript/api/word/word.customproperty#word-word-customproperty-type-member)|Gets the value type of the custom property.| +||[value](/javascript/api/word/word.customproperty#word-word-customproperty-value-member)|Specifies the value of the custom property.| +|[CustomPropertyCollection](/javascript/api/word/word.custompropertycollection)|[add(key: string, value: any)](/javascript/api/word/word.custompropertycollection#word-word-custompropertycollection-add-member(1))|Creates a new or sets an existing custom property.| +||[deleteAll()](/javascript/api/word/word.custompropertycollection#word-word-custompropertycollection-deleteall-member(1))|Deletes all custom properties in this collection.| +||[getCount()](/javascript/api/word/word.custompropertycollection#word-word-custompropertycollection-getcount-member(1))|Gets the count of custom properties.| +||[getItem(key: string)](/javascript/api/word/word.custompropertycollection#word-word-custompropertycollection-getitem-member(1))|Gets a custom property object by its key, which is case-insensitive.| +||[getItemOrNullObject(key: string)](/javascript/api/word/word.custompropertycollection#word-word-custompropertycollection-getitemornullobject-member(1))|Gets a custom property object by its key, which is case-insensitive.| +||[items](/javascript/api/word/word.custompropertycollection#word-word-custompropertycollection-items-member)|Gets the loaded child items in this collection.| +|[Document](/javascript/api/word/word.document)|[properties](/javascript/api/word/word.document#word-word-document-properties-member)|Gets the properties of the document.| +|[DocumentCreated](/javascript/api/word/word.documentcreated)|[open()](/javascript/api/word/word.documentcreated#word-word-documentcreated-open-member(1))|Opens the document.| +|[DocumentProperties](/javascript/api/word/word.documentproperties)|[applicationName](/javascript/api/word/word.documentproperties#word-word-documentproperties-applicationname-member)|Gets the application name of the document.| +||[author](/javascript/api/word/word.documentproperties#word-word-documentproperties-author-member)|Specifies the author of the document.| +||[category](/javascript/api/word/word.documentproperties#word-word-documentproperties-category-member)|Specifies the category of the document.| +||[comments](/javascript/api/word/word.documentproperties#word-word-documentproperties-comments-member)|Specifies the Comments field in the metadata of the document.| +||[company](/javascript/api/word/word.documentproperties#word-word-documentproperties-company-member)|Specifies the company of the document.| +||[creationDate](/javascript/api/word/word.documentproperties#word-word-documentproperties-creationdate-member)|Gets the creation date of the document.| +||[customProperties](/javascript/api/word/word.documentproperties#word-word-documentproperties-customproperties-member)|Gets the collection of custom properties of the document.| +||[format](/javascript/api/word/word.documentproperties#word-word-documentproperties-format-member)|Specifies the format of the document.| +||[keywords](/javascript/api/word/word.documentproperties#word-word-documentproperties-keywords-member)|Specifies the keywords of the document.| +||[lastAuthor](/javascript/api/word/word.documentproperties#word-word-documentproperties-lastauthor-member)|Gets the last author of the document.| +||[lastPrintDate](/javascript/api/word/word.documentproperties#word-word-documentproperties-lastprintdate-member)|Gets the last print date of the document.| +||[lastSaveTime](/javascript/api/word/word.documentproperties#word-word-documentproperties-lastsavetime-member)|Gets the last save time of the document.| +||[manager](/javascript/api/word/word.documentproperties#word-word-documentproperties-manager-member)|Specifies the manager of the document.| +||[revisionNumber](/javascript/api/word/word.documentproperties#word-word-documentproperties-revisionnumber-member)|Gets the revision number of the document.| +||[security](/javascript/api/word/word.documentproperties#word-word-documentproperties-security-member)|Gets security settings of the document.| +||[subject](/javascript/api/word/word.documentproperties#word-word-documentproperties-subject-member)|Specifies the subject of the document.| +||[template](/javascript/api/word/word.documentproperties#word-word-documentproperties-template-member)|Gets the template of the document.| +||[title](/javascript/api/word/word.documentproperties#word-word-documentproperties-title-member)|Specifies the title of the document.| +|[InlinePicture](/javascript/api/word/word.inlinepicture)|[getNext()](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-getnext-member(1))|Gets the next inline image.| +||[getNextOrNullObject()](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-getnextornullobject-member(1))|Gets the next inline image.| +||[getRange(rangeLocation?: Word.RangeLocation.whole \| Word.RangeLocation.start \| Word.RangeLocation.end \| "Whole" \| "Start" \| "End")](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-getrange-member(1))|Gets the picture, or the starting or ending point of the picture, as a range.| +||[parentContentControlOrNullObject](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-parentcontentcontrolornullobject-member)|Gets the content control that contains the inline image.| +||[parentTable](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-parenttable-member)|Gets the table that contains the inline image.| +||[parentTableCell](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-parenttablecell-member)|Gets the table cell that contains the inline image.| +||[parentTableCellOrNullObject](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-parenttablecellornullobject-member)|Gets the table cell that contains the inline image.| +||[parentTableOrNullObject](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-parenttableornullobject-member)|Gets the table that contains the inline image.| +|[InlinePictureCollection](/javascript/api/word/word.inlinepicturecollection)|[getFirst()](/javascript/api/word/word.inlinepicturecollection#word-word-inlinepicturecollection-getfirst-member(1))|Gets the first inline image in this collection.| +||[getFirstOrNullObject()](/javascript/api/word/word.inlinepicturecollection#word-word-inlinepicturecollection-getfirstornullobject-member(1))|Gets the first inline image in this collection.| +|[List](/javascript/api/word/word.list)|[getLevelParagraphs(level: number)](/javascript/api/word/word.list#word-word-list-getlevelparagraphs-member(1))|Gets the paragraphs that occur at the specified level in the list.| +||[getLevelString(level: number)](/javascript/api/word/word.list#word-word-list-getlevelstring-member(1))|Gets the bullet, number, or picture at the specified level as a string.| +||[id](/javascript/api/word/word.list#word-word-list-id-member)|Gets the list's id.| +||[insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.start \| Word.InsertLocation.end \| Word.InsertLocation.before \| Word.InsertLocation.after \| "Start" \| "End" \| "Before" \| "After")](/javascript/api/word/word.list#word-word-list-insertparagraph-member(1))|Inserts a paragraph at the specified location.| +||[levelExistences](/javascript/api/word/word.list#word-word-list-levelexistences-member)|Checks whether each of the 9 levels exists in the list.| +||[levelTypes](/javascript/api/word/word.list#word-word-list-leveltypes-member)|Gets all 9 level types in the list.| +||[paragraphs](/javascript/api/word/word.list#word-word-list-paragraphs-member)|Gets paragraphs in the list.| +||[setLevelAlignment(level: number, alignment: Word.Alignment)](/javascript/api/word/word.list#word-word-list-setlevelalignment-member(1))|Sets the alignment of the bullet, number, or picture at the specified level in the list.| +||[setLevelBullet(level: number, listBullet: Word.ListBullet, charCode?: number, fontName?: string)](/javascript/api/word/word.list#word-word-list-setlevelbullet-member(1))|Sets the bullet format at the specified level in the list.| +||[setLevelIndents(level: number, textIndent: number, bulletNumberPictureIndent: number)](/javascript/api/word/word.list#word-word-list-setlevelindents-member(1))|Sets the two indents of the specified level in the list.| +||[setLevelNumbering(level: number, listNumbering: Word.ListNumbering, formatString?: Array)](/javascript/api/word/word.list#word-word-list-setlevelnumbering-member(1))|Sets the numbering format at the specified level in the list.| +||[setLevelStartingNumber(level: number, startingNumber: number)](/javascript/api/word/word.list#word-word-list-setlevelstartingnumber-member(1))|Sets the starting number at the specified level in the list.| +|[ListCollection](/javascript/api/word/word.listcollection)|[getById(id: number)](/javascript/api/word/word.listcollection#word-word-listcollection-getbyid-member(1))|Gets a list by its identifier.| +||[getByIdOrNullObject(id: number)](/javascript/api/word/word.listcollection#word-word-listcollection-getbyidornullobject-member(1))|Gets a list by its identifier.| +||[getFirst()](/javascript/api/word/word.listcollection#word-word-listcollection-getfirst-member(1))|Gets the first list in this collection.| +||[getFirstOrNullObject()](/javascript/api/word/word.listcollection#word-word-listcollection-getfirstornullobject-member(1))|Gets the first list in this collection.| +||[getItem(id: number)](/javascript/api/word/word.listcollection#word-word-listcollection-getitem-member(1))|Gets a list object by its ID.| +||[items](/javascript/api/word/word.listcollection#word-word-listcollection-items-member)|Gets the loaded child items in this collection.| +|[ListItem](/javascript/api/word/word.listitem)|[getAncestor(parentOnly?: boolean)](/javascript/api/word/word.listitem#word-word-listitem-getancestor-member(1))|Gets the list item parent, or the closest ancestor if the parent doesn't exist.| +||[getAncestorOrNullObject(parentOnly?: boolean)](/javascript/api/word/word.listitem#word-word-listitem-getancestorornullobject-member(1))|Gets the list item parent, or the closest ancestor if the parent doesn't exist.| +||[getDescendants(directChildrenOnly?: boolean)](/javascript/api/word/word.listitem#word-word-listitem-getdescendants-member(1))|Gets all descendant list items of the list item.| +||[level](/javascript/api/word/word.listitem#word-word-listitem-level-member)|Specifies the level of the item in the list.| +||[listString](/javascript/api/word/word.listitem#word-word-listitem-liststring-member)|Gets the list item bullet, number, or picture as a string.| +||[siblingIndex](/javascript/api/word/word.listitem#word-word-listitem-siblingindex-member)|Gets the list item order number in relation to its siblings.| +|[Paragraph](/javascript/api/word/word.paragraph)|[attachToList(listId: number, level: number)](/javascript/api/word/word.paragraph#word-word-paragraph-attachtolist-member(1))|Lets the paragraph join an existing list at the specified level.| +||[detachFromList()](/javascript/api/word/word.paragraph#word-word-paragraph-detachfromlist-member(1))|Moves this paragraph out of its list, if the paragraph is a list item.| +||[getNext()](/javascript/api/word/word.paragraph#word-word-paragraph-getnext-member(1))|Gets the next paragraph.| +||[getNextOrNullObject()](/javascript/api/word/word.paragraph#word-word-paragraph-getnextornullobject-member(1))|Gets the next paragraph.| +||[getPrevious()](/javascript/api/word/word.paragraph#word-word-paragraph-getprevious-member(1))|Gets the previous paragraph.| +||[getPreviousOrNullObject()](/javascript/api/word/word.paragraph#word-word-paragraph-getpreviousornullobject-member(1))|Gets the previous paragraph.| +||[getRange(rangeLocation?: Word.RangeLocation.whole \| Word.RangeLocation.start \| Word.RangeLocation.end \| Word.RangeLocation.after \| Word.RangeLocation.content \| "Whole" \| "Start" \| "End" \| "After" \| "Content")](/javascript/api/word/word.paragraph#word-word-paragraph-getrange-member(1))|Gets the whole paragraph, or the starting or ending point of the paragraph, as a range.| +||[getTextRanges(endingMarks: string[], trimSpacing?: boolean)](/javascript/api/word/word.paragraph#word-word-paragraph-gettextranges-member(1))|Gets the text ranges in the paragraph by using punctuation marks and/or other ending marks.| +||[insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After", values?: string[][])](/javascript/api/word/word.paragraph#word-word-paragraph-inserttable-member(1))|Inserts a table with the specified number of rows and columns.| +||[isLastParagraph](/javascript/api/word/word.paragraph#word-word-paragraph-islastparagraph-member)|Indicates the paragraph is the last one inside its parent body.| +||[isListItem](/javascript/api/word/word.paragraph#word-word-paragraph-islistitem-member)|Checks whether the paragraph is a list item.| +||[list](/javascript/api/word/word.paragraph#word-word-paragraph-list-member)|Gets the List to which this paragraph belongs.| +||[listItem](/javascript/api/word/word.paragraph#word-word-paragraph-listitem-member)|Gets the ListItem for the paragraph.| +||[listItemOrNullObject](/javascript/api/word/word.paragraph#word-word-paragraph-listitemornullobject-member)|Gets the ListItem for the paragraph.| +||[listOrNullObject](/javascript/api/word/word.paragraph#word-word-paragraph-listornullobject-member)|Gets the List to which this paragraph belongs.| +||[parentBody](/javascript/api/word/word.paragraph#word-word-paragraph-parentbody-member)|Gets the parent body of the paragraph.| +||[parentContentControlOrNullObject](/javascript/api/word/word.paragraph#word-word-paragraph-parentcontentcontrolornullobject-member)|Gets the content control that contains the paragraph.| +||[parentTable](/javascript/api/word/word.paragraph#word-word-paragraph-parenttable-member)|Gets the table that contains the paragraph.| +||[parentTableCell](/javascript/api/word/word.paragraph#word-word-paragraph-parenttablecell-member)|Gets the table cell that contains the paragraph.| +||[parentTableCellOrNullObject](/javascript/api/word/word.paragraph#word-word-paragraph-parenttablecellornullobject-member)|Gets the table cell that contains the paragraph.| +||[parentTableOrNullObject](/javascript/api/word/word.paragraph#word-word-paragraph-parenttableornullobject-member)|Gets the table that contains the paragraph.| +||[split(delimiters: string[], trimDelimiters?: boolean, trimSpacing?: boolean)](/javascript/api/word/word.paragraph#word-word-paragraph-split-member(1))|Splits the paragraph into child ranges by using delimiters.| +||[startNewList()](/javascript/api/word/word.paragraph#word-word-paragraph-startnewlist-member(1))|Starts a new list with this paragraph.| +||[styleBuiltIn](/javascript/api/word/word.paragraph#word-word-paragraph-stylebuiltin-member)|Specifies the built-in style name for the paragraph.| +||[tableNestingLevel](/javascript/api/word/word.paragraph#word-word-paragraph-tablenestinglevel-member)|Gets the level of the paragraph's table.| +|[ParagraphCollection](/javascript/api/word/word.paragraphcollection)|[getFirst()](/javascript/api/word/word.paragraphcollection#word-word-paragraphcollection-getfirst-member(1))|Gets the first paragraph in this collection.| +||[getFirstOrNullObject()](/javascript/api/word/word.paragraphcollection#word-word-paragraphcollection-getfirstornullobject-member(1))|Gets the first paragraph in this collection.| +||[getLast()](/javascript/api/word/word.paragraphcollection#word-word-paragraphcollection-getlast-member(1))|Gets the last paragraph in this collection.| +||[getLastOrNullObject()](/javascript/api/word/word.paragraphcollection#word-word-paragraphcollection-getlastornullobject-member(1))|Gets the last paragraph in this collection.| +|[Range](/javascript/api/word/word.range)|[compareLocationWith(range: Word.Range)](/javascript/api/word/word.range#word-word-range-comparelocationwith-member(1))|Compares this range's location with another range's location.| +||[expandTo(range: Word.Range)](/javascript/api/word/word.range#word-word-range-expandto-member(1))|Returns a new range that extends from this range in either direction to cover another range.| +||[expandToOrNullObject(range: Word.Range)](/javascript/api/word/word.range#word-word-range-expandtoornullobject-member(1))|Returns a new range that extends from this range in either direction to cover another range.| +||[getHyperlinkRanges()](/javascript/api/word/word.range#word-word-range-gethyperlinkranges-member(1))|Gets hyperlink child ranges within the range.| +||[getNextTextRange(endingMarks: string[], trimSpacing?: boolean)](/javascript/api/word/word.range#word-word-range-getnexttextrange-member(1))|Gets the next text range by using punctuation marks and/or other ending marks.| +||[getNextTextRangeOrNullObject(endingMarks: string[], trimSpacing?: boolean)](/javascript/api/word/word.range#word-word-range-getnexttextrangeornullobject-member(1))|Gets the next text range by using punctuation marks and/or other ending marks.| +||[getRange(rangeLocation?: Word.RangeLocation.whole \| Word.RangeLocation.start \| Word.RangeLocation.end \| Word.RangeLocation.after \| Word.RangeLocation.content \| "Whole" \| "Start" \| "End" \| "After" \| "Content")](/javascript/api/word/word.range#word-word-range-getrange-member(1))|Clones the range, or gets the starting or ending point of the range as a new range.| +||[getTextRanges(endingMarks: string[], trimSpacing?: boolean)](/javascript/api/word/word.range#word-word-range-gettextranges-member(1))|Gets the text child ranges in the range by using punctuation marks and/or other ending marks.| +||[hyperlink](/javascript/api/word/word.range#word-word-range-hyperlink-member)|Gets the first hyperlink in the range, or sets a hyperlink on the range.| +||[insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After", values?: string[][])](/javascript/api/word/word.range#word-word-range-inserttable-member(1))|Inserts a table with the specified number of rows and columns.| +||[intersectWith(range: Word.Range)](/javascript/api/word/word.range#word-word-range-intersectwith-member(1))|Returns a new range as the intersection of this range with another range.| +||[intersectWithOrNullObject(range: Word.Range)](/javascript/api/word/word.range#word-word-range-intersectwithornullobject-member(1))|Returns a new range as the intersection of this range with another range.| +||[isEmpty](/javascript/api/word/word.range#word-word-range-isempty-member)|Checks whether the range length is zero.| +||[lists](/javascript/api/word/word.range#word-word-range-lists-member)|Gets the collection of list objects in the range.| +||[parentBody](/javascript/api/word/word.range#word-word-range-parentbody-member)|Gets the parent body of the range.| +||[parentContentControlOrNullObject](/javascript/api/word/word.range#word-word-range-parentcontentcontrolornullobject-member)|Gets the currently supported content control that contains the range.| +||[parentTable](/javascript/api/word/word.range#word-word-range-parenttable-member)|Gets the table that contains the range.| +||[parentTableCell](/javascript/api/word/word.range#word-word-range-parenttablecell-member)|Gets the table cell that contains the range.| +||[parentTableCellOrNullObject](/javascript/api/word/word.range#word-word-range-parenttablecellornullobject-member)|Gets the table cell that contains the range.| +||[parentTableOrNullObject](/javascript/api/word/word.range#word-word-range-parenttableornullobject-member)|Gets the table that contains the range.| +||[split(delimiters: string[], multiParagraphs?: boolean, trimDelimiters?: boolean, trimSpacing?: boolean)](/javascript/api/word/word.range#word-word-range-split-member(1))|Splits the range into child ranges by using delimiters.| +||[styleBuiltIn](/javascript/api/word/word.range#word-word-range-stylebuiltin-member)|Specifies the built-in style name for the range.| +||[tables](/javascript/api/word/word.range#word-word-range-tables-member)|Gets the collection of table objects in the range.| +|[RangeCollection](/javascript/api/word/word.rangecollection)|[getFirst()](/javascript/api/word/word.rangecollection#word-word-rangecollection-getfirst-member(1))|Gets the first range in this collection.| +||[getFirstOrNullObject()](/javascript/api/word/word.rangecollection#word-word-rangecollection-getfirstornullobject-member(1))|Gets the first range in this collection.| +|[RequestContext](/javascript/api/word/word.requestcontext)|[application](/javascript/api/word/word.requestcontext#word-word-requestcontext-application-member)|[Api set: WordApi 1.3] *| +|[Section](/javascript/api/word/word.section)|[getNext()](/javascript/api/word/word.section#word-word-section-getnext-member(1))|Gets the next section.| +||[getNextOrNullObject()](/javascript/api/word/word.section#word-word-section-getnextornullobject-member(1))|Gets the next section.| +|[SectionCollection](/javascript/api/word/word.sectioncollection)|[getFirst()](/javascript/api/word/word.sectioncollection#word-word-sectioncollection-getfirst-member(1))|Gets the first section in this collection.| +||[getFirstOrNullObject()](/javascript/api/word/word.sectioncollection#word-word-sectioncollection-getfirstornullobject-member(1))|Gets the first section in this collection.| +|[Style](/javascript/api/word/word.style)||| +|[Table](/javascript/api/word/word.table)|[addColumns(insertLocation: Word.InsertLocation.start \| Word.InsertLocation.end \| "Start" \| "End", columnCount: number, values?: string[][])](/javascript/api/word/word.table#word-word-table-addcolumns-member(1))|Adds columns to the start or end of the table, using the first or last existing column as a template.| +||[addRows(insertLocation: Word.InsertLocation.start \| Word.InsertLocation.end \| "Start" \| "End", rowCount: number, values?: string[][])](/javascript/api/word/word.table#word-word-table-addrows-member(1))|Adds rows to the start or end of the table, using the first or last existing row as a template.| +||[alignment](/javascript/api/word/word.table#word-word-table-alignment-member)|Specifies the alignment of the table against the page column.| +||[autoFitWindow()](/javascript/api/word/word.table#word-word-table-autofitwindow-member(1))|Autofits the table columns to the width of the window.| +||[clear()](/javascript/api/word/word.table#word-word-table-clear-member(1))|Clears the contents of the table.| +||[delete()](/javascript/api/word/word.table#word-word-table-delete-member(1))|Deletes the entire table.| +||[deleteColumns(columnIndex: number, columnCount?: number)](/javascript/api/word/word.table#word-word-table-deletecolumns-member(1))|Deletes specific columns.| +||[deleteRows(rowIndex: number, rowCount?: number)](/javascript/api/word/word.table#word-word-table-deleterows-member(1))|Deletes specific rows.| +||[distributeColumns()](/javascript/api/word/word.table#word-word-table-distributecolumns-member(1))|Distributes the column widths evenly.| +||[font](/javascript/api/word/word.table#word-word-table-font-member)|Gets the font.| +||[getBorder(borderLocation: Word.BorderLocation)](/javascript/api/word/word.table#word-word-table-getborder-member(1))|Gets the border style for the specified border.| +||[getCell(rowIndex: number, cellIndex: number)](/javascript/api/word/word.table#word-word-table-getcell-member(1))|Gets the table cell at a specified row and column.| +||[getCellOrNullObject(rowIndex: number, cellIndex: number)](/javascript/api/word/word.table#word-word-table-getcellornullobject-member(1))|Gets the table cell at a specified row and column.| +||[getCellPadding(cellPaddingLocation: Word.CellPaddingLocation)](/javascript/api/word/word.table#word-word-table-getcellpadding-member(1))|Gets cell padding in points.| +||[getNext()](/javascript/api/word/word.table#word-word-table-getnext-member(1))|Gets the next table.| +||[getNextOrNullObject()](/javascript/api/word/word.table#word-word-table-getnextornullobject-member(1))|Gets the next table.| +||[getParagraphAfter()](/javascript/api/word/word.table#word-word-table-getparagraphafter-member(1))|Gets the paragraph after the table.| +||[getParagraphAfterOrNullObject()](/javascript/api/word/word.table#word-word-table-getparagraphafterornullobject-member(1))|Gets the paragraph after the table.| +||[getParagraphBefore()](/javascript/api/word/word.table#word-word-table-getparagraphbefore-member(1))|Gets the paragraph before the table.| +||[getParagraphBeforeOrNullObject()](/javascript/api/word/word.table#word-word-table-getparagraphbeforeornullobject-member(1))|Gets the paragraph before the table.| +||[getRange(rangeLocation?: Word.RangeLocation.whole \| Word.RangeLocation.start \| Word.RangeLocation.end \| Word.RangeLocation.after \| "Whole" \| "Start" \| "End" \| "After")](/javascript/api/word/word.table#word-word-table-getrange-member(1))|Gets the range that contains this table, or the range at the start or end of the table.| +||[headerRowCount](/javascript/api/word/word.table#word-word-table-headerrowcount-member)|Specifies the number of header rows.| +||[horizontalAlignment](/javascript/api/word/word.table#word-word-table-horizontalalignment-member)|Specifies the horizontal alignment of every cell in the table.| +||[insertContentControl()](/javascript/api/word/word.table#word-word-table-insertcontentcontrol-member(1))|Inserts a content control on the table.| +||[insertParagraph(paragraphText: string, insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After")](/javascript/api/word/word.table#word-word-table-insertparagraph-member(1))|Inserts a paragraph at the specified location.| +||[insertTable(rowCount: number, columnCount: number, insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After", values?: string[][])](/javascript/api/word/word.table#word-word-table-inserttable-member(1))|Inserts a table with the specified number of rows and columns.| +||[isUniform](/javascript/api/word/word.table#word-word-table-isuniform-member)|Indicates whether all of the table rows are uniform.| +||[nestingLevel](/javascript/api/word/word.table#word-word-table-nestinglevel-member)|Gets the nesting level of the table.| +||[parentBody](/javascript/api/word/word.table#word-word-table-parentbody-member)|Gets the parent body of the table.| +||[parentContentControl](/javascript/api/word/word.table#word-word-table-parentcontentcontrol-member)|Gets the content control that contains the table.| +||[parentContentControlOrNullObject](/javascript/api/word/word.table#word-word-table-parentcontentcontrolornullobject-member)|Gets the content control that contains the table.| +||[parentTable](/javascript/api/word/word.table#word-word-table-parenttable-member)|Gets the table that contains this table.| +||[parentTableCell](/javascript/api/word/word.table#word-word-table-parenttablecell-member)|Gets the table cell that contains this table.| +||[parentTableCellOrNullObject](/javascript/api/word/word.table#word-word-table-parenttablecellornullobject-member)|Gets the table cell that contains this table.| +||[parentTableOrNullObject](/javascript/api/word/word.table#word-word-table-parenttableornullobject-member)|Gets the table that contains this table.| +||[rowCount](/javascript/api/word/word.table#word-word-table-rowcount-member)|Gets the number of rows in the table.| +||[rows](/javascript/api/word/word.table#word-word-table-rows-member)|Gets all of the table rows.| +||[search(searchText: string, searchOptions?: Word.SearchOptions \| { ignorePunct?: boolean ignoreSpace?: boolean matchCase?: boolean matchPrefix?: boolean matchSuffix?: boolean matchWholeWord?: boolean matchWildcards?: boolean })](/javascript/api/word/word.table#word-word-table-search-member(1))|Performs a search with the specified SearchOptions on the scope of the table object.| +||[select(selectionMode?: Word.SelectionMode)](/javascript/api/word/word.table#word-word-table-select-member(1))|Selects the table, or the position at the start or end of the table, and navigates the Word UI to it.| +||[setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number)](/javascript/api/word/word.table#word-word-table-setcellpadding-member(1))|Sets cell padding in points.| +||[shadingColor](/javascript/api/word/word.table#word-word-table-shadingcolor-member)|Specifies the shading color.| +||[style](/javascript/api/word/word.table#word-word-table-style-member)|Specifies the style name for the table.| +||[styleBandedColumns](/javascript/api/word/word.table#word-word-table-stylebandedcolumns-member)|Specifies whether the table has banded columns.| +||[styleBandedRows](/javascript/api/word/word.table#word-word-table-stylebandedrows-member)|Specifies whether the table has banded rows.| +||[styleBuiltIn](/javascript/api/word/word.table#word-word-table-stylebuiltin-member)|Specifies the built-in style name for the table.| +||[styleFirstColumn](/javascript/api/word/word.table#word-word-table-stylefirstcolumn-member)|Specifies whether the table has a first column with a special style.| +||[styleLastColumn](/javascript/api/word/word.table#word-word-table-stylelastcolumn-member)|Specifies whether the table has a last column with a special style.| +||[styleTotalRow](/javascript/api/word/word.table#word-word-table-styletotalrow-member)|Specifies whether the table has a total (last) row with a special style.| +||[tables](/javascript/api/word/word.table#word-word-table-tables-member)|Gets the child tables nested one level deeper.| +||[values](/javascript/api/word/word.table#word-word-table-values-member)|Specifies the text values in the table, as a 2D JavaScript array.| +||[verticalAlignment](/javascript/api/word/word.table#word-word-table-verticalalignment-member)|Specifies the vertical alignment of every cell in the table.| +||[width](/javascript/api/word/word.table#word-word-table-width-member)|Specifies the width of the table in points.| +|[TableBorder](/javascript/api/word/word.tableborder)|[color](/javascript/api/word/word.tableborder#word-word-tableborder-color-member)|Specifies the table border color.| +||[type](/javascript/api/word/word.tableborder#word-word-tableborder-type-member)|Specifies the type of the table border.| +||[width](/javascript/api/word/word.tableborder#word-word-tableborder-width-member)|Specifies the width, in points, of the table border.| +|[TableCell](/javascript/api/word/word.tablecell)|[body](/javascript/api/word/word.tablecell#word-word-tablecell-body-member)|Gets the body object of the cell.| +||[cellIndex](/javascript/api/word/word.tablecell#word-word-tablecell-cellindex-member)|Gets the index of the cell in its row.| +||[columnWidth](/javascript/api/word/word.tablecell#word-word-tablecell-columnwidth-member)|Specifies the width of the cell's column in points.| +||[deleteColumn()](/javascript/api/word/word.tablecell#word-word-tablecell-deletecolumn-member(1))|Deletes the column containing this cell.| +||[deleteRow()](/javascript/api/word/word.tablecell#word-word-tablecell-deleterow-member(1))|Deletes the row containing this cell.| +||[getBorder(borderLocation: Word.BorderLocation)](/javascript/api/word/word.tablecell#word-word-tablecell-getborder-member(1))|Gets the border style for the specified border.| +||[getCellPadding(cellPaddingLocation: Word.CellPaddingLocation)](/javascript/api/word/word.tablecell#word-word-tablecell-getcellpadding-member(1))|Gets cell padding in points.| +||[getNext()](/javascript/api/word/word.tablecell#word-word-tablecell-getnext-member(1))|Gets the next cell.| +||[getNextOrNullObject()](/javascript/api/word/word.tablecell#word-word-tablecell-getnextornullobject-member(1))|Gets the next cell.| +||[horizontalAlignment](/javascript/api/word/word.tablecell#word-word-tablecell-horizontalalignment-member)|Specifies the horizontal alignment of the cell.| +||[insertColumns(insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After", columnCount: number, values?: string[][])](/javascript/api/word/word.tablecell#word-word-tablecell-insertcolumns-member(1))|Adds columns to the left or right of the cell, using the cell's column as a template.| +||[insertRows(insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After", rowCount: number, values?: string[][])](/javascript/api/word/word.tablecell#word-word-tablecell-insertrows-member(1))|Inserts rows above or below the cell, using the cell's row as a template.| +||[parentRow](/javascript/api/word/word.tablecell#word-word-tablecell-parentrow-member)|Gets the parent row of the cell.| +||[parentTable](/javascript/api/word/word.tablecell#word-word-tablecell-parenttable-member)|Gets the parent table of the cell.| +||[rowIndex](/javascript/api/word/word.tablecell#word-word-tablecell-rowindex-member)|Gets the index of the cell's row in the table.| +||[setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number)](/javascript/api/word/word.tablecell#word-word-tablecell-setcellpadding-member(1))|Sets cell padding in points.| +||[shadingColor](/javascript/api/word/word.tablecell#word-word-tablecell-shadingcolor-member)|Specifies the shading color of the cell.| +||[value](/javascript/api/word/word.tablecell#word-word-tablecell-value-member)|Specifies the text of the cell.| +||[verticalAlignment](/javascript/api/word/word.tablecell#word-word-tablecell-verticalalignment-member)|Specifies the vertical alignment of the cell.| +||[width](/javascript/api/word/word.tablecell#word-word-tablecell-width-member)|Gets the width of the cell in points.| +|[TableCellCollection](/javascript/api/word/word.tablecellcollection)|[getFirst()](/javascript/api/word/word.tablecellcollection#word-word-tablecellcollection-getfirst-member(1))|Gets the first table cell in this collection.| +||[getFirstOrNullObject()](/javascript/api/word/word.tablecellcollection#word-word-tablecellcollection-getfirstornullobject-member(1))|Gets the first table cell in this collection.| +||[items](/javascript/api/word/word.tablecellcollection#word-word-tablecellcollection-items-member)|Gets the loaded child items in this collection.| +|[TableCollection](/javascript/api/word/word.tablecollection)|[getFirst()](/javascript/api/word/word.tablecollection#word-word-tablecollection-getfirst-member(1))|Gets the first table in this collection.| +||[getFirstOrNullObject()](/javascript/api/word/word.tablecollection#word-word-tablecollection-getfirstornullobject-member(1))|Gets the first table in this collection.| +||[items](/javascript/api/word/word.tablecollection#word-word-tablecollection-items-member)|Gets the loaded child items in this collection.| +|[TableRow](/javascript/api/word/word.tablerow)|[cellCount](/javascript/api/word/word.tablerow#word-word-tablerow-cellcount-member)|Gets the number of cells in the row.| +||[cells](/javascript/api/word/word.tablerow#word-word-tablerow-cells-member)|Gets cells.| +||[clear()](/javascript/api/word/word.tablerow#word-word-tablerow-clear-member(1))|Clears the contents of the row.| +||[delete()](/javascript/api/word/word.tablerow#word-word-tablerow-delete-member(1))|Deletes the entire row.| +||[font](/javascript/api/word/word.tablerow#word-word-tablerow-font-member)|Gets the font.| +||[getBorder(borderLocation: Word.BorderLocation)](/javascript/api/word/word.tablerow#word-word-tablerow-getborder-member(1))|Gets the border style of the cells in the row.| +||[getCellPadding(cellPaddingLocation: Word.CellPaddingLocation)](/javascript/api/word/word.tablerow#word-word-tablerow-getcellpadding-member(1))|Gets cell padding in points.| +||[getNext()](/javascript/api/word/word.tablerow#word-word-tablerow-getnext-member(1))|Gets the next row.| +||[getNextOrNullObject()](/javascript/api/word/word.tablerow#word-word-tablerow-getnextornullobject-member(1))|Gets the next row.| +||[horizontalAlignment](/javascript/api/word/word.tablerow#word-word-tablerow-horizontalalignment-member)|Specifies the horizontal alignment of every cell in the row.| +||[insertRows(insertLocation: Word.InsertLocation.before \| Word.InsertLocation.after \| "Before" \| "After", rowCount: number, values?: string[][])](/javascript/api/word/word.tablerow#word-word-tablerow-insertrows-member(1))|Inserts rows using this row as a template.| +||[isHeader](/javascript/api/word/word.tablerow#word-word-tablerow-isheader-member)|Checks whether the row is a header row.| +||[parentTable](/javascript/api/word/word.tablerow#word-word-tablerow-parenttable-member)|Gets parent table.| +||[preferredHeight](/javascript/api/word/word.tablerow#word-word-tablerow-preferredheight-member)|Specifies the preferred height of the row in points.| +||[rowIndex](/javascript/api/word/word.tablerow#word-word-tablerow-rowindex-member)|Gets the index of the row in its parent table.| +||[search(searchText: string, searchOptions?: Word.SearchOptions \| { ignorePunct?: boolean ignoreSpace?: boolean matchCase?: boolean matchPrefix?: boolean matchSuffix?: boolean matchWholeWord?: boolean matchWildcards?: boolean })](/javascript/api/word/word.tablerow#word-word-tablerow-search-member(1))|Performs a search with the specified SearchOptions on the scope of the row.| +||[select(selectionMode?: Word.SelectionMode)](/javascript/api/word/word.tablerow#word-word-tablerow-select-member(1))|Selects the row and navigates the Word UI to it.| +||[setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number)](/javascript/api/word/word.tablerow#word-word-tablerow-setcellpadding-member(1))|Sets cell padding in points.| +||[shadingColor](/javascript/api/word/word.tablerow#word-word-tablerow-shadingcolor-member)|Specifies the shading color.| +||[values](/javascript/api/word/word.tablerow#word-word-tablerow-values-member)|Specifies the text values in the row, as a 2D JavaScript array.| +||[verticalAlignment](/javascript/api/word/word.tablerow#word-word-tablerow-verticalalignment-member)|Specifies the vertical alignment of the cells in the row.| +|[TableRowCollection](/javascript/api/word/word.tablerowcollection)|[getFirst()](/javascript/api/word/word.tablerowcollection#word-word-tablerowcollection-getfirst-member(1))|Gets the first row in this collection.| +||[getFirstOrNullObject()](/javascript/api/word/word.tablerowcollection#word-word-tablerowcollection-getfirstornullobject-member(1))|Gets the first row in this collection.| +||[items](/javascript/api/word/word.tablerowcollection#word-word-tablerowcollection-items-member)|Gets the loaded child items in this collection.| diff --git a/docs/includes/word-1_3_hidden_document.md b/docs/includes/word-1_3_hidden_document.md index 5340b389bd..640d340516 100644 --- a/docs/includes/word-1_3_hidden_document.md +++ b/docs/includes/word-1_3_hidden_document.md @@ -1,8 +1,8 @@ | Class | Fields | Description | |:---|:---|:---| -|[DocumentCreated](/.documentcreated)|[body](/.documentcreated#word-javascript/api/word/-documentcreated-body-member)|Gets the body object of the document.| -||[contentControls](/.documentcreated#word-javascript/api/word/-documentcreated-contentcontrols-member)|Gets the collection of content control objects in the document.| -||[properties](/.documentcreated#word-javascript/api/word/-documentcreated-properties-member)|Gets the properties of the document.| -||[save(saveBehavior?: Word.SaveBehavior, fileName?: string)](/.documentcreated#word-javascript/api/word/-documentcreated-save-member(1))|Saves the document.| -||[saved](/.documentcreated#word-javascript/api/word/-documentcreated-saved-member)|Indicates whether the changes in the document have been saved.| -||[sections](/.documentcreated#word-javascript/api/word/-documentcreated-sections-member)|Gets the collection of section objects in the document.| +|[DocumentCreated](/javascript/api/word/word.documentcreated)|[body](/javascript/api/word/word.documentcreated#word-word-documentcreated-body-member)|Gets the body object of the document.| +||[contentControls](/javascript/api/word/word.documentcreated#word-word-documentcreated-contentcontrols-member)|Gets the collection of content control objects in the document.| +||[properties](/javascript/api/word/word.documentcreated#word-word-documentcreated-properties-member)|Gets the properties of the document.| +||[save(saveBehavior?: Word.SaveBehavior, fileName?: string)](/javascript/api/word/word.documentcreated#word-word-documentcreated-save-member(1))|Saves the document.| +||[saved](/javascript/api/word/word.documentcreated#word-word-documentcreated-saved-member)|Indicates whether the changes in the document have been saved.| +||[sections](/javascript/api/word/word.documentcreated#word-word-documentcreated-sections-member)|Gets the collection of section objects in the document.| diff --git a/docs/includes/word-1_4.md b/docs/includes/word-1_4.md index 8c04995ff8..fc65168a22 100644 --- a/docs/includes/word-1_4.md +++ b/docs/includes/word-1_4.md @@ -1,108 +1,108 @@ | Class | Fields | Description | |:---|:---|:---| -|[Body](/.body)|[fields](/.body#word-javascript/api/word/-body-fields-member)|Gets the collection of field objects in the body.| -||[getComments()](/.body#word-javascript/api/word/-body-getcomments-member(1))|Gets comments associated with the body.| -||[getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion)](/.body#word-javascript/api/word/-body-getreviewedtext-member(1))|Gets reviewed text based on ChangeTrackingVersion selection.| -|[Comment](/.comment)|[authorEmail](/.comment#word-javascript/api/word/-comment-authoremail-member)|Gets the email of the comment's author.| -||[authorName](/.comment#word-javascript/api/word/-comment-authorname-member)|Gets the name of the comment's author.| -||[content](/.comment#word-javascript/api/word/-comment-content-member)|Specifies the comment's content as plain text.| -||[contentRange](/.comment#word-javascript/api/word/-comment-contentrange-member)|Specifies the comment's content range.| -||[creationDate](/.comment#word-javascript/api/word/-comment-creationdate-member)|Gets the creation date of the comment.| -||[delete()](/.comment#word-javascript/api/word/-comment-delete-member(1))|Deletes the comment and its replies.| -||[getRange()](/.comment#word-javascript/api/word/-comment-getrange-member(1))|Gets the range in the main document where the comment is on.| -||[id](/.comment#word-javascript/api/word/-comment-id-member)|Gets the ID of the comment.| -||[replies](/.comment#word-javascript/api/word/-comment-replies-member)|Gets the collection of reply objects associated with the comment.| -||[reply(replyText: string)](/.comment#word-javascript/api/word/-comment-reply-member(1))|Adds a new reply to the end of the comment thread.| -||[resolved](/.comment#word-javascript/api/word/-comment-resolved-member)|Specifies the comment thread's status.| -|[CommentCollection](/.commentcollection)|[getFirst()](/.commentcollection#word-javascript/api/word/-commentcollection-getfirst-member(1))|Gets the first comment in the collection.| -||[getFirstOrNullObject()](/.commentcollection#word-javascript/api/word/-commentcollection-getfirstornullobject-member(1))|Gets the first comment in the collection.| -||[items](/.commentcollection#word-javascript/api/word/-commentcollection-items-member)|Gets the loaded child items in this collection.| -|[CommentContentRange](/.commentcontentrange)|[bold](/.commentcontentrange#word-javascript/api/word/-commentcontentrange-bold-member)|Specifies a value that indicates whether the comment text is bold.| -||[hyperlink](/.commentcontentrange#word-javascript/api/word/-commentcontentrange-hyperlink-member)|Gets the first hyperlink in the range, or sets a hyperlink on the range.| -||[insertText(text: string, insertLocation: Word.InsertLocation \| "Replace" \| "Start" \| "End" \| "Before" \| "After")](/.commentcontentrange#word-javascript/api/word/-commentcontentrange-inserttext-member(1))|Inserts text into at the specified location.| -||[isEmpty](/.commentcontentrange#word-javascript/api/word/-commentcontentrange-isempty-member)|Checks whether the range length is zero.| -||[italic](/.commentcontentrange#word-javascript/api/word/-commentcontentrange-italic-member)|Specifies a value that indicates whether the comment text is italicized.| -||[strikeThrough](/.commentcontentrange#word-javascript/api/word/-commentcontentrange-strikethrough-member)|Specifies a value that indicates whether the comment text has a strikethrough.| -||[text](/.commentcontentrange#word-javascript/api/word/-commentcontentrange-text-member)|Gets the text of the comment range.| -||[underline](/.commentcontentrange#word-javascript/api/word/-commentcontentrange-underline-member)|Specifies a value that indicates the comment text's underline type.| -|[CommentReply](/.commentreply)|[authorEmail](/.commentreply#word-javascript/api/word/-commentreply-authoremail-member)|Gets the email of the comment reply's author.| -||[authorName](/.commentreply#word-javascript/api/word/-commentreply-authorname-member)|Gets the name of the comment reply's author.| -||[content](/.commentreply#word-javascript/api/word/-commentreply-content-member)|Specifies the comment reply's content.| -||[contentRange](/.commentreply#word-javascript/api/word/-commentreply-contentrange-member)|Specifies the commentReply's content range.| -||[creationDate](/.commentreply#word-javascript/api/word/-commentreply-creationdate-member)|Gets the creation date of the comment reply.| -||[delete()](/.commentreply#word-javascript/api/word/-commentreply-delete-member(1))|Deletes the comment reply.| -||[id](/.commentreply#word-javascript/api/word/-commentreply-id-member)|Gets the ID of the comment reply.| -||[parentComment](/.commentreply#word-javascript/api/word/-commentreply-parentcomment-member)|Gets the parent comment of this reply.| -|[CommentReplyCollection](/.commentreplycollection)|[getFirst()](/.commentreplycollection#word-javascript/api/word/-commentreplycollection-getfirst-member(1))|Gets the first comment reply in the collection.| -||[getFirstOrNullObject()](/.commentreplycollection#word-javascript/api/word/-commentreplycollection-getfirstornullobject-member(1))|Gets the first comment reply in the collection.| -||[items](/.commentreplycollection#word-javascript/api/word/-commentreplycollection-items-member)|Gets the loaded child items in this collection.| -|[ContentControl](/.contentcontrol)|[fields](/.contentcontrol#word-javascript/api/word/-contentcontrol-fields-member)|Gets the collection of field objects in the content control.| -||[getComments()](/.contentcontrol#word-javascript/api/word/-contentcontrol-getcomments-member(1))|Gets comments associated with the content control.| -||[getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion)](/.contentcontrol#word-javascript/api/word/-contentcontrol-getreviewedtext-member(1))|Gets reviewed text based on ChangeTrackingVersion selection.| -|[CustomXmlPart](/.customxmlpart)|[delete()](/.customxmlpart#word-javascript/api/word/-customxmlpart-delete-member(1))|Deletes the custom XML part.| -||[deleteAttribute(xpath: string, namespaceMappings: { [key: string]: string }, name: string)](/.customxmlpart#word-javascript/api/word/-customxmlpart-deleteattribute-member(1))|Deletes an attribute with the given name from the element identified by xpath.| -||[deleteElement(xpath: string, namespaceMappings: { [key: string]: string })](/.customxmlpart#word-javascript/api/word/-customxmlpart-deleteelement-member(1))|Deletes the element identified by xpath.| -||[getXml()](/.customxmlpart#word-javascript/api/word/-customxmlpart-getxml-member(1))|Gets the full XML content of the custom XML part.| -||[id](/.customxmlpart#word-javascript/api/word/-customxmlpart-id-member)|Gets the ID of the custom XML part.| -||[insertAttribute(xpath: string, namespaceMappings: { [key: string]: string }, name: string, value: string)](/.customxmlpart#word-javascript/api/word/-customxmlpart-insertattribute-member(1))|Inserts an attribute with the given name and value to the element identified by xpath.| -||[insertElement(xpath: string, xml: string, namespaceMappings: { [key: string]: string }, index?: number)](/.customxmlpart#word-javascript/api/word/-customxmlpart-insertelement-member(1))|Inserts the given XML under the parent element identified by xpath at child position index.| -||[namespaceUri](/.customxmlpart#word-javascript/api/word/-customxmlpart-namespaceuri-member)|Gets the namespace URI of the custom XML part.| -||[query(xpath: string, namespaceMappings: { [key: string]: string })](/.customxmlpart#word-javascript/api/word/-customxmlpart-query-member(1))|Queries the XML content of the custom XML part.| -||[setXml(xml: string)](/.customxmlpart#word-javascript/api/word/-customxmlpart-setxml-member(1))|Sets the full XML content of the custom XML part.| -||[updateAttribute(xpath: string, namespaceMappings: { [key: string]: string }, name: string, value: string)](/.customxmlpart#word-javascript/api/word/-customxmlpart-updateattribute-member(1))|Updates the value of an attribute with the given name of the element identified by xpath.| -||[updateElement(xpath: string, xml: string, namespaceMappings: { [key: string]: string })](/.customxmlpart#word-javascript/api/word/-customxmlpart-updateelement-member(1))|Updates the XML of the element identified by xpath.| -|[CustomXmlPartCollection](/.customxmlpartcollection)|[add(xml: string)](/.customxmlpartcollection#word-javascript/api/word/-customxmlpartcollection-add-member(1))|Adds a new custom XML part to the document.| -||[getByNamespace(namespaceUri: string)](/.customxmlpartcollection#word-javascript/api/word/-customxmlpartcollection-getbynamespace-member(1))|Gets a new scoped collection of custom XML parts whose namespaces match the given namespace.| -||[getCount()](/.customxmlpartcollection#word-javascript/api/word/-customxmlpartcollection-getcount-member(1))|Gets the number of items in the collection.| -||[getItem(id: string)](/.customxmlpartcollection#word-javascript/api/word/-customxmlpartcollection-getitem-member(1))|Gets a custom XML part based on its ID.| -||[getItemOrNullObject(id: string)](/.customxmlpartcollection#word-javascript/api/word/-customxmlpartcollection-getitemornullobject-member(1))|Gets a custom XML part based on its ID.| -||[items](/.customxmlpartcollection#word-javascript/api/word/-customxmlpartcollection-items-member)|Gets the loaded child items in this collection.| -|[CustomXmlPartScopedCollection](/.customxmlpartscopedcollection)|[getCount()](/.customxmlpartscopedcollection#word-javascript/api/word/-customxmlpartscopedcollection-getcount-member(1))|Gets the number of items in the collection.| -||[getItem(id: string)](/.customxmlpartscopedcollection#word-javascript/api/word/-customxmlpartscopedcollection-getitem-member(1))|Gets a custom XML part based on its ID.| -||[getItemOrNullObject(id: string)](/.customxmlpartscopedcollection#word-javascript/api/word/-customxmlpartscopedcollection-getitemornullobject-member(1))|Gets a custom XML part based on its ID.| -||[getOnlyItem()](/.customxmlpartscopedcollection#word-javascript/api/word/-customxmlpartscopedcollection-getonlyitem-member(1))|If the collection contains exactly one item, this method returns it.| -||[getOnlyItemOrNullObject()](/.customxmlpartscopedcollection#word-javascript/api/word/-customxmlpartscopedcollection-getonlyitemornullobject-member(1))|If the collection contains exactly one item, this method returns it.| -||[items](/.customxmlpartscopedcollection#word-javascript/api/word/-customxmlpartscopedcollection-items-member)|Gets the loaded child items in this collection.| -|[Document](/.document)|[changeTrackingMode](/.document#word-javascript/api/word/-document-changetrackingmode-member)|Specifies the ChangeTracking mode.| -||[customXmlParts](/.document#word-javascript/api/word/-document-customxmlparts-member)|Gets the custom XML parts in the document.| -||[deleteBookmark(name: string)](/.document#word-javascript/api/word/-document-deletebookmark-member(1))|Deletes a bookmark, if it exists, from the document.| -||[getBookmarkRange(name: string)](/.document#word-javascript/api/word/-document-getbookmarkrange-member(1))|Gets a bookmark's range.| -||[getBookmarkRangeOrNullObject(name: string)](/.document#word-javascript/api/word/-document-getbookmarkrangeornullobject-member(1))|Gets a bookmark's range.| -||[settings](/.document#word-javascript/api/word/-document-settings-member)|Gets the add-in's settings in the document.| -|[Field](/.field)|[code](/.field#word-javascript/api/word/-field-code-member)|Specifies the field's code instruction.| -||[getNext()](/.field#word-javascript/api/word/-field-getnext-member(1))|Gets the next field.| -||[getNextOrNullObject()](/.field#word-javascript/api/word/-field-getnextornullobject-member(1))|Gets the next field.| -||[parentBody](/.field#word-javascript/api/word/-field-parentbody-member)|Gets the parent body of the field.| -||[parentContentControl](/.field#word-javascript/api/word/-field-parentcontentcontrol-member)|Gets the content control that contains the field.| -||[parentContentControlOrNullObject](/.field#word-javascript/api/word/-field-parentcontentcontrolornullobject-member)|Gets the content control that contains the field.| -||[parentTable](/.field#word-javascript/api/word/-field-parenttable-member)|Gets the table that contains the field.| -||[parentTableCell](/.field#word-javascript/api/word/-field-parenttablecell-member)|Gets the table cell that contains the field.| -||[parentTableCellOrNullObject](/.field#word-javascript/api/word/-field-parenttablecellornullobject-member)|Gets the table cell that contains the field.| -||[parentTableOrNullObject](/.field#word-javascript/api/word/-field-parenttableornullobject-member)|Gets the table that contains the field.| -||[result](/.field#word-javascript/api/word/-field-result-member)|Gets the field's result data.| -|[FieldCollection](/.fieldcollection)|[getFirst()](/.fieldcollection#word-javascript/api/word/-fieldcollection-getfirst-member(1))|Gets the first field in this collection.| -||[getFirstOrNullObject()](/.fieldcollection#word-javascript/api/word/-fieldcollection-getfirstornullobject-member(1))|Gets the first field in this collection.| -||[items](/.fieldcollection#word-javascript/api/word/-fieldcollection-items-member)|Gets the loaded child items in this collection.| -|[Paragraph](/.paragraph)|[fields](/.paragraph#word-javascript/api/word/-paragraph-fields-member)|Gets the collection of fields in the paragraph.| -||[getComments()](/.paragraph#word-javascript/api/word/-paragraph-getcomments-member(1))|Gets comments associated with the paragraph.| -||[getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion)](/.paragraph#word-javascript/api/word/-paragraph-getreviewedtext-member(1))|Gets reviewed text based on ChangeTrackingVersion selection.| -|[Range](/.range)|[fields](/.range#word-javascript/api/word/-range-fields-member)|Gets the collection of field objects in the range.| -||[getBookmarks(includeHidden?: boolean, includeAdjacent?: boolean)](/.range#word-javascript/api/word/-range-getbookmarks-member(1))|Gets the names all bookmarks in or overlapping the range.| -||[getComments()](/.range#word-javascript/api/word/-range-getcomments-member(1))|Gets comments associated with the range.| -||[getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion)](/.range#word-javascript/api/word/-range-getreviewedtext-member(1))|Gets reviewed text based on ChangeTrackingVersion selection.| -||[insertBookmark(name: string)](/.range#word-javascript/api/word/-range-insertbookmark-member(1))|Inserts a bookmark on the range.| -||[insertComment(commentText: string)](/.range#word-javascript/api/word/-range-insertcomment-member(1))|Insert a comment on the range.| -|[Setting](/.setting)|[delete()](/.setting#word-javascript/api/word/-setting-delete-member(1))|Deletes the setting.| -||[key](/.setting#word-javascript/api/word/-setting-key-member)|Gets the key of the setting.| -||[value](/.setting#word-javascript/api/word/-setting-value-member)|Specifies the value of the setting.| -|[SettingCollection](/.settingcollection)|[add(key: string, value: any)](/.settingcollection#word-javascript/api/word/-settingcollection-add-member(1))|Creates a new setting or sets an existing setting.| -||[deleteAll()](/.settingcollection#word-javascript/api/word/-settingcollection-deleteall-member(1))|Deletes all settings in this add-in.| -||[getCount()](/.settingcollection#word-javascript/api/word/-settingcollection-getcount-member(1))|Gets the count of settings.| -||[getItem(key: string)](/.settingcollection#word-javascript/api/word/-settingcollection-getitem-member(1))|Gets a setting object by its key, which is case-sensitive.| -||[getItemOrNullObject(key: string)](/.settingcollection#word-javascript/api/word/-settingcollection-getitemornullobject-member(1))|Gets a setting object by its key, which is case-sensitive.| -||[items](/.settingcollection#word-javascript/api/word/-settingcollection-items-member)|Gets the loaded child items in this collection.| -|[Table](/.table)|[fields](/.table#word-javascript/api/word/-table-fields-member)|Gets the collection of field objects in the table.| -||[mergeCells(topRow: number, firstCell: number, bottomRow: number, lastCell: number)](/.table#word-javascript/api/word/-table-mergecells-member(1))|Merges the cells bounded inclusively by a first and last cell.| -|[TableCell](/.tablecell)|[split(rowCount: number, columnCount: number)](/.tablecell#word-javascript/api/word/-tablecell-split-member(1))|Splits the cell into the specified number of rows and columns.| -|[TableRow](/.tablerow)|[fields](/.tablerow#word-javascript/api/word/-tablerow-fields-member)|Gets the collection of field objects in the table row.| -||[merge()](/.tablerow#word-javascript/api/word/-tablerow-merge-member(1))|Merges the row into one cell.| +|[Body](/javascript/api/word/word.body)|[fields](/javascript/api/word/word.body#word-word-body-fields-member)|Gets the collection of field objects in the body.| +||[getComments()](/javascript/api/word/word.body#word-word-body-getcomments-member(1))|Gets comments associated with the body.| +||[getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion)](/javascript/api/word/word.body#word-word-body-getreviewedtext-member(1))|Gets reviewed text based on ChangeTrackingVersion selection.| +|[Comment](/javascript/api/word/word.comment)|[authorEmail](/javascript/api/word/word.comment#word-word-comment-authoremail-member)|Gets the email of the comment's author.| +||[authorName](/javascript/api/word/word.comment#word-word-comment-authorname-member)|Gets the name of the comment's author.| +||[content](/javascript/api/word/word.comment#word-word-comment-content-member)|Specifies the comment's content as plain text.| +||[contentRange](/javascript/api/word/word.comment#word-word-comment-contentrange-member)|Specifies the comment's content range.| +||[creationDate](/javascript/api/word/word.comment#word-word-comment-creationdate-member)|Gets the creation date of the comment.| +||[delete()](/javascript/api/word/word.comment#word-word-comment-delete-member(1))|Deletes the comment and its replies.| +||[getRange()](/javascript/api/word/word.comment#word-word-comment-getrange-member(1))|Gets the range in the main document where the comment is on.| +||[id](/javascript/api/word/word.comment#word-word-comment-id-member)|Gets the ID of the comment.| +||[replies](/javascript/api/word/word.comment#word-word-comment-replies-member)|Gets the collection of reply objects associated with the comment.| +||[reply(replyText: string)](/javascript/api/word/word.comment#word-word-comment-reply-member(1))|Adds a new reply to the end of the comment thread.| +||[resolved](/javascript/api/word/word.comment#word-word-comment-resolved-member)|Specifies the comment thread's status.| +|[CommentCollection](/javascript/api/word/word.commentcollection)|[getFirst()](/javascript/api/word/word.commentcollection#word-word-commentcollection-getfirst-member(1))|Gets the first comment in the collection.| +||[getFirstOrNullObject()](/javascript/api/word/word.commentcollection#word-word-commentcollection-getfirstornullobject-member(1))|Gets the first comment in the collection.| +||[items](/javascript/api/word/word.commentcollection#word-word-commentcollection-items-member)|Gets the loaded child items in this collection.| +|[CommentContentRange](/javascript/api/word/word.commentcontentrange)|[bold](/javascript/api/word/word.commentcontentrange#word-word-commentcontentrange-bold-member)|Specifies a value that indicates whether the comment text is bold.| +||[hyperlink](/javascript/api/word/word.commentcontentrange#word-word-commentcontentrange-hyperlink-member)|Gets the first hyperlink in the range, or sets a hyperlink on the range.| +||[insertText(text: string, insertLocation: Word.InsertLocation \| "Replace" \| "Start" \| "End" \| "Before" \| "After")](/javascript/api/word/word.commentcontentrange#word-word-commentcontentrange-inserttext-member(1))|Inserts text into at the specified location.| +||[isEmpty](/javascript/api/word/word.commentcontentrange#word-word-commentcontentrange-isempty-member)|Checks whether the range length is zero.| +||[italic](/javascript/api/word/word.commentcontentrange#word-word-commentcontentrange-italic-member)|Specifies a value that indicates whether the comment text is italicized.| +||[strikeThrough](/javascript/api/word/word.commentcontentrange#word-word-commentcontentrange-strikethrough-member)|Specifies a value that indicates whether the comment text has a strikethrough.| +||[text](/javascript/api/word/word.commentcontentrange#word-word-commentcontentrange-text-member)|Gets the text of the comment range.| +||[underline](/javascript/api/word/word.commentcontentrange#word-word-commentcontentrange-underline-member)|Specifies a value that indicates the comment text's underline type.| +|[CommentReply](/javascript/api/word/word.commentreply)|[authorEmail](/javascript/api/word/word.commentreply#word-word-commentreply-authoremail-member)|Gets the email of the comment reply's author.| +||[authorName](/javascript/api/word/word.commentreply#word-word-commentreply-authorname-member)|Gets the name of the comment reply's author.| +||[content](/javascript/api/word/word.commentreply#word-word-commentreply-content-member)|Specifies the comment reply's content.| +||[contentRange](/javascript/api/word/word.commentreply#word-word-commentreply-contentrange-member)|Specifies the commentReply's content range.| +||[creationDate](/javascript/api/word/word.commentreply#word-word-commentreply-creationdate-member)|Gets the creation date of the comment reply.| +||[delete()](/javascript/api/word/word.commentreply#word-word-commentreply-delete-member(1))|Deletes the comment reply.| +||[id](/javascript/api/word/word.commentreply#word-word-commentreply-id-member)|Gets the ID of the comment reply.| +||[parentComment](/javascript/api/word/word.commentreply#word-word-commentreply-parentcomment-member)|Gets the parent comment of this reply.| +|[CommentReplyCollection](/javascript/api/word/word.commentreplycollection)|[getFirst()](/javascript/api/word/word.commentreplycollection#word-word-commentreplycollection-getfirst-member(1))|Gets the first comment reply in the collection.| +||[getFirstOrNullObject()](/javascript/api/word/word.commentreplycollection#word-word-commentreplycollection-getfirstornullobject-member(1))|Gets the first comment reply in the collection.| +||[items](/javascript/api/word/word.commentreplycollection#word-word-commentreplycollection-items-member)|Gets the loaded child items in this collection.| +|[ContentControl](/javascript/api/word/word.contentcontrol)|[fields](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-fields-member)|Gets the collection of field objects in the content control.| +||[getComments()](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-getcomments-member(1))|Gets comments associated with the content control.| +||[getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion)](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-getreviewedtext-member(1))|Gets reviewed text based on ChangeTrackingVersion selection.| +|[CustomXmlPart](/javascript/api/word/word.customxmlpart)|[delete()](/javascript/api/word/word.customxmlpart#word-word-customxmlpart-delete-member(1))|Deletes the custom XML part.| +||[deleteAttribute(xpath: string, namespaceMappings: { [key: string]: string }, name: string)](/javascript/api/word/word.customxmlpart#word-word-customxmlpart-deleteattribute-member(1))|Deletes an attribute with the given name from the element identified by xpath.| +||[deleteElement(xpath: string, namespaceMappings: { [key: string]: string })](/javascript/api/word/word.customxmlpart#word-word-customxmlpart-deleteelement-member(1))|Deletes the element identified by xpath.| +||[getXml()](/javascript/api/word/word.customxmlpart#word-word-customxmlpart-getxml-member(1))|Gets the full XML content of the custom XML part.| +||[id](/javascript/api/word/word.customxmlpart#word-word-customxmlpart-id-member)|Gets the ID of the custom XML part.| +||[insertAttribute(xpath: string, namespaceMappings: { [key: string]: string }, name: string, value: string)](/javascript/api/word/word.customxmlpart#word-word-customxmlpart-insertattribute-member(1))|Inserts an attribute with the given name and value to the element identified by xpath.| +||[insertElement(xpath: string, xml: string, namespaceMappings: { [key: string]: string }, index?: number)](/javascript/api/word/word.customxmlpart#word-word-customxmlpart-insertelement-member(1))|Inserts the given XML under the parent element identified by xpath at child position index.| +||[namespaceUri](/javascript/api/word/word.customxmlpart#word-word-customxmlpart-namespaceuri-member)|Gets the namespace URI of the custom XML part.| +||[query(xpath: string, namespaceMappings: { [key: string]: string })](/javascript/api/word/word.customxmlpart#word-word-customxmlpart-query-member(1))|Queries the XML content of the custom XML part.| +||[setXml(xml: string)](/javascript/api/word/word.customxmlpart#word-word-customxmlpart-setxml-member(1))|Sets the full XML content of the custom XML part.| +||[updateAttribute(xpath: string, namespaceMappings: { [key: string]: string }, name: string, value: string)](/javascript/api/word/word.customxmlpart#word-word-customxmlpart-updateattribute-member(1))|Updates the value of an attribute with the given name of the element identified by xpath.| +||[updateElement(xpath: string, xml: string, namespaceMappings: { [key: string]: string })](/javascript/api/word/word.customxmlpart#word-word-customxmlpart-updateelement-member(1))|Updates the XML of the element identified by xpath.| +|[CustomXmlPartCollection](/javascript/api/word/word.customxmlpartcollection)|[add(xml: string)](/javascript/api/word/word.customxmlpartcollection#word-word-customxmlpartcollection-add-member(1))|Adds a new custom XML part to the document.| +||[getByNamespace(namespaceUri: string)](/javascript/api/word/word.customxmlpartcollection#word-word-customxmlpartcollection-getbynamespace-member(1))|Gets a new scoped collection of custom XML parts whose namespaces match the given namespace.| +||[getCount()](/javascript/api/word/word.customxmlpartcollection#word-word-customxmlpartcollection-getcount-member(1))|Gets the number of items in the collection.| +||[getItem(id: string)](/javascript/api/word/word.customxmlpartcollection#word-word-customxmlpartcollection-getitem-member(1))|Gets a custom XML part based on its ID.| +||[getItemOrNullObject(id: string)](/javascript/api/word/word.customxmlpartcollection#word-word-customxmlpartcollection-getitemornullobject-member(1))|Gets a custom XML part based on its ID.| +||[items](/javascript/api/word/word.customxmlpartcollection#word-word-customxmlpartcollection-items-member)|Gets the loaded child items in this collection.| +|[CustomXmlPartScopedCollection](/javascript/api/word/word.customxmlpartscopedcollection)|[getCount()](/javascript/api/word/word.customxmlpartscopedcollection#word-word-customxmlpartscopedcollection-getcount-member(1))|Gets the number of items in the collection.| +||[getItem(id: string)](/javascript/api/word/word.customxmlpartscopedcollection#word-word-customxmlpartscopedcollection-getitem-member(1))|Gets a custom XML part based on its ID.| +||[getItemOrNullObject(id: string)](/javascript/api/word/word.customxmlpartscopedcollection#word-word-customxmlpartscopedcollection-getitemornullobject-member(1))|Gets a custom XML part based on its ID.| +||[getOnlyItem()](/javascript/api/word/word.customxmlpartscopedcollection#word-word-customxmlpartscopedcollection-getonlyitem-member(1))|If the collection contains exactly one item, this method returns it.| +||[getOnlyItemOrNullObject()](/javascript/api/word/word.customxmlpartscopedcollection#word-word-customxmlpartscopedcollection-getonlyitemornullobject-member(1))|If the collection contains exactly one item, this method returns it.| +||[items](/javascript/api/word/word.customxmlpartscopedcollection#word-word-customxmlpartscopedcollection-items-member)|Gets the loaded child items in this collection.| +|[Document](/javascript/api/word/word.document)|[changeTrackingMode](/javascript/api/word/word.document#word-word-document-changetrackingmode-member)|Specifies the ChangeTracking mode.| +||[customXmlParts](/javascript/api/word/word.document#word-word-document-customxmlparts-member)|Gets the custom XML parts in the document.| +||[deleteBookmark(name: string)](/javascript/api/word/word.document#word-word-document-deletebookmark-member(1))|Deletes a bookmark, if it exists, from the document.| +||[getBookmarkRange(name: string)](/javascript/api/word/word.document#word-word-document-getbookmarkrange-member(1))|Gets a bookmark's range.| +||[getBookmarkRangeOrNullObject(name: string)](/javascript/api/word/word.document#word-word-document-getbookmarkrangeornullobject-member(1))|Gets a bookmark's range.| +||[settings](/javascript/api/word/word.document#word-word-document-settings-member)|Gets the add-in's settings in the document.| +|[Field](/javascript/api/word/word.field)|[code](/javascript/api/word/word.field#word-word-field-code-member)|Specifies the field's code instruction.| +||[getNext()](/javascript/api/word/word.field#word-word-field-getnext-member(1))|Gets the next field.| +||[getNextOrNullObject()](/javascript/api/word/word.field#word-word-field-getnextornullobject-member(1))|Gets the next field.| +||[parentBody](/javascript/api/word/word.field#word-word-field-parentbody-member)|Gets the parent body of the field.| +||[parentContentControl](/javascript/api/word/word.field#word-word-field-parentcontentcontrol-member)|Gets the content control that contains the field.| +||[parentContentControlOrNullObject](/javascript/api/word/word.field#word-word-field-parentcontentcontrolornullobject-member)|Gets the content control that contains the field.| +||[parentTable](/javascript/api/word/word.field#word-word-field-parenttable-member)|Gets the table that contains the field.| +||[parentTableCell](/javascript/api/word/word.field#word-word-field-parenttablecell-member)|Gets the table cell that contains the field.| +||[parentTableCellOrNullObject](/javascript/api/word/word.field#word-word-field-parenttablecellornullobject-member)|Gets the table cell that contains the field.| +||[parentTableOrNullObject](/javascript/api/word/word.field#word-word-field-parenttableornullobject-member)|Gets the table that contains the field.| +||[result](/javascript/api/word/word.field#word-word-field-result-member)|Gets the field's result data.| +|[FieldCollection](/javascript/api/word/word.fieldcollection)|[getFirst()](/javascript/api/word/word.fieldcollection#word-word-fieldcollection-getfirst-member(1))|Gets the first field in this collection.| +||[getFirstOrNullObject()](/javascript/api/word/word.fieldcollection#word-word-fieldcollection-getfirstornullobject-member(1))|Gets the first field in this collection.| +||[items](/javascript/api/word/word.fieldcollection#word-word-fieldcollection-items-member)|Gets the loaded child items in this collection.| +|[Paragraph](/javascript/api/word/word.paragraph)|[fields](/javascript/api/word/word.paragraph#word-word-paragraph-fields-member)|Gets the collection of fields in the paragraph.| +||[getComments()](/javascript/api/word/word.paragraph#word-word-paragraph-getcomments-member(1))|Gets comments associated with the paragraph.| +||[getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion)](/javascript/api/word/word.paragraph#word-word-paragraph-getreviewedtext-member(1))|Gets reviewed text based on ChangeTrackingVersion selection.| +|[Range](/javascript/api/word/word.range)|[fields](/javascript/api/word/word.range#word-word-range-fields-member)|Gets the collection of field objects in the range.| +||[getBookmarks(includeHidden?: boolean, includeAdjacent?: boolean)](/javascript/api/word/word.range#word-word-range-getbookmarks-member(1))|Gets the names all bookmarks in or overlapping the range.| +||[getComments()](/javascript/api/word/word.range#word-word-range-getcomments-member(1))|Gets comments associated with the range.| +||[getReviewedText(changeTrackingVersion?: Word.ChangeTrackingVersion)](/javascript/api/word/word.range#word-word-range-getreviewedtext-member(1))|Gets reviewed text based on ChangeTrackingVersion selection.| +||[insertBookmark(name: string)](/javascript/api/word/word.range#word-word-range-insertbookmark-member(1))|Inserts a bookmark on the range.| +||[insertComment(commentText: string)](/javascript/api/word/word.range#word-word-range-insertcomment-member(1))|Insert a comment on the range.| +|[Setting](/javascript/api/word/word.setting)|[delete()](/javascript/api/word/word.setting#word-word-setting-delete-member(1))|Deletes the setting.| +||[key](/javascript/api/word/word.setting#word-word-setting-key-member)|Gets the key of the setting.| +||[value](/javascript/api/word/word.setting#word-word-setting-value-member)|Specifies the value of the setting.| +|[SettingCollection](/javascript/api/word/word.settingcollection)|[add(key: string, value: any)](/javascript/api/word/word.settingcollection#word-word-settingcollection-add-member(1))|Creates a new setting or sets an existing setting.| +||[deleteAll()](/javascript/api/word/word.settingcollection#word-word-settingcollection-deleteall-member(1))|Deletes all settings in this add-in.| +||[getCount()](/javascript/api/word/word.settingcollection#word-word-settingcollection-getcount-member(1))|Gets the count of settings.| +||[getItem(key: string)](/javascript/api/word/word.settingcollection#word-word-settingcollection-getitem-member(1))|Gets a setting object by its key, which is case-sensitive.| +||[getItemOrNullObject(key: string)](/javascript/api/word/word.settingcollection#word-word-settingcollection-getitemornullobject-member(1))|Gets a setting object by its key, which is case-sensitive.| +||[items](/javascript/api/word/word.settingcollection#word-word-settingcollection-items-member)|Gets the loaded child items in this collection.| +|[Table](/javascript/api/word/word.table)|[fields](/javascript/api/word/word.table#word-word-table-fields-member)|Gets the collection of field objects in the table.| +||[mergeCells(topRow: number, firstCell: number, bottomRow: number, lastCell: number)](/javascript/api/word/word.table#word-word-table-mergecells-member(1))|Merges the cells bounded inclusively by a first and last cell.| +|[TableCell](/javascript/api/word/word.tablecell)|[split(rowCount: number, columnCount: number)](/javascript/api/word/word.tablecell#word-word-tablecell-split-member(1))|Splits the cell into the specified number of rows and columns.| +|[TableRow](/javascript/api/word/word.tablerow)|[fields](/javascript/api/word/word.tablerow#word-word-tablerow-fields-member)|Gets the collection of field objects in the table row.| +||[merge()](/javascript/api/word/word.tablerow#word-word-tablerow-merge-member(1))|Merges the row into one cell.| diff --git a/docs/includes/word-1_4_hidden_document.md b/docs/includes/word-1_4_hidden_document.md index 60e5445606..484d3a55bc 100644 --- a/docs/includes/word-1_4_hidden_document.md +++ b/docs/includes/word-1_4_hidden_document.md @@ -1,7 +1,7 @@ | Class | Fields | Description | |:---|:---|:---| -|[DocumentCreated](/.documentcreated)|[customXmlParts](/.documentcreated#word-javascript/api/word/-documentcreated-customxmlparts-member)|Gets the custom XML parts in the document.| -||[deleteBookmark(name: string)](/.documentcreated#word-javascript/api/word/-documentcreated-deletebookmark-member(1))|Deletes a bookmark, if it exists, from the document.| -||[getBookmarkRange(name: string)](/.documentcreated#word-javascript/api/word/-documentcreated-getbookmarkrange-member(1))|Gets a bookmark's range.| -||[getBookmarkRangeOrNullObject(name: string)](/.documentcreated#word-javascript/api/word/-documentcreated-getbookmarkrangeornullobject-member(1))|Gets a bookmark's range.| -||[settings](/.documentcreated#word-javascript/api/word/-documentcreated-settings-member)|Gets the add-in's settings in the document.| +|[DocumentCreated](/javascript/api/word/word.documentcreated)|[customXmlParts](/javascript/api/word/word.documentcreated#word-word-documentcreated-customxmlparts-member)|Gets the custom XML parts in the document.| +||[deleteBookmark(name: string)](/javascript/api/word/word.documentcreated#word-word-documentcreated-deletebookmark-member(1))|Deletes a bookmark, if it exists, from the document.| +||[getBookmarkRange(name: string)](/javascript/api/word/word.documentcreated#word-word-documentcreated-getbookmarkrange-member(1))|Gets a bookmark's range.| +||[getBookmarkRangeOrNullObject(name: string)](/javascript/api/word/word.documentcreated#word-word-documentcreated-getbookmarkrangeornullobject-member(1))|Gets a bookmark's range.| +||[settings](/javascript/api/word/word.documentcreated#word-word-documentcreated-settings-member)|Gets the add-in's settings in the document.| diff --git a/docs/includes/word-1_5.md b/docs/includes/word-1_5.md index 7419fc741b..84fa765f4c 100644 --- a/docs/includes/word-1_5.md +++ b/docs/includes/word-1_5.md @@ -1,110 +1,110 @@ | Class | Fields | Description | |:---|:---|:---| -|[Application](/.application)|[retrieveStylesFromBase64(base64File: string)](/.application#word-javascript/api/word/-application-retrievestylesfrombase64-member(1))|Parse styles from template Base64 file and return JSON format of retrieved styles as a string.| -|[Body](/.body)|[endnotes](/.body#word-javascript/api/word/-body-endnotes-member)|Gets the collection of endnotes in the body.| -||[footnotes](/.body#word-javascript/api/word/-body-footnotes-member)|Gets the collection of footnotes in the body.| -||[getContentControls(options?: Word.ContentControlOptions)](/.body#word-javascript/api/word/-body-getcontentcontrols-member(1))|Gets the currently supported content controls in the body.| -|[ContentControl](/.contentcontrol)|[endnotes](/.contentcontrol#word-javascript/api/word/-contentcontrol-endnotes-member)|Gets the collection of endnotes in the content control.| -||[footnotes](/.contentcontrol#word-javascript/api/word/-contentcontrol-footnotes-member)|Gets the collection of footnotes in the content control.| -||[getContentControls(options?: Word.ContentControlOptions)](/.contentcontrol#word-javascript/api/word/-contentcontrol-getcontentcontrols-member(1))|Gets the currently supported child content controls in this content control.| -||[onDataChanged](/.contentcontrol#word-javascript/api/word/-contentcontrol-ondatachanged-member)|Occurs when data within the content control are changed.| -||[onDeleted](/.contentcontrol#word-javascript/api/word/-contentcontrol-ondeleted-member)|Occurs when the content control is deleted.| -||[onEntered](/.contentcontrol#word-javascript/api/word/-contentcontrol-onentered-member)|Occurs when the content control is entered.| -||[onExited](/.contentcontrol#word-javascript/api/word/-contentcontrol-onexited-member)|Occurs when the content control is exited, for example, when the cursor leaves the content control.| -||[onSelectionChanged](/.contentcontrol#word-javascript/api/word/-contentcontrol-onselectionchanged-member)|Occurs when selection within the content control is changed.| -|[ContentControlAddedEventArgs](/.contentcontroladdedeventargs)|[eventType](/.contentcontroladdedeventargs#word-javascript/api/word/-contentcontroladdedeventargs-eventtype-member)|The event type.| -||[ids](/.contentcontroladdedeventargs#word-javascript/api/word/-contentcontroladdedeventargs-ids-member)|Gets the content control IDs.| -||[source](/.contentcontroladdedeventargs#word-javascript/api/word/-contentcontroladdedeventargs-source-member)|The source of the event.| -|[ContentControlCollection](/.contentcontrolcollection)|[getByChangeTrackingStates(changeTrackingStates: Word.ChangeTrackingState[])](/.contentcontrolcollection#word-javascript/api/word/-contentcontrolcollection-getbychangetrackingstates-member(1))|Gets the content controls that have the specified tracking state.| -|[ContentControlDataChangedEventArgs](/.contentcontroldatachangedeventargs)|[eventType](/.contentcontroldatachangedeventargs#word-javascript/api/word/-contentcontroldatachangedeventargs-eventtype-member)|The event type.| -||[ids](/.contentcontroldatachangedeventargs#word-javascript/api/word/-contentcontroldatachangedeventargs-ids-member)|Gets the content control IDs.| -||[source](/.contentcontroldatachangedeventargs#word-javascript/api/word/-contentcontroldatachangedeventargs-source-member)|The source of the event.| -|[ContentControlDeletedEventArgs](/.contentcontroldeletedeventargs)|[eventType](/.contentcontroldeletedeventargs#word-javascript/api/word/-contentcontroldeletedeventargs-eventtype-member)|The event type.| -||[ids](/.contentcontroldeletedeventargs#word-javascript/api/word/-contentcontroldeletedeventargs-ids-member)|Gets the content control IDs.| -||[source](/.contentcontroldeletedeventargs#word-javascript/api/word/-contentcontroldeletedeventargs-source-member)|The source of the event.| -|[ContentControlEnteredEventArgs](/.contentcontrolenteredeventargs)|[eventType](/.contentcontrolenteredeventargs#word-javascript/api/word/-contentcontrolenteredeventargs-eventtype-member)|The event type.| -||[ids](/.contentcontrolenteredeventargs#word-javascript/api/word/-contentcontrolenteredeventargs-ids-member)|Gets the content control IDs.| -||[source](/.contentcontrolenteredeventargs#word-javascript/api/word/-contentcontrolenteredeventargs-source-member)|The source of the event.| -|[ContentControlExitedEventArgs](/.contentcontrolexitedeventargs)|[eventType](/.contentcontrolexitedeventargs#word-javascript/api/word/-contentcontrolexitedeventargs-eventtype-member)|The event type.| -||[ids](/.contentcontrolexitedeventargs#word-javascript/api/word/-contentcontrolexitedeventargs-ids-member)|Gets the content control IDs.| -||[source](/.contentcontrolexitedeventargs#word-javascript/api/word/-contentcontrolexitedeventargs-source-member)|The source of the event.| -|[ContentControlOptions](/.contentcontroloptions)|[types](/.contentcontroloptions#word-javascript/api/word/-contentcontroloptions-types-member)|An array of content control types, item must be 'RichText', 'PlainText', 'CheckBox', 'DropDownList', or 'ComboBox'.| -|[ContentControlSelectionChangedEventArgs](/.contentcontrolselectionchangedeventargs)|[eventType](/.contentcontrolselectionchangedeventargs#word-javascript/api/word/-contentcontrolselectionchangedeventargs-eventtype-member)|The event type.| -||[ids](/.contentcontrolselectionchangedeventargs#word-javascript/api/word/-contentcontrolselectionchangedeventargs-ids-member)|Gets the content control IDs.| -||[source](/.contentcontrolselectionchangedeventargs#word-javascript/api/word/-contentcontrolselectionchangedeventargs-source-member)|The source of the event.| -|[Document](/.document)|[addStyle(name: string, type: Word.StyleType)](/.document#word-javascript/api/word/-document-addstyle-member(1))|Adds a style into the document by name and type.| -||[close(closeBehavior?: Word.CloseBehavior)](/.document#word-javascript/api/word/-document-close-member(1))|Closes the current document.| -||[getContentControls(options?: Word.ContentControlOptions)](/.document#word-javascript/api/word/-document-getcontentcontrols-member(1))|Gets the currently supported content controls in the document.| -||[getEndnoteBody()](/.document#word-javascript/api/word/-document-getendnotebody-member(1))|Gets the document's endnotes in a single body.| -||[getFootnoteBody()](/.document#word-javascript/api/word/-document-getfootnotebody-member(1))|Gets the document's footnotes in a single body.| -||[getStyles()](/.document#word-javascript/api/word/-document-getstyles-member(1))|Gets a StyleCollection object that represents the whole style set of the document.| -||[insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End", insertFileOptions?: Word.InsertFileOptions)](/.document#word-javascript/api/word/-document-insertfilefrombase64-member(1))|Inserts a document into the target document at a specific location with additional properties.| -||[onContentControlAdded](/.document#word-javascript/api/word/-document-oncontentcontroladded-member)|Occurs when a content control is added.| -|[Field](/.field)|[data](/.field#word-javascript/api/word/-field-data-member)|Specifies data in an "Addin" field.| -||[delete()](/.field#word-javascript/api/word/-field-delete-member(1))|Deletes the field.| -||[kind](/.field#word-javascript/api/word/-field-kind-member)|Gets the field's kind.| -||[locked](/.field#word-javascript/api/word/-field-locked-member)|Specifies whether the field is locked.| -||[select(selectionMode?: Word.SelectionMode)](/.field#word-javascript/api/word/-field-select-member(1))|Selects the field.| -||[type](/.field#word-javascript/api/word/-field-type-member)|Gets the field's type.| -||[updateResult()](/.field#word-javascript/api/word/-field-updateresult-member(1))|Updates the field.| -|[FieldCollection](/.fieldcollection)|[getByTypes(types: Word.FieldType[])](/.fieldcollection#word-javascript/api/word/-fieldcollection-getbytypes-member(1))|Gets the Field object collection including the specified types of fields.| -|[InsertFileOptions](/.insertfileoptions)|[importChangeTrackingMode](/.insertfileoptions#word-javascript/api/word/-insertfileoptions-importchangetrackingmode-member)|Represents whether the change tracking mode status from the source document should be imported.| -||[importPageColor](/.insertfileoptions#word-javascript/api/word/-insertfileoptions-importpagecolor-member)|Represents whether the page color and other background information from the source document should be imported.| -||[importParagraphSpacing](/.insertfileoptions#word-javascript/api/word/-insertfileoptions-importparagraphspacing-member)|Represents whether the paragraph spacing from the source document should be imported.| -||[importStyles](/.insertfileoptions#word-javascript/api/word/-insertfileoptions-importstyles-member)|Represents whether the styles from the source document should be imported.| -||[importTheme](/.insertfileoptions#word-javascript/api/word/-insertfileoptions-importtheme-member)|Represents whether the theme from the source document should be imported.| -|[NoteItem](/.noteitem)|[body](/.noteitem#word-javascript/api/word/-noteitem-body-member)|Represents the body object of the note item.| -||[delete()](/.noteitem#word-javascript/api/word/-noteitem-delete-member(1))|Deletes the note item.| -||[getNext()](/.noteitem#word-javascript/api/word/-noteitem-getnext-member(1))|Gets the next note item of the same type.| -||[getNextOrNullObject()](/.noteitem#word-javascript/api/word/-noteitem-getnextornullobject-member(1))|Gets the next note item of the same type.| -||[reference](/.noteitem#word-javascript/api/word/-noteitem-reference-member)|Represents a footnote or endnote reference in the main document.| -||[type](/.noteitem#word-javascript/api/word/-noteitem-type-member)|Represents the note item type: footnote or endnote.| -|[NoteItemCollection](/.noteitemcollection)|[getFirst()](/.noteitemcollection#word-javascript/api/word/-noteitemcollection-getfirst-member(1))|Gets the first note item in this collection.| -||[getFirstOrNullObject()](/.noteitemcollection#word-javascript/api/word/-noteitemcollection-getfirstornullobject-member(1))|Gets the first note item in this collection.| -||[items](/.noteitemcollection#word-javascript/api/word/-noteitemcollection-items-member)|Gets the loaded child items in this collection.| -|[Paragraph](/.paragraph)|[endnotes](/.paragraph#word-javascript/api/word/-paragraph-endnotes-member)|Gets the collection of endnotes in the paragraph.| -||[footnotes](/.paragraph#word-javascript/api/word/-paragraph-footnotes-member)|Gets the collection of footnotes in the paragraph.| -||[getContentControls(options?: Word.ContentControlOptions)](/.paragraph#word-javascript/api/word/-paragraph-getcontentcontrols-member(1))|Gets the currently supported content controls in the paragraph.| -|[ParagraphFormat](/.paragraphformat)|[alignment](/.paragraphformat#word-javascript/api/word/-paragraphformat-alignment-member)|Specifies the alignment for the specified paragraphs.| -||[firstLineIndent](/.paragraphformat#word-javascript/api/word/-paragraphformat-firstlineindent-member)|Specifies the value (in points) for a first line or hanging indent.| -||[keepTogether](/.paragraphformat#word-javascript/api/word/-paragraphformat-keeptogether-member)|Specifies whether all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document.| -||[keepWithNext](/.paragraphformat#word-javascript/api/word/-paragraphformat-keepwithnext-member)|Specifies whether the specified paragraph remains on the same page as the paragraph that follows it when Microsoft Word repaginates the document.| -||[leftIndent](/.paragraphformat#word-javascript/api/word/-paragraphformat-leftindent-member)|Specifies the left indent.| -||[lineSpacing](/.paragraphformat#word-javascript/api/word/-paragraphformat-linespacing-member)|Specifies the line spacing (in points) for the specified paragraphs.| -||[lineUnitAfter](/.paragraphformat#word-javascript/api/word/-paragraphformat-lineunitafter-member)|Specifies the amount of spacing (in gridlines) after the specified paragraphs.| -||[lineUnitBefore](/.paragraphformat#word-javascript/api/word/-paragraphformat-lineunitbefore-member)|Specifies the amount of spacing (in gridlines) before the specified paragraphs.| -||[mirrorIndents](/.paragraphformat#word-javascript/api/word/-paragraphformat-mirrorindents-member)|Specifies whether left and right indents are the same width.| -||[outlineLevel](/.paragraphformat#word-javascript/api/word/-paragraphformat-outlinelevel-member)|Specifies the outline level for the specified paragraphs.| -||[rightIndent](/.paragraphformat#word-javascript/api/word/-paragraphformat-rightindent-member)|Specifies the right indent (in points) for the specified paragraphs.| -||[spaceAfter](/.paragraphformat#word-javascript/api/word/-paragraphformat-spaceafter-member)|Specifies the amount of spacing (in points) after the specified paragraph or text column.| -||[spaceBefore](/.paragraphformat#word-javascript/api/word/-paragraphformat-spacebefore-member)|Specifies the spacing (in points) before the specified paragraphs.| -||[widowControl](/.paragraphformat#word-javascript/api/word/-paragraphformat-widowcontrol-member)|Specifies whether the first and last lines in the specified paragraph remain on the same page as the rest of the paragraph when Microsoft Word repaginates the document.| -|[Range](/.range)|[endnotes](/.range#word-javascript/api/word/-range-endnotes-member)|Gets the collection of endnotes in the range.| -||[footnotes](/.range#word-javascript/api/word/-range-footnotes-member)|Gets the collection of footnotes in the range.| -||[getContentControls(options?: Word.ContentControlOptions)](/.range#word-javascript/api/word/-range-getcontentcontrols-member(1))|Gets the currently supported content controls in the range.| -||[insertEndnote(insertText?: string)](/.range#word-javascript/api/word/-range-insertendnote-member(1))|Inserts an endnote.| -||[insertField(insertLocation: Word.InsertLocation \| "Replace" \| "Start" \| "End" \| "Before" \| "After", fieldType?: Word.FieldType, text?: string, removeFormatting?: boolean)](/.range#word-javascript/api/word/-range-insertfield-member(1))|Inserts a field at the specified location.| -||[insertFootnote(insertText?: string)](/.range#word-javascript/api/word/-range-insertfootnote-member(1))|Inserts a footnote.| -|[Style](/.style)|[baseStyle](/.style#word-javascript/api/word/-style-basestyle-member)|Specifies the name of an existing style to use as the base formatting of another style.| -||[builtIn](/.style#word-javascript/api/word/-style-builtin-member)|Gets whether the specified style is a built-in style.| -||[delete()](/.style#word-javascript/api/word/-style-delete-member(1))|Deletes the style.| -||[font](/.style#word-javascript/api/word/-style-font-member)|Gets a font object that represents the character formatting of the specified style.| -||[inUse](/.style#word-javascript/api/word/-style-inuse-member)|Gets whether the specified style is a built-in style that has been modified or applied in the document or a new style that has been created in the document.| -||[linked](/.style#word-javascript/api/word/-style-linked-member)|Gets whether a style is a linked style that can be used for both paragraph and character formatting.| -||[nameLocal](/.style#word-javascript/api/word/-style-namelocal-member)|Gets the name of a style in the language of the user.| -||[nextParagraphStyle](/.style#word-javascript/api/word/-style-nextparagraphstyle-member)|Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style.| -||[paragraphFormat](/.style#word-javascript/api/word/-style-paragraphformat-member)|Gets a ParagraphFormat object that represents the paragraph settings for the specified style.| -||[priority](/.style#word-javascript/api/word/-style-priority-member)|Specifies the priority.| -||[quickStyle](/.style#word-javascript/api/word/-style-quickstyle-member)|Specifies whether the style corresponds to an available quick style.| -||[type](/.style#word-javascript/api/word/-style-type-member)|Gets the style type.| -||[unhideWhenUsed](/.style#word-javascript/api/word/-style-unhidewhenused-member)|Specifies whether the specified style is made visible as a recommended style in the Styles and in the Styles task pane in Microsoft Word after it's used in the document.| -||[visibility](/.style#word-javascript/api/word/-style-visibility-member)|Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane.| -|[StyleCollection](/.stylecollection)|[getByName(name: string)](/.stylecollection#word-javascript/api/word/-stylecollection-getbyname-member(1))|Get the style object by its name.| -||[getByNameOrNullObject(name: string)](/.stylecollection#word-javascript/api/word/-stylecollection-getbynameornullobject-member(1))|If the corresponding style doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.| -||[getCount()](/.stylecollection#word-javascript/api/word/-stylecollection-getcount-member(1))|Gets the number of the styles in the collection.| -||[getItem(index: number)](/.stylecollection#word-javascript/api/word/-stylecollection-getitem-member(1))|Gets a style object by its index in the collection.| -||[items](/.stylecollection#word-javascript/api/word/-stylecollection-items-member)|Gets the loaded child items in this collection.| -|[Table](/.table)|[endnotes](/.table#word-javascript/api/word/-table-endnotes-member)|Gets the collection of endnotes in the table.| -||[footnotes](/.table#word-javascript/api/word/-table-footnotes-member)|Gets the collection of footnotes in the table.| -|[TableRow](/.tablerow)|[endnotes](/.tablerow#word-javascript/api/word/-tablerow-endnotes-member)|Gets the collection of endnotes in the table row.| -||[footnotes](/.tablerow#word-javascript/api/word/-tablerow-footnotes-member)|Gets the collection of footnotes in the table row.| +|[Application](/javascript/api/word/word.application)|[retrieveStylesFromBase64(base64File: string)](/javascript/api/word/word.application#word-word-application-retrievestylesfrombase64-member(1))|Parse styles from template Base64 file and return JSON format of retrieved styles as a string.| +|[Body](/javascript/api/word/word.body)|[endnotes](/javascript/api/word/word.body#word-word-body-endnotes-member)|Gets the collection of endnotes in the body.| +||[footnotes](/javascript/api/word/word.body#word-word-body-footnotes-member)|Gets the collection of footnotes in the body.| +||[getContentControls(options?: Word.ContentControlOptions)](/javascript/api/word/word.body#word-word-body-getcontentcontrols-member(1))|Gets the currently supported content controls in the body.| +|[ContentControl](/javascript/api/word/word.contentcontrol)|[endnotes](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-endnotes-member)|Gets the collection of endnotes in the content control.| +||[footnotes](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-footnotes-member)|Gets the collection of footnotes in the content control.| +||[getContentControls(options?: Word.ContentControlOptions)](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-getcontentcontrols-member(1))|Gets the currently supported child content controls in this content control.| +||[onDataChanged](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-ondatachanged-member)|Occurs when data within the content control are changed.| +||[onDeleted](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-ondeleted-member)|Occurs when the content control is deleted.| +||[onEntered](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-onentered-member)|Occurs when the content control is entered.| +||[onExited](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-onexited-member)|Occurs when the content control is exited, for example, when the cursor leaves the content control.| +||[onSelectionChanged](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-onselectionchanged-member)|Occurs when selection within the content control is changed.| +|[ContentControlAddedEventArgs](/javascript/api/word/word.contentcontroladdedeventargs)|[eventType](/javascript/api/word/word.contentcontroladdedeventargs#word-word-contentcontroladdedeventargs-eventtype-member)|The event type.| +||[ids](/javascript/api/word/word.contentcontroladdedeventargs#word-word-contentcontroladdedeventargs-ids-member)|Gets the content control IDs.| +||[source](/javascript/api/word/word.contentcontroladdedeventargs#word-word-contentcontroladdedeventargs-source-member)|The source of the event.| +|[ContentControlCollection](/javascript/api/word/word.contentcontrolcollection)|[getByChangeTrackingStates(changeTrackingStates: Word.ChangeTrackingState[])](/javascript/api/word/word.contentcontrolcollection#word-word-contentcontrolcollection-getbychangetrackingstates-member(1))|Gets the content controls that have the specified tracking state.| +|[ContentControlDataChangedEventArgs](/javascript/api/word/word.contentcontroldatachangedeventargs)|[eventType](/javascript/api/word/word.contentcontroldatachangedeventargs#word-word-contentcontroldatachangedeventargs-eventtype-member)|The event type.| +||[ids](/javascript/api/word/word.contentcontroldatachangedeventargs#word-word-contentcontroldatachangedeventargs-ids-member)|Gets the content control IDs.| +||[source](/javascript/api/word/word.contentcontroldatachangedeventargs#word-word-contentcontroldatachangedeventargs-source-member)|The source of the event.| +|[ContentControlDeletedEventArgs](/javascript/api/word/word.contentcontroldeletedeventargs)|[eventType](/javascript/api/word/word.contentcontroldeletedeventargs#word-word-contentcontroldeletedeventargs-eventtype-member)|The event type.| +||[ids](/javascript/api/word/word.contentcontroldeletedeventargs#word-word-contentcontroldeletedeventargs-ids-member)|Gets the content control IDs.| +||[source](/javascript/api/word/word.contentcontroldeletedeventargs#word-word-contentcontroldeletedeventargs-source-member)|The source of the event.| +|[ContentControlEnteredEventArgs](/javascript/api/word/word.contentcontrolenteredeventargs)|[eventType](/javascript/api/word/word.contentcontrolenteredeventargs#word-word-contentcontrolenteredeventargs-eventtype-member)|The event type.| +||[ids](/javascript/api/word/word.contentcontrolenteredeventargs#word-word-contentcontrolenteredeventargs-ids-member)|Gets the content control IDs.| +||[source](/javascript/api/word/word.contentcontrolenteredeventargs#word-word-contentcontrolenteredeventargs-source-member)|The source of the event.| +|[ContentControlExitedEventArgs](/javascript/api/word/word.contentcontrolexitedeventargs)|[eventType](/javascript/api/word/word.contentcontrolexitedeventargs#word-word-contentcontrolexitedeventargs-eventtype-member)|The event type.| +||[ids](/javascript/api/word/word.contentcontrolexitedeventargs#word-word-contentcontrolexitedeventargs-ids-member)|Gets the content control IDs.| +||[source](/javascript/api/word/word.contentcontrolexitedeventargs#word-word-contentcontrolexitedeventargs-source-member)|The source of the event.| +|[ContentControlOptions](/javascript/api/word/word.contentcontroloptions)|[types](/javascript/api/word/word.contentcontroloptions#word-word-contentcontroloptions-types-member)|An array of content control types, item must be 'RichText', 'PlainText', 'CheckBox', 'DropDownList', or 'ComboBox'.| +|[ContentControlSelectionChangedEventArgs](/javascript/api/word/word.contentcontrolselectionchangedeventargs)|[eventType](/javascript/api/word/word.contentcontrolselectionchangedeventargs#word-word-contentcontrolselectionchangedeventargs-eventtype-member)|The event type.| +||[ids](/javascript/api/word/word.contentcontrolselectionchangedeventargs#word-word-contentcontrolselectionchangedeventargs-ids-member)|Gets the content control IDs.| +||[source](/javascript/api/word/word.contentcontrolselectionchangedeventargs#word-word-contentcontrolselectionchangedeventargs-source-member)|The source of the event.| +|[Document](/javascript/api/word/word.document)|[addStyle(name: string, type: Word.StyleType)](/javascript/api/word/word.document#word-word-document-addstyle-member(1))|Adds a style into the document by name and type.| +||[close(closeBehavior?: Word.CloseBehavior)](/javascript/api/word/word.document#word-word-document-close-member(1))|Closes the current document.| +||[getContentControls(options?: Word.ContentControlOptions)](/javascript/api/word/word.document#word-word-document-getcontentcontrols-member(1))|Gets the currently supported content controls in the document.| +||[getEndnoteBody()](/javascript/api/word/word.document#word-word-document-getendnotebody-member(1))|Gets the document's endnotes in a single body.| +||[getFootnoteBody()](/javascript/api/word/word.document#word-word-document-getfootnotebody-member(1))|Gets the document's footnotes in a single body.| +||[getStyles()](/javascript/api/word/word.document#word-word-document-getstyles-member(1))|Gets a StyleCollection object that represents the whole style set of the document.| +||[insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End", insertFileOptions?: Word.InsertFileOptions)](/javascript/api/word/word.document#word-word-document-insertfilefrombase64-member(1))|Inserts a document into the target document at a specific location with additional properties.| +||[onContentControlAdded](/javascript/api/word/word.document#word-word-document-oncontentcontroladded-member)|Occurs when a content control is added.| +|[Field](/javascript/api/word/word.field)|[data](/javascript/api/word/word.field#word-word-field-data-member)|Specifies data in an "Addin" field.| +||[delete()](/javascript/api/word/word.field#word-word-field-delete-member(1))|Deletes the field.| +||[kind](/javascript/api/word/word.field#word-word-field-kind-member)|Gets the field's kind.| +||[locked](/javascript/api/word/word.field#word-word-field-locked-member)|Specifies whether the field is locked.| +||[select(selectionMode?: Word.SelectionMode)](/javascript/api/word/word.field#word-word-field-select-member(1))|Selects the field.| +||[type](/javascript/api/word/word.field#word-word-field-type-member)|Gets the field's type.| +||[updateResult()](/javascript/api/word/word.field#word-word-field-updateresult-member(1))|Updates the field.| +|[FieldCollection](/javascript/api/word/word.fieldcollection)|[getByTypes(types: Word.FieldType[])](/javascript/api/word/word.fieldcollection#word-word-fieldcollection-getbytypes-member(1))|Gets the Field object collection including the specified types of fields.| +|[InsertFileOptions](/javascript/api/word/word.insertfileoptions)|[importChangeTrackingMode](/javascript/api/word/word.insertfileoptions#word-word-insertfileoptions-importchangetrackingmode-member)|Represents whether the change tracking mode status from the source document should be imported.| +||[importPageColor](/javascript/api/word/word.insertfileoptions#word-word-insertfileoptions-importpagecolor-member)|Represents whether the page color and other background information from the source document should be imported.| +||[importParagraphSpacing](/javascript/api/word/word.insertfileoptions#word-word-insertfileoptions-importparagraphspacing-member)|Represents whether the paragraph spacing from the source document should be imported.| +||[importStyles](/javascript/api/word/word.insertfileoptions#word-word-insertfileoptions-importstyles-member)|Represents whether the styles from the source document should be imported.| +||[importTheme](/javascript/api/word/word.insertfileoptions#word-word-insertfileoptions-importtheme-member)|Represents whether the theme from the source document should be imported.| +|[NoteItem](/javascript/api/word/word.noteitem)|[body](/javascript/api/word/word.noteitem#word-word-noteitem-body-member)|Represents the body object of the note item.| +||[delete()](/javascript/api/word/word.noteitem#word-word-noteitem-delete-member(1))|Deletes the note item.| +||[getNext()](/javascript/api/word/word.noteitem#word-word-noteitem-getnext-member(1))|Gets the next note item of the same type.| +||[getNextOrNullObject()](/javascript/api/word/word.noteitem#word-word-noteitem-getnextornullobject-member(1))|Gets the next note item of the same type.| +||[reference](/javascript/api/word/word.noteitem#word-word-noteitem-reference-member)|Represents a footnote or endnote reference in the main document.| +||[type](/javascript/api/word/word.noteitem#word-word-noteitem-type-member)|Represents the note item type: footnote or endnote.| +|[NoteItemCollection](/javascript/api/word/word.noteitemcollection)|[getFirst()](/javascript/api/word/word.noteitemcollection#word-word-noteitemcollection-getfirst-member(1))|Gets the first note item in this collection.| +||[getFirstOrNullObject()](/javascript/api/word/word.noteitemcollection#word-word-noteitemcollection-getfirstornullobject-member(1))|Gets the first note item in this collection.| +||[items](/javascript/api/word/word.noteitemcollection#word-word-noteitemcollection-items-member)|Gets the loaded child items in this collection.| +|[Paragraph](/javascript/api/word/word.paragraph)|[endnotes](/javascript/api/word/word.paragraph#word-word-paragraph-endnotes-member)|Gets the collection of endnotes in the paragraph.| +||[footnotes](/javascript/api/word/word.paragraph#word-word-paragraph-footnotes-member)|Gets the collection of footnotes in the paragraph.| +||[getContentControls(options?: Word.ContentControlOptions)](/javascript/api/word/word.paragraph#word-word-paragraph-getcontentcontrols-member(1))|Gets the currently supported content controls in the paragraph.| +|[ParagraphFormat](/javascript/api/word/word.paragraphformat)|[alignment](/javascript/api/word/word.paragraphformat#word-word-paragraphformat-alignment-member)|Specifies the alignment for the specified paragraphs.| +||[firstLineIndent](/javascript/api/word/word.paragraphformat#word-word-paragraphformat-firstlineindent-member)|Specifies the value (in points) for a first line or hanging indent.| +||[keepTogether](/javascript/api/word/word.paragraphformat#word-word-paragraphformat-keeptogether-member)|Specifies whether all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document.| +||[keepWithNext](/javascript/api/word/word.paragraphformat#word-word-paragraphformat-keepwithnext-member)|Specifies whether the specified paragraph remains on the same page as the paragraph that follows it when Microsoft Word repaginates the document.| +||[leftIndent](/javascript/api/word/word.paragraphformat#word-word-paragraphformat-leftindent-member)|Specifies the left indent.| +||[lineSpacing](/javascript/api/word/word.paragraphformat#word-word-paragraphformat-linespacing-member)|Specifies the line spacing (in points) for the specified paragraphs.| +||[lineUnitAfter](/javascript/api/word/word.paragraphformat#word-word-paragraphformat-lineunitafter-member)|Specifies the amount of spacing (in gridlines) after the specified paragraphs.| +||[lineUnitBefore](/javascript/api/word/word.paragraphformat#word-word-paragraphformat-lineunitbefore-member)|Specifies the amount of spacing (in gridlines) before the specified paragraphs.| +||[mirrorIndents](/javascript/api/word/word.paragraphformat#word-word-paragraphformat-mirrorindents-member)|Specifies whether left and right indents are the same width.| +||[outlineLevel](/javascript/api/word/word.paragraphformat#word-word-paragraphformat-outlinelevel-member)|Specifies the outline level for the specified paragraphs.| +||[rightIndent](/javascript/api/word/word.paragraphformat#word-word-paragraphformat-rightindent-member)|Specifies the right indent (in points) for the specified paragraphs.| +||[spaceAfter](/javascript/api/word/word.paragraphformat#word-word-paragraphformat-spaceafter-member)|Specifies the amount of spacing (in points) after the specified paragraph or text column.| +||[spaceBefore](/javascript/api/word/word.paragraphformat#word-word-paragraphformat-spacebefore-member)|Specifies the spacing (in points) before the specified paragraphs.| +||[widowControl](/javascript/api/word/word.paragraphformat#word-word-paragraphformat-widowcontrol-member)|Specifies whether the first and last lines in the specified paragraph remain on the same page as the rest of the paragraph when Microsoft Word repaginates the document.| +|[Range](/javascript/api/word/word.range)|[endnotes](/javascript/api/word/word.range#word-word-range-endnotes-member)|Gets the collection of endnotes in the range.| +||[footnotes](/javascript/api/word/word.range#word-word-range-footnotes-member)|Gets the collection of footnotes in the range.| +||[getContentControls(options?: Word.ContentControlOptions)](/javascript/api/word/word.range#word-word-range-getcontentcontrols-member(1))|Gets the currently supported content controls in the range.| +||[insertEndnote(insertText?: string)](/javascript/api/word/word.range#word-word-range-insertendnote-member(1))|Inserts an endnote.| +||[insertField(insertLocation: Word.InsertLocation \| "Replace" \| "Start" \| "End" \| "Before" \| "After", fieldType?: Word.FieldType, text?: string, removeFormatting?: boolean)](/javascript/api/word/word.range#word-word-range-insertfield-member(1))|Inserts a field at the specified location.| +||[insertFootnote(insertText?: string)](/javascript/api/word/word.range#word-word-range-insertfootnote-member(1))|Inserts a footnote.| +|[Style](/javascript/api/word/word.style)|[baseStyle](/javascript/api/word/word.style#word-word-style-basestyle-member)|Specifies the name of an existing style to use as the base formatting of another style.| +||[builtIn](/javascript/api/word/word.style#word-word-style-builtin-member)|Gets whether the specified style is a built-in style.| +||[delete()](/javascript/api/word/word.style#word-word-style-delete-member(1))|Deletes the style.| +||[font](/javascript/api/word/word.style#word-word-style-font-member)|Gets a font object that represents the character formatting of the specified style.| +||[inUse](/javascript/api/word/word.style#word-word-style-inuse-member)|Gets whether the specified style is a built-in style that has been modified or applied in the document or a new style that has been created in the document.| +||[linked](/javascript/api/word/word.style#word-word-style-linked-member)|Gets whether a style is a linked style that can be used for both paragraph and character formatting.| +||[nameLocal](/javascript/api/word/word.style#word-word-style-namelocal-member)|Gets the name of a style in the language of the user.| +||[nextParagraphStyle](/javascript/api/word/word.style#word-word-style-nextparagraphstyle-member)|Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style.| +||[paragraphFormat](/javascript/api/word/word.style#word-word-style-paragraphformat-member)|Gets a ParagraphFormat object that represents the paragraph settings for the specified style.| +||[priority](/javascript/api/word/word.style#word-word-style-priority-member)|Specifies the priority.| +||[quickStyle](/javascript/api/word/word.style#word-word-style-quickstyle-member)|Specifies whether the style corresponds to an available quick style.| +||[type](/javascript/api/word/word.style#word-word-style-type-member)|Gets the style type.| +||[unhideWhenUsed](/javascript/api/word/word.style#word-word-style-unhidewhenused-member)|Specifies whether the specified style is made visible as a recommended style in the Styles and in the Styles task pane in Microsoft Word after it's used in the document.| +||[visibility](/javascript/api/word/word.style#word-word-style-visibility-member)|Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane.| +|[StyleCollection](/javascript/api/word/word.stylecollection)|[getByName(name: string)](/javascript/api/word/word.stylecollection#word-word-stylecollection-getbyname-member(1))|Get the style object by its name.| +||[getByNameOrNullObject(name: string)](/javascript/api/word/word.stylecollection#word-word-stylecollection-getbynameornullobject-member(1))|If the corresponding style doesn't exist, then this method returns an object with its `isNullObject` property set to `true`.| +||[getCount()](/javascript/api/word/word.stylecollection#word-word-stylecollection-getcount-member(1))|Gets the number of the styles in the collection.| +||[getItem(index: number)](/javascript/api/word/word.stylecollection#word-word-stylecollection-getitem-member(1))|Gets a style object by its index in the collection.| +||[items](/javascript/api/word/word.stylecollection#word-word-stylecollection-items-member)|Gets the loaded child items in this collection.| +|[Table](/javascript/api/word/word.table)|[endnotes](/javascript/api/word/word.table#word-word-table-endnotes-member)|Gets the collection of endnotes in the table.| +||[footnotes](/javascript/api/word/word.table#word-word-table-footnotes-member)|Gets the collection of footnotes in the table.| +|[TableRow](/javascript/api/word/word.tablerow)|[endnotes](/javascript/api/word/word.tablerow#word-word-tablerow-endnotes-member)|Gets the collection of endnotes in the table row.| +||[footnotes](/javascript/api/word/word.tablerow#word-word-tablerow-footnotes-member)|Gets the collection of footnotes in the table row.| diff --git a/docs/includes/word-1_5_hidden_document.md b/docs/includes/word-1_5_hidden_document.md index 7cfda2baca..e27707ab9c 100644 --- a/docs/includes/word-1_5_hidden_document.md +++ b/docs/includes/word-1_5_hidden_document.md @@ -1,6 +1,6 @@ | Class | Fields | Description | |:---|:---|:---| -|[DocumentCreated](/.documentcreated)|[addStyle(name: string, type: Word.StyleType)](/.documentcreated#word-javascript/api/word/-documentcreated-addstyle-member(1))|Adds a style into the document by name and type.| -||[getContentControls(options?: Word.ContentControlOptions)](/.documentcreated#word-javascript/api/word/-documentcreated-getcontentcontrols-member(1))|Gets the currently supported content controls in the document.| -||[getStyles()](/.documentcreated#word-javascript/api/word/-documentcreated-getstyles-member(1))|Gets a StyleCollection object that represents the whole style set of the document.| -||[insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End", insertFileOptions?: Word.InsertFileOptions)](/.documentcreated#word-javascript/api/word/-documentcreated-insertfilefrombase64-member(1))|Inserts a document into the target document at a specific location with additional properties.| +|[DocumentCreated](/javascript/api/word/word.documentcreated)|[addStyle(name: string, type: Word.StyleType)](/javascript/api/word/word.documentcreated#word-word-documentcreated-addstyle-member(1))|Adds a style into the document by name and type.| +||[getContentControls(options?: Word.ContentControlOptions)](/javascript/api/word/word.documentcreated#word-word-documentcreated-getcontentcontrols-member(1))|Gets the currently supported content controls in the document.| +||[getStyles()](/javascript/api/word/word.documentcreated#word-word-documentcreated-getstyles-member(1))|Gets a StyleCollection object that represents the whole style set of the document.| +||[insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace \| Word.InsertLocation.start \| Word.InsertLocation.end \| "Replace" \| "Start" \| "End", insertFileOptions?: Word.InsertFileOptions)](/javascript/api/word/word.documentcreated#word-word-documentcreated-insertfilefrombase64-member(1))|Inserts a document into the target document at a specific location with additional properties.| diff --git a/docs/includes/word-1_6.md b/docs/includes/word-1_6.md index da729510e2..96e7bceabf 100644 --- a/docs/includes/word-1_6.md +++ b/docs/includes/word-1_6.md @@ -1,46 +1,46 @@ | Class | Fields | Description | |:---|:---|:---| -|[Application](/.application)|[openDocument(filePath: string)](/.application#word-javascript/api/word/-application-opendocument-member(1))|Opens a document and displays it in a new tab or window.| -|[Body](/.body)|[getTrackedChanges()](/.body#word-javascript/api/word/-body-gettrackedchanges-member(1))|Gets the collection of the TrackedChange objects in the body.| -|[ContentControl](/.contentcontrol)|[getTrackedChanges()](/.contentcontrol#word-javascript/api/word/-contentcontrol-gettrackedchanges-member(1))|Gets the collection of the TrackedChange objects in the content control.| -|[Document](/.document)|[getParagraphByUniqueLocalId(id: string)](/.document#word-javascript/api/word/-document-getparagraphbyuniquelocalid-member(1))|Gets the paragraph by its unique local ID.| -||[importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior)](/.document#word-javascript/api/word/-document-importstylesfromjson-member(1))|Import styles from a JSON-formatted string.| -||[onParagraphAdded](/.document#word-javascript/api/word/-document-onparagraphadded-member)|Occurs when the user adds new paragraphs.| -||[onParagraphChanged](/.document#word-javascript/api/word/-document-onparagraphchanged-member)|Occurs when the user changes paragraphs.| -||[onParagraphDeleted](/.document#word-javascript/api/word/-document-onparagraphdeleted-member)|Occurs when the user deletes paragraphs.| -|[InsertFileOptions](/.insertfileoptions)|[importCustomProperties](/.insertfileoptions#word-javascript/api/word/-insertfileoptions-importcustomproperties-member)|Represents whether the custom properties from the source document should be imported.| -||[importCustomXmlParts](/.insertfileoptions#word-javascript/api/word/-insertfileoptions-importcustomxmlparts-member)|Represents whether the custom XML parts from the source document should be imported.| -|[Paragraph](/.paragraph)|[getTrackedChanges()](/.paragraph#word-javascript/api/word/-paragraph-gettrackedchanges-member(1))|Gets the collection of the TrackedChange objects in the paragraph.| -||[uniqueLocalId](/.paragraph#word-javascript/api/word/-paragraph-uniquelocalid-member)|Gets a string that represents the paragraph identifier in the current session.| -|[ParagraphAddedEventArgs](/.paragraphaddedeventargs)|[source](/.paragraphaddedeventargs#word-javascript/api/word/-paragraphaddedeventargs-source-member)|The source of the event.| -||[type](/.paragraphaddedeventargs#word-javascript/api/word/-paragraphaddedeventargs-type-member)|The event type.| -||[uniqueLocalIds](/.paragraphaddedeventargs#word-javascript/api/word/-paragraphaddedeventargs-uniquelocalids-member)|Gets the unique IDs of the involved paragraphs.| -|[ParagraphChangedEventArgs](/.paragraphchangedeventargs)|[source](/.paragraphchangedeventargs#word-javascript/api/word/-paragraphchangedeventargs-source-member)|The source of the event.| -||[type](/.paragraphchangedeventargs#word-javascript/api/word/-paragraphchangedeventargs-type-member)|The event type.| -||[uniqueLocalIds](/.paragraphchangedeventargs#word-javascript/api/word/-paragraphchangedeventargs-uniquelocalids-member)|Gets the unique IDs of the involved paragraphs.| -|[ParagraphDeletedEventArgs](/.paragraphdeletedeventargs)|[source](/.paragraphdeletedeventargs#word-javascript/api/word/-paragraphdeletedeventargs-source-member)|The source of the event.| -||[type](/.paragraphdeletedeventargs#word-javascript/api/word/-paragraphdeletedeventargs-type-member)|The event type.| -||[uniqueLocalIds](/.paragraphdeletedeventargs#word-javascript/api/word/-paragraphdeletedeventargs-uniquelocalids-member)|Gets the unique IDs of the involved paragraphs.| -|[Range](/.range)|[getTrackedChanges()](/.range#word-javascript/api/word/-range-gettrackedchanges-member(1))|Gets the collection of the TrackedChange objects in the range.| -|[Shading](/.shading)|[backgroundPatternColor](/.shading#word-javascript/api/word/-shading-backgroundpatterncolor-member)|Specifies the color for the background of the object.| -|[Style](/.style)|[shading](/.style#word-javascript/api/word/-style-shading-member)|Gets a Shading object that represents the shading for the specified style.| -||[tableStyle](/.style#word-javascript/api/word/-style-tablestyle-member)|Gets a TableStyle object representing Style properties that can be applied to a table.| -|[TableStyle](/.tablestyle)|[bottomCellMargin](/.tablestyle#word-javascript/api/word/-tablestyle-bottomcellmargin-member)|Specifies the amount of space to add between the contents and the bottom borders of the cells.| -||[cellSpacing](/.tablestyle#word-javascript/api/word/-tablestyle-cellspacing-member)|Specifies the spacing (in points) between the cells in a table style.| -||[leftCellMargin](/.tablestyle#word-javascript/api/word/-tablestyle-leftcellmargin-member)|Specifies the amount of space to add between the contents and the left borders of the cells.| -||[rightCellMargin](/.tablestyle#word-javascript/api/word/-tablestyle-rightcellmargin-member)|Specifies the amount of space to add between the contents and the right borders of the cells.| -||[topCellMargin](/.tablestyle#word-javascript/api/word/-tablestyle-topcellmargin-member)|Specifies the amount of space to add between the contents and the top borders of the cells.| -|[TrackedChange](/.trackedchange)|[accept()](/.trackedchange#word-javascript/api/word/-trackedchange-accept-member(1))|Accepts the tracked change.| -||[author](/.trackedchange#word-javascript/api/word/-trackedchange-author-member)|Gets the author of the tracked change.| -||[date](/.trackedchange#word-javascript/api/word/-trackedchange-date-member)|Gets the date of the tracked change.| -||[getNext()](/.trackedchange#word-javascript/api/word/-trackedchange-getnext-member(1))|Gets the next tracked change.| -||[getNextOrNullObject()](/.trackedchange#word-javascript/api/word/-trackedchange-getnextornullobject-member(1))|Gets the next tracked change.| -||[getRange(rangeLocation?: Word.RangeLocation.whole \| Word.RangeLocation.start \| Word.RangeLocation.end \| "Whole" \| "Start" \| "End")](/.trackedchange#word-javascript/api/word/-trackedchange-getrange-member(1))|Gets the range of the tracked change.| -||[reject()](/.trackedchange#word-javascript/api/word/-trackedchange-reject-member(1))|Rejects the tracked change.| -||[text](/.trackedchange#word-javascript/api/word/-trackedchange-text-member)|Gets the text of the tracked change.| -||[type](/.trackedchange#word-javascript/api/word/-trackedchange-type-member)|Gets the type of the tracked change.| -|[TrackedChangeCollection](/.trackedchangecollection)|[acceptAll()](/.trackedchangecollection#word-javascript/api/word/-trackedchangecollection-acceptall-member(1))|Accepts all the tracked changes in the collection.| -||[getFirst()](/.trackedchangecollection#word-javascript/api/word/-trackedchangecollection-getfirst-member(1))|Gets the first TrackedChange in this collection.| -||[getFirstOrNullObject()](/.trackedchangecollection#word-javascript/api/word/-trackedchangecollection-getfirstornullobject-member(1))|Gets the first TrackedChange in this collection.| -||[items](/.trackedchangecollection#word-javascript/api/word/-trackedchangecollection-items-member)|Gets the loaded child items in this collection.| -||[rejectAll()](/.trackedchangecollection#word-javascript/api/word/-trackedchangecollection-rejectall-member(1))|Rejects all the tracked changes in the collection.| +|[Application](/javascript/api/word/word.application)|[openDocument(filePath: string)](/javascript/api/word/word.application#word-word-application-opendocument-member(1))|Opens a document and displays it in a new tab or window.| +|[Body](/javascript/api/word/word.body)|[getTrackedChanges()](/javascript/api/word/word.body#word-word-body-gettrackedchanges-member(1))|Gets the collection of the TrackedChange objects in the body.| +|[ContentControl](/javascript/api/word/word.contentcontrol)|[getTrackedChanges()](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-gettrackedchanges-member(1))|Gets the collection of the TrackedChange objects in the content control.| +|[Document](/javascript/api/word/word.document)|[getParagraphByUniqueLocalId(id: string)](/javascript/api/word/word.document#word-word-document-getparagraphbyuniquelocalid-member(1))|Gets the paragraph by its unique local ID.| +||[importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior)](/javascript/api/word/word.document#word-word-document-importstylesfromjson-member(1))|Import styles from a JSON-formatted string.| +||[onParagraphAdded](/javascript/api/word/word.document#word-word-document-onparagraphadded-member)|Occurs when the user adds new paragraphs.| +||[onParagraphChanged](/javascript/api/word/word.document#word-word-document-onparagraphchanged-member)|Occurs when the user changes paragraphs.| +||[onParagraphDeleted](/javascript/api/word/word.document#word-word-document-onparagraphdeleted-member)|Occurs when the user deletes paragraphs.| +|[InsertFileOptions](/javascript/api/word/word.insertfileoptions)|[importCustomProperties](/javascript/api/word/word.insertfileoptions#word-word-insertfileoptions-importcustomproperties-member)|Represents whether the custom properties from the source document should be imported.| +||[importCustomXmlParts](/javascript/api/word/word.insertfileoptions#word-word-insertfileoptions-importcustomxmlparts-member)|Represents whether the custom XML parts from the source document should be imported.| +|[Paragraph](/javascript/api/word/word.paragraph)|[getTrackedChanges()](/javascript/api/word/word.paragraph#word-word-paragraph-gettrackedchanges-member(1))|Gets the collection of the TrackedChange objects in the paragraph.| +||[uniqueLocalId](/javascript/api/word/word.paragraph#word-word-paragraph-uniquelocalid-member)|Gets a string that represents the paragraph identifier in the current session.| +|[ParagraphAddedEventArgs](/javascript/api/word/word.paragraphaddedeventargs)|[source](/javascript/api/word/word.paragraphaddedeventargs#word-word-paragraphaddedeventargs-source-member)|The source of the event.| +||[type](/javascript/api/word/word.paragraphaddedeventargs#word-word-paragraphaddedeventargs-type-member)|The event type.| +||[uniqueLocalIds](/javascript/api/word/word.paragraphaddedeventargs#word-word-paragraphaddedeventargs-uniquelocalids-member)|Gets the unique IDs of the involved paragraphs.| +|[ParagraphChangedEventArgs](/javascript/api/word/word.paragraphchangedeventargs)|[source](/javascript/api/word/word.paragraphchangedeventargs#word-word-paragraphchangedeventargs-source-member)|The source of the event.| +||[type](/javascript/api/word/word.paragraphchangedeventargs#word-word-paragraphchangedeventargs-type-member)|The event type.| +||[uniqueLocalIds](/javascript/api/word/word.paragraphchangedeventargs#word-word-paragraphchangedeventargs-uniquelocalids-member)|Gets the unique IDs of the involved paragraphs.| +|[ParagraphDeletedEventArgs](/javascript/api/word/word.paragraphdeletedeventargs)|[source](/javascript/api/word/word.paragraphdeletedeventargs#word-word-paragraphdeletedeventargs-source-member)|The source of the event.| +||[type](/javascript/api/word/word.paragraphdeletedeventargs#word-word-paragraphdeletedeventargs-type-member)|The event type.| +||[uniqueLocalIds](/javascript/api/word/word.paragraphdeletedeventargs#word-word-paragraphdeletedeventargs-uniquelocalids-member)|Gets the unique IDs of the involved paragraphs.| +|[Range](/javascript/api/word/word.range)|[getTrackedChanges()](/javascript/api/word/word.range#word-word-range-gettrackedchanges-member(1))|Gets the collection of the TrackedChange objects in the range.| +|[Shading](/javascript/api/word/word.shading)|[backgroundPatternColor](/javascript/api/word/word.shading#word-word-shading-backgroundpatterncolor-member)|Specifies the color for the background of the object.| +|[Style](/javascript/api/word/word.style)|[shading](/javascript/api/word/word.style#word-word-style-shading-member)|Gets a Shading object that represents the shading for the specified style.| +||[tableStyle](/javascript/api/word/word.style#word-word-style-tablestyle-member)|Gets a TableStyle object representing Style properties that can be applied to a table.| +|[TableStyle](/javascript/api/word/word.tablestyle)|[bottomCellMargin](/javascript/api/word/word.tablestyle#word-word-tablestyle-bottomcellmargin-member)|Specifies the amount of space to add between the contents and the bottom borders of the cells.| +||[cellSpacing](/javascript/api/word/word.tablestyle#word-word-tablestyle-cellspacing-member)|Specifies the spacing (in points) between the cells in a table style.| +||[leftCellMargin](/javascript/api/word/word.tablestyle#word-word-tablestyle-leftcellmargin-member)|Specifies the amount of space to add between the contents and the left borders of the cells.| +||[rightCellMargin](/javascript/api/word/word.tablestyle#word-word-tablestyle-rightcellmargin-member)|Specifies the amount of space to add between the contents and the right borders of the cells.| +||[topCellMargin](/javascript/api/word/word.tablestyle#word-word-tablestyle-topcellmargin-member)|Specifies the amount of space to add between the contents and the top borders of the cells.| +|[TrackedChange](/javascript/api/word/word.trackedchange)|[accept()](/javascript/api/word/word.trackedchange#word-word-trackedchange-accept-member(1))|Accepts the tracked change.| +||[author](/javascript/api/word/word.trackedchange#word-word-trackedchange-author-member)|Gets the author of the tracked change.| +||[date](/javascript/api/word/word.trackedchange#word-word-trackedchange-date-member)|Gets the date of the tracked change.| +||[getNext()](/javascript/api/word/word.trackedchange#word-word-trackedchange-getnext-member(1))|Gets the next tracked change.| +||[getNextOrNullObject()](/javascript/api/word/word.trackedchange#word-word-trackedchange-getnextornullobject-member(1))|Gets the next tracked change.| +||[getRange(rangeLocation?: Word.RangeLocation.whole \| Word.RangeLocation.start \| Word.RangeLocation.end \| "Whole" \| "Start" \| "End")](/javascript/api/word/word.trackedchange#word-word-trackedchange-getrange-member(1))|Gets the range of the tracked change.| +||[reject()](/javascript/api/word/word.trackedchange#word-word-trackedchange-reject-member(1))|Rejects the tracked change.| +||[text](/javascript/api/word/word.trackedchange#word-word-trackedchange-text-member)|Gets the text of the tracked change.| +||[type](/javascript/api/word/word.trackedchange#word-word-trackedchange-type-member)|Gets the type of the tracked change.| +|[TrackedChangeCollection](/javascript/api/word/word.trackedchangecollection)|[acceptAll()](/javascript/api/word/word.trackedchangecollection#word-word-trackedchangecollection-acceptall-member(1))|Accepts all the tracked changes in the collection.| +||[getFirst()](/javascript/api/word/word.trackedchangecollection#word-word-trackedchangecollection-getfirst-member(1))|Gets the first TrackedChange in this collection.| +||[getFirstOrNullObject()](/javascript/api/word/word.trackedchangecollection#word-word-trackedchangecollection-getfirstornullobject-member(1))|Gets the first TrackedChange in this collection.| +||[items](/javascript/api/word/word.trackedchangecollection#word-word-trackedchangecollection-items-member)|Gets the loaded child items in this collection.| +||[rejectAll()](/javascript/api/word/word.trackedchangecollection#word-word-trackedchangecollection-rejectall-member(1))|Rejects all the tracked changes in the collection.| diff --git a/docs/includes/word-1_7.md b/docs/includes/word-1_7.md index cdf77e66ec..883fe9cf5e 100644 --- a/docs/includes/word-1_7.md +++ b/docs/includes/word-1_7.md @@ -1,35 +1,35 @@ | Class | Fields | Description | |:---|:---|:---| -|[Annotation](/.annotation)|[critiqueAnnotation](/.annotation#word-javascript/api/word/-annotation-critiqueannotation-member)|Gets the critique annotation object.| -||[delete()](/.annotation#word-javascript/api/word/-annotation-delete-member(1))|Deletes the annotation.| -||[id](/.annotation#word-javascript/api/word/-annotation-id-member)|Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects.| -||[state](/.annotation#word-javascript/api/word/-annotation-state-member)|Gets the state of the annotation.| -|[AnnotationClickedEventArgs](/.annotationclickedeventargs)|[id](/.annotationclickedeventargs#word-javascript/api/word/-annotationclickedeventargs-id-member)|Specifies the annotation ID for which the event was fired.| -|[AnnotationCollection](/.annotationcollection)|[getFirst()](/.annotationcollection#word-javascript/api/word/-annotationcollection-getfirst-member(1))|Gets the first annotation in this collection.| -||[getFirstOrNullObject()](/.annotationcollection#word-javascript/api/word/-annotationcollection-getfirstornullobject-member(1))|Gets the first annotation in this collection.| -||[items](/.annotationcollection#word-javascript/api/word/-annotationcollection-items-member)|Gets the loaded child items in this collection.| -|[AnnotationHoveredEventArgs](/.annotationhoveredeventargs)|[id](/.annotationhoveredeventargs#word-javascript/api/word/-annotationhoveredeventargs-id-member)|Specifies the annotation ID for which the event was fired.| -|[AnnotationInsertedEventArgs](/.annotationinsertedeventargs)|[ids](/.annotationinsertedeventargs#word-javascript/api/word/-annotationinsertedeventargs-ids-member)|Specifies the annotation IDs for which the event was fired.| -|[AnnotationRemovedEventArgs](/.annotationremovedeventargs)|[ids](/.annotationremovedeventargs#word-javascript/api/word/-annotationremovedeventargs-ids-member)|Specifies the annotation IDs for which the event was fired.| -|[AnnotationSet](/.annotationset)|[critiques](/.annotationset#word-javascript/api/word/-annotationset-critiques-member)|Critiques.| -|[CheckboxContentControl](/.checkboxcontentcontrol)|[isChecked](/.checkboxcontentcontrol#word-javascript/api/word/-checkboxcontentcontrol-ischecked-member)|Specifies the current state of the checkbox.| -|[ContentControl](/.contentcontrol)|[checkboxContentControl](/.contentcontrol#word-javascript/api/word/-contentcontrol-checkboxcontentcontrol-member)|Gets the data of the content control when its type is `CheckBox`.| -|[Critique](/.critique)|[colorScheme](/.critique#word-javascript/api/word/-critique-colorscheme-member)|Specifies the color scheme of the critique.| -||[length](/.critique#word-javascript/api/word/-critique-length-member)|Specifies the length of the critique inside paragraph.| -||[start](/.critique#word-javascript/api/word/-critique-start-member)|Specifies the start index of the critique inside paragraph.| -|[CritiqueAnnotation](/.critiqueannotation)|[accept()](/.critiqueannotation#word-javascript/api/word/-critiqueannotation-accept-member(1))|Accepts the critique.| -||[critique](/.critiqueannotation#word-javascript/api/word/-critiqueannotation-critique-member)|Gets the critique that was passed when the annotation was inserted.| -||[range](/.critiqueannotation#word-javascript/api/word/-critiqueannotation-range-member)|Gets the range of text that is annotated.| -||[reject()](/.critiqueannotation#word-javascript/api/word/-critiqueannotation-reject-member(1))|Rejects the critique.| -|[Document](/.document)|[getAnnotationById(id: string)](/.document#word-javascript/api/word/-document-getannotationbyid-member(1))|Gets the annotation by ID.| -||[onAnnotationClicked](/.document#word-javascript/api/word/-document-onannotationclicked-member)|Occurs when the user clicks an annotation (or selects it using **Alt+Down**).| -||[onAnnotationHovered](/.document#word-javascript/api/word/-document-onannotationhovered-member)|Occurs when the user hovers the cursor over an annotation.| -||[onAnnotationInserted](/.document#word-javascript/api/word/-document-onannotationinserted-member)|Occurs when the user adds one or more annotations.| -||[onAnnotationRemoved](/.document#word-javascript/api/word/-document-onannotationremoved-member)|Occurs when the user deletes one or more annotations.| -||[search(searchText: string, searchOptions?: Word.SearchOptions \| { ignorePunct?: boolean ignoreSpace?: boolean matchCase?: boolean matchPrefix?: boolean matchSuffix?: boolean matchWholeWord?: boolean matchWildcards?: boolean })](/.document#word-javascript/api/word/-document-search-member(1))|Performs a search with the specified search options on the scope of the whole document.| -|[GetTextOptions](/.gettextoptions)|[includeHiddenText](/.gettextoptions#word-javascript/api/word/-gettextoptions-includehiddentext-member)|Specifies a value that indicates whether to include hidden text in the result of the GetText method.| -||[includeTextMarkedAsDeleted](/.gettextoptions#word-javascript/api/word/-gettextoptions-includetextmarkedasdeleted-member)|Specifies a value that indicates whether to include text marked as deleted in the result of the GetText method.| -|[InsertFileOptions](/.insertfileoptions)|[importDifferentOddEvenPages](/.insertfileoptions#word-javascript/api/word/-insertfileoptions-importdifferentoddevenpages-member)|Represents whether to import the Different Odd and Even Pages setting for the header and footer from the source document.| -|[Paragraph](/.paragraph)|[getAnnotations()](/.paragraph#word-javascript/api/word/-paragraph-getannotations-member(1))|Gets annotations set on this Paragraph object.| -||[getText(options?: Word.GetTextOptions \| { IncludeHiddenText?: boolean IncludeTextMarkedAsDeleted?: boolean })](/.paragraph#word-javascript/api/word/-paragraph-gettext-member(1))|Returns the text of the paragraph.| -||[insertAnnotations(annotations: Word.AnnotationSet)](/.paragraph#word-javascript/api/word/-paragraph-insertannotations-member(1))|Inserts annotations on this Paragraph object.| +|[Annotation](/javascript/api/word/word.annotation)|[critiqueAnnotation](/javascript/api/word/word.annotation#word-word-annotation-critiqueannotation-member)|Gets the critique annotation object.| +||[delete()](/javascript/api/word/word.annotation#word-word-annotation-delete-member(1))|Deletes the annotation.| +||[id](/javascript/api/word/word.annotation#word-word-annotation-id-member)|Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects.| +||[state](/javascript/api/word/word.annotation#word-word-annotation-state-member)|Gets the state of the annotation.| +|[AnnotationClickedEventArgs](/javascript/api/word/word.annotationclickedeventargs)|[id](/javascript/api/word/word.annotationclickedeventargs#word-word-annotationclickedeventargs-id-member)|Specifies the annotation ID for which the event was fired.| +|[AnnotationCollection](/javascript/api/word/word.annotationcollection)|[getFirst()](/javascript/api/word/word.annotationcollection#word-word-annotationcollection-getfirst-member(1))|Gets the first annotation in this collection.| +||[getFirstOrNullObject()](/javascript/api/word/word.annotationcollection#word-word-annotationcollection-getfirstornullobject-member(1))|Gets the first annotation in this collection.| +||[items](/javascript/api/word/word.annotationcollection#word-word-annotationcollection-items-member)|Gets the loaded child items in this collection.| +|[AnnotationHoveredEventArgs](/javascript/api/word/word.annotationhoveredeventargs)|[id](/javascript/api/word/word.annotationhoveredeventargs#word-word-annotationhoveredeventargs-id-member)|Specifies the annotation ID for which the event was fired.| +|[AnnotationInsertedEventArgs](/javascript/api/word/word.annotationinsertedeventargs)|[ids](/javascript/api/word/word.annotationinsertedeventargs#word-word-annotationinsertedeventargs-ids-member)|Specifies the annotation IDs for which the event was fired.| +|[AnnotationRemovedEventArgs](/javascript/api/word/word.annotationremovedeventargs)|[ids](/javascript/api/word/word.annotationremovedeventargs#word-word-annotationremovedeventargs-ids-member)|Specifies the annotation IDs for which the event was fired.| +|[AnnotationSet](/javascript/api/word/word.annotationset)|[critiques](/javascript/api/word/word.annotationset#word-word-annotationset-critiques-member)|Critiques.| +|[CheckboxContentControl](/javascript/api/word/word.checkboxcontentcontrol)|[isChecked](/javascript/api/word/word.checkboxcontentcontrol#word-word-checkboxcontentcontrol-ischecked-member)|Specifies the current state of the checkbox.| +|[ContentControl](/javascript/api/word/word.contentcontrol)|[checkboxContentControl](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-checkboxcontentcontrol-member)|Gets the data of the content control when its type is `CheckBox`.| +|[Critique](/javascript/api/word/word.critique)|[colorScheme](/javascript/api/word/word.critique#word-word-critique-colorscheme-member)|Specifies the color scheme of the critique.| +||[length](/javascript/api/word/word.critique#word-word-critique-length-member)|Specifies the length of the critique inside paragraph.| +||[start](/javascript/api/word/word.critique#word-word-critique-start-member)|Specifies the start index of the critique inside paragraph.| +|[CritiqueAnnotation](/javascript/api/word/word.critiqueannotation)|[accept()](/javascript/api/word/word.critiqueannotation#word-word-critiqueannotation-accept-member(1))|Accepts the critique.| +||[critique](/javascript/api/word/word.critiqueannotation#word-word-critiqueannotation-critique-member)|Gets the critique that was passed when the annotation was inserted.| +||[range](/javascript/api/word/word.critiqueannotation#word-word-critiqueannotation-range-member)|Gets the range of text that is annotated.| +||[reject()](/javascript/api/word/word.critiqueannotation#word-word-critiqueannotation-reject-member(1))|Rejects the critique.| +|[Document](/javascript/api/word/word.document)|[getAnnotationById(id: string)](/javascript/api/word/word.document#word-word-document-getannotationbyid-member(1))|Gets the annotation by ID.| +||[onAnnotationClicked](/javascript/api/word/word.document#word-word-document-onannotationclicked-member)|Occurs when the user clicks an annotation (or selects it using **Alt+Down**).| +||[onAnnotationHovered](/javascript/api/word/word.document#word-word-document-onannotationhovered-member)|Occurs when the user hovers the cursor over an annotation.| +||[onAnnotationInserted](/javascript/api/word/word.document#word-word-document-onannotationinserted-member)|Occurs when the user adds one or more annotations.| +||[onAnnotationRemoved](/javascript/api/word/word.document#word-word-document-onannotationremoved-member)|Occurs when the user deletes one or more annotations.| +||[search(searchText: string, searchOptions?: Word.SearchOptions \| { ignorePunct?: boolean ignoreSpace?: boolean matchCase?: boolean matchPrefix?: boolean matchSuffix?: boolean matchWholeWord?: boolean matchWildcards?: boolean })](/javascript/api/word/word.document#word-word-document-search-member(1))|Performs a search with the specified search options on the scope of the whole document.| +|[GetTextOptions](/javascript/api/word/word.gettextoptions)|[includeHiddenText](/javascript/api/word/word.gettextoptions#word-word-gettextoptions-includehiddentext-member)|Specifies a value that indicates whether to include hidden text in the result of the GetText method.| +||[includeTextMarkedAsDeleted](/javascript/api/word/word.gettextoptions#word-word-gettextoptions-includetextmarkedasdeleted-member)|Specifies a value that indicates whether to include text marked as deleted in the result of the GetText method.| +|[InsertFileOptions](/javascript/api/word/word.insertfileoptions)|[importDifferentOddEvenPages](/javascript/api/word/word.insertfileoptions#word-word-insertfileoptions-importdifferentoddevenpages-member)|Represents whether to import the Different Odd and Even Pages setting for the header and footer from the source document.| +|[Paragraph](/javascript/api/word/word.paragraph)|[getAnnotations()](/javascript/api/word/word.paragraph#word-word-paragraph-getannotations-member(1))|Gets annotations set on this Paragraph object.| +||[getText(options?: Word.GetTextOptions \| { IncludeHiddenText?: boolean IncludeTextMarkedAsDeleted?: boolean })](/javascript/api/word/word.paragraph#word-word-paragraph-gettext-member(1))|Returns the text of the paragraph.| +||[insertAnnotations(annotations: Word.AnnotationSet)](/javascript/api/word/word.paragraph#word-word-paragraph-insertannotations-member(1))|Inserts annotations on this Paragraph object.| diff --git a/docs/includes/word-1_8.md b/docs/includes/word-1_8.md index 3dd4b01dd8..7059784241 100644 --- a/docs/includes/word-1_8.md +++ b/docs/includes/word-1_8.md @@ -1,13 +1,13 @@ | Class | Fields | Description | |:---|:---|:---| -|[AnnotationPopupActionEventArgs](/.annotationpopupactioneventargs)|[action](/.annotationpopupactioneventargs#word-javascript/api/word/-annotationpopupactioneventargs-action-member)|Specifies the chosen action in the pop-up menu.| -||[critiqueSuggestion](/.annotationpopupactioneventargs#word-javascript/api/word/-annotationpopupactioneventargs-critiquesuggestion-member)|Specifies the accepted suggestion (only populated when accepting a critique suggestion).| -||[id](/.annotationpopupactioneventargs#word-javascript/api/word/-annotationpopupactioneventargs-id-member)|Specifies the annotation ID for which the event was fired.| -|[Critique](/.critique)|[popupOptions](/.critique#word-javascript/api/word/-critique-popupoptions-member)|Specifies the behavior of the pop-up menu for the critique.| -|[CritiquePopupOptions](/.critiquepopupoptions)|[brandingTextResourceId](/.critiquepopupoptions#word-javascript/api/word/-critiquepopupoptions-brandingtextresourceid-member)|Gets the manifest resource ID of the string to use for branding.| -||[subtitleResourceId](/.critiquepopupoptions#word-javascript/api/word/-critiquepopupoptions-subtitleresourceid-member)|Gets the manifest resource ID of the string to use as the subtitle.| -||[suggestions](/.critiquepopupoptions#word-javascript/api/word/-critiquepopupoptions-suggestions-member)|Gets the suggestions to display in the critique pop-up menu.| -||[titleResourceId](/.critiquepopupoptions#word-javascript/api/word/-critiquepopupoptions-titleresourceid-member)|Gets the manifest resource ID of the string to use as the title.| -|[Document](/.document)|[onAnnotationPopupAction](/.document#word-javascript/api/word/-document-onannotationpopupaction-member)|Occurs when the user performs an action in an annotation pop-up menu.| -|[Range](/.range)|[highlight()](/.range#word-javascript/api/word/-range-highlight-member(1))|Highlights the range temporarily without changing document content.| -||[removeHighlight()](/.range#word-javascript/api/word/-range-removehighlight-member(1))|Removes the highlight added by the Highlight function if any.| +|[AnnotationPopupActionEventArgs](/javascript/api/word/word.annotationpopupactioneventargs)|[action](/javascript/api/word/word.annotationpopupactioneventargs#word-word-annotationpopupactioneventargs-action-member)|Specifies the chosen action in the pop-up menu.| +||[critiqueSuggestion](/javascript/api/word/word.annotationpopupactioneventargs#word-word-annotationpopupactioneventargs-critiquesuggestion-member)|Specifies the accepted suggestion (only populated when accepting a critique suggestion).| +||[id](/javascript/api/word/word.annotationpopupactioneventargs#word-word-annotationpopupactioneventargs-id-member)|Specifies the annotation ID for which the event was fired.| +|[Critique](/javascript/api/word/word.critique)|[popupOptions](/javascript/api/word/word.critique#word-word-critique-popupoptions-member)|Specifies the behavior of the pop-up menu for the critique.| +|[CritiquePopupOptions](/javascript/api/word/word.critiquepopupoptions)|[brandingTextResourceId](/javascript/api/word/word.critiquepopupoptions#word-word-critiquepopupoptions-brandingtextresourceid-member)|Gets the manifest resource ID of the string to use for branding.| +||[subtitleResourceId](/javascript/api/word/word.critiquepopupoptions#word-word-critiquepopupoptions-subtitleresourceid-member)|Gets the manifest resource ID of the string to use as the subtitle.| +||[suggestions](/javascript/api/word/word.critiquepopupoptions#word-word-critiquepopupoptions-suggestions-member)|Gets the suggestions to display in the critique pop-up menu.| +||[titleResourceId](/javascript/api/word/word.critiquepopupoptions#word-word-critiquepopupoptions-titleresourceid-member)|Gets the manifest resource ID of the string to use as the title.| +|[Document](/javascript/api/word/word.document)|[onAnnotationPopupAction](/javascript/api/word/word.document#word-word-document-onannotationpopupaction-member)|Occurs when the user performs an action in an annotation pop-up menu.| +|[Range](/javascript/api/word/word.range)|[highlight()](/javascript/api/word/word.range#word-word-range-highlight-member(1))|Highlights the range temporarily without changing document content.| +||[removeHighlight()](/javascript/api/word/word.range#word-word-range-removehighlight-member(1))|Removes the highlight added by the Highlight function if any.| diff --git a/docs/includes/word-desktop-1_1.md b/docs/includes/word-desktop-1_1.md index 03457fe9c5..65488d2c8a 100644 --- a/docs/includes/word-desktop-1_1.md +++ b/docs/includes/word-desktop-1_1.md @@ -1,55 +1,55 @@ | Class | Fields | Description | |:---|:---|:---| -|[Border](/.border)|[color](/.border#word-javascript/api/word/-border-color-member)|Specifies the color for the border.| -||[location](/.border#word-javascript/api/word/-border-location-member)|Gets the location of the border.| -||[type](/.border#word-javascript/api/word/-border-type-member)|Specifies the border type for the border.| -||[visible](/.border#word-javascript/api/word/-border-visible-member)|Specifies whether the border is visible.| -||[width](/.border#word-javascript/api/word/-border-width-member)|Specifies the width for the border.| -|[BorderCollection](/.bordercollection)|[getByLocation(borderLocation: Word.BorderLocation.top \| Word.BorderLocation.left \| Word.BorderLocation.bottom \| Word.BorderLocation.right \| Word.BorderLocation.insideHorizontal \| Word.BorderLocation.insideVertical \| "Top" \| "Left" \| "Bottom" \| "Right" \| "InsideHorizontal" \| "InsideVertical")](/.bordercollection#word-javascript/api/word/-bordercollection-getbylocation-member(1))|Gets the border that has the specified location.| -||[getFirst()](/.bordercollection#word-javascript/api/word/-bordercollection-getfirst-member(1))|Gets the first border in this collection.| -||[getFirstOrNullObject()](/.bordercollection#word-javascript/api/word/-bordercollection-getfirstornullobject-member(1))|Gets the first border in this collection.| -||[getItem(index: number)](/.bordercollection#word-javascript/api/word/-bordercollection-getitem-member(1))|Gets a Border object by its index in the collection.| -||[insideBorderColor](/.bordercollection#word-javascript/api/word/-bordercollection-insidebordercolor-member)|Specifies the 24-bit color of the inside borders.| -||[insideBorderType](/.bordercollection#word-javascript/api/word/-bordercollection-insidebordertype-member)|Specifies the border type of the inside borders.| -||[insideBorderWidth](/.bordercollection#word-javascript/api/word/-bordercollection-insideborderwidth-member)|Specifies the width of the inside borders.| -||[items](/.bordercollection#word-javascript/api/word/-bordercollection-items-member)|Gets the loaded child items in this collection.| -||[outsideBorderColor](/.bordercollection#word-javascript/api/word/-bordercollection-outsidebordercolor-member)|Specifies the 24-bit color of the outside borders.| -||[outsideBorderType](/.bordercollection#word-javascript/api/word/-bordercollection-outsidebordertype-member)|Specifies the border type of the outside borders.| -||[outsideBorderWidth](/.bordercollection#word-javascript/api/word/-bordercollection-outsideborderwidth-member)|Specifies the width of the outside borders.| -|[Document](/.document)|[compare(filePath: string, documentCompareOptions?: Word.DocumentCompareOptions)](/.document#word-javascript/api/word/-document-compare-member(1))|Displays revision marks that indicate where the specified document differs from another document.| -|[DocumentCompareOptions](/.documentcompareoptions)|[addToRecentFiles](/.documentcompareoptions#word-javascript/api/word/-documentcompareoptions-addtorecentfiles-member)|True adds the document to the list of recently used files on the File menu.| -||[authorName](/.documentcompareoptions#word-javascript/api/word/-documentcompareoptions-authorname-member)|The reviewer name associated with the differences generated by the comparison.| -||[compareTarget](/.documentcompareoptions#word-javascript/api/word/-documentcompareoptions-comparetarget-member)|The target document for the comparison.| -||[detectFormatChanges](/.documentcompareoptions#word-javascript/api/word/-documentcompareoptions-detectformatchanges-member)|True (default) for the comparison to include detection of format changes.| -||[ignoreAllComparisonWarnings](/.documentcompareoptions#word-javascript/api/word/-documentcompareoptions-ignoreallcomparisonwarnings-member)|True compares the documents without notifying a user of problems.| -||[removeDateAndTime](/.documentcompareoptions#word-javascript/api/word/-documentcompareoptions-removedateandtime-member)|True removes date and time stamp information from tracked changes in the returned Document object.| -||[removePersonalInformation](/.documentcompareoptions#word-javascript/api/word/-documentcompareoptions-removepersonalinformation-member)|True removes all user information from comments, revisions, and the properties dialog box in the returned Document object.| -|[Field](/.field)|[showCodes](/.field#word-javascript/api/word/-field-showcodes-member)|Specifies whether the field codes are displayed for the specified field.| -|[InlinePicture](/.inlinepicture)|[imageFormat](/.inlinepicture#word-javascript/api/word/-inlinepicture-imageformat-member)|Gets the format of the inline image.| -|[List](/.list)|[getLevelFont(level: number)](/.list#word-javascript/api/word/-list-getlevelfont-member(1))|Gets the font of the bullet, number, or picture at the specified level in the list.| -||[getLevelPicture(level: number)](/.list#word-javascript/api/word/-list-getlevelpicture-member(1))|Gets the Base64-encoded string representation of the picture at the specified level in the list.| -||[resetLevelFont(level: number, resetFontName?: boolean)](/.list#word-javascript/api/word/-list-resetlevelfont-member(1))|Resets the font of the bullet, number, or picture at the specified level in the list.| -||[setLevelPicture(level: number, base64EncodedImage?: string)](/.list#word-javascript/api/word/-list-setlevelpicture-member(1))|Sets the picture at the specified level in the list.| -|[ListLevel](/.listlevel)|[alignment](/.listlevel#word-javascript/api/word/-listlevel-alignment-member)|Specifies the horizontal alignment of the list level.| -||[font](/.listlevel#word-javascript/api/word/-listlevel-font-member)|Gets a Font object that represents the character formatting of the specified object.| -||[linkedStyle](/.listlevel#word-javascript/api/word/-listlevel-linkedstyle-member)|Specifies the name of the style that's linked to the specified list level object.| -||[numberFormat](/.listlevel#word-javascript/api/word/-listlevel-numberformat-member)|Specifies the number format for the specified list level.| -||[numberPosition](/.listlevel#word-javascript/api/word/-listlevel-numberposition-member)|Specifies the position (in points) of the number or bullet for the specified list level object.| -||[numberStyle](/.listlevel#word-javascript/api/word/-listlevel-numberstyle-member)|Specifies the number style for the list level object.| -||[resetOnHigher](/.listlevel#word-javascript/api/word/-listlevel-resetonhigher-member)|Specifies the list level that must appear before the specified list level restarts numbering at 1.| -||[startAt](/.listlevel#word-javascript/api/word/-listlevel-startat-member)|Specifies the starting number for the specified list level object.| -||[tabPosition](/.listlevel#word-javascript/api/word/-listlevel-tabposition-member)|Specifies the tab position for the specified list level object.| -||[textPosition](/.listlevel#word-javascript/api/word/-listlevel-textposition-member)|Specifies the position (in points) for the second line of wrapping text for the specified list level object.| -||[trailingCharacter](/.listlevel#word-javascript/api/word/-listlevel-trailingcharacter-member)|Specifies the character inserted after the number for the specified list level.| -|[ListLevelCollection](/.listlevelcollection)|[getFirst()](/.listlevelcollection#word-javascript/api/word/-listlevelcollection-getfirst-member(1))|Gets the first list level in this collection.| -||[getFirstOrNullObject()](/.listlevelcollection#word-javascript/api/word/-listlevelcollection-getfirstornullobject-member(1))|Gets the first list level in this collection.| -||[items](/.listlevelcollection#word-javascript/api/word/-listlevelcollection-items-member)|Gets the loaded child items in this collection.| -|[ListTemplate](/.listtemplate)|[listLevels](/.listtemplate#word-javascript/api/word/-listtemplate-listlevels-member)|Gets a `ListLevelCollection` object that represents all the levels for the list template.| -||[outlineNumbered](/.listtemplate#word-javascript/api/word/-listtemplate-outlinenumbered-member)|Specifies whether the list template is outline numbered.| -|[Shading](/.shading)|[foregroundPatternColor](/.shading#word-javascript/api/word/-shading-foregroundpatterncolor-member)|Specifies the color for the foreground of the object.| -||[texture](/.shading#word-javascript/api/word/-shading-texture-member)|Specifies the shading texture of the object.| -|[Style](/.style)|[borders](/.style#word-javascript/api/word/-style-borders-member)|Specifies a BorderCollection object that represents all the borders for the specified style.| -||[listTemplate](/.style#word-javascript/api/word/-style-listtemplate-member)|Gets a ListTemplate object that represents the list formatting for the specified Style object.| -|[TableRow](/.tablerow)|[insertContentControl()](/.tablerow#word-javascript/api/word/-tablerow-insertcontentcontrol-member(1))|Inserts a content control on the row.| -|[TableStyle](/.tablestyle)|[alignment](/.tablestyle#word-javascript/api/word/-tablestyle-alignment-member)|Specifies the table's alignment against the page margin.| -||[allowBreakAcrossPage](/.tablestyle#word-javascript/api/word/-tablestyle-allowbreakacrosspage-member)|Specifies whether lines in tables formatted with a specified style break across pages.| +|[Border](/javascript/api/word/word.border)|[color](/javascript/api/word/word.border#word-word-border-color-member)|Specifies the color for the border.| +||[location](/javascript/api/word/word.border#word-word-border-location-member)|Gets the location of the border.| +||[type](/javascript/api/word/word.border#word-word-border-type-member)|Specifies the border type for the border.| +||[visible](/javascript/api/word/word.border#word-word-border-visible-member)|Specifies whether the border is visible.| +||[width](/javascript/api/word/word.border#word-word-border-width-member)|Specifies the width for the border.| +|[BorderCollection](/javascript/api/word/word.bordercollection)|[getByLocation(borderLocation: Word.BorderLocation.top \| Word.BorderLocation.left \| Word.BorderLocation.bottom \| Word.BorderLocation.right \| Word.BorderLocation.insideHorizontal \| Word.BorderLocation.insideVertical \| "Top" \| "Left" \| "Bottom" \| "Right" \| "InsideHorizontal" \| "InsideVertical")](/javascript/api/word/word.bordercollection#word-word-bordercollection-getbylocation-member(1))|Gets the border that has the specified location.| +||[getFirst()](/javascript/api/word/word.bordercollection#word-word-bordercollection-getfirst-member(1))|Gets the first border in this collection.| +||[getFirstOrNullObject()](/javascript/api/word/word.bordercollection#word-word-bordercollection-getfirstornullobject-member(1))|Gets the first border in this collection.| +||[getItem(index: number)](/javascript/api/word/word.bordercollection#word-word-bordercollection-getitem-member(1))|Gets a Border object by its index in the collection.| +||[insideBorderColor](/javascript/api/word/word.bordercollection#word-word-bordercollection-insidebordercolor-member)|Specifies the 24-bit color of the inside borders.| +||[insideBorderType](/javascript/api/word/word.bordercollection#word-word-bordercollection-insidebordertype-member)|Specifies the border type of the inside borders.| +||[insideBorderWidth](/javascript/api/word/word.bordercollection#word-word-bordercollection-insideborderwidth-member)|Specifies the width of the inside borders.| +||[items](/javascript/api/word/word.bordercollection#word-word-bordercollection-items-member)|Gets the loaded child items in this collection.| +||[outsideBorderColor](/javascript/api/word/word.bordercollection#word-word-bordercollection-outsidebordercolor-member)|Specifies the 24-bit color of the outside borders.| +||[outsideBorderType](/javascript/api/word/word.bordercollection#word-word-bordercollection-outsidebordertype-member)|Specifies the border type of the outside borders.| +||[outsideBorderWidth](/javascript/api/word/word.bordercollection#word-word-bordercollection-outsideborderwidth-member)|Specifies the width of the outside borders.| +|[Document](/javascript/api/word/word.document)|[compare(filePath: string, documentCompareOptions?: Word.DocumentCompareOptions)](/javascript/api/word/word.document#word-word-document-compare-member(1))|Displays revision marks that indicate where the specified document differs from another document.| +|[DocumentCompareOptions](/javascript/api/word/word.documentcompareoptions)|[addToRecentFiles](/javascript/api/word/word.documentcompareoptions#word-word-documentcompareoptions-addtorecentfiles-member)|True adds the document to the list of recently used files on the File menu.| +||[authorName](/javascript/api/word/word.documentcompareoptions#word-word-documentcompareoptions-authorname-member)|The reviewer name associated with the differences generated by the comparison.| +||[compareTarget](/javascript/api/word/word.documentcompareoptions#word-word-documentcompareoptions-comparetarget-member)|The target document for the comparison.| +||[detectFormatChanges](/javascript/api/word/word.documentcompareoptions#word-word-documentcompareoptions-detectformatchanges-member)|True (default) for the comparison to include detection of format changes.| +||[ignoreAllComparisonWarnings](/javascript/api/word/word.documentcompareoptions#word-word-documentcompareoptions-ignoreallcomparisonwarnings-member)|True compares the documents without notifying a user of problems.| +||[removeDateAndTime](/javascript/api/word/word.documentcompareoptions#word-word-documentcompareoptions-removedateandtime-member)|True removes date and time stamp information from tracked changes in the returned Document object.| +||[removePersonalInformation](/javascript/api/word/word.documentcompareoptions#word-word-documentcompareoptions-removepersonalinformation-member)|True removes all user information from comments, revisions, and the properties dialog box in the returned Document object.| +|[Field](/javascript/api/word/word.field)|[showCodes](/javascript/api/word/word.field#word-word-field-showcodes-member)|Specifies whether the field codes are displayed for the specified field.| +|[InlinePicture](/javascript/api/word/word.inlinepicture)|[imageFormat](/javascript/api/word/word.inlinepicture#word-word-inlinepicture-imageformat-member)|Gets the format of the inline image.| +|[List](/javascript/api/word/word.list)|[getLevelFont(level: number)](/javascript/api/word/word.list#word-word-list-getlevelfont-member(1))|Gets the font of the bullet, number, or picture at the specified level in the list.| +||[getLevelPicture(level: number)](/javascript/api/word/word.list#word-word-list-getlevelpicture-member(1))|Gets the Base64-encoded string representation of the picture at the specified level in the list.| +||[resetLevelFont(level: number, resetFontName?: boolean)](/javascript/api/word/word.list#word-word-list-resetlevelfont-member(1))|Resets the font of the bullet, number, or picture at the specified level in the list.| +||[setLevelPicture(level: number, base64EncodedImage?: string)](/javascript/api/word/word.list#word-word-list-setlevelpicture-member(1))|Sets the picture at the specified level in the list.| +|[ListLevel](/javascript/api/word/word.listlevel)|[alignment](/javascript/api/word/word.listlevel#word-word-listlevel-alignment-member)|Specifies the horizontal alignment of the list level.| +||[font](/javascript/api/word/word.listlevel#word-word-listlevel-font-member)|Gets a Font object that represents the character formatting of the specified object.| +||[linkedStyle](/javascript/api/word/word.listlevel#word-word-listlevel-linkedstyle-member)|Specifies the name of the style that's linked to the specified list level object.| +||[numberFormat](/javascript/api/word/word.listlevel#word-word-listlevel-numberformat-member)|Specifies the number format for the specified list level.| +||[numberPosition](/javascript/api/word/word.listlevel#word-word-listlevel-numberposition-member)|Specifies the position (in points) of the number or bullet for the specified list level object.| +||[numberStyle](/javascript/api/word/word.listlevel#word-word-listlevel-numberstyle-member)|Specifies the number style for the list level object.| +||[resetOnHigher](/javascript/api/word/word.listlevel#word-word-listlevel-resetonhigher-member)|Specifies the list level that must appear before the specified list level restarts numbering at 1.| +||[startAt](/javascript/api/word/word.listlevel#word-word-listlevel-startat-member)|Specifies the starting number for the specified list level object.| +||[tabPosition](/javascript/api/word/word.listlevel#word-word-listlevel-tabposition-member)|Specifies the tab position for the specified list level object.| +||[textPosition](/javascript/api/word/word.listlevel#word-word-listlevel-textposition-member)|Specifies the position (in points) for the second line of wrapping text for the specified list level object.| +||[trailingCharacter](/javascript/api/word/word.listlevel#word-word-listlevel-trailingcharacter-member)|Specifies the character inserted after the number for the specified list level.| +|[ListLevelCollection](/javascript/api/word/word.listlevelcollection)|[getFirst()](/javascript/api/word/word.listlevelcollection#word-word-listlevelcollection-getfirst-member(1))|Gets the first list level in this collection.| +||[getFirstOrNullObject()](/javascript/api/word/word.listlevelcollection#word-word-listlevelcollection-getfirstornullobject-member(1))|Gets the first list level in this collection.| +||[items](/javascript/api/word/word.listlevelcollection#word-word-listlevelcollection-items-member)|Gets the loaded child items in this collection.| +|[ListTemplate](/javascript/api/word/word.listtemplate)|[listLevels](/javascript/api/word/word.listtemplate#word-word-listtemplate-listlevels-member)|Gets a `ListLevelCollection` object that represents all the levels for the list template.| +||[outlineNumbered](/javascript/api/word/word.listtemplate#word-word-listtemplate-outlinenumbered-member)|Specifies whether the list template is outline numbered.| +|[Shading](/javascript/api/word/word.shading)|[foregroundPatternColor](/javascript/api/word/word.shading#word-word-shading-foregroundpatterncolor-member)|Specifies the color for the foreground of the object.| +||[texture](/javascript/api/word/word.shading#word-word-shading-texture-member)|Specifies the shading texture of the object.| +|[Style](/javascript/api/word/word.style)|[borders](/javascript/api/word/word.style#word-word-style-borders-member)|Specifies a BorderCollection object that represents all the borders for the specified style.| +||[listTemplate](/javascript/api/word/word.style#word-word-style-listtemplate-member)|Gets a ListTemplate object that represents the list formatting for the specified Style object.| +|[TableRow](/javascript/api/word/word.tablerow)|[insertContentControl()](/javascript/api/word/word.tablerow#word-word-tablerow-insertcontentcontrol-member(1))|Inserts a content control on the row.| +|[TableStyle](/javascript/api/word/word.tablestyle)|[alignment](/javascript/api/word/word.tablestyle#word-word-tablestyle-alignment-member)|Specifies the table's alignment against the page margin.| +||[allowBreakAcrossPage](/javascript/api/word/word.tablestyle#word-word-tablestyle-allowbreakacrosspage-member)|Specifies whether lines in tables formatted with a specified style break across pages.| diff --git a/docs/includes/word-desktop-1_2.md b/docs/includes/word-desktop-1_2.md index 1e6d852597..ca68208941 100644 --- a/docs/includes/word-desktop-1_2.md +++ b/docs/includes/word-desktop-1_2.md @@ -1,118 +1,118 @@ | Class | Fields | Description | |:---|:---|:---| -|[Body](/.body)|[shapes](/.body#word-javascript/api/word/-body-shapes-member)|Gets the collection of shape objects in the body, including both inline and floating shapes.| -|[Canvas](/.canvas)|[id](/.canvas#word-javascript/api/word/-canvas-id-member)|Gets an integer that represents the canvas identifier.| -||[shape](/.canvas#word-javascript/api/word/-canvas-shape-member)|Gets the Shape object associated with the canvas.| -||[shapes](/.canvas#word-javascript/api/word/-canvas-shapes-member)|Gets the collection of Shape objects.| -|[Document](/.document)|[activeWindow](/.document#word-javascript/api/word/-document-activewindow-member)|Gets the active window for the document.| -||[compareFromBase64(base64File: string, documentCompareOptions?: Word.DocumentCompareOptions)](/.document#word-javascript/api/word/-document-comparefrombase64-member(1))|Displays revision marks that indicate where the specified document differs from another document.| -||[windows](/.document#word-javascript/api/word/-document-windows-member)|Gets the collection of `Word.Window` objects for the document.| -|[Font](/.font)|[hidden](/.font#word-javascript/api/word/-font-hidden-member)|Specifies a value that indicates whether the font is tagged as hidden.| -|[InsertShapeOptions](/.insertshapeoptions)|[height](/.insertshapeoptions#word-javascript/api/word/-insertshapeoptions-height-member)|Represents the height of the shape being inserted.| -||[left](/.insertshapeoptions#word-javascript/api/word/-insertshapeoptions-left-member)|Represents the left position of the shape being inserted.| -||[top](/.insertshapeoptions#word-javascript/api/word/-insertshapeoptions-top-member)|Represents the top position of the shape being inserted.| -||[width](/.insertshapeoptions#word-javascript/api/word/-insertshapeoptions-width-member)|Represents the width of the shape being inserted.| -|[Page](/.page)|[getNext()](/.page#word-javascript/api/word/-page-getnext-member(1))|Gets the next page in the pane.| -||[getNextOrNullObject()](/.page#word-javascript/api/word/-page-getnextornullobject-member(1))|Gets the next page.| -||[getRange(rangeLocation?: Word.RangeLocation.whole \| Word.RangeLocation.start \| Word.RangeLocation.end \| "Whole" \| "Start" \| "End")](/.page#word-javascript/api/word/-page-getrange-member(1))|Gets the whole page, or the starting or ending point of the page, as a range.| -||[height](/.page#word-javascript/api/word/-page-height-member)|Gets the height, in points, of the paper defined in the Page Setup dialog box.| -||[index](/.page#word-javascript/api/word/-page-index-member)|Gets the index of the page.| -||[width](/.page#word-javascript/api/word/-page-width-member)|Gets the width, in points, of the paper defined in the Page Setup dialog box.| -|[PageCollection](/.pagecollection)|[getFirst()](/.pagecollection#word-javascript/api/word/-pagecollection-getfirst-member(1))|Gets the first page in this collection.| -||[getFirstOrNullObject()](/.pagecollection#word-javascript/api/word/-pagecollection-getfirstornullobject-member(1))|Gets the first page in this collection.| -||[items](/.pagecollection#word-javascript/api/word/-pagecollection-items-member)|Gets the loaded child items in this collection.| -|[Pane](/.pane)|[getNext()](/.pane#word-javascript/api/word/-pane-getnext-member(1))|Gets the next pane in the window.| -||[getNextOrNullObject()](/.pane#word-javascript/api/word/-pane-getnextornullobject-member(1))|Gets the next pane.| -||[pages](/.pane#word-javascript/api/word/-pane-pages-member)|Gets the collection of pages in the pane.| -||[pagesEnclosingViewport](/.pane#word-javascript/api/word/-pane-pagesenclosingviewport-member)|Gets the `PageCollection` shown in the viewport of the pane.| -|[PaneCollection](/.panecollection)|[getFirst()](/.panecollection#word-javascript/api/word/-panecollection-getfirst-member(1))|Gets the first pane in this collection.| -||[getFirstOrNullObject()](/.panecollection#word-javascript/api/word/-panecollection-getfirstornullobject-member(1))|Gets the first pane in this collection.| -||[items](/.panecollection#word-javascript/api/word/-panecollection-items-member)|Gets the loaded child items in this collection.| -|[Paragraph](/.paragraph)|[insertCanvas(insertShapeOptions?: Word.InsertShapeOptions)](/.paragraph#word-javascript/api/word/-paragraph-insertcanvas-member(1))|Inserts a floating canvas in front of text with its anchor at the beginning of the paragraph.| -||[insertGeometricShape(geometricShapeType: Word.GeometricShapeType, insertShapeOptions?: Word.InsertShapeOptions)](/.paragraph#word-javascript/api/word/-paragraph-insertgeometricshape-member(1))|Inserts a geometric shape in front of text with its anchor at the beginning of the paragraph.| -||[insertPictureFromBase64(base64EncodedImage: string, insertShapeOptions?: Word.InsertShapeOptions)](/.paragraph#word-javascript/api/word/-paragraph-insertpicturefrombase64-member(1))|Inserts a floating picture in front of text with its anchor at the beginning of the paragraph.| -||[insertTextBox(text?: string, insertShapeOptions?: Word.InsertShapeOptions)](/.paragraph#word-javascript/api/word/-paragraph-inserttextbox-member(1))|Inserts a floating text box in front of text with its anchor at the beginning of the paragraph.| -||[shapes](/.paragraph#word-javascript/api/word/-paragraph-shapes-member)|Gets the collection of shape objects anchored in the paragraph, including both inline and floating shapes.| -|[Range](/.range)|[insertCanvas(insertShapeOptions?: Word.InsertShapeOptions)](/.range#word-javascript/api/word/-range-insertcanvas-member(1))|Inserts a floating canvas in front of text with its anchor at the beginning of the range.| -||[insertGeometricShape(geometricShapeType: Word.GeometricShapeType, insertShapeOptions?: Word.InsertShapeOptions)](/.range#word-javascript/api/word/-range-insertgeometricshape-member(1))|Inserts a geometric shape in front of text with its anchor at the beginning of the range.| -||[insertPictureFromBase64(base64EncodedImage: string, insertShapeOptions?: Word.InsertShapeOptions)](/.range#word-javascript/api/word/-range-insertpicturefrombase64-member(1))|Inserts a floating picture in front of text with its anchor at the beginning of the range.| -||[insertTextBox(text?: string, insertShapeOptions?: Word.InsertShapeOptions)](/.range#word-javascript/api/word/-range-inserttextbox-member(1))|Inserts a floating text box in front of text with its anchor at the beginning of the range.| -||[pages](/.range#word-javascript/api/word/-range-pages-member)|Gets the collection of pages in the range.| -||[shapes](/.range#word-javascript/api/word/-range-shapes-member)|Gets the collection of shape objects anchored in the range, including both inline and floating shapes.| -|[Shape](/.shape)|[allowOverlap](/.shape#word-javascript/api/word/-shape-allowoverlap-member)|Specifies whether a given shape can overlap other shapes.| -||[altTextDescription](/.shape#word-javascript/api/word/-shape-alttextdescription-member)|Specifies a string that represents the alternative text associated with the shape.| -||[body](/.shape#word-javascript/api/word/-shape-body-member)|Represents the body object of the shape.| -||[canvas](/.shape#word-javascript/api/word/-shape-canvas-member)|Gets the canvas associated with the shape.| -||[delete()](/.shape#word-javascript/api/word/-shape-delete-member(1))|Deletes the shape and its content.| -||[fill](/.shape#word-javascript/api/word/-shape-fill-member)|Returns the fill formatting of the shape.| -||[geometricShapeType](/.shape#word-javascript/api/word/-shape-geometricshapetype-member)|The geometric shape type of the shape.| -||[height](/.shape#word-javascript/api/word/-shape-height-member)|The height, in points, of the shape.| -||[heightRelative](/.shape#word-javascript/api/word/-shape-heightrelative-member)|The percentage of shape height to vertical relative size, see Word.RelativeSize.| -||[id](/.shape#word-javascript/api/word/-shape-id-member)|Gets an integer that represents the shape identifier.| -||[isChild](/.shape#word-javascript/api/word/-shape-ischild-member)|Check whether this shape is a child of a group shape or a canvas shape.| -||[left](/.shape#word-javascript/api/word/-shape-left-member)|The distance, in points, from the left side of the shape to the horizontal relative position, see Word.RelativeHorizontalPosition.| -||[leftRelative](/.shape#word-javascript/api/word/-shape-leftrelative-member)|The relative left position as a percentage from the left side of the shape to the horizontal relative position, see Word.RelativeHorizontalPosition.| -||[lockAspectRatio](/.shape#word-javascript/api/word/-shape-lockaspectratio-member)|Specifies if the aspect ratio of this shape is locked.| -||[moveHorizontally(distance: number)](/.shape#word-javascript/api/word/-shape-movehorizontally-member(1))|Moves the shape horizontally by the number of points.| -||[moveVertically(distance: number)](/.shape#word-javascript/api/word/-shape-movevertically-member(1))|Moves the shape vertically by the number of points.| -||[name](/.shape#word-javascript/api/word/-shape-name-member)|The name of the shape.| -||[parentCanvas](/.shape#word-javascript/api/word/-shape-parentcanvas-member)|Gets the top-level parent canvas shape of this child shape.| -||[parentGroup](/.shape#word-javascript/api/word/-shape-parentgroup-member)|Gets the top-level parent group shape of this child shape.| -||[relativeHorizontalPosition](/.shape#word-javascript/api/word/-shape-relativehorizontalposition-member)|The relative horizontal position of the shape.| -||[relativeHorizontalSize](/.shape#word-javascript/api/word/-shape-relativehorizontalsize-member)|The relative horizontal size of the shape.| -||[relativeVerticalPosition](/.shape#word-javascript/api/word/-shape-relativeverticalposition-member)|The relative vertical position of the shape.| -||[relativeVerticalSize](/.shape#word-javascript/api/word/-shape-relativeverticalsize-member)|The relative vertical size of the shape.| -||[rotation](/.shape#word-javascript/api/word/-shape-rotation-member)|Specifies the rotation, in degrees, of the shape.| -||[scaleHeight(scaleFactor: number, scaleType: Word.ShapeScaleType, scaleFrom?: Word.ShapeScaleFrom)](/.shape#word-javascript/api/word/-shape-scaleheight-member(1))|Scales the height of the shape by a specified factor.| -||[scaleWidth(scaleFactor: number, scaleType: Word.ShapeScaleType, scaleFrom?: Word.ShapeScaleFrom)](/.shape#word-javascript/api/word/-shape-scalewidth-member(1))|Scales the width of the shape by a specified factor.| -||[select(selectMultipleShapes?: boolean)](/.shape#word-javascript/api/word/-shape-select-member(1))|Selects the shape.| -||[shapeGroup](/.shape#word-javascript/api/word/-shape-shapegroup-member)|Gets the shape group associated with the shape.| -||[textFrame](/.shape#word-javascript/api/word/-shape-textframe-member)|Gets the text frame object of the shape.| -||[textWrap](/.shape#word-javascript/api/word/-shape-textwrap-member)|Returns the text wrap formatting of the shape.| -||[top](/.shape#word-javascript/api/word/-shape-top-member)|The distance, in points, from the top edge of the shape to the vertical relative position (see Word.RelativeVerticalPosition).| -||[topRelative](/.shape#word-javascript/api/word/-shape-toprelative-member)|The relative top position as a percentage from the top edge of the shape to the vertical relative position, see Word.RelativeVerticalPosition.| -||[type](/.shape#word-javascript/api/word/-shape-type-member)|Gets the shape type.| -||[visible](/.shape#word-javascript/api/word/-shape-visible-member)|Specifies if the shape is visible.| -||[width](/.shape#word-javascript/api/word/-shape-width-member)|The width, in points, of the shape.| -||[widthRelative](/.shape#word-javascript/api/word/-shape-widthrelative-member)|The percentage of shape width to horizontal relative size, see Word.RelativeSize.| -|[ShapeCollection](/.shapecollection)|[getByGeometricTypes(types: Word.GeometricShapeType[])](/.shapecollection#word-javascript/api/word/-shapecollection-getbygeometrictypes-member(1))|Gets the shapes that have the specified geometric types.| -||[getById(id: number)](/.shapecollection#word-javascript/api/word/-shapecollection-getbyid-member(1))|Gets a shape by its identifier.| -||[getByIdOrNullObject(id: number)](/.shapecollection#word-javascript/api/word/-shapecollection-getbyidornullobject-member(1))|Gets a shape by its identifier.| -||[getByIds(ids: number[])](/.shapecollection#word-javascript/api/word/-shapecollection-getbyids-member(1))|Gets the shapes by the identifiers.| -||[getByNames(names: string[])](/.shapecollection#word-javascript/api/word/-shapecollection-getbynames-member(1))|Gets the shapes that have the specified names.| -||[getByTypes(types: Word.ShapeType[])](/.shapecollection#word-javascript/api/word/-shapecollection-getbytypes-member(1))|Gets the shapes that have the specified types.| -||[getFirst()](/.shapecollection#word-javascript/api/word/-shapecollection-getfirst-member(1))|Gets the first shape in this collection.| -||[getFirstOrNullObject()](/.shapecollection#word-javascript/api/word/-shapecollection-getfirstornullobject-member(1))|Gets the first shape in this collection.| -||[group()](/.shapecollection#word-javascript/api/word/-shapecollection-group-member(1))|Groups floating shapes in this collection, inline shapes will be skipped.| -||[items](/.shapecollection#word-javascript/api/word/-shapecollection-items-member)|Gets the loaded child items in this collection.| -|[ShapeFill](/.shapefill)|[backgroundColor](/.shapefill#word-javascript/api/word/-shapefill-backgroundcolor-member)|Specifies the shape fill background color.| -||[clear()](/.shapefill#word-javascript/api/word/-shapefill-clear-member(1))|Clears the fill formatting of this shape and set it to `Word.ShapeFillType.NoFill`;| -||[foregroundColor](/.shapefill#word-javascript/api/word/-shapefill-foregroundcolor-member)|Specifies the shape fill foreground color.| -||[setSolidColor(color: string)](/.shapefill#word-javascript/api/word/-shapefill-setsolidcolor-member(1))|Sets the fill formatting of the shape to a uniform color.| -||[transparency](/.shapefill#word-javascript/api/word/-shapefill-transparency-member)|Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).| -||[type](/.shapefill#word-javascript/api/word/-shapefill-type-member)|Returns the fill type of the shape.| -|[ShapeGroup](/.shapegroup)|[id](/.shapegroup#word-javascript/api/word/-shapegroup-id-member)|Gets an integer that represents the shape group identifier.| -||[shape](/.shapegroup#word-javascript/api/word/-shapegroup-shape-member)|Gets the Shape object associated with the group.| -||[shapes](/.shapegroup#word-javascript/api/word/-shapegroup-shapes-member)|Gets the collection of Shape objects.| -||[ungroup()](/.shapegroup#word-javascript/api/word/-shapegroup-ungroup-member(1))|Ungroups any grouped shapes in the specified shape group.| -|[ShapeTextWrap](/.shapetextwrap)|[bottomDistance](/.shapetextwrap#word-javascript/api/word/-shapetextwrap-bottomdistance-member)|Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape.| -||[leftDistance](/.shapetextwrap#word-javascript/api/word/-shapetextwrap-leftdistance-member)|Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape.| -||[rightDistance](/.shapetextwrap#word-javascript/api/word/-shapetextwrap-rightdistance-member)|Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape.| -||[side](/.shapetextwrap#word-javascript/api/word/-shapetextwrap-side-member)|Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farthest from the page margin.| -||[topDistance](/.shapetextwrap#word-javascript/api/word/-shapetextwrap-topdistance-member)|Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape.| -||[type](/.shapetextwrap#word-javascript/api/word/-shapetextwrap-type-member)|Specifies the text wrap type around the shape.| -|[TextFrame](/.textframe)|[autoSizeSetting](/.textframe#word-javascript/api/word/-textframe-autosizesetting-member)|The automatic sizing settings for the text frame.| -||[bottomMargin](/.textframe#word-javascript/api/word/-textframe-bottommargin-member)|Represents the bottom margin, in points, of the text frame.| -||[hasText](/.textframe#word-javascript/api/word/-textframe-hastext-member)|Specifies if the text frame contains text.| -||[leftMargin](/.textframe#word-javascript/api/word/-textframe-leftmargin-member)|Represents the left margin, in points, of the text frame.| -||[noTextRotation](/.textframe#word-javascript/api/word/-textframe-notextrotation-member)|Returns True if text in the text frame shouldn't rotate when the shape is rotated.| -||[orientation](/.textframe#word-javascript/api/word/-textframe-orientation-member)|Represents the angle to which the text is oriented for the text frame.| -||[rightMargin](/.textframe#word-javascript/api/word/-textframe-rightmargin-member)|Represents the right margin, in points, of the text frame.| -||[topMargin](/.textframe#word-javascript/api/word/-textframe-topmargin-member)|Represents the top margin, in points, of the text frame.| -||[verticalAlignment](/.textframe#word-javascript/api/word/-textframe-verticalalignment-member)|Represents the vertical alignment of the text frame.| -||[wordWrap](/.textframe#word-javascript/api/word/-textframe-wordwrap-member)|Determines whether lines break automatically to fit text inside the shape.| -|[Window](/.window)|[activePane](/.window#word-javascript/api/word/-window-activepane-member)|Gets the active pane in the window.| -||[panes](/.window#word-javascript/api/word/-window-panes-member)|Gets the collection of panes in the window.| -|[WindowCollection](/.windowcollection)|[getFirst()](/.windowcollection#word-javascript/api/word/-windowcollection-getfirst-member(1))|Gets the first window in this collection.| -||[getFirstOrNullObject()](/.windowcollection#word-javascript/api/word/-windowcollection-getfirstornullobject-member(1))|Gets the first window in this collection.| -||[items](/.windowcollection#word-javascript/api/word/-windowcollection-items-member)|Gets the loaded child items in this collection.| +|[Body](/javascript/api/word/word.body)|[shapes](/javascript/api/word/word.body#word-word-body-shapes-member)|Gets the collection of shape objects in the body, including both inline and floating shapes.| +|[Canvas](/javascript/api/word/word.canvas)|[id](/javascript/api/word/word.canvas#word-word-canvas-id-member)|Gets an integer that represents the canvas identifier.| +||[shape](/javascript/api/word/word.canvas#word-word-canvas-shape-member)|Gets the Shape object associated with the canvas.| +||[shapes](/javascript/api/word/word.canvas#word-word-canvas-shapes-member)|Gets the collection of Shape objects.| +|[Document](/javascript/api/word/word.document)|[activeWindow](/javascript/api/word/word.document#word-word-document-activewindow-member)|Gets the active window for the document.| +||[compareFromBase64(base64File: string, documentCompareOptions?: Word.DocumentCompareOptions)](/javascript/api/word/word.document#word-word-document-comparefrombase64-member(1))|Displays revision marks that indicate where the specified document differs from another document.| +||[windows](/javascript/api/word/word.document#word-word-document-windows-member)|Gets the collection of `Word.Window` objects for the document.| +|[Font](/javascript/api/word/word.font)|[hidden](/javascript/api/word/word.font#word-word-font-hidden-member)|Specifies a value that indicates whether the font is tagged as hidden.| +|[InsertShapeOptions](/javascript/api/word/word.insertshapeoptions)|[height](/javascript/api/word/word.insertshapeoptions#word-word-insertshapeoptions-height-member)|Represents the height of the shape being inserted.| +||[left](/javascript/api/word/word.insertshapeoptions#word-word-insertshapeoptions-left-member)|Represents the left position of the shape being inserted.| +||[top](/javascript/api/word/word.insertshapeoptions#word-word-insertshapeoptions-top-member)|Represents the top position of the shape being inserted.| +||[width](/javascript/api/word/word.insertshapeoptions#word-word-insertshapeoptions-width-member)|Represents the width of the shape being inserted.| +|[Page](/javascript/api/word/word.page)|[getNext()](/javascript/api/word/word.page#word-word-page-getnext-member(1))|Gets the next page in the pane.| +||[getNextOrNullObject()](/javascript/api/word/word.page#word-word-page-getnextornullobject-member(1))|Gets the next page.| +||[getRange(rangeLocation?: Word.RangeLocation.whole \| Word.RangeLocation.start \| Word.RangeLocation.end \| "Whole" \| "Start" \| "End")](/javascript/api/word/word.page#word-word-page-getrange-member(1))|Gets the whole page, or the starting or ending point of the page, as a range.| +||[height](/javascript/api/word/word.page#word-word-page-height-member)|Gets the height, in points, of the paper defined in the Page Setup dialog box.| +||[index](/javascript/api/word/word.page#word-word-page-index-member)|Gets the index of the page.| +||[width](/javascript/api/word/word.page#word-word-page-width-member)|Gets the width, in points, of the paper defined in the Page Setup dialog box.| +|[PageCollection](/javascript/api/word/word.pagecollection)|[getFirst()](/javascript/api/word/word.pagecollection#word-word-pagecollection-getfirst-member(1))|Gets the first page in this collection.| +||[getFirstOrNullObject()](/javascript/api/word/word.pagecollection#word-word-pagecollection-getfirstornullobject-member(1))|Gets the first page in this collection.| +||[items](/javascript/api/word/word.pagecollection#word-word-pagecollection-items-member)|Gets the loaded child items in this collection.| +|[Pane](/javascript/api/word/word.pane)|[getNext()](/javascript/api/word/word.pane#word-word-pane-getnext-member(1))|Gets the next pane in the window.| +||[getNextOrNullObject()](/javascript/api/word/word.pane#word-word-pane-getnextornullobject-member(1))|Gets the next pane.| +||[pages](/javascript/api/word/word.pane#word-word-pane-pages-member)|Gets the collection of pages in the pane.| +||[pagesEnclosingViewport](/javascript/api/word/word.pane#word-word-pane-pagesenclosingviewport-member)|Gets the `PageCollection` shown in the viewport of the pane.| +|[PaneCollection](/javascript/api/word/word.panecollection)|[getFirst()](/javascript/api/word/word.panecollection#word-word-panecollection-getfirst-member(1))|Gets the first pane in this collection.| +||[getFirstOrNullObject()](/javascript/api/word/word.panecollection#word-word-panecollection-getfirstornullobject-member(1))|Gets the first pane in this collection.| +||[items](/javascript/api/word/word.panecollection#word-word-panecollection-items-member)|Gets the loaded child items in this collection.| +|[Paragraph](/javascript/api/word/word.paragraph)|[insertCanvas(insertShapeOptions?: Word.InsertShapeOptions)](/javascript/api/word/word.paragraph#word-word-paragraph-insertcanvas-member(1))|Inserts a floating canvas in front of text with its anchor at the beginning of the paragraph.| +||[insertGeometricShape(geometricShapeType: Word.GeometricShapeType, insertShapeOptions?: Word.InsertShapeOptions)](/javascript/api/word/word.paragraph#word-word-paragraph-insertgeometricshape-member(1))|Inserts a geometric shape in front of text with its anchor at the beginning of the paragraph.| +||[insertPictureFromBase64(base64EncodedImage: string, insertShapeOptions?: Word.InsertShapeOptions)](/javascript/api/word/word.paragraph#word-word-paragraph-insertpicturefrombase64-member(1))|Inserts a floating picture in front of text with its anchor at the beginning of the paragraph.| +||[insertTextBox(text?: string, insertShapeOptions?: Word.InsertShapeOptions)](/javascript/api/word/word.paragraph#word-word-paragraph-inserttextbox-member(1))|Inserts a floating text box in front of text with its anchor at the beginning of the paragraph.| +||[shapes](/javascript/api/word/word.paragraph#word-word-paragraph-shapes-member)|Gets the collection of shape objects anchored in the paragraph, including both inline and floating shapes.| +|[Range](/javascript/api/word/word.range)|[insertCanvas(insertShapeOptions?: Word.InsertShapeOptions)](/javascript/api/word/word.range#word-word-range-insertcanvas-member(1))|Inserts a floating canvas in front of text with its anchor at the beginning of the range.| +||[insertGeometricShape(geometricShapeType: Word.GeometricShapeType, insertShapeOptions?: Word.InsertShapeOptions)](/javascript/api/word/word.range#word-word-range-insertgeometricshape-member(1))|Inserts a geometric shape in front of text with its anchor at the beginning of the range.| +||[insertPictureFromBase64(base64EncodedImage: string, insertShapeOptions?: Word.InsertShapeOptions)](/javascript/api/word/word.range#word-word-range-insertpicturefrombase64-member(1))|Inserts a floating picture in front of text with its anchor at the beginning of the range.| +||[insertTextBox(text?: string, insertShapeOptions?: Word.InsertShapeOptions)](/javascript/api/word/word.range#word-word-range-inserttextbox-member(1))|Inserts a floating text box in front of text with its anchor at the beginning of the range.| +||[pages](/javascript/api/word/word.range#word-word-range-pages-member)|Gets the collection of pages in the range.| +||[shapes](/javascript/api/word/word.range#word-word-range-shapes-member)|Gets the collection of shape objects anchored in the range, including both inline and floating shapes.| +|[Shape](/javascript/api/word/word.shape)|[allowOverlap](/javascript/api/word/word.shape#word-word-shape-allowoverlap-member)|Specifies whether a given shape can overlap other shapes.| +||[altTextDescription](/javascript/api/word/word.shape#word-word-shape-alttextdescription-member)|Specifies a string that represents the alternative text associated with the shape.| +||[body](/javascript/api/word/word.shape#word-word-shape-body-member)|Represents the body object of the shape.| +||[canvas](/javascript/api/word/word.shape#word-word-shape-canvas-member)|Gets the canvas associated with the shape.| +||[delete()](/javascript/api/word/word.shape#word-word-shape-delete-member(1))|Deletes the shape and its content.| +||[fill](/javascript/api/word/word.shape#word-word-shape-fill-member)|Returns the fill formatting of the shape.| +||[geometricShapeType](/javascript/api/word/word.shape#word-word-shape-geometricshapetype-member)|The geometric shape type of the shape.| +||[height](/javascript/api/word/word.shape#word-word-shape-height-member)|The height, in points, of the shape.| +||[heightRelative](/javascript/api/word/word.shape#word-word-shape-heightrelative-member)|The percentage of shape height to vertical relative size, see Word.RelativeSize.| +||[id](/javascript/api/word/word.shape#word-word-shape-id-member)|Gets an integer that represents the shape identifier.| +||[isChild](/javascript/api/word/word.shape#word-word-shape-ischild-member)|Check whether this shape is a child of a group shape or a canvas shape.| +||[left](/javascript/api/word/word.shape#word-word-shape-left-member)|The distance, in points, from the left side of the shape to the horizontal relative position, see Word.RelativeHorizontalPosition.| +||[leftRelative](/javascript/api/word/word.shape#word-word-shape-leftrelative-member)|The relative left position as a percentage from the left side of the shape to the horizontal relative position, see Word.RelativeHorizontalPosition.| +||[lockAspectRatio](/javascript/api/word/word.shape#word-word-shape-lockaspectratio-member)|Specifies if the aspect ratio of this shape is locked.| +||[moveHorizontally(distance: number)](/javascript/api/word/word.shape#word-word-shape-movehorizontally-member(1))|Moves the shape horizontally by the number of points.| +||[moveVertically(distance: number)](/javascript/api/word/word.shape#word-word-shape-movevertically-member(1))|Moves the shape vertically by the number of points.| +||[name](/javascript/api/word/word.shape#word-word-shape-name-member)|The name of the shape.| +||[parentCanvas](/javascript/api/word/word.shape#word-word-shape-parentcanvas-member)|Gets the top-level parent canvas shape of this child shape.| +||[parentGroup](/javascript/api/word/word.shape#word-word-shape-parentgroup-member)|Gets the top-level parent group shape of this child shape.| +||[relativeHorizontalPosition](/javascript/api/word/word.shape#word-word-shape-relativehorizontalposition-member)|The relative horizontal position of the shape.| +||[relativeHorizontalSize](/javascript/api/word/word.shape#word-word-shape-relativehorizontalsize-member)|The relative horizontal size of the shape.| +||[relativeVerticalPosition](/javascript/api/word/word.shape#word-word-shape-relativeverticalposition-member)|The relative vertical position of the shape.| +||[relativeVerticalSize](/javascript/api/word/word.shape#word-word-shape-relativeverticalsize-member)|The relative vertical size of the shape.| +||[rotation](/javascript/api/word/word.shape#word-word-shape-rotation-member)|Specifies the rotation, in degrees, of the shape.| +||[scaleHeight(scaleFactor: number, scaleType: Word.ShapeScaleType, scaleFrom?: Word.ShapeScaleFrom)](/javascript/api/word/word.shape#word-word-shape-scaleheight-member(1))|Scales the height of the shape by a specified factor.| +||[scaleWidth(scaleFactor: number, scaleType: Word.ShapeScaleType, scaleFrom?: Word.ShapeScaleFrom)](/javascript/api/word/word.shape#word-word-shape-scalewidth-member(1))|Scales the width of the shape by a specified factor.| +||[select(selectMultipleShapes?: boolean)](/javascript/api/word/word.shape#word-word-shape-select-member(1))|Selects the shape.| +||[shapeGroup](/javascript/api/word/word.shape#word-word-shape-shapegroup-member)|Gets the shape group associated with the shape.| +||[textFrame](/javascript/api/word/word.shape#word-word-shape-textframe-member)|Gets the text frame object of the shape.| +||[textWrap](/javascript/api/word/word.shape#word-word-shape-textwrap-member)|Returns the text wrap formatting of the shape.| +||[top](/javascript/api/word/word.shape#word-word-shape-top-member)|The distance, in points, from the top edge of the shape to the vertical relative position (see Word.RelativeVerticalPosition).| +||[topRelative](/javascript/api/word/word.shape#word-word-shape-toprelative-member)|The relative top position as a percentage from the top edge of the shape to the vertical relative position, see Word.RelativeVerticalPosition.| +||[type](/javascript/api/word/word.shape#word-word-shape-type-member)|Gets the shape type.| +||[visible](/javascript/api/word/word.shape#word-word-shape-visible-member)|Specifies if the shape is visible.| +||[width](/javascript/api/word/word.shape#word-word-shape-width-member)|The width, in points, of the shape.| +||[widthRelative](/javascript/api/word/word.shape#word-word-shape-widthrelative-member)|The percentage of shape width to horizontal relative size, see Word.RelativeSize.| +|[ShapeCollection](/javascript/api/word/word.shapecollection)|[getByGeometricTypes(types: Word.GeometricShapeType[])](/javascript/api/word/word.shapecollection#word-word-shapecollection-getbygeometrictypes-member(1))|Gets the shapes that have the specified geometric types.| +||[getById(id: number)](/javascript/api/word/word.shapecollection#word-word-shapecollection-getbyid-member(1))|Gets a shape by its identifier.| +||[getByIdOrNullObject(id: number)](/javascript/api/word/word.shapecollection#word-word-shapecollection-getbyidornullobject-member(1))|Gets a shape by its identifier.| +||[getByIds(ids: number[])](/javascript/api/word/word.shapecollection#word-word-shapecollection-getbyids-member(1))|Gets the shapes by the identifiers.| +||[getByNames(names: string[])](/javascript/api/word/word.shapecollection#word-word-shapecollection-getbynames-member(1))|Gets the shapes that have the specified names.| +||[getByTypes(types: Word.ShapeType[])](/javascript/api/word/word.shapecollection#word-word-shapecollection-getbytypes-member(1))|Gets the shapes that have the specified types.| +||[getFirst()](/javascript/api/word/word.shapecollection#word-word-shapecollection-getfirst-member(1))|Gets the first shape in this collection.| +||[getFirstOrNullObject()](/javascript/api/word/word.shapecollection#word-word-shapecollection-getfirstornullobject-member(1))|Gets the first shape in this collection.| +||[group()](/javascript/api/word/word.shapecollection#word-word-shapecollection-group-member(1))|Groups floating shapes in this collection, inline shapes will be skipped.| +||[items](/javascript/api/word/word.shapecollection#word-word-shapecollection-items-member)|Gets the loaded child items in this collection.| +|[ShapeFill](/javascript/api/word/word.shapefill)|[backgroundColor](/javascript/api/word/word.shapefill#word-word-shapefill-backgroundcolor-member)|Specifies the shape fill background color.| +||[clear()](/javascript/api/word/word.shapefill#word-word-shapefill-clear-member(1))|Clears the fill formatting of this shape and set it to `Word.ShapeFillType.NoFill`;| +||[foregroundColor](/javascript/api/word/word.shapefill#word-word-shapefill-foregroundcolor-member)|Specifies the shape fill foreground color.| +||[setSolidColor(color: string)](/javascript/api/word/word.shapefill#word-word-shapefill-setsolidcolor-member(1))|Sets the fill formatting of the shape to a uniform color.| +||[transparency](/javascript/api/word/word.shapefill#word-word-shapefill-transparency-member)|Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear).| +||[type](/javascript/api/word/word.shapefill#word-word-shapefill-type-member)|Returns the fill type of the shape.| +|[ShapeGroup](/javascript/api/word/word.shapegroup)|[id](/javascript/api/word/word.shapegroup#word-word-shapegroup-id-member)|Gets an integer that represents the shape group identifier.| +||[shape](/javascript/api/word/word.shapegroup#word-word-shapegroup-shape-member)|Gets the Shape object associated with the group.| +||[shapes](/javascript/api/word/word.shapegroup#word-word-shapegroup-shapes-member)|Gets the collection of Shape objects.| +||[ungroup()](/javascript/api/word/word.shapegroup#word-word-shapegroup-ungroup-member(1))|Ungroups any grouped shapes in the specified shape group.| +|[ShapeTextWrap](/javascript/api/word/word.shapetextwrap)|[bottomDistance](/javascript/api/word/word.shapetextwrap#word-word-shapetextwrap-bottomdistance-member)|Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape.| +||[leftDistance](/javascript/api/word/word.shapetextwrap#word-word-shapetextwrap-leftdistance-member)|Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape.| +||[rightDistance](/javascript/api/word/word.shapetextwrap#word-word-shapetextwrap-rightdistance-member)|Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape.| +||[side](/javascript/api/word/word.shapetextwrap#word-word-shapetextwrap-side-member)|Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farthest from the page margin.| +||[topDistance](/javascript/api/word/word.shapetextwrap#word-word-shapetextwrap-topdistance-member)|Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape.| +||[type](/javascript/api/word/word.shapetextwrap#word-word-shapetextwrap-type-member)|Specifies the text wrap type around the shape.| +|[TextFrame](/javascript/api/word/word.textframe)|[autoSizeSetting](/javascript/api/word/word.textframe#word-word-textframe-autosizesetting-member)|The automatic sizing settings for the text frame.| +||[bottomMargin](/javascript/api/word/word.textframe#word-word-textframe-bottommargin-member)|Represents the bottom margin, in points, of the text frame.| +||[hasText](/javascript/api/word/word.textframe#word-word-textframe-hastext-member)|Specifies if the text frame contains text.| +||[leftMargin](/javascript/api/word/word.textframe#word-word-textframe-leftmargin-member)|Represents the left margin, in points, of the text frame.| +||[noTextRotation](/javascript/api/word/word.textframe#word-word-textframe-notextrotation-member)|Returns True if text in the text frame shouldn't rotate when the shape is rotated.| +||[orientation](/javascript/api/word/word.textframe#word-word-textframe-orientation-member)|Represents the angle to which the text is oriented for the text frame.| +||[rightMargin](/javascript/api/word/word.textframe#word-word-textframe-rightmargin-member)|Represents the right margin, in points, of the text frame.| +||[topMargin](/javascript/api/word/word.textframe#word-word-textframe-topmargin-member)|Represents the top margin, in points, of the text frame.| +||[verticalAlignment](/javascript/api/word/word.textframe#word-word-textframe-verticalalignment-member)|Represents the vertical alignment of the text frame.| +||[wordWrap](/javascript/api/word/word.textframe#word-word-textframe-wordwrap-member)|Determines whether lines break automatically to fit text inside the shape.| +|[Window](/javascript/api/word/word.window)|[activePane](/javascript/api/word/word.window#word-word-window-activepane-member)|Gets the active pane in the window.| +||[panes](/javascript/api/word/word.window#word-word-window-panes-member)|Gets the collection of panes in the window.| +|[WindowCollection](/javascript/api/word/word.windowcollection)|[getFirst()](/javascript/api/word/word.windowcollection#word-word-windowcollection-getfirst-member(1))|Gets the first window in this collection.| +||[getFirstOrNullObject()](/javascript/api/word/word.windowcollection#word-word-windowcollection-getfirstornullobject-member(1))|Gets the first window in this collection.| +||[items](/javascript/api/word/word.windowcollection#word-word-windowcollection-items-member)|Gets the loaded child items in this collection.| diff --git a/docs/includes/word-preview.md b/docs/includes/word-preview.md index 16b0f532b8..a0d1b5455b 100644 --- a/docs/includes/word-preview.md +++ b/docs/includes/word-preview.md @@ -1,952 +1,1393 @@ | Class | Fields | Description | |:---|:---|:---| -|[Application](/.application)|[bibliography](/.application#word-javascript/api/word/-application-bibliography-member)|Returns a `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word.| -||[checkLanguage](/.application#word-javascript/api/word/-application-checklanguage-member)|Specifies if Microsoft Word automatically detects the language you are using as you type.| -||[language](/.application#word-javascript/api/word/-application-language-member)|Gets a `LanguageId` value that represents the language selected for the Microsoft Word user interface.| -||[templates](/.application#word-javascript/api/word/-application-templates-member)|Returns a `TemplateCollection` object that represents all the available templates: global templates and those attached to open documents.| -|[Bibliography](/.bibliography)|[bibliographyStyle](/.bibliography#word-javascript/api/word/-bibliography-bibliographystyle-member)|Specifies the name of the active style to use for the bibliography.| -||[generateUniqueTag()](/.bibliography#word-javascript/api/word/-bibliography-generateuniquetag-member(1))|Generates a unique identification tag for a bibliography source and returns a string that represents the tag.| -||[sources](/.bibliography#word-javascript/api/word/-bibliography-sources-member)|Returns a `SourceCollection` object that represents all the sources contained in the bibliography.| -|[Body](/.body)|[onCommentAdded](/.body#word-javascript/api/word/-body-oncommentadded-member)|Occurs when new comments are added.| -||[onCommentChanged](/.body#word-javascript/api/word/-body-oncommentchanged-member)|Occurs when a comment or its reply is changed.| -||[onCommentDeleted](/.body#word-javascript/api/word/-body-oncommentdeleted-member)|Occurs when comments are deleted.| -||[onCommentDeselected](/.body#word-javascript/api/word/-body-oncommentdeselected-member)|Occurs when a comment is deselected.| -||[onCommentSelected](/.body#word-javascript/api/word/-body-oncommentselected-member)|Occurs when a comment is selected.| -||[type](/.body#word-javascript/api/word/-body-type-member)|Gets the type of the body.| -|[Bookmark](/.bookmark)|[copyTo(name: string)](/.bookmark#word-javascript/api/word/-bookmark-copyto-member(1))|Copies this bookmark to the new bookmark specified in the `name` argument and returns a `Bookmark` object.| -||[delete()](/.bookmark#word-javascript/api/word/-bookmark-delete-member(1))|Deletes the bookmark.| -||[end](/.bookmark#word-javascript/api/word/-bookmark-end-member)|Specifies the ending character position of the bookmark.| -||[isColumn](/.bookmark#word-javascript/api/word/-bookmark-iscolumn-member)|Returns `true` if the bookmark is a table column.| -||[isEmpty](/.bookmark#word-javascript/api/word/-bookmark-isempty-member)|Returns `true` if the bookmark is empty.| -||[name](/.bookmark#word-javascript/api/word/-bookmark-name-member)|Returns the name of the `Bookmark` object.| -||[range](/.bookmark#word-javascript/api/word/-bookmark-range-member)|Returns a `Range` object that represents the portion of the document that's contained in the `Bookmark` object.| -||[select()](/.bookmark#word-javascript/api/word/-bookmark-select-member(1))|Selects the bookmark.| -||[start](/.bookmark#word-javascript/api/word/-bookmark-start-member)|Specifies the starting character position of the bookmark.| -||[storyType](/.bookmark#word-javascript/api/word/-bookmark-storytype-member)|Returns the story type for the bookmark.| -|[BookmarkCollection](/.bookmarkcollection)|[exists(name: string)](/.bookmarkcollection#word-javascript/api/word/-bookmarkcollection-exists-member(1))|Determines whether the specified bookmark exists.| -||[getItem(index: number)](/.bookmarkcollection#word-javascript/api/word/-bookmarkcollection-getitem-member(1))|Gets a `Bookmark` object by its index in the collection.| -||[items](/.bookmarkcollection#word-javascript/api/word/-bookmarkcollection-items-member)|Gets the loaded child items in this collection.| -|[BorderUniversal](/.borderuniversal)|[artStyle](/.borderuniversal#word-javascript/api/word/-borderuniversal-artstyle-member)|Specifies the graphical page-border design for the document.| -||[artWidth](/.borderuniversal#word-javascript/api/word/-borderuniversal-artwidth-member)|Specifies the width (in points) of the graphical page border specified in the `artStyle` property.| -||[color](/.borderuniversal#word-javascript/api/word/-borderuniversal-color-member)|Specifies the color for the `BorderUniversal` object.| -||[colorIndex](/.borderuniversal#word-javascript/api/word/-borderuniversal-colorindex-member)|Specifies the color for the `BorderUniversal` or Word.Font object.| -||[inside](/.borderuniversal#word-javascript/api/word/-borderuniversal-inside-member)|Returns `true` if an inside border can be applied to the specified object.| -||[isVisible](/.borderuniversal#word-javascript/api/word/-borderuniversal-isvisible-member)|Specifies whether the border is visible.| -||[lineStyle](/.borderuniversal#word-javascript/api/word/-borderuniversal-linestyle-member)|Specifies the line style of the border.| -||[lineWidth](/.borderuniversal#word-javascript/api/word/-borderuniversal-linewidth-member)|Specifies the line width of an object's border.| -|[BorderUniversalCollection](/.borderuniversalcollection)|[applyPageBordersToAllSections()](/.borderuniversalcollection#word-javascript/api/word/-borderuniversalcollection-applypageborderstoallsections-member(1))|Applies the specified page-border formatting to all sections in the document.| -||[getItem(index: number)](/.borderuniversalcollection#word-javascript/api/word/-borderuniversalcollection-getitem-member(1))|Gets a `Border` object by its index in the collection.| -||[items](/.borderuniversalcollection#word-javascript/api/word/-borderuniversalcollection-items-member)|Gets the loaded child items in this collection.| -|[Break](/.break)|[pageIndex](/.break#word-javascript/api/word/-break-pageindex-member)|Returns the page number on which the break occurs.| -||[range](/.break#word-javascript/api/word/-break-range-member)|Returns a `Range` object that represents the portion of the document that's contained in the break.| -|[BreakCollection](/.breakcollection)|[items](/.breakcollection#word-javascript/api/word/-breakcollection-items-member)|Gets the loaded child items in this collection.| -|[BuildingBlock](/.buildingblock)|[category](/.buildingblock#word-javascript/api/word/-buildingblock-category-member)|Returns a `BuildingBlockCategory` object that represents the category for the building block.| -||[delete()](/.buildingblock#word-javascript/api/word/-buildingblock-delete-member(1))|Deletes the building block.| -||[description](/.buildingblock#word-javascript/api/word/-buildingblock-description-member)|Specifies the description for the building block.| -||[id](/.buildingblock#word-javascript/api/word/-buildingblock-id-member)|Returns the internal identification number for the building block.| -||[index](/.buildingblock#word-javascript/api/word/-buildingblock-index-member)|Returns the position of this building block in a collection.| -||[insert(range: Word.Range, richText: boolean)](/.buildingblock#word-javascript/api/word/-buildingblock-insert-member(1))|Inserts the value of the building block into the document and returns a `Range` object that represents the contents of the building block within the document.| -||[insertType](/.buildingblock#word-javascript/api/word/-buildingblock-inserttype-member)|Specifies a `DocPartInsertType` value that represents how to insert the contents of the building block into the document.| -||[name](/.buildingblock#word-javascript/api/word/-buildingblock-name-member)|Specifies the name of the building block.| -||[type](/.buildingblock#word-javascript/api/word/-buildingblock-type-member)|Returns a `BuildingBlockTypeItem` object that represents the type for the building block.| -||[value](/.buildingblock#word-javascript/api/word/-buildingblock-value-member)|Specifies the contents of the building block.| -|[BuildingBlockCategory](/.buildingblockcategory)|[buildingBlocks](/.buildingblockcategory#word-javascript/api/word/-buildingblockcategory-buildingblocks-member)|Returns a `BuildingBlockCollection` object that represents the building blocks for the category.| -||[index](/.buildingblockcategory#word-javascript/api/word/-buildingblockcategory-index-member)|Returns the position of the `BuildingBlockCategory` object in a collection.| -||[name](/.buildingblockcategory#word-javascript/api/word/-buildingblockcategory-name-member)|Returns the name of the `BuildingBlockCategory` object.| -||[type](/.buildingblockcategory#word-javascript/api/word/-buildingblockcategory-type-member)|Returns a `BuildingBlockTypeItem` object that represents the type of building block for the building block category.| -|[BuildingBlockCategoryCollection](/.buildingblockcategorycollection)|[getCount()](/.buildingblockcategorycollection#word-javascript/api/word/-buildingblockcategorycollection-getcount-member(1))|Returns the number of items in the collection.| -||[getItemAt(index: number)](/.buildingblockcategorycollection#word-javascript/api/word/-buildingblockcategorycollection-getitemat-member(1))|Returns a `BuildingBlockCategory` object that represents the specified item in the collection.| -|[BuildingBlockCollection](/.buildingblockcollection)|[add(name: string, range: Word.Range, description: string, insertType: Word.DocPartInsertType)](/.buildingblockcollection#word-javascript/api/word/-buildingblockcollection-add-member(1))|Creates a new building block and returns a `BuildingBlock` object.| -||[getCount()](/.buildingblockcollection#word-javascript/api/word/-buildingblockcollection-getcount-member(1))|Returns the number of items in the collection.| -||[getItemAt(index: number)](/.buildingblockcollection#word-javascript/api/word/-buildingblockcollection-getitemat-member(1))|Returns a `BuildingBlock` object that represents the specified item in the collection.| -|[BuildingBlockEntryCollection](/.buildingblockentrycollection)|[add(name: string, type: Word.BuildingBlockType, category: string, range: Word.Range, description: string, insertType: Word.DocPartInsertType)](/.buildingblockentrycollection#word-javascript/api/word/-buildingblockentrycollection-add-member(1))|Creates a new building block entry in a template and returns a `BuildingBlock` object that represents the new building block entry.| -||[getCount()](/.buildingblockentrycollection#word-javascript/api/word/-buildingblockentrycollection-getcount-member(1))|Returns the number of items in the collection.| -||[getItemAt(index: number)](/.buildingblockentrycollection#word-javascript/api/word/-buildingblockentrycollection-getitemat-member(1))|Returns a `BuildingBlock` object that represents the specified item in the collection.| -|[BuildingBlockGalleryContentControl](/.buildingblockgallerycontentcontrol)|[appearance](/.buildingblockgallerycontentcontrol#word-javascript/api/word/-buildingblockgallerycontentcontrol-appearance-member)|Specifies the appearance of the content control.| -||[buildingBlockCategory](/.buildingblockgallerycontentcontrol#word-javascript/api/word/-buildingblockgallerycontentcontrol-buildingblockcategory-member)|Specifies the category for the building block content control.| -||[buildingBlockType](/.buildingblockgallerycontentcontrol#word-javascript/api/word/-buildingblockgallerycontentcontrol-buildingblocktype-member)|Specifies a `BuildingBlockType` value that represents the type of building block for the building block content control.| -||[color](/.buildingblockgallerycontentcontrol#word-javascript/api/word/-buildingblockgallerycontentcontrol-color-member)|Specifies the red-green-blue (RGB) value of the color of the content control.| -||[copy()](/.buildingblockgallerycontentcontrol#word-javascript/api/word/-buildingblockgallerycontentcontrol-copy-member(1))|Copies the content control from the active document to the Clipboard.| -||[cut()](/.buildingblockgallerycontentcontrol#word-javascript/api/word/-buildingblockgallerycontentcontrol-cut-member(1))|Removes the content control from the active document and moves the content control to the Clipboard.| -||[delete(deleteContents?: boolean)](/.buildingblockgallerycontentcontrol#word-javascript/api/word/-buildingblockgallerycontentcontrol-delete-member(1))|Deletes the content control and optionally its contents.| -||[id](/.buildingblockgallerycontentcontrol#word-javascript/api/word/-buildingblockgallerycontentcontrol-id-member)|Gets the identification for the content control.| -||[isTemporary](/.buildingblockgallerycontentcontrol#word-javascript/api/word/-buildingblockgallerycontentcontrol-istemporary-member)|Specifies whether to remove the content control from the active document when the user edits the contents of the control.| -||[level](/.buildingblockgallerycontentcontrol#word-javascript/api/word/-buildingblockgallerycontentcontrol-level-member)|Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline.| -||[lockContentControl](/.buildingblockgallerycontentcontrol#word-javascript/api/word/-buildingblockgallerycontentcontrol-lockcontentcontrol-member)|Specifies if the content control is locked (can't be deleted).| -||[lockContents](/.buildingblockgallerycontentcontrol#word-javascript/api/word/-buildingblockgallerycontentcontrol-lockcontents-member)|Specifies if the contents of the content control are locked (not editable).| -||[placeholderText](/.buildingblockgallerycontentcontrol#word-javascript/api/word/-buildingblockgallerycontentcontrol-placeholdertext-member)|Returns a `BuildingBlock` object that represents the placeholder text for the content control.| -||[range](/.buildingblockgallerycontentcontrol#word-javascript/api/word/-buildingblockgallerycontentcontrol-range-member)|Returns a `Range` object that represents the contents of the content control in the active document.| -||[setPlaceholderText(options?: Word.ContentControlPlaceholderOptions)](/.buildingblockgallerycontentcontrol#word-javascript/api/word/-buildingblockgallerycontentcontrol-setplaceholdertext-member(1))|Sets the placeholder text that displays in the content control until a user enters their own text.| -||[showingPlaceholderText](/.buildingblockgallerycontentcontrol#word-javascript/api/word/-buildingblockgallerycontentcontrol-showingplaceholdertext-member)|Gets if the placeholder text for the content control is being displayed.| -||[tag](/.buildingblockgallerycontentcontrol#word-javascript/api/word/-buildingblockgallerycontentcontrol-tag-member)|Specifies a tag to identify the content control.| -||[title](/.buildingblockgallerycontentcontrol#word-javascript/api/word/-buildingblockgallerycontentcontrol-title-member)|Specifies the title for the content control.| -||[xmlMapping](/.buildingblockgallerycontentcontrol#word-javascript/api/word/-buildingblockgallerycontentcontrol-xmlmapping-member)|Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document.| -|[BuildingBlockTypeItem](/.buildingblocktypeitem)|[categories](/.buildingblocktypeitem#word-javascript/api/word/-buildingblocktypeitem-categories-member)|Returns a `BuildingBlockCategoryCollection` object that represents the categories for a building block type.| -||[index](/.buildingblocktypeitem#word-javascript/api/word/-buildingblocktypeitem-index-member)|Returns the position of an item in a collection.| -||[name](/.buildingblocktypeitem#word-javascript/api/word/-buildingblocktypeitem-name-member)|Returns the localized name of a building block type.| -|[BuildingBlockTypeItemCollection](/.buildingblocktypeitemcollection)|[getByType(type: Word.BuildingBlockType)](/.buildingblocktypeitemcollection#word-javascript/api/word/-buildingblocktypeitemcollection-getbytype-member(1))|Gets a `BuildingBlockTypeItem` object by its type in the collection.| -||[getCount()](/.buildingblocktypeitemcollection#word-javascript/api/word/-buildingblocktypeitemcollection-getcount-member(1))|Returns the number of items in the collection.| -|[ColorFormat](/.colorformat)|[brightness](/.colorformat#word-javascript/api/word/-colorformat-brightness-member)|Specifies the brightness of a specified shape color.| -||[objectThemeColor](/.colorformat#word-javascript/api/word/-colorformat-objectthemecolor-member)|Specifies the theme color for a color format.| -||[rgb](/.colorformat#word-javascript/api/word/-colorformat-rgb-member)|Specifies the red-green-blue (RGB) value of the specified color.| -||[tintAndShade](/.colorformat#word-javascript/api/word/-colorformat-tintandshade-member)|Specifies the lightening or darkening of a specified shape's color.| -||[type](/.colorformat#word-javascript/api/word/-colorformat-type-member)|Returns the shape color type.| -|[CommentDetail](/.commentdetail)|[id](/.commentdetail#word-javascript/api/word/-commentdetail-id-member)|Represents the ID of this comment.| -||[replyIds](/.commentdetail#word-javascript/api/word/-commentdetail-replyids-member)|Represents the IDs of the replies to this comment.| -|[CommentEventArgs](/.commenteventargs)|[changeType](/.commenteventargs#word-javascript/api/word/-commenteventargs-changetype-member)|Represents how the comment changed event is triggered.| -||[commentDetails](/.commenteventargs#word-javascript/api/word/-commenteventargs-commentdetails-member)|Gets the CommentDetail array which contains the IDs and reply IDs of the involved comments.| -||[source](/.commenteventargs#word-javascript/api/word/-commenteventargs-source-member)|The source of the event.| -||[type](/.commenteventargs#word-javascript/api/word/-commenteventargs-type-member)|The event type.| -|[ContentControl](/.contentcontrol)|[buildingBlockGalleryContentControl](/.contentcontrol#word-javascript/api/word/-contentcontrol-buildingblockgallerycontentcontrol-member)|Gets the building block gallery-related data if the content control's Word.ContentControlType is `BuildingBlockGallery`.| -||[datePickerContentControl](/.contentcontrol#word-javascript/api/word/-contentcontrol-datepickercontentcontrol-member)|Gets the date picker-related data if the content control's Word.ContentControlType is `DatePicker`.| -||[groupContentControl](/.contentcontrol#word-javascript/api/word/-contentcontrol-groupcontentcontrol-member)|Gets the group-related data if the content control's Word.ContentControlType is `Group`.| -||[onCommentAdded](/.contentcontrol#word-javascript/api/word/-contentcontrol-oncommentadded-member)|Occurs when new comments are added.| -||[onCommentChanged](/.contentcontrol#word-javascript/api/word/-contentcontrol-oncommentchanged-member)|Occurs when a comment or its reply is changed.| -||[onCommentDeselected](/.contentcontrol#word-javascript/api/word/-contentcontrol-oncommentdeselected-member)|Occurs when a comment is deselected.| -||[onCommentSelected](/.contentcontrol#word-javascript/api/word/-contentcontrol-oncommentselected-member)|Occurs when a comment is selected.| -||[pictureContentControl](/.contentcontrol#word-javascript/api/word/-contentcontrol-picturecontentcontrol-member)|Gets the picture-related data if the content control's Word.ContentControlType is `Picture`.| -||[repeatingSectionContentControl](/.contentcontrol#word-javascript/api/word/-contentcontrol-repeatingsectioncontentcontrol-member)|Gets the repeating section-related data if the content control's Word.ContentControlType is `RepeatingSection`.| -||[resetState()](/.contentcontrol#word-javascript/api/word/-contentcontrol-resetstate-member(1))|Resets the state of the content control.| -||[setState(contentControlState: Word.ContentControlState)](/.contentcontrol#word-javascript/api/word/-contentcontrol-setstate-member(1))|Sets the state of the content control.| -||[xmlMapping](/.contentcontrol#word-javascript/api/word/-contentcontrol-xmlmapping-member)|Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document.| -|[ContentControlAddedEventArgs](/.contentcontroladdedeventargs)|[eventType](/.contentcontroladdedeventargs#word-javascript/api/word/-contentcontroladdedeventargs-eventtype-member)|The event type.| -|[ContentControlDataChangedEventArgs](/.contentcontroldatachangedeventargs)|[eventType](/.contentcontroldatachangedeventargs#word-javascript/api/word/-contentcontroldatachangedeventargs-eventtype-member)|The event type.| -|[ContentControlDeletedEventArgs](/.contentcontroldeletedeventargs)|[eventType](/.contentcontroldeletedeventargs#word-javascript/api/word/-contentcontroldeletedeventargs-eventtype-member)|The event type.| -|[ContentControlEnteredEventArgs](/.contentcontrolenteredeventargs)|[eventType](/.contentcontrolenteredeventargs#word-javascript/api/word/-contentcontrolenteredeventargs-eventtype-member)|The event type.| -|[ContentControlExitedEventArgs](/.contentcontrolexitedeventargs)|[eventType](/.contentcontrolexitedeventargs#word-javascript/api/word/-contentcontrolexitedeventargs-eventtype-member)|The event type.| -|[ContentControlPlaceholderOptions](/.contentcontrolplaceholderoptions)|[buildingBlock](/.contentcontrolplaceholderoptions#word-javascript/api/word/-contentcontrolplaceholderoptions-buildingblock-member)|If provided, specifies the `BuildingBlock` object to use as placeholder.| -||[range](/.contentcontrolplaceholderoptions#word-javascript/api/word/-contentcontrolplaceholderoptions-range-member)|If provided, specifies the `Range` object to use as placeholder.| -||[text](/.contentcontrolplaceholderoptions#word-javascript/api/word/-contentcontrolplaceholderoptions-text-member)|If provided, specifies the text to use as placeholder.| -|[ContentControlSelectionChangedEventArgs](/.contentcontrolselectionchangedeventargs)|[eventType](/.contentcontrolselectionchangedeventargs#word-javascript/api/word/-contentcontrolselectionchangedeventargs-eventtype-member)|The event type.| -|[CustomXmlAddNodeOptions](/.customxmladdnodeoptions)|[name](/.customxmladdnodeoptions#word-javascript/api/word/-customxmladdnodeoptions-name-member)|If provided, specifies the base name of the element to be added.| -||[namespaceUri](/.customxmladdnodeoptions#word-javascript/api/word/-customxmladdnodeoptions-namespaceuri-member)|If provided, specifies the namespace of the element to be appended.| -||[nextSibling](/.customxmladdnodeoptions#word-javascript/api/word/-customxmladdnodeoptions-nextsibling-member)|If provided, specifies the node which should become the next sibling of the new node.| -||[nodeType](/.customxmladdnodeoptions#word-javascript/api/word/-customxmladdnodeoptions-nodetype-member)|If provided, specifies the type of node to add.| -||[nodeValue](/.customxmladdnodeoptions#word-javascript/api/word/-customxmladdnodeoptions-nodevalue-member)|If provided, specifies the value of the added node for those nodes that allow text.| -|[CustomXmlAddSchemaOptions](/.customxmladdschemaoptions)|[alias](/.customxmladdschemaoptions#word-javascript/api/word/-customxmladdschemaoptions-alias-member)|If provided, specifies the alias of the schema to be added to the collection.| -||[fileName](/.customxmladdschemaoptions#word-javascript/api/word/-customxmladdschemaoptions-filename-member)|If provided, specifies the location of the schema on a disk.| -||[installForAllUsers](/.customxmladdschemaoptions#word-javascript/api/word/-customxmladdschemaoptions-installforallusers-member)|If provided, specifies whether, in the case where the schema is being added to the Schema Library, the Schema Library keys should be written to the registry (`HKEY_LOCAL_MACHINE` for all users or `HKEY_CURRENT_USER` for just the current user).| -||[namespaceUri](/.customxmladdschemaoptions#word-javascript/api/word/-customxmladdschemaoptions-namespaceuri-member)|If provided, specifies the namespace of the schema to be added to the collection.| -|[CustomXmlAddValidationErrorOptions](/.customxmladdvalidationerroroptions)|[clearedOnUpdate](/.customxmladdvalidationerroroptions#word-javascript/api/word/-customxmladdvalidationerroroptions-clearedonupdate-member)|If provided, specifies whether the error is to be cleared from the Word.CustomXmlValidationErrorCollection when the XML is corrected and updated.| -||[errorText](/.customxmladdvalidationerroroptions#word-javascript/api/word/-customxmladdvalidationerroroptions-errortext-member)|If provided, specifies the descriptive error text.| -|[CustomXmlAppendChildNodeOptions](/.customxmlappendchildnodeoptions)|[name](/.customxmlappendchildnodeoptions#word-javascript/api/word/-customxmlappendchildnodeoptions-name-member)|If provided, specifies the base name of the element to be appended.| -||[namespaceUri](/.customxmlappendchildnodeoptions#word-javascript/api/word/-customxmlappendchildnodeoptions-namespaceuri-member)|If provided, specifies the namespace of the element to be appended.| -||[nodeType](/.customxmlappendchildnodeoptions#word-javascript/api/word/-customxmlappendchildnodeoptions-nodetype-member)|If provided, specifies the type of node to append.| -||[nodeValue](/.customxmlappendchildnodeoptions#word-javascript/api/word/-customxmlappendchildnodeoptions-nodevalue-member)|If provided, specifies the value of the appended node for those nodes that allow text.| -|[CustomXmlInsertNodeBeforeOptions](/.customxmlinsertnodebeforeoptions)|[name](/.customxmlinsertnodebeforeoptions#word-javascript/api/word/-customxmlinsertnodebeforeoptions-name-member)|If provided, specifies the base name of the element to be inserted.| -||[namespaceUri](/.customxmlinsertnodebeforeoptions#word-javascript/api/word/-customxmlinsertnodebeforeoptions-namespaceuri-member)|If provided, specifies the namespace of the element to be inserted.| -||[nextSibling](/.customxmlinsertnodebeforeoptions#word-javascript/api/word/-customxmlinsertnodebeforeoptions-nextsibling-member)|If provided, specifies the context node.| -||[nodeType](/.customxmlinsertnodebeforeoptions#word-javascript/api/word/-customxmlinsertnodebeforeoptions-nodetype-member)|If provided, specifies the type of node to append.| -||[nodeValue](/.customxmlinsertnodebeforeoptions#word-javascript/api/word/-customxmlinsertnodebeforeoptions-nodevalue-member)|If provided, specifies the value of the inserted node for those nodes that allow text.| -|[CustomXmlInsertSubtreeBeforeOptions](/.customxmlinsertsubtreebeforeoptions)|[nextSibling](/.customxmlinsertsubtreebeforeoptions#word-javascript/api/word/-customxmlinsertsubtreebeforeoptions-nextsibling-member)|If provided, specifies the context node.| -|[CustomXmlNode](/.customxmlnode)|[appendChildNode(options?: Word.CustomXmlAppendChildNodeOptions)](/.customxmlnode#word-javascript/api/word/-customxmlnode-appendchildnode-member(1))|Appends a single node as the last child under the context element node in the tree.| -||[appendChildSubtree(xml: string)](/.customxmlnode#word-javascript/api/word/-customxmlnode-appendchildsubtree-member(1))|Adds a subtree as the last child under the context element node in the tree.| -||[attributes](/.customxmlnode#word-javascript/api/word/-customxmlnode-attributes-member)|Gets a `CustomXmlNodeCollection` object representing the attributes of the current element in the current node.| -||[baseName](/.customxmlnode#word-javascript/api/word/-customxmlnode-basename-member)|Gets the base name of the node without the namespace prefix, if one exists.| -||[childNodes](/.customxmlnode#word-javascript/api/word/-customxmlnode-childnodes-member)|Gets a `CustomXmlNodeCollection` object containing all of the child elements of the current node.| -||[delete()](/.customxmlnode#word-javascript/api/word/-customxmlnode-delete-member(1))|Deletes the current node from the tree (including all of its children, if any exist).| -||[firstChild](/.customxmlnode#word-javascript/api/word/-customxmlnode-firstchild-member)|Gets a `CustomXmlNode` object corresponding to the first child element of the current node.| -||[hasChildNodes()](/.customxmlnode#word-javascript/api/word/-customxmlnode-haschildnodes-member(1))|Specifies if the current element node has child element nodes.| -||[insertNodeBefore(options?: Word.CustomXmlInsertNodeBeforeOptions)](/.customxmlnode#word-javascript/api/word/-customxmlnode-insertnodebefore-member(1))|Inserts a new node just before the context node in the tree.| -||[insertSubtreeBefore(xml: string, options?: Word.CustomXmlInsertSubtreeBeforeOptions)](/.customxmlnode#word-javascript/api/word/-customxmlnode-insertsubtreebefore-member(1))|Inserts the specified subtree into the location just before the context node.| -||[lastChild](/.customxmlnode#word-javascript/api/word/-customxmlnode-lastchild-member)|Gets a `CustomXmlNode` object corresponding to the last child element of the current node.| -||[namespaceUri](/.customxmlnode#word-javascript/api/word/-customxmlnode-namespaceuri-member)|Gets the unique address identifier for the namespace of the node.| -||[nextSibling](/.customxmlnode#word-javascript/api/word/-customxmlnode-nextsibling-member)|Gets the next sibling node (element, comment, or processing instruction) of the current node.| -||[nodeType](/.customxmlnode#word-javascript/api/word/-customxmlnode-nodetype-member)|Gets the type of the current node.| -||[nodeValue](/.customxmlnode#word-javascript/api/word/-customxmlnode-nodevalue-member)|Specifies the value of the current node.| -||[ownerPart](/.customxmlnode#word-javascript/api/word/-customxmlnode-ownerpart-member)|Gets the object representing the part associated with this node.| -||[parentNode](/.customxmlnode#word-javascript/api/word/-customxmlnode-parentnode-member)|Gets the parent element node of the current node.| -||[previousSibling](/.customxmlnode#word-javascript/api/word/-customxmlnode-previoussibling-member)|Gets the previous sibling node (element, comment, or processing instruction) of the current node.| -||[removeChild(child: Word.CustomXmlNode)](/.customxmlnode#word-javascript/api/word/-customxmlnode-removechild-member(1))|Removes the specified child node from the tree.| -||[replaceChildNode(oldNode: Word.CustomXmlNode, options?: Word.CustomXmlReplaceChildNodeOptions)](/.customxmlnode#word-javascript/api/word/-customxmlnode-replacechildnode-member(1))|Removes the specified child node and replaces it with a different node in the same location.| -||[replaceChildSubtree(xml: string, oldNode: Word.CustomXmlNode)](/.customxmlnode#word-javascript/api/word/-customxmlnode-replacechildsubtree-member(1))|Removes the specified node and replaces it with a different subtree in the same location.| -||[selectNodes(xPath: string)](/.customxmlnode#word-javascript/api/word/-customxmlnode-selectnodes-member(1))|Selects a collection of nodes matching an XPath expression.| -||[selectSingleNode(xPath: string)](/.customxmlnode#word-javascript/api/word/-customxmlnode-selectsinglenode-member(1))|Selects a single node from a collection matching an XPath expression.| -||[text](/.customxmlnode#word-javascript/api/word/-customxmlnode-text-member)|Specifies the text for the current node.| -||[xml](/.customxmlnode#word-javascript/api/word/-customxmlnode-xml-member)|Gets the XML representation of the current node and its children.| -||[xpath](/.customxmlnode#word-javascript/api/word/-customxmlnode-xpath-member)|Gets a string with the canonicalized XPath for the current node.| -|[CustomXmlNodeCollection](/.customxmlnodecollection)|[getCount()](/.customxmlnodecollection#word-javascript/api/word/-customxmlnodecollection-getcount-member(1))|Returns the number of items in the collection.| -||[getItem(index: number)](/.customxmlnodecollection#word-javascript/api/word/-customxmlnodecollection-getitem-member(1))|Returns a `CustomXmlNode` object that represents the specified item in the collection.| -||[items](/.customxmlnodecollection#word-javascript/api/word/-customxmlnodecollection-items-member)|Gets the loaded child items in this collection.| -|[CustomXmlPart](/.customxmlpart)|[addNode(parent: Word.CustomXmlNode, options?: Word.CustomXmlAddNodeOptions)](/.customxmlpart#word-javascript/api/word/-customxmlpart-addnode-member(1))|Adds a node to the XML tree.| -||[builtIn](/.customxmlpart#word-javascript/api/word/-customxmlpart-builtin-member)|Gets a value that indicates whether the `CustomXmlPart` is built-in.| -||[documentElement](/.customxmlpart#word-javascript/api/word/-customxmlpart-documentelement-member)|Gets the root element of a bound region of data in the document.| -||[errors](/.customxmlpart#word-javascript/api/word/-customxmlpart-errors-member)|Gets a `CustomXmlValidationErrorCollection` object that provides access to any XML validation errors.| -||[loadXml(xml: string)](/.customxmlpart#word-javascript/api/word/-customxmlpart-loadxml-member(1))|Populates the `CustomXmlPart` object from an XML string.| -||[namespaceManager](/.customxmlpart#word-javascript/api/word/-customxmlpart-namespacemanager-member)|Gets the set of namespace prefix mappings used against the current `CustomXmlPart` object.| -||[schemaCollection](/.customxmlpart#word-javascript/api/word/-customxmlpart-schemacollection-member)|Specifies a `CustomXmlSchemaCollection` object representing the set of schemas attached to a bound region of data in the document.| -||[selectNodes(xPath: string)](/.customxmlpart#word-javascript/api/word/-customxmlpart-selectnodes-member(1))|Selects a collection of nodes from a custom XML part.| -||[selectSingleNode(xPath: string)](/.customxmlpart#word-javascript/api/word/-customxmlpart-selectsinglenode-member(1))|Selects a single node within a custom XML part matching an XPath expression.| -||[xml](/.customxmlpart#word-javascript/api/word/-customxmlpart-xml-member)|Gets the XML representation of the current `CustomXmlPart` object.| -|[CustomXmlPrefixMapping](/.customxmlprefixmapping)|[namespaceUri](/.customxmlprefixmapping#word-javascript/api/word/-customxmlprefixmapping-namespaceuri-member)|Gets the unique address identifier for the namespace of the `CustomXmlPrefixMapping` object.| -||[prefix](/.customxmlprefixmapping#word-javascript/api/word/-customxmlprefixmapping-prefix-member)|Gets the prefix for the `CustomXmlPrefixMapping` object.| -|[CustomXmlPrefixMappingCollection](/.customxmlprefixmappingcollection)|[addNamespace(prefix: string, namespaceUri: string)](/.customxmlprefixmappingcollection#word-javascript/api/word/-customxmlprefixmappingcollection-addnamespace-member(1))|Adds a custom namespace/prefix mapping to use when querying an item.| -||[getCount()](/.customxmlprefixmappingcollection#word-javascript/api/word/-customxmlprefixmappingcollection-getcount-member(1))|Returns the number of items in the collection.| -||[getItem(index: number)](/.customxmlprefixmappingcollection#word-javascript/api/word/-customxmlprefixmappingcollection-getitem-member(1))|Returns a `CustomXmlPrefixMapping` object that represents the specified item in the collection.| -||[items](/.customxmlprefixmappingcollection#word-javascript/api/word/-customxmlprefixmappingcollection-items-member)|Gets the loaded child items in this collection.| -||[lookupNamespace(prefix: string)](/.customxmlprefixmappingcollection#word-javascript/api/word/-customxmlprefixmappingcollection-lookupnamespace-member(1))|Gets the namespace corresponding to the specified prefix.| -||[lookupPrefix(namespaceUri: string)](/.customxmlprefixmappingcollection#word-javascript/api/word/-customxmlprefixmappingcollection-lookupprefix-member(1))|Gets the prefix corresponding to the specified namespace.| -|[CustomXmlReplaceChildNodeOptions](/.customxmlreplacechildnodeoptions)|[name](/.customxmlreplacechildnodeoptions#word-javascript/api/word/-customxmlreplacechildnodeoptions-name-member)|If provided, specifies the base name of the replacement element.| -||[namespaceUri](/.customxmlreplacechildnodeoptions#word-javascript/api/word/-customxmlreplacechildnodeoptions-namespaceuri-member)|If provided, specifies the namespace of the replacement element.| -||[nodeType](/.customxmlreplacechildnodeoptions#word-javascript/api/word/-customxmlreplacechildnodeoptions-nodetype-member)|If provided, specifies the type of the replacement node.| -||[nodeValue](/.customxmlreplacechildnodeoptions#word-javascript/api/word/-customxmlreplacechildnodeoptions-nodevalue-member)|If provided, specifies the value of the replacement node for those nodes that allow text.| -|[CustomXmlSchema](/.customxmlschema)|[delete()](/.customxmlschema#word-javascript/api/word/-customxmlschema-delete-member(1))|Deletes this schema from the Word.CustomXmlSchemaCollection object.| -||[location](/.customxmlschema#word-javascript/api/word/-customxmlschema-location-member)|Gets the location of the schema on a computer.| -||[namespaceUri](/.customxmlschema#word-javascript/api/word/-customxmlschema-namespaceuri-member)|Gets the unique address identifier for the namespace of the `CustomXmlSchema` object.| -||[reload()](/.customxmlschema#word-javascript/api/word/-customxmlschema-reload-member(1))|Reloads the schema from a file.| -|[CustomXmlSchemaCollection](/.customxmlschemacollection)|[add(options?: Word.CustomXmlAddSchemaOptions)](/.customxmlschemacollection#word-javascript/api/word/-customxmlschemacollection-add-member(1))|Adds one or more schemas to the schema collection that can then be added to a stream in the data store and to the schema library.| -||[addCollection(schemaCollection: Word.CustomXmlSchemaCollection)](/.customxmlschemacollection#word-javascript/api/word/-customxmlschemacollection-addcollection-member(1))|Adds an existing schema collection to the current schema collection.| -||[getCount()](/.customxmlschemacollection#word-javascript/api/word/-customxmlschemacollection-getcount-member(1))|Returns the number of items in the collection.| -||[getItem(index: number)](/.customxmlschemacollection#word-javascript/api/word/-customxmlschemacollection-getitem-member(1))|Returns a `CustomXmlSchema` object that represents the specified item in the collection.| -||[getNamespaceUri()](/.customxmlschemacollection#word-javascript/api/word/-customxmlschemacollection-getnamespaceuri-member(1))|Returns the number of items in the collection.| -||[items](/.customxmlschemacollection#word-javascript/api/word/-customxmlschemacollection-items-member)|Gets the loaded child items in this collection.| -||[validate()](/.customxmlschemacollection#word-javascript/api/word/-customxmlschemacollection-validate-member(1))|Specifies whether the schemas in the schema collection are valid (conforms to the syntactic rules of XML and the rules for a specified vocabulary).| -|[CustomXmlValidationError](/.customxmlvalidationerror)|[delete()](/.customxmlvalidationerror#word-javascript/api/word/-customxmlvalidationerror-delete-member(1))|Deletes this `CustomXmlValidationError` object.| -||[errorCode](/.customxmlvalidationerror#word-javascript/api/word/-customxmlvalidationerror-errorcode-member)|Gets an integer representing the validation error in the `CustomXmlValidationError` object.| -||[name](/.customxmlvalidationerror#word-javascript/api/word/-customxmlvalidationerror-name-member)|Gets the name of the error in the `CustomXmlValidationError` object.If no errors exist, the property returns `Nothing`| -||[node](/.customxmlvalidationerror#word-javascript/api/word/-customxmlvalidationerror-node-member)|Gets the node associated with this `CustomXmlValidationError` object, if any exist.If no nodes exist, the property returns `Nothing`.| -||[text](/.customxmlvalidationerror#word-javascript/api/word/-customxmlvalidationerror-text-member)|Gets the text in the `CustomXmlValidationError` object.| -||[type](/.customxmlvalidationerror#word-javascript/api/word/-customxmlvalidationerror-type-member)|Gets the type of error generated from the `CustomXmlValidationError` object.| -|[CustomXmlValidationErrorCollection](/.customxmlvalidationerrorcollection)|[add(node: Word.CustomXmlNode, errorName: string, options?: Word.CustomXmlAddValidationErrorOptions)](/.customxmlvalidationerrorcollection#word-javascript/api/word/-customxmlvalidationerrorcollection-add-member(1))|Adds a `CustomXmlValidationError` object containing an XML validation error to the `CustomXmlValidationErrorCollection` object.| -||[getCount()](/.customxmlvalidationerrorcollection#word-javascript/api/word/-customxmlvalidationerrorcollection-getcount-member(1))|Returns the number of items in the collection.| -||[getItem(index: number)](/.customxmlvalidationerrorcollection#word-javascript/api/word/-customxmlvalidationerrorcollection-getitem-member(1))|Returns a `CustomXmlValidationError` object that represents the specified item in the collection.| -||[items](/.customxmlvalidationerrorcollection#word-javascript/api/word/-customxmlvalidationerrorcollection-items-member)|Gets the loaded child items in this collection.| -|[DatePickerContentControl](/.datepickercontentcontrol)|[appearance](/.datepickercontentcontrol#word-javascript/api/word/-datepickercontentcontrol-appearance-member)|Specifies the appearance of the content control.| -||[color](/.datepickercontentcontrol#word-javascript/api/word/-datepickercontentcontrol-color-member)|Specifies the red-green-blue (RGB) value of the color of the content control.| -||[copy()](/.datepickercontentcontrol#word-javascript/api/word/-datepickercontentcontrol-copy-member(1))|Copies the content control from the active document to the Clipboard.| -||[cut()](/.datepickercontentcontrol#word-javascript/api/word/-datepickercontentcontrol-cut-member(1))|Removes the content control from the active document and moves the content control to the Clipboard.| -||[dateCalendarType](/.datepickercontentcontrol#word-javascript/api/word/-datepickercontentcontrol-datecalendartype-member)|Specifies a `CalendarType` value that represents the calendar type for the date picker content control.| -||[dateDisplayFormat](/.datepickercontentcontrol#word-javascript/api/word/-datepickercontentcontrol-datedisplayformat-member)|Specifies the format in which dates are displayed.| -||[dateDisplayLocale](/.datepickercontentcontrol#word-javascript/api/word/-datepickercontentcontrol-datedisplaylocale-member)|Specifies a `LanguageId` that represents the language format for the date displayed in the date picker content control.| -||[dateStorageFormat](/.datepickercontentcontrol#word-javascript/api/word/-datepickercontentcontrol-datestorageformat-member)|Specifies a `ContentControlDateStorageFormat` value that represents the format for storage and retrieval of dates when the date picker content control is bound to the XML data store of the active document.| -||[delete(deleteContents?: boolean)](/.datepickercontentcontrol#word-javascript/api/word/-datepickercontentcontrol-delete-member(1))|Deletes this content control and the contents of the content control.| -||[id](/.datepickercontentcontrol#word-javascript/api/word/-datepickercontentcontrol-id-member)|Gets the identification for the content control.| -||[isTemporary](/.datepickercontentcontrol#word-javascript/api/word/-datepickercontentcontrol-istemporary-member)|Specifies whether to remove the content control from the active document when the user edits the contents of the control.| -||[level](/.datepickercontentcontrol#word-javascript/api/word/-datepickercontentcontrol-level-member)|Specifies the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline.| -||[lockContentControl](/.datepickercontentcontrol#word-javascript/api/word/-datepickercontentcontrol-lockcontentcontrol-member)|Specifies if the content control is locked (can't be deleted).| -||[lockContents](/.datepickercontentcontrol#word-javascript/api/word/-datepickercontentcontrol-lockcontents-member)|Specifies if the contents of the content control are locked (not editable).| -||[placeholderText](/.datepickercontentcontrol#word-javascript/api/word/-datepickercontentcontrol-placeholdertext-member)|Returns a `BuildingBlock` object that represents the placeholder text for the content control.| -||[range](/.datepickercontentcontrol#word-javascript/api/word/-datepickercontentcontrol-range-member)|Gets a `Range` object that represents the contents of the content control in the active document.| -||[setPlaceholderText(options?: Word.ContentControlPlaceholderOptions)](/.datepickercontentcontrol#word-javascript/api/word/-datepickercontentcontrol-setplaceholdertext-member(1))|Sets the placeholder text that displays in the content control until a user enters their own text.| -||[showingPlaceholderText](/.datepickercontentcontrol#word-javascript/api/word/-datepickercontentcontrol-showingplaceholdertext-member)|Gets whether the placeholder text for the content control is being displayed.| -||[tag](/.datepickercontentcontrol#word-javascript/api/word/-datepickercontentcontrol-tag-member)|Specifies a tag to identify the content control.| -||[title](/.datepickercontentcontrol#word-javascript/api/word/-datepickercontentcontrol-title-member)|Specifies the title for the content control.| -||[xmlMapping](/.datepickercontentcontrol#word-javascript/api/word/-datepickercontentcontrol-xmlmapping-member)|Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document.| -|[Document](/.document)|[attachedTemplate](/.document#word-javascript/api/word/-document-attachedtemplate-member)|Specifies a `Template` object that represents the template attached to the document.| -||[autoHyphenation](/.document#word-javascript/api/word/-document-autohyphenation-member)|Specifies if automatic hyphenation is turned on for the document.| -||[autoSaveOn](/.document#word-javascript/api/word/-document-autosaveon-member)|Specifies if the edits in the document are automatically saved.| -||[bibliography](/.document#word-javascript/api/word/-document-bibliography-member)|Returns a `Bibliography` object that represents the bibliography references contained within the document.| -||[bookmarks](/.document#word-javascript/api/word/-document-bookmarks-member)|Returns a `BookmarkCollection` object that represents all the bookmarks in the document.| -||[consecutiveHyphensLimit](/.document#word-javascript/api/word/-document-consecutivehyphenslimit-member)|Specifies the maximum number of consecutive lines that can end with hyphens.| -||[detectLanguage()](/.document#word-javascript/api/word/-document-detectlanguage-member(1))|Analyzes the document text to determine the language.| -||[documentLibraryVersions](/.document#word-javascript/api/word/-document-documentlibraryversions-member)|Returns a `DocumentLibraryVersionCollection` object that represents the collection of versions of a shared document that has versioning enabled and that's stored in a document library on a server.| -||[frames](/.document#word-javascript/api/word/-document-frames-member)|Returns a `FrameCollection` object that represents all the frames in the document.| -||[hyperlinks](/.document#word-javascript/api/word/-document-hyperlinks-member)|Returns a `HyperlinkCollection` object that represents all the hyperlinks in the document.| -||[hyphenateCaps](/.document#word-javascript/api/word/-document-hyphenatecaps-member)|Specifies whether words in all capital letters can be hyphenated.| -||[indexes](/.document#word-javascript/api/word/-document-indexes-member)|Returns an `IndexCollection` object that represents all the indexes in the document.| -||[languageDetected](/.document#word-javascript/api/word/-document-languagedetected-member)|Specifies whether Microsoft Word has detected the language of the document text.| -||[manualHyphenation()](/.document#word-javascript/api/word/-document-manualhyphenation-member(1))|Initiates manual hyphenation of a document, one line at a time.| -||[pageSetup](/.document#word-javascript/api/word/-document-pagesetup-member)|Returns a `PageSetup` object that's associated with the document.| -|[DocumentLibraryVersion](/.documentlibraryversion)|[comments](/.documentlibraryversion#word-javascript/api/word/-documentlibraryversion-comments-member)|Gets any optional comments associated with this version of the shared document.| -||[modified](/.documentlibraryversion#word-javascript/api/word/-documentlibraryversion-modified-member)|Gets the date and time at which this version of the shared document was last saved to the server.| -||[modifiedBy](/.documentlibraryversion#word-javascript/api/word/-documentlibraryversion-modifiedby-member)|Gets the name of the user who last saved this version of the shared document to the server.| -|[DocumentLibraryVersionCollection](/.documentlibraryversioncollection)|[getItem(index: number)](/.documentlibraryversioncollection#word-javascript/api/word/-documentlibraryversioncollection-getitem-member(1))|Gets a `DocumentLibraryVersion` object by its index in the collection.| -||[isVersioningEnabled()](/.documentlibraryversioncollection#word-javascript/api/word/-documentlibraryversioncollection-isversioningenabled-member(1))|Returns whether the document library in which the active document is saved on the server is configured to create a backup copy, or version, each time the file is edited on the website.| -||[items](/.documentlibraryversioncollection#word-javascript/api/word/-documentlibraryversioncollection-items-member)|Gets the loaded child items in this collection.| -|[DropCap](/.dropcap)|[clear()](/.dropcap#word-javascript/api/word/-dropcap-clear-member(1))|Removes the dropped capital letter formatting.| -||[distanceFromText](/.dropcap#word-javascript/api/word/-dropcap-distancefromtext-member)|Gets the distance (in points) between the dropped capital letter and the paragraph text.| -||[enable()](/.dropcap#word-javascript/api/word/-dropcap-enable-member(1))|Formats the first character in the specified paragraph as a dropped capital letter.| -||[fontName](/.dropcap#word-javascript/api/word/-dropcap-fontname-member)|Gets the name of the font for the dropped capital letter.| -||[linesToDrop](/.dropcap#word-javascript/api/word/-dropcap-linestodrop-member)|Gets the height (in lines) of the dropped capital letter.| -||[position](/.dropcap#word-javascript/api/word/-dropcap-position-member)|Gets the position of the dropped capital letter.| -|[Field](/.field)|[copyToClipboard()](/.field#word-javascript/api/word/-field-copytoclipboard-member(1))|Copies the field to the Clipboard.| -||[cut()](/.field#word-javascript/api/word/-field-cut-member(1))|Removes the field from the document and places it on the Clipboard.| -||[doClick()](/.field#word-javascript/api/word/-field-doclick-member(1))|Clicks the field.| -||[linkFormat](/.field#word-javascript/api/word/-field-linkformat-member)|Gets a `LinkFormat` object that represents the link options of the field.| -||[oleFormat](/.field#word-javascript/api/word/-field-oleformat-member)|Gets an `OleFormat` object that represents the OLE characteristics (other than linking) for the field.| -||[unlink()](/.field#word-javascript/api/word/-field-unlink-member(1))|Replaces the field with its most recent result.| -||[updateSource()](/.field#word-javascript/api/word/-field-updatesource-member(1))|Saves the changes made to the results of an {@link https://support.microsoft.com/office/1c34d6d6-0de3-4b5c-916a-2ff950fb629e | INCLUDETEXT field} back to the source document.| -|[FillFormat](/.fillformat)|[backgroundColor](/.fillformat#word-javascript/api/word/-fillformat-backgroundcolor-member)|Returns a `ColorFormat` object that represents the background color for the fill.| -||[foregroundColor](/.fillformat#word-javascript/api/word/-fillformat-foregroundcolor-member)|Returns a `ColorFormat` object that represents the foreground color for the fill.| -||[gradientAngle](/.fillformat#word-javascript/api/word/-fillformat-gradientangle-member)|Specifies the angle of the gradient fill.| -||[gradientColorType](/.fillformat#word-javascript/api/word/-fillformat-gradientcolortype-member)|Gets the gradient color type.| -||[gradientDegree](/.fillformat#word-javascript/api/word/-fillformat-gradientdegree-member)|Returns how dark or light a one-color gradient fill is.| -||[gradientStyle](/.fillformat#word-javascript/api/word/-fillformat-gradientstyle-member)|Returns the gradient style for the fill.| -||[gradientVariant](/.fillformat#word-javascript/api/word/-fillformat-gradientvariant-member)|Returns the gradient variant for the fill as an integer value from 1 to 4 for most gradient fills.| -||[isVisible](/.fillformat#word-javascript/api/word/-fillformat-isvisible-member)|Specifies if the object, or the formatting applied to it, is visible.| -||[pattern](/.fillformat#word-javascript/api/word/-fillformat-pattern-member)|Returns a `PatternType` value that represents the pattern applied to the fill or line.| -||[presetGradientType](/.fillformat#word-javascript/api/word/-fillformat-presetgradienttype-member)|Returns the preset gradient type for the fill.| -||[presetTexture](/.fillformat#word-javascript/api/word/-fillformat-presettexture-member)|Gets the preset texture.| -||[rotateWithObject](/.fillformat#word-javascript/api/word/-fillformat-rotatewithobject-member)|Specifies whether the fill rotates with the shape.| -||[setOneColorGradient(style: Word.GradientStyle, variant: number, degree: number)](/.fillformat#word-javascript/api/word/-fillformat-setonecolorgradient-member(1))|Sets the fill to a one-color gradient.| -||[setPatterned(pattern: Word.PatternType)](/.fillformat#word-javascript/api/word/-fillformat-setpatterned-member(1))|Sets the fill to a pattern.| -||[setPresetGradient(style: Word.GradientStyle, variant: number, presetGradientType: Word.PresetGradientType)](/.fillformat#word-javascript/api/word/-fillformat-setpresetgradient-member(1))|Sets the fill to a preset gradient.| -||[setPresetTextured(presetTexture: Word.PresetTexture)](/.fillformat#word-javascript/api/word/-fillformat-setpresettextured-member(1))|Sets the fill to a preset texture.| -||[setTwoColorGradient(style: Word.GradientStyle, variant: number)](/.fillformat#word-javascript/api/word/-fillformat-settwocolorgradient-member(1))|Sets the fill to a two-color gradient.| -||[solid()](/.fillformat#word-javascript/api/word/-fillformat-solid-member(1))|Sets the fill to a uniform color.| -||[textureAlignment](/.fillformat#word-javascript/api/word/-fillformat-texturealignment-member)|Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill.| -||[textureHorizontalScale](/.fillformat#word-javascript/api/word/-fillformat-texturehorizontalscale-member)|Specifies the horizontal scaling factor for the texture fill.| -||[textureName](/.fillformat#word-javascript/api/word/-fillformat-texturename-member)|Returns the name of the custom texture file for the fill.| -||[textureOffsetX](/.fillformat#word-javascript/api/word/-fillformat-textureoffsetx-member)|Specifies the horizontal offset of the texture from the origin in points.| -||[textureOffsetY](/.fillformat#word-javascript/api/word/-fillformat-textureoffsety-member)|Specifies the vertical offset of the texture.| -||[textureTile](/.fillformat#word-javascript/api/word/-fillformat-texturetile-member)|Specifies whether the texture is tiled.| -||[textureType](/.fillformat#word-javascript/api/word/-fillformat-texturetype-member)|Returns the texture type for the fill.| -||[textureVerticalScale](/.fillformat#word-javascript/api/word/-fillformat-textureverticalscale-member)|Specifies the vertical scaling factor for the texture fill as a value between 0.0 and 1.0.| -||[transparency](/.fillformat#word-javascript/api/word/-fillformat-transparency-member)|Specifies the degree of transparency of the fill for a shape as a value between 0.0 (opaque) and 1.0 (clear).| -||[type](/.fillformat#word-javascript/api/word/-fillformat-type-member)|Gets the fill format type.| -|[Font](/.font)|[allCaps](/.font#word-javascript/api/word/-font-allcaps-member)|Specifies whether the font is formatted as all capital letters, which makes lowercase letters appear as uppercase letters.| -||[boldBidirectional](/.font#word-javascript/api/word/-font-boldbidirectional-member)|Specifies whether the font is formatted as bold in a right-to-left language document.| -||[borders](/.font#word-javascript/api/word/-font-borders-member)|Returns a `BorderUniversalCollection` object that represents all the borders for the font.| -||[colorIndex](/.font#word-javascript/api/word/-font-colorindex-member)|Specifies a `ColorIndex` value that represents the color for the font.| -||[colorIndexBidirectional](/.font#word-javascript/api/word/-font-colorindexbidirectional-member)|Specifies the color for the `Font` object in a right-to-left language document.| -||[contextualAlternates](/.font#word-javascript/api/word/-font-contextualalternates-member)|Specifies whether contextual alternates are enabled for the font.| -||[decreaseFontSize()](/.font#word-javascript/api/word/-font-decreasefontsize-member(1))|Decreases the font size to the next available size.| -||[diacriticColor](/.font#word-javascript/api/word/-font-diacriticcolor-member)|Specifies the color to be used for diacritics for the `Font` object.| -||[disableCharacterSpaceGrid](/.font#word-javascript/api/word/-font-disablecharacterspacegrid-member)|Specifies whether Microsoft Word ignores the number of characters per line for the corresponding `Font` object.| -||[emboss](/.font#word-javascript/api/word/-font-emboss-member)|Specifies whether the font is formatted as embossed.| -||[emphasisMark](/.font#word-javascript/api/word/-font-emphasismark-member)|Specifies an `EmphasisMark` value that represents the emphasis mark for a character or designated character string.| -||[engrave](/.font#word-javascript/api/word/-font-engrave-member)|Specifies whether the font is formatted as engraved.| -||[fill](/.font#word-javascript/api/word/-font-fill-member)|Returns a `FillFormat` object that contains fill formatting properties for the font used by the range of text.| -||[glow](/.font#word-javascript/api/word/-font-glow-member)|Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text.| -||[increaseFontSize()](/.font#word-javascript/api/word/-font-increasefontsize-member(1))|Increases the font size to the next available size.| -||[italicBidirectional](/.font#word-javascript/api/word/-font-italicbidirectional-member)|Specifies whether the font is italicized in a right-to-left language document.| -||[kerning](/.font#word-javascript/api/word/-font-kerning-member)|Specifies the minimum font size for which Microsoft Word will adjust kerning automatically.| -||[ligature](/.font#word-javascript/api/word/-font-ligature-member)|Specifies the ligature setting for the `Font` object.| -||[line](/.font#word-javascript/api/word/-font-line-member)|Returns a `LineFormat` object that specifies the formatting for a line.| -||[nameAscii](/.font#word-javascript/api/word/-font-nameascii-member)|Specifies the font used for Latin text (characters with character codes from 0 (zero) through 127).| -||[nameBidirectional](/.font#word-javascript/api/word/-font-namebidirectional-member)|Specifies the font name in a right-to-left language document.| -||[nameFarEast](/.font#word-javascript/api/word/-font-namefareast-member)|Specifies the East Asian font name.| -||[nameOther](/.font#word-javascript/api/word/-font-nameother-member)|Specifies the font used for characters with codes from 128 through 255.| -||[numberForm](/.font#word-javascript/api/word/-font-numberform-member)|Specifies the number form setting for an OpenType font.| -||[numberSpacing](/.font#word-javascript/api/word/-font-numberspacing-member)|Specifies the number spacing setting for the font.| -||[outline](/.font#word-javascript/api/word/-font-outline-member)|Specifies if the font is formatted as outlined.| -||[position](/.font#word-javascript/api/word/-font-position-member)|Specifies the position of text (in points) relative to the base line.| -||[reflection](/.font#word-javascript/api/word/-font-reflection-member)|Returns a `ReflectionFormat` object that represents the reflection formatting for a shape.| -||[reset()](/.font#word-javascript/api/word/-font-reset-member(1))|Removes manual character formatting.| -||[scaling](/.font#word-javascript/api/word/-font-scaling-member)|Specifies the scaling percentage applied to the font.| -||[setAsTemplateDefault()](/.font#word-javascript/api/word/-font-setastemplatedefault-member(1))|Sets the specified font formatting as the default for the active document and all new documents based on the active template.| -||[shadow](/.font#word-javascript/api/word/-font-shadow-member)|Specifies if the font is formatted as shadowed.| -||[sizeBidirectional](/.font#word-javascript/api/word/-font-sizebidirectional-member)|Specifies the font size in points for right-to-left text.| -||[smallCaps](/.font#word-javascript/api/word/-font-smallcaps-member)|Specifies whether the font is formatted as small caps, which makes lowercase letters appear as small uppercase letters.| -||[spacing](/.font#word-javascript/api/word/-font-spacing-member)|Specifies the spacing between characters.| -||[stylisticSet](/.font#word-javascript/api/word/-font-stylisticset-member)|Specifies the stylistic set for the font.| -||[textColor](/.font#word-javascript/api/word/-font-textcolor-member)|Returns a `ColorFormat` object that represents the color for the font.| -||[textShadow](/.font#word-javascript/api/word/-font-textshadow-member)|Returns a `ShadowFormat` object that specifies the shadow formatting for the font.| -||[threeDimensionalFormat](/.font#word-javascript/api/word/-font-threedimensionalformat-member)|Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font.| -||[underlineColor](/.font#word-javascript/api/word/-font-underlinecolor-member)|Specifies the color of the underline for the `Font` object.| -|[Frame](/.frame)|[borders](/.frame#word-javascript/api/word/-frame-borders-member)|Returns a `BorderUniversalCollection` object that represents all the borders for the frame.| -||[copy()](/.frame#word-javascript/api/word/-frame-copy-member(1))|Copies the frame to the Clipboard.| -||[cut()](/.frame#word-javascript/api/word/-frame-cut-member(1))|Removes the frame from the document and places it on the Clipboard.| -||[delete()](/.frame#word-javascript/api/word/-frame-delete-member(1))|Deletes the frame.| -||[height](/.frame#word-javascript/api/word/-frame-height-member)|Specifies the height (in points) of the frame.| -||[heightRule](/.frame#word-javascript/api/word/-frame-heightrule-member)|Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame.| -||[horizontalDistanceFromText](/.frame#word-javascript/api/word/-frame-horizontaldistancefromtext-member)|Specifies the horizontal distance between the frame and the surrounding text, in points.| -||[horizontalPosition](/.frame#word-javascript/api/word/-frame-horizontalposition-member)|Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property.| -||[lockAnchor](/.frame#word-javascript/api/word/-frame-lockanchor-member)|Specifies if the frame is locked.| -||[range](/.frame#word-javascript/api/word/-frame-range-member)|Returns a `Range` object that represents the portion of the document that's contained within the frame.| -||[relativeHorizontalPosition](/.frame#word-javascript/api/word/-frame-relativehorizontalposition-member)|Specifies the relative horizontal position of the frame.| -||[relativeVerticalPosition](/.frame#word-javascript/api/word/-frame-relativeverticalposition-member)|Specifies the relative vertical position of the frame.| -||[select()](/.frame#word-javascript/api/word/-frame-select-member(1))|Selects the frame.| -||[shading](/.frame#word-javascript/api/word/-frame-shading-member)|Returns a `ShadingUniversal` object that refers to the shading formatting for the frame.| -||[textWrap](/.frame#word-javascript/api/word/-frame-textwrap-member)|Specifies if document text wraps around the frame.| -||[verticalDistanceFromText](/.frame#word-javascript/api/word/-frame-verticaldistancefromtext-member)|Specifies the vertical distance (in points) between the frame and the surrounding text.| -||[verticalPosition](/.frame#word-javascript/api/word/-frame-verticalposition-member)|Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property.| -||[width](/.frame#word-javascript/api/word/-frame-width-member)|Specifies the width (in points) of the frame.| -||[widthRule](/.frame#word-javascript/api/word/-frame-widthrule-member)|Specifies the rule used to determine the width of the frame.| -|[FrameCollection](/.framecollection)|[add(range: Word.Range)](/.framecollection#word-javascript/api/word/-framecollection-add-member(1))|Returns a `Frame` object that represents a new frame added to a range, selection, or document.| -||[delete()](/.framecollection#word-javascript/api/word/-framecollection-delete-member(1))|Deletes the `FrameCollection` object.| -||[getItem(index: number)](/.framecollection#word-javascript/api/word/-framecollection-getitem-member(1))|Gets a `Frame` object by its index in the collection.| -||[items](/.framecollection#word-javascript/api/word/-framecollection-items-member)|Gets the loaded child items in this collection.| -|[GlowFormat](/.glowformat)|[color](/.glowformat#word-javascript/api/word/-glowformat-color-member)|Returns a `ColorFormat` object that represents the color for a glow effect.| -||[radius](/.glowformat#word-javascript/api/word/-glowformat-radius-member)|Specifies the length of the radius for a glow effect.| -||[transparency](/.glowformat#word-javascript/api/word/-glowformat-transparency-member)|Specifies the degree of transparency for the glow effect as a value between 0.0 (opaque) and 1.0 (clear).| -|[GroupContentControl](/.groupcontentcontrol)|[appearance](/.groupcontentcontrol#word-javascript/api/word/-groupcontentcontrol-appearance-member)|Specifies the appearance of the content control.| -||[color](/.groupcontentcontrol#word-javascript/api/word/-groupcontentcontrol-color-member)|Specifies the red-green-blue (RGB) value of the color of the content control.| -||[copy()](/.groupcontentcontrol#word-javascript/api/word/-groupcontentcontrol-copy-member(1))|Copies the content control from the active document to the Clipboard.| -||[cut()](/.groupcontentcontrol#word-javascript/api/word/-groupcontentcontrol-cut-member(1))|Removes the content control from the active document and moves the content control to the Clipboard.| -||[delete(deleteContents: boolean)](/.groupcontentcontrol#word-javascript/api/word/-groupcontentcontrol-delete-member(1))|Deletes the content control and optionally its contents.| -||[id](/.groupcontentcontrol#word-javascript/api/word/-groupcontentcontrol-id-member)|Returns the identification for the content control.| -||[isTemporary](/.groupcontentcontrol#word-javascript/api/word/-groupcontentcontrol-istemporary-member)|Specifies whether to remove the content control from the active document when the user edits the contents of the control.| -||[level](/.groupcontentcontrol#word-javascript/api/word/-groupcontentcontrol-level-member)|Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline.| -||[lockContentControl](/.groupcontentcontrol#word-javascript/api/word/-groupcontentcontrol-lockcontentcontrol-member)|Specifies if the content control is locked (can't be deleted).| -||[lockContents](/.groupcontentcontrol#word-javascript/api/word/-groupcontentcontrol-lockcontents-member)|Specifies if the contents of the content control are locked (not editable).| -||[placeholderText](/.groupcontentcontrol#word-javascript/api/word/-groupcontentcontrol-placeholdertext-member)|Returns a `BuildingBlock` object that represents the placeholder text for the content control.| -||[range](/.groupcontentcontrol#word-javascript/api/word/-groupcontentcontrol-range-member)|Gets a `Range` object that represents the contents of the content control in the active document.| -||[setPlaceholderText(options?: Word.ContentControlPlaceholderOptions)](/.groupcontentcontrol#word-javascript/api/word/-groupcontentcontrol-setplaceholdertext-member(1))|Sets the placeholder text that displays in the content control until a user enters their own text.| -||[showingPlaceholderText](/.groupcontentcontrol#word-javascript/api/word/-groupcontentcontrol-showingplaceholdertext-member)|Returns whether the placeholder text for the content control is being displayed.| -||[tag](/.groupcontentcontrol#word-javascript/api/word/-groupcontentcontrol-tag-member)|Specifies a tag to identify the content control.| -||[title](/.groupcontentcontrol#word-javascript/api/word/-groupcontentcontrol-title-member)|Specifies the title for the content control.| -||[ungroup()](/.groupcontentcontrol#word-javascript/api/word/-groupcontentcontrol-ungroup-member(1))|Removes the group content control from the document so that its child content controls are no longer nested and can be freely edited.| -||[xmlMapping](/.groupcontentcontrol#word-javascript/api/word/-groupcontentcontrol-xmlmapping-member)|Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document.| -|[Hyperlink](/.hyperlink)|[addToFavorites()](/.hyperlink#word-javascript/api/word/-hyperlink-addtofavorites-member(1))|Creates a shortcut to the document or hyperlink and adds it to the **Favorites** folder.| -||[address](/.hyperlink#word-javascript/api/word/-hyperlink-address-member)|Specifies the address (for example, a file name or URL) of the hyperlink.| -||[createNewDocument(fileName: string, editNow: boolean, overwrite: boolean)](/.hyperlink#word-javascript/api/word/-hyperlink-createnewdocument-member(1))|Creates a new document linked to the hyperlink.| -||[delete()](/.hyperlink#word-javascript/api/word/-hyperlink-delete-member(1))|Deletes the hyperlink.| -||[emailSubject](/.hyperlink#word-javascript/api/word/-hyperlink-emailsubject-member)|Specifies the text string for the hyperlink's subject line.| -||[isExtraInfoRequired](/.hyperlink#word-javascript/api/word/-hyperlink-isextrainforequired-member)|Returns `true` if extra information is required to resolve the hyperlink.| -||[name](/.hyperlink#word-javascript/api/word/-hyperlink-name-member)|Returns the name of the `Hyperlink` object.| -||[range](/.hyperlink#word-javascript/api/word/-hyperlink-range-member)|Returns a `Range` object that represents the portion of the document that's contained within the hyperlink.| -||[screenTip](/.hyperlink#word-javascript/api/word/-hyperlink-screentip-member)|Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink.| -||[subAddress](/.hyperlink#word-javascript/api/word/-hyperlink-subaddress-member)|Specifies a named location in the destination of the hyperlink.| -||[target](/.hyperlink#word-javascript/api/word/-hyperlink-target-member)|Specifies the name of the frame or window in which to load the hyperlink.| -||[textToDisplay](/.hyperlink#word-javascript/api/word/-hyperlink-texttodisplay-member)|Specifies the hyperlink's visible text in the document.| -||[type](/.hyperlink#word-javascript/api/word/-hyperlink-type-member)|Returns the hyperlink type.| -|[HyperlinkAddOptions](/.hyperlinkaddoptions)|[address](/.hyperlinkaddoptions#word-javascript/api/word/-hyperlinkaddoptions-address-member)|If provided, specifies the address (e.g., URL or file path) of the hyperlink.| -||[screenTip](/.hyperlinkaddoptions#word-javascript/api/word/-hyperlinkaddoptions-screentip-member)|If provided, specifies the text that appears as a tooltip.| -||[subAddress](/.hyperlinkaddoptions#word-javascript/api/word/-hyperlinkaddoptions-subaddress-member)|If provided, specifies the location within the file or document.| -||[target](/.hyperlinkaddoptions#word-javascript/api/word/-hyperlinkaddoptions-target-member)|If provided, specifies the name of the frame or window in which to load the hyperlink.| -||[textToDisplay](/.hyperlinkaddoptions#word-javascript/api/word/-hyperlinkaddoptions-texttodisplay-member)|If provided, specifies the visible text of the hyperlink.| -|[HyperlinkCollection](/.hyperlinkcollection)|[add(anchor: Word.Range, options?: Word.HyperlinkAddOptions)](/.hyperlinkcollection#word-javascript/api/word/-hyperlinkcollection-add-member(1))|Returns a `Hyperlink` object that represents a new hyperlink added to a range, selection, or document.| -||[items](/.hyperlinkcollection#word-javascript/api/word/-hyperlinkcollection-items-member)|Gets the loaded child items in this collection.| -|[Index](/.index)|[delete()](/.index#word-javascript/api/word/-index-delete-member(1))|Deletes this index.| -||[filter](/.index#word-javascript/api/word/-index-filter-member)|Gets a value that represents how Microsoft Word classifies the first character of entries in the index.| -||[headingSeparator](/.index#word-javascript/api/word/-index-headingseparator-member)|Gets the text between alphabetical groups (entries that start with the same letter) in the index.| -||[indexLanguage](/.index#word-javascript/api/word/-index-indexlanguage-member)|Gets a `LanguageId` value that represents the sorting language to use for the index.| -||[numberOfColumns](/.index#word-javascript/api/word/-index-numberofcolumns-member)|Gets the number of columns for each page of the index.| -||[range](/.index#word-javascript/api/word/-index-range-member)|Returns a `Range` object that represents the portion of the document that is contained within the index.| -||[rightAlignPageNumbers](/.index#word-javascript/api/word/-index-rightalignpagenumbers-member)|Specifies if page numbers are aligned with the right margin in the index.| -||[separateAccentedLetterHeadings](/.index#word-javascript/api/word/-index-separateaccentedletterheadings-member)|Gets if the index contains separate headings for accented letters (for example, words that begin with "À" are under| -||[sortBy](/.index#word-javascript/api/word/-index-sortby-member)|Specifies the sorting criteria for the index.| -||[tabLeader](/.index#word-javascript/api/word/-index-tableader-member)|Specifies the leader character between entries in the index and their associated page numbers.| -||[type](/.index#word-javascript/api/word/-index-type-member)|Gets the index type.| -|[IndexAddOptions](/.indexaddoptions)|[headingSeparator](/.indexaddoptions#word-javascript/api/word/-indexaddoptions-headingseparator-member)|If provided, specifies the text between alphabetical groups (entries that start with the same letter) in the index.| -||[indexLanguage](/.indexaddoptions#word-javascript/api/word/-indexaddoptions-indexlanguage-member)|If provided, specifies the sorting language to be used for the index being added.| -||[numberOfColumns](/.indexaddoptions#word-javascript/api/word/-indexaddoptions-numberofcolumns-member)|If provided, specifies the number of columns for each page of the index.| -||[rightAlignPageNumbers](/.indexaddoptions#word-javascript/api/word/-indexaddoptions-rightalignpagenumbers-member)|If provided, specifies whether the page numbers in the generated index are aligned with the right margin.| -||[separateAccentedLetterHeadings](/.indexaddoptions#word-javascript/api/word/-indexaddoptions-separateaccentedletterheadings-member)|If provided, specifies whether to include separate headings for accented letters in the index.| -||[sortBy](/.indexaddoptions#word-javascript/api/word/-indexaddoptions-sortby-member)|If provided, specifies the sorting criteria to be used for the index being added.| -||[type](/.indexaddoptions#word-javascript/api/word/-indexaddoptions-type-member)|If provided, specifies whether subentries are on the same line (run-in) as the main entry or on a separate line (indented) from the main entry.| -|[IndexCollection](/.indexcollection)|[add(range: Word.Range, indexAddOptions?: Word.IndexAddOptions)](/.indexcollection#word-javascript/api/word/-indexcollection-add-member(1))|Returns an `Index` object that represents a new index added to the document.| -||[getFormat()](/.indexcollection#word-javascript/api/word/-indexcollection-getformat-member(1))|Gets the `IndexFormat` value that represents the formatting for the indexes in the document.| -||[getItem(index: number)](/.indexcollection#word-javascript/api/word/-indexcollection-getitem-member(1))|Gets an `Index` object by its index in the collection.| -||[items](/.indexcollection#word-javascript/api/word/-indexcollection-items-member)|Gets the loaded child items in this collection.| -||[markAllEntries(range: Word.Range, markAllEntriesOptions?: Word.IndexMarkAllEntriesOptions)](/.indexcollection#word-javascript/api/word/-indexcollection-markallentries-member(1))|Inserts an {@link https://support.microsoft.com/office/abaf7c78-6e21-418d-bf8b-f8186d2e4d08 | XE (Index Entry) field} after all instances of the text in the range.| -|[IndexMarkAllEntriesOptions](/.indexmarkallentriesoptions)|[bold](/.indexmarkallentriesoptions#word-javascript/api/word/-indexmarkallentriesoptions-bold-member)|If provided, specifies whether to add bold formatting to page numbers for index entries.| -||[bookmarkName](/.indexmarkallentriesoptions#word-javascript/api/word/-indexmarkallentriesoptions-bookmarkname-member)|If provided, specifies the bookmark name that marks the range of pages you want to appear in the index.| -||[crossReference](/.indexmarkallentriesoptions#word-javascript/api/word/-indexmarkallentriesoptions-crossreference-member)|If provided, specifies the cross-reference that will appear in the index.| -||[crossReferenceAutoText](/.indexmarkallentriesoptions#word-javascript/api/word/-indexmarkallentriesoptions-crossreferenceautotext-member)|If provided, specifies the name of the `AutoText` entry that contains the text for a cross-reference (if this property is specified, `crossReference` is ignored).| -||[entry](/.indexmarkallentriesoptions#word-javascript/api/word/-indexmarkallentriesoptions-entry-member)|If provided, specifies the text you want to appear in the index, in the form `MainEntry[:Subentry]`.| -||[entryAutoText](/.indexmarkallentriesoptions#word-javascript/api/word/-indexmarkallentriesoptions-entryautotext-member)|If provided, specifies the `AutoText` entry that contains the text you want to appear in the index (if this property is specified, `entry` is ignored).| -||[italic](/.indexmarkallentriesoptions#word-javascript/api/word/-indexmarkallentriesoptions-italic-member)|If provided, specifies whether to add italic formatting to page numbers for index entries.| -|[IndexMarkEntryOptions](/.indexmarkentryoptions)|[bold](/.indexmarkentryoptions#word-javascript/api/word/-indexmarkentryoptions-bold-member)|If provided, specifies whether to add bold formatting to page numbers for index entries.| -||[bookmarkName](/.indexmarkentryoptions#word-javascript/api/word/-indexmarkentryoptions-bookmarkname-member)|If provided, specifies the bookmark name that marks the range of pages you want to appear in the index.| -||[crossReference](/.indexmarkentryoptions#word-javascript/api/word/-indexmarkentryoptions-crossreference-member)|If provided, specifies the cross-reference that will appear in the index.| -||[crossReferenceAutoText](/.indexmarkentryoptions#word-javascript/api/word/-indexmarkentryoptions-crossreferenceautotext-member)|If provided, specifies the name of the `AutoText` entry that contains the text for a cross-reference (if this property is specified, `crossReference` is ignored).| -||[entry](/.indexmarkentryoptions#word-javascript/api/word/-indexmarkentryoptions-entry-member)|If provided, specifies the text you want to appear in the index, in the form `MainEntry[:Subentry]`.| -||[entryAutoText](/.indexmarkentryoptions#word-javascript/api/word/-indexmarkentryoptions-entryautotext-member)|If provided, specifies the `AutoText` entry that contains the text you want to appear in the index (if this property is specified, `entry` is ignored).| -||[italic](/.indexmarkentryoptions#word-javascript/api/word/-indexmarkentryoptions-italic-member)|If provided, specifies whether to add italic formatting to page numbers for index entries.| -||[reading](/.indexmarkentryoptions#word-javascript/api/word/-indexmarkentryoptions-reading-member)|If provided, specifies whether to show an index entry in the right location when indexes are sorted phonetically (East Asian languages only).| -|[LineFormat](/.lineformat)|[backgroundColor](/.lineformat#word-javascript/api/word/-lineformat-backgroundcolor-member)|Gets a `ColorFormat` object that represents the background color for a patterned line.| -||[beginArrowheadLength](/.lineformat#word-javascript/api/word/-lineformat-beginarrowheadlength-member)|Specifies the length of the arrowhead at the beginning of the line.| -||[beginArrowheadStyle](/.lineformat#word-javascript/api/word/-lineformat-beginarrowheadstyle-member)|Specifies the style of the arrowhead at the beginning of the line.| -||[beginArrowheadWidth](/.lineformat#word-javascript/api/word/-lineformat-beginarrowheadwidth-member)|Specifies the width of the arrowhead at the beginning of the line.| -||[dashStyle](/.lineformat#word-javascript/api/word/-lineformat-dashstyle-member)|Specifies the dash style for the line.| -||[endArrowheadLength](/.lineformat#word-javascript/api/word/-lineformat-endarrowheadlength-member)|Specifies the length of the arrowhead at the end of the line.| -||[endArrowheadStyle](/.lineformat#word-javascript/api/word/-lineformat-endarrowheadstyle-member)|Specifies the style of the arrowhead at the end of the line.| -||[endArrowheadWidth](/.lineformat#word-javascript/api/word/-lineformat-endarrowheadwidth-member)|Specifies the width of the arrowhead at the end of the line.| -||[foregroundColor](/.lineformat#word-javascript/api/word/-lineformat-foregroundcolor-member)|Gets a `ColorFormat` object that represents the foreground color for the line.| -||[insetPen](/.lineformat#word-javascript/api/word/-lineformat-insetpen-member)|Specifies if to draw lines inside a shape.| -||[isVisible](/.lineformat#word-javascript/api/word/-lineformat-isvisible-member)|Specifies if the object, or the formatting applied to it, is visible.| -||[pattern](/.lineformat#word-javascript/api/word/-lineformat-pattern-member)|Specifies the pattern applied to the line.| -||[style](/.lineformat#word-javascript/api/word/-lineformat-style-member)|Specifies the line format style.| -||[transparency](/.lineformat#word-javascript/api/word/-lineformat-transparency-member)|Specifies the degree of transparency of the line as a value between 0.0 (opaque) and 1.0 (clear).| -||[weight](/.lineformat#word-javascript/api/word/-lineformat-weight-member)|Specifies the thickness of the line in points.| -|[LineNumbering](/.linenumbering)|[countBy](/.linenumbering#word-javascript/api/word/-linenumbering-countby-member)|Specifies the numeric increment for line numbers.| -||[distanceFromText](/.linenumbering#word-javascript/api/word/-linenumbering-distancefromtext-member)|Specifies the distance (in points) between the right edge of line numbers and the left edge of the document text.| -||[isActive](/.linenumbering#word-javascript/api/word/-linenumbering-isactive-member)|Specifies if line numbering is active for the specified document, section, or sections.| -||[restartMode](/.linenumbering#word-javascript/api/word/-linenumbering-restartmode-member)|Specifies the way line numbering runs; that is, whether it starts over at the beginning of a new page or section, or runs continuously.| -||[startingNumber](/.linenumbering#word-javascript/api/word/-linenumbering-startingnumber-member)|Specifies the starting line number.| -|[LinkFormat](/.linkformat)|[breakLink()](/.linkformat#word-javascript/api/word/-linkformat-breaklink-member(1))|Breaks the link between the source file and the OLE object, picture, or linked field.| -||[isAutoUpdated](/.linkformat#word-javascript/api/word/-linkformat-isautoupdated-member)|Specifies if the link is updated automatically when the container file is opened or when the source file is changed.| -||[isLocked](/.linkformat#word-javascript/api/word/-linkformat-islocked-member)|Specifies if a `Field`, `InlineShape`, or `Shape` object is locked to prevent automatic updating.| -||[isPictureSavedWithDocument](/.linkformat#word-javascript/api/word/-linkformat-ispicturesavedwithdocument-member)|Specifies if the linked picture is saved with the document.| -||[sourceFullName](/.linkformat#word-javascript/api/word/-linkformat-sourcefullname-member)|Specifies the path and name of the source file for the linked OLE object, picture, or field.| -||[sourceName](/.linkformat#word-javascript/api/word/-linkformat-sourcename-member)|Gets the name of the source file for the linked OLE object, picture, or field.| -||[sourcePath](/.linkformat#word-javascript/api/word/-linkformat-sourcepath-member)|Gets the path of the source file for the linked OLE object, picture, or field.| -||[type](/.linkformat#word-javascript/api/word/-linkformat-type-member)|Gets the link type.| -|[ListFormat](/.listformat)|[applyBulletDefault(defaultListBehavior: Word.DefaultListBehavior)](/.listformat#word-javascript/api/word/-listformat-applybulletdefault-member(1))|Adds bullets and formatting to the paragraphs in the range.| -||[applyListTemplateWithLevel(listTemplate: Word.ListTemplate, options?: Word.ListTemplateApplyOptions)](/.listformat#word-javascript/api/word/-listformat-applylisttemplatewithlevel-member(1))|Applies a list template with a specific level to the paragraphs in the range.| -||[applyNumberDefault(defaultListBehavior: Word.DefaultListBehavior)](/.listformat#word-javascript/api/word/-listformat-applynumberdefault-member(1))|Adds numbering and formatting to the paragraphs in the range.| -||[applyOutlineNumberDefault(defaultListBehavior: Word.DefaultListBehavior)](/.listformat#word-javascript/api/word/-listformat-applyoutlinenumberdefault-member(1))|Adds outline numbering and formatting to the paragraphs in the range.| -||[canContinuePreviousList(listTemplate: Word.ListTemplate)](/.listformat#word-javascript/api/word/-listformat-cancontinuepreviouslist-member(1))|Determines whether the `ListFormat` object can continue a previous list.| -||[convertNumbersToText(numberType: Word.NumberType)](/.listformat#word-javascript/api/word/-listformat-convertnumberstotext-member(1))|Converts numbers in the list to plain text.| -||[countNumberedItems(options?: Word.ListFormatCountNumberedItemsOptions)](/.listformat#word-javascript/api/word/-listformat-countnumbereditems-member(1))|Counts the numbered items in the list.| -||[isSingleList](/.listformat#word-javascript/api/word/-listformat-issinglelist-member)|Indicates whether the `ListFormat` object contains a single list.| -||[isSingleListTemplate](/.listformat#word-javascript/api/word/-listformat-issinglelisttemplate-member)|Indicates whether the `ListFormat` object contains a single list template.| -||[list](/.listformat#word-javascript/api/word/-listformat-list-member)|Returns a `List` object that represents the first formatted list contained in the `ListFormat` object.| -||[listIndent()](/.listformat#word-javascript/api/word/-listformat-listindent-member(1))|Indents the list by one level.| -||[listLevelNumber](/.listformat#word-javascript/api/word/-listformat-listlevelnumber-member)|Specifies the list level number for the first paragraph for the `ListFormat` object.| -||[listOutdent()](/.listformat#word-javascript/api/word/-listformat-listoutdent-member(1))|Outdents the list by one level.| -||[listString](/.listformat#word-javascript/api/word/-listformat-liststring-member)|Gets the string representation of the list value of the first paragraph in the range for the `ListFormat` object.| -||[listTemplate](/.listformat#word-javascript/api/word/-listformat-listtemplate-member)|Gets the list template associated with the `ListFormat` object.| -||[listType](/.listformat#word-javascript/api/word/-listformat-listtype-member)|Gets the type of the list for the `ListFormat` object.| -||[listValue](/.listformat#word-javascript/api/word/-listformat-listvalue-member)|Gets the numeric value of the the first paragraph in the range for the `ListFormat` object.| -||[removeNumbers(numberType: Word.NumberType)](/.listformat#word-javascript/api/word/-listformat-removenumbers-member(1))|Removes numbering from the list.| -|[ListFormatCountNumberedItemsOptions](/.listformatcountnumbereditemsoptions)|[level](/.listformatcountnumbereditemsoptions#word-javascript/api/word/-listformatcountnumbereditemsoptions-level-member)|If provided, specifies the level to count.| -||[numberType](/.listformatcountnumbereditemsoptions#word-javascript/api/word/-listformatcountnumbereditemsoptions-numbertype-member)|If provided, specifies the type of number to count.| -|[ListTemplateApplyOptions](/.listtemplateapplyoptions)|[applyLevel](/.listtemplateapplyoptions#word-javascript/api/word/-listtemplateapplyoptions-applylevel-member)|If provided, specifies the level to apply in the list template.| -||[applyTo](/.listtemplateapplyoptions#word-javascript/api/word/-listtemplateapplyoptions-applyto-member)|If provided, specifies which part of the list to apply the template to.| -||[continuePreviousList](/.listtemplateapplyoptions#word-javascript/api/word/-listtemplateapplyoptions-continuepreviouslist-member)|If provided, specifies whether to continue the previous list.| -||[defaultListBehavior](/.listtemplateapplyoptions#word-javascript/api/word/-listtemplateapplyoptions-defaultlistbehavior-member)|If provided, specifies the default list behavior.| -|[OleFormat](/.oleformat)|[activate()](/.oleformat#word-javascript/api/word/-oleformat-activate-member(1))|Activates the `OleFormat` object.| -||[activateAs(classType: string)](/.oleformat#word-javascript/api/word/-oleformat-activateas-member(1))|Sets the Windows registry value that determines the default application used to activate the specified OLE object.| -||[classType](/.oleformat#word-javascript/api/word/-oleformat-classtype-member)|Specifies the class type for the specified OLE object, picture, or field.| -||[doVerb(verbIndex: Word.OleVerb)](/.oleformat#word-javascript/api/word/-oleformat-doverb-member(1))|Requests that the OLE object perform one of its available verbs.| -||[edit()](/.oleformat#word-javascript/api/word/-oleformat-edit-member(1))|Opens the OLE object for editing in the application it was created in.| -||[iconIndex](/.oleformat#word-javascript/api/word/-oleformat-iconindex-member)|Specifies the icon that is used when the `displayAsIcon` property is `true`.| -||[iconLabel](/.oleformat#word-javascript/api/word/-oleformat-iconlabel-member)|Specifies the text displayed below the icon for the OLE object.| -||[iconName](/.oleformat#word-javascript/api/word/-oleformat-iconname-member)|Specifies the program file in which the icon for the OLE object is stored.| -||[iconPath](/.oleformat#word-javascript/api/word/-oleformat-iconpath-member)|Gets the path of the file in which the icon for the OLE object is stored.| -||[isDisplayedAsIcon](/.oleformat#word-javascript/api/word/-oleformat-isdisplayedasicon-member)|Gets whether the specified object is displayed as an icon.| -||[isFormattingPreservedOnUpdate](/.oleformat#word-javascript/api/word/-oleformat-isformattingpreservedonupdate-member)|Specifies whether formatting done in Microsoft Word to the linked OLE object is preserved.| -||[label](/.oleformat#word-javascript/api/word/-oleformat-label-member)|Gets a string that's used to identify the portion of the source file that's being linked.| -||[open()](/.oleformat#word-javascript/api/word/-oleformat-open-member(1))|Opens the `OleFormat` object.| -||[progID](/.oleformat#word-javascript/api/word/-oleformat-progid-member)|Gets the programmatic identifier (`ProgId`) for the specified OLE object.| -|[Page](/.page)|[breaks](/.page#word-javascript/api/word/-page-breaks-member)|Gets a `BreakCollection` object that represents the breaks on the page.| -|[PageSetup](/.pagesetup)|[bookFoldPrinting](/.pagesetup#word-javascript/api/word/-pagesetup-bookfoldprinting-member)|Specifies whether Microsoft Word prints the document as a booklet.| -||[bookFoldPrintingSheets](/.pagesetup#word-javascript/api/word/-pagesetup-bookfoldprintingsheets-member)|Specifies the number of pages for each booklet.| -||[bookFoldReversePrinting](/.pagesetup#word-javascript/api/word/-pagesetup-bookfoldreverseprinting-member)|Specifies if Microsoft Word reverses the printing order for book fold printing of bidirectional or Asian language documents.| -||[bottomMargin](/.pagesetup#word-javascript/api/word/-pagesetup-bottommargin-member)|Specifies the distance (in points) between the bottom edge of the page and the bottom boundary of the body text.| -||[charsLine](/.pagesetup#word-javascript/api/word/-pagesetup-charsline-member)|Specifies the number of characters per line in the document grid.| -||[differentFirstPageHeaderFooter](/.pagesetup#word-javascript/api/word/-pagesetup-differentfirstpageheaderfooter-member)|Specifies whether the first page has a different header and footer.| -||[footerDistance](/.pagesetup#word-javascript/api/word/-pagesetup-footerdistance-member)|Specifies the distance between the footer and the bottom of the page in points.| -||[gutter](/.pagesetup#word-javascript/api/word/-pagesetup-gutter-member)|Specifies the amount (in points) of extra margin space added to each page in a document or section for binding.| -||[gutterPosition](/.pagesetup#word-javascript/api/word/-pagesetup-gutterposition-member)|Specifies on which side the gutter appears in a document.| -||[gutterStyle](/.pagesetup#word-javascript/api/word/-pagesetup-gutterstyle-member)|Specifies whether Microsoft Word uses gutters for the current document based on a right-to-left language or a left-to-right language.| -||[headerDistance](/.pagesetup#word-javascript/api/word/-pagesetup-headerdistance-member)|Specifies the distance between the header and the top of the page in points.| -||[layoutMode](/.pagesetup#word-javascript/api/word/-pagesetup-layoutmode-member)|Specifies the layout mode for the current document.| -||[leftMargin](/.pagesetup#word-javascript/api/word/-pagesetup-leftmargin-member)|Specifies the distance (in points) between the left edge of the page and the left boundary of the body text.| -||[lineNumbering](/.pagesetup#word-javascript/api/word/-pagesetup-linenumbering-member)|Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object.| -||[linesPage](/.pagesetup#word-javascript/api/word/-pagesetup-linespage-member)|Specifies the number of lines per page in the document grid.| -||[mirrorMargins](/.pagesetup#word-javascript/api/word/-pagesetup-mirrormargins-member)|Specifies if the inside and outside margins of facing pages are the same width.| -||[oddAndEvenPagesHeaderFooter](/.pagesetup#word-javascript/api/word/-pagesetup-oddandevenpagesheaderfooter-member)|Specifies whether odd and even pages have different headers and footers.| -||[orientation](/.pagesetup#word-javascript/api/word/-pagesetup-orientation-member)|Specifies the orientation of the page.| -||[pageHeight](/.pagesetup#word-javascript/api/word/-pagesetup-pageheight-member)|Specifies the page height in points.| -||[pageWidth](/.pagesetup#word-javascript/api/word/-pagesetup-pagewidth-member)|Specifies the page width in points.| -||[paperSize](/.pagesetup#word-javascript/api/word/-pagesetup-papersize-member)|Specifies the paper size of the page.| -||[rightMargin](/.pagesetup#word-javascript/api/word/-pagesetup-rightmargin-member)|Specifies the distance (in points) between the right edge of the page and the right boundary of the body text.| -||[sectionDirection](/.pagesetup#word-javascript/api/word/-pagesetup-sectiondirection-member)|Specifies the reading order and alignment for the specified sections.| -||[sectionStart](/.pagesetup#word-javascript/api/word/-pagesetup-sectionstart-member)|Specifies the type of section break for the specified object.| -||[setAsTemplateDefault()](/.pagesetup#word-javascript/api/word/-pagesetup-setastemplatedefault-member(1))|Sets the specified page setup formatting as the default for the active document and all new documents based on the active template.| -||[showGrid](/.pagesetup#word-javascript/api/word/-pagesetup-showgrid-member)|Specifies whether to show the grid.| -||[suppressEndnotes](/.pagesetup#word-javascript/api/word/-pagesetup-suppressendnotes-member)|Specifies if endnotes are printed at the end of the next section that doesn't suppress endnotes.| -||[textColumns](/.pagesetup#word-javascript/api/word/-pagesetup-textcolumns-member)|Gets a `TextColumnCollection` object that represents the set of text columns for the `PageSetup` object.| -||[togglePortrait()](/.pagesetup#word-javascript/api/word/-pagesetup-toggleportrait-member(1))|Switches between portrait and landscape page orientations for a document or section.| -||[topMargin](/.pagesetup#word-javascript/api/word/-pagesetup-topmargin-member)|Specifies the top margin of the page in points.| -||[twoPagesOnOne](/.pagesetup#word-javascript/api/word/-pagesetup-twopagesonone-member)|Specifies whether to print two pages per sheet.| -||[verticalAlignment](/.pagesetup#word-javascript/api/word/-pagesetup-verticalalignment-member)|Specifies the vertical alignment of text on each page in a document or section.| -|[Paragraph](/.paragraph)|[borders](/.paragraph#word-javascript/api/word/-paragraph-borders-member)|Returns a `BorderUniversalCollection` object that represents all the borders for the paragraph.| -||[closeUp()](/.paragraph#word-javascript/api/word/-paragraph-closeup-member(1))|Removes any spacing before the paragraph.| -||[indent()](/.paragraph#word-javascript/api/word/-paragraph-indent-member(1))|Indents the paragraph by one level.| -||[indentCharacterWidth(count: number)](/.paragraph#word-javascript/api/word/-paragraph-indentcharacterwidth-member(1))|Indents the paragraph by a specified number of characters.| -||[indentFirstLineCharacterWidth(count: number)](/.paragraph#word-javascript/api/word/-paragraph-indentfirstlinecharacterwidth-member(1))|Indents the first line of the paragraph by the specified number of characters.| -||[joinList()](/.paragraph#word-javascript/api/word/-paragraph-joinlist-member(1))|Joins a list paragraph with the closest list above or below this paragraph.| -||[next(count: number)](/.paragraph#word-javascript/api/word/-paragraph-next-member(1))|Returns a `Paragraph` object that represents the next paragraph.| -||[onCommentAdded](/.paragraph#word-javascript/api/word/-paragraph-oncommentadded-member)|Occurs when new comments are added.| -||[onCommentChanged](/.paragraph#word-javascript/api/word/-paragraph-oncommentchanged-member)|Occurs when a comment or its reply is changed.| -||[onCommentDeleted](/.paragraph#word-javascript/api/word/-paragraph-oncommentdeleted-member)|Occurs when comments are deleted.| -||[onCommentDeselected](/.paragraph#word-javascript/api/word/-paragraph-oncommentdeselected-member)|Occurs when a comment is deselected.| -||[onCommentSelected](/.paragraph#word-javascript/api/word/-paragraph-oncommentselected-member)|Occurs when a comment is selected.| -||[openOrCloseUp()](/.paragraph#word-javascript/api/word/-paragraph-openorcloseup-member(1))|Toggles the spacing before the paragraph.| -||[openUp()](/.paragraph#word-javascript/api/word/-paragraph-openup-member(1))|Sets spacing before the paragraph to 12 points.| -||[outdent()](/.paragraph#word-javascript/api/word/-paragraph-outdent-member(1))|Removes one level of indent for the paragraph.| -||[outlineDemote()](/.paragraph#word-javascript/api/word/-paragraph-outlinedemote-member(1))|Applies the next heading level style (Heading 1 through Heading 8) to the paragraph.| -||[outlineDemoteToBody()](/.paragraph#word-javascript/api/word/-paragraph-outlinedemotetobody-member(1))|Demotes the paragraph to body text by applying the Normal style.| -||[outlinePromote()](/.paragraph#word-javascript/api/word/-paragraph-outlinepromote-member(1))|Applies the previous heading level style (Heading 1 through Heading 8) to the paragraph.| -||[previous(count: number)](/.paragraph#word-javascript/api/word/-paragraph-previous-member(1))|Returns the previous paragraph as a `Paragraph` object.| -||[range](/.paragraph#word-javascript/api/word/-paragraph-range-member)|Gets a `Range` object that represents the portion of the document that's contained within the paragraph.| -||[reset()](/.paragraph#word-javascript/api/word/-paragraph-reset-member(1))|Removes manual paragraph formatting (formatting not applied using a style).| -||[resetAdvanceTo()](/.paragraph#word-javascript/api/word/-paragraph-resetadvanceto-member(1))|Resets the paragraph that uses custom list levels to the original level settings.| -||[selectNumber()](/.paragraph#word-javascript/api/word/-paragraph-selectnumber-member(1))|Selects the number or bullet in a list.| -||[separateList()](/.paragraph#word-javascript/api/word/-paragraph-separatelist-member(1))|Separates a list into two separate lists.| -||[shading](/.paragraph#word-javascript/api/word/-paragraph-shading-member)|Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph.| -||[space1()](/.paragraph#word-javascript/api/word/-paragraph-space1-member(1))|Sets the paragraph to single spacing.| -||[space1Pt5()](/.paragraph#word-javascript/api/word/-paragraph-space1pt5-member(1))|Sets the paragraph to 1.5-line spacing.| -||[space2()](/.paragraph#word-javascript/api/word/-paragraph-space2-member(1))|Sets the paragraph to double spacing.| -||[tabHangingIndent(count: number)](/.paragraph#word-javascript/api/word/-paragraph-tabhangingindent-member(1))|Sets a hanging indent to a specified number of tab stops.| -||[tabIndent(count: number)](/.paragraph#word-javascript/api/word/-paragraph-tabindent-member(1))|Sets the left indent for the paragraph to a specified number of tab stops.| -|[ParagraphAddedEventArgs](/.paragraphaddedeventargs)|[type](/.paragraphaddedeventargs#word-javascript/api/word/-paragraphaddedeventargs-type-member)|The event type.| -|[ParagraphChangedEventArgs](/.paragraphchangedeventargs)|[type](/.paragraphchangedeventargs#word-javascript/api/word/-paragraphchangedeventargs-type-member)|The event type.| -|[ParagraphCollection](/.paragraphcollection)|[add(range: Word.Range)](/.paragraphcollection#word-javascript/api/word/-paragraphcollection-add-member(1))|Returns a `Paragraph` object that represents a new, blank paragraph added to the document.| -||[closeUp()](/.paragraphcollection#word-javascript/api/word/-paragraphcollection-closeup-member(1))|Removes any spacing before the specified paragraphs.| -||[decreaseSpacing()](/.paragraphcollection#word-javascript/api/word/-paragraphcollection-decreasespacing-member(1))|Decreases the spacing before and after paragraphs in six-point increments.| -||[increaseSpacing()](/.paragraphcollection#word-javascript/api/word/-paragraphcollection-increasespacing-member(1))|Increases the spacing before and after paragraphs in six-point increments.| -||[indent()](/.paragraphcollection#word-javascript/api/word/-paragraphcollection-indent-member(1))|Indents the paragraphs by one level.| -||[indentCharacterWidth(count: number)](/.paragraphcollection#word-javascript/api/word/-paragraphcollection-indentcharacterwidth-member(1))|Indents the paragraphs in the collection by the specified number of characters.| -||[indentFirstLineCharacterWidth(count: number)](/.paragraphcollection#word-javascript/api/word/-paragraphcollection-indentfirstlinecharacterwidth-member(1))|Indents the first line of the paragraphs in the collection by the specified number of characters.| -||[openOrCloseUp()](/.paragraphcollection#word-javascript/api/word/-paragraphcollection-openorcloseup-member(1))|Toggles spacing before paragraphs.| -||[openUp()](/.paragraphcollection#word-javascript/api/word/-paragraphcollection-openup-member(1))|Sets spacing before the specified paragraphs to 12 points.| -||[outdent()](/.paragraphcollection#word-javascript/api/word/-paragraphcollection-outdent-member(1))|Removes one level of indent for the paragraphs.| -||[outlineDemote()](/.paragraphcollection#word-javascript/api/word/-paragraphcollection-outlinedemote-member(1))|Applies the next heading level style (Heading 1 through Heading 8) to the specified paragraphs.| -||[outlineDemoteToBody()](/.paragraphcollection#word-javascript/api/word/-paragraphcollection-outlinedemotetobody-member(1))|Demotes the specified paragraphs to body text by applying the Normal style.| -||[outlinePromote()](/.paragraphcollection#word-javascript/api/word/-paragraphcollection-outlinepromote-member(1))|Applies the previous heading level style (Heading 1 through Heading 8) to the paragraphs in the collection.| -||[space1()](/.paragraphcollection#word-javascript/api/word/-paragraphcollection-space1-member(1))|Sets the specified paragraphs to single spacing.| -||[space1Pt5()](/.paragraphcollection#word-javascript/api/word/-paragraphcollection-space1pt5-member(1))|Sets the specified paragraphs to 1.5-line spacing.| -||[space2()](/.paragraphcollection#word-javascript/api/word/-paragraphcollection-space2-member(1))|Sets the specified paragraphs to double spacing.| -||[tabHangingIndent(count: number)](/.paragraphcollection#word-javascript/api/word/-paragraphcollection-tabhangingindent-member(1))|Sets a hanging indent to the specified number of tab stops.| -||[tabIndent(count: number)](/.paragraphcollection#word-javascript/api/word/-paragraphcollection-tabindent-member(1))|Sets the left indent for the specified paragraphs to the specified number of tab stops.| -|[ParagraphDeletedEventArgs](/.paragraphdeletedeventargs)|[type](/.paragraphdeletedeventargs#word-javascript/api/word/-paragraphdeletedeventargs-type-member)|The event type.| -|[PictureContentControl](/.picturecontentcontrol)|[appearance](/.picturecontentcontrol#word-javascript/api/word/-picturecontentcontrol-appearance-member)|Specifies the appearance of the content control.| -||[color](/.picturecontentcontrol#word-javascript/api/word/-picturecontentcontrol-color-member)|Specifies the red-green-blue (RGB) value of the color of the content control.| -||[copy()](/.picturecontentcontrol#word-javascript/api/word/-picturecontentcontrol-copy-member(1))|Copies the content control from the active document to the Clipboard.| -||[cut()](/.picturecontentcontrol#word-javascript/api/word/-picturecontentcontrol-cut-member(1))|Removes the content control from the active document and moves the content control to the Clipboard.| -||[delete(deleteContents?: boolean)](/.picturecontentcontrol#word-javascript/api/word/-picturecontentcontrol-delete-member(1))|Deletes the content control and optionally its contents.| -||[id](/.picturecontentcontrol#word-javascript/api/word/-picturecontentcontrol-id-member)|Returns the identification for the content control.| -||[isTemporary](/.picturecontentcontrol#word-javascript/api/word/-picturecontentcontrol-istemporary-member)|Specifies whether to remove the content control from the active document when the user edits the contents of the control.| -||[level](/.picturecontentcontrol#word-javascript/api/word/-picturecontentcontrol-level-member)|Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline.| -||[lockContentControl](/.picturecontentcontrol#word-javascript/api/word/-picturecontentcontrol-lockcontentcontrol-member)|Specifies if the content control is locked (can't be deleted).| -||[lockContents](/.picturecontentcontrol#word-javascript/api/word/-picturecontentcontrol-lockcontents-member)|Specifies if the contents of the content control are locked (not editable).| -||[placeholderText](/.picturecontentcontrol#word-javascript/api/word/-picturecontentcontrol-placeholdertext-member)|Returns a `BuildingBlock` object that represents the placeholder text for the content control.| -||[range](/.picturecontentcontrol#word-javascript/api/word/-picturecontentcontrol-range-member)|Returns a `Range` object that represents the contents of the content control in the active document.| -||[setPlaceholderText(options?: Word.ContentControlPlaceholderOptions)](/.picturecontentcontrol#word-javascript/api/word/-picturecontentcontrol-setplaceholdertext-member(1))|Sets the placeholder text that displays in the content control until a user enters their own text.| -||[showingPlaceholderText](/.picturecontentcontrol#word-javascript/api/word/-picturecontentcontrol-showingplaceholdertext-member)|Returns whether the placeholder text for the content control is being displayed.| -||[tag](/.picturecontentcontrol#word-javascript/api/word/-picturecontentcontrol-tag-member)|Specifies a tag to identify the content control.| -||[title](/.picturecontentcontrol#word-javascript/api/word/-picturecontentcontrol-title-member)|Specifies the title for the content control.| -||[xmlMapping](/.picturecontentcontrol#word-javascript/api/word/-picturecontentcontrol-xmlmapping-member)|Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document.| -|[Range](/.range)|[bold](/.range#word-javascript/api/word/-range-bold-member)|Specifies whether the range is formatted as bold.| -||[boldBidirectional](/.range#word-javascript/api/word/-range-boldbidirectional-member)|Specifies whether the range is formatted as bold in a right-to-left language document.| -||[bookmarks](/.range#word-javascript/api/word/-range-bookmarks-member)|Returns a `BookmarkCollection` object that represents all the bookmarks in the range.| -||[borders](/.range#word-javascript/api/word/-range-borders-member)|Returns a `BorderUniversalCollection` object that represents all the borders for the range.| -||[case](/.range#word-javascript/api/word/-range-case-member)|Specifies a `CharacterCase` value that represents the case of the text in the range.| -||[characterWidth](/.range#word-javascript/api/word/-range-characterwidth-member)|Specifies the character width of the range.| -||[combineCharacters](/.range#word-javascript/api/word/-range-combinecharacters-member)|Specifies if the range contains combined characters.| -||[detectLanguage()](/.range#word-javascript/api/word/-range-detectlanguage-member(1))|Analyzes the range text to determine the language that it's written in.| -||[disableCharacterSpaceGrid](/.range#word-javascript/api/word/-range-disablecharacterspacegrid-member)|Specifies if Microsoft Word ignores the number of characters per line for the corresponding `Range` object.| -||[emphasisMark](/.range#word-javascript/api/word/-range-emphasismark-member)|Specifies the emphasis mark for a character or designated character string.| -||[end](/.range#word-javascript/api/word/-range-end-member)|Specifies the ending character position of the range.| -||[fitTextWidth](/.range#word-javascript/api/word/-range-fittextwidth-member)|Specifies the width (in the current measurement units) in which Microsoft Word fits the text in the current selection or range.| -||[frames](/.range#word-javascript/api/word/-range-frames-member)|Gets a `FrameCollection` object that represents all the frames in the range.| -||[grammarChecked](/.range#word-javascript/api/word/-range-grammarchecked-member)|Specifies if a grammar check has been run on the range or document.| -||[hasNoProofing](/.range#word-javascript/api/word/-range-hasnoproofing-member)|Specifies the proofing status (spelling and grammar checking) of the range.| -||[highlightColorIndex](/.range#word-javascript/api/word/-range-highlightcolorindex-member)|Specifies the highlight color for the range.| -||[horizontalInVertical](/.range#word-javascript/api/word/-range-horizontalinvertical-member)|Specifies the formatting for horizontal text set within vertical text.| -||[hyperlinks](/.range#word-javascript/api/word/-range-hyperlinks-member)|Returns a `HyperlinkCollection` object that represents all the hyperlinks in the range.| -||[id](/.range#word-javascript/api/word/-range-id-member)|Specifies the ID for the range.| -||[isEndOfRowMark](/.range#word-javascript/api/word/-range-isendofrowmark-member)|Gets if the range is collapsed and is located at the end-of-row mark in a table.| -||[isTextVisibleOnScreen](/.range#word-javascript/api/word/-range-istextvisibleonscreen-member)|Gets whether the text in the range is visible on the screen.| -||[italic](/.range#word-javascript/api/word/-range-italic-member)|Specifies if the font or range is formatted as italic.| -||[italicBidirectional](/.range#word-javascript/api/word/-range-italicbidirectional-member)|Specifies if the font or range is formatted as italic (right-to-left languages).| -||[kana](/.range#word-javascript/api/word/-range-kana-member)|Specifies whether the range of Japanese language text is hiragana or katakana.| -||[languageDetected](/.range#word-javascript/api/word/-range-languagedetected-member)|Specifies whether Microsoft Word has detected the language of the text in the range.| -||[languageId](/.range#word-javascript/api/word/-range-languageid-member)|Specifies a `LanguageId` value that represents the language for the range.| -||[languageIdFarEast](/.range#word-javascript/api/word/-range-languageidfareast-member)|Specifies an East Asian language for the range.| -||[languageIdOther](/.range#word-javascript/api/word/-range-languageidother-member)|Specifies a language for the range that isn't classified as an East Asian language.| -||[listFormat](/.range#word-javascript/api/word/-range-listformat-member)|Returns a `ListFormat` object that represents all the list formatting characteristics of the range.| -||[onCommentAdded](/.range#word-javascript/api/word/-range-oncommentadded-member)|Occurs when new comments are added.| -||[onCommentChanged](/.range#word-javascript/api/word/-range-oncommentchanged-member)|Occurs when a comment or its reply is changed.| -||[onCommentDeselected](/.range#word-javascript/api/word/-range-oncommentdeselected-member)|Occurs when a comment is deselected.| -||[onCommentSelected](/.range#word-javascript/api/word/-range-oncommentselected-member)|Occurs when a comment is selected.| -||[sections](/.range#word-javascript/api/word/-range-sections-member)|Gets the collection of sections in the range.| -||[shading](/.range#word-javascript/api/word/-range-shading-member)|Returns a `ShadingUniversal` object that refers to the shading formatting for the range.| -||[showAll](/.range#word-javascript/api/word/-range-showall-member)|Specifies if all nonprinting characters (such as hidden text, tab marks, space marks, and paragraph marks) are displayed.| -||[spellingChecked](/.range#word-javascript/api/word/-range-spellingchecked-member)|Specifies if spelling has been checked throughout the range or document.| -||[start](/.range#word-javascript/api/word/-range-start-member)|Specifies the starting character position of the range.| -||[storyLength](/.range#word-javascript/api/word/-range-storylength-member)|Gets the number of characters in the story that contains the range.| -||[storyType](/.range#word-javascript/api/word/-range-storytype-member)|Gets the story type for the range.| -||[tableColumns](/.range#word-javascript/api/word/-range-tablecolumns-member)|Gets a `TableColumnCollection` object that represents all the table columns in the range.| -||[twoLinesInOne](/.range#word-javascript/api/word/-range-twolinesinone-member)|Specifies whether Microsoft Word sets two lines of text in one and specifies the characters that enclose the text, if any.| -||[underline](/.range#word-javascript/api/word/-range-underline-member)|Specifies the type of underline applied to the range.| -|[ReflectionFormat](/.reflectionformat)|[blur](/.reflectionformat#word-javascript/api/word/-reflectionformat-blur-member)|Specifies the degree of blur effect applied to the `ReflectionFormat` object as a value between 0.0 and 100.0.| -||[offset](/.reflectionformat#word-javascript/api/word/-reflectionformat-offset-member)|Specifies the amount of separation, in points, of the reflected image from the shape.| -||[size](/.reflectionformat#word-javascript/api/word/-reflectionformat-size-member)|Specifies the size of the reflection as a percentage of the reflected shape from 0 to 100.| -||[transparency](/.reflectionformat#word-javascript/api/word/-reflectionformat-transparency-member)|Specifies the degree of transparency for the reflection effect as a value between 0.0 (opaque) and 1.0 (clear).| -||[type](/.reflectionformat#word-javascript/api/word/-reflectionformat-type-member)|Specifies a `ReflectionType` value that represents the type and direction of the lighting for a shape reflection.| -|[RepeatingSectionContentControl](/.repeatingsectioncontentcontrol)|[allowInsertDeleteSection](/.repeatingsectioncontentcontrol#word-javascript/api/word/-repeatingsectioncontentcontrol-allowinsertdeletesection-member)|Specifies whether users can add or remove sections from this repeating section content control by using the user interface.| -||[appearance](/.repeatingsectioncontentcontrol#word-javascript/api/word/-repeatingsectioncontentcontrol-appearance-member)|Specifies the appearance of the content control.| -||[color](/.repeatingsectioncontentcontrol#word-javascript/api/word/-repeatingsectioncontentcontrol-color-member)|Specifies the red-green-blue (RGB) value of the color of the content control.| -||[copy()](/.repeatingsectioncontentcontrol#word-javascript/api/word/-repeatingsectioncontentcontrol-copy-member(1))|Copies the content control from the active document to the Clipboard.| -||[cut()](/.repeatingsectioncontentcontrol#word-javascript/api/word/-repeatingsectioncontentcontrol-cut-member(1))|Removes the content control from the active document and moves the content control to the Clipboard.| -||[delete(deleteContents?: boolean)](/.repeatingsectioncontentcontrol#word-javascript/api/word/-repeatingsectioncontentcontrol-delete-member(1))|Deletes the content control and the contents of the content control.| -||[id](/.repeatingsectioncontentcontrol#word-javascript/api/word/-repeatingsectioncontentcontrol-id-member)|Returns the identification for the content control.| -||[isTemporary](/.repeatingsectioncontentcontrol#word-javascript/api/word/-repeatingsectioncontentcontrol-istemporary-member)|Specifies whether to remove the content control from the active document when the user edits the contents of the control.| -||[level](/.repeatingsectioncontentcontrol#word-javascript/api/word/-repeatingsectioncontentcontrol-level-member)|Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline.| -||[lockContentControl](/.repeatingsectioncontentcontrol#word-javascript/api/word/-repeatingsectioncontentcontrol-lockcontentcontrol-member)|Specifies if the content control is locked (can't be deleted).| -||[lockContents](/.repeatingsectioncontentcontrol#word-javascript/api/word/-repeatingsectioncontentcontrol-lockcontents-member)|Specifies if the contents of the content control are locked (not editable).| -||[placeholderText](/.repeatingsectioncontentcontrol#word-javascript/api/word/-repeatingsectioncontentcontrol-placeholdertext-member)|Returns a `BuildingBlock` object that represents the placeholder text for the content control.| -||[range](/.repeatingsectioncontentcontrol#word-javascript/api/word/-repeatingsectioncontentcontrol-range-member)|Gets a `Range` object that represents the contents of the content control in the active document.| -||[repeatingSectionItemTitle](/.repeatingsectioncontentcontrol#word-javascript/api/word/-repeatingsectioncontentcontrol-repeatingsectionitemtitle-member)|Specifies the name of the repeating section items used in the context menu associated with this repeating section content control.| -||[repeatingSectionItems](/.repeatingsectioncontentcontrol#word-javascript/api/word/-repeatingsectioncontentcontrol-repeatingsectionitems-member)|Returns the collection of repeating section items in this repeating section content control.| -||[setPlaceholderText(options?: Word.ContentControlPlaceholderOptions)](/.repeatingsectioncontentcontrol#word-javascript/api/word/-repeatingsectioncontentcontrol-setplaceholdertext-member(1))|Sets the placeholder text that displays in the content control until a user enters their own text.| -||[showingPlaceholderText](/.repeatingsectioncontentcontrol#word-javascript/api/word/-repeatingsectioncontentcontrol-showingplaceholdertext-member)|Returns whether the placeholder text for the content control is being displayed.| -||[tag](/.repeatingsectioncontentcontrol#word-javascript/api/word/-repeatingsectioncontentcontrol-tag-member)|Specifies a tag to identify the content control.| -||[title](/.repeatingsectioncontentcontrol#word-javascript/api/word/-repeatingsectioncontentcontrol-title-member)|Specifies the title for the content control.| -||[xmlapping](/.repeatingsectioncontentcontrol#word-javascript/api/word/-repeatingsectioncontentcontrol-xmlapping-member)|Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document.| -|[RepeatingSectionItem](/.repeatingsectionitem)|[delete()](/.repeatingsectionitem#word-javascript/api/word/-repeatingsectionitem-delete-member(1))|Deletes this `RepeatingSectionItem` object.| -||[insertItemAfter()](/.repeatingsectionitem#word-javascript/api/word/-repeatingsectionitem-insertitemafter-member(1))|Adds a repeating section item after this item and returns the new item.| -||[insertItemBefore()](/.repeatingsectionitem#word-javascript/api/word/-repeatingsectionitem-insertitembefore-member(1))|Adds a repeating section item before this item and returns the new item.| -||[range](/.repeatingsectionitem#word-javascript/api/word/-repeatingsectionitem-range-member)|Returns the range of this repeating section item, excluding the start and end tags.| -|[RepeatingSectionItemCollection](/.repeatingsectionitemcollection)|[getItemAt(index: number)](/.repeatingsectionitemcollection#word-javascript/api/word/-repeatingsectionitemcollection-getitemat-member(1))|Returns an individual repeating section item.| -|[Reviewer](/.reviewer)|[isVisible](/.reviewer#word-javascript/api/word/-reviewer-isvisible-member)|Specifies if the `Reviewer` object is visible.| -|[ReviewerCollection](/.reviewercollection)|[getItem(index: number)](/.reviewercollection#word-javascript/api/word/-reviewercollection-getitem-member(1))|Returns a `Reviewer` object that represents the specified item in the collection.| -||[items](/.reviewercollection#word-javascript/api/word/-reviewercollection-items-member)|Gets the loaded child items in this collection.| -|[RevisionsFilter](/.revisionsfilter)|[markup](/.revisionsfilter#word-javascript/api/word/-revisionsfilter-markup-member)|Specifies a `RevisionsMarkup` value that represents the extent of reviewer markup displayed in the document.| -||[reviewers](/.revisionsfilter#word-javascript/api/word/-revisionsfilter-reviewers-member)|Gets the `ReviewerCollection` object that represents the collection of reviewers of one or more documents.| -||[toggleShowAllReviewers()](/.revisionsfilter#word-javascript/api/word/-revisionsfilter-toggleshowallreviewers-member(1))|Shows or hides all revisions in the document that contain comments and tracked changes.| -||[view](/.revisionsfilter#word-javascript/api/word/-revisionsfilter-view-member)|Specifies a `RevisionsView` value that represents globally whether Word displays the original version of the document or the final version, which might have revisions and formatting changes applied.| -|[Section](/.section)|[borders](/.section#word-javascript/api/word/-section-borders-member)|Returns a `BorderUniversalCollection` object that represents all the borders in the section.| -||[pageSetup](/.section#word-javascript/api/word/-section-pagesetup-member)|Returns a `PageSetup` object that's associated with the section.| -||[protectedForForms](/.section#word-javascript/api/word/-section-protectedforforms-member)|Specifies if the section is protected for forms.| -|[ShadingUniversal](/.shadinguniversal)|[backgroundPatternColor](/.shadinguniversal#word-javascript/api/word/-shadinguniversal-backgroundpatterncolor-member)|Specifies the color that's applied to the background of the `ShadingUniversal` object.| -||[backgroundPatternColorIndex](/.shadinguniversal#word-javascript/api/word/-shadinguniversal-backgroundpatterncolorindex-member)|Specifies the color that's applied to the background of the `ShadingUniversal` object.| -||[foregroundPatternColor](/.shadinguniversal#word-javascript/api/word/-shadinguniversal-foregroundpatterncolor-member)|Specifies the color that's applied to the foreground of the `ShadingUniversal` object.| -||[foregroundPatternColorIndex](/.shadinguniversal#word-javascript/api/word/-shadinguniversal-foregroundpatterncolorindex-member)|Specifies the color that's applied to the foreground of the `ShadingUniversal` object.| -||[texture](/.shadinguniversal#word-javascript/api/word/-shadinguniversal-texture-member)|Specifies the shading texture of the object.| -|[ShadowFormat](/.shadowformat)|[blur](/.shadowformat#word-javascript/api/word/-shadowformat-blur-member)|Specifies the blur level for a shadow format as a value between 0.0 and 100.0.| -||[foregroundColor](/.shadowformat#word-javascript/api/word/-shadowformat-foregroundcolor-member)|Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow.| -||[incrementOffsetX(increment: number)](/.shadowformat#word-javascript/api/word/-shadowformat-incrementoffsetx-member(1))|Changes the horizontal offset of the shadow by the number of points.| -||[incrementOffsetY(increment: number)](/.shadowformat#word-javascript/api/word/-shadowformat-incrementoffsety-member(1))|Changes the vertical offset of the shadow by the specified number of points.| -||[isVisible](/.shadowformat#word-javascript/api/word/-shadowformat-isvisible-member)|Specifies whether the object or the formatting applied to it is visible.| -||[obscured](/.shadowformat#word-javascript/api/word/-shadowformat-obscured-member)|Specifies `true` if the shadow of the shape appears filled in and is obscured by the shape, even if the shape has no fill,| -||[offsetX](/.shadowformat#word-javascript/api/word/-shadowformat-offsetx-member)|Specifies the horizontal offset (in points) of the shadow from the shape.| -||[offsetY](/.shadowformat#word-javascript/api/word/-shadowformat-offsety-member)|Specifies the vertical offset (in points) of the shadow from the shape.| -||[rotateWithShape](/.shadowformat#word-javascript/api/word/-shadowformat-rotatewithshape-member)|Specifies whether to rotate the shadow when rotating the shape.| -||[size](/.shadowformat#word-javascript/api/word/-shadowformat-size-member)|Specifies the width of the shadow.| -||[style](/.shadowformat#word-javascript/api/word/-shadowformat-style-member)|Specifies the type of shadow formatting to apply to a shape.| -||[transparency](/.shadowformat#word-javascript/api/word/-shadowformat-transparency-member)|Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear).| -||[type](/.shadowformat#word-javascript/api/word/-shadowformat-type-member)|Specifies the shape shadow type.| -|[Source](/.source)|[delete()](/.source#word-javascript/api/word/-source-delete-member(1))|Deletes the `Source` object.| -||[getFieldByName(name: string)](/.source#word-javascript/api/word/-source-getfieldbyname-member(1))|Returns the value of a field in the bibliography `Source` object.| -||[isCited](/.source#word-javascript/api/word/-source-iscited-member)|Gets if the `Source` object has been cited in the document.| -||[tag](/.source#word-javascript/api/word/-source-tag-member)|Gets the tag of the source.| -||[xml](/.source#word-javascript/api/word/-source-xml-member)|Gets the XML representation of the source.| -|[SourceCollection](/.sourcecollection)|[add(xml: string)](/.sourcecollection#word-javascript/api/word/-sourcecollection-add-member(1))|Adds a new `Source` object to the collection.| -||[getItem(index: number)](/.sourcecollection#word-javascript/api/word/-sourcecollection-getitem-member(1))|Gets a `Source` by its index in the collection.| -||[items](/.sourcecollection#word-javascript/api/word/-sourcecollection-items-member)|Gets the loaded child items in this collection.| -|[Style](/.style)|[automaticallyUpdate](/.style#word-javascript/api/word/-style-automaticallyupdate-member)|Specifies whether the style is automatically redefined based on the selection.| -||[description](/.style#word-javascript/api/word/-style-description-member)|Gets the description of the specified style.| -||[frame](/.style#word-javascript/api/word/-style-frame-member)|Returns a `Frame` object that represents the frame formatting for the style.| -||[hasProofing](/.style#word-javascript/api/word/-style-hasproofing-member)|Specifies whether the spelling and grammar checker ignores text formatted with this style.| -||[languageId](/.style#word-javascript/api/word/-style-languageid-member)|Specifies a `LanguageId` value that represents the language for the style.| -||[languageIdFarEast](/.style#word-javascript/api/word/-style-languageidfareast-member)|Specifies an East Asian language for the style.| -||[linkStyle](/.style#word-javascript/api/word/-style-linkstyle-member)|Specifies a link between a paragraph and a character style.| -||[linkToListTemplate(listTemplate: Word.ListTemplate)](/.style#word-javascript/api/word/-style-linktolisttemplate-member(1))|Links this style to a list template so that the style's formatting can be applied to lists.| -||[listLevelNumber](/.style#word-javascript/api/word/-style-listlevelnumber-member)|Returns the list level for the style.| -||[locked](/.style#word-javascript/api/word/-style-locked-member)|Specifies whether the style cannot be changed or edited.| -||[noSpaceBetweenParagraphsOfSameStyle](/.style#word-javascript/api/word/-style-nospacebetweenparagraphsofsamestyle-member)|Specifies whether to remove spacing between paragraphs that are formatted using the same style.| -|[TabStop](/.tabstop)|[alignment](/.tabstop#word-javascript/api/word/-tabstop-alignment-member)|Gets a `TabAlignment` value that represents the alignment for the tab stop.| -||[clear()](/.tabstop#word-javascript/api/word/-tabstop-clear-member(1))|Removes this custom tab stop.| -||[customTab](/.tabstop#word-javascript/api/word/-tabstop-customtab-member)|Gets whether this tab stop is a custom tab stop.| -||[leader](/.tabstop#word-javascript/api/word/-tabstop-leader-member)|Gets a `TabLeader` value that represents the leader for this `TabStop` object.| -||[next](/.tabstop#word-javascript/api/word/-tabstop-next-member)|Gets the next tab stop in the collection.| -||[position](/.tabstop#word-javascript/api/word/-tabstop-position-member)|Gets the position of the tab stop relative to the left margin.| -||[previous](/.tabstop#word-javascript/api/word/-tabstop-previous-member)|Gets the previous tab stop in the collection.| -|[TabStopAddOptions](/.tabstopaddoptions)|[alignment](/.tabstopaddoptions#word-javascript/api/word/-tabstopaddoptions-alignment-member)|If provided, specifies the alignment of the tab stop.| -||[leader](/.tabstopaddoptions#word-javascript/api/word/-tabstopaddoptions-leader-member)|If provided, specifies the leader character for the tab stop.| -|[TabStopCollection](/.tabstopcollection)|[add(position: number, options?: Word.TabStopAddOptions)](/.tabstopcollection#word-javascript/api/word/-tabstopcollection-add-member(1))|Returns a `TabStop` object that represents a custom tab stop added to the paragraph.| -||[after(Position: number)](/.tabstopcollection#word-javascript/api/word/-tabstopcollection-after-member(1))|Returns the next `TabStop` object to the right of the specified position.| -||[before(Position: number)](/.tabstopcollection#word-javascript/api/word/-tabstopcollection-before-member(1))|Returns the next `TabStop` object to the left of the specified position.| -||[clearAll()](/.tabstopcollection#word-javascript/api/word/-tabstopcollection-clearall-member(1))|Clears all the custom tab stops from the paragraph.| -||[getItem(index: number)](/.tabstopcollection#word-javascript/api/word/-tabstopcollection-getitem-member(1))|Gets a `TabStop` object by its index in the collection.| -||[items](/.tabstopcollection#word-javascript/api/word/-tabstopcollection-items-member)|Gets the loaded child items in this collection.| -|[TableColumn](/.tablecolumn)|[autoFit()](/.tablecolumn#word-javascript/api/word/-tablecolumn-autofit-member(1))|Changes the width of the table column to accommodate the width of the text without changing the way text wraps in the cells.| -||[borders](/.tablecolumn#word-javascript/api/word/-tablecolumn-borders-member)|Returns a `BorderUniversalCollection` object that represents all the borders for the table column.| -||[columnIndex](/.tablecolumn#word-javascript/api/word/-tablecolumn-columnindex-member)|Returns the position of this column in a collection.| -||[delete()](/.tablecolumn#word-javascript/api/word/-tablecolumn-delete-member(1))|Deletes the column.| -||[isFirst](/.tablecolumn#word-javascript/api/word/-tablecolumn-isfirst-member)|Returns `true` if the column or row is the first one in the table; `false` otherwise.| -||[isLast](/.tablecolumn#word-javascript/api/word/-tablecolumn-islast-member)|Returns `true` if the column or row is the last one in the table; `false` otherwise.| -||[nestingLevel](/.tablecolumn#word-javascript/api/word/-tablecolumn-nestinglevel-member)|Returns the nesting level of the column.| -||[preferredWidth](/.tablecolumn#word-javascript/api/word/-tablecolumn-preferredwidth-member)|Specifies the preferred width (in points or as a percentage of the window width) for the column.| -||[preferredWidthType](/.tablecolumn#word-javascript/api/word/-tablecolumn-preferredwidthtype-member)|Specifies the preferred unit of measurement to use for the width of the table column.| -||[select()](/.tablecolumn#word-javascript/api/word/-tablecolumn-select-member(1))|Selects the table column.| -||[setWidth(columnWidth: number, rulerStyle: Word.RulerStyle)](/.tablecolumn#word-javascript/api/word/-tablecolumn-setwidth-member(1))|Sets the width of the column in a table.| -||[shading](/.tablecolumn#word-javascript/api/word/-tablecolumn-shading-member)|Returns a `ShadingUniversal` object that refers to the shading formatting for the column.| -||[sort()](/.tablecolumn#word-javascript/api/word/-tablecolumn-sort-member(1))|Sorts the table column.| -||[width](/.tablecolumn#word-javascript/api/word/-tablecolumn-width-member)|Specifies the width of the column, in points.| -|[TableColumnCollection](/.tablecolumncollection)|[add(beforeColumn?: Word.TableColumn)](/.tablecolumncollection#word-javascript/api/word/-tablecolumncollection-add-member(1))|Returns a `TableColumn` object that represents a column added to a table.| -||[autoFit()](/.tablecolumncollection#word-javascript/api/word/-tablecolumncollection-autofit-member(1))|Changes the width of a table column to accommodate the width of the text without changing the way text wraps in the cells.| -||[delete()](/.tablecolumncollection#word-javascript/api/word/-tablecolumncollection-delete-member(1))|Deletes the specified columns.| -||[distributeWidth()](/.tablecolumncollection#word-javascript/api/word/-tablecolumncollection-distributewidth-member(1))|Adjusts the width of the specified columns so that they are equal.| -||[items](/.tablecolumncollection#word-javascript/api/word/-tablecolumncollection-items-member)|Gets the loaded child items in this collection.| -||[select()](/.tablecolumncollection#word-javascript/api/word/-tablecolumncollection-select-member(1))|Selects the specified table columns.| -||[setWidth(columnWidth: number, rulerStyle: Word.RulerStyle)](/.tablecolumncollection#word-javascript/api/word/-tablecolumncollection-setwidth-member(1))|Sets the width of columns in a table.| -|[Template](/.template)|[buildingBlockEntries](/.template#word-javascript/api/word/-template-buildingblockentries-member)|Returns a `BuildingBlockEntryCollection` object that represents the collection of building block entries in the template.| -||[buildingBlockTypes](/.template#word-javascript/api/word/-template-buildingblocktypes-member)|Returns a `BuildingBlockTypeItemCollection` object that represents the collection of building block types that are contained in the template.| -||[farEastLineBreakLanguage](/.template#word-javascript/api/word/-template-fareastlinebreaklanguage-member)|Specifies the East Asian language to use when breaking lines of text in the document or template.| -||[farEastLineBreakLevel](/.template#word-javascript/api/word/-template-fareastlinebreaklevel-member)|Specifies the line break control level for the document.| -||[fullName](/.template#word-javascript/api/word/-template-fullname-member)|Returns the name of the template, including the drive or Web path.| -||[hasNoProofing](/.template#word-javascript/api/word/-template-hasnoproofing-member)|Specifies whether the spelling and grammar checker ignores documents based on this template.| -||[justificationMode](/.template#word-javascript/api/word/-template-justificationmode-member)|Specifies the character spacing adjustment for the template.| -||[kerningByAlgorithm](/.template#word-javascript/api/word/-template-kerningbyalgorithm-member)|Specifies if Microsoft Word kerns half-width Latin characters and punctuation marks in the document.| -||[languageId](/.template#word-javascript/api/word/-template-languageid-member)|Specifies a `LanguageId` value that represents the language in the template.| -||[languageIdFarEast](/.template#word-javascript/api/word/-template-languageidfareast-member)|Specifies an East Asian language for the language in the template.| -||[name](/.template#word-javascript/api/word/-template-name-member)|Returns only the name of the document template (excluding any path or other location information).| -||[noLineBreakAfter](/.template#word-javascript/api/word/-template-nolinebreakafter-member)|Specifies the kinsoku characters after which Microsoft Word will not break a line.| -||[noLineBreakBefore](/.template#word-javascript/api/word/-template-nolinebreakbefore-member)|Specifies the kinsoku characters before which Microsoft Word will not break a line.| -||[path](/.template#word-javascript/api/word/-template-path-member)|Returns the path to the document template.| -||[save()](/.template#word-javascript/api/word/-template-save-member(1))|Saves the template.| -||[saved](/.template#word-javascript/api/word/-template-saved-member)|Specifies `true` if the template has not changed since it was last saved, `false` if Microsoft Word displays a prompt to save changes when the document is closed.| -||[type](/.template#word-javascript/api/word/-template-type-member)|Returns the template type.| -|[TemplateCollection](/.templatecollection)|[getCount()](/.templatecollection#word-javascript/api/word/-templatecollection-getcount-member(1))|Returns the number of items in the collection.| -||[getItemAt(index: number)](/.templatecollection#word-javascript/api/word/-templatecollection-getitemat-member(1))|Gets a `Template` object by its index in the collection.| -||[importBuildingBlocks()](/.templatecollection#word-javascript/api/word/-templatecollection-importbuildingblocks-member(1))|Imports the building blocks for all templates into Microsoft Word.| -||[items](/.templatecollection#word-javascript/api/word/-templatecollection-items-member)|Gets the loaded child items in this collection.| -|[TextColumn](/.textcolumn)|[spaceAfter](/.textcolumn#word-javascript/api/word/-textcolumn-spaceafter-member)|Specifies the amount of spacing (in points) after the specified paragraph or text column.| -||[width](/.textcolumn#word-javascript/api/word/-textcolumn-width-member)|Specifies the width, in points, of the specified text columns.| -|[TextColumnAddOptions](/.textcolumnaddoptions)|[isEvenlySpaced](/.textcolumnaddoptions#word-javascript/api/word/-textcolumnaddoptions-isevenlyspaced-member)|If provided, specifies whether to evenly space all the text columns in the document.| -||[spacing](/.textcolumnaddoptions#word-javascript/api/word/-textcolumnaddoptions-spacing-member)|If provided, specifies the spacing between the text columns in the document, in points.| -||[width](/.textcolumnaddoptions#word-javascript/api/word/-textcolumnaddoptions-width-member)|If provided, specifies the width of the new text column in the document, in points.| -|[TextColumnCollection](/.textcolumncollection)|[add(options?: Word.TextColumnAddOptions)](/.textcolumncollection#word-javascript/api/word/-textcolumncollection-add-member(1))|Returns a `TextColumn` object that represents a new text column added to a section or document.| -||[getFlowDirection()](/.textcolumncollection#word-javascript/api/word/-textcolumncollection-getflowdirection-member(1))|Gets the direction in which text flows from one text column to the next.| -||[getHasLineBetween()](/.textcolumncollection#word-javascript/api/word/-textcolumncollection-gethaslinebetween-member(1))|Gets whether vertical lines appear between all the columns in the `TextColumnCollection` object.| -||[getIsEvenlySpaced()](/.textcolumncollection#word-javascript/api/word/-textcolumncollection-getisevenlyspaced-member(1))|Gets whether text columns are evenly spaced.| -||[getItem(index: number)](/.textcolumncollection#word-javascript/api/word/-textcolumncollection-getitem-member(1))|Gets a `TextColumn` by its index in the collection.| -||[items](/.textcolumncollection#word-javascript/api/word/-textcolumncollection-items-member)|Gets the loaded child items in this collection.| -||[setCount(numColumns: number)](/.textcolumncollection#word-javascript/api/word/-textcolumncollection-setcount-member(1))|Arranges text into the specified number of text columns.| -||[setFlowDirection(value: Word.FlowDirection)](/.textcolumncollection#word-javascript/api/word/-textcolumncollection-setflowdirection-member(1))|Sets the direction in which text flows from one text column to the next.| -||[setHasLineBetween(value: boolean)](/.textcolumncollection#word-javascript/api/word/-textcolumncollection-sethaslinebetween-member(1))|Sets whether vertical lines appear between all the columns in the `TextColumnCollection` object.| -||[setIsEvenlySpaced(value: boolean)](/.textcolumncollection#word-javascript/api/word/-textcolumncollection-setisevenlyspaced-member(1))|Sets whether text columns are evenly spaced.| -|[ThreeDimensionalFormat](/.threedimensionalformat)|[bevelBottomDepth](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-bevelbottomdepth-member)|Specifies the depth of the bottom bevel.| -||[bevelBottomInset](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-bevelbottominset-member)|Specifies the inset size for the bottom bevel.| -||[bevelBottomType](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-bevelbottomtype-member)|Specifies a `BevelType` value that represents the bevel type for the bottom bevel.| -||[bevelTopDepth](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-beveltopdepth-member)|Specifies the depth of the top bevel.| -||[bevelTopInset](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-beveltopinset-member)|Specifies the inset size for the top bevel.| -||[bevelTopType](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-beveltoptype-member)|Specifies a `BevelType` value that represents the bevel type for the top bevel.| -||[contourColor](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-contourcolor-member)|Returns a `ColorFormat` object that represents color of the contour of a shape.| -||[contourWidth](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-contourwidth-member)|Specifies the width of the contour of a shape.| -||[depth](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-depth-member)|Specifies the depth of the shape's extrusion.| -||[extrusionColor](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-extrusioncolor-member)|Returns a `ColorFormat` object that represents the color of the shape's extrusion.| -||[extrusionColorType](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-extrusioncolortype-member)|Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion)| -||[fieldOfView](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-fieldofview-member)|Specifies the amount of perspective for a shape.| -||[incrementRotationHorizontal(increment: number)](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-incrementrotationhorizontal-member(1))|Horizontally rotates a shape on the x-axis.| -||[incrementRotationVertical(increment: number)](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-incrementrotationvertical-member(1))|Vertically rotates a shape on the y-axis.| -||[incrementRotationX(increment: number)](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-incrementrotationx-member(1))|Changes the rotation around the x-axis.| -||[incrementRotationY(increment: number)](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-incrementrotationy-member(1))|Changes the rotation around the y-axis.| -||[incrementRotationZ(increment: number)](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-incrementrotationz-member(1))|Rotates a shape on the z-axis.| -||[isPerspective](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-isperspective-member)|Specifies `true` if the extrusion appears in perspective — that is, if the walls of the extrusion narrow toward a vanishing point,| -||[isVisible](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-isvisible-member)|Specifies if the specified object, or the formatting applied to it, is visible.| -||[lightAngle](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-lightangle-member)|Specifies the angle of the lighting.| -||[presetCamera](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-presetcamera-member)|Returns a `PresetCamera` value that represents the camera presets.| -||[presetExtrusionDirection](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-presetextrusiondirection-member)|Returns the direction taken by the extrusion's sweep path leading away from the extruded shape (the front face of the extrusion).| -||[presetLighting](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-presetlighting-member)|Specifies a `LightRigType` value that represents the lighting preset.| -||[presetLightingDirection](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-presetlightingdirection-member)|Specifies the position of the light source relative to the extrusion.| -||[presetLightingSoftness](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-presetlightingsoftness-member)|Specifies the intensity of the extrusion lighting.| -||[presetMaterial](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-presetmaterial-member)|Specifies the extrusion surface material.| -||[presetThreeDimensionalFormat](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-presetthreedimensionalformat-member)|Returns the preset extrusion format.| -||[projectText](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-projecttext-member)|Specifies whether text on a shape rotates with shape.| -||[resetRotation()](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-resetrotation-member(1))|Resets the extrusion rotation around the x-axis, y-axis, and z-axis to 0.| -||[rotationX](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-rotationx-member)|Specifies the rotation of the extruded shape around the x-axis in degrees.| -||[rotationY](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-rotationy-member)|Specifies the rotation of the extruded shape around the y-axis in degrees.| -||[rotationZ](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-rotationz-member)|Specifies the z-axis rotation of the camera.| -||[setExtrusionDirection(presetExtrusionDirection: Word.PresetExtrusionDirection)](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-setextrusiondirection-member(1))|Sets the direction of the extrusion's sweep path.| -||[setPresetCamera(presetCamera: Word.PresetCamera)](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-setpresetcamera-member(1))|Sets the camera preset for the shape.| -||[setThreeDimensionalFormat(presetThreeDimensionalFormat: Word.PresetThreeDimensionalFormat)](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-setthreedimensionalformat-member(1))|Sets the preset extrusion format.| -||[z](/.threedimensionalformat#word-javascript/api/word/-threedimensionalformat-z-member)|Specifies the position on the z-axis for the shape.| -|[View](/.view)|[areAllNonprintingCharactersDisplayed](/.view#word-javascript/api/word/-view-areallnonprintingcharactersdisplayed-member)|Specifies whether all nonprinting characters are displayed.| -||[areBackgroundsDisplayed](/.view#word-javascript/api/word/-view-arebackgroundsdisplayed-member)|Gets whether background colors and images are shown when the document is displayed in print layout view.| -||[areBookmarksIndicated](/.view#word-javascript/api/word/-view-arebookmarksindicated-member)|Gets whether square brackets are displayed at the beginning and end of each bookmark.| -||[areCommentsDisplayed](/.view#word-javascript/api/word/-view-arecommentsdisplayed-member)|Specifies whether Microsoft Word displays the comments in the document.| -||[areConnectingLinesToRevisionsBalloonDisplayed](/.view#word-javascript/api/word/-view-areconnectinglinestorevisionsballoondisplayed-member)|Specifies whether Microsoft Word displays connecting lines from the text to the revision and comment balloons.| -||[areCropMarksDisplayed](/.view#word-javascript/api/word/-view-arecropmarksdisplayed-member)|Gets whether crop marks are shown in the corners of pages to indicate where margins are located.| -||[areDrawingsDisplayed](/.view#word-javascript/api/word/-view-aredrawingsdisplayed-member)|Gets whether objects created with the drawing tools are displayed in print layout view.| -||[areEditableRangesShaded](/.view#word-javascript/api/word/-view-areeditablerangesshaded-member)|Specifies whether shading is applied to the ranges in the document that users have permission to modify.| -||[areFieldCodesDisplayed](/.view#word-javascript/api/word/-view-arefieldcodesdisplayed-member)|Specifies whether field codes are displayed.| -||[areFormatChangesDisplayed](/.view#word-javascript/api/word/-view-areformatchangesdisplayed-member)|Specifies whether Microsoft Word displays formatting changes made to the document with Track Changes enabled.| -||[areInkAnnotationsDisplayed](/.view#word-javascript/api/word/-view-areinkannotationsdisplayed-member)|Specifies whether handwritten ink annotations are shown or hidden.| -||[areInsertionsAndDeletionsDisplayed](/.view#word-javascript/api/word/-view-areinsertionsanddeletionsdisplayed-member)|Specifies whether Microsoft Word displays insertions and deletions made to the document with Track Changes enabled.| -||[areLinesWrappedToWindow](/.view#word-javascript/api/word/-view-arelineswrappedtowindow-member)|Gets whether lines wrap at the right edge of the document window rather than at the right margin or the right column boundary.| -||[areObjectAnchorsDisplayed](/.view#word-javascript/api/word/-view-areobjectanchorsdisplayed-member)|Gets whether object anchors are displayed next to items that can be positioned in print layout view.| -||[areOptionalBreaksDisplayed](/.view#word-javascript/api/word/-view-areoptionalbreaksdisplayed-member)|Gets whether Microsoft Word displays optional line breaks.| -||[areOptionalHyphensDisplayed](/.view#word-javascript/api/word/-view-areoptionalhyphensdisplayed-member)|Gets whether optional hyphens are displayed.| -||[areOtherAuthorsVisible](/.view#word-javascript/api/word/-view-areotherauthorsvisible-member)|Gets whether other authors' presence should be visible in the document.| -||[arePageBoundariesDisplayed](/.view#word-javascript/api/word/-view-arepageboundariesdisplayed-member)|Gets whether the top and bottom margins and the gray area between pages in the document are displayed.| -||[areParagraphsMarksDisplayed](/.view#word-javascript/api/word/-view-areparagraphsmarksdisplayed-member)|Gets whether paragraph marks are displayed.| -||[arePicturePlaceholdersDisplayed](/.view#word-javascript/api/word/-view-arepictureplaceholdersdisplayed-member)|Gets whether blank boxes are displayed as placeholders for pictures.| -||[areRevisionsAndCommentsDisplayed](/.view#word-javascript/api/word/-view-arerevisionsandcommentsdisplayed-member)|Specifies whether Microsoft Word displays revisions and comments made to the document with Track Changes enabled.| -||[areSpacesIndicated](/.view#word-javascript/api/word/-view-arespacesindicated-member)|Gets whether space characters are displayed.| -||[areTableGridlinesDisplayed](/.view#word-javascript/api/word/-view-aretablegridlinesdisplayed-member)|Specifies whether table gridlines are displayed.| -||[areTabsDisplayed](/.view#word-javascript/api/word/-view-aretabsdisplayed-member)|Gets whether tab characters are displayed.| -||[areTextBoundariesDisplayed](/.view#word-javascript/api/word/-view-aretextboundariesdisplayed-member)|Gets whether dotted lines are displayed around page margins, text columns, objects, and frames in print layout view.| -||[collapseAllHeadings()](/.view#word-javascript/api/word/-view-collapseallheadings-member(1))|Collapses all the headings in the document.| -||[collapseOutline(range: Word.Range)](/.view#word-javascript/api/word/-view-collapseoutline-member(1))|Collapses the text under the selection or the specified range by one heading level.| -||[columnWidth](/.view#word-javascript/api/word/-view-columnwidth-member)|Specifies the column width in Reading mode.| -||[expandAllHeadings()](/.view#word-javascript/api/word/-view-expandallheadings-member(1))|Expands all the headings in the document.| -||[expandOutline(range: Word.Range)](/.view#word-javascript/api/word/-view-expandoutline-member(1))|Expands the text under the selection by one heading level.| -||[fieldShading](/.view#word-javascript/api/word/-view-fieldshading-member)|Gets on-screen shading for fields.| -||[isDraft](/.view#word-javascript/api/word/-view-isdraft-member)|Specifies whether all the text in a window is displayed in the same sans-serif font with minimal formatting to speed up display.| -||[isFirstLineOnlyDisplayed](/.view#word-javascript/api/word/-view-isfirstlineonlydisplayed-member)|Specifies whether only the first line of body text is shown in outline view.| -||[isFormatDisplayed](/.view#word-javascript/api/word/-view-isformatdisplayed-member)|Specifies whether character formatting is visible in outline view.| -||[isFullScreen](/.view#word-javascript/api/word/-view-isfullscreen-member)|Specifies whether the window is in full-screen view.| -||[isHiddenTextDisplayed](/.view#word-javascript/api/word/-view-ishiddentextdisplayed-member)|Gets whether text formatted as hidden text is displayed.| -||[isHighlightingDisplayed](/.view#word-javascript/api/word/-view-ishighlightingdisplayed-member)|Gets whether highlight formatting is displayed and printed with the document.| -||[isInConflictMode](/.view#word-javascript/api/word/-view-isinconflictmode-member)|Specifies whether the document is in conflict mode view.| -||[isInPanning](/.view#word-javascript/api/word/-view-isinpanning-member)|Specifies whether Microsoft Word is in Panning mode.| -||[isInReadingLayout](/.view#word-javascript/api/word/-view-isinreadinglayout-member)|Specifies whether the document is being viewed in reading layout view.| -||[isMailMergeDataView](/.view#word-javascript/api/word/-view-ismailmergedataview-member)|Specifies whether mail merge data is displayed instead of mail merge fields.| -||[isMainTextLayerVisible](/.view#word-javascript/api/word/-view-ismaintextlayervisible-member)|Specifies whether the text in the document is visible when the header and footer areas are displayed.| -||[isPointerShownAsMagnifier](/.view#word-javascript/api/word/-view-ispointershownasmagnifier-member)|Specifies whether the pointer is displayed as a magnifying glass in print preview.| -||[isReadingLayoutActualView](/.view#word-javascript/api/word/-view-isreadinglayoutactualview-member)|Specifies whether pages displayed in reading layout view are displayed using the same layout as printed pages.| -||[isXmlMarkupVisible](/.view#word-javascript/api/word/-view-isxmlmarkupvisible-member)|Specifies whether XML tags are visible in the document.| -||[markupMode](/.view#word-javascript/api/word/-view-markupmode-member)|Specifies the display mode for tracked changes.| -||[nextHeaderFooter()](/.view#word-javascript/api/word/-view-nextheaderfooter-member(1))|Moves to the next header or footer, depending on whether a header or footer is displayed in the view.| -||[pageColor](/.view#word-javascript/api/word/-view-pagecolor-member)|Specifies the page color in Reading mode.| -||[pageMovementType](/.view#word-javascript/api/word/-view-pagemovementtype-member)|Specifies the page movement type.| -||[previousHeaderFooter()](/.view#word-javascript/api/word/-view-previousheaderfooter-member(1))|Moves to the previous header or footer, depending on whether a header or footer is displayed in the view.| -||[readingLayoutTruncateMargins](/.view#word-javascript/api/word/-view-readinglayouttruncatemargins-member)|Specifies whether margins are visible or hidden when the document is viewed in Full Screen Reading view.| -||[revisionsBalloonSide](/.view#word-javascript/api/word/-view-revisionsballoonside-member)|Gets whether Word displays revision balloons in the left or right margin in the document.| -||[revisionsBalloonWidth](/.view#word-javascript/api/word/-view-revisionsballoonwidth-member)|Specifies the width of the revision balloons.| -||[revisionsBalloonWidthType](/.view#word-javascript/api/word/-view-revisionsballoonwidthtype-member)|Specifies how Microsoft Word measures the width of revision balloons.| -||[revisionsFilter](/.view#word-javascript/api/word/-view-revisionsfilter-member)|Gets the instance of a `RevisionsFilter` object.| -||[seekView](/.view#word-javascript/api/word/-view-seekview-member)|Specifies the document element displayed in print layout view.| -||[showAllHeadings()](/.view#word-javascript/api/word/-view-showallheadings-member(1))|Switches between showing all text (headings and body text) and showing only headings.| -||[showHeading(level: number)](/.view#word-javascript/api/word/-view-showheading-member(1))|Shows all headings up to the specified heading level and hides subordinate headings and body text.| -||[splitSpecial](/.view#word-javascript/api/word/-view-splitspecial-member)|Specifies the active window pane.| -||[type](/.view#word-javascript/api/word/-view-type-member)|Specifies the view type.| -|[Window](/.window)|[activate()](/.window#word-javascript/api/word/-window-activate-member(1))|Activates the window.| -||[areRulersDisplayed](/.window#word-javascript/api/word/-window-arerulersdisplayed-member)|Specifies whether rulers are displayed for the window or pane.| -||[areScreenTipsDisplayed](/.window#word-javascript/api/word/-window-arescreentipsdisplayed-member)|Specifies whether comments, footnotes, endnotes, and hyperlinks are displayed as tips.| -||[areThumbnailsDisplayed](/.window#word-javascript/api/word/-window-arethumbnailsdisplayed-member)|Specifies whether thumbnail images of the pages in a document are displayed along the left side of the Microsoft Word document window.| -||[caption](/.window#word-javascript/api/word/-window-caption-member)|Specifies the caption text for the window that is displayed in the title bar of the document or application window.| -||[close(options?: Word.WindowCloseOptions)](/.window#word-javascript/api/word/-window-close-member(1))|Closes the window.| -||[height](/.window#word-javascript/api/word/-window-height-member)|Specifies the height of the window (in points).| -||[horizontalPercentScrolled](/.window#word-javascript/api/word/-window-horizontalpercentscrolled-member)|Specifies the horizontal scroll position as a percentage of the document width.| -||[imemode](/.window#word-javascript/api/word/-window-imemode-member)|Specifies the default start-up mode for the Japanese Input Method Editor (IME).| -||[index](/.window#word-javascript/api/word/-window-index-member)|Gets the position of an item in a collection.| -||[isActive](/.window#word-javascript/api/word/-window-isactive-member)|Specifies whether the window is active.| -||[isDocumentMapVisible](/.window#word-javascript/api/word/-window-isdocumentmapvisible-member)|Specifies whether the document map is visible.| -||[isEnvelopeVisible](/.window#word-javascript/api/word/-window-isenvelopevisible-member)|Specifies whether the email message header is visible in the document window.| -||[isHorizontalScrollBarDisplayed](/.window#word-javascript/api/word/-window-ishorizontalscrollbardisplayed-member)|Specifies whether a horizontal scroll bar is displayed for the window.| -||[isLeftScrollBarDisplayed](/.window#word-javascript/api/word/-window-isleftscrollbardisplayed-member)|Specifies whether the vertical scroll bar appears on the left side of the document window.| -||[isRightRulerDisplayed](/.window#word-javascript/api/word/-window-isrightrulerdisplayed-member)|Specifies whether the vertical ruler appears on the right side of the document window in print layout view.| -||[isSplit](/.window#word-javascript/api/word/-window-issplit-member)|Specifies whether the window is split into multiple panes.| -||[isVerticalRulerDisplayed](/.window#word-javascript/api/word/-window-isverticalrulerdisplayed-member)|Specifies whether a vertical ruler is displayed for the window or pane.| -||[isVerticalScrollBarDisplayed](/.window#word-javascript/api/word/-window-isverticalscrollbardisplayed-member)|Specifies whether a vertical scroll bar is displayed for the window.| -||[isVisible](/.window#word-javascript/api/word/-window-isvisible-member)|Specifies whether the window is visible.| -||[largeScroll(options?: Word.WindowScrollOptions)](/.window#word-javascript/api/word/-window-largescroll-member(1))|Scrolls the window by the specified number of screens.| -||[left](/.window#word-javascript/api/word/-window-left-member)|Specifies the horizontal position of the window, measured in points.| -||[next](/.window#word-javascript/api/word/-window-next-member)|Gets the next document window in the collection of open document windows.| -||[pageScroll(options?: Word.WindowPageScrollOptions)](/.window#word-javascript/api/word/-window-pagescroll-member(1))|Scrolls through the window page by page.| -||[previous](/.window#word-javascript/api/word/-window-previous-member)|Gets the previous document window in the collection open document windows.| -||[setFocus()](/.window#word-javascript/api/word/-window-setfocus-member(1))|Sets the focus of the document window to the body of an email message.| -||[showSourceDocuments](/.window#word-javascript/api/word/-window-showsourcedocuments-member)|Specifies how Microsoft Word displays source documents after a compare and merge process.| -||[smallScroll(options?: Word.WindowScrollOptions)](/.window#word-javascript/api/word/-window-smallscroll-member(1))|Scrolls the window by the specified number of lines.| -||[splitVertical](/.window#word-javascript/api/word/-window-splitvertical-member)|Specifies the vertical split percentage for the window.| -||[styleAreaWidth](/.window#word-javascript/api/word/-window-styleareawidth-member)|Specifies the width of the style area in points.| -||[toggleRibbon()](/.window#word-javascript/api/word/-window-toggleribbon-member(1))|Shows or hides the ribbon.| -||[top](/.window#word-javascript/api/word/-window-top-member)|Specifies the vertical position of the document window, in points.| -||[type](/.window#word-javascript/api/word/-window-type-member)|Gets the window type.| -||[usableHeight](/.window#word-javascript/api/word/-window-usableheight-member)|Gets the height (in points) of the active working area in the document window.| -||[usableWidth](/.window#word-javascript/api/word/-window-usablewidth-member)|Gets the width (in points) of the active working area in the document window.| -||[verticalPercentScrolled](/.window#word-javascript/api/word/-window-verticalpercentscrolled-member)|Specifies the vertical scroll position as a percentage of the document length.| -||[view](/.window#word-javascript/api/word/-window-view-member)|Gets the `View` object that represents the view for the window.| -||[width](/.window#word-javascript/api/word/-window-width-member)|Specifies the width of the document window, in points.| -||[windowNumber](/.window#word-javascript/api/word/-window-windownumber-member)|Gets an integer that represents the position of the window.| -||[windowState](/.window#word-javascript/api/word/-window-windowstate-member)|Specifies the state of the document window or task window.| -|[WindowCloseOptions](/.windowcloseoptions)|[routeDocument](/.windowcloseoptions#word-javascript/api/word/-windowcloseoptions-routedocument-member)|If provided, specifies whether to route the document to the next recipient.| -||[saveChanges](/.windowcloseoptions#word-javascript/api/word/-windowcloseoptions-savechanges-member)|If provided, specifies the save action for the document.| -|[WindowCollection](/.windowcollection)||| -|[WindowPageScrollOptions](/.windowpagescrolloptions)|[down](/.windowpagescrolloptions#word-javascript/api/word/-windowpagescrolloptions-down-member)|If provided, specifies the number of pages to scroll the window down.| -||[up](/.windowpagescrolloptions#word-javascript/api/word/-windowpagescrolloptions-up-member)|If provided, specifies the number of pages to scroll the window up.| -|[WindowScrollOptions](/.windowscrolloptions)|[down](/.windowscrolloptions#word-javascript/api/word/-windowscrolloptions-down-member)|If provided, specifies the number of units to scroll the window down.| -||[left](/.windowscrolloptions#word-javascript/api/word/-windowscrolloptions-left-member)|If provided, specifies the number of screens to scroll the window to the left.| -||[right](/.windowscrolloptions#word-javascript/api/word/-windowscrolloptions-right-member)|If provided, specifies the number of screens to scroll the window to the right.| -||[up](/.windowscrolloptions#word-javascript/api/word/-windowscrolloptions-up-member)|If provided, specifies the number of units to scroll the window up.| -|[XmlMapping](/.xmlmapping)|[customXmlNode](/.xmlmapping#word-javascript/api/word/-xmlmapping-customxmlnode-member)|Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to.| -||[customXmlPart](/.xmlmapping#word-javascript/api/word/-xmlmapping-customxmlpart-member)|Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps.| -||[delete()](/.xmlmapping#word-javascript/api/word/-xmlmapping-delete-member(1))|Deletes the XML mapping from the parent content control.| -||[isMapped](/.xmlmapping#word-javascript/api/word/-xmlmapping-ismapped-member)|Returns whether the content control in the document is mapped to an XML node in the document's XML data store.| -||[prefixMappings](/.xmlmapping#word-javascript/api/word/-xmlmapping-prefixmappings-member)|Returns the prefix mappings used to evaluate the XPath for the current XML mapping.| -||[setMapping(xPath: string, options?: Word.XmlSetMappingOptions)](/.xmlmapping#word-javascript/api/word/-xmlmapping-setmapping-member(1))|Allows creating or changing the XML mapping on the content control.| -||[setMappingByNode(node: Word.CustomXmlNode)](/.xmlmapping#word-javascript/api/word/-xmlmapping-setmappingbynode-member(1))|Allows creating or changing the XML data mapping on the content control.| -||[xpath](/.xmlmapping#word-javascript/api/word/-xmlmapping-xpath-member)|Returns the XPath for the XML mapping, which evaluates to the currently mapped XML node.| -|[XmlSetMappingOptions](/.xmlsetmappingoptions)|[prefixMapping](/.xmlsetmappingoptions#word-javascript/api/word/-xmlsetmappingoptions-prefixmapping-member)|If provided, specifies the prefix mappings to use when querying the expression provided in the `xPath` parameter of the `XmlMapping.setMapping` calling method.| -||[source](/.xmlsetmappingoptions#word-javascript/api/word/-xmlsetmappingoptions-source-member)|If provided, specifies the desired custom XML data to map the content control to.| +|[Application](/javascript/api/word/word.application)|[bibliography](/javascript/api/word/word.application#word-word-application-bibliography-member)|Returns a `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word.| +||[checkLanguage](/javascript/api/word/word.application#word-word-application-checklanguage-member)|Specifies if Microsoft Word automatically detects the language you are using as you type.| +||[fontNames](/javascript/api/word/word.application#word-word-application-fontnames-member)|Returns a `FontNameCollection` object that represents all the available font names in Microsoft Word.| +||[language](/javascript/api/word/word.application#word-word-application-language-member)|Gets a `LanguageId` value that represents the language selected for the Microsoft Word user interface.| +||[listTemplateGalleries](/javascript/api/word/word.application#word-word-application-listtemplategalleries-member)|Returns a `ListTemplateGalleryCollection` object that represents all the list template galleries in Microsoft Word.| +||[templates](/javascript/api/word/word.application#word-word-application-templates-member)|Returns a `TemplateCollection` object that represents all the available templates: global templates and those attached to open documents.| +|[Bibliography](/javascript/api/word/word.bibliography)|[bibliographyStyle](/javascript/api/word/word.bibliography#word-word-bibliography-bibliographystyle-member)|Specifies the name of the active style to use for the bibliography.| +||[generateUniqueTag()](/javascript/api/word/word.bibliography#word-word-bibliography-generateuniquetag-member(1))|Generates a unique identification tag for a bibliography source and returns a string that represents the tag.| +||[sources](/javascript/api/word/word.bibliography#word-word-bibliography-sources-member)|Returns a `SourceCollection` object that represents all the sources contained in the bibliography.| +|[Body](/javascript/api/word/word.body)|[onCommentAdded](/javascript/api/word/word.body#word-word-body-oncommentadded-member)|Occurs when new comments are added.| +||[onCommentChanged](/javascript/api/word/word.body#word-word-body-oncommentchanged-member)|Occurs when a comment or its reply is changed.| +||[onCommentDeleted](/javascript/api/word/word.body#word-word-body-oncommentdeleted-member)|Occurs when comments are deleted.| +||[onCommentDeselected](/javascript/api/word/word.body#word-word-body-oncommentdeselected-member)|Occurs when a comment is deselected.| +||[onCommentSelected](/javascript/api/word/word.body#word-word-body-oncommentselected-member)|Occurs when a comment is selected.| +||[type](/javascript/api/word/word.body#word-word-body-type-member)|Gets the type of the body.| +|[Bookmark](/javascript/api/word/word.bookmark)|[copyTo(name: string)](/javascript/api/word/word.bookmark#word-word-bookmark-copyto-member(1))|Copies this bookmark to the new bookmark specified in the `name` argument and returns a `Bookmark` object.| +||[delete()](/javascript/api/word/word.bookmark#word-word-bookmark-delete-member(1))|Deletes the bookmark.| +||[end](/javascript/api/word/word.bookmark#word-word-bookmark-end-member)|Specifies the ending character position of the bookmark.| +||[isColumn](/javascript/api/word/word.bookmark#word-word-bookmark-iscolumn-member)|Returns `true` if the bookmark is a table column.| +||[isEmpty](/javascript/api/word/word.bookmark#word-word-bookmark-isempty-member)|Returns `true` if the bookmark is empty.| +||[name](/javascript/api/word/word.bookmark#word-word-bookmark-name-member)|Returns the name of the `Bookmark` object.| +||[range](/javascript/api/word/word.bookmark#word-word-bookmark-range-member)|Returns a `Range` object that represents the portion of the document that's contained in the `Bookmark` object.| +||[select()](/javascript/api/word/word.bookmark#word-word-bookmark-select-member(1))|Selects the bookmark.| +||[start](/javascript/api/word/word.bookmark#word-word-bookmark-start-member)|Specifies the starting character position of the bookmark.| +||[storyType](/javascript/api/word/word.bookmark#word-word-bookmark-storytype-member)|Returns the story type for the bookmark.| +|[BookmarkCollection](/javascript/api/word/word.bookmarkcollection)|[exists(name: string)](/javascript/api/word/word.bookmarkcollection#word-word-bookmarkcollection-exists-member(1))|Determines whether the specified bookmark exists.| +||[getItem(index: number)](/javascript/api/word/word.bookmarkcollection#word-word-bookmarkcollection-getitem-member(1))|Gets a `Bookmark` object by its index in the collection.| +||[items](/javascript/api/word/word.bookmarkcollection#word-word-bookmarkcollection-items-member)|Gets the loaded child items in this collection.| +|[BorderUniversal](/javascript/api/word/word.borderuniversal)|[artStyle](/javascript/api/word/word.borderuniversal#word-word-borderuniversal-artstyle-member)|Specifies the graphical page-border design for the document.| +||[artWidth](/javascript/api/word/word.borderuniversal#word-word-borderuniversal-artwidth-member)|Specifies the width (in points) of the graphical page border specified in the `artStyle` property.| +||[color](/javascript/api/word/word.borderuniversal#word-word-borderuniversal-color-member)|Specifies the color for the `BorderUniversal` object.| +||[colorIndex](/javascript/api/word/word.borderuniversal#word-word-borderuniversal-colorindex-member)|Specifies the color for the `BorderUniversal` or Word.Font object.| +||[inside](/javascript/api/word/word.borderuniversal#word-word-borderuniversal-inside-member)|Returns `true` if an inside border can be applied to the specified object.| +||[isVisible](/javascript/api/word/word.borderuniversal#word-word-borderuniversal-isvisible-member)|Specifies whether the border is visible.| +||[lineStyle](/javascript/api/word/word.borderuniversal#word-word-borderuniversal-linestyle-member)|Specifies the line style of the border.| +||[lineWidth](/javascript/api/word/word.borderuniversal#word-word-borderuniversal-linewidth-member)|Specifies the line width of an object's border.| +|[BorderUniversalCollection](/javascript/api/word/word.borderuniversalcollection)|[applyPageBordersToAllSections()](/javascript/api/word/word.borderuniversalcollection#word-word-borderuniversalcollection-applypageborderstoallsections-member(1))|Applies the specified page-border formatting to all sections in the document.| +||[getItem(index: number)](/javascript/api/word/word.borderuniversalcollection#word-word-borderuniversalcollection-getitem-member(1))|Gets a `Border` object by its index in the collection.| +||[items](/javascript/api/word/word.borderuniversalcollection#word-word-borderuniversalcollection-items-member)|Gets the loaded child items in this collection.| +|[Break](/javascript/api/word/word.break)|[pageIndex](/javascript/api/word/word.break#word-word-break-pageindex-member)|Returns the page number on which the break occurs.| +||[range](/javascript/api/word/word.break#word-word-break-range-member)|Returns a `Range` object that represents the portion of the document that's contained in the break.| +|[BreakCollection](/javascript/api/word/word.breakcollection)|[items](/javascript/api/word/word.breakcollection#word-word-breakcollection-items-member)|Gets the loaded child items in this collection.| +|[BuildingBlock](/javascript/api/word/word.buildingblock)|[category](/javascript/api/word/word.buildingblock#word-word-buildingblock-category-member)|Returns a `BuildingBlockCategory` object that represents the category for the building block.| +||[delete()](/javascript/api/word/word.buildingblock#word-word-buildingblock-delete-member(1))|Deletes the building block.| +||[description](/javascript/api/word/word.buildingblock#word-word-buildingblock-description-member)|Specifies the description for the building block.| +||[id](/javascript/api/word/word.buildingblock#word-word-buildingblock-id-member)|Returns the internal identification number for the building block.| +||[index](/javascript/api/word/word.buildingblock#word-word-buildingblock-index-member)|Returns the position of this building block in a collection.| +||[insert(range: Word.Range, richText: boolean)](/javascript/api/word/word.buildingblock#word-word-buildingblock-insert-member(1))|Inserts the value of the building block into the document and returns a `Range` object that represents the contents of the building block within the document.| +||[insertType](/javascript/api/word/word.buildingblock#word-word-buildingblock-inserttype-member)|Specifies a `DocPartInsertType` value that represents how to insert the contents of the building block into the document.| +||[name](/javascript/api/word/word.buildingblock#word-word-buildingblock-name-member)|Specifies the name of the building block.| +||[type](/javascript/api/word/word.buildingblock#word-word-buildingblock-type-member)|Returns a `BuildingBlockTypeItem` object that represents the type for the building block.| +||[value](/javascript/api/word/word.buildingblock#word-word-buildingblock-value-member)|Specifies the contents of the building block.| +|[BuildingBlockCategory](/javascript/api/word/word.buildingblockcategory)|[buildingBlocks](/javascript/api/word/word.buildingblockcategory#word-word-buildingblockcategory-buildingblocks-member)|Returns a `BuildingBlockCollection` object that represents the building blocks for the category.| +||[index](/javascript/api/word/word.buildingblockcategory#word-word-buildingblockcategory-index-member)|Returns the position of the `BuildingBlockCategory` object in a collection.| +||[name](/javascript/api/word/word.buildingblockcategory#word-word-buildingblockcategory-name-member)|Returns the name of the `BuildingBlockCategory` object.| +||[type](/javascript/api/word/word.buildingblockcategory#word-word-buildingblockcategory-type-member)|Returns a `BuildingBlockTypeItem` object that represents the type of building block for the building block category.| +|[BuildingBlockCategoryCollection](/javascript/api/word/word.buildingblockcategorycollection)|[getCount()](/javascript/api/word/word.buildingblockcategorycollection#word-word-buildingblockcategorycollection-getcount-member(1))|Returns the number of items in the collection.| +||[getItemAt(index: number)](/javascript/api/word/word.buildingblockcategorycollection#word-word-buildingblockcategorycollection-getitemat-member(1))|Returns a `BuildingBlockCategory` object that represents the specified item in the collection.| +|[BuildingBlockCollection](/javascript/api/word/word.buildingblockcollection)|[add(name: string, range: Word.Range, description: string, insertType: Word.DocPartInsertType)](/javascript/api/word/word.buildingblockcollection#word-word-buildingblockcollection-add-member(1))|Creates a new building block and returns a `BuildingBlock` object.| +||[getCount()](/javascript/api/word/word.buildingblockcollection#word-word-buildingblockcollection-getcount-member(1))|Returns the number of items in the collection.| +||[getItemAt(index: number)](/javascript/api/word/word.buildingblockcollection#word-word-buildingblockcollection-getitemat-member(1))|Returns a `BuildingBlock` object that represents the specified item in the collection.| +|[BuildingBlockEntryCollection](/javascript/api/word/word.buildingblockentrycollection)|[add(name: string, type: Word.BuildingBlockType, category: string, range: Word.Range, description: string, insertType: Word.DocPartInsertType)](/javascript/api/word/word.buildingblockentrycollection#word-word-buildingblockentrycollection-add-member(1))|Creates a new building block entry in a template and returns a `BuildingBlock` object that represents the new building block entry.| +||[getCount()](/javascript/api/word/word.buildingblockentrycollection#word-word-buildingblockentrycollection-getcount-member(1))|Returns the number of items in the collection.| +||[getItemAt(index: number)](/javascript/api/word/word.buildingblockentrycollection#word-word-buildingblockentrycollection-getitemat-member(1))|Returns a `BuildingBlock` object that represents the specified item in the collection.| +|[BuildingBlockGalleryContentControl](/javascript/api/word/word.buildingblockgallerycontentcontrol)|[appearance](/javascript/api/word/word.buildingblockgallerycontentcontrol#word-word-buildingblockgallerycontentcontrol-appearance-member)|Specifies the appearance of the content control.| +||[buildingBlockCategory](/javascript/api/word/word.buildingblockgallerycontentcontrol#word-word-buildingblockgallerycontentcontrol-buildingblockcategory-member)|Specifies the category for the building block content control.| +||[buildingBlockType](/javascript/api/word/word.buildingblockgallerycontentcontrol#word-word-buildingblockgallerycontentcontrol-buildingblocktype-member)|Specifies a `BuildingBlockType` value that represents the type of building block for the building block content control.| +||[color](/javascript/api/word/word.buildingblockgallerycontentcontrol#word-word-buildingblockgallerycontentcontrol-color-member)|Specifies the red-green-blue (RGB) value of the color of the content control.| +||[copy()](/javascript/api/word/word.buildingblockgallerycontentcontrol#word-word-buildingblockgallerycontentcontrol-copy-member(1))|Copies the content control from the active document to the Clipboard.| +||[cut()](/javascript/api/word/word.buildingblockgallerycontentcontrol#word-word-buildingblockgallerycontentcontrol-cut-member(1))|Removes the content control from the active document and moves the content control to the Clipboard.| +||[delete(deleteContents?: boolean)](/javascript/api/word/word.buildingblockgallerycontentcontrol#word-word-buildingblockgallerycontentcontrol-delete-member(1))|Deletes the content control and optionally its contents.| +||[id](/javascript/api/word/word.buildingblockgallerycontentcontrol#word-word-buildingblockgallerycontentcontrol-id-member)|Gets the identification for the content control.| +||[isTemporary](/javascript/api/word/word.buildingblockgallerycontentcontrol#word-word-buildingblockgallerycontentcontrol-istemporary-member)|Specifies whether to remove the content control from the active document when the user edits the contents of the control.| +||[level](/javascript/api/word/word.buildingblockgallerycontentcontrol#word-word-buildingblockgallerycontentcontrol-level-member)|Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline.| +||[lockContentControl](/javascript/api/word/word.buildingblockgallerycontentcontrol#word-word-buildingblockgallerycontentcontrol-lockcontentcontrol-member)|Specifies if the content control is locked (can't be deleted).| +||[lockContents](/javascript/api/word/word.buildingblockgallerycontentcontrol#word-word-buildingblockgallerycontentcontrol-lockcontents-member)|Specifies if the contents of the content control are locked (not editable).| +||[placeholderText](/javascript/api/word/word.buildingblockgallerycontentcontrol#word-word-buildingblockgallerycontentcontrol-placeholdertext-member)|Returns a `BuildingBlock` object that represents the placeholder text for the content control.| +||[range](/javascript/api/word/word.buildingblockgallerycontentcontrol#word-word-buildingblockgallerycontentcontrol-range-member)|Returns a `Range` object that represents the contents of the content control in the active document.| +||[setPlaceholderText(options?: Word.ContentControlPlaceholderOptions)](/javascript/api/word/word.buildingblockgallerycontentcontrol#word-word-buildingblockgallerycontentcontrol-setplaceholdertext-member(1))|Sets the placeholder text that displays in the content control until a user enters their own text.| +||[showingPlaceholderText](/javascript/api/word/word.buildingblockgallerycontentcontrol#word-word-buildingblockgallerycontentcontrol-showingplaceholdertext-member)|Gets if the placeholder text for the content control is being displayed.| +||[tag](/javascript/api/word/word.buildingblockgallerycontentcontrol#word-word-buildingblockgallerycontentcontrol-tag-member)|Specifies a tag to identify the content control.| +||[title](/javascript/api/word/word.buildingblockgallerycontentcontrol#word-word-buildingblockgallerycontentcontrol-title-member)|Specifies the title for the content control.| +||[xmlMapping](/javascript/api/word/word.buildingblockgallerycontentcontrol#word-word-buildingblockgallerycontentcontrol-xmlmapping-member)|Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document.| +|[BuildingBlockTypeItem](/javascript/api/word/word.buildingblocktypeitem)|[categories](/javascript/api/word/word.buildingblocktypeitem#word-word-buildingblocktypeitem-categories-member)|Returns a `BuildingBlockCategoryCollection` object that represents the categories for a building block type.| +||[index](/javascript/api/word/word.buildingblocktypeitem#word-word-buildingblocktypeitem-index-member)|Returns the position of an item in a collection.| +||[name](/javascript/api/word/word.buildingblocktypeitem#word-word-buildingblocktypeitem-name-member)|Returns the localized name of a building block type.| +|[BuildingBlockTypeItemCollection](/javascript/api/word/word.buildingblocktypeitemcollection)|[getByType(type: Word.BuildingBlockType)](/javascript/api/word/word.buildingblocktypeitemcollection#word-word-buildingblocktypeitemcollection-getbytype-member(1))|Gets a `BuildingBlockTypeItem` object by its type in the collection.| +||[getCount()](/javascript/api/word/word.buildingblocktypeitemcollection#word-word-buildingblocktypeitemcollection-getcount-member(1))|Returns the number of items in the collection.| +|[Coauthor](/javascript/api/word/word.coauthor)|[emailAddress](/javascript/api/word/word.coauthor#word-word-coauthor-emailaddress-member)|Gets the email address of the coauthor.| +||[id](/javascript/api/word/word.coauthor#word-word-coauthor-id-member)|Gets the unique identifier for the `Coauthor` object.| +||[isMe](/javascript/api/word/word.coauthor#word-word-coauthor-isme-member)|Gets whether this author represents the current user.| +||[locks](/javascript/api/word/word.coauthor#word-word-coauthor-locks-member)|Gets a `CoauthoringLockCollection` object that represents the locks in the document that are associated with this coauthor.| +||[name](/javascript/api/word/word.coauthor#word-word-coauthor-name-member)|Gets the display name of the coauthor.| +|[CoauthorCollection](/javascript/api/word/word.coauthorcollection)|[items](/javascript/api/word/word.coauthorcollection#word-word-coauthorcollection-items-member)|Gets the loaded child items in this collection.| +|[Coauthoring](/javascript/api/word/word.coauthoring)|[authors](/javascript/api/word/word.coauthoring#word-word-coauthoring-authors-member)|Gets a `CoauthorCollection` object that represents all the coauthors currently editing the document.| +||[canCoauthor](/javascript/api/word/word.coauthoring#word-word-coauthoring-cancoauthor-member)|Gets whether this document can be coauthored.| +||[canMerge](/javascript/api/word/word.coauthoring#word-word-coauthoring-canmerge-member)|Gets whether the document can be automatically merged.| +||[conflicts](/javascript/api/word/word.coauthoring#word-word-coauthoring-conflicts-member)|Gets a `ConflictCollection` object that represents all the conflicts in the document.| +||[locks](/javascript/api/word/word.coauthoring#word-word-coauthoring-locks-member)|Gets a `CoauthoringLockCollection` object that represents the locks in the document.| +||[me](/javascript/api/word/word.coauthoring#word-word-coauthoring-me-member)|Gets a `Coauthor` object that represents the current user.| +||[pendingUpdates](/javascript/api/word/word.coauthoring#word-word-coauthoring-pendingupdates-member)|Gets whether the document has pending updates that have not been accepted.| +||[updates](/javascript/api/word/word.coauthoring#word-word-coauthoring-updates-member)|Gets a `CoauthoringUpdateCollection` object that represents the most recent updates that were merged into the document.| +|[CoauthoringLock](/javascript/api/word/word.coauthoringlock)|[owner](/javascript/api/word/word.coauthoringlock#word-word-coauthoringlock-owner-member)|Gets the owner of the lock.| +||[range](/javascript/api/word/word.coauthoringlock#word-word-coauthoringlock-range-member)|Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringLock` object.| +||[type](/javascript/api/word/word.coauthoringlock#word-word-coauthoringlock-type-member)|Gets a `CoauthoringLockType` value that represents the lock type.| +||[unlock()](/javascript/api/word/word.coauthoringlock#word-word-coauthoringlock-unlock-member(1))|Removes this lock, even if it belongs to a different user.| +|[CoauthoringLockAddOptions](/javascript/api/word/word.coauthoringlockaddoptions)|[range](/javascript/api/word/word.coauthoringlockaddoptions#word-word-coauthoringlockaddoptions-range-member)|If provided, specifies the range to which the lock is added.| +||[type](/javascript/api/word/word.coauthoringlockaddoptions#word-word-coauthoringlockaddoptions-type-member)|If provided, specifies the type of lock.| +|[CoauthoringLockCollection](/javascript/api/word/word.coauthoringlockcollection)|[add(options?: Word.CoauthoringLockAddOptions)](/javascript/api/word/word.coauthoringlockcollection#word-word-coauthoringlockcollection-add-member(1))|Returns a `CoauthoringLock` object that represents a lock added to a specified range.| +||[items](/javascript/api/word/word.coauthoringlockcollection#word-word-coauthoringlockcollection-items-member)|Gets the loaded child items in this collection.| +||[unlockEphemeralLocks()](/javascript/api/word/word.coauthoringlockcollection#word-word-coauthoringlockcollection-unlockephemerallocks-member(1))|Removes all ephemeral locks from the document.| +|[CoauthoringUpdate](/javascript/api/word/word.coauthoringupdate)|[range](/javascript/api/word/word.coauthoringupdate#word-word-coauthoringupdate-range-member)|Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringUpdate` object.| +|[CoauthoringUpdateCollection](/javascript/api/word/word.coauthoringupdatecollection)|[items](/javascript/api/word/word.coauthoringupdatecollection#word-word-coauthoringupdatecollection-items-member)|Gets the loaded child items in this collection.| +|[ColorFormat](/javascript/api/word/word.colorformat)|[brightness](/javascript/api/word/word.colorformat#word-word-colorformat-brightness-member)|Specifies the brightness of a specified shape color.| +||[objectThemeColor](/javascript/api/word/word.colorformat#word-word-colorformat-objectthemecolor-member)|Specifies the theme color for a color format.| +||[rgb](/javascript/api/word/word.colorformat#word-word-colorformat-rgb-member)|Specifies the red-green-blue (RGB) value of the specified color.| +||[tintAndShade](/javascript/api/word/word.colorformat#word-word-colorformat-tintandshade-member)|Specifies the lightening or darkening of a specified shape's color.| +||[type](/javascript/api/word/word.colorformat#word-word-colorformat-type-member)|Returns the shape color type.| +|[CommentDetail](/javascript/api/word/word.commentdetail)|[id](/javascript/api/word/word.commentdetail#word-word-commentdetail-id-member)|Represents the ID of this comment.| +||[replyIds](/javascript/api/word/word.commentdetail#word-word-commentdetail-replyids-member)|Represents the IDs of the replies to this comment.| +|[CommentEventArgs](/javascript/api/word/word.commenteventargs)|[changeType](/javascript/api/word/word.commenteventargs#word-word-commenteventargs-changetype-member)|Represents how the comment changed event is triggered.| +||[commentDetails](/javascript/api/word/word.commenteventargs#word-word-commenteventargs-commentdetails-member)|Gets the CommentDetail array which contains the IDs and reply IDs of the involved comments.| +||[source](/javascript/api/word/word.commenteventargs#word-word-commenteventargs-source-member)|The source of the event.| +||[type](/javascript/api/word/word.commenteventargs#word-word-commenteventargs-type-member)|The event type.| +|[ConditionalStyle](/javascript/api/word/word.conditionalstyle)|[borders](/javascript/api/word/word.conditionalstyle#word-word-conditionalstyle-borders-member)|Returns a `BorderUniversalCollection` object that represents all the borders for the conditional style.| +||[bottomPadding](/javascript/api/word/word.conditionalstyle#word-word-conditionalstyle-bottompadding-member)|Specifies the amount of space (in points) to add below the contents of a single cell or all the cells in a table.| +||[font](/javascript/api/word/word.conditionalstyle#word-word-conditionalstyle-font-member)|Returns a `Font` object that represents the font formatting for the conditional style.| +||[leftPadding](/javascript/api/word/word.conditionalstyle#word-word-conditionalstyle-leftpadding-member)|Specifies the amount of space (in points) to add to the left of the contents of a single cell or all the cells in a table.| +||[paragraphFormat](/javascript/api/word/word.conditionalstyle#word-word-conditionalstyle-paragraphformat-member)|Returns a `ParagraphFormat` object that represents the paragraph formatting for the conditional style.| +||[rightPadding](/javascript/api/word/word.conditionalstyle#word-word-conditionalstyle-rightpadding-member)|Specifies the amount of space (in points) to add to the right of the contents of a single cell or all the cells in a table.| +||[shading](/javascript/api/word/word.conditionalstyle#word-word-conditionalstyle-shading-member)|Returns a `ShadingUniversal` object that represents the shading of the conditional style.| +||[topPadding](/javascript/api/word/word.conditionalstyle#word-word-conditionalstyle-toppadding-member)|Specifies the amount of space (in points) to add above the contents of a single cell or all the cells in a table.| +|[Conflict](/javascript/api/word/word.conflict)|[accept()](/javascript/api/word/word.conflict#word-word-conflict-accept-member(1))|Accepts the user's change and removes the conflict.| +||[range](/javascript/api/word/word.conflict#word-word-conflict-range-member)|Gets a `Range` object that represents the portion of the document that's contained in the `Conflict` object.| +||[reject()](/javascript/api/word/word.conflict#word-word-conflict-reject-member(1))|Rejects the user's change, removes the conflict, and accepts the server copy of the change for the conflict.| +||[type](/javascript/api/word/word.conflict#word-word-conflict-type-member)|Gets the `RevisionType` for the `Conflict` object.| +|[ConflictCollection](/javascript/api/word/word.conflictcollection)|[acceptAll()](/javascript/api/word/word.conflictcollection#word-word-conflictcollection-acceptall-member(1))|Accepts all of the user's changes, removes the conflicts, and merges the changes into the server copy of the document.| +||[getItem(index: number)](/javascript/api/word/word.conflictcollection#word-word-conflictcollection-getitem-member(1))|Gets a `Conflict` object by its index in the collection.| +||[items](/javascript/api/word/word.conflictcollection#word-word-conflictcollection-items-member)|Gets the loaded child items in this collection.| +||[rejectAll()](/javascript/api/word/word.conflictcollection#word-word-conflictcollection-rejectall-member(1))|Rejects all of the user's changes and retains the server copy of the document.| +|[ContentControl](/javascript/api/word/word.contentcontrol)|[buildingBlockGalleryContentControl](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-buildingblockgallerycontentcontrol-member)|Gets the building block gallery-related data if the content control's Word.ContentControlType is `BuildingBlockGallery`.| +||[datePickerContentControl](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-datepickercontentcontrol-member)|Gets the date picker-related data if the content control's Word.ContentControlType is `DatePicker`.| +||[groupContentControl](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-groupcontentcontrol-member)|Gets the group-related data if the content control's Word.ContentControlType is `Group`.| +||[onCommentAdded](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-oncommentadded-member)|Occurs when new comments are added.| +||[onCommentChanged](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-oncommentchanged-member)|Occurs when a comment or its reply is changed.| +||[onCommentDeselected](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-oncommentdeselected-member)|Occurs when a comment is deselected.| +||[onCommentSelected](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-oncommentselected-member)|Occurs when a comment is selected.| +||[pictureContentControl](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-picturecontentcontrol-member)|Gets the picture-related data if the content control's Word.ContentControlType is `Picture`.| +||[repeatingSectionContentControl](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-repeatingsectioncontentcontrol-member)|Gets the repeating section-related data if the content control's Word.ContentControlType is `RepeatingSection`.| +||[resetState()](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-resetstate-member(1))|Resets the state of the content control.| +||[setState(contentControlState: Word.ContentControlState)](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-setstate-member(1))|Sets the state of the content control.| +||[xmlMapping](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-xmlmapping-member)|Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document.| +|[ContentControlAddedEventArgs](/javascript/api/word/word.contentcontroladdedeventargs)|[eventType](/javascript/api/word/word.contentcontroladdedeventargs#word-word-contentcontroladdedeventargs-eventtype-member)|The event type.| +|[ContentControlDataChangedEventArgs](/javascript/api/word/word.contentcontroldatachangedeventargs)|[eventType](/javascript/api/word/word.contentcontroldatachangedeventargs#word-word-contentcontroldatachangedeventargs-eventtype-member)|The event type.| +|[ContentControlDeletedEventArgs](/javascript/api/word/word.contentcontroldeletedeventargs)|[eventType](/javascript/api/word/word.contentcontroldeletedeventargs#word-word-contentcontroldeletedeventargs-eventtype-member)|The event type.| +|[ContentControlEnteredEventArgs](/javascript/api/word/word.contentcontrolenteredeventargs)|[eventType](/javascript/api/word/word.contentcontrolenteredeventargs#word-word-contentcontrolenteredeventargs-eventtype-member)|The event type.| +|[ContentControlExitedEventArgs](/javascript/api/word/word.contentcontrolexitedeventargs)|[eventType](/javascript/api/word/word.contentcontrolexitedeventargs#word-word-contentcontrolexitedeventargs-eventtype-member)|The event type.| +|[ContentControlPlaceholderOptions](/javascript/api/word/word.contentcontrolplaceholderoptions)|[buildingBlock](/javascript/api/word/word.contentcontrolplaceholderoptions#word-word-contentcontrolplaceholderoptions-buildingblock-member)|If provided, specifies the `BuildingBlock` object to use as placeholder.| +||[range](/javascript/api/word/word.contentcontrolplaceholderoptions#word-word-contentcontrolplaceholderoptions-range-member)|If provided, specifies the `Range` object to use as placeholder.| +||[text](/javascript/api/word/word.contentcontrolplaceholderoptions#word-word-contentcontrolplaceholderoptions-text-member)|If provided, specifies the text to use as placeholder.| +|[ContentControlSelectionChangedEventArgs](/javascript/api/word/word.contentcontrolselectionchangedeventargs)|[eventType](/javascript/api/word/word.contentcontrolselectionchangedeventargs#word-word-contentcontrolselectionchangedeventargs-eventtype-member)|The event type.| +|[CustomXmlAddNodeOptions](/javascript/api/word/word.customxmladdnodeoptions)|[name](/javascript/api/word/word.customxmladdnodeoptions#word-word-customxmladdnodeoptions-name-member)|If provided, specifies the base name of the element to be added.| +||[namespaceUri](/javascript/api/word/word.customxmladdnodeoptions#word-word-customxmladdnodeoptions-namespaceuri-member)|If provided, specifies the namespace of the element to be appended.| +||[nextSibling](/javascript/api/word/word.customxmladdnodeoptions#word-word-customxmladdnodeoptions-nextsibling-member)|If provided, specifies the node which should become the next sibling of the new node.| +||[nodeType](/javascript/api/word/word.customxmladdnodeoptions#word-word-customxmladdnodeoptions-nodetype-member)|If provided, specifies the type of node to add.| +||[nodeValue](/javascript/api/word/word.customxmladdnodeoptions#word-word-customxmladdnodeoptions-nodevalue-member)|If provided, specifies the value of the added node for those nodes that allow text.| +|[CustomXmlAddSchemaOptions](/javascript/api/word/word.customxmladdschemaoptions)|[alias](/javascript/api/word/word.customxmladdschemaoptions#word-word-customxmladdschemaoptions-alias-member)|If provided, specifies the alias of the schema to be added to the collection.| +||[fileName](/javascript/api/word/word.customxmladdschemaoptions#word-word-customxmladdschemaoptions-filename-member)|If provided, specifies the location of the schema on a disk.| +||[installForAllUsers](/javascript/api/word/word.customxmladdschemaoptions#word-word-customxmladdschemaoptions-installforallusers-member)|If provided, specifies whether, in the case where the schema is being added to the Schema Library, the Schema Library keys should be written to the registry (`HKEY_LOCAL_MACHINE` for all users or `HKEY_CURRENT_USER` for just the current user).| +||[namespaceUri](/javascript/api/word/word.customxmladdschemaoptions#word-word-customxmladdschemaoptions-namespaceuri-member)|If provided, specifies the namespace of the schema to be added to the collection.| +|[CustomXmlAddValidationErrorOptions](/javascript/api/word/word.customxmladdvalidationerroroptions)|[clearedOnUpdate](/javascript/api/word/word.customxmladdvalidationerroroptions#word-word-customxmladdvalidationerroroptions-clearedonupdate-member)|If provided, specifies whether the error is to be cleared from the Word.CustomXmlValidationErrorCollection when the XML is corrected and updated.| +||[errorText](/javascript/api/word/word.customxmladdvalidationerroroptions#word-word-customxmladdvalidationerroroptions-errortext-member)|If provided, specifies the descriptive error text.| +|[CustomXmlAppendChildNodeOptions](/javascript/api/word/word.customxmlappendchildnodeoptions)|[name](/javascript/api/word/word.customxmlappendchildnodeoptions#word-word-customxmlappendchildnodeoptions-name-member)|If provided, specifies the base name of the element to be appended.| +||[namespaceUri](/javascript/api/word/word.customxmlappendchildnodeoptions#word-word-customxmlappendchildnodeoptions-namespaceuri-member)|If provided, specifies the namespace of the element to be appended.| +||[nodeType](/javascript/api/word/word.customxmlappendchildnodeoptions#word-word-customxmlappendchildnodeoptions-nodetype-member)|If provided, specifies the type of node to append.| +||[nodeValue](/javascript/api/word/word.customxmlappendchildnodeoptions#word-word-customxmlappendchildnodeoptions-nodevalue-member)|If provided, specifies the value of the appended node for those nodes that allow text.| +|[CustomXmlInsertNodeBeforeOptions](/javascript/api/word/word.customxmlinsertnodebeforeoptions)|[name](/javascript/api/word/word.customxmlinsertnodebeforeoptions#word-word-customxmlinsertnodebeforeoptions-name-member)|If provided, specifies the base name of the element to be inserted.| +||[namespaceUri](/javascript/api/word/word.customxmlinsertnodebeforeoptions#word-word-customxmlinsertnodebeforeoptions-namespaceuri-member)|If provided, specifies the namespace of the element to be inserted.| +||[nextSibling](/javascript/api/word/word.customxmlinsertnodebeforeoptions#word-word-customxmlinsertnodebeforeoptions-nextsibling-member)|If provided, specifies the context node.| +||[nodeType](/javascript/api/word/word.customxmlinsertnodebeforeoptions#word-word-customxmlinsertnodebeforeoptions-nodetype-member)|If provided, specifies the type of node to append.| +||[nodeValue](/javascript/api/word/word.customxmlinsertnodebeforeoptions#word-word-customxmlinsertnodebeforeoptions-nodevalue-member)|If provided, specifies the value of the inserted node for those nodes that allow text.| +|[CustomXmlInsertSubtreeBeforeOptions](/javascript/api/word/word.customxmlinsertsubtreebeforeoptions)|[nextSibling](/javascript/api/word/word.customxmlinsertsubtreebeforeoptions#word-word-customxmlinsertsubtreebeforeoptions-nextsibling-member)|If provided, specifies the context node.| +|[CustomXmlNode](/javascript/api/word/word.customxmlnode)|[appendChildNode(options?: Word.CustomXmlAppendChildNodeOptions)](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-appendchildnode-member(1))|Appends a single node as the last child under the context element node in the tree.| +||[appendChildSubtree(xml: string)](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-appendchildsubtree-member(1))|Adds a subtree as the last child under the context element node in the tree.| +||[attributes](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-attributes-member)|Gets a `CustomXmlNodeCollection` object representing the attributes of the current element in the current node.| +||[baseName](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-basename-member)|Gets the base name of the node without the namespace prefix, if one exists.| +||[childNodes](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-childnodes-member)|Gets a `CustomXmlNodeCollection` object containing all of the child elements of the current node.| +||[delete()](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-delete-member(1))|Deletes the current node from the tree (including all of its children, if any exist).| +||[firstChild](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-firstchild-member)|Gets a `CustomXmlNode` object corresponding to the first child element of the current node.| +||[hasChildNodes()](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-haschildnodes-member(1))|Specifies if the current element node has child element nodes.| +||[insertNodeBefore(options?: Word.CustomXmlInsertNodeBeforeOptions)](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-insertnodebefore-member(1))|Inserts a new node just before the context node in the tree.| +||[insertSubtreeBefore(xml: string, options?: Word.CustomXmlInsertSubtreeBeforeOptions)](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-insertsubtreebefore-member(1))|Inserts the specified subtree into the location just before the context node.| +||[lastChild](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-lastchild-member)|Gets a `CustomXmlNode` object corresponding to the last child element of the current node.| +||[namespaceUri](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-namespaceuri-member)|Gets the unique address identifier for the namespace of the node.| +||[nextSibling](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-nextsibling-member)|Gets the next sibling node (element, comment, or processing instruction) of the current node.| +||[nodeType](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-nodetype-member)|Gets the type of the current node.| +||[nodeValue](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-nodevalue-member)|Specifies the value of the current node.| +||[ownerPart](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-ownerpart-member)|Gets the object representing the part associated with this node.| +||[parentNode](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-parentnode-member)|Gets the parent element node of the current node.| +||[previousSibling](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-previoussibling-member)|Gets the previous sibling node (element, comment, or processing instruction) of the current node.| +||[removeChild(child: Word.CustomXmlNode)](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-removechild-member(1))|Removes the specified child node from the tree.| +||[replaceChildNode(oldNode: Word.CustomXmlNode, options?: Word.CustomXmlReplaceChildNodeOptions)](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-replacechildnode-member(1))|Removes the specified child node and replaces it with a different node in the same location.| +||[replaceChildSubtree(xml: string, oldNode: Word.CustomXmlNode)](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-replacechildsubtree-member(1))|Removes the specified node and replaces it with a different subtree in the same location.| +||[selectNodes(xPath: string)](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-selectnodes-member(1))|Selects a collection of nodes matching an XPath expression.| +||[selectSingleNode(xPath: string)](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-selectsinglenode-member(1))|Selects a single node from a collection matching an XPath expression.| +||[text](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-text-member)|Specifies the text for the current node.| +||[xml](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-xml-member)|Gets the XML representation of the current node and its children.| +||[xpath](/javascript/api/word/word.customxmlnode#word-word-customxmlnode-xpath-member)|Gets a string with the canonicalized XPath for the current node.| +|[CustomXmlNodeCollection](/javascript/api/word/word.customxmlnodecollection)|[getCount()](/javascript/api/word/word.customxmlnodecollection#word-word-customxmlnodecollection-getcount-member(1))|Returns the number of items in the collection.| +||[getItem(index: number)](/javascript/api/word/word.customxmlnodecollection#word-word-customxmlnodecollection-getitem-member(1))|Returns a `CustomXmlNode` object that represents the specified item in the collection.| +||[items](/javascript/api/word/word.customxmlnodecollection#word-word-customxmlnodecollection-items-member)|Gets the loaded child items in this collection.| +|[CustomXmlPart](/javascript/api/word/word.customxmlpart)|[addNode(parent: Word.CustomXmlNode, options?: Word.CustomXmlAddNodeOptions)](/javascript/api/word/word.customxmlpart#word-word-customxmlpart-addnode-member(1))|Adds a node to the XML tree.| +||[builtIn](/javascript/api/word/word.customxmlpart#word-word-customxmlpart-builtin-member)|Gets a value that indicates whether the `CustomXmlPart` is built-in.| +||[documentElement](/javascript/api/word/word.customxmlpart#word-word-customxmlpart-documentelement-member)|Gets the root element of a bound region of data in the document.| +||[errors](/javascript/api/word/word.customxmlpart#word-word-customxmlpart-errors-member)|Gets a `CustomXmlValidationErrorCollection` object that provides access to any XML validation errors.| +||[loadXml(xml: string)](/javascript/api/word/word.customxmlpart#word-word-customxmlpart-loadxml-member(1))|Populates the `CustomXmlPart` object from an XML string.| +||[namespaceManager](/javascript/api/word/word.customxmlpart#word-word-customxmlpart-namespacemanager-member)|Gets the set of namespace prefix mappings used against the current `CustomXmlPart` object.| +||[schemaCollection](/javascript/api/word/word.customxmlpart#word-word-customxmlpart-schemacollection-member)|Specifies a `CustomXmlSchemaCollection` object representing the set of schemas attached to a bound region of data in the document.| +||[selectNodes(xPath: string)](/javascript/api/word/word.customxmlpart#word-word-customxmlpart-selectnodes-member(1))|Selects a collection of nodes from a custom XML part.| +||[selectSingleNode(xPath: string)](/javascript/api/word/word.customxmlpart#word-word-customxmlpart-selectsinglenode-member(1))|Selects a single node within a custom XML part matching an XPath expression.| +||[xml](/javascript/api/word/word.customxmlpart#word-word-customxmlpart-xml-member)|Gets the XML representation of the current `CustomXmlPart` object.| +|[CustomXmlPrefixMapping](/javascript/api/word/word.customxmlprefixmapping)|[namespaceUri](/javascript/api/word/word.customxmlprefixmapping#word-word-customxmlprefixmapping-namespaceuri-member)|Gets the unique address identifier for the namespace of the `CustomXmlPrefixMapping` object.| +||[prefix](/javascript/api/word/word.customxmlprefixmapping#word-word-customxmlprefixmapping-prefix-member)|Gets the prefix for the `CustomXmlPrefixMapping` object.| +|[CustomXmlPrefixMappingCollection](/javascript/api/word/word.customxmlprefixmappingcollection)|[addNamespace(prefix: string, namespaceUri: string)](/javascript/api/word/word.customxmlprefixmappingcollection#word-word-customxmlprefixmappingcollection-addnamespace-member(1))|Adds a custom namespace/prefix mapping to use when querying an item.| +||[getCount()](/javascript/api/word/word.customxmlprefixmappingcollection#word-word-customxmlprefixmappingcollection-getcount-member(1))|Returns the number of items in the collection.| +||[getItem(index: number)](/javascript/api/word/word.customxmlprefixmappingcollection#word-word-customxmlprefixmappingcollection-getitem-member(1))|Returns a `CustomXmlPrefixMapping` object that represents the specified item in the collection.| +||[items](/javascript/api/word/word.customxmlprefixmappingcollection#word-word-customxmlprefixmappingcollection-items-member)|Gets the loaded child items in this collection.| +||[lookupNamespace(prefix: string)](/javascript/api/word/word.customxmlprefixmappingcollection#word-word-customxmlprefixmappingcollection-lookupnamespace-member(1))|Gets the namespace corresponding to the specified prefix.| +||[lookupPrefix(namespaceUri: string)](/javascript/api/word/word.customxmlprefixmappingcollection#word-word-customxmlprefixmappingcollection-lookupprefix-member(1))|Gets the prefix corresponding to the specified namespace.| +|[CustomXmlReplaceChildNodeOptions](/javascript/api/word/word.customxmlreplacechildnodeoptions)|[name](/javascript/api/word/word.customxmlreplacechildnodeoptions#word-word-customxmlreplacechildnodeoptions-name-member)|If provided, specifies the base name of the replacement element.| +||[namespaceUri](/javascript/api/word/word.customxmlreplacechildnodeoptions#word-word-customxmlreplacechildnodeoptions-namespaceuri-member)|If provided, specifies the namespace of the replacement element.| +||[nodeType](/javascript/api/word/word.customxmlreplacechildnodeoptions#word-word-customxmlreplacechildnodeoptions-nodetype-member)|If provided, specifies the type of the replacement node.| +||[nodeValue](/javascript/api/word/word.customxmlreplacechildnodeoptions#word-word-customxmlreplacechildnodeoptions-nodevalue-member)|If provided, specifies the value of the replacement node for those nodes that allow text.| +|[CustomXmlSchema](/javascript/api/word/word.customxmlschema)|[delete()](/javascript/api/word/word.customxmlschema#word-word-customxmlschema-delete-member(1))|Deletes this schema from the Word.CustomXmlSchemaCollection object.| +||[location](/javascript/api/word/word.customxmlschema#word-word-customxmlschema-location-member)|Gets the location of the schema on a computer.| +||[namespaceUri](/javascript/api/word/word.customxmlschema#word-word-customxmlschema-namespaceuri-member)|Gets the unique address identifier for the namespace of the `CustomXmlSchema` object.| +||[reload()](/javascript/api/word/word.customxmlschema#word-word-customxmlschema-reload-member(1))|Reloads the schema from a file.| +|[CustomXmlSchemaCollection](/javascript/api/word/word.customxmlschemacollection)|[add(options?: Word.CustomXmlAddSchemaOptions)](/javascript/api/word/word.customxmlschemacollection#word-word-customxmlschemacollection-add-member(1))|Adds one or more schemas to the schema collection that can then be added to a stream in the data store and to the schema library.| +||[addCollection(schemaCollection: Word.CustomXmlSchemaCollection)](/javascript/api/word/word.customxmlschemacollection#word-word-customxmlschemacollection-addcollection-member(1))|Adds an existing schema collection to the current schema collection.| +||[getCount()](/javascript/api/word/word.customxmlschemacollection#word-word-customxmlschemacollection-getcount-member(1))|Returns the number of items in the collection.| +||[getItem(index: number)](/javascript/api/word/word.customxmlschemacollection#word-word-customxmlschemacollection-getitem-member(1))|Returns a `CustomXmlSchema` object that represents the specified item in the collection.| +||[getNamespaceUri()](/javascript/api/word/word.customxmlschemacollection#word-word-customxmlschemacollection-getnamespaceuri-member(1))|Returns the number of items in the collection.| +||[items](/javascript/api/word/word.customxmlschemacollection#word-word-customxmlschemacollection-items-member)|Gets the loaded child items in this collection.| +||[validate()](/javascript/api/word/word.customxmlschemacollection#word-word-customxmlschemacollection-validate-member(1))|Specifies whether the schemas in the schema collection are valid (conforms to the syntactic rules of XML and the rules for a specified vocabulary).| +|[CustomXmlValidationError](/javascript/api/word/word.customxmlvalidationerror)|[delete()](/javascript/api/word/word.customxmlvalidationerror#word-word-customxmlvalidationerror-delete-member(1))|Deletes this `CustomXmlValidationError` object.| +||[errorCode](/javascript/api/word/word.customxmlvalidationerror#word-word-customxmlvalidationerror-errorcode-member)|Gets an integer representing the validation error in the `CustomXmlValidationError` object.| +||[name](/javascript/api/word/word.customxmlvalidationerror#word-word-customxmlvalidationerror-name-member)|Gets the name of the error in the `CustomXmlValidationError` object.If no errors exist, the property returns `Nothing`| +||[node](/javascript/api/word/word.customxmlvalidationerror#word-word-customxmlvalidationerror-node-member)|Gets the node associated with this `CustomXmlValidationError` object, if any exist.If no nodes exist, the property returns `Nothing`.| +||[text](/javascript/api/word/word.customxmlvalidationerror#word-word-customxmlvalidationerror-text-member)|Gets the text in the `CustomXmlValidationError` object.| +||[type](/javascript/api/word/word.customxmlvalidationerror#word-word-customxmlvalidationerror-type-member)|Gets the type of error generated from the `CustomXmlValidationError` object.| +|[CustomXmlValidationErrorCollection](/javascript/api/word/word.customxmlvalidationerrorcollection)|[add(node: Word.CustomXmlNode, errorName: string, options?: Word.CustomXmlAddValidationErrorOptions)](/javascript/api/word/word.customxmlvalidationerrorcollection#word-word-customxmlvalidationerrorcollection-add-member(1))|Adds a `CustomXmlValidationError` object containing an XML validation error to the `CustomXmlValidationErrorCollection` object.| +||[getCount()](/javascript/api/word/word.customxmlvalidationerrorcollection#word-word-customxmlvalidationerrorcollection-getcount-member(1))|Returns the number of items in the collection.| +||[getItem(index: number)](/javascript/api/word/word.customxmlvalidationerrorcollection#word-word-customxmlvalidationerrorcollection-getitem-member(1))|Returns a `CustomXmlValidationError` object that represents the specified item in the collection.| +||[items](/javascript/api/word/word.customxmlvalidationerrorcollection#word-word-customxmlvalidationerrorcollection-items-member)|Gets the loaded child items in this collection.| +|[DatePickerContentControl](/javascript/api/word/word.datepickercontentcontrol)|[appearance](/javascript/api/word/word.datepickercontentcontrol#word-word-datepickercontentcontrol-appearance-member)|Specifies the appearance of the content control.| +||[color](/javascript/api/word/word.datepickercontentcontrol#word-word-datepickercontentcontrol-color-member)|Specifies the red-green-blue (RGB) value of the color of the content control.| +||[copy()](/javascript/api/word/word.datepickercontentcontrol#word-word-datepickercontentcontrol-copy-member(1))|Copies the content control from the active document to the Clipboard.| +||[cut()](/javascript/api/word/word.datepickercontentcontrol#word-word-datepickercontentcontrol-cut-member(1))|Removes the content control from the active document and moves the content control to the Clipboard.| +||[dateCalendarType](/javascript/api/word/word.datepickercontentcontrol#word-word-datepickercontentcontrol-datecalendartype-member)|Specifies a `CalendarType` value that represents the calendar type for the date picker content control.| +||[dateDisplayFormat](/javascript/api/word/word.datepickercontentcontrol#word-word-datepickercontentcontrol-datedisplayformat-member)|Specifies the format in which dates are displayed.| +||[dateDisplayLocale](/javascript/api/word/word.datepickercontentcontrol#word-word-datepickercontentcontrol-datedisplaylocale-member)|Specifies a `LanguageId` that represents the language format for the date displayed in the date picker content control.| +||[dateStorageFormat](/javascript/api/word/word.datepickercontentcontrol#word-word-datepickercontentcontrol-datestorageformat-member)|Specifies a `ContentControlDateStorageFormat` value that represents the format for storage and retrieval of dates when the date picker content control is bound to the XML data store of the active document.| +||[delete(deleteContents?: boolean)](/javascript/api/word/word.datepickercontentcontrol#word-word-datepickercontentcontrol-delete-member(1))|Deletes this content control and the contents of the content control.| +||[id](/javascript/api/word/word.datepickercontentcontrol#word-word-datepickercontentcontrol-id-member)|Gets the identification for the content control.| +||[isTemporary](/javascript/api/word/word.datepickercontentcontrol#word-word-datepickercontentcontrol-istemporary-member)|Specifies whether to remove the content control from the active document when the user edits the contents of the control.| +||[level](/javascript/api/word/word.datepickercontentcontrol#word-word-datepickercontentcontrol-level-member)|Specifies the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline.| +||[lockContentControl](/javascript/api/word/word.datepickercontentcontrol#word-word-datepickercontentcontrol-lockcontentcontrol-member)|Specifies if the content control is locked (can't be deleted).| +||[lockContents](/javascript/api/word/word.datepickercontentcontrol#word-word-datepickercontentcontrol-lockcontents-member)|Specifies if the contents of the content control are locked (not editable).| +||[placeholderText](/javascript/api/word/word.datepickercontentcontrol#word-word-datepickercontentcontrol-placeholdertext-member)|Returns a `BuildingBlock` object that represents the placeholder text for the content control.| +||[range](/javascript/api/word/word.datepickercontentcontrol#word-word-datepickercontentcontrol-range-member)|Gets a `Range` object that represents the contents of the content control in the active document.| +||[setPlaceholderText(options?: Word.ContentControlPlaceholderOptions)](/javascript/api/word/word.datepickercontentcontrol#word-word-datepickercontentcontrol-setplaceholdertext-member(1))|Sets the placeholder text that displays in the content control until a user enters their own text.| +||[showingPlaceholderText](/javascript/api/word/word.datepickercontentcontrol#word-word-datepickercontentcontrol-showingplaceholdertext-member)|Gets whether the placeholder text for the content control is being displayed.| +||[tag](/javascript/api/word/word.datepickercontentcontrol#word-word-datepickercontentcontrol-tag-member)|Specifies a tag to identify the content control.| +||[title](/javascript/api/word/word.datepickercontentcontrol#word-word-datepickercontentcontrol-title-member)|Specifies the title for the content control.| +||[xmlMapping](/javascript/api/word/word.datepickercontentcontrol#word-word-datepickercontentcontrol-xmlmapping-member)|Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document.| +|[Document](/javascript/api/word/word.document)|[attachedTemplate](/javascript/api/word/word.document#word-word-document-attachedtemplate-member)|Specifies a `Template` object that represents the template attached to the document.| +||[autoHyphenation](/javascript/api/word/word.document#word-word-document-autohyphenation-member)|Specifies if automatic hyphenation is turned on for the document.| +||[autoSaveOn](/javascript/api/word/word.document#word-word-document-autosaveon-member)|Specifies if the edits in the document are automatically saved.| +||[bibliography](/javascript/api/word/word.document#word-word-document-bibliography-member)|Returns a `Bibliography` object that represents the bibliography references contained within the document.| +||[bookmarks](/javascript/api/word/word.document#word-word-document-bookmarks-member)|Returns a `BookmarkCollection` object that represents all the bookmarks in the document.| +||[coauthoring](/javascript/api/word/word.document#word-word-document-coauthoring-member)|Gets a `Coauthoring` object for managing coauthoring in the document.| +||[consecutiveHyphensLimit](/javascript/api/word/word.document#word-word-document-consecutivehyphenslimit-member)|Specifies the maximum number of consecutive lines that can end with hyphens.| +||[detectLanguage()](/javascript/api/word/word.document#word-word-document-detectlanguage-member(1))|Analyzes the document text to determine the language.| +||[documentLibraryVersions](/javascript/api/word/word.document#word-word-document-documentlibraryversions-member)|Returns a `DocumentLibraryVersionCollection` object that represents the collection of versions of a shared document that has versioning enabled and that's stored in a document library on a server.| +||[frames](/javascript/api/word/word.document#word-word-document-frames-member)|Returns a `FrameCollection` object that represents all the frames in the document.| +||[hyperlinks](/javascript/api/word/word.document#word-word-document-hyperlinks-member)|Returns a `HyperlinkCollection` object that represents all the hyperlinks in the document.| +||[hyphenateCaps](/javascript/api/word/word.document#word-word-document-hyphenatecaps-member)|Specifies whether words in all capital letters can be hyphenated.| +||[indexes](/javascript/api/word/word.document#word-word-document-indexes-member)|Returns an `IndexCollection` object that represents all the indexes in the document.| +||[languageDetected](/javascript/api/word/word.document#word-word-document-languagedetected-member)|Specifies whether Microsoft Word has detected the language of the document text.| +||[listTemplates](/javascript/api/word/word.document#word-word-document-listtemplates-member)|Returns a `ListTemplateCollection` object that represents all the list templates in the document.| +||[manualHyphenation()](/javascript/api/word/word.document#word-word-document-manualhyphenation-member(1))|Initiates manual hyphenation of a document, one line at a time.| +||[pageSetup](/javascript/api/word/word.document#word-word-document-pagesetup-member)|Returns a `PageSetup` object that's associated with the document.| +||[revisions](/javascript/api/word/word.document#word-word-document-revisions-member)|Gets the collection of revisions that represents the tracked changes in the document.| +||[selection](/javascript/api/word/word.document#word-word-document-selection-member)|Returns a `Selection` object that represents the current selection in the document.| +||[tableOfAuthoritiesCategories](/javascript/api/word/word.document#word-word-document-tableofauthoritiescategories-member)|Returns a `TableOfAuthoritiesCategoryCollection` object that represents the available table of authorities categories in the document.| +||[tablesOfAuthorities](/javascript/api/word/word.document#word-word-document-tablesofauthorities-member)|Returns a `TableOfAuthoritiesCollection` object that represents all the tables of authorities in the document.| +||[tablesOfContents](/javascript/api/word/word.document#word-word-document-tablesofcontents-member)|Returns a `TableOfContentsCollection` object that represents all the tables of contents in the document.| +||[tablesOfFigures](/javascript/api/word/word.document#word-word-document-tablesoffigures-member)|Returns a `TableOfFiguresCollection` object that represents all the tables of figures in the document.| +|[DocumentLibraryVersion](/javascript/api/word/word.documentlibraryversion)|[comments](/javascript/api/word/word.documentlibraryversion#word-word-documentlibraryversion-comments-member)|Gets any optional comments associated with this version of the shared document.| +||[modified](/javascript/api/word/word.documentlibraryversion#word-word-documentlibraryversion-modified-member)|Gets the date and time at which this version of the shared document was last saved to the server.| +||[modifiedBy](/javascript/api/word/word.documentlibraryversion#word-word-documentlibraryversion-modifiedby-member)|Gets the name of the user who last saved this version of the shared document to the server.| +|[DocumentLibraryVersionCollection](/javascript/api/word/word.documentlibraryversioncollection)|[getItem(index: number)](/javascript/api/word/word.documentlibraryversioncollection#word-word-documentlibraryversioncollection-getitem-member(1))|Gets a `DocumentLibraryVersion` object by its index in the collection.| +||[isVersioningEnabled()](/javascript/api/word/word.documentlibraryversioncollection#word-word-documentlibraryversioncollection-isversioningenabled-member(1))|Returns whether the document library in which the active document is saved on the server is configured to create a backup copy, or version, each time the file is edited on the website.| +||[items](/javascript/api/word/word.documentlibraryversioncollection#word-word-documentlibraryversioncollection-items-member)|Gets the loaded child items in this collection.| +|[DropCap](/javascript/api/word/word.dropcap)|[clear()](/javascript/api/word/word.dropcap#word-word-dropcap-clear-member(1))|Removes the dropped capital letter formatting.| +||[distanceFromText](/javascript/api/word/word.dropcap#word-word-dropcap-distancefromtext-member)|Gets the distance (in points) between the dropped capital letter and the paragraph text.| +||[enable()](/javascript/api/word/word.dropcap#word-word-dropcap-enable-member(1))|Formats the first character in the specified paragraph as a dropped capital letter.| +||[fontName](/javascript/api/word/word.dropcap#word-word-dropcap-fontname-member)|Gets the name of the font for the dropped capital letter.| +||[linesToDrop](/javascript/api/word/word.dropcap#word-word-dropcap-linestodrop-member)|Gets the height (in lines) of the dropped capital letter.| +||[position](/javascript/api/word/word.dropcap#word-word-dropcap-position-member)|Gets the position of the dropped capital letter.| +|[Editor](/javascript/api/word/word.editor)|[delete()](/javascript/api/word/word.editor#word-word-editor-delete-member(1))|Deletes the `Editor` object.| +||[id](/javascript/api/word/word.editor#word-word-editor-id-member)|Gets the identifier for the `Editor` object when the parent document is saved as a webpage.| +||[name](/javascript/api/word/word.editor#word-word-editor-name-member)|Gets the name of the editor.| +||[nextRange](/javascript/api/word/word.editor#word-word-editor-nextrange-member)|Gets a `Range` object that represents the next range that the editor has permissions to modify.| +||[range](/javascript/api/word/word.editor#word-word-editor-range-member)|Gets a `Range` object that represents the portion of the document that's contained in the `Editor` object.| +||[removeAllPermissions()](/javascript/api/word/word.editor#word-word-editor-removeallpermissions-member(1))|Removes all editing permissions in the document for the editor.| +||[selectAllShapes()](/javascript/api/word/word.editor#word-word-editor-selectallshapes-member(1))|Selects all the shapes in the document that were inserted or edited by the editor.| +|[EditorCollection](/javascript/api/word/word.editorcollection)|[addById(editorId: string)](/javascript/api/word/word.editorcollection#word-word-editorcollection-addbyid-member(1))|Returns an `Editor` object that represents a new permission for the specified user to modify a range within the document.| +||[addByType(editorType: Word.EditorType)](/javascript/api/word/word.editorcollection#word-word-editorcollection-addbytype-member(1))|Returns an `Editor` object that represents a new permission for the specified group of users to modify a range within the document.| +||[getCount()](/javascript/api/word/word.editorcollection#word-word-editorcollection-getcount-member(1))|Returns the number of items in the collection.| +||[getItemAt(index: number)](/javascript/api/word/word.editorcollection#word-word-editorcollection-getitemat-member(1))|Gets an `Editor` object by its index in the collection.| +|[Field](/javascript/api/word/word.field)|[copyToClipboard()](/javascript/api/word/word.field#word-word-field-copytoclipboard-member(1))|Copies the field to the Clipboard.| +||[cut()](/javascript/api/word/word.field#word-word-field-cut-member(1))|Removes the field from the document and places it on the Clipboard.| +||[doClick()](/javascript/api/word/word.field#word-word-field-doclick-member(1))|Clicks the field.| +||[linkFormat](/javascript/api/word/word.field#word-word-field-linkformat-member)|Gets a `LinkFormat` object that represents the link options of the field.| +||[oleFormat](/javascript/api/word/word.field#word-word-field-oleformat-member)|Gets an `OleFormat` object that represents the OLE characteristics (other than linking) for the field.| +||[unlink()](/javascript/api/word/word.field#word-word-field-unlink-member(1))|Replaces the field with its most recent result.| +||[updateSource()](/javascript/api/word/word.field#word-word-field-updatesource-member(1))|Saves the changes made to the results of an {@link https://support.microsoft.com/office/1c34d6d6-0de3-4b5c-916a-2ff950fb629e | INCLUDETEXT field} back to the source document.| +|[FillFormat](/javascript/api/word/word.fillformat)|[backgroundColor](/javascript/api/word/word.fillformat#word-word-fillformat-backgroundcolor-member)|Returns a `ColorFormat` object that represents the background color for the fill.| +||[foregroundColor](/javascript/api/word/word.fillformat#word-word-fillformat-foregroundcolor-member)|Returns a `ColorFormat` object that represents the foreground color for the fill.| +||[gradientAngle](/javascript/api/word/word.fillformat#word-word-fillformat-gradientangle-member)|Specifies the angle of the gradient fill.| +||[gradientColorType](/javascript/api/word/word.fillformat#word-word-fillformat-gradientcolortype-member)|Gets the gradient color type.| +||[gradientDegree](/javascript/api/word/word.fillformat#word-word-fillformat-gradientdegree-member)|Returns how dark or light a one-color gradient fill is.| +||[gradientStyle](/javascript/api/word/word.fillformat#word-word-fillformat-gradientstyle-member)|Returns the gradient style for the fill.| +||[gradientVariant](/javascript/api/word/word.fillformat#word-word-fillformat-gradientvariant-member)|Returns the gradient variant for the fill as an integer value from 1 to 4 for most gradient fills.| +||[isVisible](/javascript/api/word/word.fillformat#word-word-fillformat-isvisible-member)|Specifies if the object, or the formatting applied to it, is visible.| +||[pattern](/javascript/api/word/word.fillformat#word-word-fillformat-pattern-member)|Returns a `PatternType` value that represents the pattern applied to the fill or line.| +||[presetGradientType](/javascript/api/word/word.fillformat#word-word-fillformat-presetgradienttype-member)|Returns the preset gradient type for the fill.| +||[presetTexture](/javascript/api/word/word.fillformat#word-word-fillformat-presettexture-member)|Gets the preset texture.| +||[rotateWithObject](/javascript/api/word/word.fillformat#word-word-fillformat-rotatewithobject-member)|Specifies whether the fill rotates with the shape.| +||[setOneColorGradient(style: Word.GradientStyle, variant: number, degree: number)](/javascript/api/word/word.fillformat#word-word-fillformat-setonecolorgradient-member(1))|Sets the fill to a one-color gradient.| +||[setPatterned(pattern: Word.PatternType)](/javascript/api/word/word.fillformat#word-word-fillformat-setpatterned-member(1))|Sets the fill to a pattern.| +||[setPresetGradient(style: Word.GradientStyle, variant: number, presetGradientType: Word.PresetGradientType)](/javascript/api/word/word.fillformat#word-word-fillformat-setpresetgradient-member(1))|Sets the fill to a preset gradient.| +||[setPresetTextured(presetTexture: Word.PresetTexture)](/javascript/api/word/word.fillformat#word-word-fillformat-setpresettextured-member(1))|Sets the fill to a preset texture.| +||[setTwoColorGradient(style: Word.GradientStyle, variant: number)](/javascript/api/word/word.fillformat#word-word-fillformat-settwocolorgradient-member(1))|Sets the fill to a two-color gradient.| +||[solid()](/javascript/api/word/word.fillformat#word-word-fillformat-solid-member(1))|Sets the fill to a uniform color.| +||[textureAlignment](/javascript/api/word/word.fillformat#word-word-fillformat-texturealignment-member)|Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill.| +||[textureHorizontalScale](/javascript/api/word/word.fillformat#word-word-fillformat-texturehorizontalscale-member)|Specifies the horizontal scaling factor for the texture fill.| +||[textureName](/javascript/api/word/word.fillformat#word-word-fillformat-texturename-member)|Returns the name of the custom texture file for the fill.| +||[textureOffsetX](/javascript/api/word/word.fillformat#word-word-fillformat-textureoffsetx-member)|Specifies the horizontal offset of the texture from the origin in points.| +||[textureOffsetY](/javascript/api/word/word.fillformat#word-word-fillformat-textureoffsety-member)|Specifies the vertical offset of the texture.| +||[textureTile](/javascript/api/word/word.fillformat#word-word-fillformat-texturetile-member)|Specifies whether the texture is tiled.| +||[textureType](/javascript/api/word/word.fillformat#word-word-fillformat-texturetype-member)|Returns the texture type for the fill.| +||[textureVerticalScale](/javascript/api/word/word.fillformat#word-word-fillformat-textureverticalscale-member)|Specifies the vertical scaling factor for the texture fill as a value between 0.0 and 1.0.| +||[transparency](/javascript/api/word/word.fillformat#word-word-fillformat-transparency-member)|Specifies the degree of transparency of the fill for a shape as a value between 0.0 (opaque) and 1.0 (clear).| +||[type](/javascript/api/word/word.fillformat#word-word-fillformat-type-member)|Gets the fill format type.| +|[Font](/javascript/api/word/word.font)|[allCaps](/javascript/api/word/word.font#word-word-font-allcaps-member)|Specifies whether the font is formatted as all capital letters, which makes lowercase letters appear as uppercase letters.| +||[boldBidirectional](/javascript/api/word/word.font#word-word-font-boldbidirectional-member)|Specifies whether the font is formatted as bold in a right-to-left language document.| +||[borders](/javascript/api/word/word.font#word-word-font-borders-member)|Returns a `BorderUniversalCollection` object that represents all the borders for the font.| +||[colorIndex](/javascript/api/word/word.font#word-word-font-colorindex-member)|Specifies a `ColorIndex` value that represents the color for the font.| +||[colorIndexBidirectional](/javascript/api/word/word.font#word-word-font-colorindexbidirectional-member)|Specifies the color for the `Font` object in a right-to-left language document.| +||[contextualAlternates](/javascript/api/word/word.font#word-word-font-contextualalternates-member)|Specifies whether contextual alternates are enabled for the font.| +||[decreaseFontSize()](/javascript/api/word/word.font#word-word-font-decreasefontsize-member(1))|Decreases the font size to the next available size.| +||[diacriticColor](/javascript/api/word/word.font#word-word-font-diacriticcolor-member)|Specifies the color to be used for diacritics for the `Font` object.| +||[disableCharacterSpaceGrid](/javascript/api/word/word.font#word-word-font-disablecharacterspacegrid-member)|Specifies whether Microsoft Word ignores the number of characters per line for the corresponding `Font` object.| +||[emboss](/javascript/api/word/word.font#word-word-font-emboss-member)|Specifies whether the font is formatted as embossed.| +||[emphasisMark](/javascript/api/word/word.font#word-word-font-emphasismark-member)|Specifies an `EmphasisMark` value that represents the emphasis mark for a character or designated character string.| +||[engrave](/javascript/api/word/word.font#word-word-font-engrave-member)|Specifies whether the font is formatted as engraved.| +||[fill](/javascript/api/word/word.font#word-word-font-fill-member)|Returns a `FillFormat` object that contains fill formatting properties for the font used by the range of text.| +||[glow](/javascript/api/word/word.font#word-word-font-glow-member)|Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text.| +||[increaseFontSize()](/javascript/api/word/word.font#word-word-font-increasefontsize-member(1))|Increases the font size to the next available size.| +||[italicBidirectional](/javascript/api/word/word.font#word-word-font-italicbidirectional-member)|Specifies whether the font is italicized in a right-to-left language document.| +||[kerning](/javascript/api/word/word.font#word-word-font-kerning-member)|Specifies the minimum font size for which Microsoft Word will adjust kerning automatically.| +||[ligature](/javascript/api/word/word.font#word-word-font-ligature-member)|Specifies the ligature setting for the `Font` object.| +||[line](/javascript/api/word/word.font#word-word-font-line-member)|Returns a `LineFormat` object that specifies the formatting for a line.| +||[nameAscii](/javascript/api/word/word.font#word-word-font-nameascii-member)|Specifies the font used for Latin text (characters with character codes from 0 (zero) through 127).| +||[nameBidirectional](/javascript/api/word/word.font#word-word-font-namebidirectional-member)|Specifies the font name in a right-to-left language document.| +||[nameFarEast](/javascript/api/word/word.font#word-word-font-namefareast-member)|Specifies the East Asian font name.| +||[nameOther](/javascript/api/word/word.font#word-word-font-nameother-member)|Specifies the font used for characters with codes from 128 through 255.| +||[numberForm](/javascript/api/word/word.font#word-word-font-numberform-member)|Specifies the number form setting for an OpenType font.| +||[numberSpacing](/javascript/api/word/word.font#word-word-font-numberspacing-member)|Specifies the number spacing setting for the font.| +||[outline](/javascript/api/word/word.font#word-word-font-outline-member)|Specifies if the font is formatted as outlined.| +||[position](/javascript/api/word/word.font#word-word-font-position-member)|Specifies the position of text (in points) relative to the base line.| +||[reflection](/javascript/api/word/word.font#word-word-font-reflection-member)|Returns a `ReflectionFormat` object that represents the reflection formatting for a shape.| +||[reset()](/javascript/api/word/word.font#word-word-font-reset-member(1))|Removes manual character formatting.| +||[scaling](/javascript/api/word/word.font#word-word-font-scaling-member)|Specifies the scaling percentage applied to the font.| +||[setAsTemplateDefault()](/javascript/api/word/word.font#word-word-font-setastemplatedefault-member(1))|Sets the specified font formatting as the default for the active document and all new documents based on the active template.| +||[shadow](/javascript/api/word/word.font#word-word-font-shadow-member)|Specifies if the font is formatted as shadowed.| +||[sizeBidirectional](/javascript/api/word/word.font#word-word-font-sizebidirectional-member)|Specifies the font size in points for right-to-left text.| +||[smallCaps](/javascript/api/word/word.font#word-word-font-smallcaps-member)|Specifies whether the font is formatted as small caps, which makes lowercase letters appear as small uppercase letters.| +||[spacing](/javascript/api/word/word.font#word-word-font-spacing-member)|Specifies the spacing between characters.| +||[stylisticSet](/javascript/api/word/word.font#word-word-font-stylisticset-member)|Specifies the stylistic set for the font.| +||[textColor](/javascript/api/word/word.font#word-word-font-textcolor-member)|Returns a `ColorFormat` object that represents the color for the font.| +||[textShadow](/javascript/api/word/word.font#word-word-font-textshadow-member)|Returns a `ShadowFormat` object that specifies the shadow formatting for the font.| +||[threeDimensionalFormat](/javascript/api/word/word.font#word-word-font-threedimensionalformat-member)|Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font.| +||[underlineColor](/javascript/api/word/word.font#word-word-font-underlinecolor-member)|Specifies the color of the underline for the `Font` object.| +|[FontNameCollection](/javascript/api/word/word.fontnamecollection)|[getCount()](/javascript/api/word/word.fontnamecollection#word-word-fontnamecollection-getcount-member(1))|Returns the number of items in the collection.| +||[getItemAt(index: number)](/javascript/api/word/word.fontnamecollection#word-word-fontnamecollection-getitemat-member(1))|Gets the font name at the specified index.| +|[Frame](/javascript/api/word/word.frame)|[borders](/javascript/api/word/word.frame#word-word-frame-borders-member)|Returns a `BorderUniversalCollection` object that represents all the borders for the frame.| +||[copy()](/javascript/api/word/word.frame#word-word-frame-copy-member(1))|Copies the frame to the Clipboard.| +||[cut()](/javascript/api/word/word.frame#word-word-frame-cut-member(1))|Removes the frame from the document and places it on the Clipboard.| +||[delete()](/javascript/api/word/word.frame#word-word-frame-delete-member(1))|Deletes the frame.| +||[height](/javascript/api/word/word.frame#word-word-frame-height-member)|Specifies the height (in points) of the frame.| +||[heightRule](/javascript/api/word/word.frame#word-word-frame-heightrule-member)|Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame.| +||[horizontalDistanceFromText](/javascript/api/word/word.frame#word-word-frame-horizontaldistancefromtext-member)|Specifies the horizontal distance between the frame and the surrounding text, in points.| +||[horizontalPosition](/javascript/api/word/word.frame#word-word-frame-horizontalposition-member)|Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property.| +||[lockAnchor](/javascript/api/word/word.frame#word-word-frame-lockanchor-member)|Specifies if the frame is locked.| +||[range](/javascript/api/word/word.frame#word-word-frame-range-member)|Returns a `Range` object that represents the portion of the document that's contained within the frame.| +||[relativeHorizontalPosition](/javascript/api/word/word.frame#word-word-frame-relativehorizontalposition-member)|Specifies the relative horizontal position of the frame.| +||[relativeVerticalPosition](/javascript/api/word/word.frame#word-word-frame-relativeverticalposition-member)|Specifies the relative vertical position of the frame.| +||[select()](/javascript/api/word/word.frame#word-word-frame-select-member(1))|Selects the frame.| +||[shading](/javascript/api/word/word.frame#word-word-frame-shading-member)|Returns a `ShadingUniversal` object that refers to the shading formatting for the frame.| +||[textWrap](/javascript/api/word/word.frame#word-word-frame-textwrap-member)|Specifies if document text wraps around the frame.| +||[verticalDistanceFromText](/javascript/api/word/word.frame#word-word-frame-verticaldistancefromtext-member)|Specifies the vertical distance (in points) between the frame and the surrounding text.| +||[verticalPosition](/javascript/api/word/word.frame#word-word-frame-verticalposition-member)|Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property.| +||[width](/javascript/api/word/word.frame#word-word-frame-width-member)|Specifies the width (in points) of the frame.| +||[widthRule](/javascript/api/word/word.frame#word-word-frame-widthrule-member)|Specifies the rule used to determine the width of the frame.| +|[FrameCollection](/javascript/api/word/word.framecollection)|[add(range: Word.Range)](/javascript/api/word/word.framecollection#word-word-framecollection-add-member(1))|Returns a `Frame` object that represents a new frame added to a range, selection, or document.| +||[delete()](/javascript/api/word/word.framecollection#word-word-framecollection-delete-member(1))|Deletes the `FrameCollection` object.| +||[getItem(index: number)](/javascript/api/word/word.framecollection#word-word-framecollection-getitem-member(1))|Gets a `Frame` object by its index in the collection.| +||[items](/javascript/api/word/word.framecollection#word-word-framecollection-items-member)|Gets the loaded child items in this collection.| +|[GlowFormat](/javascript/api/word/word.glowformat)|[color](/javascript/api/word/word.glowformat#word-word-glowformat-color-member)|Returns a `ColorFormat` object that represents the color for a glow effect.| +||[radius](/javascript/api/word/word.glowformat#word-word-glowformat-radius-member)|Specifies the length of the radius for a glow effect.| +||[transparency](/javascript/api/word/word.glowformat#word-word-glowformat-transparency-member)|Specifies the degree of transparency for the glow effect as a value between 0.0 (opaque) and 1.0 (clear).| +|[GroupContentControl](/javascript/api/word/word.groupcontentcontrol)|[appearance](/javascript/api/word/word.groupcontentcontrol#word-word-groupcontentcontrol-appearance-member)|Specifies the appearance of the content control.| +||[color](/javascript/api/word/word.groupcontentcontrol#word-word-groupcontentcontrol-color-member)|Specifies the red-green-blue (RGB) value of the color of the content control.| +||[copy()](/javascript/api/word/word.groupcontentcontrol#word-word-groupcontentcontrol-copy-member(1))|Copies the content control from the active document to the Clipboard.| +||[cut()](/javascript/api/word/word.groupcontentcontrol#word-word-groupcontentcontrol-cut-member(1))|Removes the content control from the active document and moves the content control to the Clipboard.| +||[delete(deleteContents: boolean)](/javascript/api/word/word.groupcontentcontrol#word-word-groupcontentcontrol-delete-member(1))|Deletes the content control and optionally its contents.| +||[id](/javascript/api/word/word.groupcontentcontrol#word-word-groupcontentcontrol-id-member)|Returns the identification for the content control.| +||[isTemporary](/javascript/api/word/word.groupcontentcontrol#word-word-groupcontentcontrol-istemporary-member)|Specifies whether to remove the content control from the active document when the user edits the contents of the control.| +||[level](/javascript/api/word/word.groupcontentcontrol#word-word-groupcontentcontrol-level-member)|Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline.| +||[lockContentControl](/javascript/api/word/word.groupcontentcontrol#word-word-groupcontentcontrol-lockcontentcontrol-member)|Specifies if the content control is locked (can't be deleted).| +||[lockContents](/javascript/api/word/word.groupcontentcontrol#word-word-groupcontentcontrol-lockcontents-member)|Specifies if the contents of the content control are locked (not editable).| +||[placeholderText](/javascript/api/word/word.groupcontentcontrol#word-word-groupcontentcontrol-placeholdertext-member)|Returns a `BuildingBlock` object that represents the placeholder text for the content control.| +||[range](/javascript/api/word/word.groupcontentcontrol#word-word-groupcontentcontrol-range-member)|Gets a `Range` object that represents the contents of the content control in the active document.| +||[setPlaceholderText(options?: Word.ContentControlPlaceholderOptions)](/javascript/api/word/word.groupcontentcontrol#word-word-groupcontentcontrol-setplaceholdertext-member(1))|Sets the placeholder text that displays in the content control until a user enters their own text.| +||[showingPlaceholderText](/javascript/api/word/word.groupcontentcontrol#word-word-groupcontentcontrol-showingplaceholdertext-member)|Returns whether the placeholder text for the content control is being displayed.| +||[tag](/javascript/api/word/word.groupcontentcontrol#word-word-groupcontentcontrol-tag-member)|Specifies a tag to identify the content control.| +||[title](/javascript/api/word/word.groupcontentcontrol#word-word-groupcontentcontrol-title-member)|Specifies the title for the content control.| +||[ungroup()](/javascript/api/word/word.groupcontentcontrol#word-word-groupcontentcontrol-ungroup-member(1))|Removes the group content control from the document so that its child content controls are no longer nested and can be freely edited.| +||[xmlMapping](/javascript/api/word/word.groupcontentcontrol#word-word-groupcontentcontrol-xmlmapping-member)|Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document.| +|[HeadingStyle](/javascript/api/word/word.headingstyle)|[delete()](/javascript/api/word/word.headingstyle#word-word-headingstyle-delete-member(1))|Deletes the heading style.| +||[level](/javascript/api/word/word.headingstyle#word-word-headingstyle-level-member)|Specifies the level for the heading style in a table of contents or table of figures.| +||[name](/javascript/api/word/word.headingstyle#word-word-headingstyle-name-member)|Specifies the name of style for a heading.| +|[HeadingStyleCollection](/javascript/api/word/word.headingstylecollection)|[add(name: string, level: number)](/javascript/api/word/word.headingstylecollection#word-word-headingstylecollection-add-member(1))|Adds a new heading style to a document.| +||[items](/javascript/api/word/word.headingstylecollection#word-word-headingstylecollection-items-member)|Gets the loaded child items in this collection.| +|[Hyperlink](/javascript/api/word/word.hyperlink)|[addToFavorites()](/javascript/api/word/word.hyperlink#word-word-hyperlink-addtofavorites-member(1))|Creates a shortcut to the document or hyperlink and adds it to the **Favorites** folder.| +||[address](/javascript/api/word/word.hyperlink#word-word-hyperlink-address-member)|Specifies the address (for example, a file name or URL) of the hyperlink.| +||[createNewDocument(fileName: string, editNow: boolean, overwrite: boolean)](/javascript/api/word/word.hyperlink#word-word-hyperlink-createnewdocument-member(1))|Creates a new document linked to the hyperlink.| +||[delete()](/javascript/api/word/word.hyperlink#word-word-hyperlink-delete-member(1))|Deletes the hyperlink.| +||[emailSubject](/javascript/api/word/word.hyperlink#word-word-hyperlink-emailsubject-member)|Specifies the text string for the hyperlink's subject line.| +||[isExtraInfoRequired](/javascript/api/word/word.hyperlink#word-word-hyperlink-isextrainforequired-member)|Returns `true` if extra information is required to resolve the hyperlink.| +||[name](/javascript/api/word/word.hyperlink#word-word-hyperlink-name-member)|Returns the name of the `Hyperlink` object.| +||[range](/javascript/api/word/word.hyperlink#word-word-hyperlink-range-member)|Returns a `Range` object that represents the portion of the document that's contained within the hyperlink.| +||[screenTip](/javascript/api/word/word.hyperlink#word-word-hyperlink-screentip-member)|Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink.| +||[subAddress](/javascript/api/word/word.hyperlink#word-word-hyperlink-subaddress-member)|Specifies a named location in the destination of the hyperlink.| +||[target](/javascript/api/word/word.hyperlink#word-word-hyperlink-target-member)|Specifies the name of the frame or window in which to load the hyperlink.| +||[textToDisplay](/javascript/api/word/word.hyperlink#word-word-hyperlink-texttodisplay-member)|Specifies the hyperlink's visible text in the document.| +||[type](/javascript/api/word/word.hyperlink#word-word-hyperlink-type-member)|Returns the hyperlink type.| +|[HyperlinkAddOptions](/javascript/api/word/word.hyperlinkaddoptions)|[address](/javascript/api/word/word.hyperlinkaddoptions#word-word-hyperlinkaddoptions-address-member)|If provided, specifies the address (e.g., URL or file path) of the hyperlink.| +||[screenTip](/javascript/api/word/word.hyperlinkaddoptions#word-word-hyperlinkaddoptions-screentip-member)|If provided, specifies the text that appears as a tooltip.| +||[subAddress](/javascript/api/word/word.hyperlinkaddoptions#word-word-hyperlinkaddoptions-subaddress-member)|If provided, specifies the location within the file or document.| +||[target](/javascript/api/word/word.hyperlinkaddoptions#word-word-hyperlinkaddoptions-target-member)|If provided, specifies the name of the frame or window in which to load the hyperlink.| +||[textToDisplay](/javascript/api/word/word.hyperlinkaddoptions#word-word-hyperlinkaddoptions-texttodisplay-member)|If provided, specifies the visible text of the hyperlink.| +|[HyperlinkCollection](/javascript/api/word/word.hyperlinkcollection)|[add(anchor: Word.Range, options?: Word.HyperlinkAddOptions)](/javascript/api/word/word.hyperlinkcollection#word-word-hyperlinkcollection-add-member(1))|Returns a `Hyperlink` object that represents a new hyperlink added to a range, selection, or document.| +||[items](/javascript/api/word/word.hyperlinkcollection#word-word-hyperlinkcollection-items-member)|Gets the loaded child items in this collection.| +|[Index](/javascript/api/word/word.index)|[delete()](/javascript/api/word/word.index#word-word-index-delete-member(1))|Deletes this index.| +||[filter](/javascript/api/word/word.index#word-word-index-filter-member)|Gets a value that represents how Microsoft Word classifies the first character of entries in the index.| +||[headingSeparator](/javascript/api/word/word.index#word-word-index-headingseparator-member)|Gets the text between alphabetical groups (entries that start with the same letter) in the index.| +||[indexLanguage](/javascript/api/word/word.index#word-word-index-indexlanguage-member)|Gets a `LanguageId` value that represents the sorting language to use for the index.| +||[numberOfColumns](/javascript/api/word/word.index#word-word-index-numberofcolumns-member)|Gets the number of columns for each page of the index.| +||[range](/javascript/api/word/word.index#word-word-index-range-member)|Returns a `Range` object that represents the portion of the document that is contained within the index.| +||[rightAlignPageNumbers](/javascript/api/word/word.index#word-word-index-rightalignpagenumbers-member)|Specifies if page numbers are aligned with the right margin in the index.| +||[separateAccentedLetterHeadings](/javascript/api/word/word.index#word-word-index-separateaccentedletterheadings-member)|Gets if the index contains separate headings for accented letters (for example, words that begin with "À" are under| +||[sortBy](/javascript/api/word/word.index#word-word-index-sortby-member)|Specifies the sorting criteria for the index.| +||[tabLeader](/javascript/api/word/word.index#word-word-index-tableader-member)|Specifies the leader character between entries in the index and their associated page numbers.| +||[type](/javascript/api/word/word.index#word-word-index-type-member)|Gets the index type.| +|[IndexAddOptions](/javascript/api/word/word.indexaddoptions)|[headingSeparator](/javascript/api/word/word.indexaddoptions#word-word-indexaddoptions-headingseparator-member)|If provided, specifies the text between alphabetical groups (entries that start with the same letter) in the index.| +||[indexLanguage](/javascript/api/word/word.indexaddoptions#word-word-indexaddoptions-indexlanguage-member)|If provided, specifies the sorting language to be used for the index being added.| +||[numberOfColumns](/javascript/api/word/word.indexaddoptions#word-word-indexaddoptions-numberofcolumns-member)|If provided, specifies the number of columns for each page of the index.| +||[rightAlignPageNumbers](/javascript/api/word/word.indexaddoptions#word-word-indexaddoptions-rightalignpagenumbers-member)|If provided, specifies whether the page numbers in the generated index are aligned with the right margin.| +||[separateAccentedLetterHeadings](/javascript/api/word/word.indexaddoptions#word-word-indexaddoptions-separateaccentedletterheadings-member)|If provided, specifies whether to include separate headings for accented letters in the index.| +||[sortBy](/javascript/api/word/word.indexaddoptions#word-word-indexaddoptions-sortby-member)|If provided, specifies the sorting criteria to be used for the index being added.| +||[type](/javascript/api/word/word.indexaddoptions#word-word-indexaddoptions-type-member)|If provided, specifies whether subentries are on the same line (run-in) as the main entry or on a separate line (indented) from the main entry.| +|[IndexCollection](/javascript/api/word/word.indexcollection)|[add(range: Word.Range, indexAddOptions?: Word.IndexAddOptions)](/javascript/api/word/word.indexcollection#word-word-indexcollection-add-member(1))|Returns an `Index` object that represents a new index added to the document.| +||[getFormat()](/javascript/api/word/word.indexcollection#word-word-indexcollection-getformat-member(1))|Gets the `IndexFormat` value that represents the formatting for the indexes in the document.| +||[getItem(index: number)](/javascript/api/word/word.indexcollection#word-word-indexcollection-getitem-member(1))|Gets an `Index` object by its index in the collection.| +||[items](/javascript/api/word/word.indexcollection#word-word-indexcollection-items-member)|Gets the loaded child items in this collection.| +||[markAllEntries(range: Word.Range, markAllEntriesOptions?: Word.IndexMarkAllEntriesOptions)](/javascript/api/word/word.indexcollection#word-word-indexcollection-markallentries-member(1))|Inserts an {@link https://support.microsoft.com/office/abaf7c78-6e21-418d-bf8b-f8186d2e4d08 | XE (Index Entry) field} after all instances of the text in the range.| +|[IndexMarkAllEntriesOptions](/javascript/api/word/word.indexmarkallentriesoptions)|[bold](/javascript/api/word/word.indexmarkallentriesoptions#word-word-indexmarkallentriesoptions-bold-member)|If provided, specifies whether to add bold formatting to page numbers for index entries.| +||[bookmarkName](/javascript/api/word/word.indexmarkallentriesoptions#word-word-indexmarkallentriesoptions-bookmarkname-member)|If provided, specifies the bookmark name that marks the range of pages you want to appear in the index.| +||[crossReference](/javascript/api/word/word.indexmarkallentriesoptions#word-word-indexmarkallentriesoptions-crossreference-member)|If provided, specifies the cross-reference that will appear in the index.| +||[crossReferenceAutoText](/javascript/api/word/word.indexmarkallentriesoptions#word-word-indexmarkallentriesoptions-crossreferenceautotext-member)|If provided, specifies the name of the `AutoText` entry that contains the text for a cross-reference (if this property is specified, `crossReference` is ignored).| +||[entry](/javascript/api/word/word.indexmarkallentriesoptions#word-word-indexmarkallentriesoptions-entry-member)|If provided, specifies the text you want to appear in the index, in the form `MainEntry[:Subentry]`.| +||[entryAutoText](/javascript/api/word/word.indexmarkallentriesoptions#word-word-indexmarkallentriesoptions-entryautotext-member)|If provided, specifies the `AutoText` entry that contains the text you want to appear in the index (if this property is specified, `entry` is ignored).| +||[italic](/javascript/api/word/word.indexmarkallentriesoptions#word-word-indexmarkallentriesoptions-italic-member)|If provided, specifies whether to add italic formatting to page numbers for index entries.| +|[IndexMarkEntryOptions](/javascript/api/word/word.indexmarkentryoptions)|[bold](/javascript/api/word/word.indexmarkentryoptions#word-word-indexmarkentryoptions-bold-member)|If provided, specifies whether to add bold formatting to page numbers for index entries.| +||[bookmarkName](/javascript/api/word/word.indexmarkentryoptions#word-word-indexmarkentryoptions-bookmarkname-member)|If provided, specifies the bookmark name that marks the range of pages you want to appear in the index.| +||[crossReference](/javascript/api/word/word.indexmarkentryoptions#word-word-indexmarkentryoptions-crossreference-member)|If provided, specifies the cross-reference that will appear in the index.| +||[crossReferenceAutoText](/javascript/api/word/word.indexmarkentryoptions#word-word-indexmarkentryoptions-crossreferenceautotext-member)|If provided, specifies the name of the `AutoText` entry that contains the text for a cross-reference (if this property is specified, `crossReference` is ignored).| +||[entry](/javascript/api/word/word.indexmarkentryoptions#word-word-indexmarkentryoptions-entry-member)|If provided, specifies the text you want to appear in the index, in the form `MainEntry[:Subentry]`.| +||[entryAutoText](/javascript/api/word/word.indexmarkentryoptions#word-word-indexmarkentryoptions-entryautotext-member)|If provided, specifies the `AutoText` entry that contains the text you want to appear in the index (if this property is specified, `entry` is ignored).| +||[italic](/javascript/api/word/word.indexmarkentryoptions#word-word-indexmarkentryoptions-italic-member)|If provided, specifies whether to add italic formatting to page numbers for index entries.| +||[reading](/javascript/api/word/word.indexmarkentryoptions#word-word-indexmarkentryoptions-reading-member)|If provided, specifies whether to show an index entry in the right location when indexes are sorted phonetically (East Asian languages only).| +|[LineFormat](/javascript/api/word/word.lineformat)|[backgroundColor](/javascript/api/word/word.lineformat#word-word-lineformat-backgroundcolor-member)|Gets a `ColorFormat` object that represents the background color for a patterned line.| +||[beginArrowheadLength](/javascript/api/word/word.lineformat#word-word-lineformat-beginarrowheadlength-member)|Specifies the length of the arrowhead at the beginning of the line.| +||[beginArrowheadStyle](/javascript/api/word/word.lineformat#word-word-lineformat-beginarrowheadstyle-member)|Specifies the style of the arrowhead at the beginning of the line.| +||[beginArrowheadWidth](/javascript/api/word/word.lineformat#word-word-lineformat-beginarrowheadwidth-member)|Specifies the width of the arrowhead at the beginning of the line.| +||[dashStyle](/javascript/api/word/word.lineformat#word-word-lineformat-dashstyle-member)|Specifies the dash style for the line.| +||[endArrowheadLength](/javascript/api/word/word.lineformat#word-word-lineformat-endarrowheadlength-member)|Specifies the length of the arrowhead at the end of the line.| +||[endArrowheadStyle](/javascript/api/word/word.lineformat#word-word-lineformat-endarrowheadstyle-member)|Specifies the style of the arrowhead at the end of the line.| +||[endArrowheadWidth](/javascript/api/word/word.lineformat#word-word-lineformat-endarrowheadwidth-member)|Specifies the width of the arrowhead at the end of the line.| +||[foregroundColor](/javascript/api/word/word.lineformat#word-word-lineformat-foregroundcolor-member)|Gets a `ColorFormat` object that represents the foreground color for the line.| +||[insetPen](/javascript/api/word/word.lineformat#word-word-lineformat-insetpen-member)|Specifies if to draw lines inside a shape.| +||[isVisible](/javascript/api/word/word.lineformat#word-word-lineformat-isvisible-member)|Specifies if the object, or the formatting applied to it, is visible.| +||[pattern](/javascript/api/word/word.lineformat#word-word-lineformat-pattern-member)|Specifies the pattern applied to the line.| +||[style](/javascript/api/word/word.lineformat#word-word-lineformat-style-member)|Specifies the line format style.| +||[transparency](/javascript/api/word/word.lineformat#word-word-lineformat-transparency-member)|Specifies the degree of transparency of the line as a value between 0.0 (opaque) and 1.0 (clear).| +||[weight](/javascript/api/word/word.lineformat#word-word-lineformat-weight-member)|Specifies the thickness of the line in points.| +|[LineNumbering](/javascript/api/word/word.linenumbering)|[countBy](/javascript/api/word/word.linenumbering#word-word-linenumbering-countby-member)|Specifies the numeric increment for line numbers.| +||[distanceFromText](/javascript/api/word/word.linenumbering#word-word-linenumbering-distancefromtext-member)|Specifies the distance (in points) between the right edge of line numbers and the left edge of the document text.| +||[isActive](/javascript/api/word/word.linenumbering#word-word-linenumbering-isactive-member)|Specifies if line numbering is active for the specified document, section, or sections.| +||[restartMode](/javascript/api/word/word.linenumbering#word-word-linenumbering-restartmode-member)|Specifies the way line numbering runs; that is, whether it starts over at the beginning of a new page or section, or runs continuously.| +||[startingNumber](/javascript/api/word/word.linenumbering#word-word-linenumbering-startingnumber-member)|Specifies the starting line number.| +|[LinkFormat](/javascript/api/word/word.linkformat)|[breakLink()](/javascript/api/word/word.linkformat#word-word-linkformat-breaklink-member(1))|Breaks the link between the source file and the OLE object, picture, or linked field.| +||[isAutoUpdated](/javascript/api/word/word.linkformat#word-word-linkformat-isautoupdated-member)|Specifies if the link is updated automatically when the container file is opened or when the source file is changed.| +||[isLocked](/javascript/api/word/word.linkformat#word-word-linkformat-islocked-member)|Specifies if a `Field`, `InlineShape`, or `Shape` object is locked to prevent automatic updating.| +||[isPictureSavedWithDocument](/javascript/api/word/word.linkformat#word-word-linkformat-ispicturesavedwithdocument-member)|Specifies if the linked picture is saved with the document.| +||[sourceFullName](/javascript/api/word/word.linkformat#word-word-linkformat-sourcefullname-member)|Specifies the path and name of the source file for the linked OLE object, picture, or field.| +||[sourceName](/javascript/api/word/word.linkformat#word-word-linkformat-sourcename-member)|Gets the name of the source file for the linked OLE object, picture, or field.| +||[sourcePath](/javascript/api/word/word.linkformat#word-word-linkformat-sourcepath-member)|Gets the path of the source file for the linked OLE object, picture, or field.| +||[type](/javascript/api/word/word.linkformat#word-word-linkformat-type-member)|Gets the link type.| +|[ListFormat](/javascript/api/word/word.listformat)|[applyBulletDefault(defaultListBehavior: Word.DefaultListBehavior)](/javascript/api/word/word.listformat#word-word-listformat-applybulletdefault-member(1))|Adds bullets and formatting to the paragraphs in the range.| +||[applyListTemplateWithLevel(listTemplate: Word.ListTemplate, options?: Word.ListTemplateApplyOptions)](/javascript/api/word/word.listformat#word-word-listformat-applylisttemplatewithlevel-member(1))|Applies a list template with a specific level to the paragraphs in the range.| +||[applyNumberDefault(defaultListBehavior: Word.DefaultListBehavior)](/javascript/api/word/word.listformat#word-word-listformat-applynumberdefault-member(1))|Adds numbering and formatting to the paragraphs in the range.| +||[applyOutlineNumberDefault(defaultListBehavior: Word.DefaultListBehavior)](/javascript/api/word/word.listformat#word-word-listformat-applyoutlinenumberdefault-member(1))|Adds outline numbering and formatting to the paragraphs in the range.| +||[canContinuePreviousList(listTemplate: Word.ListTemplate)](/javascript/api/word/word.listformat#word-word-listformat-cancontinuepreviouslist-member(1))|Determines whether the `ListFormat` object can continue a previous list.| +||[convertNumbersToText(numberType: Word.NumberType)](/javascript/api/word/word.listformat#word-word-listformat-convertnumberstotext-member(1))|Converts numbers in the list to plain text.| +||[countNumberedItems(options?: Word.ListFormatCountNumberedItemsOptions)](/javascript/api/word/word.listformat#word-word-listformat-countnumbereditems-member(1))|Counts the numbered items in the list.| +||[isSingleList](/javascript/api/word/word.listformat#word-word-listformat-issinglelist-member)|Indicates whether the `ListFormat` object contains a single list.| +||[isSingleListTemplate](/javascript/api/word/word.listformat#word-word-listformat-issinglelisttemplate-member)|Indicates whether the `ListFormat` object contains a single list template.| +||[list](/javascript/api/word/word.listformat#word-word-listformat-list-member)|Returns a `List` object that represents the first formatted list contained in the `ListFormat` object.| +||[listIndent()](/javascript/api/word/word.listformat#word-word-listformat-listindent-member(1))|Indents the list by one level.| +||[listLevelNumber](/javascript/api/word/word.listformat#word-word-listformat-listlevelnumber-member)|Specifies the list level number for the first paragraph for the `ListFormat` object.| +||[listOutdent()](/javascript/api/word/word.listformat#word-word-listformat-listoutdent-member(1))|Outdents the list by one level.| +||[listString](/javascript/api/word/word.listformat#word-word-listformat-liststring-member)|Gets the string representation of the list value of the first paragraph in the range for the `ListFormat` object.| +||[listTemplate](/javascript/api/word/word.listformat#word-word-listformat-listtemplate-member)|Gets the list template associated with the `ListFormat` object.| +||[listType](/javascript/api/word/word.listformat#word-word-listformat-listtype-member)|Gets the type of the list for the `ListFormat` object.| +||[listValue](/javascript/api/word/word.listformat#word-word-listformat-listvalue-member)|Gets the numeric value of the the first paragraph in the range for the `ListFormat` object.| +||[removeNumbers(numberType: Word.NumberType)](/javascript/api/word/word.listformat#word-word-listformat-removenumbers-member(1))|Removes numbering from the list.| +|[ListFormatCountNumberedItemsOptions](/javascript/api/word/word.listformatcountnumbereditemsoptions)|[level](/javascript/api/word/word.listformatcountnumbereditemsoptions#word-word-listformatcountnumbereditemsoptions-level-member)|If provided, specifies the level to count.| +||[numberType](/javascript/api/word/word.listformatcountnumbereditemsoptions#word-word-listformatcountnumbereditemsoptions-numbertype-member)|If provided, specifies the type of number to count.| +|[ListTemplate](/javascript/api/word/word.listtemplate)|[name](/javascript/api/word/word.listtemplate#word-word-listtemplate-name-member)|Specifies the name of the list template.| +|[ListTemplateApplyOptions](/javascript/api/word/word.listtemplateapplyoptions)|[applyLevel](/javascript/api/word/word.listtemplateapplyoptions#word-word-listtemplateapplyoptions-applylevel-member)|If provided, specifies the level to apply in the list template.| +||[applyTo](/javascript/api/word/word.listtemplateapplyoptions#word-word-listtemplateapplyoptions-applyto-member)|If provided, specifies which part of the list to apply the template to.| +||[continuePreviousList](/javascript/api/word/word.listtemplateapplyoptions#word-word-listtemplateapplyoptions-continuepreviouslist-member)|If provided, specifies whether to continue the previous list.| +||[defaultListBehavior](/javascript/api/word/word.listtemplateapplyoptions#word-word-listtemplateapplyoptions-defaultlistbehavior-member)|If provided, specifies the default list behavior.| +|[ListTemplateCollection](/javascript/api/word/word.listtemplatecollection)|[add(options?: Word.ListTemplateCollectionAddOptions)](/javascript/api/word/word.listtemplatecollection#word-word-listtemplatecollection-add-member(1))|Adds a new `ListTemplate` object.| +||[getItem(index: number)](/javascript/api/word/word.listtemplatecollection#word-word-listtemplatecollection-getitem-member(1))|Gets a `ListTemplate` object by its index in the collection.| +||[items](/javascript/api/word/word.listtemplatecollection#word-word-listtemplatecollection-items-member)|Gets the loaded child items in this collection.| +|[ListTemplateCollectionAddOptions](/javascript/api/word/word.listtemplatecollectionaddoptions)|[name](/javascript/api/word/word.listtemplatecollectionaddoptions#word-word-listtemplatecollectionaddoptions-name-member)|If provided, specifies the name of the list template to be added.| +||[outlineNumbered](/javascript/api/word/word.listtemplatecollectionaddoptions#word-word-listtemplatecollectionaddoptions-outlinenumbered-member)|If provided, specifies whether to apply outline numbering to the new list template.| +|[ListTemplateGallery](/javascript/api/word/word.listtemplategallery)|[listTemplates](/javascript/api/word/word.listtemplategallery#word-word-listtemplategallery-listtemplates-member)|Returns a `ListTemplateCollection` object that represents all the list templates for the specified list gallery.| +|[ListTemplateGalleryCollection](/javascript/api/word/word.listtemplategallerycollection)|[getByType(type: Word.ListTemplateGalleryType)](/javascript/api/word/word.listtemplategallerycollection#word-word-listtemplategallerycollection-getbytype-member(1))|Gets a `ListTemplateGallery` object by its type in the collection.| +||[getItem(index: number)](/javascript/api/word/word.listtemplategallerycollection#word-word-listtemplategallerycollection-getitem-member(1))|Gets a `ListTemplateGallery` object by its index in the collection.| +||[items](/javascript/api/word/word.listtemplategallerycollection#word-word-listtemplategallerycollection-items-member)|Gets the loaded child items in this collection.| +|[OleFormat](/javascript/api/word/word.oleformat)|[activate()](/javascript/api/word/word.oleformat#word-word-oleformat-activate-member(1))|Activates the `OleFormat` object.| +||[activateAs(classType: string)](/javascript/api/word/word.oleformat#word-word-oleformat-activateas-member(1))|Sets the Windows registry value that determines the default application used to activate the specified OLE object.| +||[classType](/javascript/api/word/word.oleformat#word-word-oleformat-classtype-member)|Specifies the class type for the specified OLE object, picture, or field.| +||[doVerb(verbIndex: Word.OleVerb)](/javascript/api/word/word.oleformat#word-word-oleformat-doverb-member(1))|Requests that the OLE object perform one of its available verbs.| +||[edit()](/javascript/api/word/word.oleformat#word-word-oleformat-edit-member(1))|Opens the OLE object for editing in the application it was created in.| +||[iconIndex](/javascript/api/word/word.oleformat#word-word-oleformat-iconindex-member)|Specifies the icon that is used when the `displayAsIcon` property is `true`.| +||[iconLabel](/javascript/api/word/word.oleformat#word-word-oleformat-iconlabel-member)|Specifies the text displayed below the icon for the OLE object.| +||[iconName](/javascript/api/word/word.oleformat#word-word-oleformat-iconname-member)|Specifies the program file in which the icon for the OLE object is stored.| +||[iconPath](/javascript/api/word/word.oleformat#word-word-oleformat-iconpath-member)|Gets the path of the file in which the icon for the OLE object is stored.| +||[isDisplayedAsIcon](/javascript/api/word/word.oleformat#word-word-oleformat-isdisplayedasicon-member)|Gets whether the specified object is displayed as an icon.| +||[isFormattingPreservedOnUpdate](/javascript/api/word/word.oleformat#word-word-oleformat-isformattingpreservedonupdate-member)|Specifies whether formatting done in Microsoft Word to the linked OLE object is preserved.| +||[label](/javascript/api/word/word.oleformat#word-word-oleformat-label-member)|Gets a string that's used to identify the portion of the source file that's being linked.| +||[open()](/javascript/api/word/word.oleformat#word-word-oleformat-open-member(1))|Opens the `OleFormat` object.| +||[progID](/javascript/api/word/word.oleformat#word-word-oleformat-progid-member)|Gets the programmatic identifier (`ProgId`) for the specified OLE object.| +|[Page](/javascript/api/word/word.page)|[breaks](/javascript/api/word/word.page#word-word-page-breaks-member)|Gets a `BreakCollection` object that represents the breaks on the page.| +|[PageSetup](/javascript/api/word/word.pagesetup)|[bookFoldPrinting](/javascript/api/word/word.pagesetup#word-word-pagesetup-bookfoldprinting-member)|Specifies whether Microsoft Word prints the document as a booklet.| +||[bookFoldPrintingSheets](/javascript/api/word/word.pagesetup#word-word-pagesetup-bookfoldprintingsheets-member)|Specifies the number of pages for each booklet.| +||[bookFoldReversePrinting](/javascript/api/word/word.pagesetup#word-word-pagesetup-bookfoldreverseprinting-member)|Specifies if Microsoft Word reverses the printing order for book fold printing of bidirectional or Asian language documents.| +||[bottomMargin](/javascript/api/word/word.pagesetup#word-word-pagesetup-bottommargin-member)|Specifies the distance (in points) between the bottom edge of the page and the bottom boundary of the body text.| +||[charsLine](/javascript/api/word/word.pagesetup#word-word-pagesetup-charsline-member)|Specifies the number of characters per line in the document grid.| +||[differentFirstPageHeaderFooter](/javascript/api/word/word.pagesetup#word-word-pagesetup-differentfirstpageheaderfooter-member)|Specifies whether the first page has a different header and footer.| +||[footerDistance](/javascript/api/word/word.pagesetup#word-word-pagesetup-footerdistance-member)|Specifies the distance between the footer and the bottom of the page in points.| +||[gutter](/javascript/api/word/word.pagesetup#word-word-pagesetup-gutter-member)|Specifies the amount (in points) of extra margin space added to each page in a document or section for binding.| +||[gutterPosition](/javascript/api/word/word.pagesetup#word-word-pagesetup-gutterposition-member)|Specifies on which side the gutter appears in a document.| +||[gutterStyle](/javascript/api/word/word.pagesetup#word-word-pagesetup-gutterstyle-member)|Specifies whether Microsoft Word uses gutters for the current document based on a right-to-left language or a left-to-right language.| +||[headerDistance](/javascript/api/word/word.pagesetup#word-word-pagesetup-headerdistance-member)|Specifies the distance between the header and the top of the page in points.| +||[layoutMode](/javascript/api/word/word.pagesetup#word-word-pagesetup-layoutmode-member)|Specifies the layout mode for the current document.| +||[leftMargin](/javascript/api/word/word.pagesetup#word-word-pagesetup-leftmargin-member)|Specifies the distance (in points) between the left edge of the page and the left boundary of the body text.| +||[lineNumbering](/javascript/api/word/word.pagesetup#word-word-pagesetup-linenumbering-member)|Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object.| +||[linesPage](/javascript/api/word/word.pagesetup#word-word-pagesetup-linespage-member)|Specifies the number of lines per page in the document grid.| +||[mirrorMargins](/javascript/api/word/word.pagesetup#word-word-pagesetup-mirrormargins-member)|Specifies if the inside and outside margins of facing pages are the same width.| +||[oddAndEvenPagesHeaderFooter](/javascript/api/word/word.pagesetup#word-word-pagesetup-oddandevenpagesheaderfooter-member)|Specifies whether odd and even pages have different headers and footers.| +||[orientation](/javascript/api/word/word.pagesetup#word-word-pagesetup-orientation-member)|Specifies the orientation of the page.| +||[pageHeight](/javascript/api/word/word.pagesetup#word-word-pagesetup-pageheight-member)|Specifies the page height in points.| +||[pageWidth](/javascript/api/word/word.pagesetup#word-word-pagesetup-pagewidth-member)|Specifies the page width in points.| +||[paperSize](/javascript/api/word/word.pagesetup#word-word-pagesetup-papersize-member)|Specifies the paper size of the page.| +||[rightMargin](/javascript/api/word/word.pagesetup#word-word-pagesetup-rightmargin-member)|Specifies the distance (in points) between the right edge of the page and the right boundary of the body text.| +||[sectionDirection](/javascript/api/word/word.pagesetup#word-word-pagesetup-sectiondirection-member)|Specifies the reading order and alignment for the specified sections.| +||[sectionStart](/javascript/api/word/word.pagesetup#word-word-pagesetup-sectionstart-member)|Specifies the type of section break for the specified object.| +||[setAsTemplateDefault()](/javascript/api/word/word.pagesetup#word-word-pagesetup-setastemplatedefault-member(1))|Sets the specified page setup formatting as the default for the active document and all new documents based on the active template.| +||[showGrid](/javascript/api/word/word.pagesetup#word-word-pagesetup-showgrid-member)|Specifies whether to show the grid.| +||[suppressEndnotes](/javascript/api/word/word.pagesetup#word-word-pagesetup-suppressendnotes-member)|Specifies if endnotes are printed at the end of the next section that doesn't suppress endnotes.| +||[textColumns](/javascript/api/word/word.pagesetup#word-word-pagesetup-textcolumns-member)|Gets a `TextColumnCollection` object that represents the set of text columns for the `PageSetup` object.| +||[togglePortrait()](/javascript/api/word/word.pagesetup#word-word-pagesetup-toggleportrait-member(1))|Switches between portrait and landscape page orientations for a document or section.| +||[topMargin](/javascript/api/word/word.pagesetup#word-word-pagesetup-topmargin-member)|Specifies the top margin of the page in points.| +||[twoPagesOnOne](/javascript/api/word/word.pagesetup#word-word-pagesetup-twopagesonone-member)|Specifies whether to print two pages per sheet.| +||[verticalAlignment](/javascript/api/word/word.pagesetup#word-word-pagesetup-verticalalignment-member)|Specifies the vertical alignment of text on each page in a document or section.| +|[Pane](/javascript/api/word/word.pane)|[selection](/javascript/api/word/word.pane#word-word-pane-selection-member)|Returns a `Selection` object that represents the current selection in the pane.| +|[PaneCollection](/javascript/api/word/word.panecollection)||| +|[Paragraph](/javascript/api/word/word.paragraph)|[borders](/javascript/api/word/word.paragraph#word-word-paragraph-borders-member)|Returns a `BorderUniversalCollection` object that represents all the borders for the paragraph.| +||[closeUp()](/javascript/api/word/word.paragraph#word-word-paragraph-closeup-member(1))|Removes any spacing before the paragraph.| +||[indent()](/javascript/api/word/word.paragraph#word-word-paragraph-indent-member(1))|Indents the paragraph by one level.| +||[indentCharacterWidth(count: number)](/javascript/api/word/word.paragraph#word-word-paragraph-indentcharacterwidth-member(1))|Indents the paragraph by a specified number of characters.| +||[indentFirstLineCharacterWidth(count: number)](/javascript/api/word/word.paragraph#word-word-paragraph-indentfirstlinecharacterwidth-member(1))|Indents the first line of the paragraph by the specified number of characters.| +||[joinList()](/javascript/api/word/word.paragraph#word-word-paragraph-joinlist-member(1))|Joins a list paragraph with the closest list above or below this paragraph.| +||[next(count: number)](/javascript/api/word/word.paragraph#word-word-paragraph-next-member(1))|Returns a `Paragraph` object that represents the next paragraph.| +||[onCommentAdded](/javascript/api/word/word.paragraph#word-word-paragraph-oncommentadded-member)|Occurs when new comments are added.| +||[onCommentChanged](/javascript/api/word/word.paragraph#word-word-paragraph-oncommentchanged-member)|Occurs when a comment or its reply is changed.| +||[onCommentDeleted](/javascript/api/word/word.paragraph#word-word-paragraph-oncommentdeleted-member)|Occurs when comments are deleted.| +||[onCommentDeselected](/javascript/api/word/word.paragraph#word-word-paragraph-oncommentdeselected-member)|Occurs when a comment is deselected.| +||[onCommentSelected](/javascript/api/word/word.paragraph#word-word-paragraph-oncommentselected-member)|Occurs when a comment is selected.| +||[openOrCloseUp()](/javascript/api/word/word.paragraph#word-word-paragraph-openorcloseup-member(1))|Toggles the spacing before the paragraph.| +||[openUp()](/javascript/api/word/word.paragraph#word-word-paragraph-openup-member(1))|Sets spacing before the paragraph to 12 points.| +||[outdent()](/javascript/api/word/word.paragraph#word-word-paragraph-outdent-member(1))|Removes one level of indent for the paragraph.| +||[outlineDemote()](/javascript/api/word/word.paragraph#word-word-paragraph-outlinedemote-member(1))|Applies the next heading level style (Heading 1 through Heading 8) to the paragraph.| +||[outlineDemoteToBody()](/javascript/api/word/word.paragraph#word-word-paragraph-outlinedemotetobody-member(1))|Demotes the paragraph to body text by applying the Normal style.| +||[outlinePromote()](/javascript/api/word/word.paragraph#word-word-paragraph-outlinepromote-member(1))|Applies the previous heading level style (Heading 1 through Heading 8) to the paragraph.| +||[previous(count: number)](/javascript/api/word/word.paragraph#word-word-paragraph-previous-member(1))|Returns the previous paragraph as a `Paragraph` object.| +||[reset()](/javascript/api/word/word.paragraph#word-word-paragraph-reset-member(1))|Removes manual paragraph formatting (formatting not applied using a style).| +||[resetAdvanceTo()](/javascript/api/word/word.paragraph#word-word-paragraph-resetadvanceto-member(1))|Resets the paragraph that uses custom list levels to the original level settings.| +||[selectNumber()](/javascript/api/word/word.paragraph#word-word-paragraph-selectnumber-member(1))|Selects the number or bullet in a list.| +||[separateList()](/javascript/api/word/word.paragraph#word-word-paragraph-separatelist-member(1))|Separates a list into two separate lists.| +||[shading](/javascript/api/word/word.paragraph#word-word-paragraph-shading-member)|Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph.| +||[space1()](/javascript/api/word/word.paragraph#word-word-paragraph-space1-member(1))|Sets the paragraph to single spacing.| +||[space1Pt5()](/javascript/api/word/word.paragraph#word-word-paragraph-space1pt5-member(1))|Sets the paragraph to 1.5-line spacing.| +||[space2()](/javascript/api/word/word.paragraph#word-word-paragraph-space2-member(1))|Sets the paragraph to double spacing.| +||[tabHangingIndent(count: number)](/javascript/api/word/word.paragraph#word-word-paragraph-tabhangingindent-member(1))|Sets a hanging indent to a specified number of tab stops.| +||[tabIndent(count: number)](/javascript/api/word/word.paragraph#word-word-paragraph-tabindent-member(1))|Sets the left indent for the paragraph to a specified number of tab stops.| +|[ParagraphAddedEventArgs](/javascript/api/word/word.paragraphaddedeventargs)|[type](/javascript/api/word/word.paragraphaddedeventargs#word-word-paragraphaddedeventargs-type-member)|The event type.| +|[ParagraphChangedEventArgs](/javascript/api/word/word.paragraphchangedeventargs)|[type](/javascript/api/word/word.paragraphchangedeventargs#word-word-paragraphchangedeventargs-type-member)|The event type.| +|[ParagraphCollection](/javascript/api/word/word.paragraphcollection)|[add(range: Word.Range)](/javascript/api/word/word.paragraphcollection#word-word-paragraphcollection-add-member(1))|Returns a `Paragraph` object that represents a new, blank paragraph added to the document.| +||[closeUp()](/javascript/api/word/word.paragraphcollection#word-word-paragraphcollection-closeup-member(1))|Removes any spacing before the specified paragraphs.| +||[decreaseSpacing()](/javascript/api/word/word.paragraphcollection#word-word-paragraphcollection-decreasespacing-member(1))|Decreases the spacing before and after paragraphs in six-point increments.| +||[increaseSpacing()](/javascript/api/word/word.paragraphcollection#word-word-paragraphcollection-increasespacing-member(1))|Increases the spacing before and after paragraphs in six-point increments.| +||[indent()](/javascript/api/word/word.paragraphcollection#word-word-paragraphcollection-indent-member(1))|Indents the paragraphs by one level.| +||[indentCharacterWidth(count: number)](/javascript/api/word/word.paragraphcollection#word-word-paragraphcollection-indentcharacterwidth-member(1))|Indents the paragraphs in the collection by the specified number of characters.| +||[indentFirstLineCharacterWidth(count: number)](/javascript/api/word/word.paragraphcollection#word-word-paragraphcollection-indentfirstlinecharacterwidth-member(1))|Indents the first line of the paragraphs in the collection by the specified number of characters.| +||[openOrCloseUp()](/javascript/api/word/word.paragraphcollection#word-word-paragraphcollection-openorcloseup-member(1))|Toggles spacing before paragraphs.| +||[openUp()](/javascript/api/word/word.paragraphcollection#word-word-paragraphcollection-openup-member(1))|Sets spacing before the specified paragraphs to 12 points.| +||[outdent()](/javascript/api/word/word.paragraphcollection#word-word-paragraphcollection-outdent-member(1))|Removes one level of indent for the paragraphs.| +||[outlineDemote()](/javascript/api/word/word.paragraphcollection#word-word-paragraphcollection-outlinedemote-member(1))|Applies the next heading level style (Heading 1 through Heading 8) to the specified paragraphs.| +||[outlineDemoteToBody()](/javascript/api/word/word.paragraphcollection#word-word-paragraphcollection-outlinedemotetobody-member(1))|Demotes the specified paragraphs to body text by applying the Normal style.| +||[outlinePromote()](/javascript/api/word/word.paragraphcollection#word-word-paragraphcollection-outlinepromote-member(1))|Applies the previous heading level style (Heading 1 through Heading 8) to the paragraphs in the collection.| +||[space1()](/javascript/api/word/word.paragraphcollection#word-word-paragraphcollection-space1-member(1))|Sets the specified paragraphs to single spacing.| +||[space1Pt5()](/javascript/api/word/word.paragraphcollection#word-word-paragraphcollection-space1pt5-member(1))|Sets the specified paragraphs to 1.5-line spacing.| +||[space2()](/javascript/api/word/word.paragraphcollection#word-word-paragraphcollection-space2-member(1))|Sets the specified paragraphs to double spacing.| +||[tabHangingIndent(count: number)](/javascript/api/word/word.paragraphcollection#word-word-paragraphcollection-tabhangingindent-member(1))|Sets a hanging indent to the specified number of tab stops.| +||[tabIndent(count: number)](/javascript/api/word/word.paragraphcollection#word-word-paragraphcollection-tabindent-member(1))|Sets the left indent for the specified paragraphs to the specified number of tab stops.| +|[ParagraphDeletedEventArgs](/javascript/api/word/word.paragraphdeletedeventargs)|[type](/javascript/api/word/word.paragraphdeletedeventargs#word-word-paragraphdeletedeventargs-type-member)|The event type.| +|[PictureContentControl](/javascript/api/word/word.picturecontentcontrol)|[appearance](/javascript/api/word/word.picturecontentcontrol#word-word-picturecontentcontrol-appearance-member)|Specifies the appearance of the content control.| +||[color](/javascript/api/word/word.picturecontentcontrol#word-word-picturecontentcontrol-color-member)|Specifies the red-green-blue (RGB) value of the color of the content control.| +||[copy()](/javascript/api/word/word.picturecontentcontrol#word-word-picturecontentcontrol-copy-member(1))|Copies the content control from the active document to the Clipboard.| +||[cut()](/javascript/api/word/word.picturecontentcontrol#word-word-picturecontentcontrol-cut-member(1))|Removes the content control from the active document and moves the content control to the Clipboard.| +||[delete(deleteContents?: boolean)](/javascript/api/word/word.picturecontentcontrol#word-word-picturecontentcontrol-delete-member(1))|Deletes the content control and optionally its contents.| +||[id](/javascript/api/word/word.picturecontentcontrol#word-word-picturecontentcontrol-id-member)|Returns the identification for the content control.| +||[isTemporary](/javascript/api/word/word.picturecontentcontrol#word-word-picturecontentcontrol-istemporary-member)|Specifies whether to remove the content control from the active document when the user edits the contents of the control.| +||[level](/javascript/api/word/word.picturecontentcontrol#word-word-picturecontentcontrol-level-member)|Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline.| +||[lockContentControl](/javascript/api/word/word.picturecontentcontrol#word-word-picturecontentcontrol-lockcontentcontrol-member)|Specifies if the content control is locked (can't be deleted).| +||[lockContents](/javascript/api/word/word.picturecontentcontrol#word-word-picturecontentcontrol-lockcontents-member)|Specifies if the contents of the content control are locked (not editable).| +||[placeholderText](/javascript/api/word/word.picturecontentcontrol#word-word-picturecontentcontrol-placeholdertext-member)|Returns a `BuildingBlock` object that represents the placeholder text for the content control.| +||[range](/javascript/api/word/word.picturecontentcontrol#word-word-picturecontentcontrol-range-member)|Returns a `Range` object that represents the contents of the content control in the active document.| +||[setPlaceholderText(options?: Word.ContentControlPlaceholderOptions)](/javascript/api/word/word.picturecontentcontrol#word-word-picturecontentcontrol-setplaceholdertext-member(1))|Sets the placeholder text that displays in the content control until a user enters their own text.| +||[showingPlaceholderText](/javascript/api/word/word.picturecontentcontrol#word-word-picturecontentcontrol-showingplaceholdertext-member)|Returns whether the placeholder text for the content control is being displayed.| +||[tag](/javascript/api/word/word.picturecontentcontrol#word-word-picturecontentcontrol-tag-member)|Specifies a tag to identify the content control.| +||[title](/javascript/api/word/word.picturecontentcontrol#word-word-picturecontentcontrol-title-member)|Specifies the title for the content control.| +||[xmlMapping](/javascript/api/word/word.picturecontentcontrol#word-word-picturecontentcontrol-xmlmapping-member)|Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document.| +|[Range](/javascript/api/word/word.range)|[bold](/javascript/api/word/word.range#word-word-range-bold-member)|Specifies whether the range is formatted as bold.| +||[boldBidirectional](/javascript/api/word/word.range#word-word-range-boldbidirectional-member)|Specifies whether the range is formatted as bold in a right-to-left language document.| +||[bookmarks](/javascript/api/word/word.range#word-word-range-bookmarks-member)|Returns a `BookmarkCollection` object that represents all the bookmarks in the range.| +||[borders](/javascript/api/word/word.range#word-word-range-borders-member)|Returns a `BorderUniversalCollection` object that represents all the borders for the range.| +||[case](/javascript/api/word/word.range#word-word-range-case-member)|Specifies a `CharacterCase` value that represents the case of the text in the range.| +||[characterWidth](/javascript/api/word/word.range#word-word-range-characterwidth-member)|Specifies the character width of the range.| +||[combineCharacters](/javascript/api/word/word.range#word-word-range-combinecharacters-member)|Specifies if the range contains combined characters.| +||[conflicts](/javascript/api/word/word.range#word-word-range-conflicts-member)|Returns a `ConflictCollection` object that contains all the Word.Conflict objects in the range.| +||[detectLanguage()](/javascript/api/word/word.range#word-word-range-detectlanguage-member(1))|Analyzes the range text to determine the language that it's written in.| +||[disableCharacterSpaceGrid](/javascript/api/word/word.range#word-word-range-disablecharacterspacegrid-member)|Specifies if Microsoft Word ignores the number of characters per line for the corresponding `Range` object.| +||[editors](/javascript/api/word/word.range#word-word-range-editors-member)|Returns an `EditorCollection` object that represents all the users authorized to modify the range when the document is in protected (read-only) mode.| +||[emphasisMark](/javascript/api/word/word.range#word-word-range-emphasismark-member)|Specifies the emphasis mark for a character or designated character string.| +||[end](/javascript/api/word/word.range#word-word-range-end-member)|Specifies the ending character position of the range.| +||[fitTextWidth](/javascript/api/word/word.range#word-word-range-fittextwidth-member)|Specifies the width (in the current measurement units) in which Microsoft Word fits the text in the current selection or range.| +||[frames](/javascript/api/word/word.range#word-word-range-frames-member)|Gets a `FrameCollection` object that represents all the frames in the range.| +||[grammarChecked](/javascript/api/word/word.range#word-word-range-grammarchecked-member)|Specifies if a grammar check has been run on the range or document.| +||[hasNoProofing](/javascript/api/word/word.range#word-word-range-hasnoproofing-member)|Specifies the proofing status (spelling and grammar checking) of the range.| +||[highlightColorIndex](/javascript/api/word/word.range#word-word-range-highlightcolorindex-member)|Specifies the highlight color for the range.| +||[horizontalInVertical](/javascript/api/word/word.range#word-word-range-horizontalinvertical-member)|Specifies the formatting for horizontal text set within vertical text.| +||[hyperlinks](/javascript/api/word/word.range#word-word-range-hyperlinks-member)|Returns a `HyperlinkCollection` object that represents all the hyperlinks in the range.| +||[id](/javascript/api/word/word.range#word-word-range-id-member)|Specifies the ID for the range.| +||[isEndOfRowMark](/javascript/api/word/word.range#word-word-range-isendofrowmark-member)|Gets if the range is collapsed and is located at the end-of-row mark in a table.| +||[isTextVisibleOnScreen](/javascript/api/word/word.range#word-word-range-istextvisibleonscreen-member)|Gets whether the text in the range is visible on the screen.| +||[italic](/javascript/api/word/word.range#word-word-range-italic-member)|Specifies if the font or range is formatted as italic.| +||[italicBidirectional](/javascript/api/word/word.range#word-word-range-italicbidirectional-member)|Specifies if the font or range is formatted as italic (right-to-left languages).| +||[kana](/javascript/api/word/word.range#word-word-range-kana-member)|Specifies whether the range of Japanese language text is hiragana or katakana.| +||[languageDetected](/javascript/api/word/word.range#word-word-range-languagedetected-member)|Specifies whether Microsoft Word has detected the language of the text in the range.| +||[languageId](/javascript/api/word/word.range#word-word-range-languageid-member)|Specifies a `LanguageId` value that represents the language for the range.| +||[languageIdFarEast](/javascript/api/word/word.range#word-word-range-languageidfareast-member)|Specifies an East Asian language for the range.| +||[languageIdOther](/javascript/api/word/word.range#word-word-range-languageidother-member)|Specifies a language for the range that isn't classified as an East Asian language.| +||[listFormat](/javascript/api/word/word.range#word-word-range-listformat-member)|Returns a `ListFormat` object that represents all the list formatting characteristics of the range.| +||[onCommentAdded](/javascript/api/word/word.range#word-word-range-oncommentadded-member)|Occurs when new comments are added.| +||[onCommentChanged](/javascript/api/word/word.range#word-word-range-oncommentchanged-member)|Occurs when a comment or its reply is changed.| +||[onCommentDeselected](/javascript/api/word/word.range#word-word-range-oncommentdeselected-member)|Occurs when a comment is deselected.| +||[onCommentSelected](/javascript/api/word/word.range#word-word-range-oncommentselected-member)|Occurs when a comment is selected.| +||[revisions](/javascript/api/word/word.range#word-word-range-revisions-member)|Gets the collection of revisions that represents the tracked changes in the range.| +||[sections](/javascript/api/word/word.range#word-word-range-sections-member)|Gets the collection of sections in the range.| +||[shading](/javascript/api/word/word.range#word-word-range-shading-member)|Returns a `ShadingUniversal` object that refers to the shading formatting for the range.| +||[showAll](/javascript/api/word/word.range#word-word-range-showall-member)|Specifies if all nonprinting characters (such as hidden text, tab marks, space marks, and paragraph marks) are displayed.| +||[spellingChecked](/javascript/api/word/word.range#word-word-range-spellingchecked-member)|Specifies if spelling has been checked throughout the range or document.| +||[start](/javascript/api/word/word.range#word-word-range-start-member)|Specifies the starting character position of the range.| +||[storyLength](/javascript/api/word/word.range#word-word-range-storylength-member)|Gets the number of characters in the story that contains the range.| +||[storyType](/javascript/api/word/word.range#word-word-range-storytype-member)|Gets the story type for the range.| +||[tableColumns](/javascript/api/word/word.range#word-word-range-tablecolumns-member)|Gets a `TableColumnCollection` object that represents all the table columns in the range.| +||[twoLinesInOne](/javascript/api/word/word.range#word-word-range-twolinesinone-member)|Specifies whether Microsoft Word sets two lines of text in one and specifies the characters that enclose the text, if any.| +||[underline](/javascript/api/word/word.range#word-word-range-underline-member)|Specifies the type of underline applied to the range.| +|[RangeScopedCollection](/javascript/api/word/word.rangescopedcollection)|[getItem(index: number)](/javascript/api/word/word.rangescopedcollection#word-word-rangescopedcollection-getitem-member(1))|Gets a `Range` object by its index in the collection.| +||[items](/javascript/api/word/word.rangescopedcollection#word-word-rangescopedcollection-items-member)|Gets the loaded child items in this collection.| +|[ReflectionFormat](/javascript/api/word/word.reflectionformat)|[blur](/javascript/api/word/word.reflectionformat#word-word-reflectionformat-blur-member)|Specifies the degree of blur effect applied to the `ReflectionFormat` object as a value between 0.0 and 100.0.| +||[offset](/javascript/api/word/word.reflectionformat#word-word-reflectionformat-offset-member)|Specifies the amount of separation, in points, of the reflected image from the shape.| +||[size](/javascript/api/word/word.reflectionformat#word-word-reflectionformat-size-member)|Specifies the size of the reflection as a percentage of the reflected shape from 0 to 100.| +||[transparency](/javascript/api/word/word.reflectionformat#word-word-reflectionformat-transparency-member)|Specifies the degree of transparency for the reflection effect as a value between 0.0 (opaque) and 1.0 (clear).| +||[type](/javascript/api/word/word.reflectionformat#word-word-reflectionformat-type-member)|Specifies a `ReflectionType` value that represents the type and direction of the lighting for a shape reflection.| +|[RepeatingSectionContentControl](/javascript/api/word/word.repeatingsectioncontentcontrol)|[allowInsertDeleteSection](/javascript/api/word/word.repeatingsectioncontentcontrol#word-word-repeatingsectioncontentcontrol-allowinsertdeletesection-member)|Specifies whether users can add or remove sections from this repeating section content control by using the user interface.| +||[appearance](/javascript/api/word/word.repeatingsectioncontentcontrol#word-word-repeatingsectioncontentcontrol-appearance-member)|Specifies the appearance of the content control.| +||[color](/javascript/api/word/word.repeatingsectioncontentcontrol#word-word-repeatingsectioncontentcontrol-color-member)|Specifies the red-green-blue (RGB) value of the color of the content control.| +||[copy()](/javascript/api/word/word.repeatingsectioncontentcontrol#word-word-repeatingsectioncontentcontrol-copy-member(1))|Copies the content control from the active document to the Clipboard.| +||[cut()](/javascript/api/word/word.repeatingsectioncontentcontrol#word-word-repeatingsectioncontentcontrol-cut-member(1))|Removes the content control from the active document and moves the content control to the Clipboard.| +||[delete(deleteContents?: boolean)](/javascript/api/word/word.repeatingsectioncontentcontrol#word-word-repeatingsectioncontentcontrol-delete-member(1))|Deletes the content control and the contents of the content control.| +||[id](/javascript/api/word/word.repeatingsectioncontentcontrol#word-word-repeatingsectioncontentcontrol-id-member)|Returns the identification for the content control.| +||[isTemporary](/javascript/api/word/word.repeatingsectioncontentcontrol#word-word-repeatingsectioncontentcontrol-istemporary-member)|Specifies whether to remove the content control from the active document when the user edits the contents of the control.| +||[level](/javascript/api/word/word.repeatingsectioncontentcontrol#word-word-repeatingsectioncontentcontrol-level-member)|Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline.| +||[lockContentControl](/javascript/api/word/word.repeatingsectioncontentcontrol#word-word-repeatingsectioncontentcontrol-lockcontentcontrol-member)|Specifies if the content control is locked (can't be deleted).| +||[lockContents](/javascript/api/word/word.repeatingsectioncontentcontrol#word-word-repeatingsectioncontentcontrol-lockcontents-member)|Specifies if the contents of the content control are locked (not editable).| +||[placeholderText](/javascript/api/word/word.repeatingsectioncontentcontrol#word-word-repeatingsectioncontentcontrol-placeholdertext-member)|Returns a `BuildingBlock` object that represents the placeholder text for the content control.| +||[range](/javascript/api/word/word.repeatingsectioncontentcontrol#word-word-repeatingsectioncontentcontrol-range-member)|Gets a `Range` object that represents the contents of the content control in the active document.| +||[repeatingSectionItemTitle](/javascript/api/word/word.repeatingsectioncontentcontrol#word-word-repeatingsectioncontentcontrol-repeatingsectionitemtitle-member)|Specifies the name of the repeating section items used in the context menu associated with this repeating section content control.| +||[repeatingSectionItems](/javascript/api/word/word.repeatingsectioncontentcontrol#word-word-repeatingsectioncontentcontrol-repeatingsectionitems-member)|Returns the collection of repeating section items in this repeating section content control.| +||[setPlaceholderText(options?: Word.ContentControlPlaceholderOptions)](/javascript/api/word/word.repeatingsectioncontentcontrol#word-word-repeatingsectioncontentcontrol-setplaceholdertext-member(1))|Sets the placeholder text that displays in the content control until a user enters their own text.| +||[showingPlaceholderText](/javascript/api/word/word.repeatingsectioncontentcontrol#word-word-repeatingsectioncontentcontrol-showingplaceholdertext-member)|Returns whether the placeholder text for the content control is being displayed.| +||[tag](/javascript/api/word/word.repeatingsectioncontentcontrol#word-word-repeatingsectioncontentcontrol-tag-member)|Specifies a tag to identify the content control.| +||[title](/javascript/api/word/word.repeatingsectioncontentcontrol#word-word-repeatingsectioncontentcontrol-title-member)|Specifies the title for the content control.| +||[xmlapping](/javascript/api/word/word.repeatingsectioncontentcontrol#word-word-repeatingsectioncontentcontrol-xmlapping-member)|Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document.| +|[RepeatingSectionItem](/javascript/api/word/word.repeatingsectionitem)|[delete()](/javascript/api/word/word.repeatingsectionitem#word-word-repeatingsectionitem-delete-member(1))|Deletes this `RepeatingSectionItem` object.| +||[insertItemAfter()](/javascript/api/word/word.repeatingsectionitem#word-word-repeatingsectionitem-insertitemafter-member(1))|Adds a repeating section item after this item and returns the new item.| +||[insertItemBefore()](/javascript/api/word/word.repeatingsectionitem#word-word-repeatingsectionitem-insertitembefore-member(1))|Adds a repeating section item before this item and returns the new item.| +||[range](/javascript/api/word/word.repeatingsectionitem#word-word-repeatingsectionitem-range-member)|Returns the range of this repeating section item, excluding the start and end tags.| +|[RepeatingSectionItemCollection](/javascript/api/word/word.repeatingsectionitemcollection)|[getItemAt(index: number)](/javascript/api/word/word.repeatingsectionitemcollection#word-word-repeatingsectionitemcollection-getitemat-member(1))|Returns an individual repeating section item.| +|[Reviewer](/javascript/api/word/word.reviewer)|[isVisible](/javascript/api/word/word.reviewer#word-word-reviewer-isvisible-member)|Specifies if the `Reviewer` object is visible.| +|[ReviewerCollection](/javascript/api/word/word.reviewercollection)|[getItem(index: number)](/javascript/api/word/word.reviewercollection#word-word-reviewercollection-getitem-member(1))|Returns a `Reviewer` object that represents the specified item in the collection.| +||[items](/javascript/api/word/word.reviewercollection#word-word-reviewercollection-items-member)|Gets the loaded child items in this collection.| +|[Revision](/javascript/api/word/word.revision)|[accept()](/javascript/api/word/word.revision#word-word-revision-accept-member(1))|Accepts the tracked change, removes the revision mark, and incorporates the change into the document.| +||[author](/javascript/api/word/word.revision#word-word-revision-author-member)|Gets the name of the user who made the tracked change.| +||[date](/javascript/api/word/word.revision#word-word-revision-date-member)|Gets the date and time when the tracked change was made.| +||[formatDescription](/javascript/api/word/word.revision#word-word-revision-formatdescription-member)|Gets the description of tracked formatting changes in the revision.| +||[index](/javascript/api/word/word.revision#word-word-revision-index-member)|Gets a number that represents the position of this item in a collection.| +||[movedRange](/javascript/api/word/word.revision#word-word-revision-movedrange-member)|Gets a `Range` object that represents the range of text that was moved from one place to another in the document with tracked changes.| +||[range](/javascript/api/word/word.revision#word-word-revision-range-member)|Gets a `Range` object that represents the portion of the document that's contained within a revision mark.| +||[reject()](/javascript/api/word/word.revision#word-word-revision-reject-member(1))|Rejects the tracked change.| +||[type](/javascript/api/word/word.revision#word-word-revision-type-member)|Gets the revision type.| +|[RevisionCollection](/javascript/api/word/word.revisioncollection)|[acceptAll()](/javascript/api/word/word.revisioncollection#word-word-revisioncollection-acceptall-member(1))|Accepts all the tracked changes in the document or range, removes all revision marks, and incorporates the changes into the document.| +||[getItem(index: number)](/javascript/api/word/word.revisioncollection#word-word-revisioncollection-getitem-member(1))|Returns a `Revision` object that represents the specified item in the collection.| +||[items](/javascript/api/word/word.revisioncollection#word-word-revisioncollection-items-member)|Gets the loaded child items in this collection.| +||[rejectAll()](/javascript/api/word/word.revisioncollection#word-word-revisioncollection-rejectall-member(1))|Rejects all the tracked changes in the document or range.| +|[RevisionsFilter](/javascript/api/word/word.revisionsfilter)|[markup](/javascript/api/word/word.revisionsfilter#word-word-revisionsfilter-markup-member)|Specifies a `RevisionsMarkup` value that represents the extent of reviewer markup displayed in the document.| +||[reviewers](/javascript/api/word/word.revisionsfilter#word-word-revisionsfilter-reviewers-member)|Gets the `ReviewerCollection` object that represents the collection of reviewers of one or more documents.| +||[toggleShowAllReviewers()](/javascript/api/word/word.revisionsfilter#word-word-revisionsfilter-toggleshowallreviewers-member(1))|Shows or hides all revisions in the document that contain comments and tracked changes.| +||[view](/javascript/api/word/word.revisionsfilter#word-word-revisionsfilter-view-member)|Specifies a `RevisionsView` value that represents globally whether Word displays the original version of the document or the final version, which might have revisions and formatting changes applied.| +|[Section](/javascript/api/word/word.section)|[borders](/javascript/api/word/word.section#word-word-section-borders-member)|Returns a `BorderUniversalCollection` object that represents all the borders in the section.| +||[pageSetup](/javascript/api/word/word.section#word-word-section-pagesetup-member)|Returns a `PageSetup` object that's associated with the section.| +||[protectedForForms](/javascript/api/word/word.section#word-word-section-protectedforforms-member)|Specifies if the section is protected for forms.| +|[Selection](/javascript/api/word/word.selection)|[borders](/javascript/api/word/word.selection#word-word-selection-borders-member)|Returns a `BorderUniversalCollection` object that represents all the borders for the objects in the selection.| +||[calculate()](/javascript/api/word/word.selection#word-word-selection-calculate-member(1))|Calculates the first mathematical expression within the selection.| +||[cancelMode()](/javascript/api/word/word.selection#word-word-selection-cancelmode-member(1))|Cancels a mode such as extend or column select.| +||[characters](/javascript/api/word/word.selection#word-word-selection-characters-member)|Returns a `RangeScopedCollection` object that represents each character in the selection.| +||[clearCharacterStyleFormatting()](/javascript/api/word/word.selection#word-word-selection-clearcharacterstyleformatting-member(1))|Removes character formatting applied through character styles.| +||[clearFormatting()](/javascript/api/word/word.selection#word-word-selection-clearformatting-member(1))|Removes character and paragraph formatting from the selection.| +||[clearManualCharacterFormatting()](/javascript/api/word/word.selection#word-word-selection-clearmanualcharacterformatting-member(1))|Removes manually applied character formatting from the selected text.| +||[clearManualParagraphFormatting()](/javascript/api/word/word.selection#word-word-selection-clearmanualparagraphformatting-member(1))|Removes manually applied paragraph formatting from the selected text.| +||[clearParagraphFormatting()](/javascript/api/word/word.selection#word-word-selection-clearparagraphformatting-member(1))|Removes all paragraph formatting from the selected text.| +||[clearParagraphStyle()](/javascript/api/word/word.selection#word-word-selection-clearparagraphstyle-member(1))|Removes paragraph formatting applied through paragraph styles.| +||[collapse(direction?: Word.CollapseDirection)](/javascript/api/word/word.selection#word-word-selection-collapse-member(1))|Collapses the selection to the starting or ending position.| +||[comments](/javascript/api/word/word.selection#word-word-selection-comments-member)|Returns a `CommentCollection` object that represents all the comments in the selection.| +||[convertToTable(options?: Word.SelectionConvertToTableOptions)](/javascript/api/word/word.selection#word-word-selection-converttotable-member(1))|Converts text within a range to a table.| +||[copyAsPictureToClipboard()](/javascript/api/word/word.selection#word-word-selection-copyaspicturetoclipboard-member(1))|Copies the selection to the Clipboard as a picture.| +||[copyFormat()](/javascript/api/word/word.selection#word-word-selection-copyformat-member(1))|Copies the character formatting of the first character in the selected text.| +||[copyToClipboard()](/javascript/api/word/word.selection#word-word-selection-copytoclipboard-member(1))|Copies the selection to the Clipboard.| +||[createTextBox()](/javascript/api/word/word.selection#word-word-selection-createtextbox-member(1))|Adds a default-sized text box around the selection.| +||[cut()](/javascript/api/word/word.selection#word-word-selection-cut-member(1))|Removes the selected content from the document and moves it to the Clipboard.| +||[delete(options?: Word.SelectionDeleteOptions)](/javascript/api/word/word.selection#word-word-selection-delete-member(1))|Deletes the specified number of characters or words.| +||[detectLanguage()](/javascript/api/word/word.selection#word-word-selection-detectlanguage-member(1))|Analyzes the selected text to determine the language that it's written in.| +||[end](/javascript/api/word/word.selection#word-word-selection-end-member)|Specifies the ending character position of the selection.| +||[expand(unit?: Word.OperationUnit)](/javascript/api/word/word.selection#word-word-selection-expand-member(1))|Expands the selection.| +||[expandToWholeStory()](/javascript/api/word/word.selection#word-word-selection-expandtowholestory-member(1))|Expands the selection to include the entire story.| +||[extend(character?: Word.OperationUnit)](/javascript/api/word/word.selection#word-word-selection-extend-member(1))|Turns on extend mode, or if extend mode is already on, extends the selection to the next larger unit of text.| +||[fields](/javascript/api/word/word.selection#word-word-selection-fields-member)|Returns a `FieldCollection` object that represents all the fields in the selection.| +||[fitTextWidth](/javascript/api/word/word.selection#word-word-selection-fittextwidth-member)|Specifies the width in which Word fits the text in the current selection.| +||[font](/javascript/api/word/word.selection#word-word-selection-font-member)|Returns the `Font` object that represents the character formatting of the selection.| +||[formattedText](/javascript/api/word/word.selection#word-word-selection-formattedtext-member)|Specifies a `Range` object that includes the formatted text in the range or selection.| +||[getNextRange(options?: Word.SelectionNextOptions)](/javascript/api/word/word.selection#word-word-selection-getnextrange-member(1))|Returns a `Range` object that represents the next unit relative to the selection.| +||[getPreviousRange(options?: Word.SelectionPreviousOptions)](/javascript/api/word/word.selection#word-word-selection-getpreviousrange-member(1))|Returns a `Range` object that represents the previous unit relative to the selection.| +||[goTo(options?: Word.SelectionGoToOptions)](/javascript/api/word/word.selection#word-word-selection-goto-member(1))|Returns a `Range` object that represents the area specified by the `options` and moves the insertion point to the character position immediately preceding the specified item.| +||[goToNext(what: Word.GoToItem)](/javascript/api/word/word.selection#word-word-selection-gotonext-member(1))|Returns a `Range` object that refers to the start position of the next item or location specified by the `what` argument and moves the selection to the specified item.| +||[goToPrevious(what: Word.GoToItem)](/javascript/api/word/word.selection#word-word-selection-gotoprevious-member(1))|Returns a `Range` object that refers to the start position of the previous item or location specified by the `what` argument and moves the selection to the specified item.| +||[hasNoProofing](/javascript/api/word/word.selection#word-word-selection-hasnoproofing-member)|Returns whether the spelling and grammar checker ignores the selected text.| +||[insertAfter(text: string)](/javascript/api/word/word.selection#word-word-selection-insertafter-member(1))|Inserts the specified text at the end of the range or selection.| +||[insertBefore(text: string)](/javascript/api/word/word.selection#word-word-selection-insertbefore-member(1))|Inserts the specified text before the selection.| +||[insertCells(shiftCells?: Word.TableCellInsertionLocation)](/javascript/api/word/word.selection#word-word-selection-insertcells-member(1))|Adds cells to an existing table.| +||[insertColumnsLeft()](/javascript/api/word/word.selection#word-word-selection-insertcolumnsleft-member(1))|Inserts columns to the left of the column that contains the selection.| +||[insertColumnsRight()](/javascript/api/word/word.selection#word-word-selection-insertcolumnsright-member(1))|Inserts columns to the right of the current selection.| +||[insertDateTime(options?: Word.SelectionInsertDateTimeOptions)](/javascript/api/word/word.selection#word-word-selection-insertdatetime-member(1))|Inserts the current date or time, or both, either as text or as a {@link https://support.microsoft.com/office/6cb8fcef-310a-4646-ae6b-886d88335c90 | TIME field}.| +||[insertFormula(options?: Word.SelectionInsertFormulaOptions)](/javascript/api/word/word.selection#word-word-selection-insertformula-member(1))|Inserts a {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | Formula field} at the selection.| +||[insertNewPage()](/javascript/api/word/word.selection#word-word-selection-insertnewpage-member(1))|Inserts a new page at the position of the insertion point.| +||[insertParagraphAfter()](/javascript/api/word/word.selection#word-word-selection-insertparagraphafter-member(1))|Inserts a paragraph mark after the selection.| +||[insertParagraphBefore()](/javascript/api/word/word.selection#word-word-selection-insertparagraphbefore-member(1))|Inserts a new paragraph before the selection or range.| +||[insertParagraphStyleSeparator()](/javascript/api/word/word.selection#word-word-selection-insertparagraphstyleseparator-member(1))|Inserts a special hidden paragraph mark that allows Word to join paragraphs formatted using different paragraph styles.| +||[insertRowsAbove(numRows: number)](/javascript/api/word/word.selection#word-word-selection-insertrowsabove-member(1))|Inserts rows above the current selection.| +||[insertRowsBelow(numRows: number)](/javascript/api/word/word.selection#word-word-selection-insertrowsbelow-member(1))|Inserts rows below the current selection.| +||[insertSymbol(characterNumber: number, options?: Word.SelectionInsertSymbolOptions)](/javascript/api/word/word.selection#word-word-selection-insertsymbol-member(1))|Inserts a symbol in place of the specified selection.| +||[insertText(Text: string)](/javascript/api/word/word.selection#word-word-selection-inserttext-member(1))|Inserts the specified text.| +||[insertXML(xml: string, transform?: string)](/javascript/api/word/word.selection#word-word-selection-insertxml-member(1))|Inserts the specified XML into the document at the cursor, replacing any selected text.| +||[isActive](/javascript/api/word/word.selection#word-word-selection-isactive-member)|Returns whether the selection in the specified window or pane is active.| +||[isColumnSelectModeActive](/javascript/api/word/word.selection#word-word-selection-iscolumnselectmodeactive-member)|Specifies whether column selection mode is active.| +||[isEndOfRowMark](/javascript/api/word/word.selection#word-word-selection-isendofrowmark-member)|Returns whether the selection is at the end-of-row mark in a table.| +||[isEqual(range: Word.Range)](/javascript/api/word/word.selection#word-word-selection-isequal-member(1))|Returns whether the selection is equal to the specified range.| +||[isExtendModeActive](/javascript/api/word/word.selection#word-word-selection-isextendmodeactive-member)|Specifies whether Extend mode is active.| +||[isInRange(range: Word.Range)](/javascript/api/word/word.selection#word-word-selection-isinrange-member(1))|Returns `true` if the selection is contained within the specified range.| +||[isInStory(range: Word.Range)](/javascript/api/word/word.selection#word-word-selection-isinstory-member(1))|Returns whether the selection is in the same story as the specified range.| +||[isInsertionPointAtEndOfLine](/javascript/api/word/word.selection#word-word-selection-isinsertionpointatendofline-member)|Returns whether the insertion point is at the end of a line.| +||[isStartActive](/javascript/api/word/word.selection#word-word-selection-isstartactive-member)|Specifies whether the beginning of the selection is active.| +||[languageDetected](/javascript/api/word/word.selection#word-word-selection-languagedetected-member)|Specifies whether Word has detected the language of the selected text.| +||[languageId](/javascript/api/word/word.selection#word-word-selection-languageid-member)|Returns the language for the selection.| +||[languageIdFarEast](/javascript/api/word/word.selection#word-word-selection-languageidfareast-member)|Returns the East Asian language for the selection.| +||[languageIdOther](/javascript/api/word/word.selection#word-word-selection-languageidother-member)|Returns the language for the selection that isn't classified as an East Asian language.| +||[move(options?: Word.SelectionMoveOptions)](/javascript/api/word/word.selection#word-word-selection-move-member(1))|Collapses the selection to its start or end position and then moves the collapsed object by the specified number of units.| +||[moveDown(options?: Word.SelectionMoveUpDownOptions)](/javascript/api/word/word.selection#word-word-selection-movedown-member(1))|Moves the selection down.| +||[moveEnd(options?: Word.SelectionMoveStartEndOptions)](/javascript/api/word/word.selection#word-word-selection-moveend-member(1))|Moves the ending character position of the range or selection.| +||[moveEndUntil(characters: string, count?: number)](/javascript/api/word/word.selection#word-word-selection-moveenduntil-member(1))|Moves the end position of the selection until any of the specified characters are found in the document.| +||[moveEndWhile(characters: string, count?: number)](/javascript/api/word/word.selection#word-word-selection-moveendwhile-member(1))|Moves the ending character position of the selection while any of the specified characters are found in the document.| +||[moveLeft(options?: Word.SelectionMoveLeftRightOptions)](/javascript/api/word/word.selection#word-word-selection-moveleft-member(1))|Moves the selection to the left.| +||[moveRight(options?: Word.SelectionMoveLeftRightOptions)](/javascript/api/word/word.selection#word-word-selection-moveright-member(1))|Moves the selection to the right.| +||[moveStart(options?: Word.SelectionMoveStartEndOptions)](/javascript/api/word/word.selection#word-word-selection-movestart-member(1))|Moves the start position of the selection.| +||[moveStartUntil(characters: string, count?: number)](/javascript/api/word/word.selection#word-word-selection-movestartuntil-member(1))|Moves the start position of the selection until one of the specified characters is found in the document.| +||[moveStartWhile(characters: string, count?: number)](/javascript/api/word/word.selection#word-word-selection-movestartwhile-member(1))|Moves the start position of the selection while any of the specified characters are found in the document.| +||[moveUntil(characters: string, count?: number)](/javascript/api/word/word.selection#word-word-selection-moveuntil-member(1))|Moves the selection until one of the specified characters is found in the document.| +||[moveUp(options?: Word.SelectionMoveUpDownOptions)](/javascript/api/word/word.selection#word-word-selection-moveup-member(1))|Moves the selection up.| +||[moveWhile(characters: string, count?: number)](/javascript/api/word/word.selection#word-word-selection-movewhile-member(1))|Moves the selection while any of the specified characters are found in the document.| +||[nextField()](/javascript/api/word/word.selection#word-word-selection-nextfield-member(1))|Selects the next field.| +||[nextSubdocument()](/javascript/api/word/word.selection#word-word-selection-nextsubdocument-member(1))|Moves the selection to the next subDocument.| +||[orientation](/javascript/api/word/word.selection#word-word-selection-orientation-member)|Specifies the orientation of text in the selection.| +||[paragraphs](/javascript/api/word/word.selection#word-word-selection-paragraphs-member)|Returns a `ParagraphCollection` object that represents all the paragraphs in the selection.| +||[pasteAndFormat(type: Word.PasteFormatType)](/javascript/api/word/word.selection#word-word-selection-pasteandformat-member(1))|Pastes the content from clipboard and formats them as specified.| +||[pasteExcelTable(linkedToExcel: boolean, wordFormatting: boolean, rtf: boolean)](/javascript/api/word/word.selection#word-word-selection-pasteexceltable-member(1))|Pastes and formats a Microsoft Excel table.| +||[pasteFormat()](/javascript/api/word/word.selection#word-word-selection-pasteformat-member(1))|Applies formatting copied with the `copyFormat` method to the selection.| +||[pasteTableCellsAppendTable()](/javascript/api/word/word.selection#word-word-selection-pastetablecellsappendtable-member(1))|Merges pasted cells into an existing table by inserting the pasted rows between the selected rows.| +||[pasteTableCellsAsNestedTable()](/javascript/api/word/word.selection#word-word-selection-pastetablecellsasnestedtable-member(1))|Pastes a cell or group of cells as a nested table into the selection.| +||[previousField()](/javascript/api/word/word.selection#word-word-selection-previousfield-member(1))|Selects and returns the previous field.| +||[previousSubdocument()](/javascript/api/word/word.selection#word-word-selection-previoussubdocument-member(1))|Moves the selection to the previous subDocument.| +||[range](/javascript/api/word/word.selection#word-word-selection-range-member)|Returns the `Range` object for the portion of the document contained in the selection.| +||[replaceParagraph()](/javascript/api/word/word.selection#word-word-selection-replaceparagraph-member(1))|Replaces the selection with a new paragraph.| +||[sections](/javascript/api/word/word.selection#word-word-selection-sections-member)|Returns the `SectionCollection` object in the selection.| +||[select()](/javascript/api/word/word.selection#word-word-selection-select-member(1))|Selects the current text.| +||[selectCell()](/javascript/api/word/word.selection#word-word-selection-selectcell-member(1))|Selects the entire cell containing the current selection when the selection is in a table.| +||[selectColumn()](/javascript/api/word/word.selection#word-word-selection-selectcolumn-member(1))|Selects the column that contains the insertion point, or selects all columns that contain the selection when the selection is in a table.| +||[selectCurrentAlignment()](/javascript/api/word/word.selection#word-word-selection-selectcurrentalignment-member(1))|Extends the selection forward until text with a different paragraph alignment is encountered.| +||[selectCurrentColor()](/javascript/api/word/word.selection#word-word-selection-selectcurrentcolor-member(1))|Extends the selection forward until text with a different color is encountered.| +||[selectCurrentFont()](/javascript/api/word/word.selection#word-word-selection-selectcurrentfont-member(1))|Extends the selection forward until text in a different font or font size is encountered.| +||[selectCurrentIndent()](/javascript/api/word/word.selection#word-word-selection-selectcurrentindent-member(1))|Extends the selection forward until text with different left or right paragraph indents is encountered.| +||[selectCurrentSpacing()](/javascript/api/word/word.selection#word-word-selection-selectcurrentspacing-member(1))|Extends the selection forward until a paragraph with different line spacing is encountered.| +||[selectCurrentTabs()](/javascript/api/word/word.selection#word-word-selection-selectcurrenttabs-member(1))|Extends the selection forward until a paragraph with different tab stops is encountered.| +||[selectRow()](/javascript/api/word/word.selection#word-word-selection-selectrow-member(1))|Selects the row that contains the insertion point, or selects all rows that contain the selection when the selection is in a table.| +||[sentences](/javascript/api/word/word.selection#word-word-selection-sentences-member)|Returns the `RangeScopedCollection` object for each sentence in the selection.| +||[setRange(start: number, end: number)](/javascript/api/word/word.selection#word-word-selection-setrange-member(1))|Sets the starting and ending character positions for the selection.| +||[shading](/javascript/api/word/word.selection#word-word-selection-shading-member)|Returns the `ShadingUniversal` object for the shading formatting for the selection.| +||[shrink()](/javascript/api/word/word.selection#word-word-selection-shrink-member(1))|Shrinks the selection to the next smaller unit of text.| +||[shrinkDiscontiguousSelection()](/javascript/api/word/word.selection#word-word-selection-shrinkdiscontiguousselection-member(1))|Cancels the selection of all but the most recently selected text when the current selection contains multiple, unconnected selections.| +||[splitTable()](/javascript/api/word/word.selection#word-word-selection-splittable-member(1))|Inserts an empty paragraph above the first row in the selection.| +||[start](/javascript/api/word/word.selection#word-word-selection-start-member)|Specifies the starting character position of the selection.| +||[storyLength](/javascript/api/word/word.selection#word-word-selection-storylength-member)|Returns the number of characters in the story that contains the selection.| +||[storyType](/javascript/api/word/word.selection#word-word-selection-storytype-member)|Returns the story type for the selection.| +||[tables](/javascript/api/word/word.selection#word-word-selection-tables-member)|Returns the `TableCollection` object in the selection.| +||[text](/javascript/api/word/word.selection#word-word-selection-text-member)|Specifies the text in the selection.| +||[toggleCharacterCode()](/javascript/api/word/word.selection#word-word-selection-togglecharactercode-member(1))|Switches the selection between a Unicode character and its corresponding hexadecimal value.| +||[topLevelTables](/javascript/api/word/word.selection#word-word-selection-topleveltables-member)|Returns the tables at the outermost nesting level in the current selection.| +||[type](/javascript/api/word/word.selection#word-word-selection-type-member)|Returns the selection type.| +||[typeBackspace()](/javascript/api/word/word.selection#word-word-selection-typebackspace-member(1))|Deletes the character preceding the selection (if collapsed) or the insertion point.| +||[words](/javascript/api/word/word.selection#word-word-selection-words-member)|Returns the `RangeScopedCollection` object that represents each word in the selection.| +|[SelectionConvertToTableOptions](/javascript/api/word/word.selectionconverttotableoptions)|[applyBorders](/javascript/api/word/word.selectionconverttotableoptions#word-word-selectionconverttotableoptions-applyborders-member)|If provided, specifies whether to apply borders to the table of the specified format.| +||[applyColor](/javascript/api/word/word.selectionconverttotableoptions#word-word-selectionconverttotableoptions-applycolor-member)|If provided, specifies whether to apply color formatting to the table of the specified format.| +||[applyFirstColumn](/javascript/api/word/word.selectionconverttotableoptions#word-word-selectionconverttotableoptions-applyfirstcolumn-member)|If provided, specifies whether to apply special formatting to the first column of the specified format.| +||[applyFont](/javascript/api/word/word.selectionconverttotableoptions#word-word-selectionconverttotableoptions-applyfont-member)|If provided, specifies whether to apply font formatting to the table of the specified format.| +||[applyHeadingRows](/javascript/api/word/word.selectionconverttotableoptions#word-word-selectionconverttotableoptions-applyheadingrows-member)|If provided, specifies whether to format the first row as a header row of the specified format.| +||[applyLastColumn](/javascript/api/word/word.selectionconverttotableoptions#word-word-selectionconverttotableoptions-applylastcolumn-member)|If provided, specifies whether to apply special formatting to the last column of the specified format.| +||[applyLastRow](/javascript/api/word/word.selectionconverttotableoptions#word-word-selectionconverttotableoptions-applylastrow-member)|If provided, specifies whether to apply special formatting to the last row of the specified format.| +||[applyShading](/javascript/api/word/word.selectionconverttotableoptions#word-word-selectionconverttotableoptions-applyshading-member)|If provided, specifies whether to apply shading to the table of the specified format.| +||[autoFit](/javascript/api/word/word.selectionconverttotableoptions#word-word-selectionconverttotableoptions-autofit-member)|If provided, specifies whether to automatically resize the table to fit the contents.| +||[autoFitBehavior](/javascript/api/word/word.selectionconverttotableoptions#word-word-selectionconverttotableoptions-autofitbehavior-member)|If provided, specifies the auto-fit behavior for the table.| +||[defaultTableBehavior](/javascript/api/word/word.selectionconverttotableoptions#word-word-selectionconverttotableoptions-defaulttablebehavior-member)|If provided, specifies whether Microsoft Word automatically resizes cells in a table to fit the contents.| +||[format](/javascript/api/word/word.selectionconverttotableoptions#word-word-selectionconverttotableoptions-format-member)|If provided, specifies a preset format to apply to the table.| +||[initialColumnWidth](/javascript/api/word/word.selectionconverttotableoptions#word-word-selectionconverttotableoptions-initialcolumnwidth-member)|If provided, specifies the initial width of each column in the table, in points.| +||[numColumns](/javascript/api/word/word.selectionconverttotableoptions#word-word-selectionconverttotableoptions-numcolumns-member)|If provided, specifies the number of columns in the table.| +||[numRows](/javascript/api/word/word.selectionconverttotableoptions#word-word-selectionconverttotableoptions-numrows-member)|If provided, specifies the number of rows in the table.| +||[separator](/javascript/api/word/word.selectionconverttotableoptions#word-word-selectionconverttotableoptions-separator-member)|If provided, specifies the character used to separate text into cells.| +|[SelectionDeleteOptions](/javascript/api/word/word.selectiondeleteoptions)|[count](/javascript/api/word/word.selectiondeleteoptions#word-word-selectiondeleteoptions-count-member)|If provided, specifies the number of units to be deleted.| +||[unit](/javascript/api/word/word.selectiondeleteoptions#word-word-selectiondeleteoptions-unit-member)|If provided, specifies the unit by which the collapsed selection is to be deleted.| +|[SelectionGoToOptions](/javascript/api/word/word.selectiongotooptions)|[count](/javascript/api/word/word.selectiongotooptions#word-word-selectiongotooptions-count-member)|If provided, specifies the number of the item in the document.| +||[direction](/javascript/api/word/word.selectiongotooptions#word-word-selectiongotooptions-direction-member)|If provided, specifies the direction the range or selection is moved to.| +||[item](/javascript/api/word/word.selectiongotooptions#word-word-selectiongotooptions-item-member)|If provided, specifies the kind of item the range or selection is moved to.| +||[name](/javascript/api/word/word.selectiongotooptions#word-word-selectiongotooptions-name-member)|If provided, specifies the name if the `item` property is set to Word.GoToItem type `bookmark`, `comment`, `field`, or `object`.| +|[SelectionInsertCrossReferenceOptions](/javascript/api/word/word.selectioninsertcrossreferenceoptions)|[includePosition](/javascript/api/word/word.selectioninsertcrossreferenceoptions#word-word-selectioninsertcrossreferenceoptions-includeposition-member)|If provided, specifies whether to include position.| +||[insertAsHyperlink](/javascript/api/word/word.selectioninsertcrossreferenceoptions#word-word-selectioninsertcrossreferenceoptions-insertashyperlink-member)|If provided, specifies whether to insert the cross-reference as a hyperlink.| +||[separateNumbers](/javascript/api/word/word.selectioninsertcrossreferenceoptions#word-word-selectioninsertcrossreferenceoptions-separatenumbers-member)|If provided, specifies whether to use a separator to separate the numbers from the associated text.| +||[separatorString](/javascript/api/word/word.selectioninsertcrossreferenceoptions#word-word-selectioninsertcrossreferenceoptions-separatorstring-member)|If provided, specifies the string to use as a separator if the `separateNumbers` parameter is set to `true` when the `Selection.insertCrossReference` method is called.| +|[SelectionInsertDateTimeOptions](/javascript/api/word/word.selectioninsertdatetimeoptions)|[calendarType](/javascript/api/word/word.selectioninsertdatetimeoptions#word-word-selectioninsertdatetimeoptions-calendartype-member)|If provided, specifies the calendar type to use when displaying the date or time.| +||[dateLanguage](/javascript/api/word/word.selectioninsertdatetimeoptions#word-word-selectioninsertdatetimeoptions-datelanguage-member)|If provided, specifies the language in which to display the date or time.| +||[dateTimeFormat](/javascript/api/word/word.selectioninsertdatetimeoptions#word-word-selectioninsertdatetimeoptions-datetimeformat-member)|If provided, specifies the format to be used for displaying the date or time, or both.| +||[insertAsField](/javascript/api/word/word.selectioninsertdatetimeoptions#word-word-selectioninsertdatetimeoptions-insertasfield-member)|If provided, specifies whether to insert the specified information as a {@link https://support.microsoft.com/office/6cb8fcef-310a-4646-ae6b-886d88335c90 | TIME field}.| +||[insertAsFullWidth](/javascript/api/word/word.selectioninsertdatetimeoptions#word-word-selectioninsertdatetimeoptions-insertasfullwidth-member)|If provided, specifies whether to insert the specified information as full-width (double-byte) digits.| +|[SelectionInsertFormulaOptions](/javascript/api/word/word.selectioninsertformulaoptions)|[formula](/javascript/api/word/word.selectioninsertformulaoptions#word-word-selectioninsertformulaoptions-formula-member)|If provided, specifies the mathematical formula you want the {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | = (Formula) field} to evaluate.| +||[numberFormat](/javascript/api/word/word.selectioninsertformulaoptions#word-word-selectioninsertformulaoptions-numberformat-member)|If provided, specifies the format for the result of the `= (Formula)` field.| +|[SelectionInsertSymbolOptions](/javascript/api/word/word.selectioninsertsymboloptions)|[bias](/javascript/api/word/word.selectioninsertsymboloptions#word-word-selectioninsertsymboloptions-bias-member)|If provided, specifies the font bias for symbols.| +||[font](/javascript/api/word/word.selectioninsertsymboloptions#word-word-selectioninsertsymboloptions-font-member)|If provided, specifies the name of the font that contains the symbol.| +||[unicode](/javascript/api/word/word.selectioninsertsymboloptions#word-word-selectioninsertsymboloptions-unicode-member)|If provided, specifies whether the character is Unicode.| +|[SelectionMoveLeftRightOptions](/javascript/api/word/word.selectionmoveleftrightoptions)|[count](/javascript/api/word/word.selectionmoveleftrightoptions#word-word-selectionmoveleftrightoptions-count-member)|If provided, specifies the number of units the selection is to be moved.| +||[extend](/javascript/api/word/word.selectionmoveleftrightoptions#word-word-selectionmoveleftrightoptions-extend-member)|If provided, specifies the type of movement.| +||[unit](/javascript/api/word/word.selectionmoveleftrightoptions#word-word-selectionmoveleftrightoptions-unit-member)|If provided, specifies the unit by which the selection is to be moved.| +|[SelectionMoveOptions](/javascript/api/word/word.selectionmoveoptions)|[count](/javascript/api/word/word.selectionmoveoptions#word-word-selectionmoveoptions-count-member)|If provided, specifies the number of units by which the range or selection is to be moved.| +||[unit](/javascript/api/word/word.selectionmoveoptions#word-word-selectionmoveoptions-unit-member)|If provided, specifies the unit by which to move the ending character position.| +|[SelectionMoveStartEndOptions](/javascript/api/word/word.selectionmovestartendoptions)|[count](/javascript/api/word/word.selectionmovestartendoptions#word-word-selectionmovestartendoptions-count-member)|If provided, specifies the number of units to move.| +||[unit](/javascript/api/word/word.selectionmovestartendoptions#word-word-selectionmovestartendoptions-unit-member)|If provided, specifies the unit by which the selection's start or end position (per the calling method) is to be moved.| +|[SelectionMoveUpDownOptions](/javascript/api/word/word.selectionmoveupdownoptions)|[count](/javascript/api/word/word.selectionmoveupdownoptions#word-word-selectionmoveupdownoptions-count-member)|If provided, specifies the number of units the selection is to be moved.| +||[extend](/javascript/api/word/word.selectionmoveupdownoptions#word-word-selectionmoveupdownoptions-extend-member)|If provided, specifies the type of movement.| +||[unit](/javascript/api/word/word.selectionmoveupdownoptions#word-word-selectionmoveupdownoptions-unit-member)|If provided, specifies the unit by which to move the selection.| +|[SelectionNextOptions](/javascript/api/word/word.selectionnextoptions)|[count](/javascript/api/word/word.selectionnextoptions#word-word-selectionnextoptions-count-member)|If provided, specifies the number of units by which you want to move ahead.| +||[unit](/javascript/api/word/word.selectionnextoptions#word-word-selectionnextoptions-unit-member)|If provided, specifies the type of units by which to move the selection.| +|[SelectionPreviousOptions](/javascript/api/word/word.selectionpreviousoptions)|[count](/javascript/api/word/word.selectionpreviousoptions#word-word-selectionpreviousoptions-count-member)|If provided, specifies the number of units by which you want to move.| +||[unit](/javascript/api/word/word.selectionpreviousoptions#word-word-selectionpreviousoptions-unit-member)|If provided, specifies the type of unit by which to move the selection.| +|[ShadingUniversal](/javascript/api/word/word.shadinguniversal)|[backgroundPatternColor](/javascript/api/word/word.shadinguniversal#word-word-shadinguniversal-backgroundpatterncolor-member)|Specifies the color that's applied to the background of the `ShadingUniversal` object.| +||[backgroundPatternColorIndex](/javascript/api/word/word.shadinguniversal#word-word-shadinguniversal-backgroundpatterncolorindex-member)|Specifies the color that's applied to the background of the `ShadingUniversal` object.| +||[foregroundPatternColor](/javascript/api/word/word.shadinguniversal#word-word-shadinguniversal-foregroundpatterncolor-member)|Specifies the color that's applied to the foreground of the `ShadingUniversal` object.| +||[foregroundPatternColorIndex](/javascript/api/word/word.shadinguniversal#word-word-shadinguniversal-foregroundpatterncolorindex-member)|Specifies the color that's applied to the foreground of the `ShadingUniversal` object.| +||[texture](/javascript/api/word/word.shadinguniversal#word-word-shadinguniversal-texture-member)|Specifies the shading texture of the object.| +|[ShadowFormat](/javascript/api/word/word.shadowformat)|[blur](/javascript/api/word/word.shadowformat#word-word-shadowformat-blur-member)|Specifies the blur level for a shadow format as a value between 0.0 and 100.0.| +||[foregroundColor](/javascript/api/word/word.shadowformat#word-word-shadowformat-foregroundcolor-member)|Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow.| +||[incrementOffsetX(increment: number)](/javascript/api/word/word.shadowformat#word-word-shadowformat-incrementoffsetx-member(1))|Changes the horizontal offset of the shadow by the number of points.| +||[incrementOffsetY(increment: number)](/javascript/api/word/word.shadowformat#word-word-shadowformat-incrementoffsety-member(1))|Changes the vertical offset of the shadow by the specified number of points.| +||[isVisible](/javascript/api/word/word.shadowformat#word-word-shadowformat-isvisible-member)|Specifies whether the object or the formatting applied to it is visible.| +||[obscured](/javascript/api/word/word.shadowformat#word-word-shadowformat-obscured-member)|Specifies `true` if the shadow of the shape appears filled in and is obscured by the shape, even if the shape has no fill,| +||[offsetX](/javascript/api/word/word.shadowformat#word-word-shadowformat-offsetx-member)|Specifies the horizontal offset (in points) of the shadow from the shape.| +||[offsetY](/javascript/api/word/word.shadowformat#word-word-shadowformat-offsety-member)|Specifies the vertical offset (in points) of the shadow from the shape.| +||[rotateWithShape](/javascript/api/word/word.shadowformat#word-word-shadowformat-rotatewithshape-member)|Specifies whether to rotate the shadow when rotating the shape.| +||[size](/javascript/api/word/word.shadowformat#word-word-shadowformat-size-member)|Specifies the width of the shadow.| +||[style](/javascript/api/word/word.shadowformat#word-word-shadowformat-style-member)|Specifies the type of shadow formatting to apply to a shape.| +||[transparency](/javascript/api/word/word.shadowformat#word-word-shadowformat-transparency-member)|Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear).| +||[type](/javascript/api/word/word.shadowformat#word-word-shadowformat-type-member)|Specifies the shape shadow type.| +|[Source](/javascript/api/word/word.source)|[delete()](/javascript/api/word/word.source#word-word-source-delete-member(1))|Deletes the `Source` object.| +||[getFieldByName(name: string)](/javascript/api/word/word.source#word-word-source-getfieldbyname-member(1))|Returns the value of a field in the bibliography `Source` object.| +||[isCited](/javascript/api/word/word.source#word-word-source-iscited-member)|Gets if the `Source` object has been cited in the document.| +||[tag](/javascript/api/word/word.source#word-word-source-tag-member)|Gets the tag of the source.| +||[xml](/javascript/api/word/word.source#word-word-source-xml-member)|Gets the XML representation of the source.| +|[SourceCollection](/javascript/api/word/word.sourcecollection)|[add(xml: string)](/javascript/api/word/word.sourcecollection#word-word-sourcecollection-add-member(1))|Adds a new `Source` object to the collection.| +||[getItem(index: number)](/javascript/api/word/word.sourcecollection#word-word-sourcecollection-getitem-member(1))|Gets a `Source` by its index in the collection.| +||[items](/javascript/api/word/word.sourcecollection#word-word-sourcecollection-items-member)|Gets the loaded child items in this collection.| +|[Style](/javascript/api/word/word.style)|[automaticallyUpdate](/javascript/api/word/word.style#word-word-style-automaticallyupdate-member)|Specifies whether the style is automatically redefined based on the selection.| +||[description](/javascript/api/word/word.style#word-word-style-description-member)|Gets the description of the specified style.| +||[frame](/javascript/api/word/word.style#word-word-style-frame-member)|Returns a `Frame` object that represents the frame formatting for the style.| +||[hasProofing](/javascript/api/word/word.style#word-word-style-hasproofing-member)|Specifies whether the spelling and grammar checker ignores text formatted with this style.| +||[languageId](/javascript/api/word/word.style#word-word-style-languageid-member)|Specifies a `LanguageId` value that represents the language for the style.| +||[languageIdFarEast](/javascript/api/word/word.style#word-word-style-languageidfareast-member)|Specifies an East Asian language for the style.| +||[linkStyle](/javascript/api/word/word.style#word-word-style-linkstyle-member)|Specifies a link between a paragraph and a character style.| +||[linkToListTemplate(listTemplate: Word.ListTemplate)](/javascript/api/word/word.style#word-word-style-linktolisttemplate-member(1))|Links this style to a list template so that the style's formatting can be applied to lists.| +||[listLevelNumber](/javascript/api/word/word.style#word-word-style-listlevelnumber-member)|Returns the list level for the style.| +||[locked](/javascript/api/word/word.style#word-word-style-locked-member)|Specifies whether the style cannot be changed or edited.| +||[noSpaceBetweenParagraphsOfSameStyle](/javascript/api/word/word.style#word-word-style-nospacebetweenparagraphsofsamestyle-member)|Specifies whether to remove spacing between paragraphs that are formatted using the same style.| +|[TabStop](/javascript/api/word/word.tabstop)|[alignment](/javascript/api/word/word.tabstop#word-word-tabstop-alignment-member)|Gets a `TabAlignment` value that represents the alignment for the tab stop.| +||[clear()](/javascript/api/word/word.tabstop#word-word-tabstop-clear-member(1))|Removes this custom tab stop.| +||[customTab](/javascript/api/word/word.tabstop#word-word-tabstop-customtab-member)|Gets whether this tab stop is a custom tab stop.| +||[leader](/javascript/api/word/word.tabstop#word-word-tabstop-leader-member)|Gets a `TabLeader` value that represents the leader for this `TabStop` object.| +||[next](/javascript/api/word/word.tabstop#word-word-tabstop-next-member)|Gets the next tab stop in the collection.| +||[position](/javascript/api/word/word.tabstop#word-word-tabstop-position-member)|Gets the position of the tab stop relative to the left margin.| +||[previous](/javascript/api/word/word.tabstop#word-word-tabstop-previous-member)|Gets the previous tab stop in the collection.| +|[TabStopAddOptions](/javascript/api/word/word.tabstopaddoptions)|[alignment](/javascript/api/word/word.tabstopaddoptions#word-word-tabstopaddoptions-alignment-member)|If provided, specifies the alignment of the tab stop.| +||[leader](/javascript/api/word/word.tabstopaddoptions#word-word-tabstopaddoptions-leader-member)|If provided, specifies the leader character for the tab stop.| +|[TabStopCollection](/javascript/api/word/word.tabstopcollection)|[add(position: number, options?: Word.TabStopAddOptions)](/javascript/api/word/word.tabstopcollection#word-word-tabstopcollection-add-member(1))|Returns a `TabStop` object that represents a custom tab stop added to the paragraph.| +||[after(Position: number)](/javascript/api/word/word.tabstopcollection#word-word-tabstopcollection-after-member(1))|Returns the next `TabStop` object to the right of the specified position.| +||[before(Position: number)](/javascript/api/word/word.tabstopcollection#word-word-tabstopcollection-before-member(1))|Returns the next `TabStop` object to the left of the specified position.| +||[clearAll()](/javascript/api/word/word.tabstopcollection#word-word-tabstopcollection-clearall-member(1))|Clears all the custom tab stops from the paragraph.| +||[getItem(index: number)](/javascript/api/word/word.tabstopcollection#word-word-tabstopcollection-getitem-member(1))|Gets a `TabStop` object by its index in the collection.| +||[items](/javascript/api/word/word.tabstopcollection#word-word-tabstopcollection-items-member)|Gets the loaded child items in this collection.| +|[Table](/javascript/api/word/word.table)|[applyStyleDirectFormatting(styleName: string)](/javascript/api/word/word.table#word-word-table-applystyledirectformatting-member(1))|Applies the specified style but maintains any formatting that a user directly applies.| +||[autoFitBehavior(behavior: Word.AutoFitBehavior)](/javascript/api/word/word.table#word-word-table-autofitbehavior-member(1))|Determines how Microsoft Word resizes a table when the AutoFit feature is used.| +||[autoFormat(options?: Word.TableAutoFormatOptions)](/javascript/api/word/word.table#word-word-table-autoformat-member(1))|Applies a predefined look to a table.| +||[columns](/javascript/api/word/word.table#word-word-table-columns-member)|Returns the `TableColumnCollection` object that represents the columns in the table.| +||[convertToText(options?: Word.TableConvertToTextOptions)](/javascript/api/word/word.table#word-word-table-converttotext-member(1))|Converts a table to text.| +||[description](/javascript/api/word/word.table#word-word-table-description-member)|Specifies the description of the table.| +||[reapplyAutoFormat()](/javascript/api/word/word.table#word-word-table-reapplyautoformat-member(1))|Updates the table with the characteristics of the predefined table format set when the `autoFormat` method was called.| +||[shading](/javascript/api/word/word.table#word-word-table-shading-member)|Returns the `ShadingUniversal` object that represents the shading of the table.| +||[sort(options?: Word.TableSortOptions)](/javascript/api/word/word.table#word-word-table-sort-member(1))|Sorts the specified table.| +||[title](/javascript/api/word/word.table#word-word-table-title-member)|Specifies the title of the table.| +|[TableAutoFormatOptions](/javascript/api/word/word.tableautoformatoptions)|[applyBorders](/javascript/api/word/word.tableautoformatoptions#word-word-tableautoformatoptions-applyborders-member)|If provided, specifies whether to apply borders of the specified format.| +||[applyColor](/javascript/api/word/word.tableautoformatoptions#word-word-tableautoformatoptions-applycolor-member)|If provided, specifies whether to apply color of the specified format.| +||[applyFirstColumn](/javascript/api/word/word.tableautoformatoptions#word-word-tableautoformatoptions-applyfirstcolumn-member)|If provided, specifies whether to apply first column formatting of the specified format.| +||[applyFont](/javascript/api/word/word.tableautoformatoptions#word-word-tableautoformatoptions-applyfont-member)|If provided, specifies whether to apply font of the specified format.| +||[applyHeadingRows](/javascript/api/word/word.tableautoformatoptions#word-word-tableautoformatoptions-applyheadingrows-member)|If provided, specifies whether to apply heading row formatting of the specified format.| +||[applyLastColumn](/javascript/api/word/word.tableautoformatoptions#word-word-tableautoformatoptions-applylastcolumn-member)|If provided, specifies whether to apply last column formatting of the specified format.| +||[applyLastRow](/javascript/api/word/word.tableautoformatoptions#word-word-tableautoformatoptions-applylastrow-member)|If provided, specifies whether to apply last row formatting of the specified format.| +||[applyShading](/javascript/api/word/word.tableautoformatoptions#word-word-tableautoformatoptions-applyshading-member)|If provided, specifies whether to apply shading of the specified format.| +||[autoFit](/javascript/api/word/word.tableautoformatoptions#word-word-tableautoformatoptions-autofit-member)|If provided, specifies whether to decrease the width of the table columns as much as possible without changing the way text wraps in the cells.| +||[format](/javascript/api/word/word.tableautoformatoptions#word-word-tableautoformatoptions-format-member)|If provided, specifies the format to apply.| +|[TableCell](/javascript/api/word/word.tablecell)|[autoSum()](/javascript/api/word/word.tablecell#word-word-tablecell-autosum-member(1))|Inserts a {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | = (Formula) field} that calculates and displays the sum of the values in table cells above or to the left of the cell specified in the expression.| +||[column](/javascript/api/word/word.tablecell#word-word-tablecell-column-member)|Returns the `TableColumn` object that represents the table column that contains this cell.| +||[delete(shiftCells: any)](/javascript/api/word/word.tablecell#word-word-tablecell-delete-member(1))|Deletes the table cell and optionally controls how the remaining cells are shifted.| +||[formula(options?: Word.TableCellFormulaOptions)](/javascript/api/word/word.tablecell#word-word-tablecell-formula-member(1))|Inserts a {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | = (Formula) field} that contains the specified formula into a table cell.| +||[merge(mergeTo: Word.TableCell)](/javascript/api/word/word.tablecell#word-word-tablecell-merge-member(1))|Merges this table cell with the specified table cell.| +||[select()](/javascript/api/word/word.tablecell#word-word-tablecell-select-member(1))|Selects the table cell.| +||[shading](/javascript/api/word/word.tablecell#word-word-tablecell-shading-member)|Returns the `ShadingUniversal` object that represents the shading of the table cell.| +|[TableCellCollection](/javascript/api/word/word.tablecellcollection)|[autoFit()](/javascript/api/word/word.tablecellcollection#word-word-tablecellcollection-autofit-member(1))|Changes the width of a table column to accommodate the width of the text without changing the way text wraps in the cells.| +||[delete(shiftCells?: Word.DeleteCells)](/javascript/api/word/word.tablecellcollection#word-word-tablecellcollection-delete-member(1))|Deletes the table cells and optionally controls how the remaining cells are shifted.| +||[distributeHeight()](/javascript/api/word/word.tablecellcollection#word-word-tablecellcollection-distributeheight-member(1))|Adjusts the height of the specified cells so that they are equal.| +||[distributeWidth()](/javascript/api/word/word.tablecellcollection#word-word-tablecellcollection-distributewidth-member(1))|Adjusts the width of the specified cells so that they are equal.| +||[merge()](/javascript/api/word/word.tablecellcollection#word-word-tablecellcollection-merge-member(1))|Merges the specified cells into a single cell.| +||[setHeight(rowHeight: number, heightRule: Word.RowHeightRule)](/javascript/api/word/word.tablecellcollection#word-word-tablecellcollection-setheight-member(1))|Sets the height of the cells in a table.| +||[setWidth(columnWidth: number, rulerStyle: Word.RulerStyle)](/javascript/api/word/word.tablecellcollection#word-word-tablecellcollection-setwidth-member(1))|Sets the width of the cells in a table.| +||[split(options?: Word.TableCellCollectionSplitOptions)](/javascript/api/word/word.tablecellcollection#word-word-tablecellcollection-split-member(1))|Splits this range of table cells.| +|[TableCellCollectionSplitOptions](/javascript/api/word/word.tablecellcollectionsplitoptions)|[mergeBeforeSplit](/javascript/api/word/word.tablecellcollectionsplitoptions#word-word-tablecellcollectionsplitoptions-mergebeforesplit-member)|If provided, specifies whether to merge the cells with one another before splitting them.| +||[numColumns](/javascript/api/word/word.tablecellcollectionsplitoptions#word-word-tablecellcollectionsplitoptions-numcolumns-member)|If provided, specifies the number of columns that the group of cells is to be split into.| +||[numRows](/javascript/api/word/word.tablecellcollectionsplitoptions#word-word-tablecellcollectionsplitoptions-numrows-member)|If provided, specifies the number of rows that the group of cells is to be split into.| +|[TableCellFormulaOptions](/javascript/api/word/word.tablecellformulaoptions)|[formula](/javascript/api/word/word.tablecellformulaoptions#word-word-tablecellformulaoptions-formula-member)|The mathematical formula you want the = (Formula) field to evaluate.| +||[numFormat](/javascript/api/word/word.tablecellformulaoptions#word-word-tablecellformulaoptions-numformat-member)|A format for the result of the {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | = (Formula) field}.| +|[TableColumn](/javascript/api/word/word.tablecolumn)|[autoFit()](/javascript/api/word/word.tablecolumn#word-word-tablecolumn-autofit-member(1))|Changes the width of the table column to accommodate the width of the text without changing the way text wraps in the cells.| +||[borders](/javascript/api/word/word.tablecolumn#word-word-tablecolumn-borders-member)|Returns a `BorderUniversalCollection` object that represents all the borders for the table column.| +||[columnIndex](/javascript/api/word/word.tablecolumn#word-word-tablecolumn-columnindex-member)|Returns the position of this column in a collection.| +||[delete()](/javascript/api/word/word.tablecolumn#word-word-tablecolumn-delete-member(1))|Deletes the column.| +||[isFirst](/javascript/api/word/word.tablecolumn#word-word-tablecolumn-isfirst-member)|Returns `true` if the column or row is the first one in the table; `false` otherwise.| +||[isLast](/javascript/api/word/word.tablecolumn#word-word-tablecolumn-islast-member)|Returns `true` if the column or row is the last one in the table; `false` otherwise.| +||[nestingLevel](/javascript/api/word/word.tablecolumn#word-word-tablecolumn-nestinglevel-member)|Returns the nesting level of the column.| +||[preferredWidth](/javascript/api/word/word.tablecolumn#word-word-tablecolumn-preferredwidth-member)|Specifies the preferred width (in points or as a percentage of the window width) for the column.| +||[preferredWidthType](/javascript/api/word/word.tablecolumn#word-word-tablecolumn-preferredwidthtype-member)|Specifies the preferred unit of measurement to use for the width of the table column.| +||[select()](/javascript/api/word/word.tablecolumn#word-word-tablecolumn-select-member(1))|Selects the table column.| +||[setWidth(columnWidth: number, rulerStyle: Word.RulerStyle)](/javascript/api/word/word.tablecolumn#word-word-tablecolumn-setwidth-member(1))|Sets the width of the column in a table.| +||[shading](/javascript/api/word/word.tablecolumn#word-word-tablecolumn-shading-member)|Returns a `ShadingUniversal` object that refers to the shading formatting for the column.| +||[sort()](/javascript/api/word/word.tablecolumn#word-word-tablecolumn-sort-member(1))|Sorts the table column.| +||[width](/javascript/api/word/word.tablecolumn#word-word-tablecolumn-width-member)|Specifies the width of the column, in points.| +|[TableColumnCollection](/javascript/api/word/word.tablecolumncollection)|[add(beforeColumn?: Word.TableColumn)](/javascript/api/word/word.tablecolumncollection#word-word-tablecolumncollection-add-member(1))|Returns a `TableColumn` object that represents a column added to a table.| +||[autoFit()](/javascript/api/word/word.tablecolumncollection#word-word-tablecolumncollection-autofit-member(1))|Changes the width of a table column to accommodate the width of the text without changing the way text wraps in the cells.| +||[delete()](/javascript/api/word/word.tablecolumncollection#word-word-tablecolumncollection-delete-member(1))|Deletes the specified columns.| +||[distributeWidth()](/javascript/api/word/word.tablecolumncollection#word-word-tablecolumncollection-distributewidth-member(1))|Adjusts the width of the specified columns so that they are equal.| +||[items](/javascript/api/word/word.tablecolumncollection#word-word-tablecolumncollection-items-member)|Gets the loaded child items in this collection.| +||[select()](/javascript/api/word/word.tablecolumncollection#word-word-tablecolumncollection-select-member(1))|Selects the specified table columns.| +||[setWidth(columnWidth: number, rulerStyle: Word.RulerStyle)](/javascript/api/word/word.tablecolumncollection#word-word-tablecolumncollection-setwidth-member(1))|Sets the width of columns in a table.| +|[TableConvertToTextOptions](/javascript/api/word/word.tableconverttotextoptions)|[nestedTables](/javascript/api/word/word.tableconverttotextoptions#word-word-tableconverttotextoptions-nestedtables-member)|If provided, specifies whether to convert the nested tables to text.| +||[separator](/javascript/api/word/word.tableconverttotextoptions#word-word-tableconverttotextoptions-separator-member)|If provided, specifies the character that delimits the converted columns (paragraph marks delimit the converted rows).| +|[TableOfAuthorities](/javascript/api/word/word.tableofauthorities)|[bookmark](/javascript/api/word/word.tableofauthorities#word-word-tableofauthorities-bookmark-member)|Specifies the name of the bookmark from which to collect table of authorities entries.| +||[category](/javascript/api/word/word.tableofauthorities#word-word-tableofauthorities-category-member)|Specifies the category of entries to be included in the table of authorities.| +||[delete()](/javascript/api/word/word.tableofauthorities#word-word-tableofauthorities-delete-member(1))|Deletes this table of authorities.| +||[entrySeparator](/javascript/api/word/word.tableofauthorities#word-word-tableofauthorities-entryseparator-member)|Specifies a separator of up to five characters.| +||[isCategoryHeaderIncluded](/javascript/api/word/word.tableofauthorities#word-word-tableofauthorities-iscategoryheaderincluded-member)|Specifies whether the category name for a group of entries appears in the table of authorities.| +||[isEntryFormattingKept](/javascript/api/word/word.tableofauthorities#word-word-tableofauthorities-isentryformattingkept-member)|Specifies whether the entries in the table of authorities are displayed with their formatting in the table.| +||[isPassimUsed](/javascript/api/word/word.tableofauthorities#word-word-tableofauthorities-ispassimused-member)|Specifies whether references to the same authority that are repeated on five or more pages are replaced with "Passim".| +||[pageNumberSeparator](/javascript/api/word/word.tableofauthorities#word-word-tableofauthorities-pagenumberseparator-member)|Specifies a separator of up to five characters.| +||[pageRangeSeparator](/javascript/api/word/word.tableofauthorities#word-word-tableofauthorities-pagerangeseparator-member)|Specifies a separator of up to five characters.| +||[range](/javascript/api/word/word.tableofauthorities#word-word-tableofauthorities-range-member)|Gets the portion of a document that is this table of authorities.| +||[sequenceName](/javascript/api/word/word.tableofauthorities#word-word-tableofauthorities-sequencename-member)|Specifies the {@link https://support.microsoft.com/office/062a387b-dfc9-4ef8-8235-29ee113d59be | Sequence (SEQ) field} identifier for the table of authorities.| +||[sequenceSeparator](/javascript/api/word/word.tableofauthorities#word-word-tableofauthorities-sequenceseparator-member)|Specifies a separator of up to five characters.| +||[tabLeader](/javascript/api/word/word.tableofauthorities#word-word-tableofauthorities-tableader-member)|Specifies the leader character that appears between entries and their associated page numbers in the table of authorities.| +|[TableOfAuthoritiesAddOptions](/javascript/api/word/word.tableofauthoritiesaddoptions)|[bookmark](/javascript/api/word/word.tableofauthoritiesaddoptions#word-word-tableofauthoritiesaddoptions-bookmark-member)|If provided, specifies the string name of the bookmark from which to collect entries for a table of authorities.| +||[category](/javascript/api/word/word.tableofauthoritiesaddoptions#word-word-tableofauthoritiesaddoptions-category-member)|If provided, specifies the category of entries to include in a table of authorities.| +||[entrySeparator](/javascript/api/word/word.tableofauthoritiesaddoptions#word-word-tableofauthoritiesaddoptions-entryseparator-member)|If provided, specifies a separator of up to five characters.| +||[includeCategoryHeader](/javascript/api/word/word.tableofauthoritiesaddoptions#word-word-tableofauthoritiesaddoptions-includecategoryheader-member)|If provided, specifies whether the category name for each group of entries appears in a table of authorities (e.g., "Cases").| +||[keepEntryFormatting](/javascript/api/word/word.tableofauthoritiesaddoptions#word-word-tableofauthoritiesaddoptions-keepentryformatting-member)|If provided, specifies whether the entries in a table of authorities are displayed with their formatting in the table.| +||[pageNumberSeparator](/javascript/api/word/word.tableofauthoritiesaddoptions#word-word-tableofauthoritiesaddoptions-pagenumberseparator-member)|If provided, specifies a separator of up to five characters.| +||[pageRangeSeparator](/javascript/api/word/word.tableofauthoritiesaddoptions#word-word-tableofauthoritiesaddoptions-pagerangeseparator-member)|If provided, specifies a separator of up to five characters.| +||[sequenceName](/javascript/api/word/word.tableofauthoritiesaddoptions#word-word-tableofauthoritiesaddoptions-sequencename-member)|If provided, specifies the string that identifies the Sequence (SEQ) field identifier for a table of authorities.| +||[sequenceSeparator](/javascript/api/word/word.tableofauthoritiesaddoptions#word-word-tableofauthoritiesaddoptions-sequenceseparator-member)|If provided, specifies a separator of up to five characters.| +||[usePassim](/javascript/api/word/word.tableofauthoritiesaddoptions#word-word-tableofauthoritiesaddoptions-usepassim-member)|If provided, specifies whether references to the same authority that are repeated on five or more pages are replaced with "Passim".| +|[TableOfAuthoritiesCategory](/javascript/api/word/word.tableofauthoritiescategory)|[name](/javascript/api/word/word.tableofauthoritiescategory#word-word-tableofauthoritiescategory-name-member)|Specifies the name of this table of authorities category.| +|[TableOfAuthoritiesCategoryCollection](/javascript/api/word/word.tableofauthoritiescategorycollection)|[getCount()](/javascript/api/word/word.tableofauthoritiescategorycollection#word-word-tableofauthoritiescategorycollection-getcount-member(1))|Returns the number of items in the collection.| +||[getItemAt(index: number)](/javascript/api/word/word.tableofauthoritiescategorycollection#word-word-tableofauthoritiescategorycollection-getitemat-member(1))|Returns a `TableOfAuthoritiesCategory` object that represents the specified item in the collection.| +||[items](/javascript/api/word/word.tableofauthoritiescategorycollection#word-word-tableofauthoritiescategorycollection-items-member)|Gets the loaded child items in this collection.| +|[TableOfAuthoritiesCollection](/javascript/api/word/word.tableofauthoritiescollection)|[add(range: Word.Range, options?: Word.TableOfAuthoritiesAddOptions)](/javascript/api/word/word.tableofauthoritiescollection#word-word-tableofauthoritiescollection-add-member(1))|Adds a table of authorities to the document at the specified range.| +||[items](/javascript/api/word/word.tableofauthoritiescollection#word-word-tableofauthoritiescollection-items-member)|Gets the loaded child items in this collection.| +||[markAllCitations(shortCitation: string, options?: Word.TableOfAuthoritiesMarkCitationOptions)](/javascript/api/word/word.tableofauthoritiescollection#word-word-tableofauthoritiescollection-markallcitations-member(1))|Inserts a {@link https://support.microsoft.com/office/2a90ad2b-4169-475d-8a09-e62521d4159c | Table of Authorities Entry (TA) field} after all instances of the specified citation text.| +||[markCitation(range: Word.Range, shortCitation: string, options?: Word.TableOfAuthoritiesMarkCitationOptions)](/javascript/api/word/word.tableofauthoritiescollection#word-word-tableofauthoritiescollection-markcitation-member(1))|Inserts a {@link https://support.microsoft.com/office/2a90ad2b-4169-475d-8a09-e62521d4159c | Table of Authorities Entry (TA) field} at the specified range.| +||[selectNextCitation(shortCitation: string)](/javascript/api/word/word.tableofauthoritiescollection#word-word-tableofauthoritiescollection-selectnextcitation-member(1))|Finds and selects the next instance of the specified citation text.| +|[TableOfAuthoritiesMarkCitationOptions](/javascript/api/word/word.tableofauthoritiesmarkcitationoptions)|[category](/javascript/api/word/word.tableofauthoritiesmarkcitationoptions#word-word-tableofauthoritiesmarkcitationoptions-category-member)|If provided, specifies the category number to be associated with the entry.| +||[longCitation](/javascript/api/word/word.tableofauthoritiesmarkcitationoptions#word-word-tableofauthoritiesmarkcitationoptions-longcitation-member)|If provided, specifies the long citation for the entry as it will appear in a table of authorities.| +||[longCitationAutoText](/javascript/api/word/word.tableofauthoritiesmarkcitationoptions#word-word-tableofauthoritiesmarkcitationoptions-longcitationautotext-member)|If provided, specifies the name of the AutoText entry that contains the text of the long citation as it will appear in a table of authorities.| +|[TableOfContents](/javascript/api/word/word.tableofcontents)|[additionalHeadingStyles](/javascript/api/word/word.tableofcontents#word-word-tableofcontents-additionalheadingstyles-member)|Gets the additional styles used for the table of contents.| +||[areBuiltInHeadingStylesUsed](/javascript/api/word/word.tableofcontents#word-word-tableofcontents-arebuiltinheadingstylesused-member)|Specifies whether built-in heading styles are used for the table of contents.| +||[areFieldsUsed](/javascript/api/word/word.tableofcontents#word-word-tableofcontents-arefieldsused-member)|Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of contents.| +||[areHyperlinksUsedOnWeb](/javascript/api/word/word.tableofcontents#word-word-tableofcontents-arehyperlinksusedonweb-member)|Specifies whether entries in the table of contents should be formatted as hyperlinks when publishing to the web.| +||[arePageNumbersHiddenOnWeb](/javascript/api/word/word.tableofcontents#word-word-tableofcontents-arepagenumbershiddenonweb-member)|Specifies whether the page numbers in the table of contents should be hidden when publishing to the web.| +||[arePageNumbersIncluded](/javascript/api/word/word.tableofcontents#word-word-tableofcontents-arepagenumbersincluded-member)|Specifies whether page numbers are included in the table of contents.| +||[arePageNumbersRightAligned](/javascript/api/word/word.tableofcontents#word-word-tableofcontents-arepagenumbersrightaligned-member)|Specifies whether page numbers are aligned with the right margin in the table of contents.| +||[delete()](/javascript/api/word/word.tableofcontents#word-word-tableofcontents-delete-member(1))|Deletes this table of contents.| +||[lowerHeadingLevel](/javascript/api/word/word.tableofcontents#word-word-tableofcontents-lowerheadinglevel-member)|Specifies the ending heading level for the table of contents.| +||[range](/javascript/api/word/word.tableofcontents#word-word-tableofcontents-range-member)|Gets the portion of a document that is this table of contents.| +||[tabLeader](/javascript/api/word/word.tableofcontents#word-word-tableofcontents-tableader-member)|Specifies the character between entries and their page numbers in the table of contents.| +||[tableId](/javascript/api/word/word.tableofcontents#word-word-tableofcontents-tableid-member)|Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of contents.| +||[updatePageNumbers()](/javascript/api/word/word.tableofcontents#word-word-tableofcontents-updatepagenumbers-member(1))|Updates the entire table of contents.| +||[upperHeadingLevel](/javascript/api/word/word.tableofcontents#word-word-tableofcontents-upperheadinglevel-member)|Specifies the starting heading level for the table of contents.| +|[TableOfContentsAddOptions](/javascript/api/word/word.tableofcontentsaddoptions)|[addedStyles](/javascript/api/word/word.tableofcontentsaddoptions#word-word-tableofcontentsaddoptions-addedstyles-member)|If provided, specifies the string names of additional styles to use for the table of contents.| +||[hidePageNumbersOnWeb](/javascript/api/word/word.tableofcontentsaddoptions#word-word-tableofcontentsaddoptions-hidepagenumbersonweb-member)|If provided, specifies whether the page numbers in a table of contents should be hidden when publishing to the web.| +||[includePageNumbers](/javascript/api/word/word.tableofcontentsaddoptions#word-word-tableofcontentsaddoptions-includepagenumbers-member)|If provided, specifies whether to include page numbers in a table of contents.| +||[lowerHeadingLevel](/javascript/api/word/word.tableofcontentsaddoptions#word-word-tableofcontentsaddoptions-lowerheadinglevel-member)|If provided, specifies the ending heading level for a table of contents and must be a value from 1 to 9.| +||[rightAlignPageNumbers](/javascript/api/word/word.tableofcontentsaddoptions#word-word-tableofcontentsaddoptions-rightalignpagenumbers-member)|If provided, specifies whether page numbers in a table of contents are aligned with the right margin.| +||[tableId](/javascript/api/word/word.tableofcontentsaddoptions#word-word-tableofcontentsaddoptions-tableid-member)|If provided, specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for a table of contents.| +||[upperHeadingLevel](/javascript/api/word/word.tableofcontentsaddoptions#word-word-tableofcontentsaddoptions-upperheadinglevel-member)|If provided, specifies the starting heading level for a table of contents and must be a value from 1 to 9.| +||[useBuiltInHeadingStyles](/javascript/api/word/word.tableofcontentsaddoptions#word-word-tableofcontentsaddoptions-usebuiltinheadingstyles-member)|If provided, specifies whether to use built-in heading styles to create a table of contents.| +||[useFields](/javascript/api/word/word.tableofcontentsaddoptions#word-word-tableofcontentsaddoptions-usefields-member)|If provided, specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are used to create a table of contents.| +||[useHyperlinksOnWeb](/javascript/api/word/word.tableofcontentsaddoptions#word-word-tableofcontentsaddoptions-usehyperlinksonweb-member)|If provided, specifies whether entries in a table of contents should be formatted as hyperlinks when the document is published to the web.| +||[useOutlineLevels](/javascript/api/word/word.tableofcontentsaddoptions#word-word-tableofcontentsaddoptions-useoutlinelevels-member)|If provided, specifies whether to use outline levels to create a table of contents.| +|[TableOfContentsCollection](/javascript/api/word/word.tableofcontentscollection)|[add(range: Word.Range, options?: Word.TableOfContentsAddOptions)](/javascript/api/word/word.tableofcontentscollection#word-word-tableofcontentscollection-add-member(1))|Adds a table of contents to the document at the specified range.| +||[items](/javascript/api/word/word.tableofcontentscollection#word-word-tableofcontentscollection-items-member)|Gets the loaded child items in this collection.| +||[markTocEntry(range: Word.Range, options?: Word.TableOfContentsMarkEntryOptions)](/javascript/api/word/word.tableofcontentscollection#word-word-tableofcontentscollection-marktocentry-member(1))|Inserts a {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) field} after the specified range.| +|[TableOfContentsMarkEntryOptions](/javascript/api/word/word.tableofcontentsmarkentryoptions)|[entry](/javascript/api/word/word.tableofcontentsmarkentryoptions#word-word-tableofcontentsmarkentryoptions-entry-member)|If provided, specifies the text that appears in a table of contents or table of figures.| +||[entryAutoText](/javascript/api/word/word.tableofcontentsmarkentryoptions#word-word-tableofcontentsmarkentryoptions-entryautotext-member)|If provided, specifies the AutoText entry name that includes text for the table of figures, or table of contents.| +||[level](/javascript/api/word/word.tableofcontentsmarkentryoptions#word-word-tableofcontentsmarkentryoptions-level-member)|If provided, specifies the level for the entry in a table of contents or table of figures and should be a value from 1 to 9.| +||[tableId](/javascript/api/word/word.tableofcontentsmarkentryoptions#word-word-tableofcontentsmarkentryoptions-tableid-member)|If provided, specifies a one-letter identifier for a table of contents or table of figures (e.g., "i" for an "illustration").| +|[TableOfFigures](/javascript/api/word/word.tableoffigures)|[additionalHeadingStyles](/javascript/api/word/word.tableoffigures#word-word-tableoffigures-additionalheadingstyles-member)|Gets the additional styles used for the table of figures.| +||[areBuiltInHeadingStylesUsed](/javascript/api/word/word.tableoffigures#word-word-tableoffigures-arebuiltinheadingstylesused-member)|Specifies whether built-in heading styles are used for the table of figures.| +||[areFieldsUsed](/javascript/api/word/word.tableoffigures#word-word-tableoffigures-arefieldsused-member)|Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of figures.| +||[areHyperlinksUsedOnWeb](/javascript/api/word/word.tableoffigures#word-word-tableoffigures-arehyperlinksusedonweb-member)|Specifies whether entries in the table of figures should be formatted as hyperlinks when publishing to the web.| +||[arePageNumbersHiddenOnWeb](/javascript/api/word/word.tableoffigures#word-word-tableoffigures-arepagenumbershiddenonweb-member)|Specifies whether the page numbers in the table of figures should be hidden when publishing to the web.| +||[arePageNumbersIncluded](/javascript/api/word/word.tableoffigures#word-word-tableoffigures-arepagenumbersincluded-member)|Specifies whether page numbers are included in the table of figures.| +||[arePageNumbersRightAligned](/javascript/api/word/word.tableoffigures#word-word-tableoffigures-arepagenumbersrightaligned-member)|Specifies whether page numbers are aligned with the right margin in the table of figures.| +||[captionLabel](/javascript/api/word/word.tableoffigures#word-word-tableoffigures-captionlabel-member)|Specifies the label that identifies the items to be included in the table of figures.| +||[delete()](/javascript/api/word/word.tableoffigures#word-word-tableoffigures-delete-member(1))|Deletes this table of figures.| +||[isLabelIncluded](/javascript/api/word/word.tableoffigures#word-word-tableoffigures-islabelincluded-member)|Specifies whether the caption label and caption number are included in the table of figures.| +||[lowerHeadingLevel](/javascript/api/word/word.tableoffigures#word-word-tableoffigures-lowerheadinglevel-member)|Specifies the ending heading level for the table of figures.| +||[range](/javascript/api/word/word.tableoffigures#word-word-tableoffigures-range-member)|Gets the portion of a document that is this table of figures.| +||[tabLeader](/javascript/api/word/word.tableoffigures#word-word-tableoffigures-tableader-member)|Specifies the character between entries and their page numbers in the table of figures.| +||[tableId](/javascript/api/word/word.tableoffigures#word-word-tableoffigures-tableid-member)|Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of figures.| +||[updatePageNumbers()](/javascript/api/word/word.tableoffigures#word-word-tableoffigures-updatepagenumbers-member(1))|Updates the entire table of figures.| +||[upperHeadingLevel](/javascript/api/word/word.tableoffigures#word-word-tableoffigures-upperheadinglevel-member)|Specifies the starting heading level for the table of figures.| +|[TableOfFiguresAddOptions](/javascript/api/word/word.tableoffiguresaddoptions)|[addedStyles](/javascript/api/word/word.tableoffiguresaddoptions#word-word-tableoffiguresaddoptions-addedstyles-member)|| +||[captionLabel](/javascript/api/word/word.tableoffiguresaddoptions#word-word-tableoffiguresaddoptions-captionlabel-member)|| +||[hidePageNumbersOnWeb](/javascript/api/word/word.tableoffiguresaddoptions#word-word-tableoffiguresaddoptions-hidepagenumbersonweb-member)|| +||[includeLabel](/javascript/api/word/word.tableoffiguresaddoptions#word-word-tableoffiguresaddoptions-includelabel-member)|| +||[includePageNumbers](/javascript/api/word/word.tableoffiguresaddoptions#word-word-tableoffiguresaddoptions-includepagenumbers-member)|| +||[lowerHeadingLevel](/javascript/api/word/word.tableoffiguresaddoptions#word-word-tableoffiguresaddoptions-lowerheadinglevel-member)|| +||[rightAlignPageNumbers](/javascript/api/word/word.tableoffiguresaddoptions#word-word-tableoffiguresaddoptions-rightalignpagenumbers-member)|| +||[tableId](/javascript/api/word/word.tableoffiguresaddoptions#word-word-tableoffiguresaddoptions-tableid-member)|| +||[upperHeadingLevel](/javascript/api/word/word.tableoffiguresaddoptions#word-word-tableoffiguresaddoptions-upperheadinglevel-member)|| +||[useBuiltInHeadingStyles](/javascript/api/word/word.tableoffiguresaddoptions#word-word-tableoffiguresaddoptions-usebuiltinheadingstyles-member)|| +||[useFields](/javascript/api/word/word.tableoffiguresaddoptions#word-word-tableoffiguresaddoptions-usefields-member)|| +||[useHyperlinksOnWeb](/javascript/api/word/word.tableoffiguresaddoptions#word-word-tableoffiguresaddoptions-usehyperlinksonweb-member)|| +|[TableOfFiguresCollection](/javascript/api/word/word.tableoffigurescollection)|[add(range: Word.Range, options?: Word.TableOfFiguresAddOptions)](/javascript/api/word/word.tableoffigurescollection#word-word-tableoffigurescollection-add-member(1))|Adds a table of figures to the document at the specified range.| +||[items](/javascript/api/word/word.tableoffigurescollection#word-word-tableoffigurescollection-items-member)|Gets the loaded child items in this collection.| +||[markTocEntry(range: Word.Range, options?: Word.TableOfContentsMarkEntryOptions)](/javascript/api/word/word.tableoffigurescollection#word-word-tableoffigurescollection-marktocentry-member(1))|Inserts a {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) field} after the specified range for marking entries in a table of figures.| +|[TableRow](/javascript/api/word/word.tablerow)|[convertToText(options?: Word.TableConvertToTextOptions)](/javascript/api/word/word.tablerow#word-word-tablerow-converttotext-member(1))|Converts the table row to text.| +||[range](/javascript/api/word/word.tablerow#word-word-tablerow-range-member)|Returns the `Range` object that represents the table row.| +||[setHeight(rowHeight: number, heightRule: Word.RowHeightRule)](/javascript/api/word/word.tablerow#word-word-tablerow-setheight-member(1))|Sets the height of the row.| +||[setLeftIndent(leftIndent: number, rulerStyle: Word.RulerStyle)](/javascript/api/word/word.tablerow#word-word-tablerow-setleftindent-member(1))|Sets the left indent for the table row.| +||[shading](/javascript/api/word/word.tablerow#word-word-tablerow-shading-member)|Returns the `ShadingUniversal` object that represents the shading of the table row.| +|[TableRowCollection](/javascript/api/word/word.tablerowcollection)|[convertToText(options?: Word.TableConvertToTextOptions)](/javascript/api/word/word.tablerowcollection#word-word-tablerowcollection-converttotext-member(1))|Converts rows in a table to text.| +||[delete()](/javascript/api/word/word.tablerowcollection#word-word-tablerowcollection-delete-member(1))|Deletes the table rows.| +||[distributeHeight()](/javascript/api/word/word.tablerowcollection#word-word-tablerowcollection-distributeheight-member(1))|Adjusts the height of the rows so that they're equal.| +||[select()](/javascript/api/word/word.tablerowcollection#word-word-tablerowcollection-select-member(1))|Selects the table rows.| +||[setHeight(rowHeight: number, heightRule: Word.RowHeightRule)](/javascript/api/word/word.tablerowcollection#word-word-tablerowcollection-setheight-member(1))|Sets the height of the cells in a table.| +||[setLeftIndent(leftIndent: number, rulerStyle: Word.RulerStyle)](/javascript/api/word/word.tablerowcollection#word-word-tablerowcollection-setleftindent-member(1))|Sets the left indent for the table row.| +|[TableSortOptions](/javascript/api/word/word.tablesortoptions)|[bidirectionalSort](/javascript/api/word/word.tablesortoptions#word-word-tablesortoptions-bidirectionalsort-member)|If provided, specifies whether to use bidirectional sort.| +||[caseSensitive](/javascript/api/word/word.tablesortoptions#word-word-tablesortoptions-casesensitive-member)|If provided, specifies whether sorting is case-sensitive.| +||[excludeHeader](/javascript/api/word/word.tablesortoptions#word-word-tablesortoptions-excludeheader-member)|If provided, specifies whether to exclude the header row from the sort operation.| +||[fieldNumber2](/javascript/api/word/word.tablesortoptions#word-word-tablesortoptions-fieldnumber2-member)|If provided, specifies the second field to sort by.| +||[fieldNumber3](/javascript/api/word/word.tablesortoptions#word-word-tablesortoptions-fieldnumber3-member)|If provided, specifies the third field to sort by.| +||[fieldNumber](/javascript/api/word/word.tablesortoptions#word-word-tablesortoptions-fieldnumber-member)|If provided, specifies the first field to sort by.| +||[ignoreArabicThe](/javascript/api/word/word.tablesortoptions#word-word-tablesortoptions-ignorearabicthe-member)|If provided, specifies whether to ignore Arabic character alef lam when sorting right-to-left language text.| +||[ignoreDiacritics](/javascript/api/word/word.tablesortoptions#word-word-tablesortoptions-ignorediacritics-member)|If provided, specifies whether to ignore bidirectional control characters when sorting right-to-left language text.| +||[ignoreHebrew](/javascript/api/word/word.tablesortoptions#word-word-tablesortoptions-ignorehebrew-member)|If provided, specifies whether to ignore Hebrew characters when sorting right-to-left language text.| +||[ignoreKashida](/javascript/api/word/word.tablesortoptions#word-word-tablesortoptions-ignorekashida-member)|If provided, specifies whether to ignore kashida when sorting right-to-left language text.| +||[languageId](/javascript/api/word/word.tablesortoptions#word-word-tablesortoptions-languageid-member)|If provided, specifies the sorting language.| +||[sortFieldType2](/javascript/api/word/word.tablesortoptions#word-word-tablesortoptions-sortfieldtype2-member)|If provided, specifies the type of the second field to sort by.| +||[sortFieldType3](/javascript/api/word/word.tablesortoptions#word-word-tablesortoptions-sortfieldtype3-member)|If provided, specifies the type of the third field to sort by.| +||[sortFieldType](/javascript/api/word/word.tablesortoptions#word-word-tablesortoptions-sortfieldtype-member)|If provided, specifies the type of the first field to sort by.| +||[sortOrder2](/javascript/api/word/word.tablesortoptions#word-word-tablesortoptions-sortorder2-member)|If provided, specifies the sort order of the second field to sort by.| +||[sortOrder3](/javascript/api/word/word.tablesortoptions#word-word-tablesortoptions-sortorder3-member)|If provided, specifies the sort order of the third field to sort by.| +||[sortOrder](/javascript/api/word/word.tablesortoptions#word-word-tablesortoptions-sortorder-member)|If provided, specifies the sort order of the first field to sort by.| +|[TableStyle](/javascript/api/word/word.tablestyle)|[borders](/javascript/api/word/word.tablestyle#word-word-tablestyle-borders-member)|Returns a `BorderUniversalCollection` that represents all the borders for the table.| +||[columnStripe](/javascript/api/word/word.tablestyle#word-word-tablestyle-columnstripe-member)|Specifies the number of columns in the banding when a style specifies odd- or even-column banding.| +||[condition(conditionCode: Word.ConditionCode)](/javascript/api/word/word.tablestyle#word-word-tablestyle-condition-member(1))|Returns a `ConditionalStyle` object that represents special style formatting for a portion of a table.| +||[isBreakAcrossPagesAllowed](/javascript/api/word/word.tablestyle#word-word-tablestyle-isbreakacrosspagesallowed-member)|Specifies whether Microsoft Word allows to break the specified table across pages.| +||[leftIndent](/javascript/api/word/word.tablestyle#word-word-tablestyle-leftindent-member)|Specifies the left indent value (in points) for the rows in the table style.| +||[rowStripe](/javascript/api/word/word.tablestyle#word-word-tablestyle-rowstripe-member)|Specifies the number of rows to include in the banding when the style specifies odd- or even-row banding.| +||[shading](/javascript/api/word/word.tablestyle#word-word-tablestyle-shading-member)|Returns a `ShadingUniversal` object that refers to the shading formatting for the table style.| +||[tableDirection](/javascript/api/word/word.tablestyle#word-word-tablestyle-tabledirection-member)|Specifies the direction in which Microsoft Word orders cells in the table style.| +|[Template](/javascript/api/word/word.template)|[buildingBlockEntries](/javascript/api/word/word.template#word-word-template-buildingblockentries-member)|Returns a `BuildingBlockEntryCollection` object that represents the collection of building block entries in the template.| +||[buildingBlockTypes](/javascript/api/word/word.template#word-word-template-buildingblocktypes-member)|Returns a `BuildingBlockTypeItemCollection` object that represents the collection of building block types that are contained in the template.| +||[farEastLineBreakLanguage](/javascript/api/word/word.template#word-word-template-fareastlinebreaklanguage-member)|Specifies the East Asian language to use when breaking lines of text in the document or template.| +||[farEastLineBreakLevel](/javascript/api/word/word.template#word-word-template-fareastlinebreaklevel-member)|Specifies the line break control level for the document.| +||[fullName](/javascript/api/word/word.template#word-word-template-fullname-member)|Returns the name of the template, including the drive or Web path.| +||[hasNoProofing](/javascript/api/word/word.template#word-word-template-hasnoproofing-member)|Specifies whether the spelling and grammar checker ignores documents based on this template.| +||[justificationMode](/javascript/api/word/word.template#word-word-template-justificationmode-member)|Specifies the character spacing adjustment for the template.| +||[kerningByAlgorithm](/javascript/api/word/word.template#word-word-template-kerningbyalgorithm-member)|Specifies if Microsoft Word kerns half-width Latin characters and punctuation marks in the document.| +||[languageId](/javascript/api/word/word.template#word-word-template-languageid-member)|Specifies a `LanguageId` value that represents the language in the template.| +||[languageIdFarEast](/javascript/api/word/word.template#word-word-template-languageidfareast-member)|Specifies an East Asian language for the language in the template.| +||[listTemplates](/javascript/api/word/word.template#word-word-template-listtemplates-member)|Returns a `ListTemplateCollection` object that represents all the list templates in the template.| +||[name](/javascript/api/word/word.template#word-word-template-name-member)|Returns only the name of the document template (excluding any path or other location information).| +||[noLineBreakAfter](/javascript/api/word/word.template#word-word-template-nolinebreakafter-member)|Specifies the kinsoku characters after which Microsoft Word will not break a line.| +||[noLineBreakBefore](/javascript/api/word/word.template#word-word-template-nolinebreakbefore-member)|Specifies the kinsoku characters before which Microsoft Word will not break a line.| +||[path](/javascript/api/word/word.template#word-word-template-path-member)|Returns the path to the document template.| +||[save()](/javascript/api/word/word.template#word-word-template-save-member(1))|Saves the template.| +||[saved](/javascript/api/word/word.template#word-word-template-saved-member)|Specifies `true` if the template has not changed since it was last saved, `false` if Microsoft Word displays a prompt to save changes when the document is closed.| +||[type](/javascript/api/word/word.template#word-word-template-type-member)|Returns the template type.| +|[TemplateCollection](/javascript/api/word/word.templatecollection)|[getCount()](/javascript/api/word/word.templatecollection#word-word-templatecollection-getcount-member(1))|Returns the number of items in the collection.| +||[getItemAt(index: number)](/javascript/api/word/word.templatecollection#word-word-templatecollection-getitemat-member(1))|Gets a `Template` object by its index in the collection.| +||[importBuildingBlocks()](/javascript/api/word/word.templatecollection#word-word-templatecollection-importbuildingblocks-member(1))|Imports the building blocks for all templates into Microsoft Word.| +||[items](/javascript/api/word/word.templatecollection#word-word-templatecollection-items-member)|Gets the loaded child items in this collection.| +|[TextColumn](/javascript/api/word/word.textcolumn)|[spaceAfter](/javascript/api/word/word.textcolumn#word-word-textcolumn-spaceafter-member)|Specifies the amount of spacing (in points) after the specified paragraph or text column.| +||[width](/javascript/api/word/word.textcolumn#word-word-textcolumn-width-member)|Specifies the width, in points, of the specified text columns.| +|[TextColumnAddOptions](/javascript/api/word/word.textcolumnaddoptions)|[isEvenlySpaced](/javascript/api/word/word.textcolumnaddoptions#word-word-textcolumnaddoptions-isevenlyspaced-member)|If provided, specifies whether to evenly space all the text columns in the document.| +||[spacing](/javascript/api/word/word.textcolumnaddoptions#word-word-textcolumnaddoptions-spacing-member)|If provided, specifies the spacing between the text columns in the document, in points.| +||[width](/javascript/api/word/word.textcolumnaddoptions#word-word-textcolumnaddoptions-width-member)|If provided, specifies the width of the new text column in the document, in points.| +|[TextColumnCollection](/javascript/api/word/word.textcolumncollection)|[add(options?: Word.TextColumnAddOptions)](/javascript/api/word/word.textcolumncollection#word-word-textcolumncollection-add-member(1))|Returns a `TextColumn` object that represents a new text column added to a section or document.| +||[getFlowDirection()](/javascript/api/word/word.textcolumncollection#word-word-textcolumncollection-getflowdirection-member(1))|Gets the direction in which text flows from one text column to the next.| +||[getHasLineBetween()](/javascript/api/word/word.textcolumncollection#word-word-textcolumncollection-gethaslinebetween-member(1))|Gets whether vertical lines appear between all the columns in the `TextColumnCollection` object.| +||[getIsEvenlySpaced()](/javascript/api/word/word.textcolumncollection#word-word-textcolumncollection-getisevenlyspaced-member(1))|Gets whether text columns are evenly spaced.| +||[getItem(index: number)](/javascript/api/word/word.textcolumncollection#word-word-textcolumncollection-getitem-member(1))|Gets a `TextColumn` by its index in the collection.| +||[items](/javascript/api/word/word.textcolumncollection#word-word-textcolumncollection-items-member)|Gets the loaded child items in this collection.| +||[setCount(numColumns: number)](/javascript/api/word/word.textcolumncollection#word-word-textcolumncollection-setcount-member(1))|Arranges text into the specified number of text columns.| +||[setFlowDirection(value: Word.FlowDirection)](/javascript/api/word/word.textcolumncollection#word-word-textcolumncollection-setflowdirection-member(1))|Sets the direction in which text flows from one text column to the next.| +||[setHasLineBetween(value: boolean)](/javascript/api/word/word.textcolumncollection#word-word-textcolumncollection-sethaslinebetween-member(1))|Sets whether vertical lines appear between all the columns in the `TextColumnCollection` object.| +||[setIsEvenlySpaced(value: boolean)](/javascript/api/word/word.textcolumncollection#word-word-textcolumncollection-setisevenlyspaced-member(1))|Sets whether text columns are evenly spaced.| +|[ThreeDimensionalFormat](/javascript/api/word/word.threedimensionalformat)|[bevelBottomDepth](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-bevelbottomdepth-member)|Specifies the depth of the bottom bevel.| +||[bevelBottomInset](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-bevelbottominset-member)|Specifies the inset size for the bottom bevel.| +||[bevelBottomType](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-bevelbottomtype-member)|Specifies a `BevelType` value that represents the bevel type for the bottom bevel.| +||[bevelTopDepth](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-beveltopdepth-member)|Specifies the depth of the top bevel.| +||[bevelTopInset](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-beveltopinset-member)|Specifies the inset size for the top bevel.| +||[bevelTopType](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-beveltoptype-member)|Specifies a `BevelType` value that represents the bevel type for the top bevel.| +||[contourColor](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-contourcolor-member)|Returns a `ColorFormat` object that represents color of the contour of a shape.| +||[contourWidth](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-contourwidth-member)|Specifies the width of the contour of a shape.| +||[depth](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-depth-member)|Specifies the depth of the shape's extrusion.| +||[extrusionColor](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-extrusioncolor-member)|Returns a `ColorFormat` object that represents the color of the shape's extrusion.| +||[extrusionColorType](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-extrusioncolortype-member)|Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion)| +||[fieldOfView](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-fieldofview-member)|Specifies the amount of perspective for a shape.| +||[incrementRotationHorizontal(increment: number)](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-incrementrotationhorizontal-member(1))|Horizontally rotates a shape on the x-axis.| +||[incrementRotationVertical(increment: number)](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-incrementrotationvertical-member(1))|Vertically rotates a shape on the y-axis.| +||[incrementRotationX(increment: number)](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-incrementrotationx-member(1))|Changes the rotation around the x-axis.| +||[incrementRotationY(increment: number)](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-incrementrotationy-member(1))|Changes the rotation around the y-axis.| +||[incrementRotationZ(increment: number)](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-incrementrotationz-member(1))|Rotates a shape on the z-axis.| +||[isPerspective](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-isperspective-member)|Specifies `true` if the extrusion appears in perspective — that is, if the walls of the extrusion narrow toward a vanishing point,| +||[isVisible](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-isvisible-member)|Specifies if the specified object, or the formatting applied to it, is visible.| +||[lightAngle](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-lightangle-member)|Specifies the angle of the lighting.| +||[presetCamera](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-presetcamera-member)|Returns a `PresetCamera` value that represents the camera presets.| +||[presetExtrusionDirection](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-presetextrusiondirection-member)|Returns the direction taken by the extrusion's sweep path leading away from the extruded shape (the front face of the extrusion).| +||[presetLighting](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-presetlighting-member)|Specifies a `LightRigType` value that represents the lighting preset.| +||[presetLightingDirection](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-presetlightingdirection-member)|Specifies the position of the light source relative to the extrusion.| +||[presetLightingSoftness](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-presetlightingsoftness-member)|Specifies the intensity of the extrusion lighting.| +||[presetMaterial](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-presetmaterial-member)|Specifies the extrusion surface material.| +||[presetThreeDimensionalFormat](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-presetthreedimensionalformat-member)|Returns the preset extrusion format.| +||[projectText](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-projecttext-member)|Specifies whether text on a shape rotates with shape.| +||[resetRotation()](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-resetrotation-member(1))|Resets the extrusion rotation around the x-axis, y-axis, and z-axis to 0.| +||[rotationX](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-rotationx-member)|Specifies the rotation of the extruded shape around the x-axis in degrees.| +||[rotationY](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-rotationy-member)|Specifies the rotation of the extruded shape around the y-axis in degrees.| +||[rotationZ](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-rotationz-member)|Specifies the z-axis rotation of the camera.| +||[setExtrusionDirection(presetExtrusionDirection: Word.PresetExtrusionDirection)](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-setextrusiondirection-member(1))|Sets the direction of the extrusion's sweep path.| +||[setPresetCamera(presetCamera: Word.PresetCamera)](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-setpresetcamera-member(1))|Sets the camera preset for the shape.| +||[setThreeDimensionalFormat(presetThreeDimensionalFormat: Word.PresetThreeDimensionalFormat)](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-setthreedimensionalformat-member(1))|Sets the preset extrusion format.| +||[z](/javascript/api/word/word.threedimensionalformat#word-word-threedimensionalformat-z-member)|Specifies the position on the z-axis for the shape.| +|[View](/javascript/api/word/word.view)|[areAllNonprintingCharactersDisplayed](/javascript/api/word/word.view#word-word-view-areallnonprintingcharactersdisplayed-member)|Specifies whether all nonprinting characters are displayed.| +||[areBackgroundsDisplayed](/javascript/api/word/word.view#word-word-view-arebackgroundsdisplayed-member)|Gets whether background colors and images are shown when the document is displayed in print layout view.| +||[areBookmarksIndicated](/javascript/api/word/word.view#word-word-view-arebookmarksindicated-member)|Gets whether square brackets are displayed at the beginning and end of each bookmark.| +||[areCommentsDisplayed](/javascript/api/word/word.view#word-word-view-arecommentsdisplayed-member)|Specifies whether Microsoft Word displays the comments in the document.| +||[areConnectingLinesToRevisionsBalloonDisplayed](/javascript/api/word/word.view#word-word-view-areconnectinglinestorevisionsballoondisplayed-member)|Specifies whether Microsoft Word displays connecting lines from the text to the revision and comment balloons.| +||[areCropMarksDisplayed](/javascript/api/word/word.view#word-word-view-arecropmarksdisplayed-member)|Gets whether crop marks are shown in the corners of pages to indicate where margins are located.| +||[areDrawingsDisplayed](/javascript/api/word/word.view#word-word-view-aredrawingsdisplayed-member)|Gets whether objects created with the drawing tools are displayed in print layout view.| +||[areEditableRangesShaded](/javascript/api/word/word.view#word-word-view-areeditablerangesshaded-member)|Specifies whether shading is applied to the ranges in the document that users have permission to modify.| +||[areFieldCodesDisplayed](/javascript/api/word/word.view#word-word-view-arefieldcodesdisplayed-member)|Specifies whether field codes are displayed.| +||[areFormatChangesDisplayed](/javascript/api/word/word.view#word-word-view-areformatchangesdisplayed-member)|Specifies whether Microsoft Word displays formatting changes made to the document with Track Changes enabled.| +||[areInkAnnotationsDisplayed](/javascript/api/word/word.view#word-word-view-areinkannotationsdisplayed-member)|Specifies whether handwritten ink annotations are shown or hidden.| +||[areInsertionsAndDeletionsDisplayed](/javascript/api/word/word.view#word-word-view-areinsertionsanddeletionsdisplayed-member)|Specifies whether Microsoft Word displays insertions and deletions made to the document with Track Changes enabled.| +||[areLinesWrappedToWindow](/javascript/api/word/word.view#word-word-view-arelineswrappedtowindow-member)|Gets whether lines wrap at the right edge of the document window rather than at the right margin or the right column boundary.| +||[areObjectAnchorsDisplayed](/javascript/api/word/word.view#word-word-view-areobjectanchorsdisplayed-member)|Gets whether object anchors are displayed next to items that can be positioned in print layout view.| +||[areOptionalBreaksDisplayed](/javascript/api/word/word.view#word-word-view-areoptionalbreaksdisplayed-member)|Gets whether Microsoft Word displays optional line breaks.| +||[areOptionalHyphensDisplayed](/javascript/api/word/word.view#word-word-view-areoptionalhyphensdisplayed-member)|Gets whether optional hyphens are displayed.| +||[areOtherAuthorsVisible](/javascript/api/word/word.view#word-word-view-areotherauthorsvisible-member)|Gets whether other authors' presence should be visible in the document.| +||[arePageBoundariesDisplayed](/javascript/api/word/word.view#word-word-view-arepageboundariesdisplayed-member)|Gets whether the top and bottom margins and the gray area between pages in the document are displayed.| +||[areParagraphsMarksDisplayed](/javascript/api/word/word.view#word-word-view-areparagraphsmarksdisplayed-member)|Gets whether paragraph marks are displayed.| +||[arePicturePlaceholdersDisplayed](/javascript/api/word/word.view#word-word-view-arepictureplaceholdersdisplayed-member)|Gets whether blank boxes are displayed as placeholders for pictures.| +||[areRevisionsAndCommentsDisplayed](/javascript/api/word/word.view#word-word-view-arerevisionsandcommentsdisplayed-member)|Specifies whether Microsoft Word displays revisions and comments made to the document with Track Changes enabled.| +||[areSpacesIndicated](/javascript/api/word/word.view#word-word-view-arespacesindicated-member)|Gets whether space characters are displayed.| +||[areTableGridlinesDisplayed](/javascript/api/word/word.view#word-word-view-aretablegridlinesdisplayed-member)|Specifies whether table gridlines are displayed.| +||[areTabsDisplayed](/javascript/api/word/word.view#word-word-view-aretabsdisplayed-member)|Gets whether tab characters are displayed.| +||[areTextBoundariesDisplayed](/javascript/api/word/word.view#word-word-view-aretextboundariesdisplayed-member)|Gets whether dotted lines are displayed around page margins, text columns, objects, and frames in print layout view.| +||[collapseAllHeadings()](/javascript/api/word/word.view#word-word-view-collapseallheadings-member(1))|Collapses all the headings in the document.| +||[collapseOutline(range: Word.Range)](/javascript/api/word/word.view#word-word-view-collapseoutline-member(1))|Collapses the text under the selection or the specified range by one heading level.| +||[columnWidth](/javascript/api/word/word.view#word-word-view-columnwidth-member)|Specifies the column width in Reading mode.| +||[expandAllHeadings()](/javascript/api/word/word.view#word-word-view-expandallheadings-member(1))|Expands all the headings in the document.| +||[expandOutline(range: Word.Range)](/javascript/api/word/word.view#word-word-view-expandoutline-member(1))|Expands the text under the selection by one heading level.| +||[fieldShading](/javascript/api/word/word.view#word-word-view-fieldshading-member)|Gets on-screen shading for fields.| +||[isDraft](/javascript/api/word/word.view#word-word-view-isdraft-member)|Specifies whether all the text in a window is displayed in the same sans-serif font with minimal formatting to speed up display.| +||[isFirstLineOnlyDisplayed](/javascript/api/word/word.view#word-word-view-isfirstlineonlydisplayed-member)|Specifies whether only the first line of body text is shown in outline view.| +||[isFormatDisplayed](/javascript/api/word/word.view#word-word-view-isformatdisplayed-member)|Specifies whether character formatting is visible in outline view.| +||[isFullScreen](/javascript/api/word/word.view#word-word-view-isfullscreen-member)|Specifies whether the window is in full-screen view.| +||[isHiddenTextDisplayed](/javascript/api/word/word.view#word-word-view-ishiddentextdisplayed-member)|Gets whether text formatted as hidden text is displayed.| +||[isHighlightingDisplayed](/javascript/api/word/word.view#word-word-view-ishighlightingdisplayed-member)|Gets whether highlight formatting is displayed and printed with the document.| +||[isInConflictMode](/javascript/api/word/word.view#word-word-view-isinconflictmode-member)|Specifies whether the document is in conflict mode view.| +||[isInPanning](/javascript/api/word/word.view#word-word-view-isinpanning-member)|Specifies whether Microsoft Word is in Panning mode.| +||[isInReadingLayout](/javascript/api/word/word.view#word-word-view-isinreadinglayout-member)|Specifies whether the document is being viewed in reading layout view.| +||[isMailMergeDataView](/javascript/api/word/word.view#word-word-view-ismailmergedataview-member)|Specifies whether mail merge data is displayed instead of mail merge fields.| +||[isMainTextLayerVisible](/javascript/api/word/word.view#word-word-view-ismaintextlayervisible-member)|Specifies whether the text in the document is visible when the header and footer areas are displayed.| +||[isPointerShownAsMagnifier](/javascript/api/word/word.view#word-word-view-ispointershownasmagnifier-member)|Specifies whether the pointer is displayed as a magnifying glass in print preview.| +||[isReadingLayoutActualView](/javascript/api/word/word.view#word-word-view-isreadinglayoutactualview-member)|Specifies whether pages displayed in reading layout view are displayed using the same layout as printed pages.| +||[isXmlMarkupVisible](/javascript/api/word/word.view#word-word-view-isxmlmarkupvisible-member)|Specifies whether XML tags are visible in the document.| +||[markupMode](/javascript/api/word/word.view#word-word-view-markupmode-member)|Specifies the display mode for tracked changes.| +||[nextHeaderFooter()](/javascript/api/word/word.view#word-word-view-nextheaderfooter-member(1))|Moves to the next header or footer, depending on whether a header or footer is displayed in the view.| +||[pageColor](/javascript/api/word/word.view#word-word-view-pagecolor-member)|Specifies the page color in Reading mode.| +||[pageMovementType](/javascript/api/word/word.view#word-word-view-pagemovementtype-member)|Specifies the page movement type.| +||[previousHeaderFooter()](/javascript/api/word/word.view#word-word-view-previousheaderfooter-member(1))|Moves to the previous header or footer, depending on whether a header or footer is displayed in the view.| +||[readingLayoutTruncateMargins](/javascript/api/word/word.view#word-word-view-readinglayouttruncatemargins-member)|Specifies whether margins are visible or hidden when the document is viewed in Full Screen Reading view.| +||[revisionsBalloonSide](/javascript/api/word/word.view#word-word-view-revisionsballoonside-member)|Gets whether Word displays revision balloons in the left or right margin in the document.| +||[revisionsBalloonWidth](/javascript/api/word/word.view#word-word-view-revisionsballoonwidth-member)|Specifies the width of the revision balloons.| +||[revisionsBalloonWidthType](/javascript/api/word/word.view#word-word-view-revisionsballoonwidthtype-member)|Specifies how Microsoft Word measures the width of revision balloons.| +||[revisionsFilter](/javascript/api/word/word.view#word-word-view-revisionsfilter-member)|Gets the instance of a `RevisionsFilter` object.| +||[seekView](/javascript/api/word/word.view#word-word-view-seekview-member)|Specifies the document element displayed in print layout view.| +||[showAllHeadings()](/javascript/api/word/word.view#word-word-view-showallheadings-member(1))|Switches between showing all text (headings and body text) and showing only headings.| +||[showHeading(level: number)](/javascript/api/word/word.view#word-word-view-showheading-member(1))|Shows all headings up to the specified heading level and hides subordinate headings and body text.| +||[splitSpecial](/javascript/api/word/word.view#word-word-view-splitspecial-member)|Specifies the active window pane.| +||[type](/javascript/api/word/word.view#word-word-view-type-member)|Specifies the view type.| +|[Window](/javascript/api/word/word.window)|[activate()](/javascript/api/word/word.window#word-word-window-activate-member(1))|Activates the window.| +||[areRulersDisplayed](/javascript/api/word/word.window#word-word-window-arerulersdisplayed-member)|Specifies whether rulers are displayed for the window or pane.| +||[areScreenTipsDisplayed](/javascript/api/word/word.window#word-word-window-arescreentipsdisplayed-member)|Specifies whether comments, footnotes, endnotes, and hyperlinks are displayed as tips.| +||[areThumbnailsDisplayed](/javascript/api/word/word.window#word-word-window-arethumbnailsdisplayed-member)|Specifies whether thumbnail images of the pages in a document are displayed along the left side of the Microsoft Word document window.| +||[caption](/javascript/api/word/word.window#word-word-window-caption-member)|Specifies the caption text for the window that is displayed in the title bar of the document or application window.| +||[close(options?: Word.WindowCloseOptions)](/javascript/api/word/word.window#word-word-window-close-member(1))|Closes the window.| +||[height](/javascript/api/word/word.window#word-word-window-height-member)|Specifies the height of the window (in points).| +||[horizontalPercentScrolled](/javascript/api/word/word.window#word-word-window-horizontalpercentscrolled-member)|Specifies the horizontal scroll position as a percentage of the document width.| +||[imeMode](/javascript/api/word/word.window#word-word-window-imemode-member)|Specifies the default start-up mode for the Japanese Input Method Editor (IME).| +||[index](/javascript/api/word/word.window#word-word-window-index-member)|Gets the position of an item in a collection.| +||[isActive](/javascript/api/word/word.window#word-word-window-isactive-member)|Specifies whether the window is active.| +||[isDocumentMapVisible](/javascript/api/word/word.window#word-word-window-isdocumentmapvisible-member)|Specifies whether the document map is visible.| +||[isEnvelopeVisible](/javascript/api/word/word.window#word-word-window-isenvelopevisible-member)|Specifies whether the email message header is visible in the document window.| +||[isHorizontalScrollBarDisplayed](/javascript/api/word/word.window#word-word-window-ishorizontalscrollbardisplayed-member)|Specifies whether a horizontal scroll bar is displayed for the window.| +||[isLeftScrollBarDisplayed](/javascript/api/word/word.window#word-word-window-isleftscrollbardisplayed-member)|Specifies whether the vertical scroll bar appears on the left side of the document window.| +||[isRightRulerDisplayed](/javascript/api/word/word.window#word-word-window-isrightrulerdisplayed-member)|Specifies whether the vertical ruler appears on the right side of the document window in print layout view.| +||[isSplit](/javascript/api/word/word.window#word-word-window-issplit-member)|Specifies whether the window is split into multiple panes.| +||[isVerticalRulerDisplayed](/javascript/api/word/word.window#word-word-window-isverticalrulerdisplayed-member)|Specifies whether a vertical ruler is displayed for the window or pane.| +||[isVerticalScrollBarDisplayed](/javascript/api/word/word.window#word-word-window-isverticalscrollbardisplayed-member)|Specifies whether a vertical scroll bar is displayed for the window.| +||[isVisible](/javascript/api/word/word.window#word-word-window-isvisible-member)|Specifies whether the window is visible.| +||[largeScroll(options?: Word.WindowScrollOptions)](/javascript/api/word/word.window#word-word-window-largescroll-member(1))|Scrolls the window by the specified number of screens.| +||[left](/javascript/api/word/word.window#word-word-window-left-member)|Specifies the horizontal position of the window, measured in points.| +||[next](/javascript/api/word/word.window#word-word-window-next-member)|Gets the next document window in the collection of open document windows.| +||[pageScroll(options?: Word.WindowPageScrollOptions)](/javascript/api/word/word.window#word-word-window-pagescroll-member(1))|Scrolls through the window page by page.| +||[previous](/javascript/api/word/word.window#word-word-window-previous-member)|Gets the previous document window in the collection open document windows.| +||[setFocus()](/javascript/api/word/word.window#word-word-window-setfocus-member(1))|Sets the focus of the document window to the body of an email message.| +||[showSourceDocuments](/javascript/api/word/word.window#word-word-window-showsourcedocuments-member)|Specifies how Microsoft Word displays source documents after a compare and merge process.| +||[smallScroll(options?: Word.WindowScrollOptions)](/javascript/api/word/word.window#word-word-window-smallscroll-member(1))|Scrolls the window by the specified number of lines.| +||[splitVertical](/javascript/api/word/word.window#word-word-window-splitvertical-member)|Specifies the vertical split percentage for the window.| +||[styleAreaWidth](/javascript/api/word/word.window#word-word-window-styleareawidth-member)|Specifies the width of the style area in points.| +||[toggleRibbon()](/javascript/api/word/word.window#word-word-window-toggleribbon-member(1))|Shows or hides the ribbon.| +||[top](/javascript/api/word/word.window#word-word-window-top-member)|Specifies the vertical position of the document window, in points.| +||[type](/javascript/api/word/word.window#word-word-window-type-member)|Gets the window type.| +||[usableHeight](/javascript/api/word/word.window#word-word-window-usableheight-member)|Gets the height (in points) of the active working area in the document window.| +||[usableWidth](/javascript/api/word/word.window#word-word-window-usablewidth-member)|Gets the width (in points) of the active working area in the document window.| +||[verticalPercentScrolled](/javascript/api/word/word.window#word-word-window-verticalpercentscrolled-member)|Specifies the vertical scroll position as a percentage of the document length.| +||[view](/javascript/api/word/word.window#word-word-window-view-member)|Gets the `View` object that represents the view for the window.| +||[width](/javascript/api/word/word.window#word-word-window-width-member)|Specifies the width of the document window, in points.| +||[windowNumber](/javascript/api/word/word.window#word-word-window-windownumber-member)|Gets an integer that represents the position of the window.| +||[windowState](/javascript/api/word/word.window#word-word-window-windowstate-member)|Specifies the state of the document window or task window.| +|[WindowCloseOptions](/javascript/api/word/word.windowcloseoptions)|[routeDocument](/javascript/api/word/word.windowcloseoptions#word-word-windowcloseoptions-routedocument-member)|If provided, specifies whether to route the document to the next recipient.| +||[saveChanges](/javascript/api/word/word.windowcloseoptions#word-word-windowcloseoptions-savechanges-member)|If provided, specifies the save action for the document.| +|[WindowCollection](/javascript/api/word/word.windowcollection)||| +|[WindowPageScrollOptions](/javascript/api/word/word.windowpagescrolloptions)|[down](/javascript/api/word/word.windowpagescrolloptions#word-word-windowpagescrolloptions-down-member)|If provided, specifies the number of pages to scroll the window down.| +||[up](/javascript/api/word/word.windowpagescrolloptions#word-word-windowpagescrolloptions-up-member)|If provided, specifies the number of pages to scroll the window up.| +|[WindowScrollOptions](/javascript/api/word/word.windowscrolloptions)|[down](/javascript/api/word/word.windowscrolloptions#word-word-windowscrolloptions-down-member)|If provided, specifies the number of units to scroll the window down.| +||[left](/javascript/api/word/word.windowscrolloptions#word-word-windowscrolloptions-left-member)|If provided, specifies the number of screens to scroll the window to the left.| +||[right](/javascript/api/word/word.windowscrolloptions#word-word-windowscrolloptions-right-member)|If provided, specifies the number of screens to scroll the window to the right.| +||[up](/javascript/api/word/word.windowscrolloptions#word-word-windowscrolloptions-up-member)|If provided, specifies the number of units to scroll the window up.| +|[XmlMapping](/javascript/api/word/word.xmlmapping)|[customXmlNode](/javascript/api/word/word.xmlmapping#word-word-xmlmapping-customxmlnode-member)|Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to.| +||[customXmlPart](/javascript/api/word/word.xmlmapping#word-word-xmlmapping-customxmlpart-member)|Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps.| +||[delete()](/javascript/api/word/word.xmlmapping#word-word-xmlmapping-delete-member(1))|Deletes the XML mapping from the parent content control.| +||[isMapped](/javascript/api/word/word.xmlmapping#word-word-xmlmapping-ismapped-member)|Returns whether the content control in the document is mapped to an XML node in the document's XML data store.| +||[prefixMappings](/javascript/api/word/word.xmlmapping#word-word-xmlmapping-prefixmappings-member)|Returns the prefix mappings used to evaluate the XPath for the current XML mapping.| +||[setMapping(xPath: string, options?: Word.XmlSetMappingOptions)](/javascript/api/word/word.xmlmapping#word-word-xmlmapping-setmapping-member(1))|Allows creating or changing the XML mapping on the content control.| +||[setMappingByNode(node: Word.CustomXmlNode)](/javascript/api/word/word.xmlmapping#word-word-xmlmapping-setmappingbynode-member(1))|Allows creating or changing the XML data mapping on the content control.| +||[xpath](/javascript/api/word/word.xmlmapping#word-word-xmlmapping-xpath-member)|Returns the XPath for the XML mapping, which evaluates to the currently mapped XML node.| +|[XmlSetMappingOptions](/javascript/api/word/word.xmlsetmappingoptions)|[prefixMapping](/javascript/api/word/word.xmlsetmappingoptions#word-word-xmlsetmappingoptions-prefixmapping-member)|If provided, specifies the prefix mappings to use when querying the expression provided in the `xPath` parameter of the `XmlMapping.setMapping` calling method.| +||[source](/javascript/api/word/word.xmlsetmappingoptions#word-word-xmlsetmappingoptions-source-member)|If provided, specifies the desired custom XML data to map the content control to.| diff --git a/generate-docs/API Coverage Report.csv b/generate-docs/API Coverage Report.csv index 1725e8fa6c..a35a2b2a87 100644 --- a/generate-docs/API Coverage Report.csv +++ b/generate-docs/API Coverage Report.csv @@ -11555,7 +11555,9 @@ Word.Application,N/A,Class,Unknown,true Word.Application,"bibliography",Property,Great,false Word.Application,"checkLanguage",Property,Great,false Word.Application,"context",Property,Excellent,false +Word.Application,"fontNames",Property,Great,false Word.Application,"language",Property,Good,false +Word.Application,"listTemplateGalleries",Property,Great,false Word.Application,"templates",Property,Excellent,false Word.Application,"createDocument(base64File)",Method,Excellent,true Word.Application,"load(options)",Method,Excellent,false @@ -11585,6 +11587,10 @@ Word.ArrowheadWidth,"medium",EnumField,Fine,false Word.ArrowheadWidth,"mixed",EnumField,Fine,false Word.ArrowheadWidth,"narrow",EnumField,Fine,false Word.ArrowheadWidth,"wide",EnumField,Fine,false +Word.AutoFitBehavior,N/A,Enum,Unknown,false +Word.AutoFitBehavior,"content",EnumField,Fine,false +Word.AutoFitBehavior,"fixedSize",EnumField,Fine,false +Word.AutoFitBehavior,"window",EnumField,Fine,false Word.BaselineAlignment,N/A,Enum,Unknown,false Word.BaselineAlignment,"auto",EnumField,Fine,false Word.BaselineAlignment,"baseline",EnumField,Fine,false @@ -12187,6 +12193,9 @@ Word.CalendarType,"translitEnglish",EnumField,Fine,false Word.CalendarType,"translitFrench",EnumField,Fine,false Word.CalendarType,"umalqura",EnumField,Fine,false Word.CalendarType,"western",EnumField,Fine,false +Word.CalendarTypeBidirectional,N/A,Enum,Unknown,false +Word.CalendarTypeBidirectional,"bidirectional",EnumField,Fine,false +Word.CalendarTypeBidirectional,"gregorian",EnumField,Fine,false Word.Canvas,N/A,Class,Unknown,false Word.Canvas,"context",Property,Excellent,false Word.Canvas,"id",Property,Great,false @@ -12200,6 +12209,13 @@ Word.Canvas,"set(properties)",Method,Good,false Word.Canvas,"toJSON()",Method,Excellent,false Word.Canvas,"track()",Method,Excellent,false Word.Canvas,"untrack()",Method,Excellent,false +Word.CaptionLabelType,N/A,Enum,Unknown,false +Word.CaptionLabelType,"equation",EnumField,Great,false +Word.CaptionLabelType,"figure",EnumField,Great,false +Word.CaptionLabelType,"table",EnumField,Great,false +Word.CaptionPosition,N/A,Enum,Good,false +Word.CaptionPosition,"above",EnumField,Fine,false +Word.CaptionPosition,"below",EnumField,Fine,false Word.CellPaddingLocation,N/A,Enum,Fine,true Word.CellPaddingLocation,"bottom",EnumField,Fine,false Word.CellPaddingLocation,"left",EnumField,Fine,false @@ -12245,6 +12261,100 @@ Word.CheckboxContentControl,"untrack()",Method,Excellent,false Word.CloseBehavior,N/A,Enum,Unknown,true Word.CloseBehavior,"save",EnumField,Fine,false Word.CloseBehavior,"skipSave",EnumField,Good,false +Word.Coauthor,N/A,Class,Unknown,false +Word.Coauthor,"context",Property,Excellent,false +Word.Coauthor,"emailAddress",Property,Poor,false +Word.Coauthor,"id",Property,Great,false +Word.Coauthor,"isMe",Property,Fine,false +Word.Coauthor,"locks",Property,Good,false +Word.Coauthor,"name",Property,Poor,false +Word.Coauthor,"load(options)",Method,Excellent,false +Word.Coauthor,"load(propertyNames)",Method,Excellent,false +Word.Coauthor,"load(propertyNamesAndPaths)",Method,Excellent,false +Word.Coauthor,"toJSON()",Method,Excellent,false +Word.Coauthor,"track()",Method,Excellent,false +Word.Coauthor,"untrack()",Method,Excellent,false +Word.CoauthorCollection,N/A,Class,Unknown,false +Word.CoauthorCollection,"context",Property,Excellent,false +Word.CoauthorCollection,"items",Property,Poor,false +Word.CoauthorCollection,"load(options)",Method,Excellent,false +Word.CoauthorCollection,"load(propertyNames)",Method,Excellent,false +Word.CoauthorCollection,"load(propertyNamesAndPaths)",Method,Excellent,false +Word.CoauthorCollection,"toJSON()",Method,Excellent,false +Word.CoauthorCollection,"track()",Method,Excellent,false +Word.CoauthorCollection,"untrack()",Method,Excellent,false +Word.Coauthoring,N/A,Class,Unknown,false +Word.Coauthoring,"authors",Property,Good,false +Word.Coauthoring,"canCoauthor",Property,Poor,false +Word.Coauthoring,"canMerge",Property,Fine,false +Word.Coauthoring,"conflicts",Property,Good,false +Word.Coauthoring,"context",Property,Excellent,false +Word.Coauthoring,"locks",Property,Good,false +Word.Coauthoring,"me",Property,Good,false +Word.Coauthoring,"pendingUpdates",Property,Good,false +Word.Coauthoring,"updates",Property,Great,false +Word.Coauthoring,"load(options)",Method,Excellent,false +Word.Coauthoring,"load(propertyNames)",Method,Excellent,false +Word.Coauthoring,"load(propertyNamesAndPaths)",Method,Excellent,false +Word.Coauthoring,"toJSON()",Method,Excellent,false +Word.Coauthoring,"track()",Method,Excellent,false +Word.Coauthoring,"untrack()",Method,Excellent,false +Word.CoauthoringLock,N/A,Class,Unknown,false +Word.CoauthoringLock,"context",Property,Excellent,false +Word.CoauthoringLock,"owner",Property,Poor,false +Word.CoauthoringLock,"range",Property,Good,false +Word.CoauthoringLock,"type",Property,Good,false +Word.CoauthoringLock,"load(options)",Method,Excellent,false +Word.CoauthoringLock,"load(propertyNames)",Method,Excellent,false +Word.CoauthoringLock,"load(propertyNamesAndPaths)",Method,Excellent,false +Word.CoauthoringLock,"set(properties, options)",Method,Good,false +Word.CoauthoringLock,"set(properties)",Method,Good,false +Word.CoauthoringLock,"toJSON()",Method,Excellent,false +Word.CoauthoringLock,"track()",Method,Excellent,false +Word.CoauthoringLock,"unlock()",Method,Good,false +Word.CoauthoringLock,"untrack()",Method,Excellent,false +Word.CoauthoringLockAddOptions,N/A,Interface,Unknown,false +Word.CoauthoringLockAddOptions,"range",Property,Great,false +Word.CoauthoringLockAddOptions,"type",Property,Great,false +Word.CoauthoringLockCollection,N/A,Class,Great,false +Word.CoauthoringLockCollection,"context",Property,Excellent,false +Word.CoauthoringLockCollection,"items",Property,Poor,false +Word.CoauthoringLockCollection,"add(options)",Method,Excellent,false +Word.CoauthoringLockCollection,"load(options)",Method,Excellent,false +Word.CoauthoringLockCollection,"load(propertyNames)",Method,Excellent,false +Word.CoauthoringLockCollection,"load(propertyNamesAndPaths)",Method,Excellent,false +Word.CoauthoringLockCollection,"toJSON()",Method,Excellent,false +Word.CoauthoringLockCollection,"track()",Method,Excellent,false +Word.CoauthoringLockCollection,"unlockEphemeralLocks()",Method,Poor,false +Word.CoauthoringLockCollection,"untrack()",Method,Excellent,false +Word.CoauthoringLockType,N/A,Enum,Fine,false +Word.CoauthoringLockType,"changed",EnumField,Fine,false +Word.CoauthoringLockType,"ephemeral",EnumField,Fine,false +Word.CoauthoringLockType,"none",EnumField,Fine,false +Word.CoauthoringLockType,"reservation",EnumField,Fine,false +Word.CoauthoringUpdate,N/A,Class,Unknown,false +Word.CoauthoringUpdate,"context",Property,Excellent,false +Word.CoauthoringUpdate,"range",Property,Good,false +Word.CoauthoringUpdate,"load(options)",Method,Excellent,false +Word.CoauthoringUpdate,"load(propertyNames)",Method,Excellent,false +Word.CoauthoringUpdate,"load(propertyNamesAndPaths)",Method,Excellent,false +Word.CoauthoringUpdate,"set(properties, options)",Method,Good,false +Word.CoauthoringUpdate,"set(properties)",Method,Good,false +Word.CoauthoringUpdate,"toJSON()",Method,Excellent,false +Word.CoauthoringUpdate,"track()",Method,Excellent,false +Word.CoauthoringUpdate,"untrack()",Method,Excellent,false +Word.CoauthoringUpdateCollection,N/A,Class,Unknown,false +Word.CoauthoringUpdateCollection,"context",Property,Excellent,false +Word.CoauthoringUpdateCollection,"items",Property,Poor,false +Word.CoauthoringUpdateCollection,"load(options)",Method,Excellent,false +Word.CoauthoringUpdateCollection,"load(propertyNames)",Method,Excellent,false +Word.CoauthoringUpdateCollection,"load(propertyNamesAndPaths)",Method,Excellent,false +Word.CoauthoringUpdateCollection,"toJSON()",Method,Excellent,false +Word.CoauthoringUpdateCollection,"track()",Method,Excellent,false +Word.CoauthoringUpdateCollection,"untrack()",Method,Excellent,false +Word.CollapseDirection,N/A,Enum,Unknown,false +Word.CollapseDirection,"end",EnumField,Fine,false +Word.CollapseDirection,"start",EnumField,Fine,false Word.ColorFormat,N/A,Class,Unknown,false Word.ColorFormat,"brightness",Property,Excellent,false Word.ColorFormat,"context",Property,Excellent,false @@ -12397,6 +12507,61 @@ Word.CompareTarget,N/A,Enum,Unknown,true Word.CompareTarget,"compareTargetCurrent",EnumField,Good,false Word.CompareTarget,"compareTargetNew",EnumField,Good,false Word.CompareTarget,"compareTargetSelected",EnumField,Good,false +Word.ConditionalStyle,N/A,Class,Unknown,false +Word.ConditionalStyle,"borders",Property,Excellent,false +Word.ConditionalStyle,"bottomPadding",Property,Great,false +Word.ConditionalStyle,"context",Property,Excellent,false +Word.ConditionalStyle,"font",Property,Excellent,false +Word.ConditionalStyle,"leftPadding",Property,Great,false +Word.ConditionalStyle,"paragraphFormat",Property,Excellent,false +Word.ConditionalStyle,"rightPadding",Property,Great,false +Word.ConditionalStyle,"shading",Property,Excellent,false +Word.ConditionalStyle,"topPadding",Property,Great,false +Word.ConditionalStyle,"load(options)",Method,Excellent,false +Word.ConditionalStyle,"load(propertyNames)",Method,Excellent,false +Word.ConditionalStyle,"load(propertyNamesAndPaths)",Method,Excellent,false +Word.ConditionalStyle,"toJSON()",Method,Excellent,false +Word.ConditionalStyle,"track()",Method,Excellent,false +Word.ConditionalStyle,"untrack()",Method,Excellent,false +Word.ConditionCode,N/A,Enum,Unknown,false +Word.ConditionCode,"bottomLeftCell",EnumField,Fine,false +Word.ConditionCode,"bottomRightCell",EnumField,Fine,false +Word.ConditionCode,"evenColumnBanding",EnumField,Fine,false +Word.ConditionCode,"evenRowBanding",EnumField,Fine,false +Word.ConditionCode,"firstColumn",EnumField,Fine,false +Word.ConditionCode,"firstRow",EnumField,Fine,false +Word.ConditionCode,"lastColumn",EnumField,Fine,false +Word.ConditionCode,"lastRow",EnumField,Fine,false +Word.ConditionCode,"oddColumnBanding",EnumField,Fine,false +Word.ConditionCode,"oddRowBanding",EnumField,Fine,false +Word.ConditionCode,"topLeftCell",EnumField,Fine,false +Word.ConditionCode,"topRightCell",EnumField,Fine,false +Word.Conflict,N/A,Class,Unknown,false +Word.Conflict,"context",Property,Excellent,false +Word.Conflict,"range",Property,Good,false +Word.Conflict,"type",Property,Fine,false +Word.Conflict,"accept()",Method,Fine,false +Word.Conflict,"load(options)",Method,Excellent,false +Word.Conflict,"load(propertyNames)",Method,Excellent,false +Word.Conflict,"load(propertyNamesAndPaths)",Method,Excellent,false +Word.Conflict,"reject()",Method,Fine,false +Word.Conflict,"set(properties, options)",Method,Good,false +Word.Conflict,"set(properties)",Method,Good,false +Word.Conflict,"toJSON()",Method,Excellent,false +Word.Conflict,"track()",Method,Excellent,false +Word.Conflict,"untrack()",Method,Excellent,false +Word.ConflictCollection,N/A,Class,Unknown,false +Word.ConflictCollection,"context",Property,Excellent,false +Word.ConflictCollection,"items",Property,Poor,false +Word.ConflictCollection,"acceptAll()",Method,Fine,false +Word.ConflictCollection,"getItem(index)",Method,Good,false +Word.ConflictCollection,"load(options)",Method,Excellent,false +Word.ConflictCollection,"load(propertyNames)",Method,Excellent,false +Word.ConflictCollection,"load(propertyNamesAndPaths)",Method,Excellent,false +Word.ConflictCollection,"rejectAll()",Method,Fine,false +Word.ConflictCollection,"toJSON()",Method,Excellent,false +Word.ConflictCollection,"track()",Method,Excellent,false +Word.ConflictCollection,"untrack()",Method,Excellent,false Word.ContentControl,N/A,Class,Unknown,true Word.ContentControl,"appearance",Property,Excellent,false Word.ContentControl,"buildingBlockGalleryContentControl",Property,Good,false @@ -12871,6 +13036,9 @@ Word.CustomXmlValidationErrorType,N/A,Enum,Good,false Word.CustomXmlValidationErrorType,"automaticallyCleared",EnumField,Good,false Word.CustomXmlValidationErrorType,"manual",EnumField,Good,false Word.CustomXmlValidationErrorType,"schemaGenerated",EnumField,Good,false +Word.DateLanguage,N/A,Enum,Unknown,false +Word.DateLanguage,"bidirectional",EnumField,Fine,false +Word.DateLanguage,"latin",EnumField,Fine,false Word.DatePickerContentControl,N/A,Class,Unknown,false Word.DatePickerContentControl,"appearance",Property,Good,false Word.DatePickerContentControl,"color",Property,Excellent,false @@ -12906,6 +13074,14 @@ Word.DefaultListBehavior,N/A,Enum,Unknown,false Word.DefaultListBehavior,"word2000",EnumField,Fine,false Word.DefaultListBehavior,"word2002",EnumField,Fine,false Word.DefaultListBehavior,"word97",EnumField,Fine,false +Word.DefaultTableBehavior,N/A,Enum,Good,false +Word.DefaultTableBehavior,"disableAutoFit",EnumField,Fine,false +Word.DefaultTableBehavior,"enableAutoFit",EnumField,Fine,false +Word.DeleteCells,N/A,Enum,Good,false +Word.DeleteCells,"entireColumn",EnumField,Fine,false +Word.DeleteCells,"entireRow",EnumField,Fine,false +Word.DeleteCells,"shiftLeft",EnumField,Good,false +Word.DeleteCells,"shiftUp",EnumField,Good,false Word.DocPartInsertType,N/A,Enum,Unknown,false Word.DocPartInsertType,"content",EnumField,Fine,false Word.DocPartInsertType,"page",EnumField,Fine,false @@ -12919,6 +13095,7 @@ Word.Document,"bibliography",Property,Excellent,false Word.Document,"body",Property,Good,false Word.Document,"bookmarks",Property,Great,false Word.Document,"changeTrackingMode",Property,Good,true +Word.Document,"coauthoring",Property,Good,false Word.Document,"consecutiveHyphensLimit",Property,Great,false Word.Document,"contentControls",Property,Good,false Word.Document,"context",Property,Excellent,false @@ -12929,11 +13106,18 @@ Word.Document,"hyperlinks",Property,Great,false Word.Document,"hyphenateCaps",Property,Great,false Word.Document,"indexes",Property,Great,false Word.Document,"languageDetected",Property,Great,false +Word.Document,"listTemplates",Property,Great,false Word.Document,"pageSetup",Property,Great,false Word.Document,"properties",Property,Poor,true +Word.Document,"revisions",Property,Fine,false Word.Document,"saved",Property,Good,false Word.Document,"sections",Property,Good,false +Word.Document,"selection",Property,Great,false Word.Document,"settings",Property,Poor,true +Word.Document,"tableOfAuthoritiesCategories",Property,Great,false +Word.Document,"tablesOfAuthorities",Property,Great,false +Word.Document,"tablesOfContents",Property,Great,false +Word.Document,"tablesOfFigures",Property,Great,false Word.Document,"windows",Property,Good,false Word.Document,"addStyle(name, type)",Method,Poor,true Word.Document,"addStyle(name, type)",Method,Poor,false @@ -13086,12 +13270,49 @@ Word.DropPosition,N/A,Enum,Fine,false Word.DropPosition,"margin",EnumField,Fine,false Word.DropPosition,"none",EnumField,Fine,false Word.DropPosition,"normal",EnumField,Fine,false +Word.Editor,N/A,Class,Unknown,false +Word.Editor,"context",Property,Excellent,false +Word.Editor,"id",Property,Excellent,false +Word.Editor,"name",Property,Poor,false +Word.Editor,"nextRange",Property,Great,false +Word.Editor,"range",Property,Good,false +Word.Editor,"delete()",Method,Good,false +Word.Editor,"load(options)",Method,Excellent,false +Word.Editor,"load(propertyNames)",Method,Excellent,false +Word.Editor,"load(propertyNamesAndPaths)",Method,Excellent,false +Word.Editor,"removeAllPermissions()",Method,Fine,false +Word.Editor,"selectAllShapes()",Method,Fine,false +Word.Editor,"set(properties, options)",Method,Good,false +Word.Editor,"set(properties)",Method,Good,false +Word.Editor,"toJSON()",Method,Excellent,false +Word.Editor,"track()",Method,Excellent,false +Word.Editor,"untrack()",Method,Excellent,false +Word.EditorCollection,N/A,Class,Unknown,false +Word.EditorCollection,"context",Property,Excellent,false +Word.EditorCollection,"addById(editorId)",Method,Excellent,false +Word.EditorCollection,"addByType(editorType)",Method,Excellent,false +Word.EditorCollection,"addByType(editorType)",Method,Excellent,false +Word.EditorCollection,"getCount()",Method,Fine,false +Word.EditorCollection,"getItemAt(index)",Method,Good,false +Word.EditorCollection,"load(propertyNames)",Method,Excellent,false +Word.EditorCollection,"load(propertyNamesAndPaths)",Method,Excellent,false +Word.EditorCollection,"toJSON()",Method,Excellent,false +Word.EditorCollection,"track()",Method,Excellent,false +Word.EditorCollection,"untrack()",Method,Excellent,false +Word.EditorType,N/A,Enum,Fine,false +Word.EditorType,"current",EnumField,Fine,false +Word.EditorType,"editors",EnumField,Fine,false +Word.EditorType,"everyone",EnumField,Fine,false +Word.EditorType,"owners",EnumField,Fine,false Word.EmphasisMark,N/A,Enum,Unknown,false Word.EmphasisMark,"none",EnumField,Fine,false Word.EmphasisMark,"overComma",EnumField,Fine,false Word.EmphasisMark,"overSolidCircle",EnumField,Fine,false Word.EmphasisMark,"overWhiteCircle",EnumField,Fine,false Word.EmphasisMark,"underSolidCircle",EnumField,Fine,false +Word.EndnoteLocation,N/A,Enum,Unknown,false +Word.EndnoteLocation,"endOfDocument",EnumField,Fine,false +Word.EndnoteLocation,"endOfSection",EnumField,Fine,false Word.ErrorCodes,N/A,Enum,Missing,true Word.ErrorCodes,"accessDenied",EnumField,Missing,false Word.ErrorCodes,"generalException",EnumField,Missing,false @@ -13402,6 +13623,22 @@ Word.Font,"setAsTemplateDefault()",Method,Great,false Word.Font,"toJSON()",Method,Excellent,false Word.Font,"track()",Method,Excellent,false Word.Font,"untrack()",Method,Excellent,false +Word.FontBias,N/A,Enum,Unknown,false +Word.FontBias,"farEast",EnumField,Fine,false +Word.FontBias,"noSpecified",EnumField,Good,false +Word.FontBias,"standard",EnumField,Good,false +Word.FontNameCollection,N/A,Class,Great,false +Word.FontNameCollection,"context",Property,Excellent,false +Word.FontNameCollection,"getCount()",Method,Fine,false +Word.FontNameCollection,"getItemAt(index)",Method,Fine,false +Word.FontNameCollection,"load(propertyNames)",Method,Excellent,false +Word.FontNameCollection,"load(propertyNamesAndPaths)",Method,Excellent,false +Word.FontNameCollection,"toJSON()",Method,Excellent,false +Word.FontNameCollection,"track()",Method,Excellent,false +Word.FontNameCollection,"untrack()",Method,Excellent,false +Word.FootnoteLocation,N/A,Enum,Unknown,false +Word.FootnoteLocation,"beneathText",EnumField,Fine,false +Word.FootnoteLocation,"bottomOfPage",EnumField,Fine,false Word.Frame,N/A,Class,Missing,false Word.Frame,"borders",Property,Great,false Word.Frame,"context",Property,Excellent,false @@ -13641,6 +13878,29 @@ Word.GlowFormat,"set(properties)",Method,Good,false Word.GlowFormat,"toJSON()",Method,Excellent,false Word.GlowFormat,"track()",Method,Excellent,false Word.GlowFormat,"untrack()",Method,Excellent,false +Word.GoToDirection,N/A,Enum,Unknown,false +Word.GoToDirection,"first",EnumField,Fine,false +Word.GoToDirection,"last",EnumField,Fine,false +Word.GoToDirection,"next",EnumField,Fine,false +Word.GoToDirection,"previous",EnumField,Fine,false +Word.GoToItem,N/A,Enum,Unknown,false +Word.GoToItem,"bookmark",EnumField,Fine,false +Word.GoToItem,"comment",EnumField,Fine,false +Word.GoToItem,"embeddedObject",EnumField,Good,false +Word.GoToItem,"endnote",EnumField,Fine,false +Word.GoToItem,"equation",EnumField,Fine,false +Word.GoToItem,"field",EnumField,Good,false +Word.GoToItem,"footnote",EnumField,Fine,false +Word.GoToItem,"grammaticalError",EnumField,Good,false +Word.GoToItem,"graphic",EnumField,Fine,false +Word.GoToItem,"heading",EnumField,Fine,false +Word.GoToItem,"line",EnumField,Fine,false +Word.GoToItem,"page",EnumField,Fine,false +Word.GoToItem,"percent",EnumField,Fine,false +Word.GoToItem,"proofreadingError",EnumField,Good,false +Word.GoToItem,"section",EnumField,Fine,false +Word.GoToItem,"spellingError",EnumField,Good,false +Word.GoToItem,"table",EnumField,Fine,false Word.GradientColorType,N/A,Enum,Good,false Word.GradientColorType,"mixed",EnumField,Excellent,false Word.GradientColorType,"multiColor",EnumField,Fine,false @@ -13701,6 +13961,29 @@ Word.HeadingSeparator,"letter",EnumField,Good,false Word.HeadingSeparator,"letterFull",EnumField,Good,false Word.HeadingSeparator,"letterLow",EnumField,Great,false Word.HeadingSeparator,"none",EnumField,Good,false +Word.HeadingStyle,N/A,Class,Unknown,false +Word.HeadingStyle,"context",Property,Excellent,false +Word.HeadingStyle,"level",Property,Excellent,false +Word.HeadingStyle,"name",Property,Good,false +Word.HeadingStyle,"delete()",Method,Fine,false +Word.HeadingStyle,"load(options)",Method,Excellent,false +Word.HeadingStyle,"load(propertyNames)",Method,Excellent,false +Word.HeadingStyle,"load(propertyNamesAndPaths)",Method,Excellent,false +Word.HeadingStyle,"set(properties, options)",Method,Good,false +Word.HeadingStyle,"set(properties)",Method,Good,false +Word.HeadingStyle,"toJSON()",Method,Excellent,false +Word.HeadingStyle,"track()",Method,Excellent,false +Word.HeadingStyle,"untrack()",Method,Excellent,false +Word.HeadingStyleCollection,N/A,Class,Great,false +Word.HeadingStyleCollection,"context",Property,Excellent,false +Word.HeadingStyleCollection,"items",Property,Poor,false +Word.HeadingStyleCollection,"add(name, level)",Method,Poor,false +Word.HeadingStyleCollection,"load(options)",Method,Excellent,false +Word.HeadingStyleCollection,"load(propertyNames)",Method,Excellent,false +Word.HeadingStyleCollection,"load(propertyNamesAndPaths)",Method,Excellent,false +Word.HeadingStyleCollection,"toJSON()",Method,Excellent,false +Word.HeadingStyleCollection,"track()",Method,Excellent,false +Word.HeadingStyleCollection,"untrack()",Method,Excellent,false Word.HorizontalInVerticalType,N/A,Enum,Unknown,false Word.HorizontalInVerticalType,"fitInLine",EnumField,Fine,false Word.HorizontalInVerticalType,"none",EnumField,Fine,false @@ -14515,9 +14798,10 @@ Word.ListNumbering,"lowerRoman",EnumField,Fine,false Word.ListNumbering,"none",EnumField,Fine,false Word.ListNumbering,"upperLetter",EnumField,Fine,false Word.ListNumbering,"upperRoman",EnumField,Fine,false -Word.ListTemplate,N/A,Class,Unknown,true +Word.ListTemplate,N/A,Class,Great,true Word.ListTemplate,"context",Property,Excellent,false Word.ListTemplate,"listLevels",Property,Good,false +Word.ListTemplate,"name",Property,Good,false Word.ListTemplate,"outlineNumbered",Property,Great,false Word.ListTemplate,"load(options)",Method,Excellent,false Word.ListTemplate,"load(propertyNames)",Method,Excellent,false @@ -14532,6 +14816,43 @@ Word.ListTemplateApplyOptions,"applyLevel",Property,Excellent,false Word.ListTemplateApplyOptions,"applyTo",Property,Excellent,false Word.ListTemplateApplyOptions,"continuePreviousList",Property,Excellent,false Word.ListTemplateApplyOptions,"defaultListBehavior",Property,Excellent,false +Word.ListTemplateCollection,N/A,Class,Unknown,false +Word.ListTemplateCollection,"context",Property,Excellent,false +Word.ListTemplateCollection,"items",Property,Poor,false +Word.ListTemplateCollection,"add(options)",Method,Great,false +Word.ListTemplateCollection,"getItem(index)",Method,Good,false +Word.ListTemplateCollection,"load(options)",Method,Excellent,false +Word.ListTemplateCollection,"load(propertyNames)",Method,Excellent,false +Word.ListTemplateCollection,"load(propertyNamesAndPaths)",Method,Excellent,false +Word.ListTemplateCollection,"toJSON()",Method,Excellent,false +Word.ListTemplateCollection,"track()",Method,Excellent,false +Word.ListTemplateCollection,"untrack()",Method,Excellent,false +Word.ListTemplateCollectionAddOptions,N/A,Interface,Unknown,false +Word.ListTemplateCollectionAddOptions,"name",Property,Great,false +Word.ListTemplateCollectionAddOptions,"outlineNumbered",Property,Excellent,false +Word.ListTemplateGallery,N/A,Class,Unknown,false +Word.ListTemplateGallery,"context",Property,Excellent,false +Word.ListTemplateGallery,"listTemplates",Property,Excellent,false +Word.ListTemplateGallery,"load(propertyNames)",Method,Excellent,false +Word.ListTemplateGallery,"load(propertyNamesAndPaths)",Method,Excellent,false +Word.ListTemplateGallery,"toJSON()",Method,Excellent,false +Word.ListTemplateGallery,"track()",Method,Excellent,false +Word.ListTemplateGallery,"untrack()",Method,Excellent,false +Word.ListTemplateGalleryCollection,N/A,Class,Unknown,false +Word.ListTemplateGalleryCollection,"context",Property,Excellent,false +Word.ListTemplateGalleryCollection,"items",Property,Poor,false +Word.ListTemplateGalleryCollection,"getByType(type)",Method,Good,false +Word.ListTemplateGalleryCollection,"getByType(type)",Method,Good,false +Word.ListTemplateGalleryCollection,"getItem(index)",Method,Good,false +Word.ListTemplateGalleryCollection,"load(propertyNames)",Method,Excellent,false +Word.ListTemplateGalleryCollection,"load(propertyNamesAndPaths)",Method,Excellent,false +Word.ListTemplateGalleryCollection,"toJSON()",Method,Excellent,false +Word.ListTemplateGalleryCollection,"track()",Method,Excellent,false +Word.ListTemplateGalleryCollection,"untrack()",Method,Excellent,false +Word.ListTemplateGalleryType,N/A,Enum,Fine,false +Word.ListTemplateGalleryType,"bullets",EnumField,Fine,false +Word.ListTemplateGalleryType,"number",EnumField,Fine,false +Word.ListTemplateGalleryType,"outlineNumbered",EnumField,Fine,false Word.ListType,N/A,Enum,Unknown,false Word.ListType,"listBullet",EnumField,Fine,false Word.ListType,"listListNumOnly",EnumField,Great,false @@ -14555,6 +14876,9 @@ Word.LocationRelation,"insideStart",EnumField,Fine,false Word.LocationRelation,"overlapsAfter",EnumField,Fine,false Word.LocationRelation,"overlapsBefore",EnumField,Fine,false Word.LocationRelation,"unrelated",EnumField,Good,false +Word.MovementType,N/A,Enum,Good,false +Word.MovementType,"extend",EnumField,Fine,false +Word.MovementType,"move",EnumField,Fine,false Word.NoteItem,N/A,Class,Unknown,true Word.NoteItem,"body",Property,Great,true Word.NoteItem,"context",Property,Excellent,false @@ -14585,6 +14909,36 @@ Word.NoteItemCollection,"untrack()",Method,Excellent,false Word.NoteItemType,N/A,Enum,Missing,true Word.NoteItemType,"endnote",EnumField,Fine,false Word.NoteItemType,"footnote",EnumField,Fine,false +Word.NoteNumberStyle,N/A,Enum,Unknown,false +Word.NoteNumberStyle,"arabic",EnumField,Fine,false +Word.NoteNumberStyle,"arabicFullWidth",EnumField,Fine,false +Word.NoteNumberStyle,"arabicLetter1",EnumField,Fine,false +Word.NoteNumberStyle,"arabicLetter2",EnumField,Fine,false +Word.NoteNumberStyle,"hanjaRead",EnumField,Fine,false +Word.NoteNumberStyle,"hanjaReadDigit",EnumField,Fine,false +Word.NoteNumberStyle,"hebrewLetter1",EnumField,Fine,false +Word.NoteNumberStyle,"hebrewLetter2",EnumField,Fine,false +Word.NoteNumberStyle,"hindiArabic",EnumField,Fine,false +Word.NoteNumberStyle,"hindiCardinalText",EnumField,Fine,false +Word.NoteNumberStyle,"hindiLetter1",EnumField,Fine,false +Word.NoteNumberStyle,"hindiLetter2",EnumField,Fine,false +Word.NoteNumberStyle,"kanji",EnumField,Fine,false +Word.NoteNumberStyle,"kanjiDigit",EnumField,Fine,false +Word.NoteNumberStyle,"kanjiTraditional",EnumField,Fine,false +Word.NoteNumberStyle,"lowercaseLetter",EnumField,Good,false +Word.NoteNumberStyle,"lowercaseRoman",EnumField,Good,false +Word.NoteNumberStyle,"numberInCircle",EnumField,Fine,false +Word.NoteNumberStyle,"simplifiedChineseNumeral1",EnumField,Good,false +Word.NoteNumberStyle,"simplifiedChineseNumeral2",EnumField,Good,false +Word.NoteNumberStyle,"symbol",EnumField,Fine,false +Word.NoteNumberStyle,"thaiArabic",EnumField,Fine,false +Word.NoteNumberStyle,"thaiCardinalText",EnumField,Fine,false +Word.NoteNumberStyle,"thaiLetter",EnumField,Fine,false +Word.NoteNumberStyle,"traditionalChineseNumeral1",EnumField,Fine,false +Word.NoteNumberStyle,"traditionalChineseNumeral2",EnumField,Fine,false +Word.NoteNumberStyle,"uppercaseLetter",EnumField,Good,false +Word.NoteNumberStyle,"uppercaseRoman",EnumField,Good,false +Word.NoteNumberStyle,"vietnameseCardinalText",EnumField,Fine,false Word.NumberForm,N/A,Enum,Unknown,false Word.NumberForm,"default",EnumField,Good,false Word.NumberForm,"lining",EnumField,Fine,false @@ -14634,6 +14988,23 @@ Word.OleVerb,"open",EnumField,Good,false Word.OleVerb,"primary",EnumField,Excellent,false Word.OleVerb,"show",EnumField,Good,false Word.OleVerb,"uiActivate",EnumField,Good,false +Word.OperationUnit,N/A,Enum,Unknown,false +Word.OperationUnit,"cell",EnumField,Great,false +Word.OperationUnit,"character",EnumField,Great,false +Word.OperationUnit,"characterFormat",EnumField,Great,false +Word.OperationUnit,"column",EnumField,Great,false +Word.OperationUnit,"item",EnumField,Great,false +Word.OperationUnit,"line",EnumField,Great,false +Word.OperationUnit,"paragraph",EnumField,Great,false +Word.OperationUnit,"paragraphFormat",EnumField,Great,false +Word.OperationUnit,"row",EnumField,Great,false +Word.OperationUnit,"screen",EnumField,Great,false +Word.OperationUnit,"section",EnumField,Great,false +Word.OperationUnit,"sentence",EnumField,Great,false +Word.OperationUnit,"story",EnumField,Great,false +Word.OperationUnit,"table",EnumField,Great,false +Word.OperationUnit,"window",EnumField,Great,false +Word.OperationUnit,"word",EnumField,Great,false Word.OutlineLevel,N/A,Enum,Unknown,true Word.OutlineLevel,"outlineLevel1",EnumField,Fine,false Word.OutlineLevel,"outlineLevel2",EnumField,Fine,false @@ -14897,8 +15268,10 @@ Word.Pane,N/A,Class,Unknown,true Word.Pane,"context",Property,Excellent,false Word.Pane,"pages",Property,Poor,true Word.Pane,"pagesEnclosingViewport",Property,Good,true +Word.Pane,"selection",Property,Great,false Word.Pane,"getNext()",Method,Great,false Word.Pane,"getNextOrNullObject()",Method,Excellent,false +Word.Pane,"load(options)",Method,Excellent,false Word.Pane,"load(propertyNames)",Method,Excellent,false Word.Pane,"load(propertyNamesAndPaths)",Method,Excellent,false Word.Pane,"toJSON()",Method,Excellent,false @@ -14909,6 +15282,7 @@ Word.PaneCollection,"context",Property,Excellent,false Word.PaneCollection,"items",Property,Poor,false Word.PaneCollection,"getFirst()",Method,Great,false Word.PaneCollection,"getFirstOrNullObject()",Method,Excellent,false +Word.PaneCollection,"load(options)",Method,Excellent,false Word.PaneCollection,"load(propertyNames)",Method,Excellent,false Word.PaneCollection,"load(propertyNamesAndPaths)",Method,Excellent,false Word.PaneCollection,"toJSON()",Method,Excellent,false @@ -14986,7 +15360,6 @@ Word.Paragraph,"parentTable",Property,Great,false Word.Paragraph,"parentTableCell",Property,Great,false Word.Paragraph,"parentTableCellOrNullObject",Property,Excellent,false Word.Paragraph,"parentTableOrNullObject",Property,Excellent,false -Word.Paragraph,"range",Property,Great,false Word.Paragraph,"rightIndent",Property,Excellent,false Word.Paragraph,"shading",Property,Great,false Word.Paragraph,"shapes",Property,Good,false @@ -15133,6 +15506,36 @@ Word.ParagraphFormat,"set(properties)",Method,Good,false Word.ParagraphFormat,"toJSON()",Method,Excellent,false Word.ParagraphFormat,"track()",Method,Excellent,false Word.ParagraphFormat,"untrack()",Method,Excellent,false +Word.PasteDataType,N/A,Enum,Unknown,false +Word.PasteDataType,"bitmap",EnumField,Fine,false +Word.PasteDataType,"deviceIndependentBitmap",EnumField,Fine,false +Word.PasteDataType,"enhancedMetafile",EnumField,Fine,false +Word.PasteDataType,"html",EnumField,Fine,false +Word.PasteDataType,"hyperlink",EnumField,Fine,false +Word.PasteDataType,"metafilePicture",EnumField,Fine,false +Word.PasteDataType,"oleObject",EnumField,Good,false +Word.PasteDataType,"rtf",EnumField,Fine,false +Word.PasteDataType,"shape",EnumField,Fine,false +Word.PasteDataType,"text",EnumField,Fine,false +Word.PasteFormatType,N/A,Enum,Unknown,false +Word.PasteFormatType,"chart",EnumField,Fine,false +Word.PasteFormatType,"chartLinked",EnumField,Fine,false +Word.PasteFormatType,"chartPicture",EnumField,Fine,false +Word.PasteFormatType,"formatOriginalFormatting",EnumField,Fine,false +Word.PasteFormatType,"formatPlainText",EnumField,Fine,false +Word.PasteFormatType,"formatSurroundingFormattingWithEmphasis",EnumField,Fine,false +Word.PasteFormatType,"listCombineWithExistingList",EnumField,Fine,false +Word.PasteFormatType,"listContinueNumbering",EnumField,Fine,false +Word.PasteFormatType,"listDontMerge",EnumField,Fine,false +Word.PasteFormatType,"listRestartNumbering",EnumField,Fine,false +Word.PasteFormatType,"pasteDefault",EnumField,Great,false +Word.PasteFormatType,"singleCellTable",EnumField,Fine,false +Word.PasteFormatType,"singleCellText",EnumField,Fine,false +Word.PasteFormatType,"tableAppendTable",EnumField,Fine,false +Word.PasteFormatType,"tableInsertAsRows",EnumField,Fine,false +Word.PasteFormatType,"tableOriginalFormatting",EnumField,Fine,false +Word.PasteFormatType,"tableOverwriteCells",EnumField,Fine,false +Word.PasteFormatType,"useDestinationStylesRecovery",EnumField,Fine,false Word.PatternType,N/A,Enum,Unknown,false Word.PatternType,"cross",EnumField,Fine,false Word.PatternType,"darkDownwardDiagonal",EnumField,Fine,false @@ -15410,9 +15813,11 @@ Word.Range,"borders",Property,Great,false Word.Range,"case",Property,Excellent,false Word.Range,"characterWidth",Property,Good,false Word.Range,"combineCharacters",Property,Great,false +Word.Range,"conflicts",Property,Great,false Word.Range,"contentControls",Property,Good,false Word.Range,"context",Property,Excellent,false Word.Range,"disableCharacterSpaceGrid",Property,Excellent,false +Word.Range,"editors",Property,Excellent,false Word.Range,"emphasisMark",Property,Excellent,false Word.Range,"end",Property,Great,false Word.Range,"endnotes",Property,Poor,false @@ -15450,6 +15855,7 @@ Word.Range,"parentTable",Property,Great,false Word.Range,"parentTableCell",Property,Great,false Word.Range,"parentTableCellOrNullObject",Property,Excellent,false Word.Range,"parentTableOrNullObject",Property,Excellent,false +Word.Range,"revisions",Property,Fine,false Word.Range,"sections",Property,Poor,false Word.Range,"shading",Property,Great,false Word.Range,"shapes",Property,Good,false @@ -15538,6 +15944,16 @@ Word.RangeLocation,"content",EnumField,Fine,false Word.RangeLocation,"end",EnumField,Good,false Word.RangeLocation,"start",EnumField,Good,false Word.RangeLocation,"whole",EnumField,Great,false +Word.RangeScopedCollection,N/A,Class,Unknown,false +Word.RangeScopedCollection,"context",Property,Excellent,false +Word.RangeScopedCollection,"items",Property,Poor,false +Word.RangeScopedCollection,"getItem(index)",Method,Good,false +Word.RangeScopedCollection,"load(options)",Method,Excellent,false +Word.RangeScopedCollection,"load(propertyNames)",Method,Excellent,false +Word.RangeScopedCollection,"load(propertyNamesAndPaths)",Method,Excellent,false +Word.RangeScopedCollection,"toJSON()",Method,Excellent,false +Word.RangeScopedCollection,"track()",Method,Excellent,false +Word.RangeScopedCollection,"untrack()",Method,Excellent,false Word.ReadingLayoutMargin,N/A,Enum,Unknown,false Word.ReadingLayoutMargin,"automatic",EnumField,Fine,false Word.ReadingLayoutMargin,"full",EnumField,Fine,false @@ -15545,6 +15961,26 @@ Word.ReadingLayoutMargin,"suppress",EnumField,Fine,false Word.ReadingOrder,N/A,Enum,Unknown,false Word.ReadingOrder,"leftToRight",EnumField,Fine,false Word.ReadingOrder,"rightToLeft",EnumField,Fine,false +Word.ReferenceKind,N/A,Enum,Unknown,false +Word.ReferenceKind,"contentText",EnumField,Fine,false +Word.ReferenceKind,"endnoteNumber",EnumField,Fine,false +Word.ReferenceKind,"endnoteNumberFormatted",EnumField,Fine,false +Word.ReferenceKind,"entireCaption",EnumField,Fine,false +Word.ReferenceKind,"footnoteNumber",EnumField,Fine,false +Word.ReferenceKind,"footnoteNumberFormatted",EnumField,Fine,false +Word.ReferenceKind,"numberFullContext",EnumField,Great,false +Word.ReferenceKind,"numberNoContext",EnumField,Great,false +Word.ReferenceKind,"numberRelativeContext",EnumField,Great,false +Word.ReferenceKind,"onlyCaptionText",EnumField,Fine,false +Word.ReferenceKind,"onlyLabelAndNumber",EnumField,Fine,false +Word.ReferenceKind,"pageNumber",EnumField,Fine,false +Word.ReferenceKind,"position",EnumField,Fine,false +Word.ReferenceType,N/A,Enum,Unknown,false +Word.ReferenceType,"bookmark",EnumField,Fine,false +Word.ReferenceType,"endnote",EnumField,Fine,false +Word.ReferenceType,"footnote",EnumField,Fine,false +Word.ReferenceType,"heading",EnumField,Fine,false +Word.ReferenceType,"numberedItem",EnumField,Fine,false Word.ReflectionFormat,N/A,Class,Unknown,false Word.ReflectionFormat,"blur",Property,Excellent,false Word.ReflectionFormat,"context",Property,Excellent,false @@ -15673,6 +16109,37 @@ Word.ReviewerCollection,"load(propertyNamesAndPaths)",Method,Excellent,false Word.ReviewerCollection,"toJSON()",Method,Excellent,false Word.ReviewerCollection,"track()",Method,Excellent,false Word.ReviewerCollection,"untrack()",Method,Excellent,false +Word.Revision,N/A,Class,Unknown,false +Word.Revision,"author",Property,Fine,false +Word.Revision,"context",Property,Excellent,false +Word.Revision,"date",Property,Good,false +Word.Revision,"formatDescription",Property,Fine,false +Word.Revision,"index",Property,Fine,false +Word.Revision,"movedRange",Property,Good,false +Word.Revision,"range",Property,Great,false +Word.Revision,"type",Property,Poor,false +Word.Revision,"accept()",Method,Fine,false +Word.Revision,"load(options)",Method,Excellent,false +Word.Revision,"load(propertyNames)",Method,Excellent,false +Word.Revision,"load(propertyNamesAndPaths)",Method,Excellent,false +Word.Revision,"reject()",Method,Fine,false +Word.Revision,"set(properties, options)",Method,Good,false +Word.Revision,"set(properties)",Method,Good,false +Word.Revision,"toJSON()",Method,Excellent,false +Word.Revision,"track()",Method,Excellent,false +Word.Revision,"untrack()",Method,Excellent,false +Word.RevisionCollection,N/A,Class,Great,false +Word.RevisionCollection,"context",Property,Excellent,false +Word.RevisionCollection,"items",Property,Poor,false +Word.RevisionCollection,"acceptAll()",Method,Fine,false +Word.RevisionCollection,"getItem(index)",Method,Excellent,false +Word.RevisionCollection,"load(options)",Method,Excellent,false +Word.RevisionCollection,"load(propertyNames)",Method,Excellent,false +Word.RevisionCollection,"load(propertyNamesAndPaths)",Method,Excellent,false +Word.RevisionCollection,"rejectAll()",Method,Fine,false +Word.RevisionCollection,"toJSON()",Method,Excellent,false +Word.RevisionCollection,"track()",Method,Excellent,false +Word.RevisionCollection,"untrack()",Method,Excellent,false Word.RevisionsBalloonMargin,N/A,Enum,Unknown,false Word.RevisionsBalloonMargin,"left",EnumField,Fine,false Word.RevisionsBalloonMargin,"right",EnumField,Fine,false @@ -15727,6 +16194,10 @@ Word.RevisionType,"sectionProperty",EnumField,Good,false Word.RevisionType,"style",EnumField,Fine,false Word.RevisionType,"styleDefinition",EnumField,Fine,false Word.RevisionType,"tableProperty",EnumField,Good,false +Word.RowHeightRule,N/A,Enum,Unknown,false +Word.RowHeightRule,"atLeast",EnumField,Good,false +Word.RowHeightRule,"auto",EnumField,Good,false +Word.RowHeightRule,"exactly",EnumField,Good,false Word.RulerStyle,N/A,Enum,Unknown,false Word.RulerStyle,"firstColumn",EnumField,Fine,false Word.RulerStyle,"none",EnumField,Excellent,false @@ -15807,10 +16278,214 @@ Word.SeekView,"footnotes",EnumField,Fine,false Word.SeekView,"mainDocument",EnumField,Fine,false Word.SeekView,"primaryFooter",EnumField,Fine,false Word.SeekView,"primaryHeader",EnumField,Fine,false +Word.Selection,N/A,Class,Unknown,false +Word.Selection,"borders",Property,Great,false +Word.Selection,"characters",Property,Excellent,false +Word.Selection,"comments",Property,Great,false +Word.Selection,"context",Property,Excellent,false +Word.Selection,"end",Property,Great,false +Word.Selection,"fields",Property,Excellent,false +Word.Selection,"fitTextWidth",Property,Great,false +Word.Selection,"font",Property,Great,false +Word.Selection,"formattedText",Property,Excellent,false +Word.Selection,"hasNoProofing",Property,Great,false +Word.Selection,"isActive",Property,Great,false +Word.Selection,"isColumnSelectModeActive",Property,Good,false +Word.Selection,"isEndOfRowMark",Property,Good,false +Word.Selection,"isExtendModeActive",Property,Good,false +Word.Selection,"isInsertionPointAtEndOfLine",Property,Good,false +Word.Selection,"isStartActive",Property,Great,false +Word.Selection,"languageDetected",Property,Great,false +Word.Selection,"languageId",Property,Fine,false +Word.Selection,"languageIdFarEast",Property,Fine,false +Word.Selection,"languageIdOther",Property,Great,false +Word.Selection,"orientation",Property,Great,false +Word.Selection,"paragraphs",Property,Great,false +Word.Selection,"range",Property,Great,false +Word.Selection,"sections",Property,Great,false +Word.Selection,"sentences",Property,Excellent,false +Word.Selection,"shading",Property,Great,false +Word.Selection,"start",Property,Great,false +Word.Selection,"storyLength",Property,Good,false +Word.Selection,"storyType",Property,Fine,false +Word.Selection,"tables",Property,Great,false +Word.Selection,"text",Property,Good,false +Word.Selection,"topLevelTables",Property,Good,false +Word.Selection,"type",Property,Fine,false +Word.Selection,"words",Property,Excellent,false +Word.Selection,"calculate()",Method,Great,false +Word.Selection,"cancelMode()",Method,Fine,false +Word.Selection,"clearCharacterStyleFormatting()",Method,Fine,false +Word.Selection,"clearFormatting()",Method,Fine,false +Word.Selection,"clearManualCharacterFormatting()",Method,Fine,false +Word.Selection,"clearManualParagraphFormatting()",Method,Fine,false +Word.Selection,"clearParagraphFormatting()",Method,Fine,false +Word.Selection,"clearParagraphStyle()",Method,Fine,false +Word.Selection,"collapse(direction)",Method,Fine,false +Word.Selection,"collapse(direction)",Method,Fine,false +Word.Selection,"convertToTable(options)",Method,Fine,false +Word.Selection,"copyAsPictureToClipboard()",Method,Fine,false +Word.Selection,"copyFormat()",Method,Fine,false +Word.Selection,"copyToClipboard()",Method,Poor,false +Word.Selection,"createTextBox()",Method,Good,false +Word.Selection,"cut()",Method,Fine,false +Word.Selection,"delete(options)",Method,Great,false +Word.Selection,"detectLanguage()",Method,Fine,false +Word.Selection,"expand(unit)",Method,Poor,false +Word.Selection,"expand(unit)",Method,Poor,false +Word.Selection,"expandToWholeStory()",Method,Poor,false +Word.Selection,"extend(character)",Method,Good,false +Word.Selection,"extend(character)",Method,Good,false +Word.Selection,"getNextRange(options)",Method,Great,false +Word.Selection,"getPreviousRange(options)",Method,Great,false +Word.Selection,"goTo(options)",Method,Excellent,false +Word.Selection,"goToNext(what)",Method,Excellent,false +Word.Selection,"goToNext(what)",Method,Excellent,false +Word.Selection,"goToPrevious(what)",Method,Excellent,false +Word.Selection,"goToPrevious(what)",Method,Excellent,false +Word.Selection,"insertAfter(text)",Method,Good,false +Word.Selection,"insertBefore(text)",Method,Fine,false +Word.Selection,"insertCells(shiftCells)",Method,Poor,false +Word.Selection,"insertCells(shiftCells)",Method,Poor,false +Word.Selection,"insertColumnsLeft()",Method,Fine,false +Word.Selection,"insertColumnsRight()",Method,Fine,false +Word.Selection,"insertDateTime(options)",Method,Good,false +Word.Selection,"insertFormula(options)",Method,Good,false +Word.Selection,"insertNewPage()",Method,Fine,false +Word.Selection,"insertParagraphAfter()",Method,Poor,false +Word.Selection,"insertParagraphBefore()",Method,Fine,false +Word.Selection,"insertParagraphStyleSeparator()",Method,Good,false +Word.Selection,"insertRowsAbove(numRows)",Method,Poor,false +Word.Selection,"insertRowsBelow(numRows)",Method,Poor,false +Word.Selection,"insertSymbol(characterNumber, options)",Method,Good,false +Word.Selection,"insertText(Text)",Method,Fine,false +Word.Selection,"insertXML(xml, transform)",Method,Good,false +Word.Selection,"isEqual(range)",Method,Great,false +Word.Selection,"isInRange(range)",Method,Excellent,false +Word.Selection,"isInStory(range)",Method,Great,false +Word.Selection,"load(options)",Method,Excellent,false +Word.Selection,"load(propertyNames)",Method,Excellent,false +Word.Selection,"load(propertyNamesAndPaths)",Method,Excellent,false +Word.Selection,"move(options)",Method,Great,false +Word.Selection,"moveDown(options)",Method,Poor,false +Word.Selection,"moveEnd(options)",Method,Fine,false +Word.Selection,"moveEndUntil(characters, count)",Method,Good,false +Word.Selection,"moveEndWhile(characters, count)",Method,Good,false +Word.Selection,"moveLeft(options)",Method,Poor,false +Word.Selection,"moveRight(options)",Method,Poor,false +Word.Selection,"moveStart(options)",Method,Poor,false +Word.Selection,"moveStartUntil(characters, count)",Method,Good,false +Word.Selection,"moveStartWhile(characters, count)",Method,Good,false +Word.Selection,"moveUntil(characters, count)",Method,Good,false +Word.Selection,"moveUp(options)",Method,Poor,false +Word.Selection,"moveWhile(characters, count)",Method,Good,false +Word.Selection,"nextField()",Method,Fine,false +Word.Selection,"nextSubdocument()",Method,Poor,false +Word.Selection,"pasteAndFormat(type)",Method,Good,false +Word.Selection,"pasteAndFormat(type)",Method,Good,false +Word.Selection,"pasteExcelTable(linkedToExcel, wordFormatting, rtf)",Method,Poor,false +Word.Selection,"pasteFormat()",Method,Good,false +Word.Selection,"pasteTableCellsAppendTable()",Method,Fine,false +Word.Selection,"pasteTableCellsAsNestedTable()",Method,Fine,false +Word.Selection,"previousField()",Method,Good,false +Word.Selection,"previousSubdocument()",Method,Poor,false +Word.Selection,"replaceParagraph()",Method,Poor,false +Word.Selection,"select()",Method,Poor,false +Word.Selection,"selectCell()",Method,Good,false +Word.Selection,"selectColumn()",Method,Good,false +Word.Selection,"selectCurrentAlignment()",Method,Good,false +Word.Selection,"selectCurrentColor()",Method,Good,false +Word.Selection,"selectCurrentFont()",Method,Good,false +Word.Selection,"selectCurrentIndent()",Method,Good,false +Word.Selection,"selectCurrentSpacing()",Method,Good,false +Word.Selection,"selectCurrentTabs()",Method,Good,false +Word.Selection,"selectRow()",Method,Good,false +Word.Selection,"setRange(start, end)",Method,Great,false +Word.Selection,"shrink()",Method,Good,false +Word.Selection,"shrinkDiscontiguousSelection()",Method,Good,false +Word.Selection,"splitTable()",Method,Great,false +Word.Selection,"toggleCharacterCode()",Method,Good,false +Word.Selection,"toJSON()",Method,Excellent,false +Word.Selection,"track()",Method,Excellent,false +Word.Selection,"typeBackspace()",Method,Great,false +Word.Selection,"untrack()",Method,Excellent,false +Word.SelectionConvertToTableOptions,N/A,Interface,Unknown,false +Word.SelectionConvertToTableOptions,"applyBorders",Property,Excellent,false +Word.SelectionConvertToTableOptions,"applyColor",Property,Excellent,false +Word.SelectionConvertToTableOptions,"applyFirstColumn",Property,Excellent,false +Word.SelectionConvertToTableOptions,"applyFont",Property,Excellent,false +Word.SelectionConvertToTableOptions,"applyHeadingRows",Property,Excellent,false +Word.SelectionConvertToTableOptions,"applyLastColumn",Property,Excellent,false +Word.SelectionConvertToTableOptions,"applyLastRow",Property,Excellent,false +Word.SelectionConvertToTableOptions,"applyShading",Property,Excellent,false +Word.SelectionConvertToTableOptions,"autoFit",Property,Excellent,false +Word.SelectionConvertToTableOptions,"autoFitBehavior",Property,Excellent,false +Word.SelectionConvertToTableOptions,"defaultTableBehavior",Property,Excellent,false +Word.SelectionConvertToTableOptions,"format",Property,Excellent,false +Word.SelectionConvertToTableOptions,"initialColumnWidth",Property,Excellent,false +Word.SelectionConvertToTableOptions,"numColumns",Property,Great,false +Word.SelectionConvertToTableOptions,"numRows",Property,Great,false +Word.SelectionConvertToTableOptions,"separator",Property,Excellent,false +Word.SelectionDeleteOptions,N/A,Interface,Unknown,false +Word.SelectionDeleteOptions,"count",Property,Excellent,false +Word.SelectionDeleteOptions,"unit",Property,Excellent,false +Word.SelectionGoToOptions,N/A,Interface,Unknown,false +Word.SelectionGoToOptions,"count",Property,Excellent,false +Word.SelectionGoToOptions,"direction",Property,Excellent,false +Word.SelectionGoToOptions,"item",Property,Excellent,false +Word.SelectionGoToOptions,"name",Property,Excellent,false +Word.SelectionInsertCrossReferenceOptions,N/A,Interface,Unknown,false +Word.SelectionInsertCrossReferenceOptions,"includePosition",Property,Excellent,false +Word.SelectionInsertCrossReferenceOptions,"insertAsHyperlink",Property,Excellent,false +Word.SelectionInsertCrossReferenceOptions,"separateNumbers",Property,Excellent,false +Word.SelectionInsertCrossReferenceOptions,"separatorString",Property,Excellent,false +Word.SelectionInsertDateTimeOptions,N/A,Interface,Unknown,false +Word.SelectionInsertDateTimeOptions,"calendarType",Property,Excellent,false +Word.SelectionInsertDateTimeOptions,"dateLanguage",Property,Excellent,false +Word.SelectionInsertDateTimeOptions,"dateTimeFormat",Property,Excellent,false +Word.SelectionInsertDateTimeOptions,"insertAsField",Property,Excellent,false +Word.SelectionInsertDateTimeOptions,"insertAsFullWidth",Property,Excellent,false +Word.SelectionInsertFormulaOptions,N/A,Interface,Unknown,false +Word.SelectionInsertFormulaOptions,"formula",Property,Excellent,false +Word.SelectionInsertFormulaOptions,"numberFormat",Property,Excellent,false +Word.SelectionInsertSymbolOptions,N/A,Interface,Unknown,false +Word.SelectionInsertSymbolOptions,"bias",Property,Excellent,false +Word.SelectionInsertSymbolOptions,"font",Property,Great,false +Word.SelectionInsertSymbolOptions,"unicode",Property,Excellent,false Word.SelectionMode,N/A,Enum,Fine,true Word.SelectionMode,"end",EnumField,Fine,false Word.SelectionMode,"select",EnumField,Fine,false Word.SelectionMode,"start",EnumField,Fine,false +Word.SelectionMoveLeftRightOptions,N/A,Interface,Unknown,false +Word.SelectionMoveLeftRightOptions,"count",Property,Excellent,false +Word.SelectionMoveLeftRightOptions,"extend",Property,Excellent,false +Word.SelectionMoveLeftRightOptions,"unit",Property,Excellent,false +Word.SelectionMoveOptions,N/A,Interface,Unknown,false +Word.SelectionMoveOptions,"count",Property,Excellent,false +Word.SelectionMoveOptions,"unit",Property,Excellent,false +Word.SelectionMoveStartEndOptions,N/A,Interface,Unknown,false +Word.SelectionMoveStartEndOptions,"count",Property,Excellent,false +Word.SelectionMoveStartEndOptions,"unit",Property,Excellent,false +Word.SelectionMoveUpDownOptions,N/A,Interface,Unknown,false +Word.SelectionMoveUpDownOptions,"count",Property,Excellent,false +Word.SelectionMoveUpDownOptions,"extend",Property,Excellent,false +Word.SelectionMoveUpDownOptions,"unit",Property,Excellent,false +Word.SelectionNextOptions,N/A,Interface,Unknown,false +Word.SelectionNextOptions,"count",Property,Excellent,false +Word.SelectionNextOptions,"unit",Property,Excellent,false +Word.SelectionPreviousOptions,N/A,Interface,Unknown,false +Word.SelectionPreviousOptions,"count",Property,Excellent,false +Word.SelectionPreviousOptions,"unit",Property,Excellent,false +Word.SelectionType,N/A,Enum,Unknown,false +Word.SelectionType,"block",EnumField,Fine,false +Word.SelectionType,"column",EnumField,Fine,false +Word.SelectionType,"frame",EnumField,Fine,false +Word.SelectionType,"inlineShape",EnumField,Fine,false +Word.SelectionType,"insertionPoint",EnumField,Fine,false +Word.SelectionType,"normal",EnumField,Fine,false +Word.SelectionType,"noSelection",EnumField,Fine,false +Word.SelectionType,"row",EnumField,Fine,false +Word.SelectionType,"selectionShape",EnumField,Fine,false Word.Setting,N/A,Class,Unknown,true Word.Setting,"context",Property,Excellent,false Word.Setting,"key",Property,Poor,true @@ -16146,6 +16821,17 @@ Word.ShowSourceDocuments,"both",EnumField,Great,false Word.ShowSourceDocuments,"none",EnumField,Great,false Word.ShowSourceDocuments,"original",EnumField,Great,false Word.ShowSourceDocuments,"revised",EnumField,Great,false +Word.SortFieldType,N/A,Enum,Unknown,false +Word.SortFieldType,"alphanumeric",EnumField,Fine,false +Word.SortFieldType,"date",EnumField,Fine,false +Word.SortFieldType,"japanJis",EnumField,Fine,false +Word.SortFieldType,"koreaKs",EnumField,Fine,false +Word.SortFieldType,"numeric",EnumField,Fine,false +Word.SortFieldType,"stroke",EnumField,Fine,false +Word.SortFieldType,"syllable",EnumField,Fine,false +Word.SortOrder,N/A,Enum,Unknown,false +Word.SortOrder,"ascending",EnumField,Fine,false +Word.SortOrder,"descending",EnumField,Fine,false Word.Source,N/A,Class,Unknown,false Word.Source,"context",Property,Excellent,false Word.Source,"isCited",Property,Great,false @@ -16298,7 +16984,9 @@ Word.TabAlignment,"list",EnumField,Fine,false Word.TabAlignment,"right",EnumField,Fine,false Word.Table,N/A,Class,Unknown,true Word.Table,"alignment",Property,Excellent,true +Word.Table,"columns",Property,Great,false Word.Table,"context",Property,Excellent,false +Word.Table,"description",Property,Good,false Word.Table,"endnotes",Property,Poor,false Word.Table,"fields",Property,Good,false Word.Table,"font",Property,Fine,false @@ -16316,6 +17004,7 @@ Word.Table,"parentTableCellOrNullObject",Property,Excellent,false Word.Table,"parentTableOrNullObject",Property,Excellent,false Word.Table,"rowCount",Property,Poor,false Word.Table,"rows",Property,Poor,true +Word.Table,"shading",Property,Great,false Word.Table,"shadingColor",Property,Great,false Word.Table,"style",Property,Excellent,false Word.Table,"styleBandedColumns",Property,Good,false @@ -16325,13 +17014,19 @@ Word.Table,"styleFirstColumn",Property,Great,false Word.Table,"styleLastColumn",Property,Great,false Word.Table,"styleTotalRow",Property,Great,false Word.Table,"tables",Property,Poor,false +Word.Table,"title",Property,Good,false Word.Table,"values",Property,Excellent,false Word.Table,"verticalAlignment",Property,Excellent,true Word.Table,"width",Property,Good,false Word.Table,"addColumns(insertLocation, columnCount, values)",Method,Excellent,false Word.Table,"addRows(insertLocation, rowCount, values)",Method,Excellent,false +Word.Table,"applyStyleDirectFormatting(styleName)",Method,Good,false +Word.Table,"autoFitBehavior(behavior)",Method,Great,false +Word.Table,"autoFitBehavior(behavior)",Method,Great,false Word.Table,"autoFitWindow()",Method,Fine,false +Word.Table,"autoFormat(options)",Method,Poor,false Word.Table,"clear()",Method,Poor,false +Word.Table,"convertToText(options)",Method,Poor,false Word.Table,"delete()",Method,Fine,false Word.Table,"deleteColumns(columnIndex, columnCount)",Method,Great,false Word.Table,"deleteRows(rowIndex, rowCount)",Method,Good,false @@ -16356,6 +17051,7 @@ Word.Table,"load(options)",Method,Excellent,false Word.Table,"load(propertyNames)",Method,Excellent,false Word.Table,"load(propertyNamesAndPaths)",Method,Excellent,false Word.Table,"mergeCells(topRow, firstCell, bottomRow, lastCell)",Method,Fine,false +Word.Table,"reapplyAutoFormat()",Method,Excellent,false Word.Table,"search(searchText, searchOptions)",Method,Excellent,false Word.Table,"select(selectionMode)",Method,Fine,false Word.Table,"select(selectionMode)",Method,Fine,false @@ -16363,6 +17059,7 @@ Word.Table,"set(properties, options)",Method,Good,false Word.Table,"set(properties)",Method,Good,false Word.Table,"setCellPadding(cellPaddingLocation, cellPadding)",Method,Poor,false Word.Table,"setCellPadding(cellPaddingLocation, cellPadding)",Method,Poor,false +Word.Table,"sort(options)",Method,Fine,false Word.Table,"toJSON()",Method,Excellent,false Word.Table,"track()",Method,Excellent,false Word.Table,"untrack()",Method,Excellent,false @@ -16373,6 +17070,17 @@ Word.TabLeader,"heavy",EnumField,Good,false Word.TabLeader,"lines",EnumField,Good,false Word.TabLeader,"middleDot",EnumField,Good,false Word.TabLeader,"spaces",EnumField,Good,false +Word.TableAutoFormatOptions,N/A,Interface,Unknown,false +Word.TableAutoFormatOptions,"applyBorders",Property,Excellent,false +Word.TableAutoFormatOptions,"applyColor",Property,Excellent,false +Word.TableAutoFormatOptions,"applyFirstColumn",Property,Excellent,false +Word.TableAutoFormatOptions,"applyFont",Property,Excellent,false +Word.TableAutoFormatOptions,"applyHeadingRows",Property,Excellent,false +Word.TableAutoFormatOptions,"applyLastColumn",Property,Excellent,false +Word.TableAutoFormatOptions,"applyLastRow",Property,Excellent,false +Word.TableAutoFormatOptions,"applyShading",Property,Excellent,false +Word.TableAutoFormatOptions,"autoFit",Property,Excellent,false +Word.TableAutoFormatOptions,"format",Property,Excellent,false Word.TableBorder,N/A,Class,Unknown,true Word.TableBorder,"color",Property,Good,true Word.TableBorder,"context",Property,Excellent,false @@ -16389,18 +17097,23 @@ Word.TableBorder,"untrack()",Method,Excellent,false Word.TableCell,N/A,Class,Unknown,true Word.TableCell,"body",Property,Fine,false Word.TableCell,"cellIndex",Property,Poor,false +Word.TableCell,"column",Property,Great,false Word.TableCell,"columnWidth",Property,Great,false Word.TableCell,"context",Property,Excellent,false Word.TableCell,"horizontalAlignment",Property,Excellent,true Word.TableCell,"parentRow",Property,Poor,false Word.TableCell,"parentTable",Property,Poor,false Word.TableCell,"rowIndex",Property,Poor,false +Word.TableCell,"shading",Property,Great,false Word.TableCell,"shadingColor",Property,Great,false Word.TableCell,"value",Property,Good,false Word.TableCell,"verticalAlignment",Property,Excellent,true Word.TableCell,"width",Property,Poor,false +Word.TableCell,"autoSum()",Method,Excellent,false +Word.TableCell,"delete(shiftCells)",Method,Excellent,false Word.TableCell,"deleteColumn()",Method,Great,false Word.TableCell,"deleteRow()",Method,Fine,false +Word.TableCell,"formula(options)",Method,Great,false Word.TableCell,"getBorder(borderLocation)",Method,Fine,false Word.TableCell,"getBorder(borderLocation)",Method,Fine,true Word.TableCell,"getCellPadding(cellPaddingLocation)",Method,Poor,false @@ -16412,6 +17125,8 @@ Word.TableCell,"insertRows(insertLocation, rowCount, values)",Method,Excellent,f Word.TableCell,"load(options)",Method,Excellent,false Word.TableCell,"load(propertyNames)",Method,Excellent,false Word.TableCell,"load(propertyNamesAndPaths)",Method,Excellent,false +Word.TableCell,"merge(mergeTo)",Method,Good,false +Word.TableCell,"select()",Method,Poor,false Word.TableCell,"set(properties, options)",Method,Good,false Word.TableCell,"set(properties)",Method,Good,false Word.TableCell,"setCellPadding(cellPaddingLocation, cellPadding)",Method,Poor,false @@ -16423,14 +17138,37 @@ Word.TableCell,"untrack()",Method,Excellent,false Word.TableCellCollection,N/A,Class,Unknown,true Word.TableCellCollection,"context",Property,Excellent,false Word.TableCellCollection,"items",Property,Poor,false +Word.TableCellCollection,"autoFit()",Method,Fine,false +Word.TableCellCollection,"delete(shiftCells)",Method,Excellent,false +Word.TableCellCollection,"delete(shiftCells)",Method,Excellent,false +Word.TableCellCollection,"distributeHeight()",Method,Good,false +Word.TableCellCollection,"distributeWidth()",Method,Good,false Word.TableCellCollection,"getFirst()",Method,Great,false Word.TableCellCollection,"getFirstOrNullObject()",Method,Excellent,false Word.TableCellCollection,"load(options)",Method,Excellent,false Word.TableCellCollection,"load(propertyNames)",Method,Excellent,false Word.TableCellCollection,"load(propertyNamesAndPaths)",Method,Excellent,false +Word.TableCellCollection,"merge()",Method,Fine,false +Word.TableCellCollection,"setHeight(rowHeight, heightRule)",Method,Poor,false +Word.TableCellCollection,"setHeight(rowHeight, heightRule)",Method,Poor,false +Word.TableCellCollection,"setWidth(columnWidth, rulerStyle)",Method,Poor,false +Word.TableCellCollection,"setWidth(columnWidth, rulerStyle)",Method,Poor,false +Word.TableCellCollection,"split(options)",Method,Poor,false Word.TableCellCollection,"toJSON()",Method,Excellent,false Word.TableCellCollection,"track()",Method,Excellent,false Word.TableCellCollection,"untrack()",Method,Excellent,false +Word.TableCellCollectionSplitOptions,N/A,Interface,Unknown,false +Word.TableCellCollectionSplitOptions,"mergeBeforeSplit",Property,Excellent,false +Word.TableCellCollectionSplitOptions,"numColumns",Property,Excellent,false +Word.TableCellCollectionSplitOptions,"numRows",Property,Excellent,false +Word.TableCellFormulaOptions,N/A,Interface,Great,false +Word.TableCellFormulaOptions,"formula",Property,Excellent,false +Word.TableCellFormulaOptions,"numFormat",Property,Good,false +Word.TableCellInsertionLocation,N/A,Enum,Unknown,false +Word.TableCellInsertionLocation,"shiftColumnRight",EnumField,Fine,false +Word.TableCellInsertionLocation,"shiftDown",EnumField,Fine,false +Word.TableCellInsertionLocation,"shiftRight",EnumField,Fine,false +Word.TableCellInsertionLocation,"shiftRowDown",EnumField,Fine,false Word.TableCollection,N/A,Class,Unknown,true Word.TableCollection,"context",Property,Excellent,false Word.TableCollection,"items",Property,Poor,false @@ -16483,6 +17221,278 @@ Word.TableColumnCollection,"setWidth(columnWidth, rulerStyle)",Method,Poor,false Word.TableColumnCollection,"toJSON()",Method,Excellent,false Word.TableColumnCollection,"track()",Method,Excellent,false Word.TableColumnCollection,"untrack()",Method,Excellent,false +Word.TableConvertToTextOptions,N/A,Interface,Unknown,false +Word.TableConvertToTextOptions,"nestedTables",Property,Excellent,false +Word.TableConvertToTextOptions,"separator",Property,Excellent,false +Word.TableDirection,N/A,Enum,Unknown,false +Word.TableDirection,"leftToRight",EnumField,Fine,false +Word.TableDirection,"rightToLeft",EnumField,Fine,false +Word.TableFieldSeparator,N/A,Enum,Unknown,false +Word.TableFieldSeparator,"comma",EnumField,Fine,false +Word.TableFieldSeparator,"defaultListSeparator",EnumField,Good,false +Word.TableFieldSeparator,"paragraph",EnumField,Fine,false +Word.TableFieldSeparator,"tab",EnumField,Fine,false +Word.TableFormat,N/A,Enum,Unknown,false +Word.TableFormat,"classic1",EnumField,Fine,false +Word.TableFormat,"classic2",EnumField,Fine,false +Word.TableFormat,"classic3",EnumField,Fine,false +Word.TableFormat,"classic4",EnumField,Fine,false +Word.TableFormat,"colorful1",EnumField,Fine,false +Word.TableFormat,"colorful2",EnumField,Fine,false +Word.TableFormat,"colorful3",EnumField,Fine,false +Word.TableFormat,"columns1",EnumField,Fine,false +Word.TableFormat,"columns2",EnumField,Fine,false +Word.TableFormat,"columns3",EnumField,Fine,false +Word.TableFormat,"columns4",EnumField,Fine,false +Word.TableFormat,"columns5",EnumField,Fine,false +Word.TableFormat,"contemporary",EnumField,Fine,false +Word.TableFormat,"elegant",EnumField,Fine,false +Word.TableFormat,"grid1",EnumField,Fine,false +Word.TableFormat,"grid2",EnumField,Fine,false +Word.TableFormat,"grid3",EnumField,Fine,false +Word.TableFormat,"grid4",EnumField,Fine,false +Word.TableFormat,"grid5",EnumField,Fine,false +Word.TableFormat,"grid6",EnumField,Fine,false +Word.TableFormat,"grid7",EnumField,Fine,false +Word.TableFormat,"grid8",EnumField,Fine,false +Word.TableFormat,"list1",EnumField,Fine,false +Word.TableFormat,"list2",EnumField,Fine,false +Word.TableFormat,"list3",EnumField,Fine,false +Word.TableFormat,"list4",EnumField,Fine,false +Word.TableFormat,"list5",EnumField,Fine,false +Word.TableFormat,"list6",EnumField,Fine,false +Word.TableFormat,"list7",EnumField,Fine,false +Word.TableFormat,"list8",EnumField,Fine,false +Word.TableFormat,"none",EnumField,Fine,false +Word.TableFormat,"professional",EnumField,Fine,false +Word.TableFormat,"simple1",EnumField,Fine,false +Word.TableFormat,"simple2",EnumField,Fine,false +Word.TableFormat,"simple3",EnumField,Fine,false +Word.TableFormat,"subtle1",EnumField,Fine,false +Word.TableFormat,"subtle2",EnumField,Fine,false +Word.TableFormat,"threeDEffects1",EnumField,Good,false +Word.TableFormat,"threeDEffects2",EnumField,Good,false +Word.TableFormat,"threeDEffects3",EnumField,Good,false +Word.TableFormat,"web1",EnumField,Fine,false +Word.TableFormat,"web2",EnumField,Fine,false +Word.TableFormat,"web3",EnumField,Fine,false +Word.TableFormatType,N/A,Enum,Unknown,false +Word.TableFormatType,"classic1",EnumField,Fine,false +Word.TableFormatType,"classic2",EnumField,Fine,false +Word.TableFormatType,"classic3",EnumField,Fine,false +Word.TableFormatType,"classic4",EnumField,Fine,false +Word.TableFormatType,"colorful1",EnumField,Fine,false +Word.TableFormatType,"colorful2",EnumField,Fine,false +Word.TableFormatType,"colorful3",EnumField,Fine,false +Word.TableFormatType,"columns1",EnumField,Fine,false +Word.TableFormatType,"columns2",EnumField,Fine,false +Word.TableFormatType,"columns3",EnumField,Fine,false +Word.TableFormatType,"columns4",EnumField,Fine,false +Word.TableFormatType,"columns5",EnumField,Fine,false +Word.TableFormatType,"contemporary",EnumField,Fine,false +Word.TableFormatType,"elegant",EnumField,Fine,false +Word.TableFormatType,"grid1",EnumField,Fine,false +Word.TableFormatType,"grid2",EnumField,Fine,false +Word.TableFormatType,"grid3",EnumField,Fine,false +Word.TableFormatType,"grid4",EnumField,Fine,false +Word.TableFormatType,"grid5",EnumField,Fine,false +Word.TableFormatType,"grid6",EnumField,Fine,false +Word.TableFormatType,"grid7",EnumField,Fine,false +Word.TableFormatType,"grid8",EnumField,Fine,false +Word.TableFormatType,"list1",EnumField,Fine,false +Word.TableFormatType,"list2",EnumField,Fine,false +Word.TableFormatType,"list3",EnumField,Fine,false +Word.TableFormatType,"list4",EnumField,Fine,false +Word.TableFormatType,"list5",EnumField,Fine,false +Word.TableFormatType,"list6",EnumField,Fine,false +Word.TableFormatType,"list7",EnumField,Fine,false +Word.TableFormatType,"list8",EnumField,Fine,false +Word.TableFormatType,"none",EnumField,Fine,false +Word.TableFormatType,"professional",EnumField,Fine,false +Word.TableFormatType,"simple1",EnumField,Fine,false +Word.TableFormatType,"simple2",EnumField,Fine,false +Word.TableFormatType,"simple3",EnumField,Fine,false +Word.TableFormatType,"subtle1",EnumField,Fine,false +Word.TableFormatType,"subtle2",EnumField,Fine,false +Word.TableFormatType,"threeDEffects1",EnumField,Good,false +Word.TableFormatType,"threeDEffects2",EnumField,Good,false +Word.TableFormatType,"threeDEffects3",EnumField,Good,false +Word.TableFormatType,"web1",EnumField,Fine,false +Word.TableFormatType,"web2",EnumField,Fine,false +Word.TableFormatType,"web3",EnumField,Fine,false +Word.TableOfAuthorities,N/A,Class,Unknown,false +Word.TableOfAuthorities,"bookmark",Property,Great,false +Word.TableOfAuthorities,"category",Property,Excellent,false +Word.TableOfAuthorities,"context",Property,Excellent,false +Word.TableOfAuthorities,"entrySeparator",Property,Great,false +Word.TableOfAuthorities,"isCategoryHeaderIncluded",Property,Great,false +Word.TableOfAuthorities,"isEntryFormattingKept",Property,Great,false +Word.TableOfAuthorities,"isPassimUsed",Property,Great,false +Word.TableOfAuthorities,"pageNumberSeparator",Property,Great,false +Word.TableOfAuthorities,"pageRangeSeparator",Property,Great,false +Word.TableOfAuthorities,"range",Property,Fine,false +Word.TableOfAuthorities,"sequenceName",Property,Excellent,false +Word.TableOfAuthorities,"sequenceSeparator",Property,Great,false +Word.TableOfAuthorities,"tabLeader",Property,Great,false +Word.TableOfAuthorities,"delete()",Method,Fine,false +Word.TableOfAuthorities,"load(options)",Method,Excellent,false +Word.TableOfAuthorities,"load(propertyNames)",Method,Excellent,false +Word.TableOfAuthorities,"load(propertyNamesAndPaths)",Method,Excellent,false +Word.TableOfAuthorities,"set(properties, options)",Method,Good,false +Word.TableOfAuthorities,"set(properties)",Method,Good,false +Word.TableOfAuthorities,"toJSON()",Method,Excellent,false +Word.TableOfAuthorities,"track()",Method,Excellent,false +Word.TableOfAuthorities,"untrack()",Method,Excellent,false +Word.TableOfAuthoritiesAddOptions,N/A,Interface,Excellent,false +Word.TableOfAuthoritiesAddOptions,"bookmark",Property,Excellent,false +Word.TableOfAuthoritiesAddOptions,"category",Property,Excellent,false +Word.TableOfAuthoritiesAddOptions,"entrySeparator",Property,Excellent,false +Word.TableOfAuthoritiesAddOptions,"includeCategoryHeader",Property,Excellent,false +Word.TableOfAuthoritiesAddOptions,"keepEntryFormatting",Property,Excellent,false +Word.TableOfAuthoritiesAddOptions,"pageNumberSeparator",Property,Excellent,false +Word.TableOfAuthoritiesAddOptions,"pageRangeSeparator",Property,Excellent,false +Word.TableOfAuthoritiesAddOptions,"sequenceName",Property,Excellent,false +Word.TableOfAuthoritiesAddOptions,"sequenceSeparator",Property,Excellent,false +Word.TableOfAuthoritiesAddOptions,"usePassim",Property,Excellent,false +Word.TableOfAuthoritiesCategory,N/A,Class,Unknown,false +Word.TableOfAuthoritiesCategory,"context",Property,Excellent,false +Word.TableOfAuthoritiesCategory,"name",Property,Excellent,false +Word.TableOfAuthoritiesCategory,"load(options)",Method,Excellent,false +Word.TableOfAuthoritiesCategory,"load(propertyNames)",Method,Excellent,false +Word.TableOfAuthoritiesCategory,"load(propertyNamesAndPaths)",Method,Excellent,false +Word.TableOfAuthoritiesCategory,"toJSON()",Method,Excellent,false +Word.TableOfAuthoritiesCategory,"track()",Method,Excellent,false +Word.TableOfAuthoritiesCategory,"untrack()",Method,Excellent,false +Word.TableOfAuthoritiesCategoryCollection,N/A,Class,Unknown,false +Word.TableOfAuthoritiesCategoryCollection,"context",Property,Excellent,false +Word.TableOfAuthoritiesCategoryCollection,"items",Property,Poor,false +Word.TableOfAuthoritiesCategoryCollection,"getCount()",Method,Fine,false +Word.TableOfAuthoritiesCategoryCollection,"getItemAt(index)",Method,Excellent,false +Word.TableOfAuthoritiesCategoryCollection,"load(options)",Method,Excellent,false +Word.TableOfAuthoritiesCategoryCollection,"load(propertyNames)",Method,Excellent,false +Word.TableOfAuthoritiesCategoryCollection,"load(propertyNamesAndPaths)",Method,Excellent,false +Word.TableOfAuthoritiesCategoryCollection,"toJSON()",Method,Excellent,false +Word.TableOfAuthoritiesCategoryCollection,"track()",Method,Excellent,false +Word.TableOfAuthoritiesCategoryCollection,"untrack()",Method,Excellent,false +Word.TableOfAuthoritiesCollection,N/A,Class,Unknown,false +Word.TableOfAuthoritiesCollection,"context",Property,Excellent,false +Word.TableOfAuthoritiesCollection,"items",Property,Poor,false +Word.TableOfAuthoritiesCollection,"add(range, options)",Method,Good,false +Word.TableOfAuthoritiesCollection,"load(options)",Method,Excellent,false +Word.TableOfAuthoritiesCollection,"load(propertyNames)",Method,Excellent,false +Word.TableOfAuthoritiesCollection,"load(propertyNamesAndPaths)",Method,Excellent,false +Word.TableOfAuthoritiesCollection,"markAllCitations(shortCitation, options)",Method,Great,false +Word.TableOfAuthoritiesCollection,"markCitation(range, shortCitation, options)",Method,Great,false +Word.TableOfAuthoritiesCollection,"selectNextCitation(shortCitation)",Method,Good,false +Word.TableOfAuthoritiesCollection,"toJSON()",Method,Excellent,false +Word.TableOfAuthoritiesCollection,"track()",Method,Excellent,false +Word.TableOfAuthoritiesCollection,"untrack()",Method,Excellent,false +Word.TableOfAuthoritiesMarkCitationOptions,N/A,Interface,Unknown,false +Word.TableOfAuthoritiesMarkCitationOptions,"category",Property,Excellent,false +Word.TableOfAuthoritiesMarkCitationOptions,"longCitation",Property,Great,false +Word.TableOfAuthoritiesMarkCitationOptions,"longCitationAutoText",Property,Great,false +Word.TableOfContents,N/A,Class,Unknown,false +Word.TableOfContents,"additionalHeadingStyles",Property,Great,false +Word.TableOfContents,"areBuiltInHeadingStylesUsed",Property,Excellent,false +Word.TableOfContents,"areFieldsUsed",Property,Excellent,false +Word.TableOfContents,"areHyperlinksUsedOnWeb",Property,Excellent,false +Word.TableOfContents,"arePageNumbersHiddenOnWeb",Property,Excellent,false +Word.TableOfContents,"arePageNumbersIncluded",Property,Great,false +Word.TableOfContents,"arePageNumbersRightAligned",Property,Great,false +Word.TableOfContents,"context",Property,Excellent,false +Word.TableOfContents,"lowerHeadingLevel",Property,Excellent,false +Word.TableOfContents,"range",Property,Fine,false +Word.TableOfContents,"tabLeader",Property,Great,false +Word.TableOfContents,"tableId",Property,Excellent,false +Word.TableOfContents,"upperHeadingLevel",Property,Excellent,false +Word.TableOfContents,"delete()",Method,Fine,false +Word.TableOfContents,"load(options)",Method,Excellent,false +Word.TableOfContents,"load(propertyNames)",Method,Excellent,false +Word.TableOfContents,"load(propertyNamesAndPaths)",Method,Excellent,false +Word.TableOfContents,"set(properties, options)",Method,Good,false +Word.TableOfContents,"set(properties)",Method,Good,false +Word.TableOfContents,"toJSON()",Method,Excellent,false +Word.TableOfContents,"track()",Method,Excellent,false +Word.TableOfContents,"untrack()",Method,Excellent,false +Word.TableOfContents,"updatePageNumbers()",Method,Fine,false +Word.TableOfContentsAddOptions,N/A,Interface,Excellent,false +Word.TableOfContentsAddOptions,"addedStyles",Property,Excellent,false +Word.TableOfContentsAddOptions,"hidePageNumbersOnWeb",Property,Excellent,false +Word.TableOfContentsAddOptions,"includePageNumbers",Property,Excellent,false +Word.TableOfContentsAddOptions,"lowerHeadingLevel",Property,Excellent,false +Word.TableOfContentsAddOptions,"rightAlignPageNumbers",Property,Excellent,false +Word.TableOfContentsAddOptions,"tableId",Property,Excellent,false +Word.TableOfContentsAddOptions,"upperHeadingLevel",Property,Excellent,false +Word.TableOfContentsAddOptions,"useBuiltInHeadingStyles",Property,Excellent,false +Word.TableOfContentsAddOptions,"useFields",Property,Excellent,false +Word.TableOfContentsAddOptions,"useHyperlinksOnWeb",Property,Excellent,false +Word.TableOfContentsAddOptions,"useOutlineLevels",Property,Excellent,false +Word.TableOfContentsCollection,N/A,Class,Unknown,false +Word.TableOfContentsCollection,"context",Property,Excellent,false +Word.TableOfContentsCollection,"items",Property,Poor,false +Word.TableOfContentsCollection,"add(range, options)",Method,Good,false +Word.TableOfContentsCollection,"load(options)",Method,Excellent,false +Word.TableOfContentsCollection,"load(propertyNames)",Method,Excellent,false +Word.TableOfContentsCollection,"load(propertyNamesAndPaths)",Method,Excellent,false +Word.TableOfContentsCollection,"markTocEntry(range, options)",Method,Great,false +Word.TableOfContentsCollection,"toJSON()",Method,Excellent,false +Word.TableOfContentsCollection,"track()",Method,Excellent,false +Word.TableOfContentsCollection,"untrack()",Method,Excellent,false +Word.TableOfContentsMarkEntryOptions,N/A,Interface,Unknown,false +Word.TableOfContentsMarkEntryOptions,"entry",Property,Excellent,false +Word.TableOfContentsMarkEntryOptions,"entryAutoText",Property,Excellent,false +Word.TableOfContentsMarkEntryOptions,"level",Property,Excellent,false +Word.TableOfContentsMarkEntryOptions,"tableId",Property,Great,false +Word.TableOfFigures,N/A,Class,Unknown,false +Word.TableOfFigures,"additionalHeadingStyles",Property,Great,false +Word.TableOfFigures,"areBuiltInHeadingStylesUsed",Property,Excellent,false +Word.TableOfFigures,"areFieldsUsed",Property,Excellent,false +Word.TableOfFigures,"areHyperlinksUsedOnWeb",Property,Excellent,false +Word.TableOfFigures,"arePageNumbersHiddenOnWeb",Property,Excellent,false +Word.TableOfFigures,"arePageNumbersIncluded",Property,Great,false +Word.TableOfFigures,"arePageNumbersRightAligned",Property,Great,false +Word.TableOfFigures,"captionLabel",Property,Great,false +Word.TableOfFigures,"context",Property,Excellent,false +Word.TableOfFigures,"isLabelIncluded",Property,Great,false +Word.TableOfFigures,"lowerHeadingLevel",Property,Excellent,false +Word.TableOfFigures,"range",Property,Fine,false +Word.TableOfFigures,"tabLeader",Property,Great,false +Word.TableOfFigures,"tableId",Property,Excellent,false +Word.TableOfFigures,"upperHeadingLevel",Property,Excellent,false +Word.TableOfFigures,"delete()",Method,Fine,false +Word.TableOfFigures,"load(options)",Method,Excellent,false +Word.TableOfFigures,"load(propertyNames)",Method,Excellent,false +Word.TableOfFigures,"load(propertyNamesAndPaths)",Method,Excellent,false +Word.TableOfFigures,"set(properties, options)",Method,Good,false +Word.TableOfFigures,"set(properties)",Method,Good,false +Word.TableOfFigures,"toJSON()",Method,Excellent,false +Word.TableOfFigures,"track()",Method,Excellent,false +Word.TableOfFigures,"untrack()",Method,Excellent,false +Word.TableOfFigures,"updatePageNumbers()",Method,Fine,false +Word.TableOfFiguresAddOptions,N/A,Interface,Missing,false +Word.TableOfFiguresAddOptions,"addedStyles",Property,Missing,false +Word.TableOfFiguresAddOptions,"captionLabel",Property,Missing,false +Word.TableOfFiguresAddOptions,"hidePageNumbersOnWeb",Property,Missing,false +Word.TableOfFiguresAddOptions,"includeLabel",Property,Missing,false +Word.TableOfFiguresAddOptions,"includePageNumbers",Property,Missing,false +Word.TableOfFiguresAddOptions,"lowerHeadingLevel",Property,Missing,false +Word.TableOfFiguresAddOptions,"rightAlignPageNumbers",Property,Missing,false +Word.TableOfFiguresAddOptions,"tableId",Property,Missing,false +Word.TableOfFiguresAddOptions,"upperHeadingLevel",Property,Missing,false +Word.TableOfFiguresAddOptions,"useBuiltInHeadingStyles",Property,Missing,false +Word.TableOfFiguresAddOptions,"useFields",Property,Missing,false +Word.TableOfFiguresAddOptions,"useHyperlinksOnWeb",Property,Missing,false +Word.TableOfFiguresCollection,N/A,Class,Unknown,false +Word.TableOfFiguresCollection,"context",Property,Excellent,false +Word.TableOfFiguresCollection,"items",Property,Poor,false +Word.TableOfFiguresCollection,"add(range, options)",Method,Good,false +Word.TableOfFiguresCollection,"load(options)",Method,Excellent,false +Word.TableOfFiguresCollection,"load(propertyNames)",Method,Excellent,false +Word.TableOfFiguresCollection,"load(propertyNamesAndPaths)",Method,Excellent,false +Word.TableOfFiguresCollection,"markTocEntry(range, options)",Method,Great,false +Word.TableOfFiguresCollection,"toJSON()",Method,Excellent,false +Word.TableOfFiguresCollection,"track()",Method,Excellent,false +Word.TableOfFiguresCollection,"untrack()",Method,Excellent,false Word.TableRow,N/A,Class,Missing,true Word.TableRow,"cellCount",Property,Poor,false Word.TableRow,"cells",Property,Missing,true @@ -16495,11 +17505,14 @@ Word.TableRow,"horizontalAlignment",Property,Excellent,false Word.TableRow,"isHeader",Property,Good,false Word.TableRow,"parentTable",Property,Missing,false Word.TableRow,"preferredHeight",Property,Great,false +Word.TableRow,"range",Property,Great,false Word.TableRow,"rowIndex",Property,Poor,false +Word.TableRow,"shading",Property,Great,false Word.TableRow,"shadingColor",Property,Great,false Word.TableRow,"values",Property,Excellent,false Word.TableRow,"verticalAlignment",Property,Excellent,false Word.TableRow,"clear()",Method,Poor,false +Word.TableRow,"convertToText(options)",Method,Poor,false Word.TableRow,"delete()",Method,Fine,false Word.TableRow,"getBorder(borderLocation)",Method,Poor,true Word.TableRow,"getBorder(borderLocation)",Method,Poor,false @@ -16520,29 +17533,68 @@ Word.TableRow,"set(properties, options)",Method,Good,false Word.TableRow,"set(properties)",Method,Good,false Word.TableRow,"setCellPadding(cellPaddingLocation, cellPadding)",Method,Poor,false Word.TableRow,"setCellPadding(cellPaddingLocation, cellPadding)",Method,Poor,false +Word.TableRow,"setHeight(rowHeight, heightRule)",Method,Poor,false +Word.TableRow,"setHeight(rowHeight, heightRule)",Method,Poor,false +Word.TableRow,"setLeftIndent(leftIndent, rulerStyle)",Method,Poor,false +Word.TableRow,"setLeftIndent(leftIndent, rulerStyle)",Method,Poor,false Word.TableRow,"toJSON()",Method,Excellent,false Word.TableRow,"track()",Method,Excellent,false Word.TableRow,"untrack()",Method,Excellent,false Word.TableRowCollection,N/A,Class,Unknown,true Word.TableRowCollection,"context",Property,Excellent,false Word.TableRowCollection,"items",Property,Poor,false +Word.TableRowCollection,"convertToText(options)",Method,Poor,false +Word.TableRowCollection,"delete()",Method,Fine,false +Word.TableRowCollection,"distributeHeight()",Method,Fine,false Word.TableRowCollection,"getFirst()",Method,Great,true Word.TableRowCollection,"getFirstOrNullObject()",Method,Excellent,false Word.TableRowCollection,"load(options)",Method,Excellent,false Word.TableRowCollection,"load(propertyNames)",Method,Excellent,false Word.TableRowCollection,"load(propertyNamesAndPaths)",Method,Excellent,false +Word.TableRowCollection,"select()",Method,Poor,false +Word.TableRowCollection,"setHeight(rowHeight, heightRule)",Method,Poor,false +Word.TableRowCollection,"setHeight(rowHeight, heightRule)",Method,Poor,false +Word.TableRowCollection,"setLeftIndent(leftIndent, rulerStyle)",Method,Poor,false +Word.TableRowCollection,"setLeftIndent(leftIndent, rulerStyle)",Method,Poor,false Word.TableRowCollection,"toJSON()",Method,Excellent,false Word.TableRowCollection,"track()",Method,Excellent,false Word.TableRowCollection,"untrack()",Method,Excellent,false +Word.TableSortOptions,N/A,Interface,Unknown,false +Word.TableSortOptions,"bidirectionalSort",Property,Excellent,false +Word.TableSortOptions,"caseSensitive",Property,Excellent,false +Word.TableSortOptions,"excludeHeader",Property,Excellent,false +Word.TableSortOptions,"fieldNumber",Property,Excellent,false +Word.TableSortOptions,"fieldNumber2",Property,Excellent,false +Word.TableSortOptions,"fieldNumber3",Property,Great,false +Word.TableSortOptions,"ignoreArabicThe",Property,Excellent,false +Word.TableSortOptions,"ignoreDiacritics",Property,Excellent,false +Word.TableSortOptions,"ignoreHebrew",Property,Excellent,false +Word.TableSortOptions,"ignoreKashida",Property,Excellent,false +Word.TableSortOptions,"languageId",Property,Good,false +Word.TableSortOptions,"sortFieldType",Property,Excellent,false +Word.TableSortOptions,"sortFieldType2",Property,Excellent,false +Word.TableSortOptions,"sortFieldType3",Property,Excellent,false +Word.TableSortOptions,"sortOrder",Property,Excellent,false +Word.TableSortOptions,"sortOrder2",Property,Excellent,false +Word.TableSortOptions,"sortOrder3",Property,Excellent,false Word.TableStyle,N/A,Class,Unknown,true Word.TableStyle,"alignment",Property,Great,false Word.TableStyle,"allowBreakAcrossPage",Property,Great,false +Word.TableStyle,"borders",Property,Good,false Word.TableStyle,"bottomCellMargin",Property,Great,false Word.TableStyle,"cellSpacing",Property,Great,false +Word.TableStyle,"columnStripe",Property,Excellent,false Word.TableStyle,"context",Property,Excellent,false +Word.TableStyle,"isBreakAcrossPagesAllowed",Property,Great,false Word.TableStyle,"leftCellMargin",Property,Great,false +Word.TableStyle,"leftIndent",Property,Excellent,false Word.TableStyle,"rightCellMargin",Property,Great,false +Word.TableStyle,"rowStripe",Property,Excellent,false +Word.TableStyle,"shading",Property,Great,false +Word.TableStyle,"tableDirection",Property,Great,false Word.TableStyle,"topCellMargin",Property,Great,false +Word.TableStyle,"condition(conditionCode)",Method,Excellent,false +Word.TableStyle,"condition(conditionCode)",Method,Excellent,false Word.TableStyle,"load(options)",Method,Excellent,false Word.TableStyle,"load(propertyNames)",Method,Excellent,false Word.TableStyle,"load(propertyNamesAndPaths)",Method,Excellent,false @@ -16595,6 +17647,7 @@ Word.Template,"justificationMode",Property,Great,false Word.Template,"kerningByAlgorithm",Property,Great,false Word.Template,"languageId",Property,Excellent,false Word.Template,"languageIdFarEast",Property,Great,false +Word.Template,"listTemplates",Property,Great,false Word.Template,"name",Property,Good,false Word.Template,"noLineBreakAfter",Property,Great,false Word.Template,"noLineBreakBefore",Property,Great,false @@ -16687,6 +17740,13 @@ Word.TextFrame,"set(properties)",Method,Good,false Word.TextFrame,"toJSON()",Method,Excellent,false Word.TextFrame,"track()",Method,Excellent,false Word.TextFrame,"untrack()",Method,Excellent,false +Word.TextOrientation,N/A,Enum,Unknown,false +Word.TextOrientation,"downward",EnumField,Fine,false +Word.TextOrientation,"horizontal",EnumField,Fine,false +Word.TextOrientation,"horizontalRotatedFarEast",EnumField,Fine,false +Word.TextOrientation,"upward",EnumField,Fine,false +Word.TextOrientation,"vertical",EnumField,Fine,false +Word.TextOrientation,"verticalFarEast",EnumField,Fine,false Word.TextureAlignment,N/A,Enum,Unknown,false Word.TextureAlignment,"bottom",EnumField,Fine,false Word.TextureAlignment,"bottomLeft",EnumField,Fine,false @@ -16949,7 +18009,7 @@ Word.Window,"caption",Property,Excellent,false Word.Window,"context",Property,Excellent,false Word.Window,"height",Property,Good,false Word.Window,"horizontalPercentScrolled",Property,Great,false -Word.Window,"imemode",Property,Excellent,false +Word.Window,"imeMode",Property,Excellent,false Word.Window,"index",Property,Poor,false Word.Window,"isActive",Property,Good,false Word.Window,"isDocumentMapVisible",Property,Good,false diff --git a/generate-docs/api-extractor-inputs-word/word.d.ts b/generate-docs/api-extractor-inputs-word/word.d.ts index e9705923c7..2fef787496 100644 --- a/generate-docs/api-extractor-inputs-word/word.d.ts +++ b/generate-docs/api-extractor-inputs-word/word.d.ts @@ -5,6 +5,359 @@ import { Office as Outlook} from "../api-extractor-inputs-outlook/outlook" //////////////////////////////////////////////////////////////// export declare namespace Word { + /** + * Represents the {@link Word.Editor | editors} in a protected (read-only) Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class EditorCollection 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 `Editor` object that represents a new permission for the specified user to modify a range within the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param editorId - The user's email alias (if in the same domain) or an email address. + */ + addById(editorId: string): Word.Editor; + /** + * Returns an `Editor` object that represents a new permission for the specified group of users to modify a range within the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param editorType - An `EditorType` that represents a group of users. + */ + addByType(editorType: Word.EditorType): Word.Editor; + /** + * Returns an `Editor` object that represents a new permission for the specified group of users to modify a range within the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param editorType - An `EditorType` that represents a group of users. + */ + addByType(editorType: "Current" | "Editors" | "Everyone" | "Owners"): Word.Editor; + /** + * Returns the number of items in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets an `Editor` object by its index in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index - The index of the object in this collection. + */ + getItemAt(index: number): Word.Editor; + /** + * 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[]): Word.EditorCollection; + /** + * 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; + }): Word.EditorCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.EditorCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.EditorCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.EditorCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.EditorCollectionData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): { + [key: string]: string; + }; + } + /** + * Represents a user with permissions to edit authorized portions of a protected (read-only) Word document. To learn more, see {@link https://support.microsoft.com/office/187ed01c-8795-43e1-9fd0-c9fca419dadf | Allow changes to parts of a protected Word document}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class Editor 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 a `Range` object that represents the next range that the editor has permissions to modify. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly nextRange: Word.Range; + /** + * Gets a `Range` object that represents the portion of the document that's contained in the `Editor` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly range: Word.Range; + /** + * Gets the identifier for the `Editor` object when the parent document is saved as a webpage. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly id: string; + /** + * Gets the name of the editor. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly name: string; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.EditorUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Editor): void; + /** + * Deletes the `Editor` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + delete(): void; + /** + * Removes all editing permissions in the document for the editor. The editor will be deleted next time the document opens. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + removeAllPermissions(): void; + /** + * Selects all the shapes in the document that were inserted or edited by the editor. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + selectAllShapes(): 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?: Word.Interfaces.EditorLoadOptions): Word.Editor; + /** + * 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[]): Word.Editor; + /** + * 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; + }): Word.Editor; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.Editor; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.Editor; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Editor` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.EditorData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.EditorData; + } + /** + * Represents the coauthoring conflicts in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class ConflictCollection 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: Word.Conflict[]; + /** + * Accepts all of the user's changes, removes the conflicts, and merges the changes into the server copy of the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + acceptAll(): void; + /** + * Gets a `Conflict` object by its index in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index - A number that identifies the index location of a `Conflict` object. + */ + getItem(index: number): Word.Conflict; + /** + * Rejects all of the user's changes and retains the server copy of the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + rejectAll(): 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?: Word.Interfaces.ConflictCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ConflictCollection; + /** + * 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[]): Word.ConflictCollection; + /** + * 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): Word.ConflictCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.ConflictCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.ConflictCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ConflictCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ConflictCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.ConflictCollectionData; + } + /** + * Represents a coauthoring conflict in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class Conflict 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 a `Range` object that represents the portion of the document that's contained in the `Conflict` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly range: Word.Range; + /** + * Gets the `RevisionType` for the `Conflict` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly type: Word.RevisionType | "None" | "Insert" | "Delete" | "Property" | "ParagraphNumber" | "DisplayField" | "Reconcile" | "Conflict" | "Style" | "Replace" | "ParagraphProperty" | "TableProperty" | "SectionProperty" | "StyleDefinition" | "MovedFrom" | "MovedTo" | "CellInsertion" | "CellDeletion" | "CellMerge" | "CellSplit" | "ConflictInsert" | "ConflictDelete"; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ConflictUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Conflict): void; + /** + * Accepts the user's change and removes the conflict. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + accept(): void; + /** + * Rejects the user's change, removes the conflict, and accepts the server copy of the change for the conflict. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + reject(): 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?: Word.Interfaces.ConflictLoadOptions): Word.Conflict; + /** + * 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[]): Word.Conflict; + /** + * 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; + }): Word.Conflict; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.Conflict; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.Conflict; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Conflict` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ConflictData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.ConflictData; + } /** * Represents the color scheme of a critique in the document, affecting underline and highlight. * @@ -465,6 +818,22 @@ export declare namespace Word { * @beta */ readonly bibliography: Word.Bibliography; + /** + * Returns a `FontNameCollection` object that represents all the available font names in Microsoft Word. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly fontNames: Word.FontNameCollection; + /** + * Returns a `ListTemplateGalleryCollection` object that represents all the list template galleries in Microsoft Word. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly listTemplateGalleries: Word.ListTemplateGalleryCollection; /** * Returns a `TemplateCollection` object that represents all the available templates: global templates and those attached to open documents. * @@ -2150,6 +2519,521 @@ export declare namespace Word { */ toJSON(): Word.Interfaces.CheckboxContentControlData; } + /** + * Represents a coauthoring lock in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class CoauthoringLock 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 owner of the lock. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly owner: Word.Coauthor; + /** + * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringLock` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly range: Word.Range; + /** + * Gets a `CoauthoringLockType` value that represents the lock type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly type: Word.CoauthoringLockType | "None" | "Reservation" | "Ephemeral" | "Changed"; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.CoauthoringLockUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.CoauthoringLock): void; + /** + * Removes this lock, even if it belongs to a different user. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + unlock(): 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?: Word.Interfaces.CoauthoringLockLoadOptions): Word.CoauthoringLock; + /** + * 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[]): Word.CoauthoringLock; + /** + * 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; + }): Word.CoauthoringLock; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.CoauthoringLock; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.CoauthoringLock; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.CoauthoringLock` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CoauthoringLockData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.CoauthoringLockData; + } + /** + * Represents a collection of coauthoring locks in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class CoauthoringLockCollection 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: Word.CoauthoringLock[]; + /** + * Returns a `CoauthoringLock` object that represents a lock added to a specified range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - Optional. The options to further configure the coauthoring lock. + */ + add(options?: Word.CoauthoringLockAddOptions): Word.CoauthoringLock; + /** + * Removes all ephemeral locks from the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + unlockEphemeralLocks(): 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?: Word.Interfaces.CoauthoringLockCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CoauthoringLockCollection; + /** + * 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[]): Word.CoauthoringLockCollection; + /** + * 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): Word.CoauthoringLockCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.CoauthoringLockCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.CoauthoringLockCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.CoauthoringLockCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CoauthoringLockCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.CoauthoringLockCollectionData; + } + /** + * Specifies the options for adding to a {@link Word.CoauthoringLockCollection} object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface CoauthoringLockAddOptions { + /** + * If provided, specifies the range to which the lock is added. If not provided, the new lock is placed on the paragraph that contains the insertion point. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Range; + /** + * If provided, specifies the type of lock. If not provided, the lock type is set to `reservation`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type?: Word.CoauthoringLockType | "None" | "Reservation" | "Ephemeral" | "Changed"; + } + /** + * Represents a coauthor in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class Coauthor 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 a `CoauthoringLockCollection` object that represents the locks in the document that are associated with this coauthor. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly locks: Word.CoauthoringLockCollection; + /** + * Gets the email address of the coauthor. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly emailAddress: string; + /** + * Gets the unique identifier for the `Coauthor` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly id: string; + /** + * Gets whether this author represents the current user. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly isMe: boolean; + /** + * Gets the display name of the coauthor. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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?: Word.Interfaces.CoauthorLoadOptions): Word.Coauthor; + /** + * 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[]): Word.Coauthor; + /** + * 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; + }): Word.Coauthor; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.Coauthor; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.Coauthor; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Coauthor` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CoauthorData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.CoauthorData; + } + /** + * Contains a collection of {@link Word.Coauthor} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class CoauthorCollection 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: Word.Coauthor[]; + /** + * 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?: Word.Interfaces.CoauthorCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CoauthorCollection; + /** + * 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[]): Word.CoauthorCollection; + /** + * 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): Word.CoauthorCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.CoauthorCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.CoauthorCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.CoauthorCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CoauthorCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.CoauthorCollectionData; + } + /** + * Represents the `Coauthoring` object. This tracks the updates, changes, conflicts, and other interactions in the document done through coauthoring. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class Coauthoring 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 a `CoauthorCollection` object that represents all the coauthors currently editing the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly authors: Word.CoauthorCollection; + /** + * Gets a `ConflictCollection` object that represents all the conflicts in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly conflicts: Word.ConflictCollection; + /** + * Gets a `CoauthoringLockCollection` object that represents the locks in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly locks: Word.CoauthoringLockCollection; + /** + * Gets a `Coauthor` object that represents the current user. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly me: Word.Coauthor; + /** + * Gets a `CoauthoringUpdateCollection` object that represents the most recent updates that were merged into the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly updates: Word.CoauthoringUpdateCollection; + /** + * Gets whether this document can be coauthored. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly canCoauthor: boolean; + /** + * Gets whether the document can be automatically merged. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly canMerge: boolean; + /** + * Gets whether the document has pending updates that have not been accepted. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly pendingUpdates: boolean; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Word.Interfaces.CoauthoringLoadOptions): Word.Coauthoring; + /** + * 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[]): Word.Coauthoring; + /** + * 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; + }): Word.Coauthoring; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.Coauthoring; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.Coauthoring; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Coauthoring` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CoauthoringData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.CoauthoringData; + } + /** + * Represents a coauthoring update in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class CoauthoringUpdate 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 a `Range` object that represents the portion of the document that's contained in the `CoauthoringUpdate` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly range: Word.Range; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.CoauthoringUpdateUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.CoauthoringUpdate): 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?: Word.Interfaces.CoauthoringUpdateLoadOptions): Word.CoauthoringUpdate; + /** + * 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[]): Word.CoauthoringUpdate; + /** + * 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; + }): Word.CoauthoringUpdate; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.CoauthoringUpdate; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.CoauthoringUpdate; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.CoauthoringUpdate` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CoauthoringUpdateData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.CoauthoringUpdateData; + } + /** + * Contains a collection of {@link Word.CoauthoringUpdate} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class CoauthoringUpdateCollection 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: Word.CoauthoringUpdate[]; + /** + * 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?: Word.Interfaces.CoauthoringUpdateCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CoauthoringUpdateCollection; + /** + * 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[]): Word.CoauthoringUpdateCollection; + /** + * 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): Word.CoauthoringUpdateCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.CoauthoringUpdateCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.CoauthoringUpdateCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.CoauthoringUpdateCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CoauthoringUpdateCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.CoauthoringUpdateCollectionData; + } /** * Represents a comment in the document. * @@ -2612,6 +3496,115 @@ export declare namespace Word { */ toJSON(): Word.Interfaces.CommentReplyCollectionData; } + /** + * Represents special formatting applied to specified areas of a table when the selected table is formatted with a specified table style. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class ConditionalStyle 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 `BorderUniversalCollection` object that represents all the borders for the conditional style. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly borders: Word.BorderUniversalCollection; + /** + * Returns a `Font` object that represents the font formatting for the conditional style. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly font: Word.Font; + /** + * Returns a `ParagraphFormat` object that represents the paragraph formatting for the conditional style. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly paragraphFormat: Word.ParagraphFormat; + /** + * Returns a `ShadingUniversal` object that represents the shading of the conditional style. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly shading: Word.ShadingUniversal; + /** + * Specifies the amount of space (in points) to add below the contents of a single cell or all the cells in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bottomPadding: number; + /** + * Specifies the amount of space (in points) to add to the left of the contents of a single cell or all the cells in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + leftPadding: number; + /** + * Specifies the amount of space (in points) to add to the right of the contents of a single cell or all the cells in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + rightPadding: number; + /** + * Specifies the amount of space (in points) to add above the contents of a single cell or all the cells in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + topPadding: 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?: Word.Interfaces.ConditionalStyleLoadOptions): Word.ConditionalStyle; + /** + * 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[]): Word.ConditionalStyle; + /** + * 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; + }): Word.ConditionalStyle; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.ConditionalStyle; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.ConditionalStyle; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ConditionalStyle` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ConditionalStyleData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.ConditionalStyleData; + } /** * Represents the XML mapping on a {@link Word.ContentControl} object between custom XML and that content control. An XML mapping is a link between the text in a content control and an XML element in the custom XML data store for this document. * @@ -5582,6 +6575,14 @@ export declare namespace Word { * @beta */ readonly bookmarks: Word.BookmarkCollection; + /** + * Gets a `Coauthoring` object for managing coauthoring in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly coauthoring: Word.Coauthoring; /** * Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. * @@ -5628,6 +6629,14 @@ export declare namespace Word { * @beta */ readonly indexes: Word.IndexCollection; + /** + * Returns a `ListTemplateCollection` object that represents all the list templates in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly listTemplates: Word.ListTemplateCollection; /** * Returns a `PageSetup` object that's associated with the document. * @@ -5643,6 +6652,14 @@ export declare namespace Word { * [Api set: WordApi 1.3] */ readonly properties: Word.DocumentProperties; + /** + * Gets the collection of revisions that represents the tracked changes in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly revisions: Word.RevisionCollection; /** * Gets the collection of section objects in the document. * @@ -5650,6 +6667,14 @@ export declare namespace Word { * [Api set: WordApi 1.1] */ readonly sections: Word.SectionCollection; + /** + * Returns a `Selection` object that represents the current selection in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly selection: Word.Selection; /** * Gets the add-in's settings in the document. * @@ -5657,6 +6682,38 @@ export declare namespace Word { * [Api set: WordApi 1.4] */ readonly settings: Word.SettingCollection; + /** + * Returns a `TableOfAuthoritiesCategoryCollection` object that represents the available table of authorities categories in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly tableOfAuthoritiesCategories: Word.TableOfAuthoritiesCategoryCollection; + /** + * Returns a `TableOfAuthoritiesCollection` object that represents all the tables of authorities in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly tablesOfAuthorities: Word.TableOfAuthoritiesCollection; + /** + * Returns a `TableOfContentsCollection` object that represents all the tables of contents in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly tablesOfContents: Word.TableOfContentsCollection; + /** + * Returns a `TableOfFiguresCollection` object that represents all the tables of figures in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly tablesOfFigures: Word.TableOfFiguresCollection; /** * Gets the collection of `Word.Window` objects for the document. * @@ -7427,11 +8484,144 @@ export declare namespace Word { */ untrack(): Word.Font; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Font` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FontData`) 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 `Word.Font` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FontData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.FontData; } + /** + * Represents a heading style used in a table of contents or table of figures. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class HeadingStyle 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 level for the heading style in a table of contents or table of figures. Must be a value from 1 to 9. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + level: number; + /** + * Specifies the name of style for a heading. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + name: string; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.HeadingStyleUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.HeadingStyle): void; + /** + * Deletes the heading style. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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?: Word.Interfaces.HeadingStyleLoadOptions): Word.HeadingStyle; + /** + * 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[]): Word.HeadingStyle; + /** + * 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; + }): Word.HeadingStyle; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.HeadingStyle; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.HeadingStyle; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.HeadingStyle` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.HeadingStyleData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.HeadingStyleData; + } + /** + * Represents a collection of {@link Word.HeadingStyle} objects in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class HeadingStyleCollection 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: Word.HeadingStyle[]; + /** + * Adds a new heading style to a document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param name - The style name to be added. + * @param level - The heading level to assign. Must be a value from 1 to 9. + * @returns The new `HeadingStyle` object that was added to the collection. + */ + add(name: string, level: number): Word.HeadingStyle; + /** + * 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?: Word.Interfaces.HeadingStyleCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.HeadingStyleCollection; + /** + * 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[]): Word.HeadingStyleCollection; + /** + * 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): Word.HeadingStyleCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.HeadingStyleCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.HeadingStyleCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.HeadingStyleCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.HeadingStyleCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.HeadingStyleCollectionData; + } /** * Represents a hyperlink in a Word document. * @@ -8766,6 +9956,14 @@ export declare namespace Word { * [Api set: WordApiDesktop 1.1] */ readonly listLevels: Word.ListLevelCollection; + /** + * Specifies the name of the list template. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + name: string; /** * Specifies whether the list template is outline numbered. * @@ -9322,6 +10520,14 @@ export declare namespace Word { * [Api set: WordApiDesktop 1.2] */ readonly pagesEnclosingViewport: Word.PageCollection; + /** + * Returns a `Selection` object that represents the current selection in the pane. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly selection: Word.Selection; /** * Gets the next pane in the window. Throws an `ItemNotFound` error if this pane is the last one. * @@ -9336,6 +10542,12 @@ export declare namespace Word { * [Api set: WordApiDesktop 1.2] */ getNextOrNullObject(): Word.Pane; + /** + * 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?: Word.Interfaces.PaneLoadOptions): Word.Pane; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -9390,6 +10602,12 @@ export declare namespace Word { * [Api set: WordApiDesktop 1.2] */ getFirstOrNullObject(): Word.Pane; + /** + * 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?: Word.Interfaces.PaneCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.PaneCollection; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -9615,7 +10833,7 @@ export declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - imemode: Word.ImeMode | "NoControl" | "On" | "Off" | "Hiragana" | "Katakana" | "KatakanaHalf" | "AlphaFull" | "Alpha" | "HangulFull" | "Hangul"; + imeMode: Word.ImeMode | "NoControl" | "On" | "Off" | "Hiragana" | "Katakana" | "KatakanaHalf" | "AlphaFull" | "Alpha" | "HangulFull" | "Hangul"; /** * Gets the position of an item in a collection. * @@ -10100,14 +11318,6 @@ export declare namespace Word { * [Api set: WordApi 1.3] */ readonly parentTableOrNullObject: Word.Table; - /** - * Gets a `Range` object that represents the portion of the document that's contained within the paragraph. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - readonly range: Word.Range; /** * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. * @@ -11293,6 +12503,14 @@ export declare namespace Word { * @beta */ readonly borders: Word.BorderUniversalCollection; + /** + * Returns a `ConflictCollection` object that contains all the {@link Word.Conflict} objects in the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly conflicts: Word.ConflictCollection; /** * Gets the collection of content control objects in the range. * @@ -11300,6 +12518,14 @@ export declare namespace Word { * [Api set: WordApi 1.1] */ readonly contentControls: Word.ContentControlCollection; + /** + * Returns an `EditorCollection` object that represents all the users authorized to modify the range when the document is in protected (read-only) mode. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly editors: Word.EditorCollection; /** * Gets the collection of endnotes in the range. * @@ -11431,6 +12657,14 @@ export declare namespace Word { * [Api set: WordApi 1.3] */ readonly parentTableOrNullObject: Word.Table; + /** + * Gets the collection of revisions that represents the tracked changes in the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly revisions: Word.RevisionCollection; /** * Gets the collection of sections in the range. * @@ -13494,6 +14728,14 @@ export declare namespace Word { 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; + /** + * Returns the `TableColumnCollection` object that represents the columns in the table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly columns: Word.TableColumnCollection; /** * Gets the collection of endnotes in the table. * @@ -13578,6 +14820,14 @@ export declare namespace Word { * [Api set: WordApi 1.3] */ readonly rows: Word.TableRowCollection; + /** + * Returns the `ShadingUniversal` object that represents the shading of the table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly shading: Word.ShadingUniversal; /** * Gets the child tables nested one level deeper. * @@ -13592,6 +14842,14 @@ export declare namespace Word { * [Api set: WordApi 1.3] */ alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + /** + * Specifies the description of the table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + description: string; /** * Specifies the number of header rows. * @@ -13683,6 +14941,14 @@ export declare namespace Word { * [Api set: WordApi 1.3] */ styleTotalRow: boolean; + /** + * Specifies the title of the table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + title: string; /** * Specifies the text values in the table, as a 2D JavaScript array. * @@ -13734,6 +15000,36 @@ export declare namespace Word { * @param values - Optional 2D array. Cells are filled if the corresponding strings are specified in the array. */ addRows(insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End", rowCount: number, values?: string[][]): Word.TableRowCollection; + /** + * Applies the specified style but maintains any formatting that a user directly applies. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param styleName - The name of the style to apply. + */ + applyStyleDirectFormatting(styleName: string): void; + /** + * Determines how Microsoft Word resizes a table when the AutoFit feature is used. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param behavior - How Word resizes the specified table with the AutoFit feature is used. + */ + autoFitBehavior(behavior: Word.AutoFitBehavior): void; + /** + * Determines how Microsoft Word resizes a table when the AutoFit feature is used. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param behavior - How Word resizes the specified table with the AutoFit feature is used. + */ + autoFitBehavior(behavior: "FixedSize" | "Content" | "Window"): void; /** * Autofits the table columns to the width of the window. * @@ -13741,6 +15037,16 @@ export declare namespace Word { * [Api set: WordApi 1.3] */ autoFitWindow(): void; + /** + * Applies a predefined look to a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - Optional. An object that specifies the options for applying the table format. + */ + autoFormat(options?: Word.TableAutoFormatOptions): void; /** * Clears the contents of the table. * @@ -13748,6 +15054,17 @@ export declare namespace Word { * [Api set: WordApi 1.3] */ clear(): void; + /** + * Converts a table to text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - An object that specifies the options for converting the table to text. + * @returns A `Range` object that represents the converted text. + */ + convertToText(options?: Word.TableConvertToTextOptions): Word.Range; /** * Deletes the entire table. * @@ -13930,6 +15247,14 @@ export declare namespace Word { * @param lastCell - Required. The index of the last cell in its row */ mergeCells(topRow: number, firstCell: number, bottomRow: number, lastCell: number): Word.TableCell; + /** + * Updates the table with the characteristics of the predefined table format set when the `autoFormat` method was called. The default predefined format is {@link Word.TableFormatType | TableFormatType.none}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + reapplyAutoFormat(): void; /** * Performs a search with the specified SearchOptions on the scope of the table object. The search results are a collection of range objects. * @@ -13986,6 +15311,16 @@ export declare namespace Word { * @param cellPadding - Required. The cell padding. */ setCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void; + /** + * Sorts the specified table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - An object that specifies the options for sorting the table. + */ + sort(options?: Word.TableSortOptions): void; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -14030,6 +15365,22 @@ export declare namespace Word { export class TableStyle 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 `BorderUniversalCollection` that represents all the borders for the table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly borders: Word.BorderUniversalCollection; + /** + * Returns a `ShadingUniversal` object that refers to the shading formatting for the table style. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly shading: Word.Shading; /** * Specifies the table's alignment against the page margin. * @@ -14058,6 +15409,22 @@ export declare namespace Word { * [Api set: WordApi 1.6] */ cellSpacing: number; + /** + * Specifies the number of columns in the banding when a style specifies odd- or even-column banding. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + columnStripe: number; + /** + * Specifies whether Microsoft Word allows to break the specified table across pages. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isBreakAcrossPagesAllowed: boolean; /** * Specifies the amount of space to add between the contents and the left borders of the cells. * @@ -14065,6 +15432,14 @@ export declare namespace Word { * [Api set: WordApi 1.6] */ leftCellMargin: number; + /** + * Specifies the left indent value (in points) for the rows in the table style. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + leftIndent: number; /** * Specifies the amount of space to add between the contents and the right borders of the cells. * @@ -14072,6 +15447,22 @@ export declare namespace Word { * [Api set: WordApi 1.6] */ rightCellMargin: number; + /** + * Specifies the number of rows to include in the banding when the style specifies odd- or even-row banding. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + rowStripe: number; + /** + * Specifies the direction in which Microsoft Word orders cells in the table style. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tableDirection: Word.TableDirection | "RightToLeft" | "LeftToRight"; /** * Specifies the amount of space to add between the contents and the top borders of the cells. * @@ -14087,6 +15478,26 @@ export declare namespace Word { set(properties: Interfaces.TableStyleUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Word.TableStyle): void; + /** + * Returns a `ConditionalStyle` object that represents special style formatting for a portion of a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param conditionCode - The area of the table to which to apply the formatting. + */ + condition(conditionCode: Word.ConditionCode): Word.ConditionalStyle; + /** + * Returns a `ConditionalStyle` object that represents special style formatting for a portion of a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param conditionCode - The area of the table to which to apply the formatting. + */ + condition(conditionCode: "FirstRow" | "LastRow" | "OddRowBanding" | "EvenRowBanding" | "FirstColumn" | "LastColumn" | "OddColumnBanding" | "EvenColumnBanding" | "TopRightCell" | "TopLeftCell" | "BottomRightCell" | "BottomLeftCell"): Word.ConditionalStyle; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -14688,277 +16099,427 @@ export declare namespace Word { toJSON(): Word.Interfaces.TableColumnCollectionData; } /** - * Represents a row in a Word document. + * Represents a table of authorities in a Word document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - export class TableRow extends OfficeExtension.ClientObject { + export class TableOfAuthorities 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 cells. + * Gets the portion of a document that is this table of authorities. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly cells: Word.TableCellCollection; + readonly range: Word.Range; /** - * Gets the collection of endnotes in the table row. + * Specifies the name of the bookmark from which to collect table of authorities entries. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly endnotes: Word.NoteItemCollection; + bookmark: string; /** - * Gets the collection of field objects in the table row. + * Specifies the category of entries to be included in the table of authorities. + Values 0 through 16 correspond to the items listed in the Category box of the Table of Authorities dialog. To learn how to access this through the Word UI, see {@link https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0 | Create a table of authorities}. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly fields: Word.FieldCollection; + category: number; /** - * Gets the font. Use this to get and set font name, size, color, and other properties. + * Specifies a separator of up to five characters. This appears between the table of authorities entry and its page number. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly font: Word.Font; + entrySeparator: string; /** - * Gets the collection of footnotes in the table row. + * Specifies whether the category name for a group of entries appears in the table of authorities. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly footnotes: Word.NoteItemCollection; + isCategoryHeaderIncluded: boolean; /** - * Gets parent table. + * Specifies whether the entries in the table of authorities are displayed with their formatting in the table. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly parentTable: Word.Table; + isEntryFormattingKept: boolean; /** - * Gets the number of cells in the row. + * Specifies whether references to the same authority that are repeated on five or more pages are replaced with "Passim". * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly cellCount: number; + isPassimUsed: boolean; /** - * Specifies the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Specifies a separator of up to five characters. This appears between individual page references in the table of authorities. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - horizontalAlignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + pageNumberSeparator: string; /** - * Checks whether the row is a header row. To set the number of header rows, use `headerRowCount` on the Table object. + * Specifies a separator of up to five characters. This appears between ranges of pages in the table of authorities. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly isHeader: boolean; + pageRangeSeparator: string; /** - * Specifies the preferred height of the row in points. + * Specifies the {@link https://support.microsoft.com/office/062a387b-dfc9-4ef8-8235-29ee113d59be | Sequence (SEQ) field} identifier for the table of authorities. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - preferredHeight: number; + sequenceName: string; /** - * Gets the index of the row in its parent table. + * Specifies a separator of up to five characters. This appears between the sequence number and the page number in the table of authorities. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly rowIndex: number; + sequenceSeparator: string; /** - * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * Specifies the leader character that appears between entries and their associated page numbers in the table of authorities. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shadingColor: string; + tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** - * Specifies the text values in the row, as a 2D JavaScript array. + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.TableOfAuthoritiesUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.TableOfAuthorities): void; + /** + * Deletes this table of authorities. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - values: string[][]; + delete(): void; /** - * Specifies the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.3] + * @param options - Provides options for which properties of the object to load. */ - verticalAlignment: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + load(options?: Word.Interfaces.TableOfAuthoritiesLoadOptions): Word.TableOfAuthorities; /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + * 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. */ - set(properties: Interfaces.TableRowUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.TableRow): void; + load(propertyNames?: string | string[]): Word.TableOfAuthorities; /** - * Clears the contents of the row. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.3] + * @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. */ - clear(): void; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.TableOfAuthorities; /** - * Deletes the entire row. + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.TableOfAuthorities; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.TableOfAuthorities; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TableOfAuthorities` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfAuthoritiesData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.TableOfAuthoritiesData; + } + /** + * Represents a collection of {@link Word.TableOfAuthorities} objects in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class TableOfAuthoritiesCollection 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: Word.TableOfAuthorities[]; + /** + * Adds a table of authorities to the document at the specified range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param range - The range where the table of authorities will appear. The table of authorities replaces the range if the range isn't collapsed. + * @param options - Optional. The options to configure the table of authorities. */ - delete(): void; + add(range: Word.Range, options?: Word.TableOfAuthoritiesAddOptions): Word.TableOfAuthorities; /** - * Gets the border style of the cells in the row. + * Inserts a {@link https://support.microsoft.com/office/2a90ad2b-4169-475d-8a09-e62521d4159c | Table of Authorities Entry (TA) field} after all instances of the specified citation text. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta * - * @param borderLocation - Required. The border location. + * @param shortCitation - The citation text to mark. + * @param options - Optional. The options for marking the citation. */ - getBorder(borderLocation: Word.BorderLocation): Word.TableBorder; + markAllCitations(shortCitation: string, options?: Word.TableOfAuthoritiesMarkCitationOptions): void; /** - * Gets the border style of the cells in the row. + * Inserts a {@link https://support.microsoft.com/office/2a90ad2b-4169-475d-8a09-e62521d4159c | Table of Authorities Entry (TA) field} at the specified range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta * - * @param borderLocation - Required. The border location. + * @param range - The range where the citation will be inserted. + * @param shortCitation - The short citation text. + * @param options - Optional. The options for marking the citation. */ - getBorder(borderLocation: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder; + markCitation(range: Word.Range, shortCitation: string, options?: Word.TableOfAuthoritiesMarkCitationOptions): Word.Field; /** - * Gets cell padding in points. + * Finds and selects the next instance of the specified citation text. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta * - * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * @param shortCitation - The citation text to search for. */ - getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult; + selectNextCitation(shortCitation: string): void; /** - * Gets cell padding in points. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.3] + * @param options - Provides options for which properties of the object to load. + */ + load(options?: Word.Interfaces.TableOfAuthoritiesCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableOfAuthoritiesCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. */ - getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult; + load(propertyNames?: string | string[]): Word.TableOfAuthoritiesCollection; /** - * Gets the next row. Throws an `ItemNotFound` error if this row is the last one. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.3] + * @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. */ - getNext(): Word.TableRow; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableOfAuthoritiesCollection; /** - * Gets the next row. If this row is the last one, then this method will return 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}. + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.TableOfAuthoritiesCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.TableOfAuthoritiesCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TableOfAuthoritiesCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfAuthoritiesCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.TableOfAuthoritiesCollectionData; + } + /** + * Specifies the options for adding to a {@link Word.TableOfAuthoritiesCollection} object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface TableOfAuthoritiesAddOptions { + /** + * If provided, specifies the string name of the bookmark from which to collect entries for a table of authorities. + When specified, the entries are collected only from the portion of the document marked by the bookmark. + Corresponds to the `\b` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getNextOrNullObject(): Word.TableRow; + bookmark?: string; /** - * Inserts a content control on the row. + * If provided, specifies the category of entries to include in a table of authorities. + Corresponds to the `\c` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. + Values 0 through 16 correspond to the items listed in the Category box of the Table of Authorities dialog. To learn how to access this through the Word UI, see {@link https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0 | Create a table of authorities}. + The default value is `1`. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - insertContentControl(): Word.ContentControl; + category?: number; /** - * Inserts rows using this row as a template. If values are specified, inserts the values into the new rows. + * If provided, specifies a separator of up to five characters. This appears between the table of authorities entry and its page number. + Corresponds to the `\e` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. + If omitted, no separator is used. * * @remarks - * [Api set: WordApi 1.3] - * - * @param insertLocation - Required. Where the new rows should be inserted, relative to the current row. It must be 'Before' or 'After'. - * @param rowCount - Required. Number of rows to add - * @param values - Optional. Strings to insert in the new rows, specified as a 2D array. The number of cells in each row must not exceed the number of cells in the existing row. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - insertRows(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", rowCount: number, values?: string[][]): Word.TableRowCollection; + entrySeparator?: string; /** - * Merges the row into one cell. + * If provided, specifies whether the category name for each group of entries appears in a table of authorities (e.g., "Cases"). + Corresponds to the `\h` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. + The default value is `true`. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - merge(): Word.TableCell; + includeCategoryHeader?: boolean; /** - * Performs a search with the specified SearchOptions on the scope of the row. The search results are a collection of range objects. + * If provided, specifies whether the entries in a table of authorities are displayed with their formatting in the table. + Corresponds to the `\f` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. + The default value is `true`. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + keepEntryFormatting?: boolean; + /** + * If provided, specifies a separator of up to five characters. This appears between individual page references in a table of authorities. + Corresponds to the `\l` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. + If omitted, a comma and a space (", ") are used. * - * @param searchText - Required. The search text. - * @param searchOptions - Optional. Options for the search. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - search(searchText: string, searchOptions?: Word.SearchOptions | { - ignorePunct?: boolean; - ignoreSpace?: boolean; - matchCase?: boolean; - matchPrefix?: boolean; - matchSuffix?: boolean; - matchWholeWord?: boolean; - matchWildcards?: boolean; - }): Word.RangeCollection; + pageNumberSeparator?: string; /** - * Selects the row and navigates the Word UI to it. + * If provided, specifies a separator of up to five characters. This appears between ranges of pages in a table of authorities. + Corresponds to the `\g` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. + If omitted, an en dash ("–") is used. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + pageRangeSeparator?: string; + /** + * If provided, specifies the string that identifies the Sequence (SEQ) field identifier for a table of authorities. + Corresponds to the `\s` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. * - * @param selectionMode - Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - select(selectionMode?: Word.SelectionMode): void; + sequenceName?: string; /** - * Selects the row and navigates the Word UI to it. + * If provided, specifies a separator of up to five characters. This appears between the sequence number and the page number in a table of authorities. + Corresponds to the `\d` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. + If omitted, a hyphen ("-") is used. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sequenceSeparator?: string; + /** + * If provided, specifies whether references to the same authority that are repeated on five or more pages are replaced with "Passim". + Corresponds to the `\p` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. + The default value is `false`. * - * @param selectionMode - Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - select(selectionMode?: "Select" | "Start" | "End"): void; + usePassim?: boolean; + } + /** + * Specifies the options for inserting a {@link https://support.microsoft.com/office/2a90ad2b-4169-475d-8a09-e62521d4159c | Table of Authorities Entry (TA) field}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface TableOfAuthoritiesMarkCitationOptions { /** - * Sets cell padding in points. + * If provided, specifies the category number to be associated with the entry. + Values 1 through 16 correspond to the items listed in the Category dropdown list of the Mark Citation dialog. + The value `1` corresponds to the first category listed, `2` corresponds to the second category, and so on. + To learn how to access this through the Word UI, see {@link https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0 | Create a table of authorities}. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + category?: number; + /** + * If provided, specifies the long citation for the entry as it will appear in a table of authorities. * - * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. - * @param cellPadding - Required. The cell padding. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void; + longCitation?: string; /** - * Sets cell padding in points. + * If provided, specifies the name of the AutoText entry that contains the text of the long citation as it will appear in a table of authorities. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + longCitationAutoText?: string; + } + /** + * Represents a category used in a table of authorities. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class TableOfAuthoritiesCategory 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 name of this table of authorities category. + Changing the name of the category doesn't change the index in the collection. The value for {@link Word.TableOfAuthorities | TableOfAuthorities.category} will remain the same. * - * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. - * @param cellPadding - Required. The cell padding. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - setCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void; + 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?: Word.Interfaces.TableRowLoadOptions): Word.TableRow; + load(options?: Word.Interfaces.TableOfAuthoritiesCategoryLoadOptions): Word.TableOfAuthoritiesCategory; /** * 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[]): Word.TableRow; + load(propertyNames?: string | string[]): Word.TableOfAuthoritiesCategory; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -14967,619 +16528,640 @@ export declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.TableRow; + }): Word.TableOfAuthoritiesCategory; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - track(): Word.TableRow; + track(): Word.TableOfAuthoritiesCategory; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - untrack(): Word.TableRow; + untrack(): Word.TableOfAuthoritiesCategory; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TableRow` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableRowData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.TableOfAuthoritiesCategory` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfAuthoritiesCategoryData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.TableRowData; + toJSON(): Word.Interfaces.TableOfAuthoritiesCategoryData; } /** - * Contains the collection of the document's TableRow objects. + * Represents a collection of {@link Word.TableOfAuthoritiesCategory} objects in a Word document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - export class TableRowCollection extends OfficeExtension.ClientObject { + export class TableOfAuthoritiesCategoryCollection 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: Word.TableRow[]; + readonly items: Word.TableOfAuthoritiesCategory[]; /** - * Gets the first row in this collection. Throws an `ItemNotFound` error if this collection is empty. + * Returns the number of items in the collection. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getFirst(): Word.TableRow; + getCount(): OfficeExtension.ClientResult; /** - * Gets the first row in this collection. If this collection is empty, then this method will return 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}. + * Returns a `TableOfAuthoritiesCategory` object that represents the specified item in the collection. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index - The index of the item to retrieve. */ - getFirstOrNullObject(): Word.TableRow; + getItemAt(index: number): Word.TableOfAuthoritiesCategory; /** * 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?: Word.Interfaces.TableRowCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableRowCollection; + load(options?: Word.Interfaces.TableOfAuthoritiesCategoryCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableOfAuthoritiesCategoryCollection; /** * 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[]): Word.TableRowCollection; + load(propertyNames?: string | string[]): Word.TableOfAuthoritiesCategoryCollection; /** * 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): Word.TableRowCollection; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableOfAuthoritiesCategoryCollection; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - track(): Word.TableRowCollection; + track(): Word.TableOfAuthoritiesCategoryCollection; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - untrack(): Word.TableRowCollection; + untrack(): Word.TableOfAuthoritiesCategoryCollection; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TableRowCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableRowCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * Whereas the original `Word.TableOfAuthoritiesCategoryCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfAuthoritiesCategoryCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.TableRowCollectionData; + toJSON(): Word.Interfaces.TableOfAuthoritiesCategoryCollectionData; } /** - * Represents a table cell in a Word document. + * Represents a table of contents in a Word document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - export class TableCell extends OfficeExtension.ClientObject { + export class TableOfContents 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 body object of the cell. + * Gets the additional styles used for the table of contents. The default "Heading 1" - "Heading 9" styles aren't included in this collection. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly body: Word.Body; + readonly additionalHeadingStyles: Word.HeadingStyleCollection; /** - * Gets the parent row of the cell. + * Gets the portion of a document that is this table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly parentRow: Word.TableRow; + readonly range: Word.Range; /** - * Gets the parent table of the cell. + * Specifies whether built-in heading styles are used for the table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly parentTable: Word.Table; + areBuiltInHeadingStylesUsed: boolean; /** - * Gets the index of the cell in its row. + * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly cellIndex: number; + areFieldsUsed: boolean; /** - * Specifies the width of the cell's column in points. This is applicable to uniform tables. + * Specifies whether entries in the table of contents should be formatted as hyperlinks when publishing to the web. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - columnWidth: number; + areHyperlinksUsedOnWeb: boolean; /** - * Specifies the horizontal alignment of the cell. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Specifies whether the page numbers in the table of contents should be hidden when publishing to the web. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - horizontalAlignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + arePageNumbersHiddenOnWeb: boolean; /** - * Gets the index of the cell's row in the table. + * Specifies whether page numbers are included in the table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly rowIndex: number; + arePageNumbersIncluded: boolean; /** - * Specifies the shading color of the cell. Color is specified in "#RRGGBB" format or by using the color name. + * Specifies whether page numbers are aligned with the right margin in the table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shadingColor: string; + arePageNumbersRightAligned: boolean; /** - * Specifies the text of the cell. + * Specifies the ending heading level for the table of contents. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - value: string; + lowerHeadingLevel: number; /** - * Specifies the vertical alignment of the cell. The value can be 'Top', 'Center', or 'Bottom'. + * Specifies the character between entries and their page numbers in the table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - verticalAlignment: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** - * Gets the width of the cell in points. + * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly width: number; + tableId: string; + /** + * Specifies the starting heading level for the table of contents. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + upperHeadingLevel: number; /** * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - set(properties: Interfaces.TableCellUpdateData, options?: OfficeExtension.UpdateOptions): void; + set(properties: Interfaces.TableOfContentsUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.TableCell): void; + set(properties: Word.TableOfContents): void; /** - * Deletes the column containing this cell. This is applicable to uniform tables. + * Deletes this table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - deleteColumn(): void; + delete(): void; /** - * Deletes the row containing this cell. + * Updates the entire table of contents. * * @remarks - * [Api set: WordApi 1.3] - */ - deleteRow(): void; + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta /** - * Gets the border style for the specified border. + * Updates only the page numbers for items in this table of contents. * * @remarks - * [Api set: WordApi 1.3] - * - * @param borderLocation - Required. The border location. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getBorder(borderLocation: Word.BorderLocation): Word.TableBorder; + updatePageNumbers(): void; /** - * Gets the border style for the specified border. - * - * @remarks - * [Api set: WordApi 1.3] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param borderLocation - Required. The border location. + * @param options - Provides options for which properties of the object to load. */ - getBorder(borderLocation: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder; + load(options?: Word.Interfaces.TableOfContentsLoadOptions): Word.TableOfContents; /** - * Gets cell padding in points. - * - * @remarks - * [Api set: WordApi 1.3] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. */ - getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult; + load(propertyNames?: string | string[]): Word.TableOfContents; /** - * Gets cell padding in points. - * - * @remarks - * [Api set: WordApi 1.3] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * @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. */ - getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.TableOfContents; /** - * Gets the next cell. Throws an `ItemNotFound` error if this cell is the last one. - * - * @remarks - * [Api set: WordApi 1.3] - */ - getNext(): Word.TableCell; - /** - * Gets the next cell. If this cell is the last one, then this method will return 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: WordApi 1.3] - */ - getNextOrNullObject(): Word.TableCell; - /** - * Adds columns to the left or right of the cell, using the cell's column as a template. This is applicable to uniform tables. The string values, if specified, are set in the newly inserted rows. - * - * @remarks - * [Api set: WordApi 1.3] - * - * @param insertLocation - Required. It must be 'Before' or 'After'. - * @param columnCount - Required. Number of columns to add. - * @param values - Optional 2D array. Cells are filled if the corresponding strings are specified in the array. + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - insertColumns(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", columnCount: number, values?: string[][]): void; + track(): Word.TableOfContents; /** - * Inserts rows above or below the cell, using the cell's row as a template. The string values, if specified, are set in the newly inserted rows. - * - * @remarks - * [Api set: WordApi 1.3] - * - * @param insertLocation - Required. It must be 'Before' or 'After'. - * @param rowCount - Required. Number of rows to add. - * @param values - Optional 2D array. Cells are filled if the corresponding strings are specified in the array. + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - insertRows(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", rowCount: number, values?: string[][]): Word.TableRowCollection; + untrack(): Word.TableOfContents; /** - * Sets cell padding in points. - * - * @remarks - * [Api set: WordApi 1.3] - * - * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. - * @param cellPadding - Required. The cell padding. + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TableOfContents` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfContentsData`) that contains shallow copies of any loaded child properties from the original object. */ - setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void; + toJSON(): Word.Interfaces.TableOfContentsData; + } + /** + * Represents a collection of {@link Word.TableOfContents} objects in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class TableOfContentsCollection 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: Word.TableOfContents[]; /** - * Sets cell padding in points. + * Adds a table of contents to the document at the specified range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta * - * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. - * @param cellPadding - Required. The cell padding. + * @param range - The range where the table of contents will be added. The table of contents replaces the range if the range isn't collapsed. + * @param options - Optional. The options for configuring the table of contents. */ - setCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void; + add(range: Word.Range, options?: Word.TableOfContentsAddOptions): Word.TableOfContents; /** - * Splits the cell into the specified number of rows and columns. + * Inserts a {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) field} after the specified range. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta * - * @param rowCount - Required. The number of rows to split into. Must be a divisor of the number of underlying rows. - * @param columnCount - Required. The number of columns to split into. + * @param range - The range where the entry will be inserted. + * @param options - Optional. The options for marking the table of contents entry. */ - split(rowCount: number, columnCount: number): void; + markTocEntry(range: Word.Range, options?: Word.TableOfContentsMarkEntryOptions): Word.Field; /** * 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?: Word.Interfaces.TableCellLoadOptions): Word.TableCell; + load(options?: Word.Interfaces.TableOfContentsCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableOfContentsCollection; /** * 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[]): Word.TableCell; + load(propertyNames?: string | string[]): Word.TableOfContentsCollection; /** * 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; - }): Word.TableCell; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableOfContentsCollection; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - track(): Word.TableCell; + track(): Word.TableOfContentsCollection; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - untrack(): Word.TableCell; + untrack(): Word.TableOfContentsCollection; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TableCell` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableCellData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.TableOfContentsCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfContentsCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.TableCellData; + toJSON(): Word.Interfaces.TableOfContentsCollectionData; } /** - * Contains the collection of the document's TableCell objects. + * Specifies the options for adding to a {@link Word.TableOfContentsCollection} object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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: Word.TableCell[]; + export interface TableOfContentsAddOptions { /** - * Gets the first table cell in this collection. Throws an `ItemNotFound` error if this collection is empty. + * If provided, specifies the string names of additional styles to use for the table of contents. + Use {@link Word.HeadingStyleCollection | HeadingStyleCollection.add} to create new heading styles. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getFirst(): Word.TableCell; + addedStyles?: string; /** - * Gets the first table cell in this collection. If this collection is empty, then this method will return 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}. + * If provided, specifies whether the page numbers in a table of contents should be hidden when publishing to the web. + The default value is `true`. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getFirstOrNullObject(): Word.TableCell; + hidePageNumbersOnWeb?: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * If provided, specifies whether to include page numbers in a table of contents. + The default value is `true`. * - * @param options - Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.TableCellCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableCellCollection; + includePageNumbers?: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * If provided, specifies the ending heading level for a table of contents and must be a value from 1 to 9. Must be greater than `upperHeadingLevel`. + Corresponds to the ending value used with the `\o` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. + The default value is `9`. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.TableCellCollection; + lowerHeadingLevel?: number; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * If provided, specifies whether page numbers in a table of contents are aligned with the right margin. + The default value is `true`. * - * @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): Word.TableCellCollection; - /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. - */ - track(): Word.TableCellCollection; - /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. - */ - untrack(): Word.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 `Word.TableCellCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableCellCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.TableCellCollectionData; - } - /** - * Specifies the border style. - * - * @remarks - * [Api set: WordApi 1.3] - */ - export class TableBorder 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; + rightAlignPageNumbers?: boolean; /** - * Specifies the table border color. + * If provided, specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for a table of contents. + Corresponds to the `\f` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. For example, "T" indicates a table of contents includes TC fields that use the table identifier T. + If this argument is omitted, TC fields aren't used. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - color: string; + tableId?: string; /** - * Specifies the type of the table border. + * If provided, specifies the starting heading level for a table of contents and must be a value from 1 to 9. Should be smaller than `lowerHeadingLevel`. + Corresponds to the starting value used with the `\o` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. + The default value is `1`. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + upperHeadingLevel?: number; /** - * Specifies the width, in points, of the table border. Not applicable to table border types that have fixed widths. + * If provided, specifies whether to use built-in heading styles to create a table of contents. + The default value is `true`. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width: number; + useBuiltInHeadingStyles?: boolean; /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + * If provided, specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are used to create a table of contents. + Use the {@link Word.TableOfContentsCollection | TableOfContentsCollection.markTocEntry} method to mark entries to be included in a table of contents. + The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.TableBorderUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.TableBorder): void; + useFields?: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * If provided, specifies whether entries in a table of contents should be formatted as hyperlinks when the document is published to the web. + The default value is `true`. * - * @param options - Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.TableBorderLoadOptions): Word.TableBorder; + useHyperlinksOnWeb?: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * If provided, specifies whether to use outline levels to create a table of contents. + The default value is `false`. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.TableBorder; + useOutlineLevels?: boolean; + } + /** + * Specifies the options for inserting a {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) field}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface TableOfContentsMarkEntryOptions { /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * If provided, specifies the text that appears in a table of contents or table of figures. + To indicate a subentry, include the main entry text and the subentry text, separated by a colon (":") (e.g., "Introduction:The Product"). + When the `entryAutoText` property is set, this property is ignored. * - * @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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.TableBorder; + entry?: string; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + * If provided, specifies the AutoText entry name that includes text for the table of figures, or table of contents. + When this property is used, the `entry` property is ignored. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.TableBorder; + entryAutoText?: string; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + * If provided, specifies the level for the entry in a table of contents or table of figures and should be a value from 1 to 9. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.TableBorder; + level?: 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 `Word.TableBorder` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableBorderData`) that contains shallow copies of any loaded child properties from the original object. + * If provided, specifies a one-letter identifier for a table of contents or table of figures (e.g., "i" for an "illustration"). + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.TableBorderData; + tableId?: string; } /** - * Represents a document template. + * Represents a table of figures in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export class Template extends OfficeExtension.ClientObject { + export class TableOfFigures 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 `BuildingBlockEntryCollection` object that represents the collection of building block entries in the template. + * Gets the additional styles used for the table of figures. The default "Heading 1" - "Heading 9" styles aren't included in this collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly buildingBlockEntries: Word.BuildingBlockEntryCollection; + readonly additionalHeadingStyles: Word.HeadingStyleCollection; /** - * Returns a `BuildingBlockTypeItemCollection` object that represents the collection of building block types that are contained in the template. + * Gets the portion of a document that is this table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly buildingBlockTypes: Word.BuildingBlockTypeItemCollection; + readonly range: Word.Range; /** - * Specifies the East Asian language to use when breaking lines of text in the document or template. + * Specifies whether built-in heading styles are used for the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - farEastLineBreakLanguage: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; + areBuiltInHeadingStylesUsed: boolean; /** - * Specifies the line break control level for the document. + * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - farEastLineBreakLevel: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"; + areFieldsUsed: boolean; /** - * Returns the name of the template, including the drive or Web path. + * Specifies whether entries in the table of figures should be formatted as hyperlinks when publishing to the web. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly fullName: string; + areHyperlinksUsedOnWeb: boolean; /** - * Specifies whether the spelling and grammar checker ignores documents based on this template. + * Specifies whether the page numbers in the table of figures should be hidden when publishing to the web. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hasNoProofing: boolean; + arePageNumbersHiddenOnWeb: boolean; /** - * Specifies the character spacing adjustment for the template. + * Specifies whether page numbers are included in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - justificationMode: Word.JustificationMode | "Expand" | "Compress" | "CompressKana"; + arePageNumbersIncluded: boolean; /** - * Specifies if Microsoft Word kerns half-width Latin characters and punctuation marks in the document. + * Specifies whether page numbers are aligned with the right margin in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - kerningByAlgorithm: boolean; + arePageNumbersRightAligned: boolean; /** - * Specifies a `LanguageId` value that represents the language in the template. + * Specifies the label that identifies the items to be included in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageId: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + captionLabel: string; /** - * Specifies an East Asian language for the language in the template. + * Specifies whether the caption label and caption number are included in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageIdFarEast: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + isLabelIncluded: boolean; /** - * Returns only the name of the document template (excluding any path or other location information). + * Specifies the ending heading level for the table of figures. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly name: string; + lowerHeadingLevel: number; /** - * Specifies the kinsoku characters after which Microsoft Word will not break a line. + * Specifies the character between entries and their page numbers in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - noLineBreakAfter: string; + tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** - * Specifies the kinsoku characters before which Microsoft Word will not break a line. + * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - noLineBreakBefore: string; + tableId: string; /** - * Returns the path to the document template. + * Specifies the starting heading level for the table of figures. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly path: string; + upperHeadingLevel: number; /** - * Specifies `true` if the template has not changed since it was last saved, `false` if Microsoft Word displays a prompt to save changes when the document is closed. + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.TableOfFiguresUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.TableOfFigures): void; + /** + * Deletes this table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - saved: boolean; + delete(): void; /** - * Returns the template type. + * Updates the entire table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - */ - readonly type: Word.TemplateType | "Normal" | "Global" | "Attached"; - /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. - */ - set(properties: Interfaces.TemplateUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Template): void; /** - * Saves the template. + * Updates only the page numbers for items in this table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - save(): void; + updatePageNumbers(): 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?: Word.Interfaces.TemplateLoadOptions): Word.Template; + load(options?: Word.Interfaces.TableOfFiguresLoadOptions): Word.TableOfFigures; /** * 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[]): Word.Template; + load(propertyNames?: string | string[]): Word.TableOfFigures; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -15588,787 +17170,893 @@ export declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.Template; + }): Word.TableOfFigures; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - track(): Word.Template; + track(): Word.TableOfFigures; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - untrack(): Word.Template; + untrack(): Word.TableOfFigures; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Template` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TemplateData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.TableOfFigures` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfFiguresData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.TemplateData; + toJSON(): Word.Interfaces.TableOfFiguresData; } /** - * Contains a collection of {@link Word.Template} objects that represent all the templates that are currently available. - This collection includes open templates, templates attached to open documents, and global templates loaded in the **Templates and Add-ins** dialog box. - To learn how to access this dialog in the Word UI, see {@link https://support.microsoft.com/office/2479fe53-f849-4394-88bb-2a6e2a39479d | Load or unload a template or add-in program}. + * Represents a collection of {@link Word.TableOfFigures} objects in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export class TemplateCollection extends OfficeExtension.ClientObject { + export class TableOfFiguresCollection 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: Word.Template[]; - /** - * Returns the number of items in the collection. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - getCount(): OfficeExtension.ClientResult; + readonly items: Word.TableOfFigures[]; /** - * Gets a `Template` object by its index in the collection. + * Adds a table of figures to the document at the specified range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param index - The index of the template to retrieve. + * @param range - The range where the table of figures will be added. The table of figures replaces the range if the range isn't collapsed. + * @param options - Optional. The options for configuring the table of figures. */ - getItemAt(index: number): Word.Template; + add(range: Word.Range, options?: Word.TableOfFiguresAddOptions): Word.TableOfFigures; /** - * Imports the building blocks for all templates into Microsoft Word. + * Inserts a {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) field} after the specified range for marking entries in a table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param range - The range where the TC field will be inserted. + * @param options - Optional. The options for marking the entry. */ - importBuildingBlocks(): void; + markTocEntry(range: Word.Range, options?: Word.TableOfContentsMarkEntryOptions): Word.Field; /** * 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?: Word.Interfaces.TemplateCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TemplateCollection; + load(options?: Word.Interfaces.TableOfFiguresCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableOfFiguresCollection; /** * 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[]): Word.TemplateCollection; + load(propertyNames?: string | string[]): Word.TableOfFiguresCollection; /** * 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): Word.TemplateCollection; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableOfFiguresCollection; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - track(): Word.TemplateCollection; + track(): Word.TableOfFiguresCollection; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - untrack(): Word.TemplateCollection; + untrack(): Word.TableOfFiguresCollection; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TemplateCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TemplateCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * Whereas the original `Word.TableOfFiguresCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfFiguresCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.TemplateCollectionData; + toJSON(): Word.Interfaces.TableOfFiguresCollectionData; } /** - * Represents a tracked change in a Word document. + * Specifies the options for adding to a {@link Word.TableOfFiguresCollection} object. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - export class TrackedChange extends OfficeExtension.ClientObject { + export interface TableOfFiguresAddOptions { + addedStyles?: string; + captionLabel?: string; + hidePageNumbersOnWeb?: boolean; + includeLabel?: boolean; + includePageNumbers?: boolean; + lowerHeadingLevel?: number; + rightAlignPageNumbers?: boolean; + tableId?: string; + upperHeadingLevel?: number; + useBuiltInHeadingStyles?: boolean; + useFields?: boolean; + useHyperlinksOnWeb?: boolean; + } + /** + * Represents a row in a Word document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + 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; /** - * Gets the author of the tracked change. + * Gets cells. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.3] */ - readonly author: string; + readonly cells: Word.TableCellCollection; /** - * Gets the date of the tracked change. + * Gets the collection of endnotes in the table row. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.5] */ - readonly date: Date; + readonly endnotes: Word.NoteItemCollection; /** - * Gets the text of the tracked change. + * Gets the collection of field objects in the table row. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.4] */ - readonly text: string; + readonly fields: Word.FieldCollection; /** - * Gets the type of the tracked change. + * Gets the font. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.3] */ - readonly type: Word.TrackedChangeType | "None" | "Added" | "Deleted" | "Formatted"; + readonly font: Word.Font; /** - * Accepts the tracked change. + * Gets the collection of footnotes in the table row. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.5] */ - accept(): void; + readonly footnotes: Word.NoteItemCollection; /** - * Gets the next tracked change. Throws an `ItemNotFound` error if this tracked change is the last one. + * Gets parent table. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.3] */ - getNext(): Word.TrackedChange; + readonly parentTable: Word.Table; /** - * Gets the next tracked change. If this tracked change is the last one, then this method will return 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}. + * Returns the `Range` object that represents the table row. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getNextOrNullObject(): Word.TrackedChange; + readonly range: Word.Range; /** - * Gets the range of the tracked change. + * Returns the `ShadingUniversal` object that represents the shading of the table row. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range; + readonly shading: Word.ShadingUniversal; /** - * Rejects the tracked change. + * Gets the number of cells in the row. * * @remarks - * [Api set: WordApi 1.6] - */ - reject(): 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: WordApi 1.3] */ - load(options?: Word.Interfaces.TrackedChangeLoadOptions): Word.TrackedChange; + readonly cellCount: number; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi 1.3] */ - load(propertyNames?: string | string[]): Word.TrackedChange; + horizontalAlignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Checks whether the row is a header row. To set the number of header rows, use `headerRowCount` on the Table object. * - * @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; - }): Word.TrackedChange; - /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. - */ - track(): Word.TrackedChange; - /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. - */ - untrack(): Word.TrackedChange; - /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TrackedChange` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TrackedChangeData`) that contains shallow copies of any loaded child properties from the original object. + * @remarks + * [Api set: WordApi 1.3] */ - toJSON(): Word.Interfaces.TrackedChangeData; - } - /** - * Contains a collection of {@link Word.TrackedChange} objects. - * - * @remarks - * [Api set: WordApi 1.6] - */ - export class TrackedChangeCollection 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: Word.TrackedChange[]; + readonly isHeader: boolean; /** - * Accepts all the tracked changes in the collection. + * Specifies the preferred height of the row in points. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.3] */ - acceptAll(): void; + preferredHeight: number; /** - * Gets the first TrackedChange in this collection. Throws an `ItemNotFound` error if this collection is empty. + * Gets the index of the row in its parent table. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.3] */ - getFirst(): Word.TrackedChange; + readonly rowIndex: number; /** - * Gets the first TrackedChange in this collection. If this collection is empty, then this method will return 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 shading color. Color is specified in "#RRGGBB" format or by using the color name. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.3] */ - getFirstOrNullObject(): Word.TrackedChange; + shadingColor: string; /** - * Rejects all the tracked changes in the collection. + * Specifies the text values in the row, as a 2D JavaScript array. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.3] */ - rejectAll(): void; + values: string[][]; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'. * - * @param options - Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi 1.3] */ - load(options?: Word.Interfaces.TrackedChangeCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TrackedChangeCollection; + verticalAlignment: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; /** - * 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. + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - load(propertyNames?: string | string[]): Word.TrackedChangeCollection; + set(properties: Interfaces.TableRowUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.TableRow): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Clears the contents of the row. * - * @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): Word.TrackedChangeCollection; - /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. - */ - track(): Word.TrackedChangeCollection; - /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. - */ - untrack(): Word.TrackedChangeCollection; - /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TrackedChangeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TrackedChangeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * @remarks + * [Api set: WordApi 1.3] */ - toJSON(): Word.Interfaces.TrackedChangeCollectionData; - } - /** - * Contains the view attributes (such as show all, field shading, and table gridlines) for a window or pane. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class View 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; + clear(): void; /** - * Gets the instance of a `RevisionsFilter` object. + * Converts the table row to text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param options - Optional. An object that specifies the options for converting the table row to text. */ - readonly revisionsFilter: Word.RevisionsFilter; + convertToText(options?: Word.TableConvertToTextOptions): Word.Range; /** - * Specifies whether all nonprinting characters are displayed. + * Deletes the entire row. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - areAllNonprintingCharactersDisplayed: boolean; + delete(): void; /** - * Gets whether background colors and images are shown when the document is displayed in print layout view. + * Gets the border style of the cells in the row. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param borderLocation - Required. The border location. */ - areBackgroundsDisplayed: boolean; + getBorder(borderLocation: Word.BorderLocation): Word.TableBorder; /** - * Gets whether square brackets are displayed at the beginning and end of each bookmark. + * Gets the border style of the cells in the row. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param borderLocation - Required. The border location. */ - readonly areBookmarksIndicated: boolean; + getBorder(borderLocation: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder; /** - * Specifies whether Microsoft Word displays the comments in the document. + * Gets cell padding in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. */ - areCommentsDisplayed: boolean; + getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult; /** - * Specifies whether Microsoft Word displays connecting lines from the text to the revision and comment balloons. + * Gets cell padding in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. */ - areConnectingLinesToRevisionsBalloonDisplayed: boolean; + getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult; /** - * Gets whether crop marks are shown in the corners of pages to indicate where margins are located. + * Gets the next row. Throws an `ItemNotFound` error if this row is the last one. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - readonly areCropMarksDisplayed: boolean; + getNext(): Word.TableRow; /** - * Gets whether objects created with the drawing tools are displayed in print layout view. + * Gets the next row. If this row is the last one, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - readonly areDrawingsDisplayed: boolean; + getNextOrNullObject(): Word.TableRow; /** - * Specifies whether shading is applied to the ranges in the document that users have permission to modify. + * Inserts a content control on the row. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - areEditableRangesShaded: boolean; + insertContentControl(): Word.ContentControl; /** - * Specifies whether field codes are displayed. + * Inserts rows using this row as a template. If values are specified, inserts the values into the new rows. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param insertLocation - Required. Where the new rows should be inserted, relative to the current row. It must be 'Before' or 'After'. + * @param rowCount - Required. Number of rows to add + * @param values - Optional. Strings to insert in the new rows, specified as a 2D array. The number of cells in each row must not exceed the number of cells in the existing row. */ - areFieldCodesDisplayed: boolean; + insertRows(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", rowCount: number, values?: string[][]): Word.TableRowCollection; /** - * Specifies whether Microsoft Word displays formatting changes made to the document with Track Changes enabled. + * Merges the row into one cell. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - areFormatChangesDisplayed: boolean; + merge(): Word.TableCell; /** - * Specifies whether handwritten ink annotations are shown or hidden. + * Performs a search with the specified SearchOptions on the scope of the row. The search results are a collection of range objects. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param searchText - Required. The search text. + * @param searchOptions - Optional. Options for the search. */ - areInkAnnotationsDisplayed: boolean; + search(searchText: string, searchOptions?: Word.SearchOptions | { + ignorePunct?: boolean; + ignoreSpace?: boolean; + matchCase?: boolean; + matchPrefix?: boolean; + matchSuffix?: boolean; + matchWholeWord?: boolean; + matchWildcards?: boolean; + }): Word.RangeCollection; /** - * Specifies whether Microsoft Word displays insertions and deletions made to the document with Track Changes enabled. + * Selects the row and navigates the Word UI to it. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param selectionMode - Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. */ - areInsertionsAndDeletionsDisplayed: boolean; + select(selectionMode?: Word.SelectionMode): void; /** - * Gets whether lines wrap at the right edge of the document window rather than at the right margin or the right column boundary. + * Selects the row and navigates the Word UI to it. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param selectionMode - Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. */ - readonly areLinesWrappedToWindow: boolean; + select(selectionMode?: "Select" | "Start" | "End"): void; /** - * Gets whether object anchors are displayed next to items that can be positioned in print layout view. + * Sets cell padding in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * @param cellPadding - Required. The cell padding. */ - readonly areObjectAnchorsDisplayed: boolean; + setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void; /** - * Gets whether Microsoft Word displays optional line breaks. + * Sets cell padding in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * @param cellPadding - Required. The cell padding. */ - readonly areOptionalBreaksDisplayed: boolean; + setCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void; /** - * Gets whether optional hyphens are displayed. + * Sets the height of the row. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param rowHeight - The height of the row, in points. + * @param heightRule - The rule for determining the height of the table row. */ - readonly areOptionalHyphensDisplayed: boolean; + setHeight(rowHeight: number, heightRule: Word.RowHeightRule): void; /** - * Gets whether other authors' presence should be visible in the document. + * Sets the height of the row. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param rowHeight - The height of the row, in points. + * @param heightRule - The rule for determining the height of the table row. */ - areOtherAuthorsVisible: boolean; + setHeight(rowHeight: number, heightRule: "Auto" | "AtLeast" | "Exactly"): void; /** - * Gets whether the top and bottom margins and the gray area between pages in the document are displayed. + * Sets the left indent for the table row. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param leftIndent - The distance (in points) between the current left edge of the table row and the desired left edge. + * @param rulerStyle - The ruler style to apply. */ - readonly arePageBoundariesDisplayed: boolean; + setLeftIndent(leftIndent: number, rulerStyle: Word.RulerStyle): void; /** - * Gets whether paragraph marks are displayed. + * Sets the left indent for the table row. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param leftIndent - The distance (in points) between the current left edge of the table row and the desired left edge. + * @param rulerStyle - The ruler style to apply. */ - readonly areParagraphsMarksDisplayed: boolean; + setLeftIndent(leftIndent: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void; /** - * Gets whether blank boxes are displayed as placeholders for pictures. + * 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?: Word.Interfaces.TableRowLoadOptions): Word.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[]): Word.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; + }): Word.TableRow; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.TableRow; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.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 `Word.TableRow` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableRowData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.TableRowData; + } + /** + * Contains the collection of the document's TableRow objects. + * + * @remarks + * [Api set: WordApi 1.3] + */ + 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: Word.TableRow[]; + /** + * Converts rows in a table to text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param options - Optional. An object that specifies the options for converting the table rows to text. + * @returns A `Range` object that represents the converted text. */ - readonly arePicturePlaceholdersDisplayed: boolean; + convertToText(options?: Word.TableConvertToTextOptions): Word.Range; /** - * Specifies whether Microsoft Word displays revisions and comments made to the document with Track Changes enabled. + * Deletes the table rows. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areRevisionsAndCommentsDisplayed: boolean; + delete(): void; /** - * Gets whether space characters are displayed. + * Adjusts the height of the rows so that they're equal. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly areSpacesIndicated: boolean; + distributeHeight(): void; /** - * Specifies whether table gridlines are displayed. + * Gets the first row in this collection. Throws an `ItemNotFound` error if this collection is empty. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - areTableGridlinesDisplayed: boolean; + getFirst(): Word.TableRow; /** - * Gets whether tab characters are displayed. + * Gets the first row in this collection. If this collection is empty, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - readonly areTabsDisplayed: boolean; + getFirstOrNullObject(): Word.TableRow; /** - * Gets whether dotted lines are displayed around page margins, text columns, objects, and frames in print layout view. + * Selects the table rows. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly areTextBoundariesDisplayed: boolean; + select(): void; /** - * Specifies the column width in Reading mode. + * Sets the height of the cells in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param rowHeight - The height of the row, in points. + * @param heightRule - The rule for determining the height of the specified rows. */ - columnWidth: Word.ColumnWidth | "Narrow" | "Default" | "Wide"; + setHeight(rowHeight: number, heightRule: Word.RowHeightRule): void; /** - * Gets on-screen shading for fields. + * Sets the height of the cells in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param rowHeight - The height of the row, in points. + * @param heightRule - The rule for determining the height of the specified rows. */ - readonly fieldShading: Word.FieldShading | "Never" | "Always" | "WhenSelected"; + setHeight(rowHeight: number, heightRule: "Auto" | "AtLeast" | "Exactly"): void; /** - * Specifies whether all the text in a window is displayed in the same sans-serif font with minimal formatting to speed up display. + * Sets the left indent for the table row. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param leftIndent - The distance (in points) between the current left edge of the specified rows and the desired left edge. + * @param rulerStyle - The ruler style to apply. */ - isDraft: boolean; + setLeftIndent(leftIndent: number, rulerStyle: Word.RulerStyle): void; /** - * Specifies whether only the first line of body text is shown in outline view. + * Sets the left indent for the table row. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param leftIndent - The distance (in points) between the current left edge of the specified rows and the desired left edge. + * @param rulerStyle - The ruler style to apply. */ - isFirstLineOnlyDisplayed: boolean; + setLeftIndent(leftIndent: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void; /** - * Specifies whether character formatting is visible in outline view. + * 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?: Word.Interfaces.TableRowCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.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[]): Word.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): Word.TableRowCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.TableRowCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.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 `Word.TableRowCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableRowCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.TableRowCollectionData; + } + /** + * Represents a table cell in a Word document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + 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 body object of the cell. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isFormatDisplayed: boolean; + readonly body: Word.Body; /** - * Specifies whether the window is in full-screen view. + * Returns the `TableColumn` object that represents the table column that contains this cell. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isFullScreen: boolean; + readonly column: Word.TableColumn; /** - * Gets whether text formatted as hidden text is displayed. + * Gets the parent row of the cell. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - readonly isHiddenTextDisplayed: boolean; + readonly parentRow: Word.TableRow; /** - * Gets whether highlight formatting is displayed and printed with the document. + * Gets the parent table of the cell. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - readonly isHighlightingDisplayed: boolean; + readonly parentTable: Word.Table; /** - * Specifies whether the document is in conflict mode view. + * Returns the `ShadingUniversal` object that represents the shading of the table cell. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isInConflictMode: boolean; + readonly shading: Word.ShadingUniversal; /** - * Specifies whether Microsoft Word is in Panning mode. + * Gets the index of the cell in its row. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isInPanning: boolean; + readonly cellIndex: number; /** - * Specifies whether the document is being viewed in reading layout view. + * Specifies the width of the cell's column in points. This is applicable to uniform tables. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isInReadingLayout: boolean; + columnWidth: number; /** - * Specifies whether mail merge data is displayed instead of mail merge fields. + * Specifies the horizontal alignment of the cell. The value can be 'Left', 'Centered', 'Right', or 'Justified'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isMailMergeDataView: boolean; + horizontalAlignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies whether the text in the document is visible when the header and footer areas are displayed. + * Gets the index of the cell's row in the table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isMainTextLayerVisible: boolean; + readonly rowIndex: number; /** - * Specifies whether the pointer is displayed as a magnifying glass in print preview. + * Specifies the shading color of the cell. Color is specified in "#RRGGBB" format or by using the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isPointerShownAsMagnifier: boolean; + shadingColor: string; /** - * Specifies whether pages displayed in reading layout view are displayed using the same layout as printed pages. + * Specifies the text of the cell. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isReadingLayoutActualView: boolean; + value: string; /** - * Specifies whether XML tags are visible in the document. + * Specifies the vertical alignment of the cell. The value can be 'Top', 'Center', or 'Bottom'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isXmlMarkupVisible: boolean; + verticalAlignment: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; /** - * Specifies the display mode for tracked changes. + * Gets the width of the cell in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - markupMode: Word.RevisionsMode | "Balloon" | "Inline" | "Mixed"; + readonly width: number; /** - * Specifies the page color in Reading mode. + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.TableCellUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.TableCell): void; + /** + * Inserts a {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | = (Formula) field} that calculates and displays the sum of the values in table cells above or to the left of the cell specified in the expression. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageColor: Word.PageColor | "None" | "Sepia" | "Inverse"; + autoSum(): void; /** - * Specifies the page movement type. + * Deletes the table cell and optionally controls how the remaining cells are shifted. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param shiftCells - Optional. Specifies how the remaining cells are shifted after the deletion. The default is `shiftLeft`. */ - pageMovementType: Word.PageMovementType | "Vertical" | "SideToSide"; + delete(shiftCells: any): void; /** - * Specifies whether margins are visible or hidden when the document is viewed in Full Screen Reading view. + * Deletes the column containing this cell. This is applicable to uniform tables. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - readingLayoutTruncateMargins: Word.ReadingLayoutMargin | "Automatic" | "Suppress" | "Full"; + deleteColumn(): void; /** - * Gets whether Word displays revision balloons in the left or right margin in the document. + * Deletes the row containing this cell. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - readonly revisionsBalloonSide: Word.RevisionsBalloonMargin | "Left" | "Right"; + deleteRow(): void; /** - * Specifies the width of the revision balloons. + * Inserts a {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | = (Formula) field} that contains the specified formula into a table cell. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param options - Optional. An object that specifies the options for the formula. */ - revisionsBalloonWidth: number; + formula(options?: Word.TableCellFormulaOptions): void; /** - * Specifies how Microsoft Word measures the width of revision balloons. + * Gets the border style for the specified border. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param borderLocation - Required. The border location. */ - revisionsBalloonWidthType: Word.RevisionsBalloonWidthType | "Percent" | "Points"; + getBorder(borderLocation: Word.BorderLocation): Word.TableBorder; /** - * Specifies the document element displayed in print layout view. + * Gets the border style for the specified border. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param borderLocation - Required. The border location. */ - seekView: Word.SeekView | "MainDocument" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "CurrentPageHeader" | "CurrentPageFooter"; + getBorder(borderLocation: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder; /** - * Specifies the active window pane. + * Gets cell padding in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. */ - splitSpecial: Word.SpecialPane | "None" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "FootnoteContinuationNotice" | "FootnoteContinuationSeparator" | "FootnoteSeparator" | "EndnoteContinuationNotice" | "EndnoteContinuationSeparator" | "EndnoteSeparator" | "Comments" | "CurrentPageHeader" | "CurrentPageFooter" | "Revisions" | "RevisionsHoriz" | "RevisionsVert"; + getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult; /** - * Specifies the view type. + * Gets cell padding in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. */ - type: Word.ViewType | "Normal" | "Outline" | "Print" | "PrintPreview" | "Master" | "Web" | "Reading" | "Conflict"; + getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult; /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Gets the next cell. Throws an `ItemNotFound` error if this cell is the last one. + * + * @remarks + * [Api set: WordApi 1.3] */ - set(properties: Interfaces.ViewUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.View): void; + getNext(): Word.TableCell; /** - * Collapses all the headings in the document. + * Gets the next cell. If this cell is the last one, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - collapseAllHeadings(): void; + getNextOrNullObject(): Word.TableCell; /** - * Collapses the text under the selection or the specified range by one heading level. + * Adds columns to the left or right of the cell, using the cell's column as a template. This is applicable to uniform tables. The string values, if specified, are set in the newly inserted rows. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] * - * @param range - A `Range` object that specifies the range to collapse. + * @param insertLocation - Required. It must be 'Before' or 'After'. + * @param columnCount - Required. Number of columns to add. + * @param values - Optional 2D array. Cells are filled if the corresponding strings are specified in the array. */ - collapseOutline(range: Word.Range): void; + insertColumns(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", columnCount: number, values?: string[][]): void; /** - * Expands all the headings in the document. + * Inserts rows above or below the cell, using the cell's row as a template. The string values, if specified, are set in the newly inserted rows. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param insertLocation - Required. It must be 'Before' or 'After'. + * @param rowCount - Required. Number of rows to add. + * @param values - Optional 2D array. Cells are filled if the corresponding strings are specified in the array. */ - expandAllHeadings(): void; + insertRows(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", rowCount: number, values?: string[][]): Word.TableRowCollection; /** - * Expands the text under the selection by one heading level. + * Merges this table cell with the specified table cell. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param range - A `Range` object that specifies the range to expand. + * @param mergeTo - The cell to be merged with. */ - expandOutline(range: Word.Range): void; + merge(mergeTo: Word.TableCell): void; /** - * Moves to the next header or footer, depending on whether a header or footer is displayed in the view. + * Selects the table cell. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nextHeaderFooter(): void; + select(): void; /** - * Moves to the previous header or footer, depending on whether a header or footer is displayed in the view. + * Sets cell padding in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * @param cellPadding - Required. The cell padding. */ - previousHeaderFooter(): void; + setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void; /** - * Switches between showing all text (headings and body text) and showing only headings. + * Sets cell padding in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation - Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * @param cellPadding - Required. The cell padding. */ - showAllHeadings(): void; + setCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void; /** - * Shows all headings up to the specified heading level and hides subordinate headings and body text. + * Splits the cell into the specified number of rows and columns. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] * - * @param level - The heading level to show. + * @param rowCount - Required. The number of rows to split into. Must be a divisor of the number of underlying rows. + * @param columnCount - Required. The number of columns to split into. */ - showHeading(level: number): void; + 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?: Word.Interfaces.ViewLoadOptions): Word.View; + load(options?: Word.Interfaces.TableCellLoadOptions): Word.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[]): Word.View; + load(propertyNames?: string | string[]): Word.TableCell; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -16377,338 +18065,431 @@ export declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.View; + }): Word.TableCell; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - track(): Word.View; + track(): Word.TableCell; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - untrack(): Word.View; + untrack(): Word.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 `Word.View` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ViewData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.TableCell` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableCellData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.ViewData; + toJSON(): Word.Interfaces.TableCellData; } /** - * Represents a shape in the header, footer, or document body. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * Contains the collection of the document's TableCell objects. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - export class Shape extends OfficeExtension.ClientObject { + 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: Word.TableCell[]; /** - * Represents the body object of the shape. Only applies to text boxes and geometric shapes. + * Changes the width of a table column to accommodate the width of the text without changing the way text wraps in the cells. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly body: Word.Body; + autoFit(): void; /** - * Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "Canvas". 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}. + * Deletes the table cells and optionally controls how the remaining cells are shifted. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param shiftCells - Optional. Specifies how the remaining cells are shifted after the deletion. The default is `shiftLeft`. */ - readonly canvas: Word.Canvas; + delete(shiftCells?: Word.DeleteCells): void; /** - * Returns the fill formatting of the shape. + * Deletes the table cells and optionally controls how the remaining cells are shifted. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param shiftCells - Optional. Specifies how the remaining cells are shifted after the deletion. The default is `shiftLeft`. */ - readonly fill: Word.ShapeFill; + delete(shiftCells?: "ShiftLeft" | "ShiftUp" | "EntireRow" | "EntireColumn"): void; /** - * Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas. + * Adjusts the height of the specified cells so that they are equal. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly parentCanvas: Word.Shape; + distributeHeight(): void; /** - * Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group. + * Adjusts the width of the specified cells so that they are equal. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly parentGroup: Word.Shape; + distributeWidth(): void; /** - * Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "GroupShape". 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}. + * Gets the first table cell in this collection. Throws an `ItemNotFound` error if this collection is empty. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - readonly shapeGroup: Word.ShapeGroup; + getFirst(): Word.TableCell; /** - * Gets the text frame object of the shape. + * Gets the first table cell in this collection. If this collection is empty, then this method will return 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: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - readonly textFrame: Word.TextFrame; + getFirstOrNullObject(): Word.TableCell; /** - * Returns the text wrap formatting of the shape. + * Merges the specified cells into a single cell. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly textWrap: Word.ShapeTextWrap; + merge(): void; /** - * Specifies whether a given shape can overlap other shapes. + * Sets the height of the cells in a table. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param rowHeight - The height of the row to set, in points. + * @param heightRule - The rule for determining the height of the specified rows. */ - allowOverlap: boolean; + setHeight(rowHeight: number, heightRule: Word.RowHeightRule): void; /** - * Specifies a string that represents the alternative text associated with the shape. + * Sets the height of the cells in a table. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param rowHeight - The height of the row to set, in points. + * @param heightRule - The rule for determining the height of the specified rows. */ - altTextDescription: string; + setHeight(rowHeight: number, heightRule: "Auto" | "AtLeast" | "Exactly"): void; /** - * The geometric shape type of the shape. It will be null if isn't a geometric shape. + * Sets the width of the cells in a table. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param columnWidth - The width of the row to set, in points. + * @param rulerStyle - The ruler style to apply. */ - geometricShapeType: Word.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"; + setWidth(columnWidth: number, rulerStyle: Word.RulerStyle): void; /** - * The height, in points, of the shape. + * Sets the width of the cells in a table. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param columnWidth - The width of the row to set, in points. + * @param rulerStyle - The ruler style to apply. */ - height: number; + setWidth(columnWidth: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void; /** - * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * Splits this range of table cells. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - TableCellCollectionSplitOptions. */ - heightRelative: number; + split(options?: Word.TableCellCollectionSplitOptions): void; /** - * Gets an integer that represents the shape identifier. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApiDesktop 1.2] + * @param options - Provides options for which properties of the object to load. */ - readonly id: number; + load(options?: Word.Interfaces.TableCellCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableCellCollection; /** - * Check whether this shape is a child of a group shape or a canvas shape. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApiDesktop 1.2] + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. */ - readonly isChild: boolean; + load(propertyNames?: string | string[]): Word.TableCellCollection; /** - * The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApiDesktop 1.2] + * @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. */ - left: number; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableCellCollection; /** - * The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set. + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.TableCellCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.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 `Word.TableCellCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableCellCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.TableCellCollectionData; + } + /** + * Specifies the border style. + * + * @remarks + * [Api set: WordApi 1.3] + */ + export class TableBorder 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 table border color. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - leftRelative: number; + color: string; /** - * Specifies if the aspect ratio of this shape is locked. + * Specifies the type of the table border. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - lockAspectRatio: boolean; + type: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; /** - * The name of the shape. + * Specifies the width, in points, of the table border. Not applicable to table border types that have fixed widths. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - name: string; + width: number; /** - * The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.TableBorderUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.TableBorder): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApiDesktop 1.2] + * @param options - Provides options for which properties of the object to load. */ - relativeHorizontalPosition: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; + load(options?: Word.Interfaces.TableBorderLoadOptions): Word.TableBorder; /** - * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApiDesktop 1.2] + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. */ - relativeHorizontalSize: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + load(propertyNames?: string | string[]): Word.TableBorder; /** - * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApiDesktop 1.2] + * @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. */ - relativeVerticalPosition: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.TableBorder; /** - * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.TableBorder; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.TableBorder; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TableBorder` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableBorderData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.TableBorderData; + } + /** + * Represents a document template. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class Template 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 `BuildingBlockEntryCollection` object that represents the collection of building block entries in the template. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - relativeVerticalSize: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + readonly buildingBlockEntries: Word.BuildingBlockEntryCollection; /** - * Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape. + * Returns a `BuildingBlockTypeItemCollection` object that represents the collection of building block types that are contained in the template. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rotation: number; + readonly buildingBlockTypes: Word.BuildingBlockTypeItemCollection; /** - * The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * Returns a `ListTemplateCollection` object that represents all the list templates in the template. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - top: number; + readonly listTemplates: Word.ListTemplateCollection; /** - * The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set. + * Specifies the East Asian language to use when breaking lines of text in the document or template. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topRelative: number; + farEastLineBreakLanguage: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; /** - * Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * Specifies the line break control level for the document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly type: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture" | "Canvas"; + farEastLineBreakLevel: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"; /** - * Specifies if the shape is visible. Not applicable to inline shapes. + * Returns the name of the template, including the drive or Web path. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - visible: boolean; + readonly fullName: string; /** - * The width, in points, of the shape. + * Specifies whether the spelling and grammar checker ignores documents based on this template. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width: number; + hasNoProofing: boolean; /** - * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * Specifies the character spacing adjustment for the template. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - widthRelative: number; + justificationMode: Word.JustificationMode | "Expand" | "Compress" | "CompressKana"; /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Specifies if Microsoft Word kerns half-width Latin characters and punctuation marks in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.ShapeUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Shape): void; + kerningByAlgorithm: boolean; /** - * Deletes the shape and its content. + * Specifies a `LanguageId` value that represents the language in the template. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - delete(): void; + languageId: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Moves the shape horizontally by the number of points. + * Specifies an East Asian language for the language in the template. * * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param distance - Required. Specifies how far the shape is to be moved horizontally, in points. Use a positive value to move the shape right. Use a negative value to move the shape left. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - moveHorizontally(distance: number): void; + languageIdFarEast: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Moves the shape vertically by the number of points. + * Returns only the name of the document template (excluding any path or other location information). * * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param distance - Required. Specifies how far the shape is to be moved vertically, in points. Use a positive value to move the shape up. Use a negative value to move the shape down. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - moveVertically(distance: number): void; + readonly name: string; /** - * Scales the height of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current height. + * Specifies the kinsoku characters after which Microsoft Word will not break a line. * * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param scaleFactor - Specifies the ratio between the height of the shape after you resize it and the current or original height. - * @param scaleType - Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images. - * @param scaleFrom - Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents that the shape's upper left corner retains its position. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - scaleHeight(scaleFactor: number, scaleType: Word.ShapeScaleType, scaleFrom?: Word.ShapeScaleFrom): void; + noLineBreakAfter: string; /** - * Scales the height of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current height. + * Specifies the kinsoku characters before which Microsoft Word will not break a line. * * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param scaleFactor - Specifies the ratio between the height of the shape after you resize it and the current or original height. - * @param scaleType - Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images. - * @param scaleFrom - Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents that the shape's upper left corner retains its position. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - scaleHeight(scaleFactor: number, scaleType: "CurrentSize" | "OriginalSize", scaleFrom?: "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"): void; + noLineBreakBefore: string; /** - * Scales the width of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current height. + * Returns the path to the document template. * * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param scaleFactor - Specifies the ratio between the width of the shape after you resize it and the current or original width. - * @param scaleType - Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images. - * @param scaleFrom - Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents that the shape's upper left corner retains its position. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - scaleWidth(scaleFactor: number, scaleType: Word.ShapeScaleType, scaleFrom?: Word.ShapeScaleFrom): void; + readonly path: string; /** - * Scales the width of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current height. + * Specifies `true` if the template has not changed since it was last saved, `false` if Microsoft Word displays a prompt to save changes when the document is closed. * * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param scaleFactor - Specifies the ratio between the width of the shape after you resize it and the current or original width. - * @param scaleType - Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images. - * @param scaleFrom - Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents that the shape's upper left corner retains its position. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - scaleWidth(scaleFactor: number, scaleType: "CurrentSize" | "OriginalSize", scaleFrom?: "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"): void; + saved: boolean; /** - * Selects the shape. + * Returns the template type. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly type: Word.TemplateType | "Normal" | "Global" | "Attached"; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.TemplateUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Template): void; + /** + * Saves the template. * - * @param selectMultipleShapes - Optional. Whether to select multiple floating shapes. The default value is false. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - select(selectMultipleShapes?: boolean): void; + save(): 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?: Word.Interfaces.ShapeLoadOptions): Word.Shape; + load(options?: Word.Interfaces.TemplateLoadOptions): Word.Template; /** * 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[]): Word.Shape; + load(propertyNames?: string | string[]): Word.Template; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -16717,151 +18498,177 @@ export declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.Shape; + }): Word.Template; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - track(): Word.Shape; + track(): Word.Template; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - untrack(): Word.Shape; + untrack(): Word.Template; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Shape` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.Template` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TemplateData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.ShapeData; + toJSON(): Word.Interfaces.TemplateData; } /** - * Represents a shape group in the document. To get the corresponding Shape object, use ShapeGroup.shape. + * Contains a collection of {@link Word.Template} objects that represent all the templates that are currently available. + This collection includes open templates, templates attached to open documents, and global templates loaded in the **Templates and Add-ins** dialog box. + To learn how to access this dialog in the Word UI, see {@link https://support.microsoft.com/office/2479fe53-f849-4394-88bb-2a6e2a39479d | Load or unload a template or add-in program}. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - export class ShapeGroup extends OfficeExtension.ClientObject { + export class TemplateCollection 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: Word.Template[]; /** - * Gets the Shape object associated with the group. + * Returns the number of items in the collection. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly shape: Word.Shape; + getCount(): OfficeExtension.ClientResult; /** - * Gets the collection of Shape objects. Currently, only text boxes, geometric shapes, and pictures are supported. + * Gets a `Template` object by its index in the collection. * * @remarks - * [Api set: WordApiDesktop 1.2] - */ - readonly shapes: Word.ShapeCollection; - /** - * Gets an integer that represents the shape group identifier. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - readonly id: number; - /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + * @param index - The index of the template to retrieve. */ - set(properties: Interfaces.ShapeGroupUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ShapeGroup): void; + getItemAt(index: number): Word.Template; /** - * Ungroups any grouped shapes in the specified shape group. + * Imports the building blocks for all templates into Microsoft Word. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ungroup(): Word.ShapeCollection; + importBuildingBlocks(): 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?: Word.Interfaces.ShapeGroupLoadOptions): Word.ShapeGroup; + load(options?: Word.Interfaces.TemplateCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TemplateCollection; /** * 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[]): Word.ShapeGroup; + load(propertyNames?: string | string[]): Word.TemplateCollection; /** * 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; - }): Word.ShapeGroup; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TemplateCollection; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - track(): Word.ShapeGroup; + track(): Word.TemplateCollection; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - untrack(): Word.ShapeGroup; + untrack(): Word.TemplateCollection; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ShapeGroup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeGroupData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.TemplateCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TemplateCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.ShapeGroupData; + toJSON(): Word.Interfaces.TemplateCollectionData; } /** - * Represents a canvas in the document. To get the corresponding Shape object, use Canvas.shape. + * Represents a tracked change in a Word document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] */ - export class Canvas extends OfficeExtension.ClientObject { + export class TrackedChange 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 Shape object associated with the canvas. + * Gets the author of the tracked change. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] */ - readonly shape: Word.Shape; + readonly author: string; /** - * Gets the collection of Shape objects. Currently, only text boxes, pictures, and geometric shapes are supported. + * Gets the date of the tracked change. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] */ - readonly shapes: Word.ShapeCollection; + readonly date: Date; /** - * Gets an integer that represents the canvas identifier. + * Gets the text of the tracked change. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] */ - readonly id: number; + readonly text: string; /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Gets the type of the tracked change. + * + * @remarks + * [Api set: WordApi 1.6] */ - set(properties: Interfaces.CanvasUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Canvas): void; + readonly type: Word.TrackedChangeType | "None" | "Added" | "Deleted" | "Formatted"; + /** + * Accepts the tracked change. + * + * @remarks + * [Api set: WordApi 1.6] + */ + accept(): void; + /** + * Gets the next tracked change. Throws an `ItemNotFound` error if this tracked change is the last one. + * + * @remarks + * [Api set: WordApi 1.6] + */ + getNext(): Word.TrackedChange; + /** + * Gets the next tracked change. If this tracked change is the last one, then this method will return 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: WordApi 1.6] + */ + getNextOrNullObject(): Word.TrackedChange; + /** + * Gets the range of the tracked change. + * + * @remarks + * [Api set: WordApi 1.6] + */ + getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range; + /** + * Rejects the tracked change. + * + * @remarks + * [Api set: WordApi 1.6] + */ + reject(): 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?: Word.Interfaces.CanvasLoadOptions): Word.Canvas; + load(options?: Word.Interfaces.TrackedChangeLoadOptions): Word.TrackedChange; /** * 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[]): Word.Canvas; + load(propertyNames?: string | string[]): Word.TrackedChange; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -16870,628 +18677,608 @@ export declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.Canvas; + }): Word.TrackedChange; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - track(): Word.Canvas; + track(): Word.TrackedChange; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - untrack(): Word.Canvas; + untrack(): Word.TrackedChange; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Canvas` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CanvasData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.TrackedChange` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TrackedChangeData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.CanvasData; + toJSON(): Word.Interfaces.TrackedChangeData; } /** - * Contains a collection of {@link Word.Shape} objects. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * Contains a collection of {@link Word.TrackedChange} objects. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] */ - export class ShapeCollection extends OfficeExtension.ClientObject { + export class TrackedChangeCollection 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: Word.Shape[]; - /** - * Gets the shapes that have the specified geometric types. Only applied to geometric shapes. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param types - Required. An array of geometric shape subtypes. - */ - getByGeometricTypes(types: Word.GeometricShapeType[]): Word.ShapeCollection; - /** - * Gets a shape by its identifier. Throws an `ItemNotFound` error if there isn't a shape with the identifier in this collection. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param id - Required. A shape identifier. - */ - getById(id: number): Word.Shape; - /** - * Gets a shape by its identifier. If there isn't a shape with the identifier in this collection, then this method will return 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: WordApiDesktop 1.2] - * - * @param id - Required. A shape identifier. - */ - getByIdOrNullObject(id: number): Word.Shape; - /** - * Gets the shapes by the identifiers. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param ids - Required. An array of shape identifiers. - */ - getByIds(ids: number[]): Word.ShapeCollection; - /** - * Gets the shapes that have the specified names. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param names - Required. An array of shape names. - */ - getByNames(names: string[]): Word.ShapeCollection; + readonly items: Word.TrackedChange[]; /** - * Gets the shapes that have the specified types. + * Accepts all the tracked changes in the collection. * * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param types - Required. An array of shape types. + * [Api set: WordApi 1.6] */ - getByTypes(types: Word.ShapeType[]): Word.ShapeCollection; + acceptAll(): void; /** - * Gets the first shape in this collection. Throws an `ItemNotFound` error if this collection is empty. + * Gets the first TrackedChange in this collection. Throws an `ItemNotFound` error if this collection is empty. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] */ - getFirst(): Word.Shape; + getFirst(): Word.TrackedChange; /** - * Gets the first shape in this collection. If this collection is empty, then this method will return 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}. + * Gets the first TrackedChange in this collection. If this collection is empty, then this method will return 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: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] */ - getFirstOrNullObject(): Word.Shape; + getFirstOrNullObject(): Word.TrackedChange; /** - * Groups floating shapes in this collection, inline shapes will be skipped. Returns a Shape object that represents the new group of shapes. + * Rejects all the tracked changes in the collection. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] */ - group(): Word.Shape; + rejectAll(): 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?: Word.Interfaces.ShapeCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ShapeCollection; + load(options?: Word.Interfaces.TrackedChangeCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TrackedChangeCollection; /** * 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[]): Word.ShapeCollection; + load(propertyNames?: string | string[]): Word.TrackedChangeCollection; /** * 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): Word.ShapeCollection; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TrackedChangeCollection; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - track(): Word.ShapeCollection; + track(): Word.TrackedChangeCollection; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - untrack(): Word.ShapeCollection; + untrack(): Word.TrackedChangeCollection; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ShapeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * Whereas the original `Word.TrackedChangeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TrackedChangeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.ShapeCollectionData; + toJSON(): Word.Interfaces.TrackedChangeCollectionData; } /** - * Represents the fill formatting of a shape object. + * Contains the view attributes (such as show all, field shading, and table gridlines) for a window or pane. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - export class ShapeFill extends OfficeExtension.ClientObject { + export class View 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 shape fill background color. You can provide the value in the '#RRGGBB' format or the color name. + * Gets the instance of a `RevisionsFilter` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - backgroundColor: string; + readonly revisionsFilter: Word.RevisionsFilter; /** - * Specifies the shape fill foreground color. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies whether all nonprinting characters are displayed. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - foregroundColor: string; + areAllNonprintingCharactersDisplayed: boolean; /** - * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type. + * Gets whether background colors and images are shown when the document is displayed in print layout view. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - transparency: number; + areBackgroundsDisplayed: boolean; /** - * Returns the fill type of the shape. See `Word.ShapeFillType` for details. + * Gets whether square brackets are displayed at the beginning and end of each bookmark. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly type: Word.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "Picture" | "Texture" | "Mixed"; + readonly areBookmarksIndicated: boolean; /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Specifies whether Microsoft Word displays the comments in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.ShapeFillUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ShapeFill): void; + areCommentsDisplayed: boolean; /** - * Clears the fill formatting of this shape and set it to `Word.ShapeFillType.NoFill`; + * Specifies whether Microsoft Word displays connecting lines from the text to the revision and comment balloons. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - clear(): void; + areConnectingLinesToRevisionsBalloonDisplayed: boolean; /** - * Sets the fill formatting of the shape to a uniform color. This changes the fill type to `Word.ShapeFillType.Solid`. + * Gets whether crop marks are shown in the corners of pages to indicate where margins are located. * * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param color - A string that represents the fill foreground color. You can provide the value in the '#RRGGBB' format or the color name. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - setSolidColor(color: string): void; + readonly areCropMarksDisplayed: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets whether objects created with the drawing tools are displayed in print layout view. * - * @param options - Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.ShapeFillLoadOptions): Word.ShapeFill; + readonly areDrawingsDisplayed: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether shading is applied to the ranges in the document that users have permission to modify. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.ShapeFill; + areEditableRangesShaded: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether field codes are displayed. * - * @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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.ShapeFill; + areFieldCodesDisplayed: boolean; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + * Specifies whether Microsoft Word displays formatting changes made to the document with Track Changes enabled. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.ShapeFill; + areFormatChangesDisplayed: boolean; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + * Specifies whether handwritten ink annotations are shown or hidden. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.ShapeFill; + areInkAnnotationsDisplayed: boolean; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ShapeFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeFillData`) that contains shallow copies of any loaded child properties from the original object. + * Specifies whether Microsoft Word displays insertions and deletions made to the document with Track Changes enabled. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.ShapeFillData; - } - /** - * Represents the text frame of a shape object. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - 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; + areInsertionsAndDeletionsDisplayed: boolean; /** - * 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. + * Gets whether lines wrap at the right edge of the document window rather than at the right margin or the right column boundary. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - autoSizeSetting: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed"; + readonly areLinesWrappedToWindow: boolean; /** - * Represents the bottom margin, in points, of the text frame. + * Gets whether object anchors are displayed next to items that can be positioned in print layout view. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bottomMargin: number; + readonly areObjectAnchorsDisplayed: boolean; /** - * Specifies if the text frame contains text. + * Gets whether Microsoft Word displays optional line breaks. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly hasText: boolean; + readonly areOptionalBreaksDisplayed: boolean; /** - * Represents the left margin, in points, of the text frame. + * Gets whether optional hyphens are displayed. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftMargin: number; + readonly areOptionalHyphensDisplayed: boolean; /** - * Returns True if text in the text frame shouldn't rotate when the shape is rotated. + * Gets whether other authors' presence should be visible in the document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - noTextRotation: boolean; + areOtherAuthorsVisible: boolean; /** - * Represents the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. + * Gets whether the top and bottom margins and the gray area between pages in the document are displayed. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - orientation: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed"; + readonly arePageBoundariesDisplayed: boolean; /** - * Represents the right margin, in points, of the text frame. + * Gets whether paragraph marks are displayed. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightMargin: number; + readonly areParagraphsMarksDisplayed: boolean; /** - * Represents the top margin, in points, of the text frame. + * Gets whether blank boxes are displayed as placeholders for pictures. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topMargin: number; + readonly arePicturePlaceholdersDisplayed: boolean; /** - * Represents the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. + * Specifies whether Microsoft Word displays revisions and comments made to the document with Track Changes enabled. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - verticalAlignment: Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom"; + areRevisionsAndCommentsDisplayed: boolean; /** - * Determines whether lines break automatically to fit text inside the shape. + * Gets whether space characters are displayed. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - wordWrap: boolean; + readonly areSpacesIndicated: boolean; /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Specifies whether table gridlines are displayed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.TextFrameUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.TextFrame): void; + areTableGridlinesDisplayed: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets whether tab characters are displayed. * - * @param options - Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.TextFrameLoadOptions): Word.TextFrame; + readonly areTabsDisplayed: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets whether dotted lines are displayed around page margins, text columns, objects, and frames in print layout view. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.TextFrame; + readonly areTextBoundariesDisplayed: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the column width in Reading mode. * - * @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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.TextFrame; + columnWidth: Word.ColumnWidth | "Narrow" | "Default" | "Wide"; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + * Gets on-screen shading for fields. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.TextFrame; + readonly fieldShading: Word.FieldShading | "Never" | "Always" | "WhenSelected"; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + * Specifies whether all the text in a window is displayed in the same sans-serif font with minimal formatting to speed up display. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.TextFrame; + isDraft: boolean; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TextFrame` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TextFrameData`) that contains shallow copies of any loaded child properties from the original object. + * Specifies whether only the first line of body text is shown in outline view. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.TextFrameData; - } - /** - * Represents all the properties for wrapping text around a shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - export class ShapeTextWrap 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; + isFirstLineOnlyDisplayed: boolean; /** - * Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape. + * Specifies whether character formatting is visible in outline view. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bottomDistance: number; + isFormatDisplayed: boolean; /** - * Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape. + * Specifies whether the window is in full-screen view. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftDistance: number; + isFullScreen: boolean; /** - * Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape. + * Gets whether text formatted as hidden text is displayed. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightDistance: number; + readonly isHiddenTextDisplayed: boolean; /** - * Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farthest from the page margin. + * Gets whether highlight formatting is displayed and printed with the document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - side: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest"; + readonly isHighlightingDisplayed: boolean; /** - * Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape. + * Specifies whether the document is in conflict mode view. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topDistance: number; + isInConflictMode: boolean; /** - * Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details. + * Specifies whether Microsoft Word is in Panning mode. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type: Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front"; + isInPanning: boolean; /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Specifies whether the document is being viewed in reading layout view. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.ShapeTextWrapUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ShapeTextWrap): void; + isInReadingLayout: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether mail merge data is displayed instead of mail merge fields. * - * @param options - Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.ShapeTextWrapLoadOptions): Word.ShapeTextWrap; + isMailMergeDataView: boolean; /** - * 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 document is visible when the header and footer areas are displayed. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.ShapeTextWrap; + isMainTextLayerVisible: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether the pointer is displayed as a magnifying glass in print preview. * - * @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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.ShapeTextWrap; + isPointerShownAsMagnifier: boolean; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + * Specifies whether pages displayed in reading layout view are displayed using the same layout as printed pages. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.ShapeTextWrap; + isReadingLayoutActualView: boolean; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + * Specifies whether XML tags are visible in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.ShapeTextWrap; + isXmlMarkupVisible: boolean; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ShapeTextWrap` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeTextWrapData`) that contains shallow copies of any loaded child properties from the original object. + * Specifies the display mode for tracked changes. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.ShapeTextWrapData; - } - /** - * Represents a single reviewer of a document in which changes have been tracked. The `Reviewer` object is a member of the {@link Word.ReviewerCollection} object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class Reviewer 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; + markupMode: Word.RevisionsMode | "Balloon" | "Inline" | "Mixed"; /** - * Specifies if the `Reviewer` object is visible. + * Specifies the page color in Reading mode. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible: boolean; + pageColor: Word.PageColor | "None" | "Sepia" | "Inverse"; /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Specifies the page movement type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.ReviewerUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Reviewer): void; + pageMovementType: Word.PageMovementType | "Vertical" | "SideToSide"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether margins are visible or hidden when the document is viewed in Full Screen Reading view. * - * @param options - Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.ReviewerLoadOptions): Word.Reviewer; + readingLayoutTruncateMargins: Word.ReadingLayoutMargin | "Automatic" | "Suppress" | "Full"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets whether Word displays revision balloons in the left or right margin in the document. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.Reviewer; + readonly revisionsBalloonSide: Word.RevisionsBalloonMargin | "Left" | "Right"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the width of the revision balloons. * - * @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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.Reviewer; - /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. - */ - track(): Word.Reviewer; - /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. - */ - untrack(): Word.Reviewer; + revisionsBalloonWidth: 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 `Word.Reviewer` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ReviewerData`) that contains shallow copies of any loaded child properties from the original object. + * Specifies how Microsoft Word measures the width of revision balloons. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.ReviewerData; - } - /** - * A collection of {@link Word.Reviewer} objects that represents the reviewers of one or more documents. The `ReviewerCollection` object contains the names of all reviewers who have reviewed documents opened or edited on a computer. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class ReviewerCollection 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: Word.Reviewer[]; + revisionsBalloonWidthType: Word.RevisionsBalloonWidthType | "Percent" | "Points"; /** - * Returns a `Reviewer` object that represents the specified item in the collection. + * Specifies the document element displayed in print layout view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param index - The index of the item to retrieve. */ - getItem(index: number): Word.Reviewer; + seekView: Word.SeekView | "MainDocument" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "CurrentPageHeader" | "CurrentPageFooter"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the active window pane. * - * @param options - Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.ReviewerCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ReviewerCollection; + splitSpecial: Word.SpecialPane | "None" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "FootnoteContinuationNotice" | "FootnoteContinuationSeparator" | "FootnoteSeparator" | "EndnoteContinuationNotice" | "EndnoteContinuationSeparator" | "EndnoteSeparator" | "Comments" | "CurrentPageHeader" | "CurrentPageFooter" | "Revisions" | "RevisionsHoriz" | "RevisionsVert"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the view type. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.ReviewerCollection; + type: Word.ViewType | "Normal" | "Outline" | "Print" | "PrintPreview" | "Master" | "Web" | "Reading" | "Conflict"; /** - * 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. + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.ReviewerCollection; + set(properties: Interfaces.ViewUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.View): void; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + * Collapses all the headings in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.ReviewerCollection; + collapseAllHeadings(): void; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + * Collapses the text under the selection or the specified range by one heading level. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param range - A `Range` object that specifies the range to collapse. */ - untrack(): Word.ReviewerCollection; + collapseOutline(range: Word.Range): 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 `Word.ReviewerCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ReviewerCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * Expands all the headings in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.ReviewerCollectionData; - } - /** - * Represents the current settings related to the display of reviewers' comments and revision marks in the document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class RevisionsFilter 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; + expandAllHeadings(): void; /** - * Gets the `ReviewerCollection` object that represents the collection of reviewers of one or more documents. + * Expands the text under the selection by one heading level. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param range - A `Range` object that specifies the range to expand. */ - readonly reviewers: Word.ReviewerCollection; + expandOutline(range: Word.Range): void; /** - * Specifies a `RevisionsMarkup` value that represents the extent of reviewer markup displayed in the document. + * Moves to the next header or footer, depending on whether a header or footer is displayed in the view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - markup: Word.RevisionsMarkup | "None" | "Simple" | "All"; + nextHeaderFooter(): void; /** - * Specifies a `RevisionsView` value that represents globally whether Word displays the original version of the document or the final version, which might have revisions and formatting changes applied. + * Moves to the previous header or footer, depending on whether a header or footer is displayed in the view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - view: Word.RevisionsView | "Final" | "Original"; + previousHeaderFooter(): void; /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Switches between showing all text (headings and body text) and showing only headings. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.RevisionsFilterUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.RevisionsFilter): void; + showAllHeadings(): void; /** - * Shows or hides all revisions in the document that contain comments and tracked changes. + * Shows all headings up to the specified heading level and hides subordinate headings and body text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param level - The heading level to show. */ - toggleShowAllReviewers(): void; + showHeading(level: 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?: Word.Interfaces.RevisionsFilterLoadOptions): Word.RevisionsFilter; + load(options?: Word.Interfaces.ViewLoadOptions): Word.View; /** * 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[]): Word.RevisionsFilter; + load(propertyNames?: string | string[]): Word.View; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -17500,360 +19287,338 @@ export declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.RevisionsFilter; + }): Word.View; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - track(): Word.RevisionsFilter; + track(): Word.View; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - untrack(): Word.RevisionsFilter; + untrack(): Word.View; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.RevisionsFilter` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RevisionsFilterData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.View` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ViewData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.RevisionsFilterData; + toJSON(): Word.Interfaces.ViewData; } /** - * Represents a single item in a {@link Word.RepeatingSectionContentControl}. + * Represents a shape in the header, footer, or document body. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - export class RepeatingSectionItem extends OfficeExtension.ClientObject { + export class Shape extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Returns the range of this repeating section item, excluding the start and end tags. + * Represents the body object of the shape. Only applies to text boxes and geometric shapes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - readonly range: Word.Range; - /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + * [Api set: WordApiDesktop 1.2] */ - set(properties: Interfaces.RepeatingSectionItemUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.RepeatingSectionItem): void; + readonly body: Word.Body; /** - * Deletes this `RepeatingSectionItem` object. + * Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "Canvas". 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - delete(): void; + readonly canvas: Word.Canvas; /** - * Adds a repeating section item after this item and returns the new item. + * Returns the fill formatting of the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - insertItemAfter(): Word.RepeatingSectionItem; + readonly fill: Word.ShapeFill; /** - * Adds a repeating section item before this item and returns the new item. + * Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - insertItemBefore(): Word.RepeatingSectionItem; + readonly parentCanvas: Word.Shape; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group. * - * @param options - Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(options?: Word.Interfaces.RepeatingSectionItemLoadOptions): Word.RepeatingSectionItem; + readonly parentGroup: Word.Shape; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "GroupShape". 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 propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(propertyNames?: string | string[]): Word.RepeatingSectionItem; + readonly shapeGroup: Word.ShapeGroup; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the text frame object of the shape. * - * @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: WordApiDesktop 1.2] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.RepeatingSectionItem; + readonly textFrame: Word.TextFrame; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + * Returns the text wrap formatting of the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] */ - track(): Word.RepeatingSectionItem; + readonly textWrap: Word.ShapeTextWrap; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + * Specifies whether a given shape can overlap other shapes. + * + * @remarks + * [Api set: WordApiDesktop 1.2] */ - untrack(): Word.RepeatingSectionItem; + allowOverlap: boolean; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.RepeatingSectionItem` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RepeatingSectionItemData`) that contains shallow copies of any loaded child properties from the original object. + * Specifies a string that represents the alternative text associated with the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] */ - toJSON(): Word.Interfaces.RepeatingSectionItemData; - } - /** - * Represents a collection of {@link Word.RepeatingSectionItem} objects in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class RepeatingSectionItemCollection 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; + altTextDescription: string; /** - * Returns an individual repeating section item. + * The geometric shape type of the shape. It will be null if isn't a geometric shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param index - The index of the item to retrieve. - * @returns A `RepeatingSectionItem` object representing the item at the specified index. + * [Api set: WordApiDesktop 1.2] */ - getItemAt(index: number): Word.RepeatingSectionItem; + geometricShapeType: Word.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"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * The height, in points, of the shape. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(propertyNames?: string | string[]): Word.RepeatingSectionItemCollection; + height: number; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. * - * @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: WordApiDesktop 1.2] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.RepeatingSectionItemCollection; + heightRelative: number; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + * Gets an integer that represents the shape identifier. + * + * @remarks + * [Api set: WordApiDesktop 1.2] */ - track(): Word.RepeatingSectionItemCollection; + readonly id: number; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + * Check whether this shape is a child of a group shape or a canvas shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] */ - untrack(): Word.RepeatingSectionItemCollection; + readonly isChild: boolean; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.RepeatingSectionItemCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RepeatingSectionItemCollectionData`) that contains shallow copies of any loaded child properties from the original object. + * The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * + * @remarks + * [Api set: WordApiDesktop 1.2] */ - toJSON(): { - [key: string]: string; - }; - } - /** - * Represents the `DatePickerContentControl` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class DatePickerContentControl 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; + left: number; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly placeholderText: Word.BuildingBlock; + leftRelative: number; /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * Specifies if the aspect ratio of this shape is locked. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly range: Word.Range; + lockAspectRatio: boolean; /** - * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * The name of the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly xmlMapping: Word.XmlMapping; + name: string; /** - * Specifies the appearance of the content control. + * The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + relativeHorizontalPosition: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - color: string; + relativeHorizontalSize: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies a `CalendarType` value that represents the calendar type for the date picker content control. + * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - dateCalendarType: Word.CalendarType | "Western" | "Arabic" | "Hebrew" | "Taiwan" | "Japan" | "Thai" | "Korean" | "SakaEra" | "TranslitEnglish" | "TranslitFrench" | "Umalqura"; + relativeVerticalPosition: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies the format in which dates are displayed. + * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - dateDisplayFormat: string; + relativeVerticalSize: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies a `LanguageId` that represents the language format for the date displayed in the date picker content control. + * Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - dateDisplayLocale: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + rotation: number; /** - * Specifies a `ContentControlDateStorageFormat` value that represents the format for storage and retrieval of dates when the date picker content control is bound to the XML data store of the active document. + * The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - dateStorageFormat: Word.ContentControlDateStorageFormat | "Text" | "Date" | "DateTime"; + top: number; /** - * Gets the identification for the content control. + * The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly id: string; + topRelative: number; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - isTemporary: boolean; + readonly type: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture" | "Canvas"; /** - * Specifies the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Specifies if the shape is visible. Not applicable to inline shapes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + visible: boolean; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * The width, in points, of the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - lockContentControl: boolean; + width: number; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - lockContents: boolean; + widthRelative: number; /** - * Gets whether the placeholder text for the content control is being displayed. + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ShapeUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Shape): void; + /** + * Deletes the shape and its content. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly showingPlaceholderText: boolean; + delete(): void; /** - * Specifies a tag to identify the content control. + * Moves the shape horizontally by the number of points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] + * + * @param distance - Required. Specifies how far the shape is to be moved horizontally, in points. Use a positive value to move the shape right. Use a negative value to move the shape left. */ - tag: string; + moveHorizontally(distance: number): void; /** - * Specifies the title for the content control. + * Moves the shape vertically by the number of points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] + * + * @param distance - Required. Specifies how far the shape is to be moved vertically, in points. Use a positive value to move the shape up. Use a negative value to move the shape down. */ - title: string; + moveVertically(distance: number): void; /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Scales the height of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current height. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + * + * @param scaleFactor - Specifies the ratio between the height of the shape after you resize it and the current or original height. + * @param scaleType - Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images. + * @param scaleFrom - Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents that the shape's upper left corner retains its position. */ - set(properties: Interfaces.DatePickerContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.DatePickerContentControl): void; + scaleHeight(scaleFactor: number, scaleType: Word.ShapeScaleType, scaleFrom?: Word.ShapeScaleFrom): void; /** - * Copies the content control from the active document to the Clipboard. + * Scales the height of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current height. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] + * + * @param scaleFactor - Specifies the ratio between the height of the shape after you resize it and the current or original height. + * @param scaleType - Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images. + * @param scaleFrom - Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents that the shape's upper left corner retains its position. */ - copy(): void; + scaleHeight(scaleFactor: number, scaleType: "CurrentSize" | "OriginalSize", scaleFrom?: "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"): void; /** - * Removes the content control from the active document and moves the content control to the Clipboard. + * Scales the width of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current height. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] + * + * @param scaleFactor - Specifies the ratio between the width of the shape after you resize it and the current or original width. + * @param scaleType - Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images. + * @param scaleFrom - Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents that the shape's upper left corner retains its position. */ - cut(): void; + scaleWidth(scaleFactor: number, scaleType: Word.ShapeScaleType, scaleFrom?: Word.ShapeScaleFrom): void; /** - * Deletes this content control and the contents of the content control. + * Scales the width of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current height. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] * - * @param deleteContents - Optional. If true, deletes the contents as well. + * @param scaleFactor - Specifies the ratio between the width of the shape after you resize it and the current or original width. + * @param scaleType - Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images. + * @param scaleFrom - Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents that the shape's upper left corner retains its position. */ - delete(deleteContents?: boolean): void; + scaleWidth(scaleFactor: number, scaleType: "CurrentSize" | "OriginalSize", scaleFrom?: "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"): void; /** - * Sets the placeholder text that displays in the content control until a user enters their own text. + * Selects the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] * - * @param options - Optional. The options for configuring the content control's placeholder text. + * @param selectMultipleShapes - Optional. Whether to select multiple floating shapes. The default value is false. */ - setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void; + select(selectMultipleShapes?: boolean): 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?: Word.Interfaces.DatePickerContentControlLoadOptions): Word.DatePickerContentControl; + load(options?: Word.Interfaces.ShapeLoadOptions): Word.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[]): Word.DatePickerContentControl; + load(propertyNames?: string | string[]): Word.Shape; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -17862,191 +19627,151 @@ export declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.DatePickerContentControl; + }): Word.Shape; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - track(): Word.DatePickerContentControl; + track(): Word.Shape; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - untrack(): Word.DatePickerContentControl; + untrack(): Word.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 `Word.DatePickerContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DatePickerContentControlData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.Shape` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.DatePickerContentControlData; + toJSON(): Word.Interfaces.ShapeData; } /** - * Represents the `PictureContentControl` object. + * Represents a shape group in the document. To get the corresponding Shape object, use ShapeGroup.shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - export class PictureContentControl extends OfficeExtension.ClientObject { + 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 a `BuildingBlock` object that represents the placeholder text for the content control. + * Gets the Shape object associated with the group. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly placeholderText: Word.BuildingBlock; + readonly shape: Word.Shape; /** - * Returns a `Range` object that represents the contents of the content control in the active document. + * Gets the collection of Shape objects. Currently, only text boxes, geometric shapes, and pictures are supported. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly range: Word.Range; + readonly shapes: Word.ShapeCollection; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Gets an integer that represents the shape group identifier. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly xmlMapping: Word.XmlMapping; + readonly id: number; /** - * Specifies the appearance of the content control. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + set(properties: Interfaces.ShapeGroupUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ShapeGroup): void; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Ungroups any grouped shapes in the specified shape group. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - color: string; + ungroup(): Word.ShapeCollection; /** - * Returns the identification for the content control. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param options - Provides options for which properties of the object to load. */ - readonly id: string; + load(options?: Word.Interfaces.ShapeGroupLoadOptions): Word.ShapeGroup; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. */ - isTemporary: boolean; + load(propertyNames?: string | string[]): Word.ShapeGroup; /** - * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param propertyNamesAndPaths - `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.ShapeGroup; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - lockContentControl: boolean; + track(): Word.ShapeGroup; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - lockContents: boolean; + untrack(): Word.ShapeGroup; /** - * Returns whether the placeholder text for the content control is being displayed. + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ShapeGroup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeGroupData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.ShapeGroupData; + } + /** + * Represents a canvas in the document. To get the corresponding Shape object, use Canvas.shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + export class Canvas 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 Shape object associated with the canvas. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly showingPlaceholderText: boolean; + readonly shape: Word.Shape; /** - * Specifies a tag to identify the content control. + * Gets the collection of Shape objects. Currently, only text boxes, pictures, and geometric shapes are supported. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - tag: string; + readonly shapes: Word.ShapeCollection; /** - * Specifies the title for the content control. + * Gets an integer that represents the canvas identifier. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - title: string; + readonly id: number; /** * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - set(properties: Interfaces.PictureContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; + set(properties: Interfaces.CanvasUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.PictureContentControl): void; - /** - * Copies the content control from the active document to the Clipboard. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - copy(): void; - /** - * Removes the content control from the active document and moves the content control to the Clipboard. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - cut(): void; - /** - * Deletes the content control and optionally its contents. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param deleteContents - Optional. Decides whether to delete the contents of the content control. - */ - delete(deleteContents?: boolean): void; - /** - * Sets the placeholder text that displays in the content control until a user enters their own text. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param options - Optional. The options for configuring the content control's placeholder text. - */ - setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void; + set(properties: Word.Canvas): 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?: Word.Interfaces.PictureContentControlLoadOptions): Word.PictureContentControl; + load(options?: Word.Interfaces.CanvasLoadOptions): Word.Canvas; /** * 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[]): Word.PictureContentControl; + load(propertyNames?: string | string[]): Word.Canvas; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -18055,199 +19780,212 @@ export declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.PictureContentControl; + }): Word.Canvas; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - track(): Word.PictureContentControl; + track(): Word.Canvas; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - untrack(): Word.PictureContentControl; + untrack(): Word.Canvas; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.PictureContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PictureContentControlData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.Canvas` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CanvasData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.PictureContentControlData; + toJSON(): Word.Interfaces.CanvasData; } /** - * Represents the `GroupContentControl` object. + * Contains a collection of {@link Word.Shape} objects. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - export class GroupContentControl extends OfficeExtension.ClientObject { + 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: Word.Shape[]; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Gets the shapes that have the specified geometric types. Only applied to geometric shapes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] + * + * @param types - Required. An array of geometric shape subtypes. */ - readonly placeholderText: Word.BuildingBlock; + getByGeometricTypes(types: Word.GeometricShapeType[]): Word.ShapeCollection; /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * Gets a shape by its identifier. Throws an `ItemNotFound` error if there isn't a shape with the identifier in this collection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] + * + * @param id - Required. A shape identifier. */ - readonly range: Word.Range; + getById(id: number): Word.Shape; /** - * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Gets a shape by its identifier. If there isn't a shape with the identifier in this collection, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] + * + * @param id - Required. A shape identifier. */ - readonly xmlMapping: Word.XmlMapping; + getByIdOrNullObject(id: number): Word.Shape; /** - * Specifies the appearance of the content control. + * Gets the shapes by the identifiers. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] + * + * @param ids - Required. An array of shape identifiers. */ - appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + getByIds(ids: number[]): Word.ShapeCollection; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Gets the shapes that have the specified names. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] + * + * @param names - Required. An array of shape names. */ - color: string; + getByNames(names: string[]): Word.ShapeCollection; /** - * Returns the identification for the content control. + * Gets the shapes that have the specified types. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] + * + * @param types - Required. An array of shape types. */ - readonly id: string; + getByTypes(types: Word.ShapeType[]): Word.ShapeCollection; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Gets the first shape in this collection. Throws an `ItemNotFound` error if this collection is empty. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - isTemporary: boolean; + getFirst(): Word.Shape; /** - * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Gets the first shape in this collection. If this collection is empty, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + getFirstOrNullObject(): Word.Shape; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Groups floating shapes in this collection, inline shapes will be skipped. Returns a Shape object that represents the new group of shapes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - lockContentControl: boolean; + group(): Word.Shape; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param options - Provides options for which properties of the object to load. */ - lockContents: boolean; + load(options?: Word.Interfaces.ShapeCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ShapeCollection; /** - * Returns whether the placeholder text for the content control is being displayed. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. */ - readonly showingPlaceholderText: boolean; + load(propertyNames?: string | string[]): Word.ShapeCollection; /** - * Specifies a tag to identify the content control. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @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. */ - tag: string; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.ShapeCollection; /** - * Specifies the title for the content control. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - title: string; + track(): Word.ShapeCollection; /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - set(properties: Interfaces.GroupContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.GroupContentControl): void; + untrack(): Word.ShapeCollection; /** - * Copies the content control from the active document to the Clipboard. + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ShapeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.ShapeCollectionData; + } + /** + * Represents the fill formatting of a shape object. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + 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; + /** + * Specifies the shape fill background color. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - copy(): void; + backgroundColor: string; /** - * Removes the content control from the active document and moves the content control to the Clipboard. + * Specifies the shape fill foreground color. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - cut(): void; + foregroundColor: string; /** - * Deletes the content control and optionally its contents. + * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param deleteContents - Optional. Whether to delete the contents inside the control. + * [Api set: WordApiDesktop 1.2] */ - delete(deleteContents: boolean): void; + transparency: number; /** - * Sets the placeholder text that displays in the content control until a user enters their own text. + * Returns the fill type of the shape. See `Word.ShapeFillType` for details. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] + */ + readonly type: Word.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "Picture" | "Texture" | "Mixed"; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ShapeFillUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ShapeFill): void; + /** + * Clears the fill formatting of this shape and set it to `Word.ShapeFillType.NoFill`; * - * @param options - Optional. The options for configuring the content control's placeholder text. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void; + clear(): void; /** - * Removes the group content control from the document so that its child content controls are no longer nested and can be freely edited. + * Sets the fill formatting of the shape to a uniform color. This changes the fill type to `Word.ShapeFillType.Solid`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] + * + * @param color - A string that represents the fill foreground color. You can provide the value in the '#RRGGBB' format or the color name. */ - ungroup(): void; + 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?: Word.Interfaces.GroupContentControlLoadOptions): Word.GroupContentControl; + load(options?: Word.Interfaces.ShapeFillLoadOptions): Word.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[]): Word.GroupContentControl; + load(propertyNames?: string | string[]): Word.ShapeFill; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -18256,240 +19994,214 @@ export declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.GroupContentControl; + }): Word.ShapeFill; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - track(): Word.GroupContentControl; + track(): Word.ShapeFill; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - untrack(): Word.GroupContentControl; + untrack(): Word.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 `Word.GroupContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.GroupContentControlData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.ShapeFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeFillData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.GroupContentControlData; + toJSON(): Word.Interfaces.ShapeFillData; } /** - * The options that define what placeholder to be used in the content control. + * Represents the text frame of a shape object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - export interface ContentControlPlaceholderOptions { + 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; /** - * If provided, specifies the `BuildingBlock` object to use as placeholder. + * 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - buildingBlock?: Word.BuildingBlock; + autoSizeSetting: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed"; /** - * If provided, specifies the `Range` object to use as placeholder. + * Represents the bottom margin, in points, of the text frame. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - range?: Word.Range; + bottomMargin: number; /** - * If provided, specifies the text to use as placeholder. + * Specifies if the text frame contains text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - text?: string; - } - /** - * Represents the `BuildingBlockGalleryContentControl` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class BuildingBlockGalleryContentControl 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; + readonly hasText: boolean; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Represents the left margin, in points, of the text frame. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly placeholderText: Word.BuildingBlock; + leftMargin: number; /** - * Returns a `Range` object that represents the contents of the content control in the active document. + * Returns True if text in the text frame shouldn't rotate when the shape is rotated. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly range: Word.Range; + noTextRotation: boolean; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Represents the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly xmlMapping: Word.XmlMapping; + orientation: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed"; /** - * Specifies the appearance of the content control. + * Represents the right margin, in points, of the text frame. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + rightMargin: number; /** - * Specifies the category for the building block content control. + * Represents the top margin, in points, of the text frame. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - buildingBlockCategory: string; + topMargin: number; /** - * Specifies a `BuildingBlockType` value that represents the type of building block for the building block content control. + * Represents the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - buildingBlockType: Word.BuildingBlockType | "QuickParts" | "CoverPage" | "Equations" | "Footers" | "Headers" | "PageNumber" | "Tables" | "Watermarks" | "AutoText" | "TextBox" | "PageNumberTop" | "PageNumberBottom" | "PageNumberPage" | "TableOfContents" | "CustomQuickParts" | "CustomCoverPage" | "CustomEquations" | "CustomFooters" | "CustomHeaders" | "CustomPageNumber" | "CustomTables" | "CustomWatermarks" | "CustomAutoText" | "CustomTextBox" | "CustomPageNumberTop" | "CustomPageNumberBottom" | "CustomPageNumberPage" | "CustomTableOfContents" | "Custom1" | "Custom2" | "Custom3" | "Custom4" | "Custom5" | "Bibliography" | "CustomBibliography"; + verticalAlignment: Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom"; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Determines whether lines break automatically to fit text inside the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - color: string; + wordWrap: boolean; /** - * Gets the identification for the content control. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - readonly id: string; + set(properties: Interfaces.TextFrameUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.TextFrame): void; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param options - Provides options for which properties of the object to load. */ - isTemporary: boolean; + load(options?: Word.Interfaces.TextFrameLoadOptions): Word.TextFrame; /** - * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. */ - readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + load(propertyNames?: string | string[]): Word.TextFrame; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @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. */ - lockContentControl: boolean; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.TextFrame; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - lockContents: boolean; + track(): Word.TextFrame; /** - * Gets if the placeholder text for the content control is being displayed. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - readonly showingPlaceholderText: boolean; + untrack(): Word.TextFrame; /** - * Specifies a tag to identify the content control. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TextFrame` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TextFrameData`) that contains shallow copies of any loaded child properties from the original object. */ - tag: string; + toJSON(): Word.Interfaces.TextFrameData; + } + /** + * Represents all the properties for wrapping text around a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + export class ShapeTextWrap 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 title for the content control. + * Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - title: string; + bottomDistance: number; /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] */ - set(properties: Interfaces.BuildingBlockGalleryContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.BuildingBlockGalleryContentControl): void; + leftDistance: number; /** - * Copies the content control from the active document to the Clipboard. + * Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - copy(): void; + rightDistance: number; /** - * Removes the content control from the active document and moves the content control to the Clipboard. + * Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farthest from the page margin. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - cut(): void; + side: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest"; /** - * Deletes the content control and optionally its contents. + * Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param deleteContents - Optional. Whether to delete the contents inside the control. + * [Api set: WordApiDesktop 1.2] */ - delete(deleteContents?: boolean): void; + topDistance: number; /** - * Sets the placeholder text that displays in the content control until a user enters their own text. + * Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param options - The options for configuring the content control's placeholder text. + * [Api set: WordApiDesktop 1.2] */ - setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void; + type: Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front"; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ShapeTextWrapUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ShapeTextWrap): 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?: Word.Interfaces.BuildingBlockGalleryContentControlLoadOptions): Word.BuildingBlockGalleryContentControl; + load(options?: Word.Interfaces.ShapeTextWrapLoadOptions): Word.ShapeTextWrap; /** * 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[]): Word.BuildingBlockGalleryContentControl; + load(propertyNames?: string | string[]): Word.ShapeTextWrap; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -18498,215 +20210,198 @@ export declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.BuildingBlockGalleryContentControl; + }): Word.ShapeTextWrap; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - track(): Word.BuildingBlockGalleryContentControl; + track(): Word.ShapeTextWrap; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - untrack(): Word.BuildingBlockGalleryContentControl; + untrack(): Word.ShapeTextWrap; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.BuildingBlockGalleryContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BuildingBlockGalleryContentControlData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.ShapeTextWrap` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeTextWrapData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.BuildingBlockGalleryContentControlData; + toJSON(): Word.Interfaces.ShapeTextWrapData; } /** - * Represents the `RepeatingSectionContentControl` object. + * Represents a single reviewer of a document in which changes have been tracked. The `Reviewer` object is a member of the {@link Word.ReviewerCollection} object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export class RepeatingSectionContentControl extends OfficeExtension.ClientObject { + export class Reviewer 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 `BuildingBlock` object that represents the placeholder text for the content control. + * Specifies if the `Reviewer` object is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly placeholderText: Word.BuildingBlock; + isVisible: boolean; /** - * Gets a `Range` object that represents the contents of the content control in the active document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - readonly range: Word.Range; + set(properties: Interfaces.ReviewerUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Reviewer): void; /** - * Returns the collection of repeating section items in this repeating section content control. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param options - Provides options for which properties of the object to load. */ - readonly repeatingSectionItems: Word.RepeatingSectionItemCollection; + load(options?: Word.Interfaces.ReviewerLoadOptions): Word.Reviewer; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. */ - readonly xmlapping: Word.XmlMapping; + load(propertyNames?: string | string[]): Word.Reviewer; /** - * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @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. */ - allowInsertDeleteSection: boolean; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Reviewer; /** - * Specifies the appearance of the content control. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + track(): Word.Reviewer; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - color: string; + untrack(): Word.Reviewer; /** - * Returns the identification for the content control. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Reviewer` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ReviewerData`) that contains shallow copies of any loaded child properties from the original object. */ - readonly id: string; + toJSON(): Word.Interfaces.ReviewerData; + } + /** + * A collection of {@link Word.Reviewer} objects that represents the reviewers of one or more documents. The `ReviewerCollection` object contains the names of all reviewers who have reviewed documents opened or edited on a computer. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class ReviewerCollection 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: Word.Reviewer[]; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Returns a `Reviewer` object that represents the specified item in the collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param index - The index of the item to retrieve. */ - isTemporary: boolean; + getItem(index: number): Word.Reviewer; /** - * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param options - Provides options for which properties of the object to load. */ - readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + load(options?: Word.Interfaces.ReviewerCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ReviewerCollection; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. */ - lockContentControl: boolean; + load(propertyNames?: string | string[]): Word.ReviewerCollection; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @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. */ - lockContents: boolean; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.ReviewerCollection; /** - * Specifies the name of the repeating section items used in the context menu associated with this repeating section content control. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - repeatingSectionItemTitle: string; + track(): Word.ReviewerCollection; /** - * Returns whether the placeholder text for the content control is being displayed. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - readonly showingPlaceholderText: boolean; + untrack(): Word.ReviewerCollection; /** - * Specifies a tag to identify the content control. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ReviewerCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ReviewerCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - tag: string; + toJSON(): Word.Interfaces.ReviewerCollectionData; + } + /** + * Represents the current settings related to the display of reviewers' comments and revision marks in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class RevisionsFilter 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 title for the content control. + * Gets the `ReviewerCollection` object that represents the collection of reviewers of one or more documents. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title: string; - /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. - */ - set(properties: Interfaces.RepeatingSectionContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.RepeatingSectionContentControl): void; + readonly reviewers: Word.ReviewerCollection; /** - * Copies the content control from the active document to the Clipboard. + * Specifies a `RevisionsMarkup` value that represents the extent of reviewer markup displayed in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - copy(): void; + markup: Word.RevisionsMarkup | "None" | "Simple" | "All"; /** - * Removes the content control from the active document and moves the content control to the Clipboard. + * Specifies a `RevisionsView` value that represents globally whether Word displays the original version of the document or the final version, which might have revisions and formatting changes applied. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cut(): void; + view: Word.RevisionsView | "Final" | "Original"; /** - * Deletes the content control and the contents of the content control. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param deleteContents - Optional. Whether to delete the contents inside the control. + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - delete(deleteContents?: boolean): void; + set(properties: Interfaces.RevisionsFilterUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.RevisionsFilter): void; /** - * Sets the placeholder text that displays in the content control until a user enters their own text. + * Shows or hides all revisions in the document that contain comments and tracked changes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param options - Optional. The options for configuring the content control's placeholder text. */ - setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void; + toggleShowAllReviewers(): 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?: Word.Interfaces.RepeatingSectionContentControlLoadOptions): Word.RepeatingSectionContentControl; + load(options?: Word.Interfaces.RevisionsFilterLoadOptions): Word.RevisionsFilter; /** * 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[]): Word.RepeatingSectionContentControl; + load(propertyNames?: string | string[]): Word.RevisionsFilter; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -18715,157 +20410,178 @@ export declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.RepeatingSectionContentControl; + }): Word.RevisionsFilter; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - track(): Word.RepeatingSectionContentControl; + track(): Word.RevisionsFilter; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - untrack(): Word.RepeatingSectionContentControl; + untrack(): Word.RevisionsFilter; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.RepeatingSectionContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RepeatingSectionContentControlData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.RevisionsFilter` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RevisionsFilterData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.RepeatingSectionContentControlData; + toJSON(): Word.Interfaces.RevisionsFilterData; } /** - * Calendar types. + * Represents a single item in a {@link Word.RepeatingSectionContentControl}. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum CalendarType { + export class RepeatingSectionItem 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; /** - * Western calendar type. + * Returns the range of this repeating section item, excluding the start and end tags. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - western = "Western", + readonly range: Word.Range; /** - * Arabic calendar type. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - arabic = "Arabic", + set(properties: Interfaces.RepeatingSectionItemUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.RepeatingSectionItem): void; /** - * Hebrew calendar type. + * Deletes this `RepeatingSectionItem` object. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hebrew = "Hebrew", + delete(): void; /** - * Taiwan calendar type. + * Adds a repeating section item after this item and returns the new item. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - taiwan = "Taiwan", + insertItemAfter(): Word.RepeatingSectionItem; /** - * Japanese calendar type. + * Adds a repeating section item before this item and returns the new item. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - japan = "Japan", + insertItemBefore(): Word.RepeatingSectionItem; /** - * Thai calendar type. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - thai = "Thai", + load(options?: Word.Interfaces.RepeatingSectionItemLoadOptions): Word.RepeatingSectionItem; /** - * Korean calendar type. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - korean = "Korean", + load(propertyNames?: string | string[]): Word.RepeatingSectionItem; /** - * Saka Era calendar type. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - sakaEra = "SakaEra", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.RepeatingSectionItem; /** - * Transliterated English calendar type. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - translitEnglish = "TranslitEnglish", + track(): Word.RepeatingSectionItem; /** - * Transliterated French calendar type. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - translitFrench = "TranslitFrench", + untrack(): Word.RepeatingSectionItem; /** - * Umm al-Qura calendar type. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.RepeatingSectionItem` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RepeatingSectionItemData`) that contains shallow copies of any loaded child properties from the original object. */ - umalqura = "Umalqura", + toJSON(): Word.Interfaces.RepeatingSectionItemData; } /** - * Date storage formats for {@link Word.DatePickerContentControl}. + * Represents a collection of {@link Word.RepeatingSectionItem} objects in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum ContentControlDateStorageFormat { + export class RepeatingSectionItemCollection 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; /** - * Stores the date as text. + * Returns an individual repeating section item. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param index - The index of the item to retrieve. + * @returns A `RepeatingSectionItem` object representing the item at the specified index. */ - text = "Text", + getItemAt(index: number): Word.RepeatingSectionItem; /** - * Stores the date as a date object. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - date = "Date", + load(propertyNames?: string | string[]): Word.RepeatingSectionItemCollection; /** - * Stores the date as a date-time object. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - dateTime = "DateTime", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.RepeatingSectionItemCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.RepeatingSectionItemCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.RepeatingSectionItemCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.RepeatingSectionItemCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RepeatingSectionItemCollectionData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): { + [key: string]: string; + }; } /** - * Represents a frame. The `Frame` object is a member of the {@link Word.FrameCollection} object. + * Represents a single tracked change in a document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export class Frame extends OfficeExtension.ClientObject { + export class Revision 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 `BorderUniversalCollection` object that represents all the borders for the frame. + * Gets a `Range` object that represents the range of text that was moved from one place to another in the document with tracked changes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly borders: Word.BorderUniversalCollection; + readonly movedRange: Word.Range; /** - * Returns a `Range` object that represents the portion of the document that's contained within the frame. + * Gets a `Range` object that represents the portion of the document that's contained within a revision mark. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -18873,870 +20589,770 @@ export declare namespace Word { */ readonly range: Word.Range; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. + * Gets the name of the user who made the tracked change. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly shading: Word.ShadingUniversal; + readonly author: string; /** - * Specifies the height (in points) of the frame. + * Gets the date and time when the tracked change was made. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - height: number; + readonly date: Date; /** - * Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. + * Gets the description of tracked formatting changes in the revision. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - heightRule: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; + readonly formatDescription: string; /** - * Specifies the horizontal distance between the frame and the surrounding text, in points. + * Gets a number that represents the position of this item in a collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontalDistanceFromText: number; + readonly index: number; /** - * Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property. + * Gets the revision type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontalPosition: number; + readonly type: Word.RevisionType | "None" | "Insert" | "Delete" | "Property" | "ParagraphNumber" | "DisplayField" | "Reconcile" | "Conflict" | "Style" | "Replace" | "ParagraphProperty" | "TableProperty" | "SectionProperty" | "StyleDefinition" | "MovedFrom" | "MovedTo" | "CellInsertion" | "CellDeletion" | "CellMerge" | "CellSplit" | "ConflictInsert" | "ConflictDelete"; /** - * Specifies if the frame is locked. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - lockAnchor: boolean; + set(properties: Interfaces.RevisionUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Revision): void; /** - * Specifies the relative horizontal position of the frame. + * Accepts the tracked change, removes the revision mark, and incorporates the change into the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - relativeHorizontalPosition: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; + accept(): void; /** - * Specifies the relative vertical position of the frame. + * Rejects the tracked change. The revision marks are removed, leaving the original text intact. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - relativeVerticalPosition: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + reject(): void; /** - * Specifies if document text wraps around the 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param options - Provides options for which properties of the object to load. */ - textWrap: boolean; + load(options?: Word.Interfaces.RevisionLoadOptions): Word.Revision; /** - * Specifies the vertical distance (in points) between the frame and the surrounding text. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. */ - verticalDistanceFromText: number; + load(propertyNames?: string | string[]): Word.Revision; /** - * Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @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. */ - verticalPosition: number; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Revision; /** - * Specifies the width (in points) of the frame. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - width: number; + track(): Word.Revision; /** - * Specifies the rule used to determine the width of the frame. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - widthRule: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; + untrack(): Word.Revision; /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Revision` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RevisionData`) that contains shallow copies of any loaded child properties from the original object. */ - set(properties: Interfaces.FrameUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Frame): void; + toJSON(): Word.Interfaces.RevisionData; + } + /** + * A collection of Revision objects that represent the changes marked with revision marks in a range or document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class RevisionCollection 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: Word.Revision[]; /** - * Copies the frame to the Clipboard. + * Accepts all the tracked changes in the document or range, removes all revision marks, and incorporates the changes into the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - copy(): void; + acceptAll(): void; /** - * Removes the frame from the document and places it on the Clipboard. + * Returns a `Revision` object that represents the specified item in the collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - */ - cut(): void; - /** - * Deletes the frame. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param index - The index of the item to retrieve. */ - delete(): void; + getItem(index: number): Word.Revision; /** - * Selects the frame. + * Rejects all the tracked changes in the document or range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - select(): void; + rejectAll(): 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?: Word.Interfaces.FrameLoadOptions): Word.Frame; + load(options?: Word.Interfaces.RevisionCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.RevisionCollection; /** * 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[]): Word.Frame; + load(propertyNames?: string | string[]): Word.RevisionCollection; /** * 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; - }): Word.Frame; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.RevisionCollection; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - track(): Word.Frame; + track(): Word.RevisionCollection; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - untrack(): Word.Frame; + untrack(): Word.RevisionCollection; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Frame` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FrameData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.RevisionCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RevisionCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.FrameData; + toJSON(): Word.Interfaces.RevisionCollectionData; } /** - * Represents the collection of {@link Word.Frame} objects. + * Represents the `DatePickerContentControl` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export class FrameCollection extends OfficeExtension.ClientObject { + export class DatePickerContentControl 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: Word.Frame[]; /** - * Returns a `Frame` object that represents a new frame added to a range, selection, or document. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + */ + readonly placeholderText: Word.BuildingBlock; + /** + * Gets a `Range` object that represents the contents of the content control in the active document. * - * @param range - The range where the frame will be added. - * @returns A `Frame` object that represents the new frame. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - add(range: Word.Range): Word.Frame; + readonly range: Word.Range; /** - * Deletes the `FrameCollection` object. + * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - delete(): void; + readonly xmlMapping: Word.XmlMapping; /** - * Gets a `Frame` object by its index in the collection. + * Specifies the appearance of the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + */ + appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + /** + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * - * @param index - The location of a `Frame` object. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getItem(index: number): Word.Frame; + color: string; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies a `CalendarType` value that represents the calendar type for the date picker content control. * - * @param options - Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.FrameCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.FrameCollection; + dateCalendarType: Word.CalendarType | "Western" | "Arabic" | "Hebrew" | "Taiwan" | "Japan" | "Thai" | "Korean" | "SakaEra" | "TranslitEnglish" | "TranslitFrench" | "Umalqura"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the format in which dates are displayed. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.FrameCollection; + dateDisplayFormat: string; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies a `LanguageId` that represents the language format for the date displayed in the date picker content control. * - * @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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.FrameCollection; + dateDisplayLocale: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + * Specifies a `ContentControlDateStorageFormat` value that represents the format for storage and retrieval of dates when the date picker content control is bound to the XML data store of the active document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.FrameCollection; + dateStorageFormat: Word.ContentControlDateStorageFormat | "Text" | "Date" | "DateTime"; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + * Gets the identification for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.FrameCollection; + readonly id: 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 `Word.FrameCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FrameCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.FrameCollectionData; - } - /** - * Represents a document library version. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class DocumentLibraryVersion 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; + isTemporary: boolean; /** - * Gets any optional comments associated with this version of the shared document. + * Specifies the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly comments: string; + readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * Gets the date and time at which this version of the shared document was last saved to the server. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly modified: any; + lockContentControl: boolean; /** - * Gets the name of the user who last saved this version of the shared document to the server. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly modifiedBy: string; + lockContents: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets whether the placeholder text for the content control is being displayed. * - * @param options - Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.DocumentLibraryVersionLoadOptions): Word.DocumentLibraryVersion; + readonly showingPlaceholderText: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies a tag to identify the content control. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.DocumentLibraryVersion; + tag: string; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the title for the content control. * - * @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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.DocumentLibraryVersion; + title: string; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - track(): Word.DocumentLibraryVersion; + set(properties: Interfaces.DatePickerContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.DatePickerContentControl): void; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + * Copies the content control from the active document to the Clipboard. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.DocumentLibraryVersion; + copy(): 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 `Word.DocumentLibraryVersion` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentLibraryVersionData`) that contains shallow copies of any loaded child properties from the original object. + * Removes the content control from the active document and moves the content control to the Clipboard. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.DocumentLibraryVersionData; - } - /** - * Represents the collection of {@link Word.DocumentLibraryVersion} objects. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class DocumentLibraryVersionCollection 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: Word.DocumentLibraryVersion[]; + cut(): void; /** - * Gets a `DocumentLibraryVersion` object by its index in the collection. + * Deletes this content control and the contents of the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param index - The location of a `DocumentLibraryVersion` object. + * @param deleteContents - Optional. If true, deletes the contents as well. */ - getItem(index: number): Word.DocumentLibraryVersion; + delete(deleteContents?: boolean): void; /** - * Returns whether the document library in which the active document is saved on the server is configured to create a backup copy, or version, each time the file is edited on the website. + * Sets the placeholder text that displays in the content control until a user enters their own text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param options - Optional. The options for configuring the content control's placeholder text. */ - isVersioningEnabled(): OfficeExtension.ClientResult; + setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): 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?: Word.Interfaces.DocumentLibraryVersionCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.DocumentLibraryVersionCollection; + load(options?: Word.Interfaces.DatePickerContentControlLoadOptions): Word.DatePickerContentControl; /** * 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[]): Word.DocumentLibraryVersionCollection; + load(propertyNames?: string | string[]): Word.DatePickerContentControl; /** * 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): Word.DocumentLibraryVersionCollection; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.DatePickerContentControl; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - track(): Word.DocumentLibraryVersionCollection; + track(): Word.DatePickerContentControl; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - untrack(): Word.DocumentLibraryVersionCollection; + untrack(): Word.DatePickerContentControl; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.DocumentLibraryVersionCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentLibraryVersionCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ - toJSON(): Word.Interfaces.DocumentLibraryVersionCollectionData; - } - /** - * Represents the possible change tracking modes. - * - * @remarks - * [Api set: WordApi 1.4] - */ - enum ChangeTrackingMode { - /** - * ChangeTracking is turned off. - * @remarks - * [Api set: WordApi 1.4] - */ - off = "Off", - /** - * ChangeTracking is turned on for everyone. - * @remarks - * [Api set: WordApi 1.4] - */ - trackAll = "TrackAll", - /** - * Tracking is turned on for my changes only. - * @remarks - * [Api set: WordApi 1.4] - */ - trackMineOnly = "TrackMineOnly", - } - /** - * Specify the current version or the original version of the text. - * - * @remarks - * [Api set: WordApi 1.4] - */ - enum ChangeTrackingVersion { - /** - * @remarks - * [Api set: WordApi 1.4] - */ - original = "Original", - /** - * @remarks - * [Api set: WordApi 1.4] + * Whereas the original `Word.DatePickerContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DatePickerContentControlData`) that contains shallow copies of any loaded child properties from the original object. */ - current = "Current", + toJSON(): Word.Interfaces.DatePickerContentControlData; } /** - * Specify the track state when ChangeTracking is on. + * Represents the `PictureContentControl` object. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum ChangeTrackingState { + export class PictureContentControl 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 `BuildingBlock` object that represents the placeholder text for the content control. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - unknown = "Unknown", + readonly placeholderText: Word.BuildingBlock; /** + * Returns a `Range` object that represents the contents of the content control in the active document. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - normal = "Normal", + readonly range: Word.Range; /** + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - added = "Added", + readonly xmlMapping: Word.XmlMapping; /** + * Specifies the appearance of the content control. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - deleted = "Deleted", - } - /** - * TrackedChange type. - * - * @remarks - * [Api set: WordApi 1.6] - */ - enum TrackedChangeType { + appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * No revision. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - none = "None", + color: string; /** - * Add change. + * Returns the identification for the content control. + * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - added = "Added", + readonly id: string; /** - * Delete change. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - deleted = "Deleted", + isTemporary: boolean; /** - * Format change. + * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - formatted = "Formatted", - } - /** - * Note item type - * - * @remarks - * [Api set: WordApi 1.5] - */ - enum NoteItemType { + readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - footnote = "Footnote", + lockContentControl: boolean; /** + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - endnote = "Endnote", - } - /** - * Provides information about the type of a raised event. - * - * @remarks - * [Api set: WordApi 1.5] - */ - enum EventType { + lockContents: boolean; /** - * ContentControlDeleted represents the event that the content control has been deleted. + * Returns whether the placeholder text for the content control is being displayed. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - contentControlDeleted = "ContentControlDeleted", + readonly showingPlaceholderText: boolean; /** - * ContentControlSelectionChanged represents the event that the selection in the content control has been changed. + * Specifies a tag to identify the content control. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - contentControlSelectionChanged = "ContentControlSelectionChanged", + tag: string; /** - * ContentControlDataChanged represents the event that the data in the content control have been changed. + * Specifies the title for the content control. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - contentControlDataChanged = "ContentControlDataChanged", + title: string; /** - * ContentControlAdded represents the event a content control has been added to the document. - * @remarks - * [Api set: WordApi 1.5] + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - contentControlAdded = "ContentControlAdded", + set(properties: Interfaces.PictureContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.PictureContentControl): void; /** - * Represents that one or more comments were deleted. + * Copies the content control from the active document to the Clipboard. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - commentDeleted = "CommentDeleted", + copy(): void; /** - * Represents that a comment was selected. + * Removes the content control from the active document and moves the content control to the Clipboard. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - commentSelected = "CommentSelected", + cut(): void; /** - * Represents that a comment was deselected. + * Deletes the content control and optionally its contents. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param deleteContents - Optional. Decides whether to delete the contents of the content control. */ - commentDeselected = "CommentDeselected", + delete(deleteContents?: boolean): void; /** - * Represents that a comment or its reply was changed. + * Sets the placeholder text that displays in the content control until a user enters their own text. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param options - Optional. The options for configuring the content control's placeholder text. */ - commentChanged = "CommentChanged", + setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void; /** - * Represents that one or more new comments were added. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - commentAdded = "CommentAdded", + load(options?: Word.Interfaces.PictureContentControlLoadOptions): Word.PictureContentControl; /** - * Represents that a content control has been entered. - * @remarks - * [Api set: WordApi 1.5] + * 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. */ - contentControlEntered = "ContentControlEntered", + load(propertyNames?: string | string[]): Word.PictureContentControl; /** - * Represents that a content control has been exited. - * @remarks - * [Api set: WordApi 1.5] + * 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. */ - contentControlExited = "ContentControlExited", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.PictureContentControl; /** - * Represents that one or more new paragraphs were added. - * @remarks - * [Api set: WordApi 1.6] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - paragraphAdded = "ParagraphAdded", + track(): Word.PictureContentControl; /** - * Represents that one or more paragraphs were changed. - * @remarks - * [Api set: WordApi 1.6] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - paragraphChanged = "ParagraphChanged", + untrack(): Word.PictureContentControl; /** - * Represents that one or more paragraphs were deleted. - * @remarks - * [Api set: WordApi 1.6] - */ - paragraphDeleted = "ParagraphDeleted", - /** - * Represents that an annotation was clicked (or selected with **Alt+Down**) in the document. - * @remarks - * [Api set: WordApi 1.7] - */ - annotationClicked = "AnnotationClicked", - /** - * Represents that an annotation was hovered over in the document. - * @remarks - * [Api set: WordApi 1.7] - */ - annotationHovered = "AnnotationHovered", - /** - * Represents that one or more annotations were added in the document. - * @remarks - * [Api set: WordApi 1.7] - */ - annotationInserted = "AnnotationInserted", - /** - * Represents that one or more annotations were deleted from the document. - * @remarks - * [Api set: WordApi 1.7] - */ - annotationRemoved = "AnnotationRemoved", - /** - * Represents an action in the annotation pop-up. - * @remarks - * [Api set: WordApi 1.8] - */ - annotationPopupAction = "AnnotationPopupAction", - } - /** - * An enum that specifies an event's source. It can be local or remote (through coauthoring). - * - * @remarks - * [Api set: WordApi 1.5] - */ - enum EventSource { - /** - * @remarks - * [Api set: WordApi 1.5] - */ - local = "Local", - /** - * @remarks - * [Api set: WordApi 1.5] + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.PictureContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PictureContentControlData`) that contains shallow copies of any loaded child properties from the original object. */ - remote = "Remote", + toJSON(): Word.Interfaces.PictureContentControlData; } /** - * Provides information about the content control that raised contentControlAdded event. + * Represents the `GroupContentControl` object. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - export interface ContentControlAddedEventArgs { - /** - * The event type. See Word.EventType for details. - * - * @remarks - * [Api set: WordApi 1.5] - */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + export class GroupContentControl 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 content control IDs. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ids: number[]; + readonly placeholderText: Word.BuildingBlock; /** - * The source of the event. It can be local or remote (through coauthoring). + * Gets a `Range` object that represents the contents of the content control in the active document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - source: Word.EventSource | "Local" | "Remote"; - } - /** - * Provides information about the content control that raised contentControlDataChanged event. - * - * @remarks - * [Api set: WordApi 1.5] - */ - export interface ContentControlDataChangedEventArgs { + readonly range: Word.Range; /** - * The event type. See Word.EventType for details. + * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + readonly xmlMapping: Word.XmlMapping; /** - * Gets the content control IDs. + * Specifies the appearance of the content control. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ids: number[]; + appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * The source of the event. It can be local or remote (through coauthoring). + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - source: Word.EventSource | "Local" | "Remote"; - } - /** - * Provides information about the content control that raised contentControlDeleted event. - * - * @remarks - * [Api set: WordApi 1.5] - */ - export interface ContentControlDeletedEventArgs { + color: string; /** - * The event type. See Word.EventType for details. + * Returns the identification for the content control. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + readonly id: string; /** - * Gets the content control IDs. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ids: number[]; + isTemporary: boolean; /** - * The source of the event. It can be local or remote (through coauthoring). + * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - source: Word.EventSource | "Local" | "Remote"; - } - /** - * Provides information about the content control that raised contentControlEntered event. - * - * @remarks - * [Api set: WordApi 1.5] - */ - export interface ContentControlEnteredEventArgs { + readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * The event type. See Word.EventType for details. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + lockContentControl: boolean; /** - * Gets the content control IDs. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ids: number[]; + lockContents: boolean; /** - * The source of the event. It can be local or remote (through coauthoring). + * Returns whether the placeholder text for the content control is being displayed. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - source: Word.EventSource | "Local" | "Remote"; - } - /** - * Provides information about the content control that raised contentControlExited event. - * - * @remarks - * [Api set: WordApi 1.5] - */ - export interface ContentControlExitedEventArgs { + readonly showingPlaceholderText: boolean; /** - * The event type. See Word.EventType for details. + * Specifies a tag to identify the content control. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + tag: string; /** - * Gets the content control IDs. + * Specifies the title for the content control. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ids: number[]; + title: string; /** - * The source of the event. It can be local or remote (through coauthoring). - * - * @remarks - * [Api set: WordApi 1.5] + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - source: Word.EventSource | "Local" | "Remote"; - } - /** - * Represents a dropped capital letter in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class DropCap 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; + set(properties: Interfaces.GroupContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.GroupContentControl): void; /** - * Gets the distance (in points) between the dropped capital letter and the paragraph text. + * Copies the content control from the active document to the Clipboard. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly distanceFromText: number; + copy(): void; /** - * Gets the name of the font for the dropped capital letter. + * Removes the content control from the active document and moves the content control to the Clipboard. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly fontName: string; + cut(): void; /** - * Gets the height (in lines) of the dropped capital letter. + * Deletes the content control and optionally its contents. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - */ - readonly linesToDrop: number; - /** - * Gets the position of the dropped capital letter. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param deleteContents - Optional. Whether to delete the contents inside the control. */ - readonly position: Word.DropPosition | "None" | "Normal" | "Margin"; + delete(deleteContents: boolean): void; /** - * Removes the dropped capital letter formatting. + * Sets the placeholder text that displays in the content control until a user enters their own text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param options - Optional. The options for configuring the content control's placeholder text. */ - clear(): void; + setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void; /** - * Formats the first character in the specified paragraph as a dropped capital letter. + * Removes the group content control from the document so that its child content controls are no longer nested and can be freely edited. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enable(): void; + 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?: Word.Interfaces.DropCapLoadOptions): Word.DropCap; + load(options?: Word.Interfaces.GroupContentControlLoadOptions): Word.GroupContentControl; /** * 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[]): Word.DropCap; + load(propertyNames?: string | string[]): Word.GroupContentControl; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -19745,14169 +21361,14492 @@ export declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.DropCap; + }): Word.GroupContentControl; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - track(): Word.DropCap; + track(): Word.GroupContentControl; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - untrack(): Word.DropCap; + untrack(): Word.GroupContentControl; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.DropCap` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DropCapData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.GroupContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.GroupContentControlData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.DropCapData; + toJSON(): Word.Interfaces.GroupContentControlData; } /** - * Provides information about the content control that raised contentControlSelectionChanged event. + * The options that define what placeholder to be used in the content control. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - export interface ContentControlSelectionChangedEventArgs { + export interface ContentControlPlaceholderOptions { /** - * The event type. See Word.EventType for details. + * If provided, specifies the `BuildingBlock` object to use as placeholder. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + buildingBlock?: Word.BuildingBlock; /** - * Gets the content control IDs. + * If provided, specifies the `Range` object to use as placeholder. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ids: number[]; + range?: Word.Range; /** - * The source of the event. It can be local or remote (through coauthoring). + * If provided, specifies the text to use as placeholder. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - source: Word.EventSource | "Local" | "Remote"; + text?: string; } /** - * Provides information about the paragraphs that raised the paragraphAdded event. + * Represents the `BuildingBlockGalleryContentControl` object. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - export interface ParagraphAddedEventArgs { - /** - * The source of the event. It can be local or remote (through coauthoring). - * - * @remarks - * [Api set: WordApi 1.6] - */ - source: Word.EventSource | "Local" | "Remote"; - /** - * The event type. See Word.EventType for details. - * - * @remarks - * [Api set: WordApi 1.6] - */ - type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + export class BuildingBlockGalleryContentControl 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 IDs of the involved paragraphs. IDs are in standard 8-4-4-4-12 GUID format without curly braces and differ across sessions and coauthors. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - uniqueLocalIds: string[]; - } - /** - * Provides information about the paragraphs that raised the paragraphChanged event. - * - * @remarks - * [Api set: WordApi 1.6] - */ - export interface ParagraphChangedEventArgs { + readonly placeholderText: Word.BuildingBlock; /** - * The source of the event. It can be local or remote (through coauthoring). + * Returns a `Range` object that represents the contents of the content control in the active document. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - source: Word.EventSource | "Local" | "Remote"; + readonly range: Word.Range; /** - * The event type. See Word.EventType for details. + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + readonly xmlMapping: Word.XmlMapping; /** - * Gets the unique IDs of the involved paragraphs. IDs are in standard 8-4-4-4-12 GUID format without curly braces and differ across sessions and coauthors. + * Specifies the appearance of the content control. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - uniqueLocalIds: string[]; - } - /** - * Provides information about the paragraphs that raised the paragraphDeleted event. - * - * @remarks - * [Api set: WordApi 1.6] - */ - export interface ParagraphDeletedEventArgs { + appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * The source of the event. It can be local or remote (through coauthoring). + * Specifies the category for the building block content control. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - source: Word.EventSource | "Local" | "Remote"; + buildingBlockCategory: string; /** - * The event type. See Word.EventType for details. + * Specifies a `BuildingBlockType` value that represents the type of building block for the building block content control. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + buildingBlockType: Word.BuildingBlockType | "QuickParts" | "CoverPage" | "Equations" | "Footers" | "Headers" | "PageNumber" | "Tables" | "Watermarks" | "AutoText" | "TextBox" | "PageNumberTop" | "PageNumberBottom" | "PageNumberPage" | "TableOfContents" | "CustomQuickParts" | "CustomCoverPage" | "CustomEquations" | "CustomFooters" | "CustomHeaders" | "CustomPageNumber" | "CustomTables" | "CustomWatermarks" | "CustomAutoText" | "CustomTextBox" | "CustomPageNumberTop" | "CustomPageNumberBottom" | "CustomPageNumberPage" | "CustomTableOfContents" | "Custom1" | "Custom2" | "Custom3" | "Custom4" | "Custom5" | "Bibliography" | "CustomBibliography"; /** - * Gets the unique IDs of the involved paragraphs. IDs are in standard 8-4-4-4-12 GUID format without curly braces and differ across sessions and coauthors. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - uniqueLocalIds: string[]; - } - /** - * Provides information about the comments that raised the comment event. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface CommentEventArgs { + color: string; /** - * Represents how the comment changed event is triggered. + * Gets the identification for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - changeType: Word.CommentChangeType | "none" | "edited" | "resolved" | "reopened" | "replyAdded" | "replyDeleted" | "replyEdited"; + readonly id: string; /** - * Gets the CommentDetail array which contains the IDs and reply IDs of the involved comments. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - commentDetails: Word.CommentDetail[]; + isTemporary: boolean; /** - * The source of the event. It can be local or remote (through coauthoring). + * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - source: Word.EventSource | "Local" | "Remote"; + readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * The event type. See Word.EventType for details. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; - } - /** - * A structure for the ID and reply IDs of this comment. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface CommentDetail { + lockContentControl: boolean; /** - * Represents the ID of this comment. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id: string; + lockContents: boolean; /** - * Represents the IDs of the replies to this comment. + * Gets if the placeholder text for the content control is being displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - replyIds: string[]; - } - /** - * Represents how the comments in the event were changed. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum CommentChangeType { + readonly showingPlaceholderText: boolean; /** - * No comment changed event is triggered. + * Specifies a tag to identify the content control. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "none", + tag: string; /** - * A comment was edited. + * Specifies the title for the content control. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - edited = "edited", + title: string; /** - * A comment was resolved. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - resolved = "resolved", + set(properties: Interfaces.BuildingBlockGalleryContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.BuildingBlockGalleryContentControl): void; /** - * A comment was reopened. + * Copies the content control from the active document to the Clipboard. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - reopened = "reopened", + copy(): void; /** - * A reply was added. + * Removes the content control from the active document and moves the content control to the Clipboard. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - replyAdded = "replyAdded", + cut(): void; /** - * A reply was deleted. + * Deletes the content control and optionally its contents. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param deleteContents - Optional. Whether to delete the contents inside the control. */ - replyDeleted = "replyDeleted", + delete(deleteContents?: boolean): void; /** - * A reply was edited. + * Sets the placeholder text that displays in the content control until a user enters their own text. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param options - The options for configuring the content control's placeholder text. */ - replyEdited = "replyEdited", - } - /** - * Specifies supported content control types and subtypes. - * - * @remarks - * [Api set: WordApi 1.1] - */ - enum ContentControlType { + setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void; /** - * @remarks - * [Api set: WordApi 1.1] + * 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. */ - unknown = "Unknown", + load(options?: Word.Interfaces.BuildingBlockGalleryContentControlLoadOptions): Word.BuildingBlockGalleryContentControl; /** - * @remarks - * [Api set: WordApi 1.1] + * 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. */ - richTextInline = "RichTextInline", + load(propertyNames?: string | string[]): Word.BuildingBlockGalleryContentControl; /** - * @remarks - * [Api set: WordApi 1.1] + * 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. */ - richTextParagraphs = "RichTextParagraphs", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.BuildingBlockGalleryContentControl; /** - * Contains a whole cell. - * @remarks - * [Api set: WordApi 1.1] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - richTextTableCell = "RichTextTableCell", + track(): Word.BuildingBlockGalleryContentControl; /** - * Contains a whole row. - * @remarks - * [Api set: WordApi 1.1] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - richTextTableRow = "RichTextTableRow", - /** - * Contains a whole table. - * @remarks - * [Api set: WordApi 1.1] - */ - richTextTable = "RichTextTable", - /** - * @remarks - * [Api set: WordApi 1.1] - */ - plainTextInline = "PlainTextInline", + untrack(): Word.BuildingBlockGalleryContentControl; /** - * @remarks - * [Api set: WordApi 1.1] + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.BuildingBlockGalleryContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BuildingBlockGalleryContentControlData`) that contains shallow copies of any loaded child properties from the original object. */ - plainTextParagraph = "PlainTextParagraph", + toJSON(): Word.Interfaces.BuildingBlockGalleryContentControlData; + } + /** + * Represents the `RepeatingSectionContentControl` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class RepeatingSectionContentControl 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 `BuildingBlock` object that represents the placeholder text for the content control. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - picture = "Picture", + readonly placeholderText: Word.BuildingBlock; /** + * Gets a `Range` object that represents the contents of the content control in the active document. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - buildingBlockGallery = "BuildingBlockGallery", + readonly range: Word.Range; /** + * Returns the collection of repeating section items in this repeating section content control. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - checkBox = "CheckBox", + readonly repeatingSectionItems: Word.RepeatingSectionItemCollection; /** + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - comboBox = "ComboBox", + readonly xmlapping: Word.XmlMapping; /** + * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dropDownList = "DropDownList", + allowInsertDeleteSection: boolean; /** + * Specifies the appearance of the content control. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - datePicker = "DatePicker", + appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - repeatingSection = "RepeatingSection", + color: string; /** - * Identifies a rich text content control. + * Returns the identification for the content control. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - richText = "RichText", + readonly id: string; /** + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - plainText = "PlainText", + isTemporary: boolean; /** + * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - group = "Group", - } - /** - * ContentControl appearance. - * - * @remarks - * [Api set: WordApi 1.1] - * - * Content control appearance options are BoundingBox, Tags, or Hidden. - */ - enum ContentControlAppearance { + readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * Represents a content control shown as a shaded rectangle or bounding box (with optional title). + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - boundingBox = "BoundingBox", + lockContentControl: boolean; /** - * Represents a content control shown as start and end markers. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tags = "Tags", + lockContents: boolean; /** - * Represents a content control that isn't shown. + * Specifies the name of the repeating section items used in the context menu associated with this repeating section content control. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - hidden = "Hidden", - } - /** - * Content control level types. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ContentControlLevel { + repeatingSectionItemTitle: string; /** - * Represents an inline content control. + * Returns whether the placeholder text for the content control is being displayed. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - inline = "Inline", + readonly showingPlaceholderText: boolean; /** - * Represents a paragraph-level content control. + * Specifies a tag to identify the content control. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - paragraph = "Paragraph", + tag: string; /** - * Represents a row-level content control. + * Specifies the title for the content control. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - row = "Row", + title: string; /** - * Represents a cell-level content control. + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.RepeatingSectionContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.RepeatingSectionContentControl): void; + /** + * Copies the content control from the active document to the Clipboard. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cell = "Cell", - } - /** - * Represents the state of the content control. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ContentControlState { + copy(): void; /** - * Error state. + * Removes the content control from the active document and moves the content control to the Clipboard. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - error = "Error", + cut(): void; /** - * Warning state. + * Deletes the content control and the contents of the content control. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param deleteContents - Optional. Whether to delete the contents inside the control. */ - warning = "Warning", - } - /** - * The supported styles for underline format. - * - * @remarks - * [Api set: WordApi 1.1] - */ - enum UnderlineType { + delete(deleteContents?: boolean): void; /** + * Sets the placeholder text that displays in the content control until a user enters their own text. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - Optional. The options for configuring the content control's placeholder text. */ - mixed = "Mixed", + setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void; /** - * No underline. - * @remarks - * [Api set: WordApi 1.1] + * 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. */ - none = "None", + load(options?: Word.Interfaces.RepeatingSectionContentControlLoadOptions): Word.RepeatingSectionContentControl; /** - * Warning: hidden has been deprecated. - * @deprecated Hidden is no longer supported. - * @remarks - * [Api set: WordApi 1.1] + * 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. */ - hidden = "Hidden", + load(propertyNames?: string | string[]): Word.RepeatingSectionContentControl; /** - * Warning: dotLine has been deprecated. - * @deprecated DotLine is no longer supported. - * @remarks - * [Api set: WordApi 1.1] + * 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. */ - dotLine = "DotLine", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.RepeatingSectionContentControl; /** - * A single underline. This is the default value. - * @remarks - * [Api set: WordApi 1.1] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - single = "Single", + track(): Word.RepeatingSectionContentControl; /** - * Only underline individual words. - * @remarks - * [Api set: WordApi 1.1] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - word = "Word", + untrack(): Word.RepeatingSectionContentControl; /** - * A double underline. - * @remarks - * [Api set: WordApi 1.1] + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.RepeatingSectionContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RepeatingSectionContentControlData`) that contains shallow copies of any loaded child properties from the original object. */ - double = "Double", + toJSON(): Word.Interfaces.RepeatingSectionContentControlData; + } + /** + * Calendar types. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum CalendarType { /** - * A single thick underline. + * Western calendar type. * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - thick = "Thick", + western = "Western", /** - * A dotted underline. + * Arabic calendar type. * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dotted = "Dotted", + arabic = "Arabic", /** + * Hebrew calendar type. * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dottedHeavy = "DottedHeavy", + hebrew = "Hebrew", /** - * A single dash underline. + * Taiwan calendar type. * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dashLine = "DashLine", + taiwan = "Taiwan", /** + * Japanese calendar type. * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dashLineHeavy = "DashLineHeavy", + japan = "Japan", /** + * Thai calendar type. * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dashLineLong = "DashLineLong", + thai = "Thai", /** + * Korean calendar type. * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dashLineLongHeavy = "DashLineLongHeavy", + korean = "Korean", /** - * An alternating dot-dash underline. + * Saka Era calendar type. * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dotDashLine = "DotDashLine", + sakaEra = "SakaEra", /** + * Transliterated English calendar type. * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dotDashLineHeavy = "DotDashLineHeavy", + translitEnglish = "TranslitEnglish", /** - * An alternating dot-dot-dash underline. + * Transliterated French calendar type. * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - twoDotDashLine = "TwoDotDashLine", + translitFrench = "TranslitFrench", /** + * Umm al-Qura calendar type. * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - twoDotDashLineHeavy = "TwoDotDashLineHeavy", + umalqura = "Umalqura", + } + /** + * Date storage formats for {@link Word.DatePickerContentControl}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ContentControlDateStorageFormat { /** - * A single wavy underline. + * Stores the date as text. * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - wave = "Wave", + text = "Text", /** + * Stores the date as a date object. * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - waveHeavy = "WaveHeavy", + date = "Date", /** + * Stores the date as a date-time object. * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - waveDouble = "WaveDouble", + dateTime = "DateTime", } /** - * Specifies the form of a break. + * Represents a frame. The `Frame` object is a member of the {@link Word.FrameCollection} object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum BreakType { + export class Frame 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; /** - * Page break at the insertion point. + * Returns a `BorderUniversalCollection` object that represents all the borders for the frame. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - page = "Page", + readonly borders: Word.BorderUniversalCollection; /** - * Warning: next has been deprecated. Use sectionNext instead. - * @deprecated Use sectionNext instead. + * Returns a `Range` object that represents the portion of the document that's contained within the frame. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - next = "Next", + readonly range: Word.Range; /** - * Section break on next page. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - sectionNext = "SectionNext", + readonly shading: Word.ShadingUniversal; /** - * New section without a corresponding page break. + * Specifies the height (in points) of the frame. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - sectionContinuous = "SectionContinuous", + height: number; /** - * Section break with the next section beginning on the next even-numbered page. If the section break falls on an even-numbered page, Word leaves the next odd-numbered page blank. + * Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - sectionEven = "SectionEven", + heightRule: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; /** - * Section break with the next section beginning on the next odd-numbered page. If the section break falls on an odd-numbered page, Word leaves the next even-numbered page blank. + * Specifies the horizontal distance between the frame and the surrounding text, in points. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - sectionOdd = "SectionOdd", + horizontalDistanceFromText: number; /** - * Line break. + * Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - line = "Line", - } - /** - * The insertion location types. - * - * @remarks - * [Api set: WordApi 1.1] - * - * To be used with an API call, such as `obj.insertSomething(newStuff, location);`. - * If the location is "Before" or "After", the new content will be outside of the modified object. - * If the location is "Start" or "End", the new content will be included as part of the modified object. - */ - enum InsertLocation { + horizontalPosition: number; /** - * Add content before the contents of the calling object. + * Specifies if the frame is locked. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - before = "Before", + lockAnchor: boolean; /** - * Add content after the contents of the calling object. + * Specifies the relative horizontal position of the frame. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - after = "After", + relativeHorizontalPosition: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; /** - * Prepend content to the contents of the calling object. + * Specifies the relative vertical position of the frame. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - start = "Start", + relativeVerticalPosition: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Append content to the contents of the calling object. + * Specifies if document text wraps around the frame. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - end = "End", + textWrap: boolean; /** - * Replace the contents of the current object. + * Specifies the vertical distance (in points) between the frame and the surrounding text. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - replace = "Replace", - } - /** - * @remarks - * [Api set: WordApi 1.1] - */ - enum Alignment { + verticalDistanceFromText: number; /** + * Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - mixed = "Mixed", + verticalPosition: number; /** - * Unknown alignment. + * Specifies the width (in points) of the frame. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - unknown = "Unknown", + width: number; /** - * Alignment to the left. + * Specifies the rule used to determine the width of the frame. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - left = "Left", + widthRule: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; /** - * Alignment to the center. - * @remarks - * [Api set: WordApi 1.1] + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - centered = "Centered", + set(properties: Interfaces.FrameUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Frame): void; /** - * Alignment to the right. + * Copies the frame to the Clipboard. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - right = "Right", + copy(): void; /** - * Fully justified alignment. + * Removes the frame from the document and places it on the Clipboard. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - justified = "Justified", - } - /** - * @remarks - * [Api set: WordApi 1.1] - */ - enum HeaderFooterType { + cut(): void; /** - * Returns the header or footer on all pages of a section, but excludes the first page or even pages if they are different. + * Deletes the frame. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - primary = "Primary", + delete(): void; /** - * Returns the header or footer on the first page of a section. + * Selects the frame. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - firstPage = "FirstPage", + select(): void; /** - * Returns all headers or footers on even-numbered pages of a section. - * @remarks - * [Api set: WordApi 1.1] + * 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. */ - evenPages = "EvenPages", + load(options?: Word.Interfaces.FrameLoadOptions): Word.Frame; + /** + * 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[]): Word.Frame; + /** + * 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; + }): Word.Frame; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.Frame; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.Frame; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Frame` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FrameData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.FrameData; } /** - * Represents the types of body objects. + * Represents the collection of {@link Word.Frame} objects. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum BodyType { - /** - * Unknown body type. - * @remarks - * [Api set: WordApi 1.3] - */ - unknown = "Unknown", + export class FrameCollection 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: Word.Frame[]; /** - * Main document body. + * Returns a `Frame` object that represents a new frame added to a range, selection, or document. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param range - The range where the frame will be added. + * @returns A `Frame` object that represents the new frame. */ - mainDoc = "MainDoc", + add(range: Word.Range): Word.Frame; /** - * Section body. + * Deletes the `FrameCollection` object. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - section = "Section", + delete(): void; /** - * Header body. + * Gets a `Frame` object by its index in the collection. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index - The location of a `Frame` object. */ - header = "Header", + getItem(index: number): Word.Frame; /** - * Footer body. - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - footer = "Footer", + load(options?: Word.Interfaces.FrameCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.FrameCollection; /** - * Table cell body. - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - tableCell = "TableCell", + load(propertyNames?: string | string[]): Word.FrameCollection; /** - * Footnote body. - * @remarks - * [Api set: WordApi 1.5] + * 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. */ - footnote = "Footnote", + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.FrameCollection; /** - * Endnote body. - * @remarks - * [Api set: WordApi 1.5] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - endnote = "Endnote", + track(): Word.FrameCollection; /** - * Note body e.g., endnote, footnote. - * @remarks - * [Api set: WordApi 1.5] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - noteItem = "NoteItem", + untrack(): Word.FrameCollection; /** - * Shape body. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.FrameCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FrameCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - shape = "Shape", + toJSON(): Word.Interfaces.FrameCollectionData; } /** - * This enum sets where the cursor (insertion point) in the document is after a selection. + * Represents a document library version. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum SelectionMode { + export class DocumentLibraryVersion 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 entire range is selected. + * Gets any optional comments associated with this version of the shared document. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - select = "Select", + readonly comments: string; /** - * The cursor is at the beginning of the selection (just before the start of the selected range). + * Gets the date and time at which this version of the shared document was last saved to the server. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - start = "Start", + readonly modified: any; /** - * The cursor is at the end of the selection (just after the end of the selected range). + * Gets the name of the user who last saved this version of the shared document to the server. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - end = "End", - } - /** - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - enum ImageFormat { + readonly modifiedBy: string; /** - * @remarks - * [Api set: WordApiDesktop 1.1] + * 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. */ - unsupported = "Unsupported", + load(options?: Word.Interfaces.DocumentLibraryVersionLoadOptions): Word.DocumentLibraryVersion; /** - * @remarks - * [Api set: WordApiDesktop 1.1] + * 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. */ - undefined = "Undefined", + load(propertyNames?: string | string[]): Word.DocumentLibraryVersion; /** - * @remarks - * [Api set: WordApiDesktop 1.1] + * 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. */ - bmp = "Bmp", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.DocumentLibraryVersion; /** - * @remarks - * [Api set: WordApiDesktop 1.1] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - jpeg = "Jpeg", + track(): Word.DocumentLibraryVersion; /** - * @remarks - * [Api set: WordApiDesktop 1.1] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - gif = "Gif", + untrack(): Word.DocumentLibraryVersion; /** - * @remarks - * [Api set: WordApiDesktop 1.1] + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.DocumentLibraryVersion` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentLibraryVersionData`) that contains shallow copies of any loaded child properties from the original object. */ - tiff = "Tiff", + toJSON(): Word.Interfaces.DocumentLibraryVersionData; + } + /** + * Represents the collection of {@link Word.DocumentLibraryVersion} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class DocumentLibraryVersionCollection 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: Word.DocumentLibraryVersion[]; /** + * Gets a `DocumentLibraryVersion` object by its index in the collection. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index - The location of a `DocumentLibraryVersion` object. */ - png = "Png", + getItem(index: number): Word.DocumentLibraryVersion; /** + * Returns whether the document library in which the active document is saved on the server is configured to create a backup copy, or version, each time the file is edited on the website. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - icon = "Icon", + isVersioningEnabled(): OfficeExtension.ClientResult; /** - * @remarks - * [Api set: WordApiDesktop 1.1] + * 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. */ - exif = "Exif", + load(options?: Word.Interfaces.DocumentLibraryVersionCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.DocumentLibraryVersionCollection; /** - * @remarks - * [Api set: WordApiDesktop 1.1] + * 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. */ - wmf = "Wmf", + load(propertyNames?: string | string[]): Word.DocumentLibraryVersionCollection; /** - * @remarks - * [Api set: WordApiDesktop 1.1] + * 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. */ - emf = "Emf", + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.DocumentLibraryVersionCollection; /** - * @remarks - * [Api set: WordApiDesktop 1.1] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - pict = "Pict", + track(): Word.DocumentLibraryVersionCollection; /** - * @remarks - * [Api set: WordApiDesktop 1.1] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - pdf = "Pdf", + untrack(): Word.DocumentLibraryVersionCollection; /** - * @remarks - * [Api set: WordApiDesktop 1.1] + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.DocumentLibraryVersionCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentLibraryVersionCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - svg = "Svg", + toJSON(): Word.Interfaces.DocumentLibraryVersionCollectionData; } /** - * Represents the location of a range. You can get range by calling getRange on different objects such as {@link Word.Paragraph} and {@link Word.ContentControl}. + * Represents the possible change tracking modes. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - enum RangeLocation { - /** - * The object's whole range. If the object is a paragraph content control or table content control, the EOP or Table characters after the content control are also included. - * @remarks - * [Api set: WordApi 1.3] - */ - whole = "Whole", + enum ChangeTrackingMode { /** - * The starting point of the object. For content control, it's the point after the opening tag. + * ChangeTracking is turned off. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - start = "Start", + off = "Off", /** - * The ending point of the object. For paragraph, it's the point before the EOP (end of paragraph). For content control, it's the point before the closing tag. + * ChangeTracking is turned on for everyone. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - end = "End", + trackAll = "TrackAll", /** - * For content control only. It's the point before the opening tag. + * Tracking is turned on for my changes only. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - before = "Before", + trackMineOnly = "TrackMineOnly", + } + /** + * Specify the current version or the original version of the text. + * + * @remarks + * [Api set: WordApi 1.4] + */ + enum ChangeTrackingVersion { /** - * The point after the object. If the object is a paragraph content control or table content control, it's the point after the EOP or Table characters. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - after = "After", + original = "Original", /** - * The range between 'Start' and 'End'. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] */ - content = "Content", + current = "Current", } /** + * Specify the track state when ChangeTracking is on. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - enum LocationRelation { + enum ChangeTrackingState { /** - * Indicates that this instance and the range are in different sub-documents. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - unrelated = "Unrelated", + unknown = "Unknown", /** - * Indicates that this instance and the range represent the same range. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - equal = "Equal", + normal = "Normal", /** - * Indicates that this instance contains the range and that it shares the same start character. The range doesn't share the same end character as this instance. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - containsStart = "ContainsStart", + added = "Added", /** - * Indicates that this instance contains the range and that it shares the same end character. The range doesn't share the same start character as this instance. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - containsEnd = "ContainsEnd", + deleted = "Deleted", + } + /** + * TrackedChange type. + * + * @remarks + * [Api set: WordApi 1.6] + */ + enum TrackedChangeType { /** - * Indicates that this instance contains the range, with the exception of the start and end character of this instance. + * No revision. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - contains = "Contains", + none = "None", /** - * Indicates that this instance is inside the range and that it shares the same start character. The range doesn't share the same end character as this instance. + * Add change. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - insideStart = "InsideStart", + added = "Added", /** - * Indicates that this instance is inside the range and that it shares the same end character. The range doesn't share the same start character as this instance. + * Delete change. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - insideEnd = "InsideEnd", + deleted = "Deleted", /** - * Indicates that this instance is inside the range. The range doesn't share the same start and end characters as this instance. + * Format change. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - inside = "Inside", + formatted = "Formatted", + } + /** + * Note item type + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum NoteItemType { /** - * Indicates that this instance occurs before, and is adjacent to, the range. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - adjacentBefore = "AdjacentBefore", + footnote = "Footnote", /** - * Indicates that this instance starts before the range and overlaps the range's first character. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - overlapsBefore = "OverlapsBefore", + endnote = "Endnote", + } + /** + * Provides information about the type of a raised event. + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum EventType { /** - * Indicates that this instance occurs before the range. + * ContentControlDeleted represents the event that the content control has been deleted. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - before = "Before", + contentControlDeleted = "ContentControlDeleted", /** - * Indicates that this instance occurs after, and is adjacent to, the range. + * ContentControlSelectionChanged represents the event that the selection in the content control has been changed. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - adjacentAfter = "AdjacentAfter", + contentControlSelectionChanged = "ContentControlSelectionChanged", /** - * Indicates that this instance starts inside the range and overlaps the range’s last character. + * ContentControlDataChanged represents the event that the data in the content control have been changed. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - overlapsAfter = "OverlapsAfter", + contentControlDataChanged = "ContentControlDataChanged", /** - * Indicates that this instance occurs after the range. + * ContentControlAdded represents the event a content control has been added to the document. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - after = "After", - } - /** - * @remarks - * [Api set: WordApi 1.3] - */ - enum BorderLocation { + contentControlAdded = "ContentControlAdded", /** + * Represents that one or more comments were deleted. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - top = "Top", + commentDeleted = "CommentDeleted", /** + * Represents that a comment was selected. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - left = "Left", + commentSelected = "CommentSelected", /** + * Represents that a comment was deselected. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bottom = "Bottom", + commentDeselected = "CommentDeselected", /** + * Represents that a comment or its reply was changed. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - right = "Right", + commentChanged = "CommentChanged", /** + * Represents that one or more new comments were added. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - insideHorizontal = "InsideHorizontal", + commentAdded = "CommentAdded", /** + * Represents that a content control has been entered. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - insideVertical = "InsideVertical", + contentControlEntered = "ContentControlEntered", /** + * Represents that a content control has been exited. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - inside = "Inside", + contentControlExited = "ContentControlExited", /** + * Represents that one or more new paragraphs were added. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - outside = "Outside", + paragraphAdded = "ParagraphAdded", /** + * Represents that one or more paragraphs were changed. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - all = "All", - } - /** - * @remarks - * [Api set: WordApi 1.3] - */ - enum CellPaddingLocation { + paragraphChanged = "ParagraphChanged", /** + * Represents that one or more paragraphs were deleted. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - top = "Top", + paragraphDeleted = "ParagraphDeleted", + /** + * Represents that an annotation was clicked (or selected with **Alt+Down**) in the document. + * @remarks + * [Api set: WordApi 1.7] + */ + annotationClicked = "AnnotationClicked", /** + * Represents that an annotation was hovered over in the document. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.7] */ - left = "Left", + annotationHovered = "AnnotationHovered", /** + * Represents that one or more annotations were added in the document. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.7] */ - bottom = "Bottom", + annotationInserted = "AnnotationInserted", + /** + * Represents that one or more annotations were deleted from the document. + * @remarks + * [Api set: WordApi 1.7] + */ + annotationRemoved = "AnnotationRemoved", /** + * Represents an action in the annotation pop-up. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.8] */ - right = "Right", + annotationPopupAction = "AnnotationPopupAction", } /** - * Represents the width of a style's border. + * An enum that specifies an event's source. It can be local or remote (through coauthoring). * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - enum BorderWidth { + enum EventSource { /** - * None width. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - none = "None", + local = "Local", /** - * 0.25 point. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - pt025 = "Pt025", + remote = "Remote", + } + /** + * Provides information about the content control that raised contentControlAdded event. + * + * @remarks + * [Api set: WordApi 1.5] + */ + export interface ContentControlAddedEventArgs { /** - * 0.50 point. + * The event type. See Word.EventType for details. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - pt050 = "Pt050", + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** - * 0.75 point. + * Gets the content control IDs. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - pt075 = "Pt075", + ids: number[]; /** - * 1.00 point. This is the default. + * The source of the event. It can be local or remote (through coauthoring). + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - pt100 = "Pt100", + source: Word.EventSource | "Local" | "Remote"; + } + /** + * Provides information about the content control that raised contentControlDataChanged event. + * + * @remarks + * [Api set: WordApi 1.5] + */ + export interface ContentControlDataChangedEventArgs { /** - * 1.50 points. + * The event type. See Word.EventType for details. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - pt150 = "Pt150", + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** - * 2.25 points. + * Gets the content control IDs. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - pt225 = "Pt225", + ids: number[]; /** - * 3.00 points. + * The source of the event. It can be local or remote (through coauthoring). + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - pt300 = "Pt300", + source: Word.EventSource | "Local" | "Remote"; + } + /** + * Provides information about the content control that raised contentControlDeleted event. + * + * @remarks + * [Api set: WordApi 1.5] + */ + export interface ContentControlDeletedEventArgs { /** - * 4.50 points. + * The event type. See Word.EventType for details. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - pt450 = "Pt450", + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** - * 6.00 points. + * Gets the content control IDs. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - pt600 = "Pt600", + ids: number[]; /** - * Mixed width. + * The source of the event. It can be local or remote (through coauthoring). + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - mixed = "Mixed", + source: Word.EventSource | "Local" | "Remote"; } /** + * Provides information about the content control that raised contentControlEntered event. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - enum BorderType { + export interface ContentControlEnteredEventArgs { /** + * The event type. See Word.EventType for details. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - mixed = "Mixed", + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** + * Gets the content control IDs. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - none = "None", + ids: number[]; /** + * The source of the event. It can be local or remote (through coauthoring). + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - single = "Single", + source: Word.EventSource | "Local" | "Remote"; + } + /** + * Provides information about the content control that raised contentControlExited event. + * + * @remarks + * [Api set: WordApi 1.5] + */ + export interface ContentControlExitedEventArgs { /** + * The event type. See Word.EventType for details. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - double = "Double", + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** + * Gets the content control IDs. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - dotted = "Dotted", + ids: number[]; /** + * The source of the event. It can be local or remote (through coauthoring). + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - dashed = "Dashed", + source: Word.EventSource | "Local" | "Remote"; + } + /** + * Represents a dropped capital letter in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class DropCap 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 distance (in points) between the dropped capital letter and the paragraph text. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dotDashed = "DotDashed", + readonly distanceFromText: number; /** + * Gets the name of the font for the dropped capital letter. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dot2Dashed = "Dot2Dashed", + readonly fontName: string; /** + * Gets the height (in lines) of the dropped capital letter. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - triple = "Triple", + readonly linesToDrop: number; /** + * Gets the position of the dropped capital letter. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - thinThickSmall = "ThinThickSmall", + readonly position: Word.DropPosition | "None" | "Normal" | "Margin"; /** + * Removes the dropped capital letter formatting. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - thickThinSmall = "ThickThinSmall", + clear(): void; /** + * Formats the first character in the specified paragraph as a dropped capital letter. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - thinThickThinSmall = "ThinThickThinSmall", + enable(): void; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - thinThickMed = "ThinThickMed", + load(options?: Word.Interfaces.DropCapLoadOptions): Word.DropCap; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - thickThinMed = "ThickThinMed", + load(propertyNames?: string | string[]): Word.DropCap; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - thinThickThinMed = "ThinThickThinMed", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.DropCap; /** - * @remarks - * [Api set: WordApi 1.3] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - thinThickLarge = "ThinThickLarge", + track(): Word.DropCap; /** - * @remarks - * [Api set: WordApi 1.3] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - thickThinLarge = "ThickThinLarge", + untrack(): Word.DropCap; /** - * @remarks - * [Api set: WordApi 1.3] + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.DropCap` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DropCapData`) that contains shallow copies of any loaded child properties from the original object. */ - thinThickThinLarge = "ThinThickThinLarge", + toJSON(): Word.Interfaces.DropCapData; + } + /** + * Provides information about the content control that raised contentControlSelectionChanged event. + * + * @remarks + * [Api set: WordApi 1.5] + */ + export interface ContentControlSelectionChangedEventArgs { /** + * The event type. See Word.EventType for details. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - wave = "Wave", + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** + * Gets the content control IDs. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - doubleWave = "DoubleWave", + ids: number[]; /** + * The source of the event. It can be local or remote (through coauthoring). + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - dashedSmall = "DashedSmall", + source: Word.EventSource | "Local" | "Remote"; + } + /** + * Provides information about the paragraphs that raised the paragraphAdded event. + * + * @remarks + * [Api set: WordApi 1.6] + */ + export interface ParagraphAddedEventArgs { /** + * The source of the event. It can be local or remote (through coauthoring). + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - dashDotStroked = "DashDotStroked", + source: Word.EventSource | "Local" | "Remote"; /** + * The event type. See Word.EventType for details. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - threeDEmboss = "ThreeDEmboss", + type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** + * Gets the unique IDs of the involved paragraphs. IDs are in standard 8-4-4-4-12 GUID format without curly braces and differ across sessions and coauthors. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - threeDEngrave = "ThreeDEngrave", + uniqueLocalIds: string[]; } /** + * Provides information about the paragraphs that raised the paragraphChanged event. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - enum VerticalAlignment { + export interface ParagraphChangedEventArgs { /** + * The source of the event. It can be local or remote (through coauthoring). + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - mixed = "Mixed", + source: Word.EventSource | "Local" | "Remote"; /** + * The event type. See Word.EventType for details. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - top = "Top", + type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** + * Gets the unique IDs of the involved paragraphs. IDs are in standard 8-4-4-4-12 GUID format without curly braces and differ across sessions and coauthors. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - center = "Center", + uniqueLocalIds: string[]; + } + /** + * Provides information about the paragraphs that raised the paragraphDeleted event. + * + * @remarks + * [Api set: WordApi 1.6] + */ + export interface ParagraphDeletedEventArgs { /** + * The source of the event. It can be local or remote (through coauthoring). + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - bottom = "Bottom", + source: Word.EventSource | "Local" | "Remote"; + /** + * The event type. See Word.EventType for details. + * + * @remarks + * [Api set: WordApi 1.6] + */ + type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + /** + * Gets the unique IDs of the involved paragraphs. IDs are in standard 8-4-4-4-12 GUID format without curly braces and differ across sessions and coauthors. + * + * @remarks + * [Api set: WordApi 1.6] + */ + uniqueLocalIds: string[]; } /** - * Represents the type of baseline alignment. + * Provides information about the comments that raised the comment event. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum BaselineAlignment { - /** - * Represents top baseline alignment. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - top = "Top", + export interface CommentEventArgs { /** - * Represents center baseline alignment. + * Represents how the comment changed event is triggered. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - center = "Center", + changeType: Word.CommentChangeType | "none" | "edited" | "resolved" | "reopened" | "replyAdded" | "replyDeleted" | "replyEdited"; /** - * Represents baseline alignment. + * Gets the CommentDetail array which contains the IDs and reply IDs of the involved comments. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - baseline = "Baseline", + commentDetails: Word.CommentDetail[]; /** - * Represents Far East 50% baseline alignment. + * The source of the event. It can be local or remote (through coauthoring). + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - farEast50 = "FarEast50", + source: Word.EventSource | "Local" | "Remote"; /** - * Represents automatic baseline alignment. + * The event type. See Word.EventType for details. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - auto = "Auto", + type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; } /** + * A structure for the ID and reply IDs of this comment. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum ListLevelType { - /** - * @remarks - * [Api set: WordApi 1.3] - */ - bullet = "Bullet", + export interface CommentDetail { /** + * Represents the ID of this comment. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - number = "Number", + id: string; /** + * Represents the IDs of the replies to this comment. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - picture = "Picture", + replyIds: string[]; } /** + * Represents how the comments in the event were changed. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum ListBullet { + enum CommentChangeType { /** + * No comment changed event is triggered. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - custom = "Custom", + none = "none", /** + * A comment was edited. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - solid = "Solid", + edited = "edited", /** + * A comment was resolved. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - hollow = "Hollow", + resolved = "resolved", /** + * A comment was reopened. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - square = "Square", + reopened = "reopened", /** + * A reply was added. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - diamonds = "Diamonds", + replyAdded = "replyAdded", /** + * A reply was deleted. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - arrow = "Arrow", + replyDeleted = "replyDeleted", /** + * A reply was edited. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - checkmark = "Checkmark", + replyEdited = "replyEdited", } /** + * Specifies supported content control types and subtypes. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - enum ListNumbering { + enum ContentControlType { /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - none = "None", + unknown = "Unknown", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - arabic = "Arabic", + richTextInline = "RichTextInline", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - upperRoman = "UpperRoman", + richTextParagraphs = "RichTextParagraphs", /** + * Contains a whole cell. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - lowerRoman = "LowerRoman", + richTextTableCell = "RichTextTableCell", /** + * Contains a whole row. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - upperLetter = "UpperLetter", + richTextTableRow = "RichTextTableRow", /** + * Contains a whole table. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - lowerLetter = "LowerLetter", - } - /** - * Represents the built-in style in a Word document. - * - * @remarks - * [Api set: WordApi 1.3] - * - * Important: This enum was renamed from `Style` to `BuiltInStyleName` in WordApi 1.5. - */ - enum BuiltInStyleName { + richTextTable = "RichTextTable", /** - * Mixed styles or other style not in this list. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - other = "Other", + plainTextInline = "PlainTextInline", /** - * Reset character and paragraph style to default. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - normal = "Normal", + plainTextParagraph = "PlainTextParagraph", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - heading1 = "Heading1", + picture = "Picture", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - heading2 = "Heading2", + buildingBlockGallery = "BuildingBlockGallery", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - heading3 = "Heading3", + checkBox = "CheckBox", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - heading4 = "Heading4", + comboBox = "ComboBox", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - heading5 = "Heading5", + dropDownList = "DropDownList", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - heading6 = "Heading6", + datePicker = "DatePicker", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - heading7 = "Heading7", + repeatingSection = "RepeatingSection", /** + * Identifies a rich text content control. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - heading8 = "Heading8", + richText = "RichText", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - heading9 = "Heading9", + plainText = "PlainText", /** - * Table-of-content level 1. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - toc1 = "Toc1", + group = "Group", + } + /** + * ContentControl appearance. + * + * @remarks + * [Api set: WordApi 1.1] + * + * Content control appearance options are BoundingBox, Tags, or Hidden. + */ + enum ContentControlAppearance { /** - * Table-of-content level 2. + * Represents a content control shown as a shaded rectangle or bounding box (with optional title). * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - toc2 = "Toc2", + boundingBox = "BoundingBox", /** - * Table-of-content level 3. + * Represents a content control shown as start and end markers. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - toc3 = "Toc3", + tags = "Tags", /** - * Table-of-content level 4. + * Represents a content control that isn't shown. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - toc4 = "Toc4", + hidden = "Hidden", + } + /** + * Content control level types. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ContentControlLevel { /** - * Table-of-content level 5. + * Represents an inline content control. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toc5 = "Toc5", + inline = "Inline", /** - * Table-of-content level 6. + * Represents a paragraph-level content control. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toc6 = "Toc6", + paragraph = "Paragraph", /** - * Table-of-content level 7. + * Represents a row-level content control. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toc7 = "Toc7", + row = "Row", /** - * Table-of-content level 8. + * Represents a cell-level content control. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toc8 = "Toc8", + cell = "Cell", + } + /** + * Represents the state of the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ContentControlState { /** - * Table-of-content level 9. + * Error state. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toc9 = "Toc9", + error = "Error", /** + * Warning state. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - footnoteText = "FootnoteText", + warning = "Warning", + } + /** + * The supported styles for underline format. + * + * @remarks + * [Api set: WordApi 1.1] + */ + enum UnderlineType { /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - header = "Header", + mixed = "Mixed", /** + * No underline. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - footer = "Footer", + none = "None", /** + * Warning: hidden has been deprecated. + * @deprecated Hidden is no longer supported. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - caption = "Caption", + hidden = "Hidden", /** + * Warning: dotLine has been deprecated. + * @deprecated DotLine is no longer supported. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - footnoteReference = "FootnoteReference", + dotLine = "DotLine", /** + * A single underline. This is the default value. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - endnoteReference = "EndnoteReference", + single = "Single", /** + * Only underline individual words. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - endnoteText = "EndnoteText", + word = "Word", /** + * A double underline. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - title = "Title", + double = "Double", /** + * A single thick underline. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - subtitle = "Subtitle", + thick = "Thick", /** + * A dotted underline. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - hyperlink = "Hyperlink", + dotted = "Dotted", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - strong = "Strong", + dottedHeavy = "DottedHeavy", /** + * A single dash underline. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - emphasis = "Emphasis", + dashLine = "DashLine", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - noSpacing = "NoSpacing", + dashLineHeavy = "DashLineHeavy", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - listParagraph = "ListParagraph", + dashLineLong = "DashLineLong", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - quote = "Quote", + dashLineLongHeavy = "DashLineLongHeavy", /** + * An alternating dot-dash underline. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - intenseQuote = "IntenseQuote", + dotDashLine = "DotDashLine", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - subtleEmphasis = "SubtleEmphasis", + dotDashLineHeavy = "DotDashLineHeavy", /** + * An alternating dot-dot-dash underline. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - intenseEmphasis = "IntenseEmphasis", + twoDotDashLine = "TwoDotDashLine", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - subtleReference = "SubtleReference", + twoDotDashLineHeavy = "TwoDotDashLineHeavy", /** + * A single wavy underline. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - intenseReference = "IntenseReference", + wave = "Wave", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - bookTitle = "BookTitle", + waveHeavy = "WaveHeavy", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - bibliography = "Bibliography", + waveDouble = "WaveDouble", + } + /** + * Specifies the form of a break. + * + * @remarks + * [Api set: WordApi 1.1] + */ + enum BreakType { /** - * Table-of-content heading. + * Page break at the insertion point. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - tocHeading = "TocHeading", + page = "Page", /** + * Warning: next has been deprecated. Use sectionNext instead. + * @deprecated Use sectionNext instead. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - tableGrid = "TableGrid", + next = "Next", /** + * Section break on next page. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - plainTable1 = "PlainTable1", + sectionNext = "SectionNext", /** + * New section without a corresponding page break. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - plainTable2 = "PlainTable2", + sectionContinuous = "SectionContinuous", /** + * Section break with the next section beginning on the next even-numbered page. If the section break falls on an even-numbered page, Word leaves the next odd-numbered page blank. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - plainTable3 = "PlainTable3", + sectionEven = "SectionEven", /** + * Section break with the next section beginning on the next odd-numbered page. If the section break falls on an odd-numbered page, Word leaves the next even-numbered page blank. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - plainTable4 = "PlainTable4", + sectionOdd = "SectionOdd", /** + * Line break. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - plainTable5 = "PlainTable5", + line = "Line", + } + /** + * The insertion location types. + * + * @remarks + * [Api set: WordApi 1.1] + * + * To be used with an API call, such as `obj.insertSomething(newStuff, location);`. + * If the location is "Before" or "After", the new content will be outside of the modified object. + * If the location is "Start" or "End", the new content will be included as part of the modified object. + */ + enum InsertLocation { /** + * Add content before the contents of the calling object. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - tableGridLight = "TableGridLight", + before = "Before", /** + * Add content after the contents of the calling object. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable1Light = "GridTable1Light", + after = "After", /** + * Prepend content to the contents of the calling object. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable1Light_Accent1 = "GridTable1Light_Accent1", + start = "Start", /** + * Append content to the contents of the calling object. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable1Light_Accent2 = "GridTable1Light_Accent2", + end = "End", /** + * Replace the contents of the current object. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable1Light_Accent3 = "GridTable1Light_Accent3", + replace = "Replace", + } + /** + * @remarks + * [Api set: WordApi 1.1] + */ + enum Alignment { /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable1Light_Accent4 = "GridTable1Light_Accent4", + mixed = "Mixed", /** + * Unknown alignment. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable1Light_Accent5 = "GridTable1Light_Accent5", + unknown = "Unknown", /** + * Alignment to the left. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable1Light_Accent6 = "GridTable1Light_Accent6", + left = "Left", /** + * Alignment to the center. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable2 = "GridTable2", + centered = "Centered", /** + * Alignment to the right. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable2_Accent1 = "GridTable2_Accent1", + right = "Right", /** + * Fully justified alignment. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable2_Accent2 = "GridTable2_Accent2", + justified = "Justified", + } + /** + * @remarks + * [Api set: WordApi 1.1] + */ + enum HeaderFooterType { /** + * Returns the header or footer on all pages of a section, but excludes the first page or even pages if they are different. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable2_Accent3 = "GridTable2_Accent3", + primary = "Primary", /** + * Returns the header or footer on the first page of a section. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable2_Accent4 = "GridTable2_Accent4", + firstPage = "FirstPage", /** + * Returns all headers or footers on even-numbered pages of a section. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable2_Accent5 = "GridTable2_Accent5", + evenPages = "EvenPages", + } + /** + * Represents the types of body objects. + * + * @remarks + * [Api set: WordApi 1.3] + */ + enum BodyType { /** + * Unknown body type. * @remarks * [Api set: WordApi 1.3] */ - gridTable2_Accent6 = "GridTable2_Accent6", + unknown = "Unknown", /** + * Main document body. * @remarks * [Api set: WordApi 1.3] */ - gridTable3 = "GridTable3", + mainDoc = "MainDoc", /** + * Section body. * @remarks * [Api set: WordApi 1.3] */ - gridTable3_Accent1 = "GridTable3_Accent1", + section = "Section", /** + * Header body. * @remarks * [Api set: WordApi 1.3] */ - gridTable3_Accent2 = "GridTable3_Accent2", + header = "Header", /** + * Footer body. * @remarks * [Api set: WordApi 1.3] */ - gridTable3_Accent3 = "GridTable3_Accent3", + footer = "Footer", /** + * Table cell body. * @remarks * [Api set: WordApi 1.3] */ - gridTable3_Accent4 = "GridTable3_Accent4", + tableCell = "TableCell", /** + * Footnote body. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - gridTable3_Accent5 = "GridTable3_Accent5", + footnote = "Footnote", /** + * Endnote body. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - gridTable3_Accent6 = "GridTable3_Accent6", + endnote = "Endnote", /** + * Note body e.g., endnote, footnote. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - gridTable4 = "GridTable4", + noteItem = "NoteItem", /** + * Shape body. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - gridTable4_Accent1 = "GridTable4_Accent1", + shape = "Shape", + } + /** + * This enum sets where the cursor (insertion point) in the document is after a selection. + * + * @remarks + * [Api set: WordApi 1.1] + */ + enum SelectionMode { /** + * The entire range is selected. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable4_Accent2 = "GridTable4_Accent2", + select = "Select", /** + * The cursor is at the beginning of the selection (just before the start of the selected range). * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable4_Accent3 = "GridTable4_Accent3", + start = "Start", /** + * The cursor is at the end of the selection (just after the end of the selected range). * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable4_Accent4 = "GridTable4_Accent4", + end = "End", + } + /** + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + enum ImageFormat { /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - gridTable4_Accent5 = "GridTable4_Accent5", + unsupported = "Unsupported", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - gridTable4_Accent6 = "GridTable4_Accent6", + undefined = "Undefined", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - gridTable5Dark = "GridTable5Dark", + bmp = "Bmp", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - gridTable5Dark_Accent1 = "GridTable5Dark_Accent1", + jpeg = "Jpeg", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - gridTable5Dark_Accent2 = "GridTable5Dark_Accent2", + gif = "Gif", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - gridTable5Dark_Accent3 = "GridTable5Dark_Accent3", + tiff = "Tiff", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - gridTable5Dark_Accent4 = "GridTable5Dark_Accent4", + png = "Png", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - gridTable5Dark_Accent5 = "GridTable5Dark_Accent5", + icon = "Icon", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - gridTable5Dark_Accent6 = "GridTable5Dark_Accent6", + exif = "Exif", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - gridTable6Colorful = "GridTable6Colorful", + wmf = "Wmf", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - gridTable6Colorful_Accent1 = "GridTable6Colorful_Accent1", + emf = "Emf", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - gridTable6Colorful_Accent2 = "GridTable6Colorful_Accent2", + pict = "Pict", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - gridTable6Colorful_Accent3 = "GridTable6Colorful_Accent3", + pdf = "Pdf", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - gridTable6Colorful_Accent4 = "GridTable6Colorful_Accent4", + svg = "Svg", + } + /** + * Represents the location of a range. You can get range by calling getRange on different objects such as {@link Word.Paragraph} and {@link Word.ContentControl}. + * + * @remarks + * [Api set: WordApi 1.3] + */ + enum RangeLocation { /** + * The object's whole range. If the object is a paragraph content control or table content control, the EOP or Table characters after the content control are also included. * @remarks * [Api set: WordApi 1.3] */ - gridTable6Colorful_Accent5 = "GridTable6Colorful_Accent5", + whole = "Whole", /** + * The starting point of the object. For content control, it's the point after the opening tag. * @remarks * [Api set: WordApi 1.3] */ - gridTable6Colorful_Accent6 = "GridTable6Colorful_Accent6", + start = "Start", /** + * The ending point of the object. For paragraph, it's the point before the EOP (end of paragraph). For content control, it's the point before the closing tag. * @remarks * [Api set: WordApi 1.3] */ - gridTable7Colorful = "GridTable7Colorful", + end = "End", /** + * For content control only. It's the point before the opening tag. * @remarks * [Api set: WordApi 1.3] */ - gridTable7Colorful_Accent1 = "GridTable7Colorful_Accent1", + before = "Before", /** + * The point after the object. If the object is a paragraph content control or table content control, it's the point after the EOP or Table characters. * @remarks * [Api set: WordApi 1.3] */ - gridTable7Colorful_Accent2 = "GridTable7Colorful_Accent2", + after = "After", /** + * The range between 'Start' and 'End'. * @remarks * [Api set: WordApi 1.3] */ - gridTable7Colorful_Accent3 = "GridTable7Colorful_Accent3", + content = "Content", + } + /** + * @remarks + * [Api set: WordApi 1.3] + */ + enum LocationRelation { /** + * Indicates that this instance and the range are in different sub-documents. * @remarks * [Api set: WordApi 1.3] */ - gridTable7Colorful_Accent4 = "GridTable7Colorful_Accent4", + unrelated = "Unrelated", /** + * Indicates that this instance and the range represent the same range. * @remarks * [Api set: WordApi 1.3] */ - gridTable7Colorful_Accent5 = "GridTable7Colorful_Accent5", + equal = "Equal", /** + * Indicates that this instance contains the range and that it shares the same start character. The range doesn't share the same end character as this instance. * @remarks * [Api set: WordApi 1.3] */ - gridTable7Colorful_Accent6 = "GridTable7Colorful_Accent6", + containsStart = "ContainsStart", /** + * Indicates that this instance contains the range and that it shares the same end character. The range doesn't share the same start character as this instance. * @remarks * [Api set: WordApi 1.3] */ - listTable1Light = "ListTable1Light", + containsEnd = "ContainsEnd", /** + * Indicates that this instance contains the range, with the exception of the start and end character of this instance. * @remarks * [Api set: WordApi 1.3] */ - listTable1Light_Accent1 = "ListTable1Light_Accent1", + contains = "Contains", /** + * Indicates that this instance is inside the range and that it shares the same start character. The range doesn't share the same end character as this instance. * @remarks * [Api set: WordApi 1.3] */ - listTable1Light_Accent2 = "ListTable1Light_Accent2", + insideStart = "InsideStart", /** + * Indicates that this instance is inside the range and that it shares the same end character. The range doesn't share the same start character as this instance. * @remarks * [Api set: WordApi 1.3] */ - listTable1Light_Accent3 = "ListTable1Light_Accent3", + insideEnd = "InsideEnd", /** + * Indicates that this instance is inside the range. The range doesn't share the same start and end characters as this instance. * @remarks * [Api set: WordApi 1.3] */ - listTable1Light_Accent4 = "ListTable1Light_Accent4", + inside = "Inside", /** + * Indicates that this instance occurs before, and is adjacent to, the range. * @remarks * [Api set: WordApi 1.3] */ - listTable1Light_Accent5 = "ListTable1Light_Accent5", + adjacentBefore = "AdjacentBefore", /** + * Indicates that this instance starts before the range and overlaps the range's first character. * @remarks * [Api set: WordApi 1.3] */ - listTable1Light_Accent6 = "ListTable1Light_Accent6", + overlapsBefore = "OverlapsBefore", /** + * Indicates that this instance occurs before the range. * @remarks * [Api set: WordApi 1.3] */ - listTable2 = "ListTable2", + before = "Before", /** + * Indicates that this instance occurs after, and is adjacent to, the range. * @remarks * [Api set: WordApi 1.3] */ - listTable2_Accent1 = "ListTable2_Accent1", + adjacentAfter = "AdjacentAfter", /** + * Indicates that this instance starts inside the range and overlaps the range’s last character. * @remarks * [Api set: WordApi 1.3] */ - listTable2_Accent2 = "ListTable2_Accent2", + overlapsAfter = "OverlapsAfter", /** + * Indicates that this instance occurs after the range. * @remarks * [Api set: WordApi 1.3] */ - listTable2_Accent3 = "ListTable2_Accent3", + after = "After", + } + /** + * @remarks + * [Api set: WordApi 1.3] + */ + enum BorderLocation { /** * @remarks * [Api set: WordApi 1.3] */ - listTable2_Accent4 = "ListTable2_Accent4", + top = "Top", /** * @remarks * [Api set: WordApi 1.3] */ - listTable2_Accent5 = "ListTable2_Accent5", + left = "Left", /** * @remarks * [Api set: WordApi 1.3] */ - listTable2_Accent6 = "ListTable2_Accent6", + bottom = "Bottom", /** * @remarks * [Api set: WordApi 1.3] */ - listTable3 = "ListTable3", + right = "Right", /** * @remarks * [Api set: WordApi 1.3] */ - listTable3_Accent1 = "ListTable3_Accent1", + insideHorizontal = "InsideHorizontal", /** * @remarks * [Api set: WordApi 1.3] */ - listTable3_Accent2 = "ListTable3_Accent2", + insideVertical = "InsideVertical", /** * @remarks * [Api set: WordApi 1.3] */ - listTable3_Accent3 = "ListTable3_Accent3", + inside = "Inside", /** * @remarks * [Api set: WordApi 1.3] */ - listTable3_Accent4 = "ListTable3_Accent4", + outside = "Outside", /** * @remarks * [Api set: WordApi 1.3] */ - listTable3_Accent5 = "ListTable3_Accent5", + all = "All", + } + /** + * @remarks + * [Api set: WordApi 1.3] + */ + enum CellPaddingLocation { /** * @remarks * [Api set: WordApi 1.3] */ - listTable3_Accent6 = "ListTable3_Accent6", + top = "Top", /** * @remarks * [Api set: WordApi 1.3] */ - listTable4 = "ListTable4", + left = "Left", /** * @remarks * [Api set: WordApi 1.3] */ - listTable4_Accent1 = "ListTable4_Accent1", + bottom = "Bottom", /** * @remarks * [Api set: WordApi 1.3] */ - listTable4_Accent2 = "ListTable4_Accent2", + right = "Right", + } + /** + * Represents the width of a style's border. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + enum BorderWidth { /** + * None width. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - listTable4_Accent3 = "ListTable4_Accent3", + none = "None", + /** + * 0.25 point. + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + pt025 = "Pt025", + /** + * 0.50 point. + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + pt050 = "Pt050", + /** + * 0.75 point. + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + pt075 = "Pt075", + /** + * 1.00 point. This is the default. + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + pt100 = "Pt100", + /** + * 1.50 points. + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + pt150 = "Pt150", + /** + * 2.25 points. + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + pt225 = "Pt225", + /** + * 3.00 points. + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + pt300 = "Pt300", + /** + * 4.50 points. + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + pt450 = "Pt450", + /** + * 6.00 points. + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + pt600 = "Pt600", + /** + * Mixed width. + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + mixed = "Mixed", + } + /** + * @remarks + * [Api set: WordApi 1.3] + */ + enum BorderType { /** * @remarks * [Api set: WordApi 1.3] */ - listTable4_Accent4 = "ListTable4_Accent4", + mixed = "Mixed", /** * @remarks * [Api set: WordApi 1.3] */ - listTable4_Accent5 = "ListTable4_Accent5", + none = "None", /** * @remarks * [Api set: WordApi 1.3] */ - listTable4_Accent6 = "ListTable4_Accent6", + single = "Single", /** * @remarks * [Api set: WordApi 1.3] */ - listTable5Dark = "ListTable5Dark", + double = "Double", /** * @remarks * [Api set: WordApi 1.3] */ - listTable5Dark_Accent1 = "ListTable5Dark_Accent1", + dotted = "Dotted", /** * @remarks * [Api set: WordApi 1.3] */ - listTable5Dark_Accent2 = "ListTable5Dark_Accent2", + dashed = "Dashed", /** * @remarks * [Api set: WordApi 1.3] */ - listTable5Dark_Accent3 = "ListTable5Dark_Accent3", + dotDashed = "DotDashed", /** * @remarks * [Api set: WordApi 1.3] */ - listTable5Dark_Accent4 = "ListTable5Dark_Accent4", + dot2Dashed = "Dot2Dashed", /** * @remarks * [Api set: WordApi 1.3] */ - listTable5Dark_Accent5 = "ListTable5Dark_Accent5", + triple = "Triple", /** * @remarks * [Api set: WordApi 1.3] */ - listTable5Dark_Accent6 = "ListTable5Dark_Accent6", + thinThickSmall = "ThinThickSmall", /** * @remarks * [Api set: WordApi 1.3] */ - listTable6Colorful = "ListTable6Colorful", + thickThinSmall = "ThickThinSmall", /** * @remarks * [Api set: WordApi 1.3] */ - listTable6Colorful_Accent1 = "ListTable6Colorful_Accent1", + thinThickThinSmall = "ThinThickThinSmall", /** * @remarks * [Api set: WordApi 1.3] */ - listTable6Colorful_Accent2 = "ListTable6Colorful_Accent2", + thinThickMed = "ThinThickMed", /** * @remarks * [Api set: WordApi 1.3] */ - listTable6Colorful_Accent3 = "ListTable6Colorful_Accent3", + thickThinMed = "ThickThinMed", /** * @remarks * [Api set: WordApi 1.3] */ - listTable6Colorful_Accent4 = "ListTable6Colorful_Accent4", + thinThickThinMed = "ThinThickThinMed", /** * @remarks * [Api set: WordApi 1.3] */ - listTable6Colorful_Accent5 = "ListTable6Colorful_Accent5", + thinThickLarge = "ThinThickLarge", /** * @remarks * [Api set: WordApi 1.3] */ - listTable6Colorful_Accent6 = "ListTable6Colorful_Accent6", + thickThinLarge = "ThickThinLarge", /** * @remarks * [Api set: WordApi 1.3] */ - listTable7Colorful = "ListTable7Colorful", + thinThickThinLarge = "ThinThickThinLarge", /** * @remarks * [Api set: WordApi 1.3] */ - listTable7Colorful_Accent1 = "ListTable7Colorful_Accent1", + wave = "Wave", /** * @remarks * [Api set: WordApi 1.3] */ - listTable7Colorful_Accent2 = "ListTable7Colorful_Accent2", + doubleWave = "DoubleWave", /** * @remarks * [Api set: WordApi 1.3] */ - listTable7Colorful_Accent3 = "ListTable7Colorful_Accent3", + dashedSmall = "DashedSmall", /** * @remarks * [Api set: WordApi 1.3] */ - listTable7Colorful_Accent4 = "ListTable7Colorful_Accent4", + dashDotStroked = "DashDotStroked", /** * @remarks * [Api set: WordApi 1.3] */ - listTable7Colorful_Accent5 = "ListTable7Colorful_Accent5", + threeDEmboss = "ThreeDEmboss", /** * @remarks * [Api set: WordApi 1.3] */ - listTable7Colorful_Accent6 = "ListTable7Colorful_Accent6", + threeDEngrave = "ThreeDEngrave", } /** * @remarks * [Api set: WordApi 1.3] */ - enum DocumentPropertyType { + enum VerticalAlignment { /** * @remarks * [Api set: WordApi 1.3] */ - string = "String", + mixed = "Mixed", /** * @remarks * [Api set: WordApi 1.3] */ - number = "Number", + top = "Top", /** * @remarks * [Api set: WordApi 1.3] */ - date = "Date", + center = "Center", /** * @remarks * [Api set: WordApi 1.3] */ - boolean = "Boolean", + bottom = "Bottom", } /** - * Represents the type of style. + * Represents the type of baseline alignment. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum StyleType { + enum BaselineAlignment { /** - * Represents that the style is a character style. + * Represents top baseline alignment. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - character = "Character", + top = "Top", /** - * Represents that the style is a list style. Currently supported on desktop. + * Represents center baseline alignment. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - list = "List", + center = "Center", /** - * Represents that the style is a paragraph style. + * Represents baseline alignment. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - paragraph = "Paragraph", + baseline = "Baseline", /** - * Represents that the style is a table style. + * Represents Far East 50% baseline alignment. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - table = "Table", + farEast50 = "FarEast50", + /** + * Represents automatic baseline alignment. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + auto = "Auto", } /** - * Represents the outline levels. - * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - enum OutlineLevel { + enum ListLevelType { /** - * Represents outline level 1. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - outlineLevel1 = "OutlineLevel1", + bullet = "Bullet", /** - * Represents outline level 2. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - outlineLevel2 = "OutlineLevel2", + number = "Number", /** - * Represents outline level 3. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - outlineLevel3 = "OutlineLevel3", + picture = "Picture", + } + /** + * @remarks + * [Api set: WordApi 1.3] + */ + enum ListBullet { /** - * Represents outline level 4. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - outlineLevel4 = "OutlineLevel4", + custom = "Custom", /** - * Represents outline level 5. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - outlineLevel5 = "OutlineLevel5", + solid = "Solid", /** - * Represents outline level 6. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - outlineLevel6 = "OutlineLevel6", + hollow = "Hollow", /** - * Represents outline level 7. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - outlineLevel7 = "OutlineLevel7", + square = "Square", /** - * Represents outline level 8. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - outlineLevel8 = "OutlineLevel8", + diamonds = "Diamonds", /** - * Represents outline level 9. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - outlineLevel9 = "OutlineLevel9", + arrow = "Arrow", /** - * Represents outline level body text, not an outline level. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - outlineLevelBodyText = "OutlineLevelBodyText", + checkmark = "Checkmark", } /** - * Specifies the close behavior for `Document.close`. - * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - enum CloseBehavior { + enum ListNumbering { /** - * Saves the changes before closing the document. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - save = "Save", + none = "None", /** - * Discard the possible changes when closing the document. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - skipSave = "SkipSave", - } - /** - * Specifies the save behavior for `Document.save`. - * - * @remarks - * [Api set: WordApi 1.1] - */ - enum SaveBehavior { + arabic = "Arabic", /** - * Saves the document without prompting the user. If it's a new document, - it will be saved with the default name or specified name in the default location. * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - save = "Save", + upperRoman = "UpperRoman", /** - * Displays the "Save As" dialog to the user if the document hasn't been saved. - Won't take effect if the document was previously saved. * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - prompt = "Prompt", + lowerRoman = "LowerRoman", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + upperLetter = "UpperLetter", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + lowerLetter = "LowerLetter", } /** - * Represents the type of Field. + * Represents the built-in style in a Word document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] + * + * Important: This enum was renamed from `Style` to `BuiltInStyleName` in WordApi 1.5. */ - enum FieldType { + enum BuiltInStyleName { /** - * Represents that the field type is Add-in. + * Mixed styles or other style not in this list. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - addin = "Addin", + other = "Other", /** - * Represents that the field type is AddressBlock. + * Reset character and paragraph style to default. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - addressBlock = "AddressBlock", + normal = "Normal", /** - * Represents that the field type is Advance. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - advance = "Advance", + heading1 = "Heading1", /** - * Represents that the field type is Ask. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - ask = "Ask", + heading2 = "Heading2", /** - * Represents that the field type is Author. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - author = "Author", + heading3 = "Heading3", /** - * Represents that the field type is AutoText. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - autoText = "AutoText", + heading4 = "Heading4", /** - * Represents that the field type is AutoTextList. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - autoTextList = "AutoTextList", + heading5 = "Heading5", /** - * Represents that the field type is Barcode. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - barCode = "BarCode", + heading6 = "Heading6", /** - * Represents that the field type is Bibliography. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - bibliography = "Bibliography", + heading7 = "Heading7", /** - * Represents that the field type is BidiOutline. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - bidiOutline = "BidiOutline", + heading8 = "Heading8", /** - * Represents that the field type is Citation. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - citation = "Citation", + heading9 = "Heading9", /** - * Represents that the field type is Comments. + * Table-of-content level 1. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - comments = "Comments", + toc1 = "Toc1", /** - * Represents that the field type is Compare. + * Table-of-content level 2. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - compare = "Compare", + toc2 = "Toc2", /** - * Represents that the field type is CreateDate. + * Table-of-content level 3. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - createDate = "CreateDate", + toc3 = "Toc3", /** - * Represents that the field type is Data. + * Table-of-content level 4. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - data = "Data", + toc4 = "Toc4", /** - * Represents that the field type is Database. + * Table-of-content level 5. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - database = "Database", + toc5 = "Toc5", /** - * Represents that the field type is Date. + * Table-of-content level 6. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - date = "Date", + toc6 = "Toc6", /** - * Represents that the field type is DisplayBarcode. + * Table-of-content level 7. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - displayBarcode = "DisplayBarcode", + toc7 = "Toc7", /** - * Represents that the field type is DocumentProperty + * Table-of-content level 8. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - docProperty = "DocProperty", + toc8 = "Toc8", /** - * Represents that the field type is DocumentVariable. + * Table-of-content level 9. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - docVariable = "DocVariable", + toc9 = "Toc9", /** - * Represents that the field type is EditTime. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - editTime = "EditTime", + footnoteText = "FootnoteText", /** - * Represents that the field type is Embedded. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - embedded = "Embedded", + header = "Header", /** - * Represents that the field type is Equation. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - eq = "EQ", + footer = "Footer", /** - * Represents that the field type is Expression. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - expression = "Expression", + caption = "Caption", /** - * Represents that the field type is FileName. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - fileName = "FileName", + footnoteReference = "FootnoteReference", /** - * Represents that the field type is FileSize. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - fileSize = "FileSize", + endnoteReference = "EndnoteReference", /** - * Represents that the field type is FillIn. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - fillIn = "FillIn", + endnoteText = "EndnoteText", /** - * Represents that the field type is FormCheckbox. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - formCheckbox = "FormCheckbox", + title = "Title", /** - * Represents that the field type is FormDropdown. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - formDropdown = "FormDropdown", + subtitle = "Subtitle", /** - * Represents that the field type is FormText. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - formText = "FormText", + hyperlink = "Hyperlink", /** - * Represents that the field type is GotoButton. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - gotoButton = "GotoButton", + strong = "Strong", /** - * Represents that the field type is GreetingLine. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - greetingLine = "GreetingLine", + emphasis = "Emphasis", /** - * Represents that the field type is Hyperlink. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - hyperlink = "Hyperlink", + noSpacing = "NoSpacing", /** - * Represents that the field type is If. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - if = "If", + listParagraph = "ListParagraph", /** - * Represents that the field type is Import. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - import = "Import", + quote = "Quote", /** - * Represents that the field type is Include. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - include = "Include", + intenseQuote = "IntenseQuote", /** - * Represents that the field type is IncludePicture. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - includePicture = "IncludePicture", + subtleEmphasis = "SubtleEmphasis", /** - * Represents that the field type is IncludeText. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - includeText = "IncludeText", + intenseEmphasis = "IntenseEmphasis", /** - * Represents that the field type is Index. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - index = "Index", + subtleReference = "SubtleReference", /** - * Represents that the field type is Information. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - info = "Info", + intenseReference = "IntenseReference", /** - * Represents that the field type is Keywords. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - keywords = "Keywords", + bookTitle = "BookTitle", /** - * Represents that the field type is LastSavedBy. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - lastSavedBy = "LastSavedBy", + bibliography = "Bibliography", /** - * Represents that the field type is Link. + * Table-of-content heading. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - link = "Link", + tocHeading = "TocHeading", /** - * Represents that the field type is ListNumber. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - listNum = "ListNum", + tableGrid = "TableGrid", /** - * Represents that the field type is MacroButton. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - macroButton = "MacroButton", + plainTable1 = "PlainTable1", /** - * Represents that the field type is MergeBarcode. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - mergeBarcode = "MergeBarcode", + plainTable2 = "PlainTable2", /** - * Represents that the field type is MergeField. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - mergeField = "MergeField", + plainTable3 = "PlainTable3", /** - * Represents that the field type is MergeRecord. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - mergeRec = "MergeRec", + plainTable4 = "PlainTable4", /** - * Represents that the field type is MergeSequence. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - mergeSeq = "MergeSeq", + plainTable5 = "PlainTable5", /** - * Represents that the field type is Next. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - next = "Next", + tableGridLight = "TableGridLight", /** - * Represents that the field type is NextIf. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - nextIf = "NextIf", + gridTable1Light = "GridTable1Light", /** - * Represents that the field type is NoteReference. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - noteRef = "NoteRef", + gridTable1Light_Accent1 = "GridTable1Light_Accent1", /** - * Represents that the field type is NumberOfCharacters. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - numChars = "NumChars", + gridTable1Light_Accent2 = "GridTable1Light_Accent2", /** - * Represents that the field type is NumberOfPages. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - numPages = "NumPages", + gridTable1Light_Accent3 = "GridTable1Light_Accent3", /** - * Represents that the field type is NumberOfWords. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - numWords = "NumWords", + gridTable1Light_Accent4 = "GridTable1Light_Accent4", /** - * Represents that the field type is ActiveXControl. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - ocx = "OCX", + gridTable1Light_Accent5 = "GridTable1Light_Accent5", /** - * Represents that the field type is Page. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - page = "Page", + gridTable1Light_Accent6 = "GridTable1Light_Accent6", /** - * Represents that the field type is PageReference. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - pageRef = "PageRef", + gridTable2 = "GridTable2", /** - * Represents that the field type is Print. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - print = "Print", + gridTable2_Accent1 = "GridTable2_Accent1", /** - * Represents that the field type is PrintDate. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - printDate = "PrintDate", + gridTable2_Accent2 = "GridTable2_Accent2", /** - * Represents that the field type is Private. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - private = "Private", + gridTable2_Accent3 = "GridTable2_Accent3", /** - * Represents that the field type is Quote. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - quote = "Quote", + gridTable2_Accent4 = "GridTable2_Accent4", /** - * Represents that the field type is ReferencedDocument. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - rd = "RD", + gridTable2_Accent5 = "GridTable2_Accent5", /** - * Represents that the field type is Reference. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - ref = "Ref", + gridTable2_Accent6 = "GridTable2_Accent6", /** - * Represents that the field type is RevisionNumber. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - revNum = "RevNum", + gridTable3 = "GridTable3", /** - * Represents that the field type is SaveDate. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - saveDate = "SaveDate", + gridTable3_Accent1 = "GridTable3_Accent1", /** - * Represents that the field type is Section. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - section = "Section", + gridTable3_Accent2 = "GridTable3_Accent2", /** - * Represents that the field type is SectionPages. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - sectionPages = "SectionPages", + gridTable3_Accent3 = "GridTable3_Accent3", /** - * Represents that the field type is Sequence. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - seq = "Seq", + gridTable3_Accent4 = "GridTable3_Accent4", /** - * Represents that the field type is Set. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - set = "Set", + gridTable3_Accent5 = "GridTable3_Accent5", /** - * Represents that the field type is Shape. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - shape = "Shape", + gridTable3_Accent6 = "GridTable3_Accent6", /** - * Represents that the field type is SkipIf. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - skipIf = "SkipIf", + gridTable4 = "GridTable4", /** - * Represents that the field type is StyleReference. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - styleRef = "StyleRef", + gridTable4_Accent1 = "GridTable4_Accent1", /** - * Represents that the field type is Subject. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - subject = "Subject", + gridTable4_Accent2 = "GridTable4_Accent2", /** - * Represents that the field type is Subscriber. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - subscriber = "Subscriber", + gridTable4_Accent3 = "GridTable4_Accent3", /** - * Represents that the field type is Symbol. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - symbol = "Symbol", + gridTable4_Accent4 = "GridTable4_Accent4", /** - * Represents that the field type is TableOfAuthoritiesEntry. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - ta = "TA", + gridTable4_Accent5 = "GridTable4_Accent5", /** - * Represents that the field type is TableOfContentsEntry. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - tc = "TC", + gridTable4_Accent6 = "GridTable4_Accent6", /** - * Represents that the field type is Template. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - template = "Template", + gridTable5Dark = "GridTable5Dark", /** - * Represents that the field type is Time. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - time = "Time", + gridTable5Dark_Accent1 = "GridTable5Dark_Accent1", /** - * Represents that the field type is Title. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - title = "Title", + gridTable5Dark_Accent2 = "GridTable5Dark_Accent2", /** - * Represents that the field type is TableOfAuthorities. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - toa = "TOA", + gridTable5Dark_Accent3 = "GridTable5Dark_Accent3", /** - * Represents that the field type is TableOfContents. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - toc = "TOC", + gridTable5Dark_Accent4 = "GridTable5Dark_Accent4", /** - * Represents that the field type is UserAddress. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - userAddress = "UserAddress", + gridTable5Dark_Accent5 = "GridTable5Dark_Accent5", /** - * Represents that the field type is UserInitials. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - userInitials = "UserInitials", + gridTable5Dark_Accent6 = "GridTable5Dark_Accent6", /** - * Represents that the field type is UserName. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - userName = "UserName", + gridTable6Colorful = "GridTable6Colorful", /** - * Represents that the field type is IndexEntry. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - xe = "XE", + gridTable6Colorful_Accent1 = "GridTable6Colorful_Accent1", /** - * Represents that the field type is Empty. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - empty = "Empty", + gridTable6Colorful_Accent2 = "GridTable6Colorful_Accent2", /** - * Represents the field types not supported by the Office JavaScript API. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - others = "Others", + gridTable6Colorful_Accent3 = "GridTable6Colorful_Accent3", /** - * Represents that the field type is Undefined. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - undefined = "Undefined", - } - /** - * Represents the kind of field. Indicates how the field works in relation to updating. - * - * @remarks - * [Api set: WordApi 1.5] - */ - enum FieldKind { + gridTable6Colorful_Accent4 = "GridTable6Colorful_Accent4", /** - * Represents that the field is invalid. For example, a pair of field characters with nothing inside. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - none = "None", + gridTable6Colorful_Accent5 = "GridTable6Colorful_Accent5", /** - * Represents that the field is automatically updated each time it's displayed or each time the page is reformatted, but which can also be manually updated. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - hot = "Hot", + gridTable6Colorful_Accent6 = "GridTable6Colorful_Accent6", /** - * Represents that the field is automatically updated when the source changes or the field can be manually updated. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - warm = "Warm", + gridTable7Colorful = "GridTable7Colorful", /** - * Represents that the field doesn't have a result. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - cold = "Cold", - } - /** - * Represents the character inserted after the list item mark. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - enum TrailingCharacter { + gridTable7Colorful_Accent1 = "GridTable7Colorful_Accent1", /** - * A tab is inserted. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - trailingTab = "TrailingTab", + gridTable7Colorful_Accent2 = "GridTable7Colorful_Accent2", /** - * A space is inserted. Default. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - trailingSpace = "TrailingSpace", + gridTable7Colorful_Accent3 = "GridTable7Colorful_Accent3", /** - * No character is inserted. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - trailingNone = "TrailingNone", - } - /** - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - enum ListBuiltInNumberStyle { + gridTable7Colorful_Accent4 = "GridTable7Colorful_Accent4", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - none = "None", + gridTable7Colorful_Accent5 = "GridTable7Colorful_Accent5", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - arabic = "Arabic", + gridTable7Colorful_Accent6 = "GridTable7Colorful_Accent6", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - upperRoman = "UpperRoman", + listTable1Light = "ListTable1Light", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - lowerRoman = "LowerRoman", + listTable1Light_Accent1 = "ListTable1Light_Accent1", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - upperLetter = "UpperLetter", + listTable1Light_Accent2 = "ListTable1Light_Accent2", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - lowerLetter = "LowerLetter", + listTable1Light_Accent3 = "ListTable1Light_Accent3", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - ordinal = "Ordinal", + listTable1Light_Accent4 = "ListTable1Light_Accent4", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - cardinalText = "CardinalText", + listTable1Light_Accent5 = "ListTable1Light_Accent5", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - ordinalText = "OrdinalText", + listTable1Light_Accent6 = "ListTable1Light_Accent6", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - kanji = "Kanji", + listTable2 = "ListTable2", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - kanjiDigit = "KanjiDigit", + listTable2_Accent1 = "ListTable2_Accent1", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - aiueoHalfWidth = "AiueoHalfWidth", + listTable2_Accent2 = "ListTable2_Accent2", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - irohaHalfWidth = "IrohaHalfWidth", + listTable2_Accent3 = "ListTable2_Accent3", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - arabicFullWidth = "ArabicFullWidth", + listTable2_Accent4 = "ListTable2_Accent4", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - kanjiTraditional = "KanjiTraditional", + listTable2_Accent5 = "ListTable2_Accent5", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - kanjiTraditional2 = "KanjiTraditional2", + listTable2_Accent6 = "ListTable2_Accent6", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - numberInCircle = "NumberInCircle", + listTable3 = "ListTable3", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - aiueo = "Aiueo", + listTable3_Accent1 = "ListTable3_Accent1", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - iroha = "Iroha", + listTable3_Accent2 = "ListTable3_Accent2", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - arabicLZ = "ArabicLZ", + listTable3_Accent3 = "ListTable3_Accent3", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - bullet = "Bullet", + listTable3_Accent4 = "ListTable3_Accent4", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - ganada = "Ganada", + listTable3_Accent5 = "ListTable3_Accent5", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - chosung = "Chosung", + listTable3_Accent6 = "ListTable3_Accent6", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - gbnum1 = "GBNum1", + listTable4 = "ListTable4", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - gbnum2 = "GBNum2", + listTable4_Accent1 = "ListTable4_Accent1", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - gbnum3 = "GBNum3", + listTable4_Accent2 = "ListTable4_Accent2", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - gbnum4 = "GBNum4", + listTable4_Accent3 = "ListTable4_Accent3", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - zodiac1 = "Zodiac1", + listTable4_Accent4 = "ListTable4_Accent4", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - zodiac2 = "Zodiac2", + listTable4_Accent5 = "ListTable4_Accent5", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - zodiac3 = "Zodiac3", + listTable4_Accent6 = "ListTable4_Accent6", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - tradChinNum1 = "TradChinNum1", + listTable5Dark = "ListTable5Dark", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - tradChinNum2 = "TradChinNum2", + listTable5Dark_Accent1 = "ListTable5Dark_Accent1", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - tradChinNum3 = "TradChinNum3", + listTable5Dark_Accent2 = "ListTable5Dark_Accent2", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - tradChinNum4 = "TradChinNum4", + listTable5Dark_Accent3 = "ListTable5Dark_Accent3", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - simpChinNum1 = "SimpChinNum1", + listTable5Dark_Accent4 = "ListTable5Dark_Accent4", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - simpChinNum2 = "SimpChinNum2", + listTable5Dark_Accent5 = "ListTable5Dark_Accent5", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - simpChinNum3 = "SimpChinNum3", + listTable5Dark_Accent6 = "ListTable5Dark_Accent6", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - simpChinNum4 = "SimpChinNum4", + listTable6Colorful = "ListTable6Colorful", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - hanjaRead = "HanjaRead", + listTable6Colorful_Accent1 = "ListTable6Colorful_Accent1", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - hanjaReadDigit = "HanjaReadDigit", + listTable6Colorful_Accent2 = "ListTable6Colorful_Accent2", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - hangul = "Hangul", + listTable6Colorful_Accent3 = "ListTable6Colorful_Accent3", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - hanja = "Hanja", + listTable6Colorful_Accent4 = "ListTable6Colorful_Accent4", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - hebrew1 = "Hebrew1", + listTable6Colorful_Accent5 = "ListTable6Colorful_Accent5", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - arabic1 = "Arabic1", + listTable6Colorful_Accent6 = "ListTable6Colorful_Accent6", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - hebrew2 = "Hebrew2", + listTable7Colorful = "ListTable7Colorful", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - arabic2 = "Arabic2", + listTable7Colorful_Accent1 = "ListTable7Colorful_Accent1", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - hindiLetter1 = "HindiLetter1", + listTable7Colorful_Accent2 = "ListTable7Colorful_Accent2", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - hindiLetter2 = "HindiLetter2", + listTable7Colorful_Accent3 = "ListTable7Colorful_Accent3", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - hindiArabic = "HindiArabic", + listTable7Colorful_Accent4 = "ListTable7Colorful_Accent4", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - hindiCardinalText = "HindiCardinalText", + listTable7Colorful_Accent5 = "ListTable7Colorful_Accent5", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - thaiLetter = "ThaiLetter", + listTable7Colorful_Accent6 = "ListTable7Colorful_Accent6", + } + /** + * @remarks + * [Api set: WordApi 1.3] + */ + enum DocumentPropertyType { /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - thaiArabic = "ThaiArabic", + string = "String", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - thaiCardinalText = "ThaiCardinalText", + number = "Number", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - vietCardinalText = "VietCardinalText", + date = "Date", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - lowercaseRussian = "LowercaseRussian", + boolean = "Boolean", + } + /** + * Represents the type of style. + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum StyleType { /** + * Represents that the style is a character style. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - uppercaseRussian = "UppercaseRussian", + character = "Character", /** + * Represents that the style is a list style. Currently supported on desktop. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - lowercaseGreek = "LowercaseGreek", + list = "List", /** + * Represents that the style is a paragraph style. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - uppercaseGreek = "UppercaseGreek", + paragraph = "Paragraph", /** + * Represents that the style is a table style. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - arabicLZ2 = "ArabicLZ2", + table = "Table", + } + /** + * Represents the outline levels. + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum OutlineLevel { /** + * Represents outline level 1. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - arabicLZ3 = "ArabicLZ3", + outlineLevel1 = "OutlineLevel1", /** + * Represents outline level 2. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - arabicLZ4 = "ArabicLZ4", + outlineLevel2 = "OutlineLevel2", /** + * Represents outline level 3. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - lowercaseTurkish = "LowercaseTurkish", + outlineLevel3 = "OutlineLevel3", /** + * Represents outline level 4. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - uppercaseTurkish = "UppercaseTurkish", + outlineLevel4 = "OutlineLevel4", /** + * Represents outline level 5. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - lowercaseBulgarian = "LowercaseBulgarian", + outlineLevel5 = "OutlineLevel5", /** + * Represents outline level 6. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - uppercaseBulgarian = "UppercaseBulgarian", + outlineLevel6 = "OutlineLevel6", /** + * Represents outline level 7. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - pictureBullet = "PictureBullet", + outlineLevel7 = "OutlineLevel7", /** + * Represents outline level 8. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - legal = "Legal", + outlineLevel8 = "OutlineLevel8", /** + * Represents outline level 9. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - legalLZ = "LegalLZ", + outlineLevel9 = "OutlineLevel9", + /** + * Represents outline level body text, not an outline level. + * @remarks + * [Api set: WordApi 1.5] + */ + outlineLevelBodyText = "OutlineLevelBodyText", } /** - * Represents the shading texture. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. + * Specifies the close behavior for `Document.close`. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - enum ShadingTextureType { + enum CloseBehavior { /** - * Represents dark diagonal-down texture. + * Saves the changes before closing the document. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - darkDiagonalDown = "DarkDiagonalDown", + save = "Save", /** - * Represents dark diagonal-up texture. + * Discard the possible changes when closing the document. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - darkDiagonalUp = "DarkDiagonalUp", + skipSave = "SkipSave", + } + /** + * Specifies the save behavior for `Document.save`. + * + * @remarks + * [Api set: WordApi 1.1] + */ + enum SaveBehavior { /** - * Represents dark horizontal-cross texture. + * Saves the document without prompting the user. If it's a new document, + it will be saved with the default name or specified name in the default location. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.1] */ - darkGrid = "DarkGrid", + save = "Save", /** - * Represents dark horizontal texture. + * Displays the "Save As" dialog to the user if the document hasn't been saved. + Won't take effect if the document was previously saved. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.1] */ - darkHorizontal = "DarkHorizontal", + prompt = "Prompt", + } + /** + * Represents the type of Field. + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum FieldType { /** - * Represents dark diagonal-cross texture. + * Represents that the field type is Add-in. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - darkTrellis = "DarkTrellis", + addin = "Addin", /** - * Represents dark vertical texture. + * Represents that the field type is AddressBlock. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - darkVertical = "DarkVertical", + addressBlock = "AddressBlock", /** - * Represents light diagonal-down texture. + * Represents that the field type is Advance. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - lightDiagonalDown = "LightDiagonalDown", + advance = "Advance", /** - * Represents light diagonal-up texture. + * Represents that the field type is Ask. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - lightDiagonalUp = "LightDiagonalUp", + ask = "Ask", /** - * Represents light horizontal-cross texture. + * Represents that the field type is Author. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - lightGrid = "LightGrid", + author = "Author", /** - * Represents light horizontal texture. + * Represents that the field type is AutoText. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - lightHorizontal = "LightHorizontal", + autoText = "AutoText", /** - * Represents light diagonal-cross texture. + * Represents that the field type is AutoTextList. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - lightTrellis = "LightTrellis", + autoTextList = "AutoTextList", /** - * Represents light vertical texture. + * Represents that the field type is Barcode. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - lightVertical = "LightVertical", + barCode = "BarCode", /** - * Represents that there's no texture. + * Represents that the field type is Bibliography. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - none = "None", + bibliography = "Bibliography", /** - * Represents 10 percent texture. + * Represents that the field type is BidiOutline. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent10 = "Percent10", + bidiOutline = "BidiOutline", /** - * Represents 12.5 percent texture. + * Represents that the field type is Citation. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent12Pt5 = "Percent12Pt5", + citation = "Citation", /** - * Represents 15 percent texture. + * Represents that the field type is Comments. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent15 = "Percent15", + comments = "Comments", /** - * Represents 20 percent texture. + * Represents that the field type is Compare. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent20 = "Percent20", + compare = "Compare", /** - * Represents 25 percent texture. + * Represents that the field type is CreateDate. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent25 = "Percent25", + createDate = "CreateDate", /** - * Represents 30 percent texture. + * Represents that the field type is Data. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent30 = "Percent30", + data = "Data", /** - * Represents 35 percent texture. + * Represents that the field type is Database. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent35 = "Percent35", + database = "Database", /** - * Represents 37.5 percent texture. + * Represents that the field type is Date. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent37Pt5 = "Percent37Pt5", + date = "Date", /** - * Represents 40 percent texture. + * Represents that the field type is DisplayBarcode. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent40 = "Percent40", + displayBarcode = "DisplayBarcode", /** - * Represents 45 percent texture. + * Represents that the field type is DocumentProperty * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent45 = "Percent45", + docProperty = "DocProperty", /** - * Represents 5 percent texture. + * Represents that the field type is DocumentVariable. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent5 = "Percent5", + docVariable = "DocVariable", /** - * Represents 50 percent texture. + * Represents that the field type is EditTime. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent50 = "Percent50", + editTime = "EditTime", /** - * Represents 55 percent texture. + * Represents that the field type is Embedded. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent55 = "Percent55", + embedded = "Embedded", /** - * Represents 60 percent texture. + * Represents that the field type is Equation. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent60 = "Percent60", + eq = "EQ", /** - * Represents 62.5 percent texture. + * Represents that the field type is Expression. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent62Pt5 = "Percent62Pt5", + expression = "Expression", /** - * Represents 65 percent texture. + * Represents that the field type is FileName. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent65 = "Percent65", + fileName = "FileName", /** - * Represents 70 percent texture. + * Represents that the field type is FileSize. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent70 = "Percent70", + fileSize = "FileSize", /** - * Represents 75 percent texture. + * Represents that the field type is FillIn. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent75 = "Percent75", + fillIn = "FillIn", /** - * Represents 80 percent texture. + * Represents that the field type is FormCheckbox. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent80 = "Percent80", + formCheckbox = "FormCheckbox", /** - * Represents 85 percent texture. + * Represents that the field type is FormDropdown. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent85 = "Percent85", + formDropdown = "FormDropdown", /** - * Represents 87.5 percent texture. + * Represents that the field type is FormText. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent87Pt5 = "Percent87Pt5", + formText = "FormText", /** - * Represents 90 percent texture. + * Represents that the field type is GotoButton. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent90 = "Percent90", + gotoButton = "GotoButton", /** - * Represents 95 percent texture. + * Represents that the field type is GreetingLine. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent95 = "Percent95", + greetingLine = "GreetingLine", /** - * Represents solid texture. + * Represents that the field type is Hyperlink. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - solid = "Solid", - } - /** - * Specifies the target document for displaying document comparison differences. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - enum CompareTarget { + hyperlink = "Hyperlink", /** - * Places comparison differences in the current document. + * Represents that the field type is If. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - compareTargetCurrent = "CompareTargetCurrent", + if = "If", /** - * Places comparison differences in the target document. + * Represents that the field type is Import. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - compareTargetSelected = "CompareTargetSelected", + import = "Import", /** - * Places comparison differences in a new document. + * Represents that the field type is Include. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - compareTargetNew = "CompareTargetNew", - } - /** - * Specifies how to handle any conflicts, that is, when imported styles have the same name as existing styles in the current document. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - enum ImportedStylesConflictBehavior { + include = "Include", /** - * Ignore conflicting imported styles and keep the existing version of those styles in the current document. + * Represents that the field type is IncludePicture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - ignore = "Ignore", + includePicture = "IncludePicture", /** - * Overwrite the existing styles in the current document. + * Represents that the field type is IncludeText. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - overwrite = "Overwrite", + includeText = "IncludeText", /** - * Rename conflicting imported styles so that both versions are kept in the current document. For example, if MyStyle already exists in the document, then the imported version could be added as MyStyle1. + * Represents that the field type is Index. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - createNew = "CreateNew", - } - /** - * Represents the shape type. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - enum ShapeType { + index = "Index", /** - * Unsupported shape type. + * Represents that the field type is Information. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - unsupported = "Unsupported", + info = "Info", /** - * Text box shape. + * Represents that the field type is Keywords. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - textBox = "TextBox", + keywords = "Keywords", /** - * Geometric shape. + * Represents that the field type is LastSavedBy. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - geometricShape = "GeometricShape", + lastSavedBy = "LastSavedBy", /** - * Group shape. + * Represents that the field type is Link. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - group = "Group", + link = "Link", /** - * Picture shape. + * Represents that the field type is ListNumber. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - picture = "Picture", + listNum = "ListNum", /** - * Canvas shape. + * Represents that the field type is MacroButton. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - canvas = "Canvas", - } - /** - * Represents what the horizontal position of a shape is relative to. - For more information about margins, see {@link https://support.microsoft.com/office/c95c1ea1-70b1-4dde-a1da-f5aa2042c829 | Change the margins in your Word document}. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - enum RelativeHorizontalPosition { + macroButton = "MacroButton", /** - * Relative to margin. + * Represents that the field type is MergeBarcode. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - margin = "Margin", + mergeBarcode = "MergeBarcode", /** - * Relative to page. + * Represents that the field type is MergeField. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - page = "Page", + mergeField = "MergeField", /** - * Relative to column. + * Represents that the field type is MergeRecord. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - column = "Column", + mergeRec = "MergeRec", /** - * Relative to character. + * Represents that the field type is MergeSequence. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - character = "Character", + mergeSeq = "MergeSeq", /** - * Relative to left margin. + * Represents that the field type is Next. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - leftMargin = "LeftMargin", + next = "Next", /** - * Relative to right margin. + * Represents that the field type is NextIf. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - rightMargin = "RightMargin", + nextIf = "NextIf", /** - * Relative to inside margin. + * Represents that the field type is NoteReference. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - insideMargin = "InsideMargin", + noteRef = "NoteRef", /** - * Relative to outside margin. + * Represents that the field type is NumberOfCharacters. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - outsideMargin = "OutsideMargin", - } - /** - * Represents what the vertical position of a shape is relative to. - For more information about margins, see {@link https://support.microsoft.com/office/c95c1ea1-70b1-4dde-a1da-f5aa2042c829 | Change the margins in your Word document}. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - enum RelativeVerticalPosition { + numChars = "NumChars", /** - * Relative to margin. + * Represents that the field type is NumberOfPages. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - margin = "Margin", + numPages = "NumPages", /** - * Relative to page. + * Represents that the field type is NumberOfWords. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - page = "Page", + numWords = "NumWords", /** - * Relative to paragraph. + * Represents that the field type is ActiveXControl. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - paragraph = "Paragraph", + ocx = "OCX", /** - * Relative to line. + * Represents that the field type is Page. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - line = "Line", + page = "Page", /** - * Relative to top margin. + * Represents that the field type is PageReference. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - topMargin = "TopMargin", + pageRef = "PageRef", /** - * Relative to bottom margin. + * Represents that the field type is Print. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - bottomMargin = "BottomMargin", + print = "Print", /** - * Relative to inside margin. + * Represents that the field type is PrintDate. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - insideMargin = "InsideMargin", + printDate = "PrintDate", /** - * Relative to outside margin. + * Represents that the field type is Private. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - outsideMargin = "OutsideMargin", - } - /** - * Represents what the horizontal or vertical size of a shape is relative to. - For more information about margins, see {@link https://support.microsoft.com/office/c95c1ea1-70b1-4dde-a1da-f5aa2042c829 | Change the margins in your Word document}. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - enum RelativeSize { + private = "Private", /** - * Relative to margin. + * Represents that the field type is Quote. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - margin = "Margin", + quote = "Quote", /** - * Relative to page. + * Represents that the field type is ReferencedDocument. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - page = "Page", + rd = "RD", /** - * Relative to top margin. + * Represents that the field type is Reference. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - topMargin = "TopMargin", + ref = "Ref", /** - * Relative to bottom margin. + * Represents that the field type is RevisionNumber. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - bottomMargin = "BottomMargin", + revNum = "RevNum", /** - * Relative to inside margin. + * Represents that the field type is SaveDate. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - insideMargin = "InsideMargin", + saveDate = "SaveDate", /** - * Relative to outside margin. + * Represents that the field type is Section. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - outsideMargin = "OutsideMargin", - } - /** - * Specifies the shape type for a `GeometricShape` object. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - enum GeometricShapeType { + section = "Section", /** - * Line inverse geometric shape. + * Represents that the field type is SectionPages. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - lineInverse = "LineInverse", + sectionPages = "SectionPages", /** - * Triangle geometric shape. + * Represents that the field type is Sequence. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - triangle = "Triangle", + seq = "Seq", /** - * Right triangle geometric shape. + * Represents that the field type is Set. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - rightTriangle = "RightTriangle", + set = "Set", /** - * Rectangle geometric shape. + * Represents that the field type is Shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - rectangle = "Rectangle", + shape = "Shape", /** - * Diamond geometric shape. + * Represents that the field type is SkipIf. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - diamond = "Diamond", + skipIf = "SkipIf", /** - * Parallelogram geometric shape. + * Represents that the field type is StyleReference. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - parallelogram = "Parallelogram", + styleRef = "StyleRef", /** - * Trapezoid geometric shape. + * Represents that the field type is Subject. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - trapezoid = "Trapezoid", + subject = "Subject", /** - * Non-isosceles trapezoid geometric shape. + * Represents that the field type is Subscriber. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - nonIsoscelesTrapezoid = "NonIsoscelesTrapezoid", + subscriber = "Subscriber", /** - * Pentagon geometric shape. + * Represents that the field type is Symbol. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - pentagon = "Pentagon", + symbol = "Symbol", /** - * Hexagon geometric shape. + * Represents that the field type is TableOfAuthoritiesEntry. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - hexagon = "Hexagon", + ta = "TA", /** - * Heptagon geometric shape. + * Represents that the field type is TableOfContentsEntry. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - heptagon = "Heptagon", + tc = "TC", /** - * Octagon geometric shape. + * Represents that the field type is Template. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - octagon = "Octagon", + template = "Template", /** - * Decagon geometric shape. + * Represents that the field type is Time. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - decagon = "Decagon", + time = "Time", /** - * Dodecagon geometric shape. + * Represents that the field type is Title. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - dodecagon = "Dodecagon", + title = "Title", /** - * Star 4-point geometric shape. + * Represents that the field type is TableOfAuthorities. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - star4 = "Star4", + toa = "TOA", /** - * Star 5-point geometric shape. + * Represents that the field type is TableOfContents. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - star5 = "Star5", + toc = "TOC", /** - * Star 6-point geometric shape. + * Represents that the field type is UserAddress. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - star6 = "Star6", + userAddress = "UserAddress", /** - * Star 7-point geometric shape. + * Represents that the field type is UserInitials. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - star7 = "Star7", + userInitials = "UserInitials", /** - * Star 8-point geometric shape. + * Represents that the field type is UserName. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - star8 = "Star8", + userName = "UserName", /** - * Star 10-point geometric shape. + * Represents that the field type is IndexEntry. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - star10 = "Star10", + xe = "XE", /** - * Star 12-point geometric shape. + * Represents that the field type is Empty. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - star12 = "Star12", + empty = "Empty", /** - * Star 16-point geometric shape. + * Represents the field types not supported by the Office JavaScript API. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - star16 = "Star16", + others = "Others", /** - * Star 24-point geometric shape. + * Represents that the field type is Undefined. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - star24 = "Star24", + undefined = "Undefined", + } + /** + * Represents the kind of field. Indicates how the field works in relation to updating. + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum FieldKind { /** - * Star 32-point geometric shape. + * Represents that the field is invalid. For example, a pair of field characters with nothing inside. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - star32 = "Star32", + none = "None", /** - * Round rectangle geometric shape. + * Represents that the field is automatically updated each time it's displayed or each time the page is reformatted, but which can also be manually updated. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - roundRectangle = "RoundRectangle", + hot = "Hot", /** - * Round one rectangle geometric shape. + * Represents that the field is automatically updated when the source changes or the field can be manually updated. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - round1Rectangle = "Round1Rectangle", + warm = "Warm", /** - * Round two same rectangle geometric shape. + * Represents that the field doesn't have a result. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - round2SameRectangle = "Round2SameRectangle", + cold = "Cold", + } + /** + * Represents the character inserted after the list item mark. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + enum TrailingCharacter { /** - * Round two diagonal rectangle geometric shape. + * A tab is inserted. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - round2DiagonalRectangle = "Round2DiagonalRectangle", + trailingTab = "TrailingTab", /** - * Snip round rectangle geometric shape. + * A space is inserted. Default. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - snipRoundRectangle = "SnipRoundRectangle", + trailingSpace = "TrailingSpace", /** - * Snip one rectangle geometric shape. + * No character is inserted. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - snip1Rectangle = "Snip1Rectangle", + trailingNone = "TrailingNone", + } + /** + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + enum ListBuiltInNumberStyle { /** - * Snip two same rectangle geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - snip2SameRectangle = "Snip2SameRectangle", + none = "None", /** - * Snip two diagonal rectangle geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - snip2DiagonalRectangle = "Snip2DiagonalRectangle", + arabic = "Arabic", /** - * Plaque geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - plaque = "Plaque", + upperRoman = "UpperRoman", /** - * Ellipse geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - ellipse = "Ellipse", + lowerRoman = "LowerRoman", /** - * Teardrop geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - teardrop = "Teardrop", + upperLetter = "UpperLetter", /** - * Home plate geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - homePlate = "HomePlate", + lowerLetter = "LowerLetter", /** - * Chevron geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - chevron = "Chevron", + ordinal = "Ordinal", /** - * Pie wedge geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - pieWedge = "PieWedge", + cardinalText = "CardinalText", /** - * Pie geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - pie = "Pie", + ordinalText = "OrdinalText", /** - * Block arc geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - blockArc = "BlockArc", + kanji = "Kanji", /** - * Donut geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - donut = "Donut", + kanjiDigit = "KanjiDigit", /** - * No smoking geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - noSmoking = "NoSmoking", + aiueoHalfWidth = "AiueoHalfWidth", /** - * Right arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - rightArrow = "RightArrow", + irohaHalfWidth = "IrohaHalfWidth", /** - * Left arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - leftArrow = "LeftArrow", + arabicFullWidth = "ArabicFullWidth", /** - * Up arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - upArrow = "UpArrow", + kanjiTraditional = "KanjiTraditional", /** - * Down arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - downArrow = "DownArrow", + kanjiTraditional2 = "KanjiTraditional2", /** - * Striped right arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - stripedRightArrow = "StripedRightArrow", + numberInCircle = "NumberInCircle", /** - * Notched right arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - notchedRightArrow = "NotchedRightArrow", + aiueo = "Aiueo", /** - * Bent up arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - bentUpArrow = "BentUpArrow", + iroha = "Iroha", /** - * Left-right arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - leftRightArrow = "LeftRightArrow", + arabicLZ = "ArabicLZ", /** - * Up-down arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - upDownArrow = "UpDownArrow", + bullet = "Bullet", /** - * Left-up arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - leftUpArrow = "LeftUpArrow", + ganada = "Ganada", /** - * Left-right-up arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - leftRightUpArrow = "LeftRightUpArrow", + chosung = "Chosung", /** - * Quad arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - quadArrow = "QuadArrow", + gbnum1 = "GBNum1", /** - * Left arrow callout geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - leftArrowCallout = "LeftArrowCallout", + gbnum2 = "GBNum2", /** - * Right arrow callout geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - rightArrowCallout = "RightArrowCallout", + gbnum3 = "GBNum3", /** - * Up arrow callout geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - upArrowCallout = "UpArrowCallout", + gbnum4 = "GBNum4", /** - * Down arrow callout geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - downArrowCallout = "DownArrowCallout", + zodiac1 = "Zodiac1", /** - * Left-right arrow callout geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - leftRightArrowCallout = "LeftRightArrowCallout", + zodiac2 = "Zodiac2", /** - * Up-down arrow callout geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - upDownArrowCallout = "UpDownArrowCallout", + zodiac3 = "Zodiac3", /** - * Quad arrow callout geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - quadArrowCallout = "QuadArrowCallout", + tradChinNum1 = "TradChinNum1", /** - * Bent arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - bentArrow = "BentArrow", + tradChinNum2 = "TradChinNum2", /** - * U-turn arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - uturnArrow = "UturnArrow", + tradChinNum3 = "TradChinNum3", /** - * Circular arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - circularArrow = "CircularArrow", + tradChinNum4 = "TradChinNum4", /** - * Left circular arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - leftCircularArrow = "LeftCircularArrow", + simpChinNum1 = "SimpChinNum1", /** - * Left-right circular arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - leftRightCircularArrow = "LeftRightCircularArrow", + simpChinNum2 = "SimpChinNum2", /** - * Curved right arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - curvedRightArrow = "CurvedRightArrow", + simpChinNum3 = "SimpChinNum3", /** - * Curved left arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - curvedLeftArrow = "CurvedLeftArrow", + simpChinNum4 = "SimpChinNum4", /** - * Curved up arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - curvedUpArrow = "CurvedUpArrow", + hanjaRead = "HanjaRead", /** - * Curved down arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - curvedDownArrow = "CurvedDownArrow", + hanjaReadDigit = "HanjaReadDigit", /** - * Swoosh arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - swooshArrow = "SwooshArrow", + hangul = "Hangul", /** - * Cube geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - cube = "Cube", + hanja = "Hanja", /** - * Can geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - can = "Can", + hebrew1 = "Hebrew1", /** - * Lightning bolt geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - lightningBolt = "LightningBolt", + arabic1 = "Arabic1", /** - * Heart geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - heart = "Heart", + hebrew2 = "Hebrew2", /** - * Sun geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - sun = "Sun", + arabic2 = "Arabic2", /** - * Moon geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - moon = "Moon", + hindiLetter1 = "HindiLetter1", /** - * Smiley face geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - smileyFace = "SmileyFace", + hindiLetter2 = "HindiLetter2", /** - * Irregular seal 1 geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - irregularSeal1 = "IrregularSeal1", + hindiArabic = "HindiArabic", /** - * Irregular seal 2 geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - irregularSeal2 = "IrregularSeal2", + hindiCardinalText = "HindiCardinalText", /** - * Folded corner geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - foldedCorner = "FoldedCorner", + thaiLetter = "ThaiLetter", /** - * Bevel geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - bevel = "Bevel", + thaiArabic = "ThaiArabic", /** - * Frame geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - frame = "Frame", + thaiCardinalText = "ThaiCardinalText", /** - * Half frame geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - halfFrame = "HalfFrame", + vietCardinalText = "VietCardinalText", /** - * Corner geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - corner = "Corner", + lowercaseRussian = "LowercaseRussian", /** - * Diagonal stripe geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - diagonalStripe = "DiagonalStripe", + uppercaseRussian = "UppercaseRussian", /** - * Chord geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - chord = "Chord", + lowercaseGreek = "LowercaseGreek", /** - * Arc geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - arc = "Arc", + uppercaseGreek = "UppercaseGreek", /** - * Left bracket geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - leftBracket = "LeftBracket", + arabicLZ2 = "ArabicLZ2", /** - * Right bracket geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - rightBracket = "RightBracket", + arabicLZ3 = "ArabicLZ3", /** - * Left brace geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - leftBrace = "LeftBrace", + arabicLZ4 = "ArabicLZ4", /** - * Right brace geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - rightBrace = "RightBrace", + lowercaseTurkish = "LowercaseTurkish", /** - * Bracket pair geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - bracketPair = "BracketPair", + uppercaseTurkish = "UppercaseTurkish", /** - * Brace pair geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - bracePair = "BracePair", + lowercaseBulgarian = "LowercaseBulgarian", /** - * Callout 1 geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - callout1 = "Callout1", + uppercaseBulgarian = "UppercaseBulgarian", /** - * Callout 2 geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - callout2 = "Callout2", + pictureBullet = "PictureBullet", /** - * Callout 3 geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - callout3 = "Callout3", + legal = "Legal", /** - * Accent callout 1 geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - accentCallout1 = "AccentCallout1", + legalLZ = "LegalLZ", + } + /** + * Represents the shading texture. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + enum ShadingTextureType { /** - * Accent callout 2 geometric shape. + * Represents dark diagonal-down texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - accentCallout2 = "AccentCallout2", + darkDiagonalDown = "DarkDiagonalDown", /** - * Accent callout 3 geometric shape. + * Represents dark diagonal-up texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - accentCallout3 = "AccentCallout3", + darkDiagonalUp = "DarkDiagonalUp", /** - * Border callout 1 geometric shape. + * Represents dark horizontal-cross texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - borderCallout1 = "BorderCallout1", + darkGrid = "DarkGrid", /** - * Border callout 2 geometric shape. + * Represents dark horizontal texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - borderCallout2 = "BorderCallout2", + darkHorizontal = "DarkHorizontal", /** - * Border callout 3 geometric shape. + * Represents dark diagonal-cross texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - borderCallout3 = "BorderCallout3", + darkTrellis = "DarkTrellis", /** - * Accent border callout 1 geometric shape. + * Represents dark vertical texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - accentBorderCallout1 = "AccentBorderCallout1", + darkVertical = "DarkVertical", /** - * Accent border callout 2 geometric shape. + * Represents light diagonal-down texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - accentBorderCallout2 = "AccentBorderCallout2", + lightDiagonalDown = "LightDiagonalDown", /** - * Accent border callout 3 geometric shape. + * Represents light diagonal-up texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - accentBorderCallout3 = "AccentBorderCallout3", + lightDiagonalUp = "LightDiagonalUp", /** - * Wedge rectangle callout geometric shape. + * Represents light horizontal-cross texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - wedgeRectCallout = "WedgeRectCallout", + lightGrid = "LightGrid", /** - * Wedge rounded rectangle callout geometric shape. + * Represents light horizontal texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - wedgeRRectCallout = "WedgeRRectCallout", + lightHorizontal = "LightHorizontal", /** - * Wedge ellipse callout geometric shape. + * Represents light diagonal-cross texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - wedgeEllipseCallout = "WedgeEllipseCallout", + lightTrellis = "LightTrellis", /** - * Cloud callout geometric shape. + * Represents light vertical texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - cloudCallout = "CloudCallout", + lightVertical = "LightVertical", /** - * Cloud geometric shape. + * Represents that there's no texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - cloud = "Cloud", + none = "None", /** - * Ribbon geometric shape. + * Represents 10 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - ribbon = "Ribbon", + percent10 = "Percent10", /** - * Ribbon 2 geometric shape. + * Represents 12.5 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - ribbon2 = "Ribbon2", + percent12Pt5 = "Percent12Pt5", /** - * Ellipse ribbon geometric shape. + * Represents 15 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - ellipseRibbon = "EllipseRibbon", + percent15 = "Percent15", /** - * Ellipse ribbon 2 geometric shape. + * Represents 20 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - ellipseRibbon2 = "EllipseRibbon2", + percent20 = "Percent20", /** - * Left-right ribbon geometric shape. + * Represents 25 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - leftRightRibbon = "LeftRightRibbon", + percent25 = "Percent25", /** - * Vertical scroll geometric shape. + * Represents 30 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - verticalScroll = "VerticalScroll", + percent30 = "Percent30", /** - * Horizontal scroll geometric shape. + * Represents 35 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - horizontalScroll = "HorizontalScroll", + percent35 = "Percent35", /** - * Wave geometric shape. + * Represents 37.5 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - wave = "Wave", + percent37Pt5 = "Percent37Pt5", /** - * Double wave geometric shape. + * Represents 40 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - doubleWave = "DoubleWave", + percent40 = "Percent40", /** - * Plus geometric shape. + * Represents 45 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - plus = "Plus", + percent45 = "Percent45", /** - * Flow chart process geometric shape. + * Represents 5 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartProcess = "FlowChartProcess", + percent5 = "Percent5", /** - * Flow chart decision geometric shape. + * Represents 50 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartDecision = "FlowChartDecision", + percent50 = "Percent50", /** - * Flow chart input-output geometric shape. + * Represents 55 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartInputOutput = "FlowChartInputOutput", + percent55 = "Percent55", /** - * Flow chart predefined process geometric shape. + * Represents 60 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartPredefinedProcess = "FlowChartPredefinedProcess", + percent60 = "Percent60", /** - * Flow chart internal storage geometric shape. + * Represents 62.5 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartInternalStorage = "FlowChartInternalStorage", + percent62Pt5 = "Percent62Pt5", /** - * Flow chart document geometric shape. + * Represents 65 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartDocument = "FlowChartDocument", + percent65 = "Percent65", /** - * Flow chart multidocument geometric shape. + * Represents 70 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartMultidocument = "FlowChartMultidocument", + percent70 = "Percent70", /** - * Flow chart terminator geometric shape. + * Represents 75 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartTerminator = "FlowChartTerminator", + percent75 = "Percent75", /** - * Flow chart preparation geometric shape. + * Represents 80 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartPreparation = "FlowChartPreparation", + percent80 = "Percent80", /** - * Flow chart manual input geometric shape. + * Represents 85 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartManualInput = "FlowChartManualInput", + percent85 = "Percent85", /** - * Flow chart manual operation geometric shape. + * Represents 87.5 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartManualOperation = "FlowChartManualOperation", + percent87Pt5 = "Percent87Pt5", /** - * Flow chart connector geometric shape. + * Represents 90 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartConnector = "FlowChartConnector", + percent90 = "Percent90", /** - * Flow chart punched card geometric shape. + * Represents 95 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartPunchedCard = "FlowChartPunchedCard", + percent95 = "Percent95", /** - * Flow chart punched tape geometric shape. + * Represents solid texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartPunchedTape = "FlowChartPunchedTape", + solid = "Solid", + } + /** + * Specifies the target document for displaying document comparison differences. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + enum CompareTarget { /** - * Flow chart summing junction geometric shape. + * Places comparison differences in the current document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartSummingJunction = "FlowChartSummingJunction", + compareTargetCurrent = "CompareTargetCurrent", /** - * Flow chart OR geometric shape. + * Places comparison differences in the target document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartOr = "FlowChartOr", + compareTargetSelected = "CompareTargetSelected", /** - * Flow chart collate geometric shape. + * Places comparison differences in a new document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartCollate = "FlowChartCollate", + compareTargetNew = "CompareTargetNew", + } + /** + * Specifies how to handle any conflicts, that is, when imported styles have the same name as existing styles in the current document. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + enum ImportedStylesConflictBehavior { /** - * Flow chart sort geometric shape. + * Ignore conflicting imported styles and keep the existing version of those styles in the current document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartSort = "FlowChartSort", + ignore = "Ignore", /** - * Flow chart extract geometric shape. + * Overwrite the existing styles in the current document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartExtract = "FlowChartExtract", + overwrite = "Overwrite", /** - * Flow chart merge geometric shape. + * Rename conflicting imported styles so that both versions are kept in the current document. For example, if MyStyle already exists in the document, then the imported version could be added as MyStyle1. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartMerge = "FlowChartMerge", + createNew = "CreateNew", + } + /** + * Represents the shape type. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum ShapeType { /** - * Flow chart offline storage geometric shape. + * Unsupported shape type. * @remarks * [Api set: WordApiDesktop 1.2] */ - flowChartOfflineStorage = "FlowChartOfflineStorage", + unsupported = "Unsupported", /** - * Flow chart online storage geometric shape. + * Text box shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - flowChartOnlineStorage = "FlowChartOnlineStorage", + textBox = "TextBox", /** - * Flow chart magnetic tape geometric shape. + * Geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - flowChartMagneticTape = "FlowChartMagneticTape", + geometricShape = "GeometricShape", /** - * Flow chart magnetic disk geometric shape. + * Group shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - flowChartMagneticDisk = "FlowChartMagneticDisk", + group = "Group", /** - * Flow chart magnetic drum geometric shape. + * Picture shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - flowChartMagneticDrum = "FlowChartMagneticDrum", + picture = "Picture", /** - * Flow chart display geometric shape. + * Canvas shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - flowChartDisplay = "FlowChartDisplay", + canvas = "Canvas", + } + /** + * Represents what the horizontal position of a shape is relative to. + For more information about margins, see {@link https://support.microsoft.com/office/c95c1ea1-70b1-4dde-a1da-f5aa2042c829 | Change the margins in your Word document}. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum RelativeHorizontalPosition { /** - * Flow chart delay geometric shape. + * Relative to margin. * @remarks * [Api set: WordApiDesktop 1.2] */ - flowChartDelay = "FlowChartDelay", + margin = "Margin", /** - * Flow chart alternate process geometric shape. + * Relative to page. * @remarks * [Api set: WordApiDesktop 1.2] */ - flowChartAlternateProcess = "FlowChartAlternateProcess", + page = "Page", /** - * Flow chart off-page connector geometric shape. + * Relative to column. * @remarks * [Api set: WordApiDesktop 1.2] */ - flowChartOffpageConnector = "FlowChartOffpageConnector", + column = "Column", /** - * Action button blank geometric shape. + * Relative to character. * @remarks * [Api set: WordApiDesktop 1.2] */ - actionButtonBlank = "ActionButtonBlank", + character = "Character", /** - * Action button home geometric shape. + * Relative to left margin. * @remarks * [Api set: WordApiDesktop 1.2] */ - actionButtonHome = "ActionButtonHome", + leftMargin = "LeftMargin", /** - * Action button help geometric shape. + * Relative to right margin. * @remarks * [Api set: WordApiDesktop 1.2] */ - actionButtonHelp = "ActionButtonHelp", + rightMargin = "RightMargin", /** - * Action button information geometric shape. + * Relative to inside margin. * @remarks * [Api set: WordApiDesktop 1.2] */ - actionButtonInformation = "ActionButtonInformation", + insideMargin = "InsideMargin", /** - * Action button forward next geometric shape. + * Relative to outside margin. * @remarks * [Api set: WordApiDesktop 1.2] */ - actionButtonForwardNext = "ActionButtonForwardNext", + outsideMargin = "OutsideMargin", + } + /** + * Represents what the vertical position of a shape is relative to. + For more information about margins, see {@link https://support.microsoft.com/office/c95c1ea1-70b1-4dde-a1da-f5aa2042c829 | Change the margins in your Word document}. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum RelativeVerticalPosition { /** - * Action button back previous geometric shape. + * Relative to margin. * @remarks * [Api set: WordApiDesktop 1.2] */ - actionButtonBackPrevious = "ActionButtonBackPrevious", + margin = "Margin", /** - * Action button end geometric shape. + * Relative to page. * @remarks * [Api set: WordApiDesktop 1.2] */ - actionButtonEnd = "ActionButtonEnd", + page = "Page", /** - * Action button beginning geometric shape. + * Relative to paragraph. * @remarks * [Api set: WordApiDesktop 1.2] */ - actionButtonBeginning = "ActionButtonBeginning", + paragraph = "Paragraph", /** - * Action button return geometric shape. + * Relative to line. * @remarks * [Api set: WordApiDesktop 1.2] */ - actionButtonReturn = "ActionButtonReturn", + line = "Line", /** - * Action button document geometric shape. + * Relative to top margin. * @remarks * [Api set: WordApiDesktop 1.2] */ - actionButtonDocument = "ActionButtonDocument", + topMargin = "TopMargin", /** - * Action button sound geometric shape. + * Relative to bottom margin. * @remarks * [Api set: WordApiDesktop 1.2] */ - actionButtonSound = "ActionButtonSound", + bottomMargin = "BottomMargin", /** - * Action button movie geometric shape. + * Relative to inside margin. * @remarks * [Api set: WordApiDesktop 1.2] */ - actionButtonMovie = "ActionButtonMovie", + insideMargin = "InsideMargin", /** - * Gear 6 geometric shape. + * Relative to outside margin. * @remarks * [Api set: WordApiDesktop 1.2] */ - gear6 = "Gear6", + outsideMargin = "OutsideMargin", + } + /** + * Represents what the horizontal or vertical size of a shape is relative to. + For more information about margins, see {@link https://support.microsoft.com/office/c95c1ea1-70b1-4dde-a1da-f5aa2042c829 | Change the margins in your Word document}. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum RelativeSize { /** - * Gear 9 geometric shape. + * Relative to margin. * @remarks * [Api set: WordApiDesktop 1.2] */ - gear9 = "Gear9", + margin = "Margin", /** - * Funnel geometric shape. + * Relative to page. * @remarks * [Api set: WordApiDesktop 1.2] */ - funnel = "Funnel", + page = "Page", /** - * Math plus geometric shape. + * Relative to top margin. * @remarks * [Api set: WordApiDesktop 1.2] */ - mathPlus = "MathPlus", + topMargin = "TopMargin", /** - * Math minus geometric shape. + * Relative to bottom margin. * @remarks * [Api set: WordApiDesktop 1.2] */ - mathMinus = "MathMinus", + bottomMargin = "BottomMargin", /** - * Math multiply geometric shape. + * Relative to inside margin. * @remarks * [Api set: WordApiDesktop 1.2] */ - mathMultiply = "MathMultiply", + insideMargin = "InsideMargin", /** - * Math divide geometric shape. + * Relative to outside margin. * @remarks * [Api set: WordApiDesktop 1.2] */ - mathDivide = "MathDivide", + outsideMargin = "OutsideMargin", + } + /** + * Specifies the shape type for a `GeometricShape` object. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum GeometricShapeType { /** - * Math equal geometric shape. + * Line inverse geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - mathEqual = "MathEqual", + lineInverse = "LineInverse", /** - * Math not equal geometric shape. + * Triangle geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - mathNotEqual = "MathNotEqual", + triangle = "Triangle", /** - * Corner tabs geometric shape. + * Right triangle geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - cornerTabs = "CornerTabs", + rightTriangle = "RightTriangle", /** - * Square tabs geometric shape. + * Rectangle geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - squareTabs = "SquareTabs", + rectangle = "Rectangle", /** - * Plaque tabs geometric shape. + * Diamond geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - plaqueTabs = "PlaqueTabs", + diamond = "Diamond", /** - * Chart X geometric shape. + * Parallelogram geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - chartX = "ChartX", + parallelogram = "Parallelogram", /** - * Chart star geometric shape. + * Trapezoid geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - chartStar = "ChartStar", + trapezoid = "Trapezoid", /** - * Chart plus geometric shape. + * Non-isosceles trapezoid geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - chartPlus = "ChartPlus", - } - /** - * Specifies a shape's fill type. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - enum ShapeFillType { + nonIsoscelesTrapezoid = "NonIsoscelesTrapezoid", /** - * No fill. + * Pentagon geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - noFill = "NoFill", + pentagon = "Pentagon", /** - * Solid fill. + * Hexagon geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - solid = "Solid", + hexagon = "Hexagon", /** - * Gradient fill. + * Heptagon geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - gradient = "Gradient", + heptagon = "Heptagon", /** - * Pattern fill. + * Octagon geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - pattern = "Pattern", + octagon = "Octagon", /** - * Picture fill. + * Decagon geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - picture = "Picture", + decagon = "Decagon", /** - * Texture fill. + * Dodecagon geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - texture = "Texture", + dodecagon = "Dodecagon", /** - * Mixed fill. + * Star 4-point geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - mixed = "Mixed", - } - /** - * Specifies the vertical alignment for the text frame in a shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - enum ShapeTextVerticalAlignment { + star4 = "Star4", /** - * Anchor the text at the top of the bounding rectangle. + * Star 5-point geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - top = "Top", + star5 = "Star5", /** - * Anchor the text at the middle of the bounding rectangle. + * Star 6-point geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - middle = "Middle", + star6 = "Star6", /** - * Anchor the text at the bottom of the bounding rectangle. + * Star 7-point geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - bottom = "Bottom", - } - /** - * Specifies the orientation for the text frame in a shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - enum ShapeTextOrientation { + star7 = "Star7", /** - * No orientation, such as in a new geometric shape. + * Star 8-point geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - none = "None", + star8 = "Star8", /** - * Horizontal text. + * Star 10-point geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - horizontal = "Horizontal", + star10 = "Star10", /** - * A special version of vertical text, where some fonts are displayed as if rotated. + * Star 12-point geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - eastAsianVertical = "EastAsianVertical", + star12 = "Star12", /** - * Determines if all of the text is vertical orientation (each line is 270 degrees rotated clockwise). + * Star 16-point geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - vertical270 = "Vertical270", + star16 = "Star16", /** - * Determines if all of the text is vertical orientation (each line is 90 degrees rotated clockwise). + * Star 24-point geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - vertical = "Vertical", + star24 = "Star24", /** - * A special version of vertical text, where some fonts are displayed as if rotated. + * Star 32-point geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - eastAsianHorizontalRotated = "EastAsianHorizontalRotated", + star32 = "Star32", /** - * A combination of automatic orientation is used. + * Round rectangle geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - mixed = "Mixed", - } - /** - * Determines the type of automatic sizing allowed. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - enum ShapeAutoSize { + roundRectangle = "RoundRectangle", /** - * No autosizing. + * Round one rectangle geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - none = "None", + round1Rectangle = "Round1Rectangle", /** - * The text is adjusted to fit the shape. + * Round two same rectangle geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - textToFitShape = "TextToFitShape", + round2SameRectangle = "Round2SameRectangle", /** - * The shape is adjusted to fit the text. + * Round two diagonal rectangle geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - shapeToFitText = "ShapeToFitText", + round2DiagonalRectangle = "Round2DiagonalRectangle", /** - * A combination of automatic sizing schemes are used. + * Snip round rectangle geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - mixed = "Mixed", - } - /** - * Specifies how to wrap document text around a shape. For more details, see the "Text Wrapping" tab of {@link https://support.microsoft.com/office/a0f53857-b501-46c6-ba8b-68ba51e0e3cc | Layout options}. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - enum ShapeTextWrapType { + snipRoundRectangle = "SnipRoundRectangle", /** - * Places the shape in line with text. + * Snip one rectangle geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - inline = "Inline", + snip1Rectangle = "Snip1Rectangle", /** - * Wraps text squarely around the shape. + * Snip two same rectangle geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - square = "Square", + snip2SameRectangle = "Snip2SameRectangle", /** - * Wraps text close to the shape. + * Snip two diagonal rectangle geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - tight = "Tight", + snip2DiagonalRectangle = "Snip2DiagonalRectangle", /** - * Wraps text around and through the shape. + * Plaque geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - through = "Through", + plaque = "Plaque", /** - * Places text above and below the shape. + * Ellipse geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - topBottom = "TopBottom", + ellipse = "Ellipse", /** - * Places shape behind text. + * Teardrop geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - behind = "Behind", + teardrop = "Teardrop", /** - * Places shape in front of text. + * Home plate geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - front = "Front", - } - /** - * Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farther from the respective page margin. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - enum ShapeTextWrapSide { + homePlate = "HomePlate", /** - * Has no wrap side property, such as those for inline shapes. + * Chevron geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - none = "None", + chevron = "Chevron", /** - * Both left and right sides of the shape. + * Pie wedge geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - both = "Both", + pieWedge = "PieWedge", /** - * Left side of the shape only. + * Pie geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - left = "Left", + pie = "Pie", /** - * Right side of the shape only. + * Block arc geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - right = "Right", + blockArc = "BlockArc", /** - * Side of the shape that's farther from the respective page margin. + * Donut geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - largest = "Largest", - } - /** - * Specifies the scale size type of a shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - enum ShapeScaleType { + donut = "Donut", /** - * Scale from current size of the shape. + * No smoking geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - currentSize = "CurrentSize", + noSmoking = "NoSmoking", /** - * Scale from original size of the shape. It only works for pictures. + * Right arrow geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - originalSize = "OriginalSize", - } - /** - * Specifies which part of the shape retains its position when the shape is scaled. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - enum ShapeScaleFrom { + rightArrow = "RightArrow", /** - * Scale from the top left corner of the shape. + * Left arrow geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - scaleFromTopLeft = "ScaleFromTopLeft", + leftArrow = "LeftArrow", /** - * Scale from the center of the shape. + * Up arrow geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - scaleFromMiddle = "ScaleFromMiddle", + upArrow = "UpArrow", /** - * Scale from the bottom right corner of the shape. + * Down arrow geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - scaleFromBottomRight = "ScaleFromBottomRight", - } - /** - * Represents how Word interprets the rule used to determine the height or width of a {@link Word.Frame}. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum FrameSizeRule { + downArrow = "DownArrow", /** - * The height or width is set according to the height or width of the item in the frame. + * Striped right arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - auto = "Auto", + stripedRightArrow = "StripedRightArrow", /** - * The height or width is set to a value equal to or greater than the value specified by the `height` property or `width` property. + * Notched right arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - atLeast = "AtLeast", + notchedRightArrow = "NotchedRightArrow", /** - * The height or width is set to an exact value specified by the `height` property or `width` property. + * Bent up arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - exact = "Exact", - } - /** - * Specifies the border style for an object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum BorderLineStyle { + bentUpArrow = "BentUpArrow", /** - * No line style. + * Left-right arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - none = "None", + leftRightArrow = "LeftRightArrow", /** - * Single line style. + * Up-down arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - single = "Single", + upDownArrow = "UpDownArrow", /** - * Dotted line style. + * Left-up arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - dot = "Dot", + leftUpArrow = "LeftUpArrow", /** - * Dashed line style with small gaps. + * Left-right-up arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - dashSmallGap = "DashSmallGap", + leftRightUpArrow = "LeftRightUpArrow", /** - * Dashed line style with large gaps. + * Quad arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - dashLargeGap = "DashLargeGap", + quadArrow = "QuadArrow", /** - * Dash-dot line style. + * Left arrow callout geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - dashDot = "DashDot", + leftArrowCallout = "LeftArrowCallout", /** - * Dash-dot-dot line style. + * Right arrow callout geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - dashDotDot = "DashDotDot", + rightArrowCallout = "RightArrowCallout", /** - * Double line style. + * Up arrow callout geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - double = "Double", + upArrowCallout = "UpArrowCallout", /** - * Triple line style. + * Down arrow callout geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - triple = "Triple", + downArrowCallout = "DownArrowCallout", /** - * Thin-thick line style with small gaps. + * Left-right arrow callout geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - thinThickSmallGap = "ThinThickSmallGap", + leftRightArrowCallout = "LeftRightArrowCallout", /** - * Thick-thin line style with small gaps. + * Up-down arrow callout geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - thickThinSmallGap = "ThickThinSmallGap", + upDownArrowCallout = "UpDownArrowCallout", /** - * Thin-thick-thin line style with small gaps. + * Quad arrow callout geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - thinThickThinSmallGap = "ThinThickThinSmallGap", + quadArrowCallout = "QuadArrowCallout", /** - * Thin-thick line style with medium gaps. + * Bent arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - thinThickMedGap = "ThinThickMedGap", + bentArrow = "BentArrow", /** - * Thick-thin line style with medium gaps. + * U-turn arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - thickThinMedGap = "ThickThinMedGap", + uturnArrow = "UturnArrow", /** - * Thin-thick-thin line style with medium gaps. + * Circular arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - thinThickThinMedGap = "ThinThickThinMedGap", + circularArrow = "CircularArrow", /** - * Thin-thick line style with large gaps. + * Left circular arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - thinThickLargeGap = "ThinThickLargeGap", + leftCircularArrow = "LeftCircularArrow", /** - * Thick-thin line style with large gaps. + * Left-right circular arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - thickThinLargeGap = "ThickThinLargeGap", + leftRightCircularArrow = "LeftRightCircularArrow", /** - * Thin-thick-thin line style with large gaps. + * Curved right arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - thinThickThinLargeGap = "ThinThickThinLargeGap", + curvedRightArrow = "CurvedRightArrow", /** - * Single wavy line style. + * Curved left arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - singleWavy = "SingleWavy", + curvedLeftArrow = "CurvedLeftArrow", /** - * Double wavy line style. + * Curved up arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - doubleWavy = "DoubleWavy", + curvedUpArrow = "CurvedUpArrow", /** - * Dash-dot stroked line style. + * Curved down arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - dashDotStroked = "DashDotStroked", + curvedDownArrow = "CurvedDownArrow", /** - * Embossed 3D line style. + * Swoosh arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - emboss3D = "Emboss3D", + swooshArrow = "SwooshArrow", /** - * Engraved 3D line style. + * Cube geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - engrave3D = "Engrave3D", + cube = "Cube", /** - * Outset line style. + * Can geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - outset = "Outset", + can = "Can", /** - * Inset line style. + * Lightning bolt geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - inset = "Inset", - } - /** - * Specifies the width of an object's border. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum LineWidth { + lightningBolt = "LightningBolt", /** - * Represents a line width of 0.25 points. + * Heart geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - pt025 = "Pt025", + heart = "Heart", /** - * Represents a line width of 0.50 points. + * Sun geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - pt050 = "Pt050", + sun = "Sun", /** - * Represents a line width of 0.75 points. + * Moon geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - pt075 = "Pt075", + moon = "Moon", /** - * Represents a line width of 1.00 points. + * Smiley face geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - pt100 = "Pt100", + smileyFace = "SmileyFace", /** - * Represents a line width of 1.50 points. + * Irregular seal 1 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - pt150 = "Pt150", + irregularSeal1 = "IrregularSeal1", /** - * Represents a line width of 2.25 points. + * Irregular seal 2 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - pt225 = "Pt225", + irregularSeal2 = "IrregularSeal2", /** - * Represents a line width of 3.00 points. + * Folded corner geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - pt300 = "Pt300", + foldedCorner = "FoldedCorner", /** - * Represents a line width of 4.50 points. + * Bevel geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - pt450 = "Pt450", + bevel = "Bevel", /** - * Represents a line width of 6.00 points. + * Frame geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - pt600 = "Pt600", - } - /** - * Specifies the graphical page border setting of a page. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum PageBorderArt { + frame = "Frame", /** - * Represents a border with apple design. + * Half frame geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - apples = "Apples", + halfFrame = "HalfFrame", /** - * Represents a border with maple muffin design. + * Corner geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - mapleMuffins = "MapleMuffins", + corner = "Corner", /** - * Represents a border with cake slice design. + * Diagonal stripe geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - cakeSlice = "CakeSlice", + diagonalStripe = "DiagonalStripe", /** - * Represents a border with candy corn design. + * Chord geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - candyCorn = "CandyCorn", + chord = "Chord", /** - * Represents a border with ice cream cone design. + * Arc geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - iceCreamCones = "IceCreamCones", + arc = "Arc", /** - * Represents a border with champagne bottle design. + * Left bracket geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - champagneBottle = "ChampagneBottle", + leftBracket = "LeftBracket", /** - * Represents a border with party glass design. + * Right bracket geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - partyGlass = "PartyGlass", + rightBracket = "RightBracket", /** - * Represents a border with Christmas tree design. + * Left brace geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - christmasTree = "ChristmasTree", + leftBrace = "LeftBrace", /** - * Represents a border with trees design. + * Right brace geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - trees = "Trees", + rightBrace = "RightBrace", /** - * Represents a border with palm trees in color. + * Bracket pair geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - palmsColor = "PalmsColor", + bracketPair = "BracketPair", /** - * Represents a border with three-color balloons design. + * Brace pair geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - balloons3Colors = "Balloons3Colors", + bracePair = "BracePair", /** - * Represents a border with hot air balloons design. + * Callout 1 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - balloonsHotAir = "BalloonsHotAir", + callout1 = "Callout1", /** - * Represents a border with party favor design. + * Callout 2 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - partyFavor = "PartyFavor", + callout2 = "Callout2", /** - * Represents a border with confetti streamers design. + * Callout 3 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - confettiStreamers = "ConfettiStreamers", + callout3 = "Callout3", /** - * Represents a border with hearts design. + * Accent callout 1 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - hearts = "Hearts", + accentCallout1 = "AccentCallout1", /** - * Represents a border with heart balloon design. + * Accent callout 2 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - heartBalloon = "HeartBalloon", + accentCallout2 = "AccentCallout2", /** - * Represents a border with 3D stars design. + * Accent callout 3 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - stars3D = "Stars3D", + accentCallout3 = "AccentCallout3", /** - * Represents a border with shadowed stars design. + * Border callout 1 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - starsShadowed = "StarsShadowed", + borderCallout1 = "BorderCallout1", /** - * Represents a border with stars design. + * Border callout 2 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - stars = "Stars", + borderCallout2 = "BorderCallout2", /** - * Represents a border with sun design. + * Border callout 3 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - sun = "Sun", + borderCallout3 = "BorderCallout3", /** - * Represents a border with Earth design (variant 2). + * Accent border callout 1 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - earth2 = "Earth2", + accentBorderCallout1 = "AccentBorderCallout1", /** - * Represents a border with Earth design (variant 1). + * Accent border callout 2 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - earth1 = "Earth1", + accentBorderCallout2 = "AccentBorderCallout2", /** - * Represents a border with people wearing hats design. + * Accent border callout 3 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - peopleHats = "PeopleHats", + accentBorderCallout3 = "AccentBorderCallout3", /** - * Represents a border with sombrero design. + * Wedge rectangle callout geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - sombrero = "Sombrero", + wedgeRectCallout = "WedgeRectCallout", /** - * Represents a border with pencils design. + * Wedge rounded rectangle callout geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - pencils = "Pencils", + wedgeRRectCallout = "WedgeRRectCallout", /** - * Represents a border with packages design. + * Wedge ellipse callout geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - packages = "Packages", + wedgeEllipseCallout = "WedgeEllipseCallout", /** - * Represents a border with clocks design. + * Cloud callout geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - clocks = "Clocks", + cloudCallout = "CloudCallout", /** - * Represents a border with firecrackers design. + * Cloud geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - firecrackers = "Firecrackers", + cloud = "Cloud", /** - * Represents a border with rings design. + * Ribbon geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - rings = "Rings", + ribbon = "Ribbon", /** - * Represents a border with map pins design. + * Ribbon 2 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - mapPins = "MapPins", + ribbon2 = "Ribbon2", /** - * Represents a border with confetti design. + * Ellipse ribbon geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - confetti = "Confetti", + ellipseRibbon = "EllipseRibbon", /** - * Represents a border with butterfly creatures design. + * Ellipse ribbon 2 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - creaturesButterfly = "CreaturesButterfly", + ellipseRibbon2 = "EllipseRibbon2", /** - * Represents a border with ladybug creatures design. + * Left-right ribbon geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - creaturesLadyBug = "CreaturesLadyBug", + leftRightRibbon = "LeftRightRibbon", /** - * Represents a border with fish creatures design. + * Vertical scroll geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - creaturesFish = "CreaturesFish", + verticalScroll = "VerticalScroll", /** - * Represents a border with birds in flight design. + * Horizontal scroll geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - birdsFlight = "BirdsFlight", + horizontalScroll = "HorizontalScroll", /** - * Represents a border with scared cat design. + * Wave geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - scaredCat = "ScaredCat", + wave = "Wave", /** - * Represents a border with bats design. + * Double wave geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - bats = "Bats", + doubleWave = "DoubleWave", /** - * Represents a border with roses flowers design. + * Plus geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - flowersRoses = "FlowersRoses", + plus = "Plus", /** - * Represents a border with red rose flowers design. + * Flow chart process geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - flowersRedRose = "FlowersRedRose", + flowChartProcess = "FlowChartProcess", /** - * Represents a border with poinsettias flowers design. + * Flow chart decision geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - poinsettias = "Poinsettias", + flowChartDecision = "FlowChartDecision", /** - * Represents a border with holly design. + * Flow chart input-output geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - holly = "Holly", + flowChartInputOutput = "FlowChartInputOutput", /** - * Represents a border with tiny flowers design. + * Flow chart predefined process geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - flowersTiny = "FlowersTiny", + flowChartPredefinedProcess = "FlowChartPredefinedProcess", /** - * Represents a border with pansy flowers design. + * Flow chart internal storage geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - flowersPansy = "FlowersPansy", + flowChartInternalStorage = "FlowChartInternalStorage", /** - * Represents a border with modern 2 flowers design. + * Flow chart document geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - flowersModern2 = "FlowersModern2", + flowChartDocument = "FlowChartDocument", /** - * Represents a border with modern 1 flowers design. + * Flow chart multidocument geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - flowersModern1 = "FlowersModern1", + flowChartMultidocument = "FlowChartMultidocument", /** - * Represents a border with white flowers design. + * Flow chart terminator geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - whiteFlowers = "WhiteFlowers", + flowChartTerminator = "FlowChartTerminator", /** - * Represents a border with vine design. + * Flow chart preparation geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - vine = "Vine", + flowChartPreparation = "FlowChartPreparation", /** - * Represents a border with daisies flowers design. + * Flow chart manual input geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - flowersDaisies = "FlowersDaisies", + flowChartManualInput = "FlowChartManualInput", /** - * Represents a border with block print flowers design. + * Flow chart manual operation geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - flowersBlockPrint = "FlowersBlockPrint", + flowChartManualOperation = "FlowChartManualOperation", /** - * Represents a border with colored deco arch design. + * Flow chart connector geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - decoArchColor = "DecoArchColor", + flowChartConnector = "FlowChartConnector", /** - * Represents a border with fans design. + * Flow chart punched card geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - fans = "Fans", + flowChartPunchedCard = "FlowChartPunchedCard", /** - * Represents a border with film design. + * Flow chart punched tape geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - film = "Film", + flowChartPunchedTape = "FlowChartPunchedTape", /** - * Represents a border with lightning design (variant 1). + * Flow chart summing junction geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - lightning1 = "Lightning1", + flowChartSummingJunction = "FlowChartSummingJunction", /** - * Represents a border with compass design. + * Flow chart OR geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - compass = "Compass", + flowChartOr = "FlowChartOr", /** - * Represents a border with double D design. + * Flow chart collate geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - doubleD = "DoubleD", + flowChartCollate = "FlowChartCollate", /** - * Represents a border with classical wave design. + * Flow chart sort geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - classicalWave = "ClassicalWave", + flowChartSort = "FlowChartSort", /** - * Represents a border with shadowed squares design. + * Flow chart extract geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - shadowedSquares = "ShadowedSquares", + flowChartExtract = "FlowChartExtract", /** - * Represents a border with twisted lines design (variant 1). + * Flow chart merge geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - twistedLines1 = "TwistedLines1", + flowChartMerge = "FlowChartMerge", /** - * Represents a border with waveline design. + * Flow chart offline storage geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - waveline = "Waveline", + flowChartOfflineStorage = "FlowChartOfflineStorage", /** - * Represents a border with quadrants design. + * Flow chart online storage geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - quadrants = "Quadrants", + flowChartOnlineStorage = "FlowChartOnlineStorage", /** - * Represents a border with colored checked bar design. + * Flow chart magnetic tape geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - checkedBarColor = "CheckedBarColor", + flowChartMagneticTape = "FlowChartMagneticTape", /** - * Represents a border with swirligig design. + * Flow chart magnetic disk geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - swirligig = "Swirligig", + flowChartMagneticDisk = "FlowChartMagneticDisk", /** - * Represents a border with push pin note design (variant 1). + * Flow chart magnetic drum geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - pushPinNote1 = "PushPinNote1", + flowChartMagneticDrum = "FlowChartMagneticDrum", /** - * Represents a border with push pin note design (variant 2). + * Flow chart display geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - pushPinNote2 = "PushPinNote2", + flowChartDisplay = "FlowChartDisplay", /** - * Represents a border with pumpkin design (variant 1). + * Flow chart delay geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - pumpkin1 = "Pumpkin1", + flowChartDelay = "FlowChartDelay", /** - * Represents a border with black eggs design. + * Flow chart alternate process geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - eggsBlack = "EggsBlack", + flowChartAlternateProcess = "FlowChartAlternateProcess", /** - * Represents a border with cup design. + * Flow chart off-page connector geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - cup = "Cup", + flowChartOffpageConnector = "FlowChartOffpageConnector", /** - * Represents a border with gray heart design. + * Action button blank geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - heartGray = "HeartGray", + actionButtonBlank = "ActionButtonBlank", /** - * Represents a border with gingerbread man design. + * Action button home geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - gingerbreadMan = "GingerbreadMan", + actionButtonHome = "ActionButtonHome", /** - * Represents a border with baby pacifier design. + * Action button help geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - babyPacifier = "BabyPacifier", + actionButtonHelp = "ActionButtonHelp", /** - * Represents a border with baby rattle design. + * Action button information geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - babyRattle = "BabyRattle", + actionButtonInformation = "ActionButtonInformation", /** - * Represents a border with cabins design. + * Action button forward next geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - cabins = "Cabins", + actionButtonForwardNext = "ActionButtonForwardNext", /** - * Represents a border with funky house design. + * Action button back previous geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - houseFunky = "HouseFunky", + actionButtonBackPrevious = "ActionButtonBackPrevious", /** - * Represents a border with black stars design. + * Action button end geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - starsBlack = "StarsBlack", + actionButtonEnd = "ActionButtonEnd", /** - * Represents a border with snowflakes design. + * Action button beginning geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - snowflakes = "Snowflakes", + actionButtonBeginning = "ActionButtonBeginning", /** - * Represents a border with fancy snowflake design. + * Action button return geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - snowflakeFancy = "SnowflakeFancy", + actionButtonReturn = "ActionButtonReturn", /** - * Represents a border with skyrocket design. + * Action button document geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - skyrocket = "Skyrocket", + actionButtonDocument = "ActionButtonDocument", /** - * Represents a border with Seattle design. + * Action button sound geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - seattle = "Seattle", + actionButtonSound = "ActionButtonSound", /** - * Represents a border with music notes design. + * Action button movie geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - musicNotes = "MusicNotes", + actionButtonMovie = "ActionButtonMovie", /** - * Represents a border with black palms design. + * Gear 6 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - palmsBlack = "PalmsBlack", + gear6 = "Gear6", /** - * Represents a border with maple leaf design. + * Gear 9 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - mapleLeaf = "MapleLeaf", + gear9 = "Gear9", /** - * Represents a border with paper clips design. + * Funnel geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - paperClips = "PaperClips", + funnel = "Funnel", /** - * Represents a border with shorebird tracks design. + * Math plus geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - shorebirdTracks = "ShorebirdTracks", + mathPlus = "MathPlus", /** - * Represents a border with people design. + * Math minus geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - people = "People", + mathMinus = "MathMinus", /** - * Represents a border with people waving design. + * Math multiply geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - peopleWaving = "PeopleWaving", + mathMultiply = "MathMultiply", /** - * Represents a border with eclipsing squares design (variant 2). + * Math divide geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - eclipsingSquares2 = "EclipsingSquares2", + mathDivide = "MathDivide", /** - * Represents a border with hypnotic design. + * Math equal geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - hypnotic = "Hypnotic", + mathEqual = "MathEqual", /** - * Represents a border with gray diamonds design. + * Math not equal geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - diamondsGray = "DiamondsGray", + mathNotEqual = "MathNotEqual", /** - * Represents a border with deco arch design. + * Corner tabs geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - decoArch = "DecoArch", + cornerTabs = "CornerTabs", /** - * Represents a border with deco blocks design. + * Square tabs geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - decoBlocks = "DecoBlocks", + squareTabs = "SquareTabs", /** - * Represents a border with circles and lines design. + * Plaque tabs geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - circlesLines = "CirclesLines", + plaqueTabs = "PlaqueTabs", /** - * Represents a border with papyrus design. + * Chart X geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - papyrus = "Papyrus", + chartX = "ChartX", /** - * Represents a border with woodwork design. + * Chart star geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - woodwork = "Woodwork", + chartStar = "ChartStar", /** - * Represents a border with weaving braid design. + * Chart plus geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - weavingBraid = "WeavingBraid", + chartPlus = "ChartPlus", + } + /** + * Specifies a shape's fill type. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum ShapeFillType { /** - * Represents a border with weaving ribbon design. + * No fill. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - weavingRibbon = "WeavingRibbon", + noFill = "NoFill", /** - * Represents a border with weaving angles design. + * Solid fill. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - weavingAngles = "WeavingAngles", + solid = "Solid", /** - * Represents a border with arched scallops design. + * Gradient fill. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - archedScallops = "ArchedScallops", + gradient = "Gradient", /** - * Represents a border with safari design. + * Pattern fill. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - safari = "Safari", + pattern = "Pattern", /** - * Represents a border with Celtic knotwork design. + * Picture fill. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - celticKnotwork = "CelticKnotwork", + picture = "Picture", /** - * Represents a border with crazy maze design. + * Texture fill. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - crazyMaze = "CrazyMaze", + texture = "Texture", /** - * Represents a border with eclipsing squares design (variant 1). + * Mixed fill. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - eclipsingSquares1 = "EclipsingSquares1", + mixed = "Mixed", + } + /** + * Specifies the vertical alignment for the text frame in a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum ShapeTextVerticalAlignment { /** - * Represents a border with birds design. + * Anchor the text at the top of the bounding rectangle. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - birds = "Birds", + top = "Top", /** - * Represents a border with teacup and flowers design. + * Anchor the text at the middle of the bounding rectangle. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - flowersTeacup = "FlowersTeacup", + middle = "Middle", /** - * Represents a border with northwest design. + * Anchor the text at the bottom of the bounding rectangle. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - northwest = "Northwest", + bottom = "Bottom", + } + /** + * Specifies the orientation for the text frame in a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum ShapeTextOrientation { /** - * Represents a border with southwest design. + * No orientation, such as in a new geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - southwest = "Southwest", + none = "None", /** - * Represents a border with tribal design (variant 6). + * Horizontal text. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - tribal6 = "Tribal6", + horizontal = "Horizontal", /** - * Represents a border with tribal design (variant 4). + * A special version of vertical text, where some fonts are displayed as if rotated. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - tribal4 = "Tribal4", + eastAsianVertical = "EastAsianVertical", /** - * Represents a border with tribal design (variant 3). + * Determines if all of the text is vertical orientation (each line is 270 degrees rotated clockwise). * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - tribal3 = "Tribal3", + vertical270 = "Vertical270", /** - * Represents a border with tribal design (variant 2). + * Determines if all of the text is vertical orientation (each line is 90 degrees rotated clockwise). * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - tribal2 = "Tribal2", + vertical = "Vertical", /** - * Represents a border with tribal design (variant 5). + * A special version of vertical text, where some fonts are displayed as if rotated. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - tribal5 = "Tribal5", + eastAsianHorizontalRotated = "EastAsianHorizontalRotated", /** - * Represents a border with X illusions design. + * A combination of automatic orientation is used. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - xillusions = "XIllusions", + mixed = "Mixed", + } + /** + * Determines the type of automatic sizing allowed. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum ShapeAutoSize { /** - * Represents a border with zany triangles design. + * No autosizing. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - zanyTriangles = "ZanyTriangles", + none = "None", /** - * Represents a border with pyramids design. + * The text is adjusted to fit the shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - pyramids = "Pyramids", + textToFitShape = "TextToFitShape", /** - * Represents a border with pyramids above design. + * The shape is adjusted to fit the text. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - pyramidsAbove = "PyramidsAbove", + shapeToFitText = "ShapeToFitText", /** - * Represents a border with gray confetti design. + * A combination of automatic sizing schemes are used. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - confettiGrays = "ConfettiGrays", + mixed = "Mixed", + } + /** + * Specifies how to wrap document text around a shape. For more details, see the "Text Wrapping" tab of {@link https://support.microsoft.com/office/a0f53857-b501-46c6-ba8b-68ba51e0e3cc | Layout options}. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum ShapeTextWrapType { /** - * Represents a border with outline confetti design. + * Places the shape in line with text. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - confettiOutline = "ConfettiOutline", + inline = "Inline", /** - * Represents a border with white confetti design. + * Wraps text squarely around the shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - confettiWhite = "ConfettiWhite", + square = "Square", /** - * Represents a border with mosaic design. + * Wraps text close to the shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - mosaic = "Mosaic", + tight = "Tight", /** - * Represents a border with lightning design (variant 2). + * Wraps text around and through the shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - lightning2 = "Lightning2", + through = "Through", /** - * Represents a border with heebie jeebies design. + * Places text above and below the shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - heebieJeebies = "HeebieJeebies", + topBottom = "TopBottom", /** - * Represents a border with light bulb design. + * Places shape behind text. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - lightBulb = "LightBulb", + behind = "Behind", /** - * Represents a border with gradient design. + * Places shape in front of text. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - gradient = "Gradient", + front = "Front", + } + /** + * Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farther from the respective page margin. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum ShapeTextWrapSide { /** - * Represents a border with triangle party design. + * Has no wrap side property, such as those for inline shapes. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - triangleParty = "TriangleParty", + none = "None", /** - * Represents a border with twisted lines design (variant 2). + * Both left and right sides of the shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - twistedLines2 = "TwistedLines2", + both = "Both", /** - * Represents a border with moons design. + * Left side of the shape only. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - moons = "Moons", + left = "Left", /** - * Represents a border with ovals design. + * Right side of the shape only. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - ovals = "Ovals", + right = "Right", /** - * Represents a border with double diamonds design. + * Side of the shape that's farther from the respective page margin. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - doubleDiamonds = "DoubleDiamonds", + largest = "Largest", + } + /** + * Specifies the scale size type of a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum ShapeScaleType { /** - * Represents a border with chain link design. + * Scale from current size of the shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - chainLink = "ChainLink", + currentSize = "CurrentSize", /** - * Represents a border with triangles design. + * Scale from original size of the shape. It only works for pictures. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - triangles = "Triangles", + originalSize = "OriginalSize", + } + /** + * Specifies which part of the shape retains its position when the shape is scaled. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum ShapeScaleFrom { /** - * Represents a border with tribal design (variant 1). + * Scale from the top left corner of the shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - tribal1 = "Tribal1", + scaleFromTopLeft = "ScaleFromTopLeft", /** - * Represents a border with marquee toothed design. + * Scale from the center of the shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - marqueeToothed = "MarqueeToothed", + scaleFromMiddle = "ScaleFromMiddle", /** - * Represents a border with sharks teeth design. + * Scale from the bottom right corner of the shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - sharksTeeth = "SharksTeeth", + scaleFromBottomRight = "ScaleFromBottomRight", + } + /** + * Represents how Word interprets the rule used to determine the height or width of a {@link Word.Frame}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum FrameSizeRule { /** - * Represents a border with sawtooth design. + * The height or width is set according to the height or width of the item in the frame. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sawtooth = "Sawtooth", + auto = "Auto", /** - * Represents a border with gray sawtooth design. + * The height or width is set to a value equal to or greater than the value specified by the `height` property or `width` property. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sawtoothGray = "SawtoothGray", + atLeast = "AtLeast", /** - * Represents a border with postage stamp design. + * The height or width is set to an exact value specified by the `height` property or `width` property. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - postageStamp = "PostageStamp", + exact = "Exact", + } + /** + * Specifies the border style for an object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum BorderLineStyle { /** - * Represents a border with weaving strips design. + * No line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - weavingStrips = "WeavingStrips", + none = "None", /** - * Represents a border with zigzag design. + * Single line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - zigZag = "ZigZag", + single = "Single", /** - * Represents a border with cross stitch design. + * Dotted line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - crossStitch = "CrossStitch", + dot = "Dot", /** - * Represents a border with gems design. + * Dashed line style with small gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gems = "Gems", + dashSmallGap = "DashSmallGap", /** - * Represents a border with circles and rectangles design. + * Dashed line style with large gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - circlesRectangles = "CirclesRectangles", + dashLargeGap = "DashLargeGap", /** - * Represents a border with corner triangles design. + * Dash-dot line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cornerTriangles = "CornerTriangles", + dashDot = "DashDot", /** - * Represents a border with insects creatures design. + * Dash-dot-dot line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - creaturesInsects = "CreaturesInsects", + dashDotDot = "DashDotDot", /** - * Represents a border with zigzag stitch design. + * Double line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - zigZagStitch = "ZigZagStitch", + double = "Double", /** - * Represents a border with checkered design. + * Triple line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - checkered = "Checkered", + triple = "Triple", /** - * Represents a border with black checked bar design. + * Thin-thick line style with small gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - checkedBarBlack = "CheckedBarBlack", + thinThickSmallGap = "ThinThickSmallGap", /** - * Represents a border with marquee design. + * Thick-thin line style with small gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - marquee = "Marquee", + thickThinSmallGap = "ThickThinSmallGap", /** - * Represents a border with basic white dots design. + * Thin-thick-thin line style with small gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - basicWhiteDots = "BasicWhiteDots", + thinThickThinSmallGap = "ThinThickThinSmallGap", /** - * Represents a border with basic wide midline design. + * Thin-thick line style with medium gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - basicWideMidline = "BasicWideMidline", + thinThickMedGap = "ThinThickMedGap", /** - * Represents a border with basic wide outline design. + * Thick-thin line style with medium gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - basicWideOutline = "BasicWideOutline", + thickThinMedGap = "ThickThinMedGap", /** - * Represents a border with basic wide inline design. + * Thin-thick-thin line style with medium gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - basicWideInline = "BasicWideInline", + thinThickThinMedGap = "ThinThickThinMedGap", /** - * Represents a border with basic thin lines design. + * Thin-thick line style with large gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - basicThinLines = "BasicThinLines", + thinThickLargeGap = "ThinThickLargeGap", /** - * Represents a border with basic white dashes design. + * Thick-thin line style with large gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - basicWhiteDashes = "BasicWhiteDashes", + thickThinLargeGap = "ThickThinLargeGap", /** - * Represents a border with basic white squares design. + * Thin-thick-thin line style with large gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - basicWhiteSquares = "BasicWhiteSquares", + thinThickThinLargeGap = "ThinThickThinLargeGap", /** - * Represents a border with basic black squares design. + * Single wavy line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - basicBlackSquares = "BasicBlackSquares", + singleWavy = "SingleWavy", /** - * Represents a border with basic black dashes design. + * Double wavy line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - basicBlackDashes = "BasicBlackDashes", + doubleWavy = "DoubleWavy", /** - * Represents a border with basic black dots design. + * Dash-dot stroked line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - basicBlackDots = "BasicBlackDots", + dashDotStroked = "DashDotStroked", /** - * Represents a border with top stars design. + * Embossed 3D line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - starsTop = "StarsTop", + emboss3D = "Emboss3D", /** - * Represents a border with certificate banner design. + * Engraved 3D line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - certificateBanner = "CertificateBanner", + engrave3D = "Engrave3D", /** - * Represents a border with handmade design (variant 1). + * Outset line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - handmade1 = "Handmade1", + outset = "Outset", /** - * Represents a border with handmade design (variant 2). + * Inset line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - handmade2 = "Handmade2", + inset = "Inset", + } + /** + * Specifies the width of an object's border. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum LineWidth { /** - * Represents a border with torn paper design. + * Represents a line width of 0.25 points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tornPaper = "TornPaper", + pt025 = "Pt025", /** - * Represents a border with black torn paper design. + * Represents a line width of 0.50 points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tornPaperBlack = "TornPaperBlack", + pt050 = "Pt050", /** - * Represents a border with coupon cutout dashes design. + * Represents a line width of 0.75 points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - couponCutoutDashes = "CouponCutoutDashes", + pt075 = "Pt075", /** - * Represents a border with coupon cutout dots design. + * Represents a line width of 1.00 points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - couponCutoutDots = "CouponCutoutDots", - } - /** - * Specifies the preferred unit of measure to use when measuring the width of an item. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum PreferredWidthType { + pt100 = "Pt100", /** - * Automatically select the unit of measure to use based on the current selection. + * Represents a line width of 1.50 points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - auto = "Auto", + pt150 = "Pt150", /** - * Measure the current item width using a specified percentage. + * Represents a line width of 2.25 points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent = "Percent", + pt225 = "Pt225", /** - * Measure the current item width using a specified number of points. + * Represents a line width of 3.00 points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - points = "Points", - } - /** - * Represents the reading order of text. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ReadingOrder { + pt300 = "Pt300", /** - * Represents right-to-left reading order. + * Represents a line width of 4.50 points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rightToLeft = "RightToLeft", + pt450 = "Pt450", /** - * Represents left-to-right reading order. + * Represents a line width of 6.00 points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - leftToRight = "LeftToRight", + pt600 = "Pt600", } /** - * Specifies the way Word adjusts the table when the left indent is changed. + * Specifies the graphical page border setting of a page. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum RulerStyle { + enum PageBorderArt { /** - * Adjusts the left edge of row or rows, preserving the width of all columns by shifting them to the left or right. This is the default value. + * Represents a border with apple design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + apples = "Apples", /** - * Adjusts the left edge of the first column, preserving the position of the right edge of the table by proportionally adjusting the widths of all the cells in the specified row or rows. + * Represents a border with maple muffin design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - proportional = "Proportional", + mapleMuffins = "MapleMuffins", /** - * Adjusts the left edge of the first column only, preserving the positions of the other columns and the right edge of the table. + * Represents a border with cake slice design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - firstColumn = "FirstColumn", + cakeSlice = "CakeSlice", /** - * Adjusts the left edge of the first column, preserving the position of the right edge of the table by setting the widths of all the cells in the specified row or rows to the same value. + * Represents a border with candy corn design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sameWidth = "SameWidth", - } - /** - * Represents the East Asian language to use when breaking lines of text in the specified document or template. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum FarEastLineBreakLanguageId { + candyCorn = "CandyCorn", /** - * Represents Traditional Chinese language. + * Represents a border with ice cream cone design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - traditionalChinese = "TraditionalChinese", + iceCreamCones = "IceCreamCones", /** - * Represents Japanese language. + * Represents a border with champagne bottle design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - japanese = "Japanese", + champagneBottle = "ChampagneBottle", /** - * Represents Korean language. + * Represents a border with party glass design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - korean = "Korean", + partyGlass = "PartyGlass", /** - * Represents Simplified Chinese language. + * Represents a border with Christmas tree design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - simplifiedChinese = "SimplifiedChinese", - } - /** - * Represents the level of line breaking to use for East Asian languages in the specified document or template. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum FarEastLineBreakLevel { + christmasTree = "ChristmasTree", /** - * Represents the normal line break level. + * Represents a border with trees design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - normal = "Normal", + trees = "Trees", /** - * Represents the strict line break level. + * Represents a border with palm trees in color. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - strict = "Strict", + palmsColor = "PalmsColor", /** - * Represents the custom line break level. + * Represents a border with three-color balloons design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - custom = "Custom", - } - /** - * Specifies the character spacing adjustment for a document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum JustificationMode { + balloons3Colors = "Balloons3Colors", /** - * Expands the character spacing + * Represents a border with hot air balloons design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - expand = "Expand", + balloonsHotAir = "BalloonsHotAir", /** - * Compresses the character spacing. + * Represents a border with party favor design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - compress = "Compress", + partyFavor = "PartyFavor", /** - * Compresses the character spacing using rules of the kana syllabaries, Hiragana and Katakana. + * Represents a border with confetti streamers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - compressKana = "CompressKana", - } - /** - * Specifies the type of template. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum TemplateType { + confettiStreamers = "ConfettiStreamers", /** - * Represents the normal template type. + * Represents a border with hearts design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - normal = "Normal", + hearts = "Hearts", /** - * Represents the global template type. + * Represents a border with heart balloon design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - global = "Global", + heartBalloon = "HeartBalloon", /** - * Represents the attached template type. + * Represents a border with 3D stars design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - attached = "Attached", - } - /** - * Represents the language ID of a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum LanguageId { + stars3D = "Stars3D", /** - * Afrikaans language. + * Represents a border with shadowed stars design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - afrikaans = "Afrikaans", + starsShadowed = "StarsShadowed", /** - * Albanian language. + * Represents a border with stars design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - albanian = "Albanian", + stars = "Stars", /** - * Amharic language. + * Represents a border with sun design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - amharic = "Amharic", + sun = "Sun", /** - * Arabic language. + * Represents a border with Earth design (variant 2). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabic = "Arabic", + earth2 = "Earth2", /** - * Arabic Algerian language. + * Represents a border with Earth design (variant 1). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicAlgeria = "ArabicAlgeria", + earth1 = "Earth1", /** - * Arabic Bahraini language. + * Represents a border with people wearing hats design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicBahrain = "ArabicBahrain", + peopleHats = "PeopleHats", /** - * Arabic Egyptian language. + * Represents a border with sombrero design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicEgypt = "ArabicEgypt", + sombrero = "Sombrero", /** - * Arabic Iraqi language. + * Represents a border with pencils design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicIraq = "ArabicIraq", + pencils = "Pencils", /** - * Arabic Jordanian language. + * Represents a border with packages design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicJordan = "ArabicJordan", + packages = "Packages", /** - * Arabic Kuwaiti language. + * Represents a border with clocks design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicKuwait = "ArabicKuwait", + clocks = "Clocks", /** - * Arabic Lebanese language. + * Represents a border with firecrackers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicLebanon = "ArabicLebanon", + firecrackers = "Firecrackers", /** - * Arabic Libyan language. + * Represents a border with rings design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicLibya = "ArabicLibya", + rings = "Rings", /** - * Arabic Moroccan language. + * Represents a border with map pins design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicMorocco = "ArabicMorocco", + mapPins = "MapPins", /** - * Arabic Omani language. + * Represents a border with confetti design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicOman = "ArabicOman", + confetti = "Confetti", /** - * Arabic Qatari language. + * Represents a border with butterfly creatures design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicQatar = "ArabicQatar", + creaturesButterfly = "CreaturesButterfly", /** - * Arabic Syrian language. + * Represents a border with ladybug creatures design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicSyria = "ArabicSyria", + creaturesLadyBug = "CreaturesLadyBug", /** - * Arabic Tunisian language. + * Represents a border with fish creatures design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicTunisia = "ArabicTunisia", + creaturesFish = "CreaturesFish", /** - * Arabic United Arab Emirates language. + * Represents a border with birds in flight design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicUAE = "ArabicUAE", + birdsFlight = "BirdsFlight", /** - * Arabic Yemeni language. + * Represents a border with scared cat design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicYemen = "ArabicYemen", + scaredCat = "ScaredCat", /** - * Armenian language. + * Represents a border with bats design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - armenian = "Armenian", + bats = "Bats", /** - * Assamese language. + * Represents a border with roses flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - assamese = "Assamese", + flowersRoses = "FlowersRoses", /** - * Azerbaijani Cyrillic language. + * Represents a border with red rose flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - azeriCyrillic = "AzeriCyrillic", + flowersRedRose = "FlowersRedRose", /** - * Azerbaijani Latin language. + * Represents a border with poinsettias flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - azeriLatin = "AzeriLatin", + poinsettias = "Poinsettias", /** - * Basque (Basque). + * Represents a border with holly design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - basque = "Basque", + holly = "Holly", /** - * Belgian Dutch language. + * Represents a border with tiny flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - belgianDutch = "BelgianDutch", + flowersTiny = "FlowersTiny", /** - * Belgian French language. + * Represents a border with pansy flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - belgianFrench = "BelgianFrench", + flowersPansy = "FlowersPansy", /** - * Bengali language. + * Represents a border with modern 2 flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bengali = "Bengali", + flowersModern2 = "FlowersModern2", /** - * Bulgarian language. + * Represents a border with modern 1 flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bulgarian = "Bulgarian", + flowersModern1 = "FlowersModern1", /** - * Burmese language. + * Represents a border with white flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - burmese = "Burmese", + whiteFlowers = "WhiteFlowers", /** - * Belarusian language. + * Represents a border with vine design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - belarusian = "Belarusian", + vine = "Vine", /** - * Catalan language. + * Represents a border with daisies flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - catalan = "Catalan", + flowersDaisies = "FlowersDaisies", /** - * Cherokee language. + * Represents a border with block print flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cherokee = "Cherokee", + flowersBlockPrint = "FlowersBlockPrint", /** - * Chinese Hong Kong SAR language. + * Represents a border with colored deco arch design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - chineseHongKongSAR = "ChineseHongKongSAR", + decoArchColor = "DecoArchColor", /** - * Chinese Macao SAR language. + * Represents a border with fans design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - chineseMacaoSAR = "ChineseMacaoSAR", + fans = "Fans", /** - * Chinese Singapore language. + * Represents a border with film design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - chineseSingapore = "ChineseSingapore", + film = "Film", /** - * Croatian language. + * Represents a border with lightning design (variant 1). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - croatian = "Croatian", + lightning1 = "Lightning1", /** - * Czech language. + * Represents a border with compass design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - czech = "Czech", + compass = "Compass", /** - * Danish language. + * Represents a border with double D design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - danish = "Danish", + doubleD = "DoubleD", /** - * Divehi language. + * Represents a border with classical wave design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - divehi = "Divehi", + classicalWave = "ClassicalWave", /** - * Dutch language. + * Represents a border with shadowed squares design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dutch = "Dutch", + shadowedSquares = "ShadowedSquares", /** - * Edo language. + * Represents a border with twisted lines design (variant 1). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - edo = "Edo", + twistedLines1 = "TwistedLines1", /** - * Australian English language. + * Represents a border with waveline design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - englishAUS = "EnglishAUS", + waveline = "Waveline", /** - * Belize English language. + * Represents a border with quadrants design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - englishBelize = "EnglishBelize", + quadrants = "Quadrants", /** - * Canadian English language. + * Represents a border with colored checked bar design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - englishCanadian = "EnglishCanadian", + checkedBarColor = "CheckedBarColor", /** - * Caribbean English language. + * Represents a border with swirligig design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - englishCaribbean = "EnglishCaribbean", + swirligig = "Swirligig", /** - * Indonesian English language. + * Represents a border with push pin note design (variant 1). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - englishIndonesia = "EnglishIndonesia", + pushPinNote1 = "PushPinNote1", /** - * Irish English language. + * Represents a border with push pin note design (variant 2). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - englishIreland = "EnglishIreland", + pushPinNote2 = "PushPinNote2", /** - * Jamaican English language. + * Represents a border with pumpkin design (variant 1). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - englishJamaica = "EnglishJamaica", + pumpkin1 = "Pumpkin1", /** - * New Zealand English language. + * Represents a border with black eggs design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - englishNewZealand = "EnglishNewZealand", + eggsBlack = "EggsBlack", /** - * Filipino English language. + * Represents a border with cup design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - englishPhilippines = "EnglishPhilippines", + cup = "Cup", /** - * South African English language. + * Represents a border with gray heart design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - englishSouthAfrica = "EnglishSouthAfrica", + heartGray = "HeartGray", /** - * Tobago Trinidad English language. + * Represents a border with gingerbread man design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - englishTrinidadTobago = "EnglishTrinidadTobago", + gingerbreadMan = "GingerbreadMan", /** - * United Kingdom English language. + * Represents a border with baby pacifier design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - englishUK = "EnglishUK", + babyPacifier = "BabyPacifier", /** - * United States English language. + * Represents a border with baby rattle design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - englishUS = "EnglishUS", + babyRattle = "BabyRattle", /** - * Zimbabwe English language. + * Represents a border with cabins design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - englishZimbabwe = "EnglishZimbabwe", + cabins = "Cabins", /** - * Estonian language. + * Represents a border with funky house design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - estonian = "Estonian", + houseFunky = "HouseFunky", /** - * Faeroese language. + * Represents a border with black stars design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - faeroese = "Faeroese", + starsBlack = "StarsBlack", /** - * Filipino language. + * Represents a border with snowflakes design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - filipino = "Filipino", + snowflakes = "Snowflakes", /** - * Finnish language. + * Represents a border with fancy snowflake design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - finnish = "Finnish", + snowflakeFancy = "SnowflakeFancy", /** - * French language. + * Represents a border with skyrocket design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - french = "French", + skyrocket = "Skyrocket", /** - * French Cameroon language. + * Represents a border with Seattle design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - frenchCameroon = "FrenchCameroon", + seattle = "Seattle", /** - * French Canadian language. + * Represents a border with music notes design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - frenchCanadian = "FrenchCanadian", + musicNotes = "MusicNotes", /** - * French (Congo (DRC)) language. + * Represents a border with black palms design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - frenchCongoDRC = "FrenchCongoDRC", + palmsBlack = "PalmsBlack", /** - * French Cote d'Ivoire language. + * Represents a border with maple leaf design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - frenchCotedIvoire = "FrenchCotedIvoire", + mapleLeaf = "MapleLeaf", /** - * French Haiti language. + * Represents a border with paper clips design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - frenchHaiti = "FrenchHaiti", + paperClips = "PaperClips", /** - * French Luxembourg language. + * Represents a border with shorebird tracks design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - frenchLuxembourg = "FrenchLuxembourg", + shorebirdTracks = "ShorebirdTracks", /** - * French Mali language. + * Represents a border with people design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - frenchMali = "FrenchMali", + people = "People", /** - * French Monaco language. + * Represents a border with people waving design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - frenchMonaco = "FrenchMonaco", + peopleWaving = "PeopleWaving", /** - * French Morocco language. + * Represents a border with eclipsing squares design (variant 2). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - frenchMorocco = "FrenchMorocco", + eclipsingSquares2 = "EclipsingSquares2", /** - * French Reunion language. + * Represents a border with hypnotic design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - frenchReunion = "FrenchReunion", + hypnotic = "Hypnotic", /** - * French Senegal language. + * Represents a border with gray diamonds design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - frenchSenegal = "FrenchSenegal", + diamondsGray = "DiamondsGray", /** - * French West Indies language. + * Represents a border with deco arch design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - frenchWestIndies = "FrenchWestIndies", + decoArch = "DecoArch", /** - * Frisian Netherlands language. + * Represents a border with deco blocks design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - frisianNetherlands = "FrisianNetherlands", + decoBlocks = "DecoBlocks", /** - * Fulfulde language. + * Represents a border with circles and lines design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fulfulde = "Fulfulde", + circlesLines = "CirclesLines", /** - * Irish (Irish) language. + * Represents a border with papyrus design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gaelicIreland = "GaelicIreland", + papyrus = "Papyrus", /** - * Scottish Gaelic language. + * Represents a border with woodwork design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gaelicScotland = "GaelicScotland", + woodwork = "Woodwork", /** - * Galician language. + * Represents a border with weaving braid design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - galician = "Galician", + weavingBraid = "WeavingBraid", /** - * Georgian language. + * Represents a border with weaving ribbon design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - georgian = "Georgian", + weavingRibbon = "WeavingRibbon", /** - * German language. + * Represents a border with weaving angles design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - german = "German", + weavingAngles = "WeavingAngles", /** - * German Austrian language. + * Represents a border with arched scallops design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - germanAustria = "GermanAustria", + archedScallops = "ArchedScallops", /** - * German Liechtenstein language. + * Represents a border with safari design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - germanLiechtenstein = "GermanLiechtenstein", + safari = "Safari", /** - * German Luxembourg language. + * Represents a border with Celtic knotwork design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - germanLuxembourg = "GermanLuxembourg", + celticKnotwork = "CelticKnotwork", /** - * Greek language. + * Represents a border with crazy maze design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - greek = "Greek", + crazyMaze = "CrazyMaze", /** - * Guarani language. + * Represents a border with eclipsing squares design (variant 1). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - guarani = "Guarani", + eclipsingSquares1 = "EclipsingSquares1", /** - * Gujarati language. + * Represents a border with birds design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gujarati = "Gujarati", + birds = "Birds", /** - * Hausa language. + * Represents a border with teacup and flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hausa = "Hausa", + flowersTeacup = "FlowersTeacup", /** - * Hawaiian language. + * Represents a border with northwest design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hawaiian = "Hawaiian", + northwest = "Northwest", /** - * Hebrew language. + * Represents a border with southwest design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hebrew = "Hebrew", + southwest = "Southwest", /** - * Hindi language. + * Represents a border with tribal design (variant 6). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hindi = "Hindi", + tribal6 = "Tribal6", /** - * Hungarian language. + * Represents a border with tribal design (variant 4). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hungarian = "Hungarian", + tribal4 = "Tribal4", /** - * Ibibio language. + * Represents a border with tribal design (variant 3). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - ibibio = "Ibibio", + tribal3 = "Tribal3", /** - * Icelandic language. + * Represents a border with tribal design (variant 2). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - icelandic = "Icelandic", + tribal2 = "Tribal2", /** - * Igbo language. + * Represents a border with tribal design (variant 5). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - igbo = "Igbo", + tribal5 = "Tribal5", /** - * Indonesian language. + * Represents a border with X illusions design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - indonesian = "Indonesian", + xillusions = "XIllusions", /** - * Inuktitut language. + * Represents a border with zany triangles design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - inuktitut = "Inuktitut", + zanyTriangles = "ZanyTriangles", /** - * Italian language. + * Represents a border with pyramids design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - italian = "Italian", + pyramids = "Pyramids", /** - * Japanese language. + * Represents a border with pyramids above design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - japanese = "Japanese", + pyramidsAbove = "PyramidsAbove", /** - * Kannada language. + * Represents a border with gray confetti design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - kannada = "Kannada", + confettiGrays = "ConfettiGrays", /** - * Kanuri language. + * Represents a border with outline confetti design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - kanuri = "Kanuri", + confettiOutline = "ConfettiOutline", /** - * Kashmiri language. + * Represents a border with white confetti design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - kashmiri = "Kashmiri", + confettiWhite = "ConfettiWhite", /** - * Kazakh language. + * Represents a border with mosaic design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - kazakh = "Kazakh", + mosaic = "Mosaic", /** - * Khmer language. + * Represents a border with lightning design (variant 2). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - khmer = "Khmer", + lightning2 = "Lightning2", /** - * Kirghiz language. + * Represents a border with heebie jeebies design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - kirghiz = "Kirghiz", + heebieJeebies = "HeebieJeebies", /** - * Konkani language. + * Represents a border with light bulb design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - konkani = "Konkani", + lightBulb = "LightBulb", /** - * Korean language. + * Represents a border with gradient design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - korean = "Korean", + gradient = "Gradient", /** - * Kyrgyz language. + * Represents a border with triangle party design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - kyrgyz = "Kyrgyz", + triangleParty = "TriangleParty", /** - * No specified language. + * Represents a border with twisted lines design (variant 2). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageNone = "LanguageNone", + twistedLines2 = "TwistedLines2", /** - * Lao language. + * Represents a border with moons design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lao = "Lao", + moons = "Moons", /** - * Latin language. + * Represents a border with ovals design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - latin = "Latin", + ovals = "Ovals", /** - * Latvian language. + * Represents a border with double diamonds design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - latvian = "Latvian", + doubleDiamonds = "DoubleDiamonds", /** - * Lithuanian language. + * Represents a border with chain link design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lithuanian = "Lithuanian", + chainLink = "ChainLink", /** - * Macedonian language. + * Represents a border with triangles design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - macedonianFYROM = "MacedonianFYROM", + triangles = "Triangles", /** - * Malayalam language. + * Represents a border with tribal design (variant 1). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - malayalam = "Malayalam", + tribal1 = "Tribal1", /** - * Malay Brunei Darussalam language. + * Represents a border with marquee toothed design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - malayBruneiDarussalam = "MalayBruneiDarussalam", + marqueeToothed = "MarqueeToothed", /** - * Malaysian language. + * Represents a border with sharks teeth design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - malaysian = "Malaysian", + sharksTeeth = "SharksTeeth", /** - * Maltese language. + * Represents a border with sawtooth design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - maltese = "Maltese", + sawtooth = "Sawtooth", /** - * Manipuri language. + * Represents a border with gray sawtooth design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - manipuri = "Manipuri", + sawtoothGray = "SawtoothGray", /** - * Marathi language. + * Represents a border with postage stamp design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - marathi = "Marathi", + postageStamp = "PostageStamp", /** - * Mexican Spanish language. + * Represents a border with weaving strips design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mexicanSpanish = "MexicanSpanish", + weavingStrips = "WeavingStrips", /** - * Mongolian language. + * Represents a border with zigzag design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mongolian = "Mongolian", + zigZag = "ZigZag", /** - * Nepali language. + * Represents a border with cross stitch design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nepali = "Nepali", + crossStitch = "CrossStitch", /** - * Disables proofing if the language ID identifies a language in which an object is grammatically validated using the Microsoft Word proofing tools. + * Represents a border with gems design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - noProofing = "NoProofing", + gems = "Gems", /** - * Norwegian Bokmol language. + * Represents a border with circles and rectangles design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - norwegianBokmol = "NorwegianBokmol", + circlesRectangles = "CirclesRectangles", /** - * Norwegian Nynorsk language. + * Represents a border with corner triangles design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - norwegianNynorsk = "NorwegianNynorsk", + cornerTriangles = "CornerTriangles", /** - * Odia (Oriya) language. + * Represents a border with insects creatures design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - oriya = "Oriya", + creaturesInsects = "CreaturesInsects", /** - * Oromo language. + * Represents a border with zigzag stitch design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - oromo = "Oromo", + zigZagStitch = "ZigZagStitch", /** - * Pashto language. + * Represents a border with checkered design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pashto = "Pashto", + checkered = "Checkered", /** - * Persian language. + * Represents a border with black checked bar design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - persian = "Persian", + checkedBarBlack = "CheckedBarBlack", /** - * Polish language. + * Represents a border with marquee design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - polish = "Polish", + marquee = "Marquee", /** - * Portuguese language. + * Represents a border with basic white dots design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - portuguese = "Portuguese", + basicWhiteDots = "BasicWhiteDots", /** - * Portuguese (Brazil) language. + * Represents a border with basic wide midline design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - portugueseBrazil = "PortugueseBrazil", + basicWideMidline = "BasicWideMidline", /** - * Punjabi language. + * Represents a border with basic wide outline design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - punjabi = "Punjabi", + basicWideOutline = "BasicWideOutline", /** - * Rhaeto Romanic language. + * Represents a border with basic wide inline design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rhaetoRomanic = "RhaetoRomanic", + basicWideInline = "BasicWideInline", /** - * Romanian language. + * Represents a border with basic thin lines design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - romanian = "Romanian", + basicThinLines = "BasicThinLines", /** - * Romanian Moldova language. + * Represents a border with basic white dashes design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - romanianMoldova = "RomanianMoldova", + basicWhiteDashes = "BasicWhiteDashes", /** - * Russian language. + * Represents a border with basic white squares design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - russian = "Russian", + basicWhiteSquares = "BasicWhiteSquares", /** - * Russian Moldova language. + * Represents a border with basic black squares design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - russianMoldova = "RussianMoldova", + basicBlackSquares = "BasicBlackSquares", /** - * Sami Lappish language. + * Represents a border with basic black dashes design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - samiLappish = "SamiLappish", + basicBlackDashes = "BasicBlackDashes", /** - * Sanskrit language. + * Represents a border with basic black dots design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sanskrit = "Sanskrit", + basicBlackDots = "BasicBlackDots", /** - * Serbian Cyrillic language. + * Represents a border with top stars design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - serbianCyrillic = "SerbianCyrillic", + starsTop = "StarsTop", /** - * Serbian Latin language. + * Represents a border with certificate banner design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - serbianLatin = "SerbianLatin", + certificateBanner = "CertificateBanner", /** - * Sesotho language. + * Represents a border with handmade design (variant 1). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sesotho = "Sesotho", + handmade1 = "Handmade1", /** - * Simplified Chinese language. + * Represents a border with handmade design (variant 2). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - simplifiedChinese = "SimplifiedChinese", + handmade2 = "Handmade2", /** - * Sindhi language. + * Represents a border with torn paper design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sindhi = "Sindhi", + tornPaper = "TornPaper", /** - * Sindhi (Pakistan) language. + * Represents a border with black torn paper design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sindhiPakistan = "SindhiPakistan", + tornPaperBlack = "TornPaperBlack", /** - * Sinhalese language. + * Represents a border with coupon cutout dashes design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sinhalese = "Sinhalese", + couponCutoutDashes = "CouponCutoutDashes", /** - * Slovakian language. + * Represents a border with coupon cutout dots design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - slovak = "Slovak", + couponCutoutDots = "CouponCutoutDots", + } + /** + * Specifies the preferred unit of measure to use when measuring the width of an item. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PreferredWidthType { /** - * Slovenian language. + * Automatically select the unit of measure to use based on the current selection. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - slovenian = "Slovenian", + auto = "Auto", /** - * Somali language. + * Measure the current item width using a specified percentage. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - somali = "Somali", + percent = "Percent", /** - * Sorbian language. + * Measure the current item width using a specified number of points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sorbian = "Sorbian", + points = "Points", + } + /** + * Represents the reading order of text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ReadingOrder { /** - * Spanish language. + * Represents right-to-left reading order. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spanish = "Spanish", + rightToLeft = "RightToLeft", /** - * Spanish Argentina language. + * Represents left-to-right reading order. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spanishArgentina = "SpanishArgentina", + leftToRight = "LeftToRight", + } + /** + * Specifies the way Word adjusts the table when the left indent is changed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum RulerStyle { /** - * Spanish Bolivian language. + * Adjusts the left edge of row or rows, preserving the width of all columns by shifting them to the left or right. This is the default value. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spanishBolivia = "SpanishBolivia", + none = "None", /** - * Spanish Chilean language. + * Adjusts the left edge of the first column, preserving the position of the right edge of the table by proportionally adjusting the widths of all the cells in the specified row or rows. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spanishChile = "SpanishChile", + proportional = "Proportional", /** - * Spanish Colombian language. + * Adjusts the left edge of the first column only, preserving the positions of the other columns and the right edge of the table. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spanishColombia = "SpanishColombia", + firstColumn = "FirstColumn", /** - * Spanish Costa Rican language. + * Adjusts the left edge of the first column, preserving the position of the right edge of the table by setting the widths of all the cells in the specified row or rows to the same value. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spanishCostaRica = "SpanishCostaRica", + sameWidth = "SameWidth", + } + /** + * Represents the East Asian language to use when breaking lines of text in the specified document or template. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum FarEastLineBreakLanguageId { /** - * Spanish Dominican Republic language. + * Represents Traditional Chinese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spanishDominicanRepublic = "SpanishDominicanRepublic", + traditionalChinese = "TraditionalChinese", /** - * Spanish Ecuadorian language. + * Represents Japanese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spanishEcuador = "SpanishEcuador", + japanese = "Japanese", /** - * Spanish El Salvadorian language. + * Represents Korean language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spanishElSalvador = "SpanishElSalvador", + korean = "Korean", /** - * Spanish Guatemala language. + * Represents Simplified Chinese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spanishGuatemala = "SpanishGuatemala", + simplifiedChinese = "SimplifiedChinese", + } + /** + * Represents the level of line breaking to use for East Asian languages in the specified document or template. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum FarEastLineBreakLevel { /** - * Spanish Honduran language. + * Represents the normal line break level. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spanishHonduras = "SpanishHonduras", + normal = "Normal", /** - * Spanish Modern Sort language. + * Represents the strict line break level. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spanishModernSort = "SpanishModernSort", + strict = "Strict", /** - * Spanish Nicaraguan language. + * Represents the custom line break level. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spanishNicaragua = "SpanishNicaragua", + custom = "Custom", + } + /** + * Specifies the character spacing adjustment for a document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum JustificationMode { /** - * Spanish Panamanian language. + * Expands the character spacing * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spanishPanama = "SpanishPanama", + expand = "Expand", /** - * Spanish Paraguayan language. + * Compresses the character spacing. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spanishParaguay = "SpanishParaguay", + compress = "Compress", /** - * Spanish Peruvian language. + * Compresses the character spacing using rules of the kana syllabaries, Hiragana and Katakana. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spanishPeru = "SpanishPeru", + compressKana = "CompressKana", + } + /** + * Specifies the type of template. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum TemplateType { /** - * Spanish Puerto Rican language. + * Represents the normal template type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spanishPuertoRico = "SpanishPuertoRico", + normal = "Normal", /** - * Spanish Uruguayan language. + * Represents the global template type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spanishUruguay = "SpanishUruguay", + global = "Global", /** - * Spanish Venezuelan language. + * Represents the attached template type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spanishVenezuela = "SpanishVenezuela", + attached = "Attached", + } + /** + * Represents the language ID of a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum LanguageId { /** - * Sutu language. + * Afrikaans language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sutu = "Sutu", + afrikaans = "Afrikaans", /** - * Swahili language. + * Albanian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - swahili = "Swahili", + albanian = "Albanian", /** - * Swedish language. + * Amharic language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - swedish = "Swedish", + amharic = "Amharic", /** - * Swedish Finnish language. + * Arabic language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - swedishFinland = "SwedishFinland", + arabic = "Arabic", /** - * Swiss French language. + * Arabic Algerian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - swissFrench = "SwissFrench", + arabicAlgeria = "ArabicAlgeria", /** - * Swiss German language. + * Arabic Bahraini language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - swissGerman = "SwissGerman", + arabicBahrain = "ArabicBahrain", /** - * Swiss Italian language. + * Arabic Egyptian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - swissItalian = "SwissItalian", + arabicEgypt = "ArabicEgypt", /** - * Syriac language. + * Arabic Iraqi language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - syriac = "Syriac", + arabicIraq = "ArabicIraq", /** - * Tajik language. + * Arabic Jordanian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tajik = "Tajik", + arabicJordan = "ArabicJordan", /** - * Tamazight language. + * Arabic Kuwaiti language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tamazight = "Tamazight", + arabicKuwait = "ArabicKuwait", /** - * Tamazight Latin language. + * Arabic Lebanese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tamazightLatin = "TamazightLatin", + arabicLebanon = "ArabicLebanon", /** - * Tamil language. + * Arabic Libyan language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tamil = "Tamil", + arabicLibya = "ArabicLibya", /** - * Tatar language. + * Arabic Moroccan language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tatar = "Tatar", + arabicMorocco = "ArabicMorocco", /** - * Telugu language. + * Arabic Omani language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - telugu = "Telugu", + arabicOman = "ArabicOman", /** - * Thai language. + * Arabic Qatari language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thai = "Thai", + arabicQatar = "ArabicQatar", /** - * Tibetan language. + * Arabic Syrian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tibetan = "Tibetan", + arabicSyria = "ArabicSyria", /** - * Tigrigna Eritrea language. + * Arabic Tunisian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tigrignaEritrea = "TigrignaEritrea", + arabicTunisia = "ArabicTunisia", /** - * Tigrigna Ethiopic language. + * Arabic United Arab Emirates language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tigrignaEthiopic = "TigrignaEthiopic", + arabicUAE = "ArabicUAE", /** - * Traditional Chinese language. + * Arabic Yemeni language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - traditionalChinese = "TraditionalChinese", + arabicYemen = "ArabicYemen", /** - * Tsonga language. + * Armenian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tsonga = "Tsonga", + armenian = "Armenian", /** - * Tswana language. + * Assamese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tswana = "Tswana", + assamese = "Assamese", /** - * Turkish language. + * Azerbaijani Cyrillic language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - turkish = "Turkish", + azeriCyrillic = "AzeriCyrillic", /** - * Turkmen language. + * Azerbaijani Latin language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - turkmen = "Turkmen", + azeriLatin = "AzeriLatin", /** - * Ukrainian language. + * Basque (Basque). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - ukrainian = "Ukrainian", + basque = "Basque", /** - * Urdu language. + * Belgian Dutch language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - urdu = "Urdu", + belgianDutch = "BelgianDutch", /** - * Uzbek Cyrillic language. + * Belgian French language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - uzbekCyrillic = "UzbekCyrillic", + belgianFrench = "BelgianFrench", /** - * Uzbek Latin language. + * Bengali language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - uzbekLatin = "UzbekLatin", + bengali = "Bengali", /** - * Venda language. + * Bulgarian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - venda = "Venda", + bulgarian = "Bulgarian", /** - * Vietnamese language. + * Burmese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - vietnamese = "Vietnamese", + burmese = "Burmese", /** - * Welsh language. + * Belarusian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - welsh = "Welsh", + belarusian = "Belarusian", /** - * Xhosa language. + * Catalan language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xhosa = "Xhosa", + catalan = "Catalan", /** - * Yi language. + * Cherokee language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - yi = "Yi", + cherokee = "Cherokee", /** - * Yiddish language. + * Chinese Hong Kong SAR language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - yiddish = "Yiddish", + chineseHongKongSAR = "ChineseHongKongSAR", /** - * Yoruba language. + * Chinese Macao SAR language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - yoruba = "Yoruba", + chineseMacaoSAR = "ChineseMacaoSAR", /** - * Zulu language. + * Chinese Singapore language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - zulu = "Zulu", - } - /** - * Specifies how a building block is inserted into a document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum DocPartInsertType { + chineseSingapore = "ChineseSingapore", /** - * Inserts the content of the building block. + * Croatian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - content = "Content", + croatian = "Croatian", /** - * Inserts the building block as a paragraph. + * Czech language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - paragraph = "Paragraph", + czech = "Czech", /** - * Inserts the building block as a page. + * Danish language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - page = "Page", - } - /** - * Specifies the type of building block. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum BuildingBlockType { + danish = "Danish", /** - * Represents Quick Parts building block type. + * Divehi language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - quickParts = "QuickParts", + divehi = "Divehi", /** - * Represents Cover Page building block type. + * Dutch language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - coverPage = "CoverPage", + dutch = "Dutch", /** - * Represents Equations building block type. + * Edo language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - equations = "Equations", + edo = "Edo", /** - * Represents Footers building block type. + * Australian English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footers = "Footers", + englishAUS = "EnglishAUS", /** - * Represents Headers building block type. + * Belize English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - headers = "Headers", + englishBelize = "EnglishBelize", /** - * Represents Page Number building block type. + * Canadian English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageNumber = "PageNumber", + englishCanadian = "EnglishCanadian", /** - * Represents Tables building block type. + * Caribbean English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tables = "Tables", + englishCaribbean = "EnglishCaribbean", /** - * Represents Watermarks building block type. + * Indonesian English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - watermarks = "Watermarks", + englishIndonesia = "EnglishIndonesia", /** - * Represents AutoText building block type. + * Irish English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - autoText = "AutoText", + englishIreland = "EnglishIreland", /** - * Represents Text Box building block type. + * Jamaican English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textBox = "TextBox", + englishJamaica = "EnglishJamaica", /** - * Represents Page Number Top building block type. + * New Zealand English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageNumberTop = "PageNumberTop", + englishNewZealand = "EnglishNewZealand", /** - * Represents Page Number Bottom building block type. + * Filipino English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageNumberBottom = "PageNumberBottom", + englishPhilippines = "EnglishPhilippines", /** - * Represents Page Number Page building block type. + * South African English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageNumberPage = "PageNumberPage", + englishSouthAfrica = "EnglishSouthAfrica", /** - * Represents Table of Contents building block type. + * Tobago Trinidad English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tableOfContents = "TableOfContents", + englishTrinidadTobago = "EnglishTrinidadTobago", /** - * Represents Custom Quick Parts building block type. + * United Kingdom English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customQuickParts = "CustomQuickParts", + englishUK = "EnglishUK", /** - * Represents Custom Cover Page building block type. + * United States English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customCoverPage = "CustomCoverPage", + englishUS = "EnglishUS", /** - * Represents Custom Equations building block type. + * Zimbabwe English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customEquations = "CustomEquations", + englishZimbabwe = "EnglishZimbabwe", /** - * Represents Custom Footers building block type. + * Estonian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customFooters = "CustomFooters", + estonian = "Estonian", /** - * Represents Custom Headers building block type. + * Faeroese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customHeaders = "CustomHeaders", + faeroese = "Faeroese", /** - * Represents Custom Page Number building block type. + * Filipino language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customPageNumber = "CustomPageNumber", + filipino = "Filipino", /** - * Represents Custom Tables building block type. + * Finnish language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customTables = "CustomTables", + finnish = "Finnish", /** - * Represents Custom Watermarks building block type. + * French language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customWatermarks = "CustomWatermarks", + french = "French", /** - * Represents Custom AutoText building block type. + * French Cameroon language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customAutoText = "CustomAutoText", + frenchCameroon = "FrenchCameroon", /** - * Represents Custom Text Box building block type. + * French Canadian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customTextBox = "CustomTextBox", + frenchCanadian = "FrenchCanadian", /** - * Represents Custom Page Number Top building block type. + * French (Congo (DRC)) language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customPageNumberTop = "CustomPageNumberTop", + frenchCongoDRC = "FrenchCongoDRC", /** - * Represents Custom Page Number Bottom building block type. + * French Cote d'Ivoire language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customPageNumberBottom = "CustomPageNumberBottom", + frenchCotedIvoire = "FrenchCotedIvoire", /** - * Represents Custom Page Number Page building block type. + * French Haiti language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customPageNumberPage = "CustomPageNumberPage", + frenchHaiti = "FrenchHaiti", /** - * Represents Custom Table of Contents building block type. + * French Luxembourg language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customTableOfContents = "CustomTableOfContents", + frenchLuxembourg = "FrenchLuxembourg", /** - * Represents Custom building block type 1. + * French Mali language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - custom1 = "Custom1", + frenchMali = "FrenchMali", /** - * Represents Custom building block type 2. + * French Monaco language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - custom2 = "Custom2", + frenchMonaco = "FrenchMonaco", /** - * Represents Custom building block type 3. + * French Morocco language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - custom3 = "Custom3", + frenchMorocco = "FrenchMorocco", /** - * Represents Custom building block type 4. + * French Reunion language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - custom4 = "Custom4", + frenchReunion = "FrenchReunion", /** - * Represents Custom building block type 5. + * French Senegal language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - custom5 = "Custom5", + frenchSenegal = "FrenchSenegal", /** - * Represents Bibliography building block type. + * French West Indies language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bibliography = "Bibliography", + frenchWestIndies = "FrenchWestIndies", /** - * Represents Custom Bibliography building block type. + * Frisian Netherlands language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customBibliography = "CustomBibliography", - } - /** - * Represents the type of a {@link Word.CustomXmlValidationError}. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum CustomXmlValidationErrorType { + frisianNetherlands = "FrisianNetherlands", /** - * Represents a validation error generated by the schema. + * Fulfulde language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - schemaGenerated = "schemaGenerated", + fulfulde = "Fulfulde", /** - * Represents a validation error that is automatically cleared. + * Irish (Irish) language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - automaticallyCleared = "automaticallyCleared", + gaelicIreland = "GaelicIreland", /** - * Represents a validation error that is manually created. + * Scottish Gaelic language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - manual = "manual", - } - /** - * Represents the type of a {@link Word.CustomXmlNode}. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum CustomXmlNodeType { + gaelicScotland = "GaelicScotland", /** - * Represents an XML element node. + * Galician language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - element = "element", + galician = "Galician", /** - * Represents an XML attribute node. + * Georgian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - attribute = "attribute", + georgian = "Georgian", /** - * Represents an XML text node. + * German language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - text = "text", + german = "German", /** - * Represents an XML CDATA section node. + * German Austrian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cData = "cData", + germanAustria = "GermanAustria", /** - * Represents an XML processing instruction node. + * German Liechtenstein language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - processingInstruction = "processingInstruction", + germanLiechtenstein = "GermanLiechtenstein", /** - * Represents an XML comment node. + * German Luxembourg language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - comment = "comment", + germanLuxembourg = "GermanLuxembourg", /** - * Represents an XML document node. + * Greek language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - document = "document", - } - /** - * Specifies the type of link. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum LinkType { + greek = "Greek", /** - * OLE object. + * Guarani language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - ole = "Ole", + guarani = "Guarani", /** - * Picture. + * Gujarati language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - picture = "Picture", + gujarati = "Gujarati", /** - * Text. + * Hausa language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - text = "Text", + hausa = "Hausa", /** - * Reference library. + * Hawaiian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - reference = "Reference", + hawaiian = "Hawaiian", /** - * Include file. + * Hebrew language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - include = "Include", + hebrew = "Hebrew", /** - * Import file. + * Hindi language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - import = "Import", + hindi = "Hindi", /** - * Dynamic Data Exchange. + * Hungarian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dde = "Dde", + hungarian = "Hungarian", /** - * Automatic DDE. + * Ibibio language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - ddeAuto = "DdeAuto", + ibibio = "Ibibio", /** - * Microsoft Excel chart. + * Icelandic language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - chart = "Chart", - } - /** - * Specifies the action associated with the verb that the OLE object should perform. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum OleVerb { + icelandic = "Icelandic", /** - * Performs the verb that is invoked when the user double-clicks the object. + * Igbo language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - primary = "Primary", + igbo = "Igbo", /** - * Shows the object to the user for editing or viewing. Use it to show a newly inserted object for initial editing. + * Indonesian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - show = "Show", + indonesian = "Indonesian", /** - * Opens the object in a separate window. + * Inuktitut language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - open = "Open", + inuktitut = "Inuktitut", /** - * Removes the object's user interface from view. + * Italian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hide = "Hide", + italian = "Italian", /** - * Activates the object in place and displays any user-interface tools that the object needs, such as menus or toolbars. + * Japanese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - uiActivate = "UiActivate", + japanese = "Japanese", /** - * Runs the object and installs its window, but doesn't install any user-interface tools. + * Kannada language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - inPlaceActivate = "InPlaceActivate", + kannada = "Kannada", /** - * Forces the object to discard any undo state that it might be maintaining; note that the object remains active, however. + * Kanuri language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - discardUndoState = "DiscardUndoState", - } - /** - * Represents the list formatting characteristics of a range. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class ListFormat 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; + kanuri = "Kanuri", /** - * Returns a `List` object that represents the first formatted list contained in the `ListFormat` object. - * + * Kashmiri language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly list: Word.List; + kashmiri = "Kashmiri", /** - * Gets the list template associated with the `ListFormat` object. - * + * Kazakh language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly listTemplate: Word.ListTemplate; + kazakh = "Kazakh", /** - * Indicates whether the `ListFormat` object contains a single list. - * + * Khmer language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly isSingleList: boolean; + khmer = "Khmer", /** - * Indicates whether the `ListFormat` object contains a single list template. - * + * Kirghiz language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly isSingleListTemplate: boolean; + kirghiz = "Kirghiz", /** - * Specifies the list level number for the first paragraph for the `ListFormat` object. - * + * Konkani language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listLevelNumber: number; + konkani = "Konkani", /** - * Gets the string representation of the list value of the first paragraph in the range for the `ListFormat` object. - * + * Korean language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly listString: string; + korean = "Korean", /** - * Gets the type of the list for the `ListFormat` object. - * + * Kyrgyz language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly listType: Word.ListType | "ListNoNumbering" | "ListListNumOnly" | "ListBullet" | "ListSimpleNumbering" | "ListOutlineNumbering" | "ListMixedNumbering" | "ListPictureBullet"; + kyrgyz = "Kyrgyz", /** - * Gets the numeric value of the the first paragraph in the range for the `ListFormat` object. - * + * No specified language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly listValue: number; - /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. - */ - set(properties: Interfaces.ListFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ListFormat): void; + languageNone = "LanguageNone", /** - * Adds bullets and formatting to the paragraphs in the range. - * + * Lao language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param defaultListBehavior - Optional. Specifies the default list behavior. Default is `DefaultListBehavior.word97`. */ - applyBulletDefault(defaultListBehavior: Word.DefaultListBehavior): void; + lao = "Lao", /** - * Adds bullets and formatting to the paragraphs in the range. - * + * Latin language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param defaultListBehavior - Optional. Specifies the default list behavior. Default is `DefaultListBehavior.word97`. */ - applyBulletDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void; + latin = "Latin", /** - * Applies a list template with a specific level to the paragraphs in the range. - * + * Latvian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param listTemplate - The list template to apply. - * @param options - Optional. Options for applying the list template, such as whether to continue the previous list or which part of the list to apply the template to. */ - applyListTemplateWithLevel(listTemplate: Word.ListTemplate, options?: Word.ListTemplateApplyOptions): void; + latvian = "Latvian", /** - * Adds numbering and formatting to the paragraphs in the range. - * + * Lithuanian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param defaultListBehavior - Optional. Specifies the default list behavior. */ - applyNumberDefault(defaultListBehavior: Word.DefaultListBehavior): void; + lithuanian = "Lithuanian", /** - * Adds numbering and formatting to the paragraphs in the range. - * + * Macedonian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param defaultListBehavior - Optional. Specifies the default list behavior. */ - applyNumberDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void; + macedonianFYROM = "MacedonianFYROM", /** - * Adds outline numbering and formatting to the paragraphs in the range. - * + * Malayalam language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param defaultListBehavior - Optional. Specifies the default list behavior. */ - applyOutlineNumberDefault(defaultListBehavior: Word.DefaultListBehavior): void; + malayalam = "Malayalam", /** - * Adds outline numbering and formatting to the paragraphs in the range. - * + * Malay Brunei Darussalam language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param defaultListBehavior - Optional. Specifies the default list behavior. */ - applyOutlineNumberDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void; + malayBruneiDarussalam = "MalayBruneiDarussalam", /** - * Determines whether the `ListFormat` object can continue a previous list. - * + * Malaysian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param listTemplate - The list template to check. - * @returns A `Continue` value indicating whether continuation is possible. */ - canContinuePreviousList(listTemplate: Word.ListTemplate): OfficeExtension.ClientResult; + malaysian = "Malaysian", /** - * Converts numbers in the list to plain text. - * + * Maltese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param numberType - Optional. The type of number to convert. */ - convertNumbersToText(numberType: Word.NumberType): void; + maltese = "Maltese", /** - * Converts numbers in the list to plain text. - * + * Manipuri language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param numberType - Optional. The type of number to convert. */ - convertNumbersToText(numberType: "Paragraph" | "ListNum" | "AllNumbers"): void; + manipuri = "Manipuri", /** - * Counts the numbered items in the list. - * + * Marathi language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param options - Optional. Options for counting numbered items, such as the type of number and the level to count. - * @returns The number of items. */ - countNumberedItems(options?: Word.ListFormatCountNumberedItemsOptions): OfficeExtension.ClientResult; + marathi = "Marathi", /** - * Indents the list by one level. - * + * Mexican Spanish language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listIndent(): void; + mexicanSpanish = "MexicanSpanish", /** - * Outdents the list by one level. - * + * Mongolian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listOutdent(): void; + mongolian = "Mongolian", /** - * Removes numbering from the list. - * + * Nepali language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param numberType - Optional. The type of number to remove. */ - removeNumbers(numberType: Word.NumberType): void; + nepali = "Nepali", /** - * Removes numbering from the list. - * + * Disables proofing if the language ID identifies a language in which an object is grammatically validated using the Microsoft Word proofing tools. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param numberType - Optional. The type of number to remove. - */ - removeNumbers(numberType: "Paragraph" | "ListNum" | "AllNumbers"): 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?: Word.Interfaces.ListFormatLoadOptions): Word.ListFormat; - /** - * 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[]): Word.ListFormat; - /** - * 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; - }): Word.ListFormat; - /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - track(): Word.ListFormat; - /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. - */ - untrack(): Word.ListFormat; + noProofing = "NoProofing", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ListFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListFormatData`) that contains shallow copies of any loaded child properties from the original object. + * Norwegian Bokmol language. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.ListFormatData; - } - /** - * Represents options for counting numbered items in a range. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface ListFormatCountNumberedItemsOptions { + norwegianBokmol = "NorwegianBokmol", /** - * If provided, specifies the level to count. The default value is 1. - * + * Norwegian Nynorsk language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - level?: number; + norwegianNynorsk = "NorwegianNynorsk", /** - * If provided, specifies the type of number to count. The default value is `Word.NumberType.paragraph`. - * + * Odia (Oriya) language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - numberType?: Word.NumberType | "Paragraph" | "ListNum" | "AllNumbers"; - } - /** - * Represents options for applying a list template to a range. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface ListTemplateApplyOptions { + oriya = "Oriya", /** - * If provided, specifies the level to apply in the list template. The default value is 1. - * + * Oromo language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - applyLevel?: number; + oromo = "Oromo", /** - * If provided, specifies which part of the list to apply the template to. The default value is `Word.ListApplyTo.wholeList`. - * + * Pashto language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - applyTo?: Word.ListApplyTo | "WholeList" | "ThisPointForward" | "Selection"; + pashto = "Pashto", /** - * If provided, specifies whether to continue the previous list. The default value is `false`. - * + * Persian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - continuePreviousList?: boolean; + persian = "Persian", /** - * If provided, specifies the default list behavior. The default value is `DefaultListBehavior.word97`. - * + * Polish language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - defaultListBehavior?: Word.DefaultListBehavior | "Word97" | "Word2000" | "Word2002"; - } - /** - * Represents the fill formatting for a shape or text. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class FillFormat 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; + polish = "Polish", /** - * Returns a `ColorFormat` object that represents the background color for the fill. - * + * Portuguese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly backgroundColor: Word.ColorFormat; + portuguese = "Portuguese", /** - * Returns a `ColorFormat` object that represents the foreground color for the fill. - * + * Portuguese (Brazil) language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly foregroundColor: Word.ColorFormat; + portugueseBrazil = "PortugueseBrazil", /** - * Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9. - * + * Punjabi language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gradientAngle: number; + punjabi = "Punjabi", /** - * Gets the gradient color type. - * + * Rhaeto Romanic language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly gradientColorType: Word.GradientColorType | "Mixed" | "OneColor" | "TwoColors" | "PresetColors" | "MultiColor"; + rhaetoRomanic = "RhaetoRomanic", /** - * Returns how dark or light a one-color gradient fill is. - A value of 0 means that black is mixed in with the shape's foreground color to form the gradient. - A value of 1 means that white is mixed in. - Values between 0 and 1 mean that a darker or lighter shade of the foreground color is mixed in. - * + * Romanian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly gradientDegree: number; + romanian = "Romanian", /** - * Returns the gradient style for the fill. - * + * Romanian Moldova language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly gradientStyle: Word.GradientStyle | "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter"; + romanianMoldova = "RomanianMoldova", /** - * Returns the gradient variant for the fill as an integer value from 1 to 4 for most gradient fills. - * + * Russian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly gradientVariant: number; + russian = "Russian", /** - * Specifies if the object, or the formatting applied to it, is visible. - * + * Russian Moldova language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible: boolean; + russianMoldova = "RussianMoldova", /** - * Returns a `PatternType` value that represents the pattern applied to the fill or line. - * + * Sami Lappish language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly pattern: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"; + samiLappish = "SamiLappish", /** - * Returns the preset gradient type for the fill. - * + * Sanskrit language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly presetGradientType: Word.PresetGradientType | "Mixed" | "EarlySunset" | "LateSunset" | "Nightfall" | "Daybreak" | "Horizon" | "Desert" | "Ocean" | "CalmWater" | "Fire" | "Fog" | "Moss" | "Peacock" | "Wheat" | "Parchment" | "Mahogany" | "Rainbow" | "RainbowII" | "Gold" | "GoldII" | "Brass" | "Chrome" | "ChromeII" | "Silver" | "Sapphire"; + sanskrit = "Sanskrit", /** - * Gets the preset texture. - * + * Serbian Cyrillic language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly presetTexture: Word.PresetTexture | "Mixed" | "Papyrus" | "Canvas" | "Denim" | "WovenMat" | "WaterDroplets" | "PaperBag" | "FishFossil" | "Sand" | "GreenMarble" | "WhiteMarble" | "BrownMarble" | "Granite" | "Newsprint" | "RecycledPaper" | "Parchment" | "Stationery" | "BlueTissuePaper" | "PinkTissuePaper" | "PurpleMesh" | "Bouquet" | "Cork" | "Walnut" | "Oak" | "MediumWood"; + serbianCyrillic = "SerbianCyrillic", /** - * Specifies whether the fill rotates with the shape. - * + * Serbian Latin language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotateWithObject: boolean; + serbianLatin = "SerbianLatin", /** - * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. - * + * Sesotho language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureAlignment: Word.TextureAlignment | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "Center" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; + sesotho = "Sesotho", /** - * Specifies the horizontal scaling factor for the texture fill. - * + * Simplified Chinese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureHorizontalScale: number; + simplifiedChinese = "SimplifiedChinese", /** - * Returns the name of the custom texture file for the fill. - * + * Sindhi language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly textureName: string; + sindhi = "Sindhi", /** - * Specifies the horizontal offset of the texture from the origin in points. - * + * Sindhi (Pakistan) language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureOffsetX: number; + sindhiPakistan = "SindhiPakistan", /** - * Specifies the vertical offset of the texture. - * + * Sinhalese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureOffsetY: number; + sinhalese = "Sinhalese", /** - * Specifies whether the texture is tiled. - * + * Slovakian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureTile: boolean; + slovak = "Slovak", /** - * Returns the texture type for the fill. - * + * Slovenian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly textureType: Word.TextureType | "Mixed" | "Preset" | "UserDefined"; + slovenian = "Slovenian", /** - * Specifies the vertical scaling factor for the texture fill as a value between 0.0 and 1.0. - * + * Somali language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureVerticalScale: number; + somali = "Somali", /** - * Specifies the degree of transparency of the fill for a shape as a value between 0.0 (opaque) and 1.0 (clear). - * + * Sorbian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency: number; + sorbian = "Sorbian", /** - * Gets the fill format type. - * + * Spanish language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly type: Word.FillType | "Mixed" | "Solid" | "Patterned" | "Gradient" | "Textured" | "Background" | "Picture"; - /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. - */ - set(properties: Interfaces.FillFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.FillFormat): void; + spanish = "Spanish", /** - * Sets the fill to a one-color gradient. - * + * Spanish Argentina language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param style - The gradient style. - * @param variant - The gradient variant. Can be a value from 1 to 4. - * @param degree - The gradient degree. Can be a value from `0.0` (dark) to `1.0` (light). */ - setOneColorGradient(style: Word.GradientStyle, variant: number, degree: number): void; + spanishArgentina = "SpanishArgentina", /** - * Sets the fill to a one-color gradient. - * + * Spanish Bolivian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param style - The gradient style. - * @param variant - The gradient variant. Can be a value from 1 to 4. - * @param degree - The gradient degree. Can be a value from `0.0` (dark) to `1.0` (light). */ - setOneColorGradient(style: "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter", variant: number, degree: number): void; + spanishBolivia = "SpanishBolivia", /** - * Sets the fill to a pattern. - * + * Spanish Chilean language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - setPatterned(pattern: Word.PatternType): void; + spanishChile = "SpanishChile", /** - * Sets the fill to a pattern. - * + * Spanish Colombian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - setPatterned(pattern: "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"): void; + spanishColombia = "SpanishColombia", /** - * Sets the fill to a preset gradient. - The gradient style.The gradient variant. Can be a value from 1 to 4.The preset gradient type. - * + * Spanish Costa Rican language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - setPresetGradient(style: Word.GradientStyle, variant: number, presetGradientType: Word.PresetGradientType): void; + spanishCostaRica = "SpanishCostaRica", /** - * Sets the fill to a preset gradient. - The gradient style.The gradient variant. Can be a value from 1 to 4.The preset gradient type. - * + * Spanish Dominican Republic language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - setPresetGradient(style: "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter", variant: number, presetGradientType: "Mixed" | "EarlySunset" | "LateSunset" | "Nightfall" | "Daybreak" | "Horizon" | "Desert" | "Ocean" | "CalmWater" | "Fire" | "Fog" | "Moss" | "Peacock" | "Wheat" | "Parchment" | "Mahogany" | "Rainbow" | "RainbowII" | "Gold" | "GoldII" | "Brass" | "Chrome" | "ChromeII" | "Silver" | "Sapphire"): void; + spanishDominicanRepublic = "SpanishDominicanRepublic", /** - * Sets the fill to a preset texture. - * + * Spanish Ecuadorian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - setPresetTextured(presetTexture: Word.PresetTexture): void; + spanishEcuador = "SpanishEcuador", /** - * Sets the fill to a preset texture. - * + * Spanish El Salvadorian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - setPresetTextured(presetTexture: "Mixed" | "Papyrus" | "Canvas" | "Denim" | "WovenMat" | "WaterDroplets" | "PaperBag" | "FishFossil" | "Sand" | "GreenMarble" | "WhiteMarble" | "BrownMarble" | "Granite" | "Newsprint" | "RecycledPaper" | "Parchment" | "Stationery" | "BlueTissuePaper" | "PinkTissuePaper" | "PurpleMesh" | "Bouquet" | "Cork" | "Walnut" | "Oak" | "MediumWood"): void; + spanishElSalvador = "SpanishElSalvador", /** - * Sets the fill to a two-color gradient. - * + * Spanish Guatemala language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - setTwoColorGradient(style: Word.GradientStyle, variant: number): void; + spanishGuatemala = "SpanishGuatemala", /** - * Sets the fill to a two-color gradient. - * + * Spanish Honduran language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - setTwoColorGradient(style: "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter", variant: number): void; + spanishHonduras = "SpanishHonduras", /** - * Sets the fill to a uniform color. - * + * Spanish Modern Sort language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - solid(): 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?: Word.Interfaces.FillFormatLoadOptions): Word.FillFormat; - /** - * 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[]): Word.FillFormat; - /** - * 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; - }): Word.FillFormat; - /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. - */ - track(): Word.FillFormat; - /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. - */ - untrack(): Word.FillFormat; - /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.FillFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FillFormatData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.FillFormatData; - } - /** - * Represents the glow formatting for the font used by the range of text. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class GlowFormat 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; + spanishModernSort = "SpanishModernSort", /** - * Returns a `ColorFormat` object that represents the color for a glow effect. - * + * Spanish Nicaraguan language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly color: Word.ColorFormat; + spanishNicaragua = "SpanishNicaragua", /** - * Specifies the length of the radius for a glow effect. - * + * Spanish Panamanian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - radius: number; + spanishPanama = "SpanishPanama", /** - * Specifies the degree of transparency for the glow effect as a value between 0.0 (opaque) and 1.0 (clear). - * + * Spanish Paraguayan language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency: number; - /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. - */ - set(properties: Interfaces.GlowFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.GlowFormat): 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?: Word.Interfaces.GlowFormatLoadOptions): Word.GlowFormat; + spanishParaguay = "SpanishParaguay", /** - * 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. + * Spanish Peruvian language. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.GlowFormat; + spanishPeru = "SpanishPeru", /** - * 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. + * Spanish Puerto Rican language. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.GlowFormat; + spanishPuertoRico = "SpanishPuertoRico", /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + * Spanish Uruguayan language. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.GlowFormat; + spanishUruguay = "SpanishUruguay", /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + * Spanish Venezuelan language. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.GlowFormat; + spanishVenezuela = "SpanishVenezuela", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.GlowFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.GlowFormatData`) that contains shallow copies of any loaded child properties from the original object. + * Sutu language. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.GlowFormatData; - } - /** - * Represents line and arrowhead formatting. For a line, the `LineFormat` object contains formatting information for the line itself; - for a shape with a border, this object contains formatting information for the shape's border. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class LineFormat 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; + sutu = "Sutu", /** - * Gets a `ColorFormat` object that represents the background color for a patterned line. - * + * Swahili language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly backgroundColor: Word.ColorFormat; + swahili = "Swahili", /** - * Gets a `ColorFormat` object that represents the foreground color for the line. - * + * Swedish language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly foregroundColor: Word.ColorFormat; + swedish = "Swedish", /** - * Specifies the length of the arrowhead at the beginning of the line. - * + * Swedish Finnish language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - beginArrowheadLength: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; + swedishFinland = "SwedishFinland", /** - * Specifies the style of the arrowhead at the beginning of the line. - * + * Swiss French language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - beginArrowheadStyle: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; + swissFrench = "SwissFrench", /** - * Specifies the width of the arrowhead at the beginning of the line. - * + * Swiss German language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - beginArrowheadWidth: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; + swissGerman = "SwissGerman", /** - * Specifies the dash style for the line. - * + * Swiss Italian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashStyle: Word.LineDashStyle | "Mixed" | "Solid" | "SquareDot" | "RoundDot" | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "SysDash" | "SysDot" | "SysDashDot"; + swissItalian = "SwissItalian", /** - * Specifies the length of the arrowhead at the end of the line. - * + * Syriac language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endArrowheadLength: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; + syriac = "Syriac", /** - * Specifies the style of the arrowhead at the end of the line. - * + * Tajik language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endArrowheadStyle: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; + tajik = "Tajik", /** - * Specifies the width of the arrowhead at the end of the line. - * + * Tamazight language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endArrowheadWidth: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; + tamazight = "Tamazight", /** - * Specifies if to draw lines inside a shape. - * + * Tamazight Latin language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - insetPen: boolean; + tamazightLatin = "TamazightLatin", /** - * Specifies if the object, or the formatting applied to it, is visible. - * + * Tamil language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible: boolean; + tamil = "Tamil", /** - * Specifies the pattern applied to the line. - * + * Tatar language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pattern: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"; + tatar = "Tatar", /** - * Specifies the line format style. - * + * Telugu language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - style: Word.LineFormatStyle | "Mixed" | "Single" | "ThinThin" | "ThinThick" | "ThickThin" | "ThickBetweenThin"; + telugu = "Telugu", /** - * Specifies the degree of transparency of the line as a value between 0.0 (opaque) and 1.0 (clear). - * + * Thai language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency: number; + thai = "Thai", /** - * Specifies the thickness of the line in points. - * + * Tibetan language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - weight: number; + tibetan = "Tibetan", /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Tigrigna Eritrea language. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.LineFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.LineFormat): void; + tigrignaEritrea = "TigrignaEritrea", /** - * 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. + * Tigrigna Ethiopic language. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.LineFormatLoadOptions): Word.LineFormat; + tigrignaEthiopic = "TigrignaEthiopic", /** - * 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. + * Traditional Chinese language. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.LineFormat; + traditionalChinese = "TraditionalChinese", /** - * 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. + * Tsonga language. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.LineFormat; + tsonga = "Tsonga", /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + * Tswana language. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.LineFormat; + tswana = "Tswana", /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + * Turkish language. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.LineFormat; + turkish = "Turkish", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.LineFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.LineFormatData`) that contains shallow copies of any loaded child properties from the original object. + * Turkmen language. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.LineFormatData; - } - /** - * Represents the reflection formatting for a shape in Word. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class ReflectionFormat 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; + turkmen = "Turkmen", /** - * Specifies the degree of blur effect applied to the `ReflectionFormat` object as a value between 0.0 and 100.0. - * + * Ukrainian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - blur: number; + ukrainian = "Ukrainian", /** - * Specifies the amount of separation, in points, of the reflected image from the shape. - * + * Urdu language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - offset: number; + urdu = "Urdu", /** - * Specifies the size of the reflection as a percentage of the reflected shape from 0 to 100. - * + * Uzbek Cyrillic language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - size: number; + uzbekCyrillic = "UzbekCyrillic", /** - * Specifies the degree of transparency for the reflection effect as a value between 0.0 (opaque) and 1.0 (clear). - * + * Uzbek Latin language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency: number; + uzbekLatin = "UzbekLatin", /** - * Specifies a `ReflectionType` value that represents the type and direction of the lighting for a shape reflection. - * + * Venda language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type: Word.ReflectionType | "Mixed" | "None" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9"; + venda = "Venda", /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Vietnamese language. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.ReflectionFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ReflectionFormat): void; + vietnamese = "Vietnamese", /** - * 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. + * Welsh language. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.ReflectionFormatLoadOptions): Word.ReflectionFormat; + welsh = "Welsh", /** - * 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. + * Xhosa language. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.ReflectionFormat; + xhosa = "Xhosa", /** - * 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. + * Yi language. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.ReflectionFormat; + yi = "Yi", /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + * Yiddish language. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.ReflectionFormat; + yiddish = "Yiddish", /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + * Yoruba language. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.ReflectionFormat; + yoruba = "Yoruba", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ReflectionFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ReflectionFormatData`) that contains shallow copies of any loaded child properties from the original object. + * Zulu language. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.ReflectionFormatData; + zulu = "Zulu", } /** - * Represents the color formatting of a shape or text in Word. + * Specifies how a building block is inserted into a document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export class ColorFormat 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 DocPartInsertType { /** - * Specifies the brightness of a specified shape color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. - * + * Inserts the content of the building block. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - brightness: number; + content = "Content", /** - * Specifies the theme color for a color format. - * + * Inserts the building block as a paragraph. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - objectThemeColor: Word.ThemeColorIndex | "NotThemeColor" | "MainDark1" | "MainLight1" | "MainDark2" | "MainLight2" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Hyperlink" | "HyperlinkFollowed" | "Background1" | "Text1" | "Background2" | "Text2"; + paragraph = "Paragraph", /** - * Specifies the red-green-blue (RGB) value of the specified color. You can provide the value in the '#RRGGBB' format. - * + * Inserts the building block as a page. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rgb: string; + page = "Page", + } + /** + * Specifies the type of building block. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum BuildingBlockType { /** - * Specifies the lightening or darkening of a specified shape's color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. - * + * Represents Quick Parts building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tintAndShade: number; + quickParts = "QuickParts", /** - * Returns the shape color type. - * + * Represents Cover Page building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly type: Word.ColorType | "rgb" | "scheme"; + coverPage = "CoverPage", /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Represents Equations building block type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.ColorFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ColorFormat): void; + equations = "Equations", /** - * 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. + * Represents Footers building block type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.ColorFormatLoadOptions): Word.ColorFormat; + footers = "Footers", /** - * 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. + * Represents Headers building block type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.ColorFormat; + headers = "Headers", /** - * 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. + * Represents Page Number building block type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.ColorFormat; + pageNumber = "PageNumber", /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + * Represents Tables building block type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.ColorFormat; + tables = "Tables", /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + * Represents Watermarks building block type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.ColorFormat; + watermarks = "Watermarks", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ColorFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ColorFormatData`) that contains shallow copies of any loaded child properties from the original object. + * Represents AutoText building block type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.ColorFormatData; - } - /** - * Represents the shadow formatting for a shape or text in Word. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class ShadowFormat 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; + autoText = "AutoText", /** - * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. - * + * Represents Text Box building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly foregroundColor: Word.ColorFormat; + textBox = "TextBox", /** - * Specifies the blur level for a shadow format as a value between 0.0 and 100.0. - * + * Represents Page Number Top building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - blur: number; + pageNumberTop = "PageNumberTop", /** - * Specifies whether the object or the formatting applied to it is visible. - * + * Represents Page Number Bottom building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible: boolean; + pageNumberBottom = "PageNumberBottom", /** - * Specifies `true` if the shadow of the shape appears filled in and is obscured by the shape, even if the shape has no fill, - `false` if the shadow has no fill and the outline of the shadow is visible through the shape if the shape has no fill. - * + * Represents Page Number Page building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - obscured: boolean; + pageNumberPage = "PageNumberPage", /** - * Specifies the horizontal offset (in points) of the shadow from the shape. - A positive value offsets the shadow to the right of the shape; a negative value offsets it to the left. - * + * Represents Table of Contents building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - offsetX: number; + tableOfContents = "TableOfContents", /** - * Specifies the vertical offset (in points) of the shadow from the shape. - A positive value offsets the shadow to the top of the shape; a negative value offsets it to the bottom. - * + * Represents Custom Quick Parts building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - offsetY: number; + customQuickParts = "CustomQuickParts", /** - * Specifies whether to rotate the shadow when rotating the shape. - * + * Represents Custom Cover Page building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotateWithShape: boolean; + customCoverPage = "CustomCoverPage", /** - * Specifies the width of the shadow. - * + * Represents Custom Equations building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - size: number; + customEquations = "CustomEquations", /** - * Specifies the type of shadow formatting to apply to a shape. - * + * Represents Custom Footers building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - style: Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow"; + customFooters = "CustomFooters", /** - * Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear). - * + * Represents Custom Headers building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency: number; + customHeaders = "CustomHeaders", /** - * Specifies the shape shadow type. - * + * Represents Custom Page Number building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type: Word.ShadowType | "Mixed" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9" | "Type10" | "Type11" | "Type12" | "Type13" | "Type14" | "Type15" | "Type16" | "Type17" | "Type18" | "Type19" | "Type20" | "Type21" | "Type22" | "Type23" | "Type24" | "Type25" | "Type26" | "Type27" | "Type28" | "Type29" | "Type30" | "Type31" | "Type32" | "Type33" | "Type34" | "Type35" | "Type36" | "Type37" | "Type38" | "Type39" | "Type40" | "Type41" | "Type42" | "Type43"; + customPageNumber = "CustomPageNumber", /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Represents Custom Tables building block type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.ShadowFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ShadowFormat): void; + customTables = "CustomTables", /** - * Changes the horizontal offset of the shadow by the number of points. - Increment The number of points to adjust. - * + * Represents Custom Watermarks building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - incrementOffsetX(increment: number): void; + customWatermarks = "CustomWatermarks", /** - * Changes the vertical offset of the shadow by the specified number of points. - Increment The number of points to adjust. - * + * Represents Custom AutoText building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - incrementOffsetY(increment: number): void; + customAutoText = "CustomAutoText", /** - * 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. + * Represents Custom Text Box building block type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.ShadowFormatLoadOptions): Word.ShadowFormat; + customTextBox = "CustomTextBox", /** - * 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. + * Represents Custom Page Number Top building block type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.ShadowFormat; + customPageNumberTop = "CustomPageNumberTop", /** - * 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. + * Represents Custom Page Number Bottom building block type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.ShadowFormat; + customPageNumberBottom = "CustomPageNumberBottom", /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + * Represents Custom Page Number Page building block type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.ShadowFormat; + customPageNumberPage = "CustomPageNumberPage", /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + * Represents Custom Table of Contents building block type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.ShadowFormat; + customTableOfContents = "CustomTableOfContents", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ShadowFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShadowFormatData`) that contains shallow copies of any loaded child properties from the original object. + * Represents Custom building block type 1. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.ShadowFormatData; - } - /** - * Represents a shape's three-dimensional formatting. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class ThreeDimensionalFormat 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; + custom1 = "Custom1", /** - * Returns a `ColorFormat` object that represents color of the contour of a shape. - * + * Represents Custom building block type 2. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly contourColor: Word.ColorFormat; + custom2 = "Custom2", /** - * Returns a `ColorFormat` object that represents the color of the shape's extrusion. - * + * Represents Custom building block type 3. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly extrusionColor: Word.ColorFormat; + custom3 = "Custom3", /** - * Specifies the depth of the bottom bevel. - * + * Represents Custom building block type 4. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelBottomDepth: number; + custom4 = "Custom4", /** - * Specifies the inset size for the bottom bevel. - * + * Represents Custom building block type 5. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelBottomInset: number; + custom5 = "Custom5", /** - * Specifies a `BevelType` value that represents the bevel type for the bottom bevel. - * + * Represents Bibliography building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelBottomType: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; + bibliography = "Bibliography", /** - * Specifies the depth of the top bevel. - * + * Represents Custom Bibliography building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelTopDepth: number; + customBibliography = "CustomBibliography", + } + /** + * Represents the type of a {@link Word.CustomXmlValidationError}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum CustomXmlValidationErrorType { /** - * Specifies the inset size for the top bevel. - * + * Represents a validation error generated by the schema. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelTopInset: number; + schemaGenerated = "schemaGenerated", /** - * Specifies a `BevelType` value that represents the bevel type for the top bevel. - * + * Represents a validation error that is automatically cleared. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelTopType: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; + automaticallyCleared = "automaticallyCleared", /** - * Specifies the width of the contour of a shape. - * + * Represents a validation error that is manually created. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contourWidth: number; + manual = "manual", + } + /** + * Represents the type of a {@link Word.CustomXmlNode}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum CustomXmlNodeType { /** - * Specifies the depth of the shape's extrusion. - * + * Represents an XML element node. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - depth: number; + element = "element", /** - * Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion) - and automatically changes when the shape's fill changes, or whether the extrusion color is independent of the shape's fill. - * + * Represents an XML attribute node. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - extrusionColorType: Word.ExtrusionColorType | "mixed" | "automatic" | "custom"; + attribute = "attribute", /** - * Specifies the amount of perspective for a shape. - * + * Represents an XML text node. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fieldOfView: number; + text = "text", /** - * Specifies `true` if the extrusion appears in perspective — that is, if the walls of the extrusion narrow toward a vanishing point, - `false` if the extrusion is a parallel, or orthographic, projection — that is, if the walls don't narrow toward a vanishing point. - * + * Represents an XML CDATA section node. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isPerspective: boolean; + cData = "cData", /** - * Specifies if the specified object, or the formatting applied to it, is visible. - * + * Represents an XML processing instruction node. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible: boolean; + processingInstruction = "processingInstruction", /** - * Specifies the angle of the lighting. - * + * Represents an XML comment node. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lightAngle: number; + comment = "comment", /** - * Returns a `PresetCamera` value that represents the camera presets. - * + * Represents an XML document node. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly presetCamera: Word.PresetCamera | "Mixed" | "LegacyObliqueTopLeft" | "LegacyObliqueTop" | "LegacyObliqueTopRight" | "LegacyObliqueLeft" | "LegacyObliqueFront" | "LegacyObliqueRight" | "LegacyObliqueBottomLeft" | "LegacyObliqueBottom" | "LegacyObliqueBottomRight" | "LegacyPerspectiveTopLeft" | "LegacyPerspectiveTop" | "LegacyPerspectiveTopRight" | "LegacyPerspectiveLeft" | "LegacyPerspectiveFront" | "LegacyPerspectiveRight" | "LegacyPerspectiveBottomLeft" | "LegacyPerspectiveBottom" | "LegacyPerspectiveBottomRight" | "OrthographicFront" | "IsometricTopUp" | "IsometricTopDown" | "IsometricBottomUp" | "IsometricBottomDown" | "IsometricLeftUp" | "IsometricLeftDown" | "IsometricRightUp" | "IsometricRightDown" | "IsometricOffAxis1Left" | "IsometricOffAxis1Right" | "IsometricOffAxis1Top" | "IsometricOffAxis2Left" | "IsometricOffAxis2Right" | "IsometricOffAxis2Top" | "IsometricOffAxis3Left" | "IsometricOffAxis3Right" | "IsometricOffAxis3Bottom" | "IsometricOffAxis4Left" | "IsometricOffAxis4Right" | "IsometricOffAxis4Bottom" | "ObliqueTopLeft" | "ObliqueTop" | "ObliqueTopRight" | "ObliqueLeft" | "ObliqueRight" | "ObliqueBottomLeft" | "ObliqueBottom" | "ObliqueBottomRight" | "PerspectiveFront" | "PerspectiveLeft" | "PerspectiveRight" | "PerspectiveAbove" | "PerspectiveBelow" | "PerspectiveAboveLeftFacing" | "PerspectiveAboveRightFacing" | "PerspectiveContrastingLeftFacing" | "PerspectiveContrastingRightFacing" | "PerspectiveHeroicLeftFacing" | "PerspectiveHeroicRightFacing" | "PerspectiveHeroicExtremeLeftFacing" | "PerspectiveHeroicExtremeRightFacing" | "PerspectiveRelaxed" | "PerspectiveRelaxedModerately"; + document = "document", + } + /** + * Specifies the type of link. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum LinkType { /** - * Returns the direction taken by the extrusion's sweep path leading away from the extruded shape (the front face of the extrusion). - * + * OLE object. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly presetExtrusionDirection: Word.PresetExtrusionDirection | "Mixed" | "BottomRight" | "Bottom" | "BottomLeft" | "Right" | "None" | "Left" | "TopRight" | "Top" | "TopLeft"; + ole = "Ole", /** - * Specifies a `LightRigType` value that represents the lighting preset. - * + * Picture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetLighting: Word.LightRigType | "Mixed" | "LegacyFlat1" | "LegacyFlat2" | "LegacyFlat3" | "LegacyFlat4" | "LegacyNormal1" | "LegacyNormal2" | "LegacyNormal3" | "LegacyNormal4" | "LegacyHarsh1" | "LegacyHarsh2" | "LegacyHarsh3" | "LegacyHarsh4" | "ThreePoint" | "Balanced" | "Soft" | "Harsh" | "Flood" | "Contrasting" | "Morning" | "Sunrise" | "Sunset" | "Chilly" | "Freezing" | "Flat" | "TwoPoint" | "Glow" | "BrightRoom"; + picture = "Picture", /** - * Specifies the position of the light source relative to the extrusion. - * + * Text. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetLightingDirection: Word.PresetLightingDirection | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "None" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; + text = "Text", /** - * Specifies the intensity of the extrusion lighting. - * + * Reference library. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetLightingSoftness: Word.PresetLightingSoftness | "Mixed" | "Dim" | "Normal" | "Bright"; + reference = "Reference", /** - * Specifies the extrusion surface material. - * + * Include file. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetMaterial: Word.PresetMaterial | "Mixed" | "Matte" | "Plastic" | "Metal" | "WireFrame" | "Matte2" | "Plastic2" | "Metal2" | "WarmMatte" | "TranslucentPowder" | "Powder" | "DarkEdge" | "SoftEdge" | "Clear" | "Flat" | "SoftMetal"; + include = "Include", /** - * Returns the preset extrusion format. - * + * Import file. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly presetThreeDimensionalFormat: Word.PresetThreeDimensionalFormat | "Mixed" | "Format1" | "Format2" | "Format3" | "Format4" | "Format5" | "Format6" | "Format7" | "Format8" | "Format9" | "Format10" | "Format11" | "Format12" | "Format13" | "Format14" | "Format15" | "Format16" | "Format17" | "Format18" | "Format19" | "Format20"; + import = "Import", /** - * Specifies whether text on a shape rotates with shape. `true` rotates the text. - * + * Dynamic Data Exchange. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - projectText: boolean; + dde = "Dde", /** - * Specifies the rotation of the extruded shape around the x-axis in degrees. - * + * Automatic DDE. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotationX: number; + ddeAuto = "DdeAuto", /** - * Specifies the rotation of the extruded shape around the y-axis in degrees. - * + * Microsoft Excel chart. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotationY: number; + chart = "Chart", + } + /** + * Specifies the action associated with the verb that the OLE object should perform. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum OleVerb { /** - * Specifies the z-axis rotation of the camera. - * + * Performs the verb that is invoked when the user double-clicks the object. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotationZ: number; + primary = "Primary", /** - * Specifies the position on the z-axis for the shape. - * + * Shows the object to the user for editing or viewing. Use it to show a newly inserted object for initial editing. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - z: number; + show = "Show", /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Opens the object in a separate window. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.ThreeDimensionalFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ThreeDimensionalFormat): void; + open = "Open", /** - * Horizontally rotates a shape on the x-axis. - The number of degrees to rotate. - * + * Removes the object's user interface from view. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - incrementRotationHorizontal(increment: number): void; + hide = "Hide", /** - * Vertically rotates a shape on the y-axis. - The number of degrees to rotate. - * + * Activates the object in place and displays any user-interface tools that the object needs, such as menus or toolbars. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - incrementRotationVertical(increment: number): void; + uiActivate = "UiActivate", /** - * Changes the rotation around the x-axis. - The number of degrees to rotate. - * + * Runs the object and installs its window, but doesn't install any user-interface tools. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - incrementRotationX(increment: number): void; + inPlaceActivate = "InPlaceActivate", /** - * Changes the rotation around the y-axis. - The number of degrees to rotate. - * + * Forces the object to discard any undo state that it might be maintaining; note that the object remains active, however. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - incrementRotationY(increment: number): void; + discardUndoState = "DiscardUndoState", + } + /** + * Represents the list formatting characteristics of a range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class ListFormat 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; /** - * Rotates a shape on the z-axis. - The number of degrees to rotate. + * Returns a `List` object that represents the first formatted list contained in the `ListFormat` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - incrementRotationZ(increment: number): void; + readonly list: Word.List; /** - * Resets the extrusion rotation around the x-axis, y-axis, and z-axis to 0. + * Gets the list template associated with the `ListFormat` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - resetRotation(): void; + readonly listTemplate: Word.ListTemplate; /** - * Sets the direction of the extrusion's sweep path. + * Indicates whether the `ListFormat` object contains a single list. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param presetExtrusionDirection - The preset direction. */ - setExtrusionDirection(presetExtrusionDirection: Word.PresetExtrusionDirection): void; + readonly isSingleList: boolean; /** - * Sets the direction of the extrusion's sweep path. + * Indicates whether the `ListFormat` object contains a single list template. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param presetExtrusionDirection - The preset direction. */ - setExtrusionDirection(presetExtrusionDirection: "Mixed" | "BottomRight" | "Bottom" | "BottomLeft" | "Right" | "None" | "Left" | "TopRight" | "Top" | "TopLeft"): void; + readonly isSingleListTemplate: boolean; /** - * Sets the camera preset for the shape. - The preset camera type. + * Specifies the list level number for the first paragraph for the `ListFormat` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - setPresetCamera(presetCamera: Word.PresetCamera): void; + listLevelNumber: number; /** - * Sets the camera preset for the shape. - The preset camera type. + * Gets the string representation of the list value of the first paragraph in the range for the `ListFormat` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - setPresetCamera(presetCamera: "Mixed" | "LegacyObliqueTopLeft" | "LegacyObliqueTop" | "LegacyObliqueTopRight" | "LegacyObliqueLeft" | "LegacyObliqueFront" | "LegacyObliqueRight" | "LegacyObliqueBottomLeft" | "LegacyObliqueBottom" | "LegacyObliqueBottomRight" | "LegacyPerspectiveTopLeft" | "LegacyPerspectiveTop" | "LegacyPerspectiveTopRight" | "LegacyPerspectiveLeft" | "LegacyPerspectiveFront" | "LegacyPerspectiveRight" | "LegacyPerspectiveBottomLeft" | "LegacyPerspectiveBottom" | "LegacyPerspectiveBottomRight" | "OrthographicFront" | "IsometricTopUp" | "IsometricTopDown" | "IsometricBottomUp" | "IsometricBottomDown" | "IsometricLeftUp" | "IsometricLeftDown" | "IsometricRightUp" | "IsometricRightDown" | "IsometricOffAxis1Left" | "IsometricOffAxis1Right" | "IsometricOffAxis1Top" | "IsometricOffAxis2Left" | "IsometricOffAxis2Right" | "IsometricOffAxis2Top" | "IsometricOffAxis3Left" | "IsometricOffAxis3Right" | "IsometricOffAxis3Bottom" | "IsometricOffAxis4Left" | "IsometricOffAxis4Right" | "IsometricOffAxis4Bottom" | "ObliqueTopLeft" | "ObliqueTop" | "ObliqueTopRight" | "ObliqueLeft" | "ObliqueRight" | "ObliqueBottomLeft" | "ObliqueBottom" | "ObliqueBottomRight" | "PerspectiveFront" | "PerspectiveLeft" | "PerspectiveRight" | "PerspectiveAbove" | "PerspectiveBelow" | "PerspectiveAboveLeftFacing" | "PerspectiveAboveRightFacing" | "PerspectiveContrastingLeftFacing" | "PerspectiveContrastingRightFacing" | "PerspectiveHeroicLeftFacing" | "PerspectiveHeroicRightFacing" | "PerspectiveHeroicExtremeLeftFacing" | "PerspectiveHeroicExtremeRightFacing" | "PerspectiveRelaxed" | "PerspectiveRelaxedModerately"): void; + readonly listString: string; /** - * Sets the preset extrusion format. - The preset format. + * Gets the type of the list for the `ListFormat` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - setThreeDimensionalFormat(presetThreeDimensionalFormat: Word.PresetThreeDimensionalFormat): void; + readonly listType: Word.ListType | "ListNoNumbering" | "ListListNumOnly" | "ListBullet" | "ListSimpleNumbering" | "ListOutlineNumbering" | "ListMixedNumbering" | "ListPictureBullet"; /** - * Sets the preset extrusion format. - The preset format. + * Gets the numeric value of the the first paragraph in the range for the `ListFormat` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - setThreeDimensionalFormat(presetThreeDimensionalFormat: "Mixed" | "Format1" | "Format2" | "Format3" | "Format4" | "Format5" | "Format6" | "Format7" | "Format8" | "Format9" | "Format10" | "Format11" | "Format12" | "Format13" | "Format14" | "Format15" | "Format16" | "Format17" | "Format18" | "Format19" | "Format20"): void; + readonly listValue: 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. + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - load(options?: Word.Interfaces.ThreeDimensionalFormatLoadOptions): Word.ThreeDimensionalFormat; + set(properties: Interfaces.ListFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ListFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Adds bullets and formatting to the paragraphs in the range. * - * @param propertyNames - A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param defaultListBehavior - Optional. Specifies the default list behavior. Default is `DefaultListBehavior.word97`. */ - load(propertyNames?: string | string[]): Word.ThreeDimensionalFormat; + applyBulletDefault(defaultListBehavior: Word.DefaultListBehavior): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Adds bullets and formatting to the paragraphs in the range. * - * @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; - }): Word.ThreeDimensionalFormat; - /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. - */ - track(): Word.ThreeDimensionalFormat; - /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. - */ - untrack(): Word.ThreeDimensionalFormat; - /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ThreeDimensionalFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ThreeDimensionalFormatData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.ThreeDimensionalFormatData; - } - /** - * Specifies the length of the arrowhead at the end of a line. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ArrowheadLength { - /** - * Represents a mixed arrowhead length. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param defaultListBehavior - Optional. Specifies the default list behavior. Default is `DefaultListBehavior.word97`. */ - mixed = "Mixed", + applyBulletDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void; /** - * Represents a short arrowhead length. + * Applies a list template with a specific level to the paragraphs in the range. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param listTemplate - The list template to apply. + * @param options - Optional. Options for applying the list template, such as whether to continue the previous list or which part of the list to apply the template to. */ - short = "Short", + applyListTemplateWithLevel(listTemplate: Word.ListTemplate, options?: Word.ListTemplateApplyOptions): void; /** - * Represents a medium arrowhead length. + * Adds numbering and formatting to the paragraphs in the range. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param defaultListBehavior - Optional. Specifies the default list behavior. */ - medium = "Medium", + applyNumberDefault(defaultListBehavior: Word.DefaultListBehavior): void; /** - * Represents a long arrowhead length. + * Adds numbering and formatting to the paragraphs in the range. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param defaultListBehavior - Optional. Specifies the default list behavior. */ - long = "Long", - } - /** - * Specifies the style of the arrowhead at the end of a line. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ArrowheadStyle { + applyNumberDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void; /** - * Represents a mixed arrowhead style. + * Adds outline numbering and formatting to the paragraphs in the range. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param defaultListBehavior - Optional. Specifies the default list behavior. */ - mixed = "Mixed", + applyOutlineNumberDefault(defaultListBehavior: Word.DefaultListBehavior): void; /** - * Represents no arrowhead. + * Adds outline numbering and formatting to the paragraphs in the range. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param defaultListBehavior - Optional. Specifies the default list behavior. */ - none = "None", + applyOutlineNumberDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void; /** - * Represents a triangle arrowhead style. + * Determines whether the `ListFormat` object can continue a previous list. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param listTemplate - The list template to check. + * @returns A `Continue` value indicating whether continuation is possible. */ - triangle = "Triangle", + canContinuePreviousList(listTemplate: Word.ListTemplate): OfficeExtension.ClientResult; /** - * Represents an open arrowhead style. + * Converts numbers in the list to plain text. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param numberType - Optional. The type of number to convert. */ - open = "Open", + convertNumbersToText(numberType: Word.NumberType): void; /** - * Represents a stealth arrowhead style. + * Converts numbers in the list to plain text. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param numberType - Optional. The type of number to convert. */ - stealth = "Stealth", + convertNumbersToText(numberType: "Paragraph" | "ListNum" | "AllNumbers"): void; /** - * Represents a diamond arrowhead style. + * Counts the numbered items in the list. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param options - Optional. Options for counting numbered items, such as the type of number and the level to count. + * @returns The number of items. */ - diamond = "Diamond", + countNumberedItems(options?: Word.ListFormatCountNumberedItemsOptions): OfficeExtension.ClientResult; /** - * Represents an oval arrowhead style. + * Indents the list by one level. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - oval = "Oval", - } - /** - * Specifies the width of the arrowhead at the end of a line. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ArrowheadWidth { + listIndent(): void; /** - * Represents a mixed arrowhead width. + * Outdents the list by one level. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + listOutdent(): void; /** - * Represents a narrow arrowhead width. + * Removes numbering from the list. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param numberType - Optional. The type of number to remove. */ - narrow = "Narrow", + removeNumbers(numberType: Word.NumberType): void; /** - * Represents a medium arrowhead width. + * Removes numbering from the list. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param numberType - Optional. The type of number to remove. */ - medium = "Medium", + removeNumbers(numberType: "Paragraph" | "ListNum" | "AllNumbers"): void; /** - * Represents a wide arrowhead width. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - wide = "Wide", + load(options?: Word.Interfaces.ListFormatLoadOptions): Word.ListFormat; + /** + * 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[]): Word.ListFormat; + /** + * 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; + }): Word.ListFormat; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.ListFormat; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.ListFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ListFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.ListFormatData; } /** - * Indicates the bevel type of a {@link Word.ThreeDimensionalFormat} object. + * Represents options for counting numbered items in a range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum BevelType { + export interface ListFormatCountNumberedItemsOptions { /** - * Represents a mixed bevel type. + * If provided, specifies the level to count. The default value is 1. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "mixed", + level?: number; /** - * Represents no bevel. + * If provided, specifies the type of number to count. The default value is `Word.NumberType.paragraph`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "none", + numberType?: Word.NumberType | "Paragraph" | "ListNum" | "AllNumbers"; + } + /** + * Represents options for applying a list template to a range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface ListTemplateApplyOptions { /** - * Represents a relaxed inset bevel. + * If provided, specifies the level to apply in the list template. The default value is 1. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - relaxedInset = "relaxedInset", + applyLevel?: number; /** - * Represents a circle bevel. + * If provided, specifies which part of the list to apply the template to. The default value is `Word.ListApplyTo.wholeList`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - circle = "circle", + applyTo?: Word.ListApplyTo | "WholeList" | "ThisPointForward" | "Selection"; /** - * Represents a slope bevel. + * If provided, specifies whether to continue the previous list. The default value is `false`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - slope = "slope", + continuePreviousList?: boolean; /** - * Represents a cross bevel. + * If provided, specifies the default list behavior. The default value is `DefaultListBehavior.word97`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cross = "cross", + defaultListBehavior?: Word.DefaultListBehavior | "Word97" | "Word2000" | "Word2002"; + } + /** + * Represents the fill formatting for a shape or text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class FillFormat 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 an angle bevel. + * Returns a `ColorFormat` object that represents the background color for the fill. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - angle = "angle", + readonly backgroundColor: Word.ColorFormat; /** - * Represents a soft round bevel. + * Returns a `ColorFormat` object that represents the foreground color for the fill. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - softRound = "softRound", + readonly foregroundColor: Word.ColorFormat; /** - * Represents a convex bevel. + * Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - convex = "convex", + gradientAngle: number; /** - * Represents a cool slant bevel. + * Gets the gradient color type. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - coolSlant = "coolSlant", + readonly gradientColorType: Word.GradientColorType | "Mixed" | "OneColor" | "TwoColors" | "PresetColors" | "MultiColor"; /** - * Represents a divot bevel. + * Returns how dark or light a one-color gradient fill is. + A value of 0 means that black is mixed in with the shape's foreground color to form the gradient. + A value of 1 means that white is mixed in. + Values between 0 and 1 mean that a darker or lighter shade of the foreground color is mixed in. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - divot = "divot", + readonly gradientDegree: number; /** - * Represents a riblet bevel. + * Returns the gradient style for the fill. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - riblet = "riblet", + readonly gradientStyle: Word.GradientStyle | "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter"; /** - * Represents a hard edge bevel. + * Returns the gradient variant for the fill as an integer value from 1 to 4 for most gradient fills. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hardEdge = "hardEdge", + readonly gradientVariant: number; /** - * Represents an art deco bevel. + * Specifies if the object, or the formatting applied to it, is visible. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - artDeco = "artDeco", - } - /** - * Represents color index values in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ColorIndex { + isVisible: boolean; /** - * Automatically determines the color. + * Returns a `PatternType` value that represents the pattern applied to the fill or line. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - auto = "Auto", + readonly pattern: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"; /** - * Represents the color black. + * Returns the preset gradient type for the fill. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - black = "Black", + readonly presetGradientType: Word.PresetGradientType | "Mixed" | "EarlySunset" | "LateSunset" | "Nightfall" | "Daybreak" | "Horizon" | "Desert" | "Ocean" | "CalmWater" | "Fire" | "Fog" | "Moss" | "Peacock" | "Wheat" | "Parchment" | "Mahogany" | "Rainbow" | "RainbowII" | "Gold" | "GoldII" | "Brass" | "Chrome" | "ChromeII" | "Silver" | "Sapphire"; /** - * Represents the color blue. + * Gets the preset texture. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - blue = "Blue", + readonly presetTexture: Word.PresetTexture | "Mixed" | "Papyrus" | "Canvas" | "Denim" | "WovenMat" | "WaterDroplets" | "PaperBag" | "FishFossil" | "Sand" | "GreenMarble" | "WhiteMarble" | "BrownMarble" | "Granite" | "Newsprint" | "RecycledPaper" | "Parchment" | "Stationery" | "BlueTissuePaper" | "PinkTissuePaper" | "PurpleMesh" | "Bouquet" | "Cork" | "Walnut" | "Oak" | "MediumWood"; /** - * Represents the color turquoise. + * Specifies whether the fill rotates with the shape. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - turquoise = "Turquoise", + rotateWithObject: boolean; /** - * Represents a bright green color. + * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - brightGreen = "BrightGreen", + textureAlignment: Word.TextureAlignment | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "Center" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; /** - * Represents the color pink. + * Specifies the horizontal scaling factor for the texture fill. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pink = "Pink", + textureHorizontalScale: number; /** - * Represents the color red. + * Returns the name of the custom texture file for the fill. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - red = "Red", + readonly textureName: string; /** - * Represents the color yellow. + * Specifies the horizontal offset of the texture from the origin in points. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - yellow = "Yellow", + textureOffsetX: number; /** - * Represents the color white. + * Specifies the vertical offset of the texture. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - white = "White", + textureOffsetY: number; /** - * Represents a dark blue color. + * Specifies whether the texture is tiled. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - darkBlue = "DarkBlue", + textureTile: boolean; /** - * Represents the color teal. + * Returns the texture type for the fill. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - teal = "Teal", + readonly textureType: Word.TextureType | "Mixed" | "Preset" | "UserDefined"; /** - * Represents the color green. + * Specifies the vertical scaling factor for the texture fill as a value between 0.0 and 1.0. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - green = "Green", + textureVerticalScale: number; /** - * Represents the color violet. + * Specifies the degree of transparency of the fill for a shape as a value between 0.0 (opaque) and 1.0 (clear). + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - violet = "Violet", + transparency: number; /** - * Represents a dark red color. + * Gets the fill format type. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - darkRed = "DarkRed", + readonly type: Word.FillType | "Mixed" | "Solid" | "Patterned" | "Gradient" | "Textured" | "Background" | "Picture"; /** - * Represents a dark yellow color. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - darkYellow = "DarkYellow", + set(properties: Interfaces.FillFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.FillFormat): void; /** - * Represents a gray color with 50% intensity. + * Sets the fill to a one-color gradient. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param style - The gradient style. + * @param variant - The gradient variant. Can be a value from 1 to 4. + * @param degree - The gradient degree. Can be a value from `0.0` (dark) to `1.0` (light). */ - gray50 = "Gray50", + setOneColorGradient(style: Word.GradientStyle, variant: number, degree: number): void; /** - * Represents a gray color with 25% intensity. + * Sets the fill to a one-color gradient. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param style - The gradient style. + * @param variant - The gradient variant. Can be a value from 1 to 4. + * @param degree - The gradient degree. Can be a value from `0.0` (dark) to `1.0` (light). */ - gray25 = "Gray25", + setOneColorGradient(style: "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter", variant: number, degree: number): void; /** - * Represents a classic red color. + * Sets the fill to a pattern. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - classicRed = "ClassicRed", + setPatterned(pattern: Word.PatternType): void; /** - * Represents a classic blue color. + * Sets the fill to a pattern. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - classicBlue = "ClassicBlue", + setPatterned(pattern: "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"): void; /** - * Represents a color determined by the author. + * Sets the fill to a preset gradient. + The gradient style.The gradient variant. Can be a value from 1 to 4.The preset gradient type. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - byAuthor = "ByAuthor", - } - /** - * Specifies the color type. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ColorType { + setPresetGradient(style: Word.GradientStyle, variant: number, presetGradientType: Word.PresetGradientType): void; /** - * Represents an RGB color type. + * Sets the fill to a preset gradient. + The gradient style.The gradient variant. Can be a value from 1 to 4.The preset gradient type. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rgb = "rgb", + setPresetGradient(style: "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter", variant: number, presetGradientType: "Mixed" | "EarlySunset" | "LateSunset" | "Nightfall" | "Daybreak" | "Horizon" | "Desert" | "Ocean" | "CalmWater" | "Fire" | "Fog" | "Moss" | "Peacock" | "Wheat" | "Parchment" | "Mahogany" | "Rainbow" | "RainbowII" | "Gold" | "GoldII" | "Brass" | "Chrome" | "ChromeII" | "Silver" | "Sapphire"): void; /** - * Represents a scheme color type. + * Sets the fill to a preset texture. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - scheme = "scheme", - } - /** - * Specifies whether the formatting from the previous list can be continued. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum Continue { + setPresetTextured(presetTexture: Word.PresetTexture): void; /** - * Formatting cannot continue from the previous list. + * Sets the fill to a preset texture. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - disabled = "Disabled", + setPresetTextured(presetTexture: "Mixed" | "Papyrus" | "Canvas" | "Denim" | "WovenMat" | "WaterDroplets" | "PaperBag" | "FishFossil" | "Sand" | "GreenMarble" | "WhiteMarble" | "BrownMarble" | "Granite" | "Newsprint" | "RecycledPaper" | "Parchment" | "Stationery" | "BlueTissuePaper" | "PinkTissuePaper" | "PurpleMesh" | "Bouquet" | "Cork" | "Walnut" | "Oak" | "MediumWood"): void; /** - * Formatting can continue from the previous list. + * Sets the fill to a two-color gradient. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - list = "List", + setTwoColorGradient(style: Word.GradientStyle, variant: number): void; /** - * Numbering can be restarted. + * Sets the fill to a two-color gradient. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - reset = "Reset", - } - /** - * Specifies the default list behavior for a list. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum DefaultListBehavior { + setTwoColorGradient(style: "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter", variant: number): void; /** - * Use formatting compatible with Microsoft Word 97. + * Sets the fill to a uniform color. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - word97 = "Word97", + solid(): void; /** - * Use Web-oriented formatting as introduced in Microsoft Word 2000. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - word2000 = "Word2000", + load(options?: Word.Interfaces.FillFormatLoadOptions): Word.FillFormat; /** - * Use formatting compatible with Microsoft Word 2002. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - word2002 = "Word2002", + load(propertyNames?: string | string[]): Word.FillFormat; + /** + * 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; + }): Word.FillFormat; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.FillFormat; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.FillFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.FillFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FillFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.FillFormatData; } /** - * Specifies the type of emphasis mark to use for a character or designated character string. + * Represents the glow formatting for the font used by the range of text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum EmphasisMark { + export class GlowFormat 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; /** - * No emphasis mark. + * Returns a `ColorFormat` object that represents the color for a glow effect. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + readonly color: Word.ColorFormat; /** - * Emphasis mark over a solid circle. + * Specifies the length of the radius for a glow effect. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - overSolidCircle = "OverSolidCircle", + radius: number; /** - * Emphasis mark over a comma. + * Specifies the degree of transparency for the glow effect as a value between 0.0 (opaque) and 1.0 (clear). + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - overComma = "OverComma", + transparency: number; /** - * Emphasis mark over a white circle. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - overWhiteCircle = "OverWhiteCircle", + set(properties: Interfaces.GlowFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.GlowFormat): void; /** - * Emphasis mark under a solid circle. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - underSolidCircle = "UnderSolidCircle", - } - /** - * Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion) - and automatically changes when the shape's fill changes, or whether the extrusion color is independent of the shape's fill. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ExtrusionColorType { + load(options?: Word.Interfaces.GlowFormatLoadOptions): Word.GlowFormat; /** - * Represents a mixed extrusion color type. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - mixed = "mixed", + load(propertyNames?: string | string[]): Word.GlowFormat; /** - * Represents an automatic extrusion color based on the shape's fill. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - automatic = "automatic", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.GlowFormat; /** - * Represents a custom extrusion color independent of the shape's fill. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - custom = "custom", + track(): Word.GlowFormat; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.GlowFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.GlowFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.GlowFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.GlowFormatData; } /** - * Specifies a shape's fill type. + * Represents line and arrowhead formatting. For a line, the `LineFormat` object contains formatting information for the line itself; + for a shape with a border, this object contains formatting information for the shape's border. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum FillType { + export class LineFormat 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 a mixed fill type. + * Gets a `ColorFormat` object that represents the background color for a patterned line. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + readonly backgroundColor: Word.ColorFormat; /** - * Represents a solid fill type. + * Gets a `ColorFormat` object that represents the foreground color for the line. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - solid = "Solid", + readonly foregroundColor: Word.ColorFormat; /** - * Represents a patterned fill type. + * Specifies the length of the arrowhead at the beginning of the line. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - patterned = "Patterned", + beginArrowheadLength: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; /** - * Represents a gradient fill type. + * Specifies the style of the arrowhead at the beginning of the line. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gradient = "Gradient", + beginArrowheadStyle: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; /** - * Represents a textured fill type. + * Specifies the width of the arrowhead at the beginning of the line. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textured = "Textured", + beginArrowheadWidth: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; /** - * Represents a background fill type. + * Specifies the dash style for the line. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - background = "Background", + dashStyle: Word.LineDashStyle | "Mixed" | "Solid" | "SquareDot" | "RoundDot" | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "SysDash" | "SysDot" | "SysDashDot"; /** - * Represents a picture fill type. + * Specifies the length of the arrowhead at the end of the line. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - picture = "Picture", - } - /** - * Specifies the type of gradient used in a shape's fill. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum GradientColorType { + endArrowheadLength: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; /** - * Mixed gradient color type. Used when multiple shapes with different gradient types are selected. + * Specifies the style of the arrowhead at the end of the line. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + endArrowheadStyle: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; /** - * Gradient with a single color and varying transparency or brightness. + * Specifies the width of the arrowhead at the end of the line. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - oneColor = "OneColor", + endArrowheadWidth: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; /** - * Gradient that blends two distinct colors. + * Specifies if to draw lines inside a shape. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - twoColors = "TwoColors", + insetPen: boolean; /** - * Gradient that uses a predefined set of colors. + * Specifies if the object, or the formatting applied to it, is visible. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetColors = "PresetColors", + isVisible: boolean; /** - * Gradient that includes more than two colors, often customized. + * Specifies the pattern applied to the line. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - multiColor = "MultiColor", - } - /** - * Specifies the style for a gradient fill. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum GradientStyle { + pattern: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"; /** - * Represents a mixed gradient style. + * Specifies the line format style. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + style: Word.LineFormatStyle | "Mixed" | "Single" | "ThinThin" | "ThinThick" | "ThickThin" | "ThickBetweenThin"; /** - * Represents a horizontal gradient style. + * Specifies the degree of transparency of the line as a value between 0.0 (opaque) and 1.0 (clear). + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontal = "Horizontal", + transparency: number; /** - * Represents a vertical gradient style. + * Specifies the thickness of the line in points. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - vertical = "Vertical", + weight: number; /** - * Represents a diagonal-up gradient style. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - diagonalUp = "DiagonalUp", + set(properties: Interfaces.LineFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.LineFormat): void; /** - * Represents a diagonal-down gradient style. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - diagonalDown = "DiagonalDown", + load(options?: Word.Interfaces.LineFormatLoadOptions): Word.LineFormat; /** - * Represents a gradient style from the corner. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - fromCorner = "FromCorner", + load(propertyNames?: string | string[]): Word.LineFormat; /** - * Represents a gradient style from the title. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - fromTitle = "FromTitle", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.LineFormat; /** - * Represents a gradient style from the center. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - fromCenter = "FromCenter", + track(): Word.LineFormat; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.LineFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.LineFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.LineFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.LineFormatData; } /** - * Specifies the type of ligature applied to a font. + * Represents the reflection formatting for a shape in Word. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum Ligature { + export class ReflectionFormat 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; /** - * No ligatures applied. + * Specifies the degree of blur effect applied to the `ReflectionFormat` object as a value between 0.0 and 100.0. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + blur: number; /** - * Standard ligatures applied. + * Specifies the amount of separation, in points, of the reflected image from the shape. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - standard = "Standard", + offset: number; /** - * Contextual ligatures applied. + * Specifies the size of the reflection as a percentage of the reflected shape from 0 to 100. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contextual = "Contextual", + size: number; /** - * Standard and contextual ligatures applied. + * Specifies the degree of transparency for the reflection effect as a value between 0.0 (opaque) and 1.0 (clear). + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - standardContextual = "StandardContextual", + transparency: number; /** - * Historical ligatures applied. + * Specifies a `ReflectionType` value that represents the type and direction of the lighting for a shape reflection. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - historical = "Historical", + type: Word.ReflectionType | "Mixed" | "None" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9"; /** - * Standard and historical ligatures applied. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - standardHistorical = "StandardHistorical", + set(properties: Interfaces.ReflectionFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ReflectionFormat): void; /** - * Contextual and historical ligatures applied. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - contextualHistorical = "ContextualHistorical", + load(options?: Word.Interfaces.ReflectionFormatLoadOptions): Word.ReflectionFormat; /** - * Standard, contextual, and historical ligatures applied. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - standardContextualHistorical = "StandardContextualHistorical", + load(propertyNames?: string | string[]): Word.ReflectionFormat; /** - * Discretional ligatures applied. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - discretional = "Discretional", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.ReflectionFormat; /** - * Standard and discretional ligatures applied. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - standardDiscretional = "StandardDiscretional", + track(): Word.ReflectionFormat; /** - * Contextual and discretional ligatures applied. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - contextualDiscretional = "ContextualDiscretional", + untrack(): Word.ReflectionFormat; /** - * Standard, contextual, and discretional ligatures applied. + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ReflectionFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ReflectionFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.ReflectionFormatData; + } + /** + * Represents the color formatting of a shape or text in Word. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class ColorFormat 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 brightness of a specified shape color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - standardContextualDiscretional = "StandardContextualDiscretional", + brightness: number; /** - * Historical and discretional ligatures applied. + * Specifies the theme color for a color format. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - historicalDiscretional = "HistoricalDiscretional", + objectThemeColor: Word.ThemeColorIndex | "NotThemeColor" | "MainDark1" | "MainLight1" | "MainDark2" | "MainLight2" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Hyperlink" | "HyperlinkFollowed" | "Background1" | "Text1" | "Background2" | "Text2"; /** - * Standard, historical, and discretional ligatures applied. + * Specifies the red-green-blue (RGB) value of the specified color. You can provide the value in the '#RRGGBB' format. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - standardHistoricalDiscretional = "StandardHistoricalDiscretional", + rgb: string; /** - * Contextual, historical, and discretional ligatures applied. + * Specifies the lightening or darkening of a specified shape's color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contextualHistoricalDiscretional = "ContextualHistoricalDiscretional", + tintAndShade: number; /** - * All ligatures applied. + * Returns the shape color type. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - all = "All", + readonly type: Word.ColorType | "rgb" | "scheme"; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ColorFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ColorFormat): 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?: Word.Interfaces.ColorFormatLoadOptions): Word.ColorFormat; + /** + * 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[]): Word.ColorFormat; + /** + * 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; + }): Word.ColorFormat; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.ColorFormat; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.ColorFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ColorFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ColorFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.ColorFormatData; } /** - * Indicates the effects lighting for an object. + * Represents the shadow formatting for a shape or text in Word. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum LightRigType { + export class ShadowFormat 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 a mixed light rig type. + * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + readonly foregroundColor: Word.ColorFormat; /** - * Represents legacy flat light rig type 1. + * Specifies the blur level for a shadow format as a value between 0.0 and 100.0. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyFlat1 = "LegacyFlat1", + blur: number; /** - * Represents legacy flat light rig type 2. + * Specifies whether the object or the formatting applied to it is visible. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyFlat2 = "LegacyFlat2", + isVisible: boolean; /** - * Represents legacy flat light rig type 3. + * Specifies `true` if the shadow of the shape appears filled in and is obscured by the shape, even if the shape has no fill, + `false` if the shadow has no fill and the outline of the shadow is visible through the shape if the shape has no fill. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyFlat3 = "LegacyFlat3", + obscured: boolean; /** - * Represents legacy flat light rig type 4. + * Specifies the horizontal offset (in points) of the shadow from the shape. + A positive value offsets the shadow to the right of the shape; a negative value offsets it to the left. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyFlat4 = "LegacyFlat4", + offsetX: number; /** - * Represents legacy normal light rig type 1. + * Specifies the vertical offset (in points) of the shadow from the shape. + A positive value offsets the shadow to the top of the shape; a negative value offsets it to the bottom. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyNormal1 = "LegacyNormal1", + offsetY: number; /** - * Represents legacy normal light rig type 2. + * Specifies whether to rotate the shadow when rotating the shape. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyNormal2 = "LegacyNormal2", + rotateWithShape: boolean; /** - * Represents legacy normal light rig type 3. + * Specifies the width of the shadow. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyNormal3 = "LegacyNormal3", + size: number; /** - * Represents legacy normal light rig type 4. + * Specifies the type of shadow formatting to apply to a shape. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyNormal4 = "LegacyNormal4", + style: Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow"; /** - * Represents legacy harsh light rig type 1. + * Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear). + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyHarsh1 = "LegacyHarsh1", + transparency: number; /** - * Represents legacy harsh light rig type 2. + * Specifies the shape shadow type. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyHarsh2 = "LegacyHarsh2", + type: Word.ShadowType | "Mixed" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9" | "Type10" | "Type11" | "Type12" | "Type13" | "Type14" | "Type15" | "Type16" | "Type17" | "Type18" | "Type19" | "Type20" | "Type21" | "Type22" | "Type23" | "Type24" | "Type25" | "Type26" | "Type27" | "Type28" | "Type29" | "Type30" | "Type31" | "Type32" | "Type33" | "Type34" | "Type35" | "Type36" | "Type37" | "Type38" | "Type39" | "Type40" | "Type41" | "Type42" | "Type43"; /** - * Represents legacy harsh light rig type 3. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - legacyHarsh3 = "LegacyHarsh3", + set(properties: Interfaces.ShadowFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ShadowFormat): void; /** - * Represents legacy harsh light rig type 4. + * Changes the horizontal offset of the shadow by the number of points. + Increment The number of points to adjust. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyHarsh4 = "LegacyHarsh4", + incrementOffsetX(increment: number): void; /** - * Represents a three-point light rig type. + * Changes the vertical offset of the shadow by the specified number of points. + Increment The number of points to adjust. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - threePoint = "ThreePoint", + incrementOffsetY(increment: number): void; /** - * Represents a balanced light rig type. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - balanced = "Balanced", + load(options?: Word.Interfaces.ShadowFormatLoadOptions): Word.ShadowFormat; /** - * Represents a soft light rig type. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - soft = "Soft", + load(propertyNames?: string | string[]): Word.ShadowFormat; /** - * Represents a harsh light rig type. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - harsh = "Harsh", - /** - * Represents a flood light rig type. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.ShadowFormat; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - flood = "Flood", + track(): Word.ShadowFormat; /** - * Represents a contrasting light rig type. + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.ShadowFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ShadowFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShadowFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.ShadowFormatData; + } + /** + * Represents a shape's three-dimensional formatting. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class ThreeDimensionalFormat 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 `ColorFormat` object that represents color of the contour of a shape. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contrasting = "Contrasting", + readonly contourColor: Word.ColorFormat; /** - * Represents a morning light rig type. + * Returns a `ColorFormat` object that represents the color of the shape's extrusion. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - morning = "Morning", + readonly extrusionColor: Word.ColorFormat; /** - * Represents a sunrise light rig type. + * Specifies the depth of the bottom bevel. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sunrise = "Sunrise", + bevelBottomDepth: number; /** - * Represents a sunset light rig type. + * Specifies the inset size for the bottom bevel. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sunset = "Sunset", + bevelBottomInset: number; /** - * Represents a chilly light rig type. + * Specifies a `BevelType` value that represents the bevel type for the bottom bevel. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - chilly = "Chilly", + bevelBottomType: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; /** - * Represents a freezing light rig type. + * Specifies the depth of the top bevel. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - freezing = "Freezing", + bevelTopDepth: number; /** - * Represents a flat light rig type. + * Specifies the inset size for the top bevel. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - flat = "Flat", + bevelTopInset: number; /** - * Represents a two-point light rig type. + * Specifies a `BevelType` value that represents the bevel type for the top bevel. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - twoPoint = "TwoPoint", + bevelTopType: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; /** - * Represents a glow light rig type. + * Specifies the width of the contour of a shape. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - glow = "Glow", + contourWidth: number; /** - * Represents a bright room light rig type. + * Specifies the depth of the shape's extrusion. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - brightRoom = "BrightRoom", - } - /** - * Specifies the dash style for a line. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum LineDashStyle { + depth: number; /** - * Represents a mixed dash style. + * Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion) + and automatically changes when the shape's fill changes, or whether the extrusion color is independent of the shape's fill. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + extrusionColorType: Word.ExtrusionColorType | "mixed" | "automatic" | "custom"; /** - * Represents a solid line style. + * Specifies the amount of perspective for a shape. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - solid = "Solid", + fieldOfView: number; /** - * Represents a square dot line style. + * Specifies `true` if the extrusion appears in perspective — that is, if the walls of the extrusion narrow toward a vanishing point, + `false` if the extrusion is a parallel, or orthographic, projection — that is, if the walls don't narrow toward a vanishing point. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - squareDot = "SquareDot", + isPerspective: boolean; /** - * Represents a round dot line style. + * Specifies if the specified object, or the formatting applied to it, is visible. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - roundDot = "RoundDot", + isVisible: boolean; /** - * Represents a dashed line style. + * Specifies the angle of the lighting. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dash = "Dash", + lightAngle: number; /** - * Represents a dash-dot line style. + * Returns a `PresetCamera` value that represents the camera presets. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashDot = "DashDot", + readonly presetCamera: Word.PresetCamera | "Mixed" | "LegacyObliqueTopLeft" | "LegacyObliqueTop" | "LegacyObliqueTopRight" | "LegacyObliqueLeft" | "LegacyObliqueFront" | "LegacyObliqueRight" | "LegacyObliqueBottomLeft" | "LegacyObliqueBottom" | "LegacyObliqueBottomRight" | "LegacyPerspectiveTopLeft" | "LegacyPerspectiveTop" | "LegacyPerspectiveTopRight" | "LegacyPerspectiveLeft" | "LegacyPerspectiveFront" | "LegacyPerspectiveRight" | "LegacyPerspectiveBottomLeft" | "LegacyPerspectiveBottom" | "LegacyPerspectiveBottomRight" | "OrthographicFront" | "IsometricTopUp" | "IsometricTopDown" | "IsometricBottomUp" | "IsometricBottomDown" | "IsometricLeftUp" | "IsometricLeftDown" | "IsometricRightUp" | "IsometricRightDown" | "IsometricOffAxis1Left" | "IsometricOffAxis1Right" | "IsometricOffAxis1Top" | "IsometricOffAxis2Left" | "IsometricOffAxis2Right" | "IsometricOffAxis2Top" | "IsometricOffAxis3Left" | "IsometricOffAxis3Right" | "IsometricOffAxis3Bottom" | "IsometricOffAxis4Left" | "IsometricOffAxis4Right" | "IsometricOffAxis4Bottom" | "ObliqueTopLeft" | "ObliqueTop" | "ObliqueTopRight" | "ObliqueLeft" | "ObliqueRight" | "ObliqueBottomLeft" | "ObliqueBottom" | "ObliqueBottomRight" | "PerspectiveFront" | "PerspectiveLeft" | "PerspectiveRight" | "PerspectiveAbove" | "PerspectiveBelow" | "PerspectiveAboveLeftFacing" | "PerspectiveAboveRightFacing" | "PerspectiveContrastingLeftFacing" | "PerspectiveContrastingRightFacing" | "PerspectiveHeroicLeftFacing" | "PerspectiveHeroicRightFacing" | "PerspectiveHeroicExtremeLeftFacing" | "PerspectiveHeroicExtremeRightFacing" | "PerspectiveRelaxed" | "PerspectiveRelaxedModerately"; /** - * Represents a dash-dot-dot line style. + * Returns the direction taken by the extrusion's sweep path leading away from the extruded shape (the front face of the extrusion). + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashDotDot = "DashDotDot", + readonly presetExtrusionDirection: Word.PresetExtrusionDirection | "Mixed" | "BottomRight" | "Bottom" | "BottomLeft" | "Right" | "None" | "Left" | "TopRight" | "Top" | "TopLeft"; /** - * Represents a long dash line style. + * Specifies a `LightRigType` value that represents the lighting preset. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - longDash = "LongDash", + presetLighting: Word.LightRigType | "Mixed" | "LegacyFlat1" | "LegacyFlat2" | "LegacyFlat3" | "LegacyFlat4" | "LegacyNormal1" | "LegacyNormal2" | "LegacyNormal3" | "LegacyNormal4" | "LegacyHarsh1" | "LegacyHarsh2" | "LegacyHarsh3" | "LegacyHarsh4" | "ThreePoint" | "Balanced" | "Soft" | "Harsh" | "Flood" | "Contrasting" | "Morning" | "Sunrise" | "Sunset" | "Chilly" | "Freezing" | "Flat" | "TwoPoint" | "Glow" | "BrightRoom"; /** - * Represents a long dash-dot line style. + * Specifies the position of the light source relative to the extrusion. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - longDashDot = "LongDashDot", + presetLightingDirection: Word.PresetLightingDirection | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "None" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; /** - * Represents a long dash-dot-dot line style. + * Specifies the intensity of the extrusion lighting. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - longDashDotDot = "LongDashDotDot", + presetLightingSoftness: Word.PresetLightingSoftness | "Mixed" | "Dim" | "Normal" | "Bright"; /** - * Represents a system dash line style. + * Specifies the extrusion surface material. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sysDash = "SysDash", + presetMaterial: Word.PresetMaterial | "Mixed" | "Matte" | "Plastic" | "Metal" | "WireFrame" | "Matte2" | "Plastic2" | "Metal2" | "WarmMatte" | "TranslucentPowder" | "Powder" | "DarkEdge" | "SoftEdge" | "Clear" | "Flat" | "SoftMetal"; /** - * Represents a system dot line style. + * Returns the preset extrusion format. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sysDot = "SysDot", + readonly presetThreeDimensionalFormat: Word.PresetThreeDimensionalFormat | "Mixed" | "Format1" | "Format2" | "Format3" | "Format4" | "Format5" | "Format6" | "Format7" | "Format8" | "Format9" | "Format10" | "Format11" | "Format12" | "Format13" | "Format14" | "Format15" | "Format16" | "Format17" | "Format18" | "Format19" | "Format20"; /** - * Represents a system dash-dot line style. + * Specifies whether text on a shape rotates with shape. `true` rotates the text. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sysDashDot = "SysDashDot", - } - /** - * Specifies the style for a line. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum LineFormatStyle { + projectText: boolean; /** - * Represents a mixed line style. + * Specifies the rotation of the extruded shape around the x-axis in degrees. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + rotationX: number; /** - * Represents a single line style. + * Specifies the rotation of the extruded shape around the y-axis in degrees. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - single = "Single", + rotationY: number; /** - * Represents a thin-thin line style. + * Specifies the z-axis rotation of the camera. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thinThin = "ThinThin", + rotationZ: number; /** - * Represents a thin-thick line style. + * Specifies the position on the z-axis for the shape. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thinThick = "ThinThick", + z: number; /** - * Represents a thick-thin line style. + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ThreeDimensionalFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ThreeDimensionalFormat): void; + /** + * Horizontally rotates a shape on the x-axis. + The number of degrees to rotate. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thickThin = "ThickThin", + incrementRotationHorizontal(increment: number): void; /** - * Represents a thick line between two thin lines style. + * Vertically rotates a shape on the y-axis. + The number of degrees to rotate. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thickBetweenThin = "ThickBetweenThin", - } - /** - * Specifies the portion of a list to which to apply a list template. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ListApplyTo { + incrementRotationVertical(increment: number): void; /** - * Applies the list template to the entire list. + * Changes the rotation around the x-axis. + The number of degrees to rotate. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - wholeList = "WholeList", + incrementRotationX(increment: number): void; /** - * Applies the list template from the cursor insertion point to the end of the list. + * Changes the rotation around the y-axis. + The number of degrees to rotate. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thisPointForward = "ThisPointForward", + incrementRotationY(increment: number): void; /** - * Applies the list template to the selection. + * Rotates a shape on the z-axis. + The number of degrees to rotate. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - selection = "Selection", - } - /** - * Represents the list type. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ListType { + incrementRotationZ(increment: number): void; /** - * List with no bullets, numbering, or outlining. + * Resets the extrusion rotation around the x-axis, y-axis, and z-axis to 0. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listNoNumbering = "ListNoNumbering", + resetRotation(): void; /** - * ListNum fields that can be used in the body of a paragraph. + * Sets the direction of the extrusion's sweep path. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param presetExtrusionDirection - The preset direction. */ - listListNumOnly = "ListListNumOnly", + setExtrusionDirection(presetExtrusionDirection: Word.PresetExtrusionDirection): void; /** - * Bulleted list. + * Sets the direction of the extrusion's sweep path. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param presetExtrusionDirection - The preset direction. */ - listBullet = "ListBullet", + setExtrusionDirection(presetExtrusionDirection: "Mixed" | "BottomRight" | "Bottom" | "BottomLeft" | "Right" | "None" | "Left" | "TopRight" | "Top" | "TopLeft"): void; /** - * Simple numeric list. + * Sets the camera preset for the shape. + The preset camera type. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listSimpleNumbering = "ListSimpleNumbering", + setPresetCamera(presetCamera: Word.PresetCamera): void; /** - * Outlined list. + * Sets the camera preset for the shape. + The preset camera type. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listOutlineNumbering = "ListOutlineNumbering", + setPresetCamera(presetCamera: "Mixed" | "LegacyObliqueTopLeft" | "LegacyObliqueTop" | "LegacyObliqueTopRight" | "LegacyObliqueLeft" | "LegacyObliqueFront" | "LegacyObliqueRight" | "LegacyObliqueBottomLeft" | "LegacyObliqueBottom" | "LegacyObliqueBottomRight" | "LegacyPerspectiveTopLeft" | "LegacyPerspectiveTop" | "LegacyPerspectiveTopRight" | "LegacyPerspectiveLeft" | "LegacyPerspectiveFront" | "LegacyPerspectiveRight" | "LegacyPerspectiveBottomLeft" | "LegacyPerspectiveBottom" | "LegacyPerspectiveBottomRight" | "OrthographicFront" | "IsometricTopUp" | "IsometricTopDown" | "IsometricBottomUp" | "IsometricBottomDown" | "IsometricLeftUp" | "IsometricLeftDown" | "IsometricRightUp" | "IsometricRightDown" | "IsometricOffAxis1Left" | "IsometricOffAxis1Right" | "IsometricOffAxis1Top" | "IsometricOffAxis2Left" | "IsometricOffAxis2Right" | "IsometricOffAxis2Top" | "IsometricOffAxis3Left" | "IsometricOffAxis3Right" | "IsometricOffAxis3Bottom" | "IsometricOffAxis4Left" | "IsometricOffAxis4Right" | "IsometricOffAxis4Bottom" | "ObliqueTopLeft" | "ObliqueTop" | "ObliqueTopRight" | "ObliqueLeft" | "ObliqueRight" | "ObliqueBottomLeft" | "ObliqueBottom" | "ObliqueBottomRight" | "PerspectiveFront" | "PerspectiveLeft" | "PerspectiveRight" | "PerspectiveAbove" | "PerspectiveBelow" | "PerspectiveAboveLeftFacing" | "PerspectiveAboveRightFacing" | "PerspectiveContrastingLeftFacing" | "PerspectiveContrastingRightFacing" | "PerspectiveHeroicLeftFacing" | "PerspectiveHeroicRightFacing" | "PerspectiveHeroicExtremeLeftFacing" | "PerspectiveHeroicExtremeRightFacing" | "PerspectiveRelaxed" | "PerspectiveRelaxedModerately"): void; /** - * Mixed numeric list. + * Sets the preset extrusion format. + The preset format. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listMixedNumbering = "ListMixedNumbering", + setThreeDimensionalFormat(presetThreeDimensionalFormat: Word.PresetThreeDimensionalFormat): void; /** - * Picture bulleted list. + * Sets the preset extrusion format. + The preset format. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listPictureBullet = "ListPictureBullet", + setThreeDimensionalFormat(presetThreeDimensionalFormat: "Mixed" | "Format1" | "Format2" | "Format3" | "Format4" | "Format5" | "Format6" | "Format7" | "Format8" | "Format9" | "Format10" | "Format11" | "Format12" | "Format13" | "Format14" | "Format15" | "Format16" | "Format17" | "Format18" | "Format19" | "Format20"): 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?: Word.Interfaces.ThreeDimensionalFormatLoadOptions): Word.ThreeDimensionalFormat; + /** + * 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[]): Word.ThreeDimensionalFormat; + /** + * 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; + }): Word.ThreeDimensionalFormat; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.ThreeDimensionalFormat; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.ThreeDimensionalFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ThreeDimensionalFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ThreeDimensionalFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.ThreeDimensionalFormatData; } /** - * Specifies the number form setting for an OpenType font. + * Specifies the length of the arrowhead at the end of a line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum NumberForm { + enum ArrowheadLength { /** - * Default number form setting. + * Represents a mixed arrowhead length. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - default = "Default", + mixed = "Mixed", /** - * Lining number form setting. + * Represents a short arrowhead length. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lining = "Lining", + short = "Short", /** - * Old-style number form setting. + * Represents a medium arrowhead length. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - oldStyle = "OldStyle", + medium = "Medium", + /** + * Represents a long arrowhead length. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + long = "Long", } /** - * Specifies the number spacing setting for an OpenType font. + * Specifies the style of the arrowhead at the end of a line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum NumberSpacing { + enum ArrowheadStyle { /** - * Default number spacing setting. + * Represents a mixed arrowhead style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - default = "Default", + mixed = "Mixed", /** - * Proportional number spacing setting. + * Represents no arrowhead. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - proportional = "Proportional", + none = "None", /** - * Tabular number spacing setting. + * Represents a triangle arrowhead style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tabular = "Tabular", - } - /** - * Specifies the type of numbers in a list. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum NumberType { + triangle = "Triangle", /** - * Preset numbers you can add to paragraphs by selecting a template in the **Bullets and Numbering** dialog box. + * Represents an open arrowhead style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - paragraph = "Paragraph", + open = "Open", /** - * Default value for {@link https://support.microsoft.com/office/557541b1-abb2-4959-a9f2-401639c8ff82 | ListNum fields}. + * Represents a stealth arrowhead style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listNum = "ListNum", + stealth = "Stealth", /** - * Default value for all other cases. + * Represents a diamond arrowhead style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - allNumbers = "AllNumbers", + diamond = "Diamond", + /** + * Represents an oval arrowhead style. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + oval = "Oval", } /** - * Specifies the fill pattern used in a shape. + * Specifies the width of the arrowhead at the end of a line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum PatternType { + enum ArrowheadWidth { /** - * Represents a mixed pattern type. + * Represents a mixed arrowhead width. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ mixed = "Mixed", /** - * Represents a 5 percent fill pattern. + * Represents a narrow arrowhead width. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent5 = "Percent5", + narrow = "Narrow", /** - * Represents a 10 percent fill pattern. + * Represents a medium arrowhead width. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent10 = "Percent10", + medium = "Medium", /** - * Represents a 20 percent fill pattern. + * Represents a wide arrowhead width. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent20 = "Percent20", + wide = "Wide", + } + /** + * Indicates the bevel type of a {@link Word.ThreeDimensionalFormat} object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum BevelType { /** - * Represents a 25 percent fill pattern. + * Represents a mixed bevel type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent25 = "Percent25", + mixed = "mixed", /** - * Represents a 30 percent fill pattern. + * Represents no bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent30 = "Percent30", + none = "none", /** - * Represents a 40 percent fill pattern. + * Represents a relaxed inset bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent40 = "Percent40", + relaxedInset = "relaxedInset", /** - * Represents a 50 percent fill pattern. + * Represents a circle bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent50 = "Percent50", + circle = "circle", /** - * Represents a 60 percent fill pattern. + * Represents a slope bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent60 = "Percent60", + slope = "slope", /** - * Represents a 70 percent fill pattern. + * Represents a cross bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent70 = "Percent70", + cross = "cross", /** - * Represents a 75 percent fill pattern. + * Represents an angle bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent75 = "Percent75", + angle = "angle", /** - * Represents an 80 percent fill pattern. + * Represents a soft round bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent80 = "Percent80", + softRound = "softRound", /** - * Represents a 90 percent fill pattern. + * Represents a convex bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent90 = "Percent90", + convex = "convex", /** - * Represents a dark horizontal fill pattern. + * Represents a cool slant bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - darkHorizontal = "DarkHorizontal", + coolSlant = "coolSlant", /** - * Represents a dark vertical fill pattern. + * Represents a divot bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - darkVertical = "DarkVertical", + divot = "divot", /** - * Represents a dark downward diagonal fill pattern. + * Represents a riblet bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - darkDownwardDiagonal = "DarkDownwardDiagonal", + riblet = "riblet", /** - * Represents a dark upward diagonal fill pattern. + * Represents a hard edge bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - darkUpwardDiagonal = "DarkUpwardDiagonal", + hardEdge = "hardEdge", /** - * Represents a small checkerboard fill pattern. + * Represents an art deco bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - smallCheckerBoard = "SmallCheckerBoard", + artDeco = "artDeco", + } + /** + * Represents color index values in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ColorIndex { /** - * Represents a trellis fill pattern. + * Automatically determines the color. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - trellis = "Trellis", + auto = "Auto", /** - * Represents a light horizontal fill pattern. + * Represents the color black. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lightHorizontal = "LightHorizontal", + black = "Black", /** - * Represents a light vertical fill pattern. + * Represents the color blue. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lightVertical = "LightVertical", + blue = "Blue", /** - * Represents a light downward diagonal fill pattern. + * Represents the color turquoise. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lightDownwardDiagonal = "LightDownwardDiagonal", + turquoise = "Turquoise", /** - * Represents a light upward diagonal fill pattern. + * Represents a bright green color. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lightUpwardDiagonal = "LightUpwardDiagonal", + brightGreen = "BrightGreen", /** - * Represents a small grid fill pattern. + * Represents the color pink. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - smallGrid = "SmallGrid", + pink = "Pink", /** - * Represents a dotted diamond fill pattern. + * Represents the color red. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dottedDiamond = "DottedDiamond", + red = "Red", /** - * Represents a wide downward diagonal fill pattern. + * Represents the color yellow. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - wideDownwardDiagonal = "WideDownwardDiagonal", + yellow = "Yellow", /** - * Represents a wide upward diagonal fill pattern. + * Represents the color white. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - wideUpwardDiagonal = "WideUpwardDiagonal", - /** - * Represents a dashed upward diagonal fill pattern. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - dashedUpwardDiagonal = "DashedUpwardDiagonal", + white = "White", /** - * Represents a dashed downward diagonal fill pattern. + * Represents a dark blue color. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashedDownwardDiagonal = "DashedDownwardDiagonal", + darkBlue = "DarkBlue", /** - * Represents a narrow vertical fill pattern. + * Represents the color teal. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - narrowVertical = "NarrowVertical", + teal = "Teal", /** - * Represents a narrow horizontal fill pattern. + * Represents the color green. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - narrowHorizontal = "NarrowHorizontal", + green = "Green", /** - * Represents a dashed vertical fill pattern. + * Represents the color violet. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashedVertical = "DashedVertical", + violet = "Violet", /** - * Represents a dashed horizontal fill pattern. + * Represents a dark red color. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashedHorizontal = "DashedHorizontal", + darkRed = "DarkRed", /** - * Represents a large confetti fill pattern. + * Represents a dark yellow color. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - largeConfetti = "LargeConfetti", + darkYellow = "DarkYellow", /** - * Represents a large grid fill pattern. + * Represents a gray color with 50% intensity. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - largeGrid = "LargeGrid", + gray50 = "Gray50", /** - * Represents a horizontal brick fill pattern. + * Represents a gray color with 25% intensity. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontalBrick = "HorizontalBrick", + gray25 = "Gray25", /** - * Represents a large checkerboard fill pattern. + * Represents a classic red color. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - largeCheckerBoard = "LargeCheckerBoard", + classicRed = "ClassicRed", /** - * Represents a small confetti fill pattern. + * Represents a classic blue color. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - smallConfetti = "SmallConfetti", + classicBlue = "ClassicBlue", /** - * Represents a zigzag fill pattern. + * Represents a color determined by the author. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - zigZag = "ZigZag", + byAuthor = "ByAuthor", + } + /** + * Specifies the color type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ColorType { /** - * Represents a solid diamond fill pattern. + * Represents an RGB color type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - solidDiamond = "SolidDiamond", + rgb = "rgb", /** - * Represents a diagonal brick fill pattern. + * Represents a scheme color type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - diagonalBrick = "DiagonalBrick", + scheme = "scheme", + } + /** + * Specifies whether the formatting from the previous list can be continued. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum Continue { /** - * Represents an outlined diamond fill pattern. + * Formatting cannot continue from the previous list. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - outlinedDiamond = "OutlinedDiamond", + disabled = "Disabled", /** - * Represents a plaid fill pattern. + * Formatting can continue from the previous list. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - plaid = "Plaid", + list = "List", /** - * Represents a sphere fill pattern. + * Numbering can be restarted. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sphere = "Sphere", + reset = "Reset", + } + /** + * Specifies the default list behavior for a list. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum DefaultListBehavior { /** - * Represents a weave fill pattern. + * Use formatting compatible with Microsoft Word 97. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - weave = "Weave", + word97 = "Word97", /** - * Represents a dotted grid fill pattern. + * Use Web-oriented formatting as introduced in Microsoft Word 2000. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dottedGrid = "DottedGrid", + word2000 = "Word2000", /** - * Represents a divot fill pattern. + * Use formatting compatible with Microsoft Word 2002. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - divot = "Divot", + word2002 = "Word2002", + } + /** + * Specifies the type of emphasis mark to use for a character or designated character string. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum EmphasisMark { /** - * Represents a shingle fill pattern. + * No emphasis mark. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shingle = "Shingle", + none = "None", /** - * Represents a wave fill pattern. + * Emphasis mark over a solid circle. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - wave = "Wave", + overSolidCircle = "OverSolidCircle", /** - * Represents a horizontal fill pattern. + * Emphasis mark over a comma. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontal = "Horizontal", + overComma = "OverComma", /** - * Represents a vertical fill pattern. + * Emphasis mark over a white circle. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - vertical = "Vertical", + overWhiteCircle = "OverWhiteCircle", /** - * Represents a cross fill pattern. + * Emphasis mark under a solid circle. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cross = "Cross", + underSolidCircle = "UnderSolidCircle", + } + /** + * Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion) + and automatically changes when the shape's fill changes, or whether the extrusion color is independent of the shape's fill. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ExtrusionColorType { /** - * Represents a downward diagonal fill pattern. + * Represents a mixed extrusion color type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - downwardDiagonal = "DownwardDiagonal", + mixed = "mixed", /** - * Represents an upward diagonal fill pattern. + * Represents an automatic extrusion color based on the shape's fill. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - upwardDiagonal = "UpwardDiagonal", + automatic = "automatic", /** - * Represents a diagonal cross fill pattern. + * Represents a custom extrusion color independent of the shape's fill. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - diagonalCross = "DiagonalCross", + custom = "custom", } /** - * Indicates the effects camera type used by the specified object. + * Specifies a shape's fill type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum PresetCamera { + enum FillType { /** - * Represents a mixed camera type. + * Represents a mixed fill type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ mixed = "Mixed", /** - * Represents a legacy oblique top-left camera type. + * Represents a solid fill type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyObliqueTopLeft = "LegacyObliqueTopLeft", + solid = "Solid", /** - * Represents a legacy oblique top camera type. + * Represents a patterned fill type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyObliqueTop = "LegacyObliqueTop", + patterned = "Patterned", /** - * Represents a legacy oblique top-right camera type. + * Represents a gradient fill type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyObliqueTopRight = "LegacyObliqueTopRight", + gradient = "Gradient", /** - * Represents a legacy oblique left camera type. + * Represents a textured fill type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyObliqueLeft = "LegacyObliqueLeft", + textured = "Textured", /** - * Represents a legacy oblique front camera type. + * Represents a background fill type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyObliqueFront = "LegacyObliqueFront", + background = "Background", /** - * Represents a legacy oblique right camera type. + * Represents a picture fill type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyObliqueRight = "LegacyObliqueRight", + picture = "Picture", + } + /** + * Specifies the type of gradient used in a shape's fill. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum GradientColorType { /** - * Represents a legacy oblique bottom-left camera type. + * Mixed gradient color type. Used when multiple shapes with different gradient types are selected. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyObliqueBottomLeft = "LegacyObliqueBottomLeft", + mixed = "Mixed", /** - * Represents a legacy oblique bottom camera type. + * Gradient with a single color and varying transparency or brightness. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyObliqueBottom = "LegacyObliqueBottom", + oneColor = "OneColor", /** - * Represents a legacy oblique bottom-right camera type. + * Gradient that blends two distinct colors. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyObliqueBottomRight = "LegacyObliqueBottomRight", + twoColors = "TwoColors", /** - * Represents a legacy perspective top-left camera type. + * Gradient that uses a predefined set of colors. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyPerspectiveTopLeft = "LegacyPerspectiveTopLeft", + presetColors = "PresetColors", /** - * Represents a legacy perspective top camera type. + * Gradient that includes more than two colors, often customized. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyPerspectiveTop = "LegacyPerspectiveTop", + multiColor = "MultiColor", + } + /** + * Specifies the style for a gradient fill. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum GradientStyle { /** - * Represents a legacy perspective top-right camera type. + * Represents a mixed gradient style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyPerspectiveTopRight = "LegacyPerspectiveTopRight", + mixed = "Mixed", /** - * Represents a legacy perspective left camera type. + * Represents a horizontal gradient style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyPerspectiveLeft = "LegacyPerspectiveLeft", + horizontal = "Horizontal", /** - * Represents a legacy perspective front camera type. + * Represents a vertical gradient style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyPerspectiveFront = "LegacyPerspectiveFront", + vertical = "Vertical", /** - * Represents a legacy perspective right camera type. + * Represents a diagonal-up gradient style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyPerspectiveRight = "LegacyPerspectiveRight", + diagonalUp = "DiagonalUp", /** - * Represents a legacy perspective bottom-left camera type. + * Represents a diagonal-down gradient style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyPerspectiveBottomLeft = "LegacyPerspectiveBottomLeft", + diagonalDown = "DiagonalDown", /** - * Represents a legacy perspective bottom camera type. + * Represents a gradient style from the corner. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyPerspectiveBottom = "LegacyPerspectiveBottom", + fromCorner = "FromCorner", /** - * Represents a legacy perspective bottom-right camera type. + * Represents a gradient style from the title. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyPerspectiveBottomRight = "LegacyPerspectiveBottomRight", + fromTitle = "FromTitle", /** - * Represents an orthographic front camera type. + * Represents a gradient style from the center. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - orthographicFront = "OrthographicFront", + fromCenter = "FromCenter", + } + /** + * Specifies the type of ligature applied to a font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum Ligature { /** - * Represents an isometric top-up camera type. + * No ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricTopUp = "IsometricTopUp", + none = "None", /** - * Represents an isometric top-down camera type. + * Standard ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricTopDown = "IsometricTopDown", + standard = "Standard", /** - * Represents an isometric bottom-up camera type. + * Contextual ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricBottomUp = "IsometricBottomUp", + contextual = "Contextual", /** - * Represents an isometric bottom-down camera type. + * Standard and contextual ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricBottomDown = "IsometricBottomDown", + standardContextual = "StandardContextual", /** - * Represents an isometric left-up camera type. + * Historical ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricLeftUp = "IsometricLeftUp", + historical = "Historical", /** - * Represents an isometric left-down camera type. + * Standard and historical ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricLeftDown = "IsometricLeftDown", + standardHistorical = "StandardHistorical", /** - * Represents an isometric right-up camera type. + * Contextual and historical ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricRightUp = "IsometricRightUp", + contextualHistorical = "ContextualHistorical", /** - * Represents an isometric right-down camera type. + * Standard, contextual, and historical ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricRightDown = "IsometricRightDown", + standardContextualHistorical = "StandardContextualHistorical", /** - * Represents an isometric off-axis 1 left camera type. + * Discretional ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis1Left = "IsometricOffAxis1Left", + discretional = "Discretional", /** - * Represents an isometric off-axis 1 right camera type. + * Standard and discretional ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis1Right = "IsometricOffAxis1Right", + standardDiscretional = "StandardDiscretional", /** - * Represents an isometric off-axis 1 top camera type. + * Contextual and discretional ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis1Top = "IsometricOffAxis1Top", + contextualDiscretional = "ContextualDiscretional", /** - * Represents an isometric off-axis 2 left camera type. + * Standard, contextual, and discretional ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis2Left = "IsometricOffAxis2Left", + standardContextualDiscretional = "StandardContextualDiscretional", /** - * Represents an isometric off-axis 2 right camera type. + * Historical and discretional ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis2Right = "IsometricOffAxis2Right", + historicalDiscretional = "HistoricalDiscretional", /** - * Represents an isometric off-axis 2 top camera type. + * Standard, historical, and discretional ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis2Top = "IsometricOffAxis2Top", + standardHistoricalDiscretional = "StandardHistoricalDiscretional", /** - * Represents an isometric off-axis 3 left camera type. + * Contextual, historical, and discretional ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis3Left = "IsometricOffAxis3Left", + contextualHistoricalDiscretional = "ContextualHistoricalDiscretional", /** - * Represents an isometric off-axis 3 right camera type. + * All ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis3Right = "IsometricOffAxis3Right", + all = "All", + } + /** + * Indicates the effects lighting for an object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum LightRigType { /** - * Represents an isometric off-axis 3 bottom camera type. + * Represents a mixed light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis3Bottom = "IsometricOffAxis3Bottom", + mixed = "Mixed", /** - * Represents an isometric off-axis 4 left camera type. + * Represents legacy flat light rig type 1. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis4Left = "IsometricOffAxis4Left", + legacyFlat1 = "LegacyFlat1", /** - * Represents an isometric off-axis 4 right camera type. + * Represents legacy flat light rig type 2. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis4Right = "IsometricOffAxis4Right", + legacyFlat2 = "LegacyFlat2", /** - * Represents an isometric off-axis 4 bottom camera type. + * Represents legacy flat light rig type 3. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis4Bottom = "IsometricOffAxis4Bottom", + legacyFlat3 = "LegacyFlat3", /** - * Represents an oblique top-left camera type. + * Represents legacy flat light rig type 4. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - obliqueTopLeft = "ObliqueTopLeft", + legacyFlat4 = "LegacyFlat4", /** - * Represents an oblique top camera type. + * Represents legacy normal light rig type 1. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - obliqueTop = "ObliqueTop", + legacyNormal1 = "LegacyNormal1", /** - * Represents an oblique top-right camera type. + * Represents legacy normal light rig type 2. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - obliqueTopRight = "ObliqueTopRight", + legacyNormal2 = "LegacyNormal2", /** - * Represents an oblique left camera type. + * Represents legacy normal light rig type 3. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - obliqueLeft = "ObliqueLeft", + legacyNormal3 = "LegacyNormal3", /** - * Represents an oblique right camera type. + * Represents legacy normal light rig type 4. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - obliqueRight = "ObliqueRight", + legacyNormal4 = "LegacyNormal4", /** - * Represents an oblique bottom-left camera type. + * Represents legacy harsh light rig type 1. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - obliqueBottomLeft = "ObliqueBottomLeft", + legacyHarsh1 = "LegacyHarsh1", /** - * Represents an oblique bottom camera type. + * Represents legacy harsh light rig type 2. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - obliqueBottom = "ObliqueBottom", + legacyHarsh2 = "LegacyHarsh2", /** - * Represents an oblique bottom-right camera type. + * Represents legacy harsh light rig type 3. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - obliqueBottomRight = "ObliqueBottomRight", + legacyHarsh3 = "LegacyHarsh3", /** - * Represents a perspective front camera type. + * Represents legacy harsh light rig type 4. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveFront = "PerspectiveFront", + legacyHarsh4 = "LegacyHarsh4", /** - * Represents a perspective left camera type. + * Represents a three-point light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveLeft = "PerspectiveLeft", + threePoint = "ThreePoint", /** - * Represents a perspective right camera type. + * Represents a balanced light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveRight = "PerspectiveRight", + balanced = "Balanced", /** - * Represents a perspective above camera type. + * Represents a soft light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveAbove = "PerspectiveAbove", + soft = "Soft", /** - * Represents a perspective below camera type. + * Represents a harsh light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveBelow = "PerspectiveBelow", + harsh = "Harsh", /** - * Represents a perspective above-left facing camera type. + * Represents a flood light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveAboveLeftFacing = "PerspectiveAboveLeftFacing", + flood = "Flood", /** - * Represents a perspective above-right facing camera type. + * Represents a contrasting light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveAboveRightFacing = "PerspectiveAboveRightFacing", + contrasting = "Contrasting", /** - * Represents a perspective contrasting-left facing camera type. + * Represents a morning light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveContrastingLeftFacing = "PerspectiveContrastingLeftFacing", + morning = "Morning", /** - * Represents a perspective contrasting-right facing camera type. + * Represents a sunrise light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveContrastingRightFacing = "PerspectiveContrastingRightFacing", + sunrise = "Sunrise", /** - * Represents a perspective heroic-left facing camera type. + * Represents a sunset light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveHeroicLeftFacing = "PerspectiveHeroicLeftFacing", + sunset = "Sunset", /** - * Represents a perspective heroic-right facing camera type. + * Represents a chilly light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveHeroicRightFacing = "PerspectiveHeroicRightFacing", + chilly = "Chilly", /** - * Represents a perspective heroic-extreme left facing camera type. + * Represents a freezing light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveHeroicExtremeLeftFacing = "PerspectiveHeroicExtremeLeftFacing", + freezing = "Freezing", /** - * Represents a perspective heroic-extreme right facing camera type. + * Represents a flat light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveHeroicExtremeRightFacing = "PerspectiveHeroicExtremeRightFacing", + flat = "Flat", /** - * Represents a relaxed perspective camera type. + * Represents a two-point light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveRelaxed = "PerspectiveRelaxed", + twoPoint = "TwoPoint", /** - * Represents a moderately relaxed perspective camera type. + * Represents a glow light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveRelaxedModerately = "PerspectiveRelaxedModerately", + glow = "Glow", + /** + * Represents a bright room light rig type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + brightRoom = "BrightRoom", } /** - * Specifies the direction that the extrusion's sweep path takes away from the extruded shape (the front face of the extrusion). + * Specifies the dash style for a line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum PresetExtrusionDirection { + enum LineDashStyle { /** - * Represents a mixed extrusion direction. + * Represents a mixed dash style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ mixed = "Mixed", /** - * Represents an extrusion direction to the bottom-right. + * Represents a solid line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottomRight = "BottomRight", + solid = "Solid", /** - * Represents an extrusion direction to the bottom. + * Represents a square dot line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottom = "Bottom", + squareDot = "SquareDot", /** - * Represents an extrusion direction to the bottom-left. + * Represents a round dot line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottomLeft = "BottomLeft", + roundDot = "RoundDot", /** - * Represents an extrusion direction to the right. + * Represents a dashed line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - right = "Right", + dash = "Dash", /** - * Represents no extrusion direction. + * Represents a dash-dot line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + dashDot = "DashDot", /** - * Represents an extrusion direction to the left. + * Represents a dash-dot-dot line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - left = "Left", + dashDotDot = "DashDotDot", /** - * Represents an extrusion direction to the top-right. + * Represents a long dash line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - topRight = "TopRight", + longDash = "LongDash", /** - * Represents an extrusion direction to the top. + * Represents a long dash-dot line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - top = "Top", + longDashDot = "LongDashDot", /** - * Represents an extrusion direction to the top-left. + * Represents a long dash-dot-dot line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - topLeft = "TopLeft", - } - /** - * Specifies which predefined gradient to use to fill a shape. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum PresetGradientType { + longDashDotDot = "LongDashDotDot", /** - * Mixed gradient type. Used when multiple shapes with different preset gradients are selected. + * Represents a system dash line style. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sysDash = "SysDash", + /** + * Represents a system dot line style. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sysDot = "SysDot", + /** + * Represents a system dash-dot line style. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sysDashDot = "SysDashDot", + } + /** + * Specifies the style for a line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum LineFormatStyle { + /** + * Represents a mixed line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ mixed = "Mixed", /** - * A warm gradient resembling an early sunset. + * Represents a single line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - earlySunset = "EarlySunset", + single = "Single", /** - * A deeper, richer gradient resembling a late sunset. + * Represents a thin-thin line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lateSunset = "LateSunset", + thinThin = "ThinThin", /** - * A dark gradient evoking the colors of nightfall. + * Represents a thin-thick line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nightfall = "Nightfall", + thinThick = "ThinThick", /** - * A light gradient representing the colors of daybreak. + * Represents a thick-thin line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - daybreak = "Daybreak", + thickThin = "ThickThin", /** - * A gradient that mimics the colors of the horizon. + * Represents a thick line between two thin lines style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizon = "Horizon", + thickBetweenThin = "ThickBetweenThin", + } + /** + * Specifies the portion of a list to which to apply a list template. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ListApplyTo { /** - * A warm, sandy gradient inspired by desert tones. + * Applies the list template to the entire list. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - desert = "Desert", + wholeList = "WholeList", /** - * A cool gradient reflecting ocean hues. + * Applies the list template from the cursor insertion point to the end of the list. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - ocean = "Ocean", + thisPointForward = "ThisPointForward", /** - * A soft, tranquil gradient resembling calm water. + * Applies the list template to the selection. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - calmWater = "CalmWater", + selection = "Selection", + } + /** + * Represents the list type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ListType { /** - * A vivid gradient with fiery tones. + * List with no bullets, numbering, or outlining. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fire = "Fire", + listNoNumbering = "ListNoNumbering", /** - * A muted gradient with fog-like softness. + * ListNum fields that can be used in the body of a paragraph. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fog = "Fog", + listListNumOnly = "ListListNumOnly", /** - * A natural green gradient inspired by moss. + * Bulleted list. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - moss = "Moss", + listBullet = "ListBullet", /** - * A vibrant gradient with peacock feather colors. + * Simple numeric list. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - peacock = "Peacock", + listSimpleNumbering = "ListSimpleNumbering", /** - * A light, golden gradient resembling wheat. + * Outlined list. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - wheat = "Wheat", + listOutlineNumbering = "ListOutlineNumbering", /** - * A warm, aged paper-like gradient. + * Mixed numeric list. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - parchment = "Parchment", + listMixedNumbering = "ListMixedNumbering", /** - * A rich, reddish-brown gradient like mahogany wood. + * Picture bulleted list. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mahogany = "Mahogany", + listPictureBullet = "ListPictureBullet", + } + /** + * Specifies the number form setting for an OpenType font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum NumberForm { /** - * A colorful gradient resembling a rainbow. + * Default number form setting. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rainbow = "Rainbow", + default = "Default", /** - * A variation of the rainbow gradient with different color emphasis. + * Lining number form setting. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rainbowII = "RainbowII", + lining = "Lining", /** - * A shiny, metallic gold gradient. + * Old-style number form setting. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gold = "Gold", + oldStyle = "OldStyle", + } + /** + * Specifies the number spacing setting for an OpenType font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum NumberSpacing { /** - * A variation of the gold gradient with different tones. + * Default number spacing setting. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - goldII = "GoldII", + default = "Default", /** - * A metallic gradient resembling brass. + * Proportional number spacing setting. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - brass = "Brass", + proportional = "Proportional", /** - * A sleek, reflective chrome gradient. + * Tabular number spacing setting. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - chrome = "Chrome", + tabular = "Tabular", + } + /** + * Specifies the type of numbers in a list. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum NumberType { /** - * A variation of the chrome gradient with alternate highlights. + * Preset numbers you can add to paragraphs by selecting a template in the **Bullets and Numbering** dialog box. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - chromeII = "ChromeII", + paragraph = "Paragraph", /** - * A smooth, metallic silver gradient. + * Default value for {@link https://support.microsoft.com/office/557541b1-abb2-4959-a9f2-401639c8ff82 | ListNum fields}. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - silver = "Silver", + listNum = "ListNum", /** - * A deep blue gradient inspired by sapphire. + * Default value for all other cases. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sapphire = "Sapphire", + allNumbers = "AllNumbers", } /** - * Specifies the location of lighting on an extruded (three-dimensional) shape relative to the shape. + * Specifies the fill pattern used in a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum PresetLightingDirection { + enum PatternType { /** - * Represents a mixed lighting direction. + * Represents a mixed pattern type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ mixed = "Mixed", /** - * Represents lighting from the top-left. + * Represents a 5 percent fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - topLeft = "TopLeft", + percent5 = "Percent5", /** - * Represents lighting from the top. + * Represents a 10 percent fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - top = "Top", + percent10 = "Percent10", /** - * Represents lighting from the top-right. + * Represents a 20 percent fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - topRight = "TopRight", + percent20 = "Percent20", /** - * Represents lighting from the left. + * Represents a 25 percent fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - left = "Left", + percent25 = "Percent25", /** - * Represents no lighting. + * Represents a 30 percent fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + percent30 = "Percent30", /** - * Represents lighting from the right. + * Represents a 40 percent fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - right = "Right", + percent40 = "Percent40", /** - * Represents lighting from the bottom-left. + * Represents a 50 percent fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottomLeft = "BottomLeft", + percent50 = "Percent50", /** - * Represents lighting from the bottom. + * Represents a 60 percent fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottom = "Bottom", + percent60 = "Percent60", /** - * Represents lighting from the bottom-right. + * Represents a 70 percent fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottomRight = "BottomRight", - } - /** - * Specifies the intensity of light used on a shape. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum PresetLightingSoftness { + percent70 = "Percent70", /** - * Represents a mixed lighting softness. + * Represents a 75 percent fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + percent75 = "Percent75", /** - * Represents dim lighting. + * Represents an 80 percent fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dim = "Dim", + percent80 = "Percent80", /** - * Represents normal lighting. + * Represents a 90 percent fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - normal = "Normal", + percent90 = "Percent90", /** - * Represents bright lighting. + * Represents a dark horizontal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bright = "Bright", - } - /** - * Specifies the extrusion surface material. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum PresetMaterial { + darkHorizontal = "DarkHorizontal", /** - * Represents a mixed material type. + * Represents a dark vertical fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + darkVertical = "DarkVertical", /** - * Represents a matte material. + * Represents a dark downward diagonal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - matte = "Matte", + darkDownwardDiagonal = "DarkDownwardDiagonal", /** - * Represents a plastic material. + * Represents a dark upward diagonal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - plastic = "Plastic", + darkUpwardDiagonal = "DarkUpwardDiagonal", /** - * Represents a metal material. + * Represents a small checkerboard fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - metal = "Metal", + smallCheckerBoard = "SmallCheckerBoard", /** - * Represents a wireframe material. + * Represents a trellis fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - wireFrame = "WireFrame", + trellis = "Trellis", /** - * Represents a second matte material. + * Represents a light horizontal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - matte2 = "Matte2", + lightHorizontal = "LightHorizontal", /** - * Represents a second plastic material. + * Represents a light vertical fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - plastic2 = "Plastic2", + lightVertical = "LightVertical", /** - * Represents a second metal material. + * Represents a light downward diagonal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - metal2 = "Metal2", + lightDownwardDiagonal = "LightDownwardDiagonal", /** - * Represents a warm matte material. + * Represents a light upward diagonal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - warmMatte = "WarmMatte", + lightUpwardDiagonal = "LightUpwardDiagonal", /** - * Represents a translucent powder material. + * Represents a small grid fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - translucentPowder = "TranslucentPowder", + smallGrid = "SmallGrid", /** - * Represents a powder material. + * Represents a dotted diamond fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - powder = "Powder", + dottedDiamond = "DottedDiamond", /** - * Represents a dark edge material. + * Represents a wide downward diagonal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - darkEdge = "DarkEdge", + wideDownwardDiagonal = "WideDownwardDiagonal", /** - * Represents a soft edge material. + * Represents a wide upward diagonal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - softEdge = "SoftEdge", + wideUpwardDiagonal = "WideUpwardDiagonal", /** - * Represents a clear material. + * Represents a dashed upward diagonal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - clear = "Clear", + dashedUpwardDiagonal = "DashedUpwardDiagonal", /** - * Represents a flat material. + * Represents a dashed downward diagonal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - flat = "Flat", + dashedDownwardDiagonal = "DashedDownwardDiagonal", /** - * Represents a soft metal material. + * Represents a narrow vertical fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - softMetal = "SoftMetal", - } - /** - * Specifies texture to be used to fill a shape. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum PresetTexture { + narrowVertical = "NarrowVertical", /** - * Represents a mixed texture type. + * Represents a narrow horizontal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + narrowHorizontal = "NarrowHorizontal", /** - * Represents a papyrus texture. + * Represents a dashed vertical fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - papyrus = "Papyrus", + dashedVertical = "DashedVertical", /** - * Represents a canvas texture. + * Represents a dashed horizontal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - canvas = "Canvas", + dashedHorizontal = "DashedHorizontal", /** - * Represents a denim texture. + * Represents a large confetti fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - denim = "Denim", + largeConfetti = "LargeConfetti", /** - * Represents a woven mat texture. + * Represents a large grid fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - wovenMat = "WovenMat", + largeGrid = "LargeGrid", /** - * Represents a water droplets texture. + * Represents a horizontal brick fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - waterDroplets = "WaterDroplets", + horizontalBrick = "HorizontalBrick", /** - * Represents a paper bag texture. + * Represents a large checkerboard fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - paperBag = "PaperBag", + largeCheckerBoard = "LargeCheckerBoard", /** - * Represents a fish fossil texture. + * Represents a small confetti fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fishFossil = "FishFossil", + smallConfetti = "SmallConfetti", /** - * Represents a sand texture. + * Represents a zigzag fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sand = "Sand", + zigZag = "ZigZag", /** - * Represents a green marble texture. + * Represents a solid diamond fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - greenMarble = "GreenMarble", + solidDiamond = "SolidDiamond", /** - * Represents a white marble texture. + * Represents a diagonal brick fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - whiteMarble = "WhiteMarble", + diagonalBrick = "DiagonalBrick", /** - * Represents a brown marble texture. + * Represents an outlined diamond fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - brownMarble = "BrownMarble", + outlinedDiamond = "OutlinedDiamond", /** - * Represents a granite texture. + * Represents a plaid fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - granite = "Granite", + plaid = "Plaid", /** - * Represents a newsprint texture. + * Represents a sphere fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - newsprint = "Newsprint", + sphere = "Sphere", /** - * Represents a recycled paper texture. + * Represents a weave fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - recycledPaper = "RecycledPaper", + weave = "Weave", /** - * Represents a parchment texture. + * Represents a dotted grid fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - parchment = "Parchment", + dottedGrid = "DottedGrid", /** - * Represents a stationery texture. + * Represents a divot fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - stationery = "Stationery", + divot = "Divot", /** - * Represents a blue tissue paper texture. + * Represents a shingle fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - blueTissuePaper = "BlueTissuePaper", + shingle = "Shingle", /** - * Represents a pink tissue paper texture. + * Represents a wave fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pinkTissuePaper = "PinkTissuePaper", + wave = "Wave", /** - * Represents a purple mesh texture. + * Represents a horizontal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - purpleMesh = "PurpleMesh", + horizontal = "Horizontal", /** - * Represents a bouquet texture. + * Represents a vertical fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bouquet = "Bouquet", + vertical = "Vertical", /** - * Represents a cork texture. + * Represents a cross fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cork = "Cork", + cross = "Cross", /** - * Represents a walnut texture. + * Represents a downward diagonal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - walnut = "Walnut", + downwardDiagonal = "DownwardDiagonal", /** - * Represents an oak texture. + * Represents an upward diagonal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - oak = "Oak", + upwardDiagonal = "UpwardDiagonal", /** - * Represents a medium wood texture. + * Represents a diagonal cross fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mediumWood = "MediumWood", + diagonalCross = "DiagonalCross", } /** - * Specifies an extrusion (three-dimensional) format. + * Indicates the effects camera type used by the specified object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum PresetThreeDimensionalFormat { + enum PresetCamera { /** - * Represents a mixed three-dimensional format. + * Represents a mixed camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ mixed = "Mixed", /** - * Represents three-dimensional format 1. + * Represents a legacy oblique top-left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format1 = "Format1", + legacyObliqueTopLeft = "LegacyObliqueTopLeft", /** - * Represents three-dimensional format 2. + * Represents a legacy oblique top camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format2 = "Format2", + legacyObliqueTop = "LegacyObliqueTop", /** - * Represents three-dimensional format 3. + * Represents a legacy oblique top-right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format3 = "Format3", + legacyObliqueTopRight = "LegacyObliqueTopRight", /** - * Represents three-dimensional format 4. + * Represents a legacy oblique left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format4 = "Format4", + legacyObliqueLeft = "LegacyObliqueLeft", /** - * Represents three-dimensional format 5. + * Represents a legacy oblique front camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format5 = "Format5", + legacyObliqueFront = "LegacyObliqueFront", /** - * Represents three-dimensional format 6. + * Represents a legacy oblique right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format6 = "Format6", + legacyObliqueRight = "LegacyObliqueRight", /** - * Represents three-dimensional format 7. + * Represents a legacy oblique bottom-left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format7 = "Format7", + legacyObliqueBottomLeft = "LegacyObliqueBottomLeft", /** - * Represents three-dimensional format 8. + * Represents a legacy oblique bottom camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format8 = "Format8", + legacyObliqueBottom = "LegacyObliqueBottom", /** - * Represents three-dimensional format 9. + * Represents a legacy oblique bottom-right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format9 = "Format9", + legacyObliqueBottomRight = "LegacyObliqueBottomRight", /** - * Represents three-dimensional format 10. + * Represents a legacy perspective top-left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format10 = "Format10", + legacyPerspectiveTopLeft = "LegacyPerspectiveTopLeft", /** - * Represents three-dimensional format 11. + * Represents a legacy perspective top camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format11 = "Format11", + legacyPerspectiveTop = "LegacyPerspectiveTop", /** - * Represents three-dimensional format 12. + * Represents a legacy perspective top-right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format12 = "Format12", + legacyPerspectiveTopRight = "LegacyPerspectiveTopRight", /** - * Represents three-dimensional format 13. + * Represents a legacy perspective left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format13 = "Format13", + legacyPerspectiveLeft = "LegacyPerspectiveLeft", /** - * Represents three-dimensional format 14. + * Represents a legacy perspective front camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format14 = "Format14", + legacyPerspectiveFront = "LegacyPerspectiveFront", /** - * Represents three-dimensional format 15. + * Represents a legacy perspective right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format15 = "Format15", + legacyPerspectiveRight = "LegacyPerspectiveRight", /** - * Represents three-dimensional format 16. + * Represents a legacy perspective bottom-left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format16 = "Format16", + legacyPerspectiveBottomLeft = "LegacyPerspectiveBottomLeft", /** - * Represents three-dimensional format 17. + * Represents a legacy perspective bottom camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format17 = "Format17", + legacyPerspectiveBottom = "LegacyPerspectiveBottom", /** - * Represents three-dimensional format 18. + * Represents a legacy perspective bottom-right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format18 = "Format18", + legacyPerspectiveBottomRight = "LegacyPerspectiveBottomRight", /** - * Represents three-dimensional format 19. + * Represents an orthographic front camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format19 = "Format19", + orthographicFront = "OrthographicFront", /** - * Represents three-dimensional format 20. + * Represents an isometric top-up camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format20 = "Format20", - } - /** - * Specifies the type of the {@link Word.ReflectionFormat} object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ReflectionType { - /** - * Represents a mixed reflection type. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - mixed = "Mixed", - /** - * Represents no reflection. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - none = "None", + isometricTopUp = "IsometricTopUp", /** - * Represents reflection type 1. + * Represents an isometric top-down camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type1 = "Type1", + isometricTopDown = "IsometricTopDown", /** - * Represents reflection type 2. + * Represents an isometric bottom-up camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type2 = "Type2", + isometricBottomUp = "IsometricBottomUp", /** - * Represents reflection type 3. + * Represents an isometric bottom-down camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type3 = "Type3", + isometricBottomDown = "IsometricBottomDown", /** - * Represents reflection type 4. + * Represents an isometric left-up camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type4 = "Type4", + isometricLeftUp = "IsometricLeftUp", /** - * Represents reflection type 5. + * Represents an isometric left-down camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type5 = "Type5", + isometricLeftDown = "IsometricLeftDown", /** - * Represents reflection type 6. + * Represents an isometric right-up camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type6 = "Type6", + isometricRightUp = "IsometricRightUp", /** - * Represents reflection type 7. + * Represents an isometric right-down camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type7 = "Type7", + isometricRightDown = "IsometricRightDown", /** - * Represents reflection type 8. + * Represents an isometric off-axis 1 left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type8 = "Type8", + isometricOffAxis1Left = "IsometricOffAxis1Left", /** - * Represents reflection type 9. + * Represents an isometric off-axis 1 right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type9 = "Type9", - } - /** - * Specifies the type of shadowing effect. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ShadowStyle { + isometricOffAxis1Right = "IsometricOffAxis1Right", /** - * Represents a mixed shadow style. + * Represents an isometric off-axis 1 top camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + isometricOffAxis1Top = "IsometricOffAxis1Top", /** - * Represents an outer shadow style. + * Represents an isometric off-axis 2 left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - outerShadow = "OuterShadow", + isometricOffAxis2Left = "IsometricOffAxis2Left", /** - * Represents an inner shadow style. + * Represents an isometric off-axis 2 right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - innerShadow = "InnerShadow", - } - /** - * Specifies the type of shadow displayed with a shape. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ShadowType { + isometricOffAxis2Right = "IsometricOffAxis2Right", /** - * Represents a mixed shadow type. + * Represents an isometric off-axis 2 top camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + isometricOffAxis2Top = "IsometricOffAxis2Top", /** - * Represents shadow type 1. + * Represents an isometric off-axis 3 left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type1 = "Type1", + isometricOffAxis3Left = "IsometricOffAxis3Left", /** - * Represents shadow type 2. + * Represents an isometric off-axis 3 right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type2 = "Type2", + isometricOffAxis3Right = "IsometricOffAxis3Right", /** - * Represents shadow type 3. + * Represents an isometric off-axis 3 bottom camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type3 = "Type3", + isometricOffAxis3Bottom = "IsometricOffAxis3Bottom", /** - * Represents shadow type 4. + * Represents an isometric off-axis 4 left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type4 = "Type4", + isometricOffAxis4Left = "IsometricOffAxis4Left", /** - * Represents shadow type 5. + * Represents an isometric off-axis 4 right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type5 = "Type5", + isometricOffAxis4Right = "IsometricOffAxis4Right", /** - * Represents shadow type 6. + * Represents an isometric off-axis 4 bottom camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type6 = "Type6", + isometricOffAxis4Bottom = "IsometricOffAxis4Bottom", /** - * Represents shadow type 7. + * Represents an oblique top-left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type7 = "Type7", + obliqueTopLeft = "ObliqueTopLeft", /** - * Represents shadow type 8. + * Represents an oblique top camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type8 = "Type8", + obliqueTop = "ObliqueTop", /** - * Represents shadow type 9. + * Represents an oblique top-right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type9 = "Type9", + obliqueTopRight = "ObliqueTopRight", /** - * Represents shadow type 10. + * Represents an oblique left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type10 = "Type10", + obliqueLeft = "ObliqueLeft", /** - * Represents shadow type 11. + * Represents an oblique right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type11 = "Type11", + obliqueRight = "ObliqueRight", /** - * Represents shadow type 12. + * Represents an oblique bottom-left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type12 = "Type12", + obliqueBottomLeft = "ObliqueBottomLeft", /** - * Represents shadow type 13. + * Represents an oblique bottom camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type13 = "Type13", + obliqueBottom = "ObliqueBottom", /** - * Represents shadow type 14. + * Represents an oblique bottom-right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type14 = "Type14", + obliqueBottomRight = "ObliqueBottomRight", /** - * Represents shadow type 15. + * Represents a perspective front camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type15 = "Type15", + perspectiveFront = "PerspectiveFront", /** - * Represents shadow type 16. + * Represents a perspective left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type16 = "Type16", + perspectiveLeft = "PerspectiveLeft", /** - * Represents shadow type 17. + * Represents a perspective right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type17 = "Type17", + perspectiveRight = "PerspectiveRight", /** - * Represents shadow type 18. + * Represents a perspective above camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type18 = "Type18", + perspectiveAbove = "PerspectiveAbove", /** - * Represents shadow type 19. + * Represents a perspective below camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type19 = "Type19", + perspectiveBelow = "PerspectiveBelow", /** - * Represents shadow type 20. + * Represents a perspective above-left facing camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type20 = "Type20", + perspectiveAboveLeftFacing = "PerspectiveAboveLeftFacing", /** - * Represents shadow type 21. + * Represents a perspective above-right facing camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type21 = "Type21", + perspectiveAboveRightFacing = "PerspectiveAboveRightFacing", /** - * Represents shadow type 22. + * Represents a perspective contrasting-left facing camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type22 = "Type22", + perspectiveContrastingLeftFacing = "PerspectiveContrastingLeftFacing", /** - * Represents shadow type 23. + * Represents a perspective contrasting-right facing camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type23 = "Type23", + perspectiveContrastingRightFacing = "PerspectiveContrastingRightFacing", /** - * Represents shadow type 24. + * Represents a perspective heroic-left facing camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type24 = "Type24", + perspectiveHeroicLeftFacing = "PerspectiveHeroicLeftFacing", /** - * Represents shadow type 25. + * Represents a perspective heroic-right facing camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type25 = "Type25", + perspectiveHeroicRightFacing = "PerspectiveHeroicRightFacing", /** - * Represents shadow type 26. + * Represents a perspective heroic-extreme left facing camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type26 = "Type26", + perspectiveHeroicExtremeLeftFacing = "PerspectiveHeroicExtremeLeftFacing", /** - * Represents shadow type 27. + * Represents a perspective heroic-extreme right facing camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type27 = "Type27", + perspectiveHeroicExtremeRightFacing = "PerspectiveHeroicExtremeRightFacing", /** - * Represents shadow type 28. + * Represents a relaxed perspective camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type28 = "Type28", + perspectiveRelaxed = "PerspectiveRelaxed", /** - * Represents shadow type 29. + * Represents a moderately relaxed perspective camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type29 = "Type29", + perspectiveRelaxedModerately = "PerspectiveRelaxedModerately", + } + /** + * Specifies the direction that the extrusion's sweep path takes away from the extruded shape (the front face of the extrusion). + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PresetExtrusionDirection { /** - * Represents shadow type 30. + * Represents a mixed extrusion direction. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type30 = "Type30", + mixed = "Mixed", /** - * Represents shadow type 31. + * Represents an extrusion direction to the bottom-right. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type31 = "Type31", + bottomRight = "BottomRight", /** - * Represents shadow type 32. + * Represents an extrusion direction to the bottom. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type32 = "Type32", + bottom = "Bottom", /** - * Represents shadow type 33. + * Represents an extrusion direction to the bottom-left. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type33 = "Type33", + bottomLeft = "BottomLeft", /** - * Represents shadow type 34. + * Represents an extrusion direction to the right. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type34 = "Type34", + right = "Right", /** - * Represents shadow type 35. + * Represents no extrusion direction. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type35 = "Type35", + none = "None", /** - * Represents shadow type 36. + * Represents an extrusion direction to the left. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type36 = "Type36", + left = "Left", /** - * Represents shadow type 37. + * Represents an extrusion direction to the top-right. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type37 = "Type37", + topRight = "TopRight", /** - * Represents shadow type 38. + * Represents an extrusion direction to the top. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type38 = "Type38", + top = "Top", /** - * Represents shadow type 39. + * Represents an extrusion direction to the top-left. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type39 = "Type39", + topLeft = "TopLeft", + } + /** + * Specifies which predefined gradient to use to fill a shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PresetGradientType { /** - * Represents shadow type 40. + * Mixed gradient type. Used when multiple shapes with different preset gradients are selected. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type40 = "Type40", + mixed = "Mixed", /** - * Represents shadow type 41. + * A warm gradient resembling an early sunset. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type41 = "Type41", + earlySunset = "EarlySunset", /** - * Represents shadow type 42. + * A deeper, richer gradient resembling a late sunset. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type42 = "Type42", + lateSunset = "LateSunset", /** - * Represents shadow type 43. + * A dark gradient evoking the colors of nightfall. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type43 = "Type43", - } - /** - * Specifies the stylistic set to apply to the font. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum StylisticSet { + nightfall = "Nightfall", /** - * Default stylistic set. + * A light gradient representing the colors of daybreak. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - default = "Default", + daybreak = "Daybreak", /** - * Stylistic set 01. + * A gradient that mimics the colors of the horizon. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set01 = "Set01", + horizon = "Horizon", /** - * Stylistic set 02. + * A warm, sandy gradient inspired by desert tones. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set02 = "Set02", + desert = "Desert", /** - * Stylistic set 03. + * A cool gradient reflecting ocean hues. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set03 = "Set03", + ocean = "Ocean", /** - * Stylistic set 04. + * A soft, tranquil gradient resembling calm water. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set04 = "Set04", + calmWater = "CalmWater", /** - * Stylistic set 05. + * A vivid gradient with fiery tones. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set05 = "Set05", + fire = "Fire", /** - * Stylistic set 06. + * A muted gradient with fog-like softness. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set06 = "Set06", + fog = "Fog", /** - * Stylistic set 07. + * A natural green gradient inspired by moss. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set07 = "Set07", + moss = "Moss", /** - * Stylistic set 08. + * A vibrant gradient with peacock feather colors. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set08 = "Set08", + peacock = "Peacock", /** - * Stylistic set 09. + * A light, golden gradient resembling wheat. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set09 = "Set09", + wheat = "Wheat", /** - * Stylistic set 10. + * A warm, aged paper-like gradient. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set10 = "Set10", + parchment = "Parchment", /** - * Stylistic set 11. + * A rich, reddish-brown gradient like mahogany wood. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set11 = "Set11", + mahogany = "Mahogany", /** - * Stylistic set 12. + * A colorful gradient resembling a rainbow. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set12 = "Set12", + rainbow = "Rainbow", /** - * Stylistic set 13. + * A variation of the rainbow gradient with different color emphasis. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set13 = "Set13", + rainbowII = "RainbowII", /** - * Stylistic set 14. + * A shiny, metallic gold gradient. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set14 = "Set14", + gold = "Gold", /** - * Stylistic set 15. + * A variation of the gold gradient with different tones. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set15 = "Set15", + goldII = "GoldII", /** - * Stylistic set 16. + * A metallic gradient resembling brass. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set16 = "Set16", + brass = "Brass", /** - * Stylistic set 17. + * A sleek, reflective chrome gradient. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set17 = "Set17", + chrome = "Chrome", /** - * Stylistic set 18. + * A variation of the chrome gradient with alternate highlights. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set18 = "Set18", + chromeII = "ChromeII", /** - * Stylistic set 19. + * A smooth, metallic silver gradient. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set19 = "Set19", + silver = "Silver", /** - * Stylistic set 20. + * A deep blue gradient inspired by sapphire. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set20 = "Set20", + sapphire = "Sapphire", } /** - * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. + * Specifies the location of lighting on an extruded (three-dimensional) shape relative to the shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum TextureAlignment { + enum PresetLightingDirection { /** - * Mixed texture alignment. Used when multiple shapes with different texture alignments are selected. + * Represents a mixed lighting direction. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ mixed = "Mixed", /** - * Aligns the texture to the top-left corner of the shape. + * Represents lighting from the top-left. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ topLeft = "TopLeft", /** - * Aligns the texture to the top center of the shape. + * Represents lighting from the top. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ top = "Top", /** - * Aligns the texture to the top-right corner of the shape. + * Represents lighting from the top-right. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ topRight = "TopRight", /** - * Aligns the texture to the middle left side of the shape. + * Represents lighting from the left. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ left = "Left", /** - * Aligns the texture to the center of the shape. + * Represents no lighting. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - center = "Center", + none = "None", /** - * Aligns the texture to the middle right side of the shape. + * Represents lighting from the right. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ right = "Right", /** - * Aligns the texture to the bottom-left corner of the shape. + * Represents lighting from the bottom-left. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ bottomLeft = "BottomLeft", /** - * Aligns the texture to the bottom center of the shape. + * Represents lighting from the bottom. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ bottom = "Bottom", /** - * Aligns the texture to the bottom-right corner of the shape. + * Represents lighting from the bottom-right. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta @@ -33915,10944 +35854,19152 @@ export declare namespace Word { bottomRight = "BottomRight", } /** - * Specifies the texture type for the selected fill. + * Specifies the intensity of light used on a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum TextureType { + enum PresetLightingSoftness { /** - * Mixed texture type. Used when multiple shapes with different texture types are selected. + * Represents a mixed lighting softness. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ mixed = "Mixed", /** - * A predefined texture selected from the built-in texture gallery. + * Represents dim lighting. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - preset = "Preset", + dim = "Dim", /** - * A custom texture defined by the user, typically from an image file. + * Represents normal lighting. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - userDefined = "UserDefined", + normal = "Normal", + /** + * Represents bright lighting. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bright = "Bright", } /** - * Specifies the theme colors for document themes. + * Specifies the extrusion surface material. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum ThemeColorIndex { - /** - * Not a theme color. Used when the color is not part of the theme. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - notThemeColor = "NotThemeColor", + enum PresetMaterial { /** - * The first dark color in the main theme. + * Represents a mixed material type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mainDark1 = "MainDark1", + mixed = "Mixed", /** - * The first light color in the main theme. + * Represents a matte material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mainLight1 = "MainLight1", + matte = "Matte", /** - * The second dark color in the main theme. + * Represents a plastic material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mainDark2 = "MainDark2", + plastic = "Plastic", /** - * The second light color in the main theme. + * Represents a metal material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mainLight2 = "MainLight2", + metal = "Metal", /** - * The first accent color in the theme. + * Represents a wireframe material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - accent1 = "Accent1", + wireFrame = "WireFrame", /** - * The second accent color in the theme. + * Represents a second matte material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - accent2 = "Accent2", + matte2 = "Matte2", /** - * The third accent color in the theme. + * Represents a second plastic material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - accent3 = "Accent3", + plastic2 = "Plastic2", /** - * The fourth accent color in the theme. + * Represents a second metal material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - accent4 = "Accent4", + metal2 = "Metal2", /** - * The fifth accent color in the theme. + * Represents a warm matte material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - accent5 = "Accent5", + warmMatte = "WarmMatte", /** - * The sixth accent color in the theme. + * Represents a translucent powder material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - accent6 = "Accent6", + translucentPowder = "TranslucentPowder", /** - * The color used for hyperlinks. + * Represents a powder material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hyperlink = "Hyperlink", + powder = "Powder", /** - * The color used for followed hyperlinks. + * Represents a dark edge material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hyperlinkFollowed = "HyperlinkFollowed", + darkEdge = "DarkEdge", /** - * The first background color in the theme. + * Represents a soft edge material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - background1 = "Background1", + softEdge = "SoftEdge", /** - * The first text color in the theme. + * Represents a clear material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - text1 = "Text1", + clear = "Clear", /** - * The second background color in the theme. + * Represents a flat material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - background2 = "Background2", + flat = "Flat", /** - * The second text color in the theme. + * Represents a soft metal material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - text2 = "Text2", + softMetal = "SoftMetal", } /** - * Specifies the hyperlink type. + * Specifies texture to be used to fill a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum HyperlinkType { + enum PresetTexture { /** - * Represents a hyperlink to a range in the document. + * Represents a mixed texture type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range = "Range", + mixed = "Mixed", /** - * Represents a hyperlink to a shape in the document. + * Represents a papyrus texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shape = "Shape", + papyrus = "Papyrus", /** - * Represents a hyperlink to an inline shape in the document. + * Represents a canvas texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - inlineShape = "InlineShape", - } - /** - * Represents the list of available sources attached to the document (in the current list) or the list of sources available in the application (in the master list). - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class Bibliography 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; + canvas = "Canvas", /** - * Returns a `SourceCollection` object that represents all the sources contained in the bibliography. - * + * Represents a denim texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly sources: Word.SourceCollection; + denim = "Denim", /** - * Specifies the name of the active style to use for the bibliography. - * + * Represents a woven mat texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bibliographyStyle: string; - /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. - */ - set(properties: Interfaces.BibliographyUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Bibliography): void; + wovenMat = "WovenMat", /** - * Generates a unique identification tag for a bibliography source and returns a string that represents the tag. - * + * Represents a water droplets texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - generateUniqueTag(): OfficeExtension.ClientResult; - /** - * 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?: Word.Interfaces.BibliographyLoadOptions): Word.Bibliography; - /** - * 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[]): Word.Bibliography; - /** - * 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; - }): Word.Bibliography; - /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. - */ - track(): Word.Bibliography; - /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. - */ - untrack(): Word.Bibliography; - /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Bibliography` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BibliographyData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.BibliographyData; - } - /** - * Represents a collection of {@link Word.Source} objects. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class SourceCollection 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: Word.Source[]; + waterDroplets = "WaterDroplets", /** - * Adds a new `Source` object to the collection. - * + * Represents a paper bag texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param xml - A string containing the XML data for the source. - * @returns A `Source` object that was added to the collection. */ - add(xml: string): Word.Source; + paperBag = "PaperBag", /** - * Gets a `Source` by its index in the collection. - * + * Represents a fish fossil texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param index - A number that identifies the index location of a `Source` object. */ - getItem(index: number): Word.Source; + fishFossil = "FishFossil", /** - * 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. + * Represents a sand texture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.SourceCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.SourceCollection; + sand = "Sand", /** - * 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. + * Represents a green marble texture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.SourceCollection; + greenMarble = "GreenMarble", /** - * 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. + * Represents a white marble texture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.SourceCollection; + whiteMarble = "WhiteMarble", /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + * Represents a brown marble texture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.SourceCollection; + brownMarble = "BrownMarble", /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + * Represents a granite texture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.SourceCollection; + granite = "Granite", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.SourceCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SourceCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * Represents a newsprint texture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.SourceCollectionData; - } - /** - * Represents an individual source, such as a book, journal article, or interview. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class Source 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; + newsprint = "Newsprint", /** - * Gets if the `Source` object has been cited in the document. - * + * Represents a recycled paper texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly isCited: boolean; + recycledPaper = "RecycledPaper", /** - * Gets the tag of the source. - * + * Represents a parchment texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly tag: string; + parchment = "Parchment", /** - * Gets the XML representation of the source. - * + * Represents a stationery texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly xml: string; + stationery = "Stationery", /** - * Deletes the `Source` object. - * + * Represents a blue tissue paper texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - delete(): void; + blueTissuePaper = "BlueTissuePaper", /** - * Returns the value of a field in the bibliography `Source` object. - * + * Represents a pink tissue paper texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param name - The name of the field to retrieve. */ - getFieldByName(name: string): OfficeExtension.ClientResult; + pinkTissuePaper = "PinkTissuePaper", /** - * 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. + * Represents a purple mesh texture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.SourceLoadOptions): Word.Source; + purpleMesh = "PurpleMesh", /** - * 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. + * Represents a bouquet texture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.Source; + bouquet = "Bouquet", /** - * 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. + * Represents a cork texture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.Source; + cork = "Cork", /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + * Represents a walnut texture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.Source; + walnut = "Walnut", /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + * Represents an oak texture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.Source; + oak = "Oak", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Source` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SourceData`) that contains shallow copies of any loaded child properties from the original object. + * Represents a medium wood texture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.SourceData; + mediumWood = "MediumWood", } /** - * Represents the page setup settings for a Word document or section. + * Specifies an extrusion (three-dimensional) format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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; + enum PresetThreeDimensionalFormat { /** - * Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object. - * + * Represents a mixed three-dimensional format. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lineNumbering: Word.LineNumbering; + mixed = "Mixed", /** - * Gets a `TextColumnCollection` object that represents the set of text columns for the `PageSetup` object. - * + * Represents three-dimensional format 1. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly textColumns: Word.TextColumnCollection; + format1 = "Format1", /** - * Specifies whether Microsoft Word prints the document as a booklet. - * + * Represents three-dimensional format 2. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bookFoldPrinting: boolean; + format2 = "Format2", /** - * Specifies the number of pages for each booklet. - * + * Represents three-dimensional format 3. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bookFoldPrintingSheets: number; + format3 = "Format3", /** - * Specifies if Microsoft Word reverses the printing order for book fold printing of bidirectional or Asian language documents. - * + * Represents three-dimensional format 4. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bookFoldReversePrinting: boolean; + format4 = "Format4", /** - * Specifies the distance (in points) between the bottom edge of the page and the bottom boundary of the body text. - * + * Represents three-dimensional format 5. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottomMargin: number; + format5 = "Format5", /** - * Specifies the number of characters per line in the document grid. - * + * Represents three-dimensional format 6. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - charsLine: number; + format6 = "Format6", /** - * Specifies whether the first page has a different header and footer. - * + * Represents three-dimensional format 7. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - differentFirstPageHeaderFooter: boolean; + format7 = "Format7", /** - * Specifies the distance between the footer and the bottom of the page in points. - * + * Represents three-dimensional format 8. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footerDistance: number; + format8 = "Format8", /** - * Specifies the amount (in points) of extra margin space added to each page in a document or section for binding. - * + * Represents three-dimensional format 9. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gutter: number; + format9 = "Format9", /** - * Specifies on which side the gutter appears in a document. - * + * Represents three-dimensional format 10. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gutterPosition: Word.GutterPosition | "Left" | "Right" | "Top"; + format10 = "Format10", /** - * Specifies whether Microsoft Word uses gutters for the current document based on a right-to-left language or a left-to-right language. - * + * Represents three-dimensional format 11. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gutterStyle: Word.GutterStyle | "Bidirectional" | "Latin"; + format11 = "Format11", /** - * Specifies the distance between the header and the top of the page in points. - * + * Represents three-dimensional format 12. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - headerDistance: number; + format12 = "Format12", /** - * Specifies the layout mode for the current document. - * + * Represents three-dimensional format 13. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - layoutMode: Word.LayoutMode | "Default" | "Grid" | "LineGrid" | "Genko"; + format13 = "Format13", /** - * Specifies the distance (in points) between the left edge of the page and the left boundary of the body text. - * + * Represents three-dimensional format 14. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - leftMargin: number; + format14 = "Format14", /** - * Specifies the number of lines per page in the document grid. - * + * Represents three-dimensional format 15. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - linesPage: number; + format15 = "Format15", /** - * Specifies if the inside and outside margins of facing pages are the same width. - * + * Represents three-dimensional format 16. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mirrorMargins: boolean; + format16 = "Format16", /** - * Specifies whether odd and even pages have different headers and footers. - * + * Represents three-dimensional format 17. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - oddAndEvenPagesHeaderFooter: boolean; + format17 = "Format17", /** - * Specifies the orientation of the page. - * + * Represents three-dimensional format 18. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - orientation: Word.PageOrientation | "Portrait" | "Landscape"; + format18 = "Format18", /** - * Specifies the page height in points. - * + * Represents three-dimensional format 19. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageHeight: number; + format19 = "Format19", /** - * Specifies the page width in points. - * + * Represents three-dimensional format 20. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageWidth: number; + format20 = "Format20", + } + /** + * Specifies the type of the {@link Word.ReflectionFormat} object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ReflectionType { /** - * Specifies the paper size of the page. - * + * Represents a mixed reflection type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - paperSize: Word.PaperSize | "Size10x14" | "Size11x17" | "Letter" | "LetterSmall" | "Legal" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "CSheet" | "DSheet" | "ESheet" | "FanfoldLegalGerman" | "FanfoldStdGerman" | "FanfoldUS" | "Folio" | "Ledger" | "Note" | "Quarto" | "Statement" | "Tabloid" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC5" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeDL" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "Custom"; + mixed = "Mixed", /** - * Specifies the distance (in points) between the right edge of the page and the right boundary of the body text. - * + * Represents no reflection. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rightMargin: number; + none = "None", /** - * Specifies the reading order and alignment for the specified sections. - * + * Represents reflection type 1. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sectionDirection: Word.SectionDirection | "RightToLeft" | "LeftToRight"; + type1 = "Type1", /** - * Specifies the type of section break for the specified object. - * + * Represents reflection type 2. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sectionStart: Word.SectionStart | "Continuous" | "NewColumn" | "NewPage" | "EvenPage" | "OddPage"; + type2 = "Type2", /** - * Specifies whether to show the grid. - * + * Represents reflection type 3. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showGrid: boolean; + type3 = "Type3", /** - * Specifies if endnotes are printed at the end of the next section that doesn't suppress endnotes. - * + * Represents reflection type 4. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - suppressEndnotes: boolean; + type4 = "Type4", /** - * Specifies the top margin of the page in points. - * + * Represents reflection type 5. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - topMargin: number; + type5 = "Type5", /** - * Specifies whether to print two pages per sheet. - * + * Represents reflection type 6. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - twoPagesOnOne: boolean; + type6 = "Type6", /** - * Specifies the vertical alignment of text on each page in a document or section. - * + * Represents reflection type 7. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - verticalAlignment: Word.PageSetupVerticalAlignment | "Top" | "Center" | "Justify" | "Bottom"; - /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. - */ - set(properties: Interfaces.PageSetupUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.PageSetup): void; + type7 = "Type7", /** - * Sets the specified page setup formatting as the default for the active document and all new documents based on the active template. - * + * Represents reflection type 8. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - setAsTemplateDefault(): void; + type8 = "Type8", /** - * Switches between portrait and landscape page orientations for a document or section. - * + * Represents reflection type 9. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - togglePortrait(): 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?: Word.Interfaces.PageSetupLoadOptions): Word.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[]): Word.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; - }): Word.PageSetup; + type9 = "Type9", + } + /** + * Specifies the type of shadowing effect. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ShadowStyle { /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + * Represents a mixed shadow style. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.PageSetup; + mixed = "Mixed", /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + * Represents an outer shadow style. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.PageSetup; + outerShadow = "OuterShadow", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.PageSetup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PageSetupData`) that contains shallow copies of any loaded child properties from the original object. + * Represents an inner shadow style. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.PageSetupData; + innerShadow = "InnerShadow", } /** - * Represents line numbers in the left margin or to the left of each newspaper-style column. + * Specifies the type of shadow displayed with a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export class LineNumbering 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 ShadowType { /** - * Specifies the numeric increment for line numbers. - * + * Represents a mixed shadow type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - countBy: number; + mixed = "Mixed", /** - * Specifies the distance (in points) between the right edge of line numbers and the left edge of the document text. - * + * Represents shadow type 1. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - distanceFromText: number; + type1 = "Type1", /** - * Specifies if line numbering is active for the specified document, section, or sections. - * + * Represents shadow type 2. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isActive: boolean; + type2 = "Type2", /** - * Specifies the way line numbering runs; that is, whether it starts over at the beginning of a new page or section, or runs continuously. - * + * Represents shadow type 3. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - restartMode: Word.NumberingRule | "RestartContinuous" | "RestartSection" | "RestartPage"; + type3 = "Type3", /** - * Specifies the starting line number. - * + * Represents shadow type 4. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - startingNumber: number; + type4 = "Type4", /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Represents shadow type 5. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.LineNumberingUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.LineNumbering): void; + type5 = "Type5", /** - * 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?: Word.Interfaces.LineNumberingLoadOptions): Word.LineNumbering; - /** - * 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[]): Word.LineNumbering; - /** - * 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; - }): Word.LineNumbering; - /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. - */ - track(): Word.LineNumbering; - /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. - */ - untrack(): Word.LineNumbering; - /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.LineNumbering` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.LineNumberingData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.LineNumberingData; - } - /** - * A collection of {@link Word.TextColumn} objects that represent all the columns of text in the document or a section of the document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class TextColumnCollection 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: Word.TextColumn[]; - /** - * Returns a `TextColumn` object that represents a new text column added to a section or document. - * + * Represents shadow type 6. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param options - Optional. Options for configuring the new text column. - * @returns A `TextColumn` object that represents a new text column added to the document. */ - add(options?: Word.TextColumnAddOptions): Word.TextColumn; + type6 = "Type6", /** - * Gets the direction in which text flows from one text column to the next. - * + * Represents shadow type 7. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - getFlowDirection(): OfficeExtension.ClientResult; + type7 = "Type7", /** - * Gets whether vertical lines appear between all the columns in the `TextColumnCollection` object. - * + * Represents shadow type 8. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - getHasLineBetween(): OfficeExtension.ClientResult; + type8 = "Type8", /** - * Gets whether text columns are evenly spaced. - * + * Represents shadow type 9. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - getIsEvenlySpaced(): OfficeExtension.ClientResult; + type9 = "Type9", /** - * Gets a `TextColumn` by its index in the collection. - * + * Represents shadow type 10. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param index - A number that identifies the index location of a `TextColumn` object. */ - getItem(index: number): Word.TextColumn; + type10 = "Type10", /** - * Arranges text into the specified number of text columns. - * + * Represents shadow type 11. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param numColumns - The number of columns the text is to be arranged into. */ - setCount(numColumns: number): void; + type11 = "Type11", /** - * Sets the direction in which text flows from one text column to the next. - * + * Represents shadow type 12. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param value - The flow direction to set. */ - setFlowDirection(value: Word.FlowDirection): void; + type12 = "Type12", /** - * Sets the direction in which text flows from one text column to the next. - * + * Represents shadow type 13. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param value - The flow direction to set. */ - setFlowDirection(value: "LeftToRight" | "RightToLeft"): void; + type13 = "Type13", /** - * Sets whether vertical lines appear between all the columns in the `TextColumnCollection` object. - * + * Represents shadow type 14. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param value - `true` to show vertical lines between columns. */ - setHasLineBetween(value: boolean): void; + type14 = "Type14", /** - * Sets whether text columns are evenly spaced. - * + * Represents shadow type 15. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param value - `true` to evenly space all the text columns in the document. - */ - setIsEvenlySpaced(value: boolean): 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?: Word.Interfaces.TextColumnCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TextColumnCollection; - /** - * 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[]): Word.TextColumnCollection; - /** - * 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): Word.TextColumnCollection; - /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. - */ - track(): Word.TextColumnCollection; - /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. - */ - untrack(): Word.TextColumnCollection; - /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TextColumnCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TextColumnCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.TextColumnCollectionData; - } - /** - * Represents options for a new text column in a document or section of a document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface TextColumnAddOptions { + type15 = "Type15", /** - * If provided, specifies whether to evenly space all the text columns in the document. The default value is `true`. - * + * Represents shadow type 16. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isEvenlySpaced?: boolean; + type16 = "Type16", /** - * If provided, specifies the spacing between the text columns in the document, in points. - The default value is -1, which means Word will automatically determine the width based on the number of columns and page size. - * + * Represents shadow type 17. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spacing?: number; + type17 = "Type17", /** - * If provided, specifies the width of the new text column in the document, in points. - The default value is -1, which means Word will automatically determine the width based on the number of columns and page size. - * + * Represents shadow type 18. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - width?: number; - } - /** - * Represents a single text column in a section. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class TextColumn 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; + type18 = "Type18", /** - * Specifies the amount of spacing (in points) after the specified paragraph or text column. - * + * Represents shadow type 19. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spaceAfter: number; + type19 = "Type19", /** - * Specifies the width, in points, of the specified text columns. - * + * Represents shadow type 20. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - width: number; - /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. - */ - set(properties: Interfaces.TextColumnUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.TextColumn): 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?: Word.Interfaces.TextColumnLoadOptions): Word.TextColumn; - /** - * 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[]): Word.TextColumn; - /** - * 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; - }): Word.TextColumn; - /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. - */ - track(): Word.TextColumn; - /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. - */ - untrack(): Word.TextColumn; - /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TextColumn` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TextColumnData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.TextColumnData; - } - /** - * Specifies the case of the text in the specified range. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum CharacterCase { + type20 = "Type20", /** - * Specifies the next case. + * Represents shadow type 21. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - next = "Next", + type21 = "Type21", /** - * Specifies lowercase. + * Represents shadow type 22. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lower = "Lower", + type22 = "Type22", /** - * Specifies uppercase. + * Represents shadow type 23. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - upper = "Upper", + type23 = "Type23", /** - * Specifies title case for each word. + * Represents shadow type 24. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - titleWord = "TitleWord", + type24 = "Type24", /** - * Specifies title case for the sentence. + * Represents shadow type 25. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - titleSentence = "TitleSentence", + type25 = "Type25", /** - * Specifies toggle case. + * Represents shadow type 26. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - toggle = "Toggle", + type26 = "Type26", /** - * Specifies half-width characters. + * Represents shadow type 27. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - halfWidth = "HalfWidth", + type27 = "Type27", /** - * Specifies full-width characters. + * Represents shadow type 28. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fullWidth = "FullWidth", + type28 = "Type28", /** - * Specifies Katakana characters. + * Represents shadow type 29. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - katakana = "Katakana", + type29 = "Type29", /** - * Specifies Hiragana characters. + * Represents shadow type 30. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hiragana = "Hiragana", - } - /** - * Specifies the character width of the text in the specified range. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum CharacterWidth { + type30 = "Type30", /** - * Specifies half-width characters. + * Represents shadow type 31. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - half = "Half", + type31 = "Type31", /** - * Specifies full-width characters. + * Represents shadow type 32. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - full = "Full", - } - /** - * Specifies the seek view options in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum SeekView { + type32 = "Type32", /** - * Main document. + * Represents shadow type 33. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mainDocument = "MainDocument", + type33 = "Type33", /** - * Primary header. + * Represents shadow type 34. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - primaryHeader = "PrimaryHeader", + type34 = "Type34", /** - * First page header. + * Represents shadow type 35. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - firstPageHeader = "FirstPageHeader", + type35 = "Type35", /** - * Even pages header. + * Represents shadow type 36. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - evenPagesHeader = "EvenPagesHeader", + type36 = "Type36", /** - * Primary footer. + * Represents shadow type 37. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - primaryFooter = "PrimaryFooter", + type37 = "Type37", /** - * First page footer. + * Represents shadow type 38. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - firstPageFooter = "FirstPageFooter", + type38 = "Type38", /** - * Even pages footer. + * Represents shadow type 39. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - evenPagesFooter = "EvenPagesFooter", + type39 = "Type39", /** - * Footnotes. + * Represents shadow type 40. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footnotes = "Footnotes", + type40 = "Type40", /** - * Endnotes. + * Represents shadow type 41. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endnotes = "Endnotes", + type41 = "Type41", /** - * Current page header. + * Represents shadow type 42. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - currentPageHeader = "CurrentPageHeader", + type42 = "Type42", /** - * Current page footer. + * Represents shadow type 43. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - currentPageFooter = "CurrentPageFooter", + type43 = "Type43", } /** - * Specifies the source documents to show. + * Specifies the stylistic set to apply to the font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum ShowSourceDocuments { + enum StylisticSet { /** - * Specifies that no source documents are shown. + * Default stylistic set. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + default = "Default", /** - * Specifies that the original source document is shown. + * Stylistic set 01. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - original = "Original", + set01 = "Set01", /** - * Specifies that the revised source document is shown. + * Stylistic set 02. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - revised = "Revised", + set02 = "Set02", /** - * Specifies that both the original and revised source documents are shown. + * Stylistic set 03. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - both = "Both", - } - /** - * Specifies the special pane options in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum SpecialPane { + set03 = "Set03", /** - * None. + * Stylistic set 04. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + set04 = "Set04", /** - * Primary header. + * Stylistic set 05. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - primaryHeader = "PrimaryHeader", + set05 = "Set05", /** - * First page header. + * Stylistic set 06. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - firstPageHeader = "FirstPageHeader", + set06 = "Set06", /** - * Even pages header. + * Stylistic set 07. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - evenPagesHeader = "EvenPagesHeader", + set07 = "Set07", /** - * Primary footer. + * Stylistic set 08. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - primaryFooter = "PrimaryFooter", + set08 = "Set08", /** - * First page footer. + * Stylistic set 09. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - firstPageFooter = "FirstPageFooter", + set09 = "Set09", /** - * Even pages footer. + * Stylistic set 10. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - evenPagesFooter = "EvenPagesFooter", + set10 = "Set10", /** - * Footnotes. + * Stylistic set 11. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footnotes = "Footnotes", + set11 = "Set11", /** - * Endnotes. + * Stylistic set 12. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endnotes = "Endnotes", + set12 = "Set12", /** - * Footnote continuation notice. + * Stylistic set 13. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footnoteContinuationNotice = "FootnoteContinuationNotice", + set13 = "Set13", /** - * Footnote continuation separator. + * Stylistic set 14. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footnoteContinuationSeparator = "FootnoteContinuationSeparator", + set14 = "Set14", /** - * Footnote separator. + * Stylistic set 15. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footnoteSeparator = "FootnoteSeparator", + set15 = "Set15", /** - * Endnote continuation notice. + * Stylistic set 16. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endnoteContinuationNotice = "EndnoteContinuationNotice", + set16 = "Set16", /** - * Endnote continuation separator. + * Stylistic set 17. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endnoteContinuationSeparator = "EndnoteContinuationSeparator", + set17 = "Set17", /** - * Endnote separator. + * Stylistic set 18. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endnoteSeparator = "EndnoteSeparator", + set18 = "Set18", /** - * Comments. + * Stylistic set 19. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - comments = "Comments", + set19 = "Set19", /** - * Current page header. + * Stylistic set 20. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - currentPageHeader = "CurrentPageHeader", + set20 = "Set20", + } + /** + * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum TextureAlignment { /** - * Current page footer. + * Mixed texture alignment. Used when multiple shapes with different texture alignments are selected. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - currentPageFooter = "CurrentPageFooter", + mixed = "Mixed", /** - * Revisions. + * Aligns the texture to the top-left corner of the shape. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - revisions = "Revisions", + topLeft = "TopLeft", /** - * Revisions horizontal. + * Aligns the texture to the top center of the shape. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - revisionsHoriz = "RevisionsHoriz", + top = "Top", /** - * Revisions vertical. + * Aligns the texture to the top-right corner of the shape. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - revisionsVert = "RevisionsVert", - } - /** - * Specifies the save options. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum SaveConfiguration { + topRight = "TopRight", /** - * Specifies not to save changes. + * Aligns the texture to the middle left side of the shape. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - doNotSaveChanges = "DoNotSaveChanges", + left = "Left", /** - * Specifies to save changes. + * Aligns the texture to the center of the shape. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - saveChanges = "SaveChanges", + center = "Center", /** - * Specifies to prompt to save changes. + * Aligns the texture to the middle right side of the shape. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - promptToSaveChanges = "PromptToSaveChanges", - } - /** - * Specifies the page color options in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum PageColor { + right = "Right", /** - * None. + * Aligns the texture to the bottom-left corner of the shape. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + bottomLeft = "BottomLeft", /** - * Sepia. + * Aligns the texture to the bottom center of the shape. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sepia = "Sepia", + bottom = "Bottom", /** - * Inverse. + * Aligns the texture to the bottom-right corner of the shape. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - inverse = "Inverse", + bottomRight = "BottomRight", } /** - * Specifies the page movement type in a Word document. + * Specifies the texture type for the selected fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum PageMovementType { + enum TextureType { /** - * Vertical. + * Mixed texture type. Used when multiple shapes with different texture types are selected. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - vertical = "Vertical", + mixed = "Mixed", /** - * Side to side. + * A predefined texture selected from the built-in texture gallery. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sideToSide = "SideToSide", + preset = "Preset", + /** + * A custom texture defined by the user, typically from an image file. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + userDefined = "UserDefined", } /** - * Specifies the margin options in reading layout view in a Word document. + * Specifies the theme colors for document themes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum ReadingLayoutMargin { + enum ThemeColorIndex { /** - * Microsoft Word determines automatically whether to show or hide the margins based on the available space. + * Not a theme color. Used when the color is not part of the theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - automatic = "Automatic", + notThemeColor = "NotThemeColor", /** - * Hides margins. + * The first dark color in the main theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - suppress = "Suppress", + mainDark1 = "MainDark1", /** - * Shows margins. + * The first light color in the main theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - full = "Full", - } - /** - * Specifies the margin for revision balloons in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum RevisionsBalloonMargin { + mainLight1 = "MainLight1", /** - * Left margin. + * The second dark color in the main theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - left = "Left", + mainDark2 = "MainDark2", /** - * Right margin. + * The second light color in the main theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - right = "Right", - } - /** - * Specifies the width type for revision balloons in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum RevisionsBalloonWidthType { + mainLight2 = "MainLight2", /** - * Balloon width as a percentage. + * The first accent color in the theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent = "Percent", + accent1 = "Accent1", /** - * Balloon width in points. + * The second accent color in the theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - points = "Points", - } - /** - * Specifies the extent of markup visible in the document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum RevisionsMarkup { + accent2 = "Accent2", /** - * No markup. + * The third accent color in the theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + accent3 = "Accent3", /** - * Simple markup. + * The fourth accent color in the theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - simple = "Simple", + accent4 = "Accent4", /** - * All markup. + * The fifth accent color in the theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - all = "All", - } - /** - * Specifies the display mode for tracked changes in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum RevisionsMode { + accent5 = "Accent5", /** - * Balloon. + * The sixth accent color in the theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - balloon = "Balloon", + accent6 = "Accent6", /** - * Inline. + * The color used for hyperlinks. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - inline = "Inline", + hyperlink = "Hyperlink", /** - * Mixed. + * The color used for followed hyperlinks. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", - } - /** - * Specifies whether Word displays the original version of a document or a version with revisions and formatting changes applied. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum RevisionsView { + hyperlinkFollowed = "HyperlinkFollowed", /** - * Final view. + * The first background color in the theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - final = "Final", + background1 = "Background1", /** - * Original view. + * The first text color in the theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - original = "Original", + text1 = "Text1", + /** + * The second background color in the theme. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + background2 = "Background2", + /** + * The second text color in the theme. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + text2 = "Text2", } /** - * Specifies the revision type. + * Specifies the hyperlink type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum RevisionType { + enum HyperlinkType { /** - * No revision. + * Represents a hyperlink to a range in the document. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + range = "Range", /** - * Insert revision. + * Represents a hyperlink to a shape in the document. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - insert = "Insert", + shape = "Shape", /** - * Delete revision. + * Represents a hyperlink to an inline shape in the document. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - delete = "Delete", + inlineShape = "InlineShape", + } + /** + * Represents the list of available sources attached to the document (in the current list) or the list of sources available in the application (in the master list). + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class Bibliography 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; /** - * Property revision. + * Returns a `SourceCollection` object that represents all the sources contained in the bibliography. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - property = "Property", + readonly sources: Word.SourceCollection; /** - * Paragraph number revision. + * Specifies the name of the active style to use for the bibliography. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - paragraphNumber = "ParagraphNumber", + bibliographyStyle: string; /** - * Display field revision. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - displayField = "DisplayField", + set(properties: Interfaces.BibliographyUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Bibliography): void; /** - * Reconcile revision. + * Generates a unique identification tag for a bibliography source and returns a string that represents the tag. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - reconcile = "Reconcile", + generateUniqueTag(): OfficeExtension.ClientResult; /** - * Conflict revision. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - conflict = "Conflict", + load(options?: Word.Interfaces.BibliographyLoadOptions): Word.Bibliography; /** - * Style revision. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - style = "Style", + load(propertyNames?: string | string[]): Word.Bibliography; /** - * Replace revision. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - replace = "Replace", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Bibliography; /** - * Paragraph property revision. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - paragraphProperty = "ParagraphProperty", + track(): Word.Bibliography; /** - * Table property revision. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - tableProperty = "TableProperty", + untrack(): Word.Bibliography; /** - * Section property revision. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Bibliography` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BibliographyData`) that contains shallow copies of any loaded child properties from the original object. */ - sectionProperty = "SectionProperty", + toJSON(): Word.Interfaces.BibliographyData; + } + /** + * Represents a collection of {@link Word.Source} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class SourceCollection 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: Word.Source[]; /** - * Style definition revision. + * Adds a new `Source` object to the collection. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param xml - A string containing the XML data for the source. + * @returns A `Source` object that was added to the collection. */ - styleDefinition = "StyleDefinition", + add(xml: string): Word.Source; /** - * Moved from revision. + * Gets a `Source` by its index in the collection. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param index - A number that identifies the index location of a `Source` object. */ - movedFrom = "MovedFrom", + getItem(index: number): Word.Source; /** - * Moved to revision. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - movedTo = "MovedTo", + load(options?: Word.Interfaces.SourceCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.SourceCollection; /** - * Cell insertion revision. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - cellInsertion = "CellInsertion", + load(propertyNames?: string | string[]): Word.SourceCollection; /** - * Cell deletion revision. + * 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): Word.SourceCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.SourceCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.SourceCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.SourceCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SourceCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.SourceCollectionData; + } + /** + * Represents an individual source, such as a book, journal article, or interview. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class Source 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 if the `Source` object has been cited in the document. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cellDeletion = "CellDeletion", + readonly isCited: boolean; /** - * Cell merge revision. + * Gets the tag of the source. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cellMerge = "CellMerge", + readonly tag: string; /** - * Cell split revision. + * Gets the XML representation of the source. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cellSplit = "CellSplit", + readonly xml: string; /** - * Conflict insert revision. + * Deletes the `Source` object. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - conflictInsert = "ConflictInsert", + delete(): void; /** - * Conflict delete revision. + * Returns the value of a field in the bibliography `Source` object. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param name - The name of the field to retrieve. */ - conflictDelete = "ConflictDelete", + getFieldByName(name: string): OfficeExtension.ClientResult; + /** + * 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?: Word.Interfaces.SourceLoadOptions): Word.Source; + /** + * 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[]): Word.Source; + /** + * 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; + }): Word.Source; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.Source; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.Source; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Source` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SourceData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.SourceData; } /** - * Specifies the column width options in a Word document. + * Represents the page setup settings for a Word document or section. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum ColumnWidth { + 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; /** - * Narrow column width. + * Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - narrow = "Narrow", + lineNumbering: Word.LineNumbering; /** - * Default column width. + * Gets a `TextColumnCollection` object that represents the set of text columns for the `PageSetup` object. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - default = "Default", + readonly textColumns: Word.TextColumnCollection; /** - * Wide column width. + * Specifies whether Microsoft Word prints the document as a booklet. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - wide = "Wide", - } - /** - * Specifies the field shading options in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum FieldShading { + bookFoldPrinting: boolean; /** - * Never shade fields. + * Specifies the number of pages for each booklet. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - never = "Never", + bookFoldPrintingSheets: number; /** - * Always shade fields. + * Specifies if Microsoft Word reverses the printing order for book fold printing of bidirectional or Asian language documents. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - always = "Always", + bookFoldReversePrinting: boolean; /** - * Shade fields when selected. + * Specifies the distance (in points) between the bottom edge of the page and the bottom boundary of the body text. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - whenSelected = "WhenSelected", - } - /** - * Specifies the format for horizontal text set within vertical text. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum HorizontalInVerticalType { + bottomMargin: number; /** - * No formatting is applied to the horizontal text. + * Specifies the number of characters per line in the document grid. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + charsLine: number; /** - * The horizontal text is sized to fit in the line of vertical text. + * Specifies whether the first page has a different header and footer. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fitInLine = "FitInLine", + differentFirstPageHeaderFooter: boolean; /** - * The line of vertical text is sized to accommodate the horizontal text. + * Specifies the distance between the footer and the bottom of the page in points. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - resizeLine = "ResizeLine", - } - /** - * Specifies the IME (Input Method Editor) mode. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ImeMode { + footerDistance: number; /** - * Specifies no control over the IME mode. + * Specifies the amount (in points) of extra margin space added to each page in a document or section for binding. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - noControl = "NoControl", + gutter: number; /** - * Specifies the IME mode is on. + * Specifies on which side the gutter appears in a document. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - on = "On", + gutterPosition: Word.GutterPosition | "Left" | "Right" | "Top"; /** - * Specifies the IME mode is off. + * Specifies whether Microsoft Word uses gutters for the current document based on a right-to-left language or a left-to-right language. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - off = "Off", + gutterStyle: Word.GutterStyle | "Bidirectional" | "Latin"; /** - * Specifies the Hiragana IME mode. + * Specifies the distance between the header and the top of the page in points. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hiragana = "Hiragana", + headerDistance: number; /** - * Specifies the Katakana (double-byte) IME mode. + * Specifies the layout mode for the current document. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - katakana = "Katakana", + layoutMode: Word.LayoutMode | "Default" | "Grid" | "LineGrid" | "Genko"; /** - * Specifies the Katakana (half-width) IME mode. + * Specifies the distance (in points) between the left edge of the page and the left boundary of the body text. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - katakanaHalf = "KatakanaHalf", + leftMargin: number; /** - * Specifies the full-width alphanumeric IME mode. + * Specifies the number of lines per page in the document grid. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - alphaFull = "AlphaFull", + linesPage: number; /** - * Specifies the half-width alphanumeric IME mode. + * Specifies if the inside and outside margins of facing pages are the same width. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - alpha = "Alpha", + mirrorMargins: boolean; /** - * Specifies the full-width Hangul IME mode. + * Specifies whether odd and even pages have different headers and footers. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hangulFull = "HangulFull", + oddAndEvenPagesHeaderFooter: boolean; /** - * Specifies the half-width Hangul IME mode. + * Specifies the orientation of the page. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hangul = "Hangul", - } - /** - * Specifies the Kana type. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum Kana { + orientation: Word.PageOrientation | "Portrait" | "Landscape"; /** - * Katakana Kana type. + * Specifies the page height in points. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - katakana = "Katakana", + pageHeight: number; /** - * Hiragana Kana type. + * Specifies the page width in points. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hiragana = "Hiragana", - } - /** - * Specifies the two lines in one type. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum TwoLinesInOneType { + pageWidth: number; /** - * No two lines in one. + * Specifies the paper size of the page. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + paperSize: Word.PaperSize | "Size10x14" | "Size11x17" | "Letter" | "LetterSmall" | "Legal" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "CSheet" | "DSheet" | "ESheet" | "FanfoldLegalGerman" | "FanfoldStdGerman" | "FanfoldUS" | "Folio" | "Ledger" | "Note" | "Quarto" | "Statement" | "Tabloid" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC5" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeDL" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "Custom"; /** - * Two lines in one without brackets. + * Specifies the distance (in points) between the right edge of the page and the right boundary of the body text. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - noBrackets = "NoBrackets", + rightMargin: number; /** - * Two lines in one with parentheses. + * Specifies the reading order and alignment for the specified sections. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - parentheses = "Parentheses", + sectionDirection: Word.SectionDirection | "RightToLeft" | "LeftToRight"; /** - * Two lines in one with square brackets. + * Specifies the type of section break for the specified object. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - squareBrackets = "SquareBrackets", + sectionStart: Word.SectionStart | "Continuous" | "NewColumn" | "NewPage" | "EvenPage" | "OddPage"; /** - * Two lines in one with angle brackets. + * Specifies whether to show the grid. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - angleBrackets = "AngleBrackets", + showGrid: boolean; /** - * Two lines in one with curly brackets. + * Specifies if endnotes are printed at the end of the next section that doesn't suppress endnotes. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - curlyBrackets = "CurlyBrackets", - } - /** - * Specifies the underline type. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum Underline { + suppressEndnotes: boolean; /** - * No underline. + * Specifies the top margin of the page in points. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + topMargin: number; /** - * Single underline. + * Specifies whether to print two pages per sheet. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - single = "Single", + twoPagesOnOne: boolean; /** - * Underline words only. + * Specifies the vertical alignment of text on each page in a document or section. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - words = "Words", + verticalAlignment: Word.PageSetupVerticalAlignment | "Top" | "Center" | "Justify" | "Bottom"; /** - * Double underline. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - double = "Double", + set(properties: Interfaces.PageSetupUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.PageSetup): void; /** - * Dotted underline. + * Sets the specified page setup formatting as the default for the active document and all new documents based on the active template. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dotted = "Dotted", + setAsTemplateDefault(): void; /** - * Thick underline. + * Switches between portrait and landscape page orientations for a document or section. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thick = "Thick", + togglePortrait(): void; /** - * Dash underline. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - dash = "Dash", + load(options?: Word.Interfaces.PageSetupLoadOptions): Word.PageSetup; /** - * Dot dash underline. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - dotDash = "DotDash", + load(propertyNames?: string | string[]): Word.PageSetup; /** - * Dot dot dash underline. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - dotDotDash = "DotDotDash", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.PageSetup; /** - * Wavy underline. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - wavy = "Wavy", + track(): Word.PageSetup; /** - * Heavy wavy underline. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - wavyHeavy = "WavyHeavy", + untrack(): Word.PageSetup; /** - * Heavy dotted underline. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.PageSetup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PageSetupData`) that contains shallow copies of any loaded child properties from the original object. */ - dottedHeavy = "DottedHeavy", + toJSON(): Word.Interfaces.PageSetupData; + } + /** + * Represents line numbers in the left margin or to the left of each newspaper-style column. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class LineNumbering 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; /** - * Heavy dash underline. + * Specifies the numeric increment for line numbers. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashHeavy = "DashHeavy", + countBy: number; /** - * Heavy dot dash underline. + * Specifies the distance (in points) between the right edge of line numbers and the left edge of the document text. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dotDashHeavy = "DotDashHeavy", + distanceFromText: number; /** - * Heavy dot dot dash underline. + * Specifies if line numbering is active for the specified document, section, or sections. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dotDotDashHeavy = "DotDotDashHeavy", + isActive: boolean; /** - * Long dash underline. + * Specifies the way line numbering runs; that is, whether it starts over at the beginning of a new page or section, or runs continuously. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashLong = "DashLong", + restartMode: Word.NumberingRule | "RestartContinuous" | "RestartSection" | "RestartPage"; /** - * Heavy long dash underline. + * Specifies the starting line number. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashLongHeavy = "DashLongHeavy", + startingNumber: number; /** - * Double wavy underline. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - wavyDouble = "WavyDouble", + set(properties: Interfaces.LineNumberingUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.LineNumbering): 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?: Word.Interfaces.LineNumberingLoadOptions): Word.LineNumbering; + /** + * 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[]): Word.LineNumbering; + /** + * 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; + }): Word.LineNumbering; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.LineNumbering; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.LineNumbering; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.LineNumbering` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.LineNumberingData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.LineNumberingData; } /** - * Specifies the view type in a Word document. + * A collection of {@link Word.TextColumn} objects that represent all the columns of text in the document or a section of the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum ViewType { + export class TextColumnCollection 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: Word.TextColumn[]; /** - * Normal. + * Returns a `TextColumn` object that represents a new text column added to a section or document. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param options - Optional. Options for configuring the new text column. + * @returns A `TextColumn` object that represents a new text column added to the document. */ - normal = "Normal", + add(options?: Word.TextColumnAddOptions): Word.TextColumn; /** - * Outline. + * Gets the direction in which text flows from one text column to the next. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - outline = "Outline", + getFlowDirection(): OfficeExtension.ClientResult; /** - * Print. + * Gets whether vertical lines appear between all the columns in the `TextColumnCollection` object. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - print = "Print", + getHasLineBetween(): OfficeExtension.ClientResult; /** - * Print preview. + * Gets whether text columns are evenly spaced. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - printPreview = "PrintPreview", + getIsEvenlySpaced(): OfficeExtension.ClientResult; /** - * Master. + * Gets a `TextColumn` by its index in the collection. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param index - A number that identifies the index location of a `TextColumn` object. */ - master = "Master", + getItem(index: number): Word.TextColumn; /** - * Web. + * Arranges text into the specified number of text columns. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param numColumns - The number of columns the text is to be arranged into. */ - web = "Web", + setCount(numColumns: number): void; /** - * Reading. + * Sets the direction in which text flows from one text column to the next. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param value - The flow direction to set. */ - reading = "Reading", + setFlowDirection(value: Word.FlowDirection): void; /** - * Conflict. + * Sets the direction in which text flows from one text column to the next. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param value - The flow direction to set. */ - conflict = "Conflict", - } - /** - * Represents the state of the window. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum WindowState { + setFlowDirection(value: "LeftToRight" | "RightToLeft"): void; /** - * Represents the normal state of the window. + * Sets whether vertical lines appear between all the columns in the `TextColumnCollection` object. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param value - `true` to show vertical lines between columns. */ - normal = "Normal", + setHasLineBetween(value: boolean): void; /** - * Represents the maximized state of the window. + * Sets whether text columns are evenly spaced. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param value - `true` to evenly space all the text columns in the document. */ - maximize = "Maximize", + setIsEvenlySpaced(value: boolean): void; /** - * Represents the minimized state of the window. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - minimize = "Minimize", + load(options?: Word.Interfaces.TextColumnCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TextColumnCollection; + /** + * 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[]): Word.TextColumnCollection; + /** + * 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): Word.TextColumnCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.TextColumnCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.TextColumnCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TextColumnCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TextColumnCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.TextColumnCollectionData; } /** - * Specifies the type of the window. + * Represents options for a new text column in a document or section of a document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum WindowType { + export interface TextColumnAddOptions { /** - * Specifies a document window. + * If provided, specifies whether to evenly space all the text columns in the document. The default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - document = "Document", + isEvenlySpaced?: boolean; /** - * Specifies a template window. + * If provided, specifies the spacing between the text columns in the document, in points. + The default value is -1, which means Word will automatically determine the width based on the number of columns and page size. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - template = "Template", + spacing?: number; + /** + * If provided, specifies the width of the new text column in the document, in points. + The default value is -1, which means Word will automatically determine the width based on the number of columns and page size. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + width?: number; } /** - * Specifies the direction in which text flows from one text column to the next. + * Represents a single text column in a section. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum FlowDirection { + export class TextColumn 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; /** - * Text flows from left to right. + * Specifies the amount of spacing (in points) after the specified paragraph or text column. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - leftToRight = "LeftToRight", + spaceAfter: number; /** - * Text flows from right to left. + * Specifies the width, in points, of the specified text columns. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rightToLeft = "RightToLeft", + width: number; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.TextColumnUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.TextColumn): 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?: Word.Interfaces.TextColumnLoadOptions): Word.TextColumn; + /** + * 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[]): Word.TextColumn; + /** + * 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; + }): Word.TextColumn; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.TextColumn; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.TextColumn; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TextColumn` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TextColumnData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.TextColumnData; } /** - * Specifies where the gutter appears in the document. + * Specifies the case of the text in the specified range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum GutterPosition { + enum CharacterCase { /** - * The gutter appears on the left side of the document. + * Specifies the next case. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - left = "Left", + next = "Next", /** - * The gutter appears on the right side of the document. + * Specifies lowercase. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - right = "Right", + lower = "Lower", /** - * The gutter appears at the top of the document. + * Specifies uppercase. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - top = "Top", - } - /** - * Specifies whether the gutter style should conform to left-to-right text flow or right-to-left text flow. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum GutterStyle { + upper = "Upper", /** - * Gutter style for bidirectional text flow. This is mainly right to left. + * Specifies title case for each word. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bidirectional = "Bidirectional", + titleWord = "TitleWord", /** - * Gutter style for Latin text flow. This is mainly left to right. + * Specifies title case for the sentence. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - latin = "Latin", - } - /** - * Specifies how text is laid out in the layout mode for the current document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum LayoutMode { + titleSentence = "TitleSentence", /** - * Default layout mode. + * Specifies toggle case. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - default = "Default", + toggle = "Toggle", /** - * Grid layout mode. + * Specifies half-width characters. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - grid = "Grid", + halfWidth = "HalfWidth", /** - * Line grid layout mode. + * Specifies full-width characters. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lineGrid = "LineGrid", + fullWidth = "FullWidth", /** - * Genko layout mode. + * Specifies Katakana characters. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - genko = "Genko", + katakana = "Katakana", + /** + * Specifies Hiragana characters. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hiragana = "Hiragana", } /** - * Specifies the numbering rule to apply. + * Specifies the character width of the text in the specified range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum NumberingRule { + enum CharacterWidth { /** - * Restart numbering continuously. + * Specifies half-width characters. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - restartContinuous = "RestartContinuous", + half = "Half", /** - * Restart numbering at the beginning of each section. + * Specifies full-width characters. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - restartSection = "RestartSection", - /** - * Restart numbering at the beginning of each page. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - restartPage = "RestartPage", + full = "Full", } /** - * Specifies a page layout orientation. + * Specifies the seek view options in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum PageOrientation { + enum SeekView { /** - * Portrait orientation. + * Main document. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - portrait = "Portrait", + mainDocument = "MainDocument", /** - * Landscape orientation. + * Primary header. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - landscape = "Landscape", + primaryHeader = "PrimaryHeader", + /** + * First page header. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + firstPageHeader = "FirstPageHeader", + /** + * Even pages header. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + evenPagesHeader = "EvenPagesHeader", + /** + * Primary footer. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + primaryFooter = "PrimaryFooter", + /** + * First page footer. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + firstPageFooter = "FirstPageFooter", + /** + * Even pages footer. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + evenPagesFooter = "EvenPagesFooter", + /** + * Footnotes. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + footnotes = "Footnotes", + /** + * Endnotes. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + endnotes = "Endnotes", + /** + * Current page header. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + currentPageHeader = "CurrentPageHeader", + /** + * Current page footer. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + currentPageFooter = "CurrentPageFooter", } /** - * Specifies the type of vertical alignment to apply. + * Specifies the source documents to show. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum PageSetupVerticalAlignment { + enum ShowSourceDocuments { /** - * Align text to the top. + * Specifies that no source documents are shown. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - top = "Top", + none = "None", /** - * Align text to the center. + * Specifies that the original source document is shown. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - center = "Center", + original = "Original", /** - * Justify text vertically. + * Specifies that the revised source document is shown. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - justify = "Justify", + revised = "Revised", /** - * Align text to the bottom. + * Specifies that both the original and revised source documents are shown. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottom = "Bottom", + both = "Both", } /** - * Specifies a paper size. + * Specifies the special pane options in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum PaperSize { + enum SpecialPane { /** - * 10x14 paper size. + * None. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - size10x14 = "Size10x14", + none = "None", /** - * 11x17 paper size. + * Primary header. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - size11x17 = "Size11x17", + primaryHeader = "PrimaryHeader", /** - * Letter paper size. + * First page header. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - letter = "Letter", + firstPageHeader = "FirstPageHeader", /** - * Small letter paper size. + * Even pages header. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - letterSmall = "LetterSmall", + evenPagesHeader = "EvenPagesHeader", /** - * Legal paper size. + * Primary footer. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legal = "Legal", + primaryFooter = "PrimaryFooter", /** - * Executive paper size. + * First page footer. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - executive = "Executive", + firstPageFooter = "FirstPageFooter", /** - * A3 paper size. + * Even pages footer. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - a3 = "A3", + evenPagesFooter = "EvenPagesFooter", /** - * A4 paper size. + * Footnotes. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - a4 = "A4", + footnotes = "Footnotes", /** - * Small A4 paper size. + * Endnotes. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - a4Small = "A4Small", + endnotes = "Endnotes", /** - * A5 paper size. + * Footnote continuation notice. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - a5 = "A5", + footnoteContinuationNotice = "FootnoteContinuationNotice", /** - * B4 paper size. + * Footnote continuation separator. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - b4 = "B4", + footnoteContinuationSeparator = "FootnoteContinuationSeparator", /** - * B5 paper size. + * Footnote separator. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - b5 = "B5", + footnoteSeparator = "FootnoteSeparator", /** - * C-sheet paper size. + * Endnote continuation notice. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - csheet = "CSheet", + endnoteContinuationNotice = "EndnoteContinuationNotice", /** - * D-sheet paper size. + * Endnote continuation separator. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dsheet = "DSheet", + endnoteContinuationSeparator = "EndnoteContinuationSeparator", /** - * E-sheet paper size. + * Endnote separator. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - esheet = "ESheet", + endnoteSeparator = "EndnoteSeparator", /** - * Fanfold legal German paper size. + * Comments. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fanfoldLegalGerman = "FanfoldLegalGerman", + comments = "Comments", /** - * Fanfold standard German paper size. + * Current page header. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fanfoldStdGerman = "FanfoldStdGerman", + currentPageHeader = "CurrentPageHeader", /** - * Fanfold US paper size. + * Current page footer. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fanfoldUS = "FanfoldUS", + currentPageFooter = "CurrentPageFooter", /** - * Folio paper size. + * Revisions. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - folio = "Folio", + revisions = "Revisions", /** - * Ledger paper size. + * Revisions horizontal. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - ledger = "Ledger", + revisionsHoriz = "RevisionsHoriz", /** - * Note paper size. + * Revisions vertical. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - note = "Note", + revisionsVert = "RevisionsVert", + } + /** + * Specifies the save options. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum SaveConfiguration { /** - * Quarto paper size. + * Specifies not to save changes. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - quarto = "Quarto", + doNotSaveChanges = "DoNotSaveChanges", /** - * Statement paper size. + * Specifies to save changes. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - statement = "Statement", + saveChanges = "SaveChanges", /** - * Tabloid paper size. + * Specifies to prompt to save changes. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tabloid = "Tabloid", + promptToSaveChanges = "PromptToSaveChanges", + } + /** + * Specifies the page color options in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PageColor { /** - * Envelope size 9. + * None. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelope9 = "Envelope9", + none = "None", /** - * Envelope size 10. + * Sepia. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelope10 = "Envelope10", + sepia = "Sepia", /** - * Envelope size 11. + * Inverse. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelope11 = "Envelope11", + inverse = "Inverse", + } + /** + * Specifies the page movement type in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PageMovementType { /** - * Envelope size 12. + * Vertical. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelope12 = "Envelope12", + vertical = "Vertical", /** - * Envelope size 14. + * Side to side. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelope14 = "Envelope14", + sideToSide = "SideToSide", + } + /** + * Specifies the margin options in reading layout view in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ReadingLayoutMargin { /** - * Envelope B4 size. + * Microsoft Word determines automatically whether to show or hide the margins based on the available space. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeB4 = "EnvelopeB4", + automatic = "Automatic", /** - * Envelope B5 size. + * Hides margins. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeB5 = "EnvelopeB5", + suppress = "Suppress", /** - * Envelope B6 size. + * Shows margins. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeB6 = "EnvelopeB6", + full = "Full", + } + /** + * Specifies the margin for revision balloons in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum RevisionsBalloonMargin { /** - * Envelope C3 size. + * Left margin. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeC3 = "EnvelopeC3", + left = "Left", /** - * Envelope C4 size. + * Right margin. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeC4 = "EnvelopeC4", + right = "Right", + } + /** + * Specifies the width type for revision balloons in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum RevisionsBalloonWidthType { /** - * Envelope C5 size. + * Balloon width as a percentage. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeC5 = "EnvelopeC5", + percent = "Percent", /** - * Envelope C6 size. + * Balloon width in points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeC6 = "EnvelopeC6", + points = "Points", + } + /** + * Specifies the extent of markup visible in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum RevisionsMarkup { /** - * Envelope C65 size. + * No markup. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeC65 = "EnvelopeC65", + none = "None", /** - * Envelope DL size. + * Simple markup. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeDL = "EnvelopeDL", + simple = "Simple", /** - * Envelope Italy size. + * All markup. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeItaly = "EnvelopeItaly", + all = "All", + } + /** + * Specifies the display mode for tracked changes in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum RevisionsMode { /** - * Envelope Monarch size. + * Balloon. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeMonarch = "EnvelopeMonarch", + balloon = "Balloon", /** - * Envelope Personal size. + * Inline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopePersonal = "EnvelopePersonal", + inline = "Inline", /** - * Custom paper size. + * Mixed. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - custom = "Custom", + mixed = "Mixed", } /** - * Specifies how Word displays the reading order and alignment for the specified sections. + * Specifies whether Word displays the original version of a document or a version with revisions and formatting changes applied. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum SectionDirection { + enum RevisionsView { /** - * Right-to-left reading order. + * Final view. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rightToLeft = "RightToLeft", + final = "Final", /** - * Left-to-right reading order. + * Original view. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - leftToRight = "LeftToRight", + original = "Original", } /** - * Specifies the type of section break for the specified item. + * Specifies the revision type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum SectionStart { + enum RevisionType { /** - * Continuous section break. + * No revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - continuous = "Continuous", + none = "None", /** - * New column section break. + * Insert revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - newColumn = "NewColumn", + insert = "Insert", /** - * New page section break. + * Delete revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - newPage = "NewPage", + delete = "Delete", /** - * Even page section break. + * Property revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - evenPage = "EvenPage", + property = "Property", /** - * Odd page section break. + * Paragraph number revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - oddPage = "OddPage", - } - /** - * Represents a single bookmark in a document, selection, or range. The `Bookmark` object is a member of the `Bookmark` collection. - The {@link Word.BookmarkCollection} includes all the bookmarks listed in the **Bookmark** dialog box (**Insert** menu). - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export class Bookmark 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; + paragraphNumber = "ParagraphNumber", /** - * Returns a `Range` object that represents the portion of the document that's contained in the `Bookmark` object. - * + * Display field revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly range: Word.Range; + displayField = "DisplayField", /** - * Specifies the ending character position of the bookmark. - * + * Reconcile revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - end: number; + reconcile = "Reconcile", /** - * Returns `true` if the bookmark is a table column. - * + * Conflict revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly isColumn: boolean; + conflict = "Conflict", /** - * Returns `true` if the bookmark is empty. - * + * Style revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly isEmpty: boolean; + style = "Style", /** - * Returns the name of the `Bookmark` object. - * + * Replace revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly name: string; + replace = "Replace", /** - * Specifies the starting character position of the bookmark. - * + * Paragraph property revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - start: number; + paragraphProperty = "ParagraphProperty", /** - * Returns the story type for the bookmark. - * + * Table property revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly storyType: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; + tableProperty = "TableProperty", /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Section property revision. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.BookmarkUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Bookmark): void; + sectionProperty = "SectionProperty", /** - * Copies this bookmark to the new bookmark specified in the `name` argument and returns a `Bookmark` object. - * + * Style definition revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param name - The name of the new bookmark. */ - copyTo(name: string): Word.Bookmark; + styleDefinition = "StyleDefinition", /** - * Deletes the bookmark. - * + * Moved from revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - delete(): void; + movedFrom = "MovedFrom", /** - * Selects the bookmark. - * + * Moved to revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - select(): void; + movedTo = "MovedTo", /** - * 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. + * Cell insertion revision. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.BookmarkLoadOptions): Word.Bookmark; + cellInsertion = "CellInsertion", /** - * 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. + * Cell deletion revision. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.Bookmark; + cellDeletion = "CellDeletion", /** - * 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. + * Cell merge revision. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.Bookmark; + cellMerge = "CellMerge", /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + * Cell split revision. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.Bookmark; + cellSplit = "CellSplit", /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + * Conflict insert revision. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.Bookmark; + conflictInsert = "ConflictInsert", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Bookmark` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BookmarkData`) that contains shallow copies of any loaded child properties from the original object. + * Conflict delete revision. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.BookmarkData; + conflictDelete = "ConflictDelete", } /** - * A collection of {@link Word.Bookmark} objects that represent the bookmarks in the specified selection, range, or document. + * Specifies the column width options in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export class BookmarkCollection 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: Word.Bookmark[]; + enum ColumnWidth { /** - * Determines whether the specified bookmark exists. - * + * Narrow column width. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param name - A bookmark name than cannot include more than 40 characters or more than one word. - * @returns `true` if the bookmark exists. */ - exists(name: string): OfficeExtension.ClientResult; + narrow = "Narrow", /** - * Gets a `Bookmark` object by its index in the collection. - * + * Default column width. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param index - A number that identifies the index location of a `Bookmark` object. */ - getItem(index: number): Word.Bookmark; + default = "Default", /** - * 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. + * Wide column width. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.BookmarkCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.BookmarkCollection; + wide = "Wide", + } + /** + * Specifies the field shading options in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum FieldShading { /** - * 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. + * Never shade fields. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.BookmarkCollection; + never = "Never", /** - * 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. + * Always shade fields. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.BookmarkCollection; + always = "Always", /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + * Shade fields when selected. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.BookmarkCollection; + whenSelected = "WhenSelected", + } + /** + * Specifies the format for horizontal text set within vertical text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum HorizontalInVerticalType { /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + * No formatting is applied to the horizontal text. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.BookmarkCollection; + none = "None", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.BookmarkCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BookmarkCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * The horizontal text is sized to fit in the line of vertical text. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.BookmarkCollectionData; + fitInLine = "FitInLine", + /** + * The line of vertical text is sized to accommodate the horizontal text. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + resizeLine = "ResizeLine", } /** - * Specifies the type of story in a Word document. + * Specifies the IME (Input Method Editor) mode. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum StoryType { + enum ImeMode { /** - * Main text story. + * Specifies no control over the IME mode. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mainText = "MainText", + noControl = "NoControl", /** - * Footnotes story. + * Specifies the IME mode is on. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footnotes = "Footnotes", + on = "On", /** - * Endnotes story. + * Specifies the IME mode is off. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endnotes = "Endnotes", + off = "Off", /** - * Comments story. + * Specifies the Hiragana IME mode. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - comments = "Comments", + hiragana = "Hiragana", /** - * Text frame story. + * Specifies the Katakana (double-byte) IME mode. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textFrame = "TextFrame", + katakana = "Katakana", /** - * Even pages header story. + * Specifies the Katakana (half-width) IME mode. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - evenPagesHeader = "EvenPagesHeader", + katakanaHalf = "KatakanaHalf", /** - * Primary header story. + * Specifies the full-width alphanumeric IME mode. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - primaryHeader = "PrimaryHeader", + alphaFull = "AlphaFull", /** - * Even pages footer story. + * Specifies the half-width alphanumeric IME mode. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - evenPagesFooter = "EvenPagesFooter", + alpha = "Alpha", /** - * Primary footer story. + * Specifies the full-width Hangul IME mode. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - primaryFooter = "PrimaryFooter", + hangulFull = "HangulFull", /** - * First page header story. + * Specifies the half-width Hangul IME mode. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - firstPageHeader = "FirstPageHeader", + hangul = "Hangul", + } + /** + * Specifies the Kana type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum Kana { /** - * First page footer story. + * Katakana Kana type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - firstPageFooter = "FirstPageFooter", + katakana = "Katakana", /** - * Footnote separator story. + * Hiragana Kana type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footnoteSeparator = "FootnoteSeparator", + hiragana = "Hiragana", + } + /** + * Specifies the two lines in one type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum TwoLinesInOneType { /** - * Footnote continuation separator story. + * No two lines in one. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footnoteContinuationSeparator = "FootnoteContinuationSeparator", + none = "None", /** - * Footnote continuation notice story. + * Two lines in one without brackets. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footnoteContinuationNotice = "FootnoteContinuationNotice", + noBrackets = "NoBrackets", /** - * Endnote separator story. + * Two lines in one with parentheses. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endnoteSeparator = "EndnoteSeparator", + parentheses = "Parentheses", /** - * Endnote continuation separator story. + * Two lines in one with square brackets. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endnoteContinuationSeparator = "EndnoteContinuationSeparator", + squareBrackets = "SquareBrackets", /** - * Endnote continuation notice story. + * Two lines in one with angle brackets. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endnoteContinuationNotice = "EndnoteContinuationNotice", + angleBrackets = "AngleBrackets", + /** + * Two lines in one with curly brackets. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + curlyBrackets = "CurlyBrackets", } /** - * Represents a single index. The `Index` object is a member of the {@link Word.IndexCollection}. The `IndexCollection` includes all the - indexes in the document. + * Specifies the underline type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export class Index 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 Underline { /** - * Returns a `Range` object that represents the portion of the document that is contained within the index. - * + * No underline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly range: Word.Range; + none = "None", /** - * Gets a value that represents how Microsoft Word classifies the first character of entries in the index. - See `IndexFilter` for available values. - * + * Single underline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly filter: Word.IndexFilter | "None" | "Aiueo" | "Akasatana" | "Chosung" | "Low" | "Medium" | "Full"; + single = "Single", /** - * Gets the text between alphabetical groups (entries that start with the same letter) in the index. Corresponds to - the **\h** switch for an {@link https://support.microsoft.com/office/adafcf4a-cb30-43f6-85c7-743da1635d9e | INDEX field}. - * + * Underline words only. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly headingSeparator: Word.HeadingSeparator | "None" | "BlankLine" | "Letter" | "LetterLow" | "LetterFull"; + words = "Words", /** - * Gets a `LanguageId` value that represents the sorting language to use for the index. - * + * Double underline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly indexLanguage: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + double = "Double", /** - * Gets the number of columns for each page of the index. - * + * Dotted underline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly numberOfColumns: number; + dotted = "Dotted", /** - * Specifies if page numbers are aligned with the right margin in the index. - * + * Thick underline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly rightAlignPageNumbers: boolean; + thick = "Thick", /** - * Gets if the index contains separate headings for accented letters (for example, words that begin with "À" are under - one heading and words that begin with "A" are under another). - * + * Dash underline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly separateAccentedLetterHeadings: boolean; + dash = "Dash", /** - * Specifies the sorting criteria for the index. - * + * Dot dash underline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly sortBy: Word.IndexSortBy | "Stroke" | "Syllable"; + dotDash = "DotDash", /** - * Specifies the leader character between entries in the index and their associated page numbers. - * + * Dot dot dash underline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + dotDotDash = "DotDotDash", /** - * Gets the index type. - * + * Wavy underline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly type: Word.IndexType | "Indent" | "Runin"; + wavy = "Wavy", /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Heavy wavy underline. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.IndexUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Index): void; + wavyHeavy = "WavyHeavy", /** - * Deletes this index. - * + * Heavy dotted underline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - delete(): void; + dottedHeavy = "DottedHeavy", /** - * 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. + * Heavy dash underline. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.IndexLoadOptions): Word.Index; + dashHeavy = "DashHeavy", /** - * 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. + * Heavy dot dash underline. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.Index; + dotDashHeavy = "DotDashHeavy", /** - * 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. + * Heavy dot dot dash underline. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.Index; + dotDotDashHeavy = "DotDotDashHeavy", /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + * Long dash underline. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.Index; + dashLong = "DashLong", /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + * Heavy long dash underline. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.Index; + dashLongHeavy = "DashLongHeavy", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Index` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.IndexData`) that contains shallow copies of any loaded child properties from the original object. + * Double wavy underline. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.IndexData; + wavyDouble = "WavyDouble", } /** - * A collection of {@link Word.Index} objects that represents all the indexes in the document. + * Specifies the view type in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export class IndexCollection 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: Word.Index[]; + enum ViewType { /** - * Returns an `Index` object that represents a new index added to the document. - * + * Normal. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param range - The range where you want the index to appear. The index replaces the range, if the range is not collapsed. - * @param indexAddOptions - Optional. The options for adding the index. */ - add(range: Word.Range, indexAddOptions?: Word.IndexAddOptions): Word.Index; + normal = "Normal", /** - * Gets the `IndexFormat` value that represents the formatting for the indexes in the document. - * + * Outline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - getFormat(): OfficeExtension.ClientResult; + outline = "Outline", /** - * Gets an `Index` object by its index in the collection. - * + * Print. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param index - A number that identifies the index location of an `Index` object. */ - getItem(index: number): Word.Index; + print = "Print", /** - * Inserts an {@link https://support.microsoft.com/office/abaf7c78-6e21-418d-bf8b-f8186d2e4d08 | XE (Index Entry) field} after all instances of the text in the range. - * + * Print preview. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param range - The range whose text is marked with an `XE` field throughout the document. - * @param markAllEntriesOptions - Optional. The options for marking all entries. */ - markAllEntries(range: Word.Range, markAllEntriesOptions?: Word.IndexMarkAllEntriesOptions): 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?: Word.Interfaces.IndexCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.IndexCollection; - /** - * 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[]): Word.IndexCollection; + printPreview = "PrintPreview", /** - * 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. + * Master. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.IndexCollection; + master = "Master", /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + * Web. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.IndexCollection; + web = "Web", /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + * Reading. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.IndexCollection; + reading = "Reading", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.IndexCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.IndexCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * Conflict. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.IndexCollectionData; + conflict = "Conflict", } /** - * Represents options for creating an index in a Word document. + * Represents the state of the window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export interface IndexAddOptions { - /** - * If provided, specifies the text between alphabetical groups (entries that start with the same letter) in the index. - See `HeadingSeparator` for available values. The default value is `Word.HeadingSeparator.blankLine`. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - headingSeparator?: Word.HeadingSeparator | "None" | "BlankLine" | "Letter" | "LetterLow" | "LetterFull"; - /** - * If provided, specifies the sorting language to be used for the index being added. - See `LanguageId` for available values. The default value is the installed language of the Word application. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - indexLanguage?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + enum WindowState { /** - * If provided, specifies the number of columns for each page of the index. - Specifying 0 (zero) sets the number of columns in the index to the same number as in the document. The default value is 1. - * + * Represents the normal state of the window. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - numberOfColumns?: number; + normal = "Normal", /** - * If provided, specifies whether the page numbers in the generated index are aligned with the right margin. The default value is `false`. - * + * Represents the maximized state of the window. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rightAlignPageNumbers?: boolean; + maximize = "Maximize", /** - * If provided, specifies whether to include separate headings for accented letters in the index. The default value is `false`. - * + * Represents the minimized state of the window. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - separateAccentedLetterHeadings?: boolean; + minimize = "Minimize", + } + /** + * Specifies the type of the window. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum WindowType { /** - * If provided, specifies the sorting criteria to be used for the index being added. Can be either of the following `IndexSortBy` values: `stroke` or `syllable`. The default value is `Word.IndexSortBy.stroke`. - * + * Specifies a document window. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sortBy?: Word.IndexSortBy | "Stroke" | "Syllable"; + document = "Document", /** - * If provided, specifies whether subentries are on the same line (run-in) as the main entry or on a separate line (indented) from the main entry. - Can be either of the following `IndexType` values: `indent` or `runin`. The default value is `Word.IndexType.indent`. - * + * Specifies a template window. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.IndexType | "Indent" | "Runin"; + template = "Template", } /** - * Represents options for marking all index entries in a Word document. + * Represents the options for the {@link Word.Selection | Selection.convertToTable} method. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export interface IndexMarkAllEntriesOptions { + export interface SelectionConvertToTableOptions { /** - * If provided, specifies whether to add bold formatting to page numbers for index entries. The default value is `false`. + * If provided, specifies whether to apply borders to the table of the specified format. Default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bold?: boolean; + applyBorders?: boolean; /** - * If provided, specifies the bookmark name that marks the range of pages you want to appear in the index. If this property is omitted, the number of the page that contains the `XE` field appears in the index. The default value is "". + * If provided, specifies whether to apply color formatting to the table of the specified format. Default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bookmarkName?: string; + applyColor?: boolean; /** - * If provided, specifies the cross-reference that will appear in the index. The default value is "". + * If provided, specifies whether to apply special formatting to the first column of the specified format. Default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - crossReference?: string; + applyFirstColumn?: boolean; /** - * If provided, specifies the name of the `AutoText` entry that contains the text for a cross-reference (if this property is specified, `crossReference` is ignored). The default value is "". + * If provided, specifies whether to apply font formatting to the table of the specified format. Default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - crossReferenceAutoText?: string; + applyFont?: boolean; /** - * If provided, specifies the text you want to appear in the index, in the form `MainEntry[:Subentry]`. The default value is "". - Either this property or `entryAutoText` must be provided. + * If provided, specifies whether to format the first row as a header row of the specified format. Default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - entry?: string; + applyHeadingRows?: boolean; /** - * If provided, specifies the `AutoText` entry that contains the text you want to appear in the index (if this property is specified, `entry` is ignored). The default value is "". - Either this property or `entry` must be provided. + * If provided, specifies whether to apply special formatting to the last column of the specified format. Default value is `false`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - entryAutoText?: string; + applyLastColumn?: boolean; /** - * If provided, specifies whether to add italic formatting to page numbers for index entries. The default value is `false`. + * If provided, specifies whether to apply special formatting to the last row of the specified format. Default value is `false`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - italic?: boolean; - } - /** - * Represents options for marking an index entry in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface IndexMarkEntryOptions { + applyLastRow?: boolean; /** - * If provided, specifies whether to add bold formatting to page numbers for index entries. The default value is `false`. + * If provided, specifies whether to apply shading to the table of the specified format. Default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bold?: boolean; + applyShading?: boolean; /** - * If provided, specifies the bookmark name that marks the range of pages you want to appear in the index. If this property is omitted, the number of the page that contains the `XE` field appears in the index. The default value is "". + * If provided, specifies whether to automatically resize the table to fit the contents. Default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bookmarkName?: string; + autoFit?: boolean; /** - * If provided, specifies the cross-reference that will appear in the index. The default value is "". + * If provided, specifies the auto-fit behavior for the table. Used when the `defaultTableBehavior` property is `enableAutoFit`. The default value is `fixed`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - crossReference?: string; + autoFitBehavior?: Word.AutoFitBehavior | "FixedSize" | "Content" | "Window"; /** - * If provided, specifies the name of the `AutoText` entry that contains the text for a cross-reference (if this property is specified, `crossReference` is ignored). The default value is "". + * If provided, specifies whether Microsoft Word automatically resizes cells in a table to fit the contents. The default value is `disableAutoFit`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - crossReferenceAutoText?: string; + defaultTableBehavior?: Word.DefaultTableBehavior | "DisableAutoFit" | "EnableAutoFit"; /** - * If provided, specifies the text you want to appear in the index, in the form `MainEntry[:Subentry]`. The default value is "". - Either this property or `entryAutoText` must be provided. + * If provided, specifies a preset format to apply to the table. If omitted, Word applies the default table format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - entry?: string; + format?: Word.TableFormat | "None" | "Simple1" | "Simple2" | "Simple3" | "Classic1" | "Classic2" | "Classic3" | "Classic4" | "Colorful1" | "Colorful2" | "Colorful3" | "Columns1" | "Columns2" | "Columns3" | "Columns4" | "Columns5" | "Grid1" | "Grid2" | "Grid3" | "Grid4" | "Grid5" | "Grid6" | "Grid7" | "Grid8" | "List1" | "List2" | "List3" | "List4" | "List5" | "List6" | "List7" | "List8" | "ThreeDEffects1" | "ThreeDEffects2" | "ThreeDEffects3" | "Contemporary" | "Elegant" | "Professional" | "Subtle1" | "Subtle2" | "Web1" | "Web2" | "Web3"; /** - * If provided, specifies the `AutoText` entry that contains the text you want to appear in the index (if this property is specified, `entry` is ignored). The default value is "". - Either this property or `entry` must be provided. + * If provided, specifies the initial width of each column in the table, in points. If omitted, Word calculates and adjusts the column width so that the table stretches from margin to margin. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - entryAutoText?: string; + initialColumnWidth?: number; /** - * If provided, specifies whether to add italic formatting to page numbers for index entries. The default value is `false`. + * If provided, specifies the number of columns in the table. If omitted, Word determines the number of columns based on the contents of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - italic?: boolean; + numColumns?: number; /** - * If provided, specifies whether to show an index entry in the right location when indexes are sorted phonetically (East Asian languages only). The default value is `false`. + * If provided, specifies the number of rows in the table. If omitted, Word determines the number of rows based on the contents of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - reading?: boolean; + numRows?: number; + /** + * If provided, specifies the character used to separate text into cells. The default value is `-`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + separator?: string; } /** - * Specifies the type of separator to use for headings. + * Represents the options for the {@link Word.Selection | Selection.delete} method. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum HeadingSeparator { + export interface SelectionDeleteOptions { /** - * No separator is used for headings. + * If provided, specifies the number of units to be deleted. To delete units after the selection, collapse the selection and use a positive number. To delete units before the selection, collapse the selection and use a negative number. The default value is 1. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + count?: number; /** - * A blank line is used as a separator for headings. + * If provided, specifies the unit by which the collapsed selection is to be deleted. The default value is `character`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - blankLine = "BlankLine", + unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; + } + /** + * Represents the options for the {@link Word.Selection | Selection.goTo} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface SelectionGoToOptions { /** - * A single letter is used as a separator for headings. + * If provided, specifies the number of the item in the document. Only positive values are valid. The default value is 1. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - letter = "Letter", + count?: number; /** - * A lowercase letter is used as a separator for headings. + * If provided, specifies the direction the range or selection is moved to. The default value is `next`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - letterLow = "LetterLow", + direction?: Word.GoToDirection | "First" | "Last" | "Next" | "Previous"; /** - * A full-width letter is used as a separator for headings. + * If provided, specifies the kind of item the range or selection is moved to. The default value is `page`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - letterFull = "LetterFull", + item?: Word.GoToItem | "Bookmark" | "Comment" | "Endnote" | "Field" | "Footnote" | "Graphic" | "Heading" | "Line" | "Page" | "Section" | "Table" | "EmbeddedObject" | "Equation" | "Percent" | "SpellingError" | "GrammaticalError" | "ProofreadingError"; + /** + * If provided, specifies the name if the `item` property is set to {@link Word.GoToItem} type `bookmark`, `comment`, `field`, or `object`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + name?: string; } /** - * Represents the position of a dropped capital letter. + * Represents the options for the {@link Word.Selection | Selection.insertCrossReference} method. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum DropPosition { + export interface SelectionInsertCrossReferenceOptions { /** - * Represents that there's no dropped capital letter. + * If provided, specifies whether to include position. `true` to insert "above" or "below," depending on the location of the reference item in relation to the cross-reference. The default value is `false`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + includePosition?: boolean; /** - * Represents a normal dropped capital letter. + * If provided, specifies whether to insert the cross-reference as a hyperlink. The default value is `false`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - normal = "Normal", + insertAsHyperlink?: boolean; /** - * Represents a dropped capital letter in the margin. + * If provided, specifies whether to use a separator to separate the numbers from the associated text. The default value is `false`. (Use only if the `referenceType` parameter is set to `numberedItem` and the `referenceKind` parameter is set to `numberFullContext` when the `Selection.insertCrossReference` method is called.) + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - margin = "Margin", + separateNumbers?: boolean; + /** + * If provided, specifies the string to use as a separator if the `separateNumbers` parameter is set to `true` when the `Selection.insertCrossReference` method is called. The default value is " ". + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + separatorString?: string; } /** - * Represents the type of line spacing. + * Represents the options for the {@link Word.Selection | Selection.insertDateTime} method. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum LineSpacing { + export interface SelectionInsertDateTimeOptions { /** - * Represents single line spacing. + * If provided, specifies the calendar type to use when displaying the date or time. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - single = "Single", + calendarType?: Word.CalendarTypeBidirectional | "Gregorian" | "Bidirectional"; /** - * Represents 1.5 line spacing. + * If provided, specifies the language in which to display the date or time. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - onePt5 = "OnePt5", + dateLanguage?: Word.DateLanguage | "Bidirectional" | "Latin"; /** - * Represents double line spacing. + * If provided, specifies the format to be used for displaying the date or time, or both. If this property is omitted, Microsoft Word uses the short-date style from the Windows Control Panel (Regional Settings icon). See {@link https://support.microsoft.com/office/47fbbdc1-52fa-416a-b8d5-ba24d881b698 | Date/Time data type} for format symbols. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - double = "Double", + dateTimeFormat?: string; /** - * Represents at least line spacing. + * If provided, specifies whether to insert the specified information as a {@link https://support.microsoft.com/office/6cb8fcef-310a-4646-ae6b-886d88335c90 | TIME field}. The default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - atLeast = "AtLeast", + insertAsField?: boolean; /** - * Represents exact line spacing. + * If provided, specifies whether to insert the specified information as full-width (double-byte) digits. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - exactly = "Exactly", + insertAsFullWidth?: boolean; + } + /** + * Represents the options for the {@link Word.Selection | Selection.insertFormula} method + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface SelectionInsertFormulaOptions { /** - * Represents multiple line spacing. + * If provided, specifies the mathematical formula you want the {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | = (Formula) field} to evaluate. + The `formula` property is optional only if the selection is in a cell and there is at least one cell that contains a value above or to the left of the cell that contains the insertion point. If the cells above the insertion point contain values, the inserted field is `{=SUM(ABOVE)}`; if the cells to the left of the insertion point contain values, the inserted field is `{=SUM(LEFT)}`. If both the cells above the insertion point and the cells to the left of it contain values, Microsoft Word uses the following rules to determine which `SUM` function to insert. + + - If the cell immediately above the insertion point contains a value, Word inserts `{=SUM(ABOVE)}`. + + - If the cell immediately above the insertion point doesn't contain a value but the cell immediately to the left of the insertion point does, Word inserts `{=SUM(LEFT)}`. + + - If neither cell immediately above the insertion point nor the cell immediately below it contains a value, Word inserts `{=SUM(ABOVE)}`. + + - If you don't specify the `formula` property and all the cells above and to the left of the insertion point are empty, using the `= (Formula)` field causes an error. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - multiple = "Multiple", + formula?: string; + /** + * If provided, specifies the format for the result of the `= (Formula)` field. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numberFormat?: string; } /** - * Represents the alignment of a tab stop. + * Represents the options for the {@link Word.Selection | Selection.insertSymbol} method. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum TabAlignment { + export interface SelectionInsertSymbolOptions { /** - * Represents that the tab stop is aligned to the left. + * If provided, specifies the font bias for symbols. This argument is useful for setting the correct font bias for East Asian characters. The default value is `default`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - left = "Left", + bias?: Word.FontBias | "Standard" | "FarEast" | "NoSpecified"; /** - * Represents that the tab stop is aligned to the center. + * If provided, specifies the name of the font that contains the symbol. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - center = "Center", + font?: string; /** - * Represents that the tab stop is aligned to the right. + * If provided, specifies whether the character is Unicode. `true` to insert the Unicode character specified by the `characterNumber` property when the `Selection.insertSymbol` method is called; `false` to instead insert the ANSI character specified by the `characterNumber` property. The default value is `false`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - right = "Right", + unicode?: boolean; + } + /** + * Represents the options for the {@link Word.Selection | Selection.moveLeft and Selection.moveRight} methods. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface SelectionMoveLeftRightOptions { /** - * Represents that the tab stop is aligned to the decimal point. + * If provided, specifies the number of units the selection is to be moved. The default value is 1. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - decimal = "Decimal", + count?: number; /** - * Represents that the tab stop is aligned to the bar. + * If provided, specifies the type of movement. The movement direction (left or right) is according to the calling method. If set to `move`, the selection is collapsed to the endpoint and moved in the appropriate direction. If set to `extend`, the selection is extended in the appropriate direction. The default value is `move`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bar = "Bar", + extend?: Word.MovementType | "Move" | "Extend"; /** - * Represents that the tab stop is aligned to the list. + * If provided, specifies the unit by which the selection is to be moved. The default value is `character`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - list = "List", + unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; } /** - * Represents the type of tight wrap for a text box. + * Represents the options for the {@link Word.Selection | Selection.move} method. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum TextboxTightWrap { - /** - * Represents that there's no tight wrap. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - none = "None", + export interface SelectionMoveOptions { /** - * Represents tight wrap around all lines. + * If provided, specifies the number of units by which the range or selection is to be moved. If `count` is a positive number, the object is collapsed to its end position and moved backward in the document by the specified number of units. If `count` is a negative number, the object is collapsed to its start position and moved forward by the specified number of units. The default value is 1. You can also control the collapse direction by using the {@link Word.Selection | Selection.collapse} method before using the `move` method. If the range or selection is in the middle of a unit or isn't collapsed, moving it to the beginning or end of the unit counts as moving it one full unit. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - all = "All", + count?: number; /** - * Represents tight wrap around the first and last lines. + * If provided, specifies the unit by which to move the ending character position. The default value is `character`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - firstAndLastLines = "FirstAndLastLines", + unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; + } + /** + * Represents the options for the {@link Word.Selection | Selection.moveEnd and Selection.moveStart} methods. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface SelectionMoveStartEndOptions { /** - * Represents tight wrap around the first line only. + * If provided, specifies the number of units to move. The affected character position (start or end) is according to the calling method. If this number is positive, the position is moved forward in the document. If this number is negative, the position is moved backward. If the affected position encounters the other position, the selection is collapsed and both the start and end positions move together. The default value is 1. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - firstLineOnly = "FirstLineOnly", + count?: number; /** - * Represents tight wrap around the last line only. + * If provided, specifies the unit by which the selection's start or end position (per the calling method) is to be moved. The default value is `character`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lastLineOnly = "LastLineOnly", + unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; } /** - * Specifies the filter type for an index. + * Represents the options for the {@link Word.Selection | Selection.moveUp and Selection.moveDown} methods. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum IndexFilter { + export interface SelectionMoveUpDownOptions { /** - * No filter is applied. + * If provided, specifies the number of units the selection is to be moved. The default value is 1. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + count?: number; /** - * Aiueo filter is applied. + * If provided, specifies the type of movement. The movement direction (up or down) is according to the calling method. If set to `move`, the selection is collapsed to the endpoint and moved in the appropriate direction. If set to `extend`, the selection is extended in the appropriate direction. The default value is `move`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - aiueo = "Aiueo", + extend?: Word.MovementType | "Move" | "Extend"; /** - * Akasatana filter is applied. + * If provided, specifies the unit by which to move the selection. The default value is `line`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - akasatana = "Akasatana", + unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; + } + /** + * Represents the options for the {@link Word.Selection | Selection.next} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface SelectionNextOptions { /** - * Chosung filter is applied. + * If provided, specifies the number of units by which you want to move ahead. The default value is 1. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - chosung = "Chosung", + count?: number; /** - * Low filter is applied. + * If provided, specifies the type of units by which to move the selection. The default value is `character`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - low = "Low", + unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; + } + /** + * Represents the options for the {@link Word.Selection | Selection.previous} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface SelectionPreviousOptions { /** - * Medium filter is applied. + * If provided, specifies the number of units by which you want to move. The default value is 1. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - medium = "Medium", + count?: number; /** - * Full filter is applied. + * If provided, specifies the type of unit by which to move the selection. The default value is `character`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - full = "Full", + unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; } /** - * Specifies the format for an index. + * Represents a selected range or the insertion point in a Word document. + + - Note: {@link Word.Range | Range} objects share many of the same methods and properties as `Selection` objects. Using `Range` objects is preferable for manipulating a document when there isn't a reason to physically change the current selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum IndexFormat { + export class Selection 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; /** - * Template format. + * Returns a `BorderUniversalCollection` object that represents all the borders for the objects in the selection. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - template = "Template", + readonly borders: Word.BorderUniversalCollection; /** - * Classic format. + * Returns a `RangeScopedCollection` object that represents each character in the selection. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - classic = "Classic", + readonly characters: Word.RangeScopedCollection; /** - * Fancy format. + * Returns a `CommentCollection` object that represents all the comments in the selection. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fancy = "Fancy", + readonly comments: Word.CommentCollection; /** - * Modern format. + * Returns a `FieldCollection` object that represents all the fields in the selection. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - modern = "Modern", + readonly fields: Word.FieldCollection; /** - * Bulleted format. + * Returns the `Font` object that represents the character formatting of the selection. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bulleted = "Bulleted", + readonly font: Word.Font; /** - * Formal format. + * Specifies a `Range` object that includes the formatted text in the range or selection. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - formal = "Formal", + formattedText: Word.Range; /** - * Simple format. + * Returns a `ParagraphCollection` object that represents all the paragraphs in the selection. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - simple = "Simple", - } - /** - * Specifies how an index is sorted. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum IndexSortBy { + readonly paragraphs: Word.ParagraphCollection; /** - * Sort by stroke. + * Returns the `Range` object for the portion of the document contained in the selection. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - stroke = "Stroke", + readonly range: Word.Range; /** - * Sort by syllable. + * Returns the `SectionCollection` object in the selection. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - syllable = "Syllable", - } - /** - * Specifies the type of index to create. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum IndexType { + readonly sections: Word.SectionCollection; /** - * Creates an indented index. + * Returns the `RangeScopedCollection` object for each sentence in the selection. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - indent = "Indent", + readonly sentences: Word.RangeScopedCollection; /** - * Creates a run-in index. + * Returns the `ShadingUniversal` object for the shading formatting for the selection. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - runin = "Runin", - } - /** - * Specifies the tab leader style. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum TabLeader { + readonly shading: Word.ShadingUniversal; /** - * Spaces are used as the tab leader. + * Returns the `TableCollection` object in the selection. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spaces = "Spaces", + readonly tables: Word.TableCollection; /** - * Dots are used as the tab leader. + * Returns the tables at the outermost nesting level in the current selection. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dots = "Dots", + readonly topLevelTables: Word.TableCollection; /** - * Dashes are used as the tab leader. + * Returns the `RangeScopedCollection` object that represents each word in the selection. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashes = "Dashes", + readonly words: Word.RangeScopedCollection; /** - * Lines are used as the tab leader. + * Specifies the ending character position of the selection. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lines = "Lines", + end: number; /** - * Heavy lines are used as the tab leader. + * Specifies the width in which Word fits the text in the current selection. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - heavy = "Heavy", + fitTextWidth: number; /** - * Middle dots are used as the tab leader. + * Returns whether the spelling and grammar checker ignores the selected text. + If the selected text contains a mix of proofed and un-proofed content, this API returns `null`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - middleDot = "MiddleDot", - } - enum ErrorCodes { - accessDenied = "AccessDenied", - generalException = "GeneralException", - invalidArgument = "InvalidArgument", - itemNotFound = "ItemNotFound", - notAllowed = "NotAllowed", - notImplemented = "NotImplemented", - searchDialogIsOpen = "SearchDialogIsOpen", - searchStringInvalidOrTooLong = "SearchStringInvalidOrTooLong", - } - export namespace Interfaces { + readonly hasNoProofing: boolean; /** - * Provides ways to load properties of only a subset of members of a collection. + * Returns whether the selection in the specified window or pane is active. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - export interface CollectionLoadOptions { + readonly isActive: boolean; + /** + * Specifies whether column selection mode is active. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isColumnSelectModeActive: boolean; + /** + * Returns whether the selection is at the end-of-row mark in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly isEndOfRowMark: boolean; + /** + * Specifies whether Extend mode is active. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isExtendModeActive: boolean; + /** + * Returns whether the insertion point is at the end of a line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly isInsertionPointAtEndOfLine: boolean; + /** + * Specifies whether the beginning of the selection is active. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isStartActive: boolean; + /** + * Specifies whether Word has detected the language of the selected text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + languageDetected: boolean; + /** + * Returns the language for the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly languageId: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + /** + * Returns the East Asian language for the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly languageIdFarEast: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + /** + * Returns the language for the selection that isn't classified as an East Asian language. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly languageIdOther: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + /** + * Specifies the orientation of text in the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + orientation: Word.TextOrientation | "Horizontal" | "Upward" | "Downward" | "VerticalFarEast" | "HorizontalRotatedFarEast" | "Vertical"; + /** + * Specifies the starting character position of the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + start: number; + /** + * Returns the number of characters in the story that contains the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly storyLength: number; + /** + * Returns the story type for the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly storyType: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; + /** + * Specifies the text in the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + text: string; + /** + * Returns the selection type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly type: Word.SelectionType | "NoSelection" | "InsertionPoint" | "Normal" | "Frame" | "Column" | "Row" | "Block" | "InlineShape" | "SelectionShape"; + /** + * Calculates the first mathematical expression within the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * @returns The result of the calculation. + */ + calculate(): OfficeExtension.ClientResult; + /** + * Cancels a mode such as extend or column select. This is equivalent to pressing the Esc key. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + cancelMode(): void; + /** + * Removes character formatting applied through character styles. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + clearCharacterStyleFormatting(): void; + /** + * Removes character and paragraph formatting from the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + clearFormatting(): void; + /** + * Removes manually applied character formatting from the selected text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + clearManualCharacterFormatting(): void; + /** + * Removes manually applied paragraph formatting from the selected text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + clearManualParagraphFormatting(): void; + /** + * Removes all paragraph formatting from the selected text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + clearParagraphFormatting(): void; + /** + * Removes paragraph formatting applied through paragraph styles. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + clearParagraphStyle(): void; + /** + * Collapses the selection to the starting or ending position. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param direction - Optional. Direction to collapse. + */ + collapse(direction?: Word.CollapseDirection): void; + /** + * Collapses the selection to the starting or ending position. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param direction - Optional. Direction to collapse. + */ + collapse(direction?: "Start" | "End"): void; + /** + * Converts text within a range to a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - Optional. Options for converting text to a table. + * @returns A `Table` object that represents the newly created table. + */ + convertToTable(options?: Word.SelectionConvertToTableOptions): Word.Table; + /** + * Copies the selection to the Clipboard as a picture. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + copyAsPictureToClipboard(): void; + /** + * Copies the character formatting of the first character in the selected text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + copyFormat(): void; + /** + * Copies the selection to the Clipboard. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + copyToClipboard(): void; + /** + * Adds a default-sized text box around the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + createTextBox(): void; + /** + * Removes the selected content from the document and moves it to the Clipboard. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + cut(): void; + /** + * Deletes the specified number of characters or words. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - Optional. Options for deleting text. + * @returns The number of characters deleted. + */ + delete(options?: Word.SelectionDeleteOptions): OfficeExtension.ClientResult; + /** + * Analyzes the selected text to determine the language that it's written in. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + detectLanguage(): void; + /** + * Expands the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param unit - Optional. The unit to expand. + * @returns The number of characters added to the range or selection. + */ + expand(unit?: Word.OperationUnit): OfficeExtension.ClientResult; + /** + * Expands the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param unit - Optional. The unit to expand. + * @returns The number of characters added to the range or selection. + */ + expand(unit?: "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"): OfficeExtension.ClientResult; + /** + * Expands the selection to include the entire story. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + expandToWholeStory(): void; + /** + * Turns on extend mode, or if extend mode is already on, extends the selection to the next larger unit of text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param character - Optional. The character through which the selection is extended. This argument is case-sensitive and must evaluate to a string or an error occurs. Also, if the value of this argument is longer than a single character, Microsoft Word ignores the command entirely. + */ + extend(character?: Word.OperationUnit): void; + /** + * Turns on extend mode, or if extend mode is already on, extends the selection to the next larger unit of text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param character - Optional. The character through which the selection is extended. This argument is case-sensitive and must evaluate to a string or an error occurs. Also, if the value of this argument is longer than a single character, Microsoft Word ignores the command entirely. + */ + extend(character?: "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"): void; + /** + * Returns a `Range` object that represents the next unit relative to the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - Optional. Options for the `next` operation. + * @returns A `Range` object that represents the next unit relative to the selection. + */ + getNextRange(options?: Word.SelectionNextOptions): Word.Range; + /** + * Returns a `Range` object that represents the previous unit relative to the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - Optional. Options for the `previous` operation. + * @returns A `Range` object that represents the previous unit relative to the selection. + */ + getPreviousRange(options?: Word.SelectionPreviousOptions): Word.Range; + /** + * Returns a `Range` object that represents the area specified by the `options` and moves the insertion point to the character position immediately preceding the specified item. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - Optional. Options for the `goTo` operation. + * @returns A `Range` object that is now selected. + */ + goTo(options?: Word.SelectionGoToOptions): Word.Range; + /** + * Returns a `Range` object that refers to the start position of the next item or location specified by the `what` argument and moves the selection to the specified item. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param what - The item type to go to. + * @returns A `Range` object that refers to the start position of the next item or location specified by the `what` argument. + */ + goToNext(what: Word.GoToItem): Word.Range; + /** + * Returns a `Range` object that refers to the start position of the next item or location specified by the `what` argument and moves the selection to the specified item. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param what - The item type to go to. + * @returns A `Range` object that refers to the start position of the next item or location specified by the `what` argument. + */ + goToNext(what: "Bookmark" | "Comment" | "Endnote" | "Field" | "Footnote" | "Graphic" | "Heading" | "Line" | "Page" | "Section" | "Table" | "EmbeddedObject" | "Equation" | "Percent" | "SpellingError" | "GrammaticalError" | "ProofreadingError"): Word.Range; + /** + * Returns a `Range` object that refers to the start position of the previous item or location specified by the `what` argument and moves the selection to the specified item. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param what - The item type to go to. + * @returns A `Range` object that refers to the start position of the previous item or location specified by the `what` argument. + */ + goToPrevious(what: Word.GoToItem): Word.Range; + /** + * Returns a `Range` object that refers to the start position of the previous item or location specified by the `what` argument and moves the selection to the specified item. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param what - The item type to go to. + * @returns A `Range` object that refers to the start position of the previous item or location specified by the `what` argument. + */ + goToPrevious(what: "Bookmark" | "Comment" | "Endnote" | "Field" | "Footnote" | "Graphic" | "Heading" | "Line" | "Page" | "Section" | "Table" | "EmbeddedObject" | "Equation" | "Percent" | "SpellingError" | "GrammaticalError" | "ProofreadingError"): Word.Range; + /** + * Inserts the specified text at the end of the range or selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param text - Text to insert. + */ + insertAfter(text: string): void; + /** + * Inserts the specified text before the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param text - Text to insert. + */ + insertBefore(text: string): void; + /** + * Adds cells to an existing table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param shiftCells - Optional. Specifies how to insert the cells into the existing columns and rows of the table. The default value is `shiftDown`. + */ + insertCells(shiftCells?: Word.TableCellInsertionLocation): void; + /** + * Adds cells to an existing table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param shiftCells - Optional. Specifies how to insert the cells into the existing columns and rows of the table. The default value is `shiftDown`. + */ + insertCells(shiftCells?: "ShiftRight" | "ShiftDown" | "ShiftRowDown" | "ShiftColumnRight"): void; + /** + * Inserts columns to the left of the column that contains the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + insertColumnsLeft(): void; + /** + * Inserts columns to the right of the current selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + insertColumnsRight(): void; + /** + * Inserts the current date or time, or both, either as text or as a {@link https://support.microsoft.com/office/6cb8fcef-310a-4646-ae6b-886d88335c90 | TIME field}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - Options for inserting the date or time. + */ + insertDateTime(options?: Word.SelectionInsertDateTimeOptions): void; + /** + * Inserts a {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | Formula field} at the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - Optional. Options for inserting the formula. + */ + insertFormula(options?: Word.SelectionInsertFormulaOptions): void; + /** + * Inserts a new page at the position of the insertion point. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + insertNewPage(): void; + /** + * Inserts a paragraph mark after the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + insertParagraphAfter(): void; + /** + * Inserts a new paragraph before the selection or range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + insertParagraphBefore(): void; + /** + * Inserts a special hidden paragraph mark that allows Word to join paragraphs formatted using different paragraph styles. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + insertParagraphStyleSeparator(): void; + /** + * Inserts rows above the current selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param numRows - Optional. Number of rows to insert. + */ + insertRowsAbove(numRows: number): void; + /** + * Inserts rows below the current selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param numRows - Optional. Number of rows to insert. + */ + insertRowsBelow(numRows: number): void; + /** + * Inserts a symbol in place of the specified selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param characterNumber - The character number of the symbol. + * @param options - Optional. Options for inserting the symbol. + */ + insertSymbol(characterNumber: number, options?: Word.SelectionInsertSymbolOptions): void; + /** + * Inserts the specified text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param Text - The text to insert. + */ + insertText(Text: string): void; + /** + * Inserts the specified XML into the document at the cursor, replacing any selected text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param xml - The XML string to insert. + * @param transform - Optional. XSL transform to apply. + */ + insertXML(xml: string, transform?: string): void; + /** + * Returns whether the selection is equal to the specified range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param range - The range to compare. + * @returns `true` if the selection is equal to the specified range. + */ + isEqual(range: Word.Range): OfficeExtension.ClientResult; + /** + * Returns `true` if the selection is contained within the specified range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param range - The range to compare. + * @returns `true` if the selection is contained within the specified range. + */ + isInRange(range: Word.Range): OfficeExtension.ClientResult; + /** + * Returns whether the selection is in the same story as the specified range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param range - The range to compare. + * @returns `true` if the selection is in the same story as the specified range. + */ + isInStory(range: Word.Range): OfficeExtension.ClientResult; + /** + * Collapses the selection to its start or end position and then moves the collapsed object by the specified number of units. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - Optional. Options for moving the selection. + * @returns The number of characters by which the selection was moved. + */ + move(options?: Word.SelectionMoveOptions): OfficeExtension.ClientResult; + /** + * Moves the selection down. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - Optional. Options for moving down. + * @returns The number of characters by which the selection was moved. + */ + moveDown(options?: Word.SelectionMoveUpDownOptions): OfficeExtension.ClientResult; + /** + * Moves the ending character position of the range or selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - Optional. Options for moving end. + * @returns The number of characters by which the selection was moved. + */ + moveEnd(options?: Word.SelectionMoveStartEndOptions): OfficeExtension.ClientResult; + /** + * Moves the end position of the selection until any of the specified characters are found in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param characters - Characters to search for. For example. If you specify "a", the selection moves the end position to before the first "a" character. + * @param count - Optional. Maximum number of characters to search. + * @returns The number of characters by which the selection was moved. + */ + moveEndUntil(characters: string, count?: number): OfficeExtension.ClientResult; + /** + * Moves the ending character position of the selection while any of the specified characters are found in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param characters - Characters to search for. For example. If you specify "abcd", the selection moves the end position when any letter from "abcd" is found. + * @param count - Optional. Maximum number of characters to search. + * @returns The number of characters by which the selection was moved. + */ + moveEndWhile(characters: string, count?: number): OfficeExtension.ClientResult; + /** + * Moves the selection to the left. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - Optional. Options for moving left. + * @returns The number of characters by which the selection was moved. + */ + moveLeft(options?: Word.SelectionMoveLeftRightOptions): OfficeExtension.ClientResult; + /** + * Moves the selection to the right. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - Optional. Options for moving right. + * @returns The number of characters by which the selection was moved. + */ + moveRight(options?: Word.SelectionMoveLeftRightOptions): OfficeExtension.ClientResult; + /** + * Moves the start position of the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - Optional. Options for the `moveStart` operation. + * @returns The number of characters by which the selection was moved. + */ + moveStart(options?: Word.SelectionMoveStartEndOptions): OfficeExtension.ClientResult; + /** + * Moves the start position of the selection until one of the specified characters is found in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param characters - Characters to search for. If you specify "a", the selection moves the start position to before the first "a" character. + * @param count - Optional. Maximum number of characters to search. + * @returns The number of characters by which the selection was moved. + */ + moveStartUntil(characters: string, count?: number): OfficeExtension.ClientResult; + /** + * Moves the start position of the selection while any of the specified characters are found in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param characters - Characters to search for. For example. If you specify "abcd", the selection moves the start position when any letter from "abcd" is found. + * @param count - Optional. Maximum number of characters to search. + * @returns The number of characters by which the selection was moved. + */ + moveStartWhile(characters: string, count?: number): OfficeExtension.ClientResult; + /** + * Moves the selection until one of the specified characters is found in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param characters - Characters to search for. For example. If you specify "a", the selection moves to the position before the first "a" character. + * @param count - Optional. Maximum number of characters to search. + * @returns The number of characters by which the selection was moved. + */ + moveUntil(characters: string, count?: number): OfficeExtension.ClientResult; + /** + * Moves the selection up. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - Optional. Options for moving up. + * @returns The number of characters by which the selection was moved. + */ + moveUp(options?: Word.SelectionMoveUpDownOptions): OfficeExtension.ClientResult; + /** + * Moves the selection while any of the specified characters are found in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param characters - Characters to search for. For example. If you specify "abcd", the selection moves to the position when any letter from "abcd" is found. + * @param count - Optional. Maximum number of characters to search. + * @returns The number of characters by which the selection was moved. + */ + moveWhile(characters: string, count?: number): OfficeExtension.ClientResult; + /** + * Selects the next field. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * @returns The next field. + */ + nextField(): Word.Field; + /** + * Moves the selection to the next subDocument. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nextSubdocument(): void; + /** + * Pastes the content from clipboard and formats them as specified. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param type - The format paste type for table cells + */ + pasteAndFormat(type: Word.PasteFormatType): void; + /** + * Pastes the content from clipboard and formats them as specified. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param type - The format paste type for table cells + */ + pasteAndFormat(type: "PasteDefault" | "SingleCellText" | "SingleCellTable" | "ListContinueNumbering" | "ListRestartNumbering" | "TableAppendTable" | "TableInsertAsRows" | "TableOriginalFormatting" | "ChartPicture" | "Chart" | "ChartLinked" | "FormatOriginalFormatting" | "FormatSurroundingFormattingWithEmphasis" | "FormatPlainText" | "TableOverwriteCells" | "ListCombineWithExistingList" | "ListDontMerge" | "UseDestinationStylesRecovery"): void; + /** + * Pastes and formats a Microsoft Excel table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param linkedToExcel - Whether the table is linked to Excel. + * @param wordFormatting - Whether to apply Word formatting. + * @param rtf - Whether to paste as Rich Text Format (RTF). + */ + pasteExcelTable(linkedToExcel: boolean, wordFormatting: boolean, rtf: boolean): void; + /** + * Applies formatting copied with the `copyFormat` method to the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + pasteFormat(): void; + /** + * Merges pasted cells into an existing table by inserting the pasted rows between the selected rows. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + pasteTableCellsAppendTable(): void; + /** + * Pastes a cell or group of cells as a nested table into the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + pasteTableCellsAsNestedTable(): void; + /** + * Selects and returns the previous field. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * @returns The previous field. + */ + previousField(): Word.Field; + /** + * Moves the selection to the previous subDocument. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + previousSubdocument(): void; + /** + * Replaces the selection with a new paragraph. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + replaceParagraph(): void; + /** + * Selects the current text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + select(): void; + /** + * Selects the entire cell containing the current selection when the selection is in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + selectCell(): void; + /** + * Selects the column that contains the insertion point, or selects all columns that contain the selection when the selection is in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + selectColumn(): void; + /** + * Extends the selection forward until text with a different paragraph alignment is encountered. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + selectCurrentAlignment(): void; + /** + * Extends the selection forward until text with a different color is encountered. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + selectCurrentColor(): void; + /** + * Extends the selection forward until text in a different font or font size is encountered. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + selectCurrentFont(): void; + /** + * Extends the selection forward until text with different left or right paragraph indents is encountered. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + selectCurrentIndent(): void; + /** + * Extends the selection forward until a paragraph with different line spacing is encountered. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + selectCurrentSpacing(): void; + /** + * Extends the selection forward until a paragraph with different tab stops is encountered. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + selectCurrentTabs(): void; + /** + * Selects the row that contains the insertion point, or selects all rows that contain the selection when the selection is in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + selectRow(): void; + /** + * Sets the starting and ending character positions for the selection. + Character position values start at the beginning of the story, with the first value being 0. All characters are counted, including nonprinting characters. Hidden characters are counted even if they're not displayed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param start - The starting character position of the current story. + * @param end - The ending character position of the current story. + */ + setRange(start: number, end: number): void; + /** + * Shrinks the selection to the next smaller unit of text. + The unit progression for this method is as follows: entire document, section, paragraph, sentence, word, insertion point. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shrink(): void; + /** + * Cancels the selection of all but the most recently selected text when the current selection contains multiple, unconnected selections. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shrinkDiscontiguousSelection(): void; + /** + * Inserts an empty paragraph above the first row in the selection. + If the selection isn't in the first row of the table, the table is split into two tables. If the selection isn't in a table, an error occurs. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + splitTable(): void; + /** + * Switches the selection between a Unicode character and its corresponding hexadecimal value. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + toggleCharacterCode(): void; + /** + * Deletes the character preceding the selection (if collapsed) or the insertion point. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + typeBackspace(): 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?: Word.Interfaces.SelectionLoadOptions): Word.Selection; + /** + * 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[]): Word.Selection; + /** + * 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; + }): Word.Selection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.Selection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.Selection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Selection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SelectionData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.SelectionData; + } + /** + * Represents a collection of {@link Word.Range} objects that represents each character, word or sentence. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class RangeScopedCollection 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: Word.Range[]; + /** + * Gets a `Range` object by its index in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index - The location of a `Range` object in the collection. + */ + getItem(index: number): Word.Range; + /** + * 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?: Word.Interfaces.RangeScopedCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.RangeScopedCollection; + /** + * 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[]): Word.RangeScopedCollection; + /** + * 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): Word.RangeScopedCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.RangeScopedCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.RangeScopedCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.RangeScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RangeScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.RangeScopedCollectionData; + } + /** + * Specifies the direction in which text flows from one text column to the next. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum FlowDirection { + /** + * Text flows from left to right. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + leftToRight = "LeftToRight", + /** + * Text flows from right to left. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + rightToLeft = "RightToLeft", + } + /** + * Specifies where the gutter appears in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum GutterPosition { + /** + * The gutter appears on the left side of the document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + left = "Left", + /** + * The gutter appears on the right side of the document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + right = "Right", + /** + * The gutter appears at the top of the document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + top = "Top", + } + /** + * Specifies whether the gutter style should conform to left-to-right text flow or right-to-left text flow. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum GutterStyle { + /** + * Gutter style for bidirectional text flow. This is mainly right to left. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bidirectional = "Bidirectional", + /** + * Gutter style for Latin text flow. This is mainly left to right. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + latin = "Latin", + } + /** + * Specifies how text is laid out in the layout mode for the current document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum LayoutMode { + /** + * Default layout mode. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + default = "Default", + /** + * Grid layout mode. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid = "Grid", + /** + * Line grid layout mode. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lineGrid = "LineGrid", + /** + * Genko layout mode. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + genko = "Genko", + } + /** + * Specifies the numbering rule to apply. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum NumberingRule { + /** + * Restart numbering continuously. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + restartContinuous = "RestartContinuous", + /** + * Restart numbering at the beginning of each section. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + restartSection = "RestartSection", + /** + * Restart numbering at the beginning of each page. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + restartPage = "RestartPage", + } + /** + * Specifies a page layout orientation. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PageOrientation { + /** + * Portrait orientation. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + portrait = "Portrait", + /** + * Landscape orientation. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + landscape = "Landscape", + } + /** + * Specifies the type of vertical alignment to apply. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PageSetupVerticalAlignment { + /** + * Align text to the top. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + top = "Top", + /** + * Align text to the center. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + center = "Center", + /** + * Justify text vertically. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + justify = "Justify", + /** + * Align text to the bottom. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bottom = "Bottom", + } + /** + * Specifies a paper size. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PaperSize { + /** + * 10x14 paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + size10x14 = "Size10x14", + /** + * 11x17 paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + size11x17 = "Size11x17", + /** + * Letter paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + letter = "Letter", + /** + * Small letter paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + letterSmall = "LetterSmall", + /** + * Legal paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + legal = "Legal", + /** + * Executive paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + executive = "Executive", + /** + * A3 paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + a3 = "A3", + /** + * A4 paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + a4 = "A4", + /** + * Small A4 paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + a4Small = "A4Small", + /** + * A5 paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + a5 = "A5", + /** + * B4 paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + b4 = "B4", + /** + * B5 paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + b5 = "B5", + /** + * C-sheet paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + csheet = "CSheet", + /** + * D-sheet paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + dsheet = "DSheet", + /** + * E-sheet paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + esheet = "ESheet", + /** + * Fanfold legal German paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fanfoldLegalGerman = "FanfoldLegalGerman", + /** + * Fanfold standard German paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fanfoldStdGerman = "FanfoldStdGerman", + /** + * Fanfold US paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fanfoldUS = "FanfoldUS", + /** + * Folio paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + folio = "Folio", + /** + * Ledger paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + ledger = "Ledger", + /** + * Note paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + note = "Note", + /** + * Quarto paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + quarto = "Quarto", + /** + * Statement paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + statement = "Statement", + /** + * Tabloid paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tabloid = "Tabloid", + /** + * Envelope size 9. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelope9 = "Envelope9", + /** + * Envelope size 10. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelope10 = "Envelope10", + /** + * Envelope size 11. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelope11 = "Envelope11", + /** + * Envelope size 12. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelope12 = "Envelope12", + /** + * Envelope size 14. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelope14 = "Envelope14", + /** + * Envelope B4 size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeB4 = "EnvelopeB4", + /** + * Envelope B5 size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeB5 = "EnvelopeB5", + /** + * Envelope B6 size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeB6 = "EnvelopeB6", + /** + * Envelope C3 size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeC3 = "EnvelopeC3", + /** + * Envelope C4 size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeC4 = "EnvelopeC4", + /** + * Envelope C5 size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeC5 = "EnvelopeC5", + /** + * Envelope C6 size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeC6 = "EnvelopeC6", + /** + * Envelope C65 size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeC65 = "EnvelopeC65", + /** + * Envelope DL size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeDL = "EnvelopeDL", + /** + * Envelope Italy size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeItaly = "EnvelopeItaly", + /** + * Envelope Monarch size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeMonarch = "EnvelopeMonarch", + /** + * Envelope Personal size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopePersonal = "EnvelopePersonal", + /** + * Custom paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + custom = "Custom", + } + /** + * Specifies how Word displays the reading order and alignment for the specified sections. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum SectionDirection { + /** + * Right-to-left reading order. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + rightToLeft = "RightToLeft", + /** + * Left-to-right reading order. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + leftToRight = "LeftToRight", + } + /** + * Specifies the type of section break for the specified item. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum SectionStart { + /** + * Continuous section break. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + continuous = "Continuous", + /** + * New column section break. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + newColumn = "NewColumn", + /** + * New page section break. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + newPage = "NewPage", + /** + * Even page section break. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + evenPage = "EvenPage", + /** + * Odd page section break. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + oddPage = "OddPage", + } + /** + * Specifies how a table is resized to fit its contents or the window. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum AutoFitBehavior { + /** + * Disables automatic resizing. The table retains its current size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fixedSize = "FixedSize", + /** + * Automatically resizes the table columns to fit the contents. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + content = "Content", + /** + * Automatically resizes the table to fit the window width. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + window = "Window", + } + /** + * Specifies the type of bidirectional calendar to use. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum CalendarTypeBidirectional { + /** + * Uses the Gregorian calendar. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + gregorian = "Gregorian", + /** + * Uses the Bidirectional calendar. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bidirectional = "Bidirectional", + } + /** + * Specifies the type of caption label to use. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum CaptionLabelType { + /** + * Specifies a figure caption label. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + figure = "Figure", + /** + * Specifies a table caption label. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + table = "Table", + /** + * Specifies an equation caption label. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + equation = "Equation", + } + /** + * Specifies the position of a caption relative to the object it describes. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum CaptionPosition { + /** + * Places the caption above the selected item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + above = "Above", + /** + * Places the caption below the selected item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + below = "Below", + } + /** + * Specifies the direction in which to collapse a selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum CollapseDirection { + /** + * Collapses the selection to the start position. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + start = "Start", + /** + * Collapses the selection to the end position. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + end = "End", + } + /** + * Specifies the language to use for date formatting. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum DateLanguage { + /** + * Uses the bidirectional date/time format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bidirectional = "Bidirectional", + /** + * Uses the latin date/time format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + latin = "Latin", + } + /** + * Specifies the default behavior when inserting a new table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum DefaultTableBehavior { + /** + * Disables AutoFit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + disableAutoFit = "DisableAutoFit", + /** + * Enables AutoFit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enableAutoFit = "EnableAutoFit", + } + /** + * Specifies the location of endnotes in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum EndnoteLocation { + /** + * Places endnotes at the end of the section. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + endOfSection = "EndOfSection", + /** + * Places endnotes at the end of the document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + endOfDocument = "EndOfDocument", + } + /** + * Specifies the font bias to use when formatting East Asian text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum FontBias { + /** + * Uses the default font bias. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + standard = "Standard", + /** + * Uses the font bias for Far East text. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + farEast = "FarEast", + /** + * No font bias specified. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + noSpecified = "NoSpecified", + } + /** + * Specifies the location of footnotes in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum FootnoteLocation { + /** + * Places footnotes at the bottom of the page. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bottomOfPage = "BottomOfPage", + /** + * Places footnotes below the text on the page. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + beneathText = "BeneathText", + } + /** + * Specifies the direction in which to move when using the {@link Word.Selection | Selection.goTo} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum GoToDirection { + /** + * Moves to the first item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + first = "First", + /** + * Moves to the last item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + last = "Last", + /** + * Moves to the next item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + next = "Next", + /** + * Moves to the previous item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + previous = "Previous", + } + /** + * Specifies the item or location to which to move or extend a {@link Word.Selection | selection}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum GoToItem { + /** + * Moves to a bookmark. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bookmark = "Bookmark", + /** + * Moves to a comment. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + comment = "Comment", + /** + * Moves to a endnote. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + endnote = "Endnote", + /** + * Moves to a field. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + field = "Field", + /** + * Moves to a footnote. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + footnote = "Footnote", + /** + * Moves to a graphic. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + graphic = "Graphic", + /** + * Moves to a heading. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + heading = "Heading", + /** + * Moves to a line. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + line = "Line", + /** + * Moves to a page. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + page = "Page", + /** + * Moves to a section. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + section = "Section", + /** + * Moves to a table. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + table = "Table", + /** + * Moves to an embedded object. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + embeddedObject = "EmbeddedObject", + /** + * Moves to an equation. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + equation = "Equation", + /** + * Moves to a percent. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + percent = "Percent", + /** + * Moves to a spelling error. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + spellingError = "SpellingError", + /** + * Moves to a grammatical error. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grammaticalError = "GrammaticalError", + /** + * Moves to a proofreading error. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + proofreadingError = "ProofreadingError", + } + /** + * Specifies the type of movement when navigating through a document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum MovementType { + /** + * Moves the insertion point or selection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + move = "Move", + /** + * Extends the selection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + extend = "Extend", + } + /** + * Specifies the numbering style to use for footnotes or endnotes. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum NoteNumberStyle { + /** + * Uses Arabic numerals (1, 2, 3...). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + arabic = "Arabic", + /** + * Uses uppercase Roman numerals (I, II, III...). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + uppercaseRoman = "UppercaseRoman", + /** + * Uses lowercase Roman numerals (i, ii, iii...). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lowercaseRoman = "LowercaseRoman", + /** + * Uses uppercase letters (A, B, C...). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + uppercaseLetter = "UppercaseLetter", + /** + * Uses lowercase letters (a, b, c...). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lowercaseLetter = "LowercaseLetter", + /** + * Uses a symbol instead of a number. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + symbol = "Symbol", + /** + * Uses full-width Arabic numerals. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + arabicFullWidth = "ArabicFullWidth", + /** + * Uses Kanji characters. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + kanji = "Kanji", + /** + * Uses Kanji digits. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + kanjiDigit = "KanjiDigit", + /** + * Uses traditional Kanji characters. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + kanjiTraditional = "KanjiTraditional", + /** + * Uses numbers enclosed in circles. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numberInCircle = "NumberInCircle", + /** + * Uses Hanja characters with phonetic reading. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hanjaRead = "HanjaRead", + /** + * Uses Hanja digits with phonetic reading. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hanjaReadDigit = "HanjaReadDigit", + /** + * Uses traditional Chinese numerals (style 1). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + traditionalChineseNumeral1 = "traditionalChineseNumeral1", + /** + * Uses traditional Chinese numerals (style 2). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + traditionalChineseNumeral2 = "traditionalChineseNumeral2", + /** + * Uses simplified Chinese numerals (style 1). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + simplifiedChineseNumeral1 = "simplifiedChineseNumeral1", + /** + * Uses simplified Chinese numerals (style 2). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + simplifiedChineseNumeral2 = "simplifiedChineseNumeral2", + /** + * Uses Hebrew letters (style 1). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hebrewLetter1 = "HebrewLetter1", + /** + * Uses Arabic letters (style 1). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + arabicLetter1 = "ArabicLetter1", + /** + * Uses Hebrew letters (style 2). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hebrewLetter2 = "HebrewLetter2", + /** + * Uses Arabic letters (style 2). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + arabicLetter2 = "ArabicLetter2", + /** + * Uses Hindi letters (style 1). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hindiLetter1 = "HindiLetter1", + /** + * Uses Hindi letters (style 2). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hindiLetter2 = "HindiLetter2", + /** + * Uses Hindi Arabic numerals. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hindiArabic = "HindiArabic", + /** + * Uses Hindi cardinal text. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hindiCardinalText = "HindiCardinalText", + /** + * Uses Thai letters. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + thaiLetter = "ThaiLetter", + /** + * Uses Thai Arabic numerals. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + thaiArabic = "ThaiArabic", + /** + * Uses Thai cardinal text. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + thaiCardinalText = "ThaiCardinalText", + /** + * Uses Vietnamese cardinal text. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + vietnameseCardinalText = "vietnameseCardinalText", + } + /** + * Specifies the unit of measurement used in Word operations. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum OperationUnit { + /** + * Specifies a character unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + character = "Character", + /** + * Specifies a word unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + word = "Word", + /** + * Specifies a sentence unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sentence = "Sentence", + /** + * Specifies a paragraph unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + paragraph = "Paragraph", + /** + * Specifies a line unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + line = "Line", + /** + * Specifies a story unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + story = "Story", + /** + * Specifies a screen unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + screen = "Screen", + /** + * Specifies a section unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + section = "Section", + /** + * Specifies a column unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + column = "Column", + /** + * Specifies a row unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + row = "Row", + /** + * Specifies a window unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + window = "Window", + /** + * Specifies a cell unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + cell = "Cell", + /** + * Specifies a character format unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + characterFormat = "CharacterFormat", + /** + * Specifies a paragraph format unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + paragraphFormat = "ParagraphFormat", + /** + * Specifies a table unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + table = "Table", + /** + * Specifies an item unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + item = "Item", + } + /** + * Specifies the format to use when pasting data. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PasteDataType { + /** + * Pastes the data as an OLE object. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + oleObject = "OleObject", + /** + * Pastes the data as rich text format (RTF). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + rtf = "Rtf", + /** + * Pastes the data as plain text. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + text = "Text", + /** + * Pastes the data as a metafile picture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + metafilePicture = "MetafilePicture", + /** + * Pastes the data as a bitmap. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bitmap = "Bitmap", + /** + * Pastes the data as a device-independent bitmap (DIB). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + deviceIndependentBitmap = "DeviceIndependentBitmap", + /** + * Pastes the data as a hyperlink. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hyperlink = "Hyperlink", + /** + * Pastes the data as a shape. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shape = "Shape", + /** + * Pastes the data as an enhanced metafile. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enhancedMetafile = "EnhancedMetafile", + /** + * Pastes the data as HTML. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + html = "Html", + } + /** + * Specifies the type of formatting when paste to a document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PasteFormatType { + /** + * Uses the default paste behavior. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + pasteDefault = "PasteDefault", + /** + * Pastes text into a single cell. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + singleCellText = "SingleCellText", + /** + * Pastes a table into a single cell. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + singleCellTable = "SingleCellTable", + /** + * Continues numbering from the previous list. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + listContinueNumbering = "ListContinueNumbering", + /** + * Restarts numbering for the new list. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + listRestartNumbering = "ListRestartNumbering", + /** + * Appends the pasted table to the existing table. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tableAppendTable = "TableAppendTable", + /** + * Inserts the pasted table as new rows. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tableInsertAsRows = "TableInsertAsRows", + /** + * Inserts the pasted table with its original formatting. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tableOriginalFormatting = "TableOriginalFormatting", + /** + * Pastes a chart as a picture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + chartPicture = "ChartPicture", + /** + * Pastes a chart as an editable chart. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + chart = "Chart", + /** + * Pastes a chart with a link to the source data. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + chartLinked = "ChartLinked", + /** + * Applies the original formatting of the pasted content. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + formatOriginalFormatting = "FormatOriginalFormatting", + /** + * Applies surrounding formatting with emphasis. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + formatSurroundingFormattingWithEmphasis = "FormatSurroundingFormattingWithEmphasis", + /** + * Pastes content as plain text. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + formatPlainText = "FormatPlainText", + /** + * Overwrites existing cells with the pasted table. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tableOverwriteCells = "TableOverwriteCells", + /** + * Combines the pasted list with an existing list. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + listCombineWithExistingList = "ListCombineWithExistingList", + /** + * Prevents merging the pasted list with an existing list. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + listDontMerge = "ListDontMerge", + /** + * Uses the destination styles for the pasted content. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + useDestinationStylesRecovery = "UseDestinationStylesRecovery", + } + /** + * Specifies the kind of reference to insert. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ReferenceKind { + /** + * Inserts the full text of the referenced item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + contentText = "ContentText", + /** + * Inserts the number of the referenced item with relative context. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numberRelativeContext = "NumberRelativeContext", + /** + * Inserts only the number of the referenced item without context. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numberNoContext = "NumberNoContext", + /** + * Inserts the number of the referenced item with full context. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numberFullContext = "NumberFullContext", + /** + * Inserts the entire caption of the referenced item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + entireCaption = "EntireCaption", + /** + * Inserts only the label and number of the referenced item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + onlyLabelAndNumber = "OnlyLabelAndNumber", + /** + * Inserts only the caption text of the referenced item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + onlyCaptionText = "OnlyCaptionText", + /** + * Inserts the footnote number of the referenced item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + footnoteNumber = "FootnoteNumber", + /** + * Inserts the endnote number of the referenced item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + endnoteNumber = "EndnoteNumber", + /** + * Inserts the page number of the referenced item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + pageNumber = "PageNumber", + /** + * Inserts the position of the referenced item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + position = "Position", + /** + * Inserts the formatted footnote number of the referenced item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + footnoteNumberFormatted = "FootnoteNumberFormatted", + /** + * Inserts the formatted endnote number of the referenced item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + endnoteNumberFormatted = "EndnoteNumberFormatted", + } + /** + * Specifies the type of reference to insert. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ReferenceType { + /** + * Refers to a numbered item in the document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numberedItem = "NumberedItem", + /** + * Refers to a heading in the document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + heading = "Heading", + /** + * Refers to a bookmark in the document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bookmark = "Bookmark", + /** + * Refers to a footnote in the document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + footnote = "Footnote", + /** + * Refers to an endnote in the document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + endnote = "Endnote", + } + /** + * Specifies the type of selection in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum SelectionType { + /** + * No selection is made. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + noSelection = "NoSelection", + /** + * Represents an insertion point (IP) selection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + insertionPoint = "InsertionPoint", + /** + * Represents a normal selection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + normal = "Normal", + /** + * Represents a frame selection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + frame = "Frame", + /** + * Represents a column selection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + column = "Column", + /** + * Represents a row selection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + row = "Row", + /** + * Represents a block selection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + block = "Block", + /** + * Represents an inline shape selection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + inlineShape = "InlineShape", + /** + * Represents a shape selection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + selectionShape = "SelectionShape", + } + /** + * Specifies the type of field to sort by. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum SortFieldType { + /** + * Sorts content alphanumerically. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + alphanumeric = "Alphanumeric", + /** + * Sorts content numerically. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numeric = "Numeric", + /** + * Sorts content by date. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + date = "Date", + /** + * Sorts content by syllables. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + syllable = "Syllable", + /** + * Sorts content using the Japanese JIS standard. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + japanJis = "JapanJis", + /** + * Sorts content by stroke count. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + stroke = "Stroke", + /** + * Sorts content using the Korean KS standard. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + koreaKs = "KoreaKs", + } + /** + * Specifies the sort order. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum SortOrder { + /** + * Sorts in ascending order. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + ascending = "Ascending", + /** + * Sorts in descending order. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + descending = "Descending", + } + /** + * Specifies where and what type of cells to add to an existing table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum TableCellInsertionLocation { + /** + * Inserts new cells to the left of the selected cells. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shiftRight = "ShiftRight", + /** + * Inserts new cells above the selected cells. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shiftDown = "ShiftDown", + /** + * Inserts an entire row above the row that contains the selection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shiftRowDown = "ShiftRowDown", + /** + * Inserts an entire column to the left of the column that contains the selection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shiftColumnRight = "ShiftColumnRight", + } + /** + * Specifies the predefined table formatting options. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum TableFormat { + /** + * No table format is applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + none = "None", + /** + * Applies the simple 1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + simple1 = "Simple1", + /** + * Applies the simple 2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + simple2 = "Simple2", + /** + * Applies the simple 3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + simple3 = "Simple3", + /** + * Applies the classic 1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + classic1 = "Classic1", + /** + * Applies the classic 2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + classic2 = "Classic2", + /** + * Applies the classic 3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + classic3 = "Classic3", + /** + * Applies the classic 4 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + classic4 = "Classic4", + /** + * Applies the colorful 1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + colorful1 = "Colorful1", + /** + * Applies the colorful 2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + colorful2 = "Colorful2", + /** + * Applies the colorful 3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + colorful3 = "Colorful3", + /** + * Applies the columns 1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + columns1 = "Columns1", + /** + * Applies the columns 2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + columns2 = "Columns2", + /** + * Applies the columns 3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + columns3 = "Columns3", + /** + * Applies the columns 4 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + columns4 = "Columns4", + /** + * Applies the columns 5 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + columns5 = "Columns5", + /** + * Applies the grid 1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid1 = "Grid1", + /** + * Applies the grid 2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid2 = "Grid2", + /** + * Applies the grid 3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid3 = "Grid3", + /** + * Applies the grid 4 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid4 = "Grid4", + /** + * Applies the grid 5 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid5 = "Grid5", + /** + * Applies the grid 6 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid6 = "Grid6", + /** + * Applies the grid 7 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid7 = "Grid7", + /** + * Applies the grid 8 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid8 = "Grid8", + /** + * Applies the list 1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list1 = "List1", + /** + * Applies the list 2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list2 = "List2", + /** + * Applies the list 3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list3 = "List3", + /** + * Applies the list 4 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list4 = "List4", + /** + * Applies the list 5 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list5 = "List5", + /** + * Applies the list 6 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list6 = "List6", + /** + * Applies the list 7 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list7 = "List7", + /** + * Applies the list 8 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list8 = "List8", + /** + * Applies the 3D effects 1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + threeDEffects1 = "ThreeDEffects1", + /** + * Applies the 3D effects 2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + threeDEffects2 = "ThreeDEffects2", + /** + * Applies the 3D effects 3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + threeDEffects3 = "ThreeDEffects3", + /** + * Applies the contemporary table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + contemporary = "Contemporary", + /** + * Applies the elegant table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + elegant = "Elegant", + /** + * Applies the professional table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + professional = "Professional", + /** + * Applies the subtle 1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + subtle1 = "Subtle1", + /** + * Applies the subtle 2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + subtle2 = "Subtle2", + /** + * Applies the web 1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + web1 = "Web1", + /** + * Applies the web 2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + web2 = "Web2", + /** + * Applies the web 3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + web3 = "Web3", + } + /** + * Specifies the orientation of text in a text frame or shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum TextOrientation { + /** + * Text is horizontal. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + horizontal = "Horizontal", + /** + * Text is vertical with letters rotated 90 degrees clockwise. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + upward = "Upward", + /** + * Text is vertical with letters rotated 90 degrees counterclockwise. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + downward = "Downward", + /** + * Text is vertical and reads downward from the top, right to left. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + verticalFarEast = "VerticalFarEast", + /** + * Text is horizontal but from right to left to accommodate right-to-left languages. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + horizontalRotatedFarEast = "HorizontalRotatedFarEast", + /** + * Text is vertical and reads downward from the top, left to right. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + vertical = "Vertical", + } + /** + * Represents a single bookmark in a document, selection, or range. The `Bookmark` object is a member of the `Bookmark` collection. + The {@link Word.BookmarkCollection} includes all the bookmarks listed in the **Bookmark** dialog box (**Insert** menu). + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class Bookmark 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 `Range` object that represents the portion of the document that's contained in the `Bookmark` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly range: Word.Range; + /** + * Specifies the ending character position of the bookmark. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + end: number; + /** + * Returns `true` if the bookmark is a table column. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly isColumn: boolean; + /** + * Returns `true` if the bookmark is empty. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly isEmpty: boolean; + /** + * Returns the name of the `Bookmark` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly name: string; + /** + * Specifies the starting character position of the bookmark. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + start: number; + /** + * Returns the story type for the bookmark. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly storyType: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.BookmarkUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Bookmark): void; + /** + * Copies this bookmark to the new bookmark specified in the `name` argument and returns a `Bookmark` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param name - The name of the new bookmark. + */ + copyTo(name: string): Word.Bookmark; + /** + * Deletes the bookmark. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + delete(): void; + /** + * Selects the bookmark. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + select(): 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?: Word.Interfaces.BookmarkLoadOptions): Word.Bookmark; + /** + * 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[]): Word.Bookmark; + /** + * 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; + }): Word.Bookmark; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.Bookmark; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.Bookmark; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Bookmark` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BookmarkData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.BookmarkData; + } + /** + * A collection of {@link Word.Bookmark} objects that represent the bookmarks in the specified selection, range, or document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class BookmarkCollection 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: Word.Bookmark[]; + /** + * Determines whether the specified bookmark exists. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param name - A bookmark name than cannot include more than 40 characters or more than one word. + * @returns `true` if the bookmark exists. + */ + exists(name: string): OfficeExtension.ClientResult; + /** + * Gets a `Bookmark` object by its index in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index - A number that identifies the index location of a `Bookmark` object. + */ + getItem(index: number): Word.Bookmark; + /** + * 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?: Word.Interfaces.BookmarkCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.BookmarkCollection; + /** + * 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[]): Word.BookmarkCollection; + /** + * 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): Word.BookmarkCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.BookmarkCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.BookmarkCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.BookmarkCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BookmarkCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.BookmarkCollectionData; + } + /** + * Specifies the type of story in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum StoryType { + /** + * Main text story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + mainText = "MainText", + /** + * Footnotes story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + footnotes = "Footnotes", + /** + * Endnotes story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + endnotes = "Endnotes", + /** + * Comments story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + comments = "Comments", + /** + * Text frame story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + textFrame = "TextFrame", + /** + * Even pages header story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + evenPagesHeader = "EvenPagesHeader", + /** + * Primary header story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + primaryHeader = "PrimaryHeader", + /** + * Even pages footer story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + evenPagesFooter = "EvenPagesFooter", + /** + * Primary footer story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + primaryFooter = "PrimaryFooter", + /** + * First page header story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + firstPageHeader = "FirstPageHeader", + /** + * First page footer story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + firstPageFooter = "FirstPageFooter", + /** + * Footnote separator story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + footnoteSeparator = "FootnoteSeparator", + /** + * Footnote continuation separator story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + footnoteContinuationSeparator = "FootnoteContinuationSeparator", + /** + * Footnote continuation notice story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + footnoteContinuationNotice = "FootnoteContinuationNotice", + /** + * Endnote separator story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + endnoteSeparator = "EndnoteSeparator", + /** + * Endnote continuation separator story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + endnoteContinuationSeparator = "EndnoteContinuationSeparator", + /** + * Endnote continuation notice story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + endnoteContinuationNotice = "EndnoteContinuationNotice", + } + /** + * Represents a single index. The `Index` object is a member of the {@link Word.IndexCollection}. The `IndexCollection` includes all the + indexes in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class Index 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 `Range` object that represents the portion of the document that is contained within the index. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly range: Word.Range; + /** + * Gets a value that represents how Microsoft Word classifies the first character of entries in the index. + See `IndexFilter` for available values. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly filter: Word.IndexFilter | "None" | "Aiueo" | "Akasatana" | "Chosung" | "Low" | "Medium" | "Full"; + /** + * Gets the text between alphabetical groups (entries that start with the same letter) in the index. Corresponds to + the **\h** switch for an {@link https://support.microsoft.com/office/adafcf4a-cb30-43f6-85c7-743da1635d9e | INDEX field}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly headingSeparator: Word.HeadingSeparator | "None" | "BlankLine" | "Letter" | "LetterLow" | "LetterFull"; + /** + * Gets a `LanguageId` value that represents the sorting language to use for the index. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly indexLanguage: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + /** + * Gets the number of columns for each page of the index. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly numberOfColumns: number; + /** + * Specifies if page numbers are aligned with the right margin in the index. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly rightAlignPageNumbers: boolean; + /** + * Gets if the index contains separate headings for accented letters (for example, words that begin with "À" are under + one heading and words that begin with "A" are under another). + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly separateAccentedLetterHeadings: boolean; + /** + * Specifies the sorting criteria for the index. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly sortBy: Word.IndexSortBy | "Stroke" | "Syllable"; + /** + * Specifies the leader character between entries in the index and their associated page numbers. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + /** + * Gets the index type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly type: Word.IndexType | "Indent" | "Runin"; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties - A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options - Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.IndexUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Index): void; + /** + * Deletes this index. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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?: Word.Interfaces.IndexLoadOptions): Word.Index; + /** + * 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[]): Word.Index; + /** + * 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; + }): Word.Index; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.Index; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.Index; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Index` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.IndexData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.IndexData; + } + /** + * A collection of {@link Word.Index} objects that represents all the indexes in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class IndexCollection 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: Word.Index[]; + /** + * Returns an `Index` object that represents a new index added to the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param range - The range where you want the index to appear. The index replaces the range, if the range is not collapsed. + * @param indexAddOptions - Optional. The options for adding the index. + */ + add(range: Word.Range, indexAddOptions?: Word.IndexAddOptions): Word.Index; + /** + * Gets the `IndexFormat` value that represents the formatting for the indexes in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + getFormat(): OfficeExtension.ClientResult; + /** + * Gets an `Index` object by its index in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index - A number that identifies the index location of an `Index` object. + */ + getItem(index: number): Word.Index; + /** + * Inserts an {@link https://support.microsoft.com/office/abaf7c78-6e21-418d-bf8b-f8186d2e4d08 | XE (Index Entry) field} after all instances of the text in the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param range - The range whose text is marked with an `XE` field throughout the document. + * @param markAllEntriesOptions - Optional. The options for marking all entries. + */ + markAllEntries(range: Word.Range, markAllEntriesOptions?: Word.IndexMarkAllEntriesOptions): 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?: Word.Interfaces.IndexCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.IndexCollection; + /** + * 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[]): Word.IndexCollection; + /** + * 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): Word.IndexCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.IndexCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.IndexCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.IndexCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.IndexCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.IndexCollectionData; + } + /** + * Represents options for creating an index in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface IndexAddOptions { + /** + * If provided, specifies the text between alphabetical groups (entries that start with the same letter) in the index. + See `HeadingSeparator` for available values. The default value is `Word.HeadingSeparator.blankLine`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + headingSeparator?: Word.HeadingSeparator | "None" | "BlankLine" | "Letter" | "LetterLow" | "LetterFull"; + /** + * If provided, specifies the sorting language to be used for the index being added. + See `LanguageId` for available values. The default value is the installed language of the Word application. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + indexLanguage?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + /** + * If provided, specifies the number of columns for each page of the index. + Specifying 0 (zero) sets the number of columns in the index to the same number as in the document. The default value is 1. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numberOfColumns?: number; + /** + * If provided, specifies whether the page numbers in the generated index are aligned with the right margin. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + rightAlignPageNumbers?: boolean; + /** + * If provided, specifies whether to include separate headings for accented letters in the index. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + separateAccentedLetterHeadings?: boolean; + /** + * If provided, specifies the sorting criteria to be used for the index being added. Can be either of the following `IndexSortBy` values: `stroke` or `syllable`. The default value is `Word.IndexSortBy.stroke`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sortBy?: Word.IndexSortBy | "Stroke" | "Syllable"; + /** + * If provided, specifies whether subentries are on the same line (run-in) as the main entry or on a separate line (indented) from the main entry. + Can be either of the following `IndexType` values: `indent` or `runin`. The default value is `Word.IndexType.indent`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type?: Word.IndexType | "Indent" | "Runin"; + } + /** + * Represents options for marking all index entries in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface IndexMarkAllEntriesOptions { + /** + * If provided, specifies whether to add bold formatting to page numbers for index entries. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bold?: boolean; + /** + * If provided, specifies the bookmark name that marks the range of pages you want to appear in the index. If this property is omitted, the number of the page that contains the `XE` field appears in the index. The default value is "". + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bookmarkName?: string; + /** + * If provided, specifies the cross-reference that will appear in the index. The default value is "". + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + crossReference?: string; + /** + * If provided, specifies the name of the `AutoText` entry that contains the text for a cross-reference (if this property is specified, `crossReference` is ignored). The default value is "". + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + crossReferenceAutoText?: string; + /** + * If provided, specifies the text you want to appear in the index, in the form `MainEntry[:Subentry]`. The default value is "". + Either this property or `entryAutoText` must be provided. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + entry?: string; + /** + * If provided, specifies the `AutoText` entry that contains the text you want to appear in the index (if this property is specified, `entry` is ignored). The default value is "". + Either this property or `entry` must be provided. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + entryAutoText?: string; + /** + * If provided, specifies whether to add italic formatting to page numbers for index entries. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + italic?: boolean; + } + /** + * Represents options for marking an index entry in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface IndexMarkEntryOptions { + /** + * If provided, specifies whether to add bold formatting to page numbers for index entries. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bold?: boolean; + /** + * If provided, specifies the bookmark name that marks the range of pages you want to appear in the index. If this property is omitted, the number of the page that contains the `XE` field appears in the index. The default value is "". + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bookmarkName?: string; + /** + * If provided, specifies the cross-reference that will appear in the index. The default value is "". + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + crossReference?: string; + /** + * If provided, specifies the name of the `AutoText` entry that contains the text for a cross-reference (if this property is specified, `crossReference` is ignored). The default value is "". + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + crossReferenceAutoText?: string; + /** + * If provided, specifies the text you want to appear in the index, in the form `MainEntry[:Subentry]`. The default value is "". + Either this property or `entryAutoText` must be provided. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + entry?: string; + /** + * If provided, specifies the `AutoText` entry that contains the text you want to appear in the index (if this property is specified, `entry` is ignored). The default value is "". + Either this property or `entry` must be provided. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + entryAutoText?: string; + /** + * If provided, specifies whether to add italic formatting to page numbers for index entries. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + italic?: boolean; + /** + * If provided, specifies whether to show an index entry in the right location when indexes are sorted phonetically (East Asian languages only). The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + reading?: boolean; + } + /** + * Specifies the type of separator to use for headings. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum HeadingSeparator { + /** + * No separator is used for headings. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + none = "None", + /** + * A blank line is used as a separator for headings. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + blankLine = "BlankLine", + /** + * A single letter is used as a separator for headings. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + letter = "Letter", + /** + * A lowercase letter is used as a separator for headings. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + letterLow = "LetterLow", + /** + * A full-width letter is used as a separator for headings. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + letterFull = "LetterFull", + } + /** + * Represents the position of a dropped capital letter. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum DropPosition { + /** + * Represents that there's no dropped capital letter. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + none = "None", + /** + * Represents a normal dropped capital letter. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + normal = "Normal", + /** + * Represents a dropped capital letter in the margin. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + margin = "Margin", + } + /** + * Represents the type of line spacing. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum LineSpacing { + /** + * Represents single line spacing. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + single = "Single", + /** + * Represents 1.5 line spacing. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + onePt5 = "OnePt5", + /** + * Represents double line spacing. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + double = "Double", + /** + * Represents at least line spacing. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + atLeast = "AtLeast", + /** + * Represents exact line spacing. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + exactly = "Exactly", + /** + * Represents multiple line spacing. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + multiple = "Multiple", + } + /** + * Represents the alignment of a tab stop. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum TabAlignment { + /** + * Represents that the tab stop is aligned to the left. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + left = "Left", + /** + * Represents that the tab stop is aligned to the center. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + center = "Center", + /** + * Represents that the tab stop is aligned to the right. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + right = "Right", + /** + * Represents that the tab stop is aligned to the decimal point. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + decimal = "Decimal", + /** + * Represents that the tab stop is aligned to the bar. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bar = "Bar", + /** + * Represents that the tab stop is aligned to the list. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list = "List", + } + /** + * Represents the type of tight wrap for a text box. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum TextboxTightWrap { + /** + * Represents that there's no tight wrap. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + none = "None", + /** + * Represents tight wrap around all lines. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + all = "All", + /** + * Represents tight wrap around the first and last lines. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + firstAndLastLines = "FirstAndLastLines", + /** + * Represents tight wrap around the first line only. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + firstLineOnly = "FirstLineOnly", + /** + * Represents tight wrap around the last line only. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lastLineOnly = "LastLineOnly", + } + /** + * Specifies the filter type for an index. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum IndexFilter { + /** + * No filter is applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + none = "None", + /** + * Aiueo filter is applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + aiueo = "Aiueo", + /** + * Akasatana filter is applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + akasatana = "Akasatana", + /** + * Chosung filter is applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + chosung = "Chosung", + /** + * Low filter is applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + low = "Low", + /** + * Medium filter is applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + medium = "Medium", + /** + * Full filter is applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + full = "Full", + } + /** + * Specifies the format for an index. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum IndexFormat { + /** + * Template format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + template = "Template", + /** + * Classic format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + classic = "Classic", + /** + * Fancy format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fancy = "Fancy", + /** + * Modern format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + modern = "Modern", + /** + * Bulleted format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bulleted = "Bulleted", + /** + * Formal format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + formal = "Formal", + /** + * Simple format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + simple = "Simple", + } + /** + * Specifies how an index is sorted. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum IndexSortBy { + /** + * Sort by stroke. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + stroke = "Stroke", + /** + * Sort by syllable. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + syllable = "Syllable", + } + /** + * Specifies the type of index to create. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum IndexType { + /** + * Creates an indented index. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + indent = "Indent", + /** + * Creates a run-in index. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + runin = "Runin", + } + /** + * Specifies the tab leader style. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum TabLeader { + /** + * Spaces are used as the tab leader. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + spaces = "Spaces", + /** + * Dots are used as the tab leader. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + dots = "Dots", + /** + * Dashes are used as the tab leader. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + dashes = "Dashes", + /** + * Lines are used as the tab leader. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lines = "Lines", + /** + * Heavy lines are used as the tab leader. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + heavy = "Heavy", + /** + * Middle dots are used as the tab leader. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + middleDot = "MiddleDot", + } + /** + * Specifies the area of a table to which to apply special style formatting. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ConditionCode { + /** + * Applies formatting to the first row in a table. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + firstRow = "FirstRow", + /** + * Applies formatting to the last row in a table. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lastRow = "LastRow", + /** + * Applies formatting to odd-numbered rows. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + oddRowBanding = "OddRowBanding", + /** + * Applies formatting to even-numbered rows. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + evenRowBanding = "EvenRowBanding", + /** + * Applies formatting to the first column in a table. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + firstColumn = "FirstColumn", + /** + * Applies formatting to the last column in a table. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lastColumn = "LastColumn", + /** + * Applies formatting to odd-numbered columns. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + oddColumnBanding = "OddColumnBanding", + /** + * Applies formatting to even-numbered columns. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + evenColumnBanding = "EvenColumnBanding", + /** + * Applies formatting to the last cell in the first row. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + topRightCell = "TopRightCell", + /** + * Applies formatting to the first cell in the first row. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + topLeftCell = "TopLeftCell", + /** + * Applies formatting to the last cell in the table. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bottomRightCell = "BottomRightCell", + /** + * Applies formatting to first cell in the last row of the table. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bottomLeftCell = "BottomLeftCell", + } + /** + * Specifies a range of cells to be deleted from a table in a delete cells action or the behavior of the remaining cells after the deletion has occurred. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum DeleteCells { + /** + * Shift remaining cells left in the row where the deletion occurred after a cell or range of cells has been deleted. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shiftLeft = "ShiftLeft", + /** + * Shift remaining cells up in the column where the deletion occurred after a cell or range of cells has been deleted. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shiftUp = "ShiftUp", + /** + * Delete the entire row of cells from the table. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + entireRow = "EntireRow", + /** + * Delete the entire column of cells from the table. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + entireColumn = "EntireColumn", + } + /** + * Specifies the rule for determining the height of the specified cells or rows. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum RowHeightRule { + /** + * The row height is adjusted to accommodate the tallest value in the row. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + auto = "Auto", + /** + * The row height is set to a minimum value. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + atLeast = "AtLeast", + /** + * The row height is set to an exact value. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + exactly = "Exactly", + } + /** + * Specifies the direction in which Microsoft Word orders cells in the specified table or row. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum TableDirection { + /** + * The table is arranged with the first column in the rightmost position. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + rightToLeft = "RightToLeft", + /** + * The table is arranged with the first column in the leftmost position. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + leftToRight = "LeftToRight", + } + /** + * Specifies the character used to separate fields in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum TableFieldSeparator { + /** + * Uses the paragraph marker. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + paragraph = "Paragraph", + /** + * Uses the tab. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tab = "Tab", + /** + * Uses the comma. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + comma = "Comma", + /** + * Uses the default list separator. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + defaultListSeparator = "DefaultListSeparator", + } + /** + * Specifies the table format to apply. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum TableFormatType { + /** + * Applies no formatting to the table. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + none = "None", + /** + * Applies the Simple1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + simple1 = "Simple1", + /** + * Applies the Simple2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + simple2 = "Simple2", + /** + * Applies the Simple3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + simple3 = "Simple3", + /** + * Applies the Classic1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + classic1 = "Classic1", + /** + * Applies the Classic2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + classic2 = "Classic2", + /** + * Applies the Classic3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + classic3 = "Classic3", + /** + * Applies the Classic4 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + classic4 = "Classic4", + /** + * Applies the Colorful1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + colorful1 = "Colorful1", + /** + * Applies the Colorful2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + colorful2 = "Colorful2", + /** + * Applies the Colorful3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + colorful3 = "Colorful3", + /** + * Applies the Columns1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + columns1 = "Columns1", + /** + * Applies the Columns2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + columns2 = "Columns2", + /** + * Applies the Columns3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + columns3 = "Columns3", + /** + * Applies the Columns4 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + columns4 = "Columns4", + /** + * Applies the Columns5 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + columns5 = "Columns5", + /** + * Applies the Grid1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid1 = "Grid1", + /** + * Applies the Grid2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid2 = "Grid2", + /** + * Applies the Grid3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid3 = "Grid3", + /** + * Applies the Grid4 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid4 = "Grid4", + /** + * Applies the Grid5 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid5 = "Grid5", + /** + * Applies the Grid6 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid6 = "Grid6", + /** + * Applies the Grid7 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid7 = "Grid7", + /** + * Applies the Grid8 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid8 = "Grid8", + /** + * Applies the List1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list1 = "List1", + /** + * Applies the List2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list2 = "List2", + /** + * Applies the List3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list3 = "List3", + /** + * Applies the List4 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list4 = "List4", + /** + * Applies the List5 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list5 = "List5", + /** + * Applies the List6 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list6 = "List6", + /** + * Applies the List7 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list7 = "List7", + /** + * Applies the List8 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list8 = "List8", + /** + * Applies the 3D Effects1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + threeDEffects1 = "ThreeDEffects1", + /** + * Applies the 3D Effects2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + threeDEffects2 = "ThreeDEffects2", + /** + * Applies the 3D Effects3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + threeDEffects3 = "ThreeDEffects3", + /** + * Applies the Contemporary table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + contemporary = "Contemporary", + /** + * Applies the Elegant table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + elegant = "Elegant", + /** + * Applies the Professional table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + professional = "Professional", + /** + * Applies the Subtle1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + subtle1 = "Subtle1", + /** + * Applies the Subtle2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + subtle2 = "Subtle2", + /** + * Applies the Web1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + web1 = "Web1", + /** + * Applies the Web2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + web2 = "Web2", + /** + * Applies the Web3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + web3 = "Web3", + } + /** + * Represents the options for the {@link Word.Table | Table.autoFormat} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface TableAutoFormatOptions { + /** + * If provided, specifies whether to apply borders of the specified format. The default value is `true`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + applyBorders?: boolean; + /** + * If provided, specifies whether to apply color of the specified format. The default value is `true`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + applyColor?: boolean; + /** + * If provided, specifies whether to apply first column formatting of the specified format. The default value is `true`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + applyFirstColumn?: boolean; + /** + * If provided, specifies whether to apply font of the specified format. The default value is `true`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + applyFont?: boolean; + /** + * If provided, specifies whether to apply heading row formatting of the specified format. The default value is `true`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + applyHeadingRows?: boolean; + /** + * If provided, specifies whether to apply last column formatting of the specified format. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + applyLastColumn?: boolean; + /** + * If provided, specifies whether to apply last row formatting of the specified format. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + applyLastRow?: boolean; + /** + * If provided, specifies whether to apply shading of the specified format. The default value is `true`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + applyShading?: boolean; + /** + * If provided, specifies whether to decrease the width of the table columns as much as possible without changing the way text wraps in the cells. The default value is `true`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + autoFit?: boolean; + /** + * If provided, specifies the format to apply. The default value is `simple1`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + format?: Word.TableFormatType | "None" | "Simple1" | "Simple2" | "Simple3" | "Classic1" | "Classic2" | "Classic3" | "Classic4" | "Colorful1" | "Colorful2" | "Colorful3" | "Columns1" | "Columns2" | "Columns3" | "Columns4" | "Columns5" | "Grid1" | "Grid2" | "Grid3" | "Grid4" | "Grid5" | "Grid6" | "Grid7" | "Grid8" | "List1" | "List2" | "List3" | "List4" | "List5" | "List6" | "List7" | "List8" | "ThreeDEffects1" | "ThreeDEffects2" | "ThreeDEffects3" | "Contemporary" | "Elegant" | "Professional" | "Subtle1" | "Subtle2" | "Web1" | "Web2" | "Web3"; + } + /** + * Represents the options for the {@link Word.TableCellCollection | TableCellCollection.split} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface TableCellCollectionSplitOptions { + /** + * If provided, specifies whether to merge the cells with one another before splitting them. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + mergeBeforeSplit?: boolean; + /** + * If provided, specifies the number of columns that the group of cells is to be split into. The default value is 1. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numColumns?: number; + /** + * If provided, specifies the number of rows that the group of cells is to be split into. The default value is 1. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numRows?: number; + } + /** + * Represents the options for the {@link Word.TableCell | TableCell.formula} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface TableCellFormulaOptions { + /** + * The mathematical formula you want the = (Formula) field to evaluate. Spreadsheet-type references to table cells are valid. For example, "=SUM(A4:C4)" specifies the first three values in the fourth row. For more information about the = (Formula) field, see {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | Field codes: = (Formula) field}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + formula?: string; + /** + * A format for the result of the {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | = (Formula) field}. For information about the types of formats you can apply, see the Numeric Picture (#) field switch. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numFormat?: string; + } + /** + * Represents the options for the {@link Word.Table | Table.convertToText}, {@link Word.TableRow | TableRow.convertToText}, and {@link Word.TableRowCollection | TableRowCollection.convertToText} methods. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface TableConvertToTextOptions { + /** + * If provided, specifies whether to convert the nested tables to text. This property is ignored if the `separator` property isn't set to `paragraph`. The default is `true`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nestedTables?: boolean; + /** + * If provided, specifies the character that delimits the converted columns (paragraph marks delimit the converted rows). The default is `tab`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + separator?: Word.TableFieldSeparator | "Paragraph" | "Tab" | "Comma" | "DefaultListSeparator"; + } + /** + * Represents the options for the {@link Word.Table | Table.sort} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface TableSortOptions { + /** + * If provided, specifies whether to use bidirectional sort. `true` means to sort based on right-to-left language rules. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bidirectionalSort?: boolean; + /** + * If provided, specifies whether sorting is case-sensitive. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + caseSensitive?: boolean; + /** + * If provided, specifies whether to exclude the header row from the sort operation. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + excludeHeader?: boolean; + /** + * If provided, specifies the first field to sort by. Microsoft Word sorts by `fieldNumber`, then by `fieldNumber2`, and finally by `fieldNumber3`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fieldNumber?: string; + /** + * If provided, specifies the second field to sort by. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fieldNumber2?: string; + /** + * If provided, specifies the third field to sort by. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fieldNumber3?: string; + /** + * If provided, specifies whether to ignore Arabic character alef lam when sorting right-to-left language text. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + ignoreArabicThe?: boolean; + /** + * If provided, specifies whether to ignore bidirectional control characters when sorting right-to-left language text. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + ignoreDiacritics?: boolean; + /** + * If provided, specifies whether to ignore Hebrew characters when sorting right-to-left language text. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + ignoreHebrew?: boolean; + /** + * If provided, specifies whether to ignore kashida when sorting right-to-left language text. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + ignoreKashida?: boolean; + /** + * If provided, specifies the sorting language. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + /** + * If provided, specifies the type of the first field to sort by. The default value is `alphanumeric`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sortFieldType?: Word.SortFieldType | "Alphanumeric" | "Numeric" | "Date" | "Syllable" | "JapanJis" | "Stroke" | "KoreaKs"; + /** + * If provided, specifies the type of the second field to sort by. The default value is `alphanumeric`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sortFieldType2?: Word.SortFieldType | "Alphanumeric" | "Numeric" | "Date" | "Syllable" | "JapanJis" | "Stroke" | "KoreaKs"; + /** + * If provided, specifies the type of the third field to sort by. The default value is `alphanumeric`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sortFieldType3?: Word.SortFieldType | "Alphanumeric" | "Numeric" | "Date" | "Syllable" | "JapanJis" | "Stroke" | "KoreaKs"; + /** + * If provided, specifies the sort order of the first field to sort by. The default value is `ascending`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sortOrder?: Word.SortOrder | "Ascending" | "Descending"; + /** + * If provided, specifies the sort order of the second field to sort by. The default value is `ascending`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sortOrder2?: Word.SortOrder | "Ascending" | "Descending"; + /** + * If provided, specifies the sort order of the third field to sort by. The default value is `ascending`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sortOrder3?: Word.SortOrder | "Ascending" | "Descending"; + } + /** + * Represents a list of the names of all the available fonts. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class FontNameCollection 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 number of items in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets the font name at the specified index. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index - The zero-based index of the font name to retrieve. + */ + getItemAt(index: number): OfficeExtension.ClientResult; + /** + * 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[]): Word.FontNameCollection; + /** + * 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; + }): Word.FontNameCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.FontNameCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.FontNameCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.FontNameCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FontNameCollectionData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): { + [key: string]: string; + }; + } + /** + * Contains a collection of {@link Word.ListTemplate} objects in a document, list template gallery, or document template. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class ListTemplateCollection 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: Word.ListTemplate[]; + /** + * Adds a new `ListTemplate` object. Note: This operation isn't allowed if the collection represents list templates from a {@link Word.ListTemplateGallery}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options - Optional. Options for adding a new list template. + */ + add(options?: Word.ListTemplateCollectionAddOptions): Word.ListTemplate; + /** + * Gets a `ListTemplate` object by its index in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index - A number that identifies the index location of a `ListTemplate` object. + */ + getItem(index: number): Word.ListTemplate; + /** + * 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?: Word.Interfaces.ListTemplateCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ListTemplateCollection; + /** + * 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[]): Word.ListTemplateCollection; + /** + * 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): Word.ListTemplateCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.ListTemplateCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.ListTemplateCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ListTemplateCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListTemplateCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.ListTemplateCollectionData; + } + /** + * Represents the options for the {@link Word.ListTemplateCollection | ListTemplateCollection.add} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface ListTemplateCollectionAddOptions { + /** + * If provided, specifies the name of the list template to be added. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + name?: string; + /** + * If provided, specifies whether to apply outline numbering to the new list template. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + outlineNumbered?: boolean; + } + /** + * Represents a gallery of list templates of the same {@link Word.ListTemplateGalleryType}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class ListTemplateGallery 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 `ListTemplateCollection` object that represents all the list templates for the specified list gallery. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly listTemplates: Word.ListTemplateCollection; + /** + * 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[]): Word.ListTemplateGallery; + /** + * 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; + }): Word.ListTemplateGallery; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.ListTemplateGallery; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.ListTemplateGallery; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ListTemplateGallery` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListTemplateGalleryData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.ListTemplateGalleryData; + } + /** + * Contains a collection of {@link Word.ListTemplateGallery} objects available through the three bullets-and-numbering buttons on the **Home** tab (see {@link https://support.microsoft.com/office/6c06ef65-27ad-4893-80c9-0b944cb81f5f | Define new bullets, numbers, and multilevel lists} for how to access in the Word UI). + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export class ListTemplateGalleryCollection 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: Word.ListTemplateGallery[]; + /** + * Gets a `ListTemplateGallery` object by its type in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param type - The type of list template gallery to retrieve. + */ + getByType(type: Word.ListTemplateGalleryType): Word.ListTemplateGallery; + /** + * Gets a `ListTemplateGallery` object by its type in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param type - The type of list template gallery to retrieve. + */ + getByType(type: "Bullets" | "Number" | "OutlineNumbered"): Word.ListTemplateGallery; + /** + * Gets a `ListTemplateGallery` object by its index in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index - A number that identifies the index location of a `ListTemplateGallery` object. + */ + getItem(index: number): Word.ListTemplateGallery; + /** + * 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[]): Word.ListTemplateGalleryCollection; + /** + * 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): Word.ListTemplateGalleryCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.ListTemplateGalleryCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.ListTemplateGalleryCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ListTemplateGalleryCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListTemplateGalleryCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.ListTemplateGalleryCollectionData; + } + /** + * Describes the types of list template galleries available. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ListTemplateGalleryType { + /** + * Represents the bullet list gallery. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bullets = "Bullets", + /** + * Represents the number list gallery. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + number = "Number", + /** + * Represents the outline number list gallery. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + outlineNumbered = "OutlineNumbered", + } + /** + * Represents the types of {@link Word.CoauthoringLock | coauthoring locks}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum CoauthoringLockType { + /** + * Reserved for future use. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + none = "None", + /** + * Represents that the lock is a reservation. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + reservation = "Reservation", + /** + * Represents that the lock is ephemeral. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + ephemeral = "Ephemeral", + /** + * Represents that the lock has changed. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + changed = "Changed", + } + /** + * Represents the classes of users who can edit authorized portions of a protected (read-only) document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum EditorType { + /** + * Represents the current user of the document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + current = "Current", + /** + * Represents the Editors group for documents that use Information Rights Management. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + editors = "Editors", + /** + * Represents all users who open a document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + everyone = "Everyone", + /** + * Represents the Owners group for documents that use Information Rights Management. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + owners = "Owners", + } + enum ErrorCodes { + accessDenied = "AccessDenied", + generalException = "GeneralException", + invalidArgument = "InvalidArgument", + itemNotFound = "ItemNotFound", + notAllowed = "NotAllowed", + notImplemented = "NotImplemented", + searchDialogIsOpen = "SearchDialogIsOpen", + searchStringInvalidOrTooLong = "SearchStringInvalidOrTooLong", + } + 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 `Editor` object, for use in `editor.set({ ... })`. */ + export interface EditorUpdateData { + /** + * Gets a `Range` object that represents the next range that the editor has permissions to modify. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nextRange?: Word.Interfaces.RangeUpdateData; + /** + * Gets a `Range` object that represents the portion of the document that's contained in the `Editor` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeUpdateData; + } + /** An interface for updating data on the `ConflictCollection` object, for use in `conflictCollection.set({ ... })`. */ + export interface ConflictCollectionUpdateData { + items?: Word.Interfaces.ConflictData[]; + } + /** An interface for updating data on the `Conflict` object, for use in `conflict.set({ ... })`. */ + export interface ConflictUpdateData { + /** + * Gets a `Range` object that represents the portion of the document that's contained in the `Conflict` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeUpdateData; + } + /** An interface for updating data on the `AnnotationCollection` object, for use in `annotationCollection.set({ ... })`. */ + export interface AnnotationCollectionUpdateData { + items?: Word.Interfaces.AnnotationData[]; + } + /** An interface for updating data on the `Application` object, for use in `application.set({ ... })`. */ + export interface ApplicationUpdateData { + /** + * Returns a `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bibliography?: Word.Interfaces.BibliographyUpdateData; + /** + * Specifies if Microsoft Word automatically detects the language you are using as you type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + checkLanguage?: boolean; + } + /** An interface for updating data on the `Body` object, for use in `body.set({ ... })`. */ + export interface BodyUpdateData { + /** + * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ + font?: Word.Interfaces.FontUpdateData; + /** + * Specifies the style name for the body. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * + * @remarks + * [Api set: WordApi 1.1] + */ + style?: string; + /** + * Specifies the built-in style name for the body. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + } + /** An interface for updating data on the `Border` object, for use in `border.set({ ... })`. */ + export interface BorderUpdateData { + /** + * Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + color?: string; + /** + * Specifies the border type for the border. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + type?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + /** + * Specifies whether the border is visible. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + visible?: boolean; + /** + * Specifies the width for the border. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + width?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed"; + } + /** An interface for updating data on the `BorderUniversal` object, for use in `borderUniversal.set({ ... })`. */ + export interface BorderUniversalUpdateData { + /** + * Specifies the graphical page-border design for the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + artStyle?: Word.PageBorderArt | "Apples" | "MapleMuffins" | "CakeSlice" | "CandyCorn" | "IceCreamCones" | "ChampagneBottle" | "PartyGlass" | "ChristmasTree" | "Trees" | "PalmsColor" | "Balloons3Colors" | "BalloonsHotAir" | "PartyFavor" | "ConfettiStreamers" | "Hearts" | "HeartBalloon" | "Stars3D" | "StarsShadowed" | "Stars" | "Sun" | "Earth2" | "Earth1" | "PeopleHats" | "Sombrero" | "Pencils" | "Packages" | "Clocks" | "Firecrackers" | "Rings" | "MapPins" | "Confetti" | "CreaturesButterfly" | "CreaturesLadyBug" | "CreaturesFish" | "BirdsFlight" | "ScaredCat" | "Bats" | "FlowersRoses" | "FlowersRedRose" | "Poinsettias" | "Holly" | "FlowersTiny" | "FlowersPansy" | "FlowersModern2" | "FlowersModern1" | "WhiteFlowers" | "Vine" | "FlowersDaisies" | "FlowersBlockPrint" | "DecoArchColor" | "Fans" | "Film" | "Lightning1" | "Compass" | "DoubleD" | "ClassicalWave" | "ShadowedSquares" | "TwistedLines1" | "Waveline" | "Quadrants" | "CheckedBarColor" | "Swirligig" | "PushPinNote1" | "PushPinNote2" | "Pumpkin1" | "EggsBlack" | "Cup" | "HeartGray" | "GingerbreadMan" | "BabyPacifier" | "BabyRattle" | "Cabins" | "HouseFunky" | "StarsBlack" | "Snowflakes" | "SnowflakeFancy" | "Skyrocket" | "Seattle" | "MusicNotes" | "PalmsBlack" | "MapleLeaf" | "PaperClips" | "ShorebirdTracks" | "People" | "PeopleWaving" | "EclipsingSquares2" | "Hypnotic" | "DiamondsGray" | "DecoArch" | "DecoBlocks" | "CirclesLines" | "Papyrus" | "Woodwork" | "WeavingBraid" | "WeavingRibbon" | "WeavingAngles" | "ArchedScallops" | "Safari" | "CelticKnotwork" | "CrazyMaze" | "EclipsingSquares1" | "Birds" | "FlowersTeacup" | "Northwest" | "Southwest" | "Tribal6" | "Tribal4" | "Tribal3" | "Tribal2" | "Tribal5" | "XIllusions" | "ZanyTriangles" | "Pyramids" | "PyramidsAbove" | "ConfettiGrays" | "ConfettiOutline" | "ConfettiWhite" | "Mosaic" | "Lightning2" | "HeebieJeebies" | "LightBulb" | "Gradient" | "TriangleParty" | "TwistedLines2" | "Moons" | "Ovals" | "DoubleDiamonds" | "ChainLink" | "Triangles" | "Tribal1" | "MarqueeToothed" | "SharksTeeth" | "Sawtooth" | "SawtoothGray" | "PostageStamp" | "WeavingStrips" | "ZigZag" | "CrossStitch" | "Gems" | "CirclesRectangles" | "CornerTriangles" | "CreaturesInsects" | "ZigZagStitch" | "Checkered" | "CheckedBarBlack" | "Marquee" | "BasicWhiteDots" | "BasicWideMidline" | "BasicWideOutline" | "BasicWideInline" | "BasicThinLines" | "BasicWhiteDashes" | "BasicWhiteSquares" | "BasicBlackSquares" | "BasicBlackDashes" | "BasicBlackDots" | "StarsTop" | "CertificateBanner" | "Handmade1" | "Handmade2" | "TornPaper" | "TornPaperBlack" | "CouponCutoutDashes" | "CouponCutoutDots"; + /** + * Specifies the width (in points) of the graphical page border specified in the `artStyle` property. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + artWidth?: number; + /** + * Specifies the color for the `BorderUniversal` object. You can provide the value in the '#RRGGBB' format. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + color?: string; + /** + * Specifies the color for the `BorderUniversal` or {@link Word.Font} object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + colorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + /** + * Specifies whether the border is visible. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isVisible?: boolean; + /** + * Specifies the line style of the border. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lineStyle?: Word.BorderLineStyle | "None" | "Single" | "Dot" | "DashSmallGap" | "DashLargeGap" | "DashDot" | "DashDotDot" | "Double" | "Triple" | "ThinThickSmallGap" | "ThickThinSmallGap" | "ThinThickThinSmallGap" | "ThinThickMedGap" | "ThickThinMedGap" | "ThinThickThinMedGap" | "ThinThickLargeGap" | "ThickThinLargeGap" | "ThinThickThinLargeGap" | "SingleWavy" | "DoubleWavy" | "DashDotStroked" | "Emboss3D" | "Engrave3D" | "Outset" | "Inset"; + /** + * Specifies the line width of an object's border. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lineWidth?: Word.LineWidth | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600"; + } + /** An interface for updating data on the `BorderCollection` object, for use in `borderCollection.set({ ... })`. */ + export interface BorderCollectionUpdateData { + /** + * Specifies the 24-bit color of the inside borders. Color is specified in ‘#RRGGBB’ format or by using the color name. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + insideBorderColor?: string; + /** + * Specifies the border type of the inside borders. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + insideBorderType?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + /** + * Specifies the width of the inside borders. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + insideBorderWidth?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed"; + /** + * Specifies the 24-bit color of the outside borders. Color is specified in ‘#RRGGBB’ format or by using the color name. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + outsideBorderColor?: string; + /** + * Specifies the border type of the outside borders. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + outsideBorderType?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + /** + * Specifies the width of the outside borders. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + outsideBorderWidth?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed"; + items?: Word.Interfaces.BorderData[]; + } + /** An interface for updating data on the `BorderUniversalCollection` object, for use in `borderUniversalCollection.set({ ... })`. */ + export interface BorderUniversalCollectionUpdateData { + items?: Word.Interfaces.BorderUniversalData[]; + } + /** An interface for updating data on the `Break` object, for use in `break.set({ ... })`. */ + export interface BreakUpdateData { + /** + * Returns a `Range` object that represents the portion of the document that's contained in the break. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeUpdateData; + } + /** An interface for updating data on the `BreakCollection` object, for use in `breakCollection.set({ ... })`. */ + export interface BreakCollectionUpdateData { + items?: Word.Interfaces.BreakData[]; + } + /** An interface for updating data on the `BuildingBlock` object, for use in `buildingBlock.set({ ... })`. */ + export interface BuildingBlockUpdateData { + /** + * Specifies the description for the building block. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + description?: string; + /** + * Specifies a `DocPartInsertType` value that represents how to insert the contents of the building block into the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + insertType?: Word.DocPartInsertType | "Content" | "Paragraph" | "Page"; + /** + * Specifies the name of the building block. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + name?: string; + /** + * Specifies the contents of the building block. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + value?: string; + } + /** An interface for updating data on the `CheckboxContentControl` object, for use in `checkboxContentControl.set({ ... })`. */ + export interface CheckboxContentControlUpdateData { + /** + * Specifies the current state of the checkbox. + * + * @remarks + * [Api set: WordApi 1.7] + */ + isChecked?: boolean; + } + /** An interface for updating data on the `CoauthoringLock` object, for use in `coauthoringLock.set({ ... })`. */ + export interface CoauthoringLockUpdateData { + /** + * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringLock` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeUpdateData; + } + /** An interface for updating data on the `CoauthoringLockCollection` object, for use in `coauthoringLockCollection.set({ ... })`. */ + export interface CoauthoringLockCollectionUpdateData { + items?: Word.Interfaces.CoauthoringLockData[]; + } + /** An interface for updating data on the `CoauthorCollection` object, for use in `coauthorCollection.set({ ... })`. */ + export interface CoauthorCollectionUpdateData { + items?: Word.Interfaces.CoauthorData[]; + } + /** An interface for updating data on the `CoauthoringUpdate` object, for use in `coauthoringUpdate.set({ ... })`. */ + export interface CoauthoringUpdateUpdateData { + /** + * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringUpdate` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeUpdateData; + } + /** An interface for updating data on the `CoauthoringUpdateCollection` object, for use in `coauthoringUpdateCollection.set({ ... })`. */ + export interface CoauthoringUpdateCollectionUpdateData { + items?: Word.Interfaces.CoauthoringUpdateData[]; + } + /** An interface for updating data on the `Comment` object, for use in `comment.set({ ... })`. */ + export interface CommentUpdateData { + /** + * Specifies the comment's content range. + * + * @remarks + * [Api set: WordApi 1.4] + */ + contentRange?: Word.Interfaces.CommentContentRangeUpdateData; + /** + * Specifies the comment's content as plain text. + * + * @remarks + * [Api set: WordApi 1.4] + */ + content?: string; + /** + * Specifies the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved. + * + * @remarks + * [Api set: WordApi 1.4] + */ + resolved?: boolean; + } + /** An interface for updating data on the `CommentCollection` object, for use in `commentCollection.set({ ... })`. */ + export interface CommentCollectionUpdateData { + items?: Word.Interfaces.CommentData[]; + } + /** An interface for updating data on the `CommentContentRange` object, for use in `commentContentRange.set({ ... })`. */ + export interface CommentContentRangeUpdateData { + /** + * Specifies a value that indicates whether the comment text is bold. + * + * @remarks + * [Api set: WordApi 1.4] + */ + bold?: boolean; + /** + * Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. + * + * @remarks + * [Api set: WordApi 1.4] + */ + hyperlink?: string; + /** + * Specifies a value that indicates whether the comment text is italicized. + * + * @remarks + * [Api set: WordApi 1.4] + */ + italic?: boolean; + /** + * Specifies a value that indicates whether the comment text has a strikethrough. + * + * @remarks + * [Api set: WordApi 1.4] + */ + strikeThrough?: boolean; + /** + * Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined. + * + * @remarks + * [Api set: WordApi 1.4] + */ + underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; + } + /** An interface for updating data on the `CommentReply` object, for use in `commentReply.set({ ... })`. */ + export interface CommentReplyUpdateData { + /** + * Specifies the commentReply's content range. + * + * @remarks + * [Api set: WordApi 1.4] + */ + contentRange?: Word.Interfaces.CommentContentRangeUpdateData; + /** + * Gets the parent comment of this reply. + * + * @remarks + * [Api set: WordApi 1.4] + */ + parentComment?: Word.Interfaces.CommentUpdateData; + /** + * Specifies the comment reply's content. The string is plain text. + * + * @remarks + * [Api set: WordApi 1.4] + */ + content?: string; + } + /** An interface for updating data on the `CommentReplyCollection` object, for use in `commentReplyCollection.set({ ... })`. */ + export interface CommentReplyCollectionUpdateData { + items?: Word.Interfaces.CommentReplyData[]; + } + /** An interface for updating data on the `ConditionalStyle` object, for use in `conditionalStyle.set({ ... })`. */ + export interface ConditionalStyleUpdateData { + /** + * Specifies the amount of space (in points) to add below the contents of a single cell or all the cells in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bottomPadding?: number; + /** + * Specifies the amount of space (in points) to add to the left of the contents of a single cell or all the cells in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + leftPadding?: number; + /** + * Specifies the amount of space (in points) to add to the right of the contents of a single cell or all the cells in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + rightPadding?: number; + /** + * Specifies the amount of space (in points) to add above the contents of a single cell or all the cells in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + topPadding?: number; + } + /** An interface for updating data on the `XmlMapping` object, for use in `xmlMapping.set({ ... })`. */ + export interface XmlMappingUpdateData { + /** + * Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + customXmlNode?: Word.Interfaces.CustomXmlNodeUpdateData; + /** + * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + customXmlPart?: Word.Interfaces.CustomXmlPartUpdateData; + } + /** An interface for updating data on the `CustomXmlPrefixMappingCollection` object, for use in `customXmlPrefixMappingCollection.set({ ... })`. */ + export interface CustomXmlPrefixMappingCollectionUpdateData { + items?: Word.Interfaces.CustomXmlPrefixMappingData[]; + } + /** An interface for updating data on the `CustomXmlSchemaCollection` object, for use in `customXmlSchemaCollection.set({ ... })`. */ + export interface CustomXmlSchemaCollectionUpdateData { + items?: Word.Interfaces.CustomXmlSchemaData[]; + } + /** An interface for updating data on the `CustomXmlValidationErrorCollection` object, for use in `customXmlValidationErrorCollection.set({ ... })`. */ + export interface CustomXmlValidationErrorCollectionUpdateData { + items?: Word.Interfaces.CustomXmlValidationErrorData[]; + } + /** An interface for updating data on the `CustomXmlValidationError` object, for use in `customXmlValidationError.set({ ... })`. */ + export interface CustomXmlValidationErrorUpdateData { + /** + * Gets the node associated with this `CustomXmlValidationError` object, if any exist.If no nodes exist, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + node?: Word.Interfaces.CustomXmlNodeUpdateData; + } + /** An interface for updating data on the `CustomXmlNodeCollection` object, for use in `customXmlNodeCollection.set({ ... })`. */ + export interface CustomXmlNodeCollectionUpdateData { + items?: Word.Interfaces.CustomXmlNodeData[]; + } + /** An interface for updating data on the `CustomXmlNode` object, for use in `customXmlNode.set({ ... })`. */ + export interface CustomXmlNodeUpdateData { + /** + * Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + firstChild?: Word.Interfaces.CustomXmlNodeUpdateData; + /** + * Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lastChild?: Word.Interfaces.CustomXmlNodeUpdateData; + /** + * Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nextSibling?: Word.Interfaces.CustomXmlNodeUpdateData; + /** + * Gets the object representing the part associated with this node. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + ownerPart?: Word.Interfaces.CustomXmlPartUpdateData; + /** + * Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + parentNode?: Word.Interfaces.CustomXmlNodeUpdateData; + /** + * Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + previousSibling?: Word.Interfaces.CustomXmlNodeUpdateData; + /** + * Specifies the value of the current node. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nodeValue?: string; + /** + * Specifies the text for the current node. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + text?: string; + } + /** An interface for updating data on the `ContentControl` object, for use in `contentControl.set({ ... })`. */ + export interface ContentControlUpdateData { + /** + * Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `BuildingBlockGallery`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlUpdateData; + /** + * Gets the data of the content control when its type is `CheckBox`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi 1.7] + */ + checkboxContentControl?: Word.Interfaces.CheckboxContentControlUpdateData; + /** + * Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `DatePicker`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + datePickerContentControl?: Word.Interfaces.DatePickerContentControlUpdateData; + /** + * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ + font?: Word.Interfaces.FontUpdateData; + /** + * Gets the group-related data if the content control's {@link Word.ContentControlType} is `Group`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + groupContentControl?: Word.Interfaces.GroupContentControlUpdateData; + /** + * Gets the picture-related data if the content control's {@link Word.ContentControlType} is `Picture`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + pictureContentControl?: Word.Interfaces.PictureContentControlUpdateData; + /** + * Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `RepeatingSection`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlUpdateData; + /** + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + xmlMapping?: Word.Interfaces.XmlMappingUpdateData; + /** + * Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. + * + * @remarks + * [Api set: WordApi 1.1] + */ + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + /** + * Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited. + * + * @remarks + * [Api set: WordApi 1.1] + */ + cannotDelete?: boolean; + /** + * Specifies a value that indicates whether the user can edit the contents of the content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ + cannotEdit?: boolean; + /** + * Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. + * + * @remarks + * [Api set: WordApi 1.1] + */ + color?: string; + /** + * Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. + * + * @remarks + * [Api set: WordApi 1.1] + */ + placeholderText?: string; + /** + * Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. + * + * @remarks + * [Api set: WordApi 1.1] + */ + removeWhenEdited?: boolean; + /** + * Specifies the style name for the content control. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * + * @remarks + * [Api set: WordApi 1.1] + */ + style?: string; + /** + * Specifies the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + /** + * Specifies a tag to identify a content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ + tag?: string; + /** + * Specifies the title for a content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ + title?: string; + } + /** An interface for updating data on the `ContentControlCollection` object, for use in `contentControlCollection.set({ ... })`. */ + export interface ContentControlCollectionUpdateData { + items?: Word.Interfaces.ContentControlData[]; + } + /** An interface for updating data on the `ContentControlListItem` object, for use in `contentControlListItem.set({ ... })`. */ + export interface ContentControlListItemUpdateData { + /** + * Specifies the display text of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + displayText?: string; + /** + * Specifies the index location of a content control list item in the collection of list items. + * + * @remarks + * [Api set: WordApi 1.9] + */ + index?: number; + /** + * Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + value?: string; + } + /** An interface for updating data on the `ContentControlListItemCollection` object, for use in `contentControlListItemCollection.set({ ... })`. */ + export interface ContentControlListItemCollectionUpdateData { + items?: Word.Interfaces.ContentControlListItemData[]; + } + /** An interface for updating data on the `CustomProperty` object, for use in `customProperty.set({ ... })`. */ + export interface CustomPropertyUpdateData { + /** + * Specifies the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). + * + * @remarks + * [Api set: WordApi 1.3] + */ + value?: any; + } + /** An interface for updating data on the `CustomPropertyCollection` object, for use in `customPropertyCollection.set({ ... })`. */ + export interface CustomPropertyCollectionUpdateData { + items?: Word.Interfaces.CustomPropertyData[]; + } + /** An interface for updating data on the `CustomXmlPart` object, for use in `customXmlPart.set({ ... })`. */ + export interface CustomXmlPartUpdateData { + /** + * Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + documentElement?: Word.Interfaces.CustomXmlNodeUpdateData; + } + /** An interface for updating data on the `CustomXmlPartCollection` object, for use in `customXmlPartCollection.set({ ... })`. */ + export interface CustomXmlPartCollectionUpdateData { + items?: Word.Interfaces.CustomXmlPartData[]; + } + /** An interface for updating data on the `CustomXmlPartScopedCollection` object, for use in `customXmlPartScopedCollection.set({ ... })`. */ + export interface CustomXmlPartScopedCollectionUpdateData { + items?: Word.Interfaces.CustomXmlPartData[]; + } + /** An interface for updating data on the `Document` object, for use in `document.set({ ... })`. */ + export interface DocumentUpdateData { + /** + * Gets the active window for the document. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + activeWindow?: Word.Interfaces.WindowUpdateData; + /** + * Returns a `Bibliography` object that represents the bibliography references contained within the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bibliography?: Word.Interfaces.BibliographyUpdateData; + /** + * Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * + * @remarks + * [Api set: WordApi 1.1] + */ + body?: Word.Interfaces.BodyUpdateData; + /** + * Returns a `PageSetup` object that's associated with the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + pageSetup?: Word.Interfaces.PageSetupUpdateData; + /** + * Gets the properties of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + properties?: Word.Interfaces.DocumentPropertiesUpdateData; + /** + * Specifies if automatic hyphenation is turned on for the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + autoHyphenation?: boolean; + /** + * Specifies if the edits in the document are automatically saved. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + autoSaveOn?: boolean; + /** + * Specifies the ChangeTracking mode. + * + * @remarks + * [Api set: WordApi 1.4] + */ + changeTrackingMode?: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly"; + /** + * Specifies the maximum number of consecutive lines that can end with hyphens. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + consecutiveHyphensLimit?: number; + /** + * Specifies whether words in all capital letters can be hyphenated. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hyphenateCaps?: boolean; + /** + * Specifies whether Microsoft Word has detected the language of the document text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + languageDetected?: boolean; + } + /** An interface for updating data on the `DocumentCreated` object, for use in `documentCreated.set({ ... })`. */ + export interface DocumentCreatedUpdateData { + /** + * Gets the body object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.3] + */ + body?: Word.Interfaces.BodyUpdateData; + /** + * Gets the properties of the document. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.3] + */ + properties?: Word.Interfaces.DocumentPropertiesUpdateData; + } + /** An interface for updating data on the `DocumentProperties` object, for use in `documentProperties.set({ ... })`. */ + export interface DocumentPropertiesUpdateData { + /** + * Specifies the author of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + author?: string; + /** + * Specifies the category of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + category?: string; + /** + * Specifies the Comments field in the metadata of the document. These have no connection to comments by users made in the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + comments?: string; + /** + * Specifies the company of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + company?: string; + /** + * Specifies the format of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + format?: string; + /** + * Specifies the keywords of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + keywords?: string; + /** + * Specifies the manager of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + manager?: string; + /** + * Specifies the subject of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + subject?: string; + /** + * Specifies the title of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + title?: string; + } + /** An interface for updating data on the `Field` object, for use in `field.set({ ... })`. */ + export interface FieldUpdateData { + /** + * Gets the field's result data. + * + * @remarks + * [Api set: WordApi 1.4] + */ + result?: Word.Interfaces.RangeUpdateData; + /** + * Specifies the field's code instruction. + * + * @remarks + * [Api set: WordApi 1.4] + * + * Note: The ability to set the code was introduced in WordApi 1.5. + */ + code?: string; + /** + * Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is `null` and it will throw a general exception when code attempts to set it. + * + * @remarks + * [Api set: WordApi 1.5] + */ + data?: string; + /** + * Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. + * + * @remarks + * [Api set: WordApi 1.5] + */ + locked?: boolean; + /** + * Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + showCodes?: boolean; + } + /** An interface for updating data on the `FieldCollection` object, for use in `fieldCollection.set({ ... })`. */ + export interface FieldCollectionUpdateData { + items?: Word.Interfaces.FieldData[]; + } + /** An interface for updating data on the `Font` object, for use in `font.set({ ... })`. */ + export interface FontUpdateData { + /** + * Returns a `FillFormat` object that contains fill formatting properties for the font used by the range of text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fill?: Word.Interfaces.FillFormatUpdateData; + /** + * Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + glow?: Word.Interfaces.GlowFormatUpdateData; + /** + * Returns a `LineFormat` object that specifies the formatting for a line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + line?: Word.Interfaces.LineFormatUpdateData; + /** + * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + reflection?: Word.Interfaces.ReflectionFormatUpdateData; + /** + * Returns a `ColorFormat` object that represents the color for the font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + textColor?: Word.Interfaces.ColorFormatUpdateData; + /** + * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + textShadow?: Word.Interfaces.ShadowFormatUpdateData; + /** + * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + threeDimensionalFormat?: Word.Interfaces.ThreeDimensionalFormatUpdateData; + /** + * Specifies whether the font is formatted as all capital letters, 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + allCaps?: boolean; + /** + * Specifies a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + bold?: boolean; + /** + * Specifies whether the font is formatted as bold in a right-to-left language document. 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + boldBidirectional?: boolean; + /** + * Specifies the color for the specified font. You can provide the value in the '#RRGGBB' format or the color name. + * + * @remarks + * [Api set: WordApi 1.1] + */ + color?: string; + /** + * Specifies a `ColorIndex` value that represents the color for the font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + colorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + /** + * Specifies the color for the `Font` object in a right-to-left language document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + colorIndexBidirectional?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + /** + * Specifies whether contextual alternates are enabled for the font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + contextualAlternates?: boolean; + /** + * Specifies the color to be used for diacritics for the `Font` object. You can provide the value in the '#RRGGBB' format. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + diacriticColor?: string; + /** + * Specifies whether Microsoft Word ignores the number of characters per line for the corresponding `Font` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + disableCharacterSpaceGrid?: boolean; + /** + * Specifies a value that indicates whether the font has a double strikethrough. True if the font is formatted as double strikethrough text, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + doubleStrikeThrough?: boolean; + /** + * Specifies whether the font is formatted as embossed. The possible values are as follows: + + - `true`: All the text is embossed. + + - `false`: None of the text is embossed. + + - `null`: Returned if some, but not all, of the text is embossed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + emboss?: boolean; + /** + * Specifies an `EmphasisMark` value that represents the emphasis mark for a character or designated character string. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + emphasisMark?: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle"; + /** + * Specifies whether the font is formatted as engraved. The possible values are as follows: + + - `true`: All the text is engraved. + + - `false`: None of the text is engraved. + + - `null`: Returned if some, but not all, of the text is engraved. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + engrave?: boolean; + /** + * Specifies a value that indicates whether the font is tagged as hidden. True if the font is formatted as hidden text, otherwise, false. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + hidden?: boolean; + /** + * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or `null` for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. + * + * @remarks + * [Api set: WordApi 1.1] + */ + highlightColor?: string; + /** + * Specifies a value that indicates whether the font is italicized. True if the font is italicized, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + italic?: boolean; + /** + * Specifies whether the font is italicized in a right-to-left language document. 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + italicBidirectional?: boolean; + /** + * Specifies the minimum font size for which Microsoft Word will adjust kerning automatically. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + kerning?: number; + /** + * Specifies the ligature setting for the `Font` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + ligature?: Word.Ligature | "None" | "Standard" | "Contextual" | "StandardContextual" | "Historical" | "StandardHistorical" | "ContextualHistorical" | "StandardContextualHistorical" | "Discretional" | "StandardDiscretional" | "ContextualDiscretional" | "StandardContextualDiscretional" | "HistoricalDiscretional" | "StandardHistoricalDiscretional" | "ContextualHistoricalDiscretional" | "All"; + /** + * Specifies a value that represents the name of the font. + * + * @remarks + * [Api set: WordApi 1.1] + */ + name?: string; + /** + * Specifies the font used for Latin text (characters with character codes from 0 (zero) through 127). + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nameAscii?: string; + /** + * Specifies the font name in a right-to-left language document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nameBidirectional?: string; + /** + * Specifies the East Asian font name. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nameFarEast?: string; + /** + * Specifies the font used for characters with codes from 128 through 255. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nameOther?: string; + /** + * Specifies the number form setting for an OpenType font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numberForm?: Word.NumberForm | "Default" | "Lining" | "OldStyle"; + /** + * Specifies the number spacing setting for the font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numberSpacing?: Word.NumberSpacing | "Default" | "Proportional" | "Tabular"; + /** + * Specifies if the font is formatted as outlined. The possible values are as follows: + + - `true`: All the text is outlined. + + - `false`: None of the text is outlined. + + - `null`: Returned if some, but not all, of the text is outlined. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + outline?: boolean; + /** + * Specifies the position of text (in points) relative to the base line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + position?: number; + /** + * Specifies the scaling percentage applied to the font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + scaling?: number; + /** + * Specifies if the font is formatted as shadowed. The possible values are as follows: + + - `true`: All the text is shadowed. + + - `false`: None of the text is shadowed. + + - `null`: Returned if some, but not all, of the text is shadowed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shadow?: boolean; + /** + * Specifies a value that represents the font size in points. + * + * @remarks + * [Api set: WordApi 1.1] + */ + size?: number; + /** + * Specifies the font size in points for right-to-left text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sizeBidirectional?: number; + /** + * Specifies whether the font is formatted as small caps, 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + smallCaps?: boolean; + /** + * Specifies the spacing between characters. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + spacing?: number; + /** + * Specifies a value that indicates whether the font has a strikethrough. True if the font is formatted as strikethrough text, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + strikeThrough?: boolean; + /** + * Specifies the stylistic set for the font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + stylisticSet?: Word.StylisticSet | "Default" | "Set01" | "Set02" | "Set03" | "Set04" | "Set05" | "Set06" | "Set07" | "Set08" | "Set09" | "Set10" | "Set11" | "Set12" | "Set13" | "Set14" | "Set15" | "Set16" | "Set17" | "Set18" | "Set19" | "Set20"; + /** + * Specifies a value that indicates whether the font is a subscript. True if the font is formatted as subscript, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + subscript?: boolean; + /** + * Specifies a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + superscript?: boolean; + /** + * Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined. + * + * @remarks + * [Api set: WordApi 1.1] + */ + underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; + /** + * Specifies the color of the underline for the `Font` object. You can provide the value in the '#RRGGBB' format. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + underlineColor?: string; + } + /** An interface for updating data on the `HeadingStyle` object, for use in `headingStyle.set({ ... })`. */ + export interface HeadingStyleUpdateData { + /** + * Specifies the level for the heading style in a table of contents or table of figures. Must be a value from 1 to 9. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + level?: number; + /** + * Specifies the name of style for a heading. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + name?: string; + } + /** An interface for updating data on the `HeadingStyleCollection` object, for use in `headingStyleCollection.set({ ... })`. */ + export interface HeadingStyleCollectionUpdateData { + items?: Word.Interfaces.HeadingStyleData[]; + } + /** An interface for updating data on the `Hyperlink` object, for use in `hyperlink.set({ ... })`. */ + export interface HyperlinkUpdateData { + /** + * Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeUpdateData; + /** + * Specifies the address (for example, a file name or URL) of the hyperlink. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + address?: string; + /** + * Specifies the text string for the hyperlink's subject line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + emailSubject?: string; + /** + * Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + screenTip?: string; + /** + * Specifies a named location in the destination of the hyperlink. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + subAddress?: string; + /** + * Specifies the name of the frame or window in which to load the hyperlink. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + target?: string; + /** + * Specifies the hyperlink's visible text in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + textToDisplay?: string; + } + /** An interface for updating data on the `HyperlinkCollection` object, for use in `hyperlinkCollection.set({ ... })`. */ + export interface HyperlinkCollectionUpdateData { + items?: Word.Interfaces.HyperlinkData[]; + } + /** An interface for updating data on the `InlinePicture` object, for use in `inlinePicture.set({ ... })`. */ + export interface InlinePictureUpdateData { + /** + * Specifies a string that represents the alternative text associated with the inline image. + * + * @remarks + * [Api set: WordApi 1.1] + */ + altTextDescription?: string; + /** + * Specifies a string that contains the title for the inline image. + * + * @remarks + * [Api set: WordApi 1.1] + */ + altTextTitle?: string; + /** + * Specifies a number that describes the height of the inline image. + * + * @remarks + * [Api set: WordApi 1.1] + */ + height?: number; + /** + * Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. + * + * @remarks + * [Api set: WordApi 1.1] + */ + hyperlink?: string; + /** + * Specifies a value that indicates whether the inline image retains its original proportions when you resize it. + * + * @remarks + * [Api set: WordApi 1.1] + */ + lockAspectRatio?: boolean; + /** + * Specifies a number that describes the width of the inline image. + * + * @remarks + * [Api set: WordApi 1.1] + */ + width?: number; + } + /** An interface for updating data on the `InlinePictureCollection` object, for use in `inlinePictureCollection.set({ ... })`. */ + export interface InlinePictureCollectionUpdateData { + items?: Word.Interfaces.InlinePictureData[]; + } + /** An interface for updating data on the `LinkFormat` object, for use in `linkFormat.set({ ... })`. */ + export interface LinkFormatUpdateData { + /** + * Specifies if the link is updated automatically when the container file is opened or when the source file is changed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isAutoUpdated?: boolean; + /** + * Specifies if a `Field`, `InlineShape`, or `Shape` object is locked to prevent automatic updating. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isLocked?: boolean; + /** + * Specifies if the linked picture is saved with the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isPictureSavedWithDocument?: boolean; + /** + * Specifies the path and name of the source file for the linked OLE object, picture, or field. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sourceFullName?: string; + } + /** An interface for updating data on the `ListCollection` object, for use in `listCollection.set({ ... })`. */ + export interface ListCollectionUpdateData { + items?: Word.Interfaces.ListData[]; + } + /** An interface for updating data on the `ListItem` object, for use in `listItem.set({ ... })`. */ + export interface ListItemUpdateData { + /** + * Specifies the level of the item in the list. + * + * @remarks + * [Api set: WordApi 1.3] + */ + level?: number; + } + /** An interface for updating data on the `ListLevel` object, for use in `listLevel.set({ ... })`. */ + export interface ListLevelUpdateData { + /** + * Gets a Font object that represents the character formatting of the specified object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + font?: Word.Interfaces.FontUpdateData; + /** + * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + /** + * Specifies the name of the style that's linked to the specified list level object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + linkedStyle?: string; + /** + * Specifies the number format for the specified list level. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + numberFormat?: string; + /** + * Specifies the position (in points) of the number or bullet for the specified list level object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + numberPosition?: number; + /** + * Specifies the number style for the list level object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + numberStyle?: Word.ListBuiltInNumberStyle | "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter" | "Ordinal" | "CardinalText" | "OrdinalText" | "Kanji" | "KanjiDigit" | "AiueoHalfWidth" | "IrohaHalfWidth" | "ArabicFullWidth" | "KanjiTraditional" | "KanjiTraditional2" | "NumberInCircle" | "Aiueo" | "Iroha" | "ArabicLZ" | "Bullet" | "Ganada" | "Chosung" | "GBNum1" | "GBNum2" | "GBNum3" | "GBNum4" | "Zodiac1" | "Zodiac2" | "Zodiac3" | "TradChinNum1" | "TradChinNum2" | "TradChinNum3" | "TradChinNum4" | "SimpChinNum1" | "SimpChinNum2" | "SimpChinNum3" | "SimpChinNum4" | "HanjaRead" | "HanjaReadDigit" | "Hangul" | "Hanja" | "Hebrew1" | "Arabic1" | "Hebrew2" | "Arabic2" | "HindiLetter1" | "HindiLetter2" | "HindiArabic" | "HindiCardinalText" | "ThaiLetter" | "ThaiArabic" | "ThaiCardinalText" | "VietCardinalText" | "LowercaseRussian" | "UppercaseRussian" | "LowercaseGreek" | "UppercaseGreek" | "ArabicLZ2" | "ArabicLZ3" | "ArabicLZ4" | "LowercaseTurkish" | "UppercaseTurkish" | "LowercaseBulgarian" | "UppercaseBulgarian" | "PictureBullet" | "Legal" | "LegalLZ"; + /** + * Specifies the list level that must appear before the specified list level restarts numbering at 1. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + resetOnHigher?: number; + /** + * Specifies the starting number for the specified list level object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + startAt?: number; + /** + * Specifies the tab position for the specified list level object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + tabPosition?: number; + /** + * Specifies the position (in points) for the second line of wrapping text for the specified list level object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + textPosition?: number; + /** + * Specifies the character inserted after the number for the specified list level. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + trailingCharacter?: Word.TrailingCharacter | "TrailingTab" | "TrailingSpace" | "TrailingNone"; + } + /** An interface for updating data on the `ListLevelCollection` object, for use in `listLevelCollection.set({ ... })`. */ + export interface ListLevelCollectionUpdateData { + items?: Word.Interfaces.ListLevelData[]; + } + /** An interface for updating data on the `ListTemplate` object, for use in `listTemplate.set({ ... })`. */ + export interface ListTemplateUpdateData { + /** + * Specifies the name of the list template. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + name?: string; + /** + * Specifies whether the list template is outline numbered. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + outlineNumbered?: boolean; + } + /** An interface for updating data on the `NoteItem` object, for use in `noteItem.set({ ... })`. */ + export interface NoteItemUpdateData { + /** + * Represents the body object of the note item. It's the portion of the text within the footnote or endnote. + * + * @remarks + * [Api set: WordApi 1.5] + */ + body?: Word.Interfaces.BodyUpdateData; + /** + * Represents a footnote or endnote reference in the main document. + * + * @remarks + * [Api set: WordApi 1.5] + */ + reference?: Word.Interfaces.RangeUpdateData; + } + /** An interface for updating data on the `NoteItemCollection` object, for use in `noteItemCollection.set({ ... })`. */ + export interface NoteItemCollectionUpdateData { + items?: Word.Interfaces.NoteItemData[]; + } + /** An interface for updating data on the `OleFormat` object, for use in `oleFormat.set({ ... })`. */ + export interface OleFormatUpdateData { + /** + * Specifies the class type for the specified OLE object, picture, or field. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + classType?: string; + /** + * Specifies the icon that is used when the `displayAsIcon` property is `true`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + iconIndex?: number; + /** + * Specifies the text displayed below the icon for the OLE object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + iconLabel?: string; + /** + * Specifies the program file in which the icon for the OLE object is stored. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + iconName?: string; + /** + * Specifies whether formatting done in Microsoft Word to the linked OLE object is preserved. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isFormattingPreservedOnUpdate?: boolean; + } + /** An interface for updating data on the `PageCollection` object, for use in `pageCollection.set({ ... })`. */ + export interface PageCollectionUpdateData { + items?: Word.Interfaces.PageData[]; + } + /** An interface for updating data on the `PaneCollection` object, for use in `paneCollection.set({ ... })`. */ + export interface PaneCollectionUpdateData { + items?: Word.Interfaces.PaneData[]; + } + /** An interface for updating data on the `Window` object, for use in `window.set({ ... })`. */ + export interface WindowUpdateData { + /** + * Gets the next document window in the collection of open document windows. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + next?: Word.Interfaces.WindowUpdateData; + /** + * Gets the previous document window in the collection open document windows. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + previous?: Word.Interfaces.WindowUpdateData; + /** + * Specifies whether rulers are displayed for the window or pane. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + areRulersDisplayed?: boolean; + /** + * Specifies whether thumbnail images of the pages in a document are displayed along the left side of the Microsoft Word document window. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + areThumbnailsDisplayed?: boolean; + /** + * Specifies the caption text for the window that is displayed in the title bar of the document or application window. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + caption?: string; + /** + * Specifies the horizontal scroll position as a percentage of the document width. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + horizontalPercentScrolled?: number; + /** + * Specifies the default start-up mode for the Japanese Input Method Editor (IME). + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + imeMode?: Word.ImeMode | "NoControl" | "On" | "Off" | "Hiragana" | "Katakana" | "KatakanaHalf" | "AlphaFull" | "Alpha" | "HangulFull" | "Hangul"; + /** + * Specifies whether the document map is visible. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isDocumentMapVisible?: boolean; + /** + * Specifies whether the email message header is visible in the document window. The default value is `False`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isEnvelopeVisible?: boolean; + /** + * Specifies whether a horizontal scroll bar is displayed for the window. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isHorizontalScrollBarDisplayed?: boolean; /** - * Specify the number of items in the queried collection to be included in the result. + * Specifies whether the vertical scroll bar appears on the left side of the document window. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $top?: number; + isLeftScrollBarDisplayed?: boolean; /** - * 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. + * Specifies whether the vertical ruler appears on the right side of the document window in print layout view. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $skip?: number; - } - /** An interface for updating data on the `AnnotationCollection` object, for use in `annotationCollection.set({ ... })`. */ - export interface AnnotationCollectionUpdateData { - items?: Word.Interfaces.AnnotationData[]; - } - /** An interface for updating data on the `Application` object, for use in `application.set({ ... })`. */ - export interface ApplicationUpdateData { + isRightRulerDisplayed?: boolean; /** - * Returns a `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word. + * Specifies whether the window is split into multiple panes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bibliography?: Word.Interfaces.BibliographyUpdateData; + isSplit?: boolean; /** - * Specifies if Microsoft Word automatically detects the language you are using as you type. + * Specifies whether a vertical ruler is displayed for the window or pane. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - checkLanguage?: boolean; + isVerticalRulerDisplayed?: boolean; + /** + * Specifies whether a vertical scroll bar is displayed for the window. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isVerticalScrollBarDisplayed?: boolean; + /** + * Specifies whether the window is visible. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isVisible?: boolean; + /** + * Specifies how Microsoft Word displays source documents after a compare and merge process. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + showSourceDocuments?: Word.ShowSourceDocuments | "None" | "Original" | "Revised" | "Both"; + /** + * Specifies the vertical split percentage for the window. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + splitVertical?: number; + /** + * Specifies the width of the style area in points. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + styleAreaWidth?: number; + /** + * Specifies the vertical scroll position as a percentage of the document length. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + verticalPercentScrolled?: number; + /** + * Specifies the state of the document window or task window. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + windowState?: Word.WindowState | "Normal" | "Maximize" | "Minimize"; } - /** An interface for updating data on the `Body` object, for use in `body.set({ ... })`. */ - export interface BodyUpdateData { + /** An interface for updating data on the `WindowCollection` object, for use in `windowCollection.set({ ... })`. */ + export interface WindowCollectionUpdateData { + items?: Word.Interfaces.WindowData[]; + } + /** An interface for updating data on the `Paragraph` object, for use in `paragraph.set({ ... })`. */ + export interface ParagraphUpdateData { /** - * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. + * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. * * @remarks * [Api set: WordApi 1.1] */ font?: Word.Interfaces.FontUpdateData; /** - * Specifies the style name for the body. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. + * + * @remarks + * [Api set: WordApi 1.3] + */ + listItem?: Word.Interfaces.ListItemUpdateData; + /** + * Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return 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: WordApi 1.3] + */ + listItemOrNullObject?: Word.Interfaces.ListItemUpdateData; + /** + * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shading?: Word.Interfaces.ShadingUniversalUpdateData; + /** + * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. + * + * @remarks + * [Api set: WordApi 1.1] + */ + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + /** + * Specifies the value, in points, for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. + * + * @remarks + * [Api set: WordApi 1.1] + */ + firstLineIndent?: number; + /** + * Specifies the left indent value, in points, for the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + leftIndent?: number; + /** + * Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. + * + * @remarks + * [Api set: WordApi 1.1] + */ + lineSpacing?: number; + /** + * Specifies the amount of spacing, in grid lines, after the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + lineUnitAfter?: number; + /** + * Specifies the amount of spacing, in grid lines, before the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + lineUnitBefore?: number; + /** + * Specifies the outline level for the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + outlineLevel?: number; + /** + * Specifies the right indent value, in points, for the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + rightIndent?: number; + /** + * Specifies the spacing, in points, after the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + spaceAfter?: number; + /** + * Specifies the spacing, in points, before the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + spaceBefore?: number; + /** + * Specifies the style name for the paragraph. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. * * @remarks * [Api set: WordApi 1.1] */ style?: string; /** - * Specifies the built-in style name for the body. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Specifies the built-in style name for the paragraph. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks * [Api set: WordApi 1.3] */ styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; } - /** An interface for updating data on the `Border` object, for use in `border.set({ ... })`. */ - export interface BorderUpdateData { + /** An interface for updating data on the `ParagraphCollection` object, for use in `paragraphCollection.set({ ... })`. */ + export interface ParagraphCollectionUpdateData { + items?: Word.Interfaces.ParagraphData[]; + } + /** An interface for updating data on the `ParagraphFormat` object, for use in `paragraphFormat.set({ ... })`. */ + export interface ParagraphFormatUpdateData { /** - * Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name. + * Specifies the alignment for the specified paragraphs. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - color?: string; + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies the border type for the border. + * Specifies the value (in points) for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - type?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + firstLineIndent?: number; /** - * Specifies whether the border is visible. + * Specifies whether all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - visible?: boolean; + keepTogether?: boolean; /** - * Specifies the width for the border. + * Specifies whether the specified paragraph remains on the same page as the paragraph that follows it when Microsoft Word repaginates the document. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - width?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed"; + keepWithNext?: boolean; + /** + * Specifies the left indent. + * + * @remarks + * [Api set: WordApi 1.5] + */ + leftIndent?: number; + /** + * Specifies the line spacing (in points) for the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + lineSpacing?: number; + /** + * Specifies the amount of spacing (in gridlines) after the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + lineUnitAfter?: number; + /** + * Specifies the amount of spacing (in gridlines) before the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + lineUnitBefore?: number; + /** + * Specifies whether left and right indents are the same width. + * + * @remarks + * [Api set: WordApi 1.5] + */ + mirrorIndents?: boolean; + /** + * Specifies the outline level for the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + outlineLevel?: Word.OutlineLevel | "OutlineLevel1" | "OutlineLevel2" | "OutlineLevel3" | "OutlineLevel4" | "OutlineLevel5" | "OutlineLevel6" | "OutlineLevel7" | "OutlineLevel8" | "OutlineLevel9" | "OutlineLevelBodyText"; + /** + * Specifies the right indent (in points) for the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + rightIndent?: number; + /** + * Specifies the amount of spacing (in points) after the specified paragraph or text column. + * + * @remarks + * [Api set: WordApi 1.5] + */ + spaceAfter?: number; + /** + * Specifies the spacing (in points) before the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + spaceBefore?: number; + /** + * Specifies whether the first and last lines in the specified paragraph remain on the same page as the rest of the paragraph when Microsoft Word repaginates the document. + * + * @remarks + * [Api set: WordApi 1.5] + */ + widowControl?: boolean; } - /** An interface for updating data on the `BorderUniversal` object, for use in `borderUniversal.set({ ... })`. */ - export interface BorderUniversalUpdateData { + /** An interface for updating data on the `Range` object, for use in `range.set({ ... })`. */ + export interface RangeUpdateData { /** - * Specifies the graphical page-border design for the document. + * Gets the text format of the range. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ + font?: Word.Interfaces.FontUpdateData; + /** + * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - artStyle?: Word.PageBorderArt | "Apples" | "MapleMuffins" | "CakeSlice" | "CandyCorn" | "IceCreamCones" | "ChampagneBottle" | "PartyGlass" | "ChristmasTree" | "Trees" | "PalmsColor" | "Balloons3Colors" | "BalloonsHotAir" | "PartyFavor" | "ConfettiStreamers" | "Hearts" | "HeartBalloon" | "Stars3D" | "StarsShadowed" | "Stars" | "Sun" | "Earth2" | "Earth1" | "PeopleHats" | "Sombrero" | "Pencils" | "Packages" | "Clocks" | "Firecrackers" | "Rings" | "MapPins" | "Confetti" | "CreaturesButterfly" | "CreaturesLadyBug" | "CreaturesFish" | "BirdsFlight" | "ScaredCat" | "Bats" | "FlowersRoses" | "FlowersRedRose" | "Poinsettias" | "Holly" | "FlowersTiny" | "FlowersPansy" | "FlowersModern2" | "FlowersModern1" | "WhiteFlowers" | "Vine" | "FlowersDaisies" | "FlowersBlockPrint" | "DecoArchColor" | "Fans" | "Film" | "Lightning1" | "Compass" | "DoubleD" | "ClassicalWave" | "ShadowedSquares" | "TwistedLines1" | "Waveline" | "Quadrants" | "CheckedBarColor" | "Swirligig" | "PushPinNote1" | "PushPinNote2" | "Pumpkin1" | "EggsBlack" | "Cup" | "HeartGray" | "GingerbreadMan" | "BabyPacifier" | "BabyRattle" | "Cabins" | "HouseFunky" | "StarsBlack" | "Snowflakes" | "SnowflakeFancy" | "Skyrocket" | "Seattle" | "MusicNotes" | "PalmsBlack" | "MapleLeaf" | "PaperClips" | "ShorebirdTracks" | "People" | "PeopleWaving" | "EclipsingSquares2" | "Hypnotic" | "DiamondsGray" | "DecoArch" | "DecoBlocks" | "CirclesLines" | "Papyrus" | "Woodwork" | "WeavingBraid" | "WeavingRibbon" | "WeavingAngles" | "ArchedScallops" | "Safari" | "CelticKnotwork" | "CrazyMaze" | "EclipsingSquares1" | "Birds" | "FlowersTeacup" | "Northwest" | "Southwest" | "Tribal6" | "Tribal4" | "Tribal3" | "Tribal2" | "Tribal5" | "XIllusions" | "ZanyTriangles" | "Pyramids" | "PyramidsAbove" | "ConfettiGrays" | "ConfettiOutline" | "ConfettiWhite" | "Mosaic" | "Lightning2" | "HeebieJeebies" | "LightBulb" | "Gradient" | "TriangleParty" | "TwistedLines2" | "Moons" | "Ovals" | "DoubleDiamonds" | "ChainLink" | "Triangles" | "Tribal1" | "MarqueeToothed" | "SharksTeeth" | "Sawtooth" | "SawtoothGray" | "PostageStamp" | "WeavingStrips" | "ZigZag" | "CrossStitch" | "Gems" | "CirclesRectangles" | "CornerTriangles" | "CreaturesInsects" | "ZigZagStitch" | "Checkered" | "CheckedBarBlack" | "Marquee" | "BasicWhiteDots" | "BasicWideMidline" | "BasicWideOutline" | "BasicWideInline" | "BasicThinLines" | "BasicWhiteDashes" | "BasicWhiteSquares" | "BasicBlackSquares" | "BasicBlackDashes" | "BasicBlackDots" | "StarsTop" | "CertificateBanner" | "Handmade1" | "Handmade2" | "TornPaper" | "TornPaperBlack" | "CouponCutoutDashes" | "CouponCutoutDots"; + listFormat?: Word.Interfaces.ListFormatUpdateData; /** - * Specifies the width (in points) of the graphical page border specified in the `artStyle` property. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - artWidth?: number; + shading?: Word.Interfaces.ShadingUniversalUpdateData; /** - * Specifies the color for the `BorderUniversal` object. You can provide the value in the '#RRGGBB' format. + * Specifies a `CharacterCase` value that represents the case of the text in the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + case?: Word.CharacterCase | "Next" | "Lower" | "Upper" | "TitleWord" | "TitleSentence" | "Toggle" | "HalfWidth" | "FullWidth" | "Katakana" | "Hiragana"; /** - * Specifies the color for the `BorderUniversal` or {@link Word.Font} object. + * Specifies the character width of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - colorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + characterWidth?: Word.CharacterWidth | "Half" | "Full"; /** - * Specifies whether the border is visible. + * Specifies if the range contains combined characters. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + combineCharacters?: boolean; /** - * Specifies the line style of the border. + * Specifies the ending character position of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lineStyle?: Word.BorderLineStyle | "None" | "Single" | "Dot" | "DashSmallGap" | "DashLargeGap" | "DashDot" | "DashDotDot" | "Double" | "Triple" | "ThinThickSmallGap" | "ThickThinSmallGap" | "ThinThickThinSmallGap" | "ThinThickMedGap" | "ThickThinMedGap" | "ThinThickThinMedGap" | "ThinThickLargeGap" | "ThickThinLargeGap" | "ThinThickThinLargeGap" | "SingleWavy" | "DoubleWavy" | "DashDotStroked" | "Emboss3D" | "Engrave3D" | "Outset" | "Inset"; + end?: number; /** - * Specifies the line width of an object's border. + * Specifies the width (in the current measurement units) in which Microsoft Word fits the text in the current selection or range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lineWidth?: Word.LineWidth | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600"; - } - /** An interface for updating data on the `BorderCollection` object, for use in `borderCollection.set({ ... })`. */ - export interface BorderCollectionUpdateData { + fitTextWidth?: number; /** - * Specifies the 24-bit color of the inside borders. Color is specified in ‘#RRGGBB’ format or by using the color name. + * Specifies if a grammar check has been run on the range or document. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - insideBorderColor?: string; + grammarChecked?: boolean; /** - * Specifies the border type of the inside borders. + * Specifies the proofing status (spelling and grammar checking) of the range. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - insideBorderType?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + hasNoProofing?: boolean; /** - * Specifies the width of the inside borders. + * Specifies the formatting for horizontal text set within vertical text. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - insideBorderWidth?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed"; + horizontalInVertical?: Word.HorizontalInVerticalType | "None" | "FitInLine" | "ResizeLine"; /** - * Specifies the 24-bit color of the outside borders. Color is specified in ‘#RRGGBB’ format or by using the color name. + * Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. Use a '#' to separate the address part from the optional location part. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - outsideBorderColor?: string; + hyperlink?: string; /** - * Specifies the border type of the outside borders. + * Specifies the ID for the range. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - outsideBorderType?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + id?: string; /** - * Specifies the width of the outside borders. + * Specifies whether the range of Japanese language text is hiragana or katakana. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - outsideBorderWidth?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed"; - items?: Word.Interfaces.BorderData[]; - } - /** An interface for updating data on the `BorderUniversalCollection` object, for use in `borderUniversalCollection.set({ ... })`. */ - export interface BorderUniversalCollectionUpdateData { - items?: Word.Interfaces.BorderUniversalData[]; - } - /** An interface for updating data on the `Break` object, for use in `break.set({ ... })`. */ - export interface BreakUpdateData { + kana?: Word.Kana | "Katakana" | "Hiragana"; /** - * Returns a `Range` object that represents the portion of the document that's contained in the break. + * Specifies whether Microsoft Word has detected the language of the text in the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeUpdateData; - } - /** An interface for updating data on the `BreakCollection` object, for use in `breakCollection.set({ ... })`. */ - export interface BreakCollectionUpdateData { - items?: Word.Interfaces.BreakData[]; - } - /** An interface for updating data on the `BuildingBlock` object, for use in `buildingBlock.set({ ... })`. */ - export interface BuildingBlockUpdateData { + languageDetected?: boolean; /** - * Specifies the description for the building block. + * Specifies a `LanguageId` value that represents the language for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - description?: string; + languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies a `DocPartInsertType` value that represents how to insert the contents of the building block into the document. + * Specifies an East Asian language for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - insertType?: Word.DocPartInsertType | "Content" | "Paragraph" | "Page"; + languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies the name of the building block. + * Specifies a language for the range that isn't classified as an East Asian language. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: string; + languageIdOther?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies the contents of the building block. + * Specifies if all nonprinting characters (such as hidden text, tab marks, space marks, and paragraph marks) are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - value?: string; - } - /** An interface for updating data on the `CheckboxContentControl` object, for use in `checkboxContentControl.set({ ... })`. */ - export interface CheckboxContentControlUpdateData { + showAll?: boolean; /** - * Specifies the current state of the checkbox. + * Specifies if spelling has been checked throughout the range or document. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isChecked?: boolean; - } - /** An interface for updating data on the `Comment` object, for use in `comment.set({ ... })`. */ - export interface CommentUpdateData { + spellingChecked?: boolean; /** - * Specifies the comment's content range. + * Specifies the starting character position of the range. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - contentRange?: Word.Interfaces.CommentContentRangeUpdateData; + start?: number; /** - * Specifies the comment's content as plain text. + * Specifies the style name for the range. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - content?: string; + style?: string; /** - * Specifies the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved. + * Specifies the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - resolved?: boolean; + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + /** + * Specifies whether Microsoft Word sets two lines of text in one and specifies the characters that enclose the text, if any. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + twoLinesInOne?: Word.TwoLinesInOneType | "None" | "NoBrackets" | "Parentheses" | "SquareBrackets" | "AngleBrackets" | "CurlyBrackets"; } - /** An interface for updating data on the `CommentCollection` object, for use in `commentCollection.set({ ... })`. */ - export interface CommentCollectionUpdateData { - items?: Word.Interfaces.CommentData[]; + /** An interface for updating data on the `RangeCollection` object, for use in `rangeCollection.set({ ... })`. */ + export interface RangeCollectionUpdateData { + items?: Word.Interfaces.RangeData[]; } - /** An interface for updating data on the `CommentContentRange` object, for use in `commentContentRange.set({ ... })`. */ - export interface CommentContentRangeUpdateData { + /** An interface for updating data on the `SearchOptions` object, for use in `searchOptions.set({ ... })`. */ + export interface SearchOptionsUpdateData { /** - * Specifies a value that indicates whether the comment text is bold. + * Specifies a value that indicates whether to ignore all punctuation characters between words. Corresponds to the Ignore punctuation check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - bold?: boolean; + ignorePunct?: boolean; /** - * Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. + * Specifies a value that indicates whether to ignore all whitespace between words. Corresponds to the Ignore whitespace characters check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - hyperlink?: string; + ignoreSpace?: boolean; /** - * Specifies a value that indicates whether the comment text is italicized. + * Specifies a value that indicates whether to perform a case sensitive search. Corresponds to the Match case check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - italic?: boolean; + matchCase?: boolean; /** - * Specifies a value that indicates whether the comment text has a strikethrough. + * Specifies a value that indicates whether to match words that begin with the search string. Corresponds to the Match prefix check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - strikeThrough?: boolean; + matchPrefix?: boolean; /** - * Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined. + * Specifies a value that indicates whether to match words that end with the search string. Corresponds to the Match suffix check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; - } - /** An interface for updating data on the `CommentReply` object, for use in `commentReply.set({ ... })`. */ - export interface CommentReplyUpdateData { + matchSuffix?: boolean; /** - * Specifies the commentReply's content range. + * Specifies a value that indicates whether to find operation only entire words, not text that is part of a larger word. Corresponds to the Find whole words only check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - contentRange?: Word.Interfaces.CommentContentRangeUpdateData; + matchWholeWord?: boolean; /** - * Gets the parent comment of this reply. + * Specifies a value that indicates whether the search will be performed using special search operators. Corresponds to the Use wildcards check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - parentComment?: Word.Interfaces.CommentUpdateData; + matchWildcards?: boolean; + } + /** An interface for updating data on the `Section` object, for use in `section.set({ ... })`. */ + export interface SectionUpdateData { /** - * Specifies the comment reply's content. The string is plain text. + * Gets the body object of the section. This doesn't include the header/footer and other section metadata. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - content?: string; - } - /** An interface for updating data on the `CommentReplyCollection` object, for use in `commentReplyCollection.set({ ... })`. */ - export interface CommentReplyCollectionUpdateData { - items?: Word.Interfaces.CommentReplyData[]; - } - /** An interface for updating data on the `XmlMapping` object, for use in `xmlMapping.set({ ... })`. */ - export interface XmlMappingUpdateData { + body?: Word.Interfaces.BodyUpdateData; /** - * Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to. + * Returns a `PageSetup` object that's associated with the section. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customXmlNode?: Word.Interfaces.CustomXmlNodeUpdateData; + pageSetup?: Word.Interfaces.PageSetupUpdateData; /** - * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. + * Specifies if the section is protected for forms. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customXmlPart?: Word.Interfaces.CustomXmlPartUpdateData; - } - /** An interface for updating data on the `CustomXmlPrefixMappingCollection` object, for use in `customXmlPrefixMappingCollection.set({ ... })`. */ - export interface CustomXmlPrefixMappingCollectionUpdateData { - items?: Word.Interfaces.CustomXmlPrefixMappingData[]; - } - /** An interface for updating data on the `CustomXmlSchemaCollection` object, for use in `customXmlSchemaCollection.set({ ... })`. */ - export interface CustomXmlSchemaCollectionUpdateData { - items?: Word.Interfaces.CustomXmlSchemaData[]; + protectedForForms?: boolean; } - /** An interface for updating data on the `CustomXmlValidationErrorCollection` object, for use in `customXmlValidationErrorCollection.set({ ... })`. */ - export interface CustomXmlValidationErrorCollectionUpdateData { - items?: Word.Interfaces.CustomXmlValidationErrorData[]; + /** An interface for updating data on the `SectionCollection` object, for use in `sectionCollection.set({ ... })`. */ + export interface SectionCollectionUpdateData { + items?: Word.Interfaces.SectionData[]; } - /** An interface for updating data on the `CustomXmlValidationError` object, for use in `customXmlValidationError.set({ ... })`. */ - export interface CustomXmlValidationErrorUpdateData { + /** An interface for updating data on the `Setting` object, for use in `setting.set({ ... })`. */ + export interface SettingUpdateData { /** - * Gets the node associated with this `CustomXmlValidationError` object, if any exist.If no nodes exist, the property returns `Nothing`. + * Specifies the value of the setting. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - node?: Word.Interfaces.CustomXmlNodeUpdateData; + value?: any; } - /** An interface for updating data on the `CustomXmlNodeCollection` object, for use in `customXmlNodeCollection.set({ ... })`. */ - export interface CustomXmlNodeCollectionUpdateData { - items?: Word.Interfaces.CustomXmlNodeData[]; + /** An interface for updating data on the `SettingCollection` object, for use in `settingCollection.set({ ... })`. */ + export interface SettingCollectionUpdateData { + items?: Word.Interfaces.SettingData[]; } - /** An interface for updating data on the `CustomXmlNode` object, for use in `customXmlNode.set({ ... })`. */ - export interface CustomXmlNodeUpdateData { + /** An interface for updating data on the `StyleCollection` object, for use in `styleCollection.set({ ... })`. */ + export interface StyleCollectionUpdateData { + items?: Word.Interfaces.StyleData[]; + } + /** An interface for updating data on the `Style` object, for use in `style.set({ ... })`. */ + export interface StyleUpdateData { /** - * Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. + * Specifies a BorderCollection object that represents all the borders for the specified style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - firstChild?: Word.Interfaces.CustomXmlNodeUpdateData; + borders?: Word.Interfaces.BorderCollectionUpdateData; /** - * Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. + * Gets a font object that represents the character formatting of the specified style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - lastChild?: Word.Interfaces.CustomXmlNodeUpdateData; + font?: Word.Interfaces.FontUpdateData; /** - * Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. + * Returns a `Frame` object that represents the frame formatting for the style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nextSibling?: Word.Interfaces.CustomXmlNodeUpdateData; + frame?: Word.Interfaces.FrameUpdateData; /** - * Gets the object representing the part associated with this node. + * Specifies a link between a paragraph and a character style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - ownerPart?: Word.Interfaces.CustomXmlPartUpdateData; + linkStyle?: Word.Interfaces.StyleUpdateData; /** - * Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. + * Gets a ListTemplate object that represents the list formatting for the specified Style object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - parentNode?: Word.Interfaces.CustomXmlNodeUpdateData; + listTemplate?: Word.Interfaces.ListTemplateUpdateData; /** - * Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. + * Gets a ParagraphFormat object that represents the paragraph settings for the specified style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - previousSibling?: Word.Interfaces.CustomXmlNodeUpdateData; + paragraphFormat?: Word.Interfaces.ParagraphFormatUpdateData; /** - * Specifies the value of the current node. + * Gets a Shading object that represents the shading for the specified style. Not applicable to List style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - nodeValue?: string; + shading?: Word.Interfaces.ShadingUpdateData; /** - * Specifies the text for the current node. + * Gets a TableStyle object representing Style properties that can be applied to a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - text?: string; - } - /** An interface for updating data on the `ContentControl` object, for use in `contentControl.set({ ... })`. */ - export interface ContentControlUpdateData { + tableStyle?: Word.Interfaces.TableStyleUpdateData; /** - * Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `BuildingBlockGallery`. It's `null` otherwise. + * Specifies whether the style is automatically redefined based on the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlUpdateData; + automaticallyUpdate?: boolean; /** - * Gets the data of the content control when its type is `CheckBox`. It's `null` otherwise. + * Specifies the name of an existing style to use as the base formatting of another style. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi 1.5] + * + * Note: The ability to set `baseStyle` was introduced in WordApi 1.6. */ - checkboxContentControl?: Word.Interfaces.CheckboxContentControlUpdateData; + baseStyle?: string; /** - * Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `DatePicker`. It's `null` otherwise. + * Specifies whether the spelling and grammar checker ignores text formatted with this style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - datePickerContentControl?: Word.Interfaces.DatePickerContentControlUpdateData; + hasProofing?: boolean; /** - * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. + * Specifies a `LanguageId` value that represents the language for the style. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontUpdateData; + languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Gets the group-related data if the content control's {@link Word.ContentControlType} is `Group`. It's `null` otherwise. + * Specifies an East Asian language for the style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - groupContentControl?: Word.Interfaces.GroupContentControlUpdateData; + languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Gets the picture-related data if the content control's {@link Word.ContentControlType} is `Picture`. It's `null` otherwise. + * Specifies whether the style cannot be changed or edited. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pictureContentControl?: Word.Interfaces.PictureContentControlUpdateData; + locked?: boolean; /** - * Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `RepeatingSection`. It's `null` otherwise. + * Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] + * + * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. */ - repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlUpdateData; + nextParagraphStyle?: string; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Specifies whether to remove spacing between paragraphs that are formatted using the same style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingUpdateData; + noSpaceBetweenParagraphsOfSameStyle?: boolean; /** - * Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. + * Specifies the priority. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + priority?: number; /** - * Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited. + * Specifies whether the style corresponds to an available quick style. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - cannotDelete?: boolean; + quickStyle?: boolean; /** - * Specifies a value that indicates whether the user can edit the contents of the content control. + * Specifies whether the specified style is made visible as a recommended style in the Styles and in the Styles task pane in Microsoft Word after it's used in the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - cannotEdit?: boolean; + unhideWhenUsed?: boolean; /** - * Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. + * Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - color?: string; + visibility?: boolean; + } + /** An interface for updating data on the `Shading` object, for use in `shading.set({ ... })`. */ + export interface ShadingUpdateData { /** - * Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. + * Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.6] */ - placeholderText?: string; + backgroundPatternColor?: string; /** - * Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. + * Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - removeWhenEdited?: boolean; + foregroundPatternColor?: string; /** - * Specifies the style name for the content control. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - style?: string; + texture?: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; + } + /** An interface for updating data on the `ShadingUniversal` object, for use in `shadingUniversal.set({ ... })`. */ + export interface ShadingUniversalUpdateData { /** - * Specifies the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Specifies the color that's applied to the background of the `ShadingUniversal` object. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + backgroundPatternColor?: string; /** - * Specifies a tag to identify a content control. + * Specifies the color that's applied to the background of the `ShadingUniversal` object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tag?: string; + backgroundPatternColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Specifies the title for a content control. + * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - title?: string; - } - /** An interface for updating data on the `ContentControlCollection` object, for use in `contentControlCollection.set({ ... })`. */ - export interface ContentControlCollectionUpdateData { - items?: Word.Interfaces.ContentControlData[]; - } - /** An interface for updating data on the `ContentControlListItem` object, for use in `contentControlListItem.set({ ... })`. */ - export interface ContentControlListItemUpdateData { + foregroundPatternColor?: string; /** - * Specifies the display text of a list item for a dropdown list or combo box content control. + * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - displayText?: string; + foregroundPatternColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Specifies the index location of a content control list item in the collection of list items. + * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - index?: number; + texture?: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; + } + /** An interface for updating data on the `Table` object, for use in `table.set({ ... })`. */ + export interface TableUpdateData { /** - * Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * Gets the font. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi 1.3] */ - value?: string; - } - /** An interface for updating data on the `ContentControlListItemCollection` object, for use in `contentControlListItemCollection.set({ ... })`. */ - export interface ContentControlListItemCollectionUpdateData { - items?: Word.Interfaces.ContentControlListItemData[]; - } - /** An interface for updating data on the `CustomProperty` object, for use in `customProperty.set({ ... })`. */ - export interface CustomPropertyUpdateData { + font?: Word.Interfaces.FontUpdateData; /** - * Specifies the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). + * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. * * @remarks * [Api set: WordApi 1.3] */ - value?: any; - } - /** An interface for updating data on the `CustomPropertyCollection` object, for use in `customPropertyCollection.set({ ... })`. */ - export interface CustomPropertyCollectionUpdateData { - items?: Word.Interfaces.CustomPropertyData[]; - } - /** An interface for updating data on the `CustomXmlPart` object, for use in `customXmlPart.set({ ... })`. */ - export interface CustomXmlPartUpdateData { + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. + * Specifies the description of the table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - documentElement?: Word.Interfaces.CustomXmlNodeUpdateData; - } - /** An interface for updating data on the `CustomXmlPartCollection` object, for use in `customXmlPartCollection.set({ ... })`. */ - export interface CustomXmlPartCollectionUpdateData { - items?: Word.Interfaces.CustomXmlPartData[]; - } - /** An interface for updating data on the `CustomXmlPartScopedCollection` object, for use in `customXmlPartScopedCollection.set({ ... })`. */ - export interface CustomXmlPartScopedCollectionUpdateData { - items?: Word.Interfaces.CustomXmlPartData[]; - } - /** An interface for updating data on the `Document` object, for use in `document.set({ ... })`. */ - export interface DocumentUpdateData { + description?: string; /** - * Gets the active window for the document. + * Specifies the number of header rows. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - activeWindow?: Word.Interfaces.WindowUpdateData; + headerRowCount?: number; /** - * Returns a `Bibliography` object that represents the bibliography references contained within the document. + * Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - bibliography?: Word.Interfaces.BibliographyUpdateData; + horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - body?: Word.Interfaces.BodyUpdateData; + shadingColor?: string; /** - * Returns a `PageSetup` object that's associated with the document. + * Specifies the style name for the table. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - pageSetup?: Word.Interfaces.PageSetupUpdateData; + style?: string; /** - * Gets the properties of the document. + * Specifies whether the table has banded columns. * * @remarks * [Api set: WordApi 1.3] */ - properties?: Word.Interfaces.DocumentPropertiesUpdateData; + styleBandedColumns?: boolean; /** - * Specifies if automatic hyphenation is turned on for the document. + * Specifies whether the table has banded rows. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - autoHyphenation?: boolean; + styleBandedRows?: boolean; /** - * Specifies if the edits in the document are automatically saved. + * Specifies the built-in style name for the table. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - autoSaveOn?: boolean; + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; /** - * Specifies the ChangeTracking mode. + * Specifies whether the table has a first column with a special style. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - changeTrackingMode?: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly"; + styleFirstColumn?: boolean; /** - * Specifies the maximum number of consecutive lines that can end with hyphens. + * Specifies whether the table has a last column with a special style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - consecutiveHyphensLimit?: number; + styleLastColumn?: boolean; /** - * Specifies whether words in all capital letters can be hyphenated. + * Specifies whether the table has a total (last) row with a special style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - hyphenateCaps?: boolean; + styleTotalRow?: boolean; /** - * Specifies whether Microsoft Word has detected the language of the document text. + * Specifies the title of the table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageDetected?: boolean; - } - /** An interface for updating data on the `DocumentCreated` object, for use in `documentCreated.set({ ... })`. */ - export interface DocumentCreatedUpdateData { - /** - * Gets the body object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.3] - */ - body?: Word.Interfaces.BodyUpdateData; + title?: string; /** - * Gets the properties of the document. + * Specifies the text values in the table, as a 2D JavaScript array. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] + * [Api set: WordApi 1.3] */ - properties?: Word.Interfaces.DocumentPropertiesUpdateData; - } - /** An interface for updating data on the `DocumentProperties` object, for use in `documentProperties.set({ ... })`. */ - export interface DocumentPropertiesUpdateData { + values?: string[][]; /** - * Specifies the author of the document. + * Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. * * @remarks * [Api set: WordApi 1.3] */ - author?: string; + verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; /** - * Specifies the category of the document. + * Specifies the width of the table in points. * * @remarks * [Api set: WordApi 1.3] */ - category?: string; + width?: number; + } + /** An interface for updating data on the `TableStyle` object, for use in `tableStyle.set({ ... })`. */ + export interface TableStyleUpdateData { /** - * Specifies the Comments field in the metadata of the document. These have no connection to comments by users made in the document. + * Specifies the table's alignment against the page margin. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - comments?: string; + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies the company of the document. + * Specifies whether lines in tables formatted with a specified style break across pages. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - company?: string; + allowBreakAcrossPage?: boolean; /** - * Specifies the format of the document. + * Specifies the amount of space to add between the contents and the bottom borders of the cells. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - format?: string; + bottomCellMargin?: number; /** - * Specifies the keywords of the document. + * Specifies the spacing (in points) between the cells in a table style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - keywords?: string; + cellSpacing?: number; /** - * Specifies the manager of the document. + * Specifies the number of columns in the banding when a style specifies odd- or even-column banding. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - manager?: string; + columnStripe?: number; /** - * Specifies the subject of the document. + * Specifies whether Microsoft Word allows to break the specified table across pages. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - subject?: string; + isBreakAcrossPagesAllowed?: boolean; /** - * Specifies the title of the document. + * Specifies the amount of space to add between the contents and the left borders of the cells. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - title?: string; - } - /** An interface for updating data on the `Field` object, for use in `field.set({ ... })`. */ - export interface FieldUpdateData { + leftCellMargin?: number; /** - * Gets the field's result data. + * Specifies the left indent value (in points) for the rows in the table style. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - result?: Word.Interfaces.RangeUpdateData; + leftIndent?: number; /** - * Specifies the field's code instruction. + * Specifies the amount of space to add between the contents and the right borders of the cells. * * @remarks - * [Api set: WordApi 1.4] - * - * Note: The ability to set the code was introduced in WordApi 1.5. + * [Api set: WordApi 1.6] */ - code?: string; + rightCellMargin?: number; /** - * Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is `null` and it will throw a general exception when code attempts to set it. + * Specifies the number of rows to include in the banding when the style specifies odd- or even-row banding. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - data?: string; + rowStripe?: number; /** - * Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. + * Specifies the direction in which Microsoft Word orders cells in the table style. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - locked?: boolean; + tableDirection?: Word.TableDirection | "RightToLeft" | "LeftToRight"; /** - * Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise. + * Specifies the amount of space to add between the contents and the top borders of the cells. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.6] */ - showCodes?: boolean; + topCellMargin?: number; } - /** An interface for updating data on the `FieldCollection` object, for use in `fieldCollection.set({ ... })`. */ - export interface FieldCollectionUpdateData { - items?: Word.Interfaces.FieldData[]; + /** An interface for updating data on the `TabStopCollection` object, for use in `tabStopCollection.set({ ... })`. */ + export interface TabStopCollectionUpdateData { + items?: Word.Interfaces.TabStopData[]; } - /** An interface for updating data on the `Font` object, for use in `font.set({ ... })`. */ - export interface FontUpdateData { + /** An interface for updating data on the `TableCollection` object, for use in `tableCollection.set({ ... })`. */ + export interface TableCollectionUpdateData { + items?: Word.Interfaces.TableData[]; + } + /** An interface for updating data on the `TableColumn` object, for use in `tableColumn.set({ ... })`. */ + export interface TableColumnUpdateData { /** - * Returns a `FillFormat` object that contains fill formatting properties for the font used by the range of text. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fill?: Word.Interfaces.FillFormatUpdateData; + shading?: Word.Interfaces.ShadingUniversalUpdateData; /** - * Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text. + * Specifies the preferred width (in points or as a percentage of the window width) for the column. + The unit of measurement can be specified by the `preferredWidthType` property. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - glow?: Word.Interfaces.GlowFormatUpdateData; + preferredWidth?: number; /** - * Returns a `LineFormat` object that specifies the formatting for a line. + * Specifies the preferred unit of measurement to use for the width of the table column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - line?: Word.Interfaces.LineFormatUpdateData; + preferredWidthType?: Word.PreferredWidthType | "Auto" | "Percent" | "Points"; /** - * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. + * Specifies the width of the column, in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - reflection?: Word.Interfaces.ReflectionFormatUpdateData; + width?: number; + } + /** An interface for updating data on the `TableColumnCollection` object, for use in `tableColumnCollection.set({ ... })`. */ + export interface TableColumnCollectionUpdateData { + items?: Word.Interfaces.TableColumnData[]; + } + /** An interface for updating data on the `TableOfAuthorities` object, for use in `tableOfAuthorities.set({ ... })`. */ + export interface TableOfAuthoritiesUpdateData { /** - * Returns a `ColorFormat` object that represents the color for the font. + * Specifies the name of the bookmark from which to collect table of authorities entries. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textColor?: Word.Interfaces.ColorFormatUpdateData; + bookmark?: string; /** - * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. + * Specifies the category of entries to be included in the table of authorities. + Values 0 through 16 correspond to the items listed in the Category box of the Table of Authorities dialog. To learn how to access this through the Word UI, see {@link https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0 | Create a table of authorities}. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textShadow?: Word.Interfaces.ShadowFormatUpdateData; + category?: number; /** - * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font. + * Specifies a separator of up to five characters. This appears between the table of authorities entry and its page number. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - threeDimensionalFormat?: Word.Interfaces.ThreeDimensionalFormatUpdateData; - /** - * Specifies whether the font is formatted as all capital letters, 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. + * @beta + */ + entrySeparator?: string; + /** + * Specifies whether the category name for a group of entries appears in the table of authorities. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - allCaps?: boolean; + isCategoryHeaderIncluded?: boolean; /** - * Specifies a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false. + * Specifies whether the entries in the table of authorities are displayed with their formatting in the table. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bold?: boolean; + isEntryFormattingKept?: boolean; /** - * Specifies whether the font is formatted as bold in a right-to-left language document. 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. + * Specifies whether references to the same authority that are repeated on five or more pages are replaced with "Passim". * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - boldBidirectional?: boolean; + isPassimUsed?: boolean; /** - * Specifies the color for the specified font. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies a separator of up to five characters. This appears between individual page references in the table of authorities. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - color?: string; + pageNumberSeparator?: string; /** - * Specifies a `ColorIndex` value that represents the color for the font. + * Specifies a separator of up to five characters. This appears between ranges of pages in the table of authorities. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - colorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + pageRangeSeparator?: string; /** - * Specifies the color for the `Font` object in a right-to-left language document. + * Specifies the {@link https://support.microsoft.com/office/062a387b-dfc9-4ef8-8235-29ee113d59be | Sequence (SEQ) field} identifier for the table of authorities. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - colorIndexBidirectional?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + sequenceName?: string; /** - * Specifies whether contextual alternates are enabled for the font. + * Specifies a separator of up to five characters. This appears between the sequence number and the page number in the table of authorities. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contextualAlternates?: boolean; + sequenceSeparator?: string; /** - * Specifies the color to be used for diacritics for the `Font` object. You can provide the value in the '#RRGGBB' format. + * Specifies the leader character that appears between entries and their associated page numbers in the table of authorities. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - diacriticColor?: string; + tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + } + /** An interface for updating data on the `TableOfAuthoritiesCollection` object, for use in `tableOfAuthoritiesCollection.set({ ... })`. */ + export interface TableOfAuthoritiesCollectionUpdateData { + items?: Word.Interfaces.TableOfAuthoritiesData[]; + } + /** An interface for updating data on the `TableOfAuthoritiesCategoryCollection` object, for use in `tableOfAuthoritiesCategoryCollection.set({ ... })`. */ + export interface TableOfAuthoritiesCategoryCollectionUpdateData { + items?: Word.Interfaces.TableOfAuthoritiesCategoryData[]; + } + /** An interface for updating data on the `TableOfContents` object, for use in `tableOfContents.set({ ... })`. */ + export interface TableOfContentsUpdateData { /** - * Specifies whether Microsoft Word ignores the number of characters per line for the corresponding `Font` object. + * Specifies whether built-in heading styles are used for the table of contents. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - disableCharacterSpaceGrid?: boolean; + areBuiltInHeadingStylesUsed?: boolean; /** - * Specifies a value that indicates whether the font has a double strikethrough. True if the font is formatted as double strikethrough text, otherwise, false. + * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of contents. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - doubleStrikeThrough?: boolean; + areFieldsUsed?: boolean; /** - * Specifies whether the font is formatted as embossed. The possible values are as follows: - - - `true`: All the text is embossed. - - - `false`: None of the text is embossed. - - - `null`: Returned if some, but not all, of the text is embossed. + * Specifies whether entries in the table of contents should be formatted as hyperlinks when publishing to the web. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - emboss?: boolean; + areHyperlinksUsedOnWeb?: boolean; /** - * Specifies an `EmphasisMark` value that represents the emphasis mark for a character or designated character string. + * Specifies whether the page numbers in the table of contents should be hidden when publishing to the web. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - emphasisMark?: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle"; + arePageNumbersHiddenOnWeb?: boolean; /** - * Specifies whether the font is formatted as engraved. The possible values are as follows: - - - `true`: All the text is engraved. - - - `false`: None of the text is engraved. - - - `null`: Returned if some, but not all, of the text is engraved. + * Specifies whether page numbers are included in the table of contents. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - engrave?: boolean; + arePageNumbersIncluded?: boolean; /** - * Specifies a value that indicates whether the font is tagged as hidden. True if the font is formatted as hidden text, otherwise, false. + * Specifies whether page numbers are aligned with the right margin in the table of contents. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - hidden?: boolean; + arePageNumbersRightAligned?: boolean; /** - * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or `null` for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. + * Specifies the ending heading level for the table of contents. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - highlightColor?: string; + lowerHeadingLevel?: number; /** - * Specifies a value that indicates whether the font is italicized. True if the font is italicized, otherwise, false. + * Specifies the character between entries and their page numbers in the table of contents. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - italic?: boolean; + tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** - * Specifies whether the font is italicized in a right-to-left language document. 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. + * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of contents. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - italicBidirectional?: boolean; + tableId?: string; /** - * Specifies the minimum font size for which Microsoft Word will adjust kerning automatically. + * Specifies the starting heading level for the table of contents. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - kerning?: number; + upperHeadingLevel?: number; + } + /** An interface for updating data on the `TableOfContentsCollection` object, for use in `tableOfContentsCollection.set({ ... })`. */ + export interface TableOfContentsCollectionUpdateData { + items?: Word.Interfaces.TableOfContentsData[]; + } + /** An interface for updating data on the `TableOfFigures` object, for use in `tableOfFigures.set({ ... })`. */ + export interface TableOfFiguresUpdateData { /** - * Specifies the ligature setting for the `Font` object. + * Specifies whether built-in heading styles are used for the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - ligature?: Word.Ligature | "None" | "Standard" | "Contextual" | "StandardContextual" | "Historical" | "StandardHistorical" | "ContextualHistorical" | "StandardContextualHistorical" | "Discretional" | "StandardDiscretional" | "ContextualDiscretional" | "StandardContextualDiscretional" | "HistoricalDiscretional" | "StandardHistoricalDiscretional" | "ContextualHistoricalDiscretional" | "All"; + areBuiltInHeadingStylesUsed?: boolean; /** - * Specifies a value that represents the name of the font. + * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of figures. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - name?: string; + areFieldsUsed?: boolean; /** - * Specifies the font used for Latin text (characters with character codes from 0 (zero) through 127). + * Specifies whether entries in the table of figures should be formatted as hyperlinks when publishing to the web. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nameAscii?: string; + areHyperlinksUsedOnWeb?: boolean; /** - * Specifies the font name in a right-to-left language document. + * Specifies whether the page numbers in the table of figures should be hidden when publishing to the web. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nameBidirectional?: string; + arePageNumbersHiddenOnWeb?: boolean; /** - * Specifies the East Asian font name. + * Specifies whether page numbers are included in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nameFarEast?: string; + arePageNumbersIncluded?: boolean; /** - * Specifies the font used for characters with codes from 128 through 255. + * Specifies whether page numbers are aligned with the right margin in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nameOther?: string; + arePageNumbersRightAligned?: boolean; /** - * Specifies the number form setting for an OpenType font. + * Specifies the label that identifies the items to be included in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - numberForm?: Word.NumberForm | "Default" | "Lining" | "OldStyle"; + captionLabel?: string; /** - * Specifies the number spacing setting for the font. + * Specifies whether the caption label and caption number are included in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - numberSpacing?: Word.NumberSpacing | "Default" | "Proportional" | "Tabular"; + isLabelIncluded?: boolean; /** - * Specifies if the font is formatted as outlined. The possible values are as follows: - - - `true`: All the text is outlined. - - - `false`: None of the text is outlined. - - - `null`: Returned if some, but not all, of the text is outlined. + * Specifies the ending heading level for the table of figures. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - outline?: boolean; + lowerHeadingLevel?: number; /** - * Specifies the position of text (in points) relative to the base line. + * Specifies the character between entries and their page numbers in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - position?: number; + tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** - * Specifies the scaling percentage applied to the font. + * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - scaling?: number; + tableId?: string; /** - * Specifies if the font is formatted as shadowed. The possible values are as follows: - - - `true`: All the text is shadowed. - - - `false`: None of the text is shadowed. - - - `null`: Returned if some, but not all, of the text is shadowed. + * Specifies the starting heading level for the table of figures. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shadow?: boolean; + upperHeadingLevel?: number; + } + /** An interface for updating data on the `TableOfFiguresCollection` object, for use in `tableOfFiguresCollection.set({ ... })`. */ + export interface TableOfFiguresCollectionUpdateData { + items?: Word.Interfaces.TableOfFiguresData[]; + } + /** An interface for updating data on the `TableRow` object, for use in `tableRow.set({ ... })`. */ + export interface TableRowUpdateData { /** - * Specifies a value that represents the font size in points. + * Gets the font. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - size?: number; + font?: Word.Interfaces.FontUpdateData; /** - * Specifies the font size in points for right-to-left text. + * Specifies the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - sizeBidirectional?: number; + horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies whether the font is formatted as small caps, 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. + * Specifies the preferred height of the row in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - smallCaps?: boolean; + preferredHeight?: number; /** - * Specifies the spacing between characters. + * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - spacing?: number; + shadingColor?: string; /** - * Specifies a value that indicates whether the font has a strikethrough. True if the font is formatted as strikethrough text, otherwise, false. + * Specifies the text values in the row, as a 2D JavaScript array. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - strikeThrough?: boolean; + values?: string[][]; /** - * Specifies the stylistic set for the font. + * Specifies the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - stylisticSet?: Word.StylisticSet | "Default" | "Set01" | "Set02" | "Set03" | "Set04" | "Set05" | "Set06" | "Set07" | "Set08" | "Set09" | "Set10" | "Set11" | "Set12" | "Set13" | "Set14" | "Set15" | "Set16" | "Set17" | "Set18" | "Set19" | "Set20"; + verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + } + /** An interface for updating data on the `TableRowCollection` object, for use in `tableRowCollection.set({ ... })`. */ + export interface TableRowCollectionUpdateData { + items?: Word.Interfaces.TableRowData[]; + } + /** An interface for updating data on the `TableCell` object, for use in `tableCell.set({ ... })`. */ + export interface TableCellUpdateData { /** - * Specifies a value that indicates whether the font is a subscript. True if the font is formatted as subscript, otherwise, false. + * Gets the body object of the cell. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - subscript?: boolean; + body?: Word.Interfaces.BodyUpdateData; /** - * Specifies a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false. + * Specifies the width of the cell's column in points. This is applicable to uniform tables. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - superscript?: boolean; + columnWidth?: number; /** - * Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined. + * Specifies the horizontal alignment of the cell. The value can be 'Left', 'Centered', 'Right', or 'Justified'. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; + horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies the color of the underline for the `Font` object. You can provide the value in the '#RRGGBB' format. + * Specifies the shading color of the cell. Color is specified in "#RRGGBB" format or by using the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - underlineColor?: string; - } - /** An interface for updating data on the `Hyperlink` object, for use in `hyperlink.set({ ... })`. */ - export interface HyperlinkUpdateData { + shadingColor?: string; /** - * Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. + * Specifies the text of the cell. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - range?: Word.Interfaces.RangeUpdateData; + value?: string; /** - * Specifies the address (for example, a file name or URL) of the hyperlink. + * Specifies the vertical alignment of the cell. The value can be 'Top', 'Center', or 'Bottom'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - address?: string; + verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + } + /** An interface for updating data on the `TableCellCollection` object, for use in `tableCellCollection.set({ ... })`. */ + export interface TableCellCollectionUpdateData { + items?: Word.Interfaces.TableCellData[]; + } + /** An interface for updating data on the `TableBorder` object, for use in `tableBorder.set({ ... })`. */ + export interface TableBorderUpdateData { /** - * Specifies the text string for the hyperlink's subject line. + * Specifies the table border color. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - emailSubject?: string; + color?: string; /** - * Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink. + * Specifies the type of the table border. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - screenTip?: string; + type?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; /** - * Specifies a named location in the destination of the hyperlink. + * Specifies the width, in points, of the table border. Not applicable to table border types that have fixed widths. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - subAddress?: string; + width?: number; + } + /** An interface for updating data on the `Template` object, for use in `template.set({ ... })`. */ + export interface TemplateUpdateData { /** - * Specifies the name of the frame or window in which to load the hyperlink. + * Specifies the East Asian language to use when breaking lines of text in the document or template. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - target?: string; + farEastLineBreakLanguage?: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; /** - * Specifies the hyperlink's visible text in the document. + * Specifies the line break control level for the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textToDisplay?: string; - } - /** An interface for updating data on the `HyperlinkCollection` object, for use in `hyperlinkCollection.set({ ... })`. */ - export interface HyperlinkCollectionUpdateData { - items?: Word.Interfaces.HyperlinkData[]; - } - /** An interface for updating data on the `InlinePicture` object, for use in `inlinePicture.set({ ... })`. */ - export interface InlinePictureUpdateData { + farEastLineBreakLevel?: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"; /** - * Specifies a string that represents the alternative text associated with the inline image. + * Specifies whether the spelling and grammar checker ignores documents based on this template. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - altTextDescription?: string; + hasNoProofing?: boolean; /** - * Specifies a string that contains the title for the inline image. + * Specifies the character spacing adjustment for the template. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - altTextTitle?: string; + justificationMode?: Word.JustificationMode | "Expand" | "Compress" | "CompressKana"; /** - * Specifies a number that describes the height of the inline image. + * Specifies if Microsoft Word kerns half-width Latin characters and punctuation marks in the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - height?: number; + kerningByAlgorithm?: boolean; /** - * Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. + * Specifies a `LanguageId` value that represents the language in the template. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - hyperlink?: string; + languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies a value that indicates whether the inline image retains its original proportions when you resize it. + * Specifies an East Asian language for the language in the template. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lockAspectRatio?: boolean; + languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies a number that describes the width of the inline image. + * Specifies the kinsoku characters after which Microsoft Word will not break a line. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: number; - } - /** An interface for updating data on the `InlinePictureCollection` object, for use in `inlinePictureCollection.set({ ... })`. */ - export interface InlinePictureCollectionUpdateData { - items?: Word.Interfaces.InlinePictureData[]; - } - /** An interface for updating data on the `LinkFormat` object, for use in `linkFormat.set({ ... })`. */ - export interface LinkFormatUpdateData { + noLineBreakAfter?: string; /** - * Specifies if the link is updated automatically when the container file is opened or when the source file is changed. + * Specifies the kinsoku characters before which Microsoft Word will not break a line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isAutoUpdated?: boolean; + noLineBreakBefore?: string; /** - * Specifies if a `Field`, `InlineShape`, or `Shape` object is locked to prevent automatic updating. + * Specifies `true` if the template has not changed since it was last saved, `false` if Microsoft Word displays a prompt to save changes when the document is closed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isLocked?: boolean; + saved?: boolean; + } + /** An interface for updating data on the `TemplateCollection` object, for use in `templateCollection.set({ ... })`. */ + export interface TemplateCollectionUpdateData { + items?: Word.Interfaces.TemplateData[]; + } + /** An interface for updating data on the `TrackedChangeCollection` object, for use in `trackedChangeCollection.set({ ... })`. */ + export interface TrackedChangeCollectionUpdateData { + items?: Word.Interfaces.TrackedChangeData[]; + } + /** An interface for updating data on the `View` object, for use in `view.set({ ... })`. */ + export interface ViewUpdateData { /** - * Specifies if the linked picture is saved with the document. + * Specifies whether all nonprinting characters are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isPictureSavedWithDocument?: boolean; + areAllNonprintingCharactersDisplayed?: boolean; /** - * Specifies the path and name of the source file for the linked OLE object, picture, or field. + * Gets whether background colors and images are shown when the document is displayed in print layout view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sourceFullName?: string; - } - /** An interface for updating data on the `ListCollection` object, for use in `listCollection.set({ ... })`. */ - export interface ListCollectionUpdateData { - items?: Word.Interfaces.ListData[]; - } - /** An interface for updating data on the `ListItem` object, for use in `listItem.set({ ... })`. */ - export interface ListItemUpdateData { + areBackgroundsDisplayed?: boolean; /** - * Specifies the level of the item in the list. + * Specifies whether Microsoft Word displays the comments in the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - level?: number; - } - /** An interface for updating data on the `ListLevel` object, for use in `listLevel.set({ ... })`. */ - export interface ListLevelUpdateData { + areCommentsDisplayed?: boolean; /** - * Gets a Font object that represents the character formatting of the specified object. + * Specifies whether Microsoft Word displays connecting lines from the text to the revision and comment balloons. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontUpdateData; + areConnectingLinesToRevisionsBalloonDisplayed?: boolean; /** - * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. + * Specifies whether shading is applied to the ranges in the document that users have permission to modify. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + areEditableRangesShaded?: boolean; /** - * Specifies the name of the style that's linked to the specified list level object. + * Specifies whether field codes are displayed. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - linkedStyle?: string; + areFieldCodesDisplayed?: boolean; /** - * Specifies the number format for the specified list level. + * Specifies whether Microsoft Word displays formatting changes made to the document with Track Changes enabled. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - numberFormat?: string; + areFormatChangesDisplayed?: boolean; /** - * Specifies the position (in points) of the number or bullet for the specified list level object. + * Specifies whether handwritten ink annotations are shown or hidden. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - numberPosition?: number; + areInkAnnotationsDisplayed?: boolean; /** - * Specifies the number style for the list level object. + * Specifies whether Microsoft Word displays insertions and deletions made to the document with Track Changes enabled. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - numberStyle?: Word.ListBuiltInNumberStyle | "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter" | "Ordinal" | "CardinalText" | "OrdinalText" | "Kanji" | "KanjiDigit" | "AiueoHalfWidth" | "IrohaHalfWidth" | "ArabicFullWidth" | "KanjiTraditional" | "KanjiTraditional2" | "NumberInCircle" | "Aiueo" | "Iroha" | "ArabicLZ" | "Bullet" | "Ganada" | "Chosung" | "GBNum1" | "GBNum2" | "GBNum3" | "GBNum4" | "Zodiac1" | "Zodiac2" | "Zodiac3" | "TradChinNum1" | "TradChinNum2" | "TradChinNum3" | "TradChinNum4" | "SimpChinNum1" | "SimpChinNum2" | "SimpChinNum3" | "SimpChinNum4" | "HanjaRead" | "HanjaReadDigit" | "Hangul" | "Hanja" | "Hebrew1" | "Arabic1" | "Hebrew2" | "Arabic2" | "HindiLetter1" | "HindiLetter2" | "HindiArabic" | "HindiCardinalText" | "ThaiLetter" | "ThaiArabic" | "ThaiCardinalText" | "VietCardinalText" | "LowercaseRussian" | "UppercaseRussian" | "LowercaseGreek" | "UppercaseGreek" | "ArabicLZ2" | "ArabicLZ3" | "ArabicLZ4" | "LowercaseTurkish" | "UppercaseTurkish" | "LowercaseBulgarian" | "UppercaseBulgarian" | "PictureBullet" | "Legal" | "LegalLZ"; + areInsertionsAndDeletionsDisplayed?: boolean; /** - * Specifies the list level that must appear before the specified list level restarts numbering at 1. + * Gets whether other authors' presence should be visible in the document. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - resetOnHigher?: number; + areOtherAuthorsVisible?: boolean; /** - * Specifies the starting number for the specified list level object. + * Specifies whether Microsoft Word displays revisions and comments made to the document with Track Changes enabled. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - startAt?: number; + areRevisionsAndCommentsDisplayed?: boolean; /** - * Specifies the tab position for the specified list level object. + * Specifies whether table gridlines are displayed. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tabPosition?: number; + areTableGridlinesDisplayed?: boolean; /** - * Specifies the position (in points) for the second line of wrapping text for the specified list level object. + * Specifies the column width in Reading mode. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - textPosition?: number; + columnWidth?: Word.ColumnWidth | "Narrow" | "Default" | "Wide"; /** - * Specifies the character inserted after the number for the specified list level. + * Specifies whether all the text in a window is displayed in the same sans-serif font with minimal formatting to speed up display. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - trailingCharacter?: Word.TrailingCharacter | "TrailingTab" | "TrailingSpace" | "TrailingNone"; - } - /** An interface for updating data on the `ListLevelCollection` object, for use in `listLevelCollection.set({ ... })`. */ - export interface ListLevelCollectionUpdateData { - items?: Word.Interfaces.ListLevelData[]; - } - /** An interface for updating data on the `ListTemplate` object, for use in `listTemplate.set({ ... })`. */ - export interface ListTemplateUpdateData { + isDraft?: boolean; /** - * Specifies whether the list template is outline numbered. + * Specifies whether only the first line of body text is shown in outline view. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - outlineNumbered?: boolean; - } - /** An interface for updating data on the `NoteItem` object, for use in `noteItem.set({ ... })`. */ - export interface NoteItemUpdateData { + isFirstLineOnlyDisplayed?: boolean; /** - * Represents the body object of the note item. It's the portion of the text within the footnote or endnote. + * Specifies whether character formatting is visible in outline view. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - body?: Word.Interfaces.BodyUpdateData; + isFormatDisplayed?: boolean; /** - * Represents a footnote or endnote reference in the main document. + * Specifies whether the window is in full-screen view. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - reference?: Word.Interfaces.RangeUpdateData; - } - /** An interface for updating data on the `NoteItemCollection` object, for use in `noteItemCollection.set({ ... })`. */ - export interface NoteItemCollectionUpdateData { - items?: Word.Interfaces.NoteItemData[]; - } - /** An interface for updating data on the `OleFormat` object, for use in `oleFormat.set({ ... })`. */ - export interface OleFormatUpdateData { + isFullScreen?: boolean; /** - * Specifies the class type for the specified OLE object, picture, or field. + * Specifies whether the document is in conflict mode view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - classType?: string; + isInConflictMode?: boolean; /** - * Specifies the icon that is used when the `displayAsIcon` property is `true`. + * Specifies whether Microsoft Word is in Panning mode. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - iconIndex?: number; + isInPanning?: boolean; /** - * Specifies the text displayed below the icon for the OLE object. + * Specifies whether the document is being viewed in reading layout view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - iconLabel?: string; + isInReadingLayout?: boolean; /** - * Specifies the program file in which the icon for the OLE object is stored. + * Specifies whether mail merge data is displayed instead of mail merge fields. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - iconName?: string; + isMailMergeDataView?: boolean; /** - * Specifies whether formatting done in Microsoft Word to the linked OLE object is preserved. + * Specifies whether the text in the document is visible when the header and footer areas are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isFormattingPreservedOnUpdate?: boolean; - } - /** An interface for updating data on the `PageCollection` object, for use in `pageCollection.set({ ... })`. */ - export interface PageCollectionUpdateData { - items?: Word.Interfaces.PageData[]; - } - /** An interface for updating data on the `PaneCollection` object, for use in `paneCollection.set({ ... })`. */ - export interface PaneCollectionUpdateData { - items?: Word.Interfaces.PaneData[]; - } - /** An interface for updating data on the `Window` object, for use in `window.set({ ... })`. */ - export interface WindowUpdateData { + isMainTextLayerVisible?: boolean; /** - * Gets the next document window in the collection of open document windows. + * Specifies whether the pointer is displayed as a magnifying glass in print preview. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - next?: Word.Interfaces.WindowUpdateData; + isPointerShownAsMagnifier?: boolean; /** - * Gets the previous document window in the collection open document windows. + * Specifies whether pages displayed in reading layout view are displayed using the same layout as printed pages. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - previous?: Word.Interfaces.WindowUpdateData; + isReadingLayoutActualView?: boolean; /** - * Specifies whether rulers are displayed for the window or pane. + * Specifies whether XML tags are visible in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areRulersDisplayed?: boolean; + isXmlMarkupVisible?: boolean; /** - * Specifies whether thumbnail images of the pages in a document are displayed along the left side of the Microsoft Word document window. + * Specifies the display mode for tracked changes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areThumbnailsDisplayed?: boolean; + markupMode?: Word.RevisionsMode | "Balloon" | "Inline" | "Mixed"; /** - * Specifies the caption text for the window that is displayed in the title bar of the document or application window. + * Specifies the page color in Reading mode. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - caption?: string; + pageColor?: Word.PageColor | "None" | "Sepia" | "Inverse"; /** - * Specifies the horizontal scroll position as a percentage of the document width. + * Specifies the page movement type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontalPercentScrolled?: number; + pageMovementType?: Word.PageMovementType | "Vertical" | "SideToSide"; /** - * Specifies the default start-up mode for the Japanese Input Method Editor (IME). + * Specifies whether margins are visible or hidden when the document is viewed in Full Screen Reading view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - imemode?: Word.ImeMode | "NoControl" | "On" | "Off" | "Hiragana" | "Katakana" | "KatakanaHalf" | "AlphaFull" | "Alpha" | "HangulFull" | "Hangul"; + readingLayoutTruncateMargins?: Word.ReadingLayoutMargin | "Automatic" | "Suppress" | "Full"; /** - * Specifies whether the document map is visible. + * Specifies the width of the revision balloons. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isDocumentMapVisible?: boolean; + revisionsBalloonWidth?: number; /** - * Specifies whether the email message header is visible in the document window. The default value is `False`. + * Specifies how Microsoft Word measures the width of revision balloons. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isEnvelopeVisible?: boolean; + revisionsBalloonWidthType?: Word.RevisionsBalloonWidthType | "Percent" | "Points"; /** - * Specifies whether a horizontal scroll bar is displayed for the window. + * Specifies the document element displayed in print layout view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isHorizontalScrollBarDisplayed?: boolean; + seekView?: Word.SeekView | "MainDocument" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "CurrentPageHeader" | "CurrentPageFooter"; /** - * Specifies whether the vertical scroll bar appears on the left side of the document window. + * Specifies the active window pane. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isLeftScrollBarDisplayed?: boolean; + splitSpecial?: Word.SpecialPane | "None" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "FootnoteContinuationNotice" | "FootnoteContinuationSeparator" | "FootnoteSeparator" | "EndnoteContinuationNotice" | "EndnoteContinuationSeparator" | "EndnoteSeparator" | "Comments" | "CurrentPageHeader" | "CurrentPageFooter" | "Revisions" | "RevisionsHoriz" | "RevisionsVert"; /** - * Specifies whether the vertical ruler appears on the right side of the document window in print layout view. + * Specifies the view type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isRightRulerDisplayed?: boolean; + type?: Word.ViewType | "Normal" | "Outline" | "Print" | "PrintPreview" | "Master" | "Web" | "Reading" | "Conflict"; + } + /** An interface for updating data on the `Shape` object, for use in `shape.set({ ... })`. */ + export interface ShapeUpdateData { /** - * Specifies whether the window is split into multiple panes. + * Represents the body object of the shape. Only applies to text boxes and geometric shapes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - isSplit?: boolean; + body?: Word.Interfaces.BodyUpdateData; /** - * Specifies whether a vertical ruler is displayed for the window or pane. + * Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "Canvas". 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - isVerticalRulerDisplayed?: boolean; + canvas?: Word.Interfaces.CanvasUpdateData; /** - * Specifies whether a vertical scroll bar is displayed for the window. + * Returns the fill formatting of the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - isVerticalScrollBarDisplayed?: boolean; + fill?: Word.Interfaces.ShapeFillUpdateData; /** - * Specifies whether the window is visible. + * Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - isVisible?: boolean; + parentCanvas?: Word.Interfaces.ShapeUpdateData; /** - * Specifies how Microsoft Word displays source documents after a compare and merge process. + * Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - showSourceDocuments?: Word.ShowSourceDocuments | "None" | "Original" | "Revised" | "Both"; + parentGroup?: Word.Interfaces.ShapeUpdateData; /** - * Specifies the vertical split percentage for the window. + * Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "GroupShape". 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - splitVertical?: number; + shapeGroup?: Word.Interfaces.ShapeGroupUpdateData; /** - * Specifies the width of the style area in points. + * Gets the text frame object of the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - styleAreaWidth?: number; + textFrame?: Word.Interfaces.TextFrameUpdateData; /** - * Specifies the vertical scroll position as a percentage of the document length. + * Returns the text wrap formatting of the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - verticalPercentScrolled?: number; + textWrap?: Word.Interfaces.ShapeTextWrapUpdateData; /** - * Specifies the state of the document window or task window. + * Specifies whether a given shape can overlap other shapes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - windowState?: Word.WindowState | "Normal" | "Maximize" | "Minimize"; - } - /** An interface for updating data on the `WindowCollection` object, for use in `windowCollection.set({ ... })`. */ - export interface WindowCollectionUpdateData { - items?: Word.Interfaces.WindowData[]; - } - /** An interface for updating data on the `Paragraph` object, for use in `paragraph.set({ ... })`. */ - export interface ParagraphUpdateData { + allowOverlap?: boolean; /** - * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. + * Specifies a string that represents the alternative text associated with the shape. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - font?: Word.Interfaces.FontUpdateData; + altTextDescription?: string; /** - * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. + * The geometric shape type of the shape. It will be null if isn't a geometric shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - listItem?: Word.Interfaces.ListItemUpdateData; + geometricShapeType?: Word.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"; /** - * Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return 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}. + * The height, in points, of the shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - listItemOrNullObject?: Word.Interfaces.ListItemUpdateData; + height?: number; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. + * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - shading?: Word.Interfaces.ShadingUniversalUpdateData; + heightRelative?: number; /** - * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. + * The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + left?: number; /** - * Specifies the value, in points, for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. + * The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - firstLineIndent?: number; + leftRelative?: number; /** - * Specifies the left indent value, in points, for the paragraph. + * Specifies if the aspect ratio of this shape is locked. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - leftIndent?: number; + lockAspectRatio?: boolean; /** - * Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. + * The name of the shape. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - lineSpacing?: number; + name?: string; /** - * Specifies the amount of spacing, in grid lines, after the paragraph. + * The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - lineUnitAfter?: number; + relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies the amount of spacing, in grid lines, before the paragraph. + * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - lineUnitBefore?: number; + relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies the outline level for the paragraph. + * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - outlineLevel?: number; + relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies the right indent value, in points, for the paragraph. + * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - rightIndent?: number; + relativeVerticalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies the spacing, in points, after the paragraph. + * Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - spaceAfter?: number; + rotation?: number; /** - * Specifies the spacing, in points, before the paragraph. + * The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - spaceBefore?: number; + top?: number; /** - * Specifies the style name for the paragraph. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - style?: string; + topRelative?: number; /** - * Specifies the built-in style name for the paragraph. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Specifies if the shape is visible. Not applicable to inline shapes. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; - } - /** An interface for updating data on the `ParagraphCollection` object, for use in `paragraphCollection.set({ ... })`. */ - export interface ParagraphCollectionUpdateData { - items?: Word.Interfaces.ParagraphData[]; + visible?: boolean; + /** + * The width, in points, of the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + width?: number; + /** + * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + widthRelative?: number; } - /** An interface for updating data on the `ParagraphFormat` object, for use in `paragraphFormat.set({ ... })`. */ - export interface ParagraphFormatUpdateData { + /** An interface for updating data on the `ShapeGroup` object, for use in `shapeGroup.set({ ... })`. */ + export interface ShapeGroupUpdateData { /** - * Specifies the alignment for the specified paragraphs. + * Gets the Shape object associated with the group. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + shape?: Word.Interfaces.ShapeUpdateData; + } + /** An interface for updating data on the `Canvas` object, for use in `canvas.set({ ... })`. */ + export interface CanvasUpdateData { /** - * Specifies the value (in points) for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. + * Gets the Shape object associated with the canvas. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - firstLineIndent?: number; + shape?: Word.Interfaces.ShapeUpdateData; + } + /** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */ + export interface ShapeCollectionUpdateData { + items?: Word.Interfaces.ShapeData[]; + } + /** An interface for updating data on the `ShapeFill` object, for use in `shapeFill.set({ ... })`. */ + export interface ShapeFillUpdateData { /** - * Specifies whether all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document. + * Specifies the shape fill background color. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - keepTogether?: boolean; + backgroundColor?: string; /** - * Specifies whether the specified paragraph remains on the same page as the paragraph that follows it when Microsoft Word repaginates the document. + * Specifies the shape fill foreground color. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - keepWithNext?: boolean; + foregroundColor?: string; /** - * Specifies the left indent. + * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - leftIndent?: number; + transparency?: number; + } + /** An interface for updating data on the `TextFrame` object, for use in `textFrame.set({ ... })`. */ + export interface TextFrameUpdateData { /** - * Specifies the line spacing (in points) for the specified paragraphs. + * 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: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - lineSpacing?: number; + autoSizeSetting?: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed"; /** - * Specifies the amount of spacing (in gridlines) after the specified paragraphs. + * Represents the bottom margin, in points, of the text frame. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - lineUnitAfter?: number; + bottomMargin?: number; /** - * Specifies the amount of spacing (in gridlines) before the specified paragraphs. + * Represents the left margin, in points, of the text frame. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - lineUnitBefore?: number; + leftMargin?: number; /** - * Specifies whether left and right indents are the same width. + * Returns True if text in the text frame shouldn't rotate when the shape is rotated. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - mirrorIndents?: boolean; + noTextRotation?: boolean; /** - * Specifies the outline level for the specified paragraphs. + * Represents the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - outlineLevel?: Word.OutlineLevel | "OutlineLevel1" | "OutlineLevel2" | "OutlineLevel3" | "OutlineLevel4" | "OutlineLevel5" | "OutlineLevel6" | "OutlineLevel7" | "OutlineLevel8" | "OutlineLevel9" | "OutlineLevelBodyText"; + orientation?: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed"; /** - * Specifies the right indent (in points) for the specified paragraphs. + * Represents the right margin, in points, of the text frame. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - rightIndent?: number; + rightMargin?: number; /** - * Specifies the amount of spacing (in points) after the specified paragraph or text column. + * Represents the top margin, in points, of the text frame. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - spaceAfter?: number; + topMargin?: number; /** - * Specifies the spacing (in points) before the specified paragraphs. + * Represents the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - spaceBefore?: number; + verticalAlignment?: Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom"; /** - * Specifies whether the first and last lines in the specified paragraph remain on the same page as the rest of the paragraph when Microsoft Word repaginates the document. + * Determines whether lines break automatically to fit text inside the shape. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - widowControl?: boolean; + wordWrap?: boolean; } - /** An interface for updating data on the `Range` object, for use in `range.set({ ... })`. */ - export interface RangeUpdateData { + /** An interface for updating data on the `ShapeTextWrap` object, for use in `shapeTextWrap.set({ ... })`. */ + export interface ShapeTextWrapUpdateData { /** - * Gets the text format of the range. Use this to get and set font name, size, color, and other properties. + * Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - font?: Word.Interfaces.FontUpdateData; + bottomDistance?: number; /** - * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. + * Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - listFormat?: Word.Interfaces.ListFormatUpdateData; + leftDistance?: number; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. + * Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - shading?: Word.Interfaces.ShadingUniversalUpdateData; + rightDistance?: number; /** - * Specifies a `CharacterCase` value that represents the case of the text in the range. + * Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farthest from the page margin. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - case?: Word.CharacterCase | "Next" | "Lower" | "Upper" | "TitleWord" | "TitleSentence" | "Toggle" | "HalfWidth" | "FullWidth" | "Katakana" | "Hiragana"; + side?: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest"; /** - * Specifies the character width of the range. + * Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - characterWidth?: Word.CharacterWidth | "Half" | "Full"; + topDistance?: number; /** - * Specifies if the range contains combined characters. + * Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + type?: Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front"; + } + /** An interface for updating data on the `Reviewer` object, for use in `reviewer.set({ ... })`. */ + export interface ReviewerUpdateData { + /** + * Specifies if the `Reviewer` object is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - combineCharacters?: boolean; + isVisible?: boolean; + } + /** An interface for updating data on the `ReviewerCollection` object, for use in `reviewerCollection.set({ ... })`. */ + export interface ReviewerCollectionUpdateData { + items?: Word.Interfaces.ReviewerData[]; + } + /** An interface for updating data on the `RevisionsFilter` object, for use in `revisionsFilter.set({ ... })`. */ + export interface RevisionsFilterUpdateData { /** - * Specifies the ending character position of the range. + * Specifies a `RevisionsMarkup` value that represents the extent of reviewer markup displayed in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - end?: number; + markup?: Word.RevisionsMarkup | "None" | "Simple" | "All"; /** - * Specifies the width (in the current measurement units) in which Microsoft Word fits the text in the current selection or range. + * Specifies a `RevisionsView` value that represents globally whether Word displays the original version of the document or the final version, which might have revisions and formatting changes applied. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fitTextWidth?: number; + view?: Word.RevisionsView | "Final" | "Original"; + } + /** An interface for updating data on the `RepeatingSectionItem` object, for use in `repeatingSectionItem.set({ ... })`. */ + export interface RepeatingSectionItemUpdateData { /** - * Specifies if a grammar check has been run on the range or document. + * Returns the range of this repeating section item, excluding the start and end tags. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - grammarChecked?: boolean; + range?: Word.Interfaces.RangeUpdateData; + } + /** An interface for updating data on the `Revision` object, for use in `revision.set({ ... })`. */ + export interface RevisionUpdateData { /** - * Specifies the proofing status (spelling and grammar checking) of the range. + * Gets a `Range` object that represents the range of text that was moved from one place to another in the document with tracked changes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hasNoProofing?: boolean; + movedRange?: Word.Interfaces.RangeUpdateData; /** - * Specifies the formatting for horizontal text set within vertical text. + * Gets a `Range` object that represents the portion of the document that's contained within a revision mark. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontalInVertical?: Word.HorizontalInVerticalType | "None" | "FitInLine" | "ResizeLine"; + range?: Word.Interfaces.RangeUpdateData; + } + /** An interface for updating data on the `RevisionCollection` object, for use in `revisionCollection.set({ ... })`. */ + export interface RevisionCollectionUpdateData { + items?: Word.Interfaces.RevisionData[]; + } + /** An interface for updating data on the `DatePickerContentControl` object, for use in `datePickerContentControl.set({ ... })`. */ + export interface DatePickerContentControlUpdateData { /** - * Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. Use a '#' to separate the address part from the optional location part. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - hyperlink?: string; + placeholderText?: Word.Interfaces.BuildingBlockUpdateData; /** - * Specifies the ID for the range. + * Gets a `Range` object that represents the contents of the content control in the active document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: string; + range?: Word.Interfaces.RangeUpdateData; /** - * Specifies whether the range of Japanese language text is hiragana or katakana. + * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - kana?: Word.Kana | "Katakana" | "Hiragana"; + xmlMapping?: Word.Interfaces.XmlMappingUpdateData; /** - * Specifies whether Microsoft Word has detected the language of the text in the range. + * Specifies the appearance of the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageDetected?: boolean; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Specifies a `LanguageId` value that represents the language for the range. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + color?: string; /** - * Specifies an East Asian language for the range. + * Specifies a `CalendarType` value that represents the calendar type for the date picker content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + dateCalendarType?: Word.CalendarType | "Western" | "Arabic" | "Hebrew" | "Taiwan" | "Japan" | "Thai" | "Korean" | "SakaEra" | "TranslitEnglish" | "TranslitFrench" | "Umalqura"; /** - * Specifies a language for the range that isn't classified as an East Asian language. + * Specifies the format in which dates are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageIdOther?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + dateDisplayFormat?: string; /** - * Specifies if all nonprinting characters (such as hidden text, tab marks, space marks, and paragraph marks) are displayed. + * Specifies a `LanguageId` that represents the language format for the date displayed in the date picker content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showAll?: boolean; + dateDisplayLocale?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies if spelling has been checked throughout the range or document. + * Specifies a `ContentControlDateStorageFormat` value that represents the format for storage and retrieval of dates when the date picker content control is bound to the XML data store of the active document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spellingChecked?: boolean; + dateStorageFormat?: Word.ContentControlDateStorageFormat | "Text" | "Date" | "DateTime"; /** - * Specifies the starting character position of the range. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - start?: number; + isTemporary?: boolean; /** - * Specifies the style name for the range. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: string; + lockContentControl?: boolean; /** - * Specifies the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + lockContents?: boolean; /** - * Specifies whether Microsoft Word sets two lines of text in one and specifies the characters that enclose the text, if any. + * Specifies a tag to identify the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - twoLinesInOne?: Word.TwoLinesInOneType | "None" | "NoBrackets" | "Parentheses" | "SquareBrackets" | "AngleBrackets" | "CurlyBrackets"; - } - /** An interface for updating data on the `RangeCollection` object, for use in `rangeCollection.set({ ... })`. */ - export interface RangeCollectionUpdateData { - items?: Word.Interfaces.RangeData[]; - } - /** An interface for updating data on the `SearchOptions` object, for use in `searchOptions.set({ ... })`. */ - export interface SearchOptionsUpdateData { + tag?: string; /** - * Specifies a value that indicates whether to ignore all punctuation characters between words. Corresponds to the Ignore punctuation check box in the Find and Replace dialog box. + * Specifies the title for the content control. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ignorePunct?: boolean; + title?: string; + } + /** An interface for updating data on the `PictureContentControl` object, for use in `pictureContentControl.set({ ... })`. */ + export interface PictureContentControlUpdateData { /** - * Specifies a value that indicates whether to ignore all whitespace between words. Corresponds to the Ignore whitespace characters check box in the Find and Replace dialog box. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ignoreSpace?: boolean; + placeholderText?: Word.Interfaces.BuildingBlockUpdateData; /** - * Specifies a value that indicates whether to perform a case sensitive search. Corresponds to the Match case check box in the Find and Replace dialog box. + * Returns a `Range` object that represents the contents of the content control in the active document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - matchCase?: boolean; + range?: Word.Interfaces.RangeUpdateData; /** - * Specifies a value that indicates whether to match words that begin with the search string. Corresponds to the Match prefix check box in the Find and Replace dialog box. + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - matchPrefix?: boolean; + xmlMapping?: Word.Interfaces.XmlMappingUpdateData; /** - * Specifies a value that indicates whether to match words that end with the search string. Corresponds to the Match suffix check box in the Find and Replace dialog box. + * Specifies the appearance of the content control. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - matchSuffix?: boolean; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Specifies a value that indicates whether to find operation only entire words, not text that is part of a larger word. Corresponds to the Find whole words only check box in the Find and Replace dialog box. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - matchWholeWord?: boolean; + color?: string; /** - * Specifies a value that indicates whether the search will be performed using special search operators. Corresponds to the Use wildcards check box in the Find and Replace dialog box. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - matchWildcards?: boolean; - } - /** An interface for updating data on the `Section` object, for use in `section.set({ ... })`. */ - export interface SectionUpdateData { + isTemporary?: boolean; /** - * Gets the body object of the section. This doesn't include the header/footer and other section metadata. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - body?: Word.Interfaces.BodyUpdateData; + lockContentControl?: boolean; /** - * Returns a `PageSetup` object that's associated with the section. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageSetup?: Word.Interfaces.PageSetupUpdateData; + lockContents?: boolean; /** - * Specifies if the section is protected for forms. + * Specifies a tag to identify the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - protectedForForms?: boolean; - } - /** An interface for updating data on the `SectionCollection` object, for use in `sectionCollection.set({ ... })`. */ - export interface SectionCollectionUpdateData { - items?: Word.Interfaces.SectionData[]; - } - /** An interface for updating data on the `Setting` object, for use in `setting.set({ ... })`. */ - export interface SettingUpdateData { + tag?: string; /** - * Specifies the value of the setting. + * Specifies the title for the content control. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - value?: any; - } - /** An interface for updating data on the `SettingCollection` object, for use in `settingCollection.set({ ... })`. */ - export interface SettingCollectionUpdateData { - items?: Word.Interfaces.SettingData[]; - } - /** An interface for updating data on the `StyleCollection` object, for use in `styleCollection.set({ ... })`. */ - export interface StyleCollectionUpdateData { - items?: Word.Interfaces.StyleData[]; + title?: string; } - /** An interface for updating data on the `Style` object, for use in `style.set({ ... })`. */ - export interface StyleUpdateData { + /** An interface for updating data on the `GroupContentControl` object, for use in `groupContentControl.set({ ... })`. */ + export interface GroupContentControlUpdateData { /** - * Specifies a BorderCollection object that represents all the borders for the specified style. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - borders?: Word.Interfaces.BorderCollectionUpdateData; + placeholderText?: Word.Interfaces.BuildingBlockUpdateData; /** - * Gets a font object that represents the character formatting of the specified style. + * Gets a `Range` object that represents the contents of the content control in the active document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontUpdateData; + range?: Word.Interfaces.RangeUpdateData; /** - * Returns a `Frame` object that represents the frame formatting for the style. + * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - frame?: Word.Interfaces.FrameUpdateData; + xmlMapping?: Word.Interfaces.XmlMappingUpdateData; /** - * Specifies a link between a paragraph and a character style. + * Specifies the appearance of the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - linkStyle?: Word.Interfaces.StyleUpdateData; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Gets a ListTemplate object that represents the list formatting for the specified Style object. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listTemplate?: Word.Interfaces.ListTemplateUpdateData; + color?: string; /** - * Gets a ParagraphFormat object that represents the paragraph settings for the specified style. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - paragraphFormat?: Word.Interfaces.ParagraphFormatUpdateData; + isTemporary?: boolean; /** - * Gets a Shading object that represents the shading for the specified style. Not applicable to List style. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shading?: Word.Interfaces.ShadingUpdateData; + lockContentControl?: boolean; /** - * Gets a TableStyle object representing Style properties that can be applied to a table. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tableStyle?: Word.Interfaces.TableStyleUpdateData; + lockContents?: boolean; /** - * Specifies whether the style is automatically redefined based on the selection. + * Specifies a tag to identify the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - automaticallyUpdate?: boolean; + tag?: string; /** - * Specifies the name of an existing style to use as the base formatting of another style. + * Specifies the title for the content control. * * @remarks - * [Api set: WordApi 1.5] - * - * Note: The ability to set `baseStyle` was introduced in WordApi 1.6. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - baseStyle?: string; + title?: string; + } + /** An interface for updating data on the `BuildingBlockGalleryContentControl` object, for use in `buildingBlockGalleryContentControl.set({ ... })`. */ + export interface BuildingBlockGalleryContentControlUpdateData { /** - * Specifies whether the spelling and grammar checker ignores text formatted with this style. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hasProofing?: boolean; + placeholderText?: Word.Interfaces.BuildingBlockUpdateData; /** - * Specifies a `LanguageId` value that represents the language for the style. + * Returns a `Range` object that represents the contents of the content control in the active document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + range?: Word.Interfaces.RangeUpdateData; /** - * Specifies an East Asian language for the style. + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + xmlMapping?: Word.Interfaces.XmlMappingUpdateData; /** - * Specifies whether the style cannot be changed or edited. + * Specifies the appearance of the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - locked?: boolean; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style. + * Specifies the category for the building block content control. * * @remarks - * [Api set: WordApi 1.5] - * - * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - nextParagraphStyle?: string; + buildingBlockCategory?: string; /** - * Specifies whether to remove spacing between paragraphs that are formatted using the same style. + * Specifies a `BuildingBlockType` value that represents the type of building block for the building block content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - noSpaceBetweenParagraphsOfSameStyle?: boolean; + buildingBlockType?: Word.BuildingBlockType | "QuickParts" | "CoverPage" | "Equations" | "Footers" | "Headers" | "PageNumber" | "Tables" | "Watermarks" | "AutoText" | "TextBox" | "PageNumberTop" | "PageNumberBottom" | "PageNumberPage" | "TableOfContents" | "CustomQuickParts" | "CustomCoverPage" | "CustomEquations" | "CustomFooters" | "CustomHeaders" | "CustomPageNumber" | "CustomTables" | "CustomWatermarks" | "CustomAutoText" | "CustomTextBox" | "CustomPageNumberTop" | "CustomPageNumberBottom" | "CustomPageNumberPage" | "CustomTableOfContents" | "Custom1" | "Custom2" | "Custom3" | "Custom4" | "Custom5" | "Bibliography" | "CustomBibliography"; /** - * Specifies the priority. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - priority?: number; + color?: string; /** - * Specifies whether the style corresponds to an available quick style. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - quickStyle?: boolean; + isTemporary?: boolean; /** - * Specifies whether the specified style is made visible as a recommended style in the Styles and in the Styles task pane in Microsoft Word after it's used in the document. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - unhideWhenUsed?: boolean; + lockContentControl?: boolean; /** - * Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - visibility?: boolean; - } - /** An interface for updating data on the `Shading` object, for use in `shading.set({ ... })`. */ - export interface ShadingUpdateData { + lockContents?: boolean; /** - * Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies a tag to identify the content control. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - backgroundPatternColor?: string; + tag?: string; /** - * Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies the title for the content control. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - foregroundPatternColor?: string; + title?: string; + } + /** An interface for updating data on the `RepeatingSectionContentControl` object, for use in `repeatingSectionContentControl.set({ ... })`. */ + export interface RepeatingSectionContentControlUpdateData { /** - * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - texture?: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; - } - /** An interface for updating data on the `ShadingUniversal` object, for use in `shadingUniversal.set({ ... })`. */ - export interface ShadingUniversalUpdateData { + placeholderText?: Word.Interfaces.BuildingBlockUpdateData; /** - * Specifies the color that's applied to the background of the `ShadingUniversal` object. You can provide the value in the '#RRGGBB' format. + * Gets a `Range` object that represents the contents of the content control in the active document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - backgroundPatternColor?: string; + range?: Word.Interfaces.RangeUpdateData; /** - * Specifies the color that's applied to the background of the `ShadingUniversal` object. + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - backgroundPatternColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + xmlapping?: Word.Interfaces.XmlMappingUpdateData; /** - * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. You can provide the value in the '#RRGGBB' format. + * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - foregroundPatternColor?: string; + allowInsertDeleteSection?: boolean; /** - * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. + * Specifies the appearance of the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - foregroundPatternColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - texture?: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; - } - /** An interface for updating data on the `Table` object, for use in `table.set({ ... })`. */ - export interface TableUpdateData { + color?: string; /** - * Gets the font. Use this to get and set font name, size, color, and other properties. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontUpdateData; + isTemporary?: boolean; /** - * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + lockContentControl?: boolean; /** - * Specifies the number of header rows. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - headerRowCount?: number; + lockContents?: boolean; /** - * Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Specifies the name of the repeating section items used in the context menu associated with this repeating section content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + repeatingSectionItemTitle?: string; /** - * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * Specifies a tag to identify the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shadingColor?: string; + tag?: string; /** - * Specifies the style name for the table. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * Specifies the title for the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: string; + title?: string; + } + /** An interface for updating data on the `Frame` object, for use in `frame.set({ ... })`. */ + export interface FrameUpdateData { /** - * Specifies whether the table has banded columns. + * Returns a `Range` object that represents the portion of the document that's contained within the frame. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBandedColumns?: boolean; + range?: Word.Interfaces.RangeUpdateData; /** - * Specifies whether the table has banded rows. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBandedRows?: boolean; + shading?: Word.Interfaces.ShadingUniversalUpdateData; /** - * Specifies the built-in style name for the table. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Specifies the height (in points) of the frame. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + height?: number; /** - * Specifies whether the table has a first column with a special style. + * Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleFirstColumn?: boolean; + heightRule?: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; /** - * Specifies whether the table has a last column with a special style. + * Specifies the horizontal distance between the frame and the surrounding text, in points. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleLastColumn?: boolean; + horizontalDistanceFromText?: number; /** - * Specifies whether the table has a total (last) row with a special style. + * Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleTotalRow?: boolean; + horizontalPosition?: number; /** - * Specifies the text values in the table, as a 2D JavaScript array. + * Specifies if the frame is locked. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - values?: string[][]; + lockAnchor?: boolean; /** - * Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. + * Specifies the relative horizontal position of the frame. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies the width of the table in points. + * Specifies the relative vertical position of the frame. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: number; - } - /** An interface for updating data on the `TableStyle` object, for use in `tableStyle.set({ ... })`. */ - export interface TableStyleUpdateData { + relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies the table's alignment against the page margin. + * Specifies if document text wraps around the frame. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + textWrap?: boolean; /** - * Specifies whether lines in tables formatted with a specified style break across pages. + * Specifies the vertical distance (in points) between the frame and the surrounding text. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - allowBreakAcrossPage?: boolean; + verticalDistanceFromText?: number; /** - * Specifies the amount of space to add between the contents and the bottom borders of the cells. + * Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bottomCellMargin?: number; + verticalPosition?: number; /** - * Specifies the spacing (in points) between the cells in a table style. + * Specifies the width (in points) of the frame. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - cellSpacing?: number; + width?: number; /** - * Specifies the amount of space to add between the contents and the left borders of the cells. + * Specifies the rule used to determine the width of the frame. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftCellMargin?: number; + widthRule?: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; + } + /** An interface for updating data on the `FrameCollection` object, for use in `frameCollection.set({ ... })`. */ + export interface FrameCollectionUpdateData { + items?: Word.Interfaces.FrameData[]; + } + /** An interface for updating data on the `DocumentLibraryVersionCollection` object, for use in `documentLibraryVersionCollection.set({ ... })`. */ + export interface DocumentLibraryVersionCollectionUpdateData { + items?: Word.Interfaces.DocumentLibraryVersionData[]; + } + /** An interface for updating data on the `ListFormat` object, for use in `listFormat.set({ ... })`. */ + export interface ListFormatUpdateData { /** - * Specifies the amount of space to add between the contents and the right borders of the cells. + * Gets the list template associated with the `ListFormat` object. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightCellMargin?: number; + listTemplate?: Word.Interfaces.ListTemplateUpdateData; /** - * Specifies the amount of space to add between the contents and the top borders of the cells. + * Specifies the list level number for the first paragraph for the `ListFormat` object. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topCellMargin?: number; - } - /** An interface for updating data on the `TabStopCollection` object, for use in `tabStopCollection.set({ ... })`. */ - export interface TabStopCollectionUpdateData { - items?: Word.Interfaces.TabStopData[]; - } - /** An interface for updating data on the `TableCollection` object, for use in `tableCollection.set({ ... })`. */ - export interface TableCollectionUpdateData { - items?: Word.Interfaces.TableData[]; + listLevelNumber?: number; } - /** An interface for updating data on the `TableColumn` object, for use in `tableColumn.set({ ... })`. */ - export interface TableColumnUpdateData { + /** An interface for updating data on the `FillFormat` object, for use in `fillFormat.set({ ... })`. */ + export interface FillFormatUpdateData { /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the column. + * Returns a `ColorFormat` object that represents the background color for the fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shading?: Word.Interfaces.ShadingUniversalUpdateData; + backgroundColor?: Word.Interfaces.ColorFormatUpdateData; /** - * Specifies the preferred width (in points or as a percentage of the window width) for the column. - The unit of measurement can be specified by the `preferredWidthType` property. + * Returns a `ColorFormat` object that represents the foreground color for the fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - preferredWidth?: number; + foregroundColor?: Word.Interfaces.ColorFormatUpdateData; /** - * Specifies the preferred unit of measurement to use for the width of the table column. + * Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - preferredWidthType?: Word.PreferredWidthType | "Auto" | "Percent" | "Points"; + gradientAngle?: number; /** - * Specifies the width of the column, in points. + * Specifies if the object, or the formatting applied to it, is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - width?: number; - } - /** An interface for updating data on the `TableColumnCollection` object, for use in `tableColumnCollection.set({ ... })`. */ - export interface TableColumnCollectionUpdateData { - items?: Word.Interfaces.TableColumnData[]; - } - /** An interface for updating data on the `TableRow` object, for use in `tableRow.set({ ... })`. */ - export interface TableRowUpdateData { + isVisible?: boolean; /** - * Gets the font. Use this to get and set font name, size, color, and other properties. + * Specifies whether the fill rotates with the shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontUpdateData; + rotateWithObject?: boolean; /** - * Specifies the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + textureAlignment?: Word.TextureAlignment | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "Center" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; /** - * Specifies the preferred height of the row in points. + * Specifies the horizontal scaling factor for the texture fill. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - preferredHeight?: number; + textureHorizontalScale?: number; /** - * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * Specifies the horizontal offset of the texture from the origin in points. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shadingColor?: string; + textureOffsetX?: number; /** - * Specifies the text values in the row, as a 2D JavaScript array. + * Specifies the vertical offset of the texture. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - values?: string[][]; + textureOffsetY?: number; /** - * Specifies the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'. + * Specifies whether the texture is tiled. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; - } - /** An interface for updating data on the `TableRowCollection` object, for use in `tableRowCollection.set({ ... })`. */ - export interface TableRowCollectionUpdateData { - items?: Word.Interfaces.TableRowData[]; - } - /** An interface for updating data on the `TableCell` object, for use in `tableCell.set({ ... })`. */ - export interface TableCellUpdateData { + textureTile?: boolean; /** - * Gets the body object of the cell. + * Specifies the vertical scaling factor for the texture fill as a value between 0.0 and 1.0. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - body?: Word.Interfaces.BodyUpdateData; + textureVerticalScale?: number; /** - * Specifies the width of the cell's column in points. This is applicable to uniform tables. + * Specifies the degree of transparency of the fill for a shape as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - columnWidth?: number; + transparency?: number; + } + /** An interface for updating data on the `GlowFormat` object, for use in `glowFormat.set({ ... })`. */ + export interface GlowFormatUpdateData { /** - * Specifies the horizontal alignment of the cell. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Returns a `ColorFormat` object that represents the color for a glow effect. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + color?: Word.Interfaces.ColorFormatUpdateData; /** - * Specifies the shading color of the cell. Color is specified in "#RRGGBB" format or by using the color name. + * Specifies the length of the radius for a glow effect. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shadingColor?: string; + radius?: number; /** - * Specifies the text of the cell. + * Specifies the degree of transparency for the glow effect as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - value?: string; + transparency?: number; + } + /** An interface for updating data on the `LineFormat` object, for use in `lineFormat.set({ ... })`. */ + export interface LineFormatUpdateData { /** - * Specifies the vertical alignment of the cell. The value can be 'Top', 'Center', or 'Bottom'. + * Gets a `ColorFormat` object that represents the background color for a patterned line. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; - } - /** An interface for updating data on the `TableCellCollection` object, for use in `tableCellCollection.set({ ... })`. */ - export interface TableCellCollectionUpdateData { - items?: Word.Interfaces.TableCellData[]; - } - /** An interface for updating data on the `TableBorder` object, for use in `tableBorder.set({ ... })`. */ - export interface TableBorderUpdateData { + backgroundColor?: Word.Interfaces.ColorFormatUpdateData; /** - * Specifies the table border color. + * Gets a `ColorFormat` object that represents the foreground color for the line. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - color?: string; + foregroundColor?: Word.Interfaces.ColorFormatUpdateData; /** - * Specifies the type of the table border. + * Specifies the length of the arrowhead at the beginning of the line. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + beginArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; /** - * Specifies the width, in points, of the table border. Not applicable to table border types that have fixed widths. + * Specifies the style of the arrowhead at the beginning of the line. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: number; - } - /** An interface for updating data on the `Template` object, for use in `template.set({ ... })`. */ - export interface TemplateUpdateData { + beginArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; /** - * Specifies the East Asian language to use when breaking lines of text in the document or template. + * Specifies the width of the arrowhead at the beginning of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - farEastLineBreakLanguage?: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; + beginArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; /** - * Specifies the line break control level for the document. + * Specifies the dash style for the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - farEastLineBreakLevel?: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"; + dashStyle?: Word.LineDashStyle | "Mixed" | "Solid" | "SquareDot" | "RoundDot" | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "SysDash" | "SysDot" | "SysDashDot"; /** - * Specifies whether the spelling and grammar checker ignores documents based on this template. + * Specifies the length of the arrowhead at the end of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hasNoProofing?: boolean; + endArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; /** - * Specifies the character spacing adjustment for the template. + * Specifies the style of the arrowhead at the end of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - justificationMode?: Word.JustificationMode | "Expand" | "Compress" | "CompressKana"; + endArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; /** - * Specifies if Microsoft Word kerns half-width Latin characters and punctuation marks in the document. + * Specifies the width of the arrowhead at the end of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - kerningByAlgorithm?: boolean; + endArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; /** - * Specifies a `LanguageId` value that represents the language in the template. + * Specifies if to draw lines inside a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + insetPen?: boolean; /** - * Specifies an East Asian language for the language in the template. + * Specifies if the object, or the formatting applied to it, is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + isVisible?: boolean; /** - * Specifies the kinsoku characters after which Microsoft Word will not break a line. + * Specifies the pattern applied to the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - noLineBreakAfter?: string; + pattern?: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"; /** - * Specifies the kinsoku characters before which Microsoft Word will not break a line. + * Specifies the line format style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - noLineBreakBefore?: string; + style?: Word.LineFormatStyle | "Mixed" | "Single" | "ThinThin" | "ThinThick" | "ThickThin" | "ThickBetweenThin"; /** - * Specifies `true` if the template has not changed since it was last saved, `false` if Microsoft Word displays a prompt to save changes when the document is closed. + * Specifies the degree of transparency of the line as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - saved?: boolean; - } - /** An interface for updating data on the `TemplateCollection` object, for use in `templateCollection.set({ ... })`. */ - export interface TemplateCollectionUpdateData { - items?: Word.Interfaces.TemplateData[]; - } - /** An interface for updating data on the `TrackedChangeCollection` object, for use in `trackedChangeCollection.set({ ... })`. */ - export interface TrackedChangeCollectionUpdateData { - items?: Word.Interfaces.TrackedChangeData[]; - } - /** An interface for updating data on the `View` object, for use in `view.set({ ... })`. */ - export interface ViewUpdateData { + transparency?: number; /** - * Specifies whether all nonprinting characters are displayed. + * Specifies the thickness of the line in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areAllNonprintingCharactersDisplayed?: boolean; + weight?: number; + } + /** An interface for updating data on the `ReflectionFormat` object, for use in `reflectionFormat.set({ ... })`. */ + export interface ReflectionFormatUpdateData { /** - * Gets whether background colors and images are shown when the document is displayed in print layout view. + * Specifies the degree of blur effect applied to the `ReflectionFormat` object as a value between 0.0 and 100.0. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areBackgroundsDisplayed?: boolean; + blur?: number; /** - * Specifies whether Microsoft Word displays the comments in the document. + * Specifies the amount of separation, in points, of the reflected image from the shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areCommentsDisplayed?: boolean; + offset?: number; /** - * Specifies whether Microsoft Word displays connecting lines from the text to the revision and comment balloons. + * Specifies the size of the reflection as a percentage of the reflected shape from 0 to 100. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areConnectingLinesToRevisionsBalloonDisplayed?: boolean; + size?: number; /** - * Specifies whether shading is applied to the ranges in the document that users have permission to modify. + * Specifies the degree of transparency for the reflection effect as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areEditableRangesShaded?: boolean; + transparency?: number; /** - * Specifies whether field codes are displayed. + * Specifies a `ReflectionType` value that represents the type and direction of the lighting for a shape reflection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areFieldCodesDisplayed?: boolean; + type?: Word.ReflectionType | "Mixed" | "None" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9"; + } + /** An interface for updating data on the `ColorFormat` object, for use in `colorFormat.set({ ... })`. */ + export interface ColorFormatUpdateData { /** - * Specifies whether Microsoft Word displays formatting changes made to the document with Track Changes enabled. + * Specifies the brightness of a specified shape color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areFormatChangesDisplayed?: boolean; + brightness?: number; /** - * Specifies whether handwritten ink annotations are shown or hidden. + * Specifies the theme color for a color format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areInkAnnotationsDisplayed?: boolean; + objectThemeColor?: Word.ThemeColorIndex | "NotThemeColor" | "MainDark1" | "MainLight1" | "MainDark2" | "MainLight2" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Hyperlink" | "HyperlinkFollowed" | "Background1" | "Text1" | "Background2" | "Text2"; /** - * Specifies whether Microsoft Word displays insertions and deletions made to the document with Track Changes enabled. + * Specifies the red-green-blue (RGB) value of the specified color. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areInsertionsAndDeletionsDisplayed?: boolean; + rgb?: string; /** - * Gets whether other authors' presence should be visible in the document. + * Specifies the lightening or darkening of a specified shape's color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areOtherAuthorsVisible?: boolean; + tintAndShade?: number; + } + /** An interface for updating data on the `ShadowFormat` object, for use in `shadowFormat.set({ ... })`. */ + export interface ShadowFormatUpdateData { /** - * Specifies whether Microsoft Word displays revisions and comments made to the document with Track Changes enabled. + * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areRevisionsAndCommentsDisplayed?: boolean; + foregroundColor?: Word.Interfaces.ColorFormatUpdateData; /** - * Specifies whether table gridlines are displayed. + * Specifies the blur level for a shadow format as a value between 0.0 and 100.0. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areTableGridlinesDisplayed?: boolean; + blur?: number; /** - * Specifies the column width in Reading mode. + * Specifies whether the object or the formatting applied to it is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - columnWidth?: Word.ColumnWidth | "Narrow" | "Default" | "Wide"; + isVisible?: boolean; /** - * Specifies whether all the text in a window is displayed in the same sans-serif font with minimal formatting to speed up display. + * Specifies `true` if the shadow of the shape appears filled in and is obscured by the shape, even if the shape has no fill, + `false` if the shadow has no fill and the outline of the shadow is visible through the shape if the shape has no fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isDraft?: boolean; + obscured?: boolean; /** - * Specifies whether only the first line of body text is shown in outline view. + * Specifies the horizontal offset (in points) of the shadow from the shape. + A positive value offsets the shadow to the right of the shape; a negative value offsets it to the left. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isFirstLineOnlyDisplayed?: boolean; + offsetX?: number; /** - * Specifies whether character formatting is visible in outline view. + * Specifies the vertical offset (in points) of the shadow from the shape. + A positive value offsets the shadow to the top of the shape; a negative value offsets it to the bottom. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isFormatDisplayed?: boolean; + offsetY?: number; /** - * Specifies whether the window is in full-screen view. + * Specifies whether to rotate the shadow when rotating the shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isFullScreen?: boolean; + rotateWithShape?: boolean; /** - * Specifies whether the document is in conflict mode view. + * Specifies the width of the shadow. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isInConflictMode?: boolean; + size?: number; /** - * Specifies whether Microsoft Word is in Panning mode. + * Specifies the type of shadow formatting to apply to a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isInPanning?: boolean; + style?: Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow"; /** - * Specifies whether the document is being viewed in reading layout view. + * Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isInReadingLayout?: boolean; + transparency?: number; /** - * Specifies whether mail merge data is displayed instead of mail merge fields. + * Specifies the shape shadow type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isMailMergeDataView?: boolean; + type?: Word.ShadowType | "Mixed" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9" | "Type10" | "Type11" | "Type12" | "Type13" | "Type14" | "Type15" | "Type16" | "Type17" | "Type18" | "Type19" | "Type20" | "Type21" | "Type22" | "Type23" | "Type24" | "Type25" | "Type26" | "Type27" | "Type28" | "Type29" | "Type30" | "Type31" | "Type32" | "Type33" | "Type34" | "Type35" | "Type36" | "Type37" | "Type38" | "Type39" | "Type40" | "Type41" | "Type42" | "Type43"; + } + /** An interface for updating data on the `ThreeDimensionalFormat` object, for use in `threeDimensionalFormat.set({ ... })`. */ + export interface ThreeDimensionalFormatUpdateData { /** - * Specifies whether the text in the document is visible when the header and footer areas are displayed. + * Returns a `ColorFormat` object that represents color of the contour of a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isMainTextLayerVisible?: boolean; + contourColor?: Word.Interfaces.ColorFormatUpdateData; /** - * Specifies whether the pointer is displayed as a magnifying glass in print preview. + * Returns a `ColorFormat` object that represents the color of the shape's extrusion. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isPointerShownAsMagnifier?: boolean; + extrusionColor?: Word.Interfaces.ColorFormatUpdateData; /** - * Specifies whether pages displayed in reading layout view are displayed using the same layout as printed pages. + * Specifies the depth of the bottom bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isReadingLayoutActualView?: boolean; + bevelBottomDepth?: number; /** - * Specifies whether XML tags are visible in the document. + * Specifies the inset size for the bottom bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isXmlMarkupVisible?: boolean; + bevelBottomInset?: number; /** - * Specifies the display mode for tracked changes. + * Specifies a `BevelType` value that represents the bevel type for the bottom bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - markupMode?: Word.RevisionsMode | "Balloon" | "Inline" | "Mixed"; + bevelBottomType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; /** - * Specifies the page color in Reading mode. + * Specifies the depth of the top bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageColor?: Word.PageColor | "None" | "Sepia" | "Inverse"; + bevelTopDepth?: number; /** - * Specifies the page movement type. + * Specifies the inset size for the top bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageMovementType?: Word.PageMovementType | "Vertical" | "SideToSide"; + bevelTopInset?: number; /** - * Specifies whether margins are visible or hidden when the document is viewed in Full Screen Reading view. + * Specifies a `BevelType` value that represents the bevel type for the top bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readingLayoutTruncateMargins?: Word.ReadingLayoutMargin | "Automatic" | "Suppress" | "Full"; + bevelTopType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; /** - * Specifies the width of the revision balloons. + * Specifies the width of the contour of a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - revisionsBalloonWidth?: number; + contourWidth?: number; /** - * Specifies how Microsoft Word measures the width of revision balloons. + * Specifies the depth of the shape's extrusion. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - revisionsBalloonWidthType?: Word.RevisionsBalloonWidthType | "Percent" | "Points"; + depth?: number; /** - * Specifies the document element displayed in print layout view. + * Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion) + and automatically changes when the shape's fill changes, or whether the extrusion color is independent of the shape's fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - seekView?: Word.SeekView | "MainDocument" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "CurrentPageHeader" | "CurrentPageFooter"; + extrusionColorType?: Word.ExtrusionColorType | "mixed" | "automatic" | "custom"; /** - * Specifies the active window pane. + * Specifies the amount of perspective for a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - splitSpecial?: Word.SpecialPane | "None" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "FootnoteContinuationNotice" | "FootnoteContinuationSeparator" | "FootnoteSeparator" | "EndnoteContinuationNotice" | "EndnoteContinuationSeparator" | "EndnoteSeparator" | "Comments" | "CurrentPageHeader" | "CurrentPageFooter" | "Revisions" | "RevisionsHoriz" | "RevisionsVert"; + fieldOfView?: number; /** - * Specifies the view type. + * Specifies `true` if the extrusion appears in perspective — that is, if the walls of the extrusion narrow toward a vanishing point, + `false` if the extrusion is a parallel, or orthographic, projection — that is, if the walls don't narrow toward a vanishing point. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.ViewType | "Normal" | "Outline" | "Print" | "PrintPreview" | "Master" | "Web" | "Reading" | "Conflict"; - } - /** An interface for updating data on the `Shape` object, for use in `shape.set({ ... })`. */ - export interface ShapeUpdateData { + isPerspective?: boolean; /** - * Represents the body object of the shape. Only applies to text boxes and geometric shapes. + * Specifies if the specified object, or the formatting applied to it, is visible. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - body?: Word.Interfaces.BodyUpdateData; + isVisible?: boolean; /** - * Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "Canvas". 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 angle of the lighting. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - canvas?: Word.Interfaces.CanvasUpdateData; + lightAngle?: number; /** - * Returns the fill formatting of the shape. + * Specifies a `LightRigType` value that represents the lighting preset. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - fill?: Word.Interfaces.ShapeFillUpdateData; + presetLighting?: Word.LightRigType | "Mixed" | "LegacyFlat1" | "LegacyFlat2" | "LegacyFlat3" | "LegacyFlat4" | "LegacyNormal1" | "LegacyNormal2" | "LegacyNormal3" | "LegacyNormal4" | "LegacyHarsh1" | "LegacyHarsh2" | "LegacyHarsh3" | "LegacyHarsh4" | "ThreePoint" | "Balanced" | "Soft" | "Harsh" | "Flood" | "Contrasting" | "Morning" | "Sunrise" | "Sunset" | "Chilly" | "Freezing" | "Flat" | "TwoPoint" | "Glow" | "BrightRoom"; /** - * Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas. + * Specifies the position of the light source relative to the extrusion. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentCanvas?: Word.Interfaces.ShapeUpdateData; + presetLightingDirection?: Word.PresetLightingDirection | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "None" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; /** - * Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group. + * Specifies the intensity of the extrusion lighting. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentGroup?: Word.Interfaces.ShapeUpdateData; + presetLightingSoftness?: Word.PresetLightingSoftness | "Mixed" | "Dim" | "Normal" | "Bright"; /** - * Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "GroupShape". 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 extrusion surface material. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shapeGroup?: Word.Interfaces.ShapeGroupUpdateData; + presetMaterial?: Word.PresetMaterial | "Mixed" | "Matte" | "Plastic" | "Metal" | "WireFrame" | "Matte2" | "Plastic2" | "Metal2" | "WarmMatte" | "TranslucentPowder" | "Powder" | "DarkEdge" | "SoftEdge" | "Clear" | "Flat" | "SoftMetal"; /** - * Gets the text frame object of the shape. + * Specifies whether text on a shape rotates with shape. `true` rotates the text. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - textFrame?: Word.Interfaces.TextFrameUpdateData; + projectText?: boolean; /** - * Returns the text wrap formatting of the shape. + * Specifies the rotation of the extruded shape around the x-axis in degrees. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - textWrap?: Word.Interfaces.ShapeTextWrapUpdateData; + rotationX?: number; /** - * Specifies whether a given shape can overlap other shapes. + * Specifies the rotation of the extruded shape around the y-axis in degrees. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - allowOverlap?: boolean; + rotationY?: number; /** - * Specifies a string that represents the alternative text associated with the shape. + * Specifies the z-axis rotation of the camera. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - altTextDescription?: string; + rotationZ?: number; /** - * The geometric shape type of the shape. It will be null if isn't a geometric shape. + * Specifies the position on the z-axis for the shape. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - geometricShapeType?: Word.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"; + z?: number; + } + /** An interface for updating data on the `Bibliography` object, for use in `bibliography.set({ ... })`. */ + export interface BibliographyUpdateData { /** - * The height, in points, of the shape. + * Specifies the name of the active style to use for the bibliography. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - height?: number; + bibliographyStyle?: string; + } + /** An interface for updating data on the `SourceCollection` object, for use in `sourceCollection.set({ ... })`. */ + export interface SourceCollectionUpdateData { + items?: Word.Interfaces.SourceData[]; + } + /** An interface for updating data on the `PageSetup` object, for use in `pageSetup.set({ ... })`. */ + export interface PageSetupUpdateData { /** - * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - heightRelative?: number; + lineNumbering?: Word.Interfaces.LineNumberingUpdateData; /** - * The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * Specifies whether Microsoft Word prints the document as a booklet. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - left?: number; + bookFoldPrinting?: boolean; /** - * The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set. + * Specifies the number of pages for each booklet. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftRelative?: number; + bookFoldPrintingSheets?: number; /** - * Specifies if the aspect ratio of this shape is locked. + * Specifies if Microsoft Word reverses the printing order for book fold printing of bidirectional or Asian language documents. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lockAspectRatio?: boolean; + bookFoldReversePrinting?: boolean; /** - * The name of the shape. + * Specifies the distance (in points) between the bottom edge of the page and the bottom boundary of the body text. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - name?: string; + bottomMargin?: number; /** - * The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Specifies the number of characters per line in the document grid. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; + charsLine?: number; /** - * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Specifies whether the first page has a different header and footer. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + differentFirstPageHeaderFooter?: boolean; /** - * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. + * Specifies the distance between the footer and the bottom of the page in points. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + footerDistance?: number; /** - * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Specifies the amount (in points) of extra margin space added to each page in a document or section for binding. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - relativeVerticalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + gutter?: number; /** - * Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape. + * Specifies on which side the gutter appears in a document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rotation?: number; + gutterPosition?: Word.GutterPosition | "Left" | "Right" | "Top"; /** - * The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * Specifies whether Microsoft Word uses gutters for the current document based on a right-to-left language or a left-to-right language. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - top?: number; + gutterStyle?: Word.GutterStyle | "Bidirectional" | "Latin"; /** - * The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set. + * Specifies the distance between the header and the top of the page in points. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topRelative?: number; + headerDistance?: number; /** - * Specifies if the shape is visible. Not applicable to inline shapes. + * Specifies the layout mode for the current document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - visible?: boolean; + layoutMode?: Word.LayoutMode | "Default" | "Grid" | "LineGrid" | "Genko"; /** - * The width, in points, of the shape. + * Specifies the distance (in points) between the left edge of the page and the left boundary of the body text. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: number; + leftMargin?: number; /** - * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * Specifies the number of lines per page in the document grid. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - widthRelative?: number; - } - /** An interface for updating data on the `ShapeGroup` object, for use in `shapeGroup.set({ ... })`. */ - export interface ShapeGroupUpdateData { + linesPage?: number; /** - * Gets the Shape object associated with the group. + * Specifies if the inside and outside margins of facing pages are the same width. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shape?: Word.Interfaces.ShapeUpdateData; - } - /** An interface for updating data on the `Canvas` object, for use in `canvas.set({ ... })`. */ - export interface CanvasUpdateData { + mirrorMargins?: boolean; /** - * Gets the Shape object associated with the canvas. + * Specifies whether odd and even pages have different headers and footers. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shape?: Word.Interfaces.ShapeUpdateData; - } - /** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */ - export interface ShapeCollectionUpdateData { - items?: Word.Interfaces.ShapeData[]; - } - /** An interface for updating data on the `ShapeFill` object, for use in `shapeFill.set({ ... })`. */ - export interface ShapeFillUpdateData { + oddAndEvenPagesHeaderFooter?: boolean; /** - * Specifies the shape fill background color. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies the orientation of the page. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - backgroundColor?: string; + orientation?: Word.PageOrientation | "Portrait" | "Landscape"; /** - * Specifies the shape fill foreground color. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies the page height in points. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - foregroundColor?: string; + pageHeight?: number; /** - * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type. + * Specifies the page width in points. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - transparency?: number; - } - /** An interface for updating data on the `TextFrame` object, for use in `textFrame.set({ ... })`. */ - export interface TextFrameUpdateData { + pageWidth?: number; /** - * 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. + * Specifies the paper size of the page. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - autoSizeSetting?: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed"; + paperSize?: Word.PaperSize | "Size10x14" | "Size11x17" | "Letter" | "LetterSmall" | "Legal" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "CSheet" | "DSheet" | "ESheet" | "FanfoldLegalGerman" | "FanfoldStdGerman" | "FanfoldUS" | "Folio" | "Ledger" | "Note" | "Quarto" | "Statement" | "Tabloid" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC5" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeDL" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "Custom"; /** - * Represents the bottom margin, in points, of the text frame. + * Specifies the distance (in points) between the right edge of the page and the right boundary of the body text. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bottomMargin?: number; + rightMargin?: number; /** - * Represents the left margin, in points, of the text frame. + * Specifies the reading order and alignment for the specified sections. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftMargin?: number; + sectionDirection?: Word.SectionDirection | "RightToLeft" | "LeftToRight"; /** - * Returns True if text in the text frame shouldn't rotate when the shape is rotated. + * Specifies the type of section break for the specified object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - noTextRotation?: boolean; + sectionStart?: Word.SectionStart | "Continuous" | "NewColumn" | "NewPage" | "EvenPage" | "OddPage"; /** - * Represents the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. + * Specifies whether to show the grid. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - orientation?: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed"; + showGrid?: boolean; /** - * Represents the right margin, in points, of the text frame. + * Specifies if endnotes are printed at the end of the next section that doesn't suppress endnotes. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightMargin?: number; + suppressEndnotes?: boolean; /** - * Represents the top margin, in points, of the text frame. + * Specifies the top margin of the page in points. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ topMargin?: number; /** - * Represents the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. + * Specifies whether to print two pages per sheet. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - verticalAlignment?: Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom"; + twoPagesOnOne?: boolean; /** - * Determines whether lines break automatically to fit text inside the shape. + * Specifies the vertical alignment of text on each page in a document or section. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - wordWrap?: boolean; + verticalAlignment?: Word.PageSetupVerticalAlignment | "Top" | "Center" | "Justify" | "Bottom"; } - /** An interface for updating data on the `ShapeTextWrap` object, for use in `shapeTextWrap.set({ ... })`. */ - export interface ShapeTextWrapUpdateData { + /** An interface for updating data on the `LineNumbering` object, for use in `lineNumbering.set({ ... })`. */ + export interface LineNumberingUpdateData { /** - * Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape. + * Specifies the numeric increment for line numbers. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bottomDistance?: number; + countBy?: number; /** - * Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape. + * Specifies the distance (in points) between the right edge of line numbers and the left edge of the document text. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftDistance?: number; + distanceFromText?: number; /** - * Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape. + * Specifies if line numbering is active for the specified document, section, or sections. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightDistance?: number; + isActive?: boolean; /** - * Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farthest from the page margin. + * Specifies the way line numbering runs; that is, whether it starts over at the beginning of a new page or section, or runs continuously. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - side?: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest"; + restartMode?: Word.NumberingRule | "RestartContinuous" | "RestartSection" | "RestartPage"; /** - * Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape. + * Specifies the starting line number. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topDistance?: number; + startingNumber?: number; + } + /** An interface for updating data on the `TextColumnCollection` object, for use in `textColumnCollection.set({ ... })`. */ + export interface TextColumnCollectionUpdateData { + items?: Word.Interfaces.TextColumnData[]; + } + /** An interface for updating data on the `TextColumn` object, for use in `textColumn.set({ ... })`. */ + export interface TextColumnUpdateData { /** - * Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details. + * Specifies the amount of spacing (in points) after the specified paragraph or text column. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front"; - } - /** An interface for updating data on the `Reviewer` object, for use in `reviewer.set({ ... })`. */ - export interface ReviewerUpdateData { + spaceAfter?: number; /** - * Specifies if the `Reviewer` object is visible. + * Specifies the width, in points, of the specified text columns. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; - } - /** An interface for updating data on the `ReviewerCollection` object, for use in `reviewerCollection.set({ ... })`. */ - export interface ReviewerCollectionUpdateData { - items?: Word.Interfaces.ReviewerData[]; + width?: number; } - /** An interface for updating data on the `RevisionsFilter` object, for use in `revisionsFilter.set({ ... })`. */ - export interface RevisionsFilterUpdateData { + /** An interface for updating data on the `Selection` object, for use in `selection.set({ ... })`. */ + export interface SelectionUpdateData { /** - * Specifies a `RevisionsMarkup` value that represents the extent of reviewer markup displayed in the document. + * Specifies the ending character position of the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - markup?: Word.RevisionsMarkup | "None" | "Simple" | "All"; + end?: number; /** - * Specifies a `RevisionsView` value that represents globally whether Word displays the original version of the document or the final version, which might have revisions and formatting changes applied. + * Specifies the width in which Word fits the text in the current selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - view?: Word.RevisionsView | "Final" | "Original"; - } - /** An interface for updating data on the `RepeatingSectionItem` object, for use in `repeatingSectionItem.set({ ... })`. */ - export interface RepeatingSectionItemUpdateData { + fitTextWidth?: number; /** - * Returns the range of this repeating section item, excluding the start and end tags. + * Specifies whether column selection mode is active. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeUpdateData; - } - /** An interface for updating data on the `DatePickerContentControl` object, for use in `datePickerContentControl.set({ ... })`. */ - export interface DatePickerContentControlUpdateData { + isColumnSelectModeActive?: boolean; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Specifies whether Extend mode is active. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: Word.Interfaces.BuildingBlockUpdateData; + isExtendModeActive?: boolean; /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * Specifies whether the beginning of the selection is active. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeUpdateData; + isStartActive?: boolean; /** - * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Specifies whether Word has detected the language of the selected text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingUpdateData; + languageDetected?: boolean; /** - * Specifies the appearance of the content control. + * Specifies the orientation of text in the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + orientation?: Word.TextOrientation | "Horizontal" | "Upward" | "Downward" | "VerticalFarEast" | "HorizontalRotatedFarEast" | "Vertical"; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Specifies the starting character position of the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + start?: number; /** - * Specifies a `CalendarType` value that represents the calendar type for the date picker content control. + * Specifies the text in the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateCalendarType?: Word.CalendarType | "Western" | "Arabic" | "Hebrew" | "Taiwan" | "Japan" | "Thai" | "Korean" | "SakaEra" | "TranslitEnglish" | "TranslitFrench" | "Umalqura"; + text?: string; + } + /** An interface for updating data on the `RangeScopedCollection` object, for use in `rangeScopedCollection.set({ ... })`. */ + export interface RangeScopedCollectionUpdateData { + items?: Word.Interfaces.RangeData[]; + } + /** An interface for updating data on the `Bookmark` object, for use in `bookmark.set({ ... })`. */ + export interface BookmarkUpdateData { /** - * Specifies the format in which dates are displayed. + * Returns a `Range` object that represents the portion of the document that's contained in the `Bookmark` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateDisplayFormat?: string; + range?: Word.Interfaces.RangeUpdateData; /** - * Specifies a `LanguageId` that represents the language format for the date displayed in the date picker content control. + * Specifies the ending character position of the bookmark. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateDisplayLocale?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + end?: number; /** - * Specifies a `ContentControlDateStorageFormat` value that represents the format for storage and retrieval of dates when the date picker content control is bound to the XML data store of the active document. + * Specifies the starting character position of the bookmark. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateStorageFormat?: Word.ContentControlDateStorageFormat | "Text" | "Date" | "DateTime"; + start?: number; + } + /** An interface for updating data on the `BookmarkCollection` object, for use in `bookmarkCollection.set({ ... })`. */ + export interface BookmarkCollectionUpdateData { + items?: Word.Interfaces.BookmarkData[]; + } + /** An interface for updating data on the `Index` object, for use in `index.set({ ... })`. */ + export interface IndexUpdateData { /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Returns a `Range` object that represents the portion of the document that is contained within the index. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + range?: Word.Interfaces.RangeUpdateData; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Specifies the leader character between entries in the index and their associated page numbers. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + } + /** An interface for updating data on the `IndexCollection` object, for use in `indexCollection.set({ ... })`. */ + export interface IndexCollectionUpdateData { + items?: Word.Interfaces.IndexData[]; + } + /** An interface for updating data on the `ListTemplateCollection` object, for use in `listTemplateCollection.set({ ... })`. */ + export interface ListTemplateCollectionUpdateData { + items?: Word.Interfaces.ListTemplateData[]; + } + /** An interface for updating data on the `ListTemplateGalleryCollection` object, for use in `listTemplateGalleryCollection.set({ ... })`. */ + export interface ListTemplateGalleryCollectionUpdateData { + items?: Word.Interfaces.ListTemplateGalleryData[]; + } + /** An interface describing the data returned by calling `editor.toJSON()`. */ + export interface EditorData { /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Gets a `Range` object that represents the next range that the editor has permissions to modify. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + nextRange?: Word.Interfaces.RangeData; /** - * Specifies a tag to identify the content control. + * Gets a `Range` object that represents the portion of the document that's contained in the `Editor` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: string; + range?: Word.Interfaces.RangeData; /** - * Specifies the title for the content control. + * Gets the identifier for the `Editor` object when the parent document is saved as a webpage. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: string; - } - /** An interface for updating data on the `PictureContentControl` object, for use in `pictureContentControl.set({ ... })`. */ - export interface PictureContentControlUpdateData { + id?: string; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Gets the name of the editor. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: Word.Interfaces.BuildingBlockUpdateData; + name?: string; + } + /** An interface describing the data returned by calling `conflictCollection.toJSON()`. */ + export interface ConflictCollectionData { + items?: Word.Interfaces.ConflictData[]; + } + /** An interface describing the data returned by calling `conflict.toJSON()`. */ + export interface ConflictData { /** - * Returns a `Range` object that represents the contents of the content control in the active document. + * Gets a `Range` object that represents the portion of the document that's contained in the `Conflict` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeUpdateData; + range?: Word.Interfaces.RangeData; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Gets the `RevisionType` for the `Conflict` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingUpdateData; + type?: Word.RevisionType | "None" | "Insert" | "Delete" | "Property" | "ParagraphNumber" | "DisplayField" | "Reconcile" | "Conflict" | "Style" | "Replace" | "ParagraphProperty" | "TableProperty" | "SectionProperty" | "StyleDefinition" | "MovedFrom" | "MovedTo" | "CellInsertion" | "CellDeletion" | "CellMerge" | "CellSplit" | "ConflictInsert" | "ConflictDelete"; + } + /** An interface describing the data returned by calling `critiqueAnnotation.toJSON()`. */ + export interface CritiqueAnnotationData { /** - * Specifies the appearance of the content control. + * Gets the critique that was passed when the annotation was inserted. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + critique?: Word.Critique; + } + /** An interface describing the data returned by calling `annotation.toJSON()`. */ + export interface AnnotationData { /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - color?: string; + id?: string; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Gets the state of the annotation. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - isTemporary?: boolean; + state?: Word.AnnotationState | "Created" | "Accepted" | "Rejected"; + } + /** An interface describing the data returned by calling `annotationCollection.toJSON()`. */ + export interface AnnotationCollectionData { + items?: Word.Interfaces.AnnotationData[]; + } + /** An interface describing the data returned by calling `application.toJSON()`. */ + export interface ApplicationData { /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Returns a `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + bibliography?: Word.Interfaces.BibliographyData; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Returns a `ListTemplateGalleryCollection` object that represents all the list template galleries in Microsoft Word. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + listTemplateGalleries?: Word.Interfaces.ListTemplateGalleryData[]; /** - * Specifies a tag to identify the content control. + * Specifies if Microsoft Word automatically detects the language you are using as you type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: string; + checkLanguage?: boolean; /** - * Specifies the title for the content control. + * Gets a `LanguageId` value that represents the language selected for the Microsoft Word user interface. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: string; + language?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; } - /** An interface for updating data on the `GroupContentControl` object, for use in `groupContentControl.set({ ... })`. */ - export interface GroupContentControlUpdateData { + /** An interface describing the data returned by calling `body.toJSON()`. */ + export interface BodyData { /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Gets the collection of rich text content control objects in the body. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - placeholderText?: Word.Interfaces.BuildingBlockUpdateData; + contentControls?: Word.Interfaces.ContentControlData[]; /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * Gets the collection of field objects in the body. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - range?: Word.Interfaces.RangeUpdateData; + fields?: Word.Interfaces.FieldData[]; /** - * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - xmlMapping?: Word.Interfaces.XmlMappingUpdateData; + font?: Word.Interfaces.FontData; /** - * Specifies the appearance of the content control. + * Gets the collection of InlinePicture objects in the body. The collection doesn't include floating images. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + inlinePictures?: Word.Interfaces.InlinePictureData[]; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Gets the collection of list objects in the body. + * + * @remarks + * [Api set: WordApi 1.3] + */ + lists?: Word.Interfaces.ListData[]; + /** + * Gets the collection of paragraph objects in the body. + * + * @remarks + * [Api set: WordApi 1.1] + * + * Important: Paragraphs in tables aren't returned for requirement sets 1.1 and 1.2. From requirement set 1.3, paragraphs in tables are also returned. + */ + paragraphs?: Word.Interfaces.ParagraphData[]; + /** + * Gets the collection of shape objects in the body, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + shapes?: Word.Interfaces.ShapeData[]; + /** + * Gets the collection of table objects in the body. + * + * @remarks + * [Api set: WordApi 1.3] + */ + tables?: Word.Interfaces.TableData[]; + /** + * Specifies the style name for the body. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * + * @remarks + * [Api set: WordApi 1.1] + */ + style?: string; + /** + * Specifies the built-in style name for the body. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + /** + * Gets the text of the body. Use the insertText method to insert text. + * + * @remarks + * [Api set: WordApi 1.1] + */ + text?: string; + /** + * Gets the type of the body. The type can be 'MainDoc', 'Section', 'Header', 'Footer', or 'TableCell'. Additional types ‘Footnote’, ‘Endnote’, and ‘NoteItem’ are supported in WordApiOnline 1.1 and later. + * + * @remarks + * [Api set: WordApi 1.3] + */ + type?: Word.BodyType | "Unknown" | "MainDoc" | "Section" | "Header" | "Footer" | "TableCell" | "Footnote" | "Endnote" | "NoteItem" | "Shape"; + } + /** An interface describing the data returned by calling `border.toJSON()`. */ + export interface BorderData { + /** + * Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + color?: string; + /** + * Gets the location of the border. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + location?: Word.BorderLocation | "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"; + /** + * Specifies the border type for the border. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + type?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + /** + * Specifies whether the border is visible. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + visible?: boolean; + /** + * Specifies the width for the border. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + width?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed"; + } + /** An interface describing the data returned by calling `borderUniversal.toJSON()`. */ + export interface BorderUniversalData { + /** + * Specifies the graphical page-border design for the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + artStyle?: Word.PageBorderArt | "Apples" | "MapleMuffins" | "CakeSlice" | "CandyCorn" | "IceCreamCones" | "ChampagneBottle" | "PartyGlass" | "ChristmasTree" | "Trees" | "PalmsColor" | "Balloons3Colors" | "BalloonsHotAir" | "PartyFavor" | "ConfettiStreamers" | "Hearts" | "HeartBalloon" | "Stars3D" | "StarsShadowed" | "Stars" | "Sun" | "Earth2" | "Earth1" | "PeopleHats" | "Sombrero" | "Pencils" | "Packages" | "Clocks" | "Firecrackers" | "Rings" | "MapPins" | "Confetti" | "CreaturesButterfly" | "CreaturesLadyBug" | "CreaturesFish" | "BirdsFlight" | "ScaredCat" | "Bats" | "FlowersRoses" | "FlowersRedRose" | "Poinsettias" | "Holly" | "FlowersTiny" | "FlowersPansy" | "FlowersModern2" | "FlowersModern1" | "WhiteFlowers" | "Vine" | "FlowersDaisies" | "FlowersBlockPrint" | "DecoArchColor" | "Fans" | "Film" | "Lightning1" | "Compass" | "DoubleD" | "ClassicalWave" | "ShadowedSquares" | "TwistedLines1" | "Waveline" | "Quadrants" | "CheckedBarColor" | "Swirligig" | "PushPinNote1" | "PushPinNote2" | "Pumpkin1" | "EggsBlack" | "Cup" | "HeartGray" | "GingerbreadMan" | "BabyPacifier" | "BabyRattle" | "Cabins" | "HouseFunky" | "StarsBlack" | "Snowflakes" | "SnowflakeFancy" | "Skyrocket" | "Seattle" | "MusicNotes" | "PalmsBlack" | "MapleLeaf" | "PaperClips" | "ShorebirdTracks" | "People" | "PeopleWaving" | "EclipsingSquares2" | "Hypnotic" | "DiamondsGray" | "DecoArch" | "DecoBlocks" | "CirclesLines" | "Papyrus" | "Woodwork" | "WeavingBraid" | "WeavingRibbon" | "WeavingAngles" | "ArchedScallops" | "Safari" | "CelticKnotwork" | "CrazyMaze" | "EclipsingSquares1" | "Birds" | "FlowersTeacup" | "Northwest" | "Southwest" | "Tribal6" | "Tribal4" | "Tribal3" | "Tribal2" | "Tribal5" | "XIllusions" | "ZanyTriangles" | "Pyramids" | "PyramidsAbove" | "ConfettiGrays" | "ConfettiOutline" | "ConfettiWhite" | "Mosaic" | "Lightning2" | "HeebieJeebies" | "LightBulb" | "Gradient" | "TriangleParty" | "TwistedLines2" | "Moons" | "Ovals" | "DoubleDiamonds" | "ChainLink" | "Triangles" | "Tribal1" | "MarqueeToothed" | "SharksTeeth" | "Sawtooth" | "SawtoothGray" | "PostageStamp" | "WeavingStrips" | "ZigZag" | "CrossStitch" | "Gems" | "CirclesRectangles" | "CornerTriangles" | "CreaturesInsects" | "ZigZagStitch" | "Checkered" | "CheckedBarBlack" | "Marquee" | "BasicWhiteDots" | "BasicWideMidline" | "BasicWideOutline" | "BasicWideInline" | "BasicThinLines" | "BasicWhiteDashes" | "BasicWhiteSquares" | "BasicBlackSquares" | "BasicBlackDashes" | "BasicBlackDots" | "StarsTop" | "CertificateBanner" | "Handmade1" | "Handmade2" | "TornPaper" | "TornPaperBlack" | "CouponCutoutDashes" | "CouponCutoutDots"; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Specifies the width (in points) of the graphical page border specified in the `artStyle` property. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + artWidth?: number; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Specifies the color for the `BorderUniversal` object. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + color?: string; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Specifies the color for the `BorderUniversal` or {@link Word.Font} object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + colorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Specifies a tag to identify the content control. + * Returns `true` if an inside border can be applied to the specified object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: string; + inside?: boolean; /** - * Specifies the title for the content control. + * Specifies whether the border is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: string; - } - /** An interface for updating data on the `BuildingBlockGalleryContentControl` object, for use in `buildingBlockGalleryContentControl.set({ ... })`. */ - export interface BuildingBlockGalleryContentControlUpdateData { + isVisible?: boolean; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Specifies the line style of the border. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: Word.Interfaces.BuildingBlockUpdateData; + lineStyle?: Word.BorderLineStyle | "None" | "Single" | "Dot" | "DashSmallGap" | "DashLargeGap" | "DashDot" | "DashDotDot" | "Double" | "Triple" | "ThinThickSmallGap" | "ThickThinSmallGap" | "ThinThickThinSmallGap" | "ThinThickMedGap" | "ThickThinMedGap" | "ThinThickThinMedGap" | "ThinThickLargeGap" | "ThickThinLargeGap" | "ThinThickThinLargeGap" | "SingleWavy" | "DoubleWavy" | "DashDotStroked" | "Emboss3D" | "Engrave3D" | "Outset" | "Inset"; /** - * Returns a `Range` object that represents the contents of the content control in the active document. + * Specifies the line width of an object's border. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeUpdateData; + lineWidth?: Word.LineWidth | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600"; + } + /** An interface describing the data returned by calling `borderCollection.toJSON()`. */ + export interface BorderCollectionData { + items?: Word.Interfaces.BorderData[]; + } + /** An interface describing the data returned by calling `borderUniversalCollection.toJSON()`. */ + export interface BorderUniversalCollectionData { + items?: Word.Interfaces.BorderUniversalData[]; + } + /** An interface describing the data returned by calling `break.toJSON()`. */ + export interface BreakData { /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Returns a `Range` object that represents the portion of the document that's contained in the break. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingUpdateData; + range?: Word.Interfaces.RangeData; /** - * Specifies the appearance of the content control. + * Returns the page number on which the break occurs. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + pageIndex?: number; + } + /** An interface describing the data returned by calling `breakCollection.toJSON()`. */ + export interface BreakCollectionData { + items?: Word.Interfaces.BreakData[]; + } + /** An interface describing the data returned by calling `buildingBlock.toJSON()`. */ + export interface BuildingBlockData { /** - * Specifies the category for the building block content control. + * Specifies the description for the building block. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - buildingBlockCategory?: string; + description?: string; /** - * Specifies a `BuildingBlockType` value that represents the type of building block for the building block content control. + * Returns the internal identification number for the building block. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - buildingBlockType?: Word.BuildingBlockType | "QuickParts" | "CoverPage" | "Equations" | "Footers" | "Headers" | "PageNumber" | "Tables" | "Watermarks" | "AutoText" | "TextBox" | "PageNumberTop" | "PageNumberBottom" | "PageNumberPage" | "TableOfContents" | "CustomQuickParts" | "CustomCoverPage" | "CustomEquations" | "CustomFooters" | "CustomHeaders" | "CustomPageNumber" | "CustomTables" | "CustomWatermarks" | "CustomAutoText" | "CustomTextBox" | "CustomPageNumberTop" | "CustomPageNumberBottom" | "CustomPageNumberPage" | "CustomTableOfContents" | "Custom1" | "Custom2" | "Custom3" | "Custom4" | "Custom5" | "Bibliography" | "CustomBibliography"; + id?: string; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Returns the position of this building block in a collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + index?: number; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Specifies a `DocPartInsertType` value that represents how to insert the contents of the building block into the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + insertType?: Word.DocPartInsertType | "Content" | "Paragraph" | "Page"; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Specifies the name of the building block. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + name?: string; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Specifies the contents of the building block. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + value?: string; + } + /** An interface describing the data returned by calling `buildingBlockCategory.toJSON()`. */ + export interface BuildingBlockCategoryData { /** - * Specifies a tag to identify the content control. + * Returns the position of the `BuildingBlockCategory` object in a collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: string; + index?: number; /** - * Specifies the title for the content control. + * Returns the name of the `BuildingBlockCategory` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: string; + name?: string; } - /** An interface for updating data on the `RepeatingSectionContentControl` object, for use in `repeatingSectionContentControl.set({ ... })`. */ - export interface RepeatingSectionContentControlUpdateData { + /** An interface describing the data returned by calling `buildingBlockTypeItem.toJSON()`. */ + export interface BuildingBlockTypeItemData { /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Returns the position of an item in a collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: Word.Interfaces.BuildingBlockUpdateData; + index?: number; /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * Returns the localized name of a building block type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeUpdateData; + name?: string; + } + /** An interface describing the data returned by calling `checkboxContentControl.toJSON()`. */ + export interface CheckboxContentControlData { /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Specifies the current state of the checkbox. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - xmlapping?: Word.Interfaces.XmlMappingUpdateData; + isChecked?: boolean; + } + /** An interface describing the data returned by calling `coauthoringLock.toJSON()`. */ + export interface CoauthoringLockData { /** - * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. + * Gets the owner of the lock. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - allowInsertDeleteSection?: boolean; + owner?: Word.Interfaces.CoauthorData; /** - * Specifies the appearance of the content control. + * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringLock` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + range?: Word.Interfaces.RangeData; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Gets a `CoauthoringLockType` value that represents the lock type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + type?: Word.CoauthoringLockType | "None" | "Reservation" | "Ephemeral" | "Changed"; + } + /** An interface describing the data returned by calling `coauthoringLockCollection.toJSON()`. */ + export interface CoauthoringLockCollectionData { + items?: Word.Interfaces.CoauthoringLockData[]; + } + /** An interface describing the data returned by calling `coauthor.toJSON()`. */ + export interface CoauthorData { /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Gets a `CoauthoringLockCollection` object that represents the locks in the document that are associated with this coauthor. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + locks?: Word.Interfaces.CoauthoringLockData[]; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Gets the email address of the coauthor. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + emailAddress?: string; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Gets the unique identifier for the `Coauthor` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + id?: string; /** - * Specifies the name of the repeating section items used in the context menu associated with this repeating section content control. + * Gets whether this author represents the current user. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - repeatingSectionItemTitle?: string; + isMe?: boolean; /** - * Specifies a tag to identify the content control. + * Gets the display name of the coauthor. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: string; + name?: string; + } + /** An interface describing the data returned by calling `coauthorCollection.toJSON()`. */ + export interface CoauthorCollectionData { + items?: Word.Interfaces.CoauthorData[]; + } + /** An interface describing the data returned by calling `coauthoring.toJSON()`. */ + export interface CoauthoringData { /** - * Specifies the title for the content control. + * Gets a `CoauthorCollection` object that represents all the coauthors currently editing the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: string; - } - /** An interface for updating data on the `Frame` object, for use in `frame.set({ ... })`. */ - export interface FrameUpdateData { + authors?: Word.Interfaces.CoauthorData[]; /** - * Returns a `Range` object that represents the portion of the document that's contained within the frame. + * Gets a `ConflictCollection` object that represents all the conflicts in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeUpdateData; + conflicts?: Word.Interfaces.ConflictData[]; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. + * Gets a `CoauthoringLockCollection` object that represents the locks in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shading?: Word.Interfaces.ShadingUniversalUpdateData; + locks?: Word.Interfaces.CoauthoringLockData[]; /** - * Specifies the height (in points) of the frame. + * Gets a `Coauthor` object that represents the current user. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - height?: number; + me?: Word.Interfaces.CoauthorData; /** - * Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. + * Gets a `CoauthoringUpdateCollection` object that represents the most recent updates that were merged into the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - heightRule?: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; + updates?: Word.Interfaces.CoauthoringUpdateData[]; /** - * Specifies the horizontal distance between the frame and the surrounding text, in points. + * Gets whether this document can be coauthored. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontalDistanceFromText?: number; + canCoauthor?: boolean; /** - * Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property. + * Gets whether the document can be automatically merged. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontalPosition?: number; + canMerge?: boolean; /** - * Specifies if the frame is locked. + * Gets whether the document has pending updates that have not been accepted. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockAnchor?: boolean; + pendingUpdates?: boolean; + } + /** An interface describing the data returned by calling `coauthoringUpdate.toJSON()`. */ + export interface CoauthoringUpdateData { /** - * Specifies the relative horizontal position of the frame. + * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringUpdate` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; + range?: Word.Interfaces.RangeData; + } + /** An interface describing the data returned by calling `coauthoringUpdateCollection.toJSON()`. */ + export interface CoauthoringUpdateCollectionData { + items?: Word.Interfaces.CoauthoringUpdateData[]; + } + /** An interface describing the data returned by calling `comment.toJSON()`. */ + export interface CommentData { /** - * Specifies the relative vertical position of the frame. + * Specifies the comment's content range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + contentRange?: Word.Interfaces.CommentContentRangeData; /** - * Specifies if document text wraps around the frame. + * Gets the collection of reply objects associated with the comment. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - textWrap?: boolean; + replies?: Word.Interfaces.CommentReplyData[]; /** - * Specifies the vertical distance (in points) between the frame and the surrounding text. + * Gets the email of the comment's author. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - verticalDistanceFromText?: number; + authorEmail?: string; /** - * Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property. + * Gets the name of the comment's author. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - verticalPosition?: number; + authorName?: string; /** - * Specifies the width (in points) of the frame. + * Specifies the comment's content as plain text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - width?: number; + content?: string; /** - * Specifies the rule used to determine the width of the frame. + * Gets the creation date of the comment. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - widthRule?: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; - } - /** An interface for updating data on the `FrameCollection` object, for use in `frameCollection.set({ ... })`. */ - export interface FrameCollectionUpdateData { - items?: Word.Interfaces.FrameData[]; - } - /** An interface for updating data on the `DocumentLibraryVersionCollection` object, for use in `documentLibraryVersionCollection.set({ ... })`. */ - export interface DocumentLibraryVersionCollectionUpdateData { - items?: Word.Interfaces.DocumentLibraryVersionData[]; - } - /** An interface for updating data on the `ListFormat` object, for use in `listFormat.set({ ... })`. */ - export interface ListFormatUpdateData { + creationDate?: Date; /** - * Gets the list template associated with the `ListFormat` object. + * Gets the ID of the comment. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - listTemplate?: Word.Interfaces.ListTemplateUpdateData; + id?: string; /** - * Specifies the list level number for the first paragraph for the `ListFormat` object. + * Specifies the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - listLevelNumber?: number; + resolved?: boolean; } - /** An interface for updating data on the `FillFormat` object, for use in `fillFormat.set({ ... })`. */ - export interface FillFormatUpdateData { + /** An interface describing the data returned by calling `commentCollection.toJSON()`. */ + export interface CommentCollectionData { + items?: Word.Interfaces.CommentData[]; + } + /** An interface describing the data returned by calling `commentContentRange.toJSON()`. */ + export interface CommentContentRangeData { /** - * Returns a `ColorFormat` object that represents the background color for the fill. + * Specifies a value that indicates whether the comment text is bold. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - backgroundColor?: Word.Interfaces.ColorFormatUpdateData; + bold?: boolean; /** - * Returns a `ColorFormat` object that represents the foreground color for the fill. + * Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - foregroundColor?: Word.Interfaces.ColorFormatUpdateData; + hyperlink?: string; /** - * Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9. + * Checks whether the range length is zero. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - gradientAngle?: number; + isEmpty?: boolean; /** - * Specifies if the object, or the formatting applied to it, is visible. + * Specifies a value that indicates whether the comment text is italicized. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - isVisible?: boolean; + italic?: boolean; /** - * Specifies whether the fill rotates with the shape. + * Specifies a value that indicates whether the comment text has a strikethrough. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - rotateWithObject?: boolean; + strikeThrough?: boolean; /** - * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. + * Gets the text of the comment range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - textureAlignment?: Word.TextureAlignment | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "Center" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; + text?: string; /** - * Specifies the horizontal scaling factor for the texture fill. + * Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - textureHorizontalScale?: number; + underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; + } + /** An interface describing the data returned by calling `commentReply.toJSON()`. */ + export interface CommentReplyData { /** - * Specifies the horizontal offset of the texture from the origin in points. + * Specifies the commentReply's content range. + * + * @remarks + * [Api set: WordApi 1.4] + */ + contentRange?: Word.Interfaces.CommentContentRangeData; + /** + * Gets the parent comment of this reply. + * + * @remarks + * [Api set: WordApi 1.4] + */ + parentComment?: Word.Interfaces.CommentData; + /** + * Gets the email of the comment reply's author. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - textureOffsetX?: number; + authorEmail?: string; /** - * Specifies the vertical offset of the texture. + * Gets the name of the comment reply's author. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - textureOffsetY?: number; + authorName?: string; /** - * Specifies whether the texture is tiled. + * Specifies the comment reply's content. The string is plain text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - textureTile?: boolean; + content?: string; /** - * Specifies the vertical scaling factor for the texture fill as a value between 0.0 and 1.0. + * Gets the creation date of the comment reply. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - textureVerticalScale?: number; + creationDate?: Date; /** - * Specifies the degree of transparency of the fill for a shape as a value between 0.0 (opaque) and 1.0 (clear). + * Gets the ID of the comment reply. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - transparency?: number; + id?: string; } - /** An interface for updating data on the `GlowFormat` object, for use in `glowFormat.set({ ... })`. */ - export interface GlowFormatUpdateData { + /** An interface describing the data returned by calling `commentReplyCollection.toJSON()`. */ + export interface CommentReplyCollectionData { + items?: Word.Interfaces.CommentReplyData[]; + } + /** An interface describing the data returned by calling `conditionalStyle.toJSON()`. */ + export interface ConditionalStyleData { /** - * Returns a `ColorFormat` object that represents the color for a glow effect. + * Specifies the amount of space (in points) to add below the contents of a single cell or all the cells in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: Word.Interfaces.ColorFormatUpdateData; + bottomPadding?: number; /** - * Specifies the length of the radius for a glow effect. + * Specifies the amount of space (in points) to add to the left of the contents of a single cell or all the cells in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - radius?: number; + leftPadding?: number; /** - * Specifies the degree of transparency for the glow effect as a value between 0.0 (opaque) and 1.0 (clear). + * Specifies the amount of space (in points) to add to the right of the contents of a single cell or all the cells in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency?: number; - } - /** An interface for updating data on the `LineFormat` object, for use in `lineFormat.set({ ... })`. */ - export interface LineFormatUpdateData { + rightPadding?: number; /** - * Gets a `ColorFormat` object that represents the background color for a patterned line. + * Specifies the amount of space (in points) to add above the contents of a single cell or all the cells in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - backgroundColor?: Word.Interfaces.ColorFormatUpdateData; + topPadding?: number; + } + /** An interface describing the data returned by calling `xmlMapping.toJSON()`. */ + export interface XmlMappingData { /** - * Gets a `ColorFormat` object that represents the foreground color for the line. + * Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - foregroundColor?: Word.Interfaces.ColorFormatUpdateData; + customXmlNode?: Word.Interfaces.CustomXmlNodeData; /** - * Specifies the length of the arrowhead at the beginning of the line. + * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - beginArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; + customXmlPart?: Word.Interfaces.CustomXmlPartData; /** - * Specifies the style of the arrowhead at the beginning of the line. + * Returns whether the content control in the document is mapped to an XML node in the document's XML data store. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - beginArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; + isMapped?: boolean; /** - * Specifies the width of the arrowhead at the beginning of the line. + * Returns the prefix mappings used to evaluate the XPath for the current XML mapping. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - beginArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; + prefixMappings?: string; /** - * Specifies the dash style for the line. + * Returns the XPath for the XML mapping, which evaluates to the currently mapped XML node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashStyle?: Word.LineDashStyle | "Mixed" | "Solid" | "SquareDot" | "RoundDot" | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "SysDash" | "SysDot" | "SysDashDot"; + xpath?: string; + } + /** An interface describing the data returned by calling `customXmlPrefixMappingCollection.toJSON()`. */ + export interface CustomXmlPrefixMappingCollectionData { + items?: Word.Interfaces.CustomXmlPrefixMappingData[]; + } + /** An interface describing the data returned by calling `customXmlPrefixMapping.toJSON()`. */ + export interface CustomXmlPrefixMappingData { /** - * Specifies the length of the arrowhead at the end of the line. + * Gets the unique address identifier for the namespace of the `CustomXmlPrefixMapping` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; + namespaceUri?: string; /** - * Specifies the style of the arrowhead at the end of the line. + * Gets the prefix for the `CustomXmlPrefixMapping` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; + prefix?: string; + } + /** An interface describing the data returned by calling `customXmlSchema.toJSON()`. */ + export interface CustomXmlSchemaData { /** - * Specifies the width of the arrowhead at the end of the line. + * Gets the location of the schema on a computer. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; + location?: string; /** - * Specifies if to draw lines inside a shape. + * Gets the unique address identifier for the namespace of the `CustomXmlSchema` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - insetPen?: boolean; + namespaceUri?: string; + } + /** An interface describing the data returned by calling `customXmlSchemaCollection.toJSON()`. */ + export interface CustomXmlSchemaCollectionData { + items?: Word.Interfaces.CustomXmlSchemaData[]; + } + /** An interface describing the data returned by calling `customXmlValidationErrorCollection.toJSON()`. */ + export interface CustomXmlValidationErrorCollectionData { + items?: Word.Interfaces.CustomXmlValidationErrorData[]; + } + /** An interface describing the data returned by calling `customXmlValidationError.toJSON()`. */ + export interface CustomXmlValidationErrorData { /** - * Specifies if the object, or the formatting applied to it, is visible. + * Gets the node associated with this `CustomXmlValidationError` object, if any exist.If no nodes exist, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + node?: Word.Interfaces.CustomXmlNodeData; /** - * Specifies the pattern applied to the line. + * Gets an integer representing the validation error in the `CustomXmlValidationError` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pattern?: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"; + errorCode?: number; /** - * Specifies the line format style. + * Gets the name of the error in the `CustomXmlValidationError` object.If no errors exist, the property returns `Nothing` * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - style?: Word.LineFormatStyle | "Mixed" | "Single" | "ThinThin" | "ThinThick" | "ThickThin" | "ThickBetweenThin"; + name?: string; /** - * Specifies the degree of transparency of the line as a value between 0.0 (opaque) and 1.0 (clear). + * Gets the text in the `CustomXmlValidationError` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency?: number; + text?: string; /** - * Specifies the thickness of the line in points. + * Gets the type of error generated from the `CustomXmlValidationError` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - weight?: number; + type?: Word.CustomXmlValidationErrorType | "schemaGenerated" | "automaticallyCleared" | "manual"; } - /** An interface for updating data on the `ReflectionFormat` object, for use in `reflectionFormat.set({ ... })`. */ - export interface ReflectionFormatUpdateData { + /** An interface describing the data returned by calling `customXmlNodeCollection.toJSON()`. */ + export interface CustomXmlNodeCollectionData { + items?: Word.Interfaces.CustomXmlNodeData[]; + } + /** An interface describing the data returned by calling `customXmlNode.toJSON()`. */ + export interface CustomXmlNodeData { /** - * Specifies the degree of blur effect applied to the `ReflectionFormat` object as a value between 0.0 and 100.0. + * Gets a `CustomXmlNodeCollection` object representing the attributes of the current element in the current node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - blur?: number; + attributes?: Word.Interfaces.CustomXmlNodeData[]; /** - * Specifies the amount of separation, in points, of the reflected image from the shape. + * Gets a `CustomXmlNodeCollection` object containing all of the child elements of the current node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - offset?: number; + childNodes?: Word.Interfaces.CustomXmlNodeData[]; /** - * Specifies the size of the reflection as a percentage of the reflected shape from 0 to 100. + * Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - size?: number; + firstChild?: Word.Interfaces.CustomXmlNodeData; /** - * Specifies the degree of transparency for the reflection effect as a value between 0.0 (opaque) and 1.0 (clear). + * Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency?: number; + lastChild?: Word.Interfaces.CustomXmlNodeData; /** - * Specifies a `ReflectionType` value that represents the type and direction of the lighting for a shape reflection. + * Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.ReflectionType | "Mixed" | "None" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9"; - } - /** An interface for updating data on the `ColorFormat` object, for use in `colorFormat.set({ ... })`. */ - export interface ColorFormatUpdateData { + nextSibling?: Word.Interfaces.CustomXmlNodeData; /** - * Specifies the brightness of a specified shape color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. + * Gets the object representing the part associated with this node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - brightness?: number; + ownerPart?: Word.Interfaces.CustomXmlPartData; /** - * Specifies the theme color for a color format. + * Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - objectThemeColor?: Word.ThemeColorIndex | "NotThemeColor" | "MainDark1" | "MainLight1" | "MainDark2" | "MainLight2" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Hyperlink" | "HyperlinkFollowed" | "Background1" | "Text1" | "Background2" | "Text2"; + parentNode?: Word.Interfaces.CustomXmlNodeData; /** - * Specifies the red-green-blue (RGB) value of the specified color. You can provide the value in the '#RRGGBB' format. + * Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rgb?: string; + previousSibling?: Word.Interfaces.CustomXmlNodeData; /** - * Specifies the lightening or darkening of a specified shape's color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. + * Gets the base name of the node without the namespace prefix, if one exists. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tintAndShade?: number; - } - /** An interface for updating data on the `ShadowFormat` object, for use in `shadowFormat.set({ ... })`. */ - export interface ShadowFormatUpdateData { + baseName?: string; /** - * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. + * Gets the unique address identifier for the namespace of the node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - foregroundColor?: Word.Interfaces.ColorFormatUpdateData; + namespaceUri?: string; /** - * Specifies the blur level for a shadow format as a value between 0.0 and 100.0. + * Gets the type of the current node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - blur?: number; + nodeType?: Word.CustomXmlNodeType | "element" | "attribute" | "text" | "cData" | "processingInstruction" | "comment" | "document"; /** - * Specifies whether the object or the formatting applied to it is visible. + * Specifies the value of the current node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + nodeValue?: string; /** - * Specifies `true` if the shadow of the shape appears filled in and is obscured by the shape, even if the shape has no fill, - `false` if the shadow has no fill and the outline of the shadow is visible through the shape if the shape has no fill. + * Specifies the text for the current node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - obscured?: boolean; + text?: string; /** - * Specifies the horizontal offset (in points) of the shadow from the shape. - A positive value offsets the shadow to the right of the shape; a negative value offsets it to the left. + * Gets a string with the canonicalized XPath for the current node. If the node is no longer in the Document Object Model (DOM), the property returns an error message. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - offsetX?: number; + xpath?: string; /** - * Specifies the vertical offset (in points) of the shadow from the shape. - A positive value offsets the shadow to the top of the shape; a negative value offsets it to the bottom. + * Gets the XML representation of the current node and its children. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - offsetY?: number; + xml?: string; + } + /** An interface describing the data returned by calling `contentControl.toJSON()`. */ + export interface ContentControlData { /** - * Specifies whether to rotate the shadow when rotating the shape. + * Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `BuildingBlockGallery`. It's `null` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotateWithShape?: boolean; + buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlData; /** - * Specifies the width of the shadow. + * Gets the data of the content control when its type is `CheckBox`. It's `null` otherwise. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - size?: number; + checkboxContentControl?: Word.Interfaces.CheckboxContentControlData; /** - * Specifies the type of shadow formatting to apply to a shape. + * Gets the data of the content control when its type is `ComboBox`. It's `null` otherwise. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - style?: Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow"; + comboBoxContentControl?: Word.Interfaces.ComboBoxContentControlData; /** - * Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear). + * Gets the collection of content control objects in the content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - transparency?: number; + contentControls?: Word.Interfaces.ContentControlData[]; /** - * Specifies the shape shadow type. + * Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `DatePicker`. It's `null` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.ShadowType | "Mixed" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9" | "Type10" | "Type11" | "Type12" | "Type13" | "Type14" | "Type15" | "Type16" | "Type17" | "Type18" | "Type19" | "Type20" | "Type21" | "Type22" | "Type23" | "Type24" | "Type25" | "Type26" | "Type27" | "Type28" | "Type29" | "Type30" | "Type31" | "Type32" | "Type33" | "Type34" | "Type35" | "Type36" | "Type37" | "Type38" | "Type39" | "Type40" | "Type41" | "Type42" | "Type43"; - } - /** An interface for updating data on the `ThreeDimensionalFormat` object, for use in `threeDimensionalFormat.set({ ... })`. */ - export interface ThreeDimensionalFormatUpdateData { + datePickerContentControl?: Word.Interfaces.DatePickerContentControlData; /** - * Returns a `ColorFormat` object that represents color of the contour of a shape. + * Gets the data of the content control when its type is `DropDownList`. It's `null` otherwise. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - contourColor?: Word.Interfaces.ColorFormatUpdateData; + dropDownListContentControl?: Word.Interfaces.DropDownListContentControlData; /** - * Returns a `ColorFormat` object that represents the color of the shape's extrusion. + * Gets the collection of field objects in the content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - extrusionColor?: Word.Interfaces.ColorFormatUpdateData; + fields?: Word.Interfaces.FieldData[]; /** - * Specifies the depth of the bottom bevel. + * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - bevelBottomDepth?: number; + font?: Word.Interfaces.FontData; /** - * Specifies the inset size for the bottom bevel. + * Gets the group-related data if the content control's {@link Word.ContentControlType} is `Group`. It's `null` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelBottomInset?: number; + groupContentControl?: Word.Interfaces.GroupContentControlData; /** - * Specifies a `BevelType` value that represents the bevel type for the bottom bevel. + * Gets the collection of InlinePicture objects in the content control. The collection doesn't include floating images. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - bevelBottomType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; + inlinePictures?: Word.Interfaces.InlinePictureData[]; /** - * Specifies the depth of the top bevel. + * Gets the collection of list objects in the content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - bevelTopDepth?: number; + lists?: Word.Interfaces.ListData[]; /** - * Specifies the inset size for the top bevel. + * Gets the collection of paragraph objects in the content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] + * + * Important: For requirement sets 1.1 and 1.2, paragraphs in tables wholly contained within this content control aren't returned. From requirement set 1.3, paragraphs in such tables are also returned. */ - bevelTopInset?: number; + paragraphs?: Word.Interfaces.ParagraphData[]; /** - * Specifies a `BevelType` value that represents the bevel type for the top bevel. + * Gets the picture-related data if the content control's {@link Word.ContentControlType} is `Picture`. It's `null` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelTopType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; + pictureContentControl?: Word.Interfaces.PictureContentControlData; /** - * Specifies the width of the contour of a shape. + * Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `RepeatingSection`. It's `null` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contourWidth?: number; + repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlData; /** - * Specifies the depth of the shape's extrusion. + * Gets the collection of table objects in the content control. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @remarks + * [Api set: WordApi 1.3] */ - depth?: number; + tables?: Word.Interfaces.TableData[]; /** - * Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion) - and automatically changes when the shape's fill changes, or whether the extrusion color is independent of the shape's fill. + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - extrusionColorType?: Word.ExtrusionColorType | "mixed" | "automatic" | "custom"; + xmlMapping?: Word.Interfaces.XmlMappingData; /** - * Specifies the amount of perspective for a shape. + * Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - fieldOfView?: number; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Specifies `true` if the extrusion appears in perspective — that is, if the walls of the extrusion narrow toward a vanishing point, - `false` if the extrusion is a parallel, or orthographic, projection — that is, if the walls don't narrow toward a vanishing point. + * Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - isPerspective?: boolean; + cannotDelete?: boolean; /** - * Specifies if the specified object, or the formatting applied to it, is visible. + * Specifies a value that indicates whether the user can edit the contents of the content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - isVisible?: boolean; + cannotEdit?: boolean; /** - * Specifies the angle of the lighting. + * Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - lightAngle?: number; + color?: string; /** - * Specifies a `LightRigType` value that represents the lighting preset. + * Gets an integer that represents the content control identifier. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - presetLighting?: Word.LightRigType | "Mixed" | "LegacyFlat1" | "LegacyFlat2" | "LegacyFlat3" | "LegacyFlat4" | "LegacyNormal1" | "LegacyNormal2" | "LegacyNormal3" | "LegacyNormal4" | "LegacyHarsh1" | "LegacyHarsh2" | "LegacyHarsh3" | "LegacyHarsh4" | "ThreePoint" | "Balanced" | "Soft" | "Harsh" | "Flood" | "Contrasting" | "Morning" | "Sunrise" | "Sunset" | "Chilly" | "Freezing" | "Flat" | "TwoPoint" | "Glow" | "BrightRoom"; + id?: number; /** - * Specifies the position of the light source relative to the extrusion. + * Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - presetLightingDirection?: Word.PresetLightingDirection | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "None" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; + placeholderText?: string; /** - * Specifies the intensity of the extrusion lighting. + * Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - presetLightingSoftness?: Word.PresetLightingSoftness | "Mixed" | "Dim" | "Normal" | "Bright"; + removeWhenEdited?: boolean; /** - * Specifies the extrusion surface material. + * Specifies the style name for the content control. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - presetMaterial?: Word.PresetMaterial | "Mixed" | "Matte" | "Plastic" | "Metal" | "WireFrame" | "Matte2" | "Plastic2" | "Metal2" | "WarmMatte" | "TranslucentPowder" | "Powder" | "DarkEdge" | "SoftEdge" | "Clear" | "Flat" | "SoftMetal"; + style?: string; /** - * Specifies whether text on a shape rotates with shape. `true` rotates the text. + * Specifies the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - projectText?: boolean; + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; /** - * Specifies the rotation of the extruded shape around the x-axis in degrees. + * Gets the content control subtype. The subtype can be 'RichTextInline', 'RichTextParagraphs', 'RichTextTableCell', 'RichTextTableRow' and 'RichTextTable' for rich text content controls, or 'PlainTextInline' and 'PlainTextParagraph' for plain text content controls, or 'CheckBox' for checkbox content controls. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - rotationX?: number; + subtype?: Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" | "RichText" | "PlainText" | "Group"; /** - * Specifies the rotation of the extruded shape around the y-axis in degrees. + * Specifies a tag to identify a content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - rotationY?: number; + tag?: string; /** - * Specifies the z-axis rotation of the camera. + * Gets the text of the content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - rotationZ?: number; + text?: string; /** - * Specifies the position on the z-axis for the shape. + * Specifies the title for a content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - z?: number; - } - /** An interface for updating data on the `Bibliography` object, for use in `bibliography.set({ ... })`. */ - export interface BibliographyUpdateData { + title?: string; /** - * Specifies the name of the active style to use for the bibliography. + * Gets the content control type. Only rich text, plain text, and checkbox content controls are supported currently. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - bibliographyStyle?: string; + type?: Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" | "RichText" | "PlainText" | "Group"; } - /** An interface for updating data on the `SourceCollection` object, for use in `sourceCollection.set({ ... })`. */ - export interface SourceCollectionUpdateData { - items?: Word.Interfaces.SourceData[]; + /** An interface describing the data returned by calling `contentControlCollection.toJSON()`. */ + export interface ContentControlCollectionData { + items?: Word.Interfaces.ContentControlData[]; } - /** An interface for updating data on the `PageSetup` object, for use in `pageSetup.set({ ... })`. */ - export interface PageSetupUpdateData { + /** An interface describing the data returned by calling `contentControlListItem.toJSON()`. */ + export interface ContentControlListItemData { /** - * Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object. + * Specifies the display text of a list item for a dropdown list or combo box content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - lineNumbering?: Word.Interfaces.LineNumberingUpdateData; + displayText?: string; /** - * Specifies whether Microsoft Word prints the document as a booklet. + * Specifies the index location of a content control list item in the collection of list items. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - bookFoldPrinting?: boolean; + index?: number; /** - * Specifies the number of pages for each booklet. + * Specifies the programmatic value of a list item for a dropdown list or combo box content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - bookFoldPrintingSheets?: number; + value?: string; + } + /** An interface describing the data returned by calling `contentControlListItemCollection.toJSON()`. */ + export interface ContentControlListItemCollectionData { + items?: Word.Interfaces.ContentControlListItemData[]; + } + /** An interface describing the data returned by calling `customProperty.toJSON()`. */ + export interface CustomPropertyData { /** - * Specifies if Microsoft Word reverses the printing order for book fold printing of bidirectional or Asian language documents. + * Gets the key of the custom property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - bookFoldReversePrinting?: boolean; + key?: string; /** - * Specifies the distance (in points) between the bottom edge of the page and the bottom boundary of the body text. + * Gets the value type of the custom property. Possible values are: String, Number, Date, Boolean. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - bottomMargin?: number; + type?: Word.DocumentPropertyType | "String" | "Number" | "Date" | "Boolean"; /** - * Specifies the number of characters per line in the document grid. + * Specifies the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - charsLine?: number; + value?: any; + } + /** An interface describing the data returned by calling `customPropertyCollection.toJSON()`. */ + export interface CustomPropertyCollectionData { + items?: Word.Interfaces.CustomPropertyData[]; + } + /** An interface describing the data returned by calling `customXmlPart.toJSON()`. */ + export interface CustomXmlPartData { /** - * Specifies whether the first page has a different header and footer. + * Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - differentFirstPageHeaderFooter?: boolean; + documentElement?: Word.Interfaces.CustomXmlNodeData; /** - * Specifies the distance between the footer and the bottom of the page in points. + * Gets a `CustomXmlValidationErrorCollection` object that provides access to any XML validation errors. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footerDistance?: number; + errors?: Word.Interfaces.CustomXmlValidationErrorData[]; /** - * Specifies the amount (in points) of extra margin space added to each page in a document or section for binding. + * Gets the set of namespace prefix mappings used against the current `CustomXmlPart` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gutter?: number; + namespaceManager?: Word.Interfaces.CustomXmlPrefixMappingData[]; /** - * Specifies on which side the gutter appears in a document. + * Specifies a `CustomXmlSchemaCollection` object representing the set of schemas attached to a bound region of data in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gutterPosition?: Word.GutterPosition | "Left" | "Right" | "Top"; + schemaCollection?: Word.Interfaces.CustomXmlSchemaData[]; /** - * Specifies whether Microsoft Word uses gutters for the current document based on a right-to-left language or a left-to-right language. + * Gets a value that indicates whether the `CustomXmlPart` is built-in. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gutterStyle?: Word.GutterStyle | "Bidirectional" | "Latin"; + builtIn?: boolean; /** - * Specifies the distance between the header and the top of the page in points. + * Gets the ID of the custom XML part. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - headerDistance?: number; + id?: string; /** - * Specifies the layout mode for the current document. + * Gets the namespace URI of the custom XML part. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - layoutMode?: Word.LayoutMode | "Default" | "Grid" | "LineGrid" | "Genko"; + namespaceUri?: string; /** - * Specifies the distance (in points) between the left edge of the page and the left boundary of the body text. + * Gets the XML representation of the current `CustomXmlPart` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - leftMargin?: number; + xml?: string; + } + /** An interface describing the data returned by calling `customXmlPartCollection.toJSON()`. */ + export interface CustomXmlPartCollectionData { + items?: Word.Interfaces.CustomXmlPartData[]; + } + /** An interface describing the data returned by calling `customXmlPartScopedCollection.toJSON()`. */ + export interface CustomXmlPartScopedCollectionData { + items?: Word.Interfaces.CustomXmlPartData[]; + } + /** An interface describing the data returned by calling `document.toJSON()`. */ + export interface DocumentData { /** - * Specifies the number of lines per page in the document grid. + * Gets the active window for the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - linesPage?: number; + activeWindow?: Word.Interfaces.WindowData; /** - * Specifies if the inside and outside margins of facing pages are the same width. + * Returns a `Bibliography` object that represents the bibliography references contained within the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mirrorMargins?: boolean; + bibliography?: Word.Interfaces.BibliographyData; /** - * Specifies whether odd and even pages have different headers and footers. + * Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - oddAndEvenPagesHeaderFooter?: boolean; + body?: Word.Interfaces.BodyData; /** - * Specifies the orientation of the page. + * Gets a `Coauthoring` object for managing coauthoring in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - orientation?: Word.PageOrientation | "Portrait" | "Landscape"; + coauthoring?: Word.Interfaces.CoauthoringData; /** - * Specifies the page height in points. + * Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - pageHeight?: number; + contentControls?: Word.Interfaces.ContentControlData[]; /** - * Specifies the page width in points. + * Gets the custom XML parts in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - pageWidth?: number; + customXmlParts?: Word.Interfaces.CustomXmlPartData[]; /** - * Specifies the paper size of the page. + * Returns a `DocumentLibraryVersionCollection` object that represents the collection of versions of a shared document that has versioning enabled and that's stored in a document library on a server. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - paperSize?: Word.PaperSize | "Size10x14" | "Size11x17" | "Letter" | "LetterSmall" | "Legal" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "CSheet" | "DSheet" | "ESheet" | "FanfoldLegalGerman" | "FanfoldStdGerman" | "FanfoldUS" | "Folio" | "Ledger" | "Note" | "Quarto" | "Statement" | "Tabloid" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC5" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeDL" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "Custom"; + documentLibraryVersions?: Word.Interfaces.DocumentLibraryVersionData[]; /** - * Specifies the distance (in points) between the right edge of the page and the right boundary of the body text. + * Returns a `FrameCollection` object that represents all the frames in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rightMargin?: number; + frames?: Word.Interfaces.FrameData[]; /** - * Specifies the reading order and alignment for the specified sections. + * Returns a `HyperlinkCollection` object that represents all the hyperlinks in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sectionDirection?: Word.SectionDirection | "RightToLeft" | "LeftToRight"; + hyperlinks?: Word.Interfaces.HyperlinkData[]; /** - * Specifies the type of section break for the specified object. + * Returns a `ListTemplateCollection` object that represents all the list templates in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sectionStart?: Word.SectionStart | "Continuous" | "NewColumn" | "NewPage" | "EvenPage" | "OddPage"; + listTemplates?: Word.Interfaces.ListTemplateData[]; /** - * Specifies whether to show the grid. + * Returns a `PageSetup` object that's associated with the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showGrid?: boolean; + pageSetup?: Word.Interfaces.PageSetupData; /** - * Specifies if endnotes are printed at the end of the next section that doesn't suppress endnotes. + * Gets the properties of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - suppressEndnotes?: boolean; + properties?: Word.Interfaces.DocumentPropertiesData; /** - * Specifies the top margin of the page in points. + * Gets the collection of section objects in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - topMargin?: number; + sections?: Word.Interfaces.SectionData[]; /** - * Specifies whether to print two pages per sheet. + * Returns a `Selection` object that represents the current selection in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - twoPagesOnOne?: boolean; + selection?: Word.Interfaces.SelectionData; /** - * Specifies the vertical alignment of text on each page in a document or section. + * Gets the add-in's settings in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - verticalAlignment?: Word.PageSetupVerticalAlignment | "Top" | "Center" | "Justify" | "Bottom"; - } - /** An interface for updating data on the `LineNumbering` object, for use in `lineNumbering.set({ ... })`. */ - export interface LineNumberingUpdateData { + settings?: Word.Interfaces.SettingData[]; /** - * Specifies the numeric increment for line numbers. + * Gets the collection of `Word.Window` objects for the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - countBy?: number; + windows?: Word.Interfaces.WindowData[]; /** - * Specifies the distance (in points) between the right edge of line numbers and the left edge of the document text. + * Specifies if automatic hyphenation is turned on for the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - distanceFromText?: number; + autoHyphenation?: boolean; /** - * Specifies if line numbering is active for the specified document, section, or sections. + * Specifies if the edits in the document are automatically saved. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isActive?: boolean; + autoSaveOn?: boolean; /** - * Specifies the way line numbering runs; that is, whether it starts over at the beginning of a new page or section, or runs continuously. + * Specifies the ChangeTracking mode. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - restartMode?: Word.NumberingRule | "RestartContinuous" | "RestartSection" | "RestartPage"; + changeTrackingMode?: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly"; /** - * Specifies the starting line number. + * Specifies the maximum number of consecutive lines that can end with hyphens. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - startingNumber?: number; - } - /** An interface for updating data on the `TextColumnCollection` object, for use in `textColumnCollection.set({ ... })`. */ - export interface TextColumnCollectionUpdateData { - items?: Word.Interfaces.TextColumnData[]; - } - /** An interface for updating data on the `TextColumn` object, for use in `textColumn.set({ ... })`. */ - export interface TextColumnUpdateData { + consecutiveHyphensLimit?: number; /** - * Specifies the amount of spacing (in points) after the specified paragraph or text column. + * Specifies whether words in all capital letters can be hyphenated. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spaceAfter?: number; + hyphenateCaps?: boolean; /** - * Specifies the width, in points, of the specified text columns. + * Specifies whether Microsoft Word has detected the language of the document text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - width?: number; - } - /** An interface for updating data on the `Bookmark` object, for use in `bookmark.set({ ... })`. */ - export interface BookmarkUpdateData { + languageDetected?: boolean; /** - * Returns a `Range` object that represents the portion of the document that's contained in the `Bookmark` object. + * Indicates whether the changes in the document have been saved. A value of true indicates that the document hasn't changed since it was saved. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - range?: Word.Interfaces.RangeUpdateData; + saved?: boolean; + } + /** An interface describing the data returned by calling `documentCreated.toJSON()`. */ + export interface DocumentCreatedData { /** - * Specifies the ending character position of the bookmark. + * Gets the body object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.3] + */ + body?: Word.Interfaces.BodyData; + /** + * Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.3] + */ + contentControls?: Word.Interfaces.ContentControlData[]; + /** + * Gets the custom XML parts in the document. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.4] + */ + customXmlParts?: Word.Interfaces.CustomXmlPartData[]; + /** + * Gets the properties of the document. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.3] + */ + properties?: Word.Interfaces.DocumentPropertiesData; + /** + * Gets the collection of section objects in the document. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.3] + */ + sections?: Word.Interfaces.SectionData[]; + /** + * Gets the add-in's settings in the document. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.4] + */ + settings?: Word.Interfaces.SettingData[]; + /** + * Indicates whether the changes in the document have been saved. A value of true indicates that the document hasn't changed since it was saved. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiHiddenDocument 1.3] */ - end?: number; + saved?: boolean; + } + /** An interface describing the data returned by calling `documentProperties.toJSON()`. */ + export interface DocumentPropertiesData { /** - * Specifies the starting character position of the bookmark. + * Gets the collection of custom properties of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + customProperties?: Word.Interfaces.CustomPropertyData[]; + /** + * Gets the application name of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - start?: number; - } - /** An interface for updating data on the `BookmarkCollection` object, for use in `bookmarkCollection.set({ ... })`. */ - export interface BookmarkCollectionUpdateData { - items?: Word.Interfaces.BookmarkData[]; - } - /** An interface for updating data on the `Index` object, for use in `index.set({ ... })`. */ - export interface IndexUpdateData { + applicationName?: string; /** - * Returns a `Range` object that represents the portion of the document that is contained within the index. + * Specifies the author of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - range?: Word.Interfaces.RangeUpdateData; + author?: string; /** - * Specifies the leader character between entries in the index and their associated page numbers. + * Specifies the category of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; - } - /** An interface for updating data on the `IndexCollection` object, for use in `indexCollection.set({ ... })`. */ - export interface IndexCollectionUpdateData { - items?: Word.Interfaces.IndexData[]; - } - /** An interface describing the data returned by calling `critiqueAnnotation.toJSON()`. */ - export interface CritiqueAnnotationData { + category?: string; /** - * Gets the critique that was passed when the annotation was inserted. + * Specifies the Comments field in the metadata of the document. These have no connection to comments by users made in the document. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi 1.3] */ - critique?: Word.Critique; - } - /** An interface describing the data returned by calling `annotation.toJSON()`. */ - export interface AnnotationData { + comments?: string; /** - * Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects. + * Specifies the company of the document. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi 1.3] */ - id?: string; + company?: string; /** - * Gets the state of the annotation. + * Gets the creation date of the document. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi 1.3] */ - state?: Word.AnnotationState | "Created" | "Accepted" | "Rejected"; - } - /** An interface describing the data returned by calling `annotationCollection.toJSON()`. */ - export interface AnnotationCollectionData { - items?: Word.Interfaces.AnnotationData[]; - } - /** An interface describing the data returned by calling `application.toJSON()`. */ - export interface ApplicationData { + creationDate?: Date; /** - * Returns a `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word. + * Specifies the format of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - bibliography?: Word.Interfaces.BibliographyData; + format?: string; /** - * Specifies if Microsoft Word automatically detects the language you are using as you type. + * Specifies the keywords of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - checkLanguage?: boolean; + keywords?: string; /** - * Gets a `LanguageId` value that represents the language selected for the Microsoft Word user interface. + * Gets the last author of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - language?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; - } - /** An interface describing the data returned by calling `body.toJSON()`. */ - export interface BodyData { + lastAuthor?: string; /** - * Gets the collection of rich text content control objects in the body. + * Gets the last print date of the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - contentControls?: Word.Interfaces.ContentControlData[]; + lastPrintDate?: Date; /** - * Gets the collection of field objects in the body. + * Gets the last save time of the document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - fields?: Word.Interfaces.FieldData[]; + lastSaveTime?: Date; /** - * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. + * Specifies the manager of the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - font?: Word.Interfaces.FontData; + manager?: string; /** - * Gets the collection of InlinePicture objects in the body. The collection doesn't include floating images. + * Gets the revision number of the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - inlinePictures?: Word.Interfaces.InlinePictureData[]; + revisionNumber?: string; /** - * Gets the collection of list objects in the body. + * Gets security settings of the document. Some are access restrictions on the file on disk. Others are Document Protection settings. Some possible values are 0 = File on disk is read/write; 1 = Protect Document: File is encrypted and requires a password to open; 2 = Protect Document: Always Open as Read-Only; 3 = Protect Document: Both #1 and #2; 4 = File on disk is read-only; 5 = Both #1 and #4; 6 = Both #2 and #4; 7 = All of #1, #2, and #4; 8 = Protect Document: Restrict Edit to read-only; 9 = Both #1 and #8; 10 = Both #2 and #8; 11 = All of #1, #2, and #8; 12 = Both #4 and #8; 13 = All of #1, #4, and #8; 14 = All of #2, #4, and #8; 15 = All of #1, #2, #4, and #8. * * @remarks * [Api set: WordApi 1.3] */ - lists?: Word.Interfaces.ListData[]; + security?: number; /** - * Gets the collection of paragraph objects in the body. + * Specifies the subject of the document. * * @remarks - * [Api set: WordApi 1.1] - * - * Important: Paragraphs in tables aren't returned for requirement sets 1.1 and 1.2. From requirement set 1.3, paragraphs in tables are also returned. + * [Api set: WordApi 1.3] */ - paragraphs?: Word.Interfaces.ParagraphData[]; + subject?: string; /** - * Gets the collection of shape objects in the body, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * Gets the template of the document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - shapes?: Word.Interfaces.ShapeData[]; + template?: string; /** - * Gets the collection of table objects in the body. + * Specifies the title of the document. * * @remarks * [Api set: WordApi 1.3] */ - tables?: Word.Interfaces.TableData[]; + title?: string; + } + /** An interface describing the data returned by calling `dropDownListContentControl.toJSON()`. */ + export interface DropDownListContentControlData { + } + /** An interface describing the data returned by calling `comboBoxContentControl.toJSON()`. */ + export interface ComboBoxContentControlData { + } + /** An interface describing the data returned by calling `field.toJSON()`. */ + export interface FieldData { /** - * Specifies the style name for the body. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * Gets the field's result data. + * + * @remarks + * [Api set: WordApi 1.4] + */ + result?: Word.Interfaces.RangeData; + /** + * Specifies the field's code instruction. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.4] + * + * Note: The ability to set the code was introduced in WordApi 1.5. */ - style?: string; + code?: string; /** - * Specifies the built-in style name for the body. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is `null` and it will throw a general exception when code attempts to set it. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + data?: string; /** - * Gets the text of the body. Use the insertText method to insert text. + * Gets the field's kind. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - text?: string; + kind?: Word.FieldKind | "None" | "Hot" | "Warm" | "Cold"; /** - * Gets the type of the body. The type can be 'MainDoc', 'Section', 'Header', 'Footer', or 'TableCell'. Additional types ‘Footnote’, ‘Endnote’, and ‘NoteItem’ are supported in WordApiOnline 1.1 and later. + * Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - type?: Word.BodyType | "Unknown" | "MainDoc" | "Section" | "Header" | "Footer" | "TableCell" | "Footnote" | "Endnote" | "NoteItem" | "Shape"; - } - /** An interface describing the data returned by calling `border.toJSON()`. */ - export interface BorderData { + locked?: boolean; /** - * Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name. + * Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise. * * @remarks * [Api set: WordApiDesktop 1.1] */ - color?: string; + showCodes?: boolean; /** - * Gets the location of the border. + * Gets the field's type. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - location?: Word.BorderLocation | "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"; + type?: Word.FieldType | "Addin" | "AddressBlock" | "Advance" | "Ask" | "Author" | "AutoText" | "AutoTextList" | "BarCode" | "Bibliography" | "BidiOutline" | "Citation" | "Comments" | "Compare" | "CreateDate" | "Data" | "Database" | "Date" | "DisplayBarcode" | "DocProperty" | "DocVariable" | "EditTime" | "Embedded" | "EQ" | "Expression" | "FileName" | "FileSize" | "FillIn" | "FormCheckbox" | "FormDropdown" | "FormText" | "GotoButton" | "GreetingLine" | "Hyperlink" | "If" | "Import" | "Include" | "IncludePicture" | "IncludeText" | "Index" | "Info" | "Keywords" | "LastSavedBy" | "Link" | "ListNum" | "MacroButton" | "MergeBarcode" | "MergeField" | "MergeRec" | "MergeSeq" | "Next" | "NextIf" | "NoteRef" | "NumChars" | "NumPages" | "NumWords" | "OCX" | "Page" | "PageRef" | "Print" | "PrintDate" | "Private" | "Quote" | "RD" | "Ref" | "RevNum" | "SaveDate" | "Section" | "SectionPages" | "Seq" | "Set" | "Shape" | "SkipIf" | "StyleRef" | "Subject" | "Subscriber" | "Symbol" | "TA" | "TC" | "Template" | "Time" | "Title" | "TOA" | "TOC" | "UserAddress" | "UserInitials" | "UserName" | "XE" | "Empty" | "Others" | "Undefined"; + } + /** An interface describing the data returned by calling `fieldCollection.toJSON()`. */ + export interface FieldCollectionData { + items?: Word.Interfaces.FieldData[]; + } + /** An interface describing the data returned by calling `font.toJSON()`. */ + export interface FontData { /** - * Specifies the border type for the border. + * Returns a `BorderUniversalCollection` object that represents all the borders for the font. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + borders?: Word.Interfaces.BorderUniversalData[]; /** - * Specifies whether the border is visible. + * Returns a `FillFormat` object that contains fill formatting properties for the font used by the range of text. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - visible?: boolean; + fill?: Word.Interfaces.FillFormatData; /** - * Specifies the width for the border. + * Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed"; - } - /** An interface describing the data returned by calling `borderUniversal.toJSON()`. */ - export interface BorderUniversalData { + glow?: Word.Interfaces.GlowFormatData; /** - * Specifies the graphical page-border design for the document. + * Returns a `LineFormat` object that specifies the formatting for a line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - artStyle?: Word.PageBorderArt | "Apples" | "MapleMuffins" | "CakeSlice" | "CandyCorn" | "IceCreamCones" | "ChampagneBottle" | "PartyGlass" | "ChristmasTree" | "Trees" | "PalmsColor" | "Balloons3Colors" | "BalloonsHotAir" | "PartyFavor" | "ConfettiStreamers" | "Hearts" | "HeartBalloon" | "Stars3D" | "StarsShadowed" | "Stars" | "Sun" | "Earth2" | "Earth1" | "PeopleHats" | "Sombrero" | "Pencils" | "Packages" | "Clocks" | "Firecrackers" | "Rings" | "MapPins" | "Confetti" | "CreaturesButterfly" | "CreaturesLadyBug" | "CreaturesFish" | "BirdsFlight" | "ScaredCat" | "Bats" | "FlowersRoses" | "FlowersRedRose" | "Poinsettias" | "Holly" | "FlowersTiny" | "FlowersPansy" | "FlowersModern2" | "FlowersModern1" | "WhiteFlowers" | "Vine" | "FlowersDaisies" | "FlowersBlockPrint" | "DecoArchColor" | "Fans" | "Film" | "Lightning1" | "Compass" | "DoubleD" | "ClassicalWave" | "ShadowedSquares" | "TwistedLines1" | "Waveline" | "Quadrants" | "CheckedBarColor" | "Swirligig" | "PushPinNote1" | "PushPinNote2" | "Pumpkin1" | "EggsBlack" | "Cup" | "HeartGray" | "GingerbreadMan" | "BabyPacifier" | "BabyRattle" | "Cabins" | "HouseFunky" | "StarsBlack" | "Snowflakes" | "SnowflakeFancy" | "Skyrocket" | "Seattle" | "MusicNotes" | "PalmsBlack" | "MapleLeaf" | "PaperClips" | "ShorebirdTracks" | "People" | "PeopleWaving" | "EclipsingSquares2" | "Hypnotic" | "DiamondsGray" | "DecoArch" | "DecoBlocks" | "CirclesLines" | "Papyrus" | "Woodwork" | "WeavingBraid" | "WeavingRibbon" | "WeavingAngles" | "ArchedScallops" | "Safari" | "CelticKnotwork" | "CrazyMaze" | "EclipsingSquares1" | "Birds" | "FlowersTeacup" | "Northwest" | "Southwest" | "Tribal6" | "Tribal4" | "Tribal3" | "Tribal2" | "Tribal5" | "XIllusions" | "ZanyTriangles" | "Pyramids" | "PyramidsAbove" | "ConfettiGrays" | "ConfettiOutline" | "ConfettiWhite" | "Mosaic" | "Lightning2" | "HeebieJeebies" | "LightBulb" | "Gradient" | "TriangleParty" | "TwistedLines2" | "Moons" | "Ovals" | "DoubleDiamonds" | "ChainLink" | "Triangles" | "Tribal1" | "MarqueeToothed" | "SharksTeeth" | "Sawtooth" | "SawtoothGray" | "PostageStamp" | "WeavingStrips" | "ZigZag" | "CrossStitch" | "Gems" | "CirclesRectangles" | "CornerTriangles" | "CreaturesInsects" | "ZigZagStitch" | "Checkered" | "CheckedBarBlack" | "Marquee" | "BasicWhiteDots" | "BasicWideMidline" | "BasicWideOutline" | "BasicWideInline" | "BasicThinLines" | "BasicWhiteDashes" | "BasicWhiteSquares" | "BasicBlackSquares" | "BasicBlackDashes" | "BasicBlackDots" | "StarsTop" | "CertificateBanner" | "Handmade1" | "Handmade2" | "TornPaper" | "TornPaperBlack" | "CouponCutoutDashes" | "CouponCutoutDots"; + line?: Word.Interfaces.LineFormatData; /** - * Specifies the width (in points) of the graphical page border specified in the `artStyle` property. + * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - artWidth?: number; + reflection?: Word.Interfaces.ReflectionFormatData; /** - * Specifies the color for the `BorderUniversal` object. You can provide the value in the '#RRGGBB' format. + * Returns a `ColorFormat` object that represents the color for the font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + textColor?: Word.Interfaces.ColorFormatData; /** - * Specifies the color for the `BorderUniversal` or {@link Word.Font} object. + * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - colorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + textShadow?: Word.Interfaces.ShadowFormatData; /** - * Returns `true` if an inside border can be applied to the specified object. + * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - inside?: boolean; + threeDimensionalFormat?: Word.Interfaces.ThreeDimensionalFormatData; /** - * Specifies whether the border is visible. + * Specifies whether the font is formatted as all capital letters, 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + allCaps?: boolean; /** - * Specifies the line style of the border. + * Specifies a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + bold?: boolean; + /** + * Specifies whether the font is formatted as bold in a right-to-left language document. 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - lineStyle?: Word.BorderLineStyle | "None" | "Single" | "Dot" | "DashSmallGap" | "DashLargeGap" | "DashDot" | "DashDotDot" | "Double" | "Triple" | "ThinThickSmallGap" | "ThickThinSmallGap" | "ThinThickThinSmallGap" | "ThinThickMedGap" | "ThickThinMedGap" | "ThinThickThinMedGap" | "ThinThickLargeGap" | "ThickThinLargeGap" | "ThinThickThinLargeGap" | "SingleWavy" | "DoubleWavy" | "DashDotStroked" | "Emboss3D" | "Engrave3D" | "Outset" | "Inset"; + boldBidirectional?: boolean; /** - * Specifies the line width of an object's border. + * Specifies the color for the specified font. You can provide the value in the '#RRGGBB' format or the color name. + * + * @remarks + * [Api set: WordApi 1.1] + */ + color?: string; + /** + * Specifies a `ColorIndex` value that represents the color for the font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lineWidth?: Word.LineWidth | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600"; - } - /** An interface describing the data returned by calling `borderCollection.toJSON()`. */ - export interface BorderCollectionData { - items?: Word.Interfaces.BorderData[]; - } - /** An interface describing the data returned by calling `borderUniversalCollection.toJSON()`. */ - export interface BorderUniversalCollectionData { - items?: Word.Interfaces.BorderUniversalData[]; - } - /** An interface describing the data returned by calling `break.toJSON()`. */ - export interface BreakData { + colorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Returns a `Range` object that represents the portion of the document that's contained in the break. + * Specifies the color for the `Font` object in a right-to-left language document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeData; + colorIndexBidirectional?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Returns the page number on which the break occurs. + * Specifies whether contextual alternates are enabled for the font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageIndex?: number; - } - /** An interface describing the data returned by calling `breakCollection.toJSON()`. */ - export interface BreakCollectionData { - items?: Word.Interfaces.BreakData[]; - } - /** An interface describing the data returned by calling `buildingBlock.toJSON()`. */ - export interface BuildingBlockData { + contextualAlternates?: boolean; /** - * Specifies the description for the building block. + * Specifies the color to be used for diacritics for the `Font` object. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - description?: string; + diacriticColor?: string; /** - * Returns the internal identification number for the building block. + * Specifies whether Microsoft Word ignores the number of characters per line for the corresponding `Font` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: string; + disableCharacterSpaceGrid?: boolean; /** - * Returns the position of this building block in a collection. + * Specifies a value that indicates whether the font has a double strikethrough. True if the font is formatted as double strikethrough text, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + doubleStrikeThrough?: boolean; + /** + * Specifies whether the font is formatted as embossed. The possible values are as follows: + + - `true`: All the text is embossed. + + - `false`: None of the text is embossed. + + - `null`: Returned if some, but not all, of the text is embossed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - index?: number; + emboss?: boolean; /** - * Specifies a `DocPartInsertType` value that represents how to insert the contents of the building block into the document. + * Specifies an `EmphasisMark` value that represents the emphasis mark for a character or designated character string. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - insertType?: Word.DocPartInsertType | "Content" | "Paragraph" | "Page"; + emphasisMark?: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle"; /** - * Specifies the name of the building block. + * Specifies whether the font is formatted as engraved. The possible values are as follows: + + - `true`: All the text is engraved. + + - `false`: None of the text is engraved. + + - `null`: Returned if some, but not all, of the text is engraved. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: string; + engrave?: boolean; /** - * Specifies the contents of the building block. + * Specifies a value that indicates whether the font is tagged as hidden. True if the font is formatted as hidden text, otherwise, false. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + hidden?: boolean; + /** + * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or `null` for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. + * + * @remarks + * [Api set: WordApi 1.1] + */ + highlightColor?: string; + /** + * Specifies a value that indicates whether the font is italicized. True if the font is italicized, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + italic?: boolean; + /** + * Specifies whether the font is italicized in a right-to-left language document. 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - value?: string; - } - /** An interface describing the data returned by calling `buildingBlockCategory.toJSON()`. */ - export interface BuildingBlockCategoryData { + italicBidirectional?: boolean; /** - * Returns the position of the `BuildingBlockCategory` object in a collection. + * Specifies the minimum font size for which Microsoft Word will adjust kerning automatically. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - index?: number; + kerning?: number; /** - * Returns the name of the `BuildingBlockCategory` object. + * Specifies the ligature setting for the `Font` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ + ligature?: Word.Ligature | "None" | "Standard" | "Contextual" | "StandardContextual" | "Historical" | "StandardHistorical" | "ContextualHistorical" | "StandardContextualHistorical" | "Discretional" | "StandardDiscretional" | "ContextualDiscretional" | "StandardContextualDiscretional" | "HistoricalDiscretional" | "StandardHistoricalDiscretional" | "ContextualHistoricalDiscretional" | "All"; + /** + * Specifies a value that represents the name of the font. + * + * @remarks + * [Api set: WordApi 1.1] + */ name?: string; - } - /** An interface describing the data returned by calling `buildingBlockTypeItem.toJSON()`. */ - export interface BuildingBlockTypeItemData { /** - * Returns the position of an item in a collection. + * Specifies the font used for Latin text (characters with character codes from 0 (zero) through 127). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - index?: number; + nameAscii?: string; /** - * Returns the localized name of a building block type. + * Specifies the font name in a right-to-left language document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: string; - } - /** An interface describing the data returned by calling `checkboxContentControl.toJSON()`. */ - export interface CheckboxContentControlData { + nameBidirectional?: string; /** - * Specifies the current state of the checkbox. + * Specifies the East Asian font name. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isChecked?: boolean; - } - /** An interface describing the data returned by calling `comment.toJSON()`. */ - export interface CommentData { - /** - * Specifies the comment's content range. - * - * @remarks - * [Api set: WordApi 1.4] - */ - contentRange?: Word.Interfaces.CommentContentRangeData; + nameFarEast?: string; /** - * Gets the collection of reply objects associated with the comment. - * - * @remarks - * [Api set: WordApi 1.4] - */ - replies?: Word.Interfaces.CommentReplyData[]; + * Specifies the font used for characters with codes from 128 through 255. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nameOther?: string; /** - * Gets the email of the comment's author. + * Specifies the number form setting for an OpenType font. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - authorEmail?: string; + numberForm?: Word.NumberForm | "Default" | "Lining" | "OldStyle"; /** - * Gets the name of the comment's author. + * Specifies the number spacing setting for the font. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - authorName?: string; + numberSpacing?: Word.NumberSpacing | "Default" | "Proportional" | "Tabular"; /** - * Specifies the comment's content as plain text. + * Specifies if the font is formatted as outlined. The possible values are as follows: + + - `true`: All the text is outlined. + + - `false`: None of the text is outlined. + + - `null`: Returned if some, but not all, of the text is outlined. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - content?: string; + outline?: boolean; /** - * Gets the creation date of the comment. + * Specifies the position of text (in points) relative to the base line. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - creationDate?: Date; + position?: number; /** - * Gets the ID of the comment. + * Specifies the scaling percentage applied to the font. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: string; + scaling?: number; /** - * Specifies the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved. + * Specifies if the font is formatted as shadowed. The possible values are as follows: + + - `true`: All the text is shadowed. + + - `false`: None of the text is shadowed. + + - `null`: Returned if some, but not all, of the text is shadowed. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - resolved?: boolean; - } - /** An interface describing the data returned by calling `commentCollection.toJSON()`. */ - export interface CommentCollectionData { - items?: Word.Interfaces.CommentData[]; - } - /** An interface describing the data returned by calling `commentContentRange.toJSON()`. */ - export interface CommentContentRangeData { + shadow?: boolean; /** - * Specifies a value that indicates whether the comment text is bold. + * Specifies a value that represents the font size in points. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - bold?: boolean; + size?: number; /** - * Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. + * Specifies the font size in points for right-to-left text. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - hyperlink?: string; + sizeBidirectional?: number; /** - * Checks whether the range length is zero. + * Specifies whether the font is formatted as small caps, 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: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isEmpty?: boolean; + smallCaps?: boolean; /** - * Specifies a value that indicates whether the comment text is italicized. + * Specifies the spacing between characters. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - italic?: boolean; + spacing?: number; /** - * Specifies a value that indicates whether the comment text has a strikethrough. + * Specifies a value that indicates whether the font has a strikethrough. True if the font is formatted as strikethrough text, otherwise, false. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ strikeThrough?: boolean; /** - * Gets the text of the comment range. + * Specifies the stylistic set for the font. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - text?: string; + stylisticSet?: Word.StylisticSet | "Default" | "Set01" | "Set02" | "Set03" | "Set04" | "Set05" | "Set06" | "Set07" | "Set08" | "Set09" | "Set10" | "Set11" | "Set12" | "Set13" | "Set14" | "Set15" | "Set16" | "Set17" | "Set18" | "Set19" | "Set20"; /** - * Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined. + * Specifies a value that indicates whether the font is a subscript. True if the font is formatted as subscript, otherwise, false. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; - } - /** An interface describing the data returned by calling `commentReply.toJSON()`. */ - export interface CommentReplyData { - /** - * Specifies the commentReply's content range. - * - * @remarks - * [Api set: WordApi 1.4] - */ - contentRange?: Word.Interfaces.CommentContentRangeData; - /** - * Gets the parent comment of this reply. - * - * @remarks - * [Api set: WordApi 1.4] - */ - parentComment?: Word.Interfaces.CommentData; + subscript?: boolean; /** - * Gets the email of the comment reply's author. + * Specifies a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - authorEmail?: string; + superscript?: boolean; /** - * Gets the name of the comment reply's author. + * Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - authorName?: string; + underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; /** - * Specifies the comment reply's content. The string is plain text. + * Specifies the color of the underline for the `Font` object. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - content?: string; + underlineColor?: string; + } + /** An interface describing the data returned by calling `headingStyle.toJSON()`. */ + export interface HeadingStyleData { /** - * Gets the creation date of the comment reply. + * Specifies the level for the heading style in a table of contents or table of figures. Must be a value from 1 to 9. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - creationDate?: Date; + level?: number; /** - * Gets the ID of the comment reply. + * Specifies the name of style for a heading. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: string; + name?: string; } - /** An interface describing the data returned by calling `commentReplyCollection.toJSON()`. */ - export interface CommentReplyCollectionData { - items?: Word.Interfaces.CommentReplyData[]; + /** An interface describing the data returned by calling `headingStyleCollection.toJSON()`. */ + export interface HeadingStyleCollectionData { + items?: Word.Interfaces.HeadingStyleData[]; } - /** An interface describing the data returned by calling `xmlMapping.toJSON()`. */ - export interface XmlMappingData { + /** An interface describing the data returned by calling `hyperlink.toJSON()`. */ + export interface HyperlinkData { /** - * Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to. + * Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeData; + /** + * Specifies the address (for example, a file name or URL) of the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customXmlNode?: Word.Interfaces.CustomXmlNodeData; + address?: string; /** - * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. + * Specifies the text string for the hyperlink's subject line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customXmlPart?: Word.Interfaces.CustomXmlPartData; + emailSubject?: string; /** - * Returns whether the content control in the document is mapped to an XML node in the document's XML data store. + * Returns `true` if extra information is required to resolve the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isMapped?: boolean; + isExtraInfoRequired?: boolean; /** - * Returns the prefix mappings used to evaluate the XPath for the current XML mapping. + * Returns the name of the `Hyperlink` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - prefixMappings?: string; + name?: string; /** - * Returns the XPath for the XML mapping, which evaluates to the currently mapped XML node. + * Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xpath?: string; - } - /** An interface describing the data returned by calling `customXmlPrefixMappingCollection.toJSON()`. */ - export interface CustomXmlPrefixMappingCollectionData { - items?: Word.Interfaces.CustomXmlPrefixMappingData[]; - } - /** An interface describing the data returned by calling `customXmlPrefixMapping.toJSON()`. */ - export interface CustomXmlPrefixMappingData { + screenTip?: string; /** - * Gets the unique address identifier for the namespace of the `CustomXmlPrefixMapping` object. + * Specifies a named location in the destination of the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - namespaceUri?: string; + subAddress?: string; /** - * Gets the prefix for the `CustomXmlPrefixMapping` object. + * Specifies the name of the frame or window in which to load the hyperlink. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - prefix?: string; - } - /** An interface describing the data returned by calling `customXmlSchema.toJSON()`. */ - export interface CustomXmlSchemaData { + target?: string; /** - * Gets the location of the schema on a computer. + * Specifies the hyperlink's visible text in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - location?: string; + textToDisplay?: string; /** - * Gets the unique address identifier for the namespace of the `CustomXmlSchema` object. + * Returns the hyperlink type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - namespaceUri?: string; - } - /** An interface describing the data returned by calling `customXmlSchemaCollection.toJSON()`. */ - export interface CustomXmlSchemaCollectionData { - items?: Word.Interfaces.CustomXmlSchemaData[]; + type?: Word.HyperlinkType | "Range" | "Shape" | "InlineShape"; } - /** An interface describing the data returned by calling `customXmlValidationErrorCollection.toJSON()`. */ - export interface CustomXmlValidationErrorCollectionData { - items?: Word.Interfaces.CustomXmlValidationErrorData[]; + /** An interface describing the data returned by calling `hyperlinkCollection.toJSON()`. */ + export interface HyperlinkCollectionData { + items?: Word.Interfaces.HyperlinkData[]; } - /** An interface describing the data returned by calling `customXmlValidationError.toJSON()`. */ - export interface CustomXmlValidationErrorData { + /** An interface describing the data returned by calling `inlinePicture.toJSON()`. */ + export interface InlinePictureData { /** - * Gets the node associated with this `CustomXmlValidationError` object, if any exist.If no nodes exist, the property returns `Nothing`. + * Specifies a string that represents the alternative text associated with the inline image. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - node?: Word.Interfaces.CustomXmlNodeData; + altTextDescription?: string; /** - * Gets an integer representing the validation error in the `CustomXmlValidationError` object. + * Specifies a string that contains the title for the inline image. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - errorCode?: number; + altTextTitle?: string; /** - * Gets the name of the error in the `CustomXmlValidationError` object.If no errors exist, the property returns `Nothing` + * Specifies a number that describes the height of the inline image. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - name?: string; + height?: number; /** - * Gets the text in the `CustomXmlValidationError` object. + * Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - text?: string; + hyperlink?: string; /** - * Gets the type of error generated from the `CustomXmlValidationError` object. + * Gets the format of the inline image. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - type?: Word.CustomXmlValidationErrorType | "schemaGenerated" | "automaticallyCleared" | "manual"; + imageFormat?: Word.ImageFormat | "Unsupported" | "Undefined" | "Bmp" | "Jpeg" | "Gif" | "Tiff" | "Png" | "Icon" | "Exif" | "Wmf" | "Emf" | "Pict" | "Pdf" | "Svg"; + /** + * Specifies a value that indicates whether the inline image retains its original proportions when you resize it. + * + * @remarks + * [Api set: WordApi 1.1] + */ + lockAspectRatio?: boolean; + /** + * Specifies a number that describes the width of the inline image. + * + * @remarks + * [Api set: WordApi 1.1] + */ + width?: number; } - /** An interface describing the data returned by calling `customXmlNodeCollection.toJSON()`. */ - export interface CustomXmlNodeCollectionData { - items?: Word.Interfaces.CustomXmlNodeData[]; + /** An interface describing the data returned by calling `inlinePictureCollection.toJSON()`. */ + export interface InlinePictureCollectionData { + items?: Word.Interfaces.InlinePictureData[]; } - /** An interface describing the data returned by calling `customXmlNode.toJSON()`. */ - export interface CustomXmlNodeData { + /** An interface describing the data returned by calling `linkFormat.toJSON()`. */ + export interface LinkFormatData { /** - * Gets a `CustomXmlNodeCollection` object representing the attributes of the current element in the current node. + * Specifies if the link is updated automatically when the container file is opened or when the source file is changed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - attributes?: Word.Interfaces.CustomXmlNodeData[]; + isAutoUpdated?: boolean; /** - * Gets a `CustomXmlNodeCollection` object containing all of the child elements of the current node. + * Specifies if a `Field`, `InlineShape`, or `Shape` object is locked to prevent automatic updating. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - childNodes?: Word.Interfaces.CustomXmlNodeData[]; + isLocked?: boolean; /** - * Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. + * Specifies if the linked picture is saved with the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - firstChild?: Word.Interfaces.CustomXmlNodeData; + isPictureSavedWithDocument?: boolean; /** - * Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. + * Specifies the path and name of the source file for the linked OLE object, picture, or field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lastChild?: Word.Interfaces.CustomXmlNodeData; + sourceFullName?: string; /** - * Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. + * Gets the name of the source file for the linked OLE object, picture, or field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nextSibling?: Word.Interfaces.CustomXmlNodeData; + sourceName?: string; /** - * Gets the object representing the part associated with this node. + * Gets the path of the source file for the linked OLE object, picture, or field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - ownerPart?: Word.Interfaces.CustomXmlPartData; + sourcePath?: string; /** - * Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. + * Gets the link type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - parentNode?: Word.Interfaces.CustomXmlNodeData; + type?: Word.LinkType | "Ole" | "Picture" | "Text" | "Reference" | "Include" | "Import" | "Dde" | "DdeAuto" | "Chart"; + } + /** An interface describing the data returned by calling `list.toJSON()`. */ + export interface ListData { /** - * Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. + * Gets paragraphs in the list. + * + * @remarks + * [Api set: WordApi 1.3] + */ + paragraphs?: Word.Interfaces.ParagraphData[]; + /** + * Gets the list's id. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - previousSibling?: Word.Interfaces.CustomXmlNodeData; + id?: number; /** - * Gets the base name of the node without the namespace prefix, if one exists. + * Checks whether each of the 9 levels exists in the list. A true value indicates the level exists, which means there is at least one list item at that level. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - baseName?: string; + levelExistences?: boolean[]; /** - * Gets the unique address identifier for the namespace of the node. + * Gets all 9 level types in the list. Each type can be 'Bullet', 'Number', or 'Picture'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - namespaceUri?: string; + levelTypes?: Word.ListLevelType[]; + } + /** An interface describing the data returned by calling `listCollection.toJSON()`. */ + export interface ListCollectionData { + items?: Word.Interfaces.ListData[]; + } + /** An interface describing the data returned by calling `listItem.toJSON()`. */ + export interface ListItemData { /** - * Gets the type of the current node. + * Specifies the level of the item in the list. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - nodeType?: Word.CustomXmlNodeType | "element" | "attribute" | "text" | "cData" | "processingInstruction" | "comment" | "document"; + level?: number; /** - * Specifies the value of the current node. + * Gets the list item bullet, number, or picture as a string. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - nodeValue?: string; + listString?: string; /** - * Specifies the text for the current node. + * Gets the list item order number in relation to its siblings. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - text?: string; + siblingIndex?: number; + } + /** An interface describing the data returned by calling `listLevel.toJSON()`. */ + export interface ListLevelData { /** - * Gets a string with the canonicalized XPath for the current node. If the node is no longer in the Document Object Model (DOM), the property returns an error message. + * Gets a Font object that represents the character formatting of the specified object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - xpath?: string; + font?: Word.Interfaces.FontData; /** - * Gets the XML representation of the current node and its children. + * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - xml?: string; - } - /** An interface describing the data returned by calling `contentControl.toJSON()`. */ - export interface ContentControlData { + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `BuildingBlockGallery`. It's `null` otherwise. + * Specifies the name of the style that's linked to the specified list level object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlData; + linkedStyle?: string; /** - * Gets the data of the content control when its type is `CheckBox`. It's `null` otherwise. + * Specifies the number format for the specified list level. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApiDesktop 1.1] */ - checkboxContentControl?: Word.Interfaces.CheckboxContentControlData; + numberFormat?: string; /** - * Gets the data of the content control when its type is `ComboBox`. It's `null` otherwise. + * Specifies the position (in points) of the number or bullet for the specified list level object. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApiDesktop 1.1] */ - comboBoxContentControl?: Word.Interfaces.ComboBoxContentControlData; + numberPosition?: number; /** - * Gets the collection of content control objects in the content control. + * Specifies the number style for the list level object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - contentControls?: Word.Interfaces.ContentControlData[]; + numberStyle?: Word.ListBuiltInNumberStyle | "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter" | "Ordinal" | "CardinalText" | "OrdinalText" | "Kanji" | "KanjiDigit" | "AiueoHalfWidth" | "IrohaHalfWidth" | "ArabicFullWidth" | "KanjiTraditional" | "KanjiTraditional2" | "NumberInCircle" | "Aiueo" | "Iroha" | "ArabicLZ" | "Bullet" | "Ganada" | "Chosung" | "GBNum1" | "GBNum2" | "GBNum3" | "GBNum4" | "Zodiac1" | "Zodiac2" | "Zodiac3" | "TradChinNum1" | "TradChinNum2" | "TradChinNum3" | "TradChinNum4" | "SimpChinNum1" | "SimpChinNum2" | "SimpChinNum3" | "SimpChinNum4" | "HanjaRead" | "HanjaReadDigit" | "Hangul" | "Hanja" | "Hebrew1" | "Arabic1" | "Hebrew2" | "Arabic2" | "HindiLetter1" | "HindiLetter2" | "HindiArabic" | "HindiCardinalText" | "ThaiLetter" | "ThaiArabic" | "ThaiCardinalText" | "VietCardinalText" | "LowercaseRussian" | "UppercaseRussian" | "LowercaseGreek" | "UppercaseGreek" | "ArabicLZ2" | "ArabicLZ3" | "ArabicLZ4" | "LowercaseTurkish" | "UppercaseTurkish" | "LowercaseBulgarian" | "UppercaseBulgarian" | "PictureBullet" | "Legal" | "LegalLZ"; /** - * Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `DatePicker`. It's `null` otherwise. + * Specifies the list level that must appear before the specified list level restarts numbering at 1. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + resetOnHigher?: number; + /** + * Specifies the starting number for the specified list level object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + startAt?: number; + /** + * Specifies the tab position for the specified list level object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + tabPosition?: number; + /** + * Specifies the position (in points) for the second line of wrapping text for the specified list level object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + textPosition?: number; + /** + * Specifies the character inserted after the number for the specified list level. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + trailingCharacter?: Word.TrailingCharacter | "TrailingTab" | "TrailingSpace" | "TrailingNone"; + } + /** An interface describing the data returned by calling `listLevelCollection.toJSON()`. */ + export interface ListLevelCollectionData { + items?: Word.Interfaces.ListLevelData[]; + } + /** An interface describing the data returned by calling `listTemplate.toJSON()`. */ + export interface ListTemplateData { + /** + * Gets a `ListLevelCollection` object that represents all the levels for the list template. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + listLevels?: Word.Interfaces.ListLevelData[]; + /** + * Specifies the name of the list template. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - datePickerContentControl?: Word.Interfaces.DatePickerContentControlData; + name?: string; /** - * Gets the data of the content control when its type is `DropDownList`. It's `null` otherwise. + * Specifies whether the list template is outline numbered. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApiDesktop 1.1] */ - dropDownListContentControl?: Word.Interfaces.DropDownListContentControlData; + outlineNumbered?: boolean; + } + /** An interface describing the data returned by calling `noteItem.toJSON()`. */ + export interface NoteItemData { /** - * Gets the collection of field objects in the content control. + * Represents the body object of the note item. It's the portion of the text within the footnote or endnote. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.5] */ - fields?: Word.Interfaces.FieldData[]; + body?: Word.Interfaces.BodyData; /** - * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. + * Represents a footnote or endnote reference in the main document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - font?: Word.Interfaces.FontData; + reference?: Word.Interfaces.RangeData; /** - * Gets the group-related data if the content control's {@link Word.ContentControlType} is `Group`. It's `null` otherwise. + * Represents the note item type: footnote or endnote. + * + * @remarks + * [Api set: WordApi 1.5] + */ + type?: Word.NoteItemType | "Footnote" | "Endnote"; + } + /** An interface describing the data returned by calling `noteItemCollection.toJSON()`. */ + export interface NoteItemCollectionData { + items?: Word.Interfaces.NoteItemData[]; + } + /** An interface describing the data returned by calling `oleFormat.toJSON()`. */ + export interface OleFormatData { + /** + * Specifies the class type for the specified OLE object, picture, or field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - groupContentControl?: Word.Interfaces.GroupContentControlData; + classType?: string; /** - * Gets the collection of InlinePicture objects in the content control. The collection doesn't include floating images. + * Specifies the icon that is used when the `displayAsIcon` property is `true`. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - inlinePictures?: Word.Interfaces.InlinePictureData[]; + iconIndex?: number; /** - * Gets the collection of list objects in the content control. + * Specifies the text displayed below the icon for the OLE object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lists?: Word.Interfaces.ListData[]; + iconLabel?: string; /** - * Gets the collection of paragraph objects in the content control. + * Specifies the program file in which the icon for the OLE object is stored. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + iconName?: string; + /** + * Gets the path of the file in which the icon for the OLE object is stored. * - * Important: For requirement sets 1.1 and 1.2, paragraphs in tables wholly contained within this content control aren't returned. From requirement set 1.3, paragraphs in such tables are also returned. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - paragraphs?: Word.Interfaces.ParagraphData[]; + iconPath?: string; /** - * Gets the picture-related data if the content control's {@link Word.ContentControlType} is `Picture`. It's `null` otherwise. + * Gets whether the specified object is displayed as an icon. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pictureContentControl?: Word.Interfaces.PictureContentControlData; + isDisplayedAsIcon?: boolean; /** - * Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `RepeatingSection`. It's `null` otherwise. + * Specifies whether formatting done in Microsoft Word to the linked OLE object is preserved. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlData; + isFormattingPreservedOnUpdate?: boolean; /** - * Gets the collection of table objects in the content control. + * Gets a string that's used to identify the portion of the source file that's being linked. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tables?: Word.Interfaces.TableData[]; + label?: string; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Gets the programmatic identifier (`ProgId`) for the specified OLE object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingData; + progID?: string; + } + /** An interface describing the data returned by calling `page.toJSON()`. */ + export interface PageData { /** - * Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. + * Gets a `BreakCollection` object that represents the breaks on the page. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + breaks?: Word.Interfaces.BreakData[]; /** - * Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited. + * Gets the height, in points, of the paper defined in the Page Setup dialog box. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - cannotDelete?: boolean; + height?: number; /** - * Specifies a value that indicates whether the user can edit the contents of the content control. + * Gets the index of the page. The page index is 1-based and independent of the user's custom page numbering. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - cannotEdit?: boolean; + index?: number; /** - * Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. + * Gets the width, in points, of the paper defined in the Page Setup dialog box. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - color?: string; + width?: number; + } + /** An interface describing the data returned by calling `pageCollection.toJSON()`. */ + export interface PageCollectionData { + items?: Word.Interfaces.PageData[]; + } + /** An interface describing the data returned by calling `pane.toJSON()`. */ + export interface PaneData { /** - * Gets an integer that represents the content control identifier. + * Gets the collection of pages in the pane. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - id?: number; + pages?: Word.Interfaces.PageData[]; /** - * Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. + * Gets the `PageCollection` shown in the viewport of the pane. If a page is partially visible in the pane, the whole page is returned. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - placeholderText?: string; + pagesEnclosingViewport?: Word.Interfaces.PageData[]; + } + /** An interface describing the data returned by calling `paneCollection.toJSON()`. */ + export interface PaneCollectionData { + items?: Word.Interfaces.PaneData[]; + } + /** An interface describing the data returned by calling `window.toJSON()`. */ + export interface WindowData { /** - * Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. + * Gets the next document window in the collection of open document windows. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - removeWhenEdited?: boolean; + next?: Word.Interfaces.WindowData; /** - * Specifies the style name for the content control. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * Gets the previous document window in the collection open document windows. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: string; + previous?: Word.Interfaces.WindowData; /** - * Specifies the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Specifies whether rulers are displayed for the window or pane. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + areRulersDisplayed?: boolean; /** - * Gets the content control subtype. The subtype can be 'RichTextInline', 'RichTextParagraphs', 'RichTextTableCell', 'RichTextTableRow' and 'RichTextTable' for rich text content controls, or 'PlainTextInline' and 'PlainTextParagraph' for plain text content controls, or 'CheckBox' for checkbox content controls. + * Specifies whether comments, footnotes, endnotes, and hyperlinks are displayed as tips. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - subtype?: Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" | "RichText" | "PlainText" | "Group"; + areScreenTipsDisplayed?: boolean; /** - * Specifies a tag to identify a content control. + * Specifies whether thumbnail images of the pages in a document are displayed along the left side of the Microsoft Word document window. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tag?: string; + areThumbnailsDisplayed?: boolean; /** - * Gets the text of the content control. + * Specifies the caption text for the window that is displayed in the title bar of the document or application window. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - text?: string; + caption?: string; /** - * Specifies the title for a content control. + * Specifies the height of the window (in points). * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - title?: string; + height?: number; /** - * Gets the content control type. Only rich text, plain text, and checkbox content controls are supported currently. + * Specifies the horizontal scroll position as a percentage of the document width. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" | "RichText" | "PlainText" | "Group"; - } - /** An interface describing the data returned by calling `contentControlCollection.toJSON()`. */ - export interface ContentControlCollectionData { - items?: Word.Interfaces.ContentControlData[]; - } - /** An interface describing the data returned by calling `contentControlListItem.toJSON()`. */ - export interface ContentControlListItemData { + horizontalPercentScrolled?: number; /** - * Specifies the display text of a list item for a dropdown list or combo box content control. + * Specifies the default start-up mode for the Japanese Input Method Editor (IME). * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - displayText?: string; + imeMode?: Word.ImeMode | "NoControl" | "On" | "Off" | "Hiragana" | "Katakana" | "KatakanaHalf" | "AlphaFull" | "Alpha" | "HangulFull" | "Hangul"; /** - * Specifies the index location of a content control list item in the collection of list items. + * Gets the position of an item in a collection. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ index?: number; /** - * Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * Specifies whether the window is active. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - value?: string; - } - /** An interface describing the data returned by calling `contentControlListItemCollection.toJSON()`. */ - export interface ContentControlListItemCollectionData { - items?: Word.Interfaces.ContentControlListItemData[]; - } - /** An interface describing the data returned by calling `customProperty.toJSON()`. */ - export interface CustomPropertyData { + isActive?: boolean; /** - * Gets the key of the custom property. + * Specifies whether the document map is visible. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - key?: string; + isDocumentMapVisible?: boolean; /** - * Gets the value type of the custom property. Possible values are: String, Number, Date, Boolean. + * Specifies whether the email message header is visible in the document window. The default value is `False`. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: Word.DocumentPropertyType | "String" | "Number" | "Date" | "Boolean"; + isEnvelopeVisible?: boolean; /** - * Specifies the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). + * Specifies whether a horizontal scroll bar is displayed for the window. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - value?: any; - } - /** An interface describing the data returned by calling `customPropertyCollection.toJSON()`. */ - export interface CustomPropertyCollectionData { - items?: Word.Interfaces.CustomPropertyData[]; - } - /** An interface describing the data returned by calling `customXmlPart.toJSON()`. */ - export interface CustomXmlPartData { + isHorizontalScrollBarDisplayed?: boolean; /** - * Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. + * Specifies whether the vertical scroll bar appears on the left side of the document window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - documentElement?: Word.Interfaces.CustomXmlNodeData; + isLeftScrollBarDisplayed?: boolean; /** - * Gets a `CustomXmlValidationErrorCollection` object that provides access to any XML validation errors. + * Specifies whether the vertical ruler appears on the right side of the document window in print layout view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - errors?: Word.Interfaces.CustomXmlValidationErrorData[]; + isRightRulerDisplayed?: boolean; /** - * Gets the set of namespace prefix mappings used against the current `CustomXmlPart` object. + * Specifies whether the window is split into multiple panes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - namespaceManager?: Word.Interfaces.CustomXmlPrefixMappingData[]; + isSplit?: boolean; /** - * Specifies a `CustomXmlSchemaCollection` object representing the set of schemas attached to a bound region of data in the document. + * Specifies whether a vertical ruler is displayed for the window or pane. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - schemaCollection?: Word.Interfaces.CustomXmlSchemaData[]; + isVerticalRulerDisplayed?: boolean; /** - * Gets a value that indicates whether the `CustomXmlPart` is built-in. + * Specifies whether a vertical scroll bar is displayed for the window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - builtIn?: boolean; + isVerticalScrollBarDisplayed?: boolean; /** - * Gets the ID of the custom XML part. + * Specifies whether the window is visible. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: string; + isVisible?: boolean; /** - * Gets the namespace URI of the custom XML part. + * Specifies the horizontal position of the window, measured in points. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - namespaceUri?: string; + left?: number; /** - * Gets the XML representation of the current `CustomXmlPart` object. + * Specifies how Microsoft Word displays source documents after a compare and merge process. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xml?: string; - } - /** An interface describing the data returned by calling `customXmlPartCollection.toJSON()`. */ - export interface CustomXmlPartCollectionData { - items?: Word.Interfaces.CustomXmlPartData[]; - } - /** An interface describing the data returned by calling `customXmlPartScopedCollection.toJSON()`. */ - export interface CustomXmlPartScopedCollectionData { - items?: Word.Interfaces.CustomXmlPartData[]; - } - /** An interface describing the data returned by calling `document.toJSON()`. */ - export interface DocumentData { + showSourceDocuments?: Word.ShowSourceDocuments | "None" | "Original" | "Revised" | "Both"; /** - * Gets the active window for the document. + * Specifies the vertical split percentage for the window. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - activeWindow?: Word.Interfaces.WindowData; + splitVertical?: number; /** - * Returns a `Bibliography` object that represents the bibliography references contained within the document. + * Specifies the width of the style area in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bibliography?: Word.Interfaces.BibliographyData; + styleAreaWidth?: number; /** - * Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * Specifies the vertical position of the document window, in points. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - body?: Word.Interfaces.BodyData; + top?: number; /** - * Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. + * Gets the window type. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - contentControls?: Word.Interfaces.ContentControlData[]; + type?: Word.WindowType | "Document" | "Template"; /** - * Gets the custom XML parts in the document. + * Gets the height (in points) of the active working area in the document window. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - customXmlParts?: Word.Interfaces.CustomXmlPartData[]; + usableHeight?: number; /** - * Returns a `DocumentLibraryVersionCollection` object that represents the collection of versions of a shared document that has versioning enabled and that's stored in a document library on a server. + * Gets the width (in points) of the active working area in the document window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - documentLibraryVersions?: Word.Interfaces.DocumentLibraryVersionData[]; + usableWidth?: number; /** - * Returns a `FrameCollection` object that represents all the frames in the document. + * Specifies the vertical scroll position as a percentage of the document length. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - frames?: Word.Interfaces.FrameData[]; + verticalPercentScrolled?: number; /** - * Returns a `HyperlinkCollection` object that represents all the hyperlinks in the document. + * Specifies the width of the document window, in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hyperlinks?: Word.Interfaces.HyperlinkData[]; + width?: number; /** - * Returns a `PageSetup` object that's associated with the document. + * Gets an integer that represents the position of the window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageSetup?: Word.Interfaces.PageSetupData; + windowNumber?: number; /** - * Gets the properties of the document. + * Specifies the state of the document window or task window. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - properties?: Word.Interfaces.DocumentPropertiesData; + windowState?: Word.WindowState | "Normal" | "Maximize" | "Minimize"; + } + /** An interface describing the data returned by calling `windowCollection.toJSON()`. */ + export interface WindowCollectionData { + items?: Word.Interfaces.WindowData[]; + } + /** An interface describing the data returned by calling `paragraph.toJSON()`. */ + export interface ParagraphData { /** - * Gets the collection of section objects in the document. + * Returns a `BorderUniversalCollection` object that represents all the borders for the paragraph. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - sections?: Word.Interfaces.SectionData[]; + borders?: Word.Interfaces.BorderUniversalData[]; /** - * Gets the add-in's settings in the document. + * Gets the collection of fields in the paragraph. * * @remarks * [Api set: WordApi 1.4] */ - settings?: Word.Interfaces.SettingData[]; + fields?: Word.Interfaces.FieldData[]; /** - * Gets the collection of `Word.Window` objects for the document. + * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] */ - windows?: Word.Interfaces.WindowData[]; + font?: Word.Interfaces.FontData; /** - * Specifies if automatic hyphenation is turned on for the document. + * Gets the collection of InlinePicture objects in the paragraph. The collection doesn't include floating images. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - autoHyphenation?: boolean; + inlinePictures?: Word.Interfaces.InlinePictureData[]; /** - * Specifies if the edits in the document are automatically saved. + * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - autoSaveOn?: boolean; + listItem?: Word.Interfaces.ListItemData; /** - * Specifies the ChangeTracking mode. + * Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return 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: WordApi 1.4] + * [Api set: WordApi 1.3] */ - changeTrackingMode?: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly"; + listItemOrNullObject?: Word.Interfaces.ListItemData; /** - * Specifies the maximum number of consecutive lines that can end with hyphens. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - consecutiveHyphensLimit?: number; + shading?: Word.Interfaces.ShadingUniversalData; /** - * Specifies whether words in all capital letters can be hyphenated. + * Gets the collection of shape objects anchored in the paragraph, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - hyphenateCaps?: boolean; + shapes?: Word.Interfaces.ShapeData[]; /** - * Specifies whether Microsoft Word has detected the language of the document text. + * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - languageDetected?: boolean; + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Indicates whether the changes in the document have been saved. A value of true indicates that the document hasn't changed since it was saved. + * Specifies the value, in points, for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. * * @remarks * [Api set: WordApi 1.1] */ - saved?: boolean; - } - /** An interface describing the data returned by calling `documentCreated.toJSON()`. */ - export interface DocumentCreatedData { - /** - * Gets the body object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.3] - */ - body?: Word.Interfaces.BodyData; - /** - * Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.3] - */ - contentControls?: Word.Interfaces.ContentControlData[]; - /** - * Gets the custom XML parts in the document. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.4] - */ - customXmlParts?: Word.Interfaces.CustomXmlPartData[]; - /** - * Gets the properties of the document. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.3] - */ - properties?: Word.Interfaces.DocumentPropertiesData; + firstLineIndent?: number; /** - * Gets the collection of section objects in the document. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.3] - */ - sections?: Word.Interfaces.SectionData[]; + * Indicates the paragraph is the last one inside its parent body. + * + * @remarks + * [Api set: WordApi 1.3] + */ + isLastParagraph?: boolean; /** - * Gets the add-in's settings in the document. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.4] - */ - settings?: Word.Interfaces.SettingData[]; + * Checks whether the paragraph is a list item. + * + * @remarks + * [Api set: WordApi 1.3] + */ + isListItem?: boolean; /** - * Indicates whether the changes in the document have been saved. A value of true indicates that the document hasn't changed since it was saved. + * Specifies the left indent value, in points, for the paragraph. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] + * [Api set: WordApi 1.1] */ - saved?: boolean; - } - /** An interface describing the data returned by calling `documentProperties.toJSON()`. */ - export interface DocumentPropertiesData { + leftIndent?: number; /** - * Gets the collection of custom properties of the document. - * - * @remarks - * [Api set: WordApi 1.3] - */ - customProperties?: Word.Interfaces.CustomPropertyData[]; + * Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. + * + * @remarks + * [Api set: WordApi 1.1] + */ + lineSpacing?: number; /** - * Gets the application name of the document. + * Specifies the amount of spacing, in grid lines, after the paragraph. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - applicationName?: string; + lineUnitAfter?: number; /** - * Specifies the author of the document. + * Specifies the amount of spacing, in grid lines, before the paragraph. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - author?: string; + lineUnitBefore?: number; /** - * Specifies the category of the document. + * Specifies the outline level for the paragraph. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - category?: string; + outlineLevel?: number; /** - * Specifies the Comments field in the metadata of the document. These have no connection to comments by users made in the document. + * Specifies the right indent value, in points, for the paragraph. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - comments?: string; + rightIndent?: number; /** - * Specifies the company of the document. + * Specifies the spacing, in points, after the paragraph. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - company?: string; + spaceAfter?: number; /** - * Gets the creation date of the document. + * Specifies the spacing, in points, before the paragraph. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - creationDate?: Date; + spaceBefore?: number; /** - * Specifies the format of the document. + * Specifies the style name for the paragraph. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - format?: string; + style?: string; /** - * Specifies the keywords of the document. + * Specifies the built-in style name for the paragraph. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks * [Api set: WordApi 1.3] */ - keywords?: string; + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; /** - * Gets the last author of the document. + * Gets the level of the paragraph's table. It returns 0 if the paragraph isn't in a table. * * @remarks * [Api set: WordApi 1.3] */ - lastAuthor?: string; + tableNestingLevel?: number; /** - * Gets the last print date of the document. + * Gets the text of the paragraph. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - lastPrintDate?: Date; + text?: string; /** - * Gets the last save time of the document. + * Gets a string that represents the paragraph identifier in the current session. ID is in standard 8-4-4-4-12 GUID format without curly braces and differs across sessions and coauthors. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - lastSaveTime?: Date; + uniqueLocalId?: string; + } + /** An interface describing the data returned by calling `paragraphCollection.toJSON()`. */ + export interface ParagraphCollectionData { + items?: Word.Interfaces.ParagraphData[]; + } + /** An interface describing the data returned by calling `paragraphFormat.toJSON()`. */ + export interface ParagraphFormatData { /** - * Specifies the manager of the document. + * Specifies the alignment for the specified paragraphs. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - manager?: string; + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Gets the revision number of the document. + * Specifies the value (in points) for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - revisionNumber?: string; + firstLineIndent?: number; /** - * Gets security settings of the document. Some are access restrictions on the file on disk. Others are Document Protection settings. Some possible values are 0 = File on disk is read/write; 1 = Protect Document: File is encrypted and requires a password to open; 2 = Protect Document: Always Open as Read-Only; 3 = Protect Document: Both #1 and #2; 4 = File on disk is read-only; 5 = Both #1 and #4; 6 = Both #2 and #4; 7 = All of #1, #2, and #4; 8 = Protect Document: Restrict Edit to read-only; 9 = Both #1 and #8; 10 = Both #2 and #8; 11 = All of #1, #2, and #8; 12 = Both #4 and #8; 13 = All of #1, #4, and #8; 14 = All of #2, #4, and #8; 15 = All of #1, #2, #4, and #8. + * Specifies whether all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - security?: number; + keepTogether?: boolean; /** - * Specifies the subject of the document. + * Specifies whether the specified paragraph remains on the same page as the paragraph that follows it when Microsoft Word repaginates the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - subject?: string; + keepWithNext?: boolean; /** - * Gets the template of the document. + * Specifies the left indent. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - template?: string; + leftIndent?: number; /** - * Specifies the title of the document. + * Specifies the line spacing (in points) for the specified paragraphs. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - title?: string; - } - /** An interface describing the data returned by calling `dropDownListContentControl.toJSON()`. */ - export interface DropDownListContentControlData { - } - /** An interface describing the data returned by calling `comboBoxContentControl.toJSON()`. */ - export interface ComboBoxContentControlData { - } - /** An interface describing the data returned by calling `field.toJSON()`. */ - export interface FieldData { + lineSpacing?: number; /** - * Gets the field's result data. - * - * @remarks - * [Api set: WordApi 1.4] - */ - result?: Word.Interfaces.RangeData; + * Specifies the amount of spacing (in gridlines) after the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + lineUnitAfter?: number; /** - * Specifies the field's code instruction. + * Specifies the amount of spacing (in gridlines) before the specified paragraphs. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.5] + */ + lineUnitBefore?: number; + /** + * Specifies whether left and right indents are the same width. * - * Note: The ability to set the code was introduced in WordApi 1.5. + * @remarks + * [Api set: WordApi 1.5] */ - code?: string; + mirrorIndents?: boolean; /** - * Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is `null` and it will throw a general exception when code attempts to set it. + * Specifies the outline level for the specified paragraphs. * * @remarks * [Api set: WordApi 1.5] */ - data?: string; + outlineLevel?: Word.OutlineLevel | "OutlineLevel1" | "OutlineLevel2" | "OutlineLevel3" | "OutlineLevel4" | "OutlineLevel5" | "OutlineLevel6" | "OutlineLevel7" | "OutlineLevel8" | "OutlineLevel9" | "OutlineLevelBodyText"; /** - * Gets the field's kind. + * Specifies the right indent (in points) for the specified paragraphs. * * @remarks * [Api set: WordApi 1.5] */ - kind?: Word.FieldKind | "None" | "Hot" | "Warm" | "Cold"; + rightIndent?: number; /** - * Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. + * Specifies the amount of spacing (in points) after the specified paragraph or text column. * * @remarks * [Api set: WordApi 1.5] */ - locked?: boolean; + spaceAfter?: number; /** - * Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise. + * Specifies the spacing (in points) before the specified paragraphs. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - showCodes?: boolean; + spaceBefore?: number; /** - * Gets the field's type. + * Specifies whether the first and last lines in the specified paragraph remain on the same page as the rest of the paragraph when Microsoft Word repaginates the document. * * @remarks * [Api set: WordApi 1.5] */ - type?: Word.FieldType | "Addin" | "AddressBlock" | "Advance" | "Ask" | "Author" | "AutoText" | "AutoTextList" | "BarCode" | "Bibliography" | "BidiOutline" | "Citation" | "Comments" | "Compare" | "CreateDate" | "Data" | "Database" | "Date" | "DisplayBarcode" | "DocProperty" | "DocVariable" | "EditTime" | "Embedded" | "EQ" | "Expression" | "FileName" | "FileSize" | "FillIn" | "FormCheckbox" | "FormDropdown" | "FormText" | "GotoButton" | "GreetingLine" | "Hyperlink" | "If" | "Import" | "Include" | "IncludePicture" | "IncludeText" | "Index" | "Info" | "Keywords" | "LastSavedBy" | "Link" | "ListNum" | "MacroButton" | "MergeBarcode" | "MergeField" | "MergeRec" | "MergeSeq" | "Next" | "NextIf" | "NoteRef" | "NumChars" | "NumPages" | "NumWords" | "OCX" | "Page" | "PageRef" | "Print" | "PrintDate" | "Private" | "Quote" | "RD" | "Ref" | "RevNum" | "SaveDate" | "Section" | "SectionPages" | "Seq" | "Set" | "Shape" | "SkipIf" | "StyleRef" | "Subject" | "Subscriber" | "Symbol" | "TA" | "TC" | "Template" | "Time" | "Title" | "TOA" | "TOC" | "UserAddress" | "UserInitials" | "UserName" | "XE" | "Empty" | "Others" | "Undefined"; - } - /** An interface describing the data returned by calling `fieldCollection.toJSON()`. */ - export interface FieldCollectionData { - items?: Word.Interfaces.FieldData[]; + widowControl?: boolean; } - /** An interface describing the data returned by calling `font.toJSON()`. */ - export interface FontData { + /** An interface describing the data returned by calling `range.toJSON()`. */ + export interface RangeData { /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the font. + * Returns a `BorderUniversalCollection` object that represents all the borders for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -44860,7253 +55007,7624 @@ export declare namespace Word { */ borders?: Word.Interfaces.BorderUniversalData[]; /** - * Returns a `FillFormat` object that contains fill formatting properties for the font used by the range of text. + * Returns a `ConflictCollection` object that contains all the {@link Word.Conflict} objects in the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fill?: Word.Interfaces.FillFormatData; + conflicts?: Word.Interfaces.ConflictData[]; /** - * Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text. + * Gets the collection of field objects in the range. + * + * @remarks + * [Api set: WordApi 1.4] + */ + fields?: Word.Interfaces.FieldData[]; + /** + * Gets the text format of the range. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ + font?: Word.Interfaces.FontData; + /** + * Gets a `FrameCollection` object that represents all the frames in the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - glow?: Word.Interfaces.GlowFormatData; + frames?: Word.Interfaces.FrameData[]; /** - * Returns a `LineFormat` object that specifies the formatting for a line. + * Returns a `HyperlinkCollection` object that represents all the hyperlinks in the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - line?: Word.Interfaces.LineFormatData; + hyperlinks?: Word.Interfaces.HyperlinkData[]; /** - * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. + * Gets the collection of inline picture objects in the range. + * + * @remarks + * [Api set: WordApi 1.2] + */ + inlinePictures?: Word.Interfaces.InlinePictureData[]; + /** + * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + listFormat?: Word.Interfaces.ListFormatData; + /** + * Gets the collection of pages in the range. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + pages?: Word.Interfaces.PageData[]; + /** + * Gets the collection of sections in the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - reflection?: Word.Interfaces.ReflectionFormatData; + sections?: Word.Interfaces.SectionData[]; /** - * Returns a `ColorFormat` object that represents the color for the font. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textColor?: Word.Interfaces.ColorFormatData; + shading?: Word.Interfaces.ShadingUniversalData; /** - * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. + * Gets the collection of shape objects anchored in the range, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - textShadow?: Word.Interfaces.ShadowFormatData; + shapes?: Word.Interfaces.ShapeData[]; /** - * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font. + * Gets a `TableColumnCollection` object that represents all the table columns in the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - threeDimensionalFormat?: Word.Interfaces.ThreeDimensionalFormatData; + tableColumns?: Word.Interfaces.TableColumnData[]; /** - * Specifies whether the font is formatted as all capital letters, 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. + * Specifies whether the range is formatted as bold. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - allCaps?: boolean; + bold?: boolean; /** - * Specifies a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false. + * Specifies whether the range is formatted as bold in a right-to-left language document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bold?: boolean; + boldBidirectional?: boolean; /** - * Specifies whether the font is formatted as bold in a right-to-left language document. 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. + * Specifies a `CharacterCase` value that represents the case of the text in the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - boldBidirectional?: boolean; + case?: Word.CharacterCase | "Next" | "Lower" | "Upper" | "TitleWord" | "TitleSentence" | "Toggle" | "HalfWidth" | "FullWidth" | "Katakana" | "Hiragana"; /** - * Specifies the color for the specified font. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies the character width of the range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - color?: string; + characterWidth?: Word.CharacterWidth | "Half" | "Full"; /** - * Specifies a `ColorIndex` value that represents the color for the font. + * Specifies if the range contains combined characters. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - colorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + combineCharacters?: boolean; /** - * Specifies the color for the `Font` object in a right-to-left language document. + * Specifies if Microsoft Word ignores the number of characters per line for the corresponding `Range` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - colorIndexBidirectional?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + disableCharacterSpaceGrid?: boolean; /** - * Specifies whether contextual alternates are enabled for the font. + * Specifies the emphasis mark for a character or designated character string. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contextualAlternates?: boolean; + emphasisMark?: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle"; /** - * Specifies the color to be used for diacritics for the `Font` object. You can provide the value in the '#RRGGBB' format. + * Specifies the ending character position of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - diacriticColor?: string; + end?: number; /** - * Specifies whether Microsoft Word ignores the number of characters per line for the corresponding `Font` object. + * Specifies the width (in the current measurement units) in which Microsoft Word fits the text in the current selection or range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - disableCharacterSpaceGrid?: boolean; + fitTextWidth?: number; /** - * Specifies a value that indicates whether the font has a double strikethrough. True if the font is formatted as double strikethrough text, otherwise, false. + * Specifies if a grammar check has been run on the range or document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - doubleStrikeThrough?: boolean; + grammarChecked?: boolean; /** - * Specifies whether the font is formatted as embossed. The possible values are as follows: - - - `true`: All the text is embossed. - - - `false`: None of the text is embossed. - - - `null`: Returned if some, but not all, of the text is embossed. + * Specifies the proofing status (spelling and grammar checking) of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - emboss?: boolean; + hasNoProofing?: boolean; /** - * Specifies an `EmphasisMark` value that represents the emphasis mark for a character or designated character string. + * Specifies the highlight color for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - emphasisMark?: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle"; + highlightColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Specifies whether the font is formatted as engraved. The possible values are as follows: - - - `true`: All the text is engraved. - - - `false`: None of the text is engraved. - - - `null`: Returned if some, but not all, of the text is engraved. + * Specifies the formatting for horizontal text set within vertical text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - engrave?: boolean; + horizontalInVertical?: Word.HorizontalInVerticalType | "None" | "FitInLine" | "ResizeLine"; /** - * Specifies a value that indicates whether the font is tagged as hidden. True if the font is formatted as hidden text, otherwise, false. + * Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. Use a '#' to separate the address part from the optional location part. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - hidden?: boolean; + hyperlink?: string; /** - * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or `null` for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. + * Specifies the ID for the range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - highlightColor?: string; + id?: string; /** - * Specifies a value that indicates whether the font is italicized. True if the font is italicized, otherwise, false. + * Checks whether the range length is zero. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - italic?: boolean; + isEmpty?: boolean; /** - * Specifies whether the font is italicized in a right-to-left language document. 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. + * Gets if the range is collapsed and is located at the end-of-row mark in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - italicBidirectional?: boolean; + isEndOfRowMark?: boolean; /** - * Specifies the minimum font size for which Microsoft Word will adjust kerning automatically. + * Gets whether the text in the range is visible on the screen. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - kerning?: number; + isTextVisibleOnScreen?: boolean; /** - * Specifies the ligature setting for the `Font` object. + * Specifies if the font or range is formatted as italic. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - ligature?: Word.Ligature | "None" | "Standard" | "Contextual" | "StandardContextual" | "Historical" | "StandardHistorical" | "ContextualHistorical" | "StandardContextualHistorical" | "Discretional" | "StandardDiscretional" | "ContextualDiscretional" | "StandardContextualDiscretional" | "HistoricalDiscretional" | "StandardHistoricalDiscretional" | "ContextualHistoricalDiscretional" | "All"; + italic?: boolean; /** - * Specifies a value that represents the name of the font. + * Specifies if the font or range is formatted as italic (right-to-left languages). * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - name?: string; + italicBidirectional?: boolean; /** - * Specifies the font used for Latin text (characters with character codes from 0 (zero) through 127). + * Specifies whether the range of Japanese language text is hiragana or katakana. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nameAscii?: string; + kana?: Word.Kana | "Katakana" | "Hiragana"; /** - * Specifies the font name in a right-to-left language document. + * Specifies whether Microsoft Word has detected the language of the text in the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nameBidirectional?: string; + languageDetected?: boolean; /** - * Specifies the East Asian font name. + * Specifies a `LanguageId` value that represents the language for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nameFarEast?: string; + languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies the font used for characters with codes from 128 through 255. + * Specifies an East Asian language for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nameOther?: string; + languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies the number form setting for an OpenType font. + * Specifies a language for the range that isn't classified as an East Asian language. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - numberForm?: Word.NumberForm | "Default" | "Lining" | "OldStyle"; + languageIdOther?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies the number spacing setting for the font. + * Specifies if all nonprinting characters (such as hidden text, tab marks, space marks, and paragraph marks) are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - numberSpacing?: Word.NumberSpacing | "Default" | "Proportional" | "Tabular"; + showAll?: boolean; /** - * Specifies if the font is formatted as outlined. The possible values are as follows: - - - `true`: All the text is outlined. - - - `false`: None of the text is outlined. - - - `null`: Returned if some, but not all, of the text is outlined. + * Specifies if spelling has been checked throughout the range or document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - outline?: boolean; + spellingChecked?: boolean; /** - * Specifies the position of text (in points) relative to the base line. + * Specifies the starting character position of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - position?: number; + start?: number; /** - * Specifies the scaling percentage applied to the font. + * Gets the number of characters in the story that contains the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - scaling?: number; + storyLength?: number; /** - * Specifies if the font is formatted as shadowed. The possible values are as follows: - - - `true`: All the text is shadowed. - - - `false`: None of the text is shadowed. - - - `null`: Returned if some, but not all, of the text is shadowed. + * Gets the story type for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shadow?: boolean; + storyType?: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; /** - * Specifies a value that represents the font size in points. + * Specifies the style name for the range. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. * * @remarks * [Api set: WordApi 1.1] */ - size?: number; + style?: string; /** - * Specifies the font size in points for right-to-left text. + * Specifies the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - sizeBidirectional?: number; + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; /** - * Specifies whether the font is formatted as small caps, 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. + * Gets the text of the range. + * + * @remarks + * [Api set: WordApi 1.1] + */ + text?: string; + /** + * Specifies whether Microsoft Word sets two lines of text in one and specifies the characters that enclose the text, if any. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - smallCaps?: boolean; + twoLinesInOne?: Word.TwoLinesInOneType | "None" | "NoBrackets" | "Parentheses" | "SquareBrackets" | "AngleBrackets" | "CurlyBrackets"; /** - * Specifies the spacing between characters. + * Specifies the type of underline applied to the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spacing?: number; + underline?: Word.Underline | "None" | "Single" | "Words" | "Double" | "Dotted" | "Thick" | "Dash" | "DotDash" | "DotDotDash" | "Wavy" | "WavyHeavy" | "DottedHeavy" | "DashHeavy" | "DotDashHeavy" | "DotDotDashHeavy" | "DashLong" | "DashLongHeavy" | "WavyDouble"; + } + /** An interface describing the data returned by calling `rangeCollection.toJSON()`. */ + export interface RangeCollectionData { + items?: Word.Interfaces.RangeData[]; + } + /** An interface describing the data returned by calling `searchOptions.toJSON()`. */ + export interface SearchOptionsData { /** - * Specifies a value that indicates whether the font has a strikethrough. True if the font is formatted as strikethrough text, otherwise, false. + * Specifies a value that indicates whether to ignore all punctuation characters between words. Corresponds to the Ignore punctuation check box in the Find and Replace dialog box. * * @remarks * [Api set: WordApi 1.1] */ - strikeThrough?: boolean; + ignorePunct?: boolean; /** - * Specifies the stylistic set for the font. + * Specifies a value that indicates whether to ignore all whitespace between words. Corresponds to the Ignore whitespace characters check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - stylisticSet?: Word.StylisticSet | "Default" | "Set01" | "Set02" | "Set03" | "Set04" | "Set05" | "Set06" | "Set07" | "Set08" | "Set09" | "Set10" | "Set11" | "Set12" | "Set13" | "Set14" | "Set15" | "Set16" | "Set17" | "Set18" | "Set19" | "Set20"; + ignoreSpace?: boolean; /** - * Specifies a value that indicates whether the font is a subscript. True if the font is formatted as subscript, otherwise, false. + * Specifies a value that indicates whether to perform a case sensitive search. Corresponds to the Match case check box in the Find and Replace dialog box. * * @remarks * [Api set: WordApi 1.1] */ - subscript?: boolean; + matchCase?: boolean; /** - * Specifies a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false. + * Specifies a value that indicates whether to match words that begin with the search string. Corresponds to the Match prefix check box in the Find and Replace dialog box. * * @remarks * [Api set: WordApi 1.1] */ - superscript?: boolean; + matchPrefix?: boolean; /** - * Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined. + * Specifies a value that indicates whether to match words that end with the search string. Corresponds to the Match suffix check box in the Find and Replace dialog box. * * @remarks * [Api set: WordApi 1.1] */ - underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; + matchSuffix?: boolean; /** - * Specifies the color of the underline for the `Font` object. You can provide the value in the '#RRGGBB' format. + * Specifies a value that indicates whether to find operation only entire words, not text that is part of a larger word. Corresponds to the Find whole words only check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - underlineColor?: string; + matchWholeWord?: boolean; + /** + * Specifies a value that indicates whether the search will be performed using special search operators. Corresponds to the Use wildcards check box in the Find and Replace dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + matchWildcards?: boolean; } - /** An interface describing the data returned by calling `hyperlink.toJSON()`. */ - export interface HyperlinkData { + /** An interface describing the data returned by calling `section.toJSON()`. */ + export interface SectionData { /** - * Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. + * Gets the body object of the section. This doesn't include the header/footer and other section metadata. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - range?: Word.Interfaces.RangeData; + body?: Word.Interfaces.BodyData; /** - * Specifies the address (for example, a file name or URL) of the hyperlink. + * Returns a `BorderUniversalCollection` object that represents all the borders in the section. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - address?: string; + borders?: Word.Interfaces.BorderUniversalData[]; /** - * Specifies the text string for the hyperlink's subject line. + * Returns a `PageSetup` object that's associated with the section. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - emailSubject?: string; + pageSetup?: Word.Interfaces.PageSetupData; /** - * Returns `true` if extra information is required to resolve the hyperlink. + * Specifies if the section is protected for forms. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isExtraInfoRequired?: boolean; + protectedForForms?: boolean; + } + /** An interface describing the data returned by calling `sectionCollection.toJSON()`. */ + export interface SectionCollectionData { + items?: Word.Interfaces.SectionData[]; + } + /** An interface describing the data returned by calling `setting.toJSON()`. */ + export interface SettingData { /** - * Returns the name of the `Hyperlink` object. + * Gets the key of the setting. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - name?: string; + key?: string; /** - * Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink. + * Specifies the value of the setting. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - screenTip?: string; + value?: any; + } + /** An interface describing the data returned by calling `settingCollection.toJSON()`. */ + export interface SettingCollectionData { + items?: Word.Interfaces.SettingData[]; + } + /** An interface describing the data returned by calling `styleCollection.toJSON()`. */ + export interface StyleCollectionData { + items?: Word.Interfaces.StyleData[]; + } + /** An interface describing the data returned by calling `style.toJSON()`. */ + export interface StyleData { /** - * Specifies a named location in the destination of the hyperlink. + * Specifies a BorderCollection object that represents all the borders for the specified style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - subAddress?: string; + borders?: Word.Interfaces.BorderData[]; /** - * Specifies the name of the frame or window in which to load the hyperlink. + * Gets a font object that represents the character formatting of the specified style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - target?: string; + font?: Word.Interfaces.FontData; /** - * Specifies the hyperlink's visible text in the document. + * Returns a `Frame` object that represents the frame formatting for the style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textToDisplay?: string; + frame?: Word.Interfaces.FrameData; /** - * Returns the hyperlink type. + * Specifies a link between a paragraph and a character style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.HyperlinkType | "Range" | "Shape" | "InlineShape"; - } - /** An interface describing the data returned by calling `hyperlinkCollection.toJSON()`. */ - export interface HyperlinkCollectionData { - items?: Word.Interfaces.HyperlinkData[]; - } - /** An interface describing the data returned by calling `inlinePicture.toJSON()`. */ - export interface InlinePictureData { + linkStyle?: Word.Interfaces.StyleData; /** - * Specifies a string that represents the alternative text associated with the inline image. + * Gets a ListTemplate object that represents the list formatting for the specified Style object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - altTextDescription?: string; + listTemplate?: Word.Interfaces.ListTemplateData; /** - * Specifies a string that contains the title for the inline image. + * Gets a ParagraphFormat object that represents the paragraph settings for the specified style. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - altTextTitle?: string; + paragraphFormat?: Word.Interfaces.ParagraphFormatData; /** - * Specifies a number that describes the height of the inline image. + * Gets a Shading object that represents the shading for the specified style. Not applicable to List style. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.6] */ - height?: number; + shading?: Word.Interfaces.ShadingData; /** - * Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. + * Gets a TableStyle object representing Style properties that can be applied to a table. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.6] */ - hyperlink?: string; + tableStyle?: Word.Interfaces.TableStyleData; /** - * Gets the format of the inline image. + * Specifies whether the style is automatically redefined based on the selection. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - imageFormat?: Word.ImageFormat | "Unsupported" | "Undefined" | "Bmp" | "Jpeg" | "Gif" | "Tiff" | "Png" | "Icon" | "Exif" | "Wmf" | "Emf" | "Pict" | "Pdf" | "Svg"; + automaticallyUpdate?: boolean; /** - * Specifies a value that indicates whether the inline image retains its original proportions when you resize it. + * Specifies the name of an existing style to use as the base formatting of another style. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] + * + * Note: The ability to set `baseStyle` was introduced in WordApi 1.6. */ - lockAspectRatio?: boolean; + baseStyle?: string; /** - * Specifies a number that describes the width of the inline image. + * Gets whether the specified style is a built-in style. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - width?: number; - } - /** An interface describing the data returned by calling `inlinePictureCollection.toJSON()`. */ - export interface InlinePictureCollectionData { - items?: Word.Interfaces.InlinePictureData[]; - } - /** An interface describing the data returned by calling `linkFormat.toJSON()`. */ - export interface LinkFormatData { + builtIn?: boolean; /** - * Specifies if the link is updated automatically when the container file is opened or when the source file is changed. + * Gets the description of the specified style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isAutoUpdated?: boolean; + description?: string; /** - * Specifies if a `Field`, `InlineShape`, or `Shape` object is locked to prevent automatic updating. + * Specifies whether the spelling and grammar checker ignores text formatted with this style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isLocked?: boolean; + hasProofing?: boolean; /** - * Specifies if the linked picture is saved with the document. + * Gets whether the specified style is a built-in style that has been modified or applied in the document or a new style that has been created in the document. + * + * @remarks + * [Api set: WordApi 1.5] + */ + inUse?: boolean; + /** + * Specifies a `LanguageId` value that represents the language for the style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isPictureSavedWithDocument?: boolean; + languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies the path and name of the source file for the linked OLE object, picture, or field. + * Specifies an East Asian language for the style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sourceFullName?: string; + languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Gets the name of the source file for the linked OLE object, picture, or field. + * Gets whether a style is a linked style that can be used for both paragraph and character formatting. + * + * @remarks + * [Api set: WordApi 1.5] + */ + linked?: boolean; + /** + * Returns the list level for the style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sourceName?: string; + listLevelNumber?: number; /** - * Gets the path of the source file for the linked OLE object, picture, or field. + * Specifies whether the style cannot be changed or edited. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sourcePath?: string; + locked?: boolean; /** - * Gets the link type. + * Gets the name of a style in the language of the user. + * + * @remarks + * [Api set: WordApi 1.5] + */ + nameLocal?: string; + /** + * Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style. + * + * @remarks + * [Api set: WordApi 1.5] + * + * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. + */ + nextParagraphStyle?: string; + /** + * Specifies whether to remove spacing between paragraphs that are formatted using the same style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.LinkType | "Ole" | "Picture" | "Text" | "Reference" | "Include" | "Import" | "Dde" | "DdeAuto" | "Chart"; - } - /** An interface describing the data returned by calling `list.toJSON()`. */ - export interface ListData { + noSpaceBetweenParagraphsOfSameStyle?: boolean; /** - * Gets paragraphs in the list. - * - * @remarks - * [Api set: WordApi 1.3] - */ - paragraphs?: Word.Interfaces.ParagraphData[]; + * Specifies the priority. + * + * @remarks + * [Api set: WordApi 1.5] + */ + priority?: number; /** - * Gets the list's id. + * Specifies whether the style corresponds to an available quick style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - id?: number; + quickStyle?: boolean; /** - * Checks whether each of the 9 levels exists in the list. A true value indicates the level exists, which means there is at least one list item at that level. + * Gets the style type. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - levelExistences?: boolean[]; + type?: Word.StyleType | "Character" | "List" | "Paragraph" | "Table"; /** - * Gets all 9 level types in the list. Each type can be 'Bullet', 'Number', or 'Picture'. + * Specifies whether the specified style is made visible as a recommended style in the Styles and in the Styles task pane in Microsoft Word after it's used in the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - levelTypes?: Word.ListLevelType[]; - } - /** An interface describing the data returned by calling `listCollection.toJSON()`. */ - export interface ListCollectionData { - items?: Word.Interfaces.ListData[]; - } - /** An interface describing the data returned by calling `listItem.toJSON()`. */ - export interface ListItemData { + unhideWhenUsed?: boolean; /** - * Specifies the level of the item in the list. + * Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - level?: number; + visibility?: boolean; + } + /** An interface describing the data returned by calling `shading.toJSON()`. */ + export interface ShadingData { /** - * Gets the list item bullet, number, or picture as a string. + * Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - listString?: string; + backgroundPatternColor?: string; /** - * Gets the list item order number in relation to its siblings. + * Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - siblingIndex?: number; - } - /** An interface describing the data returned by calling `listLevel.toJSON()`. */ - export interface ListLevelData { + foregroundPatternColor?: string; /** - * Gets a Font object that represents the character formatting of the specified object. + * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. * * @remarks * [Api set: WordApiDesktop 1.1] */ - font?: Word.Interfaces.FontData; + texture?: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; + } + /** An interface describing the data returned by calling `shadingUniversal.toJSON()`. */ + export interface ShadingUniversalData { /** - * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. + * Specifies the color that's applied to the background of the `ShadingUniversal` object. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + backgroundPatternColor?: string; /** - * Specifies the name of the style that's linked to the specified list level object. + * Specifies the color that's applied to the background of the `ShadingUniversal` object. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - linkedStyle?: string; + backgroundPatternColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Specifies the number format for the specified list level. + * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - numberFormat?: string; + foregroundPatternColor?: string; /** - * Specifies the position (in points) of the number or bullet for the specified list level object. + * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - numberPosition?: number; + foregroundPatternColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Specifies the number style for the list level object. + * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - numberStyle?: Word.ListBuiltInNumberStyle | "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter" | "Ordinal" | "CardinalText" | "OrdinalText" | "Kanji" | "KanjiDigit" | "AiueoHalfWidth" | "IrohaHalfWidth" | "ArabicFullWidth" | "KanjiTraditional" | "KanjiTraditional2" | "NumberInCircle" | "Aiueo" | "Iroha" | "ArabicLZ" | "Bullet" | "Ganada" | "Chosung" | "GBNum1" | "GBNum2" | "GBNum3" | "GBNum4" | "Zodiac1" | "Zodiac2" | "Zodiac3" | "TradChinNum1" | "TradChinNum2" | "TradChinNum3" | "TradChinNum4" | "SimpChinNum1" | "SimpChinNum2" | "SimpChinNum3" | "SimpChinNum4" | "HanjaRead" | "HanjaReadDigit" | "Hangul" | "Hanja" | "Hebrew1" | "Arabic1" | "Hebrew2" | "Arabic2" | "HindiLetter1" | "HindiLetter2" | "HindiArabic" | "HindiCardinalText" | "ThaiLetter" | "ThaiArabic" | "ThaiCardinalText" | "VietCardinalText" | "LowercaseRussian" | "UppercaseRussian" | "LowercaseGreek" | "UppercaseGreek" | "ArabicLZ2" | "ArabicLZ3" | "ArabicLZ4" | "LowercaseTurkish" | "UppercaseTurkish" | "LowercaseBulgarian" | "UppercaseBulgarian" | "PictureBullet" | "Legal" | "LegalLZ"; + texture?: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; + } + /** An interface describing the data returned by calling `table.toJSON()`. */ + export interface TableData { /** - * Specifies the list level that must appear before the specified list level restarts numbering at 1. + * Gets the collection of field objects in the table. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - resetOnHigher?: number; + fields?: Word.Interfaces.FieldData[]; /** - * Specifies the starting number for the specified list level object. + * Gets the font. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - startAt?: number; + font?: Word.Interfaces.FontData; /** - * Specifies the tab position for the specified list level object. + * Gets all of the table rows. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - tabPosition?: number; + rows?: Word.Interfaces.TableRowData[]; /** - * Specifies the position (in points) for the second line of wrapping text for the specified list level object. + * Gets the child tables nested one level deeper. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - textPosition?: number; + tables?: Word.Interfaces.TableData[]; /** - * Specifies the character inserted after the number for the specified list level. + * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - trailingCharacter?: Word.TrailingCharacter | "TrailingTab" | "TrailingSpace" | "TrailingNone"; - } - /** An interface describing the data returned by calling `listLevelCollection.toJSON()`. */ - export interface ListLevelCollectionData { - items?: Word.Interfaces.ListLevelData[]; - } - /** An interface describing the data returned by calling `listTemplate.toJSON()`. */ - export interface ListTemplateData { + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Gets a `ListLevelCollection` object that represents all the levels for the list template. + * Specifies the description of the table. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listLevels?: Word.Interfaces.ListLevelData[]; + description?: string; /** - * Specifies whether the list template is outline numbered. + * Specifies the number of header rows. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - outlineNumbered?: boolean; - } - /** An interface describing the data returned by calling `noteItem.toJSON()`. */ - export interface NoteItemData { + headerRowCount?: number; /** - * Represents the body object of the note item. It's the portion of the text within the footnote or endnote. + * Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - body?: Word.Interfaces.BodyData; + horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Represents a footnote or endnote reference in the main document. + * Indicates whether all of the table rows are uniform. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - reference?: Word.Interfaces.RangeData; + isUniform?: boolean; /** - * Represents the note item type: footnote or endnote. + * Gets the nesting level of the table. Top-level tables have level 1. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - type?: Word.NoteItemType | "Footnote" | "Endnote"; - } - /** An interface describing the data returned by calling `noteItemCollection.toJSON()`. */ - export interface NoteItemCollectionData { - items?: Word.Interfaces.NoteItemData[]; - } - /** An interface describing the data returned by calling `oleFormat.toJSON()`. */ - export interface OleFormatData { + nestingLevel?: number; /** - * Specifies the class type for the specified OLE object, picture, or field. + * Gets the number of rows in the table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - classType?: string; + rowCount?: number; /** - * Specifies the icon that is used when the `displayAsIcon` property is `true`. + * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - iconIndex?: number; + shadingColor?: string; /** - * Specifies the text displayed below the icon for the OLE object. + * Specifies the style name for the table. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - iconLabel?: string; + style?: string; /** - * Specifies the program file in which the icon for the OLE object is stored. + * Specifies whether the table has banded columns. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - iconName?: string; + styleBandedColumns?: boolean; /** - * Gets the path of the file in which the icon for the OLE object is stored. + * Specifies whether the table has banded rows. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - iconPath?: string; + styleBandedRows?: boolean; /** - * Gets whether the specified object is displayed as an icon. + * Specifies the built-in style name for the table. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isDisplayedAsIcon?: boolean; + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; /** - * Specifies whether formatting done in Microsoft Word to the linked OLE object is preserved. + * Specifies whether the table has a first column with a special style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isFormattingPreservedOnUpdate?: boolean; + styleFirstColumn?: boolean; /** - * Gets a string that's used to identify the portion of the source file that's being linked. + * Specifies whether the table has a last column with a special style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - label?: string; + styleLastColumn?: boolean; /** - * Gets the programmatic identifier (`ProgId`) for the specified OLE object. + * Specifies whether the table has a total (last) row with a special style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - progID?: string; - } - /** An interface describing the data returned by calling `page.toJSON()`. */ - export interface PageData { + styleTotalRow?: boolean; /** - * Gets a `BreakCollection` object that represents the breaks on the page. + * Specifies the title of the table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - breaks?: Word.Interfaces.BreakData[]; + title?: string; /** - * Gets the height, in points, of the paper defined in the Page Setup dialog box. + * Specifies the text values in the table, as a 2D JavaScript array. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - height?: number; + values?: string[][]; /** - * Gets the index of the page. The page index is 1-based and independent of the user's custom page numbering. + * Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - index?: number; + verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; /** - * Gets the width, in points, of the paper defined in the Page Setup dialog box. + * Specifies the width of the table in points. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ width?: number; } - /** An interface describing the data returned by calling `pageCollection.toJSON()`. */ - export interface PageCollectionData { - items?: Word.Interfaces.PageData[]; - } - /** An interface describing the data returned by calling `pane.toJSON()`. */ - export interface PaneData { + /** An interface describing the data returned by calling `tableStyle.toJSON()`. */ + export interface TableStyleData { /** - * Gets the collection of pages in the pane. + * Specifies the table's alignment against the page margin. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - pages?: Word.Interfaces.PageData[]; + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Gets the `PageCollection` shown in the viewport of the pane. If a page is partially visible in the pane, the whole page is returned. + * Specifies whether lines in tables formatted with a specified style break across pages. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - pagesEnclosingViewport?: Word.Interfaces.PageData[]; - } - /** An interface describing the data returned by calling `paneCollection.toJSON()`. */ - export interface PaneCollectionData { - items?: Word.Interfaces.PaneData[]; - } - /** An interface describing the data returned by calling `window.toJSON()`. */ - export interface WindowData { + allowBreakAcrossPage?: boolean; /** - * Gets the next document window in the collection of open document windows. + * Specifies the amount of space to add between the contents and the bottom borders of the cells. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - next?: Word.Interfaces.WindowData; + bottomCellMargin?: number; /** - * Gets the previous document window in the collection open document windows. + * Specifies the spacing (in points) between the cells in a table style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - previous?: Word.Interfaces.WindowData; + cellSpacing?: number; /** - * Specifies whether rulers are displayed for the window or pane. + * Specifies the number of columns in the banding when a style specifies odd- or even-column banding. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areRulersDisplayed?: boolean; + columnStripe?: number; /** - * Specifies whether comments, footnotes, endnotes, and hyperlinks are displayed as tips. + * Specifies whether Microsoft Word allows to break the specified table across pages. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areScreenTipsDisplayed?: boolean; + isBreakAcrossPagesAllowed?: boolean; /** - * Specifies whether thumbnail images of the pages in a document are displayed along the left side of the Microsoft Word document window. + * Specifies the amount of space to add between the contents and the left borders of the cells. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - areThumbnailsDisplayed?: boolean; + leftCellMargin?: number; /** - * Specifies the caption text for the window that is displayed in the title bar of the document or application window. + * Specifies the left indent value (in points) for the rows in the table style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - caption?: string; + leftIndent?: number; /** - * Specifies the height of the window (in points). + * Specifies the amount of space to add between the contents and the right borders of the cells. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - height?: number; + rightCellMargin?: number; /** - * Specifies the horizontal scroll position as a percentage of the document width. + * Specifies the number of rows to include in the banding when the style specifies odd- or even-row banding. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontalPercentScrolled?: number; + rowStripe?: number; /** - * Specifies the default start-up mode for the Japanese Input Method Editor (IME). + * Specifies the direction in which Microsoft Word orders cells in the table style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - imemode?: Word.ImeMode | "NoControl" | "On" | "Off" | "Hiragana" | "Katakana" | "KatakanaHalf" | "AlphaFull" | "Alpha" | "HangulFull" | "Hangul"; + tableDirection?: Word.TableDirection | "RightToLeft" | "LeftToRight"; /** - * Gets the position of an item in a collection. + * Specifies the amount of space to add between the contents and the top borders of the cells. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - index?: number; + topCellMargin?: number; + } + /** An interface describing the data returned by calling `tabStop.toJSON()`. */ + export interface TabStopData { /** - * Specifies whether the window is active. + * Gets a `TabAlignment` value that represents the alignment for the tab stop. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isActive?: boolean; + alignment?: Word.TabAlignment | "Left" | "Center" | "Right" | "Decimal" | "Bar" | "List"; /** - * Specifies whether the document map is visible. + * Gets whether this tab stop is a custom tab stop. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isDocumentMapVisible?: boolean; + customTab?: boolean; /** - * Specifies whether the email message header is visible in the document window. The default value is `False`. + * Gets a `TabLeader` value that represents the leader for this `TabStop` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isEnvelopeVisible?: boolean; + leader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** - * Specifies whether a horizontal scroll bar is displayed for the window. + * Gets the position of the tab stop relative to the left margin. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isHorizontalScrollBarDisplayed?: boolean; + position?: number; + } + /** An interface describing the data returned by calling `tabStopCollection.toJSON()`. */ + export interface TabStopCollectionData { + items?: Word.Interfaces.TabStopData[]; + } + /** An interface describing the data returned by calling `tableCollection.toJSON()`. */ + export interface TableCollectionData { + items?: Word.Interfaces.TableData[]; + } + /** An interface describing the data returned by calling `tableColumn.toJSON()`. */ + export interface TableColumnData { /** - * Specifies whether the vertical scroll bar appears on the left side of the document window. + * Returns a `BorderUniversalCollection` object that represents all the borders for the table column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isLeftScrollBarDisplayed?: boolean; + borders?: Word.Interfaces.BorderUniversalData[]; /** - * Specifies whether the vertical ruler appears on the right side of the document window in print layout view. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isRightRulerDisplayed?: boolean; + shading?: Word.Interfaces.ShadingUniversalData; /** - * Specifies whether the window is split into multiple panes. + * Returns the position of this column in a collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isSplit?: boolean; + columnIndex?: number; /** - * Specifies whether a vertical ruler is displayed for the window or pane. + * Returns `true` if the column or row is the first one in the table; `false` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVerticalRulerDisplayed?: boolean; + isFirst?: boolean; /** - * Specifies whether a vertical scroll bar is displayed for the window. + * Returns `true` if the column or row is the last one in the table; `false` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVerticalScrollBarDisplayed?: boolean; + isLast?: boolean; /** - * Specifies whether the window is visible. + * Returns the nesting level of the column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + nestingLevel?: number; /** - * Specifies the horizontal position of the window, measured in points. + * Specifies the preferred width (in points or as a percentage of the window width) for the column. + The unit of measurement can be specified by the `preferredWidthType` property. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - left?: number; + preferredWidth?: number; /** - * Specifies how Microsoft Word displays source documents after a compare and merge process. + * Specifies the preferred unit of measurement to use for the width of the table column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showSourceDocuments?: Word.ShowSourceDocuments | "None" | "Original" | "Revised" | "Both"; + preferredWidthType?: Word.PreferredWidthType | "Auto" | "Percent" | "Points"; /** - * Specifies the vertical split percentage for the window. + * Specifies the width of the column, in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - splitVertical?: number; + width?: number; + } + /** An interface describing the data returned by calling `tableColumnCollection.toJSON()`. */ + export interface TableColumnCollectionData { + items?: Word.Interfaces.TableColumnData[]; + } + /** An interface describing the data returned by calling `tableOfAuthorities.toJSON()`. */ + export interface TableOfAuthoritiesData { /** - * Specifies the width of the style area in points. + * Specifies the name of the bookmark from which to collect table of authorities entries. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - styleAreaWidth?: number; + bookmark?: string; /** - * Specifies the vertical position of the document window, in points. + * Specifies the category of entries to be included in the table of authorities. + Values 0 through 16 correspond to the items listed in the Category box of the Table of Authorities dialog. To learn how to access this through the Word UI, see {@link https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0 | Create a table of authorities}. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - top?: number; + category?: number; /** - * Gets the window type. + * Specifies a separator of up to five characters. This appears between the table of authorities entry and its page number. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.WindowType | "Document" | "Template"; + entrySeparator?: string; /** - * Gets the height (in points) of the active working area in the document window. + * Specifies whether the category name for a group of entries appears in the table of authorities. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - usableHeight?: number; + isCategoryHeaderIncluded?: boolean; /** - * Gets the width (in points) of the active working area in the document window. + * Specifies whether the entries in the table of authorities are displayed with their formatting in the table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - usableWidth?: number; + isEntryFormattingKept?: boolean; /** - * Specifies the vertical scroll position as a percentage of the document length. + * Specifies whether references to the same authority that are repeated on five or more pages are replaced with "Passim". * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - verticalPercentScrolled?: number; + isPassimUsed?: boolean; /** - * Specifies the width of the document window, in points. + * Specifies a separator of up to five characters. This appears between individual page references in the table of authorities. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - width?: number; + pageNumberSeparator?: string; /** - * Gets an integer that represents the position of the window. + * Specifies a separator of up to five characters. This appears between ranges of pages in the table of authorities. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - windowNumber?: number; + pageRangeSeparator?: string; /** - * Specifies the state of the document window or task window. + * Specifies the {@link https://support.microsoft.com/office/062a387b-dfc9-4ef8-8235-29ee113d59be | Sequence (SEQ) field} identifier for the table of authorities. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - windowState?: Word.WindowState | "Normal" | "Maximize" | "Minimize"; - } - /** An interface describing the data returned by calling `windowCollection.toJSON()`. */ - export interface WindowCollectionData { - items?: Word.Interfaces.WindowData[]; - } - /** An interface describing the data returned by calling `paragraph.toJSON()`. */ - export interface ParagraphData { + sequenceName?: string; /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the paragraph. + * Specifies a separator of up to five characters. This appears between the sequence number and the page number in the table of authorities. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - borders?: Word.Interfaces.BorderUniversalData[]; - /** - * Gets the collection of fields in the paragraph. - * - * @remarks - * [Api set: WordApi 1.4] - */ - fields?: Word.Interfaces.FieldData[]; - /** - * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ - font?: Word.Interfaces.FontData; - /** - * Gets the collection of InlinePicture objects in the paragraph. The collection doesn't include floating images. - * - * @remarks - * [Api set: WordApi 1.1] - */ - inlinePictures?: Word.Interfaces.InlinePictureData[]; - /** - * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. - * - * @remarks - * [Api set: WordApi 1.3] - */ - listItem?: Word.Interfaces.ListItemData; + sequenceSeparator?: string; /** - * Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return 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 leader character that appears between entries and their associated page numbers in the table of authorities. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listItemOrNullObject?: Word.Interfaces.ListItemData; + tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + } + /** An interface describing the data returned by calling `tableOfAuthoritiesCollection.toJSON()`. */ + export interface TableOfAuthoritiesCollectionData { + items?: Word.Interfaces.TableOfAuthoritiesData[]; + } + /** An interface describing the data returned by calling `tableOfAuthoritiesCategory.toJSON()`. */ + export interface TableOfAuthoritiesCategoryData { /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. + * Specifies the name of this table of authorities category. + Changing the name of the category doesn't change the index in the collection. The value for {@link Word.TableOfAuthorities | TableOfAuthorities.category} will remain the same. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shading?: Word.Interfaces.ShadingUniversalData; + name?: string; + } + /** An interface describing the data returned by calling `tableOfAuthoritiesCategoryCollection.toJSON()`. */ + export interface TableOfAuthoritiesCategoryCollectionData { + items?: Word.Interfaces.TableOfAuthoritiesCategoryData[]; + } + /** An interface describing the data returned by calling `tableOfContents.toJSON()`. */ + export interface TableOfContentsData { /** - * Gets the collection of shape objects anchored in the paragraph, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * Specifies whether built-in heading styles are used for the table of contents. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shapes?: Word.Interfaces.ShapeData[]; + areBuiltInHeadingStylesUsed?: boolean; /** - * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. + * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of contents. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + areFieldsUsed?: boolean; /** - * Specifies the value, in points, for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. + * Specifies whether entries in the table of contents should be formatted as hyperlinks when publishing to the web. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - firstLineIndent?: number; + areHyperlinksUsedOnWeb?: boolean; /** - * Indicates the paragraph is the last one inside its parent body. + * Specifies whether the page numbers in the table of contents should be hidden when publishing to the web. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isLastParagraph?: boolean; + arePageNumbersHiddenOnWeb?: boolean; /** - * Checks whether the paragraph is a list item. + * Specifies whether page numbers are included in the table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isListItem?: boolean; + arePageNumbersIncluded?: boolean; /** - * Specifies the left indent value, in points, for the paragraph. + * Specifies whether page numbers are aligned with the right margin in the table of contents. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftIndent?: number; + arePageNumbersRightAligned?: boolean; /** - * Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. + * Specifies the ending heading level for the table of contents. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineSpacing?: number; + lowerHeadingLevel?: number; /** - * Specifies the amount of spacing, in grid lines, after the paragraph. + * Specifies the character between entries and their page numbers in the table of contents. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitAfter?: number; + tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** - * Specifies the amount of spacing, in grid lines, before the paragraph. + * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of contents. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitBefore?: number; + tableId?: string; /** - * Specifies the outline level for the paragraph. + * Specifies the starting heading level for the table of contents. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - outlineLevel?: number; + upperHeadingLevel?: number; + } + /** An interface describing the data returned by calling `tableOfContentsCollection.toJSON()`. */ + export interface TableOfContentsCollectionData { + items?: Word.Interfaces.TableOfContentsData[]; + } + /** An interface describing the data returned by calling `tableOfFigures.toJSON()`. */ + export interface TableOfFiguresData { /** - * Specifies the right indent value, in points, for the paragraph. + * Specifies whether built-in heading styles are used for the table of figures. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightIndent?: number; + areBuiltInHeadingStylesUsed?: boolean; /** - * Specifies the spacing, in points, after the paragraph. + * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of figures. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - spaceAfter?: number; + areFieldsUsed?: boolean; /** - * Specifies the spacing, in points, before the paragraph. + * Specifies whether entries in the table of figures should be formatted as hyperlinks when publishing to the web. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - spaceBefore?: number; + areHyperlinksUsedOnWeb?: boolean; /** - * Specifies the style name for the paragraph. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * Specifies whether the page numbers in the table of figures should be hidden when publishing to the web. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: string; + arePageNumbersHiddenOnWeb?: boolean; /** - * Specifies the built-in style name for the paragraph. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Specifies whether page numbers are included in the table of figures. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + arePageNumbersIncluded?: boolean; /** - * Gets the level of the paragraph's table. It returns 0 if the paragraph isn't in a table. + * Specifies whether page numbers are aligned with the right margin in the table of figures. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tableNestingLevel?: number; + arePageNumbersRightAligned?: boolean; /** - * Gets the text of the paragraph. + * Specifies the label that identifies the items to be included in the table of figures. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - text?: string; + captionLabel?: string; /** - * Gets a string that represents the paragraph identifier in the current session. ID is in standard 8-4-4-4-12 GUID format without curly braces and differs across sessions and coauthors. + * Specifies whether the caption label and caption number are included in the table of figures. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - uniqueLocalId?: string; - } - /** An interface describing the data returned by calling `paragraphCollection.toJSON()`. */ - export interface ParagraphCollectionData { - items?: Word.Interfaces.ParagraphData[]; - } - /** An interface describing the data returned by calling `paragraphFormat.toJSON()`. */ - export interface ParagraphFormatData { + isLabelIncluded?: boolean; /** - * Specifies the alignment for the specified paragraphs. + * Specifies the ending heading level for the table of figures. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + lowerHeadingLevel?: number; /** - * Specifies the value (in points) for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. + * Specifies the character between entries and their page numbers in the table of figures. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - firstLineIndent?: number; + tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** - * Specifies whether all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document. + * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of figures. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - keepTogether?: boolean; + tableId?: string; /** - * Specifies whether the specified paragraph remains on the same page as the paragraph that follows it when Microsoft Word repaginates the document. + * Specifies the starting heading level for the table of figures. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - keepWithNext?: boolean; + upperHeadingLevel?: number; + } + /** An interface describing the data returned by calling `tableOfFiguresCollection.toJSON()`. */ + export interface TableOfFiguresCollectionData { + items?: Word.Interfaces.TableOfFiguresData[]; + } + /** An interface describing the data returned by calling `tableRow.toJSON()`. */ + export interface TableRowData { /** - * Specifies the left indent. + * Gets cells. + * + * @remarks + * [Api set: WordApi 1.3] + */ + cells?: Word.Interfaces.TableCellData[]; + /** + * Gets the collection of field objects in the table row. + * + * @remarks + * [Api set: WordApi 1.4] + */ + fields?: Word.Interfaces.FieldData[]; + /** + * Gets the font. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.3] + */ + font?: Word.Interfaces.FontData; + /** + * Gets the number of cells in the row. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - leftIndent?: number; + cellCount?: number; /** - * Specifies the line spacing (in points) for the specified paragraphs. + * Specifies the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - lineSpacing?: number; + horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies the amount of spacing (in gridlines) after the specified paragraphs. + * Checks whether the row is a header row. To set the number of header rows, use `headerRowCount` on the Table object. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - lineUnitAfter?: number; + isHeader?: boolean; /** - * Specifies the amount of spacing (in gridlines) before the specified paragraphs. + * Specifies the preferred height of the row in points. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - lineUnitBefore?: number; + preferredHeight?: number; /** - * Specifies whether left and right indents are the same width. + * Gets the index of the row in its parent table. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - mirrorIndents?: boolean; + rowIndex?: number; /** - * Specifies the outline level for the specified paragraphs. + * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - outlineLevel?: Word.OutlineLevel | "OutlineLevel1" | "OutlineLevel2" | "OutlineLevel3" | "OutlineLevel4" | "OutlineLevel5" | "OutlineLevel6" | "OutlineLevel7" | "OutlineLevel8" | "OutlineLevel9" | "OutlineLevelBodyText"; + shadingColor?: string; /** - * Specifies the right indent (in points) for the specified paragraphs. + * Specifies the text values in the row, as a 2D JavaScript array. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - rightIndent?: number; + values?: string[][]; /** - * Specifies the amount of spacing (in points) after the specified paragraph or text column. + * Specifies the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - spaceAfter?: number; + verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + } + /** An interface describing the data returned by calling `tableRowCollection.toJSON()`. */ + export interface TableRowCollectionData { + items?: Word.Interfaces.TableRowData[]; + } + /** An interface describing the data returned by calling `tableCell.toJSON()`. */ + export interface TableCellData { /** - * Specifies the spacing (in points) before the specified paragraphs. + * Gets the body object of the cell. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - spaceBefore?: number; + body?: Word.Interfaces.BodyData; /** - * Specifies whether the first and last lines in the specified paragraph remain on the same page as the rest of the paragraph when Microsoft Word repaginates the document. + * Gets the index of the cell in its row. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - widowControl?: boolean; - } - /** An interface describing the data returned by calling `range.toJSON()`. */ - export interface RangeData { + cellIndex?: number; /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the range. + * Specifies the width of the cell's column in points. This is applicable to uniform tables. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - borders?: Word.Interfaces.BorderUniversalData[]; + columnWidth?: number; /** - * Gets the collection of field objects in the range. + * Specifies the horizontal alignment of the cell. The value can be 'Left', 'Centered', 'Right', or 'Justified'. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - fields?: Word.Interfaces.FieldData[]; + horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Gets the text format of the range. Use this to get and set font name, size, color, and other properties. + * Gets the index of the cell's row in the table. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - font?: Word.Interfaces.FontData; + rowIndex?: number; /** - * Gets a `FrameCollection` object that represents all the frames in the range. + * Specifies the shading color of the cell. Color is specified in "#RRGGBB" format or by using the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - frames?: Word.Interfaces.FrameData[]; + shadingColor?: string; /** - * Returns a `HyperlinkCollection` object that represents all the hyperlinks in the range. + * Specifies the text of the cell. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - hyperlinks?: Word.Interfaces.HyperlinkData[]; + value?: string; /** - * Gets the collection of inline picture objects in the range. + * Specifies the vertical alignment of the cell. The value can be 'Top', 'Center', or 'Bottom'. * * @remarks - * [Api set: WordApi 1.2] + * [Api set: WordApi 1.3] */ - inlinePictures?: Word.Interfaces.InlinePictureData[]; + verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; /** - * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. + * Gets the width of the cell in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - listFormat?: Word.Interfaces.ListFormatData; + width?: number; + } + /** An interface describing the data returned by calling `tableCellCollection.toJSON()`. */ + export interface TableCellCollectionData { + items?: Word.Interfaces.TableCellData[]; + } + /** An interface describing the data returned by calling `tableBorder.toJSON()`. */ + export interface TableBorderData { /** - * Gets the collection of pages in the range. + * Specifies the table border color. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - pages?: Word.Interfaces.PageData[]; + color?: string; /** - * Gets the collection of sections in the range. + * Specifies the type of the table border. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - sections?: Word.Interfaces.SectionData[]; + type?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. + * Specifies the width, in points, of the table border. Not applicable to table border types that have fixed widths. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - shading?: Word.Interfaces.ShadingUniversalData; + width?: number; + } + /** An interface describing the data returned by calling `template.toJSON()`. */ + export interface TemplateData { /** - * Gets the collection of shape objects anchored in the range, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * Specifies the East Asian language to use when breaking lines of text in the document or template. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shapes?: Word.Interfaces.ShapeData[]; + farEastLineBreakLanguage?: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; /** - * Gets a `TableColumnCollection` object that represents all the table columns in the range. + * Specifies the line break control level for the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tableColumns?: Word.Interfaces.TableColumnData[]; + farEastLineBreakLevel?: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"; /** - * Specifies whether the range is formatted as bold. + * Returns the name of the template, including the drive or Web path. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bold?: boolean; + fullName?: string; /** - * Specifies whether the range is formatted as bold in a right-to-left language document. + * Specifies whether the spelling and grammar checker ignores documents based on this template. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - boldBidirectional?: boolean; + hasNoProofing?: boolean; /** - * Specifies a `CharacterCase` value that represents the case of the text in the range. + * Specifies the character spacing adjustment for the template. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - case?: Word.CharacterCase | "Next" | "Lower" | "Upper" | "TitleWord" | "TitleSentence" | "Toggle" | "HalfWidth" | "FullWidth" | "Katakana" | "Hiragana"; + justificationMode?: Word.JustificationMode | "Expand" | "Compress" | "CompressKana"; /** - * Specifies the character width of the range. + * Specifies if Microsoft Word kerns half-width Latin characters and punctuation marks in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - characterWidth?: Word.CharacterWidth | "Half" | "Full"; + kerningByAlgorithm?: boolean; /** - * Specifies if the range contains combined characters. + * Specifies a `LanguageId` value that represents the language in the template. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - combineCharacters?: boolean; + languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies if Microsoft Word ignores the number of characters per line for the corresponding `Range` object. + * Specifies an East Asian language for the language in the template. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - disableCharacterSpaceGrid?: boolean; + languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies the emphasis mark for a character or designated character string. + * Returns only the name of the document template (excluding any path or other location information). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - emphasisMark?: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle"; + name?: string; /** - * Specifies the ending character position of the range. + * Specifies the kinsoku characters after which Microsoft Word will not break a line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - end?: number; + noLineBreakAfter?: string; /** - * Specifies the width (in the current measurement units) in which Microsoft Word fits the text in the current selection or range. + * Specifies the kinsoku characters before which Microsoft Word will not break a line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fitTextWidth?: number; + noLineBreakBefore?: string; /** - * Specifies if a grammar check has been run on the range or document. + * Returns the path to the document template. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - grammarChecked?: boolean; + path?: string; /** - * Specifies the proofing status (spelling and grammar checking) of the range. + * Specifies `true` if the template has not changed since it was last saved, `false` if Microsoft Word displays a prompt to save changes when the document is closed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hasNoProofing?: boolean; + saved?: boolean; /** - * Specifies the highlight color for the range. + * Returns the template type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - highlightColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + type?: Word.TemplateType | "Normal" | "Global" | "Attached"; + } + /** An interface describing the data returned by calling `templateCollection.toJSON()`. */ + export interface TemplateCollectionData { + items?: Word.Interfaces.TemplateData[]; + } + /** An interface describing the data returned by calling `trackedChange.toJSON()`. */ + export interface TrackedChangeData { /** - * Specifies the formatting for horizontal text set within vertical text. + * Gets the author of the tracked change. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - horizontalInVertical?: Word.HorizontalInVerticalType | "None" | "FitInLine" | "ResizeLine"; + author?: string; /** - * Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. Use a '#' to separate the address part from the optional location part. + * Gets the date of the tracked change. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - hyperlink?: string; + date?: Date; /** - * Specifies the ID for the range. + * Gets the text of the tracked change. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - id?: string; + text?: string; /** - * Checks whether the range length is zero. + * Gets the type of the tracked change. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - isEmpty?: boolean; + type?: Word.TrackedChangeType | "None" | "Added" | "Deleted" | "Formatted"; + } + /** An interface describing the data returned by calling `trackedChangeCollection.toJSON()`. */ + export interface TrackedChangeCollectionData { + items?: Word.Interfaces.TrackedChangeData[]; + } + /** An interface describing the data returned by calling `view.toJSON()`. */ + export interface ViewData { /** - * Gets if the range is collapsed and is located at the end-of-row mark in a table. + * Specifies whether all nonprinting characters are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isEndOfRowMark?: boolean; + areAllNonprintingCharactersDisplayed?: boolean; /** - * Gets whether the text in the range is visible on the screen. + * Gets whether background colors and images are shown when the document is displayed in print layout view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTextVisibleOnScreen?: boolean; + areBackgroundsDisplayed?: boolean; /** - * Specifies if the font or range is formatted as italic. + * Gets whether square brackets are displayed at the beginning and end of each bookmark. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - italic?: boolean; + areBookmarksIndicated?: boolean; /** - * Specifies if the font or range is formatted as italic (right-to-left languages). + * Specifies whether Microsoft Word displays the comments in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - italicBidirectional?: boolean; + areCommentsDisplayed?: boolean; /** - * Specifies whether the range of Japanese language text is hiragana or katakana. + * Specifies whether Microsoft Word displays connecting lines from the text to the revision and comment balloons. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - kana?: Word.Kana | "Katakana" | "Hiragana"; + areConnectingLinesToRevisionsBalloonDisplayed?: boolean; /** - * Specifies whether Microsoft Word has detected the language of the text in the range. + * Gets whether crop marks are shown in the corners of pages to indicate where margins are located. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageDetected?: boolean; + areCropMarksDisplayed?: boolean; /** - * Specifies a `LanguageId` value that represents the language for the range. + * Gets whether objects created with the drawing tools are displayed in print layout view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + areDrawingsDisplayed?: boolean; /** - * Specifies an East Asian language for the range. + * Specifies whether shading is applied to the ranges in the document that users have permission to modify. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + areEditableRangesShaded?: boolean; /** - * Specifies a language for the range that isn't classified as an East Asian language. + * Specifies whether field codes are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageIdOther?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + areFieldCodesDisplayed?: boolean; /** - * Specifies if all nonprinting characters (such as hidden text, tab marks, space marks, and paragraph marks) are displayed. + * Specifies whether Microsoft Word displays formatting changes made to the document with Track Changes enabled. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showAll?: boolean; + areFormatChangesDisplayed?: boolean; /** - * Specifies if spelling has been checked throughout the range or document. + * Specifies whether handwritten ink annotations are shown or hidden. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spellingChecked?: boolean; + areInkAnnotationsDisplayed?: boolean; /** - * Specifies the starting character position of the range. + * Specifies whether Microsoft Word displays insertions and deletions made to the document with Track Changes enabled. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - start?: number; + areInsertionsAndDeletionsDisplayed?: boolean; /** - * Gets the number of characters in the story that contains the range. + * Gets whether lines wrap at the right edge of the document window rather than at the right margin or the right column boundary. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - storyLength?: number; + areLinesWrappedToWindow?: boolean; /** - * Gets the story type for the range. + * Gets whether object anchors are displayed next to items that can be positioned in print layout view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - storyType?: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; + areObjectAnchorsDisplayed?: boolean; /** - * Specifies the style name for the range. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * Gets whether Microsoft Word displays optional line breaks. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: string; + areOptionalBreaksDisplayed?: boolean; /** - * Specifies the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Gets whether optional hyphens are displayed. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + areOptionalHyphensDisplayed?: boolean; /** - * Gets the text of the range. + * Gets whether other authors' presence should be visible in the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - text?: string; + areOtherAuthorsVisible?: boolean; /** - * Specifies whether Microsoft Word sets two lines of text in one and specifies the characters that enclose the text, if any. + * Gets whether the top and bottom margins and the gray area between pages in the document are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - twoLinesInOne?: Word.TwoLinesInOneType | "None" | "NoBrackets" | "Parentheses" | "SquareBrackets" | "AngleBrackets" | "CurlyBrackets"; + arePageBoundariesDisplayed?: boolean; /** - * Specifies the type of underline applied to the range. + * Gets whether paragraph marks are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - underline?: Word.Underline | "None" | "Single" | "Words" | "Double" | "Dotted" | "Thick" | "Dash" | "DotDash" | "DotDotDash" | "Wavy" | "WavyHeavy" | "DottedHeavy" | "DashHeavy" | "DotDashHeavy" | "DotDotDashHeavy" | "DashLong" | "DashLongHeavy" | "WavyDouble"; - } - /** An interface describing the data returned by calling `rangeCollection.toJSON()`. */ - export interface RangeCollectionData { - items?: Word.Interfaces.RangeData[]; - } - /** An interface describing the data returned by calling `searchOptions.toJSON()`. */ - export interface SearchOptionsData { + areParagraphsMarksDisplayed?: boolean; /** - * Specifies a value that indicates whether to ignore all punctuation characters between words. Corresponds to the Ignore punctuation check box in the Find and Replace dialog box. + * Gets whether blank boxes are displayed as placeholders for pictures. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ignorePunct?: boolean; + arePicturePlaceholdersDisplayed?: boolean; /** - * Specifies a value that indicates whether to ignore all whitespace between words. Corresponds to the Ignore whitespace characters check box in the Find and Replace dialog box. + * Specifies whether Microsoft Word displays revisions and comments made to the document with Track Changes enabled. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ignoreSpace?: boolean; + areRevisionsAndCommentsDisplayed?: boolean; /** - * Specifies a value that indicates whether to perform a case sensitive search. Corresponds to the Match case check box in the Find and Replace dialog box. + * Gets whether space characters are displayed. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - matchCase?: boolean; + areSpacesIndicated?: boolean; /** - * Specifies a value that indicates whether to match words that begin with the search string. Corresponds to the Match prefix check box in the Find and Replace dialog box. + * Specifies whether table gridlines are displayed. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - matchPrefix?: boolean; + areTableGridlinesDisplayed?: boolean; /** - * Specifies a value that indicates whether to match words that end with the search string. Corresponds to the Match suffix check box in the Find and Replace dialog box. + * Gets whether tab characters are displayed. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - matchSuffix?: boolean; + areTabsDisplayed?: boolean; /** - * Specifies a value that indicates whether to find operation only entire words, not text that is part of a larger word. Corresponds to the Find whole words only check box in the Find and Replace dialog box. + * Gets whether dotted lines are displayed around page margins, text columns, objects, and frames in print layout view. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - matchWholeWord?: boolean; + areTextBoundariesDisplayed?: boolean; /** - * Specifies a value that indicates whether the search will be performed using special search operators. Corresponds to the Use wildcards check box in the Find and Replace dialog box. + * Specifies the column width in Reading mode. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - matchWildcards?: boolean; - } - /** An interface describing the data returned by calling `section.toJSON()`. */ - export interface SectionData { + columnWidth?: Word.ColumnWidth | "Narrow" | "Default" | "Wide"; /** - * Gets the body object of the section. This doesn't include the header/footer and other section metadata. + * Gets on-screen shading for fields. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - body?: Word.Interfaces.BodyData; + fieldShading?: Word.FieldShading | "Never" | "Always" | "WhenSelected"; /** - * Returns a `BorderUniversalCollection` object that represents all the borders in the section. + * Specifies whether all the text in a window is displayed in the same sans-serif font with minimal formatting to speed up display. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - borders?: Word.Interfaces.BorderUniversalData[]; + isDraft?: boolean; /** - * Returns a `PageSetup` object that's associated with the section. + * Specifies whether only the first line of body text is shown in outline view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageSetup?: Word.Interfaces.PageSetupData; + isFirstLineOnlyDisplayed?: boolean; /** - * Specifies if the section is protected for forms. + * Specifies whether character formatting is visible in outline view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - protectedForForms?: boolean; - } - /** An interface describing the data returned by calling `sectionCollection.toJSON()`. */ - export interface SectionCollectionData { - items?: Word.Interfaces.SectionData[]; - } - /** An interface describing the data returned by calling `setting.toJSON()`. */ - export interface SettingData { + isFormatDisplayed?: boolean; /** - * Gets the key of the setting. + * Specifies whether the window is in full-screen view. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - key?: string; + isFullScreen?: boolean; /** - * Specifies the value of the setting. + * Gets whether text formatted as hidden text is displayed. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - value?: any; - } - /** An interface describing the data returned by calling `settingCollection.toJSON()`. */ - export interface SettingCollectionData { - items?: Word.Interfaces.SettingData[]; - } - /** An interface describing the data returned by calling `styleCollection.toJSON()`. */ - export interface StyleCollectionData { - items?: Word.Interfaces.StyleData[]; - } - /** An interface describing the data returned by calling `style.toJSON()`. */ - export interface StyleData { + isHiddenTextDisplayed?: boolean; /** - * Specifies a BorderCollection object that represents all the borders for the specified style. + * Gets whether highlight formatting is displayed and printed with the document. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - borders?: Word.Interfaces.BorderData[]; + isHighlightingDisplayed?: boolean; /** - * Gets a font object that represents the character formatting of the specified style. + * Specifies whether the document is in conflict mode view. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontData; + isInConflictMode?: boolean; /** - * Returns a `Frame` object that represents the frame formatting for the style. + * Specifies whether Microsoft Word is in Panning mode. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - frame?: Word.Interfaces.FrameData; + isInPanning?: boolean; /** - * Specifies a link between a paragraph and a character style. + * Specifies whether the document is being viewed in reading layout view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - linkStyle?: Word.Interfaces.StyleData; + isInReadingLayout?: boolean; /** - * Gets a ListTemplate object that represents the list formatting for the specified Style object. + * Specifies whether mail merge data is displayed instead of mail merge fields. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listTemplate?: Word.Interfaces.ListTemplateData; + isMailMergeDataView?: boolean; /** - * Gets a ParagraphFormat object that represents the paragraph settings for the specified style. + * Specifies whether the text in the document is visible when the header and footer areas are displayed. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - paragraphFormat?: Word.Interfaces.ParagraphFormatData; + isMainTextLayerVisible?: boolean; /** - * Gets a Shading object that represents the shading for the specified style. Not applicable to List style. + * Specifies whether the pointer is displayed as a magnifying glass in print preview. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shading?: Word.Interfaces.ShadingData; + isPointerShownAsMagnifier?: boolean; /** - * Gets a TableStyle object representing Style properties that can be applied to a table. + * Specifies whether pages displayed in reading layout view are displayed using the same layout as printed pages. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tableStyle?: Word.Interfaces.TableStyleData; + isReadingLayoutActualView?: boolean; /** - * Specifies whether the style is automatically redefined based on the selection. + * Specifies whether XML tags are visible in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - automaticallyUpdate?: boolean; + isXmlMarkupVisible?: boolean; /** - * Specifies the name of an existing style to use as the base formatting of another style. + * Specifies the display mode for tracked changes. * * @remarks - * [Api set: WordApi 1.5] - * - * Note: The ability to set `baseStyle` was introduced in WordApi 1.6. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - baseStyle?: string; + markupMode?: Word.RevisionsMode | "Balloon" | "Inline" | "Mixed"; /** - * Gets whether the specified style is a built-in style. + * Specifies the page color in Reading mode. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - builtIn?: boolean; + pageColor?: Word.PageColor | "None" | "Sepia" | "Inverse"; /** - * Gets the description of the specified style. + * Specifies the page movement type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - description?: string; + pageMovementType?: Word.PageMovementType | "Vertical" | "SideToSide"; /** - * Specifies whether the spelling and grammar checker ignores text formatted with this style. + * Specifies whether margins are visible or hidden when the document is viewed in Full Screen Reading view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hasProofing?: boolean; + readingLayoutTruncateMargins?: Word.ReadingLayoutMargin | "Automatic" | "Suppress" | "Full"; /** - * Gets whether the specified style is a built-in style that has been modified or applied in the document or a new style that has been created in the document. + * Gets whether Word displays revision balloons in the left or right margin in the document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - inUse?: boolean; + revisionsBalloonSide?: Word.RevisionsBalloonMargin | "Left" | "Right"; /** - * Specifies a `LanguageId` value that represents the language for the style. + * Specifies the width of the revision balloons. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + revisionsBalloonWidth?: number; /** - * Specifies an East Asian language for the style. + * Specifies how Microsoft Word measures the width of revision balloons. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + revisionsBalloonWidthType?: Word.RevisionsBalloonWidthType | "Percent" | "Points"; /** - * Gets whether a style is a linked style that can be used for both paragraph and character formatting. + * Specifies the document element displayed in print layout view. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - linked?: boolean; + seekView?: Word.SeekView | "MainDocument" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "CurrentPageHeader" | "CurrentPageFooter"; /** - * Returns the list level for the style. + * Specifies the active window pane. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listLevelNumber?: number; + splitSpecial?: Word.SpecialPane | "None" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "FootnoteContinuationNotice" | "FootnoteContinuationSeparator" | "FootnoteSeparator" | "EndnoteContinuationNotice" | "EndnoteContinuationSeparator" | "EndnoteSeparator" | "Comments" | "CurrentPageHeader" | "CurrentPageFooter" | "Revisions" | "RevisionsHoriz" | "RevisionsVert"; /** - * Specifies whether the style cannot be changed or edited. + * Specifies the view type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - locked?: boolean; + type?: Word.ViewType | "Normal" | "Outline" | "Print" | "PrintPreview" | "Master" | "Web" | "Reading" | "Conflict"; + } + /** An interface describing the data returned by calling `shape.toJSON()`. */ + export interface ShapeData { /** - * Gets the name of a style in the language of the user. + * Represents the body object of the shape. Only applies to text boxes and geometric shapes. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - nameLocal?: string; + body?: Word.Interfaces.BodyData; /** - * Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style. + * Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "Canvas". 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: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] + */ + canvas?: Word.Interfaces.CanvasData; + /** + * Returns the fill formatting of the shape. * - * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - nextParagraphStyle?: string; + fill?: Word.Interfaces.ShapeFillData; /** - * Specifies whether to remove spacing between paragraphs that are formatted using the same style. + * Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - noSpaceBetweenParagraphsOfSameStyle?: boolean; + parentCanvas?: Word.Interfaces.ShapeData; /** - * Specifies the priority. + * Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - priority?: number; + parentGroup?: Word.Interfaces.ShapeData; /** - * Specifies whether the style corresponds to an available quick style. + * Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "GroupShape". 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: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - quickStyle?: boolean; + shapeGroup?: Word.Interfaces.ShapeGroupData; /** - * Gets the style type. + * Gets the text frame object of the shape. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - type?: Word.StyleType | "Character" | "List" | "Paragraph" | "Table"; + textFrame?: Word.Interfaces.TextFrameData; /** - * Specifies whether the specified style is made visible as a recommended style in the Styles and in the Styles task pane in Microsoft Word after it's used in the document. + * Returns the text wrap formatting of the shape. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - unhideWhenUsed?: boolean; + textWrap?: Word.Interfaces.ShapeTextWrapData; /** - * Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane. + * Specifies whether a given shape can overlap other shapes. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - visibility?: boolean; - } - /** An interface describing the data returned by calling `shading.toJSON()`. */ - export interface ShadingData { + allowOverlap?: boolean; /** - * Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies a string that represents the alternative text associated with the shape. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.2] */ - backgroundPatternColor?: string; + altTextDescription?: string; /** - * Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name. + * The geometric shape type of the shape. It will be null if isn't a geometric shape. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.2] */ - foregroundPatternColor?: string; + geometricShapeType?: Word.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"; /** - * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. + * The height, in points, of the shape. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.2] */ - texture?: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; - } - /** An interface describing the data returned by calling `shadingUniversal.toJSON()`. */ - export interface ShadingUniversalData { + height?: number; /** - * Specifies the color that's applied to the background of the `ShadingUniversal` object. You can provide the value in the '#RRGGBB' format. + * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - backgroundPatternColor?: string; + heightRelative?: number; /** - * Specifies the color that's applied to the background of the `ShadingUniversal` object. + * Gets an integer that represents the shape identifier. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - backgroundPatternColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + id?: number; /** - * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. You can provide the value in the '#RRGGBB' format. + * Check whether this shape is a child of a group shape or a canvas shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - foregroundPatternColor?: string; + isChild?: boolean; /** - * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. + * The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - foregroundPatternColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + left?: number; /** - * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. + * The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - texture?: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; - } - /** An interface describing the data returned by calling `table.toJSON()`. */ - export interface TableData { + leftRelative?: number; /** - * Gets the collection of field objects in the table. + * Specifies if the aspect ratio of this shape is locked. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.2] */ - fields?: Word.Interfaces.FieldData[]; + lockAspectRatio?: boolean; /** - * Gets the font. Use this to get and set font name, size, color, and other properties. + * The name of the shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - font?: Word.Interfaces.FontData; + name?: string; /** - * Gets all of the table rows. + * The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - rows?: Word.Interfaces.TableRowData[]; + relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; /** - * Gets the child tables nested one level deeper. + * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - tables?: Word.Interfaces.TableData[]; + relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. + * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies the number of header rows. + * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - headerRowCount?: number; + relativeVerticalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + rotation?: number; /** - * Indicates whether all of the table rows are uniform. + * The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - isUniform?: boolean; + top?: number; /** - * Gets the nesting level of the table. Top-level tables have level 1. + * The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - nestingLevel?: number; + topRelative?: number; /** - * Gets the number of rows in the table. + * Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - rowCount?: number; + type?: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture" | "Canvas"; /** - * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * Specifies if the shape is visible. Not applicable to inline shapes. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - shadingColor?: string; + visible?: boolean; /** - * Specifies the style name for the table. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * The width, in points, of the shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - style?: string; + width?: number; /** - * Specifies whether the table has banded columns. + * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - styleBandedColumns?: boolean; + widthRelative?: number; + } + /** An interface describing the data returned by calling `shapeGroup.toJSON()`. */ + export interface ShapeGroupData { /** - * Specifies whether the table has banded rows. + * Gets the Shape object associated with the group. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - styleBandedRows?: boolean; + shape?: Word.Interfaces.ShapeData; /** - * Specifies the built-in style name for the table. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Gets the collection of Shape objects. Currently, only text boxes, geometric shapes, and pictures are supported. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + shapes?: Word.Interfaces.ShapeData[]; /** - * Specifies whether the table has a first column with a special style. + * Gets an integer that represents the shape group identifier. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - styleFirstColumn?: boolean; + id?: number; + } + /** An interface describing the data returned by calling `canvas.toJSON()`. */ + export interface CanvasData { /** - * Specifies whether the table has a last column with a special style. + * Gets the Shape object associated with the canvas. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - styleLastColumn?: boolean; + shape?: Word.Interfaces.ShapeData; /** - * Specifies whether the table has a total (last) row with a special style. + * Gets the collection of Shape objects. Currently, only text boxes, pictures, and geometric shapes are supported. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - styleTotalRow?: boolean; + shapes?: Word.Interfaces.ShapeData[]; /** - * Specifies the text values in the table, as a 2D JavaScript array. + * Gets an integer that represents the canvas identifier. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - values?: string[][]; + id?: number; + } + /** An interface describing the data returned by calling `shapeCollection.toJSON()`. */ + export interface ShapeCollectionData { + items?: Word.Interfaces.ShapeData[]; + } + /** An interface describing the data returned by calling `shapeFill.toJSON()`. */ + export interface ShapeFillData { /** - * Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. + * Specifies the shape fill background color. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + backgroundColor?: string; /** - * Specifies the width of the table in points. + * Specifies the shape fill foreground color. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - width?: number; + foregroundColor?: string; + /** + * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + transparency?: number; + /** + * Returns the fill type of the shape. See `Word.ShapeFillType` for details. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + type?: Word.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "Picture" | "Texture" | "Mixed"; } - /** An interface describing the data returned by calling `tableStyle.toJSON()`. */ - export interface TableStyleData { + /** An interface describing the data returned by calling `textFrame.toJSON()`. */ + export interface TextFrameData { /** - * Specifies the table's alignment against the page margin. + * 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: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.2] */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + autoSizeSetting?: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed"; /** - * Specifies whether lines in tables formatted with a specified style break across pages. + * Represents the bottom margin, in points, of the text frame. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.2] */ - allowBreakAcrossPage?: boolean; + bottomMargin?: number; /** - * Specifies the amount of space to add between the contents and the bottom borders of the cells. + * Specifies if the text frame contains text. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.2] */ - bottomCellMargin?: number; + hasText?: boolean; /** - * Specifies the spacing (in points) between the cells in a table style. + * Represents the left margin, in points, of the text frame. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.2] */ - cellSpacing?: number; + leftMargin?: number; /** - * Specifies the amount of space to add between the contents and the left borders of the cells. + * Returns True if text in the text frame shouldn't rotate when the shape is rotated. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.2] */ - leftCellMargin?: number; + noTextRotation?: boolean; /** - * Specifies the amount of space to add between the contents and the right borders of the cells. + * Represents the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.2] */ - rightCellMargin?: number; + orientation?: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed"; /** - * Specifies the amount of space to add between the contents and the top borders of the cells. + * Represents the right margin, in points, of the text frame. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.2] */ - topCellMargin?: number; + rightMargin?: number; + /** + * Represents the top margin, in points, of the text frame. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + topMargin?: number; + /** + * Represents the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + verticalAlignment?: Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom"; + /** + * Determines whether lines break automatically to fit text inside the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + wordWrap?: boolean; } - /** An interface describing the data returned by calling `tabStop.toJSON()`. */ - export interface TabStopData { + /** An interface describing the data returned by calling `shapeTextWrap.toJSON()`. */ + export interface ShapeTextWrapData { /** - * Gets a `TabAlignment` value that represents the alignment for the tab stop. + * Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - alignment?: Word.TabAlignment | "Left" | "Center" | "Right" | "Decimal" | "Bar" | "List"; + bottomDistance?: number; /** - * Gets whether this tab stop is a custom tab stop. + * Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - customTab?: boolean; + leftDistance?: number; /** - * Gets a `TabLeader` value that represents the leader for this `TabStop` object. + * Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - leader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + rightDistance?: number; /** - * Gets the position of the tab stop relative to the left margin. + * Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farthest from the page margin. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - position?: number; - } - /** An interface describing the data returned by calling `tabStopCollection.toJSON()`. */ - export interface TabStopCollectionData { - items?: Word.Interfaces.TabStopData[]; - } - /** An interface describing the data returned by calling `tableCollection.toJSON()`. */ - export interface TableCollectionData { - items?: Word.Interfaces.TableData[]; - } - /** An interface describing the data returned by calling `tableColumn.toJSON()`. */ - export interface TableColumnData { + side?: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest"; /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the table column. + * Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - borders?: Word.Interfaces.BorderUniversalData[]; + topDistance?: number; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the column. + * Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - shading?: Word.Interfaces.ShadingUniversalData; + type?: Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front"; + } + /** An interface describing the data returned by calling `reviewer.toJSON()`. */ + export interface ReviewerData { /** - * Returns the position of this column in a collection. + * Specifies if the `Reviewer` object is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - columnIndex?: number; + isVisible?: boolean; + } + /** An interface describing the data returned by calling `reviewerCollection.toJSON()`. */ + export interface ReviewerCollectionData { + items?: Word.Interfaces.ReviewerData[]; + } + /** An interface describing the data returned by calling `revisionsFilter.toJSON()`. */ + export interface RevisionsFilterData { /** - * Returns `true` if the column or row is the first one in the table; `false` otherwise. + * Specifies a `RevisionsMarkup` value that represents the extent of reviewer markup displayed in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isFirst?: boolean; + markup?: Word.RevisionsMarkup | "None" | "Simple" | "All"; /** - * Returns `true` if the column or row is the last one in the table; `false` otherwise. + * Specifies a `RevisionsView` value that represents globally whether Word displays the original version of the document or the final version, which might have revisions and formatting changes applied. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isLast?: boolean; + view?: Word.RevisionsView | "Final" | "Original"; + } + /** An interface describing the data returned by calling `repeatingSectionItem.toJSON()`. */ + export interface RepeatingSectionItemData { /** - * Returns the nesting level of the column. + * Returns the range of this repeating section item, excluding the start and end tags. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nestingLevel?: number; + range?: Word.Interfaces.RangeData; + } + /** An interface describing the data returned by calling `revision.toJSON()`. */ + export interface RevisionData { /** - * Specifies the preferred width (in points or as a percentage of the window width) for the column. - The unit of measurement can be specified by the `preferredWidthType` property. + * Gets a `Range` object that represents the range of text that was moved from one place to another in the document with tracked changes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - preferredWidth?: number; + movedRange?: Word.Interfaces.RangeData; /** - * Specifies the preferred unit of measurement to use for the width of the table column. + * Gets a `Range` object that represents the portion of the document that's contained within a revision mark. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - preferredWidthType?: Word.PreferredWidthType | "Auto" | "Percent" | "Points"; + range?: Word.Interfaces.RangeData; /** - * Specifies the width of the column, in points. + * Gets the name of the user who made the tracked change. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - width?: number; - } - /** An interface describing the data returned by calling `tableColumnCollection.toJSON()`. */ - export interface TableColumnCollectionData { - items?: Word.Interfaces.TableColumnData[]; - } - /** An interface describing the data returned by calling `tableRow.toJSON()`. */ - export interface TableRowData { - /** - * Gets cells. - * - * @remarks - * [Api set: WordApi 1.3] - */ - cells?: Word.Interfaces.TableCellData[]; - /** - * Gets the collection of field objects in the table row. - * - * @remarks - * [Api set: WordApi 1.4] - */ - fields?: Word.Interfaces.FieldData[]; - /** - * Gets the font. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.3] - */ - font?: Word.Interfaces.FontData; + author?: string; /** - * Gets the number of cells in the row. + * Gets the date and time when the tracked change was made. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - cellCount?: number; + date?: Date; /** - * Specifies the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Gets the description of tracked formatting changes in the revision. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + formatDescription?: string; /** - * Checks whether the row is a header row. To set the number of header rows, use `headerRowCount` on the Table object. + * Gets a number that represents the position of this item in a collection. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isHeader?: boolean; + index?: number; /** - * Specifies the preferred height of the row in points. + * Gets the revision type. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - preferredHeight?: number; + type?: Word.RevisionType | "None" | "Insert" | "Delete" | "Property" | "ParagraphNumber" | "DisplayField" | "Reconcile" | "Conflict" | "Style" | "Replace" | "ParagraphProperty" | "TableProperty" | "SectionProperty" | "StyleDefinition" | "MovedFrom" | "MovedTo" | "CellInsertion" | "CellDeletion" | "CellMerge" | "CellSplit" | "ConflictInsert" | "ConflictDelete"; + } + /** An interface describing the data returned by calling `revisionCollection.toJSON()`. */ + export interface RevisionCollectionData { + items?: Word.Interfaces.RevisionData[]; + } + /** An interface describing the data returned by calling `datePickerContentControl.toJSON()`. */ + export interface DatePickerContentControlData { /** - * Gets the index of the row in its parent table. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rowIndex?: number; + placeholderText?: Word.Interfaces.BuildingBlockData; /** - * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * Gets a `Range` object that represents the contents of the content control in the active document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shadingColor?: string; + range?: Word.Interfaces.RangeData; /** - * Specifies the text values in the row, as a 2D JavaScript array. + * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - values?: string[][]; + xmlMapping?: Word.Interfaces.XmlMappingData; /** - * Specifies the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'. + * Specifies the appearance of the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; - } - /** An interface describing the data returned by calling `tableRowCollection.toJSON()`. */ - export interface TableRowCollectionData { - items?: Word.Interfaces.TableRowData[]; - } - /** An interface describing the data returned by calling `tableCell.toJSON()`. */ - export interface TableCellData { + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Gets the body object of the cell. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - body?: Word.Interfaces.BodyData; + color?: string; /** - * Gets the index of the cell in its row. + * Specifies a `CalendarType` value that represents the calendar type for the date picker content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - cellIndex?: number; + dateCalendarType?: Word.CalendarType | "Western" | "Arabic" | "Hebrew" | "Taiwan" | "Japan" | "Thai" | "Korean" | "SakaEra" | "TranslitEnglish" | "TranslitFrench" | "Umalqura"; /** - * Specifies the width of the cell's column in points. This is applicable to uniform tables. + * Specifies the format in which dates are displayed. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - columnWidth?: number; + dateDisplayFormat?: string; /** - * Specifies the horizontal alignment of the cell. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Specifies a `LanguageId` that represents the language format for the date displayed in the date picker content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + dateDisplayLocale?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Gets the index of the cell's row in the table. + * Specifies a `ContentControlDateStorageFormat` value that represents the format for storage and retrieval of dates when the date picker content control is bound to the XML data store of the active document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rowIndex?: number; + dateStorageFormat?: Word.ContentControlDateStorageFormat | "Text" | "Date" | "DateTime"; /** - * Specifies the shading color of the cell. Color is specified in "#RRGGBB" format or by using the color name. + * Gets the identification for the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shadingColor?: string; + id?: string; /** - * Specifies the text of the cell. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - value?: string; + isTemporary?: boolean; /** - * Specifies the vertical alignment of the cell. The value can be 'Top', 'Center', or 'Bottom'. + * Specifies the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * Gets the width of the cell in points. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: number; - } - /** An interface describing the data returned by calling `tableCellCollection.toJSON()`. */ - export interface TableCellCollectionData { - items?: Word.Interfaces.TableCellData[]; - } - /** An interface describing the data returned by calling `tableBorder.toJSON()`. */ - export interface TableBorderData { + lockContentControl?: boolean; /** - * Specifies the table border color. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - color?: string; + lockContents?: boolean; /** - * Specifies the type of the table border. + * Gets whether the placeholder text for the content control is being displayed. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + showingPlaceholderText?: boolean; /** - * Specifies the width, in points, of the table border. Not applicable to table border types that have fixed widths. + * Specifies a tag to identify the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: number; - } - /** An interface describing the data returned by calling `template.toJSON()`. */ - export interface TemplateData { + tag?: string; /** - * Specifies the East Asian language to use when breaking lines of text in the document or template. + * Specifies the title for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - farEastLineBreakLanguage?: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; + title?: string; + } + /** An interface describing the data returned by calling `pictureContentControl.toJSON()`. */ + export interface PictureContentControlData { /** - * Specifies the line break control level for the document. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - farEastLineBreakLevel?: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"; + placeholderText?: Word.Interfaces.BuildingBlockData; /** - * Returns the name of the template, including the drive or Web path. + * Returns a `Range` object that represents the contents of the content control in the active document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fullName?: string; + range?: Word.Interfaces.RangeData; /** - * Specifies whether the spelling and grammar checker ignores documents based on this template. + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hasNoProofing?: boolean; + xmlMapping?: Word.Interfaces.XmlMappingData; /** - * Specifies the character spacing adjustment for the template. + * Specifies the appearance of the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - justificationMode?: Word.JustificationMode | "Expand" | "Compress" | "CompressKana"; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Specifies if Microsoft Word kerns half-width Latin characters and punctuation marks in the document. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - kerningByAlgorithm?: boolean; + color?: string; /** - * Specifies a `LanguageId` value that represents the language in the template. + * Returns the identification for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + id?: string; /** - * Specifies an East Asian language for the language in the template. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + isTemporary?: boolean; /** - * Returns only the name of the document template (excluding any path or other location information). + * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: string; + level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * Specifies the kinsoku characters after which Microsoft Word will not break a line. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - noLineBreakAfter?: string; + lockContentControl?: boolean; /** - * Specifies the kinsoku characters before which Microsoft Word will not break a line. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - noLineBreakBefore?: string; + lockContents?: boolean; /** - * Returns the path to the document template. + * Returns whether the placeholder text for the content control is being displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - path?: string; + showingPlaceholderText?: boolean; /** - * Specifies `true` if the template has not changed since it was last saved, `false` if Microsoft Word displays a prompt to save changes when the document is closed. + * Specifies a tag to identify the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - saved?: boolean; + tag?: string; /** - * Returns the template type. + * Specifies the title for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.TemplateType | "Normal" | "Global" | "Attached"; - } - /** An interface describing the data returned by calling `templateCollection.toJSON()`. */ - export interface TemplateCollectionData { - items?: Word.Interfaces.TemplateData[]; + title?: string; } - /** An interface describing the data returned by calling `trackedChange.toJSON()`. */ - export interface TrackedChangeData { + /** An interface describing the data returned by calling `groupContentControl.toJSON()`. */ + export interface GroupContentControlData { /** - * Gets the author of the tracked change. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - author?: string; + placeholderText?: Word.Interfaces.BuildingBlockData; /** - * Gets the date of the tracked change. + * Gets a `Range` object that represents the contents of the content control in the active document. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - date?: Date; + range?: Word.Interfaces.RangeData; /** - * Gets the text of the tracked change. + * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - text?: string; + xmlMapping?: Word.Interfaces.XmlMappingData; /** - * Gets the type of the tracked change. + * Specifies the appearance of the content control. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: Word.TrackedChangeType | "None" | "Added" | "Deleted" | "Formatted"; - } - /** An interface describing the data returned by calling `trackedChangeCollection.toJSON()`. */ - export interface TrackedChangeCollectionData { - items?: Word.Interfaces.TrackedChangeData[]; - } - /** An interface describing the data returned by calling `view.toJSON()`. */ - export interface ViewData { + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Specifies whether all nonprinting characters are displayed. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areAllNonprintingCharactersDisplayed?: boolean; + color?: string; /** - * Gets whether background colors and images are shown when the document is displayed in print layout view. + * Returns the identification for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areBackgroundsDisplayed?: boolean; + id?: string; /** - * Gets whether square brackets are displayed at the beginning and end of each bookmark. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areBookmarksIndicated?: boolean; + isTemporary?: boolean; /** - * Specifies whether Microsoft Word displays the comments in the document. + * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areCommentsDisplayed?: boolean; + level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * Specifies whether Microsoft Word displays connecting lines from the text to the revision and comment balloons. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areConnectingLinesToRevisionsBalloonDisplayed?: boolean; + lockContentControl?: boolean; /** - * Gets whether crop marks are shown in the corners of pages to indicate where margins are located. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areCropMarksDisplayed?: boolean; + lockContents?: boolean; /** - * Gets whether objects created with the drawing tools are displayed in print layout view. + * Returns whether the placeholder text for the content control is being displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areDrawingsDisplayed?: boolean; + showingPlaceholderText?: boolean; /** - * Specifies whether shading is applied to the ranges in the document that users have permission to modify. + * Specifies a tag to identify the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areEditableRangesShaded?: boolean; + tag?: string; /** - * Specifies whether field codes are displayed. + * Specifies the title for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areFieldCodesDisplayed?: boolean; + title?: string; + } + /** An interface describing the data returned by calling `buildingBlockGalleryContentControl.toJSON()`. */ + export interface BuildingBlockGalleryContentControlData { /** - * Specifies whether Microsoft Word displays formatting changes made to the document with Track Changes enabled. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areFormatChangesDisplayed?: boolean; + placeholderText?: Word.Interfaces.BuildingBlockData; /** - * Specifies whether handwritten ink annotations are shown or hidden. + * Returns a `Range` object that represents the contents of the content control in the active document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areInkAnnotationsDisplayed?: boolean; + range?: Word.Interfaces.RangeData; /** - * Specifies whether Microsoft Word displays insertions and deletions made to the document with Track Changes enabled. + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areInsertionsAndDeletionsDisplayed?: boolean; + xmlMapping?: Word.Interfaces.XmlMappingData; /** - * Gets whether lines wrap at the right edge of the document window rather than at the right margin or the right column boundary. + * Specifies the appearance of the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areLinesWrappedToWindow?: boolean; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Gets whether object anchors are displayed next to items that can be positioned in print layout view. + * Specifies the category for the building block content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areObjectAnchorsDisplayed?: boolean; + buildingBlockCategory?: string; /** - * Gets whether Microsoft Word displays optional line breaks. + * Specifies a `BuildingBlockType` value that represents the type of building block for the building block content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areOptionalBreaksDisplayed?: boolean; + buildingBlockType?: Word.BuildingBlockType | "QuickParts" | "CoverPage" | "Equations" | "Footers" | "Headers" | "PageNumber" | "Tables" | "Watermarks" | "AutoText" | "TextBox" | "PageNumberTop" | "PageNumberBottom" | "PageNumberPage" | "TableOfContents" | "CustomQuickParts" | "CustomCoverPage" | "CustomEquations" | "CustomFooters" | "CustomHeaders" | "CustomPageNumber" | "CustomTables" | "CustomWatermarks" | "CustomAutoText" | "CustomTextBox" | "CustomPageNumberTop" | "CustomPageNumberBottom" | "CustomPageNumberPage" | "CustomTableOfContents" | "Custom1" | "Custom2" | "Custom3" | "Custom4" | "Custom5" | "Bibliography" | "CustomBibliography"; /** - * Gets whether optional hyphens are displayed. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areOptionalHyphensDisplayed?: boolean; + color?: string; /** - * Gets whether other authors' presence should be visible in the document. + * Gets the identification for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areOtherAuthorsVisible?: boolean; + id?: string; /** - * Gets whether the top and bottom margins and the gray area between pages in the document are displayed. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arePageBoundariesDisplayed?: boolean; + isTemporary?: boolean; /** - * Gets whether paragraph marks are displayed. + * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areParagraphsMarksDisplayed?: boolean; + level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * Gets whether blank boxes are displayed as placeholders for pictures. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arePicturePlaceholdersDisplayed?: boolean; + lockContentControl?: boolean; /** - * Specifies whether Microsoft Word displays revisions and comments made to the document with Track Changes enabled. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areRevisionsAndCommentsDisplayed?: boolean; + lockContents?: boolean; /** - * Gets whether space characters are displayed. + * Gets if the placeholder text for the content control is being displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areSpacesIndicated?: boolean; + showingPlaceholderText?: boolean; /** - * Specifies whether table gridlines are displayed. + * Specifies a tag to identify the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areTableGridlinesDisplayed?: boolean; + tag?: string; /** - * Gets whether tab characters are displayed. + * Specifies the title for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areTabsDisplayed?: boolean; + title?: string; + } + /** An interface describing the data returned by calling `repeatingSectionContentControl.toJSON()`. */ + export interface RepeatingSectionContentControlData { /** - * Gets whether dotted lines are displayed around page margins, text columns, objects, and frames in print layout view. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areTextBoundariesDisplayed?: boolean; + placeholderText?: Word.Interfaces.BuildingBlockData; /** - * Specifies the column width in Reading mode. + * Gets a `Range` object that represents the contents of the content control in the active document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - columnWidth?: Word.ColumnWidth | "Narrow" | "Default" | "Wide"; + range?: Word.Interfaces.RangeData; /** - * Gets on-screen shading for fields. + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fieldShading?: Word.FieldShading | "Never" | "Always" | "WhenSelected"; + xmlapping?: Word.Interfaces.XmlMappingData; /** - * Specifies whether all the text in a window is displayed in the same sans-serif font with minimal formatting to speed up display. + * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isDraft?: boolean; + allowInsertDeleteSection?: boolean; /** - * Specifies whether only the first line of body text is shown in outline view. + * Specifies the appearance of the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isFirstLineOnlyDisplayed?: boolean; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Specifies whether character formatting is visible in outline view. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isFormatDisplayed?: boolean; + color?: string; /** - * Specifies whether the window is in full-screen view. + * Returns the identification for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isFullScreen?: boolean; + id?: string; /** - * Gets whether text formatted as hidden text is displayed. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isHiddenTextDisplayed?: boolean; + isTemporary?: boolean; /** - * Gets whether highlight formatting is displayed and printed with the document. + * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isHighlightingDisplayed?: boolean; + level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * Specifies whether the document is in conflict mode view. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isInConflictMode?: boolean; + lockContentControl?: boolean; /** - * Specifies whether Microsoft Word is in Panning mode. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isInPanning?: boolean; + lockContents?: boolean; /** - * Specifies whether the document is being viewed in reading layout view. + * Specifies the name of the repeating section items used in the context menu associated with this repeating section content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isInReadingLayout?: boolean; + repeatingSectionItemTitle?: string; /** - * Specifies whether mail merge data is displayed instead of mail merge fields. + * Returns whether the placeholder text for the content control is being displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isMailMergeDataView?: boolean; + showingPlaceholderText?: boolean; /** - * Specifies whether the text in the document is visible when the header and footer areas are displayed. + * Specifies a tag to identify the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isMainTextLayerVisible?: boolean; + tag?: string; /** - * Specifies whether the pointer is displayed as a magnifying glass in print preview. + * Specifies the title for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isPointerShownAsMagnifier?: boolean; + title?: string; + } + /** An interface describing the data returned by calling `frame.toJSON()`. */ + export interface FrameData { /** - * Specifies whether pages displayed in reading layout view are displayed using the same layout as printed pages. + * Returns a `BorderUniversalCollection` object that represents all the borders for the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isReadingLayoutActualView?: boolean; + borders?: Word.Interfaces.BorderUniversalData[]; /** - * Specifies whether XML tags are visible in the document. + * Returns a `Range` object that represents the portion of the document that's contained within the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isXmlMarkupVisible?: boolean; + range?: Word.Interfaces.RangeData; /** - * Specifies the display mode for tracked changes. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - markupMode?: Word.RevisionsMode | "Balloon" | "Inline" | "Mixed"; + shading?: Word.Interfaces.ShadingUniversalData; /** - * Specifies the page color in Reading mode. + * Specifies the height (in points) of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageColor?: Word.PageColor | "None" | "Sepia" | "Inverse"; + height?: number; /** - * Specifies the page movement type. + * Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageMovementType?: Word.PageMovementType | "Vertical" | "SideToSide"; + heightRule?: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; /** - * Specifies whether margins are visible or hidden when the document is viewed in Full Screen Reading view. + * Specifies the horizontal distance between the frame and the surrounding text, in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readingLayoutTruncateMargins?: Word.ReadingLayoutMargin | "Automatic" | "Suppress" | "Full"; + horizontalDistanceFromText?: number; /** - * Gets whether Word displays revision balloons in the left or right margin in the document. + * Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - revisionsBalloonSide?: Word.RevisionsBalloonMargin | "Left" | "Right"; + horizontalPosition?: number; /** - * Specifies the width of the revision balloons. + * Specifies if the frame is locked. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - revisionsBalloonWidth?: number; + lockAnchor?: boolean; /** - * Specifies how Microsoft Word measures the width of revision balloons. + * Specifies the relative horizontal position of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - revisionsBalloonWidthType?: Word.RevisionsBalloonWidthType | "Percent" | "Points"; + relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies the document element displayed in print layout view. + * Specifies the relative vertical position of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - seekView?: Word.SeekView | "MainDocument" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "CurrentPageHeader" | "CurrentPageFooter"; + relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies the active window pane. + * Specifies if document text wraps around the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - splitSpecial?: Word.SpecialPane | "None" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "FootnoteContinuationNotice" | "FootnoteContinuationSeparator" | "FootnoteSeparator" | "EndnoteContinuationNotice" | "EndnoteContinuationSeparator" | "EndnoteSeparator" | "Comments" | "CurrentPageHeader" | "CurrentPageFooter" | "Revisions" | "RevisionsHoriz" | "RevisionsVert"; + textWrap?: boolean; /** - * Specifies the view type. + * Specifies the vertical distance (in points) between the frame and the surrounding text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.ViewType | "Normal" | "Outline" | "Print" | "PrintPreview" | "Master" | "Web" | "Reading" | "Conflict"; - } - /** An interface describing the data returned by calling `shape.toJSON()`. */ - export interface ShapeData { + verticalDistanceFromText?: number; /** - * Represents the body object of the shape. Only applies to text boxes and geometric shapes. + * Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - body?: Word.Interfaces.BodyData; + verticalPosition?: number; /** - * Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "Canvas". 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 width (in points) of the frame. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - canvas?: Word.Interfaces.CanvasData; + width?: number; /** - * Returns the fill formatting of the shape. + * Specifies the rule used to determine the width of the frame. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - fill?: Word.Interfaces.ShapeFillData; + widthRule?: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; + } + /** An interface describing the data returned by calling `frameCollection.toJSON()`. */ + export interface FrameCollectionData { + items?: Word.Interfaces.FrameData[]; + } + /** An interface describing the data returned by calling `documentLibraryVersion.toJSON()`. */ + export interface DocumentLibraryVersionData { /** - * Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas. + * Gets any optional comments associated with this version of the shared document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentCanvas?: Word.Interfaces.ShapeData; + comments?: string; /** - * Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group. + * Gets the date and time at which this version of the shared document was last saved to the server. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentGroup?: Word.Interfaces.ShapeData; + modified?: any; /** - * Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "GroupShape". 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}. + * Gets the name of the user who last saved this version of the shared document to the server. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shapeGroup?: Word.Interfaces.ShapeGroupData; + modifiedBy?: string; + } + /** An interface describing the data returned by calling `documentLibraryVersionCollection.toJSON()`. */ + export interface DocumentLibraryVersionCollectionData { + items?: Word.Interfaces.DocumentLibraryVersionData[]; + } + /** An interface describing the data returned by calling `dropCap.toJSON()`. */ + export interface DropCapData { /** - * Gets the text frame object of the shape. + * Gets the distance (in points) between the dropped capital letter and the paragraph text. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - textFrame?: Word.Interfaces.TextFrameData; + distanceFromText?: number; /** - * Returns the text wrap formatting of the shape. + * Gets the name of the font for the dropped capital letter. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - textWrap?: Word.Interfaces.ShapeTextWrapData; + fontName?: string; /** - * Specifies whether a given shape can overlap other shapes. + * Gets the height (in lines) of the dropped capital letter. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - allowOverlap?: boolean; + linesToDrop?: number; /** - * Specifies a string that represents the alternative text associated with the shape. + * Gets the position of the dropped capital letter. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - altTextDescription?: string; + position?: Word.DropPosition | "None" | "Normal" | "Margin"; + } + /** An interface describing the data returned by calling `listFormat.toJSON()`. */ + export interface ListFormatData { /** - * The geometric shape type of the shape. It will be null if isn't a geometric shape. + * Returns a `List` object that represents the first formatted list contained in the `ListFormat` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - geometricShapeType?: Word.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"; + list?: Word.Interfaces.ListData; /** - * The height, in points, of the shape. + * Gets the list template associated with the `ListFormat` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - height?: number; + listTemplate?: Word.Interfaces.ListTemplateData; /** - * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * Indicates whether the `ListFormat` object contains a single list. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - heightRelative?: number; + isSingleList?: boolean; /** - * Gets an integer that represents the shape identifier. + * Indicates whether the `ListFormat` object contains a single list template. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: number; + isSingleListTemplate?: boolean; /** - * Check whether this shape is a child of a group shape or a canvas shape. + * Specifies the list level number for the first paragraph for the `ListFormat` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isChild?: boolean; + listLevelNumber?: number; /** - * The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * Gets the string representation of the list value of the first paragraph in the range for the `ListFormat` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - left?: number; + listString?: string; /** - * The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set. + * Gets the type of the list for the `ListFormat` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftRelative?: number; + listType?: Word.ListType | "ListNoNumbering" | "ListListNumOnly" | "ListBullet" | "ListSimpleNumbering" | "ListOutlineNumbering" | "ListMixedNumbering" | "ListPictureBullet"; /** - * Specifies if the aspect ratio of this shape is locked. + * Gets the numeric value of the the first paragraph in the range for the `ListFormat` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lockAspectRatio?: boolean; + listValue?: number; + } + /** An interface describing the data returned by calling `fillFormat.toJSON()`. */ + export interface FillFormatData { /** - * The name of the shape. + * Returns a `ColorFormat` object that represents the background color for the fill. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - name?: string; + backgroundColor?: Word.Interfaces.ColorFormatData; /** - * The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Returns a `ColorFormat` object that represents the foreground color for the fill. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; + foregroundColor?: Word.Interfaces.ColorFormatData; /** - * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + gradientAngle?: number; /** - * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. + * Gets the gradient color type. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + gradientColorType?: Word.GradientColorType | "Mixed" | "OneColor" | "TwoColors" | "PresetColors" | "MultiColor"; /** - * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Returns how dark or light a one-color gradient fill is. + A value of 0 means that black is mixed in with the shape's foreground color to form the gradient. + A value of 1 means that white is mixed in. + Values between 0 and 1 mean that a darker or lighter shade of the foreground color is mixed in. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - relativeVerticalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + gradientDegree?: number; /** - * Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape. + * Returns the gradient style for the fill. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rotation?: number; + gradientStyle?: Word.GradientStyle | "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter"; /** - * The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * Returns the gradient variant for the fill as an integer value from 1 to 4 for most gradient fills. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - top?: number; + gradientVariant?: number; /** - * The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set. + * Specifies if the object, or the formatting applied to it, is visible. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topRelative?: number; + isVisible?: boolean; /** - * Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * Returns a `PatternType` value that represents the pattern applied to the fill or line. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture" | "Canvas"; + pattern?: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"; /** - * Specifies if the shape is visible. Not applicable to inline shapes. + * Returns the preset gradient type for the fill. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - visible?: boolean; + presetGradientType?: Word.PresetGradientType | "Mixed" | "EarlySunset" | "LateSunset" | "Nightfall" | "Daybreak" | "Horizon" | "Desert" | "Ocean" | "CalmWater" | "Fire" | "Fog" | "Moss" | "Peacock" | "Wheat" | "Parchment" | "Mahogany" | "Rainbow" | "RainbowII" | "Gold" | "GoldII" | "Brass" | "Chrome" | "ChromeII" | "Silver" | "Sapphire"; /** - * The width, in points, of the shape. + * Gets the preset texture. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: number; + presetTexture?: Word.PresetTexture | "Mixed" | "Papyrus" | "Canvas" | "Denim" | "WovenMat" | "WaterDroplets" | "PaperBag" | "FishFossil" | "Sand" | "GreenMarble" | "WhiteMarble" | "BrownMarble" | "Granite" | "Newsprint" | "RecycledPaper" | "Parchment" | "Stationery" | "BlueTissuePaper" | "PinkTissuePaper" | "PurpleMesh" | "Bouquet" | "Cork" | "Walnut" | "Oak" | "MediumWood"; /** - * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * Specifies whether the fill rotates with the shape. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - widthRelative?: number; - } - /** An interface describing the data returned by calling `shapeGroup.toJSON()`. */ - export interface ShapeGroupData { + rotateWithObject?: boolean; /** - * Gets the Shape object associated with the group. + * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shape?: Word.Interfaces.ShapeData; + textureAlignment?: Word.TextureAlignment | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "Center" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; /** - * Gets the collection of Shape objects. Currently, only text boxes, geometric shapes, and pictures are supported. + * Specifies the horizontal scaling factor for the texture fill. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shapes?: Word.Interfaces.ShapeData[]; + textureHorizontalScale?: number; /** - * Gets an integer that represents the shape group identifier. + * Returns the name of the custom texture file for the fill. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: number; - } - /** An interface describing the data returned by calling `canvas.toJSON()`. */ - export interface CanvasData { + textureName?: string; /** - * Gets the Shape object associated with the canvas. + * Specifies the horizontal offset of the texture from the origin in points. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shape?: Word.Interfaces.ShapeData; + textureOffsetX?: number; /** - * Gets the collection of Shape objects. Currently, only text boxes, pictures, and geometric shapes are supported. + * Specifies the vertical offset of the texture. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shapes?: Word.Interfaces.ShapeData[]; + textureOffsetY?: number; /** - * Gets an integer that represents the canvas identifier. + * Specifies whether the texture is tiled. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: number; - } - /** An interface describing the data returned by calling `shapeCollection.toJSON()`. */ - export interface ShapeCollectionData { - items?: Word.Interfaces.ShapeData[]; - } - /** An interface describing the data returned by calling `shapeFill.toJSON()`. */ - export interface ShapeFillData { + textureTile?: boolean; /** - * Specifies the shape fill background color. You can provide the value in the '#RRGGBB' format or the color name. + * Returns the texture type for the fill. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - backgroundColor?: string; + textureType?: Word.TextureType | "Mixed" | "Preset" | "UserDefined"; /** - * Specifies the shape fill foreground color. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies the vertical scaling factor for the texture fill as a value between 0.0 and 1.0. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - foregroundColor?: string; + textureVerticalScale?: number; /** - * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type. + * Specifies the degree of transparency of the fill for a shape as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ transparency?: number; /** - * Returns the fill type of the shape. See `Word.ShapeFillType` for details. + * Gets the fill format type. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: Word.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "Picture" | "Texture" | "Mixed"; + type?: Word.FillType | "Mixed" | "Solid" | "Patterned" | "Gradient" | "Textured" | "Background" | "Picture"; } - /** An interface describing the data returned by calling `textFrame.toJSON()`. */ - export interface TextFrameData { + /** An interface describing the data returned by calling `glowFormat.toJSON()`. */ + export interface GlowFormatData { /** - * 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. + * Returns a `ColorFormat` object that represents the color for a glow effect. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - autoSizeSetting?: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed"; + color?: Word.Interfaces.ColorFormatData; /** - * Represents the bottom margin, in points, of the text frame. + * Specifies the length of the radius for a glow effect. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bottomMargin?: number; + radius?: number; /** - * Specifies if the text frame contains text. + * Specifies the degree of transparency for the glow effect as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - hasText?: boolean; + transparency?: number; + } + /** An interface describing the data returned by calling `lineFormat.toJSON()`. */ + export interface LineFormatData { /** - * Represents the left margin, in points, of the text frame. + * Gets a `ColorFormat` object that represents the background color for a patterned line. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftMargin?: number; + backgroundColor?: Word.Interfaces.ColorFormatData; /** - * Returns True if text in the text frame shouldn't rotate when the shape is rotated. + * Gets a `ColorFormat` object that represents the foreground color for the line. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - noTextRotation?: boolean; + foregroundColor?: Word.Interfaces.ColorFormatData; /** - * Represents the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. + * Specifies the length of the arrowhead at the beginning of the line. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - orientation?: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed"; + beginArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; /** - * Represents the right margin, in points, of the text frame. + * Specifies the style of the arrowhead at the beginning of the line. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightMargin?: number; + beginArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; /** - * Represents the top margin, in points, of the text frame. + * Specifies the width of the arrowhead at the beginning of the line. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topMargin?: number; + beginArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; /** - * Represents the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. + * Specifies the dash style for the line. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - verticalAlignment?: Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom"; + dashStyle?: Word.LineDashStyle | "Mixed" | "Solid" | "SquareDot" | "RoundDot" | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "SysDash" | "SysDot" | "SysDashDot"; /** - * Determines whether lines break automatically to fit text inside the shape. + * Specifies the length of the arrowhead at the end of the line. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - wordWrap?: boolean; - } - /** An interface describing the data returned by calling `shapeTextWrap.toJSON()`. */ - export interface ShapeTextWrapData { + endArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; /** - * Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape. + * Specifies the style of the arrowhead at the end of the line. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bottomDistance?: number; + endArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; /** - * Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape. + * Specifies the width of the arrowhead at the end of the line. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftDistance?: number; + endArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; /** - * Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape. + * Specifies if to draw lines inside a shape. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightDistance?: number; + insetPen?: boolean; /** - * Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farthest from the page margin. + * Specifies if the object, or the formatting applied to it, is visible. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - side?: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest"; + isVisible?: boolean; /** - * Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape. + * Specifies the pattern applied to the line. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topDistance?: number; + pattern?: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"; /** - * Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details. + * Specifies the line format style. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front"; - } - /** An interface describing the data returned by calling `reviewer.toJSON()`. */ - export interface ReviewerData { + style?: Word.LineFormatStyle | "Mixed" | "Single" | "ThinThin" | "ThinThick" | "ThickThin" | "ThickBetweenThin"; /** - * Specifies if the `Reviewer` object is visible. + * Specifies the degree of transparency of the line as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; - } - /** An interface describing the data returned by calling `reviewerCollection.toJSON()`. */ - export interface ReviewerCollectionData { - items?: Word.Interfaces.ReviewerData[]; - } - /** An interface describing the data returned by calling `revisionsFilter.toJSON()`. */ - export interface RevisionsFilterData { + transparency?: number; /** - * Specifies a `RevisionsMarkup` value that represents the extent of reviewer markup displayed in the document. + * Specifies the thickness of the line in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - markup?: Word.RevisionsMarkup | "None" | "Simple" | "All"; + weight?: number; + } + /** An interface describing the data returned by calling `reflectionFormat.toJSON()`. */ + export interface ReflectionFormatData { /** - * Specifies a `RevisionsView` value that represents globally whether Word displays the original version of the document or the final version, which might have revisions and formatting changes applied. + * Specifies the degree of blur effect applied to the `ReflectionFormat` object as a value between 0.0 and 100.0. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - view?: Word.RevisionsView | "Final" | "Original"; - } - /** An interface describing the data returned by calling `repeatingSectionItem.toJSON()`. */ - export interface RepeatingSectionItemData { + blur?: number; /** - * Returns the range of this repeating section item, excluding the start and end tags. + * Specifies the amount of separation, in points, of the reflected image from the shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeData; - } - /** An interface describing the data returned by calling `datePickerContentControl.toJSON()`. */ - export interface DatePickerContentControlData { + offset?: number; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Specifies the size of the reflection as a percentage of the reflected shape from 0 to 100. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: Word.Interfaces.BuildingBlockData; + size?: number; /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * Specifies the degree of transparency for the reflection effect as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeData; + transparency?: number; /** - * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Specifies a `ReflectionType` value that represents the type and direction of the lighting for a shape reflection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingData; + type?: Word.ReflectionType | "Mixed" | "None" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9"; + } + /** An interface describing the data returned by calling `colorFormat.toJSON()`. */ + export interface ColorFormatData { /** - * Specifies the appearance of the content control. + * Specifies the brightness of a specified shape color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + brightness?: number; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Specifies the theme color for a color format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + objectThemeColor?: Word.ThemeColorIndex | "NotThemeColor" | "MainDark1" | "MainLight1" | "MainDark2" | "MainLight2" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Hyperlink" | "HyperlinkFollowed" | "Background1" | "Text1" | "Background2" | "Text2"; /** - * Specifies a `CalendarType` value that represents the calendar type for the date picker content control. + * Specifies the red-green-blue (RGB) value of the specified color. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateCalendarType?: Word.CalendarType | "Western" | "Arabic" | "Hebrew" | "Taiwan" | "Japan" | "Thai" | "Korean" | "SakaEra" | "TranslitEnglish" | "TranslitFrench" | "Umalqura"; + rgb?: string; /** - * Specifies the format in which dates are displayed. + * Specifies the lightening or darkening of a specified shape's color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateDisplayFormat?: string; + tintAndShade?: number; /** - * Specifies a `LanguageId` that represents the language format for the date displayed in the date picker content control. + * Returns the shape color type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateDisplayLocale?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + type?: Word.ColorType | "rgb" | "scheme"; + } + /** An interface describing the data returned by calling `shadowFormat.toJSON()`. */ + export interface ShadowFormatData { /** - * Specifies a `ContentControlDateStorageFormat` value that represents the format for storage and retrieval of dates when the date picker content control is bound to the XML data store of the active document. + * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateStorageFormat?: Word.ContentControlDateStorageFormat | "Text" | "Date" | "DateTime"; + foregroundColor?: Word.Interfaces.ColorFormatData; /** - * Gets the identification for the content control. + * Specifies the blur level for a shadow format as a value between 0.0 and 100.0. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: string; + blur?: number; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Specifies whether the object or the formatting applied to it is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + isVisible?: boolean; /** - * Specifies the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Specifies `true` if the shadow of the shape appears filled in and is obscured by the shape, even if the shape has no fill, + `false` if the shadow has no fill and the outline of the shadow is visible through the shape if the shape has no fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + obscured?: boolean; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Specifies the horizontal offset (in points) of the shadow from the shape. + A positive value offsets the shadow to the right of the shape; a negative value offsets it to the left. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + offsetX?: number; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Specifies the vertical offset (in points) of the shadow from the shape. + A positive value offsets the shadow to the top of the shape; a negative value offsets it to the bottom. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + offsetY?: number; /** - * Gets whether the placeholder text for the content control is being displayed. + * Specifies whether to rotate the shadow when rotating the shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showingPlaceholderText?: boolean; + rotateWithShape?: boolean; /** - * Specifies a tag to identify the content control. + * Specifies the width of the shadow. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: string; + size?: number; /** - * Specifies the title for the content control. + * Specifies the type of shadow formatting to apply to a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: string; - } - /** An interface describing the data returned by calling `pictureContentControl.toJSON()`. */ - export interface PictureContentControlData { + style?: Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow"; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: Word.Interfaces.BuildingBlockData; + transparency?: number; /** - * Returns a `Range` object that represents the contents of the content control in the active document. + * Specifies the shape shadow type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeData; + type?: Word.ShadowType | "Mixed" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9" | "Type10" | "Type11" | "Type12" | "Type13" | "Type14" | "Type15" | "Type16" | "Type17" | "Type18" | "Type19" | "Type20" | "Type21" | "Type22" | "Type23" | "Type24" | "Type25" | "Type26" | "Type27" | "Type28" | "Type29" | "Type30" | "Type31" | "Type32" | "Type33" | "Type34" | "Type35" | "Type36" | "Type37" | "Type38" | "Type39" | "Type40" | "Type41" | "Type42" | "Type43"; + } + /** An interface describing the data returned by calling `threeDimensionalFormat.toJSON()`. */ + export interface ThreeDimensionalFormatData { /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Returns a `ColorFormat` object that represents color of the contour of a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingData; + contourColor?: Word.Interfaces.ColorFormatData; /** - * Specifies the appearance of the content control. + * Returns a `ColorFormat` object that represents the color of the shape's extrusion. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + extrusionColor?: Word.Interfaces.ColorFormatData; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Specifies the depth of the bottom bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + bevelBottomDepth?: number; /** - * Returns the identification for the content control. + * Specifies the inset size for the bottom bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: string; + bevelBottomInset?: number; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Specifies a `BevelType` value that represents the bevel type for the bottom bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + bevelBottomType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; /** - * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Specifies the depth of the top bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + bevelTopDepth?: number; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Specifies the inset size for the top bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + bevelTopInset?: number; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Specifies a `BevelType` value that represents the bevel type for the top bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + bevelTopType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; /** - * Returns whether the placeholder text for the content control is being displayed. + * Specifies the width of the contour of a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showingPlaceholderText?: boolean; + contourWidth?: number; /** - * Specifies a tag to identify the content control. + * Specifies the depth of the shape's extrusion. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: string; + depth?: number; /** - * Specifies the title for the content control. + * Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion) + and automatically changes when the shape's fill changes, or whether the extrusion color is independent of the shape's fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: string; - } - /** An interface describing the data returned by calling `groupContentControl.toJSON()`. */ - export interface GroupContentControlData { + extrusionColorType?: Word.ExtrusionColorType | "mixed" | "automatic" | "custom"; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Specifies the amount of perspective for a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: Word.Interfaces.BuildingBlockData; + fieldOfView?: number; /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * Specifies `true` if the extrusion appears in perspective — that is, if the walls of the extrusion narrow toward a vanishing point, + `false` if the extrusion is a parallel, or orthographic, projection — that is, if the walls don't narrow toward a vanishing point. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeData; + isPerspective?: boolean; /** - * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Specifies if the specified object, or the formatting applied to it, is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingData; + isVisible?: boolean; /** - * Specifies the appearance of the content control. + * Specifies the angle of the lighting. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + lightAngle?: number; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Returns a `PresetCamera` value that represents the camera presets. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + presetCamera?: Word.PresetCamera | "Mixed" | "LegacyObliqueTopLeft" | "LegacyObliqueTop" | "LegacyObliqueTopRight" | "LegacyObliqueLeft" | "LegacyObliqueFront" | "LegacyObliqueRight" | "LegacyObliqueBottomLeft" | "LegacyObliqueBottom" | "LegacyObliqueBottomRight" | "LegacyPerspectiveTopLeft" | "LegacyPerspectiveTop" | "LegacyPerspectiveTopRight" | "LegacyPerspectiveLeft" | "LegacyPerspectiveFront" | "LegacyPerspectiveRight" | "LegacyPerspectiveBottomLeft" | "LegacyPerspectiveBottom" | "LegacyPerspectiveBottomRight" | "OrthographicFront" | "IsometricTopUp" | "IsometricTopDown" | "IsometricBottomUp" | "IsometricBottomDown" | "IsometricLeftUp" | "IsometricLeftDown" | "IsometricRightUp" | "IsometricRightDown" | "IsometricOffAxis1Left" | "IsometricOffAxis1Right" | "IsometricOffAxis1Top" | "IsometricOffAxis2Left" | "IsometricOffAxis2Right" | "IsometricOffAxis2Top" | "IsometricOffAxis3Left" | "IsometricOffAxis3Right" | "IsometricOffAxis3Bottom" | "IsometricOffAxis4Left" | "IsometricOffAxis4Right" | "IsometricOffAxis4Bottom" | "ObliqueTopLeft" | "ObliqueTop" | "ObliqueTopRight" | "ObliqueLeft" | "ObliqueRight" | "ObliqueBottomLeft" | "ObliqueBottom" | "ObliqueBottomRight" | "PerspectiveFront" | "PerspectiveLeft" | "PerspectiveRight" | "PerspectiveAbove" | "PerspectiveBelow" | "PerspectiveAboveLeftFacing" | "PerspectiveAboveRightFacing" | "PerspectiveContrastingLeftFacing" | "PerspectiveContrastingRightFacing" | "PerspectiveHeroicLeftFacing" | "PerspectiveHeroicRightFacing" | "PerspectiveHeroicExtremeLeftFacing" | "PerspectiveHeroicExtremeRightFacing" | "PerspectiveRelaxed" | "PerspectiveRelaxedModerately"; /** - * Returns the identification for the content control. + * Returns the direction taken by the extrusion's sweep path leading away from the extruded shape (the front face of the extrusion). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: string; + presetExtrusionDirection?: Word.PresetExtrusionDirection | "Mixed" | "BottomRight" | "Bottom" | "BottomLeft" | "Right" | "None" | "Left" | "TopRight" | "Top" | "TopLeft"; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Specifies a `LightRigType` value that represents the lighting preset. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + presetLighting?: Word.LightRigType | "Mixed" | "LegacyFlat1" | "LegacyFlat2" | "LegacyFlat3" | "LegacyFlat4" | "LegacyNormal1" | "LegacyNormal2" | "LegacyNormal3" | "LegacyNormal4" | "LegacyHarsh1" | "LegacyHarsh2" | "LegacyHarsh3" | "LegacyHarsh4" | "ThreePoint" | "Balanced" | "Soft" | "Harsh" | "Flood" | "Contrasting" | "Morning" | "Sunrise" | "Sunset" | "Chilly" | "Freezing" | "Flat" | "TwoPoint" | "Glow" | "BrightRoom"; /** - * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Specifies the position of the light source relative to the extrusion. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + presetLightingDirection?: Word.PresetLightingDirection | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "None" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Specifies the intensity of the extrusion lighting. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + presetLightingSoftness?: Word.PresetLightingSoftness | "Mixed" | "Dim" | "Normal" | "Bright"; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Specifies the extrusion surface material. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + presetMaterial?: Word.PresetMaterial | "Mixed" | "Matte" | "Plastic" | "Metal" | "WireFrame" | "Matte2" | "Plastic2" | "Metal2" | "WarmMatte" | "TranslucentPowder" | "Powder" | "DarkEdge" | "SoftEdge" | "Clear" | "Flat" | "SoftMetal"; /** - * Returns whether the placeholder text for the content control is being displayed. + * Returns the preset extrusion format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showingPlaceholderText?: boolean; + presetThreeDimensionalFormat?: Word.PresetThreeDimensionalFormat | "Mixed" | "Format1" | "Format2" | "Format3" | "Format4" | "Format5" | "Format6" | "Format7" | "Format8" | "Format9" | "Format10" | "Format11" | "Format12" | "Format13" | "Format14" | "Format15" | "Format16" | "Format17" | "Format18" | "Format19" | "Format20"; /** - * Specifies a tag to identify the content control. + * Specifies whether text on a shape rotates with shape. `true` rotates the text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: string; + projectText?: boolean; /** - * Specifies the title for the content control. + * Specifies the rotation of the extruded shape around the x-axis in degrees. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: string; - } - /** An interface describing the data returned by calling `buildingBlockGalleryContentControl.toJSON()`. */ - export interface BuildingBlockGalleryContentControlData { + rotationX?: number; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Specifies the rotation of the extruded shape around the y-axis in degrees. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: Word.Interfaces.BuildingBlockData; + rotationY?: number; /** - * Returns a `Range` object that represents the contents of the content control in the active document. + * Specifies the z-axis rotation of the camera. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeData; + rotationZ?: number; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Specifies the position on the z-axis for the shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingData; + z?: number; + } + /** An interface describing the data returned by calling `bibliography.toJSON()`. */ + export interface BibliographyData { /** - * Specifies the appearance of the content control. + * Returns a `SourceCollection` object that represents all the sources contained in the bibliography. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + sources?: Word.Interfaces.SourceData[]; /** - * Specifies the category for the building block content control. + * Specifies the name of the active style to use for the bibliography. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - buildingBlockCategory?: string; + bibliographyStyle?: string; + } + /** An interface describing the data returned by calling `sourceCollection.toJSON()`. */ + export interface SourceCollectionData { + items?: Word.Interfaces.SourceData[]; + } + /** An interface describing the data returned by calling `source.toJSON()`. */ + export interface SourceData { /** - * Specifies a `BuildingBlockType` value that represents the type of building block for the building block content control. + * Gets if the `Source` object has been cited in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - buildingBlockType?: Word.BuildingBlockType | "QuickParts" | "CoverPage" | "Equations" | "Footers" | "Headers" | "PageNumber" | "Tables" | "Watermarks" | "AutoText" | "TextBox" | "PageNumberTop" | "PageNumberBottom" | "PageNumberPage" | "TableOfContents" | "CustomQuickParts" | "CustomCoverPage" | "CustomEquations" | "CustomFooters" | "CustomHeaders" | "CustomPageNumber" | "CustomTables" | "CustomWatermarks" | "CustomAutoText" | "CustomTextBox" | "CustomPageNumberTop" | "CustomPageNumberBottom" | "CustomPageNumberPage" | "CustomTableOfContents" | "Custom1" | "Custom2" | "Custom3" | "Custom4" | "Custom5" | "Bibliography" | "CustomBibliography"; + isCited?: boolean; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Gets the tag of the source. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + tag?: string; /** - * Gets the identification for the content control. + * Gets the XML representation of the source. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: string; + xml?: string; + } + /** An interface describing the data returned by calling `pageSetup.toJSON()`. */ + export interface PageSetupData { /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + lineNumbering?: Word.Interfaces.LineNumberingData; /** - * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Gets a `TextColumnCollection` object that represents the set of text columns for the `PageSetup` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + textColumns?: Word.Interfaces.TextColumnData[]; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Specifies whether Microsoft Word prints the document as a booklet. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + bookFoldPrinting?: boolean; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Specifies the number of pages for each booklet. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + bookFoldPrintingSheets?: number; /** - * Gets if the placeholder text for the content control is being displayed. + * Specifies if Microsoft Word reverses the printing order for book fold printing of bidirectional or Asian language documents. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showingPlaceholderText?: boolean; + bookFoldReversePrinting?: boolean; /** - * Specifies a tag to identify the content control. + * Specifies the distance (in points) between the bottom edge of the page and the bottom boundary of the body text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: string; + bottomMargin?: number; /** - * Specifies the title for the content control. + * Specifies the number of characters per line in the document grid. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: string; - } - /** An interface describing the data returned by calling `repeatingSectionContentControl.toJSON()`. */ - export interface RepeatingSectionContentControlData { + charsLine?: number; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Specifies whether the first page has a different header and footer. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: Word.Interfaces.BuildingBlockData; + differentFirstPageHeaderFooter?: boolean; /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * Specifies the distance between the footer and the bottom of the page in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeData; + footerDistance?: number; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Specifies the amount (in points) of extra margin space added to each page in a document or section for binding. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlapping?: Word.Interfaces.XmlMappingData; + gutter?: number; /** - * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. + * Specifies on which side the gutter appears in a document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - allowInsertDeleteSection?: boolean; + gutterPosition?: Word.GutterPosition | "Left" | "Right" | "Top"; /** - * Specifies the appearance of the content control. + * Specifies whether Microsoft Word uses gutters for the current document based on a right-to-left language or a left-to-right language. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + gutterStyle?: Word.GutterStyle | "Bidirectional" | "Latin"; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Specifies the distance between the header and the top of the page in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + headerDistance?: number; /** - * Returns the identification for the content control. + * Specifies the layout mode for the current document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: string; + layoutMode?: Word.LayoutMode | "Default" | "Grid" | "LineGrid" | "Genko"; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Specifies the distance (in points) between the left edge of the page and the left boundary of the body text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + leftMargin?: number; /** - * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Specifies the number of lines per page in the document grid. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + linesPage?: number; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Specifies if the inside and outside margins of facing pages are the same width. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + mirrorMargins?: boolean; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Specifies whether odd and even pages have different headers and footers. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + oddAndEvenPagesHeaderFooter?: boolean; /** - * Specifies the name of the repeating section items used in the context menu associated with this repeating section content control. + * Specifies the orientation of the page. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - repeatingSectionItemTitle?: string; + orientation?: Word.PageOrientation | "Portrait" | "Landscape"; /** - * Returns whether the placeholder text for the content control is being displayed. + * Specifies the page height in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showingPlaceholderText?: boolean; + pageHeight?: number; /** - * Specifies a tag to identify the content control. + * Specifies the page width in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: string; + pageWidth?: number; /** - * Specifies the title for the content control. + * Specifies the paper size of the page. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: string; - } - /** An interface describing the data returned by calling `frame.toJSON()`. */ - export interface FrameData { + paperSize?: Word.PaperSize | "Size10x14" | "Size11x17" | "Letter" | "LetterSmall" | "Legal" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "CSheet" | "DSheet" | "ESheet" | "FanfoldLegalGerman" | "FanfoldStdGerman" | "FanfoldUS" | "Folio" | "Ledger" | "Note" | "Quarto" | "Statement" | "Tabloid" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC5" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeDL" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "Custom"; /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the frame. + * Specifies the distance (in points) between the right edge of the page and the right boundary of the body text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - borders?: Word.Interfaces.BorderUniversalData[]; + rightMargin?: number; /** - * Returns a `Range` object that represents the portion of the document that's contained within the frame. + * Specifies the reading order and alignment for the specified sections. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeData; + sectionDirection?: Word.SectionDirection | "RightToLeft" | "LeftToRight"; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. + * Specifies the type of section break for the specified object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shading?: Word.Interfaces.ShadingUniversalData; + sectionStart?: Word.SectionStart | "Continuous" | "NewColumn" | "NewPage" | "EvenPage" | "OddPage"; /** - * Specifies the height (in points) of the frame. + * Specifies whether to show the grid. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - height?: number; + showGrid?: boolean; /** - * Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. + * Specifies if endnotes are printed at the end of the next section that doesn't suppress endnotes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - heightRule?: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; + suppressEndnotes?: boolean; /** - * Specifies the horizontal distance between the frame and the surrounding text, in points. + * Specifies the top margin of the page in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontalDistanceFromText?: number; + topMargin?: number; /** - * Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property. + * Specifies whether to print two pages per sheet. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontalPosition?: number; + twoPagesOnOne?: boolean; /** - * Specifies if the frame is locked. + * Specifies the vertical alignment of text on each page in a document or section. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockAnchor?: boolean; + verticalAlignment?: Word.PageSetupVerticalAlignment | "Top" | "Center" | "Justify" | "Bottom"; + } + /** An interface describing the data returned by calling `lineNumbering.toJSON()`. */ + export interface LineNumberingData { /** - * Specifies the relative horizontal position of the frame. + * Specifies the numeric increment for line numbers. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; + countBy?: number; /** - * Specifies the relative vertical position of the frame. + * Specifies the distance (in points) between the right edge of line numbers and the left edge of the document text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + distanceFromText?: number; /** - * Specifies if document text wraps around the frame. + * Specifies if line numbering is active for the specified document, section, or sections. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textWrap?: boolean; + isActive?: boolean; /** - * Specifies the vertical distance (in points) between the frame and the surrounding text. + * Specifies the way line numbering runs; that is, whether it starts over at the beginning of a new page or section, or runs continuously. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - verticalDistanceFromText?: number; + restartMode?: Word.NumberingRule | "RestartContinuous" | "RestartSection" | "RestartPage"; /** - * Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property. + * Specifies the starting line number. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - verticalPosition?: number; + startingNumber?: number; + } + /** An interface describing the data returned by calling `textColumnCollection.toJSON()`. */ + export interface TextColumnCollectionData { + items?: Word.Interfaces.TextColumnData[]; + } + /** An interface describing the data returned by calling `textColumn.toJSON()`. */ + export interface TextColumnData { /** - * Specifies the width (in points) of the frame. + * Specifies the amount of spacing (in points) after the specified paragraph or text column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - width?: number; + spaceAfter?: number; /** - * Specifies the rule used to determine the width of the frame. + * Specifies the width, in points, of the specified text columns. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - widthRule?: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; - } - /** An interface describing the data returned by calling `frameCollection.toJSON()`. */ - export interface FrameCollectionData { - items?: Word.Interfaces.FrameData[]; + width?: number; } - /** An interface describing the data returned by calling `documentLibraryVersion.toJSON()`. */ - export interface DocumentLibraryVersionData { + /** An interface describing the data returned by calling `selection.toJSON()`. */ + export interface SelectionData { /** - * Gets any optional comments associated with this version of the shared document. + * Specifies the ending character position of the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - comments?: string; + end?: number; /** - * Gets the date and time at which this version of the shared document was last saved to the server. + * Specifies the width in which Word fits the text in the current selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - modified?: any; + fitTextWidth?: number; /** - * Gets the name of the user who last saved this version of the shared document to the server. + * Returns whether the spelling and grammar checker ignores the selected text. + If the selected text contains a mix of proofed and un-proofed content, this API returns `null`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - modifiedBy?: string; - } - /** An interface describing the data returned by calling `documentLibraryVersionCollection.toJSON()`. */ - export interface DocumentLibraryVersionCollectionData { - items?: Word.Interfaces.DocumentLibraryVersionData[]; - } - /** An interface describing the data returned by calling `dropCap.toJSON()`. */ - export interface DropCapData { + hasNoProofing?: boolean; /** - * Gets the distance (in points) between the dropped capital letter and the paragraph text. + * Returns whether the selection in the specified window or pane is active. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - distanceFromText?: number; + isActive?: boolean; /** - * Gets the name of the font for the dropped capital letter. + * Specifies whether column selection mode is active. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fontName?: string; + isColumnSelectModeActive?: boolean; /** - * Gets the height (in lines) of the dropped capital letter. + * Returns whether the selection is at the end-of-row mark in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - linesToDrop?: number; + isEndOfRowMark?: boolean; /** - * Gets the position of the dropped capital letter. + * Specifies whether Extend mode is active. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - position?: Word.DropPosition | "None" | "Normal" | "Margin"; - } - /** An interface describing the data returned by calling `listFormat.toJSON()`. */ - export interface ListFormatData { + isExtendModeActive?: boolean; /** - * Returns a `List` object that represents the first formatted list contained in the `ListFormat` object. + * Returns whether the insertion point is at the end of a line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - list?: Word.Interfaces.ListData; + isInsertionPointAtEndOfLine?: boolean; /** - * Gets the list template associated with the `ListFormat` object. + * Specifies whether the beginning of the selection is active. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listTemplate?: Word.Interfaces.ListTemplateData; + isStartActive?: boolean; /** - * Indicates whether the `ListFormat` object contains a single list. + * Specifies whether Word has detected the language of the selected text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isSingleList?: boolean; + languageDetected?: boolean; /** - * Indicates whether the `ListFormat` object contains a single list template. + * Returns the language for the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isSingleListTemplate?: boolean; + languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies the list level number for the first paragraph for the `ListFormat` object. + * Returns the East Asian language for the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listLevelNumber?: number; + languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Gets the string representation of the list value of the first paragraph in the range for the `ListFormat` object. + * Returns the language for the selection that isn't classified as an East Asian language. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listString?: string; + languageIdOther?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Gets the type of the list for the `ListFormat` object. + * Specifies the orientation of text in the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listType?: Word.ListType | "ListNoNumbering" | "ListListNumOnly" | "ListBullet" | "ListSimpleNumbering" | "ListOutlineNumbering" | "ListMixedNumbering" | "ListPictureBullet"; + orientation?: Word.TextOrientation | "Horizontal" | "Upward" | "Downward" | "VerticalFarEast" | "HorizontalRotatedFarEast" | "Vertical"; /** - * Gets the numeric value of the the first paragraph in the range for the `ListFormat` object. + * Specifies the starting character position of the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listValue?: number; - } - /** An interface describing the data returned by calling `fillFormat.toJSON()`. */ - export interface FillFormatData { + start?: number; /** - * Returns a `ColorFormat` object that represents the background color for the fill. + * Returns the number of characters in the story that contains the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - backgroundColor?: Word.Interfaces.ColorFormatData; + storyLength?: number; /** - * Returns a `ColorFormat` object that represents the foreground color for the fill. + * Returns the story type for the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - foregroundColor?: Word.Interfaces.ColorFormatData; + storyType?: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; /** - * Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9. + * Specifies the text in the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gradientAngle?: number; + text?: string; /** - * Gets the gradient color type. + * Returns the selection type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gradientColorType?: Word.GradientColorType | "Mixed" | "OneColor" | "TwoColors" | "PresetColors" | "MultiColor"; + type?: Word.SelectionType | "NoSelection" | "InsertionPoint" | "Normal" | "Frame" | "Column" | "Row" | "Block" | "InlineShape" | "SelectionShape"; + } + /** An interface describing the data returned by calling `rangeScopedCollection.toJSON()`. */ + export interface RangeScopedCollectionData { + items?: Word.Interfaces.RangeData[]; + } + /** An interface describing the data returned by calling `bookmark.toJSON()`. */ + export interface BookmarkData { /** - * Returns how dark or light a one-color gradient fill is. - A value of 0 means that black is mixed in with the shape's foreground color to form the gradient. - A value of 1 means that white is mixed in. - Values between 0 and 1 mean that a darker or lighter shade of the foreground color is mixed in. + * Returns a `Range` object that represents the portion of the document that's contained in the `Bookmark` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gradientDegree?: number; + range?: Word.Interfaces.RangeData; /** - * Returns the gradient style for the fill. + * Specifies the ending character position of the bookmark. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gradientStyle?: Word.GradientStyle | "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter"; + end?: number; /** - * Returns the gradient variant for the fill as an integer value from 1 to 4 for most gradient fills. + * Returns `true` if the bookmark is a table column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gradientVariant?: number; + isColumn?: boolean; /** - * Specifies if the object, or the formatting applied to it, is visible. + * Returns `true` if the bookmark is empty. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + isEmpty?: boolean; /** - * Returns a `PatternType` value that represents the pattern applied to the fill or line. + * Returns the name of the `Bookmark` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pattern?: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"; + name?: string; /** - * Returns the preset gradient type for the fill. + * Specifies the starting character position of the bookmark. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetGradientType?: Word.PresetGradientType | "Mixed" | "EarlySunset" | "LateSunset" | "Nightfall" | "Daybreak" | "Horizon" | "Desert" | "Ocean" | "CalmWater" | "Fire" | "Fog" | "Moss" | "Peacock" | "Wheat" | "Parchment" | "Mahogany" | "Rainbow" | "RainbowII" | "Gold" | "GoldII" | "Brass" | "Chrome" | "ChromeII" | "Silver" | "Sapphire"; + start?: number; /** - * Gets the preset texture. + * Returns the story type for the bookmark. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetTexture?: Word.PresetTexture | "Mixed" | "Papyrus" | "Canvas" | "Denim" | "WovenMat" | "WaterDroplets" | "PaperBag" | "FishFossil" | "Sand" | "GreenMarble" | "WhiteMarble" | "BrownMarble" | "Granite" | "Newsprint" | "RecycledPaper" | "Parchment" | "Stationery" | "BlueTissuePaper" | "PinkTissuePaper" | "PurpleMesh" | "Bouquet" | "Cork" | "Walnut" | "Oak" | "MediumWood"; + storyType?: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; + } + /** An interface describing the data returned by calling `bookmarkCollection.toJSON()`. */ + export interface BookmarkCollectionData { + items?: Word.Interfaces.BookmarkData[]; + } + /** An interface describing the data returned by calling `index.toJSON()`. */ + export interface IndexData { /** - * Specifies whether the fill rotates with the shape. + * Returns a `Range` object that represents the portion of the document that is contained within the index. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotateWithObject?: boolean; + range?: Word.Interfaces.RangeData; /** - * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. + * Gets a value that represents how Microsoft Word classifies the first character of entries in the index. + See `IndexFilter` for available values. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureAlignment?: Word.TextureAlignment | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "Center" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; + filter?: Word.IndexFilter | "None" | "Aiueo" | "Akasatana" | "Chosung" | "Low" | "Medium" | "Full"; /** - * Specifies the horizontal scaling factor for the texture fill. + * Gets the text between alphabetical groups (entries that start with the same letter) in the index. Corresponds to + the **\h** switch for an {@link https://support.microsoft.com/office/adafcf4a-cb30-43f6-85c7-743da1635d9e | INDEX field}. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureHorizontalScale?: number; + headingSeparator?: Word.HeadingSeparator | "None" | "BlankLine" | "Letter" | "LetterLow" | "LetterFull"; /** - * Returns the name of the custom texture file for the fill. + * Gets a `LanguageId` value that represents the sorting language to use for the index. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureName?: string; + indexLanguage?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies the horizontal offset of the texture from the origin in points. + * Gets the number of columns for each page of the index. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureOffsetX?: number; + numberOfColumns?: number; /** - * Specifies the vertical offset of the texture. + * Specifies if page numbers are aligned with the right margin in the index. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureOffsetY?: number; + rightAlignPageNumbers?: boolean; /** - * Specifies whether the texture is tiled. + * Gets if the index contains separate headings for accented letters (for example, words that begin with "À" are under + one heading and words that begin with "A" are under another). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureTile?: boolean; + separateAccentedLetterHeadings?: boolean; /** - * Returns the texture type for the fill. + * Specifies the sorting criteria for the index. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureType?: Word.TextureType | "Mixed" | "Preset" | "UserDefined"; + sortBy?: Word.IndexSortBy | "Stroke" | "Syllable"; /** - * Specifies the vertical scaling factor for the texture fill as a value between 0.0 and 1.0. + * Specifies the leader character between entries in the index and their associated page numbers. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureVerticalScale?: number; + tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** - * Specifies the degree of transparency of the fill for a shape as a value between 0.0 (opaque) and 1.0 (clear). + * Gets the index type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency?: number; + type?: Word.IndexType | "Indent" | "Runin"; + } + /** An interface describing the data returned by calling `indexCollection.toJSON()`. */ + export interface IndexCollectionData { + items?: Word.Interfaces.IndexData[]; + } + /** An interface describing the data returned by calling `listTemplateCollection.toJSON()`. */ + export interface ListTemplateCollectionData { + items?: Word.Interfaces.ListTemplateData[]; + } + /** An interface describing the data returned by calling `listTemplateGallery.toJSON()`. */ + export interface ListTemplateGalleryData { + } + /** An interface describing the data returned by calling `listTemplateGalleryCollection.toJSON()`. */ + export interface ListTemplateGalleryCollectionData { + items?: Word.Interfaces.ListTemplateGalleryData[]; + } + /** + * Represents a user with permissions to edit authorized portions of a protected (read-only) Word document. To learn more, see {@link https://support.microsoft.com/office/187ed01c-8795-43e1-9fd0-c9fca419dadf | Allow changes to parts of a protected Word document}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface EditorLoadOptions { /** - * Gets the fill format type. + Specifying `$all` 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 a `Range` object that represents the next range that the editor has permissions to modify. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.FillType | "Mixed" | "Solid" | "Patterned" | "Gradient" | "Textured" | "Background" | "Picture"; - } - /** An interface describing the data returned by calling `glowFormat.toJSON()`. */ - export interface GlowFormatData { + nextRange?: Word.Interfaces.RangeLoadOptions; /** - * Returns a `ColorFormat` object that represents the color for a glow effect. + * Gets a `Range` object that represents the portion of the document that's contained in the `Editor` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: Word.Interfaces.ColorFormatData; + range?: Word.Interfaces.RangeLoadOptions; /** - * Specifies the length of the radius for a glow effect. + * Gets the identifier for the `Editor` object when the parent document is saved as a webpage. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - radius?: number; + id?: boolean; /** - * Specifies the degree of transparency for the glow effect as a value between 0.0 (opaque) and 1.0 (clear). + * Gets the name of the editor. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency?: number; + name?: boolean; } - /** An interface describing the data returned by calling `lineFormat.toJSON()`. */ - export interface LineFormatData { + /** + * Represents the coauthoring conflicts in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface ConflictCollectionLoadOptions { /** - * Gets a `ColorFormat` object that represents the background color for a patterned line. + Specifying `$all` 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 a `Range` object that represents the portion of the document that's contained in the `Conflict` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - backgroundColor?: Word.Interfaces.ColorFormatData; + range?: Word.Interfaces.RangeLoadOptions; /** - * Gets a `ColorFormat` object that represents the foreground color for the line. + * For EACH ITEM in the collection: Gets the `RevisionType` for the `Conflict` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - foregroundColor?: Word.Interfaces.ColorFormatData; + type?: boolean; + } + /** + * Represents a coauthoring conflict in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface ConflictLoadOptions { /** - * Specifies the length of the arrowhead at the beginning of the line. + Specifying `$all` 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 a `Range` object that represents the portion of the document that's contained in the `Conflict` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - beginArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; + range?: Word.Interfaces.RangeLoadOptions; /** - * Specifies the style of the arrowhead at the beginning of the line. + * Gets the `RevisionType` for the `Conflict` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - beginArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; + type?: boolean; + } + /** + * Represents an annotation wrapper around critique displayed in the document. + * + * @remarks + * [Api set: WordApi 1.7] + */ + export interface CritiqueAnnotationLoadOptions { /** - * Specifies the width of the arrowhead at the beginning of the line. + Specifying `$all` 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 range of text that is annotated. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - beginArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; + range?: Word.Interfaces.RangeLoadOptions; /** - * Specifies the dash style for the line. + * Gets the critique that was passed when the annotation was inserted. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - dashStyle?: Word.LineDashStyle | "Mixed" | "Solid" | "SquareDot" | "RoundDot" | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "SysDash" | "SysDot" | "SysDashDot"; + critique?: boolean; + } + /** + * Represents an annotation attached to a paragraph. + * + * @remarks + * [Api set: WordApi 1.7] + */ + export interface AnnotationLoadOptions { /** - * Specifies the length of the arrowhead at the end of the line. + Specifying `$all` 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 critique annotation object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - endArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; + critiqueAnnotation?: Word.Interfaces.CritiqueAnnotationLoadOptions; /** - * Specifies the style of the arrowhead at the end of the line. + * Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - endArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; + id?: boolean; /** - * Specifies the width of the arrowhead at the end of the line. + * Gets the state of the annotation. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - endArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; + state?: boolean; + } + /** + * Contains a collection of {@link Word.Annotation} objects. + * + * @remarks + * [Api set: WordApi 1.7] + */ + export interface AnnotationCollectionLoadOptions { /** - * Specifies if to draw lines inside a shape. + Specifying `$all` 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 critique annotation object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - insetPen?: boolean; + critiqueAnnotation?: Word.Interfaces.CritiqueAnnotationLoadOptions; /** - * Specifies if the object, or the formatting applied to it, is visible. + * For EACH ITEM in the collection: Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - isVisible?: boolean; + id?: boolean; /** - * Specifies the pattern applied to the line. + * For EACH ITEM in the collection: Gets the state of the annotation. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - pattern?: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"; + state?: boolean; + } + /** + * Represents the application object. + * + * @remarks + * [Api set: WordApi 1.3] + */ + export interface ApplicationLoadOptions { /** - * Specifies the line format style. + Specifying `$all` 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 `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - style?: Word.LineFormatStyle | "Mixed" | "Single" | "ThinThin" | "ThinThick" | "ThickThin" | "ThickBetweenThin"; + bibliography?: Word.Interfaces.BibliographyLoadOptions; /** - * Specifies the degree of transparency of the line as a value between 0.0 (opaque) and 1.0 (clear). + * Specifies if Microsoft Word automatically detects the language you are using as you type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency?: number; + checkLanguage?: boolean; /** - * Specifies the thickness of the line in points. + * Gets a `LanguageId` value that represents the language selected for the Microsoft Word user interface. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - weight?: number; + language?: boolean; } - /** An interface describing the data returned by calling `reflectionFormat.toJSON()`. */ - export interface ReflectionFormatData { + /** + * Represents the body of a document or a section. + * + * @remarks + * [Api set: WordApi 1.1] + */ + export interface BodyLoadOptions { /** - * Specifies the degree of blur effect applied to the `ReflectionFormat` object as a value between 0.0 and 100.0. + Specifying `$all` 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 text format of the body. Use this to get and set font name, size, color and other properties. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - blur?: number; + font?: Word.Interfaces.FontLoadOptions; /** - * Specifies the amount of separation, in points, of the reflected image from the shape. + * Gets the parent body of the body. For example, a table cell body's parent body could be a header. Throws an `ItemNotFound` error if there isn't a parent body. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - offset?: number; + parentBody?: Word.Interfaces.BodyLoadOptions; /** - * Specifies the size of the reflection as a percentage of the reflected shape from 0 to 100. + * Gets the parent body of the body. For example, a table cell body's parent body could be a header. If there isn't a parent body, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - size?: number; + parentBodyOrNullObject?: Word.Interfaces.BodyLoadOptions; /** - * Specifies the degree of transparency for the reflection effect as a value between 0.0 (opaque) and 1.0 (clear). + * Gets the content control that contains the body. Throws an `ItemNotFound` error if there isn't a parent content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - transparency?: number; + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Specifies a `ReflectionType` value that represents the type and direction of the lighting for a shape reflection. + * Gets the content control that contains the body. If there isn't a parent content control, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - type?: Word.ReflectionType | "Mixed" | "None" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9"; - } - /** An interface describing the data returned by calling `colorFormat.toJSON()`. */ - export interface ColorFormatData { + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Specifies the brightness of a specified shape color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. + * Gets the parent section of the body. Throws an `ItemNotFound` error if there isn't a parent section. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - brightness?: number; + parentSection?: Word.Interfaces.SectionLoadOptions; /** - * Specifies the theme color for a color format. + * Gets the parent section of the body. If there isn't a parent section, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - objectThemeColor?: Word.ThemeColorIndex | "NotThemeColor" | "MainDark1" | "MainLight1" | "MainDark2" | "MainLight2" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Hyperlink" | "HyperlinkFollowed" | "Background1" | "Text1" | "Background2" | "Text2"; + parentSectionOrNullObject?: Word.Interfaces.SectionLoadOptions; /** - * Specifies the red-green-blue (RGB) value of the specified color. You can provide the value in the '#RRGGBB' format. + * Specifies the style name for the body. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - rgb?: string; + style?: boolean; /** - * Specifies the lightening or darkening of a specified shape's color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. + * Specifies the built-in style name for the body. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - tintAndShade?: number; + styleBuiltIn?: boolean; /** - * Returns the shape color type. + * Gets the text of the body. Use the insertText method to insert text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - type?: Word.ColorType | "rgb" | "scheme"; + text?: boolean; + /** + * Gets the type of the body. The type can be 'MainDoc', 'Section', 'Header', 'Footer', or 'TableCell'. Additional types ‘Footnote’, ‘Endnote’, and ‘NoteItem’ are supported in WordApiOnline 1.1 and later. + * + * @remarks + * [Api set: WordApi 1.3] + */ + type?: boolean; } - /** An interface describing the data returned by calling `shadowFormat.toJSON()`. */ - export interface ShadowFormatData { + /** + * Represents the Border object for text, a paragraph, or a table. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + export interface BorderLoadOptions { /** - * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. + Specifying `$all` 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 color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - foregroundColor?: Word.Interfaces.ColorFormatData; + color?: boolean; /** - * Specifies the blur level for a shadow format as a value between 0.0 and 100.0. + * Gets the location of the border. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - blur?: number; + location?: boolean; /** - * Specifies whether the object or the formatting applied to it is visible. + * Specifies the border type for the border. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - isVisible?: boolean; + type?: boolean; /** - * Specifies `true` if the shadow of the shape appears filled in and is obscured by the shape, even if the shape has no fill, - `false` if the shadow has no fill and the outline of the shadow is visible through the shape if the shape has no fill. + * Specifies whether the border is visible. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - obscured?: boolean; + visible?: boolean; /** - * Specifies the horizontal offset (in points) of the shadow from the shape. - A positive value offsets the shadow to the right of the shape; a negative value offsets it to the left. + * Specifies the width for the border. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - offsetX?: number; + width?: boolean; + } + /** + * Represents the `BorderUniversal` object, which manages borders for a range, paragraph, table, or frame. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface BorderUniversalLoadOptions { /** - * Specifies the vertical offset (in points) of the shadow from the shape. - A positive value offsets the shadow to the top of the shape; a negative value offsets it to the bottom. + Specifying `$all` 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 graphical page-border design for the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - offsetY?: number; + artStyle?: boolean; /** - * Specifies whether to rotate the shadow when rotating the shape. + * Specifies the width (in points) of the graphical page border specified in the `artStyle` property. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotateWithShape?: boolean; + artWidth?: boolean; /** - * Specifies the width of the shadow. + * Specifies the color for the `BorderUniversal` object. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - size?: number; + color?: boolean; /** - * Specifies the type of shadow formatting to apply to a shape. + * Specifies the color for the `BorderUniversal` or {@link Word.Font} object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - style?: Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow"; + colorIndex?: boolean; /** - * Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear). + * Returns `true` if an inside border can be applied to the specified object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency?: number; + inside?: boolean; /** - * Specifies the shape shadow type. + * Specifies whether the border is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.ShadowType | "Mixed" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9" | "Type10" | "Type11" | "Type12" | "Type13" | "Type14" | "Type15" | "Type16" | "Type17" | "Type18" | "Type19" | "Type20" | "Type21" | "Type22" | "Type23" | "Type24" | "Type25" | "Type26" | "Type27" | "Type28" | "Type29" | "Type30" | "Type31" | "Type32" | "Type33" | "Type34" | "Type35" | "Type36" | "Type37" | "Type38" | "Type39" | "Type40" | "Type41" | "Type42" | "Type43"; - } - /** An interface describing the data returned by calling `threeDimensionalFormat.toJSON()`. */ - export interface ThreeDimensionalFormatData { + isVisible?: boolean; /** - * Returns a `ColorFormat` object that represents color of the contour of a shape. + * Specifies the line style of the border. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contourColor?: Word.Interfaces.ColorFormatData; + lineStyle?: boolean; /** - * Returns a `ColorFormat` object that represents the color of the shape's extrusion. + * Specifies the line width of an object's border. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - extrusionColor?: Word.Interfaces.ColorFormatData; + lineWidth?: boolean; + } + /** + * Represents the collection of border styles. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + export interface BorderCollectionLoadOptions { /** - * Specifies the depth of the bottom bevel. + Specifying `$all` 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 color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - bevelBottomDepth?: number; + color?: boolean; /** - * Specifies the inset size for the bottom bevel. + * For EACH ITEM in the collection: Gets the location of the border. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - bevelBottomInset?: number; + location?: boolean; /** - * Specifies a `BevelType` value that represents the bevel type for the bottom bevel. + * For EACH ITEM in the collection: Specifies the border type for the border. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - bevelBottomType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; + type?: boolean; /** - * Specifies the depth of the top bevel. + * For EACH ITEM in the collection: Specifies whether the border is visible. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - bevelTopDepth?: number; + visible?: boolean; /** - * Specifies the inset size for the top bevel. + * For EACH ITEM in the collection: Specifies the width for the border. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - bevelTopInset?: number; + width?: boolean; + } + /** + * Represents the collection of {@link Word.BorderUniversal} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface BorderUniversalCollectionLoadOptions { /** - * Specifies a `BevelType` value that represents the bevel type for the top bevel. + Specifying `$all` 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 graphical page-border design for the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelTopType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; + artStyle?: boolean; /** - * Specifies the width of the contour of a shape. + * For EACH ITEM in the collection: Specifies the width (in points) of the graphical page border specified in the `artStyle` property. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contourWidth?: number; + artWidth?: boolean; /** - * Specifies the depth of the shape's extrusion. + * For EACH ITEM in the collection: Specifies the color for the `BorderUniversal` object. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - depth?: number; + color?: boolean; /** - * Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion) - and automatically changes when the shape's fill changes, or whether the extrusion color is independent of the shape's fill. + * For EACH ITEM in the collection: Specifies the color for the `BorderUniversal` or {@link Word.Font} object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - extrusionColorType?: Word.ExtrusionColorType | "mixed" | "automatic" | "custom"; + colorIndex?: boolean; /** - * Specifies the amount of perspective for a shape. + * For EACH ITEM in the collection: Returns `true` if an inside border can be applied to the specified object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fieldOfView?: number; + inside?: boolean; /** - * Specifies `true` if the extrusion appears in perspective — that is, if the walls of the extrusion narrow toward a vanishing point, - `false` if the extrusion is a parallel, or orthographic, projection — that is, if the walls don't narrow toward a vanishing point. + * For EACH ITEM in the collection: Specifies whether the border is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isPerspective?: boolean; + isVisible?: boolean; /** - * Specifies if the specified object, or the formatting applied to it, is visible. + * For EACH ITEM in the collection: Specifies the line style of the border. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + lineStyle?: boolean; /** - * Specifies the angle of the lighting. + * For EACH ITEM in the collection: Specifies the line width of an object's border. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lightAngle?: number; + lineWidth?: boolean; + } + /** + * Represents a break in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface BreakLoadOptions { + /** + Specifying `$all` 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 `PresetCamera` value that represents the camera presets. + * Returns a `Range` object that represents the portion of the document that's contained in the break. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetCamera?: Word.PresetCamera | "Mixed" | "LegacyObliqueTopLeft" | "LegacyObliqueTop" | "LegacyObliqueTopRight" | "LegacyObliqueLeft" | "LegacyObliqueFront" | "LegacyObliqueRight" | "LegacyObliqueBottomLeft" | "LegacyObliqueBottom" | "LegacyObliqueBottomRight" | "LegacyPerspectiveTopLeft" | "LegacyPerspectiveTop" | "LegacyPerspectiveTopRight" | "LegacyPerspectiveLeft" | "LegacyPerspectiveFront" | "LegacyPerspectiveRight" | "LegacyPerspectiveBottomLeft" | "LegacyPerspectiveBottom" | "LegacyPerspectiveBottomRight" | "OrthographicFront" | "IsometricTopUp" | "IsometricTopDown" | "IsometricBottomUp" | "IsometricBottomDown" | "IsometricLeftUp" | "IsometricLeftDown" | "IsometricRightUp" | "IsometricRightDown" | "IsometricOffAxis1Left" | "IsometricOffAxis1Right" | "IsometricOffAxis1Top" | "IsometricOffAxis2Left" | "IsometricOffAxis2Right" | "IsometricOffAxis2Top" | "IsometricOffAxis3Left" | "IsometricOffAxis3Right" | "IsometricOffAxis3Bottom" | "IsometricOffAxis4Left" | "IsometricOffAxis4Right" | "IsometricOffAxis4Bottom" | "ObliqueTopLeft" | "ObliqueTop" | "ObliqueTopRight" | "ObliqueLeft" | "ObliqueRight" | "ObliqueBottomLeft" | "ObliqueBottom" | "ObliqueBottomRight" | "PerspectiveFront" | "PerspectiveLeft" | "PerspectiveRight" | "PerspectiveAbove" | "PerspectiveBelow" | "PerspectiveAboveLeftFacing" | "PerspectiveAboveRightFacing" | "PerspectiveContrastingLeftFacing" | "PerspectiveContrastingRightFacing" | "PerspectiveHeroicLeftFacing" | "PerspectiveHeroicRightFacing" | "PerspectiveHeroicExtremeLeftFacing" | "PerspectiveHeroicExtremeRightFacing" | "PerspectiveRelaxed" | "PerspectiveRelaxedModerately"; + range?: Word.Interfaces.RangeLoadOptions; /** - * Returns the direction taken by the extrusion's sweep path leading away from the extruded shape (the front face of the extrusion). + * Returns the page number on which the break occurs. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetExtrusionDirection?: Word.PresetExtrusionDirection | "Mixed" | "BottomRight" | "Bottom" | "BottomLeft" | "Right" | "None" | "Left" | "TopRight" | "Top" | "TopLeft"; + pageIndex?: boolean; + } + /** + * Contains a collection of {@link Word.Break} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface BreakCollectionLoadOptions { /** - * Specifies a `LightRigType` value that represents the lighting preset. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ - presetLighting?: Word.LightRigType | "Mixed" | "LegacyFlat1" | "LegacyFlat2" | "LegacyFlat3" | "LegacyFlat4" | "LegacyNormal1" | "LegacyNormal2" | "LegacyNormal3" | "LegacyNormal4" | "LegacyHarsh1" | "LegacyHarsh2" | "LegacyHarsh3" | "LegacyHarsh4" | "ThreePoint" | "Balanced" | "Soft" | "Harsh" | "Flood" | "Contrasting" | "Morning" | "Sunrise" | "Sunset" | "Chilly" | "Freezing" | "Flat" | "TwoPoint" | "Glow" | "BrightRoom"; + $all?: boolean; /** - * Specifies the position of the light source relative to the extrusion. + * For EACH ITEM in the collection: Returns a `Range` object that represents the portion of the document that's contained in the break. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetLightingDirection?: Word.PresetLightingDirection | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "None" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; + range?: Word.Interfaces.RangeLoadOptions; /** - * Specifies the intensity of the extrusion lighting. + * For EACH ITEM in the collection: Returns the page number on which the break occurs. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetLightingSoftness?: Word.PresetLightingSoftness | "Mixed" | "Dim" | "Normal" | "Bright"; + pageIndex?: boolean; + } + /** + * Represents a building block in a template. A building block is pre-built content, similar to autotext, that may contain text, images, and formatting. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface BuildingBlockLoadOptions { /** - * Specifies the extrusion surface material. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ - presetMaterial?: Word.PresetMaterial | "Mixed" | "Matte" | "Plastic" | "Metal" | "WireFrame" | "Matte2" | "Plastic2" | "Metal2" | "WarmMatte" | "TranslucentPowder" | "Powder" | "DarkEdge" | "SoftEdge" | "Clear" | "Flat" | "SoftMetal"; + $all?: boolean; /** - * Returns the preset extrusion format. + * Returns a `BuildingBlockCategory` object that represents the category for the building block. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetThreeDimensionalFormat?: Word.PresetThreeDimensionalFormat | "Mixed" | "Format1" | "Format2" | "Format3" | "Format4" | "Format5" | "Format6" | "Format7" | "Format8" | "Format9" | "Format10" | "Format11" | "Format12" | "Format13" | "Format14" | "Format15" | "Format16" | "Format17" | "Format18" | "Format19" | "Format20"; + category?: Word.Interfaces.BuildingBlockCategoryLoadOptions; /** - * Specifies whether text on a shape rotates with shape. `true` rotates the text. + * Returns a `BuildingBlockTypeItem` object that represents the type for the building block. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - projectText?: boolean; + type?: Word.Interfaces.BuildingBlockTypeItemLoadOptions; /** - * Specifies the rotation of the extruded shape around the x-axis in degrees. + * Specifies the description for the building block. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotationX?: number; + description?: boolean; /** - * Specifies the rotation of the extruded shape around the y-axis in degrees. + * Returns the internal identification number for the building block. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotationY?: number; + id?: boolean; /** - * Specifies the z-axis rotation of the camera. + * Returns the position of this building block in a collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotationZ?: number; + index?: boolean; /** - * Specifies the position on the z-axis for the shape. + * Specifies a `DocPartInsertType` value that represents how to insert the contents of the building block into the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - z?: number; - } - /** An interface describing the data returned by calling `bibliography.toJSON()`. */ - export interface BibliographyData { + insertType?: boolean; /** - * Returns a `SourceCollection` object that represents all the sources contained in the bibliography. + * Specifies the name of the building block. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sources?: Word.Interfaces.SourceData[]; + name?: boolean; /** - * Specifies the name of the active style to use for the bibliography. + * Specifies the contents of the building block. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bibliographyStyle?: string; - } - /** An interface describing the data returned by calling `sourceCollection.toJSON()`. */ - export interface SourceCollectionData { - items?: Word.Interfaces.SourceData[]; + value?: boolean; } - /** An interface describing the data returned by calling `source.toJSON()`. */ - export interface SourceData { + /** + * Represents a category of building blocks in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface BuildingBlockCategoryLoadOptions { /** - * Gets if the `Source` object has been cited in the document. + Specifying `$all` 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 `BuildingBlockTypeItem` object that represents the type of building block for the building block category. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isCited?: boolean; + type?: Word.Interfaces.BuildingBlockTypeItemLoadOptions; /** - * Gets the tag of the source. + * Returns the position of the `BuildingBlockCategory` object in a collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: string; + index?: boolean; /** - * Gets the XML representation of the source. + * Returns the name of the `BuildingBlockCategory` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xml?: string; + name?: boolean; } - /** An interface describing the data returned by calling `pageSetup.toJSON()`. */ - export interface PageSetupData { + /** + * Represents a type of building block in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface BuildingBlockTypeItemLoadOptions { /** - * Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object. + Specifying `$all` 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 position of an item in a collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lineNumbering?: Word.Interfaces.LineNumberingData; + index?: boolean; /** - * Gets a `TextColumnCollection` object that represents the set of text columns for the `PageSetup` object. + * Returns the localized name of a building block type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textColumns?: Word.Interfaces.TextColumnData[]; + name?: boolean; + } + /** + * The data specific to content controls of type CheckBox. + * + * @remarks + * [Api set: WordApi 1.7] + */ + export interface CheckboxContentControlLoadOptions { /** - * Specifies whether Microsoft Word prints the document as a booklet. + Specifying `$all` 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 current state of the checkbox. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - bookFoldPrinting?: boolean; + isChecked?: boolean; + } + /** + * Represents a coauthoring lock in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface CoauthoringLockLoadOptions { /** - * Specifies the number of pages for each booklet. + Specifying `$all` 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 owner of the lock. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bookFoldPrintingSheets?: number; + owner?: Word.Interfaces.CoauthorLoadOptions; /** - * Specifies if Microsoft Word reverses the printing order for book fold printing of bidirectional or Asian language documents. + * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringLock` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bookFoldReversePrinting?: boolean; + range?: Word.Interfaces.RangeLoadOptions; /** - * Specifies the distance (in points) between the bottom edge of the page and the bottom boundary of the body text. + * Gets a `CoauthoringLockType` value that represents the lock type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottomMargin?: number; + type?: boolean; + } + /** + * Represents a collection of coauthoring locks in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface CoauthoringLockCollectionLoadOptions { /** - * Specifies the number of characters per line in the document grid. + Specifying `$all` 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 owner of the lock. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - charsLine?: number; + owner?: Word.Interfaces.CoauthorLoadOptions; /** - * Specifies whether the first page has a different header and footer. + * For EACH ITEM in the collection: Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringLock` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - differentFirstPageHeaderFooter?: boolean; + range?: Word.Interfaces.RangeLoadOptions; /** - * Specifies the distance between the footer and the bottom of the page in points. + * For EACH ITEM in the collection: Gets a `CoauthoringLockType` value that represents the lock type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footerDistance?: number; + type?: boolean; + } + /** + * Represents a coauthor in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface CoauthorLoadOptions { /** - * Specifies the amount (in points) of extra margin space added to each page in a document or section for binding. + Specifying `$all` 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 email address of the coauthor. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gutter?: number; + emailAddress?: boolean; /** - * Specifies on which side the gutter appears in a document. + * Gets the unique identifier for the `Coauthor` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gutterPosition?: Word.GutterPosition | "Left" | "Right" | "Top"; + id?: boolean; /** - * Specifies whether Microsoft Word uses gutters for the current document based on a right-to-left language or a left-to-right language. + * Gets whether this author represents the current user. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gutterStyle?: Word.GutterStyle | "Bidirectional" | "Latin"; + isMe?: boolean; /** - * Specifies the distance between the header and the top of the page in points. + * Gets the display name of the coauthor. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - headerDistance?: number; + name?: boolean; + } + /** + * Contains a collection of {@link Word.Coauthor} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface CoauthorCollectionLoadOptions { /** - * Specifies the layout mode for the current document. + Specifying `$all` 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 email address of the coauthor. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - layoutMode?: Word.LayoutMode | "Default" | "Grid" | "LineGrid" | "Genko"; + emailAddress?: boolean; /** - * Specifies the distance (in points) between the left edge of the page and the left boundary of the body text. + * For EACH ITEM in the collection: Gets the unique identifier for the `Coauthor` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - leftMargin?: number; + id?: boolean; /** - * Specifies the number of lines per page in the document grid. + * For EACH ITEM in the collection: Gets whether this author represents the current user. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - linesPage?: number; + isMe?: boolean; /** - * Specifies if the inside and outside margins of facing pages are the same width. + * For EACH ITEM in the collection: Gets the display name of the coauthor. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mirrorMargins?: boolean; + name?: boolean; + } + /** + * Represents the `Coauthoring` object. This tracks the updates, changes, conflicts, and other interactions in the document done through coauthoring. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface CoauthoringLoadOptions { /** - * Specifies whether odd and even pages have different headers and footers. + Specifying `$all` 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 a `Coauthor` object that represents the current user. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - oddAndEvenPagesHeaderFooter?: boolean; + me?: Word.Interfaces.CoauthorLoadOptions; /** - * Specifies the orientation of the page. + * Gets whether this document can be coauthored. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - orientation?: Word.PageOrientation | "Portrait" | "Landscape"; + canCoauthor?: boolean; /** - * Specifies the page height in points. + * Gets whether the document can be automatically merged. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageHeight?: number; + canMerge?: boolean; /** - * Specifies the page width in points. + * Gets whether the document has pending updates that have not been accepted. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageWidth?: number; + pendingUpdates?: boolean; + } + /** + * Represents a coauthoring update in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface CoauthoringUpdateLoadOptions { /** - * Specifies the paper size of the page. + Specifying `$all` 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 a `Range` object that represents the portion of the document that's contained in the `CoauthoringUpdate` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - paperSize?: Word.PaperSize | "Size10x14" | "Size11x17" | "Letter" | "LetterSmall" | "Legal" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "CSheet" | "DSheet" | "ESheet" | "FanfoldLegalGerman" | "FanfoldStdGerman" | "FanfoldUS" | "Folio" | "Ledger" | "Note" | "Quarto" | "Statement" | "Tabloid" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC5" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeDL" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "Custom"; + range?: Word.Interfaces.RangeLoadOptions; + } + /** + * Contains a collection of {@link Word.CoauthoringUpdate} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface CoauthoringUpdateCollectionLoadOptions { /** - * Specifies the distance (in points) between the right edge of the page and the right boundary of the body text. + Specifying `$all` 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 a `Range` object that represents the portion of the document that's contained in the `CoauthoringUpdate` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rightMargin?: number; + range?: Word.Interfaces.RangeLoadOptions; + } + /** + * Represents a comment in the document. + * + * @remarks + * [Api set: WordApi 1.4] + */ + export interface CommentLoadOptions { /** - * Specifies the reading order and alignment for the specified sections. + Specifying `$all` 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 comment's content range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - sectionDirection?: Word.SectionDirection | "RightToLeft" | "LeftToRight"; + contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; /** - * Specifies the type of section break for the specified object. + * Gets the email of the comment's author. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - sectionStart?: Word.SectionStart | "Continuous" | "NewColumn" | "NewPage" | "EvenPage" | "OddPage"; + authorEmail?: boolean; /** - * Specifies whether to show the grid. + * Gets the name of the comment's author. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - showGrid?: boolean; + authorName?: boolean; /** - * Specifies if endnotes are printed at the end of the next section that doesn't suppress endnotes. + * Specifies the comment's content as plain text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - suppressEndnotes?: boolean; + content?: boolean; /** - * Specifies the top margin of the page in points. + * Gets the creation date of the comment. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - topMargin?: number; + creationDate?: boolean; /** - * Specifies whether to print two pages per sheet. + * Gets the ID of the comment. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - twoPagesOnOne?: boolean; + id?: boolean; /** - * Specifies the vertical alignment of text on each page in a document or section. + * Specifies the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - verticalAlignment?: Word.PageSetupVerticalAlignment | "Top" | "Center" | "Justify" | "Bottom"; + resolved?: boolean; } - /** An interface describing the data returned by calling `lineNumbering.toJSON()`. */ - export interface LineNumberingData { + /** + * Contains a collection of {@link Word.Comment} objects. + * + * @remarks + * [Api set: WordApi 1.4] + */ + export interface CommentCollectionLoadOptions { /** - * Specifies the numeric increment for line numbers. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ - countBy?: number; + $all?: boolean; /** - * Specifies the distance (in points) between the right edge of line numbers and the left edge of the document text. + * For EACH ITEM in the collection: Specifies the comment's content range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - distanceFromText?: number; + contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; /** - * Specifies if line numbering is active for the specified document, section, or sections. + * For EACH ITEM in the collection: Gets the email of the comment's author. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - isActive?: boolean; + authorEmail?: boolean; /** - * Specifies the way line numbering runs; that is, whether it starts over at the beginning of a new page or section, or runs continuously. + * For EACH ITEM in the collection: Gets the name of the comment's author. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - restartMode?: Word.NumberingRule | "RestartContinuous" | "RestartSection" | "RestartPage"; + authorName?: boolean; /** - * Specifies the starting line number. + * For EACH ITEM in the collection: Specifies the comment's content as plain text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - startingNumber?: number; - } - /** An interface describing the data returned by calling `textColumnCollection.toJSON()`. */ - export interface TextColumnCollectionData { - items?: Word.Interfaces.TextColumnData[]; - } - /** An interface describing the data returned by calling `textColumn.toJSON()`. */ - export interface TextColumnData { + content?: boolean; /** - * Specifies the amount of spacing (in points) after the specified paragraph or text column. + * For EACH ITEM in the collection: Gets the creation date of the comment. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - spaceAfter?: number; + creationDate?: boolean; /** - * Specifies the width, in points, of the specified text columns. + * For EACH ITEM in the collection: Gets the ID of the comment. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - width?: number; - } - /** An interface describing the data returned by calling `bookmark.toJSON()`. */ - export interface BookmarkData { + id?: boolean; /** - * Returns a `Range` object that represents the portion of the document that's contained in the `Bookmark` object. + * For EACH ITEM in the collection: Specifies the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - range?: Word.Interfaces.RangeData; + resolved?: boolean; + } + /** + * @remarks + * [Api set: WordApi 1.4] + */ + export interface CommentContentRangeLoadOptions { /** - * Specifies the ending character position of the bookmark. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ - end?: number; + $all?: boolean; /** - * Returns `true` if the bookmark is a table column. + * Specifies a value that indicates whether the comment text is bold. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - isColumn?: boolean; + bold?: boolean; /** - * Returns `true` if the bookmark is empty. + * Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - isEmpty?: boolean; + hyperlink?: boolean; /** - * Returns the name of the `Bookmark` object. + * Checks whether the range length is zero. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - name?: string; + isEmpty?: boolean; /** - * Specifies the starting character position of the bookmark. + * Specifies a value that indicates whether the comment text is italicized. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - start?: number; + italic?: boolean; /** - * Returns the story type for the bookmark. + * Specifies a value that indicates whether the comment text has a strikethrough. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - storyType?: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; - } - /** An interface describing the data returned by calling `bookmarkCollection.toJSON()`. */ - export interface BookmarkCollectionData { - items?: Word.Interfaces.BookmarkData[]; - } - /** An interface describing the data returned by calling `index.toJSON()`. */ - export interface IndexData { + strikeThrough?: boolean; /** - * Returns a `Range` object that represents the portion of the document that is contained within the index. + * Gets the text of the comment range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - range?: Word.Interfaces.RangeData; + text?: boolean; /** - * Gets a value that represents how Microsoft Word classifies the first character of entries in the index. - See `IndexFilter` for available values. + * Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - filter?: Word.IndexFilter | "None" | "Aiueo" | "Akasatana" | "Chosung" | "Low" | "Medium" | "Full"; + underline?: boolean; + } + /** + * Represents a comment reply in the document. + * + * @remarks + * [Api set: WordApi 1.4] + */ + export interface CommentReplyLoadOptions { /** - * Gets the text between alphabetical groups (entries that start with the same letter) in the index. Corresponds to - the **\h** switch for an {@link https://support.microsoft.com/office/adafcf4a-cb30-43f6-85c7-743da1635d9e | INDEX field}. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ - headingSeparator?: Word.HeadingSeparator | "None" | "BlankLine" | "Letter" | "LetterLow" | "LetterFull"; + $all?: boolean; /** - * Gets a `LanguageId` value that represents the sorting language to use for the index. + * Specifies the commentReply's content range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - indexLanguage?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; /** - * Gets the number of columns for each page of the index. + * Gets the parent comment of this reply. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - numberOfColumns?: number; + parentComment?: Word.Interfaces.CommentLoadOptions; /** - * Specifies if page numbers are aligned with the right margin in the index. + * Gets the email of the comment reply's author. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - rightAlignPageNumbers?: boolean; + authorEmail?: boolean; /** - * Gets if the index contains separate headings for accented letters (for example, words that begin with "À" are under - one heading and words that begin with "A" are under another). + * Gets the name of the comment reply's author. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - separateAccentedLetterHeadings?: boolean; + authorName?: boolean; /** - * Specifies the sorting criteria for the index. + * Specifies the comment reply's content. The string is plain text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - sortBy?: Word.IndexSortBy | "Stroke" | "Syllable"; + content?: boolean; /** - * Specifies the leader character between entries in the index and their associated page numbers. + * Gets the creation date of the comment reply. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + creationDate?: boolean; /** - * Gets the index type. + * Gets the ID of the comment reply. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - type?: Word.IndexType | "Indent" | "Runin"; - } - /** An interface describing the data returned by calling `indexCollection.toJSON()`. */ - export interface IndexCollectionData { - items?: Word.Interfaces.IndexData[]; + id?: boolean; } /** - * Represents an annotation wrapper around critique displayed in the document. + * Contains a collection of {@link Word.CommentReply} objects. Represents all comment replies in one comment thread. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi 1.4] */ - export interface CritiqueAnnotationLoadOptions { + export interface CommentReplyCollectionLoadOptions { /** Specifying `$all` 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 range of text that is annotated. + * For EACH ITEM in the collection: Specifies the commentReply's content range. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi 1.4] */ - range?: Word.Interfaces.RangeLoadOptions; + contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; /** - * Gets the critique that was passed when the annotation was inserted. + * For EACH ITEM in the collection: Gets the parent comment of this reply. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi 1.4] */ - critique?: boolean; - } - /** - * Represents an annotation attached to a paragraph. - * - * @remarks - * [Api set: WordApi 1.7] - */ - export interface AnnotationLoadOptions { + parentComment?: Word.Interfaces.CommentLoadOptions; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * For EACH ITEM in the collection: Gets the email of the comment reply's author. + * + * @remarks + * [Api set: WordApi 1.4] */ - $all?: boolean; + authorEmail?: boolean; /** - * Gets the critique annotation object. + * For EACH ITEM in the collection: Gets the name of the comment reply's author. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi 1.4] */ - critiqueAnnotation?: Word.Interfaces.CritiqueAnnotationLoadOptions; + authorName?: boolean; /** - * Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects. + * For EACH ITEM in the collection: Specifies the comment reply's content. The string is plain text. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi 1.4] */ - id?: boolean; + content?: boolean; /** - * Gets the state of the annotation. + * For EACH ITEM in the collection: Gets the creation date of the comment reply. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi 1.4] */ - state?: boolean; + creationDate?: boolean; + /** + * For EACH ITEM in the collection: Gets the ID of the comment reply. + * + * @remarks + * [Api set: WordApi 1.4] + */ + id?: boolean; } /** - * Contains a collection of {@link Word.Annotation} objects. + * Represents special formatting applied to specified areas of a table when the selected table is formatted with a specified table style. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - export interface AnnotationCollectionLoadOptions { + export interface ConditionalStyleLoadOptions { /** Specifying `$all` 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 critique annotation object. + * Returns a `Font` object that represents the font formatting for the conditional style. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - critiqueAnnotation?: Word.Interfaces.CritiqueAnnotationLoadOptions; + font?: Word.Interfaces.FontLoadOptions; /** - * For EACH ITEM in the collection: Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects. + * Returns a `ParagraphFormat` object that represents the paragraph formatting for the conditional style. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: boolean; + paragraphFormat?: Word.Interfaces.ParagraphFormatLoadOptions; /** - * For EACH ITEM in the collection: Gets the state of the annotation. + * Returns a `ShadingUniversal` object that represents the shading of the conditional style. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - state?: boolean; - } - /** - * Represents the application object. - * - * @remarks - * [Api set: WordApi 1.3] - */ - export interface ApplicationLoadOptions { + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * Specifies the amount of space (in points) to add below the contents of a single cell or all the cells in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + bottomPadding?: boolean; /** - * Returns a `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word. + * Specifies the amount of space (in points) to add to the left of the contents of a single cell or all the cells in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bibliography?: Word.Interfaces.BibliographyLoadOptions; + leftPadding?: boolean; /** - * Specifies if Microsoft Word automatically detects the language you are using as you type. + * Specifies the amount of space (in points) to add to the right of the contents of a single cell or all the cells in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - checkLanguage?: boolean; + rightPadding?: boolean; /** - * Gets a `LanguageId` value that represents the language selected for the Microsoft Word user interface. + * Specifies the amount of space (in points) to add above the contents of a single cell or all the cells in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - language?: boolean; + topPadding?: boolean; } /** - * Represents the body of a document or a section. + * Represents the XML mapping on a {@link Word.ContentControl} object between custom XML and that content control. An XML mapping is a link between the text in a content control and an XML element in the custom XML data store for this document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - export interface BodyLoadOptions { + export interface XmlMappingLoadOptions { /** Specifying `$all` 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 text format of the body. Use this to get and set font name, size, color and other properties. + * Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontLoadOptions; + customXmlNode?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Gets the parent body of the body. For example, a table cell body's parent body could be a header. Throws an `ItemNotFound` error if there isn't a parent body. + * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentBody?: Word.Interfaces.BodyLoadOptions; + customXmlPart?: Word.Interfaces.CustomXmlPartLoadOptions; /** - * Gets the parent body of the body. For example, a table cell body's parent body could be a header. If there isn't a parent body, then this method will return 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}. + * Returns whether the content control in the document is mapped to an XML node in the document's XML data store. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentBodyOrNullObject?: Word.Interfaces.BodyLoadOptions; + isMapped?: boolean; /** - * Gets the content control that contains the body. Throws an `ItemNotFound` error if there isn't a parent content control. + * Returns the prefix mappings used to evaluate the XPath for the current XML mapping. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; + prefixMappings?: boolean; /** - * Gets the content control that contains the body. If there isn't a parent content control, then this method will return 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}. + * Returns the XPath for the XML mapping, which evaluates to the currently mapped XML node. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + xpath?: boolean; + } + /** + * Represents a collection of {@link Word.CustomXmlPrefixMapping} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface CustomXmlPrefixMappingCollectionLoadOptions { /** - * Gets the parent section of the body. Throws an `ItemNotFound` error if there isn't a parent section. - * - * @remarks - * [Api set: WordApi 1.3] + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ - parentSection?: Word.Interfaces.SectionLoadOptions; + $all?: boolean; /** - * Gets the parent section of the body. If there isn't a parent section, then this method will return 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}. + * For EACH ITEM in the collection: Gets the unique address identifier for the namespace of the `CustomXmlPrefixMapping` object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentSectionOrNullObject?: Word.Interfaces.SectionLoadOptions; + namespaceUri?: boolean; /** - * Specifies the style name for the body. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * For EACH ITEM in the collection: Gets the prefix for the `CustomXmlPrefixMapping` object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: boolean; + prefix?: boolean; + } + /** + * Represents a `CustomXmlPrefixMapping` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface CustomXmlPrefixMappingLoadOptions { /** - * Specifies the built-in style name for the body. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. - * - * @remarks - * [Api set: WordApi 1.3] + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ - styleBuiltIn?: boolean; + $all?: boolean; /** - * Gets the text of the body. Use the insertText method to insert text. + * Gets the unique address identifier for the namespace of the `CustomXmlPrefixMapping` object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - text?: boolean; + namespaceUri?: boolean; /** - * Gets the type of the body. The type can be 'MainDoc', 'Section', 'Header', 'Footer', or 'TableCell'. Additional types ‘Footnote’, ‘Endnote’, and ‘NoteItem’ are supported in WordApiOnline 1.1 and later. + * Gets the prefix for the `CustomXmlPrefixMapping` object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: boolean; + prefix?: boolean; } /** - * Represents the Border object for text, a paragraph, or a table. + * Represents a schema in a {@link Word.CustomXmlSchemaCollection} object. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - export interface BorderLoadOptions { + export interface CustomXmlSchemaLoadOptions { /** Specifying `$all` 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 color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - color?: boolean; - /** - * Gets the location of the border. + * Gets the location of the schema on a computer. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ location?: boolean; /** - * Specifies the border type for the border. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - type?: boolean; - /** - * Specifies whether the border is visible. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - visible?: boolean; - /** - * Specifies the width for the border. + * Gets the unique address identifier for the namespace of the `CustomXmlSchema` object. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: boolean; + namespaceUri?: boolean; } /** - * Represents the `BorderUniversal` object, which manages borders for a range, paragraph, table, or frame. + * Represents a collection of {@link Word.CustomXmlSchema} objects attached to a data stream. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export interface BorderUniversalLoadOptions { + export interface CustomXmlSchemaCollectionLoadOptions { /** Specifying `$all` 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 graphical page-border design for the document. + * For EACH ITEM in the collection: Gets the location of the schema on a computer. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - artStyle?: boolean; + location?: boolean; /** - * Specifies the width (in points) of the graphical page border specified in the `artStyle` property. + * For EACH ITEM in the collection: Gets the unique address identifier for the namespace of the `CustomXmlSchema` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - artWidth?: boolean; + namespaceUri?: boolean; + } + /** + * Represents a collection of {@link Word.CustomXmlValidationError} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface CustomXmlValidationErrorCollectionLoadOptions { /** - * Specifies the color for the `BorderUniversal` object. You can provide the value in the '#RRGGBB' format. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ - color?: boolean; + $all?: boolean; /** - * Specifies the color for the `BorderUniversal` or {@link Word.Font} object. + * For EACH ITEM in the collection: Gets the node associated with this `CustomXmlValidationError` object, if any exist.If no nodes exist, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - colorIndex?: boolean; + node?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Returns `true` if an inside border can be applied to the specified object. + * For EACH ITEM in the collection: Gets an integer representing the validation error in the `CustomXmlValidationError` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - inside?: boolean; + errorCode?: boolean; /** - * Specifies whether the border is visible. + * For EACH ITEM in the collection: Gets the name of the error in the `CustomXmlValidationError` object.If no errors exist, the property returns `Nothing` * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + name?: boolean; /** - * Specifies the line style of the border. + * For EACH ITEM in the collection: Gets the text in the `CustomXmlValidationError` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lineStyle?: boolean; + text?: boolean; /** - * Specifies the line width of an object's border. + * For EACH ITEM in the collection: Gets the type of error generated from the `CustomXmlValidationError` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lineWidth?: boolean; + type?: boolean; } /** - * Represents the collection of border styles. + * Represents a single validation error in a {@link Word.CustomXmlValidationErrorCollection} object. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - export interface BorderCollectionLoadOptions { + export interface CustomXmlValidationErrorLoadOptions { /** Specifying `$all` 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 color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name. + * Gets the node associated with this `CustomXmlValidationError` object, if any exist.If no nodes exist, the property returns `Nothing`. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - color?: boolean; + node?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * For EACH ITEM in the collection: Gets the location of the border. + * Gets an integer representing the validation error in the `CustomXmlValidationError` object. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - location?: boolean; + errorCode?: boolean; /** - * For EACH ITEM in the collection: Specifies the border type for the border. + * Gets the name of the error in the `CustomXmlValidationError` object.If no errors exist, the property returns `Nothing` * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: boolean; + name?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the border is visible. + * Gets the text in the `CustomXmlValidationError` object. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - visible?: boolean; + text?: boolean; /** - * For EACH ITEM in the collection: Specifies the width for the border. + * Gets the type of error generated from the `CustomXmlValidationError` object. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: boolean; + type?: boolean; } /** - * Represents the collection of {@link Word.BorderUniversal} objects. + * Contains a collection of {@link Word.CustomXmlNode} objects representing the XML nodes in a document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export interface BorderUniversalCollectionLoadOptions { + export interface CustomXmlNodeCollectionLoadOptions { /** Specifying `$all` 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 graphical page-border design for the document. + * For EACH ITEM in the collection: Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - artStyle?: boolean; + firstChild?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * For EACH ITEM in the collection: Specifies the width (in points) of the graphical page border specified in the `artStyle` property. + * For EACH ITEM in the collection: Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - artWidth?: boolean; + lastChild?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * For EACH ITEM in the collection: Specifies the color for the `BorderUniversal` object. You can provide the value in the '#RRGGBB' format. + * For EACH ITEM in the collection: Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: boolean; + nextSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * For EACH ITEM in the collection: Specifies the color for the `BorderUniversal` or {@link Word.Font} object. + * For EACH ITEM in the collection: Gets the object representing the part associated with this node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - colorIndex?: boolean; + ownerPart?: Word.Interfaces.CustomXmlPartLoadOptions; /** - * For EACH ITEM in the collection: Returns `true` if an inside border can be applied to the specified object. + * For EACH ITEM in the collection: Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - inside?: boolean; + parentNode?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * For EACH ITEM in the collection: Specifies whether the border is visible. + * For EACH ITEM in the collection: Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + previousSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * For EACH ITEM in the collection: Specifies the line style of the border. + * For EACH ITEM in the collection: Gets the base name of the node without the namespace prefix, if one exists. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lineStyle?: boolean; + baseName?: boolean; /** - * For EACH ITEM in the collection: Specifies the line width of an object's border. + * For EACH ITEM in the collection: Gets the unique address identifier for the namespace of the node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lineWidth?: boolean; - } - /** - * Represents a break in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface BreakLoadOptions { + namespaceUri?: boolean; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * For EACH ITEM in the collection: Gets the type of the current node. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + nodeType?: boolean; /** - * Returns a `Range` object that represents the portion of the document that's contained in the break. + * For EACH ITEM in the collection: Specifies the value of the current node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeLoadOptions; + nodeValue?: boolean; /** - * Returns the page number on which the break occurs. + * For EACH ITEM in the collection: Specifies the text for the current node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageIndex?: boolean; + text?: boolean; + /** + * For EACH ITEM in the collection: Gets a string with the canonicalized XPath for the current node. If the node is no longer in the Document Object Model (DOM), the property returns an error message. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + xpath?: boolean; + /** + * For EACH ITEM in the collection: Gets the XML representation of the current node and its children. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + xml?: boolean; } /** - * Contains a collection of {@link Word.Break} objects. + * Represents an XML node in a tree in the document. The `CustomXmlNode` object is a member of the {@link Word.CustomXmlNodeCollection} object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export interface BreakCollectionLoadOptions { + export interface CustomXmlNodeLoadOptions { /** Specifying `$all` 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 a `Range` object that represents the portion of the document that's contained in the break. + * Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeLoadOptions; + firstChild?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * For EACH ITEM in the collection: Returns the page number on which the break occurs. + * Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageIndex?: boolean; - } - /** - * Represents a building block in a template. A building block is pre-built content, similar to autotext, that may contain text, images, and formatting. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface BuildingBlockLoadOptions { + lastChild?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + nextSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Returns a `BuildingBlockCategory` object that represents the category for the building block. + * Gets the object representing the part associated with this node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - category?: Word.Interfaces.BuildingBlockCategoryLoadOptions; + ownerPart?: Word.Interfaces.CustomXmlPartLoadOptions; /** - * Returns a `BuildingBlockTypeItem` object that represents the type for the building block. + * Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + parentNode?: Word.Interfaces.CustomXmlNodeLoadOptions; + /** + * Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + previousSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; + /** + * Gets the base name of the node without the namespace prefix, if one exists. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.Interfaces.BuildingBlockTypeItemLoadOptions; + baseName?: boolean; /** - * Specifies the description for the building block. + * Gets the unique address identifier for the namespace of the node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - description?: boolean; + namespaceUri?: boolean; /** - * Returns the internal identification number for the building block. + * Gets the type of the current node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: boolean; + nodeType?: boolean; /** - * Returns the position of this building block in a collection. + * Specifies the value of the current node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - index?: boolean; + nodeValue?: boolean; /** - * Specifies a `DocPartInsertType` value that represents how to insert the contents of the building block into the document. + * Specifies the text for the current node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - insertType?: boolean; + text?: boolean; /** - * Specifies the name of the building block. + * Gets a string with the canonicalized XPath for the current node. If the node is no longer in the Document Object Model (DOM), the property returns an error message. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: boolean; + xpath?: boolean; /** - * Specifies the contents of the building block. + * Gets the XML representation of the current node and its children. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - value?: boolean; + xml?: boolean; } /** - * Represents a category of building blocks in a Word document. + * Represents a content control. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text, plain text, checkbox, dropdown list, and combo box content controls are supported. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - export interface BuildingBlockCategoryLoadOptions { + export interface ContentControlLoadOptions { /** Specifying `$all` 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 `BuildingBlockTypeItem` object that represents the type of building block for the building block category. + * Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `BuildingBlockGallery`. It's `null` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.Interfaces.BuildingBlockTypeItemLoadOptions; + buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlLoadOptions; /** - * Returns the position of the `BuildingBlockCategory` object in a collection. + * Gets the data of the content control when its type is `CheckBox`. It's `null` otherwise. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - index?: boolean; + checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions; /** - * Returns the name of the `BuildingBlockCategory` object. + * Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `DatePicker`. It's `null` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: boolean; - } - /** - * Represents a type of building block in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface BuildingBlockTypeItemLoadOptions { - /** - Specifying `$all` 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; + datePickerContentControl?: Word.Interfaces.DatePickerContentControlLoadOptions; /** - * Returns the position of an item in a collection. + * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - index?: boolean; + font?: Word.Interfaces.FontLoadOptions; /** - * Returns the localized name of a building block type. + * Gets the group-related data if the content control's {@link Word.ContentControlType} is `Group`. It's `null` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: boolean; - } - /** - * The data specific to content controls of type CheckBox. - * - * @remarks - * [Api set: WordApi 1.7] - */ - export interface CheckboxContentControlLoadOptions { - /** - Specifying `$all` 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; + groupContentControl?: Word.Interfaces.GroupContentControlLoadOptions; /** - * Specifies the current state of the checkbox. + * Gets the parent body of the content control. * * @remarks - * [Api set: WordApi 1.7] - */ - isChecked?: boolean; - } - /** - * Represents a comment in the document. - * - * @remarks - * [Api set: WordApi 1.4] - */ - export interface CommentLoadOptions { - /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * [Api set: WordApi 1.3] */ - $all?: boolean; + parentBody?: Word.Interfaces.BodyLoadOptions; /** - * Specifies the comment's content range. + * Gets the content control that contains the content control. Throws an `ItemNotFound` error if there isn't a parent content control. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the email of the comment's author. + * Gets the content control that contains the content control. If there isn't a parent content control, then this method will return 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: WordApi 1.4] + * [Api set: WordApi 1.3] */ - authorEmail?: boolean; + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the name of the comment's author. + * Gets the table that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - authorName?: boolean; + parentTable?: Word.Interfaces.TableLoadOptions; /** - * Specifies the comment's content as plain text. + * Gets the table cell that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table cell. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - content?: boolean; + parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * Gets the creation date of the comment. + * Gets the table cell that contains the content control. If it isn't contained in a table cell, then this method will return 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: WordApi 1.4] + * [Api set: WordApi 1.3] */ - creationDate?: boolean; + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * Gets the ID of the comment. + * Gets the table that contains the content control. If it isn't contained in a table, then this method will return 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: WordApi 1.4] + * [Api set: WordApi 1.3] */ - id?: boolean; + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * Specifies the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved. + * Gets the picture-related data if the content control's {@link Word.ContentControlType} is `Picture`. It's `null` otherwise. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - resolved?: boolean; - } - /** - * Contains a collection of {@link Word.Comment} objects. - * - * @remarks - * [Api set: WordApi 1.4] - */ - export interface CommentCollectionLoadOptions { + pictureContentControl?: Word.Interfaces.PictureContentControlLoadOptions; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `RepeatingSection`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlLoadOptions; /** - * For EACH ITEM in the collection: Specifies the comment's content range. + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; + xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; /** - * For EACH ITEM in the collection: Gets the email of the comment's author. + * Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - authorEmail?: boolean; + appearance?: boolean; /** - * For EACH ITEM in the collection: Gets the name of the comment's author. + * Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - authorName?: boolean; + cannotDelete?: boolean; /** - * For EACH ITEM in the collection: Specifies the comment's content as plain text. + * Specifies a value that indicates whether the user can edit the contents of the content control. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - content?: boolean; + cannotEdit?: boolean; /** - * For EACH ITEM in the collection: Gets the creation date of the comment. + * Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - creationDate?: boolean; + color?: boolean; /** - * For EACH ITEM in the collection: Gets the ID of the comment. + * Gets an integer that represents the content control identifier. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ id?: boolean; /** - * For EACH ITEM in the collection: Specifies the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved. + * Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - resolved?: boolean; - } - /** - * @remarks - * [Api set: WordApi 1.4] - */ - export interface CommentContentRangeLoadOptions { + placeholderText?: boolean; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. + * + * @remarks + * [Api set: WordApi 1.1] */ - $all?: boolean; + removeWhenEdited?: boolean; /** - * Specifies a value that indicates whether the comment text is bold. + * Specifies the style name for the content control. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - bold?: boolean; + style?: boolean; /** - * Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. + * Specifies the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - hyperlink?: boolean; + styleBuiltIn?: boolean; /** - * Checks whether the range length is zero. + * Gets the content control subtype. The subtype can be 'RichTextInline', 'RichTextParagraphs', 'RichTextTableCell', 'RichTextTableRow' and 'RichTextTable' for rich text content controls, or 'PlainTextInline' and 'PlainTextParagraph' for plain text content controls, or 'CheckBox' for checkbox content controls. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - isEmpty?: boolean; + subtype?: boolean; /** - * Specifies a value that indicates whether the comment text is italicized. + * Specifies a tag to identify a content control. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - italic?: boolean; + tag?: boolean; /** - * Specifies a value that indicates whether the comment text has a strikethrough. + * Gets the text of the content control. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - strikeThrough?: boolean; + text?: boolean; /** - * Gets the text of the comment range. + * Specifies the title for a content control. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - text?: boolean; + title?: boolean; /** - * Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined. + * Gets the content control type. Only rich text, plain text, and checkbox content controls are supported currently. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - underline?: boolean; + type?: boolean; } /** - * Represents a comment reply in the document. + * Contains a collection of {@link Word.ContentControl} objects. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text, plain text, checkbox, dropdown list, and combo box content controls are supported. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - export interface CommentReplyLoadOptions { + export interface ContentControlCollectionLoadOptions { /** Specifying `$all` 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 commentReply's content range. + * For EACH ITEM in the collection: Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `BuildingBlockGallery`. It's `null` otherwise. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; + buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlLoadOptions; /** - * Gets the parent comment of this reply. + * For EACH ITEM in the collection: Gets the data of the content control when its type is `CheckBox`. It's `null` otherwise. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.7] */ - parentComment?: Word.Interfaces.CommentLoadOptions; + checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions; /** - * Gets the email of the comment reply's author. + * For EACH ITEM in the collection: Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `DatePicker`. It's `null` otherwise. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - authorEmail?: boolean; + datePickerContentControl?: Word.Interfaces.DatePickerContentControlLoadOptions; /** - * Gets the name of the comment reply's author. + * For EACH ITEM in the collection: Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - authorName?: boolean; + font?: Word.Interfaces.FontLoadOptions; /** - * Specifies the comment reply's content. The string is plain text. + * For EACH ITEM in the collection: Gets the group-related data if the content control's {@link Word.ContentControlType} is `Group`. It's `null` otherwise. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - content?: boolean; + groupContentControl?: Word.Interfaces.GroupContentControlLoadOptions; /** - * Gets the creation date of the comment reply. + * For EACH ITEM in the collection: Gets the parent body of the content control. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - creationDate?: boolean; + parentBody?: Word.Interfaces.BodyLoadOptions; /** - * Gets the ID of the comment reply. + * For EACH ITEM in the collection: Gets the content control that contains the content control. Throws an `ItemNotFound` error if there isn't a parent content control. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - id?: boolean; - } - /** - * Contains a collection of {@link Word.CommentReply} objects. Represents all comment replies in one comment thread. - * - * @remarks - * [Api set: WordApi 1.4] - */ - export interface CommentReplyCollectionLoadOptions { + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * For EACH ITEM in the collection: Gets the content control that contains the content control. If there isn't a parent content control, then this method will return 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: WordApi 1.3] */ - $all?: boolean; + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Specifies the commentReply's content range. + * For EACH ITEM in the collection: Gets the table that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; + parentTable?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Gets the parent comment of this reply. + * For EACH ITEM in the collection: Gets the table cell that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table cell. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - parentComment?: Word.Interfaces.CommentLoadOptions; + parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the email of the comment reply's author. + * For EACH ITEM in the collection: Gets the table cell that contains the content control. If it isn't contained in a table cell, then this method will return 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: WordApi 1.4] + * [Api set: WordApi 1.3] */ - authorEmail?: boolean; + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the name of the comment reply's author. + * For EACH ITEM in the collection: Gets the table that contains the content control. If it isn't contained in a table, then this method will return 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: WordApi 1.4] + * [Api set: WordApi 1.3] */ - authorName?: boolean; + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Specifies the comment reply's content. The string is plain text. + * For EACH ITEM in the collection: Gets the picture-related data if the content control's {@link Word.ContentControlType} is `Picture`. It's `null` otherwise. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - content?: boolean; + pictureContentControl?: Word.Interfaces.PictureContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the creation date of the comment reply. + * For EACH ITEM in the collection: Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `RepeatingSection`. It's `null` otherwise. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - creationDate?: boolean; + repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the ID of the comment reply. + * For EACH ITEM in the collection: Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; + /** + * For EACH ITEM in the collection: Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. + * + * @remarks + * [Api set: WordApi 1.1] + */ + appearance?: boolean; + /** + * For EACH ITEM in the collection: Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited. + * + * @remarks + * [Api set: WordApi 1.1] + */ + cannotDelete?: boolean; + /** + * For EACH ITEM in the collection: Specifies a value that indicates whether the user can edit the contents of the content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ + cannotEdit?: boolean; + /** + * For EACH ITEM in the collection: Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. + * + * @remarks + * [Api set: WordApi 1.1] + */ + color?: boolean; + /** + * For EACH ITEM in the collection: Gets an integer that represents the content control identifier. + * + * @remarks + * [Api set: WordApi 1.1] */ id?: boolean; - } - /** - * Represents the XML mapping on a {@link Word.ContentControl} object between custom XML and that content control. An XML mapping is a link between the text in a content control and an XML element in the custom XML data store for this document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface XmlMappingLoadOptions { /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * For EACH ITEM in the collection: Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. + * + * @remarks + * [Api set: WordApi 1.1] */ - $all?: boolean; + placeholderText?: boolean; /** - * Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to. + * For EACH ITEM in the collection: Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - customXmlNode?: Word.Interfaces.CustomXmlNodeLoadOptions; + removeWhenEdited?: boolean; /** - * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. + * For EACH ITEM in the collection: Specifies the style name for the content control. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - customXmlPart?: Word.Interfaces.CustomXmlPartLoadOptions; + style?: boolean; /** - * Returns whether the content control in the document is mapped to an XML node in the document's XML data store. + * For EACH ITEM in the collection: Specifies the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isMapped?: boolean; + styleBuiltIn?: boolean; /** - * Returns the prefix mappings used to evaluate the XPath for the current XML mapping. + * For EACH ITEM in the collection: Gets the content control subtype. The subtype can be 'RichTextInline', 'RichTextParagraphs', 'RichTextTableCell', 'RichTextTableRow' and 'RichTextTable' for rich text content controls, or 'PlainTextInline' and 'PlainTextParagraph' for plain text content controls, or 'CheckBox' for checkbox content controls. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - prefixMappings?: boolean; + subtype?: boolean; /** - * Returns the XPath for the XML mapping, which evaluates to the currently mapped XML node. + * For EACH ITEM in the collection: Specifies a tag to identify a content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - xpath?: boolean; - } - /** - * Represents a collection of {@link Word.CustomXmlPrefixMapping} objects. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface CustomXmlPrefixMappingCollectionLoadOptions { + tag?: boolean; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * For EACH ITEM in the collection: Gets the text of the content control. + * + * @remarks + * [Api set: WordApi 1.1] */ - $all?: boolean; + text?: boolean; /** - * For EACH ITEM in the collection: Gets the unique address identifier for the namespace of the `CustomXmlPrefixMapping` object. + * For EACH ITEM in the collection: Specifies the title for a content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - namespaceUri?: boolean; + title?: boolean; /** - * For EACH ITEM in the collection: Gets the prefix for the `CustomXmlPrefixMapping` object. + * For EACH ITEM in the collection: Gets the content control type. Only rich text, plain text, and checkbox content controls are supported currently. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - prefix?: boolean; + type?: boolean; } /** - * Represents a `CustomXmlPrefixMapping` object. + * Represents a list item in a dropdown list or combo box content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - export interface CustomXmlPrefixMappingLoadOptions { + export interface ContentControlListItemLoadOptions { /** Specifying `$all` 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 address identifier for the namespace of the `CustomXmlPrefixMapping` object. + * Specifies the display text of a list item for a dropdown list or combo box content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - namespaceUri?: boolean; + displayText?: boolean; /** - * Gets the prefix for the `CustomXmlPrefixMapping` object. + * Specifies the index location of a content control list item in the collection of list items. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - prefix?: boolean; + index?: boolean; + /** + * Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + value?: boolean; } /** - * Represents a schema in a {@link Word.CustomXmlSchemaCollection} object. + * Contains a collection of {@link Word.ContentControlListItem} objects that represent the items in a dropdown list or combo box content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - export interface CustomXmlSchemaLoadOptions { + export interface ContentControlListItemCollectionLoadOptions { /** Specifying `$all` 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 location of the schema on a computer. + * For EACH ITEM in the collection: Specifies the display text of a list item for a dropdown list or combo box content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - location?: boolean; + displayText?: boolean; /** - * Gets the unique address identifier for the namespace of the `CustomXmlSchema` object. + * For EACH ITEM in the collection: Specifies the index location of a content control list item in the collection of list items. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - namespaceUri?: boolean; + index?: boolean; + /** + * For EACH ITEM in the collection: Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + value?: boolean; } /** - * Represents a collection of {@link Word.CustomXmlSchema} objects attached to a data stream. + * Represents a custom property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - export interface CustomXmlSchemaCollectionLoadOptions { + 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; /** - * For EACH ITEM in the collection: Gets the location of the schema on a computer. + * Gets the key of the custom property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - location?: boolean; + key?: boolean; /** - * For EACH ITEM in the collection: Gets the unique address identifier for the namespace of the `CustomXmlSchema` object. + * Gets the value type of the custom property. Possible values are: String, Number, Date, Boolean. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - namespaceUri?: boolean; + type?: boolean; + /** + * Specifies the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). + * + * @remarks + * [Api set: WordApi 1.3] + */ + value?: boolean; } /** - * Represents a collection of {@link Word.CustomXmlValidationError} objects. + * Contains the collection of {@link Word.CustomProperty} objects. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - export interface CustomXmlValidationErrorCollectionLoadOptions { + 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: Gets the node associated with this `CustomXmlValidationError` object, if any exist.If no nodes exist, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - node?: Word.Interfaces.CustomXmlNodeLoadOptions; - /** - * For EACH ITEM in the collection: Gets an integer representing the validation error in the `CustomXmlValidationError` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - errorCode?: boolean; - /** - * For EACH ITEM in the collection: Gets the name of the error in the `CustomXmlValidationError` object.If no errors exist, the property returns `Nothing` + * For EACH ITEM in the collection: Gets the key of the custom property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - name?: boolean; + key?: boolean; /** - * For EACH ITEM in the collection: Gets the text in the `CustomXmlValidationError` object. + * For EACH ITEM in the collection: Gets the value type of the custom property. Possible values are: String, Number, Date, Boolean. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - text?: boolean; + type?: boolean; /** - * For EACH ITEM in the collection: Gets the type of error generated from the `CustomXmlValidationError` object. + * For EACH ITEM in the collection: Specifies the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - type?: boolean; + value?: boolean; } /** - * Represents a single validation error in a {@link Word.CustomXmlValidationErrorCollection} object. + * Represents a custom XML part. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - export interface CustomXmlValidationErrorLoadOptions { + 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; /** - * Gets the node associated with this `CustomXmlValidationError` object, if any exist.If no nodes exist, the property returns `Nothing`. + * Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - node?: Word.Interfaces.CustomXmlNodeLoadOptions; + documentElement?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Gets an integer representing the validation error in the `CustomXmlValidationError` object. + * Gets a value that indicates whether the `CustomXmlPart` is built-in. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - errorCode?: boolean; + builtIn?: boolean; /** - * Gets the name of the error in the `CustomXmlValidationError` object.If no errors exist, the property returns `Nothing` + * Gets the ID of the custom XML part. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - name?: boolean; + id?: boolean; /** - * Gets the text in the `CustomXmlValidationError` object. + * Gets the namespace URI of the custom XML part. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - text?: boolean; + namespaceUri?: boolean; /** - * Gets the type of error generated from the `CustomXmlValidationError` object. + * Gets the XML representation of the current `CustomXmlPart` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: boolean; + xml?: boolean; } /** - * Contains a collection of {@link Word.CustomXmlNode} objects representing the XML nodes in a document. + * Contains the collection of {@link Word.CustomXmlPart} objects. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - export interface CustomXmlNodeCollectionLoadOptions { + 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: Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - firstChild?: Word.Interfaces.CustomXmlNodeLoadOptions; - /** - * For EACH ITEM in the collection: Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - lastChild?: Word.Interfaces.CustomXmlNodeLoadOptions; - /** - * For EACH ITEM in the collection: Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. + * For EACH ITEM in the collection: Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nextSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; + documentElement?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * For EACH ITEM in the collection: Gets the object representing the part associated with this node. + * For EACH ITEM in the collection: Gets a value that indicates whether the `CustomXmlPart` is built-in. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - ownerPart?: Word.Interfaces.CustomXmlPartLoadOptions; + builtIn?: boolean; /** - * For EACH ITEM in the collection: Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. + * For EACH ITEM in the collection: Gets the ID of the custom XML part. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - parentNode?: Word.Interfaces.CustomXmlNodeLoadOptions; + id?: boolean; /** - * For EACH ITEM in the collection: Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. + * For EACH ITEM in the collection: Gets the namespace URI of the custom XML part. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - previousSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; + namespaceUri?: boolean; /** - * For EACH ITEM in the collection: Gets the base name of the node without the namespace prefix, if one exists. + * For EACH ITEM in the collection: Gets the XML representation of the current `CustomXmlPart` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - baseName?: boolean; + xml?: boolean; + } + /** + * Contains the collection of {@link Word.CustomXmlPart} objects with a specific namespace. + * + * @remarks + * [Api set: WordApi 1.4] + */ + export interface CustomXmlPartScopedCollectionLoadOptions { /** - * For EACH ITEM in the collection: Gets the unique address identifier for the namespace of the node. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ - namespaceUri?: boolean; + $all?: boolean; /** - * For EACH ITEM in the collection: Gets the type of the current node. + * For EACH ITEM in the collection: Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nodeType?: boolean; + documentElement?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * For EACH ITEM in the collection: Specifies the value of the current node. + * For EACH ITEM in the collection: Gets a value that indicates whether the `CustomXmlPart` is built-in. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nodeValue?: boolean; + builtIn?: boolean; /** - * For EACH ITEM in the collection: Specifies the text for the current node. + * For EACH ITEM in the collection: Gets the ID of the custom XML part. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - text?: boolean; + id?: boolean; /** - * For EACH ITEM in the collection: Gets a string with the canonicalized XPath for the current node. If the node is no longer in the Document Object Model (DOM), the property returns an error message. + * For EACH ITEM in the collection: Gets the namespace URI of the custom XML part. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - xpath?: boolean; + namespaceUri?: boolean; /** - * For EACH ITEM in the collection: Gets the XML representation of the current node and its children. + * For EACH ITEM in the collection: Gets the XML representation of the current `CustomXmlPart` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -52115,4164 +62633,4220 @@ export declare namespace Word { xml?: boolean; } /** - * Represents an XML node in a tree in the document. The `CustomXmlNode` object is a member of the {@link Word.CustomXmlNodeCollection} object. + * The Document object is the top level object. A Document object contains one or more sections, content controls, and the body that contains the contents of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - export interface CustomXmlNodeLoadOptions { + export interface DocumentLoadOptions { /** Specifying `$all` 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 a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. + * Gets the active window for the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - firstChild?: Word.Interfaces.CustomXmlNodeLoadOptions; + activeWindow?: Word.Interfaces.WindowLoadOptions; /** - * Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. + * Specifies a `Template` object that represents the template attached to the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lastChild?: Word.Interfaces.CustomXmlNodeLoadOptions; + attachedTemplate?: Word.Interfaces.TemplateLoadOptions; /** - * Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. + * Returns a `Bibliography` object that represents the bibliography references contained within the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nextSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; + bibliography?: Word.Interfaces.BibliographyLoadOptions; /** - * Gets the object representing the part associated with this node. + * Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - ownerPart?: Word.Interfaces.CustomXmlPartLoadOptions; - /** - * Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - parentNode?: Word.Interfaces.CustomXmlNodeLoadOptions; - /** - * Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - previousSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; + body?: Word.Interfaces.BodyLoadOptions; /** - * Gets the base name of the node without the namespace prefix, if one exists. + * Gets a `Coauthoring` object for managing coauthoring in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - baseName?: boolean; + coauthoring?: Word.Interfaces.CoauthoringLoadOptions; /** - * Gets the unique address identifier for the namespace of the node. + * Returns a `PageSetup` object that's associated with the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - namespaceUri?: boolean; + pageSetup?: Word.Interfaces.PageSetupLoadOptions; /** - * Gets the type of the current node. + * Gets the properties of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - nodeType?: boolean; + properties?: Word.Interfaces.DocumentPropertiesLoadOptions; /** - * Specifies the value of the current node. + * Returns a `Selection` object that represents the current selection in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nodeValue?: boolean; + selection?: Word.Interfaces.SelectionLoadOptions; /** - * Specifies the text for the current node. + * Specifies if automatic hyphenation is turned on for the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - text?: boolean; + autoHyphenation?: boolean; /** - * Gets a string with the canonicalized XPath for the current node. If the node is no longer in the Document Object Model (DOM), the property returns an error message. + * Specifies if the edits in the document are automatically saved. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xpath?: boolean; + autoSaveOn?: boolean; /** - * Gets the XML representation of the current node and its children. + * Specifies the ChangeTracking mode. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - xml?: boolean; - } - /** - * Represents a content control. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text, plain text, checkbox, dropdown list, and combo box content controls are supported. - * - * @remarks - * [Api set: WordApi 1.1] - */ - export interface ContentControlLoadOptions { - /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * [Api set: WordApi 1.4] */ - $all?: boolean; + changeTrackingMode?: boolean; /** - * Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `BuildingBlockGallery`. It's `null` otherwise. + * Specifies the maximum number of consecutive lines that can end with hyphens. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlLoadOptions; + consecutiveHyphensLimit?: boolean; /** - * Gets the data of the content control when its type is `CheckBox`. It's `null` otherwise. + * Specifies whether words in all capital letters can be hyphenated. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions; + hyphenateCaps?: boolean; /** - * Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `DatePicker`. It's `null` otherwise. + * Specifies whether Microsoft Word has detected the language of the document text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - datePickerContentControl?: Word.Interfaces.DatePickerContentControlLoadOptions; + languageDetected?: boolean; /** - * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. + * Indicates whether the changes in the document have been saved. A value of true indicates that the document hasn't changed since it was saved. * * @remarks * [Api set: WordApi 1.1] */ - font?: Word.Interfaces.FontLoadOptions; + saved?: boolean; + } + /** + * The DocumentCreated object is the top level object created by Application.CreateDocument. A DocumentCreated object is a special Document object. + * + * @remarks + * [Api set: WordApi 1.3] + */ + export interface DocumentCreatedLoadOptions { /** - * Gets the group-related data if the content control's {@link Word.ContentControlType} is `Group`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ - groupContentControl?: Word.Interfaces.GroupContentControlLoadOptions; + $all?: boolean; /** - * Gets the parent body of the content control. + * Gets the body object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiHiddenDocument 1.3] */ - parentBody?: Word.Interfaces.BodyLoadOptions; + body?: Word.Interfaces.BodyLoadOptions; /** - * Gets the content control that contains the content control. Throws an `ItemNotFound` error if there isn't a parent content control. + * Gets the properties of the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiHiddenDocument 1.3] */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; + properties?: Word.Interfaces.DocumentPropertiesLoadOptions; /** - * Gets the content control that contains the content control. If there isn't a parent content control, then this method will return 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}. + * Indicates whether the changes in the document have been saved. A value of true indicates that the document hasn't changed since it was saved. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiHiddenDocument 1.3] */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + saved?: boolean; + } + /** + * Represents document properties. + * + * @remarks + * [Api set: WordApi 1.3] + */ + export interface DocumentPropertiesLoadOptions { /** - * Gets the table that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table. - * - * @remarks - * [Api set: WordApi 1.3] + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ - parentTable?: Word.Interfaces.TableLoadOptions; + $all?: boolean; /** - * Gets the table cell that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * Gets the application name of the document. * * @remarks * [Api set: WordApi 1.3] */ - parentTableCell?: Word.Interfaces.TableCellLoadOptions; + applicationName?: boolean; /** - * Gets the table cell that contains the content control. If it isn't contained in a table cell, then this method will return 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 author of the document. * * @remarks * [Api set: WordApi 1.3] */ - parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + author?: boolean; /** - * Gets the table that contains the content control. If it isn't contained in a table, then this method will return 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 category of the document. * * @remarks * [Api set: WordApi 1.3] */ - parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + category?: boolean; /** - * Gets the picture-related data if the content control's {@link Word.ContentControlType} is `Picture`. It's `null` otherwise. + * Specifies the Comments field in the metadata of the document. These have no connection to comments by users made in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - pictureContentControl?: Word.Interfaces.PictureContentControlLoadOptions; + comments?: boolean; /** - * Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `RepeatingSection`. It's `null` otherwise. + * Specifies the company of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlLoadOptions; + company?: boolean; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Gets the creation date of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; + creationDate?: boolean; /** - * Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. + * Specifies the format of the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - appearance?: boolean; + format?: boolean; /** - * Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited. + * Specifies the keywords of the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - cannotDelete?: boolean; + keywords?: boolean; /** - * Specifies a value that indicates whether the user can edit the contents of the content control. + * Gets the last author of the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - cannotEdit?: boolean; + lastAuthor?: boolean; /** - * Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. + * Gets the last print date of the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - color?: boolean; + lastPrintDate?: boolean; /** - * Gets an integer that represents the content control identifier. + * Gets the last save time of the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - id?: boolean; + lastSaveTime?: boolean; /** - * Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. + * Specifies the manager of the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - placeholderText?: boolean; + manager?: boolean; /** - * Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. + * Gets the revision number of the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - removeWhenEdited?: boolean; + revisionNumber?: boolean; /** - * Specifies the style name for the content control. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * Gets security settings of the document. Some are access restrictions on the file on disk. Others are Document Protection settings. Some possible values are 0 = File on disk is read/write; 1 = Protect Document: File is encrypted and requires a password to open; 2 = Protect Document: Always Open as Read-Only; 3 = Protect Document: Both #1 and #2; 4 = File on disk is read-only; 5 = Both #1 and #4; 6 = Both #2 and #4; 7 = All of #1, #2, and #4; 8 = Protect Document: Restrict Edit to read-only; 9 = Both #1 and #8; 10 = Both #2 and #8; 11 = All of #1, #2, and #8; 12 = Both #4 and #8; 13 = All of #1, #4, and #8; 14 = All of #2, #4, and #8; 15 = All of #1, #2, #4, and #8. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - style?: boolean; + security?: boolean; /** - * Specifies the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Specifies the subject of the document. * * @remarks * [Api set: WordApi 1.3] */ - styleBuiltIn?: boolean; + subject?: boolean; /** - * Gets the content control subtype. The subtype can be 'RichTextInline', 'RichTextParagraphs', 'RichTextTableCell', 'RichTextTableRow' and 'RichTextTable' for rich text content controls, or 'PlainTextInline' and 'PlainTextParagraph' for plain text content controls, or 'CheckBox' for checkbox content controls. + * Gets the template of the document. * * @remarks * [Api set: WordApi 1.3] */ - subtype?: boolean; + template?: boolean; /** - * Specifies a tag to identify a content control. + * Specifies the title of the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - tag?: boolean; + title?: boolean; + } + /** + * Represents a field. + * + * @remarks + * [Api set: WordApi 1.4] + * + * Important: To learn more about which fields can be inserted, see the `Word.Range.insertField` API introduced in requirement set 1.5. + * Support for managing fields is similar to what's available in the Word UI. However, the Word UI on the web primarily only supports fields as read-only (see {@link https://support.microsoft.com/office/d8f46094-13c3-4966-98c3-259748f3caf1 | Field codes in Word for the web}). + * To learn more about Word UI clients that more fully support fields, see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}. + */ + export interface FieldLoadOptions { /** - * Gets the text of the content control. - * - * @remarks - * [Api set: WordApi 1.1] + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ - text?: boolean; + $all?: boolean; /** - * Specifies the title for a content control. + * Gets a `LinkFormat` object that represents the link options of the field. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - title?: boolean; + linkFormat?: Word.Interfaces.LinkFormatLoadOptions; /** - * Gets the content control type. Only rich text, plain text, and checkbox content controls are supported currently. + * Gets an `OleFormat` object that represents the OLE characteristics (other than linking) for the field. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: boolean; - } - /** - * Contains a collection of {@link Word.ContentControl} objects. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text, plain text, checkbox, dropdown list, and combo box content controls are supported. - * - * @remarks - * [Api set: WordApi 1.1] - */ - export interface ContentControlCollectionLoadOptions { + oleFormat?: Word.Interfaces.OleFormatLoadOptions; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * Gets the parent body of the field. + * + * @remarks + * [Api set: WordApi 1.4] */ - $all?: boolean; + parentBody?: Word.Interfaces.BodyLoadOptions; /** - * For EACH ITEM in the collection: Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `BuildingBlockGallery`. It's `null` otherwise. + * Gets the content control that contains the field. Throws an `ItemNotFound` error if there isn't a parent content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlLoadOptions; + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the data of the content control when its type is `CheckBox`. It's `null` otherwise. + * Gets the content control that contains the field. If there isn't a parent content control, then this method will return 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: WordApi 1.7] + * [Api set: WordApi 1.4] */ - checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions; + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `DatePicker`. It's `null` otherwise. + * Gets the table that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - datePickerContentControl?: Word.Interfaces.DatePickerContentControlLoadOptions; + parentTable?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. + * Gets the table cell that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table cell. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.4] */ - font?: Word.Interfaces.FontLoadOptions; + parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the group-related data if the content control's {@link Word.ContentControlType} is `Group`. It's `null` otherwise. + * Gets the table cell that contains the field. If it isn't contained in a table cell, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - groupContentControl?: Word.Interfaces.GroupContentControlLoadOptions; + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the parent body of the content control. + * Gets the table that contains the field. If it isn't contained in a table, then this method will return 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: WordApi 1.3] + * [Api set: WordApi 1.4] */ - parentBody?: Word.Interfaces.BodyLoadOptions; + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Gets the content control that contains the content control. Throws an `ItemNotFound` error if there isn't a parent content control. + * Gets the field's result data. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.4] */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; + result?: Word.Interfaces.RangeLoadOptions; /** - * For EACH ITEM in the collection: Gets the content control that contains the content control. If there isn't a parent content control, then this method will return 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 field's code instruction. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] + * + * Note: The ability to set the code was introduced in WordApi 1.5. */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + code?: boolean; /** - * For EACH ITEM in the collection: Gets the table that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table. + * Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is `null` and it will throw a general exception when code attempts to set it. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - parentTable?: Word.Interfaces.TableLoadOptions; + data?: boolean; /** - * For EACH ITEM in the collection: Gets the table cell that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * Gets the field's kind. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - parentTableCell?: Word.Interfaces.TableCellLoadOptions; + kind?: boolean; /** - * For EACH ITEM in the collection: Gets the table cell that contains the content control. If it isn't contained in a table cell, then this method will return 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 whether the field is locked. `true` if the field is locked, `false` otherwise. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + locked?: boolean; /** - * For EACH ITEM in the collection: Gets the table that contains the content control. If it isn't contained in a table, then this method will return 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 whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + showCodes?: boolean; /** - * For EACH ITEM in the collection: Gets the picture-related data if the content control's {@link Word.ContentControlType} is `Picture`. It's `null` otherwise. + * Gets the field's type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - pictureContentControl?: Word.Interfaces.PictureContentControlLoadOptions; + type?: boolean; + } + /** + * Contains a collection of {@link Word.Field} objects. + * + * @remarks + * [Api set: WordApi 1.4] + * + * Important: To learn more about which fields can be inserted, see the `Word.Range.insertField` API introduced in requirement set 1.5. + * Support for managing fields is similar to what's available in the Word UI. However, the Word UI on the web primarily only supports fields as read-only (see {@link https://support.microsoft.com/office/d8f46094-13c3-4966-98c3-259748f3caf1 | Field codes in Word for the web}). + * To learn more about Word UI clients that more fully support fields, see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}. + */ + export interface FieldCollectionLoadOptions { /** - * For EACH ITEM in the collection: Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `RepeatingSection`. It's `null` otherwise. + Specifying `$all` 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 a `LinkFormat` object that represents the link options of the field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlLoadOptions; + linkFormat?: Word.Interfaces.LinkFormatLoadOptions; /** - * For EACH ITEM in the collection: Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * For EACH ITEM in the collection: Gets an `OleFormat` object that represents the OLE characteristics (other than linking) for the field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; + oleFormat?: Word.Interfaces.OleFormatLoadOptions; /** - * For EACH ITEM in the collection: Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. + * For EACH ITEM in the collection: Gets the parent body of the field. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.4] */ - appearance?: boolean; + parentBody?: Word.Interfaces.BodyLoadOptions; /** - * For EACH ITEM in the collection: Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited. + * For EACH ITEM in the collection: Gets the content control that contains the field. Throws an `ItemNotFound` error if there isn't a parent content control. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.4] */ - cannotDelete?: boolean; + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Specifies a value that indicates whether the user can edit the contents of the content control. + * For EACH ITEM in the collection: Gets the content control that contains the field. If there isn't a parent content control, then this method will return 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: WordApi 1.1] + * [Api set: WordApi 1.4] */ - cannotEdit?: boolean; + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. + * For EACH ITEM in the collection: Gets the table that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.4] */ - color?: boolean; + parentTable?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Gets an integer that represents the content control identifier. + * For EACH ITEM in the collection: Gets the table cell that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table cell. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.4] */ - id?: boolean; + parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. + * For EACH ITEM in the collection: Gets the table cell that contains the field. If it isn't contained in a table cell, then this method will return 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: WordApi 1.1] + * [Api set: WordApi 1.4] */ - placeholderText?: boolean; + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. + * For EACH ITEM in the collection: Gets the table that contains the field. If it isn't contained in a table, then this method will return 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: WordApi 1.1] + * [Api set: WordApi 1.4] */ - removeWhenEdited?: boolean; + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Specifies the style name for the content control. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * For EACH ITEM in the collection: Gets the field's result data. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.4] */ - style?: boolean; + result?: Word.Interfaces.RangeLoadOptions; /** - * For EACH ITEM in the collection: Specifies the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * For EACH ITEM in the collection: Specifies the field's code instruction. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] + * + * Note: The ability to set the code was introduced in WordApi 1.5. */ - styleBuiltIn?: boolean; + code?: boolean; /** - * For EACH ITEM in the collection: Gets the content control subtype. The subtype can be 'RichTextInline', 'RichTextParagraphs', 'RichTextTableCell', 'RichTextTableRow' and 'RichTextTable' for rich text content controls, or 'PlainTextInline' and 'PlainTextParagraph' for plain text content controls, or 'CheckBox' for checkbox content controls. + * For EACH ITEM in the collection: Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is `null` and it will throw a general exception when code attempts to set it. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - subtype?: boolean; + data?: boolean; /** - * For EACH ITEM in the collection: Specifies a tag to identify a content control. + * For EACH ITEM in the collection: Gets the field's kind. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - tag?: boolean; + kind?: boolean; /** - * For EACH ITEM in the collection: Gets the text of the content control. + * For EACH ITEM in the collection: Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - text?: boolean; + locked?: boolean; /** - * For EACH ITEM in the collection: Specifies the title for a content control. + * For EACH ITEM in the collection: Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - title?: boolean; + showCodes?: boolean; /** - * For EACH ITEM in the collection: Gets the content control type. Only rich text, plain text, and checkbox content controls are supported currently. + * For EACH ITEM in the collection: Gets the field's type. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ type?: boolean; } /** - * Represents a list item in a dropdown list or combo box content control. + * Represents a font. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi 1.1] */ - export interface ContentControlListItemLoadOptions { + export interface FontLoadOptions { /** Specifying `$all` 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 display text of a list item for a dropdown list or combo box content control. + * Returns a `FillFormat` object that contains fill formatting properties for the font used by the range of text. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - displayText?: boolean; + fill?: Word.Interfaces.FillFormatLoadOptions; /** - * Specifies the index location of a content control list item in the collection of list items. + * Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - index?: boolean; + glow?: Word.Interfaces.GlowFormatLoadOptions; /** - * Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * Returns a `LineFormat` object that specifies the formatting for a line. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - value?: boolean; - } - /** - * Contains a collection of {@link Word.ContentControlListItem} objects that represent the items in a dropdown list or combo box content control. - * - * @remarks - * [Api set: WordApi 1.9] - */ - export interface ContentControlListItemCollectionLoadOptions { + line?: Word.Interfaces.LineFormatLoadOptions; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + reflection?: Word.Interfaces.ReflectionFormatLoadOptions; /** - * For EACH ITEM in the collection: Specifies the display text of a list item for a dropdown list or combo box content control. + * Returns a `ColorFormat` object that represents the color for the font. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - displayText?: boolean; + textColor?: Word.Interfaces.ColorFormatLoadOptions; /** - * For EACH ITEM in the collection: Specifies the index location of a content control list item in the collection of list items. + * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - index?: boolean; + textShadow?: Word.Interfaces.ShadowFormatLoadOptions; /** - * For EACH ITEM in the collection: Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - value?: boolean; - } - /** - * Represents a custom property. - * - * @remarks - * [Api set: WordApi 1.3] - */ - export interface CustomPropertyLoadOptions { + threeDimensionalFormat?: Word.Interfaces.ThreeDimensionalFormatLoadOptions; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * Specifies whether the font is formatted as all capital letters, 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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + allCaps?: boolean; /** - * Gets the key of the custom property. + * Specifies a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - key?: boolean; + bold?: boolean; /** - * Gets the value type of the custom property. Possible values are: String, Number, Date, Boolean. + * Specifies whether the font is formatted as bold in a right-to-left language document. 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: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: boolean; + boldBidirectional?: boolean; /** - * Specifies the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). + * Specifies the color for the specified font. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - value?: boolean; - } - /** - * Contains the collection of {@link Word.CustomProperty} objects. - * - * @remarks - * [Api set: WordApi 1.3] - */ - export interface CustomPropertyCollectionLoadOptions { + color?: boolean; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * Specifies a `ColorIndex` value that represents the color for the font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + colorIndex?: boolean; /** - * For EACH ITEM in the collection: Gets the key of the custom property. + * Specifies the color for the `Font` object in a right-to-left language document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - key?: boolean; + colorIndexBidirectional?: boolean; /** - * For EACH ITEM in the collection: Gets the value type of the custom property. Possible values are: String, Number, Date, Boolean. + * Specifies whether contextual alternates are enabled for the font. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: boolean; + contextualAlternates?: boolean; /** - * For EACH ITEM in the collection: Specifies the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). + * Specifies the color to be used for diacritics for the `Font` object. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - value?: boolean; - } - /** - * Represents a custom XML part. - * - * @remarks - * [Api set: WordApi 1.4] - */ - export interface CustomXmlPartLoadOptions { + diacriticColor?: boolean; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * Specifies whether Microsoft Word ignores the number of characters per line for the corresponding `Font` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + disableCharacterSpaceGrid?: boolean; /** - * Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. + * Specifies a value that indicates whether the font has a double strikethrough. True if the font is formatted as double strikethrough text, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + doubleStrikeThrough?: boolean; + /** + * Specifies whether the font is formatted as embossed. The possible values are as follows: + + - `true`: All the text is embossed. + + - `false`: None of the text is embossed. + + - `null`: Returned if some, but not all, of the text is embossed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - documentElement?: Word.Interfaces.CustomXmlNodeLoadOptions; + emboss?: boolean; /** - * Gets a value that indicates whether the `CustomXmlPart` is built-in. + * Specifies an `EmphasisMark` value that represents the emphasis mark for a character or designated character string. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - builtIn?: boolean; + emphasisMark?: boolean; /** - * Gets the ID of the custom XML part. + * Specifies whether the font is formatted as engraved. The possible values are as follows: + + - `true`: All the text is engraved. + + - `false`: None of the text is engraved. + + - `null`: Returned if some, but not all, of the text is engraved. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: boolean; + engrave?: boolean; /** - * Gets the namespace URI of the custom XML part. + * Specifies a value that indicates whether the font is tagged as hidden. True if the font is formatted as hidden text, otherwise, false. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.2] */ - namespaceUri?: boolean; + hidden?: boolean; /** - * Gets the XML representation of the current `CustomXmlPart` object. + * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or `null` for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - xml?: boolean; - } - /** - * Contains the collection of {@link Word.CustomXmlPart} objects. - * - * @remarks - * [Api set: WordApi 1.4] - */ - export interface CustomXmlPartCollectionLoadOptions { + highlightColor?: boolean; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * Specifies a value that indicates whether the font is italicized. True if the font is italicized, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] */ - $all?: boolean; + italic?: boolean; /** - * For EACH ITEM in the collection: Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. + * Specifies whether the font is italicized in a right-to-left language document. 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - documentElement?: Word.Interfaces.CustomXmlNodeLoadOptions; + italicBidirectional?: boolean; /** - * For EACH ITEM in the collection: Gets a value that indicates whether the `CustomXmlPart` is built-in. + * Specifies the minimum font size for which Microsoft Word will adjust kerning automatically. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - builtIn?: boolean; + kerning?: boolean; /** - * For EACH ITEM in the collection: Gets the ID of the custom XML part. + * Specifies the ligature setting for the `Font` object. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: boolean; + ligature?: boolean; /** - * For EACH ITEM in the collection: Gets the namespace URI of the custom XML part. + * Specifies a value that represents the name of the font. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - namespaceUri?: boolean; + name?: boolean; /** - * For EACH ITEM in the collection: Gets the XML representation of the current `CustomXmlPart` object. + * Specifies the font used for Latin text (characters with character codes from 0 (zero) through 127). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xml?: boolean; - } - /** - * Contains the collection of {@link Word.CustomXmlPart} objects with a specific namespace. - * - * @remarks - * [Api set: WordApi 1.4] - */ - 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; + nameAscii?: boolean; /** - * For EACH ITEM in the collection: Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. + * Specifies the font name in a right-to-left language document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - documentElement?: Word.Interfaces.CustomXmlNodeLoadOptions; + nameBidirectional?: boolean; /** - * For EACH ITEM in the collection: Gets a value that indicates whether the `CustomXmlPart` is built-in. + * Specifies the East Asian font name. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - builtIn?: boolean; + nameFarEast?: boolean; /** - * For EACH ITEM in the collection: Gets the ID of the custom XML part. + * Specifies the font used for characters with codes from 128 through 255. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: boolean; + nameOther?: boolean; /** - * For EACH ITEM in the collection: Gets the namespace URI of the custom XML part. + * Specifies the number form setting for an OpenType font. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - namespaceUri?: boolean; + numberForm?: boolean; /** - * For EACH ITEM in the collection: Gets the XML representation of the current `CustomXmlPart` object. + * Specifies the number spacing setting for the font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xml?: boolean; - } - /** - * The Document object is the top level object. A Document object contains one or more sections, content controls, and the body that contains the contents of the document. - * - * @remarks - * [Api set: WordApi 1.1] - */ - export interface DocumentLoadOptions { + numberSpacing?: boolean; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * Specifies if the font is formatted as outlined. The possible values are as follows: + + - `true`: All the text is outlined. + + - `false`: None of the text is outlined. + + - `null`: Returned if some, but not all, of the text is outlined. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + outline?: boolean; /** - * Gets the active window for the document. + * Specifies the position of text (in points) relative to the base line. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - activeWindow?: Word.Interfaces.WindowLoadOptions; + position?: boolean; /** - * Specifies a `Template` object that represents the template attached to the document. + * Specifies the scaling percentage applied to the font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - attachedTemplate?: Word.Interfaces.TemplateLoadOptions; + scaling?: boolean; /** - * Returns a `Bibliography` object that represents the bibliography references contained within the document. + * Specifies if the font is formatted as shadowed. The possible values are as follows: + + - `true`: All the text is shadowed. + + - `false`: None of the text is shadowed. + + - `null`: Returned if some, but not all, of the text is shadowed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bibliography?: Word.Interfaces.BibliographyLoadOptions; + shadow?: boolean; /** - * Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * Specifies a value that represents the font size in points. * * @remarks * [Api set: WordApi 1.1] */ - body?: Word.Interfaces.BodyLoadOptions; + size?: boolean; /** - * Returns a `PageSetup` object that's associated with the document. + * Specifies the font size in points for right-to-left text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageSetup?: Word.Interfaces.PageSetupLoadOptions; + sizeBidirectional?: boolean; /** - * Gets the properties of the document. + * Specifies whether the font is formatted as small caps, 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: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - properties?: Word.Interfaces.DocumentPropertiesLoadOptions; + smallCaps?: boolean; /** - * Specifies if automatic hyphenation is turned on for the document. + * Specifies the spacing between characters. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - autoHyphenation?: boolean; + spacing?: boolean; /** - * Specifies if the edits in the document are automatically saved. + * Specifies a value that indicates whether the font has a strikethrough. True if the font is formatted as strikethrough text, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + strikeThrough?: boolean; + /** + * Specifies the stylistic set for the font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - autoSaveOn?: boolean; + stylisticSet?: boolean; /** - * Specifies the ChangeTracking mode. + * Specifies a value that indicates whether the font is a subscript. True if the font is formatted as subscript, otherwise, false. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - changeTrackingMode?: boolean; + subscript?: boolean; /** - * Specifies the maximum number of consecutive lines that can end with hyphens. + * Specifies a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - consecutiveHyphensLimit?: boolean; + superscript?: boolean; /** - * Specifies whether words in all capital letters can be hyphenated. + * Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined. + * + * @remarks + * [Api set: WordApi 1.1] + */ + underline?: boolean; + /** + * Specifies the color of the underline for the `Font` object. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hyphenateCaps?: boolean; + underlineColor?: boolean; + } + /** + * Represents a heading style used in a table of contents or table of figures. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface HeadingStyleLoadOptions { /** - * Specifies whether Microsoft Word has detected the language of the document text. + Specifying `$all` 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 level for the heading style in a table of contents or table of figures. Must be a value from 1 to 9. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageDetected?: boolean; + level?: boolean; /** - * Indicates whether the changes in the document have been saved. A value of true indicates that the document hasn't changed since it was saved. + * Specifies the name of style for a heading. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - saved?: boolean; + name?: boolean; } /** - * The DocumentCreated object is the top level object created by Application.CreateDocument. A DocumentCreated object is a special Document object. + * Represents a collection of {@link Word.HeadingStyle} objects in a Word document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - export interface DocumentCreatedLoadOptions { + export interface HeadingStyleCollectionLoadOptions { /** Specifying `$all` 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 body object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.3] - */ - body?: Word.Interfaces.BodyLoadOptions; - /** - * Gets the properties of the document. + * For EACH ITEM in the collection: Specifies the level for the heading style in a table of contents or table of figures. Must be a value from 1 to 9. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - properties?: Word.Interfaces.DocumentPropertiesLoadOptions; + level?: boolean; /** - * Indicates whether the changes in the document have been saved. A value of true indicates that the document hasn't changed since it was saved. + * For EACH ITEM in the collection: Specifies the name of style for a heading. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - saved?: boolean; + name?: boolean; } /** - * Represents document properties. + * Represents a hyperlink in a Word document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - export interface DocumentPropertiesLoadOptions { + 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; /** - * Gets the application name of the document. + * Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - applicationName?: boolean; + range?: Word.Interfaces.RangeLoadOptions; /** - * Specifies the author of the document. + * Specifies the address (for example, a file name or URL) of the hyperlink. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - author?: boolean; + address?: boolean; /** - * Specifies the category of the document. + * Specifies the text string for the hyperlink's subject line. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - category?: boolean; + emailSubject?: boolean; /** - * Specifies the Comments field in the metadata of the document. These have no connection to comments by users made in the document. + * Returns `true` if extra information is required to resolve the hyperlink. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - comments?: boolean; + isExtraInfoRequired?: boolean; /** - * Specifies the company of the document. + * Returns the name of the `Hyperlink` object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - company?: boolean; + name?: boolean; /** - * Gets the creation date of the document. + * Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - creationDate?: boolean; + screenTip?: boolean; /** - * Specifies the format of the document. + * Specifies a named location in the destination of the hyperlink. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - format?: boolean; + subAddress?: boolean; /** - * Specifies the keywords of the document. + * Specifies the name of the frame or window in which to load the hyperlink. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - keywords?: boolean; + target?: boolean; /** - * Gets the last author of the document. + * Specifies the hyperlink's visible text in the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lastAuthor?: boolean; + textToDisplay?: boolean; /** - * Gets the last print date of the document. + * Returns the hyperlink type. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lastPrintDate?: boolean; + type?: boolean; + } + /** + * Contains a collection of {@link Word.Hyperlink} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface HyperlinkCollectionLoadOptions { /** - * Gets the last save time of the document. + Specifying `$all` 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 a `Range` object that represents the portion of the document that's contained within the hyperlink. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lastSaveTime?: boolean; + range?: Word.Interfaces.RangeLoadOptions; /** - * Specifies the manager of the document. + * For EACH ITEM in the collection: Specifies the address (for example, a file name or URL) of the hyperlink. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - manager?: boolean; + address?: boolean; /** - * Gets the revision number of the document. + * For EACH ITEM in the collection: Specifies the text string for the hyperlink's subject line. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - revisionNumber?: boolean; + emailSubject?: boolean; /** - * Gets security settings of the document. Some are access restrictions on the file on disk. Others are Document Protection settings. Some possible values are 0 = File on disk is read/write; 1 = Protect Document: File is encrypted and requires a password to open; 2 = Protect Document: Always Open as Read-Only; 3 = Protect Document: Both #1 and #2; 4 = File on disk is read-only; 5 = Both #1 and #4; 6 = Both #2 and #4; 7 = All of #1, #2, and #4; 8 = Protect Document: Restrict Edit to read-only; 9 = Both #1 and #8; 10 = Both #2 and #8; 11 = All of #1, #2, and #8; 12 = Both #4 and #8; 13 = All of #1, #4, and #8; 14 = All of #2, #4, and #8; 15 = All of #1, #2, #4, and #8. + * For EACH ITEM in the collection: Returns `true` if extra information is required to resolve the hyperlink. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - security?: boolean; + isExtraInfoRequired?: boolean; /** - * Specifies the subject of the document. + * For EACH ITEM in the collection: Returns the name of the `Hyperlink` object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - subject?: boolean; + name?: boolean; /** - * Gets the template of the document. + * For EACH ITEM in the collection: Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - template?: boolean; + screenTip?: boolean; /** - * Specifies the title of the document. + * For EACH ITEM in the collection: Specifies a named location in the destination of the hyperlink. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - title?: boolean; - } - /** - * Represents a field. - * - * @remarks - * [Api set: WordApi 1.4] - * - * Important: To learn more about which fields can be inserted, see the `Word.Range.insertField` API introduced in requirement set 1.5. - * Support for managing fields is similar to what's available in the Word UI. However, the Word UI on the web primarily only supports fields as read-only (see {@link https://support.microsoft.com/office/d8f46094-13c3-4966-98c3-259748f3caf1 | Field codes in Word for the web}). - * To learn more about Word UI clients that more fully support fields, see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}. - */ - export interface FieldLoadOptions { + subAddress?: boolean; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * For EACH ITEM in the collection: Specifies the name of the frame or window in which to load the hyperlink. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + target?: boolean; /** - * Gets a `LinkFormat` object that represents the link options of the field. + * For EACH ITEM in the collection: Specifies the hyperlink's visible text in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - linkFormat?: Word.Interfaces.LinkFormatLoadOptions; + textToDisplay?: boolean; /** - * Gets an `OleFormat` object that represents the OLE characteristics (other than linking) for the field. + * For EACH ITEM in the collection: Returns the hyperlink type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - oleFormat?: Word.Interfaces.OleFormatLoadOptions; + type?: boolean; + } + /** + * Represents an inline picture. + * + * @remarks + * [Api set: WordApi 1.1] + */ + export interface InlinePictureLoadOptions { /** - * Gets the parent body of the field. + Specifying `$all` 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 parent paragraph that contains the inline image. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.2] */ - parentBody?: Word.Interfaces.BodyLoadOptions; + paragraph?: Word.Interfaces.ParagraphLoadOptions; /** - * Gets the content control that contains the field. Throws an `ItemNotFound` error if there isn't a parent content control. + * Gets the content control that contains the inline image. Throws an `ItemNotFound` error if there isn't a parent content control. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the content control that contains the field. If there isn't a parent content control, then this method will return 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}. + * Gets the content control that contains the inline image. If there isn't a parent content control, then this method will return 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: WordApi 1.4] + * [Api set: WordApi 1.3] */ parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the table that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table. + * Gets the table that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ parentTable?: Word.Interfaces.TableLoadOptions; /** - * Gets the table cell that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * Gets the table cell that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table cell. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * Gets the table cell that contains the field. If it isn't contained in a table cell, then this method will return 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}. + * Gets the table cell that contains the inline image. If it isn't contained in a table cell, then this method will return 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: WordApi 1.4] + * [Api set: WordApi 1.3] */ parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * Gets the table that contains the field. If it isn't contained in a table, then this method will return 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}. + * Gets the table that contains the inline image. If it isn't contained in a table, then this method will return 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: WordApi 1.4] + * [Api set: WordApi 1.3] */ parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * Gets the field's result data. + * Specifies a string that represents the alternative text associated with the inline image. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - result?: Word.Interfaces.RangeLoadOptions; + altTextDescription?: boolean; /** - * Specifies the field's code instruction. + * Specifies a string that contains the title for the inline image. * * @remarks - * [Api set: WordApi 1.4] - * - * Note: The ability to set the code was introduced in WordApi 1.5. + * [Api set: WordApi 1.1] */ - code?: boolean; + altTextTitle?: boolean; /** - * Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is `null` and it will throw a general exception when code attempts to set it. + * Specifies a number that describes the height of the inline image. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - data?: boolean; + height?: boolean; /** - * Gets the field's kind. + * Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - kind?: boolean; + hyperlink?: boolean; /** - * Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. + * Gets the format of the inline image. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - locked?: boolean; + imageFormat?: boolean; /** - * Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise. + * Specifies a value that indicates whether the inline image retains its original proportions when you resize it. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.1] */ - showCodes?: boolean; + lockAspectRatio?: boolean; /** - * Gets the field's type. + * Specifies a number that describes the width of the inline image. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - type?: boolean; + width?: boolean; } /** - * Contains a collection of {@link Word.Field} objects. + * Contains a collection of {@link Word.InlinePicture} objects. * * @remarks - * [Api set: WordApi 1.4] - * - * Important: To learn more about which fields can be inserted, see the `Word.Range.insertField` API introduced in requirement set 1.5. - * Support for managing fields is similar to what's available in the Word UI. However, the Word UI on the web primarily only supports fields as read-only (see {@link https://support.microsoft.com/office/d8f46094-13c3-4966-98c3-259748f3caf1 | Field codes in Word for the web}). - * To learn more about Word UI clients that more fully support fields, see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}. + * [Api set: WordApi 1.1] */ - export interface FieldCollectionLoadOptions { + export interface InlinePictureCollectionLoadOptions { /** Specifying `$all` 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 a `LinkFormat` object that represents the link options of the field. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - linkFormat?: Word.Interfaces.LinkFormatLoadOptions; - /** - * For EACH ITEM in the collection: Gets an `OleFormat` object that represents the OLE characteristics (other than linking) for the field. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - oleFormat?: Word.Interfaces.OleFormatLoadOptions; - /** - * For EACH ITEM in the collection: Gets the parent body of the field. + * For EACH ITEM in the collection: Gets the parent paragraph that contains the inline image. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.2] */ - parentBody?: Word.Interfaces.BodyLoadOptions; + paragraph?: Word.Interfaces.ParagraphLoadOptions; /** - * For EACH ITEM in the collection: Gets the content control that contains the field. Throws an `ItemNotFound` error if there isn't a parent content control. + * For EACH ITEM in the collection: Gets the content control that contains the inline image. Throws an `ItemNotFound` error if there isn't a parent content control. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the content control that contains the field. If there isn't a parent content control, then this method will return 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}. + * For EACH ITEM in the collection: Gets the content control that contains the inline image. If there isn't a parent content control, then this method will return 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: WordApi 1.4] + * [Api set: WordApi 1.3] */ parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the table that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table. + * For EACH ITEM in the collection: Gets the table that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ parentTable?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Gets the table cell that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * For EACH ITEM in the collection: Gets the table cell that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table cell. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the table cell that contains the field. If it isn't contained in a table cell, then this method will return 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}. + * For EACH ITEM in the collection: Gets the table cell that contains the inline image. If it isn't contained in a table cell, then this method will return 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: WordApi 1.4] + * [Api set: WordApi 1.3] */ parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the table that contains the field. If it isn't contained in a table, then this method will return 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}. + * For EACH ITEM in the collection: Gets the table that contains the inline image. If it isn't contained in a table, then this method will return 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: WordApi 1.4] + * [Api set: WordApi 1.3] */ parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Gets the field's result data. + * For EACH ITEM in the collection: Specifies a string that represents the alternative text associated with the inline image. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - result?: Word.Interfaces.RangeLoadOptions; + altTextDescription?: boolean; /** - * For EACH ITEM in the collection: Specifies the field's code instruction. + * For EACH ITEM in the collection: Specifies a string that contains the title for the inline image. * * @remarks - * [Api set: WordApi 1.4] - * - * Note: The ability to set the code was introduced in WordApi 1.5. + * [Api set: WordApi 1.1] */ - code?: boolean; + altTextTitle?: boolean; /** - * For EACH ITEM in the collection: Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is `null` and it will throw a general exception when code attempts to set it. + * For EACH ITEM in the collection: Specifies a number that describes the height of the inline image. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - data?: boolean; + height?: boolean; /** - * For EACH ITEM in the collection: Gets the field's kind. + * For EACH ITEM in the collection: Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - kind?: boolean; + hyperlink?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. + * For EACH ITEM in the collection: Gets the format of the inline image. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - locked?: boolean; + imageFormat?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise. + * For EACH ITEM in the collection: Specifies a value that indicates whether the inline image retains its original proportions when you resize it. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.1] */ - showCodes?: boolean; + lockAspectRatio?: boolean; /** - * For EACH ITEM in the collection: Gets the field's type. + * For EACH ITEM in the collection: Specifies a number that describes the width of the inline image. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - type?: boolean; + width?: boolean; } /** - * Represents a font. + * Represents the linking characteristics for an OLE object or picture. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - export interface FontLoadOptions { + export interface LinkFormatLoadOptions { /** Specifying `$all` 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 `FillFormat` object that contains fill formatting properties for the font used by the range of text. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - fill?: Word.Interfaces.FillFormatLoadOptions; - /** - * Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text. + * Specifies if the link is updated automatically when the container file is opened or when the source file is changed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - glow?: Word.Interfaces.GlowFormatLoadOptions; + isAutoUpdated?: boolean; /** - * Returns a `LineFormat` object that specifies the formatting for a line. + * Specifies if a `Field`, `InlineShape`, or `Shape` object is locked to prevent automatic updating. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - line?: Word.Interfaces.LineFormatLoadOptions; + isLocked?: boolean; /** - * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. + * Specifies if the linked picture is saved with the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - reflection?: Word.Interfaces.ReflectionFormatLoadOptions; + isPictureSavedWithDocument?: boolean; /** - * Returns a `ColorFormat` object that represents the color for the font. + * Specifies the path and name of the source file for the linked OLE object, picture, or field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textColor?: Word.Interfaces.ColorFormatLoadOptions; + sourceFullName?: boolean; /** - * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. + * Gets the name of the source file for the linked OLE object, picture, or field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textShadow?: Word.Interfaces.ShadowFormatLoadOptions; + sourceName?: boolean; /** - * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font. + * Gets the path of the source file for the linked OLE object, picture, or field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - threeDimensionalFormat?: Word.Interfaces.ThreeDimensionalFormatLoadOptions; + sourcePath?: boolean; /** - * Specifies whether the font is formatted as all capital letters, 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. + * Gets the link type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - allCaps?: boolean; + type?: boolean; + } + /** + * Contains a collection of {@link Word.Paragraph} objects. + * + * @remarks + * [Api set: WordApi 1.3] + */ + export interface ListLoadOptions { /** - * Specifies a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false. + Specifying `$all` 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 list's id. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - bold?: boolean; + id?: boolean; /** - * Specifies whether the font is formatted as bold in a right-to-left language document. 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. + * Checks whether each of the 9 levels exists in the list. A true value indicates the level exists, which means there is at least one list item at that level. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - boldBidirectional?: boolean; + levelExistences?: boolean; /** - * Specifies the color for the specified font. You can provide the value in the '#RRGGBB' format or the color name. + * Gets all 9 level types in the list. Each type can be 'Bullet', 'Number', or 'Picture'. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - color?: boolean; + levelTypes?: boolean; + } + /** + * Contains a collection of {@link Word.List} objects. + * + * @remarks + * [Api set: WordApi 1.3] + */ + export interface ListCollectionLoadOptions { /** - * Specifies a `ColorIndex` value that represents the color for the font. + Specifying `$all` 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 list's id. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - colorIndex?: boolean; + id?: boolean; /** - * Specifies the color for the `Font` object in a right-to-left language document. + * For EACH ITEM in the collection: Checks whether each of the 9 levels exists in the list. A true value indicates the level exists, which means there is at least one list item at that level. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - colorIndexBidirectional?: boolean; + levelExistences?: boolean; /** - * Specifies whether contextual alternates are enabled for the font. + * For EACH ITEM in the collection: Gets all 9 level types in the list. Each type can be 'Bullet', 'Number', or 'Picture'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - contextualAlternates?: boolean; + levelTypes?: boolean; + } + /** + * Represents the paragraph list item format. + * + * @remarks + * [Api set: WordApi 1.3] + */ + export interface ListItemLoadOptions { /** - * Specifies the color to be used for diacritics for the `Font` object. You can provide the value in the '#RRGGBB' format. + Specifying `$all` 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 level of the item in the list. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - diacriticColor?: boolean; + level?: boolean; /** - * Specifies whether Microsoft Word ignores the number of characters per line for the corresponding `Font` object. + * Gets the list item bullet, number, or picture as a string. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - disableCharacterSpaceGrid?: boolean; + listString?: boolean; /** - * Specifies a value that indicates whether the font has a double strikethrough. True if the font is formatted as double strikethrough text, otherwise, false. + * Gets the list item order number in relation to its siblings. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - doubleStrikeThrough?: boolean; + siblingIndex?: boolean; + } + /** + * Represents a list level. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + export interface ListLevelLoadOptions { /** - * Specifies whether the font is formatted as embossed. The possible values are as follows: - - - `true`: All the text is embossed. - - - `false`: None of the text is embossed. - - - `null`: Returned if some, but not all, of the text is embossed. + Specifying `$all` 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 a Font object that represents the character formatting of the specified object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - emboss?: boolean; + font?: Word.Interfaces.FontLoadOptions; /** - * Specifies an `EmphasisMark` value that represents the emphasis mark for a character or designated character string. + * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - emphasisMark?: boolean; + alignment?: boolean; /** - * Specifies whether the font is formatted as engraved. The possible values are as follows: - - - `true`: All the text is engraved. - - - `false`: None of the text is engraved. - - - `null`: Returned if some, but not all, of the text is engraved. + * Specifies the name of the style that's linked to the specified list level object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - engrave?: boolean; + linkedStyle?: boolean; /** - * Specifies a value that indicates whether the font is tagged as hidden. True if the font is formatted as hidden text, otherwise, false. + * Specifies the number format for the specified list level. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - hidden?: boolean; + numberFormat?: boolean; /** - * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or `null` for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. + * Specifies the position (in points) of the number or bullet for the specified list level object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - highlightColor?: boolean; + numberPosition?: boolean; /** - * Specifies a value that indicates whether the font is italicized. True if the font is italicized, otherwise, false. + * Specifies the number style for the list level object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - italic?: boolean; + numberStyle?: boolean; /** - * Specifies whether the font is italicized in a right-to-left language document. 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. + * Specifies the list level that must appear before the specified list level restarts numbering at 1. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - italicBidirectional?: boolean; + resetOnHigher?: boolean; /** - * Specifies the minimum font size for which Microsoft Word will adjust kerning automatically. + * Specifies the starting number for the specified list level object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - kerning?: boolean; + startAt?: boolean; /** - * Specifies the ligature setting for the `Font` object. + * Specifies the tab position for the specified list level object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - ligature?: boolean; + tabPosition?: boolean; /** - * Specifies a value that represents the name of the font. + * Specifies the position (in points) for the second line of wrapping text for the specified list level object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - name?: boolean; + textPosition?: boolean; /** - * Specifies the font used for Latin text (characters with character codes from 0 (zero) through 127). + * Specifies the character inserted after the number for the specified list level. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - nameAscii?: boolean; + trailingCharacter?: boolean; + } + /** + * Contains a collection of {@link Word.ListLevel} objects. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + export interface ListLevelCollectionLoadOptions { /** - * Specifies the font name in a right-to-left language document. + Specifying `$all` 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 a Font object that represents the character formatting of the specified object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - nameBidirectional?: boolean; + font?: Word.Interfaces.FontLoadOptions; /** - * Specifies the East Asian font name. + * For EACH ITEM in the collection: Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - nameFarEast?: boolean; + alignment?: boolean; /** - * Specifies the font used for characters with codes from 128 through 255. + * For EACH ITEM in the collection: Specifies the name of the style that's linked to the specified list level object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - nameOther?: boolean; + linkedStyle?: boolean; /** - * Specifies the number form setting for an OpenType font. + * For EACH ITEM in the collection: Specifies the number format for the specified list level. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - numberForm?: boolean; + numberFormat?: boolean; /** - * Specifies the number spacing setting for the font. + * For EACH ITEM in the collection: Specifies the position (in points) of the number or bullet for the specified list level object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - numberSpacing?: boolean; + numberPosition?: boolean; /** - * Specifies if the font is formatted as outlined. The possible values are as follows: - - - `true`: All the text is outlined. - - - `false`: None of the text is outlined. - - - `null`: Returned if some, but not all, of the text is outlined. + * For EACH ITEM in the collection: Specifies the number style for the list level object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - outline?: boolean; + numberStyle?: boolean; /** - * Specifies the position of text (in points) relative to the base line. + * For EACH ITEM in the collection: Specifies the list level that must appear before the specified list level restarts numbering at 1. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - position?: boolean; + resetOnHigher?: boolean; /** - * Specifies the scaling percentage applied to the font. + * For EACH ITEM in the collection: Specifies the starting number for the specified list level object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - scaling?: boolean; + startAt?: boolean; /** - * Specifies if the font is formatted as shadowed. The possible values are as follows: - - - `true`: All the text is shadowed. - - - `false`: None of the text is shadowed. - - - `null`: Returned if some, but not all, of the text is shadowed. + * For EACH ITEM in the collection: Specifies the tab position for the specified list level object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - shadow?: boolean; + tabPosition?: boolean; /** - * Specifies a value that represents the font size in points. + * For EACH ITEM in the collection: Specifies the position (in points) for the second line of wrapping text for the specified list level object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - size?: boolean; + textPosition?: boolean; /** - * Specifies the font size in points for right-to-left text. + * For EACH ITEM in the collection: Specifies the character inserted after the number for the specified list level. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - sizeBidirectional?: boolean; + trailingCharacter?: boolean; + } + /** + * Represents a list template. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + export interface ListTemplateLoadOptions { /** - * Specifies whether the font is formatted as small caps, 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. + Specifying `$all` 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 name of the list template. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - smallCaps?: boolean; + name?: boolean; /** - * Specifies the spacing between characters. + * Specifies whether the list template is outline numbered. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - spacing?: boolean; + outlineNumbered?: boolean; + } + /** + * Represents a footnote or endnote. + * + * @remarks + * [Api set: WordApi 1.5] + */ + export interface NoteItemLoadOptions { /** - * Specifies a value that indicates whether the font has a strikethrough. True if the font is formatted as strikethrough text, otherwise, false. + Specifying `$all` 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 body object of the note item. It's the portion of the text within the footnote or endnote. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - strikeThrough?: boolean; + body?: Word.Interfaces.BodyLoadOptions; /** - * Specifies the stylistic set for the font. + * Represents a footnote or endnote reference in the main document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - stylisticSet?: boolean; + reference?: Word.Interfaces.RangeLoadOptions; /** - * Specifies a value that indicates whether the font is a subscript. True if the font is formatted as subscript, otherwise, false. + * Represents the note item type: footnote or endnote. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - subscript?: boolean; + type?: boolean; + } + /** + * Contains a collection of {@link Word.NoteItem} objects. + * + * @remarks + * [Api set: WordApi 1.5] + */ + export interface NoteItemCollectionLoadOptions { /** - * Specifies a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false. + Specifying `$all` 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 body object of the note item. It's the portion of the text within the footnote or endnote. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - superscript?: boolean; + body?: Word.Interfaces.BodyLoadOptions; /** - * Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined. + * For EACH ITEM in the collection: Represents a footnote or endnote reference in the main document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - underline?: boolean; + reference?: Word.Interfaces.RangeLoadOptions; /** - * Specifies the color of the underline for the `Font` object. You can provide the value in the '#RRGGBB' format. + * For EACH ITEM in the collection: Represents the note item type: footnote or endnote. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - underlineColor?: boolean; + type?: boolean; } /** - * Represents a hyperlink in a Word document. + * Represents the OLE characteristics (other than linking) for an OLE object, ActiveX control, or field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export interface HyperlinkLoadOptions { + export interface OleFormatLoadOptions { /** Specifying `$all` 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 `Range` object that represents the portion of the document that's contained within the hyperlink. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - range?: Word.Interfaces.RangeLoadOptions; - /** - * Specifies the address (for example, a file name or URL) of the hyperlink. + * Specifies the class type for the specified OLE object, picture, or field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - address?: boolean; + classType?: boolean; /** - * Specifies the text string for the hyperlink's subject line. + * Specifies the icon that is used when the `displayAsIcon` property is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - emailSubject?: boolean; + iconIndex?: boolean; /** - * Returns `true` if extra information is required to resolve the hyperlink. + * Specifies the text displayed below the icon for the OLE object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isExtraInfoRequired?: boolean; + iconLabel?: boolean; /** - * Returns the name of the `Hyperlink` object. + * Specifies the program file in which the icon for the OLE object is stored. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: boolean; + iconName?: boolean; /** - * Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink. + * Gets the path of the file in which the icon for the OLE object is stored. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - screenTip?: boolean; + iconPath?: boolean; /** - * Specifies a named location in the destination of the hyperlink. + * Gets whether the specified object is displayed as an icon. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - subAddress?: boolean; + isDisplayedAsIcon?: boolean; /** - * Specifies the name of the frame or window in which to load the hyperlink. + * Specifies whether formatting done in Microsoft Word to the linked OLE object is preserved. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - target?: boolean; + isFormattingPreservedOnUpdate?: boolean; /** - * Specifies the hyperlink's visible text in the document. + * Gets a string that's used to identify the portion of the source file that's being linked. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textToDisplay?: boolean; + label?: boolean; /** - * Returns the hyperlink type. + * Gets the programmatic identifier (`ProgId`) for the specified OLE object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: boolean; + progID?: boolean; } /** - * Contains a collection of {@link Word.Hyperlink} objects. + * Represents a page in the document. `Page` objects manage the page layout and content. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - export interface HyperlinkCollectionLoadOptions { + export interface PageLoadOptions { /** Specifying `$all` 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 a `Range` object that represents the portion of the document that's contained within the hyperlink. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - range?: Word.Interfaces.RangeLoadOptions; - /** - * For EACH ITEM in the collection: Specifies the address (for example, a file name or URL) of the hyperlink. + * Gets the height, in points, of the paper defined in the Page Setup dialog box. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - address?: boolean; + height?: boolean; /** - * For EACH ITEM in the collection: Specifies the text string for the hyperlink's subject line. + * Gets the index of the page. The page index is 1-based and independent of the user's custom page numbering. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - emailSubject?: boolean; + index?: boolean; /** - * For EACH ITEM in the collection: Returns `true` if extra information is required to resolve the hyperlink. + * Gets the width, in points, of the paper defined in the Page Setup dialog box. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - isExtraInfoRequired?: boolean; + width?: boolean; + } + /** + * Represents the collection of page. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + export interface PageCollectionLoadOptions { /** - * For EACH ITEM in the collection: Returns the name of the `Hyperlink` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ - name?: boolean; + $all?: boolean; /** - * For EACH ITEM in the collection: Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink. + * For EACH ITEM in the collection: Gets the height, in points, of the paper defined in the Page Setup dialog box. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - screenTip?: boolean; + height?: boolean; /** - * For EACH ITEM in the collection: Specifies a named location in the destination of the hyperlink. + * For EACH ITEM in the collection: Gets the index of the page. The page index is 1-based and independent of the user's custom page numbering. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - subAddress?: boolean; + index?: boolean; /** - * For EACH ITEM in the collection: Specifies the name of the frame or window in which to load the hyperlink. + * For EACH ITEM in the collection: Gets the width, in points, of the paper defined in the Page Setup dialog box. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - target?: boolean; + width?: boolean; + } + /** + * Represents a window pane. The `Pane` object is a member of the pane collection. The pane collection includes all the window panes for a single window. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + export interface PaneLoadOptions { /** - * For EACH ITEM in the collection: Specifies the hyperlink's visible text in the document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ - textToDisplay?: boolean; + $all?: boolean; /** - * For EACH ITEM in the collection: Returns the hyperlink type. + * Returns a `Selection` object that represents the current selection in the pane. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: boolean; + selection?: Word.Interfaces.SelectionLoadOptions; } /** - * Represents an inline picture. + * Represents the collection of pane. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - export interface InlinePictureLoadOptions { + export interface PaneCollectionLoadOptions { /** Specifying `$all` 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 parent paragraph that contains the inline image. + * For EACH ITEM in the collection: Returns a `Selection` object that represents the current selection in the pane. * * @remarks - * [Api set: WordApi 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - paragraph?: Word.Interfaces.ParagraphLoadOptions; + selection?: Word.Interfaces.SelectionLoadOptions; + } + /** + * Represents the window that displays the document. A window can be split to contain multiple reading panes. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + export interface WindowLoadOptions { /** - * Gets the content control that contains the inline image. Throws an `ItemNotFound` error if there isn't a parent content control. + Specifying `$all` 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 active pane in the window. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; + activePane?: Word.Interfaces.PaneLoadOptions; /** - * Gets the content control that contains the inline image. If there isn't a parent content control, then this method will return 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}. + * Gets the next document window in the collection of open document windows. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + next?: Word.Interfaces.WindowLoadOptions; /** - * Gets the table that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table. + * Gets the previous document window in the collection open document windows. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTable?: Word.Interfaces.TableLoadOptions; + previous?: Word.Interfaces.WindowLoadOptions; /** - * Gets the table cell that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * Gets the `View` object that represents the view for the window. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTableCell?: Word.Interfaces.TableCellLoadOptions; + view?: Word.Interfaces.ViewLoadOptions; /** - * Gets the table cell that contains the inline image. If it isn't contained in a table cell, then this method will return 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 whether rulers are displayed for the window or pane. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + areRulersDisplayed?: boolean; /** - * Gets the table that contains the inline image. If it isn't contained in a table, then this method will return 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 whether comments, footnotes, endnotes, and hyperlinks are displayed as tips. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + areScreenTipsDisplayed?: boolean; /** - * Specifies a string that represents the alternative text associated with the inline image. + * Specifies whether thumbnail images of the pages in a document are displayed along the left side of the Microsoft Word document window. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - altTextDescription?: boolean; + areThumbnailsDisplayed?: boolean; /** - * Specifies a string that contains the title for the inline image. + * Specifies the caption text for the window that is displayed in the title bar of the document or application window. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - altTextTitle?: boolean; + caption?: boolean; /** - * Specifies a number that describes the height of the inline image. + * Specifies the height of the window (in points). * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ height?: boolean; /** - * Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. + * Specifies the horizontal scroll position as a percentage of the document width. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - hyperlink?: boolean; + horizontalPercentScrolled?: boolean; /** - * Gets the format of the inline image. + * Specifies the default start-up mode for the Japanese Input Method Editor (IME). * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - imageFormat?: boolean; + imeMode?: boolean; /** - * Specifies a value that indicates whether the inline image retains its original proportions when you resize it. + * Gets the position of an item in a collection. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lockAspectRatio?: boolean; + index?: boolean; /** - * Specifies a number that describes the width of the inline image. + * Specifies whether the window is active. * * @remarks - * [Api set: WordApi 1.1] - */ - width?: boolean; - } - /** - * Contains a collection of {@link Word.InlinePicture} objects. - * - * @remarks - * [Api set: WordApi 1.1] - */ - export interface InlinePictureCollectionLoadOptions { - /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + isActive?: boolean; /** - * For EACH ITEM in the collection: Gets the parent paragraph that contains the inline image. + * Specifies whether the document map is visible. * * @remarks - * [Api set: WordApi 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - paragraph?: Word.Interfaces.ParagraphLoadOptions; + isDocumentMapVisible?: boolean; /** - * For EACH ITEM in the collection: Gets the content control that contains the inline image. Throws an `ItemNotFound` error if there isn't a parent content control. + * Specifies whether the email message header is visible in the document window. The default value is `False`. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; + isEnvelopeVisible?: boolean; /** - * For EACH ITEM in the collection: Gets the content control that contains the inline image. If there isn't a parent content control, then this method will return 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 whether a horizontal scroll bar is displayed for the window. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + isHorizontalScrollBarDisplayed?: boolean; /** - * For EACH ITEM in the collection: Gets the table that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table. + * Specifies whether the vertical scroll bar appears on the left side of the document window. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTable?: Word.Interfaces.TableLoadOptions; + isLeftScrollBarDisplayed?: boolean; /** - * For EACH ITEM in the collection: Gets the table cell that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * Specifies whether the vertical ruler appears on the right side of the document window in print layout view. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTableCell?: Word.Interfaces.TableCellLoadOptions; + isRightRulerDisplayed?: boolean; /** - * For EACH ITEM in the collection: Gets the table cell that contains the inline image. If it isn't contained in a table cell, then this method will return 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 whether the window is split into multiple panes. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + isSplit?: boolean; /** - * For EACH ITEM in the collection: Gets the table that contains the inline image. If it isn't contained in a table, then this method will return 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 whether a vertical ruler is displayed for the window or pane. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + isVerticalRulerDisplayed?: boolean; /** - * For EACH ITEM in the collection: Specifies a string that represents the alternative text associated with the inline image. + * Specifies whether a vertical scroll bar is displayed for the window. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - altTextDescription?: boolean; + isVerticalScrollBarDisplayed?: boolean; /** - * For EACH ITEM in the collection: Specifies a string that contains the title for the inline image. + * Specifies whether the window is visible. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - altTextTitle?: boolean; + isVisible?: boolean; /** - * For EACH ITEM in the collection: Specifies a number that describes the height of the inline image. + * Specifies the horizontal position of the window, measured in points. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - height?: boolean; + left?: boolean; /** - * For EACH ITEM in the collection: Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. + * Specifies how Microsoft Word displays source documents after a compare and merge process. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - hyperlink?: boolean; + showSourceDocuments?: boolean; /** - * For EACH ITEM in the collection: Gets the format of the inline image. + * Specifies the vertical split percentage for the window. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - imageFormat?: boolean; + splitVertical?: boolean; /** - * For EACH ITEM in the collection: Specifies a value that indicates whether the inline image retains its original proportions when you resize it. + * Specifies the width of the style area in points. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lockAspectRatio?: boolean; + styleAreaWidth?: boolean; /** - * For EACH ITEM in the collection: Specifies a number that describes the width of the inline image. + * Specifies the vertical position of the document window, in points. * * @remarks - * [Api set: WordApi 1.1] - */ - width?: boolean; - } - /** - * Represents the linking characteristics for an OLE object or picture. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface LinkFormatLoadOptions { - /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + top?: boolean; /** - * Specifies if the link is updated automatically when the container file is opened or when the source file is changed. + * Gets the window type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isAutoUpdated?: boolean; + type?: boolean; /** - * Specifies if a `Field`, `InlineShape`, or `Shape` object is locked to prevent automatic updating. + * Gets the height (in points) of the active working area in the document window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isLocked?: boolean; + usableHeight?: boolean; /** - * Specifies if the linked picture is saved with the document. + * Gets the width (in points) of the active working area in the document window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isPictureSavedWithDocument?: boolean; + usableWidth?: boolean; /** - * Specifies the path and name of the source file for the linked OLE object, picture, or field. + * Specifies the vertical scroll position as a percentage of the document length. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sourceFullName?: boolean; + verticalPercentScrolled?: boolean; /** - * Gets the name of the source file for the linked OLE object, picture, or field. + * Specifies the width of the document window, in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sourceName?: boolean; + width?: boolean; /** - * Gets the path of the source file for the linked OLE object, picture, or field. + * Gets an integer that represents the position of the window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sourcePath?: boolean; + windowNumber?: boolean; /** - * Gets the link type. + * Specifies the state of the document window or task window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: boolean; + windowState?: boolean; } /** - * Contains a collection of {@link Word.Paragraph} objects. + * Represents the collection of window objects. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - export interface ListLoadOptions { + export interface WindowCollectionLoadOptions { /** Specifying `$all` 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 list's id. + * For EACH ITEM in the collection: Gets the active pane in the window. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - id?: boolean; + activePane?: Word.Interfaces.PaneLoadOptions; /** - * Checks whether each of the 9 levels exists in the list. A true value indicates the level exists, which means there is at least one list item at that level. + * For EACH ITEM in the collection: Gets the next document window in the collection of open document windows. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - levelExistences?: boolean; + next?: Word.Interfaces.WindowLoadOptions; /** - * Gets all 9 level types in the list. Each type can be 'Bullet', 'Number', or 'Picture'. + * For EACH ITEM in the collection: Gets the previous document window in the collection open document windows. * * @remarks - * [Api set: WordApi 1.3] - */ - levelTypes?: boolean; - } - /** - * Contains a collection of {@link Word.List} objects. - * - * @remarks - * [Api set: WordApi 1.3] - */ - export interface ListCollectionLoadOptions { - /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + previous?: Word.Interfaces.WindowLoadOptions; /** - * For EACH ITEM in the collection: Gets the list's id. + * For EACH ITEM in the collection: Gets the `View` object that represents the view for the window. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: boolean; + view?: Word.Interfaces.ViewLoadOptions; /** - * For EACH ITEM in the collection: Checks whether each of the 9 levels exists in the list. A true value indicates the level exists, which means there is at least one list item at that level. + * For EACH ITEM in the collection: Specifies whether rulers are displayed for the window or pane. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - levelExistences?: boolean; + areRulersDisplayed?: boolean; /** - * For EACH ITEM in the collection: Gets all 9 level types in the list. Each type can be 'Bullet', 'Number', or 'Picture'. + * For EACH ITEM in the collection: Specifies whether comments, footnotes, endnotes, and hyperlinks are displayed as tips. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - levelTypes?: boolean; - } - /** - * Represents the paragraph list item format. - * - * @remarks - * [Api set: WordApi 1.3] - */ - export interface ListItemLoadOptions { + areScreenTipsDisplayed?: boolean; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * For EACH ITEM in the collection: Specifies whether thumbnail images of the pages in a document are displayed along the left side of the Microsoft Word document window. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + areThumbnailsDisplayed?: boolean; /** - * Specifies the level of the item in the list. + * For EACH ITEM in the collection: Specifies the caption text for the window that is displayed in the title bar of the document or application window. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - level?: boolean; + caption?: boolean; /** - * Gets the list item bullet, number, or picture as a string. + * For EACH ITEM in the collection: Specifies the height of the window (in points). * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listString?: boolean; + height?: boolean; /** - * Gets the list item order number in relation to its siblings. + * For EACH ITEM in the collection: Specifies the horizontal scroll position as a percentage of the document width. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - siblingIndex?: boolean; - } - /** - * Represents a list level. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - export interface ListLevelLoadOptions { + horizontalPercentScrolled?: boolean; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * For EACH ITEM in the collection: Specifies the default start-up mode for the Japanese Input Method Editor (IME). + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + imeMode?: boolean; /** - * Gets a Font object that represents the character formatting of the specified object. + * For EACH ITEM in the collection: Gets the position of an item in a collection. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontLoadOptions; + index?: boolean; /** - * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. + * For EACH ITEM in the collection: Specifies whether the window is active. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: boolean; + isActive?: boolean; /** - * Specifies the name of the style that's linked to the specified list level object. + * For EACH ITEM in the collection: Specifies whether the document map is visible. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - linkedStyle?: boolean; + isDocumentMapVisible?: boolean; /** - * Specifies the number format for the specified list level. + * For EACH ITEM in the collection: Specifies whether the email message header is visible in the document window. The default value is `False`. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - numberFormat?: boolean; + isEnvelopeVisible?: boolean; /** - * Specifies the position (in points) of the number or bullet for the specified list level object. + * For EACH ITEM in the collection: Specifies whether a horizontal scroll bar is displayed for the window. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - numberPosition?: boolean; + isHorizontalScrollBarDisplayed?: boolean; /** - * Specifies the number style for the list level object. + * For EACH ITEM in the collection: Specifies whether the vertical scroll bar appears on the left side of the document window. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - numberStyle?: boolean; + isLeftScrollBarDisplayed?: boolean; /** - * Specifies the list level that must appear before the specified list level restarts numbering at 1. + * For EACH ITEM in the collection: Specifies whether the vertical ruler appears on the right side of the document window in print layout view. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - resetOnHigher?: boolean; + isRightRulerDisplayed?: boolean; /** - * Specifies the starting number for the specified list level object. + * For EACH ITEM in the collection: Specifies whether the window is split into multiple panes. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - startAt?: boolean; + isSplit?: boolean; /** - * Specifies the tab position for the specified list level object. + * For EACH ITEM in the collection: Specifies whether a vertical ruler is displayed for the window or pane. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tabPosition?: boolean; + isVerticalRulerDisplayed?: boolean; /** - * Specifies the position (in points) for the second line of wrapping text for the specified list level object. + * For EACH ITEM in the collection: Specifies whether a vertical scroll bar is displayed for the window. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - textPosition?: boolean; + isVerticalScrollBarDisplayed?: boolean; /** - * Specifies the character inserted after the number for the specified list level. + * For EACH ITEM in the collection: Specifies whether the window is visible. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - trailingCharacter?: boolean; - } - /** - * Contains a collection of {@link Word.ListLevel} objects. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - export interface ListLevelCollectionLoadOptions { + isVisible?: boolean; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * For EACH ITEM in the collection: Specifies the horizontal position of the window, measured in points. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + left?: boolean; /** - * For EACH ITEM in the collection: Gets a Font object that represents the character formatting of the specified object. + * For EACH ITEM in the collection: Specifies how Microsoft Word displays source documents after a compare and merge process. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontLoadOptions; + showSourceDocuments?: boolean; /** - * For EACH ITEM in the collection: Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. + * For EACH ITEM in the collection: Specifies the vertical split percentage for the window. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: boolean; + splitVertical?: boolean; /** - * For EACH ITEM in the collection: Specifies the name of the style that's linked to the specified list level object. + * For EACH ITEM in the collection: Specifies the width of the style area in points. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - linkedStyle?: boolean; + styleAreaWidth?: boolean; /** - * For EACH ITEM in the collection: Specifies the number format for the specified list level. + * For EACH ITEM in the collection: Specifies the vertical position of the document window, in points. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - numberFormat?: boolean; + top?: boolean; /** - * For EACH ITEM in the collection: Specifies the position (in points) of the number or bullet for the specified list level object. + * For EACH ITEM in the collection: Gets the window type. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - numberPosition?: boolean; + type?: boolean; /** - * For EACH ITEM in the collection: Specifies the number style for the list level object. + * For EACH ITEM in the collection: Gets the height (in points) of the active working area in the document window. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - numberStyle?: boolean; + usableHeight?: boolean; /** - * For EACH ITEM in the collection: Specifies the list level that must appear before the specified list level restarts numbering at 1. + * For EACH ITEM in the collection: Gets the width (in points) of the active working area in the document window. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - resetOnHigher?: boolean; + usableWidth?: boolean; /** - * For EACH ITEM in the collection: Specifies the starting number for the specified list level object. + * For EACH ITEM in the collection: Specifies the vertical scroll position as a percentage of the document length. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - startAt?: boolean; + verticalPercentScrolled?: boolean; /** - * For EACH ITEM in the collection: Specifies the tab position for the specified list level object. + * For EACH ITEM in the collection: Specifies the width of the document window, in points. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tabPosition?: boolean; + width?: boolean; /** - * For EACH ITEM in the collection: Specifies the position (in points) for the second line of wrapping text for the specified list level object. + * For EACH ITEM in the collection: Gets an integer that represents the position of the window. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - textPosition?: boolean; + windowNumber?: boolean; /** - * For EACH ITEM in the collection: Specifies the character inserted after the number for the specified list level. + * For EACH ITEM in the collection: Specifies the state of the document window or task window. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - trailingCharacter?: boolean; + windowState?: boolean; } /** - * Represents a list template. + * Represents a single paragraph in a selection, range, content control, or document body. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.1] */ - export interface ListTemplateLoadOptions { + export interface ParagraphLoadOptions { /** Specifying `$all` 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 list template is outline numbered. + * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApiDesktop 1.1] - */ - outlineNumbered?: boolean; - } - /** - * Represents a footnote or endnote. - * - * @remarks - * [Api set: WordApi 1.5] - */ - export interface NoteItemLoadOptions { - /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * [Api set: WordApi 1.1] */ - $all?: boolean; + font?: Word.Interfaces.FontLoadOptions; /** - * Represents the body object of the note item. It's the portion of the text within the footnote or endnote. + * Gets the List to which this paragraph belongs. Throws an `ItemNotFound` error if the paragraph isn't in a list. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - body?: Word.Interfaces.BodyLoadOptions; + list?: Word.Interfaces.ListLoadOptions; /** - * Represents a footnote or endnote reference in the main document. + * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - reference?: Word.Interfaces.RangeLoadOptions; + listItem?: Word.Interfaces.ListItemLoadOptions; /** - * Represents the note item type: footnote or endnote. + * Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return 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: WordApi 1.5] + * [Api set: WordApi 1.3] */ - type?: boolean; - } - /** - * Contains a collection of {@link Word.NoteItem} objects. - * - * @remarks - * [Api set: WordApi 1.5] - */ - export interface NoteItemCollectionLoadOptions { + listItemOrNullObject?: Word.Interfaces.ListItemLoadOptions; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * Gets the List to which this paragraph belongs. If the paragraph isn't in a list, then this method will return 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: WordApi 1.3] */ - $all?: boolean; + listOrNullObject?: Word.Interfaces.ListLoadOptions; /** - * For EACH ITEM in the collection: Represents the body object of the note item. It's the portion of the text within the footnote or endnote. + * Gets the parent body of the paragraph. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - body?: Word.Interfaces.BodyLoadOptions; + parentBody?: Word.Interfaces.BodyLoadOptions; /** - * For EACH ITEM in the collection: Represents a footnote or endnote reference in the main document. + * Gets the content control that contains the paragraph. Throws an `ItemNotFound` error if there isn't a parent content control. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - reference?: Word.Interfaces.RangeLoadOptions; + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Represents the note item type: footnote or endnote. + * Gets the content control that contains the paragraph. If there isn't a parent content control, then this method will return 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: WordApi 1.5] + * [Api set: WordApi 1.3] */ - type?: boolean; - } - /** - * Represents the OLE characteristics (other than linking) for an OLE object, ActiveX control, or field. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface OleFormatLoadOptions { + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * Gets the table that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table. + * + * @remarks + * [Api set: WordApi 1.3] */ - $all?: boolean; + parentTable?: Word.Interfaces.TableLoadOptions; /** - * Specifies the class type for the specified OLE object, picture, or field. + * Gets the table cell that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table cell. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - classType?: boolean; + parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * Specifies the icon that is used when the `displayAsIcon` property is `true`. + * Gets the table cell that contains the paragraph. If it isn't contained in a table cell, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - iconIndex?: boolean; + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * Specifies the text displayed below the icon for the OLE object. + * Gets the table that contains the paragraph. If it isn't contained in a table, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - iconLabel?: boolean; + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * Specifies the program file in which the icon for the OLE object is stored. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - iconName?: boolean; + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - * Gets the path of the file in which the icon for the OLE object is stored. + * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - iconPath?: boolean; + alignment?: boolean; /** - * Gets whether the specified object is displayed as an icon. + * Specifies the value, in points, for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - isDisplayedAsIcon?: boolean; + firstLineIndent?: boolean; /** - * Specifies whether formatting done in Microsoft Word to the linked OLE object is preserved. + * Indicates the paragraph is the last one inside its parent body. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isFormattingPreservedOnUpdate?: boolean; + isLastParagraph?: boolean; /** - * Gets a string that's used to identify the portion of the source file that's being linked. + * Checks whether the paragraph is a list item. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - label?: boolean; + isListItem?: boolean; /** - * Gets the programmatic identifier (`ProgId`) for the specified OLE object. + * Specifies the left indent value, in points, for the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - progID?: boolean; - } - /** - * Represents a page in the document. `Page` objects manage the page layout and content. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - export interface PageLoadOptions { + leftIndent?: boolean; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. + * + * @remarks + * [Api set: WordApi 1.1] */ - $all?: boolean; + lineSpacing?: boolean; /** - * Gets the height, in points, of the paper defined in the Page Setup dialog box. + * Specifies the amount of spacing, in grid lines, after the paragraph. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] */ - height?: boolean; + lineUnitAfter?: boolean; /** - * Gets the index of the page. The page index is 1-based and independent of the user's custom page numbering. + * Specifies the amount of spacing, in grid lines, before the paragraph. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] */ - index?: boolean; + lineUnitBefore?: boolean; /** - * Gets the width, in points, of the paper defined in the Page Setup dialog box. + * Specifies the outline level for the paragraph. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] */ - width?: boolean; - } - /** - * Represents the collection of page. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - export interface PageCollectionLoadOptions { + outlineLevel?: boolean; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * Specifies the right indent value, in points, for the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] */ - $all?: boolean; + rightIndent?: boolean; /** - * For EACH ITEM in the collection: Gets the height, in points, of the paper defined in the Page Setup dialog box. + * Specifies the spacing, in points, after the paragraph. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] */ - height?: boolean; + spaceAfter?: boolean; /** - * For EACH ITEM in the collection: Gets the index of the page. The page index is 1-based and independent of the user's custom page numbering. + * Specifies the spacing, in points, before the paragraph. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] */ - index?: boolean; + spaceBefore?: boolean; /** - * For EACH ITEM in the collection: Gets the width, in points, of the paper defined in the Page Setup dialog box. + * Specifies the style name for the paragraph. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] */ - width?: boolean; - } - /** - * Represents the window that displays the document. A window can be split to contain multiple reading panes. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - export interface WindowLoadOptions { + style?: boolean; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * Specifies the built-in style name for the paragraph. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * + * @remarks + * [Api set: WordApi 1.3] */ - $all?: boolean; + styleBuiltIn?: boolean; /** - * Gets the next document window in the collection of open document windows. + * Gets the level of the paragraph's table. It returns 0 if the paragraph isn't in a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - next?: Word.Interfaces.WindowLoadOptions; + tableNestingLevel?: boolean; /** - * Gets the previous document window in the collection open document windows. + * Gets the text of the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - previous?: Word.Interfaces.WindowLoadOptions; + text?: boolean; /** - * Gets the `View` object that represents the view for the window. + * Gets a string that represents the paragraph identifier in the current session. ID is in standard 8-4-4-4-12 GUID format without curly braces and differs across sessions and coauthors. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - view?: Word.Interfaces.ViewLoadOptions; + uniqueLocalId?: boolean; + } + /** + * Contains a collection of {@link Word.Paragraph} objects. + * + * @remarks + * [Api set: WordApi 1.1] + */ + export interface ParagraphCollectionLoadOptions { /** - * Specifies whether rulers are displayed for the window or pane. + Specifying `$all` 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 text format of the paragraph. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - areRulersDisplayed?: boolean; + font?: Word.Interfaces.FontLoadOptions; /** - * Specifies whether comments, footnotes, endnotes, and hyperlinks are displayed as tips. + * For EACH ITEM in the collection: Gets the List to which this paragraph belongs. Throws an `ItemNotFound` error if the paragraph isn't in a list. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - areScreenTipsDisplayed?: boolean; + list?: Word.Interfaces.ListLoadOptions; /** - * Specifies whether thumbnail images of the pages in a document are displayed along the left side of the Microsoft Word document window. + * For EACH ITEM in the collection: Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - areThumbnailsDisplayed?: boolean; + listItem?: Word.Interfaces.ListItemLoadOptions; /** - * Specifies the caption text for the window that is displayed in the title bar of the document or application window. + * For EACH ITEM in the collection: Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - caption?: boolean; + listItemOrNullObject?: Word.Interfaces.ListItemLoadOptions; /** - * Specifies the height of the window (in points). + * For EACH ITEM in the collection: Gets the List to which this paragraph belongs. If the paragraph isn't in a list, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - height?: boolean; + listOrNullObject?: Word.Interfaces.ListLoadOptions; /** - * Specifies the horizontal scroll position as a percentage of the document width. + * For EACH ITEM in the collection: Gets the parent body of the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - horizontalPercentScrolled?: boolean; + parentBody?: Word.Interfaces.BodyLoadOptions; /** - * Specifies the default start-up mode for the Japanese Input Method Editor (IME). + * For EACH ITEM in the collection: Gets the content control that contains the paragraph. Throws an `ItemNotFound` error if there isn't a parent content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - imemode?: boolean; + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the position of an item in a collection. + * For EACH ITEM in the collection: Gets the content control that contains the paragraph. If there isn't a parent content control, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - index?: boolean; + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Specifies whether the window is active. + * For EACH ITEM in the collection: Gets the table that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isActive?: boolean; + parentTable?: Word.Interfaces.TableLoadOptions; /** - * Specifies whether the document map is visible. + * For EACH ITEM in the collection: Gets the table cell that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table cell. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isDocumentMapVisible?: boolean; + parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * Specifies whether the email message header is visible in the document window. The default value is `False`. + * For EACH ITEM in the collection: Gets the table cell that contains the paragraph. If it isn't contained in a table cell, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isEnvelopeVisible?: boolean; + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * Specifies whether a horizontal scroll bar is displayed for the window. + * For EACH ITEM in the collection: Gets the table that contains the paragraph. If it isn't contained in a table, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isHorizontalScrollBarDisplayed?: boolean; + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * Specifies whether the vertical scroll bar appears on the left side of the document window. + * For EACH ITEM in the collection: Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isLeftScrollBarDisplayed?: boolean; + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - * Specifies whether the vertical ruler appears on the right side of the document window in print layout view. + * For EACH ITEM in the collection: Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - isRightRulerDisplayed?: boolean; + alignment?: boolean; /** - * Specifies whether the window is split into multiple panes. + * For EACH ITEM in the collection: Specifies the value, in points, for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - isSplit?: boolean; + firstLineIndent?: boolean; /** - * Specifies whether a vertical ruler is displayed for the window or pane. + * For EACH ITEM in the collection: Indicates the paragraph is the last one inside its parent body. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isVerticalRulerDisplayed?: boolean; + isLastParagraph?: boolean; /** - * Specifies whether a vertical scroll bar is displayed for the window. + * For EACH ITEM in the collection: Checks whether the paragraph is a list item. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isVerticalScrollBarDisplayed?: boolean; + isListItem?: boolean; /** - * Specifies whether the window is visible. + * For EACH ITEM in the collection: Specifies the left indent value, in points, for the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - isVisible?: boolean; + leftIndent?: boolean; /** - * Specifies the horizontal position of the window, measured in points. + * For EACH ITEM in the collection: Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - left?: boolean; + lineSpacing?: boolean; /** - * Specifies how Microsoft Word displays source documents after a compare and merge process. + * For EACH ITEM in the collection: Specifies the amount of spacing, in grid lines, after the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - showSourceDocuments?: boolean; + lineUnitAfter?: boolean; /** - * Specifies the vertical split percentage for the window. + * For EACH ITEM in the collection: Specifies the amount of spacing, in grid lines, before the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - splitVertical?: boolean; + lineUnitBefore?: boolean; /** - * Specifies the width of the style area in points. + * For EACH ITEM in the collection: Specifies the outline level for the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - styleAreaWidth?: boolean; + outlineLevel?: boolean; /** - * Specifies the vertical position of the document window, in points. + * For EACH ITEM in the collection: Specifies the right indent value, in points, for the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - top?: boolean; + rightIndent?: boolean; /** - * Gets the window type. + * For EACH ITEM in the collection: Specifies the spacing, in points, after the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - type?: boolean; + spaceAfter?: boolean; /** - * Gets the height (in points) of the active working area in the document window. + * For EACH ITEM in the collection: Specifies the spacing, in points, before the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - usableHeight?: boolean; + spaceBefore?: boolean; /** - * Gets the width (in points) of the active working area in the document window. + * For EACH ITEM in the collection: Specifies the style name for the paragraph. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - usableWidth?: boolean; + style?: boolean; /** - * Specifies the vertical scroll position as a percentage of the document length. + * For EACH ITEM in the collection: Specifies the built-in style name for the paragraph. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - verticalPercentScrolled?: boolean; + styleBuiltIn?: boolean; /** - * Specifies the width of the document window, in points. + * For EACH ITEM in the collection: Gets the level of the paragraph's table. It returns 0 if the paragraph isn't in a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - width?: boolean; + tableNestingLevel?: boolean; /** - * Gets an integer that represents the position of the window. + * For EACH ITEM in the collection: Gets the text of the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - windowNumber?: boolean; + text?: boolean; /** - * Specifies the state of the document window or task window. + * For EACH ITEM in the collection: Gets a string that represents the paragraph identifier in the current session. ID is in standard 8-4-4-4-12 GUID format without curly braces and differs across sessions and coauthors. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - windowState?: boolean; + uniqueLocalId?: boolean; } /** - * Represents the collection of window objects. + * Represents a style of paragraph in a document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - export interface WindowCollectionLoadOptions { + 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; /** - * For EACH ITEM in the collection: Gets the next document window in the collection of open document windows. + * Specifies the alignment for the specified paragraphs. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - next?: Word.Interfaces.WindowLoadOptions; + alignment?: boolean; /** - * For EACH ITEM in the collection: Gets the previous document window in the collection open document windows. + * Specifies the value (in points) for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - previous?: Word.Interfaces.WindowLoadOptions; + firstLineIndent?: boolean; /** - * For EACH ITEM in the collection: Gets the `View` object that represents the view for the window. + * Specifies whether all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - view?: Word.Interfaces.ViewLoadOptions; + keepTogether?: boolean; /** - * For EACH ITEM in the collection: Specifies whether rulers are displayed for the window or pane. + * Specifies whether the specified paragraph remains on the same page as the paragraph that follows it when Microsoft Word repaginates the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - areRulersDisplayed?: boolean; + keepWithNext?: boolean; /** - * For EACH ITEM in the collection: Specifies whether comments, footnotes, endnotes, and hyperlinks are displayed as tips. + * Specifies the left indent. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - areScreenTipsDisplayed?: boolean; + leftIndent?: boolean; /** - * For EACH ITEM in the collection: Specifies whether thumbnail images of the pages in a document are displayed along the left side of the Microsoft Word document window. + * Specifies the line spacing (in points) for the specified paragraphs. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - areThumbnailsDisplayed?: boolean; + lineSpacing?: boolean; /** - * For EACH ITEM in the collection: Specifies the caption text for the window that is displayed in the title bar of the document or application window. + * Specifies the amount of spacing (in gridlines) after the specified paragraphs. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - caption?: boolean; + lineUnitAfter?: boolean; /** - * For EACH ITEM in the collection: Specifies the height of the window (in points). + * Specifies the amount of spacing (in gridlines) before the specified paragraphs. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - height?: boolean; + lineUnitBefore?: boolean; /** - * For EACH ITEM in the collection: Specifies the horizontal scroll position as a percentage of the document width. + * Specifies whether left and right indents are the same width. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - horizontalPercentScrolled?: boolean; + mirrorIndents?: boolean; /** - * For EACH ITEM in the collection: Specifies the default start-up mode for the Japanese Input Method Editor (IME). + * Specifies the outline level for the specified paragraphs. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - imemode?: boolean; + outlineLevel?: boolean; /** - * For EACH ITEM in the collection: Gets the position of an item in a collection. + * Specifies the right indent (in points) for the specified paragraphs. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - index?: boolean; + rightIndent?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the window is active. + * Specifies the amount of spacing (in points) after the specified paragraph or text column. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - isActive?: boolean; + spaceAfter?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the document map is visible. + * Specifies the spacing (in points) before the specified paragraphs. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - isDocumentMapVisible?: boolean; + spaceBefore?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the email message header is visible in the document window. The default value is `False`. + * Specifies whether the first and last lines in the specified paragraph remain on the same page as the rest of the paragraph when Microsoft Word repaginates the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - isEnvelopeVisible?: boolean; + widowControl?: boolean; + } + /** + * Represents a contiguous area in a document. + * + * @remarks + * [Api set: WordApi 1.1] + */ + export interface RangeLoadOptions { /** - * For EACH ITEM in the collection: Specifies whether a horizontal scroll bar is displayed for the window. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ - isHorizontalScrollBarDisplayed?: boolean; + $all?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the vertical scroll bar appears on the left side of the document window. + * Gets the text format of the range. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - isLeftScrollBarDisplayed?: boolean; + font?: Word.Interfaces.FontLoadOptions; /** - * For EACH ITEM in the collection: Specifies whether the vertical ruler appears on the right side of the document window in print layout view. + * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isRightRulerDisplayed?: boolean; + listFormat?: Word.Interfaces.ListFormatLoadOptions; /** - * For EACH ITEM in the collection: Specifies whether the window is split into multiple panes. + * Gets the parent body of the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isSplit?: boolean; + parentBody?: Word.Interfaces.BodyLoadOptions; /** - * For EACH ITEM in the collection: Specifies whether a vertical ruler is displayed for the window or pane. + * Gets the currently supported content control that contains the range. Throws an `ItemNotFound` error if there isn't a parent content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - isVerticalRulerDisplayed?: boolean; + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Specifies whether a vertical scroll bar is displayed for the window. + * Gets the currently supported content control that contains the range. If there isn't a parent content control, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isVerticalScrollBarDisplayed?: boolean; + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Specifies whether the window is visible. + * Gets the table that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isVisible?: boolean; + parentTable?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Specifies the horizontal position of the window, measured in points. + * Gets the table cell that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table cell. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - left?: boolean; + parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Specifies how Microsoft Word displays source documents after a compare and merge process. + * Gets the table cell that contains the range. If it isn't contained in a table cell, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - showSourceDocuments?: boolean; + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Specifies the vertical split percentage for the window. + * Gets the table that contains the range. If it isn't contained in a table, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - splitVertical?: boolean; + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Specifies the width of the style area in points. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - styleAreaWidth?: boolean; + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - * For EACH ITEM in the collection: Specifies the vertical position of the document window, in points. + * Specifies whether the range is formatted as bold. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - top?: boolean; + bold?: boolean; /** - * For EACH ITEM in the collection: Gets the window type. + * Specifies whether the range is formatted as bold in a right-to-left language document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: boolean; + boldBidirectional?: boolean; /** - * For EACH ITEM in the collection: Gets the height (in points) of the active working area in the document window. + * Specifies a `CharacterCase` value that represents the case of the text in the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - usableHeight?: boolean; + case?: boolean; /** - * For EACH ITEM in the collection: Gets the width (in points) of the active working area in the document window. + * Specifies the character width of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - usableWidth?: boolean; + characterWidth?: boolean; /** - * For EACH ITEM in the collection: Specifies the vertical scroll position as a percentage of the document length. + * Specifies if the range contains combined characters. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - verticalPercentScrolled?: boolean; + combineCharacters?: boolean; /** - * For EACH ITEM in the collection: Specifies the width of the document window, in points. + * Specifies if Microsoft Word ignores the number of characters per line for the corresponding `Range` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - width?: boolean; + disableCharacterSpaceGrid?: boolean; /** - * For EACH ITEM in the collection: Gets an integer that represents the position of the window. + * Specifies the emphasis mark for a character or designated character string. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - windowNumber?: boolean; + emphasisMark?: boolean; /** - * For EACH ITEM in the collection: Specifies the state of the document window or task window. + * Specifies the ending character position of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - windowState?: boolean; - } - /** - * Represents a single paragraph in a selection, range, content control, or document body. - * - * @remarks - * [Api set: WordApi 1.1] - */ - export interface ParagraphLoadOptions { - /** - Specifying `$all` 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 text format of the paragraph. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ - font?: Word.Interfaces.FontLoadOptions; - /** - * Gets the List to which this paragraph belongs. Throws an `ItemNotFound` error if the paragraph isn't in a list. - * - * @remarks - * [Api set: WordApi 1.3] - */ - list?: Word.Interfaces.ListLoadOptions; - /** - * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. - * - * @remarks - * [Api set: WordApi 1.3] - */ - listItem?: Word.Interfaces.ListItemLoadOptions; + end?: boolean; /** - * Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return 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 width (in the current measurement units) in which Microsoft Word fits the text in the current selection or range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listItemOrNullObject?: Word.Interfaces.ListItemLoadOptions; + fitTextWidth?: boolean; /** - * Gets the List to which this paragraph belongs. If the paragraph isn't in a list, then this method will return 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 if a grammar check has been run on the range or document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listOrNullObject?: Word.Interfaces.ListLoadOptions; + grammarChecked?: boolean; /** - * Gets the parent body of the paragraph. + * Specifies the proofing status (spelling and grammar checking) of the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentBody?: Word.Interfaces.BodyLoadOptions; + hasNoProofing?: boolean; /** - * Gets the content control that contains the paragraph. Throws an `ItemNotFound` error if there isn't a parent content control. + * Specifies the highlight color for the range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; + highlightColorIndex?: boolean; /** - * Gets the content control that contains the paragraph. If there isn't a parent content control, then this method will return 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 formatting for horizontal text set within vertical text. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + horizontalInVertical?: boolean; /** - * Gets the table that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table. + * Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. Use a '#' to separate the address part from the optional location part. * * @remarks * [Api set: WordApi 1.3] */ - parentTable?: Word.Interfaces.TableLoadOptions; + hyperlink?: boolean; /** - * Gets the table cell that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * Specifies the ID for the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTableCell?: Word.Interfaces.TableCellLoadOptions; + id?: boolean; /** - * Gets the table cell that contains the paragraph. If it isn't contained in a table cell, then this method will return 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}. + * Checks whether the range length is zero. * * @remarks * [Api set: WordApi 1.3] */ - parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + isEmpty?: boolean; /** - * Gets the table that contains the paragraph. If it isn't contained in a table, then this method will return 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}. + * Gets if the range is collapsed and is located at the end-of-row mark in a table. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + isEndOfRowMark?: boolean; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. + * Gets whether the text in the range is visible on the screen. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shading?: Word.Interfaces.ShadingUniversalLoadOptions; + isTextVisibleOnScreen?: boolean; /** - * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. + * Specifies if the font or range is formatted as italic. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: boolean; + italic?: boolean; /** - * Specifies the value, in points, for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. + * Specifies if the font or range is formatted as italic (right-to-left languages). * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - firstLineIndent?: boolean; + italicBidirectional?: boolean; /** - * Indicates the paragraph is the last one inside its parent body. + * Specifies whether the range of Japanese language text is hiragana or katakana. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isLastParagraph?: boolean; + kana?: boolean; /** - * Checks whether the paragraph is a list item. + * Specifies whether Microsoft Word has detected the language of the text in the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isListItem?: boolean; + languageDetected?: boolean; /** - * Specifies the left indent value, in points, for the paragraph. + * Specifies a `LanguageId` value that represents the language for the range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftIndent?: boolean; + languageId?: boolean; /** - * Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. + * Specifies an East Asian language for the range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineSpacing?: boolean; + languageIdFarEast?: boolean; /** - * Specifies the amount of spacing, in grid lines, after the paragraph. + * Specifies a language for the range that isn't classified as an East Asian language. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitAfter?: boolean; + languageIdOther?: boolean; /** - * Specifies the amount of spacing, in grid lines, before the paragraph. + * Specifies if all nonprinting characters (such as hidden text, tab marks, space marks, and paragraph marks) are displayed. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitBefore?: boolean; + showAll?: boolean; /** - * Specifies the outline level for the paragraph. + * Specifies if spelling has been checked throughout the range or document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - outlineLevel?: boolean; + spellingChecked?: boolean; /** - * Specifies the right indent value, in points, for the paragraph. + * Specifies the starting character position of the range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightIndent?: boolean; + start?: boolean; /** - * Specifies the spacing, in points, after the paragraph. + * Gets the number of characters in the story that contains the range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - spaceAfter?: boolean; + storyLength?: boolean; /** - * Specifies the spacing, in points, before the paragraph. + * Gets the story type for the range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - spaceBefore?: boolean; + storyType?: boolean; /** - * Specifies the style name for the paragraph. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * Specifies the style name for the range. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. * * @remarks * [Api set: WordApi 1.1] */ style?: boolean; /** - * Specifies the built-in style name for the paragraph. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Specifies the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks * [Api set: WordApi 1.3] */ styleBuiltIn?: boolean; /** - * Gets the level of the paragraph's table. It returns 0 if the paragraph isn't in a table. + * Gets the text of the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - tableNestingLevel?: boolean; + text?: boolean; /** - * Gets the text of the paragraph. + * Specifies whether Microsoft Word sets two lines of text in one and specifies the characters that enclose the text, if any. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - text?: boolean; + twoLinesInOne?: boolean; /** - * Gets a string that represents the paragraph identifier in the current session. ID is in standard 8-4-4-4-12 GUID format without curly braces and differs across sessions and coauthors. + * Specifies the type of underline applied to the range. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - uniqueLocalId?: boolean; + underline?: boolean; } /** - * Contains a collection of {@link Word.Paragraph} objects. + * Contains a collection of {@link Word.Range} objects. * * @remarks * [Api set: WordApi 1.1] */ - export interface ParagraphCollectionLoadOptions { + export interface RangeCollectionLoadOptions { /** Specifying `$all` 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 text format of the paragraph. Use this to get and set font name, size, color, and other properties. + * For EACH ITEM in the collection: Gets the text format of the range. Use this to get and set font name, size, color, and other properties. * * @remarks * [Api set: WordApi 1.1] */ font?: Word.Interfaces.FontLoadOptions; /** - * For EACH ITEM in the collection: Gets the List to which this paragraph belongs. Throws an `ItemNotFound` error if the paragraph isn't in a list. + * For EACH ITEM in the collection: Returns a `ListFormat` object that represents all the list formatting characteristics of the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - list?: Word.Interfaces.ListLoadOptions; + listFormat?: Word.Interfaces.ListFormatLoadOptions; /** - * For EACH ITEM in the collection: Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. + * For EACH ITEM in the collection: Gets the parent body of the range. * * @remarks * [Api set: WordApi 1.3] */ - listItem?: Word.Interfaces.ListItemLoadOptions; + parentBody?: Word.Interfaces.BodyLoadOptions; /** - * For EACH ITEM in the collection: Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return 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}. + * For EACH ITEM in the collection: Gets the currently supported content control that contains the range. Throws an `ItemNotFound` error if there isn't a parent content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - listItemOrNullObject?: Word.Interfaces.ListItemLoadOptions; + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the List to which this paragraph belongs. If the paragraph isn't in a list, then this method will return 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}. + * For EACH ITEM in the collection: Gets the currently supported content control that contains the range. If there isn't a parent content control, then this method will return 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: WordApi 1.3] */ - listOrNullObject?: Word.Interfaces.ListLoadOptions; + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the parent body of the paragraph. + * For EACH ITEM in the collection: Gets the table that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table. * * @remarks * [Api set: WordApi 1.3] */ - parentBody?: Word.Interfaces.BodyLoadOptions; + parentTable?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Gets the content control that contains the paragraph. Throws an `ItemNotFound` error if there isn't a parent content control. + * For EACH ITEM in the collection: Gets the table cell that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table cell. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; + parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the content control that contains the paragraph. If there isn't a parent content control, then this method will return 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}. + * For EACH ITEM in the collection: Gets the table cell that contains the range. If it isn't contained in a table cell, then this method will return 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: WordApi 1.3] */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the table that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table. + * For EACH ITEM in the collection: Gets the table that contains the range. If it isn't contained in a table, then this method will return 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: WordApi 1.3] */ - parentTable?: Word.Interfaces.TableLoadOptions; + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Gets the table cell that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * For EACH ITEM in the collection: Returns a `ShadingUniversal` object that refers to the shading formatting for the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTableCell?: Word.Interfaces.TableCellLoadOptions; + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - * For EACH ITEM in the collection: Gets the table cell that contains the paragraph. If it isn't contained in a table cell, then this method will return 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}. + * For EACH ITEM in the collection: Specifies whether the range is formatted as bold. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + bold?: boolean; /** - * For EACH ITEM in the collection: Gets the table that contains the paragraph. If it isn't contained in a table, then this method will return 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}. + * For EACH ITEM in the collection: Specifies whether the range is formatted as bold in a right-to-left language document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + boldBidirectional?: boolean; + /** + * For EACH ITEM in the collection: Specifies a `CharacterCase` value that represents the case of the text in the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + case?: boolean; /** - * For EACH ITEM in the collection: Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. + * For EACH ITEM in the collection: Specifies the character width of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shading?: Word.Interfaces.ShadingUniversalLoadOptions; + characterWidth?: boolean; /** - * For EACH ITEM in the collection: Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. + * For EACH ITEM in the collection: Specifies if the range contains combined characters. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: boolean; + combineCharacters?: boolean; /** - * For EACH ITEM in the collection: Specifies the value, in points, for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. + * For EACH ITEM in the collection: Specifies if Microsoft Word ignores the number of characters per line for the corresponding `Range` object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - firstLineIndent?: boolean; + disableCharacterSpaceGrid?: boolean; /** - * For EACH ITEM in the collection: Indicates the paragraph is the last one inside its parent body. + * For EACH ITEM in the collection: Specifies the emphasis mark for a character or designated character string. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isLastParagraph?: boolean; + emphasisMark?: boolean; /** - * For EACH ITEM in the collection: Checks whether the paragraph is a list item. + * For EACH ITEM in the collection: Specifies the ending character position of the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isListItem?: boolean; + end?: boolean; /** - * For EACH ITEM in the collection: Specifies the left indent value, in points, for the paragraph. + * For EACH ITEM in the collection: Specifies the width (in the current measurement units) in which Microsoft Word fits the text in the current selection or range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftIndent?: boolean; + fitTextWidth?: boolean; /** - * For EACH ITEM in the collection: Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. + * For EACH ITEM in the collection: Specifies if a grammar check has been run on the range or document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineSpacing?: boolean; + grammarChecked?: boolean; /** - * For EACH ITEM in the collection: Specifies the amount of spacing, in grid lines, after the paragraph. + * For EACH ITEM in the collection: Specifies the proofing status (spelling and grammar checking) of the range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitAfter?: boolean; + hasNoProofing?: boolean; /** - * For EACH ITEM in the collection: Specifies the amount of spacing, in grid lines, before the paragraph. + * For EACH ITEM in the collection: Specifies the highlight color for the range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitBefore?: boolean; + highlightColorIndex?: boolean; /** - * For EACH ITEM in the collection: Specifies the outline level for the paragraph. + * For EACH ITEM in the collection: Specifies the formatting for horizontal text set within vertical text. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - outlineLevel?: boolean; + horizontalInVertical?: boolean; /** - * For EACH ITEM in the collection: Specifies the right indent value, in points, for the paragraph. + * For EACH ITEM in the collection: Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. Use a '#' to separate the address part from the optional location part. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - rightIndent?: boolean; + hyperlink?: boolean; /** - * For EACH ITEM in the collection: Specifies the spacing, in points, after the paragraph. + * For EACH ITEM in the collection: Specifies the ID for the range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - spaceAfter?: boolean; + id?: boolean; /** - * For EACH ITEM in the collection: Specifies the spacing, in points, before the paragraph. + * For EACH ITEM in the collection: Checks whether the range length is zero. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - spaceBefore?: boolean; + isEmpty?: boolean; /** - * For EACH ITEM in the collection: Specifies the style name for the paragraph. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * For EACH ITEM in the collection: Gets if the range is collapsed and is located at the end-of-row mark in a table. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: boolean; + isEndOfRowMark?: boolean; /** - * For EACH ITEM in the collection: Specifies the built-in style name for the paragraph. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * For EACH ITEM in the collection: Gets whether the text in the range is visible on the screen. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBuiltIn?: boolean; + isTextVisibleOnScreen?: boolean; /** - * For EACH ITEM in the collection: Gets the level of the paragraph's table. It returns 0 if the paragraph isn't in a table. + * For EACH ITEM in the collection: Specifies if the font or range is formatted as italic. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tableNestingLevel?: boolean; + italic?: boolean; /** - * For EACH ITEM in the collection: Gets the text of the paragraph. + * For EACH ITEM in the collection: Specifies if the font or range is formatted as italic (right-to-left languages). * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - text?: boolean; + italicBidirectional?: boolean; /** - * For EACH ITEM in the collection: Gets a string that represents the paragraph identifier in the current session. ID is in standard 8-4-4-4-12 GUID format without curly braces and differs across sessions and coauthors. + * For EACH ITEM in the collection: Specifies whether the range of Japanese language text is hiragana or katakana. * * @remarks - * [Api set: WordApi 1.6] - */ - uniqueLocalId?: boolean; - } - /** - * Represents a style of paragraph in a document. - * - * @remarks - * [Api set: WordApi 1.5] - */ - 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`). + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + kana?: boolean; /** - * Specifies the alignment for the specified paragraphs. + * For EACH ITEM in the collection: Specifies whether Microsoft Word has detected the language of the text in the range. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: boolean; + languageDetected?: boolean; /** - * Specifies the value (in points) for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. + * For EACH ITEM in the collection: Specifies a `LanguageId` value that represents the language for the range. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - firstLineIndent?: boolean; + languageId?: boolean; /** - * Specifies whether all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document. + * For EACH ITEM in the collection: Specifies an East Asian language for the range. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - keepTogether?: boolean; + languageIdFarEast?: boolean; /** - * Specifies whether the specified paragraph remains on the same page as the paragraph that follows it when Microsoft Word repaginates the document. + * For EACH ITEM in the collection: Specifies a language for the range that isn't classified as an East Asian language. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - keepWithNext?: boolean; + languageIdOther?: boolean; /** - * Specifies the left indent. + * For EACH ITEM in the collection: Specifies if all nonprinting characters (such as hidden text, tab marks, space marks, and paragraph marks) are displayed. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftIndent?: boolean; + showAll?: boolean; /** - * Specifies the line spacing (in points) for the specified paragraphs. + * For EACH ITEM in the collection: Specifies if spelling has been checked throughout the range or document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineSpacing?: boolean; + spellingChecked?: boolean; /** - * Specifies the amount of spacing (in gridlines) after the specified paragraphs. + * For EACH ITEM in the collection: Specifies the starting character position of the range. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitAfter?: boolean; + start?: boolean; /** - * Specifies the amount of spacing (in gridlines) before the specified paragraphs. + * For EACH ITEM in the collection: Gets the number of characters in the story that contains the range. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitBefore?: boolean; + storyLength?: boolean; /** - * Specifies whether left and right indents are the same width. + * For EACH ITEM in the collection: Gets the story type for the range. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - mirrorIndents?: boolean; + storyType?: boolean; /** - * Specifies the outline level for the specified paragraphs. + * For EACH ITEM in the collection: Specifies the style name for the range. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - outlineLevel?: boolean; + style?: boolean; /** - * Specifies the right indent (in points) for the specified paragraphs. + * For EACH ITEM in the collection: Specifies the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - rightIndent?: boolean; + styleBuiltIn?: boolean; /** - * Specifies the amount of spacing (in points) after the specified paragraph or text column. + * For EACH ITEM in the collection: Gets the text of the range. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - spaceAfter?: boolean; + text?: boolean; /** - * Specifies the spacing (in points) before the specified paragraphs. + * For EACH ITEM in the collection: Specifies whether Microsoft Word sets two lines of text in one and specifies the characters that enclose the text, if any. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - spaceBefore?: boolean; + twoLinesInOne?: boolean; /** - * Specifies whether the first and last lines in the specified paragraph remain on the same page as the rest of the paragraph when Microsoft Word repaginates the document. + * For EACH ITEM in the collection: Specifies the type of underline applied to the range. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - widowControl?: boolean; + underline?: boolean; } /** - * Represents a contiguous area in a document. + * Specifies the options to be included in a search operation. + To learn more about how to use search options in the Word JavaScript APIs, read {@link https://learn.microsoft.com/office/dev/add-ins/word/search-option-guidance | Use search options to find text in your Word add-in}. * * @remarks * [Api set: WordApi 1.1] */ - export interface RangeLoadOptions { + export interface SearchOptionsLoadOptions { /** Specifying `$all` 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 text format of the range. Use this to get and set font name, size, color, and other properties. + * Specifies a value that indicates whether to ignore all punctuation characters between words. Corresponds to the Ignore punctuation check box in the Find and Replace dialog box. * * @remarks * [Api set: WordApi 1.1] */ - font?: Word.Interfaces.FontLoadOptions; + ignorePunct?: boolean; /** - * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. + * Specifies a value that indicates whether to ignore all whitespace between words. Corresponds to the Ignore whitespace characters check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - listFormat?: Word.Interfaces.ListFormatLoadOptions; + ignoreSpace?: boolean; /** - * Gets the parent body of the range. + * Specifies a value that indicates whether to perform a case sensitive search. Corresponds to the Match case check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - parentBody?: Word.Interfaces.BodyLoadOptions; + matchCase?: boolean; /** - * Gets the currently supported content control that contains the range. Throws an `ItemNotFound` error if there isn't a parent content control. + * Specifies a value that indicates whether to match words that begin with the search string. Corresponds to the Match prefix check box in the Find and Replace dialog box. * * @remarks * [Api set: WordApi 1.1] */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; + matchPrefix?: boolean; /** - * Gets the currently supported content control that contains the range. If there isn't a parent content control, then this method will return 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 a value that indicates whether to match words that end with the search string. Corresponds to the Match suffix check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + matchSuffix?: boolean; /** - * Gets the table that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table. + * Specifies a value that indicates whether to find operation only entire words, not text that is part of a larger word. Corresponds to the Find whole words only check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - parentTable?: Word.Interfaces.TableLoadOptions; + matchWholeWord?: boolean; /** - * Gets the table cell that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * Specifies a value that indicates whether the search will be performed using special search operators. Corresponds to the Use wildcards check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - parentTableCell?: Word.Interfaces.TableCellLoadOptions; + matchWildcards?: boolean; + } + /** + * Represents a section in a Word document. + * + * @remarks + * [Api set: WordApi 1.1] + */ + export interface SectionLoadOptions { /** - * Gets the table cell that contains the range. If it isn't contained in a table cell, then this method will return 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: WordApi 1.3] + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ - parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + $all?: boolean; /** - * Gets the table that contains the range. If it isn't contained in a table, then this method will return 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}. + * Gets the body object of the section. This doesn't include the header/footer and other section metadata. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + body?: Word.Interfaces.BodyLoadOptions; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. + * Returns a `PageSetup` object that's associated with the section. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shading?: Word.Interfaces.ShadingUniversalLoadOptions; + pageSetup?: Word.Interfaces.PageSetupLoadOptions; /** - * Specifies whether the range is formatted as bold. + * Specifies if the section is protected for forms. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bold?: boolean; + protectedForForms?: boolean; + } + /** + * Contains the collection of the document's {@link Word.Section} objects. + * + * @remarks + * [Api set: WordApi 1.1] + */ + export interface SectionCollectionLoadOptions { /** - * Specifies whether the range is formatted as bold in a right-to-left language document. + Specifying `$all` 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 body object of the section. This doesn't include the header/footer and other section metadata. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - boldBidirectional?: boolean; + body?: Word.Interfaces.BodyLoadOptions; /** - * Specifies a `CharacterCase` value that represents the case of the text in the range. + * For EACH ITEM in the collection: Returns a `PageSetup` object that's associated with the section. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - case?: boolean; + pageSetup?: Word.Interfaces.PageSetupLoadOptions; /** - * Specifies the character width of the range. + * For EACH ITEM in the collection: Specifies if the section is protected for forms. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - characterWidth?: boolean; + protectedForForms?: boolean; + } + /** + * Represents a setting of the add-in. + * + * @remarks + * [Api set: WordApi 1.4] + */ + export interface SettingLoadOptions { /** - * Specifies if the range contains combined characters. + Specifying `$all` 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 key of the setting. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - combineCharacters?: boolean; + key?: boolean; /** - * Specifies if Microsoft Word ignores the number of characters per line for the corresponding `Range` object. + * Specifies the value of the setting. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - disableCharacterSpaceGrid?: boolean; + value?: boolean; + } + /** + * Contains the collection of {@link Word.Setting} objects. + * + * @remarks + * [Api set: WordApi 1.4] + */ + export interface SettingCollectionLoadOptions { /** - * Specifies the emphasis mark for a character or designated character string. + Specifying `$all` 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 key of the setting. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - emphasisMark?: boolean; + key?: boolean; /** - * Specifies the ending character position of the range. + * For EACH ITEM in the collection: Specifies the value of the setting. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - end?: boolean; + value?: boolean; + } + /** + * Contains a collection of {@link Word.Style} objects. + * + * @remarks + * [Api set: WordApi 1.5] + */ + export interface StyleCollectionLoadOptions { /** - * Specifies the width (in the current measurement units) in which Microsoft Word fits the text in the current selection or range. + Specifying `$all` 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 a BorderCollection object that represents all the borders for the specified style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - fitTextWidth?: boolean; + borders?: Word.Interfaces.BorderCollectionLoadOptions; /** - * Specifies if a grammar check has been run on the range or document. + * For EACH ITEM in the collection: Gets a font object that represents the character formatting of the specified style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - grammarChecked?: boolean; + font?: Word.Interfaces.FontLoadOptions; /** - * Specifies the proofing status (spelling and grammar checking) of the range. + * For EACH ITEM in the collection: Returns a `Frame` object that represents the frame formatting for the style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hasNoProofing?: boolean; + frame?: Word.Interfaces.FrameLoadOptions; /** - * Specifies the highlight color for the range. + * For EACH ITEM in the collection: Specifies a link between a paragraph and a character style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - highlightColorIndex?: boolean; + linkStyle?: Word.Interfaces.StyleLoadOptions; /** - * Specifies the formatting for horizontal text set within vertical text. + * For EACH ITEM in the collection: Gets a ListTemplate object that represents the list formatting for the specified Style object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - horizontalInVertical?: boolean; + listTemplate?: Word.Interfaces.ListTemplateLoadOptions; /** - * Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. Use a '#' to separate the address part from the optional location part. + * For EACH ITEM in the collection: Gets a ParagraphFormat object that represents the paragraph settings for the specified style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - hyperlink?: boolean; + paragraphFormat?: Word.Interfaces.ParagraphFormatLoadOptions; /** - * Specifies the ID for the range. + * For EACH ITEM in the collection: Gets a Shading object that represents the shading for the specified style. Not applicable to List style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - id?: boolean; + shading?: Word.Interfaces.ShadingLoadOptions; /** - * Checks whether the range length is zero. + * For EACH ITEM in the collection: Gets a TableStyle object representing Style properties that can be applied to a table. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - isEmpty?: boolean; + tableStyle?: Word.Interfaces.TableStyleLoadOptions; /** - * Gets if the range is collapsed and is located at the end-of-row mark in a table. + * For EACH ITEM in the collection: Specifies whether the style is automatically redefined based on the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isEndOfRowMark?: boolean; + automaticallyUpdate?: boolean; /** - * Gets whether the text in the range is visible on the screen. + * For EACH ITEM in the collection: Specifies the name of an existing style to use as the base formatting of another style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] + * + * Note: The ability to set `baseStyle` was introduced in WordApi 1.6. */ - isTextVisibleOnScreen?: boolean; + baseStyle?: boolean; /** - * Specifies if the font or range is formatted as italic. + * For EACH ITEM in the collection: Gets whether the specified style is a built-in style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - italic?: boolean; + builtIn?: boolean; /** - * Specifies if the font or range is formatted as italic (right-to-left languages). + * For EACH ITEM in the collection: Gets the description of the specified style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - italicBidirectional?: boolean; + description?: boolean; /** - * Specifies whether the range of Japanese language text is hiragana or katakana. + * For EACH ITEM in the collection: Specifies whether the spelling and grammar checker ignores text formatted with this style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - kana?: boolean; + hasProofing?: boolean; /** - * Specifies whether Microsoft Word has detected the language of the text in the range. + * For EACH ITEM in the collection: Gets whether the specified style is a built-in style that has been modified or applied in the document or a new style that has been created in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - languageDetected?: boolean; + inUse?: boolean; /** - * Specifies a `LanguageId` value that represents the language for the range. + * For EACH ITEM in the collection: Specifies a `LanguageId` value that represents the language for the style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -56280,7 +66854,7 @@ export declare namespace Word { */ languageId?: boolean; /** - * Specifies an East Asian language for the range. + * For EACH ITEM in the collection: Specifies an East Asian language for the style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -56288,944 +66862,915 @@ export declare namespace Word { */ languageIdFarEast?: boolean; /** - * Specifies a language for the range that isn't classified as an East Asian language. + * For EACH ITEM in the collection: Gets whether a style is a linked style that can be used for both paragraph and character formatting. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - languageIdOther?: boolean; + linked?: boolean; /** - * Specifies if all nonprinting characters (such as hidden text, tab marks, space marks, and paragraph marks) are displayed. + * For EACH ITEM in the collection: Returns the list level for the style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showAll?: boolean; + listLevelNumber?: boolean; /** - * Specifies if spelling has been checked throughout the range or document. + * For EACH ITEM in the collection: Specifies whether the style cannot be changed or edited. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spellingChecked?: boolean; + locked?: boolean; /** - * Specifies the starting character position of the range. + * For EACH ITEM in the collection: Gets the name of a style in the language of the user. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - start?: boolean; + nameLocal?: boolean; /** - * Gets the number of characters in the story that contains the range. + * For EACH ITEM in the collection: Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] + * + * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. */ - storyLength?: boolean; + nextParagraphStyle?: boolean; /** - * Gets the story type for the range. + * For EACH ITEM in the collection: Specifies whether to remove spacing between paragraphs that are formatted using the same style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - storyType?: boolean; + noSpaceBetweenParagraphsOfSameStyle?: boolean; /** - * Specifies the style name for the range. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * For EACH ITEM in the collection: Specifies the priority. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - style?: boolean; + priority?: boolean; /** - * Specifies the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * For EACH ITEM in the collection: Specifies whether the style corresponds to an available quick style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - styleBuiltIn?: boolean; + quickStyle?: boolean; /** - * Gets the text of the range. + * For EACH ITEM in the collection: Gets the style type. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - text?: boolean; + type?: boolean; /** - * Specifies whether Microsoft Word sets two lines of text in one and specifies the characters that enclose the text, if any. + * For EACH ITEM in the collection: Specifies whether the specified style is made visible as a recommended style in the Styles and in the Styles task pane in Microsoft Word after it's used in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - twoLinesInOne?: boolean; + unhideWhenUsed?: boolean; /** - * Specifies the type of underline applied to the range. + * For EACH ITEM in the collection: Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - underline?: boolean; + visibility?: boolean; } /** - * Contains a collection of {@link Word.Range} objects. + * Represents a style in a Word document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - export interface RangeCollectionLoadOptions { + export interface StyleLoadOptions { /** Specifying `$all` 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 text format of the range. Use this to get and set font name, size, color, and other properties. + * Specifies a BorderCollection object that represents all the borders for the specified style. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] + */ + borders?: Word.Interfaces.BorderCollectionLoadOptions; + /** + * Gets a font object that represents the character formatting of the specified style. + * + * @remarks + * [Api set: WordApi 1.5] */ font?: Word.Interfaces.FontLoadOptions; /** - * For EACH ITEM in the collection: Returns a `ListFormat` object that represents all the list formatting characteristics of the range. + * Returns a `Frame` object that represents the frame formatting for the style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listFormat?: Word.Interfaces.ListFormatLoadOptions; + frame?: Word.Interfaces.FrameLoadOptions; /** - * For EACH ITEM in the collection: Gets the parent body of the range. + * Specifies a link between a paragraph and a character style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentBody?: Word.Interfaces.BodyLoadOptions; + linkStyle?: Word.Interfaces.StyleLoadOptions; /** - * For EACH ITEM in the collection: Gets the currently supported content control that contains the range. Throws an `ItemNotFound` error if there isn't a parent content control. + * Gets a ListTemplate object that represents the list formatting for the specified Style object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; + listTemplate?: Word.Interfaces.ListTemplateLoadOptions; /** - * For EACH ITEM in the collection: Gets the currently supported content control that contains the range. If there isn't a parent content control, then this method will return 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}. + * Gets a ParagraphFormat object that represents the paragraph settings for the specified style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + paragraphFormat?: Word.Interfaces.ParagraphFormatLoadOptions; /** - * For EACH ITEM in the collection: Gets the table that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table. + * Gets a Shading object that represents the shading for the specified style. Not applicable to List style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - parentTable?: Word.Interfaces.TableLoadOptions; + shading?: Word.Interfaces.ShadingLoadOptions; /** - * For EACH ITEM in the collection: Gets the table cell that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * Gets a TableStyle object representing Style properties that can be applied to a table. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - parentTableCell?: Word.Interfaces.TableCellLoadOptions; + tableStyle?: Word.Interfaces.TableStyleLoadOptions; /** - * For EACH ITEM in the collection: Gets the table cell that contains the range. If it isn't contained in a table cell, then this method will return 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 whether the style is automatically redefined based on the selection. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + automaticallyUpdate?: boolean; /** - * For EACH ITEM in the collection: Gets the table that contains the range. If it isn't contained in a table, then this method will return 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 name of an existing style to use as the base formatting of another style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] + * + * Note: The ability to set `baseStyle` was introduced in WordApi 1.6. */ - parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + baseStyle?: boolean; /** - * For EACH ITEM in the collection: Returns a `ShadingUniversal` object that refers to the shading formatting for the range. + * Gets whether the specified style is a built-in style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - shading?: Word.Interfaces.ShadingUniversalLoadOptions; + builtIn?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the range is formatted as bold. + * Gets the description of the specified style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bold?: boolean; + description?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the range is formatted as bold in a right-to-left language document. + * Specifies whether the spelling and grammar checker ignores text formatted with this style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - boldBidirectional?: boolean; + hasProofing?: boolean; /** - * For EACH ITEM in the collection: Specifies a `CharacterCase` value that represents the case of the text in the range. + * Gets whether the specified style is a built-in style that has been modified or applied in the document or a new style that has been created in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - case?: boolean; + inUse?: boolean; /** - * For EACH ITEM in the collection: Specifies the character width of the range. + * Specifies a `LanguageId` value that represents the language for the style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - characterWidth?: boolean; + languageId?: boolean; /** - * For EACH ITEM in the collection: Specifies if the range contains combined characters. + * Specifies an East Asian language for the style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - combineCharacters?: boolean; + languageIdFarEast?: boolean; /** - * For EACH ITEM in the collection: Specifies if Microsoft Word ignores the number of characters per line for the corresponding `Range` object. + * Gets whether a style is a linked style that can be used for both paragraph and character formatting. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - disableCharacterSpaceGrid?: boolean; + linked?: boolean; /** - * For EACH ITEM in the collection: Specifies the emphasis mark for a character or designated character string. + * Returns the list level for the style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - emphasisMark?: boolean; + listLevelNumber?: boolean; /** - * For EACH ITEM in the collection: Specifies the ending character position of the range. + * Specifies whether the style cannot be changed or edited. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - end?: boolean; + locked?: boolean; /** - * For EACH ITEM in the collection: Specifies the width (in the current measurement units) in which Microsoft Word fits the text in the current selection or range. + * Gets the name of a style in the language of the user. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - fitTextWidth?: boolean; + nameLocal?: boolean; /** - * For EACH ITEM in the collection: Specifies if a grammar check has been run on the range or document. + * Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] + * + * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. */ - grammarChecked?: boolean; + nextParagraphStyle?: boolean; /** - * For EACH ITEM in the collection: Specifies the proofing status (spelling and grammar checking) of the range. + * Specifies whether to remove spacing between paragraphs that are formatted using the same style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hasNoProofing?: boolean; + noSpaceBetweenParagraphsOfSameStyle?: boolean; /** - * For EACH ITEM in the collection: Specifies the highlight color for the range. + * Specifies the priority. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - highlightColorIndex?: boolean; + priority?: boolean; /** - * For EACH ITEM in the collection: Specifies the formatting for horizontal text set within vertical text. + * Specifies whether the style corresponds to an available quick style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - horizontalInVertical?: boolean; + quickStyle?: boolean; /** - * For EACH ITEM in the collection: Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. Use a '#' to separate the address part from the optional location part. + * Gets the style type. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - hyperlink?: boolean; + type?: boolean; /** - * For EACH ITEM in the collection: Specifies the ID for the range. + * Specifies whether the specified style is made visible as a recommended style in the Styles and in the Styles task pane in Microsoft Word after it's used in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - id?: boolean; + unhideWhenUsed?: boolean; /** - * For EACH ITEM in the collection: Checks whether the range length is zero. + * Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - isEmpty?: boolean; + visibility?: boolean; + } + /** + * Represents the shading object. + * + * @remarks + * [Api set: WordApi 1.6] + */ + export interface ShadingLoadOptions { /** - * For EACH ITEM in the collection: Gets if the range is collapsed and is located at the end-of-row mark in a table. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ - isEndOfRowMark?: boolean; + $all?: boolean; /** - * For EACH ITEM in the collection: Gets whether the text in the range is visible on the screen. + * Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - isTextVisibleOnScreen?: boolean; + backgroundPatternColor?: boolean; /** - * For EACH ITEM in the collection: Specifies if the font or range is formatted as italic. + * Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - italic?: boolean; + foregroundPatternColor?: boolean; /** - * For EACH ITEM in the collection: Specifies if the font or range is formatted as italic (right-to-left languages). + * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - italicBidirectional?: boolean; + texture?: boolean; + } + /** + * Represents the `ShadingUniversal` object, which manages shading for a range, paragraph, frame, or table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface ShadingUniversalLoadOptions { /** - * For EACH ITEM in the collection: Specifies whether the range of Japanese language text is hiragana or katakana. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ - kana?: boolean; + $all?: boolean; /** - * For EACH ITEM in the collection: Specifies whether Microsoft Word has detected the language of the text in the range. + * Specifies the color that's applied to the background of the `ShadingUniversal` object. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageDetected?: boolean; + backgroundPatternColor?: boolean; /** - * For EACH ITEM in the collection: Specifies a `LanguageId` value that represents the language for the range. + * Specifies the color that's applied to the background of the `ShadingUniversal` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageId?: boolean; + backgroundPatternColorIndex?: boolean; /** - * For EACH ITEM in the collection: Specifies an East Asian language for the range. + * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageIdFarEast?: boolean; + foregroundPatternColor?: boolean; /** - * For EACH ITEM in the collection: Specifies a language for the range that isn't classified as an East Asian language. + * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageIdOther?: boolean; + foregroundPatternColorIndex?: boolean; /** - * For EACH ITEM in the collection: Specifies if all nonprinting characters (such as hidden text, tab marks, space marks, and paragraph marks) are displayed. + * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showAll?: boolean; + texture?: boolean; + } + /** + * Represents a table in a Word document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + export interface TableLoadOptions { /** - * For EACH ITEM in the collection: Specifies if spelling has been checked throughout the range or document. + Specifying `$all` 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 font. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - spellingChecked?: boolean; + font?: Word.Interfaces.FontLoadOptions; /** - * For EACH ITEM in the collection: Specifies the starting character position of the range. + * Gets the parent body of the table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - start?: boolean; + parentBody?: Word.Interfaces.BodyLoadOptions; /** - * For EACH ITEM in the collection: Gets the number of characters in the story that contains the range. + * Gets the content control that contains the table. Throws an `ItemNotFound` error if there isn't a parent content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - storyLength?: boolean; + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the story type for the range. + * Gets the content control that contains the table. If there isn't a parent content control, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - storyType?: boolean; + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Specifies the style name for the range. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * Gets the table that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - style?: boolean; + parentTable?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Specifies the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Gets the table cell that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table cell. * * @remarks * [Api set: WordApi 1.3] */ - styleBuiltIn?: boolean; + parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the text of the range. + * Gets the table cell that contains this table. If it isn't contained in a table cell, then this method will return 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: WordApi 1.1] + * [Api set: WordApi 1.3] */ - text?: boolean; + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Specifies whether Microsoft Word sets two lines of text in one and specifies the characters that enclose the text, if any. + * Gets the table that contains this table. If it isn't contained in a table, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - twoLinesInOne?: boolean; + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Specifies the type of underline applied to the range. + * Returns the `ShadingUniversal` object that represents the shading of the table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - underline?: boolean; - } - /** - * Specifies the options to be included in a search operation. - To learn more about how to use search options in the Word JavaScript APIs, read {@link https://learn.microsoft.com/office/dev/add-ins/word/search-option-guidance | Use search options to find text in your Word add-in}. - * - * @remarks - * [Api set: WordApi 1.1] - */ - export interface SearchOptionsLoadOptions { - /** - Specifying `$all` 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; + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - * Specifies a value that indicates whether to ignore all punctuation characters between words. Corresponds to the Ignore punctuation check box in the Find and Replace dialog box. + * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - ignorePunct?: boolean; + alignment?: boolean; /** - * Specifies a value that indicates whether to ignore all whitespace between words. Corresponds to the Ignore whitespace characters check box in the Find and Replace dialog box. + * Specifies the description of the table. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ignoreSpace?: boolean; + description?: boolean; /** - * Specifies a value that indicates whether to perform a case sensitive search. Corresponds to the Match case check box in the Find and Replace dialog box. + * Specifies the number of header rows. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - matchCase?: boolean; + headerRowCount?: boolean; /** - * Specifies a value that indicates whether to match words that begin with the search string. Corresponds to the Match prefix check box in the Find and Replace dialog box. + * Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - matchPrefix?: boolean; + horizontalAlignment?: boolean; /** - * Specifies a value that indicates whether to match words that end with the search string. Corresponds to the Match suffix check box in the Find and Replace dialog box. + * Indicates whether all of the table rows are uniform. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - matchSuffix?: boolean; + isUniform?: boolean; /** - * Specifies a value that indicates whether to find operation only entire words, not text that is part of a larger word. Corresponds to the Find whole words only check box in the Find and Replace dialog box. + * Gets the nesting level of the table. Top-level tables have level 1. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - matchWholeWord?: boolean; + nestingLevel?: boolean; /** - * Specifies a value that indicates whether the search will be performed using special search operators. Corresponds to the Use wildcards check box in the Find and Replace dialog box. + * Gets the number of rows in the table. * * @remarks - * [Api set: WordApi 1.1] - */ - matchWildcards?: boolean; - } - /** - * Represents a section in a Word document. - * - * @remarks - * [Api set: WordApi 1.1] - */ - export interface SectionLoadOptions { - /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * [Api set: WordApi 1.3] */ - $all?: boolean; + rowCount?: boolean; /** - * Gets the body object of the section. This doesn't include the header/footer and other section metadata. + * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - body?: Word.Interfaces.BodyLoadOptions; + shadingColor?: boolean; /** - * Returns a `PageSetup` object that's associated with the section. + * Specifies the style name for the table. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - pageSetup?: Word.Interfaces.PageSetupLoadOptions; + style?: boolean; /** - * Specifies if the section is protected for forms. + * Specifies whether the table has banded columns. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - protectedForForms?: boolean; - } - /** - * Contains the collection of the document's {@link Word.Section} objects. - * - * @remarks - * [Api set: WordApi 1.1] - */ - export interface SectionCollectionLoadOptions { - /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * [Api set: WordApi 1.3] */ - $all?: boolean; + styleBandedColumns?: boolean; /** - * For EACH ITEM in the collection: Gets the body object of the section. This doesn't include the header/footer and other section metadata. + * Specifies whether the table has banded rows. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - body?: Word.Interfaces.BodyLoadOptions; + styleBandedRows?: boolean; /** - * For EACH ITEM in the collection: Returns a `PageSetup` object that's associated with the section. + * Specifies the built-in style name for the table. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - pageSetup?: Word.Interfaces.PageSetupLoadOptions; + styleBuiltIn?: boolean; /** - * For EACH ITEM in the collection: Specifies if the section is protected for forms. + * Specifies whether the table has a first column with a special style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - protectedForForms?: boolean; - } - /** - * Represents a setting of the add-in. - * - * @remarks - * [Api set: WordApi 1.4] - */ - export interface SettingLoadOptions { + styleFirstColumn?: boolean; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * Specifies whether the table has a last column with a special style. + * + * @remarks + * [Api set: WordApi 1.3] */ - $all?: boolean; + styleLastColumn?: boolean; /** - * Gets the key of the setting. + * Specifies whether the table has a total (last) row with a special style. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - key?: boolean; + styleTotalRow?: boolean; /** - * Specifies the value of the setting. + * Specifies the title of the table. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - value?: boolean; - } - /** - * Contains the collection of {@link Word.Setting} objects. - * - * @remarks - * [Api set: WordApi 1.4] - */ - export interface SettingCollectionLoadOptions { + title?: boolean; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * Specifies the text values in the table, as a 2D JavaScript array. + * + * @remarks + * [Api set: WordApi 1.3] */ - $all?: boolean; + values?: boolean; /** - * For EACH ITEM in the collection: Gets the key of the setting. + * Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - key?: boolean; + verticalAlignment?: boolean; /** - * For EACH ITEM in the collection: Specifies the value of the setting. + * Specifies the width of the table in points. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - value?: boolean; + width?: boolean; } /** - * Contains a collection of {@link Word.Style} objects. + * Represents the TableStyle object. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.6] */ - export interface StyleCollectionLoadOptions { + export interface TableStyleLoadOptions { /** Specifying `$all` 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 a BorderCollection object that represents all the borders for the specified style. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - borders?: Word.Interfaces.BorderCollectionLoadOptions; - /** - * For EACH ITEM in the collection: Gets a font object that represents the character formatting of the specified style. - * - * @remarks - * [Api set: WordApi 1.5] - */ - font?: Word.Interfaces.FontLoadOptions; - /** - * For EACH ITEM in the collection: Returns a `Frame` object that represents the frame formatting for the style. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the table style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - frame?: Word.Interfaces.FrameLoadOptions; + shading?: Word.Interfaces.ShadingLoadOptions; /** - * For EACH ITEM in the collection: Specifies a link between a paragraph and a character style. + * Specifies the table's alignment against the page margin. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - linkStyle?: Word.Interfaces.StyleLoadOptions; + alignment?: boolean; /** - * For EACH ITEM in the collection: Gets a ListTemplate object that represents the list formatting for the specified Style object. + * Specifies whether lines in tables formatted with a specified style break across pages. * * @remarks * [Api set: WordApiDesktop 1.1] */ - listTemplate?: Word.Interfaces.ListTemplateLoadOptions; + allowBreakAcrossPage?: boolean; /** - * For EACH ITEM in the collection: Gets a ParagraphFormat object that represents the paragraph settings for the specified style. + * Specifies the amount of space to add between the contents and the bottom borders of the cells. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.6] */ - paragraphFormat?: Word.Interfaces.ParagraphFormatLoadOptions; + bottomCellMargin?: boolean; /** - * For EACH ITEM in the collection: Gets a Shading object that represents the shading for the specified style. Not applicable to List style. + * Specifies the spacing (in points) between the cells in a table style. * * @remarks * [Api set: WordApi 1.6] */ - shading?: Word.Interfaces.ShadingLoadOptions; + cellSpacing?: boolean; /** - * For EACH ITEM in the collection: Gets a TableStyle object representing Style properties that can be applied to a table. + * Specifies the number of columns in the banding when a style specifies odd- or even-column banding. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tableStyle?: Word.Interfaces.TableStyleLoadOptions; + columnStripe?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the style is automatically redefined based on the selection. + * Specifies whether Microsoft Word allows to break the specified table across pages. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - automaticallyUpdate?: boolean; + isBreakAcrossPagesAllowed?: boolean; /** - * For EACH ITEM in the collection: Specifies the name of an existing style to use as the base formatting of another style. + * Specifies the amount of space to add between the contents and the left borders of the cells. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.6] + */ + leftCellMargin?: boolean; + /** + * Specifies the left indent value (in points) for the rows in the table style. * - * Note: The ability to set `baseStyle` was introduced in WordApi 1.6. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - baseStyle?: boolean; + leftIndent?: boolean; /** - * For EACH ITEM in the collection: Gets whether the specified style is a built-in style. + * Specifies the amount of space to add between the contents and the right borders of the cells. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.6] */ - builtIn?: boolean; + rightCellMargin?: boolean; /** - * For EACH ITEM in the collection: Gets the description of the specified style. + * Specifies the number of rows to include in the banding when the style specifies odd- or even-row banding. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - description?: boolean; + rowStripe?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the spelling and grammar checker ignores text formatted with this style. + * Specifies the direction in which Microsoft Word orders cells in the table style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hasProofing?: boolean; + tableDirection?: boolean; /** - * For EACH ITEM in the collection: Gets whether the specified style is a built-in style that has been modified or applied in the document or a new style that has been created in the document. + * Specifies the amount of space to add between the contents and the top borders of the cells. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.6] */ - inUse?: boolean; + topCellMargin?: boolean; + } + /** + * Represents a tab stop in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface TabStopLoadOptions { /** - * For EACH ITEM in the collection: Specifies a `LanguageId` value that represents the language for the style. + Specifying `$all` 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 next tab stop in the collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageId?: boolean; + next?: Word.Interfaces.TabStopLoadOptions; /** - * For EACH ITEM in the collection: Specifies an East Asian language for the style. + * Gets the previous tab stop in the collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageIdFarEast?: boolean; + previous?: Word.Interfaces.TabStopLoadOptions; /** - * For EACH ITEM in the collection: Gets whether a style is a linked style that can be used for both paragraph and character formatting. + * Gets a `TabAlignment` value that represents the alignment for the tab stop. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - linked?: boolean; + alignment?: boolean; /** - * For EACH ITEM in the collection: Returns the list level for the style. + * Gets whether this tab stop is a custom tab stop. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listLevelNumber?: boolean; + customTab?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the style cannot be changed or edited. + * Gets a `TabLeader` value that represents the leader for this `TabStop` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - locked?: boolean; + leader?: boolean; /** - * For EACH ITEM in the collection: Gets the name of a style in the language of the user. + * Gets the position of the tab stop relative to the left margin. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - nameLocal?: boolean; + position?: boolean; + } + /** + * Represents a collection of {@link Word.TabStop | tab stops} in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface TabStopCollectionLoadOptions { /** - * For EACH ITEM in the collection: Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style. - * - * @remarks - * [Api set: WordApi 1.5] - * - * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ - nextParagraphStyle?: boolean; + $all?: boolean; /** - * For EACH ITEM in the collection: Specifies whether to remove spacing between paragraphs that are formatted using the same style. + * For EACH ITEM in the collection: Gets the next tab stop in the collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - noSpaceBetweenParagraphsOfSameStyle?: boolean; + next?: Word.Interfaces.TabStopLoadOptions; /** - * For EACH ITEM in the collection: Specifies the priority. + * For EACH ITEM in the collection: Gets the previous tab stop in the collection. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - priority?: boolean; + previous?: Word.Interfaces.TabStopLoadOptions; /** - * For EACH ITEM in the collection: Specifies whether the style corresponds to an available quick style. + * For EACH ITEM in the collection: Gets a `TabAlignment` value that represents the alignment for the tab stop. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - quickStyle?: boolean; + alignment?: boolean; /** - * For EACH ITEM in the collection: Gets the style type. + * For EACH ITEM in the collection: Gets whether this tab stop is a custom tab stop. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: boolean; + customTab?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the specified style is made visible as a recommended style in the Styles and in the Styles task pane in Microsoft Word after it's used in the document. + * For EACH ITEM in the collection: Gets a `TabLeader` value that represents the leader for this `TabStop` object. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - unhideWhenUsed?: boolean; + leader?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane. + * For EACH ITEM in the collection: Gets the position of the tab stop relative to the left margin. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - visibility?: boolean; + position?: boolean; } /** - * Represents a style in a Word document. + * Contains the collection of the document's Table objects. * * @remarks * [Api set: WordApi 1.3] */ - export interface StyleLoadOptions { + export interface TableCollectionLoadOptions { /** Specifying `$all` 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 a BorderCollection object that represents all the borders for the specified style. + * For EACH ITEM in the collection: Gets the font. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - borders?: Word.Interfaces.BorderCollectionLoadOptions; + font?: Word.Interfaces.FontLoadOptions; /** - * Gets a font object that represents the character formatting of the specified style. + * For EACH ITEM in the collection: Gets the parent body of the table. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - font?: Word.Interfaces.FontLoadOptions; + parentBody?: Word.Interfaces.BodyLoadOptions; /** - * Returns a `Frame` object that represents the frame formatting for the style. + * For EACH ITEM in the collection: Gets the content control that contains the table. Throws an `ItemNotFound` error if there isn't a parent content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - frame?: Word.Interfaces.FrameLoadOptions; + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Specifies a link between a paragraph and a character style. + * For EACH ITEM in the collection: Gets the content control that contains the table. If there isn't a parent content control, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - linkStyle?: Word.Interfaces.StyleLoadOptions; + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets a ListTemplate object that represents the list formatting for the specified Style object. + * For EACH ITEM in the collection: Gets the table that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - listTemplate?: Word.Interfaces.ListTemplateLoadOptions; + parentTable?: Word.Interfaces.TableLoadOptions; /** - * Gets a ParagraphFormat object that represents the paragraph settings for the specified style. + * For EACH ITEM in the collection: Gets the table cell that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table cell. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - paragraphFormat?: Word.Interfaces.ParagraphFormatLoadOptions; + parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * Gets a Shading object that represents the shading for the specified style. Not applicable to List style. + * For EACH ITEM in the collection: Gets the table cell that contains this table. If it isn't contained in a table cell, then this method will return 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: WordApi 1.6] + * [Api set: WordApi 1.3] */ - shading?: Word.Interfaces.ShadingLoadOptions; + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * Gets a TableStyle object representing Style properties that can be applied to a table. + * For EACH ITEM in the collection: Gets the table that contains this table. If it isn't contained in a table, then this method will return 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: WordApi 1.6] + * [Api set: WordApi 1.3] */ - tableStyle?: Word.Interfaces.TableStyleLoadOptions; + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * Specifies whether the style is automatically redefined based on the selection. + * For EACH ITEM in the collection: Returns the `ShadingUniversal` object that represents the shading of the table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - automaticallyUpdate?: boolean; - /** - * Specifies the name of an existing style to use as the base formatting of another style. - * - * @remarks - * [Api set: WordApi 1.5] - * - * Note: The ability to set `baseStyle` was introduced in WordApi 1.6. - */ - baseStyle?: boolean; + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - * Gets whether the specified style is a built-in style. + * For EACH ITEM in the collection: Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - builtIn?: boolean; + alignment?: boolean; /** - * Gets the description of the specified style. + * For EACH ITEM in the collection: Specifies the description of the table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -57233,917 +67778,981 @@ export declare namespace Word { */ description?: boolean; /** - * Specifies whether the spelling and grammar checker ignores text formatted with this style. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - hasProofing?: boolean; - /** - * Gets whether the specified style is a built-in style that has been modified or applied in the document or a new style that has been created in the document. + * For EACH ITEM in the collection: Specifies the number of header rows. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - inUse?: boolean; + headerRowCount?: boolean; /** - * Specifies a `LanguageId` value that represents the language for the style. + * For EACH ITEM in the collection: Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - languageId?: boolean; + horizontalAlignment?: boolean; /** - * Specifies an East Asian language for the style. + * For EACH ITEM in the collection: Indicates whether all of the table rows are uniform. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - languageIdFarEast?: boolean; + isUniform?: boolean; /** - * Gets whether a style is a linked style that can be used for both paragraph and character formatting. + * For EACH ITEM in the collection: Gets the nesting level of the table. Top-level tables have level 1. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - linked?: boolean; + nestingLevel?: boolean; /** - * Returns the list level for the style. + * For EACH ITEM in the collection: Gets the number of rows in the table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - listLevelNumber?: boolean; + rowCount?: boolean; /** - * Specifies whether the style cannot be changed or edited. + * For EACH ITEM in the collection: Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - locked?: boolean; + shadingColor?: boolean; /** - * Gets the name of a style in the language of the user. + * For EACH ITEM in the collection: Specifies the style name for the table. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - nameLocal?: boolean; + style?: boolean; /** - * Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style. + * For EACH ITEM in the collection: Specifies whether the table has banded columns. * * @remarks - * [Api set: WordApi 1.5] - * - * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. + * [Api set: WordApi 1.3] */ - nextParagraphStyle?: boolean; + styleBandedColumns?: boolean; /** - * Specifies whether to remove spacing between paragraphs that are formatted using the same style. + * For EACH ITEM in the collection: Specifies whether the table has banded rows. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - noSpaceBetweenParagraphsOfSameStyle?: boolean; + styleBandedRows?: boolean; /** - * Specifies the priority. + * For EACH ITEM in the collection: Specifies the built-in style name for the table. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - priority?: boolean; + styleBuiltIn?: boolean; /** - * Specifies whether the style corresponds to an available quick style. + * For EACH ITEM in the collection: Specifies whether the table has a first column with a special style. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - quickStyle?: boolean; + styleFirstColumn?: boolean; /** - * Gets the style type. + * For EACH ITEM in the collection: Specifies whether the table has a last column with a special style. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - type?: boolean; + styleLastColumn?: boolean; /** - * Specifies whether the specified style is made visible as a recommended style in the Styles and in the Styles task pane in Microsoft Word after it's used in the document. + * For EACH ITEM in the collection: Specifies whether the table has a total (last) row with a special style. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - unhideWhenUsed?: boolean; + styleTotalRow?: boolean; /** - * Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane. + * For EACH ITEM in the collection: Specifies the title of the table. * * @remarks - * [Api set: WordApi 1.5] - */ - visibility?: boolean; - } - /** - * Represents the shading object. - * - * @remarks - * [Api set: WordApi 1.6] - */ - export interface ShadingLoadOptions { - /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + title?: boolean; /** - * Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name. + * For EACH ITEM in the collection: Specifies the text values in the table, as a 2D JavaScript array. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.3] */ - backgroundPatternColor?: boolean; + values?: boolean; /** - * Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name. + * For EACH ITEM in the collection: Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - foregroundPatternColor?: boolean; + verticalAlignment?: boolean; /** - * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. + * For EACH ITEM in the collection: Specifies the width of the table in points. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - texture?: boolean; + width?: boolean; } /** - * Represents the `ShadingUniversal` object, which manages shading for a range, paragraph, frame, or table. + * Represents a table column in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export interface ShadingUniversalLoadOptions { + 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; /** - * Specifies the color that's applied to the background of the `ShadingUniversal` object. You can provide the value in the '#RRGGBB' format. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - backgroundPatternColor?: boolean; + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - * Specifies the color that's applied to the background of the `ShadingUniversal` object. + * Returns the position of this column in a collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - backgroundPatternColorIndex?: boolean; + columnIndex?: boolean; /** - * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. You can provide the value in the '#RRGGBB' format. + * Returns `true` if the column or row is the first one in the table; `false` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - foregroundPatternColor?: boolean; + isFirst?: boolean; /** - * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. + * Returns `true` if the column or row is the last one in the table; `false` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - foregroundPatternColorIndex?: boolean; + isLast?: boolean; /** - * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. + * Returns the nesting level of the column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - texture?: boolean; - } - /** - * Represents a table in a Word document. - * - * @remarks - * [Api set: WordApi 1.3] - */ - 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 font. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.3] - */ - font?: Word.Interfaces.FontLoadOptions; - /** - * Gets the parent body of the table. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentBody?: Word.Interfaces.BodyLoadOptions; - /** - * Gets the content control that contains the table. Throws an `ItemNotFound` error if there isn't a parent content control. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; - /** - * Gets the content control that contains the table. If there isn't a parent content control, then this method will return 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: WordApi 1.3] - */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; - /** - * Gets the table that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentTable?: Word.Interfaces.TableLoadOptions; - /** - * Gets the table cell that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentTableCell?: Word.Interfaces.TableCellLoadOptions; - /** - * Gets the table cell that contains this table. If it isn't contained in a table cell, then this method will return 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: WordApi 1.3] - */ - parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; - /** - * Gets the table that contains this table. If it isn't contained in a table, then this method will return 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: WordApi 1.3] - */ - parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + nestingLevel?: boolean; /** - * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. + * Specifies the preferred width (in points or as a percentage of the window width) for the column. + The unit of measurement can be specified by the `preferredWidthType` property. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: boolean; + preferredWidth?: boolean; /** - * Specifies the number of header rows. + * Specifies the preferred unit of measurement to use for the width of the table column. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - headerRowCount?: boolean; + preferredWidthType?: boolean; /** - * Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Specifies the width of the column, in points. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - horizontalAlignment?: boolean; + width?: boolean; + } + /** + * Represents a collection of {@link Word.TableColumn} objects in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface TableColumnCollectionLoadOptions { /** - * Indicates whether all of the table rows are uniform. - * - * @remarks - * [Api set: WordApi 1.3] + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ - isUniform?: boolean; + $all?: boolean; /** - * Gets the nesting level of the table. Top-level tables have level 1. + * For EACH ITEM in the collection: Returns a `ShadingUniversal` object that refers to the shading formatting for the column. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - nestingLevel?: boolean; + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - * Gets the number of rows in the table. + * For EACH ITEM in the collection: Returns the position of this column in a collection. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rowCount?: boolean; + columnIndex?: boolean; /** - * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * For EACH ITEM in the collection: Returns `true` if the column or row is the first one in the table; `false` otherwise. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shadingColor?: boolean; + isFirst?: boolean; /** - * Specifies the style name for the table. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * For EACH ITEM in the collection: Returns `true` if the column or row is the last one in the table; `false` otherwise. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: boolean; + isLast?: boolean; /** - * Specifies whether the table has banded columns. + * For EACH ITEM in the collection: Returns the nesting level of the column. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBandedColumns?: boolean; + nestingLevel?: boolean; /** - * Specifies whether the table has banded rows. + * For EACH ITEM in the collection: Specifies the preferred width (in points or as a percentage of the window width) for the column. + The unit of measurement can be specified by the `preferredWidthType` property. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBandedRows?: boolean; + preferredWidth?: boolean; /** - * Specifies the built-in style name for the table. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * For EACH ITEM in the collection: Specifies the preferred unit of measurement to use for the width of the table column. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBuiltIn?: boolean; + preferredWidthType?: boolean; /** - * Specifies whether the table has a first column with a special style. + * For EACH ITEM in the collection: Specifies the width of the column, in points. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleFirstColumn?: boolean; + width?: boolean; + } + /** + * Represents a table of authorities in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface TableOfAuthoritiesLoadOptions { /** - * Specifies whether the table has a last column with a special style. - * - * @remarks - * [Api set: WordApi 1.3] + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ - styleLastColumn?: boolean; + $all?: boolean; /** - * Specifies whether the table has a total (last) row with a special style. + * Gets the portion of a document that is this table of authorities. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleTotalRow?: boolean; + range?: Word.Interfaces.RangeLoadOptions; /** - * Specifies the text values in the table, as a 2D JavaScript array. + * Specifies the name of the bookmark from which to collect table of authorities entries. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - values?: boolean; + bookmark?: boolean; /** - * Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. + * Specifies the category of entries to be included in the table of authorities. + Values 0 through 16 correspond to the items listed in the Category box of the Table of Authorities dialog. To learn how to access this through the Word UI, see {@link https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0 | Create a table of authorities}. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - verticalAlignment?: boolean; + category?: boolean; /** - * Specifies the width of the table in points. + * Specifies a separator of up to five characters. This appears between the table of authorities entry and its page number. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: boolean; - } - /** - * Represents the TableStyle object. - * - * @remarks - * [Api set: WordApi 1.6] - */ - export interface TableStyleLoadOptions { + entrySeparator?: boolean; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * Specifies whether the category name for a group of entries appears in the table of authorities. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + isCategoryHeaderIncluded?: boolean; /** - * Specifies the table's alignment against the page margin. + * Specifies whether the entries in the table of authorities are displayed with their formatting in the table. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: boolean; + isEntryFormattingKept?: boolean; /** - * Specifies whether lines in tables formatted with a specified style break across pages. + * Specifies whether references to the same authority that are repeated on five or more pages are replaced with "Passim". * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - allowBreakAcrossPage?: boolean; + isPassimUsed?: boolean; /** - * Specifies the amount of space to add between the contents and the bottom borders of the cells. + * Specifies a separator of up to five characters. This appears between individual page references in the table of authorities. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bottomCellMargin?: boolean; + pageNumberSeparator?: boolean; /** - * Specifies the spacing (in points) between the cells in a table style. + * Specifies a separator of up to five characters. This appears between ranges of pages in the table of authorities. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - cellSpacing?: boolean; + pageRangeSeparator?: boolean; /** - * Specifies the amount of space to add between the contents and the left borders of the cells. + * Specifies the {@link https://support.microsoft.com/office/062a387b-dfc9-4ef8-8235-29ee113d59be | Sequence (SEQ) field} identifier for the table of authorities. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftCellMargin?: boolean; + sequenceName?: boolean; /** - * Specifies the amount of space to add between the contents and the right borders of the cells. + * Specifies a separator of up to five characters. This appears between the sequence number and the page number in the table of authorities. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightCellMargin?: boolean; + sequenceSeparator?: boolean; /** - * Specifies the amount of space to add between the contents and the top borders of the cells. + * Specifies the leader character that appears between entries and their associated page numbers in the table of authorities. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topCellMargin?: boolean; + tabLeader?: boolean; } /** - * Represents a tab stop in a Word document. + * Represents a collection of {@link Word.TableOfAuthorities} objects in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export interface TabStopLoadOptions { + export interface TableOfAuthoritiesCollectionLoadOptions { /** Specifying `$all` 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 next tab stop in the collection. + * For EACH ITEM in the collection: Gets the portion of a document that is this table of authorities. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - next?: Word.Interfaces.TabStopLoadOptions; + range?: Word.Interfaces.RangeLoadOptions; /** - * Gets the previous tab stop in the collection. + * For EACH ITEM in the collection: Specifies the name of the bookmark from which to collect table of authorities entries. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - previous?: Word.Interfaces.TabStopLoadOptions; + bookmark?: boolean; /** - * Gets a `TabAlignment` value that represents the alignment for the tab stop. + * For EACH ITEM in the collection: Specifies the category of entries to be included in the table of authorities. + Values 0 through 16 correspond to the items listed in the Category box of the Table of Authorities dialog. To learn how to access this through the Word UI, see {@link https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0 | Create a table of authorities}. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - alignment?: boolean; + category?: boolean; /** - * Gets whether this tab stop is a custom tab stop. + * For EACH ITEM in the collection: Specifies a separator of up to five characters. This appears between the table of authorities entry and its page number. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customTab?: boolean; + entrySeparator?: boolean; /** - * Gets a `TabLeader` value that represents the leader for this `TabStop` object. + * For EACH ITEM in the collection: Specifies whether the category name for a group of entries appears in the table of authorities. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - leader?: boolean; + isCategoryHeaderIncluded?: boolean; /** - * Gets the position of the tab stop relative to the left margin. + * For EACH ITEM in the collection: Specifies whether the entries in the table of authorities are displayed with their formatting in the table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - position?: boolean; - } - /** - * Represents a collection of {@link Word.TabStop | tab stops} in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface TabStopCollectionLoadOptions { - /** - Specifying `$all` 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; + isEntryFormattingKept?: boolean; /** - * For EACH ITEM in the collection: Gets the next tab stop in the collection. + * For EACH ITEM in the collection: Specifies whether references to the same authority that are repeated on five or more pages are replaced with "Passim". * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - next?: Word.Interfaces.TabStopLoadOptions; + isPassimUsed?: boolean; /** - * For EACH ITEM in the collection: Gets the previous tab stop in the collection. + * For EACH ITEM in the collection: Specifies a separator of up to five characters. This appears between individual page references in the table of authorities. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - previous?: Word.Interfaces.TabStopLoadOptions; + pageNumberSeparator?: boolean; /** - * For EACH ITEM in the collection: Gets a `TabAlignment` value that represents the alignment for the tab stop. + * For EACH ITEM in the collection: Specifies a separator of up to five characters. This appears between ranges of pages in the table of authorities. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - alignment?: boolean; + pageRangeSeparator?: boolean; /** - * For EACH ITEM in the collection: Gets whether this tab stop is a custom tab stop. + * For EACH ITEM in the collection: Specifies the {@link https://support.microsoft.com/office/062a387b-dfc9-4ef8-8235-29ee113d59be | Sequence (SEQ) field} identifier for the table of authorities. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customTab?: boolean; + sequenceName?: boolean; /** - * For EACH ITEM in the collection: Gets a `TabLeader` value that represents the leader for this `TabStop` object. + * For EACH ITEM in the collection: Specifies a separator of up to five characters. This appears between the sequence number and the page number in the table of authorities. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - leader?: boolean; + sequenceSeparator?: boolean; /** - * For EACH ITEM in the collection: Gets the position of the tab stop relative to the left margin. + * For EACH ITEM in the collection: Specifies the leader character that appears between entries and their associated page numbers in the table of authorities. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - position?: boolean; + tabLeader?: boolean; } /** - * Contains the collection of the document's Table objects. + * Represents a category used in a table of authorities. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - export interface TableCollectionLoadOptions { + export interface TableOfAuthoritiesCategoryLoadOptions { /** Specifying `$all` 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 font. Use this to get and set font name, size, color, and other properties. + * Specifies the name of this table of authorities category. + Changing the name of the category doesn't change the index in the collection. The value for {@link Word.TableOfAuthorities | TableOfAuthorities.category} will remain the same. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontLoadOptions; + name?: boolean; + } + /** + * Represents a collection of {@link Word.TableOfAuthoritiesCategory} objects in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface TableOfAuthoritiesCategoryCollectionLoadOptions { /** - * For EACH ITEM in the collection: Gets the parent body of the table. - * - * @remarks - * [Api set: WordApi 1.3] + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ - parentBody?: Word.Interfaces.BodyLoadOptions; + $all?: boolean; /** - * For EACH ITEM in the collection: Gets the content control that contains the table. Throws an `ItemNotFound` error if there isn't a parent content control. + * For EACH ITEM in the collection: Specifies the name of this table of authorities category. + Changing the name of the category doesn't change the index in the collection. The value for {@link Word.TableOfAuthorities | TableOfAuthorities.category} will remain the same. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; + name?: boolean; + } + /** + * Represents a table of contents in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface TableOfContentsLoadOptions { /** - * For EACH ITEM in the collection: Gets the content control that contains the table. If there isn't a parent content control, then this method will return 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: WordApi 1.3] + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + $all?: boolean; /** - * For EACH ITEM in the collection: Gets the table that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table. + * Gets the portion of a document that is this table of contents. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeLoadOptions; + /** + * Specifies whether built-in heading styles are used for the table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTable?: Word.Interfaces.TableLoadOptions; + areBuiltInHeadingStylesUsed?: boolean; /** - * For EACH ITEM in the collection: Gets the table cell that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTableCell?: Word.Interfaces.TableCellLoadOptions; + areFieldsUsed?: boolean; /** - * For EACH ITEM in the collection: Gets the table cell that contains this table. If it isn't contained in a table cell, then this method will return 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 whether entries in the table of contents should be formatted as hyperlinks when publishing to the web. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + areHyperlinksUsedOnWeb?: boolean; /** - * For EACH ITEM in the collection: Gets the table that contains this table. If it isn't contained in a table, then this method will return 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 whether the page numbers in the table of contents should be hidden when publishing to the web. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + arePageNumbersHiddenOnWeb?: boolean; /** - * For EACH ITEM in the collection: Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. + * Specifies whether page numbers are included in the table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: boolean; + arePageNumbersIncluded?: boolean; /** - * For EACH ITEM in the collection: Specifies the number of header rows. + * Specifies whether page numbers are aligned with the right margin in the table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - headerRowCount?: boolean; + arePageNumbersRightAligned?: boolean; /** - * For EACH ITEM in the collection: Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Specifies the ending heading level for the table of contents. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - horizontalAlignment?: boolean; + lowerHeadingLevel?: boolean; /** - * For EACH ITEM in the collection: Indicates whether all of the table rows are uniform. + * Specifies the character between entries and their page numbers in the table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isUniform?: boolean; + tabLeader?: boolean; /** - * For EACH ITEM in the collection: Gets the nesting level of the table. Top-level tables have level 1. + * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - nestingLevel?: boolean; + tableId?: boolean; /** - * For EACH ITEM in the collection: Gets the number of rows in the table. + * Specifies the starting heading level for the table of contents. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rowCount?: boolean; + upperHeadingLevel?: boolean; + } + /** + * Represents a collection of {@link Word.TableOfContents} objects in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface TableOfContentsCollectionLoadOptions { /** - * For EACH ITEM in the collection: Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + Specifying `$all` 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 portion of a document that is this table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shadingColor?: boolean; + range?: Word.Interfaces.RangeLoadOptions; /** - * For EACH ITEM in the collection: Specifies the style name for the table. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * For EACH ITEM in the collection: Specifies whether built-in heading styles are used for the table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: boolean; + areBuiltInHeadingStylesUsed?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the table has banded columns. + * For EACH ITEM in the collection: Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBandedColumns?: boolean; + areFieldsUsed?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the table has banded rows. + * For EACH ITEM in the collection: Specifies whether entries in the table of contents should be formatted as hyperlinks when publishing to the web. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBandedRows?: boolean; + areHyperlinksUsedOnWeb?: boolean; /** - * For EACH ITEM in the collection: Specifies the built-in style name for the table. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * For EACH ITEM in the collection: Specifies whether the page numbers in the table of contents should be hidden when publishing to the web. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBuiltIn?: boolean; + arePageNumbersHiddenOnWeb?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the table has a first column with a special style. + * For EACH ITEM in the collection: Specifies whether page numbers are included in the table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleFirstColumn?: boolean; + arePageNumbersIncluded?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the table has a last column with a special style. + * For EACH ITEM in the collection: Specifies whether page numbers are aligned with the right margin in the table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleLastColumn?: boolean; + arePageNumbersRightAligned?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the table has a total (last) row with a special style. + * For EACH ITEM in the collection: Specifies the ending heading level for the table of contents. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleTotalRow?: boolean; + lowerHeadingLevel?: boolean; /** - * For EACH ITEM in the collection: Specifies the text values in the table, as a 2D JavaScript array. + * For EACH ITEM in the collection: Specifies the character between entries and their page numbers in the table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - values?: boolean; + tabLeader?: boolean; /** - * For EACH ITEM in the collection: Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. + * For EACH ITEM in the collection: Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - verticalAlignment?: boolean; + tableId?: boolean; /** - * For EACH ITEM in the collection: Specifies the width of the table in points. + * For EACH ITEM in the collection: Specifies the starting heading level for the table of contents. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: boolean; + upperHeadingLevel?: boolean; } /** - * Represents a table column in a Word document. + * Represents a table of figures in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export interface TableColumnLoadOptions { + export interface TableOfFiguresLoadOptions { /** Specifying `$all` 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 `ShadingUniversal` object that refers to the shading formatting for the column. + * Gets the portion of a document that is this table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shading?: Word.Interfaces.ShadingUniversalLoadOptions; + range?: Word.Interfaces.RangeLoadOptions; /** - * Returns the position of this column in a collection. + * Specifies whether built-in heading styles are used for the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - columnIndex?: boolean; + areBuiltInHeadingStylesUsed?: boolean; /** - * Returns `true` if the column or row is the first one in the table; `false` otherwise. + * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isFirst?: boolean; + areFieldsUsed?: boolean; /** - * Returns `true` if the column or row is the last one in the table; `false` otherwise. + * Specifies whether entries in the table of figures should be formatted as hyperlinks when publishing to the web. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isLast?: boolean; + areHyperlinksUsedOnWeb?: boolean; /** - * Returns the nesting level of the column. + * Specifies whether the page numbers in the table of figures should be hidden when publishing to the web. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nestingLevel?: boolean; + arePageNumbersHiddenOnWeb?: boolean; /** - * Specifies the preferred width (in points or as a percentage of the window width) for the column. - The unit of measurement can be specified by the `preferredWidthType` property. + * Specifies whether page numbers are included in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - preferredWidth?: boolean; + arePageNumbersIncluded?: boolean; /** - * Specifies the preferred unit of measurement to use for the width of the table column. + * Specifies whether page numbers are aligned with the right margin in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - preferredWidthType?: boolean; + arePageNumbersRightAligned?: boolean; /** - * Specifies the width of the column, in points. + * Specifies the label that identifies the items to be included in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - width?: boolean; + captionLabel?: boolean; + /** + * Specifies whether the caption label and caption number are included in the table of figures. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isLabelIncluded?: boolean; + /** + * Specifies the ending heading level for the table of figures. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lowerHeadingLevel?: boolean; + /** + * Specifies the character between entries and their page numbers in the table of figures. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tabLeader?: boolean; + /** + * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of figures. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tableId?: boolean; + /** + * Specifies the starting heading level for the table of figures. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + upperHeadingLevel?: boolean; } /** - * Represents a collection of {@link Word.TableColumn} objects in a Word document. + * Represents a collection of {@link Word.TableOfFigures} objects in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export interface TableColumnCollectionLoadOptions { + export interface TableOfFiguresCollectionLoadOptions { /** Specifying `$all` 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 a `ShadingUniversal` object that refers to the shading formatting for the column. + * For EACH ITEM in the collection: Gets the portion of a document that is this table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shading?: Word.Interfaces.ShadingUniversalLoadOptions; + range?: Word.Interfaces.RangeLoadOptions; /** - * For EACH ITEM in the collection: Returns the position of this column in a collection. + * For EACH ITEM in the collection: Specifies whether built-in heading styles are used for the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - columnIndex?: boolean; + areBuiltInHeadingStylesUsed?: boolean; /** - * For EACH ITEM in the collection: Returns `true` if the column or row is the first one in the table; `false` otherwise. + * For EACH ITEM in the collection: Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isFirst?: boolean; + areFieldsUsed?: boolean; /** - * For EACH ITEM in the collection: Returns `true` if the column or row is the last one in the table; `false` otherwise. + * For EACH ITEM in the collection: Specifies whether entries in the table of figures should be formatted as hyperlinks when publishing to the web. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isLast?: boolean; + areHyperlinksUsedOnWeb?: boolean; /** - * For EACH ITEM in the collection: Returns the nesting level of the column. + * For EACH ITEM in the collection: Specifies whether the page numbers in the table of figures should be hidden when publishing to the web. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nestingLevel?: boolean; + arePageNumbersHiddenOnWeb?: boolean; /** - * For EACH ITEM in the collection: Specifies the preferred width (in points or as a percentage of the window width) for the column. - The unit of measurement can be specified by the `preferredWidthType` property. + * For EACH ITEM in the collection: Specifies whether page numbers are included in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - preferredWidth?: boolean; + arePageNumbersIncluded?: boolean; /** - * For EACH ITEM in the collection: Specifies the preferred unit of measurement to use for the width of the table column. + * For EACH ITEM in the collection: Specifies whether page numbers are aligned with the right margin in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - preferredWidthType?: boolean; + arePageNumbersRightAligned?: boolean; /** - * For EACH ITEM in the collection: Specifies the width of the column, in points. + * For EACH ITEM in the collection: Specifies the label that identifies the items to be included in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - width?: boolean; + captionLabel?: boolean; + /** + * For EACH ITEM in the collection: Specifies whether the caption label and caption number are included in the table of figures. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isLabelIncluded?: boolean; + /** + * For EACH ITEM in the collection: Specifies the ending heading level for the table of figures. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lowerHeadingLevel?: boolean; + /** + * For EACH ITEM in the collection: Specifies the character between entries and their page numbers in the table of figures. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tabLeader?: boolean; + /** + * For EACH ITEM in the collection: Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of figures. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tableId?: boolean; + /** + * For EACH ITEM in the collection: Specifies the starting heading level for the table of figures. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + upperHeadingLevel?: boolean; } /** * Represents a row in a Word document. @@ -58170,6 +68779,22 @@ export declare namespace Word { * [Api set: WordApi 1.3] */ parentTable?: Word.Interfaces.TableLoadOptions; + /** + * Returns the `Range` object that represents the table row. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeLoadOptions; + /** + * Returns the `ShadingUniversal` object that represents the shading of the table row. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** * Gets the number of cells in the row. * @@ -58252,6 +68877,22 @@ export declare namespace Word { * [Api set: WordApi 1.3] */ parentTable?: Word.Interfaces.TableLoadOptions; + /** + * For EACH ITEM in the collection: Returns the `Range` object that represents the table row. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeLoadOptions; + /** + * For EACH ITEM in the collection: Returns the `ShadingUniversal` object that represents the shading of the table row. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** * For EACH ITEM in the collection: Gets the number of cells in the row. * @@ -58327,6 +68968,14 @@ export declare namespace Word { * [Api set: WordApi 1.3] */ body?: Word.Interfaces.BodyLoadOptions; + /** + * Returns the `TableColumn` object that represents the table column that contains this cell. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + column?: Word.Interfaces.TableColumnLoadOptions; /** * Gets the parent row of the cell. * @@ -58341,6 +68990,14 @@ export declare namespace Word { * [Api set: WordApi 1.3] */ parentTable?: Word.Interfaces.TableLoadOptions; + /** + * Returns the `ShadingUniversal` object that represents the shading of the table cell. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** * Gets the index of the cell in its row. * @@ -58416,6 +69073,14 @@ export declare namespace Word { * [Api set: WordApi 1.3] */ body?: Word.Interfaces.BodyLoadOptions; + /** + * For EACH ITEM in the collection: Returns the `TableColumn` object that represents the table column that contains this cell. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + column?: Word.Interfaces.TableColumnLoadOptions; /** * For EACH ITEM in the collection: Gets the parent row of the cell. * @@ -58430,6 +69095,14 @@ export declare namespace Word { * [Api set: WordApi 1.3] */ parentTable?: Word.Interfaces.TableLoadOptions; + /** + * For EACH ITEM in the collection: Returns the `ShadingUniversal` object that represents the shading of the table cell. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** * For EACH ITEM in the collection: Gets the index of the cell in its row. * @@ -60035,24 +70708,545 @@ export declare namespace Word { /** Specifying `$all` 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; + $all?: boolean; + /** + * Returns the range of this repeating section item, excluding the start and end tags. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeLoadOptions; + } + /** + * Represents a single tracked change in a document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface RevisionLoadOptions { + /** + Specifying `$all` 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 a `Range` object that represents the range of text that was moved from one place to another in the document with tracked changes. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + movedRange?: Word.Interfaces.RangeLoadOptions; + /** + * Gets a `Range` object that represents the portion of the document that's contained within a revision mark. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeLoadOptions; + /** + * Gets the name of the user who made the tracked change. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + author?: boolean; + /** + * Gets the date and time when the tracked change was made. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + date?: boolean; + /** + * Gets the description of tracked formatting changes in the revision. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + formatDescription?: boolean; + /** + * Gets a number that represents the position of this item in a collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + index?: boolean; + /** + * Gets the revision type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type?: boolean; + } + /** + * A collection of Revision objects that represent the changes marked with revision marks in a range or document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface RevisionCollectionLoadOptions { + /** + Specifying `$all` 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 a `Range` object that represents the range of text that was moved from one place to another in the document with tracked changes. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + movedRange?: Word.Interfaces.RangeLoadOptions; + /** + * For EACH ITEM in the collection: Gets a `Range` object that represents the portion of the document that's contained within a revision mark. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeLoadOptions; + /** + * For EACH ITEM in the collection: Gets the name of the user who made the tracked change. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + author?: boolean; + /** + * For EACH ITEM in the collection: Gets the date and time when the tracked change was made. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + date?: boolean; + /** + * For EACH ITEM in the collection: Gets the description of tracked formatting changes in the revision. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + formatDescription?: boolean; + /** + * For EACH ITEM in the collection: Gets a number that represents the position of this item in a collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + index?: boolean; + /** + * For EACH ITEM in the collection: Gets the revision type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type?: boolean; + } + /** + * Represents the `DatePickerContentControl` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface DatePickerContentControlLoadOptions { + /** + Specifying `$all` 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 `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; + /** + * Gets a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeLoadOptions; + /** + * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; + /** + * Specifies the appearance of the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + appearance?: boolean; + /** + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + color?: boolean; + /** + * Specifies a `CalendarType` value that represents the calendar type for the date picker content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + dateCalendarType?: boolean; + /** + * Specifies the format in which dates are displayed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + dateDisplayFormat?: boolean; + /** + * Specifies a `LanguageId` that represents the language format for the date displayed in the date picker content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + dateDisplayLocale?: boolean; + /** + * Specifies a `ContentControlDateStorageFormat` value that represents the format for storage and retrieval of dates when the date picker content control is bound to the XML data store of the active document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + dateStorageFormat?: boolean; + /** + * Gets the identification for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + id?: boolean; + /** + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isTemporary?: boolean; + /** + * Specifies the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + level?: boolean; + /** + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lockContentControl?: boolean; + /** + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lockContents?: boolean; + /** + * Gets whether the placeholder text for the content control is being displayed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + showingPlaceholderText?: boolean; + /** + * Specifies a tag to identify the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tag?: boolean; + /** + * Specifies the title for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + title?: boolean; + } + /** + * Represents the `PictureContentControl` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface PictureContentControlLoadOptions { + /** + Specifying `$all` 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 `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; + /** + * Returns a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeLoadOptions; + /** + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; + /** + * Specifies the appearance of the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + appearance?: boolean; + /** + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + color?: boolean; + /** + * Returns the identification for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + id?: boolean; + /** + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isTemporary?: boolean; + /** + * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + level?: boolean; + /** + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lockContentControl?: boolean; + /** + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lockContents?: boolean; + /** + * Returns whether the placeholder text for the content control is being displayed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + showingPlaceholderText?: boolean; + /** + * Specifies a tag to identify the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tag?: boolean; + /** + * Specifies the title for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + title?: boolean; + } + /** + * Represents the `GroupContentControl` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface GroupContentControlLoadOptions { + /** + Specifying `$all` 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 `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; + /** + * Gets a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeLoadOptions; + /** + * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; + /** + * Specifies the appearance of the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + appearance?: boolean; + /** + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + color?: boolean; + /** + * Returns the identification for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + id?: boolean; + /** + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isTemporary?: boolean; + /** + * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + level?: boolean; + /** + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lockContentControl?: boolean; + /** + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lockContents?: boolean; + /** + * Returns whether the placeholder text for the content control is being displayed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + showingPlaceholderText?: boolean; + /** + * Specifies a tag to identify the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tag?: boolean; /** - * Returns the range of this repeating section item, excluding the start and end tags. + * Specifies the title for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeLoadOptions; + title?: boolean; } /** - * Represents the `DatePickerContentControl` object. + * Represents the `BuildingBlockGalleryContentControl` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export interface DatePickerContentControlLoadOptions { + export interface BuildingBlockGalleryContentControlLoadOptions { /** Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ @@ -60066,7 +71260,7 @@ export declare namespace Word { */ placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * Returns a `Range` object that represents the contents of the content control in the active document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -60074,7 +71268,7 @@ export declare namespace Word { */ range?: Word.Interfaces.RangeLoadOptions; /** - * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -60090,45 +71284,29 @@ export declare namespace Word { */ appearance?: boolean; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - color?: boolean; - /** - * Specifies a `CalendarType` value that represents the calendar type for the date picker content control. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - dateCalendarType?: boolean; - /** - * Specifies the format in which dates are displayed. + * Specifies the category for the building block content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateDisplayFormat?: boolean; + buildingBlockCategory?: boolean; /** - * Specifies a `LanguageId` that represents the language format for the date displayed in the date picker content control. + * Specifies a `BuildingBlockType` value that represents the type of building block for the building block content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateDisplayLocale?: boolean; + buildingBlockType?: boolean; /** - * Specifies a `ContentControlDateStorageFormat` value that represents the format for storage and retrieval of dates when the date picker content control is bound to the XML data store of the active document. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateStorageFormat?: boolean; + color?: boolean; /** * Gets the identification for the content control. * @@ -60146,7 +71324,7 @@ export declare namespace Word { */ isTemporary?: boolean; /** - * Specifies the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -60170,7 +71348,7 @@ export declare namespace Word { */ lockContents?: boolean; /** - * Gets whether the placeholder text for the content control is being displayed. + * Gets if the placeholder text for the content control is being displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -60195,13 +71373,13 @@ export declare namespace Word { title?: boolean; } /** - * Represents the `PictureContentControl` object. + * Represents the `RepeatingSectionContentControl` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export interface PictureContentControlLoadOptions { + export interface RepeatingSectionContentControlLoadOptions { /** Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ @@ -60215,7 +71393,7 @@ export declare namespace Word { */ placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; /** - * Returns a `Range` object that represents the contents of the content control in the active document. + * Gets a `Range` object that represents the contents of the content control in the active document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -60229,7 +71407,15 @@ export declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; + xmlapping?: Word.Interfaces.XmlMappingLoadOptions; + /** + * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + allowInsertDeleteSection?: boolean; /** * Specifies the appearance of the content control. * @@ -60286,6 +71472,14 @@ export declare namespace Word { * @beta */ lockContents?: boolean; + /** + * Specifies the name of the repeating section items used in the context menu associated with this repeating section content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + repeatingSectionItemTitle?: boolean; /** * Returns whether the placeholder text for the content control is being displayed. * @@ -60312,144 +71506,144 @@ export declare namespace Word { title?: boolean; } /** - * Represents the `GroupContentControl` object. + * Represents a frame. The `Frame` object is a member of the {@link Word.FrameCollection} object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export interface GroupContentControlLoadOptions { + export interface FrameLoadOptions { /** Specifying `$all` 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 `BuildingBlock` object that represents the placeholder text for the content control. + * Returns a `Range` object that represents the portion of the document that's contained within the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; + range?: Word.Interfaces.RangeLoadOptions; /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeLoadOptions; + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Specifies the height (in points) of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; + height?: boolean; /** - * Specifies the appearance of the content control. + * Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: boolean; + heightRule?: boolean; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Specifies the horizontal distance between the frame and the surrounding text, in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: boolean; + horizontalDistanceFromText?: boolean; /** - * Returns the identification for the content control. + * Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: boolean; + horizontalPosition?: boolean; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Specifies if the frame is locked. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + lockAnchor?: boolean; /** - * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Specifies the relative horizontal position of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - level?: boolean; + relativeHorizontalPosition?: boolean; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Specifies the relative vertical position of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + relativeVerticalPosition?: boolean; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Specifies if document text wraps around the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + textWrap?: boolean; /** - * Returns whether the placeholder text for the content control is being displayed. + * Specifies the vertical distance (in points) between the frame and the surrounding text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showingPlaceholderText?: boolean; + verticalDistanceFromText?: boolean; /** - * Specifies a tag to identify the content control. + * Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: boolean; + verticalPosition?: boolean; /** - * Specifies the title for the content control. + * Specifies the width (in points) of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: boolean; + width?: boolean; + /** + * Specifies the rule used to determine the width of the frame. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + widthRule?: boolean; } /** - * Represents the `BuildingBlockGalleryContentControl` object. + * Represents the collection of {@link Word.Frame} objects. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export interface BuildingBlockGalleryContentControlLoadOptions { + export interface FrameCollectionLoadOptions { /** Specifying `$all` 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 `BuildingBlock` object that represents the placeholder text for the content control. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; - /** - * Returns a `Range` object that represents the contents of the content control in the active document. + * For EACH ITEM in the collection: Returns a `Range` object that represents the portion of the document that's contained within the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -60457,1943 +71651,2120 @@ export declare namespace Word { */ range?: Word.Interfaces.RangeLoadOptions; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * For EACH ITEM in the collection: Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - * Specifies the appearance of the content control. + * For EACH ITEM in the collection: Specifies the height (in points) of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: boolean; + height?: boolean; /** - * Specifies the category for the building block content control. + * For EACH ITEM in the collection: Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - buildingBlockCategory?: boolean; + heightRule?: boolean; /** - * Specifies a `BuildingBlockType` value that represents the type of building block for the building block content control. + * For EACH ITEM in the collection: Specifies the horizontal distance between the frame and the surrounding text, in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - buildingBlockType?: boolean; + horizontalDistanceFromText?: boolean; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * For EACH ITEM in the collection: Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: boolean; + horizontalPosition?: boolean; /** - * Gets the identification for the content control. + * For EACH ITEM in the collection: Specifies if the frame is locked. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: boolean; + lockAnchor?: boolean; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * For EACH ITEM in the collection: Specifies the relative horizontal position of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + relativeHorizontalPosition?: boolean; /** - * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * For EACH ITEM in the collection: Specifies the relative vertical position of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - level?: boolean; + relativeVerticalPosition?: boolean; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * For EACH ITEM in the collection: Specifies if document text wraps around the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + textWrap?: boolean; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * For EACH ITEM in the collection: Specifies the vertical distance (in points) between the frame and the surrounding text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + verticalDistanceFromText?: boolean; /** - * Gets if the placeholder text for the content control is being displayed. + * For EACH ITEM in the collection: Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showingPlaceholderText?: boolean; + verticalPosition?: boolean; /** - * Specifies a tag to identify the content control. + * For EACH ITEM in the collection: Specifies the width (in points) of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: boolean; + width?: boolean; /** - * Specifies the title for the content control. + * For EACH ITEM in the collection: Specifies the rule used to determine the width of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: boolean; + widthRule?: boolean; } /** - * Represents the `RepeatingSectionContentControl` object. + * Represents a document library version. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export interface RepeatingSectionContentControlLoadOptions { + export interface DocumentLibraryVersionLoadOptions { /** Specifying `$all` 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 `BuildingBlock` object that represents the placeholder text for the content control. + * Gets any optional comments associated with this version of the shared document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; + comments?: boolean; /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * Gets the date and time at which this version of the shared document was last saved to the server. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeLoadOptions; + modified?: boolean; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Gets the name of the user who last saved this version of the shared document to the server. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlapping?: Word.Interfaces.XmlMappingLoadOptions; + modifiedBy?: boolean; + } + /** + * Represents the collection of {@link Word.DocumentLibraryVersion} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface DocumentLibraryVersionCollectionLoadOptions { /** - * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. + Specifying `$all` 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 any optional comments associated with this version of the shared document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - allowInsertDeleteSection?: boolean; + comments?: boolean; /** - * Specifies the appearance of the content control. + * For EACH ITEM in the collection: Gets the date and time at which this version of the shared document was last saved to the server. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: boolean; + modified?: boolean; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * For EACH ITEM in the collection: Gets the name of the user who last saved this version of the shared document to the server. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: boolean; + modifiedBy?: boolean; + } + /** + * Represents a dropped capital letter in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface DropCapLoadOptions { /** - * Returns the identification for the content control. + Specifying `$all` 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 distance (in points) between the dropped capital letter and the paragraph text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: boolean; + distanceFromText?: boolean; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Gets the name of the font for the dropped capital letter. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + fontName?: boolean; /** - * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Gets the height (in lines) of the dropped capital letter. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - level?: boolean; + linesToDrop?: boolean; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Gets the position of the dropped capital letter. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + position?: boolean; + } + /** + * Represents the list formatting characteristics of a range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface ListFormatLoadOptions { /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + Specifying `$all` 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 `List` object that represents the first formatted list contained in the `ListFormat` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list?: Word.Interfaces.ListLoadOptions; + /** + * Gets the list template associated with the `ListFormat` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + listTemplate?: Word.Interfaces.ListTemplateLoadOptions; + /** + * Indicates whether the `ListFormat` object contains a single list. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + isSingleList?: boolean; /** - * Specifies the name of the repeating section items used in the context menu associated with this repeating section content control. + * Indicates whether the `ListFormat` object contains a single list template. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - repeatingSectionItemTitle?: boolean; + isSingleListTemplate?: boolean; /** - * Returns whether the placeholder text for the content control is being displayed. + * Specifies the list level number for the first paragraph for the `ListFormat` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showingPlaceholderText?: boolean; + listLevelNumber?: boolean; /** - * Specifies a tag to identify the content control. + * Gets the string representation of the list value of the first paragraph in the range for the `ListFormat` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: boolean; + listString?: boolean; /** - * Specifies the title for the content control. + * Gets the type of the list for the `ListFormat` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: boolean; + listType?: boolean; + /** + * Gets the numeric value of the the first paragraph in the range for the `ListFormat` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + listValue?: boolean; } /** - * Represents a frame. The `Frame` object is a member of the {@link Word.FrameCollection} object. + * Represents the fill formatting for a shape or text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export interface FrameLoadOptions { + export interface FillFormatLoadOptions { /** Specifying `$all` 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 `Range` object that represents the portion of the document that's contained within the frame. + * Returns a `ColorFormat` object that represents the background color for the fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeLoadOptions; + backgroundColor?: Word.Interfaces.ColorFormatLoadOptions; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. + * Returns a `ColorFormat` object that represents the foreground color for the fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shading?: Word.Interfaces.ShadingUniversalLoadOptions; + foregroundColor?: Word.Interfaces.ColorFormatLoadOptions; /** - * Specifies the height (in points) of the frame. + * Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - height?: boolean; + gradientAngle?: boolean; /** - * Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. + * Gets the gradient color type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - heightRule?: boolean; + gradientColorType?: boolean; /** - * Specifies the horizontal distance between the frame and the surrounding text, in points. + * Returns how dark or light a one-color gradient fill is. + A value of 0 means that black is mixed in with the shape's foreground color to form the gradient. + A value of 1 means that white is mixed in. + Values between 0 and 1 mean that a darker or lighter shade of the foreground color is mixed in. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontalDistanceFromText?: boolean; + gradientDegree?: boolean; /** - * Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property. + * Returns the gradient style for the fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontalPosition?: boolean; + gradientStyle?: boolean; /** - * Specifies if the frame is locked. + * Returns the gradient variant for the fill as an integer value from 1 to 4 for most gradient fills. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockAnchor?: boolean; + gradientVariant?: boolean; /** - * Specifies the relative horizontal position of the frame. + * Specifies if the object, or the formatting applied to it, is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - relativeHorizontalPosition?: boolean; + isVisible?: boolean; /** - * Specifies the relative vertical position of the frame. + * Returns a `PatternType` value that represents the pattern applied to the fill or line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - relativeVerticalPosition?: boolean; + pattern?: boolean; /** - * Specifies if document text wraps around the frame. + * Returns the preset gradient type for the fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textWrap?: boolean; + presetGradientType?: boolean; /** - * Specifies the vertical distance (in points) between the frame and the surrounding text. + * Gets the preset texture. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - verticalDistanceFromText?: boolean; + presetTexture?: boolean; /** - * Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property. + * Specifies whether the fill rotates with the shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - verticalPosition?: boolean; + rotateWithObject?: boolean; /** - * Specifies the width (in points) of the frame. + * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - width?: boolean; + textureAlignment?: boolean; /** - * Specifies the rule used to determine the width of the frame. + * Specifies the horizontal scaling factor for the texture fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - widthRule?: boolean; + textureHorizontalScale?: boolean; + /** + * Returns the name of the custom texture file for the fill. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + textureName?: boolean; + /** + * Specifies the horizontal offset of the texture from the origin in points. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + textureOffsetX?: boolean; + /** + * Specifies the vertical offset of the texture. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + textureOffsetY?: boolean; + /** + * Specifies whether the texture is tiled. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + textureTile?: boolean; + /** + * Returns the texture type for the fill. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + textureType?: boolean; + /** + * Specifies the vertical scaling factor for the texture fill as a value between 0.0 and 1.0. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + textureVerticalScale?: boolean; + /** + * Specifies the degree of transparency of the fill for a shape as a value between 0.0 (opaque) and 1.0 (clear). + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + transparency?: boolean; + /** + * Gets the fill format type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type?: boolean; } /** - * Represents the collection of {@link Word.Frame} objects. + * Represents the glow formatting for the font used by the range of text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export interface FrameCollectionLoadOptions { + export interface GlowFormatLoadOptions { /** Specifying `$all` 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 a `Range` object that represents the portion of the document that's contained within the frame. + * Returns a `ColorFormat` object that represents the color for a glow effect. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeLoadOptions; + color?: Word.Interfaces.ColorFormatLoadOptions; + /** + * Specifies the length of the radius for a glow effect. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + radius?: boolean; + /** + * Specifies the degree of transparency for the glow effect as a value between 0.0 (opaque) and 1.0 (clear). + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + transparency?: boolean; + } + /** + * Represents line and arrowhead formatting. For a line, the `LineFormat` object contains formatting information for the line itself; + for a shape with a border, this object contains formatting information for the shape's border. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface LineFormatLoadOptions { + /** + Specifying `$all` 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 a `ColorFormat` object that represents the background color for a patterned line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + backgroundColor?: Word.Interfaces.ColorFormatLoadOptions; + /** + * Gets a `ColorFormat` object that represents the foreground color for the line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + foregroundColor?: Word.Interfaces.ColorFormatLoadOptions; /** - * For EACH ITEM in the collection: Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. + * Specifies the length of the arrowhead at the beginning of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shading?: Word.Interfaces.ShadingUniversalLoadOptions; + beginArrowheadLength?: boolean; /** - * For EACH ITEM in the collection: Specifies the height (in points) of the frame. + * Specifies the style of the arrowhead at the beginning of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - height?: boolean; + beginArrowheadStyle?: boolean; /** - * For EACH ITEM in the collection: Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. + * Specifies the width of the arrowhead at the beginning of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - heightRule?: boolean; + beginArrowheadWidth?: boolean; /** - * For EACH ITEM in the collection: Specifies the horizontal distance between the frame and the surrounding text, in points. + * Specifies the dash style for the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontalDistanceFromText?: boolean; + dashStyle?: boolean; /** - * For EACH ITEM in the collection: Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property. + * Specifies the length of the arrowhead at the end of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontalPosition?: boolean; + endArrowheadLength?: boolean; /** - * For EACH ITEM in the collection: Specifies if the frame is locked. + * Specifies the style of the arrowhead at the end of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockAnchor?: boolean; + endArrowheadStyle?: boolean; /** - * For EACH ITEM in the collection: Specifies the relative horizontal position of the frame. + * Specifies the width of the arrowhead at the end of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - relativeHorizontalPosition?: boolean; + endArrowheadWidth?: boolean; /** - * For EACH ITEM in the collection: Specifies the relative vertical position of the frame. + * Specifies if to draw lines inside a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - relativeVerticalPosition?: boolean; + insetPen?: boolean; /** - * For EACH ITEM in the collection: Specifies if document text wraps around the frame. + * Specifies if the object, or the formatting applied to it, is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textWrap?: boolean; + isVisible?: boolean; /** - * For EACH ITEM in the collection: Specifies the vertical distance (in points) between the frame and the surrounding text. + * Specifies the pattern applied to the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - verticalDistanceFromText?: boolean; + pattern?: boolean; /** - * For EACH ITEM in the collection: Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property. + * Specifies the line format style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - verticalPosition?: boolean; + style?: boolean; /** - * For EACH ITEM in the collection: Specifies the width (in points) of the frame. + * Specifies the degree of transparency of the line as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - width?: boolean; + transparency?: boolean; /** - * For EACH ITEM in the collection: Specifies the rule used to determine the width of the frame. + * Specifies the thickness of the line in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - widthRule?: boolean; + weight?: boolean; } /** - * Represents a document library version. + * Represents the reflection formatting for a shape in Word. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export interface DocumentLibraryVersionLoadOptions { + export interface ReflectionFormatLoadOptions { /** Specifying `$all` 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 any optional comments associated with this version of the shared document. + * Specifies the degree of blur effect applied to the `ReflectionFormat` object as a value between 0.0 and 100.0. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - comments?: boolean; + blur?: boolean; /** - * Gets the date and time at which this version of the shared document was last saved to the server. + * Specifies the amount of separation, in points, of the reflected image from the shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - modified?: boolean; + offset?: boolean; /** - * Gets the name of the user who last saved this version of the shared document to the server. + * Specifies the size of the reflection as a percentage of the reflected shape from 0 to 100. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - modifiedBy?: boolean; + size?: boolean; + /** + * Specifies the degree of transparency for the reflection effect as a value between 0.0 (opaque) and 1.0 (clear). + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + transparency?: boolean; + /** + * Specifies a `ReflectionType` value that represents the type and direction of the lighting for a shape reflection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type?: boolean; } /** - * Represents the collection of {@link Word.DocumentLibraryVersion} objects. + * Represents the color formatting of a shape or text in Word. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export interface DocumentLibraryVersionCollectionLoadOptions { + export interface ColorFormatLoadOptions { /** Specifying `$all` 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 any optional comments associated with this version of the shared document. + * Specifies the brightness of a specified shape color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - comments?: boolean; + brightness?: boolean; /** - * For EACH ITEM in the collection: Gets the date and time at which this version of the shared document was last saved to the server. + * Specifies the theme color for a color format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - modified?: boolean; + objectThemeColor?: boolean; /** - * For EACH ITEM in the collection: Gets the name of the user who last saved this version of the shared document to the server. + * Specifies the red-green-blue (RGB) value of the specified color. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - modifiedBy?: boolean; + rgb?: boolean; + /** + * Specifies the lightening or darkening of a specified shape's color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tintAndShade?: boolean; + /** + * Returns the shape color type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type?: boolean; } /** - * Represents a dropped capital letter in a Word document. + * Represents the shadow formatting for a shape or text in Word. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export interface DropCapLoadOptions { + export interface ShadowFormatLoadOptions { /** Specifying `$all` 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 distance (in points) between the dropped capital letter and the paragraph text. + * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - distanceFromText?: boolean; + foregroundColor?: Word.Interfaces.ColorFormatLoadOptions; /** - * Gets the name of the font for the dropped capital letter. + * Specifies the blur level for a shadow format as a value between 0.0 and 100.0. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fontName?: boolean; + blur?: boolean; /** - * Gets the height (in lines) of the dropped capital letter. + * Specifies whether the object or the formatting applied to it is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - linesToDrop?: boolean; + isVisible?: boolean; /** - * Gets the position of the dropped capital letter. + * Specifies `true` if the shadow of the shape appears filled in and is obscured by the shape, even if the shape has no fill, + `false` if the shadow has no fill and the outline of the shadow is visible through the shape if the shape has no fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - position?: boolean; - } - /** - * Represents the list formatting characteristics of a range. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface ListFormatLoadOptions { + obscured?: boolean; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * Specifies the horizontal offset (in points) of the shadow from the shape. + A positive value offsets the shadow to the right of the shape; a negative value offsets it to the left. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; - /** - * Returns a `List` object that represents the first formatted list contained in the `ListFormat` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - list?: Word.Interfaces.ListLoadOptions; - /** - * Gets the list template associated with the `ListFormat` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - listTemplate?: Word.Interfaces.ListTemplateLoadOptions; + offsetX?: boolean; /** - * Indicates whether the `ListFormat` object contains a single list. + * Specifies the vertical offset (in points) of the shadow from the shape. + A positive value offsets the shadow to the top of the shape; a negative value offsets it to the bottom. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isSingleList?: boolean; + offsetY?: boolean; /** - * Indicates whether the `ListFormat` object contains a single list template. + * Specifies whether to rotate the shadow when rotating the shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isSingleListTemplate?: boolean; + rotateWithShape?: boolean; /** - * Specifies the list level number for the first paragraph for the `ListFormat` object. + * Specifies the width of the shadow. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listLevelNumber?: boolean; + size?: boolean; /** - * Gets the string representation of the list value of the first paragraph in the range for the `ListFormat` object. + * Specifies the type of shadow formatting to apply to a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listString?: boolean; + style?: boolean; /** - * Gets the type of the list for the `ListFormat` object. + * Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listType?: boolean; + transparency?: boolean; /** - * Gets the numeric value of the the first paragraph in the range for the `ListFormat` object. + * Specifies the shape shadow type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listValue?: boolean; + type?: boolean; } /** - * Represents the fill formatting for a shape or text. + * Represents a shape's three-dimensional formatting. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export interface FillFormatLoadOptions { + export interface ThreeDimensionalFormatLoadOptions { /** Specifying `$all` 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 `ColorFormat` object that represents the background color for the fill. + * Returns a `ColorFormat` object that represents color of the contour of a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - backgroundColor?: Word.Interfaces.ColorFormatLoadOptions; + contourColor?: Word.Interfaces.ColorFormatLoadOptions; /** - * Returns a `ColorFormat` object that represents the foreground color for the fill. + * Returns a `ColorFormat` object that represents the color of the shape's extrusion. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - foregroundColor?: Word.Interfaces.ColorFormatLoadOptions; + extrusionColor?: Word.Interfaces.ColorFormatLoadOptions; /** - * Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9. + * Specifies the depth of the bottom bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gradientAngle?: boolean; + bevelBottomDepth?: boolean; /** - * Gets the gradient color type. + * Specifies the inset size for the bottom bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gradientColorType?: boolean; + bevelBottomInset?: boolean; /** - * Returns how dark or light a one-color gradient fill is. - A value of 0 means that black is mixed in with the shape's foreground color to form the gradient. - A value of 1 means that white is mixed in. - Values between 0 and 1 mean that a darker or lighter shade of the foreground color is mixed in. + * Specifies a `BevelType` value that represents the bevel type for the bottom bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gradientDegree?: boolean; + bevelBottomType?: boolean; /** - * Returns the gradient style for the fill. + * Specifies the depth of the top bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gradientStyle?: boolean; + bevelTopDepth?: boolean; /** - * Returns the gradient variant for the fill as an integer value from 1 to 4 for most gradient fills. + * Specifies the inset size for the top bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gradientVariant?: boolean; + bevelTopInset?: boolean; /** - * Specifies if the object, or the formatting applied to it, is visible. + * Specifies a `BevelType` value that represents the bevel type for the top bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + bevelTopType?: boolean; /** - * Returns a `PatternType` value that represents the pattern applied to the fill or line. + * Specifies the width of the contour of a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pattern?: boolean; + contourWidth?: boolean; /** - * Returns the preset gradient type for the fill. + * Specifies the depth of the shape's extrusion. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetGradientType?: boolean; + depth?: boolean; /** - * Gets the preset texture. + * Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion) + and automatically changes when the shape's fill changes, or whether the extrusion color is independent of the shape's fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetTexture?: boolean; + extrusionColorType?: boolean; /** - * Specifies whether the fill rotates with the shape. + * Specifies the amount of perspective for a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotateWithObject?: boolean; + fieldOfView?: boolean; /** - * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. + * Specifies `true` if the extrusion appears in perspective — that is, if the walls of the extrusion narrow toward a vanishing point, + `false` if the extrusion is a parallel, or orthographic, projection — that is, if the walls don't narrow toward a vanishing point. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureAlignment?: boolean; + isPerspective?: boolean; /** - * Specifies the horizontal scaling factor for the texture fill. + * Specifies if the specified object, or the formatting applied to it, is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureHorizontalScale?: boolean; + isVisible?: boolean; /** - * Returns the name of the custom texture file for the fill. + * Specifies the angle of the lighting. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureName?: boolean; + lightAngle?: boolean; /** - * Specifies the horizontal offset of the texture from the origin in points. + * Returns a `PresetCamera` value that represents the camera presets. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureOffsetX?: boolean; + presetCamera?: boolean; /** - * Specifies the vertical offset of the texture. + * Returns the direction taken by the extrusion's sweep path leading away from the extruded shape (the front face of the extrusion). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureOffsetY?: boolean; + presetExtrusionDirection?: boolean; /** - * Specifies whether the texture is tiled. + * Specifies a `LightRigType` value that represents the lighting preset. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureTile?: boolean; + presetLighting?: boolean; /** - * Returns the texture type for the fill. + * Specifies the position of the light source relative to the extrusion. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureType?: boolean; + presetLightingDirection?: boolean; /** - * Specifies the vertical scaling factor for the texture fill as a value between 0.0 and 1.0. + * Specifies the intensity of the extrusion lighting. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureVerticalScale?: boolean; + presetLightingSoftness?: boolean; /** - * Specifies the degree of transparency of the fill for a shape as a value between 0.0 (opaque) and 1.0 (clear). + * Specifies the extrusion surface material. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency?: boolean; + presetMaterial?: boolean; /** - * Gets the fill format type. + * Returns the preset extrusion format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: boolean; - } - /** - * Represents the glow formatting for the font used by the range of text. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface GlowFormatLoadOptions { + presetThreeDimensionalFormat?: boolean; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * Specifies whether text on a shape rotates with shape. `true` rotates the text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + projectText?: boolean; /** - * Returns a `ColorFormat` object that represents the color for a glow effect. + * Specifies the rotation of the extruded shape around the x-axis in degrees. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: Word.Interfaces.ColorFormatLoadOptions; + rotationX?: boolean; /** - * Specifies the length of the radius for a glow effect. + * Specifies the rotation of the extruded shape around the y-axis in degrees. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - radius?: boolean; + rotationY?: boolean; /** - * Specifies the degree of transparency for the glow effect as a value between 0.0 (opaque) and 1.0 (clear). + * Specifies the z-axis rotation of the camera. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency?: boolean; + rotationZ?: boolean; + /** + * Specifies the position on the z-axis for the shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + z?: boolean; } /** - * Represents line and arrowhead formatting. For a line, the `LineFormat` object contains formatting information for the line itself; - for a shape with a border, this object contains formatting information for the shape's border. + * Represents the list of available sources attached to the document (in the current list) or the list of sources available in the application (in the master list). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export interface LineFormatLoadOptions { + export interface BibliographyLoadOptions { /** Specifying `$all` 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 a `ColorFormat` object that represents the background color for a patterned line. + * Specifies the name of the active style to use for the bibliography. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - backgroundColor?: Word.Interfaces.ColorFormatLoadOptions; + bibliographyStyle?: boolean; + } + /** + * Represents a collection of {@link Word.Source} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface SourceCollectionLoadOptions { /** - * Gets a `ColorFormat` object that represents the foreground color for the line. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ - foregroundColor?: Word.Interfaces.ColorFormatLoadOptions; + $all?: boolean; /** - * Specifies the length of the arrowhead at the beginning of the line. + * For EACH ITEM in the collection: Gets if the `Source` object has been cited in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - beginArrowheadLength?: boolean; + isCited?: boolean; /** - * Specifies the style of the arrowhead at the beginning of the line. + * For EACH ITEM in the collection: Gets the tag of the source. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - beginArrowheadStyle?: boolean; + tag?: boolean; /** - * Specifies the width of the arrowhead at the beginning of the line. + * For EACH ITEM in the collection: Gets the XML representation of the source. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - beginArrowheadWidth?: boolean; + xml?: boolean; + } + /** + * Represents an individual source, such as a book, journal article, or interview. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface SourceLoadOptions { /** - * Specifies the dash style for the line. + Specifying `$all` 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 if the `Source` object has been cited in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashStyle?: boolean; + isCited?: boolean; /** - * Specifies the length of the arrowhead at the end of the line. + * Gets the tag of the source. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endArrowheadLength?: boolean; + tag?: boolean; /** - * Specifies the style of the arrowhead at the end of the line. + * Gets the XML representation of the source. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endArrowheadStyle?: boolean; + xml?: boolean; + } + /** + * Represents the page setup settings for a Word document or section. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface PageSetupLoadOptions { /** - * Specifies the width of the arrowhead at the end of the line. + Specifying `$all` 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 a `LineNumbering` object that represents the line numbers for the `PageSetup` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endArrowheadWidth?: boolean; + lineNumbering?: Word.Interfaces.LineNumberingLoadOptions; /** - * Specifies if to draw lines inside a shape. + * Specifies whether Microsoft Word prints the document as a booklet. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - insetPen?: boolean; + bookFoldPrinting?: boolean; /** - * Specifies if the object, or the formatting applied to it, is visible. + * Specifies the number of pages for each booklet. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + bookFoldPrintingSheets?: boolean; /** - * Specifies the pattern applied to the line. + * Specifies if Microsoft Word reverses the printing order for book fold printing of bidirectional or Asian language documents. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pattern?: boolean; + bookFoldReversePrinting?: boolean; /** - * Specifies the line format style. + * Specifies the distance (in points) between the bottom edge of the page and the bottom boundary of the body text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - style?: boolean; + bottomMargin?: boolean; /** - * Specifies the degree of transparency of the line as a value between 0.0 (opaque) and 1.0 (clear). + * Specifies the number of characters per line in the document grid. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency?: boolean; + charsLine?: boolean; /** - * Specifies the thickness of the line in points. + * Specifies whether the first page has a different header and footer. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - weight?: boolean; - } - /** - * Represents the reflection formatting for a shape in Word. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface ReflectionFormatLoadOptions { - /** - Specifying `$all` 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; + differentFirstPageHeaderFooter?: boolean; /** - * Specifies the degree of blur effect applied to the `ReflectionFormat` object as a value between 0.0 and 100.0. + * Specifies the distance between the footer and the bottom of the page in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - blur?: boolean; + footerDistance?: boolean; /** - * Specifies the amount of separation, in points, of the reflected image from the shape. + * Specifies the amount (in points) of extra margin space added to each page in a document or section for binding. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - offset?: boolean; + gutter?: boolean; /** - * Specifies the size of the reflection as a percentage of the reflected shape from 0 to 100. + * Specifies on which side the gutter appears in a document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - size?: boolean; + gutterPosition?: boolean; /** - * Specifies the degree of transparency for the reflection effect as a value between 0.0 (opaque) and 1.0 (clear). + * Specifies whether Microsoft Word uses gutters for the current document based on a right-to-left language or a left-to-right language. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency?: boolean; + gutterStyle?: boolean; /** - * Specifies a `ReflectionType` value that represents the type and direction of the lighting for a shape reflection. + * Specifies the distance between the header and the top of the page in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: boolean; - } - /** - * Represents the color formatting of a shape or text in Word. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface ColorFormatLoadOptions { - /** - Specifying `$all` 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; + headerDistance?: boolean; /** - * Specifies the brightness of a specified shape color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. + * Specifies the layout mode for the current document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - brightness?: boolean; + layoutMode?: boolean; /** - * Specifies the theme color for a color format. + * Specifies the distance (in points) between the left edge of the page and the left boundary of the body text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - objectThemeColor?: boolean; + leftMargin?: boolean; /** - * Specifies the red-green-blue (RGB) value of the specified color. You can provide the value in the '#RRGGBB' format. + * Specifies the number of lines per page in the document grid. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rgb?: boolean; + linesPage?: boolean; /** - * Specifies the lightening or darkening of a specified shape's color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. + * Specifies if the inside and outside margins of facing pages are the same width. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tintAndShade?: boolean; + mirrorMargins?: boolean; /** - * Returns the shape color type. + * Specifies whether odd and even pages have different headers and footers. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: boolean; - } - /** - * Represents the shadow formatting for a shape or text in Word. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface ShadowFormatLoadOptions { + oddAndEvenPagesHeaderFooter?: boolean; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * Specifies the orientation of the page. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + orientation?: boolean; /** - * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. + * Specifies the page height in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - foregroundColor?: Word.Interfaces.ColorFormatLoadOptions; + pageHeight?: boolean; /** - * Specifies the blur level for a shadow format as a value between 0.0 and 100.0. + * Specifies the page width in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - blur?: boolean; + pageWidth?: boolean; /** - * Specifies whether the object or the formatting applied to it is visible. + * Specifies the paper size of the page. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + paperSize?: boolean; /** - * Specifies `true` if the shadow of the shape appears filled in and is obscured by the shape, even if the shape has no fill, - `false` if the shadow has no fill and the outline of the shadow is visible through the shape if the shape has no fill. + * Specifies the distance (in points) between the right edge of the page and the right boundary of the body text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - obscured?: boolean; + rightMargin?: boolean; /** - * Specifies the horizontal offset (in points) of the shadow from the shape. - A positive value offsets the shadow to the right of the shape; a negative value offsets it to the left. + * Specifies the reading order and alignment for the specified sections. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - offsetX?: boolean; + sectionDirection?: boolean; /** - * Specifies the vertical offset (in points) of the shadow from the shape. - A positive value offsets the shadow to the top of the shape; a negative value offsets it to the bottom. + * Specifies the type of section break for the specified object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - offsetY?: boolean; + sectionStart?: boolean; /** - * Specifies whether to rotate the shadow when rotating the shape. + * Specifies whether to show the grid. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotateWithShape?: boolean; + showGrid?: boolean; /** - * Specifies the width of the shadow. + * Specifies if endnotes are printed at the end of the next section that doesn't suppress endnotes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - size?: boolean; + suppressEndnotes?: boolean; /** - * Specifies the type of shadow formatting to apply to a shape. + * Specifies the top margin of the page in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - style?: boolean; + topMargin?: boolean; /** - * Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear). + * Specifies whether to print two pages per sheet. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency?: boolean; + twoPagesOnOne?: boolean; /** - * Specifies the shape shadow type. + * Specifies the vertical alignment of text on each page in a document or section. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: boolean; + verticalAlignment?: boolean; } /** - * Represents a shape's three-dimensional formatting. + * Represents line numbers in the left margin or to the left of each newspaper-style column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export interface ThreeDimensionalFormatLoadOptions { + export interface LineNumberingLoadOptions { /** Specifying `$all` 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 `ColorFormat` object that represents color of the contour of a shape. + * Specifies the numeric increment for line numbers. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contourColor?: Word.Interfaces.ColorFormatLoadOptions; + countBy?: boolean; /** - * Returns a `ColorFormat` object that represents the color of the shape's extrusion. + * Specifies the distance (in points) between the right edge of line numbers and the left edge of the document text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - extrusionColor?: Word.Interfaces.ColorFormatLoadOptions; + distanceFromText?: boolean; /** - * Specifies the depth of the bottom bevel. + * Specifies if line numbering is active for the specified document, section, or sections. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelBottomDepth?: boolean; + isActive?: boolean; /** - * Specifies the inset size for the bottom bevel. + * Specifies the way line numbering runs; that is, whether it starts over at the beginning of a new page or section, or runs continuously. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelBottomInset?: boolean; + restartMode?: boolean; /** - * Specifies a `BevelType` value that represents the bevel type for the bottom bevel. + * Specifies the starting line number. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelBottomType?: boolean; + startingNumber?: boolean; + } + /** + * A collection of {@link Word.TextColumn} objects that represent all the columns of text in the document or a section of the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface TextColumnCollectionLoadOptions { /** - * Specifies the depth of the top bevel. + Specifying `$all` 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 amount of spacing (in points) after the specified paragraph or text column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelTopDepth?: boolean; + spaceAfter?: boolean; /** - * Specifies the inset size for the top bevel. + * For EACH ITEM in the collection: Specifies the width, in points, of the specified text columns. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelTopInset?: boolean; + width?: boolean; + } + /** + * Represents a single text column in a section. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface TextColumnLoadOptions { /** - * Specifies a `BevelType` value that represents the bevel type for the top bevel. + Specifying `$all` 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 amount of spacing (in points) after the specified paragraph or text column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelTopType?: boolean; + spaceAfter?: boolean; /** - * Specifies the width of the contour of a shape. + * Specifies the width, in points, of the specified text columns. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contourWidth?: boolean; + width?: boolean; + } + /** + * Represents a selected range or the insertion point in a Word document. + + - Note: {@link Word.Range | Range} objects share many of the same methods and properties as `Selection` objects. Using `Range` objects is preferable for manipulating a document when there isn't a reason to physically change the current selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface SelectionLoadOptions { /** - * Specifies the depth of the shape's extrusion. + Specifying `$all` 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 `Font` object that represents the character formatting of the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - depth?: boolean; + font?: Word.Interfaces.FontLoadOptions; /** - * Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion) - and automatically changes when the shape's fill changes, or whether the extrusion color is independent of the shape's fill. + * Specifies a `Range` object that includes the formatted text in the range or selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - extrusionColorType?: boolean; + formattedText?: Word.Interfaces.RangeLoadOptions; /** - * Specifies the amount of perspective for a shape. + * Returns the `Range` object for the portion of the document contained in the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fieldOfView?: boolean; + range?: Word.Interfaces.RangeLoadOptions; /** - * Specifies `true` if the extrusion appears in perspective — that is, if the walls of the extrusion narrow toward a vanishing point, - `false` if the extrusion is a parallel, or orthographic, projection — that is, if the walls don't narrow toward a vanishing point. + * Returns the `ShadingUniversal` object for the shading formatting for the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isPerspective?: boolean; + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - * Specifies if the specified object, or the formatting applied to it, is visible. + * Specifies the ending character position of the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + end?: boolean; /** - * Specifies the angle of the lighting. + * Specifies the width in which Word fits the text in the current selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lightAngle?: boolean; + fitTextWidth?: boolean; /** - * Returns a `PresetCamera` value that represents the camera presets. + * Returns whether the spelling and grammar checker ignores the selected text. + If the selected text contains a mix of proofed and un-proofed content, this API returns `null`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetCamera?: boolean; + hasNoProofing?: boolean; /** - * Returns the direction taken by the extrusion's sweep path leading away from the extruded shape (the front face of the extrusion). + * Returns whether the selection in the specified window or pane is active. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetExtrusionDirection?: boolean; + isActive?: boolean; /** - * Specifies a `LightRigType` value that represents the lighting preset. + * Specifies whether column selection mode is active. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetLighting?: boolean; + isColumnSelectModeActive?: boolean; /** - * Specifies the position of the light source relative to the extrusion. + * Returns whether the selection is at the end-of-row mark in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetLightingDirection?: boolean; + isEndOfRowMark?: boolean; /** - * Specifies the intensity of the extrusion lighting. + * Specifies whether Extend mode is active. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetLightingSoftness?: boolean; + isExtendModeActive?: boolean; /** - * Specifies the extrusion surface material. + * Returns whether the insertion point is at the end of a line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetMaterial?: boolean; + isInsertionPointAtEndOfLine?: boolean; /** - * Returns the preset extrusion format. + * Specifies whether the beginning of the selection is active. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetThreeDimensionalFormat?: boolean; + isStartActive?: boolean; /** - * Specifies whether text on a shape rotates with shape. `true` rotates the text. + * Specifies whether Word has detected the language of the selected text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - projectText?: boolean; + languageDetected?: boolean; /** - * Specifies the rotation of the extruded shape around the x-axis in degrees. + * Returns the language for the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotationX?: boolean; + languageId?: boolean; /** - * Specifies the rotation of the extruded shape around the y-axis in degrees. + * Returns the East Asian language for the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotationY?: boolean; + languageIdFarEast?: boolean; /** - * Specifies the z-axis rotation of the camera. + * Returns the language for the selection that isn't classified as an East Asian language. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotationZ?: boolean; + languageIdOther?: boolean; /** - * Specifies the position on the z-axis for the shape. + * Specifies the orientation of text in the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - z?: boolean; - } - /** - * Represents the list of available sources attached to the document (in the current list) or the list of sources available in the application (in the master list). - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface BibliographyLoadOptions { - /** - Specifying `$all` 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; + orientation?: boolean; /** - * Specifies the name of the active style to use for the bibliography. + * Specifies the starting character position of the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bibliographyStyle?: boolean; - } - /** - * Represents a collection of {@link Word.Source} objects. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface SourceCollectionLoadOptions { + start?: boolean; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * Returns the number of characters in the story that contains the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + storyLength?: boolean; /** - * For EACH ITEM in the collection: Gets if the `Source` object has been cited in the document. + * Returns the story type for the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isCited?: boolean; + storyType?: boolean; /** - * For EACH ITEM in the collection: Gets the tag of the source. + * Specifies the text in the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: boolean; + text?: boolean; /** - * For EACH ITEM in the collection: Gets the XML representation of the source. + * Returns the selection type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xml?: boolean; + type?: boolean; } /** - * Represents an individual source, such as a book, journal article, or interview. + * Represents a collection of {@link Word.Range} objects that represents each character, word or sentence. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - export interface SourceLoadOptions { + export interface RangeScopedCollectionLoadOptions { /** Specifying `$all` 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 if the `Source` object has been cited in the document. + * For EACH ITEM in the collection: Gets the text format of the range. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - isCited?: boolean; + font?: Word.Interfaces.FontLoadOptions; /** - * Gets the tag of the source. + * For EACH ITEM in the collection: Returns a `ListFormat` object that represents all the list formatting characteristics of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: boolean; + listFormat?: Word.Interfaces.ListFormatLoadOptions; /** - * Gets the XML representation of the source. + * For EACH ITEM in the collection: Gets the parent body of the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - xml?: boolean; - } - /** - * Represents the page setup settings for a Word document or section. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface PageSetupLoadOptions { + parentBody?: Word.Interfaces.BodyLoadOptions; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * For EACH ITEM in the collection: Gets the currently supported content control that contains the range. Throws an `ItemNotFound` error if there isn't a parent content control. + * + * @remarks + * [Api set: WordApi 1.1] */ - $all?: boolean; + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object. + * For EACH ITEM in the collection: Gets the currently supported content control that contains the range. If there isn't a parent content control, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - lineNumbering?: Word.Interfaces.LineNumberingLoadOptions; + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Specifies whether Microsoft Word prints the document as a booklet. + * For EACH ITEM in the collection: Gets the table that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - bookFoldPrinting?: boolean; + parentTable?: Word.Interfaces.TableLoadOptions; /** - * Specifies the number of pages for each booklet. + * For EACH ITEM in the collection: Gets the table cell that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table cell. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - bookFoldPrintingSheets?: boolean; + parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * Specifies if Microsoft Word reverses the printing order for book fold printing of bidirectional or Asian language documents. + * For EACH ITEM in the collection: Gets the table cell that contains the range. If it isn't contained in a table cell, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - bookFoldReversePrinting?: boolean; + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * Specifies the distance (in points) between the bottom edge of the page and the bottom boundary of the body text. + * For EACH ITEM in the collection: Gets the table that contains the range. If it isn't contained in a table, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - bottomMargin?: boolean; + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * Specifies the number of characters per line in the document grid. + * For EACH ITEM in the collection: Returns a `ShadingUniversal` object that refers to the shading formatting for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - charsLine?: boolean; + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - * Specifies whether the first page has a different header and footer. + * For EACH ITEM in the collection: Specifies whether the range is formatted as bold. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - differentFirstPageHeaderFooter?: boolean; + bold?: boolean; /** - * Specifies the distance between the footer and the bottom of the page in points. + * For EACH ITEM in the collection: Specifies whether the range is formatted as bold in a right-to-left language document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footerDistance?: boolean; + boldBidirectional?: boolean; /** - * Specifies the amount (in points) of extra margin space added to each page in a document or section for binding. + * For EACH ITEM in the collection: Specifies a `CharacterCase` value that represents the case of the text in the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gutter?: boolean; + case?: boolean; /** - * Specifies on which side the gutter appears in a document. + * For EACH ITEM in the collection: Specifies the character width of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gutterPosition?: boolean; + characterWidth?: boolean; /** - * Specifies whether Microsoft Word uses gutters for the current document based on a right-to-left language or a left-to-right language. + * For EACH ITEM in the collection: Specifies if the range contains combined characters. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gutterStyle?: boolean; + combineCharacters?: boolean; /** - * Specifies the distance between the header and the top of the page in points. + * For EACH ITEM in the collection: Specifies if Microsoft Word ignores the number of characters per line for the corresponding `Range` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - headerDistance?: boolean; + disableCharacterSpaceGrid?: boolean; /** - * Specifies the layout mode for the current document. + * For EACH ITEM in the collection: Specifies the emphasis mark for a character or designated character string. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - layoutMode?: boolean; + emphasisMark?: boolean; /** - * Specifies the distance (in points) between the left edge of the page and the left boundary of the body text. + * For EACH ITEM in the collection: Specifies the ending character position of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - leftMargin?: boolean; + end?: boolean; /** - * Specifies the number of lines per page in the document grid. + * For EACH ITEM in the collection: Specifies the width (in the current measurement units) in which Microsoft Word fits the text in the current selection or range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - linesPage?: boolean; + fitTextWidth?: boolean; /** - * Specifies if the inside and outside margins of facing pages are the same width. + * For EACH ITEM in the collection: Specifies if a grammar check has been run on the range or document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mirrorMargins?: boolean; + grammarChecked?: boolean; /** - * Specifies whether odd and even pages have different headers and footers. + * For EACH ITEM in the collection: Specifies the proofing status (spelling and grammar checking) of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - oddAndEvenPagesHeaderFooter?: boolean; + hasNoProofing?: boolean; /** - * Specifies the orientation of the page. + * For EACH ITEM in the collection: Specifies the highlight color for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - orientation?: boolean; + highlightColorIndex?: boolean; /** - * Specifies the page height in points. + * For EACH ITEM in the collection: Specifies the formatting for horizontal text set within vertical text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageHeight?: boolean; + horizontalInVertical?: boolean; /** - * Specifies the page width in points. + * For EACH ITEM in the collection: Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. Use a '#' to separate the address part from the optional location part. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - pageWidth?: boolean; + hyperlink?: boolean; /** - * Specifies the paper size of the page. + * For EACH ITEM in the collection: Specifies the ID for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - paperSize?: boolean; + id?: boolean; /** - * Specifies the distance (in points) between the right edge of the page and the right boundary of the body text. + * For EACH ITEM in the collection: Checks whether the range length is zero. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - rightMargin?: boolean; + isEmpty?: boolean; /** - * Specifies the reading order and alignment for the specified sections. + * For EACH ITEM in the collection: Gets if the range is collapsed and is located at the end-of-row mark in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sectionDirection?: boolean; + isEndOfRowMark?: boolean; /** - * Specifies the type of section break for the specified object. + * For EACH ITEM in the collection: Gets whether the text in the range is visible on the screen. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sectionStart?: boolean; + isTextVisibleOnScreen?: boolean; /** - * Specifies whether to show the grid. + * For EACH ITEM in the collection: Specifies if the font or range is formatted as italic. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showGrid?: boolean; + italic?: boolean; /** - * Specifies if endnotes are printed at the end of the next section that doesn't suppress endnotes. + * For EACH ITEM in the collection: Specifies if the font or range is formatted as italic (right-to-left languages). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - suppressEndnotes?: boolean; + italicBidirectional?: boolean; /** - * Specifies the top margin of the page in points. + * For EACH ITEM in the collection: Specifies whether the range of Japanese language text is hiragana or katakana. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - topMargin?: boolean; + kana?: boolean; /** - * Specifies whether to print two pages per sheet. + * For EACH ITEM in the collection: Specifies whether Microsoft Word has detected the language of the text in the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - twoPagesOnOne?: boolean; + languageDetected?: boolean; /** - * Specifies the vertical alignment of text on each page in a document or section. + * For EACH ITEM in the collection: Specifies a `LanguageId` value that represents the language for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - verticalAlignment?: boolean; - } - /** - * Represents line numbers in the left margin or to the left of each newspaper-style column. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface LineNumberingLoadOptions { - /** - Specifying `$all` 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; + languageId?: boolean; /** - * Specifies the numeric increment for line numbers. + * For EACH ITEM in the collection: Specifies an East Asian language for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - countBy?: boolean; + languageIdFarEast?: boolean; /** - * Specifies the distance (in points) between the right edge of line numbers and the left edge of the document text. + * For EACH ITEM in the collection: Specifies a language for the range that isn't classified as an East Asian language. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - distanceFromText?: boolean; + languageIdOther?: boolean; /** - * Specifies if line numbering is active for the specified document, section, or sections. + * For EACH ITEM in the collection: Specifies if all nonprinting characters (such as hidden text, tab marks, space marks, and paragraph marks) are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isActive?: boolean; + showAll?: boolean; /** - * Specifies the way line numbering runs; that is, whether it starts over at the beginning of a new page or section, or runs continuously. + * For EACH ITEM in the collection: Specifies if spelling has been checked throughout the range or document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - restartMode?: boolean; + spellingChecked?: boolean; /** - * Specifies the starting line number. + * For EACH ITEM in the collection: Specifies the starting character position of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - startingNumber?: boolean; - } - /** - * A collection of {@link Word.TextColumn} objects that represent all the columns of text in the document or a section of the document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface TextColumnCollectionLoadOptions { - /** - Specifying `$all` 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; + start?: boolean; /** - * For EACH ITEM in the collection: Specifies the amount of spacing (in points) after the specified paragraph or text column. + * For EACH ITEM in the collection: Gets the number of characters in the story that contains the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spaceAfter?: boolean; + storyLength?: boolean; /** - * For EACH ITEM in the collection: Specifies the width, in points, of the specified text columns. + * For EACH ITEM in the collection: Gets the story type for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - width?: boolean; - } - /** - * Represents a single text column in a section. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - export interface TextColumnLoadOptions { + storyType?: boolean; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * For EACH ITEM in the collection: Specifies the style name for the range. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * + * @remarks + * [Api set: WordApi 1.1] */ - $all?: boolean; + style?: boolean; /** - * Specifies the amount of spacing (in points) after the specified paragraph or text column. + * For EACH ITEM in the collection: Specifies the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBuiltIn?: boolean; + /** + * For EACH ITEM in the collection: Gets the text of the range. + * + * @remarks + * [Api set: WordApi 1.1] + */ + text?: boolean; + /** + * For EACH ITEM in the collection: Specifies whether Microsoft Word sets two lines of text in one and specifies the characters that enclose the text, if any. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spaceAfter?: boolean; + twoLinesInOne?: boolean; /** - * Specifies the width, in points, of the specified text columns. + * For EACH ITEM in the collection: Specifies the type of underline applied to the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - width?: boolean; + underline?: boolean; } /** * Represents a single bookmark in a document, selection, or range. The `Bookmark` object is a member of the `Bookmark` collection. @@ -62727,6 +74098,34 @@ export declare namespace Word { */ type?: boolean; } + /** + * Contains a collection of {@link Word.ListTemplate} objects in a document, list template gallery, or document template. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + export interface ListTemplateCollectionLoadOptions { + /** + Specifying `$all` 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 name of the list template. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + name?: boolean; + /** + * For EACH ITEM in the collection: Specifies whether the list template is outline numbered. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + outlineNumbered?: boolean; + } } } export declare namespace Word { diff --git a/generate-docs/configs/excel-1_1-config.json b/generate-docs/configs/excel-1_1-config.json index 73079ddf18..084554dbce 100644 --- a/generate-docs/configs/excel-1_1-config.json +++ b/generate-docs/configs/excel-1_1-config.json @@ -1,19 +1,34 @@ { - "excludedFieldPatterns": [ - "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" - ], - "excludedFieldNames": [ - "load", - "set", - "toJSON", - "context", - "track", - "untrack" - ], - "excludedClassPatterns": [ - "LoadOptions$", - "Data$" - ], - "includeStaticFields": false, - "includeEnums": false -} \ No newline at end of file + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/excel", + "description": "Standard URL pattern for Excel APIs", + "globalFunctionTemplate": "/javascript/api/excel/#excel-excel-{fieldName}-function(1)", + "interfaceMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/excel/excel.{className}", + "name": "Excel Standard Pattern", + "classTemplate": "/javascript/api/excel/excel.{className}", + "interfaceTemplate": "/javascript/api/excel/excel.{className}", + "enumMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}", + "enumTemplate": "/javascript/api/excel/excel.{className}" + } + ] +} diff --git a/generate-docs/configs/excel-1_10-config.json b/generate-docs/configs/excel-1_10-config.json index 949dd854ab..084554dbce 100644 --- a/generate-docs/configs/excel-1_10-config.json +++ b/generate-docs/configs/excel-1_10-config.json @@ -1,19 +1,34 @@ { - "excludedFieldPatterns": [ - "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" - ], - "excludedFieldNames": [ - "load", - "set", - "toJSON", - "context", - "track", - "untrack" - ], - "excludedClassPatterns": [ - "LoadOptions$", - "Data$" - ], - "includeStaticFields": false, - "includeEnums": false + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/excel", + "description": "Standard URL pattern for Excel APIs", + "globalFunctionTemplate": "/javascript/api/excel/#excel-excel-{fieldName}-function(1)", + "interfaceMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/excel/excel.{className}", + "name": "Excel Standard Pattern", + "classTemplate": "/javascript/api/excel/excel.{className}", + "interfaceTemplate": "/javascript/api/excel/excel.{className}", + "enumMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}", + "enumTemplate": "/javascript/api/excel/excel.{className}" + } + ] } diff --git a/generate-docs/configs/excel-1_11-config.json b/generate-docs/configs/excel-1_11-config.json index 2f9837a9b2..90ea6d8ea9 100644 --- a/generate-docs/configs/excel-1_11-config.json +++ b/generate-docs/configs/excel-1_11-config.json @@ -1,26 +1,41 @@ { - "replacements": [ - { - "find": "content: CommentRichContent | string,", - "replace": "content: string,", - "description": "Address CommentRichContent reference for when removing ExcelApi 1.11" - } - ], - "excludedFieldPatterns": [ - "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" - ], - "excludedFieldNames": [ - "load", - "set", - "toJSON", - "context", - "track", - "untrack" - ], - "excludedClassPatterns": [ - "LoadOptions$", - "Data$" - ], - "includeStaticFields": false, - "includeEnums": false + "replacements": [ + { + "find": "content: CommentRichContent | string,", + "replace": "content: string,", + "description": "Address CommentRichContent reference for when removing ExcelApi 1.11" + } + ], + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/excel", + "description": "Standard URL pattern for Excel APIs", + "globalFunctionTemplate": "/javascript/api/excel/#excel-excel-{fieldName}-function(1)", + "interfaceMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/excel/excel.{className}", + "name": "Excel Standard Pattern", + "classTemplate": "/javascript/api/excel/excel.{className}", + "interfaceTemplate": "/javascript/api/excel/excel.{className}", + "enumMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}", + "enumTemplate": "/javascript/api/excel/excel.{className}" + } + ] } diff --git a/generate-docs/configs/excel-1_12-config.json b/generate-docs/configs/excel-1_12-config.json index 949dd854ab..084554dbce 100644 --- a/generate-docs/configs/excel-1_12-config.json +++ b/generate-docs/configs/excel-1_12-config.json @@ -1,19 +1,34 @@ { - "excludedFieldPatterns": [ - "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" - ], - "excludedFieldNames": [ - "load", - "set", - "toJSON", - "context", - "track", - "untrack" - ], - "excludedClassPatterns": [ - "LoadOptions$", - "Data$" - ], - "includeStaticFields": false, - "includeEnums": false + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/excel", + "description": "Standard URL pattern for Excel APIs", + "globalFunctionTemplate": "/javascript/api/excel/#excel-excel-{fieldName}-function(1)", + "interfaceMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/excel/excel.{className}", + "name": "Excel Standard Pattern", + "classTemplate": "/javascript/api/excel/excel.{className}", + "interfaceTemplate": "/javascript/api/excel/excel.{className}", + "enumMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}", + "enumTemplate": "/javascript/api/excel/excel.{className}" + } + ] } diff --git a/generate-docs/configs/excel-1_13-config.json b/generate-docs/configs/excel-1_13-config.json index 949dd854ab..084554dbce 100644 --- a/generate-docs/configs/excel-1_13-config.json +++ b/generate-docs/configs/excel-1_13-config.json @@ -1,19 +1,34 @@ { - "excludedFieldPatterns": [ - "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" - ], - "excludedFieldNames": [ - "load", - "set", - "toJSON", - "context", - "track", - "untrack" - ], - "excludedClassPatterns": [ - "LoadOptions$", - "Data$" - ], - "includeStaticFields": false, - "includeEnums": false + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/excel", + "description": "Standard URL pattern for Excel APIs", + "globalFunctionTemplate": "/javascript/api/excel/#excel-excel-{fieldName}-function(1)", + "interfaceMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/excel/excel.{className}", + "name": "Excel Standard Pattern", + "classTemplate": "/javascript/api/excel/excel.{className}", + "interfaceTemplate": "/javascript/api/excel/excel.{className}", + "enumMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}", + "enumTemplate": "/javascript/api/excel/excel.{className}" + } + ] } diff --git a/generate-docs/configs/excel-1_14-config.json b/generate-docs/configs/excel-1_14-config.json index 949dd854ab..084554dbce 100644 --- a/generate-docs/configs/excel-1_14-config.json +++ b/generate-docs/configs/excel-1_14-config.json @@ -1,19 +1,34 @@ { - "excludedFieldPatterns": [ - "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" - ], - "excludedFieldNames": [ - "load", - "set", - "toJSON", - "context", - "track", - "untrack" - ], - "excludedClassPatterns": [ - "LoadOptions$", - "Data$" - ], - "includeStaticFields": false, - "includeEnums": false + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/excel", + "description": "Standard URL pattern for Excel APIs", + "globalFunctionTemplate": "/javascript/api/excel/#excel-excel-{fieldName}-function(1)", + "interfaceMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/excel/excel.{className}", + "name": "Excel Standard Pattern", + "classTemplate": "/javascript/api/excel/excel.{className}", + "interfaceTemplate": "/javascript/api/excel/excel.{className}", + "enumMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}", + "enumTemplate": "/javascript/api/excel/excel.{className}" + } + ] } diff --git a/generate-docs/configs/excel-1_15-config.json b/generate-docs/configs/excel-1_15-config.json index 949dd854ab..084554dbce 100644 --- a/generate-docs/configs/excel-1_15-config.json +++ b/generate-docs/configs/excel-1_15-config.json @@ -1,19 +1,34 @@ { - "excludedFieldPatterns": [ - "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" - ], - "excludedFieldNames": [ - "load", - "set", - "toJSON", - "context", - "track", - "untrack" - ], - "excludedClassPatterns": [ - "LoadOptions$", - "Data$" - ], - "includeStaticFields": false, - "includeEnums": false + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/excel", + "description": "Standard URL pattern for Excel APIs", + "globalFunctionTemplate": "/javascript/api/excel/#excel-excel-{fieldName}-function(1)", + "interfaceMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/excel/excel.{className}", + "name": "Excel Standard Pattern", + "classTemplate": "/javascript/api/excel/excel.{className}", + "interfaceTemplate": "/javascript/api/excel/excel.{className}", + "enumMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}", + "enumTemplate": "/javascript/api/excel/excel.{className}" + } + ] } diff --git a/generate-docs/configs/excel-1_16-config.json b/generate-docs/configs/excel-1_16-config.json index 949dd854ab..084554dbce 100644 --- a/generate-docs/configs/excel-1_16-config.json +++ b/generate-docs/configs/excel-1_16-config.json @@ -1,19 +1,34 @@ { - "excludedFieldPatterns": [ - "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" - ], - "excludedFieldNames": [ - "load", - "set", - "toJSON", - "context", - "track", - "untrack" - ], - "excludedClassPatterns": [ - "LoadOptions$", - "Data$" - ], - "includeStaticFields": false, - "includeEnums": false + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/excel", + "description": "Standard URL pattern for Excel APIs", + "globalFunctionTemplate": "/javascript/api/excel/#excel-excel-{fieldName}-function(1)", + "interfaceMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/excel/excel.{className}", + "name": "Excel Standard Pattern", + "classTemplate": "/javascript/api/excel/excel.{className}", + "interfaceTemplate": "/javascript/api/excel/excel.{className}", + "enumMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}", + "enumTemplate": "/javascript/api/excel/excel.{className}" + } + ] } diff --git a/generate-docs/configs/excel-1_17-config.json b/generate-docs/configs/excel-1_17-config.json index 949dd854ab..084554dbce 100644 --- a/generate-docs/configs/excel-1_17-config.json +++ b/generate-docs/configs/excel-1_17-config.json @@ -1,19 +1,34 @@ { - "excludedFieldPatterns": [ - "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" - ], - "excludedFieldNames": [ - "load", - "set", - "toJSON", - "context", - "track", - "untrack" - ], - "excludedClassPatterns": [ - "LoadOptions$", - "Data$" - ], - "includeStaticFields": false, - "includeEnums": false + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/excel", + "description": "Standard URL pattern for Excel APIs", + "globalFunctionTemplate": "/javascript/api/excel/#excel-excel-{fieldName}-function(1)", + "interfaceMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/excel/excel.{className}", + "name": "Excel Standard Pattern", + "classTemplate": "/javascript/api/excel/excel.{className}", + "interfaceTemplate": "/javascript/api/excel/excel.{className}", + "enumMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}", + "enumTemplate": "/javascript/api/excel/excel.{className}" + } + ] } diff --git a/generate-docs/configs/excel-1_18-config.json b/generate-docs/configs/excel-1_18-config.json index 949dd854ab..084554dbce 100644 --- a/generate-docs/configs/excel-1_18-config.json +++ b/generate-docs/configs/excel-1_18-config.json @@ -1,19 +1,34 @@ { - "excludedFieldPatterns": [ - "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" - ], - "excludedFieldNames": [ - "load", - "set", - "toJSON", - "context", - "track", - "untrack" - ], - "excludedClassPatterns": [ - "LoadOptions$", - "Data$" - ], - "includeStaticFields": false, - "includeEnums": false + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/excel", + "description": "Standard URL pattern for Excel APIs", + "globalFunctionTemplate": "/javascript/api/excel/#excel-excel-{fieldName}-function(1)", + "interfaceMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/excel/excel.{className}", + "name": "Excel Standard Pattern", + "classTemplate": "/javascript/api/excel/excel.{className}", + "interfaceTemplate": "/javascript/api/excel/excel.{className}", + "enumMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}", + "enumTemplate": "/javascript/api/excel/excel.{className}" + } + ] } diff --git a/generate-docs/configs/excel-1_19-config.json b/generate-docs/configs/excel-1_19-config.json index 1ffeb5cd7e..6b4207783e 100644 --- a/generate-docs/configs/excel-1_19-config.json +++ b/generate-docs/configs/excel-1_19-config.json @@ -1,36 +1,51 @@ { - "replacements": [ - { - "find": "type CardLayoutSection = CardLayoutListSection | CardLayoutTableSection | CardLayoutTwoColumnSection;", - "replace": "type CardLayoutSection = CardLayoutListSection | CardLayoutTableSection;", - "description": "Address CardLayoutTwoColumnSection reference for when removing ExcelApi 1.19" - }, - { - "find": "icon?: string | EntityCompactLayoutIcons;", - "replace": "icon?: string;", - "description": "Address EntityCompactLayoutIcons reference for when removing ExcelApi 1.19" - }, - { - "find": "type CellValue = (ArrayCellValue | BooleanCellValue | DoubleCellValue | EntityCellValue | EmptyCellValue | ErrorCellValue | FormattedNumberCellValue | FunctionCellValue | LinkedEntityCellValue | ReferenceCellValue | StringCellValue | ValueTypeNotAvailableCellValue | WebImageCellValue) & CellValueExtraProperties;", - "replace": "type CellValue = (ArrayCellValue | BooleanCellValue | DoubleCellValue | EntityCellValue | EmptyCellValue | ErrorCellValue | LinkedEntityCellValue | ReferenceCellValue | StringCellValue | ValueTypeNotAvailableCellValue | WebImageCellValue) & CellValueExtraProperties;", - "description": "Remove FormattedNumberCellValue from CellValue union type" - } - ], - "excludedFieldPatterns": [ - "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" - ], - "excludedFieldNames": [ - "load", - "set", - "toJSON", - "context", - "track", - "untrack" - ], - "excludedClassPatterns": [ - "LoadOptions$", - "Data$" - ], - "includeStaticFields": false, - "includeEnums": false + "replacements": [ + { + "find": "type CardLayoutSection = CardLayoutListSection | CardLayoutTableSection | CardLayoutTwoColumnSection;", + "replace": "type CardLayoutSection = CardLayoutListSection | CardLayoutTableSection;", + "description": "Address CardLayoutTwoColumnSection reference for when removing ExcelApi 1.19" + }, + { + "find": "icon?: string | EntityCompactLayoutIcons;", + "replace": "icon?: string;", + "description": "Address EntityCompactLayoutIcons reference for when removing ExcelApi 1.19" + }, + { + "find": "type CellValue = (ArrayCellValue | BooleanCellValue | DoubleCellValue | EntityCellValue | EmptyCellValue | ErrorCellValue | FormattedNumberCellValue | FunctionCellValue | LinkedEntityCellValue | ReferenceCellValue | StringCellValue | ValueTypeNotAvailableCellValue | WebImageCellValue) \u0026 CellValueExtraProperties;", + "replace": "type CellValue = (ArrayCellValue | BooleanCellValue | DoubleCellValue | EntityCellValue | EmptyCellValue | ErrorCellValue | LinkedEntityCellValue | ReferenceCellValue | StringCellValue | ValueTypeNotAvailableCellValue | WebImageCellValue) \u0026 CellValueExtraProperties;", + "description": "Remove FormattedNumberCellValue from CellValue union type" + } + ], + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/excel", + "description": "Standard URL pattern for Excel APIs", + "globalFunctionTemplate": "/javascript/api/excel/#excel-excel-{fieldName}-function(1)", + "interfaceMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/excel/excel.{className}", + "name": "Excel Standard Pattern", + "classTemplate": "/javascript/api/excel/excel.{className}", + "interfaceTemplate": "/javascript/api/excel/excel.{className}", + "enumMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}", + "enumTemplate": "/javascript/api/excel/excel.{className}" + } + ] } diff --git a/generate-docs/configs/excel-1_2-config.json b/generate-docs/configs/excel-1_2-config.json index 73079ddf18..084554dbce 100644 --- a/generate-docs/configs/excel-1_2-config.json +++ b/generate-docs/configs/excel-1_2-config.json @@ -1,19 +1,34 @@ { - "excludedFieldPatterns": [ - "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" - ], - "excludedFieldNames": [ - "load", - "set", - "toJSON", - "context", - "track", - "untrack" - ], - "excludedClassPatterns": [ - "LoadOptions$", - "Data$" - ], - "includeStaticFields": false, - "includeEnums": false -} \ No newline at end of file + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/excel", + "description": "Standard URL pattern for Excel APIs", + "globalFunctionTemplate": "/javascript/api/excel/#excel-excel-{fieldName}-function(1)", + "interfaceMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/excel/excel.{className}", + "name": "Excel Standard Pattern", + "classTemplate": "/javascript/api/excel/excel.{className}", + "interfaceTemplate": "/javascript/api/excel/excel.{className}", + "enumMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}", + "enumTemplate": "/javascript/api/excel/excel.{className}" + } + ] +} diff --git a/generate-docs/configs/excel-1_20-config.json b/generate-docs/configs/excel-1_20-config.json index 949dd854ab..084554dbce 100644 --- a/generate-docs/configs/excel-1_20-config.json +++ b/generate-docs/configs/excel-1_20-config.json @@ -1,19 +1,34 @@ { - "excludedFieldPatterns": [ - "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" - ], - "excludedFieldNames": [ - "load", - "set", - "toJSON", - "context", - "track", - "untrack" - ], - "excludedClassPatterns": [ - "LoadOptions$", - "Data$" - ], - "includeStaticFields": false, - "includeEnums": false + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/excel", + "description": "Standard URL pattern for Excel APIs", + "globalFunctionTemplate": "/javascript/api/excel/#excel-excel-{fieldName}-function(1)", + "interfaceMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/excel/excel.{className}", + "name": "Excel Standard Pattern", + "classTemplate": "/javascript/api/excel/excel.{className}", + "interfaceTemplate": "/javascript/api/excel/excel.{className}", + "enumMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}", + "enumTemplate": "/javascript/api/excel/excel.{className}" + } + ] } diff --git a/generate-docs/configs/excel-1_3-config.json b/generate-docs/configs/excel-1_3-config.json index 73079ddf18..084554dbce 100644 --- a/generate-docs/configs/excel-1_3-config.json +++ b/generate-docs/configs/excel-1_3-config.json @@ -1,19 +1,34 @@ { - "excludedFieldPatterns": [ - "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" - ], - "excludedFieldNames": [ - "load", - "set", - "toJSON", - "context", - "track", - "untrack" - ], - "excludedClassPatterns": [ - "LoadOptions$", - "Data$" - ], - "includeStaticFields": false, - "includeEnums": false -} \ No newline at end of file + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/excel", + "description": "Standard URL pattern for Excel APIs", + "globalFunctionTemplate": "/javascript/api/excel/#excel-excel-{fieldName}-function(1)", + "interfaceMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/excel/excel.{className}", + "name": "Excel Standard Pattern", + "classTemplate": "/javascript/api/excel/excel.{className}", + "interfaceTemplate": "/javascript/api/excel/excel.{className}", + "enumMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}", + "enumTemplate": "/javascript/api/excel/excel.{className}" + } + ] +} diff --git a/generate-docs/configs/excel-1_4-config.json b/generate-docs/configs/excel-1_4-config.json index 949dd854ab..084554dbce 100644 --- a/generate-docs/configs/excel-1_4-config.json +++ b/generate-docs/configs/excel-1_4-config.json @@ -1,19 +1,34 @@ { - "excludedFieldPatterns": [ - "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" - ], - "excludedFieldNames": [ - "load", - "set", - "toJSON", - "context", - "track", - "untrack" - ], - "excludedClassPatterns": [ - "LoadOptions$", - "Data$" - ], - "includeStaticFields": false, - "includeEnums": false + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/excel", + "description": "Standard URL pattern for Excel APIs", + "globalFunctionTemplate": "/javascript/api/excel/#excel-excel-{fieldName}-function(1)", + "interfaceMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/excel/excel.{className}", + "name": "Excel Standard Pattern", + "classTemplate": "/javascript/api/excel/excel.{className}", + "interfaceTemplate": "/javascript/api/excel/excel.{className}", + "enumMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}", + "enumTemplate": "/javascript/api/excel/excel.{className}" + } + ] } diff --git a/generate-docs/configs/excel-1_5-config.json b/generate-docs/configs/excel-1_5-config.json index 949dd854ab..084554dbce 100644 --- a/generate-docs/configs/excel-1_5-config.json +++ b/generate-docs/configs/excel-1_5-config.json @@ -1,19 +1,34 @@ { - "excludedFieldPatterns": [ - "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" - ], - "excludedFieldNames": [ - "load", - "set", - "toJSON", - "context", - "track", - "untrack" - ], - "excludedClassPatterns": [ - "LoadOptions$", - "Data$" - ], - "includeStaticFields": false, - "includeEnums": false + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/excel", + "description": "Standard URL pattern for Excel APIs", + "globalFunctionTemplate": "/javascript/api/excel/#excel-excel-{fieldName}-function(1)", + "interfaceMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/excel/excel.{className}", + "name": "Excel Standard Pattern", + "classTemplate": "/javascript/api/excel/excel.{className}", + "interfaceTemplate": "/javascript/api/excel/excel.{className}", + "enumMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}", + "enumTemplate": "/javascript/api/excel/excel.{className}" + } + ] } diff --git a/generate-docs/configs/excel-1_6-config.json b/generate-docs/configs/excel-1_6-config.json index 949dd854ab..084554dbce 100644 --- a/generate-docs/configs/excel-1_6-config.json +++ b/generate-docs/configs/excel-1_6-config.json @@ -1,19 +1,34 @@ { - "excludedFieldPatterns": [ - "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" - ], - "excludedFieldNames": [ - "load", - "set", - "toJSON", - "context", - "track", - "untrack" - ], - "excludedClassPatterns": [ - "LoadOptions$", - "Data$" - ], - "includeStaticFields": false, - "includeEnums": false + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/excel", + "description": "Standard URL pattern for Excel APIs", + "globalFunctionTemplate": "/javascript/api/excel/#excel-excel-{fieldName}-function(1)", + "interfaceMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/excel/excel.{className}", + "name": "Excel Standard Pattern", + "classTemplate": "/javascript/api/excel/excel.{className}", + "interfaceTemplate": "/javascript/api/excel/excel.{className}", + "enumMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}", + "enumTemplate": "/javascript/api/excel/excel.{className}" + } + ] } diff --git a/generate-docs/configs/excel-1_7-config.json b/generate-docs/configs/excel-1_7-config.json index 949dd854ab..084554dbce 100644 --- a/generate-docs/configs/excel-1_7-config.json +++ b/generate-docs/configs/excel-1_7-config.json @@ -1,19 +1,34 @@ { - "excludedFieldPatterns": [ - "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" - ], - "excludedFieldNames": [ - "load", - "set", - "toJSON", - "context", - "track", - "untrack" - ], - "excludedClassPatterns": [ - "LoadOptions$", - "Data$" - ], - "includeStaticFields": false, - "includeEnums": false + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/excel", + "description": "Standard URL pattern for Excel APIs", + "globalFunctionTemplate": "/javascript/api/excel/#excel-excel-{fieldName}-function(1)", + "interfaceMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/excel/excel.{className}", + "name": "Excel Standard Pattern", + "classTemplate": "/javascript/api/excel/excel.{className}", + "interfaceTemplate": "/javascript/api/excel/excel.{className}", + "enumMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}", + "enumTemplate": "/javascript/api/excel/excel.{className}" + } + ] } diff --git a/generate-docs/configs/excel-1_8-config.json b/generate-docs/configs/excel-1_8-config.json index 949dd854ab..084554dbce 100644 --- a/generate-docs/configs/excel-1_8-config.json +++ b/generate-docs/configs/excel-1_8-config.json @@ -1,19 +1,34 @@ { - "excludedFieldPatterns": [ - "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" - ], - "excludedFieldNames": [ - "load", - "set", - "toJSON", - "context", - "track", - "untrack" - ], - "excludedClassPatterns": [ - "LoadOptions$", - "Data$" - ], - "includeStaticFields": false, - "includeEnums": false + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/excel", + "description": "Standard URL pattern for Excel APIs", + "globalFunctionTemplate": "/javascript/api/excel/#excel-excel-{fieldName}-function(1)", + "interfaceMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/excel/excel.{className}", + "name": "Excel Standard Pattern", + "classTemplate": "/javascript/api/excel/excel.{className}", + "interfaceTemplate": "/javascript/api/excel/excel.{className}", + "enumMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}", + "enumTemplate": "/javascript/api/excel/excel.{className}" + } + ] } diff --git a/generate-docs/configs/excel-1_9-config.json b/generate-docs/configs/excel-1_9-config.json index 949dd854ab..084554dbce 100644 --- a/generate-docs/configs/excel-1_9-config.json +++ b/generate-docs/configs/excel-1_9-config.json @@ -1,19 +1,34 @@ { - "excludedFieldPatterns": [ - "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" - ], - "excludedFieldNames": [ - "load", - "set", - "toJSON", - "context", - "track", - "untrack" - ], - "excludedClassPatterns": [ - "LoadOptions$", - "Data$" - ], - "includeStaticFields": false, - "includeEnums": false + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/excel", + "description": "Standard URL pattern for Excel APIs", + "globalFunctionTemplate": "/javascript/api/excel/#excel-excel-{fieldName}-function(1)", + "interfaceMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/excel/excel.{className}", + "name": "Excel Standard Pattern", + "classTemplate": "/javascript/api/excel/excel.{className}", + "interfaceTemplate": "/javascript/api/excel/excel.{className}", + "enumMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}", + "enumTemplate": "/javascript/api/excel/excel.{className}" + } + ] } diff --git a/generate-docs/configs/excel-online-config.json b/generate-docs/configs/excel-online-config.json index 73079ddf18..084554dbce 100644 --- a/generate-docs/configs/excel-online-config.json +++ b/generate-docs/configs/excel-online-config.json @@ -1,19 +1,34 @@ { - "excludedFieldPatterns": [ - "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" - ], - "excludedFieldNames": [ - "load", - "set", - "toJSON", - "context", - "track", - "untrack" - ], - "excludedClassPatterns": [ - "LoadOptions$", - "Data$" - ], - "includeStaticFields": false, - "includeEnums": false -} \ No newline at end of file + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/excel", + "description": "Standard URL pattern for Excel APIs", + "globalFunctionTemplate": "/javascript/api/excel/#excel-excel-{fieldName}-function(1)", + "interfaceMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/excel/excel.{className}", + "name": "Excel Standard Pattern", + "classTemplate": "/javascript/api/excel/excel.{className}", + "interfaceTemplate": "/javascript/api/excel/excel.{className}", + "enumMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}", + "enumTemplate": "/javascript/api/excel/excel.{className}" + } + ] +} diff --git a/generate-docs/configs/excel-preview-config.json b/generate-docs/configs/excel-preview-config.json index 73079ddf18..084554dbce 100644 --- a/generate-docs/configs/excel-preview-config.json +++ b/generate-docs/configs/excel-preview-config.json @@ -1,19 +1,34 @@ { - "excludedFieldPatterns": [ - "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" - ], - "excludedFieldNames": [ - "load", - "set", - "toJSON", - "context", - "track", - "untrack" - ], - "excludedClassPatterns": [ - "LoadOptions$", - "Data$" - ], - "includeStaticFields": false, - "includeEnums": false -} \ No newline at end of file + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/excel", + "description": "Standard URL pattern for Excel APIs", + "globalFunctionTemplate": "/javascript/api/excel/#excel-excel-{fieldName}-function(1)", + "interfaceMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/excel/excel.{className}", + "name": "Excel Standard Pattern", + "classTemplate": "/javascript/api/excel/excel.{className}", + "interfaceTemplate": "/javascript/api/excel/excel.{className}", + "enumMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}", + "enumTemplate": "/javascript/api/excel/excel.{className}" + } + ] +} diff --git a/generate-docs/configs/outlook-1.1-config.json b/generate-docs/configs/outlook-1.1-config.json index f826e92a99..be7dbbf938 100644 --- a/generate-docs/configs/outlook-1.1-config.json +++ b/generate-docs/configs/outlook-1.1-config.json @@ -1,12 +1,27 @@ { - "replacements": [ - { - "find": "/outlook/requirement-set-1.[\\d]*/", - "replace": "/outlook/requirement-set-1.1/", - "isRegex": true, - "description": "Update Outlook requirement set URL references to version 1.1" - } - ], - "includeStaticFields": false, - "includeEnums": false + "replacements": [ + { + "find": "/outlook/requirement-set-1.[\\d]*/", + "replace": "/outlook/requirement-set-1.1/", + "isRegex": true, + "description": "Update Outlook requirement set URL references to version 1.1" + } + ], + "includeStaticFields": false, + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/outlook", + "description": "Standard URL pattern for Outlook APIs", + "globalFunctionTemplate": "/javascript/api/outlook/office#{fieldName}", + "interfaceMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/outlook/office.{className}", + "name": "Outlook Standard Pattern", + "classTemplate": "/javascript/api/outlook/office.{className}", + "interfaceTemplate": "/javascript/api/outlook/office.{className}", + "enumMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}", + "enumTemplate": "/javascript/api/outlook/office.{className}" + } + ] } diff --git a/generate-docs/configs/outlook-1.10-config.json b/generate-docs/configs/outlook-1.10-config.json index dc4252fbcf..acd1b10d57 100644 --- a/generate-docs/configs/outlook-1.10-config.json +++ b/generate-docs/configs/outlook-1.10-config.json @@ -7,5 +7,20 @@ } ], "includeStaticFields": false, - "includeEnums": false + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/outlook", + "description": "Standard URL pattern for Outlook APIs", + "globalFunctionTemplate": "/javascript/api/outlook/office#{fieldName}", + "interfaceMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/outlook/office.{className}", + "name": "Outlook Standard Pattern", + "classTemplate": "/javascript/api/outlook/office.{className}", + "interfaceTemplate": "/javascript/api/outlook/office.{className}", + "enumMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}", + "enumTemplate": "/javascript/api/outlook/office.{className}" + } + ] } diff --git a/generate-docs/configs/outlook-1.11-config.json b/generate-docs/configs/outlook-1.11-config.json index 8bf2011ddf..2baea24c9c 100644 --- a/generate-docs/configs/outlook-1.11-config.json +++ b/generate-docs/configs/outlook-1.11-config.json @@ -7,5 +7,20 @@ } ], "includeStaticFields": false, - "includeEnums": false + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/outlook", + "description": "Standard URL pattern for Outlook APIs", + "globalFunctionTemplate": "/javascript/api/outlook/office#{fieldName}", + "interfaceMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/outlook/office.{className}", + "name": "Outlook Standard Pattern", + "classTemplate": "/javascript/api/outlook/office.{className}", + "interfaceTemplate": "/javascript/api/outlook/office.{className}", + "enumMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}", + "enumTemplate": "/javascript/api/outlook/office.{className}" + } + ] } diff --git a/generate-docs/configs/outlook-1.12-config.json b/generate-docs/configs/outlook-1.12-config.json index 3528f8abd4..7a30b3cec2 100644 --- a/generate-docs/configs/outlook-1.12-config.json +++ b/generate-docs/configs/outlook-1.12-config.json @@ -17,5 +17,20 @@ } ], "includeStaticFields": false, - "includeEnums": false + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/outlook", + "description": "Standard URL pattern for Outlook APIs", + "globalFunctionTemplate": "/javascript/api/outlook/office#{fieldName}", + "interfaceMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/outlook/office.{className}", + "name": "Outlook Standard Pattern", + "classTemplate": "/javascript/api/outlook/office.{className}", + "interfaceTemplate": "/javascript/api/outlook/office.{className}", + "enumMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}", + "enumTemplate": "/javascript/api/outlook/office.{className}" + } + ] } diff --git a/generate-docs/configs/outlook-1.13-config.json b/generate-docs/configs/outlook-1.13-config.json index 30c587a923..b7d75e56b5 100644 --- a/generate-docs/configs/outlook-1.13-config.json +++ b/generate-docs/configs/outlook-1.13-config.json @@ -7,5 +7,20 @@ } ], "includeStaticFields": false, - "includeEnums": false + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/outlook", + "description": "Standard URL pattern for Outlook APIs", + "globalFunctionTemplate": "/javascript/api/outlook/office#{fieldName}", + "interfaceMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/outlook/office.{className}", + "name": "Outlook Standard Pattern", + "classTemplate": "/javascript/api/outlook/office.{className}", + "interfaceTemplate": "/javascript/api/outlook/office.{className}", + "enumMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}", + "enumTemplate": "/javascript/api/outlook/office.{className}" + } + ] } diff --git a/generate-docs/configs/outlook-1.14-config.json b/generate-docs/configs/outlook-1.14-config.json index 9fa4cd1ce1..91a11c5393 100644 --- a/generate-docs/configs/outlook-1.14-config.json +++ b/generate-docs/configs/outlook-1.14-config.json @@ -12,5 +12,20 @@ } ], "includeStaticFields": false, - "includeEnums": false + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/outlook", + "description": "Standard URL pattern for Outlook APIs", + "globalFunctionTemplate": "/javascript/api/outlook/office#{fieldName}", + "interfaceMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/outlook/office.{className}", + "name": "Outlook Standard Pattern", + "classTemplate": "/javascript/api/outlook/office.{className}", + "interfaceTemplate": "/javascript/api/outlook/office.{className}", + "enumMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}", + "enumTemplate": "/javascript/api/outlook/office.{className}" + } + ] } diff --git a/generate-docs/configs/outlook-1.15-config.json b/generate-docs/configs/outlook-1.15-config.json index 172a20a80b..9d85949fe0 100644 --- a/generate-docs/configs/outlook-1.15-config.json +++ b/generate-docs/configs/outlook-1.15-config.json @@ -7,5 +7,20 @@ } ], "includeStaticFields": false, - "includeEnums": false + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/outlook", + "description": "Standard URL pattern for Outlook APIs", + "globalFunctionTemplate": "/javascript/api/outlook/office#{fieldName}", + "interfaceMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/outlook/office.{className}", + "name": "Outlook Standard Pattern", + "classTemplate": "/javascript/api/outlook/office.{className}", + "interfaceTemplate": "/javascript/api/outlook/office.{className}", + "enumMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}", + "enumTemplate": "/javascript/api/outlook/office.{className}" + } + ] } diff --git a/generate-docs/configs/outlook-1.2-config.json b/generate-docs/configs/outlook-1.2-config.json index 0b9ef61b5a..e787a5ce40 100644 --- a/generate-docs/configs/outlook-1.2-config.json +++ b/generate-docs/configs/outlook-1.2-config.json @@ -7,5 +7,20 @@ } ], "includeStaticFields": false, - "includeEnums": false + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/outlook", + "description": "Standard URL pattern for Outlook APIs", + "globalFunctionTemplate": "/javascript/api/outlook/office#{fieldName}", + "interfaceMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/outlook/office.{className}", + "name": "Outlook Standard Pattern", + "classTemplate": "/javascript/api/outlook/office.{className}", + "interfaceTemplate": "/javascript/api/outlook/office.{className}", + "enumMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}", + "enumTemplate": "/javascript/api/outlook/office.{className}" + } + ] } diff --git a/generate-docs/configs/outlook-1.3-config.json b/generate-docs/configs/outlook-1.3-config.json index dc38099bc9..28acb04215 100644 --- a/generate-docs/configs/outlook-1.3-config.json +++ b/generate-docs/configs/outlook-1.3-config.json @@ -7,5 +7,20 @@ } ], "includeStaticFields": false, - "includeEnums": false + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/outlook", + "description": "Standard URL pattern for Outlook APIs", + "globalFunctionTemplate": "/javascript/api/outlook/office#{fieldName}", + "interfaceMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/outlook/office.{className}", + "name": "Outlook Standard Pattern", + "classTemplate": "/javascript/api/outlook/office.{className}", + "interfaceTemplate": "/javascript/api/outlook/office.{className}", + "enumMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}", + "enumTemplate": "/javascript/api/outlook/office.{className}" + } + ] } diff --git a/generate-docs/configs/outlook-1.4-config.json b/generate-docs/configs/outlook-1.4-config.json index cd3050bae1..012387c364 100644 --- a/generate-docs/configs/outlook-1.4-config.json +++ b/generate-docs/configs/outlook-1.4-config.json @@ -7,5 +7,20 @@ } ], "includeStaticFields": false, - "includeEnums": false + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/outlook", + "description": "Standard URL pattern for Outlook APIs", + "globalFunctionTemplate": "/javascript/api/outlook/office#{fieldName}", + "interfaceMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/outlook/office.{className}", + "name": "Outlook Standard Pattern", + "classTemplate": "/javascript/api/outlook/office.{className}", + "interfaceTemplate": "/javascript/api/outlook/office.{className}", + "enumMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}", + "enumTemplate": "/javascript/api/outlook/office.{className}" + } + ] } diff --git a/generate-docs/configs/outlook-1.5-config.json b/generate-docs/configs/outlook-1.5-config.json index 86e4b426d8..67af66e398 100644 --- a/generate-docs/configs/outlook-1.5-config.json +++ b/generate-docs/configs/outlook-1.5-config.json @@ -7,5 +7,20 @@ } ], "includeStaticFields": false, - "includeEnums": false + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/outlook", + "description": "Standard URL pattern for Outlook APIs", + "globalFunctionTemplate": "/javascript/api/outlook/office#{fieldName}", + "interfaceMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/outlook/office.{className}", + "name": "Outlook Standard Pattern", + "classTemplate": "/javascript/api/outlook/office.{className}", + "interfaceTemplate": "/javascript/api/outlook/office.{className}", + "enumMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}", + "enumTemplate": "/javascript/api/outlook/office.{className}" + } + ] } diff --git a/generate-docs/configs/outlook-1.6-config.json b/generate-docs/configs/outlook-1.6-config.json index 8b43373f82..327e5b0f46 100644 --- a/generate-docs/configs/outlook-1.6-config.json +++ b/generate-docs/configs/outlook-1.6-config.json @@ -7,5 +7,20 @@ } ], "includeStaticFields": false, - "includeEnums": false + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/outlook", + "description": "Standard URL pattern for Outlook APIs", + "globalFunctionTemplate": "/javascript/api/outlook/office#{fieldName}", + "interfaceMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/outlook/office.{className}", + "name": "Outlook Standard Pattern", + "classTemplate": "/javascript/api/outlook/office.{className}", + "interfaceTemplate": "/javascript/api/outlook/office.{className}", + "enumMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}", + "enumTemplate": "/javascript/api/outlook/office.{className}" + } + ] } diff --git a/generate-docs/configs/outlook-1.7-config.json b/generate-docs/configs/outlook-1.7-config.json index bd759355e1..6a457d7439 100644 --- a/generate-docs/configs/outlook-1.7-config.json +++ b/generate-docs/configs/outlook-1.7-config.json @@ -7,5 +7,20 @@ } ], "includeStaticFields": false, - "includeEnums": false + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/outlook", + "description": "Standard URL pattern for Outlook APIs", + "globalFunctionTemplate": "/javascript/api/outlook/office#{fieldName}", + "interfaceMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/outlook/office.{className}", + "name": "Outlook Standard Pattern", + "classTemplate": "/javascript/api/outlook/office.{className}", + "interfaceTemplate": "/javascript/api/outlook/office.{className}", + "enumMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}", + "enumTemplate": "/javascript/api/outlook/office.{className}" + } + ] } diff --git a/generate-docs/configs/outlook-1.8-config.json b/generate-docs/configs/outlook-1.8-config.json index e9044d6383..fa30bdf01c 100644 --- a/generate-docs/configs/outlook-1.8-config.json +++ b/generate-docs/configs/outlook-1.8-config.json @@ -7,5 +7,20 @@ } ], "includeStaticFields": false, - "includeEnums": false + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/outlook", + "description": "Standard URL pattern for Outlook APIs", + "globalFunctionTemplate": "/javascript/api/outlook/office#{fieldName}", + "interfaceMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/outlook/office.{className}", + "name": "Outlook Standard Pattern", + "classTemplate": "/javascript/api/outlook/office.{className}", + "interfaceTemplate": "/javascript/api/outlook/office.{className}", + "enumMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}", + "enumTemplate": "/javascript/api/outlook/office.{className}" + } + ] } diff --git a/generate-docs/configs/outlook-1.9-config.json b/generate-docs/configs/outlook-1.9-config.json index d8e6890716..8f5c197463 100644 --- a/generate-docs/configs/outlook-1.9-config.json +++ b/generate-docs/configs/outlook-1.9-config.json @@ -7,5 +7,20 @@ } ], "includeStaticFields": false, - "includeEnums": false + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/outlook", + "description": "Standard URL pattern for Outlook APIs", + "globalFunctionTemplate": "/javascript/api/outlook/office#{fieldName}", + "interfaceMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/outlook/office.{className}", + "name": "Outlook Standard Pattern", + "classTemplate": "/javascript/api/outlook/office.{className}", + "interfaceTemplate": "/javascript/api/outlook/office.{className}", + "enumMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}", + "enumTemplate": "/javascript/api/outlook/office.{className}" + } + ] } diff --git a/generate-docs/configs/outlook-preview-config.json b/generate-docs/configs/outlook-preview-config.json index 0385017d61..07f98fcd38 100644 --- a/generate-docs/configs/outlook-preview-config.json +++ b/generate-docs/configs/outlook-preview-config.json @@ -1,12 +1,27 @@ { - "excludedFieldPatterns": [ - "toJSON", - "^_" - ], - "excludedFieldNames": [ - "context", - "isNullObject" - ], - "includeStaticFields": false, - "includeEnums": false -} \ No newline at end of file + "excludedFieldPatterns": [ + "toJSON", + "^_" + ], + "excludedFieldNames": [ + "context", + "isNullObject" + ], + "includeStaticFields": false, + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/outlook", + "description": "Standard URL pattern for Outlook APIs", + "globalFunctionTemplate": "/javascript/api/outlook/office#{fieldName}", + "interfaceMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/outlook/office.{className}", + "name": "Outlook Standard Pattern", + "classTemplate": "/javascript/api/outlook/office.{className}", + "interfaceTemplate": "/javascript/api/outlook/office.{className}", + "enumMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}", + "enumTemplate": "/javascript/api/outlook/office.{className}" + } + ] +} diff --git a/generate-docs/configs/powerpoint-1_1-config.json b/generate-docs/configs/powerpoint-1_1-config.json index 5940f0d0a5..9b497b3167 100644 --- a/generate-docs/configs/powerpoint-1_1-config.json +++ b/generate-docs/configs/powerpoint-1_1-config.json @@ -1,19 +1,34 @@ { - "excludedFieldPatterns": [ - "\\w+\\??:\\s*\".*\"" - ], - "excludedFieldNames": [ - "load", - "set", - "toJSON", - "context", - "track", - "untrack" - ], - "excludedClassPatterns": [ - "LoadOptions$", - "Data$" - ], - "includeStaticFields": false, - "includeEnums": false + "excludedFieldPatterns": [ + "\\w+\\??:\\s*\".*\"" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false, + "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/configs/powerpoint-1_2-config.json b/generate-docs/configs/powerpoint-1_2-config.json index 5940f0d0a5..9b497b3167 100644 --- a/generate-docs/configs/powerpoint-1_2-config.json +++ b/generate-docs/configs/powerpoint-1_2-config.json @@ -1,19 +1,34 @@ { - "excludedFieldPatterns": [ - "\\w+\\??:\\s*\".*\"" - ], - "excludedFieldNames": [ - "load", - "set", - "toJSON", - "context", - "track", - "untrack" - ], - "excludedClassPatterns": [ - "LoadOptions$", - "Data$" - ], - "includeStaticFields": false, - "includeEnums": false + "excludedFieldPatterns": [ + "\\w+\\??:\\s*\".*\"" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false, + "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/configs/powerpoint-1_3-config.json b/generate-docs/configs/powerpoint-1_3-config.json index 5940f0d0a5..9b497b3167 100644 --- a/generate-docs/configs/powerpoint-1_3-config.json +++ b/generate-docs/configs/powerpoint-1_3-config.json @@ -1,19 +1,34 @@ { - "excludedFieldPatterns": [ - "\\w+\\??:\\s*\".*\"" - ], - "excludedFieldNames": [ - "load", - "set", - "toJSON", - "context", - "track", - "untrack" - ], - "excludedClassPatterns": [ - "LoadOptions$", - "Data$" - ], - "includeStaticFields": false, - "includeEnums": false + "excludedFieldPatterns": [ + "\\w+\\??:\\s*\".*\"" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false, + "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/configs/powerpoint-1_4-config.json b/generate-docs/configs/powerpoint-1_4-config.json index 5940f0d0a5..9b497b3167 100644 --- a/generate-docs/configs/powerpoint-1_4-config.json +++ b/generate-docs/configs/powerpoint-1_4-config.json @@ -1,19 +1,34 @@ { - "excludedFieldPatterns": [ - "\\w+\\??:\\s*\".*\"" - ], - "excludedFieldNames": [ - "load", - "set", - "toJSON", - "context", - "track", - "untrack" - ], - "excludedClassPatterns": [ - "LoadOptions$", - "Data$" - ], - "includeStaticFields": false, - "includeEnums": false + "excludedFieldPatterns": [ + "\\w+\\??:\\s*\".*\"" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false, + "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/configs/powerpoint-1_5-config.json b/generate-docs/configs/powerpoint-1_5-config.json index 5940f0d0a5..9b497b3167 100644 --- a/generate-docs/configs/powerpoint-1_5-config.json +++ b/generate-docs/configs/powerpoint-1_5-config.json @@ -1,19 +1,34 @@ { - "excludedFieldPatterns": [ - "\\w+\\??:\\s*\".*\"" - ], - "excludedFieldNames": [ - "load", - "set", - "toJSON", - "context", - "track", - "untrack" - ], - "excludedClassPatterns": [ - "LoadOptions$", - "Data$" - ], - "includeStaticFields": false, - "includeEnums": false + "excludedFieldPatterns": [ + "\\w+\\??:\\s*\".*\"" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false, + "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/configs/powerpoint-1_6-config.json b/generate-docs/configs/powerpoint-1_6-config.json index 5940f0d0a5..9b497b3167 100644 --- a/generate-docs/configs/powerpoint-1_6-config.json +++ b/generate-docs/configs/powerpoint-1_6-config.json @@ -1,19 +1,34 @@ { - "excludedFieldPatterns": [ - "\\w+\\??:\\s*\".*\"" - ], - "excludedFieldNames": [ - "load", - "set", - "toJSON", - "context", - "track", - "untrack" - ], - "excludedClassPatterns": [ - "LoadOptions$", - "Data$" - ], - "includeStaticFields": false, - "includeEnums": false + "excludedFieldPatterns": [ + "\\w+\\??:\\s*\".*\"" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false, + "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/configs/powerpoint-1_7-config.json b/generate-docs/configs/powerpoint-1_7-config.json index 5940f0d0a5..9b497b3167 100644 --- a/generate-docs/configs/powerpoint-1_7-config.json +++ b/generate-docs/configs/powerpoint-1_7-config.json @@ -1,19 +1,34 @@ { - "excludedFieldPatterns": [ - "\\w+\\??:\\s*\".*\"" - ], - "excludedFieldNames": [ - "load", - "set", - "toJSON", - "context", - "track", - "untrack" - ], - "excludedClassPatterns": [ - "LoadOptions$", - "Data$" - ], - "includeStaticFields": false, - "includeEnums": false + "excludedFieldPatterns": [ + "\\w+\\??:\\s*\".*\"" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false, + "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/configs/powerpoint-1_8-config.json b/generate-docs/configs/powerpoint-1_8-config.json index 5940f0d0a5..9b497b3167 100644 --- a/generate-docs/configs/powerpoint-1_8-config.json +++ b/generate-docs/configs/powerpoint-1_8-config.json @@ -1,19 +1,34 @@ { - "excludedFieldPatterns": [ - "\\w+\\??:\\s*\".*\"" - ], - "excludedFieldNames": [ - "load", - "set", - "toJSON", - "context", - "track", - "untrack" - ], - "excludedClassPatterns": [ - "LoadOptions$", - "Data$" - ], - "includeStaticFields": false, - "includeEnums": false + "excludedFieldPatterns": [ + "\\w+\\??:\\s*\".*\"" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false, + "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/configs/powerpoint-1_9-config.json b/generate-docs/configs/powerpoint-1_9-config.json index 5940f0d0a5..9b497b3167 100644 --- a/generate-docs/configs/powerpoint-1_9-config.json +++ b/generate-docs/configs/powerpoint-1_9-config.json @@ -1,19 +1,34 @@ { - "excludedFieldPatterns": [ - "\\w+\\??:\\s*\".*\"" - ], - "excludedFieldNames": [ - "load", - "set", - "toJSON", - "context", - "track", - "untrack" - ], - "excludedClassPatterns": [ - "LoadOptions$", - "Data$" - ], - "includeStaticFields": false, - "includeEnums": false + "excludedFieldPatterns": [ + "\\w+\\??:\\s*\".*\"" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false, + "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/configs/powerpoint-preview-config.json b/generate-docs/configs/powerpoint-preview-config.json index 73079ddf18..d0d8f736fc 100644 --- a/generate-docs/configs/powerpoint-preview-config.json +++ b/generate-docs/configs/powerpoint-preview-config.json @@ -1,19 +1,34 @@ { - "excludedFieldPatterns": [ - "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" - ], - "excludedFieldNames": [ - "load", - "set", - "toJSON", - "context", - "track", - "untrack" - ], - "excludedClassPatterns": [ - "LoadOptions$", - "Data$" - ], - "includeStaticFields": false, - "includeEnums": false -} \ No newline at end of file + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false, + "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/configs/word-1_1-config.json b/generate-docs/configs/word-1_1-config.json index 949dd854ab..a7000dfb4e 100644 --- a/generate-docs/configs/word-1_1-config.json +++ b/generate-docs/configs/word-1_1-config.json @@ -1,19 +1,34 @@ { - "excludedFieldPatterns": [ - "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" - ], - "excludedFieldNames": [ - "load", - "set", - "toJSON", - "context", - "track", - "untrack" - ], - "excludedClassPatterns": [ - "LoadOptions$", - "Data$" - ], - "includeStaticFields": false, - "includeEnums": false + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/word", + "description": "Standard URL pattern for Word APIs", + "globalFunctionTemplate": "/javascript/api/word/word#{fieldName}", + "interfaceMemberTemplate": "/javascript/api/word/word.{className}#word-word-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/word/word.{className}#word-word-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/word/word.{className}", + "name": "Word Standard Pattern", + "classTemplate": "/javascript/api/word/word.{className}", + "interfaceTemplate": "/javascript/api/word/word.{className}", + "enumMemberTemplate": "/javascript/api/word/word.{className}#word-word-{className}-{fieldName}", + "enumTemplate": "/javascript/api/word/word.{className}" + } + ] } diff --git a/generate-docs/configs/word-1_2-config.json b/generate-docs/configs/word-1_2-config.json index 949dd854ab..a7000dfb4e 100644 --- a/generate-docs/configs/word-1_2-config.json +++ b/generate-docs/configs/word-1_2-config.json @@ -1,19 +1,34 @@ { - "excludedFieldPatterns": [ - "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" - ], - "excludedFieldNames": [ - "load", - "set", - "toJSON", - "context", - "track", - "untrack" - ], - "excludedClassPatterns": [ - "LoadOptions$", - "Data$" - ], - "includeStaticFields": false, - "includeEnums": false + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/word", + "description": "Standard URL pattern for Word APIs", + "globalFunctionTemplate": "/javascript/api/word/word#{fieldName}", + "interfaceMemberTemplate": "/javascript/api/word/word.{className}#word-word-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/word/word.{className}#word-word-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/word/word.{className}", + "name": "Word Standard Pattern", + "classTemplate": "/javascript/api/word/word.{className}", + "interfaceTemplate": "/javascript/api/word/word.{className}", + "enumMemberTemplate": "/javascript/api/word/word.{className}#word-word-{className}-{fieldName}", + "enumTemplate": "/javascript/api/word/word.{className}" + } + ] } diff --git a/generate-docs/configs/word-1_3-config.json b/generate-docs/configs/word-1_3-config.json index 949dd854ab..a7000dfb4e 100644 --- a/generate-docs/configs/word-1_3-config.json +++ b/generate-docs/configs/word-1_3-config.json @@ -1,19 +1,34 @@ { - "excludedFieldPatterns": [ - "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" - ], - "excludedFieldNames": [ - "load", - "set", - "toJSON", - "context", - "track", - "untrack" - ], - "excludedClassPatterns": [ - "LoadOptions$", - "Data$" - ], - "includeStaticFields": false, - "includeEnums": false + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/word", + "description": "Standard URL pattern for Word APIs", + "globalFunctionTemplate": "/javascript/api/word/word#{fieldName}", + "interfaceMemberTemplate": "/javascript/api/word/word.{className}#word-word-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/word/word.{className}#word-word-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/word/word.{className}", + "name": "Word Standard Pattern", + "classTemplate": "/javascript/api/word/word.{className}", + "interfaceTemplate": "/javascript/api/word/word.{className}", + "enumMemberTemplate": "/javascript/api/word/word.{className}#word-word-{className}-{fieldName}", + "enumTemplate": "/javascript/api/word/word.{className}" + } + ] } diff --git a/generate-docs/configs/word-1_3_hidden_document-config.json b/generate-docs/configs/word-1_3_hidden_document-config.json index 73079ddf18..a7000dfb4e 100644 --- a/generate-docs/configs/word-1_3_hidden_document-config.json +++ b/generate-docs/configs/word-1_3_hidden_document-config.json @@ -1,19 +1,34 @@ { - "excludedFieldPatterns": [ - "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" - ], - "excludedFieldNames": [ - "load", - "set", - "toJSON", - "context", - "track", - "untrack" - ], - "excludedClassPatterns": [ - "LoadOptions$", - "Data$" - ], - "includeStaticFields": false, - "includeEnums": false -} \ No newline at end of file + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/word", + "description": "Standard URL pattern for Word APIs", + "globalFunctionTemplate": "/javascript/api/word/word#{fieldName}", + "interfaceMemberTemplate": "/javascript/api/word/word.{className}#word-word-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/word/word.{className}#word-word-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/word/word.{className}", + "name": "Word Standard Pattern", + "classTemplate": "/javascript/api/word/word.{className}", + "interfaceTemplate": "/javascript/api/word/word.{className}", + "enumMemberTemplate": "/javascript/api/word/word.{className}#word-word-{className}-{fieldName}", + "enumTemplate": "/javascript/api/word/word.{className}" + } + ] +} diff --git a/generate-docs/configs/word-1_4-config.json b/generate-docs/configs/word-1_4-config.json index 949dd854ab..a7000dfb4e 100644 --- a/generate-docs/configs/word-1_4-config.json +++ b/generate-docs/configs/word-1_4-config.json @@ -1,19 +1,34 @@ { - "excludedFieldPatterns": [ - "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" - ], - "excludedFieldNames": [ - "load", - "set", - "toJSON", - "context", - "track", - "untrack" - ], - "excludedClassPatterns": [ - "LoadOptions$", - "Data$" - ], - "includeStaticFields": false, - "includeEnums": false + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/word", + "description": "Standard URL pattern for Word APIs", + "globalFunctionTemplate": "/javascript/api/word/word#{fieldName}", + "interfaceMemberTemplate": "/javascript/api/word/word.{className}#word-word-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/word/word.{className}#word-word-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/word/word.{className}", + "name": "Word Standard Pattern", + "classTemplate": "/javascript/api/word/word.{className}", + "interfaceTemplate": "/javascript/api/word/word.{className}", + "enumMemberTemplate": "/javascript/api/word/word.{className}#word-word-{className}-{fieldName}", + "enumTemplate": "/javascript/api/word/word.{className}" + } + ] } diff --git a/generate-docs/configs/word-1_4_hidden_document-config.json b/generate-docs/configs/word-1_4_hidden_document-config.json index 73079ddf18..a7000dfb4e 100644 --- a/generate-docs/configs/word-1_4_hidden_document-config.json +++ b/generate-docs/configs/word-1_4_hidden_document-config.json @@ -1,19 +1,34 @@ { - "excludedFieldPatterns": [ - "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" - ], - "excludedFieldNames": [ - "load", - "set", - "toJSON", - "context", - "track", - "untrack" - ], - "excludedClassPatterns": [ - "LoadOptions$", - "Data$" - ], - "includeStaticFields": false, - "includeEnums": false -} \ No newline at end of file + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/word", + "description": "Standard URL pattern for Word APIs", + "globalFunctionTemplate": "/javascript/api/word/word#{fieldName}", + "interfaceMemberTemplate": "/javascript/api/word/word.{className}#word-word-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/word/word.{className}#word-word-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/word/word.{className}", + "name": "Word Standard Pattern", + "classTemplate": "/javascript/api/word/word.{className}", + "interfaceTemplate": "/javascript/api/word/word.{className}", + "enumMemberTemplate": "/javascript/api/word/word.{className}#word-word-{className}-{fieldName}", + "enumTemplate": "/javascript/api/word/word.{className}" + } + ] +} diff --git a/generate-docs/configs/word-1_5-config.json b/generate-docs/configs/word-1_5-config.json index 949dd854ab..a7000dfb4e 100644 --- a/generate-docs/configs/word-1_5-config.json +++ b/generate-docs/configs/word-1_5-config.json @@ -1,19 +1,34 @@ { - "excludedFieldPatterns": [ - "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" - ], - "excludedFieldNames": [ - "load", - "set", - "toJSON", - "context", - "track", - "untrack" - ], - "excludedClassPatterns": [ - "LoadOptions$", - "Data$" - ], - "includeStaticFields": false, - "includeEnums": false + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/word", + "description": "Standard URL pattern for Word APIs", + "globalFunctionTemplate": "/javascript/api/word/word#{fieldName}", + "interfaceMemberTemplate": "/javascript/api/word/word.{className}#word-word-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/word/word.{className}#word-word-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/word/word.{className}", + "name": "Word Standard Pattern", + "classTemplate": "/javascript/api/word/word.{className}", + "interfaceTemplate": "/javascript/api/word/word.{className}", + "enumMemberTemplate": "/javascript/api/word/word.{className}#word-word-{className}-{fieldName}", + "enumTemplate": "/javascript/api/word/word.{className}" + } + ] } diff --git a/generate-docs/configs/word-1_5_hidden_document-config.json b/generate-docs/configs/word-1_5_hidden_document-config.json index 73079ddf18..a7000dfb4e 100644 --- a/generate-docs/configs/word-1_5_hidden_document-config.json +++ b/generate-docs/configs/word-1_5_hidden_document-config.json @@ -1,19 +1,34 @@ { - "excludedFieldPatterns": [ - "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" - ], - "excludedFieldNames": [ - "load", - "set", - "toJSON", - "context", - "track", - "untrack" - ], - "excludedClassPatterns": [ - "LoadOptions$", - "Data$" - ], - "includeStaticFields": false, - "includeEnums": false -} \ No newline at end of file + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/word", + "description": "Standard URL pattern for Word APIs", + "globalFunctionTemplate": "/javascript/api/word/word#{fieldName}", + "interfaceMemberTemplate": "/javascript/api/word/word.{className}#word-word-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/word/word.{className}#word-word-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/word/word.{className}", + "name": "Word Standard Pattern", + "classTemplate": "/javascript/api/word/word.{className}", + "interfaceTemplate": "/javascript/api/word/word.{className}", + "enumMemberTemplate": "/javascript/api/word/word.{className}#word-word-{className}-{fieldName}", + "enumTemplate": "/javascript/api/word/word.{className}" + } + ] +} diff --git a/generate-docs/configs/word-1_6-config.json b/generate-docs/configs/word-1_6-config.json index 949dd854ab..a7000dfb4e 100644 --- a/generate-docs/configs/word-1_6-config.json +++ b/generate-docs/configs/word-1_6-config.json @@ -1,19 +1,34 @@ { - "excludedFieldPatterns": [ - "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" - ], - "excludedFieldNames": [ - "load", - "set", - "toJSON", - "context", - "track", - "untrack" - ], - "excludedClassPatterns": [ - "LoadOptions$", - "Data$" - ], - "includeStaticFields": false, - "includeEnums": false + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/word", + "description": "Standard URL pattern for Word APIs", + "globalFunctionTemplate": "/javascript/api/word/word#{fieldName}", + "interfaceMemberTemplate": "/javascript/api/word/word.{className}#word-word-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/word/word.{className}#word-word-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/word/word.{className}", + "name": "Word Standard Pattern", + "classTemplate": "/javascript/api/word/word.{className}", + "interfaceTemplate": "/javascript/api/word/word.{className}", + "enumMemberTemplate": "/javascript/api/word/word.{className}#word-word-{className}-{fieldName}", + "enumTemplate": "/javascript/api/word/word.{className}" + } + ] } diff --git a/generate-docs/configs/word-1_7-config.json b/generate-docs/configs/word-1_7-config.json index 949dd854ab..a7000dfb4e 100644 --- a/generate-docs/configs/word-1_7-config.json +++ b/generate-docs/configs/word-1_7-config.json @@ -1,19 +1,34 @@ { - "excludedFieldPatterns": [ - "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" - ], - "excludedFieldNames": [ - "load", - "set", - "toJSON", - "context", - "track", - "untrack" - ], - "excludedClassPatterns": [ - "LoadOptions$", - "Data$" - ], - "includeStaticFields": false, - "includeEnums": false + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/word", + "description": "Standard URL pattern for Word APIs", + "globalFunctionTemplate": "/javascript/api/word/word#{fieldName}", + "interfaceMemberTemplate": "/javascript/api/word/word.{className}#word-word-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/word/word.{className}#word-word-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/word/word.{className}", + "name": "Word Standard Pattern", + "classTemplate": "/javascript/api/word/word.{className}", + "interfaceTemplate": "/javascript/api/word/word.{className}", + "enumMemberTemplate": "/javascript/api/word/word.{className}#word-word-{className}-{fieldName}", + "enumTemplate": "/javascript/api/word/word.{className}" + } + ] } diff --git a/generate-docs/configs/word-1_8-config.json b/generate-docs/configs/word-1_8-config.json index 949dd854ab..a7000dfb4e 100644 --- a/generate-docs/configs/word-1_8-config.json +++ b/generate-docs/configs/word-1_8-config.json @@ -1,19 +1,34 @@ { - "excludedFieldPatterns": [ - "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" - ], - "excludedFieldNames": [ - "load", - "set", - "toJSON", - "context", - "track", - "untrack" - ], - "excludedClassPatterns": [ - "LoadOptions$", - "Data$" - ], - "includeStaticFields": false, - "includeEnums": false + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/word", + "description": "Standard URL pattern for Word APIs", + "globalFunctionTemplate": "/javascript/api/word/word#{fieldName}", + "interfaceMemberTemplate": "/javascript/api/word/word.{className}#word-word-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/word/word.{className}#word-word-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/word/word.{className}", + "name": "Word Standard Pattern", + "classTemplate": "/javascript/api/word/word.{className}", + "interfaceTemplate": "/javascript/api/word/word.{className}", + "enumMemberTemplate": "/javascript/api/word/word.{className}#word-word-{className}-{fieldName}", + "enumTemplate": "/javascript/api/word/word.{className}" + } + ] } diff --git a/generate-docs/configs/word-desktop-1_1-config.json b/generate-docs/configs/word-desktop-1_1-config.json index c1427e89aa..ff8faa8931 100644 --- a/generate-docs/configs/word-desktop-1_1-config.json +++ b/generate-docs/configs/word-desktop-1_1-config.json @@ -1,37 +1,52 @@ { - "replacements": [ - { - "find": "@param importedStylesConflictBehavior - Optional. Specifies how to handle any imported styles with the same name as existing styles in the current document.", - "replace": "", - "description": "Remove importedStylesConflictBehavior parameter documentation when removing WordApiDesktop 1.1" - }, - { - "find": "Note: The `importedStylesConflictBehavior` parameter was introduced in WordApiDesktop 1.1.", - "replace": "", - "description": "Remove WordApiDesktop 1.1 note when removing WordApiDesktop 1.1" - }, - { - "find": "/,\\s*importedStylesConflictBehavior\\?:\\s*Word\\.ImportedStylesConflictBehavior[\\w\\W]*?importedStylesConflictBehaviorString\\?:\\s*\"Ignore\"\\s*\\|\\s*\"Overwrite\"\\s*\\|\\s*\"CreateNew\"\\):\\s*OfficeExtension\\.ClientResult;/gm", - "replace": "): OfficeExtension.ClientResult;", - "isRegex": true, - "description": "Remove importedStylesConflictBehavior parameter from method signature when removing WordApiDesktop 1.1" - } - ], - "excludedFieldPatterns": [ - "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" - ], - "excludedFieldNames": [ - "load", - "set", - "toJSON", - "context", - "track", - "untrack" - ], - "excludedClassPatterns": [ - "LoadOptions$", - "Data$" - ], - "includeStaticFields": false, - "includeEnums": false + "replacements": [ + { + "find": "@param importedStylesConflictBehavior - Optional. Specifies how to handle any imported styles with the same name as existing styles in the current document.", + "replace": "", + "description": "Remove importedStylesConflictBehavior parameter documentation when removing WordApiDesktop 1.1" + }, + { + "find": "Note: The `importedStylesConflictBehavior` parameter was introduced in WordApiDesktop 1.1.", + "replace": "", + "description": "Remove WordApiDesktop 1.1 note when removing WordApiDesktop 1.1" + }, + { + "find": "/,\\s*importedStylesConflictBehavior\\?:\\s*Word\\.ImportedStylesConflictBehavior[\\w\\W]*?importedStylesConflictBehaviorString\\?:\\s*\"Ignore\"\\s*\\|\\s*\"Overwrite\"\\s*\\|\\s*\"CreateNew\"\\):\\s*OfficeExtension\\.ClientResult\u003cstring\\[\\]\u003e;/gm", + "replace": "): OfficeExtension.ClientResult\u003cstring[]\u003e;", + "isRegex": true, + "description": "Remove importedStylesConflictBehavior parameter from method signature when removing WordApiDesktop 1.1" + } + ], + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/word", + "description": "Standard URL pattern for Word APIs", + "globalFunctionTemplate": "/javascript/api/word/word#{fieldName}", + "interfaceMemberTemplate": "/javascript/api/word/word.{className}#word-word-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/word/word.{className}#word-word-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/word/word.{className}", + "name": "Word Standard Pattern", + "classTemplate": "/javascript/api/word/word.{className}", + "interfaceTemplate": "/javascript/api/word/word.{className}", + "enumMemberTemplate": "/javascript/api/word/word.{className}#word-word-{className}-{fieldName}", + "enumTemplate": "/javascript/api/word/word.{className}" + } + ] } diff --git a/generate-docs/configs/word-desktop-1_2-config.json b/generate-docs/configs/word-desktop-1_2-config.json index 73079ddf18..a7000dfb4e 100644 --- a/generate-docs/configs/word-desktop-1_2-config.json +++ b/generate-docs/configs/word-desktop-1_2-config.json @@ -1,19 +1,34 @@ { - "excludedFieldPatterns": [ - "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" - ], - "excludedFieldNames": [ - "load", - "set", - "toJSON", - "context", - "track", - "untrack" - ], - "excludedClassPatterns": [ - "LoadOptions$", - "Data$" - ], - "includeStaticFields": false, - "includeEnums": false -} \ No newline at end of file + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/word", + "description": "Standard URL pattern for Word APIs", + "globalFunctionTemplate": "/javascript/api/word/word#{fieldName}", + "interfaceMemberTemplate": "/javascript/api/word/word.{className}#word-word-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/word/word.{className}#word-word-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/word/word.{className}", + "name": "Word Standard Pattern", + "classTemplate": "/javascript/api/word/word.{className}", + "interfaceTemplate": "/javascript/api/word/word.{className}", + "enumMemberTemplate": "/javascript/api/word/word.{className}#word-word-{className}-{fieldName}", + "enumTemplate": "/javascript/api/word/word.{className}" + } + ] +} diff --git a/generate-docs/configs/word-online-config.json b/generate-docs/configs/word-online-config.json index 73079ddf18..a7000dfb4e 100644 --- a/generate-docs/configs/word-online-config.json +++ b/generate-docs/configs/word-online-config.json @@ -1,19 +1,34 @@ { - "excludedFieldPatterns": [ - "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" - ], - "excludedFieldNames": [ - "load", - "set", - "toJSON", - "context", - "track", - "untrack" - ], - "excludedClassPatterns": [ - "LoadOptions$", - "Data$" - ], - "includeStaticFields": false, - "includeEnums": false -} \ No newline at end of file + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/word", + "description": "Standard URL pattern for Word APIs", + "globalFunctionTemplate": "/javascript/api/word/word#{fieldName}", + "interfaceMemberTemplate": "/javascript/api/word/word.{className}#word-word-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/word/word.{className}#word-word-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/word/word.{className}", + "name": "Word Standard Pattern", + "classTemplate": "/javascript/api/word/word.{className}", + "interfaceTemplate": "/javascript/api/word/word.{className}", + "enumMemberTemplate": "/javascript/api/word/word.{className}#word-word-{className}-{fieldName}", + "enumTemplate": "/javascript/api/word/word.{className}" + } + ] +} diff --git a/generate-docs/configs/word-preview-config.json b/generate-docs/configs/word-preview-config.json index 73079ddf18..a7000dfb4e 100644 --- a/generate-docs/configs/word-preview-config.json +++ b/generate-docs/configs/word-preview-config.json @@ -1,19 +1,34 @@ { - "excludedFieldPatterns": [ - "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" - ], - "excludedFieldNames": [ - "load", - "set", - "toJSON", - "context", - "track", - "untrack" - ], - "excludedClassPatterns": [ - "LoadOptions$", - "Data$" - ], - "includeStaticFields": false, - "includeEnums": false -} \ No newline at end of file + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false, + "linkConfigs": [ + { + "pathPattern": "javascript/api/word", + "description": "Standard URL pattern for Word APIs", + "globalFunctionTemplate": "/javascript/api/word/word#{fieldName}", + "interfaceMemberTemplate": "/javascript/api/word/word.{className}#word-word-{className}-{fieldName}{suffix}", + "classMemberTemplate": "/javascript/api/word/word.{className}#word-word-{className}-{fieldName}{suffix}", + "typeAliasTemplate": "/javascript/api/word/word.{className}", + "name": "Word Standard Pattern", + "classTemplate": "/javascript/api/word/word.{className}", + "interfaceTemplate": "/javascript/api/word/word.{className}", + "enumMemberTemplate": "/javascript/api/word/word.{className}#word-word-{className}-{fieldName}", + "enumTemplate": "/javascript/api/word/word.{className}" + } + ] +} diff --git a/generate-docs/script-inputs/office_preview.d.ts b/generate-docs/script-inputs/office_preview.d.ts index 82bede9637..7452677353 100644 --- a/generate-docs/script-inputs/office_preview.d.ts +++ b/generate-docs/script-inputs/office_preview.d.ts @@ -97234,6 +97234,359 @@ declare namespace Excel { //////////////////////////////////////////////////////////////// declare namespace Word { + /** + * Represents the {@link Word.Editor | editors} in a protected (read-only) Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class EditorCollection 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 `Editor` object that represents a new permission for the specified user to modify a range within the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param editorId The user's email alias (if in the same domain) or an email address. + */ + addById(editorId: string): Word.Editor; + /** + * Returns an `Editor` object that represents a new permission for the specified group of users to modify a range within the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param editorType An `EditorType` that represents a group of users. + */ + addByType(editorType: Word.EditorType): Word.Editor; + /** + * Returns an `Editor` object that represents a new permission for the specified group of users to modify a range within the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param editorType An `EditorType` that represents a group of users. + */ + addByType(editorType: "Current" | "Editors" | "Everyone" | "Owners"): Word.Editor; + /** + * Returns the number of items in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets an `Editor` object by its index in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index The index of the object in this collection. + */ + getItemAt(index: number): Word.Editor; + /** + * 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[]): Word.EditorCollection; + /** + * 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; + }): Word.EditorCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.EditorCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.EditorCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.EditorCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.EditorCollectionData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): { + [key: string]: string; + }; + } + /** + * Represents a user with permissions to edit authorized portions of a protected (read-only) Word document. To learn more, see {@link https://support.microsoft.com/office/187ed01c-8795-43e1-9fd0-c9fca419dadf | Allow changes to parts of a protected Word document}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class Editor 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 a `Range` object that represents the next range that the editor has permissions to modify. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly nextRange: Word.Range; + /** + * Gets a `Range` object that represents the portion of the document that's contained in the `Editor` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly range: Word.Range; + /** + * Gets the identifier for the `Editor` object when the parent document is saved as a webpage. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly id: string; + /** + * Gets the name of the editor. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly name: string; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.EditorUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Editor): void; + /** + * Deletes the `Editor` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + delete(): void; + /** + * Removes all editing permissions in the document for the editor. The editor will be deleted next time the document opens. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + removeAllPermissions(): void; + /** + * Selects all the shapes in the document that were inserted or edited by the editor. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + selectAllShapes(): 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?: Word.Interfaces.EditorLoadOptions): Word.Editor; + /** + * 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[]): Word.Editor; + /** + * 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; + }): Word.Editor; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.Editor; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.Editor; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Editor` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.EditorData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.EditorData; + } + /** + * Represents the coauthoring conflicts in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class ConflictCollection 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: Word.Conflict[]; + /** + * Accepts all of the user's changes, removes the conflicts, and merges the changes into the server copy of the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + acceptAll(): void; + /** + * Gets a `Conflict` object by its index in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index A number that identifies the index location of a `Conflict` object. + */ + getItem(index: number): Word.Conflict; + /** + * Rejects all of the user's changes and retains the server copy of the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + rejectAll(): 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?: Word.Interfaces.ConflictCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ConflictCollection; + /** + * 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[]): Word.ConflictCollection; + /** + * 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): Word.ConflictCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.ConflictCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.ConflictCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ConflictCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ConflictCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.ConflictCollectionData; + } + /** + * Represents a coauthoring conflict in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class Conflict 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 a `Range` object that represents the portion of the document that's contained in the `Conflict` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly range: Word.Range; + /** + * Gets the `RevisionType` for the `Conflict` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly type: Word.RevisionType | "None" | "Insert" | "Delete" | "Property" | "ParagraphNumber" | "DisplayField" | "Reconcile" | "Conflict" | "Style" | "Replace" | "ParagraphProperty" | "TableProperty" | "SectionProperty" | "StyleDefinition" | "MovedFrom" | "MovedTo" | "CellInsertion" | "CellDeletion" | "CellMerge" | "CellSplit" | "ConflictInsert" | "ConflictDelete"; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ConflictUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Conflict): void; + /** + * Accepts the user's change and removes the conflict. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + accept(): void; + /** + * Rejects the user's change, removes the conflict, and accepts the server copy of the change for the conflict. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + reject(): 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?: Word.Interfaces.ConflictLoadOptions): Word.Conflict; + /** + * 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[]): Word.Conflict; + /** + * 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; + }): Word.Conflict; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.Conflict; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.Conflict; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Conflict` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ConflictData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.ConflictData; + } /** * Represents the color scheme of a critique in the document, affecting underline and highlight. * @@ -97694,6 +98047,22 @@ declare namespace Word { * @beta */ readonly bibliography: Word.Bibliography; + /** + * Returns a `FontNameCollection` object that represents all the available font names in Microsoft Word. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly fontNames: Word.FontNameCollection; + /** + * Returns a `ListTemplateGalleryCollection` object that represents all the list template galleries in Microsoft Word. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly listTemplateGalleries: Word.ListTemplateGalleryCollection; /** * Returns a `TemplateCollection` object that represents all the available templates: global templates and those attached to open documents. * @@ -99379,6 +99748,521 @@ declare namespace Word { */ toJSON(): Word.Interfaces.CheckboxContentControlData; } + /** + * Represents a coauthoring lock in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class CoauthoringLock 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 owner of the lock. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly owner: Word.Coauthor; + /** + * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringLock` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly range: Word.Range; + /** + * Gets a `CoauthoringLockType` value that represents the lock type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly type: Word.CoauthoringLockType | "None" | "Reservation" | "Ephemeral" | "Changed"; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.CoauthoringLockUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.CoauthoringLock): void; + /** + * Removes this lock, even if it belongs to a different user. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + unlock(): 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?: Word.Interfaces.CoauthoringLockLoadOptions): Word.CoauthoringLock; + /** + * 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[]): Word.CoauthoringLock; + /** + * 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; + }): Word.CoauthoringLock; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.CoauthoringLock; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.CoauthoringLock; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.CoauthoringLock` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CoauthoringLockData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.CoauthoringLockData; + } + /** + * Represents a collection of coauthoring locks in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class CoauthoringLockCollection 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: Word.CoauthoringLock[]; + /** + * Returns a `CoauthoringLock` object that represents a lock added to a specified range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options Optional. The options to further configure the coauthoring lock. + */ + add(options?: Word.CoauthoringLockAddOptions): Word.CoauthoringLock; + /** + * Removes all ephemeral locks from the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + unlockEphemeralLocks(): 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?: Word.Interfaces.CoauthoringLockCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CoauthoringLockCollection; + /** + * 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[]): Word.CoauthoringLockCollection; + /** + * 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): Word.CoauthoringLockCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.CoauthoringLockCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.CoauthoringLockCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.CoauthoringLockCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CoauthoringLockCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.CoauthoringLockCollectionData; + } + /** + * Specifies the options for adding to a {@link Word.CoauthoringLockCollection} object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface CoauthoringLockAddOptions { + /** + * If provided, specifies the range to which the lock is added. If not provided, the new lock is placed on the paragraph that contains the insertion point. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Range; + /** + * If provided, specifies the type of lock. If not provided, the lock type is set to `reservation`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type?: Word.CoauthoringLockType | "None" | "Reservation" | "Ephemeral" | "Changed"; + } + /** + * Represents a coauthor in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class Coauthor 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 a `CoauthoringLockCollection` object that represents the locks in the document that are associated with this coauthor. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly locks: Word.CoauthoringLockCollection; + /** + * Gets the email address of the coauthor. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly emailAddress: string; + /** + * Gets the unique identifier for the `Coauthor` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly id: string; + /** + * Gets whether this author represents the current user. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly isMe: boolean; + /** + * Gets the display name of the coauthor. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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?: Word.Interfaces.CoauthorLoadOptions): Word.Coauthor; + /** + * 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[]): Word.Coauthor; + /** + * 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; + }): Word.Coauthor; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.Coauthor; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.Coauthor; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Coauthor` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CoauthorData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.CoauthorData; + } + /** + * Contains a collection of {@link Word.Coauthor} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class CoauthorCollection 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: Word.Coauthor[]; + /** + * 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?: Word.Interfaces.CoauthorCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CoauthorCollection; + /** + * 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[]): Word.CoauthorCollection; + /** + * 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): Word.CoauthorCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.CoauthorCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.CoauthorCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.CoauthorCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CoauthorCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.CoauthorCollectionData; + } + /** + * Represents the `Coauthoring` object. This tracks the updates, changes, conflicts, and other interactions in the document done through coauthoring. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class Coauthoring 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 a `CoauthorCollection` object that represents all the coauthors currently editing the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly authors: Word.CoauthorCollection; + /** + * Gets a `ConflictCollection` object that represents all the conflicts in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly conflicts: Word.ConflictCollection; + /** + * Gets a `CoauthoringLockCollection` object that represents the locks in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly locks: Word.CoauthoringLockCollection; + /** + * Gets a `Coauthor` object that represents the current user. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly me: Word.Coauthor; + /** + * Gets a `CoauthoringUpdateCollection` object that represents the most recent updates that were merged into the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly updates: Word.CoauthoringUpdateCollection; + /** + * Gets whether this document can be coauthored. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly canCoauthor: boolean; + /** + * Gets whether the document can be automatically merged. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly canMerge: boolean; + /** + * Gets whether the document has pending updates that have not been accepted. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly pendingUpdates: boolean; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * + * @param options Provides options for which properties of the object to load. + */ + load(options?: Word.Interfaces.CoauthoringLoadOptions): Word.Coauthoring; + /** + * 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[]): Word.Coauthoring; + /** + * 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; + }): Word.Coauthoring; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.Coauthoring; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.Coauthoring; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Coauthoring` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CoauthoringData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.CoauthoringData; + } + /** + * Represents a coauthoring update in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class CoauthoringUpdate 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 a `Range` object that represents the portion of the document that's contained in the `CoauthoringUpdate` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly range: Word.Range; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.CoauthoringUpdateUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.CoauthoringUpdate): 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?: Word.Interfaces.CoauthoringUpdateLoadOptions): Word.CoauthoringUpdate; + /** + * 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[]): Word.CoauthoringUpdate; + /** + * 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; + }): Word.CoauthoringUpdate; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.CoauthoringUpdate; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.CoauthoringUpdate; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.CoauthoringUpdate` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CoauthoringUpdateData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.CoauthoringUpdateData; + } + /** + * Contains a collection of {@link Word.CoauthoringUpdate} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class CoauthoringUpdateCollection 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: Word.CoauthoringUpdate[]; + /** + * 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?: Word.Interfaces.CoauthoringUpdateCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CoauthoringUpdateCollection; + /** + * 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[]): Word.CoauthoringUpdateCollection; + /** + * 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): Word.CoauthoringUpdateCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.CoauthoringUpdateCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.CoauthoringUpdateCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.CoauthoringUpdateCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CoauthoringUpdateCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.CoauthoringUpdateCollectionData; + } /** * Represents a comment in the document. * @@ -99841,6 +100725,115 @@ declare namespace Word { */ toJSON(): Word.Interfaces.CommentReplyCollectionData; } + /** + * Represents special formatting applied to specified areas of a table when the selected table is formatted with a specified table style. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class ConditionalStyle 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 `BorderUniversalCollection` object that represents all the borders for the conditional style. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly borders: Word.BorderUniversalCollection; + /** + * Returns a `Font` object that represents the font formatting for the conditional style. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly font: Word.Font; + /** + * Returns a `ParagraphFormat` object that represents the paragraph formatting for the conditional style. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly paragraphFormat: Word.ParagraphFormat; + /** + * Returns a `ShadingUniversal` object that represents the shading of the conditional style. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly shading: Word.ShadingUniversal; + /** + * Specifies the amount of space (in points) to add below the contents of a single cell or all the cells in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bottomPadding: number; + /** + * Specifies the amount of space (in points) to add to the left of the contents of a single cell or all the cells in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + leftPadding: number; + /** + * Specifies the amount of space (in points) to add to the right of the contents of a single cell or all the cells in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + rightPadding: number; + /** + * Specifies the amount of space (in points) to add above the contents of a single cell or all the cells in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + topPadding: 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?: Word.Interfaces.ConditionalStyleLoadOptions): Word.ConditionalStyle; + /** + * 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[]): Word.ConditionalStyle; + /** + * 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; + }): Word.ConditionalStyle; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.ConditionalStyle; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.ConditionalStyle; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ConditionalStyle` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ConditionalStyleData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.ConditionalStyleData; + } /** * Represents the XML mapping on a {@link Word.ContentControl} object between custom XML and that content control. An XML mapping is a link between the text in a content control and an XML element in the custom XML data store for this document. * @@ -102811,6 +103804,14 @@ declare namespace Word { * @beta */ readonly bookmarks: Word.BookmarkCollection; + /** + * Gets a `Coauthoring` object for managing coauthoring in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly coauthoring: Word.Coauthoring; /** * Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. * @@ -102857,6 +103858,14 @@ declare namespace Word { * @beta */ readonly indexes: Word.IndexCollection; + /** + * Returns a `ListTemplateCollection` object that represents all the list templates in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly listTemplates: Word.ListTemplateCollection; /** * Returns a `PageSetup` object that's associated with the document. * @@ -102872,6 +103881,14 @@ declare namespace Word { * [Api set: WordApi 1.3] */ readonly properties: Word.DocumentProperties; + /** + * Gets the collection of revisions that represents the tracked changes in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly revisions: Word.RevisionCollection; /** * Gets the collection of section objects in the document. * @@ -102879,6 +103896,14 @@ declare namespace Word { * [Api set: WordApi 1.1] */ readonly sections: Word.SectionCollection; + /** + * Returns a `Selection` object that represents the current selection in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly selection: Word.Selection; /** * Gets the add-in's settings in the document. * @@ -102886,6 +103911,38 @@ declare namespace Word { * [Api set: WordApi 1.4] */ readonly settings: Word.SettingCollection; + /** + * Returns a `TableOfAuthoritiesCategoryCollection` object that represents the available table of authorities categories in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly tableOfAuthoritiesCategories: Word.TableOfAuthoritiesCategoryCollection; + /** + * Returns a `TableOfAuthoritiesCollection` object that represents all the tables of authorities in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly tablesOfAuthorities: Word.TableOfAuthoritiesCollection; + /** + * Returns a `TableOfContentsCollection` object that represents all the tables of contents in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly tablesOfContents: Word.TableOfContentsCollection; + /** + * Returns a `TableOfFiguresCollection` object that represents all the tables of figures in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly tablesOfFigures: Word.TableOfFiguresCollection; /** * Gets the collection of `Word.Window` objects for the document. * @@ -104656,11 +105713,144 @@ declare namespace Word { */ untrack(): Word.Font; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Font` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FontData`) 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 `Word.Font` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FontData`) that contains shallow copies of any loaded child properties from the original object. + */ toJSON(): Word.Interfaces.FontData; } + /** + * Represents a heading style used in a table of contents or table of figures. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class HeadingStyle 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 level for the heading style in a table of contents or table of figures. Must be a value from 1 to 9. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + level: number; + /** + * Specifies the name of style for a heading. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + name: string; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.HeadingStyleUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.HeadingStyle): void; + /** + * Deletes the heading style. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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?: Word.Interfaces.HeadingStyleLoadOptions): Word.HeadingStyle; + /** + * 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[]): Word.HeadingStyle; + /** + * 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; + }): Word.HeadingStyle; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.HeadingStyle; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.HeadingStyle; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.HeadingStyle` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.HeadingStyleData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.HeadingStyleData; + } + /** + * Represents a collection of {@link Word.HeadingStyle} objects in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class HeadingStyleCollection 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: Word.HeadingStyle[]; + /** + * Adds a new heading style to a document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param name The style name to be added. + * @param level The heading level to assign. Must be a value from 1 to 9. + * @returns The new `HeadingStyle` object that was added to the collection. + */ + add(name: string, level: number): Word.HeadingStyle; + /** + * 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?: Word.Interfaces.HeadingStyleCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.HeadingStyleCollection; + /** + * 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[]): Word.HeadingStyleCollection; + /** + * 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): Word.HeadingStyleCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.HeadingStyleCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.HeadingStyleCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.HeadingStyleCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.HeadingStyleCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.HeadingStyleCollectionData; + } /** * Represents a hyperlink in a Word document. * @@ -105995,6 +107185,14 @@ declare namespace Word { * [Api set: WordApiDesktop 1.1] */ readonly listLevels: Word.ListLevelCollection; + /** + * Specifies the name of the list template. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + name: string; /** * Specifies whether the list template is outline numbered. * @@ -106551,6 +107749,14 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ readonly pagesEnclosingViewport: Word.PageCollection; + /** + * Returns a `Selection` object that represents the current selection in the pane. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly selection: Word.Selection; /** * Gets the next pane in the window. Throws an `ItemNotFound` error if this pane is the last one. * @@ -106565,6 +107771,12 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ getNextOrNullObject(): Word.Pane; + /** + * 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?: Word.Interfaces.PaneLoadOptions): Word.Pane; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -106619,6 +107831,12 @@ declare namespace Word { * [Api set: WordApiDesktop 1.2] */ getFirstOrNullObject(): Word.Pane; + /** + * 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?: Word.Interfaces.PaneCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.PaneCollection; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -106844,7 +108062,7 @@ declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - imemode: Word.ImeMode | "NoControl" | "On" | "Off" | "Hiragana" | "Katakana" | "KatakanaHalf" | "AlphaFull" | "Alpha" | "HangulFull" | "Hangul"; + imeMode: Word.ImeMode | "NoControl" | "On" | "Off" | "Hiragana" | "Katakana" | "KatakanaHalf" | "AlphaFull" | "Alpha" | "HangulFull" | "Hangul"; /** * Gets the position of an item in a collection. * @@ -107329,14 +108547,6 @@ declare namespace Word { * [Api set: WordApi 1.3] */ readonly parentTableOrNullObject: Word.Table; - /** - * Gets a `Range` object that represents the portion of the document that's contained within the paragraph. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - readonly range: Word.Range; /** * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. * @@ -108522,6 +109732,14 @@ declare namespace Word { * @beta */ readonly borders: Word.BorderUniversalCollection; + /** + * Returns a `ConflictCollection` object that contains all the {@link Word.Conflict} objects in the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly conflicts: Word.ConflictCollection; /** * Gets the collection of content control objects in the range. * @@ -108529,6 +109747,14 @@ declare namespace Word { * [Api set: WordApi 1.1] */ readonly contentControls: Word.ContentControlCollection; + /** + * Returns an `EditorCollection` object that represents all the users authorized to modify the range when the document is in protected (read-only) mode. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly editors: Word.EditorCollection; /** * Gets the collection of endnotes in the range. * @@ -108660,6 +109886,14 @@ declare namespace Word { * [Api set: WordApi 1.3] */ readonly parentTableOrNullObject: Word.Table; + /** + * Gets the collection of revisions that represents the tracked changes in the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly revisions: Word.RevisionCollection; /** * Gets the collection of sections in the range. * @@ -110723,6 +111957,14 @@ declare namespace Word { 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; + /** + * Returns the `TableColumnCollection` object that represents the columns in the table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly columns: Word.TableColumnCollection; /** * Gets the collection of endnotes in the table. * @@ -110807,6 +112049,14 @@ declare namespace Word { * [Api set: WordApi 1.3] */ readonly rows: Word.TableRowCollection; + /** + * Returns the `ShadingUniversal` object that represents the shading of the table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly shading: Word.ShadingUniversal; /** * Gets the child tables nested one level deeper. * @@ -110821,6 +112071,14 @@ declare namespace Word { * [Api set: WordApi 1.3] */ alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + /** + * Specifies the description of the table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + description: string; /** * Specifies the number of header rows. * @@ -110912,6 +112170,14 @@ declare namespace Word { * [Api set: WordApi 1.3] */ styleTotalRow: boolean; + /** + * Specifies the title of the table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + title: string; /** * Specifies the text values in the table, as a 2D JavaScript array. * @@ -110963,6 +112229,36 @@ declare namespace Word { * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array. */ addRows(insertLocation: Word.InsertLocation.start | Word.InsertLocation.end | "Start" | "End", rowCount: number, values?: string[][]): Word.TableRowCollection; + /** + * Applies the specified style but maintains any formatting that a user directly applies. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param styleName The name of the style to apply. + */ + applyStyleDirectFormatting(styleName: string): void; + /** + * Determines how Microsoft Word resizes a table when the AutoFit feature is used. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param behavior How Word resizes the specified table with the AutoFit feature is used. + */ + autoFitBehavior(behavior: Word.AutoFitBehavior): void; + /** + * Determines how Microsoft Word resizes a table when the AutoFit feature is used. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param behavior How Word resizes the specified table with the AutoFit feature is used. + */ + autoFitBehavior(behavior: "FixedSize" | "Content" | "Window"): void; /** * Autofits the table columns to the width of the window. * @@ -110970,6 +112266,16 @@ declare namespace Word { * [Api set: WordApi 1.3] */ autoFitWindow(): void; + /** + * Applies a predefined look to a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options Optional. An object that specifies the options for applying the table format. + */ + autoFormat(options?: Word.TableAutoFormatOptions): void; /** * Clears the contents of the table. * @@ -110977,6 +112283,17 @@ declare namespace Word { * [Api set: WordApi 1.3] */ clear(): void; + /** + * Converts a table to text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options An object that specifies the options for converting the table to text. + * @returns A `Range` object that represents the converted text. + */ + convertToText(options?: Word.TableConvertToTextOptions): Word.Range; /** * Deletes the entire table. * @@ -111159,6 +112476,14 @@ declare namespace Word { * @param lastCell Required. The index of the last cell in its row */ mergeCells(topRow: number, firstCell: number, bottomRow: number, lastCell: number): Word.TableCell; + /** + * Updates the table with the characteristics of the predefined table format set when the `autoFormat` method was called. The default predefined format is {@link Word.TableFormatType | TableFormatType.none}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + reapplyAutoFormat(): void; /** * Performs a search with the specified SearchOptions on the scope of the table object. The search results are a collection of range objects. * @@ -111215,6 +112540,16 @@ declare namespace Word { * @param cellPadding Required. The cell padding. */ setCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void; + /** + * Sorts the specified table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options An object that specifies the options for sorting the table. + */ + sort(options?: Word.TableSortOptions): void; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -111259,6 +112594,22 @@ declare namespace Word { class TableStyle 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 `BorderUniversalCollection` that represents all the borders for the table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly borders: Word.BorderUniversalCollection; + /** + * Returns a `ShadingUniversal` object that refers to the shading formatting for the table style. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly shading: Word.Shading; /** * Specifies the table's alignment against the page margin. * @@ -111287,6 +112638,22 @@ declare namespace Word { * [Api set: WordApi 1.6] */ cellSpacing: number; + /** + * Specifies the number of columns in the banding when a style specifies odd- or even-column banding. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + columnStripe: number; + /** + * Specifies whether Microsoft Word allows to break the specified table across pages. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isBreakAcrossPagesAllowed: boolean; /** * Specifies the amount of space to add between the contents and the left borders of the cells. * @@ -111294,6 +112661,14 @@ declare namespace Word { * [Api set: WordApi 1.6] */ leftCellMargin: number; + /** + * Specifies the left indent value (in points) for the rows in the table style. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + leftIndent: number; /** * Specifies the amount of space to add between the contents and the right borders of the cells. * @@ -111301,6 +112676,22 @@ declare namespace Word { * [Api set: WordApi 1.6] */ rightCellMargin: number; + /** + * Specifies the number of rows to include in the banding when the style specifies odd- or even-row banding. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + rowStripe: number; + /** + * Specifies the direction in which Microsoft Word orders cells in the table style. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tableDirection: Word.TableDirection | "RightToLeft" | "LeftToRight"; /** * Specifies the amount of space to add between the contents and the top borders of the cells. * @@ -111316,6 +112707,26 @@ declare namespace Word { set(properties: Interfaces.TableStyleUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ set(properties: Word.TableStyle): void; + /** + * Returns a `ConditionalStyle` object that represents special style formatting for a portion of a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param conditionCode The area of the table to which to apply the formatting. + */ + condition(conditionCode: Word.ConditionCode): Word.ConditionalStyle; + /** + * Returns a `ConditionalStyle` object that represents special style formatting for a portion of a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param conditionCode The area of the table to which to apply the formatting. + */ + condition(conditionCode: "FirstRow" | "LastRow" | "OddRowBanding" | "EvenRowBanding" | "FirstColumn" | "LastColumn" | "OddColumnBanding" | "EvenColumnBanding" | "TopRightCell" | "TopLeftCell" | "BottomRightCell" | "BottomLeftCell"): Word.ConditionalStyle; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -111917,277 +113328,427 @@ declare namespace Word { toJSON(): Word.Interfaces.TableColumnCollectionData; } /** - * Represents a row in a Word document. + * Represents a table of authorities in a Word document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - class TableRow extends OfficeExtension.ClientObject { + class TableOfAuthorities 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 cells. + * Gets the portion of a document that is this table of authorities. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly cells: Word.TableCellCollection; + readonly range: Word.Range; /** - * Gets the collection of endnotes in the table row. + * Specifies the name of the bookmark from which to collect table of authorities entries. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly endnotes: Word.NoteItemCollection; + bookmark: string; /** - * Gets the collection of field objects in the table row. + * Specifies the category of entries to be included in the table of authorities. + Values 0 through 16 correspond to the items listed in the Category box of the Table of Authorities dialog. To learn how to access this through the Word UI, see {@link https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0 | Create a table of authorities}. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly fields: Word.FieldCollection; + category: number; /** - * Gets the font. Use this to get and set font name, size, color, and other properties. + * Specifies a separator of up to five characters. This appears between the table of authorities entry and its page number. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly font: Word.Font; + entrySeparator: string; /** - * Gets the collection of footnotes in the table row. + * Specifies whether the category name for a group of entries appears in the table of authorities. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly footnotes: Word.NoteItemCollection; + isCategoryHeaderIncluded: boolean; /** - * Gets parent table. + * Specifies whether the entries in the table of authorities are displayed with their formatting in the table. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly parentTable: Word.Table; + isEntryFormattingKept: boolean; /** - * Gets the number of cells in the row. + * Specifies whether references to the same authority that are repeated on five or more pages are replaced with "Passim". * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly cellCount: number; + isPassimUsed: boolean; /** - * Specifies the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Specifies a separator of up to five characters. This appears between individual page references in the table of authorities. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - horizontalAlignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + pageNumberSeparator: string; /** - * Checks whether the row is a header row. To set the number of header rows, use `headerRowCount` on the Table object. + * Specifies a separator of up to five characters. This appears between ranges of pages in the table of authorities. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly isHeader: boolean; + pageRangeSeparator: string; /** - * Specifies the preferred height of the row in points. + * Specifies the {@link https://support.microsoft.com/office/062a387b-dfc9-4ef8-8235-29ee113d59be | Sequence (SEQ) field} identifier for the table of authorities. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - preferredHeight: number; + sequenceName: string; /** - * Gets the index of the row in its parent table. + * Specifies a separator of up to five characters. This appears between the sequence number and the page number in the table of authorities. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly rowIndex: number; + sequenceSeparator: string; /** - * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * Specifies the leader character that appears between entries and their associated page numbers in the table of authorities. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shadingColor: string; + tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** - * Specifies the text values in the row, as a 2D JavaScript array. + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.TableOfAuthoritiesUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.TableOfAuthorities): void; + /** + * Deletes this table of authorities. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - values: string[][]; + delete(): void; /** - * Specifies the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.3] + * @param options Provides options for which properties of the object to load. */ - verticalAlignment: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + load(options?: Word.Interfaces.TableOfAuthoritiesLoadOptions): Word.TableOfAuthorities; /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * 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. */ - set(properties: Interfaces.TableRowUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.TableRow): void; + load(propertyNames?: string | string[]): Word.TableOfAuthorities; /** - * Clears the contents of the row. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.3] + * @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. */ - clear(): void; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.TableOfAuthorities; /** - * Deletes the entire row. + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.TableOfAuthorities; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.TableOfAuthorities; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TableOfAuthorities` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfAuthoritiesData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.TableOfAuthoritiesData; + } + /** + * Represents a collection of {@link Word.TableOfAuthorities} objects in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class TableOfAuthoritiesCollection 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: Word.TableOfAuthorities[]; + /** + * Adds a table of authorities to the document at the specified range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param range The range where the table of authorities will appear. The table of authorities replaces the range if the range isn't collapsed. + * @param options Optional. The options to configure the table of authorities. */ - delete(): void; + add(range: Word.Range, options?: Word.TableOfAuthoritiesAddOptions): Word.TableOfAuthorities; /** - * Gets the border style of the cells in the row. + * Inserts a {@link https://support.microsoft.com/office/2a90ad2b-4169-475d-8a09-e62521d4159c | Table of Authorities Entry (TA) field} after all instances of the specified citation text. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta * - * @param borderLocation Required. The border location. + * @param shortCitation The citation text to mark. + * @param options Optional. The options for marking the citation. */ - getBorder(borderLocation: Word.BorderLocation): Word.TableBorder; + markAllCitations(shortCitation: string, options?: Word.TableOfAuthoritiesMarkCitationOptions): void; /** - * Gets the border style of the cells in the row. + * Inserts a {@link https://support.microsoft.com/office/2a90ad2b-4169-475d-8a09-e62521d4159c | Table of Authorities Entry (TA) field} at the specified range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta * - * @param borderLocation Required. The border location. + * @param range The range where the citation will be inserted. + * @param shortCitation The short citation text. + * @param options Optional. The options for marking the citation. */ - getBorder(borderLocation: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder; + markCitation(range: Word.Range, shortCitation: string, options?: Word.TableOfAuthoritiesMarkCitationOptions): Word.Field; /** - * Gets cell padding in points. + * Finds and selects the next instance of the specified citation text. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta * - * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * @param shortCitation The citation text to search for. */ - getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult; + selectNextCitation(shortCitation: string): void; /** - * Gets cell padding in points. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.3] + * @param options Provides options for which properties of the object to load. + */ + load(options?: Word.Interfaces.TableOfAuthoritiesCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableOfAuthoritiesCollection; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult; + load(propertyNames?: string | string[]): Word.TableOfAuthoritiesCollection; /** - * Gets the next row. Throws an `ItemNotFound` error if this row is the last one. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi 1.3] + * @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. */ - getNext(): Word.TableRow; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableOfAuthoritiesCollection; /** - * Gets the next row. If this row is the last one, then this method will return 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}. + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.TableOfAuthoritiesCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.TableOfAuthoritiesCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TableOfAuthoritiesCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfAuthoritiesCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.TableOfAuthoritiesCollectionData; + } + /** + * Specifies the options for adding to a {@link Word.TableOfAuthoritiesCollection} object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface TableOfAuthoritiesAddOptions { + /** + * If provided, specifies the string name of the bookmark from which to collect entries for a table of authorities. + When specified, the entries are collected only from the portion of the document marked by the bookmark. + Corresponds to the `\b` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getNextOrNullObject(): Word.TableRow; + bookmark?: string; /** - * Inserts a content control on the row. + * If provided, specifies the category of entries to include in a table of authorities. + Corresponds to the `\c` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. + Values 0 through 16 correspond to the items listed in the Category box of the Table of Authorities dialog. To learn how to access this through the Word UI, see {@link https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0 | Create a table of authorities}. + The default value is `1`. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - insertContentControl(): Word.ContentControl; + category?: number; /** - * Inserts rows using this row as a template. If values are specified, inserts the values into the new rows. + * If provided, specifies a separator of up to five characters. This appears between the table of authorities entry and its page number. + Corresponds to the `\e` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. + If omitted, no separator is used. * * @remarks - * [Api set: WordApi 1.3] - * - * @param insertLocation Required. Where the new rows should be inserted, relative to the current row. It must be 'Before' or 'After'. - * @param rowCount Required. Number of rows to add - * @param values Optional. Strings to insert in the new rows, specified as a 2D array. The number of cells in each row must not exceed the number of cells in the existing row. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - insertRows(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", rowCount: number, values?: string[][]): Word.TableRowCollection; + entrySeparator?: string; /** - * Merges the row into one cell. + * If provided, specifies whether the category name for each group of entries appears in a table of authorities (e.g., "Cases"). + Corresponds to the `\h` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. + The default value is `true`. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - merge(): Word.TableCell; + includeCategoryHeader?: boolean; /** - * Performs a search with the specified SearchOptions on the scope of the row. The search results are a collection of range objects. + * If provided, specifies whether the entries in a table of authorities are displayed with their formatting in the table. + Corresponds to the `\f` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. + The default value is `true`. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + keepEntryFormatting?: boolean; + /** + * If provided, specifies a separator of up to five characters. This appears between individual page references in a table of authorities. + Corresponds to the `\l` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. + If omitted, a comma and a space (", ") are used. * - * @param searchText Required. The search text. - * @param searchOptions Optional. Options for the search. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - search(searchText: string, searchOptions?: Word.SearchOptions | { - ignorePunct?: boolean; - ignoreSpace?: boolean; - matchCase?: boolean; - matchPrefix?: boolean; - matchSuffix?: boolean; - matchWholeWord?: boolean; - matchWildcards?: boolean; - }): Word.RangeCollection; + pageNumberSeparator?: string; /** - * Selects the row and navigates the Word UI to it. + * If provided, specifies a separator of up to five characters. This appears between ranges of pages in a table of authorities. + Corresponds to the `\g` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. + If omitted, an en dash ("–") is used. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + pageRangeSeparator?: string; + /** + * If provided, specifies the string that identifies the Sequence (SEQ) field identifier for a table of authorities. + Corresponds to the `\s` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. * - * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - select(selectionMode?: Word.SelectionMode): void; + sequenceName?: string; /** - * Selects the row and navigates the Word UI to it. + * If provided, specifies a separator of up to five characters. This appears between the sequence number and the page number in a table of authorities. + Corresponds to the `\d` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. + If omitted, a hyphen ("-") is used. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sequenceSeparator?: string; + /** + * If provided, specifies whether references to the same authority that are repeated on five or more pages are replaced with "Passim". + Corresponds to the `\p` switch for a {@link https://support.microsoft.com/office/c754a963-90c1-4d32-b2db-1ed90b9dd958 | Table of Authorities (TOA) field}. + The default value is `false`. * - * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - select(selectionMode?: "Select" | "Start" | "End"): void; + usePassim?: boolean; + } + /** + * Specifies the options for inserting a {@link https://support.microsoft.com/office/2a90ad2b-4169-475d-8a09-e62521d4159c | Table of Authorities Entry (TA) field}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface TableOfAuthoritiesMarkCitationOptions { /** - * Sets cell padding in points. + * If provided, specifies the category number to be associated with the entry. + Values 1 through 16 correspond to the items listed in the Category dropdown list of the Mark Citation dialog. + The value `1` corresponds to the first category listed, `2` corresponds to the second category, and so on. + To learn how to access this through the Word UI, see {@link https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0 | Create a table of authorities}. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + category?: number; + /** + * If provided, specifies the long citation for the entry as it will appear in a table of authorities. * - * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. - * @param cellPadding Required. The cell padding. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void; + longCitation?: string; /** - * Sets cell padding in points. + * If provided, specifies the name of the AutoText entry that contains the text of the long citation as it will appear in a table of authorities. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + longCitationAutoText?: string; + } + /** + * Represents a category used in a table of authorities. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class TableOfAuthoritiesCategory 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 name of this table of authorities category. + Changing the name of the category doesn't change the index in the collection. The value for {@link Word.TableOfAuthorities | TableOfAuthorities.category} will remain the same. * - * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. - * @param cellPadding Required. The cell padding. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - setCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void; + 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?: Word.Interfaces.TableRowLoadOptions): Word.TableRow; + load(options?: Word.Interfaces.TableOfAuthoritiesCategoryLoadOptions): Word.TableOfAuthoritiesCategory; /** * 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[]): Word.TableRow; + load(propertyNames?: string | string[]): Word.TableOfAuthoritiesCategory; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -112196,619 +113757,640 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.TableRow; + }): Word.TableOfAuthoritiesCategory; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - track(): Word.TableRow; + track(): Word.TableOfAuthoritiesCategory; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - untrack(): Word.TableRow; + untrack(): Word.TableOfAuthoritiesCategory; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TableRow` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableRowData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.TableOfAuthoritiesCategory` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfAuthoritiesCategoryData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.TableRowData; + toJSON(): Word.Interfaces.TableOfAuthoritiesCategoryData; } /** - * Contains the collection of the document's TableRow objects. + * Represents a collection of {@link Word.TableOfAuthoritiesCategory} objects in a Word document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - class TableRowCollection extends OfficeExtension.ClientObject { + class TableOfAuthoritiesCategoryCollection 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: Word.TableRow[]; + readonly items: Word.TableOfAuthoritiesCategory[]; /** - * Gets the first row in this collection. Throws an `ItemNotFound` error if this collection is empty. + * Returns the number of items in the collection. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getFirst(): Word.TableRow; + getCount(): OfficeExtension.ClientResult; /** - * Gets the first row in this collection. If this collection is empty, then this method will return 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}. + * Returns a `TableOfAuthoritiesCategory` object that represents the specified item in the collection. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index The index of the item to retrieve. */ - getFirstOrNullObject(): Word.TableRow; + getItemAt(index: number): Word.TableOfAuthoritiesCategory; /** * 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?: Word.Interfaces.TableRowCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableRowCollection; + load(options?: Word.Interfaces.TableOfAuthoritiesCategoryCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableOfAuthoritiesCategoryCollection; /** * 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[]): Word.TableRowCollection; + load(propertyNames?: string | string[]): Word.TableOfAuthoritiesCategoryCollection; /** * 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): Word.TableRowCollection; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableOfAuthoritiesCategoryCollection; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - track(): Word.TableRowCollection; + track(): Word.TableOfAuthoritiesCategoryCollection; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - untrack(): Word.TableRowCollection; + untrack(): Word.TableOfAuthoritiesCategoryCollection; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TableRowCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableRowCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * Whereas the original `Word.TableOfAuthoritiesCategoryCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfAuthoritiesCategoryCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.TableRowCollectionData; + toJSON(): Word.Interfaces.TableOfAuthoritiesCategoryCollectionData; } /** - * Represents a table cell in a Word document. + * Represents a table of contents in a Word document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - class TableCell extends OfficeExtension.ClientObject { + class TableOfContents 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 body object of the cell. + * Gets the additional styles used for the table of contents. The default "Heading 1" - "Heading 9" styles aren't included in this collection. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly body: Word.Body; + readonly additionalHeadingStyles: Word.HeadingStyleCollection; /** - * Gets the parent row of the cell. + * Gets the portion of a document that is this table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly parentRow: Word.TableRow; + readonly range: Word.Range; /** - * Gets the parent table of the cell. + * Specifies whether built-in heading styles are used for the table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly parentTable: Word.Table; + areBuiltInHeadingStylesUsed: boolean; /** - * Gets the index of the cell in its row. + * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly cellIndex: number; + areFieldsUsed: boolean; /** - * Specifies the width of the cell's column in points. This is applicable to uniform tables. + * Specifies whether entries in the table of contents should be formatted as hyperlinks when publishing to the web. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - columnWidth: number; + areHyperlinksUsedOnWeb: boolean; /** - * Specifies the horizontal alignment of the cell. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Specifies whether the page numbers in the table of contents should be hidden when publishing to the web. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - horizontalAlignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + arePageNumbersHiddenOnWeb: boolean; /** - * Gets the index of the cell's row in the table. + * Specifies whether page numbers are included in the table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly rowIndex: number; + arePageNumbersIncluded: boolean; /** - * Specifies the shading color of the cell. Color is specified in "#RRGGBB" format or by using the color name. + * Specifies whether page numbers are aligned with the right margin in the table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shadingColor: string; + arePageNumbersRightAligned: boolean; /** - * Specifies the text of the cell. + * Specifies the ending heading level for the table of contents. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - value: string; + lowerHeadingLevel: number; /** - * Specifies the vertical alignment of the cell. The value can be 'Top', 'Center', or 'Bottom'. + * Specifies the character between entries and their page numbers in the table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - verticalAlignment: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** - * Gets the width of the cell in points. + * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly width: number; + tableId: string; + /** + * Specifies the starting heading level for the table of contents. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + upperHeadingLevel: number; /** * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - set(properties: Interfaces.TableCellUpdateData, options?: OfficeExtension.UpdateOptions): void; + set(properties: Interfaces.TableOfContentsUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.TableCell): void; + set(properties: Word.TableOfContents): void; /** - * Deletes the column containing this cell. This is applicable to uniform tables. + * Deletes this table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - deleteColumn(): void; + delete(): void; /** - * Deletes the row containing this cell. + * Updates the entire table of contents. * * @remarks - * [Api set: WordApi 1.3] - */ - deleteRow(): void; + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta /** - * Gets the border style for the specified border. + * Updates only the page numbers for items in this table of contents. * * @remarks - * [Api set: WordApi 1.3] - * - * @param borderLocation Required. The border location. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getBorder(borderLocation: Word.BorderLocation): Word.TableBorder; + updatePageNumbers(): void; /** - * Gets the border style for the specified border. - * - * @remarks - * [Api set: WordApi 1.3] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param borderLocation Required. The border location. + * @param options Provides options for which properties of the object to load. */ - getBorder(borderLocation: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder; + load(options?: Word.Interfaces.TableOfContentsLoadOptions): Word.TableOfContents; /** - * Gets cell padding in points. - * - * @remarks - * [Api set: WordApi 1.3] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult; + load(propertyNames?: string | string[]): Word.TableOfContents; /** - * Gets cell padding in points. - * - * @remarks - * [Api set: WordApi 1.3] + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * @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. */ - getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.TableOfContents; /** - * Gets the next cell. Throws an `ItemNotFound` error if this cell is the last one. - * - * @remarks - * [Api set: WordApi 1.3] - */ - getNext(): Word.TableCell; - /** - * Gets the next cell. If this cell is the last one, then this method will return 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: WordApi 1.3] - */ - getNextOrNullObject(): Word.TableCell; - /** - * Adds columns to the left or right of the cell, using the cell's column as a template. This is applicable to uniform tables. The string values, if specified, are set in the newly inserted rows. - * - * @remarks - * [Api set: WordApi 1.3] - * - * @param insertLocation Required. It must be 'Before' or 'After'. - * @param columnCount Required. Number of columns to add. - * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array. + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - insertColumns(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", columnCount: number, values?: string[][]): void; + track(): Word.TableOfContents; /** - * Inserts rows above or below the cell, using the cell's row as a template. The string values, if specified, are set in the newly inserted rows. - * - * @remarks - * [Api set: WordApi 1.3] - * - * @param insertLocation Required. It must be 'Before' or 'After'. - * @param rowCount Required. Number of rows to add. - * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array. + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - insertRows(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", rowCount: number, values?: string[][]): Word.TableRowCollection; + untrack(): Word.TableOfContents; /** - * Sets cell padding in points. - * - * @remarks - * [Api set: WordApi 1.3] - * - * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. - * @param cellPadding Required. The cell padding. + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TableOfContents` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfContentsData`) that contains shallow copies of any loaded child properties from the original object. */ - setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void; + toJSON(): Word.Interfaces.TableOfContentsData; + } + /** + * Represents a collection of {@link Word.TableOfContents} objects in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class TableOfContentsCollection 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: Word.TableOfContents[]; /** - * Sets cell padding in points. + * Adds a table of contents to the document at the specified range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta * - * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. - * @param cellPadding Required. The cell padding. + * @param range The range where the table of contents will be added. The table of contents replaces the range if the range isn't collapsed. + * @param options Optional. The options for configuring the table of contents. */ - setCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void; + add(range: Word.Range, options?: Word.TableOfContentsAddOptions): Word.TableOfContents; /** - * Splits the cell into the specified number of rows and columns. + * Inserts a {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) field} after the specified range. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta * - * @param rowCount Required. The number of rows to split into. Must be a divisor of the number of underlying rows. - * @param columnCount Required. The number of columns to split into. + * @param range The range where the entry will be inserted. + * @param options Optional. The options for marking the table of contents entry. */ - split(rowCount: number, columnCount: number): void; + markTocEntry(range: Word.Range, options?: Word.TableOfContentsMarkEntryOptions): Word.Field; /** * 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?: Word.Interfaces.TableCellLoadOptions): Word.TableCell; + load(options?: Word.Interfaces.TableOfContentsCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableOfContentsCollection; /** * 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[]): Word.TableCell; + load(propertyNames?: string | string[]): Word.TableOfContentsCollection; /** * 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; - }): Word.TableCell; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableOfContentsCollection; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - track(): Word.TableCell; + track(): Word.TableOfContentsCollection; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - untrack(): Word.TableCell; + untrack(): Word.TableOfContentsCollection; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TableCell` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableCellData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.TableOfContentsCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfContentsCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.TableCellData; + toJSON(): Word.Interfaces.TableOfContentsCollectionData; } /** - * Contains the collection of the document's TableCell objects. + * Specifies the options for adding to a {@link Word.TableOfContentsCollection} object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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: Word.TableCell[]; + interface TableOfContentsAddOptions { /** - * Gets the first table cell in this collection. Throws an `ItemNotFound` error if this collection is empty. + * If provided, specifies the string names of additional styles to use for the table of contents. + Use {@link Word.HeadingStyleCollection | HeadingStyleCollection.add} to create new heading styles. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getFirst(): Word.TableCell; + addedStyles?: string; /** - * Gets the first table cell in this collection. If this collection is empty, then this method will return 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}. + * If provided, specifies whether the page numbers in a table of contents should be hidden when publishing to the web. + The default value is `true`. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getFirstOrNullObject(): Word.TableCell; + hidePageNumbersOnWeb?: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * If provided, specifies whether to include page numbers in a table of contents. + The default value is `true`. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.TableCellCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableCellCollection; + includePageNumbers?: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * If provided, specifies the ending heading level for a table of contents and must be a value from 1 to 9. Must be greater than `upperHeadingLevel`. + Corresponds to the ending value used with the `\o` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. + The default value is `9`. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.TableCellCollection; + lowerHeadingLevel?: number; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * If provided, specifies whether page numbers in a table of contents are aligned with the right margin. + The default value is `true`. * - * @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): Word.TableCellCollection; - /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. - */ - track(): Word.TableCellCollection; - /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. - */ - untrack(): Word.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 `Word.TableCellCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableCellCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.TableCellCollectionData; - } - /** - * Specifies the border style. - * - * @remarks - * [Api set: WordApi 1.3] - */ - class TableBorder 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; + rightAlignPageNumbers?: boolean; /** - * Specifies the table border color. + * If provided, specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for a table of contents. + Corresponds to the `\f` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. For example, "T" indicates a table of contents includes TC fields that use the table identifier T. + If this argument is omitted, TC fields aren't used. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - color: string; + tableId?: string; /** - * Specifies the type of the table border. + * If provided, specifies the starting heading level for a table of contents and must be a value from 1 to 9. Should be smaller than `lowerHeadingLevel`. + Corresponds to the starting value used with the `\o` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. + The default value is `1`. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + upperHeadingLevel?: number; /** - * Specifies the width, in points, of the table border. Not applicable to table border types that have fixed widths. + * If provided, specifies whether to use built-in heading styles to create a table of contents. + The default value is `true`. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width: number; + useBuiltInHeadingStyles?: boolean; /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * If provided, specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are used to create a table of contents. + Use the {@link Word.TableOfContentsCollection | TableOfContentsCollection.markTocEntry} method to mark entries to be included in a table of contents. + The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.TableBorderUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.TableBorder): void; + useFields?: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * If provided, specifies whether entries in a table of contents should be formatted as hyperlinks when the document is published to the web. + The default value is `true`. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.TableBorderLoadOptions): Word.TableBorder; + useHyperlinksOnWeb?: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * If provided, specifies whether to use outline levels to create a table of contents. + The default value is `false`. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.TableBorder; + useOutlineLevels?: boolean; + } + /** + * Specifies the options for inserting a {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) field}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface TableOfContentsMarkEntryOptions { /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * If provided, specifies the text that appears in a table of contents or table of figures. + To indicate a subentry, include the main entry text and the subentry text, separated by a colon (":") (e.g., "Introduction:The Product"). + When the `entryAutoText` property is set, this property is ignored. * - * @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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.TableBorder; + entry?: string; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + * If provided, specifies the AutoText entry name that includes text for the table of figures, or table of contents. + When this property is used, the `entry` property is ignored. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.TableBorder; + entryAutoText?: string; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + * If provided, specifies the level for the entry in a table of contents or table of figures and should be a value from 1 to 9. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.TableBorder; + level?: 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 `Word.TableBorder` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableBorderData`) that contains shallow copies of any loaded child properties from the original object. + * If provided, specifies a one-letter identifier for a table of contents or table of figures (e.g., "i" for an "illustration"). + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.TableBorderData; + tableId?: string; } /** - * Represents a document template. + * Represents a table of figures in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - class Template extends OfficeExtension.ClientObject { + class TableOfFigures 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 `BuildingBlockEntryCollection` object that represents the collection of building block entries in the template. + * Gets the additional styles used for the table of figures. The default "Heading 1" - "Heading 9" styles aren't included in this collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly buildingBlockEntries: Word.BuildingBlockEntryCollection; + readonly additionalHeadingStyles: Word.HeadingStyleCollection; /** - * Returns a `BuildingBlockTypeItemCollection` object that represents the collection of building block types that are contained in the template. + * Gets the portion of a document that is this table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly buildingBlockTypes: Word.BuildingBlockTypeItemCollection; + readonly range: Word.Range; /** - * Specifies the East Asian language to use when breaking lines of text in the document or template. + * Specifies whether built-in heading styles are used for the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - farEastLineBreakLanguage: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; + areBuiltInHeadingStylesUsed: boolean; /** - * Specifies the line break control level for the document. + * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - farEastLineBreakLevel: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"; + areFieldsUsed: boolean; /** - * Returns the name of the template, including the drive or Web path. + * Specifies whether entries in the table of figures should be formatted as hyperlinks when publishing to the web. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly fullName: string; + areHyperlinksUsedOnWeb: boolean; /** - * Specifies whether the spelling and grammar checker ignores documents based on this template. + * Specifies whether the page numbers in the table of figures should be hidden when publishing to the web. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hasNoProofing: boolean; + arePageNumbersHiddenOnWeb: boolean; /** - * Specifies the character spacing adjustment for the template. + * Specifies whether page numbers are included in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - justificationMode: Word.JustificationMode | "Expand" | "Compress" | "CompressKana"; + arePageNumbersIncluded: boolean; /** - * Specifies if Microsoft Word kerns half-width Latin characters and punctuation marks in the document. + * Specifies whether page numbers are aligned with the right margin in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - kerningByAlgorithm: boolean; + arePageNumbersRightAligned: boolean; /** - * Specifies a `LanguageId` value that represents the language in the template. + * Specifies the label that identifies the items to be included in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageId: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + captionLabel: string; /** - * Specifies an East Asian language for the language in the template. + * Specifies whether the caption label and caption number are included in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageIdFarEast: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + isLabelIncluded: boolean; /** - * Returns only the name of the document template (excluding any path or other location information). + * Specifies the ending heading level for the table of figures. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly name: string; + lowerHeadingLevel: number; /** - * Specifies the kinsoku characters after which Microsoft Word will not break a line. + * Specifies the character between entries and their page numbers in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - noLineBreakAfter: string; + tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** - * Specifies the kinsoku characters before which Microsoft Word will not break a line. + * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - noLineBreakBefore: string; + tableId: string; /** - * Returns the path to the document template. + * Specifies the starting heading level for the table of figures. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly path: string; + upperHeadingLevel: number; /** - * Specifies `true` if the template has not changed since it was last saved, `false` if Microsoft Word displays a prompt to save changes when the document is closed. + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.TableOfFiguresUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.TableOfFigures): void; + /** + * Deletes this table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - saved: boolean; + delete(): void; /** - * Returns the template type. + * Updates the entire table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - */ - readonly type: Word.TemplateType | "Normal" | "Global" | "Attached"; - /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. - */ - set(properties: Interfaces.TemplateUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Template): void; /** - * Saves the template. + * Updates only the page numbers for items in this table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - save(): void; + updatePageNumbers(): 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?: Word.Interfaces.TemplateLoadOptions): Word.Template; + load(options?: Word.Interfaces.TableOfFiguresLoadOptions): Word.TableOfFigures; /** * 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[]): Word.Template; + load(propertyNames?: string | string[]): Word.TableOfFigures; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -112817,787 +114399,893 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.Template; + }): Word.TableOfFigures; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - track(): Word.Template; + track(): Word.TableOfFigures; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - untrack(): Word.Template; + untrack(): Word.TableOfFigures; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Template` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TemplateData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.TableOfFigures` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfFiguresData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.TemplateData; + toJSON(): Word.Interfaces.TableOfFiguresData; } /** - * Contains a collection of {@link Word.Template} objects that represent all the templates that are currently available. - This collection includes open templates, templates attached to open documents, and global templates loaded in the **Templates and Add-ins** dialog box. - To learn how to access this dialog in the Word UI, see {@link https://support.microsoft.com/office/2479fe53-f849-4394-88bb-2a6e2a39479d | Load or unload a template or add-in program}. + * Represents a collection of {@link Word.TableOfFigures} objects in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - class TemplateCollection extends OfficeExtension.ClientObject { + class TableOfFiguresCollection 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: Word.Template[]; - /** - * Returns the number of items in the collection. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - getCount(): OfficeExtension.ClientResult; + readonly items: Word.TableOfFigures[]; /** - * Gets a `Template` object by its index in the collection. + * Adds a table of figures to the document at the specified range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param index The index of the template to retrieve. + * @param range The range where the table of figures will be added. The table of figures replaces the range if the range isn't collapsed. + * @param options Optional. The options for configuring the table of figures. */ - getItemAt(index: number): Word.Template; + add(range: Word.Range, options?: Word.TableOfFiguresAddOptions): Word.TableOfFigures; /** - * Imports the building blocks for all templates into Microsoft Word. + * Inserts a {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) field} after the specified range for marking entries in a table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param range The range where the TC field will be inserted. + * @param options Optional. The options for marking the entry. */ - importBuildingBlocks(): void; + markTocEntry(range: Word.Range, options?: Word.TableOfContentsMarkEntryOptions): Word.Field; /** * 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?: Word.Interfaces.TemplateCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TemplateCollection; + load(options?: Word.Interfaces.TableOfFiguresCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableOfFiguresCollection; /** * 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[]): Word.TemplateCollection; + load(propertyNames?: string | string[]): Word.TableOfFiguresCollection; /** * 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): Word.TemplateCollection; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableOfFiguresCollection; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - track(): Word.TemplateCollection; + track(): Word.TableOfFiguresCollection; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - untrack(): Word.TemplateCollection; + untrack(): Word.TableOfFiguresCollection; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TemplateCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TemplateCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * Whereas the original `Word.TableOfFiguresCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableOfFiguresCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.TemplateCollectionData; + toJSON(): Word.Interfaces.TableOfFiguresCollectionData; } /** - * Represents a tracked change in a Word document. + * Specifies the options for adding to a {@link Word.TableOfFiguresCollection} object. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - class TrackedChange extends OfficeExtension.ClientObject { + interface TableOfFiguresAddOptions { + addedStyles?: string; + captionLabel?: string; + hidePageNumbersOnWeb?: boolean; + includeLabel?: boolean; + includePageNumbers?: boolean; + lowerHeadingLevel?: number; + rightAlignPageNumbers?: boolean; + tableId?: string; + upperHeadingLevel?: number; + useBuiltInHeadingStyles?: boolean; + useFields?: boolean; + useHyperlinksOnWeb?: boolean; + } + /** + * Represents a row in a Word document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + 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; /** - * Gets the author of the tracked change. + * Gets cells. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.3] */ - readonly author: string; + readonly cells: Word.TableCellCollection; /** - * Gets the date of the tracked change. + * Gets the collection of endnotes in the table row. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.5] */ - readonly date: Date; + readonly endnotes: Word.NoteItemCollection; /** - * Gets the text of the tracked change. + * Gets the collection of field objects in the table row. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.4] */ - readonly text: string; + readonly fields: Word.FieldCollection; /** - * Gets the type of the tracked change. + * Gets the font. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.3] */ - readonly type: Word.TrackedChangeType | "None" | "Added" | "Deleted" | "Formatted"; + readonly font: Word.Font; /** - * Accepts the tracked change. + * Gets the collection of footnotes in the table row. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.5] */ - accept(): void; + readonly footnotes: Word.NoteItemCollection; /** - * Gets the next tracked change. Throws an `ItemNotFound` error if this tracked change is the last one. + * Gets parent table. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.3] */ - getNext(): Word.TrackedChange; + readonly parentTable: Word.Table; /** - * Gets the next tracked change. If this tracked change is the last one, then this method will return 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}. + * Returns the `Range` object that represents the table row. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getNextOrNullObject(): Word.TrackedChange; + readonly range: Word.Range; /** - * Gets the range of the tracked change. + * Returns the `ShadingUniversal` object that represents the shading of the table row. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range; + readonly shading: Word.ShadingUniversal; /** - * Rejects the tracked change. + * Gets the number of cells in the row. * * @remarks - * [Api set: WordApi 1.6] - */ - reject(): 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: WordApi 1.3] */ - load(options?: Word.Interfaces.TrackedChangeLoadOptions): Word.TrackedChange; + readonly cellCount: number; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi 1.3] */ - load(propertyNames?: string | string[]): Word.TrackedChange; + horizontalAlignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Checks whether the row is a header row. To set the number of header rows, use `headerRowCount` on the Table object. * - * @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; - }): Word.TrackedChange; - /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. - */ - track(): Word.TrackedChange; - /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. - */ - untrack(): Word.TrackedChange; - /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TrackedChange` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TrackedChangeData`) that contains shallow copies of any loaded child properties from the original object. + * @remarks + * [Api set: WordApi 1.3] */ - toJSON(): Word.Interfaces.TrackedChangeData; - } - /** - * Contains a collection of {@link Word.TrackedChange} objects. - * - * @remarks - * [Api set: WordApi 1.6] - */ - class TrackedChangeCollection 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: Word.TrackedChange[]; + readonly isHeader: boolean; /** - * Accepts all the tracked changes in the collection. + * Specifies the preferred height of the row in points. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.3] */ - acceptAll(): void; + preferredHeight: number; /** - * Gets the first TrackedChange in this collection. Throws an `ItemNotFound` error if this collection is empty. + * Gets the index of the row in its parent table. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.3] */ - getFirst(): Word.TrackedChange; + readonly rowIndex: number; /** - * Gets the first TrackedChange in this collection. If this collection is empty, then this method will return 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 shading color. Color is specified in "#RRGGBB" format or by using the color name. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.3] */ - getFirstOrNullObject(): Word.TrackedChange; + shadingColor: string; /** - * Rejects all the tracked changes in the collection. + * Specifies the text values in the row, as a 2D JavaScript array. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.3] */ - rejectAll(): void; + values: string[][]; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi 1.3] */ - load(options?: Word.Interfaces.TrackedChangeCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TrackedChangeCollection; + verticalAlignment: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; /** - * 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. + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - load(propertyNames?: string | string[]): Word.TrackedChangeCollection; + set(properties: Interfaces.TableRowUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.TableRow): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Clears the contents of the row. * - * @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): Word.TrackedChangeCollection; - /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. - */ - track(): Word.TrackedChangeCollection; - /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. - */ - untrack(): Word.TrackedChangeCollection; - /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TrackedChangeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TrackedChangeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * @remarks + * [Api set: WordApi 1.3] */ - toJSON(): Word.Interfaces.TrackedChangeCollectionData; - } - /** - * Contains the view attributes (such as show all, field shading, and table gridlines) for a window or pane. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class View 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; + clear(): void; /** - * Gets the instance of a `RevisionsFilter` object. + * Converts the table row to text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param options Optional. An object that specifies the options for converting the table row to text. */ - readonly revisionsFilter: Word.RevisionsFilter; + convertToText(options?: Word.TableConvertToTextOptions): Word.Range; /** - * Specifies whether all nonprinting characters are displayed. + * Deletes the entire row. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - areAllNonprintingCharactersDisplayed: boolean; + delete(): void; /** - * Gets whether background colors and images are shown when the document is displayed in print layout view. + * Gets the border style of the cells in the row. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param borderLocation Required. The border location. */ - areBackgroundsDisplayed: boolean; + getBorder(borderLocation: Word.BorderLocation): Word.TableBorder; /** - * Gets whether square brackets are displayed at the beginning and end of each bookmark. + * Gets the border style of the cells in the row. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param borderLocation Required. The border location. */ - readonly areBookmarksIndicated: boolean; + getBorder(borderLocation: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder; /** - * Specifies whether Microsoft Word displays the comments in the document. + * Gets cell padding in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. */ - areCommentsDisplayed: boolean; + getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult; /** - * Specifies whether Microsoft Word displays connecting lines from the text to the revision and comment balloons. + * Gets cell padding in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. */ - areConnectingLinesToRevisionsBalloonDisplayed: boolean; + getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult; /** - * Gets whether crop marks are shown in the corners of pages to indicate where margins are located. + * Gets the next row. Throws an `ItemNotFound` error if this row is the last one. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - readonly areCropMarksDisplayed: boolean; + getNext(): Word.TableRow; /** - * Gets whether objects created with the drawing tools are displayed in print layout view. + * Gets the next row. If this row is the last one, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - readonly areDrawingsDisplayed: boolean; + getNextOrNullObject(): Word.TableRow; /** - * Specifies whether shading is applied to the ranges in the document that users have permission to modify. + * Inserts a content control on the row. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - areEditableRangesShaded: boolean; + insertContentControl(): Word.ContentControl; /** - * Specifies whether field codes are displayed. + * Inserts rows using this row as a template. If values are specified, inserts the values into the new rows. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param insertLocation Required. Where the new rows should be inserted, relative to the current row. It must be 'Before' or 'After'. + * @param rowCount Required. Number of rows to add + * @param values Optional. Strings to insert in the new rows, specified as a 2D array. The number of cells in each row must not exceed the number of cells in the existing row. */ - areFieldCodesDisplayed: boolean; + insertRows(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", rowCount: number, values?: string[][]): Word.TableRowCollection; /** - * Specifies whether Microsoft Word displays formatting changes made to the document with Track Changes enabled. + * Merges the row into one cell. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - areFormatChangesDisplayed: boolean; + merge(): Word.TableCell; /** - * Specifies whether handwritten ink annotations are shown or hidden. + * Performs a search with the specified SearchOptions on the scope of the row. The search results are a collection of range objects. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param searchText Required. The search text. + * @param searchOptions Optional. Options for the search. */ - areInkAnnotationsDisplayed: boolean; + search(searchText: string, searchOptions?: Word.SearchOptions | { + ignorePunct?: boolean; + ignoreSpace?: boolean; + matchCase?: boolean; + matchPrefix?: boolean; + matchSuffix?: boolean; + matchWholeWord?: boolean; + matchWildcards?: boolean; + }): Word.RangeCollection; /** - * Specifies whether Microsoft Word displays insertions and deletions made to the document with Track Changes enabled. + * Selects the row and navigates the Word UI to it. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. */ - areInsertionsAndDeletionsDisplayed: boolean; + select(selectionMode?: Word.SelectionMode): void; /** - * Gets whether lines wrap at the right edge of the document window rather than at the right margin or the right column boundary. + * Selects the row and navigates the Word UI to it. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param selectionMode Optional. The selection mode must be 'Select', 'Start', or 'End'. 'Select' is the default. */ - readonly areLinesWrappedToWindow: boolean; + select(selectionMode?: "Select" | "Start" | "End"): void; /** - * Gets whether object anchors are displayed next to items that can be positioned in print layout view. + * Sets cell padding in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * @param cellPadding Required. The cell padding. */ - readonly areObjectAnchorsDisplayed: boolean; + setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void; /** - * Gets whether Microsoft Word displays optional line breaks. + * Sets cell padding in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * @param cellPadding Required. The cell padding. */ - readonly areOptionalBreaksDisplayed: boolean; + setCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void; /** - * Gets whether optional hyphens are displayed. + * Sets the height of the row. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param rowHeight The height of the row, in points. + * @param heightRule The rule for determining the height of the table row. */ - readonly areOptionalHyphensDisplayed: boolean; + setHeight(rowHeight: number, heightRule: Word.RowHeightRule): void; /** - * Gets whether other authors' presence should be visible in the document. + * Sets the height of the row. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param rowHeight The height of the row, in points. + * @param heightRule The rule for determining the height of the table row. */ - areOtherAuthorsVisible: boolean; + setHeight(rowHeight: number, heightRule: "Auto" | "AtLeast" | "Exactly"): void; /** - * Gets whether the top and bottom margins and the gray area between pages in the document are displayed. + * Sets the left indent for the table row. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param leftIndent The distance (in points) between the current left edge of the table row and the desired left edge. + * @param rulerStyle The ruler style to apply. */ - readonly arePageBoundariesDisplayed: boolean; + setLeftIndent(leftIndent: number, rulerStyle: Word.RulerStyle): void; /** - * Gets whether paragraph marks are displayed. + * Sets the left indent for the table row. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param leftIndent The distance (in points) between the current left edge of the table row and the desired left edge. + * @param rulerStyle The ruler style to apply. */ - readonly areParagraphsMarksDisplayed: boolean; + setLeftIndent(leftIndent: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void; /** - * Gets whether blank boxes are displayed as placeholders for pictures. + * 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?: Word.Interfaces.TableRowLoadOptions): Word.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[]): Word.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; + }): Word.TableRow; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.TableRow; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.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 `Word.TableRow` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableRowData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.TableRowData; + } + /** + * Contains the collection of the document's TableRow objects. + * + * @remarks + * [Api set: WordApi 1.3] + */ + 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: Word.TableRow[]; + /** + * Converts rows in a table to text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param options Optional. An object that specifies the options for converting the table rows to text. + * @returns A `Range` object that represents the converted text. */ - readonly arePicturePlaceholdersDisplayed: boolean; + convertToText(options?: Word.TableConvertToTextOptions): Word.Range; /** - * Specifies whether Microsoft Word displays revisions and comments made to the document with Track Changes enabled. + * Deletes the table rows. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areRevisionsAndCommentsDisplayed: boolean; + delete(): void; /** - * Gets whether space characters are displayed. + * Adjusts the height of the rows so that they're equal. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly areSpacesIndicated: boolean; + distributeHeight(): void; /** - * Specifies whether table gridlines are displayed. + * Gets the first row in this collection. Throws an `ItemNotFound` error if this collection is empty. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - areTableGridlinesDisplayed: boolean; + getFirst(): Word.TableRow; /** - * Gets whether tab characters are displayed. + * Gets the first row in this collection. If this collection is empty, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - readonly areTabsDisplayed: boolean; + getFirstOrNullObject(): Word.TableRow; /** - * Gets whether dotted lines are displayed around page margins, text columns, objects, and frames in print layout view. + * Selects the table rows. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly areTextBoundariesDisplayed: boolean; + select(): void; /** - * Specifies the column width in Reading mode. + * Sets the height of the cells in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param rowHeight The height of the row, in points. + * @param heightRule The rule for determining the height of the specified rows. */ - columnWidth: Word.ColumnWidth | "Narrow" | "Default" | "Wide"; + setHeight(rowHeight: number, heightRule: Word.RowHeightRule): void; /** - * Gets on-screen shading for fields. + * Sets the height of the cells in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param rowHeight The height of the row, in points. + * @param heightRule The rule for determining the height of the specified rows. */ - readonly fieldShading: Word.FieldShading | "Never" | "Always" | "WhenSelected"; + setHeight(rowHeight: number, heightRule: "Auto" | "AtLeast" | "Exactly"): void; /** - * Specifies whether all the text in a window is displayed in the same sans-serif font with minimal formatting to speed up display. + * Sets the left indent for the table row. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param leftIndent The distance (in points) between the current left edge of the specified rows and the desired left edge. + * @param rulerStyle The ruler style to apply. */ - isDraft: boolean; + setLeftIndent(leftIndent: number, rulerStyle: Word.RulerStyle): void; /** - * Specifies whether only the first line of body text is shown in outline view. + * Sets the left indent for the table row. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param leftIndent The distance (in points) between the current left edge of the specified rows and the desired left edge. + * @param rulerStyle The ruler style to apply. */ - isFirstLineOnlyDisplayed: boolean; + setLeftIndent(leftIndent: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void; /** - * Specifies whether character formatting is visible in outline view. + * 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?: Word.Interfaces.TableRowCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.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[]): Word.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): Word.TableRowCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.TableRowCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.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 `Word.TableRowCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableRowCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.TableRowCollectionData; + } + /** + * Represents a table cell in a Word document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + 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 body object of the cell. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isFormatDisplayed: boolean; + readonly body: Word.Body; /** - * Specifies whether the window is in full-screen view. + * Returns the `TableColumn` object that represents the table column that contains this cell. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isFullScreen: boolean; + readonly column: Word.TableColumn; /** - * Gets whether text formatted as hidden text is displayed. + * Gets the parent row of the cell. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - readonly isHiddenTextDisplayed: boolean; + readonly parentRow: Word.TableRow; /** - * Gets whether highlight formatting is displayed and printed with the document. + * Gets the parent table of the cell. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - readonly isHighlightingDisplayed: boolean; + readonly parentTable: Word.Table; /** - * Specifies whether the document is in conflict mode view. + * Returns the `ShadingUniversal` object that represents the shading of the table cell. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isInConflictMode: boolean; + readonly shading: Word.ShadingUniversal; /** - * Specifies whether Microsoft Word is in Panning mode. + * Gets the index of the cell in its row. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isInPanning: boolean; + readonly cellIndex: number; /** - * Specifies whether the document is being viewed in reading layout view. + * Specifies the width of the cell's column in points. This is applicable to uniform tables. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isInReadingLayout: boolean; + columnWidth: number; /** - * Specifies whether mail merge data is displayed instead of mail merge fields. + * Specifies the horizontal alignment of the cell. The value can be 'Left', 'Centered', 'Right', or 'Justified'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isMailMergeDataView: boolean; + horizontalAlignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies whether the text in the document is visible when the header and footer areas are displayed. + * Gets the index of the cell's row in the table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isMainTextLayerVisible: boolean; + readonly rowIndex: number; /** - * Specifies whether the pointer is displayed as a magnifying glass in print preview. + * Specifies the shading color of the cell. Color is specified in "#RRGGBB" format or by using the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isPointerShownAsMagnifier: boolean; + shadingColor: string; /** - * Specifies whether pages displayed in reading layout view are displayed using the same layout as printed pages. + * Specifies the text of the cell. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isReadingLayoutActualView: boolean; + value: string; /** - * Specifies whether XML tags are visible in the document. + * Specifies the vertical alignment of the cell. The value can be 'Top', 'Center', or 'Bottom'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isXmlMarkupVisible: boolean; + verticalAlignment: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; /** - * Specifies the display mode for tracked changes. + * Gets the width of the cell in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - markupMode: Word.RevisionsMode | "Balloon" | "Inline" | "Mixed"; + readonly width: number; /** - * Specifies the page color in Reading mode. + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.TableCellUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.TableCell): void; + /** + * Inserts a {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | = (Formula) field} that calculates and displays the sum of the values in table cells above or to the left of the cell specified in the expression. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageColor: Word.PageColor | "None" | "Sepia" | "Inverse"; + autoSum(): void; /** - * Specifies the page movement type. + * Deletes the table cell and optionally controls how the remaining cells are shifted. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param shiftCells Optional. Specifies how the remaining cells are shifted after the deletion. The default is `shiftLeft`. */ - pageMovementType: Word.PageMovementType | "Vertical" | "SideToSide"; + delete(shiftCells: any): void; /** - * Specifies whether margins are visible or hidden when the document is viewed in Full Screen Reading view. + * Deletes the column containing this cell. This is applicable to uniform tables. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - readingLayoutTruncateMargins: Word.ReadingLayoutMargin | "Automatic" | "Suppress" | "Full"; + deleteColumn(): void; /** - * Gets whether Word displays revision balloons in the left or right margin in the document. + * Deletes the row containing this cell. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - readonly revisionsBalloonSide: Word.RevisionsBalloonMargin | "Left" | "Right"; + deleteRow(): void; /** - * Specifies the width of the revision balloons. + * Inserts a {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | = (Formula) field} that contains the specified formula into a table cell. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param options Optional. An object that specifies the options for the formula. */ - revisionsBalloonWidth: number; + formula(options?: Word.TableCellFormulaOptions): void; /** - * Specifies how Microsoft Word measures the width of revision balloons. + * Gets the border style for the specified border. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param borderLocation Required. The border location. */ - revisionsBalloonWidthType: Word.RevisionsBalloonWidthType | "Percent" | "Points"; + getBorder(borderLocation: Word.BorderLocation): Word.TableBorder; /** - * Specifies the document element displayed in print layout view. + * Gets the border style for the specified border. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param borderLocation Required. The border location. */ - seekView: Word.SeekView | "MainDocument" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "CurrentPageHeader" | "CurrentPageFooter"; + getBorder(borderLocation: "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"): Word.TableBorder; /** - * Specifies the active window pane. + * Gets cell padding in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. */ - splitSpecial: Word.SpecialPane | "None" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "FootnoteContinuationNotice" | "FootnoteContinuationSeparator" | "FootnoteSeparator" | "EndnoteContinuationNotice" | "EndnoteContinuationSeparator" | "EndnoteSeparator" | "Comments" | "CurrentPageHeader" | "CurrentPageFooter" | "Revisions" | "RevisionsHoriz" | "RevisionsVert"; + getCellPadding(cellPaddingLocation: Word.CellPaddingLocation): OfficeExtension.ClientResult; /** - * Specifies the view type. + * Gets cell padding in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. */ - type: Word.ViewType | "Normal" | "Outline" | "Print" | "PrintPreview" | "Master" | "Web" | "Reading" | "Conflict"; + getCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right"): OfficeExtension.ClientResult; /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Gets the next cell. Throws an `ItemNotFound` error if this cell is the last one. + * + * @remarks + * [Api set: WordApi 1.3] */ - set(properties: Interfaces.ViewUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.View): void; + getNext(): Word.TableCell; /** - * Collapses all the headings in the document. + * Gets the next cell. If this cell is the last one, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - collapseAllHeadings(): void; + getNextOrNullObject(): Word.TableCell; /** - * Collapses the text under the selection or the specified range by one heading level. + * Adds columns to the left or right of the cell, using the cell's column as a template. This is applicable to uniform tables. The string values, if specified, are set in the newly inserted rows. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] * - * @param range A `Range` object that specifies the range to collapse. + * @param insertLocation Required. It must be 'Before' or 'After'. + * @param columnCount Required. Number of columns to add. + * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array. */ - collapseOutline(range: Word.Range): void; + insertColumns(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", columnCount: number, values?: string[][]): void; /** - * Expands all the headings in the document. + * Inserts rows above or below the cell, using the cell's row as a template. The string values, if specified, are set in the newly inserted rows. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param insertLocation Required. It must be 'Before' or 'After'. + * @param rowCount Required. Number of rows to add. + * @param values Optional 2D array. Cells are filled if the corresponding strings are specified in the array. */ - expandAllHeadings(): void; + insertRows(insertLocation: Word.InsertLocation.before | Word.InsertLocation.after | "Before" | "After", rowCount: number, values?: string[][]): Word.TableRowCollection; /** - * Expands the text under the selection by one heading level. + * Merges this table cell with the specified table cell. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param range A `Range` object that specifies the range to expand. + * @param mergeTo The cell to be merged with. */ - expandOutline(range: Word.Range): void; + merge(mergeTo: Word.TableCell): void; /** - * Moves to the next header or footer, depending on whether a header or footer is displayed in the view. + * Selects the table cell. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nextHeaderFooter(): void; + select(): void; /** - * Moves to the previous header or footer, depending on whether a header or footer is displayed in the view. + * Sets cell padding in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * @param cellPadding Required. The cell padding. */ - previousHeaderFooter(): void; + setCellPadding(cellPaddingLocation: Word.CellPaddingLocation, cellPadding: number): void; /** - * Switches between showing all text (headings and body text) and showing only headings. + * Sets cell padding in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] + * + * @param cellPaddingLocation Required. The cell padding location must be 'Top', 'Left', 'Bottom', or 'Right'. + * @param cellPadding Required. The cell padding. */ - showAllHeadings(): void; + setCellPadding(cellPaddingLocation: "Top" | "Left" | "Bottom" | "Right", cellPadding: number): void; /** - * Shows all headings up to the specified heading level and hides subordinate headings and body text. + * Splits the cell into the specified number of rows and columns. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] * - * @param level The heading level to show. + * @param rowCount Required. The number of rows to split into. Must be a divisor of the number of underlying rows. + * @param columnCount Required. The number of columns to split into. */ - showHeading(level: number): void; + 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?: Word.Interfaces.ViewLoadOptions): Word.View; + load(options?: Word.Interfaces.TableCellLoadOptions): Word.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[]): Word.View; + load(propertyNames?: string | string[]): Word.TableCell; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -113606,338 +115294,431 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.View; + }): Word.TableCell; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - track(): Word.View; + track(): Word.TableCell; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - untrack(): Word.View; + untrack(): Word.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 `Word.View` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ViewData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.TableCell` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableCellData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.ViewData; + toJSON(): Word.Interfaces.TableCellData; } /** - * Represents a shape in the header, footer, or document body. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * Contains the collection of the document's TableCell objects. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - class Shape extends OfficeExtension.ClientObject { + 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: Word.TableCell[]; /** - * Represents the body object of the shape. Only applies to text boxes and geometric shapes. + * Changes the width of a table column to accommodate the width of the text without changing the way text wraps in the cells. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly body: Word.Body; + autoFit(): void; /** - * Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "Canvas". 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}. + * Deletes the table cells and optionally controls how the remaining cells are shifted. * * @remarks - * [Api set: WordApiDesktop 1.2] - */ - readonly canvas: Word.Canvas; + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param shiftCells Optional. Specifies how the remaining cells are shifted after the deletion. The default is `shiftLeft`. + */ + delete(shiftCells?: Word.DeleteCells): void; /** - * Returns the fill formatting of the shape. + * Deletes the table cells and optionally controls how the remaining cells are shifted. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param shiftCells Optional. Specifies how the remaining cells are shifted after the deletion. The default is `shiftLeft`. */ - readonly fill: Word.ShapeFill; + delete(shiftCells?: "ShiftLeft" | "ShiftUp" | "EntireRow" | "EntireColumn"): void; /** - * Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas. + * Adjusts the height of the specified cells so that they are equal. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly parentCanvas: Word.Shape; + distributeHeight(): void; /** - * Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group. + * Adjusts the width of the specified cells so that they are equal. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly parentGroup: Word.Shape; + distributeWidth(): void; /** - * Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "GroupShape". 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}. + * Gets the first table cell in this collection. Throws an `ItemNotFound` error if this collection is empty. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - readonly shapeGroup: Word.ShapeGroup; + getFirst(): Word.TableCell; /** - * Gets the text frame object of the shape. + * Gets the first table cell in this collection. If this collection is empty, then this method will return 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: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - readonly textFrame: Word.TextFrame; + getFirstOrNullObject(): Word.TableCell; /** - * Returns the text wrap formatting of the shape. + * Merges the specified cells into a single cell. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly textWrap: Word.ShapeTextWrap; + merge(): void; /** - * Specifies whether a given shape can overlap other shapes. + * Sets the height of the cells in a table. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param rowHeight The height of the row to set, in points. + * @param heightRule The rule for determining the height of the specified rows. */ - allowOverlap: boolean; + setHeight(rowHeight: number, heightRule: Word.RowHeightRule): void; /** - * Specifies a string that represents the alternative text associated with the shape. + * Sets the height of the cells in a table. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param rowHeight The height of the row to set, in points. + * @param heightRule The rule for determining the height of the specified rows. */ - altTextDescription: string; + setHeight(rowHeight: number, heightRule: "Auto" | "AtLeast" | "Exactly"): void; /** - * The geometric shape type of the shape. It will be null if isn't a geometric shape. + * Sets the width of the cells in a table. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param columnWidth The width of the row to set, in points. + * @param rulerStyle The ruler style to apply. */ - geometricShapeType: Word.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"; + setWidth(columnWidth: number, rulerStyle: Word.RulerStyle): void; /** - * The height, in points, of the shape. + * Sets the width of the cells in a table. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param columnWidth The width of the row to set, in points. + * @param rulerStyle The ruler style to apply. */ - height: number; + setWidth(columnWidth: number, rulerStyle: "None" | "Proportional" | "FirstColumn" | "SameWidth"): void; /** - * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * Splits this range of table cells. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options TableCellCollectionSplitOptions. */ - heightRelative: number; + split(options?: Word.TableCellCollectionSplitOptions): void; /** - * Gets an integer that represents the shape identifier. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApiDesktop 1.2] + * @param options Provides options for which properties of the object to load. */ - readonly id: number; + load(options?: Word.Interfaces.TableCellCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TableCellCollection; /** - * Check whether this shape is a child of a group shape or a canvas shape. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApiDesktop 1.2] + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - readonly isChild: boolean; + load(propertyNames?: string | string[]): Word.TableCellCollection; /** - * The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApiDesktop 1.2] + * @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. */ - left: number; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TableCellCollection; /** - * The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set. + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.TableCellCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.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 `Word.TableCellCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableCellCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.TableCellCollectionData; + } + /** + * Specifies the border style. + * + * @remarks + * [Api set: WordApi 1.3] + */ + class TableBorder 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 table border color. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - leftRelative: number; + color: string; /** - * Specifies if the aspect ratio of this shape is locked. + * Specifies the type of the table border. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - lockAspectRatio: boolean; + type: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; /** - * The name of the shape. + * Specifies the width, in points, of the table border. Not applicable to table border types that have fixed widths. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - name: string; + width: number; /** - * The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.TableBorderUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.TableBorder): void; + /** + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApiDesktop 1.2] + * @param options Provides options for which properties of the object to load. */ - relativeHorizontalPosition: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; + load(options?: Word.Interfaces.TableBorderLoadOptions): Word.TableBorder; /** - * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApiDesktop 1.2] + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - relativeHorizontalSize: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + load(propertyNames?: string | string[]): Word.TableBorder; /** - * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApiDesktop 1.2] + * @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. */ - relativeVerticalPosition: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.TableBorder; /** - * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.TableBorder; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.TableBorder; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TableBorder` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TableBorderData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.TableBorderData; + } + /** + * Represents a document template. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class Template 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 `BuildingBlockEntryCollection` object that represents the collection of building block entries in the template. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - relativeVerticalSize: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + readonly buildingBlockEntries: Word.BuildingBlockEntryCollection; /** - * Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape. + * Returns a `BuildingBlockTypeItemCollection` object that represents the collection of building block types that are contained in the template. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rotation: number; + readonly buildingBlockTypes: Word.BuildingBlockTypeItemCollection; /** - * The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * Returns a `ListTemplateCollection` object that represents all the list templates in the template. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - top: number; + readonly listTemplates: Word.ListTemplateCollection; /** - * The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set. + * Specifies the East Asian language to use when breaking lines of text in the document or template. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topRelative: number; + farEastLineBreakLanguage: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; /** - * Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * Specifies the line break control level for the document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly type: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture" | "Canvas"; + farEastLineBreakLevel: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"; /** - * Specifies if the shape is visible. Not applicable to inline shapes. + * Returns the name of the template, including the drive or Web path. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - visible: boolean; + readonly fullName: string; /** - * The width, in points, of the shape. + * Specifies whether the spelling and grammar checker ignores documents based on this template. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width: number; + hasNoProofing: boolean; /** - * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * Specifies the character spacing adjustment for the template. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - widthRelative: number; + justificationMode: Word.JustificationMode | "Expand" | "Compress" | "CompressKana"; /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Specifies if Microsoft Word kerns half-width Latin characters and punctuation marks in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.ShapeUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Shape): void; + kerningByAlgorithm: boolean; /** - * Deletes the shape and its content. + * Specifies a `LanguageId` value that represents the language in the template. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - delete(): void; + languageId: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Moves the shape horizontally by the number of points. + * Specifies an East Asian language for the language in the template. * * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param distance Required. Specifies how far the shape is to be moved horizontally, in points. Use a positive value to move the shape right. Use a negative value to move the shape left. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - moveHorizontally(distance: number): void; + languageIdFarEast: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Moves the shape vertically by the number of points. + * Returns only the name of the document template (excluding any path or other location information). * * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param distance Required. Specifies how far the shape is to be moved vertically, in points. Use a positive value to move the shape up. Use a negative value to move the shape down. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - moveVertically(distance: number): void; + readonly name: string; /** - * Scales the height of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current height. + * Specifies the kinsoku characters after which Microsoft Word will not break a line. * * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param scaleFactor Specifies the ratio between the height of the shape after you resize it and the current or original height. - * @param scaleType Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images. - * @param scaleFrom Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents that the shape's upper left corner retains its position. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - scaleHeight(scaleFactor: number, scaleType: Word.ShapeScaleType, scaleFrom?: Word.ShapeScaleFrom): void; + noLineBreakAfter: string; /** - * Scales the height of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current height. + * Specifies the kinsoku characters before which Microsoft Word will not break a line. * * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param scaleFactor Specifies the ratio between the height of the shape after you resize it and the current or original height. - * @param scaleType Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images. - * @param scaleFrom Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents that the shape's upper left corner retains its position. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - scaleHeight(scaleFactor: number, scaleType: "CurrentSize" | "OriginalSize", scaleFrom?: "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"): void; + noLineBreakBefore: string; /** - * Scales the width of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current height. + * Returns the path to the document template. * * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param scaleFactor Specifies the ratio between the width of the shape after you resize it and the current or original width. - * @param scaleType Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images. - * @param scaleFrom Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents that the shape's upper left corner retains its position. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - scaleWidth(scaleFactor: number, scaleType: Word.ShapeScaleType, scaleFrom?: Word.ShapeScaleFrom): void; + readonly path: string; /** - * Scales the width of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current height. + * Specifies `true` if the template has not changed since it was last saved, `false` if Microsoft Word displays a prompt to save changes when the document is closed. * * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param scaleFactor Specifies the ratio between the width of the shape after you resize it and the current or original width. - * @param scaleType Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images. - * @param scaleFrom Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents that the shape's upper left corner retains its position. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - scaleWidth(scaleFactor: number, scaleType: "CurrentSize" | "OriginalSize", scaleFrom?: "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"): void; + saved: boolean; /** - * Selects the shape. + * Returns the template type. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly type: Word.TemplateType | "Normal" | "Global" | "Attached"; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.TemplateUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Template): void; + /** + * Saves the template. * - * @param selectMultipleShapes Optional. Whether to select multiple floating shapes. The default value is false. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - select(selectMultipleShapes?: boolean): void; + save(): 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?: Word.Interfaces.ShapeLoadOptions): Word.Shape; + load(options?: Word.Interfaces.TemplateLoadOptions): Word.Template; /** * 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[]): Word.Shape; + load(propertyNames?: string | string[]): Word.Template; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -113946,151 +115727,177 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.Shape; + }): Word.Template; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - track(): Word.Shape; + track(): Word.Template; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - untrack(): Word.Shape; + untrack(): Word.Template; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Shape` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.Template` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TemplateData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.ShapeData; + toJSON(): Word.Interfaces.TemplateData; } /** - * Represents a shape group in the document. To get the corresponding Shape object, use ShapeGroup.shape. + * Contains a collection of {@link Word.Template} objects that represent all the templates that are currently available. + This collection includes open templates, templates attached to open documents, and global templates loaded in the **Templates and Add-ins** dialog box. + To learn how to access this dialog in the Word UI, see {@link https://support.microsoft.com/office/2479fe53-f849-4394-88bb-2a6e2a39479d | Load or unload a template or add-in program}. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - class ShapeGroup extends OfficeExtension.ClientObject { + class TemplateCollection 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: Word.Template[]; /** - * Gets the Shape object associated with the group. + * Returns the number of items in the collection. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly shape: Word.Shape; + getCount(): OfficeExtension.ClientResult; /** - * Gets the collection of Shape objects. Currently, only text boxes, geometric shapes, and pictures are supported. + * Gets a `Template` object by its index in the collection. * * @remarks - * [Api set: WordApiDesktop 1.2] - */ - readonly shapes: Word.ShapeCollection; - /** - * Gets an integer that represents the shape group identifier. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - readonly id: number; - /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * @param index The index of the template to retrieve. */ - set(properties: Interfaces.ShapeGroupUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ShapeGroup): void; + getItemAt(index: number): Word.Template; /** - * Ungroups any grouped shapes in the specified shape group. + * Imports the building blocks for all templates into Microsoft Word. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ungroup(): Word.ShapeCollection; + importBuildingBlocks(): 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?: Word.Interfaces.ShapeGroupLoadOptions): Word.ShapeGroup; + load(options?: Word.Interfaces.TemplateCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TemplateCollection; /** * 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[]): Word.ShapeGroup; + load(propertyNames?: string | string[]): Word.TemplateCollection; /** * 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; - }): Word.ShapeGroup; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TemplateCollection; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - track(): Word.ShapeGroup; + track(): Word.TemplateCollection; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - untrack(): Word.ShapeGroup; + untrack(): Word.TemplateCollection; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ShapeGroup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeGroupData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.TemplateCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TemplateCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.ShapeGroupData; + toJSON(): Word.Interfaces.TemplateCollectionData; } /** - * Represents a canvas in the document. To get the corresponding Shape object, use Canvas.shape. + * Represents a tracked change in a Word document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] */ - class Canvas extends OfficeExtension.ClientObject { + class TrackedChange 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 Shape object associated with the canvas. + * Gets the author of the tracked change. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] */ - readonly shape: Word.Shape; + readonly author: string; /** - * Gets the collection of Shape objects. Currently, only text boxes, pictures, and geometric shapes are supported. + * Gets the date of the tracked change. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] */ - readonly shapes: Word.ShapeCollection; + readonly date: Date; /** - * Gets an integer that represents the canvas identifier. + * Gets the text of the tracked change. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] */ - readonly id: number; + readonly text: string; /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Gets the type of the tracked change. + * + * @remarks + * [Api set: WordApi 1.6] */ - set(properties: Interfaces.CanvasUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Canvas): void; + readonly type: Word.TrackedChangeType | "None" | "Added" | "Deleted" | "Formatted"; + /** + * Accepts the tracked change. + * + * @remarks + * [Api set: WordApi 1.6] + */ + accept(): void; + /** + * Gets the next tracked change. Throws an `ItemNotFound` error if this tracked change is the last one. + * + * @remarks + * [Api set: WordApi 1.6] + */ + getNext(): Word.TrackedChange; + /** + * Gets the next tracked change. If this tracked change is the last one, then this method will return 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: WordApi 1.6] + */ + getNextOrNullObject(): Word.TrackedChange; + /** + * Gets the range of the tracked change. + * + * @remarks + * [Api set: WordApi 1.6] + */ + getRange(rangeLocation?: Word.RangeLocation.whole | Word.RangeLocation.start | Word.RangeLocation.end | "Whole" | "Start" | "End"): Word.Range; + /** + * Rejects the tracked change. + * + * @remarks + * [Api set: WordApi 1.6] + */ + reject(): 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?: Word.Interfaces.CanvasLoadOptions): Word.Canvas; + load(options?: Word.Interfaces.TrackedChangeLoadOptions): Word.TrackedChange; /** * 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[]): Word.Canvas; + load(propertyNames?: string | string[]): Word.TrackedChange; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -114099,628 +115906,608 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.Canvas; + }): Word.TrackedChange; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - track(): Word.Canvas; + track(): Word.TrackedChange; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - untrack(): Word.Canvas; + untrack(): Word.TrackedChange; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Canvas` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CanvasData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.TrackedChange` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TrackedChangeData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.CanvasData; + toJSON(): Word.Interfaces.TrackedChangeData; } /** - * Contains a collection of {@link Word.Shape} objects. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * Contains a collection of {@link Word.TrackedChange} objects. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] */ - class ShapeCollection extends OfficeExtension.ClientObject { + class TrackedChangeCollection 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: Word.Shape[]; - /** - * Gets the shapes that have the specified geometric types. Only applied to geometric shapes. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param types Required. An array of geometric shape subtypes. - */ - getByGeometricTypes(types: Word.GeometricShapeType[]): Word.ShapeCollection; - /** - * Gets a shape by its identifier. Throws an `ItemNotFound` error if there isn't a shape with the identifier in this collection. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param id Required. A shape identifier. - */ - getById(id: number): Word.Shape; - /** - * Gets a shape by its identifier. If there isn't a shape with the identifier in this collection, then this method will return 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: WordApiDesktop 1.2] - * - * @param id Required. A shape identifier. - */ - getByIdOrNullObject(id: number): Word.Shape; - /** - * Gets the shapes by the identifiers. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param ids Required. An array of shape identifiers. - */ - getByIds(ids: number[]): Word.ShapeCollection; - /** - * Gets the shapes that have the specified names. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param names Required. An array of shape names. - */ - getByNames(names: string[]): Word.ShapeCollection; + readonly items: Word.TrackedChange[]; /** - * Gets the shapes that have the specified types. + * Accepts all the tracked changes in the collection. * * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param types Required. An array of shape types. + * [Api set: WordApi 1.6] */ - getByTypes(types: Word.ShapeType[]): Word.ShapeCollection; + acceptAll(): void; /** - * Gets the first shape in this collection. Throws an `ItemNotFound` error if this collection is empty. + * Gets the first TrackedChange in this collection. Throws an `ItemNotFound` error if this collection is empty. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] */ - getFirst(): Word.Shape; + getFirst(): Word.TrackedChange; /** - * Gets the first shape in this collection. If this collection is empty, then this method will return 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}. + * Gets the first TrackedChange in this collection. If this collection is empty, then this method will return 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: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] */ - getFirstOrNullObject(): Word.Shape; + getFirstOrNullObject(): Word.TrackedChange; /** - * Groups floating shapes in this collection, inline shapes will be skipped. Returns a Shape object that represents the new group of shapes. + * Rejects all the tracked changes in the collection. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.6] */ - group(): Word.Shape; + rejectAll(): 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?: Word.Interfaces.ShapeCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ShapeCollection; + load(options?: Word.Interfaces.TrackedChangeCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TrackedChangeCollection; /** * 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[]): Word.ShapeCollection; + load(propertyNames?: string | string[]): Word.TrackedChangeCollection; /** * 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): Word.ShapeCollection; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.TrackedChangeCollection; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - track(): Word.ShapeCollection; + track(): Word.TrackedChangeCollection; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - untrack(): Word.ShapeCollection; + untrack(): Word.TrackedChangeCollection; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ShapeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * Whereas the original `Word.TrackedChangeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TrackedChangeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.ShapeCollectionData; + toJSON(): Word.Interfaces.TrackedChangeCollectionData; } /** - * Represents the fill formatting of a shape object. + * Contains the view attributes (such as show all, field shading, and table gridlines) for a window or pane. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - class ShapeFill extends OfficeExtension.ClientObject { + class View 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 shape fill background color. You can provide the value in the '#RRGGBB' format or the color name. + * Gets the instance of a `RevisionsFilter` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - backgroundColor: string; + readonly revisionsFilter: Word.RevisionsFilter; /** - * Specifies the shape fill foreground color. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies whether all nonprinting characters are displayed. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - foregroundColor: string; + areAllNonprintingCharactersDisplayed: boolean; /** - * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type. + * Gets whether background colors and images are shown when the document is displayed in print layout view. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - transparency: number; + areBackgroundsDisplayed: boolean; /** - * Returns the fill type of the shape. See `Word.ShapeFillType` for details. + * Gets whether square brackets are displayed at the beginning and end of each bookmark. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly type: Word.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "Picture" | "Texture" | "Mixed"; + readonly areBookmarksIndicated: boolean; /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Specifies whether Microsoft Word displays the comments in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.ShapeFillUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ShapeFill): void; + areCommentsDisplayed: boolean; /** - * Clears the fill formatting of this shape and set it to `Word.ShapeFillType.NoFill`; + * Specifies whether Microsoft Word displays connecting lines from the text to the revision and comment balloons. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - clear(): void; + areConnectingLinesToRevisionsBalloonDisplayed: boolean; /** - * Sets the fill formatting of the shape to a uniform color. This changes the fill type to `Word.ShapeFillType.Solid`. + * Gets whether crop marks are shown in the corners of pages to indicate where margins are located. * * @remarks - * [Api set: WordApiDesktop 1.2] - * - * @param color A string that represents the fill foreground color. You can provide the value in the '#RRGGBB' format or the color name. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - setSolidColor(color: string): void; + readonly areCropMarksDisplayed: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets whether objects created with the drawing tools are displayed in print layout view. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.ShapeFillLoadOptions): Word.ShapeFill; + readonly areDrawingsDisplayed: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether shading is applied to the ranges in the document that users have permission to modify. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.ShapeFill; + areEditableRangesShaded: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether field codes are displayed. * - * @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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.ShapeFill; + areFieldCodesDisplayed: boolean; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + * Specifies whether Microsoft Word displays formatting changes made to the document with Track Changes enabled. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.ShapeFill; + areFormatChangesDisplayed: boolean; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + * Specifies whether handwritten ink annotations are shown or hidden. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.ShapeFill; + areInkAnnotationsDisplayed: boolean; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ShapeFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeFillData`) that contains shallow copies of any loaded child properties from the original object. + * Specifies whether Microsoft Word displays insertions and deletions made to the document with Track Changes enabled. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.ShapeFillData; - } - /** - * Represents the text frame of a shape object. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - 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; + areInsertionsAndDeletionsDisplayed: boolean; /** - * 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. + * Gets whether lines wrap at the right edge of the document window rather than at the right margin or the right column boundary. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - autoSizeSetting: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed"; + readonly areLinesWrappedToWindow: boolean; /** - * Represents the bottom margin, in points, of the text frame. + * Gets whether object anchors are displayed next to items that can be positioned in print layout view. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bottomMargin: number; + readonly areObjectAnchorsDisplayed: boolean; /** - * Specifies if the text frame contains text. + * Gets whether Microsoft Word displays optional line breaks. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - readonly hasText: boolean; + readonly areOptionalBreaksDisplayed: boolean; /** - * Represents the left margin, in points, of the text frame. + * Gets whether optional hyphens are displayed. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftMargin: number; + readonly areOptionalHyphensDisplayed: boolean; /** - * Returns True if text in the text frame shouldn't rotate when the shape is rotated. + * Gets whether other authors' presence should be visible in the document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - noTextRotation: boolean; + areOtherAuthorsVisible: boolean; /** - * Represents the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. + * Gets whether the top and bottom margins and the gray area between pages in the document are displayed. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - orientation: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed"; + readonly arePageBoundariesDisplayed: boolean; /** - * Represents the right margin, in points, of the text frame. + * Gets whether paragraph marks are displayed. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightMargin: number; + readonly areParagraphsMarksDisplayed: boolean; /** - * Represents the top margin, in points, of the text frame. + * Gets whether blank boxes are displayed as placeholders for pictures. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topMargin: number; + readonly arePicturePlaceholdersDisplayed: boolean; /** - * Represents the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. + * Specifies whether Microsoft Word displays revisions and comments made to the document with Track Changes enabled. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - verticalAlignment: Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom"; + areRevisionsAndCommentsDisplayed: boolean; /** - * Determines whether lines break automatically to fit text inside the shape. + * Gets whether space characters are displayed. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - wordWrap: boolean; + readonly areSpacesIndicated: boolean; /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Specifies whether table gridlines are displayed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.TextFrameUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.TextFrame): void; + areTableGridlinesDisplayed: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets whether tab characters are displayed. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.TextFrameLoadOptions): Word.TextFrame; + readonly areTabsDisplayed: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets whether dotted lines are displayed around page margins, text columns, objects, and frames in print layout view. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.TextFrame; + readonly areTextBoundariesDisplayed: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the column width in Reading mode. * - * @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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.TextFrame; + columnWidth: Word.ColumnWidth | "Narrow" | "Default" | "Wide"; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + * Gets on-screen shading for fields. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.TextFrame; + readonly fieldShading: Word.FieldShading | "Never" | "Always" | "WhenSelected"; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + * Specifies whether all the text in a window is displayed in the same sans-serif font with minimal formatting to speed up display. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.TextFrame; + isDraft: boolean; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TextFrame` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TextFrameData`) that contains shallow copies of any loaded child properties from the original object. + * Specifies whether only the first line of body text is shown in outline view. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.TextFrameData; - } - /** - * Represents all the properties for wrapping text around a shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - class ShapeTextWrap 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; + isFirstLineOnlyDisplayed: boolean; /** - * Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape. + * Specifies whether character formatting is visible in outline view. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bottomDistance: number; + isFormatDisplayed: boolean; /** - * Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape. + * Specifies whether the window is in full-screen view. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftDistance: number; + isFullScreen: boolean; /** - * Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape. + * Gets whether text formatted as hidden text is displayed. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightDistance: number; + readonly isHiddenTextDisplayed: boolean; /** - * Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farthest from the page margin. + * Gets whether highlight formatting is displayed and printed with the document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - side: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest"; + readonly isHighlightingDisplayed: boolean; /** - * Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape. + * Specifies whether the document is in conflict mode view. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topDistance: number; + isInConflictMode: boolean; /** - * Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details. + * Specifies whether Microsoft Word is in Panning mode. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type: Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front"; + isInPanning: boolean; /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Specifies whether the document is being viewed in reading layout view. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.ShapeTextWrapUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ShapeTextWrap): void; + isInReadingLayout: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether mail merge data is displayed instead of mail merge fields. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.ShapeTextWrapLoadOptions): Word.ShapeTextWrap; + isMailMergeDataView: boolean; /** - * 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 document is visible when the header and footer areas are displayed. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.ShapeTextWrap; + isMainTextLayerVisible: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether the pointer is displayed as a magnifying glass in print preview. * - * @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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.ShapeTextWrap; + isPointerShownAsMagnifier: boolean; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + * Specifies whether pages displayed in reading layout view are displayed using the same layout as printed pages. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.ShapeTextWrap; + isReadingLayoutActualView: boolean; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + * Specifies whether XML tags are visible in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.ShapeTextWrap; + isXmlMarkupVisible: boolean; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ShapeTextWrap` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeTextWrapData`) that contains shallow copies of any loaded child properties from the original object. + * Specifies the display mode for tracked changes. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.ShapeTextWrapData; - } - /** - * Represents a single reviewer of a document in which changes have been tracked. The `Reviewer` object is a member of the {@link Word.ReviewerCollection} object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class Reviewer 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; + markupMode: Word.RevisionsMode | "Balloon" | "Inline" | "Mixed"; /** - * Specifies if the `Reviewer` object is visible. + * Specifies the page color in Reading mode. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible: boolean; + pageColor: Word.PageColor | "None" | "Sepia" | "Inverse"; /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Specifies the page movement type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.ReviewerUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Reviewer): void; + pageMovementType: Word.PageMovementType | "Vertical" | "SideToSide"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies whether margins are visible or hidden when the document is viewed in Full Screen Reading view. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.ReviewerLoadOptions): Word.Reviewer; + readingLayoutTruncateMargins: Word.ReadingLayoutMargin | "Automatic" | "Suppress" | "Full"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets whether Word displays revision balloons in the left or right margin in the document. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.Reviewer; + readonly revisionsBalloonSide: Word.RevisionsBalloonMargin | "Left" | "Right"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the width of the revision balloons. * - * @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; - }): Word.Reviewer; - /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. - */ - track(): Word.Reviewer; - /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.Reviewer; + revisionsBalloonWidth: 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 `Word.Reviewer` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ReviewerData`) that contains shallow copies of any loaded child properties from the original object. + * Specifies how Microsoft Word measures the width of revision balloons. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.ReviewerData; - } - /** - * A collection of {@link Word.Reviewer} objects that represents the reviewers of one or more documents. The `ReviewerCollection` object contains the names of all reviewers who have reviewed documents opened or edited on a computer. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class ReviewerCollection 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: Word.Reviewer[]; + revisionsBalloonWidthType: Word.RevisionsBalloonWidthType | "Percent" | "Points"; /** - * Returns a `Reviewer` object that represents the specified item in the collection. + * Specifies the document element displayed in print layout view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param index The index of the item to retrieve. */ - getItem(index: number): Word.Reviewer; + seekView: Word.SeekView | "MainDocument" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "CurrentPageHeader" | "CurrentPageFooter"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the active window pane. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.ReviewerCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ReviewerCollection; + splitSpecial: Word.SpecialPane | "None" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "FootnoteContinuationNotice" | "FootnoteContinuationSeparator" | "FootnoteSeparator" | "EndnoteContinuationNotice" | "EndnoteContinuationSeparator" | "EndnoteSeparator" | "Comments" | "CurrentPageHeader" | "CurrentPageFooter" | "Revisions" | "RevisionsHoriz" | "RevisionsVert"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the view type. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.ReviewerCollection; + type: Word.ViewType | "Normal" | "Outline" | "Print" | "PrintPreview" | "Master" | "Web" | "Reading" | "Conflict"; /** - * 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. + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.ReviewerCollection; + set(properties: Interfaces.ViewUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.View): void; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + * Collapses all the headings in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.ReviewerCollection; + collapseAllHeadings(): void; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + * Collapses the text under the selection or the specified range by one heading level. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param range A `Range` object that specifies the range to collapse. */ - untrack(): Word.ReviewerCollection; + collapseOutline(range: Word.Range): 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 `Word.ReviewerCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ReviewerCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * Expands all the headings in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.ReviewerCollectionData; - } - /** - * Represents the current settings related to the display of reviewers' comments and revision marks in the document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class RevisionsFilter 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; + expandAllHeadings(): void; /** - * Gets the `ReviewerCollection` object that represents the collection of reviewers of one or more documents. + * Expands the text under the selection by one heading level. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param range A `Range` object that specifies the range to expand. */ - readonly reviewers: Word.ReviewerCollection; + expandOutline(range: Word.Range): void; /** - * Specifies a `RevisionsMarkup` value that represents the extent of reviewer markup displayed in the document. + * Moves to the next header or footer, depending on whether a header or footer is displayed in the view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - markup: Word.RevisionsMarkup | "None" | "Simple" | "All"; + nextHeaderFooter(): void; /** - * Specifies a `RevisionsView` value that represents globally whether Word displays the original version of the document or the final version, which might have revisions and formatting changes applied. + * Moves to the previous header or footer, depending on whether a header or footer is displayed in the view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - view: Word.RevisionsView | "Final" | "Original"; + previousHeaderFooter(): void; /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Switches between showing all text (headings and body text) and showing only headings. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.RevisionsFilterUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.RevisionsFilter): void; + showAllHeadings(): void; /** - * Shows or hides all revisions in the document that contain comments and tracked changes. + * Shows all headings up to the specified heading level and hides subordinate headings and body text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param level The heading level to show. */ - toggleShowAllReviewers(): void; + showHeading(level: 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?: Word.Interfaces.RevisionsFilterLoadOptions): Word.RevisionsFilter; + load(options?: Word.Interfaces.ViewLoadOptions): Word.View; /** * 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[]): Word.RevisionsFilter; + load(propertyNames?: string | string[]): Word.View; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -114729,360 +116516,338 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.RevisionsFilter; + }): Word.View; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - track(): Word.RevisionsFilter; + track(): Word.View; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - untrack(): Word.RevisionsFilter; + untrack(): Word.View; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.RevisionsFilter` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RevisionsFilterData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.View` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ViewData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.RevisionsFilterData; + toJSON(): Word.Interfaces.ViewData; } /** - * Represents a single item in a {@link Word.RepeatingSectionContentControl}. + * Represents a shape in the header, footer, or document body. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - class RepeatingSectionItem extends OfficeExtension.ClientObject { + class Shape extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ context: RequestContext; /** - * Returns the range of this repeating section item, excluding the start and end tags. + * Represents the body object of the shape. Only applies to text boxes and geometric shapes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - readonly range: Word.Range; - /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * [Api set: WordApiDesktop 1.2] */ - set(properties: Interfaces.RepeatingSectionItemUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.RepeatingSectionItem): void; + readonly body: Word.Body; /** - * Deletes this `RepeatingSectionItem` object. + * Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "Canvas". 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - delete(): void; + readonly canvas: Word.Canvas; /** - * Adds a repeating section item after this item and returns the new item. + * Returns the fill formatting of the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - insertItemAfter(): Word.RepeatingSectionItem; + readonly fill: Word.ShapeFill; /** - * Adds a repeating section item before this item and returns the new item. + * Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - insertItemBefore(): Word.RepeatingSectionItem; + readonly parentCanvas: Word.Shape; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(options?: Word.Interfaces.RepeatingSectionItemLoadOptions): Word.RepeatingSectionItem; + readonly parentGroup: Word.Shape; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "GroupShape". 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 propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(propertyNames?: string | string[]): Word.RepeatingSectionItem; + readonly shapeGroup: Word.ShapeGroup; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets the text frame object of the shape. * - * @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: WordApiDesktop 1.2] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.RepeatingSectionItem; + readonly textFrame: Word.TextFrame; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + * Returns the text wrap formatting of the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] */ - track(): Word.RepeatingSectionItem; + readonly textWrap: Word.ShapeTextWrap; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + * Specifies whether a given shape can overlap other shapes. + * + * @remarks + * [Api set: WordApiDesktop 1.2] */ - untrack(): Word.RepeatingSectionItem; + allowOverlap: boolean; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.RepeatingSectionItem` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RepeatingSectionItemData`) that contains shallow copies of any loaded child properties from the original object. + * Specifies a string that represents the alternative text associated with the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] */ - toJSON(): Word.Interfaces.RepeatingSectionItemData; - } - /** - * Represents a collection of {@link Word.RepeatingSectionItem} objects in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class RepeatingSectionItemCollection 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; + altTextDescription: string; /** - * Returns an individual repeating section item. + * The geometric shape type of the shape. It will be null if isn't a geometric shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param index The index of the item to retrieve. - * @returns A `RepeatingSectionItem` object representing the item at the specified index. + * [Api set: WordApiDesktop 1.2] */ - getItemAt(index: number): Word.RepeatingSectionItem; + geometricShapeType: Word.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"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * The height, in points, of the shape. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - load(propertyNames?: string | string[]): Word.RepeatingSectionItemCollection; + height: number; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. * - * @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: WordApiDesktop 1.2] */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.RepeatingSectionItemCollection; + heightRelative: number; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + * Gets an integer that represents the shape identifier. + * + * @remarks + * [Api set: WordApiDesktop 1.2] */ - track(): Word.RepeatingSectionItemCollection; + readonly id: number; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + * Check whether this shape is a child of a group shape or a canvas shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] */ - untrack(): Word.RepeatingSectionItemCollection; + readonly isChild: boolean; /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.RepeatingSectionItemCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RepeatingSectionItemCollectionData`) that contains shallow copies of any loaded child properties from the original object. + * The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * + * @remarks + * [Api set: WordApiDesktop 1.2] */ - toJSON(): { - [key: string]: string; - }; - } - /** - * Represents the `DatePickerContentControl` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class DatePickerContentControl 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; + left: number; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly placeholderText: Word.BuildingBlock; + leftRelative: number; /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * Specifies if the aspect ratio of this shape is locked. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly range: Word.Range; + lockAspectRatio: boolean; /** - * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * The name of the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly xmlMapping: Word.XmlMapping; + name: string; /** - * Specifies the appearance of the content control. + * The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + relativeHorizontalPosition: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - color: string; + relativeHorizontalSize: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies a `CalendarType` value that represents the calendar type for the date picker content control. + * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - dateCalendarType: Word.CalendarType | "Western" | "Arabic" | "Hebrew" | "Taiwan" | "Japan" | "Thai" | "Korean" | "SakaEra" | "TranslitEnglish" | "TranslitFrench" | "Umalqura"; + relativeVerticalPosition: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies the format in which dates are displayed. + * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - dateDisplayFormat: string; + relativeVerticalSize: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies a `LanguageId` that represents the language format for the date displayed in the date picker content control. + * Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - dateDisplayLocale: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + rotation: number; /** - * Specifies a `ContentControlDateStorageFormat` value that represents the format for storage and retrieval of dates when the date picker content control is bound to the XML data store of the active document. + * The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - dateStorageFormat: Word.ContentControlDateStorageFormat | "Text" | "Date" | "DateTime"; + top: number; /** - * Gets the identification for the content control. + * The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly id: string; + topRelative: number; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - isTemporary: boolean; + readonly type: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture" | "Canvas"; /** - * Specifies the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Specifies if the shape is visible. Not applicable to inline shapes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + visible: boolean; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * The width, in points, of the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - lockContentControl: boolean; + width: number; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - lockContents: boolean; + widthRelative: number; /** - * Gets whether the placeholder text for the content control is being displayed. + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ShapeUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Shape): void; + /** + * Deletes the shape and its content. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly showingPlaceholderText: boolean; + delete(): void; /** - * Specifies a tag to identify the content control. + * Moves the shape horizontally by the number of points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] + * + * @param distance Required. Specifies how far the shape is to be moved horizontally, in points. Use a positive value to move the shape right. Use a negative value to move the shape left. */ - tag: string; + moveHorizontally(distance: number): void; /** - * Specifies the title for the content control. + * Moves the shape vertically by the number of points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] + * + * @param distance Required. Specifies how far the shape is to be moved vertically, in points. Use a positive value to move the shape up. Use a negative value to move the shape down. */ - title: string; + moveVertically(distance: number): void; /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Scales the height of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current height. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + * + * @param scaleFactor Specifies the ratio between the height of the shape after you resize it and the current or original height. + * @param scaleType Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images. + * @param scaleFrom Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents that the shape's upper left corner retains its position. */ - set(properties: Interfaces.DatePickerContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.DatePickerContentControl): void; + scaleHeight(scaleFactor: number, scaleType: Word.ShapeScaleType, scaleFrom?: Word.ShapeScaleFrom): void; /** - * Copies the content control from the active document to the Clipboard. + * Scales the height of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current height. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] + * + * @param scaleFactor Specifies the ratio between the height of the shape after you resize it and the current or original height. + * @param scaleType Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images. + * @param scaleFrom Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents that the shape's upper left corner retains its position. */ - copy(): void; + scaleHeight(scaleFactor: number, scaleType: "CurrentSize" | "OriginalSize", scaleFrom?: "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"): void; /** - * Removes the content control from the active document and moves the content control to the Clipboard. + * Scales the width of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current height. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] + * + * @param scaleFactor Specifies the ratio between the width of the shape after you resize it and the current or original width. + * @param scaleType Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images. + * @param scaleFrom Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents that the shape's upper left corner retains its position. */ - cut(): void; + scaleWidth(scaleFactor: number, scaleType: Word.ShapeScaleType, scaleFrom?: Word.ShapeScaleFrom): void; /** - * Deletes this content control and the contents of the content control. + * Scales the width of the shape by a specified factor. For images, you can indicate whether you want to scale the shape relative to the original or the current size. Shapes other than pictures are always scaled relative to their current height. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] * - * @param deleteContents Optional. If true, deletes the contents as well. + * @param scaleFactor Specifies the ratio between the width of the shape after you resize it and the current or original width. + * @param scaleType Specifies whether the shape is scaled relative to its original or current size. The original size scaling option only works for images. + * @param scaleFrom Optional. Specifies which part of the shape retains its position when the shape is scaled. If omitted, it represents that the shape's upper left corner retains its position. */ - delete(deleteContents?: boolean): void; + scaleWidth(scaleFactor: number, scaleType: "CurrentSize" | "OriginalSize", scaleFrom?: "ScaleFromTopLeft" | "ScaleFromMiddle" | "ScaleFromBottomRight"): void; /** - * Sets the placeholder text that displays in the content control until a user enters their own text. + * Selects the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] * - * @param options Optional. The options for configuring the content control's placeholder text. + * @param selectMultipleShapes Optional. Whether to select multiple floating shapes. The default value is false. */ - setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void; + select(selectMultipleShapes?: boolean): 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?: Word.Interfaces.DatePickerContentControlLoadOptions): Word.DatePickerContentControl; + load(options?: Word.Interfaces.ShapeLoadOptions): Word.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[]): Word.DatePickerContentControl; + load(propertyNames?: string | string[]): Word.Shape; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -115091,191 +116856,151 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.DatePickerContentControl; + }): Word.Shape; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - track(): Word.DatePickerContentControl; + track(): Word.Shape; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - untrack(): Word.DatePickerContentControl; + untrack(): Word.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 `Word.DatePickerContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DatePickerContentControlData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.Shape` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.DatePickerContentControlData; + toJSON(): Word.Interfaces.ShapeData; } /** - * Represents the `PictureContentControl` object. + * Represents a shape group in the document. To get the corresponding Shape object, use ShapeGroup.shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - class PictureContentControl extends OfficeExtension.ClientObject { + 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 a `BuildingBlock` object that represents the placeholder text for the content control. + * Gets the Shape object associated with the group. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly placeholderText: Word.BuildingBlock; + readonly shape: Word.Shape; /** - * Returns a `Range` object that represents the contents of the content control in the active document. + * Gets the collection of Shape objects. Currently, only text boxes, geometric shapes, and pictures are supported. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly range: Word.Range; + readonly shapes: Word.ShapeCollection; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Gets an integer that represents the shape group identifier. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly xmlMapping: Word.XmlMapping; + readonly id: number; /** - * Specifies the appearance of the content control. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + set(properties: Interfaces.ShapeGroupUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ShapeGroup): void; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Ungroups any grouped shapes in the specified shape group. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - color: string; + ungroup(): Word.ShapeCollection; /** - * Returns the identification for the content control. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param options Provides options for which properties of the object to load. */ - readonly id: string; + load(options?: Word.Interfaces.ShapeGroupLoadOptions): Word.ShapeGroup; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - isTemporary: boolean; + load(propertyNames?: string | string[]): Word.ShapeGroup; /** - * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param propertyNamesAndPaths `propertyNamesAndPaths.select` is a comma-delimited string that specifies the properties to load, and `propertyNamesAndPaths.expand` is a comma-delimited string that specifies the navigation properties to load. */ - readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.ShapeGroup; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - lockContentControl: boolean; + track(): Word.ShapeGroup; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - lockContents: boolean; + untrack(): Word.ShapeGroup; /** - * Returns whether the placeholder text for the content control is being displayed. + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ShapeGroup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeGroupData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.ShapeGroupData; + } + /** + * Represents a canvas in the document. To get the corresponding Shape object, use Canvas.shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + class Canvas 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 Shape object associated with the canvas. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly showingPlaceholderText: boolean; + readonly shape: Word.Shape; /** - * Specifies a tag to identify the content control. + * Gets the collection of Shape objects. Currently, only text boxes, pictures, and geometric shapes are supported. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - tag: string; + readonly shapes: Word.ShapeCollection; /** - * Specifies the title for the content control. + * Gets an integer that represents the canvas identifier. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - title: string; + readonly id: number; /** * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - set(properties: Interfaces.PictureContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; + set(properties: Interfaces.CanvasUpdateData, options?: OfficeExtension.UpdateOptions): void; /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.PictureContentControl): void; - /** - * Copies the content control from the active document to the Clipboard. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - copy(): void; - /** - * Removes the content control from the active document and moves the content control to the Clipboard. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - cut(): void; - /** - * Deletes the content control and optionally its contents. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param deleteContents Optional. Decides whether to delete the contents of the content control. - */ - delete(deleteContents?: boolean): void; - /** - * Sets the placeholder text that displays in the content control until a user enters their own text. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param options Optional. The options for configuring the content control's placeholder text. - */ - setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void; + set(properties: Word.Canvas): 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?: Word.Interfaces.PictureContentControlLoadOptions): Word.PictureContentControl; + load(options?: Word.Interfaces.CanvasLoadOptions): Word.Canvas; /** * 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[]): Word.PictureContentControl; + load(propertyNames?: string | string[]): Word.Canvas; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -115284,199 +117009,212 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.PictureContentControl; + }): Word.Canvas; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - track(): Word.PictureContentControl; + track(): Word.Canvas; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - untrack(): Word.PictureContentControl; + untrack(): Word.Canvas; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.PictureContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PictureContentControlData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.Canvas` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.CanvasData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.PictureContentControlData; + toJSON(): Word.Interfaces.CanvasData; } /** - * Represents the `GroupContentControl` object. + * Contains a collection of {@link Word.Shape} objects. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - class GroupContentControl extends OfficeExtension.ClientObject { + 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: Word.Shape[]; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Gets the shapes that have the specified geometric types. Only applied to geometric shapes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] + * + * @param types Required. An array of geometric shape subtypes. */ - readonly placeholderText: Word.BuildingBlock; + getByGeometricTypes(types: Word.GeometricShapeType[]): Word.ShapeCollection; /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * Gets a shape by its identifier. Throws an `ItemNotFound` error if there isn't a shape with the identifier in this collection. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] + * + * @param id Required. A shape identifier. */ - readonly range: Word.Range; + getById(id: number): Word.Shape; /** - * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Gets a shape by its identifier. If there isn't a shape with the identifier in this collection, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] + * + * @param id Required. A shape identifier. */ - readonly xmlMapping: Word.XmlMapping; + getByIdOrNullObject(id: number): Word.Shape; /** - * Specifies the appearance of the content control. + * Gets the shapes by the identifiers. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] + * + * @param ids Required. An array of shape identifiers. */ - appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + getByIds(ids: number[]): Word.ShapeCollection; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Gets the shapes that have the specified names. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] + * + * @param names Required. An array of shape names. */ - color: string; + getByNames(names: string[]): Word.ShapeCollection; /** - * Returns the identification for the content control. + * Gets the shapes that have the specified types. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] + * + * @param types Required. An array of shape types. */ - readonly id: string; + getByTypes(types: Word.ShapeType[]): Word.ShapeCollection; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Gets the first shape in this collection. Throws an `ItemNotFound` error if this collection is empty. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - isTemporary: boolean; + getFirst(): Word.Shape; /** - * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Gets the first shape in this collection. If this collection is empty, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + getFirstOrNullObject(): Word.Shape; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Groups floating shapes in this collection, inline shapes will be skipped. Returns a Shape object that represents the new group of shapes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - lockContentControl: boolean; + group(): Word.Shape; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param options Provides options for which properties of the object to load. */ - lockContents: boolean; + load(options?: Word.Interfaces.ShapeCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ShapeCollection; /** - * Returns whether the placeholder text for the content control is being displayed. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - readonly showingPlaceholderText: boolean; + load(propertyNames?: string | string[]): Word.ShapeCollection; /** - * Specifies a tag to identify the content control. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @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. */ - tag: string; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.ShapeCollection; /** - * Specifies the title for the content control. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - title: string; + track(): Word.ShapeCollection; /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - set(properties: Interfaces.GroupContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.GroupContentControl): void; + untrack(): Word.ShapeCollection; /** - * Copies the content control from the active document to the Clipboard. + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ShapeCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.ShapeCollectionData; + } + /** + * Represents the fill formatting of a shape object. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + 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; + /** + * Specifies the shape fill background color. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - copy(): void; + backgroundColor: string; /** - * Removes the content control from the active document and moves the content control to the Clipboard. + * Specifies the shape fill foreground color. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - cut(): void; + foregroundColor: string; /** - * Deletes the content control and optionally its contents. + * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param deleteContents Optional. Whether to delete the contents inside the control. + * [Api set: WordApiDesktop 1.2] */ - delete(deleteContents: boolean): void; + transparency: number; /** - * Sets the placeholder text that displays in the content control until a user enters their own text. + * Returns the fill type of the shape. See `Word.ShapeFillType` for details. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] + */ + readonly type: Word.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "Picture" | "Texture" | "Mixed"; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ShapeFillUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ShapeFill): void; + /** + * Clears the fill formatting of this shape and set it to `Word.ShapeFillType.NoFill`; * - * @param options Optional. The options for configuring the content control's placeholder text. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void; + clear(): void; /** - * Removes the group content control from the document so that its child content controls are no longer nested and can be freely edited. + * Sets the fill formatting of the shape to a uniform color. This changes the fill type to `Word.ShapeFillType.Solid`. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] + * + * @param color A string that represents the fill foreground color. You can provide the value in the '#RRGGBB' format or the color name. */ - ungroup(): void; + 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?: Word.Interfaces.GroupContentControlLoadOptions): Word.GroupContentControl; + load(options?: Word.Interfaces.ShapeFillLoadOptions): Word.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[]): Word.GroupContentControl; + load(propertyNames?: string | string[]): Word.ShapeFill; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -115485,240 +117223,214 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.GroupContentControl; + }): Word.ShapeFill; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - track(): Word.GroupContentControl; + track(): Word.ShapeFill; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - untrack(): Word.GroupContentControl; + untrack(): Word.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 `Word.GroupContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.GroupContentControlData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.ShapeFill` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeFillData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.GroupContentControlData; + toJSON(): Word.Interfaces.ShapeFillData; } /** - * The options that define what placeholder to be used in the content control. + * Represents the text frame of a shape object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - interface ContentControlPlaceholderOptions { + 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; /** - * If provided, specifies the `BuildingBlock` object to use as placeholder. + * 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - buildingBlock?: Word.BuildingBlock; + autoSizeSetting: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed"; /** - * If provided, specifies the `Range` object to use as placeholder. + * Represents the bottom margin, in points, of the text frame. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - range?: Word.Range; + bottomMargin: number; /** - * If provided, specifies the text to use as placeholder. + * Specifies if the text frame contains text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - text?: string; - } - /** - * Represents the `BuildingBlockGalleryContentControl` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class BuildingBlockGalleryContentControl 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; + readonly hasText: boolean; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Represents the left margin, in points, of the text frame. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly placeholderText: Word.BuildingBlock; + leftMargin: number; /** - * Returns a `Range` object that represents the contents of the content control in the active document. + * Returns True if text in the text frame shouldn't rotate when the shape is rotated. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly range: Word.Range; + noTextRotation: boolean; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Represents the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - readonly xmlMapping: Word.XmlMapping; + orientation: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed"; /** - * Specifies the appearance of the content control. + * Represents the right margin, in points, of the text frame. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + rightMargin: number; /** - * Specifies the category for the building block content control. + * Represents the top margin, in points, of the text frame. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - buildingBlockCategory: string; + topMargin: number; /** - * Specifies a `BuildingBlockType` value that represents the type of building block for the building block content control. + * Represents the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - buildingBlockType: Word.BuildingBlockType | "QuickParts" | "CoverPage" | "Equations" | "Footers" | "Headers" | "PageNumber" | "Tables" | "Watermarks" | "AutoText" | "TextBox" | "PageNumberTop" | "PageNumberBottom" | "PageNumberPage" | "TableOfContents" | "CustomQuickParts" | "CustomCoverPage" | "CustomEquations" | "CustomFooters" | "CustomHeaders" | "CustomPageNumber" | "CustomTables" | "CustomWatermarks" | "CustomAutoText" | "CustomTextBox" | "CustomPageNumberTop" | "CustomPageNumberBottom" | "CustomPageNumberPage" | "CustomTableOfContents" | "Custom1" | "Custom2" | "Custom3" | "Custom4" | "Custom5" | "Bibliography" | "CustomBibliography"; + verticalAlignment: Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom"; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Determines whether lines break automatically to fit text inside the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - color: string; + wordWrap: boolean; /** - * Gets the identification for the content control. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - readonly id: string; + set(properties: Interfaces.TextFrameUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.TextFrame): void; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param options Provides options for which properties of the object to load. */ - isTemporary: boolean; + load(options?: Word.Interfaces.TextFrameLoadOptions): Word.TextFrame; /** - * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + load(propertyNames?: string | string[]): Word.TextFrame; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @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. */ - lockContentControl: boolean; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.TextFrame; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - lockContents: boolean; + track(): Word.TextFrame; /** - * Gets if the placeholder text for the content control is being displayed. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - readonly showingPlaceholderText: boolean; + untrack(): Word.TextFrame; /** - * Specifies a tag to identify the content control. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TextFrame` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TextFrameData`) that contains shallow copies of any loaded child properties from the original object. */ - tag: string; + toJSON(): Word.Interfaces.TextFrameData; + } + /** + * Represents all the properties for wrapping text around a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + class ShapeTextWrap 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 title for the content control. + * Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - title: string; + bottomDistance: number; /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] */ - set(properties: Interfaces.BuildingBlockGalleryContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.BuildingBlockGalleryContentControl): void; + leftDistance: number; /** - * Copies the content control from the active document to the Clipboard. + * Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - copy(): void; + rightDistance: number; /** - * Removes the content control from the active document and moves the content control to the Clipboard. + * Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farthest from the page margin. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - cut(): void; + side: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest"; /** - * Deletes the content control and optionally its contents. + * Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param deleteContents Optional. Whether to delete the contents inside the control. + * [Api set: WordApiDesktop 1.2] */ - delete(deleteContents?: boolean): void; + topDistance: number; /** - * Sets the placeholder text that displays in the content control until a user enters their own text. + * Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param options The options for configuring the content control's placeholder text. + * [Api set: WordApiDesktop 1.2] */ - setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void; + type: Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front"; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ShapeTextWrapUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ShapeTextWrap): 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?: Word.Interfaces.BuildingBlockGalleryContentControlLoadOptions): Word.BuildingBlockGalleryContentControl; + load(options?: Word.Interfaces.ShapeTextWrapLoadOptions): Word.ShapeTextWrap; /** * 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[]): Word.BuildingBlockGalleryContentControl; + load(propertyNames?: string | string[]): Word.ShapeTextWrap; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -115727,215 +117439,198 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.BuildingBlockGalleryContentControl; + }): Word.ShapeTextWrap; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - track(): Word.BuildingBlockGalleryContentControl; + track(): Word.ShapeTextWrap; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - untrack(): Word.BuildingBlockGalleryContentControl; + untrack(): Word.ShapeTextWrap; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.BuildingBlockGalleryContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BuildingBlockGalleryContentControlData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.ShapeTextWrap` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShapeTextWrapData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.BuildingBlockGalleryContentControlData; + toJSON(): Word.Interfaces.ShapeTextWrapData; } /** - * Represents the `RepeatingSectionContentControl` object. + * Represents a single reviewer of a document in which changes have been tracked. The `Reviewer` object is a member of the {@link Word.ReviewerCollection} object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - class RepeatingSectionContentControl extends OfficeExtension.ClientObject { + class Reviewer 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 `BuildingBlock` object that represents the placeholder text for the content control. + * Specifies if the `Reviewer` object is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly placeholderText: Word.BuildingBlock; + isVisible: boolean; /** - * Gets a `Range` object that represents the contents of the content control in the active document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - readonly range: Word.Range; + set(properties: Interfaces.ReviewerUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Reviewer): void; /** - * Returns the collection of repeating section items in this repeating section content control. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param options Provides options for which properties of the object to load. */ - readonly repeatingSectionItems: Word.RepeatingSectionItemCollection; + load(options?: Word.Interfaces.ReviewerLoadOptions): Word.Reviewer; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - readonly xmlapping: Word.XmlMapping; + load(propertyNames?: string | string[]): Word.Reviewer; /** - * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @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. */ - allowInsertDeleteSection: boolean; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Reviewer; /** - * Specifies the appearance of the content control. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + track(): Word.Reviewer; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - color: string; + untrack(): Word.Reviewer; /** - * Returns the identification for the content control. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Reviewer` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ReviewerData`) that contains shallow copies of any loaded child properties from the original object. */ - readonly id: string; + toJSON(): Word.Interfaces.ReviewerData; + } + /** + * A collection of {@link Word.Reviewer} objects that represents the reviewers of one or more documents. The `ReviewerCollection` object contains the names of all reviewers who have reviewed documents opened or edited on a computer. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class ReviewerCollection 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: Word.Reviewer[]; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Returns a `Reviewer` object that represents the specified item in the collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param index The index of the item to retrieve. */ - isTemporary: boolean; + getItem(index: number): Word.Reviewer; /** - * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param options Provides options for which properties of the object to load. */ - readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + load(options?: Word.Interfaces.ReviewerCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ReviewerCollection; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - lockContentControl: boolean; + load(propertyNames?: string | string[]): Word.ReviewerCollection; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @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. */ - lockContents: boolean; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.ReviewerCollection; /** - * Specifies the name of the repeating section items used in the context menu associated with this repeating section content control. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - repeatingSectionItemTitle: string; + track(): Word.ReviewerCollection; /** - * Returns whether the placeholder text for the content control is being displayed. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - readonly showingPlaceholderText: boolean; + untrack(): Word.ReviewerCollection; /** - * Specifies a tag to identify the content control. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ReviewerCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ReviewerCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - tag: string; + toJSON(): Word.Interfaces.ReviewerCollectionData; + } + /** + * Represents the current settings related to the display of reviewers' comments and revision marks in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class RevisionsFilter 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 title for the content control. + * Gets the `ReviewerCollection` object that represents the collection of reviewers of one or more documents. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title: string; - /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. - */ - set(properties: Interfaces.RepeatingSectionContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.RepeatingSectionContentControl): void; + readonly reviewers: Word.ReviewerCollection; /** - * Copies the content control from the active document to the Clipboard. + * Specifies a `RevisionsMarkup` value that represents the extent of reviewer markup displayed in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - copy(): void; + markup: Word.RevisionsMarkup | "None" | "Simple" | "All"; /** - * Removes the content control from the active document and moves the content control to the Clipboard. + * Specifies a `RevisionsView` value that represents globally whether Word displays the original version of the document or the final version, which might have revisions and formatting changes applied. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cut(): void; + view: Word.RevisionsView | "Final" | "Original"; /** - * Deletes the content control and the contents of the content control. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - * - * @param deleteContents Optional. Whether to delete the contents inside the control. + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - delete(deleteContents?: boolean): void; + set(properties: Interfaces.RevisionsFilterUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.RevisionsFilter): void; /** - * Sets the placeholder text that displays in the content control until a user enters their own text. + * Shows or hides all revisions in the document that contain comments and tracked changes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param options Optional. The options for configuring the content control's placeholder text. */ - setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void; + toggleShowAllReviewers(): 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?: Word.Interfaces.RepeatingSectionContentControlLoadOptions): Word.RepeatingSectionContentControl; + load(options?: Word.Interfaces.RevisionsFilterLoadOptions): Word.RevisionsFilter; /** * 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[]): Word.RepeatingSectionContentControl; + load(propertyNames?: string | string[]): Word.RevisionsFilter; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -115944,157 +117639,178 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.RepeatingSectionContentControl; + }): Word.RevisionsFilter; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - track(): Word.RepeatingSectionContentControl; + track(): Word.RevisionsFilter; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - untrack(): Word.RepeatingSectionContentControl; + untrack(): Word.RevisionsFilter; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.RepeatingSectionContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RepeatingSectionContentControlData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.RevisionsFilter` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RevisionsFilterData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.RepeatingSectionContentControlData; + toJSON(): Word.Interfaces.RevisionsFilterData; } /** - * Calendar types. + * Represents a single item in a {@link Word.RepeatingSectionContentControl}. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum CalendarType { + class RepeatingSectionItem 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; /** - * Western calendar type. + * Returns the range of this repeating section item, excluding the start and end tags. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - western = "Western", + readonly range: Word.Range; /** - * Arabic calendar type. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - arabic = "Arabic", + set(properties: Interfaces.RepeatingSectionItemUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.RepeatingSectionItem): void; /** - * Hebrew calendar type. + * Deletes this `RepeatingSectionItem` object. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hebrew = "Hebrew", + delete(): void; /** - * Taiwan calendar type. + * Adds a repeating section item after this item and returns the new item. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - taiwan = "Taiwan", + insertItemAfter(): Word.RepeatingSectionItem; /** - * Japanese calendar type. + * Adds a repeating section item before this item and returns the new item. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - japan = "Japan", + insertItemBefore(): Word.RepeatingSectionItem; /** - * Thai calendar type. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - thai = "Thai", + load(options?: Word.Interfaces.RepeatingSectionItemLoadOptions): Word.RepeatingSectionItem; /** - * Korean calendar type. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - korean = "Korean", + load(propertyNames?: string | string[]): Word.RepeatingSectionItem; /** - * Saka Era calendar type. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - sakaEra = "SakaEra", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.RepeatingSectionItem; /** - * Transliterated English calendar type. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - translitEnglish = "TranslitEnglish", + track(): Word.RepeatingSectionItem; /** - * Transliterated French calendar type. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - translitFrench = "TranslitFrench", + untrack(): Word.RepeatingSectionItem; /** - * Umm al-Qura calendar type. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.RepeatingSectionItem` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RepeatingSectionItemData`) that contains shallow copies of any loaded child properties from the original object. */ - umalqura = "Umalqura", + toJSON(): Word.Interfaces.RepeatingSectionItemData; } /** - * Date storage formats for {@link Word.DatePickerContentControl}. + * Represents a collection of {@link Word.RepeatingSectionItem} objects in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum ContentControlDateStorageFormat { + class RepeatingSectionItemCollection 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; /** - * Stores the date as text. + * Returns an individual repeating section item. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param index The index of the item to retrieve. + * @returns A `RepeatingSectionItem` object representing the item at the specified index. */ - text = "Text", + getItemAt(index: number): Word.RepeatingSectionItem; /** - * Stores the date as a date object. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - date = "Date", + load(propertyNames?: string | string[]): Word.RepeatingSectionItemCollection; /** - * Stores the date as a date-time object. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - dateTime = "DateTime", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.RepeatingSectionItemCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.RepeatingSectionItemCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.RepeatingSectionItemCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.RepeatingSectionItemCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RepeatingSectionItemCollectionData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): { + [key: string]: string; + }; } /** - * Represents a frame. The `Frame` object is a member of the {@link Word.FrameCollection} object. + * Represents a single tracked change in a document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - class Frame extends OfficeExtension.ClientObject { + class Revision 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 `BorderUniversalCollection` object that represents all the borders for the frame. + * Gets a `Range` object that represents the range of text that was moved from one place to another in the document with tracked changes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly borders: Word.BorderUniversalCollection; + readonly movedRange: Word.Range; /** - * Returns a `Range` object that represents the portion of the document that's contained within the frame. + * Gets a `Range` object that represents the portion of the document that's contained within a revision mark. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -116102,870 +117818,770 @@ declare namespace Word { */ readonly range: Word.Range; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. + * Gets the name of the user who made the tracked change. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly shading: Word.ShadingUniversal; + readonly author: string; /** - * Specifies the height (in points) of the frame. + * Gets the date and time when the tracked change was made. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - height: number; + readonly date: Date; /** - * Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. + * Gets the description of tracked formatting changes in the revision. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - heightRule: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; + readonly formatDescription: string; /** - * Specifies the horizontal distance between the frame and the surrounding text, in points. + * Gets a number that represents the position of this item in a collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontalDistanceFromText: number; + readonly index: number; /** - * Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property. + * Gets the revision type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontalPosition: number; + readonly type: Word.RevisionType | "None" | "Insert" | "Delete" | "Property" | "ParagraphNumber" | "DisplayField" | "Reconcile" | "Conflict" | "Style" | "Replace" | "ParagraphProperty" | "TableProperty" | "SectionProperty" | "StyleDefinition" | "MovedFrom" | "MovedTo" | "CellInsertion" | "CellDeletion" | "CellMerge" | "CellSplit" | "ConflictInsert" | "ConflictDelete"; /** - * Specifies if the frame is locked. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - lockAnchor: boolean; + set(properties: Interfaces.RevisionUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Revision): void; /** - * Specifies the relative horizontal position of the frame. + * Accepts the tracked change, removes the revision mark, and incorporates the change into the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - relativeHorizontalPosition: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; + accept(): void; /** - * Specifies the relative vertical position of the frame. + * Rejects the tracked change. The revision marks are removed, leaving the original text intact. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - relativeVerticalPosition: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + reject(): void; /** - * Specifies if document text wraps around the 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param options Provides options for which properties of the object to load. */ - textWrap: boolean; + load(options?: Word.Interfaces.RevisionLoadOptions): Word.Revision; /** - * Specifies the vertical distance (in points) between the frame and the surrounding text. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. */ - verticalDistanceFromText: number; + load(propertyNames?: string | string[]): Word.Revision; /** - * Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property. + * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @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. */ - verticalPosition: number; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Revision; /** - * Specifies the width (in points) of the frame. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - width: number; + track(): Word.Revision; /** - * Specifies the rule used to determine the width of the frame. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - widthRule: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; + untrack(): Word.Revision; /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Revision` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RevisionData`) that contains shallow copies of any loaded child properties from the original object. */ - set(properties: Interfaces.FrameUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Frame): void; + toJSON(): Word.Interfaces.RevisionData; + } + /** + * A collection of Revision objects that represent the changes marked with revision marks in a range or document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class RevisionCollection 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: Word.Revision[]; /** - * Copies the frame to the Clipboard. + * Accepts all the tracked changes in the document or range, removes all revision marks, and incorporates the changes into the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - copy(): void; + acceptAll(): void; /** - * Removes the frame from the document and places it on the Clipboard. + * Returns a `Revision` object that represents the specified item in the collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - */ - cut(): void; - /** - * Deletes the frame. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param index The index of the item to retrieve. */ - delete(): void; + getItem(index: number): Word.Revision; /** - * Selects the frame. + * Rejects all the tracked changes in the document or range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - select(): void; + rejectAll(): 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?: Word.Interfaces.FrameLoadOptions): Word.Frame; + load(options?: Word.Interfaces.RevisionCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.RevisionCollection; /** * 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[]): Word.Frame; + load(propertyNames?: string | string[]): Word.RevisionCollection; /** * 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; - }): Word.Frame; + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.RevisionCollection; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - track(): Word.Frame; + track(): Word.RevisionCollection; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - untrack(): Word.Frame; + untrack(): Word.RevisionCollection; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Frame` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FrameData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.RevisionCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RevisionCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.FrameData; + toJSON(): Word.Interfaces.RevisionCollectionData; } /** - * Represents the collection of {@link Word.Frame} objects. + * Represents the `DatePickerContentControl` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - class FrameCollection extends OfficeExtension.ClientObject { + class DatePickerContentControl 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: Word.Frame[]; /** - * Returns a `Frame` object that represents a new frame added to a range, selection, or document. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + */ + readonly placeholderText: Word.BuildingBlock; + /** + * Gets a `Range` object that represents the contents of the content control in the active document. * - * @param range The range where the frame will be added. - * @returns A `Frame` object that represents the new frame. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - add(range: Word.Range): Word.Frame; + readonly range: Word.Range; /** - * Deletes the `FrameCollection` object. + * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - delete(): void; + readonly xmlMapping: Word.XmlMapping; /** - * Gets a `Frame` object by its index in the collection. + * Specifies the appearance of the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + */ + appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + /** + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * - * @param index The location of a `Frame` object. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - getItem(index: number): Word.Frame; + color: string; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies a `CalendarType` value that represents the calendar type for the date picker content control. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.FrameCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.FrameCollection; + dateCalendarType: Word.CalendarType | "Western" | "Arabic" | "Hebrew" | "Taiwan" | "Japan" | "Thai" | "Korean" | "SakaEra" | "TranslitEnglish" | "TranslitFrench" | "Umalqura"; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the format in which dates are displayed. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.FrameCollection; + dateDisplayFormat: string; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies a `LanguageId` that represents the language format for the date displayed in the date picker content control. * - * @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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.FrameCollection; + dateDisplayLocale: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + * Specifies a `ContentControlDateStorageFormat` value that represents the format for storage and retrieval of dates when the date picker content control is bound to the XML data store of the active document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.FrameCollection; + dateStorageFormat: Word.ContentControlDateStorageFormat | "Text" | "Date" | "DateTime"; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + * Gets the identification for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.FrameCollection; + readonly id: 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 `Word.FrameCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FrameCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.FrameCollectionData; - } - /** - * Represents a document library version. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class DocumentLibraryVersion 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; + isTemporary: boolean; /** - * Gets any optional comments associated with this version of the shared document. + * Specifies the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly comments: string; + readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * Gets the date and time at which this version of the shared document was last saved to the server. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly modified: any; + lockContentControl: boolean; /** - * Gets the name of the user who last saved this version of the shared document to the server. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly modifiedBy: string; + lockContents: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Gets whether the placeholder text for the content control is being displayed. * - * @param options Provides options for which properties of the object to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.DocumentLibraryVersionLoadOptions): Word.DocumentLibraryVersion; + readonly showingPlaceholderText: boolean; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies a tag to identify the content control. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.DocumentLibraryVersion; + tag: string; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Specifies the title for the content control. * - * @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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.DocumentLibraryVersion; + title: string; /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - track(): Word.DocumentLibraryVersion; + set(properties: Interfaces.DatePickerContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.DatePickerContentControl): void; /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + * Copies the content control from the active document to the Clipboard. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.DocumentLibraryVersion; + copy(): 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 `Word.DocumentLibraryVersion` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentLibraryVersionData`) that contains shallow copies of any loaded child properties from the original object. + * Removes the content control from the active document and moves the content control to the Clipboard. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.DocumentLibraryVersionData; - } - /** - * Represents the collection of {@link Word.DocumentLibraryVersion} objects. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class DocumentLibraryVersionCollection 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: Word.DocumentLibraryVersion[]; + cut(): void; /** - * Gets a `DocumentLibraryVersion` object by its index in the collection. + * Deletes this content control and the contents of the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta * - * @param index The location of a `DocumentLibraryVersion` object. + * @param deleteContents Optional. If true, deletes the contents as well. */ - getItem(index: number): Word.DocumentLibraryVersion; + delete(deleteContents?: boolean): void; /** - * Returns whether the document library in which the active document is saved on the server is configured to create a backup copy, or version, each time the file is edited on the website. + * Sets the placeholder text that displays in the content control until a user enters their own text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param options Optional. The options for configuring the content control's placeholder text. */ - isVersioningEnabled(): OfficeExtension.ClientResult; + setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): 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?: Word.Interfaces.DocumentLibraryVersionCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.DocumentLibraryVersionCollection; + load(options?: Word.Interfaces.DatePickerContentControlLoadOptions): Word.DatePickerContentControl; /** * 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[]): Word.DocumentLibraryVersionCollection; + load(propertyNames?: string | string[]): Word.DatePickerContentControl; /** * 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): Word.DocumentLibraryVersionCollection; + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.DatePickerContentControl; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - track(): Word.DocumentLibraryVersionCollection; + track(): Word.DatePickerContentControl; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - untrack(): Word.DocumentLibraryVersionCollection; + untrack(): Word.DatePickerContentControl; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.DocumentLibraryVersionCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentLibraryVersionCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. - */ - toJSON(): Word.Interfaces.DocumentLibraryVersionCollectionData; - } - /** - * Represents the possible change tracking modes. - * - * @remarks - * [Api set: WordApi 1.4] - */ - enum ChangeTrackingMode { - /** - * ChangeTracking is turned off. - * @remarks - * [Api set: WordApi 1.4] - */ - off = "Off", - /** - * ChangeTracking is turned on for everyone. - * @remarks - * [Api set: WordApi 1.4] - */ - trackAll = "TrackAll", - /** - * Tracking is turned on for my changes only. - * @remarks - * [Api set: WordApi 1.4] - */ - trackMineOnly = "TrackMineOnly", - } - /** - * Specify the current version or the original version of the text. - * - * @remarks - * [Api set: WordApi 1.4] - */ - enum ChangeTrackingVersion { - /** - * @remarks - * [Api set: WordApi 1.4] - */ - original = "Original", - /** - * @remarks - * [Api set: WordApi 1.4] + * Whereas the original `Word.DatePickerContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DatePickerContentControlData`) that contains shallow copies of any loaded child properties from the original object. */ - current = "Current", + toJSON(): Word.Interfaces.DatePickerContentControlData; } /** - * Specify the track state when ChangeTracking is on. + * Represents the `PictureContentControl` object. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum ChangeTrackingState { + class PictureContentControl 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 `BuildingBlock` object that represents the placeholder text for the content control. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - unknown = "Unknown", + readonly placeholderText: Word.BuildingBlock; /** + * Returns a `Range` object that represents the contents of the content control in the active document. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - normal = "Normal", + readonly range: Word.Range; /** + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - added = "Added", + readonly xmlMapping: Word.XmlMapping; /** + * Specifies the appearance of the content control. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - deleted = "Deleted", - } - /** - * TrackedChange type. - * - * @remarks - * [Api set: WordApi 1.6] - */ - enum TrackedChangeType { + appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * No revision. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - none = "None", + color: string; /** - * Add change. + * Returns the identification for the content control. + * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - added = "Added", + readonly id: string; /** - * Delete change. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - deleted = "Deleted", + isTemporary: boolean; /** - * Format change. + * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - formatted = "Formatted", - } - /** - * Note item type - * - * @remarks - * [Api set: WordApi 1.5] - */ - enum NoteItemType { + readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - footnote = "Footnote", + lockContentControl: boolean; /** + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - endnote = "Endnote", - } - /** - * Provides information about the type of a raised event. - * - * @remarks - * [Api set: WordApi 1.5] - */ - enum EventType { + lockContents: boolean; /** - * ContentControlDeleted represents the event that the content control has been deleted. + * Returns whether the placeholder text for the content control is being displayed. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - contentControlDeleted = "ContentControlDeleted", + readonly showingPlaceholderText: boolean; /** - * ContentControlSelectionChanged represents the event that the selection in the content control has been changed. + * Specifies a tag to identify the content control. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - contentControlSelectionChanged = "ContentControlSelectionChanged", + tag: string; /** - * ContentControlDataChanged represents the event that the data in the content control have been changed. + * Specifies the title for the content control. + * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - contentControlDataChanged = "ContentControlDataChanged", + title: string; /** - * ContentControlAdded represents the event a content control has been added to the document. - * @remarks - * [Api set: WordApi 1.5] + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - contentControlAdded = "ContentControlAdded", + set(properties: Interfaces.PictureContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.PictureContentControl): void; /** - * Represents that one or more comments were deleted. + * Copies the content control from the active document to the Clipboard. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - commentDeleted = "CommentDeleted", + copy(): void; /** - * Represents that a comment was selected. + * Removes the content control from the active document and moves the content control to the Clipboard. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - commentSelected = "CommentSelected", + cut(): void; /** - * Represents that a comment was deselected. + * Deletes the content control and optionally its contents. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param deleteContents Optional. Decides whether to delete the contents of the content control. */ - commentDeselected = "CommentDeselected", + delete(deleteContents?: boolean): void; /** - * Represents that a comment or its reply was changed. + * Sets the placeholder text that displays in the content control until a user enters their own text. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param options Optional. The options for configuring the content control's placeholder text. */ - commentChanged = "CommentChanged", + setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void; /** - * Represents that one or more new comments were added. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - commentAdded = "CommentAdded", + load(options?: Word.Interfaces.PictureContentControlLoadOptions): Word.PictureContentControl; /** - * Represents that a content control has been entered. - * @remarks - * [Api set: WordApi 1.5] + * 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. */ - contentControlEntered = "ContentControlEntered", + load(propertyNames?: string | string[]): Word.PictureContentControl; /** - * Represents that a content control has been exited. - * @remarks - * [Api set: WordApi 1.5] + * 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. */ - contentControlExited = "ContentControlExited", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.PictureContentControl; /** - * Represents that one or more new paragraphs were added. - * @remarks - * [Api set: WordApi 1.6] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - paragraphAdded = "ParagraphAdded", + track(): Word.PictureContentControl; /** - * Represents that one or more paragraphs were changed. - * @remarks - * [Api set: WordApi 1.6] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - paragraphChanged = "ParagraphChanged", - /** - * Represents that one or more paragraphs were deleted. - * @remarks - * [Api set: WordApi 1.6] - */ - paragraphDeleted = "ParagraphDeleted", - /** - * Represents that an annotation was clicked (or selected with **Alt+Down**) in the document. - * @remarks - * [Api set: WordApi 1.7] - */ - annotationClicked = "AnnotationClicked", - /** - * Represents that an annotation was hovered over in the document. - * @remarks - * [Api set: WordApi 1.7] - */ - annotationHovered = "AnnotationHovered", - /** - * Represents that one or more annotations were added in the document. - * @remarks - * [Api set: WordApi 1.7] - */ - annotationInserted = "AnnotationInserted", - /** - * Represents that one or more annotations were deleted from the document. - * @remarks - * [Api set: WordApi 1.7] - */ - annotationRemoved = "AnnotationRemoved", - /** - * Represents an action in the annotation pop-up. - * @remarks - * [Api set: WordApi 1.8] - */ - annotationPopupAction = "AnnotationPopupAction", - } - /** - * An enum that specifies an event's source. It can be local or remote (through coauthoring). - * - * @remarks - * [Api set: WordApi 1.5] - */ - enum EventSource { - /** - * @remarks - * [Api set: WordApi 1.5] - */ - local = "Local", + untrack(): Word.PictureContentControl; /** - * @remarks - * [Api set: WordApi 1.5] + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.PictureContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PictureContentControlData`) that contains shallow copies of any loaded child properties from the original object. */ - remote = "Remote", + toJSON(): Word.Interfaces.PictureContentControlData; } /** - * Provides information about the content control that raised contentControlAdded event. + * Represents the `GroupContentControl` object. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - interface ContentControlAddedEventArgs { - /** - * The event type. See Word.EventType for details. - * - * @remarks - * [Api set: WordApi 1.5] - */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + class GroupContentControl 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 content control IDs. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ids: number[]; + readonly placeholderText: Word.BuildingBlock; /** - * The source of the event. It can be local or remote (through coauthoring). + * Gets a `Range` object that represents the contents of the content control in the active document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - source: Word.EventSource | "Local" | "Remote"; - } - /** - * Provides information about the content control that raised contentControlDataChanged event. - * - * @remarks - * [Api set: WordApi 1.5] - */ - interface ContentControlDataChangedEventArgs { + readonly range: Word.Range; /** - * The event type. See Word.EventType for details. + * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + readonly xmlMapping: Word.XmlMapping; /** - * Gets the content control IDs. + * Specifies the appearance of the content control. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ids: number[]; + appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * The source of the event. It can be local or remote (through coauthoring). + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - source: Word.EventSource | "Local" | "Remote"; - } - /** - * Provides information about the content control that raised contentControlDeleted event. - * - * @remarks - * [Api set: WordApi 1.5] - */ - interface ContentControlDeletedEventArgs { + color: string; /** - * The event type. See Word.EventType for details. + * Returns the identification for the content control. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + readonly id: string; /** - * Gets the content control IDs. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ids: number[]; + isTemporary: boolean; /** - * The source of the event. It can be local or remote (through coauthoring). + * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - source: Word.EventSource | "Local" | "Remote"; - } - /** - * Provides information about the content control that raised contentControlEntered event. - * - * @remarks - * [Api set: WordApi 1.5] - */ - interface ContentControlEnteredEventArgs { + readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * The event type. See Word.EventType for details. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + lockContentControl: boolean; /** - * Gets the content control IDs. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ids: number[]; + lockContents: boolean; /** - * The source of the event. It can be local or remote (through coauthoring). + * Returns whether the placeholder text for the content control is being displayed. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - source: Word.EventSource | "Local" | "Remote"; - } - /** - * Provides information about the content control that raised contentControlExited event. - * - * @remarks - * [Api set: WordApi 1.5] - */ - interface ContentControlExitedEventArgs { + readonly showingPlaceholderText: boolean; /** - * The event type. See Word.EventType for details. + * Specifies a tag to identify the content control. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + tag: string; /** - * Gets the content control IDs. + * Specifies the title for the content control. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ids: number[]; + title: string; /** - * The source of the event. It can be local or remote (through coauthoring). - * - * @remarks - * [Api set: WordApi 1.5] + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - source: Word.EventSource | "Local" | "Remote"; - } - /** - * Represents a dropped capital letter in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class DropCap 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; + set(properties: Interfaces.GroupContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.GroupContentControl): void; /** - * Gets the distance (in points) between the dropped capital letter and the paragraph text. + * Copies the content control from the active document to the Clipboard. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly distanceFromText: number; + copy(): void; /** - * Gets the name of the font for the dropped capital letter. + * Removes the content control from the active document and moves the content control to the Clipboard. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly fontName: string; + cut(): void; /** - * Gets the height (in lines) of the dropped capital letter. + * Deletes the content control and optionally its contents. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - */ - readonly linesToDrop: number; - /** - * Gets the position of the dropped capital letter. * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * @param deleteContents Optional. Whether to delete the contents inside the control. */ - readonly position: Word.DropPosition | "None" | "Normal" | "Margin"; + delete(deleteContents: boolean): void; /** - * Removes the dropped capital letter formatting. + * Sets the placeholder text that displays in the content control until a user enters their own text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param options Optional. The options for configuring the content control's placeholder text. */ - clear(): void; + setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void; /** - * Formats the first character in the specified paragraph as a dropped capital letter. + * Removes the group content control from the document so that its child content controls are no longer nested and can be freely edited. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enable(): void; + 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?: Word.Interfaces.DropCapLoadOptions): Word.DropCap; + load(options?: Word.Interfaces.GroupContentControlLoadOptions): Word.GroupContentControl; /** * 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[]): Word.DropCap; + load(propertyNames?: string | string[]): Word.GroupContentControl; /** * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. * @@ -116974,14169 +118590,14492 @@ declare namespace Word { load(propertyNamesAndPaths?: { select?: string; expand?: string; - }): Word.DropCap; + }): Word.GroupContentControl; /** * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - track(): Word.DropCap; + track(): Word.GroupContentControl; /** * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - untrack(): Word.DropCap; + untrack(): Word.GroupContentControl; /** * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.DropCap` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DropCapData`) that contains shallow copies of any loaded child properties from the original object. + * Whereas the original `Word.GroupContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.GroupContentControlData`) that contains shallow copies of any loaded child properties from the original object. */ - toJSON(): Word.Interfaces.DropCapData; + toJSON(): Word.Interfaces.GroupContentControlData; } /** - * Provides information about the content control that raised contentControlSelectionChanged event. + * The options that define what placeholder to be used in the content control. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - interface ContentControlSelectionChangedEventArgs { + interface ContentControlPlaceholderOptions { /** - * The event type. See Word.EventType for details. + * If provided, specifies the `BuildingBlock` object to use as placeholder. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + buildingBlock?: Word.BuildingBlock; /** - * Gets the content control IDs. + * If provided, specifies the `Range` object to use as placeholder. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ids: number[]; + range?: Word.Range; /** - * The source of the event. It can be local or remote (through coauthoring). + * If provided, specifies the text to use as placeholder. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - source: Word.EventSource | "Local" | "Remote"; + text?: string; } /** - * Provides information about the paragraphs that raised the paragraphAdded event. + * Represents the `BuildingBlockGalleryContentControl` object. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - interface ParagraphAddedEventArgs { - /** - * The source of the event. It can be local or remote (through coauthoring). - * - * @remarks - * [Api set: WordApi 1.6] - */ - source: Word.EventSource | "Local" | "Remote"; - /** - * The event type. See Word.EventType for details. - * - * @remarks - * [Api set: WordApi 1.6] - */ - type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + class BuildingBlockGalleryContentControl 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 IDs of the involved paragraphs. IDs are in standard 8-4-4-4-12 GUID format without curly braces and differ across sessions and coauthors. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - uniqueLocalIds: string[]; - } - /** - * Provides information about the paragraphs that raised the paragraphChanged event. - * - * @remarks - * [Api set: WordApi 1.6] - */ - interface ParagraphChangedEventArgs { + readonly placeholderText: Word.BuildingBlock; /** - * The source of the event. It can be local or remote (through coauthoring). + * Returns a `Range` object that represents the contents of the content control in the active document. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - source: Word.EventSource | "Local" | "Remote"; + readonly range: Word.Range; /** - * The event type. See Word.EventType for details. + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + readonly xmlMapping: Word.XmlMapping; /** - * Gets the unique IDs of the involved paragraphs. IDs are in standard 8-4-4-4-12 GUID format without curly braces and differ across sessions and coauthors. + * Specifies the appearance of the content control. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - uniqueLocalIds: string[]; - } - /** - * Provides information about the paragraphs that raised the paragraphDeleted event. - * - * @remarks - * [Api set: WordApi 1.6] - */ - interface ParagraphDeletedEventArgs { + appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * The source of the event. It can be local or remote (through coauthoring). + * Specifies the category for the building block content control. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - source: Word.EventSource | "Local" | "Remote"; + buildingBlockCategory: string; /** - * The event type. See Word.EventType for details. + * Specifies a `BuildingBlockType` value that represents the type of building block for the building block content control. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; + buildingBlockType: Word.BuildingBlockType | "QuickParts" | "CoverPage" | "Equations" | "Footers" | "Headers" | "PageNumber" | "Tables" | "Watermarks" | "AutoText" | "TextBox" | "PageNumberTop" | "PageNumberBottom" | "PageNumberPage" | "TableOfContents" | "CustomQuickParts" | "CustomCoverPage" | "CustomEquations" | "CustomFooters" | "CustomHeaders" | "CustomPageNumber" | "CustomTables" | "CustomWatermarks" | "CustomAutoText" | "CustomTextBox" | "CustomPageNumberTop" | "CustomPageNumberBottom" | "CustomPageNumberPage" | "CustomTableOfContents" | "Custom1" | "Custom2" | "Custom3" | "Custom4" | "Custom5" | "Bibliography" | "CustomBibliography"; /** - * Gets the unique IDs of the involved paragraphs. IDs are in standard 8-4-4-4-12 GUID format without curly braces and differ across sessions and coauthors. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - uniqueLocalIds: string[]; - } - /** - * Provides information about the comments that raised the comment event. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface CommentEventArgs { + color: string; /** - * Represents how the comment changed event is triggered. + * Gets the identification for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - changeType: Word.CommentChangeType | "none" | "edited" | "resolved" | "reopened" | "replyAdded" | "replyDeleted" | "replyEdited"; + readonly id: string; /** - * Gets the CommentDetail array which contains the IDs and reply IDs of the involved comments. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - commentDetails: Word.CommentDetail[]; + isTemporary: boolean; /** - * The source of the event. It can be local or remote (through coauthoring). + * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - source: Word.EventSource | "Local" | "Remote"; + readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * The event type. See Word.EventType for details. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; - } - /** - * A structure for the ID and reply IDs of this comment. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface CommentDetail { + lockContentControl: boolean; /** - * Represents the ID of this comment. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id: string; + lockContents: boolean; /** - * Represents the IDs of the replies to this comment. + * Gets if the placeholder text for the content control is being displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - replyIds: string[]; - } - /** - * Represents how the comments in the event were changed. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum CommentChangeType { + readonly showingPlaceholderText: boolean; /** - * No comment changed event is triggered. + * Specifies a tag to identify the content control. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "none", + tag: string; /** - * A comment was edited. + * Specifies the title for the content control. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - edited = "edited", + title: string; /** - * A comment was resolved. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - resolved = "resolved", + set(properties: Interfaces.BuildingBlockGalleryContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.BuildingBlockGalleryContentControl): void; /** - * A comment was reopened. + * Copies the content control from the active document to the Clipboard. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - reopened = "reopened", + copy(): void; /** - * A reply was added. + * Removes the content control from the active document and moves the content control to the Clipboard. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - replyAdded = "replyAdded", + cut(): void; /** - * A reply was deleted. + * Deletes the content control and optionally its contents. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param deleteContents Optional. Whether to delete the contents inside the control. */ - replyDeleted = "replyDeleted", + delete(deleteContents?: boolean): void; /** - * A reply was edited. + * Sets the placeholder text that displays in the content control until a user enters their own text. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param options The options for configuring the content control's placeholder text. */ - replyEdited = "replyEdited", - } - /** - * Specifies supported content control types and subtypes. - * - * @remarks - * [Api set: WordApi 1.1] - */ - enum ContentControlType { + setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void; /** - * @remarks - * [Api set: WordApi 1.1] + * 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. */ - unknown = "Unknown", + load(options?: Word.Interfaces.BuildingBlockGalleryContentControlLoadOptions): Word.BuildingBlockGalleryContentControl; /** - * @remarks - * [Api set: WordApi 1.1] + * 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. */ - richTextInline = "RichTextInline", + load(propertyNames?: string | string[]): Word.BuildingBlockGalleryContentControl; /** - * @remarks - * [Api set: WordApi 1.1] + * 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. */ - richTextParagraphs = "RichTextParagraphs", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.BuildingBlockGalleryContentControl; /** - * Contains a whole cell. - * @remarks - * [Api set: WordApi 1.1] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - richTextTableCell = "RichTextTableCell", + track(): Word.BuildingBlockGalleryContentControl; /** - * Contains a whole row. - * @remarks - * [Api set: WordApi 1.1] - */ - richTextTableRow = "RichTextTableRow", - /** - * Contains a whole table. - * @remarks - * [Api set: WordApi 1.1] - */ - richTextTable = "RichTextTable", - /** - * @remarks - * [Api set: WordApi 1.1] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - plainTextInline = "PlainTextInline", + untrack(): Word.BuildingBlockGalleryContentControl; /** - * @remarks - * [Api set: WordApi 1.1] + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.BuildingBlockGalleryContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BuildingBlockGalleryContentControlData`) that contains shallow copies of any loaded child properties from the original object. */ - plainTextParagraph = "PlainTextParagraph", + toJSON(): Word.Interfaces.BuildingBlockGalleryContentControlData; + } + /** + * Represents the `RepeatingSectionContentControl` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class RepeatingSectionContentControl 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 `BuildingBlock` object that represents the placeholder text for the content control. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - picture = "Picture", + readonly placeholderText: Word.BuildingBlock; /** + * Gets a `Range` object that represents the contents of the content control in the active document. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - buildingBlockGallery = "BuildingBlockGallery", + readonly range: Word.Range; /** + * Returns the collection of repeating section items in this repeating section content control. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - checkBox = "CheckBox", + readonly repeatingSectionItems: Word.RepeatingSectionItemCollection; /** + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - comboBox = "ComboBox", + readonly xmlapping: Word.XmlMapping; /** + * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dropDownList = "DropDownList", + allowInsertDeleteSection: boolean; /** + * Specifies the appearance of the content control. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - datePicker = "DatePicker", + appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - repeatingSection = "RepeatingSection", + color: string; /** - * Identifies a rich text content control. + * Returns the identification for the content control. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - richText = "RichText", + readonly id: string; /** + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - plainText = "PlainText", + isTemporary: boolean; /** + * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - group = "Group", - } - /** - * ContentControl appearance. - * - * @remarks - * [Api set: WordApi 1.1] - * - * Content control appearance options are BoundingBox, Tags, or Hidden. - */ - enum ContentControlAppearance { + readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * Represents a content control shown as a shaded rectangle or bounding box (with optional title). + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - boundingBox = "BoundingBox", + lockContentControl: boolean; /** - * Represents a content control shown as start and end markers. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tags = "Tags", + lockContents: boolean; /** - * Represents a content control that isn't shown. + * Specifies the name of the repeating section items used in the context menu associated with this repeating section content control. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - hidden = "Hidden", - } - /** - * Content control level types. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ContentControlLevel { + repeatingSectionItemTitle: string; /** - * Represents an inline content control. + * Returns whether the placeholder text for the content control is being displayed. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - inline = "Inline", + readonly showingPlaceholderText: boolean; /** - * Represents a paragraph-level content control. + * Specifies a tag to identify the content control. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - paragraph = "Paragraph", + tag: string; /** - * Represents a row-level content control. + * Specifies the title for the content control. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - row = "Row", + title: string; /** - * Represents a cell-level content control. + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.RepeatingSectionContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.RepeatingSectionContentControl): void; + /** + * Copies the content control from the active document to the Clipboard. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cell = "Cell", - } - /** - * Represents the state of the content control. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ContentControlState { + copy(): void; /** - * Error state. + * Removes the content control from the active document and moves the content control to the Clipboard. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - error = "Error", + cut(): void; /** - * Warning state. + * Deletes the content control and the contents of the content control. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param deleteContents Optional. Whether to delete the contents inside the control. */ - warning = "Warning", - } - /** - * The supported styles for underline format. - * - * @remarks - * [Api set: WordApi 1.1] - */ - enum UnderlineType { + delete(deleteContents?: boolean): void; /** + * Sets the placeholder text that displays in the content control until a user enters their own text. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options Optional. The options for configuring the content control's placeholder text. */ - mixed = "Mixed", + setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void; /** - * No underline. - * @remarks - * [Api set: WordApi 1.1] + * 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. */ - none = "None", + load(options?: Word.Interfaces.RepeatingSectionContentControlLoadOptions): Word.RepeatingSectionContentControl; /** - * Warning: hidden has been deprecated. - * @deprecated Hidden is no longer supported. - * @remarks - * [Api set: WordApi 1.1] + * 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. */ - hidden = "Hidden", + load(propertyNames?: string | string[]): Word.RepeatingSectionContentControl; /** - * Warning: dotLine has been deprecated. - * @deprecated DotLine is no longer supported. - * @remarks - * [Api set: WordApi 1.1] + * 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. */ - dotLine = "DotLine", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.RepeatingSectionContentControl; /** - * A single underline. This is the default value. - * @remarks - * [Api set: WordApi 1.1] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - single = "Single", + track(): Word.RepeatingSectionContentControl; /** - * Only underline individual words. - * @remarks - * [Api set: WordApi 1.1] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - word = "Word", + untrack(): Word.RepeatingSectionContentControl; /** - * A double underline. - * @remarks - * [Api set: WordApi 1.1] + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.RepeatingSectionContentControl` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RepeatingSectionContentControlData`) that contains shallow copies of any loaded child properties from the original object. */ - double = "Double", + toJSON(): Word.Interfaces.RepeatingSectionContentControlData; + } + /** + * Calendar types. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum CalendarType { /** - * A single thick underline. + * Western calendar type. * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - thick = "Thick", + western = "Western", /** - * A dotted underline. + * Arabic calendar type. * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dotted = "Dotted", + arabic = "Arabic", /** + * Hebrew calendar type. * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dottedHeavy = "DottedHeavy", + hebrew = "Hebrew", /** - * A single dash underline. + * Taiwan calendar type. * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dashLine = "DashLine", + taiwan = "Taiwan", /** + * Japanese calendar type. * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dashLineHeavy = "DashLineHeavy", + japan = "Japan", /** + * Thai calendar type. * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dashLineLong = "DashLineLong", + thai = "Thai", /** + * Korean calendar type. * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dashLineLongHeavy = "DashLineLongHeavy", + korean = "Korean", /** - * An alternating dot-dash underline. + * Saka Era calendar type. * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dotDashLine = "DotDashLine", + sakaEra = "SakaEra", /** + * Transliterated English calendar type. * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dotDashLineHeavy = "DotDashLineHeavy", + translitEnglish = "TranslitEnglish", /** - * An alternating dot-dot-dash underline. + * Transliterated French calendar type. * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - twoDotDashLine = "TwoDotDashLine", + translitFrench = "TranslitFrench", /** + * Umm al-Qura calendar type. * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - twoDotDashLineHeavy = "TwoDotDashLineHeavy", + umalqura = "Umalqura", + } + /** + * Date storage formats for {@link Word.DatePickerContentControl}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ContentControlDateStorageFormat { /** - * A single wavy underline. + * Stores the date as text. * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - wave = "Wave", + text = "Text", /** + * Stores the date as a date object. * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - waveHeavy = "WaveHeavy", + date = "Date", /** + * Stores the date as a date-time object. * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - waveDouble = "WaveDouble", + dateTime = "DateTime", } /** - * Specifies the form of a break. + * Represents a frame. The `Frame` object is a member of the {@link Word.FrameCollection} object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum BreakType { + class Frame 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; /** - * Page break at the insertion point. + * Returns a `BorderUniversalCollection` object that represents all the borders for the frame. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - page = "Page", + readonly borders: Word.BorderUniversalCollection; /** - * Warning: next has been deprecated. Use sectionNext instead. - * @deprecated Use sectionNext instead. + * Returns a `Range` object that represents the portion of the document that's contained within the frame. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - next = "Next", + readonly range: Word.Range; /** - * Section break on next page. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - sectionNext = "SectionNext", + readonly shading: Word.ShadingUniversal; /** - * New section without a corresponding page break. + * Specifies the height (in points) of the frame. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - sectionContinuous = "SectionContinuous", + height: number; /** - * Section break with the next section beginning on the next even-numbered page. If the section break falls on an even-numbered page, Word leaves the next odd-numbered page blank. + * Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - sectionEven = "SectionEven", + heightRule: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; /** - * Section break with the next section beginning on the next odd-numbered page. If the section break falls on an odd-numbered page, Word leaves the next even-numbered page blank. + * Specifies the horizontal distance between the frame and the surrounding text, in points. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - sectionOdd = "SectionOdd", + horizontalDistanceFromText: number; /** - * Line break. + * Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - line = "Line", - } - /** - * The insertion location types. - * - * @remarks - * [Api set: WordApi 1.1] - * - * To be used with an API call, such as `obj.insertSomething(newStuff, location);`. - * If the location is "Before" or "After", the new content will be outside of the modified object. - * If the location is "Start" or "End", the new content will be included as part of the modified object. - */ - enum InsertLocation { + horizontalPosition: number; /** - * Add content before the contents of the calling object. + * Specifies if the frame is locked. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - before = "Before", + lockAnchor: boolean; /** - * Add content after the contents of the calling object. + * Specifies the relative horizontal position of the frame. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - after = "After", + relativeHorizontalPosition: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; /** - * Prepend content to the contents of the calling object. + * Specifies the relative vertical position of the frame. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - start = "Start", + relativeVerticalPosition: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Append content to the contents of the calling object. + * Specifies if document text wraps around the frame. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - end = "End", + textWrap: boolean; /** - * Replace the contents of the current object. + * Specifies the vertical distance (in points) between the frame and the surrounding text. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - replace = "Replace", - } - /** - * @remarks - * [Api set: WordApi 1.1] - */ - enum Alignment { + verticalDistanceFromText: number; /** + * Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - mixed = "Mixed", + verticalPosition: number; /** - * Unknown alignment. + * Specifies the width (in points) of the frame. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - unknown = "Unknown", + width: number; /** - * Alignment to the left. + * Specifies the rule used to determine the width of the frame. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - left = "Left", + widthRule: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; /** - * Alignment to the center. - * @remarks - * [Api set: WordApi 1.1] + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - centered = "Centered", + set(properties: Interfaces.FrameUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Frame): void; /** - * Alignment to the right. + * Copies the frame to the Clipboard. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - right = "Right", + copy(): void; /** - * Fully justified alignment. + * Removes the frame from the document and places it on the Clipboard. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - justified = "Justified", - } - /** - * @remarks - * [Api set: WordApi 1.1] - */ - enum HeaderFooterType { + cut(): void; /** - * Returns the header or footer on all pages of a section, but excludes the first page or even pages if they are different. + * Deletes the frame. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - primary = "Primary", + delete(): void; /** - * Returns the header or footer on the first page of a section. + * Selects the frame. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - firstPage = "FirstPage", + select(): void; /** - * Returns all headers or footers on even-numbered pages of a section. - * @remarks - * [Api set: WordApi 1.1] + * 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. */ - evenPages = "EvenPages", + load(options?: Word.Interfaces.FrameLoadOptions): Word.Frame; + /** + * 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[]): Word.Frame; + /** + * 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; + }): Word.Frame; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.Frame; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.Frame; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Frame` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FrameData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.FrameData; } /** - * Represents the types of body objects. + * Represents the collection of {@link Word.Frame} objects. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum BodyType { - /** - * Unknown body type. - * @remarks - * [Api set: WordApi 1.3] - */ - unknown = "Unknown", + class FrameCollection 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: Word.Frame[]; /** - * Main document body. + * Returns a `Frame` object that represents a new frame added to a range, selection, or document. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param range The range where the frame will be added. + * @returns A `Frame` object that represents the new frame. */ - mainDoc = "MainDoc", + add(range: Word.Range): Word.Frame; /** - * Section body. + * Deletes the `FrameCollection` object. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - section = "Section", + delete(): void; /** - * Header body. + * Gets a `Frame` object by its index in the collection. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index The location of a `Frame` object. */ - header = "Header", + getItem(index: number): Word.Frame; /** - * Footer body. - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - footer = "Footer", + load(options?: Word.Interfaces.FrameCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.FrameCollection; /** - * Table cell body. - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - tableCell = "TableCell", + load(propertyNames?: string | string[]): Word.FrameCollection; /** - * Footnote body. - * @remarks - * [Api set: WordApi 1.5] + * 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. */ - footnote = "Footnote", + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.FrameCollection; /** - * Endnote body. - * @remarks - * [Api set: WordApi 1.5] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - endnote = "Endnote", + track(): Word.FrameCollection; /** - * Note body e.g., endnote, footnote. - * @remarks - * [Api set: WordApi 1.5] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - noteItem = "NoteItem", + untrack(): Word.FrameCollection; /** - * Shape body. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.FrameCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FrameCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - shape = "Shape", + toJSON(): Word.Interfaces.FrameCollectionData; } /** - * This enum sets where the cursor (insertion point) in the document is after a selection. + * Represents a document library version. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum SelectionMode { + class DocumentLibraryVersion 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 entire range is selected. + * Gets any optional comments associated with this version of the shared document. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - select = "Select", + readonly comments: string; /** - * The cursor is at the beginning of the selection (just before the start of the selected range). + * Gets the date and time at which this version of the shared document was last saved to the server. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - start = "Start", + readonly modified: any; /** - * The cursor is at the end of the selection (just after the end of the selected range). + * Gets the name of the user who last saved this version of the shared document to the server. + * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - end = "End", + readonly modifiedBy: 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?: Word.Interfaces.DocumentLibraryVersionLoadOptions): Word.DocumentLibraryVersion; + /** + * 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[]): Word.DocumentLibraryVersion; + /** + * 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; + }): Word.DocumentLibraryVersion; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.DocumentLibraryVersion; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.DocumentLibraryVersion; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.DocumentLibraryVersion` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentLibraryVersionData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.DocumentLibraryVersionData; } /** + * Represents the collection of {@link Word.DocumentLibraryVersion} objects. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum ImageFormat { + class DocumentLibraryVersionCollection 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: Word.DocumentLibraryVersion[]; /** + * Gets a `DocumentLibraryVersion` object by its index in the collection. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index The location of a `DocumentLibraryVersion` object. */ - unsupported = "Unsupported", + getItem(index: number): Word.DocumentLibraryVersion; /** + * Returns whether the document library in which the active document is saved on the server is configured to create a backup copy, or version, each time the file is edited on the website. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - undefined = "Undefined", + isVersioningEnabled(): OfficeExtension.ClientResult; /** - * @remarks - * [Api set: WordApiDesktop 1.1] + * 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. */ - bmp = "Bmp", + load(options?: Word.Interfaces.DocumentLibraryVersionCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.DocumentLibraryVersionCollection; /** - * @remarks - * [Api set: WordApiDesktop 1.1] + * 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. */ - jpeg = "Jpeg", + load(propertyNames?: string | string[]): Word.DocumentLibraryVersionCollection; /** - * @remarks - * [Api set: WordApiDesktop 1.1] + * 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. */ - gif = "Gif", + load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.DocumentLibraryVersionCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.DocumentLibraryVersionCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.DocumentLibraryVersionCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.DocumentLibraryVersionCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DocumentLibraryVersionCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.DocumentLibraryVersionCollectionData; + } + /** + * Represents the possible change tracking modes. + * + * @remarks + * [Api set: WordApi 1.4] + */ + enum ChangeTrackingMode { /** + * ChangeTracking is turned off. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - tiff = "Tiff", + off = "Off", /** + * ChangeTracking is turned on for everyone. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - png = "Png", + trackAll = "TrackAll", /** + * Tracking is turned on for my changes only. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - icon = "Icon", + trackMineOnly = "TrackMineOnly", + } + /** + * Specify the current version or the original version of the text. + * + * @remarks + * [Api set: WordApi 1.4] + */ + enum ChangeTrackingVersion { /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - exif = "Exif", + original = "Original", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - wmf = "Wmf", + current = "Current", + } + /** + * Specify the track state when ChangeTracking is on. + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum ChangeTrackingState { /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - emf = "Emf", + unknown = "Unknown", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - pict = "Pict", + normal = "Normal", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - pdf = "Pdf", + added = "Added", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - svg = "Svg", + deleted = "Deleted", } /** - * Represents the location of a range. You can get range by calling getRange on different objects such as {@link Word.Paragraph} and {@link Word.ContentControl}. + * TrackedChange type. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - enum RangeLocation { + enum TrackedChangeType { /** - * The object's whole range. If the object is a paragraph content control or table content control, the EOP or Table characters after the content control are also included. + * No revision. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - whole = "Whole", + none = "None", /** - * The starting point of the object. For content control, it's the point after the opening tag. + * Add change. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - start = "Start", + added = "Added", /** - * The ending point of the object. For paragraph, it's the point before the EOP (end of paragraph). For content control, it's the point before the closing tag. + * Delete change. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - end = "End", + deleted = "Deleted", /** - * For content control only. It's the point before the opening tag. + * Format change. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - before = "Before", + formatted = "Formatted", + } + /** + * Note item type + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum NoteItemType { /** - * The point after the object. If the object is a paragraph content control or table content control, it's the point after the EOP or Table characters. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - after = "After", + footnote = "Footnote", /** - * The range between 'Start' and 'End'. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - content = "Content", + endnote = "Endnote", } /** + * Provides information about the type of a raised event. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - enum LocationRelation { + enum EventType { /** - * Indicates that this instance and the range are in different sub-documents. + * ContentControlDeleted represents the event that the content control has been deleted. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - unrelated = "Unrelated", + contentControlDeleted = "ContentControlDeleted", /** - * Indicates that this instance and the range represent the same range. + * ContentControlSelectionChanged represents the event that the selection in the content control has been changed. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - equal = "Equal", + contentControlSelectionChanged = "ContentControlSelectionChanged", /** - * Indicates that this instance contains the range and that it shares the same start character. The range doesn't share the same end character as this instance. + * ContentControlDataChanged represents the event that the data in the content control have been changed. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - containsStart = "ContainsStart", + contentControlDataChanged = "ContentControlDataChanged", /** - * Indicates that this instance contains the range and that it shares the same end character. The range doesn't share the same start character as this instance. + * ContentControlAdded represents the event a content control has been added to the document. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - containsEnd = "ContainsEnd", + contentControlAdded = "ContentControlAdded", /** - * Indicates that this instance contains the range, with the exception of the start and end character of this instance. + * Represents that one or more comments were deleted. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - contains = "Contains", + commentDeleted = "CommentDeleted", /** - * Indicates that this instance is inside the range and that it shares the same start character. The range doesn't share the same end character as this instance. + * Represents that a comment was selected. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - insideStart = "InsideStart", + commentSelected = "CommentSelected", /** - * Indicates that this instance is inside the range and that it shares the same end character. The range doesn't share the same start character as this instance. + * Represents that a comment was deselected. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - insideEnd = "InsideEnd", + commentDeselected = "CommentDeselected", /** - * Indicates that this instance is inside the range. The range doesn't share the same start and end characters as this instance. + * Represents that a comment or its reply was changed. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - inside = "Inside", + commentChanged = "CommentChanged", /** - * Indicates that this instance occurs before, and is adjacent to, the range. + * Represents that one or more new comments were added. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - adjacentBefore = "AdjacentBefore", + commentAdded = "CommentAdded", /** - * Indicates that this instance starts before the range and overlaps the range's first character. + * Represents that a content control has been entered. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - overlapsBefore = "OverlapsBefore", + contentControlEntered = "ContentControlEntered", /** - * Indicates that this instance occurs before the range. + * Represents that a content control has been exited. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - before = "Before", + contentControlExited = "ContentControlExited", /** - * Indicates that this instance occurs after, and is adjacent to, the range. + * Represents that one or more new paragraphs were added. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - adjacentAfter = "AdjacentAfter", + paragraphAdded = "ParagraphAdded", /** - * Indicates that this instance starts inside the range and overlaps the range’s last character. + * Represents that one or more paragraphs were changed. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - overlapsAfter = "OverlapsAfter", + paragraphChanged = "ParagraphChanged", /** - * Indicates that this instance occurs after the range. + * Represents that one or more paragraphs were deleted. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - after = "After", - } - /** - * @remarks - * [Api set: WordApi 1.3] - */ - enum BorderLocation { - /** - * @remarks - * [Api set: WordApi 1.3] - */ - top = "Top", - /** - * @remarks - * [Api set: WordApi 1.3] - */ - left = "Left", + paragraphDeleted = "ParagraphDeleted", /** + * Represents that an annotation was clicked (or selected with **Alt+Down**) in the document. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.7] */ - bottom = "Bottom", + annotationClicked = "AnnotationClicked", /** + * Represents that an annotation was hovered over in the document. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.7] */ - right = "Right", + annotationHovered = "AnnotationHovered", /** + * Represents that one or more annotations were added in the document. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.7] */ - insideHorizontal = "InsideHorizontal", + annotationInserted = "AnnotationInserted", /** + * Represents that one or more annotations were deleted from the document. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.7] */ - insideVertical = "InsideVertical", + annotationRemoved = "AnnotationRemoved", /** + * Represents an action in the annotation pop-up. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.8] */ - inside = "Inside", + annotationPopupAction = "AnnotationPopupAction", + } + /** + * An enum that specifies an event's source. It can be local or remote (through coauthoring). + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum EventSource { /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - outside = "Outside", + local = "Local", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - all = "All", + remote = "Remote", } /** + * Provides information about the content control that raised contentControlAdded event. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - enum CellPaddingLocation { - /** - * @remarks - * [Api set: WordApi 1.3] - */ - top = "Top", + interface ContentControlAddedEventArgs { /** + * The event type. See Word.EventType for details. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - left = "Left", + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** + * Gets the content control IDs. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - bottom = "Bottom", + ids: number[]; /** + * The source of the event. It can be local or remote (through coauthoring). + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - right = "Right", + source: Word.EventSource | "Local" | "Remote"; } /** - * Represents the width of a style's border. + * Provides information about the content control that raised contentControlDataChanged event. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - enum BorderWidth { - /** - * None width. - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - none = "None", - /** - * 0.25 point. - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - pt025 = "Pt025", + interface ContentControlDataChangedEventArgs { /** - * 0.50 point. + * The event type. See Word.EventType for details. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - pt050 = "Pt050", + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** - * 0.75 point. + * Gets the content control IDs. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - pt075 = "Pt075", + ids: number[]; /** - * 1.00 point. This is the default. + * The source of the event. It can be local or remote (through coauthoring). + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - pt100 = "Pt100", + source: Word.EventSource | "Local" | "Remote"; + } + /** + * Provides information about the content control that raised contentControlDeleted event. + * + * @remarks + * [Api set: WordApi 1.5] + */ + interface ContentControlDeletedEventArgs { /** - * 1.50 points. + * The event type. See Word.EventType for details. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - pt150 = "Pt150", + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** - * 2.25 points. + * Gets the content control IDs. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - pt225 = "Pt225", + ids: number[]; /** - * 3.00 points. + * The source of the event. It can be local or remote (through coauthoring). + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - pt300 = "Pt300", + source: Word.EventSource | "Local" | "Remote"; + } + /** + * Provides information about the content control that raised contentControlEntered event. + * + * @remarks + * [Api set: WordApi 1.5] + */ + interface ContentControlEnteredEventArgs { /** - * 4.50 points. + * The event type. See Word.EventType for details. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - pt450 = "Pt450", + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** - * 6.00 points. + * Gets the content control IDs. + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - pt600 = "Pt600", + ids: number[]; /** - * Mixed width. + * The source of the event. It can be local or remote (through coauthoring). + * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - mixed = "Mixed", + source: Word.EventSource | "Local" | "Remote"; } /** + * Provides information about the content control that raised contentControlExited event. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - enum BorderType { + interface ContentControlExitedEventArgs { /** + * The event type. See Word.EventType for details. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - mixed = "Mixed", + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** + * Gets the content control IDs. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - none = "None", + ids: number[]; /** + * The source of the event. It can be local or remote (through coauthoring). + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - single = "Single", + source: Word.EventSource | "Local" | "Remote"; + } + /** + * Represents a dropped capital letter in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class DropCap 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 distance (in points) between the dropped capital letter and the paragraph text. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - double = "Double", + readonly distanceFromText: number; /** + * Gets the name of the font for the dropped capital letter. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dotted = "Dotted", + readonly fontName: string; /** + * Gets the height (in lines) of the dropped capital letter. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dashed = "Dashed", + readonly linesToDrop: number; /** + * Gets the position of the dropped capital letter. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dotDashed = "DotDashed", + readonly position: Word.DropPosition | "None" | "Normal" | "Margin"; /** + * Removes the dropped capital letter formatting. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dot2Dashed = "Dot2Dashed", + clear(): void; /** + * Formats the first character in the specified paragraph as a dropped capital letter. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - triple = "Triple", + enable(): void; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - thinThickSmall = "ThinThickSmall", + load(options?: Word.Interfaces.DropCapLoadOptions): Word.DropCap; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - thickThinSmall = "ThickThinSmall", + load(propertyNames?: string | string[]): Word.DropCap; /** - * @remarks - * [Api set: WordApi 1.3] + * 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. */ - thinThickThinSmall = "ThinThickThinSmall", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.DropCap; /** - * @remarks - * [Api set: WordApi 1.3] + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - thinThickMed = "ThinThickMed", + track(): Word.DropCap; /** - * @remarks - * [Api set: WordApi 1.3] + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - thickThinMed = "ThickThinMed", + untrack(): Word.DropCap; /** - * @remarks - * [Api set: WordApi 1.3] + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.DropCap` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.DropCapData`) that contains shallow copies of any loaded child properties from the original object. */ - thinThickThinMed = "ThinThickThinMed", + toJSON(): Word.Interfaces.DropCapData; + } + /** + * Provides information about the content control that raised contentControlSelectionChanged event. + * + * @remarks + * [Api set: WordApi 1.5] + */ + interface ContentControlSelectionChangedEventArgs { /** + * The event type. See Word.EventType for details. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - thinThickLarge = "ThinThickLarge", + eventType: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** + * Gets the content control IDs. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - thickThinLarge = "ThickThinLarge", + ids: number[]; /** + * The source of the event. It can be local or remote (through coauthoring). + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - thinThickThinLarge = "ThinThickThinLarge", + source: Word.EventSource | "Local" | "Remote"; + } + /** + * Provides information about the paragraphs that raised the paragraphAdded event. + * + * @remarks + * [Api set: WordApi 1.6] + */ + interface ParagraphAddedEventArgs { /** + * The source of the event. It can be local or remote (through coauthoring). + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - wave = "Wave", + source: Word.EventSource | "Local" | "Remote"; /** + * The event type. See Word.EventType for details. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - doubleWave = "DoubleWave", + type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** + * Gets the unique IDs of the involved paragraphs. IDs are in standard 8-4-4-4-12 GUID format without curly braces and differ across sessions and coauthors. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - dashedSmall = "DashedSmall", + uniqueLocalIds: string[]; + } + /** + * Provides information about the paragraphs that raised the paragraphChanged event. + * + * @remarks + * [Api set: WordApi 1.6] + */ + interface ParagraphChangedEventArgs { /** + * The source of the event. It can be local or remote (through coauthoring). + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - dashDotStroked = "DashDotStroked", + source: Word.EventSource | "Local" | "Remote"; /** + * The event type. See Word.EventType for details. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - threeDEmboss = "ThreeDEmboss", + type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** + * Gets the unique IDs of the involved paragraphs. IDs are in standard 8-4-4-4-12 GUID format without curly braces and differ across sessions and coauthors. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - threeDEngrave = "ThreeDEngrave", + uniqueLocalIds: string[]; } /** + * Provides information about the paragraphs that raised the paragraphDeleted event. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - enum VerticalAlignment { - /** - * @remarks - * [Api set: WordApi 1.3] - */ - mixed = "Mixed", + interface ParagraphDeletedEventArgs { /** + * The source of the event. It can be local or remote (through coauthoring). + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - top = "Top", + source: Word.EventSource | "Local" | "Remote"; /** + * The event type. See Word.EventType for details. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - center = "Center", + type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; /** + * Gets the unique IDs of the involved paragraphs. IDs are in standard 8-4-4-4-12 GUID format without curly braces and differ across sessions and coauthors. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - bottom = "Bottom", + uniqueLocalIds: string[]; } /** - * Represents the type of baseline alignment. + * Provides information about the comments that raised the comment event. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum BaselineAlignment { - /** - * Represents top baseline alignment. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - top = "Top", + interface CommentEventArgs { /** - * Represents center baseline alignment. + * Represents how the comment changed event is triggered. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - center = "Center", + changeType: Word.CommentChangeType | "none" | "edited" | "resolved" | "reopened" | "replyAdded" | "replyDeleted" | "replyEdited"; /** - * Represents baseline alignment. + * Gets the CommentDetail array which contains the IDs and reply IDs of the involved comments. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - baseline = "Baseline", + commentDetails: Word.CommentDetail[]; /** - * Represents Far East 50% baseline alignment. + * The source of the event. It can be local or remote (through coauthoring). + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - farEast50 = "FarEast50", + source: Word.EventSource | "Local" | "Remote"; /** - * Represents automatic baseline alignment. + * The event type. See Word.EventType for details. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - auto = "Auto", + type: Word.EventType | "ContentControlDeleted" | "ContentControlSelectionChanged" | "ContentControlDataChanged" | "ContentControlAdded" | "CommentDeleted" | "CommentSelected" | "CommentDeselected" | "CommentChanged" | "CommentAdded" | "ContentControlEntered" | "ContentControlExited" | "ParagraphAdded" | "ParagraphChanged" | "ParagraphDeleted" | "AnnotationClicked" | "AnnotationHovered" | "AnnotationInserted" | "AnnotationRemoved" | "AnnotationPopupAction"; } /** + * A structure for the ID and reply IDs of this comment. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum ListLevelType { - /** - * @remarks - * [Api set: WordApi 1.3] - */ - bullet = "Bullet", + interface CommentDetail { /** + * Represents the ID of this comment. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - number = "Number", + id: string; /** + * Represents the IDs of the replies to this comment. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - picture = "Picture", + replyIds: string[]; } /** + * Represents how the comments in the event were changed. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum ListBullet { + enum CommentChangeType { /** + * No comment changed event is triggered. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - custom = "Custom", + none = "none", /** + * A comment was edited. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - solid = "Solid", + edited = "edited", /** + * A comment was resolved. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - hollow = "Hollow", + resolved = "resolved", /** + * A comment was reopened. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - square = "Square", + reopened = "reopened", /** + * A reply was added. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - diamonds = "Diamonds", + replyAdded = "replyAdded", /** + * A reply was deleted. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - arrow = "Arrow", + replyDeleted = "replyDeleted", /** + * A reply was edited. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - checkmark = "Checkmark", + replyEdited = "replyEdited", } /** + * Specifies supported content control types and subtypes. + * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - enum ListNumbering { + enum ContentControlType { /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - none = "None", + unknown = "Unknown", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - arabic = "Arabic", + richTextInline = "RichTextInline", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - upperRoman = "UpperRoman", + richTextParagraphs = "RichTextParagraphs", /** + * Contains a whole cell. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - lowerRoman = "LowerRoman", + richTextTableCell = "RichTextTableCell", /** + * Contains a whole row. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - upperLetter = "UpperLetter", + richTextTableRow = "RichTextTableRow", /** + * Contains a whole table. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - lowerLetter = "LowerLetter", - } - /** - * Represents the built-in style in a Word document. - * - * @remarks - * [Api set: WordApi 1.3] - * - * Important: This enum was renamed from `Style` to `BuiltInStyleName` in WordApi 1.5. - */ - enum BuiltInStyleName { + richTextTable = "RichTextTable", /** - * Mixed styles or other style not in this list. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - other = "Other", + plainTextInline = "PlainTextInline", /** - * Reset character and paragraph style to default. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - normal = "Normal", + plainTextParagraph = "PlainTextParagraph", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - heading1 = "Heading1", + picture = "Picture", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - heading2 = "Heading2", + buildingBlockGallery = "BuildingBlockGallery", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - heading3 = "Heading3", + checkBox = "CheckBox", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - heading4 = "Heading4", + comboBox = "ComboBox", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - heading5 = "Heading5", + dropDownList = "DropDownList", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - heading6 = "Heading6", + datePicker = "DatePicker", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - heading7 = "Heading7", + repeatingSection = "RepeatingSection", /** + * Identifies a rich text content control. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - heading8 = "Heading8", + richText = "RichText", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - heading9 = "Heading9", + plainText = "PlainText", /** - * Table-of-content level 1. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - toc1 = "Toc1", + group = "Group", + } + /** + * ContentControl appearance. + * + * @remarks + * [Api set: WordApi 1.1] + * + * Content control appearance options are BoundingBox, Tags, or Hidden. + */ + enum ContentControlAppearance { /** - * Table-of-content level 2. + * Represents a content control shown as a shaded rectangle or bounding box (with optional title). * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - toc2 = "Toc2", + boundingBox = "BoundingBox", /** - * Table-of-content level 3. + * Represents a content control shown as start and end markers. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - toc3 = "Toc3", + tags = "Tags", /** - * Table-of-content level 4. + * Represents a content control that isn't shown. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - toc4 = "Toc4", + hidden = "Hidden", + } + /** + * Content control level types. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ContentControlLevel { /** - * Table-of-content level 5. + * Represents an inline content control. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toc5 = "Toc5", + inline = "Inline", /** - * Table-of-content level 6. + * Represents a paragraph-level content control. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toc6 = "Toc6", + paragraph = "Paragraph", /** - * Table-of-content level 7. + * Represents a row-level content control. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toc7 = "Toc7", + row = "Row", /** - * Table-of-content level 8. + * Represents a cell-level content control. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toc8 = "Toc8", + cell = "Cell", + } + /** + * Represents the state of the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ContentControlState { /** - * Table-of-content level 9. + * Error state. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toc9 = "Toc9", + error = "Error", /** + * Warning state. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - footnoteText = "FootnoteText", + warning = "Warning", + } + /** + * The supported styles for underline format. + * + * @remarks + * [Api set: WordApi 1.1] + */ + enum UnderlineType { /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - header = "Header", + mixed = "Mixed", /** + * No underline. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - footer = "Footer", + none = "None", /** + * Warning: hidden has been deprecated. + * @deprecated Hidden is no longer supported. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - caption = "Caption", + hidden = "Hidden", /** + * Warning: dotLine has been deprecated. + * @deprecated DotLine is no longer supported. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - footnoteReference = "FootnoteReference", + dotLine = "DotLine", /** + * A single underline. This is the default value. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - endnoteReference = "EndnoteReference", + single = "Single", /** + * Only underline individual words. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - endnoteText = "EndnoteText", + word = "Word", /** + * A double underline. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - title = "Title", + double = "Double", /** + * A single thick underline. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - subtitle = "Subtitle", + thick = "Thick", /** + * A dotted underline. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - hyperlink = "Hyperlink", + dotted = "Dotted", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - strong = "Strong", + dottedHeavy = "DottedHeavy", /** + * A single dash underline. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - emphasis = "Emphasis", + dashLine = "DashLine", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - noSpacing = "NoSpacing", + dashLineHeavy = "DashLineHeavy", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - listParagraph = "ListParagraph", + dashLineLong = "DashLineLong", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - quote = "Quote", + dashLineLongHeavy = "DashLineLongHeavy", /** + * An alternating dot-dash underline. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - intenseQuote = "IntenseQuote", + dotDashLine = "DotDashLine", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - subtleEmphasis = "SubtleEmphasis", + dotDashLineHeavy = "DotDashLineHeavy", /** + * An alternating dot-dot-dash underline. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - intenseEmphasis = "IntenseEmphasis", + twoDotDashLine = "TwoDotDashLine", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - subtleReference = "SubtleReference", + twoDotDashLineHeavy = "TwoDotDashLineHeavy", /** + * A single wavy underline. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - intenseReference = "IntenseReference", + wave = "Wave", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - bookTitle = "BookTitle", + waveHeavy = "WaveHeavy", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - bibliography = "Bibliography", + waveDouble = "WaveDouble", + } + /** + * Specifies the form of a break. + * + * @remarks + * [Api set: WordApi 1.1] + */ + enum BreakType { /** - * Table-of-content heading. + * Page break at the insertion point. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - tocHeading = "TocHeading", + page = "Page", /** + * Warning: next has been deprecated. Use sectionNext instead. + * @deprecated Use sectionNext instead. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - tableGrid = "TableGrid", + next = "Next", /** + * Section break on next page. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - plainTable1 = "PlainTable1", + sectionNext = "SectionNext", /** + * New section without a corresponding page break. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - plainTable2 = "PlainTable2", + sectionContinuous = "SectionContinuous", /** + * Section break with the next section beginning on the next even-numbered page. If the section break falls on an even-numbered page, Word leaves the next odd-numbered page blank. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - plainTable3 = "PlainTable3", + sectionEven = "SectionEven", /** + * Section break with the next section beginning on the next odd-numbered page. If the section break falls on an odd-numbered page, Word leaves the next even-numbered page blank. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - plainTable4 = "PlainTable4", + sectionOdd = "SectionOdd", /** + * Line break. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - plainTable5 = "PlainTable5", + line = "Line", + } + /** + * The insertion location types. + * + * @remarks + * [Api set: WordApi 1.1] + * + * To be used with an API call, such as `obj.insertSomething(newStuff, location);`. + * If the location is "Before" or "After", the new content will be outside of the modified object. + * If the location is "Start" or "End", the new content will be included as part of the modified object. + */ + enum InsertLocation { /** + * Add content before the contents of the calling object. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - tableGridLight = "TableGridLight", + before = "Before", /** + * Add content after the contents of the calling object. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable1Light = "GridTable1Light", + after = "After", /** + * Prepend content to the contents of the calling object. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable1Light_Accent1 = "GridTable1Light_Accent1", + start = "Start", /** + * Append content to the contents of the calling object. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable1Light_Accent2 = "GridTable1Light_Accent2", + end = "End", /** + * Replace the contents of the current object. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable1Light_Accent3 = "GridTable1Light_Accent3", + replace = "Replace", + } + /** + * @remarks + * [Api set: WordApi 1.1] + */ + enum Alignment { /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable1Light_Accent4 = "GridTable1Light_Accent4", + mixed = "Mixed", /** + * Unknown alignment. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable1Light_Accent5 = "GridTable1Light_Accent5", + unknown = "Unknown", /** + * Alignment to the left. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable1Light_Accent6 = "GridTable1Light_Accent6", + left = "Left", /** + * Alignment to the center. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable2 = "GridTable2", + centered = "Centered", /** + * Alignment to the right. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable2_Accent1 = "GridTable2_Accent1", + right = "Right", /** + * Fully justified alignment. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable2_Accent2 = "GridTable2_Accent2", + justified = "Justified", + } + /** + * @remarks + * [Api set: WordApi 1.1] + */ + enum HeaderFooterType { /** + * Returns the header or footer on all pages of a section, but excludes the first page or even pages if they are different. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable2_Accent3 = "GridTable2_Accent3", + primary = "Primary", /** + * Returns the header or footer on the first page of a section. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable2_Accent4 = "GridTable2_Accent4", + firstPage = "FirstPage", /** + * Returns all headers or footers on even-numbered pages of a section. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable2_Accent5 = "GridTable2_Accent5", + evenPages = "EvenPages", + } + /** + * Represents the types of body objects. + * + * @remarks + * [Api set: WordApi 1.3] + */ + enum BodyType { /** + * Unknown body type. * @remarks * [Api set: WordApi 1.3] */ - gridTable2_Accent6 = "GridTable2_Accent6", + unknown = "Unknown", /** + * Main document body. * @remarks * [Api set: WordApi 1.3] */ - gridTable3 = "GridTable3", + mainDoc = "MainDoc", /** + * Section body. * @remarks * [Api set: WordApi 1.3] */ - gridTable3_Accent1 = "GridTable3_Accent1", + section = "Section", /** + * Header body. * @remarks * [Api set: WordApi 1.3] */ - gridTable3_Accent2 = "GridTable3_Accent2", + header = "Header", /** + * Footer body. * @remarks * [Api set: WordApi 1.3] */ - gridTable3_Accent3 = "GridTable3_Accent3", + footer = "Footer", /** + * Table cell body. * @remarks * [Api set: WordApi 1.3] */ - gridTable3_Accent4 = "GridTable3_Accent4", + tableCell = "TableCell", /** + * Footnote body. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - gridTable3_Accent5 = "GridTable3_Accent5", + footnote = "Footnote", /** + * Endnote body. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - gridTable3_Accent6 = "GridTable3_Accent6", + endnote = "Endnote", /** + * Note body e.g., endnote, footnote. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - gridTable4 = "GridTable4", + noteItem = "NoteItem", /** + * Shape body. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - gridTable4_Accent1 = "GridTable4_Accent1", + shape = "Shape", + } + /** + * This enum sets where the cursor (insertion point) in the document is after a selection. + * + * @remarks + * [Api set: WordApi 1.1] + */ + enum SelectionMode { /** + * The entire range is selected. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable4_Accent2 = "GridTable4_Accent2", + select = "Select", /** + * The cursor is at the beginning of the selection (just before the start of the selected range). * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable4_Accent3 = "GridTable4_Accent3", + start = "Start", /** + * The cursor is at the end of the selection (just after the end of the selected range). * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - gridTable4_Accent4 = "GridTable4_Accent4", + end = "End", + } + /** + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + enum ImageFormat { /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - gridTable4_Accent5 = "GridTable4_Accent5", + unsupported = "Unsupported", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - gridTable4_Accent6 = "GridTable4_Accent6", + undefined = "Undefined", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - gridTable5Dark = "GridTable5Dark", + bmp = "Bmp", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - gridTable5Dark_Accent1 = "GridTable5Dark_Accent1", + jpeg = "Jpeg", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - gridTable5Dark_Accent2 = "GridTable5Dark_Accent2", + gif = "Gif", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - gridTable5Dark_Accent3 = "GridTable5Dark_Accent3", + tiff = "Tiff", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - gridTable5Dark_Accent4 = "GridTable5Dark_Accent4", + png = "Png", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - gridTable5Dark_Accent5 = "GridTable5Dark_Accent5", + icon = "Icon", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - gridTable5Dark_Accent6 = "GridTable5Dark_Accent6", + exif = "Exif", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - gridTable6Colorful = "GridTable6Colorful", + wmf = "Wmf", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - gridTable6Colorful_Accent1 = "GridTable6Colorful_Accent1", + emf = "Emf", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - gridTable6Colorful_Accent2 = "GridTable6Colorful_Accent2", + pict = "Pict", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - gridTable6Colorful_Accent3 = "GridTable6Colorful_Accent3", + pdf = "Pdf", /** * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - gridTable6Colorful_Accent4 = "GridTable6Colorful_Accent4", + svg = "Svg", + } + /** + * Represents the location of a range. You can get range by calling getRange on different objects such as {@link Word.Paragraph} and {@link Word.ContentControl}. + * + * @remarks + * [Api set: WordApi 1.3] + */ + enum RangeLocation { /** + * The object's whole range. If the object is a paragraph content control or table content control, the EOP or Table characters after the content control are also included. * @remarks * [Api set: WordApi 1.3] */ - gridTable6Colorful_Accent5 = "GridTable6Colorful_Accent5", + whole = "Whole", /** + * The starting point of the object. For content control, it's the point after the opening tag. * @remarks * [Api set: WordApi 1.3] */ - gridTable6Colorful_Accent6 = "GridTable6Colorful_Accent6", + start = "Start", /** + * The ending point of the object. For paragraph, it's the point before the EOP (end of paragraph). For content control, it's the point before the closing tag. * @remarks * [Api set: WordApi 1.3] */ - gridTable7Colorful = "GridTable7Colorful", + end = "End", /** + * For content control only. It's the point before the opening tag. * @remarks * [Api set: WordApi 1.3] */ - gridTable7Colorful_Accent1 = "GridTable7Colorful_Accent1", + before = "Before", /** + * The point after the object. If the object is a paragraph content control or table content control, it's the point after the EOP or Table characters. * @remarks * [Api set: WordApi 1.3] */ - gridTable7Colorful_Accent2 = "GridTable7Colorful_Accent2", + after = "After", /** + * The range between 'Start' and 'End'. * @remarks * [Api set: WordApi 1.3] */ - gridTable7Colorful_Accent3 = "GridTable7Colorful_Accent3", + content = "Content", + } + /** + * @remarks + * [Api set: WordApi 1.3] + */ + enum LocationRelation { /** + * Indicates that this instance and the range are in different sub-documents. * @remarks * [Api set: WordApi 1.3] */ - gridTable7Colorful_Accent4 = "GridTable7Colorful_Accent4", + unrelated = "Unrelated", /** + * Indicates that this instance and the range represent the same range. * @remarks * [Api set: WordApi 1.3] */ - gridTable7Colorful_Accent5 = "GridTable7Colorful_Accent5", + equal = "Equal", /** + * Indicates that this instance contains the range and that it shares the same start character. The range doesn't share the same end character as this instance. * @remarks * [Api set: WordApi 1.3] */ - gridTable7Colorful_Accent6 = "GridTable7Colorful_Accent6", + containsStart = "ContainsStart", /** + * Indicates that this instance contains the range and that it shares the same end character. The range doesn't share the same start character as this instance. * @remarks * [Api set: WordApi 1.3] */ - listTable1Light = "ListTable1Light", + containsEnd = "ContainsEnd", /** + * Indicates that this instance contains the range, with the exception of the start and end character of this instance. * @remarks * [Api set: WordApi 1.3] */ - listTable1Light_Accent1 = "ListTable1Light_Accent1", + contains = "Contains", /** + * Indicates that this instance is inside the range and that it shares the same start character. The range doesn't share the same end character as this instance. * @remarks * [Api set: WordApi 1.3] */ - listTable1Light_Accent2 = "ListTable1Light_Accent2", + insideStart = "InsideStart", /** + * Indicates that this instance is inside the range and that it shares the same end character. The range doesn't share the same start character as this instance. * @remarks * [Api set: WordApi 1.3] */ - listTable1Light_Accent3 = "ListTable1Light_Accent3", + insideEnd = "InsideEnd", /** + * Indicates that this instance is inside the range. The range doesn't share the same start and end characters as this instance. * @remarks * [Api set: WordApi 1.3] */ - listTable1Light_Accent4 = "ListTable1Light_Accent4", + inside = "Inside", /** + * Indicates that this instance occurs before, and is adjacent to, the range. * @remarks * [Api set: WordApi 1.3] */ - listTable1Light_Accent5 = "ListTable1Light_Accent5", + adjacentBefore = "AdjacentBefore", /** + * Indicates that this instance starts before the range and overlaps the range's first character. * @remarks * [Api set: WordApi 1.3] */ - listTable1Light_Accent6 = "ListTable1Light_Accent6", + overlapsBefore = "OverlapsBefore", /** + * Indicates that this instance occurs before the range. * @remarks * [Api set: WordApi 1.3] */ - listTable2 = "ListTable2", + before = "Before", /** + * Indicates that this instance occurs after, and is adjacent to, the range. * @remarks * [Api set: WordApi 1.3] */ - listTable2_Accent1 = "ListTable2_Accent1", + adjacentAfter = "AdjacentAfter", /** + * Indicates that this instance starts inside the range and overlaps the range’s last character. * @remarks * [Api set: WordApi 1.3] */ - listTable2_Accent2 = "ListTable2_Accent2", + overlapsAfter = "OverlapsAfter", /** + * Indicates that this instance occurs after the range. * @remarks * [Api set: WordApi 1.3] */ - listTable2_Accent3 = "ListTable2_Accent3", + after = "After", + } + /** + * @remarks + * [Api set: WordApi 1.3] + */ + enum BorderLocation { /** * @remarks * [Api set: WordApi 1.3] */ - listTable2_Accent4 = "ListTable2_Accent4", + top = "Top", /** * @remarks * [Api set: WordApi 1.3] */ - listTable2_Accent5 = "ListTable2_Accent5", + left = "Left", /** * @remarks * [Api set: WordApi 1.3] */ - listTable2_Accent6 = "ListTable2_Accent6", + bottom = "Bottom", /** * @remarks * [Api set: WordApi 1.3] */ - listTable3 = "ListTable3", + right = "Right", /** * @remarks * [Api set: WordApi 1.3] */ - listTable3_Accent1 = "ListTable3_Accent1", + insideHorizontal = "InsideHorizontal", /** * @remarks * [Api set: WordApi 1.3] */ - listTable3_Accent2 = "ListTable3_Accent2", + insideVertical = "InsideVertical", /** * @remarks * [Api set: WordApi 1.3] */ - listTable3_Accent3 = "ListTable3_Accent3", + inside = "Inside", /** * @remarks * [Api set: WordApi 1.3] */ - listTable3_Accent4 = "ListTable3_Accent4", + outside = "Outside", /** * @remarks * [Api set: WordApi 1.3] */ - listTable3_Accent5 = "ListTable3_Accent5", + all = "All", + } + /** + * @remarks + * [Api set: WordApi 1.3] + */ + enum CellPaddingLocation { /** * @remarks * [Api set: WordApi 1.3] */ - listTable3_Accent6 = "ListTable3_Accent6", + top = "Top", /** * @remarks * [Api set: WordApi 1.3] */ - listTable4 = "ListTable4", + left = "Left", /** * @remarks * [Api set: WordApi 1.3] */ - listTable4_Accent1 = "ListTable4_Accent1", + bottom = "Bottom", /** * @remarks * [Api set: WordApi 1.3] */ - listTable4_Accent2 = "ListTable4_Accent2", + right = "Right", + } + /** + * Represents the width of a style's border. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + enum BorderWidth { /** + * None width. * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - listTable4_Accent3 = "ListTable4_Accent3", + none = "None", + /** + * 0.25 point. + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + pt025 = "Pt025", + /** + * 0.50 point. + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + pt050 = "Pt050", + /** + * 0.75 point. + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + pt075 = "Pt075", + /** + * 1.00 point. This is the default. + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + pt100 = "Pt100", + /** + * 1.50 points. + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + pt150 = "Pt150", + /** + * 2.25 points. + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + pt225 = "Pt225", + /** + * 3.00 points. + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + pt300 = "Pt300", + /** + * 4.50 points. + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + pt450 = "Pt450", + /** + * 6.00 points. + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + pt600 = "Pt600", + /** + * Mixed width. + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + mixed = "Mixed", + } + /** + * @remarks + * [Api set: WordApi 1.3] + */ + enum BorderType { /** * @remarks * [Api set: WordApi 1.3] */ - listTable4_Accent4 = "ListTable4_Accent4", + mixed = "Mixed", /** * @remarks * [Api set: WordApi 1.3] */ - listTable4_Accent5 = "ListTable4_Accent5", + none = "None", /** * @remarks * [Api set: WordApi 1.3] */ - listTable4_Accent6 = "ListTable4_Accent6", + single = "Single", /** * @remarks * [Api set: WordApi 1.3] */ - listTable5Dark = "ListTable5Dark", + double = "Double", /** * @remarks * [Api set: WordApi 1.3] */ - listTable5Dark_Accent1 = "ListTable5Dark_Accent1", + dotted = "Dotted", /** * @remarks * [Api set: WordApi 1.3] */ - listTable5Dark_Accent2 = "ListTable5Dark_Accent2", + dashed = "Dashed", /** * @remarks * [Api set: WordApi 1.3] */ - listTable5Dark_Accent3 = "ListTable5Dark_Accent3", + dotDashed = "DotDashed", /** * @remarks * [Api set: WordApi 1.3] */ - listTable5Dark_Accent4 = "ListTable5Dark_Accent4", + dot2Dashed = "Dot2Dashed", /** * @remarks * [Api set: WordApi 1.3] */ - listTable5Dark_Accent5 = "ListTable5Dark_Accent5", + triple = "Triple", /** * @remarks * [Api set: WordApi 1.3] */ - listTable5Dark_Accent6 = "ListTable5Dark_Accent6", + thinThickSmall = "ThinThickSmall", /** * @remarks * [Api set: WordApi 1.3] */ - listTable6Colorful = "ListTable6Colorful", + thickThinSmall = "ThickThinSmall", /** * @remarks * [Api set: WordApi 1.3] */ - listTable6Colorful_Accent1 = "ListTable6Colorful_Accent1", + thinThickThinSmall = "ThinThickThinSmall", /** * @remarks * [Api set: WordApi 1.3] */ - listTable6Colorful_Accent2 = "ListTable6Colorful_Accent2", + thinThickMed = "ThinThickMed", /** * @remarks * [Api set: WordApi 1.3] */ - listTable6Colorful_Accent3 = "ListTable6Colorful_Accent3", + thickThinMed = "ThickThinMed", /** * @remarks * [Api set: WordApi 1.3] */ - listTable6Colorful_Accent4 = "ListTable6Colorful_Accent4", + thinThickThinMed = "ThinThickThinMed", /** * @remarks * [Api set: WordApi 1.3] */ - listTable6Colorful_Accent5 = "ListTable6Colorful_Accent5", + thinThickLarge = "ThinThickLarge", /** * @remarks * [Api set: WordApi 1.3] */ - listTable6Colorful_Accent6 = "ListTable6Colorful_Accent6", + thickThinLarge = "ThickThinLarge", /** * @remarks * [Api set: WordApi 1.3] */ - listTable7Colorful = "ListTable7Colorful", + thinThickThinLarge = "ThinThickThinLarge", /** * @remarks * [Api set: WordApi 1.3] */ - listTable7Colorful_Accent1 = "ListTable7Colorful_Accent1", + wave = "Wave", /** * @remarks * [Api set: WordApi 1.3] */ - listTable7Colorful_Accent2 = "ListTable7Colorful_Accent2", + doubleWave = "DoubleWave", /** * @remarks * [Api set: WordApi 1.3] */ - listTable7Colorful_Accent3 = "ListTable7Colorful_Accent3", + dashedSmall = "DashedSmall", /** * @remarks * [Api set: WordApi 1.3] */ - listTable7Colorful_Accent4 = "ListTable7Colorful_Accent4", + dashDotStroked = "DashDotStroked", /** * @remarks * [Api set: WordApi 1.3] */ - listTable7Colorful_Accent5 = "ListTable7Colorful_Accent5", + threeDEmboss = "ThreeDEmboss", /** * @remarks * [Api set: WordApi 1.3] */ - listTable7Colorful_Accent6 = "ListTable7Colorful_Accent6", + threeDEngrave = "ThreeDEngrave", } /** * @remarks * [Api set: WordApi 1.3] */ - enum DocumentPropertyType { + enum VerticalAlignment { /** * @remarks * [Api set: WordApi 1.3] */ - string = "String", + mixed = "Mixed", /** * @remarks * [Api set: WordApi 1.3] */ - number = "Number", + top = "Top", /** * @remarks * [Api set: WordApi 1.3] */ - date = "Date", + center = "Center", /** * @remarks * [Api set: WordApi 1.3] */ - boolean = "Boolean", + bottom = "Bottom", } /** - * Represents the type of style. + * Represents the type of baseline alignment. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - enum StyleType { + enum BaselineAlignment { /** - * Represents that the style is a character style. + * Represents top baseline alignment. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - character = "Character", + top = "Top", /** - * Represents that the style is a list style. Currently supported on desktop. + * Represents center baseline alignment. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - list = "List", + center = "Center", /** - * Represents that the style is a paragraph style. + * Represents baseline alignment. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - paragraph = "Paragraph", + baseline = "Baseline", /** - * Represents that the style is a table style. + * Represents Far East 50% baseline alignment. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - table = "Table", + farEast50 = "FarEast50", + /** + * Represents automatic baseline alignment. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + auto = "Auto", } /** - * Represents the outline levels. - * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - enum OutlineLevel { + enum ListLevelType { /** - * Represents outline level 1. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - outlineLevel1 = "OutlineLevel1", + bullet = "Bullet", /** - * Represents outline level 2. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - outlineLevel2 = "OutlineLevel2", + number = "Number", /** - * Represents outline level 3. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - outlineLevel3 = "OutlineLevel3", + picture = "Picture", + } + /** + * @remarks + * [Api set: WordApi 1.3] + */ + enum ListBullet { /** - * Represents outline level 4. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - outlineLevel4 = "OutlineLevel4", + custom = "Custom", /** - * Represents outline level 5. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - outlineLevel5 = "OutlineLevel5", + solid = "Solid", /** - * Represents outline level 6. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - outlineLevel6 = "OutlineLevel6", + hollow = "Hollow", /** - * Represents outline level 7. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - outlineLevel7 = "OutlineLevel7", + square = "Square", /** - * Represents outline level 8. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - outlineLevel8 = "OutlineLevel8", + diamonds = "Diamonds", /** - * Represents outline level 9. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - outlineLevel9 = "OutlineLevel9", + arrow = "Arrow", /** - * Represents outline level body text, not an outline level. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - outlineLevelBodyText = "OutlineLevelBodyText", + checkmark = "Checkmark", } /** - * Specifies the close behavior for `Document.close`. - * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - enum CloseBehavior { + enum ListNumbering { /** - * Saves the changes before closing the document. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - save = "Save", + none = "None", /** - * Discard the possible changes when closing the document. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - skipSave = "SkipSave", - } - /** - * Specifies the save behavior for `Document.save`. - * - * @remarks - * [Api set: WordApi 1.1] - */ - enum SaveBehavior { + arabic = "Arabic", /** - * Saves the document without prompting the user. If it's a new document, - it will be saved with the default name or specified name in the default location. * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - save = "Save", + upperRoman = "UpperRoman", /** - * Displays the "Save As" dialog to the user if the document hasn't been saved. - Won't take effect if the document was previously saved. * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - prompt = "Prompt", + lowerRoman = "LowerRoman", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + upperLetter = "UpperLetter", + /** + * @remarks + * [Api set: WordApi 1.3] + */ + lowerLetter = "LowerLetter", } /** - * Represents the type of Field. + * Represents the built-in style in a Word document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] + * + * Important: This enum was renamed from `Style` to `BuiltInStyleName` in WordApi 1.5. */ - enum FieldType { + enum BuiltInStyleName { /** - * Represents that the field type is Add-in. + * Mixed styles or other style not in this list. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - addin = "Addin", + other = "Other", /** - * Represents that the field type is AddressBlock. + * Reset character and paragraph style to default. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - addressBlock = "AddressBlock", + normal = "Normal", /** - * Represents that the field type is Advance. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - advance = "Advance", + heading1 = "Heading1", /** - * Represents that the field type is Ask. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - ask = "Ask", + heading2 = "Heading2", /** - * Represents that the field type is Author. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - author = "Author", + heading3 = "Heading3", /** - * Represents that the field type is AutoText. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - autoText = "AutoText", + heading4 = "Heading4", /** - * Represents that the field type is AutoTextList. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - autoTextList = "AutoTextList", + heading5 = "Heading5", /** - * Represents that the field type is Barcode. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - barCode = "BarCode", + heading6 = "Heading6", /** - * Represents that the field type is Bibliography. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - bibliography = "Bibliography", + heading7 = "Heading7", /** - * Represents that the field type is BidiOutline. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - bidiOutline = "BidiOutline", + heading8 = "Heading8", /** - * Represents that the field type is Citation. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - citation = "Citation", + heading9 = "Heading9", /** - * Represents that the field type is Comments. + * Table-of-content level 1. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - comments = "Comments", + toc1 = "Toc1", /** - * Represents that the field type is Compare. + * Table-of-content level 2. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - compare = "Compare", + toc2 = "Toc2", /** - * Represents that the field type is CreateDate. + * Table-of-content level 3. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - createDate = "CreateDate", + toc3 = "Toc3", /** - * Represents that the field type is Data. + * Table-of-content level 4. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - data = "Data", + toc4 = "Toc4", /** - * Represents that the field type is Database. + * Table-of-content level 5. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - database = "Database", + toc5 = "Toc5", /** - * Represents that the field type is Date. + * Table-of-content level 6. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - date = "Date", + toc6 = "Toc6", /** - * Represents that the field type is DisplayBarcode. + * Table-of-content level 7. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - displayBarcode = "DisplayBarcode", + toc7 = "Toc7", /** - * Represents that the field type is DocumentProperty + * Table-of-content level 8. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - docProperty = "DocProperty", + toc8 = "Toc8", /** - * Represents that the field type is DocumentVariable. + * Table-of-content level 9. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - docVariable = "DocVariable", + toc9 = "Toc9", /** - * Represents that the field type is EditTime. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - editTime = "EditTime", + footnoteText = "FootnoteText", /** - * Represents that the field type is Embedded. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - embedded = "Embedded", + header = "Header", /** - * Represents that the field type is Equation. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - eq = "EQ", + footer = "Footer", /** - * Represents that the field type is Expression. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - expression = "Expression", + caption = "Caption", /** - * Represents that the field type is FileName. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - fileName = "FileName", + footnoteReference = "FootnoteReference", /** - * Represents that the field type is FileSize. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - fileSize = "FileSize", + endnoteReference = "EndnoteReference", /** - * Represents that the field type is FillIn. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - fillIn = "FillIn", + endnoteText = "EndnoteText", /** - * Represents that the field type is FormCheckbox. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - formCheckbox = "FormCheckbox", + title = "Title", /** - * Represents that the field type is FormDropdown. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - formDropdown = "FormDropdown", + subtitle = "Subtitle", /** - * Represents that the field type is FormText. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - formText = "FormText", + hyperlink = "Hyperlink", /** - * Represents that the field type is GotoButton. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - gotoButton = "GotoButton", + strong = "Strong", /** - * Represents that the field type is GreetingLine. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - greetingLine = "GreetingLine", + emphasis = "Emphasis", /** - * Represents that the field type is Hyperlink. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - hyperlink = "Hyperlink", + noSpacing = "NoSpacing", /** - * Represents that the field type is If. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - if = "If", + listParagraph = "ListParagraph", /** - * Represents that the field type is Import. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - import = "Import", + quote = "Quote", /** - * Represents that the field type is Include. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - include = "Include", + intenseQuote = "IntenseQuote", /** - * Represents that the field type is IncludePicture. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - includePicture = "IncludePicture", + subtleEmphasis = "SubtleEmphasis", /** - * Represents that the field type is IncludeText. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - includeText = "IncludeText", + intenseEmphasis = "IntenseEmphasis", /** - * Represents that the field type is Index. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - index = "Index", + subtleReference = "SubtleReference", /** - * Represents that the field type is Information. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - info = "Info", + intenseReference = "IntenseReference", /** - * Represents that the field type is Keywords. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - keywords = "Keywords", + bookTitle = "BookTitle", /** - * Represents that the field type is LastSavedBy. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - lastSavedBy = "LastSavedBy", + bibliography = "Bibliography", /** - * Represents that the field type is Link. + * Table-of-content heading. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - link = "Link", + tocHeading = "TocHeading", /** - * Represents that the field type is ListNumber. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - listNum = "ListNum", + tableGrid = "TableGrid", /** - * Represents that the field type is MacroButton. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - macroButton = "MacroButton", + plainTable1 = "PlainTable1", /** - * Represents that the field type is MergeBarcode. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - mergeBarcode = "MergeBarcode", + plainTable2 = "PlainTable2", /** - * Represents that the field type is MergeField. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - mergeField = "MergeField", + plainTable3 = "PlainTable3", /** - * Represents that the field type is MergeRecord. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - mergeRec = "MergeRec", + plainTable4 = "PlainTable4", /** - * Represents that the field type is MergeSequence. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - mergeSeq = "MergeSeq", + plainTable5 = "PlainTable5", /** - * Represents that the field type is Next. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - next = "Next", + tableGridLight = "TableGridLight", /** - * Represents that the field type is NextIf. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - nextIf = "NextIf", + gridTable1Light = "GridTable1Light", /** - * Represents that the field type is NoteReference. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - noteRef = "NoteRef", + gridTable1Light_Accent1 = "GridTable1Light_Accent1", /** - * Represents that the field type is NumberOfCharacters. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - numChars = "NumChars", + gridTable1Light_Accent2 = "GridTable1Light_Accent2", /** - * Represents that the field type is NumberOfPages. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - numPages = "NumPages", + gridTable1Light_Accent3 = "GridTable1Light_Accent3", /** - * Represents that the field type is NumberOfWords. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - numWords = "NumWords", + gridTable1Light_Accent4 = "GridTable1Light_Accent4", /** - * Represents that the field type is ActiveXControl. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - ocx = "OCX", + gridTable1Light_Accent5 = "GridTable1Light_Accent5", /** - * Represents that the field type is Page. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - page = "Page", + gridTable1Light_Accent6 = "GridTable1Light_Accent6", /** - * Represents that the field type is PageReference. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - pageRef = "PageRef", + gridTable2 = "GridTable2", /** - * Represents that the field type is Print. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - print = "Print", + gridTable2_Accent1 = "GridTable2_Accent1", /** - * Represents that the field type is PrintDate. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - printDate = "PrintDate", + gridTable2_Accent2 = "GridTable2_Accent2", /** - * Represents that the field type is Private. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - private = "Private", + gridTable2_Accent3 = "GridTable2_Accent3", /** - * Represents that the field type is Quote. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - quote = "Quote", + gridTable2_Accent4 = "GridTable2_Accent4", /** - * Represents that the field type is ReferencedDocument. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - rd = "RD", + gridTable2_Accent5 = "GridTable2_Accent5", /** - * Represents that the field type is Reference. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - ref = "Ref", + gridTable2_Accent6 = "GridTable2_Accent6", /** - * Represents that the field type is RevisionNumber. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - revNum = "RevNum", + gridTable3 = "GridTable3", /** - * Represents that the field type is SaveDate. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - saveDate = "SaveDate", + gridTable3_Accent1 = "GridTable3_Accent1", /** - * Represents that the field type is Section. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - section = "Section", + gridTable3_Accent2 = "GridTable3_Accent2", /** - * Represents that the field type is SectionPages. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - sectionPages = "SectionPages", + gridTable3_Accent3 = "GridTable3_Accent3", /** - * Represents that the field type is Sequence. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - seq = "Seq", + gridTable3_Accent4 = "GridTable3_Accent4", /** - * Represents that the field type is Set. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - set = "Set", + gridTable3_Accent5 = "GridTable3_Accent5", /** - * Represents that the field type is Shape. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - shape = "Shape", + gridTable3_Accent6 = "GridTable3_Accent6", /** - * Represents that the field type is SkipIf. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - skipIf = "SkipIf", + gridTable4 = "GridTable4", /** - * Represents that the field type is StyleReference. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - styleRef = "StyleRef", + gridTable4_Accent1 = "GridTable4_Accent1", /** - * Represents that the field type is Subject. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - subject = "Subject", + gridTable4_Accent2 = "GridTable4_Accent2", /** - * Represents that the field type is Subscriber. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - subscriber = "Subscriber", + gridTable4_Accent3 = "GridTable4_Accent3", /** - * Represents that the field type is Symbol. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - symbol = "Symbol", + gridTable4_Accent4 = "GridTable4_Accent4", /** - * Represents that the field type is TableOfAuthoritiesEntry. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - ta = "TA", + gridTable4_Accent5 = "GridTable4_Accent5", /** - * Represents that the field type is TableOfContentsEntry. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - tc = "TC", + gridTable4_Accent6 = "GridTable4_Accent6", /** - * Represents that the field type is Template. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - template = "Template", + gridTable5Dark = "GridTable5Dark", /** - * Represents that the field type is Time. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - time = "Time", + gridTable5Dark_Accent1 = "GridTable5Dark_Accent1", /** - * Represents that the field type is Title. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - title = "Title", + gridTable5Dark_Accent2 = "GridTable5Dark_Accent2", /** - * Represents that the field type is TableOfAuthorities. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - toa = "TOA", + gridTable5Dark_Accent3 = "GridTable5Dark_Accent3", /** - * Represents that the field type is TableOfContents. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - toc = "TOC", + gridTable5Dark_Accent4 = "GridTable5Dark_Accent4", /** - * Represents that the field type is UserAddress. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - userAddress = "UserAddress", + gridTable5Dark_Accent5 = "GridTable5Dark_Accent5", /** - * Represents that the field type is UserInitials. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - userInitials = "UserInitials", + gridTable5Dark_Accent6 = "GridTable5Dark_Accent6", /** - * Represents that the field type is UserName. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - userName = "UserName", + gridTable6Colorful = "GridTable6Colorful", /** - * Represents that the field type is IndexEntry. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - xe = "XE", + gridTable6Colorful_Accent1 = "GridTable6Colorful_Accent1", /** - * Represents that the field type is Empty. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - empty = "Empty", + gridTable6Colorful_Accent2 = "GridTable6Colorful_Accent2", /** - * Represents the field types not supported by the Office JavaScript API. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - others = "Others", + gridTable6Colorful_Accent3 = "GridTable6Colorful_Accent3", /** - * Represents that the field type is Undefined. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - undefined = "Undefined", - } - /** - * Represents the kind of field. Indicates how the field works in relation to updating. - * - * @remarks - * [Api set: WordApi 1.5] - */ - enum FieldKind { + gridTable6Colorful_Accent4 = "GridTable6Colorful_Accent4", /** - * Represents that the field is invalid. For example, a pair of field characters with nothing inside. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - none = "None", + gridTable6Colorful_Accent5 = "GridTable6Colorful_Accent5", /** - * Represents that the field is automatically updated each time it's displayed or each time the page is reformatted, but which can also be manually updated. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - hot = "Hot", + gridTable6Colorful_Accent6 = "GridTable6Colorful_Accent6", /** - * Represents that the field is automatically updated when the source changes or the field can be manually updated. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - warm = "Warm", + gridTable7Colorful = "GridTable7Colorful", /** - * Represents that the field doesn't have a result. * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - cold = "Cold", - } - /** - * Represents the character inserted after the list item mark. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - enum TrailingCharacter { + gridTable7Colorful_Accent1 = "GridTable7Colorful_Accent1", /** - * A tab is inserted. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - trailingTab = "TrailingTab", + gridTable7Colorful_Accent2 = "GridTable7Colorful_Accent2", /** - * A space is inserted. Default. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - trailingSpace = "TrailingSpace", + gridTable7Colorful_Accent3 = "GridTable7Colorful_Accent3", /** - * No character is inserted. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - trailingNone = "TrailingNone", - } - /** - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - enum ListBuiltInNumberStyle { + gridTable7Colorful_Accent4 = "GridTable7Colorful_Accent4", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - none = "None", + gridTable7Colorful_Accent5 = "GridTable7Colorful_Accent5", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - arabic = "Arabic", + gridTable7Colorful_Accent6 = "GridTable7Colorful_Accent6", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - upperRoman = "UpperRoman", + listTable1Light = "ListTable1Light", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - lowerRoman = "LowerRoman", + listTable1Light_Accent1 = "ListTable1Light_Accent1", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - upperLetter = "UpperLetter", + listTable1Light_Accent2 = "ListTable1Light_Accent2", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - lowerLetter = "LowerLetter", + listTable1Light_Accent3 = "ListTable1Light_Accent3", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - ordinal = "Ordinal", + listTable1Light_Accent4 = "ListTable1Light_Accent4", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - cardinalText = "CardinalText", + listTable1Light_Accent5 = "ListTable1Light_Accent5", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - ordinalText = "OrdinalText", + listTable1Light_Accent6 = "ListTable1Light_Accent6", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - kanji = "Kanji", + listTable2 = "ListTable2", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - kanjiDigit = "KanjiDigit", + listTable2_Accent1 = "ListTable2_Accent1", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - aiueoHalfWidth = "AiueoHalfWidth", + listTable2_Accent2 = "ListTable2_Accent2", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - irohaHalfWidth = "IrohaHalfWidth", + listTable2_Accent3 = "ListTable2_Accent3", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - arabicFullWidth = "ArabicFullWidth", + listTable2_Accent4 = "ListTable2_Accent4", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - kanjiTraditional = "KanjiTraditional", + listTable2_Accent5 = "ListTable2_Accent5", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - kanjiTraditional2 = "KanjiTraditional2", + listTable2_Accent6 = "ListTable2_Accent6", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - numberInCircle = "NumberInCircle", + listTable3 = "ListTable3", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - aiueo = "Aiueo", + listTable3_Accent1 = "ListTable3_Accent1", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - iroha = "Iroha", + listTable3_Accent2 = "ListTable3_Accent2", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - arabicLZ = "ArabicLZ", + listTable3_Accent3 = "ListTable3_Accent3", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - bullet = "Bullet", + listTable3_Accent4 = "ListTable3_Accent4", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - ganada = "Ganada", + listTable3_Accent5 = "ListTable3_Accent5", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - chosung = "Chosung", + listTable3_Accent6 = "ListTable3_Accent6", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - gbnum1 = "GBNum1", + listTable4 = "ListTable4", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - gbnum2 = "GBNum2", + listTable4_Accent1 = "ListTable4_Accent1", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - gbnum3 = "GBNum3", + listTable4_Accent2 = "ListTable4_Accent2", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - gbnum4 = "GBNum4", + listTable4_Accent3 = "ListTable4_Accent3", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - zodiac1 = "Zodiac1", + listTable4_Accent4 = "ListTable4_Accent4", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - zodiac2 = "Zodiac2", + listTable4_Accent5 = "ListTable4_Accent5", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - zodiac3 = "Zodiac3", + listTable4_Accent6 = "ListTable4_Accent6", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - tradChinNum1 = "TradChinNum1", + listTable5Dark = "ListTable5Dark", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - tradChinNum2 = "TradChinNum2", + listTable5Dark_Accent1 = "ListTable5Dark_Accent1", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - tradChinNum3 = "TradChinNum3", + listTable5Dark_Accent2 = "ListTable5Dark_Accent2", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - tradChinNum4 = "TradChinNum4", + listTable5Dark_Accent3 = "ListTable5Dark_Accent3", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - simpChinNum1 = "SimpChinNum1", + listTable5Dark_Accent4 = "ListTable5Dark_Accent4", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - simpChinNum2 = "SimpChinNum2", + listTable5Dark_Accent5 = "ListTable5Dark_Accent5", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - simpChinNum3 = "SimpChinNum3", + listTable5Dark_Accent6 = "ListTable5Dark_Accent6", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - simpChinNum4 = "SimpChinNum4", + listTable6Colorful = "ListTable6Colorful", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - hanjaRead = "HanjaRead", + listTable6Colorful_Accent1 = "ListTable6Colorful_Accent1", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - hanjaReadDigit = "HanjaReadDigit", + listTable6Colorful_Accent2 = "ListTable6Colorful_Accent2", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - hangul = "Hangul", + listTable6Colorful_Accent3 = "ListTable6Colorful_Accent3", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - hanja = "Hanja", + listTable6Colorful_Accent4 = "ListTable6Colorful_Accent4", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - hebrew1 = "Hebrew1", + listTable6Colorful_Accent5 = "ListTable6Colorful_Accent5", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - arabic1 = "Arabic1", + listTable6Colorful_Accent6 = "ListTable6Colorful_Accent6", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - hebrew2 = "Hebrew2", + listTable7Colorful = "ListTable7Colorful", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - arabic2 = "Arabic2", + listTable7Colorful_Accent1 = "ListTable7Colorful_Accent1", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - hindiLetter1 = "HindiLetter1", + listTable7Colorful_Accent2 = "ListTable7Colorful_Accent2", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - hindiLetter2 = "HindiLetter2", + listTable7Colorful_Accent3 = "ListTable7Colorful_Accent3", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - hindiArabic = "HindiArabic", + listTable7Colorful_Accent4 = "ListTable7Colorful_Accent4", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - hindiCardinalText = "HindiCardinalText", + listTable7Colorful_Accent5 = "ListTable7Colorful_Accent5", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - thaiLetter = "ThaiLetter", + listTable7Colorful_Accent6 = "ListTable7Colorful_Accent6", + } + /** + * @remarks + * [Api set: WordApi 1.3] + */ + enum DocumentPropertyType { /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - thaiArabic = "ThaiArabic", + string = "String", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - thaiCardinalText = "ThaiCardinalText", + number = "Number", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - vietCardinalText = "VietCardinalText", + date = "Date", /** * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - lowercaseRussian = "LowercaseRussian", + boolean = "Boolean", + } + /** + * Represents the type of style. + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum StyleType { /** + * Represents that the style is a character style. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - uppercaseRussian = "UppercaseRussian", + character = "Character", /** + * Represents that the style is a list style. Currently supported on desktop. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - lowercaseGreek = "LowercaseGreek", + list = "List", /** + * Represents that the style is a paragraph style. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - uppercaseGreek = "UppercaseGreek", + paragraph = "Paragraph", /** + * Represents that the style is a table style. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - arabicLZ2 = "ArabicLZ2", + table = "Table", + } + /** + * Represents the outline levels. + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum OutlineLevel { /** + * Represents outline level 1. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - arabicLZ3 = "ArabicLZ3", + outlineLevel1 = "OutlineLevel1", /** + * Represents outline level 2. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - arabicLZ4 = "ArabicLZ4", + outlineLevel2 = "OutlineLevel2", /** + * Represents outline level 3. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - lowercaseTurkish = "LowercaseTurkish", + outlineLevel3 = "OutlineLevel3", /** + * Represents outline level 4. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - uppercaseTurkish = "UppercaseTurkish", + outlineLevel4 = "OutlineLevel4", /** + * Represents outline level 5. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - lowercaseBulgarian = "LowercaseBulgarian", + outlineLevel5 = "OutlineLevel5", /** + * Represents outline level 6. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - uppercaseBulgarian = "UppercaseBulgarian", + outlineLevel6 = "OutlineLevel6", /** + * Represents outline level 7. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - pictureBullet = "PictureBullet", + outlineLevel7 = "OutlineLevel7", /** + * Represents outline level 8. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - legal = "Legal", + outlineLevel8 = "OutlineLevel8", /** + * Represents outline level 9. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - legalLZ = "LegalLZ", + outlineLevel9 = "OutlineLevel9", + /** + * Represents outline level body text, not an outline level. + * @remarks + * [Api set: WordApi 1.5] + */ + outlineLevelBodyText = "OutlineLevelBodyText", } /** - * Represents the shading texture. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. + * Specifies the close behavior for `Document.close`. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - enum ShadingTextureType { + enum CloseBehavior { /** - * Represents dark diagonal-down texture. + * Saves the changes before closing the document. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - darkDiagonalDown = "DarkDiagonalDown", + save = "Save", /** - * Represents dark diagonal-up texture. + * Discard the possible changes when closing the document. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - darkDiagonalUp = "DarkDiagonalUp", + skipSave = "SkipSave", + } + /** + * Specifies the save behavior for `Document.save`. + * + * @remarks + * [Api set: WordApi 1.1] + */ + enum SaveBehavior { /** - * Represents dark horizontal-cross texture. + * Saves the document without prompting the user. If it's a new document, + it will be saved with the default name or specified name in the default location. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.1] */ - darkGrid = "DarkGrid", + save = "Save", /** - * Represents dark horizontal texture. + * Displays the "Save As" dialog to the user if the document hasn't been saved. + Won't take effect if the document was previously saved. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.1] */ - darkHorizontal = "DarkHorizontal", + prompt = "Prompt", + } + /** + * Represents the type of Field. + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum FieldType { /** - * Represents dark diagonal-cross texture. + * Represents that the field type is Add-in. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - darkTrellis = "DarkTrellis", + addin = "Addin", /** - * Represents dark vertical texture. + * Represents that the field type is AddressBlock. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - darkVertical = "DarkVertical", + addressBlock = "AddressBlock", /** - * Represents light diagonal-down texture. + * Represents that the field type is Advance. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - lightDiagonalDown = "LightDiagonalDown", + advance = "Advance", /** - * Represents light diagonal-up texture. + * Represents that the field type is Ask. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - lightDiagonalUp = "LightDiagonalUp", + ask = "Ask", /** - * Represents light horizontal-cross texture. + * Represents that the field type is Author. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - lightGrid = "LightGrid", + author = "Author", /** - * Represents light horizontal texture. + * Represents that the field type is AutoText. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - lightHorizontal = "LightHorizontal", + autoText = "AutoText", /** - * Represents light diagonal-cross texture. + * Represents that the field type is AutoTextList. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - lightTrellis = "LightTrellis", + autoTextList = "AutoTextList", /** - * Represents light vertical texture. + * Represents that the field type is Barcode. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - lightVertical = "LightVertical", + barCode = "BarCode", /** - * Represents that there's no texture. + * Represents that the field type is Bibliography. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - none = "None", + bibliography = "Bibliography", /** - * Represents 10 percent texture. + * Represents that the field type is BidiOutline. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent10 = "Percent10", + bidiOutline = "BidiOutline", /** - * Represents 12.5 percent texture. + * Represents that the field type is Citation. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent12Pt5 = "Percent12Pt5", + citation = "Citation", /** - * Represents 15 percent texture. + * Represents that the field type is Comments. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent15 = "Percent15", + comments = "Comments", /** - * Represents 20 percent texture. + * Represents that the field type is Compare. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent20 = "Percent20", + compare = "Compare", /** - * Represents 25 percent texture. + * Represents that the field type is CreateDate. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent25 = "Percent25", + createDate = "CreateDate", /** - * Represents 30 percent texture. + * Represents that the field type is Data. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent30 = "Percent30", + data = "Data", /** - * Represents 35 percent texture. + * Represents that the field type is Database. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent35 = "Percent35", + database = "Database", /** - * Represents 37.5 percent texture. + * Represents that the field type is Date. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent37Pt5 = "Percent37Pt5", + date = "Date", /** - * Represents 40 percent texture. + * Represents that the field type is DisplayBarcode. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent40 = "Percent40", + displayBarcode = "DisplayBarcode", /** - * Represents 45 percent texture. + * Represents that the field type is DocumentProperty * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent45 = "Percent45", + docProperty = "DocProperty", /** - * Represents 5 percent texture. + * Represents that the field type is DocumentVariable. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent5 = "Percent5", + docVariable = "DocVariable", /** - * Represents 50 percent texture. + * Represents that the field type is EditTime. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent50 = "Percent50", + editTime = "EditTime", /** - * Represents 55 percent texture. + * Represents that the field type is Embedded. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent55 = "Percent55", + embedded = "Embedded", /** - * Represents 60 percent texture. + * Represents that the field type is Equation. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent60 = "Percent60", + eq = "EQ", /** - * Represents 62.5 percent texture. + * Represents that the field type is Expression. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent62Pt5 = "Percent62Pt5", + expression = "Expression", /** - * Represents 65 percent texture. + * Represents that the field type is FileName. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent65 = "Percent65", + fileName = "FileName", /** - * Represents 70 percent texture. + * Represents that the field type is FileSize. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent70 = "Percent70", + fileSize = "FileSize", /** - * Represents 75 percent texture. + * Represents that the field type is FillIn. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent75 = "Percent75", + fillIn = "FillIn", /** - * Represents 80 percent texture. + * Represents that the field type is FormCheckbox. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent80 = "Percent80", + formCheckbox = "FormCheckbox", /** - * Represents 85 percent texture. + * Represents that the field type is FormDropdown. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent85 = "Percent85", + formDropdown = "FormDropdown", /** - * Represents 87.5 percent texture. + * Represents that the field type is FormText. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent87Pt5 = "Percent87Pt5", + formText = "FormText", /** - * Represents 90 percent texture. + * Represents that the field type is GotoButton. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent90 = "Percent90", + gotoButton = "GotoButton", /** - * Represents 95 percent texture. + * Represents that the field type is GreetingLine. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - percent95 = "Percent95", + greetingLine = "GreetingLine", /** - * Represents solid texture. + * Represents that the field type is Hyperlink. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - solid = "Solid", - } - /** - * Specifies the target document for displaying document comparison differences. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - enum CompareTarget { + hyperlink = "Hyperlink", /** - * Places comparison differences in the current document. + * Represents that the field type is If. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - compareTargetCurrent = "CompareTargetCurrent", + if = "If", /** - * Places comparison differences in the target document. + * Represents that the field type is Import. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - compareTargetSelected = "CompareTargetSelected", + import = "Import", /** - * Places comparison differences in a new document. + * Represents that the field type is Include. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - compareTargetNew = "CompareTargetNew", - } - /** - * Specifies how to handle any conflicts, that is, when imported styles have the same name as existing styles in the current document. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - enum ImportedStylesConflictBehavior { + include = "Include", /** - * Ignore conflicting imported styles and keep the existing version of those styles in the current document. + * Represents that the field type is IncludePicture. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - ignore = "Ignore", + includePicture = "IncludePicture", /** - * Overwrite the existing styles in the current document. + * Represents that the field type is IncludeText. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - overwrite = "Overwrite", + includeText = "IncludeText", /** - * Rename conflicting imported styles so that both versions are kept in the current document. For example, if MyStyle already exists in the document, then the imported version could be added as MyStyle1. + * Represents that the field type is Index. * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - createNew = "CreateNew", - } - /** - * Represents the shape type. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - enum ShapeType { + index = "Index", /** - * Unsupported shape type. + * Represents that the field type is Information. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - unsupported = "Unsupported", + info = "Info", /** - * Text box shape. + * Represents that the field type is Keywords. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - textBox = "TextBox", + keywords = "Keywords", /** - * Geometric shape. + * Represents that the field type is LastSavedBy. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - geometricShape = "GeometricShape", + lastSavedBy = "LastSavedBy", /** - * Group shape. + * Represents that the field type is Link. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - group = "Group", + link = "Link", /** - * Picture shape. + * Represents that the field type is ListNumber. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - picture = "Picture", + listNum = "ListNum", /** - * Canvas shape. + * Represents that the field type is MacroButton. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - canvas = "Canvas", - } - /** - * Represents what the horizontal position of a shape is relative to. - For more information about margins, see {@link https://support.microsoft.com/office/c95c1ea1-70b1-4dde-a1da-f5aa2042c829 | Change the margins in your Word document}. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - enum RelativeHorizontalPosition { + macroButton = "MacroButton", /** - * Relative to margin. + * Represents that the field type is MergeBarcode. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - margin = "Margin", + mergeBarcode = "MergeBarcode", /** - * Relative to page. + * Represents that the field type is MergeField. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - page = "Page", + mergeField = "MergeField", /** - * Relative to column. + * Represents that the field type is MergeRecord. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - column = "Column", + mergeRec = "MergeRec", /** - * Relative to character. + * Represents that the field type is MergeSequence. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - character = "Character", + mergeSeq = "MergeSeq", /** - * Relative to left margin. + * Represents that the field type is Next. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - leftMargin = "LeftMargin", + next = "Next", /** - * Relative to right margin. + * Represents that the field type is NextIf. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - rightMargin = "RightMargin", + nextIf = "NextIf", /** - * Relative to inside margin. + * Represents that the field type is NoteReference. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - insideMargin = "InsideMargin", + noteRef = "NoteRef", /** - * Relative to outside margin. + * Represents that the field type is NumberOfCharacters. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - outsideMargin = "OutsideMargin", - } - /** - * Represents what the vertical position of a shape is relative to. - For more information about margins, see {@link https://support.microsoft.com/office/c95c1ea1-70b1-4dde-a1da-f5aa2042c829 | Change the margins in your Word document}. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - enum RelativeVerticalPosition { + numChars = "NumChars", /** - * Relative to margin. + * Represents that the field type is NumberOfPages. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - margin = "Margin", + numPages = "NumPages", /** - * Relative to page. + * Represents that the field type is NumberOfWords. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - page = "Page", + numWords = "NumWords", /** - * Relative to paragraph. + * Represents that the field type is ActiveXControl. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - paragraph = "Paragraph", + ocx = "OCX", /** - * Relative to line. + * Represents that the field type is Page. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - line = "Line", + page = "Page", /** - * Relative to top margin. + * Represents that the field type is PageReference. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - topMargin = "TopMargin", + pageRef = "PageRef", /** - * Relative to bottom margin. + * Represents that the field type is Print. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - bottomMargin = "BottomMargin", + print = "Print", /** - * Relative to inside margin. + * Represents that the field type is PrintDate. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - insideMargin = "InsideMargin", + printDate = "PrintDate", /** - * Relative to outside margin. + * Represents that the field type is Private. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - outsideMargin = "OutsideMargin", - } - /** - * Represents what the horizontal or vertical size of a shape is relative to. - For more information about margins, see {@link https://support.microsoft.com/office/c95c1ea1-70b1-4dde-a1da-f5aa2042c829 | Change the margins in your Word document}. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - enum RelativeSize { + private = "Private", /** - * Relative to margin. + * Represents that the field type is Quote. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - margin = "Margin", + quote = "Quote", /** - * Relative to page. + * Represents that the field type is ReferencedDocument. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - page = "Page", + rd = "RD", /** - * Relative to top margin. + * Represents that the field type is Reference. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - topMargin = "TopMargin", + ref = "Ref", /** - * Relative to bottom margin. + * Represents that the field type is RevisionNumber. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - bottomMargin = "BottomMargin", + revNum = "RevNum", /** - * Relative to inside margin. + * Represents that the field type is SaveDate. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - insideMargin = "InsideMargin", + saveDate = "SaveDate", /** - * Relative to outside margin. + * Represents that the field type is Section. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - outsideMargin = "OutsideMargin", - } - /** - * Specifies the shape type for a `GeometricShape` object. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - enum GeometricShapeType { + section = "Section", /** - * Line inverse geometric shape. + * Represents that the field type is SectionPages. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - lineInverse = "LineInverse", + sectionPages = "SectionPages", /** - * Triangle geometric shape. + * Represents that the field type is Sequence. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - triangle = "Triangle", + seq = "Seq", /** - * Right triangle geometric shape. + * Represents that the field type is Set. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - rightTriangle = "RightTriangle", + set = "Set", /** - * Rectangle geometric shape. + * Represents that the field type is Shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - rectangle = "Rectangle", + shape = "Shape", /** - * Diamond geometric shape. + * Represents that the field type is SkipIf. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - diamond = "Diamond", + skipIf = "SkipIf", /** - * Parallelogram geometric shape. + * Represents that the field type is StyleReference. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - parallelogram = "Parallelogram", + styleRef = "StyleRef", /** - * Trapezoid geometric shape. + * Represents that the field type is Subject. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - trapezoid = "Trapezoid", + subject = "Subject", /** - * Non-isosceles trapezoid geometric shape. + * Represents that the field type is Subscriber. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - nonIsoscelesTrapezoid = "NonIsoscelesTrapezoid", + subscriber = "Subscriber", /** - * Pentagon geometric shape. + * Represents that the field type is Symbol. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - pentagon = "Pentagon", + symbol = "Symbol", /** - * Hexagon geometric shape. + * Represents that the field type is TableOfAuthoritiesEntry. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - hexagon = "Hexagon", + ta = "TA", /** - * Heptagon geometric shape. + * Represents that the field type is TableOfContentsEntry. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - heptagon = "Heptagon", + tc = "TC", /** - * Octagon geometric shape. + * Represents that the field type is Template. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - octagon = "Octagon", + template = "Template", /** - * Decagon geometric shape. + * Represents that the field type is Time. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - decagon = "Decagon", + time = "Time", /** - * Dodecagon geometric shape. + * Represents that the field type is Title. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - dodecagon = "Dodecagon", + title = "Title", /** - * Star 4-point geometric shape. + * Represents that the field type is TableOfAuthorities. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - star4 = "Star4", + toa = "TOA", /** - * Star 5-point geometric shape. + * Represents that the field type is TableOfContents. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - star5 = "Star5", + toc = "TOC", /** - * Star 6-point geometric shape. + * Represents that the field type is UserAddress. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - star6 = "Star6", + userAddress = "UserAddress", /** - * Star 7-point geometric shape. + * Represents that the field type is UserInitials. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - star7 = "Star7", + userInitials = "UserInitials", /** - * Star 8-point geometric shape. + * Represents that the field type is UserName. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - star8 = "Star8", + userName = "UserName", /** - * Star 10-point geometric shape. + * Represents that the field type is IndexEntry. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - star10 = "Star10", + xe = "XE", /** - * Star 12-point geometric shape. + * Represents that the field type is Empty. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - star12 = "Star12", + empty = "Empty", /** - * Star 16-point geometric shape. + * Represents the field types not supported by the Office JavaScript API. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - star16 = "Star16", + others = "Others", /** - * Star 24-point geometric shape. + * Represents that the field type is Undefined. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - star24 = "Star24", + undefined = "Undefined", + } + /** + * Represents the kind of field. Indicates how the field works in relation to updating. + * + * @remarks + * [Api set: WordApi 1.5] + */ + enum FieldKind { /** - * Star 32-point geometric shape. + * Represents that the field is invalid. For example, a pair of field characters with nothing inside. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - star32 = "Star32", + none = "None", /** - * Round rectangle geometric shape. + * Represents that the field is automatically updated each time it's displayed or each time the page is reformatted, but which can also be manually updated. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - roundRectangle = "RoundRectangle", + hot = "Hot", /** - * Round one rectangle geometric shape. + * Represents that the field is automatically updated when the source changes or the field can be manually updated. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - round1Rectangle = "Round1Rectangle", + warm = "Warm", /** - * Round two same rectangle geometric shape. + * Represents that the field doesn't have a result. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - round2SameRectangle = "Round2SameRectangle", + cold = "Cold", + } + /** + * Represents the character inserted after the list item mark. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + enum TrailingCharacter { /** - * Round two diagonal rectangle geometric shape. + * A tab is inserted. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - round2DiagonalRectangle = "Round2DiagonalRectangle", + trailingTab = "TrailingTab", /** - * Snip round rectangle geometric shape. + * A space is inserted. Default. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - snipRoundRectangle = "SnipRoundRectangle", + trailingSpace = "TrailingSpace", /** - * Snip one rectangle geometric shape. + * No character is inserted. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - snip1Rectangle = "Snip1Rectangle", + trailingNone = "TrailingNone", + } + /** + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + enum ListBuiltInNumberStyle { /** - * Snip two same rectangle geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - snip2SameRectangle = "Snip2SameRectangle", + none = "None", /** - * Snip two diagonal rectangle geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - snip2DiagonalRectangle = "Snip2DiagonalRectangle", + arabic = "Arabic", /** - * Plaque geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - plaque = "Plaque", + upperRoman = "UpperRoman", /** - * Ellipse geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - ellipse = "Ellipse", + lowerRoman = "LowerRoman", /** - * Teardrop geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - teardrop = "Teardrop", + upperLetter = "UpperLetter", /** - * Home plate geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - homePlate = "HomePlate", + lowerLetter = "LowerLetter", /** - * Chevron geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - chevron = "Chevron", + ordinal = "Ordinal", /** - * Pie wedge geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - pieWedge = "PieWedge", + cardinalText = "CardinalText", /** - * Pie geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - pie = "Pie", + ordinalText = "OrdinalText", /** - * Block arc geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - blockArc = "BlockArc", + kanji = "Kanji", /** - * Donut geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - donut = "Donut", + kanjiDigit = "KanjiDigit", /** - * No smoking geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - noSmoking = "NoSmoking", + aiueoHalfWidth = "AiueoHalfWidth", /** - * Right arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - rightArrow = "RightArrow", + irohaHalfWidth = "IrohaHalfWidth", /** - * Left arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - leftArrow = "LeftArrow", + arabicFullWidth = "ArabicFullWidth", /** - * Up arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - upArrow = "UpArrow", + kanjiTraditional = "KanjiTraditional", /** - * Down arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - downArrow = "DownArrow", + kanjiTraditional2 = "KanjiTraditional2", /** - * Striped right arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - stripedRightArrow = "StripedRightArrow", + numberInCircle = "NumberInCircle", /** - * Notched right arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - notchedRightArrow = "NotchedRightArrow", + aiueo = "Aiueo", /** - * Bent up arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - bentUpArrow = "BentUpArrow", + iroha = "Iroha", /** - * Left-right arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - leftRightArrow = "LeftRightArrow", + arabicLZ = "ArabicLZ", /** - * Up-down arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - upDownArrow = "UpDownArrow", + bullet = "Bullet", /** - * Left-up arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - leftUpArrow = "LeftUpArrow", + ganada = "Ganada", /** - * Left-right-up arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - leftRightUpArrow = "LeftRightUpArrow", + chosung = "Chosung", /** - * Quad arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - quadArrow = "QuadArrow", + gbnum1 = "GBNum1", /** - * Left arrow callout geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - leftArrowCallout = "LeftArrowCallout", + gbnum2 = "GBNum2", /** - * Right arrow callout geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - rightArrowCallout = "RightArrowCallout", + gbnum3 = "GBNum3", /** - * Up arrow callout geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - upArrowCallout = "UpArrowCallout", + gbnum4 = "GBNum4", /** - * Down arrow callout geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - downArrowCallout = "DownArrowCallout", + zodiac1 = "Zodiac1", /** - * Left-right arrow callout geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - leftRightArrowCallout = "LeftRightArrowCallout", + zodiac2 = "Zodiac2", /** - * Up-down arrow callout geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - upDownArrowCallout = "UpDownArrowCallout", + zodiac3 = "Zodiac3", /** - * Quad arrow callout geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - quadArrowCallout = "QuadArrowCallout", + tradChinNum1 = "TradChinNum1", /** - * Bent arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - bentArrow = "BentArrow", + tradChinNum2 = "TradChinNum2", /** - * U-turn arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - uturnArrow = "UturnArrow", + tradChinNum3 = "TradChinNum3", /** - * Circular arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - circularArrow = "CircularArrow", + tradChinNum4 = "TradChinNum4", /** - * Left circular arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - leftCircularArrow = "LeftCircularArrow", + simpChinNum1 = "SimpChinNum1", /** - * Left-right circular arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - leftRightCircularArrow = "LeftRightCircularArrow", + simpChinNum2 = "SimpChinNum2", /** - * Curved right arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - curvedRightArrow = "CurvedRightArrow", + simpChinNum3 = "SimpChinNum3", /** - * Curved left arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - curvedLeftArrow = "CurvedLeftArrow", + simpChinNum4 = "SimpChinNum4", /** - * Curved up arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - curvedUpArrow = "CurvedUpArrow", + hanjaRead = "HanjaRead", /** - * Curved down arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - curvedDownArrow = "CurvedDownArrow", + hanjaReadDigit = "HanjaReadDigit", /** - * Swoosh arrow geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - swooshArrow = "SwooshArrow", + hangul = "Hangul", /** - * Cube geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - cube = "Cube", + hanja = "Hanja", /** - * Can geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - can = "Can", + hebrew1 = "Hebrew1", /** - * Lightning bolt geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - lightningBolt = "LightningBolt", + arabic1 = "Arabic1", /** - * Heart geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - heart = "Heart", + hebrew2 = "Hebrew2", /** - * Sun geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - sun = "Sun", + arabic2 = "Arabic2", /** - * Moon geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - moon = "Moon", + hindiLetter1 = "HindiLetter1", /** - * Smiley face geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - smileyFace = "SmileyFace", + hindiLetter2 = "HindiLetter2", /** - * Irregular seal 1 geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - irregularSeal1 = "IrregularSeal1", + hindiArabic = "HindiArabic", /** - * Irregular seal 2 geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - irregularSeal2 = "IrregularSeal2", + hindiCardinalText = "HindiCardinalText", /** - * Folded corner geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - foldedCorner = "FoldedCorner", + thaiLetter = "ThaiLetter", /** - * Bevel geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - bevel = "Bevel", + thaiArabic = "ThaiArabic", /** - * Frame geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - frame = "Frame", + thaiCardinalText = "ThaiCardinalText", /** - * Half frame geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - halfFrame = "HalfFrame", + vietCardinalText = "VietCardinalText", /** - * Corner geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - corner = "Corner", + lowercaseRussian = "LowercaseRussian", /** - * Diagonal stripe geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - diagonalStripe = "DiagonalStripe", + uppercaseRussian = "UppercaseRussian", /** - * Chord geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - chord = "Chord", + lowercaseGreek = "LowercaseGreek", /** - * Arc geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - arc = "Arc", + uppercaseGreek = "UppercaseGreek", /** - * Left bracket geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - leftBracket = "LeftBracket", + arabicLZ2 = "ArabicLZ2", /** - * Right bracket geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - rightBracket = "RightBracket", + arabicLZ3 = "ArabicLZ3", /** - * Left brace geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - leftBrace = "LeftBrace", + arabicLZ4 = "ArabicLZ4", /** - * Right brace geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - rightBrace = "RightBrace", + lowercaseTurkish = "LowercaseTurkish", /** - * Bracket pair geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - bracketPair = "BracketPair", + uppercaseTurkish = "UppercaseTurkish", /** - * Brace pair geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - bracePair = "BracePair", + lowercaseBulgarian = "LowercaseBulgarian", /** - * Callout 1 geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - callout1 = "Callout1", + uppercaseBulgarian = "UppercaseBulgarian", /** - * Callout 2 geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - callout2 = "Callout2", + pictureBullet = "PictureBullet", /** - * Callout 3 geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - callout3 = "Callout3", + legal = "Legal", /** - * Accent callout 1 geometric shape. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - accentCallout1 = "AccentCallout1", + legalLZ = "LegalLZ", + } + /** + * Represents the shading texture. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + enum ShadingTextureType { /** - * Accent callout 2 geometric shape. + * Represents dark diagonal-down texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - accentCallout2 = "AccentCallout2", + darkDiagonalDown = "DarkDiagonalDown", /** - * Accent callout 3 geometric shape. + * Represents dark diagonal-up texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - accentCallout3 = "AccentCallout3", + darkDiagonalUp = "DarkDiagonalUp", /** - * Border callout 1 geometric shape. + * Represents dark horizontal-cross texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - borderCallout1 = "BorderCallout1", + darkGrid = "DarkGrid", /** - * Border callout 2 geometric shape. + * Represents dark horizontal texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - borderCallout2 = "BorderCallout2", + darkHorizontal = "DarkHorizontal", /** - * Border callout 3 geometric shape. + * Represents dark diagonal-cross texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - borderCallout3 = "BorderCallout3", + darkTrellis = "DarkTrellis", /** - * Accent border callout 1 geometric shape. + * Represents dark vertical texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - accentBorderCallout1 = "AccentBorderCallout1", + darkVertical = "DarkVertical", /** - * Accent border callout 2 geometric shape. + * Represents light diagonal-down texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - accentBorderCallout2 = "AccentBorderCallout2", + lightDiagonalDown = "LightDiagonalDown", /** - * Accent border callout 3 geometric shape. + * Represents light diagonal-up texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - accentBorderCallout3 = "AccentBorderCallout3", + lightDiagonalUp = "LightDiagonalUp", /** - * Wedge rectangle callout geometric shape. + * Represents light horizontal-cross texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - wedgeRectCallout = "WedgeRectCallout", + lightGrid = "LightGrid", /** - * Wedge rounded rectangle callout geometric shape. + * Represents light horizontal texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - wedgeRRectCallout = "WedgeRRectCallout", + lightHorizontal = "LightHorizontal", /** - * Wedge ellipse callout geometric shape. + * Represents light diagonal-cross texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - wedgeEllipseCallout = "WedgeEllipseCallout", + lightTrellis = "LightTrellis", /** - * Cloud callout geometric shape. + * Represents light vertical texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - cloudCallout = "CloudCallout", + lightVertical = "LightVertical", /** - * Cloud geometric shape. + * Represents that there's no texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - cloud = "Cloud", + none = "None", /** - * Ribbon geometric shape. + * Represents 10 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - ribbon = "Ribbon", + percent10 = "Percent10", /** - * Ribbon 2 geometric shape. + * Represents 12.5 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - ribbon2 = "Ribbon2", + percent12Pt5 = "Percent12Pt5", /** - * Ellipse ribbon geometric shape. + * Represents 15 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - ellipseRibbon = "EllipseRibbon", + percent15 = "Percent15", /** - * Ellipse ribbon 2 geometric shape. + * Represents 20 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - ellipseRibbon2 = "EllipseRibbon2", + percent20 = "Percent20", /** - * Left-right ribbon geometric shape. + * Represents 25 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - leftRightRibbon = "LeftRightRibbon", + percent25 = "Percent25", /** - * Vertical scroll geometric shape. + * Represents 30 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - verticalScroll = "VerticalScroll", + percent30 = "Percent30", /** - * Horizontal scroll geometric shape. + * Represents 35 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - horizontalScroll = "HorizontalScroll", + percent35 = "Percent35", /** - * Wave geometric shape. + * Represents 37.5 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - wave = "Wave", + percent37Pt5 = "Percent37Pt5", /** - * Double wave geometric shape. + * Represents 40 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - doubleWave = "DoubleWave", + percent40 = "Percent40", /** - * Plus geometric shape. + * Represents 45 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - plus = "Plus", + percent45 = "Percent45", /** - * Flow chart process geometric shape. + * Represents 5 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartProcess = "FlowChartProcess", + percent5 = "Percent5", /** - * Flow chart decision geometric shape. + * Represents 50 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartDecision = "FlowChartDecision", + percent50 = "Percent50", /** - * Flow chart input-output geometric shape. + * Represents 55 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartInputOutput = "FlowChartInputOutput", + percent55 = "Percent55", /** - * Flow chart predefined process geometric shape. + * Represents 60 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartPredefinedProcess = "FlowChartPredefinedProcess", + percent60 = "Percent60", /** - * Flow chart internal storage geometric shape. + * Represents 62.5 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartInternalStorage = "FlowChartInternalStorage", + percent62Pt5 = "Percent62Pt5", /** - * Flow chart document geometric shape. + * Represents 65 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartDocument = "FlowChartDocument", + percent65 = "Percent65", /** - * Flow chart multidocument geometric shape. + * Represents 70 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartMultidocument = "FlowChartMultidocument", + percent70 = "Percent70", /** - * Flow chart terminator geometric shape. + * Represents 75 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartTerminator = "FlowChartTerminator", + percent75 = "Percent75", /** - * Flow chart preparation geometric shape. + * Represents 80 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartPreparation = "FlowChartPreparation", + percent80 = "Percent80", /** - * Flow chart manual input geometric shape. + * Represents 85 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartManualInput = "FlowChartManualInput", + percent85 = "Percent85", /** - * Flow chart manual operation geometric shape. + * Represents 87.5 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartManualOperation = "FlowChartManualOperation", + percent87Pt5 = "Percent87Pt5", /** - * Flow chart connector geometric shape. + * Represents 90 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartConnector = "FlowChartConnector", + percent90 = "Percent90", /** - * Flow chart punched card geometric shape. + * Represents 95 percent texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartPunchedCard = "FlowChartPunchedCard", + percent95 = "Percent95", /** - * Flow chart punched tape geometric shape. + * Represents solid texture. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartPunchedTape = "FlowChartPunchedTape", + solid = "Solid", + } + /** + * Specifies the target document for displaying document comparison differences. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + enum CompareTarget { /** - * Flow chart summing junction geometric shape. + * Places comparison differences in the current document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartSummingJunction = "FlowChartSummingJunction", + compareTargetCurrent = "CompareTargetCurrent", /** - * Flow chart OR geometric shape. + * Places comparison differences in the target document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartOr = "FlowChartOr", + compareTargetSelected = "CompareTargetSelected", /** - * Flow chart collate geometric shape. + * Places comparison differences in a new document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartCollate = "FlowChartCollate", + compareTargetNew = "CompareTargetNew", + } + /** + * Specifies how to handle any conflicts, that is, when imported styles have the same name as existing styles in the current document. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + enum ImportedStylesConflictBehavior { /** - * Flow chart sort geometric shape. + * Ignore conflicting imported styles and keep the existing version of those styles in the current document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartSort = "FlowChartSort", + ignore = "Ignore", /** - * Flow chart extract geometric shape. + * Overwrite the existing styles in the current document. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartExtract = "FlowChartExtract", + overwrite = "Overwrite", /** - * Flow chart merge geometric shape. + * Rename conflicting imported styles so that both versions are kept in the current document. For example, if MyStyle already exists in the document, then the imported version could be added as MyStyle1. * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - flowChartMerge = "FlowChartMerge", + createNew = "CreateNew", + } + /** + * Represents the shape type. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum ShapeType { /** - * Flow chart offline storage geometric shape. + * Unsupported shape type. * @remarks * [Api set: WordApiDesktop 1.2] */ - flowChartOfflineStorage = "FlowChartOfflineStorage", + unsupported = "Unsupported", /** - * Flow chart online storage geometric shape. + * Text box shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - flowChartOnlineStorage = "FlowChartOnlineStorage", + textBox = "TextBox", /** - * Flow chart magnetic tape geometric shape. + * Geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - flowChartMagneticTape = "FlowChartMagneticTape", + geometricShape = "GeometricShape", /** - * Flow chart magnetic disk geometric shape. + * Group shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - flowChartMagneticDisk = "FlowChartMagneticDisk", + group = "Group", /** - * Flow chart magnetic drum geometric shape. + * Picture shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - flowChartMagneticDrum = "FlowChartMagneticDrum", + picture = "Picture", /** - * Flow chart display geometric shape. + * Canvas shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - flowChartDisplay = "FlowChartDisplay", + canvas = "Canvas", + } + /** + * Represents what the horizontal position of a shape is relative to. + For more information about margins, see {@link https://support.microsoft.com/office/c95c1ea1-70b1-4dde-a1da-f5aa2042c829 | Change the margins in your Word document}. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum RelativeHorizontalPosition { /** - * Flow chart delay geometric shape. + * Relative to margin. * @remarks * [Api set: WordApiDesktop 1.2] */ - flowChartDelay = "FlowChartDelay", + margin = "Margin", /** - * Flow chart alternate process geometric shape. + * Relative to page. * @remarks * [Api set: WordApiDesktop 1.2] */ - flowChartAlternateProcess = "FlowChartAlternateProcess", + page = "Page", /** - * Flow chart off-page connector geometric shape. + * Relative to column. * @remarks * [Api set: WordApiDesktop 1.2] */ - flowChartOffpageConnector = "FlowChartOffpageConnector", + column = "Column", /** - * Action button blank geometric shape. + * Relative to character. * @remarks * [Api set: WordApiDesktop 1.2] */ - actionButtonBlank = "ActionButtonBlank", + character = "Character", /** - * Action button home geometric shape. + * Relative to left margin. * @remarks * [Api set: WordApiDesktop 1.2] */ - actionButtonHome = "ActionButtonHome", + leftMargin = "LeftMargin", /** - * Action button help geometric shape. + * Relative to right margin. * @remarks * [Api set: WordApiDesktop 1.2] */ - actionButtonHelp = "ActionButtonHelp", + rightMargin = "RightMargin", /** - * Action button information geometric shape. + * Relative to inside margin. * @remarks * [Api set: WordApiDesktop 1.2] */ - actionButtonInformation = "ActionButtonInformation", + insideMargin = "InsideMargin", /** - * Action button forward next geometric shape. + * Relative to outside margin. * @remarks * [Api set: WordApiDesktop 1.2] */ - actionButtonForwardNext = "ActionButtonForwardNext", + outsideMargin = "OutsideMargin", + } + /** + * Represents what the vertical position of a shape is relative to. + For more information about margins, see {@link https://support.microsoft.com/office/c95c1ea1-70b1-4dde-a1da-f5aa2042c829 | Change the margins in your Word document}. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum RelativeVerticalPosition { /** - * Action button back previous geometric shape. + * Relative to margin. * @remarks * [Api set: WordApiDesktop 1.2] */ - actionButtonBackPrevious = "ActionButtonBackPrevious", + margin = "Margin", /** - * Action button end geometric shape. + * Relative to page. * @remarks * [Api set: WordApiDesktop 1.2] */ - actionButtonEnd = "ActionButtonEnd", + page = "Page", /** - * Action button beginning geometric shape. + * Relative to paragraph. * @remarks * [Api set: WordApiDesktop 1.2] */ - actionButtonBeginning = "ActionButtonBeginning", + paragraph = "Paragraph", /** - * Action button return geometric shape. + * Relative to line. * @remarks * [Api set: WordApiDesktop 1.2] */ - actionButtonReturn = "ActionButtonReturn", + line = "Line", /** - * Action button document geometric shape. + * Relative to top margin. * @remarks * [Api set: WordApiDesktop 1.2] */ - actionButtonDocument = "ActionButtonDocument", + topMargin = "TopMargin", /** - * Action button sound geometric shape. + * Relative to bottom margin. * @remarks * [Api set: WordApiDesktop 1.2] */ - actionButtonSound = "ActionButtonSound", + bottomMargin = "BottomMargin", /** - * Action button movie geometric shape. + * Relative to inside margin. * @remarks * [Api set: WordApiDesktop 1.2] */ - actionButtonMovie = "ActionButtonMovie", + insideMargin = "InsideMargin", /** - * Gear 6 geometric shape. + * Relative to outside margin. * @remarks * [Api set: WordApiDesktop 1.2] */ - gear6 = "Gear6", + outsideMargin = "OutsideMargin", + } + /** + * Represents what the horizontal or vertical size of a shape is relative to. + For more information about margins, see {@link https://support.microsoft.com/office/c95c1ea1-70b1-4dde-a1da-f5aa2042c829 | Change the margins in your Word document}. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum RelativeSize { /** - * Gear 9 geometric shape. + * Relative to margin. * @remarks * [Api set: WordApiDesktop 1.2] */ - gear9 = "Gear9", + margin = "Margin", /** - * Funnel geometric shape. + * Relative to page. * @remarks * [Api set: WordApiDesktop 1.2] */ - funnel = "Funnel", + page = "Page", /** - * Math plus geometric shape. + * Relative to top margin. * @remarks * [Api set: WordApiDesktop 1.2] */ - mathPlus = "MathPlus", + topMargin = "TopMargin", /** - * Math minus geometric shape. + * Relative to bottom margin. * @remarks * [Api set: WordApiDesktop 1.2] */ - mathMinus = "MathMinus", + bottomMargin = "BottomMargin", /** - * Math multiply geometric shape. + * Relative to inside margin. * @remarks * [Api set: WordApiDesktop 1.2] */ - mathMultiply = "MathMultiply", + insideMargin = "InsideMargin", /** - * Math divide geometric shape. + * Relative to outside margin. * @remarks * [Api set: WordApiDesktop 1.2] */ - mathDivide = "MathDivide", + outsideMargin = "OutsideMargin", + } + /** + * Specifies the shape type for a `GeometricShape` object. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum GeometricShapeType { /** - * Math equal geometric shape. + * Line inverse geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - mathEqual = "MathEqual", + lineInverse = "LineInverse", /** - * Math not equal geometric shape. + * Triangle geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - mathNotEqual = "MathNotEqual", + triangle = "Triangle", /** - * Corner tabs geometric shape. + * Right triangle geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - cornerTabs = "CornerTabs", + rightTriangle = "RightTriangle", /** - * Square tabs geometric shape. + * Rectangle geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - squareTabs = "SquareTabs", + rectangle = "Rectangle", /** - * Plaque tabs geometric shape. + * Diamond geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - plaqueTabs = "PlaqueTabs", + diamond = "Diamond", /** - * Chart X geometric shape. + * Parallelogram geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - chartX = "ChartX", + parallelogram = "Parallelogram", /** - * Chart star geometric shape. + * Trapezoid geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - chartStar = "ChartStar", + trapezoid = "Trapezoid", /** - * Chart plus geometric shape. + * Non-isosceles trapezoid geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - chartPlus = "ChartPlus", - } - /** - * Specifies a shape's fill type. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - enum ShapeFillType { + nonIsoscelesTrapezoid = "NonIsoscelesTrapezoid", /** - * No fill. + * Pentagon geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - noFill = "NoFill", + pentagon = "Pentagon", /** - * Solid fill. + * Hexagon geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - solid = "Solid", + hexagon = "Hexagon", /** - * Gradient fill. + * Heptagon geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - gradient = "Gradient", + heptagon = "Heptagon", /** - * Pattern fill. + * Octagon geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - pattern = "Pattern", + octagon = "Octagon", /** - * Picture fill. + * Decagon geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - picture = "Picture", + decagon = "Decagon", /** - * Texture fill. + * Dodecagon geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - texture = "Texture", + dodecagon = "Dodecagon", /** - * Mixed fill. + * Star 4-point geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - mixed = "Mixed", - } - /** - * Specifies the vertical alignment for the text frame in a shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - enum ShapeTextVerticalAlignment { + star4 = "Star4", /** - * Anchor the text at the top of the bounding rectangle. + * Star 5-point geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - top = "Top", + star5 = "Star5", /** - * Anchor the text at the middle of the bounding rectangle. + * Star 6-point geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - middle = "Middle", + star6 = "Star6", /** - * Anchor the text at the bottom of the bounding rectangle. + * Star 7-point geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - bottom = "Bottom", - } - /** - * Specifies the orientation for the text frame in a shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - enum ShapeTextOrientation { + star7 = "Star7", /** - * No orientation, such as in a new geometric shape. + * Star 8-point geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - none = "None", + star8 = "Star8", /** - * Horizontal text. + * Star 10-point geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - horizontal = "Horizontal", + star10 = "Star10", /** - * A special version of vertical text, where some fonts are displayed as if rotated. + * Star 12-point geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - eastAsianVertical = "EastAsianVertical", + star12 = "Star12", /** - * Determines if all of the text is vertical orientation (each line is 270 degrees rotated clockwise). + * Star 16-point geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - vertical270 = "Vertical270", + star16 = "Star16", /** - * Determines if all of the text is vertical orientation (each line is 90 degrees rotated clockwise). + * Star 24-point geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - vertical = "Vertical", + star24 = "Star24", /** - * A special version of vertical text, where some fonts are displayed as if rotated. + * Star 32-point geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - eastAsianHorizontalRotated = "EastAsianHorizontalRotated", + star32 = "Star32", /** - * A combination of automatic orientation is used. + * Round rectangle geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - mixed = "Mixed", - } - /** - * Determines the type of automatic sizing allowed. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - enum ShapeAutoSize { + roundRectangle = "RoundRectangle", /** - * No autosizing. + * Round one rectangle geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - none = "None", + round1Rectangle = "Round1Rectangle", /** - * The text is adjusted to fit the shape. + * Round two same rectangle geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - textToFitShape = "TextToFitShape", + round2SameRectangle = "Round2SameRectangle", /** - * The shape is adjusted to fit the text. + * Round two diagonal rectangle geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - shapeToFitText = "ShapeToFitText", + round2DiagonalRectangle = "Round2DiagonalRectangle", /** - * A combination of automatic sizing schemes are used. + * Snip round rectangle geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - mixed = "Mixed", - } - /** - * Specifies how to wrap document text around a shape. For more details, see the "Text Wrapping" tab of {@link https://support.microsoft.com/office/a0f53857-b501-46c6-ba8b-68ba51e0e3cc | Layout options}. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - enum ShapeTextWrapType { + snipRoundRectangle = "SnipRoundRectangle", /** - * Places the shape in line with text. + * Snip one rectangle geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - inline = "Inline", + snip1Rectangle = "Snip1Rectangle", /** - * Wraps text squarely around the shape. + * Snip two same rectangle geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - square = "Square", + snip2SameRectangle = "Snip2SameRectangle", /** - * Wraps text close to the shape. + * Snip two diagonal rectangle geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - tight = "Tight", + snip2DiagonalRectangle = "Snip2DiagonalRectangle", /** - * Wraps text around and through the shape. + * Plaque geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - through = "Through", + plaque = "Plaque", /** - * Places text above and below the shape. + * Ellipse geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - topBottom = "TopBottom", + ellipse = "Ellipse", /** - * Places shape behind text. + * Teardrop geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - behind = "Behind", + teardrop = "Teardrop", /** - * Places shape in front of text. + * Home plate geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - front = "Front", - } - /** - * Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farther from the respective page margin. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - enum ShapeTextWrapSide { + homePlate = "HomePlate", /** - * Has no wrap side property, such as those for inline shapes. + * Chevron geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - none = "None", + chevron = "Chevron", /** - * Both left and right sides of the shape. + * Pie wedge geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - both = "Both", + pieWedge = "PieWedge", /** - * Left side of the shape only. + * Pie geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - left = "Left", + pie = "Pie", /** - * Right side of the shape only. + * Block arc geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - right = "Right", + blockArc = "BlockArc", /** - * Side of the shape that's farther from the respective page margin. + * Donut geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - largest = "Largest", - } - /** - * Specifies the scale size type of a shape. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - enum ShapeScaleType { + donut = "Donut", /** - * Scale from current size of the shape. + * No smoking geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - currentSize = "CurrentSize", + noSmoking = "NoSmoking", /** - * Scale from original size of the shape. It only works for pictures. + * Right arrow geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - originalSize = "OriginalSize", - } - /** - * Specifies which part of the shape retains its position when the shape is scaled. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - enum ShapeScaleFrom { + rightArrow = "RightArrow", /** - * Scale from the top left corner of the shape. + * Left arrow geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - scaleFromTopLeft = "ScaleFromTopLeft", + leftArrow = "LeftArrow", /** - * Scale from the center of the shape. + * Up arrow geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - scaleFromMiddle = "ScaleFromMiddle", + upArrow = "UpArrow", /** - * Scale from the bottom right corner of the shape. + * Down arrow geometric shape. * @remarks * [Api set: WordApiDesktop 1.2] */ - scaleFromBottomRight = "ScaleFromBottomRight", - } - /** - * Represents how Word interprets the rule used to determine the height or width of a {@link Word.Frame}. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum FrameSizeRule { + downArrow = "DownArrow", /** - * The height or width is set according to the height or width of the item in the frame. + * Striped right arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - auto = "Auto", + stripedRightArrow = "StripedRightArrow", /** - * The height or width is set to a value equal to or greater than the value specified by the `height` property or `width` property. + * Notched right arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - atLeast = "AtLeast", + notchedRightArrow = "NotchedRightArrow", /** - * The height or width is set to an exact value specified by the `height` property or `width` property. + * Bent up arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - exact = "Exact", - } - /** - * Specifies the border style for an object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum BorderLineStyle { + bentUpArrow = "BentUpArrow", /** - * No line style. + * Left-right arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - none = "None", + leftRightArrow = "LeftRightArrow", /** - * Single line style. + * Up-down arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - single = "Single", + upDownArrow = "UpDownArrow", /** - * Dotted line style. + * Left-up arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - dot = "Dot", + leftUpArrow = "LeftUpArrow", /** - * Dashed line style with small gaps. + * Left-right-up arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - dashSmallGap = "DashSmallGap", + leftRightUpArrow = "LeftRightUpArrow", /** - * Dashed line style with large gaps. + * Quad arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - dashLargeGap = "DashLargeGap", + quadArrow = "QuadArrow", /** - * Dash-dot line style. + * Left arrow callout geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - dashDot = "DashDot", + leftArrowCallout = "LeftArrowCallout", /** - * Dash-dot-dot line style. + * Right arrow callout geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - dashDotDot = "DashDotDot", + rightArrowCallout = "RightArrowCallout", /** - * Double line style. + * Up arrow callout geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - double = "Double", + upArrowCallout = "UpArrowCallout", /** - * Triple line style. + * Down arrow callout geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - triple = "Triple", + downArrowCallout = "DownArrowCallout", /** - * Thin-thick line style with small gaps. + * Left-right arrow callout geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - thinThickSmallGap = "ThinThickSmallGap", + leftRightArrowCallout = "LeftRightArrowCallout", /** - * Thick-thin line style with small gaps. + * Up-down arrow callout geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - thickThinSmallGap = "ThickThinSmallGap", + upDownArrowCallout = "UpDownArrowCallout", /** - * Thin-thick-thin line style with small gaps. + * Quad arrow callout geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - thinThickThinSmallGap = "ThinThickThinSmallGap", + quadArrowCallout = "QuadArrowCallout", /** - * Thin-thick line style with medium gaps. + * Bent arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - thinThickMedGap = "ThinThickMedGap", + bentArrow = "BentArrow", /** - * Thick-thin line style with medium gaps. + * U-turn arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - thickThinMedGap = "ThickThinMedGap", + uturnArrow = "UturnArrow", /** - * Thin-thick-thin line style with medium gaps. + * Circular arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - thinThickThinMedGap = "ThinThickThinMedGap", + circularArrow = "CircularArrow", /** - * Thin-thick line style with large gaps. + * Left circular arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - thinThickLargeGap = "ThinThickLargeGap", + leftCircularArrow = "LeftCircularArrow", /** - * Thick-thin line style with large gaps. + * Left-right circular arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - thickThinLargeGap = "ThickThinLargeGap", + leftRightCircularArrow = "LeftRightCircularArrow", /** - * Thin-thick-thin line style with large gaps. + * Curved right arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - thinThickThinLargeGap = "ThinThickThinLargeGap", + curvedRightArrow = "CurvedRightArrow", /** - * Single wavy line style. + * Curved left arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - singleWavy = "SingleWavy", + curvedLeftArrow = "CurvedLeftArrow", /** - * Double wavy line style. + * Curved up arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - doubleWavy = "DoubleWavy", + curvedUpArrow = "CurvedUpArrow", /** - * Dash-dot stroked line style. + * Curved down arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - dashDotStroked = "DashDotStroked", + curvedDownArrow = "CurvedDownArrow", /** - * Embossed 3D line style. + * Swoosh arrow geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - emboss3D = "Emboss3D", + swooshArrow = "SwooshArrow", /** - * Engraved 3D line style. + * Cube geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - engrave3D = "Engrave3D", + cube = "Cube", /** - * Outset line style. + * Can geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - outset = "Outset", + can = "Can", /** - * Inset line style. + * Lightning bolt geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - inset = "Inset", - } - /** - * Specifies the width of an object's border. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum LineWidth { + lightningBolt = "LightningBolt", /** - * Represents a line width of 0.25 points. + * Heart geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - pt025 = "Pt025", + heart = "Heart", /** - * Represents a line width of 0.50 points. + * Sun geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - pt050 = "Pt050", + sun = "Sun", /** - * Represents a line width of 0.75 points. + * Moon geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - pt075 = "Pt075", + moon = "Moon", /** - * Represents a line width of 1.00 points. + * Smiley face geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - pt100 = "Pt100", + smileyFace = "SmileyFace", /** - * Represents a line width of 1.50 points. + * Irregular seal 1 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - pt150 = "Pt150", + irregularSeal1 = "IrregularSeal1", /** - * Represents a line width of 2.25 points. + * Irregular seal 2 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - pt225 = "Pt225", + irregularSeal2 = "IrregularSeal2", /** - * Represents a line width of 3.00 points. + * Folded corner geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - pt300 = "Pt300", + foldedCorner = "FoldedCorner", /** - * Represents a line width of 4.50 points. + * Bevel geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - pt450 = "Pt450", + bevel = "Bevel", /** - * Represents a line width of 6.00 points. + * Frame geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - pt600 = "Pt600", - } - /** - * Specifies the graphical page border setting of a page. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum PageBorderArt { + frame = "Frame", /** - * Represents a border with apple design. + * Half frame geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - apples = "Apples", + halfFrame = "HalfFrame", /** - * Represents a border with maple muffin design. + * Corner geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - mapleMuffins = "MapleMuffins", + corner = "Corner", /** - * Represents a border with cake slice design. + * Diagonal stripe geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - cakeSlice = "CakeSlice", + diagonalStripe = "DiagonalStripe", /** - * Represents a border with candy corn design. + * Chord geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - candyCorn = "CandyCorn", + chord = "Chord", /** - * Represents a border with ice cream cone design. + * Arc geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - iceCreamCones = "IceCreamCones", + arc = "Arc", /** - * Represents a border with champagne bottle design. + * Left bracket geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - champagneBottle = "ChampagneBottle", + leftBracket = "LeftBracket", /** - * Represents a border with party glass design. + * Right bracket geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - partyGlass = "PartyGlass", + rightBracket = "RightBracket", /** - * Represents a border with Christmas tree design. + * Left brace geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - christmasTree = "ChristmasTree", + leftBrace = "LeftBrace", /** - * Represents a border with trees design. + * Right brace geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - trees = "Trees", + rightBrace = "RightBrace", /** - * Represents a border with palm trees in color. + * Bracket pair geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - palmsColor = "PalmsColor", + bracketPair = "BracketPair", /** - * Represents a border with three-color balloons design. + * Brace pair geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - balloons3Colors = "Balloons3Colors", + bracePair = "BracePair", /** - * Represents a border with hot air balloons design. + * Callout 1 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - balloonsHotAir = "BalloonsHotAir", + callout1 = "Callout1", /** - * Represents a border with party favor design. + * Callout 2 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - partyFavor = "PartyFavor", + callout2 = "Callout2", /** - * Represents a border with confetti streamers design. + * Callout 3 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - confettiStreamers = "ConfettiStreamers", + callout3 = "Callout3", /** - * Represents a border with hearts design. + * Accent callout 1 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - hearts = "Hearts", + accentCallout1 = "AccentCallout1", /** - * Represents a border with heart balloon design. + * Accent callout 2 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - heartBalloon = "HeartBalloon", + accentCallout2 = "AccentCallout2", /** - * Represents a border with 3D stars design. + * Accent callout 3 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - stars3D = "Stars3D", + accentCallout3 = "AccentCallout3", /** - * Represents a border with shadowed stars design. + * Border callout 1 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - starsShadowed = "StarsShadowed", + borderCallout1 = "BorderCallout1", /** - * Represents a border with stars design. + * Border callout 2 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - stars = "Stars", + borderCallout2 = "BorderCallout2", /** - * Represents a border with sun design. + * Border callout 3 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - sun = "Sun", + borderCallout3 = "BorderCallout3", /** - * Represents a border with Earth design (variant 2). + * Accent border callout 1 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - earth2 = "Earth2", + accentBorderCallout1 = "AccentBorderCallout1", /** - * Represents a border with Earth design (variant 1). + * Accent border callout 2 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - earth1 = "Earth1", + accentBorderCallout2 = "AccentBorderCallout2", /** - * Represents a border with people wearing hats design. + * Accent border callout 3 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - peopleHats = "PeopleHats", + accentBorderCallout3 = "AccentBorderCallout3", /** - * Represents a border with sombrero design. + * Wedge rectangle callout geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - sombrero = "Sombrero", + wedgeRectCallout = "WedgeRectCallout", /** - * Represents a border with pencils design. + * Wedge rounded rectangle callout geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - pencils = "Pencils", + wedgeRRectCallout = "WedgeRRectCallout", /** - * Represents a border with packages design. + * Wedge ellipse callout geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - packages = "Packages", + wedgeEllipseCallout = "WedgeEllipseCallout", /** - * Represents a border with clocks design. + * Cloud callout geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - clocks = "Clocks", + cloudCallout = "CloudCallout", /** - * Represents a border with firecrackers design. + * Cloud geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - firecrackers = "Firecrackers", + cloud = "Cloud", /** - * Represents a border with rings design. + * Ribbon geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - rings = "Rings", + ribbon = "Ribbon", /** - * Represents a border with map pins design. + * Ribbon 2 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - mapPins = "MapPins", + ribbon2 = "Ribbon2", /** - * Represents a border with confetti design. + * Ellipse ribbon geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - confetti = "Confetti", + ellipseRibbon = "EllipseRibbon", /** - * Represents a border with butterfly creatures design. + * Ellipse ribbon 2 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - creaturesButterfly = "CreaturesButterfly", + ellipseRibbon2 = "EllipseRibbon2", /** - * Represents a border with ladybug creatures design. + * Left-right ribbon geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - creaturesLadyBug = "CreaturesLadyBug", + leftRightRibbon = "LeftRightRibbon", /** - * Represents a border with fish creatures design. + * Vertical scroll geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - creaturesFish = "CreaturesFish", + verticalScroll = "VerticalScroll", /** - * Represents a border with birds in flight design. + * Horizontal scroll geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - birdsFlight = "BirdsFlight", + horizontalScroll = "HorizontalScroll", /** - * Represents a border with scared cat design. + * Wave geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - scaredCat = "ScaredCat", + wave = "Wave", /** - * Represents a border with bats design. + * Double wave geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - bats = "Bats", + doubleWave = "DoubleWave", /** - * Represents a border with roses flowers design. + * Plus geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - flowersRoses = "FlowersRoses", + plus = "Plus", /** - * Represents a border with red rose flowers design. + * Flow chart process geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - flowersRedRose = "FlowersRedRose", + flowChartProcess = "FlowChartProcess", /** - * Represents a border with poinsettias flowers design. + * Flow chart decision geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - poinsettias = "Poinsettias", + flowChartDecision = "FlowChartDecision", /** - * Represents a border with holly design. + * Flow chart input-output geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - holly = "Holly", + flowChartInputOutput = "FlowChartInputOutput", /** - * Represents a border with tiny flowers design. + * Flow chart predefined process geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - flowersTiny = "FlowersTiny", + flowChartPredefinedProcess = "FlowChartPredefinedProcess", /** - * Represents a border with pansy flowers design. + * Flow chart internal storage geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - flowersPansy = "FlowersPansy", + flowChartInternalStorage = "FlowChartInternalStorage", /** - * Represents a border with modern 2 flowers design. + * Flow chart document geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - flowersModern2 = "FlowersModern2", + flowChartDocument = "FlowChartDocument", /** - * Represents a border with modern 1 flowers design. + * Flow chart multidocument geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - flowersModern1 = "FlowersModern1", + flowChartMultidocument = "FlowChartMultidocument", /** - * Represents a border with white flowers design. + * Flow chart terminator geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - whiteFlowers = "WhiteFlowers", + flowChartTerminator = "FlowChartTerminator", /** - * Represents a border with vine design. + * Flow chart preparation geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - vine = "Vine", + flowChartPreparation = "FlowChartPreparation", /** - * Represents a border with daisies flowers design. + * Flow chart manual input geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - flowersDaisies = "FlowersDaisies", + flowChartManualInput = "FlowChartManualInput", /** - * Represents a border with block print flowers design. + * Flow chart manual operation geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - flowersBlockPrint = "FlowersBlockPrint", + flowChartManualOperation = "FlowChartManualOperation", /** - * Represents a border with colored deco arch design. + * Flow chart connector geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - decoArchColor = "DecoArchColor", + flowChartConnector = "FlowChartConnector", /** - * Represents a border with fans design. + * Flow chart punched card geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - fans = "Fans", + flowChartPunchedCard = "FlowChartPunchedCard", /** - * Represents a border with film design. + * Flow chart punched tape geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - film = "Film", + flowChartPunchedTape = "FlowChartPunchedTape", /** - * Represents a border with lightning design (variant 1). + * Flow chart summing junction geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - lightning1 = "Lightning1", + flowChartSummingJunction = "FlowChartSummingJunction", /** - * Represents a border with compass design. + * Flow chart OR geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - compass = "Compass", + flowChartOr = "FlowChartOr", /** - * Represents a border with double D design. + * Flow chart collate geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - doubleD = "DoubleD", + flowChartCollate = "FlowChartCollate", /** - * Represents a border with classical wave design. + * Flow chart sort geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - classicalWave = "ClassicalWave", + flowChartSort = "FlowChartSort", /** - * Represents a border with shadowed squares design. + * Flow chart extract geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - shadowedSquares = "ShadowedSquares", + flowChartExtract = "FlowChartExtract", /** - * Represents a border with twisted lines design (variant 1). + * Flow chart merge geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - twistedLines1 = "TwistedLines1", + flowChartMerge = "FlowChartMerge", /** - * Represents a border with waveline design. + * Flow chart offline storage geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - waveline = "Waveline", + flowChartOfflineStorage = "FlowChartOfflineStorage", /** - * Represents a border with quadrants design. + * Flow chart online storage geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - quadrants = "Quadrants", + flowChartOnlineStorage = "FlowChartOnlineStorage", /** - * Represents a border with colored checked bar design. + * Flow chart magnetic tape geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - checkedBarColor = "CheckedBarColor", + flowChartMagneticTape = "FlowChartMagneticTape", /** - * Represents a border with swirligig design. + * Flow chart magnetic disk geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - swirligig = "Swirligig", + flowChartMagneticDisk = "FlowChartMagneticDisk", /** - * Represents a border with push pin note design (variant 1). + * Flow chart magnetic drum geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - pushPinNote1 = "PushPinNote1", + flowChartMagneticDrum = "FlowChartMagneticDrum", /** - * Represents a border with push pin note design (variant 2). + * Flow chart display geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - pushPinNote2 = "PushPinNote2", + flowChartDisplay = "FlowChartDisplay", /** - * Represents a border with pumpkin design (variant 1). + * Flow chart delay geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - pumpkin1 = "Pumpkin1", + flowChartDelay = "FlowChartDelay", /** - * Represents a border with black eggs design. + * Flow chart alternate process geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - eggsBlack = "EggsBlack", + flowChartAlternateProcess = "FlowChartAlternateProcess", /** - * Represents a border with cup design. + * Flow chart off-page connector geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - cup = "Cup", + flowChartOffpageConnector = "FlowChartOffpageConnector", /** - * Represents a border with gray heart design. + * Action button blank geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - heartGray = "HeartGray", + actionButtonBlank = "ActionButtonBlank", /** - * Represents a border with gingerbread man design. + * Action button home geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - gingerbreadMan = "GingerbreadMan", + actionButtonHome = "ActionButtonHome", /** - * Represents a border with baby pacifier design. + * Action button help geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - babyPacifier = "BabyPacifier", + actionButtonHelp = "ActionButtonHelp", /** - * Represents a border with baby rattle design. + * Action button information geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - babyRattle = "BabyRattle", + actionButtonInformation = "ActionButtonInformation", /** - * Represents a border with cabins design. + * Action button forward next geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - cabins = "Cabins", + actionButtonForwardNext = "ActionButtonForwardNext", /** - * Represents a border with funky house design. + * Action button back previous geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - houseFunky = "HouseFunky", + actionButtonBackPrevious = "ActionButtonBackPrevious", /** - * Represents a border with black stars design. + * Action button end geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - starsBlack = "StarsBlack", + actionButtonEnd = "ActionButtonEnd", /** - * Represents a border with snowflakes design. + * Action button beginning geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - snowflakes = "Snowflakes", + actionButtonBeginning = "ActionButtonBeginning", /** - * Represents a border with fancy snowflake design. + * Action button return geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - snowflakeFancy = "SnowflakeFancy", + actionButtonReturn = "ActionButtonReturn", /** - * Represents a border with skyrocket design. + * Action button document geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - skyrocket = "Skyrocket", + actionButtonDocument = "ActionButtonDocument", /** - * Represents a border with Seattle design. + * Action button sound geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - seattle = "Seattle", + actionButtonSound = "ActionButtonSound", /** - * Represents a border with music notes design. + * Action button movie geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - musicNotes = "MusicNotes", + actionButtonMovie = "ActionButtonMovie", /** - * Represents a border with black palms design. + * Gear 6 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - palmsBlack = "PalmsBlack", + gear6 = "Gear6", /** - * Represents a border with maple leaf design. + * Gear 9 geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - mapleLeaf = "MapleLeaf", + gear9 = "Gear9", /** - * Represents a border with paper clips design. + * Funnel geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - paperClips = "PaperClips", + funnel = "Funnel", /** - * Represents a border with shorebird tracks design. + * Math plus geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - shorebirdTracks = "ShorebirdTracks", + mathPlus = "MathPlus", /** - * Represents a border with people design. + * Math minus geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - people = "People", + mathMinus = "MathMinus", /** - * Represents a border with people waving design. + * Math multiply geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - peopleWaving = "PeopleWaving", + mathMultiply = "MathMultiply", /** - * Represents a border with eclipsing squares design (variant 2). + * Math divide geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - eclipsingSquares2 = "EclipsingSquares2", + mathDivide = "MathDivide", /** - * Represents a border with hypnotic design. + * Math equal geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - hypnotic = "Hypnotic", + mathEqual = "MathEqual", /** - * Represents a border with gray diamonds design. + * Math not equal geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - diamondsGray = "DiamondsGray", + mathNotEqual = "MathNotEqual", /** - * Represents a border with deco arch design. + * Corner tabs geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - decoArch = "DecoArch", + cornerTabs = "CornerTabs", /** - * Represents a border with deco blocks design. + * Square tabs geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - decoBlocks = "DecoBlocks", + squareTabs = "SquareTabs", /** - * Represents a border with circles and lines design. + * Plaque tabs geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - circlesLines = "CirclesLines", + plaqueTabs = "PlaqueTabs", /** - * Represents a border with papyrus design. + * Chart X geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - papyrus = "Papyrus", + chartX = "ChartX", /** - * Represents a border with woodwork design. + * Chart star geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - woodwork = "Woodwork", + chartStar = "ChartStar", /** - * Represents a border with weaving braid design. + * Chart plus geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - weavingBraid = "WeavingBraid", + chartPlus = "ChartPlus", + } + /** + * Specifies a shape's fill type. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum ShapeFillType { /** - * Represents a border with weaving ribbon design. + * No fill. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - weavingRibbon = "WeavingRibbon", + noFill = "NoFill", /** - * Represents a border with weaving angles design. + * Solid fill. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - weavingAngles = "WeavingAngles", + solid = "Solid", /** - * Represents a border with arched scallops design. + * Gradient fill. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - archedScallops = "ArchedScallops", + gradient = "Gradient", /** - * Represents a border with safari design. + * Pattern fill. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - safari = "Safari", + pattern = "Pattern", /** - * Represents a border with Celtic knotwork design. + * Picture fill. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - celticKnotwork = "CelticKnotwork", + picture = "Picture", /** - * Represents a border with crazy maze design. + * Texture fill. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - crazyMaze = "CrazyMaze", + texture = "Texture", /** - * Represents a border with eclipsing squares design (variant 1). + * Mixed fill. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - eclipsingSquares1 = "EclipsingSquares1", + mixed = "Mixed", + } + /** + * Specifies the vertical alignment for the text frame in a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum ShapeTextVerticalAlignment { /** - * Represents a border with birds design. + * Anchor the text at the top of the bounding rectangle. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - birds = "Birds", + top = "Top", /** - * Represents a border with teacup and flowers design. + * Anchor the text at the middle of the bounding rectangle. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - flowersTeacup = "FlowersTeacup", + middle = "Middle", /** - * Represents a border with northwest design. + * Anchor the text at the bottom of the bounding rectangle. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - northwest = "Northwest", + bottom = "Bottom", + } + /** + * Specifies the orientation for the text frame in a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum ShapeTextOrientation { /** - * Represents a border with southwest design. + * No orientation, such as in a new geometric shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - southwest = "Southwest", + none = "None", /** - * Represents a border with tribal design (variant 6). + * Horizontal text. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - tribal6 = "Tribal6", + horizontal = "Horizontal", /** - * Represents a border with tribal design (variant 4). + * A special version of vertical text, where some fonts are displayed as if rotated. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - tribal4 = "Tribal4", + eastAsianVertical = "EastAsianVertical", /** - * Represents a border with tribal design (variant 3). + * Determines if all of the text is vertical orientation (each line is 270 degrees rotated clockwise). * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - tribal3 = "Tribal3", + vertical270 = "Vertical270", /** - * Represents a border with tribal design (variant 2). + * Determines if all of the text is vertical orientation (each line is 90 degrees rotated clockwise). * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - tribal2 = "Tribal2", + vertical = "Vertical", /** - * Represents a border with tribal design (variant 5). + * A special version of vertical text, where some fonts are displayed as if rotated. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - tribal5 = "Tribal5", + eastAsianHorizontalRotated = "EastAsianHorizontalRotated", /** - * Represents a border with X illusions design. + * A combination of automatic orientation is used. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - xillusions = "XIllusions", + mixed = "Mixed", + } + /** + * Determines the type of automatic sizing allowed. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum ShapeAutoSize { /** - * Represents a border with zany triangles design. + * No autosizing. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - zanyTriangles = "ZanyTriangles", + none = "None", /** - * Represents a border with pyramids design. + * The text is adjusted to fit the shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - pyramids = "Pyramids", + textToFitShape = "TextToFitShape", /** - * Represents a border with pyramids above design. + * The shape is adjusted to fit the text. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - pyramidsAbove = "PyramidsAbove", + shapeToFitText = "ShapeToFitText", /** - * Represents a border with gray confetti design. + * A combination of automatic sizing schemes are used. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - confettiGrays = "ConfettiGrays", + mixed = "Mixed", + } + /** + * Specifies how to wrap document text around a shape. For more details, see the "Text Wrapping" tab of {@link https://support.microsoft.com/office/a0f53857-b501-46c6-ba8b-68ba51e0e3cc | Layout options}. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum ShapeTextWrapType { /** - * Represents a border with outline confetti design. + * Places the shape in line with text. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - confettiOutline = "ConfettiOutline", + inline = "Inline", /** - * Represents a border with white confetti design. + * Wraps text squarely around the shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - confettiWhite = "ConfettiWhite", + square = "Square", /** - * Represents a border with mosaic design. + * Wraps text close to the shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - mosaic = "Mosaic", + tight = "Tight", /** - * Represents a border with lightning design (variant 2). + * Wraps text around and through the shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - lightning2 = "Lightning2", + through = "Through", /** - * Represents a border with heebie jeebies design. + * Places text above and below the shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - heebieJeebies = "HeebieJeebies", + topBottom = "TopBottom", /** - * Represents a border with light bulb design. + * Places shape behind text. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - lightBulb = "LightBulb", + behind = "Behind", /** - * Represents a border with gradient design. + * Places shape in front of text. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - gradient = "Gradient", + front = "Front", + } + /** + * Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farther from the respective page margin. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum ShapeTextWrapSide { /** - * Represents a border with triangle party design. + * Has no wrap side property, such as those for inline shapes. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - triangleParty = "TriangleParty", + none = "None", /** - * Represents a border with twisted lines design (variant 2). + * Both left and right sides of the shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - twistedLines2 = "TwistedLines2", + both = "Both", /** - * Represents a border with moons design. + * Left side of the shape only. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - moons = "Moons", + left = "Left", /** - * Represents a border with ovals design. + * Right side of the shape only. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - ovals = "Ovals", + right = "Right", /** - * Represents a border with double diamonds design. + * Side of the shape that's farther from the respective page margin. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - doubleDiamonds = "DoubleDiamonds", + largest = "Largest", + } + /** + * Specifies the scale size type of a shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum ShapeScaleType { /** - * Represents a border with chain link design. + * Scale from current size of the shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - chainLink = "ChainLink", + currentSize = "CurrentSize", /** - * Represents a border with triangles design. + * Scale from original size of the shape. It only works for pictures. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - triangles = "Triangles", + originalSize = "OriginalSize", + } + /** + * Specifies which part of the shape retains its position when the shape is scaled. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + enum ShapeScaleFrom { /** - * Represents a border with tribal design (variant 1). + * Scale from the top left corner of the shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - tribal1 = "Tribal1", + scaleFromTopLeft = "ScaleFromTopLeft", /** - * Represents a border with marquee toothed design. + * Scale from the center of the shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - marqueeToothed = "MarqueeToothed", + scaleFromMiddle = "ScaleFromMiddle", /** - * Represents a border with sharks teeth design. + * Scale from the bottom right corner of the shape. * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - sharksTeeth = "SharksTeeth", + scaleFromBottomRight = "ScaleFromBottomRight", + } + /** + * Represents how Word interprets the rule used to determine the height or width of a {@link Word.Frame}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum FrameSizeRule { /** - * Represents a border with sawtooth design. + * The height or width is set according to the height or width of the item in the frame. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sawtooth = "Sawtooth", + auto = "Auto", /** - * Represents a border with gray sawtooth design. + * The height or width is set to a value equal to or greater than the value specified by the `height` property or `width` property. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sawtoothGray = "SawtoothGray", + atLeast = "AtLeast", /** - * Represents a border with postage stamp design. + * The height or width is set to an exact value specified by the `height` property or `width` property. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - postageStamp = "PostageStamp", + exact = "Exact", + } + /** + * Specifies the border style for an object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum BorderLineStyle { /** - * Represents a border with weaving strips design. + * No line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - weavingStrips = "WeavingStrips", + none = "None", /** - * Represents a border with zigzag design. + * Single line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - zigZag = "ZigZag", + single = "Single", /** - * Represents a border with cross stitch design. + * Dotted line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - crossStitch = "CrossStitch", + dot = "Dot", /** - * Represents a border with gems design. + * Dashed line style with small gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gems = "Gems", + dashSmallGap = "DashSmallGap", /** - * Represents a border with circles and rectangles design. + * Dashed line style with large gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - circlesRectangles = "CirclesRectangles", + dashLargeGap = "DashLargeGap", /** - * Represents a border with corner triangles design. + * Dash-dot line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cornerTriangles = "CornerTriangles", + dashDot = "DashDot", /** - * Represents a border with insects creatures design. + * Dash-dot-dot line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - creaturesInsects = "CreaturesInsects", + dashDotDot = "DashDotDot", /** - * Represents a border with zigzag stitch design. + * Double line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - zigZagStitch = "ZigZagStitch", + double = "Double", /** - * Represents a border with checkered design. + * Triple line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - checkered = "Checkered", + triple = "Triple", /** - * Represents a border with black checked bar design. + * Thin-thick line style with small gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - checkedBarBlack = "CheckedBarBlack", + thinThickSmallGap = "ThinThickSmallGap", /** - * Represents a border with marquee design. + * Thick-thin line style with small gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - marquee = "Marquee", + thickThinSmallGap = "ThickThinSmallGap", /** - * Represents a border with basic white dots design. + * Thin-thick-thin line style with small gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - basicWhiteDots = "BasicWhiteDots", + thinThickThinSmallGap = "ThinThickThinSmallGap", /** - * Represents a border with basic wide midline design. + * Thin-thick line style with medium gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - basicWideMidline = "BasicWideMidline", + thinThickMedGap = "ThinThickMedGap", /** - * Represents a border with basic wide outline design. + * Thick-thin line style with medium gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - basicWideOutline = "BasicWideOutline", + thickThinMedGap = "ThickThinMedGap", /** - * Represents a border with basic wide inline design. + * Thin-thick-thin line style with medium gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - basicWideInline = "BasicWideInline", + thinThickThinMedGap = "ThinThickThinMedGap", /** - * Represents a border with basic thin lines design. + * Thin-thick line style with large gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - basicThinLines = "BasicThinLines", + thinThickLargeGap = "ThinThickLargeGap", /** - * Represents a border with basic white dashes design. + * Thick-thin line style with large gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - basicWhiteDashes = "BasicWhiteDashes", + thickThinLargeGap = "ThickThinLargeGap", /** - * Represents a border with basic white squares design. + * Thin-thick-thin line style with large gaps. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - basicWhiteSquares = "BasicWhiteSquares", + thinThickThinLargeGap = "ThinThickThinLargeGap", /** - * Represents a border with basic black squares design. + * Single wavy line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - basicBlackSquares = "BasicBlackSquares", + singleWavy = "SingleWavy", /** - * Represents a border with basic black dashes design. + * Double wavy line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - basicBlackDashes = "BasicBlackDashes", + doubleWavy = "DoubleWavy", /** - * Represents a border with basic black dots design. + * Dash-dot stroked line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - basicBlackDots = "BasicBlackDots", + dashDotStroked = "DashDotStroked", /** - * Represents a border with top stars design. + * Embossed 3D line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - starsTop = "StarsTop", + emboss3D = "Emboss3D", /** - * Represents a border with certificate banner design. + * Engraved 3D line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - certificateBanner = "CertificateBanner", + engrave3D = "Engrave3D", /** - * Represents a border with handmade design (variant 1). + * Outset line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - handmade1 = "Handmade1", + outset = "Outset", /** - * Represents a border with handmade design (variant 2). + * Inset line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - handmade2 = "Handmade2", + inset = "Inset", + } + /** + * Specifies the width of an object's border. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum LineWidth { /** - * Represents a border with torn paper design. + * Represents a line width of 0.25 points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tornPaper = "TornPaper", + pt025 = "Pt025", /** - * Represents a border with black torn paper design. + * Represents a line width of 0.50 points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tornPaperBlack = "TornPaperBlack", + pt050 = "Pt050", /** - * Represents a border with coupon cutout dashes design. + * Represents a line width of 0.75 points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - couponCutoutDashes = "CouponCutoutDashes", + pt075 = "Pt075", /** - * Represents a border with coupon cutout dots design. + * Represents a line width of 1.00 points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - couponCutoutDots = "CouponCutoutDots", - } - /** - * Specifies the preferred unit of measure to use when measuring the width of an item. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum PreferredWidthType { + pt100 = "Pt100", /** - * Automatically select the unit of measure to use based on the current selection. + * Represents a line width of 1.50 points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - auto = "Auto", + pt150 = "Pt150", /** - * Measure the current item width using a specified percentage. + * Represents a line width of 2.25 points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent = "Percent", + pt225 = "Pt225", /** - * Measure the current item width using a specified number of points. + * Represents a line width of 3.00 points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - points = "Points", - } - /** - * Represents the reading order of text. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ReadingOrder { + pt300 = "Pt300", /** - * Represents right-to-left reading order. + * Represents a line width of 4.50 points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rightToLeft = "RightToLeft", + pt450 = "Pt450", /** - * Represents left-to-right reading order. + * Represents a line width of 6.00 points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - leftToRight = "LeftToRight", + pt600 = "Pt600", } /** - * Specifies the way Word adjusts the table when the left indent is changed. + * Specifies the graphical page border setting of a page. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum RulerStyle { + enum PageBorderArt { /** - * Adjusts the left edge of row or rows, preserving the width of all columns by shifting them to the left or right. This is the default value. + * Represents a border with apple design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + apples = "Apples", /** - * Adjusts the left edge of the first column, preserving the position of the right edge of the table by proportionally adjusting the widths of all the cells in the specified row or rows. + * Represents a border with maple muffin design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - proportional = "Proportional", + mapleMuffins = "MapleMuffins", /** - * Adjusts the left edge of the first column only, preserving the positions of the other columns and the right edge of the table. + * Represents a border with cake slice design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - firstColumn = "FirstColumn", + cakeSlice = "CakeSlice", /** - * Adjusts the left edge of the first column, preserving the position of the right edge of the table by setting the widths of all the cells in the specified row or rows to the same value. + * Represents a border with candy corn design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sameWidth = "SameWidth", - } - /** - * Represents the East Asian language to use when breaking lines of text in the specified document or template. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum FarEastLineBreakLanguageId { + candyCorn = "CandyCorn", /** - * Represents Traditional Chinese language. + * Represents a border with ice cream cone design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - traditionalChinese = "TraditionalChinese", + iceCreamCones = "IceCreamCones", /** - * Represents Japanese language. + * Represents a border with champagne bottle design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - japanese = "Japanese", + champagneBottle = "ChampagneBottle", /** - * Represents Korean language. + * Represents a border with party glass design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - korean = "Korean", + partyGlass = "PartyGlass", /** - * Represents Simplified Chinese language. + * Represents a border with Christmas tree design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - simplifiedChinese = "SimplifiedChinese", - } - /** - * Represents the level of line breaking to use for East Asian languages in the specified document or template. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum FarEastLineBreakLevel { + christmasTree = "ChristmasTree", /** - * Represents the normal line break level. + * Represents a border with trees design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - normal = "Normal", + trees = "Trees", /** - * Represents the strict line break level. + * Represents a border with palm trees in color. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - strict = "Strict", + palmsColor = "PalmsColor", /** - * Represents the custom line break level. + * Represents a border with three-color balloons design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - custom = "Custom", - } - /** - * Specifies the character spacing adjustment for a document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum JustificationMode { + balloons3Colors = "Balloons3Colors", /** - * Expands the character spacing + * Represents a border with hot air balloons design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - expand = "Expand", + balloonsHotAir = "BalloonsHotAir", /** - * Compresses the character spacing. + * Represents a border with party favor design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - compress = "Compress", + partyFavor = "PartyFavor", /** - * Compresses the character spacing using rules of the kana syllabaries, Hiragana and Katakana. + * Represents a border with confetti streamers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - compressKana = "CompressKana", - } - /** - * Specifies the type of template. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum TemplateType { + confettiStreamers = "ConfettiStreamers", /** - * Represents the normal template type. + * Represents a border with hearts design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - normal = "Normal", + hearts = "Hearts", /** - * Represents the global template type. + * Represents a border with heart balloon design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - global = "Global", + heartBalloon = "HeartBalloon", /** - * Represents the attached template type. + * Represents a border with 3D stars design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - attached = "Attached", - } - /** - * Represents the language ID of a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum LanguageId { + stars3D = "Stars3D", /** - * Afrikaans language. + * Represents a border with shadowed stars design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - afrikaans = "Afrikaans", + starsShadowed = "StarsShadowed", /** - * Albanian language. + * Represents a border with stars design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - albanian = "Albanian", + stars = "Stars", /** - * Amharic language. + * Represents a border with sun design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - amharic = "Amharic", + sun = "Sun", /** - * Arabic language. + * Represents a border with Earth design (variant 2). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabic = "Arabic", + earth2 = "Earth2", /** - * Arabic Algerian language. + * Represents a border with Earth design (variant 1). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicAlgeria = "ArabicAlgeria", + earth1 = "Earth1", /** - * Arabic Bahraini language. + * Represents a border with people wearing hats design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicBahrain = "ArabicBahrain", + peopleHats = "PeopleHats", /** - * Arabic Egyptian language. + * Represents a border with sombrero design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicEgypt = "ArabicEgypt", + sombrero = "Sombrero", /** - * Arabic Iraqi language. + * Represents a border with pencils design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicIraq = "ArabicIraq", + pencils = "Pencils", /** - * Arabic Jordanian language. + * Represents a border with packages design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicJordan = "ArabicJordan", + packages = "Packages", /** - * Arabic Kuwaiti language. + * Represents a border with clocks design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicKuwait = "ArabicKuwait", + clocks = "Clocks", /** - * Arabic Lebanese language. + * Represents a border with firecrackers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicLebanon = "ArabicLebanon", + firecrackers = "Firecrackers", /** - * Arabic Libyan language. + * Represents a border with rings design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicLibya = "ArabicLibya", + rings = "Rings", /** - * Arabic Moroccan language. + * Represents a border with map pins design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicMorocco = "ArabicMorocco", + mapPins = "MapPins", /** - * Arabic Omani language. + * Represents a border with confetti design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicOman = "ArabicOman", + confetti = "Confetti", /** - * Arabic Qatari language. + * Represents a border with butterfly creatures design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicQatar = "ArabicQatar", + creaturesButterfly = "CreaturesButterfly", /** - * Arabic Syrian language. + * Represents a border with ladybug creatures design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicSyria = "ArabicSyria", + creaturesLadyBug = "CreaturesLadyBug", /** - * Arabic Tunisian language. + * Represents a border with fish creatures design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicTunisia = "ArabicTunisia", + creaturesFish = "CreaturesFish", /** - * Arabic United Arab Emirates language. + * Represents a border with birds in flight design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicUAE = "ArabicUAE", + birdsFlight = "BirdsFlight", /** - * Arabic Yemeni language. + * Represents a border with scared cat design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arabicYemen = "ArabicYemen", + scaredCat = "ScaredCat", /** - * Armenian language. + * Represents a border with bats design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - armenian = "Armenian", + bats = "Bats", /** - * Assamese language. + * Represents a border with roses flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - assamese = "Assamese", + flowersRoses = "FlowersRoses", /** - * Azerbaijani Cyrillic language. + * Represents a border with red rose flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - azeriCyrillic = "AzeriCyrillic", + flowersRedRose = "FlowersRedRose", /** - * Azerbaijani Latin language. + * Represents a border with poinsettias flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - azeriLatin = "AzeriLatin", + poinsettias = "Poinsettias", /** - * Basque (Basque). + * Represents a border with holly design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - basque = "Basque", + holly = "Holly", /** - * Belgian Dutch language. + * Represents a border with tiny flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - belgianDutch = "BelgianDutch", + flowersTiny = "FlowersTiny", /** - * Belgian French language. + * Represents a border with pansy flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - belgianFrench = "BelgianFrench", + flowersPansy = "FlowersPansy", /** - * Bengali language. + * Represents a border with modern 2 flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bengali = "Bengali", + flowersModern2 = "FlowersModern2", /** - * Bulgarian language. + * Represents a border with modern 1 flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bulgarian = "Bulgarian", + flowersModern1 = "FlowersModern1", /** - * Burmese language. + * Represents a border with white flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - burmese = "Burmese", + whiteFlowers = "WhiteFlowers", /** - * Belarusian language. + * Represents a border with vine design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - belarusian = "Belarusian", + vine = "Vine", /** - * Catalan language. + * Represents a border with daisies flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - catalan = "Catalan", + flowersDaisies = "FlowersDaisies", /** - * Cherokee language. + * Represents a border with block print flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cherokee = "Cherokee", + flowersBlockPrint = "FlowersBlockPrint", /** - * Chinese Hong Kong SAR language. + * Represents a border with colored deco arch design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - chineseHongKongSAR = "ChineseHongKongSAR", + decoArchColor = "DecoArchColor", /** - * Chinese Macao SAR language. + * Represents a border with fans design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - chineseMacaoSAR = "ChineseMacaoSAR", + fans = "Fans", /** - * Chinese Singapore language. + * Represents a border with film design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - chineseSingapore = "ChineseSingapore", + film = "Film", /** - * Croatian language. + * Represents a border with lightning design (variant 1). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - croatian = "Croatian", + lightning1 = "Lightning1", /** - * Czech language. + * Represents a border with compass design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - czech = "Czech", + compass = "Compass", /** - * Danish language. + * Represents a border with double D design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - danish = "Danish", + doubleD = "DoubleD", /** - * Divehi language. + * Represents a border with classical wave design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - divehi = "Divehi", + classicalWave = "ClassicalWave", /** - * Dutch language. + * Represents a border with shadowed squares design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dutch = "Dutch", + shadowedSquares = "ShadowedSquares", /** - * Edo language. + * Represents a border with twisted lines design (variant 1). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - edo = "Edo", + twistedLines1 = "TwistedLines1", /** - * Australian English language. + * Represents a border with waveline design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - englishAUS = "EnglishAUS", + waveline = "Waveline", /** - * Belize English language. + * Represents a border with quadrants design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - englishBelize = "EnglishBelize", + quadrants = "Quadrants", /** - * Canadian English language. + * Represents a border with colored checked bar design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - englishCanadian = "EnglishCanadian", + checkedBarColor = "CheckedBarColor", /** - * Caribbean English language. + * Represents a border with swirligig design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - englishCaribbean = "EnglishCaribbean", + swirligig = "Swirligig", /** - * Indonesian English language. + * Represents a border with push pin note design (variant 1). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - englishIndonesia = "EnglishIndonesia", + pushPinNote1 = "PushPinNote1", /** - * Irish English language. + * Represents a border with push pin note design (variant 2). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - englishIreland = "EnglishIreland", + pushPinNote2 = "PushPinNote2", /** - * Jamaican English language. + * Represents a border with pumpkin design (variant 1). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - englishJamaica = "EnglishJamaica", + pumpkin1 = "Pumpkin1", /** - * New Zealand English language. + * Represents a border with black eggs design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - englishNewZealand = "EnglishNewZealand", + eggsBlack = "EggsBlack", /** - * Filipino English language. + * Represents a border with cup design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - englishPhilippines = "EnglishPhilippines", + cup = "Cup", /** - * South African English language. + * Represents a border with gray heart design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - englishSouthAfrica = "EnglishSouthAfrica", + heartGray = "HeartGray", /** - * Tobago Trinidad English language. + * Represents a border with gingerbread man design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - englishTrinidadTobago = "EnglishTrinidadTobago", + gingerbreadMan = "GingerbreadMan", /** - * United Kingdom English language. + * Represents a border with baby pacifier design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - englishUK = "EnglishUK", + babyPacifier = "BabyPacifier", /** - * United States English language. + * Represents a border with baby rattle design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - englishUS = "EnglishUS", + babyRattle = "BabyRattle", /** - * Zimbabwe English language. + * Represents a border with cabins design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - englishZimbabwe = "EnglishZimbabwe", + cabins = "Cabins", /** - * Estonian language. + * Represents a border with funky house design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - estonian = "Estonian", + houseFunky = "HouseFunky", /** - * Faeroese language. + * Represents a border with black stars design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - faeroese = "Faeroese", + starsBlack = "StarsBlack", /** - * Filipino language. + * Represents a border with snowflakes design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - filipino = "Filipino", + snowflakes = "Snowflakes", /** - * Finnish language. + * Represents a border with fancy snowflake design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - finnish = "Finnish", + snowflakeFancy = "SnowflakeFancy", /** - * French language. + * Represents a border with skyrocket design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - french = "French", + skyrocket = "Skyrocket", /** - * French Cameroon language. + * Represents a border with Seattle design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - frenchCameroon = "FrenchCameroon", + seattle = "Seattle", /** - * French Canadian language. + * Represents a border with music notes design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - frenchCanadian = "FrenchCanadian", + musicNotes = "MusicNotes", /** - * French (Congo (DRC)) language. + * Represents a border with black palms design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - frenchCongoDRC = "FrenchCongoDRC", + palmsBlack = "PalmsBlack", /** - * French Cote d'Ivoire language. + * Represents a border with maple leaf design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - frenchCotedIvoire = "FrenchCotedIvoire", + mapleLeaf = "MapleLeaf", /** - * French Haiti language. + * Represents a border with paper clips design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - frenchHaiti = "FrenchHaiti", + paperClips = "PaperClips", /** - * French Luxembourg language. + * Represents a border with shorebird tracks design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - frenchLuxembourg = "FrenchLuxembourg", + shorebirdTracks = "ShorebirdTracks", /** - * French Mali language. + * Represents a border with people design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - frenchMali = "FrenchMali", + people = "People", /** - * French Monaco language. + * Represents a border with people waving design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - frenchMonaco = "FrenchMonaco", + peopleWaving = "PeopleWaving", /** - * French Morocco language. + * Represents a border with eclipsing squares design (variant 2). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - frenchMorocco = "FrenchMorocco", + eclipsingSquares2 = "EclipsingSquares2", /** - * French Reunion language. + * Represents a border with hypnotic design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - frenchReunion = "FrenchReunion", + hypnotic = "Hypnotic", /** - * French Senegal language. + * Represents a border with gray diamonds design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - frenchSenegal = "FrenchSenegal", + diamondsGray = "DiamondsGray", /** - * French West Indies language. + * Represents a border with deco arch design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - frenchWestIndies = "FrenchWestIndies", + decoArch = "DecoArch", /** - * Frisian Netherlands language. + * Represents a border with deco blocks design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - frisianNetherlands = "FrisianNetherlands", + decoBlocks = "DecoBlocks", /** - * Fulfulde language. + * Represents a border with circles and lines design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fulfulde = "Fulfulde", + circlesLines = "CirclesLines", /** - * Irish (Irish) language. + * Represents a border with papyrus design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gaelicIreland = "GaelicIreland", + papyrus = "Papyrus", /** - * Scottish Gaelic language. + * Represents a border with woodwork design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gaelicScotland = "GaelicScotland", + woodwork = "Woodwork", /** - * Galician language. + * Represents a border with weaving braid design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - galician = "Galician", + weavingBraid = "WeavingBraid", /** - * Georgian language. + * Represents a border with weaving ribbon design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - georgian = "Georgian", + weavingRibbon = "WeavingRibbon", /** - * German language. + * Represents a border with weaving angles design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - german = "German", + weavingAngles = "WeavingAngles", /** - * German Austrian language. + * Represents a border with arched scallops design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - germanAustria = "GermanAustria", + archedScallops = "ArchedScallops", /** - * German Liechtenstein language. + * Represents a border with safari design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - germanLiechtenstein = "GermanLiechtenstein", + safari = "Safari", /** - * German Luxembourg language. + * Represents a border with Celtic knotwork design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - germanLuxembourg = "GermanLuxembourg", + celticKnotwork = "CelticKnotwork", /** - * Greek language. + * Represents a border with crazy maze design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - greek = "Greek", + crazyMaze = "CrazyMaze", /** - * Guarani language. + * Represents a border with eclipsing squares design (variant 1). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - guarani = "Guarani", + eclipsingSquares1 = "EclipsingSquares1", /** - * Gujarati language. + * Represents a border with birds design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gujarati = "Gujarati", + birds = "Birds", /** - * Hausa language. + * Represents a border with teacup and flowers design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hausa = "Hausa", + flowersTeacup = "FlowersTeacup", /** - * Hawaiian language. + * Represents a border with northwest design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hawaiian = "Hawaiian", + northwest = "Northwest", /** - * Hebrew language. + * Represents a border with southwest design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hebrew = "Hebrew", + southwest = "Southwest", /** - * Hindi language. + * Represents a border with tribal design (variant 6). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hindi = "Hindi", + tribal6 = "Tribal6", /** - * Hungarian language. + * Represents a border with tribal design (variant 4). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hungarian = "Hungarian", + tribal4 = "Tribal4", /** - * Ibibio language. + * Represents a border with tribal design (variant 3). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - ibibio = "Ibibio", + tribal3 = "Tribal3", /** - * Icelandic language. + * Represents a border with tribal design (variant 2). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - icelandic = "Icelandic", + tribal2 = "Tribal2", /** - * Igbo language. + * Represents a border with tribal design (variant 5). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - igbo = "Igbo", + tribal5 = "Tribal5", /** - * Indonesian language. + * Represents a border with X illusions design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - indonesian = "Indonesian", + xillusions = "XIllusions", /** - * Inuktitut language. + * Represents a border with zany triangles design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - inuktitut = "Inuktitut", + zanyTriangles = "ZanyTriangles", /** - * Italian language. + * Represents a border with pyramids design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - italian = "Italian", + pyramids = "Pyramids", /** - * Japanese language. + * Represents a border with pyramids above design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - japanese = "Japanese", + pyramidsAbove = "PyramidsAbove", /** - * Kannada language. + * Represents a border with gray confetti design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - kannada = "Kannada", + confettiGrays = "ConfettiGrays", /** - * Kanuri language. + * Represents a border with outline confetti design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - kanuri = "Kanuri", + confettiOutline = "ConfettiOutline", /** - * Kashmiri language. + * Represents a border with white confetti design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - kashmiri = "Kashmiri", + confettiWhite = "ConfettiWhite", /** - * Kazakh language. + * Represents a border with mosaic design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - kazakh = "Kazakh", + mosaic = "Mosaic", /** - * Khmer language. + * Represents a border with lightning design (variant 2). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - khmer = "Khmer", + lightning2 = "Lightning2", /** - * Kirghiz language. + * Represents a border with heebie jeebies design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - kirghiz = "Kirghiz", + heebieJeebies = "HeebieJeebies", /** - * Konkani language. + * Represents a border with light bulb design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - konkani = "Konkani", + lightBulb = "LightBulb", /** - * Korean language. + * Represents a border with gradient design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - korean = "Korean", + gradient = "Gradient", /** - * Kyrgyz language. + * Represents a border with triangle party design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - kyrgyz = "Kyrgyz", + triangleParty = "TriangleParty", /** - * No specified language. + * Represents a border with twisted lines design (variant 2). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageNone = "LanguageNone", + twistedLines2 = "TwistedLines2", /** - * Lao language. + * Represents a border with moons design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lao = "Lao", + moons = "Moons", /** - * Latin language. + * Represents a border with ovals design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - latin = "Latin", + ovals = "Ovals", /** - * Latvian language. + * Represents a border with double diamonds design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - latvian = "Latvian", + doubleDiamonds = "DoubleDiamonds", /** - * Lithuanian language. + * Represents a border with chain link design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lithuanian = "Lithuanian", + chainLink = "ChainLink", /** - * Macedonian language. + * Represents a border with triangles design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - macedonianFYROM = "MacedonianFYROM", + triangles = "Triangles", /** - * Malayalam language. + * Represents a border with tribal design (variant 1). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - malayalam = "Malayalam", + tribal1 = "Tribal1", /** - * Malay Brunei Darussalam language. + * Represents a border with marquee toothed design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - malayBruneiDarussalam = "MalayBruneiDarussalam", + marqueeToothed = "MarqueeToothed", /** - * Malaysian language. + * Represents a border with sharks teeth design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - malaysian = "Malaysian", + sharksTeeth = "SharksTeeth", /** - * Maltese language. + * Represents a border with sawtooth design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - maltese = "Maltese", + sawtooth = "Sawtooth", /** - * Manipuri language. + * Represents a border with gray sawtooth design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - manipuri = "Manipuri", + sawtoothGray = "SawtoothGray", /** - * Marathi language. + * Represents a border with postage stamp design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - marathi = "Marathi", + postageStamp = "PostageStamp", /** - * Mexican Spanish language. + * Represents a border with weaving strips design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mexicanSpanish = "MexicanSpanish", + weavingStrips = "WeavingStrips", /** - * Mongolian language. + * Represents a border with zigzag design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mongolian = "Mongolian", + zigZag = "ZigZag", /** - * Nepali language. + * Represents a border with cross stitch design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nepali = "Nepali", + crossStitch = "CrossStitch", /** - * Disables proofing if the language ID identifies a language in which an object is grammatically validated using the Microsoft Word proofing tools. + * Represents a border with gems design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - noProofing = "NoProofing", + gems = "Gems", /** - * Norwegian Bokmol language. + * Represents a border with circles and rectangles design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - norwegianBokmol = "NorwegianBokmol", + circlesRectangles = "CirclesRectangles", /** - * Norwegian Nynorsk language. + * Represents a border with corner triangles design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - norwegianNynorsk = "NorwegianNynorsk", + cornerTriangles = "CornerTriangles", /** - * Odia (Oriya) language. + * Represents a border with insects creatures design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - oriya = "Oriya", + creaturesInsects = "CreaturesInsects", /** - * Oromo language. + * Represents a border with zigzag stitch design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - oromo = "Oromo", + zigZagStitch = "ZigZagStitch", /** - * Pashto language. + * Represents a border with checkered design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pashto = "Pashto", + checkered = "Checkered", /** - * Persian language. + * Represents a border with black checked bar design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - persian = "Persian", + checkedBarBlack = "CheckedBarBlack", /** - * Polish language. + * Represents a border with marquee design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - polish = "Polish", + marquee = "Marquee", /** - * Portuguese language. + * Represents a border with basic white dots design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - portuguese = "Portuguese", + basicWhiteDots = "BasicWhiteDots", /** - * Portuguese (Brazil) language. + * Represents a border with basic wide midline design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - portugueseBrazil = "PortugueseBrazil", + basicWideMidline = "BasicWideMidline", /** - * Punjabi language. + * Represents a border with basic wide outline design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - punjabi = "Punjabi", + basicWideOutline = "BasicWideOutline", /** - * Rhaeto Romanic language. + * Represents a border with basic wide inline design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rhaetoRomanic = "RhaetoRomanic", + basicWideInline = "BasicWideInline", /** - * Romanian language. + * Represents a border with basic thin lines design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - romanian = "Romanian", + basicThinLines = "BasicThinLines", /** - * Romanian Moldova language. + * Represents a border with basic white dashes design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - romanianMoldova = "RomanianMoldova", + basicWhiteDashes = "BasicWhiteDashes", /** - * Russian language. + * Represents a border with basic white squares design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - russian = "Russian", + basicWhiteSquares = "BasicWhiteSquares", /** - * Russian Moldova language. + * Represents a border with basic black squares design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - russianMoldova = "RussianMoldova", + basicBlackSquares = "BasicBlackSquares", /** - * Sami Lappish language. + * Represents a border with basic black dashes design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - samiLappish = "SamiLappish", + basicBlackDashes = "BasicBlackDashes", /** - * Sanskrit language. + * Represents a border with basic black dots design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sanskrit = "Sanskrit", + basicBlackDots = "BasicBlackDots", /** - * Serbian Cyrillic language. + * Represents a border with top stars design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - serbianCyrillic = "SerbianCyrillic", + starsTop = "StarsTop", /** - * Serbian Latin language. + * Represents a border with certificate banner design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - serbianLatin = "SerbianLatin", + certificateBanner = "CertificateBanner", /** - * Sesotho language. + * Represents a border with handmade design (variant 1). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sesotho = "Sesotho", + handmade1 = "Handmade1", /** - * Simplified Chinese language. + * Represents a border with handmade design (variant 2). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - simplifiedChinese = "SimplifiedChinese", + handmade2 = "Handmade2", /** - * Sindhi language. + * Represents a border with torn paper design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sindhi = "Sindhi", + tornPaper = "TornPaper", /** - * Sindhi (Pakistan) language. + * Represents a border with black torn paper design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sindhiPakistan = "SindhiPakistan", + tornPaperBlack = "TornPaperBlack", /** - * Sinhalese language. + * Represents a border with coupon cutout dashes design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sinhalese = "Sinhalese", + couponCutoutDashes = "CouponCutoutDashes", /** - * Slovakian language. + * Represents a border with coupon cutout dots design. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - slovak = "Slovak", + couponCutoutDots = "CouponCutoutDots", + } + /** + * Specifies the preferred unit of measure to use when measuring the width of an item. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PreferredWidthType { /** - * Slovenian language. + * Automatically select the unit of measure to use based on the current selection. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - slovenian = "Slovenian", + auto = "Auto", /** - * Somali language. + * Measure the current item width using a specified percentage. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - somali = "Somali", + percent = "Percent", /** - * Sorbian language. + * Measure the current item width using a specified number of points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sorbian = "Sorbian", + points = "Points", + } + /** + * Represents the reading order of text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ReadingOrder { /** - * Spanish language. + * Represents right-to-left reading order. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spanish = "Spanish", + rightToLeft = "RightToLeft", /** - * Spanish Argentina language. + * Represents left-to-right reading order. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spanishArgentina = "SpanishArgentina", + leftToRight = "LeftToRight", + } + /** + * Specifies the way Word adjusts the table when the left indent is changed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum RulerStyle { /** - * Spanish Bolivian language. + * Adjusts the left edge of row or rows, preserving the width of all columns by shifting them to the left or right. This is the default value. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spanishBolivia = "SpanishBolivia", + none = "None", /** - * Spanish Chilean language. + * Adjusts the left edge of the first column, preserving the position of the right edge of the table by proportionally adjusting the widths of all the cells in the specified row or rows. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spanishChile = "SpanishChile", + proportional = "Proportional", /** - * Spanish Colombian language. + * Adjusts the left edge of the first column only, preserving the positions of the other columns and the right edge of the table. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spanishColombia = "SpanishColombia", + firstColumn = "FirstColumn", /** - * Spanish Costa Rican language. + * Adjusts the left edge of the first column, preserving the position of the right edge of the table by setting the widths of all the cells in the specified row or rows to the same value. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spanishCostaRica = "SpanishCostaRica", + sameWidth = "SameWidth", + } + /** + * Represents the East Asian language to use when breaking lines of text in the specified document or template. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum FarEastLineBreakLanguageId { /** - * Spanish Dominican Republic language. + * Represents Traditional Chinese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spanishDominicanRepublic = "SpanishDominicanRepublic", + traditionalChinese = "TraditionalChinese", /** - * Spanish Ecuadorian language. + * Represents Japanese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spanishEcuador = "SpanishEcuador", + japanese = "Japanese", /** - * Spanish El Salvadorian language. + * Represents Korean language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spanishElSalvador = "SpanishElSalvador", + korean = "Korean", /** - * Spanish Guatemala language. + * Represents Simplified Chinese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spanishGuatemala = "SpanishGuatemala", + simplifiedChinese = "SimplifiedChinese", + } + /** + * Represents the level of line breaking to use for East Asian languages in the specified document or template. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum FarEastLineBreakLevel { /** - * Spanish Honduran language. + * Represents the normal line break level. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spanishHonduras = "SpanishHonduras", + normal = "Normal", /** - * Spanish Modern Sort language. + * Represents the strict line break level. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spanishModernSort = "SpanishModernSort", + strict = "Strict", /** - * Spanish Nicaraguan language. + * Represents the custom line break level. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spanishNicaragua = "SpanishNicaragua", + custom = "Custom", + } + /** + * Specifies the character spacing adjustment for a document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum JustificationMode { /** - * Spanish Panamanian language. + * Expands the character spacing * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spanishPanama = "SpanishPanama", + expand = "Expand", /** - * Spanish Paraguayan language. + * Compresses the character spacing. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spanishParaguay = "SpanishParaguay", + compress = "Compress", /** - * Spanish Peruvian language. + * Compresses the character spacing using rules of the kana syllabaries, Hiragana and Katakana. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spanishPeru = "SpanishPeru", + compressKana = "CompressKana", + } + /** + * Specifies the type of template. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum TemplateType { /** - * Spanish Puerto Rican language. + * Represents the normal template type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spanishPuertoRico = "SpanishPuertoRico", + normal = "Normal", /** - * Spanish Uruguayan language. + * Represents the global template type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spanishUruguay = "SpanishUruguay", + global = "Global", /** - * Spanish Venezuelan language. + * Represents the attached template type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spanishVenezuela = "SpanishVenezuela", + attached = "Attached", + } + /** + * Represents the language ID of a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum LanguageId { /** - * Sutu language. + * Afrikaans language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sutu = "Sutu", + afrikaans = "Afrikaans", /** - * Swahili language. + * Albanian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - swahili = "Swahili", + albanian = "Albanian", /** - * Swedish language. + * Amharic language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - swedish = "Swedish", + amharic = "Amharic", /** - * Swedish Finnish language. + * Arabic language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - swedishFinland = "SwedishFinland", + arabic = "Arabic", /** - * Swiss French language. + * Arabic Algerian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - swissFrench = "SwissFrench", + arabicAlgeria = "ArabicAlgeria", /** - * Swiss German language. + * Arabic Bahraini language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - swissGerman = "SwissGerman", + arabicBahrain = "ArabicBahrain", /** - * Swiss Italian language. + * Arabic Egyptian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - swissItalian = "SwissItalian", + arabicEgypt = "ArabicEgypt", /** - * Syriac language. + * Arabic Iraqi language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - syriac = "Syriac", + arabicIraq = "ArabicIraq", /** - * Tajik language. + * Arabic Jordanian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tajik = "Tajik", + arabicJordan = "ArabicJordan", /** - * Tamazight language. + * Arabic Kuwaiti language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tamazight = "Tamazight", + arabicKuwait = "ArabicKuwait", /** - * Tamazight Latin language. + * Arabic Lebanese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tamazightLatin = "TamazightLatin", + arabicLebanon = "ArabicLebanon", /** - * Tamil language. + * Arabic Libyan language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tamil = "Tamil", + arabicLibya = "ArabicLibya", /** - * Tatar language. + * Arabic Moroccan language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tatar = "Tatar", + arabicMorocco = "ArabicMorocco", /** - * Telugu language. + * Arabic Omani language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - telugu = "Telugu", + arabicOman = "ArabicOman", /** - * Thai language. + * Arabic Qatari language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thai = "Thai", + arabicQatar = "ArabicQatar", /** - * Tibetan language. + * Arabic Syrian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tibetan = "Tibetan", + arabicSyria = "ArabicSyria", /** - * Tigrigna Eritrea language. + * Arabic Tunisian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tigrignaEritrea = "TigrignaEritrea", + arabicTunisia = "ArabicTunisia", /** - * Tigrigna Ethiopic language. + * Arabic United Arab Emirates language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tigrignaEthiopic = "TigrignaEthiopic", + arabicUAE = "ArabicUAE", /** - * Traditional Chinese language. + * Arabic Yemeni language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - traditionalChinese = "TraditionalChinese", + arabicYemen = "ArabicYemen", /** - * Tsonga language. + * Armenian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tsonga = "Tsonga", + armenian = "Armenian", /** - * Tswana language. + * Assamese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tswana = "Tswana", + assamese = "Assamese", /** - * Turkish language. + * Azerbaijani Cyrillic language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - turkish = "Turkish", + azeriCyrillic = "AzeriCyrillic", /** - * Turkmen language. + * Azerbaijani Latin language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - turkmen = "Turkmen", + azeriLatin = "AzeriLatin", /** - * Ukrainian language. + * Basque (Basque). * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - ukrainian = "Ukrainian", + basque = "Basque", /** - * Urdu language. + * Belgian Dutch language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - urdu = "Urdu", + belgianDutch = "BelgianDutch", /** - * Uzbek Cyrillic language. + * Belgian French language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - uzbekCyrillic = "UzbekCyrillic", + belgianFrench = "BelgianFrench", /** - * Uzbek Latin language. + * Bengali language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - uzbekLatin = "UzbekLatin", + bengali = "Bengali", /** - * Venda language. + * Bulgarian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - venda = "Venda", + bulgarian = "Bulgarian", /** - * Vietnamese language. + * Burmese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - vietnamese = "Vietnamese", + burmese = "Burmese", /** - * Welsh language. + * Belarusian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - welsh = "Welsh", + belarusian = "Belarusian", /** - * Xhosa language. + * Catalan language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xhosa = "Xhosa", + catalan = "Catalan", /** - * Yi language. + * Cherokee language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - yi = "Yi", + cherokee = "Cherokee", /** - * Yiddish language. + * Chinese Hong Kong SAR language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - yiddish = "Yiddish", + chineseHongKongSAR = "ChineseHongKongSAR", /** - * Yoruba language. + * Chinese Macao SAR language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - yoruba = "Yoruba", + chineseMacaoSAR = "ChineseMacaoSAR", /** - * Zulu language. + * Chinese Singapore language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - zulu = "Zulu", - } - /** - * Specifies how a building block is inserted into a document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum DocPartInsertType { + chineseSingapore = "ChineseSingapore", /** - * Inserts the content of the building block. + * Croatian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - content = "Content", + croatian = "Croatian", /** - * Inserts the building block as a paragraph. + * Czech language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - paragraph = "Paragraph", + czech = "Czech", /** - * Inserts the building block as a page. + * Danish language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - page = "Page", - } - /** - * Specifies the type of building block. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum BuildingBlockType { + danish = "Danish", /** - * Represents Quick Parts building block type. + * Divehi language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - quickParts = "QuickParts", + divehi = "Divehi", /** - * Represents Cover Page building block type. + * Dutch language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - coverPage = "CoverPage", + dutch = "Dutch", /** - * Represents Equations building block type. + * Edo language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - equations = "Equations", + edo = "Edo", /** - * Represents Footers building block type. + * Australian English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footers = "Footers", + englishAUS = "EnglishAUS", /** - * Represents Headers building block type. + * Belize English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - headers = "Headers", + englishBelize = "EnglishBelize", /** - * Represents Page Number building block type. + * Canadian English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageNumber = "PageNumber", + englishCanadian = "EnglishCanadian", /** - * Represents Tables building block type. + * Caribbean English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tables = "Tables", + englishCaribbean = "EnglishCaribbean", /** - * Represents Watermarks building block type. + * Indonesian English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - watermarks = "Watermarks", + englishIndonesia = "EnglishIndonesia", /** - * Represents AutoText building block type. + * Irish English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - autoText = "AutoText", + englishIreland = "EnglishIreland", /** - * Represents Text Box building block type. + * Jamaican English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textBox = "TextBox", + englishJamaica = "EnglishJamaica", /** - * Represents Page Number Top building block type. + * New Zealand English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageNumberTop = "PageNumberTop", + englishNewZealand = "EnglishNewZealand", /** - * Represents Page Number Bottom building block type. + * Filipino English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageNumberBottom = "PageNumberBottom", + englishPhilippines = "EnglishPhilippines", /** - * Represents Page Number Page building block type. + * South African English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageNumberPage = "PageNumberPage", + englishSouthAfrica = "EnglishSouthAfrica", /** - * Represents Table of Contents building block type. + * Tobago Trinidad English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tableOfContents = "TableOfContents", + englishTrinidadTobago = "EnglishTrinidadTobago", /** - * Represents Custom Quick Parts building block type. + * United Kingdom English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customQuickParts = "CustomQuickParts", + englishUK = "EnglishUK", /** - * Represents Custom Cover Page building block type. + * United States English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customCoverPage = "CustomCoverPage", + englishUS = "EnglishUS", /** - * Represents Custom Equations building block type. + * Zimbabwe English language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customEquations = "CustomEquations", + englishZimbabwe = "EnglishZimbabwe", /** - * Represents Custom Footers building block type. + * Estonian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customFooters = "CustomFooters", + estonian = "Estonian", /** - * Represents Custom Headers building block type. + * Faeroese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customHeaders = "CustomHeaders", + faeroese = "Faeroese", /** - * Represents Custom Page Number building block type. + * Filipino language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customPageNumber = "CustomPageNumber", + filipino = "Filipino", /** - * Represents Custom Tables building block type. + * Finnish language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customTables = "CustomTables", + finnish = "Finnish", /** - * Represents Custom Watermarks building block type. + * French language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customWatermarks = "CustomWatermarks", + french = "French", /** - * Represents Custom AutoText building block type. + * French Cameroon language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customAutoText = "CustomAutoText", + frenchCameroon = "FrenchCameroon", /** - * Represents Custom Text Box building block type. + * French Canadian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customTextBox = "CustomTextBox", + frenchCanadian = "FrenchCanadian", /** - * Represents Custom Page Number Top building block type. + * French (Congo (DRC)) language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customPageNumberTop = "CustomPageNumberTop", + frenchCongoDRC = "FrenchCongoDRC", /** - * Represents Custom Page Number Bottom building block type. + * French Cote d'Ivoire language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customPageNumberBottom = "CustomPageNumberBottom", + frenchCotedIvoire = "FrenchCotedIvoire", /** - * Represents Custom Page Number Page building block type. + * French Haiti language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customPageNumberPage = "CustomPageNumberPage", + frenchHaiti = "FrenchHaiti", /** - * Represents Custom Table of Contents building block type. + * French Luxembourg language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customTableOfContents = "CustomTableOfContents", + frenchLuxembourg = "FrenchLuxembourg", /** - * Represents Custom building block type 1. + * French Mali language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - custom1 = "Custom1", + frenchMali = "FrenchMali", /** - * Represents Custom building block type 2. + * French Monaco language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - custom2 = "Custom2", + frenchMonaco = "FrenchMonaco", /** - * Represents Custom building block type 3. + * French Morocco language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - custom3 = "Custom3", + frenchMorocco = "FrenchMorocco", /** - * Represents Custom building block type 4. + * French Reunion language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - custom4 = "Custom4", + frenchReunion = "FrenchReunion", /** - * Represents Custom building block type 5. + * French Senegal language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - custom5 = "Custom5", + frenchSenegal = "FrenchSenegal", /** - * Represents Bibliography building block type. + * French West Indies language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bibliography = "Bibliography", + frenchWestIndies = "FrenchWestIndies", /** - * Represents Custom Bibliography building block type. + * Frisian Netherlands language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customBibliography = "CustomBibliography", - } - /** - * Represents the type of a {@link Word.CustomXmlValidationError}. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum CustomXmlValidationErrorType { + frisianNetherlands = "FrisianNetherlands", /** - * Represents a validation error generated by the schema. + * Fulfulde language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - schemaGenerated = "schemaGenerated", + fulfulde = "Fulfulde", /** - * Represents a validation error that is automatically cleared. + * Irish (Irish) language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - automaticallyCleared = "automaticallyCleared", + gaelicIreland = "GaelicIreland", /** - * Represents a validation error that is manually created. + * Scottish Gaelic language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - manual = "manual", - } - /** - * Represents the type of a {@link Word.CustomXmlNode}. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum CustomXmlNodeType { + gaelicScotland = "GaelicScotland", /** - * Represents an XML element node. + * Galician language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - element = "element", + galician = "Galician", /** - * Represents an XML attribute node. + * Georgian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - attribute = "attribute", + georgian = "Georgian", /** - * Represents an XML text node. + * German language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - text = "text", + german = "German", /** - * Represents an XML CDATA section node. + * German Austrian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cData = "cData", + germanAustria = "GermanAustria", /** - * Represents an XML processing instruction node. + * German Liechtenstein language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - processingInstruction = "processingInstruction", + germanLiechtenstein = "GermanLiechtenstein", /** - * Represents an XML comment node. + * German Luxembourg language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - comment = "comment", + germanLuxembourg = "GermanLuxembourg", /** - * Represents an XML document node. + * Greek language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - document = "document", - } - /** - * Specifies the type of link. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum LinkType { + greek = "Greek", /** - * OLE object. + * Guarani language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - ole = "Ole", + guarani = "Guarani", /** - * Picture. + * Gujarati language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - picture = "Picture", + gujarati = "Gujarati", /** - * Text. + * Hausa language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - text = "Text", + hausa = "Hausa", /** - * Reference library. + * Hawaiian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - reference = "Reference", + hawaiian = "Hawaiian", /** - * Include file. + * Hebrew language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - include = "Include", + hebrew = "Hebrew", /** - * Import file. + * Hindi language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - import = "Import", + hindi = "Hindi", /** - * Dynamic Data Exchange. + * Hungarian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dde = "Dde", + hungarian = "Hungarian", /** - * Automatic DDE. + * Ibibio language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - ddeAuto = "DdeAuto", + ibibio = "Ibibio", /** - * Microsoft Excel chart. + * Icelandic language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - chart = "Chart", - } - /** - * Specifies the action associated with the verb that the OLE object should perform. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum OleVerb { + icelandic = "Icelandic", /** - * Performs the verb that is invoked when the user double-clicks the object. + * Igbo language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - primary = "Primary", + igbo = "Igbo", /** - * Shows the object to the user for editing or viewing. Use it to show a newly inserted object for initial editing. + * Indonesian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - show = "Show", + indonesian = "Indonesian", /** - * Opens the object in a separate window. + * Inuktitut language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - open = "Open", + inuktitut = "Inuktitut", /** - * Removes the object's user interface from view. + * Italian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hide = "Hide", + italian = "Italian", /** - * Activates the object in place and displays any user-interface tools that the object needs, such as menus or toolbars. + * Japanese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - uiActivate = "UiActivate", + japanese = "Japanese", /** - * Runs the object and installs its window, but doesn't install any user-interface tools. + * Kannada language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - inPlaceActivate = "InPlaceActivate", + kannada = "Kannada", /** - * Forces the object to discard any undo state that it might be maintaining; note that the object remains active, however. + * Kanuri language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - discardUndoState = "DiscardUndoState", - } - /** - * Represents the list formatting characteristics of a range. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class ListFormat 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; + kanuri = "Kanuri", /** - * Returns a `List` object that represents the first formatted list contained in the `ListFormat` object. - * + * Kashmiri language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly list: Word.List; + kashmiri = "Kashmiri", /** - * Gets the list template associated with the `ListFormat` object. - * + * Kazakh language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly listTemplate: Word.ListTemplate; + kazakh = "Kazakh", /** - * Indicates whether the `ListFormat` object contains a single list. - * + * Khmer language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly isSingleList: boolean; + khmer = "Khmer", /** - * Indicates whether the `ListFormat` object contains a single list template. - * + * Kirghiz language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly isSingleListTemplate: boolean; + kirghiz = "Kirghiz", /** - * Specifies the list level number for the first paragraph for the `ListFormat` object. - * + * Konkani language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listLevelNumber: number; + konkani = "Konkani", /** - * Gets the string representation of the list value of the first paragraph in the range for the `ListFormat` object. - * + * Korean language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly listString: string; + korean = "Korean", /** - * Gets the type of the list for the `ListFormat` object. - * + * Kyrgyz language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly listType: Word.ListType | "ListNoNumbering" | "ListListNumOnly" | "ListBullet" | "ListSimpleNumbering" | "ListOutlineNumbering" | "ListMixedNumbering" | "ListPictureBullet"; + kyrgyz = "Kyrgyz", /** - * Gets the numeric value of the the first paragraph in the range for the `ListFormat` object. - * + * No specified language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly listValue: number; - /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. - */ - set(properties: Interfaces.ListFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ListFormat): void; + languageNone = "LanguageNone", /** - * Adds bullets and formatting to the paragraphs in the range. - * + * Lao language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param defaultListBehavior Optional. Specifies the default list behavior. Default is `DefaultListBehavior.word97`. */ - applyBulletDefault(defaultListBehavior: Word.DefaultListBehavior): void; + lao = "Lao", /** - * Adds bullets and formatting to the paragraphs in the range. - * + * Latin language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param defaultListBehavior Optional. Specifies the default list behavior. Default is `DefaultListBehavior.word97`. */ - applyBulletDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void; + latin = "Latin", /** - * Applies a list template with a specific level to the paragraphs in the range. - * + * Latvian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param listTemplate The list template to apply. - * @param options Optional. Options for applying the list template, such as whether to continue the previous list or which part of the list to apply the template to. */ - applyListTemplateWithLevel(listTemplate: Word.ListTemplate, options?: Word.ListTemplateApplyOptions): void; + latvian = "Latvian", /** - * Adds numbering and formatting to the paragraphs in the range. - * + * Lithuanian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param defaultListBehavior Optional. Specifies the default list behavior. */ - applyNumberDefault(defaultListBehavior: Word.DefaultListBehavior): void; + lithuanian = "Lithuanian", /** - * Adds numbering and formatting to the paragraphs in the range. - * + * Macedonian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param defaultListBehavior Optional. Specifies the default list behavior. */ - applyNumberDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void; + macedonianFYROM = "MacedonianFYROM", /** - * Adds outline numbering and formatting to the paragraphs in the range. - * + * Malayalam language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param defaultListBehavior Optional. Specifies the default list behavior. */ - applyOutlineNumberDefault(defaultListBehavior: Word.DefaultListBehavior): void; + malayalam = "Malayalam", /** - * Adds outline numbering and formatting to the paragraphs in the range. - * + * Malay Brunei Darussalam language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param defaultListBehavior Optional. Specifies the default list behavior. */ - applyOutlineNumberDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void; + malayBruneiDarussalam = "MalayBruneiDarussalam", /** - * Determines whether the `ListFormat` object can continue a previous list. - * + * Malaysian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param listTemplate The list template to check. - * @returns A `Continue` value indicating whether continuation is possible. */ - canContinuePreviousList(listTemplate: Word.ListTemplate): OfficeExtension.ClientResult; + malaysian = "Malaysian", /** - * Converts numbers in the list to plain text. - * + * Maltese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param numberType Optional. The type of number to convert. */ - convertNumbersToText(numberType: Word.NumberType): void; + maltese = "Maltese", /** - * Converts numbers in the list to plain text. - * + * Manipuri language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param numberType Optional. The type of number to convert. */ - convertNumbersToText(numberType: "Paragraph" | "ListNum" | "AllNumbers"): void; + manipuri = "Manipuri", /** - * Counts the numbered items in the list. - * + * Marathi language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param options Optional. Options for counting numbered items, such as the type of number and the level to count. - * @returns The number of items. */ - countNumberedItems(options?: Word.ListFormatCountNumberedItemsOptions): OfficeExtension.ClientResult; + marathi = "Marathi", /** - * Indents the list by one level. - * + * Mexican Spanish language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listIndent(): void; + mexicanSpanish = "MexicanSpanish", /** - * Outdents the list by one level. - * + * Mongolian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listOutdent(): void; + mongolian = "Mongolian", /** - * Removes numbering from the list. - * + * Nepali language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param numberType Optional. The type of number to remove. */ - removeNumbers(numberType: Word.NumberType): void; + nepali = "Nepali", /** - * Removes numbering from the list. - * + * Disables proofing if the language ID identifies a language in which an object is grammatically validated using the Microsoft Word proofing tools. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param numberType Optional. The type of number to remove. - */ - removeNumbers(numberType: "Paragraph" | "ListNum" | "AllNumbers"): 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?: Word.Interfaces.ListFormatLoadOptions): Word.ListFormat; - /** - * 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[]): Word.ListFormat; - /** - * 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; - }): Word.ListFormat; - /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - track(): Word.ListFormat; - /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. - */ - untrack(): Word.ListFormat; + noProofing = "NoProofing", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ListFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListFormatData`) that contains shallow copies of any loaded child properties from the original object. + * Norwegian Bokmol language. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.ListFormatData; - } - /** - * Represents options for counting numbered items in a range. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface ListFormatCountNumberedItemsOptions { + norwegianBokmol = "NorwegianBokmol", /** - * If provided, specifies the level to count. The default value is 1. - * + * Norwegian Nynorsk language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - level?: number; + norwegianNynorsk = "NorwegianNynorsk", /** - * If provided, specifies the type of number to count. The default value is `Word.NumberType.paragraph`. - * + * Odia (Oriya) language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - numberType?: Word.NumberType | "Paragraph" | "ListNum" | "AllNumbers"; - } - /** - * Represents options for applying a list template to a range. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface ListTemplateApplyOptions { + oriya = "Oriya", /** - * If provided, specifies the level to apply in the list template. The default value is 1. - * + * Oromo language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - applyLevel?: number; + oromo = "Oromo", /** - * If provided, specifies which part of the list to apply the template to. The default value is `Word.ListApplyTo.wholeList`. - * + * Pashto language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - applyTo?: Word.ListApplyTo | "WholeList" | "ThisPointForward" | "Selection"; + pashto = "Pashto", /** - * If provided, specifies whether to continue the previous list. The default value is `false`. - * + * Persian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - continuePreviousList?: boolean; + persian = "Persian", /** - * If provided, specifies the default list behavior. The default value is `DefaultListBehavior.word97`. - * + * Polish language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - defaultListBehavior?: Word.DefaultListBehavior | "Word97" | "Word2000" | "Word2002"; - } - /** - * Represents the fill formatting for a shape or text. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class FillFormat 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; + polish = "Polish", /** - * Returns a `ColorFormat` object that represents the background color for the fill. - * + * Portuguese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly backgroundColor: Word.ColorFormat; + portuguese = "Portuguese", /** - * Returns a `ColorFormat` object that represents the foreground color for the fill. - * + * Portuguese (Brazil) language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly foregroundColor: Word.ColorFormat; + portugueseBrazil = "PortugueseBrazil", /** - * Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9. - * + * Punjabi language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gradientAngle: number; + punjabi = "Punjabi", /** - * Gets the gradient color type. - * + * Rhaeto Romanic language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly gradientColorType: Word.GradientColorType | "Mixed" | "OneColor" | "TwoColors" | "PresetColors" | "MultiColor"; + rhaetoRomanic = "RhaetoRomanic", /** - * Returns how dark or light a one-color gradient fill is. - A value of 0 means that black is mixed in with the shape's foreground color to form the gradient. - A value of 1 means that white is mixed in. - Values between 0 and 1 mean that a darker or lighter shade of the foreground color is mixed in. - * + * Romanian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly gradientDegree: number; + romanian = "Romanian", /** - * Returns the gradient style for the fill. - * + * Romanian Moldova language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly gradientStyle: Word.GradientStyle | "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter"; + romanianMoldova = "RomanianMoldova", /** - * Returns the gradient variant for the fill as an integer value from 1 to 4 for most gradient fills. - * + * Russian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly gradientVariant: number; + russian = "Russian", /** - * Specifies if the object, or the formatting applied to it, is visible. - * + * Russian Moldova language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible: boolean; + russianMoldova = "RussianMoldova", /** - * Returns a `PatternType` value that represents the pattern applied to the fill or line. - * + * Sami Lappish language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly pattern: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"; + samiLappish = "SamiLappish", /** - * Returns the preset gradient type for the fill. - * + * Sanskrit language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly presetGradientType: Word.PresetGradientType | "Mixed" | "EarlySunset" | "LateSunset" | "Nightfall" | "Daybreak" | "Horizon" | "Desert" | "Ocean" | "CalmWater" | "Fire" | "Fog" | "Moss" | "Peacock" | "Wheat" | "Parchment" | "Mahogany" | "Rainbow" | "RainbowII" | "Gold" | "GoldII" | "Brass" | "Chrome" | "ChromeII" | "Silver" | "Sapphire"; + sanskrit = "Sanskrit", /** - * Gets the preset texture. - * + * Serbian Cyrillic language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly presetTexture: Word.PresetTexture | "Mixed" | "Papyrus" | "Canvas" | "Denim" | "WovenMat" | "WaterDroplets" | "PaperBag" | "FishFossil" | "Sand" | "GreenMarble" | "WhiteMarble" | "BrownMarble" | "Granite" | "Newsprint" | "RecycledPaper" | "Parchment" | "Stationery" | "BlueTissuePaper" | "PinkTissuePaper" | "PurpleMesh" | "Bouquet" | "Cork" | "Walnut" | "Oak" | "MediumWood"; + serbianCyrillic = "SerbianCyrillic", /** - * Specifies whether the fill rotates with the shape. - * + * Serbian Latin language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotateWithObject: boolean; + serbianLatin = "SerbianLatin", /** - * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. - * + * Sesotho language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureAlignment: Word.TextureAlignment | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "Center" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; + sesotho = "Sesotho", /** - * Specifies the horizontal scaling factor for the texture fill. - * + * Simplified Chinese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureHorizontalScale: number; + simplifiedChinese = "SimplifiedChinese", /** - * Returns the name of the custom texture file for the fill. - * + * Sindhi language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly textureName: string; + sindhi = "Sindhi", /** - * Specifies the horizontal offset of the texture from the origin in points. - * + * Sindhi (Pakistan) language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureOffsetX: number; + sindhiPakistan = "SindhiPakistan", /** - * Specifies the vertical offset of the texture. - * + * Sinhalese language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureOffsetY: number; + sinhalese = "Sinhalese", /** - * Specifies whether the texture is tiled. - * + * Slovakian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureTile: boolean; + slovak = "Slovak", /** - * Returns the texture type for the fill. - * + * Slovenian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly textureType: Word.TextureType | "Mixed" | "Preset" | "UserDefined"; + slovenian = "Slovenian", /** - * Specifies the vertical scaling factor for the texture fill as a value between 0.0 and 1.0. - * + * Somali language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureVerticalScale: number; + somali = "Somali", /** - * Specifies the degree of transparency of the fill for a shape as a value between 0.0 (opaque) and 1.0 (clear). - * + * Sorbian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency: number; + sorbian = "Sorbian", /** - * Gets the fill format type. - * + * Spanish language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly type: Word.FillType | "Mixed" | "Solid" | "Patterned" | "Gradient" | "Textured" | "Background" | "Picture"; - /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. - */ - set(properties: Interfaces.FillFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.FillFormat): void; + spanish = "Spanish", /** - * Sets the fill to a one-color gradient. - * + * Spanish Argentina language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param style The gradient style. - * @param variant The gradient variant. Can be a value from 1 to 4. - * @param degree The gradient degree. Can be a value from `0.0` (dark) to `1.0` (light). */ - setOneColorGradient(style: Word.GradientStyle, variant: number, degree: number): void; + spanishArgentina = "SpanishArgentina", /** - * Sets the fill to a one-color gradient. - * + * Spanish Bolivian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param style The gradient style. - * @param variant The gradient variant. Can be a value from 1 to 4. - * @param degree The gradient degree. Can be a value from `0.0` (dark) to `1.0` (light). */ - setOneColorGradient(style: "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter", variant: number, degree: number): void; + spanishBolivia = "SpanishBolivia", /** - * Sets the fill to a pattern. - * + * Spanish Chilean language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - setPatterned(pattern: Word.PatternType): void; + spanishChile = "SpanishChile", /** - * Sets the fill to a pattern. - * + * Spanish Colombian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - setPatterned(pattern: "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"): void; + spanishColombia = "SpanishColombia", /** - * Sets the fill to a preset gradient. - The gradient style.The gradient variant. Can be a value from 1 to 4.The preset gradient type. - * + * Spanish Costa Rican language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - setPresetGradient(style: Word.GradientStyle, variant: number, presetGradientType: Word.PresetGradientType): void; + spanishCostaRica = "SpanishCostaRica", /** - * Sets the fill to a preset gradient. - The gradient style.The gradient variant. Can be a value from 1 to 4.The preset gradient type. - * + * Spanish Dominican Republic language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - setPresetGradient(style: "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter", variant: number, presetGradientType: "Mixed" | "EarlySunset" | "LateSunset" | "Nightfall" | "Daybreak" | "Horizon" | "Desert" | "Ocean" | "CalmWater" | "Fire" | "Fog" | "Moss" | "Peacock" | "Wheat" | "Parchment" | "Mahogany" | "Rainbow" | "RainbowII" | "Gold" | "GoldII" | "Brass" | "Chrome" | "ChromeII" | "Silver" | "Sapphire"): void; + spanishDominicanRepublic = "SpanishDominicanRepublic", /** - * Sets the fill to a preset texture. - * + * Spanish Ecuadorian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - setPresetTextured(presetTexture: Word.PresetTexture): void; + spanishEcuador = "SpanishEcuador", /** - * Sets the fill to a preset texture. - * + * Spanish El Salvadorian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - setPresetTextured(presetTexture: "Mixed" | "Papyrus" | "Canvas" | "Denim" | "WovenMat" | "WaterDroplets" | "PaperBag" | "FishFossil" | "Sand" | "GreenMarble" | "WhiteMarble" | "BrownMarble" | "Granite" | "Newsprint" | "RecycledPaper" | "Parchment" | "Stationery" | "BlueTissuePaper" | "PinkTissuePaper" | "PurpleMesh" | "Bouquet" | "Cork" | "Walnut" | "Oak" | "MediumWood"): void; + spanishElSalvador = "SpanishElSalvador", /** - * Sets the fill to a two-color gradient. - * + * Spanish Guatemala language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - setTwoColorGradient(style: Word.GradientStyle, variant: number): void; + spanishGuatemala = "SpanishGuatemala", /** - * Sets the fill to a two-color gradient. - * + * Spanish Honduran language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - setTwoColorGradient(style: "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter", variant: number): void; + spanishHonduras = "SpanishHonduras", /** - * Sets the fill to a uniform color. - * + * Spanish Modern Sort language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - solid(): 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?: Word.Interfaces.FillFormatLoadOptions): Word.FillFormat; - /** - * 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[]): Word.FillFormat; - /** - * 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; - }): Word.FillFormat; - /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. - */ - track(): Word.FillFormat; - /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. - */ - untrack(): Word.FillFormat; - /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.FillFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FillFormatData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.FillFormatData; - } - /** - * Represents the glow formatting for the font used by the range of text. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class GlowFormat 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; + spanishModernSort = "SpanishModernSort", /** - * Returns a `ColorFormat` object that represents the color for a glow effect. - * + * Spanish Nicaraguan language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly color: Word.ColorFormat; + spanishNicaragua = "SpanishNicaragua", /** - * Specifies the length of the radius for a glow effect. - * + * Spanish Panamanian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - radius: number; + spanishPanama = "SpanishPanama", /** - * Specifies the degree of transparency for the glow effect as a value between 0.0 (opaque) and 1.0 (clear). - * + * Spanish Paraguayan language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency: number; - /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. - */ - set(properties: Interfaces.GlowFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.GlowFormat): 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?: Word.Interfaces.GlowFormatLoadOptions): Word.GlowFormat; + spanishParaguay = "SpanishParaguay", /** - * 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. + * Spanish Peruvian language. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.GlowFormat; + spanishPeru = "SpanishPeru", /** - * 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. + * Spanish Puerto Rican language. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.GlowFormat; + spanishPuertoRico = "SpanishPuertoRico", /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + * Spanish Uruguayan language. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.GlowFormat; + spanishUruguay = "SpanishUruguay", /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + * Spanish Venezuelan language. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.GlowFormat; + spanishVenezuela = "SpanishVenezuela", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.GlowFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.GlowFormatData`) that contains shallow copies of any loaded child properties from the original object. + * Sutu language. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.GlowFormatData; - } - /** - * Represents line and arrowhead formatting. For a line, the `LineFormat` object contains formatting information for the line itself; - for a shape with a border, this object contains formatting information for the shape's border. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class LineFormat 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; + sutu = "Sutu", /** - * Gets a `ColorFormat` object that represents the background color for a patterned line. - * + * Swahili language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly backgroundColor: Word.ColorFormat; + swahili = "Swahili", /** - * Gets a `ColorFormat` object that represents the foreground color for the line. - * + * Swedish language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly foregroundColor: Word.ColorFormat; + swedish = "Swedish", /** - * Specifies the length of the arrowhead at the beginning of the line. - * + * Swedish Finnish language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - beginArrowheadLength: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; + swedishFinland = "SwedishFinland", /** - * Specifies the style of the arrowhead at the beginning of the line. - * + * Swiss French language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - beginArrowheadStyle: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; + swissFrench = "SwissFrench", /** - * Specifies the width of the arrowhead at the beginning of the line. - * + * Swiss German language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - beginArrowheadWidth: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; + swissGerman = "SwissGerman", /** - * Specifies the dash style for the line. - * + * Swiss Italian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashStyle: Word.LineDashStyle | "Mixed" | "Solid" | "SquareDot" | "RoundDot" | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "SysDash" | "SysDot" | "SysDashDot"; + swissItalian = "SwissItalian", /** - * Specifies the length of the arrowhead at the end of the line. - * + * Syriac language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endArrowheadLength: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; + syriac = "Syriac", /** - * Specifies the style of the arrowhead at the end of the line. - * + * Tajik language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endArrowheadStyle: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; + tajik = "Tajik", /** - * Specifies the width of the arrowhead at the end of the line. - * + * Tamazight language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endArrowheadWidth: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; + tamazight = "Tamazight", /** - * Specifies if to draw lines inside a shape. - * + * Tamazight Latin language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - insetPen: boolean; + tamazightLatin = "TamazightLatin", /** - * Specifies if the object, or the formatting applied to it, is visible. - * + * Tamil language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible: boolean; + tamil = "Tamil", /** - * Specifies the pattern applied to the line. - * + * Tatar language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pattern: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"; + tatar = "Tatar", /** - * Specifies the line format style. - * + * Telugu language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - style: Word.LineFormatStyle | "Mixed" | "Single" | "ThinThin" | "ThinThick" | "ThickThin" | "ThickBetweenThin"; + telugu = "Telugu", /** - * Specifies the degree of transparency of the line as a value between 0.0 (opaque) and 1.0 (clear). - * + * Thai language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency: number; + thai = "Thai", /** - * Specifies the thickness of the line in points. - * + * Tibetan language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - weight: number; + tibetan = "Tibetan", /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Tigrigna Eritrea language. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.LineFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.LineFormat): void; + tigrignaEritrea = "TigrignaEritrea", /** - * 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. + * Tigrigna Ethiopic language. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.LineFormatLoadOptions): Word.LineFormat; + tigrignaEthiopic = "TigrignaEthiopic", /** - * 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. + * Traditional Chinese language. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.LineFormat; + traditionalChinese = "TraditionalChinese", /** - * 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. + * Tsonga language. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.LineFormat; + tsonga = "Tsonga", /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + * Tswana language. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.LineFormat; + tswana = "Tswana", /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + * Turkish language. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.LineFormat; + turkish = "Turkish", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.LineFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.LineFormatData`) that contains shallow copies of any loaded child properties from the original object. + * Turkmen language. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.LineFormatData; - } - /** - * Represents the reflection formatting for a shape in Word. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class ReflectionFormat 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; + turkmen = "Turkmen", /** - * Specifies the degree of blur effect applied to the `ReflectionFormat` object as a value between 0.0 and 100.0. - * + * Ukrainian language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - blur: number; + ukrainian = "Ukrainian", /** - * Specifies the amount of separation, in points, of the reflected image from the shape. - * + * Urdu language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - offset: number; + urdu = "Urdu", /** - * Specifies the size of the reflection as a percentage of the reflected shape from 0 to 100. - * + * Uzbek Cyrillic language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - size: number; + uzbekCyrillic = "UzbekCyrillic", /** - * Specifies the degree of transparency for the reflection effect as a value between 0.0 (opaque) and 1.0 (clear). - * + * Uzbek Latin language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency: number; + uzbekLatin = "UzbekLatin", /** - * Specifies a `ReflectionType` value that represents the type and direction of the lighting for a shape reflection. - * + * Venda language. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type: Word.ReflectionType | "Mixed" | "None" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9"; + venda = "Venda", /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Vietnamese language. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.ReflectionFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ReflectionFormat): void; + vietnamese = "Vietnamese", /** - * 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. + * Welsh language. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.ReflectionFormatLoadOptions): Word.ReflectionFormat; + welsh = "Welsh", /** - * 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. + * Xhosa language. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.ReflectionFormat; + xhosa = "Xhosa", /** - * 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. + * Yi language. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.ReflectionFormat; + yi = "Yi", /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + * Yiddish language. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.ReflectionFormat; + yiddish = "Yiddish", /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + * Yoruba language. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.ReflectionFormat; + yoruba = "Yoruba", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ReflectionFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ReflectionFormatData`) that contains shallow copies of any loaded child properties from the original object. + * Zulu language. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.ReflectionFormatData; + zulu = "Zulu", } /** - * Represents the color formatting of a shape or text in Word. + * Specifies how a building block is inserted into a document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - class ColorFormat 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 DocPartInsertType { /** - * Specifies the brightness of a specified shape color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. - * + * Inserts the content of the building block. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - brightness: number; + content = "Content", /** - * Specifies the theme color for a color format. - * + * Inserts the building block as a paragraph. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - objectThemeColor: Word.ThemeColorIndex | "NotThemeColor" | "MainDark1" | "MainLight1" | "MainDark2" | "MainLight2" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Hyperlink" | "HyperlinkFollowed" | "Background1" | "Text1" | "Background2" | "Text2"; + paragraph = "Paragraph", /** - * Specifies the red-green-blue (RGB) value of the specified color. You can provide the value in the '#RRGGBB' format. - * + * Inserts the building block as a page. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rgb: string; + page = "Page", + } + /** + * Specifies the type of building block. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum BuildingBlockType { /** - * Specifies the lightening or darkening of a specified shape's color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. - * + * Represents Quick Parts building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tintAndShade: number; + quickParts = "QuickParts", /** - * Returns the shape color type. - * + * Represents Cover Page building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly type: Word.ColorType | "rgb" | "scheme"; + coverPage = "CoverPage", /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Represents Equations building block type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.ColorFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ColorFormat): void; + equations = "Equations", /** - * 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. + * Represents Footers building block type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.ColorFormatLoadOptions): Word.ColorFormat; + footers = "Footers", /** - * 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. + * Represents Headers building block type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.ColorFormat; + headers = "Headers", /** - * 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. + * Represents Page Number building block type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.ColorFormat; + pageNumber = "PageNumber", /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + * Represents Tables building block type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.ColorFormat; + tables = "Tables", /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + * Represents Watermarks building block type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.ColorFormat; + watermarks = "Watermarks", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ColorFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ColorFormatData`) that contains shallow copies of any loaded child properties from the original object. + * Represents AutoText building block type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.ColorFormatData; - } - /** - * Represents the shadow formatting for a shape or text in Word. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class ShadowFormat 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; + autoText = "AutoText", /** - * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. - * + * Represents Text Box building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly foregroundColor: Word.ColorFormat; + textBox = "TextBox", /** - * Specifies the blur level for a shadow format as a value between 0.0 and 100.0. - * + * Represents Page Number Top building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - blur: number; + pageNumberTop = "PageNumberTop", /** - * Specifies whether the object or the formatting applied to it is visible. - * + * Represents Page Number Bottom building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible: boolean; + pageNumberBottom = "PageNumberBottom", /** - * Specifies `true` if the shadow of the shape appears filled in and is obscured by the shape, even if the shape has no fill, - `false` if the shadow has no fill and the outline of the shadow is visible through the shape if the shape has no fill. - * + * Represents Page Number Page building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - obscured: boolean; + pageNumberPage = "PageNumberPage", /** - * Specifies the horizontal offset (in points) of the shadow from the shape. - A positive value offsets the shadow to the right of the shape; a negative value offsets it to the left. - * + * Represents Table of Contents building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - offsetX: number; + tableOfContents = "TableOfContents", /** - * Specifies the vertical offset (in points) of the shadow from the shape. - A positive value offsets the shadow to the top of the shape; a negative value offsets it to the bottom. - * + * Represents Custom Quick Parts building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - offsetY: number; + customQuickParts = "CustomQuickParts", /** - * Specifies whether to rotate the shadow when rotating the shape. - * + * Represents Custom Cover Page building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotateWithShape: boolean; + customCoverPage = "CustomCoverPage", /** - * Specifies the width of the shadow. - * + * Represents Custom Equations building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - size: number; + customEquations = "CustomEquations", /** - * Specifies the type of shadow formatting to apply to a shape. - * + * Represents Custom Footers building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - style: Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow"; + customFooters = "CustomFooters", /** - * Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear). - * + * Represents Custom Headers building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency: number; + customHeaders = "CustomHeaders", /** - * Specifies the shape shadow type. - * + * Represents Custom Page Number building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type: Word.ShadowType | "Mixed" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9" | "Type10" | "Type11" | "Type12" | "Type13" | "Type14" | "Type15" | "Type16" | "Type17" | "Type18" | "Type19" | "Type20" | "Type21" | "Type22" | "Type23" | "Type24" | "Type25" | "Type26" | "Type27" | "Type28" | "Type29" | "Type30" | "Type31" | "Type32" | "Type33" | "Type34" | "Type35" | "Type36" | "Type37" | "Type38" | "Type39" | "Type40" | "Type41" | "Type42" | "Type43"; + customPageNumber = "CustomPageNumber", /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Represents Custom Tables building block type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.ShadowFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ShadowFormat): void; + customTables = "CustomTables", /** - * Changes the horizontal offset of the shadow by the number of points. - Increment The number of points to adjust. - * + * Represents Custom Watermarks building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - incrementOffsetX(increment: number): void; + customWatermarks = "CustomWatermarks", /** - * Changes the vertical offset of the shadow by the specified number of points. - Increment The number of points to adjust. - * + * Represents Custom AutoText building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - incrementOffsetY(increment: number): void; + customAutoText = "CustomAutoText", /** - * 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. + * Represents Custom Text Box building block type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.ShadowFormatLoadOptions): Word.ShadowFormat; + customTextBox = "CustomTextBox", /** - * 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. + * Represents Custom Page Number Top building block type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.ShadowFormat; + customPageNumberTop = "CustomPageNumberTop", /** - * 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. + * Represents Custom Page Number Bottom building block type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.ShadowFormat; + customPageNumberBottom = "CustomPageNumberBottom", /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + * Represents Custom Page Number Page building block type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.ShadowFormat; + customPageNumberPage = "CustomPageNumberPage", /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + * Represents Custom Table of Contents building block type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.ShadowFormat; + customTableOfContents = "CustomTableOfContents", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ShadowFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShadowFormatData`) that contains shallow copies of any loaded child properties from the original object. + * Represents Custom building block type 1. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.ShadowFormatData; - } - /** - * Represents a shape's three-dimensional formatting. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class ThreeDimensionalFormat 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; + custom1 = "Custom1", /** - * Returns a `ColorFormat` object that represents color of the contour of a shape. - * + * Represents Custom building block type 2. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly contourColor: Word.ColorFormat; + custom2 = "Custom2", /** - * Returns a `ColorFormat` object that represents the color of the shape's extrusion. - * + * Represents Custom building block type 3. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly extrusionColor: Word.ColorFormat; + custom3 = "Custom3", /** - * Specifies the depth of the bottom bevel. - * + * Represents Custom building block type 4. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelBottomDepth: number; + custom4 = "Custom4", /** - * Specifies the inset size for the bottom bevel. - * + * Represents Custom building block type 5. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelBottomInset: number; + custom5 = "Custom5", /** - * Specifies a `BevelType` value that represents the bevel type for the bottom bevel. - * + * Represents Bibliography building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelBottomType: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; + bibliography = "Bibliography", /** - * Specifies the depth of the top bevel. - * + * Represents Custom Bibliography building block type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelTopDepth: number; + customBibliography = "CustomBibliography", + } + /** + * Represents the type of a {@link Word.CustomXmlValidationError}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum CustomXmlValidationErrorType { /** - * Specifies the inset size for the top bevel. - * + * Represents a validation error generated by the schema. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelTopInset: number; + schemaGenerated = "schemaGenerated", /** - * Specifies a `BevelType` value that represents the bevel type for the top bevel. - * + * Represents a validation error that is automatically cleared. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelTopType: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; + automaticallyCleared = "automaticallyCleared", /** - * Specifies the width of the contour of a shape. - * + * Represents a validation error that is manually created. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contourWidth: number; + manual = "manual", + } + /** + * Represents the type of a {@link Word.CustomXmlNode}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum CustomXmlNodeType { /** - * Specifies the depth of the shape's extrusion. - * + * Represents an XML element node. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - depth: number; + element = "element", /** - * Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion) - and automatically changes when the shape's fill changes, or whether the extrusion color is independent of the shape's fill. - * + * Represents an XML attribute node. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - extrusionColorType: Word.ExtrusionColorType | "mixed" | "automatic" | "custom"; + attribute = "attribute", /** - * Specifies the amount of perspective for a shape. - * + * Represents an XML text node. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fieldOfView: number; + text = "text", /** - * Specifies `true` if the extrusion appears in perspective — that is, if the walls of the extrusion narrow toward a vanishing point, - `false` if the extrusion is a parallel, or orthographic, projection — that is, if the walls don't narrow toward a vanishing point. - * + * Represents an XML CDATA section node. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isPerspective: boolean; + cData = "cData", /** - * Specifies if the specified object, or the formatting applied to it, is visible. - * + * Represents an XML processing instruction node. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible: boolean; + processingInstruction = "processingInstruction", /** - * Specifies the angle of the lighting. - * + * Represents an XML comment node. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lightAngle: number; + comment = "comment", /** - * Returns a `PresetCamera` value that represents the camera presets. - * + * Represents an XML document node. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly presetCamera: Word.PresetCamera | "Mixed" | "LegacyObliqueTopLeft" | "LegacyObliqueTop" | "LegacyObliqueTopRight" | "LegacyObliqueLeft" | "LegacyObliqueFront" | "LegacyObliqueRight" | "LegacyObliqueBottomLeft" | "LegacyObliqueBottom" | "LegacyObliqueBottomRight" | "LegacyPerspectiveTopLeft" | "LegacyPerspectiveTop" | "LegacyPerspectiveTopRight" | "LegacyPerspectiveLeft" | "LegacyPerspectiveFront" | "LegacyPerspectiveRight" | "LegacyPerspectiveBottomLeft" | "LegacyPerspectiveBottom" | "LegacyPerspectiveBottomRight" | "OrthographicFront" | "IsometricTopUp" | "IsometricTopDown" | "IsometricBottomUp" | "IsometricBottomDown" | "IsometricLeftUp" | "IsometricLeftDown" | "IsometricRightUp" | "IsometricRightDown" | "IsometricOffAxis1Left" | "IsometricOffAxis1Right" | "IsometricOffAxis1Top" | "IsometricOffAxis2Left" | "IsometricOffAxis2Right" | "IsometricOffAxis2Top" | "IsometricOffAxis3Left" | "IsometricOffAxis3Right" | "IsometricOffAxis3Bottom" | "IsometricOffAxis4Left" | "IsometricOffAxis4Right" | "IsometricOffAxis4Bottom" | "ObliqueTopLeft" | "ObliqueTop" | "ObliqueTopRight" | "ObliqueLeft" | "ObliqueRight" | "ObliqueBottomLeft" | "ObliqueBottom" | "ObliqueBottomRight" | "PerspectiveFront" | "PerspectiveLeft" | "PerspectiveRight" | "PerspectiveAbove" | "PerspectiveBelow" | "PerspectiveAboveLeftFacing" | "PerspectiveAboveRightFacing" | "PerspectiveContrastingLeftFacing" | "PerspectiveContrastingRightFacing" | "PerspectiveHeroicLeftFacing" | "PerspectiveHeroicRightFacing" | "PerspectiveHeroicExtremeLeftFacing" | "PerspectiveHeroicExtremeRightFacing" | "PerspectiveRelaxed" | "PerspectiveRelaxedModerately"; + document = "document", + } + /** + * Specifies the type of link. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum LinkType { /** - * Returns the direction taken by the extrusion's sweep path leading away from the extruded shape (the front face of the extrusion). - * + * OLE object. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly presetExtrusionDirection: Word.PresetExtrusionDirection | "Mixed" | "BottomRight" | "Bottom" | "BottomLeft" | "Right" | "None" | "Left" | "TopRight" | "Top" | "TopLeft"; + ole = "Ole", /** - * Specifies a `LightRigType` value that represents the lighting preset. - * + * Picture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetLighting: Word.LightRigType | "Mixed" | "LegacyFlat1" | "LegacyFlat2" | "LegacyFlat3" | "LegacyFlat4" | "LegacyNormal1" | "LegacyNormal2" | "LegacyNormal3" | "LegacyNormal4" | "LegacyHarsh1" | "LegacyHarsh2" | "LegacyHarsh3" | "LegacyHarsh4" | "ThreePoint" | "Balanced" | "Soft" | "Harsh" | "Flood" | "Contrasting" | "Morning" | "Sunrise" | "Sunset" | "Chilly" | "Freezing" | "Flat" | "TwoPoint" | "Glow" | "BrightRoom"; + picture = "Picture", /** - * Specifies the position of the light source relative to the extrusion. - * + * Text. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetLightingDirection: Word.PresetLightingDirection | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "None" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; + text = "Text", /** - * Specifies the intensity of the extrusion lighting. - * + * Reference library. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetLightingSoftness: Word.PresetLightingSoftness | "Mixed" | "Dim" | "Normal" | "Bright"; + reference = "Reference", /** - * Specifies the extrusion surface material. - * + * Include file. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetMaterial: Word.PresetMaterial | "Mixed" | "Matte" | "Plastic" | "Metal" | "WireFrame" | "Matte2" | "Plastic2" | "Metal2" | "WarmMatte" | "TranslucentPowder" | "Powder" | "DarkEdge" | "SoftEdge" | "Clear" | "Flat" | "SoftMetal"; + include = "Include", /** - * Returns the preset extrusion format. - * + * Import file. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly presetThreeDimensionalFormat: Word.PresetThreeDimensionalFormat | "Mixed" | "Format1" | "Format2" | "Format3" | "Format4" | "Format5" | "Format6" | "Format7" | "Format8" | "Format9" | "Format10" | "Format11" | "Format12" | "Format13" | "Format14" | "Format15" | "Format16" | "Format17" | "Format18" | "Format19" | "Format20"; + import = "Import", /** - * Specifies whether text on a shape rotates with shape. `true` rotates the text. - * + * Dynamic Data Exchange. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - projectText: boolean; + dde = "Dde", /** - * Specifies the rotation of the extruded shape around the x-axis in degrees. - * + * Automatic DDE. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotationX: number; + ddeAuto = "DdeAuto", /** - * Specifies the rotation of the extruded shape around the y-axis in degrees. - * + * Microsoft Excel chart. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotationY: number; + chart = "Chart", + } + /** + * Specifies the action associated with the verb that the OLE object should perform. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum OleVerb { /** - * Specifies the z-axis rotation of the camera. - * + * Performs the verb that is invoked when the user double-clicks the object. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotationZ: number; + primary = "Primary", /** - * Specifies the position on the z-axis for the shape. - * + * Shows the object to the user for editing or viewing. Use it to show a newly inserted object for initial editing. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - z: number; + show = "Show", /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Opens the object in a separate window. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.ThreeDimensionalFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.ThreeDimensionalFormat): void; + open = "Open", /** - * Horizontally rotates a shape on the x-axis. - The number of degrees to rotate. - * + * Removes the object's user interface from view. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - incrementRotationHorizontal(increment: number): void; + hide = "Hide", /** - * Vertically rotates a shape on the y-axis. - The number of degrees to rotate. - * + * Activates the object in place and displays any user-interface tools that the object needs, such as menus or toolbars. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - incrementRotationVertical(increment: number): void; + uiActivate = "UiActivate", /** - * Changes the rotation around the x-axis. - The number of degrees to rotate. - * + * Runs the object and installs its window, but doesn't install any user-interface tools. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - incrementRotationX(increment: number): void; + inPlaceActivate = "InPlaceActivate", /** - * Changes the rotation around the y-axis. - The number of degrees to rotate. - * + * Forces the object to discard any undo state that it might be maintaining; note that the object remains active, however. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - incrementRotationY(increment: number): void; + discardUndoState = "DiscardUndoState", + } + /** + * Represents the list formatting characteristics of a range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class ListFormat 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; /** - * Rotates a shape on the z-axis. - The number of degrees to rotate. + * Returns a `List` object that represents the first formatted list contained in the `ListFormat` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - incrementRotationZ(increment: number): void; + readonly list: Word.List; /** - * Resets the extrusion rotation around the x-axis, y-axis, and z-axis to 0. + * Gets the list template associated with the `ListFormat` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - resetRotation(): void; + readonly listTemplate: Word.ListTemplate; /** - * Sets the direction of the extrusion's sweep path. + * Indicates whether the `ListFormat` object contains a single list. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param presetExtrusionDirection The preset direction. */ - setExtrusionDirection(presetExtrusionDirection: Word.PresetExtrusionDirection): void; + readonly isSingleList: boolean; /** - * Sets the direction of the extrusion's sweep path. + * Indicates whether the `ListFormat` object contains a single list template. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param presetExtrusionDirection The preset direction. */ - setExtrusionDirection(presetExtrusionDirection: "Mixed" | "BottomRight" | "Bottom" | "BottomLeft" | "Right" | "None" | "Left" | "TopRight" | "Top" | "TopLeft"): void; + readonly isSingleListTemplate: boolean; /** - * Sets the camera preset for the shape. - The preset camera type. + * Specifies the list level number for the first paragraph for the `ListFormat` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - setPresetCamera(presetCamera: Word.PresetCamera): void; + listLevelNumber: number; /** - * Sets the camera preset for the shape. - The preset camera type. + * Gets the string representation of the list value of the first paragraph in the range for the `ListFormat` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - setPresetCamera(presetCamera: "Mixed" | "LegacyObliqueTopLeft" | "LegacyObliqueTop" | "LegacyObliqueTopRight" | "LegacyObliqueLeft" | "LegacyObliqueFront" | "LegacyObliqueRight" | "LegacyObliqueBottomLeft" | "LegacyObliqueBottom" | "LegacyObliqueBottomRight" | "LegacyPerspectiveTopLeft" | "LegacyPerspectiveTop" | "LegacyPerspectiveTopRight" | "LegacyPerspectiveLeft" | "LegacyPerspectiveFront" | "LegacyPerspectiveRight" | "LegacyPerspectiveBottomLeft" | "LegacyPerspectiveBottom" | "LegacyPerspectiveBottomRight" | "OrthographicFront" | "IsometricTopUp" | "IsometricTopDown" | "IsometricBottomUp" | "IsometricBottomDown" | "IsometricLeftUp" | "IsometricLeftDown" | "IsometricRightUp" | "IsometricRightDown" | "IsometricOffAxis1Left" | "IsometricOffAxis1Right" | "IsometricOffAxis1Top" | "IsometricOffAxis2Left" | "IsometricOffAxis2Right" | "IsometricOffAxis2Top" | "IsometricOffAxis3Left" | "IsometricOffAxis3Right" | "IsometricOffAxis3Bottom" | "IsometricOffAxis4Left" | "IsometricOffAxis4Right" | "IsometricOffAxis4Bottom" | "ObliqueTopLeft" | "ObliqueTop" | "ObliqueTopRight" | "ObliqueLeft" | "ObliqueRight" | "ObliqueBottomLeft" | "ObliqueBottom" | "ObliqueBottomRight" | "PerspectiveFront" | "PerspectiveLeft" | "PerspectiveRight" | "PerspectiveAbove" | "PerspectiveBelow" | "PerspectiveAboveLeftFacing" | "PerspectiveAboveRightFacing" | "PerspectiveContrastingLeftFacing" | "PerspectiveContrastingRightFacing" | "PerspectiveHeroicLeftFacing" | "PerspectiveHeroicRightFacing" | "PerspectiveHeroicExtremeLeftFacing" | "PerspectiveHeroicExtremeRightFacing" | "PerspectiveRelaxed" | "PerspectiveRelaxedModerately"): void; + readonly listString: string; /** - * Sets the preset extrusion format. - The preset format. + * Gets the type of the list for the `ListFormat` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - setThreeDimensionalFormat(presetThreeDimensionalFormat: Word.PresetThreeDimensionalFormat): void; + readonly listType: Word.ListType | "ListNoNumbering" | "ListListNumOnly" | "ListBullet" | "ListSimpleNumbering" | "ListOutlineNumbering" | "ListMixedNumbering" | "ListPictureBullet"; /** - * Sets the preset extrusion format. - The preset format. + * Gets the numeric value of the the first paragraph in the range for the `ListFormat` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - setThreeDimensionalFormat(presetThreeDimensionalFormat: "Mixed" | "Format1" | "Format2" | "Format3" | "Format4" | "Format5" | "Format6" | "Format7" | "Format8" | "Format9" | "Format10" | "Format11" | "Format12" | "Format13" | "Format14" | "Format15" | "Format16" | "Format17" | "Format18" | "Format19" | "Format20"): void; + readonly listValue: 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. + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - load(options?: Word.Interfaces.ThreeDimensionalFormatLoadOptions): Word.ThreeDimensionalFormat; + set(properties: Interfaces.ListFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ListFormat): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Adds bullets and formatting to the paragraphs in the range. * - * @param propertyNames A comma-delimited string or an array of strings that specify the properties to load. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param defaultListBehavior Optional. Specifies the default list behavior. Default is `DefaultListBehavior.word97`. */ - load(propertyNames?: string | string[]): Word.ThreeDimensionalFormat; + applyBulletDefault(defaultListBehavior: Word.DefaultListBehavior): void; /** - * Queues up a command to load the specified properties of the object. You must call `context.sync()` before reading the properties. + * Adds bullets and formatting to the paragraphs in the range. * - * @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; - }): Word.ThreeDimensionalFormat; - /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. - */ - track(): Word.ThreeDimensionalFormat; - /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. - */ - untrack(): Word.ThreeDimensionalFormat; - /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.ThreeDimensionalFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ThreeDimensionalFormatData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.ThreeDimensionalFormatData; - } - /** - * Specifies the length of the arrowhead at the end of a line. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ArrowheadLength { - /** - * Represents a mixed arrowhead length. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param defaultListBehavior Optional. Specifies the default list behavior. Default is `DefaultListBehavior.word97`. */ - mixed = "Mixed", + applyBulletDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void; /** - * Represents a short arrowhead length. + * Applies a list template with a specific level to the paragraphs in the range. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param listTemplate The list template to apply. + * @param options Optional. Options for applying the list template, such as whether to continue the previous list or which part of the list to apply the template to. */ - short = "Short", + applyListTemplateWithLevel(listTemplate: Word.ListTemplate, options?: Word.ListTemplateApplyOptions): void; /** - * Represents a medium arrowhead length. + * Adds numbering and formatting to the paragraphs in the range. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param defaultListBehavior Optional. Specifies the default list behavior. */ - medium = "Medium", + applyNumberDefault(defaultListBehavior: Word.DefaultListBehavior): void; /** - * Represents a long arrowhead length. + * Adds numbering and formatting to the paragraphs in the range. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param defaultListBehavior Optional. Specifies the default list behavior. */ - long = "Long", - } - /** - * Specifies the style of the arrowhead at the end of a line. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ArrowheadStyle { + applyNumberDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void; /** - * Represents a mixed arrowhead style. + * Adds outline numbering and formatting to the paragraphs in the range. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param defaultListBehavior Optional. Specifies the default list behavior. */ - mixed = "Mixed", + applyOutlineNumberDefault(defaultListBehavior: Word.DefaultListBehavior): void; /** - * Represents no arrowhead. + * Adds outline numbering and formatting to the paragraphs in the range. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param defaultListBehavior Optional. Specifies the default list behavior. */ - none = "None", + applyOutlineNumberDefault(defaultListBehavior: "Word97" | "Word2000" | "Word2002"): void; /** - * Represents a triangle arrowhead style. + * Determines whether the `ListFormat` object can continue a previous list. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param listTemplate The list template to check. + * @returns A `Continue` value indicating whether continuation is possible. */ - triangle = "Triangle", + canContinuePreviousList(listTemplate: Word.ListTemplate): OfficeExtension.ClientResult; /** - * Represents an open arrowhead style. + * Converts numbers in the list to plain text. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param numberType Optional. The type of number to convert. */ - open = "Open", + convertNumbersToText(numberType: Word.NumberType): void; /** - * Represents a stealth arrowhead style. + * Converts numbers in the list to plain text. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param numberType Optional. The type of number to convert. */ - stealth = "Stealth", + convertNumbersToText(numberType: "Paragraph" | "ListNum" | "AllNumbers"): void; /** - * Represents a diamond arrowhead style. + * Counts the numbered items in the list. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param options Optional. Options for counting numbered items, such as the type of number and the level to count. + * @returns The number of items. */ - diamond = "Diamond", + countNumberedItems(options?: Word.ListFormatCountNumberedItemsOptions): OfficeExtension.ClientResult; /** - * Represents an oval arrowhead style. + * Indents the list by one level. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - oval = "Oval", - } - /** - * Specifies the width of the arrowhead at the end of a line. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ArrowheadWidth { + listIndent(): void; /** - * Represents a mixed arrowhead width. + * Outdents the list by one level. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + listOutdent(): void; /** - * Represents a narrow arrowhead width. + * Removes numbering from the list. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param numberType Optional. The type of number to remove. */ - narrow = "Narrow", + removeNumbers(numberType: Word.NumberType): void; /** - * Represents a medium arrowhead width. + * Removes numbering from the list. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param numberType Optional. The type of number to remove. */ - medium = "Medium", + removeNumbers(numberType: "Paragraph" | "ListNum" | "AllNumbers"): void; /** - * Represents a wide arrowhead width. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - wide = "Wide", + load(options?: Word.Interfaces.ListFormatLoadOptions): Word.ListFormat; + /** + * 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[]): Word.ListFormat; + /** + * 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; + }): Word.ListFormat; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.ListFormat; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.ListFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ListFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.ListFormatData; } /** - * Indicates the bevel type of a {@link Word.ThreeDimensionalFormat} object. + * Represents options for counting numbered items in a range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum BevelType { + interface ListFormatCountNumberedItemsOptions { /** - * Represents a mixed bevel type. + * If provided, specifies the level to count. The default value is 1. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "mixed", + level?: number; /** - * Represents no bevel. + * If provided, specifies the type of number to count. The default value is `Word.NumberType.paragraph`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "none", + numberType?: Word.NumberType | "Paragraph" | "ListNum" | "AllNumbers"; + } + /** + * Represents options for applying a list template to a range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface ListTemplateApplyOptions { /** - * Represents a relaxed inset bevel. + * If provided, specifies the level to apply in the list template. The default value is 1. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - relaxedInset = "relaxedInset", + applyLevel?: number; /** - * Represents a circle bevel. + * If provided, specifies which part of the list to apply the template to. The default value is `Word.ListApplyTo.wholeList`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - circle = "circle", + applyTo?: Word.ListApplyTo | "WholeList" | "ThisPointForward" | "Selection"; /** - * Represents a slope bevel. + * If provided, specifies whether to continue the previous list. The default value is `false`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - slope = "slope", + continuePreviousList?: boolean; /** - * Represents a cross bevel. + * If provided, specifies the default list behavior. The default value is `DefaultListBehavior.word97`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cross = "cross", + defaultListBehavior?: Word.DefaultListBehavior | "Word97" | "Word2000" | "Word2002"; + } + /** + * Represents the fill formatting for a shape or text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class FillFormat 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 an angle bevel. + * Returns a `ColorFormat` object that represents the background color for the fill. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - angle = "angle", + readonly backgroundColor: Word.ColorFormat; /** - * Represents a soft round bevel. + * Returns a `ColorFormat` object that represents the foreground color for the fill. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - softRound = "softRound", + readonly foregroundColor: Word.ColorFormat; /** - * Represents a convex bevel. + * Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - convex = "convex", + gradientAngle: number; /** - * Represents a cool slant bevel. + * Gets the gradient color type. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - coolSlant = "coolSlant", + readonly gradientColorType: Word.GradientColorType | "Mixed" | "OneColor" | "TwoColors" | "PresetColors" | "MultiColor"; /** - * Represents a divot bevel. + * Returns how dark or light a one-color gradient fill is. + A value of 0 means that black is mixed in with the shape's foreground color to form the gradient. + A value of 1 means that white is mixed in. + Values between 0 and 1 mean that a darker or lighter shade of the foreground color is mixed in. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - divot = "divot", + readonly gradientDegree: number; /** - * Represents a riblet bevel. + * Returns the gradient style for the fill. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - riblet = "riblet", + readonly gradientStyle: Word.GradientStyle | "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter"; /** - * Represents a hard edge bevel. + * Returns the gradient variant for the fill as an integer value from 1 to 4 for most gradient fills. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hardEdge = "hardEdge", + readonly gradientVariant: number; /** - * Represents an art deco bevel. + * Specifies if the object, or the formatting applied to it, is visible. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - artDeco = "artDeco", - } - /** - * Represents color index values in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ColorIndex { + isVisible: boolean; /** - * Automatically determines the color. + * Returns a `PatternType` value that represents the pattern applied to the fill or line. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - auto = "Auto", + readonly pattern: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"; /** - * Represents the color black. + * Returns the preset gradient type for the fill. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - black = "Black", + readonly presetGradientType: Word.PresetGradientType | "Mixed" | "EarlySunset" | "LateSunset" | "Nightfall" | "Daybreak" | "Horizon" | "Desert" | "Ocean" | "CalmWater" | "Fire" | "Fog" | "Moss" | "Peacock" | "Wheat" | "Parchment" | "Mahogany" | "Rainbow" | "RainbowII" | "Gold" | "GoldII" | "Brass" | "Chrome" | "ChromeII" | "Silver" | "Sapphire"; /** - * Represents the color blue. + * Gets the preset texture. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - blue = "Blue", + readonly presetTexture: Word.PresetTexture | "Mixed" | "Papyrus" | "Canvas" | "Denim" | "WovenMat" | "WaterDroplets" | "PaperBag" | "FishFossil" | "Sand" | "GreenMarble" | "WhiteMarble" | "BrownMarble" | "Granite" | "Newsprint" | "RecycledPaper" | "Parchment" | "Stationery" | "BlueTissuePaper" | "PinkTissuePaper" | "PurpleMesh" | "Bouquet" | "Cork" | "Walnut" | "Oak" | "MediumWood"; /** - * Represents the color turquoise. + * Specifies whether the fill rotates with the shape. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - turquoise = "Turquoise", + rotateWithObject: boolean; /** - * Represents a bright green color. + * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - brightGreen = "BrightGreen", + textureAlignment: Word.TextureAlignment | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "Center" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; /** - * Represents the color pink. + * Specifies the horizontal scaling factor for the texture fill. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pink = "Pink", + textureHorizontalScale: number; /** - * Represents the color red. + * Returns the name of the custom texture file for the fill. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - red = "Red", + readonly textureName: string; /** - * Represents the color yellow. + * Specifies the horizontal offset of the texture from the origin in points. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - yellow = "Yellow", + textureOffsetX: number; /** - * Represents the color white. + * Specifies the vertical offset of the texture. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - white = "White", + textureOffsetY: number; /** - * Represents a dark blue color. + * Specifies whether the texture is tiled. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - darkBlue = "DarkBlue", + textureTile: boolean; /** - * Represents the color teal. + * Returns the texture type for the fill. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - teal = "Teal", + readonly textureType: Word.TextureType | "Mixed" | "Preset" | "UserDefined"; /** - * Represents the color green. + * Specifies the vertical scaling factor for the texture fill as a value between 0.0 and 1.0. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - green = "Green", + textureVerticalScale: number; /** - * Represents the color violet. + * Specifies the degree of transparency of the fill for a shape as a value between 0.0 (opaque) and 1.0 (clear). + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - violet = "Violet", + transparency: number; /** - * Represents a dark red color. + * Gets the fill format type. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - darkRed = "DarkRed", + readonly type: Word.FillType | "Mixed" | "Solid" | "Patterned" | "Gradient" | "Textured" | "Background" | "Picture"; /** - * Represents a dark yellow color. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - darkYellow = "DarkYellow", + set(properties: Interfaces.FillFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.FillFormat): void; /** - * Represents a gray color with 50% intensity. + * Sets the fill to a one-color gradient. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param style The gradient style. + * @param variant The gradient variant. Can be a value from 1 to 4. + * @param degree The gradient degree. Can be a value from `0.0` (dark) to `1.0` (light). */ - gray50 = "Gray50", + setOneColorGradient(style: Word.GradientStyle, variant: number, degree: number): void; /** - * Represents a gray color with 25% intensity. + * Sets the fill to a one-color gradient. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param style The gradient style. + * @param variant The gradient variant. Can be a value from 1 to 4. + * @param degree The gradient degree. Can be a value from `0.0` (dark) to `1.0` (light). */ - gray25 = "Gray25", + setOneColorGradient(style: "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter", variant: number, degree: number): void; /** - * Represents a classic red color. + * Sets the fill to a pattern. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - classicRed = "ClassicRed", + setPatterned(pattern: Word.PatternType): void; /** - * Represents a classic blue color. + * Sets the fill to a pattern. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - classicBlue = "ClassicBlue", + setPatterned(pattern: "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"): void; /** - * Represents a color determined by the author. + * Sets the fill to a preset gradient. + The gradient style.The gradient variant. Can be a value from 1 to 4.The preset gradient type. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - byAuthor = "ByAuthor", - } - /** - * Specifies the color type. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ColorType { + setPresetGradient(style: Word.GradientStyle, variant: number, presetGradientType: Word.PresetGradientType): void; /** - * Represents an RGB color type. + * Sets the fill to a preset gradient. + The gradient style.The gradient variant. Can be a value from 1 to 4.The preset gradient type. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rgb = "rgb", + setPresetGradient(style: "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter", variant: number, presetGradientType: "Mixed" | "EarlySunset" | "LateSunset" | "Nightfall" | "Daybreak" | "Horizon" | "Desert" | "Ocean" | "CalmWater" | "Fire" | "Fog" | "Moss" | "Peacock" | "Wheat" | "Parchment" | "Mahogany" | "Rainbow" | "RainbowII" | "Gold" | "GoldII" | "Brass" | "Chrome" | "ChromeII" | "Silver" | "Sapphire"): void; /** - * Represents a scheme color type. + * Sets the fill to a preset texture. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - scheme = "scheme", - } - /** - * Specifies whether the formatting from the previous list can be continued. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum Continue { + setPresetTextured(presetTexture: Word.PresetTexture): void; /** - * Formatting cannot continue from the previous list. + * Sets the fill to a preset texture. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - disabled = "Disabled", + setPresetTextured(presetTexture: "Mixed" | "Papyrus" | "Canvas" | "Denim" | "WovenMat" | "WaterDroplets" | "PaperBag" | "FishFossil" | "Sand" | "GreenMarble" | "WhiteMarble" | "BrownMarble" | "Granite" | "Newsprint" | "RecycledPaper" | "Parchment" | "Stationery" | "BlueTissuePaper" | "PinkTissuePaper" | "PurpleMesh" | "Bouquet" | "Cork" | "Walnut" | "Oak" | "MediumWood"): void; /** - * Formatting can continue from the previous list. + * Sets the fill to a two-color gradient. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - list = "List", + setTwoColorGradient(style: Word.GradientStyle, variant: number): void; /** - * Numbering can be restarted. + * Sets the fill to a two-color gradient. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - reset = "Reset", - } - /** - * Specifies the default list behavior for a list. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum DefaultListBehavior { + setTwoColorGradient(style: "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter", variant: number): void; /** - * Use formatting compatible with Microsoft Word 97. + * Sets the fill to a uniform color. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - word97 = "Word97", + solid(): void; /** - * Use Web-oriented formatting as introduced in Microsoft Word 2000. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - word2000 = "Word2000", + load(options?: Word.Interfaces.FillFormatLoadOptions): Word.FillFormat; /** - * Use formatting compatible with Microsoft Word 2002. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - word2002 = "Word2002", + load(propertyNames?: string | string[]): Word.FillFormat; + /** + * 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; + }): Word.FillFormat; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.FillFormat; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.FillFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.FillFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FillFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.FillFormatData; } /** - * Specifies the type of emphasis mark to use for a character or designated character string. + * Represents the glow formatting for the font used by the range of text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum EmphasisMark { + class GlowFormat 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; /** - * No emphasis mark. + * Returns a `ColorFormat` object that represents the color for a glow effect. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + readonly color: Word.ColorFormat; /** - * Emphasis mark over a solid circle. + * Specifies the length of the radius for a glow effect. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - overSolidCircle = "OverSolidCircle", + radius: number; /** - * Emphasis mark over a comma. + * Specifies the degree of transparency for the glow effect as a value between 0.0 (opaque) and 1.0 (clear). + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - overComma = "OverComma", + transparency: number; /** - * Emphasis mark over a white circle. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - overWhiteCircle = "OverWhiteCircle", + set(properties: Interfaces.GlowFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.GlowFormat): void; /** - * Emphasis mark under a solid circle. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - underSolidCircle = "UnderSolidCircle", - } - /** - * Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion) - and automatically changes when the shape's fill changes, or whether the extrusion color is independent of the shape's fill. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ExtrusionColorType { + load(options?: Word.Interfaces.GlowFormatLoadOptions): Word.GlowFormat; /** - * Represents a mixed extrusion color type. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - mixed = "mixed", + load(propertyNames?: string | string[]): Word.GlowFormat; /** - * Represents an automatic extrusion color based on the shape's fill. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - automatic = "automatic", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.GlowFormat; /** - * Represents a custom extrusion color independent of the shape's fill. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - custom = "custom", + track(): Word.GlowFormat; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.GlowFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.GlowFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.GlowFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.GlowFormatData; } /** - * Specifies a shape's fill type. + * Represents line and arrowhead formatting. For a line, the `LineFormat` object contains formatting information for the line itself; + for a shape with a border, this object contains formatting information for the shape's border. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum FillType { + class LineFormat 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 a mixed fill type. + * Gets a `ColorFormat` object that represents the background color for a patterned line. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + readonly backgroundColor: Word.ColorFormat; /** - * Represents a solid fill type. + * Gets a `ColorFormat` object that represents the foreground color for the line. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - solid = "Solid", + readonly foregroundColor: Word.ColorFormat; /** - * Represents a patterned fill type. + * Specifies the length of the arrowhead at the beginning of the line. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - patterned = "Patterned", + beginArrowheadLength: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; /** - * Represents a gradient fill type. + * Specifies the style of the arrowhead at the beginning of the line. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gradient = "Gradient", + beginArrowheadStyle: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; /** - * Represents a textured fill type. + * Specifies the width of the arrowhead at the beginning of the line. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textured = "Textured", + beginArrowheadWidth: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; /** - * Represents a background fill type. + * Specifies the dash style for the line. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - background = "Background", + dashStyle: Word.LineDashStyle | "Mixed" | "Solid" | "SquareDot" | "RoundDot" | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "SysDash" | "SysDot" | "SysDashDot"; /** - * Represents a picture fill type. + * Specifies the length of the arrowhead at the end of the line. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - picture = "Picture", - } - /** - * Specifies the type of gradient used in a shape's fill. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum GradientColorType { + endArrowheadLength: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; /** - * Mixed gradient color type. Used when multiple shapes with different gradient types are selected. + * Specifies the style of the arrowhead at the end of the line. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + endArrowheadStyle: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; /** - * Gradient with a single color and varying transparency or brightness. + * Specifies the width of the arrowhead at the end of the line. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - oneColor = "OneColor", + endArrowheadWidth: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; /** - * Gradient that blends two distinct colors. + * Specifies if to draw lines inside a shape. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - twoColors = "TwoColors", + insetPen: boolean; /** - * Gradient that uses a predefined set of colors. + * Specifies if the object, or the formatting applied to it, is visible. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetColors = "PresetColors", + isVisible: boolean; /** - * Gradient that includes more than two colors, often customized. + * Specifies the pattern applied to the line. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - multiColor = "MultiColor", - } - /** - * Specifies the style for a gradient fill. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum GradientStyle { + pattern: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"; /** - * Represents a mixed gradient style. + * Specifies the line format style. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + style: Word.LineFormatStyle | "Mixed" | "Single" | "ThinThin" | "ThinThick" | "ThickThin" | "ThickBetweenThin"; /** - * Represents a horizontal gradient style. + * Specifies the degree of transparency of the line as a value between 0.0 (opaque) and 1.0 (clear). + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontal = "Horizontal", + transparency: number; /** - * Represents a vertical gradient style. + * Specifies the thickness of the line in points. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - vertical = "Vertical", + weight: number; /** - * Represents a diagonal-up gradient style. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - diagonalUp = "DiagonalUp", + set(properties: Interfaces.LineFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.LineFormat): void; /** - * Represents a diagonal-down gradient style. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - diagonalDown = "DiagonalDown", + load(options?: Word.Interfaces.LineFormatLoadOptions): Word.LineFormat; /** - * Represents a gradient style from the corner. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - fromCorner = "FromCorner", + load(propertyNames?: string | string[]): Word.LineFormat; /** - * Represents a gradient style from the title. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - fromTitle = "FromTitle", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.LineFormat; /** - * Represents a gradient style from the center. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - fromCenter = "FromCenter", + track(): Word.LineFormat; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.LineFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.LineFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.LineFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.LineFormatData; } /** - * Specifies the type of ligature applied to a font. + * Represents the reflection formatting for a shape in Word. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum Ligature { + class ReflectionFormat 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; /** - * No ligatures applied. + * Specifies the degree of blur effect applied to the `ReflectionFormat` object as a value between 0.0 and 100.0. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + blur: number; /** - * Standard ligatures applied. + * Specifies the amount of separation, in points, of the reflected image from the shape. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - standard = "Standard", + offset: number; /** - * Contextual ligatures applied. + * Specifies the size of the reflection as a percentage of the reflected shape from 0 to 100. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contextual = "Contextual", + size: number; /** - * Standard and contextual ligatures applied. + * Specifies the degree of transparency for the reflection effect as a value between 0.0 (opaque) and 1.0 (clear). + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - standardContextual = "StandardContextual", + transparency: number; /** - * Historical ligatures applied. + * Specifies a `ReflectionType` value that represents the type and direction of the lighting for a shape reflection. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - historical = "Historical", + type: Word.ReflectionType | "Mixed" | "None" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9"; /** - * Standard and historical ligatures applied. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - standardHistorical = "StandardHistorical", + set(properties: Interfaces.ReflectionFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ReflectionFormat): void; /** - * Contextual and historical ligatures applied. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - contextualHistorical = "ContextualHistorical", + load(options?: Word.Interfaces.ReflectionFormatLoadOptions): Word.ReflectionFormat; /** - * Standard, contextual, and historical ligatures applied. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - standardContextualHistorical = "StandardContextualHistorical", + load(propertyNames?: string | string[]): Word.ReflectionFormat; /** - * Discretional ligatures applied. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - discretional = "Discretional", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.ReflectionFormat; /** - * Standard and discretional ligatures applied. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - standardDiscretional = "StandardDiscretional", + track(): Word.ReflectionFormat; /** - * Contextual and discretional ligatures applied. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - contextualDiscretional = "ContextualDiscretional", + untrack(): Word.ReflectionFormat; /** - * Standard, contextual, and discretional ligatures applied. + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ReflectionFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ReflectionFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.ReflectionFormatData; + } + /** + * Represents the color formatting of a shape or text in Word. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class ColorFormat 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 brightness of a specified shape color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - standardContextualDiscretional = "StandardContextualDiscretional", + brightness: number; /** - * Historical and discretional ligatures applied. + * Specifies the theme color for a color format. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - historicalDiscretional = "HistoricalDiscretional", + objectThemeColor: Word.ThemeColorIndex | "NotThemeColor" | "MainDark1" | "MainLight1" | "MainDark2" | "MainLight2" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Hyperlink" | "HyperlinkFollowed" | "Background1" | "Text1" | "Background2" | "Text2"; /** - * Standard, historical, and discretional ligatures applied. + * Specifies the red-green-blue (RGB) value of the specified color. You can provide the value in the '#RRGGBB' format. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - standardHistoricalDiscretional = "StandardHistoricalDiscretional", + rgb: string; /** - * Contextual, historical, and discretional ligatures applied. + * Specifies the lightening or darkening of a specified shape's color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contextualHistoricalDiscretional = "ContextualHistoricalDiscretional", + tintAndShade: number; /** - * All ligatures applied. + * Returns the shape color type. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - all = "All", + readonly type: Word.ColorType | "rgb" | "scheme"; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ColorFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ColorFormat): 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?: Word.Interfaces.ColorFormatLoadOptions): Word.ColorFormat; + /** + * 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[]): Word.ColorFormat; + /** + * 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; + }): Word.ColorFormat; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.ColorFormat; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.ColorFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ColorFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ColorFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.ColorFormatData; } /** - * Indicates the effects lighting for an object. + * Represents the shadow formatting for a shape or text in Word. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum LightRigType { + class ShadowFormat 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 a mixed light rig type. + * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + readonly foregroundColor: Word.ColorFormat; /** - * Represents legacy flat light rig type 1. + * Specifies the blur level for a shadow format as a value between 0.0 and 100.0. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyFlat1 = "LegacyFlat1", + blur: number; /** - * Represents legacy flat light rig type 2. + * Specifies whether the object or the formatting applied to it is visible. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyFlat2 = "LegacyFlat2", + isVisible: boolean; /** - * Represents legacy flat light rig type 3. + * Specifies `true` if the shadow of the shape appears filled in and is obscured by the shape, even if the shape has no fill, + `false` if the shadow has no fill and the outline of the shadow is visible through the shape if the shape has no fill. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyFlat3 = "LegacyFlat3", + obscured: boolean; /** - * Represents legacy flat light rig type 4. + * Specifies the horizontal offset (in points) of the shadow from the shape. + A positive value offsets the shadow to the right of the shape; a negative value offsets it to the left. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyFlat4 = "LegacyFlat4", + offsetX: number; /** - * Represents legacy normal light rig type 1. + * Specifies the vertical offset (in points) of the shadow from the shape. + A positive value offsets the shadow to the top of the shape; a negative value offsets it to the bottom. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyNormal1 = "LegacyNormal1", + offsetY: number; /** - * Represents legacy normal light rig type 2. + * Specifies whether to rotate the shadow when rotating the shape. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyNormal2 = "LegacyNormal2", + rotateWithShape: boolean; /** - * Represents legacy normal light rig type 3. + * Specifies the width of the shadow. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyNormal3 = "LegacyNormal3", + size: number; /** - * Represents legacy normal light rig type 4. + * Specifies the type of shadow formatting to apply to a shape. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyNormal4 = "LegacyNormal4", + style: Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow"; /** - * Represents legacy harsh light rig type 1. + * Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear). + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyHarsh1 = "LegacyHarsh1", + transparency: number; /** - * Represents legacy harsh light rig type 2. + * Specifies the shape shadow type. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyHarsh2 = "LegacyHarsh2", + type: Word.ShadowType | "Mixed" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9" | "Type10" | "Type11" | "Type12" | "Type13" | "Type14" | "Type15" | "Type16" | "Type17" | "Type18" | "Type19" | "Type20" | "Type21" | "Type22" | "Type23" | "Type24" | "Type25" | "Type26" | "Type27" | "Type28" | "Type29" | "Type30" | "Type31" | "Type32" | "Type33" | "Type34" | "Type35" | "Type36" | "Type37" | "Type38" | "Type39" | "Type40" | "Type41" | "Type42" | "Type43"; /** - * Represents legacy harsh light rig type 3. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - legacyHarsh3 = "LegacyHarsh3", + set(properties: Interfaces.ShadowFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ShadowFormat): void; /** - * Represents legacy harsh light rig type 4. + * Changes the horizontal offset of the shadow by the number of points. + Increment The number of points to adjust. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyHarsh4 = "LegacyHarsh4", + incrementOffsetX(increment: number): void; /** - * Represents a three-point light rig type. + * Changes the vertical offset of the shadow by the specified number of points. + Increment The number of points to adjust. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - threePoint = "ThreePoint", + incrementOffsetY(increment: number): void; /** - * Represents a balanced light rig type. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - balanced = "Balanced", + load(options?: Word.Interfaces.ShadowFormatLoadOptions): Word.ShadowFormat; /** - * Represents a soft light rig type. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - soft = "Soft", + load(propertyNames?: string | string[]): Word.ShadowFormat; /** - * Represents a harsh light rig type. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - harsh = "Harsh", - /** - * Represents a flood light rig type. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.ShadowFormat; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - flood = "Flood", + track(): Word.ShadowFormat; /** - * Represents a contrasting light rig type. + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.ShadowFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ShadowFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ShadowFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.ShadowFormatData; + } + /** + * Represents a shape's three-dimensional formatting. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class ThreeDimensionalFormat 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 `ColorFormat` object that represents color of the contour of a shape. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contrasting = "Contrasting", + readonly contourColor: Word.ColorFormat; /** - * Represents a morning light rig type. + * Returns a `ColorFormat` object that represents the color of the shape's extrusion. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - morning = "Morning", + readonly extrusionColor: Word.ColorFormat; /** - * Represents a sunrise light rig type. + * Specifies the depth of the bottom bevel. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sunrise = "Sunrise", + bevelBottomDepth: number; /** - * Represents a sunset light rig type. + * Specifies the inset size for the bottom bevel. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sunset = "Sunset", + bevelBottomInset: number; /** - * Represents a chilly light rig type. + * Specifies a `BevelType` value that represents the bevel type for the bottom bevel. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - chilly = "Chilly", + bevelBottomType: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; /** - * Represents a freezing light rig type. + * Specifies the depth of the top bevel. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - freezing = "Freezing", + bevelTopDepth: number; /** - * Represents a flat light rig type. + * Specifies the inset size for the top bevel. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - flat = "Flat", + bevelTopInset: number; /** - * Represents a two-point light rig type. + * Specifies a `BevelType` value that represents the bevel type for the top bevel. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - twoPoint = "TwoPoint", + bevelTopType: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; /** - * Represents a glow light rig type. + * Specifies the width of the contour of a shape. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - glow = "Glow", + contourWidth: number; /** - * Represents a bright room light rig type. + * Specifies the depth of the shape's extrusion. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - brightRoom = "BrightRoom", - } - /** - * Specifies the dash style for a line. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum LineDashStyle { + depth: number; /** - * Represents a mixed dash style. + * Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion) + and automatically changes when the shape's fill changes, or whether the extrusion color is independent of the shape's fill. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + extrusionColorType: Word.ExtrusionColorType | "mixed" | "automatic" | "custom"; /** - * Represents a solid line style. + * Specifies the amount of perspective for a shape. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - solid = "Solid", + fieldOfView: number; /** - * Represents a square dot line style. + * Specifies `true` if the extrusion appears in perspective — that is, if the walls of the extrusion narrow toward a vanishing point, + `false` if the extrusion is a parallel, or orthographic, projection — that is, if the walls don't narrow toward a vanishing point. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - squareDot = "SquareDot", + isPerspective: boolean; /** - * Represents a round dot line style. + * Specifies if the specified object, or the formatting applied to it, is visible. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - roundDot = "RoundDot", + isVisible: boolean; /** - * Represents a dashed line style. + * Specifies the angle of the lighting. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dash = "Dash", + lightAngle: number; /** - * Represents a dash-dot line style. + * Returns a `PresetCamera` value that represents the camera presets. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashDot = "DashDot", + readonly presetCamera: Word.PresetCamera | "Mixed" | "LegacyObliqueTopLeft" | "LegacyObliqueTop" | "LegacyObliqueTopRight" | "LegacyObliqueLeft" | "LegacyObliqueFront" | "LegacyObliqueRight" | "LegacyObliqueBottomLeft" | "LegacyObliqueBottom" | "LegacyObliqueBottomRight" | "LegacyPerspectiveTopLeft" | "LegacyPerspectiveTop" | "LegacyPerspectiveTopRight" | "LegacyPerspectiveLeft" | "LegacyPerspectiveFront" | "LegacyPerspectiveRight" | "LegacyPerspectiveBottomLeft" | "LegacyPerspectiveBottom" | "LegacyPerspectiveBottomRight" | "OrthographicFront" | "IsometricTopUp" | "IsometricTopDown" | "IsometricBottomUp" | "IsometricBottomDown" | "IsometricLeftUp" | "IsometricLeftDown" | "IsometricRightUp" | "IsometricRightDown" | "IsometricOffAxis1Left" | "IsometricOffAxis1Right" | "IsometricOffAxis1Top" | "IsometricOffAxis2Left" | "IsometricOffAxis2Right" | "IsometricOffAxis2Top" | "IsometricOffAxis3Left" | "IsometricOffAxis3Right" | "IsometricOffAxis3Bottom" | "IsometricOffAxis4Left" | "IsometricOffAxis4Right" | "IsometricOffAxis4Bottom" | "ObliqueTopLeft" | "ObliqueTop" | "ObliqueTopRight" | "ObliqueLeft" | "ObliqueRight" | "ObliqueBottomLeft" | "ObliqueBottom" | "ObliqueBottomRight" | "PerspectiveFront" | "PerspectiveLeft" | "PerspectiveRight" | "PerspectiveAbove" | "PerspectiveBelow" | "PerspectiveAboveLeftFacing" | "PerspectiveAboveRightFacing" | "PerspectiveContrastingLeftFacing" | "PerspectiveContrastingRightFacing" | "PerspectiveHeroicLeftFacing" | "PerspectiveHeroicRightFacing" | "PerspectiveHeroicExtremeLeftFacing" | "PerspectiveHeroicExtremeRightFacing" | "PerspectiveRelaxed" | "PerspectiveRelaxedModerately"; /** - * Represents a dash-dot-dot line style. + * Returns the direction taken by the extrusion's sweep path leading away from the extruded shape (the front face of the extrusion). + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashDotDot = "DashDotDot", + readonly presetExtrusionDirection: Word.PresetExtrusionDirection | "Mixed" | "BottomRight" | "Bottom" | "BottomLeft" | "Right" | "None" | "Left" | "TopRight" | "Top" | "TopLeft"; /** - * Represents a long dash line style. + * Specifies a `LightRigType` value that represents the lighting preset. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - longDash = "LongDash", + presetLighting: Word.LightRigType | "Mixed" | "LegacyFlat1" | "LegacyFlat2" | "LegacyFlat3" | "LegacyFlat4" | "LegacyNormal1" | "LegacyNormal2" | "LegacyNormal3" | "LegacyNormal4" | "LegacyHarsh1" | "LegacyHarsh2" | "LegacyHarsh3" | "LegacyHarsh4" | "ThreePoint" | "Balanced" | "Soft" | "Harsh" | "Flood" | "Contrasting" | "Morning" | "Sunrise" | "Sunset" | "Chilly" | "Freezing" | "Flat" | "TwoPoint" | "Glow" | "BrightRoom"; /** - * Represents a long dash-dot line style. + * Specifies the position of the light source relative to the extrusion. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - longDashDot = "LongDashDot", + presetLightingDirection: Word.PresetLightingDirection | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "None" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; /** - * Represents a long dash-dot-dot line style. + * Specifies the intensity of the extrusion lighting. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - longDashDotDot = "LongDashDotDot", + presetLightingSoftness: Word.PresetLightingSoftness | "Mixed" | "Dim" | "Normal" | "Bright"; /** - * Represents a system dash line style. + * Specifies the extrusion surface material. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sysDash = "SysDash", + presetMaterial: Word.PresetMaterial | "Mixed" | "Matte" | "Plastic" | "Metal" | "WireFrame" | "Matte2" | "Plastic2" | "Metal2" | "WarmMatte" | "TranslucentPowder" | "Powder" | "DarkEdge" | "SoftEdge" | "Clear" | "Flat" | "SoftMetal"; /** - * Represents a system dot line style. + * Returns the preset extrusion format. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sysDot = "SysDot", + readonly presetThreeDimensionalFormat: Word.PresetThreeDimensionalFormat | "Mixed" | "Format1" | "Format2" | "Format3" | "Format4" | "Format5" | "Format6" | "Format7" | "Format8" | "Format9" | "Format10" | "Format11" | "Format12" | "Format13" | "Format14" | "Format15" | "Format16" | "Format17" | "Format18" | "Format19" | "Format20"; /** - * Represents a system dash-dot line style. + * Specifies whether text on a shape rotates with shape. `true` rotates the text. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sysDashDot = "SysDashDot", - } - /** - * Specifies the style for a line. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum LineFormatStyle { + projectText: boolean; /** - * Represents a mixed line style. + * Specifies the rotation of the extruded shape around the x-axis in degrees. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + rotationX: number; /** - * Represents a single line style. + * Specifies the rotation of the extruded shape around the y-axis in degrees. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - single = "Single", + rotationY: number; /** - * Represents a thin-thin line style. + * Specifies the z-axis rotation of the camera. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thinThin = "ThinThin", + rotationZ: number; /** - * Represents a thin-thick line style. + * Specifies the position on the z-axis for the shape. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thinThick = "ThinThick", + z: number; /** - * Represents a thick-thin line style. + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.ThreeDimensionalFormatUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.ThreeDimensionalFormat): void; + /** + * Horizontally rotates a shape on the x-axis. + The number of degrees to rotate. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thickThin = "ThickThin", + incrementRotationHorizontal(increment: number): void; /** - * Represents a thick line between two thin lines style. + * Vertically rotates a shape on the y-axis. + The number of degrees to rotate. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thickBetweenThin = "ThickBetweenThin", - } - /** - * Specifies the portion of a list to which to apply a list template. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ListApplyTo { + incrementRotationVertical(increment: number): void; /** - * Applies the list template to the entire list. + * Changes the rotation around the x-axis. + The number of degrees to rotate. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - wholeList = "WholeList", + incrementRotationX(increment: number): void; /** - * Applies the list template from the cursor insertion point to the end of the list. + * Changes the rotation around the y-axis. + The number of degrees to rotate. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thisPointForward = "ThisPointForward", + incrementRotationY(increment: number): void; /** - * Applies the list template to the selection. + * Rotates a shape on the z-axis. + The number of degrees to rotate. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - selection = "Selection", - } - /** - * Represents the list type. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ListType { + incrementRotationZ(increment: number): void; /** - * List with no bullets, numbering, or outlining. + * Resets the extrusion rotation around the x-axis, y-axis, and z-axis to 0. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listNoNumbering = "ListNoNumbering", + resetRotation(): void; /** - * ListNum fields that can be used in the body of a paragraph. + * Sets the direction of the extrusion's sweep path. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param presetExtrusionDirection The preset direction. */ - listListNumOnly = "ListListNumOnly", + setExtrusionDirection(presetExtrusionDirection: Word.PresetExtrusionDirection): void; /** - * Bulleted list. + * Sets the direction of the extrusion's sweep path. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param presetExtrusionDirection The preset direction. */ - listBullet = "ListBullet", + setExtrusionDirection(presetExtrusionDirection: "Mixed" | "BottomRight" | "Bottom" | "BottomLeft" | "Right" | "None" | "Left" | "TopRight" | "Top" | "TopLeft"): void; /** - * Simple numeric list. + * Sets the camera preset for the shape. + The preset camera type. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listSimpleNumbering = "ListSimpleNumbering", + setPresetCamera(presetCamera: Word.PresetCamera): void; /** - * Outlined list. + * Sets the camera preset for the shape. + The preset camera type. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listOutlineNumbering = "ListOutlineNumbering", + setPresetCamera(presetCamera: "Mixed" | "LegacyObliqueTopLeft" | "LegacyObliqueTop" | "LegacyObliqueTopRight" | "LegacyObliqueLeft" | "LegacyObliqueFront" | "LegacyObliqueRight" | "LegacyObliqueBottomLeft" | "LegacyObliqueBottom" | "LegacyObliqueBottomRight" | "LegacyPerspectiveTopLeft" | "LegacyPerspectiveTop" | "LegacyPerspectiveTopRight" | "LegacyPerspectiveLeft" | "LegacyPerspectiveFront" | "LegacyPerspectiveRight" | "LegacyPerspectiveBottomLeft" | "LegacyPerspectiveBottom" | "LegacyPerspectiveBottomRight" | "OrthographicFront" | "IsometricTopUp" | "IsometricTopDown" | "IsometricBottomUp" | "IsometricBottomDown" | "IsometricLeftUp" | "IsometricLeftDown" | "IsometricRightUp" | "IsometricRightDown" | "IsometricOffAxis1Left" | "IsometricOffAxis1Right" | "IsometricOffAxis1Top" | "IsometricOffAxis2Left" | "IsometricOffAxis2Right" | "IsometricOffAxis2Top" | "IsometricOffAxis3Left" | "IsometricOffAxis3Right" | "IsometricOffAxis3Bottom" | "IsometricOffAxis4Left" | "IsometricOffAxis4Right" | "IsometricOffAxis4Bottom" | "ObliqueTopLeft" | "ObliqueTop" | "ObliqueTopRight" | "ObliqueLeft" | "ObliqueRight" | "ObliqueBottomLeft" | "ObliqueBottom" | "ObliqueBottomRight" | "PerspectiveFront" | "PerspectiveLeft" | "PerspectiveRight" | "PerspectiveAbove" | "PerspectiveBelow" | "PerspectiveAboveLeftFacing" | "PerspectiveAboveRightFacing" | "PerspectiveContrastingLeftFacing" | "PerspectiveContrastingRightFacing" | "PerspectiveHeroicLeftFacing" | "PerspectiveHeroicRightFacing" | "PerspectiveHeroicExtremeLeftFacing" | "PerspectiveHeroicExtremeRightFacing" | "PerspectiveRelaxed" | "PerspectiveRelaxedModerately"): void; /** - * Mixed numeric list. + * Sets the preset extrusion format. + The preset format. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listMixedNumbering = "ListMixedNumbering", + setThreeDimensionalFormat(presetThreeDimensionalFormat: Word.PresetThreeDimensionalFormat): void; /** - * Picture bulleted list. + * Sets the preset extrusion format. + The preset format. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listPictureBullet = "ListPictureBullet", + setThreeDimensionalFormat(presetThreeDimensionalFormat: "Mixed" | "Format1" | "Format2" | "Format3" | "Format4" | "Format5" | "Format6" | "Format7" | "Format8" | "Format9" | "Format10" | "Format11" | "Format12" | "Format13" | "Format14" | "Format15" | "Format16" | "Format17" | "Format18" | "Format19" | "Format20"): 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?: Word.Interfaces.ThreeDimensionalFormatLoadOptions): Word.ThreeDimensionalFormat; + /** + * 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[]): Word.ThreeDimensionalFormat; + /** + * 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; + }): Word.ThreeDimensionalFormat; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.ThreeDimensionalFormat; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.ThreeDimensionalFormat; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ThreeDimensionalFormat` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ThreeDimensionalFormatData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.ThreeDimensionalFormatData; } /** - * Specifies the number form setting for an OpenType font. + * Specifies the length of the arrowhead at the end of a line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum NumberForm { + enum ArrowheadLength { /** - * Default number form setting. + * Represents a mixed arrowhead length. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - default = "Default", + mixed = "Mixed", /** - * Lining number form setting. + * Represents a short arrowhead length. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lining = "Lining", + short = "Short", /** - * Old-style number form setting. + * Represents a medium arrowhead length. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - oldStyle = "OldStyle", + medium = "Medium", + /** + * Represents a long arrowhead length. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + long = "Long", } /** - * Specifies the number spacing setting for an OpenType font. + * Specifies the style of the arrowhead at the end of a line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum NumberSpacing { + enum ArrowheadStyle { /** - * Default number spacing setting. + * Represents a mixed arrowhead style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - default = "Default", + mixed = "Mixed", /** - * Proportional number spacing setting. + * Represents no arrowhead. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - proportional = "Proportional", + none = "None", /** - * Tabular number spacing setting. + * Represents a triangle arrowhead style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tabular = "Tabular", - } - /** - * Specifies the type of numbers in a list. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum NumberType { + triangle = "Triangle", /** - * Preset numbers you can add to paragraphs by selecting a template in the **Bullets and Numbering** dialog box. + * Represents an open arrowhead style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - paragraph = "Paragraph", + open = "Open", /** - * Default value for {@link https://support.microsoft.com/office/557541b1-abb2-4959-a9f2-401639c8ff82 | ListNum fields}. + * Represents a stealth arrowhead style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listNum = "ListNum", + stealth = "Stealth", /** - * Default value for all other cases. + * Represents a diamond arrowhead style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - allNumbers = "AllNumbers", + diamond = "Diamond", + /** + * Represents an oval arrowhead style. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + oval = "Oval", } /** - * Specifies the fill pattern used in a shape. + * Specifies the width of the arrowhead at the end of a line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum PatternType { + enum ArrowheadWidth { /** - * Represents a mixed pattern type. + * Represents a mixed arrowhead width. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ mixed = "Mixed", /** - * Represents a 5 percent fill pattern. + * Represents a narrow arrowhead width. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent5 = "Percent5", + narrow = "Narrow", /** - * Represents a 10 percent fill pattern. + * Represents a medium arrowhead width. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent10 = "Percent10", + medium = "Medium", /** - * Represents a 20 percent fill pattern. + * Represents a wide arrowhead width. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent20 = "Percent20", + wide = "Wide", + } + /** + * Indicates the bevel type of a {@link Word.ThreeDimensionalFormat} object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum BevelType { /** - * Represents a 25 percent fill pattern. + * Represents a mixed bevel type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent25 = "Percent25", + mixed = "mixed", /** - * Represents a 30 percent fill pattern. + * Represents no bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent30 = "Percent30", + none = "none", /** - * Represents a 40 percent fill pattern. + * Represents a relaxed inset bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent40 = "Percent40", + relaxedInset = "relaxedInset", /** - * Represents a 50 percent fill pattern. + * Represents a circle bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent50 = "Percent50", + circle = "circle", /** - * Represents a 60 percent fill pattern. + * Represents a slope bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent60 = "Percent60", + slope = "slope", /** - * Represents a 70 percent fill pattern. + * Represents a cross bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent70 = "Percent70", + cross = "cross", /** - * Represents a 75 percent fill pattern. + * Represents an angle bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent75 = "Percent75", + angle = "angle", /** - * Represents an 80 percent fill pattern. + * Represents a soft round bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent80 = "Percent80", + softRound = "softRound", /** - * Represents a 90 percent fill pattern. + * Represents a convex bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent90 = "Percent90", + convex = "convex", /** - * Represents a dark horizontal fill pattern. + * Represents a cool slant bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - darkHorizontal = "DarkHorizontal", + coolSlant = "coolSlant", /** - * Represents a dark vertical fill pattern. + * Represents a divot bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - darkVertical = "DarkVertical", + divot = "divot", /** - * Represents a dark downward diagonal fill pattern. + * Represents a riblet bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - darkDownwardDiagonal = "DarkDownwardDiagonal", + riblet = "riblet", /** - * Represents a dark upward diagonal fill pattern. + * Represents a hard edge bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - darkUpwardDiagonal = "DarkUpwardDiagonal", + hardEdge = "hardEdge", /** - * Represents a small checkerboard fill pattern. + * Represents an art deco bevel. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - smallCheckerBoard = "SmallCheckerBoard", + artDeco = "artDeco", + } + /** + * Represents color index values in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ColorIndex { /** - * Represents a trellis fill pattern. + * Automatically determines the color. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - trellis = "Trellis", + auto = "Auto", /** - * Represents a light horizontal fill pattern. + * Represents the color black. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lightHorizontal = "LightHorizontal", + black = "Black", /** - * Represents a light vertical fill pattern. + * Represents the color blue. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lightVertical = "LightVertical", + blue = "Blue", /** - * Represents a light downward diagonal fill pattern. + * Represents the color turquoise. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lightDownwardDiagonal = "LightDownwardDiagonal", + turquoise = "Turquoise", /** - * Represents a light upward diagonal fill pattern. + * Represents a bright green color. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lightUpwardDiagonal = "LightUpwardDiagonal", + brightGreen = "BrightGreen", /** - * Represents a small grid fill pattern. + * Represents the color pink. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - smallGrid = "SmallGrid", + pink = "Pink", /** - * Represents a dotted diamond fill pattern. + * Represents the color red. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dottedDiamond = "DottedDiamond", + red = "Red", /** - * Represents a wide downward diagonal fill pattern. + * Represents the color yellow. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - wideDownwardDiagonal = "WideDownwardDiagonal", + yellow = "Yellow", /** - * Represents a wide upward diagonal fill pattern. + * Represents the color white. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - wideUpwardDiagonal = "WideUpwardDiagonal", - /** - * Represents a dashed upward diagonal fill pattern. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - dashedUpwardDiagonal = "DashedUpwardDiagonal", + white = "White", /** - * Represents a dashed downward diagonal fill pattern. + * Represents a dark blue color. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashedDownwardDiagonal = "DashedDownwardDiagonal", + darkBlue = "DarkBlue", /** - * Represents a narrow vertical fill pattern. + * Represents the color teal. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - narrowVertical = "NarrowVertical", + teal = "Teal", /** - * Represents a narrow horizontal fill pattern. + * Represents the color green. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - narrowHorizontal = "NarrowHorizontal", + green = "Green", /** - * Represents a dashed vertical fill pattern. + * Represents the color violet. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashedVertical = "DashedVertical", + violet = "Violet", /** - * Represents a dashed horizontal fill pattern. + * Represents a dark red color. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashedHorizontal = "DashedHorizontal", + darkRed = "DarkRed", /** - * Represents a large confetti fill pattern. + * Represents a dark yellow color. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - largeConfetti = "LargeConfetti", + darkYellow = "DarkYellow", /** - * Represents a large grid fill pattern. + * Represents a gray color with 50% intensity. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - largeGrid = "LargeGrid", + gray50 = "Gray50", /** - * Represents a horizontal brick fill pattern. + * Represents a gray color with 25% intensity. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontalBrick = "HorizontalBrick", + gray25 = "Gray25", /** - * Represents a large checkerboard fill pattern. + * Represents a classic red color. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - largeCheckerBoard = "LargeCheckerBoard", + classicRed = "ClassicRed", /** - * Represents a small confetti fill pattern. + * Represents a classic blue color. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - smallConfetti = "SmallConfetti", + classicBlue = "ClassicBlue", /** - * Represents a zigzag fill pattern. + * Represents a color determined by the author. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - zigZag = "ZigZag", + byAuthor = "ByAuthor", + } + /** + * Specifies the color type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ColorType { /** - * Represents a solid diamond fill pattern. + * Represents an RGB color type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - solidDiamond = "SolidDiamond", + rgb = "rgb", /** - * Represents a diagonal brick fill pattern. + * Represents a scheme color type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - diagonalBrick = "DiagonalBrick", + scheme = "scheme", + } + /** + * Specifies whether the formatting from the previous list can be continued. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum Continue { /** - * Represents an outlined diamond fill pattern. + * Formatting cannot continue from the previous list. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - outlinedDiamond = "OutlinedDiamond", + disabled = "Disabled", /** - * Represents a plaid fill pattern. + * Formatting can continue from the previous list. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - plaid = "Plaid", + list = "List", /** - * Represents a sphere fill pattern. + * Numbering can be restarted. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sphere = "Sphere", + reset = "Reset", + } + /** + * Specifies the default list behavior for a list. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum DefaultListBehavior { /** - * Represents a weave fill pattern. + * Use formatting compatible with Microsoft Word 97. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - weave = "Weave", + word97 = "Word97", /** - * Represents a dotted grid fill pattern. + * Use Web-oriented formatting as introduced in Microsoft Word 2000. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dottedGrid = "DottedGrid", + word2000 = "Word2000", /** - * Represents a divot fill pattern. + * Use formatting compatible with Microsoft Word 2002. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - divot = "Divot", + word2002 = "Word2002", + } + /** + * Specifies the type of emphasis mark to use for a character or designated character string. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum EmphasisMark { /** - * Represents a shingle fill pattern. + * No emphasis mark. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shingle = "Shingle", + none = "None", /** - * Represents a wave fill pattern. + * Emphasis mark over a solid circle. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - wave = "Wave", + overSolidCircle = "OverSolidCircle", /** - * Represents a horizontal fill pattern. + * Emphasis mark over a comma. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontal = "Horizontal", + overComma = "OverComma", /** - * Represents a vertical fill pattern. + * Emphasis mark over a white circle. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - vertical = "Vertical", + overWhiteCircle = "OverWhiteCircle", /** - * Represents a cross fill pattern. + * Emphasis mark under a solid circle. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cross = "Cross", + underSolidCircle = "UnderSolidCircle", + } + /** + * Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion) + and automatically changes when the shape's fill changes, or whether the extrusion color is independent of the shape's fill. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ExtrusionColorType { /** - * Represents a downward diagonal fill pattern. + * Represents a mixed extrusion color type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - downwardDiagonal = "DownwardDiagonal", + mixed = "mixed", /** - * Represents an upward diagonal fill pattern. + * Represents an automatic extrusion color based on the shape's fill. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - upwardDiagonal = "UpwardDiagonal", + automatic = "automatic", /** - * Represents a diagonal cross fill pattern. + * Represents a custom extrusion color independent of the shape's fill. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - diagonalCross = "DiagonalCross", + custom = "custom", } /** - * Indicates the effects camera type used by the specified object. + * Specifies a shape's fill type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum PresetCamera { + enum FillType { /** - * Represents a mixed camera type. + * Represents a mixed fill type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ mixed = "Mixed", /** - * Represents a legacy oblique top-left camera type. + * Represents a solid fill type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyObliqueTopLeft = "LegacyObliqueTopLeft", + solid = "Solid", /** - * Represents a legacy oblique top camera type. + * Represents a patterned fill type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyObliqueTop = "LegacyObliqueTop", + patterned = "Patterned", /** - * Represents a legacy oblique top-right camera type. + * Represents a gradient fill type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyObliqueTopRight = "LegacyObliqueTopRight", + gradient = "Gradient", /** - * Represents a legacy oblique left camera type. + * Represents a textured fill type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyObliqueLeft = "LegacyObliqueLeft", + textured = "Textured", /** - * Represents a legacy oblique front camera type. + * Represents a background fill type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyObliqueFront = "LegacyObliqueFront", + background = "Background", /** - * Represents a legacy oblique right camera type. + * Represents a picture fill type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyObliqueRight = "LegacyObliqueRight", + picture = "Picture", + } + /** + * Specifies the type of gradient used in a shape's fill. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum GradientColorType { /** - * Represents a legacy oblique bottom-left camera type. + * Mixed gradient color type. Used when multiple shapes with different gradient types are selected. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyObliqueBottomLeft = "LegacyObliqueBottomLeft", + mixed = "Mixed", /** - * Represents a legacy oblique bottom camera type. + * Gradient with a single color and varying transparency or brightness. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyObliqueBottom = "LegacyObliqueBottom", + oneColor = "OneColor", /** - * Represents a legacy oblique bottom-right camera type. + * Gradient that blends two distinct colors. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyObliqueBottomRight = "LegacyObliqueBottomRight", + twoColors = "TwoColors", /** - * Represents a legacy perspective top-left camera type. + * Gradient that uses a predefined set of colors. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyPerspectiveTopLeft = "LegacyPerspectiveTopLeft", + presetColors = "PresetColors", /** - * Represents a legacy perspective top camera type. + * Gradient that includes more than two colors, often customized. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyPerspectiveTop = "LegacyPerspectiveTop", + multiColor = "MultiColor", + } + /** + * Specifies the style for a gradient fill. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum GradientStyle { /** - * Represents a legacy perspective top-right camera type. + * Represents a mixed gradient style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyPerspectiveTopRight = "LegacyPerspectiveTopRight", + mixed = "Mixed", /** - * Represents a legacy perspective left camera type. + * Represents a horizontal gradient style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyPerspectiveLeft = "LegacyPerspectiveLeft", + horizontal = "Horizontal", /** - * Represents a legacy perspective front camera type. + * Represents a vertical gradient style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyPerspectiveFront = "LegacyPerspectiveFront", + vertical = "Vertical", /** - * Represents a legacy perspective right camera type. + * Represents a diagonal-up gradient style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyPerspectiveRight = "LegacyPerspectiveRight", + diagonalUp = "DiagonalUp", /** - * Represents a legacy perspective bottom-left camera type. + * Represents a diagonal-down gradient style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyPerspectiveBottomLeft = "LegacyPerspectiveBottomLeft", + diagonalDown = "DiagonalDown", /** - * Represents a legacy perspective bottom camera type. + * Represents a gradient style from the corner. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyPerspectiveBottom = "LegacyPerspectiveBottom", + fromCorner = "FromCorner", /** - * Represents a legacy perspective bottom-right camera type. + * Represents a gradient style from the title. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legacyPerspectiveBottomRight = "LegacyPerspectiveBottomRight", + fromTitle = "FromTitle", /** - * Represents an orthographic front camera type. + * Represents a gradient style from the center. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - orthographicFront = "OrthographicFront", + fromCenter = "FromCenter", + } + /** + * Specifies the type of ligature applied to a font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum Ligature { /** - * Represents an isometric top-up camera type. + * No ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricTopUp = "IsometricTopUp", + none = "None", /** - * Represents an isometric top-down camera type. + * Standard ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricTopDown = "IsometricTopDown", + standard = "Standard", /** - * Represents an isometric bottom-up camera type. + * Contextual ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricBottomUp = "IsometricBottomUp", + contextual = "Contextual", /** - * Represents an isometric bottom-down camera type. + * Standard and contextual ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricBottomDown = "IsometricBottomDown", + standardContextual = "StandardContextual", /** - * Represents an isometric left-up camera type. + * Historical ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricLeftUp = "IsometricLeftUp", + historical = "Historical", /** - * Represents an isometric left-down camera type. + * Standard and historical ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricLeftDown = "IsometricLeftDown", + standardHistorical = "StandardHistorical", /** - * Represents an isometric right-up camera type. + * Contextual and historical ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricRightUp = "IsometricRightUp", + contextualHistorical = "ContextualHistorical", /** - * Represents an isometric right-down camera type. + * Standard, contextual, and historical ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricRightDown = "IsometricRightDown", + standardContextualHistorical = "StandardContextualHistorical", /** - * Represents an isometric off-axis 1 left camera type. + * Discretional ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis1Left = "IsometricOffAxis1Left", + discretional = "Discretional", /** - * Represents an isometric off-axis 1 right camera type. + * Standard and discretional ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis1Right = "IsometricOffAxis1Right", + standardDiscretional = "StandardDiscretional", /** - * Represents an isometric off-axis 1 top camera type. + * Contextual and discretional ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis1Top = "IsometricOffAxis1Top", + contextualDiscretional = "ContextualDiscretional", /** - * Represents an isometric off-axis 2 left camera type. + * Standard, contextual, and discretional ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis2Left = "IsometricOffAxis2Left", + standardContextualDiscretional = "StandardContextualDiscretional", /** - * Represents an isometric off-axis 2 right camera type. + * Historical and discretional ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis2Right = "IsometricOffAxis2Right", + historicalDiscretional = "HistoricalDiscretional", /** - * Represents an isometric off-axis 2 top camera type. + * Standard, historical, and discretional ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis2Top = "IsometricOffAxis2Top", + standardHistoricalDiscretional = "StandardHistoricalDiscretional", /** - * Represents an isometric off-axis 3 left camera type. + * Contextual, historical, and discretional ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis3Left = "IsometricOffAxis3Left", + contextualHistoricalDiscretional = "ContextualHistoricalDiscretional", /** - * Represents an isometric off-axis 3 right camera type. + * All ligatures applied. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis3Right = "IsometricOffAxis3Right", + all = "All", + } + /** + * Indicates the effects lighting for an object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum LightRigType { /** - * Represents an isometric off-axis 3 bottom camera type. + * Represents a mixed light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis3Bottom = "IsometricOffAxis3Bottom", + mixed = "Mixed", /** - * Represents an isometric off-axis 4 left camera type. + * Represents legacy flat light rig type 1. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis4Left = "IsometricOffAxis4Left", + legacyFlat1 = "LegacyFlat1", /** - * Represents an isometric off-axis 4 right camera type. + * Represents legacy flat light rig type 2. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis4Right = "IsometricOffAxis4Right", + legacyFlat2 = "LegacyFlat2", /** - * Represents an isometric off-axis 4 bottom camera type. + * Represents legacy flat light rig type 3. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isometricOffAxis4Bottom = "IsometricOffAxis4Bottom", + legacyFlat3 = "LegacyFlat3", /** - * Represents an oblique top-left camera type. + * Represents legacy flat light rig type 4. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - obliqueTopLeft = "ObliqueTopLeft", + legacyFlat4 = "LegacyFlat4", /** - * Represents an oblique top camera type. + * Represents legacy normal light rig type 1. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - obliqueTop = "ObliqueTop", + legacyNormal1 = "LegacyNormal1", /** - * Represents an oblique top-right camera type. + * Represents legacy normal light rig type 2. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - obliqueTopRight = "ObliqueTopRight", + legacyNormal2 = "LegacyNormal2", /** - * Represents an oblique left camera type. + * Represents legacy normal light rig type 3. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - obliqueLeft = "ObliqueLeft", + legacyNormal3 = "LegacyNormal3", /** - * Represents an oblique right camera type. + * Represents legacy normal light rig type 4. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - obliqueRight = "ObliqueRight", + legacyNormal4 = "LegacyNormal4", /** - * Represents an oblique bottom-left camera type. + * Represents legacy harsh light rig type 1. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - obliqueBottomLeft = "ObliqueBottomLeft", + legacyHarsh1 = "LegacyHarsh1", /** - * Represents an oblique bottom camera type. + * Represents legacy harsh light rig type 2. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - obliqueBottom = "ObliqueBottom", + legacyHarsh2 = "LegacyHarsh2", /** - * Represents an oblique bottom-right camera type. + * Represents legacy harsh light rig type 3. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - obliqueBottomRight = "ObliqueBottomRight", + legacyHarsh3 = "LegacyHarsh3", /** - * Represents a perspective front camera type. + * Represents legacy harsh light rig type 4. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveFront = "PerspectiveFront", + legacyHarsh4 = "LegacyHarsh4", /** - * Represents a perspective left camera type. + * Represents a three-point light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveLeft = "PerspectiveLeft", + threePoint = "ThreePoint", /** - * Represents a perspective right camera type. + * Represents a balanced light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveRight = "PerspectiveRight", + balanced = "Balanced", /** - * Represents a perspective above camera type. + * Represents a soft light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveAbove = "PerspectiveAbove", + soft = "Soft", /** - * Represents a perspective below camera type. + * Represents a harsh light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveBelow = "PerspectiveBelow", + harsh = "Harsh", /** - * Represents a perspective above-left facing camera type. + * Represents a flood light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveAboveLeftFacing = "PerspectiveAboveLeftFacing", + flood = "Flood", /** - * Represents a perspective above-right facing camera type. + * Represents a contrasting light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveAboveRightFacing = "PerspectiveAboveRightFacing", + contrasting = "Contrasting", /** - * Represents a perspective contrasting-left facing camera type. + * Represents a morning light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveContrastingLeftFacing = "PerspectiveContrastingLeftFacing", + morning = "Morning", /** - * Represents a perspective contrasting-right facing camera type. + * Represents a sunrise light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveContrastingRightFacing = "PerspectiveContrastingRightFacing", + sunrise = "Sunrise", /** - * Represents a perspective heroic-left facing camera type. + * Represents a sunset light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveHeroicLeftFacing = "PerspectiveHeroicLeftFacing", + sunset = "Sunset", /** - * Represents a perspective heroic-right facing camera type. + * Represents a chilly light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveHeroicRightFacing = "PerspectiveHeroicRightFacing", + chilly = "Chilly", /** - * Represents a perspective heroic-extreme left facing camera type. + * Represents a freezing light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveHeroicExtremeLeftFacing = "PerspectiveHeroicExtremeLeftFacing", + freezing = "Freezing", /** - * Represents a perspective heroic-extreme right facing camera type. + * Represents a flat light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveHeroicExtremeRightFacing = "PerspectiveHeroicExtremeRightFacing", + flat = "Flat", /** - * Represents a relaxed perspective camera type. + * Represents a two-point light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveRelaxed = "PerspectiveRelaxed", + twoPoint = "TwoPoint", /** - * Represents a moderately relaxed perspective camera type. + * Represents a glow light rig type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - perspectiveRelaxedModerately = "PerspectiveRelaxedModerately", + glow = "Glow", + /** + * Represents a bright room light rig type. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + brightRoom = "BrightRoom", } /** - * Specifies the direction that the extrusion's sweep path takes away from the extruded shape (the front face of the extrusion). + * Specifies the dash style for a line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum PresetExtrusionDirection { + enum LineDashStyle { /** - * Represents a mixed extrusion direction. + * Represents a mixed dash style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ mixed = "Mixed", /** - * Represents an extrusion direction to the bottom-right. + * Represents a solid line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottomRight = "BottomRight", + solid = "Solid", /** - * Represents an extrusion direction to the bottom. + * Represents a square dot line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottom = "Bottom", + squareDot = "SquareDot", /** - * Represents an extrusion direction to the bottom-left. + * Represents a round dot line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottomLeft = "BottomLeft", + roundDot = "RoundDot", /** - * Represents an extrusion direction to the right. + * Represents a dashed line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - right = "Right", + dash = "Dash", /** - * Represents no extrusion direction. + * Represents a dash-dot line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + dashDot = "DashDot", /** - * Represents an extrusion direction to the left. + * Represents a dash-dot-dot line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - left = "Left", + dashDotDot = "DashDotDot", /** - * Represents an extrusion direction to the top-right. + * Represents a long dash line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - topRight = "TopRight", + longDash = "LongDash", /** - * Represents an extrusion direction to the top. + * Represents a long dash-dot line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - top = "Top", + longDashDot = "LongDashDot", /** - * Represents an extrusion direction to the top-left. + * Represents a long dash-dot-dot line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - topLeft = "TopLeft", - } - /** - * Specifies which predefined gradient to use to fill a shape. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum PresetGradientType { + longDashDotDot = "LongDashDotDot", /** - * Mixed gradient type. Used when multiple shapes with different preset gradients are selected. + * Represents a system dash line style. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sysDash = "SysDash", + /** + * Represents a system dot line style. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sysDot = "SysDot", + /** + * Represents a system dash-dot line style. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sysDashDot = "SysDashDot", + } + /** + * Specifies the style for a line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum LineFormatStyle { + /** + * Represents a mixed line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ mixed = "Mixed", /** - * A warm gradient resembling an early sunset. + * Represents a single line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - earlySunset = "EarlySunset", + single = "Single", /** - * A deeper, richer gradient resembling a late sunset. + * Represents a thin-thin line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lateSunset = "LateSunset", + thinThin = "ThinThin", /** - * A dark gradient evoking the colors of nightfall. + * Represents a thin-thick line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nightfall = "Nightfall", + thinThick = "ThinThick", /** - * A light gradient representing the colors of daybreak. + * Represents a thick-thin line style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - daybreak = "Daybreak", + thickThin = "ThickThin", /** - * A gradient that mimics the colors of the horizon. + * Represents a thick line between two thin lines style. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizon = "Horizon", + thickBetweenThin = "ThickBetweenThin", + } + /** + * Specifies the portion of a list to which to apply a list template. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ListApplyTo { /** - * A warm, sandy gradient inspired by desert tones. + * Applies the list template to the entire list. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - desert = "Desert", + wholeList = "WholeList", /** - * A cool gradient reflecting ocean hues. + * Applies the list template from the cursor insertion point to the end of the list. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - ocean = "Ocean", + thisPointForward = "ThisPointForward", /** - * A soft, tranquil gradient resembling calm water. + * Applies the list template to the selection. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - calmWater = "CalmWater", + selection = "Selection", + } + /** + * Represents the list type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ListType { /** - * A vivid gradient with fiery tones. + * List with no bullets, numbering, or outlining. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fire = "Fire", + listNoNumbering = "ListNoNumbering", /** - * A muted gradient with fog-like softness. + * ListNum fields that can be used in the body of a paragraph. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fog = "Fog", + listListNumOnly = "ListListNumOnly", /** - * A natural green gradient inspired by moss. + * Bulleted list. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - moss = "Moss", + listBullet = "ListBullet", /** - * A vibrant gradient with peacock feather colors. + * Simple numeric list. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - peacock = "Peacock", + listSimpleNumbering = "ListSimpleNumbering", /** - * A light, golden gradient resembling wheat. + * Outlined list. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - wheat = "Wheat", + listOutlineNumbering = "ListOutlineNumbering", /** - * A warm, aged paper-like gradient. + * Mixed numeric list. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - parchment = "Parchment", + listMixedNumbering = "ListMixedNumbering", /** - * A rich, reddish-brown gradient like mahogany wood. + * Picture bulleted list. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mahogany = "Mahogany", + listPictureBullet = "ListPictureBullet", + } + /** + * Specifies the number form setting for an OpenType font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum NumberForm { /** - * A colorful gradient resembling a rainbow. + * Default number form setting. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rainbow = "Rainbow", + default = "Default", /** - * A variation of the rainbow gradient with different color emphasis. + * Lining number form setting. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rainbowII = "RainbowII", + lining = "Lining", /** - * A shiny, metallic gold gradient. + * Old-style number form setting. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gold = "Gold", + oldStyle = "OldStyle", + } + /** + * Specifies the number spacing setting for an OpenType font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum NumberSpacing { /** - * A variation of the gold gradient with different tones. + * Default number spacing setting. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - goldII = "GoldII", + default = "Default", /** - * A metallic gradient resembling brass. + * Proportional number spacing setting. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - brass = "Brass", + proportional = "Proportional", /** - * A sleek, reflective chrome gradient. + * Tabular number spacing setting. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - chrome = "Chrome", + tabular = "Tabular", + } + /** + * Specifies the type of numbers in a list. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum NumberType { /** - * A variation of the chrome gradient with alternate highlights. + * Preset numbers you can add to paragraphs by selecting a template in the **Bullets and Numbering** dialog box. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - chromeII = "ChromeII", + paragraph = "Paragraph", /** - * A smooth, metallic silver gradient. + * Default value for {@link https://support.microsoft.com/office/557541b1-abb2-4959-a9f2-401639c8ff82 | ListNum fields}. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - silver = "Silver", + listNum = "ListNum", /** - * A deep blue gradient inspired by sapphire. + * Default value for all other cases. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sapphire = "Sapphire", + allNumbers = "AllNumbers", } /** - * Specifies the location of lighting on an extruded (three-dimensional) shape relative to the shape. + * Specifies the fill pattern used in a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum PresetLightingDirection { + enum PatternType { /** - * Represents a mixed lighting direction. + * Represents a mixed pattern type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ mixed = "Mixed", /** - * Represents lighting from the top-left. + * Represents a 5 percent fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - topLeft = "TopLeft", + percent5 = "Percent5", /** - * Represents lighting from the top. + * Represents a 10 percent fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - top = "Top", + percent10 = "Percent10", /** - * Represents lighting from the top-right. + * Represents a 20 percent fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - topRight = "TopRight", + percent20 = "Percent20", /** - * Represents lighting from the left. + * Represents a 25 percent fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - left = "Left", + percent25 = "Percent25", /** - * Represents no lighting. + * Represents a 30 percent fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + percent30 = "Percent30", /** - * Represents lighting from the right. + * Represents a 40 percent fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - right = "Right", + percent40 = "Percent40", /** - * Represents lighting from the bottom-left. + * Represents a 50 percent fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottomLeft = "BottomLeft", + percent50 = "Percent50", /** - * Represents lighting from the bottom. + * Represents a 60 percent fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottom = "Bottom", + percent60 = "Percent60", /** - * Represents lighting from the bottom-right. + * Represents a 70 percent fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottomRight = "BottomRight", - } - /** - * Specifies the intensity of light used on a shape. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum PresetLightingSoftness { + percent70 = "Percent70", /** - * Represents a mixed lighting softness. + * Represents a 75 percent fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + percent75 = "Percent75", /** - * Represents dim lighting. + * Represents an 80 percent fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dim = "Dim", + percent80 = "Percent80", /** - * Represents normal lighting. + * Represents a 90 percent fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - normal = "Normal", + percent90 = "Percent90", /** - * Represents bright lighting. + * Represents a dark horizontal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bright = "Bright", - } - /** - * Specifies the extrusion surface material. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum PresetMaterial { + darkHorizontal = "DarkHorizontal", /** - * Represents a mixed material type. + * Represents a dark vertical fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + darkVertical = "DarkVertical", /** - * Represents a matte material. + * Represents a dark downward diagonal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - matte = "Matte", + darkDownwardDiagonal = "DarkDownwardDiagonal", /** - * Represents a plastic material. + * Represents a dark upward diagonal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - plastic = "Plastic", + darkUpwardDiagonal = "DarkUpwardDiagonal", /** - * Represents a metal material. + * Represents a small checkerboard fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - metal = "Metal", + smallCheckerBoard = "SmallCheckerBoard", /** - * Represents a wireframe material. + * Represents a trellis fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - wireFrame = "WireFrame", + trellis = "Trellis", /** - * Represents a second matte material. + * Represents a light horizontal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - matte2 = "Matte2", + lightHorizontal = "LightHorizontal", /** - * Represents a second plastic material. + * Represents a light vertical fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - plastic2 = "Plastic2", + lightVertical = "LightVertical", /** - * Represents a second metal material. + * Represents a light downward diagonal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - metal2 = "Metal2", + lightDownwardDiagonal = "LightDownwardDiagonal", /** - * Represents a warm matte material. + * Represents a light upward diagonal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - warmMatte = "WarmMatte", + lightUpwardDiagonal = "LightUpwardDiagonal", /** - * Represents a translucent powder material. + * Represents a small grid fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - translucentPowder = "TranslucentPowder", + smallGrid = "SmallGrid", /** - * Represents a powder material. + * Represents a dotted diamond fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - powder = "Powder", + dottedDiamond = "DottedDiamond", /** - * Represents a dark edge material. + * Represents a wide downward diagonal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - darkEdge = "DarkEdge", + wideDownwardDiagonal = "WideDownwardDiagonal", /** - * Represents a soft edge material. + * Represents a wide upward diagonal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - softEdge = "SoftEdge", + wideUpwardDiagonal = "WideUpwardDiagonal", /** - * Represents a clear material. + * Represents a dashed upward diagonal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - clear = "Clear", + dashedUpwardDiagonal = "DashedUpwardDiagonal", /** - * Represents a flat material. + * Represents a dashed downward diagonal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - flat = "Flat", + dashedDownwardDiagonal = "DashedDownwardDiagonal", /** - * Represents a soft metal material. + * Represents a narrow vertical fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - softMetal = "SoftMetal", - } - /** - * Specifies texture to be used to fill a shape. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum PresetTexture { + narrowVertical = "NarrowVertical", /** - * Represents a mixed texture type. + * Represents a narrow horizontal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + narrowHorizontal = "NarrowHorizontal", /** - * Represents a papyrus texture. + * Represents a dashed vertical fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - papyrus = "Papyrus", + dashedVertical = "DashedVertical", /** - * Represents a canvas texture. + * Represents a dashed horizontal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - canvas = "Canvas", + dashedHorizontal = "DashedHorizontal", /** - * Represents a denim texture. + * Represents a large confetti fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - denim = "Denim", + largeConfetti = "LargeConfetti", /** - * Represents a woven mat texture. + * Represents a large grid fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - wovenMat = "WovenMat", + largeGrid = "LargeGrid", /** - * Represents a water droplets texture. + * Represents a horizontal brick fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - waterDroplets = "WaterDroplets", + horizontalBrick = "HorizontalBrick", /** - * Represents a paper bag texture. + * Represents a large checkerboard fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - paperBag = "PaperBag", + largeCheckerBoard = "LargeCheckerBoard", /** - * Represents a fish fossil texture. + * Represents a small confetti fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fishFossil = "FishFossil", + smallConfetti = "SmallConfetti", /** - * Represents a sand texture. + * Represents a zigzag fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sand = "Sand", + zigZag = "ZigZag", /** - * Represents a green marble texture. + * Represents a solid diamond fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - greenMarble = "GreenMarble", + solidDiamond = "SolidDiamond", /** - * Represents a white marble texture. + * Represents a diagonal brick fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - whiteMarble = "WhiteMarble", + diagonalBrick = "DiagonalBrick", /** - * Represents a brown marble texture. + * Represents an outlined diamond fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - brownMarble = "BrownMarble", + outlinedDiamond = "OutlinedDiamond", /** - * Represents a granite texture. + * Represents a plaid fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - granite = "Granite", + plaid = "Plaid", /** - * Represents a newsprint texture. + * Represents a sphere fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - newsprint = "Newsprint", + sphere = "Sphere", /** - * Represents a recycled paper texture. + * Represents a weave fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - recycledPaper = "RecycledPaper", + weave = "Weave", /** - * Represents a parchment texture. + * Represents a dotted grid fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - parchment = "Parchment", + dottedGrid = "DottedGrid", /** - * Represents a stationery texture. + * Represents a divot fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - stationery = "Stationery", + divot = "Divot", /** - * Represents a blue tissue paper texture. + * Represents a shingle fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - blueTissuePaper = "BlueTissuePaper", + shingle = "Shingle", /** - * Represents a pink tissue paper texture. + * Represents a wave fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pinkTissuePaper = "PinkTissuePaper", + wave = "Wave", /** - * Represents a purple mesh texture. + * Represents a horizontal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - purpleMesh = "PurpleMesh", + horizontal = "Horizontal", /** - * Represents a bouquet texture. + * Represents a vertical fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bouquet = "Bouquet", + vertical = "Vertical", /** - * Represents a cork texture. + * Represents a cross fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cork = "Cork", + cross = "Cross", /** - * Represents a walnut texture. + * Represents a downward diagonal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - walnut = "Walnut", + downwardDiagonal = "DownwardDiagonal", /** - * Represents an oak texture. + * Represents an upward diagonal fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - oak = "Oak", + upwardDiagonal = "UpwardDiagonal", /** - * Represents a medium wood texture. + * Represents a diagonal cross fill pattern. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mediumWood = "MediumWood", + diagonalCross = "DiagonalCross", } /** - * Specifies an extrusion (three-dimensional) format. + * Indicates the effects camera type used by the specified object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum PresetThreeDimensionalFormat { + enum PresetCamera { /** - * Represents a mixed three-dimensional format. + * Represents a mixed camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ mixed = "Mixed", /** - * Represents three-dimensional format 1. + * Represents a legacy oblique top-left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format1 = "Format1", + legacyObliqueTopLeft = "LegacyObliqueTopLeft", /** - * Represents three-dimensional format 2. + * Represents a legacy oblique top camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format2 = "Format2", + legacyObliqueTop = "LegacyObliqueTop", /** - * Represents three-dimensional format 3. + * Represents a legacy oblique top-right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format3 = "Format3", + legacyObliqueTopRight = "LegacyObliqueTopRight", /** - * Represents three-dimensional format 4. + * Represents a legacy oblique left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format4 = "Format4", + legacyObliqueLeft = "LegacyObliqueLeft", /** - * Represents three-dimensional format 5. + * Represents a legacy oblique front camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format5 = "Format5", + legacyObliqueFront = "LegacyObliqueFront", /** - * Represents three-dimensional format 6. + * Represents a legacy oblique right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format6 = "Format6", + legacyObliqueRight = "LegacyObliqueRight", /** - * Represents three-dimensional format 7. + * Represents a legacy oblique bottom-left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format7 = "Format7", + legacyObliqueBottomLeft = "LegacyObliqueBottomLeft", /** - * Represents three-dimensional format 8. + * Represents a legacy oblique bottom camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format8 = "Format8", + legacyObliqueBottom = "LegacyObliqueBottom", /** - * Represents three-dimensional format 9. + * Represents a legacy oblique bottom-right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format9 = "Format9", + legacyObliqueBottomRight = "LegacyObliqueBottomRight", /** - * Represents three-dimensional format 10. + * Represents a legacy perspective top-left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format10 = "Format10", + legacyPerspectiveTopLeft = "LegacyPerspectiveTopLeft", /** - * Represents three-dimensional format 11. + * Represents a legacy perspective top camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format11 = "Format11", + legacyPerspectiveTop = "LegacyPerspectiveTop", /** - * Represents three-dimensional format 12. + * Represents a legacy perspective top-right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format12 = "Format12", + legacyPerspectiveTopRight = "LegacyPerspectiveTopRight", /** - * Represents three-dimensional format 13. + * Represents a legacy perspective left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format13 = "Format13", + legacyPerspectiveLeft = "LegacyPerspectiveLeft", /** - * Represents three-dimensional format 14. + * Represents a legacy perspective front camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format14 = "Format14", + legacyPerspectiveFront = "LegacyPerspectiveFront", /** - * Represents three-dimensional format 15. + * Represents a legacy perspective right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format15 = "Format15", + legacyPerspectiveRight = "LegacyPerspectiveRight", /** - * Represents three-dimensional format 16. + * Represents a legacy perspective bottom-left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format16 = "Format16", + legacyPerspectiveBottomLeft = "LegacyPerspectiveBottomLeft", /** - * Represents three-dimensional format 17. + * Represents a legacy perspective bottom camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format17 = "Format17", + legacyPerspectiveBottom = "LegacyPerspectiveBottom", /** - * Represents three-dimensional format 18. + * Represents a legacy perspective bottom-right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format18 = "Format18", + legacyPerspectiveBottomRight = "LegacyPerspectiveBottomRight", /** - * Represents three-dimensional format 19. + * Represents an orthographic front camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format19 = "Format19", + orthographicFront = "OrthographicFront", /** - * Represents three-dimensional format 20. + * Represents an isometric top-up camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - format20 = "Format20", - } - /** - * Specifies the type of the {@link Word.ReflectionFormat} object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ReflectionType { - /** - * Represents a mixed reflection type. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - mixed = "Mixed", - /** - * Represents no reflection. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - none = "None", + isometricTopUp = "IsometricTopUp", /** - * Represents reflection type 1. + * Represents an isometric top-down camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type1 = "Type1", + isometricTopDown = "IsometricTopDown", /** - * Represents reflection type 2. + * Represents an isometric bottom-up camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type2 = "Type2", + isometricBottomUp = "IsometricBottomUp", /** - * Represents reflection type 3. + * Represents an isometric bottom-down camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type3 = "Type3", + isometricBottomDown = "IsometricBottomDown", /** - * Represents reflection type 4. + * Represents an isometric left-up camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type4 = "Type4", + isometricLeftUp = "IsometricLeftUp", /** - * Represents reflection type 5. + * Represents an isometric left-down camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type5 = "Type5", + isometricLeftDown = "IsometricLeftDown", /** - * Represents reflection type 6. + * Represents an isometric right-up camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type6 = "Type6", + isometricRightUp = "IsometricRightUp", /** - * Represents reflection type 7. + * Represents an isometric right-down camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type7 = "Type7", + isometricRightDown = "IsometricRightDown", /** - * Represents reflection type 8. + * Represents an isometric off-axis 1 left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type8 = "Type8", + isometricOffAxis1Left = "IsometricOffAxis1Left", /** - * Represents reflection type 9. + * Represents an isometric off-axis 1 right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type9 = "Type9", - } - /** - * Specifies the type of shadowing effect. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ShadowStyle { + isometricOffAxis1Right = "IsometricOffAxis1Right", /** - * Represents a mixed shadow style. + * Represents an isometric off-axis 1 top camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + isometricOffAxis1Top = "IsometricOffAxis1Top", /** - * Represents an outer shadow style. + * Represents an isometric off-axis 2 left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - outerShadow = "OuterShadow", + isometricOffAxis2Left = "IsometricOffAxis2Left", /** - * Represents an inner shadow style. + * Represents an isometric off-axis 2 right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - innerShadow = "InnerShadow", - } - /** - * Specifies the type of shadow displayed with a shape. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ShadowType { + isometricOffAxis2Right = "IsometricOffAxis2Right", /** - * Represents a mixed shadow type. + * Represents an isometric off-axis 2 top camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", + isometricOffAxis2Top = "IsometricOffAxis2Top", /** - * Represents shadow type 1. + * Represents an isometric off-axis 3 left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type1 = "Type1", + isometricOffAxis3Left = "IsometricOffAxis3Left", /** - * Represents shadow type 2. + * Represents an isometric off-axis 3 right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type2 = "Type2", + isometricOffAxis3Right = "IsometricOffAxis3Right", /** - * Represents shadow type 3. + * Represents an isometric off-axis 3 bottom camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type3 = "Type3", + isometricOffAxis3Bottom = "IsometricOffAxis3Bottom", /** - * Represents shadow type 4. + * Represents an isometric off-axis 4 left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type4 = "Type4", + isometricOffAxis4Left = "IsometricOffAxis4Left", /** - * Represents shadow type 5. + * Represents an isometric off-axis 4 right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type5 = "Type5", + isometricOffAxis4Right = "IsometricOffAxis4Right", /** - * Represents shadow type 6. + * Represents an isometric off-axis 4 bottom camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type6 = "Type6", + isometricOffAxis4Bottom = "IsometricOffAxis4Bottom", /** - * Represents shadow type 7. + * Represents an oblique top-left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type7 = "Type7", + obliqueTopLeft = "ObliqueTopLeft", /** - * Represents shadow type 8. + * Represents an oblique top camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type8 = "Type8", + obliqueTop = "ObliqueTop", /** - * Represents shadow type 9. + * Represents an oblique top-right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type9 = "Type9", + obliqueTopRight = "ObliqueTopRight", /** - * Represents shadow type 10. + * Represents an oblique left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type10 = "Type10", + obliqueLeft = "ObliqueLeft", /** - * Represents shadow type 11. + * Represents an oblique right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type11 = "Type11", + obliqueRight = "ObliqueRight", /** - * Represents shadow type 12. + * Represents an oblique bottom-left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type12 = "Type12", + obliqueBottomLeft = "ObliqueBottomLeft", /** - * Represents shadow type 13. + * Represents an oblique bottom camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type13 = "Type13", + obliqueBottom = "ObliqueBottom", /** - * Represents shadow type 14. + * Represents an oblique bottom-right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type14 = "Type14", + obliqueBottomRight = "ObliqueBottomRight", /** - * Represents shadow type 15. + * Represents a perspective front camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type15 = "Type15", + perspectiveFront = "PerspectiveFront", /** - * Represents shadow type 16. + * Represents a perspective left camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type16 = "Type16", + perspectiveLeft = "PerspectiveLeft", /** - * Represents shadow type 17. + * Represents a perspective right camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type17 = "Type17", + perspectiveRight = "PerspectiveRight", /** - * Represents shadow type 18. + * Represents a perspective above camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type18 = "Type18", + perspectiveAbove = "PerspectiveAbove", /** - * Represents shadow type 19. + * Represents a perspective below camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type19 = "Type19", + perspectiveBelow = "PerspectiveBelow", /** - * Represents shadow type 20. + * Represents a perspective above-left facing camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type20 = "Type20", + perspectiveAboveLeftFacing = "PerspectiveAboveLeftFacing", /** - * Represents shadow type 21. + * Represents a perspective above-right facing camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type21 = "Type21", + perspectiveAboveRightFacing = "PerspectiveAboveRightFacing", /** - * Represents shadow type 22. + * Represents a perspective contrasting-left facing camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type22 = "Type22", + perspectiveContrastingLeftFacing = "PerspectiveContrastingLeftFacing", /** - * Represents shadow type 23. + * Represents a perspective contrasting-right facing camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type23 = "Type23", + perspectiveContrastingRightFacing = "PerspectiveContrastingRightFacing", /** - * Represents shadow type 24. + * Represents a perspective heroic-left facing camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type24 = "Type24", + perspectiveHeroicLeftFacing = "PerspectiveHeroicLeftFacing", /** - * Represents shadow type 25. + * Represents a perspective heroic-right facing camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type25 = "Type25", + perspectiveHeroicRightFacing = "PerspectiveHeroicRightFacing", /** - * Represents shadow type 26. + * Represents a perspective heroic-extreme left facing camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type26 = "Type26", + perspectiveHeroicExtremeLeftFacing = "PerspectiveHeroicExtremeLeftFacing", /** - * Represents shadow type 27. + * Represents a perspective heroic-extreme right facing camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type27 = "Type27", + perspectiveHeroicExtremeRightFacing = "PerspectiveHeroicExtremeRightFacing", /** - * Represents shadow type 28. + * Represents a relaxed perspective camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type28 = "Type28", + perspectiveRelaxed = "PerspectiveRelaxed", /** - * Represents shadow type 29. + * Represents a moderately relaxed perspective camera type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type29 = "Type29", + perspectiveRelaxedModerately = "PerspectiveRelaxedModerately", + } + /** + * Specifies the direction that the extrusion's sweep path takes away from the extruded shape (the front face of the extrusion). + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PresetExtrusionDirection { /** - * Represents shadow type 30. + * Represents a mixed extrusion direction. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type30 = "Type30", + mixed = "Mixed", /** - * Represents shadow type 31. + * Represents an extrusion direction to the bottom-right. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type31 = "Type31", + bottomRight = "BottomRight", /** - * Represents shadow type 32. + * Represents an extrusion direction to the bottom. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type32 = "Type32", + bottom = "Bottom", /** - * Represents shadow type 33. + * Represents an extrusion direction to the bottom-left. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type33 = "Type33", + bottomLeft = "BottomLeft", /** - * Represents shadow type 34. + * Represents an extrusion direction to the right. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type34 = "Type34", + right = "Right", /** - * Represents shadow type 35. + * Represents no extrusion direction. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type35 = "Type35", + none = "None", /** - * Represents shadow type 36. + * Represents an extrusion direction to the left. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type36 = "Type36", + left = "Left", /** - * Represents shadow type 37. + * Represents an extrusion direction to the top-right. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type37 = "Type37", + topRight = "TopRight", /** - * Represents shadow type 38. + * Represents an extrusion direction to the top. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type38 = "Type38", + top = "Top", /** - * Represents shadow type 39. + * Represents an extrusion direction to the top-left. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type39 = "Type39", + topLeft = "TopLeft", + } + /** + * Specifies which predefined gradient to use to fill a shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PresetGradientType { /** - * Represents shadow type 40. + * Mixed gradient type. Used when multiple shapes with different preset gradients are selected. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type40 = "Type40", + mixed = "Mixed", /** - * Represents shadow type 41. + * A warm gradient resembling an early sunset. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type41 = "Type41", + earlySunset = "EarlySunset", /** - * Represents shadow type 42. + * A deeper, richer gradient resembling a late sunset. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type42 = "Type42", + lateSunset = "LateSunset", /** - * Represents shadow type 43. + * A dark gradient evoking the colors of nightfall. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type43 = "Type43", - } - /** - * Specifies the stylistic set to apply to the font. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum StylisticSet { + nightfall = "Nightfall", /** - * Default stylistic set. + * A light gradient representing the colors of daybreak. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - default = "Default", + daybreak = "Daybreak", /** - * Stylistic set 01. + * A gradient that mimics the colors of the horizon. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set01 = "Set01", + horizon = "Horizon", /** - * Stylistic set 02. + * A warm, sandy gradient inspired by desert tones. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set02 = "Set02", + desert = "Desert", /** - * Stylistic set 03. + * A cool gradient reflecting ocean hues. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set03 = "Set03", + ocean = "Ocean", /** - * Stylistic set 04. + * A soft, tranquil gradient resembling calm water. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set04 = "Set04", + calmWater = "CalmWater", /** - * Stylistic set 05. + * A vivid gradient with fiery tones. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set05 = "Set05", + fire = "Fire", /** - * Stylistic set 06. + * A muted gradient with fog-like softness. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set06 = "Set06", + fog = "Fog", /** - * Stylistic set 07. + * A natural green gradient inspired by moss. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set07 = "Set07", + moss = "Moss", /** - * Stylistic set 08. + * A vibrant gradient with peacock feather colors. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set08 = "Set08", + peacock = "Peacock", /** - * Stylistic set 09. + * A light, golden gradient resembling wheat. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set09 = "Set09", + wheat = "Wheat", /** - * Stylistic set 10. + * A warm, aged paper-like gradient. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set10 = "Set10", + parchment = "Parchment", /** - * Stylistic set 11. + * A rich, reddish-brown gradient like mahogany wood. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set11 = "Set11", + mahogany = "Mahogany", /** - * Stylistic set 12. + * A colorful gradient resembling a rainbow. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set12 = "Set12", + rainbow = "Rainbow", /** - * Stylistic set 13. + * A variation of the rainbow gradient with different color emphasis. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set13 = "Set13", + rainbowII = "RainbowII", /** - * Stylistic set 14. + * A shiny, metallic gold gradient. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set14 = "Set14", + gold = "Gold", /** - * Stylistic set 15. + * A variation of the gold gradient with different tones. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set15 = "Set15", + goldII = "GoldII", /** - * Stylistic set 16. + * A metallic gradient resembling brass. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set16 = "Set16", + brass = "Brass", /** - * Stylistic set 17. + * A sleek, reflective chrome gradient. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set17 = "Set17", + chrome = "Chrome", /** - * Stylistic set 18. + * A variation of the chrome gradient with alternate highlights. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set18 = "Set18", + chromeII = "ChromeII", /** - * Stylistic set 19. + * A smooth, metallic silver gradient. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set19 = "Set19", + silver = "Silver", /** - * Stylistic set 20. + * A deep blue gradient inspired by sapphire. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - set20 = "Set20", + sapphire = "Sapphire", } /** - * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. + * Specifies the location of lighting on an extruded (three-dimensional) shape relative to the shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum TextureAlignment { + enum PresetLightingDirection { /** - * Mixed texture alignment. Used when multiple shapes with different texture alignments are selected. + * Represents a mixed lighting direction. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ mixed = "Mixed", /** - * Aligns the texture to the top-left corner of the shape. + * Represents lighting from the top-left. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ topLeft = "TopLeft", /** - * Aligns the texture to the top center of the shape. + * Represents lighting from the top. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ top = "Top", /** - * Aligns the texture to the top-right corner of the shape. + * Represents lighting from the top-right. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ topRight = "TopRight", /** - * Aligns the texture to the middle left side of the shape. + * Represents lighting from the left. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ left = "Left", /** - * Aligns the texture to the center of the shape. + * Represents no lighting. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - center = "Center", + none = "None", /** - * Aligns the texture to the middle right side of the shape. + * Represents lighting from the right. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ right = "Right", /** - * Aligns the texture to the bottom-left corner of the shape. + * Represents lighting from the bottom-left. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ bottomLeft = "BottomLeft", /** - * Aligns the texture to the bottom center of the shape. + * Represents lighting from the bottom. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ bottom = "Bottom", /** - * Aligns the texture to the bottom-right corner of the shape. + * Represents lighting from the bottom-right. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta @@ -131144,7799 +133083,16042 @@ declare namespace Word { bottomRight = "BottomRight", } /** - * Specifies the texture type for the selected fill. + * Specifies the intensity of light used on a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum TextureType { + enum PresetLightingSoftness { /** - * Mixed texture type. Used when multiple shapes with different texture types are selected. + * Represents a mixed lighting softness. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ mixed = "Mixed", /** - * A predefined texture selected from the built-in texture gallery. + * Represents dim lighting. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - preset = "Preset", + dim = "Dim", /** - * A custom texture defined by the user, typically from an image file. + * Represents normal lighting. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - userDefined = "UserDefined", + normal = "Normal", + /** + * Represents bright lighting. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bright = "Bright", } /** - * Specifies the theme colors for document themes. + * Specifies the extrusion surface material. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum ThemeColorIndex { - /** - * Not a theme color. Used when the color is not part of the theme. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - notThemeColor = "NotThemeColor", + enum PresetMaterial { /** - * The first dark color in the main theme. + * Represents a mixed material type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mainDark1 = "MainDark1", + mixed = "Mixed", /** - * The first light color in the main theme. + * Represents a matte material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mainLight1 = "MainLight1", + matte = "Matte", /** - * The second dark color in the main theme. + * Represents a plastic material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mainDark2 = "MainDark2", + plastic = "Plastic", /** - * The second light color in the main theme. + * Represents a metal material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mainLight2 = "MainLight2", + metal = "Metal", /** - * The first accent color in the theme. + * Represents a wireframe material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - accent1 = "Accent1", + wireFrame = "WireFrame", /** - * The second accent color in the theme. + * Represents a second matte material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - accent2 = "Accent2", + matte2 = "Matte2", /** - * The third accent color in the theme. + * Represents a second plastic material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - accent3 = "Accent3", + plastic2 = "Plastic2", /** - * The fourth accent color in the theme. + * Represents a second metal material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - accent4 = "Accent4", + metal2 = "Metal2", /** - * The fifth accent color in the theme. + * Represents a warm matte material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - accent5 = "Accent5", + warmMatte = "WarmMatte", /** - * The sixth accent color in the theme. + * Represents a translucent powder material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - accent6 = "Accent6", + translucentPowder = "TranslucentPowder", /** - * The color used for hyperlinks. + * Represents a powder material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hyperlink = "Hyperlink", + powder = "Powder", /** - * The color used for followed hyperlinks. + * Represents a dark edge material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hyperlinkFollowed = "HyperlinkFollowed", + darkEdge = "DarkEdge", /** - * The first background color in the theme. + * Represents a soft edge material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - background1 = "Background1", + softEdge = "SoftEdge", /** - * The first text color in the theme. + * Represents a clear material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - text1 = "Text1", + clear = "Clear", /** - * The second background color in the theme. + * Represents a flat material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - background2 = "Background2", + flat = "Flat", /** - * The second text color in the theme. + * Represents a soft metal material. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - text2 = "Text2", + softMetal = "SoftMetal", } /** - * Specifies the hyperlink type. + * Specifies texture to be used to fill a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum HyperlinkType { + enum PresetTexture { /** - * Represents a hyperlink to a range in the document. + * Represents a mixed texture type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range = "Range", + mixed = "Mixed", /** - * Represents a hyperlink to a shape in the document. + * Represents a papyrus texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shape = "Shape", + papyrus = "Papyrus", /** - * Represents a hyperlink to an inline shape in the document. + * Represents a canvas texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - inlineShape = "InlineShape", - } - /** - * Represents the list of available sources attached to the document (in the current list) or the list of sources available in the application (in the master list). - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class Bibliography 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; + canvas = "Canvas", /** - * Returns a `SourceCollection` object that represents all the sources contained in the bibliography. - * + * Represents a denim texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly sources: Word.SourceCollection; + denim = "Denim", /** - * Specifies the name of the active style to use for the bibliography. - * + * Represents a woven mat texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bibliographyStyle: string; - /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. - */ - set(properties: Interfaces.BibliographyUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Bibliography): void; + wovenMat = "WovenMat", /** - * Generates a unique identification tag for a bibliography source and returns a string that represents the tag. - * + * Represents a water droplets texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - generateUniqueTag(): OfficeExtension.ClientResult; - /** - * 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?: Word.Interfaces.BibliographyLoadOptions): Word.Bibliography; - /** - * 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[]): Word.Bibliography; - /** - * 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; - }): Word.Bibliography; - /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. - */ - track(): Word.Bibliography; - /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. - */ - untrack(): Word.Bibliography; - /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Bibliography` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BibliographyData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.BibliographyData; - } - /** - * Represents a collection of {@link Word.Source} objects. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class SourceCollection 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: Word.Source[]; + waterDroplets = "WaterDroplets", /** - * Adds a new `Source` object to the collection. - * + * Represents a paper bag texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param xml A string containing the XML data for the source. - * @returns A `Source` object that was added to the collection. */ - add(xml: string): Word.Source; + paperBag = "PaperBag", /** - * Gets a `Source` by its index in the collection. - * + * Represents a fish fossil texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param index A number that identifies the index location of a `Source` object. */ - getItem(index: number): Word.Source; + fishFossil = "FishFossil", /** - * 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. + * Represents a sand texture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.SourceCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.SourceCollection; + sand = "Sand", /** - * 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. + * Represents a green marble texture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.SourceCollection; + greenMarble = "GreenMarble", /** - * 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. + * Represents a white marble texture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.SourceCollection; + whiteMarble = "WhiteMarble", /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + * Represents a brown marble texture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.SourceCollection; + brownMarble = "BrownMarble", /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + * Represents a granite texture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.SourceCollection; + granite = "Granite", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.SourceCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SourceCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * Represents a newsprint texture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.SourceCollectionData; - } - /** - * Represents an individual source, such as a book, journal article, or interview. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class Source 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; + newsprint = "Newsprint", /** - * Gets if the `Source` object has been cited in the document. - * + * Represents a recycled paper texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly isCited: boolean; + recycledPaper = "RecycledPaper", /** - * Gets the tag of the source. - * + * Represents a parchment texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly tag: string; + parchment = "Parchment", /** - * Gets the XML representation of the source. - * + * Represents a stationery texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly xml: string; + stationery = "Stationery", /** - * Deletes the `Source` object. - * + * Represents a blue tissue paper texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - delete(): void; + blueTissuePaper = "BlueTissuePaper", /** - * Returns the value of a field in the bibliography `Source` object. - * + * Represents a pink tissue paper texture. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param name The name of the field to retrieve. */ - getFieldByName(name: string): OfficeExtension.ClientResult; + pinkTissuePaper = "PinkTissuePaper", /** - * 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. + * Represents a purple mesh texture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.SourceLoadOptions): Word.Source; + purpleMesh = "PurpleMesh", /** - * 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. + * Represents a bouquet texture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.Source; + bouquet = "Bouquet", /** - * 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. + * Represents a cork texture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.Source; + cork = "Cork", /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + * Represents a walnut texture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.Source; + walnut = "Walnut", /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + * Represents an oak texture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.Source; + oak = "Oak", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Source` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SourceData`) that contains shallow copies of any loaded child properties from the original object. + * Represents a medium wood texture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.SourceData; + mediumWood = "MediumWood", } /** - * Represents the page setup settings for a Word document or section. + * Specifies an extrusion (three-dimensional) format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - 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; + enum PresetThreeDimensionalFormat { /** - * Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object. - * + * Represents a mixed three-dimensional format. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lineNumbering: Word.LineNumbering; + mixed = "Mixed", /** - * Gets a `TextColumnCollection` object that represents the set of text columns for the `PageSetup` object. - * + * Represents three-dimensional format 1. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly textColumns: Word.TextColumnCollection; + format1 = "Format1", /** - * Specifies whether Microsoft Word prints the document as a booklet. - * + * Represents three-dimensional format 2. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bookFoldPrinting: boolean; + format2 = "Format2", /** - * Specifies the number of pages for each booklet. - * + * Represents three-dimensional format 3. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bookFoldPrintingSheets: number; + format3 = "Format3", /** - * Specifies if Microsoft Word reverses the printing order for book fold printing of bidirectional or Asian language documents. - * + * Represents three-dimensional format 4. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bookFoldReversePrinting: boolean; + format4 = "Format4", /** - * Specifies the distance (in points) between the bottom edge of the page and the bottom boundary of the body text. - * + * Represents three-dimensional format 5. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottomMargin: number; + format5 = "Format5", /** - * Specifies the number of characters per line in the document grid. - * + * Represents three-dimensional format 6. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - charsLine: number; + format6 = "Format6", /** - * Specifies whether the first page has a different header and footer. - * + * Represents three-dimensional format 7. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - differentFirstPageHeaderFooter: boolean; + format7 = "Format7", /** - * Specifies the distance between the footer and the bottom of the page in points. - * + * Represents three-dimensional format 8. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footerDistance: number; + format8 = "Format8", /** - * Specifies the amount (in points) of extra margin space added to each page in a document or section for binding. - * + * Represents three-dimensional format 9. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gutter: number; + format9 = "Format9", /** - * Specifies on which side the gutter appears in a document. - * + * Represents three-dimensional format 10. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gutterPosition: Word.GutterPosition | "Left" | "Right" | "Top"; + format10 = "Format10", /** - * Specifies whether Microsoft Word uses gutters for the current document based on a right-to-left language or a left-to-right language. - * + * Represents three-dimensional format 11. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gutterStyle: Word.GutterStyle | "Bidirectional" | "Latin"; + format11 = "Format11", /** - * Specifies the distance between the header and the top of the page in points. - * + * Represents three-dimensional format 12. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - headerDistance: number; + format12 = "Format12", /** - * Specifies the layout mode for the current document. - * + * Represents three-dimensional format 13. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - layoutMode: Word.LayoutMode | "Default" | "Grid" | "LineGrid" | "Genko"; + format13 = "Format13", /** - * Specifies the distance (in points) between the left edge of the page and the left boundary of the body text. - * + * Represents three-dimensional format 14. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - leftMargin: number; + format14 = "Format14", /** - * Specifies the number of lines per page in the document grid. - * + * Represents three-dimensional format 15. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - linesPage: number; + format15 = "Format15", /** - * Specifies if the inside and outside margins of facing pages are the same width. - * + * Represents three-dimensional format 16. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mirrorMargins: boolean; + format16 = "Format16", /** - * Specifies whether odd and even pages have different headers and footers. - * + * Represents three-dimensional format 17. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - oddAndEvenPagesHeaderFooter: boolean; + format17 = "Format17", /** - * Specifies the orientation of the page. - * + * Represents three-dimensional format 18. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - orientation: Word.PageOrientation | "Portrait" | "Landscape"; + format18 = "Format18", /** - * Specifies the page height in points. - * + * Represents three-dimensional format 19. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageHeight: number; + format19 = "Format19", /** - * Specifies the page width in points. - * + * Represents three-dimensional format 20. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageWidth: number; + format20 = "Format20", + } + /** + * Specifies the type of the {@link Word.ReflectionFormat} object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ReflectionType { /** - * Specifies the paper size of the page. - * + * Represents a mixed reflection type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - paperSize: Word.PaperSize | "Size10x14" | "Size11x17" | "Letter" | "LetterSmall" | "Legal" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "CSheet" | "DSheet" | "ESheet" | "FanfoldLegalGerman" | "FanfoldStdGerman" | "FanfoldUS" | "Folio" | "Ledger" | "Note" | "Quarto" | "Statement" | "Tabloid" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC5" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeDL" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "Custom"; + mixed = "Mixed", /** - * Specifies the distance (in points) between the right edge of the page and the right boundary of the body text. - * + * Represents no reflection. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rightMargin: number; + none = "None", /** - * Specifies the reading order and alignment for the specified sections. - * + * Represents reflection type 1. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sectionDirection: Word.SectionDirection | "RightToLeft" | "LeftToRight"; + type1 = "Type1", /** - * Specifies the type of section break for the specified object. - * + * Represents reflection type 2. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sectionStart: Word.SectionStart | "Continuous" | "NewColumn" | "NewPage" | "EvenPage" | "OddPage"; + type2 = "Type2", /** - * Specifies whether to show the grid. - * + * Represents reflection type 3. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showGrid: boolean; + type3 = "Type3", /** - * Specifies if endnotes are printed at the end of the next section that doesn't suppress endnotes. - * + * Represents reflection type 4. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - suppressEndnotes: boolean; + type4 = "Type4", /** - * Specifies the top margin of the page in points. - * + * Represents reflection type 5. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - topMargin: number; + type5 = "Type5", /** - * Specifies whether to print two pages per sheet. - * + * Represents reflection type 6. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - twoPagesOnOne: boolean; + type6 = "Type6", /** - * Specifies the vertical alignment of text on each page in a document or section. - * + * Represents reflection type 7. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - verticalAlignment: Word.PageSetupVerticalAlignment | "Top" | "Center" | "Justify" | "Bottom"; - /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. - */ - set(properties: Interfaces.PageSetupUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.PageSetup): void; + type7 = "Type7", /** - * Sets the specified page setup formatting as the default for the active document and all new documents based on the active template. - * + * Represents reflection type 8. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - setAsTemplateDefault(): void; + type8 = "Type8", /** - * Switches between portrait and landscape page orientations for a document or section. - * + * Represents reflection type 9. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - togglePortrait(): 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?: Word.Interfaces.PageSetupLoadOptions): Word.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[]): Word.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; - }): Word.PageSetup; + type9 = "Type9", + } + /** + * Specifies the type of shadowing effect. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ShadowStyle { /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + * Represents a mixed shadow style. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.PageSetup; + mixed = "Mixed", /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + * Represents an outer shadow style. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.PageSetup; + outerShadow = "OuterShadow", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.PageSetup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PageSetupData`) that contains shallow copies of any loaded child properties from the original object. + * Represents an inner shadow style. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.PageSetupData; + innerShadow = "InnerShadow", } /** - * Represents line numbers in the left margin or to the left of each newspaper-style column. + * Specifies the type of shadow displayed with a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - class LineNumbering 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 ShadowType { /** - * Specifies the numeric increment for line numbers. - * + * Represents a mixed shadow type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - countBy: number; + mixed = "Mixed", /** - * Specifies the distance (in points) between the right edge of line numbers and the left edge of the document text. - * + * Represents shadow type 1. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - distanceFromText: number; + type1 = "Type1", /** - * Specifies if line numbering is active for the specified document, section, or sections. - * + * Represents shadow type 2. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isActive: boolean; + type2 = "Type2", /** - * Specifies the way line numbering runs; that is, whether it starts over at the beginning of a new page or section, or runs continuously. - * + * Represents shadow type 3. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - restartMode: Word.NumberingRule | "RestartContinuous" | "RestartSection" | "RestartPage"; + type3 = "Type3", /** - * Specifies the starting line number. - * + * Represents shadow type 4. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - startingNumber: number; + type4 = "Type4", /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Represents shadow type 5. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.LineNumberingUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.LineNumbering): void; + type5 = "Type5", /** - * 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?: Word.Interfaces.LineNumberingLoadOptions): Word.LineNumbering; - /** - * 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[]): Word.LineNumbering; - /** - * 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; - }): Word.LineNumbering; - /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. - */ - track(): Word.LineNumbering; - /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. - */ - untrack(): Word.LineNumbering; - /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.LineNumbering` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.LineNumberingData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.LineNumberingData; - } - /** - * A collection of {@link Word.TextColumn} objects that represent all the columns of text in the document or a section of the document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class TextColumnCollection 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: Word.TextColumn[]; - /** - * Returns a `TextColumn` object that represents a new text column added to a section or document. - * + * Represents shadow type 6. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param options Optional. Options for configuring the new text column. - * @returns A `TextColumn` object that represents a new text column added to the document. */ - add(options?: Word.TextColumnAddOptions): Word.TextColumn; + type6 = "Type6", /** - * Gets the direction in which text flows from one text column to the next. - * + * Represents shadow type 7. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - getFlowDirection(): OfficeExtension.ClientResult; + type7 = "Type7", /** - * Gets whether vertical lines appear between all the columns in the `TextColumnCollection` object. - * + * Represents shadow type 8. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - getHasLineBetween(): OfficeExtension.ClientResult; + type8 = "Type8", /** - * Gets whether text columns are evenly spaced. - * + * Represents shadow type 9. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - getIsEvenlySpaced(): OfficeExtension.ClientResult; + type9 = "Type9", /** - * Gets a `TextColumn` by its index in the collection. - * + * Represents shadow type 10. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param index A number that identifies the index location of a `TextColumn` object. */ - getItem(index: number): Word.TextColumn; + type10 = "Type10", /** - * Arranges text into the specified number of text columns. - * + * Represents shadow type 11. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param numColumns The number of columns the text is to be arranged into. */ - setCount(numColumns: number): void; + type11 = "Type11", /** - * Sets the direction in which text flows from one text column to the next. - * + * Represents shadow type 12. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param value The flow direction to set. */ - setFlowDirection(value: Word.FlowDirection): void; + type12 = "Type12", /** - * Sets the direction in which text flows from one text column to the next. - * + * Represents shadow type 13. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param value The flow direction to set. */ - setFlowDirection(value: "LeftToRight" | "RightToLeft"): void; + type13 = "Type13", /** - * Sets whether vertical lines appear between all the columns in the `TextColumnCollection` object. - * + * Represents shadow type 14. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param value `true` to show vertical lines between columns. */ - setHasLineBetween(value: boolean): void; + type14 = "Type14", /** - * Sets whether text columns are evenly spaced. - * + * Represents shadow type 15. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param value `true` to evenly space all the text columns in the document. - */ - setIsEvenlySpaced(value: boolean): 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?: Word.Interfaces.TextColumnCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TextColumnCollection; - /** - * 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[]): Word.TextColumnCollection; - /** - * 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): Word.TextColumnCollection; - /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. - */ - track(): Word.TextColumnCollection; - /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. - */ - untrack(): Word.TextColumnCollection; - /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TextColumnCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TextColumnCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. */ - toJSON(): Word.Interfaces.TextColumnCollectionData; - } - /** - * Represents options for a new text column in a document or section of a document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface TextColumnAddOptions { + type15 = "Type15", /** - * If provided, specifies whether to evenly space all the text columns in the document. The default value is `true`. - * + * Represents shadow type 16. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isEvenlySpaced?: boolean; + type16 = "Type16", /** - * If provided, specifies the spacing between the text columns in the document, in points. - The default value is -1, which means Word will automatically determine the width based on the number of columns and page size. - * + * Represents shadow type 17. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spacing?: number; + type17 = "Type17", /** - * If provided, specifies the width of the new text column in the document, in points. - The default value is -1, which means Word will automatically determine the width based on the number of columns and page size. - * + * Represents shadow type 18. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - width?: number; - } - /** - * Represents a single text column in a section. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class TextColumn 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; + type18 = "Type18", /** - * Specifies the amount of spacing (in points) after the specified paragraph or text column. - * + * Represents shadow type 19. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spaceAfter: number; + type19 = "Type19", /** - * Specifies the width, in points, of the specified text columns. - * + * Represents shadow type 20. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - width: number; - /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. - */ - set(properties: Interfaces.TextColumnUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.TextColumn): 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?: Word.Interfaces.TextColumnLoadOptions): Word.TextColumn; - /** - * 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[]): Word.TextColumn; - /** - * 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; - }): Word.TextColumn; - /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. - */ - track(): Word.TextColumn; - /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. - */ - untrack(): Word.TextColumn; - /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.TextColumn` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TextColumnData`) that contains shallow copies of any loaded child properties from the original object. - */ - toJSON(): Word.Interfaces.TextColumnData; - } - /** - * Specifies the case of the text in the specified range. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum CharacterCase { + type20 = "Type20", /** - * Specifies the next case. + * Represents shadow type 21. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - next = "Next", + type21 = "Type21", /** - * Specifies lowercase. + * Represents shadow type 22. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lower = "Lower", + type22 = "Type22", /** - * Specifies uppercase. + * Represents shadow type 23. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - upper = "Upper", + type23 = "Type23", /** - * Specifies title case for each word. + * Represents shadow type 24. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - titleWord = "TitleWord", + type24 = "Type24", /** - * Specifies title case for the sentence. + * Represents shadow type 25. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - titleSentence = "TitleSentence", + type25 = "Type25", /** - * Specifies toggle case. + * Represents shadow type 26. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - toggle = "Toggle", + type26 = "Type26", /** - * Specifies half-width characters. + * Represents shadow type 27. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - halfWidth = "HalfWidth", + type27 = "Type27", /** - * Specifies full-width characters. + * Represents shadow type 28. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fullWidth = "FullWidth", + type28 = "Type28", /** - * Specifies Katakana characters. + * Represents shadow type 29. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - katakana = "Katakana", + type29 = "Type29", /** - * Specifies Hiragana characters. + * Represents shadow type 30. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hiragana = "Hiragana", - } - /** - * Specifies the character width of the text in the specified range. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum CharacterWidth { + type30 = "Type30", /** - * Specifies half-width characters. + * Represents shadow type 31. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - half = "Half", + type31 = "Type31", /** - * Specifies full-width characters. + * Represents shadow type 32. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - full = "Full", - } - /** - * Specifies the seek view options in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum SeekView { + type32 = "Type32", /** - * Main document. + * Represents shadow type 33. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mainDocument = "MainDocument", + type33 = "Type33", /** - * Primary header. + * Represents shadow type 34. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - primaryHeader = "PrimaryHeader", + type34 = "Type34", /** - * First page header. + * Represents shadow type 35. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - firstPageHeader = "FirstPageHeader", + type35 = "Type35", /** - * Even pages header. + * Represents shadow type 36. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - evenPagesHeader = "EvenPagesHeader", + type36 = "Type36", /** - * Primary footer. + * Represents shadow type 37. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - primaryFooter = "PrimaryFooter", + type37 = "Type37", /** - * First page footer. + * Represents shadow type 38. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - firstPageFooter = "FirstPageFooter", + type38 = "Type38", /** - * Even pages footer. + * Represents shadow type 39. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - evenPagesFooter = "EvenPagesFooter", + type39 = "Type39", /** - * Footnotes. + * Represents shadow type 40. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footnotes = "Footnotes", + type40 = "Type40", /** - * Endnotes. + * Represents shadow type 41. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endnotes = "Endnotes", + type41 = "Type41", /** - * Current page header. + * Represents shadow type 42. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - currentPageHeader = "CurrentPageHeader", + type42 = "Type42", /** - * Current page footer. + * Represents shadow type 43. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - currentPageFooter = "CurrentPageFooter", + type43 = "Type43", } /** - * Specifies the source documents to show. + * Specifies the stylistic set to apply to the font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum ShowSourceDocuments { + enum StylisticSet { /** - * Specifies that no source documents are shown. + * Default stylistic set. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + default = "Default", /** - * Specifies that the original source document is shown. + * Stylistic set 01. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - original = "Original", + set01 = "Set01", /** - * Specifies that the revised source document is shown. + * Stylistic set 02. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - revised = "Revised", + set02 = "Set02", /** - * Specifies that both the original and revised source documents are shown. + * Stylistic set 03. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - both = "Both", - } - /** - * Specifies the special pane options in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum SpecialPane { + set03 = "Set03", /** - * None. + * Stylistic set 04. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + set04 = "Set04", /** - * Primary header. + * Stylistic set 05. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - primaryHeader = "PrimaryHeader", + set05 = "Set05", /** - * First page header. + * Stylistic set 06. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - firstPageHeader = "FirstPageHeader", + set06 = "Set06", /** - * Even pages header. + * Stylistic set 07. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - evenPagesHeader = "EvenPagesHeader", + set07 = "Set07", /** - * Primary footer. + * Stylistic set 08. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - primaryFooter = "PrimaryFooter", + set08 = "Set08", /** - * First page footer. + * Stylistic set 09. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - firstPageFooter = "FirstPageFooter", + set09 = "Set09", /** - * Even pages footer. + * Stylistic set 10. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - evenPagesFooter = "EvenPagesFooter", + set10 = "Set10", /** - * Footnotes. + * Stylistic set 11. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footnotes = "Footnotes", + set11 = "Set11", /** - * Endnotes. + * Stylistic set 12. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endnotes = "Endnotes", + set12 = "Set12", /** - * Footnote continuation notice. + * Stylistic set 13. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footnoteContinuationNotice = "FootnoteContinuationNotice", + set13 = "Set13", /** - * Footnote continuation separator. + * Stylistic set 14. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footnoteContinuationSeparator = "FootnoteContinuationSeparator", + set14 = "Set14", /** - * Footnote separator. + * Stylistic set 15. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footnoteSeparator = "FootnoteSeparator", + set15 = "Set15", /** - * Endnote continuation notice. + * Stylistic set 16. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endnoteContinuationNotice = "EndnoteContinuationNotice", + set16 = "Set16", /** - * Endnote continuation separator. + * Stylistic set 17. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endnoteContinuationSeparator = "EndnoteContinuationSeparator", + set17 = "Set17", /** - * Endnote separator. + * Stylistic set 18. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endnoteSeparator = "EndnoteSeparator", + set18 = "Set18", /** - * Comments. + * Stylistic set 19. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - comments = "Comments", + set19 = "Set19", /** - * Current page header. + * Stylistic set 20. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - currentPageHeader = "CurrentPageHeader", + set20 = "Set20", + } + /** + * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum TextureAlignment { /** - * Current page footer. + * Mixed texture alignment. Used when multiple shapes with different texture alignments are selected. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - currentPageFooter = "CurrentPageFooter", + mixed = "Mixed", /** - * Revisions. + * Aligns the texture to the top-left corner of the shape. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - revisions = "Revisions", + topLeft = "TopLeft", /** - * Revisions horizontal. + * Aligns the texture to the top center of the shape. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - revisionsHoriz = "RevisionsHoriz", + top = "Top", /** - * Revisions vertical. + * Aligns the texture to the top-right corner of the shape. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - revisionsVert = "RevisionsVert", - } - /** - * Specifies the save options. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum SaveConfiguration { + topRight = "TopRight", /** - * Specifies not to save changes. + * Aligns the texture to the middle left side of the shape. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - doNotSaveChanges = "DoNotSaveChanges", + left = "Left", /** - * Specifies to save changes. + * Aligns the texture to the center of the shape. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - saveChanges = "SaveChanges", + center = "Center", /** - * Specifies to prompt to save changes. + * Aligns the texture to the middle right side of the shape. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - promptToSaveChanges = "PromptToSaveChanges", - } - /** - * Specifies the page color options in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum PageColor { + right = "Right", /** - * None. + * Aligns the texture to the bottom-left corner of the shape. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + bottomLeft = "BottomLeft", /** - * Sepia. + * Aligns the texture to the bottom center of the shape. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sepia = "Sepia", + bottom = "Bottom", /** - * Inverse. + * Aligns the texture to the bottom-right corner of the shape. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - inverse = "Inverse", + bottomRight = "BottomRight", } /** - * Specifies the page movement type in a Word document. + * Specifies the texture type for the selected fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum PageMovementType { + enum TextureType { /** - * Vertical. + * Mixed texture type. Used when multiple shapes with different texture types are selected. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - vertical = "Vertical", + mixed = "Mixed", /** - * Side to side. + * A predefined texture selected from the built-in texture gallery. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sideToSide = "SideToSide", + preset = "Preset", + /** + * A custom texture defined by the user, typically from an image file. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + userDefined = "UserDefined", } /** - * Specifies the margin options in reading layout view in a Word document. + * Specifies the theme colors for document themes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum ReadingLayoutMargin { + enum ThemeColorIndex { /** - * Microsoft Word determines automatically whether to show or hide the margins based on the available space. + * Not a theme color. Used when the color is not part of the theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - automatic = "Automatic", + notThemeColor = "NotThemeColor", /** - * Hides margins. + * The first dark color in the main theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - suppress = "Suppress", + mainDark1 = "MainDark1", /** - * Shows margins. + * The first light color in the main theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - full = "Full", - } - /** - * Specifies the margin for revision balloons in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum RevisionsBalloonMargin { + mainLight1 = "MainLight1", /** - * Left margin. + * The second dark color in the main theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - left = "Left", + mainDark2 = "MainDark2", /** - * Right margin. + * The second light color in the main theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - right = "Right", - } - /** - * Specifies the width type for revision balloons in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum RevisionsBalloonWidthType { + mainLight2 = "MainLight2", /** - * Balloon width as a percentage. + * The first accent color in the theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - percent = "Percent", + accent1 = "Accent1", /** - * Balloon width in points. + * The second accent color in the theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - points = "Points", - } - /** - * Specifies the extent of markup visible in the document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum RevisionsMarkup { + accent2 = "Accent2", /** - * No markup. + * The third accent color in the theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + accent3 = "Accent3", /** - * Simple markup. + * The fourth accent color in the theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - simple = "Simple", + accent4 = "Accent4", /** - * All markup. + * The fifth accent color in the theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - all = "All", - } - /** - * Specifies the display mode for tracked changes in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum RevisionsMode { + accent5 = "Accent5", /** - * Balloon. + * The sixth accent color in the theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - balloon = "Balloon", + accent6 = "Accent6", /** - * Inline. + * The color used for hyperlinks. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - inline = "Inline", + hyperlink = "Hyperlink", /** - * Mixed. + * The color used for followed hyperlinks. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mixed = "Mixed", - } - /** - * Specifies whether Word displays the original version of a document or a version with revisions and formatting changes applied. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum RevisionsView { + hyperlinkFollowed = "HyperlinkFollowed", /** - * Final view. + * The first background color in the theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - final = "Final", + background1 = "Background1", /** - * Original view. + * The first text color in the theme. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - original = "Original", + text1 = "Text1", + /** + * The second background color in the theme. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + background2 = "Background2", + /** + * The second text color in the theme. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + text2 = "Text2", } /** - * Specifies the revision type. + * Specifies the hyperlink type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum RevisionType { + enum HyperlinkType { /** - * No revision. + * Represents a hyperlink to a range in the document. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + range = "Range", /** - * Insert revision. + * Represents a hyperlink to a shape in the document. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - insert = "Insert", + shape = "Shape", /** - * Delete revision. + * Represents a hyperlink to an inline shape in the document. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - delete = "Delete", + inlineShape = "InlineShape", + } + /** + * Represents the list of available sources attached to the document (in the current list) or the list of sources available in the application (in the master list). + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class Bibliography 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; /** - * Property revision. + * Returns a `SourceCollection` object that represents all the sources contained in the bibliography. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - property = "Property", + readonly sources: Word.SourceCollection; /** - * Paragraph number revision. + * Specifies the name of the active style to use for the bibliography. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - paragraphNumber = "ParagraphNumber", + bibliographyStyle: string; /** - * Display field revision. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - displayField = "DisplayField", + set(properties: Interfaces.BibliographyUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Bibliography): void; /** - * Reconcile revision. + * Generates a unique identification tag for a bibliography source and returns a string that represents the tag. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - reconcile = "Reconcile", + generateUniqueTag(): OfficeExtension.ClientResult; /** - * Conflict revision. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - conflict = "Conflict", + load(options?: Word.Interfaces.BibliographyLoadOptions): Word.Bibliography; /** - * Style revision. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - style = "Style", + load(propertyNames?: string | string[]): Word.Bibliography; /** - * Replace revision. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - replace = "Replace", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.Bibliography; /** - * Paragraph property revision. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - paragraphProperty = "ParagraphProperty", + track(): Word.Bibliography; /** - * Table property revision. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - tableProperty = "TableProperty", + untrack(): Word.Bibliography; /** - * Section property revision. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Bibliography` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BibliographyData`) that contains shallow copies of any loaded child properties from the original object. */ - sectionProperty = "SectionProperty", + toJSON(): Word.Interfaces.BibliographyData; + } + /** + * Represents a collection of {@link Word.Source} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class SourceCollection 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: Word.Source[]; /** - * Style definition revision. + * Adds a new `Source` object to the collection. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param xml A string containing the XML data for the source. + * @returns A `Source` object that was added to the collection. */ - styleDefinition = "StyleDefinition", + add(xml: string): Word.Source; /** - * Moved from revision. + * Gets a `Source` by its index in the collection. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param index A number that identifies the index location of a `Source` object. */ - movedFrom = "MovedFrom", + getItem(index: number): Word.Source; /** - * Moved to revision. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - movedTo = "MovedTo", + load(options?: Word.Interfaces.SourceCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.SourceCollection; /** - * Cell insertion revision. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - cellInsertion = "CellInsertion", + load(propertyNames?: string | string[]): Word.SourceCollection; /** - * Cell deletion revision. + * 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): Word.SourceCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.SourceCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.SourceCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.SourceCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SourceCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.SourceCollectionData; + } + /** + * Represents an individual source, such as a book, journal article, or interview. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class Source 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 if the `Source` object has been cited in the document. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cellDeletion = "CellDeletion", + readonly isCited: boolean; /** - * Cell merge revision. + * Gets the tag of the source. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cellMerge = "CellMerge", + readonly tag: string; /** - * Cell split revision. + * Gets the XML representation of the source. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - cellSplit = "CellSplit", + readonly xml: string; /** - * Conflict insert revision. + * Deletes the `Source` object. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - conflictInsert = "ConflictInsert", + delete(): void; /** - * Conflict delete revision. + * Returns the value of a field in the bibliography `Source` object. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param name The name of the field to retrieve. */ - conflictDelete = "ConflictDelete", + getFieldByName(name: string): OfficeExtension.ClientResult; + /** + * 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?: Word.Interfaces.SourceLoadOptions): Word.Source; + /** + * 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[]): Word.Source; + /** + * 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; + }): Word.Source; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.Source; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.Source; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Source` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SourceData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.SourceData; } /** - * Specifies the column width options in a Word document. + * Represents the page setup settings for a Word document or section. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum ColumnWidth { + 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; /** - * Narrow column width. + * Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - narrow = "Narrow", + lineNumbering: Word.LineNumbering; /** - * Default column width. + * Gets a `TextColumnCollection` object that represents the set of text columns for the `PageSetup` object. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - default = "Default", + readonly textColumns: Word.TextColumnCollection; /** - * Wide column width. + * Specifies whether Microsoft Word prints the document as a booklet. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - wide = "Wide", - } - /** - * Specifies the field shading options in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum FieldShading { + bookFoldPrinting: boolean; /** - * Never shade fields. + * Specifies the number of pages for each booklet. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - never = "Never", + bookFoldPrintingSheets: number; /** - * Always shade fields. + * Specifies if Microsoft Word reverses the printing order for book fold printing of bidirectional or Asian language documents. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - always = "Always", + bookFoldReversePrinting: boolean; /** - * Shade fields when selected. + * Specifies the distance (in points) between the bottom edge of the page and the bottom boundary of the body text. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - whenSelected = "WhenSelected", - } - /** - * Specifies the format for horizontal text set within vertical text. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum HorizontalInVerticalType { + bottomMargin: number; /** - * No formatting is applied to the horizontal text. + * Specifies the number of characters per line in the document grid. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + charsLine: number; /** - * The horizontal text is sized to fit in the line of vertical text. + * Specifies whether the first page has a different header and footer. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fitInLine = "FitInLine", + differentFirstPageHeaderFooter: boolean; /** - * The line of vertical text is sized to accommodate the horizontal text. + * Specifies the distance between the footer and the bottom of the page in points. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - resizeLine = "ResizeLine", - } - /** - * Specifies the IME (Input Method Editor) mode. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum ImeMode { + footerDistance: number; /** - * Specifies no control over the IME mode. + * Specifies the amount (in points) of extra margin space added to each page in a document or section for binding. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - noControl = "NoControl", + gutter: number; /** - * Specifies the IME mode is on. + * Specifies on which side the gutter appears in a document. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - on = "On", + gutterPosition: Word.GutterPosition | "Left" | "Right" | "Top"; /** - * Specifies the IME mode is off. + * Specifies whether Microsoft Word uses gutters for the current document based on a right-to-left language or a left-to-right language. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - off = "Off", + gutterStyle: Word.GutterStyle | "Bidirectional" | "Latin"; /** - * Specifies the Hiragana IME mode. + * Specifies the distance between the header and the top of the page in points. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hiragana = "Hiragana", + headerDistance: number; /** - * Specifies the Katakana (double-byte) IME mode. + * Specifies the layout mode for the current document. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - katakana = "Katakana", + layoutMode: Word.LayoutMode | "Default" | "Grid" | "LineGrid" | "Genko"; /** - * Specifies the Katakana (half-width) IME mode. + * Specifies the distance (in points) between the left edge of the page and the left boundary of the body text. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - katakanaHalf = "KatakanaHalf", + leftMargin: number; /** - * Specifies the full-width alphanumeric IME mode. + * Specifies the number of lines per page in the document grid. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - alphaFull = "AlphaFull", + linesPage: number; /** - * Specifies the half-width alphanumeric IME mode. + * Specifies if the inside and outside margins of facing pages are the same width. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - alpha = "Alpha", + mirrorMargins: boolean; /** - * Specifies the full-width Hangul IME mode. + * Specifies whether odd and even pages have different headers and footers. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hangulFull = "HangulFull", + oddAndEvenPagesHeaderFooter: boolean; /** - * Specifies the half-width Hangul IME mode. + * Specifies the orientation of the page. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hangul = "Hangul", - } - /** - * Specifies the Kana type. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum Kana { + orientation: Word.PageOrientation | "Portrait" | "Landscape"; /** - * Katakana Kana type. + * Specifies the page height in points. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - katakana = "Katakana", + pageHeight: number; /** - * Hiragana Kana type. + * Specifies the page width in points. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hiragana = "Hiragana", - } - /** - * Specifies the two lines in one type. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum TwoLinesInOneType { + pageWidth: number; /** - * No two lines in one. + * Specifies the paper size of the page. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + paperSize: Word.PaperSize | "Size10x14" | "Size11x17" | "Letter" | "LetterSmall" | "Legal" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "CSheet" | "DSheet" | "ESheet" | "FanfoldLegalGerman" | "FanfoldStdGerman" | "FanfoldUS" | "Folio" | "Ledger" | "Note" | "Quarto" | "Statement" | "Tabloid" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC5" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeDL" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "Custom"; /** - * Two lines in one without brackets. + * Specifies the distance (in points) between the right edge of the page and the right boundary of the body text. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - noBrackets = "NoBrackets", + rightMargin: number; /** - * Two lines in one with parentheses. + * Specifies the reading order and alignment for the specified sections. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - parentheses = "Parentheses", + sectionDirection: Word.SectionDirection | "RightToLeft" | "LeftToRight"; /** - * Two lines in one with square brackets. + * Specifies the type of section break for the specified object. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - squareBrackets = "SquareBrackets", + sectionStart: Word.SectionStart | "Continuous" | "NewColumn" | "NewPage" | "EvenPage" | "OddPage"; /** - * Two lines in one with angle brackets. + * Specifies whether to show the grid. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - angleBrackets = "AngleBrackets", + showGrid: boolean; /** - * Two lines in one with curly brackets. + * Specifies if endnotes are printed at the end of the next section that doesn't suppress endnotes. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - curlyBrackets = "CurlyBrackets", - } - /** - * Specifies the underline type. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum Underline { + suppressEndnotes: boolean; /** - * No underline. + * Specifies the top margin of the page in points. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + topMargin: number; /** - * Single underline. + * Specifies whether to print two pages per sheet. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - single = "Single", + twoPagesOnOne: boolean; /** - * Underline words only. + * Specifies the vertical alignment of text on each page in a document or section. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - words = "Words", + verticalAlignment: Word.PageSetupVerticalAlignment | "Top" | "Center" | "Justify" | "Bottom"; /** - * Double underline. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - double = "Double", + set(properties: Interfaces.PageSetupUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.PageSetup): void; /** - * Dotted underline. + * Sets the specified page setup formatting as the default for the active document and all new documents based on the active template. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dotted = "Dotted", + setAsTemplateDefault(): void; /** - * Thick underline. + * Switches between portrait and landscape page orientations for a document or section. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - thick = "Thick", + togglePortrait(): void; /** - * Dash underline. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - dash = "Dash", + load(options?: Word.Interfaces.PageSetupLoadOptions): Word.PageSetup; /** - * Dot dash underline. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - dotDash = "DotDash", + load(propertyNames?: string | string[]): Word.PageSetup; /** - * Dot dot dash underline. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - dotDotDash = "DotDotDash", + load(propertyNamesAndPaths?: { + select?: string; + expand?: string; + }): Word.PageSetup; /** - * Wavy underline. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. */ - wavy = "Wavy", + track(): Word.PageSetup; /** - * Heavy wavy underline. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. */ - wavyHeavy = "WavyHeavy", + untrack(): Word.PageSetup; /** - * Heavy dotted underline. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.PageSetup` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.PageSetupData`) that contains shallow copies of any loaded child properties from the original object. */ - dottedHeavy = "DottedHeavy", + toJSON(): Word.Interfaces.PageSetupData; + } + /** + * Represents line numbers in the left margin or to the left of each newspaper-style column. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class LineNumbering 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; /** - * Heavy dash underline. + * Specifies the numeric increment for line numbers. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashHeavy = "DashHeavy", + countBy: number; /** - * Heavy dot dash underline. + * Specifies the distance (in points) between the right edge of line numbers and the left edge of the document text. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dotDashHeavy = "DotDashHeavy", + distanceFromText: number; /** - * Heavy dot dot dash underline. + * Specifies if line numbering is active for the specified document, section, or sections. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dotDotDashHeavy = "DotDotDashHeavy", + isActive: boolean; /** - * Long dash underline. + * Specifies the way line numbering runs; that is, whether it starts over at the beginning of a new page or section, or runs continuously. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashLong = "DashLong", + restartMode: Word.NumberingRule | "RestartContinuous" | "RestartSection" | "RestartPage"; /** - * Heavy long dash underline. + * Specifies the starting line number. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashLongHeavy = "DashLongHeavy", + startingNumber: number; /** - * Double wavy underline. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. */ - wavyDouble = "WavyDouble", + set(properties: Interfaces.LineNumberingUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.LineNumbering): 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?: Word.Interfaces.LineNumberingLoadOptions): Word.LineNumbering; + /** + * 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[]): Word.LineNumbering; + /** + * 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; + }): Word.LineNumbering; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.LineNumbering; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.LineNumbering; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.LineNumbering` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.LineNumberingData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.LineNumberingData; } /** - * Specifies the view type in a Word document. + * A collection of {@link Word.TextColumn} objects that represent all the columns of text in the document or a section of the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum ViewType { + class TextColumnCollection 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: Word.TextColumn[]; /** - * Normal. + * Returns a `TextColumn` object that represents a new text column added to a section or document. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param options Optional. Options for configuring the new text column. + * @returns A `TextColumn` object that represents a new text column added to the document. */ - normal = "Normal", + add(options?: Word.TextColumnAddOptions): Word.TextColumn; /** - * Outline. + * Gets the direction in which text flows from one text column to the next. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - outline = "Outline", + getFlowDirection(): OfficeExtension.ClientResult; /** - * Print. + * Gets whether vertical lines appear between all the columns in the `TextColumnCollection` object. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - print = "Print", + getHasLineBetween(): OfficeExtension.ClientResult; /** - * Print preview. + * Gets whether text columns are evenly spaced. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - printPreview = "PrintPreview", + getIsEvenlySpaced(): OfficeExtension.ClientResult; /** - * Master. + * Gets a `TextColumn` by its index in the collection. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param index A number that identifies the index location of a `TextColumn` object. */ - master = "Master", + getItem(index: number): Word.TextColumn; /** - * Web. + * Arranges text into the specified number of text columns. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param numColumns The number of columns the text is to be arranged into. */ - web = "Web", + setCount(numColumns: number): void; /** - * Reading. + * Sets the direction in which text flows from one text column to the next. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param value The flow direction to set. */ - reading = "Reading", + setFlowDirection(value: Word.FlowDirection): void; /** - * Conflict. + * Sets the direction in which text flows from one text column to the next. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param value The flow direction to set. */ - conflict = "Conflict", - } - /** - * Represents the state of the window. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum WindowState { + setFlowDirection(value: "LeftToRight" | "RightToLeft"): void; /** - * Represents the normal state of the window. + * Sets whether vertical lines appear between all the columns in the `TextColumnCollection` object. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param value `true` to show vertical lines between columns. */ - normal = "Normal", + setHasLineBetween(value: boolean): void; /** - * Represents the maximized state of the window. + * Sets whether text columns are evenly spaced. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta + * + * @param value `true` to evenly space all the text columns in the document. */ - maximize = "Maximize", + setIsEvenlySpaced(value: boolean): void; /** - * Represents the minimized state of the window. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * 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. */ - minimize = "Minimize", + load(options?: Word.Interfaces.TextColumnCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.TextColumnCollection; + /** + * 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[]): Word.TextColumnCollection; + /** + * 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): Word.TextColumnCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.TextColumnCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.TextColumnCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TextColumnCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TextColumnCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.TextColumnCollectionData; } /** - * Specifies the type of the window. + * Represents options for a new text column in a document or section of a document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum WindowType { + interface TextColumnAddOptions { /** - * Specifies a document window. + * If provided, specifies whether to evenly space all the text columns in the document. The default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - document = "Document", + isEvenlySpaced?: boolean; /** - * Specifies a template window. + * If provided, specifies the spacing between the text columns in the document, in points. + The default value is -1, which means Word will automatically determine the width based on the number of columns and page size. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - template = "Template", + spacing?: number; + /** + * If provided, specifies the width of the new text column in the document, in points. + The default value is -1, which means Word will automatically determine the width based on the number of columns and page size. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + width?: number; } /** - * Specifies the direction in which text flows from one text column to the next. + * Represents a single text column in a section. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum FlowDirection { + class TextColumn 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; /** - * Text flows from left to right. + * Specifies the amount of spacing (in points) after the specified paragraph or text column. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - leftToRight = "LeftToRight", + spaceAfter: number; /** - * Text flows from right to left. + * Specifies the width, in points, of the specified text columns. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rightToLeft = "RightToLeft", + width: number; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.TextColumnUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.TextColumn): 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?: Word.Interfaces.TextColumnLoadOptions): Word.TextColumn; + /** + * 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[]): Word.TextColumn; + /** + * 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; + }): Word.TextColumn; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.TextColumn; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.TextColumn; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.TextColumn` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.TextColumnData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.TextColumnData; } /** - * Specifies where the gutter appears in the document. + * Specifies the case of the text in the specified range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum GutterPosition { + enum CharacterCase { /** - * The gutter appears on the left side of the document. + * Specifies the next case. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - left = "Left", + next = "Next", /** - * The gutter appears on the right side of the document. + * Specifies lowercase. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - right = "Right", + lower = "Lower", /** - * The gutter appears at the top of the document. + * Specifies uppercase. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - top = "Top", - } - /** - * Specifies whether the gutter style should conform to left-to-right text flow or right-to-left text flow. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum GutterStyle { + upper = "Upper", /** - * Gutter style for bidirectional text flow. This is mainly right to left. + * Specifies title case for each word. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bidirectional = "Bidirectional", + titleWord = "TitleWord", /** - * Gutter style for Latin text flow. This is mainly left to right. + * Specifies title case for the sentence. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - latin = "Latin", - } - /** - * Specifies how text is laid out in the layout mode for the current document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum LayoutMode { + titleSentence = "TitleSentence", /** - * Default layout mode. + * Specifies toggle case. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - default = "Default", + toggle = "Toggle", /** - * Grid layout mode. + * Specifies half-width characters. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - grid = "Grid", + halfWidth = "HalfWidth", /** - * Line grid layout mode. + * Specifies full-width characters. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lineGrid = "LineGrid", + fullWidth = "FullWidth", /** - * Genko layout mode. + * Specifies Katakana characters. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - genko = "Genko", + katakana = "Katakana", + /** + * Specifies Hiragana characters. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hiragana = "Hiragana", } /** - * Specifies the numbering rule to apply. + * Specifies the character width of the text in the specified range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum NumberingRule { + enum CharacterWidth { /** - * Restart numbering continuously. + * Specifies half-width characters. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - restartContinuous = "RestartContinuous", + half = "Half", /** - * Restart numbering at the beginning of each section. + * Specifies full-width characters. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - restartSection = "RestartSection", - /** - * Restart numbering at the beginning of each page. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - restartPage = "RestartPage", + full = "Full", } /** - * Specifies a page layout orientation. + * Specifies the seek view options in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum PageOrientation { + enum SeekView { /** - * Portrait orientation. + * Main document. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - portrait = "Portrait", + mainDocument = "MainDocument", /** - * Landscape orientation. + * Primary header. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - landscape = "Landscape", + primaryHeader = "PrimaryHeader", + /** + * First page header. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + firstPageHeader = "FirstPageHeader", + /** + * Even pages header. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + evenPagesHeader = "EvenPagesHeader", + /** + * Primary footer. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + primaryFooter = "PrimaryFooter", + /** + * First page footer. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + firstPageFooter = "FirstPageFooter", + /** + * Even pages footer. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + evenPagesFooter = "EvenPagesFooter", + /** + * Footnotes. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + footnotes = "Footnotes", + /** + * Endnotes. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + endnotes = "Endnotes", + /** + * Current page header. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + currentPageHeader = "CurrentPageHeader", + /** + * Current page footer. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + currentPageFooter = "CurrentPageFooter", } /** - * Specifies the type of vertical alignment to apply. + * Specifies the source documents to show. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum PageSetupVerticalAlignment { + enum ShowSourceDocuments { /** - * Align text to the top. + * Specifies that no source documents are shown. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - top = "Top", + none = "None", /** - * Align text to the center. + * Specifies that the original source document is shown. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - center = "Center", + original = "Original", /** - * Justify text vertically. + * Specifies that the revised source document is shown. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - justify = "Justify", + revised = "Revised", /** - * Align text to the bottom. + * Specifies that both the original and revised source documents are shown. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottom = "Bottom", + both = "Both", } /** - * Specifies a paper size. + * Specifies the special pane options in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum PaperSize { + enum SpecialPane { /** - * 10x14 paper size. + * None. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - size10x14 = "Size10x14", + none = "None", /** - * 11x17 paper size. + * Primary header. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - size11x17 = "Size11x17", + primaryHeader = "PrimaryHeader", /** - * Letter paper size. + * First page header. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - letter = "Letter", + firstPageHeader = "FirstPageHeader", /** - * Small letter paper size. + * Even pages header. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - letterSmall = "LetterSmall", + evenPagesHeader = "EvenPagesHeader", /** - * Legal paper size. + * Primary footer. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - legal = "Legal", + primaryFooter = "PrimaryFooter", /** - * Executive paper size. + * First page footer. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - executive = "Executive", + firstPageFooter = "FirstPageFooter", /** - * A3 paper size. + * Even pages footer. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - a3 = "A3", + evenPagesFooter = "EvenPagesFooter", /** - * A4 paper size. + * Footnotes. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - a4 = "A4", + footnotes = "Footnotes", /** - * Small A4 paper size. + * Endnotes. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - a4Small = "A4Small", + endnotes = "Endnotes", /** - * A5 paper size. + * Footnote continuation notice. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - a5 = "A5", + footnoteContinuationNotice = "FootnoteContinuationNotice", /** - * B4 paper size. + * Footnote continuation separator. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - b4 = "B4", + footnoteContinuationSeparator = "FootnoteContinuationSeparator", /** - * B5 paper size. + * Footnote separator. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - b5 = "B5", + footnoteSeparator = "FootnoteSeparator", /** - * C-sheet paper size. + * Endnote continuation notice. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - csheet = "CSheet", + endnoteContinuationNotice = "EndnoteContinuationNotice", /** - * D-sheet paper size. + * Endnote continuation separator. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dsheet = "DSheet", + endnoteContinuationSeparator = "EndnoteContinuationSeparator", /** - * E-sheet paper size. + * Endnote separator. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - esheet = "ESheet", + endnoteSeparator = "EndnoteSeparator", /** - * Fanfold legal German paper size. + * Comments. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fanfoldLegalGerman = "FanfoldLegalGerman", + comments = "Comments", /** - * Fanfold standard German paper size. + * Current page header. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fanfoldStdGerman = "FanfoldStdGerman", + currentPageHeader = "CurrentPageHeader", /** - * Fanfold US paper size. + * Current page footer. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fanfoldUS = "FanfoldUS", + currentPageFooter = "CurrentPageFooter", /** - * Folio paper size. + * Revisions. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - folio = "Folio", + revisions = "Revisions", /** - * Ledger paper size. + * Revisions horizontal. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - ledger = "Ledger", + revisionsHoriz = "RevisionsHoriz", /** - * Note paper size. + * Revisions vertical. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - note = "Note", + revisionsVert = "RevisionsVert", + } + /** + * Specifies the save options. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum SaveConfiguration { /** - * Quarto paper size. + * Specifies not to save changes. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - quarto = "Quarto", + doNotSaveChanges = "DoNotSaveChanges", /** - * Statement paper size. + * Specifies to save changes. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - statement = "Statement", + saveChanges = "SaveChanges", /** - * Tabloid paper size. + * Specifies to prompt to save changes. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tabloid = "Tabloid", + promptToSaveChanges = "PromptToSaveChanges", + } + /** + * Specifies the page color options in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PageColor { /** - * Envelope size 9. + * None. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelope9 = "Envelope9", + none = "None", /** - * Envelope size 10. + * Sepia. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelope10 = "Envelope10", + sepia = "Sepia", /** - * Envelope size 11. + * Inverse. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelope11 = "Envelope11", + inverse = "Inverse", + } + /** + * Specifies the page movement type in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PageMovementType { /** - * Envelope size 12. + * Vertical. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelope12 = "Envelope12", + vertical = "Vertical", /** - * Envelope size 14. + * Side to side. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelope14 = "Envelope14", + sideToSide = "SideToSide", + } + /** + * Specifies the margin options in reading layout view in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ReadingLayoutMargin { /** - * Envelope B4 size. + * Microsoft Word determines automatically whether to show or hide the margins based on the available space. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeB4 = "EnvelopeB4", + automatic = "Automatic", /** - * Envelope B5 size. + * Hides margins. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeB5 = "EnvelopeB5", + suppress = "Suppress", /** - * Envelope B6 size. + * Shows margins. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeB6 = "EnvelopeB6", + full = "Full", + } + /** + * Specifies the margin for revision balloons in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum RevisionsBalloonMargin { /** - * Envelope C3 size. + * Left margin. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeC3 = "EnvelopeC3", + left = "Left", /** - * Envelope C4 size. + * Right margin. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeC4 = "EnvelopeC4", + right = "Right", + } + /** + * Specifies the width type for revision balloons in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum RevisionsBalloonWidthType { /** - * Envelope C5 size. + * Balloon width as a percentage. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeC5 = "EnvelopeC5", + percent = "Percent", /** - * Envelope C6 size. + * Balloon width in points. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeC6 = "EnvelopeC6", + points = "Points", + } + /** + * Specifies the extent of markup visible in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum RevisionsMarkup { /** - * Envelope C65 size. + * No markup. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeC65 = "EnvelopeC65", + none = "None", /** - * Envelope DL size. + * Simple markup. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeDL = "EnvelopeDL", + simple = "Simple", /** - * Envelope Italy size. + * All markup. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeItaly = "EnvelopeItaly", + all = "All", + } + /** + * Specifies the display mode for tracked changes in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum RevisionsMode { /** - * Envelope Monarch size. + * Balloon. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopeMonarch = "EnvelopeMonarch", + balloon = "Balloon", /** - * Envelope Personal size. + * Inline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - envelopePersonal = "EnvelopePersonal", + inline = "Inline", /** - * Custom paper size. + * Mixed. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - custom = "Custom", + mixed = "Mixed", } /** - * Specifies how Word displays the reading order and alignment for the specified sections. + * Specifies whether Word displays the original version of a document or a version with revisions and formatting changes applied. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum SectionDirection { + enum RevisionsView { /** - * Right-to-left reading order. + * Final view. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rightToLeft = "RightToLeft", + final = "Final", /** - * Left-to-right reading order. + * Original view. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - leftToRight = "LeftToRight", + original = "Original", } /** - * Specifies the type of section break for the specified item. + * Specifies the revision type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum SectionStart { + enum RevisionType { /** - * Continuous section break. + * No revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - continuous = "Continuous", + none = "None", /** - * New column section break. + * Insert revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - newColumn = "NewColumn", + insert = "Insert", /** - * New page section break. + * Delete revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - newPage = "NewPage", + delete = "Delete", /** - * Even page section break. + * Property revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - evenPage = "EvenPage", + property = "Property", /** - * Odd page section break. + * Paragraph number revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - oddPage = "OddPage", - } - /** - * Represents a single bookmark in a document, selection, or range. The `Bookmark` object is a member of the `Bookmark` collection. - The {@link Word.BookmarkCollection} includes all the bookmarks listed in the **Bookmark** dialog box (**Insert** menu). - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - class Bookmark 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; + paragraphNumber = "ParagraphNumber", /** - * Returns a `Range` object that represents the portion of the document that's contained in the `Bookmark` object. - * + * Display field revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly range: Word.Range; + displayField = "DisplayField", /** - * Specifies the ending character position of the bookmark. - * + * Reconcile revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - end: number; + reconcile = "Reconcile", /** - * Returns `true` if the bookmark is a table column. - * + * Conflict revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly isColumn: boolean; + conflict = "Conflict", /** - * Returns `true` if the bookmark is empty. - * + * Style revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly isEmpty: boolean; + style = "Style", /** - * Returns the name of the `Bookmark` object. - * + * Replace revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly name: string; + replace = "Replace", /** - * Specifies the starting character position of the bookmark. - * + * Paragraph property revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - start: number; + paragraphProperty = "ParagraphProperty", /** - * Returns the story type for the bookmark. - * + * Table property revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly storyType: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; + tableProperty = "TableProperty", /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Section property revision. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.BookmarkUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Bookmark): void; + sectionProperty = "SectionProperty", /** - * Copies this bookmark to the new bookmark specified in the `name` argument and returns a `Bookmark` object. - * + * Style definition revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param name The name of the new bookmark. */ - copyTo(name: string): Word.Bookmark; + styleDefinition = "StyleDefinition", /** - * Deletes the bookmark. - * + * Moved from revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - delete(): void; + movedFrom = "MovedFrom", /** - * Selects the bookmark. - * + * Moved to revision. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - select(): void; + movedTo = "MovedTo", /** - * 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. + * Cell insertion revision. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.BookmarkLoadOptions): Word.Bookmark; + cellInsertion = "CellInsertion", /** - * 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. + * Cell deletion revision. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.Bookmark; + cellDeletion = "CellDeletion", /** - * 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. + * Cell merge revision. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.Bookmark; + cellMerge = "CellMerge", /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + * Cell split revision. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.Bookmark; + cellSplit = "CellSplit", /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + * Conflict insert revision. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.Bookmark; + conflictInsert = "ConflictInsert", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Bookmark` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BookmarkData`) that contains shallow copies of any loaded child properties from the original object. + * Conflict delete revision. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.BookmarkData; + conflictDelete = "ConflictDelete", } /** - * A collection of {@link Word.Bookmark} objects that represent the bookmarks in the specified selection, range, or document. + * Specifies the column width options in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - class BookmarkCollection 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: Word.Bookmark[]; + enum ColumnWidth { /** - * Determines whether the specified bookmark exists. - * + * Narrow column width. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param name A bookmark name than cannot include more than 40 characters or more than one word. - * @returns `true` if the bookmark exists. */ - exists(name: string): OfficeExtension.ClientResult; + narrow = "Narrow", /** - * Gets a `Bookmark` object by its index in the collection. - * + * Default column width. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param index A number that identifies the index location of a `Bookmark` object. */ - getItem(index: number): Word.Bookmark; + default = "Default", /** - * 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. + * Wide column width. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.BookmarkCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.BookmarkCollection; + wide = "Wide", + } + /** + * Specifies the field shading options in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum FieldShading { /** - * 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. + * Never shade fields. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.BookmarkCollection; + never = "Never", /** - * 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. + * Always shade fields. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.BookmarkCollection; + always = "Always", /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + * Shade fields when selected. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.BookmarkCollection; + whenSelected = "WhenSelected", + } + /** + * Specifies the format for horizontal text set within vertical text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum HorizontalInVerticalType { /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + * No formatting is applied to the horizontal text. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.BookmarkCollection; + none = "None", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.BookmarkCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BookmarkCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * The horizontal text is sized to fit in the line of vertical text. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.BookmarkCollectionData; + fitInLine = "FitInLine", + /** + * The line of vertical text is sized to accommodate the horizontal text. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + resizeLine = "ResizeLine", } /** - * Specifies the type of story in a Word document. + * Specifies the IME (Input Method Editor) mode. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum StoryType { + enum ImeMode { /** - * Main text story. + * Specifies no control over the IME mode. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mainText = "MainText", + noControl = "NoControl", /** - * Footnotes story. + * Specifies the IME mode is on. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footnotes = "Footnotes", + on = "On", /** - * Endnotes story. + * Specifies the IME mode is off. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endnotes = "Endnotes", + off = "Off", /** - * Comments story. + * Specifies the Hiragana IME mode. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - comments = "Comments", + hiragana = "Hiragana", /** - * Text frame story. + * Specifies the Katakana (double-byte) IME mode. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textFrame = "TextFrame", + katakana = "Katakana", /** - * Even pages header story. + * Specifies the Katakana (half-width) IME mode. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - evenPagesHeader = "EvenPagesHeader", + katakanaHalf = "KatakanaHalf", /** - * Primary header story. + * Specifies the full-width alphanumeric IME mode. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - primaryHeader = "PrimaryHeader", + alphaFull = "AlphaFull", /** - * Even pages footer story. + * Specifies the half-width alphanumeric IME mode. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - evenPagesFooter = "EvenPagesFooter", + alpha = "Alpha", /** - * Primary footer story. + * Specifies the full-width Hangul IME mode. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - primaryFooter = "PrimaryFooter", + hangulFull = "HangulFull", /** - * First page header story. + * Specifies the half-width Hangul IME mode. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - firstPageHeader = "FirstPageHeader", + hangul = "Hangul", + } + /** + * Specifies the Kana type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum Kana { /** - * First page footer story. + * Katakana Kana type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - firstPageFooter = "FirstPageFooter", + katakana = "Katakana", /** - * Footnote separator story. + * Hiragana Kana type. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footnoteSeparator = "FootnoteSeparator", + hiragana = "Hiragana", + } + /** + * Specifies the two lines in one type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum TwoLinesInOneType { /** - * Footnote continuation separator story. + * No two lines in one. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footnoteContinuationSeparator = "FootnoteContinuationSeparator", + none = "None", /** - * Footnote continuation notice story. + * Two lines in one without brackets. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footnoteContinuationNotice = "FootnoteContinuationNotice", + noBrackets = "NoBrackets", /** - * Endnote separator story. + * Two lines in one with parentheses. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endnoteSeparator = "EndnoteSeparator", + parentheses = "Parentheses", /** - * Endnote continuation separator story. + * Two lines in one with square brackets. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endnoteContinuationSeparator = "EndnoteContinuationSeparator", + squareBrackets = "SquareBrackets", /** - * Endnote continuation notice story. + * Two lines in one with angle brackets. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endnoteContinuationNotice = "EndnoteContinuationNotice", + angleBrackets = "AngleBrackets", + /** + * Two lines in one with curly brackets. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + curlyBrackets = "CurlyBrackets", } /** - * Represents a single index. The `Index` object is a member of the {@link Word.IndexCollection}. The `IndexCollection` includes all the - indexes in the document. + * Specifies the underline type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - class Index 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 Underline { /** - * Returns a `Range` object that represents the portion of the document that is contained within the index. - * + * No underline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly range: Word.Range; + none = "None", /** - * Gets a value that represents how Microsoft Word classifies the first character of entries in the index. - See `IndexFilter` for available values. - * + * Single underline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly filter: Word.IndexFilter | "None" | "Aiueo" | "Akasatana" | "Chosung" | "Low" | "Medium" | "Full"; + single = "Single", /** - * Gets the text between alphabetical groups (entries that start with the same letter) in the index. Corresponds to - the **\h** switch for an {@link https://support.microsoft.com/office/adafcf4a-cb30-43f6-85c7-743da1635d9e | INDEX field}. - * + * Underline words only. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly headingSeparator: Word.HeadingSeparator | "None" | "BlankLine" | "Letter" | "LetterLow" | "LetterFull"; + words = "Words", /** - * Gets a `LanguageId` value that represents the sorting language to use for the index. - * + * Double underline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly indexLanguage: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + double = "Double", /** - * Gets the number of columns for each page of the index. - * + * Dotted underline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly numberOfColumns: number; + dotted = "Dotted", /** - * Specifies if page numbers are aligned with the right margin in the index. - * + * Thick underline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly rightAlignPageNumbers: boolean; + thick = "Thick", /** - * Gets if the index contains separate headings for accented letters (for example, words that begin with "À" are under - one heading and words that begin with "A" are under another). - * + * Dash underline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly separateAccentedLetterHeadings: boolean; + dash = "Dash", /** - * Specifies the sorting criteria for the index. - * + * Dot dash underline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly sortBy: Word.IndexSortBy | "Stroke" | "Syllable"; + dotDash = "DotDash", /** - * Specifies the leader character between entries in the index and their associated page numbers. - * + * Dot dot dash underline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + dotDotDash = "DotDotDash", /** - * Gets the index type. - * + * Wavy underline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readonly type: Word.IndexType | "Indent" | "Runin"; + wavy = "Wavy", /** - * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. - * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. - * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + * Heavy wavy underline. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - set(properties: Interfaces.IndexUpdateData, options?: OfficeExtension.UpdateOptions): void; - /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ - set(properties: Word.Index): void; + wavyHeavy = "WavyHeavy", /** - * Deletes this index. - * + * Heavy dotted underline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - delete(): void; + dottedHeavy = "DottedHeavy", /** - * 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. + * Heavy dash underline. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(options?: Word.Interfaces.IndexLoadOptions): Word.Index; + dashHeavy = "DashHeavy", /** - * 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. + * Heavy dot dash underline. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNames?: string | string[]): Word.Index; + dotDashHeavy = "DotDashHeavy", /** - * 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. + * Heavy dot dot dash underline. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: { - select?: string; - expand?: string; - }): Word.Index; + dotDotDashHeavy = "DotDotDashHeavy", /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + * Long dash underline. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.Index; + dashLong = "DashLong", /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + * Heavy long dash underline. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.Index; + dashLongHeavy = "DashLongHeavy", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.Index` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.IndexData`) that contains shallow copies of any loaded child properties from the original object. + * Double wavy underline. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.IndexData; + wavyDouble = "WavyDouble", } /** - * A collection of {@link Word.Index} objects that represents all the indexes in the document. + * Specifies the view type in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - class IndexCollection 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: Word.Index[]; + enum ViewType { /** - * Returns an `Index` object that represents a new index added to the document. - * + * Normal. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param range The range where you want the index to appear. The index replaces the range, if the range is not collapsed. - * @param indexAddOptions Optional. The options for adding the index. */ - add(range: Word.Range, indexAddOptions?: Word.IndexAddOptions): Word.Index; + normal = "Normal", /** - * Gets the `IndexFormat` value that represents the formatting for the indexes in the document. - * + * Outline. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - getFormat(): OfficeExtension.ClientResult; + outline = "Outline", /** - * Gets an `Index` object by its index in the collection. - * + * Print. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param index A number that identifies the index location of an `Index` object. */ - getItem(index: number): Word.Index; + print = "Print", /** - * Inserts an {@link https://support.microsoft.com/office/abaf7c78-6e21-418d-bf8b-f8186d2e4d08 | XE (Index Entry) field} after all instances of the text in the range. - * + * Print preview. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta - * - * @param range The range whose text is marked with an `XE` field throughout the document. - * @param markAllEntriesOptions Optional. The options for marking all entries. */ - markAllEntries(range: Word.Range, markAllEntriesOptions?: Word.IndexMarkAllEntriesOptions): 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?: Word.Interfaces.IndexCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.IndexCollection; - /** - * 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[]): Word.IndexCollection; + printPreview = "PrintPreview", /** - * 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. + * Master. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.IndexCollection; + master = "Master", /** - * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + * Web. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - track(): Word.IndexCollection; + web = "Web", /** - * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + * Reading. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - untrack(): Word.IndexCollection; + reading = "Reading", /** - * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) - * Whereas the original `Word.IndexCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.IndexCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + * Conflict. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - toJSON(): Word.Interfaces.IndexCollectionData; + conflict = "Conflict", } /** - * Represents options for creating an index in a Word document. + * Represents the state of the window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface IndexAddOptions { - /** - * If provided, specifies the text between alphabetical groups (entries that start with the same letter) in the index. - See `HeadingSeparator` for available values. The default value is `Word.HeadingSeparator.blankLine`. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - headingSeparator?: Word.HeadingSeparator | "None" | "BlankLine" | "Letter" | "LetterLow" | "LetterFull"; - /** - * If provided, specifies the sorting language to be used for the index being added. - See `LanguageId` for available values. The default value is the installed language of the Word application. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - indexLanguage?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + enum WindowState { /** - * If provided, specifies the number of columns for each page of the index. - Specifying 0 (zero) sets the number of columns in the index to the same number as in the document. The default value is 1. - * + * Represents the normal state of the window. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - numberOfColumns?: number; + normal = "Normal", /** - * If provided, specifies whether the page numbers in the generated index are aligned with the right margin. The default value is `false`. - * + * Represents the maximized state of the window. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rightAlignPageNumbers?: boolean; + maximize = "Maximize", /** - * If provided, specifies whether to include separate headings for accented letters in the index. The default value is `false`. - * + * Represents the minimized state of the window. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - separateAccentedLetterHeadings?: boolean; + minimize = "Minimize", + } + /** + * Specifies the type of the window. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum WindowType { /** - * If provided, specifies the sorting criteria to be used for the index being added. Can be either of the following `IndexSortBy` values: `stroke` or `syllable`. The default value is `Word.IndexSortBy.stroke`. - * + * Specifies a document window. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sortBy?: Word.IndexSortBy | "Stroke" | "Syllable"; + document = "Document", /** - * If provided, specifies whether subentries are on the same line (run-in) as the main entry or on a separate line (indented) from the main entry. - Can be either of the following `IndexType` values: `indent` or `runin`. The default value is `Word.IndexType.indent`. - * + * Specifies a template window. * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.IndexType | "Indent" | "Runin"; + template = "Template", } /** - * Represents options for marking all index entries in a Word document. + * Represents the options for the {@link Word.Selection | Selection.convertToTable} method. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface IndexMarkAllEntriesOptions { + interface SelectionConvertToTableOptions { /** - * If provided, specifies whether to add bold formatting to page numbers for index entries. The default value is `false`. + * If provided, specifies whether to apply borders to the table of the specified format. Default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bold?: boolean; + applyBorders?: boolean; /** - * If provided, specifies the bookmark name that marks the range of pages you want to appear in the index. If this property is omitted, the number of the page that contains the `XE` field appears in the index. The default value is "". + * If provided, specifies whether to apply color formatting to the table of the specified format. Default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bookmarkName?: string; + applyColor?: boolean; /** - * If provided, specifies the cross-reference that will appear in the index. The default value is "". + * If provided, specifies whether to apply special formatting to the first column of the specified format. Default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - crossReference?: string; + applyFirstColumn?: boolean; /** - * If provided, specifies the name of the `AutoText` entry that contains the text for a cross-reference (if this property is specified, `crossReference` is ignored). The default value is "". + * If provided, specifies whether to apply font formatting to the table of the specified format. Default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - crossReferenceAutoText?: string; + applyFont?: boolean; /** - * If provided, specifies the text you want to appear in the index, in the form `MainEntry[:Subentry]`. The default value is "". - Either this property or `entryAutoText` must be provided. + * If provided, specifies whether to format the first row as a header row of the specified format. Default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - entry?: string; + applyHeadingRows?: boolean; /** - * If provided, specifies the `AutoText` entry that contains the text you want to appear in the index (if this property is specified, `entry` is ignored). The default value is "". - Either this property or `entry` must be provided. + * If provided, specifies whether to apply special formatting to the last column of the specified format. Default value is `false`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - entryAutoText?: string; + applyLastColumn?: boolean; /** - * If provided, specifies whether to add italic formatting to page numbers for index entries. The default value is `false`. + * If provided, specifies whether to apply special formatting to the last row of the specified format. Default value is `false`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - italic?: boolean; - } - /** - * Represents options for marking an index entry in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface IndexMarkEntryOptions { + applyLastRow?: boolean; /** - * If provided, specifies whether to add bold formatting to page numbers for index entries. The default value is `false`. + * If provided, specifies whether to apply shading to the table of the specified format. Default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bold?: boolean; + applyShading?: boolean; /** - * If provided, specifies the bookmark name that marks the range of pages you want to appear in the index. If this property is omitted, the number of the page that contains the `XE` field appears in the index. The default value is "". + * If provided, specifies whether to automatically resize the table to fit the contents. Default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bookmarkName?: string; + autoFit?: boolean; /** - * If provided, specifies the cross-reference that will appear in the index. The default value is "". + * If provided, specifies the auto-fit behavior for the table. Used when the `defaultTableBehavior` property is `enableAutoFit`. The default value is `fixed`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - crossReference?: string; + autoFitBehavior?: Word.AutoFitBehavior | "FixedSize" | "Content" | "Window"; /** - * If provided, specifies the name of the `AutoText` entry that contains the text for a cross-reference (if this property is specified, `crossReference` is ignored). The default value is "". + * If provided, specifies whether Microsoft Word automatically resizes cells in a table to fit the contents. The default value is `disableAutoFit`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - crossReferenceAutoText?: string; + defaultTableBehavior?: Word.DefaultTableBehavior | "DisableAutoFit" | "EnableAutoFit"; /** - * If provided, specifies the text you want to appear in the index, in the form `MainEntry[:Subentry]`. The default value is "". - Either this property or `entryAutoText` must be provided. + * If provided, specifies a preset format to apply to the table. If omitted, Word applies the default table format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - entry?: string; + format?: Word.TableFormat | "None" | "Simple1" | "Simple2" | "Simple3" | "Classic1" | "Classic2" | "Classic3" | "Classic4" | "Colorful1" | "Colorful2" | "Colorful3" | "Columns1" | "Columns2" | "Columns3" | "Columns4" | "Columns5" | "Grid1" | "Grid2" | "Grid3" | "Grid4" | "Grid5" | "Grid6" | "Grid7" | "Grid8" | "List1" | "List2" | "List3" | "List4" | "List5" | "List6" | "List7" | "List8" | "ThreeDEffects1" | "ThreeDEffects2" | "ThreeDEffects3" | "Contemporary" | "Elegant" | "Professional" | "Subtle1" | "Subtle2" | "Web1" | "Web2" | "Web3"; /** - * If provided, specifies the `AutoText` entry that contains the text you want to appear in the index (if this property is specified, `entry` is ignored). The default value is "". - Either this property or `entry` must be provided. + * If provided, specifies the initial width of each column in the table, in points. If omitted, Word calculates and adjusts the column width so that the table stretches from margin to margin. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - entryAutoText?: string; + initialColumnWidth?: number; /** - * If provided, specifies whether to add italic formatting to page numbers for index entries. The default value is `false`. + * If provided, specifies the number of columns in the table. If omitted, Word determines the number of columns based on the contents of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - italic?: boolean; + numColumns?: number; /** - * If provided, specifies whether to show an index entry in the right location when indexes are sorted phonetically (East Asian languages only). The default value is `false`. + * If provided, specifies the number of rows in the table. If omitted, Word determines the number of rows based on the contents of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - reading?: boolean; + numRows?: number; + /** + * If provided, specifies the character used to separate text into cells. The default value is `-`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + separator?: string; } /** - * Specifies the type of separator to use for headings. + * Represents the options for the {@link Word.Selection | Selection.delete} method. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum HeadingSeparator { + interface SelectionDeleteOptions { /** - * No separator is used for headings. + * If provided, specifies the number of units to be deleted. To delete units after the selection, collapse the selection and use a positive number. To delete units before the selection, collapse the selection and use a negative number. The default value is 1. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + count?: number; /** - * A blank line is used as a separator for headings. + * If provided, specifies the unit by which the collapsed selection is to be deleted. The default value is `character`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - blankLine = "BlankLine", + unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; + } + /** + * Represents the options for the {@link Word.Selection | Selection.goTo} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface SelectionGoToOptions { /** - * A single letter is used as a separator for headings. + * If provided, specifies the number of the item in the document. Only positive values are valid. The default value is 1. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - letter = "Letter", + count?: number; /** - * A lowercase letter is used as a separator for headings. + * If provided, specifies the direction the range or selection is moved to. The default value is `next`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - letterLow = "LetterLow", + direction?: Word.GoToDirection | "First" | "Last" | "Next" | "Previous"; /** - * A full-width letter is used as a separator for headings. + * If provided, specifies the kind of item the range or selection is moved to. The default value is `page`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - letterFull = "LetterFull", + item?: Word.GoToItem | "Bookmark" | "Comment" | "Endnote" | "Field" | "Footnote" | "Graphic" | "Heading" | "Line" | "Page" | "Section" | "Table" | "EmbeddedObject" | "Equation" | "Percent" | "SpellingError" | "GrammaticalError" | "ProofreadingError"; + /** + * If provided, specifies the name if the `item` property is set to {@link Word.GoToItem} type `bookmark`, `comment`, `field`, or `object`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + name?: string; } /** - * Represents the position of a dropped capital letter. + * Represents the options for the {@link Word.Selection | Selection.insertCrossReference} method. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum DropPosition { + interface SelectionInsertCrossReferenceOptions { /** - * Represents that there's no dropped capital letter. + * If provided, specifies whether to include position. `true` to insert "above" or "below," depending on the location of the reference item in relation to the cross-reference. The default value is `false`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + includePosition?: boolean; /** - * Represents a normal dropped capital letter. + * If provided, specifies whether to insert the cross-reference as a hyperlink. The default value is `false`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - normal = "Normal", + insertAsHyperlink?: boolean; /** - * Represents a dropped capital letter in the margin. + * If provided, specifies whether to use a separator to separate the numbers from the associated text. The default value is `false`. (Use only if the `referenceType` parameter is set to `numberedItem` and the `referenceKind` parameter is set to `numberFullContext` when the `Selection.insertCrossReference` method is called.) + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - margin = "Margin", + separateNumbers?: boolean; + /** + * If provided, specifies the string to use as a separator if the `separateNumbers` parameter is set to `true` when the `Selection.insertCrossReference` method is called. The default value is " ". + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + separatorString?: string; } /** - * Represents the type of line spacing. + * Represents the options for the {@link Word.Selection | Selection.insertDateTime} method. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum LineSpacing { + interface SelectionInsertDateTimeOptions { /** - * Represents single line spacing. + * If provided, specifies the calendar type to use when displaying the date or time. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - single = "Single", + calendarType?: Word.CalendarTypeBidirectional | "Gregorian" | "Bidirectional"; /** - * Represents 1.5 line spacing. + * If provided, specifies the language in which to display the date or time. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - onePt5 = "OnePt5", + dateLanguage?: Word.DateLanguage | "Bidirectional" | "Latin"; /** - * Represents double line spacing. + * If provided, specifies the format to be used for displaying the date or time, or both. If this property is omitted, Microsoft Word uses the short-date style from the Windows Control Panel (Regional Settings icon). See {@link https://support.microsoft.com/office/47fbbdc1-52fa-416a-b8d5-ba24d881b698 | Date/Time data type} for format symbols. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - double = "Double", + dateTimeFormat?: string; /** - * Represents at least line spacing. + * If provided, specifies whether to insert the specified information as a {@link https://support.microsoft.com/office/6cb8fcef-310a-4646-ae6b-886d88335c90 | TIME field}. The default value is `true`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - atLeast = "AtLeast", + insertAsField?: boolean; /** - * Represents exact line spacing. + * If provided, specifies whether to insert the specified information as full-width (double-byte) digits. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - exactly = "Exactly", + insertAsFullWidth?: boolean; + } + /** + * Represents the options for the {@link Word.Selection | Selection.insertFormula} method + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface SelectionInsertFormulaOptions { /** - * Represents multiple line spacing. + * If provided, specifies the mathematical formula you want the {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | = (Formula) field} to evaluate. + The `formula` property is optional only if the selection is in a cell and there is at least one cell that contains a value above or to the left of the cell that contains the insertion point. If the cells above the insertion point contain values, the inserted field is `{=SUM(ABOVE)}`; if the cells to the left of the insertion point contain values, the inserted field is `{=SUM(LEFT)}`. If both the cells above the insertion point and the cells to the left of it contain values, Microsoft Word uses the following rules to determine which `SUM` function to insert. + + - If the cell immediately above the insertion point contains a value, Word inserts `{=SUM(ABOVE)}`. + + - If the cell immediately above the insertion point doesn't contain a value but the cell immediately to the left of the insertion point does, Word inserts `{=SUM(LEFT)}`. + + - If neither cell immediately above the insertion point nor the cell immediately below it contains a value, Word inserts `{=SUM(ABOVE)}`. + + - If you don't specify the `formula` property and all the cells above and to the left of the insertion point are empty, using the `= (Formula)` field causes an error. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - multiple = "Multiple", + formula?: string; + /** + * If provided, specifies the format for the result of the `= (Formula)` field. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numberFormat?: string; } /** - * Represents the alignment of a tab stop. + * Represents the options for the {@link Word.Selection | Selection.insertSymbol} method. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum TabAlignment { + interface SelectionInsertSymbolOptions { /** - * Represents that the tab stop is aligned to the left. + * If provided, specifies the font bias for symbols. This argument is useful for setting the correct font bias for East Asian characters. The default value is `default`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - left = "Left", + bias?: Word.FontBias | "Standard" | "FarEast" | "NoSpecified"; /** - * Represents that the tab stop is aligned to the center. + * If provided, specifies the name of the font that contains the symbol. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - center = "Center", + font?: string; /** - * Represents that the tab stop is aligned to the right. + * If provided, specifies whether the character is Unicode. `true` to insert the Unicode character specified by the `characterNumber` property when the `Selection.insertSymbol` method is called; `false` to instead insert the ANSI character specified by the `characterNumber` property. The default value is `false`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - right = "Right", + unicode?: boolean; + } + /** + * Represents the options for the {@link Word.Selection | Selection.moveLeft and Selection.moveRight} methods. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface SelectionMoveLeftRightOptions { /** - * Represents that the tab stop is aligned to the decimal point. + * If provided, specifies the number of units the selection is to be moved. The default value is 1. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - decimal = "Decimal", + count?: number; /** - * Represents that the tab stop is aligned to the bar. + * If provided, specifies the type of movement. The movement direction (left or right) is according to the calling method. If set to `move`, the selection is collapsed to the endpoint and moved in the appropriate direction. If set to `extend`, the selection is extended in the appropriate direction. The default value is `move`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bar = "Bar", + extend?: Word.MovementType | "Move" | "Extend"; /** - * Represents that the tab stop is aligned to the list. + * If provided, specifies the unit by which the selection is to be moved. The default value is `character`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - list = "List", + unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; } /** - * Represents the type of tight wrap for a text box. + * Represents the options for the {@link Word.Selection | Selection.move} method. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum TextboxTightWrap { - /** - * Represents that there's no tight wrap. - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - none = "None", + interface SelectionMoveOptions { /** - * Represents tight wrap around all lines. + * If provided, specifies the number of units by which the range or selection is to be moved. If `count` is a positive number, the object is collapsed to its end position and moved backward in the document by the specified number of units. If `count` is a negative number, the object is collapsed to its start position and moved forward by the specified number of units. The default value is 1. You can also control the collapse direction by using the {@link Word.Selection | Selection.collapse} method before using the `move` method. If the range or selection is in the middle of a unit or isn't collapsed, moving it to the beginning or end of the unit counts as moving it one full unit. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - all = "All", + count?: number; /** - * Represents tight wrap around the first and last lines. + * If provided, specifies the unit by which to move the ending character position. The default value is `character`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - firstAndLastLines = "FirstAndLastLines", + unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; + } + /** + * Represents the options for the {@link Word.Selection | Selection.moveEnd and Selection.moveStart} methods. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface SelectionMoveStartEndOptions { /** - * Represents tight wrap around the first line only. + * If provided, specifies the number of units to move. The affected character position (start or end) is according to the calling method. If this number is positive, the position is moved forward in the document. If this number is negative, the position is moved backward. If the affected position encounters the other position, the selection is collapsed and both the start and end positions move together. The default value is 1. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - firstLineOnly = "FirstLineOnly", + count?: number; /** - * Represents tight wrap around the last line only. + * If provided, specifies the unit by which the selection's start or end position (per the calling method) is to be moved. The default value is `character`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lastLineOnly = "LastLineOnly", + unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; } /** - * Specifies the filter type for an index. + * Represents the options for the {@link Word.Selection | Selection.moveUp and Selection.moveDown} methods. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum IndexFilter { + interface SelectionMoveUpDownOptions { /** - * No filter is applied. + * If provided, specifies the number of units the selection is to be moved. The default value is 1. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - none = "None", + count?: number; /** - * Aiueo filter is applied. + * If provided, specifies the type of movement. The movement direction (up or down) is according to the calling method. If set to `move`, the selection is collapsed to the endpoint and moved in the appropriate direction. If set to `extend`, the selection is extended in the appropriate direction. The default value is `move`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - aiueo = "Aiueo", + extend?: Word.MovementType | "Move" | "Extend"; /** - * Akasatana filter is applied. + * If provided, specifies the unit by which to move the selection. The default value is `line`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - akasatana = "Akasatana", + unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; + } + /** + * Represents the options for the {@link Word.Selection | Selection.next} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface SelectionNextOptions { /** - * Chosung filter is applied. + * If provided, specifies the number of units by which you want to move ahead. The default value is 1. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - chosung = "Chosung", + count?: number; /** - * Low filter is applied. + * If provided, specifies the type of units by which to move the selection. The default value is `character`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - low = "Low", + unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; + } + /** + * Represents the options for the {@link Word.Selection | Selection.previous} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface SelectionPreviousOptions { /** - * Medium filter is applied. + * If provided, specifies the number of units by which you want to move. The default value is 1. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - medium = "Medium", + count?: number; /** - * Full filter is applied. + * If provided, specifies the type of unit by which to move the selection. The default value is `character`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - full = "Full", + unit?: Word.OperationUnit | "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"; } /** - * Specifies the format for an index. + * Represents a selected range or the insertion point in a Word document. + + - Note: {@link Word.Range | Range} objects share many of the same methods and properties as `Selection` objects. Using `Range` objects is preferable for manipulating a document when there isn't a reason to physically change the current selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - enum IndexFormat { + class Selection 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; /** - * Template format. + * Returns a `BorderUniversalCollection` object that represents all the borders for the objects in the selection. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - template = "Template", + readonly borders: Word.BorderUniversalCollection; /** - * Classic format. + * Returns a `RangeScopedCollection` object that represents each character in the selection. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - classic = "Classic", + readonly characters: Word.RangeScopedCollection; /** - * Fancy format. + * Returns a `CommentCollection` object that represents all the comments in the selection. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fancy = "Fancy", + readonly comments: Word.CommentCollection; /** - * Modern format. + * Returns a `FieldCollection` object that represents all the fields in the selection. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - modern = "Modern", + readonly fields: Word.FieldCollection; /** - * Bulleted format. + * Returns the `Font` object that represents the character formatting of the selection. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bulleted = "Bulleted", + readonly font: Word.Font; /** - * Formal format. + * Specifies a `Range` object that includes the formatted text in the range or selection. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - formal = "Formal", + formattedText: Word.Range; /** - * Simple format. + * Returns a `ParagraphCollection` object that represents all the paragraphs in the selection. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - simple = "Simple", - } - /** - * Specifies how an index is sorted. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum IndexSortBy { + readonly paragraphs: Word.ParagraphCollection; /** - * Sort by stroke. + * Returns the `Range` object for the portion of the document contained in the selection. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - stroke = "Stroke", + readonly range: Word.Range; /** - * Sort by syllable. + * Returns the `SectionCollection` object in the selection. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - syllable = "Syllable", - } - /** - * Specifies the type of index to create. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum IndexType { + readonly sections: Word.SectionCollection; /** - * Creates an indented index. + * Returns the `RangeScopedCollection` object for each sentence in the selection. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - indent = "Indent", + readonly sentences: Word.RangeScopedCollection; /** - * Creates a run-in index. + * Returns the `ShadingUniversal` object for the shading formatting for the selection. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - runin = "Runin", - } - /** - * Specifies the tab leader style. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - enum TabLeader { + readonly shading: Word.ShadingUniversal; /** - * Spaces are used as the tab leader. + * Returns the `TableCollection` object in the selection. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spaces = "Spaces", + readonly tables: Word.TableCollection; /** - * Dots are used as the tab leader. + * Returns the tables at the outermost nesting level in the current selection. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dots = "Dots", + readonly topLevelTables: Word.TableCollection; /** - * Dashes are used as the tab leader. + * Returns the `RangeScopedCollection` object that represents each word in the selection. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashes = "Dashes", + readonly words: Word.RangeScopedCollection; /** - * Lines are used as the tab leader. + * Specifies the ending character position of the selection. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lines = "Lines", + end: number; /** - * Heavy lines are used as the tab leader. + * Specifies the width in which Word fits the text in the current selection. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - heavy = "Heavy", + fitTextWidth: number; /** - * Middle dots are used as the tab leader. + * Returns whether the spelling and grammar checker ignores the selected text. + If the selected text contains a mix of proofed and un-proofed content, this API returns `null`. + * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - middleDot = "MiddleDot", - } - enum ErrorCodes { - accessDenied = "AccessDenied", - generalException = "GeneralException", - invalidArgument = "InvalidArgument", - itemNotFound = "ItemNotFound", - notAllowed = "NotAllowed", - notImplemented = "NotImplemented", - searchDialogIsOpen = "SearchDialogIsOpen", - searchStringInvalidOrTooLong = "SearchStringInvalidOrTooLong", - } - namespace Interfaces { + readonly hasNoProofing: boolean; /** - * Provides ways to load properties of only a subset of members of a collection. + * Returns whether the selection in the specified window or pane is active. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - 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 `AnnotationCollection` object, for use in `annotationCollection.set({ ... })`. */ - interface AnnotationCollectionUpdateData { - items?: Word.Interfaces.AnnotationData[]; - } - /** An interface for updating data on the `Application` object, for use in `application.set({ ... })`. */ - interface ApplicationUpdateData { - /** - * Returns a `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - bibliography?: Word.Interfaces.BibliographyUpdateData; - /** - * Specifies if Microsoft Word automatically detects the language you are using as you type. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - checkLanguage?: boolean; - } - /** An interface for updating data on the `Body` object, for use in `body.set({ ... })`. */ - interface BodyUpdateData { - /** - * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ - font?: Word.Interfaces.FontUpdateData; - /** - * Specifies the style name for the body. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. - * - * @remarks - * [Api set: WordApi 1.1] - */ - style?: string; - /** - * Specifies the built-in style name for the body. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. - * - * @remarks - * [Api set: WordApi 1.3] - */ - styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; - } - /** An interface for updating data on the `Border` object, for use in `border.set({ ... })`. */ - interface BorderUpdateData { - /** - * Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - color?: string; - /** - * Specifies the border type for the border. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - type?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; - /** - * Specifies whether the border is visible. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - visible?: boolean; - /** - * Specifies the width for the border. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - width?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed"; - } - /** An interface for updating data on the `BorderUniversal` object, for use in `borderUniversal.set({ ... })`. */ - interface BorderUniversalUpdateData { - /** - * Specifies the graphical page-border design for the document. + readonly isActive: boolean; + /** + * Specifies whether column selection mode is active. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isColumnSelectModeActive: boolean; + /** + * Returns whether the selection is at the end-of-row mark in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly isEndOfRowMark: boolean; + /** + * Specifies whether Extend mode is active. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isExtendModeActive: boolean; + /** + * Returns whether the insertion point is at the end of a line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly isInsertionPointAtEndOfLine: boolean; + /** + * Specifies whether the beginning of the selection is active. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isStartActive: boolean; + /** + * Specifies whether Word has detected the language of the selected text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + languageDetected: boolean; + /** + * Returns the language for the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly languageId: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + /** + * Returns the East Asian language for the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly languageIdFarEast: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + /** + * Returns the language for the selection that isn't classified as an East Asian language. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly languageIdOther: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + /** + * Specifies the orientation of text in the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + orientation: Word.TextOrientation | "Horizontal" | "Upward" | "Downward" | "VerticalFarEast" | "HorizontalRotatedFarEast" | "Vertical"; + /** + * Specifies the starting character position of the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + start: number; + /** + * Returns the number of characters in the story that contains the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly storyLength: number; + /** + * Returns the story type for the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly storyType: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; + /** + * Specifies the text in the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + text: string; + /** + * Returns the selection type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly type: Word.SelectionType | "NoSelection" | "InsertionPoint" | "Normal" | "Frame" | "Column" | "Row" | "Block" | "InlineShape" | "SelectionShape"; + /** + * Calculates the first mathematical expression within the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * @returns The result of the calculation. + */ + calculate(): OfficeExtension.ClientResult; + /** + * Cancels a mode such as extend or column select. This is equivalent to pressing the Esc key. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + cancelMode(): void; + /** + * Removes character formatting applied through character styles. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + clearCharacterStyleFormatting(): void; + /** + * Removes character and paragraph formatting from the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + clearFormatting(): void; + /** + * Removes manually applied character formatting from the selected text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + clearManualCharacterFormatting(): void; + /** + * Removes manually applied paragraph formatting from the selected text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + clearManualParagraphFormatting(): void; + /** + * Removes all paragraph formatting from the selected text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + clearParagraphFormatting(): void; + /** + * Removes paragraph formatting applied through paragraph styles. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + clearParagraphStyle(): void; + /** + * Collapses the selection to the starting or ending position. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param direction Optional. Direction to collapse. + */ + collapse(direction?: Word.CollapseDirection): void; + /** + * Collapses the selection to the starting or ending position. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param direction Optional. Direction to collapse. + */ + collapse(direction?: "Start" | "End"): void; + /** + * Converts text within a range to a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options Optional. Options for converting text to a table. + * @returns A `Table` object that represents the newly created table. + */ + convertToTable(options?: Word.SelectionConvertToTableOptions): Word.Table; + /** + * Copies the selection to the Clipboard as a picture. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + copyAsPictureToClipboard(): void; + /** + * Copies the character formatting of the first character in the selected text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + copyFormat(): void; + /** + * Copies the selection to the Clipboard. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + copyToClipboard(): void; + /** + * Adds a default-sized text box around the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + createTextBox(): void; + /** + * Removes the selected content from the document and moves it to the Clipboard. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + cut(): void; + /** + * Deletes the specified number of characters or words. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options Optional. Options for deleting text. + * @returns The number of characters deleted. + */ + delete(options?: Word.SelectionDeleteOptions): OfficeExtension.ClientResult; + /** + * Analyzes the selected text to determine the language that it's written in. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + detectLanguage(): void; + /** + * Expands the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param unit Optional. The unit to expand. + * @returns The number of characters added to the range or selection. + */ + expand(unit?: Word.OperationUnit): OfficeExtension.ClientResult; + /** + * Expands the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param unit Optional. The unit to expand. + * @returns The number of characters added to the range or selection. + */ + expand(unit?: "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"): OfficeExtension.ClientResult; + /** + * Expands the selection to include the entire story. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + expandToWholeStory(): void; + /** + * Turns on extend mode, or if extend mode is already on, extends the selection to the next larger unit of text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param character Optional. The character through which the selection is extended. This argument is case-sensitive and must evaluate to a string or an error occurs. Also, if the value of this argument is longer than a single character, Microsoft Word ignores the command entirely. + */ + extend(character?: Word.OperationUnit): void; + /** + * Turns on extend mode, or if extend mode is already on, extends the selection to the next larger unit of text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param character Optional. The character through which the selection is extended. This argument is case-sensitive and must evaluate to a string or an error occurs. Also, if the value of this argument is longer than a single character, Microsoft Word ignores the command entirely. + */ + extend(character?: "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"): void; + /** + * Returns a `Range` object that represents the next unit relative to the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options Optional. Options for the `next` operation. + * @returns A `Range` object that represents the next unit relative to the selection. + */ + getNextRange(options?: Word.SelectionNextOptions): Word.Range; + /** + * Returns a `Range` object that represents the previous unit relative to the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options Optional. Options for the `previous` operation. + * @returns A `Range` object that represents the previous unit relative to the selection. + */ + getPreviousRange(options?: Word.SelectionPreviousOptions): Word.Range; + /** + * Returns a `Range` object that represents the area specified by the `options` and moves the insertion point to the character position immediately preceding the specified item. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options Optional. Options for the `goTo` operation. + * @returns A `Range` object that is now selected. + */ + goTo(options?: Word.SelectionGoToOptions): Word.Range; + /** + * Returns a `Range` object that refers to the start position of the next item or location specified by the `what` argument and moves the selection to the specified item. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param what The item type to go to. + * @returns A `Range` object that refers to the start position of the next item or location specified by the `what` argument. + */ + goToNext(what: Word.GoToItem): Word.Range; + /** + * Returns a `Range` object that refers to the start position of the next item or location specified by the `what` argument and moves the selection to the specified item. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param what The item type to go to. + * @returns A `Range` object that refers to the start position of the next item or location specified by the `what` argument. + */ + goToNext(what: "Bookmark" | "Comment" | "Endnote" | "Field" | "Footnote" | "Graphic" | "Heading" | "Line" | "Page" | "Section" | "Table" | "EmbeddedObject" | "Equation" | "Percent" | "SpellingError" | "GrammaticalError" | "ProofreadingError"): Word.Range; + /** + * Returns a `Range` object that refers to the start position of the previous item or location specified by the `what` argument and moves the selection to the specified item. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param what The item type to go to. + * @returns A `Range` object that refers to the start position of the previous item or location specified by the `what` argument. + */ + goToPrevious(what: Word.GoToItem): Word.Range; + /** + * Returns a `Range` object that refers to the start position of the previous item or location specified by the `what` argument and moves the selection to the specified item. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param what The item type to go to. + * @returns A `Range` object that refers to the start position of the previous item or location specified by the `what` argument. + */ + goToPrevious(what: "Bookmark" | "Comment" | "Endnote" | "Field" | "Footnote" | "Graphic" | "Heading" | "Line" | "Page" | "Section" | "Table" | "EmbeddedObject" | "Equation" | "Percent" | "SpellingError" | "GrammaticalError" | "ProofreadingError"): Word.Range; + /** + * Inserts the specified text at the end of the range or selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param text Text to insert. + */ + insertAfter(text: string): void; + /** + * Inserts the specified text before the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param text Text to insert. + */ + insertBefore(text: string): void; + /** + * Adds cells to an existing table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param shiftCells Optional. Specifies how to insert the cells into the existing columns and rows of the table. The default value is `shiftDown`. + */ + insertCells(shiftCells?: Word.TableCellInsertionLocation): void; + /** + * Adds cells to an existing table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param shiftCells Optional. Specifies how to insert the cells into the existing columns and rows of the table. The default value is `shiftDown`. + */ + insertCells(shiftCells?: "ShiftRight" | "ShiftDown" | "ShiftRowDown" | "ShiftColumnRight"): void; + /** + * Inserts columns to the left of the column that contains the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + insertColumnsLeft(): void; + /** + * Inserts columns to the right of the current selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + insertColumnsRight(): void; + /** + * Inserts the current date or time, or both, either as text or as a {@link https://support.microsoft.com/office/6cb8fcef-310a-4646-ae6b-886d88335c90 | TIME field}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options Options for inserting the date or time. + */ + insertDateTime(options?: Word.SelectionInsertDateTimeOptions): void; + /** + * Inserts a {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | Formula field} at the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options Optional. Options for inserting the formula. + */ + insertFormula(options?: Word.SelectionInsertFormulaOptions): void; + /** + * Inserts a new page at the position of the insertion point. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + insertNewPage(): void; + /** + * Inserts a paragraph mark after the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + insertParagraphAfter(): void; + /** + * Inserts a new paragraph before the selection or range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + insertParagraphBefore(): void; + /** + * Inserts a special hidden paragraph mark that allows Word to join paragraphs formatted using different paragraph styles. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + insertParagraphStyleSeparator(): void; + /** + * Inserts rows above the current selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param numRows Optional. Number of rows to insert. + */ + insertRowsAbove(numRows: number): void; + /** + * Inserts rows below the current selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param numRows Optional. Number of rows to insert. + */ + insertRowsBelow(numRows: number): void; + /** + * Inserts a symbol in place of the specified selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param characterNumber The character number of the symbol. + * @param options Optional. Options for inserting the symbol. + */ + insertSymbol(characterNumber: number, options?: Word.SelectionInsertSymbolOptions): void; + /** + * Inserts the specified text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param Text The text to insert. + */ + insertText(Text: string): void; + /** + * Inserts the specified XML into the document at the cursor, replacing any selected text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param xml The XML string to insert. + * @param transform Optional. XSL transform to apply. + */ + insertXML(xml: string, transform?: string): void; + /** + * Returns whether the selection is equal to the specified range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param range The range to compare. + * @returns `true` if the selection is equal to the specified range. + */ + isEqual(range: Word.Range): OfficeExtension.ClientResult; + /** + * Returns `true` if the selection is contained within the specified range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param range The range to compare. + * @returns `true` if the selection is contained within the specified range. + */ + isInRange(range: Word.Range): OfficeExtension.ClientResult; + /** + * Returns whether the selection is in the same story as the specified range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param range The range to compare. + * @returns `true` if the selection is in the same story as the specified range. + */ + isInStory(range: Word.Range): OfficeExtension.ClientResult; + /** + * Collapses the selection to its start or end position and then moves the collapsed object by the specified number of units. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options Optional. Options for moving the selection. + * @returns The number of characters by which the selection was moved. + */ + move(options?: Word.SelectionMoveOptions): OfficeExtension.ClientResult; + /** + * Moves the selection down. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options Optional. Options for moving down. + * @returns The number of characters by which the selection was moved. + */ + moveDown(options?: Word.SelectionMoveUpDownOptions): OfficeExtension.ClientResult; + /** + * Moves the ending character position of the range or selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options Optional. Options for moving end. + * @returns The number of characters by which the selection was moved. + */ + moveEnd(options?: Word.SelectionMoveStartEndOptions): OfficeExtension.ClientResult; + /** + * Moves the end position of the selection until any of the specified characters are found in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param characters Characters to search for. For example. If you specify "a", the selection moves the end position to before the first "a" character. + * @param count Optional. Maximum number of characters to search. + * @returns The number of characters by which the selection was moved. + */ + moveEndUntil(characters: string, count?: number): OfficeExtension.ClientResult; + /** + * Moves the ending character position of the selection while any of the specified characters are found in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param characters Characters to search for. For example. If you specify "abcd", the selection moves the end position when any letter from "abcd" is found. + * @param count Optional. Maximum number of characters to search. + * @returns The number of characters by which the selection was moved. + */ + moveEndWhile(characters: string, count?: number): OfficeExtension.ClientResult; + /** + * Moves the selection to the left. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options Optional. Options for moving left. + * @returns The number of characters by which the selection was moved. + */ + moveLeft(options?: Word.SelectionMoveLeftRightOptions): OfficeExtension.ClientResult; + /** + * Moves the selection to the right. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options Optional. Options for moving right. + * @returns The number of characters by which the selection was moved. + */ + moveRight(options?: Word.SelectionMoveLeftRightOptions): OfficeExtension.ClientResult; + /** + * Moves the start position of the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options Optional. Options for the `moveStart` operation. + * @returns The number of characters by which the selection was moved. + */ + moveStart(options?: Word.SelectionMoveStartEndOptions): OfficeExtension.ClientResult; + /** + * Moves the start position of the selection until one of the specified characters is found in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param characters Characters to search for. If you specify "a", the selection moves the start position to before the first "a" character. + * @param count Optional. Maximum number of characters to search. + * @returns The number of characters by which the selection was moved. + */ + moveStartUntil(characters: string, count?: number): OfficeExtension.ClientResult; + /** + * Moves the start position of the selection while any of the specified characters are found in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param characters Characters to search for. For example. If you specify "abcd", the selection moves the start position when any letter from "abcd" is found. + * @param count Optional. Maximum number of characters to search. + * @returns The number of characters by which the selection was moved. + */ + moveStartWhile(characters: string, count?: number): OfficeExtension.ClientResult; + /** + * Moves the selection until one of the specified characters is found in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param characters Characters to search for. For example. If you specify "a", the selection moves to the position before the first "a" character. + * @param count Optional. Maximum number of characters to search. + * @returns The number of characters by which the selection was moved. + */ + moveUntil(characters: string, count?: number): OfficeExtension.ClientResult; + /** + * Moves the selection up. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options Optional. Options for moving up. + * @returns The number of characters by which the selection was moved. + */ + moveUp(options?: Word.SelectionMoveUpDownOptions): OfficeExtension.ClientResult; + /** + * Moves the selection while any of the specified characters are found in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param characters Characters to search for. For example. If you specify "abcd", the selection moves to the position when any letter from "abcd" is found. + * @param count Optional. Maximum number of characters to search. + * @returns The number of characters by which the selection was moved. + */ + moveWhile(characters: string, count?: number): OfficeExtension.ClientResult; + /** + * Selects the next field. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * @returns The next field. + */ + nextField(): Word.Field; + /** + * Moves the selection to the next subDocument. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nextSubdocument(): void; + /** + * Pastes the content from clipboard and formats them as specified. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param type The format paste type for table cells + */ + pasteAndFormat(type: Word.PasteFormatType): void; + /** + * Pastes the content from clipboard and formats them as specified. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param type The format paste type for table cells + */ + pasteAndFormat(type: "PasteDefault" | "SingleCellText" | "SingleCellTable" | "ListContinueNumbering" | "ListRestartNumbering" | "TableAppendTable" | "TableInsertAsRows" | "TableOriginalFormatting" | "ChartPicture" | "Chart" | "ChartLinked" | "FormatOriginalFormatting" | "FormatSurroundingFormattingWithEmphasis" | "FormatPlainText" | "TableOverwriteCells" | "ListCombineWithExistingList" | "ListDontMerge" | "UseDestinationStylesRecovery"): void; + /** + * Pastes and formats a Microsoft Excel table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param linkedToExcel Whether the table is linked to Excel. + * @param wordFormatting Whether to apply Word formatting. + * @param rtf Whether to paste as Rich Text Format (RTF). + */ + pasteExcelTable(linkedToExcel: boolean, wordFormatting: boolean, rtf: boolean): void; + /** + * Applies formatting copied with the `copyFormat` method to the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + pasteFormat(): void; + /** + * Merges pasted cells into an existing table by inserting the pasted rows between the selected rows. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + pasteTableCellsAppendTable(): void; + /** + * Pastes a cell or group of cells as a nested table into the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + pasteTableCellsAsNestedTable(): void; + /** + * Selects and returns the previous field. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * @returns The previous field. + */ + previousField(): Word.Field; + /** + * Moves the selection to the previous subDocument. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + previousSubdocument(): void; + /** + * Replaces the selection with a new paragraph. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + replaceParagraph(): void; + /** + * Selects the current text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + select(): void; + /** + * Selects the entire cell containing the current selection when the selection is in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + selectCell(): void; + /** + * Selects the column that contains the insertion point, or selects all columns that contain the selection when the selection is in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + selectColumn(): void; + /** + * Extends the selection forward until text with a different paragraph alignment is encountered. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + selectCurrentAlignment(): void; + /** + * Extends the selection forward until text with a different color is encountered. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + selectCurrentColor(): void; + /** + * Extends the selection forward until text in a different font or font size is encountered. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + selectCurrentFont(): void; + /** + * Extends the selection forward until text with different left or right paragraph indents is encountered. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + selectCurrentIndent(): void; + /** + * Extends the selection forward until a paragraph with different line spacing is encountered. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + selectCurrentSpacing(): void; + /** + * Extends the selection forward until a paragraph with different tab stops is encountered. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + selectCurrentTabs(): void; + /** + * Selects the row that contains the insertion point, or selects all rows that contain the selection when the selection is in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + selectRow(): void; + /** + * Sets the starting and ending character positions for the selection. + Character position values start at the beginning of the story, with the first value being 0. All characters are counted, including nonprinting characters. Hidden characters are counted even if they're not displayed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param start The starting character position of the current story. + * @param end The ending character position of the current story. + */ + setRange(start: number, end: number): void; + /** + * Shrinks the selection to the next smaller unit of text. + The unit progression for this method is as follows: entire document, section, paragraph, sentence, word, insertion point. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shrink(): void; + /** + * Cancels the selection of all but the most recently selected text when the current selection contains multiple, unconnected selections. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shrinkDiscontiguousSelection(): void; + /** + * Inserts an empty paragraph above the first row in the selection. + If the selection isn't in the first row of the table, the table is split into two tables. If the selection isn't in a table, an error occurs. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + splitTable(): void; + /** + * Switches the selection between a Unicode character and its corresponding hexadecimal value. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + toggleCharacterCode(): void; + /** + * Deletes the character preceding the selection (if collapsed) or the insertion point. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + typeBackspace(): 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?: Word.Interfaces.SelectionLoadOptions): Word.Selection; + /** + * 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[]): Word.Selection; + /** + * 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; + }): Word.Selection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.Selection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.Selection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Selection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.SelectionData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.SelectionData; + } + /** + * Represents a collection of {@link Word.Range} objects that represents each character, word or sentence. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class RangeScopedCollection 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: Word.Range[]; + /** + * Gets a `Range` object by its index in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index The location of a `Range` object in the collection. + */ + getItem(index: number): Word.Range; + /** + * 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?: Word.Interfaces.RangeScopedCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.RangeScopedCollection; + /** + * 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[]): Word.RangeScopedCollection; + /** + * 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): Word.RangeScopedCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.RangeScopedCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.RangeScopedCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.RangeScopedCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.RangeScopedCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.RangeScopedCollectionData; + } + /** + * Specifies the direction in which text flows from one text column to the next. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum FlowDirection { + /** + * Text flows from left to right. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + leftToRight = "LeftToRight", + /** + * Text flows from right to left. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + rightToLeft = "RightToLeft", + } + /** + * Specifies where the gutter appears in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum GutterPosition { + /** + * The gutter appears on the left side of the document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + left = "Left", + /** + * The gutter appears on the right side of the document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + right = "Right", + /** + * The gutter appears at the top of the document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + top = "Top", + } + /** + * Specifies whether the gutter style should conform to left-to-right text flow or right-to-left text flow. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum GutterStyle { + /** + * Gutter style for bidirectional text flow. This is mainly right to left. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bidirectional = "Bidirectional", + /** + * Gutter style for Latin text flow. This is mainly left to right. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + latin = "Latin", + } + /** + * Specifies how text is laid out in the layout mode for the current document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum LayoutMode { + /** + * Default layout mode. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + default = "Default", + /** + * Grid layout mode. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid = "Grid", + /** + * Line grid layout mode. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lineGrid = "LineGrid", + /** + * Genko layout mode. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + genko = "Genko", + } + /** + * Specifies the numbering rule to apply. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum NumberingRule { + /** + * Restart numbering continuously. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + restartContinuous = "RestartContinuous", + /** + * Restart numbering at the beginning of each section. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + restartSection = "RestartSection", + /** + * Restart numbering at the beginning of each page. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + restartPage = "RestartPage", + } + /** + * Specifies a page layout orientation. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PageOrientation { + /** + * Portrait orientation. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + portrait = "Portrait", + /** + * Landscape orientation. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + landscape = "Landscape", + } + /** + * Specifies the type of vertical alignment to apply. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PageSetupVerticalAlignment { + /** + * Align text to the top. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + top = "Top", + /** + * Align text to the center. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + center = "Center", + /** + * Justify text vertically. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + justify = "Justify", + /** + * Align text to the bottom. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bottom = "Bottom", + } + /** + * Specifies a paper size. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PaperSize { + /** + * 10x14 paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + size10x14 = "Size10x14", + /** + * 11x17 paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + size11x17 = "Size11x17", + /** + * Letter paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + letter = "Letter", + /** + * Small letter paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + letterSmall = "LetterSmall", + /** + * Legal paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + legal = "Legal", + /** + * Executive paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + executive = "Executive", + /** + * A3 paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + a3 = "A3", + /** + * A4 paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + a4 = "A4", + /** + * Small A4 paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + a4Small = "A4Small", + /** + * A5 paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + a5 = "A5", + /** + * B4 paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + b4 = "B4", + /** + * B5 paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + b5 = "B5", + /** + * C-sheet paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + csheet = "CSheet", + /** + * D-sheet paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + dsheet = "DSheet", + /** + * E-sheet paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + esheet = "ESheet", + /** + * Fanfold legal German paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fanfoldLegalGerman = "FanfoldLegalGerman", + /** + * Fanfold standard German paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fanfoldStdGerman = "FanfoldStdGerman", + /** + * Fanfold US paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fanfoldUS = "FanfoldUS", + /** + * Folio paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + folio = "Folio", + /** + * Ledger paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + ledger = "Ledger", + /** + * Note paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + note = "Note", + /** + * Quarto paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + quarto = "Quarto", + /** + * Statement paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + statement = "Statement", + /** + * Tabloid paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tabloid = "Tabloid", + /** + * Envelope size 9. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelope9 = "Envelope9", + /** + * Envelope size 10. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelope10 = "Envelope10", + /** + * Envelope size 11. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelope11 = "Envelope11", + /** + * Envelope size 12. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelope12 = "Envelope12", + /** + * Envelope size 14. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelope14 = "Envelope14", + /** + * Envelope B4 size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeB4 = "EnvelopeB4", + /** + * Envelope B5 size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeB5 = "EnvelopeB5", + /** + * Envelope B6 size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeB6 = "EnvelopeB6", + /** + * Envelope C3 size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeC3 = "EnvelopeC3", + /** + * Envelope C4 size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeC4 = "EnvelopeC4", + /** + * Envelope C5 size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeC5 = "EnvelopeC5", + /** + * Envelope C6 size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeC6 = "EnvelopeC6", + /** + * Envelope C65 size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeC65 = "EnvelopeC65", + /** + * Envelope DL size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeDL = "EnvelopeDL", + /** + * Envelope Italy size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeItaly = "EnvelopeItaly", + /** + * Envelope Monarch size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopeMonarch = "EnvelopeMonarch", + /** + * Envelope Personal size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + envelopePersonal = "EnvelopePersonal", + /** + * Custom paper size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + custom = "Custom", + } + /** + * Specifies how Word displays the reading order and alignment for the specified sections. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum SectionDirection { + /** + * Right-to-left reading order. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + rightToLeft = "RightToLeft", + /** + * Left-to-right reading order. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + leftToRight = "LeftToRight", + } + /** + * Specifies the type of section break for the specified item. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum SectionStart { + /** + * Continuous section break. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + continuous = "Continuous", + /** + * New column section break. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + newColumn = "NewColumn", + /** + * New page section break. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + newPage = "NewPage", + /** + * Even page section break. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + evenPage = "EvenPage", + /** + * Odd page section break. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + oddPage = "OddPage", + } + /** + * Specifies how a table is resized to fit its contents or the window. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum AutoFitBehavior { + /** + * Disables automatic resizing. The table retains its current size. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fixedSize = "FixedSize", + /** + * Automatically resizes the table columns to fit the contents. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + content = "Content", + /** + * Automatically resizes the table to fit the window width. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + window = "Window", + } + /** + * Specifies the type of bidirectional calendar to use. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum CalendarTypeBidirectional { + /** + * Uses the Gregorian calendar. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + gregorian = "Gregorian", + /** + * Uses the Bidirectional calendar. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bidirectional = "Bidirectional", + } + /** + * Specifies the type of caption label to use. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum CaptionLabelType { + /** + * Specifies a figure caption label. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + figure = "Figure", + /** + * Specifies a table caption label. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + table = "Table", + /** + * Specifies an equation caption label. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + equation = "Equation", + } + /** + * Specifies the position of a caption relative to the object it describes. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum CaptionPosition { + /** + * Places the caption above the selected item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + above = "Above", + /** + * Places the caption below the selected item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + below = "Below", + } + /** + * Specifies the direction in which to collapse a selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum CollapseDirection { + /** + * Collapses the selection to the start position. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + start = "Start", + /** + * Collapses the selection to the end position. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + end = "End", + } + /** + * Specifies the language to use for date formatting. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum DateLanguage { + /** + * Uses the bidirectional date/time format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bidirectional = "Bidirectional", + /** + * Uses the latin date/time format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + latin = "Latin", + } + /** + * Specifies the default behavior when inserting a new table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum DefaultTableBehavior { + /** + * Disables AutoFit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + disableAutoFit = "DisableAutoFit", + /** + * Enables AutoFit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enableAutoFit = "EnableAutoFit", + } + /** + * Specifies the location of endnotes in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum EndnoteLocation { + /** + * Places endnotes at the end of the section. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + endOfSection = "EndOfSection", + /** + * Places endnotes at the end of the document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + endOfDocument = "EndOfDocument", + } + /** + * Specifies the font bias to use when formatting East Asian text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum FontBias { + /** + * Uses the default font bias. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + standard = "Standard", + /** + * Uses the font bias for Far East text. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + farEast = "FarEast", + /** + * No font bias specified. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + noSpecified = "NoSpecified", + } + /** + * Specifies the location of footnotes in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum FootnoteLocation { + /** + * Places footnotes at the bottom of the page. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bottomOfPage = "BottomOfPage", + /** + * Places footnotes below the text on the page. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + beneathText = "BeneathText", + } + /** + * Specifies the direction in which to move when using the {@link Word.Selection | Selection.goTo} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum GoToDirection { + /** + * Moves to the first item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + first = "First", + /** + * Moves to the last item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + last = "Last", + /** + * Moves to the next item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + next = "Next", + /** + * Moves to the previous item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + previous = "Previous", + } + /** + * Specifies the item or location to which to move or extend a {@link Word.Selection | selection}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum GoToItem { + /** + * Moves to a bookmark. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bookmark = "Bookmark", + /** + * Moves to a comment. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + comment = "Comment", + /** + * Moves to a endnote. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + endnote = "Endnote", + /** + * Moves to a field. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + field = "Field", + /** + * Moves to a footnote. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + footnote = "Footnote", + /** + * Moves to a graphic. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + graphic = "Graphic", + /** + * Moves to a heading. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + heading = "Heading", + /** + * Moves to a line. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + line = "Line", + /** + * Moves to a page. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + page = "Page", + /** + * Moves to a section. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + section = "Section", + /** + * Moves to a table. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + table = "Table", + /** + * Moves to an embedded object. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + embeddedObject = "EmbeddedObject", + /** + * Moves to an equation. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + equation = "Equation", + /** + * Moves to a percent. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + percent = "Percent", + /** + * Moves to a spelling error. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + spellingError = "SpellingError", + /** + * Moves to a grammatical error. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grammaticalError = "GrammaticalError", + /** + * Moves to a proofreading error. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + proofreadingError = "ProofreadingError", + } + /** + * Specifies the type of movement when navigating through a document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum MovementType { + /** + * Moves the insertion point or selection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + move = "Move", + /** + * Extends the selection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + extend = "Extend", + } + /** + * Specifies the numbering style to use for footnotes or endnotes. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum NoteNumberStyle { + /** + * Uses Arabic numerals (1, 2, 3...). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + arabic = "Arabic", + /** + * Uses uppercase Roman numerals (I, II, III...). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + uppercaseRoman = "UppercaseRoman", + /** + * Uses lowercase Roman numerals (i, ii, iii...). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lowercaseRoman = "LowercaseRoman", + /** + * Uses uppercase letters (A, B, C...). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + uppercaseLetter = "UppercaseLetter", + /** + * Uses lowercase letters (a, b, c...). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lowercaseLetter = "LowercaseLetter", + /** + * Uses a symbol instead of a number. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + symbol = "Symbol", + /** + * Uses full-width Arabic numerals. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + arabicFullWidth = "ArabicFullWidth", + /** + * Uses Kanji characters. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + kanji = "Kanji", + /** + * Uses Kanji digits. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + kanjiDigit = "KanjiDigit", + /** + * Uses traditional Kanji characters. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + kanjiTraditional = "KanjiTraditional", + /** + * Uses numbers enclosed in circles. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numberInCircle = "NumberInCircle", + /** + * Uses Hanja characters with phonetic reading. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hanjaRead = "HanjaRead", + /** + * Uses Hanja digits with phonetic reading. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hanjaReadDigit = "HanjaReadDigit", + /** + * Uses traditional Chinese numerals (style 1). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + traditionalChineseNumeral1 = "traditionalChineseNumeral1", + /** + * Uses traditional Chinese numerals (style 2). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + traditionalChineseNumeral2 = "traditionalChineseNumeral2", + /** + * Uses simplified Chinese numerals (style 1). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + simplifiedChineseNumeral1 = "simplifiedChineseNumeral1", + /** + * Uses simplified Chinese numerals (style 2). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + simplifiedChineseNumeral2 = "simplifiedChineseNumeral2", + /** + * Uses Hebrew letters (style 1). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hebrewLetter1 = "HebrewLetter1", + /** + * Uses Arabic letters (style 1). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + arabicLetter1 = "ArabicLetter1", + /** + * Uses Hebrew letters (style 2). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hebrewLetter2 = "HebrewLetter2", + /** + * Uses Arabic letters (style 2). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + arabicLetter2 = "ArabicLetter2", + /** + * Uses Hindi letters (style 1). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hindiLetter1 = "HindiLetter1", + /** + * Uses Hindi letters (style 2). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hindiLetter2 = "HindiLetter2", + /** + * Uses Hindi Arabic numerals. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hindiArabic = "HindiArabic", + /** + * Uses Hindi cardinal text. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hindiCardinalText = "HindiCardinalText", + /** + * Uses Thai letters. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + thaiLetter = "ThaiLetter", + /** + * Uses Thai Arabic numerals. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + thaiArabic = "ThaiArabic", + /** + * Uses Thai cardinal text. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + thaiCardinalText = "ThaiCardinalText", + /** + * Uses Vietnamese cardinal text. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + vietnameseCardinalText = "vietnameseCardinalText", + } + /** + * Specifies the unit of measurement used in Word operations. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum OperationUnit { + /** + * Specifies a character unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + character = "Character", + /** + * Specifies a word unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + word = "Word", + /** + * Specifies a sentence unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sentence = "Sentence", + /** + * Specifies a paragraph unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + paragraph = "Paragraph", + /** + * Specifies a line unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + line = "Line", + /** + * Specifies a story unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + story = "Story", + /** + * Specifies a screen unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + screen = "Screen", + /** + * Specifies a section unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + section = "Section", + /** + * Specifies a column unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + column = "Column", + /** + * Specifies a row unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + row = "Row", + /** + * Specifies a window unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + window = "Window", + /** + * Specifies a cell unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + cell = "Cell", + /** + * Specifies a character format unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + characterFormat = "CharacterFormat", + /** + * Specifies a paragraph format unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + paragraphFormat = "ParagraphFormat", + /** + * Specifies a table unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + table = "Table", + /** + * Specifies an item unit. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + item = "Item", + } + /** + * Specifies the format to use when pasting data. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PasteDataType { + /** + * Pastes the data as an OLE object. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + oleObject = "OleObject", + /** + * Pastes the data as rich text format (RTF). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + rtf = "Rtf", + /** + * Pastes the data as plain text. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + text = "Text", + /** + * Pastes the data as a metafile picture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + metafilePicture = "MetafilePicture", + /** + * Pastes the data as a bitmap. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bitmap = "Bitmap", + /** + * Pastes the data as a device-independent bitmap (DIB). + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + deviceIndependentBitmap = "DeviceIndependentBitmap", + /** + * Pastes the data as a hyperlink. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hyperlink = "Hyperlink", + /** + * Pastes the data as a shape. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shape = "Shape", + /** + * Pastes the data as an enhanced metafile. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enhancedMetafile = "EnhancedMetafile", + /** + * Pastes the data as HTML. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + html = "Html", + } + /** + * Specifies the type of formatting when paste to a document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum PasteFormatType { + /** + * Uses the default paste behavior. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + pasteDefault = "PasteDefault", + /** + * Pastes text into a single cell. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + singleCellText = "SingleCellText", + /** + * Pastes a table into a single cell. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + singleCellTable = "SingleCellTable", + /** + * Continues numbering from the previous list. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + listContinueNumbering = "ListContinueNumbering", + /** + * Restarts numbering for the new list. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + listRestartNumbering = "ListRestartNumbering", + /** + * Appends the pasted table to the existing table. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tableAppendTable = "TableAppendTable", + /** + * Inserts the pasted table as new rows. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tableInsertAsRows = "TableInsertAsRows", + /** + * Inserts the pasted table with its original formatting. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tableOriginalFormatting = "TableOriginalFormatting", + /** + * Pastes a chart as a picture. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + chartPicture = "ChartPicture", + /** + * Pastes a chart as an editable chart. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + chart = "Chart", + /** + * Pastes a chart with a link to the source data. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + chartLinked = "ChartLinked", + /** + * Applies the original formatting of the pasted content. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + formatOriginalFormatting = "FormatOriginalFormatting", + /** + * Applies surrounding formatting with emphasis. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + formatSurroundingFormattingWithEmphasis = "FormatSurroundingFormattingWithEmphasis", + /** + * Pastes content as plain text. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + formatPlainText = "FormatPlainText", + /** + * Overwrites existing cells with the pasted table. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tableOverwriteCells = "TableOverwriteCells", + /** + * Combines the pasted list with an existing list. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + listCombineWithExistingList = "ListCombineWithExistingList", + /** + * Prevents merging the pasted list with an existing list. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + listDontMerge = "ListDontMerge", + /** + * Uses the destination styles for the pasted content. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + useDestinationStylesRecovery = "UseDestinationStylesRecovery", + } + /** + * Specifies the kind of reference to insert. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ReferenceKind { + /** + * Inserts the full text of the referenced item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + contentText = "ContentText", + /** + * Inserts the number of the referenced item with relative context. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numberRelativeContext = "NumberRelativeContext", + /** + * Inserts only the number of the referenced item without context. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numberNoContext = "NumberNoContext", + /** + * Inserts the number of the referenced item with full context. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numberFullContext = "NumberFullContext", + /** + * Inserts the entire caption of the referenced item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + entireCaption = "EntireCaption", + /** + * Inserts only the label and number of the referenced item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + onlyLabelAndNumber = "OnlyLabelAndNumber", + /** + * Inserts only the caption text of the referenced item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + onlyCaptionText = "OnlyCaptionText", + /** + * Inserts the footnote number of the referenced item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + footnoteNumber = "FootnoteNumber", + /** + * Inserts the endnote number of the referenced item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + endnoteNumber = "EndnoteNumber", + /** + * Inserts the page number of the referenced item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + pageNumber = "PageNumber", + /** + * Inserts the position of the referenced item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + position = "Position", + /** + * Inserts the formatted footnote number of the referenced item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + footnoteNumberFormatted = "FootnoteNumberFormatted", + /** + * Inserts the formatted endnote number of the referenced item. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + endnoteNumberFormatted = "EndnoteNumberFormatted", + } + /** + * Specifies the type of reference to insert. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ReferenceType { + /** + * Refers to a numbered item in the document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numberedItem = "NumberedItem", + /** + * Refers to a heading in the document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + heading = "Heading", + /** + * Refers to a bookmark in the document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bookmark = "Bookmark", + /** + * Refers to a footnote in the document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + footnote = "Footnote", + /** + * Refers to an endnote in the document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + endnote = "Endnote", + } + /** + * Specifies the type of selection in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum SelectionType { + /** + * No selection is made. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + noSelection = "NoSelection", + /** + * Represents an insertion point (IP) selection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + insertionPoint = "InsertionPoint", + /** + * Represents a normal selection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + normal = "Normal", + /** + * Represents a frame selection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + frame = "Frame", + /** + * Represents a column selection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + column = "Column", + /** + * Represents a row selection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + row = "Row", + /** + * Represents a block selection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + block = "Block", + /** + * Represents an inline shape selection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + inlineShape = "InlineShape", + /** + * Represents a shape selection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + selectionShape = "SelectionShape", + } + /** + * Specifies the type of field to sort by. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum SortFieldType { + /** + * Sorts content alphanumerically. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + alphanumeric = "Alphanumeric", + /** + * Sorts content numerically. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numeric = "Numeric", + /** + * Sorts content by date. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + date = "Date", + /** + * Sorts content by syllables. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + syllable = "Syllable", + /** + * Sorts content using the Japanese JIS standard. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + japanJis = "JapanJis", + /** + * Sorts content by stroke count. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + stroke = "Stroke", + /** + * Sorts content using the Korean KS standard. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + koreaKs = "KoreaKs", + } + /** + * Specifies the sort order. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum SortOrder { + /** + * Sorts in ascending order. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + ascending = "Ascending", + /** + * Sorts in descending order. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + descending = "Descending", + } + /** + * Specifies where and what type of cells to add to an existing table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum TableCellInsertionLocation { + /** + * Inserts new cells to the left of the selected cells. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shiftRight = "ShiftRight", + /** + * Inserts new cells above the selected cells. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shiftDown = "ShiftDown", + /** + * Inserts an entire row above the row that contains the selection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shiftRowDown = "ShiftRowDown", + /** + * Inserts an entire column to the left of the column that contains the selection. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shiftColumnRight = "ShiftColumnRight", + } + /** + * Specifies the predefined table formatting options. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum TableFormat { + /** + * No table format is applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + none = "None", + /** + * Applies the simple 1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + simple1 = "Simple1", + /** + * Applies the simple 2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + simple2 = "Simple2", + /** + * Applies the simple 3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + simple3 = "Simple3", + /** + * Applies the classic 1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + classic1 = "Classic1", + /** + * Applies the classic 2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + classic2 = "Classic2", + /** + * Applies the classic 3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + classic3 = "Classic3", + /** + * Applies the classic 4 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + classic4 = "Classic4", + /** + * Applies the colorful 1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + colorful1 = "Colorful1", + /** + * Applies the colorful 2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + colorful2 = "Colorful2", + /** + * Applies the colorful 3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + colorful3 = "Colorful3", + /** + * Applies the columns 1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + columns1 = "Columns1", + /** + * Applies the columns 2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + columns2 = "Columns2", + /** + * Applies the columns 3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + columns3 = "Columns3", + /** + * Applies the columns 4 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + columns4 = "Columns4", + /** + * Applies the columns 5 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + columns5 = "Columns5", + /** + * Applies the grid 1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid1 = "Grid1", + /** + * Applies the grid 2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid2 = "Grid2", + /** + * Applies the grid 3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid3 = "Grid3", + /** + * Applies the grid 4 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid4 = "Grid4", + /** + * Applies the grid 5 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid5 = "Grid5", + /** + * Applies the grid 6 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid6 = "Grid6", + /** + * Applies the grid 7 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid7 = "Grid7", + /** + * Applies the grid 8 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid8 = "Grid8", + /** + * Applies the list 1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list1 = "List1", + /** + * Applies the list 2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list2 = "List2", + /** + * Applies the list 3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list3 = "List3", + /** + * Applies the list 4 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list4 = "List4", + /** + * Applies the list 5 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list5 = "List5", + /** + * Applies the list 6 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list6 = "List6", + /** + * Applies the list 7 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list7 = "List7", + /** + * Applies the list 8 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list8 = "List8", + /** + * Applies the 3D effects 1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + threeDEffects1 = "ThreeDEffects1", + /** + * Applies the 3D effects 2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + threeDEffects2 = "ThreeDEffects2", + /** + * Applies the 3D effects 3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + threeDEffects3 = "ThreeDEffects3", + /** + * Applies the contemporary table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + contemporary = "Contemporary", + /** + * Applies the elegant table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + elegant = "Elegant", + /** + * Applies the professional table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + professional = "Professional", + /** + * Applies the subtle 1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + subtle1 = "Subtle1", + /** + * Applies the subtle 2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + subtle2 = "Subtle2", + /** + * Applies the web 1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + web1 = "Web1", + /** + * Applies the web 2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + web2 = "Web2", + /** + * Applies the web 3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + web3 = "Web3", + } + /** + * Specifies the orientation of text in a text frame or shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum TextOrientation { + /** + * Text is horizontal. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + horizontal = "Horizontal", + /** + * Text is vertical with letters rotated 90 degrees clockwise. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + upward = "Upward", + /** + * Text is vertical with letters rotated 90 degrees counterclockwise. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + downward = "Downward", + /** + * Text is vertical and reads downward from the top, right to left. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + verticalFarEast = "VerticalFarEast", + /** + * Text is horizontal but from right to left to accommodate right-to-left languages. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + horizontalRotatedFarEast = "HorizontalRotatedFarEast", + /** + * Text is vertical and reads downward from the top, left to right. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + vertical = "Vertical", + } + /** + * Represents a single bookmark in a document, selection, or range. The `Bookmark` object is a member of the `Bookmark` collection. + The {@link Word.BookmarkCollection} includes all the bookmarks listed in the **Bookmark** dialog box (**Insert** menu). + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class Bookmark 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 `Range` object that represents the portion of the document that's contained in the `Bookmark` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly range: Word.Range; + /** + * Specifies the ending character position of the bookmark. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + end: number; + /** + * Returns `true` if the bookmark is a table column. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly isColumn: boolean; + /** + * Returns `true` if the bookmark is empty. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly isEmpty: boolean; + /** + * Returns the name of the `Bookmark` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly name: string; + /** + * Specifies the starting character position of the bookmark. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + start: number; + /** + * Returns the story type for the bookmark. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly storyType: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.BookmarkUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Bookmark): void; + /** + * Copies this bookmark to the new bookmark specified in the `name` argument and returns a `Bookmark` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param name The name of the new bookmark. + */ + copyTo(name: string): Word.Bookmark; + /** + * Deletes the bookmark. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + delete(): void; + /** + * Selects the bookmark. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + select(): 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?: Word.Interfaces.BookmarkLoadOptions): Word.Bookmark; + /** + * 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[]): Word.Bookmark; + /** + * 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; + }): Word.Bookmark; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.Bookmark; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.Bookmark; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Bookmark` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BookmarkData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.BookmarkData; + } + /** + * A collection of {@link Word.Bookmark} objects that represent the bookmarks in the specified selection, range, or document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class BookmarkCollection 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: Word.Bookmark[]; + /** + * Determines whether the specified bookmark exists. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param name A bookmark name than cannot include more than 40 characters or more than one word. + * @returns `true` if the bookmark exists. + */ + exists(name: string): OfficeExtension.ClientResult; + /** + * Gets a `Bookmark` object by its index in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index A number that identifies the index location of a `Bookmark` object. + */ + getItem(index: number): Word.Bookmark; + /** + * 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?: Word.Interfaces.BookmarkCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.BookmarkCollection; + /** + * 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[]): Word.BookmarkCollection; + /** + * 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): Word.BookmarkCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.BookmarkCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.BookmarkCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.BookmarkCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.BookmarkCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.BookmarkCollectionData; + } + /** + * Specifies the type of story in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum StoryType { + /** + * Main text story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + mainText = "MainText", + /** + * Footnotes story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + footnotes = "Footnotes", + /** + * Endnotes story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + endnotes = "Endnotes", + /** + * Comments story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + comments = "Comments", + /** + * Text frame story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + textFrame = "TextFrame", + /** + * Even pages header story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + evenPagesHeader = "EvenPagesHeader", + /** + * Primary header story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + primaryHeader = "PrimaryHeader", + /** + * Even pages footer story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + evenPagesFooter = "EvenPagesFooter", + /** + * Primary footer story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + primaryFooter = "PrimaryFooter", + /** + * First page header story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + firstPageHeader = "FirstPageHeader", + /** + * First page footer story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + firstPageFooter = "FirstPageFooter", + /** + * Footnote separator story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + footnoteSeparator = "FootnoteSeparator", + /** + * Footnote continuation separator story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + footnoteContinuationSeparator = "FootnoteContinuationSeparator", + /** + * Footnote continuation notice story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + footnoteContinuationNotice = "FootnoteContinuationNotice", + /** + * Endnote separator story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + endnoteSeparator = "EndnoteSeparator", + /** + * Endnote continuation separator story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + endnoteContinuationSeparator = "EndnoteContinuationSeparator", + /** + * Endnote continuation notice story. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + endnoteContinuationNotice = "EndnoteContinuationNotice", + } + /** + * Represents a single index. The `Index` object is a member of the {@link Word.IndexCollection}. The `IndexCollection` includes all the + indexes in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class Index 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 `Range` object that represents the portion of the document that is contained within the index. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly range: Word.Range; + /** + * Gets a value that represents how Microsoft Word classifies the first character of entries in the index. + See `IndexFilter` for available values. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly filter: Word.IndexFilter | "None" | "Aiueo" | "Akasatana" | "Chosung" | "Low" | "Medium" | "Full"; + /** + * Gets the text between alphabetical groups (entries that start with the same letter) in the index. Corresponds to + the **\h** switch for an {@link https://support.microsoft.com/office/adafcf4a-cb30-43f6-85c7-743da1635d9e | INDEX field}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly headingSeparator: Word.HeadingSeparator | "None" | "BlankLine" | "Letter" | "LetterLow" | "LetterFull"; + /** + * Gets a `LanguageId` value that represents the sorting language to use for the index. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly indexLanguage: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + /** + * Gets the number of columns for each page of the index. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly numberOfColumns: number; + /** + * Specifies if page numbers are aligned with the right margin in the index. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly rightAlignPageNumbers: boolean; + /** + * Gets if the index contains separate headings for accented letters (for example, words that begin with "À" are under + one heading and words that begin with "A" are under another). + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly separateAccentedLetterHeadings: boolean; + /** + * Specifies the sorting criteria for the index. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly sortBy: Word.IndexSortBy | "Stroke" | "Syllable"; + /** + * Specifies the leader character between entries in the index and their associated page numbers. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + /** + * Gets the index type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly type: Word.IndexType | "Indent" | "Runin"; + /** + * Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. + * @param properties A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called. + * @param options Provides an option to suppress errors if the properties object tries to set any read-only properties. + */ + set(properties: Interfaces.IndexUpdateData, options?: OfficeExtension.UpdateOptions): void; + /** Sets multiple properties on the object at the same time, based on an existing loaded object. */ + set(properties: Word.Index): void; + /** + * Deletes this index. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + 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?: Word.Interfaces.IndexLoadOptions): Word.Index; + /** + * 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[]): Word.Index; + /** + * 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; + }): Word.Index; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.Index; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.Index; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.Index` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.IndexData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.IndexData; + } + /** + * A collection of {@link Word.Index} objects that represents all the indexes in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class IndexCollection 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: Word.Index[]; + /** + * Returns an `Index` object that represents a new index added to the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param range The range where you want the index to appear. The index replaces the range, if the range is not collapsed. + * @param indexAddOptions Optional. The options for adding the index. + */ + add(range: Word.Range, indexAddOptions?: Word.IndexAddOptions): Word.Index; + /** + * Gets the `IndexFormat` value that represents the formatting for the indexes in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + getFormat(): OfficeExtension.ClientResult; + /** + * Gets an `Index` object by its index in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index A number that identifies the index location of an `Index` object. + */ + getItem(index: number): Word.Index; + /** + * Inserts an {@link https://support.microsoft.com/office/abaf7c78-6e21-418d-bf8b-f8186d2e4d08 | XE (Index Entry) field} after all instances of the text in the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param range The range whose text is marked with an `XE` field throughout the document. + * @param markAllEntriesOptions Optional. The options for marking all entries. + */ + markAllEntries(range: Word.Range, markAllEntriesOptions?: Word.IndexMarkAllEntriesOptions): 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?: Word.Interfaces.IndexCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.IndexCollection; + /** + * 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[]): Word.IndexCollection; + /** + * 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): Word.IndexCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.IndexCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.IndexCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.IndexCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.IndexCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.IndexCollectionData; + } + /** + * Represents options for creating an index in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface IndexAddOptions { + /** + * If provided, specifies the text between alphabetical groups (entries that start with the same letter) in the index. + See `HeadingSeparator` for available values. The default value is `Word.HeadingSeparator.blankLine`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + headingSeparator?: Word.HeadingSeparator | "None" | "BlankLine" | "Letter" | "LetterLow" | "LetterFull"; + /** + * If provided, specifies the sorting language to be used for the index being added. + See `LanguageId` for available values. The default value is the installed language of the Word application. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + indexLanguage?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + /** + * If provided, specifies the number of columns for each page of the index. + Specifying 0 (zero) sets the number of columns in the index to the same number as in the document. The default value is 1. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numberOfColumns?: number; + /** + * If provided, specifies whether the page numbers in the generated index are aligned with the right margin. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + rightAlignPageNumbers?: boolean; + /** + * If provided, specifies whether to include separate headings for accented letters in the index. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + separateAccentedLetterHeadings?: boolean; + /** + * If provided, specifies the sorting criteria to be used for the index being added. Can be either of the following `IndexSortBy` values: `stroke` or `syllable`. The default value is `Word.IndexSortBy.stroke`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sortBy?: Word.IndexSortBy | "Stroke" | "Syllable"; + /** + * If provided, specifies whether subentries are on the same line (run-in) as the main entry or on a separate line (indented) from the main entry. + Can be either of the following `IndexType` values: `indent` or `runin`. The default value is `Word.IndexType.indent`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type?: Word.IndexType | "Indent" | "Runin"; + } + /** + * Represents options for marking all index entries in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface IndexMarkAllEntriesOptions { + /** + * If provided, specifies whether to add bold formatting to page numbers for index entries. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bold?: boolean; + /** + * If provided, specifies the bookmark name that marks the range of pages you want to appear in the index. If this property is omitted, the number of the page that contains the `XE` field appears in the index. The default value is "". + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bookmarkName?: string; + /** + * If provided, specifies the cross-reference that will appear in the index. The default value is "". + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + crossReference?: string; + /** + * If provided, specifies the name of the `AutoText` entry that contains the text for a cross-reference (if this property is specified, `crossReference` is ignored). The default value is "". + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + crossReferenceAutoText?: string; + /** + * If provided, specifies the text you want to appear in the index, in the form `MainEntry[:Subentry]`. The default value is "". + Either this property or `entryAutoText` must be provided. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + entry?: string; + /** + * If provided, specifies the `AutoText` entry that contains the text you want to appear in the index (if this property is specified, `entry` is ignored). The default value is "". + Either this property or `entry` must be provided. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + entryAutoText?: string; + /** + * If provided, specifies whether to add italic formatting to page numbers for index entries. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + italic?: boolean; + } + /** + * Represents options for marking an index entry in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface IndexMarkEntryOptions { + /** + * If provided, specifies whether to add bold formatting to page numbers for index entries. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bold?: boolean; + /** + * If provided, specifies the bookmark name that marks the range of pages you want to appear in the index. If this property is omitted, the number of the page that contains the `XE` field appears in the index. The default value is "". + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bookmarkName?: string; + /** + * If provided, specifies the cross-reference that will appear in the index. The default value is "". + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + crossReference?: string; + /** + * If provided, specifies the name of the `AutoText` entry that contains the text for a cross-reference (if this property is specified, `crossReference` is ignored). The default value is "". + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + crossReferenceAutoText?: string; + /** + * If provided, specifies the text you want to appear in the index, in the form `MainEntry[:Subentry]`. The default value is "". + Either this property or `entryAutoText` must be provided. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + entry?: string; + /** + * If provided, specifies the `AutoText` entry that contains the text you want to appear in the index (if this property is specified, `entry` is ignored). The default value is "". + Either this property or `entry` must be provided. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + entryAutoText?: string; + /** + * If provided, specifies whether to add italic formatting to page numbers for index entries. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + italic?: boolean; + /** + * If provided, specifies whether to show an index entry in the right location when indexes are sorted phonetically (East Asian languages only). The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + reading?: boolean; + } + /** + * Specifies the type of separator to use for headings. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum HeadingSeparator { + /** + * No separator is used for headings. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + none = "None", + /** + * A blank line is used as a separator for headings. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + blankLine = "BlankLine", + /** + * A single letter is used as a separator for headings. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + letter = "Letter", + /** + * A lowercase letter is used as a separator for headings. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + letterLow = "LetterLow", + /** + * A full-width letter is used as a separator for headings. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + letterFull = "LetterFull", + } + /** + * Represents the position of a dropped capital letter. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum DropPosition { + /** + * Represents that there's no dropped capital letter. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + none = "None", + /** + * Represents a normal dropped capital letter. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + normal = "Normal", + /** + * Represents a dropped capital letter in the margin. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + margin = "Margin", + } + /** + * Represents the type of line spacing. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum LineSpacing { + /** + * Represents single line spacing. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + single = "Single", + /** + * Represents 1.5 line spacing. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + onePt5 = "OnePt5", + /** + * Represents double line spacing. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + double = "Double", + /** + * Represents at least line spacing. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + atLeast = "AtLeast", + /** + * Represents exact line spacing. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + exactly = "Exactly", + /** + * Represents multiple line spacing. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + multiple = "Multiple", + } + /** + * Represents the alignment of a tab stop. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum TabAlignment { + /** + * Represents that the tab stop is aligned to the left. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + left = "Left", + /** + * Represents that the tab stop is aligned to the center. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + center = "Center", + /** + * Represents that the tab stop is aligned to the right. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + right = "Right", + /** + * Represents that the tab stop is aligned to the decimal point. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + decimal = "Decimal", + /** + * Represents that the tab stop is aligned to the bar. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bar = "Bar", + /** + * Represents that the tab stop is aligned to the list. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list = "List", + } + /** + * Represents the type of tight wrap for a text box. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum TextboxTightWrap { + /** + * Represents that there's no tight wrap. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + none = "None", + /** + * Represents tight wrap around all lines. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + all = "All", + /** + * Represents tight wrap around the first and last lines. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + firstAndLastLines = "FirstAndLastLines", + /** + * Represents tight wrap around the first line only. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + firstLineOnly = "FirstLineOnly", + /** + * Represents tight wrap around the last line only. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lastLineOnly = "LastLineOnly", + } + /** + * Specifies the filter type for an index. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum IndexFilter { + /** + * No filter is applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + none = "None", + /** + * Aiueo filter is applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + aiueo = "Aiueo", + /** + * Akasatana filter is applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + akasatana = "Akasatana", + /** + * Chosung filter is applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + chosung = "Chosung", + /** + * Low filter is applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + low = "Low", + /** + * Medium filter is applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + medium = "Medium", + /** + * Full filter is applied. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + full = "Full", + } + /** + * Specifies the format for an index. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum IndexFormat { + /** + * Template format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + template = "Template", + /** + * Classic format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + classic = "Classic", + /** + * Fancy format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fancy = "Fancy", + /** + * Modern format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + modern = "Modern", + /** + * Bulleted format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bulleted = "Bulleted", + /** + * Formal format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + formal = "Formal", + /** + * Simple format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + simple = "Simple", + } + /** + * Specifies how an index is sorted. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum IndexSortBy { + /** + * Sort by stroke. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + stroke = "Stroke", + /** + * Sort by syllable. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + syllable = "Syllable", + } + /** + * Specifies the type of index to create. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum IndexType { + /** + * Creates an indented index. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + indent = "Indent", + /** + * Creates a run-in index. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + runin = "Runin", + } + /** + * Specifies the tab leader style. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum TabLeader { + /** + * Spaces are used as the tab leader. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + spaces = "Spaces", + /** + * Dots are used as the tab leader. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + dots = "Dots", + /** + * Dashes are used as the tab leader. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + dashes = "Dashes", + /** + * Lines are used as the tab leader. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lines = "Lines", + /** + * Heavy lines are used as the tab leader. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + heavy = "Heavy", + /** + * Middle dots are used as the tab leader. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + middleDot = "MiddleDot", + } + /** + * Specifies the area of a table to which to apply special style formatting. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ConditionCode { + /** + * Applies formatting to the first row in a table. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + firstRow = "FirstRow", + /** + * Applies formatting to the last row in a table. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lastRow = "LastRow", + /** + * Applies formatting to odd-numbered rows. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + oddRowBanding = "OddRowBanding", + /** + * Applies formatting to even-numbered rows. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + evenRowBanding = "EvenRowBanding", + /** + * Applies formatting to the first column in a table. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + firstColumn = "FirstColumn", + /** + * Applies formatting to the last column in a table. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lastColumn = "LastColumn", + /** + * Applies formatting to odd-numbered columns. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + oddColumnBanding = "OddColumnBanding", + /** + * Applies formatting to even-numbered columns. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + evenColumnBanding = "EvenColumnBanding", + /** + * Applies formatting to the last cell in the first row. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + topRightCell = "TopRightCell", + /** + * Applies formatting to the first cell in the first row. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + topLeftCell = "TopLeftCell", + /** + * Applies formatting to the last cell in the table. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bottomRightCell = "BottomRightCell", + /** + * Applies formatting to first cell in the last row of the table. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bottomLeftCell = "BottomLeftCell", + } + /** + * Specifies a range of cells to be deleted from a table in a delete cells action or the behavior of the remaining cells after the deletion has occurred. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum DeleteCells { + /** + * Shift remaining cells left in the row where the deletion occurred after a cell or range of cells has been deleted. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shiftLeft = "ShiftLeft", + /** + * Shift remaining cells up in the column where the deletion occurred after a cell or range of cells has been deleted. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shiftUp = "ShiftUp", + /** + * Delete the entire row of cells from the table. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + entireRow = "EntireRow", + /** + * Delete the entire column of cells from the table. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + entireColumn = "EntireColumn", + } + /** + * Specifies the rule for determining the height of the specified cells or rows. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum RowHeightRule { + /** + * The row height is adjusted to accommodate the tallest value in the row. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + auto = "Auto", + /** + * The row height is set to a minimum value. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + atLeast = "AtLeast", + /** + * The row height is set to an exact value. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + exactly = "Exactly", + } + /** + * Specifies the direction in which Microsoft Word orders cells in the specified table or row. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum TableDirection { + /** + * The table is arranged with the first column in the rightmost position. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + rightToLeft = "RightToLeft", + /** + * The table is arranged with the first column in the leftmost position. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + leftToRight = "LeftToRight", + } + /** + * Specifies the character used to separate fields in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum TableFieldSeparator { + /** + * Uses the paragraph marker. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + paragraph = "Paragraph", + /** + * Uses the tab. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tab = "Tab", + /** + * Uses the comma. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + comma = "Comma", + /** + * Uses the default list separator. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + defaultListSeparator = "DefaultListSeparator", + } + /** + * Specifies the table format to apply. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum TableFormatType { + /** + * Applies no formatting to the table. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + none = "None", + /** + * Applies the Simple1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + simple1 = "Simple1", + /** + * Applies the Simple2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + simple2 = "Simple2", + /** + * Applies the Simple3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + simple3 = "Simple3", + /** + * Applies the Classic1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + classic1 = "Classic1", + /** + * Applies the Classic2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + classic2 = "Classic2", + /** + * Applies the Classic3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + classic3 = "Classic3", + /** + * Applies the Classic4 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + classic4 = "Classic4", + /** + * Applies the Colorful1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + colorful1 = "Colorful1", + /** + * Applies the Colorful2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + colorful2 = "Colorful2", + /** + * Applies the Colorful3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + colorful3 = "Colorful3", + /** + * Applies the Columns1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + columns1 = "Columns1", + /** + * Applies the Columns2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + columns2 = "Columns2", + /** + * Applies the Columns3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + columns3 = "Columns3", + /** + * Applies the Columns4 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + columns4 = "Columns4", + /** + * Applies the Columns5 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + columns5 = "Columns5", + /** + * Applies the Grid1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid1 = "Grid1", + /** + * Applies the Grid2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid2 = "Grid2", + /** + * Applies the Grid3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid3 = "Grid3", + /** + * Applies the Grid4 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid4 = "Grid4", + /** + * Applies the Grid5 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid5 = "Grid5", + /** + * Applies the Grid6 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid6 = "Grid6", + /** + * Applies the Grid7 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid7 = "Grid7", + /** + * Applies the Grid8 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grid8 = "Grid8", + /** + * Applies the List1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list1 = "List1", + /** + * Applies the List2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list2 = "List2", + /** + * Applies the List3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list3 = "List3", + /** + * Applies the List4 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list4 = "List4", + /** + * Applies the List5 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list5 = "List5", + /** + * Applies the List6 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list6 = "List6", + /** + * Applies the List7 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list7 = "List7", + /** + * Applies the List8 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list8 = "List8", + /** + * Applies the 3D Effects1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + threeDEffects1 = "ThreeDEffects1", + /** + * Applies the 3D Effects2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + threeDEffects2 = "ThreeDEffects2", + /** + * Applies the 3D Effects3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + threeDEffects3 = "ThreeDEffects3", + /** + * Applies the Contemporary table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + contemporary = "Contemporary", + /** + * Applies the Elegant table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + elegant = "Elegant", + /** + * Applies the Professional table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + professional = "Professional", + /** + * Applies the Subtle1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + subtle1 = "Subtle1", + /** + * Applies the Subtle2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + subtle2 = "Subtle2", + /** + * Applies the Web1 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + web1 = "Web1", + /** + * Applies the Web2 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + web2 = "Web2", + /** + * Applies the Web3 table format. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + web3 = "Web3", + } + /** + * Represents the options for the {@link Word.Table | Table.autoFormat} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface TableAutoFormatOptions { + /** + * If provided, specifies whether to apply borders of the specified format. The default value is `true`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + applyBorders?: boolean; + /** + * If provided, specifies whether to apply color of the specified format. The default value is `true`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + applyColor?: boolean; + /** + * If provided, specifies whether to apply first column formatting of the specified format. The default value is `true`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + applyFirstColumn?: boolean; + /** + * If provided, specifies whether to apply font of the specified format. The default value is `true`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + applyFont?: boolean; + /** + * If provided, specifies whether to apply heading row formatting of the specified format. The default value is `true`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + applyHeadingRows?: boolean; + /** + * If provided, specifies whether to apply last column formatting of the specified format. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + applyLastColumn?: boolean; + /** + * If provided, specifies whether to apply last row formatting of the specified format. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + applyLastRow?: boolean; + /** + * If provided, specifies whether to apply shading of the specified format. The default value is `true`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + applyShading?: boolean; + /** + * If provided, specifies whether to decrease the width of the table columns as much as possible without changing the way text wraps in the cells. The default value is `true`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + autoFit?: boolean; + /** + * If provided, specifies the format to apply. The default value is `simple1`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + format?: Word.TableFormatType | "None" | "Simple1" | "Simple2" | "Simple3" | "Classic1" | "Classic2" | "Classic3" | "Classic4" | "Colorful1" | "Colorful2" | "Colorful3" | "Columns1" | "Columns2" | "Columns3" | "Columns4" | "Columns5" | "Grid1" | "Grid2" | "Grid3" | "Grid4" | "Grid5" | "Grid6" | "Grid7" | "Grid8" | "List1" | "List2" | "List3" | "List4" | "List5" | "List6" | "List7" | "List8" | "ThreeDEffects1" | "ThreeDEffects2" | "ThreeDEffects3" | "Contemporary" | "Elegant" | "Professional" | "Subtle1" | "Subtle2" | "Web1" | "Web2" | "Web3"; + } + /** + * Represents the options for the {@link Word.TableCellCollection | TableCellCollection.split} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface TableCellCollectionSplitOptions { + /** + * If provided, specifies whether to merge the cells with one another before splitting them. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + mergeBeforeSplit?: boolean; + /** + * If provided, specifies the number of columns that the group of cells is to be split into. The default value is 1. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numColumns?: number; + /** + * If provided, specifies the number of rows that the group of cells is to be split into. The default value is 1. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numRows?: number; + } + /** + * Represents the options for the {@link Word.TableCell | TableCell.formula} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface TableCellFormulaOptions { + /** + * The mathematical formula you want the = (Formula) field to evaluate. Spreadsheet-type references to table cells are valid. For example, "=SUM(A4:C4)" specifies the first three values in the fourth row. For more information about the = (Formula) field, see {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | Field codes: = (Formula) field}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + formula?: string; + /** + * A format for the result of the {@link https://support.microsoft.com/office/32d5c9de-3516-4ec3-80ed-d1fc2b5bc21d | = (Formula) field}. For information about the types of formats you can apply, see the Numeric Picture (#) field switch. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numFormat?: string; + } + /** + * Represents the options for the {@link Word.Table | Table.convertToText}, {@link Word.TableRow | TableRow.convertToText}, and {@link Word.TableRowCollection | TableRowCollection.convertToText} methods. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface TableConvertToTextOptions { + /** + * If provided, specifies whether to convert the nested tables to text. This property is ignored if the `separator` property isn't set to `paragraph`. The default is `true`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nestedTables?: boolean; + /** + * If provided, specifies the character that delimits the converted columns (paragraph marks delimit the converted rows). The default is `tab`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + separator?: Word.TableFieldSeparator | "Paragraph" | "Tab" | "Comma" | "DefaultListSeparator"; + } + /** + * Represents the options for the {@link Word.Table | Table.sort} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface TableSortOptions { + /** + * If provided, specifies whether to use bidirectional sort. `true` means to sort based on right-to-left language rules. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bidirectionalSort?: boolean; + /** + * If provided, specifies whether sorting is case-sensitive. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + caseSensitive?: boolean; + /** + * If provided, specifies whether to exclude the header row from the sort operation. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + excludeHeader?: boolean; + /** + * If provided, specifies the first field to sort by. Microsoft Word sorts by `fieldNumber`, then by `fieldNumber2`, and finally by `fieldNumber3`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fieldNumber?: string; + /** + * If provided, specifies the second field to sort by. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fieldNumber2?: string; + /** + * If provided, specifies the third field to sort by. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fieldNumber3?: string; + /** + * If provided, specifies whether to ignore Arabic character alef lam when sorting right-to-left language text. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + ignoreArabicThe?: boolean; + /** + * If provided, specifies whether to ignore bidirectional control characters when sorting right-to-left language text. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + ignoreDiacritics?: boolean; + /** + * If provided, specifies whether to ignore Hebrew characters when sorting right-to-left language text. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + ignoreHebrew?: boolean; + /** + * If provided, specifies whether to ignore kashida when sorting right-to-left language text. This property may not be available to you, depending on the language support (U.S. English, for example) that you have selected or installed. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + ignoreKashida?: boolean; + /** + * If provided, specifies the sorting language. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + /** + * If provided, specifies the type of the first field to sort by. The default value is `alphanumeric`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sortFieldType?: Word.SortFieldType | "Alphanumeric" | "Numeric" | "Date" | "Syllable" | "JapanJis" | "Stroke" | "KoreaKs"; + /** + * If provided, specifies the type of the second field to sort by. The default value is `alphanumeric`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sortFieldType2?: Word.SortFieldType | "Alphanumeric" | "Numeric" | "Date" | "Syllable" | "JapanJis" | "Stroke" | "KoreaKs"; + /** + * If provided, specifies the type of the third field to sort by. The default value is `alphanumeric`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sortFieldType3?: Word.SortFieldType | "Alphanumeric" | "Numeric" | "Date" | "Syllable" | "JapanJis" | "Stroke" | "KoreaKs"; + /** + * If provided, specifies the sort order of the first field to sort by. The default value is `ascending`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sortOrder?: Word.SortOrder | "Ascending" | "Descending"; + /** + * If provided, specifies the sort order of the second field to sort by. The default value is `ascending`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sortOrder2?: Word.SortOrder | "Ascending" | "Descending"; + /** + * If provided, specifies the sort order of the third field to sort by. The default value is `ascending`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sortOrder3?: Word.SortOrder | "Ascending" | "Descending"; + } + /** + * Represents a list of the names of all the available fonts. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class FontNameCollection 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 number of items in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + getCount(): OfficeExtension.ClientResult; + /** + * Gets the font name at the specified index. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index The zero-based index of the font name to retrieve. + */ + getItemAt(index: number): OfficeExtension.ClientResult; + /** + * 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[]): Word.FontNameCollection; + /** + * 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; + }): Word.FontNameCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.FontNameCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.FontNameCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.FontNameCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.FontNameCollectionData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): { + [key: string]: string; + }; + } + /** + * Contains a collection of {@link Word.ListTemplate} objects in a document, list template gallery, or document template. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class ListTemplateCollection 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: Word.ListTemplate[]; + /** + * Adds a new `ListTemplate` object. Note: This operation isn't allowed if the collection represents list templates from a {@link Word.ListTemplateGallery}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param options Optional. Options for adding a new list template. + */ + add(options?: Word.ListTemplateCollectionAddOptions): Word.ListTemplate; + /** + * Gets a `ListTemplate` object by its index in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index A number that identifies the index location of a `ListTemplate` object. + */ + getItem(index: number): Word.ListTemplate; + /** + * 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?: Word.Interfaces.ListTemplateCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.ListTemplateCollection; + /** + * 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[]): Word.ListTemplateCollection; + /** + * 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): Word.ListTemplateCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.ListTemplateCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.ListTemplateCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ListTemplateCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListTemplateCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.ListTemplateCollectionData; + } + /** + * Represents the options for the {@link Word.ListTemplateCollection | ListTemplateCollection.add} method. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface ListTemplateCollectionAddOptions { + /** + * If provided, specifies the name of the list template to be added. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + name?: string; + /** + * If provided, specifies whether to apply outline numbering to the new list template. The default value is `false`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + outlineNumbered?: boolean; + } + /** + * Represents a gallery of list templates of the same {@link Word.ListTemplateGalleryType}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class ListTemplateGallery 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 `ListTemplateCollection` object that represents all the list templates for the specified list gallery. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + readonly listTemplates: Word.ListTemplateCollection; + /** + * 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[]): Word.ListTemplateGallery; + /** + * 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; + }): Word.ListTemplateGallery; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.ListTemplateGallery; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.ListTemplateGallery; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ListTemplateGallery` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListTemplateGalleryData`) that contains shallow copies of any loaded child properties from the original object. + */ + toJSON(): Word.Interfaces.ListTemplateGalleryData; + } + /** + * Contains a collection of {@link Word.ListTemplateGallery} objects available through the three bullets-and-numbering buttons on the **Home** tab (see {@link https://support.microsoft.com/office/6c06ef65-27ad-4893-80c9-0b944cb81f5f | Define new bullets, numbers, and multilevel lists} for how to access in the Word UI). + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + class ListTemplateGalleryCollection 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: Word.ListTemplateGallery[]; + /** + * Gets a `ListTemplateGallery` object by its type in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param type The type of list template gallery to retrieve. + */ + getByType(type: Word.ListTemplateGalleryType): Word.ListTemplateGallery; + /** + * Gets a `ListTemplateGallery` object by its type in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param type The type of list template gallery to retrieve. + */ + getByType(type: "Bullets" | "Number" | "OutlineNumbered"): Word.ListTemplateGallery; + /** + * Gets a `ListTemplateGallery` object by its index in the collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + * + * @param index A number that identifies the index location of a `ListTemplateGallery` object. + */ + getItem(index: number): Word.ListTemplateGallery; + /** + * 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[]): Word.ListTemplateGalleryCollection; + /** + * 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): Word.ListTemplateGalleryCollection; + /** + * Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.add(thisObject)}. If you're using this object across `.sync` calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection. + */ + track(): Word.ListTemplateGalleryCollection; + /** + * Release the memory associated with this object, if it has previously been tracked. This call is shorthand for {@link https://learn.microsoft.com/javascript/api/office/officeextension.clientrequestcontext#office-officeextension-clientrequestcontext-trackedobjects-member | context.trackedObjects.remove(thisObject)}. Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call `context.sync()` before the memory release takes effect. + */ + untrack(): Word.ListTemplateGalleryCollection; + /** + * Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`. (`JSON.stringify`, in turn, calls the `toJSON` method of the object that's passed to it.) + * Whereas the original `Word.ListTemplateGalleryCollection` object is an API object, the `toJSON` method returns a plain JavaScript object (typed as `Word.Interfaces.ListTemplateGalleryCollectionData`) that contains an "items" array with shallow copies of any loaded properties from the collection's items. + */ + toJSON(): Word.Interfaces.ListTemplateGalleryCollectionData; + } + /** + * Describes the types of list template galleries available. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum ListTemplateGalleryType { + /** + * Represents the bullet list gallery. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bullets = "Bullets", + /** + * Represents the number list gallery. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + number = "Number", + /** + * Represents the outline number list gallery. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + outlineNumbered = "OutlineNumbered", + } + /** + * Represents the types of {@link Word.CoauthoringLock | coauthoring locks}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum CoauthoringLockType { + /** + * Reserved for future use. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + none = "None", + /** + * Represents that the lock is a reservation. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + reservation = "Reservation", + /** + * Represents that the lock is ephemeral. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + ephemeral = "Ephemeral", + /** + * Represents that the lock has changed. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + changed = "Changed", + } + /** + * Represents the classes of users who can edit authorized portions of a protected (read-only) document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + enum EditorType { + /** + * Represents the current user of the document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + current = "Current", + /** + * Represents the Editors group for documents that use Information Rights Management. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + editors = "Editors", + /** + * Represents all users who open a document. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + everyone = "Everyone", + /** + * Represents the Owners group for documents that use Information Rights Management. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + owners = "Owners", + } + enum ErrorCodes { + accessDenied = "AccessDenied", + generalException = "GeneralException", + invalidArgument = "InvalidArgument", + itemNotFound = "ItemNotFound", + notAllowed = "NotAllowed", + notImplemented = "NotImplemented", + searchDialogIsOpen = "SearchDialogIsOpen", + searchStringInvalidOrTooLong = "SearchStringInvalidOrTooLong", + } + namespace Interfaces { + /** + * Provides ways to load properties of only a subset of members of a collection. + */ + 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 `Editor` object, for use in `editor.set({ ... })`. */ + interface EditorUpdateData { + /** + * Gets a `Range` object that represents the next range that the editor has permissions to modify. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nextRange?: Word.Interfaces.RangeUpdateData; + /** + * Gets a `Range` object that represents the portion of the document that's contained in the `Editor` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeUpdateData; + } + /** An interface for updating data on the `ConflictCollection` object, for use in `conflictCollection.set({ ... })`. */ + interface ConflictCollectionUpdateData { + items?: Word.Interfaces.ConflictData[]; + } + /** An interface for updating data on the `Conflict` object, for use in `conflict.set({ ... })`. */ + interface ConflictUpdateData { + /** + * Gets a `Range` object that represents the portion of the document that's contained in the `Conflict` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeUpdateData; + } + /** An interface for updating data on the `AnnotationCollection` object, for use in `annotationCollection.set({ ... })`. */ + interface AnnotationCollectionUpdateData { + items?: Word.Interfaces.AnnotationData[]; + } + /** An interface for updating data on the `Application` object, for use in `application.set({ ... })`. */ + interface ApplicationUpdateData { + /** + * Returns a `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bibliography?: Word.Interfaces.BibliographyUpdateData; + /** + * Specifies if Microsoft Word automatically detects the language you are using as you type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + checkLanguage?: boolean; + } + /** An interface for updating data on the `Body` object, for use in `body.set({ ... })`. */ + interface BodyUpdateData { + /** + * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ + font?: Word.Interfaces.FontUpdateData; + /** + * Specifies the style name for the body. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * + * @remarks + * [Api set: WordApi 1.1] + */ + style?: string; + /** + * Specifies the built-in style name for the body. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + } + /** An interface for updating data on the `Border` object, for use in `border.set({ ... })`. */ + interface BorderUpdateData { + /** + * Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + color?: string; + /** + * Specifies the border type for the border. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + type?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + /** + * Specifies whether the border is visible. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + visible?: boolean; + /** + * Specifies the width for the border. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + width?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed"; + } + /** An interface for updating data on the `BorderUniversal` object, for use in `borderUniversal.set({ ... })`. */ + interface BorderUniversalUpdateData { + /** + * Specifies the graphical page-border design for the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + artStyle?: Word.PageBorderArt | "Apples" | "MapleMuffins" | "CakeSlice" | "CandyCorn" | "IceCreamCones" | "ChampagneBottle" | "PartyGlass" | "ChristmasTree" | "Trees" | "PalmsColor" | "Balloons3Colors" | "BalloonsHotAir" | "PartyFavor" | "ConfettiStreamers" | "Hearts" | "HeartBalloon" | "Stars3D" | "StarsShadowed" | "Stars" | "Sun" | "Earth2" | "Earth1" | "PeopleHats" | "Sombrero" | "Pencils" | "Packages" | "Clocks" | "Firecrackers" | "Rings" | "MapPins" | "Confetti" | "CreaturesButterfly" | "CreaturesLadyBug" | "CreaturesFish" | "BirdsFlight" | "ScaredCat" | "Bats" | "FlowersRoses" | "FlowersRedRose" | "Poinsettias" | "Holly" | "FlowersTiny" | "FlowersPansy" | "FlowersModern2" | "FlowersModern1" | "WhiteFlowers" | "Vine" | "FlowersDaisies" | "FlowersBlockPrint" | "DecoArchColor" | "Fans" | "Film" | "Lightning1" | "Compass" | "DoubleD" | "ClassicalWave" | "ShadowedSquares" | "TwistedLines1" | "Waveline" | "Quadrants" | "CheckedBarColor" | "Swirligig" | "PushPinNote1" | "PushPinNote2" | "Pumpkin1" | "EggsBlack" | "Cup" | "HeartGray" | "GingerbreadMan" | "BabyPacifier" | "BabyRattle" | "Cabins" | "HouseFunky" | "StarsBlack" | "Snowflakes" | "SnowflakeFancy" | "Skyrocket" | "Seattle" | "MusicNotes" | "PalmsBlack" | "MapleLeaf" | "PaperClips" | "ShorebirdTracks" | "People" | "PeopleWaving" | "EclipsingSquares2" | "Hypnotic" | "DiamondsGray" | "DecoArch" | "DecoBlocks" | "CirclesLines" | "Papyrus" | "Woodwork" | "WeavingBraid" | "WeavingRibbon" | "WeavingAngles" | "ArchedScallops" | "Safari" | "CelticKnotwork" | "CrazyMaze" | "EclipsingSquares1" | "Birds" | "FlowersTeacup" | "Northwest" | "Southwest" | "Tribal6" | "Tribal4" | "Tribal3" | "Tribal2" | "Tribal5" | "XIllusions" | "ZanyTriangles" | "Pyramids" | "PyramidsAbove" | "ConfettiGrays" | "ConfettiOutline" | "ConfettiWhite" | "Mosaic" | "Lightning2" | "HeebieJeebies" | "LightBulb" | "Gradient" | "TriangleParty" | "TwistedLines2" | "Moons" | "Ovals" | "DoubleDiamonds" | "ChainLink" | "Triangles" | "Tribal1" | "MarqueeToothed" | "SharksTeeth" | "Sawtooth" | "SawtoothGray" | "PostageStamp" | "WeavingStrips" | "ZigZag" | "CrossStitch" | "Gems" | "CirclesRectangles" | "CornerTriangles" | "CreaturesInsects" | "ZigZagStitch" | "Checkered" | "CheckedBarBlack" | "Marquee" | "BasicWhiteDots" | "BasicWideMidline" | "BasicWideOutline" | "BasicWideInline" | "BasicThinLines" | "BasicWhiteDashes" | "BasicWhiteSquares" | "BasicBlackSquares" | "BasicBlackDashes" | "BasicBlackDots" | "StarsTop" | "CertificateBanner" | "Handmade1" | "Handmade2" | "TornPaper" | "TornPaperBlack" | "CouponCutoutDashes" | "CouponCutoutDots"; + /** + * Specifies the width (in points) of the graphical page border specified in the `artStyle` property. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + artWidth?: number; + /** + * Specifies the color for the `BorderUniversal` object. You can provide the value in the '#RRGGBB' format. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + color?: string; + /** + * Specifies the color for the `BorderUniversal` or {@link Word.Font} object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + colorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + /** + * Specifies whether the border is visible. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isVisible?: boolean; + /** + * Specifies the line style of the border. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lineStyle?: Word.BorderLineStyle | "None" | "Single" | "Dot" | "DashSmallGap" | "DashLargeGap" | "DashDot" | "DashDotDot" | "Double" | "Triple" | "ThinThickSmallGap" | "ThickThinSmallGap" | "ThinThickThinSmallGap" | "ThinThickMedGap" | "ThickThinMedGap" | "ThinThickThinMedGap" | "ThinThickLargeGap" | "ThickThinLargeGap" | "ThinThickThinLargeGap" | "SingleWavy" | "DoubleWavy" | "DashDotStroked" | "Emboss3D" | "Engrave3D" | "Outset" | "Inset"; + /** + * Specifies the line width of an object's border. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lineWidth?: Word.LineWidth | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600"; + } + /** An interface for updating data on the `BorderCollection` object, for use in `borderCollection.set({ ... })`. */ + interface BorderCollectionUpdateData { + /** + * Specifies the 24-bit color of the inside borders. Color is specified in ‘#RRGGBB’ format or by using the color name. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + insideBorderColor?: string; + /** + * Specifies the border type of the inside borders. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + insideBorderType?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + /** + * Specifies the width of the inside borders. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + insideBorderWidth?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed"; + /** + * Specifies the 24-bit color of the outside borders. Color is specified in ‘#RRGGBB’ format or by using the color name. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + outsideBorderColor?: string; + /** + * Specifies the border type of the outside borders. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + outsideBorderType?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + /** + * Specifies the width of the outside borders. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + outsideBorderWidth?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed"; + items?: Word.Interfaces.BorderData[]; + } + /** An interface for updating data on the `BorderUniversalCollection` object, for use in `borderUniversalCollection.set({ ... })`. */ + interface BorderUniversalCollectionUpdateData { + items?: Word.Interfaces.BorderUniversalData[]; + } + /** An interface for updating data on the `Break` object, for use in `break.set({ ... })`. */ + interface BreakUpdateData { + /** + * Returns a `Range` object that represents the portion of the document that's contained in the break. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeUpdateData; + } + /** An interface for updating data on the `BreakCollection` object, for use in `breakCollection.set({ ... })`. */ + interface BreakCollectionUpdateData { + items?: Word.Interfaces.BreakData[]; + } + /** An interface for updating data on the `BuildingBlock` object, for use in `buildingBlock.set({ ... })`. */ + interface BuildingBlockUpdateData { + /** + * Specifies the description for the building block. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + description?: string; + /** + * Specifies a `DocPartInsertType` value that represents how to insert the contents of the building block into the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + insertType?: Word.DocPartInsertType | "Content" | "Paragraph" | "Page"; + /** + * Specifies the name of the building block. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + name?: string; + /** + * Specifies the contents of the building block. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + value?: string; + } + /** An interface for updating data on the `CheckboxContentControl` object, for use in `checkboxContentControl.set({ ... })`. */ + interface CheckboxContentControlUpdateData { + /** + * Specifies the current state of the checkbox. + * + * @remarks + * [Api set: WordApi 1.7] + */ + isChecked?: boolean; + } + /** An interface for updating data on the `CoauthoringLock` object, for use in `coauthoringLock.set({ ... })`. */ + interface CoauthoringLockUpdateData { + /** + * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringLock` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeUpdateData; + } + /** An interface for updating data on the `CoauthoringLockCollection` object, for use in `coauthoringLockCollection.set({ ... })`. */ + interface CoauthoringLockCollectionUpdateData { + items?: Word.Interfaces.CoauthoringLockData[]; + } + /** An interface for updating data on the `CoauthorCollection` object, for use in `coauthorCollection.set({ ... })`. */ + interface CoauthorCollectionUpdateData { + items?: Word.Interfaces.CoauthorData[]; + } + /** An interface for updating data on the `CoauthoringUpdate` object, for use in `coauthoringUpdate.set({ ... })`. */ + interface CoauthoringUpdateUpdateData { + /** + * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringUpdate` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeUpdateData; + } + /** An interface for updating data on the `CoauthoringUpdateCollection` object, for use in `coauthoringUpdateCollection.set({ ... })`. */ + interface CoauthoringUpdateCollectionUpdateData { + items?: Word.Interfaces.CoauthoringUpdateData[]; + } + /** An interface for updating data on the `Comment` object, for use in `comment.set({ ... })`. */ + interface CommentUpdateData { + /** + * Specifies the comment's content range. + * + * @remarks + * [Api set: WordApi 1.4] + */ + contentRange?: Word.Interfaces.CommentContentRangeUpdateData; + /** + * Specifies the comment's content as plain text. + * + * @remarks + * [Api set: WordApi 1.4] + */ + content?: string; + /** + * Specifies the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved. + * + * @remarks + * [Api set: WordApi 1.4] + */ + resolved?: boolean; + } + /** An interface for updating data on the `CommentCollection` object, for use in `commentCollection.set({ ... })`. */ + interface CommentCollectionUpdateData { + items?: Word.Interfaces.CommentData[]; + } + /** An interface for updating data on the `CommentContentRange` object, for use in `commentContentRange.set({ ... })`. */ + interface CommentContentRangeUpdateData { + /** + * Specifies a value that indicates whether the comment text is bold. + * + * @remarks + * [Api set: WordApi 1.4] + */ + bold?: boolean; + /** + * Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. + * + * @remarks + * [Api set: WordApi 1.4] + */ + hyperlink?: string; + /** + * Specifies a value that indicates whether the comment text is italicized. + * + * @remarks + * [Api set: WordApi 1.4] + */ + italic?: boolean; + /** + * Specifies a value that indicates whether the comment text has a strikethrough. + * + * @remarks + * [Api set: WordApi 1.4] + */ + strikeThrough?: boolean; + /** + * Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined. + * + * @remarks + * [Api set: WordApi 1.4] + */ + underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; + } + /** An interface for updating data on the `CommentReply` object, for use in `commentReply.set({ ... })`. */ + interface CommentReplyUpdateData { + /** + * Specifies the commentReply's content range. + * + * @remarks + * [Api set: WordApi 1.4] + */ + contentRange?: Word.Interfaces.CommentContentRangeUpdateData; + /** + * Gets the parent comment of this reply. + * + * @remarks + * [Api set: WordApi 1.4] + */ + parentComment?: Word.Interfaces.CommentUpdateData; + /** + * Specifies the comment reply's content. The string is plain text. + * + * @remarks + * [Api set: WordApi 1.4] + */ + content?: string; + } + /** An interface for updating data on the `CommentReplyCollection` object, for use in `commentReplyCollection.set({ ... })`. */ + interface CommentReplyCollectionUpdateData { + items?: Word.Interfaces.CommentReplyData[]; + } + /** An interface for updating data on the `ConditionalStyle` object, for use in `conditionalStyle.set({ ... })`. */ + interface ConditionalStyleUpdateData { + /** + * Specifies the amount of space (in points) to add below the contents of a single cell or all the cells in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bottomPadding?: number; + /** + * Specifies the amount of space (in points) to add to the left of the contents of a single cell or all the cells in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + leftPadding?: number; + /** + * Specifies the amount of space (in points) to add to the right of the contents of a single cell or all the cells in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + rightPadding?: number; + /** + * Specifies the amount of space (in points) to add above the contents of a single cell or all the cells in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + topPadding?: number; + } + /** An interface for updating data on the `XmlMapping` object, for use in `xmlMapping.set({ ... })`. */ + interface XmlMappingUpdateData { + /** + * Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + customXmlNode?: Word.Interfaces.CustomXmlNodeUpdateData; + /** + * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + customXmlPart?: Word.Interfaces.CustomXmlPartUpdateData; + } + /** An interface for updating data on the `CustomXmlPrefixMappingCollection` object, for use in `customXmlPrefixMappingCollection.set({ ... })`. */ + interface CustomXmlPrefixMappingCollectionUpdateData { + items?: Word.Interfaces.CustomXmlPrefixMappingData[]; + } + /** An interface for updating data on the `CustomXmlSchemaCollection` object, for use in `customXmlSchemaCollection.set({ ... })`. */ + interface CustomXmlSchemaCollectionUpdateData { + items?: Word.Interfaces.CustomXmlSchemaData[]; + } + /** An interface for updating data on the `CustomXmlValidationErrorCollection` object, for use in `customXmlValidationErrorCollection.set({ ... })`. */ + interface CustomXmlValidationErrorCollectionUpdateData { + items?: Word.Interfaces.CustomXmlValidationErrorData[]; + } + /** An interface for updating data on the `CustomXmlValidationError` object, for use in `customXmlValidationError.set({ ... })`. */ + interface CustomXmlValidationErrorUpdateData { + /** + * Gets the node associated with this `CustomXmlValidationError` object, if any exist.If no nodes exist, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + node?: Word.Interfaces.CustomXmlNodeUpdateData; + } + /** An interface for updating data on the `CustomXmlNodeCollection` object, for use in `customXmlNodeCollection.set({ ... })`. */ + interface CustomXmlNodeCollectionUpdateData { + items?: Word.Interfaces.CustomXmlNodeData[]; + } + /** An interface for updating data on the `CustomXmlNode` object, for use in `customXmlNode.set({ ... })`. */ + interface CustomXmlNodeUpdateData { + /** + * Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + firstChild?: Word.Interfaces.CustomXmlNodeUpdateData; + /** + * Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lastChild?: Word.Interfaces.CustomXmlNodeUpdateData; + /** + * Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nextSibling?: Word.Interfaces.CustomXmlNodeUpdateData; + /** + * Gets the object representing the part associated with this node. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + ownerPart?: Word.Interfaces.CustomXmlPartUpdateData; + /** + * Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + parentNode?: Word.Interfaces.CustomXmlNodeUpdateData; + /** + * Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + previousSibling?: Word.Interfaces.CustomXmlNodeUpdateData; + /** + * Specifies the value of the current node. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nodeValue?: string; + /** + * Specifies the text for the current node. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + text?: string; + } + /** An interface for updating data on the `ContentControl` object, for use in `contentControl.set({ ... })`. */ + interface ContentControlUpdateData { + /** + * Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `BuildingBlockGallery`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlUpdateData; + /** + * Gets the data of the content control when its type is `CheckBox`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi 1.7] + */ + checkboxContentControl?: Word.Interfaces.CheckboxContentControlUpdateData; + /** + * Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `DatePicker`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + datePickerContentControl?: Word.Interfaces.DatePickerContentControlUpdateData; + /** + * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ + font?: Word.Interfaces.FontUpdateData; + /** + * Gets the group-related data if the content control's {@link Word.ContentControlType} is `Group`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + groupContentControl?: Word.Interfaces.GroupContentControlUpdateData; + /** + * Gets the picture-related data if the content control's {@link Word.ContentControlType} is `Picture`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + pictureContentControl?: Word.Interfaces.PictureContentControlUpdateData; + /** + * Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `RepeatingSection`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlUpdateData; + /** + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + xmlMapping?: Word.Interfaces.XmlMappingUpdateData; + /** + * Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. + * + * @remarks + * [Api set: WordApi 1.1] + */ + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + /** + * Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited. + * + * @remarks + * [Api set: WordApi 1.1] + */ + cannotDelete?: boolean; + /** + * Specifies a value that indicates whether the user can edit the contents of the content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ + cannotEdit?: boolean; + /** + * Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. + * + * @remarks + * [Api set: WordApi 1.1] + */ + color?: string; + /** + * Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. + * + * @remarks + * [Api set: WordApi 1.1] + */ + placeholderText?: string; + /** + * Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. + * + * @remarks + * [Api set: WordApi 1.1] + */ + removeWhenEdited?: boolean; + /** + * Specifies the style name for the content control. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * + * @remarks + * [Api set: WordApi 1.1] + */ + style?: string; + /** + * Specifies the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + /** + * Specifies a tag to identify a content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ + tag?: string; + /** + * Specifies the title for a content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ + title?: string; + } + /** An interface for updating data on the `ContentControlCollection` object, for use in `contentControlCollection.set({ ... })`. */ + interface ContentControlCollectionUpdateData { + items?: Word.Interfaces.ContentControlData[]; + } + /** An interface for updating data on the `ContentControlListItem` object, for use in `contentControlListItem.set({ ... })`. */ + interface ContentControlListItemUpdateData { + /** + * Specifies the display text of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + displayText?: string; + /** + * Specifies the index location of a content control list item in the collection of list items. + * + * @remarks + * [Api set: WordApi 1.9] + */ + index?: number; + /** + * Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + value?: string; + } + /** An interface for updating data on the `ContentControlListItemCollection` object, for use in `contentControlListItemCollection.set({ ... })`. */ + interface ContentControlListItemCollectionUpdateData { + items?: Word.Interfaces.ContentControlListItemData[]; + } + /** An interface for updating data on the `CustomProperty` object, for use in `customProperty.set({ ... })`. */ + interface CustomPropertyUpdateData { + /** + * Specifies the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). + * + * @remarks + * [Api set: WordApi 1.3] + */ + value?: any; + } + /** An interface for updating data on the `CustomPropertyCollection` object, for use in `customPropertyCollection.set({ ... })`. */ + interface CustomPropertyCollectionUpdateData { + items?: Word.Interfaces.CustomPropertyData[]; + } + /** An interface for updating data on the `CustomXmlPart` object, for use in `customXmlPart.set({ ... })`. */ + interface CustomXmlPartUpdateData { + /** + * Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + documentElement?: Word.Interfaces.CustomXmlNodeUpdateData; + } + /** An interface for updating data on the `CustomXmlPartCollection` object, for use in `customXmlPartCollection.set({ ... })`. */ + interface CustomXmlPartCollectionUpdateData { + items?: Word.Interfaces.CustomXmlPartData[]; + } + /** An interface for updating data on the `CustomXmlPartScopedCollection` object, for use in `customXmlPartScopedCollection.set({ ... })`. */ + interface CustomXmlPartScopedCollectionUpdateData { + items?: Word.Interfaces.CustomXmlPartData[]; + } + /** An interface for updating data on the `Document` object, for use in `document.set({ ... })`. */ + interface DocumentUpdateData { + /** + * Gets the active window for the document. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + activeWindow?: Word.Interfaces.WindowUpdateData; + /** + * Returns a `Bibliography` object that represents the bibliography references contained within the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + bibliography?: Word.Interfaces.BibliographyUpdateData; + /** + * Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * + * @remarks + * [Api set: WordApi 1.1] + */ + body?: Word.Interfaces.BodyUpdateData; + /** + * Returns a `PageSetup` object that's associated with the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + pageSetup?: Word.Interfaces.PageSetupUpdateData; + /** + * Gets the properties of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + properties?: Word.Interfaces.DocumentPropertiesUpdateData; + /** + * Specifies if automatic hyphenation is turned on for the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + autoHyphenation?: boolean; + /** + * Specifies if the edits in the document are automatically saved. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + autoSaveOn?: boolean; + /** + * Specifies the ChangeTracking mode. + * + * @remarks + * [Api set: WordApi 1.4] + */ + changeTrackingMode?: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly"; + /** + * Specifies the maximum number of consecutive lines that can end with hyphens. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + consecutiveHyphensLimit?: number; + /** + * Specifies whether words in all capital letters can be hyphenated. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hyphenateCaps?: boolean; + /** + * Specifies whether Microsoft Word has detected the language of the document text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + languageDetected?: boolean; + } + /** An interface for updating data on the `DocumentCreated` object, for use in `documentCreated.set({ ... })`. */ + interface DocumentCreatedUpdateData { + /** + * Gets the body object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.3] + */ + body?: Word.Interfaces.BodyUpdateData; + /** + * Gets the properties of the document. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.3] + */ + properties?: Word.Interfaces.DocumentPropertiesUpdateData; + } + /** An interface for updating data on the `DocumentProperties` object, for use in `documentProperties.set({ ... })`. */ + interface DocumentPropertiesUpdateData { + /** + * Specifies the author of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + author?: string; + /** + * Specifies the category of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + category?: string; + /** + * Specifies the Comments field in the metadata of the document. These have no connection to comments by users made in the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + comments?: string; + /** + * Specifies the company of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + company?: string; + /** + * Specifies the format of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + format?: string; + /** + * Specifies the keywords of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + keywords?: string; + /** + * Specifies the manager of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + manager?: string; + /** + * Specifies the subject of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + subject?: string; + /** + * Specifies the title of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + title?: string; + } + /** An interface for updating data on the `Field` object, for use in `field.set({ ... })`. */ + interface FieldUpdateData { + /** + * Gets the field's result data. + * + * @remarks + * [Api set: WordApi 1.4] + */ + result?: Word.Interfaces.RangeUpdateData; + /** + * Specifies the field's code instruction. + * + * @remarks + * [Api set: WordApi 1.4] + * + * Note: The ability to set the code was introduced in WordApi 1.5. + */ + code?: string; + /** + * Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is `null` and it will throw a general exception when code attempts to set it. + * + * @remarks + * [Api set: WordApi 1.5] + */ + data?: string; + /** + * Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. + * + * @remarks + * [Api set: WordApi 1.5] + */ + locked?: boolean; + /** + * Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + showCodes?: boolean; + } + /** An interface for updating data on the `FieldCollection` object, for use in `fieldCollection.set({ ... })`. */ + interface FieldCollectionUpdateData { + items?: Word.Interfaces.FieldData[]; + } + /** An interface for updating data on the `Font` object, for use in `font.set({ ... })`. */ + interface FontUpdateData { + /** + * Returns a `FillFormat` object that contains fill formatting properties for the font used by the range of text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fill?: Word.Interfaces.FillFormatUpdateData; + /** + * Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + glow?: Word.Interfaces.GlowFormatUpdateData; + /** + * Returns a `LineFormat` object that specifies the formatting for a line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + line?: Word.Interfaces.LineFormatUpdateData; + /** + * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + reflection?: Word.Interfaces.ReflectionFormatUpdateData; + /** + * Returns a `ColorFormat` object that represents the color for the font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + textColor?: Word.Interfaces.ColorFormatUpdateData; + /** + * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + textShadow?: Word.Interfaces.ShadowFormatUpdateData; + /** + * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + threeDimensionalFormat?: Word.Interfaces.ThreeDimensionalFormatUpdateData; + /** + * Specifies whether the font is formatted as all capital letters, 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + allCaps?: boolean; + /** + * Specifies a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + bold?: boolean; + /** + * Specifies whether the font is formatted as bold in a right-to-left language document. 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + boldBidirectional?: boolean; + /** + * Specifies the color for the specified font. You can provide the value in the '#RRGGBB' format or the color name. + * + * @remarks + * [Api set: WordApi 1.1] + */ + color?: string; + /** + * Specifies a `ColorIndex` value that represents the color for the font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + colorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + /** + * Specifies the color for the `Font` object in a right-to-left language document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + colorIndexBidirectional?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + /** + * Specifies whether contextual alternates are enabled for the font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + contextualAlternates?: boolean; + /** + * Specifies the color to be used for diacritics for the `Font` object. You can provide the value in the '#RRGGBB' format. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + diacriticColor?: string; + /** + * Specifies whether Microsoft Word ignores the number of characters per line for the corresponding `Font` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + disableCharacterSpaceGrid?: boolean; + /** + * Specifies a value that indicates whether the font has a double strikethrough. True if the font is formatted as double strikethrough text, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + doubleStrikeThrough?: boolean; + /** + * Specifies whether the font is formatted as embossed. The possible values are as follows: + + - `true`: All the text is embossed. + + - `false`: None of the text is embossed. + + - `null`: Returned if some, but not all, of the text is embossed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + emboss?: boolean; + /** + * Specifies an `EmphasisMark` value that represents the emphasis mark for a character or designated character string. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + emphasisMark?: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle"; + /** + * Specifies whether the font is formatted as engraved. The possible values are as follows: + + - `true`: All the text is engraved. + + - `false`: None of the text is engraved. + + - `null`: Returned if some, but not all, of the text is engraved. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + engrave?: boolean; + /** + * Specifies a value that indicates whether the font is tagged as hidden. True if the font is formatted as hidden text, otherwise, false. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + hidden?: boolean; + /** + * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or `null` for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. + * + * @remarks + * [Api set: WordApi 1.1] + */ + highlightColor?: string; + /** + * Specifies a value that indicates whether the font is italicized. True if the font is italicized, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + italic?: boolean; + /** + * Specifies whether the font is italicized in a right-to-left language document. 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + italicBidirectional?: boolean; + /** + * Specifies the minimum font size for which Microsoft Word will adjust kerning automatically. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + kerning?: number; + /** + * Specifies the ligature setting for the `Font` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + ligature?: Word.Ligature | "None" | "Standard" | "Contextual" | "StandardContextual" | "Historical" | "StandardHistorical" | "ContextualHistorical" | "StandardContextualHistorical" | "Discretional" | "StandardDiscretional" | "ContextualDiscretional" | "StandardContextualDiscretional" | "HistoricalDiscretional" | "StandardHistoricalDiscretional" | "ContextualHistoricalDiscretional" | "All"; + /** + * Specifies a value that represents the name of the font. + * + * @remarks + * [Api set: WordApi 1.1] + */ + name?: string; + /** + * Specifies the font used for Latin text (characters with character codes from 0 (zero) through 127). + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nameAscii?: string; + /** + * Specifies the font name in a right-to-left language document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nameBidirectional?: string; + /** + * Specifies the East Asian font name. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nameFarEast?: string; + /** + * Specifies the font used for characters with codes from 128 through 255. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + nameOther?: string; + /** + * Specifies the number form setting for an OpenType font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numberForm?: Word.NumberForm | "Default" | "Lining" | "OldStyle"; + /** + * Specifies the number spacing setting for the font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + numberSpacing?: Word.NumberSpacing | "Default" | "Proportional" | "Tabular"; + /** + * Specifies if the font is formatted as outlined. The possible values are as follows: + + - `true`: All the text is outlined. + + - `false`: None of the text is outlined. + + - `null`: Returned if some, but not all, of the text is outlined. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + outline?: boolean; + /** + * Specifies the position of text (in points) relative to the base line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + position?: number; + /** + * Specifies the scaling percentage applied to the font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + scaling?: number; + /** + * Specifies if the font is formatted as shadowed. The possible values are as follows: + + - `true`: All the text is shadowed. + + - `false`: None of the text is shadowed. + + - `null`: Returned if some, but not all, of the text is shadowed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shadow?: boolean; + /** + * Specifies a value that represents the font size in points. + * + * @remarks + * [Api set: WordApi 1.1] + */ + size?: number; + /** + * Specifies the font size in points for right-to-left text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sizeBidirectional?: number; + /** + * Specifies whether the font is formatted as small caps, 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: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + smallCaps?: boolean; + /** + * Specifies the spacing between characters. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + spacing?: number; + /** + * Specifies a value that indicates whether the font has a strikethrough. True if the font is formatted as strikethrough text, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + strikeThrough?: boolean; + /** + * Specifies the stylistic set for the font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + stylisticSet?: Word.StylisticSet | "Default" | "Set01" | "Set02" | "Set03" | "Set04" | "Set05" | "Set06" | "Set07" | "Set08" | "Set09" | "Set10" | "Set11" | "Set12" | "Set13" | "Set14" | "Set15" | "Set16" | "Set17" | "Set18" | "Set19" | "Set20"; + /** + * Specifies a value that indicates whether the font is a subscript. True if the font is formatted as subscript, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + subscript?: boolean; + /** + * Specifies a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + superscript?: boolean; + /** + * Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined. + * + * @remarks + * [Api set: WordApi 1.1] + */ + underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; + /** + * Specifies the color of the underline for the `Font` object. You can provide the value in the '#RRGGBB' format. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + underlineColor?: string; + } + /** An interface for updating data on the `HeadingStyle` object, for use in `headingStyle.set({ ... })`. */ + interface HeadingStyleUpdateData { + /** + * Specifies the level for the heading style in a table of contents or table of figures. Must be a value from 1 to 9. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + level?: number; + /** + * Specifies the name of style for a heading. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + name?: string; + } + /** An interface for updating data on the `HeadingStyleCollection` object, for use in `headingStyleCollection.set({ ... })`. */ + interface HeadingStyleCollectionUpdateData { + items?: Word.Interfaces.HeadingStyleData[]; + } + /** An interface for updating data on the `Hyperlink` object, for use in `hyperlink.set({ ... })`. */ + interface HyperlinkUpdateData { + /** + * Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeUpdateData; + /** + * Specifies the address (for example, a file name or URL) of the hyperlink. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + address?: string; + /** + * Specifies the text string for the hyperlink's subject line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + emailSubject?: string; + /** + * Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + screenTip?: string; + /** + * Specifies a named location in the destination of the hyperlink. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + subAddress?: string; + /** + * Specifies the name of the frame or window in which to load the hyperlink. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + target?: string; + /** + * Specifies the hyperlink's visible text in the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + textToDisplay?: string; + } + /** An interface for updating data on the `HyperlinkCollection` object, for use in `hyperlinkCollection.set({ ... })`. */ + interface HyperlinkCollectionUpdateData { + items?: Word.Interfaces.HyperlinkData[]; + } + /** An interface for updating data on the `InlinePicture` object, for use in `inlinePicture.set({ ... })`. */ + interface InlinePictureUpdateData { + /** + * Specifies a string that represents the alternative text associated with the inline image. + * + * @remarks + * [Api set: WordApi 1.1] + */ + altTextDescription?: string; + /** + * Specifies a string that contains the title for the inline image. + * + * @remarks + * [Api set: WordApi 1.1] + */ + altTextTitle?: string; + /** + * Specifies a number that describes the height of the inline image. + * + * @remarks + * [Api set: WordApi 1.1] + */ + height?: number; + /** + * Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. + * + * @remarks + * [Api set: WordApi 1.1] + */ + hyperlink?: string; + /** + * Specifies a value that indicates whether the inline image retains its original proportions when you resize it. + * + * @remarks + * [Api set: WordApi 1.1] + */ + lockAspectRatio?: boolean; + /** + * Specifies a number that describes the width of the inline image. + * + * @remarks + * [Api set: WordApi 1.1] + */ + width?: number; + } + /** An interface for updating data on the `InlinePictureCollection` object, for use in `inlinePictureCollection.set({ ... })`. */ + interface InlinePictureCollectionUpdateData { + items?: Word.Interfaces.InlinePictureData[]; + } + /** An interface for updating data on the `LinkFormat` object, for use in `linkFormat.set({ ... })`. */ + interface LinkFormatUpdateData { + /** + * Specifies if the link is updated automatically when the container file is opened or when the source file is changed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isAutoUpdated?: boolean; + /** + * Specifies if a `Field`, `InlineShape`, or `Shape` object is locked to prevent automatic updating. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isLocked?: boolean; + /** + * Specifies if the linked picture is saved with the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isPictureSavedWithDocument?: boolean; + /** + * Specifies the path and name of the source file for the linked OLE object, picture, or field. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + sourceFullName?: string; + } + /** An interface for updating data on the `ListCollection` object, for use in `listCollection.set({ ... })`. */ + interface ListCollectionUpdateData { + items?: Word.Interfaces.ListData[]; + } + /** An interface for updating data on the `ListItem` object, for use in `listItem.set({ ... })`. */ + interface ListItemUpdateData { + /** + * Specifies the level of the item in the list. + * + * @remarks + * [Api set: WordApi 1.3] + */ + level?: number; + } + /** An interface for updating data on the `ListLevel` object, for use in `listLevel.set({ ... })`. */ + interface ListLevelUpdateData { + /** + * Gets a Font object that represents the character formatting of the specified object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + font?: Word.Interfaces.FontUpdateData; + /** + * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + /** + * Specifies the name of the style that's linked to the specified list level object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + linkedStyle?: string; + /** + * Specifies the number format for the specified list level. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + numberFormat?: string; + /** + * Specifies the position (in points) of the number or bullet for the specified list level object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + numberPosition?: number; + /** + * Specifies the number style for the list level object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + numberStyle?: Word.ListBuiltInNumberStyle | "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter" | "Ordinal" | "CardinalText" | "OrdinalText" | "Kanji" | "KanjiDigit" | "AiueoHalfWidth" | "IrohaHalfWidth" | "ArabicFullWidth" | "KanjiTraditional" | "KanjiTraditional2" | "NumberInCircle" | "Aiueo" | "Iroha" | "ArabicLZ" | "Bullet" | "Ganada" | "Chosung" | "GBNum1" | "GBNum2" | "GBNum3" | "GBNum4" | "Zodiac1" | "Zodiac2" | "Zodiac3" | "TradChinNum1" | "TradChinNum2" | "TradChinNum3" | "TradChinNum4" | "SimpChinNum1" | "SimpChinNum2" | "SimpChinNum3" | "SimpChinNum4" | "HanjaRead" | "HanjaReadDigit" | "Hangul" | "Hanja" | "Hebrew1" | "Arabic1" | "Hebrew2" | "Arabic2" | "HindiLetter1" | "HindiLetter2" | "HindiArabic" | "HindiCardinalText" | "ThaiLetter" | "ThaiArabic" | "ThaiCardinalText" | "VietCardinalText" | "LowercaseRussian" | "UppercaseRussian" | "LowercaseGreek" | "UppercaseGreek" | "ArabicLZ2" | "ArabicLZ3" | "ArabicLZ4" | "LowercaseTurkish" | "UppercaseTurkish" | "LowercaseBulgarian" | "UppercaseBulgarian" | "PictureBullet" | "Legal" | "LegalLZ"; + /** + * Specifies the list level that must appear before the specified list level restarts numbering at 1. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + resetOnHigher?: number; + /** + * Specifies the starting number for the specified list level object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + startAt?: number; + /** + * Specifies the tab position for the specified list level object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + tabPosition?: number; + /** + * Specifies the position (in points) for the second line of wrapping text for the specified list level object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + textPosition?: number; + /** + * Specifies the character inserted after the number for the specified list level. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + trailingCharacter?: Word.TrailingCharacter | "TrailingTab" | "TrailingSpace" | "TrailingNone"; + } + /** An interface for updating data on the `ListLevelCollection` object, for use in `listLevelCollection.set({ ... })`. */ + interface ListLevelCollectionUpdateData { + items?: Word.Interfaces.ListLevelData[]; + } + /** An interface for updating data on the `ListTemplate` object, for use in `listTemplate.set({ ... })`. */ + interface ListTemplateUpdateData { + /** + * Specifies the name of the list template. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + name?: string; + /** + * Specifies whether the list template is outline numbered. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + outlineNumbered?: boolean; + } + /** An interface for updating data on the `NoteItem` object, for use in `noteItem.set({ ... })`. */ + interface NoteItemUpdateData { + /** + * Represents the body object of the note item. It's the portion of the text within the footnote or endnote. + * + * @remarks + * [Api set: WordApi 1.5] + */ + body?: Word.Interfaces.BodyUpdateData; + /** + * Represents a footnote or endnote reference in the main document. + * + * @remarks + * [Api set: WordApi 1.5] + */ + reference?: Word.Interfaces.RangeUpdateData; + } + /** An interface for updating data on the `NoteItemCollection` object, for use in `noteItemCollection.set({ ... })`. */ + interface NoteItemCollectionUpdateData { + items?: Word.Interfaces.NoteItemData[]; + } + /** An interface for updating data on the `OleFormat` object, for use in `oleFormat.set({ ... })`. */ + interface OleFormatUpdateData { + /** + * Specifies the class type for the specified OLE object, picture, or field. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + classType?: string; + /** + * Specifies the icon that is used when the `displayAsIcon` property is `true`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + iconIndex?: number; + /** + * Specifies the text displayed below the icon for the OLE object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + iconLabel?: string; + /** + * Specifies the program file in which the icon for the OLE object is stored. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + iconName?: string; + /** + * Specifies whether formatting done in Microsoft Word to the linked OLE object is preserved. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isFormattingPreservedOnUpdate?: boolean; + } + /** An interface for updating data on the `PageCollection` object, for use in `pageCollection.set({ ... })`. */ + interface PageCollectionUpdateData { + items?: Word.Interfaces.PageData[]; + } + /** An interface for updating data on the `PaneCollection` object, for use in `paneCollection.set({ ... })`. */ + interface PaneCollectionUpdateData { + items?: Word.Interfaces.PaneData[]; + } + /** An interface for updating data on the `Window` object, for use in `window.set({ ... })`. */ + interface WindowUpdateData { + /** + * Gets the next document window in the collection of open document windows. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + next?: Word.Interfaces.WindowUpdateData; + /** + * Gets the previous document window in the collection open document windows. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + previous?: Word.Interfaces.WindowUpdateData; + /** + * Specifies whether rulers are displayed for the window or pane. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + areRulersDisplayed?: boolean; + /** + * Specifies whether thumbnail images of the pages in a document are displayed along the left side of the Microsoft Word document window. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + areThumbnailsDisplayed?: boolean; + /** + * Specifies the caption text for the window that is displayed in the title bar of the document or application window. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + caption?: string; + /** + * Specifies the horizontal scroll position as a percentage of the document width. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + horizontalPercentScrolled?: number; + /** + * Specifies the default start-up mode for the Japanese Input Method Editor (IME). + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + imeMode?: Word.ImeMode | "NoControl" | "On" | "Off" | "Hiragana" | "Katakana" | "KatakanaHalf" | "AlphaFull" | "Alpha" | "HangulFull" | "Hangul"; + /** + * Specifies whether the document map is visible. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isDocumentMapVisible?: boolean; + /** + * Specifies whether the email message header is visible in the document window. The default value is `False`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isEnvelopeVisible?: boolean; + /** + * Specifies whether a horizontal scroll bar is displayed for the window. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isHorizontalScrollBarDisplayed?: boolean; + /** + * Specifies whether the vertical scroll bar appears on the left side of the document window. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isLeftScrollBarDisplayed?: boolean; + /** + * Specifies whether the vertical ruler appears on the right side of the document window in print layout view. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isRightRulerDisplayed?: boolean; + /** + * Specifies whether the window is split into multiple panes. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isSplit?: boolean; + /** + * Specifies whether a vertical ruler is displayed for the window or pane. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isVerticalRulerDisplayed?: boolean; + /** + * Specifies whether a vertical scroll bar is displayed for the window. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isVerticalScrollBarDisplayed?: boolean; + /** + * Specifies whether the window is visible. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isVisible?: boolean; + /** + * Specifies how Microsoft Word displays source documents after a compare and merge process. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + showSourceDocuments?: Word.ShowSourceDocuments | "None" | "Original" | "Revised" | "Both"; + /** + * Specifies the vertical split percentage for the window. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + splitVertical?: number; + /** + * Specifies the width of the style area in points. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + styleAreaWidth?: number; + /** + * Specifies the vertical scroll position as a percentage of the document length. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + verticalPercentScrolled?: number; + /** + * Specifies the state of the document window or task window. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + windowState?: Word.WindowState | "Normal" | "Maximize" | "Minimize"; + } + /** An interface for updating data on the `WindowCollection` object, for use in `windowCollection.set({ ... })`. */ + interface WindowCollectionUpdateData { + items?: Word.Interfaces.WindowData[]; + } + /** An interface for updating data on the `Paragraph` object, for use in `paragraph.set({ ... })`. */ + interface ParagraphUpdateData { + /** + * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ + font?: Word.Interfaces.FontUpdateData; + /** + * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. + * + * @remarks + * [Api set: WordApi 1.3] + */ + listItem?: Word.Interfaces.ListItemUpdateData; + /** + * Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return 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: WordApi 1.3] + */ + listItemOrNullObject?: Word.Interfaces.ListItemUpdateData; + /** + * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shading?: Word.Interfaces.ShadingUniversalUpdateData; + /** + * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. + * + * @remarks + * [Api set: WordApi 1.1] + */ + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + /** + * Specifies the value, in points, for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. + * + * @remarks + * [Api set: WordApi 1.1] + */ + firstLineIndent?: number; + /** + * Specifies the left indent value, in points, for the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + leftIndent?: number; + /** + * Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. + * + * @remarks + * [Api set: WordApi 1.1] + */ + lineSpacing?: number; + /** + * Specifies the amount of spacing, in grid lines, after the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + lineUnitAfter?: number; + /** + * Specifies the amount of spacing, in grid lines, before the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + lineUnitBefore?: number; + /** + * Specifies the outline level for the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + outlineLevel?: number; + /** + * Specifies the right indent value, in points, for the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + rightIndent?: number; + /** + * Specifies the spacing, in points, after the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + spaceAfter?: number; + /** + * Specifies the spacing, in points, before the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] + */ + spaceBefore?: number; + /** + * Specifies the style name for the paragraph. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * + * @remarks + * [Api set: WordApi 1.1] + */ + style?: string; + /** + * Specifies the built-in style name for the paragraph. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + } + /** An interface for updating data on the `ParagraphCollection` object, for use in `paragraphCollection.set({ ... })`. */ + interface ParagraphCollectionUpdateData { + items?: Word.Interfaces.ParagraphData[]; + } + /** An interface for updating data on the `ParagraphFormat` object, for use in `paragraphFormat.set({ ... })`. */ + interface ParagraphFormatUpdateData { + /** + * Specifies the alignment for the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + /** + * Specifies the value (in points) for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. + * + * @remarks + * [Api set: WordApi 1.5] + */ + firstLineIndent?: number; + /** + * Specifies whether all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document. + * + * @remarks + * [Api set: WordApi 1.5] + */ + keepTogether?: boolean; + /** + * Specifies whether the specified paragraph remains on the same page as the paragraph that follows it when Microsoft Word repaginates the document. + * + * @remarks + * [Api set: WordApi 1.5] + */ + keepWithNext?: boolean; + /** + * Specifies the left indent. + * + * @remarks + * [Api set: WordApi 1.5] + */ + leftIndent?: number; + /** + * Specifies the line spacing (in points) for the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + lineSpacing?: number; + /** + * Specifies the amount of spacing (in gridlines) after the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + lineUnitAfter?: number; + /** + * Specifies the amount of spacing (in gridlines) before the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + lineUnitBefore?: number; + /** + * Specifies whether left and right indents are the same width. + * + * @remarks + * [Api set: WordApi 1.5] + */ + mirrorIndents?: boolean; + /** + * Specifies the outline level for the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + outlineLevel?: Word.OutlineLevel | "OutlineLevel1" | "OutlineLevel2" | "OutlineLevel3" | "OutlineLevel4" | "OutlineLevel5" | "OutlineLevel6" | "OutlineLevel7" | "OutlineLevel8" | "OutlineLevel9" | "OutlineLevelBodyText"; + /** + * Specifies the right indent (in points) for the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + rightIndent?: number; + /** + * Specifies the amount of spacing (in points) after the specified paragraph or text column. + * + * @remarks + * [Api set: WordApi 1.5] + */ + spaceAfter?: number; + /** + * Specifies the spacing (in points) before the specified paragraphs. + * + * @remarks + * [Api set: WordApi 1.5] + */ + spaceBefore?: number; + /** + * Specifies whether the first and last lines in the specified paragraph remain on the same page as the rest of the paragraph when Microsoft Word repaginates the document. + * + * @remarks + * [Api set: WordApi 1.5] + */ + widowControl?: boolean; + } + /** An interface for updating data on the `Range` object, for use in `range.set({ ... })`. */ + interface RangeUpdateData { + /** + * Gets the text format of the range. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.1] + */ + font?: Word.Interfaces.FontUpdateData; + /** + * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + listFormat?: Word.Interfaces.ListFormatUpdateData; + /** + * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shading?: Word.Interfaces.ShadingUniversalUpdateData; + /** + * Specifies a `CharacterCase` value that represents the case of the text in the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + case?: Word.CharacterCase | "Next" | "Lower" | "Upper" | "TitleWord" | "TitleSentence" | "Toggle" | "HalfWidth" | "FullWidth" | "Katakana" | "Hiragana"; + /** + * Specifies the character width of the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + characterWidth?: Word.CharacterWidth | "Half" | "Full"; + /** + * Specifies if the range contains combined characters. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + combineCharacters?: boolean; + /** + * Specifies the ending character position of the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + end?: number; + /** + * Specifies the width (in the current measurement units) in which Microsoft Word fits the text in the current selection or range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + fitTextWidth?: number; + /** + * Specifies if a grammar check has been run on the range or document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + grammarChecked?: boolean; + /** + * Specifies the proofing status (spelling and grammar checking) of the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hasNoProofing?: boolean; + /** + * Specifies the formatting for horizontal text set within vertical text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + horizontalInVertical?: Word.HorizontalInVerticalType | "None" | "FitInLine" | "ResizeLine"; + /** + * Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. Use a '#' to separate the address part from the optional location part. + * + * @remarks + * [Api set: WordApi 1.3] + */ + hyperlink?: string; + /** + * Specifies the ID for the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + id?: string; + /** + * Specifies whether the range of Japanese language text is hiragana or katakana. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + kana?: Word.Kana | "Katakana" | "Hiragana"; + /** + * Specifies whether Microsoft Word has detected the language of the text in the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + languageDetected?: boolean; + /** + * Specifies a `LanguageId` value that represents the language for the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + /** + * Specifies an East Asian language for the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + /** + * Specifies a language for the range that isn't classified as an East Asian language. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + languageIdOther?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + /** + * Specifies if all nonprinting characters (such as hidden text, tab marks, space marks, and paragraph marks) are displayed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + showAll?: boolean; + /** + * Specifies if spelling has been checked throughout the range or document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + spellingChecked?: boolean; + /** + * Specifies the starting character position of the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + start?: number; + /** + * Specifies the style name for the range. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * + * @remarks + * [Api set: WordApi 1.1] + */ + style?: string; + /** + * Specifies the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + /** + * Specifies whether Microsoft Word sets two lines of text in one and specifies the characters that enclose the text, if any. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + twoLinesInOne?: Word.TwoLinesInOneType | "None" | "NoBrackets" | "Parentheses" | "SquareBrackets" | "AngleBrackets" | "CurlyBrackets"; + } + /** An interface for updating data on the `RangeCollection` object, for use in `rangeCollection.set({ ... })`. */ + interface RangeCollectionUpdateData { + items?: Word.Interfaces.RangeData[]; + } + /** An interface for updating data on the `SearchOptions` object, for use in `searchOptions.set({ ... })`. */ + interface SearchOptionsUpdateData { + /** + * Specifies a value that indicates whether to ignore all punctuation characters between words. Corresponds to the Ignore punctuation check box in the Find and Replace dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + ignorePunct?: boolean; + /** + * Specifies a value that indicates whether to ignore all whitespace between words. Corresponds to the Ignore whitespace characters check box in the Find and Replace dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + ignoreSpace?: boolean; + /** + * Specifies a value that indicates whether to perform a case sensitive search. Corresponds to the Match case check box in the Find and Replace dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + matchCase?: boolean; + /** + * Specifies a value that indicates whether to match words that begin with the search string. Corresponds to the Match prefix check box in the Find and Replace dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + matchPrefix?: boolean; + /** + * Specifies a value that indicates whether to match words that end with the search string. Corresponds to the Match suffix check box in the Find and Replace dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + matchSuffix?: boolean; + /** + * Specifies a value that indicates whether to find operation only entire words, not text that is part of a larger word. Corresponds to the Find whole words only check box in the Find and Replace dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + matchWholeWord?: boolean; + /** + * Specifies a value that indicates whether the search will be performed using special search operators. Corresponds to the Use wildcards check box in the Find and Replace dialog box. + * + * @remarks + * [Api set: WordApi 1.1] + */ + matchWildcards?: boolean; + } + /** An interface for updating data on the `Section` object, for use in `section.set({ ... })`. */ + interface SectionUpdateData { + /** + * Gets the body object of the section. This doesn't include the header/footer and other section metadata. + * + * @remarks + * [Api set: WordApi 1.1] + */ + body?: Word.Interfaces.BodyUpdateData; + /** + * Returns a `PageSetup` object that's associated with the section. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + pageSetup?: Word.Interfaces.PageSetupUpdateData; + /** + * Specifies if the section is protected for forms. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + protectedForForms?: boolean; + } + /** An interface for updating data on the `SectionCollection` object, for use in `sectionCollection.set({ ... })`. */ + interface SectionCollectionUpdateData { + items?: Word.Interfaces.SectionData[]; + } + /** An interface for updating data on the `Setting` object, for use in `setting.set({ ... })`. */ + interface SettingUpdateData { + /** + * Specifies the value of the setting. + * + * @remarks + * [Api set: WordApi 1.4] + */ + value?: any; + } + /** An interface for updating data on the `SettingCollection` object, for use in `settingCollection.set({ ... })`. */ + interface SettingCollectionUpdateData { + items?: Word.Interfaces.SettingData[]; + } + /** An interface for updating data on the `StyleCollection` object, for use in `styleCollection.set({ ... })`. */ + interface StyleCollectionUpdateData { + items?: Word.Interfaces.StyleData[]; + } + /** An interface for updating data on the `Style` object, for use in `style.set({ ... })`. */ + interface StyleUpdateData { + /** + * Specifies a BorderCollection object that represents all the borders for the specified style. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + borders?: Word.Interfaces.BorderCollectionUpdateData; + /** + * Gets a font object that represents the character formatting of the specified style. + * + * @remarks + * [Api set: WordApi 1.5] + */ + font?: Word.Interfaces.FontUpdateData; + /** + * Returns a `Frame` object that represents the frame formatting for the style. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + frame?: Word.Interfaces.FrameUpdateData; + /** + * Specifies a link between a paragraph and a character style. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + linkStyle?: Word.Interfaces.StyleUpdateData; + /** + * Gets a ListTemplate object that represents the list formatting for the specified Style object. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + listTemplate?: Word.Interfaces.ListTemplateUpdateData; + /** + * Gets a ParagraphFormat object that represents the paragraph settings for the specified style. + * + * @remarks + * [Api set: WordApi 1.5] + */ + paragraphFormat?: Word.Interfaces.ParagraphFormatUpdateData; + /** + * Gets a Shading object that represents the shading for the specified style. Not applicable to List style. + * + * @remarks + * [Api set: WordApi 1.6] + */ + shading?: Word.Interfaces.ShadingUpdateData; + /** + * Gets a TableStyle object representing Style properties that can be applied to a table. + * + * @remarks + * [Api set: WordApi 1.6] + */ + tableStyle?: Word.Interfaces.TableStyleUpdateData; + /** + * Specifies whether the style is automatically redefined based on the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + automaticallyUpdate?: boolean; + /** + * Specifies the name of an existing style to use as the base formatting of another style. + * + * @remarks + * [Api set: WordApi 1.5] + * + * Note: The ability to set `baseStyle` was introduced in WordApi 1.6. + */ + baseStyle?: string; + /** + * Specifies whether the spelling and grammar checker ignores text formatted with this style. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + hasProofing?: boolean; + /** + * Specifies a `LanguageId` value that represents the language for the style. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + /** + * Specifies an East Asian language for the style. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + /** + * Specifies whether the style cannot be changed or edited. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + locked?: boolean; + /** + * Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style. + * + * @remarks + * [Api set: WordApi 1.5] + * + * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. + */ + nextParagraphStyle?: string; + /** + * Specifies whether to remove spacing between paragraphs that are formatted using the same style. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + noSpaceBetweenParagraphsOfSameStyle?: boolean; + /** + * Specifies the priority. + * + * @remarks + * [Api set: WordApi 1.5] + */ + priority?: number; + /** + * Specifies whether the style corresponds to an available quick style. + * + * @remarks + * [Api set: WordApi 1.5] + */ + quickStyle?: boolean; + /** + * Specifies whether the specified style is made visible as a recommended style in the Styles and in the Styles task pane in Microsoft Word after it's used in the document. + * + * @remarks + * [Api set: WordApi 1.5] + */ + unhideWhenUsed?: boolean; + /** + * Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane. + * + * @remarks + * [Api set: WordApi 1.5] + */ + visibility?: boolean; + } + /** An interface for updating data on the `Shading` object, for use in `shading.set({ ... })`. */ + interface ShadingUpdateData { + /** + * Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name. + * + * @remarks + * [Api set: WordApi 1.6] + */ + backgroundPatternColor?: string; + /** + * Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + foregroundPatternColor?: string; + /** + * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + texture?: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; + } + /** An interface for updating data on the `ShadingUniversal` object, for use in `shadingUniversal.set({ ... })`. */ + interface ShadingUniversalUpdateData { + /** + * Specifies the color that's applied to the background of the `ShadingUniversal` object. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - artStyle?: Word.PageBorderArt | "Apples" | "MapleMuffins" | "CakeSlice" | "CandyCorn" | "IceCreamCones" | "ChampagneBottle" | "PartyGlass" | "ChristmasTree" | "Trees" | "PalmsColor" | "Balloons3Colors" | "BalloonsHotAir" | "PartyFavor" | "ConfettiStreamers" | "Hearts" | "HeartBalloon" | "Stars3D" | "StarsShadowed" | "Stars" | "Sun" | "Earth2" | "Earth1" | "PeopleHats" | "Sombrero" | "Pencils" | "Packages" | "Clocks" | "Firecrackers" | "Rings" | "MapPins" | "Confetti" | "CreaturesButterfly" | "CreaturesLadyBug" | "CreaturesFish" | "BirdsFlight" | "ScaredCat" | "Bats" | "FlowersRoses" | "FlowersRedRose" | "Poinsettias" | "Holly" | "FlowersTiny" | "FlowersPansy" | "FlowersModern2" | "FlowersModern1" | "WhiteFlowers" | "Vine" | "FlowersDaisies" | "FlowersBlockPrint" | "DecoArchColor" | "Fans" | "Film" | "Lightning1" | "Compass" | "DoubleD" | "ClassicalWave" | "ShadowedSquares" | "TwistedLines1" | "Waveline" | "Quadrants" | "CheckedBarColor" | "Swirligig" | "PushPinNote1" | "PushPinNote2" | "Pumpkin1" | "EggsBlack" | "Cup" | "HeartGray" | "GingerbreadMan" | "BabyPacifier" | "BabyRattle" | "Cabins" | "HouseFunky" | "StarsBlack" | "Snowflakes" | "SnowflakeFancy" | "Skyrocket" | "Seattle" | "MusicNotes" | "PalmsBlack" | "MapleLeaf" | "PaperClips" | "ShorebirdTracks" | "People" | "PeopleWaving" | "EclipsingSquares2" | "Hypnotic" | "DiamondsGray" | "DecoArch" | "DecoBlocks" | "CirclesLines" | "Papyrus" | "Woodwork" | "WeavingBraid" | "WeavingRibbon" | "WeavingAngles" | "ArchedScallops" | "Safari" | "CelticKnotwork" | "CrazyMaze" | "EclipsingSquares1" | "Birds" | "FlowersTeacup" | "Northwest" | "Southwest" | "Tribal6" | "Tribal4" | "Tribal3" | "Tribal2" | "Tribal5" | "XIllusions" | "ZanyTriangles" | "Pyramids" | "PyramidsAbove" | "ConfettiGrays" | "ConfettiOutline" | "ConfettiWhite" | "Mosaic" | "Lightning2" | "HeebieJeebies" | "LightBulb" | "Gradient" | "TriangleParty" | "TwistedLines2" | "Moons" | "Ovals" | "DoubleDiamonds" | "ChainLink" | "Triangles" | "Tribal1" | "MarqueeToothed" | "SharksTeeth" | "Sawtooth" | "SawtoothGray" | "PostageStamp" | "WeavingStrips" | "ZigZag" | "CrossStitch" | "Gems" | "CirclesRectangles" | "CornerTriangles" | "CreaturesInsects" | "ZigZagStitch" | "Checkered" | "CheckedBarBlack" | "Marquee" | "BasicWhiteDots" | "BasicWideMidline" | "BasicWideOutline" | "BasicWideInline" | "BasicThinLines" | "BasicWhiteDashes" | "BasicWhiteSquares" | "BasicBlackSquares" | "BasicBlackDashes" | "BasicBlackDots" | "StarsTop" | "CertificateBanner" | "Handmade1" | "Handmade2" | "TornPaper" | "TornPaperBlack" | "CouponCutoutDashes" | "CouponCutoutDots"; + backgroundPatternColor?: string; /** - * Specifies the width (in points) of the graphical page border specified in the `artStyle` property. + * Specifies the color that's applied to the background of the `ShadingUniversal` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - artWidth?: number; + backgroundPatternColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Specifies the color for the `BorderUniversal` object. You can provide the value in the '#RRGGBB' format. + * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + foregroundPatternColor?: string; /** - * Specifies the color for the `BorderUniversal` or {@link Word.Font} object. + * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - colorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + foregroundPatternColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Specifies whether the border is visible. + * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + texture?: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; + } + /** An interface for updating data on the `Table` object, for use in `table.set({ ... })`. */ + interface TableUpdateData { /** - * Specifies the line style of the border. + * Gets the font. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - lineStyle?: Word.BorderLineStyle | "None" | "Single" | "Dot" | "DashSmallGap" | "DashLargeGap" | "DashDot" | "DashDotDot" | "Double" | "Triple" | "ThinThickSmallGap" | "ThickThinSmallGap" | "ThinThickThinSmallGap" | "ThinThickMedGap" | "ThickThinMedGap" | "ThinThickThinMedGap" | "ThinThickLargeGap" | "ThickThinLargeGap" | "ThinThickThinLargeGap" | "SingleWavy" | "DoubleWavy" | "DashDotStroked" | "Emboss3D" | "Engrave3D" | "Outset" | "Inset"; + font?: Word.Interfaces.FontUpdateData; /** - * Specifies the line width of an object's border. + * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. + * + * @remarks + * [Api set: WordApi 1.3] + */ + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + /** + * Specifies the description of the table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lineWidth?: Word.LineWidth | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600"; - } - /** An interface for updating data on the `BorderCollection` object, for use in `borderCollection.set({ ... })`. */ - interface BorderCollectionUpdateData { + description?: string; /** - * Specifies the 24-bit color of the inside borders. Color is specified in ‘#RRGGBB’ format or by using the color name. + * Specifies the number of header rows. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - insideBorderColor?: string; + headerRowCount?: number; /** - * Specifies the border type of the inside borders. + * Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - insideBorderType?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies the width of the inside borders. + * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - insideBorderWidth?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed"; + shadingColor?: string; /** - * Specifies the 24-bit color of the outside borders. Color is specified in ‘#RRGGBB’ format or by using the color name. + * Specifies the style name for the table. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - outsideBorderColor?: string; + style?: string; /** - * Specifies the border type of the outside borders. + * Specifies whether the table has banded columns. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - outsideBorderType?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + styleBandedColumns?: boolean; /** - * Specifies the width of the outside borders. + * Specifies whether the table has banded rows. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - outsideBorderWidth?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed"; - items?: Word.Interfaces.BorderData[]; - } - /** An interface for updating data on the `BorderUniversalCollection` object, for use in `borderUniversalCollection.set({ ... })`. */ - interface BorderUniversalCollectionUpdateData { - items?: Word.Interfaces.BorderUniversalData[]; - } - /** An interface for updating data on the `Break` object, for use in `break.set({ ... })`. */ - interface BreakUpdateData { + styleBandedRows?: boolean; /** - * Returns a `Range` object that represents the portion of the document that's contained in the break. + * Specifies the built-in style name for the table. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - range?: Word.Interfaces.RangeUpdateData; - } - /** An interface for updating data on the `BreakCollection` object, for use in `breakCollection.set({ ... })`. */ - interface BreakCollectionUpdateData { - items?: Word.Interfaces.BreakData[]; - } - /** An interface for updating data on the `BuildingBlock` object, for use in `buildingBlock.set({ ... })`. */ - interface BuildingBlockUpdateData { + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; /** - * Specifies the description for the building block. + * Specifies whether the table has a first column with a special style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - description?: string; + styleFirstColumn?: boolean; /** - * Specifies a `DocPartInsertType` value that represents how to insert the contents of the building block into the document. + * Specifies whether the table has a last column with a special style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - insertType?: Word.DocPartInsertType | "Content" | "Paragraph" | "Page"; + styleLastColumn?: boolean; /** - * Specifies the name of the building block. + * Specifies whether the table has a total (last) row with a special style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - name?: string; + styleTotalRow?: boolean; /** - * Specifies the contents of the building block. + * Specifies the title of the table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - value?: string; - } - /** An interface for updating data on the `CheckboxContentControl` object, for use in `checkboxContentControl.set({ ... })`. */ - interface CheckboxContentControlUpdateData { + title?: string; /** - * Specifies the current state of the checkbox. + * Specifies the text values in the table, as a 2D JavaScript array. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi 1.3] */ - isChecked?: boolean; - } - /** An interface for updating data on the `Comment` object, for use in `comment.set({ ... })`. */ - interface CommentUpdateData { + values?: string[][]; /** - * Specifies the comment's content range. + * Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - contentRange?: Word.Interfaces.CommentContentRangeUpdateData; + verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; /** - * Specifies the comment's content as plain text. + * Specifies the width of the table in points. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - content?: string; + width?: number; + } + /** An interface for updating data on the `TableStyle` object, for use in `tableStyle.set({ ... })`. */ + interface TableStyleUpdateData { /** - * Specifies the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved. + * Specifies the table's alignment against the page margin. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.1] */ - resolved?: boolean; - } - /** An interface for updating data on the `CommentCollection` object, for use in `commentCollection.set({ ... })`. */ - interface CommentCollectionUpdateData { - items?: Word.Interfaces.CommentData[]; - } - /** An interface for updating data on the `CommentContentRange` object, for use in `commentContentRange.set({ ... })`. */ - interface CommentContentRangeUpdateData { + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies a value that indicates whether the comment text is bold. + * Specifies whether lines in tables formatted with a specified style break across pages. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.1] */ - bold?: boolean; + allowBreakAcrossPage?: boolean; /** - * Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. + * Specifies the amount of space to add between the contents and the bottom borders of the cells. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.6] */ - hyperlink?: string; + bottomCellMargin?: number; /** - * Specifies a value that indicates whether the comment text is italicized. + * Specifies the spacing (in points) between the cells in a table style. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.6] */ - italic?: boolean; + cellSpacing?: number; /** - * Specifies a value that indicates whether the comment text has a strikethrough. + * Specifies the number of columns in the banding when a style specifies odd- or even-column banding. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - strikeThrough?: boolean; + columnStripe?: number; /** - * Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined. + * Specifies whether Microsoft Word allows to break the specified table across pages. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; - } - /** An interface for updating data on the `CommentReply` object, for use in `commentReply.set({ ... })`. */ - interface CommentReplyUpdateData { + isBreakAcrossPagesAllowed?: boolean; /** - * Specifies the commentReply's content range. + * Specifies the amount of space to add between the contents and the left borders of the cells. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.6] */ - contentRange?: Word.Interfaces.CommentContentRangeUpdateData; + leftCellMargin?: number; /** - * Gets the parent comment of this reply. + * Specifies the left indent value (in points) for the rows in the table style. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentComment?: Word.Interfaces.CommentUpdateData; + leftIndent?: number; /** - * Specifies the comment reply's content. The string is plain text. + * Specifies the amount of space to add between the contents and the right borders of the cells. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.6] */ - content?: string; - } - /** An interface for updating data on the `CommentReplyCollection` object, for use in `commentReplyCollection.set({ ... })`. */ - interface CommentReplyCollectionUpdateData { - items?: Word.Interfaces.CommentReplyData[]; - } - /** An interface for updating data on the `XmlMapping` object, for use in `xmlMapping.set({ ... })`. */ - interface XmlMappingUpdateData { + rightCellMargin?: number; /** - * Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to. + * Specifies the number of rows to include in the banding when the style specifies odd- or even-row banding. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customXmlNode?: Word.Interfaces.CustomXmlNodeUpdateData; + rowStripe?: number; /** - * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. + * Specifies the direction in which Microsoft Word orders cells in the table style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customXmlPart?: Word.Interfaces.CustomXmlPartUpdateData; - } - /** An interface for updating data on the `CustomXmlPrefixMappingCollection` object, for use in `customXmlPrefixMappingCollection.set({ ... })`. */ - interface CustomXmlPrefixMappingCollectionUpdateData { - items?: Word.Interfaces.CustomXmlPrefixMappingData[]; - } - /** An interface for updating data on the `CustomXmlSchemaCollection` object, for use in `customXmlSchemaCollection.set({ ... })`. */ - interface CustomXmlSchemaCollectionUpdateData { - items?: Word.Interfaces.CustomXmlSchemaData[]; - } - /** An interface for updating data on the `CustomXmlValidationErrorCollection` object, for use in `customXmlValidationErrorCollection.set({ ... })`. */ - interface CustomXmlValidationErrorCollectionUpdateData { - items?: Word.Interfaces.CustomXmlValidationErrorData[]; - } - /** An interface for updating data on the `CustomXmlValidationError` object, for use in `customXmlValidationError.set({ ... })`. */ - interface CustomXmlValidationErrorUpdateData { + tableDirection?: Word.TableDirection | "RightToLeft" | "LeftToRight"; /** - * Gets the node associated with this `CustomXmlValidationError` object, if any exist.If no nodes exist, the property returns `Nothing`. + * Specifies the amount of space to add between the contents and the top borders of the cells. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - node?: Word.Interfaces.CustomXmlNodeUpdateData; + topCellMargin?: number; } - /** An interface for updating data on the `CustomXmlNodeCollection` object, for use in `customXmlNodeCollection.set({ ... })`. */ - interface CustomXmlNodeCollectionUpdateData { - items?: Word.Interfaces.CustomXmlNodeData[]; + /** An interface for updating data on the `TabStopCollection` object, for use in `tabStopCollection.set({ ... })`. */ + interface TabStopCollectionUpdateData { + items?: Word.Interfaces.TabStopData[]; } - /** An interface for updating data on the `CustomXmlNode` object, for use in `customXmlNode.set({ ... })`. */ - interface CustomXmlNodeUpdateData { + /** An interface for updating data on the `TableCollection` object, for use in `tableCollection.set({ ... })`. */ + interface TableCollectionUpdateData { + items?: Word.Interfaces.TableData[]; + } + /** An interface for updating data on the `TableColumn` object, for use in `tableColumn.set({ ... })`. */ + interface TableColumnUpdateData { /** - * Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - firstChild?: Word.Interfaces.CustomXmlNodeUpdateData; + shading?: Word.Interfaces.ShadingUniversalUpdateData; /** - * Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. + * Specifies the preferred width (in points or as a percentage of the window width) for the column. + The unit of measurement can be specified by the `preferredWidthType` property. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lastChild?: Word.Interfaces.CustomXmlNodeUpdateData; + preferredWidth?: number; /** - * Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. + * Specifies the preferred unit of measurement to use for the width of the table column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nextSibling?: Word.Interfaces.CustomXmlNodeUpdateData; + preferredWidthType?: Word.PreferredWidthType | "Auto" | "Percent" | "Points"; /** - * Gets the object representing the part associated with this node. + * Specifies the width of the column, in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - ownerPart?: Word.Interfaces.CustomXmlPartUpdateData; + width?: number; + } + /** An interface for updating data on the `TableColumnCollection` object, for use in `tableColumnCollection.set({ ... })`. */ + interface TableColumnCollectionUpdateData { + items?: Word.Interfaces.TableColumnData[]; + } + /** An interface for updating data on the `TableOfAuthorities` object, for use in `tableOfAuthorities.set({ ... })`. */ + interface TableOfAuthoritiesUpdateData { /** - * Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. + * Specifies the name of the bookmark from which to collect table of authorities entries. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - parentNode?: Word.Interfaces.CustomXmlNodeUpdateData; + bookmark?: string; /** - * Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. + * Specifies the category of entries to be included in the table of authorities. + Values 0 through 16 correspond to the items listed in the Category box of the Table of Authorities dialog. To learn how to access this through the Word UI, see {@link https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0 | Create a table of authorities}. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - previousSibling?: Word.Interfaces.CustomXmlNodeUpdateData; + category?: number; /** - * Specifies the value of the current node. + * Specifies a separator of up to five characters. This appears between the table of authorities entry and its page number. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nodeValue?: string; + entrySeparator?: string; /** - * Specifies the text for the current node. + * Specifies whether the category name for a group of entries appears in the table of authorities. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - text?: string; - } - /** An interface for updating data on the `ContentControl` object, for use in `contentControl.set({ ... })`. */ - interface ContentControlUpdateData { + isCategoryHeaderIncluded?: boolean; /** - * Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `BuildingBlockGallery`. It's `null` otherwise. + * Specifies whether the entries in the table of authorities are displayed with their formatting in the table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlUpdateData; - /** - * Gets the data of the content control when its type is `CheckBox`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApi 1.7] - */ - checkboxContentControl?: Word.Interfaces.CheckboxContentControlUpdateData; + isEntryFormattingKept?: boolean; /** - * Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `DatePicker`. It's `null` otherwise. + * Specifies whether references to the same authority that are repeated on five or more pages are replaced with "Passim". * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - datePickerContentControl?: Word.Interfaces.DatePickerContentControlUpdateData; - /** - * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ - font?: Word.Interfaces.FontUpdateData; + isPassimUsed?: boolean; /** - * Gets the group-related data if the content control's {@link Word.ContentControlType} is `Group`. It's `null` otherwise. + * Specifies a separator of up to five characters. This appears between individual page references in the table of authorities. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - groupContentControl?: Word.Interfaces.GroupContentControlUpdateData; + pageNumberSeparator?: string; /** - * Gets the picture-related data if the content control's {@link Word.ContentControlType} is `Picture`. It's `null` otherwise. + * Specifies a separator of up to five characters. This appears between ranges of pages in the table of authorities. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pictureContentControl?: Word.Interfaces.PictureContentControlUpdateData; + pageRangeSeparator?: string; /** - * Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `RepeatingSection`. It's `null` otherwise. + * Specifies the {@link https://support.microsoft.com/office/062a387b-dfc9-4ef8-8235-29ee113d59be | Sequence (SEQ) field} identifier for the table of authorities. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlUpdateData; + sequenceName?: string; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Specifies a separator of up to five characters. This appears between the sequence number and the page number in the table of authorities. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingUpdateData; - /** - * Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. - * - * @remarks - * [Api set: WordApi 1.1] - */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; - /** - * Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited. - * - * @remarks - * [Api set: WordApi 1.1] - */ - cannotDelete?: boolean; + sequenceSeparator?: string; /** - * Specifies a value that indicates whether the user can edit the contents of the content control. + * Specifies the leader character that appears between entries and their associated page numbers in the table of authorities. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - cannotEdit?: boolean; + tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + } + /** An interface for updating data on the `TableOfAuthoritiesCollection` object, for use in `tableOfAuthoritiesCollection.set({ ... })`. */ + interface TableOfAuthoritiesCollectionUpdateData { + items?: Word.Interfaces.TableOfAuthoritiesData[]; + } + /** An interface for updating data on the `TableOfAuthoritiesCategoryCollection` object, for use in `tableOfAuthoritiesCategoryCollection.set({ ... })`. */ + interface TableOfAuthoritiesCategoryCollectionUpdateData { + items?: Word.Interfaces.TableOfAuthoritiesCategoryData[]; + } + /** An interface for updating data on the `TableOfContents` object, for use in `tableOfContents.set({ ... })`. */ + interface TableOfContentsUpdateData { /** - * Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. + * Specifies whether built-in heading styles are used for the table of contents. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - color?: string; + areBuiltInHeadingStylesUsed?: boolean; /** - * Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. + * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of contents. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - placeholderText?: string; + areFieldsUsed?: boolean; /** - * Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. + * Specifies whether entries in the table of contents should be formatted as hyperlinks when publishing to the web. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - removeWhenEdited?: boolean; + areHyperlinksUsedOnWeb?: boolean; /** - * Specifies the style name for the content control. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * Specifies whether the page numbers in the table of contents should be hidden when publishing to the web. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: string; + arePageNumbersHiddenOnWeb?: boolean; /** - * Specifies the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Specifies whether page numbers are included in the table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + arePageNumbersIncluded?: boolean; /** - * Specifies a tag to identify a content control. + * Specifies whether page numbers are aligned with the right margin in the table of contents. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tag?: string; + arePageNumbersRightAligned?: boolean; /** - * Specifies the title for a content control. + * Specifies the ending heading level for the table of contents. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - title?: string; - } - /** An interface for updating data on the `ContentControlCollection` object, for use in `contentControlCollection.set({ ... })`. */ - interface ContentControlCollectionUpdateData { - items?: Word.Interfaces.ContentControlData[]; - } - /** An interface for updating data on the `ContentControlListItem` object, for use in `contentControlListItem.set({ ... })`. */ - interface ContentControlListItemUpdateData { + lowerHeadingLevel?: number; /** - * Specifies the display text of a list item for a dropdown list or combo box content control. + * Specifies the character between entries and their page numbers in the table of contents. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - displayText?: string; + tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** - * Specifies the index location of a content control list item in the collection of list items. + * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of contents. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - index?: number; + tableId?: string; /** - * Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * Specifies the starting heading level for the table of contents. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - value?: string; + upperHeadingLevel?: number; } - /** An interface for updating data on the `ContentControlListItemCollection` object, for use in `contentControlListItemCollection.set({ ... })`. */ - interface ContentControlListItemCollectionUpdateData { - items?: Word.Interfaces.ContentControlListItemData[]; + /** An interface for updating data on the `TableOfContentsCollection` object, for use in `tableOfContentsCollection.set({ ... })`. */ + interface TableOfContentsCollectionUpdateData { + items?: Word.Interfaces.TableOfContentsData[]; } - /** An interface for updating data on the `CustomProperty` object, for use in `customProperty.set({ ... })`. */ - interface CustomPropertyUpdateData { + /** An interface for updating data on the `TableOfFigures` object, for use in `tableOfFigures.set({ ... })`. */ + interface TableOfFiguresUpdateData { /** - * Specifies the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). + * Specifies whether built-in heading styles are used for the table of figures. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - value?: any; - } - /** An interface for updating data on the `CustomPropertyCollection` object, for use in `customPropertyCollection.set({ ... })`. */ - interface CustomPropertyCollectionUpdateData { - items?: Word.Interfaces.CustomPropertyData[]; - } - /** An interface for updating data on the `CustomXmlPart` object, for use in `customXmlPart.set({ ... })`. */ - interface CustomXmlPartUpdateData { + areBuiltInHeadingStylesUsed?: boolean; /** - * Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. + * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - documentElement?: Word.Interfaces.CustomXmlNodeUpdateData; - } - /** An interface for updating data on the `CustomXmlPartCollection` object, for use in `customXmlPartCollection.set({ ... })`. */ - interface CustomXmlPartCollectionUpdateData { - items?: Word.Interfaces.CustomXmlPartData[]; - } - /** An interface for updating data on the `CustomXmlPartScopedCollection` object, for use in `customXmlPartScopedCollection.set({ ... })`. */ - interface CustomXmlPartScopedCollectionUpdateData { - items?: Word.Interfaces.CustomXmlPartData[]; - } - /** An interface for updating data on the `Document` object, for use in `document.set({ ... })`. */ - interface DocumentUpdateData { + areFieldsUsed?: boolean; /** - * Gets the active window for the document. + * Specifies whether entries in the table of figures should be formatted as hyperlinks when publishing to the web. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - activeWindow?: Word.Interfaces.WindowUpdateData; + areHyperlinksUsedOnWeb?: boolean; /** - * Returns a `Bibliography` object that represents the bibliography references contained within the document. + * Specifies whether the page numbers in the table of figures should be hidden when publishing to the web. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bibliography?: Word.Interfaces.BibliographyUpdateData; + arePageNumbersHiddenOnWeb?: boolean; /** - * Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * Specifies whether page numbers are included in the table of figures. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - body?: Word.Interfaces.BodyUpdateData; + arePageNumbersIncluded?: boolean; /** - * Returns a `PageSetup` object that's associated with the document. + * Specifies whether page numbers are aligned with the right margin in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageSetup?: Word.Interfaces.PageSetupUpdateData; + arePageNumbersRightAligned?: boolean; /** - * Gets the properties of the document. + * Specifies the label that identifies the items to be included in the table of figures. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - properties?: Word.Interfaces.DocumentPropertiesUpdateData; + captionLabel?: string; /** - * Specifies if automatic hyphenation is turned on for the document. + * Specifies whether the caption label and caption number are included in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - autoHyphenation?: boolean; + isLabelIncluded?: boolean; /** - * Specifies if the edits in the document are automatically saved. + * Specifies the ending heading level for the table of figures. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - autoSaveOn?: boolean; + lowerHeadingLevel?: number; /** - * Specifies the ChangeTracking mode. + * Specifies the character between entries and their page numbers in the table of figures. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - changeTrackingMode?: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly"; + tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** - * Specifies the maximum number of consecutive lines that can end with hyphens. + * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - consecutiveHyphensLimit?: number; + tableId?: string; /** - * Specifies whether words in all capital letters can be hyphenated. + * Specifies the starting heading level for the table of figures. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hyphenateCaps?: boolean; + upperHeadingLevel?: number; + } + /** An interface for updating data on the `TableOfFiguresCollection` object, for use in `tableOfFiguresCollection.set({ ... })`. */ + interface TableOfFiguresCollectionUpdateData { + items?: Word.Interfaces.TableOfFiguresData[]; + } + /** An interface for updating data on the `TableRow` object, for use in `tableRow.set({ ... })`. */ + interface TableRowUpdateData { /** - * Specifies whether Microsoft Word has detected the language of the document text. + * Gets the font. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - languageDetected?: boolean; - } - /** An interface for updating data on the `DocumentCreated` object, for use in `documentCreated.set({ ... })`. */ - interface DocumentCreatedUpdateData { + font?: Word.Interfaces.FontUpdateData; /** - * Gets the body object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * Specifies the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] + * [Api set: WordApi 1.3] */ - body?: Word.Interfaces.BodyUpdateData; + horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Gets the properties of the document. + * Specifies the preferred height of the row in points. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] + * [Api set: WordApi 1.3] */ - properties?: Word.Interfaces.DocumentPropertiesUpdateData; - } - /** An interface for updating data on the `DocumentProperties` object, for use in `documentProperties.set({ ... })`. */ - interface DocumentPropertiesUpdateData { + preferredHeight?: number; /** - * Specifies the author of the document. + * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. * * @remarks * [Api set: WordApi 1.3] */ - author?: string; + shadingColor?: string; /** - * Specifies the category of the document. + * Specifies the text values in the row, as a 2D JavaScript array. * * @remarks * [Api set: WordApi 1.3] */ - category?: string; + values?: string[][]; /** - * Specifies the Comments field in the metadata of the document. These have no connection to comments by users made in the document. + * Specifies the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'. * * @remarks * [Api set: WordApi 1.3] */ - comments?: string; + verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + } + /** An interface for updating data on the `TableRowCollection` object, for use in `tableRowCollection.set({ ... })`. */ + interface TableRowCollectionUpdateData { + items?: Word.Interfaces.TableRowData[]; + } + /** An interface for updating data on the `TableCell` object, for use in `tableCell.set({ ... })`. */ + interface TableCellUpdateData { /** - * Specifies the company of the document. + * Gets the body object of the cell. * * @remarks * [Api set: WordApi 1.3] */ - company?: string; + body?: Word.Interfaces.BodyUpdateData; /** - * Specifies the format of the document. + * Specifies the width of the cell's column in points. This is applicable to uniform tables. * * @remarks * [Api set: WordApi 1.3] */ - format?: string; + columnWidth?: number; /** - * Specifies the keywords of the document. + * Specifies the horizontal alignment of the cell. The value can be 'Left', 'Centered', 'Right', or 'Justified'. * * @remarks * [Api set: WordApi 1.3] */ - keywords?: string; + horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies the manager of the document. + * Specifies the shading color of the cell. Color is specified in "#RRGGBB" format or by using the color name. * * @remarks * [Api set: WordApi 1.3] */ - manager?: string; + shadingColor?: string; /** - * Specifies the subject of the document. + * Specifies the text of the cell. * * @remarks * [Api set: WordApi 1.3] */ - subject?: string; + value?: string; /** - * Specifies the title of the document. + * Specifies the vertical alignment of the cell. The value can be 'Top', 'Center', or 'Bottom'. * * @remarks * [Api set: WordApi 1.3] */ - title?: string; + verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; } - /** An interface for updating data on the `Field` object, for use in `field.set({ ... })`. */ - interface FieldUpdateData { - /** - * Gets the field's result data. - * - * @remarks - * [Api set: WordApi 1.4] - */ - result?: Word.Interfaces.RangeUpdateData; - /** - * Specifies the field's code instruction. - * - * @remarks - * [Api set: WordApi 1.4] - * - * Note: The ability to set the code was introduced in WordApi 1.5. - */ - code?: string; + /** An interface for updating data on the `TableCellCollection` object, for use in `tableCellCollection.set({ ... })`. */ + interface TableCellCollectionUpdateData { + items?: Word.Interfaces.TableCellData[]; + } + /** An interface for updating data on the `TableBorder` object, for use in `tableBorder.set({ ... })`. */ + interface TableBorderUpdateData { /** - * Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is `null` and it will throw a general exception when code attempts to set it. + * Specifies the table border color. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - data?: string; + color?: string; /** - * Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. + * Specifies the type of the table border. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - locked?: boolean; + type?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; /** - * Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise. + * Specifies the width, in points, of the table border. Not applicable to table border types that have fixed widths. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - showCodes?: boolean; - } - /** An interface for updating data on the `FieldCollection` object, for use in `fieldCollection.set({ ... })`. */ - interface FieldCollectionUpdateData { - items?: Word.Interfaces.FieldData[]; + width?: number; } - /** An interface for updating data on the `Font` object, for use in `font.set({ ... })`. */ - interface FontUpdateData { + /** An interface for updating data on the `Template` object, for use in `template.set({ ... })`. */ + interface TemplateUpdateData { /** - * Returns a `FillFormat` object that contains fill formatting properties for the font used by the range of text. + * Specifies the East Asian language to use when breaking lines of text in the document or template. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fill?: Word.Interfaces.FillFormatUpdateData; + farEastLineBreakLanguage?: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; /** - * Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text. + * Specifies the line break control level for the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - glow?: Word.Interfaces.GlowFormatUpdateData; + farEastLineBreakLevel?: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"; /** - * Returns a `LineFormat` object that specifies the formatting for a line. + * Specifies whether the spelling and grammar checker ignores documents based on this template. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - line?: Word.Interfaces.LineFormatUpdateData; + hasNoProofing?: boolean; /** - * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. + * Specifies the character spacing adjustment for the template. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - reflection?: Word.Interfaces.ReflectionFormatUpdateData; + justificationMode?: Word.JustificationMode | "Expand" | "Compress" | "CompressKana"; /** - * Returns a `ColorFormat` object that represents the color for the font. + * Specifies if Microsoft Word kerns half-width Latin characters and punctuation marks in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textColor?: Word.Interfaces.ColorFormatUpdateData; + kerningByAlgorithm?: boolean; /** - * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. + * Specifies a `LanguageId` value that represents the language in the template. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textShadow?: Word.Interfaces.ShadowFormatUpdateData; + languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font. + * Specifies an East Asian language for the language in the template. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - threeDimensionalFormat?: Word.Interfaces.ThreeDimensionalFormatUpdateData; + languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies whether the font is formatted as all capital letters, 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. + * Specifies the kinsoku characters after which Microsoft Word will not break a line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - allCaps?: boolean; - /** - * Specifies a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false. - * - * @remarks - * [Api set: WordApi 1.1] - */ - bold?: boolean; + noLineBreakAfter?: string; /** - * Specifies whether the font is formatted as bold in a right-to-left language document. 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. + * Specifies the kinsoku characters before which Microsoft Word will not break a line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - boldBidirectional?: boolean; - /** - * Specifies the color for the specified font. You can provide the value in the '#RRGGBB' format or the color name. - * - * @remarks - * [Api set: WordApi 1.1] - */ - color?: string; + noLineBreakBefore?: string; /** - * Specifies a `ColorIndex` value that represents the color for the font. + * Specifies `true` if the template has not changed since it was last saved, `false` if Microsoft Word displays a prompt to save changes when the document is closed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - colorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + saved?: boolean; + } + /** An interface for updating data on the `TemplateCollection` object, for use in `templateCollection.set({ ... })`. */ + interface TemplateCollectionUpdateData { + items?: Word.Interfaces.TemplateData[]; + } + /** An interface for updating data on the `TrackedChangeCollection` object, for use in `trackedChangeCollection.set({ ... })`. */ + interface TrackedChangeCollectionUpdateData { + items?: Word.Interfaces.TrackedChangeData[]; + } + /** An interface for updating data on the `View` object, for use in `view.set({ ... })`. */ + interface ViewUpdateData { /** - * Specifies the color for the `Font` object in a right-to-left language document. + * Specifies whether all nonprinting characters are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - colorIndexBidirectional?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + areAllNonprintingCharactersDisplayed?: boolean; /** - * Specifies whether contextual alternates are enabled for the font. + * Gets whether background colors and images are shown when the document is displayed in print layout view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contextualAlternates?: boolean; + areBackgroundsDisplayed?: boolean; /** - * Specifies the color to be used for diacritics for the `Font` object. You can provide the value in the '#RRGGBB' format. + * Specifies whether Microsoft Word displays the comments in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - diacriticColor?: string; + areCommentsDisplayed?: boolean; /** - * Specifies whether Microsoft Word ignores the number of characters per line for the corresponding `Font` object. + * Specifies whether Microsoft Word displays connecting lines from the text to the revision and comment balloons. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - disableCharacterSpaceGrid?: boolean; - /** - * Specifies a value that indicates whether the font has a double strikethrough. True if the font is formatted as double strikethrough text, otherwise, false. - * - * @remarks - * [Api set: WordApi 1.1] - */ - doubleStrikeThrough?: boolean; + areConnectingLinesToRevisionsBalloonDisplayed?: boolean; /** - * Specifies whether the font is formatted as embossed. The possible values are as follows: - - - `true`: All the text is embossed. - - - `false`: None of the text is embossed. - - - `null`: Returned if some, but not all, of the text is embossed. + * Specifies whether shading is applied to the ranges in the document that users have permission to modify. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - emboss?: boolean; + areEditableRangesShaded?: boolean; /** - * Specifies an `EmphasisMark` value that represents the emphasis mark for a character or designated character string. + * Specifies whether field codes are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - emphasisMark?: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle"; + areFieldCodesDisplayed?: boolean; /** - * Specifies whether the font is formatted as engraved. The possible values are as follows: - - - `true`: All the text is engraved. - - - `false`: None of the text is engraved. - - - `null`: Returned if some, but not all, of the text is engraved. + * Specifies whether Microsoft Word displays formatting changes made to the document with Track Changes enabled. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - engrave?: boolean; - /** - * Specifies a value that indicates whether the font is tagged as hidden. True if the font is formatted as hidden text, otherwise, false. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - hidden?: boolean; - /** - * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or `null` for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. - * - * @remarks - * [Api set: WordApi 1.1] - */ - highlightColor?: string; - /** - * Specifies a value that indicates whether the font is italicized. True if the font is italicized, otherwise, false. - * - * @remarks - * [Api set: WordApi 1.1] - */ - italic?: boolean; + areFormatChangesDisplayed?: boolean; /** - * Specifies whether the font is italicized in a right-to-left language document. 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. + * Specifies whether handwritten ink annotations are shown or hidden. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - italicBidirectional?: boolean; + areInkAnnotationsDisplayed?: boolean; /** - * Specifies the minimum font size for which Microsoft Word will adjust kerning automatically. + * Specifies whether Microsoft Word displays insertions and deletions made to the document with Track Changes enabled. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - kerning?: number; + areInsertionsAndDeletionsDisplayed?: boolean; /** - * Specifies the ligature setting for the `Font` object. + * Gets whether other authors' presence should be visible in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - ligature?: Word.Ligature | "None" | "Standard" | "Contextual" | "StandardContextual" | "Historical" | "StandardHistorical" | "ContextualHistorical" | "StandardContextualHistorical" | "Discretional" | "StandardDiscretional" | "ContextualDiscretional" | "StandardContextualDiscretional" | "HistoricalDiscretional" | "StandardHistoricalDiscretional" | "ContextualHistoricalDiscretional" | "All"; - /** - * Specifies a value that represents the name of the font. - * - * @remarks - * [Api set: WordApi 1.1] - */ - name?: string; + areOtherAuthorsVisible?: boolean; /** - * Specifies the font used for Latin text (characters with character codes from 0 (zero) through 127). + * Specifies whether Microsoft Word displays revisions and comments made to the document with Track Changes enabled. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nameAscii?: string; + areRevisionsAndCommentsDisplayed?: boolean; /** - * Specifies the font name in a right-to-left language document. + * Specifies whether table gridlines are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nameBidirectional?: string; + areTableGridlinesDisplayed?: boolean; /** - * Specifies the East Asian font name. + * Specifies the column width in Reading mode. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nameFarEast?: string; + columnWidth?: Word.ColumnWidth | "Narrow" | "Default" | "Wide"; /** - * Specifies the font used for characters with codes from 128 through 255. + * Specifies whether all the text in a window is displayed in the same sans-serif font with minimal formatting to speed up display. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nameOther?: string; + isDraft?: boolean; /** - * Specifies the number form setting for an OpenType font. + * Specifies whether only the first line of body text is shown in outline view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - numberForm?: Word.NumberForm | "Default" | "Lining" | "OldStyle"; + isFirstLineOnlyDisplayed?: boolean; /** - * Specifies the number spacing setting for the font. + * Specifies whether character formatting is visible in outline view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - numberSpacing?: Word.NumberSpacing | "Default" | "Proportional" | "Tabular"; + isFormatDisplayed?: boolean; /** - * Specifies if the font is formatted as outlined. The possible values are as follows: - - - `true`: All the text is outlined. - - - `false`: None of the text is outlined. - - - `null`: Returned if some, but not all, of the text is outlined. + * Specifies whether the window is in full-screen view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - outline?: boolean; + isFullScreen?: boolean; /** - * Specifies the position of text (in points) relative to the base line. + * Specifies whether the document is in conflict mode view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - position?: number; + isInConflictMode?: boolean; /** - * Specifies the scaling percentage applied to the font. + * Specifies whether Microsoft Word is in Panning mode. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - scaling?: number; + isInPanning?: boolean; /** - * Specifies if the font is formatted as shadowed. The possible values are as follows: - - - `true`: All the text is shadowed. - - - `false`: None of the text is shadowed. - - - `null`: Returned if some, but not all, of the text is shadowed. + * Specifies whether the document is being viewed in reading layout view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shadow?: boolean; - /** - * Specifies a value that represents the font size in points. - * - * @remarks - * [Api set: WordApi 1.1] - */ - size?: number; + isInReadingLayout?: boolean; /** - * Specifies the font size in points for right-to-left text. + * Specifies whether mail merge data is displayed instead of mail merge fields. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sizeBidirectional?: number; + isMailMergeDataView?: boolean; /** - * Specifies whether the font is formatted as small caps, 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. + * Specifies whether the text in the document is visible when the header and footer areas are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - smallCaps?: boolean; + isMainTextLayerVisible?: boolean; /** - * Specifies the spacing between characters. + * Specifies whether the pointer is displayed as a magnifying glass in print preview. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spacing?: number; + isPointerShownAsMagnifier?: boolean; /** - * Specifies a value that indicates whether the font has a strikethrough. True if the font is formatted as strikethrough text, otherwise, false. + * Specifies whether pages displayed in reading layout view are displayed using the same layout as printed pages. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - strikeThrough?: boolean; + isReadingLayoutActualView?: boolean; /** - * Specifies the stylistic set for the font. + * Specifies whether XML tags are visible in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - stylisticSet?: Word.StylisticSet | "Default" | "Set01" | "Set02" | "Set03" | "Set04" | "Set05" | "Set06" | "Set07" | "Set08" | "Set09" | "Set10" | "Set11" | "Set12" | "Set13" | "Set14" | "Set15" | "Set16" | "Set17" | "Set18" | "Set19" | "Set20"; + isXmlMarkupVisible?: boolean; /** - * Specifies a value that indicates whether the font is a subscript. True if the font is formatted as subscript, otherwise, false. + * Specifies the display mode for tracked changes. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - subscript?: boolean; + markupMode?: Word.RevisionsMode | "Balloon" | "Inline" | "Mixed"; /** - * Specifies a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false. + * Specifies the page color in Reading mode. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - superscript?: boolean; + pageColor?: Word.PageColor | "None" | "Sepia" | "Inverse"; /** - * Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined. + * Specifies the page movement type. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; + pageMovementType?: Word.PageMovementType | "Vertical" | "SideToSide"; /** - * Specifies the color of the underline for the `Font` object. You can provide the value in the '#RRGGBB' format. + * Specifies whether margins are visible or hidden when the document is viewed in Full Screen Reading view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - underlineColor?: string; - } - /** An interface for updating data on the `Hyperlink` object, for use in `hyperlink.set({ ... })`. */ - interface HyperlinkUpdateData { + readingLayoutTruncateMargins?: Word.ReadingLayoutMargin | "Automatic" | "Suppress" | "Full"; /** - * Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. + * Specifies the width of the revision balloons. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeUpdateData; + revisionsBalloonWidth?: number; /** - * Specifies the address (for example, a file name or URL) of the hyperlink. + * Specifies how Microsoft Word measures the width of revision balloons. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - address?: string; + revisionsBalloonWidthType?: Word.RevisionsBalloonWidthType | "Percent" | "Points"; /** - * Specifies the text string for the hyperlink's subject line. + * Specifies the document element displayed in print layout view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - emailSubject?: string; + seekView?: Word.SeekView | "MainDocument" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "CurrentPageHeader" | "CurrentPageFooter"; /** - * Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink. + * Specifies the active window pane. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - screenTip?: string; + splitSpecial?: Word.SpecialPane | "None" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "FootnoteContinuationNotice" | "FootnoteContinuationSeparator" | "FootnoteSeparator" | "EndnoteContinuationNotice" | "EndnoteContinuationSeparator" | "EndnoteSeparator" | "Comments" | "CurrentPageHeader" | "CurrentPageFooter" | "Revisions" | "RevisionsHoriz" | "RevisionsVert"; /** - * Specifies a named location in the destination of the hyperlink. + * Specifies the view type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - subAddress?: string; + type?: Word.ViewType | "Normal" | "Outline" | "Print" | "PrintPreview" | "Master" | "Web" | "Reading" | "Conflict"; + } + /** An interface for updating data on the `Shape` object, for use in `shape.set({ ... })`. */ + interface ShapeUpdateData { /** - * Specifies the name of the frame or window in which to load the hyperlink. + * Represents the body object of the shape. Only applies to text boxes and geometric shapes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - target?: string; + body?: Word.Interfaces.BodyUpdateData; /** - * Specifies the hyperlink's visible text in the document. + * Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "Canvas". 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - textToDisplay?: string; - } - /** An interface for updating data on the `HyperlinkCollection` object, for use in `hyperlinkCollection.set({ ... })`. */ - interface HyperlinkCollectionUpdateData { - items?: Word.Interfaces.HyperlinkData[]; - } - /** An interface for updating data on the `InlinePicture` object, for use in `inlinePicture.set({ ... })`. */ - interface InlinePictureUpdateData { + canvas?: Word.Interfaces.CanvasUpdateData; /** - * Specifies a string that represents the alternative text associated with the inline image. + * Returns the fill formatting of the shape. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - altTextDescription?: string; + fill?: Word.Interfaces.ShapeFillUpdateData; /** - * Specifies a string that contains the title for the inline image. + * Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - altTextTitle?: string; + parentCanvas?: Word.Interfaces.ShapeUpdateData; /** - * Specifies a number that describes the height of the inline image. + * Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - height?: number; + parentGroup?: Word.Interfaces.ShapeUpdateData; /** - * Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. + * Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "GroupShape". 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: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - hyperlink?: string; + shapeGroup?: Word.Interfaces.ShapeGroupUpdateData; /** - * Specifies a value that indicates whether the inline image retains its original proportions when you resize it. + * Gets the text frame object of the shape. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - lockAspectRatio?: boolean; + textFrame?: Word.Interfaces.TextFrameUpdateData; /** - * Specifies a number that describes the width of the inline image. + * Returns the text wrap formatting of the shape. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - width?: number; - } - /** An interface for updating data on the `InlinePictureCollection` object, for use in `inlinePictureCollection.set({ ... })`. */ - interface InlinePictureCollectionUpdateData { - items?: Word.Interfaces.InlinePictureData[]; - } - /** An interface for updating data on the `LinkFormat` object, for use in `linkFormat.set({ ... })`. */ - interface LinkFormatUpdateData { + textWrap?: Word.Interfaces.ShapeTextWrapUpdateData; /** - * Specifies if the link is updated automatically when the container file is opened or when the source file is changed. + * Specifies whether a given shape can overlap other shapes. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - isAutoUpdated?: boolean; + allowOverlap?: boolean; /** - * Specifies if a `Field`, `InlineShape`, or `Shape` object is locked to prevent automatic updating. + * Specifies a string that represents the alternative text associated with the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - isLocked?: boolean; + altTextDescription?: string; /** - * Specifies if the linked picture is saved with the document. + * The geometric shape type of the shape. It will be null if isn't a geometric shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - isPictureSavedWithDocument?: boolean; + geometricShapeType?: Word.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"; /** - * Specifies the path and name of the source file for the linked OLE object, picture, or field. + * The height, in points, of the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - sourceFullName?: string; - } - /** An interface for updating data on the `ListCollection` object, for use in `listCollection.set({ ... })`. */ - interface ListCollectionUpdateData { - items?: Word.Interfaces.ListData[]; - } - /** An interface for updating data on the `ListItem` object, for use in `listItem.set({ ... })`. */ - interface ListItemUpdateData { + height?: number; /** - * Specifies the level of the item in the list. + * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - level?: number; - } - /** An interface for updating data on the `ListLevel` object, for use in `listLevel.set({ ... })`. */ - interface ListLevelUpdateData { + heightRelative?: number; /** - * Gets a Font object that represents the character formatting of the specified object. + * The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.2] */ - font?: Word.Interfaces.FontUpdateData; + left?: number; /** - * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. + * The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.2] */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + leftRelative?: number; /** - * Specifies the name of the style that's linked to the specified list level object. + * Specifies if the aspect ratio of this shape is locked. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.2] */ - linkedStyle?: string; + lockAspectRatio?: boolean; /** - * Specifies the number format for the specified list level. + * The name of the shape. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.2] */ - numberFormat?: string; + name?: string; /** - * Specifies the position (in points) of the number or bullet for the specified list level object. + * The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.2] */ - numberPosition?: number; + relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies the number style for the list level object. + * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.2] */ - numberStyle?: Word.ListBuiltInNumberStyle | "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter" | "Ordinal" | "CardinalText" | "OrdinalText" | "Kanji" | "KanjiDigit" | "AiueoHalfWidth" | "IrohaHalfWidth" | "ArabicFullWidth" | "KanjiTraditional" | "KanjiTraditional2" | "NumberInCircle" | "Aiueo" | "Iroha" | "ArabicLZ" | "Bullet" | "Ganada" | "Chosung" | "GBNum1" | "GBNum2" | "GBNum3" | "GBNum4" | "Zodiac1" | "Zodiac2" | "Zodiac3" | "TradChinNum1" | "TradChinNum2" | "TradChinNum3" | "TradChinNum4" | "SimpChinNum1" | "SimpChinNum2" | "SimpChinNum3" | "SimpChinNum4" | "HanjaRead" | "HanjaReadDigit" | "Hangul" | "Hanja" | "Hebrew1" | "Arabic1" | "Hebrew2" | "Arabic2" | "HindiLetter1" | "HindiLetter2" | "HindiArabic" | "HindiCardinalText" | "ThaiLetter" | "ThaiArabic" | "ThaiCardinalText" | "VietCardinalText" | "LowercaseRussian" | "UppercaseRussian" | "LowercaseGreek" | "UppercaseGreek" | "ArabicLZ2" | "ArabicLZ3" | "ArabicLZ4" | "LowercaseTurkish" | "UppercaseTurkish" | "LowercaseBulgarian" | "UppercaseBulgarian" | "PictureBullet" | "Legal" | "LegalLZ"; + relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies the list level that must appear before the specified list level restarts numbering at 1. + * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.2] */ - resetOnHigher?: number; + relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies the starting number for the specified list level object. + * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.2] */ - startAt?: number; + relativeVerticalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies the tab position for the specified list level object. + * Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.2] */ - tabPosition?: number; + rotation?: number; /** - * Specifies the position (in points) for the second line of wrapping text for the specified list level object. + * The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.2] */ - textPosition?: number; + top?: number; /** - * Specifies the character inserted after the number for the specified list level. + * The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.2] */ - trailingCharacter?: Word.TrailingCharacter | "TrailingTab" | "TrailingSpace" | "TrailingNone"; - } - /** An interface for updating data on the `ListLevelCollection` object, for use in `listLevelCollection.set({ ... })`. */ - interface ListLevelCollectionUpdateData { - items?: Word.Interfaces.ListLevelData[]; - } - /** An interface for updating data on the `ListTemplate` object, for use in `listTemplate.set({ ... })`. */ - interface ListTemplateUpdateData { + topRelative?: number; /** - * Specifies whether the list template is outline numbered. + * Specifies if the shape is visible. Not applicable to inline shapes. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.2] */ - outlineNumbered?: boolean; - } - /** An interface for updating data on the `NoteItem` object, for use in `noteItem.set({ ... })`. */ - interface NoteItemUpdateData { + visible?: boolean; /** - * Represents the body object of the note item. It's the portion of the text within the footnote or endnote. + * The width, in points, of the shape. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - body?: Word.Interfaces.BodyUpdateData; + width?: number; /** - * Represents a footnote or endnote reference in the main document. + * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - reference?: Word.Interfaces.RangeUpdateData; - } - /** An interface for updating data on the `NoteItemCollection` object, for use in `noteItemCollection.set({ ... })`. */ - interface NoteItemCollectionUpdateData { - items?: Word.Interfaces.NoteItemData[]; + widthRelative?: number; } - /** An interface for updating data on the `OleFormat` object, for use in `oleFormat.set({ ... })`. */ - interface OleFormatUpdateData { + /** An interface for updating data on the `ShapeGroup` object, for use in `shapeGroup.set({ ... })`. */ + interface ShapeGroupUpdateData { /** - * Specifies the class type for the specified OLE object, picture, or field. + * Gets the Shape object associated with the group. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - classType?: string; + shape?: Word.Interfaces.ShapeUpdateData; + } + /** An interface for updating data on the `Canvas` object, for use in `canvas.set({ ... })`. */ + interface CanvasUpdateData { /** - * Specifies the icon that is used when the `displayAsIcon` property is `true`. + * Gets the Shape object associated with the canvas. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - iconIndex?: number; + shape?: Word.Interfaces.ShapeUpdateData; + } + /** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */ + interface ShapeCollectionUpdateData { + items?: Word.Interfaces.ShapeData[]; + } + /** An interface for updating data on the `ShapeFill` object, for use in `shapeFill.set({ ... })`. */ + interface ShapeFillUpdateData { /** - * Specifies the text displayed below the icon for the OLE object. + * Specifies the shape fill background color. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - iconLabel?: string; + backgroundColor?: string; /** - * Specifies the program file in which the icon for the OLE object is stored. + * Specifies the shape fill foreground color. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - iconName?: string; + foregroundColor?: string; /** - * Specifies whether formatting done in Microsoft Word to the linked OLE object is preserved. + * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - isFormattingPreservedOnUpdate?: boolean; - } - /** An interface for updating data on the `PageCollection` object, for use in `pageCollection.set({ ... })`. */ - interface PageCollectionUpdateData { - items?: Word.Interfaces.PageData[]; - } - /** An interface for updating data on the `PaneCollection` object, for use in `paneCollection.set({ ... })`. */ - interface PaneCollectionUpdateData { - items?: Word.Interfaces.PaneData[]; + transparency?: number; } - /** An interface for updating data on the `Window` object, for use in `window.set({ ... })`. */ - interface WindowUpdateData { + /** An interface for updating data on the `TextFrame` object, for use in `textFrame.set({ ... })`. */ + interface TextFrameUpdateData { /** - * Gets the next document window in the collection of open document windows. + * 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - next?: Word.Interfaces.WindowUpdateData; + autoSizeSetting?: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed"; /** - * Gets the previous document window in the collection open document windows. + * Represents the bottom margin, in points, of the text frame. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - previous?: Word.Interfaces.WindowUpdateData; + bottomMargin?: number; /** - * Specifies whether rulers are displayed for the window or pane. + * Represents the left margin, in points, of the text frame. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - areRulersDisplayed?: boolean; + leftMargin?: number; /** - * Specifies whether thumbnail images of the pages in a document are displayed along the left side of the Microsoft Word document window. + * Returns True if text in the text frame shouldn't rotate when the shape is rotated. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - areThumbnailsDisplayed?: boolean; + noTextRotation?: boolean; /** - * Specifies the caption text for the window that is displayed in the title bar of the document or application window. + * Represents the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - caption?: string; + orientation?: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed"; /** - * Specifies the horizontal scroll position as a percentage of the document width. + * Represents the right margin, in points, of the text frame. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - horizontalPercentScrolled?: number; + rightMargin?: number; /** - * Specifies the default start-up mode for the Japanese Input Method Editor (IME). + * Represents the top margin, in points, of the text frame. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - imemode?: Word.ImeMode | "NoControl" | "On" | "Off" | "Hiragana" | "Katakana" | "KatakanaHalf" | "AlphaFull" | "Alpha" | "HangulFull" | "Hangul"; + topMargin?: number; /** - * Specifies whether the document map is visible. + * Represents the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - isDocumentMapVisible?: boolean; + verticalAlignment?: Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom"; /** - * Specifies whether the email message header is visible in the document window. The default value is `False`. + * Determines whether lines break automatically to fit text inside the shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - isEnvelopeVisible?: boolean; + wordWrap?: boolean; + } + /** An interface for updating data on the `ShapeTextWrap` object, for use in `shapeTextWrap.set({ ... })`. */ + interface ShapeTextWrapUpdateData { /** - * Specifies whether a horizontal scroll bar is displayed for the window. + * Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - isHorizontalScrollBarDisplayed?: boolean; + bottomDistance?: number; /** - * Specifies whether the vertical scroll bar appears on the left side of the document window. + * Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - isLeftScrollBarDisplayed?: boolean; + leftDistance?: number; /** - * Specifies whether the vertical ruler appears on the right side of the document window in print layout view. + * Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - isRightRulerDisplayed?: boolean; + rightDistance?: number; /** - * Specifies whether the window is split into multiple panes. + * Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farthest from the page margin. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - isSplit?: boolean; + side?: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest"; /** - * Specifies whether a vertical ruler is displayed for the window or pane. + * Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - isVerticalRulerDisplayed?: boolean; + topDistance?: number; /** - * Specifies whether a vertical scroll bar is displayed for the window. + * Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - isVerticalScrollBarDisplayed?: boolean; + type?: Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front"; + } + /** An interface for updating data on the `Reviewer` object, for use in `reviewer.set({ ... })`. */ + interface ReviewerUpdateData { /** - * Specifies whether the window is visible. + * Specifies if the `Reviewer` object is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ isVisible?: boolean; + } + /** An interface for updating data on the `ReviewerCollection` object, for use in `reviewerCollection.set({ ... })`. */ + interface ReviewerCollectionUpdateData { + items?: Word.Interfaces.ReviewerData[]; + } + /** An interface for updating data on the `RevisionsFilter` object, for use in `revisionsFilter.set({ ... })`. */ + interface RevisionsFilterUpdateData { /** - * Specifies how Microsoft Word displays source documents after a compare and merge process. + * Specifies a `RevisionsMarkup` value that represents the extent of reviewer markup displayed in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showSourceDocuments?: Word.ShowSourceDocuments | "None" | "Original" | "Revised" | "Both"; + markup?: Word.RevisionsMarkup | "None" | "Simple" | "All"; /** - * Specifies the vertical split percentage for the window. + * Specifies a `RevisionsView` value that represents globally whether Word displays the original version of the document or the final version, which might have revisions and formatting changes applied. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - splitVertical?: number; + view?: Word.RevisionsView | "Final" | "Original"; + } + /** An interface for updating data on the `RepeatingSectionItem` object, for use in `repeatingSectionItem.set({ ... })`. */ + interface RepeatingSectionItemUpdateData { /** - * Specifies the width of the style area in points. + * Returns the range of this repeating section item, excluding the start and end tags. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - styleAreaWidth?: number; + range?: Word.Interfaces.RangeUpdateData; + } + /** An interface for updating data on the `Revision` object, for use in `revision.set({ ... })`. */ + interface RevisionUpdateData { /** - * Specifies the vertical scroll position as a percentage of the document length. + * Gets a `Range` object that represents the range of text that was moved from one place to another in the document with tracked changes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - verticalPercentScrolled?: number; + movedRange?: Word.Interfaces.RangeUpdateData; /** - * Specifies the state of the document window or task window. + * Gets a `Range` object that represents the portion of the document that's contained within a revision mark. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - windowState?: Word.WindowState | "Normal" | "Maximize" | "Minimize"; + range?: Word.Interfaces.RangeUpdateData; } - /** An interface for updating data on the `WindowCollection` object, for use in `windowCollection.set({ ... })`. */ - interface WindowCollectionUpdateData { - items?: Word.Interfaces.WindowData[]; + /** An interface for updating data on the `RevisionCollection` object, for use in `revisionCollection.set({ ... })`. */ + interface RevisionCollectionUpdateData { + items?: Word.Interfaces.RevisionData[]; } - /** An interface for updating data on the `Paragraph` object, for use in `paragraph.set({ ... })`. */ - interface ParagraphUpdateData { - /** - * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ - font?: Word.Interfaces.FontUpdateData; - /** - * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. - * - * @remarks - * [Api set: WordApi 1.3] - */ - listItem?: Word.Interfaces.ListItemUpdateData; + /** An interface for updating data on the `DatePickerContentControl` object, for use in `datePickerContentControl.set({ ... })`. */ + interface DatePickerContentControlUpdateData { /** - * Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return 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}. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listItemOrNullObject?: Word.Interfaces.ListItemUpdateData; + placeholderText?: Word.Interfaces.BuildingBlockUpdateData; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. + * Gets a `Range` object that represents the contents of the content control in the active document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shading?: Word.Interfaces.ShadingUniversalUpdateData; + range?: Word.Interfaces.RangeUpdateData; /** - * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. + * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + xmlMapping?: Word.Interfaces.XmlMappingUpdateData; /** - * Specifies the value, in points, for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. + * Specifies the appearance of the content control. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - firstLineIndent?: number; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Specifies the left indent value, in points, for the paragraph. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftIndent?: number; + color?: string; /** - * Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. + * Specifies a `CalendarType` value that represents the calendar type for the date picker content control. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineSpacing?: number; + dateCalendarType?: Word.CalendarType | "Western" | "Arabic" | "Hebrew" | "Taiwan" | "Japan" | "Thai" | "Korean" | "SakaEra" | "TranslitEnglish" | "TranslitFrench" | "Umalqura"; /** - * Specifies the amount of spacing, in grid lines, after the paragraph. + * Specifies the format in which dates are displayed. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitAfter?: number; + dateDisplayFormat?: string; /** - * Specifies the amount of spacing, in grid lines, before the paragraph. + * Specifies a `LanguageId` that represents the language format for the date displayed in the date picker content control. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitBefore?: number; + dateDisplayLocale?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies the outline level for the paragraph. + * Specifies a `ContentControlDateStorageFormat` value that represents the format for storage and retrieval of dates when the date picker content control is bound to the XML data store of the active document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - outlineLevel?: number; + dateStorageFormat?: Word.ContentControlDateStorageFormat | "Text" | "Date" | "DateTime"; /** - * Specifies the right indent value, in points, for the paragraph. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightIndent?: number; + isTemporary?: boolean; /** - * Specifies the spacing, in points, after the paragraph. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - spaceAfter?: number; + lockContentControl?: boolean; /** - * Specifies the spacing, in points, before the paragraph. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - spaceBefore?: number; + lockContents?: boolean; /** - * Specifies the style name for the paragraph. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * Specifies a tag to identify the content control. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: string; + tag?: string; /** - * Specifies the built-in style name for the paragraph. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Specifies the title for the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; - } - /** An interface for updating data on the `ParagraphCollection` object, for use in `paragraphCollection.set({ ... })`. */ - interface ParagraphCollectionUpdateData { - items?: Word.Interfaces.ParagraphData[]; + title?: string; } - /** An interface for updating data on the `ParagraphFormat` object, for use in `paragraphFormat.set({ ... })`. */ - interface ParagraphFormatUpdateData { + /** An interface for updating data on the `PictureContentControl` object, for use in `pictureContentControl.set({ ... })`. */ + interface PictureContentControlUpdateData { /** - * Specifies the alignment for the specified paragraphs. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + placeholderText?: Word.Interfaces.BuildingBlockUpdateData; /** - * Specifies the value (in points) for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. + * Returns a `Range` object that represents the contents of the content control in the active document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - firstLineIndent?: number; + range?: Word.Interfaces.RangeUpdateData; /** - * Specifies whether all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document. + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - keepTogether?: boolean; + xmlMapping?: Word.Interfaces.XmlMappingUpdateData; /** - * Specifies whether the specified paragraph remains on the same page as the paragraph that follows it when Microsoft Word repaginates the document. + * Specifies the appearance of the content control. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - keepWithNext?: boolean; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Specifies the left indent. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftIndent?: number; + color?: string; /** - * Specifies the line spacing (in points) for the specified paragraphs. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineSpacing?: number; + isTemporary?: boolean; /** - * Specifies the amount of spacing (in gridlines) after the specified paragraphs. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitAfter?: number; + lockContentControl?: boolean; /** - * Specifies the amount of spacing (in gridlines) before the specified paragraphs. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitBefore?: number; + lockContents?: boolean; /** - * Specifies whether left and right indents are the same width. + * Specifies a tag to identify the content control. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - mirrorIndents?: boolean; + tag?: string; /** - * Specifies the outline level for the specified paragraphs. + * Specifies the title for the content control. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - outlineLevel?: Word.OutlineLevel | "OutlineLevel1" | "OutlineLevel2" | "OutlineLevel3" | "OutlineLevel4" | "OutlineLevel5" | "OutlineLevel6" | "OutlineLevel7" | "OutlineLevel8" | "OutlineLevel9" | "OutlineLevelBodyText"; + title?: string; + } + /** An interface for updating data on the `GroupContentControl` object, for use in `groupContentControl.set({ ... })`. */ + interface GroupContentControlUpdateData { /** - * Specifies the right indent (in points) for the specified paragraphs. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightIndent?: number; + placeholderText?: Word.Interfaces.BuildingBlockUpdateData; /** - * Specifies the amount of spacing (in points) after the specified paragraph or text column. + * Gets a `Range` object that represents the contents of the content control in the active document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - spaceAfter?: number; + range?: Word.Interfaces.RangeUpdateData; /** - * Specifies the spacing (in points) before the specified paragraphs. + * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - spaceBefore?: number; + xmlMapping?: Word.Interfaces.XmlMappingUpdateData; /** - * Specifies whether the first and last lines in the specified paragraph remain on the same page as the rest of the paragraph when Microsoft Word repaginates the document. + * Specifies the appearance of the content control. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - widowControl?: boolean; - } - /** An interface for updating data on the `Range` object, for use in `range.set({ ... })`. */ - interface RangeUpdateData { + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Gets the text format of the range. Use this to get and set font name, size, color, and other properties. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontUpdateData; + color?: string; /** - * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listFormat?: Word.Interfaces.ListFormatUpdateData; + isTemporary?: boolean; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shading?: Word.Interfaces.ShadingUniversalUpdateData; + lockContentControl?: boolean; /** - * Specifies a `CharacterCase` value that represents the case of the text in the range. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - case?: Word.CharacterCase | "Next" | "Lower" | "Upper" | "TitleWord" | "TitleSentence" | "Toggle" | "HalfWidth" | "FullWidth" | "Katakana" | "Hiragana"; + lockContents?: boolean; /** - * Specifies the character width of the range. + * Specifies a tag to identify the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - characterWidth?: Word.CharacterWidth | "Half" | "Full"; + tag?: string; /** - * Specifies if the range contains combined characters. + * Specifies the title for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - combineCharacters?: boolean; + title?: string; + } + /** An interface for updating data on the `BuildingBlockGalleryContentControl` object, for use in `buildingBlockGalleryContentControl.set({ ... })`. */ + interface BuildingBlockGalleryContentControlUpdateData { /** - * Specifies the ending character position of the range. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - end?: number; + placeholderText?: Word.Interfaces.BuildingBlockUpdateData; /** - * Specifies the width (in the current measurement units) in which Microsoft Word fits the text in the current selection or range. + * Returns a `Range` object that represents the contents of the content control in the active document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fitTextWidth?: number; + range?: Word.Interfaces.RangeUpdateData; /** - * Specifies if a grammar check has been run on the range or document. + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - grammarChecked?: boolean; + xmlMapping?: Word.Interfaces.XmlMappingUpdateData; /** - * Specifies the proofing status (spelling and grammar checking) of the range. + * Specifies the appearance of the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hasNoProofing?: boolean; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Specifies the formatting for horizontal text set within vertical text. + * Specifies the category for the building block content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontalInVertical?: Word.HorizontalInVerticalType | "None" | "FitInLine" | "ResizeLine"; + buildingBlockCategory?: string; /** - * Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. Use a '#' to separate the address part from the optional location part. + * Specifies a `BuildingBlockType` value that represents the type of building block for the building block content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - hyperlink?: string; + buildingBlockType?: Word.BuildingBlockType | "QuickParts" | "CoverPage" | "Equations" | "Footers" | "Headers" | "PageNumber" | "Tables" | "Watermarks" | "AutoText" | "TextBox" | "PageNumberTop" | "PageNumberBottom" | "PageNumberPage" | "TableOfContents" | "CustomQuickParts" | "CustomCoverPage" | "CustomEquations" | "CustomFooters" | "CustomHeaders" | "CustomPageNumber" | "CustomTables" | "CustomWatermarks" | "CustomAutoText" | "CustomTextBox" | "CustomPageNumberTop" | "CustomPageNumberBottom" | "CustomPageNumberPage" | "CustomTableOfContents" | "Custom1" | "Custom2" | "Custom3" | "Custom4" | "Custom5" | "Bibliography" | "CustomBibliography"; /** - * Specifies the ID for the range. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: string; + color?: string; /** - * Specifies whether the range of Japanese language text is hiragana or katakana. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - kana?: Word.Kana | "Katakana" | "Hiragana"; + isTemporary?: boolean; /** - * Specifies whether Microsoft Word has detected the language of the text in the range. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageDetected?: boolean; + lockContentControl?: boolean; /** - * Specifies a `LanguageId` value that represents the language for the range. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + lockContents?: boolean; /** - * Specifies an East Asian language for the range. + * Specifies a tag to identify the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + tag?: string; /** - * Specifies a language for the range that isn't classified as an East Asian language. + * Specifies the title for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageIdOther?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + title?: string; + } + /** An interface for updating data on the `RepeatingSectionContentControl` object, for use in `repeatingSectionContentControl.set({ ... })`. */ + interface RepeatingSectionContentControlUpdateData { /** - * Specifies if all nonprinting characters (such as hidden text, tab marks, space marks, and paragraph marks) are displayed. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showAll?: boolean; + placeholderText?: Word.Interfaces.BuildingBlockUpdateData; /** - * Specifies if spelling has been checked throughout the range or document. + * Gets a `Range` object that represents the contents of the content control in the active document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spellingChecked?: boolean; + range?: Word.Interfaces.RangeUpdateData; /** - * Specifies the starting character position of the range. + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - start?: number; + xmlapping?: Word.Interfaces.XmlMappingUpdateData; /** - * Specifies the style name for the range. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: string; + allowInsertDeleteSection?: boolean; /** - * Specifies the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Specifies the appearance of the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Specifies whether Microsoft Word sets two lines of text in one and specifies the characters that enclose the text, if any. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - twoLinesInOne?: Word.TwoLinesInOneType | "None" | "NoBrackets" | "Parentheses" | "SquareBrackets" | "AngleBrackets" | "CurlyBrackets"; - } - /** An interface for updating data on the `RangeCollection` object, for use in `rangeCollection.set({ ... })`. */ - interface RangeCollectionUpdateData { - items?: Word.Interfaces.RangeData[]; - } - /** An interface for updating data on the `SearchOptions` object, for use in `searchOptions.set({ ... })`. */ - interface SearchOptionsUpdateData { + color?: string; /** - * Specifies a value that indicates whether to ignore all punctuation characters between words. Corresponds to the Ignore punctuation check box in the Find and Replace dialog box. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ignorePunct?: boolean; + isTemporary?: boolean; /** - * Specifies a value that indicates whether to ignore all whitespace between words. Corresponds to the Ignore whitespace characters check box in the Find and Replace dialog box. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ignoreSpace?: boolean; + lockContentControl?: boolean; /** - * Specifies a value that indicates whether to perform a case sensitive search. Corresponds to the Match case check box in the Find and Replace dialog box. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - matchCase?: boolean; + lockContents?: boolean; /** - * Specifies a value that indicates whether to match words that begin with the search string. Corresponds to the Match prefix check box in the Find and Replace dialog box. + * Specifies the name of the repeating section items used in the context menu associated with this repeating section content control. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - matchPrefix?: boolean; + repeatingSectionItemTitle?: string; /** - * Specifies a value that indicates whether to match words that end with the search string. Corresponds to the Match suffix check box in the Find and Replace dialog box. + * Specifies a tag to identify the content control. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - matchSuffix?: boolean; + tag?: string; /** - * Specifies a value that indicates whether to find operation only entire words, not text that is part of a larger word. Corresponds to the Find whole words only check box in the Find and Replace dialog box. + * Specifies the title for the content control. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - matchWholeWord?: boolean; + title?: string; + } + /** An interface for updating data on the `Frame` object, for use in `frame.set({ ... })`. */ + interface FrameUpdateData { /** - * Specifies a value that indicates whether the search will be performed using special search operators. Corresponds to the Use wildcards check box in the Find and Replace dialog box. + * Returns a `Range` object that represents the portion of the document that's contained within the frame. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - matchWildcards?: boolean; - } - /** An interface for updating data on the `Section` object, for use in `section.set({ ... })`. */ - interface SectionUpdateData { + range?: Word.Interfaces.RangeUpdateData; /** - * Gets the body object of the section. This doesn't include the header/footer and other section metadata. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - body?: Word.Interfaces.BodyUpdateData; + shading?: Word.Interfaces.ShadingUniversalUpdateData; /** - * Returns a `PageSetup` object that's associated with the section. + * Specifies the height (in points) of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageSetup?: Word.Interfaces.PageSetupUpdateData; + height?: number; /** - * Specifies if the section is protected for forms. + * Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - protectedForForms?: boolean; - } - /** An interface for updating data on the `SectionCollection` object, for use in `sectionCollection.set({ ... })`. */ - interface SectionCollectionUpdateData { - items?: Word.Interfaces.SectionData[]; - } - /** An interface for updating data on the `Setting` object, for use in `setting.set({ ... })`. */ - interface SettingUpdateData { + heightRule?: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; /** - * Specifies the value of the setting. + * Specifies the horizontal distance between the frame and the surrounding text, in points. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - value?: any; - } - /** An interface for updating data on the `SettingCollection` object, for use in `settingCollection.set({ ... })`. */ - interface SettingCollectionUpdateData { - items?: Word.Interfaces.SettingData[]; - } - /** An interface for updating data on the `StyleCollection` object, for use in `styleCollection.set({ ... })`. */ - interface StyleCollectionUpdateData { - items?: Word.Interfaces.StyleData[]; - } - /** An interface for updating data on the `Style` object, for use in `style.set({ ... })`. */ - interface StyleUpdateData { + horizontalDistanceFromText?: number; /** - * Specifies a BorderCollection object that represents all the borders for the specified style. + * Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - borders?: Word.Interfaces.BorderCollectionUpdateData; + horizontalPosition?: number; /** - * Gets a font object that represents the character formatting of the specified style. + * Specifies if the frame is locked. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontUpdateData; + lockAnchor?: boolean; /** - * Returns a `Frame` object that represents the frame formatting for the style. + * Specifies the relative horizontal position of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - frame?: Word.Interfaces.FrameUpdateData; + relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies a link between a paragraph and a character style. + * Specifies the relative vertical position of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - linkStyle?: Word.Interfaces.StyleUpdateData; + relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Gets a ListTemplate object that represents the list formatting for the specified Style object. + * Specifies if document text wraps around the frame. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listTemplate?: Word.Interfaces.ListTemplateUpdateData; + textWrap?: boolean; /** - * Gets a ParagraphFormat object that represents the paragraph settings for the specified style. + * Specifies the vertical distance (in points) between the frame and the surrounding text. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - paragraphFormat?: Word.Interfaces.ParagraphFormatUpdateData; + verticalDistanceFromText?: number; /** - * Gets a Shading object that represents the shading for the specified style. Not applicable to List style. + * Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shading?: Word.Interfaces.ShadingUpdateData; + verticalPosition?: number; /** - * Gets a TableStyle object representing Style properties that can be applied to a table. + * Specifies the width (in points) of the frame. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tableStyle?: Word.Interfaces.TableStyleUpdateData; + width?: number; /** - * Specifies whether the style is automatically redefined based on the selection. + * Specifies the rule used to determine the width of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - automaticallyUpdate?: boolean; + widthRule?: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; + } + /** An interface for updating data on the `FrameCollection` object, for use in `frameCollection.set({ ... })`. */ + interface FrameCollectionUpdateData { + items?: Word.Interfaces.FrameData[]; + } + /** An interface for updating data on the `DocumentLibraryVersionCollection` object, for use in `documentLibraryVersionCollection.set({ ... })`. */ + interface DocumentLibraryVersionCollectionUpdateData { + items?: Word.Interfaces.DocumentLibraryVersionData[]; + } + /** An interface for updating data on the `ListFormat` object, for use in `listFormat.set({ ... })`. */ + interface ListFormatUpdateData { /** - * Specifies the name of an existing style to use as the base formatting of another style. + * Gets the list template associated with the `ListFormat` object. * * @remarks - * [Api set: WordApi 1.5] - * - * Note: The ability to set `baseStyle` was introduced in WordApi 1.6. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - baseStyle?: string; + listTemplate?: Word.Interfaces.ListTemplateUpdateData; /** - * Specifies whether the spelling and grammar checker ignores text formatted with this style. + * Specifies the list level number for the first paragraph for the `ListFormat` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hasProofing?: boolean; + listLevelNumber?: number; + } + /** An interface for updating data on the `FillFormat` object, for use in `fillFormat.set({ ... })`. */ + interface FillFormatUpdateData { /** - * Specifies a `LanguageId` value that represents the language for the style. + * Returns a `ColorFormat` object that represents the background color for the fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + backgroundColor?: Word.Interfaces.ColorFormatUpdateData; /** - * Specifies an East Asian language for the style. + * Returns a `ColorFormat` object that represents the foreground color for the fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + foregroundColor?: Word.Interfaces.ColorFormatUpdateData; /** - * Specifies whether the style cannot be changed or edited. + * Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - locked?: boolean; + gradientAngle?: number; /** - * Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style. + * Specifies if the object, or the formatting applied to it, is visible. * * @remarks - * [Api set: WordApi 1.5] - * - * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - nextParagraphStyle?: string; + isVisible?: boolean; /** - * Specifies whether to remove spacing between paragraphs that are formatted using the same style. + * Specifies whether the fill rotates with the shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - noSpaceBetweenParagraphsOfSameStyle?: boolean; + rotateWithObject?: boolean; /** - * Specifies the priority. + * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - priority?: number; + textureAlignment?: Word.TextureAlignment | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "Center" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; /** - * Specifies whether the style corresponds to an available quick style. + * Specifies the horizontal scaling factor for the texture fill. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - quickStyle?: boolean; + textureHorizontalScale?: number; /** - * Specifies whether the specified style is made visible as a recommended style in the Styles and in the Styles task pane in Microsoft Word after it's used in the document. + * Specifies the horizontal offset of the texture from the origin in points. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - unhideWhenUsed?: boolean; + textureOffsetX?: number; /** - * Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane. + * Specifies the vertical offset of the texture. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - visibility?: boolean; - } - /** An interface for updating data on the `Shading` object, for use in `shading.set({ ... })`. */ - interface ShadingUpdateData { + textureOffsetY?: number; /** - * Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies whether the texture is tiled. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - backgroundPatternColor?: string; + textureTile?: boolean; /** - * Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies the vertical scaling factor for the texture fill as a value between 0.0 and 1.0. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - foregroundPatternColor?: string; + textureVerticalScale?: number; /** - * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. + * Specifies the degree of transparency of the fill for a shape as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - texture?: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; + transparency?: number; } - /** An interface for updating data on the `ShadingUniversal` object, for use in `shadingUniversal.set({ ... })`. */ - interface ShadingUniversalUpdateData { + /** An interface for updating data on the `GlowFormat` object, for use in `glowFormat.set({ ... })`. */ + interface GlowFormatUpdateData { /** - * Specifies the color that's applied to the background of the `ShadingUniversal` object. You can provide the value in the '#RRGGBB' format. + * Returns a `ColorFormat` object that represents the color for a glow effect. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - backgroundPatternColor?: string; + color?: Word.Interfaces.ColorFormatUpdateData; /** - * Specifies the color that's applied to the background of the `ShadingUniversal` object. + * Specifies the length of the radius for a glow effect. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - backgroundPatternColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + radius?: number; /** - * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. You can provide the value in the '#RRGGBB' format. + * Specifies the degree of transparency for the glow effect as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - foregroundPatternColor?: string; + transparency?: number; + } + /** An interface for updating data on the `LineFormat` object, for use in `lineFormat.set({ ... })`. */ + interface LineFormatUpdateData { /** - * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. + * Gets a `ColorFormat` object that represents the background color for a patterned line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - foregroundPatternColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + backgroundColor?: Word.Interfaces.ColorFormatUpdateData; /** - * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. + * Gets a `ColorFormat` object that represents the foreground color for the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - texture?: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; - } - /** An interface for updating data on the `Table` object, for use in `table.set({ ... })`. */ - interface TableUpdateData { + foregroundColor?: Word.Interfaces.ColorFormatUpdateData; /** - * Gets the font. Use this to get and set font name, size, color, and other properties. + * Specifies the length of the arrowhead at the beginning of the line. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontUpdateData; + beginArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; /** - * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. + * Specifies the style of the arrowhead at the beginning of the line. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + beginArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; /** - * Specifies the number of header rows. + * Specifies the width of the arrowhead at the beginning of the line. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - headerRowCount?: number; + beginArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; /** - * Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Specifies the dash style for the line. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + dashStyle?: Word.LineDashStyle | "Mixed" | "Solid" | "SquareDot" | "RoundDot" | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "SysDash" | "SysDot" | "SysDashDot"; /** - * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * Specifies the length of the arrowhead at the end of the line. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shadingColor?: string; + endArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; /** - * Specifies the style name for the table. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * Specifies the style of the arrowhead at the end of the line. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: string; + endArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; /** - * Specifies whether the table has banded columns. + * Specifies the width of the arrowhead at the end of the line. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBandedColumns?: boolean; + endArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; /** - * Specifies whether the table has banded rows. + * Specifies if to draw lines inside a shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBandedRows?: boolean; + insetPen?: boolean; /** - * Specifies the built-in style name for the table. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Specifies if the object, or the formatting applied to it, is visible. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + isVisible?: boolean; /** - * Specifies whether the table has a first column with a special style. + * Specifies the pattern applied to the line. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleFirstColumn?: boolean; + pattern?: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"; /** - * Specifies whether the table has a last column with a special style. + * Specifies the line format style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleLastColumn?: boolean; + style?: Word.LineFormatStyle | "Mixed" | "Single" | "ThinThin" | "ThinThick" | "ThickThin" | "ThickBetweenThin"; /** - * Specifies whether the table has a total (last) row with a special style. + * Specifies the degree of transparency of the line as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleTotalRow?: boolean; + transparency?: number; /** - * Specifies the text values in the table, as a 2D JavaScript array. + * Specifies the thickness of the line in points. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - values?: string[][]; + weight?: number; + } + /** An interface for updating data on the `ReflectionFormat` object, for use in `reflectionFormat.set({ ... })`. */ + interface ReflectionFormatUpdateData { /** - * Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. + * Specifies the degree of blur effect applied to the `ReflectionFormat` object as a value between 0.0 and 100.0. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + blur?: number; /** - * Specifies the width of the table in points. + * Specifies the amount of separation, in points, of the reflected image from the shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: number; - } - /** An interface for updating data on the `TableStyle` object, for use in `tableStyle.set({ ... })`. */ - interface TableStyleUpdateData { + offset?: number; /** - * Specifies the table's alignment against the page margin. + * Specifies the size of the reflection as a percentage of the reflected shape from 0 to 100. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + size?: number; /** - * Specifies whether lines in tables formatted with a specified style break across pages. + * Specifies the degree of transparency for the reflection effect as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - allowBreakAcrossPage?: boolean; + transparency?: number; /** - * Specifies the amount of space to add between the contents and the bottom borders of the cells. + * Specifies a `ReflectionType` value that represents the type and direction of the lighting for a shape reflection. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bottomCellMargin?: number; + type?: Word.ReflectionType | "Mixed" | "None" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9"; + } + /** An interface for updating data on the `ColorFormat` object, for use in `colorFormat.set({ ... })`. */ + interface ColorFormatUpdateData { /** - * Specifies the spacing (in points) between the cells in a table style. + * Specifies the brightness of a specified shape color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - cellSpacing?: number; + brightness?: number; /** - * Specifies the amount of space to add between the contents and the left borders of the cells. + * Specifies the theme color for a color format. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftCellMargin?: number; + objectThemeColor?: Word.ThemeColorIndex | "NotThemeColor" | "MainDark1" | "MainLight1" | "MainDark2" | "MainLight2" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Hyperlink" | "HyperlinkFollowed" | "Background1" | "Text1" | "Background2" | "Text2"; /** - * Specifies the amount of space to add between the contents and the right borders of the cells. + * Specifies the red-green-blue (RGB) value of the specified color. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightCellMargin?: number; + rgb?: string; /** - * Specifies the amount of space to add between the contents and the top borders of the cells. + * Specifies the lightening or darkening of a specified shape's color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topCellMargin?: number; - } - /** An interface for updating data on the `TabStopCollection` object, for use in `tabStopCollection.set({ ... })`. */ - interface TabStopCollectionUpdateData { - items?: Word.Interfaces.TabStopData[]; - } - /** An interface for updating data on the `TableCollection` object, for use in `tableCollection.set({ ... })`. */ - interface TableCollectionUpdateData { - items?: Word.Interfaces.TableData[]; + tintAndShade?: number; } - /** An interface for updating data on the `TableColumn` object, for use in `tableColumn.set({ ... })`. */ - interface TableColumnUpdateData { + /** An interface for updating data on the `ShadowFormat` object, for use in `shadowFormat.set({ ... })`. */ + interface ShadowFormatUpdateData { /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the column. + * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shading?: Word.Interfaces.ShadingUniversalUpdateData; + foregroundColor?: Word.Interfaces.ColorFormatUpdateData; /** - * Specifies the preferred width (in points or as a percentage of the window width) for the column. - The unit of measurement can be specified by the `preferredWidthType` property. + * Specifies the blur level for a shadow format as a value between 0.0 and 100.0. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - preferredWidth?: number; + blur?: number; /** - * Specifies the preferred unit of measurement to use for the width of the table column. + * Specifies whether the object or the formatting applied to it is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - preferredWidthType?: Word.PreferredWidthType | "Auto" | "Percent" | "Points"; + isVisible?: boolean; /** - * Specifies the width of the column, in points. + * Specifies `true` if the shadow of the shape appears filled in and is obscured by the shape, even if the shape has no fill, + `false` if the shadow has no fill and the outline of the shadow is visible through the shape if the shape has no fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - width?: number; - } - /** An interface for updating data on the `TableColumnCollection` object, for use in `tableColumnCollection.set({ ... })`. */ - interface TableColumnCollectionUpdateData { - items?: Word.Interfaces.TableColumnData[]; - } - /** An interface for updating data on the `TableRow` object, for use in `tableRow.set({ ... })`. */ - interface TableRowUpdateData { + obscured?: boolean; /** - * Gets the font. Use this to get and set font name, size, color, and other properties. + * Specifies the horizontal offset (in points) of the shadow from the shape. + A positive value offsets the shadow to the right of the shape; a negative value offsets it to the left. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontUpdateData; + offsetX?: number; /** - * Specifies the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Specifies the vertical offset (in points) of the shadow from the shape. + A positive value offsets the shadow to the top of the shape; a negative value offsets it to the bottom. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + offsetY?: number; /** - * Specifies the preferred height of the row in points. + * Specifies whether to rotate the shadow when rotating the shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - preferredHeight?: number; + rotateWithShape?: boolean; /** - * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * Specifies the width of the shadow. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shadingColor?: string; + size?: number; /** - * Specifies the text values in the row, as a 2D JavaScript array. + * Specifies the type of shadow formatting to apply to a shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - values?: string[][]; + style?: Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow"; /** - * Specifies the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'. + * Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; - } - /** An interface for updating data on the `TableRowCollection` object, for use in `tableRowCollection.set({ ... })`. */ - interface TableRowCollectionUpdateData { - items?: Word.Interfaces.TableRowData[]; - } - /** An interface for updating data on the `TableCell` object, for use in `tableCell.set({ ... })`. */ - interface TableCellUpdateData { + transparency?: number; /** - * Gets the body object of the cell. + * Specifies the shape shadow type. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - body?: Word.Interfaces.BodyUpdateData; + type?: Word.ShadowType | "Mixed" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9" | "Type10" | "Type11" | "Type12" | "Type13" | "Type14" | "Type15" | "Type16" | "Type17" | "Type18" | "Type19" | "Type20" | "Type21" | "Type22" | "Type23" | "Type24" | "Type25" | "Type26" | "Type27" | "Type28" | "Type29" | "Type30" | "Type31" | "Type32" | "Type33" | "Type34" | "Type35" | "Type36" | "Type37" | "Type38" | "Type39" | "Type40" | "Type41" | "Type42" | "Type43"; + } + /** An interface for updating data on the `ThreeDimensionalFormat` object, for use in `threeDimensionalFormat.set({ ... })`. */ + interface ThreeDimensionalFormatUpdateData { /** - * Specifies the width of the cell's column in points. This is applicable to uniform tables. + * Returns a `ColorFormat` object that represents color of the contour of a shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - columnWidth?: number; + contourColor?: Word.Interfaces.ColorFormatUpdateData; /** - * Specifies the horizontal alignment of the cell. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Returns a `ColorFormat` object that represents the color of the shape's extrusion. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + extrusionColor?: Word.Interfaces.ColorFormatUpdateData; /** - * Specifies the shading color of the cell. Color is specified in "#RRGGBB" format or by using the color name. + * Specifies the depth of the bottom bevel. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shadingColor?: string; + bevelBottomDepth?: number; /** - * Specifies the text of the cell. + * Specifies the inset size for the bottom bevel. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - value?: string; + bevelBottomInset?: number; /** - * Specifies the vertical alignment of the cell. The value can be 'Top', 'Center', or 'Bottom'. + * Specifies a `BevelType` value that represents the bevel type for the bottom bevel. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; - } - /** An interface for updating data on the `TableCellCollection` object, for use in `tableCellCollection.set({ ... })`. */ - interface TableCellCollectionUpdateData { - items?: Word.Interfaces.TableCellData[]; - } - /** An interface for updating data on the `TableBorder` object, for use in `tableBorder.set({ ... })`. */ - interface TableBorderUpdateData { + bevelBottomType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; /** - * Specifies the table border color. + * Specifies the depth of the top bevel. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - color?: string; + bevelTopDepth?: number; /** - * Specifies the type of the table border. + * Specifies the inset size for the top bevel. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + bevelTopInset?: number; /** - * Specifies the width, in points, of the table border. Not applicable to table border types that have fixed widths. + * Specifies a `BevelType` value that represents the bevel type for the top bevel. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: number; - } - /** An interface for updating data on the `Template` object, for use in `template.set({ ... })`. */ - interface TemplateUpdateData { + bevelTopType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; /** - * Specifies the East Asian language to use when breaking lines of text in the document or template. + * Specifies the width of the contour of a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - farEastLineBreakLanguage?: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; + contourWidth?: number; /** - * Specifies the line break control level for the document. + * Specifies the depth of the shape's extrusion. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - farEastLineBreakLevel?: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"; + depth?: number; /** - * Specifies whether the spelling and grammar checker ignores documents based on this template. + * Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion) + and automatically changes when the shape's fill changes, or whether the extrusion color is independent of the shape's fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hasNoProofing?: boolean; + extrusionColorType?: Word.ExtrusionColorType | "mixed" | "automatic" | "custom"; /** - * Specifies the character spacing adjustment for the template. + * Specifies the amount of perspective for a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - justificationMode?: Word.JustificationMode | "Expand" | "Compress" | "CompressKana"; + fieldOfView?: number; /** - * Specifies if Microsoft Word kerns half-width Latin characters and punctuation marks in the document. + * Specifies `true` if the extrusion appears in perspective — that is, if the walls of the extrusion narrow toward a vanishing point, + `false` if the extrusion is a parallel, or orthographic, projection — that is, if the walls don't narrow toward a vanishing point. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - kerningByAlgorithm?: boolean; + isPerspective?: boolean; /** - * Specifies a `LanguageId` value that represents the language in the template. + * Specifies if the specified object, or the formatting applied to it, is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + isVisible?: boolean; /** - * Specifies an East Asian language for the language in the template. + * Specifies the angle of the lighting. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + lightAngle?: number; /** - * Specifies the kinsoku characters after which Microsoft Word will not break a line. + * Specifies a `LightRigType` value that represents the lighting preset. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - noLineBreakAfter?: string; + presetLighting?: Word.LightRigType | "Mixed" | "LegacyFlat1" | "LegacyFlat2" | "LegacyFlat3" | "LegacyFlat4" | "LegacyNormal1" | "LegacyNormal2" | "LegacyNormal3" | "LegacyNormal4" | "LegacyHarsh1" | "LegacyHarsh2" | "LegacyHarsh3" | "LegacyHarsh4" | "ThreePoint" | "Balanced" | "Soft" | "Harsh" | "Flood" | "Contrasting" | "Morning" | "Sunrise" | "Sunset" | "Chilly" | "Freezing" | "Flat" | "TwoPoint" | "Glow" | "BrightRoom"; /** - * Specifies the kinsoku characters before which Microsoft Word will not break a line. + * Specifies the position of the light source relative to the extrusion. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - noLineBreakBefore?: string; + presetLightingDirection?: Word.PresetLightingDirection | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "None" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; /** - * Specifies `true` if the template has not changed since it was last saved, `false` if Microsoft Word displays a prompt to save changes when the document is closed. + * Specifies the intensity of the extrusion lighting. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - saved?: boolean; - } - /** An interface for updating data on the `TemplateCollection` object, for use in `templateCollection.set({ ... })`. */ - interface TemplateCollectionUpdateData { - items?: Word.Interfaces.TemplateData[]; - } - /** An interface for updating data on the `TrackedChangeCollection` object, for use in `trackedChangeCollection.set({ ... })`. */ - interface TrackedChangeCollectionUpdateData { - items?: Word.Interfaces.TrackedChangeData[]; - } - /** An interface for updating data on the `View` object, for use in `view.set({ ... })`. */ - interface ViewUpdateData { + presetLightingSoftness?: Word.PresetLightingSoftness | "Mixed" | "Dim" | "Normal" | "Bright"; /** - * Specifies whether all nonprinting characters are displayed. + * Specifies the extrusion surface material. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areAllNonprintingCharactersDisplayed?: boolean; + presetMaterial?: Word.PresetMaterial | "Mixed" | "Matte" | "Plastic" | "Metal" | "WireFrame" | "Matte2" | "Plastic2" | "Metal2" | "WarmMatte" | "TranslucentPowder" | "Powder" | "DarkEdge" | "SoftEdge" | "Clear" | "Flat" | "SoftMetal"; /** - * Gets whether background colors and images are shown when the document is displayed in print layout view. + * Specifies whether text on a shape rotates with shape. `true` rotates the text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areBackgroundsDisplayed?: boolean; + projectText?: boolean; /** - * Specifies whether Microsoft Word displays the comments in the document. + * Specifies the rotation of the extruded shape around the x-axis in degrees. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areCommentsDisplayed?: boolean; + rotationX?: number; /** - * Specifies whether Microsoft Word displays connecting lines from the text to the revision and comment balloons. + * Specifies the rotation of the extruded shape around the y-axis in degrees. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areConnectingLinesToRevisionsBalloonDisplayed?: boolean; + rotationY?: number; /** - * Specifies whether shading is applied to the ranges in the document that users have permission to modify. + * Specifies the z-axis rotation of the camera. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areEditableRangesShaded?: boolean; + rotationZ?: number; /** - * Specifies whether field codes are displayed. + * Specifies the position on the z-axis for the shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areFieldCodesDisplayed?: boolean; + z?: number; + } + /** An interface for updating data on the `Bibliography` object, for use in `bibliography.set({ ... })`. */ + interface BibliographyUpdateData { /** - * Specifies whether Microsoft Word displays formatting changes made to the document with Track Changes enabled. + * Specifies the name of the active style to use for the bibliography. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areFormatChangesDisplayed?: boolean; + bibliographyStyle?: string; + } + /** An interface for updating data on the `SourceCollection` object, for use in `sourceCollection.set({ ... })`. */ + interface SourceCollectionUpdateData { + items?: Word.Interfaces.SourceData[]; + } + /** An interface for updating data on the `PageSetup` object, for use in `pageSetup.set({ ... })`. */ + interface PageSetupUpdateData { /** - * Specifies whether handwritten ink annotations are shown or hidden. + * Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areInkAnnotationsDisplayed?: boolean; + lineNumbering?: Word.Interfaces.LineNumberingUpdateData; /** - * Specifies whether Microsoft Word displays insertions and deletions made to the document with Track Changes enabled. + * Specifies whether Microsoft Word prints the document as a booklet. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areInsertionsAndDeletionsDisplayed?: boolean; + bookFoldPrinting?: boolean; /** - * Gets whether other authors' presence should be visible in the document. + * Specifies the number of pages for each booklet. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areOtherAuthorsVisible?: boolean; + bookFoldPrintingSheets?: number; /** - * Specifies whether Microsoft Word displays revisions and comments made to the document with Track Changes enabled. + * Specifies if Microsoft Word reverses the printing order for book fold printing of bidirectional or Asian language documents. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areRevisionsAndCommentsDisplayed?: boolean; + bookFoldReversePrinting?: boolean; /** - * Specifies whether table gridlines are displayed. + * Specifies the distance (in points) between the bottom edge of the page and the bottom boundary of the body text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areTableGridlinesDisplayed?: boolean; + bottomMargin?: number; /** - * Specifies the column width in Reading mode. + * Specifies the number of characters per line in the document grid. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - columnWidth?: Word.ColumnWidth | "Narrow" | "Default" | "Wide"; + charsLine?: number; /** - * Specifies whether all the text in a window is displayed in the same sans-serif font with minimal formatting to speed up display. + * Specifies whether the first page has a different header and footer. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isDraft?: boolean; + differentFirstPageHeaderFooter?: boolean; /** - * Specifies whether only the first line of body text is shown in outline view. + * Specifies the distance between the footer and the bottom of the page in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isFirstLineOnlyDisplayed?: boolean; + footerDistance?: number; /** - * Specifies whether character formatting is visible in outline view. + * Specifies the amount (in points) of extra margin space added to each page in a document or section for binding. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isFormatDisplayed?: boolean; + gutter?: number; /** - * Specifies whether the window is in full-screen view. + * Specifies on which side the gutter appears in a document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isFullScreen?: boolean; + gutterPosition?: Word.GutterPosition | "Left" | "Right" | "Top"; /** - * Specifies whether the document is in conflict mode view. + * Specifies whether Microsoft Word uses gutters for the current document based on a right-to-left language or a left-to-right language. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isInConflictMode?: boolean; + gutterStyle?: Word.GutterStyle | "Bidirectional" | "Latin"; /** - * Specifies whether Microsoft Word is in Panning mode. + * Specifies the distance between the header and the top of the page in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isInPanning?: boolean; + headerDistance?: number; /** - * Specifies whether the document is being viewed in reading layout view. + * Specifies the layout mode for the current document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isInReadingLayout?: boolean; + layoutMode?: Word.LayoutMode | "Default" | "Grid" | "LineGrid" | "Genko"; /** - * Specifies whether mail merge data is displayed instead of mail merge fields. + * Specifies the distance (in points) between the left edge of the page and the left boundary of the body text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isMailMergeDataView?: boolean; + leftMargin?: number; /** - * Specifies whether the text in the document is visible when the header and footer areas are displayed. + * Specifies the number of lines per page in the document grid. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isMainTextLayerVisible?: boolean; + linesPage?: number; /** - * Specifies whether the pointer is displayed as a magnifying glass in print preview. + * Specifies if the inside and outside margins of facing pages are the same width. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isPointerShownAsMagnifier?: boolean; + mirrorMargins?: boolean; /** - * Specifies whether pages displayed in reading layout view are displayed using the same layout as printed pages. + * Specifies whether odd and even pages have different headers and footers. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isReadingLayoutActualView?: boolean; + oddAndEvenPagesHeaderFooter?: boolean; /** - * Specifies whether XML tags are visible in the document. + * Specifies the orientation of the page. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isXmlMarkupVisible?: boolean; + orientation?: Word.PageOrientation | "Portrait" | "Landscape"; /** - * Specifies the display mode for tracked changes. + * Specifies the page height in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - markupMode?: Word.RevisionsMode | "Balloon" | "Inline" | "Mixed"; + pageHeight?: number; /** - * Specifies the page color in Reading mode. + * Specifies the page width in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageColor?: Word.PageColor | "None" | "Sepia" | "Inverse"; + pageWidth?: number; /** - * Specifies the page movement type. + * Specifies the paper size of the page. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageMovementType?: Word.PageMovementType | "Vertical" | "SideToSide"; + paperSize?: Word.PaperSize | "Size10x14" | "Size11x17" | "Letter" | "LetterSmall" | "Legal" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "CSheet" | "DSheet" | "ESheet" | "FanfoldLegalGerman" | "FanfoldStdGerman" | "FanfoldUS" | "Folio" | "Ledger" | "Note" | "Quarto" | "Statement" | "Tabloid" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC5" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeDL" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "Custom"; /** - * Specifies whether margins are visible or hidden when the document is viewed in Full Screen Reading view. + * Specifies the distance (in points) between the right edge of the page and the right boundary of the body text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readingLayoutTruncateMargins?: Word.ReadingLayoutMargin | "Automatic" | "Suppress" | "Full"; + rightMargin?: number; /** - * Specifies the width of the revision balloons. + * Specifies the reading order and alignment for the specified sections. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - revisionsBalloonWidth?: number; + sectionDirection?: Word.SectionDirection | "RightToLeft" | "LeftToRight"; /** - * Specifies how Microsoft Word measures the width of revision balloons. + * Specifies the type of section break for the specified object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - revisionsBalloonWidthType?: Word.RevisionsBalloonWidthType | "Percent" | "Points"; + sectionStart?: Word.SectionStart | "Continuous" | "NewColumn" | "NewPage" | "EvenPage" | "OddPage"; /** - * Specifies the document element displayed in print layout view. + * Specifies whether to show the grid. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - seekView?: Word.SeekView | "MainDocument" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "CurrentPageHeader" | "CurrentPageFooter"; + showGrid?: boolean; /** - * Specifies the active window pane. + * Specifies if endnotes are printed at the end of the next section that doesn't suppress endnotes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - splitSpecial?: Word.SpecialPane | "None" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "FootnoteContinuationNotice" | "FootnoteContinuationSeparator" | "FootnoteSeparator" | "EndnoteContinuationNotice" | "EndnoteContinuationSeparator" | "EndnoteSeparator" | "Comments" | "CurrentPageHeader" | "CurrentPageFooter" | "Revisions" | "RevisionsHoriz" | "RevisionsVert"; + suppressEndnotes?: boolean; /** - * Specifies the view type. + * Specifies the top margin of the page in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.ViewType | "Normal" | "Outline" | "Print" | "PrintPreview" | "Master" | "Web" | "Reading" | "Conflict"; - } - /** An interface for updating data on the `Shape` object, for use in `shape.set({ ... })`. */ - interface ShapeUpdateData { + topMargin?: number; /** - * Represents the body object of the shape. Only applies to text boxes and geometric shapes. + * Specifies whether to print two pages per sheet. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - body?: Word.Interfaces.BodyUpdateData; + twoPagesOnOne?: boolean; /** - * Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "Canvas". 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 vertical alignment of text on each page in a document or section. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - canvas?: Word.Interfaces.CanvasUpdateData; + verticalAlignment?: Word.PageSetupVerticalAlignment | "Top" | "Center" | "Justify" | "Bottom"; + } + /** An interface for updating data on the `LineNumbering` object, for use in `lineNumbering.set({ ... })`. */ + interface LineNumberingUpdateData { /** - * Returns the fill formatting of the shape. + * Specifies the numeric increment for line numbers. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - fill?: Word.Interfaces.ShapeFillUpdateData; + countBy?: number; /** - * Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas. + * Specifies the distance (in points) between the right edge of line numbers and the left edge of the document text. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentCanvas?: Word.Interfaces.ShapeUpdateData; + distanceFromText?: number; /** - * Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group. + * Specifies if line numbering is active for the specified document, section, or sections. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentGroup?: Word.Interfaces.ShapeUpdateData; + isActive?: boolean; /** - * Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "GroupShape". 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 way line numbering runs; that is, whether it starts over at the beginning of a new page or section, or runs continuously. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shapeGroup?: Word.Interfaces.ShapeGroupUpdateData; + restartMode?: Word.NumberingRule | "RestartContinuous" | "RestartSection" | "RestartPage"; /** - * Gets the text frame object of the shape. + * Specifies the starting line number. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - textFrame?: Word.Interfaces.TextFrameUpdateData; + startingNumber?: number; + } + /** An interface for updating data on the `TextColumnCollection` object, for use in `textColumnCollection.set({ ... })`. */ + interface TextColumnCollectionUpdateData { + items?: Word.Interfaces.TextColumnData[]; + } + /** An interface for updating data on the `TextColumn` object, for use in `textColumn.set({ ... })`. */ + interface TextColumnUpdateData { /** - * Returns the text wrap formatting of the shape. + * Specifies the amount of spacing (in points) after the specified paragraph or text column. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - textWrap?: Word.Interfaces.ShapeTextWrapUpdateData; + spaceAfter?: number; /** - * Specifies whether a given shape can overlap other shapes. + * Specifies the width, in points, of the specified text columns. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - allowOverlap?: boolean; + width?: number; + } + /** An interface for updating data on the `Selection` object, for use in `selection.set({ ... })`. */ + interface SelectionUpdateData { /** - * Specifies a string that represents the alternative text associated with the shape. + * Specifies the ending character position of the selection. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - altTextDescription?: string; + end?: number; /** - * The geometric shape type of the shape. It will be null if isn't a geometric shape. + * Specifies the width in which Word fits the text in the current selection. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - geometricShapeType?: Word.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"; + fitTextWidth?: number; /** - * The height, in points, of the shape. + * Specifies whether column selection mode is active. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - height?: number; + isColumnSelectModeActive?: boolean; /** - * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * Specifies whether Extend mode is active. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - heightRelative?: number; + isExtendModeActive?: boolean; /** - * The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * Specifies whether the beginning of the selection is active. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - left?: number; + isStartActive?: boolean; /** - * The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set. + * Specifies whether Word has detected the language of the selected text. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftRelative?: number; + languageDetected?: boolean; /** - * Specifies if the aspect ratio of this shape is locked. + * Specifies the orientation of text in the selection. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lockAspectRatio?: boolean; + orientation?: Word.TextOrientation | "Horizontal" | "Upward" | "Downward" | "VerticalFarEast" | "HorizontalRotatedFarEast" | "Vertical"; /** - * The name of the shape. + * Specifies the starting character position of the selection. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - name?: string; + start?: number; /** - * The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Specifies the text in the selection. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; + text?: string; + } + /** An interface for updating data on the `RangeScopedCollection` object, for use in `rangeScopedCollection.set({ ... })`. */ + interface RangeScopedCollectionUpdateData { + items?: Word.Interfaces.RangeData[]; + } + /** An interface for updating data on the `Bookmark` object, for use in `bookmark.set({ ... })`. */ + interface BookmarkUpdateData { /** - * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Returns a `Range` object that represents the portion of the document that's contained in the `Bookmark` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + range?: Word.Interfaces.RangeUpdateData; /** - * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. + * Specifies the ending character position of the bookmark. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + end?: number; /** - * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Specifies the starting character position of the bookmark. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - relativeVerticalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + start?: number; + } + /** An interface for updating data on the `BookmarkCollection` object, for use in `bookmarkCollection.set({ ... })`. */ + interface BookmarkCollectionUpdateData { + items?: Word.Interfaces.BookmarkData[]; + } + /** An interface for updating data on the `Index` object, for use in `index.set({ ... })`. */ + interface IndexUpdateData { /** - * Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape. + * Returns a `Range` object that represents the portion of the document that is contained within the index. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rotation?: number; + range?: Word.Interfaces.RangeUpdateData; /** - * The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * Specifies the leader character between entries in the index and their associated page numbers. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - top?: number; + tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + } + /** An interface for updating data on the `IndexCollection` object, for use in `indexCollection.set({ ... })`. */ + interface IndexCollectionUpdateData { + items?: Word.Interfaces.IndexData[]; + } + /** An interface for updating data on the `ListTemplateCollection` object, for use in `listTemplateCollection.set({ ... })`. */ + interface ListTemplateCollectionUpdateData { + items?: Word.Interfaces.ListTemplateData[]; + } + /** An interface for updating data on the `ListTemplateGalleryCollection` object, for use in `listTemplateGalleryCollection.set({ ... })`. */ + interface ListTemplateGalleryCollectionUpdateData { + items?: Word.Interfaces.ListTemplateGalleryData[]; + } + /** An interface describing the data returned by calling `editor.toJSON()`. */ + interface EditorData { /** - * The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set. + * Gets a `Range` object that represents the next range that the editor has permissions to modify. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topRelative?: number; + nextRange?: Word.Interfaces.RangeData; /** - * Specifies if the shape is visible. Not applicable to inline shapes. + * Gets a `Range` object that represents the portion of the document that's contained in the `Editor` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - visible?: boolean; + range?: Word.Interfaces.RangeData; /** - * The width, in points, of the shape. + * Gets the identifier for the `Editor` object when the parent document is saved as a webpage. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: number; + id?: string; /** - * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * Gets the name of the editor. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - widthRelative?: number; + name?: string; } - /** An interface for updating data on the `ShapeGroup` object, for use in `shapeGroup.set({ ... })`. */ - interface ShapeGroupUpdateData { + /** An interface describing the data returned by calling `conflictCollection.toJSON()`. */ + interface ConflictCollectionData { + items?: Word.Interfaces.ConflictData[]; + } + /** An interface describing the data returned by calling `conflict.toJSON()`. */ + interface ConflictData { /** - * Gets the Shape object associated with the group. + * Gets a `Range` object that represents the portion of the document that's contained in the `Conflict` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shape?: Word.Interfaces.ShapeUpdateData; - } - /** An interface for updating data on the `Canvas` object, for use in `canvas.set({ ... })`. */ - interface CanvasUpdateData { + range?: Word.Interfaces.RangeData; /** - * Gets the Shape object associated with the canvas. + * Gets the `RevisionType` for the `Conflict` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shape?: Word.Interfaces.ShapeUpdateData; - } - /** An interface for updating data on the `ShapeCollection` object, for use in `shapeCollection.set({ ... })`. */ - interface ShapeCollectionUpdateData { - items?: Word.Interfaces.ShapeData[]; + type?: Word.RevisionType | "None" | "Insert" | "Delete" | "Property" | "ParagraphNumber" | "DisplayField" | "Reconcile" | "Conflict" | "Style" | "Replace" | "ParagraphProperty" | "TableProperty" | "SectionProperty" | "StyleDefinition" | "MovedFrom" | "MovedTo" | "CellInsertion" | "CellDeletion" | "CellMerge" | "CellSplit" | "ConflictInsert" | "ConflictDelete"; } - /** An interface for updating data on the `ShapeFill` object, for use in `shapeFill.set({ ... })`. */ - interface ShapeFillUpdateData { + /** An interface describing the data returned by calling `critiqueAnnotation.toJSON()`. */ + interface CritiqueAnnotationData { /** - * Specifies the shape fill background color. You can provide the value in the '#RRGGBB' format or the color name. + * Gets the critique that was passed when the annotation was inserted. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.7] */ - backgroundColor?: string; + critique?: Word.Critique; + } + /** An interface describing the data returned by calling `annotation.toJSON()`. */ + interface AnnotationData { /** - * Specifies the shape fill foreground color. You can provide the value in the '#RRGGBB' format or the color name. + * Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.7] */ - foregroundColor?: string; + id?: string; /** - * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type. + * Gets the state of the annotation. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.7] */ - transparency?: number; + state?: Word.AnnotationState | "Created" | "Accepted" | "Rejected"; } - /** An interface for updating data on the `TextFrame` object, for use in `textFrame.set({ ... })`. */ - interface TextFrameUpdateData { + /** An interface describing the data returned by calling `annotationCollection.toJSON()`. */ + interface AnnotationCollectionData { + items?: Word.Interfaces.AnnotationData[]; + } + /** An interface describing the data returned by calling `application.toJSON()`. */ + interface ApplicationData { /** - * 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. + * Returns a `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - autoSizeSetting?: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed"; + bibliography?: Word.Interfaces.BibliographyData; /** - * Represents the bottom margin, in points, of the text frame. + * Returns a `ListTemplateGalleryCollection` object that represents all the list template galleries in Microsoft Word. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bottomMargin?: number; + listTemplateGalleries?: Word.Interfaces.ListTemplateGalleryData[]; /** - * Represents the left margin, in points, of the text frame. + * Specifies if Microsoft Word automatically detects the language you are using as you type. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftMargin?: number; + checkLanguage?: boolean; /** - * Returns True if text in the text frame shouldn't rotate when the shape is rotated. + * Gets a `LanguageId` value that represents the language selected for the Microsoft Word user interface. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - noTextRotation?: boolean; + language?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + } + /** An interface describing the data returned by calling `body.toJSON()`. */ + interface BodyData { /** - * Represents the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. + * Gets the collection of rich text content control objects in the body. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] */ - orientation?: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed"; + contentControls?: Word.Interfaces.ContentControlData[]; /** - * Represents the right margin, in points, of the text frame. + * Gets the collection of field objects in the body. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.4] */ - rightMargin?: number; + fields?: Word.Interfaces.FieldData[]; /** - * Represents the top margin, in points, of the text frame. + * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] */ - topMargin?: number; + font?: Word.Interfaces.FontData; /** - * Represents the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. + * Gets the collection of InlinePicture objects in the body. The collection doesn't include floating images. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] */ - verticalAlignment?: Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom"; + inlinePictures?: Word.Interfaces.InlinePictureData[]; /** - * Determines whether lines break automatically to fit text inside the shape. + * Gets the collection of list objects in the body. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - wordWrap?: boolean; - } - /** An interface for updating data on the `ShapeTextWrap` object, for use in `shapeTextWrap.set({ ... })`. */ - interface ShapeTextWrapUpdateData { + lists?: Word.Interfaces.ListData[]; /** - * Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape. + * Gets the collection of paragraph objects in the body. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] + * + * Important: Paragraphs in tables aren't returned for requirement sets 1.1 and 1.2. From requirement set 1.3, paragraphs in tables are also returned. */ - bottomDistance?: number; + paragraphs?: Word.Interfaces.ParagraphData[]; /** - * Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape. + * Gets the collection of shape objects in the body, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. * * @remarks * [Api set: WordApiDesktop 1.2] */ - leftDistance?: number; + shapes?: Word.Interfaces.ShapeData[]; /** - * Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape. + * Gets the collection of table objects in the body. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - rightDistance?: number; + tables?: Word.Interfaces.TableData[]; /** - * Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farthest from the page margin. + * Specifies the style name for the body. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] */ - side?: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest"; + style?: string; /** - * Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape. + * Specifies the built-in style name for the body. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - topDistance?: number; + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; /** - * Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details. + * Gets the text of the body. Use the insertText method to insert text. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] */ - type?: Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front"; - } - /** An interface for updating data on the `Reviewer` object, for use in `reviewer.set({ ... })`. */ - interface ReviewerUpdateData { + text?: string; /** - * Specifies if the `Reviewer` object is visible. + * Gets the type of the body. The type can be 'MainDoc', 'Section', 'Header', 'Footer', or 'TableCell'. Additional types ‘Footnote’, ‘Endnote’, and ‘NoteItem’ are supported in WordApiOnline 1.1 and later. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isVisible?: boolean; - } - /** An interface for updating data on the `ReviewerCollection` object, for use in `reviewerCollection.set({ ... })`. */ - interface ReviewerCollectionUpdateData { - items?: Word.Interfaces.ReviewerData[]; + type?: Word.BodyType | "Unknown" | "MainDoc" | "Section" | "Header" | "Footer" | "TableCell" | "Footnote" | "Endnote" | "NoteItem" | "Shape"; } - /** An interface for updating data on the `RevisionsFilter` object, for use in `revisionsFilter.set({ ... })`. */ - interface RevisionsFilterUpdateData { + /** An interface describing the data returned by calling `border.toJSON()`. */ + interface BorderData { /** - * Specifies a `RevisionsMarkup` value that represents the extent of reviewer markup displayed in the document. + * Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - markup?: Word.RevisionsMarkup | "None" | "Simple" | "All"; + color?: string; /** - * Specifies a `RevisionsView` value that represents globally whether Word displays the original version of the document or the final version, which might have revisions and formatting changes applied. + * Gets the location of the border. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - view?: Word.RevisionsView | "Final" | "Original"; - } - /** An interface for updating data on the `RepeatingSectionItem` object, for use in `repeatingSectionItem.set({ ... })`. */ - interface RepeatingSectionItemUpdateData { + location?: Word.BorderLocation | "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"; /** - * Returns the range of this repeating section item, excluding the start and end tags. + * Specifies the border type for the border. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - range?: Word.Interfaces.RangeUpdateData; - } - /** An interface for updating data on the `DatePickerContentControl` object, for use in `datePickerContentControl.set({ ... })`. */ - interface DatePickerContentControlUpdateData { + type?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Specifies whether the border is visible. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - placeholderText?: Word.Interfaces.BuildingBlockUpdateData; + visible?: boolean; /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * Specifies the width for the border. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - range?: Word.Interfaces.RangeUpdateData; + width?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed"; + } + /** An interface describing the data returned by calling `borderUniversal.toJSON()`. */ + interface BorderUniversalData { /** - * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Specifies the graphical page-border design for the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingUpdateData; + artStyle?: Word.PageBorderArt | "Apples" | "MapleMuffins" | "CakeSlice" | "CandyCorn" | "IceCreamCones" | "ChampagneBottle" | "PartyGlass" | "ChristmasTree" | "Trees" | "PalmsColor" | "Balloons3Colors" | "BalloonsHotAir" | "PartyFavor" | "ConfettiStreamers" | "Hearts" | "HeartBalloon" | "Stars3D" | "StarsShadowed" | "Stars" | "Sun" | "Earth2" | "Earth1" | "PeopleHats" | "Sombrero" | "Pencils" | "Packages" | "Clocks" | "Firecrackers" | "Rings" | "MapPins" | "Confetti" | "CreaturesButterfly" | "CreaturesLadyBug" | "CreaturesFish" | "BirdsFlight" | "ScaredCat" | "Bats" | "FlowersRoses" | "FlowersRedRose" | "Poinsettias" | "Holly" | "FlowersTiny" | "FlowersPansy" | "FlowersModern2" | "FlowersModern1" | "WhiteFlowers" | "Vine" | "FlowersDaisies" | "FlowersBlockPrint" | "DecoArchColor" | "Fans" | "Film" | "Lightning1" | "Compass" | "DoubleD" | "ClassicalWave" | "ShadowedSquares" | "TwistedLines1" | "Waveline" | "Quadrants" | "CheckedBarColor" | "Swirligig" | "PushPinNote1" | "PushPinNote2" | "Pumpkin1" | "EggsBlack" | "Cup" | "HeartGray" | "GingerbreadMan" | "BabyPacifier" | "BabyRattle" | "Cabins" | "HouseFunky" | "StarsBlack" | "Snowflakes" | "SnowflakeFancy" | "Skyrocket" | "Seattle" | "MusicNotes" | "PalmsBlack" | "MapleLeaf" | "PaperClips" | "ShorebirdTracks" | "People" | "PeopleWaving" | "EclipsingSquares2" | "Hypnotic" | "DiamondsGray" | "DecoArch" | "DecoBlocks" | "CirclesLines" | "Papyrus" | "Woodwork" | "WeavingBraid" | "WeavingRibbon" | "WeavingAngles" | "ArchedScallops" | "Safari" | "CelticKnotwork" | "CrazyMaze" | "EclipsingSquares1" | "Birds" | "FlowersTeacup" | "Northwest" | "Southwest" | "Tribal6" | "Tribal4" | "Tribal3" | "Tribal2" | "Tribal5" | "XIllusions" | "ZanyTriangles" | "Pyramids" | "PyramidsAbove" | "ConfettiGrays" | "ConfettiOutline" | "ConfettiWhite" | "Mosaic" | "Lightning2" | "HeebieJeebies" | "LightBulb" | "Gradient" | "TriangleParty" | "TwistedLines2" | "Moons" | "Ovals" | "DoubleDiamonds" | "ChainLink" | "Triangles" | "Tribal1" | "MarqueeToothed" | "SharksTeeth" | "Sawtooth" | "SawtoothGray" | "PostageStamp" | "WeavingStrips" | "ZigZag" | "CrossStitch" | "Gems" | "CirclesRectangles" | "CornerTriangles" | "CreaturesInsects" | "ZigZagStitch" | "Checkered" | "CheckedBarBlack" | "Marquee" | "BasicWhiteDots" | "BasicWideMidline" | "BasicWideOutline" | "BasicWideInline" | "BasicThinLines" | "BasicWhiteDashes" | "BasicWhiteSquares" | "BasicBlackSquares" | "BasicBlackDashes" | "BasicBlackDots" | "StarsTop" | "CertificateBanner" | "Handmade1" | "Handmade2" | "TornPaper" | "TornPaperBlack" | "CouponCutoutDashes" | "CouponCutoutDots"; /** - * Specifies the appearance of the content control. + * Specifies the width (in points) of the graphical page border specified in the `artStyle` property. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + artWidth?: number; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Specifies the color for the `BorderUniversal` object. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -138944,1937 +149126,2016 @@ declare namespace Word { */ color?: string; /** - * Specifies a `CalendarType` value that represents the calendar type for the date picker content control. + * Specifies the color for the `BorderUniversal` or {@link Word.Font} object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateCalendarType?: Word.CalendarType | "Western" | "Arabic" | "Hebrew" | "Taiwan" | "Japan" | "Thai" | "Korean" | "SakaEra" | "TranslitEnglish" | "TranslitFrench" | "Umalqura"; + colorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Specifies the format in which dates are displayed. + * Returns `true` if an inside border can be applied to the specified object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateDisplayFormat?: string; + inside?: boolean; /** - * Specifies a `LanguageId` that represents the language format for the date displayed in the date picker content control. + * Specifies whether the border is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateDisplayLocale?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + isVisible?: boolean; /** - * Specifies a `ContentControlDateStorageFormat` value that represents the format for storage and retrieval of dates when the date picker content control is bound to the XML data store of the active document. + * Specifies the line style of the border. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateStorageFormat?: Word.ContentControlDateStorageFormat | "Text" | "Date" | "DateTime"; + lineStyle?: Word.BorderLineStyle | "None" | "Single" | "Dot" | "DashSmallGap" | "DashLargeGap" | "DashDot" | "DashDotDot" | "Double" | "Triple" | "ThinThickSmallGap" | "ThickThinSmallGap" | "ThinThickThinSmallGap" | "ThinThickMedGap" | "ThickThinMedGap" | "ThinThickThinMedGap" | "ThinThickLargeGap" | "ThickThinLargeGap" | "ThinThickThinLargeGap" | "SingleWavy" | "DoubleWavy" | "DashDotStroked" | "Emboss3D" | "Engrave3D" | "Outset" | "Inset"; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Specifies the line width of an object's border. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + lineWidth?: Word.LineWidth | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600"; + } + /** An interface describing the data returned by calling `borderCollection.toJSON()`. */ + interface BorderCollectionData { + items?: Word.Interfaces.BorderData[]; + } + /** An interface describing the data returned by calling `borderUniversalCollection.toJSON()`. */ + interface BorderUniversalCollectionData { + items?: Word.Interfaces.BorderUniversalData[]; + } + /** An interface describing the data returned by calling `break.toJSON()`. */ + interface BreakData { /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Returns a `Range` object that represents the portion of the document that's contained in the break. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + range?: Word.Interfaces.RangeData; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Returns the page number on which the break occurs. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + pageIndex?: number; + } + /** An interface describing the data returned by calling `breakCollection.toJSON()`. */ + interface BreakCollectionData { + items?: Word.Interfaces.BreakData[]; + } + /** An interface describing the data returned by calling `buildingBlock.toJSON()`. */ + interface BuildingBlockData { /** - * Specifies a tag to identify the content control. + * Specifies the description for the building block. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: string; + description?: string; /** - * Specifies the title for the content control. + * Returns the internal identification number for the building block. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: string; - } - /** An interface for updating data on the `PictureContentControl` object, for use in `pictureContentControl.set({ ... })`. */ - interface PictureContentControlUpdateData { + id?: string; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Returns the position of this building block in a collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: Word.Interfaces.BuildingBlockUpdateData; + index?: number; /** - * Returns a `Range` object that represents the contents of the content control in the active document. + * Specifies a `DocPartInsertType` value that represents how to insert the contents of the building block into the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeUpdateData; + insertType?: Word.DocPartInsertType | "Content" | "Paragraph" | "Page"; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Specifies the name of the building block. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingUpdateData; + name?: string; /** - * Specifies the appearance of the content control. + * Specifies the contents of the building block. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + value?: string; + } + /** An interface describing the data returned by calling `buildingBlockCategory.toJSON()`. */ + interface BuildingBlockCategoryData { /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Returns the position of the `BuildingBlockCategory` object in a collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + index?: number; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Returns the name of the `BuildingBlockCategory` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + name?: string; + } + /** An interface describing the data returned by calling `buildingBlockTypeItem.toJSON()`. */ + interface BuildingBlockTypeItemData { /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Returns the position of an item in a collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + index?: number; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Returns the localized name of a building block type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + name?: string; + } + /** An interface describing the data returned by calling `checkboxContentControl.toJSON()`. */ + interface CheckboxContentControlData { /** - * Specifies a tag to identify the content control. + * Specifies the current state of the checkbox. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - tag?: string; + isChecked?: boolean; + } + /** An interface describing the data returned by calling `coauthoringLock.toJSON()`. */ + interface CoauthoringLockData { /** - * Specifies the title for the content control. + * Gets the owner of the lock. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: string; - } - /** An interface for updating data on the `GroupContentControl` object, for use in `groupContentControl.set({ ... })`. */ - interface GroupContentControlUpdateData { + owner?: Word.Interfaces.CoauthorData; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringLock` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: Word.Interfaces.BuildingBlockUpdateData; + range?: Word.Interfaces.RangeData; /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * Gets a `CoauthoringLockType` value that represents the lock type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeUpdateData; + type?: Word.CoauthoringLockType | "None" | "Reservation" | "Ephemeral" | "Changed"; + } + /** An interface describing the data returned by calling `coauthoringLockCollection.toJSON()`. */ + interface CoauthoringLockCollectionData { + items?: Word.Interfaces.CoauthoringLockData[]; + } + /** An interface describing the data returned by calling `coauthor.toJSON()`. */ + interface CoauthorData { /** - * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Gets a `CoauthoringLockCollection` object that represents the locks in the document that are associated with this coauthor. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingUpdateData; + locks?: Word.Interfaces.CoauthoringLockData[]; /** - * Specifies the appearance of the content control. + * Gets the email address of the coauthor. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + emailAddress?: string; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Gets the unique identifier for the `Coauthor` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + id?: string; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Gets whether this author represents the current user. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + isMe?: boolean; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Gets the display name of the coauthor. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + name?: string; + } + /** An interface describing the data returned by calling `coauthorCollection.toJSON()`. */ + interface CoauthorCollectionData { + items?: Word.Interfaces.CoauthorData[]; + } + /** An interface describing the data returned by calling `coauthoring.toJSON()`. */ + interface CoauthoringData { /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Gets a `CoauthorCollection` object that represents all the coauthors currently editing the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + authors?: Word.Interfaces.CoauthorData[]; /** - * Specifies a tag to identify the content control. + * Gets a `ConflictCollection` object that represents all the conflicts in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: string; + conflicts?: Word.Interfaces.ConflictData[]; /** - * Specifies the title for the content control. + * Gets a `CoauthoringLockCollection` object that represents the locks in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: string; - } - /** An interface for updating data on the `BuildingBlockGalleryContentControl` object, for use in `buildingBlockGalleryContentControl.set({ ... })`. */ - interface BuildingBlockGalleryContentControlUpdateData { + locks?: Word.Interfaces.CoauthoringLockData[]; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Gets a `Coauthor` object that represents the current user. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: Word.Interfaces.BuildingBlockUpdateData; + me?: Word.Interfaces.CoauthorData; /** - * Returns a `Range` object that represents the contents of the content control in the active document. + * Gets a `CoauthoringUpdateCollection` object that represents the most recent updates that were merged into the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeUpdateData; + updates?: Word.Interfaces.CoauthoringUpdateData[]; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Gets whether this document can be coauthored. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingUpdateData; + canCoauthor?: boolean; /** - * Specifies the appearance of the content control. + * Gets whether the document can be automatically merged. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + canMerge?: boolean; /** - * Specifies the category for the building block content control. + * Gets whether the document has pending updates that have not been accepted. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - buildingBlockCategory?: string; + pendingUpdates?: boolean; + } + /** An interface describing the data returned by calling `coauthoringUpdate.toJSON()`. */ + interface CoauthoringUpdateData { /** - * Specifies a `BuildingBlockType` value that represents the type of building block for the building block content control. + * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringUpdate` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - buildingBlockType?: Word.BuildingBlockType | "QuickParts" | "CoverPage" | "Equations" | "Footers" | "Headers" | "PageNumber" | "Tables" | "Watermarks" | "AutoText" | "TextBox" | "PageNumberTop" | "PageNumberBottom" | "PageNumberPage" | "TableOfContents" | "CustomQuickParts" | "CustomCoverPage" | "CustomEquations" | "CustomFooters" | "CustomHeaders" | "CustomPageNumber" | "CustomTables" | "CustomWatermarks" | "CustomAutoText" | "CustomTextBox" | "CustomPageNumberTop" | "CustomPageNumberBottom" | "CustomPageNumberPage" | "CustomTableOfContents" | "Custom1" | "Custom2" | "Custom3" | "Custom4" | "Custom5" | "Bibliography" | "CustomBibliography"; + range?: Word.Interfaces.RangeData; + } + /** An interface describing the data returned by calling `coauthoringUpdateCollection.toJSON()`. */ + interface CoauthoringUpdateCollectionData { + items?: Word.Interfaces.CoauthoringUpdateData[]; + } + /** An interface describing the data returned by calling `comment.toJSON()`. */ + interface CommentData { /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Specifies the comment's content range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - color?: string; + contentRange?: Word.Interfaces.CommentContentRangeData; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Gets the collection of reply objects associated with the comment. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - isTemporary?: boolean; + replies?: Word.Interfaces.CommentReplyData[]; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Gets the email of the comment's author. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - lockContentControl?: boolean; + authorEmail?: string; + /** + * Gets the name of the comment's author. + * + * @remarks + * [Api set: WordApi 1.4] + */ + authorName?: string; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Specifies the comment's content as plain text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - lockContents?: boolean; + content?: string; /** - * Specifies a tag to identify the content control. + * Gets the creation date of the comment. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - tag?: string; + creationDate?: Date; /** - * Specifies the title for the content control. + * Gets the ID of the comment. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - title?: string; - } - /** An interface for updating data on the `RepeatingSectionContentControl` object, for use in `repeatingSectionContentControl.set({ ... })`. */ - interface RepeatingSectionContentControlUpdateData { + id?: string; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Specifies the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - placeholderText?: Word.Interfaces.BuildingBlockUpdateData; + resolved?: boolean; + } + /** An interface describing the data returned by calling `commentCollection.toJSON()`. */ + interface CommentCollectionData { + items?: Word.Interfaces.CommentData[]; + } + /** An interface describing the data returned by calling `commentContentRange.toJSON()`. */ + interface CommentContentRangeData { /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * Specifies a value that indicates whether the comment text is bold. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - range?: Word.Interfaces.RangeUpdateData; + bold?: boolean; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - xmlapping?: Word.Interfaces.XmlMappingUpdateData; + hyperlink?: string; /** - * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. + * Checks whether the range length is zero. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - allowInsertDeleteSection?: boolean; + isEmpty?: boolean; /** - * Specifies the appearance of the content control. + * Specifies a value that indicates whether the comment text is italicized. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + italic?: boolean; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Specifies a value that indicates whether the comment text has a strikethrough. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - color?: string; + strikeThrough?: boolean; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Gets the text of the comment range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - isTemporary?: boolean; + text?: string; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - lockContentControl?: boolean; + underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; + } + /** An interface describing the data returned by calling `commentReply.toJSON()`. */ + interface CommentReplyData { /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Specifies the commentReply's content range. + * + * @remarks + * [Api set: WordApi 1.4] + */ + contentRange?: Word.Interfaces.CommentContentRangeData; + /** + * Gets the parent comment of this reply. + * + * @remarks + * [Api set: WordApi 1.4] + */ + parentComment?: Word.Interfaces.CommentData; + /** + * Gets the email of the comment reply's author. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - lockContents?: boolean; + authorEmail?: string; /** - * Specifies the name of the repeating section items used in the context menu associated with this repeating section content control. + * Gets the name of the comment reply's author. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - repeatingSectionItemTitle?: string; + authorName?: string; /** - * Specifies a tag to identify the content control. + * Specifies the comment reply's content. The string is plain text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - tag?: string; + content?: string; /** - * Specifies the title for the content control. + * Gets the creation date of the comment reply. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - title?: string; - } - /** An interface for updating data on the `Frame` object, for use in `frame.set({ ... })`. */ - interface FrameUpdateData { + creationDate?: Date; /** - * Returns a `Range` object that represents the portion of the document that's contained within the frame. + * Gets the ID of the comment reply. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - range?: Word.Interfaces.RangeUpdateData; + id?: string; + } + /** An interface describing the data returned by calling `commentReplyCollection.toJSON()`. */ + interface CommentReplyCollectionData { + items?: Word.Interfaces.CommentReplyData[]; + } + /** An interface describing the data returned by calling `conditionalStyle.toJSON()`. */ + interface ConditionalStyleData { /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. + * Specifies the amount of space (in points) to add below the contents of a single cell or all the cells in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shading?: Word.Interfaces.ShadingUniversalUpdateData; + bottomPadding?: number; /** - * Specifies the height (in points) of the frame. + * Specifies the amount of space (in points) to add to the left of the contents of a single cell or all the cells in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - height?: number; + leftPadding?: number; /** - * Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. + * Specifies the amount of space (in points) to add to the right of the contents of a single cell or all the cells in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - heightRule?: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; + rightPadding?: number; /** - * Specifies the horizontal distance between the frame and the surrounding text, in points. + * Specifies the amount of space (in points) to add above the contents of a single cell or all the cells in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontalDistanceFromText?: number; + topPadding?: number; + } + /** An interface describing the data returned by calling `xmlMapping.toJSON()`. */ + interface XmlMappingData { /** - * Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property. + * Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontalPosition?: number; + customXmlNode?: Word.Interfaces.CustomXmlNodeData; /** - * Specifies if the frame is locked. + * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockAnchor?: boolean; + customXmlPart?: Word.Interfaces.CustomXmlPartData; /** - * Specifies the relative horizontal position of the frame. + * Returns whether the content control in the document is mapped to an XML node in the document's XML data store. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; + isMapped?: boolean; /** - * Specifies the relative vertical position of the frame. + * Returns the prefix mappings used to evaluate the XPath for the current XML mapping. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + prefixMappings?: string; /** - * Specifies if document text wraps around the frame. + * Returns the XPath for the XML mapping, which evaluates to the currently mapped XML node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textWrap?: boolean; + xpath?: string; + } + /** An interface describing the data returned by calling `customXmlPrefixMappingCollection.toJSON()`. */ + interface CustomXmlPrefixMappingCollectionData { + items?: Word.Interfaces.CustomXmlPrefixMappingData[]; + } + /** An interface describing the data returned by calling `customXmlPrefixMapping.toJSON()`. */ + interface CustomXmlPrefixMappingData { /** - * Specifies the vertical distance (in points) between the frame and the surrounding text. + * Gets the unique address identifier for the namespace of the `CustomXmlPrefixMapping` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - verticalDistanceFromText?: number; + namespaceUri?: string; /** - * Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property. + * Gets the prefix for the `CustomXmlPrefixMapping` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - verticalPosition?: number; + prefix?: string; + } + /** An interface describing the data returned by calling `customXmlSchema.toJSON()`. */ + interface CustomXmlSchemaData { /** - * Specifies the width (in points) of the frame. + * Gets the location of the schema on a computer. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - width?: number; + location?: string; /** - * Specifies the rule used to determine the width of the frame. + * Gets the unique address identifier for the namespace of the `CustomXmlSchema` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - widthRule?: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; + namespaceUri?: string; } - /** An interface for updating data on the `FrameCollection` object, for use in `frameCollection.set({ ... })`. */ - interface FrameCollectionUpdateData { - items?: Word.Interfaces.FrameData[]; + /** An interface describing the data returned by calling `customXmlSchemaCollection.toJSON()`. */ + interface CustomXmlSchemaCollectionData { + items?: Word.Interfaces.CustomXmlSchemaData[]; } - /** An interface for updating data on the `DocumentLibraryVersionCollection` object, for use in `documentLibraryVersionCollection.set({ ... })`. */ - interface DocumentLibraryVersionCollectionUpdateData { - items?: Word.Interfaces.DocumentLibraryVersionData[]; + /** An interface describing the data returned by calling `customXmlValidationErrorCollection.toJSON()`. */ + interface CustomXmlValidationErrorCollectionData { + items?: Word.Interfaces.CustomXmlValidationErrorData[]; } - /** An interface for updating data on the `ListFormat` object, for use in `listFormat.set({ ... })`. */ - interface ListFormatUpdateData { + /** An interface describing the data returned by calling `customXmlValidationError.toJSON()`. */ + interface CustomXmlValidationErrorData { /** - * Gets the list template associated with the `ListFormat` object. + * Gets the node associated with this `CustomXmlValidationError` object, if any exist.If no nodes exist, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listTemplate?: Word.Interfaces.ListTemplateUpdateData; + node?: Word.Interfaces.CustomXmlNodeData; /** - * Specifies the list level number for the first paragraph for the `ListFormat` object. + * Gets an integer representing the validation error in the `CustomXmlValidationError` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listLevelNumber?: number; - } - /** An interface for updating data on the `FillFormat` object, for use in `fillFormat.set({ ... })`. */ - interface FillFormatUpdateData { + errorCode?: number; /** - * Returns a `ColorFormat` object that represents the background color for the fill. + * Gets the name of the error in the `CustomXmlValidationError` object.If no errors exist, the property returns `Nothing` * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - backgroundColor?: Word.Interfaces.ColorFormatUpdateData; + name?: string; /** - * Returns a `ColorFormat` object that represents the foreground color for the fill. + * Gets the text in the `CustomXmlValidationError` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - foregroundColor?: Word.Interfaces.ColorFormatUpdateData; + text?: string; /** - * Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9. + * Gets the type of error generated from the `CustomXmlValidationError` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gradientAngle?: number; + type?: Word.CustomXmlValidationErrorType | "schemaGenerated" | "automaticallyCleared" | "manual"; + } + /** An interface describing the data returned by calling `customXmlNodeCollection.toJSON()`. */ + interface CustomXmlNodeCollectionData { + items?: Word.Interfaces.CustomXmlNodeData[]; + } + /** An interface describing the data returned by calling `customXmlNode.toJSON()`. */ + interface CustomXmlNodeData { /** - * Specifies if the object, or the formatting applied to it, is visible. + * Gets a `CustomXmlNodeCollection` object representing the attributes of the current element in the current node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + attributes?: Word.Interfaces.CustomXmlNodeData[]; /** - * Specifies whether the fill rotates with the shape. + * Gets a `CustomXmlNodeCollection` object containing all of the child elements of the current node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotateWithObject?: boolean; + childNodes?: Word.Interfaces.CustomXmlNodeData[]; /** - * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. + * Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureAlignment?: Word.TextureAlignment | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "Center" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; + firstChild?: Word.Interfaces.CustomXmlNodeData; /** - * Specifies the horizontal scaling factor for the texture fill. + * Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureHorizontalScale?: number; + lastChild?: Word.Interfaces.CustomXmlNodeData; /** - * Specifies the horizontal offset of the texture from the origin in points. + * Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureOffsetX?: number; + nextSibling?: Word.Interfaces.CustomXmlNodeData; /** - * Specifies the vertical offset of the texture. + * Gets the object representing the part associated with this node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureOffsetY?: number; + ownerPart?: Word.Interfaces.CustomXmlPartData; /** - * Specifies whether the texture is tiled. + * Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureTile?: boolean; + parentNode?: Word.Interfaces.CustomXmlNodeData; /** - * Specifies the vertical scaling factor for the texture fill as a value between 0.0 and 1.0. + * Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureVerticalScale?: number; + previousSibling?: Word.Interfaces.CustomXmlNodeData; /** - * Specifies the degree of transparency of the fill for a shape as a value between 0.0 (opaque) and 1.0 (clear). + * Gets the base name of the node without the namespace prefix, if one exists. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency?: number; - } - /** An interface for updating data on the `GlowFormat` object, for use in `glowFormat.set({ ... })`. */ - interface GlowFormatUpdateData { + baseName?: string; /** - * Returns a `ColorFormat` object that represents the color for a glow effect. + * Gets the unique address identifier for the namespace of the node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: Word.Interfaces.ColorFormatUpdateData; + namespaceUri?: string; /** - * Specifies the length of the radius for a glow effect. + * Gets the type of the current node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - radius?: number; + nodeType?: Word.CustomXmlNodeType | "element" | "attribute" | "text" | "cData" | "processingInstruction" | "comment" | "document"; /** - * Specifies the degree of transparency for the glow effect as a value between 0.0 (opaque) and 1.0 (clear). + * Specifies the value of the current node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency?: number; - } - /** An interface for updating data on the `LineFormat` object, for use in `lineFormat.set({ ... })`. */ - interface LineFormatUpdateData { + nodeValue?: string; /** - * Gets a `ColorFormat` object that represents the background color for a patterned line. + * Specifies the text for the current node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - backgroundColor?: Word.Interfaces.ColorFormatUpdateData; + text?: string; /** - * Gets a `ColorFormat` object that represents the foreground color for the line. + * Gets a string with the canonicalized XPath for the current node. If the node is no longer in the Document Object Model (DOM), the property returns an error message. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - foregroundColor?: Word.Interfaces.ColorFormatUpdateData; + xpath?: string; /** - * Specifies the length of the arrowhead at the beginning of the line. + * Gets the XML representation of the current node and its children. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - beginArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; + xml?: string; + } + /** An interface describing the data returned by calling `contentControl.toJSON()`. */ + interface ContentControlData { /** - * Specifies the style of the arrowhead at the beginning of the line. + * Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `BuildingBlockGallery`. It's `null` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - beginArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; + buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlData; /** - * Specifies the width of the arrowhead at the beginning of the line. + * Gets the data of the content control when its type is `CheckBox`. It's `null` otherwise. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - beginArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; + checkboxContentControl?: Word.Interfaces.CheckboxContentControlData; /** - * Specifies the dash style for the line. + * Gets the data of the content control when its type is `ComboBox`. It's `null` otherwise. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - dashStyle?: Word.LineDashStyle | "Mixed" | "Solid" | "SquareDot" | "RoundDot" | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "SysDash" | "SysDot" | "SysDashDot"; + comboBoxContentControl?: Word.Interfaces.ComboBoxContentControlData; /** - * Specifies the length of the arrowhead at the end of the line. + * Gets the collection of content control objects in the content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - endArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; + contentControls?: Word.Interfaces.ContentControlData[]; /** - * Specifies the style of the arrowhead at the end of the line. + * Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `DatePicker`. It's `null` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; + datePickerContentControl?: Word.Interfaces.DatePickerContentControlData; /** - * Specifies the width of the arrowhead at the end of the line. + * Gets the data of the content control when its type is `DropDownList`. It's `null` otherwise. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - endArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; + dropDownListContentControl?: Word.Interfaces.DropDownListContentControlData; /** - * Specifies if to draw lines inside a shape. + * Gets the collection of field objects in the content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - insetPen?: boolean; + fields?: Word.Interfaces.FieldData[]; /** - * Specifies if the object, or the formatting applied to it, is visible. + * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - isVisible?: boolean; + font?: Word.Interfaces.FontData; /** - * Specifies the pattern applied to the line. + * Gets the group-related data if the content control's {@link Word.ContentControlType} is `Group`. It's `null` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pattern?: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"; + groupContentControl?: Word.Interfaces.GroupContentControlData; /** - * Specifies the line format style. + * Gets the collection of InlinePicture objects in the content control. The collection doesn't include floating images. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - style?: Word.LineFormatStyle | "Mixed" | "Single" | "ThinThin" | "ThinThick" | "ThickThin" | "ThickBetweenThin"; + inlinePictures?: Word.Interfaces.InlinePictureData[]; /** - * Specifies the degree of transparency of the line as a value between 0.0 (opaque) and 1.0 (clear). + * Gets the collection of list objects in the content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - transparency?: number; + lists?: Word.Interfaces.ListData[]; /** - * Specifies the thickness of the line in points. + * Gets the collection of paragraph objects in the content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] + * + * Important: For requirement sets 1.1 and 1.2, paragraphs in tables wholly contained within this content control aren't returned. From requirement set 1.3, paragraphs in such tables are also returned. */ - weight?: number; - } - /** An interface for updating data on the `ReflectionFormat` object, for use in `reflectionFormat.set({ ... })`. */ - interface ReflectionFormatUpdateData { + paragraphs?: Word.Interfaces.ParagraphData[]; /** - * Specifies the degree of blur effect applied to the `ReflectionFormat` object as a value between 0.0 and 100.0. + * Gets the picture-related data if the content control's {@link Word.ContentControlType} is `Picture`. It's `null` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - blur?: number; + pictureContentControl?: Word.Interfaces.PictureContentControlData; /** - * Specifies the amount of separation, in points, of the reflected image from the shape. + * Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `RepeatingSection`. It's `null` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - offset?: number; + repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlData; /** - * Specifies the size of the reflection as a percentage of the reflected shape from 0 to 100. + * Gets the collection of table objects in the content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - size?: number; + tables?: Word.Interfaces.TableData[]; /** - * Specifies the degree of transparency for the reflection effect as a value between 0.0 (opaque) and 1.0 (clear). + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency?: number; + xmlMapping?: Word.Interfaces.XmlMappingData; /** - * Specifies a `ReflectionType` value that represents the type and direction of the lighting for a shape reflection. + * Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - type?: Word.ReflectionType | "Mixed" | "None" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9"; - } - /** An interface for updating data on the `ColorFormat` object, for use in `colorFormat.set({ ... })`. */ - interface ColorFormatUpdateData { + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Specifies the brightness of a specified shape color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. + * Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - brightness?: number; + cannotDelete?: boolean; /** - * Specifies the theme color for a color format. + * Specifies a value that indicates whether the user can edit the contents of the content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - objectThemeColor?: Word.ThemeColorIndex | "NotThemeColor" | "MainDark1" | "MainLight1" | "MainDark2" | "MainLight2" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Hyperlink" | "HyperlinkFollowed" | "Background1" | "Text1" | "Background2" | "Text2"; + cannotEdit?: boolean; /** - * Specifies the red-green-blue (RGB) value of the specified color. You can provide the value in the '#RRGGBB' format. + * Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - rgb?: string; + color?: string; /** - * Specifies the lightening or darkening of a specified shape's color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. + * Gets an integer that represents the content control identifier. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - tintAndShade?: number; - } - /** An interface for updating data on the `ShadowFormat` object, for use in `shadowFormat.set({ ... })`. */ - interface ShadowFormatUpdateData { + id?: number; /** - * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. + * Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - foregroundColor?: Word.Interfaces.ColorFormatUpdateData; + placeholderText?: string; /** - * Specifies the blur level for a shadow format as a value between 0.0 and 100.0. + * Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - blur?: number; + removeWhenEdited?: boolean; /** - * Specifies whether the object or the formatting applied to it is visible. + * Specifies the style name for the content control. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - isVisible?: boolean; + style?: string; /** - * Specifies `true` if the shadow of the shape appears filled in and is obscured by the shape, even if the shape has no fill, - `false` if the shadow has no fill and the outline of the shadow is visible through the shape if the shape has no fill. + * Specifies the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - obscured?: boolean; + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; /** - * Specifies the horizontal offset (in points) of the shadow from the shape. - A positive value offsets the shadow to the right of the shape; a negative value offsets it to the left. + * Gets the content control subtype. The subtype can be 'RichTextInline', 'RichTextParagraphs', 'RichTextTableCell', 'RichTextTableRow' and 'RichTextTable' for rich text content controls, or 'PlainTextInline' and 'PlainTextParagraph' for plain text content controls, or 'CheckBox' for checkbox content controls. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - offsetX?: number; + subtype?: Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" | "RichText" | "PlainText" | "Group"; /** - * Specifies the vertical offset (in points) of the shadow from the shape. - A positive value offsets the shadow to the top of the shape; a negative value offsets it to the bottom. + * Specifies a tag to identify a content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - offsetY?: number; + tag?: string; /** - * Specifies whether to rotate the shadow when rotating the shape. + * Gets the text of the content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - rotateWithShape?: boolean; + text?: string; /** - * Specifies the width of the shadow. + * Specifies the title for a content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - size?: number; + title?: string; /** - * Specifies the type of shadow formatting to apply to a shape. + * Gets the content control type. Only rich text, plain text, and checkbox content controls are supported currently. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - style?: Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow"; + type?: Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" | "RichText" | "PlainText" | "Group"; + } + /** An interface describing the data returned by calling `contentControlCollection.toJSON()`. */ + interface ContentControlCollectionData { + items?: Word.Interfaces.ContentControlData[]; + } + /** An interface describing the data returned by calling `contentControlListItem.toJSON()`. */ + interface ContentControlListItemData { /** - * Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear). + * Specifies the display text of a list item for a dropdown list or combo box content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - transparency?: number; + displayText?: string; /** - * Specifies the shape shadow type. + * Specifies the index location of a content control list item in the collection of list items. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - type?: Word.ShadowType | "Mixed" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9" | "Type10" | "Type11" | "Type12" | "Type13" | "Type14" | "Type15" | "Type16" | "Type17" | "Type18" | "Type19" | "Type20" | "Type21" | "Type22" | "Type23" | "Type24" | "Type25" | "Type26" | "Type27" | "Type28" | "Type29" | "Type30" | "Type31" | "Type32" | "Type33" | "Type34" | "Type35" | "Type36" | "Type37" | "Type38" | "Type39" | "Type40" | "Type41" | "Type42" | "Type43"; - } - /** An interface for updating data on the `ThreeDimensionalFormat` object, for use in `threeDimensionalFormat.set({ ... })`. */ - interface ThreeDimensionalFormatUpdateData { + index?: number; /** - * Returns a `ColorFormat` object that represents color of the contour of a shape. + * Specifies the programmatic value of a list item for a dropdown list or combo box content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - contourColor?: Word.Interfaces.ColorFormatUpdateData; + value?: string; + } + /** An interface describing the data returned by calling `contentControlListItemCollection.toJSON()`. */ + interface ContentControlListItemCollectionData { + items?: Word.Interfaces.ContentControlListItemData[]; + } + /** An interface describing the data returned by calling `customProperty.toJSON()`. */ + interface CustomPropertyData { /** - * Returns a `ColorFormat` object that represents the color of the shape's extrusion. + * Gets the key of the custom property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - extrusionColor?: Word.Interfaces.ColorFormatUpdateData; + key?: string; /** - * Specifies the depth of the bottom bevel. + * Gets the value type of the custom property. Possible values are: String, Number, Date, Boolean. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - bevelBottomDepth?: number; + type?: Word.DocumentPropertyType | "String" | "Number" | "Date" | "Boolean"; /** - * Specifies the inset size for the bottom bevel. + * Specifies the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - bevelBottomInset?: number; + value?: any; + } + /** An interface describing the data returned by calling `customPropertyCollection.toJSON()`. */ + interface CustomPropertyCollectionData { + items?: Word.Interfaces.CustomPropertyData[]; + } + /** An interface describing the data returned by calling `customXmlPart.toJSON()`. */ + interface CustomXmlPartData { /** - * Specifies a `BevelType` value that represents the bevel type for the bottom bevel. + * Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelBottomType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; + documentElement?: Word.Interfaces.CustomXmlNodeData; /** - * Specifies the depth of the top bevel. + * Gets a `CustomXmlValidationErrorCollection` object that provides access to any XML validation errors. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelTopDepth?: number; + errors?: Word.Interfaces.CustomXmlValidationErrorData[]; /** - * Specifies the inset size for the top bevel. + * Gets the set of namespace prefix mappings used against the current `CustomXmlPart` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelTopInset?: number; + namespaceManager?: Word.Interfaces.CustomXmlPrefixMappingData[]; /** - * Specifies a `BevelType` value that represents the bevel type for the top bevel. + * Specifies a `CustomXmlSchemaCollection` object representing the set of schemas attached to a bound region of data in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelTopType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; + schemaCollection?: Word.Interfaces.CustomXmlSchemaData[]; /** - * Specifies the width of the contour of a shape. + * Gets a value that indicates whether the `CustomXmlPart` is built-in. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contourWidth?: number; + builtIn?: boolean; /** - * Specifies the depth of the shape's extrusion. + * Gets the ID of the custom XML part. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - depth?: number; + id?: string; /** - * Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion) - and automatically changes when the shape's fill changes, or whether the extrusion color is independent of the shape's fill. + * Gets the namespace URI of the custom XML part. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - extrusionColorType?: Word.ExtrusionColorType | "mixed" | "automatic" | "custom"; + namespaceUri?: string; /** - * Specifies the amount of perspective for a shape. + * Gets the XML representation of the current `CustomXmlPart` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fieldOfView?: number; + xml?: string; + } + /** An interface describing the data returned by calling `customXmlPartCollection.toJSON()`. */ + interface CustomXmlPartCollectionData { + items?: Word.Interfaces.CustomXmlPartData[]; + } + /** An interface describing the data returned by calling `customXmlPartScopedCollection.toJSON()`. */ + interface CustomXmlPartScopedCollectionData { + items?: Word.Interfaces.CustomXmlPartData[]; + } + /** An interface describing the data returned by calling `document.toJSON()`. */ + interface DocumentData { /** - * Specifies `true` if the extrusion appears in perspective — that is, if the walls of the extrusion narrow toward a vanishing point, - `false` if the extrusion is a parallel, or orthographic, projection — that is, if the walls don't narrow toward a vanishing point. + * Gets the active window for the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - isPerspective?: boolean; + activeWindow?: Word.Interfaces.WindowData; /** - * Specifies if the specified object, or the formatting applied to it, is visible. + * Returns a `Bibliography` object that represents the bibliography references contained within the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + bibliography?: Word.Interfaces.BibliographyData; /** - * Specifies the angle of the lighting. + * Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - lightAngle?: number; + body?: Word.Interfaces.BodyData; /** - * Specifies a `LightRigType` value that represents the lighting preset. + * Gets a `Coauthoring` object for managing coauthoring in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetLighting?: Word.LightRigType | "Mixed" | "LegacyFlat1" | "LegacyFlat2" | "LegacyFlat3" | "LegacyFlat4" | "LegacyNormal1" | "LegacyNormal2" | "LegacyNormal3" | "LegacyNormal4" | "LegacyHarsh1" | "LegacyHarsh2" | "LegacyHarsh3" | "LegacyHarsh4" | "ThreePoint" | "Balanced" | "Soft" | "Harsh" | "Flood" | "Contrasting" | "Morning" | "Sunrise" | "Sunset" | "Chilly" | "Freezing" | "Flat" | "TwoPoint" | "Glow" | "BrightRoom"; + coauthoring?: Word.Interfaces.CoauthoringData; /** - * Specifies the position of the light source relative to the extrusion. + * Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - presetLightingDirection?: Word.PresetLightingDirection | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "None" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; + contentControls?: Word.Interfaces.ContentControlData[]; /** - * Specifies the intensity of the extrusion lighting. + * Gets the custom XML parts in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - presetLightingSoftness?: Word.PresetLightingSoftness | "Mixed" | "Dim" | "Normal" | "Bright"; + customXmlParts?: Word.Interfaces.CustomXmlPartData[]; /** - * Specifies the extrusion surface material. + * Returns a `DocumentLibraryVersionCollection` object that represents the collection of versions of a shared document that has versioning enabled and that's stored in a document library on a server. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetMaterial?: Word.PresetMaterial | "Mixed" | "Matte" | "Plastic" | "Metal" | "WireFrame" | "Matte2" | "Plastic2" | "Metal2" | "WarmMatte" | "TranslucentPowder" | "Powder" | "DarkEdge" | "SoftEdge" | "Clear" | "Flat" | "SoftMetal"; + documentLibraryVersions?: Word.Interfaces.DocumentLibraryVersionData[]; /** - * Specifies whether text on a shape rotates with shape. `true` rotates the text. + * Returns a `FrameCollection` object that represents all the frames in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - projectText?: boolean; + frames?: Word.Interfaces.FrameData[]; /** - * Specifies the rotation of the extruded shape around the x-axis in degrees. + * Returns a `HyperlinkCollection` object that represents all the hyperlinks in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotationX?: number; + hyperlinks?: Word.Interfaces.HyperlinkData[]; /** - * Specifies the rotation of the extruded shape around the y-axis in degrees. + * Returns a `ListTemplateCollection` object that represents all the list templates in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotationY?: number; + listTemplates?: Word.Interfaces.ListTemplateData[]; /** - * Specifies the z-axis rotation of the camera. + * Returns a `PageSetup` object that's associated with the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotationZ?: number; + pageSetup?: Word.Interfaces.PageSetupData; /** - * Specifies the position on the z-axis for the shape. + * Gets the properties of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - z?: number; - } - /** An interface for updating data on the `Bibliography` object, for use in `bibliography.set({ ... })`. */ - interface BibliographyUpdateData { + properties?: Word.Interfaces.DocumentPropertiesData; /** - * Specifies the name of the active style to use for the bibliography. + * Gets the collection of section objects in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - bibliographyStyle?: string; - } - /** An interface for updating data on the `SourceCollection` object, for use in `sourceCollection.set({ ... })`. */ - interface SourceCollectionUpdateData { - items?: Word.Interfaces.SourceData[]; - } - /** An interface for updating data on the `PageSetup` object, for use in `pageSetup.set({ ... })`. */ - interface PageSetupUpdateData { + sections?: Word.Interfaces.SectionData[]; /** - * Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object. + * Returns a `Selection` object that represents the current selection in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lineNumbering?: Word.Interfaces.LineNumberingUpdateData; + selection?: Word.Interfaces.SelectionData; /** - * Specifies whether Microsoft Word prints the document as a booklet. + * Gets the add-in's settings in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - bookFoldPrinting?: boolean; + settings?: Word.Interfaces.SettingData[]; /** - * Specifies the number of pages for each booklet. + * Gets the collection of `Word.Window` objects for the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - bookFoldPrintingSheets?: number; + windows?: Word.Interfaces.WindowData[]; /** - * Specifies if Microsoft Word reverses the printing order for book fold printing of bidirectional or Asian language documents. + * Specifies if automatic hyphenation is turned on for the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bookFoldReversePrinting?: boolean; + autoHyphenation?: boolean; /** - * Specifies the distance (in points) between the bottom edge of the page and the bottom boundary of the body text. + * Specifies if the edits in the document are automatically saved. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottomMargin?: number; + autoSaveOn?: boolean; /** - * Specifies the number of characters per line in the document grid. + * Specifies the ChangeTracking mode. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - charsLine?: number; + changeTrackingMode?: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly"; /** - * Specifies whether the first page has a different header and footer. + * Specifies the maximum number of consecutive lines that can end with hyphens. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - differentFirstPageHeaderFooter?: boolean; + consecutiveHyphensLimit?: number; /** - * Specifies the distance between the footer and the bottom of the page in points. + * Specifies whether words in all capital letters can be hyphenated. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footerDistance?: number; + hyphenateCaps?: boolean; /** - * Specifies the amount (in points) of extra margin space added to each page in a document or section for binding. + * Specifies whether Microsoft Word has detected the language of the document text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gutter?: number; + languageDetected?: boolean; /** - * Specifies on which side the gutter appears in a document. + * Indicates whether the changes in the document have been saved. A value of true indicates that the document hasn't changed since it was saved. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - gutterPosition?: Word.GutterPosition | "Left" | "Right" | "Top"; + saved?: boolean; + } + /** An interface describing the data returned by calling `documentCreated.toJSON()`. */ + interface DocumentCreatedData { /** - * Specifies whether Microsoft Word uses gutters for the current document based on a right-to-left language or a left-to-right language. + * Gets the body object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.3] + */ + body?: Word.Interfaces.BodyData; + /** + * Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.3] + */ + contentControls?: Word.Interfaces.ContentControlData[]; + /** + * Gets the custom XML parts in the document. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.4] + */ + customXmlParts?: Word.Interfaces.CustomXmlPartData[]; + /** + * Gets the properties of the document. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.3] + */ + properties?: Word.Interfaces.DocumentPropertiesData; + /** + * Gets the collection of section objects in the document. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.3] + */ + sections?: Word.Interfaces.SectionData[]; + /** + * Gets the add-in's settings in the document. + * + * @remarks + * [Api set: WordApiHiddenDocument 1.4] + */ + settings?: Word.Interfaces.SettingData[]; + /** + * Indicates whether the changes in the document have been saved. A value of true indicates that the document hasn't changed since it was saved. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiHiddenDocument 1.3] */ - gutterStyle?: Word.GutterStyle | "Bidirectional" | "Latin"; + saved?: boolean; + } + /** An interface describing the data returned by calling `documentProperties.toJSON()`. */ + interface DocumentPropertiesData { /** - * Specifies the distance between the header and the top of the page in points. + * Gets the collection of custom properties of the document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + customProperties?: Word.Interfaces.CustomPropertyData[]; + /** + * Gets the application name of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - headerDistance?: number; + applicationName?: string; /** - * Specifies the layout mode for the current document. + * Specifies the author of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - layoutMode?: Word.LayoutMode | "Default" | "Grid" | "LineGrid" | "Genko"; + author?: string; /** - * Specifies the distance (in points) between the left edge of the page and the left boundary of the body text. + * Specifies the category of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - leftMargin?: number; + category?: string; /** - * Specifies the number of lines per page in the document grid. + * Specifies the Comments field in the metadata of the document. These have no connection to comments by users made in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - linesPage?: number; + comments?: string; /** - * Specifies if the inside and outside margins of facing pages are the same width. + * Specifies the company of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - mirrorMargins?: boolean; + company?: string; /** - * Specifies whether odd and even pages have different headers and footers. + * Gets the creation date of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - oddAndEvenPagesHeaderFooter?: boolean; + creationDate?: Date; /** - * Specifies the orientation of the page. + * Specifies the format of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - orientation?: Word.PageOrientation | "Portrait" | "Landscape"; + format?: string; /** - * Specifies the page height in points. + * Specifies the keywords of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - pageHeight?: number; + keywords?: string; /** - * Specifies the page width in points. + * Gets the last author of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - pageWidth?: number; + lastAuthor?: string; /** - * Specifies the paper size of the page. + * Gets the last print date of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - paperSize?: Word.PaperSize | "Size10x14" | "Size11x17" | "Letter" | "LetterSmall" | "Legal" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "CSheet" | "DSheet" | "ESheet" | "FanfoldLegalGerman" | "FanfoldStdGerman" | "FanfoldUS" | "Folio" | "Ledger" | "Note" | "Quarto" | "Statement" | "Tabloid" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC5" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeDL" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "Custom"; + lastPrintDate?: Date; /** - * Specifies the distance (in points) between the right edge of the page and the right boundary of the body text. + * Gets the last save time of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - rightMargin?: number; + lastSaveTime?: Date; /** - * Specifies the reading order and alignment for the specified sections. + * Specifies the manager of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - sectionDirection?: Word.SectionDirection | "RightToLeft" | "LeftToRight"; + manager?: string; /** - * Specifies the type of section break for the specified object. + * Gets the revision number of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - sectionStart?: Word.SectionStart | "Continuous" | "NewColumn" | "NewPage" | "EvenPage" | "OddPage"; + revisionNumber?: string; /** - * Specifies whether to show the grid. + * Gets security settings of the document. Some are access restrictions on the file on disk. Others are Document Protection settings. Some possible values are 0 = File on disk is read/write; 1 = Protect Document: File is encrypted and requires a password to open; 2 = Protect Document: Always Open as Read-Only; 3 = Protect Document: Both #1 and #2; 4 = File on disk is read-only; 5 = Both #1 and #4; 6 = Both #2 and #4; 7 = All of #1, #2, and #4; 8 = Protect Document: Restrict Edit to read-only; 9 = Both #1 and #8; 10 = Both #2 and #8; 11 = All of #1, #2, and #8; 12 = Both #4 and #8; 13 = All of #1, #4, and #8; 14 = All of #2, #4, and #8; 15 = All of #1, #2, #4, and #8. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - showGrid?: boolean; + security?: number; /** - * Specifies if endnotes are printed at the end of the next section that doesn't suppress endnotes. + * Specifies the subject of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - suppressEndnotes?: boolean; + subject?: string; /** - * Specifies the top margin of the page in points. + * Gets the template of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - topMargin?: number; + template?: string; /** - * Specifies whether to print two pages per sheet. + * Specifies the title of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - twoPagesOnOne?: boolean; + title?: string; + } + /** An interface describing the data returned by calling `dropDownListContentControl.toJSON()`. */ + interface DropDownListContentControlData { + } + /** An interface describing the data returned by calling `comboBoxContentControl.toJSON()`. */ + interface ComboBoxContentControlData { + } + /** An interface describing the data returned by calling `field.toJSON()`. */ + interface FieldData { /** - * Specifies the vertical alignment of text on each page in a document or section. + * Gets the field's result data. + * + * @remarks + * [Api set: WordApi 1.4] + */ + result?: Word.Interfaces.RangeData; + /** + * Specifies the field's code instruction. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] + * + * Note: The ability to set the code was introduced in WordApi 1.5. */ - verticalAlignment?: Word.PageSetupVerticalAlignment | "Top" | "Center" | "Justify" | "Bottom"; - } - /** An interface for updating data on the `LineNumbering` object, for use in `lineNumbering.set({ ... })`. */ - interface LineNumberingUpdateData { + code?: string; /** - * Specifies the numeric increment for line numbers. + * Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is `null` and it will throw a general exception when code attempts to set it. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - countBy?: number; + data?: string; /** - * Specifies the distance (in points) between the right edge of line numbers and the left edge of the document text. + * Gets the field's kind. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - distanceFromText?: number; + kind?: Word.FieldKind | "None" | "Hot" | "Warm" | "Cold"; /** - * Specifies if line numbering is active for the specified document, section, or sections. + * Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - isActive?: boolean; + locked?: boolean; /** - * Specifies the way line numbering runs; that is, whether it starts over at the beginning of a new page or section, or runs continuously. + * Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - restartMode?: Word.NumberingRule | "RestartContinuous" | "RestartSection" | "RestartPage"; + showCodes?: boolean; /** - * Specifies the starting line number. + * Gets the field's type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - startingNumber?: number; + type?: Word.FieldType | "Addin" | "AddressBlock" | "Advance" | "Ask" | "Author" | "AutoText" | "AutoTextList" | "BarCode" | "Bibliography" | "BidiOutline" | "Citation" | "Comments" | "Compare" | "CreateDate" | "Data" | "Database" | "Date" | "DisplayBarcode" | "DocProperty" | "DocVariable" | "EditTime" | "Embedded" | "EQ" | "Expression" | "FileName" | "FileSize" | "FillIn" | "FormCheckbox" | "FormDropdown" | "FormText" | "GotoButton" | "GreetingLine" | "Hyperlink" | "If" | "Import" | "Include" | "IncludePicture" | "IncludeText" | "Index" | "Info" | "Keywords" | "LastSavedBy" | "Link" | "ListNum" | "MacroButton" | "MergeBarcode" | "MergeField" | "MergeRec" | "MergeSeq" | "Next" | "NextIf" | "NoteRef" | "NumChars" | "NumPages" | "NumWords" | "OCX" | "Page" | "PageRef" | "Print" | "PrintDate" | "Private" | "Quote" | "RD" | "Ref" | "RevNum" | "SaveDate" | "Section" | "SectionPages" | "Seq" | "Set" | "Shape" | "SkipIf" | "StyleRef" | "Subject" | "Subscriber" | "Symbol" | "TA" | "TC" | "Template" | "Time" | "Title" | "TOA" | "TOC" | "UserAddress" | "UserInitials" | "UserName" | "XE" | "Empty" | "Others" | "Undefined"; } - /** An interface for updating data on the `TextColumnCollection` object, for use in `textColumnCollection.set({ ... })`. */ - interface TextColumnCollectionUpdateData { - items?: Word.Interfaces.TextColumnData[]; + /** An interface describing the data returned by calling `fieldCollection.toJSON()`. */ + interface FieldCollectionData { + items?: Word.Interfaces.FieldData[]; } - /** An interface for updating data on the `TextColumn` object, for use in `textColumn.set({ ... })`. */ - interface TextColumnUpdateData { + /** An interface describing the data returned by calling `font.toJSON()`. */ + interface FontData { /** - * Specifies the amount of spacing (in points) after the specified paragraph or text column. + * Returns a `BorderUniversalCollection` object that represents all the borders for the font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spaceAfter?: number; + borders?: Word.Interfaces.BorderUniversalData[]; /** - * Specifies the width, in points, of the specified text columns. + * Returns a `FillFormat` object that contains fill formatting properties for the font used by the range of text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - width?: number; - } - /** An interface for updating data on the `Bookmark` object, for use in `bookmark.set({ ... })`. */ - interface BookmarkUpdateData { + fill?: Word.Interfaces.FillFormatData; /** - * Returns a `Range` object that represents the portion of the document that's contained in the `Bookmark` object. + * Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeUpdateData; + glow?: Word.Interfaces.GlowFormatData; /** - * Specifies the ending character position of the bookmark. + * Returns a `LineFormat` object that specifies the formatting for a line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - end?: number; + line?: Word.Interfaces.LineFormatData; /** - * Specifies the starting character position of the bookmark. + * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - start?: number; - } - /** An interface for updating data on the `BookmarkCollection` object, for use in `bookmarkCollection.set({ ... })`. */ - interface BookmarkCollectionUpdateData { - items?: Word.Interfaces.BookmarkData[]; - } - /** An interface for updating data on the `Index` object, for use in `index.set({ ... })`. */ - interface IndexUpdateData { + reflection?: Word.Interfaces.ReflectionFormatData; /** - * Returns a `Range` object that represents the portion of the document that is contained within the index. + * Returns a `ColorFormat` object that represents the color for the font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeUpdateData; + textColor?: Word.Interfaces.ColorFormatData; /** - * Specifies the leader character between entries in the index and their associated page numbers. + * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; - } - /** An interface for updating data on the `IndexCollection` object, for use in `indexCollection.set({ ... })`. */ - interface IndexCollectionUpdateData { - items?: Word.Interfaces.IndexData[]; - } - /** An interface describing the data returned by calling `critiqueAnnotation.toJSON()`. */ - interface CritiqueAnnotationData { + textShadow?: Word.Interfaces.ShadowFormatData; /** - * Gets the critique that was passed when the annotation was inserted. + * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - critique?: Word.Critique; - } - /** An interface describing the data returned by calling `annotation.toJSON()`. */ - interface AnnotationData { + threeDimensionalFormat?: Word.Interfaces.ThreeDimensionalFormatData; /** - * Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects. + * Specifies whether the font is formatted as all capital letters, 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: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: string; + allCaps?: boolean; /** - * Gets the state of the annotation. + * Specifies a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi 1.1] */ - state?: Word.AnnotationState | "Created" | "Accepted" | "Rejected"; - } - /** An interface describing the data returned by calling `annotationCollection.toJSON()`. */ - interface AnnotationCollectionData { - items?: Word.Interfaces.AnnotationData[]; - } - /** An interface describing the data returned by calling `application.toJSON()`. */ - interface ApplicationData { + bold?: boolean; /** - * Returns a `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word. + * Specifies whether the font is formatted as bold in a right-to-left language document. 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - bibliography?: Word.Interfaces.BibliographyData; + boldBidirectional?: boolean; /** - * Specifies if Microsoft Word automatically detects the language you are using as you type. + * Specifies the color for the specified font. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - checkLanguage?: boolean; + color?: string; /** - * Gets a `LanguageId` value that represents the language selected for the Microsoft Word user interface. + * Specifies a `ColorIndex` value that represents the color for the font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - language?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; - } - /** An interface describing the data returned by calling `body.toJSON()`. */ - interface BodyData { + colorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Gets the collection of rich text content control objects in the body. + * Specifies the color for the `Font` object in a right-to-left language document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - contentControls?: Word.Interfaces.ContentControlData[]; + colorIndexBidirectional?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Gets the collection of field objects in the body. + * Specifies whether contextual alternates are enabled for the font. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - fields?: Word.Interfaces.FieldData[]; + contextualAlternates?: boolean; /** - * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. + * Specifies the color to be used for diacritics for the `Font` object. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontData; + diacriticColor?: string; /** - * Gets the collection of InlinePicture objects in the body. The collection doesn't include floating images. + * Specifies whether Microsoft Word ignores the number of characters per line for the corresponding `Font` object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - inlinePictures?: Word.Interfaces.InlinePictureData[]; + disableCharacterSpaceGrid?: boolean; /** - * Gets the collection of list objects in the body. + * Specifies a value that indicates whether the font has a double strikethrough. True if the font is formatted as double strikethrough text, otherwise, false. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - lists?: Word.Interfaces.ListData[]; + doubleStrikeThrough?: boolean; /** - * Gets the collection of paragraph objects in the body. + * Specifies whether the font is formatted as embossed. The possible values are as follows: + + - `true`: All the text is embossed. + + - `false`: None of the text is embossed. + + - `null`: Returned if some, but not all, of the text is embossed. * * @remarks - * [Api set: WordApi 1.1] - * - * Important: Paragraphs in tables aren't returned for requirement sets 1.1 and 1.2. From requirement set 1.3, paragraphs in tables are also returned. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - paragraphs?: Word.Interfaces.ParagraphData[]; + emboss?: boolean; /** - * Gets the collection of shape objects in the body, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * Specifies an `EmphasisMark` value that represents the emphasis mark for a character or designated character string. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shapes?: Word.Interfaces.ShapeData[]; + emphasisMark?: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle"; /** - * Gets the collection of table objects in the body. + * Specifies whether the font is formatted as engraved. The possible values are as follows: + + - `true`: All the text is engraved. + + - `false`: None of the text is engraved. + + - `null`: Returned if some, but not all, of the text is engraved. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tables?: Word.Interfaces.TableData[]; + engrave?: boolean; /** - * Specifies the style name for the body. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * Specifies a value that indicates whether the font is tagged as hidden. True if the font is formatted as hidden text, otherwise, false. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - style?: string; + hidden?: boolean; /** - * Specifies the built-in style name for the body. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or `null` for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + highlightColor?: string; /** - * Gets the text of the body. Use the insertText method to insert text. + * Specifies a value that indicates whether the font is italicized. True if the font is italicized, otherwise, false. * * @remarks * [Api set: WordApi 1.1] */ - text?: string; + italic?: boolean; /** - * Gets the type of the body. The type can be 'MainDoc', 'Section', 'Header', 'Footer', or 'TableCell'. Additional types ‘Footnote’, ‘Endnote’, and ‘NoteItem’ are supported in WordApiOnline 1.1 and later. + * Specifies whether the font is italicized in a right-to-left language document. 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: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: Word.BodyType | "Unknown" | "MainDoc" | "Section" | "Header" | "Footer" | "TableCell" | "Footnote" | "Endnote" | "NoteItem" | "Shape"; - } - /** An interface describing the data returned by calling `border.toJSON()`. */ - interface BorderData { + italicBidirectional?: boolean; /** - * Specifies the color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name. + * Specifies the minimum font size for which Microsoft Word will adjust kerning automatically. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - color?: string; + kerning?: number; /** - * Gets the location of the border. + * Specifies the ligature setting for the `Font` object. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - location?: Word.BorderLocation | "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical" | "Inside" | "Outside" | "All"; + ligature?: Word.Ligature | "None" | "Standard" | "Contextual" | "StandardContextual" | "Historical" | "StandardHistorical" | "ContextualHistorical" | "StandardContextualHistorical" | "Discretional" | "StandardDiscretional" | "ContextualDiscretional" | "StandardContextualDiscretional" | "HistoricalDiscretional" | "StandardHistoricalDiscretional" | "ContextualHistoricalDiscretional" | "All"; /** - * Specifies the border type for the border. + * Specifies a value that represents the name of the font. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.1] */ - type?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + name?: string; /** - * Specifies whether the border is visible. + * Specifies the font used for Latin text (characters with character codes from 0 (zero) through 127). * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - visible?: boolean; + nameAscii?: string; /** - * Specifies the width for the border. + * Specifies the font name in a right-to-left language document. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed"; - } - /** An interface describing the data returned by calling `borderUniversal.toJSON()`. */ - interface BorderUniversalData { + nameBidirectional?: string; /** - * Specifies the graphical page-border design for the document. + * Specifies the East Asian font name. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - artStyle?: Word.PageBorderArt | "Apples" | "MapleMuffins" | "CakeSlice" | "CandyCorn" | "IceCreamCones" | "ChampagneBottle" | "PartyGlass" | "ChristmasTree" | "Trees" | "PalmsColor" | "Balloons3Colors" | "BalloonsHotAir" | "PartyFavor" | "ConfettiStreamers" | "Hearts" | "HeartBalloon" | "Stars3D" | "StarsShadowed" | "Stars" | "Sun" | "Earth2" | "Earth1" | "PeopleHats" | "Sombrero" | "Pencils" | "Packages" | "Clocks" | "Firecrackers" | "Rings" | "MapPins" | "Confetti" | "CreaturesButterfly" | "CreaturesLadyBug" | "CreaturesFish" | "BirdsFlight" | "ScaredCat" | "Bats" | "FlowersRoses" | "FlowersRedRose" | "Poinsettias" | "Holly" | "FlowersTiny" | "FlowersPansy" | "FlowersModern2" | "FlowersModern1" | "WhiteFlowers" | "Vine" | "FlowersDaisies" | "FlowersBlockPrint" | "DecoArchColor" | "Fans" | "Film" | "Lightning1" | "Compass" | "DoubleD" | "ClassicalWave" | "ShadowedSquares" | "TwistedLines1" | "Waveline" | "Quadrants" | "CheckedBarColor" | "Swirligig" | "PushPinNote1" | "PushPinNote2" | "Pumpkin1" | "EggsBlack" | "Cup" | "HeartGray" | "GingerbreadMan" | "BabyPacifier" | "BabyRattle" | "Cabins" | "HouseFunky" | "StarsBlack" | "Snowflakes" | "SnowflakeFancy" | "Skyrocket" | "Seattle" | "MusicNotes" | "PalmsBlack" | "MapleLeaf" | "PaperClips" | "ShorebirdTracks" | "People" | "PeopleWaving" | "EclipsingSquares2" | "Hypnotic" | "DiamondsGray" | "DecoArch" | "DecoBlocks" | "CirclesLines" | "Papyrus" | "Woodwork" | "WeavingBraid" | "WeavingRibbon" | "WeavingAngles" | "ArchedScallops" | "Safari" | "CelticKnotwork" | "CrazyMaze" | "EclipsingSquares1" | "Birds" | "FlowersTeacup" | "Northwest" | "Southwest" | "Tribal6" | "Tribal4" | "Tribal3" | "Tribal2" | "Tribal5" | "XIllusions" | "ZanyTriangles" | "Pyramids" | "PyramidsAbove" | "ConfettiGrays" | "ConfettiOutline" | "ConfettiWhite" | "Mosaic" | "Lightning2" | "HeebieJeebies" | "LightBulb" | "Gradient" | "TriangleParty" | "TwistedLines2" | "Moons" | "Ovals" | "DoubleDiamonds" | "ChainLink" | "Triangles" | "Tribal1" | "MarqueeToothed" | "SharksTeeth" | "Sawtooth" | "SawtoothGray" | "PostageStamp" | "WeavingStrips" | "ZigZag" | "CrossStitch" | "Gems" | "CirclesRectangles" | "CornerTriangles" | "CreaturesInsects" | "ZigZagStitch" | "Checkered" | "CheckedBarBlack" | "Marquee" | "BasicWhiteDots" | "BasicWideMidline" | "BasicWideOutline" | "BasicWideInline" | "BasicThinLines" | "BasicWhiteDashes" | "BasicWhiteSquares" | "BasicBlackSquares" | "BasicBlackDashes" | "BasicBlackDots" | "StarsTop" | "CertificateBanner" | "Handmade1" | "Handmade2" | "TornPaper" | "TornPaperBlack" | "CouponCutoutDashes" | "CouponCutoutDots"; + nameFarEast?: string; /** - * Specifies the width (in points) of the graphical page border specified in the `artStyle` property. + * Specifies the font used for characters with codes from 128 through 255. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - artWidth?: number; + nameOther?: string; /** - * Specifies the color for the `BorderUniversal` object. You can provide the value in the '#RRGGBB' format. + * Specifies the number form setting for an OpenType font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + numberForm?: Word.NumberForm | "Default" | "Lining" | "OldStyle"; /** - * Specifies the color for the `BorderUniversal` or {@link Word.Font} object. + * Specifies the number spacing setting for the font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - colorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + numberSpacing?: Word.NumberSpacing | "Default" | "Proportional" | "Tabular"; /** - * Returns `true` if an inside border can be applied to the specified object. + * Specifies if the font is formatted as outlined. The possible values are as follows: + + - `true`: All the text is outlined. + + - `false`: None of the text is outlined. + + - `null`: Returned if some, but not all, of the text is outlined. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - inside?: boolean; + outline?: boolean; /** - * Specifies whether the border is visible. + * Specifies the position of text (in points) relative to the base line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + position?: number; /** - * Specifies the line style of the border. + * Specifies the scaling percentage applied to the font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lineStyle?: Word.BorderLineStyle | "None" | "Single" | "Dot" | "DashSmallGap" | "DashLargeGap" | "DashDot" | "DashDotDot" | "Double" | "Triple" | "ThinThickSmallGap" | "ThickThinSmallGap" | "ThinThickThinSmallGap" | "ThinThickMedGap" | "ThickThinMedGap" | "ThinThickThinMedGap" | "ThinThickLargeGap" | "ThickThinLargeGap" | "ThinThickThinLargeGap" | "SingleWavy" | "DoubleWavy" | "DashDotStroked" | "Emboss3D" | "Engrave3D" | "Outset" | "Inset"; + scaling?: number; /** - * Specifies the line width of an object's border. + * Specifies if the font is formatted as shadowed. The possible values are as follows: + + - `true`: All the text is shadowed. + + - `false`: None of the text is shadowed. + + - `null`: Returned if some, but not all, of the text is shadowed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lineWidth?: Word.LineWidth | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600"; - } - /** An interface describing the data returned by calling `borderCollection.toJSON()`. */ - interface BorderCollectionData { - items?: Word.Interfaces.BorderData[]; - } - /** An interface describing the data returned by calling `borderUniversalCollection.toJSON()`. */ - interface BorderUniversalCollectionData { - items?: Word.Interfaces.BorderUniversalData[]; - } - /** An interface describing the data returned by calling `break.toJSON()`. */ - interface BreakData { + shadow?: boolean; /** - * Returns a `Range` object that represents the portion of the document that's contained in the break. + * Specifies a value that represents the font size in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - range?: Word.Interfaces.RangeData; + size?: number; /** - * Returns the page number on which the break occurs. + * Specifies the font size in points for right-to-left text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageIndex?: number; - } - /** An interface describing the data returned by calling `breakCollection.toJSON()`. */ - interface BreakCollectionData { - items?: Word.Interfaces.BreakData[]; - } - /** An interface describing the data returned by calling `buildingBlock.toJSON()`. */ - interface BuildingBlockData { + sizeBidirectional?: number; /** - * Specifies the description for the building block. + * Specifies whether the font is formatted as small caps, 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - description?: string; + smallCaps?: boolean; /** - * Returns the internal identification number for the building block. + * Specifies the spacing between characters. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: string; + spacing?: number; /** - * Returns the position of this building block in a collection. + * Specifies a value that indicates whether the font has a strikethrough. True if the font is formatted as strikethrough text, otherwise, false. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - index?: number; + strikeThrough?: boolean; /** - * Specifies a `DocPartInsertType` value that represents how to insert the contents of the building block into the document. + * Specifies the stylistic set for the font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - insertType?: Word.DocPartInsertType | "Content" | "Paragraph" | "Page"; + stylisticSet?: Word.StylisticSet | "Default" | "Set01" | "Set02" | "Set03" | "Set04" | "Set05" | "Set06" | "Set07" | "Set08" | "Set09" | "Set10" | "Set11" | "Set12" | "Set13" | "Set14" | "Set15" | "Set16" | "Set17" | "Set18" | "Set19" | "Set20"; /** - * Specifies the name of the building block. + * Specifies a value that indicates whether the font is a subscript. True if the font is formatted as subscript, otherwise, false. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - name?: string; + subscript?: boolean; /** - * Specifies the contents of the building block. + * Specifies a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - value?: string; - } - /** An interface describing the data returned by calling `buildingBlockCategory.toJSON()`. */ - interface BuildingBlockCategoryData { + superscript?: boolean; /** - * Returns the position of the `BuildingBlockCategory` object in a collection. + * Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - index?: number; + underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; /** - * Returns the name of the `BuildingBlockCategory` object. + * Specifies the color of the underline for the `Font` object. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: string; + underlineColor?: string; } - /** An interface describing the data returned by calling `buildingBlockTypeItem.toJSON()`. */ - interface BuildingBlockTypeItemData { + /** An interface describing the data returned by calling `headingStyle.toJSON()`. */ + interface HeadingStyleData { /** - * Returns the position of an item in a collection. + * Specifies the level for the heading style in a table of contents or table of figures. Must be a value from 1 to 9. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - index?: number; + level?: number; /** - * Returns the localized name of a building block type. + * Specifies the name of style for a heading. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -140882,1422 +151143,1341 @@ declare namespace Word { */ name?: string; } - /** An interface describing the data returned by calling `checkboxContentControl.toJSON()`. */ - interface CheckboxContentControlData { - /** - * Specifies the current state of the checkbox. - * - * @remarks - * [Api set: WordApi 1.7] - */ - isChecked?: boolean; + /** An interface describing the data returned by calling `headingStyleCollection.toJSON()`. */ + interface HeadingStyleCollectionData { + items?: Word.Interfaces.HeadingStyleData[]; } - /** An interface describing the data returned by calling `comment.toJSON()`. */ - interface CommentData { - /** - * Specifies the comment's content range. - * - * @remarks - * [Api set: WordApi 1.4] - */ - contentRange?: Word.Interfaces.CommentContentRangeData; - /** - * Gets the collection of reply objects associated with the comment. - * - * @remarks - * [Api set: WordApi 1.4] - */ - replies?: Word.Interfaces.CommentReplyData[]; - /** - * Gets the email of the comment's author. - * - * @remarks - * [Api set: WordApi 1.4] - */ - authorEmail?: string; - /** - * Gets the name of the comment's author. - * - * @remarks - * [Api set: WordApi 1.4] - */ - authorName?: string; - /** - * Specifies the comment's content as plain text. - * - * @remarks - * [Api set: WordApi 1.4] - */ - content?: string; + /** An interface describing the data returned by calling `hyperlink.toJSON()`. */ + interface HyperlinkData { /** - * Gets the creation date of the comment. + * Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - creationDate?: Date; + range?: Word.Interfaces.RangeData; /** - * Gets the ID of the comment. + * Specifies the address (for example, a file name or URL) of the hyperlink. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: string; + address?: string; /** - * Specifies the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved. + * Specifies the text string for the hyperlink's subject line. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - resolved?: boolean; - } - /** An interface describing the data returned by calling `commentCollection.toJSON()`. */ - interface CommentCollectionData { - items?: Word.Interfaces.CommentData[]; - } - /** An interface describing the data returned by calling `commentContentRange.toJSON()`. */ - interface CommentContentRangeData { + emailSubject?: string; /** - * Specifies a value that indicates whether the comment text is bold. + * Returns `true` if extra information is required to resolve the hyperlink. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bold?: boolean; + isExtraInfoRequired?: boolean; /** - * Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. + * Returns the name of the `Hyperlink` object. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - hyperlink?: string; + name?: string; /** - * Checks whether the range length is zero. + * Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isEmpty?: boolean; + screenTip?: string; /** - * Specifies a value that indicates whether the comment text is italicized. + * Specifies a named location in the destination of the hyperlink. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - italic?: boolean; + subAddress?: string; /** - * Specifies a value that indicates whether the comment text has a strikethrough. + * Specifies the name of the frame or window in which to load the hyperlink. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - strikeThrough?: boolean; + target?: string; /** - * Gets the text of the comment range. + * Specifies the hyperlink's visible text in the document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - text?: string; + textToDisplay?: string; /** - * Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined. + * Returns the hyperlink type. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; + type?: Word.HyperlinkType | "Range" | "Shape" | "InlineShape"; } - /** An interface describing the data returned by calling `commentReply.toJSON()`. */ - interface CommentReplyData { + /** An interface describing the data returned by calling `hyperlinkCollection.toJSON()`. */ + interface HyperlinkCollectionData { + items?: Word.Interfaces.HyperlinkData[]; + } + /** An interface describing the data returned by calling `inlinePicture.toJSON()`. */ + interface InlinePictureData { /** - * Specifies the commentReply's content range. - * - * @remarks - * [Api set: WordApi 1.4] - */ - contentRange?: Word.Interfaces.CommentContentRangeData; + * Specifies a string that represents the alternative text associated with the inline image. + * + * @remarks + * [Api set: WordApi 1.1] + */ + altTextDescription?: string; /** - * Gets the parent comment of this reply. - * - * @remarks - * [Api set: WordApi 1.4] - */ - parentComment?: Word.Interfaces.CommentData; + * Specifies a string that contains the title for the inline image. + * + * @remarks + * [Api set: WordApi 1.1] + */ + altTextTitle?: string; /** - * Gets the email of the comment reply's author. + * Specifies a number that describes the height of the inline image. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - authorEmail?: string; + height?: number; /** - * Gets the name of the comment reply's author. + * Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - authorName?: string; + hyperlink?: string; /** - * Specifies the comment reply's content. The string is plain text. + * Gets the format of the inline image. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.1] */ - content?: string; + imageFormat?: Word.ImageFormat | "Unsupported" | "Undefined" | "Bmp" | "Jpeg" | "Gif" | "Tiff" | "Png" | "Icon" | "Exif" | "Wmf" | "Emf" | "Pict" | "Pdf" | "Svg"; /** - * Gets the creation date of the comment reply. + * Specifies a value that indicates whether the inline image retains its original proportions when you resize it. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - creationDate?: Date; + lockAspectRatio?: boolean; /** - * Gets the ID of the comment reply. + * Specifies a number that describes the width of the inline image. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - id?: string; + width?: number; } - /** An interface describing the data returned by calling `commentReplyCollection.toJSON()`. */ - interface CommentReplyCollectionData { - items?: Word.Interfaces.CommentReplyData[]; + /** An interface describing the data returned by calling `inlinePictureCollection.toJSON()`. */ + interface InlinePictureCollectionData { + items?: Word.Interfaces.InlinePictureData[]; } - /** An interface describing the data returned by calling `xmlMapping.toJSON()`. */ - interface XmlMappingData { + /** An interface describing the data returned by calling `linkFormat.toJSON()`. */ + interface LinkFormatData { /** - * Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to. + * Specifies if the link is updated automatically when the container file is opened or when the source file is changed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customXmlNode?: Word.Interfaces.CustomXmlNodeData; + isAutoUpdated?: boolean; /** - * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. + * Specifies if a `Field`, `InlineShape`, or `Shape` object is locked to prevent automatic updating. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customXmlPart?: Word.Interfaces.CustomXmlPartData; + isLocked?: boolean; /** - * Returns whether the content control in the document is mapped to an XML node in the document's XML data store. + * Specifies if the linked picture is saved with the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isMapped?: boolean; + isPictureSavedWithDocument?: boolean; /** - * Returns the prefix mappings used to evaluate the XPath for the current XML mapping. + * Specifies the path and name of the source file for the linked OLE object, picture, or field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - prefixMappings?: string; + sourceFullName?: string; /** - * Returns the XPath for the XML mapping, which evaluates to the currently mapped XML node. + * Gets the name of the source file for the linked OLE object, picture, or field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xpath?: string; - } - /** An interface describing the data returned by calling `customXmlPrefixMappingCollection.toJSON()`. */ - interface CustomXmlPrefixMappingCollectionData { - items?: Word.Interfaces.CustomXmlPrefixMappingData[]; - } - /** An interface describing the data returned by calling `customXmlPrefixMapping.toJSON()`. */ - interface CustomXmlPrefixMappingData { + sourceName?: string; /** - * Gets the unique address identifier for the namespace of the `CustomXmlPrefixMapping` object. + * Gets the path of the source file for the linked OLE object, picture, or field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - namespaceUri?: string; + sourcePath?: string; /** - * Gets the prefix for the `CustomXmlPrefixMapping` object. + * Gets the link type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - prefix?: string; + type?: Word.LinkType | "Ole" | "Picture" | "Text" | "Reference" | "Include" | "Import" | "Dde" | "DdeAuto" | "Chart"; } - /** An interface describing the data returned by calling `customXmlSchema.toJSON()`. */ - interface CustomXmlSchemaData { + /** An interface describing the data returned by calling `list.toJSON()`. */ + interface ListData { /** - * Gets the location of the schema on a computer. + * Gets paragraphs in the list. + * + * @remarks + * [Api set: WordApi 1.3] + */ + paragraphs?: Word.Interfaces.ParagraphData[]; + /** + * Gets the list's id. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - location?: string; + id?: number; /** - * Gets the unique address identifier for the namespace of the `CustomXmlSchema` object. + * Checks whether each of the 9 levels exists in the list. A true value indicates the level exists, which means there is at least one list item at that level. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - namespaceUri?: string; + levelExistences?: boolean[]; + /** + * Gets all 9 level types in the list. Each type can be 'Bullet', 'Number', or 'Picture'. + * + * @remarks + * [Api set: WordApi 1.3] + */ + levelTypes?: Word.ListLevelType[]; } - /** An interface describing the data returned by calling `customXmlSchemaCollection.toJSON()`. */ - interface CustomXmlSchemaCollectionData { - items?: Word.Interfaces.CustomXmlSchemaData[]; + /** An interface describing the data returned by calling `listCollection.toJSON()`. */ + interface ListCollectionData { + items?: Word.Interfaces.ListData[]; } - /** An interface describing the data returned by calling `customXmlValidationErrorCollection.toJSON()`. */ - interface CustomXmlValidationErrorCollectionData { - items?: Word.Interfaces.CustomXmlValidationErrorData[]; + /** An interface describing the data returned by calling `listItem.toJSON()`. */ + interface ListItemData { + /** + * Specifies the level of the item in the list. + * + * @remarks + * [Api set: WordApi 1.3] + */ + level?: number; + /** + * Gets the list item bullet, number, or picture as a string. + * + * @remarks + * [Api set: WordApi 1.3] + */ + listString?: string; + /** + * Gets the list item order number in relation to its siblings. + * + * @remarks + * [Api set: WordApi 1.3] + */ + siblingIndex?: number; } - /** An interface describing the data returned by calling `customXmlValidationError.toJSON()`. */ - interface CustomXmlValidationErrorData { + /** An interface describing the data returned by calling `listLevel.toJSON()`. */ + interface ListLevelData { /** - * Gets the node associated with this `CustomXmlValidationError` object, if any exist.If no nodes exist, the property returns `Nothing`. + * Gets a Font object that represents the character formatting of the specified object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - node?: Word.Interfaces.CustomXmlNodeData; + font?: Word.Interfaces.FontData; /** - * Gets an integer representing the validation error in the `CustomXmlValidationError` object. + * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - errorCode?: number; + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Gets the name of the error in the `CustomXmlValidationError` object.If no errors exist, the property returns `Nothing` + * Specifies the name of the style that's linked to the specified list level object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - name?: string; + linkedStyle?: string; /** - * Gets the text in the `CustomXmlValidationError` object. + * Specifies the number format for the specified list level. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - text?: string; + numberFormat?: string; /** - * Gets the type of error generated from the `CustomXmlValidationError` object. + * Specifies the position (in points) of the number or bullet for the specified list level object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - type?: Word.CustomXmlValidationErrorType | "schemaGenerated" | "automaticallyCleared" | "manual"; - } - /** An interface describing the data returned by calling `customXmlNodeCollection.toJSON()`. */ - interface CustomXmlNodeCollectionData { - items?: Word.Interfaces.CustomXmlNodeData[]; - } - /** An interface describing the data returned by calling `customXmlNode.toJSON()`. */ - interface CustomXmlNodeData { + numberPosition?: number; /** - * Gets a `CustomXmlNodeCollection` object representing the attributes of the current element in the current node. + * Specifies the number style for the list level object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - attributes?: Word.Interfaces.CustomXmlNodeData[]; + numberStyle?: Word.ListBuiltInNumberStyle | "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter" | "Ordinal" | "CardinalText" | "OrdinalText" | "Kanji" | "KanjiDigit" | "AiueoHalfWidth" | "IrohaHalfWidth" | "ArabicFullWidth" | "KanjiTraditional" | "KanjiTraditional2" | "NumberInCircle" | "Aiueo" | "Iroha" | "ArabicLZ" | "Bullet" | "Ganada" | "Chosung" | "GBNum1" | "GBNum2" | "GBNum3" | "GBNum4" | "Zodiac1" | "Zodiac2" | "Zodiac3" | "TradChinNum1" | "TradChinNum2" | "TradChinNum3" | "TradChinNum4" | "SimpChinNum1" | "SimpChinNum2" | "SimpChinNum3" | "SimpChinNum4" | "HanjaRead" | "HanjaReadDigit" | "Hangul" | "Hanja" | "Hebrew1" | "Arabic1" | "Hebrew2" | "Arabic2" | "HindiLetter1" | "HindiLetter2" | "HindiArabic" | "HindiCardinalText" | "ThaiLetter" | "ThaiArabic" | "ThaiCardinalText" | "VietCardinalText" | "LowercaseRussian" | "UppercaseRussian" | "LowercaseGreek" | "UppercaseGreek" | "ArabicLZ2" | "ArabicLZ3" | "ArabicLZ4" | "LowercaseTurkish" | "UppercaseTurkish" | "LowercaseBulgarian" | "UppercaseBulgarian" | "PictureBullet" | "Legal" | "LegalLZ"; /** - * Gets a `CustomXmlNodeCollection` object containing all of the child elements of the current node. + * Specifies the list level that must appear before the specified list level restarts numbering at 1. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - childNodes?: Word.Interfaces.CustomXmlNodeData[]; + resetOnHigher?: number; /** - * Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. + * Specifies the starting number for the specified list level object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - firstChild?: Word.Interfaces.CustomXmlNodeData; + startAt?: number; /** - * Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. + * Specifies the tab position for the specified list level object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - lastChild?: Word.Interfaces.CustomXmlNodeData; + tabPosition?: number; /** - * Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. + * Specifies the position (in points) for the second line of wrapping text for the specified list level object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - nextSibling?: Word.Interfaces.CustomXmlNodeData; + textPosition?: number; /** - * Gets the object representing the part associated with this node. + * Specifies the character inserted after the number for the specified list level. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - ownerPart?: Word.Interfaces.CustomXmlPartData; + trailingCharacter?: Word.TrailingCharacter | "TrailingTab" | "TrailingSpace" | "TrailingNone"; + } + /** An interface describing the data returned by calling `listLevelCollection.toJSON()`. */ + interface ListLevelCollectionData { + items?: Word.Interfaces.ListLevelData[]; + } + /** An interface describing the data returned by calling `listTemplate.toJSON()`. */ + interface ListTemplateData { /** - * Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. + * Gets a `ListLevelCollection` object that represents all the levels for the list template. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - parentNode?: Word.Interfaces.CustomXmlNodeData; + listLevels?: Word.Interfaces.ListLevelData[]; /** - * Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. + * Specifies the name of the list template. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - previousSibling?: Word.Interfaces.CustomXmlNodeData; + name?: string; /** - * Gets the base name of the node without the namespace prefix, if one exists. + * Specifies whether the list template is outline numbered. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - baseName?: string; + outlineNumbered?: boolean; + } + /** An interface describing the data returned by calling `noteItem.toJSON()`. */ + interface NoteItemData { /** - * Gets the unique address identifier for the namespace of the node. + * Represents the body object of the note item. It's the portion of the text within the footnote or endnote. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - namespaceUri?: string; + body?: Word.Interfaces.BodyData; /** - * Gets the type of the current node. + * Represents a footnote or endnote reference in the main document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - nodeType?: Word.CustomXmlNodeType | "element" | "attribute" | "text" | "cData" | "processingInstruction" | "comment" | "document"; + reference?: Word.Interfaces.RangeData; /** - * Specifies the value of the current node. + * Represents the note item type: footnote or endnote. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - nodeValue?: string; + type?: Word.NoteItemType | "Footnote" | "Endnote"; + } + /** An interface describing the data returned by calling `noteItemCollection.toJSON()`. */ + interface NoteItemCollectionData { + items?: Word.Interfaces.NoteItemData[]; + } + /** An interface describing the data returned by calling `oleFormat.toJSON()`. */ + interface OleFormatData { /** - * Specifies the text for the current node. + * Specifies the class type for the specified OLE object, picture, or field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - text?: string; + classType?: string; /** - * Gets a string with the canonicalized XPath for the current node. If the node is no longer in the Document Object Model (DOM), the property returns an error message. + * Specifies the icon that is used when the `displayAsIcon` property is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xpath?: string; + iconIndex?: number; /** - * Gets the XML representation of the current node and its children. + * Specifies the text displayed below the icon for the OLE object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xml?: string; - } - /** An interface describing the data returned by calling `contentControl.toJSON()`. */ - interface ContentControlData { + iconLabel?: string; /** - * Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `BuildingBlockGallery`. It's `null` otherwise. + * Specifies the program file in which the icon for the OLE object is stored. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlData; + iconName?: string; /** - * Gets the data of the content control when its type is `CheckBox`. It's `null` otherwise. + * Gets the path of the file in which the icon for the OLE object is stored. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - checkboxContentControl?: Word.Interfaces.CheckboxContentControlData; + iconPath?: string; /** - * Gets the data of the content control when its type is `ComboBox`. It's `null` otherwise. + * Gets whether the specified object is displayed as an icon. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - comboBoxContentControl?: Word.Interfaces.ComboBoxContentControlData; + isDisplayedAsIcon?: boolean; /** - * Gets the collection of content control objects in the content control. + * Specifies whether formatting done in Microsoft Word to the linked OLE object is preserved. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - contentControls?: Word.Interfaces.ContentControlData[]; + isFormattingPreservedOnUpdate?: boolean; /** - * Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `DatePicker`. It's `null` otherwise. + * Gets a string that's used to identify the portion of the source file that's being linked. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - datePickerContentControl?: Word.Interfaces.DatePickerContentControlData; + label?: string; /** - * Gets the data of the content control when its type is `DropDownList`. It's `null` otherwise. + * Gets the programmatic identifier (`ProgId`) for the specified OLE object. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - dropDownListContentControl?: Word.Interfaces.DropDownListContentControlData; + progID?: string; + } + /** An interface describing the data returned by calling `page.toJSON()`. */ + interface PageData { /** - * Gets the collection of field objects in the content control. + * Gets a `BreakCollection` object that represents the breaks on the page. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - fields?: Word.Interfaces.FieldData[]; + breaks?: Word.Interfaces.BreakData[]; /** - * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. + * Gets the height, in points, of the paper defined in the Page Setup dialog box. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - font?: Word.Interfaces.FontData; + height?: number; /** - * Gets the group-related data if the content control's {@link Word.ContentControlType} is `Group`. It's `null` otherwise. + * Gets the index of the page. The page index is 1-based and independent of the user's custom page numbering. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - groupContentControl?: Word.Interfaces.GroupContentControlData; + index?: number; /** - * Gets the collection of InlinePicture objects in the content control. The collection doesn't include floating images. + * Gets the width, in points, of the paper defined in the Page Setup dialog box. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - inlinePictures?: Word.Interfaces.InlinePictureData[]; + width?: number; + } + /** An interface describing the data returned by calling `pageCollection.toJSON()`. */ + interface PageCollectionData { + items?: Word.Interfaces.PageData[]; + } + /** An interface describing the data returned by calling `pane.toJSON()`. */ + interface PaneData { /** - * Gets the collection of list objects in the content control. + * Gets the collection of pages in the pane. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - lists?: Word.Interfaces.ListData[]; + pages?: Word.Interfaces.PageData[]; /** - * Gets the collection of paragraph objects in the content control. + * Gets the `PageCollection` shown in the viewport of the pane. If a page is partially visible in the pane, the whole page is returned. * * @remarks - * [Api set: WordApi 1.1] - * - * Important: For requirement sets 1.1 and 1.2, paragraphs in tables wholly contained within this content control aren't returned. From requirement set 1.3, paragraphs in such tables are also returned. + * [Api set: WordApiDesktop 1.2] */ - paragraphs?: Word.Interfaces.ParagraphData[]; + pagesEnclosingViewport?: Word.Interfaces.PageData[]; + } + /** An interface describing the data returned by calling `paneCollection.toJSON()`. */ + interface PaneCollectionData { + items?: Word.Interfaces.PaneData[]; + } + /** An interface describing the data returned by calling `window.toJSON()`. */ + interface WindowData { /** - * Gets the picture-related data if the content control's {@link Word.ContentControlType} is `Picture`. It's `null` otherwise. + * Gets the next document window in the collection of open document windows. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pictureContentControl?: Word.Interfaces.PictureContentControlData; + next?: Word.Interfaces.WindowData; /** - * Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `RepeatingSection`. It's `null` otherwise. + * Gets the previous document window in the collection open document windows. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlData; + previous?: Word.Interfaces.WindowData; /** - * Gets the collection of table objects in the content control. + * Specifies whether rulers are displayed for the window or pane. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tables?: Word.Interfaces.TableData[]; + areRulersDisplayed?: boolean; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Specifies whether comments, footnotes, endnotes, and hyperlinks are displayed as tips. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingData; + areScreenTipsDisplayed?: boolean; /** - * Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. + * Specifies whether thumbnail images of the pages in a document are displayed along the left side of the Microsoft Word document window. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + areThumbnailsDisplayed?: boolean; /** - * Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited. + * Specifies the caption text for the window that is displayed in the title bar of the document or application window. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - cannotDelete?: boolean; + caption?: string; /** - * Specifies a value that indicates whether the user can edit the contents of the content control. + * Specifies the height of the window (in points). * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - cannotEdit?: boolean; + height?: number; /** - * Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. + * Specifies the horizontal scroll position as a percentage of the document width. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - color?: string; + horizontalPercentScrolled?: number; /** - * Gets an integer that represents the content control identifier. + * Specifies the default start-up mode for the Japanese Input Method Editor (IME). * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: number; + imeMode?: Word.ImeMode | "NoControl" | "On" | "Off" | "Hiragana" | "Katakana" | "KatakanaHalf" | "AlphaFull" | "Alpha" | "HangulFull" | "Hangul"; /** - * Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. + * Gets the position of an item in a collection. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - placeholderText?: string; + index?: number; /** - * Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. + * Specifies whether the window is active. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - removeWhenEdited?: boolean; + isActive?: boolean; /** - * Specifies the style name for the content control. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * Specifies whether the document map is visible. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: string; + isDocumentMapVisible?: boolean; /** - * Specifies the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Specifies whether the email message header is visible in the document window. The default value is `False`. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + isEnvelopeVisible?: boolean; /** - * Gets the content control subtype. The subtype can be 'RichTextInline', 'RichTextParagraphs', 'RichTextTableCell', 'RichTextTableRow' and 'RichTextTable' for rich text content controls, or 'PlainTextInline' and 'PlainTextParagraph' for plain text content controls, or 'CheckBox' for checkbox content controls. + * Specifies whether a horizontal scroll bar is displayed for the window. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - subtype?: Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" | "RichText" | "PlainText" | "Group"; + isHorizontalScrollBarDisplayed?: boolean; /** - * Specifies a tag to identify a content control. + * Specifies whether the vertical scroll bar appears on the left side of the document window. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tag?: string; + isLeftScrollBarDisplayed?: boolean; /** - * Gets the text of the content control. + * Specifies whether the vertical ruler appears on the right side of the document window in print layout view. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - text?: string; + isRightRulerDisplayed?: boolean; /** - * Specifies the title for a content control. + * Specifies whether the window is split into multiple panes. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - title?: string; + isSplit?: boolean; /** - * Gets the content control type. Only rich text, plain text, and checkbox content controls are supported currently. + * Specifies whether a vertical ruler is displayed for the window or pane. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" | "RichText" | "PlainText" | "Group"; - } - /** An interface describing the data returned by calling `contentControlCollection.toJSON()`. */ - interface ContentControlCollectionData { - items?: Word.Interfaces.ContentControlData[]; - } - /** An interface describing the data returned by calling `contentControlListItem.toJSON()`. */ - interface ContentControlListItemData { + isVerticalRulerDisplayed?: boolean; /** - * Specifies the display text of a list item for a dropdown list or combo box content control. + * Specifies whether a vertical scroll bar is displayed for the window. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - displayText?: string; + isVerticalScrollBarDisplayed?: boolean; /** - * Specifies the index location of a content control list item in the collection of list items. + * Specifies whether the window is visible. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - index?: number; + isVisible?: boolean; /** - * Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * Specifies the horizontal position of the window, measured in points. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - value?: string; - } - /** An interface describing the data returned by calling `contentControlListItemCollection.toJSON()`. */ - interface ContentControlListItemCollectionData { - items?: Word.Interfaces.ContentControlListItemData[]; - } - /** An interface describing the data returned by calling `customProperty.toJSON()`. */ - interface CustomPropertyData { + left?: number; /** - * Gets the key of the custom property. + * Specifies how Microsoft Word displays source documents after a compare and merge process. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - key?: string; + showSourceDocuments?: Word.ShowSourceDocuments | "None" | "Original" | "Revised" | "Both"; /** - * Gets the value type of the custom property. Possible values are: String, Number, Date, Boolean. + * Specifies the vertical split percentage for the window. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: Word.DocumentPropertyType | "String" | "Number" | "Date" | "Boolean"; + splitVertical?: number; /** - * Specifies the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). + * Specifies the width of the style area in points. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - value?: any; - } - /** An interface describing the data returned by calling `customPropertyCollection.toJSON()`. */ - interface CustomPropertyCollectionData { - items?: Word.Interfaces.CustomPropertyData[]; - } - /** An interface describing the data returned by calling `customXmlPart.toJSON()`. */ - interface CustomXmlPartData { + styleAreaWidth?: number; /** - * Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. + * Specifies the vertical position of the document window, in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - documentElement?: Word.Interfaces.CustomXmlNodeData; + top?: number; /** - * Gets a `CustomXmlValidationErrorCollection` object that provides access to any XML validation errors. + * Gets the window type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - errors?: Word.Interfaces.CustomXmlValidationErrorData[]; + type?: Word.WindowType | "Document" | "Template"; /** - * Gets the set of namespace prefix mappings used against the current `CustomXmlPart` object. + * Gets the height (in points) of the active working area in the document window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - namespaceManager?: Word.Interfaces.CustomXmlPrefixMappingData[]; + usableHeight?: number; /** - * Specifies a `CustomXmlSchemaCollection` object representing the set of schemas attached to a bound region of data in the document. + * Gets the width (in points) of the active working area in the document window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - schemaCollection?: Word.Interfaces.CustomXmlSchemaData[]; + usableWidth?: number; /** - * Gets a value that indicates whether the `CustomXmlPart` is built-in. + * Specifies the vertical scroll position as a percentage of the document length. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - builtIn?: boolean; + verticalPercentScrolled?: number; /** - * Gets the ID of the custom XML part. + * Specifies the width of the document window, in points. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: string; + width?: number; /** - * Gets the namespace URI of the custom XML part. + * Gets an integer that represents the position of the window. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - namespaceUri?: string; + windowNumber?: number; /** - * Gets the XML representation of the current `CustomXmlPart` object. + * Specifies the state of the document window or task window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xml?: string; - } - /** An interface describing the data returned by calling `customXmlPartCollection.toJSON()`. */ - interface CustomXmlPartCollectionData { - items?: Word.Interfaces.CustomXmlPartData[]; + windowState?: Word.WindowState | "Normal" | "Maximize" | "Minimize"; } - /** An interface describing the data returned by calling `customXmlPartScopedCollection.toJSON()`. */ - interface CustomXmlPartScopedCollectionData { - items?: Word.Interfaces.CustomXmlPartData[]; + /** An interface describing the data returned by calling `windowCollection.toJSON()`. */ + interface WindowCollectionData { + items?: Word.Interfaces.WindowData[]; } - /** An interface describing the data returned by calling `document.toJSON()`. */ - interface DocumentData { + /** An interface describing the data returned by calling `paragraph.toJSON()`. */ + interface ParagraphData { /** - * Gets the active window for the document. + * Returns a `BorderUniversalCollection` object that represents all the borders for the paragraph. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - activeWindow?: Word.Interfaces.WindowData; + borders?: Word.Interfaces.BorderUniversalData[]; /** - * Returns a `Bibliography` object that represents the bibliography references contained within the document. + * Gets the collection of fields in the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - bibliography?: Word.Interfaces.BibliographyData; + fields?: Word.Interfaces.FieldData[]; /** - * Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. * * @remarks * [Api set: WordApi 1.1] */ - body?: Word.Interfaces.BodyData; + font?: Word.Interfaces.FontData; /** - * Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. + * Gets the collection of InlinePicture objects in the paragraph. The collection doesn't include floating images. * * @remarks * [Api set: WordApi 1.1] */ - contentControls?: Word.Interfaces.ContentControlData[]; + inlinePictures?: Word.Interfaces.InlinePictureData[]; /** - * Gets the custom XML parts in the document. + * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - customXmlParts?: Word.Interfaces.CustomXmlPartData[]; + listItem?: Word.Interfaces.ListItemData; /** - * Returns a `DocumentLibraryVersionCollection` object that represents the collection of versions of a shared document that has versioning enabled and that's stored in a document library on a server. + * Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - documentLibraryVersions?: Word.Interfaces.DocumentLibraryVersionData[]; + listItemOrNullObject?: Word.Interfaces.ListItemData; /** - * Returns a `FrameCollection` object that represents all the frames in the document. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - frames?: Word.Interfaces.FrameData[]; + shading?: Word.Interfaces.ShadingUniversalData; /** - * Returns a `HyperlinkCollection` object that represents all the hyperlinks in the document. + * Gets the collection of shape objects anchored in the paragraph, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - hyperlinks?: Word.Interfaces.HyperlinkData[]; + shapes?: Word.Interfaces.ShapeData[]; /** - * Returns a `PageSetup` object that's associated with the document. + * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - pageSetup?: Word.Interfaces.PageSetupData; + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Gets the properties of the document. + * Specifies the value, in points, for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - properties?: Word.Interfaces.DocumentPropertiesData; + firstLineIndent?: number; /** - * Gets the collection of section objects in the document. + * Indicates the paragraph is the last one inside its parent body. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - sections?: Word.Interfaces.SectionData[]; + isLastParagraph?: boolean; /** - * Gets the add-in's settings in the document. + * Checks whether the paragraph is a list item. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - settings?: Word.Interfaces.SettingData[]; + isListItem?: boolean; /** - * Gets the collection of `Word.Window` objects for the document. + * Specifies the left indent value, in points, for the paragraph. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] */ - windows?: Word.Interfaces.WindowData[]; + leftIndent?: number; /** - * Specifies if automatic hyphenation is turned on for the document. + * Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - autoHyphenation?: boolean; + lineSpacing?: number; /** - * Specifies if the edits in the document are automatically saved. + * Specifies the amount of spacing, in grid lines, after the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - autoSaveOn?: boolean; + lineUnitAfter?: number; /** - * Specifies the ChangeTracking mode. + * Specifies the amount of spacing, in grid lines, before the paragraph. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - changeTrackingMode?: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly"; + lineUnitBefore?: number; /** - * Specifies the maximum number of consecutive lines that can end with hyphens. + * Specifies the outline level for the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - consecutiveHyphensLimit?: number; + outlineLevel?: number; /** - * Specifies whether words in all capital letters can be hyphenated. + * Specifies the right indent value, in points, for the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - hyphenateCaps?: boolean; + rightIndent?: number; /** - * Specifies whether Microsoft Word has detected the language of the document text. + * Specifies the spacing, in points, after the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - languageDetected?: boolean; + spaceAfter?: number; /** - * Indicates whether the changes in the document have been saved. A value of true indicates that the document hasn't changed since it was saved. + * Specifies the spacing, in points, before the paragraph. * * @remarks * [Api set: WordApi 1.1] */ - saved?: boolean; - } - /** An interface describing the data returned by calling `documentCreated.toJSON()`. */ - interface DocumentCreatedData { - /** - * Gets the body object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.3] - */ - body?: Word.Interfaces.BodyData; - /** - * Gets the collection of content control objects in the document. This includes content controls in the body of the document, headers, footers, textboxes, etc. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.3] - */ - contentControls?: Word.Interfaces.ContentControlData[]; - /** - * Gets the custom XML parts in the document. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.4] - */ - customXmlParts?: Word.Interfaces.CustomXmlPartData[]; - /** - * Gets the properties of the document. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.3] - */ - properties?: Word.Interfaces.DocumentPropertiesData; - /** - * Gets the collection of section objects in the document. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.3] - */ - sections?: Word.Interfaces.SectionData[]; - /** - * Gets the add-in's settings in the document. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.4] - */ - settings?: Word.Interfaces.SettingData[]; + spaceBefore?: number; /** - * Indicates whether the changes in the document have been saved. A value of true indicates that the document hasn't changed since it was saved. + * Specifies the style name for the paragraph. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] + * [Api set: WordApi 1.1] */ - saved?: boolean; - } - /** An interface describing the data returned by calling `documentProperties.toJSON()`. */ - interface DocumentPropertiesData { - /** - * Gets the collection of custom properties of the document. - * - * @remarks - * [Api set: WordApi 1.3] - */ - customProperties?: Word.Interfaces.CustomPropertyData[]; + style?: string; /** - * Gets the application name of the document. + * Specifies the built-in style name for the paragraph. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks * [Api set: WordApi 1.3] */ - applicationName?: string; + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; /** - * Specifies the author of the document. + * Gets the level of the paragraph's table. It returns 0 if the paragraph isn't in a table. * * @remarks * [Api set: WordApi 1.3] */ - author?: string; + tableNestingLevel?: number; /** - * Specifies the category of the document. + * Gets the text of the paragraph. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - category?: string; + text?: string; /** - * Specifies the Comments field in the metadata of the document. These have no connection to comments by users made in the document. + * Gets a string that represents the paragraph identifier in the current session. ID is in standard 8-4-4-4-12 GUID format without curly braces and differs across sessions and coauthors. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - comments?: string; + uniqueLocalId?: string; + } + /** An interface describing the data returned by calling `paragraphCollection.toJSON()`. */ + interface ParagraphCollectionData { + items?: Word.Interfaces.ParagraphData[]; + } + /** An interface describing the data returned by calling `paragraphFormat.toJSON()`. */ + interface ParagraphFormatData { /** - * Specifies the company of the document. + * Specifies the alignment for the specified paragraphs. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - company?: string; + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Gets the creation date of the document. + * Specifies the value (in points) for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - creationDate?: Date; + firstLineIndent?: number; /** - * Specifies the format of the document. + * Specifies whether all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - format?: string; + keepTogether?: boolean; /** - * Specifies the keywords of the document. + * Specifies whether the specified paragraph remains on the same page as the paragraph that follows it when Microsoft Word repaginates the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - keywords?: string; + keepWithNext?: boolean; /** - * Gets the last author of the document. + * Specifies the left indent. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - lastAuthor?: string; + leftIndent?: number; /** - * Gets the last print date of the document. + * Specifies the line spacing (in points) for the specified paragraphs. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - lastPrintDate?: Date; + lineSpacing?: number; /** - * Gets the last save time of the document. + * Specifies the amount of spacing (in gridlines) after the specified paragraphs. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - lastSaveTime?: Date; + lineUnitAfter?: number; /** - * Specifies the manager of the document. + * Specifies the amount of spacing (in gridlines) before the specified paragraphs. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - manager?: string; + lineUnitBefore?: number; /** - * Gets the revision number of the document. + * Specifies whether left and right indents are the same width. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - revisionNumber?: string; + mirrorIndents?: boolean; /** - * Gets security settings of the document. Some are access restrictions on the file on disk. Others are Document Protection settings. Some possible values are 0 = File on disk is read/write; 1 = Protect Document: File is encrypted and requires a password to open; 2 = Protect Document: Always Open as Read-Only; 3 = Protect Document: Both #1 and #2; 4 = File on disk is read-only; 5 = Both #1 and #4; 6 = Both #2 and #4; 7 = All of #1, #2, and #4; 8 = Protect Document: Restrict Edit to read-only; 9 = Both #1 and #8; 10 = Both #2 and #8; 11 = All of #1, #2, and #8; 12 = Both #4 and #8; 13 = All of #1, #4, and #8; 14 = All of #2, #4, and #8; 15 = All of #1, #2, #4, and #8. + * Specifies the outline level for the specified paragraphs. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - security?: number; + outlineLevel?: Word.OutlineLevel | "OutlineLevel1" | "OutlineLevel2" | "OutlineLevel3" | "OutlineLevel4" | "OutlineLevel5" | "OutlineLevel6" | "OutlineLevel7" | "OutlineLevel8" | "OutlineLevel9" | "OutlineLevelBodyText"; /** - * Specifies the subject of the document. + * Specifies the right indent (in points) for the specified paragraphs. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - subject?: string; + rightIndent?: number; /** - * Gets the template of the document. + * Specifies the amount of spacing (in points) after the specified paragraph or text column. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - template?: string; + spaceAfter?: number; /** - * Specifies the title of the document. + * Specifies the spacing (in points) before the specified paragraphs. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - title?: string; - } - /** An interface describing the data returned by calling `dropDownListContentControl.toJSON()`. */ - interface DropDownListContentControlData { - } - /** An interface describing the data returned by calling `comboBoxContentControl.toJSON()`. */ - interface ComboBoxContentControlData { - } - /** An interface describing the data returned by calling `field.toJSON()`. */ - interface FieldData { + spaceBefore?: number; /** - * Gets the field's result data. - * - * @remarks - * [Api set: WordApi 1.4] - */ - result?: Word.Interfaces.RangeData; + * Specifies whether the first and last lines in the specified paragraph remain on the same page as the rest of the paragraph when Microsoft Word repaginates the document. + * + * @remarks + * [Api set: WordApi 1.5] + */ + widowControl?: boolean; + } + /** An interface describing the data returned by calling `range.toJSON()`. */ + interface RangeData { /** - * Specifies the field's code instruction. + * Returns a `BorderUniversalCollection` object that represents all the borders for the range. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + borders?: Word.Interfaces.BorderUniversalData[]; + /** + * Returns a `ConflictCollection` object that contains all the {@link Word.Conflict} objects in the range. * - * Note: The ability to set the code was introduced in WordApi 1.5. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - code?: string; + conflicts?: Word.Interfaces.ConflictData[]; /** - * Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is `null` and it will throw a general exception when code attempts to set it. + * Gets the collection of field objects in the range. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.4] */ - data?: string; + fields?: Word.Interfaces.FieldData[]; /** - * Gets the field's kind. + * Gets the text format of the range. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - kind?: Word.FieldKind | "None" | "Hot" | "Warm" | "Cold"; + font?: Word.Interfaces.FontData; /** - * Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. + * Gets a `FrameCollection` object that represents all the frames in the range. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - locked?: boolean; + frames?: Word.Interfaces.FrameData[]; /** - * Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise. + * Returns a `HyperlinkCollection` object that represents all the hyperlinks in the range. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - showCodes?: boolean; + hyperlinks?: Word.Interfaces.HyperlinkData[]; /** - * Gets the field's type. + * Gets the collection of inline picture objects in the range. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.2] */ - type?: Word.FieldType | "Addin" | "AddressBlock" | "Advance" | "Ask" | "Author" | "AutoText" | "AutoTextList" | "BarCode" | "Bibliography" | "BidiOutline" | "Citation" | "Comments" | "Compare" | "CreateDate" | "Data" | "Database" | "Date" | "DisplayBarcode" | "DocProperty" | "DocVariable" | "EditTime" | "Embedded" | "EQ" | "Expression" | "FileName" | "FileSize" | "FillIn" | "FormCheckbox" | "FormDropdown" | "FormText" | "GotoButton" | "GreetingLine" | "Hyperlink" | "If" | "Import" | "Include" | "IncludePicture" | "IncludeText" | "Index" | "Info" | "Keywords" | "LastSavedBy" | "Link" | "ListNum" | "MacroButton" | "MergeBarcode" | "MergeField" | "MergeRec" | "MergeSeq" | "Next" | "NextIf" | "NoteRef" | "NumChars" | "NumPages" | "NumWords" | "OCX" | "Page" | "PageRef" | "Print" | "PrintDate" | "Private" | "Quote" | "RD" | "Ref" | "RevNum" | "SaveDate" | "Section" | "SectionPages" | "Seq" | "Set" | "Shape" | "SkipIf" | "StyleRef" | "Subject" | "Subscriber" | "Symbol" | "TA" | "TC" | "Template" | "Time" | "Title" | "TOA" | "TOC" | "UserAddress" | "UserInitials" | "UserName" | "XE" | "Empty" | "Others" | "Undefined"; - } - /** An interface describing the data returned by calling `fieldCollection.toJSON()`. */ - interface FieldCollectionData { - items?: Word.Interfaces.FieldData[]; - } - /** An interface describing the data returned by calling `font.toJSON()`. */ - interface FontData { + inlinePictures?: Word.Interfaces.InlinePictureData[]; /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the font. + * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - borders?: Word.Interfaces.BorderUniversalData[]; + listFormat?: Word.Interfaces.ListFormatData; /** - * Returns a `FillFormat` object that contains fill formatting properties for the font used by the range of text. + * Gets the collection of pages in the range. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + pages?: Word.Interfaces.PageData[]; + /** + * Gets the collection of sections in the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fill?: Word.Interfaces.FillFormatData; + sections?: Word.Interfaces.SectionData[]; /** - * Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - glow?: Word.Interfaces.GlowFormatData; + shading?: Word.Interfaces.ShadingUniversalData; + /** + * Gets the collection of shape objects anchored in the range, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + shapes?: Word.Interfaces.ShapeData[]; /** - * Returns a `LineFormat` object that specifies the formatting for a line. + * Gets a `TableColumnCollection` object that represents all the table columns in the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - line?: Word.Interfaces.LineFormatData; + tableColumns?: Word.Interfaces.TableColumnData[]; /** - * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. + * Specifies whether the range is formatted as bold. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - reflection?: Word.Interfaces.ReflectionFormatData; + bold?: boolean; /** - * Returns a `ColorFormat` object that represents the color for the font. + * Specifies whether the range is formatted as bold in a right-to-left language document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textColor?: Word.Interfaces.ColorFormatData; + boldBidirectional?: boolean; /** - * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. + * Specifies a `CharacterCase` value that represents the case of the text in the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textShadow?: Word.Interfaces.ShadowFormatData; + case?: Word.CharacterCase | "Next" | "Lower" | "Upper" | "TitleWord" | "TitleSentence" | "Toggle" | "HalfWidth" | "FullWidth" | "Katakana" | "Hiragana"; /** - * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font. + * Specifies the character width of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - threeDimensionalFormat?: Word.Interfaces.ThreeDimensionalFormatData; + characterWidth?: Word.CharacterWidth | "Half" | "Full"; /** - * Specifies whether the font is formatted as all capital letters, 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. + * Specifies if the range contains combined characters. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - allCaps?: boolean; + combineCharacters?: boolean; /** - * Specifies a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false. + * Specifies if Microsoft Word ignores the number of characters per line for the corresponding `Range` object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bold?: boolean; + disableCharacterSpaceGrid?: boolean; /** - * Specifies whether the font is formatted as bold in a right-to-left language document. 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. + * Specifies the emphasis mark for a character or designated character string. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - boldBidirectional?: boolean; + emphasisMark?: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle"; /** - * Specifies the color for the specified font. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies the ending character position of the range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - color?: string; + end?: number; /** - * Specifies a `ColorIndex` value that represents the color for the font. + * Specifies the width (in the current measurement units) in which Microsoft Word fits the text in the current selection or range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - colorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + fitTextWidth?: number; /** - * Specifies the color for the `Font` object in a right-to-left language document. + * Specifies if a grammar check has been run on the range or document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - colorIndexBidirectional?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + grammarChecked?: boolean; /** - * Specifies whether contextual alternates are enabled for the font. + * Specifies the proofing status (spelling and grammar checking) of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contextualAlternates?: boolean; + hasNoProofing?: boolean; /** - * Specifies the color to be used for diacritics for the `Font` object. You can provide the value in the '#RRGGBB' format. + * Specifies the highlight color for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - diacriticColor?: string; + highlightColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Specifies whether Microsoft Word ignores the number of characters per line for the corresponding `Font` object. + * Specifies the formatting for horizontal text set within vertical text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - disableCharacterSpaceGrid?: boolean; + horizontalInVertical?: Word.HorizontalInVerticalType | "None" | "FitInLine" | "ResizeLine"; /** - * Specifies a value that indicates whether the font has a double strikethrough. True if the font is formatted as double strikethrough text, otherwise, false. + * Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. Use a '#' to separate the address part from the optional location part. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - doubleStrikeThrough?: boolean; + hyperlink?: string; /** - * Specifies whether the font is formatted as embossed. The possible values are as follows: - - - `true`: All the text is embossed. - - - `false`: None of the text is embossed. - - - `null`: Returned if some, but not all, of the text is embossed. + * Specifies the ID for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - emboss?: boolean; + id?: string; /** - * Specifies an `EmphasisMark` value that represents the emphasis mark for a character or designated character string. + * Checks whether the range length is zero. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - emphasisMark?: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle"; + isEmpty?: boolean; /** - * Specifies whether the font is formatted as engraved. The possible values are as follows: - - - `true`: All the text is engraved. - - - `false`: None of the text is engraved. - - - `null`: Returned if some, but not all, of the text is engraved. + * Gets if the range is collapsed and is located at the end-of-row mark in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - engrave?: boolean; - /** - * Specifies a value that indicates whether the font is tagged as hidden. True if the font is formatted as hidden text, otherwise, false. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - hidden?: boolean; + isEndOfRowMark?: boolean; /** - * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or `null` for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. + * Gets whether the text in the range is visible on the screen. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - highlightColor?: string; + isTextVisibleOnScreen?: boolean; /** - * Specifies a value that indicates whether the font is italicized. True if the font is italicized, otherwise, false. + * Specifies if the font or range is formatted as italic. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ italic?: boolean; /** - * Specifies whether the font is italicized in a right-to-left language document. 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. + * Specifies if the font or range is formatted as italic (right-to-left languages). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -142305,7037 +152485,7375 @@ declare namespace Word { */ italicBidirectional?: boolean; /** - * Specifies the minimum font size for which Microsoft Word will adjust kerning automatically. + * Specifies whether the range of Japanese language text is hiragana or katakana. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - kerning?: number; + kana?: Word.Kana | "Katakana" | "Hiragana"; /** - * Specifies the ligature setting for the `Font` object. + * Specifies whether Microsoft Word has detected the language of the text in the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - ligature?: Word.Ligature | "None" | "Standard" | "Contextual" | "StandardContextual" | "Historical" | "StandardHistorical" | "ContextualHistorical" | "StandardContextualHistorical" | "Discretional" | "StandardDiscretional" | "ContextualDiscretional" | "StandardContextualDiscretional" | "HistoricalDiscretional" | "StandardHistoricalDiscretional" | "ContextualHistoricalDiscretional" | "All"; - /** - * Specifies a value that represents the name of the font. - * - * @remarks - * [Api set: WordApi 1.1] - */ - name?: string; + languageDetected?: boolean; /** - * Specifies the font used for Latin text (characters with character codes from 0 (zero) through 127). + * Specifies a `LanguageId` value that represents the language for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nameAscii?: string; + languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies the font name in a right-to-left language document. + * Specifies an East Asian language for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nameBidirectional?: string; + languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies the East Asian font name. + * Specifies a language for the range that isn't classified as an East Asian language. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nameFarEast?: string; + languageIdOther?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies the font used for characters with codes from 128 through 255. + * Specifies if all nonprinting characters (such as hidden text, tab marks, space marks, and paragraph marks) are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nameOther?: string; + showAll?: boolean; /** - * Specifies the number form setting for an OpenType font. + * Specifies if spelling has been checked throughout the range or document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - numberForm?: Word.NumberForm | "Default" | "Lining" | "OldStyle"; + spellingChecked?: boolean; /** - * Specifies the number spacing setting for the font. + * Specifies the starting character position of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - numberSpacing?: Word.NumberSpacing | "Default" | "Proportional" | "Tabular"; + start?: number; /** - * Specifies if the font is formatted as outlined. The possible values are as follows: - - - `true`: All the text is outlined. - - - `false`: None of the text is outlined. - - - `null`: Returned if some, but not all, of the text is outlined. + * Gets the number of characters in the story that contains the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - outline?: boolean; + storyLength?: number; /** - * Specifies the position of text (in points) relative to the base line. + * Gets the story type for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - position?: number; + storyType?: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; /** - * Specifies the scaling percentage applied to the font. + * Specifies the style name for the range. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - scaling?: number; + style?: string; /** - * Specifies if the font is formatted as shadowed. The possible values are as follows: - - - `true`: All the text is shadowed. - - - `false`: None of the text is shadowed. - - - `null`: Returned if some, but not all, of the text is shadowed. + * Specifies the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - shadow?: boolean; + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; /** - * Specifies a value that represents the font size in points. + * Gets the text of the range. * * @remarks * [Api set: WordApi 1.1] */ - size?: number; + text?: string; /** - * Specifies the font size in points for right-to-left text. + * Specifies whether Microsoft Word sets two lines of text in one and specifies the characters that enclose the text, if any. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sizeBidirectional?: number; + twoLinesInOne?: Word.TwoLinesInOneType | "None" | "NoBrackets" | "Parentheses" | "SquareBrackets" | "AngleBrackets" | "CurlyBrackets"; /** - * Specifies whether the font is formatted as small caps, 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. + * Specifies the type of underline applied to the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - smallCaps?: boolean; + underline?: Word.Underline | "None" | "Single" | "Words" | "Double" | "Dotted" | "Thick" | "Dash" | "DotDash" | "DotDotDash" | "Wavy" | "WavyHeavy" | "DottedHeavy" | "DashHeavy" | "DotDashHeavy" | "DotDotDashHeavy" | "DashLong" | "DashLongHeavy" | "WavyDouble"; + } + /** An interface describing the data returned by calling `rangeCollection.toJSON()`. */ + interface RangeCollectionData { + items?: Word.Interfaces.RangeData[]; + } + /** An interface describing the data returned by calling `searchOptions.toJSON()`. */ + interface SearchOptionsData { /** - * Specifies the spacing between characters. + * Specifies a value that indicates whether to ignore all punctuation characters between words. Corresponds to the Ignore punctuation check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - spacing?: number; + ignorePunct?: boolean; /** - * Specifies a value that indicates whether the font has a strikethrough. True if the font is formatted as strikethrough text, otherwise, false. + * Specifies a value that indicates whether to ignore all whitespace between words. Corresponds to the Ignore whitespace characters check box in the Find and Replace dialog box. * * @remarks * [Api set: WordApi 1.1] */ - strikeThrough?: boolean; + ignoreSpace?: boolean; /** - * Specifies the stylistic set for the font. + * Specifies a value that indicates whether to perform a case sensitive search. Corresponds to the Match case check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - stylisticSet?: Word.StylisticSet | "Default" | "Set01" | "Set02" | "Set03" | "Set04" | "Set05" | "Set06" | "Set07" | "Set08" | "Set09" | "Set10" | "Set11" | "Set12" | "Set13" | "Set14" | "Set15" | "Set16" | "Set17" | "Set18" | "Set19" | "Set20"; + matchCase?: boolean; /** - * Specifies a value that indicates whether the font is a subscript. True if the font is formatted as subscript, otherwise, false. + * Specifies a value that indicates whether to match words that begin with the search string. Corresponds to the Match prefix check box in the Find and Replace dialog box. * * @remarks * [Api set: WordApi 1.1] */ - subscript?: boolean; + matchPrefix?: boolean; /** - * Specifies a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false. + * Specifies a value that indicates whether to match words that end with the search string. Corresponds to the Match suffix check box in the Find and Replace dialog box. * * @remarks * [Api set: WordApi 1.1] */ - superscript?: boolean; + matchSuffix?: boolean; /** - * Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined. + * Specifies a value that indicates whether to find operation only entire words, not text that is part of a larger word. Corresponds to the Find whole words only check box in the Find and Replace dialog box. * * @remarks * [Api set: WordApi 1.1] */ - underline?: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"; + matchWholeWord?: boolean; /** - * Specifies the color of the underline for the `Font` object. You can provide the value in the '#RRGGBB' format. + * Specifies a value that indicates whether the search will be performed using special search operators. Corresponds to the Use wildcards check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - underlineColor?: string; + matchWildcards?: boolean; } - /** An interface describing the data returned by calling `hyperlink.toJSON()`. */ - interface HyperlinkData { + /** An interface describing the data returned by calling `section.toJSON()`. */ + interface SectionData { /** - * Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. + * Gets the body object of the section. This doesn't include the header/footer and other section metadata. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - range?: Word.Interfaces.RangeData; + body?: Word.Interfaces.BodyData; /** - * Specifies the address (for example, a file name or URL) of the hyperlink. + * Returns a `BorderUniversalCollection` object that represents all the borders in the section. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - address?: string; + borders?: Word.Interfaces.BorderUniversalData[]; /** - * Specifies the text string for the hyperlink's subject line. + * Returns a `PageSetup` object that's associated with the section. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - emailSubject?: string; + pageSetup?: Word.Interfaces.PageSetupData; /** - * Returns `true` if extra information is required to resolve the hyperlink. + * Specifies if the section is protected for forms. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isExtraInfoRequired?: boolean; + protectedForForms?: boolean; + } + /** An interface describing the data returned by calling `sectionCollection.toJSON()`. */ + interface SectionCollectionData { + items?: Word.Interfaces.SectionData[]; + } + /** An interface describing the data returned by calling `setting.toJSON()`. */ + interface SettingData { /** - * Returns the name of the `Hyperlink` object. + * Gets the key of the setting. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - name?: string; + key?: string; /** - * Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink. + * Specifies the value of the setting. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - screenTip?: string; + value?: any; + } + /** An interface describing the data returned by calling `settingCollection.toJSON()`. */ + interface SettingCollectionData { + items?: Word.Interfaces.SettingData[]; + } + /** An interface describing the data returned by calling `styleCollection.toJSON()`. */ + interface StyleCollectionData { + items?: Word.Interfaces.StyleData[]; + } + /** An interface describing the data returned by calling `style.toJSON()`. */ + interface StyleData { /** - * Specifies a named location in the destination of the hyperlink. + * Specifies a BorderCollection object that represents all the borders for the specified style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - subAddress?: string; + borders?: Word.Interfaces.BorderData[]; /** - * Specifies the name of the frame or window in which to load the hyperlink. + * Gets a font object that represents the character formatting of the specified style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - target?: string; + font?: Word.Interfaces.FontData; /** - * Specifies the hyperlink's visible text in the document. + * Returns a `Frame` object that represents the frame formatting for the style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textToDisplay?: string; + frame?: Word.Interfaces.FrameData; /** - * Returns the hyperlink type. + * Specifies a link between a paragraph and a character style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.HyperlinkType | "Range" | "Shape" | "InlineShape"; - } - /** An interface describing the data returned by calling `hyperlinkCollection.toJSON()`. */ - interface HyperlinkCollectionData { - items?: Word.Interfaces.HyperlinkData[]; - } - /** An interface describing the data returned by calling `inlinePicture.toJSON()`. */ - interface InlinePictureData { + linkStyle?: Word.Interfaces.StyleData; /** - * Specifies a string that represents the alternative text associated with the inline image. + * Gets a ListTemplate object that represents the list formatting for the specified Style object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - altTextDescription?: string; + listTemplate?: Word.Interfaces.ListTemplateData; /** - * Specifies a string that contains the title for the inline image. + * Gets a ParagraphFormat object that represents the paragraph settings for the specified style. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - altTextTitle?: string; + paragraphFormat?: Word.Interfaces.ParagraphFormatData; /** - * Specifies a number that describes the height of the inline image. + * Gets a Shading object that represents the shading for the specified style. Not applicable to List style. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.6] */ - height?: number; + shading?: Word.Interfaces.ShadingData; /** - * Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. + * Gets a TableStyle object representing Style properties that can be applied to a table. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.6] */ - hyperlink?: string; + tableStyle?: Word.Interfaces.TableStyleData; /** - * Gets the format of the inline image. + * Specifies whether the style is automatically redefined based on the selection. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - imageFormat?: Word.ImageFormat | "Unsupported" | "Undefined" | "Bmp" | "Jpeg" | "Gif" | "Tiff" | "Png" | "Icon" | "Exif" | "Wmf" | "Emf" | "Pict" | "Pdf" | "Svg"; + automaticallyUpdate?: boolean; /** - * Specifies a value that indicates whether the inline image retains its original proportions when you resize it. + * Specifies the name of an existing style to use as the base formatting of another style. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] + * + * Note: The ability to set `baseStyle` was introduced in WordApi 1.6. */ - lockAspectRatio?: boolean; + baseStyle?: string; /** - * Specifies a number that describes the width of the inline image. + * Gets whether the specified style is a built-in style. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - width?: number; - } - /** An interface describing the data returned by calling `inlinePictureCollection.toJSON()`. */ - interface InlinePictureCollectionData { - items?: Word.Interfaces.InlinePictureData[]; - } - /** An interface describing the data returned by calling `linkFormat.toJSON()`. */ - interface LinkFormatData { + builtIn?: boolean; /** - * Specifies if the link is updated automatically when the container file is opened or when the source file is changed. + * Gets the description of the specified style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isAutoUpdated?: boolean; + description?: string; /** - * Specifies if a `Field`, `InlineShape`, or `Shape` object is locked to prevent automatic updating. + * Specifies whether the spelling and grammar checker ignores text formatted with this style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isLocked?: boolean; + hasProofing?: boolean; /** - * Specifies if the linked picture is saved with the document. + * Gets whether the specified style is a built-in style that has been modified or applied in the document or a new style that has been created in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - isPictureSavedWithDocument?: boolean; + inUse?: boolean; /** - * Specifies the path and name of the source file for the linked OLE object, picture, or field. + * Specifies a `LanguageId` value that represents the language for the style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sourceFullName?: string; + languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Gets the name of the source file for the linked OLE object, picture, or field. + * Specifies an East Asian language for the style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sourceName?: string; + languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Gets the path of the source file for the linked OLE object, picture, or field. + * Gets whether a style is a linked style that can be used for both paragraph and character formatting. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - sourcePath?: string; + linked?: boolean; /** - * Gets the link type. + * Returns the list level for the style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.LinkType | "Ole" | "Picture" | "Text" | "Reference" | "Include" | "Import" | "Dde" | "DdeAuto" | "Chart"; - } - /** An interface describing the data returned by calling `list.toJSON()`. */ - interface ListData { - /** - * Gets paragraphs in the list. - * - * @remarks - * [Api set: WordApi 1.3] - */ - paragraphs?: Word.Interfaces.ParagraphData[]; + listLevelNumber?: number; /** - * Gets the list's id. + * Specifies whether the style cannot be changed or edited. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: number; + locked?: boolean; /** - * Checks whether each of the 9 levels exists in the list. A true value indicates the level exists, which means there is at least one list item at that level. + * Gets the name of a style in the language of the user. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - levelExistences?: boolean[]; + nameLocal?: string; /** - * Gets all 9 level types in the list. Each type can be 'Bullet', 'Number', or 'Picture'. + * Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] + * + * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. */ - levelTypes?: Word.ListLevelType[]; - } - /** An interface describing the data returned by calling `listCollection.toJSON()`. */ - interface ListCollectionData { - items?: Word.Interfaces.ListData[]; - } - /** An interface describing the data returned by calling `listItem.toJSON()`. */ - interface ListItemData { + nextParagraphStyle?: string; /** - * Specifies the level of the item in the list. + * Specifies whether to remove spacing between paragraphs that are formatted using the same style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - level?: number; + noSpaceBetweenParagraphsOfSameStyle?: boolean; /** - * Gets the list item bullet, number, or picture as a string. + * Specifies the priority. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - listString?: string; + priority?: number; /** - * Gets the list item order number in relation to its siblings. + * Specifies whether the style corresponds to an available quick style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - siblingIndex?: number; - } - /** An interface describing the data returned by calling `listLevel.toJSON()`. */ - interface ListLevelData { + quickStyle?: boolean; /** - * Gets a Font object that represents the character formatting of the specified object. + * Gets the style type. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - font?: Word.Interfaces.FontData; + type?: Word.StyleType | "Character" | "List" | "Paragraph" | "Table"; /** - * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. + * Specifies whether the specified style is made visible as a recommended style in the Styles and in the Styles task pane in Microsoft Word after it's used in the document. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + unhideWhenUsed?: boolean; /** - * Specifies the name of the style that's linked to the specified list level object. + * Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.5] */ - linkedStyle?: string; + visibility?: boolean; + } + /** An interface describing the data returned by calling `shading.toJSON()`. */ + interface ShadingData { /** - * Specifies the number format for the specified list level. + * Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.6] */ - numberFormat?: string; + backgroundPatternColor?: string; /** - * Specifies the position (in points) of the number or bullet for the specified list level object. + * Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks * [Api set: WordApiDesktop 1.1] */ - numberPosition?: number; + foregroundPatternColor?: string; /** - * Specifies the number style for the list level object. + * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. * * @remarks * [Api set: WordApiDesktop 1.1] */ - numberStyle?: Word.ListBuiltInNumberStyle | "None" | "Arabic" | "UpperRoman" | "LowerRoman" | "UpperLetter" | "LowerLetter" | "Ordinal" | "CardinalText" | "OrdinalText" | "Kanji" | "KanjiDigit" | "AiueoHalfWidth" | "IrohaHalfWidth" | "ArabicFullWidth" | "KanjiTraditional" | "KanjiTraditional2" | "NumberInCircle" | "Aiueo" | "Iroha" | "ArabicLZ" | "Bullet" | "Ganada" | "Chosung" | "GBNum1" | "GBNum2" | "GBNum3" | "GBNum4" | "Zodiac1" | "Zodiac2" | "Zodiac3" | "TradChinNum1" | "TradChinNum2" | "TradChinNum3" | "TradChinNum4" | "SimpChinNum1" | "SimpChinNum2" | "SimpChinNum3" | "SimpChinNum4" | "HanjaRead" | "HanjaReadDigit" | "Hangul" | "Hanja" | "Hebrew1" | "Arabic1" | "Hebrew2" | "Arabic2" | "HindiLetter1" | "HindiLetter2" | "HindiArabic" | "HindiCardinalText" | "ThaiLetter" | "ThaiArabic" | "ThaiCardinalText" | "VietCardinalText" | "LowercaseRussian" | "UppercaseRussian" | "LowercaseGreek" | "UppercaseGreek" | "ArabicLZ2" | "ArabicLZ3" | "ArabicLZ4" | "LowercaseTurkish" | "UppercaseTurkish" | "LowercaseBulgarian" | "UppercaseBulgarian" | "PictureBullet" | "Legal" | "LegalLZ"; + texture?: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; + } + /** An interface describing the data returned by calling `shadingUniversal.toJSON()`. */ + interface ShadingUniversalData { /** - * Specifies the list level that must appear before the specified list level restarts numbering at 1. + * Specifies the color that's applied to the background of the `ShadingUniversal` object. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - resetOnHigher?: number; + backgroundPatternColor?: string; /** - * Specifies the starting number for the specified list level object. + * Specifies the color that's applied to the background of the `ShadingUniversal` object. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - startAt?: number; + backgroundPatternColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Specifies the tab position for the specified list level object. + * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tabPosition?: number; + foregroundPatternColor?: string; /** - * Specifies the position (in points) for the second line of wrapping text for the specified list level object. + * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - textPosition?: number; + foregroundPatternColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; /** - * Specifies the character inserted after the number for the specified list level. + * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - trailingCharacter?: Word.TrailingCharacter | "TrailingTab" | "TrailingSpace" | "TrailingNone"; - } - /** An interface describing the data returned by calling `listLevelCollection.toJSON()`. */ - interface ListLevelCollectionData { - items?: Word.Interfaces.ListLevelData[]; + texture?: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; } - /** An interface describing the data returned by calling `listTemplate.toJSON()`. */ - interface ListTemplateData { + /** An interface describing the data returned by calling `table.toJSON()`. */ + interface TableData { /** - * Gets a `ListLevelCollection` object that represents all the levels for the list template. + * Gets the collection of field objects in the table. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.4] */ - listLevels?: Word.Interfaces.ListLevelData[]; + fields?: Word.Interfaces.FieldData[]; /** - * Specifies whether the list template is outline numbered. + * Gets the font. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - outlineNumbered?: boolean; - } - /** An interface describing the data returned by calling `noteItem.toJSON()`. */ - interface NoteItemData { + font?: Word.Interfaces.FontData; /** - * Represents the body object of the note item. It's the portion of the text within the footnote or endnote. + * Gets all of the table rows. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - body?: Word.Interfaces.BodyData; + rows?: Word.Interfaces.TableRowData[]; /** - * Represents a footnote or endnote reference in the main document. + * Gets the child tables nested one level deeper. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - reference?: Word.Interfaces.RangeData; + tables?: Word.Interfaces.TableData[]; /** - * Represents the note item type: footnote or endnote. + * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - type?: Word.NoteItemType | "Footnote" | "Endnote"; - } - /** An interface describing the data returned by calling `noteItemCollection.toJSON()`. */ - interface NoteItemCollectionData { - items?: Word.Interfaces.NoteItemData[]; - } - /** An interface describing the data returned by calling `oleFormat.toJSON()`. */ - interface OleFormatData { + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies the class type for the specified OLE object, picture, or field. + * Specifies the description of the table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - classType?: string; + description?: string; /** - * Specifies the icon that is used when the `displayAsIcon` property is `true`. + * Specifies the number of header rows. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - iconIndex?: number; + headerRowCount?: number; /** - * Specifies the text displayed below the icon for the OLE object. + * Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - iconLabel?: string; + horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies the program file in which the icon for the OLE object is stored. + * Indicates whether all of the table rows are uniform. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - iconName?: string; + isUniform?: boolean; /** - * Gets the path of the file in which the icon for the OLE object is stored. + * Gets the nesting level of the table. Top-level tables have level 1. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - iconPath?: string; + nestingLevel?: number; /** - * Gets whether the specified object is displayed as an icon. + * Gets the number of rows in the table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isDisplayedAsIcon?: boolean; + rowCount?: number; /** - * Specifies whether formatting done in Microsoft Word to the linked OLE object is preserved. + * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isFormattingPreservedOnUpdate?: boolean; + shadingColor?: string; /** - * Gets a string that's used to identify the portion of the source file that's being linked. + * Specifies the style name for the table. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - label?: string; + style?: string; /** - * Gets the programmatic identifier (`ProgId`) for the specified OLE object. + * Specifies whether the table has banded columns. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - progID?: string; - } - /** An interface describing the data returned by calling `page.toJSON()`. */ - interface PageData { + styleBandedColumns?: boolean; /** - * Gets a `BreakCollection` object that represents the breaks on the page. + * Specifies whether the table has banded rows. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - breaks?: Word.Interfaces.BreakData[]; + styleBandedRows?: boolean; /** - * Gets the height, in points, of the paper defined in the Page Setup dialog box. + * Specifies the built-in style name for the table. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - height?: number; + styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; /** - * Gets the index of the page. The page index is 1-based and independent of the user's custom page numbering. + * Specifies whether the table has a first column with a special style. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - index?: number; + styleFirstColumn?: boolean; /** - * Gets the width, in points, of the paper defined in the Page Setup dialog box. + * Specifies whether the table has a last column with a special style. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - width?: number; - } - /** An interface describing the data returned by calling `pageCollection.toJSON()`. */ - interface PageCollectionData { - items?: Word.Interfaces.PageData[]; - } - /** An interface describing the data returned by calling `pane.toJSON()`. */ - interface PaneData { + styleLastColumn?: boolean; /** - * Gets the collection of pages in the pane. + * Specifies whether the table has a total (last) row with a special style. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - pages?: Word.Interfaces.PageData[]; + styleTotalRow?: boolean; /** - * Gets the `PageCollection` shown in the viewport of the pane. If a page is partially visible in the pane, the whole page is returned. + * Specifies the title of the table. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - pagesEnclosingViewport?: Word.Interfaces.PageData[]; - } - /** An interface describing the data returned by calling `paneCollection.toJSON()`. */ - interface PaneCollectionData { - items?: Word.Interfaces.PaneData[]; - } - /** An interface describing the data returned by calling `window.toJSON()`. */ - interface WindowData { + title?: string; /** - * Gets the next document window in the collection of open document windows. + * Specifies the text values in the table, as a 2D JavaScript array. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - next?: Word.Interfaces.WindowData; + values?: string[][]; /** - * Gets the previous document window in the collection open document windows. + * Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - previous?: Word.Interfaces.WindowData; + verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; /** - * Specifies whether rulers are displayed for the window or pane. + * Specifies the width of the table in points. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - areRulersDisplayed?: boolean; + width?: number; + } + /** An interface describing the data returned by calling `tableStyle.toJSON()`. */ + interface TableStyleData { /** - * Specifies whether comments, footnotes, endnotes, and hyperlinks are displayed as tips. + * Specifies the table's alignment against the page margin. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - areScreenTipsDisplayed?: boolean; + alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies whether thumbnail images of the pages in a document are displayed along the left side of the Microsoft Word document window. + * Specifies whether lines in tables formatted with a specified style break across pages. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - areThumbnailsDisplayed?: boolean; + allowBreakAcrossPage?: boolean; /** - * Specifies the caption text for the window that is displayed in the title bar of the document or application window. + * Specifies the amount of space to add between the contents and the bottom borders of the cells. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - caption?: string; + bottomCellMargin?: number; /** - * Specifies the height of the window (in points). + * Specifies the spacing (in points) between the cells in a table style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - height?: number; + cellSpacing?: number; /** - * Specifies the horizontal scroll position as a percentage of the document width. + * Specifies the number of columns in the banding when a style specifies odd- or even-column banding. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontalPercentScrolled?: number; + columnStripe?: number; /** - * Specifies the default start-up mode for the Japanese Input Method Editor (IME). + * Specifies whether Microsoft Word allows to break the specified table across pages. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - imemode?: Word.ImeMode | "NoControl" | "On" | "Off" | "Hiragana" | "Katakana" | "KatakanaHalf" | "AlphaFull" | "Alpha" | "HangulFull" | "Hangul"; + isBreakAcrossPagesAllowed?: boolean; /** - * Gets the position of an item in a collection. + * Specifies the amount of space to add between the contents and the left borders of the cells. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - index?: number; + leftCellMargin?: number; /** - * Specifies whether the window is active. + * Specifies the left indent value (in points) for the rows in the table style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isActive?: boolean; + leftIndent?: number; /** - * Specifies whether the document map is visible. + * Specifies the amount of space to add between the contents and the right borders of the cells. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - isDocumentMapVisible?: boolean; + rightCellMargin?: number; /** - * Specifies whether the email message header is visible in the document window. The default value is `False`. + * Specifies the number of rows to include in the banding when the style specifies odd- or even-row banding. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isEnvelopeVisible?: boolean; + rowStripe?: number; /** - * Specifies whether a horizontal scroll bar is displayed for the window. + * Specifies the direction in which Microsoft Word orders cells in the table style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isHorizontalScrollBarDisplayed?: boolean; + tableDirection?: Word.TableDirection | "RightToLeft" | "LeftToRight"; /** - * Specifies whether the vertical scroll bar appears on the left side of the document window. + * Specifies the amount of space to add between the contents and the top borders of the cells. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - isLeftScrollBarDisplayed?: boolean; + topCellMargin?: number; + } + /** An interface describing the data returned by calling `tabStop.toJSON()`. */ + interface TabStopData { /** - * Specifies whether the vertical ruler appears on the right side of the document window in print layout view. + * Gets a `TabAlignment` value that represents the alignment for the tab stop. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isRightRulerDisplayed?: boolean; + alignment?: Word.TabAlignment | "Left" | "Center" | "Right" | "Decimal" | "Bar" | "List"; /** - * Specifies whether the window is split into multiple panes. + * Gets whether this tab stop is a custom tab stop. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isSplit?: boolean; + customTab?: boolean; /** - * Specifies whether a vertical ruler is displayed for the window or pane. + * Gets a `TabLeader` value that represents the leader for this `TabStop` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVerticalRulerDisplayed?: boolean; + leader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** - * Specifies whether a vertical scroll bar is displayed for the window. + * Gets the position of the tab stop relative to the left margin. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVerticalScrollBarDisplayed?: boolean; + position?: number; + } + /** An interface describing the data returned by calling `tabStopCollection.toJSON()`. */ + interface TabStopCollectionData { + items?: Word.Interfaces.TabStopData[]; + } + /** An interface describing the data returned by calling `tableCollection.toJSON()`. */ + interface TableCollectionData { + items?: Word.Interfaces.TableData[]; + } + /** An interface describing the data returned by calling `tableColumn.toJSON()`. */ + interface TableColumnData { /** - * Specifies whether the window is visible. + * Returns a `BorderUniversalCollection` object that represents all the borders for the table column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + borders?: Word.Interfaces.BorderUniversalData[]; /** - * Specifies the horizontal position of the window, measured in points. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - left?: number; + shading?: Word.Interfaces.ShadingUniversalData; /** - * Specifies how Microsoft Word displays source documents after a compare and merge process. + * Returns the position of this column in a collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showSourceDocuments?: Word.ShowSourceDocuments | "None" | "Original" | "Revised" | "Both"; + columnIndex?: number; /** - * Specifies the vertical split percentage for the window. + * Returns `true` if the column or row is the first one in the table; `false` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - splitVertical?: number; + isFirst?: boolean; /** - * Specifies the width of the style area in points. + * Returns `true` if the column or row is the last one in the table; `false` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - styleAreaWidth?: number; + isLast?: boolean; /** - * Specifies the vertical position of the document window, in points. + * Returns the nesting level of the column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - top?: number; + nestingLevel?: number; /** - * Gets the window type. + * Specifies the preferred width (in points or as a percentage of the window width) for the column. + The unit of measurement can be specified by the `preferredWidthType` property. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.WindowType | "Document" | "Template"; + preferredWidth?: number; /** - * Gets the height (in points) of the active working area in the document window. + * Specifies the preferred unit of measurement to use for the width of the table column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - usableHeight?: number; + preferredWidthType?: Word.PreferredWidthType | "Auto" | "Percent" | "Points"; /** - * Gets the width (in points) of the active working area in the document window. + * Specifies the width of the column, in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - usableWidth?: number; + width?: number; + } + /** An interface describing the data returned by calling `tableColumnCollection.toJSON()`. */ + interface TableColumnCollectionData { + items?: Word.Interfaces.TableColumnData[]; + } + /** An interface describing the data returned by calling `tableOfAuthorities.toJSON()`. */ + interface TableOfAuthoritiesData { /** - * Specifies the vertical scroll position as a percentage of the document length. + * Specifies the name of the bookmark from which to collect table of authorities entries. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - verticalPercentScrolled?: number; + bookmark?: string; /** - * Specifies the width of the document window, in points. + * Specifies the category of entries to be included in the table of authorities. + Values 0 through 16 correspond to the items listed in the Category box of the Table of Authorities dialog. To learn how to access this through the Word UI, see {@link https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0 | Create a table of authorities}. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - width?: number; + category?: number; /** - * Gets an integer that represents the position of the window. + * Specifies a separator of up to five characters. This appears between the table of authorities entry and its page number. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - windowNumber?: number; + entrySeparator?: string; /** - * Specifies the state of the document window or task window. + * Specifies whether the category name for a group of entries appears in the table of authorities. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - windowState?: Word.WindowState | "Normal" | "Maximize" | "Minimize"; - } - /** An interface describing the data returned by calling `windowCollection.toJSON()`. */ - interface WindowCollectionData { - items?: Word.Interfaces.WindowData[]; - } - /** An interface describing the data returned by calling `paragraph.toJSON()`. */ - interface ParagraphData { + isCategoryHeaderIncluded?: boolean; /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the paragraph. + * Specifies whether the entries in the table of authorities are displayed with their formatting in the table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - borders?: Word.Interfaces.BorderUniversalData[]; + isEntryFormattingKept?: boolean; /** - * Gets the collection of fields in the paragraph. + * Specifies whether references to the same authority that are repeated on five or more pages are replaced with "Passim". * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - fields?: Word.Interfaces.FieldData[]; + isPassimUsed?: boolean; /** - * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. + * Specifies a separator of up to five characters. This appears between individual page references in the table of authorities. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontData; + pageNumberSeparator?: string; /** - * Gets the collection of InlinePicture objects in the paragraph. The collection doesn't include floating images. + * Specifies a separator of up to five characters. This appears between ranges of pages in the table of authorities. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - inlinePictures?: Word.Interfaces.InlinePictureData[]; + pageRangeSeparator?: string; /** - * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. + * Specifies the {@link https://support.microsoft.com/office/062a387b-dfc9-4ef8-8235-29ee113d59be | Sequence (SEQ) field} identifier for the table of authorities. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listItem?: Word.Interfaces.ListItemData; + sequenceName?: string; /** - * Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return 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 a separator of up to five characters. This appears between the sequence number and the page number in the table of authorities. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listItemOrNullObject?: Word.Interfaces.ListItemData; + sequenceSeparator?: string; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. + * Specifies the leader character that appears between entries and their associated page numbers in the table of authorities. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shading?: Word.Interfaces.ShadingUniversalData; + tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + } + /** An interface describing the data returned by calling `tableOfAuthoritiesCollection.toJSON()`. */ + interface TableOfAuthoritiesCollectionData { + items?: Word.Interfaces.TableOfAuthoritiesData[]; + } + /** An interface describing the data returned by calling `tableOfAuthoritiesCategory.toJSON()`. */ + interface TableOfAuthoritiesCategoryData { /** - * Gets the collection of shape objects anchored in the paragraph, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * Specifies the name of this table of authorities category. + Changing the name of the category doesn't change the index in the collection. The value for {@link Word.TableOfAuthorities | TableOfAuthorities.category} will remain the same. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shapes?: Word.Interfaces.ShapeData[]; + name?: string; + } + /** An interface describing the data returned by calling `tableOfAuthoritiesCategoryCollection.toJSON()`. */ + interface TableOfAuthoritiesCategoryCollectionData { + items?: Word.Interfaces.TableOfAuthoritiesCategoryData[]; + } + /** An interface describing the data returned by calling `tableOfContents.toJSON()`. */ + interface TableOfContentsData { /** - * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. + * Specifies whether built-in heading styles are used for the table of contents. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + areBuiltInHeadingStylesUsed?: boolean; /** - * Specifies the value, in points, for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. + * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of contents. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - firstLineIndent?: number; + areFieldsUsed?: boolean; /** - * Indicates the paragraph is the last one inside its parent body. + * Specifies whether entries in the table of contents should be formatted as hyperlinks when publishing to the web. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isLastParagraph?: boolean; + areHyperlinksUsedOnWeb?: boolean; /** - * Checks whether the paragraph is a list item. + * Specifies whether the page numbers in the table of contents should be hidden when publishing to the web. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isListItem?: boolean; + arePageNumbersHiddenOnWeb?: boolean; /** - * Specifies the left indent value, in points, for the paragraph. + * Specifies whether page numbers are included in the table of contents. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftIndent?: number; + arePageNumbersIncluded?: boolean; /** - * Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. + * Specifies whether page numbers are aligned with the right margin in the table of contents. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineSpacing?: number; + arePageNumbersRightAligned?: boolean; /** - * Specifies the amount of spacing, in grid lines, after the paragraph. + * Specifies the ending heading level for the table of contents. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitAfter?: number; + lowerHeadingLevel?: number; /** - * Specifies the amount of spacing, in grid lines, before the paragraph. + * Specifies the character between entries and their page numbers in the table of contents. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitBefore?: number; + tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** - * Specifies the outline level for the paragraph. + * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of contents. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - outlineLevel?: number; + tableId?: string; /** - * Specifies the right indent value, in points, for the paragraph. + * Specifies the starting heading level for the table of contents. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightIndent?: number; + upperHeadingLevel?: number; + } + /** An interface describing the data returned by calling `tableOfContentsCollection.toJSON()`. */ + interface TableOfContentsCollectionData { + items?: Word.Interfaces.TableOfContentsData[]; + } + /** An interface describing the data returned by calling `tableOfFigures.toJSON()`. */ + interface TableOfFiguresData { /** - * Specifies the spacing, in points, after the paragraph. + * Specifies whether built-in heading styles are used for the table of figures. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - spaceAfter?: number; + areBuiltInHeadingStylesUsed?: boolean; /** - * Specifies the spacing, in points, before the paragraph. + * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of figures. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - spaceBefore?: number; + areFieldsUsed?: boolean; /** - * Specifies the style name for the paragraph. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * Specifies whether entries in the table of figures should be formatted as hyperlinks when publishing to the web. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: string; + areHyperlinksUsedOnWeb?: boolean; /** - * Specifies the built-in style name for the paragraph. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Specifies whether the page numbers in the table of figures should be hidden when publishing to the web. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + arePageNumbersHiddenOnWeb?: boolean; /** - * Gets the level of the paragraph's table. It returns 0 if the paragraph isn't in a table. + * Specifies whether page numbers are included in the table of figures. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tableNestingLevel?: number; + arePageNumbersIncluded?: boolean; /** - * Gets the text of the paragraph. + * Specifies whether page numbers are aligned with the right margin in the table of figures. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - text?: string; + arePageNumbersRightAligned?: boolean; /** - * Gets a string that represents the paragraph identifier in the current session. ID is in standard 8-4-4-4-12 GUID format without curly braces and differs across sessions and coauthors. + * Specifies the label that identifies the items to be included in the table of figures. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - uniqueLocalId?: string; - } - /** An interface describing the data returned by calling `paragraphCollection.toJSON()`. */ - interface ParagraphCollectionData { - items?: Word.Interfaces.ParagraphData[]; - } - /** An interface describing the data returned by calling `paragraphFormat.toJSON()`. */ - interface ParagraphFormatData { + captionLabel?: string; /** - * Specifies the alignment for the specified paragraphs. + * Specifies whether the caption label and caption number are included in the table of figures. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + isLabelIncluded?: boolean; /** - * Specifies the value (in points) for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. + * Specifies the ending heading level for the table of figures. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - firstLineIndent?: number; + lowerHeadingLevel?: number; /** - * Specifies whether all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document. + * Specifies the character between entries and their page numbers in the table of figures. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - keepTogether?: boolean; + tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** - * Specifies whether the specified paragraph remains on the same page as the paragraph that follows it when Microsoft Word repaginates the document. + * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of figures. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - keepWithNext?: boolean; + tableId?: string; /** - * Specifies the left indent. + * Specifies the starting heading level for the table of figures. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftIndent?: number; + upperHeadingLevel?: number; + } + /** An interface describing the data returned by calling `tableOfFiguresCollection.toJSON()`. */ + interface TableOfFiguresCollectionData { + items?: Word.Interfaces.TableOfFiguresData[]; + } + /** An interface describing the data returned by calling `tableRow.toJSON()`. */ + interface TableRowData { /** - * Specifies the line spacing (in points) for the specified paragraphs. + * Gets cells. + * + * @remarks + * [Api set: WordApi 1.3] + */ + cells?: Word.Interfaces.TableCellData[]; + /** + * Gets the collection of field objects in the table row. + * + * @remarks + * [Api set: WordApi 1.4] + */ + fields?: Word.Interfaces.FieldData[]; + /** + * Gets the font. Use this to get and set font name, size, color, and other properties. + * + * @remarks + * [Api set: WordApi 1.3] + */ + font?: Word.Interfaces.FontData; + /** + * Gets the number of cells in the row. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - lineSpacing?: number; + cellCount?: number; /** - * Specifies the amount of spacing (in gridlines) after the specified paragraphs. + * Specifies the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - lineUnitAfter?: number; + horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Specifies the amount of spacing (in gridlines) before the specified paragraphs. + * Checks whether the row is a header row. To set the number of header rows, use `headerRowCount` on the Table object. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - lineUnitBefore?: number; + isHeader?: boolean; /** - * Specifies whether left and right indents are the same width. + * Specifies the preferred height of the row in points. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - mirrorIndents?: boolean; + preferredHeight?: number; /** - * Specifies the outline level for the specified paragraphs. + * Gets the index of the row in its parent table. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - outlineLevel?: Word.OutlineLevel | "OutlineLevel1" | "OutlineLevel2" | "OutlineLevel3" | "OutlineLevel4" | "OutlineLevel5" | "OutlineLevel6" | "OutlineLevel7" | "OutlineLevel8" | "OutlineLevel9" | "OutlineLevelBodyText"; + rowIndex?: number; /** - * Specifies the right indent (in points) for the specified paragraphs. + * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - rightIndent?: number; + shadingColor?: string; /** - * Specifies the amount of spacing (in points) after the specified paragraph or text column. + * Specifies the text values in the row, as a 2D JavaScript array. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - spaceAfter?: number; + values?: string[][]; /** - * Specifies the spacing (in points) before the specified paragraphs. + * Specifies the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - spaceBefore?: number; + verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + } + /** An interface describing the data returned by calling `tableRowCollection.toJSON()`. */ + interface TableRowCollectionData { + items?: Word.Interfaces.TableRowData[]; + } + /** An interface describing the data returned by calling `tableCell.toJSON()`. */ + interface TableCellData { /** - * Specifies whether the first and last lines in the specified paragraph remain on the same page as the rest of the paragraph when Microsoft Word repaginates the document. + * Gets the body object of the cell. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - widowControl?: boolean; - } - /** An interface describing the data returned by calling `range.toJSON()`. */ - interface RangeData { + body?: Word.Interfaces.BodyData; /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the range. + * Gets the index of the cell in its row. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - borders?: Word.Interfaces.BorderUniversalData[]; + cellIndex?: number; /** - * Gets the collection of field objects in the range. + * Specifies the width of the cell's column in points. This is applicable to uniform tables. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - fields?: Word.Interfaces.FieldData[]; + columnWidth?: number; /** - * Gets the text format of the range. Use this to get and set font name, size, color, and other properties. + * Specifies the horizontal alignment of the cell. The value can be 'Left', 'Centered', 'Right', or 'Justified'. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - font?: Word.Interfaces.FontData; + horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; /** - * Gets a `FrameCollection` object that represents all the frames in the range. + * Gets the index of the cell's row in the table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - frames?: Word.Interfaces.FrameData[]; + rowIndex?: number; /** - * Returns a `HyperlinkCollection` object that represents all the hyperlinks in the range. + * Specifies the shading color of the cell. Color is specified in "#RRGGBB" format or by using the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - hyperlinks?: Word.Interfaces.HyperlinkData[]; + shadingColor?: string; /** - * Gets the collection of inline picture objects in the range. + * Specifies the text of the cell. * * @remarks - * [Api set: WordApi 1.2] + * [Api set: WordApi 1.3] */ - inlinePictures?: Word.Interfaces.InlinePictureData[]; + value?: string; /** - * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. + * Specifies the vertical alignment of the cell. The value can be 'Top', 'Center', or 'Bottom'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - listFormat?: Word.Interfaces.ListFormatData; + verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; /** - * Gets the collection of pages in the range. + * Gets the width of the cell in points. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - pages?: Word.Interfaces.PageData[]; + width?: number; + } + /** An interface describing the data returned by calling `tableCellCollection.toJSON()`. */ + interface TableCellCollectionData { + items?: Word.Interfaces.TableCellData[]; + } + /** An interface describing the data returned by calling `tableBorder.toJSON()`. */ + interface TableBorderData { /** - * Gets the collection of sections in the range. + * Specifies the table border color. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - sections?: Word.Interfaces.SectionData[]; + color?: string; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. + * Specifies the type of the table border. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - shading?: Word.Interfaces.ShadingUniversalData; + type?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; /** - * Gets the collection of shape objects anchored in the range, including both inline and floating shapes. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * Specifies the width, in points, of the table border. Not applicable to table border types that have fixed widths. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.3] */ - shapes?: Word.Interfaces.ShapeData[]; + width?: number; + } + /** An interface describing the data returned by calling `template.toJSON()`. */ + interface TemplateData { /** - * Gets a `TableColumnCollection` object that represents all the table columns in the range. + * Specifies the East Asian language to use when breaking lines of text in the document or template. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tableColumns?: Word.Interfaces.TableColumnData[]; + farEastLineBreakLanguage?: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; /** - * Specifies whether the range is formatted as bold. + * Specifies the line break control level for the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bold?: boolean; + farEastLineBreakLevel?: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"; /** - * Specifies whether the range is formatted as bold in a right-to-left language document. + * Returns the name of the template, including the drive or Web path. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - boldBidirectional?: boolean; + fullName?: string; /** - * Specifies a `CharacterCase` value that represents the case of the text in the range. + * Specifies whether the spelling and grammar checker ignores documents based on this template. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - case?: Word.CharacterCase | "Next" | "Lower" | "Upper" | "TitleWord" | "TitleSentence" | "Toggle" | "HalfWidth" | "FullWidth" | "Katakana" | "Hiragana"; + hasNoProofing?: boolean; /** - * Specifies the character width of the range. + * Specifies the character spacing adjustment for the template. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - characterWidth?: Word.CharacterWidth | "Half" | "Full"; + justificationMode?: Word.JustificationMode | "Expand" | "Compress" | "CompressKana"; /** - * Specifies if the range contains combined characters. + * Specifies if Microsoft Word kerns half-width Latin characters and punctuation marks in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - combineCharacters?: boolean; + kerningByAlgorithm?: boolean; /** - * Specifies if Microsoft Word ignores the number of characters per line for the corresponding `Range` object. + * Specifies a `LanguageId` value that represents the language in the template. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - disableCharacterSpaceGrid?: boolean; + languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies the emphasis mark for a character or designated character string. + * Specifies an East Asian language for the language in the template. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - emphasisMark?: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle"; + languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies the ending character position of the range. + * Returns only the name of the document template (excluding any path or other location information). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - end?: number; + name?: string; /** - * Specifies the width (in the current measurement units) in which Microsoft Word fits the text in the current selection or range. + * Specifies the kinsoku characters after which Microsoft Word will not break a line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fitTextWidth?: number; + noLineBreakAfter?: string; /** - * Specifies if a grammar check has been run on the range or document. + * Specifies the kinsoku characters before which Microsoft Word will not break a line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - grammarChecked?: boolean; + noLineBreakBefore?: string; /** - * Specifies the proofing status (spelling and grammar checking) of the range. + * Returns the path to the document template. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hasNoProofing?: boolean; + path?: string; /** - * Specifies the highlight color for the range. + * Specifies `true` if the template has not changed since it was last saved, `false` if Microsoft Word displays a prompt to save changes when the document is closed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - highlightColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + saved?: boolean; /** - * Specifies the formatting for horizontal text set within vertical text. + * Returns the template type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontalInVertical?: Word.HorizontalInVerticalType | "None" | "FitInLine" | "ResizeLine"; + type?: Word.TemplateType | "Normal" | "Global" | "Attached"; + } + /** An interface describing the data returned by calling `templateCollection.toJSON()`. */ + interface TemplateCollectionData { + items?: Word.Interfaces.TemplateData[]; + } + /** An interface describing the data returned by calling `trackedChange.toJSON()`. */ + interface TrackedChangeData { /** - * Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. Use a '#' to separate the address part from the optional location part. + * Gets the author of the tracked change. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - hyperlink?: string; + author?: string; /** - * Specifies the ID for the range. + * Gets the date of the tracked change. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - id?: string; + date?: Date; /** - * Checks whether the range length is zero. + * Gets the text of the tracked change. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - isEmpty?: boolean; + text?: string; /** - * Gets if the range is collapsed and is located at the end-of-row mark in a table. + * Gets the type of the tracked change. + * + * @remarks + * [Api set: WordApi 1.6] + */ + type?: Word.TrackedChangeType | "None" | "Added" | "Deleted" | "Formatted"; + } + /** An interface describing the data returned by calling `trackedChangeCollection.toJSON()`. */ + interface TrackedChangeCollectionData { + items?: Word.Interfaces.TrackedChangeData[]; + } + /** An interface describing the data returned by calling `view.toJSON()`. */ + interface ViewData { + /** + * Specifies whether all nonprinting characters are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isEndOfRowMark?: boolean; + areAllNonprintingCharactersDisplayed?: boolean; /** - * Gets whether the text in the range is visible on the screen. + * Gets whether background colors and images are shown when the document is displayed in print layout view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTextVisibleOnScreen?: boolean; + areBackgroundsDisplayed?: boolean; /** - * Specifies if the font or range is formatted as italic. + * Gets whether square brackets are displayed at the beginning and end of each bookmark. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - italic?: boolean; + areBookmarksIndicated?: boolean; /** - * Specifies if the font or range is formatted as italic (right-to-left languages). + * Specifies whether Microsoft Word displays the comments in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - italicBidirectional?: boolean; + areCommentsDisplayed?: boolean; /** - * Specifies whether the range of Japanese language text is hiragana or katakana. + * Specifies whether Microsoft Word displays connecting lines from the text to the revision and comment balloons. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - kana?: Word.Kana | "Katakana" | "Hiragana"; + areConnectingLinesToRevisionsBalloonDisplayed?: boolean; /** - * Specifies whether Microsoft Word has detected the language of the text in the range. + * Gets whether crop marks are shown in the corners of pages to indicate where margins are located. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageDetected?: boolean; + areCropMarksDisplayed?: boolean; /** - * Specifies a `LanguageId` value that represents the language for the range. + * Gets whether objects created with the drawing tools are displayed in print layout view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + areDrawingsDisplayed?: boolean; /** - * Specifies an East Asian language for the range. + * Specifies whether shading is applied to the ranges in the document that users have permission to modify. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + areEditableRangesShaded?: boolean; /** - * Specifies a language for the range that isn't classified as an East Asian language. + * Specifies whether field codes are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageIdOther?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + areFieldCodesDisplayed?: boolean; /** - * Specifies if all nonprinting characters (such as hidden text, tab marks, space marks, and paragraph marks) are displayed. + * Specifies whether Microsoft Word displays formatting changes made to the document with Track Changes enabled. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showAll?: boolean; + areFormatChangesDisplayed?: boolean; /** - * Specifies if spelling has been checked throughout the range or document. + * Specifies whether handwritten ink annotations are shown or hidden. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spellingChecked?: boolean; + areInkAnnotationsDisplayed?: boolean; /** - * Specifies the starting character position of the range. + * Specifies whether Microsoft Word displays insertions and deletions made to the document with Track Changes enabled. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - start?: number; + areInsertionsAndDeletionsDisplayed?: boolean; /** - * Gets the number of characters in the story that contains the range. + * Gets whether lines wrap at the right edge of the document window rather than at the right margin or the right column boundary. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - storyLength?: number; + areLinesWrappedToWindow?: boolean; /** - * Gets the story type for the range. + * Gets whether object anchors are displayed next to items that can be positioned in print layout view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - storyType?: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; + areObjectAnchorsDisplayed?: boolean; /** - * Specifies the style name for the range. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * Gets whether Microsoft Word displays optional line breaks. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: string; + areOptionalBreaksDisplayed?: boolean; /** - * Specifies the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Gets whether optional hyphens are displayed. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + areOptionalHyphensDisplayed?: boolean; /** - * Gets the text of the range. + * Gets whether other authors' presence should be visible in the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - text?: string; + areOtherAuthorsVisible?: boolean; /** - * Specifies whether Microsoft Word sets two lines of text in one and specifies the characters that enclose the text, if any. + * Gets whether the top and bottom margins and the gray area between pages in the document are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - twoLinesInOne?: Word.TwoLinesInOneType | "None" | "NoBrackets" | "Parentheses" | "SquareBrackets" | "AngleBrackets" | "CurlyBrackets"; + arePageBoundariesDisplayed?: boolean; /** - * Specifies the type of underline applied to the range. + * Gets whether paragraph marks are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - underline?: Word.Underline | "None" | "Single" | "Words" | "Double" | "Dotted" | "Thick" | "Dash" | "DotDash" | "DotDotDash" | "Wavy" | "WavyHeavy" | "DottedHeavy" | "DashHeavy" | "DotDashHeavy" | "DotDotDashHeavy" | "DashLong" | "DashLongHeavy" | "WavyDouble"; - } - /** An interface describing the data returned by calling `rangeCollection.toJSON()`. */ - interface RangeCollectionData { - items?: Word.Interfaces.RangeData[]; - } - /** An interface describing the data returned by calling `searchOptions.toJSON()`. */ - interface SearchOptionsData { + areParagraphsMarksDisplayed?: boolean; /** - * Specifies a value that indicates whether to ignore all punctuation characters between words. Corresponds to the Ignore punctuation check box in the Find and Replace dialog box. + * Gets whether blank boxes are displayed as placeholders for pictures. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ignorePunct?: boolean; + arePicturePlaceholdersDisplayed?: boolean; /** - * Specifies a value that indicates whether to ignore all whitespace between words. Corresponds to the Ignore whitespace characters check box in the Find and Replace dialog box. + * Specifies whether Microsoft Word displays revisions and comments made to the document with Track Changes enabled. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ignoreSpace?: boolean; + areRevisionsAndCommentsDisplayed?: boolean; /** - * Specifies a value that indicates whether to perform a case sensitive search. Corresponds to the Match case check box in the Find and Replace dialog box. + * Gets whether space characters are displayed. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - matchCase?: boolean; + areSpacesIndicated?: boolean; /** - * Specifies a value that indicates whether to match words that begin with the search string. Corresponds to the Match prefix check box in the Find and Replace dialog box. + * Specifies whether table gridlines are displayed. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - matchPrefix?: boolean; + areTableGridlinesDisplayed?: boolean; /** - * Specifies a value that indicates whether to match words that end with the search string. Corresponds to the Match suffix check box in the Find and Replace dialog box. + * Gets whether tab characters are displayed. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - matchSuffix?: boolean; + areTabsDisplayed?: boolean; /** - * Specifies a value that indicates whether to find operation only entire words, not text that is part of a larger word. Corresponds to the Find whole words only check box in the Find and Replace dialog box. + * Gets whether dotted lines are displayed around page margins, text columns, objects, and frames in print layout view. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - matchWholeWord?: boolean; + areTextBoundariesDisplayed?: boolean; /** - * Specifies a value that indicates whether the search will be performed using special search operators. Corresponds to the Use wildcards check box in the Find and Replace dialog box. + * Specifies the column width in Reading mode. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - matchWildcards?: boolean; - } - /** An interface describing the data returned by calling `section.toJSON()`. */ - interface SectionData { + columnWidth?: Word.ColumnWidth | "Narrow" | "Default" | "Wide"; /** - * Gets the body object of the section. This doesn't include the header/footer and other section metadata. + * Gets on-screen shading for fields. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - body?: Word.Interfaces.BodyData; + fieldShading?: Word.FieldShading | "Never" | "Always" | "WhenSelected"; /** - * Returns a `BorderUniversalCollection` object that represents all the borders in the section. + * Specifies whether all the text in a window is displayed in the same sans-serif font with minimal formatting to speed up display. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - borders?: Word.Interfaces.BorderUniversalData[]; + isDraft?: boolean; /** - * Returns a `PageSetup` object that's associated with the section. + * Specifies whether only the first line of body text is shown in outline view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageSetup?: Word.Interfaces.PageSetupData; + isFirstLineOnlyDisplayed?: boolean; /** - * Specifies if the section is protected for forms. + * Specifies whether character formatting is visible in outline view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - protectedForForms?: boolean; - } - /** An interface describing the data returned by calling `sectionCollection.toJSON()`. */ - interface SectionCollectionData { - items?: Word.Interfaces.SectionData[]; - } - /** An interface describing the data returned by calling `setting.toJSON()`. */ - interface SettingData { + isFormatDisplayed?: boolean; /** - * Gets the key of the setting. + * Specifies whether the window is in full-screen view. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - key?: string; + isFullScreen?: boolean; /** - * Specifies the value of the setting. + * Gets whether text formatted as hidden text is displayed. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - value?: any; - } - /** An interface describing the data returned by calling `settingCollection.toJSON()`. */ - interface SettingCollectionData { - items?: Word.Interfaces.SettingData[]; - } - /** An interface describing the data returned by calling `styleCollection.toJSON()`. */ - interface StyleCollectionData { - items?: Word.Interfaces.StyleData[]; - } - /** An interface describing the data returned by calling `style.toJSON()`. */ - interface StyleData { + isHiddenTextDisplayed?: boolean; /** - * Specifies a BorderCollection object that represents all the borders for the specified style. + * Gets whether highlight formatting is displayed and printed with the document. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - borders?: Word.Interfaces.BorderData[]; + isHighlightingDisplayed?: boolean; /** - * Gets a font object that represents the character formatting of the specified style. + * Specifies whether the document is in conflict mode view. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontData; + isInConflictMode?: boolean; /** - * Returns a `Frame` object that represents the frame formatting for the style. + * Specifies whether Microsoft Word is in Panning mode. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - frame?: Word.Interfaces.FrameData; + isInPanning?: boolean; /** - * Specifies a link between a paragraph and a character style. + * Specifies whether the document is being viewed in reading layout view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - linkStyle?: Word.Interfaces.StyleData; + isInReadingLayout?: boolean; /** - * Gets a ListTemplate object that represents the list formatting for the specified Style object. + * Specifies whether mail merge data is displayed instead of mail merge fields. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listTemplate?: Word.Interfaces.ListTemplateData; + isMailMergeDataView?: boolean; /** - * Gets a ParagraphFormat object that represents the paragraph settings for the specified style. + * Specifies whether the text in the document is visible when the header and footer areas are displayed. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - paragraphFormat?: Word.Interfaces.ParagraphFormatData; + isMainTextLayerVisible?: boolean; /** - * Gets a Shading object that represents the shading for the specified style. Not applicable to List style. + * Specifies whether the pointer is displayed as a magnifying glass in print preview. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shading?: Word.Interfaces.ShadingData; + isPointerShownAsMagnifier?: boolean; /** - * Gets a TableStyle object representing Style properties that can be applied to a table. + * Specifies whether pages displayed in reading layout view are displayed using the same layout as printed pages. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tableStyle?: Word.Interfaces.TableStyleData; + isReadingLayoutActualView?: boolean; /** - * Specifies whether the style is automatically redefined based on the selection. + * Specifies whether XML tags are visible in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - automaticallyUpdate?: boolean; + isXmlMarkupVisible?: boolean; /** - * Specifies the name of an existing style to use as the base formatting of another style. + * Specifies the display mode for tracked changes. * * @remarks - * [Api set: WordApi 1.5] - * - * Note: The ability to set `baseStyle` was introduced in WordApi 1.6. + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - baseStyle?: string; + markupMode?: Word.RevisionsMode | "Balloon" | "Inline" | "Mixed"; /** - * Gets whether the specified style is a built-in style. + * Specifies the page color in Reading mode. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - builtIn?: boolean; + pageColor?: Word.PageColor | "None" | "Sepia" | "Inverse"; /** - * Gets the description of the specified style. + * Specifies the page movement type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - description?: string; + pageMovementType?: Word.PageMovementType | "Vertical" | "SideToSide"; /** - * Specifies whether the spelling and grammar checker ignores text formatted with this style. + * Specifies whether margins are visible or hidden when the document is viewed in Full Screen Reading view. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hasProofing?: boolean; + readingLayoutTruncateMargins?: Word.ReadingLayoutMargin | "Automatic" | "Suppress" | "Full"; /** - * Gets whether the specified style is a built-in style that has been modified or applied in the document or a new style that has been created in the document. + * Gets whether Word displays revision balloons in the left or right margin in the document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - inUse?: boolean; + revisionsBalloonSide?: Word.RevisionsBalloonMargin | "Left" | "Right"; /** - * Specifies a `LanguageId` value that represents the language for the style. + * Specifies the width of the revision balloons. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + revisionsBalloonWidth?: number; /** - * Specifies an East Asian language for the style. + * Specifies how Microsoft Word measures the width of revision balloons. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + revisionsBalloonWidthType?: Word.RevisionsBalloonWidthType | "Percent" | "Points"; /** - * Gets whether a style is a linked style that can be used for both paragraph and character formatting. + * Specifies the document element displayed in print layout view. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - linked?: boolean; + seekView?: Word.SeekView | "MainDocument" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "CurrentPageHeader" | "CurrentPageFooter"; /** - * Returns the list level for the style. + * Specifies the active window pane. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listLevelNumber?: number; + splitSpecial?: Word.SpecialPane | "None" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "FootnoteContinuationNotice" | "FootnoteContinuationSeparator" | "FootnoteSeparator" | "EndnoteContinuationNotice" | "EndnoteContinuationSeparator" | "EndnoteSeparator" | "Comments" | "CurrentPageHeader" | "CurrentPageFooter" | "Revisions" | "RevisionsHoriz" | "RevisionsVert"; /** - * Specifies whether the style cannot be changed or edited. + * Specifies the view type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - locked?: boolean; + type?: Word.ViewType | "Normal" | "Outline" | "Print" | "PrintPreview" | "Master" | "Web" | "Reading" | "Conflict"; + } + /** An interface describing the data returned by calling `shape.toJSON()`. */ + interface ShapeData { /** - * Gets the name of a style in the language of the user. + * Represents the body object of the shape. Only applies to text boxes and geometric shapes. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - nameLocal?: string; + body?: Word.Interfaces.BodyData; /** - * Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style. + * Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "Canvas". 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: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] + */ + canvas?: Word.Interfaces.CanvasData; + /** + * Returns the fill formatting of the shape. * - * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. + * @remarks + * [Api set: WordApiDesktop 1.2] */ - nextParagraphStyle?: string; + fill?: Word.Interfaces.ShapeFillData; /** - * Specifies whether to remove spacing between paragraphs that are formatted using the same style. + * Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - noSpaceBetweenParagraphsOfSameStyle?: boolean; + parentCanvas?: Word.Interfaces.ShapeData; /** - * Specifies the priority. + * Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - priority?: number; + parentGroup?: Word.Interfaces.ShapeData; /** - * Specifies whether the style corresponds to an available quick style. + * Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "GroupShape". 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: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - quickStyle?: boolean; + shapeGroup?: Word.Interfaces.ShapeGroupData; /** - * Gets the style type. + * Gets the text frame object of the shape. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - type?: Word.StyleType | "Character" | "List" | "Paragraph" | "Table"; + textFrame?: Word.Interfaces.TextFrameData; /** - * Specifies whether the specified style is made visible as a recommended style in the Styles and in the Styles task pane in Microsoft Word after it's used in the document. + * Returns the text wrap formatting of the shape. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - unhideWhenUsed?: boolean; + textWrap?: Word.Interfaces.ShapeTextWrapData; /** - * Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane. + * Specifies whether a given shape can overlap other shapes. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.2] */ - visibility?: boolean; - } - /** An interface describing the data returned by calling `shading.toJSON()`. */ - interface ShadingData { + allowOverlap?: boolean; /** - * Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies a string that represents the alternative text associated with the shape. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.2] */ - backgroundPatternColor?: string; + altTextDescription?: string; /** - * Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name. + * The geometric shape type of the shape. It will be null if isn't a geometric shape. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.2] */ - foregroundPatternColor?: string; + geometricShapeType?: Word.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"; /** - * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. + * The height, in points, of the shape. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.2] */ - texture?: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; - } - /** An interface describing the data returned by calling `shadingUniversal.toJSON()`. */ - interface ShadingUniversalData { + height?: number; /** - * Specifies the color that's applied to the background of the `ShadingUniversal` object. You can provide the value in the '#RRGGBB' format. + * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - backgroundPatternColor?: string; + heightRelative?: number; /** - * Specifies the color that's applied to the background of the `ShadingUniversal` object. + * Gets an integer that represents the shape identifier. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - backgroundPatternColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + id?: number; /** - * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. You can provide the value in the '#RRGGBB' format. + * Check whether this shape is a child of a group shape or a canvas shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - foregroundPatternColor?: string; + isChild?: boolean; /** - * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. + * The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - foregroundPatternColorIndex?: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor"; + left?: number; /** - * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. + * The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - texture?: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid"; - } - /** An interface describing the data returned by calling `table.toJSON()`. */ - interface TableData { + leftRelative?: number; /** - * Gets the collection of field objects in the table. + * Specifies if the aspect ratio of this shape is locked. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.2] */ - fields?: Word.Interfaces.FieldData[]; + lockAspectRatio?: boolean; /** - * Gets the font. Use this to get and set font name, size, color, and other properties. + * The name of the shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - font?: Word.Interfaces.FontData; + name?: string; /** - * Gets all of the table rows. + * The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - rows?: Word.Interfaces.TableRowData[]; + relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; /** - * Gets the child tables nested one level deeper. + * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - tables?: Word.Interfaces.TableData[]; + relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. + * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies the number of header rows. + * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - headerRowCount?: number; + relativeVerticalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + rotation?: number; /** - * Indicates whether all of the table rows are uniform. + * The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - isUniform?: boolean; + top?: number; /** - * Gets the nesting level of the table. Top-level tables have level 1. + * The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - nestingLevel?: number; + topRelative?: number; /** - * Gets the number of rows in the table. + * Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - rowCount?: number; + type?: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture" | "Canvas"; /** - * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * Specifies if the shape is visible. Not applicable to inline shapes. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - shadingColor?: string; + visible?: boolean; /** - * Specifies the style name for the table. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * The width, in points, of the shape. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - style?: string; + width?: number; /** - * Specifies whether the table has banded columns. + * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - styleBandedColumns?: boolean; + widthRelative?: number; + } + /** An interface describing the data returned by calling `shapeGroup.toJSON()`. */ + interface ShapeGroupData { /** - * Specifies whether the table has banded rows. + * Gets the Shape object associated with the group. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - styleBandedRows?: boolean; + shape?: Word.Interfaces.ShapeData; /** - * Specifies the built-in style name for the table. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Gets the collection of Shape objects. Currently, only text boxes, geometric shapes, and pictures are supported. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6"; + shapes?: Word.Interfaces.ShapeData[]; /** - * Specifies whether the table has a first column with a special style. + * Gets an integer that represents the shape group identifier. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - styleFirstColumn?: boolean; + id?: number; + } + /** An interface describing the data returned by calling `canvas.toJSON()`. */ + interface CanvasData { /** - * Specifies whether the table has a last column with a special style. + * Gets the Shape object associated with the canvas. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - styleLastColumn?: boolean; + shape?: Word.Interfaces.ShapeData; /** - * Specifies whether the table has a total (last) row with a special style. + * Gets the collection of Shape objects. Currently, only text boxes, pictures, and geometric shapes are supported. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - styleTotalRow?: boolean; + shapes?: Word.Interfaces.ShapeData[]; /** - * Specifies the text values in the table, as a 2D JavaScript array. + * Gets an integer that represents the canvas identifier. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - values?: string[][]; + id?: number; + } + /** An interface describing the data returned by calling `shapeCollection.toJSON()`. */ + interface ShapeCollectionData { + items?: Word.Interfaces.ShapeData[]; + } + /** An interface describing the data returned by calling `shapeFill.toJSON()`. */ + interface ShapeFillData { /** - * Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. + * Specifies the shape fill background color. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + backgroundColor?: string; /** - * Specifies the width of the table in points. + * Specifies the shape fill foreground color. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - width?: number; + foregroundColor?: string; + /** + * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + transparency?: number; + /** + * Returns the fill type of the shape. See `Word.ShapeFillType` for details. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + type?: Word.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "Picture" | "Texture" | "Mixed"; } - /** An interface describing the data returned by calling `tableStyle.toJSON()`. */ - interface TableStyleData { + /** An interface describing the data returned by calling `textFrame.toJSON()`. */ + interface TextFrameData { /** - * Specifies the table's alignment against the page margin. + * 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: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.2] */ - alignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + autoSizeSetting?: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed"; /** - * Specifies whether lines in tables formatted with a specified style break across pages. + * Represents the bottom margin, in points, of the text frame. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApiDesktop 1.2] */ - allowBreakAcrossPage?: boolean; + bottomMargin?: number; /** - * Specifies the amount of space to add between the contents and the bottom borders of the cells. + * Specifies if the text frame contains text. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.2] */ - bottomCellMargin?: number; + hasText?: boolean; /** - * Specifies the spacing (in points) between the cells in a table style. + * Represents the left margin, in points, of the text frame. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.2] */ - cellSpacing?: number; + leftMargin?: number; /** - * Specifies the amount of space to add between the contents and the left borders of the cells. + * Returns True if text in the text frame shouldn't rotate when the shape is rotated. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.2] */ - leftCellMargin?: number; + noTextRotation?: boolean; /** - * Specifies the amount of space to add between the contents and the right borders of the cells. + * Represents the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.2] */ - rightCellMargin?: number; + orientation?: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed"; /** - * Specifies the amount of space to add between the contents and the top borders of the cells. + * Represents the right margin, in points, of the text frame. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApiDesktop 1.2] */ - topCellMargin?: number; + rightMargin?: number; + /** + * Represents the top margin, in points, of the text frame. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + topMargin?: number; + /** + * Represents the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + verticalAlignment?: Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom"; + /** + * Determines whether lines break automatically to fit text inside the shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + wordWrap?: boolean; } - /** An interface describing the data returned by calling `tabStop.toJSON()`. */ - interface TabStopData { + /** An interface describing the data returned by calling `shapeTextWrap.toJSON()`. */ + interface ShapeTextWrapData { /** - * Gets a `TabAlignment` value that represents the alignment for the tab stop. + * Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - alignment?: Word.TabAlignment | "Left" | "Center" | "Right" | "Decimal" | "Bar" | "List"; + bottomDistance?: number; /** - * Gets whether this tab stop is a custom tab stop. + * Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - customTab?: boolean; + leftDistance?: number; /** - * Gets a `TabLeader` value that represents the leader for this `TabStop` object. + * Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - leader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + rightDistance?: number; /** - * Gets the position of the tab stop relative to the left margin. + * Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farthest from the page margin. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - position?: number; - } - /** An interface describing the data returned by calling `tabStopCollection.toJSON()`. */ - interface TabStopCollectionData { - items?: Word.Interfaces.TabStopData[]; - } - /** An interface describing the data returned by calling `tableCollection.toJSON()`. */ - interface TableCollectionData { - items?: Word.Interfaces.TableData[]; + side?: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest"; + /** + * Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + topDistance?: number; + /** + * Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + type?: Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front"; } - /** An interface describing the data returned by calling `tableColumn.toJSON()`. */ - interface TableColumnData { + /** An interface describing the data returned by calling `reviewer.toJSON()`. */ + interface ReviewerData { /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the table column. + * Specifies if the `Reviewer` object is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - borders?: Word.Interfaces.BorderUniversalData[]; + isVisible?: boolean; + } + /** An interface describing the data returned by calling `reviewerCollection.toJSON()`. */ + interface ReviewerCollectionData { + items?: Word.Interfaces.ReviewerData[]; + } + /** An interface describing the data returned by calling `revisionsFilter.toJSON()`. */ + interface RevisionsFilterData { /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the column. + * Specifies a `RevisionsMarkup` value that represents the extent of reviewer markup displayed in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shading?: Word.Interfaces.ShadingUniversalData; + markup?: Word.RevisionsMarkup | "None" | "Simple" | "All"; /** - * Returns the position of this column in a collection. + * Specifies a `RevisionsView` value that represents globally whether Word displays the original version of the document or the final version, which might have revisions and formatting changes applied. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - columnIndex?: number; + view?: Word.RevisionsView | "Final" | "Original"; + } + /** An interface describing the data returned by calling `repeatingSectionItem.toJSON()`. */ + interface RepeatingSectionItemData { /** - * Returns `true` if the column or row is the first one in the table; `false` otherwise. + * Returns the range of this repeating section item, excluding the start and end tags. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isFirst?: boolean; + range?: Word.Interfaces.RangeData; + } + /** An interface describing the data returned by calling `revision.toJSON()`. */ + interface RevisionData { /** - * Returns `true` if the column or row is the last one in the table; `false` otherwise. + * Gets a `Range` object that represents the range of text that was moved from one place to another in the document with tracked changes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isLast?: boolean; + movedRange?: Word.Interfaces.RangeData; /** - * Returns the nesting level of the column. + * Gets a `Range` object that represents the portion of the document that's contained within a revision mark. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nestingLevel?: number; + range?: Word.Interfaces.RangeData; /** - * Specifies the preferred width (in points or as a percentage of the window width) for the column. - The unit of measurement can be specified by the `preferredWidthType` property. + * Gets the name of the user who made the tracked change. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - preferredWidth?: number; + author?: string; /** - * Specifies the preferred unit of measurement to use for the width of the table column. + * Gets the date and time when the tracked change was made. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - preferredWidthType?: Word.PreferredWidthType | "Auto" | "Percent" | "Points"; + date?: Date; /** - * Specifies the width of the column, in points. + * Gets the description of tracked formatting changes in the revision. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - width?: number; - } - /** An interface describing the data returned by calling `tableColumnCollection.toJSON()`. */ - interface TableColumnCollectionData { - items?: Word.Interfaces.TableColumnData[]; - } - /** An interface describing the data returned by calling `tableRow.toJSON()`. */ - interface TableRowData { - /** - * Gets cells. - * - * @remarks - * [Api set: WordApi 1.3] - */ - cells?: Word.Interfaces.TableCellData[]; - /** - * Gets the collection of field objects in the table row. - * - * @remarks - * [Api set: WordApi 1.4] - */ - fields?: Word.Interfaces.FieldData[]; - /** - * Gets the font. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.3] - */ - font?: Word.Interfaces.FontData; - /** - * Gets the number of cells in the row. - * - * @remarks - * [Api set: WordApi 1.3] - */ - cellCount?: number; - /** - * Specifies the horizontal alignment of every cell in the row. The value can be 'Left', 'Centered', 'Right', or 'Justified'. - * - * @remarks - * [Api set: WordApi 1.3] - */ - horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + formatDescription?: string; /** - * Checks whether the row is a header row. To set the number of header rows, use `headerRowCount` on the Table object. + * Gets a number that represents the position of this item in a collection. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isHeader?: boolean; + index?: number; /** - * Specifies the preferred height of the row in points. + * Gets the revision type. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - preferredHeight?: number; + type?: Word.RevisionType | "None" | "Insert" | "Delete" | "Property" | "ParagraphNumber" | "DisplayField" | "Reconcile" | "Conflict" | "Style" | "Replace" | "ParagraphProperty" | "TableProperty" | "SectionProperty" | "StyleDefinition" | "MovedFrom" | "MovedTo" | "CellInsertion" | "CellDeletion" | "CellMerge" | "CellSplit" | "ConflictInsert" | "ConflictDelete"; + } + /** An interface describing the data returned by calling `revisionCollection.toJSON()`. */ + interface RevisionCollectionData { + items?: Word.Interfaces.RevisionData[]; + } + /** An interface describing the data returned by calling `datePickerContentControl.toJSON()`. */ + interface DatePickerContentControlData { /** - * Gets the index of the row in its parent table. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rowIndex?: number; + placeholderText?: Word.Interfaces.BuildingBlockData; /** - * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * Gets a `Range` object that represents the contents of the content control in the active document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shadingColor?: string; + range?: Word.Interfaces.RangeData; /** - * Specifies the text values in the row, as a 2D JavaScript array. + * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - values?: string[][]; + xmlMapping?: Word.Interfaces.XmlMappingData; /** - * Specifies the vertical alignment of the cells in the row. The value can be 'Top', 'Center', or 'Bottom'. + * Specifies the appearance of the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; - } - /** An interface describing the data returned by calling `tableRowCollection.toJSON()`. */ - interface TableRowCollectionData { - items?: Word.Interfaces.TableRowData[]; - } - /** An interface describing the data returned by calling `tableCell.toJSON()`. */ - interface TableCellData { + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Gets the body object of the cell. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - body?: Word.Interfaces.BodyData; + color?: string; /** - * Gets the index of the cell in its row. + * Specifies a `CalendarType` value that represents the calendar type for the date picker content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - cellIndex?: number; + dateCalendarType?: Word.CalendarType | "Western" | "Arabic" | "Hebrew" | "Taiwan" | "Japan" | "Thai" | "Korean" | "SakaEra" | "TranslitEnglish" | "TranslitFrench" | "Umalqura"; /** - * Specifies the width of the cell's column in points. This is applicable to uniform tables. + * Specifies the format in which dates are displayed. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - columnWidth?: number; + dateDisplayFormat?: string; /** - * Specifies the horizontal alignment of the cell. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Specifies a `LanguageId` that represents the language format for the date displayed in the date picker content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - horizontalAlignment?: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"; + dateDisplayLocale?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Gets the index of the cell's row in the table. + * Specifies a `ContentControlDateStorageFormat` value that represents the format for storage and retrieval of dates when the date picker content control is bound to the XML data store of the active document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rowIndex?: number; + dateStorageFormat?: Word.ContentControlDateStorageFormat | "Text" | "Date" | "DateTime"; /** - * Specifies the shading color of the cell. Color is specified in "#RRGGBB" format or by using the color name. + * Gets the identification for the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shadingColor?: string; + id?: string; /** - * Specifies the text of the cell. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - value?: string; + isTemporary?: boolean; /** - * Specifies the vertical alignment of the cell. The value can be 'Top', 'Center', or 'Bottom'. + * Specifies the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - verticalAlignment?: Word.VerticalAlignment | "Mixed" | "Top" | "Center" | "Bottom"; + level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * Gets the width of the cell in points. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: number; - } - /** An interface describing the data returned by calling `tableCellCollection.toJSON()`. */ - interface TableCellCollectionData { - items?: Word.Interfaces.TableCellData[]; - } - /** An interface describing the data returned by calling `tableBorder.toJSON()`. */ - interface TableBorderData { + lockContentControl?: boolean; /** - * Specifies the table border color. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - color?: string; + lockContents?: boolean; /** - * Specifies the type of the table border. + * Gets whether the placeholder text for the content control is being displayed. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave"; + showingPlaceholderText?: boolean; /** - * Specifies the width, in points, of the table border. Not applicable to table border types that have fixed widths. + * Specifies a tag to identify the content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: number; - } - /** An interface describing the data returned by calling `template.toJSON()`. */ - interface TemplateData { + tag?: string; /** - * Specifies the East Asian language to use when breaking lines of text in the document or template. + * Specifies the title for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - farEastLineBreakLanguage?: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"; + title?: string; + } + /** An interface describing the data returned by calling `pictureContentControl.toJSON()`. */ + interface PictureContentControlData { /** - * Specifies the line break control level for the document. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - farEastLineBreakLevel?: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"; + placeholderText?: Word.Interfaces.BuildingBlockData; /** - * Returns the name of the template, including the drive or Web path. + * Returns a `Range` object that represents the contents of the content control in the active document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fullName?: string; + range?: Word.Interfaces.RangeData; /** - * Specifies whether the spelling and grammar checker ignores documents based on this template. + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hasNoProofing?: boolean; + xmlMapping?: Word.Interfaces.XmlMappingData; /** - * Specifies the character spacing adjustment for the template. + * Specifies the appearance of the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - justificationMode?: Word.JustificationMode | "Expand" | "Compress" | "CompressKana"; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Specifies if Microsoft Word kerns half-width Latin characters and punctuation marks in the document. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - kerningByAlgorithm?: boolean; + color?: string; /** - * Specifies a `LanguageId` value that represents the language in the template. + * Returns the identification for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + id?: string; /** - * Specifies an East Asian language for the language in the template. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + isTemporary?: boolean; /** - * Returns only the name of the document template (excluding any path or other location information). + * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: string; + level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * Specifies the kinsoku characters after which Microsoft Word will not break a line. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - noLineBreakAfter?: string; + lockContentControl?: boolean; /** - * Specifies the kinsoku characters before which Microsoft Word will not break a line. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - noLineBreakBefore?: string; + lockContents?: boolean; /** - * Returns the path to the document template. + * Returns whether the placeholder text for the content control is being displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - path?: string; + showingPlaceholderText?: boolean; /** - * Specifies `true` if the template has not changed since it was last saved, `false` if Microsoft Word displays a prompt to save changes when the document is closed. + * Specifies a tag to identify the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - saved?: boolean; + tag?: string; /** - * Returns the template type. + * Specifies the title for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.TemplateType | "Normal" | "Global" | "Attached"; - } - /** An interface describing the data returned by calling `templateCollection.toJSON()`. */ - interface TemplateCollectionData { - items?: Word.Interfaces.TemplateData[]; + title?: string; } - /** An interface describing the data returned by calling `trackedChange.toJSON()`. */ - interface TrackedChangeData { + /** An interface describing the data returned by calling `groupContentControl.toJSON()`. */ + interface GroupContentControlData { /** - * Gets the author of the tracked change. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - author?: string; + placeholderText?: Word.Interfaces.BuildingBlockData; /** - * Gets the date of the tracked change. + * Gets a `Range` object that represents the contents of the content control in the active document. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - date?: Date; + range?: Word.Interfaces.RangeData; /** - * Gets the text of the tracked change. + * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - text?: string; + xmlMapping?: Word.Interfaces.XmlMappingData; /** - * Gets the type of the tracked change. + * Specifies the appearance of the content control. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: Word.TrackedChangeType | "None" | "Added" | "Deleted" | "Formatted"; - } - /** An interface describing the data returned by calling `trackedChangeCollection.toJSON()`. */ - interface TrackedChangeCollectionData { - items?: Word.Interfaces.TrackedChangeData[]; - } - /** An interface describing the data returned by calling `view.toJSON()`. */ - interface ViewData { + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Specifies whether all nonprinting characters are displayed. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areAllNonprintingCharactersDisplayed?: boolean; + color?: string; /** - * Gets whether background colors and images are shown when the document is displayed in print layout view. + * Returns the identification for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areBackgroundsDisplayed?: boolean; + id?: string; /** - * Gets whether square brackets are displayed at the beginning and end of each bookmark. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areBookmarksIndicated?: boolean; + isTemporary?: boolean; /** - * Specifies whether Microsoft Word displays the comments in the document. + * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areCommentsDisplayed?: boolean; + level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * Specifies whether Microsoft Word displays connecting lines from the text to the revision and comment balloons. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areConnectingLinesToRevisionsBalloonDisplayed?: boolean; + lockContentControl?: boolean; /** - * Gets whether crop marks are shown in the corners of pages to indicate where margins are located. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areCropMarksDisplayed?: boolean; + lockContents?: boolean; /** - * Gets whether objects created with the drawing tools are displayed in print layout view. + * Returns whether the placeholder text for the content control is being displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areDrawingsDisplayed?: boolean; + showingPlaceholderText?: boolean; /** - * Specifies whether shading is applied to the ranges in the document that users have permission to modify. + * Specifies a tag to identify the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areEditableRangesShaded?: boolean; + tag?: string; /** - * Specifies whether field codes are displayed. + * Specifies the title for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areFieldCodesDisplayed?: boolean; + title?: string; + } + /** An interface describing the data returned by calling `buildingBlockGalleryContentControl.toJSON()`. */ + interface BuildingBlockGalleryContentControlData { /** - * Specifies whether Microsoft Word displays formatting changes made to the document with Track Changes enabled. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areFormatChangesDisplayed?: boolean; + placeholderText?: Word.Interfaces.BuildingBlockData; /** - * Specifies whether handwritten ink annotations are shown or hidden. + * Returns a `Range` object that represents the contents of the content control in the active document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areInkAnnotationsDisplayed?: boolean; + range?: Word.Interfaces.RangeData; /** - * Specifies whether Microsoft Word displays insertions and deletions made to the document with Track Changes enabled. + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areInsertionsAndDeletionsDisplayed?: boolean; + xmlMapping?: Word.Interfaces.XmlMappingData; /** - * Gets whether lines wrap at the right edge of the document window rather than at the right margin or the right column boundary. + * Specifies the appearance of the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areLinesWrappedToWindow?: boolean; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Gets whether object anchors are displayed next to items that can be positioned in print layout view. + * Specifies the category for the building block content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areObjectAnchorsDisplayed?: boolean; + buildingBlockCategory?: string; /** - * Gets whether Microsoft Word displays optional line breaks. + * Specifies a `BuildingBlockType` value that represents the type of building block for the building block content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areOptionalBreaksDisplayed?: boolean; + buildingBlockType?: Word.BuildingBlockType | "QuickParts" | "CoverPage" | "Equations" | "Footers" | "Headers" | "PageNumber" | "Tables" | "Watermarks" | "AutoText" | "TextBox" | "PageNumberTop" | "PageNumberBottom" | "PageNumberPage" | "TableOfContents" | "CustomQuickParts" | "CustomCoverPage" | "CustomEquations" | "CustomFooters" | "CustomHeaders" | "CustomPageNumber" | "CustomTables" | "CustomWatermarks" | "CustomAutoText" | "CustomTextBox" | "CustomPageNumberTop" | "CustomPageNumberBottom" | "CustomPageNumberPage" | "CustomTableOfContents" | "Custom1" | "Custom2" | "Custom3" | "Custom4" | "Custom5" | "Bibliography" | "CustomBibliography"; /** - * Gets whether optional hyphens are displayed. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areOptionalHyphensDisplayed?: boolean; + color?: string; /** - * Gets whether other authors' presence should be visible in the document. + * Gets the identification for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areOtherAuthorsVisible?: boolean; + id?: string; /** - * Gets whether the top and bottom margins and the gray area between pages in the document are displayed. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arePageBoundariesDisplayed?: boolean; + isTemporary?: boolean; /** - * Gets whether paragraph marks are displayed. + * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areParagraphsMarksDisplayed?: boolean; + level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * Gets whether blank boxes are displayed as placeholders for pictures. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - arePicturePlaceholdersDisplayed?: boolean; + lockContentControl?: boolean; /** - * Specifies whether Microsoft Word displays revisions and comments made to the document with Track Changes enabled. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areRevisionsAndCommentsDisplayed?: boolean; + lockContents?: boolean; /** - * Gets whether space characters are displayed. + * Gets if the placeholder text for the content control is being displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areSpacesIndicated?: boolean; + showingPlaceholderText?: boolean; /** - * Specifies whether table gridlines are displayed. + * Specifies a tag to identify the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areTableGridlinesDisplayed?: boolean; + tag?: string; /** - * Gets whether tab characters are displayed. + * Specifies the title for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areTabsDisplayed?: boolean; + title?: string; + } + /** An interface describing the data returned by calling `repeatingSectionContentControl.toJSON()`. */ + interface RepeatingSectionContentControlData { /** - * Gets whether dotted lines are displayed around page margins, text columns, objects, and frames in print layout view. + * Returns a `BuildingBlock` object that represents the placeholder text for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - areTextBoundariesDisplayed?: boolean; + placeholderText?: Word.Interfaces.BuildingBlockData; /** - * Specifies the column width in Reading mode. + * Gets a `Range` object that represents the contents of the content control in the active document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - columnWidth?: Word.ColumnWidth | "Narrow" | "Default" | "Wide"; + range?: Word.Interfaces.RangeData; /** - * Gets on-screen shading for fields. + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fieldShading?: Word.FieldShading | "Never" | "Always" | "WhenSelected"; + xmlapping?: Word.Interfaces.XmlMappingData; /** - * Specifies whether all the text in a window is displayed in the same sans-serif font with minimal formatting to speed up display. + * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isDraft?: boolean; + allowInsertDeleteSection?: boolean; /** - * Specifies whether only the first line of body text is shown in outline view. + * Specifies the appearance of the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isFirstLineOnlyDisplayed?: boolean; + appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; /** - * Specifies whether character formatting is visible in outline view. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isFormatDisplayed?: boolean; + color?: string; /** - * Specifies whether the window is in full-screen view. + * Returns the identification for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isFullScreen?: boolean; + id?: string; /** - * Gets whether text formatted as hidden text is displayed. + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isHiddenTextDisplayed?: boolean; + isTemporary?: boolean; /** - * Gets whether highlight formatting is displayed and printed with the document. + * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isHighlightingDisplayed?: boolean; + level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; /** - * Specifies whether the document is in conflict mode view. + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isInConflictMode?: boolean; + lockContentControl?: boolean; /** - * Specifies whether Microsoft Word is in Panning mode. + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isInPanning?: boolean; + lockContents?: boolean; /** - * Specifies whether the document is being viewed in reading layout view. + * Specifies the name of the repeating section items used in the context menu associated with this repeating section content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isInReadingLayout?: boolean; + repeatingSectionItemTitle?: string; /** - * Specifies whether mail merge data is displayed instead of mail merge fields. + * Returns whether the placeholder text for the content control is being displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isMailMergeDataView?: boolean; + showingPlaceholderText?: boolean; /** - * Specifies whether the text in the document is visible when the header and footer areas are displayed. + * Specifies a tag to identify the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isMainTextLayerVisible?: boolean; + tag?: string; /** - * Specifies whether the pointer is displayed as a magnifying glass in print preview. + * Specifies the title for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isPointerShownAsMagnifier?: boolean; + title?: string; + } + /** An interface describing the data returned by calling `frame.toJSON()`. */ + interface FrameData { /** - * Specifies whether pages displayed in reading layout view are displayed using the same layout as printed pages. + * Returns a `BorderUniversalCollection` object that represents all the borders for the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isReadingLayoutActualView?: boolean; + borders?: Word.Interfaces.BorderUniversalData[]; /** - * Specifies whether XML tags are visible in the document. + * Returns a `Range` object that represents the portion of the document that's contained within the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isXmlMarkupVisible?: boolean; + range?: Word.Interfaces.RangeData; /** - * Specifies the display mode for tracked changes. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - markupMode?: Word.RevisionsMode | "Balloon" | "Inline" | "Mixed"; + shading?: Word.Interfaces.ShadingUniversalData; /** - * Specifies the page color in Reading mode. + * Specifies the height (in points) of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageColor?: Word.PageColor | "None" | "Sepia" | "Inverse"; + height?: number; /** - * Specifies the page movement type. + * Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageMovementType?: Word.PageMovementType | "Vertical" | "SideToSide"; + heightRule?: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; /** - * Specifies whether margins are visible or hidden when the document is viewed in Full Screen Reading view. + * Specifies the horizontal distance between the frame and the surrounding text, in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - readingLayoutTruncateMargins?: Word.ReadingLayoutMargin | "Automatic" | "Suppress" | "Full"; + horizontalDistanceFromText?: number; /** - * Gets whether Word displays revision balloons in the left or right margin in the document. + * Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - revisionsBalloonSide?: Word.RevisionsBalloonMargin | "Left" | "Right"; + horizontalPosition?: number; /** - * Specifies the width of the revision balloons. + * Specifies if the frame is locked. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - revisionsBalloonWidth?: number; + lockAnchor?: boolean; /** - * Specifies how Microsoft Word measures the width of revision balloons. + * Specifies the relative horizontal position of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - revisionsBalloonWidthType?: Word.RevisionsBalloonWidthType | "Percent" | "Points"; + relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies the document element displayed in print layout view. + * Specifies the relative vertical position of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - seekView?: Word.SeekView | "MainDocument" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "CurrentPageHeader" | "CurrentPageFooter"; + relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; /** - * Specifies the active window pane. + * Specifies if document text wraps around the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - splitSpecial?: Word.SpecialPane | "None" | "PrimaryHeader" | "FirstPageHeader" | "EvenPagesHeader" | "PrimaryFooter" | "FirstPageFooter" | "EvenPagesFooter" | "Footnotes" | "Endnotes" | "FootnoteContinuationNotice" | "FootnoteContinuationSeparator" | "FootnoteSeparator" | "EndnoteContinuationNotice" | "EndnoteContinuationSeparator" | "EndnoteSeparator" | "Comments" | "CurrentPageHeader" | "CurrentPageFooter" | "Revisions" | "RevisionsHoriz" | "RevisionsVert"; + textWrap?: boolean; /** - * Specifies the view type. + * Specifies the vertical distance (in points) between the frame and the surrounding text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.ViewType | "Normal" | "Outline" | "Print" | "PrintPreview" | "Master" | "Web" | "Reading" | "Conflict"; - } - /** An interface describing the data returned by calling `shape.toJSON()`. */ - interface ShapeData { + verticalDistanceFromText?: number; /** - * Represents the body object of the shape. Only applies to text boxes and geometric shapes. + * Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - body?: Word.Interfaces.BodyData; + verticalPosition?: number; /** - * Gets the canvas associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "Canvas". 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 width (in points) of the frame. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - canvas?: Word.Interfaces.CanvasData; + width?: number; /** - * Returns the fill formatting of the shape. + * Specifies the rule used to determine the width of the frame. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - fill?: Word.Interfaces.ShapeFillData; + widthRule?: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; + } + /** An interface describing the data returned by calling `frameCollection.toJSON()`. */ + interface FrameCollectionData { + items?: Word.Interfaces.FrameData[]; + } + /** An interface describing the data returned by calling `documentLibraryVersion.toJSON()`. */ + interface DocumentLibraryVersionData { /** - * Gets the top-level parent canvas shape of this child shape. It will be null if it isn't a child shape of a canvas. + * Gets any optional comments associated with this version of the shared document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentCanvas?: Word.Interfaces.ShapeData; + comments?: string; /** - * Gets the top-level parent group shape of this child shape. It will be null if it isn't a child shape of a group. + * Gets the date and time at which this version of the shared document was last saved to the server. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentGroup?: Word.Interfaces.ShapeData; + modified?: any; /** - * Gets the shape group associated with the shape. An object with its `isNullObject` property set to `true` will be returned if the shape type isn't "GroupShape". 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}. + * Gets the name of the user who last saved this version of the shared document to the server. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shapeGroup?: Word.Interfaces.ShapeGroupData; + modifiedBy?: string; + } + /** An interface describing the data returned by calling `documentLibraryVersionCollection.toJSON()`. */ + interface DocumentLibraryVersionCollectionData { + items?: Word.Interfaces.DocumentLibraryVersionData[]; + } + /** An interface describing the data returned by calling `dropCap.toJSON()`. */ + interface DropCapData { /** - * Gets the text frame object of the shape. + * Gets the distance (in points) between the dropped capital letter and the paragraph text. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - textFrame?: Word.Interfaces.TextFrameData; + distanceFromText?: number; /** - * Returns the text wrap formatting of the shape. + * Gets the name of the font for the dropped capital letter. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - textWrap?: Word.Interfaces.ShapeTextWrapData; + fontName?: string; /** - * Specifies whether a given shape can overlap other shapes. + * Gets the height (in lines) of the dropped capital letter. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - allowOverlap?: boolean; + linesToDrop?: number; /** - * Specifies a string that represents the alternative text associated with the shape. + * Gets the position of the dropped capital letter. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - altTextDescription?: string; + position?: Word.DropPosition | "None" | "Normal" | "Margin"; + } + /** An interface describing the data returned by calling `listFormat.toJSON()`. */ + interface ListFormatData { /** - * The geometric shape type of the shape. It will be null if isn't a geometric shape. + * Returns a `List` object that represents the first formatted list contained in the `ListFormat` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - geometricShapeType?: Word.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"; + list?: Word.Interfaces.ListData; /** - * The height, in points, of the shape. + * Gets the list template associated with the `ListFormat` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - height?: number; + listTemplate?: Word.Interfaces.ListTemplateData; /** - * The percentage of shape height to vertical relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * Indicates whether the `ListFormat` object contains a single list. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - heightRelative?: number; + isSingleList?: boolean; /** - * Gets an integer that represents the shape identifier. + * Indicates whether the `ListFormat` object contains a single list template. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: number; + isSingleListTemplate?: boolean; /** - * Check whether this shape is a child of a group shape or a canvas shape. + * Specifies the list level number for the first paragraph for the `ListFormat` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isChild?: boolean; + listLevelNumber?: number; /** - * The distance, in points, from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * Gets the string representation of the list value of the first paragraph in the range for the `ListFormat` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - left?: number; + listString?: string; /** - * The relative left position as a percentage from the left side of the shape to the horizontal relative position, see {@link Word.RelativeHorizontalPosition}. For an inline or child shape, it will return 0 and can't be set. + * Gets the type of the list for the `ListFormat` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftRelative?: number; + listType?: Word.ListType | "ListNoNumbering" | "ListListNumOnly" | "ListBullet" | "ListSimpleNumbering" | "ListOutlineNumbering" | "ListMixedNumbering" | "ListPictureBullet"; /** - * Specifies if the aspect ratio of this shape is locked. + * Gets the numeric value of the the first paragraph in the range for the `ListFormat` object. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lockAspectRatio?: boolean; + listValue?: number; + } + /** An interface describing the data returned by calling `fillFormat.toJSON()`. */ + interface FillFormatData { /** - * The name of the shape. + * Returns a `ColorFormat` object that represents the background color for the fill. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - name?: string; + backgroundColor?: Word.Interfaces.ColorFormatData; /** - * The relative horizontal position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Returns a `ColorFormat` object that represents the foreground color for the fill. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; + foregroundColor?: Word.Interfaces.ColorFormatData; /** - * The relative horizontal size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - relativeHorizontalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + gradientAngle?: number; /** - * The relative vertical position of the shape. For an inline shape, it can't be set. For details, see {@link Word.RelativeVerticalPosition}. + * Gets the gradient color type. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + gradientColorType?: Word.GradientColorType | "Mixed" | "OneColor" | "TwoColors" | "PresetColors" | "MultiColor"; /** - * The relative vertical size of the shape. For an inline or child shape, it can't be set. For details, see {@link Word.RelativeHorizontalPosition}. + * Returns how dark or light a one-color gradient fill is. + A value of 0 means that black is mixed in with the shape's foreground color to form the gradient. + A value of 1 means that white is mixed in. + Values between 0 and 1 mean that a darker or lighter shade of the foreground color is mixed in. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - relativeVerticalSize?: Word.RelativeSize | "Margin" | "Page" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + gradientDegree?: number; /** - * Specifies the rotation, in degrees, of the shape. Not applicable to Canvas shape. + * Returns the gradient style for the fill. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rotation?: number; + gradientStyle?: Word.GradientStyle | "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter"; /** - * The distance, in points, from the top edge of the shape to the vertical relative position (see {@link Word.RelativeVerticalPosition}). For an inline shape, it will return 0 and can't be set. For a child shape in a canvas or group, it's relative to the top left corner. + * Returns the gradient variant for the fill as an integer value from 1 to 4 for most gradient fills. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - top?: number; + gradientVariant?: number; /** - * The relative top position as a percentage from the top edge of the shape to the vertical relative position, see {@link Word.RelativeVerticalPosition}. For an inline or child shape, it will return 0 and can't be set. + * Specifies if the object, or the formatting applied to it, is visible. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topRelative?: number; + isVisible?: boolean; /** - * Gets the shape type. Currently, only the following shapes are supported: text boxes, geometric shapes, groups, pictures, and canvases. + * Returns a `PatternType` value that represents the pattern applied to the fill or line. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: Word.ShapeType | "Unsupported" | "TextBox" | "GeometricShape" | "Group" | "Picture" | "Canvas"; + pattern?: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"; /** - * Specifies if the shape is visible. Not applicable to inline shapes. + * Returns the preset gradient type for the fill. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - visible?: boolean; + presetGradientType?: Word.PresetGradientType | "Mixed" | "EarlySunset" | "LateSunset" | "Nightfall" | "Daybreak" | "Horizon" | "Desert" | "Ocean" | "CalmWater" | "Fire" | "Fog" | "Moss" | "Peacock" | "Wheat" | "Parchment" | "Mahogany" | "Rainbow" | "RainbowII" | "Gold" | "GoldII" | "Brass" | "Chrome" | "ChromeII" | "Silver" | "Sapphire"; /** - * The width, in points, of the shape. + * Gets the preset texture. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: number; + presetTexture?: Word.PresetTexture | "Mixed" | "Papyrus" | "Canvas" | "Denim" | "WovenMat" | "WaterDroplets" | "PaperBag" | "FishFossil" | "Sand" | "GreenMarble" | "WhiteMarble" | "BrownMarble" | "Granite" | "Newsprint" | "RecycledPaper" | "Parchment" | "Stationery" | "BlueTissuePaper" | "PinkTissuePaper" | "PurpleMesh" | "Bouquet" | "Cork" | "Walnut" | "Oak" | "MediumWood"; /** - * The percentage of shape width to horizontal relative size, see {@link Word.RelativeSize}. For an inline or child shape, it can't be set. + * Specifies whether the fill rotates with the shape. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - widthRelative?: number; - } - /** An interface describing the data returned by calling `shapeGroup.toJSON()`. */ - interface ShapeGroupData { + rotateWithObject?: boolean; /** - * Gets the Shape object associated with the group. + * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shape?: Word.Interfaces.ShapeData; + textureAlignment?: Word.TextureAlignment | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "Center" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; /** - * Gets the collection of Shape objects. Currently, only text boxes, geometric shapes, and pictures are supported. + * Specifies the horizontal scaling factor for the texture fill. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shapes?: Word.Interfaces.ShapeData[]; + textureHorizontalScale?: number; /** - * Gets an integer that represents the shape group identifier. + * Returns the name of the custom texture file for the fill. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: number; - } - /** An interface describing the data returned by calling `canvas.toJSON()`. */ - interface CanvasData { + textureName?: string; /** - * Gets the Shape object associated with the canvas. + * Specifies the horizontal offset of the texture from the origin in points. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shape?: Word.Interfaces.ShapeData; + textureOffsetX?: number; /** - * Gets the collection of Shape objects. Currently, only text boxes, pictures, and geometric shapes are supported. + * Specifies the vertical offset of the texture. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shapes?: Word.Interfaces.ShapeData[]; + textureOffsetY?: number; /** - * Gets an integer that represents the canvas identifier. + * Specifies whether the texture is tiled. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: number; - } - /** An interface describing the data returned by calling `shapeCollection.toJSON()`. */ - interface ShapeCollectionData { - items?: Word.Interfaces.ShapeData[]; - } - /** An interface describing the data returned by calling `shapeFill.toJSON()`. */ - interface ShapeFillData { + textureTile?: boolean; /** - * Specifies the shape fill background color. You can provide the value in the '#RRGGBB' format or the color name. + * Returns the texture type for the fill. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - backgroundColor?: string; + textureType?: Word.TextureType | "Mixed" | "Preset" | "UserDefined"; /** - * Specifies the shape fill foreground color. You can provide the value in the '#RRGGBB' format or the color name. + * Specifies the vertical scaling factor for the texture fill as a value between 0.0 and 1.0. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - foregroundColor?: string; + textureVerticalScale?: number; /** - * Specifies the transparency percentage of the fill as a value from 0.0 (opaque) through 1.0 (clear). Returns `null` if the shape type does not support transparency or the shape fill has inconsistent transparency, such as with a gradient fill type. + * Specifies the degree of transparency of the fill for a shape as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ transparency?: number; /** - * Returns the fill type of the shape. See `Word.ShapeFillType` for details. + * Gets the fill format type. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: Word.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "Picture" | "Texture" | "Mixed"; + type?: Word.FillType | "Mixed" | "Solid" | "Patterned" | "Gradient" | "Textured" | "Background" | "Picture"; } - /** An interface describing the data returned by calling `textFrame.toJSON()`. */ - interface TextFrameData { + /** An interface describing the data returned by calling `glowFormat.toJSON()`. */ + interface GlowFormatData { /** - * 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. + * Returns a `ColorFormat` object that represents the color for a glow effect. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - autoSizeSetting?: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed"; + color?: Word.Interfaces.ColorFormatData; /** - * Represents the bottom margin, in points, of the text frame. + * Specifies the length of the radius for a glow effect. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bottomMargin?: number; + radius?: number; /** - * Specifies if the text frame contains text. + * Specifies the degree of transparency for the glow effect as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - hasText?: boolean; + transparency?: number; + } + /** An interface describing the data returned by calling `lineFormat.toJSON()`. */ + interface LineFormatData { /** - * Represents the left margin, in points, of the text frame. + * Gets a `ColorFormat` object that represents the background color for a patterned line. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftMargin?: number; + backgroundColor?: Word.Interfaces.ColorFormatData; /** - * Returns True if text in the text frame shouldn't rotate when the shape is rotated. + * Gets a `ColorFormat` object that represents the foreground color for the line. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - noTextRotation?: boolean; + foregroundColor?: Word.Interfaces.ColorFormatData; /** - * Represents the angle to which the text is oriented for the text frame. See `Word.ShapeTextOrientation` for details. + * Specifies the length of the arrowhead at the beginning of the line. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - orientation?: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed"; + beginArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; /** - * Represents the right margin, in points, of the text frame. + * Specifies the style of the arrowhead at the beginning of the line. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightMargin?: number; + beginArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; /** - * Represents the top margin, in points, of the text frame. + * Specifies the width of the arrowhead at the beginning of the line. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topMargin?: number; + beginArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; /** - * Represents the vertical alignment of the text frame. See `Word.ShapeTextVerticalAlignment` for details. + * Specifies the dash style for the line. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - verticalAlignment?: Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom"; + dashStyle?: Word.LineDashStyle | "Mixed" | "Solid" | "SquareDot" | "RoundDot" | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "SysDash" | "SysDot" | "SysDashDot"; /** - * Determines whether lines break automatically to fit text inside the shape. + * Specifies the length of the arrowhead at the end of the line. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - wordWrap?: boolean; - } - /** An interface describing the data returned by calling `shapeTextWrap.toJSON()`. */ - interface ShapeTextWrapData { + endArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; /** - * Specifies the distance (in points) between the document text and the bottom edge of the text-free area surrounding the specified shape. + * Specifies the style of the arrowhead at the end of the line. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bottomDistance?: number; + endArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; /** - * Specifies the distance (in points) between the document text and the left edge of the text-free area surrounding the specified shape. + * Specifies the width of the arrowhead at the end of the line. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftDistance?: number; + endArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; /** - * Specifies the distance (in points) between the document text and the right edge of the text-free area surrounding the specified shape. + * Specifies if to draw lines inside a shape. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightDistance?: number; + insetPen?: boolean; /** - * Specifies whether the document text should wrap on both sides of the specified shape, on either the left or right side only, or on the side of the shape that's farthest from the page margin. + * Specifies if the object, or the formatting applied to it, is visible. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - side?: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest"; + isVisible?: boolean; /** - * Specifies the distance (in points) between the document text and the top edge of the text-free area surrounding the specified shape. + * Specifies the pattern applied to the line. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topDistance?: number; + pattern?: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"; /** - * Specifies the text wrap type around the shape. See `Word.ShapeTextWrapType` for details. + * Specifies the line format style. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front"; - } - /** An interface describing the data returned by calling `reviewer.toJSON()`. */ - interface ReviewerData { + style?: Word.LineFormatStyle | "Mixed" | "Single" | "ThinThin" | "ThinThick" | "ThickThin" | "ThickBetweenThin"; /** - * Specifies if the `Reviewer` object is visible. + * Specifies the degree of transparency of the line as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; - } - /** An interface describing the data returned by calling `reviewerCollection.toJSON()`. */ - interface ReviewerCollectionData { - items?: Word.Interfaces.ReviewerData[]; - } - /** An interface describing the data returned by calling `revisionsFilter.toJSON()`. */ - interface RevisionsFilterData { + transparency?: number; /** - * Specifies a `RevisionsMarkup` value that represents the extent of reviewer markup displayed in the document. + * Specifies the thickness of the line in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - markup?: Word.RevisionsMarkup | "None" | "Simple" | "All"; + weight?: number; + } + /** An interface describing the data returned by calling `reflectionFormat.toJSON()`. */ + interface ReflectionFormatData { /** - * Specifies a `RevisionsView` value that represents globally whether Word displays the original version of the document or the final version, which might have revisions and formatting changes applied. + * Specifies the degree of blur effect applied to the `ReflectionFormat` object as a value between 0.0 and 100.0. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - view?: Word.RevisionsView | "Final" | "Original"; - } - /** An interface describing the data returned by calling `repeatingSectionItem.toJSON()`. */ - interface RepeatingSectionItemData { + blur?: number; /** - * Returns the range of this repeating section item, excluding the start and end tags. + * Specifies the amount of separation, in points, of the reflected image from the shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeData; - } - /** An interface describing the data returned by calling `datePickerContentControl.toJSON()`. */ - interface DatePickerContentControlData { + offset?: number; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Specifies the size of the reflection as a percentage of the reflected shape from 0 to 100. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: Word.Interfaces.BuildingBlockData; + size?: number; /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * Specifies the degree of transparency for the reflection effect as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeData; + transparency?: number; /** - * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Specifies a `ReflectionType` value that represents the type and direction of the lighting for a shape reflection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingData; + type?: Word.ReflectionType | "Mixed" | "None" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9"; + } + /** An interface describing the data returned by calling `colorFormat.toJSON()`. */ + interface ColorFormatData { /** - * Specifies the appearance of the content control. + * Specifies the brightness of a specified shape color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + brightness?: number; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Specifies the theme color for a color format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + objectThemeColor?: Word.ThemeColorIndex | "NotThemeColor" | "MainDark1" | "MainLight1" | "MainDark2" | "MainLight2" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Hyperlink" | "HyperlinkFollowed" | "Background1" | "Text1" | "Background2" | "Text2"; /** - * Specifies a `CalendarType` value that represents the calendar type for the date picker content control. + * Specifies the red-green-blue (RGB) value of the specified color. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateCalendarType?: Word.CalendarType | "Western" | "Arabic" | "Hebrew" | "Taiwan" | "Japan" | "Thai" | "Korean" | "SakaEra" | "TranslitEnglish" | "TranslitFrench" | "Umalqura"; + rgb?: string; /** - * Specifies the format in which dates are displayed. + * Specifies the lightening or darkening of a specified shape's color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateDisplayFormat?: string; + tintAndShade?: number; /** - * Specifies a `LanguageId` that represents the language format for the date displayed in the date picker content control. + * Returns the shape color type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateDisplayLocale?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + type?: Word.ColorType | "rgb" | "scheme"; + } + /** An interface describing the data returned by calling `shadowFormat.toJSON()`. */ + interface ShadowFormatData { /** - * Specifies a `ContentControlDateStorageFormat` value that represents the format for storage and retrieval of dates when the date picker content control is bound to the XML data store of the active document. + * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateStorageFormat?: Word.ContentControlDateStorageFormat | "Text" | "Date" | "DateTime"; + foregroundColor?: Word.Interfaces.ColorFormatData; /** - * Gets the identification for the content control. + * Specifies the blur level for a shadow format as a value between 0.0 and 100.0. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: string; + blur?: number; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Specifies whether the object or the formatting applied to it is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + isVisible?: boolean; /** - * Specifies the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Specifies `true` if the shadow of the shape appears filled in and is obscured by the shape, even if the shape has no fill, + `false` if the shadow has no fill and the outline of the shadow is visible through the shape if the shape has no fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + obscured?: boolean; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Specifies the horizontal offset (in points) of the shadow from the shape. + A positive value offsets the shadow to the right of the shape; a negative value offsets it to the left. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + offsetX?: number; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Specifies the vertical offset (in points) of the shadow from the shape. + A positive value offsets the shadow to the top of the shape; a negative value offsets it to the bottom. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + offsetY?: number; /** - * Gets whether the placeholder text for the content control is being displayed. + * Specifies whether to rotate the shadow when rotating the shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showingPlaceholderText?: boolean; + rotateWithShape?: boolean; /** - * Specifies a tag to identify the content control. + * Specifies the width of the shadow. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: string; + size?: number; /** - * Specifies the title for the content control. + * Specifies the type of shadow formatting to apply to a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: string; - } - /** An interface describing the data returned by calling `pictureContentControl.toJSON()`. */ - interface PictureContentControlData { + style?: Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow"; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: Word.Interfaces.BuildingBlockData; + transparency?: number; /** - * Returns a `Range` object that represents the contents of the content control in the active document. + * Specifies the shape shadow type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeData; + type?: Word.ShadowType | "Mixed" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9" | "Type10" | "Type11" | "Type12" | "Type13" | "Type14" | "Type15" | "Type16" | "Type17" | "Type18" | "Type19" | "Type20" | "Type21" | "Type22" | "Type23" | "Type24" | "Type25" | "Type26" | "Type27" | "Type28" | "Type29" | "Type30" | "Type31" | "Type32" | "Type33" | "Type34" | "Type35" | "Type36" | "Type37" | "Type38" | "Type39" | "Type40" | "Type41" | "Type42" | "Type43"; + } + /** An interface describing the data returned by calling `threeDimensionalFormat.toJSON()`. */ + interface ThreeDimensionalFormatData { /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Returns a `ColorFormat` object that represents color of the contour of a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingData; + contourColor?: Word.Interfaces.ColorFormatData; /** - * Specifies the appearance of the content control. + * Returns a `ColorFormat` object that represents the color of the shape's extrusion. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + extrusionColor?: Word.Interfaces.ColorFormatData; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Specifies the depth of the bottom bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + bevelBottomDepth?: number; /** - * Returns the identification for the content control. + * Specifies the inset size for the bottom bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: string; + bevelBottomInset?: number; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Specifies a `BevelType` value that represents the bevel type for the bottom bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + bevelBottomType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; /** - * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Specifies the depth of the top bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + bevelTopDepth?: number; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Specifies the inset size for the top bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + bevelTopInset?: number; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Specifies a `BevelType` value that represents the bevel type for the top bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + bevelTopType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; /** - * Returns whether the placeholder text for the content control is being displayed. + * Specifies the width of the contour of a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showingPlaceholderText?: boolean; + contourWidth?: number; /** - * Specifies a tag to identify the content control. + * Specifies the depth of the shape's extrusion. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: string; + depth?: number; /** - * Specifies the title for the content control. + * Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion) + and automatically changes when the shape's fill changes, or whether the extrusion color is independent of the shape's fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: string; - } - /** An interface describing the data returned by calling `groupContentControl.toJSON()`. */ - interface GroupContentControlData { + extrusionColorType?: Word.ExtrusionColorType | "mixed" | "automatic" | "custom"; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Specifies the amount of perspective for a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: Word.Interfaces.BuildingBlockData; + fieldOfView?: number; /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * Specifies `true` if the extrusion appears in perspective — that is, if the walls of the extrusion narrow toward a vanishing point, + `false` if the extrusion is a parallel, or orthographic, projection — that is, if the walls don't narrow toward a vanishing point. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeData; + isPerspective?: boolean; /** - * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Specifies if the specified object, or the formatting applied to it, is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingData; + isVisible?: boolean; /** - * Specifies the appearance of the content control. + * Specifies the angle of the lighting. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + lightAngle?: number; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Returns a `PresetCamera` value that represents the camera presets. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + presetCamera?: Word.PresetCamera | "Mixed" | "LegacyObliqueTopLeft" | "LegacyObliqueTop" | "LegacyObliqueTopRight" | "LegacyObliqueLeft" | "LegacyObliqueFront" | "LegacyObliqueRight" | "LegacyObliqueBottomLeft" | "LegacyObliqueBottom" | "LegacyObliqueBottomRight" | "LegacyPerspectiveTopLeft" | "LegacyPerspectiveTop" | "LegacyPerspectiveTopRight" | "LegacyPerspectiveLeft" | "LegacyPerspectiveFront" | "LegacyPerspectiveRight" | "LegacyPerspectiveBottomLeft" | "LegacyPerspectiveBottom" | "LegacyPerspectiveBottomRight" | "OrthographicFront" | "IsometricTopUp" | "IsometricTopDown" | "IsometricBottomUp" | "IsometricBottomDown" | "IsometricLeftUp" | "IsometricLeftDown" | "IsometricRightUp" | "IsometricRightDown" | "IsometricOffAxis1Left" | "IsometricOffAxis1Right" | "IsometricOffAxis1Top" | "IsometricOffAxis2Left" | "IsometricOffAxis2Right" | "IsometricOffAxis2Top" | "IsometricOffAxis3Left" | "IsometricOffAxis3Right" | "IsometricOffAxis3Bottom" | "IsometricOffAxis4Left" | "IsometricOffAxis4Right" | "IsometricOffAxis4Bottom" | "ObliqueTopLeft" | "ObliqueTop" | "ObliqueTopRight" | "ObliqueLeft" | "ObliqueRight" | "ObliqueBottomLeft" | "ObliqueBottom" | "ObliqueBottomRight" | "PerspectiveFront" | "PerspectiveLeft" | "PerspectiveRight" | "PerspectiveAbove" | "PerspectiveBelow" | "PerspectiveAboveLeftFacing" | "PerspectiveAboveRightFacing" | "PerspectiveContrastingLeftFacing" | "PerspectiveContrastingRightFacing" | "PerspectiveHeroicLeftFacing" | "PerspectiveHeroicRightFacing" | "PerspectiveHeroicExtremeLeftFacing" | "PerspectiveHeroicExtremeRightFacing" | "PerspectiveRelaxed" | "PerspectiveRelaxedModerately"; /** - * Returns the identification for the content control. + * Returns the direction taken by the extrusion's sweep path leading away from the extruded shape (the front face of the extrusion). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: string; + presetExtrusionDirection?: Word.PresetExtrusionDirection | "Mixed" | "BottomRight" | "Bottom" | "BottomLeft" | "Right" | "None" | "Left" | "TopRight" | "Top" | "TopLeft"; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Specifies a `LightRigType` value that represents the lighting preset. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + presetLighting?: Word.LightRigType | "Mixed" | "LegacyFlat1" | "LegacyFlat2" | "LegacyFlat3" | "LegacyFlat4" | "LegacyNormal1" | "LegacyNormal2" | "LegacyNormal3" | "LegacyNormal4" | "LegacyHarsh1" | "LegacyHarsh2" | "LegacyHarsh3" | "LegacyHarsh4" | "ThreePoint" | "Balanced" | "Soft" | "Harsh" | "Flood" | "Contrasting" | "Morning" | "Sunrise" | "Sunset" | "Chilly" | "Freezing" | "Flat" | "TwoPoint" | "Glow" | "BrightRoom"; /** - * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Specifies the position of the light source relative to the extrusion. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + presetLightingDirection?: Word.PresetLightingDirection | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "None" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Specifies the intensity of the extrusion lighting. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + presetLightingSoftness?: Word.PresetLightingSoftness | "Mixed" | "Dim" | "Normal" | "Bright"; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Specifies the extrusion surface material. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + presetMaterial?: Word.PresetMaterial | "Mixed" | "Matte" | "Plastic" | "Metal" | "WireFrame" | "Matte2" | "Plastic2" | "Metal2" | "WarmMatte" | "TranslucentPowder" | "Powder" | "DarkEdge" | "SoftEdge" | "Clear" | "Flat" | "SoftMetal"; /** - * Returns whether the placeholder text for the content control is being displayed. + * Returns the preset extrusion format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showingPlaceholderText?: boolean; + presetThreeDimensionalFormat?: Word.PresetThreeDimensionalFormat | "Mixed" | "Format1" | "Format2" | "Format3" | "Format4" | "Format5" | "Format6" | "Format7" | "Format8" | "Format9" | "Format10" | "Format11" | "Format12" | "Format13" | "Format14" | "Format15" | "Format16" | "Format17" | "Format18" | "Format19" | "Format20"; /** - * Specifies a tag to identify the content control. + * Specifies whether text on a shape rotates with shape. `true` rotates the text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: string; + projectText?: boolean; /** - * Specifies the title for the content control. + * Specifies the rotation of the extruded shape around the x-axis in degrees. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: string; - } - /** An interface describing the data returned by calling `buildingBlockGalleryContentControl.toJSON()`. */ - interface BuildingBlockGalleryContentControlData { + rotationX?: number; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Specifies the rotation of the extruded shape around the y-axis in degrees. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: Word.Interfaces.BuildingBlockData; + rotationY?: number; /** - * Returns a `Range` object that represents the contents of the content control in the active document. + * Specifies the z-axis rotation of the camera. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeData; + rotationZ?: number; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Specifies the position on the z-axis for the shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingData; + z?: number; + } + /** An interface describing the data returned by calling `bibliography.toJSON()`. */ + interface BibliographyData { /** - * Specifies the appearance of the content control. + * Returns a `SourceCollection` object that represents all the sources contained in the bibliography. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + sources?: Word.Interfaces.SourceData[]; /** - * Specifies the category for the building block content control. + * Specifies the name of the active style to use for the bibliography. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - buildingBlockCategory?: string; + bibliographyStyle?: string; + } + /** An interface describing the data returned by calling `sourceCollection.toJSON()`. */ + interface SourceCollectionData { + items?: Word.Interfaces.SourceData[]; + } + /** An interface describing the data returned by calling `source.toJSON()`. */ + interface SourceData { /** - * Specifies a `BuildingBlockType` value that represents the type of building block for the building block content control. + * Gets if the `Source` object has been cited in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - buildingBlockType?: Word.BuildingBlockType | "QuickParts" | "CoverPage" | "Equations" | "Footers" | "Headers" | "PageNumber" | "Tables" | "Watermarks" | "AutoText" | "TextBox" | "PageNumberTop" | "PageNumberBottom" | "PageNumberPage" | "TableOfContents" | "CustomQuickParts" | "CustomCoverPage" | "CustomEquations" | "CustomFooters" | "CustomHeaders" | "CustomPageNumber" | "CustomTables" | "CustomWatermarks" | "CustomAutoText" | "CustomTextBox" | "CustomPageNumberTop" | "CustomPageNumberBottom" | "CustomPageNumberPage" | "CustomTableOfContents" | "Custom1" | "Custom2" | "Custom3" | "Custom4" | "Custom5" | "Bibliography" | "CustomBibliography"; + isCited?: boolean; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Gets the tag of the source. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + tag?: string; /** - * Gets the identification for the content control. + * Gets the XML representation of the source. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: string; + xml?: string; + } + /** An interface describing the data returned by calling `pageSetup.toJSON()`. */ + interface PageSetupData { /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + lineNumbering?: Word.Interfaces.LineNumberingData; /** - * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Gets a `TextColumnCollection` object that represents the set of text columns for the `PageSetup` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + textColumns?: Word.Interfaces.TextColumnData[]; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Specifies whether Microsoft Word prints the document as a booklet. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + bookFoldPrinting?: boolean; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Specifies the number of pages for each booklet. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + bookFoldPrintingSheets?: number; /** - * Gets if the placeholder text for the content control is being displayed. + * Specifies if Microsoft Word reverses the printing order for book fold printing of bidirectional or Asian language documents. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showingPlaceholderText?: boolean; + bookFoldReversePrinting?: boolean; /** - * Specifies a tag to identify the content control. + * Specifies the distance (in points) between the bottom edge of the page and the bottom boundary of the body text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: string; + bottomMargin?: number; /** - * Specifies the title for the content control. + * Specifies the number of characters per line in the document grid. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: string; - } - /** An interface describing the data returned by calling `repeatingSectionContentControl.toJSON()`. */ - interface RepeatingSectionContentControlData { + charsLine?: number; /** - * Returns a `BuildingBlock` object that represents the placeholder text for the content control. + * Specifies whether the first page has a different header and footer. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: Word.Interfaces.BuildingBlockData; + differentFirstPageHeaderFooter?: boolean; /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * Specifies the distance between the footer and the bottom of the page in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeData; + footerDistance?: number; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Specifies the amount (in points) of extra margin space added to each page in a document or section for binding. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlapping?: Word.Interfaces.XmlMappingData; + gutter?: number; /** - * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. + * Specifies on which side the gutter appears in a document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - allowInsertDeleteSection?: boolean; + gutterPosition?: Word.GutterPosition | "Left" | "Right" | "Top"; /** - * Specifies the appearance of the content control. + * Specifies whether Microsoft Word uses gutters for the current document based on a right-to-left language or a left-to-right language. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"; + gutterStyle?: Word.GutterStyle | "Bidirectional" | "Latin"; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Specifies the distance between the header and the top of the page in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: string; + headerDistance?: number; /** - * Returns the identification for the content control. + * Specifies the layout mode for the current document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: string; + layoutMode?: Word.LayoutMode | "Default" | "Grid" | "LineGrid" | "Genko"; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Specifies the distance (in points) between the left edge of the page and the left boundary of the body text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + leftMargin?: number; /** - * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Specifies the number of lines per page in the document grid. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - level?: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"; + linesPage?: number; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Specifies if the inside and outside margins of facing pages are the same width. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + mirrorMargins?: boolean; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Specifies whether odd and even pages have different headers and footers. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + oddAndEvenPagesHeaderFooter?: boolean; /** - * Specifies the name of the repeating section items used in the context menu associated with this repeating section content control. + * Specifies the orientation of the page. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - repeatingSectionItemTitle?: string; + orientation?: Word.PageOrientation | "Portrait" | "Landscape"; /** - * Returns whether the placeholder text for the content control is being displayed. + * Specifies the page height in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showingPlaceholderText?: boolean; + pageHeight?: number; /** - * Specifies a tag to identify the content control. + * Specifies the page width in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: string; + pageWidth?: number; /** - * Specifies the title for the content control. + * Specifies the paper size of the page. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: string; - } - /** An interface describing the data returned by calling `frame.toJSON()`. */ - interface FrameData { + paperSize?: Word.PaperSize | "Size10x14" | "Size11x17" | "Letter" | "LetterSmall" | "Legal" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "CSheet" | "DSheet" | "ESheet" | "FanfoldLegalGerman" | "FanfoldStdGerman" | "FanfoldUS" | "Folio" | "Ledger" | "Note" | "Quarto" | "Statement" | "Tabloid" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC5" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeDL" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "Custom"; /** - * Returns a `BorderUniversalCollection` object that represents all the borders for the frame. + * Specifies the distance (in points) between the right edge of the page and the right boundary of the body text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - borders?: Word.Interfaces.BorderUniversalData[]; + rightMargin?: number; /** - * Returns a `Range` object that represents the portion of the document that's contained within the frame. + * Specifies the reading order and alignment for the specified sections. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeData; + sectionDirection?: Word.SectionDirection | "RightToLeft" | "LeftToRight"; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. + * Specifies the type of section break for the specified object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shading?: Word.Interfaces.ShadingUniversalData; + sectionStart?: Word.SectionStart | "Continuous" | "NewColumn" | "NewPage" | "EvenPage" | "OddPage"; /** - * Specifies the height (in points) of the frame. + * Specifies whether to show the grid. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - height?: number; + showGrid?: boolean; /** - * Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. + * Specifies if endnotes are printed at the end of the next section that doesn't suppress endnotes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - heightRule?: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; + suppressEndnotes?: boolean; /** - * Specifies the horizontal distance between the frame and the surrounding text, in points. + * Specifies the top margin of the page in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontalDistanceFromText?: number; + topMargin?: number; /** - * Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property. + * Specifies whether to print two pages per sheet. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontalPosition?: number; + twoPagesOnOne?: boolean; /** - * Specifies if the frame is locked. + * Specifies the vertical alignment of text on each page in a document or section. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockAnchor?: boolean; + verticalAlignment?: Word.PageSetupVerticalAlignment | "Top" | "Center" | "Justify" | "Bottom"; + } + /** An interface describing the data returned by calling `lineNumbering.toJSON()`. */ + interface LineNumberingData { /** - * Specifies the relative horizontal position of the frame. + * Specifies the numeric increment for line numbers. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - relativeHorizontalPosition?: Word.RelativeHorizontalPosition | "Margin" | "Page" | "Column" | "Character" | "LeftMargin" | "RightMargin" | "InsideMargin" | "OutsideMargin"; + countBy?: number; /** - * Specifies the relative vertical position of the frame. + * Specifies the distance (in points) between the right edge of line numbers and the left edge of the document text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - relativeVerticalPosition?: Word.RelativeVerticalPosition | "Margin" | "Page" | "Paragraph" | "Line" | "TopMargin" | "BottomMargin" | "InsideMargin" | "OutsideMargin"; + distanceFromText?: number; /** - * Specifies if document text wraps around the frame. + * Specifies if line numbering is active for the specified document, section, or sections. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textWrap?: boolean; + isActive?: boolean; /** - * Specifies the vertical distance (in points) between the frame and the surrounding text. + * Specifies the way line numbering runs; that is, whether it starts over at the beginning of a new page or section, or runs continuously. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - verticalDistanceFromText?: number; + restartMode?: Word.NumberingRule | "RestartContinuous" | "RestartSection" | "RestartPage"; /** - * Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property. + * Specifies the starting line number. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - verticalPosition?: number; + startingNumber?: number; + } + /** An interface describing the data returned by calling `textColumnCollection.toJSON()`. */ + interface TextColumnCollectionData { + items?: Word.Interfaces.TextColumnData[]; + } + /** An interface describing the data returned by calling `textColumn.toJSON()`. */ + interface TextColumnData { /** - * Specifies the width (in points) of the frame. + * Specifies the amount of spacing (in points) after the specified paragraph or text column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - width?: number; + spaceAfter?: number; /** - * Specifies the rule used to determine the width of the frame. + * Specifies the width, in points, of the specified text columns. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - widthRule?: Word.FrameSizeRule | "Auto" | "AtLeast" | "Exact"; - } - /** An interface describing the data returned by calling `frameCollection.toJSON()`. */ - interface FrameCollectionData { - items?: Word.Interfaces.FrameData[]; + width?: number; } - /** An interface describing the data returned by calling `documentLibraryVersion.toJSON()`. */ - interface DocumentLibraryVersionData { + /** An interface describing the data returned by calling `selection.toJSON()`. */ + interface SelectionData { /** - * Gets any optional comments associated with this version of the shared document. + * Specifies the ending character position of the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - comments?: string; + end?: number; /** - * Gets the date and time at which this version of the shared document was last saved to the server. + * Specifies the width in which Word fits the text in the current selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - modified?: any; + fitTextWidth?: number; /** - * Gets the name of the user who last saved this version of the shared document to the server. + * Returns whether the spelling and grammar checker ignores the selected text. + If the selected text contains a mix of proofed and un-proofed content, this API returns `null`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - modifiedBy?: string; - } - /** An interface describing the data returned by calling `documentLibraryVersionCollection.toJSON()`. */ - interface DocumentLibraryVersionCollectionData { - items?: Word.Interfaces.DocumentLibraryVersionData[]; - } - /** An interface describing the data returned by calling `dropCap.toJSON()`. */ - interface DropCapData { + hasNoProofing?: boolean; /** - * Gets the distance (in points) between the dropped capital letter and the paragraph text. + * Returns whether the selection in the specified window or pane is active. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - distanceFromText?: number; + isActive?: boolean; /** - * Gets the name of the font for the dropped capital letter. + * Specifies whether column selection mode is active. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fontName?: string; + isColumnSelectModeActive?: boolean; /** - * Gets the height (in lines) of the dropped capital letter. + * Returns whether the selection is at the end-of-row mark in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - linesToDrop?: number; + isEndOfRowMark?: boolean; /** - * Gets the position of the dropped capital letter. + * Specifies whether Extend mode is active. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - position?: Word.DropPosition | "None" | "Normal" | "Margin"; - } - /** An interface describing the data returned by calling `listFormat.toJSON()`. */ - interface ListFormatData { + isExtendModeActive?: boolean; /** - * Returns a `List` object that represents the first formatted list contained in the `ListFormat` object. + * Returns whether the insertion point is at the end of a line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - list?: Word.Interfaces.ListData; + isInsertionPointAtEndOfLine?: boolean; /** - * Gets the list template associated with the `ListFormat` object. + * Specifies whether the beginning of the selection is active. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listTemplate?: Word.Interfaces.ListTemplateData; + isStartActive?: boolean; /** - * Indicates whether the `ListFormat` object contains a single list. + * Specifies whether Word has detected the language of the selected text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isSingleList?: boolean; + languageDetected?: boolean; /** - * Indicates whether the `ListFormat` object contains a single list template. + * Returns the language for the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isSingleListTemplate?: boolean; + languageId?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies the list level number for the first paragraph for the `ListFormat` object. + * Returns the East Asian language for the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listLevelNumber?: number; + languageIdFarEast?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Gets the string representation of the list value of the first paragraph in the range for the `ListFormat` object. + * Returns the language for the selection that isn't classified as an East Asian language. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listString?: string; + languageIdOther?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Gets the type of the list for the `ListFormat` object. + * Specifies the orientation of text in the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listType?: Word.ListType | "ListNoNumbering" | "ListListNumOnly" | "ListBullet" | "ListSimpleNumbering" | "ListOutlineNumbering" | "ListMixedNumbering" | "ListPictureBullet"; + orientation?: Word.TextOrientation | "Horizontal" | "Upward" | "Downward" | "VerticalFarEast" | "HorizontalRotatedFarEast" | "Vertical"; /** - * Gets the numeric value of the the first paragraph in the range for the `ListFormat` object. + * Specifies the starting character position of the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listValue?: number; - } - /** An interface describing the data returned by calling `fillFormat.toJSON()`. */ - interface FillFormatData { + start?: number; /** - * Returns a `ColorFormat` object that represents the background color for the fill. + * Returns the number of characters in the story that contains the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - backgroundColor?: Word.Interfaces.ColorFormatData; + storyLength?: number; /** - * Returns a `ColorFormat` object that represents the foreground color for the fill. + * Returns the story type for the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - foregroundColor?: Word.Interfaces.ColorFormatData; + storyType?: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; /** - * Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9. + * Specifies the text in the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gradientAngle?: number; + text?: string; /** - * Gets the gradient color type. + * Returns the selection type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gradientColorType?: Word.GradientColorType | "Mixed" | "OneColor" | "TwoColors" | "PresetColors" | "MultiColor"; + type?: Word.SelectionType | "NoSelection" | "InsertionPoint" | "Normal" | "Frame" | "Column" | "Row" | "Block" | "InlineShape" | "SelectionShape"; + } + /** An interface describing the data returned by calling `rangeScopedCollection.toJSON()`. */ + interface RangeScopedCollectionData { + items?: Word.Interfaces.RangeData[]; + } + /** An interface describing the data returned by calling `bookmark.toJSON()`. */ + interface BookmarkData { /** - * Returns how dark or light a one-color gradient fill is. - A value of 0 means that black is mixed in with the shape's foreground color to form the gradient. - A value of 1 means that white is mixed in. - Values between 0 and 1 mean that a darker or lighter shade of the foreground color is mixed in. + * Returns a `Range` object that represents the portion of the document that's contained in the `Bookmark` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gradientDegree?: number; + range?: Word.Interfaces.RangeData; /** - * Returns the gradient style for the fill. + * Specifies the ending character position of the bookmark. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gradientStyle?: Word.GradientStyle | "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter"; + end?: number; /** - * Returns the gradient variant for the fill as an integer value from 1 to 4 for most gradient fills. + * Returns `true` if the bookmark is a table column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gradientVariant?: number; + isColumn?: boolean; /** - * Specifies if the object, or the formatting applied to it, is visible. + * Returns `true` if the bookmark is empty. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + isEmpty?: boolean; /** - * Returns a `PatternType` value that represents the pattern applied to the fill or line. + * Returns the name of the `Bookmark` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pattern?: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"; + name?: string; /** - * Returns the preset gradient type for the fill. + * Specifies the starting character position of the bookmark. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetGradientType?: Word.PresetGradientType | "Mixed" | "EarlySunset" | "LateSunset" | "Nightfall" | "Daybreak" | "Horizon" | "Desert" | "Ocean" | "CalmWater" | "Fire" | "Fog" | "Moss" | "Peacock" | "Wheat" | "Parchment" | "Mahogany" | "Rainbow" | "RainbowII" | "Gold" | "GoldII" | "Brass" | "Chrome" | "ChromeII" | "Silver" | "Sapphire"; + start?: number; /** - * Gets the preset texture. + * Returns the story type for the bookmark. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetTexture?: Word.PresetTexture | "Mixed" | "Papyrus" | "Canvas" | "Denim" | "WovenMat" | "WaterDroplets" | "PaperBag" | "FishFossil" | "Sand" | "GreenMarble" | "WhiteMarble" | "BrownMarble" | "Granite" | "Newsprint" | "RecycledPaper" | "Parchment" | "Stationery" | "BlueTissuePaper" | "PinkTissuePaper" | "PurpleMesh" | "Bouquet" | "Cork" | "Walnut" | "Oak" | "MediumWood"; + storyType?: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; + } + /** An interface describing the data returned by calling `bookmarkCollection.toJSON()`. */ + interface BookmarkCollectionData { + items?: Word.Interfaces.BookmarkData[]; + } + /** An interface describing the data returned by calling `index.toJSON()`. */ + interface IndexData { /** - * Specifies whether the fill rotates with the shape. + * Returns a `Range` object that represents the portion of the document that is contained within the index. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotateWithObject?: boolean; + range?: Word.Interfaces.RangeData; /** - * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. + * Gets a value that represents how Microsoft Word classifies the first character of entries in the index. + See `IndexFilter` for available values. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureAlignment?: Word.TextureAlignment | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "Center" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; + filter?: Word.IndexFilter | "None" | "Aiueo" | "Akasatana" | "Chosung" | "Low" | "Medium" | "Full"; /** - * Specifies the horizontal scaling factor for the texture fill. + * Gets the text between alphabetical groups (entries that start with the same letter) in the index. Corresponds to + the **\h** switch for an {@link https://support.microsoft.com/office/adafcf4a-cb30-43f6-85c7-743da1635d9e | INDEX field}. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureHorizontalScale?: number; + headingSeparator?: Word.HeadingSeparator | "None" | "BlankLine" | "Letter" | "LetterLow" | "LetterFull"; /** - * Returns the name of the custom texture file for the fill. + * Gets a `LanguageId` value that represents the sorting language to use for the index. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureName?: string; + indexLanguage?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; /** - * Specifies the horizontal offset of the texture from the origin in points. + * Gets the number of columns for each page of the index. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureOffsetX?: number; + numberOfColumns?: number; /** - * Specifies the vertical offset of the texture. + * Specifies if page numbers are aligned with the right margin in the index. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureOffsetY?: number; + rightAlignPageNumbers?: boolean; /** - * Specifies whether the texture is tiled. + * Gets if the index contains separate headings for accented letters (for example, words that begin with "À" are under + one heading and words that begin with "A" are under another). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureTile?: boolean; + separateAccentedLetterHeadings?: boolean; /** - * Returns the texture type for the fill. + * Specifies the sorting criteria for the index. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureType?: Word.TextureType | "Mixed" | "Preset" | "UserDefined"; + sortBy?: Word.IndexSortBy | "Stroke" | "Syllable"; /** - * Specifies the vertical scaling factor for the texture fill as a value between 0.0 and 1.0. + * Specifies the leader character between entries in the index and their associated page numbers. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureVerticalScale?: number; + tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; /** - * Specifies the degree of transparency of the fill for a shape as a value between 0.0 (opaque) and 1.0 (clear). + * Gets the index type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency?: number; + type?: Word.IndexType | "Indent" | "Runin"; + } + /** An interface describing the data returned by calling `indexCollection.toJSON()`. */ + interface IndexCollectionData { + items?: Word.Interfaces.IndexData[]; + } + /** An interface describing the data returned by calling `listTemplateCollection.toJSON()`. */ + interface ListTemplateCollectionData { + items?: Word.Interfaces.ListTemplateData[]; + } + /** An interface describing the data returned by calling `listTemplateGallery.toJSON()`. */ + interface ListTemplateGalleryData { + } + /** An interface describing the data returned by calling `listTemplateGalleryCollection.toJSON()`. */ + interface ListTemplateGalleryCollectionData { + items?: Word.Interfaces.ListTemplateGalleryData[]; + } + /** + * Represents a user with permissions to edit authorized portions of a protected (read-only) Word document. To learn more, see {@link https://support.microsoft.com/office/187ed01c-8795-43e1-9fd0-c9fca419dadf | Allow changes to parts of a protected Word document}. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface EditorLoadOptions { /** - * Gets the fill format type. + Specifying `$all` 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 a `Range` object that represents the next range that the editor has permissions to modify. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.FillType | "Mixed" | "Solid" | "Patterned" | "Gradient" | "Textured" | "Background" | "Picture"; - } - /** An interface describing the data returned by calling `glowFormat.toJSON()`. */ - interface GlowFormatData { + nextRange?: Word.Interfaces.RangeLoadOptions; /** - * Returns a `ColorFormat` object that represents the color for a glow effect. + * Gets a `Range` object that represents the portion of the document that's contained in the `Editor` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: Word.Interfaces.ColorFormatData; + range?: Word.Interfaces.RangeLoadOptions; /** - * Specifies the length of the radius for a glow effect. + * Gets the identifier for the `Editor` object when the parent document is saved as a webpage. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - radius?: number; + id?: boolean; /** - * Specifies the degree of transparency for the glow effect as a value between 0.0 (opaque) and 1.0 (clear). + * Gets the name of the editor. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency?: number; + name?: boolean; } - /** An interface describing the data returned by calling `lineFormat.toJSON()`. */ - interface LineFormatData { + /** + * Represents the coauthoring conflicts in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface ConflictCollectionLoadOptions { /** - * Gets a `ColorFormat` object that represents the background color for a patterned line. + Specifying `$all` 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 a `Range` object that represents the portion of the document that's contained in the `Conflict` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - backgroundColor?: Word.Interfaces.ColorFormatData; + range?: Word.Interfaces.RangeLoadOptions; /** - * Gets a `ColorFormat` object that represents the foreground color for the line. + * For EACH ITEM in the collection: Gets the `RevisionType` for the `Conflict` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - foregroundColor?: Word.Interfaces.ColorFormatData; + type?: boolean; + } + /** + * Represents a coauthoring conflict in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface ConflictLoadOptions { /** - * Specifies the length of the arrowhead at the beginning of the line. + Specifying `$all` 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 a `Range` object that represents the portion of the document that's contained in the `Conflict` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - beginArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; + range?: Word.Interfaces.RangeLoadOptions; /** - * Specifies the style of the arrowhead at the beginning of the line. + * Gets the `RevisionType` for the `Conflict` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - beginArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; + type?: boolean; + } + /** + * Represents an annotation wrapper around critique displayed in the document. + * + * @remarks + * [Api set: WordApi 1.7] + */ + interface CritiqueAnnotationLoadOptions { /** - * Specifies the width of the arrowhead at the beginning of the line. + Specifying `$all` 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 range of text that is annotated. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - beginArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; + range?: Word.Interfaces.RangeLoadOptions; /** - * Specifies the dash style for the line. + * Gets the critique that was passed when the annotation was inserted. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - dashStyle?: Word.LineDashStyle | "Mixed" | "Solid" | "SquareDot" | "RoundDot" | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "SysDash" | "SysDot" | "SysDashDot"; + critique?: boolean; + } + /** + * Represents an annotation attached to a paragraph. + * + * @remarks + * [Api set: WordApi 1.7] + */ + interface AnnotationLoadOptions { /** - * Specifies the length of the arrowhead at the end of the line. + Specifying `$all` 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 critique annotation object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - endArrowheadLength?: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"; + critiqueAnnotation?: Word.Interfaces.CritiqueAnnotationLoadOptions; /** - * Specifies the style of the arrowhead at the end of the line. + * Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - endArrowheadStyle?: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"; + id?: boolean; /** - * Specifies the width of the arrowhead at the end of the line. + * Gets the state of the annotation. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - endArrowheadWidth?: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"; + state?: boolean; + } + /** + * Contains a collection of {@link Word.Annotation} objects. + * + * @remarks + * [Api set: WordApi 1.7] + */ + interface AnnotationCollectionLoadOptions { /** - * Specifies if to draw lines inside a shape. + Specifying `$all` 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 critique annotation object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - insetPen?: boolean; + critiqueAnnotation?: Word.Interfaces.CritiqueAnnotationLoadOptions; /** - * Specifies if the object, or the formatting applied to it, is visible. + * For EACH ITEM in the collection: Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - isVisible?: boolean; + id?: boolean; /** - * Specifies the pattern applied to the line. + * For EACH ITEM in the collection: Gets the state of the annotation. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - pattern?: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"; + state?: boolean; + } + /** + * Represents the application object. + * + * @remarks + * [Api set: WordApi 1.3] + */ + interface ApplicationLoadOptions { /** - * Specifies the line format style. + Specifying `$all` 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 `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - style?: Word.LineFormatStyle | "Mixed" | "Single" | "ThinThin" | "ThinThick" | "ThickThin" | "ThickBetweenThin"; + bibliography?: Word.Interfaces.BibliographyLoadOptions; /** - * Specifies the degree of transparency of the line as a value between 0.0 (opaque) and 1.0 (clear). + * Specifies if Microsoft Word automatically detects the language you are using as you type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency?: number; + checkLanguage?: boolean; /** - * Specifies the thickness of the line in points. + * Gets a `LanguageId` value that represents the language selected for the Microsoft Word user interface. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - weight?: number; + language?: boolean; } - /** An interface describing the data returned by calling `reflectionFormat.toJSON()`. */ - interface ReflectionFormatData { + /** + * Represents the body of a document or a section. + * + * @remarks + * [Api set: WordApi 1.1] + */ + interface BodyLoadOptions { /** - * Specifies the degree of blur effect applied to the `ReflectionFormat` object as a value between 0.0 and 100.0. + Specifying `$all` 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 text format of the body. Use this to get and set font name, size, color and other properties. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - blur?: number; + font?: Word.Interfaces.FontLoadOptions; /** - * Specifies the amount of separation, in points, of the reflected image from the shape. + * Gets the parent body of the body. For example, a table cell body's parent body could be a header. Throws an `ItemNotFound` error if there isn't a parent body. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - offset?: number; + parentBody?: Word.Interfaces.BodyLoadOptions; /** - * Specifies the size of the reflection as a percentage of the reflected shape from 0 to 100. + * Gets the parent body of the body. For example, a table cell body's parent body could be a header. If there isn't a parent body, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - size?: number; + parentBodyOrNullObject?: Word.Interfaces.BodyLoadOptions; /** - * Specifies the degree of transparency for the reflection effect as a value between 0.0 (opaque) and 1.0 (clear). + * Gets the content control that contains the body. Throws an `ItemNotFound` error if there isn't a parent content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - transparency?: number; + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Specifies a `ReflectionType` value that represents the type and direction of the lighting for a shape reflection. + * Gets the content control that contains the body. If there isn't a parent content control, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - type?: Word.ReflectionType | "Mixed" | "None" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9"; - } - /** An interface describing the data returned by calling `colorFormat.toJSON()`. */ - interface ColorFormatData { + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Specifies the brightness of a specified shape color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. + * Gets the parent section of the body. Throws an `ItemNotFound` error if there isn't a parent section. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - brightness?: number; + parentSection?: Word.Interfaces.SectionLoadOptions; /** - * Specifies the theme color for a color format. + * Gets the parent section of the body. If there isn't a parent section, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - objectThemeColor?: Word.ThemeColorIndex | "NotThemeColor" | "MainDark1" | "MainLight1" | "MainDark2" | "MainLight2" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Hyperlink" | "HyperlinkFollowed" | "Background1" | "Text1" | "Background2" | "Text2"; + parentSectionOrNullObject?: Word.Interfaces.SectionLoadOptions; /** - * Specifies the red-green-blue (RGB) value of the specified color. You can provide the value in the '#RRGGBB' format. + * Specifies the style name for the body. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - rgb?: string; + style?: boolean; /** - * Specifies the lightening or darkening of a specified shape's color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. + * Specifies the built-in style name for the body. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - tintAndShade?: number; + styleBuiltIn?: boolean; /** - * Returns the shape color type. + * Gets the text of the body. Use the insertText method to insert text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - type?: Word.ColorType | "rgb" | "scheme"; + text?: boolean; + /** + * Gets the type of the body. The type can be 'MainDoc', 'Section', 'Header', 'Footer', or 'TableCell'. Additional types ‘Footnote’, ‘Endnote’, and ‘NoteItem’ are supported in WordApiOnline 1.1 and later. + * + * @remarks + * [Api set: WordApi 1.3] + */ + type?: boolean; } - /** An interface describing the data returned by calling `shadowFormat.toJSON()`. */ - interface ShadowFormatData { + /** + * Represents the Border object for text, a paragraph, or a table. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + interface BorderLoadOptions { /** - * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. + Specifying `$all` 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 color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - foregroundColor?: Word.Interfaces.ColorFormatData; + color?: boolean; /** - * Specifies the blur level for a shadow format as a value between 0.0 and 100.0. + * Gets the location of the border. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - blur?: number; + location?: boolean; /** - * Specifies whether the object or the formatting applied to it is visible. + * Specifies the border type for the border. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - isVisible?: boolean; + type?: boolean; /** - * Specifies `true` if the shadow of the shape appears filled in and is obscured by the shape, even if the shape has no fill, - `false` if the shadow has no fill and the outline of the shadow is visible through the shape if the shape has no fill. + * Specifies whether the border is visible. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - obscured?: boolean; + visible?: boolean; /** - * Specifies the horizontal offset (in points) of the shadow from the shape. - A positive value offsets the shadow to the right of the shape; a negative value offsets it to the left. + * Specifies the width for the border. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - offsetX?: number; + width?: boolean; + } + /** + * Represents the `BorderUniversal` object, which manages borders for a range, paragraph, table, or frame. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface BorderUniversalLoadOptions { /** - * Specifies the vertical offset (in points) of the shadow from the shape. - A positive value offsets the shadow to the top of the shape; a negative value offsets it to the bottom. + Specifying `$all` 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 graphical page-border design for the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - offsetY?: number; + artStyle?: boolean; /** - * Specifies whether to rotate the shadow when rotating the shape. + * Specifies the width (in points) of the graphical page border specified in the `artStyle` property. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotateWithShape?: boolean; + artWidth?: boolean; /** - * Specifies the width of the shadow. + * Specifies the color for the `BorderUniversal` object. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - size?: number; + color?: boolean; /** - * Specifies the type of shadow formatting to apply to a shape. + * Specifies the color for the `BorderUniversal` or {@link Word.Font} object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - style?: Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow"; + colorIndex?: boolean; /** - * Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear). + * Returns `true` if an inside border can be applied to the specified object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency?: number; + inside?: boolean; /** - * Specifies the shape shadow type. + * Specifies whether the border is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.ShadowType | "Mixed" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9" | "Type10" | "Type11" | "Type12" | "Type13" | "Type14" | "Type15" | "Type16" | "Type17" | "Type18" | "Type19" | "Type20" | "Type21" | "Type22" | "Type23" | "Type24" | "Type25" | "Type26" | "Type27" | "Type28" | "Type29" | "Type30" | "Type31" | "Type32" | "Type33" | "Type34" | "Type35" | "Type36" | "Type37" | "Type38" | "Type39" | "Type40" | "Type41" | "Type42" | "Type43"; - } - /** An interface describing the data returned by calling `threeDimensionalFormat.toJSON()`. */ - interface ThreeDimensionalFormatData { + isVisible?: boolean; /** - * Returns a `ColorFormat` object that represents color of the contour of a shape. + * Specifies the line style of the border. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contourColor?: Word.Interfaces.ColorFormatData; + lineStyle?: boolean; /** - * Returns a `ColorFormat` object that represents the color of the shape's extrusion. + * Specifies the line width of an object's border. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - extrusionColor?: Word.Interfaces.ColorFormatData; + lineWidth?: boolean; + } + /** + * Represents the collection of border styles. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + interface BorderCollectionLoadOptions { /** - * Specifies the depth of the bottom bevel. + Specifying `$all` 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 color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - bevelBottomDepth?: number; + color?: boolean; /** - * Specifies the inset size for the bottom bevel. + * For EACH ITEM in the collection: Gets the location of the border. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - bevelBottomInset?: number; + location?: boolean; /** - * Specifies a `BevelType` value that represents the bevel type for the bottom bevel. + * For EACH ITEM in the collection: Specifies the border type for the border. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - bevelBottomType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; + type?: boolean; /** - * Specifies the depth of the top bevel. + * For EACH ITEM in the collection: Specifies whether the border is visible. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - bevelTopDepth?: number; + visible?: boolean; /** - * Specifies the inset size for the top bevel. + * For EACH ITEM in the collection: Specifies the width for the border. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - bevelTopInset?: number; + width?: boolean; + } + /** + * Represents the collection of {@link Word.BorderUniversal} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface BorderUniversalCollectionLoadOptions { /** - * Specifies a `BevelType` value that represents the bevel type for the top bevel. + Specifying `$all` 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 graphical page-border design for the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelTopType?: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"; + artStyle?: boolean; /** - * Specifies the width of the contour of a shape. + * For EACH ITEM in the collection: Specifies the width (in points) of the graphical page border specified in the `artStyle` property. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contourWidth?: number; + artWidth?: boolean; /** - * Specifies the depth of the shape's extrusion. + * For EACH ITEM in the collection: Specifies the color for the `BorderUniversal` object. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - depth?: number; + color?: boolean; /** - * Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion) - and automatically changes when the shape's fill changes, or whether the extrusion color is independent of the shape's fill. + * For EACH ITEM in the collection: Specifies the color for the `BorderUniversal` or {@link Word.Font} object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - extrusionColorType?: Word.ExtrusionColorType | "mixed" | "automatic" | "custom"; + colorIndex?: boolean; /** - * Specifies the amount of perspective for a shape. + * For EACH ITEM in the collection: Returns `true` if an inside border can be applied to the specified object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fieldOfView?: number; + inside?: boolean; /** - * Specifies `true` if the extrusion appears in perspective — that is, if the walls of the extrusion narrow toward a vanishing point, - `false` if the extrusion is a parallel, or orthographic, projection — that is, if the walls don't narrow toward a vanishing point. + * For EACH ITEM in the collection: Specifies whether the border is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isPerspective?: boolean; + isVisible?: boolean; /** - * Specifies if the specified object, or the formatting applied to it, is visible. + * For EACH ITEM in the collection: Specifies the line style of the border. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + lineStyle?: boolean; /** - * Specifies the angle of the lighting. + * For EACH ITEM in the collection: Specifies the line width of an object's border. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lightAngle?: number; + lineWidth?: boolean; + } + /** + * Represents a break in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface BreakLoadOptions { + /** + Specifying `$all` 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 `PresetCamera` value that represents the camera presets. + * Returns a `Range` object that represents the portion of the document that's contained in the break. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetCamera?: Word.PresetCamera | "Mixed" | "LegacyObliqueTopLeft" | "LegacyObliqueTop" | "LegacyObliqueTopRight" | "LegacyObliqueLeft" | "LegacyObliqueFront" | "LegacyObliqueRight" | "LegacyObliqueBottomLeft" | "LegacyObliqueBottom" | "LegacyObliqueBottomRight" | "LegacyPerspectiveTopLeft" | "LegacyPerspectiveTop" | "LegacyPerspectiveTopRight" | "LegacyPerspectiveLeft" | "LegacyPerspectiveFront" | "LegacyPerspectiveRight" | "LegacyPerspectiveBottomLeft" | "LegacyPerspectiveBottom" | "LegacyPerspectiveBottomRight" | "OrthographicFront" | "IsometricTopUp" | "IsometricTopDown" | "IsometricBottomUp" | "IsometricBottomDown" | "IsometricLeftUp" | "IsometricLeftDown" | "IsometricRightUp" | "IsometricRightDown" | "IsometricOffAxis1Left" | "IsometricOffAxis1Right" | "IsometricOffAxis1Top" | "IsometricOffAxis2Left" | "IsometricOffAxis2Right" | "IsometricOffAxis2Top" | "IsometricOffAxis3Left" | "IsometricOffAxis3Right" | "IsometricOffAxis3Bottom" | "IsometricOffAxis4Left" | "IsometricOffAxis4Right" | "IsometricOffAxis4Bottom" | "ObliqueTopLeft" | "ObliqueTop" | "ObliqueTopRight" | "ObliqueLeft" | "ObliqueRight" | "ObliqueBottomLeft" | "ObliqueBottom" | "ObliqueBottomRight" | "PerspectiveFront" | "PerspectiveLeft" | "PerspectiveRight" | "PerspectiveAbove" | "PerspectiveBelow" | "PerspectiveAboveLeftFacing" | "PerspectiveAboveRightFacing" | "PerspectiveContrastingLeftFacing" | "PerspectiveContrastingRightFacing" | "PerspectiveHeroicLeftFacing" | "PerspectiveHeroicRightFacing" | "PerspectiveHeroicExtremeLeftFacing" | "PerspectiveHeroicExtremeRightFacing" | "PerspectiveRelaxed" | "PerspectiveRelaxedModerately"; + range?: Word.Interfaces.RangeLoadOptions; /** - * Returns the direction taken by the extrusion's sweep path leading away from the extruded shape (the front face of the extrusion). + * Returns the page number on which the break occurs. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetExtrusionDirection?: Word.PresetExtrusionDirection | "Mixed" | "BottomRight" | "Bottom" | "BottomLeft" | "Right" | "None" | "Left" | "TopRight" | "Top" | "TopLeft"; + pageIndex?: boolean; + } + /** + * Contains a collection of {@link Word.Break} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface BreakCollectionLoadOptions { /** - * Specifies a `LightRigType` value that represents the lighting preset. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ - presetLighting?: Word.LightRigType | "Mixed" | "LegacyFlat1" | "LegacyFlat2" | "LegacyFlat3" | "LegacyFlat4" | "LegacyNormal1" | "LegacyNormal2" | "LegacyNormal3" | "LegacyNormal4" | "LegacyHarsh1" | "LegacyHarsh2" | "LegacyHarsh3" | "LegacyHarsh4" | "ThreePoint" | "Balanced" | "Soft" | "Harsh" | "Flood" | "Contrasting" | "Morning" | "Sunrise" | "Sunset" | "Chilly" | "Freezing" | "Flat" | "TwoPoint" | "Glow" | "BrightRoom"; + $all?: boolean; /** - * Specifies the position of the light source relative to the extrusion. + * For EACH ITEM in the collection: Returns a `Range` object that represents the portion of the document that's contained in the break. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetLightingDirection?: Word.PresetLightingDirection | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "None" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"; + range?: Word.Interfaces.RangeLoadOptions; /** - * Specifies the intensity of the extrusion lighting. + * For EACH ITEM in the collection: Returns the page number on which the break occurs. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetLightingSoftness?: Word.PresetLightingSoftness | "Mixed" | "Dim" | "Normal" | "Bright"; + pageIndex?: boolean; + } + /** + * Represents a building block in a template. A building block is pre-built content, similar to autotext, that may contain text, images, and formatting. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface BuildingBlockLoadOptions { /** - * Specifies the extrusion surface material. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ - presetMaterial?: Word.PresetMaterial | "Mixed" | "Matte" | "Plastic" | "Metal" | "WireFrame" | "Matte2" | "Plastic2" | "Metal2" | "WarmMatte" | "TranslucentPowder" | "Powder" | "DarkEdge" | "SoftEdge" | "Clear" | "Flat" | "SoftMetal"; + $all?: boolean; /** - * Returns the preset extrusion format. + * Returns a `BuildingBlockCategory` object that represents the category for the building block. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetThreeDimensionalFormat?: Word.PresetThreeDimensionalFormat | "Mixed" | "Format1" | "Format2" | "Format3" | "Format4" | "Format5" | "Format6" | "Format7" | "Format8" | "Format9" | "Format10" | "Format11" | "Format12" | "Format13" | "Format14" | "Format15" | "Format16" | "Format17" | "Format18" | "Format19" | "Format20"; + category?: Word.Interfaces.BuildingBlockCategoryLoadOptions; /** - * Specifies whether text on a shape rotates with shape. `true` rotates the text. + * Returns a `BuildingBlockTypeItem` object that represents the type for the building block. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - projectText?: boolean; + type?: Word.Interfaces.BuildingBlockTypeItemLoadOptions; /** - * Specifies the rotation of the extruded shape around the x-axis in degrees. + * Specifies the description for the building block. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotationX?: number; + description?: boolean; /** - * Specifies the rotation of the extruded shape around the y-axis in degrees. + * Returns the internal identification number for the building block. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotationY?: number; + id?: boolean; /** - * Specifies the z-axis rotation of the camera. + * Returns the position of this building block in a collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotationZ?: number; + index?: boolean; /** - * Specifies the position on the z-axis for the shape. + * Specifies a `DocPartInsertType` value that represents how to insert the contents of the building block into the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - z?: number; - } - /** An interface describing the data returned by calling `bibliography.toJSON()`. */ - interface BibliographyData { + insertType?: boolean; /** - * Returns a `SourceCollection` object that represents all the sources contained in the bibliography. + * Specifies the name of the building block. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sources?: Word.Interfaces.SourceData[]; + name?: boolean; /** - * Specifies the name of the active style to use for the bibliography. + * Specifies the contents of the building block. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bibliographyStyle?: string; - } - /** An interface describing the data returned by calling `sourceCollection.toJSON()`. */ - interface SourceCollectionData { - items?: Word.Interfaces.SourceData[]; + value?: boolean; } - /** An interface describing the data returned by calling `source.toJSON()`. */ - interface SourceData { + /** + * Represents a category of building blocks in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface BuildingBlockCategoryLoadOptions { /** - * Gets if the `Source` object has been cited in the document. + Specifying `$all` 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 `BuildingBlockTypeItem` object that represents the type of building block for the building block category. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isCited?: boolean; + type?: Word.Interfaces.BuildingBlockTypeItemLoadOptions; /** - * Gets the tag of the source. + * Returns the position of the `BuildingBlockCategory` object in a collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: string; + index?: boolean; /** - * Gets the XML representation of the source. + * Returns the name of the `BuildingBlockCategory` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xml?: string; + name?: boolean; } - /** An interface describing the data returned by calling `pageSetup.toJSON()`. */ - interface PageSetupData { + /** + * Represents a type of building block in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface BuildingBlockTypeItemLoadOptions { /** - * Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object. + Specifying `$all` 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 position of an item in a collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lineNumbering?: Word.Interfaces.LineNumberingData; + index?: boolean; /** - * Gets a `TextColumnCollection` object that represents the set of text columns for the `PageSetup` object. + * Returns the localized name of a building block type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textColumns?: Word.Interfaces.TextColumnData[]; + name?: boolean; + } + /** + * The data specific to content controls of type CheckBox. + * + * @remarks + * [Api set: WordApi 1.7] + */ + interface CheckboxContentControlLoadOptions { /** - * Specifies whether Microsoft Word prints the document as a booklet. + Specifying `$all` 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 current state of the checkbox. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - bookFoldPrinting?: boolean; + isChecked?: boolean; + } + /** + * Represents a coauthoring lock in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface CoauthoringLockLoadOptions { /** - * Specifies the number of pages for each booklet. + Specifying `$all` 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 owner of the lock. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bookFoldPrintingSheets?: number; + owner?: Word.Interfaces.CoauthorLoadOptions; /** - * Specifies if Microsoft Word reverses the printing order for book fold printing of bidirectional or Asian language documents. + * Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringLock` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bookFoldReversePrinting?: boolean; + range?: Word.Interfaces.RangeLoadOptions; /** - * Specifies the distance (in points) between the bottom edge of the page and the bottom boundary of the body text. + * Gets a `CoauthoringLockType` value that represents the lock type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bottomMargin?: number; + type?: boolean; + } + /** + * Represents a collection of coauthoring locks in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface CoauthoringLockCollectionLoadOptions { /** - * Specifies the number of characters per line in the document grid. + Specifying `$all` 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 owner of the lock. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - charsLine?: number; + owner?: Word.Interfaces.CoauthorLoadOptions; /** - * Specifies whether the first page has a different header and footer. + * For EACH ITEM in the collection: Gets a `Range` object that represents the portion of the document that's contained in the `CoauthoringLock` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - differentFirstPageHeaderFooter?: boolean; + range?: Word.Interfaces.RangeLoadOptions; /** - * Specifies the distance between the footer and the bottom of the page in points. + * For EACH ITEM in the collection: Gets a `CoauthoringLockType` value that represents the lock type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footerDistance?: number; + type?: boolean; + } + /** + * Represents a coauthor in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface CoauthorLoadOptions { /** - * Specifies the amount (in points) of extra margin space added to each page in a document or section for binding. + Specifying `$all` 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 email address of the coauthor. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gutter?: number; + emailAddress?: boolean; /** - * Specifies on which side the gutter appears in a document. + * Gets the unique identifier for the `Coauthor` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gutterPosition?: Word.GutterPosition | "Left" | "Right" | "Top"; + id?: boolean; /** - * Specifies whether Microsoft Word uses gutters for the current document based on a right-to-left language or a left-to-right language. + * Gets whether this author represents the current user. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gutterStyle?: Word.GutterStyle | "Bidirectional" | "Latin"; + isMe?: boolean; /** - * Specifies the distance between the header and the top of the page in points. + * Gets the display name of the coauthor. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - headerDistance?: number; + name?: boolean; + } + /** + * Contains a collection of {@link Word.Coauthor} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface CoauthorCollectionLoadOptions { /** - * Specifies the layout mode for the current document. + Specifying `$all` 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 email address of the coauthor. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - layoutMode?: Word.LayoutMode | "Default" | "Grid" | "LineGrid" | "Genko"; + emailAddress?: boolean; /** - * Specifies the distance (in points) between the left edge of the page and the left boundary of the body text. + * For EACH ITEM in the collection: Gets the unique identifier for the `Coauthor` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - leftMargin?: number; + id?: boolean; /** - * Specifies the number of lines per page in the document grid. + * For EACH ITEM in the collection: Gets whether this author represents the current user. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - linesPage?: number; + isMe?: boolean; /** - * Specifies if the inside and outside margins of facing pages are the same width. + * For EACH ITEM in the collection: Gets the display name of the coauthor. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mirrorMargins?: boolean; + name?: boolean; + } + /** + * Represents the `Coauthoring` object. This tracks the updates, changes, conflicts, and other interactions in the document done through coauthoring. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface CoauthoringLoadOptions { /** - * Specifies whether odd and even pages have different headers and footers. + Specifying `$all` 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 a `Coauthor` object that represents the current user. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - oddAndEvenPagesHeaderFooter?: boolean; + me?: Word.Interfaces.CoauthorLoadOptions; /** - * Specifies the orientation of the page. + * Gets whether this document can be coauthored. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - orientation?: Word.PageOrientation | "Portrait" | "Landscape"; + canCoauthor?: boolean; /** - * Specifies the page height in points. + * Gets whether the document can be automatically merged. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageHeight?: number; + canMerge?: boolean; /** - * Specifies the page width in points. + * Gets whether the document has pending updates that have not been accepted. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageWidth?: number; + pendingUpdates?: boolean; + } + /** + * Represents a coauthoring update in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface CoauthoringUpdateLoadOptions { /** - * Specifies the paper size of the page. + Specifying `$all` 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 a `Range` object that represents the portion of the document that's contained in the `CoauthoringUpdate` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - paperSize?: Word.PaperSize | "Size10x14" | "Size11x17" | "Letter" | "LetterSmall" | "Legal" | "Executive" | "A3" | "A4" | "A4Small" | "A5" | "B4" | "B5" | "CSheet" | "DSheet" | "ESheet" | "FanfoldLegalGerman" | "FanfoldStdGerman" | "FanfoldUS" | "Folio" | "Ledger" | "Note" | "Quarto" | "Statement" | "Tabloid" | "Envelope9" | "Envelope10" | "Envelope11" | "Envelope12" | "Envelope14" | "EnvelopeB4" | "EnvelopeB5" | "EnvelopeB6" | "EnvelopeC3" | "EnvelopeC4" | "EnvelopeC5" | "EnvelopeC6" | "EnvelopeC65" | "EnvelopeDL" | "EnvelopeItaly" | "EnvelopeMonarch" | "EnvelopePersonal" | "Custom"; + range?: Word.Interfaces.RangeLoadOptions; + } + /** + * Contains a collection of {@link Word.CoauthoringUpdate} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface CoauthoringUpdateCollectionLoadOptions { /** - * Specifies the distance (in points) between the right edge of the page and the right boundary of the body text. + Specifying `$all` 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 a `Range` object that represents the portion of the document that's contained in the `CoauthoringUpdate` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rightMargin?: number; + range?: Word.Interfaces.RangeLoadOptions; + } + /** + * Represents a comment in the document. + * + * @remarks + * [Api set: WordApi 1.4] + */ + interface CommentLoadOptions { /** - * Specifies the reading order and alignment for the specified sections. + Specifying `$all` 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 comment's content range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - sectionDirection?: Word.SectionDirection | "RightToLeft" | "LeftToRight"; + contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; /** - * Specifies the type of section break for the specified object. + * Gets the email of the comment's author. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - sectionStart?: Word.SectionStart | "Continuous" | "NewColumn" | "NewPage" | "EvenPage" | "OddPage"; + authorEmail?: boolean; /** - * Specifies whether to show the grid. + * Gets the name of the comment's author. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - showGrid?: boolean; + authorName?: boolean; /** - * Specifies if endnotes are printed at the end of the next section that doesn't suppress endnotes. + * Specifies the comment's content as plain text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - suppressEndnotes?: boolean; + content?: boolean; /** - * Specifies the top margin of the page in points. + * Gets the creation date of the comment. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - topMargin?: number; + creationDate?: boolean; /** - * Specifies whether to print two pages per sheet. + * Gets the ID of the comment. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - twoPagesOnOne?: boolean; + id?: boolean; /** - * Specifies the vertical alignment of text on each page in a document or section. + * Specifies the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - verticalAlignment?: Word.PageSetupVerticalAlignment | "Top" | "Center" | "Justify" | "Bottom"; + resolved?: boolean; } - /** An interface describing the data returned by calling `lineNumbering.toJSON()`. */ - interface LineNumberingData { + /** + * Contains a collection of {@link Word.Comment} objects. + * + * @remarks + * [Api set: WordApi 1.4] + */ + interface CommentCollectionLoadOptions { /** - * Specifies the numeric increment for line numbers. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ - countBy?: number; + $all?: boolean; /** - * Specifies the distance (in points) between the right edge of line numbers and the left edge of the document text. + * For EACH ITEM in the collection: Specifies the comment's content range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - distanceFromText?: number; + contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; /** - * Specifies if line numbering is active for the specified document, section, or sections. + * For EACH ITEM in the collection: Gets the email of the comment's author. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - isActive?: boolean; + authorEmail?: boolean; /** - * Specifies the way line numbering runs; that is, whether it starts over at the beginning of a new page or section, or runs continuously. + * For EACH ITEM in the collection: Gets the name of the comment's author. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - restartMode?: Word.NumberingRule | "RestartContinuous" | "RestartSection" | "RestartPage"; + authorName?: boolean; /** - * Specifies the starting line number. + * For EACH ITEM in the collection: Specifies the comment's content as plain text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - startingNumber?: number; - } - /** An interface describing the data returned by calling `textColumnCollection.toJSON()`. */ - interface TextColumnCollectionData { - items?: Word.Interfaces.TextColumnData[]; - } - /** An interface describing the data returned by calling `textColumn.toJSON()`. */ - interface TextColumnData { + content?: boolean; /** - * Specifies the amount of spacing (in points) after the specified paragraph or text column. + * For EACH ITEM in the collection: Gets the creation date of the comment. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - spaceAfter?: number; + creationDate?: boolean; /** - * Specifies the width, in points, of the specified text columns. + * For EACH ITEM in the collection: Gets the ID of the comment. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - width?: number; - } - /** An interface describing the data returned by calling `bookmark.toJSON()`. */ - interface BookmarkData { + id?: boolean; /** - * Returns a `Range` object that represents the portion of the document that's contained in the `Bookmark` object. + * For EACH ITEM in the collection: Specifies the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - range?: Word.Interfaces.RangeData; + resolved?: boolean; + } + /** + * @remarks + * [Api set: WordApi 1.4] + */ + interface CommentContentRangeLoadOptions { /** - * Specifies the ending character position of the bookmark. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ - end?: number; + $all?: boolean; /** - * Returns `true` if the bookmark is a table column. + * Specifies a value that indicates whether the comment text is bold. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - isColumn?: boolean; + bold?: boolean; /** - * Returns `true` if the bookmark is empty. + * Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - isEmpty?: boolean; + hyperlink?: boolean; /** - * Returns the name of the `Bookmark` object. + * Checks whether the range length is zero. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - name?: string; + isEmpty?: boolean; /** - * Specifies the starting character position of the bookmark. + * Specifies a value that indicates whether the comment text is italicized. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - start?: number; + italic?: boolean; /** - * Returns the story type for the bookmark. + * Specifies a value that indicates whether the comment text has a strikethrough. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - storyType?: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice"; - } - /** An interface describing the data returned by calling `bookmarkCollection.toJSON()`. */ - interface BookmarkCollectionData { - items?: Word.Interfaces.BookmarkData[]; - } - /** An interface describing the data returned by calling `index.toJSON()`. */ - interface IndexData { + strikeThrough?: boolean; /** - * Returns a `Range` object that represents the portion of the document that is contained within the index. + * Gets the text of the comment range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - range?: Word.Interfaces.RangeData; + text?: boolean; /** - * Gets a value that represents how Microsoft Word classifies the first character of entries in the index. - See `IndexFilter` for available values. + * Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - filter?: Word.IndexFilter | "None" | "Aiueo" | "Akasatana" | "Chosung" | "Low" | "Medium" | "Full"; + underline?: boolean; + } + /** + * Represents a comment reply in the document. + * + * @remarks + * [Api set: WordApi 1.4] + */ + interface CommentReplyLoadOptions { /** - * Gets the text between alphabetical groups (entries that start with the same letter) in the index. Corresponds to - the **\h** switch for an {@link https://support.microsoft.com/office/adafcf4a-cb30-43f6-85c7-743da1635d9e | INDEX field}. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ - headingSeparator?: Word.HeadingSeparator | "None" | "BlankLine" | "Letter" | "LetterLow" | "LetterFull"; + $all?: boolean; /** - * Gets a `LanguageId` value that represents the sorting language to use for the index. + * Specifies the commentReply's content range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - indexLanguage?: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu"; + contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; /** - * Gets the number of columns for each page of the index. + * Gets the parent comment of this reply. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - numberOfColumns?: number; + parentComment?: Word.Interfaces.CommentLoadOptions; /** - * Specifies if page numbers are aligned with the right margin in the index. + * Gets the email of the comment reply's author. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - rightAlignPageNumbers?: boolean; + authorEmail?: boolean; /** - * Gets if the index contains separate headings for accented letters (for example, words that begin with "À" are under - one heading and words that begin with "A" are under another). + * Gets the name of the comment reply's author. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - separateAccentedLetterHeadings?: boolean; + authorName?: boolean; /** - * Specifies the sorting criteria for the index. + * Specifies the comment reply's content. The string is plain text. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - sortBy?: Word.IndexSortBy | "Stroke" | "Syllable"; + content?: boolean; /** - * Specifies the leader character between entries in the index and their associated page numbers. + * Gets the creation date of the comment reply. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - tabLeader?: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"; + creationDate?: boolean; /** - * Gets the index type. + * Gets the ID of the comment reply. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - type?: Word.IndexType | "Indent" | "Runin"; - } - /** An interface describing the data returned by calling `indexCollection.toJSON()`. */ - interface IndexCollectionData { - items?: Word.Interfaces.IndexData[]; + id?: boolean; } /** - * Represents an annotation wrapper around critique displayed in the document. + * Contains a collection of {@link Word.CommentReply} objects. Represents all comment replies in one comment thread. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi 1.4] */ - interface CritiqueAnnotationLoadOptions { + interface CommentReplyCollectionLoadOptions { /** Specifying `$all` 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 range of text that is annotated. + * For EACH ITEM in the collection: Specifies the commentReply's content range. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi 1.4] */ - range?: Word.Interfaces.RangeLoadOptions; + contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; /** - * Gets the critique that was passed when the annotation was inserted. + * For EACH ITEM in the collection: Gets the parent comment of this reply. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi 1.4] */ - critique?: boolean; - } - /** - * Represents an annotation attached to a paragraph. - * - * @remarks - * [Api set: WordApi 1.7] - */ - interface AnnotationLoadOptions { + parentComment?: Word.Interfaces.CommentLoadOptions; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * For EACH ITEM in the collection: Gets the email of the comment reply's author. + * + * @remarks + * [Api set: WordApi 1.4] */ - $all?: boolean; + authorEmail?: boolean; /** - * Gets the critique annotation object. + * For EACH ITEM in the collection: Gets the name of the comment reply's author. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi 1.4] */ - critiqueAnnotation?: Word.Interfaces.CritiqueAnnotationLoadOptions; + authorName?: boolean; /** - * Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects. + * For EACH ITEM in the collection: Specifies the comment reply's content. The string is plain text. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi 1.4] */ - id?: boolean; + content?: boolean; /** - * Gets the state of the annotation. + * For EACH ITEM in the collection: Gets the creation date of the comment reply. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi 1.4] */ - state?: boolean; + creationDate?: boolean; + /** + * For EACH ITEM in the collection: Gets the ID of the comment reply. + * + * @remarks + * [Api set: WordApi 1.4] + */ + id?: boolean; } /** - * Contains a collection of {@link Word.Annotation} objects. + * Represents special formatting applied to specified areas of a table when the selected table is formatted with a specified table style. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - interface AnnotationCollectionLoadOptions { + interface ConditionalStyleLoadOptions { /** Specifying `$all` 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 critique annotation object. + * Returns a `Font` object that represents the font formatting for the conditional style. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - critiqueAnnotation?: Word.Interfaces.CritiqueAnnotationLoadOptions; + font?: Word.Interfaces.FontLoadOptions; /** - * For EACH ITEM in the collection: Gets the unique identifier, which is meant to be used for easier tracking of Annotation objects. + * Returns a `ParagraphFormat` object that represents the paragraph formatting for the conditional style. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: boolean; + paragraphFormat?: Word.Interfaces.ParagraphFormatLoadOptions; /** - * For EACH ITEM in the collection: Gets the state of the annotation. + * Returns a `ShadingUniversal` object that represents the shading of the conditional style. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - state?: boolean; - } - /** - * Represents the application object. - * - * @remarks - * [Api set: WordApi 1.3] - */ - interface ApplicationLoadOptions { + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * Specifies the amount of space (in points) to add below the contents of a single cell or all the cells in a table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + bottomPadding?: boolean; /** - * Returns a `Bibliography` object that represents the bibliography reference sources stored in Microsoft Word. + * Specifies the amount of space (in points) to add to the left of the contents of a single cell or all the cells in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bibliography?: Word.Interfaces.BibliographyLoadOptions; + leftPadding?: boolean; /** - * Specifies if Microsoft Word automatically detects the language you are using as you type. + * Specifies the amount of space (in points) to add to the right of the contents of a single cell or all the cells in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - checkLanguage?: boolean; + rightPadding?: boolean; /** - * Gets a `LanguageId` value that represents the language selected for the Microsoft Word user interface. + * Specifies the amount of space (in points) to add above the contents of a single cell or all the cells in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - language?: boolean; + topPadding?: boolean; } /** - * Represents the body of a document or a section. + * Represents the XML mapping on a {@link Word.ContentControl} object between custom XML and that content control. An XML mapping is a link between the text in a content control and an XML element in the custom XML data store for this document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - interface BodyLoadOptions { + interface XmlMappingLoadOptions { /** Specifying `$all` 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 text format of the body. Use this to get and set font name, size, color and other properties. + * Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontLoadOptions; + customXmlNode?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Gets the parent body of the body. For example, a table cell body's parent body could be a header. Throws an `ItemNotFound` error if there isn't a parent body. + * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentBody?: Word.Interfaces.BodyLoadOptions; + customXmlPart?: Word.Interfaces.CustomXmlPartLoadOptions; /** - * Gets the parent body of the body. For example, a table cell body's parent body could be a header. If there isn't a parent body, then this method will return 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}. + * Returns whether the content control in the document is mapped to an XML node in the document's XML data store. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentBodyOrNullObject?: Word.Interfaces.BodyLoadOptions; + isMapped?: boolean; /** - * Gets the content control that contains the body. Throws an `ItemNotFound` error if there isn't a parent content control. + * Returns the prefix mappings used to evaluate the XPath for the current XML mapping. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; + prefixMappings?: boolean; /** - * Gets the content control that contains the body. If there isn't a parent content control, then this method will return 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}. + * Returns the XPath for the XML mapping, which evaluates to the currently mapped XML node. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + xpath?: boolean; + } + /** + * Represents a collection of {@link Word.CustomXmlPrefixMapping} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface CustomXmlPrefixMappingCollectionLoadOptions { /** - * Gets the parent section of the body. Throws an `ItemNotFound` error if there isn't a parent section. - * - * @remarks - * [Api set: WordApi 1.3] + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ - parentSection?: Word.Interfaces.SectionLoadOptions; + $all?: boolean; /** - * Gets the parent section of the body. If there isn't a parent section, then this method will return 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}. + * For EACH ITEM in the collection: Gets the unique address identifier for the namespace of the `CustomXmlPrefixMapping` object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentSectionOrNullObject?: Word.Interfaces.SectionLoadOptions; + namespaceUri?: boolean; /** - * Specifies the style name for the body. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * For EACH ITEM in the collection: Gets the prefix for the `CustomXmlPrefixMapping` object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: boolean; + prefix?: boolean; + } + /** + * Represents a `CustomXmlPrefixMapping` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface CustomXmlPrefixMappingLoadOptions { /** - * Specifies the built-in style name for the body. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. - * - * @remarks - * [Api set: WordApi 1.3] + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ - styleBuiltIn?: boolean; + $all?: boolean; /** - * Gets the text of the body. Use the insertText method to insert text. + * Gets the unique address identifier for the namespace of the `CustomXmlPrefixMapping` object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - text?: boolean; + namespaceUri?: boolean; /** - * Gets the type of the body. The type can be 'MainDoc', 'Section', 'Header', 'Footer', or 'TableCell'. Additional types ‘Footnote’, ‘Endnote’, and ‘NoteItem’ are supported in WordApiOnline 1.1 and later. + * Gets the prefix for the `CustomXmlPrefixMapping` object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: boolean; + prefix?: boolean; } /** - * Represents the Border object for text, a paragraph, or a table. + * Represents a schema in a {@link Word.CustomXmlSchemaCollection} object. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - interface BorderLoadOptions { + interface CustomXmlSchemaLoadOptions { /** Specifying `$all` 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 color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - color?: boolean; - /** - * Gets the location of the border. + * Gets the location of the schema on a computer. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ location?: boolean; /** - * Specifies the border type for the border. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - type?: boolean; - /** - * Specifies whether the border is visible. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - visible?: boolean; - /** - * Specifies the width for the border. + * Gets the unique address identifier for the namespace of the `CustomXmlSchema` object. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: boolean; + namespaceUri?: boolean; } /** - * Represents the `BorderUniversal` object, which manages borders for a range, paragraph, table, or frame. + * Represents a collection of {@link Word.CustomXmlSchema} objects attached to a data stream. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface BorderUniversalLoadOptions { + interface CustomXmlSchemaCollectionLoadOptions { /** Specifying `$all` 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 graphical page-border design for the document. + * For EACH ITEM in the collection: Gets the location of the schema on a computer. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - artStyle?: boolean; + location?: boolean; /** - * Specifies the width (in points) of the graphical page border specified in the `artStyle` property. + * For EACH ITEM in the collection: Gets the unique address identifier for the namespace of the `CustomXmlSchema` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - artWidth?: boolean; + namespaceUri?: boolean; + } + /** + * Represents a collection of {@link Word.CustomXmlValidationError} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface CustomXmlValidationErrorCollectionLoadOptions { /** - * Specifies the color for the `BorderUniversal` object. You can provide the value in the '#RRGGBB' format. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ - color?: boolean; + $all?: boolean; /** - * Specifies the color for the `BorderUniversal` or {@link Word.Font} object. + * For EACH ITEM in the collection: Gets the node associated with this `CustomXmlValidationError` object, if any exist.If no nodes exist, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - colorIndex?: boolean; + node?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Returns `true` if an inside border can be applied to the specified object. + * For EACH ITEM in the collection: Gets an integer representing the validation error in the `CustomXmlValidationError` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - inside?: boolean; + errorCode?: boolean; /** - * Specifies whether the border is visible. + * For EACH ITEM in the collection: Gets the name of the error in the `CustomXmlValidationError` object.If no errors exist, the property returns `Nothing` * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + name?: boolean; /** - * Specifies the line style of the border. + * For EACH ITEM in the collection: Gets the text in the `CustomXmlValidationError` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lineStyle?: boolean; + text?: boolean; /** - * Specifies the line width of an object's border. + * For EACH ITEM in the collection: Gets the type of error generated from the `CustomXmlValidationError` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lineWidth?: boolean; + type?: boolean; } /** - * Represents the collection of border styles. + * Represents a single validation error in a {@link Word.CustomXmlValidationErrorCollection} object. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - interface BorderCollectionLoadOptions { + interface CustomXmlValidationErrorLoadOptions { /** Specifying `$all` 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 color for the border. Color is specified in ‘#RRGGBB’ format or by using the color name. + * Gets the node associated with this `CustomXmlValidationError` object, if any exist.If no nodes exist, the property returns `Nothing`. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - color?: boolean; + node?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * For EACH ITEM in the collection: Gets the location of the border. + * Gets an integer representing the validation error in the `CustomXmlValidationError` object. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - location?: boolean; + errorCode?: boolean; /** - * For EACH ITEM in the collection: Specifies the border type for the border. + * Gets the name of the error in the `CustomXmlValidationError` object.If no errors exist, the property returns `Nothing` * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: boolean; + name?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the border is visible. + * Gets the text in the `CustomXmlValidationError` object. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - visible?: boolean; + text?: boolean; /** - * For EACH ITEM in the collection: Specifies the width for the border. + * Gets the type of error generated from the `CustomXmlValidationError` object. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: boolean; + type?: boolean; } /** - * Represents the collection of {@link Word.BorderUniversal} objects. + * Contains a collection of {@link Word.CustomXmlNode} objects representing the XML nodes in a document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface BorderUniversalCollectionLoadOptions { + interface CustomXmlNodeCollectionLoadOptions { /** Specifying `$all` 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 graphical page-border design for the document. + * For EACH ITEM in the collection: Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - artStyle?: boolean; + firstChild?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * For EACH ITEM in the collection: Specifies the width (in points) of the graphical page border specified in the `artStyle` property. + * For EACH ITEM in the collection: Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - artWidth?: boolean; + lastChild?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * For EACH ITEM in the collection: Specifies the color for the `BorderUniversal` object. You can provide the value in the '#RRGGBB' format. + * For EACH ITEM in the collection: Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: boolean; + nextSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * For EACH ITEM in the collection: Specifies the color for the `BorderUniversal` or {@link Word.Font} object. + * For EACH ITEM in the collection: Gets the object representing the part associated with this node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - colorIndex?: boolean; + ownerPart?: Word.Interfaces.CustomXmlPartLoadOptions; /** - * For EACH ITEM in the collection: Returns `true` if an inside border can be applied to the specified object. + * For EACH ITEM in the collection: Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - inside?: boolean; + parentNode?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * For EACH ITEM in the collection: Specifies whether the border is visible. + * For EACH ITEM in the collection: Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + previousSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * For EACH ITEM in the collection: Specifies the line style of the border. + * For EACH ITEM in the collection: Gets the base name of the node without the namespace prefix, if one exists. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lineStyle?: boolean; + baseName?: boolean; /** - * For EACH ITEM in the collection: Specifies the line width of an object's border. + * For EACH ITEM in the collection: Gets the unique address identifier for the namespace of the node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lineWidth?: boolean; - } - /** - * Represents a break in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface BreakLoadOptions { + namespaceUri?: boolean; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * For EACH ITEM in the collection: Gets the type of the current node. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + nodeType?: boolean; /** - * Returns a `Range` object that represents the portion of the document that's contained in the break. + * For EACH ITEM in the collection: Specifies the value of the current node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeLoadOptions; + nodeValue?: boolean; /** - * Returns the page number on which the break occurs. + * For EACH ITEM in the collection: Specifies the text for the current node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageIndex?: boolean; + text?: boolean; + /** + * For EACH ITEM in the collection: Gets a string with the canonicalized XPath for the current node. If the node is no longer in the Document Object Model (DOM), the property returns an error message. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + xpath?: boolean; + /** + * For EACH ITEM in the collection: Gets the XML representation of the current node and its children. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + xml?: boolean; } /** - * Contains a collection of {@link Word.Break} objects. + * Represents an XML node in a tree in the document. The `CustomXmlNode` object is a member of the {@link Word.CustomXmlNodeCollection} object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface BreakCollectionLoadOptions { + interface CustomXmlNodeLoadOptions { /** Specifying `$all` 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 a `Range` object that represents the portion of the document that's contained in the break. + * Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeLoadOptions; + firstChild?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * For EACH ITEM in the collection: Returns the page number on which the break occurs. + * Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageIndex?: boolean; - } - /** - * Represents a building block in a template. A building block is pre-built content, similar to autotext, that may contain text, images, and formatting. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface BuildingBlockLoadOptions { + lastChild?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + nextSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Returns a `BuildingBlockCategory` object that represents the category for the building block. + * Gets the object representing the part associated with this node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - category?: Word.Interfaces.BuildingBlockCategoryLoadOptions; + ownerPart?: Word.Interfaces.CustomXmlPartLoadOptions; /** - * Returns a `BuildingBlockTypeItem` object that represents the type for the building block. + * Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + parentNode?: Word.Interfaces.CustomXmlNodeLoadOptions; + /** + * Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + previousSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; + /** + * Gets the base name of the node without the namespace prefix, if one exists. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.Interfaces.BuildingBlockTypeItemLoadOptions; + baseName?: boolean; /** - * Specifies the description for the building block. + * Gets the unique address identifier for the namespace of the node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - description?: boolean; + namespaceUri?: boolean; /** - * Returns the internal identification number for the building block. + * Gets the type of the current node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: boolean; + nodeType?: boolean; /** - * Returns the position of this building block in a collection. + * Specifies the value of the current node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - index?: boolean; + nodeValue?: boolean; /** - * Specifies a `DocPartInsertType` value that represents how to insert the contents of the building block into the document. + * Specifies the text for the current node. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - insertType?: boolean; + text?: boolean; /** - * Specifies the name of the building block. + * Gets a string with the canonicalized XPath for the current node. If the node is no longer in the Document Object Model (DOM), the property returns an error message. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: boolean; + xpath?: boolean; /** - * Specifies the contents of the building block. + * Gets the XML representation of the current node and its children. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - value?: boolean; + xml?: boolean; } /** - * Represents a category of building blocks in a Word document. + * Represents a content control. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text, plain text, checkbox, dropdown list, and combo box content controls are supported. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - interface BuildingBlockCategoryLoadOptions { + interface ContentControlLoadOptions { /** Specifying `$all` 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 `BuildingBlockTypeItem` object that represents the type of building block for the building block category. + * Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `BuildingBlockGallery`. It's `null` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: Word.Interfaces.BuildingBlockTypeItemLoadOptions; + buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlLoadOptions; /** - * Returns the position of the `BuildingBlockCategory` object in a collection. + * Gets the data of the content control when its type is `CheckBox`. It's `null` otherwise. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.7] */ - index?: boolean; + checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions; /** - * Returns the name of the `BuildingBlockCategory` object. + * Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `DatePicker`. It's `null` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: boolean; - } - /** - * Represents a type of building block in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface BuildingBlockTypeItemLoadOptions { - /** - Specifying `$all` 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; + datePickerContentControl?: Word.Interfaces.DatePickerContentControlLoadOptions; /** - * Returns the position of an item in a collection. + * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - index?: boolean; + font?: Word.Interfaces.FontLoadOptions; /** - * Returns the localized name of a building block type. + * Gets the group-related data if the content control's {@link Word.ContentControlType} is `Group`. It's `null` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: boolean; - } - /** - * The data specific to content controls of type CheckBox. - * - * @remarks - * [Api set: WordApi 1.7] - */ - interface CheckboxContentControlLoadOptions { - /** - Specifying `$all` 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; + groupContentControl?: Word.Interfaces.GroupContentControlLoadOptions; /** - * Specifies the current state of the checkbox. + * Gets the parent body of the content control. * * @remarks - * [Api set: WordApi 1.7] - */ - isChecked?: boolean; - } - /** - * Represents a comment in the document. - * - * @remarks - * [Api set: WordApi 1.4] - */ - interface CommentLoadOptions { - /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * [Api set: WordApi 1.3] */ - $all?: boolean; + parentBody?: Word.Interfaces.BodyLoadOptions; /** - * Specifies the comment's content range. + * Gets the content control that contains the content control. Throws an `ItemNotFound` error if there isn't a parent content control. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the email of the comment's author. + * Gets the content control that contains the content control. If there isn't a parent content control, then this method will return 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: WordApi 1.4] + * [Api set: WordApi 1.3] */ - authorEmail?: boolean; + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the name of the comment's author. + * Gets the table that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - authorName?: boolean; + parentTable?: Word.Interfaces.TableLoadOptions; /** - * Specifies the comment's content as plain text. + * Gets the table cell that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table cell. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - content?: boolean; + parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * Gets the creation date of the comment. + * Gets the table cell that contains the content control. If it isn't contained in a table cell, then this method will return 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: WordApi 1.4] + * [Api set: WordApi 1.3] */ - creationDate?: boolean; + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * Gets the ID of the comment. + * Gets the table that contains the content control. If it isn't contained in a table, then this method will return 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: WordApi 1.4] + * [Api set: WordApi 1.3] */ - id?: boolean; + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * Specifies the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved. + * Gets the picture-related data if the content control's {@link Word.ContentControlType} is `Picture`. It's `null` otherwise. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - resolved?: boolean; - } - /** - * Contains a collection of {@link Word.Comment} objects. - * - * @remarks - * [Api set: WordApi 1.4] - */ - interface CommentCollectionLoadOptions { + pictureContentControl?: Word.Interfaces.PictureContentControlLoadOptions; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `RepeatingSection`. It's `null` otherwise. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlLoadOptions; /** - * For EACH ITEM in the collection: Specifies the comment's content range. + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; + xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; /** - * For EACH ITEM in the collection: Gets the email of the comment's author. + * Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - authorEmail?: boolean; + appearance?: boolean; /** - * For EACH ITEM in the collection: Gets the name of the comment's author. + * Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - authorName?: boolean; + cannotDelete?: boolean; /** - * For EACH ITEM in the collection: Specifies the comment's content as plain text. + * Specifies a value that indicates whether the user can edit the contents of the content control. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - content?: boolean; + cannotEdit?: boolean; /** - * For EACH ITEM in the collection: Gets the creation date of the comment. + * Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - creationDate?: boolean; + color?: boolean; /** - * For EACH ITEM in the collection: Gets the ID of the comment. + * Gets an integer that represents the content control identifier. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ id?: boolean; /** - * For EACH ITEM in the collection: Specifies the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved. + * Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - resolved?: boolean; - } - /** - * @remarks - * [Api set: WordApi 1.4] - */ - interface CommentContentRangeLoadOptions { + placeholderText?: boolean; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. + * + * @remarks + * [Api set: WordApi 1.1] */ - $all?: boolean; + removeWhenEdited?: boolean; /** - * Specifies a value that indicates whether the comment text is bold. + * Specifies the style name for the content control. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - bold?: boolean; + style?: boolean; /** - * Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. + * Specifies the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - hyperlink?: boolean; + styleBuiltIn?: boolean; /** - * Checks whether the range length is zero. + * Gets the content control subtype. The subtype can be 'RichTextInline', 'RichTextParagraphs', 'RichTextTableCell', 'RichTextTableRow' and 'RichTextTable' for rich text content controls, or 'PlainTextInline' and 'PlainTextParagraph' for plain text content controls, or 'CheckBox' for checkbox content controls. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - isEmpty?: boolean; + subtype?: boolean; /** - * Specifies a value that indicates whether the comment text is italicized. + * Specifies a tag to identify a content control. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - italic?: boolean; + tag?: boolean; /** - * Specifies a value that indicates whether the comment text has a strikethrough. + * Gets the text of the content control. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - strikeThrough?: boolean; + text?: boolean; /** - * Gets the text of the comment range. + * Specifies the title for a content control. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - text?: boolean; + title?: boolean; /** - * Specifies a value that indicates the comment text's underline type. 'None' if the comment text isn't underlined. + * Gets the content control type. Only rich text, plain text, and checkbox content controls are supported currently. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - underline?: boolean; + type?: boolean; } /** - * Represents a comment reply in the document. + * Contains a collection of {@link Word.ContentControl} objects. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text, plain text, checkbox, dropdown list, and combo box content controls are supported. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - interface CommentReplyLoadOptions { + interface ContentControlCollectionLoadOptions { /** Specifying `$all` 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 commentReply's content range. + * For EACH ITEM in the collection: Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `BuildingBlockGallery`. It's `null` otherwise. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; + buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlLoadOptions; /** - * Gets the parent comment of this reply. + * For EACH ITEM in the collection: Gets the data of the content control when its type is `CheckBox`. It's `null` otherwise. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.7] */ - parentComment?: Word.Interfaces.CommentLoadOptions; + checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions; /** - * Gets the email of the comment reply's author. + * For EACH ITEM in the collection: Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `DatePicker`. It's `null` otherwise. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - authorEmail?: boolean; + datePickerContentControl?: Word.Interfaces.DatePickerContentControlLoadOptions; /** - * Gets the name of the comment reply's author. + * For EACH ITEM in the collection: Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - authorName?: boolean; + font?: Word.Interfaces.FontLoadOptions; /** - * Specifies the comment reply's content. The string is plain text. + * For EACH ITEM in the collection: Gets the group-related data if the content control's {@link Word.ContentControlType} is `Group`. It's `null` otherwise. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - content?: boolean; + groupContentControl?: Word.Interfaces.GroupContentControlLoadOptions; /** - * Gets the creation date of the comment reply. + * For EACH ITEM in the collection: Gets the parent body of the content control. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - creationDate?: boolean; + parentBody?: Word.Interfaces.BodyLoadOptions; /** - * Gets the ID of the comment reply. + * For EACH ITEM in the collection: Gets the content control that contains the content control. Throws an `ItemNotFound` error if there isn't a parent content control. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - id?: boolean; - } - /** - * Contains a collection of {@link Word.CommentReply} objects. Represents all comment replies in one comment thread. - * - * @remarks - * [Api set: WordApi 1.4] - */ - interface CommentReplyCollectionLoadOptions { + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * For EACH ITEM in the collection: Gets the content control that contains the content control. If there isn't a parent content control, then this method will return 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: WordApi 1.3] */ - $all?: boolean; + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Specifies the commentReply's content range. + * For EACH ITEM in the collection: Gets the table that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - contentRange?: Word.Interfaces.CommentContentRangeLoadOptions; + parentTable?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Gets the parent comment of this reply. + * For EACH ITEM in the collection: Gets the table cell that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table cell. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - parentComment?: Word.Interfaces.CommentLoadOptions; + parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the email of the comment reply's author. + * For EACH ITEM in the collection: Gets the table cell that contains the content control. If it isn't contained in a table cell, then this method will return 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: WordApi 1.4] + * [Api set: WordApi 1.3] */ - authorEmail?: boolean; + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the name of the comment reply's author. + * For EACH ITEM in the collection: Gets the table that contains the content control. If it isn't contained in a table, then this method will return 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: WordApi 1.4] + * [Api set: WordApi 1.3] */ - authorName?: boolean; + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Specifies the comment reply's content. The string is plain text. + * For EACH ITEM in the collection: Gets the picture-related data if the content control's {@link Word.ContentControlType} is `Picture`. It's `null` otherwise. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - content?: boolean; + pictureContentControl?: Word.Interfaces.PictureContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the creation date of the comment reply. + * For EACH ITEM in the collection: Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `RepeatingSection`. It's `null` otherwise. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - creationDate?: boolean; + repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the ID of the comment reply. + * For EACH ITEM in the collection: Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; + /** + * For EACH ITEM in the collection: Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. + * + * @remarks + * [Api set: WordApi 1.1] + */ + appearance?: boolean; + /** + * For EACH ITEM in the collection: Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited. + * + * @remarks + * [Api set: WordApi 1.1] + */ + cannotDelete?: boolean; + /** + * For EACH ITEM in the collection: Specifies a value that indicates whether the user can edit the contents of the content control. + * + * @remarks + * [Api set: WordApi 1.1] + */ + cannotEdit?: boolean; + /** + * For EACH ITEM in the collection: Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. + * + * @remarks + * [Api set: WordApi 1.1] + */ + color?: boolean; + /** + * For EACH ITEM in the collection: Gets an integer that represents the content control identifier. + * + * @remarks + * [Api set: WordApi 1.1] */ id?: boolean; - } - /** - * Represents the XML mapping on a {@link Word.ContentControl} object between custom XML and that content control. An XML mapping is a link between the text in a content control and an XML element in the custom XML data store for this document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface XmlMappingLoadOptions { /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * For EACH ITEM in the collection: Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. + * + * @remarks + * [Api set: WordApi 1.1] */ - $all?: boolean; + placeholderText?: boolean; /** - * Returns a `CustomXmlNode` object that represents the custom XML node in the data store that the content control in the document maps to. + * For EACH ITEM in the collection: Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - customXmlNode?: Word.Interfaces.CustomXmlNodeLoadOptions; + removeWhenEdited?: boolean; /** - * Returns a `CustomXmlPart` object that represents the custom XML part to which the content control in the document maps. + * For EACH ITEM in the collection: Specifies the style name for the content control. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - customXmlPart?: Word.Interfaces.CustomXmlPartLoadOptions; + style?: boolean; /** - * Returns whether the content control in the document is mapped to an XML node in the document's XML data store. + * For EACH ITEM in the collection: Specifies the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isMapped?: boolean; + styleBuiltIn?: boolean; /** - * Returns the prefix mappings used to evaluate the XPath for the current XML mapping. + * For EACH ITEM in the collection: Gets the content control subtype. The subtype can be 'RichTextInline', 'RichTextParagraphs', 'RichTextTableCell', 'RichTextTableRow' and 'RichTextTable' for rich text content controls, or 'PlainTextInline' and 'PlainTextParagraph' for plain text content controls, or 'CheckBox' for checkbox content controls. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - prefixMappings?: boolean; + subtype?: boolean; /** - * Returns the XPath for the XML mapping, which evaluates to the currently mapped XML node. + * For EACH ITEM in the collection: Specifies a tag to identify a content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - xpath?: boolean; - } - /** - * Represents a collection of {@link Word.CustomXmlPrefixMapping} objects. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface CustomXmlPrefixMappingCollectionLoadOptions { + tag?: boolean; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * For EACH ITEM in the collection: Gets the text of the content control. + * + * @remarks + * [Api set: WordApi 1.1] */ - $all?: boolean; + text?: boolean; /** - * For EACH ITEM in the collection: Gets the unique address identifier for the namespace of the `CustomXmlPrefixMapping` object. + * For EACH ITEM in the collection: Specifies the title for a content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - namespaceUri?: boolean; + title?: boolean; /** - * For EACH ITEM in the collection: Gets the prefix for the `CustomXmlPrefixMapping` object. + * For EACH ITEM in the collection: Gets the content control type. Only rich text, plain text, and checkbox content controls are supported currently. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - prefix?: boolean; + type?: boolean; } /** - * Represents a `CustomXmlPrefixMapping` object. + * Represents a list item in a dropdown list or combo box content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - interface CustomXmlPrefixMappingLoadOptions { + interface ContentControlListItemLoadOptions { /** Specifying `$all` 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 address identifier for the namespace of the `CustomXmlPrefixMapping` object. + * Specifies the display text of a list item for a dropdown list or combo box content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - namespaceUri?: boolean; + displayText?: boolean; /** - * Gets the prefix for the `CustomXmlPrefixMapping` object. + * Specifies the index location of a content control list item in the collection of list items. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - prefix?: boolean; + index?: boolean; + /** + * Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + value?: boolean; } /** - * Represents a schema in a {@link Word.CustomXmlSchemaCollection} object. + * Contains a collection of {@link Word.ContentControlListItem} objects that represent the items in a dropdown list or combo box content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - interface CustomXmlSchemaLoadOptions { + interface ContentControlListItemCollectionLoadOptions { /** Specifying `$all` 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 location of the schema on a computer. + * For EACH ITEM in the collection: Specifies the display text of a list item for a dropdown list or combo box content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - location?: boolean; + displayText?: boolean; /** - * Gets the unique address identifier for the namespace of the `CustomXmlSchema` object. + * For EACH ITEM in the collection: Specifies the index location of a content control list item in the collection of list items. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.9] */ - namespaceUri?: boolean; + index?: boolean; + /** + * For EACH ITEM in the collection: Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * + * @remarks + * [Api set: WordApi 1.9] + */ + value?: boolean; } /** - * Represents a collection of {@link Word.CustomXmlSchema} objects attached to a data stream. + * Represents a custom property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - interface CustomXmlSchemaCollectionLoadOptions { + 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; /** - * For EACH ITEM in the collection: Gets the location of the schema on a computer. + * Gets the key of the custom property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - location?: boolean; + key?: boolean; /** - * For EACH ITEM in the collection: Gets the unique address identifier for the namespace of the `CustomXmlSchema` object. + * Gets the value type of the custom property. Possible values are: String, Number, Date, Boolean. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - namespaceUri?: boolean; + type?: boolean; + /** + * Specifies the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). + * + * @remarks + * [Api set: WordApi 1.3] + */ + value?: boolean; } /** - * Represents a collection of {@link Word.CustomXmlValidationError} objects. + * Contains the collection of {@link Word.CustomProperty} objects. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - interface CustomXmlValidationErrorCollectionLoadOptions { + 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: Gets the node associated with this `CustomXmlValidationError` object, if any exist.If no nodes exist, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - node?: Word.Interfaces.CustomXmlNodeLoadOptions; - /** - * For EACH ITEM in the collection: Gets an integer representing the validation error in the `CustomXmlValidationError` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - errorCode?: boolean; - /** - * For EACH ITEM in the collection: Gets the name of the error in the `CustomXmlValidationError` object.If no errors exist, the property returns `Nothing` + * For EACH ITEM in the collection: Gets the key of the custom property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - name?: boolean; + key?: boolean; /** - * For EACH ITEM in the collection: Gets the text in the `CustomXmlValidationError` object. + * For EACH ITEM in the collection: Gets the value type of the custom property. Possible values are: String, Number, Date, Boolean. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - text?: boolean; + type?: boolean; /** - * For EACH ITEM in the collection: Gets the type of error generated from the `CustomXmlValidationError` object. + * For EACH ITEM in the collection: Specifies the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - type?: boolean; + value?: boolean; } /** - * Represents a single validation error in a {@link Word.CustomXmlValidationErrorCollection} object. + * Represents a custom XML part. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - interface CustomXmlValidationErrorLoadOptions { + 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; /** - * Gets the node associated with this `CustomXmlValidationError` object, if any exist.If no nodes exist, the property returns `Nothing`. + * Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - node?: Word.Interfaces.CustomXmlNodeLoadOptions; + documentElement?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * Gets an integer representing the validation error in the `CustomXmlValidationError` object. + * Gets a value that indicates whether the `CustomXmlPart` is built-in. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - errorCode?: boolean; + builtIn?: boolean; /** - * Gets the name of the error in the `CustomXmlValidationError` object.If no errors exist, the property returns `Nothing` + * Gets the ID of the custom XML part. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - name?: boolean; + id?: boolean; /** - * Gets the text in the `CustomXmlValidationError` object. + * Gets the namespace URI of the custom XML part. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - text?: boolean; + namespaceUri?: boolean; /** - * Gets the type of error generated from the `CustomXmlValidationError` object. + * Gets the XML representation of the current `CustomXmlPart` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: boolean; + xml?: boolean; } /** - * Contains a collection of {@link Word.CustomXmlNode} objects representing the XML nodes in a document. + * Contains the collection of {@link Word.CustomXmlPart} objects. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - interface CustomXmlNodeCollectionLoadOptions { + 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: Gets a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - firstChild?: Word.Interfaces.CustomXmlNodeLoadOptions; - /** - * For EACH ITEM in the collection: Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - lastChild?: Word.Interfaces.CustomXmlNodeLoadOptions; - /** - * For EACH ITEM in the collection: Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. + * For EACH ITEM in the collection: Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nextSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; + documentElement?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * For EACH ITEM in the collection: Gets the object representing the part associated with this node. + * For EACH ITEM in the collection: Gets a value that indicates whether the `CustomXmlPart` is built-in. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - ownerPart?: Word.Interfaces.CustomXmlPartLoadOptions; + builtIn?: boolean; /** - * For EACH ITEM in the collection: Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. + * For EACH ITEM in the collection: Gets the ID of the custom XML part. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - parentNode?: Word.Interfaces.CustomXmlNodeLoadOptions; + id?: boolean; /** - * For EACH ITEM in the collection: Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. + * For EACH ITEM in the collection: Gets the namespace URI of the custom XML part. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - previousSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; + namespaceUri?: boolean; /** - * For EACH ITEM in the collection: Gets the base name of the node without the namespace prefix, if one exists. + * For EACH ITEM in the collection: Gets the XML representation of the current `CustomXmlPart` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - baseName?: boolean; + xml?: boolean; + } + /** + * Contains the collection of {@link Word.CustomXmlPart} objects with a specific namespace. + * + * @remarks + * [Api set: WordApi 1.4] + */ + interface CustomXmlPartScopedCollectionLoadOptions { /** - * For EACH ITEM in the collection: Gets the unique address identifier for the namespace of the node. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ - namespaceUri?: boolean; + $all?: boolean; /** - * For EACH ITEM in the collection: Gets the type of the current node. + * For EACH ITEM in the collection: Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nodeType?: boolean; + documentElement?: Word.Interfaces.CustomXmlNodeLoadOptions; /** - * For EACH ITEM in the collection: Specifies the value of the current node. + * For EACH ITEM in the collection: Gets a value that indicates whether the `CustomXmlPart` is built-in. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nodeValue?: boolean; + builtIn?: boolean; /** - * For EACH ITEM in the collection: Specifies the text for the current node. + * For EACH ITEM in the collection: Gets the ID of the custom XML part. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - text?: boolean; + id?: boolean; /** - * For EACH ITEM in the collection: Gets a string with the canonicalized XPath for the current node. If the node is no longer in the Document Object Model (DOM), the property returns an error message. + * For EACH ITEM in the collection: Gets the namespace URI of the custom XML part. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - xpath?: boolean; + namespaceUri?: boolean; /** - * For EACH ITEM in the collection: Gets the XML representation of the current node and its children. + * For EACH ITEM in the collection: Gets the XML representation of the current `CustomXmlPart` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -149344,4164 +159862,4220 @@ declare namespace Word { xml?: boolean; } /** - * Represents an XML node in a tree in the document. The `CustomXmlNode` object is a member of the {@link Word.CustomXmlNodeCollection} object. + * The Document object is the top level object. A Document object contains one or more sections, content controls, and the body that contains the contents of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - interface CustomXmlNodeLoadOptions { + interface DocumentLoadOptions { /** Specifying `$all` 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 a `CustomXmlNode` object corresponding to the first child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), returns `Nothing`. + * Gets the active window for the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - firstChild?: Word.Interfaces.CustomXmlNodeLoadOptions; + activeWindow?: Word.Interfaces.WindowLoadOptions; /** - * Gets a `CustomXmlNode` object corresponding to the last child element of the current node. If the node has no child elements (or if it isn't of type {@link Word.CustomXmlNodeType | CustomXmlNodeType.element}), the property returns `Nothing`. + * Specifies a `Template` object that represents the template attached to the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lastChild?: Word.Interfaces.CustomXmlNodeLoadOptions; + attachedTemplate?: Word.Interfaces.TemplateLoadOptions; /** - * Gets the next sibling node (element, comment, or processing instruction) of the current node. If the node is the last sibling at its level, the property returns `Nothing`. + * Returns a `Bibliography` object that represents the bibliography references contained within the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nextSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; + bibliography?: Word.Interfaces.BibliographyLoadOptions; /** - * Gets the object representing the part associated with this node. + * Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - ownerPart?: Word.Interfaces.CustomXmlPartLoadOptions; - /** - * Gets the parent element node of the current node. If the current node is at the root level, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - parentNode?: Word.Interfaces.CustomXmlNodeLoadOptions; - /** - * Gets the previous sibling node (element, comment, or processing instruction) of the current node. If the current node is the first sibling at its level, the property returns `Nothing`. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - previousSibling?: Word.Interfaces.CustomXmlNodeLoadOptions; + body?: Word.Interfaces.BodyLoadOptions; /** - * Gets the base name of the node without the namespace prefix, if one exists. + * Gets a `Coauthoring` object for managing coauthoring in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - baseName?: boolean; + coauthoring?: Word.Interfaces.CoauthoringLoadOptions; /** - * Gets the unique address identifier for the namespace of the node. + * Returns a `PageSetup` object that's associated with the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - namespaceUri?: boolean; + pageSetup?: Word.Interfaces.PageSetupLoadOptions; /** - * Gets the type of the current node. + * Gets the properties of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - nodeType?: boolean; + properties?: Word.Interfaces.DocumentPropertiesLoadOptions; /** - * Specifies the value of the current node. + * Returns a `Selection` object that represents the current selection in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nodeValue?: boolean; + selection?: Word.Interfaces.SelectionLoadOptions; /** - * Specifies the text for the current node. + * Specifies if automatic hyphenation is turned on for the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - text?: boolean; + autoHyphenation?: boolean; /** - * Gets a string with the canonicalized XPath for the current node. If the node is no longer in the Document Object Model (DOM), the property returns an error message. + * Specifies if the edits in the document are automatically saved. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xpath?: boolean; + autoSaveOn?: boolean; /** - * Gets the XML representation of the current node and its children. + * Specifies the ChangeTracking mode. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - xml?: boolean; - } - /** - * Represents a content control. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text, plain text, checkbox, dropdown list, and combo box content controls are supported. - * - * @remarks - * [Api set: WordApi 1.1] - */ - interface ContentControlLoadOptions { - /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * [Api set: WordApi 1.4] */ - $all?: boolean; + changeTrackingMode?: boolean; /** - * Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `BuildingBlockGallery`. It's `null` otherwise. + * Specifies the maximum number of consecutive lines that can end with hyphens. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlLoadOptions; + consecutiveHyphensLimit?: boolean; /** - * Gets the data of the content control when its type is `CheckBox`. It's `null` otherwise. + * Specifies whether words in all capital letters can be hyphenated. * * @remarks - * [Api set: WordApi 1.7] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions; + hyphenateCaps?: boolean; /** - * Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `DatePicker`. It's `null` otherwise. + * Specifies whether Microsoft Word has detected the language of the document text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - datePickerContentControl?: Word.Interfaces.DatePickerContentControlLoadOptions; + languageDetected?: boolean; /** - * Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. + * Indicates whether the changes in the document have been saved. A value of true indicates that the document hasn't changed since it was saved. * * @remarks * [Api set: WordApi 1.1] */ - font?: Word.Interfaces.FontLoadOptions; + saved?: boolean; + } + /** + * The DocumentCreated object is the top level object created by Application.CreateDocument. A DocumentCreated object is a special Document object. + * + * @remarks + * [Api set: WordApi 1.3] + */ + interface DocumentCreatedLoadOptions { /** - * Gets the group-related data if the content control's {@link Word.ContentControlType} is `Group`. It's `null` otherwise. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ - groupContentControl?: Word.Interfaces.GroupContentControlLoadOptions; + $all?: boolean; /** - * Gets the parent body of the content control. + * Gets the body object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiHiddenDocument 1.3] */ - parentBody?: Word.Interfaces.BodyLoadOptions; + body?: Word.Interfaces.BodyLoadOptions; /** - * Gets the content control that contains the content control. Throws an `ItemNotFound` error if there isn't a parent content control. + * Gets the properties of the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiHiddenDocument 1.3] */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; + properties?: Word.Interfaces.DocumentPropertiesLoadOptions; /** - * Gets the content control that contains the content control. If there isn't a parent content control, then this method will return 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}. + * Indicates whether the changes in the document have been saved. A value of true indicates that the document hasn't changed since it was saved. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiHiddenDocument 1.3] */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + saved?: boolean; + } + /** + * Represents document properties. + * + * @remarks + * [Api set: WordApi 1.3] + */ + interface DocumentPropertiesLoadOptions { /** - * Gets the table that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table. - * - * @remarks - * [Api set: WordApi 1.3] + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ - parentTable?: Word.Interfaces.TableLoadOptions; + $all?: boolean; /** - * Gets the table cell that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * Gets the application name of the document. * * @remarks * [Api set: WordApi 1.3] */ - parentTableCell?: Word.Interfaces.TableCellLoadOptions; + applicationName?: boolean; /** - * Gets the table cell that contains the content control. If it isn't contained in a table cell, then this method will return 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 author of the document. * * @remarks * [Api set: WordApi 1.3] */ - parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + author?: boolean; /** - * Gets the table that contains the content control. If it isn't contained in a table, then this method will return 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 category of the document. * * @remarks * [Api set: WordApi 1.3] */ - parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + category?: boolean; /** - * Gets the picture-related data if the content control's {@link Word.ContentControlType} is `Picture`. It's `null` otherwise. + * Specifies the Comments field in the metadata of the document. These have no connection to comments by users made in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - pictureContentControl?: Word.Interfaces.PictureContentControlLoadOptions; + comments?: boolean; /** - * Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `RepeatingSection`. It's `null` otherwise. + * Specifies the company of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlLoadOptions; + company?: boolean; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Gets the creation date of the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; + creationDate?: boolean; /** - * Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. + * Specifies the format of the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - appearance?: boolean; + format?: boolean; /** - * Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited. + * Specifies the keywords of the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - cannotDelete?: boolean; + keywords?: boolean; /** - * Specifies a value that indicates whether the user can edit the contents of the content control. + * Gets the last author of the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - cannotEdit?: boolean; + lastAuthor?: boolean; /** - * Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. + * Gets the last print date of the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - color?: boolean; + lastPrintDate?: boolean; /** - * Gets an integer that represents the content control identifier. + * Gets the last save time of the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - id?: boolean; + lastSaveTime?: boolean; /** - * Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. + * Specifies the manager of the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - placeholderText?: boolean; + manager?: boolean; /** - * Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. + * Gets the revision number of the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - removeWhenEdited?: boolean; + revisionNumber?: boolean; /** - * Specifies the style name for the content control. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * Gets security settings of the document. Some are access restrictions on the file on disk. Others are Document Protection settings. Some possible values are 0 = File on disk is read/write; 1 = Protect Document: File is encrypted and requires a password to open; 2 = Protect Document: Always Open as Read-Only; 3 = Protect Document: Both #1 and #2; 4 = File on disk is read-only; 5 = Both #1 and #4; 6 = Both #2 and #4; 7 = All of #1, #2, and #4; 8 = Protect Document: Restrict Edit to read-only; 9 = Both #1 and #8; 10 = Both #2 and #8; 11 = All of #1, #2, and #8; 12 = Both #4 and #8; 13 = All of #1, #4, and #8; 14 = All of #2, #4, and #8; 15 = All of #1, #2, #4, and #8. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - style?: boolean; + security?: boolean; /** - * Specifies the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Specifies the subject of the document. * * @remarks * [Api set: WordApi 1.3] */ - styleBuiltIn?: boolean; + subject?: boolean; /** - * Gets the content control subtype. The subtype can be 'RichTextInline', 'RichTextParagraphs', 'RichTextTableCell', 'RichTextTableRow' and 'RichTextTable' for rich text content controls, or 'PlainTextInline' and 'PlainTextParagraph' for plain text content controls, or 'CheckBox' for checkbox content controls. + * Gets the template of the document. * * @remarks * [Api set: WordApi 1.3] */ - subtype?: boolean; + template?: boolean; /** - * Specifies a tag to identify a content control. + * Specifies the title of the document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - tag?: boolean; + title?: boolean; + } + /** + * Represents a field. + * + * @remarks + * [Api set: WordApi 1.4] + * + * Important: To learn more about which fields can be inserted, see the `Word.Range.insertField` API introduced in requirement set 1.5. + * Support for managing fields is similar to what's available in the Word UI. However, the Word UI on the web primarily only supports fields as read-only (see {@link https://support.microsoft.com/office/d8f46094-13c3-4966-98c3-259748f3caf1 | Field codes in Word for the web}). + * To learn more about Word UI clients that more fully support fields, see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}. + */ + interface FieldLoadOptions { /** - * Gets the text of the content control. - * - * @remarks - * [Api set: WordApi 1.1] + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ - text?: boolean; + $all?: boolean; /** - * Specifies the title for a content control. + * Gets a `LinkFormat` object that represents the link options of the field. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - title?: boolean; + linkFormat?: Word.Interfaces.LinkFormatLoadOptions; /** - * Gets the content control type. Only rich text, plain text, and checkbox content controls are supported currently. + * Gets an `OleFormat` object that represents the OLE characteristics (other than linking) for the field. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: boolean; - } - /** - * Contains a collection of {@link Word.ContentControl} objects. Content controls are bounded and potentially labeled regions in a document that serve as containers for specific types of content. Individual content controls may contain contents such as images, tables, or paragraphs of formatted text. Currently, only rich text, plain text, checkbox, dropdown list, and combo box content controls are supported. - * - * @remarks - * [Api set: WordApi 1.1] - */ - interface ContentControlCollectionLoadOptions { + oleFormat?: Word.Interfaces.OleFormatLoadOptions; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * Gets the parent body of the field. + * + * @remarks + * [Api set: WordApi 1.4] */ - $all?: boolean; + parentBody?: Word.Interfaces.BodyLoadOptions; /** - * For EACH ITEM in the collection: Gets the building block gallery-related data if the content control's {@link Word.ContentControlType} is `BuildingBlockGallery`. It's `null` otherwise. + * Gets the content control that contains the field. Throws an `ItemNotFound` error if there isn't a parent content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlLoadOptions; + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the data of the content control when its type is `CheckBox`. It's `null` otherwise. + * Gets the content control that contains the field. If there isn't a parent content control, then this method will return 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: WordApi 1.7] + * [Api set: WordApi 1.4] */ - checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions; + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the date picker-related data if the content control's {@link Word.ContentControlType} is `DatePicker`. It's `null` otherwise. + * Gets the table that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - datePickerContentControl?: Word.Interfaces.DatePickerContentControlLoadOptions; + parentTable?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Gets the text format of the content control. Use this to get and set font name, size, color, and other properties. + * Gets the table cell that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table cell. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.4] */ - font?: Word.Interfaces.FontLoadOptions; + parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the group-related data if the content control's {@link Word.ContentControlType} is `Group`. It's `null` otherwise. + * Gets the table cell that contains the field. If it isn't contained in a table cell, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - groupContentControl?: Word.Interfaces.GroupContentControlLoadOptions; + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the parent body of the content control. + * Gets the table that contains the field. If it isn't contained in a table, then this method will return 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: WordApi 1.3] + * [Api set: WordApi 1.4] */ - parentBody?: Word.Interfaces.BodyLoadOptions; + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Gets the content control that contains the content control. Throws an `ItemNotFound` error if there isn't a parent content control. + * Gets the field's result data. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.4] */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; + result?: Word.Interfaces.RangeLoadOptions; /** - * For EACH ITEM in the collection: Gets the content control that contains the content control. If there isn't a parent content control, then this method will return 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 field's code instruction. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] + * + * Note: The ability to set the code was introduced in WordApi 1.5. */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + code?: boolean; /** - * For EACH ITEM in the collection: Gets the table that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table. + * Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is `null` and it will throw a general exception when code attempts to set it. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - parentTable?: Word.Interfaces.TableLoadOptions; + data?: boolean; /** - * For EACH ITEM in the collection: Gets the table cell that contains the content control. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * Gets the field's kind. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - parentTableCell?: Word.Interfaces.TableCellLoadOptions; + kind?: boolean; /** - * For EACH ITEM in the collection: Gets the table cell that contains the content control. If it isn't contained in a table cell, then this method will return 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 whether the field is locked. `true` if the field is locked, `false` otherwise. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + locked?: boolean; /** - * For EACH ITEM in the collection: Gets the table that contains the content control. If it isn't contained in a table, then this method will return 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 whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.1] */ - parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + showCodes?: boolean; /** - * For EACH ITEM in the collection: Gets the picture-related data if the content control's {@link Word.ContentControlType} is `Picture`. It's `null` otherwise. + * Gets the field's type. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - pictureContentControl?: Word.Interfaces.PictureContentControlLoadOptions; + type?: boolean; + } + /** + * Contains a collection of {@link Word.Field} objects. + * + * @remarks + * [Api set: WordApi 1.4] + * + * Important: To learn more about which fields can be inserted, see the `Word.Range.insertField` API introduced in requirement set 1.5. + * Support for managing fields is similar to what's available in the Word UI. However, the Word UI on the web primarily only supports fields as read-only (see {@link https://support.microsoft.com/office/d8f46094-13c3-4966-98c3-259748f3caf1 | Field codes in Word for the web}). + * To learn more about Word UI clients that more fully support fields, see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}. + */ + interface FieldCollectionLoadOptions { /** - * For EACH ITEM in the collection: Gets the repeating section-related data if the content control's {@link Word.ContentControlType} is `RepeatingSection`. It's `null` otherwise. + Specifying `$all` 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 a `LinkFormat` object that represents the link options of the field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlLoadOptions; + linkFormat?: Word.Interfaces.LinkFormatLoadOptions; /** - * For EACH ITEM in the collection: Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * For EACH ITEM in the collection: Gets an `OleFormat` object that represents the OLE characteristics (other than linking) for the field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; + oleFormat?: Word.Interfaces.OleFormatLoadOptions; /** - * For EACH ITEM in the collection: Specifies the appearance of the content control. The value can be 'BoundingBox', 'Tags', or 'Hidden'. + * For EACH ITEM in the collection: Gets the parent body of the field. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.4] */ - appearance?: boolean; + parentBody?: Word.Interfaces.BodyLoadOptions; /** - * For EACH ITEM in the collection: Specifies a value that indicates whether the user can delete the content control. Mutually exclusive with removeWhenEdited. + * For EACH ITEM in the collection: Gets the content control that contains the field. Throws an `ItemNotFound` error if there isn't a parent content control. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.4] */ - cannotDelete?: boolean; + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Specifies a value that indicates whether the user can edit the contents of the content control. + * For EACH ITEM in the collection: Gets the content control that contains the field. If there isn't a parent content control, then this method will return 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: WordApi 1.1] + * [Api set: WordApi 1.4] */ - cannotEdit?: boolean; + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Specifies the color of the content control. Color is specified in '#RRGGBB' format or by using the color name. + * For EACH ITEM in the collection: Gets the table that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.4] */ - color?: boolean; + parentTable?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Gets an integer that represents the content control identifier. + * For EACH ITEM in the collection: Gets the table cell that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table cell. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.4] */ - id?: boolean; + parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Specifies the placeholder text of the content control. Dimmed text will be displayed when the content control is empty. + * For EACH ITEM in the collection: Gets the table cell that contains the field. If it isn't contained in a table cell, then this method will return 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: WordApi 1.1] + * [Api set: WordApi 1.4] */ - placeholderText?: boolean; + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Specifies a value that indicates whether the content control is removed after it is edited. Mutually exclusive with cannotDelete. + * For EACH ITEM in the collection: Gets the table that contains the field. If it isn't contained in a table, then this method will return 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: WordApi 1.1] + * [Api set: WordApi 1.4] */ - removeWhenEdited?: boolean; + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Specifies the style name for the content control. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * For EACH ITEM in the collection: Gets the field's result data. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.4] */ - style?: boolean; + result?: Word.Interfaces.RangeLoadOptions; /** - * For EACH ITEM in the collection: Specifies the built-in style name for the content control. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * For EACH ITEM in the collection: Specifies the field's code instruction. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.4] + * + * Note: The ability to set the code was introduced in WordApi 1.5. */ - styleBuiltIn?: boolean; + code?: boolean; /** - * For EACH ITEM in the collection: Gets the content control subtype. The subtype can be 'RichTextInline', 'RichTextParagraphs', 'RichTextTableCell', 'RichTextTableRow' and 'RichTextTable' for rich text content controls, or 'PlainTextInline' and 'PlainTextParagraph' for plain text content controls, or 'CheckBox' for checkbox content controls. + * For EACH ITEM in the collection: Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is `null` and it will throw a general exception when code attempts to set it. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - subtype?: boolean; + data?: boolean; /** - * For EACH ITEM in the collection: Specifies a tag to identify a content control. + * For EACH ITEM in the collection: Gets the field's kind. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - tag?: boolean; + kind?: boolean; /** - * For EACH ITEM in the collection: Gets the text of the content control. + * For EACH ITEM in the collection: Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - text?: boolean; + locked?: boolean; /** - * For EACH ITEM in the collection: Specifies the title for a content control. + * For EACH ITEM in the collection: Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - title?: boolean; + showCodes?: boolean; /** - * For EACH ITEM in the collection: Gets the content control type. Only rich text, plain text, and checkbox content controls are supported currently. + * For EACH ITEM in the collection: Gets the field's type. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ type?: boolean; } /** - * Represents a list item in a dropdown list or combo box content control. + * Represents a font. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi 1.1] */ - interface ContentControlListItemLoadOptions { + interface FontLoadOptions { /** Specifying `$all` 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 display text of a list item for a dropdown list or combo box content control. + * Returns a `FillFormat` object that contains fill formatting properties for the font used by the range of text. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - displayText?: boolean; + fill?: Word.Interfaces.FillFormatLoadOptions; /** - * Specifies the index location of a content control list item in the collection of list items. + * Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - index?: boolean; + glow?: Word.Interfaces.GlowFormatLoadOptions; /** - * Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * Returns a `LineFormat` object that specifies the formatting for a line. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - value?: boolean; - } - /** - * Contains a collection of {@link Word.ContentControlListItem} objects that represent the items in a dropdown list or combo box content control. - * - * @remarks - * [Api set: WordApi 1.9] - */ - interface ContentControlListItemCollectionLoadOptions { + line?: Word.Interfaces.LineFormatLoadOptions; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + reflection?: Word.Interfaces.ReflectionFormatLoadOptions; /** - * For EACH ITEM in the collection: Specifies the display text of a list item for a dropdown list or combo box content control. + * Returns a `ColorFormat` object that represents the color for the font. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - displayText?: boolean; + textColor?: Word.Interfaces.ColorFormatLoadOptions; /** - * For EACH ITEM in the collection: Specifies the index location of a content control list item in the collection of list items. + * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - index?: boolean; + textShadow?: Word.Interfaces.ShadowFormatLoadOptions; /** - * For EACH ITEM in the collection: Specifies the programmatic value of a list item for a dropdown list or combo box content control. + * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font. * * @remarks - * [Api set: WordApi 1.9] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - value?: boolean; - } - /** - * Represents a custom property. - * - * @remarks - * [Api set: WordApi 1.3] - */ - interface CustomPropertyLoadOptions { + threeDimensionalFormat?: Word.Interfaces.ThreeDimensionalFormatLoadOptions; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * Specifies whether the font is formatted as all capital letters, 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: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + allCaps?: boolean; /** - * Gets the key of the custom property. + * Specifies a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - key?: boolean; + bold?: boolean; /** - * Gets the value type of the custom property. Possible values are: String, Number, Date, Boolean. + * Specifies whether the font is formatted as bold in a right-to-left language document. 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: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: boolean; + boldBidirectional?: boolean; /** - * Specifies the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). + * Specifies the color for the specified font. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - value?: boolean; - } - /** - * Contains the collection of {@link Word.CustomProperty} objects. - * - * @remarks - * [Api set: WordApi 1.3] - */ - interface CustomPropertyCollectionLoadOptions { + color?: boolean; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * Specifies a `ColorIndex` value that represents the color for the font. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + colorIndex?: boolean; /** - * For EACH ITEM in the collection: Gets the key of the custom property. + * Specifies the color for the `Font` object in a right-to-left language document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - key?: boolean; + colorIndexBidirectional?: boolean; /** - * For EACH ITEM in the collection: Gets the value type of the custom property. Possible values are: String, Number, Date, Boolean. + * Specifies whether contextual alternates are enabled for the font. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: boolean; + contextualAlternates?: boolean; /** - * For EACH ITEM in the collection: Specifies the value of the custom property. Note that even though Word on the web and the docx file format allow these properties to be arbitrarily long, the desktop version of Word will truncate string values to 255 16-bit chars (possibly creating invalid unicode by breaking up a surrogate pair). + * Specifies the color to be used for diacritics for the `Font` object. You can provide the value in the '#RRGGBB' format. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - value?: boolean; - } - /** - * Represents a custom XML part. - * - * @remarks - * [Api set: WordApi 1.4] - */ - interface CustomXmlPartLoadOptions { + diacriticColor?: boolean; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * Specifies whether Microsoft Word ignores the number of characters per line for the corresponding `Font` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + disableCharacterSpaceGrid?: boolean; /** - * Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. + * Specifies a value that indicates whether the font has a double strikethrough. True if the font is formatted as double strikethrough text, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + doubleStrikeThrough?: boolean; + /** + * Specifies whether the font is formatted as embossed. The possible values are as follows: + + - `true`: All the text is embossed. + + - `false`: None of the text is embossed. + + - `null`: Returned if some, but not all, of the text is embossed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - documentElement?: Word.Interfaces.CustomXmlNodeLoadOptions; + emboss?: boolean; /** - * Gets a value that indicates whether the `CustomXmlPart` is built-in. + * Specifies an `EmphasisMark` value that represents the emphasis mark for a character or designated character string. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - builtIn?: boolean; + emphasisMark?: boolean; /** - * Gets the ID of the custom XML part. + * Specifies whether the font is formatted as engraved. The possible values are as follows: + + - `true`: All the text is engraved. + + - `false`: None of the text is engraved. + + - `null`: Returned if some, but not all, of the text is engraved. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: boolean; + engrave?: boolean; /** - * Gets the namespace URI of the custom XML part. + * Specifies a value that indicates whether the font is tagged as hidden. True if the font is formatted as hidden text, otherwise, false. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApiDesktop 1.2] */ - namespaceUri?: boolean; + hidden?: boolean; /** - * Gets the XML representation of the current `CustomXmlPart` object. + * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or `null` for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - xml?: boolean; - } - /** - * Contains the collection of {@link Word.CustomXmlPart} objects. - * - * @remarks - * [Api set: WordApi 1.4] - */ - interface CustomXmlPartCollectionLoadOptions { + highlightColor?: boolean; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * Specifies a value that indicates whether the font is italicized. True if the font is italicized, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] */ - $all?: boolean; + italic?: boolean; /** - * For EACH ITEM in the collection: Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. + * Specifies whether the font is italicized in a right-to-left language document. 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: WordApi BETA (PREVIEW ONLY)] * @beta */ - documentElement?: Word.Interfaces.CustomXmlNodeLoadOptions; + italicBidirectional?: boolean; /** - * For EACH ITEM in the collection: Gets a value that indicates whether the `CustomXmlPart` is built-in. + * Specifies the minimum font size for which Microsoft Word will adjust kerning automatically. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - builtIn?: boolean; + kerning?: boolean; /** - * For EACH ITEM in the collection: Gets the ID of the custom XML part. + * Specifies the ligature setting for the `Font` object. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: boolean; + ligature?: boolean; /** - * For EACH ITEM in the collection: Gets the namespace URI of the custom XML part. + * Specifies a value that represents the name of the font. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - namespaceUri?: boolean; + name?: boolean; /** - * For EACH ITEM in the collection: Gets the XML representation of the current `CustomXmlPart` object. + * Specifies the font used for Latin text (characters with character codes from 0 (zero) through 127). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xml?: boolean; - } - /** - * Contains the collection of {@link Word.CustomXmlPart} objects with a specific namespace. - * - * @remarks - * [Api set: WordApi 1.4] - */ - 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; + nameAscii?: boolean; /** - * For EACH ITEM in the collection: Gets the root element of a bound region of data in the document. If the region is empty, the property returns `Nothing`. + * Specifies the font name in a right-to-left language document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - documentElement?: Word.Interfaces.CustomXmlNodeLoadOptions; + nameBidirectional?: boolean; /** - * For EACH ITEM in the collection: Gets a value that indicates whether the `CustomXmlPart` is built-in. + * Specifies the East Asian font name. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - builtIn?: boolean; + nameFarEast?: boolean; /** - * For EACH ITEM in the collection: Gets the ID of the custom XML part. + * Specifies the font used for characters with codes from 128 through 255. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: boolean; + nameOther?: boolean; /** - * For EACH ITEM in the collection: Gets the namespace URI of the custom XML part. + * Specifies the number form setting for an OpenType font. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - namespaceUri?: boolean; + numberForm?: boolean; /** - * For EACH ITEM in the collection: Gets the XML representation of the current `CustomXmlPart` object. + * Specifies the number spacing setting for the font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xml?: boolean; - } - /** - * The Document object is the top level object. A Document object contains one or more sections, content controls, and the body that contains the contents of the document. - * - * @remarks - * [Api set: WordApi 1.1] - */ - interface DocumentLoadOptions { + numberSpacing?: boolean; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * Specifies if the font is formatted as outlined. The possible values are as follows: + + - `true`: All the text is outlined. + + - `false`: None of the text is outlined. + + - `null`: Returned if some, but not all, of the text is outlined. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + outline?: boolean; /** - * Gets the active window for the document. + * Specifies the position of text (in points) relative to the base line. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - activeWindow?: Word.Interfaces.WindowLoadOptions; + position?: boolean; /** - * Specifies a `Template` object that represents the template attached to the document. + * Specifies the scaling percentage applied to the font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - attachedTemplate?: Word.Interfaces.TemplateLoadOptions; + scaling?: boolean; /** - * Returns a `Bibliography` object that represents the bibliography references contained within the document. + * Specifies if the font is formatted as shadowed. The possible values are as follows: + + - `true`: All the text is shadowed. + + - `false`: None of the text is shadowed. + + - `null`: Returned if some, but not all, of the text is shadowed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bibliography?: Word.Interfaces.BibliographyLoadOptions; + shadow?: boolean; /** - * Gets the body object of the main document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. + * Specifies a value that represents the font size in points. * * @remarks * [Api set: WordApi 1.1] */ - body?: Word.Interfaces.BodyLoadOptions; + size?: boolean; /** - * Returns a `PageSetup` object that's associated with the document. + * Specifies the font size in points for right-to-left text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageSetup?: Word.Interfaces.PageSetupLoadOptions; + sizeBidirectional?: boolean; /** - * Gets the properties of the document. + * Specifies whether the font is formatted as small caps, 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: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - properties?: Word.Interfaces.DocumentPropertiesLoadOptions; + smallCaps?: boolean; /** - * Specifies if automatic hyphenation is turned on for the document. + * Specifies the spacing between characters. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - autoHyphenation?: boolean; + spacing?: boolean; /** - * Specifies if the edits in the document are automatically saved. + * Specifies a value that indicates whether the font has a strikethrough. True if the font is formatted as strikethrough text, otherwise, false. + * + * @remarks + * [Api set: WordApi 1.1] + */ + strikeThrough?: boolean; + /** + * Specifies the stylistic set for the font. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - autoSaveOn?: boolean; + stylisticSet?: boolean; /** - * Specifies the ChangeTracking mode. + * Specifies a value that indicates whether the font is a subscript. True if the font is formatted as subscript, otherwise, false. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - changeTrackingMode?: boolean; + subscript?: boolean; /** - * Specifies the maximum number of consecutive lines that can end with hyphens. + * Specifies a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - consecutiveHyphensLimit?: boolean; + superscript?: boolean; /** - * Specifies whether words in all capital letters can be hyphenated. + * Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined. + * + * @remarks + * [Api set: WordApi 1.1] + */ + underline?: boolean; + /** + * Specifies the color of the underline for the `Font` object. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hyphenateCaps?: boolean; + underlineColor?: boolean; + } + /** + * Represents a heading style used in a table of contents or table of figures. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface HeadingStyleLoadOptions { /** - * Specifies whether Microsoft Word has detected the language of the document text. + Specifying `$all` 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 level for the heading style in a table of contents or table of figures. Must be a value from 1 to 9. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageDetected?: boolean; + level?: boolean; /** - * Indicates whether the changes in the document have been saved. A value of true indicates that the document hasn't changed since it was saved. + * Specifies the name of style for a heading. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - saved?: boolean; + name?: boolean; } /** - * The DocumentCreated object is the top level object created by Application.CreateDocument. A DocumentCreated object is a special Document object. + * Represents a collection of {@link Word.HeadingStyle} objects in a Word document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - interface DocumentCreatedLoadOptions { + interface HeadingStyleCollectionLoadOptions { /** Specifying `$all` 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 body object of the document. The body is the text that excludes headers, footers, footnotes, textboxes, etc. - * - * @remarks - * [Api set: WordApiHiddenDocument 1.3] - */ - body?: Word.Interfaces.BodyLoadOptions; - /** - * Gets the properties of the document. + * For EACH ITEM in the collection: Specifies the level for the heading style in a table of contents or table of figures. Must be a value from 1 to 9. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - properties?: Word.Interfaces.DocumentPropertiesLoadOptions; + level?: boolean; /** - * Indicates whether the changes in the document have been saved. A value of true indicates that the document hasn't changed since it was saved. + * For EACH ITEM in the collection: Specifies the name of style for a heading. * * @remarks - * [Api set: WordApiHiddenDocument 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - saved?: boolean; + name?: boolean; } /** - * Represents document properties. + * Represents a hyperlink in a Word document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - interface DocumentPropertiesLoadOptions { + 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; /** - * Gets the application name of the document. + * Returns a `Range` object that represents the portion of the document that's contained within the hyperlink. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - applicationName?: boolean; + range?: Word.Interfaces.RangeLoadOptions; /** - * Specifies the author of the document. + * Specifies the address (for example, a file name or URL) of the hyperlink. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - author?: boolean; + address?: boolean; /** - * Specifies the category of the document. + * Specifies the text string for the hyperlink's subject line. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - category?: boolean; + emailSubject?: boolean; /** - * Specifies the Comments field in the metadata of the document. These have no connection to comments by users made in the document. + * Returns `true` if extra information is required to resolve the hyperlink. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - comments?: boolean; + isExtraInfoRequired?: boolean; /** - * Specifies the company of the document. + * Returns the name of the `Hyperlink` object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - company?: boolean; + name?: boolean; /** - * Gets the creation date of the document. + * Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - creationDate?: boolean; + screenTip?: boolean; /** - * Specifies the format of the document. + * Specifies a named location in the destination of the hyperlink. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - format?: boolean; + subAddress?: boolean; /** - * Specifies the keywords of the document. + * Specifies the name of the frame or window in which to load the hyperlink. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - keywords?: boolean; + target?: boolean; /** - * Gets the last author of the document. + * Specifies the hyperlink's visible text in the document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lastAuthor?: boolean; + textToDisplay?: boolean; /** - * Gets the last print date of the document. + * Returns the hyperlink type. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lastPrintDate?: boolean; + type?: boolean; + } + /** + * Contains a collection of {@link Word.Hyperlink} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface HyperlinkCollectionLoadOptions { /** - * Gets the last save time of the document. + Specifying `$all` 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 a `Range` object that represents the portion of the document that's contained within the hyperlink. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lastSaveTime?: boolean; + range?: Word.Interfaces.RangeLoadOptions; /** - * Specifies the manager of the document. + * For EACH ITEM in the collection: Specifies the address (for example, a file name or URL) of the hyperlink. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - manager?: boolean; + address?: boolean; /** - * Gets the revision number of the document. + * For EACH ITEM in the collection: Specifies the text string for the hyperlink's subject line. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - revisionNumber?: boolean; + emailSubject?: boolean; /** - * Gets security settings of the document. Some are access restrictions on the file on disk. Others are Document Protection settings. Some possible values are 0 = File on disk is read/write; 1 = Protect Document: File is encrypted and requires a password to open; 2 = Protect Document: Always Open as Read-Only; 3 = Protect Document: Both #1 and #2; 4 = File on disk is read-only; 5 = Both #1 and #4; 6 = Both #2 and #4; 7 = All of #1, #2, and #4; 8 = Protect Document: Restrict Edit to read-only; 9 = Both #1 and #8; 10 = Both #2 and #8; 11 = All of #1, #2, and #8; 12 = Both #4 and #8; 13 = All of #1, #4, and #8; 14 = All of #2, #4, and #8; 15 = All of #1, #2, #4, and #8. + * For EACH ITEM in the collection: Returns `true` if extra information is required to resolve the hyperlink. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - security?: boolean; + isExtraInfoRequired?: boolean; /** - * Specifies the subject of the document. + * For EACH ITEM in the collection: Returns the name of the `Hyperlink` object. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - subject?: boolean; + name?: boolean; /** - * Gets the template of the document. + * For EACH ITEM in the collection: Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - template?: boolean; + screenTip?: boolean; /** - * Specifies the title of the document. + * For EACH ITEM in the collection: Specifies a named location in the destination of the hyperlink. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - title?: boolean; - } - /** - * Represents a field. - * - * @remarks - * [Api set: WordApi 1.4] - * - * Important: To learn more about which fields can be inserted, see the `Word.Range.insertField` API introduced in requirement set 1.5. - * Support for managing fields is similar to what's available in the Word UI. However, the Word UI on the web primarily only supports fields as read-only (see {@link https://support.microsoft.com/office/d8f46094-13c3-4966-98c3-259748f3caf1 | Field codes in Word for the web}). - * To learn more about Word UI clients that more fully support fields, see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}. - */ - interface FieldLoadOptions { + subAddress?: boolean; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * For EACH ITEM in the collection: Specifies the name of the frame or window in which to load the hyperlink. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + target?: boolean; /** - * Gets a `LinkFormat` object that represents the link options of the field. + * For EACH ITEM in the collection: Specifies the hyperlink's visible text in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - linkFormat?: Word.Interfaces.LinkFormatLoadOptions; + textToDisplay?: boolean; /** - * Gets an `OleFormat` object that represents the OLE characteristics (other than linking) for the field. + * For EACH ITEM in the collection: Returns the hyperlink type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - oleFormat?: Word.Interfaces.OleFormatLoadOptions; + type?: boolean; + } + /** + * Represents an inline picture. + * + * @remarks + * [Api set: WordApi 1.1] + */ + interface InlinePictureLoadOptions { /** - * Gets the parent body of the field. + Specifying `$all` 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 parent paragraph that contains the inline image. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.2] */ - parentBody?: Word.Interfaces.BodyLoadOptions; + paragraph?: Word.Interfaces.ParagraphLoadOptions; /** - * Gets the content control that contains the field. Throws an `ItemNotFound` error if there isn't a parent content control. + * Gets the content control that contains the inline image. Throws an `ItemNotFound` error if there isn't a parent content control. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the content control that contains the field. If there isn't a parent content control, then this method will return 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}. + * Gets the content control that contains the inline image. If there isn't a parent content control, then this method will return 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: WordApi 1.4] + * [Api set: WordApi 1.3] */ parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the table that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table. + * Gets the table that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ parentTable?: Word.Interfaces.TableLoadOptions; /** - * Gets the table cell that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * Gets the table cell that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table cell. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * Gets the table cell that contains the field. If it isn't contained in a table cell, then this method will return 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}. + * Gets the table cell that contains the inline image. If it isn't contained in a table cell, then this method will return 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: WordApi 1.4] + * [Api set: WordApi 1.3] */ parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * Gets the table that contains the field. If it isn't contained in a table, then this method will return 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}. + * Gets the table that contains the inline image. If it isn't contained in a table, then this method will return 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: WordApi 1.4] + * [Api set: WordApi 1.3] */ parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * Gets the field's result data. + * Specifies a string that represents the alternative text associated with the inline image. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - result?: Word.Interfaces.RangeLoadOptions; + altTextDescription?: boolean; /** - * Specifies the field's code instruction. + * Specifies a string that contains the title for the inline image. * * @remarks - * [Api set: WordApi 1.4] - * - * Note: The ability to set the code was introduced in WordApi 1.5. + * [Api set: WordApi 1.1] */ - code?: boolean; + altTextTitle?: boolean; /** - * Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is `null` and it will throw a general exception when code attempts to set it. + * Specifies a number that describes the height of the inline image. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - data?: boolean; + height?: boolean; /** - * Gets the field's kind. + * Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - kind?: boolean; + hyperlink?: boolean; /** - * Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. + * Gets the format of the inline image. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - locked?: boolean; + imageFormat?: boolean; /** - * Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise. + * Specifies a value that indicates whether the inline image retains its original proportions when you resize it. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.1] */ - showCodes?: boolean; + lockAspectRatio?: boolean; /** - * Gets the field's type. + * Specifies a number that describes the width of the inline image. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - type?: boolean; + width?: boolean; } /** - * Contains a collection of {@link Word.Field} objects. + * Contains a collection of {@link Word.InlinePicture} objects. * * @remarks - * [Api set: WordApi 1.4] - * - * Important: To learn more about which fields can be inserted, see the `Word.Range.insertField` API introduced in requirement set 1.5. - * Support for managing fields is similar to what's available in the Word UI. However, the Word UI on the web primarily only supports fields as read-only (see {@link https://support.microsoft.com/office/d8f46094-13c3-4966-98c3-259748f3caf1 | Field codes in Word for the web}). - * To learn more about Word UI clients that more fully support fields, see the product list at the beginning of {@link https://support.microsoft.com/office/c429bbb0-8669-48a7-bd24-bab6ba6b06bb | Insert, edit, and view fields in Word}. + * [Api set: WordApi 1.1] */ - interface FieldCollectionLoadOptions { + interface InlinePictureCollectionLoadOptions { /** Specifying `$all` 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 a `LinkFormat` object that represents the link options of the field. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - linkFormat?: Word.Interfaces.LinkFormatLoadOptions; - /** - * For EACH ITEM in the collection: Gets an `OleFormat` object that represents the OLE characteristics (other than linking) for the field. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - oleFormat?: Word.Interfaces.OleFormatLoadOptions; - /** - * For EACH ITEM in the collection: Gets the parent body of the field. + * For EACH ITEM in the collection: Gets the parent paragraph that contains the inline image. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.2] */ - parentBody?: Word.Interfaces.BodyLoadOptions; + paragraph?: Word.Interfaces.ParagraphLoadOptions; /** - * For EACH ITEM in the collection: Gets the content control that contains the field. Throws an `ItemNotFound` error if there isn't a parent content control. + * For EACH ITEM in the collection: Gets the content control that contains the inline image. Throws an `ItemNotFound` error if there isn't a parent content control. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the content control that contains the field. If there isn't a parent content control, then this method will return 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}. + * For EACH ITEM in the collection: Gets the content control that contains the inline image. If there isn't a parent content control, then this method will return 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: WordApi 1.4] + * [Api set: WordApi 1.3] */ parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the table that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table. + * For EACH ITEM in the collection: Gets the table that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ parentTable?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Gets the table cell that contains the field. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * For EACH ITEM in the collection: Gets the table cell that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table cell. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the table cell that contains the field. If it isn't contained in a table cell, then this method will return 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}. + * For EACH ITEM in the collection: Gets the table cell that contains the inline image. If it isn't contained in a table cell, then this method will return 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: WordApi 1.4] + * [Api set: WordApi 1.3] */ parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the table that contains the field. If it isn't contained in a table, then this method will return 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}. + * For EACH ITEM in the collection: Gets the table that contains the inline image. If it isn't contained in a table, then this method will return 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: WordApi 1.4] + * [Api set: WordApi 1.3] */ parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Gets the field's result data. + * For EACH ITEM in the collection: Specifies a string that represents the alternative text associated with the inline image. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.1] */ - result?: Word.Interfaces.RangeLoadOptions; + altTextDescription?: boolean; /** - * For EACH ITEM in the collection: Specifies the field's code instruction. + * For EACH ITEM in the collection: Specifies a string that contains the title for the inline image. * * @remarks - * [Api set: WordApi 1.4] - * - * Note: The ability to set the code was introduced in WordApi 1.5. + * [Api set: WordApi 1.1] */ - code?: boolean; + altTextTitle?: boolean; /** - * For EACH ITEM in the collection: Specifies data in an "Addin" field. If the field isn't an "Addin" field, it is `null` and it will throw a general exception when code attempts to set it. + * For EACH ITEM in the collection: Specifies a number that describes the height of the inline image. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - data?: boolean; + height?: boolean; /** - * For EACH ITEM in the collection: Gets the field's kind. + * For EACH ITEM in the collection: Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - kind?: boolean; + hyperlink?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the field is locked. `true` if the field is locked, `false` otherwise. + * For EACH ITEM in the collection: Gets the format of the inline image. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApiDesktop 1.1] */ - locked?: boolean; + imageFormat?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the field codes are displayed for the specified field. `true` if the field codes are displayed, `false` otherwise. + * For EACH ITEM in the collection: Specifies a value that indicates whether the inline image retains its original proportions when you resize it. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.1] */ - showCodes?: boolean; + lockAspectRatio?: boolean; /** - * For EACH ITEM in the collection: Gets the field's type. + * For EACH ITEM in the collection: Specifies a number that describes the width of the inline image. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - type?: boolean; + width?: boolean; } /** - * Represents a font. + * Represents the linking characteristics for an OLE object or picture. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - interface FontLoadOptions { + interface LinkFormatLoadOptions { /** Specifying `$all` 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 `FillFormat` object that contains fill formatting properties for the font used by the range of text. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - fill?: Word.Interfaces.FillFormatLoadOptions; - /** - * Returns a `GlowFormat` object that represents the glow formatting for the font used by the range of text. + * Specifies if the link is updated automatically when the container file is opened or when the source file is changed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - glow?: Word.Interfaces.GlowFormatLoadOptions; + isAutoUpdated?: boolean; /** - * Returns a `LineFormat` object that specifies the formatting for a line. + * Specifies if a `Field`, `InlineShape`, or `Shape` object is locked to prevent automatic updating. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - line?: Word.Interfaces.LineFormatLoadOptions; + isLocked?: boolean; /** - * Returns a `ReflectionFormat` object that represents the reflection formatting for a shape. + * Specifies if the linked picture is saved with the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - reflection?: Word.Interfaces.ReflectionFormatLoadOptions; + isPictureSavedWithDocument?: boolean; /** - * Returns a `ColorFormat` object that represents the color for the font. + * Specifies the path and name of the source file for the linked OLE object, picture, or field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textColor?: Word.Interfaces.ColorFormatLoadOptions; + sourceFullName?: boolean; /** - * Returns a `ShadowFormat` object that specifies the shadow formatting for the font. + * Gets the name of the source file for the linked OLE object, picture, or field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textShadow?: Word.Interfaces.ShadowFormatLoadOptions; + sourceName?: boolean; /** - * Returns a `ThreeDimensionalFormat` object that contains 3-dimensional (3D) effect formatting properties for the font. + * Gets the path of the source file for the linked OLE object, picture, or field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - threeDimensionalFormat?: Word.Interfaces.ThreeDimensionalFormatLoadOptions; + sourcePath?: boolean; /** - * Specifies whether the font is formatted as all capital letters, 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. + * Gets the link type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - allCaps?: boolean; + type?: boolean; + } + /** + * Contains a collection of {@link Word.Paragraph} objects. + * + * @remarks + * [Api set: WordApi 1.3] + */ + interface ListLoadOptions { /** - * Specifies a value that indicates whether the font is bold. True if the font is formatted as bold, otherwise, false. + Specifying `$all` 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 list's id. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - bold?: boolean; + id?: boolean; /** - * Specifies whether the font is formatted as bold in a right-to-left language document. 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. + * Checks whether each of the 9 levels exists in the list. A true value indicates the level exists, which means there is at least one list item at that level. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - boldBidirectional?: boolean; + levelExistences?: boolean; /** - * Specifies the color for the specified font. You can provide the value in the '#RRGGBB' format or the color name. + * Gets all 9 level types in the list. Each type can be 'Bullet', 'Number', or 'Picture'. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - color?: boolean; + levelTypes?: boolean; + } + /** + * Contains a collection of {@link Word.List} objects. + * + * @remarks + * [Api set: WordApi 1.3] + */ + interface ListCollectionLoadOptions { /** - * Specifies a `ColorIndex` value that represents the color for the font. + Specifying `$all` 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 list's id. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - colorIndex?: boolean; + id?: boolean; /** - * Specifies the color for the `Font` object in a right-to-left language document. + * For EACH ITEM in the collection: Checks whether each of the 9 levels exists in the list. A true value indicates the level exists, which means there is at least one list item at that level. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - colorIndexBidirectional?: boolean; + levelExistences?: boolean; /** - * Specifies whether contextual alternates are enabled for the font. + * For EACH ITEM in the collection: Gets all 9 level types in the list. Each type can be 'Bullet', 'Number', or 'Picture'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - contextualAlternates?: boolean; + levelTypes?: boolean; + } + /** + * Represents the paragraph list item format. + * + * @remarks + * [Api set: WordApi 1.3] + */ + interface ListItemLoadOptions { /** - * Specifies the color to be used for diacritics for the `Font` object. You can provide the value in the '#RRGGBB' format. + Specifying `$all` 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 level of the item in the list. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - diacriticColor?: boolean; + level?: boolean; /** - * Specifies whether Microsoft Word ignores the number of characters per line for the corresponding `Font` object. + * Gets the list item bullet, number, or picture as a string. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - disableCharacterSpaceGrid?: boolean; + listString?: boolean; /** - * Specifies a value that indicates whether the font has a double strikethrough. True if the font is formatted as double strikethrough text, otherwise, false. + * Gets the list item order number in relation to its siblings. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - doubleStrikeThrough?: boolean; + siblingIndex?: boolean; + } + /** + * Represents a list level. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + interface ListLevelLoadOptions { /** - * Specifies whether the font is formatted as embossed. The possible values are as follows: - - - `true`: All the text is embossed. - - - `false`: None of the text is embossed. - - - `null`: Returned if some, but not all, of the text is embossed. + Specifying `$all` 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 a Font object that represents the character formatting of the specified object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - emboss?: boolean; + font?: Word.Interfaces.FontLoadOptions; /** - * Specifies an `EmphasisMark` value that represents the emphasis mark for a character or designated character string. + * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - emphasisMark?: boolean; + alignment?: boolean; /** - * Specifies whether the font is formatted as engraved. The possible values are as follows: - - - `true`: All the text is engraved. - - - `false`: None of the text is engraved. - - - `null`: Returned if some, but not all, of the text is engraved. + * Specifies the name of the style that's linked to the specified list level object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - engrave?: boolean; + linkedStyle?: boolean; /** - * Specifies a value that indicates whether the font is tagged as hidden. True if the font is formatted as hidden text, otherwise, false. + * Specifies the number format for the specified list level. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApiDesktop 1.1] */ - hidden?: boolean; + numberFormat?: boolean; /** - * Specifies the highlight color. To set it, use a value either in the '#RRGGBB' format or the color name. To remove highlight color, set it to null. The returned highlight color can be in the '#RRGGBB' format, an empty string for mixed highlight colors, or `null` for no highlight color. Note: Only the default highlight colors are available in Office for Windows Desktop. These are "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray", and "Black". When the add-in runs in Office for Windows Desktop, any other color is converted to the closest color when applied to the font. + * Specifies the position (in points) of the number or bullet for the specified list level object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - highlightColor?: boolean; + numberPosition?: boolean; /** - * Specifies a value that indicates whether the font is italicized. True if the font is italicized, otherwise, false. + * Specifies the number style for the list level object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - italic?: boolean; + numberStyle?: boolean; /** - * Specifies whether the font is italicized in a right-to-left language document. 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. + * Specifies the list level that must appear before the specified list level restarts numbering at 1. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - italicBidirectional?: boolean; + resetOnHigher?: boolean; /** - * Specifies the minimum font size for which Microsoft Word will adjust kerning automatically. + * Specifies the starting number for the specified list level object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - kerning?: boolean; + startAt?: boolean; /** - * Specifies the ligature setting for the `Font` object. + * Specifies the tab position for the specified list level object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - ligature?: boolean; + tabPosition?: boolean; /** - * Specifies a value that represents the name of the font. + * Specifies the position (in points) for the second line of wrapping text for the specified list level object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - name?: boolean; + textPosition?: boolean; /** - * Specifies the font used for Latin text (characters with character codes from 0 (zero) through 127). + * Specifies the character inserted after the number for the specified list level. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - nameAscii?: boolean; + trailingCharacter?: boolean; + } + /** + * Contains a collection of {@link Word.ListLevel} objects. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + interface ListLevelCollectionLoadOptions { /** - * Specifies the font name in a right-to-left language document. + Specifying `$all` 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 a Font object that represents the character formatting of the specified object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - nameBidirectional?: boolean; + font?: Word.Interfaces.FontLoadOptions; /** - * Specifies the East Asian font name. + * For EACH ITEM in the collection: Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - nameFarEast?: boolean; + alignment?: boolean; /** - * Specifies the font used for characters with codes from 128 through 255. + * For EACH ITEM in the collection: Specifies the name of the style that's linked to the specified list level object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - nameOther?: boolean; + linkedStyle?: boolean; /** - * Specifies the number form setting for an OpenType font. + * For EACH ITEM in the collection: Specifies the number format for the specified list level. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - numberForm?: boolean; + numberFormat?: boolean; /** - * Specifies the number spacing setting for the font. + * For EACH ITEM in the collection: Specifies the position (in points) of the number or bullet for the specified list level object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - numberSpacing?: boolean; + numberPosition?: boolean; /** - * Specifies if the font is formatted as outlined. The possible values are as follows: - - - `true`: All the text is outlined. - - - `false`: None of the text is outlined. - - - `null`: Returned if some, but not all, of the text is outlined. + * For EACH ITEM in the collection: Specifies the number style for the list level object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - outline?: boolean; + numberStyle?: boolean; /** - * Specifies the position of text (in points) relative to the base line. + * For EACH ITEM in the collection: Specifies the list level that must appear before the specified list level restarts numbering at 1. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - position?: boolean; + resetOnHigher?: boolean; /** - * Specifies the scaling percentage applied to the font. + * For EACH ITEM in the collection: Specifies the starting number for the specified list level object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - scaling?: boolean; + startAt?: boolean; /** - * Specifies if the font is formatted as shadowed. The possible values are as follows: - - - `true`: All the text is shadowed. - - - `false`: None of the text is shadowed. - - - `null`: Returned if some, but not all, of the text is shadowed. + * For EACH ITEM in the collection: Specifies the tab position for the specified list level object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - shadow?: boolean; + tabPosition?: boolean; /** - * Specifies a value that represents the font size in points. + * For EACH ITEM in the collection: Specifies the position (in points) for the second line of wrapping text for the specified list level object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - size?: boolean; + textPosition?: boolean; /** - * Specifies the font size in points for right-to-left text. + * For EACH ITEM in the collection: Specifies the character inserted after the number for the specified list level. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - sizeBidirectional?: boolean; + trailingCharacter?: boolean; + } + /** + * Represents a list template. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + interface ListTemplateLoadOptions { /** - * Specifies whether the font is formatted as small caps, 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. + Specifying `$all` 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 name of the list template. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - smallCaps?: boolean; + name?: boolean; /** - * Specifies the spacing between characters. + * Specifies whether the list template is outline numbered. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - spacing?: boolean; + outlineNumbered?: boolean; + } + /** + * Represents a footnote or endnote. + * + * @remarks + * [Api set: WordApi 1.5] + */ + interface NoteItemLoadOptions { /** - * Specifies a value that indicates whether the font has a strikethrough. True if the font is formatted as strikethrough text, otherwise, false. + Specifying `$all` 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 body object of the note item. It's the portion of the text within the footnote or endnote. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - strikeThrough?: boolean; + body?: Word.Interfaces.BodyLoadOptions; /** - * Specifies the stylistic set for the font. + * Represents a footnote or endnote reference in the main document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - stylisticSet?: boolean; + reference?: Word.Interfaces.RangeLoadOptions; /** - * Specifies a value that indicates whether the font is a subscript. True if the font is formatted as subscript, otherwise, false. + * Represents the note item type: footnote or endnote. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - subscript?: boolean; + type?: boolean; + } + /** + * Contains a collection of {@link Word.NoteItem} objects. + * + * @remarks + * [Api set: WordApi 1.5] + */ + interface NoteItemCollectionLoadOptions { /** - * Specifies a value that indicates whether the font is a superscript. True if the font is formatted as superscript, otherwise, false. + Specifying `$all` 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 body object of the note item. It's the portion of the text within the footnote or endnote. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - superscript?: boolean; + body?: Word.Interfaces.BodyLoadOptions; /** - * Specifies a value that indicates the font's underline type. 'None' if the font isn't underlined. + * For EACH ITEM in the collection: Represents a footnote or endnote reference in the main document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - underline?: boolean; + reference?: Word.Interfaces.RangeLoadOptions; /** - * Specifies the color of the underline for the `Font` object. You can provide the value in the '#RRGGBB' format. + * For EACH ITEM in the collection: Represents the note item type: footnote or endnote. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - underlineColor?: boolean; + type?: boolean; } /** - * Represents a hyperlink in a Word document. + * Represents the OLE characteristics (other than linking) for an OLE object, ActiveX control, or field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface HyperlinkLoadOptions { + interface OleFormatLoadOptions { /** Specifying `$all` 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 `Range` object that represents the portion of the document that's contained within the hyperlink. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - range?: Word.Interfaces.RangeLoadOptions; - /** - * Specifies the address (for example, a file name or URL) of the hyperlink. + * Specifies the class type for the specified OLE object, picture, or field. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - address?: boolean; + classType?: boolean; /** - * Specifies the text string for the hyperlink's subject line. + * Specifies the icon that is used when the `displayAsIcon` property is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - emailSubject?: boolean; + iconIndex?: boolean; /** - * Returns `true` if extra information is required to resolve the hyperlink. + * Specifies the text displayed below the icon for the OLE object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isExtraInfoRequired?: boolean; + iconLabel?: boolean; /** - * Returns the name of the `Hyperlink` object. + * Specifies the program file in which the icon for the OLE object is stored. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - name?: boolean; + iconName?: boolean; /** - * Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink. + * Gets the path of the file in which the icon for the OLE object is stored. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - screenTip?: boolean; + iconPath?: boolean; /** - * Specifies a named location in the destination of the hyperlink. + * Gets whether the specified object is displayed as an icon. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - subAddress?: boolean; + isDisplayedAsIcon?: boolean; /** - * Specifies the name of the frame or window in which to load the hyperlink. + * Specifies whether formatting done in Microsoft Word to the linked OLE object is preserved. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - target?: boolean; + isFormattingPreservedOnUpdate?: boolean; /** - * Specifies the hyperlink's visible text in the document. + * Gets a string that's used to identify the portion of the source file that's being linked. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textToDisplay?: boolean; + label?: boolean; /** - * Returns the hyperlink type. + * Gets the programmatic identifier (`ProgId`) for the specified OLE object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: boolean; + progID?: boolean; } /** - * Contains a collection of {@link Word.Hyperlink} objects. + * Represents a page in the document. `Page` objects manage the page layout and content. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - interface HyperlinkCollectionLoadOptions { + interface PageLoadOptions { /** Specifying `$all` 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 a `Range` object that represents the portion of the document that's contained within the hyperlink. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - range?: Word.Interfaces.RangeLoadOptions; - /** - * For EACH ITEM in the collection: Specifies the address (for example, a file name or URL) of the hyperlink. + * Gets the height, in points, of the paper defined in the Page Setup dialog box. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - address?: boolean; + height?: boolean; /** - * For EACH ITEM in the collection: Specifies the text string for the hyperlink's subject line. + * Gets the index of the page. The page index is 1-based and independent of the user's custom page numbering. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - emailSubject?: boolean; + index?: boolean; /** - * For EACH ITEM in the collection: Returns `true` if extra information is required to resolve the hyperlink. + * Gets the width, in points, of the paper defined in the Page Setup dialog box. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - isExtraInfoRequired?: boolean; + width?: boolean; + } + /** + * Represents the collection of page. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + interface PageCollectionLoadOptions { /** - * For EACH ITEM in the collection: Returns the name of the `Hyperlink` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ - name?: boolean; + $all?: boolean; /** - * For EACH ITEM in the collection: Specifies the text that appears as a ScreenTip when the mouse pointer is positioned over the hyperlink. + * For EACH ITEM in the collection: Gets the height, in points, of the paper defined in the Page Setup dialog box. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - screenTip?: boolean; + height?: boolean; /** - * For EACH ITEM in the collection: Specifies a named location in the destination of the hyperlink. + * For EACH ITEM in the collection: Gets the index of the page. The page index is 1-based and independent of the user's custom page numbering. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - subAddress?: boolean; + index?: boolean; /** - * For EACH ITEM in the collection: Specifies the name of the frame or window in which to load the hyperlink. + * For EACH ITEM in the collection: Gets the width, in points, of the paper defined in the Page Setup dialog box. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.2] */ - target?: boolean; + width?: boolean; + } + /** + * Represents a window pane. The `Pane` object is a member of the pane collection. The pane collection includes all the window panes for a single window. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + interface PaneLoadOptions { /** - * For EACH ITEM in the collection: Specifies the hyperlink's visible text in the document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ - textToDisplay?: boolean; + $all?: boolean; /** - * For EACH ITEM in the collection: Returns the hyperlink type. + * Returns a `Selection` object that represents the current selection in the pane. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: boolean; + selection?: Word.Interfaces.SelectionLoadOptions; } /** - * Represents an inline picture. + * Represents the collection of pane. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - interface InlinePictureLoadOptions { + interface PaneCollectionLoadOptions { /** Specifying `$all` 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 parent paragraph that contains the inline image. + * For EACH ITEM in the collection: Returns a `Selection` object that represents the current selection in the pane. * * @remarks - * [Api set: WordApi 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - paragraph?: Word.Interfaces.ParagraphLoadOptions; + selection?: Word.Interfaces.SelectionLoadOptions; + } + /** + * Represents the window that displays the document. A window can be split to contain multiple reading panes. + * + * @remarks + * [Api set: WordApiDesktop 1.2] + */ + interface WindowLoadOptions { /** - * Gets the content control that contains the inline image. Throws an `ItemNotFound` error if there isn't a parent content control. + Specifying `$all` 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 active pane in the window. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.2] */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; + activePane?: Word.Interfaces.PaneLoadOptions; /** - * Gets the content control that contains the inline image. If there isn't a parent content control, then this method will return 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}. + * Gets the next document window in the collection of open document windows. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + next?: Word.Interfaces.WindowLoadOptions; /** - * Gets the table that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table. + * Gets the previous document window in the collection open document windows. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTable?: Word.Interfaces.TableLoadOptions; + previous?: Word.Interfaces.WindowLoadOptions; /** - * Gets the table cell that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * Gets the `View` object that represents the view for the window. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTableCell?: Word.Interfaces.TableCellLoadOptions; + view?: Word.Interfaces.ViewLoadOptions; /** - * Gets the table cell that contains the inline image. If it isn't contained in a table cell, then this method will return 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 whether rulers are displayed for the window or pane. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + areRulersDisplayed?: boolean; /** - * Gets the table that contains the inline image. If it isn't contained in a table, then this method will return 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 whether comments, footnotes, endnotes, and hyperlinks are displayed as tips. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + areScreenTipsDisplayed?: boolean; /** - * Specifies a string that represents the alternative text associated with the inline image. + * Specifies whether thumbnail images of the pages in a document are displayed along the left side of the Microsoft Word document window. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - altTextDescription?: boolean; + areThumbnailsDisplayed?: boolean; /** - * Specifies a string that contains the title for the inline image. + * Specifies the caption text for the window that is displayed in the title bar of the document or application window. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - altTextTitle?: boolean; + caption?: boolean; /** - * Specifies a number that describes the height of the inline image. + * Specifies the height of the window (in points). * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ height?: boolean; /** - * Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. + * Specifies the horizontal scroll position as a percentage of the document width. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - hyperlink?: boolean; + horizontalPercentScrolled?: boolean; /** - * Gets the format of the inline image. + * Specifies the default start-up mode for the Japanese Input Method Editor (IME). * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - imageFormat?: boolean; + imeMode?: boolean; /** - * Specifies a value that indicates whether the inline image retains its original proportions when you resize it. + * Gets the position of an item in a collection. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lockAspectRatio?: boolean; + index?: boolean; /** - * Specifies a number that describes the width of the inline image. + * Specifies whether the window is active. * * @remarks - * [Api set: WordApi 1.1] - */ - width?: boolean; - } - /** - * Contains a collection of {@link Word.InlinePicture} objects. - * - * @remarks - * [Api set: WordApi 1.1] - */ - interface InlinePictureCollectionLoadOptions { - /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + isActive?: boolean; /** - * For EACH ITEM in the collection: Gets the parent paragraph that contains the inline image. + * Specifies whether the document map is visible. * * @remarks - * [Api set: WordApi 1.2] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - paragraph?: Word.Interfaces.ParagraphLoadOptions; + isDocumentMapVisible?: boolean; /** - * For EACH ITEM in the collection: Gets the content control that contains the inline image. Throws an `ItemNotFound` error if there isn't a parent content control. + * Specifies whether the email message header is visible in the document window. The default value is `False`. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; + isEnvelopeVisible?: boolean; /** - * For EACH ITEM in the collection: Gets the content control that contains the inline image. If there isn't a parent content control, then this method will return 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 whether a horizontal scroll bar is displayed for the window. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + isHorizontalScrollBarDisplayed?: boolean; /** - * For EACH ITEM in the collection: Gets the table that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table. + * Specifies whether the vertical scroll bar appears on the left side of the document window. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTable?: Word.Interfaces.TableLoadOptions; + isLeftScrollBarDisplayed?: boolean; /** - * For EACH ITEM in the collection: Gets the table cell that contains the inline image. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * Specifies whether the vertical ruler appears on the right side of the document window in print layout view. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTableCell?: Word.Interfaces.TableCellLoadOptions; + isRightRulerDisplayed?: boolean; /** - * For EACH ITEM in the collection: Gets the table cell that contains the inline image. If it isn't contained in a table cell, then this method will return 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 whether the window is split into multiple panes. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + isSplit?: boolean; /** - * For EACH ITEM in the collection: Gets the table that contains the inline image. If it isn't contained in a table, then this method will return 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 whether a vertical ruler is displayed for the window or pane. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + isVerticalRulerDisplayed?: boolean; /** - * For EACH ITEM in the collection: Specifies a string that represents the alternative text associated with the inline image. + * Specifies whether a vertical scroll bar is displayed for the window. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - altTextDescription?: boolean; + isVerticalScrollBarDisplayed?: boolean; /** - * For EACH ITEM in the collection: Specifies a string that contains the title for the inline image. + * Specifies whether the window is visible. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - altTextTitle?: boolean; + isVisible?: boolean; /** - * For EACH ITEM in the collection: Specifies a number that describes the height of the inline image. + * Specifies the horizontal position of the window, measured in points. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - height?: boolean; + left?: boolean; /** - * For EACH ITEM in the collection: Specifies a hyperlink on the image. Use a '#' to separate the address part from the optional location part. + * Specifies how Microsoft Word displays source documents after a compare and merge process. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - hyperlink?: boolean; + showSourceDocuments?: boolean; /** - * For EACH ITEM in the collection: Gets the format of the inline image. + * Specifies the vertical split percentage for the window. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - imageFormat?: boolean; + splitVertical?: boolean; /** - * For EACH ITEM in the collection: Specifies a value that indicates whether the inline image retains its original proportions when you resize it. + * Specifies the width of the style area in points. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lockAspectRatio?: boolean; + styleAreaWidth?: boolean; /** - * For EACH ITEM in the collection: Specifies a number that describes the width of the inline image. + * Specifies the vertical position of the document window, in points. * * @remarks - * [Api set: WordApi 1.1] - */ - width?: boolean; - } - /** - * Represents the linking characteristics for an OLE object or picture. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface LinkFormatLoadOptions { - /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + top?: boolean; /** - * Specifies if the link is updated automatically when the container file is opened or when the source file is changed. + * Gets the window type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isAutoUpdated?: boolean; + type?: boolean; /** - * Specifies if a `Field`, `InlineShape`, or `Shape` object is locked to prevent automatic updating. + * Gets the height (in points) of the active working area in the document window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isLocked?: boolean; + usableHeight?: boolean; /** - * Specifies if the linked picture is saved with the document. + * Gets the width (in points) of the active working area in the document window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isPictureSavedWithDocument?: boolean; + usableWidth?: boolean; /** - * Specifies the path and name of the source file for the linked OLE object, picture, or field. + * Specifies the vertical scroll position as a percentage of the document length. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sourceFullName?: boolean; + verticalPercentScrolled?: boolean; /** - * Gets the name of the source file for the linked OLE object, picture, or field. + * Specifies the width of the document window, in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sourceName?: boolean; + width?: boolean; /** - * Gets the path of the source file for the linked OLE object, picture, or field. + * Gets an integer that represents the position of the window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sourcePath?: boolean; + windowNumber?: boolean; /** - * Gets the link type. + * Specifies the state of the document window or task window. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: boolean; + windowState?: boolean; } /** - * Contains a collection of {@link Word.Paragraph} objects. + * Represents the collection of window objects. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - interface ListLoadOptions { + interface WindowCollectionLoadOptions { /** Specifying `$all` 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 list's id. + * For EACH ITEM in the collection: Gets the active pane in the window. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApiDesktop 1.2] */ - id?: boolean; + activePane?: Word.Interfaces.PaneLoadOptions; /** - * Checks whether each of the 9 levels exists in the list. A true value indicates the level exists, which means there is at least one list item at that level. + * For EACH ITEM in the collection: Gets the next document window in the collection of open document windows. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - levelExistences?: boolean; + next?: Word.Interfaces.WindowLoadOptions; /** - * Gets all 9 level types in the list. Each type can be 'Bullet', 'Number', or 'Picture'. + * For EACH ITEM in the collection: Gets the previous document window in the collection open document windows. * * @remarks - * [Api set: WordApi 1.3] - */ - levelTypes?: boolean; - } - /** - * Contains a collection of {@link Word.List} objects. - * - * @remarks - * [Api set: WordApi 1.3] - */ - interface ListCollectionLoadOptions { - /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + previous?: Word.Interfaces.WindowLoadOptions; /** - * For EACH ITEM in the collection: Gets the list's id. + * For EACH ITEM in the collection: Gets the `View` object that represents the view for the window. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - id?: boolean; + view?: Word.Interfaces.ViewLoadOptions; /** - * For EACH ITEM in the collection: Checks whether each of the 9 levels exists in the list. A true value indicates the level exists, which means there is at least one list item at that level. + * For EACH ITEM in the collection: Specifies whether rulers are displayed for the window or pane. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - levelExistences?: boolean; + areRulersDisplayed?: boolean; /** - * For EACH ITEM in the collection: Gets all 9 level types in the list. Each type can be 'Bullet', 'Number', or 'Picture'. + * For EACH ITEM in the collection: Specifies whether comments, footnotes, endnotes, and hyperlinks are displayed as tips. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - levelTypes?: boolean; - } - /** - * Represents the paragraph list item format. - * - * @remarks - * [Api set: WordApi 1.3] - */ - interface ListItemLoadOptions { + areScreenTipsDisplayed?: boolean; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * For EACH ITEM in the collection: Specifies whether thumbnail images of the pages in a document are displayed along the left side of the Microsoft Word document window. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + areThumbnailsDisplayed?: boolean; /** - * Specifies the level of the item in the list. + * For EACH ITEM in the collection: Specifies the caption text for the window that is displayed in the title bar of the document or application window. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - level?: boolean; + caption?: boolean; /** - * Gets the list item bullet, number, or picture as a string. + * For EACH ITEM in the collection: Specifies the height of the window (in points). * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listString?: boolean; + height?: boolean; /** - * Gets the list item order number in relation to its siblings. + * For EACH ITEM in the collection: Specifies the horizontal scroll position as a percentage of the document width. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - siblingIndex?: boolean; - } - /** - * Represents a list level. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - interface ListLevelLoadOptions { + horizontalPercentScrolled?: boolean; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * For EACH ITEM in the collection: Specifies the default start-up mode for the Japanese Input Method Editor (IME). + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + imeMode?: boolean; /** - * Gets a Font object that represents the character formatting of the specified object. + * For EACH ITEM in the collection: Gets the position of an item in a collection. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontLoadOptions; + index?: boolean; /** - * Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. + * For EACH ITEM in the collection: Specifies whether the window is active. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: boolean; + isActive?: boolean; /** - * Specifies the name of the style that's linked to the specified list level object. + * For EACH ITEM in the collection: Specifies whether the document map is visible. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - linkedStyle?: boolean; + isDocumentMapVisible?: boolean; /** - * Specifies the number format for the specified list level. + * For EACH ITEM in the collection: Specifies whether the email message header is visible in the document window. The default value is `False`. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - numberFormat?: boolean; + isEnvelopeVisible?: boolean; /** - * Specifies the position (in points) of the number or bullet for the specified list level object. + * For EACH ITEM in the collection: Specifies whether a horizontal scroll bar is displayed for the window. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - numberPosition?: boolean; + isHorizontalScrollBarDisplayed?: boolean; /** - * Specifies the number style for the list level object. + * For EACH ITEM in the collection: Specifies whether the vertical scroll bar appears on the left side of the document window. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - numberStyle?: boolean; + isLeftScrollBarDisplayed?: boolean; /** - * Specifies the list level that must appear before the specified list level restarts numbering at 1. + * For EACH ITEM in the collection: Specifies whether the vertical ruler appears on the right side of the document window in print layout view. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - resetOnHigher?: boolean; + isRightRulerDisplayed?: boolean; /** - * Specifies the starting number for the specified list level object. + * For EACH ITEM in the collection: Specifies whether the window is split into multiple panes. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - startAt?: boolean; + isSplit?: boolean; /** - * Specifies the tab position for the specified list level object. + * For EACH ITEM in the collection: Specifies whether a vertical ruler is displayed for the window or pane. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tabPosition?: boolean; + isVerticalRulerDisplayed?: boolean; /** - * Specifies the position (in points) for the second line of wrapping text for the specified list level object. + * For EACH ITEM in the collection: Specifies whether a vertical scroll bar is displayed for the window. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - textPosition?: boolean; + isVerticalScrollBarDisplayed?: boolean; /** - * Specifies the character inserted after the number for the specified list level. + * For EACH ITEM in the collection: Specifies whether the window is visible. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - trailingCharacter?: boolean; - } - /** - * Contains a collection of {@link Word.ListLevel} objects. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - interface ListLevelCollectionLoadOptions { + isVisible?: boolean; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * For EACH ITEM in the collection: Specifies the horizontal position of the window, measured in points. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + left?: boolean; /** - * For EACH ITEM in the collection: Gets a Font object that represents the character formatting of the specified object. + * For EACH ITEM in the collection: Specifies how Microsoft Word displays source documents after a compare and merge process. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontLoadOptions; + showSourceDocuments?: boolean; /** - * For EACH ITEM in the collection: Specifies the horizontal alignment of the list level. The value can be 'Left', 'Centered', or 'Right'. + * For EACH ITEM in the collection: Specifies the vertical split percentage for the window. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: boolean; + splitVertical?: boolean; /** - * For EACH ITEM in the collection: Specifies the name of the style that's linked to the specified list level object. + * For EACH ITEM in the collection: Specifies the width of the style area in points. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - linkedStyle?: boolean; + styleAreaWidth?: boolean; /** - * For EACH ITEM in the collection: Specifies the number format for the specified list level. + * For EACH ITEM in the collection: Specifies the vertical position of the document window, in points. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - numberFormat?: boolean; + top?: boolean; /** - * For EACH ITEM in the collection: Specifies the position (in points) of the number or bullet for the specified list level object. + * For EACH ITEM in the collection: Gets the window type. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - numberPosition?: boolean; + type?: boolean; /** - * For EACH ITEM in the collection: Specifies the number style for the list level object. + * For EACH ITEM in the collection: Gets the height (in points) of the active working area in the document window. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - numberStyle?: boolean; + usableHeight?: boolean; /** - * For EACH ITEM in the collection: Specifies the list level that must appear before the specified list level restarts numbering at 1. + * For EACH ITEM in the collection: Gets the width (in points) of the active working area in the document window. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - resetOnHigher?: boolean; + usableWidth?: boolean; /** - * For EACH ITEM in the collection: Specifies the starting number for the specified list level object. + * For EACH ITEM in the collection: Specifies the vertical scroll position as a percentage of the document length. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - startAt?: boolean; + verticalPercentScrolled?: boolean; /** - * For EACH ITEM in the collection: Specifies the tab position for the specified list level object. + * For EACH ITEM in the collection: Specifies the width of the document window, in points. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tabPosition?: boolean; + width?: boolean; /** - * For EACH ITEM in the collection: Specifies the position (in points) for the second line of wrapping text for the specified list level object. + * For EACH ITEM in the collection: Gets an integer that represents the position of the window. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - textPosition?: boolean; + windowNumber?: boolean; /** - * For EACH ITEM in the collection: Specifies the character inserted after the number for the specified list level. + * For EACH ITEM in the collection: Specifies the state of the document window or task window. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - trailingCharacter?: boolean; + windowState?: boolean; } /** - * Represents a list template. + * Represents a single paragraph in a selection, range, content control, or document body. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.1] */ - interface ListTemplateLoadOptions { + interface ParagraphLoadOptions { /** Specifying `$all` 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 list template is outline numbered. + * Gets the text format of the paragraph. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApiDesktop 1.1] - */ - outlineNumbered?: boolean; - } - /** - * Represents a footnote or endnote. - * - * @remarks - * [Api set: WordApi 1.5] - */ - interface NoteItemLoadOptions { - /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * [Api set: WordApi 1.1] */ - $all?: boolean; + font?: Word.Interfaces.FontLoadOptions; /** - * Represents the body object of the note item. It's the portion of the text within the footnote or endnote. + * Gets the List to which this paragraph belongs. Throws an `ItemNotFound` error if the paragraph isn't in a list. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - body?: Word.Interfaces.BodyLoadOptions; + list?: Word.Interfaces.ListLoadOptions; /** - * Represents a footnote or endnote reference in the main document. + * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - reference?: Word.Interfaces.RangeLoadOptions; + listItem?: Word.Interfaces.ListItemLoadOptions; /** - * Represents the note item type: footnote or endnote. + * Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return 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: WordApi 1.5] + * [Api set: WordApi 1.3] */ - type?: boolean; - } - /** - * Contains a collection of {@link Word.NoteItem} objects. - * - * @remarks - * [Api set: WordApi 1.5] - */ - interface NoteItemCollectionLoadOptions { + listItemOrNullObject?: Word.Interfaces.ListItemLoadOptions; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * Gets the List to which this paragraph belongs. If the paragraph isn't in a list, then this method will return 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: WordApi 1.3] */ - $all?: boolean; + listOrNullObject?: Word.Interfaces.ListLoadOptions; /** - * For EACH ITEM in the collection: Represents the body object of the note item. It's the portion of the text within the footnote or endnote. + * Gets the parent body of the paragraph. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - body?: Word.Interfaces.BodyLoadOptions; + parentBody?: Word.Interfaces.BodyLoadOptions; /** - * For EACH ITEM in the collection: Represents a footnote or endnote reference in the main document. + * Gets the content control that contains the paragraph. Throws an `ItemNotFound` error if there isn't a parent content control. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - reference?: Word.Interfaces.RangeLoadOptions; + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Represents the note item type: footnote or endnote. + * Gets the content control that contains the paragraph. If there isn't a parent content control, then this method will return 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: WordApi 1.5] + * [Api set: WordApi 1.3] */ - type?: boolean; - } - /** - * Represents the OLE characteristics (other than linking) for an OLE object, ActiveX control, or field. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface OleFormatLoadOptions { + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * Gets the table that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table. + * + * @remarks + * [Api set: WordApi 1.3] */ - $all?: boolean; + parentTable?: Word.Interfaces.TableLoadOptions; /** - * Specifies the class type for the specified OLE object, picture, or field. + * Gets the table cell that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table cell. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - classType?: boolean; + parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * Specifies the icon that is used when the `displayAsIcon` property is `true`. + * Gets the table cell that contains the paragraph. If it isn't contained in a table cell, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - iconIndex?: boolean; + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * Specifies the text displayed below the icon for the OLE object. + * Gets the table that contains the paragraph. If it isn't contained in a table, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - iconLabel?: boolean; + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * Specifies the program file in which the icon for the OLE object is stored. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - iconName?: boolean; + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - * Gets the path of the file in which the icon for the OLE object is stored. + * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - iconPath?: boolean; + alignment?: boolean; /** - * Gets whether the specified object is displayed as an icon. + * Specifies the value, in points, for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - isDisplayedAsIcon?: boolean; + firstLineIndent?: boolean; /** - * Specifies whether formatting done in Microsoft Word to the linked OLE object is preserved. + * Indicates the paragraph is the last one inside its parent body. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isFormattingPreservedOnUpdate?: boolean; + isLastParagraph?: boolean; /** - * Gets a string that's used to identify the portion of the source file that's being linked. + * Checks whether the paragraph is a list item. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - label?: boolean; + isListItem?: boolean; /** - * Gets the programmatic identifier (`ProgId`) for the specified OLE object. + * Specifies the left indent value, in points, for the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - progID?: boolean; - } - /** - * Represents a page in the document. `Page` objects manage the page layout and content. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - interface PageLoadOptions { + leftIndent?: boolean; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. + * + * @remarks + * [Api set: WordApi 1.1] */ - $all?: boolean; + lineSpacing?: boolean; /** - * Gets the height, in points, of the paper defined in the Page Setup dialog box. + * Specifies the amount of spacing, in grid lines, after the paragraph. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] */ - height?: boolean; + lineUnitAfter?: boolean; /** - * Gets the index of the page. The page index is 1-based and independent of the user's custom page numbering. + * Specifies the amount of spacing, in grid lines, before the paragraph. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] */ - index?: boolean; + lineUnitBefore?: boolean; /** - * Gets the width, in points, of the paper defined in the Page Setup dialog box. + * Specifies the outline level for the paragraph. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] */ - width?: boolean; - } - /** - * Represents the collection of page. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - interface PageCollectionLoadOptions { + outlineLevel?: boolean; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * Specifies the right indent value, in points, for the paragraph. + * + * @remarks + * [Api set: WordApi 1.1] */ - $all?: boolean; + rightIndent?: boolean; /** - * For EACH ITEM in the collection: Gets the height, in points, of the paper defined in the Page Setup dialog box. + * Specifies the spacing, in points, after the paragraph. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] */ - height?: boolean; + spaceAfter?: boolean; /** - * For EACH ITEM in the collection: Gets the index of the page. The page index is 1-based and independent of the user's custom page numbering. + * Specifies the spacing, in points, before the paragraph. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] */ - index?: boolean; + spaceBefore?: boolean; /** - * For EACH ITEM in the collection: Gets the width, in points, of the paper defined in the Page Setup dialog box. + * Specifies the style name for the paragraph. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.1] */ - width?: boolean; - } - /** - * Represents the window that displays the document. A window can be split to contain multiple reading panes. - * - * @remarks - * [Api set: WordApiDesktop 1.2] - */ - interface WindowLoadOptions { + style?: boolean; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * Specifies the built-in style name for the paragraph. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * + * @remarks + * [Api set: WordApi 1.3] */ - $all?: boolean; + styleBuiltIn?: boolean; /** - * Gets the next document window in the collection of open document windows. + * Gets the level of the paragraph's table. It returns 0 if the paragraph isn't in a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - next?: Word.Interfaces.WindowLoadOptions; + tableNestingLevel?: boolean; /** - * Gets the previous document window in the collection open document windows. + * Gets the text of the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - previous?: Word.Interfaces.WindowLoadOptions; + text?: boolean; /** - * Gets the `View` object that represents the view for the window. + * Gets a string that represents the paragraph identifier in the current session. ID is in standard 8-4-4-4-12 GUID format without curly braces and differs across sessions and coauthors. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - view?: Word.Interfaces.ViewLoadOptions; + uniqueLocalId?: boolean; + } + /** + * Contains a collection of {@link Word.Paragraph} objects. + * + * @remarks + * [Api set: WordApi 1.1] + */ + interface ParagraphCollectionLoadOptions { /** - * Specifies whether rulers are displayed for the window or pane. + Specifying `$all` 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 text format of the paragraph. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - areRulersDisplayed?: boolean; + font?: Word.Interfaces.FontLoadOptions; /** - * Specifies whether comments, footnotes, endnotes, and hyperlinks are displayed as tips. + * For EACH ITEM in the collection: Gets the List to which this paragraph belongs. Throws an `ItemNotFound` error if the paragraph isn't in a list. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - areScreenTipsDisplayed?: boolean; + list?: Word.Interfaces.ListLoadOptions; /** - * Specifies whether thumbnail images of the pages in a document are displayed along the left side of the Microsoft Word document window. + * For EACH ITEM in the collection: Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - areThumbnailsDisplayed?: boolean; + listItem?: Word.Interfaces.ListItemLoadOptions; /** - * Specifies the caption text for the window that is displayed in the title bar of the document or application window. + * For EACH ITEM in the collection: Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - caption?: boolean; + listItemOrNullObject?: Word.Interfaces.ListItemLoadOptions; /** - * Specifies the height of the window (in points). + * For EACH ITEM in the collection: Gets the List to which this paragraph belongs. If the paragraph isn't in a list, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - height?: boolean; + listOrNullObject?: Word.Interfaces.ListLoadOptions; /** - * Specifies the horizontal scroll position as a percentage of the document width. + * For EACH ITEM in the collection: Gets the parent body of the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - horizontalPercentScrolled?: boolean; + parentBody?: Word.Interfaces.BodyLoadOptions; /** - * Specifies the default start-up mode for the Japanese Input Method Editor (IME). + * For EACH ITEM in the collection: Gets the content control that contains the paragraph. Throws an `ItemNotFound` error if there isn't a parent content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - imemode?: boolean; + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets the position of an item in a collection. + * For EACH ITEM in the collection: Gets the content control that contains the paragraph. If there isn't a parent content control, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - index?: boolean; + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Specifies whether the window is active. + * For EACH ITEM in the collection: Gets the table that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isActive?: boolean; + parentTable?: Word.Interfaces.TableLoadOptions; /** - * Specifies whether the document map is visible. + * For EACH ITEM in the collection: Gets the table cell that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table cell. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isDocumentMapVisible?: boolean; + parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * Specifies whether the email message header is visible in the document window. The default value is `False`. + * For EACH ITEM in the collection: Gets the table cell that contains the paragraph. If it isn't contained in a table cell, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isEnvelopeVisible?: boolean; + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * Specifies whether a horizontal scroll bar is displayed for the window. + * For EACH ITEM in the collection: Gets the table that contains the paragraph. If it isn't contained in a table, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isHorizontalScrollBarDisplayed?: boolean; + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * Specifies whether the vertical scroll bar appears on the left side of the document window. + * For EACH ITEM in the collection: Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isLeftScrollBarDisplayed?: boolean; + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - * Specifies whether the vertical ruler appears on the right side of the document window in print layout view. + * For EACH ITEM in the collection: Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - isRightRulerDisplayed?: boolean; + alignment?: boolean; /** - * Specifies whether the window is split into multiple panes. + * For EACH ITEM in the collection: Specifies the value, in points, for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - isSplit?: boolean; + firstLineIndent?: boolean; /** - * Specifies whether a vertical ruler is displayed for the window or pane. + * For EACH ITEM in the collection: Indicates the paragraph is the last one inside its parent body. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isVerticalRulerDisplayed?: boolean; + isLastParagraph?: boolean; /** - * Specifies whether a vertical scroll bar is displayed for the window. + * For EACH ITEM in the collection: Checks whether the paragraph is a list item. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isVerticalScrollBarDisplayed?: boolean; + isListItem?: boolean; /** - * Specifies whether the window is visible. + * For EACH ITEM in the collection: Specifies the left indent value, in points, for the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - isVisible?: boolean; + leftIndent?: boolean; /** - * Specifies the horizontal position of the window, measured in points. + * For EACH ITEM in the collection: Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - left?: boolean; + lineSpacing?: boolean; /** - * Specifies how Microsoft Word displays source documents after a compare and merge process. + * For EACH ITEM in the collection: Specifies the amount of spacing, in grid lines, after the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - showSourceDocuments?: boolean; + lineUnitAfter?: boolean; /** - * Specifies the vertical split percentage for the window. + * For EACH ITEM in the collection: Specifies the amount of spacing, in grid lines, before the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - splitVertical?: boolean; + lineUnitBefore?: boolean; /** - * Specifies the width of the style area in points. + * For EACH ITEM in the collection: Specifies the outline level for the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - styleAreaWidth?: boolean; + outlineLevel?: boolean; /** - * Specifies the vertical position of the document window, in points. + * For EACH ITEM in the collection: Specifies the right indent value, in points, for the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - top?: boolean; + rightIndent?: boolean; /** - * Gets the window type. + * For EACH ITEM in the collection: Specifies the spacing, in points, after the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - type?: boolean; + spaceAfter?: boolean; /** - * Gets the height (in points) of the active working area in the document window. + * For EACH ITEM in the collection: Specifies the spacing, in points, before the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - usableHeight?: boolean; + spaceBefore?: boolean; /** - * Gets the width (in points) of the active working area in the document window. + * For EACH ITEM in the collection: Specifies the style name for the paragraph. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - usableWidth?: boolean; + style?: boolean; /** - * Specifies the vertical scroll position as a percentage of the document length. + * For EACH ITEM in the collection: Specifies the built-in style name for the paragraph. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - verticalPercentScrolled?: boolean; + styleBuiltIn?: boolean; /** - * Specifies the width of the document window, in points. + * For EACH ITEM in the collection: Gets the level of the paragraph's table. It returns 0 if the paragraph isn't in a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - width?: boolean; + tableNestingLevel?: boolean; /** - * Gets an integer that represents the position of the window. + * For EACH ITEM in the collection: Gets the text of the paragraph. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - windowNumber?: boolean; + text?: boolean; /** - * Specifies the state of the document window or task window. + * For EACH ITEM in the collection: Gets a string that represents the paragraph identifier in the current session. ID is in standard 8-4-4-4-12 GUID format without curly braces and differs across sessions and coauthors. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - windowState?: boolean; + uniqueLocalId?: boolean; } /** - * Represents the collection of window objects. + * Represents a style of paragraph in a document. * * @remarks - * [Api set: WordApiDesktop 1.2] + * [Api set: WordApi 1.5] */ - interface WindowCollectionLoadOptions { + 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; /** - * For EACH ITEM in the collection: Gets the next document window in the collection of open document windows. + * Specifies the alignment for the specified paragraphs. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - next?: Word.Interfaces.WindowLoadOptions; + alignment?: boolean; /** - * For EACH ITEM in the collection: Gets the previous document window in the collection open document windows. + * Specifies the value (in points) for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - previous?: Word.Interfaces.WindowLoadOptions; + firstLineIndent?: boolean; /** - * For EACH ITEM in the collection: Gets the `View` object that represents the view for the window. + * Specifies whether all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - view?: Word.Interfaces.ViewLoadOptions; + keepTogether?: boolean; /** - * For EACH ITEM in the collection: Specifies whether rulers are displayed for the window or pane. + * Specifies whether the specified paragraph remains on the same page as the paragraph that follows it when Microsoft Word repaginates the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - areRulersDisplayed?: boolean; + keepWithNext?: boolean; /** - * For EACH ITEM in the collection: Specifies whether comments, footnotes, endnotes, and hyperlinks are displayed as tips. + * Specifies the left indent. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - areScreenTipsDisplayed?: boolean; + leftIndent?: boolean; /** - * For EACH ITEM in the collection: Specifies whether thumbnail images of the pages in a document are displayed along the left side of the Microsoft Word document window. + * Specifies the line spacing (in points) for the specified paragraphs. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - areThumbnailsDisplayed?: boolean; + lineSpacing?: boolean; /** - * For EACH ITEM in the collection: Specifies the caption text for the window that is displayed in the title bar of the document or application window. + * Specifies the amount of spacing (in gridlines) after the specified paragraphs. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - caption?: boolean; + lineUnitAfter?: boolean; /** - * For EACH ITEM in the collection: Specifies the height of the window (in points). + * Specifies the amount of spacing (in gridlines) before the specified paragraphs. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - height?: boolean; + lineUnitBefore?: boolean; /** - * For EACH ITEM in the collection: Specifies the horizontal scroll position as a percentage of the document width. + * Specifies whether left and right indents are the same width. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - horizontalPercentScrolled?: boolean; + mirrorIndents?: boolean; /** - * For EACH ITEM in the collection: Specifies the default start-up mode for the Japanese Input Method Editor (IME). + * Specifies the outline level for the specified paragraphs. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - imemode?: boolean; + outlineLevel?: boolean; /** - * For EACH ITEM in the collection: Gets the position of an item in a collection. + * Specifies the right indent (in points) for the specified paragraphs. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - index?: boolean; + rightIndent?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the window is active. + * Specifies the amount of spacing (in points) after the specified paragraph or text column. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - isActive?: boolean; + spaceAfter?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the document map is visible. + * Specifies the spacing (in points) before the specified paragraphs. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - isDocumentMapVisible?: boolean; + spaceBefore?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the email message header is visible in the document window. The default value is `False`. + * Specifies whether the first and last lines in the specified paragraph remain on the same page as the rest of the paragraph when Microsoft Word repaginates the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - isEnvelopeVisible?: boolean; + widowControl?: boolean; + } + /** + * Represents a contiguous area in a document. + * + * @remarks + * [Api set: WordApi 1.1] + */ + interface RangeLoadOptions { /** - * For EACH ITEM in the collection: Specifies whether a horizontal scroll bar is displayed for the window. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ - isHorizontalScrollBarDisplayed?: boolean; + $all?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the vertical scroll bar appears on the left side of the document window. + * Gets the text format of the range. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - isLeftScrollBarDisplayed?: boolean; + font?: Word.Interfaces.FontLoadOptions; /** - * For EACH ITEM in the collection: Specifies whether the vertical ruler appears on the right side of the document window in print layout view. + * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isRightRulerDisplayed?: boolean; + listFormat?: Word.Interfaces.ListFormatLoadOptions; /** - * For EACH ITEM in the collection: Specifies whether the window is split into multiple panes. + * Gets the parent body of the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isSplit?: boolean; + parentBody?: Word.Interfaces.BodyLoadOptions; /** - * For EACH ITEM in the collection: Specifies whether a vertical ruler is displayed for the window or pane. + * Gets the currently supported content control that contains the range. Throws an `ItemNotFound` error if there isn't a parent content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - isVerticalRulerDisplayed?: boolean; + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Specifies whether a vertical scroll bar is displayed for the window. + * Gets the currently supported content control that contains the range. If there isn't a parent content control, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isVerticalScrollBarDisplayed?: boolean; + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Specifies whether the window is visible. + * Gets the table that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - isVisible?: boolean; + parentTable?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Specifies the horizontal position of the window, measured in points. + * Gets the table cell that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table cell. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - left?: boolean; + parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Specifies how Microsoft Word displays source documents after a compare and merge process. + * Gets the table cell that contains the range. If it isn't contained in a table cell, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - showSourceDocuments?: boolean; + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Specifies the vertical split percentage for the window. + * Gets the table that contains the range. If it isn't contained in a table, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - splitVertical?: boolean; + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Specifies the width of the style area in points. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - styleAreaWidth?: boolean; + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - * For EACH ITEM in the collection: Specifies the vertical position of the document window, in points. + * Specifies whether the range is formatted as bold. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - top?: boolean; + bold?: boolean; /** - * For EACH ITEM in the collection: Gets the window type. + * Specifies whether the range is formatted as bold in a right-to-left language document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: boolean; + boldBidirectional?: boolean; /** - * For EACH ITEM in the collection: Gets the height (in points) of the active working area in the document window. + * Specifies a `CharacterCase` value that represents the case of the text in the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - usableHeight?: boolean; + case?: boolean; /** - * For EACH ITEM in the collection: Gets the width (in points) of the active working area in the document window. + * Specifies the character width of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - usableWidth?: boolean; + characterWidth?: boolean; /** - * For EACH ITEM in the collection: Specifies the vertical scroll position as a percentage of the document length. + * Specifies if the range contains combined characters. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - verticalPercentScrolled?: boolean; + combineCharacters?: boolean; /** - * For EACH ITEM in the collection: Specifies the width of the document window, in points. + * Specifies if Microsoft Word ignores the number of characters per line for the corresponding `Range` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - width?: boolean; + disableCharacterSpaceGrid?: boolean; /** - * For EACH ITEM in the collection: Gets an integer that represents the position of the window. + * Specifies the emphasis mark for a character or designated character string. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - windowNumber?: boolean; + emphasisMark?: boolean; /** - * For EACH ITEM in the collection: Specifies the state of the document window or task window. + * Specifies the ending character position of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - windowState?: boolean; - } - /** - * Represents a single paragraph in a selection, range, content control, or document body. - * - * @remarks - * [Api set: WordApi 1.1] - */ - interface ParagraphLoadOptions { - /** - Specifying `$all` 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 text format of the paragraph. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.1] - */ - font?: Word.Interfaces.FontLoadOptions; - /** - * Gets the List to which this paragraph belongs. Throws an `ItemNotFound` error if the paragraph isn't in a list. - * - * @remarks - * [Api set: WordApi 1.3] - */ - list?: Word.Interfaces.ListLoadOptions; - /** - * Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. - * - * @remarks - * [Api set: WordApi 1.3] - */ - listItem?: Word.Interfaces.ListItemLoadOptions; + end?: boolean; /** - * Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return 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 width (in the current measurement units) in which Microsoft Word fits the text in the current selection or range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listItemOrNullObject?: Word.Interfaces.ListItemLoadOptions; + fitTextWidth?: boolean; /** - * Gets the List to which this paragraph belongs. If the paragraph isn't in a list, then this method will return 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 if a grammar check has been run on the range or document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - listOrNullObject?: Word.Interfaces.ListLoadOptions; + grammarChecked?: boolean; /** - * Gets the parent body of the paragraph. + * Specifies the proofing status (spelling and grammar checking) of the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentBody?: Word.Interfaces.BodyLoadOptions; + hasNoProofing?: boolean; /** - * Gets the content control that contains the paragraph. Throws an `ItemNotFound` error if there isn't a parent content control. + * Specifies the highlight color for the range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; + highlightColorIndex?: boolean; /** - * Gets the content control that contains the paragraph. If there isn't a parent content control, then this method will return 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 formatting for horizontal text set within vertical text. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + horizontalInVertical?: boolean; /** - * Gets the table that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table. + * Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. Use a '#' to separate the address part from the optional location part. * * @remarks * [Api set: WordApi 1.3] */ - parentTable?: Word.Interfaces.TableLoadOptions; + hyperlink?: boolean; /** - * Gets the table cell that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * Specifies the ID for the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTableCell?: Word.Interfaces.TableCellLoadOptions; + id?: boolean; /** - * Gets the table cell that contains the paragraph. If it isn't contained in a table cell, then this method will return 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}. + * Checks whether the range length is zero. * * @remarks * [Api set: WordApi 1.3] */ - parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + isEmpty?: boolean; /** - * Gets the table that contains the paragraph. If it isn't contained in a table, then this method will return 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}. + * Gets if the range is collapsed and is located at the end-of-row mark in a table. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + isEndOfRowMark?: boolean; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. + * Gets whether the text in the range is visible on the screen. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shading?: Word.Interfaces.ShadingUniversalLoadOptions; + isTextVisibleOnScreen?: boolean; /** - * Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. + * Specifies if the font or range is formatted as italic. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: boolean; + italic?: boolean; /** - * Specifies the value, in points, for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. + * Specifies if the font or range is formatted as italic (right-to-left languages). * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - firstLineIndent?: boolean; + italicBidirectional?: boolean; /** - * Indicates the paragraph is the last one inside its parent body. + * Specifies whether the range of Japanese language text is hiragana or katakana. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isLastParagraph?: boolean; + kana?: boolean; /** - * Checks whether the paragraph is a list item. + * Specifies whether Microsoft Word has detected the language of the text in the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isListItem?: boolean; + languageDetected?: boolean; /** - * Specifies the left indent value, in points, for the paragraph. + * Specifies a `LanguageId` value that represents the language for the range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftIndent?: boolean; + languageId?: boolean; /** - * Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. + * Specifies an East Asian language for the range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineSpacing?: boolean; + languageIdFarEast?: boolean; /** - * Specifies the amount of spacing, in grid lines, after the paragraph. + * Specifies a language for the range that isn't classified as an East Asian language. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitAfter?: boolean; + languageIdOther?: boolean; /** - * Specifies the amount of spacing, in grid lines, before the paragraph. + * Specifies if all nonprinting characters (such as hidden text, tab marks, space marks, and paragraph marks) are displayed. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitBefore?: boolean; + showAll?: boolean; /** - * Specifies the outline level for the paragraph. + * Specifies if spelling has been checked throughout the range or document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - outlineLevel?: boolean; + spellingChecked?: boolean; /** - * Specifies the right indent value, in points, for the paragraph. + * Specifies the starting character position of the range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightIndent?: boolean; + start?: boolean; /** - * Specifies the spacing, in points, after the paragraph. + * Gets the number of characters in the story that contains the range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - spaceAfter?: boolean; + storyLength?: boolean; /** - * Specifies the spacing, in points, before the paragraph. + * Gets the story type for the range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - spaceBefore?: boolean; + storyType?: boolean; /** - * Specifies the style name for the paragraph. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * Specifies the style name for the range. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. * * @remarks * [Api set: WordApi 1.1] */ style?: boolean; /** - * Specifies the built-in style name for the paragraph. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Specifies the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks * [Api set: WordApi 1.3] */ styleBuiltIn?: boolean; /** - * Gets the level of the paragraph's table. It returns 0 if the paragraph isn't in a table. + * Gets the text of the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - tableNestingLevel?: boolean; + text?: boolean; /** - * Gets the text of the paragraph. + * Specifies whether Microsoft Word sets two lines of text in one and specifies the characters that enclose the text, if any. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - text?: boolean; + twoLinesInOne?: boolean; /** - * Gets a string that represents the paragraph identifier in the current session. ID is in standard 8-4-4-4-12 GUID format without curly braces and differs across sessions and coauthors. + * Specifies the type of underline applied to the range. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - uniqueLocalId?: boolean; + underline?: boolean; } /** - * Contains a collection of {@link Word.Paragraph} objects. + * Contains a collection of {@link Word.Range} objects. * * @remarks * [Api set: WordApi 1.1] */ - interface ParagraphCollectionLoadOptions { + interface RangeCollectionLoadOptions { /** Specifying `$all` 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 text format of the paragraph. Use this to get and set font name, size, color, and other properties. + * For EACH ITEM in the collection: Gets the text format of the range. Use this to get and set font name, size, color, and other properties. * * @remarks * [Api set: WordApi 1.1] */ font?: Word.Interfaces.FontLoadOptions; /** - * For EACH ITEM in the collection: Gets the List to which this paragraph belongs. Throws an `ItemNotFound` error if the paragraph isn't in a list. + * For EACH ITEM in the collection: Returns a `ListFormat` object that represents all the list formatting characteristics of the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - list?: Word.Interfaces.ListLoadOptions; + listFormat?: Word.Interfaces.ListFormatLoadOptions; /** - * For EACH ITEM in the collection: Gets the ListItem for the paragraph. Throws an `ItemNotFound` error if the paragraph isn't part of a list. + * For EACH ITEM in the collection: Gets the parent body of the range. * * @remarks * [Api set: WordApi 1.3] */ - listItem?: Word.Interfaces.ListItemLoadOptions; + parentBody?: Word.Interfaces.BodyLoadOptions; /** - * For EACH ITEM in the collection: Gets the ListItem for the paragraph. If the paragraph isn't part of a list, then this method will return 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}. + * For EACH ITEM in the collection: Gets the currently supported content control that contains the range. Throws an `ItemNotFound` error if there isn't a parent content control. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - listItemOrNullObject?: Word.Interfaces.ListItemLoadOptions; + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the List to which this paragraph belongs. If the paragraph isn't in a list, then this method will return 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}. + * For EACH ITEM in the collection: Gets the currently supported content control that contains the range. If there isn't a parent content control, then this method will return 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: WordApi 1.3] */ - listOrNullObject?: Word.Interfaces.ListLoadOptions; + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the parent body of the paragraph. + * For EACH ITEM in the collection: Gets the table that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table. * * @remarks * [Api set: WordApi 1.3] */ - parentBody?: Word.Interfaces.BodyLoadOptions; + parentTable?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Gets the content control that contains the paragraph. Throws an `ItemNotFound` error if there isn't a parent content control. + * For EACH ITEM in the collection: Gets the table cell that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table cell. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; + parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the content control that contains the paragraph. If there isn't a parent content control, then this method will return 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}. + * For EACH ITEM in the collection: Gets the table cell that contains the range. If it isn't contained in a table cell, then this method will return 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: WordApi 1.3] */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the table that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table. + * For EACH ITEM in the collection: Gets the table that contains the range. If it isn't contained in a table, then this method will return 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: WordApi 1.3] */ - parentTable?: Word.Interfaces.TableLoadOptions; + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Gets the table cell that contains the paragraph. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * For EACH ITEM in the collection: Returns a `ShadingUniversal` object that refers to the shading formatting for the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTableCell?: Word.Interfaces.TableCellLoadOptions; + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - * For EACH ITEM in the collection: Gets the table cell that contains the paragraph. If it isn't contained in a table cell, then this method will return 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}. + * For EACH ITEM in the collection: Specifies whether the range is formatted as bold. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + bold?: boolean; /** - * For EACH ITEM in the collection: Gets the table that contains the paragraph. If it isn't contained in a table, then this method will return 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}. + * For EACH ITEM in the collection: Specifies whether the range is formatted as bold in a right-to-left language document. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + boldBidirectional?: boolean; + /** + * For EACH ITEM in the collection: Specifies a `CharacterCase` value that represents the case of the text in the range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + case?: boolean; /** - * For EACH ITEM in the collection: Returns a `ShadingUniversal` object that refers to the shading formatting for the paragraph. + * For EACH ITEM in the collection: Specifies the character width of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shading?: Word.Interfaces.ShadingUniversalLoadOptions; + characterWidth?: boolean; /** - * For EACH ITEM in the collection: Specifies the alignment for a paragraph. The value can be 'left', 'centered', 'right', or 'justified'. + * For EACH ITEM in the collection: Specifies if the range contains combined characters. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: boolean; + combineCharacters?: boolean; /** - * For EACH ITEM in the collection: Specifies the value, in points, for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. + * For EACH ITEM in the collection: Specifies if Microsoft Word ignores the number of characters per line for the corresponding `Range` object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - firstLineIndent?: boolean; + disableCharacterSpaceGrid?: boolean; /** - * For EACH ITEM in the collection: Indicates the paragraph is the last one inside its parent body. + * For EACH ITEM in the collection: Specifies the emphasis mark for a character or designated character string. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isLastParagraph?: boolean; + emphasisMark?: boolean; /** - * For EACH ITEM in the collection: Checks whether the paragraph is a list item. + * For EACH ITEM in the collection: Specifies the ending character position of the range. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isListItem?: boolean; + end?: boolean; /** - * For EACH ITEM in the collection: Specifies the left indent value, in points, for the paragraph. + * For EACH ITEM in the collection: Specifies the width (in the current measurement units) in which Microsoft Word fits the text in the current selection or range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftIndent?: boolean; + fitTextWidth?: boolean; /** - * For EACH ITEM in the collection: Specifies the line spacing, in points, for the specified paragraph. In the Word UI, this value is divided by 12. + * For EACH ITEM in the collection: Specifies if a grammar check has been run on the range or document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineSpacing?: boolean; + grammarChecked?: boolean; /** - * For EACH ITEM in the collection: Specifies the amount of spacing, in grid lines, after the paragraph. + * For EACH ITEM in the collection: Specifies the proofing status (spelling and grammar checking) of the range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitAfter?: boolean; + hasNoProofing?: boolean; /** - * For EACH ITEM in the collection: Specifies the amount of spacing, in grid lines, before the paragraph. + * For EACH ITEM in the collection: Specifies the highlight color for the range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitBefore?: boolean; + highlightColorIndex?: boolean; /** - * For EACH ITEM in the collection: Specifies the outline level for the paragraph. + * For EACH ITEM in the collection: Specifies the formatting for horizontal text set within vertical text. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - outlineLevel?: boolean; + horizontalInVertical?: boolean; /** - * For EACH ITEM in the collection: Specifies the right indent value, in points, for the paragraph. + * For EACH ITEM in the collection: Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. Use a '#' to separate the address part from the optional location part. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - rightIndent?: boolean; + hyperlink?: boolean; /** - * For EACH ITEM in the collection: Specifies the spacing, in points, after the paragraph. + * For EACH ITEM in the collection: Specifies the ID for the range. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - spaceAfter?: boolean; + id?: boolean; /** - * For EACH ITEM in the collection: Specifies the spacing, in points, before the paragraph. + * For EACH ITEM in the collection: Checks whether the range length is zero. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - spaceBefore?: boolean; + isEmpty?: boolean; /** - * For EACH ITEM in the collection: Specifies the style name for the paragraph. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * For EACH ITEM in the collection: Gets if the range is collapsed and is located at the end-of-row mark in a table. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: boolean; + isEndOfRowMark?: boolean; /** - * For EACH ITEM in the collection: Specifies the built-in style name for the paragraph. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * For EACH ITEM in the collection: Gets whether the text in the range is visible on the screen. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBuiltIn?: boolean; + isTextVisibleOnScreen?: boolean; /** - * For EACH ITEM in the collection: Gets the level of the paragraph's table. It returns 0 if the paragraph isn't in a table. + * For EACH ITEM in the collection: Specifies if the font or range is formatted as italic. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tableNestingLevel?: boolean; + italic?: boolean; /** - * For EACH ITEM in the collection: Gets the text of the paragraph. + * For EACH ITEM in the collection: Specifies if the font or range is formatted as italic (right-to-left languages). * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - text?: boolean; + italicBidirectional?: boolean; /** - * For EACH ITEM in the collection: Gets a string that represents the paragraph identifier in the current session. ID is in standard 8-4-4-4-12 GUID format without curly braces and differs across sessions and coauthors. + * For EACH ITEM in the collection: Specifies whether the range of Japanese language text is hiragana or katakana. * * @remarks - * [Api set: WordApi 1.6] - */ - uniqueLocalId?: boolean; - } - /** - * Represents a style of paragraph in a document. - * - * @remarks - * [Api set: WordApi 1.5] - */ - 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`). + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + kana?: boolean; /** - * Specifies the alignment for the specified paragraphs. + * For EACH ITEM in the collection: Specifies whether Microsoft Word has detected the language of the text in the range. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: boolean; + languageDetected?: boolean; /** - * Specifies the value (in points) for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. + * For EACH ITEM in the collection: Specifies a `LanguageId` value that represents the language for the range. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - firstLineIndent?: boolean; + languageId?: boolean; /** - * Specifies whether all lines in the specified paragraphs remain on the same page when Microsoft Word repaginates the document. + * For EACH ITEM in the collection: Specifies an East Asian language for the range. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - keepTogether?: boolean; + languageIdFarEast?: boolean; /** - * Specifies whether the specified paragraph remains on the same page as the paragraph that follows it when Microsoft Word repaginates the document. + * For EACH ITEM in the collection: Specifies a language for the range that isn't classified as an East Asian language. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - keepWithNext?: boolean; + languageIdOther?: boolean; /** - * Specifies the left indent. + * For EACH ITEM in the collection: Specifies if all nonprinting characters (such as hidden text, tab marks, space marks, and paragraph marks) are displayed. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftIndent?: boolean; + showAll?: boolean; /** - * Specifies the line spacing (in points) for the specified paragraphs. + * For EACH ITEM in the collection: Specifies if spelling has been checked throughout the range or document. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineSpacing?: boolean; + spellingChecked?: boolean; /** - * Specifies the amount of spacing (in gridlines) after the specified paragraphs. + * For EACH ITEM in the collection: Specifies the starting character position of the range. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitAfter?: boolean; + start?: boolean; /** - * Specifies the amount of spacing (in gridlines) before the specified paragraphs. + * For EACH ITEM in the collection: Gets the number of characters in the story that contains the range. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - lineUnitBefore?: boolean; + storyLength?: boolean; /** - * Specifies whether left and right indents are the same width. + * For EACH ITEM in the collection: Gets the story type for the range. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - mirrorIndents?: boolean; + storyType?: boolean; /** - * Specifies the outline level for the specified paragraphs. + * For EACH ITEM in the collection: Specifies the style name for the range. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - outlineLevel?: boolean; + style?: boolean; /** - * Specifies the right indent (in points) for the specified paragraphs. + * For EACH ITEM in the collection: Specifies the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - rightIndent?: boolean; + styleBuiltIn?: boolean; /** - * Specifies the amount of spacing (in points) after the specified paragraph or text column. + * For EACH ITEM in the collection: Gets the text of the range. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.1] */ - spaceAfter?: boolean; + text?: boolean; /** - * Specifies the spacing (in points) before the specified paragraphs. + * For EACH ITEM in the collection: Specifies whether Microsoft Word sets two lines of text in one and specifies the characters that enclose the text, if any. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - spaceBefore?: boolean; + twoLinesInOne?: boolean; /** - * Specifies whether the first and last lines in the specified paragraph remain on the same page as the rest of the paragraph when Microsoft Word repaginates the document. + * For EACH ITEM in the collection: Specifies the type of underline applied to the range. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - widowControl?: boolean; + underline?: boolean; } /** - * Represents a contiguous area in a document. + * Specifies the options to be included in a search operation. + To learn more about how to use search options in the Word JavaScript APIs, read {@link https://learn.microsoft.com/office/dev/add-ins/word/search-option-guidance | Use search options to find text in your Word add-in}. * * @remarks * [Api set: WordApi 1.1] */ - interface RangeLoadOptions { + interface SearchOptionsLoadOptions { /** Specifying `$all` 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 text format of the range. Use this to get and set font name, size, color, and other properties. + * Specifies a value that indicates whether to ignore all punctuation characters between words. Corresponds to the Ignore punctuation check box in the Find and Replace dialog box. * * @remarks * [Api set: WordApi 1.1] */ - font?: Word.Interfaces.FontLoadOptions; + ignorePunct?: boolean; /** - * Returns a `ListFormat` object that represents all the list formatting characteristics of the range. + * Specifies a value that indicates whether to ignore all whitespace between words. Corresponds to the Ignore whitespace characters check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - listFormat?: Word.Interfaces.ListFormatLoadOptions; + ignoreSpace?: boolean; /** - * Gets the parent body of the range. + * Specifies a value that indicates whether to perform a case sensitive search. Corresponds to the Match case check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - parentBody?: Word.Interfaces.BodyLoadOptions; + matchCase?: boolean; /** - * Gets the currently supported content control that contains the range. Throws an `ItemNotFound` error if there isn't a parent content control. + * Specifies a value that indicates whether to match words that begin with the search string. Corresponds to the Match prefix check box in the Find and Replace dialog box. * * @remarks * [Api set: WordApi 1.1] */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; + matchPrefix?: boolean; /** - * Gets the currently supported content control that contains the range. If there isn't a parent content control, then this method will return 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 a value that indicates whether to match words that end with the search string. Corresponds to the Match suffix check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + matchSuffix?: boolean; /** - * Gets the table that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table. + * Specifies a value that indicates whether to find operation only entire words, not text that is part of a larger word. Corresponds to the Find whole words only check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - parentTable?: Word.Interfaces.TableLoadOptions; + matchWholeWord?: boolean; /** - * Gets the table cell that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * Specifies a value that indicates whether the search will be performed using special search operators. Corresponds to the Use wildcards check box in the Find and Replace dialog box. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - parentTableCell?: Word.Interfaces.TableCellLoadOptions; + matchWildcards?: boolean; + } + /** + * Represents a section in a Word document. + * + * @remarks + * [Api set: WordApi 1.1] + */ + interface SectionLoadOptions { /** - * Gets the table cell that contains the range. If it isn't contained in a table cell, then this method will return 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: WordApi 1.3] + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ - parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + $all?: boolean; /** - * Gets the table that contains the range. If it isn't contained in a table, then this method will return 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}. + * Gets the body object of the section. This doesn't include the header/footer and other section metadata. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.1] */ - parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + body?: Word.Interfaces.BodyLoadOptions; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the range. + * Returns a `PageSetup` object that's associated with the section. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shading?: Word.Interfaces.ShadingUniversalLoadOptions; + pageSetup?: Word.Interfaces.PageSetupLoadOptions; /** - * Specifies whether the range is formatted as bold. + * Specifies if the section is protected for forms. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bold?: boolean; + protectedForForms?: boolean; + } + /** + * Contains the collection of the document's {@link Word.Section} objects. + * + * @remarks + * [Api set: WordApi 1.1] + */ + interface SectionCollectionLoadOptions { /** - * Specifies whether the range is formatted as bold in a right-to-left language document. + Specifying `$all` 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 body object of the section. This doesn't include the header/footer and other section metadata. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - boldBidirectional?: boolean; + body?: Word.Interfaces.BodyLoadOptions; /** - * Specifies a `CharacterCase` value that represents the case of the text in the range. + * For EACH ITEM in the collection: Returns a `PageSetup` object that's associated with the section. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - case?: boolean; + pageSetup?: Word.Interfaces.PageSetupLoadOptions; /** - * Specifies the character width of the range. + * For EACH ITEM in the collection: Specifies if the section is protected for forms. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - characterWidth?: boolean; + protectedForForms?: boolean; + } + /** + * Represents a setting of the add-in. + * + * @remarks + * [Api set: WordApi 1.4] + */ + interface SettingLoadOptions { /** - * Specifies if the range contains combined characters. + Specifying `$all` 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 key of the setting. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - combineCharacters?: boolean; + key?: boolean; /** - * Specifies if Microsoft Word ignores the number of characters per line for the corresponding `Range` object. + * Specifies the value of the setting. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - disableCharacterSpaceGrid?: boolean; + value?: boolean; + } + /** + * Contains the collection of {@link Word.Setting} objects. + * + * @remarks + * [Api set: WordApi 1.4] + */ + interface SettingCollectionLoadOptions { /** - * Specifies the emphasis mark for a character or designated character string. + Specifying `$all` 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 key of the setting. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - emphasisMark?: boolean; + key?: boolean; /** - * Specifies the ending character position of the range. + * For EACH ITEM in the collection: Specifies the value of the setting. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.4] */ - end?: boolean; + value?: boolean; + } + /** + * Contains a collection of {@link Word.Style} objects. + * + * @remarks + * [Api set: WordApi 1.5] + */ + interface StyleCollectionLoadOptions { /** - * Specifies the width (in the current measurement units) in which Microsoft Word fits the text in the current selection or range. + Specifying `$all` 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 a BorderCollection object that represents all the borders for the specified style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - fitTextWidth?: boolean; + borders?: Word.Interfaces.BorderCollectionLoadOptions; /** - * Specifies if a grammar check has been run on the range or document. + * For EACH ITEM in the collection: Gets a font object that represents the character formatting of the specified style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - grammarChecked?: boolean; + font?: Word.Interfaces.FontLoadOptions; /** - * Specifies the proofing status (spelling and grammar checking) of the range. + * For EACH ITEM in the collection: Returns a `Frame` object that represents the frame formatting for the style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hasNoProofing?: boolean; + frame?: Word.Interfaces.FrameLoadOptions; /** - * Specifies the highlight color for the range. + * For EACH ITEM in the collection: Specifies a link between a paragraph and a character style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - highlightColorIndex?: boolean; + linkStyle?: Word.Interfaces.StyleLoadOptions; /** - * Specifies the formatting for horizontal text set within vertical text. + * For EACH ITEM in the collection: Gets a ListTemplate object that represents the list formatting for the specified Style object. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - horizontalInVertical?: boolean; + listTemplate?: Word.Interfaces.ListTemplateLoadOptions; /** - * Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. Use a '#' to separate the address part from the optional location part. + * For EACH ITEM in the collection: Gets a ParagraphFormat object that represents the paragraph settings for the specified style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - hyperlink?: boolean; + paragraphFormat?: Word.Interfaces.ParagraphFormatLoadOptions; /** - * Specifies the ID for the range. + * For EACH ITEM in the collection: Gets a Shading object that represents the shading for the specified style. Not applicable to List style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - id?: boolean; + shading?: Word.Interfaces.ShadingLoadOptions; /** - * Checks whether the range length is zero. + * For EACH ITEM in the collection: Gets a TableStyle object representing Style properties that can be applied to a table. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - isEmpty?: boolean; + tableStyle?: Word.Interfaces.TableStyleLoadOptions; /** - * Gets if the range is collapsed and is located at the end-of-row mark in a table. + * For EACH ITEM in the collection: Specifies whether the style is automatically redefined based on the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isEndOfRowMark?: boolean; + automaticallyUpdate?: boolean; /** - * Gets whether the text in the range is visible on the screen. + * For EACH ITEM in the collection: Specifies the name of an existing style to use as the base formatting of another style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] + * + * Note: The ability to set `baseStyle` was introduced in WordApi 1.6. */ - isTextVisibleOnScreen?: boolean; + baseStyle?: boolean; /** - * Specifies if the font or range is formatted as italic. + * For EACH ITEM in the collection: Gets whether the specified style is a built-in style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - italic?: boolean; + builtIn?: boolean; /** - * Specifies if the font or range is formatted as italic (right-to-left languages). + * For EACH ITEM in the collection: Gets the description of the specified style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - italicBidirectional?: boolean; + description?: boolean; /** - * Specifies whether the range of Japanese language text is hiragana or katakana. + * For EACH ITEM in the collection: Specifies whether the spelling and grammar checker ignores text formatted with this style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - kana?: boolean; + hasProofing?: boolean; /** - * Specifies whether Microsoft Word has detected the language of the text in the range. + * For EACH ITEM in the collection: Gets whether the specified style is a built-in style that has been modified or applied in the document or a new style that has been created in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - languageDetected?: boolean; + inUse?: boolean; /** - * Specifies a `LanguageId` value that represents the language for the range. + * For EACH ITEM in the collection: Specifies a `LanguageId` value that represents the language for the style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -153509,7 +164083,7 @@ declare namespace Word { */ languageId?: boolean; /** - * Specifies an East Asian language for the range. + * For EACH ITEM in the collection: Specifies an East Asian language for the style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -153517,944 +164091,915 @@ declare namespace Word { */ languageIdFarEast?: boolean; /** - * Specifies a language for the range that isn't classified as an East Asian language. + * For EACH ITEM in the collection: Gets whether a style is a linked style that can be used for both paragraph and character formatting. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - languageIdOther?: boolean; + linked?: boolean; /** - * Specifies if all nonprinting characters (such as hidden text, tab marks, space marks, and paragraph marks) are displayed. + * For EACH ITEM in the collection: Returns the list level for the style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showAll?: boolean; + listLevelNumber?: boolean; /** - * Specifies if spelling has been checked throughout the range or document. + * For EACH ITEM in the collection: Specifies whether the style cannot be changed or edited. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spellingChecked?: boolean; + locked?: boolean; /** - * Specifies the starting character position of the range. + * For EACH ITEM in the collection: Gets the name of a style in the language of the user. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - start?: boolean; + nameLocal?: boolean; /** - * Gets the number of characters in the story that contains the range. + * For EACH ITEM in the collection: Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] + * + * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. */ - storyLength?: boolean; + nextParagraphStyle?: boolean; /** - * Gets the story type for the range. + * For EACH ITEM in the collection: Specifies whether to remove spacing between paragraphs that are formatted using the same style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - storyType?: boolean; + noSpaceBetweenParagraphsOfSameStyle?: boolean; /** - * Specifies the style name for the range. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * For EACH ITEM in the collection: Specifies the priority. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - style?: boolean; + priority?: boolean; /** - * Specifies the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * For EACH ITEM in the collection: Specifies whether the style corresponds to an available quick style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - styleBuiltIn?: boolean; + quickStyle?: boolean; /** - * Gets the text of the range. + * For EACH ITEM in the collection: Gets the style type. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.5] */ - text?: boolean; + type?: boolean; /** - * Specifies whether Microsoft Word sets two lines of text in one and specifies the characters that enclose the text, if any. + * For EACH ITEM in the collection: Specifies whether the specified style is made visible as a recommended style in the Styles and in the Styles task pane in Microsoft Word after it's used in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - twoLinesInOne?: boolean; + unhideWhenUsed?: boolean; /** - * Specifies the type of underline applied to the range. + * For EACH ITEM in the collection: Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - underline?: boolean; + visibility?: boolean; } /** - * Contains a collection of {@link Word.Range} objects. + * Represents a style in a Word document. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - interface RangeCollectionLoadOptions { + interface StyleLoadOptions { /** Specifying `$all` 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 text format of the range. Use this to get and set font name, size, color, and other properties. + * Specifies a BorderCollection object that represents all the borders for the specified style. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] + */ + borders?: Word.Interfaces.BorderCollectionLoadOptions; + /** + * Gets a font object that represents the character formatting of the specified style. + * + * @remarks + * [Api set: WordApi 1.5] */ font?: Word.Interfaces.FontLoadOptions; /** - * For EACH ITEM in the collection: Returns a `ListFormat` object that represents all the list formatting characteristics of the range. + * Returns a `Frame` object that represents the frame formatting for the style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listFormat?: Word.Interfaces.ListFormatLoadOptions; + frame?: Word.Interfaces.FrameLoadOptions; /** - * For EACH ITEM in the collection: Gets the parent body of the range. + * Specifies a link between a paragraph and a character style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentBody?: Word.Interfaces.BodyLoadOptions; + linkStyle?: Word.Interfaces.StyleLoadOptions; /** - * For EACH ITEM in the collection: Gets the currently supported content control that contains the range. Throws an `ItemNotFound` error if there isn't a parent content control. + * Gets a ListTemplate object that represents the list formatting for the specified Style object. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApiDesktop 1.1] */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; + listTemplate?: Word.Interfaces.ListTemplateLoadOptions; /** - * For EACH ITEM in the collection: Gets the currently supported content control that contains the range. If there isn't a parent content control, then this method will return 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}. + * Gets a ParagraphFormat object that represents the paragraph settings for the specified style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + paragraphFormat?: Word.Interfaces.ParagraphFormatLoadOptions; /** - * For EACH ITEM in the collection: Gets the table that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table. + * Gets a Shading object that represents the shading for the specified style. Not applicable to List style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - parentTable?: Word.Interfaces.TableLoadOptions; + shading?: Word.Interfaces.ShadingLoadOptions; /** - * For EACH ITEM in the collection: Gets the table cell that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * Gets a TableStyle object representing Style properties that can be applied to a table. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.6] */ - parentTableCell?: Word.Interfaces.TableCellLoadOptions; + tableStyle?: Word.Interfaces.TableStyleLoadOptions; /** - * For EACH ITEM in the collection: Gets the table cell that contains the range. If it isn't contained in a table cell, then this method will return 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 whether the style is automatically redefined based on the selection. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + automaticallyUpdate?: boolean; /** - * For EACH ITEM in the collection: Gets the table that contains the range. If it isn't contained in a table, then this method will return 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 name of an existing style to use as the base formatting of another style. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] + * + * Note: The ability to set `baseStyle` was introduced in WordApi 1.6. */ - parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + baseStyle?: boolean; /** - * For EACH ITEM in the collection: Returns a `ShadingUniversal` object that refers to the shading formatting for the range. + * Gets whether the specified style is a built-in style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - shading?: Word.Interfaces.ShadingUniversalLoadOptions; + builtIn?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the range is formatted as bold. + * Gets the description of the specified style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bold?: boolean; + description?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the range is formatted as bold in a right-to-left language document. + * Specifies whether the spelling and grammar checker ignores text formatted with this style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - boldBidirectional?: boolean; + hasProofing?: boolean; /** - * For EACH ITEM in the collection: Specifies a `CharacterCase` value that represents the case of the text in the range. + * Gets whether the specified style is a built-in style that has been modified or applied in the document or a new style that has been created in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - case?: boolean; + inUse?: boolean; /** - * For EACH ITEM in the collection: Specifies the character width of the range. + * Specifies a `LanguageId` value that represents the language for the style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - characterWidth?: boolean; + languageId?: boolean; /** - * For EACH ITEM in the collection: Specifies if the range contains combined characters. + * Specifies an East Asian language for the style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - combineCharacters?: boolean; + languageIdFarEast?: boolean; /** - * For EACH ITEM in the collection: Specifies if Microsoft Word ignores the number of characters per line for the corresponding `Range` object. + * Gets whether a style is a linked style that can be used for both paragraph and character formatting. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - disableCharacterSpaceGrid?: boolean; + linked?: boolean; /** - * For EACH ITEM in the collection: Specifies the emphasis mark for a character or designated character string. + * Returns the list level for the style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - emphasisMark?: boolean; + listLevelNumber?: boolean; /** - * For EACH ITEM in the collection: Specifies the ending character position of the range. + * Specifies whether the style cannot be changed or edited. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - end?: boolean; + locked?: boolean; /** - * For EACH ITEM in the collection: Specifies the width (in the current measurement units) in which Microsoft Word fits the text in the current selection or range. + * Gets the name of a style in the language of the user. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - fitTextWidth?: boolean; + nameLocal?: boolean; /** - * For EACH ITEM in the collection: Specifies if a grammar check has been run on the range or document. + * Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] + * + * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. */ - grammarChecked?: boolean; + nextParagraphStyle?: boolean; /** - * For EACH ITEM in the collection: Specifies the proofing status (spelling and grammar checking) of the range. + * Specifies whether to remove spacing between paragraphs that are formatted using the same style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hasNoProofing?: boolean; + noSpaceBetweenParagraphsOfSameStyle?: boolean; /** - * For EACH ITEM in the collection: Specifies the highlight color for the range. + * Specifies the priority. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - highlightColorIndex?: boolean; + priority?: boolean; /** - * For EACH ITEM in the collection: Specifies the formatting for horizontal text set within vertical text. + * Specifies whether the style corresponds to an available quick style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - horizontalInVertical?: boolean; + quickStyle?: boolean; /** - * For EACH ITEM in the collection: Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. Use a '#' to separate the address part from the optional location part. + * Gets the style type. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - hyperlink?: boolean; + type?: boolean; /** - * For EACH ITEM in the collection: Specifies the ID for the range. + * Specifies whether the specified style is made visible as a recommended style in the Styles and in the Styles task pane in Microsoft Word after it's used in the document. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.5] */ - id?: boolean; + unhideWhenUsed?: boolean; /** - * For EACH ITEM in the collection: Checks whether the range length is zero. + * Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi 1.5] */ - isEmpty?: boolean; + visibility?: boolean; + } + /** + * Represents the shading object. + * + * @remarks + * [Api set: WordApi 1.6] + */ + interface ShadingLoadOptions { /** - * For EACH ITEM in the collection: Gets if the range is collapsed and is located at the end-of-row mark in a table. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ - isEndOfRowMark?: boolean; + $all?: boolean; /** - * For EACH ITEM in the collection: Gets whether the text in the range is visible on the screen. + * Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.6] */ - isTextVisibleOnScreen?: boolean; + backgroundPatternColor?: boolean; /** - * For EACH ITEM in the collection: Specifies if the font or range is formatted as italic. + * Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - italic?: boolean; + foregroundPatternColor?: boolean; /** - * For EACH ITEM in the collection: Specifies if the font or range is formatted as italic (right-to-left languages). + * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - italicBidirectional?: boolean; + texture?: boolean; + } + /** + * Represents the `ShadingUniversal` object, which manages shading for a range, paragraph, frame, or table. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface ShadingUniversalLoadOptions { /** - * For EACH ITEM in the collection: Specifies whether the range of Japanese language text is hiragana or katakana. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ - kana?: boolean; + $all?: boolean; /** - * For EACH ITEM in the collection: Specifies whether Microsoft Word has detected the language of the text in the range. + * Specifies the color that's applied to the background of the `ShadingUniversal` object. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageDetected?: boolean; + backgroundPatternColor?: boolean; /** - * For EACH ITEM in the collection: Specifies a `LanguageId` value that represents the language for the range. + * Specifies the color that's applied to the background of the `ShadingUniversal` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageId?: boolean; + backgroundPatternColorIndex?: boolean; /** - * For EACH ITEM in the collection: Specifies an East Asian language for the range. + * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageIdFarEast?: boolean; + foregroundPatternColor?: boolean; /** - * For EACH ITEM in the collection: Specifies a language for the range that isn't classified as an East Asian language. + * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageIdOther?: boolean; + foregroundPatternColorIndex?: boolean; /** - * For EACH ITEM in the collection: Specifies if all nonprinting characters (such as hidden text, tab marks, space marks, and paragraph marks) are displayed. + * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showAll?: boolean; + texture?: boolean; + } + /** + * Represents a table in a Word document. + * + * @remarks + * [Api set: WordApi 1.3] + */ + interface TableLoadOptions { /** - * For EACH ITEM in the collection: Specifies if spelling has been checked throughout the range or document. + Specifying `$all` 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 font. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - spellingChecked?: boolean; + font?: Word.Interfaces.FontLoadOptions; /** - * For EACH ITEM in the collection: Specifies the starting character position of the range. + * Gets the parent body of the table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - start?: boolean; + parentBody?: Word.Interfaces.BodyLoadOptions; /** - * For EACH ITEM in the collection: Gets the number of characters in the story that contains the range. + * Gets the content control that contains the table. Throws an `ItemNotFound` error if there isn't a parent content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - storyLength?: boolean; + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Gets the story type for the range. + * Gets the content control that contains the table. If there isn't a parent content control, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - storyType?: boolean; + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * For EACH ITEM in the collection: Specifies the style name for the range. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * Gets the table that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - style?: boolean; + parentTable?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Specifies the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * Gets the table cell that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table cell. * * @remarks * [Api set: WordApi 1.3] */ - styleBuiltIn?: boolean; + parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Gets the text of the range. + * Gets the table cell that contains this table. If it isn't contained in a table cell, then this method will return 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: WordApi 1.1] + * [Api set: WordApi 1.3] */ - text?: boolean; + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * For EACH ITEM in the collection: Specifies whether Microsoft Word sets two lines of text in one and specifies the characters that enclose the text, if any. + * Gets the table that contains this table. If it isn't contained in a table, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - twoLinesInOne?: boolean; + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * For EACH ITEM in the collection: Specifies the type of underline applied to the range. + * Returns the `ShadingUniversal` object that represents the shading of the table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - underline?: boolean; - } - /** - * Specifies the options to be included in a search operation. - To learn more about how to use search options in the Word JavaScript APIs, read {@link https://learn.microsoft.com/office/dev/add-ins/word/search-option-guidance | Use search options to find text in your Word add-in}. - * - * @remarks - * [Api set: WordApi 1.1] - */ - interface SearchOptionsLoadOptions { - /** - Specifying `$all` 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; + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - * Specifies a value that indicates whether to ignore all punctuation characters between words. Corresponds to the Ignore punctuation check box in the Find and Replace dialog box. + * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - ignorePunct?: boolean; + alignment?: boolean; /** - * Specifies a value that indicates whether to ignore all whitespace between words. Corresponds to the Ignore whitespace characters check box in the Find and Replace dialog box. + * Specifies the description of the table. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - ignoreSpace?: boolean; + description?: boolean; /** - * Specifies a value that indicates whether to perform a case sensitive search. Corresponds to the Match case check box in the Find and Replace dialog box. + * Specifies the number of header rows. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - matchCase?: boolean; + headerRowCount?: boolean; /** - * Specifies a value that indicates whether to match words that begin with the search string. Corresponds to the Match prefix check box in the Find and Replace dialog box. + * Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - matchPrefix?: boolean; + horizontalAlignment?: boolean; /** - * Specifies a value that indicates whether to match words that end with the search string. Corresponds to the Match suffix check box in the Find and Replace dialog box. + * Indicates whether all of the table rows are uniform. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - matchSuffix?: boolean; + isUniform?: boolean; /** - * Specifies a value that indicates whether to find operation only entire words, not text that is part of a larger word. Corresponds to the Find whole words only check box in the Find and Replace dialog box. + * Gets the nesting level of the table. Top-level tables have level 1. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - matchWholeWord?: boolean; + nestingLevel?: boolean; /** - * Specifies a value that indicates whether the search will be performed using special search operators. Corresponds to the Use wildcards check box in the Find and Replace dialog box. + * Gets the number of rows in the table. * * @remarks - * [Api set: WordApi 1.1] - */ - matchWildcards?: boolean; - } - /** - * Represents a section in a Word document. - * - * @remarks - * [Api set: WordApi 1.1] - */ - interface SectionLoadOptions { - /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * [Api set: WordApi 1.3] */ - $all?: boolean; + rowCount?: boolean; /** - * Gets the body object of the section. This doesn't include the header/footer and other section metadata. + * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - body?: Word.Interfaces.BodyLoadOptions; + shadingColor?: boolean; /** - * Returns a `PageSetup` object that's associated with the section. + * Specifies the style name for the table. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - pageSetup?: Word.Interfaces.PageSetupLoadOptions; + style?: boolean; /** - * Specifies if the section is protected for forms. + * Specifies whether the table has banded columns. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - protectedForForms?: boolean; - } - /** - * Contains the collection of the document's {@link Word.Section} objects. - * - * @remarks - * [Api set: WordApi 1.1] - */ - interface SectionCollectionLoadOptions { - /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * [Api set: WordApi 1.3] */ - $all?: boolean; + styleBandedColumns?: boolean; /** - * For EACH ITEM in the collection: Gets the body object of the section. This doesn't include the header/footer and other section metadata. + * Specifies whether the table has banded rows. * * @remarks - * [Api set: WordApi 1.1] + * [Api set: WordApi 1.3] */ - body?: Word.Interfaces.BodyLoadOptions; + styleBandedRows?: boolean; /** - * For EACH ITEM in the collection: Returns a `PageSetup` object that's associated with the section. + * Specifies the built-in style name for the table. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - pageSetup?: Word.Interfaces.PageSetupLoadOptions; + styleBuiltIn?: boolean; /** - * For EACH ITEM in the collection: Specifies if the section is protected for forms. + * Specifies whether the table has a first column with a special style. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - protectedForForms?: boolean; - } - /** - * Represents a setting of the add-in. - * - * @remarks - * [Api set: WordApi 1.4] - */ - interface SettingLoadOptions { + styleFirstColumn?: boolean; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * Specifies whether the table has a last column with a special style. + * + * @remarks + * [Api set: WordApi 1.3] */ - $all?: boolean; + styleLastColumn?: boolean; /** - * Gets the key of the setting. + * Specifies whether the table has a total (last) row with a special style. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - key?: boolean; + styleTotalRow?: boolean; /** - * Specifies the value of the setting. + * Specifies the title of the table. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - value?: boolean; - } - /** - * Contains the collection of {@link Word.Setting} objects. - * - * @remarks - * [Api set: WordApi 1.4] - */ - interface SettingCollectionLoadOptions { + title?: boolean; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * Specifies the text values in the table, as a 2D JavaScript array. + * + * @remarks + * [Api set: WordApi 1.3] */ - $all?: boolean; + values?: boolean; /** - * For EACH ITEM in the collection: Gets the key of the setting. + * Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - key?: boolean; + verticalAlignment?: boolean; /** - * For EACH ITEM in the collection: Specifies the value of the setting. + * Specifies the width of the table in points. * * @remarks - * [Api set: WordApi 1.4] + * [Api set: WordApi 1.3] */ - value?: boolean; + width?: boolean; } /** - * Contains a collection of {@link Word.Style} objects. + * Represents the TableStyle object. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.6] */ - interface StyleCollectionLoadOptions { + interface TableStyleLoadOptions { /** Specifying `$all` 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 a BorderCollection object that represents all the borders for the specified style. - * - * @remarks - * [Api set: WordApiDesktop 1.1] - */ - borders?: Word.Interfaces.BorderCollectionLoadOptions; - /** - * For EACH ITEM in the collection: Gets a font object that represents the character formatting of the specified style. - * - * @remarks - * [Api set: WordApi 1.5] - */ - font?: Word.Interfaces.FontLoadOptions; - /** - * For EACH ITEM in the collection: Returns a `Frame` object that represents the frame formatting for the style. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the table style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - frame?: Word.Interfaces.FrameLoadOptions; + shading?: Word.Interfaces.ShadingLoadOptions; /** - * For EACH ITEM in the collection: Specifies a link between a paragraph and a character style. + * Specifies the table's alignment against the page margin. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApiDesktop 1.1] */ - linkStyle?: Word.Interfaces.StyleLoadOptions; + alignment?: boolean; /** - * For EACH ITEM in the collection: Gets a ListTemplate object that represents the list formatting for the specified Style object. + * Specifies whether lines in tables formatted with a specified style break across pages. * * @remarks * [Api set: WordApiDesktop 1.1] */ - listTemplate?: Word.Interfaces.ListTemplateLoadOptions; + allowBreakAcrossPage?: boolean; /** - * For EACH ITEM in the collection: Gets a ParagraphFormat object that represents the paragraph settings for the specified style. + * Specifies the amount of space to add between the contents and the bottom borders of the cells. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.6] */ - paragraphFormat?: Word.Interfaces.ParagraphFormatLoadOptions; + bottomCellMargin?: boolean; /** - * For EACH ITEM in the collection: Gets a Shading object that represents the shading for the specified style. Not applicable to List style. + * Specifies the spacing (in points) between the cells in a table style. * * @remarks * [Api set: WordApi 1.6] */ - shading?: Word.Interfaces.ShadingLoadOptions; + cellSpacing?: boolean; /** - * For EACH ITEM in the collection: Gets a TableStyle object representing Style properties that can be applied to a table. + * Specifies the number of columns in the banding when a style specifies odd- or even-column banding. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - tableStyle?: Word.Interfaces.TableStyleLoadOptions; + columnStripe?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the style is automatically redefined based on the selection. + * Specifies whether Microsoft Word allows to break the specified table across pages. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - automaticallyUpdate?: boolean; + isBreakAcrossPagesAllowed?: boolean; /** - * For EACH ITEM in the collection: Specifies the name of an existing style to use as the base formatting of another style. + * Specifies the amount of space to add between the contents and the left borders of the cells. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.6] + */ + leftCellMargin?: boolean; + /** + * Specifies the left indent value (in points) for the rows in the table style. * - * Note: The ability to set `baseStyle` was introduced in WordApi 1.6. + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - baseStyle?: boolean; + leftIndent?: boolean; /** - * For EACH ITEM in the collection: Gets whether the specified style is a built-in style. + * Specifies the amount of space to add between the contents and the right borders of the cells. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.6] */ - builtIn?: boolean; + rightCellMargin?: boolean; /** - * For EACH ITEM in the collection: Gets the description of the specified style. + * Specifies the number of rows to include in the banding when the style specifies odd- or even-row banding. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - description?: boolean; + rowStripe?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the spelling and grammar checker ignores text formatted with this style. + * Specifies the direction in which Microsoft Word orders cells in the table style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - hasProofing?: boolean; + tableDirection?: boolean; /** - * For EACH ITEM in the collection: Gets whether the specified style is a built-in style that has been modified or applied in the document or a new style that has been created in the document. + * Specifies the amount of space to add between the contents and the top borders of the cells. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.6] */ - inUse?: boolean; + topCellMargin?: boolean; + } + /** + * Represents a tab stop in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface TabStopLoadOptions { /** - * For EACH ITEM in the collection: Specifies a `LanguageId` value that represents the language for the style. + Specifying `$all` 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 next tab stop in the collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageId?: boolean; + next?: Word.Interfaces.TabStopLoadOptions; /** - * For EACH ITEM in the collection: Specifies an East Asian language for the style. + * Gets the previous tab stop in the collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - languageIdFarEast?: boolean; + previous?: Word.Interfaces.TabStopLoadOptions; /** - * For EACH ITEM in the collection: Gets whether a style is a linked style that can be used for both paragraph and character formatting. + * Gets a `TabAlignment` value that represents the alignment for the tab stop. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - linked?: boolean; + alignment?: boolean; /** - * For EACH ITEM in the collection: Returns the list level for the style. + * Gets whether this tab stop is a custom tab stop. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listLevelNumber?: boolean; + customTab?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the style cannot be changed or edited. + * Gets a `TabLeader` value that represents the leader for this `TabStop` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - locked?: boolean; + leader?: boolean; /** - * For EACH ITEM in the collection: Gets the name of a style in the language of the user. + * Gets the position of the tab stop relative to the left margin. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - nameLocal?: boolean; + position?: boolean; + } + /** + * Represents a collection of {@link Word.TabStop | tab stops} in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface TabStopCollectionLoadOptions { /** - * For EACH ITEM in the collection: Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style. - * - * @remarks - * [Api set: WordApi 1.5] - * - * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ - nextParagraphStyle?: boolean; + $all?: boolean; /** - * For EACH ITEM in the collection: Specifies whether to remove spacing between paragraphs that are formatted using the same style. + * For EACH ITEM in the collection: Gets the next tab stop in the collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - noSpaceBetweenParagraphsOfSameStyle?: boolean; + next?: Word.Interfaces.TabStopLoadOptions; /** - * For EACH ITEM in the collection: Specifies the priority. + * For EACH ITEM in the collection: Gets the previous tab stop in the collection. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - priority?: boolean; + previous?: Word.Interfaces.TabStopLoadOptions; /** - * For EACH ITEM in the collection: Specifies whether the style corresponds to an available quick style. + * For EACH ITEM in the collection: Gets a `TabAlignment` value that represents the alignment for the tab stop. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - quickStyle?: boolean; + alignment?: boolean; /** - * For EACH ITEM in the collection: Gets the style type. + * For EACH ITEM in the collection: Gets whether this tab stop is a custom tab stop. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - type?: boolean; + customTab?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the specified style is made visible as a recommended style in the Styles and in the Styles task pane in Microsoft Word after it's used in the document. + * For EACH ITEM in the collection: Gets a `TabLeader` value that represents the leader for this `TabStop` object. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - unhideWhenUsed?: boolean; + leader?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane. + * For EACH ITEM in the collection: Gets the position of the tab stop relative to the left margin. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - visibility?: boolean; + position?: boolean; } /** - * Represents a style in a Word document. + * Contains the collection of the document's Table objects. * * @remarks * [Api set: WordApi 1.3] */ - interface StyleLoadOptions { + interface TableCollectionLoadOptions { /** Specifying `$all` 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 a BorderCollection object that represents all the borders for the specified style. + * For EACH ITEM in the collection: Gets the font. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - borders?: Word.Interfaces.BorderCollectionLoadOptions; + font?: Word.Interfaces.FontLoadOptions; /** - * Gets a font object that represents the character formatting of the specified style. + * For EACH ITEM in the collection: Gets the parent body of the table. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - font?: Word.Interfaces.FontLoadOptions; + parentBody?: Word.Interfaces.BodyLoadOptions; /** - * Returns a `Frame` object that represents the frame formatting for the style. + * For EACH ITEM in the collection: Gets the content control that contains the table. Throws an `ItemNotFound` error if there isn't a parent content control. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - frame?: Word.Interfaces.FrameLoadOptions; + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Specifies a link between a paragraph and a character style. + * For EACH ITEM in the collection: Gets the content control that contains the table. If there isn't a parent content control, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - linkStyle?: Word.Interfaces.StyleLoadOptions; + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Gets a ListTemplate object that represents the list formatting for the specified Style object. + * For EACH ITEM in the collection: Gets the table that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - listTemplate?: Word.Interfaces.ListTemplateLoadOptions; + parentTable?: Word.Interfaces.TableLoadOptions; /** - * Gets a ParagraphFormat object that represents the paragraph settings for the specified style. + * For EACH ITEM in the collection: Gets the table cell that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table cell. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - paragraphFormat?: Word.Interfaces.ParagraphFormatLoadOptions; + parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * Gets a Shading object that represents the shading for the specified style. Not applicable to List style. + * For EACH ITEM in the collection: Gets the table cell that contains this table. If it isn't contained in a table cell, then this method will return 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: WordApi 1.6] + * [Api set: WordApi 1.3] */ - shading?: Word.Interfaces.ShadingLoadOptions; + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * Gets a TableStyle object representing Style properties that can be applied to a table. + * For EACH ITEM in the collection: Gets the table that contains this table. If it isn't contained in a table, then this method will return 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: WordApi 1.6] + * [Api set: WordApi 1.3] */ - tableStyle?: Word.Interfaces.TableStyleLoadOptions; + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * Specifies whether the style is automatically redefined based on the selection. + * For EACH ITEM in the collection: Returns the `ShadingUniversal` object that represents the shading of the table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - automaticallyUpdate?: boolean; - /** - * Specifies the name of an existing style to use as the base formatting of another style. - * - * @remarks - * [Api set: WordApi 1.5] - * - * Note: The ability to set `baseStyle` was introduced in WordApi 1.6. - */ - baseStyle?: boolean; + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - * Gets whether the specified style is a built-in style. + * For EACH ITEM in the collection: Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - builtIn?: boolean; + alignment?: boolean; /** - * Gets the description of the specified style. + * For EACH ITEM in the collection: Specifies the description of the table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -154462,917 +165007,981 @@ declare namespace Word { */ description?: boolean; /** - * Specifies whether the spelling and grammar checker ignores text formatted with this style. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - hasProofing?: boolean; - /** - * Gets whether the specified style is a built-in style that has been modified or applied in the document or a new style that has been created in the document. + * For EACH ITEM in the collection: Specifies the number of header rows. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - inUse?: boolean; + headerRowCount?: boolean; /** - * Specifies a `LanguageId` value that represents the language for the style. + * For EACH ITEM in the collection: Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - languageId?: boolean; + horizontalAlignment?: boolean; /** - * Specifies an East Asian language for the style. + * For EACH ITEM in the collection: Indicates whether all of the table rows are uniform. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - languageIdFarEast?: boolean; + isUniform?: boolean; /** - * Gets whether a style is a linked style that can be used for both paragraph and character formatting. + * For EACH ITEM in the collection: Gets the nesting level of the table. Top-level tables have level 1. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - linked?: boolean; + nestingLevel?: boolean; /** - * Returns the list level for the style. + * For EACH ITEM in the collection: Gets the number of rows in the table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - listLevelNumber?: boolean; + rowCount?: boolean; /** - * Specifies whether the style cannot be changed or edited. + * For EACH ITEM in the collection: Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - locked?: boolean; + shadingColor?: boolean; /** - * Gets the name of a style in the language of the user. + * For EACH ITEM in the collection: Specifies the style name for the table. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - nameLocal?: boolean; + style?: boolean; /** - * Specifies the name of the style to be applied automatically to a new paragraph that is inserted after a paragraph formatted with the specified style. + * For EACH ITEM in the collection: Specifies whether the table has banded columns. * * @remarks - * [Api set: WordApi 1.5] - * - * Note: The ability to set `nextParagraphStyle` was introduced in WordApi 1.6. + * [Api set: WordApi 1.3] */ - nextParagraphStyle?: boolean; + styleBandedColumns?: boolean; /** - * Specifies whether to remove spacing between paragraphs that are formatted using the same style. + * For EACH ITEM in the collection: Specifies whether the table has banded rows. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - noSpaceBetweenParagraphsOfSameStyle?: boolean; + styleBandedRows?: boolean; /** - * Specifies the priority. + * For EACH ITEM in the collection: Specifies the built-in style name for the table. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - priority?: boolean; + styleBuiltIn?: boolean; /** - * Specifies whether the style corresponds to an available quick style. + * For EACH ITEM in the collection: Specifies whether the table has a first column with a special style. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - quickStyle?: boolean; + styleFirstColumn?: boolean; /** - * Gets the style type. + * For EACH ITEM in the collection: Specifies whether the table has a last column with a special style. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - type?: boolean; + styleLastColumn?: boolean; /** - * Specifies whether the specified style is made visible as a recommended style in the Styles and in the Styles task pane in Microsoft Word after it's used in the document. + * For EACH ITEM in the collection: Specifies whether the table has a total (last) row with a special style. * * @remarks - * [Api set: WordApi 1.5] + * [Api set: WordApi 1.3] */ - unhideWhenUsed?: boolean; + styleTotalRow?: boolean; /** - * Specifies whether the specified style is visible as a recommended style in the Styles gallery and in the Styles task pane. + * For EACH ITEM in the collection: Specifies the title of the table. * * @remarks - * [Api set: WordApi 1.5] - */ - visibility?: boolean; - } - /** - * Represents the shading object. - * - * @remarks - * [Api set: WordApi 1.6] - */ - interface ShadingLoadOptions { - /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + title?: boolean; /** - * Specifies the color for the background of the object. You can provide the value in the '#RRGGBB' format or the color name. + * For EACH ITEM in the collection: Specifies the text values in the table, as a 2D JavaScript array. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi 1.3] */ - backgroundPatternColor?: boolean; + values?: boolean; /** - * Specifies the color for the foreground of the object. You can provide the value in the '#RRGGBB' format or the color name. + * For EACH ITEM in the collection: Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - foregroundPatternColor?: boolean; + verticalAlignment?: boolean; /** - * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. + * For EACH ITEM in the collection: Specifies the width of the table in points. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi 1.3] */ - texture?: boolean; + width?: boolean; } /** - * Represents the `ShadingUniversal` object, which manages shading for a range, paragraph, frame, or table. + * Represents a table column in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface ShadingUniversalLoadOptions { + 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; /** - * Specifies the color that's applied to the background of the `ShadingUniversal` object. You can provide the value in the '#RRGGBB' format. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - backgroundPatternColor?: boolean; + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - * Specifies the color that's applied to the background of the `ShadingUniversal` object. + * Returns the position of this column in a collection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - backgroundPatternColorIndex?: boolean; + columnIndex?: boolean; /** - * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. You can provide the value in the '#RRGGBB' format. + * Returns `true` if the column or row is the first one in the table; `false` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - foregroundPatternColor?: boolean; + isFirst?: boolean; /** - * Specifies the color that's applied to the foreground of the `ShadingUniversal` object. This color is applied to the dots and lines in the shading pattern. + * Returns `true` if the column or row is the last one in the table; `false` otherwise. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - foregroundPatternColorIndex?: boolean; + isLast?: boolean; /** - * Specifies the shading texture of the object. To learn more about how to apply backgrounds like textures, see {@link https://support.microsoft.com/office/db481e61-7af6-4063-bbcd-b276054a5515 | Add, change, or delete the background color in Word}. + * Returns the nesting level of the column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - texture?: boolean; - } - /** - * Represents a table in a Word document. - * - * @remarks - * [Api set: WordApi 1.3] - */ - 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 font. Use this to get and set font name, size, color, and other properties. - * - * @remarks - * [Api set: WordApi 1.3] - */ - font?: Word.Interfaces.FontLoadOptions; - /** - * Gets the parent body of the table. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentBody?: Word.Interfaces.BodyLoadOptions; - /** - * Gets the content control that contains the table. Throws an `ItemNotFound` error if there isn't a parent content control. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; - /** - * Gets the content control that contains the table. If there isn't a parent content control, then this method will return 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: WordApi 1.3] - */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; - /** - * Gets the table that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentTable?: Word.Interfaces.TableLoadOptions; - /** - * Gets the table cell that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table cell. - * - * @remarks - * [Api set: WordApi 1.3] - */ - parentTableCell?: Word.Interfaces.TableCellLoadOptions; - /** - * Gets the table cell that contains this table. If it isn't contained in a table cell, then this method will return 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: WordApi 1.3] - */ - parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; - /** - * Gets the table that contains this table. If it isn't contained in a table, then this method will return 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: WordApi 1.3] - */ - parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + nestingLevel?: boolean; /** - * Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. + * Specifies the preferred width (in points or as a percentage of the window width) for the column. + The unit of measurement can be specified by the `preferredWidthType` property. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: boolean; + preferredWidth?: boolean; /** - * Specifies the number of header rows. + * Specifies the preferred unit of measurement to use for the width of the table column. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - headerRowCount?: boolean; + preferredWidthType?: boolean; /** - * Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Specifies the width of the column, in points. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - horizontalAlignment?: boolean; + width?: boolean; + } + /** + * Represents a collection of {@link Word.TableColumn} objects in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface TableColumnCollectionLoadOptions { /** - * Indicates whether all of the table rows are uniform. - * - * @remarks - * [Api set: WordApi 1.3] + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ - isUniform?: boolean; + $all?: boolean; /** - * Gets the nesting level of the table. Top-level tables have level 1. + * For EACH ITEM in the collection: Returns a `ShadingUniversal` object that refers to the shading formatting for the column. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - nestingLevel?: boolean; + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - * Gets the number of rows in the table. + * For EACH ITEM in the collection: Returns the position of this column in a collection. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rowCount?: boolean; + columnIndex?: boolean; /** - * Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + * For EACH ITEM in the collection: Returns `true` if the column or row is the first one in the table; `false` otherwise. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shadingColor?: boolean; + isFirst?: boolean; /** - * Specifies the style name for the table. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * For EACH ITEM in the collection: Returns `true` if the column or row is the last one in the table; `false` otherwise. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: boolean; + isLast?: boolean; /** - * Specifies whether the table has banded columns. + * For EACH ITEM in the collection: Returns the nesting level of the column. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBandedColumns?: boolean; + nestingLevel?: boolean; /** - * Specifies whether the table has banded rows. + * For EACH ITEM in the collection: Specifies the preferred width (in points or as a percentage of the window width) for the column. + The unit of measurement can be specified by the `preferredWidthType` property. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBandedRows?: boolean; + preferredWidth?: boolean; /** - * Specifies the built-in style name for the table. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * For EACH ITEM in the collection: Specifies the preferred unit of measurement to use for the width of the table column. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBuiltIn?: boolean; + preferredWidthType?: boolean; /** - * Specifies whether the table has a first column with a special style. + * For EACH ITEM in the collection: Specifies the width of the column, in points. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleFirstColumn?: boolean; + width?: boolean; + } + /** + * Represents a table of authorities in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface TableOfAuthoritiesLoadOptions { /** - * Specifies whether the table has a last column with a special style. - * - * @remarks - * [Api set: WordApi 1.3] + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ - styleLastColumn?: boolean; + $all?: boolean; /** - * Specifies whether the table has a total (last) row with a special style. + * Gets the portion of a document that is this table of authorities. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleTotalRow?: boolean; + range?: Word.Interfaces.RangeLoadOptions; /** - * Specifies the text values in the table, as a 2D JavaScript array. + * Specifies the name of the bookmark from which to collect table of authorities entries. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - values?: boolean; + bookmark?: boolean; /** - * Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. + * Specifies the category of entries to be included in the table of authorities. + Values 0 through 16 correspond to the items listed in the Category box of the Table of Authorities dialog. To learn how to access this through the Word UI, see {@link https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0 | Create a table of authorities}. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - verticalAlignment?: boolean; + category?: boolean; /** - * Specifies the width of the table in points. + * Specifies a separator of up to five characters. This appears between the table of authorities entry and its page number. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: boolean; - } - /** - * Represents the TableStyle object. - * - * @remarks - * [Api set: WordApi 1.6] - */ - interface TableStyleLoadOptions { + entrySeparator?: boolean; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * Specifies whether the category name for a group of entries appears in the table of authorities. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + isCategoryHeaderIncluded?: boolean; /** - * Specifies the table's alignment against the page margin. + * Specifies whether the entries in the table of authorities are displayed with their formatting in the table. * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: boolean; + isEntryFormattingKept?: boolean; /** - * Specifies whether lines in tables formatted with a specified style break across pages. + * Specifies whether references to the same authority that are repeated on five or more pages are replaced with "Passim". * * @remarks - * [Api set: WordApiDesktop 1.1] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - allowBreakAcrossPage?: boolean; + isPassimUsed?: boolean; /** - * Specifies the amount of space to add between the contents and the bottom borders of the cells. + * Specifies a separator of up to five characters. This appears between individual page references in the table of authorities. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - bottomCellMargin?: boolean; + pageNumberSeparator?: boolean; /** - * Specifies the spacing (in points) between the cells in a table style. + * Specifies a separator of up to five characters. This appears between ranges of pages in the table of authorities. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - cellSpacing?: boolean; + pageRangeSeparator?: boolean; /** - * Specifies the amount of space to add between the contents and the left borders of the cells. + * Specifies the {@link https://support.microsoft.com/office/062a387b-dfc9-4ef8-8235-29ee113d59be | Sequence (SEQ) field} identifier for the table of authorities. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - leftCellMargin?: boolean; + sequenceName?: boolean; /** - * Specifies the amount of space to add between the contents and the right borders of the cells. + * Specifies a separator of up to five characters. This appears between the sequence number and the page number in the table of authorities. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rightCellMargin?: boolean; + sequenceSeparator?: boolean; /** - * Specifies the amount of space to add between the contents and the top borders of the cells. + * Specifies the leader character that appears between entries and their associated page numbers in the table of authorities. * * @remarks - * [Api set: WordApi 1.6] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - topCellMargin?: boolean; + tabLeader?: boolean; } /** - * Represents a tab stop in a Word document. + * Represents a collection of {@link Word.TableOfAuthorities} objects in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface TabStopLoadOptions { + interface TableOfAuthoritiesCollectionLoadOptions { /** Specifying `$all` 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 next tab stop in the collection. + * For EACH ITEM in the collection: Gets the portion of a document that is this table of authorities. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - next?: Word.Interfaces.TabStopLoadOptions; + range?: Word.Interfaces.RangeLoadOptions; /** - * Gets the previous tab stop in the collection. + * For EACH ITEM in the collection: Specifies the name of the bookmark from which to collect table of authorities entries. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - previous?: Word.Interfaces.TabStopLoadOptions; + bookmark?: boolean; /** - * Gets a `TabAlignment` value that represents the alignment for the tab stop. + * For EACH ITEM in the collection: Specifies the category of entries to be included in the table of authorities. + Values 0 through 16 correspond to the items listed in the Category box of the Table of Authorities dialog. To learn how to access this through the Word UI, see {@link https://support.microsoft.com/office/ddd126ae-52bc-4299-9558-06dd0e4fe8c0 | Create a table of authorities}. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - alignment?: boolean; + category?: boolean; /** - * Gets whether this tab stop is a custom tab stop. + * For EACH ITEM in the collection: Specifies a separator of up to five characters. This appears between the table of authorities entry and its page number. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customTab?: boolean; + entrySeparator?: boolean; /** - * Gets a `TabLeader` value that represents the leader for this `TabStop` object. + * For EACH ITEM in the collection: Specifies whether the category name for a group of entries appears in the table of authorities. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - leader?: boolean; + isCategoryHeaderIncluded?: boolean; /** - * Gets the position of the tab stop relative to the left margin. + * For EACH ITEM in the collection: Specifies whether the entries in the table of authorities are displayed with their formatting in the table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - position?: boolean; - } - /** - * Represents a collection of {@link Word.TabStop | tab stops} in a Word document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface TabStopCollectionLoadOptions { - /** - Specifying `$all` 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; + isEntryFormattingKept?: boolean; /** - * For EACH ITEM in the collection: Gets the next tab stop in the collection. + * For EACH ITEM in the collection: Specifies whether references to the same authority that are repeated on five or more pages are replaced with "Passim". * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - next?: Word.Interfaces.TabStopLoadOptions; + isPassimUsed?: boolean; /** - * For EACH ITEM in the collection: Gets the previous tab stop in the collection. + * For EACH ITEM in the collection: Specifies a separator of up to five characters. This appears between individual page references in the table of authorities. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - previous?: Word.Interfaces.TabStopLoadOptions; + pageNumberSeparator?: boolean; /** - * For EACH ITEM in the collection: Gets a `TabAlignment` value that represents the alignment for the tab stop. + * For EACH ITEM in the collection: Specifies a separator of up to five characters. This appears between ranges of pages in the table of authorities. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - alignment?: boolean; + pageRangeSeparator?: boolean; /** - * For EACH ITEM in the collection: Gets whether this tab stop is a custom tab stop. + * For EACH ITEM in the collection: Specifies the {@link https://support.microsoft.com/office/062a387b-dfc9-4ef8-8235-29ee113d59be | Sequence (SEQ) field} identifier for the table of authorities. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - customTab?: boolean; + sequenceName?: boolean; /** - * For EACH ITEM in the collection: Gets a `TabLeader` value that represents the leader for this `TabStop` object. + * For EACH ITEM in the collection: Specifies a separator of up to five characters. This appears between the sequence number and the page number in the table of authorities. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - leader?: boolean; + sequenceSeparator?: boolean; /** - * For EACH ITEM in the collection: Gets the position of the tab stop relative to the left margin. + * For EACH ITEM in the collection: Specifies the leader character that appears between entries and their associated page numbers in the table of authorities. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - position?: boolean; + tabLeader?: boolean; } /** - * Contains the collection of the document's Table objects. + * Represents a category used in a table of authorities. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - interface TableCollectionLoadOptions { + interface TableOfAuthoritiesCategoryLoadOptions { /** Specifying `$all` 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 font. Use this to get and set font name, size, color, and other properties. + * Specifies the name of this table of authorities category. + Changing the name of the category doesn't change the index in the collection. The value for {@link Word.TableOfAuthorities | TableOfAuthorities.category} will remain the same. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - font?: Word.Interfaces.FontLoadOptions; + name?: boolean; + } + /** + * Represents a collection of {@link Word.TableOfAuthoritiesCategory} objects in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface TableOfAuthoritiesCategoryCollectionLoadOptions { /** - * For EACH ITEM in the collection: Gets the parent body of the table. - * - * @remarks - * [Api set: WordApi 1.3] + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ - parentBody?: Word.Interfaces.BodyLoadOptions; + $all?: boolean; /** - * For EACH ITEM in the collection: Gets the content control that contains the table. Throws an `ItemNotFound` error if there isn't a parent content control. + * For EACH ITEM in the collection: Specifies the name of this table of authorities category. + Changing the name of the category doesn't change the index in the collection. The value for {@link Word.TableOfAuthorities | TableOfAuthorities.category} will remain the same. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentContentControl?: Word.Interfaces.ContentControlLoadOptions; + name?: boolean; + } + /** + * Represents a table of contents in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface TableOfContentsLoadOptions { /** - * For EACH ITEM in the collection: Gets the content control that contains the table. If there isn't a parent content control, then this method will return 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: WordApi 1.3] + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ - parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; + $all?: boolean; /** - * For EACH ITEM in the collection: Gets the table that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table. + * Gets the portion of a document that is this table of contents. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeLoadOptions; + /** + * Specifies whether built-in heading styles are used for the table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTable?: Word.Interfaces.TableLoadOptions; + areBuiltInHeadingStylesUsed?: boolean; /** - * For EACH ITEM in the collection: Gets the table cell that contains this table. Throws an `ItemNotFound` error if it isn't contained in a table cell. + * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTableCell?: Word.Interfaces.TableCellLoadOptions; + areFieldsUsed?: boolean; /** - * For EACH ITEM in the collection: Gets the table cell that contains this table. If it isn't contained in a table cell, then this method will return 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 whether entries in the table of contents should be formatted as hyperlinks when publishing to the web. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; + areHyperlinksUsedOnWeb?: boolean; /** - * For EACH ITEM in the collection: Gets the table that contains this table. If it isn't contained in a table, then this method will return 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 whether the page numbers in the table of contents should be hidden when publishing to the web. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; + arePageNumbersHiddenOnWeb?: boolean; /** - * For EACH ITEM in the collection: Specifies the alignment of the table against the page column. The value can be 'Left', 'Centered', or 'Right'. + * Specifies whether page numbers are included in the table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - alignment?: boolean; + arePageNumbersIncluded?: boolean; /** - * For EACH ITEM in the collection: Specifies the number of header rows. + * Specifies whether page numbers are aligned with the right margin in the table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - headerRowCount?: boolean; + arePageNumbersRightAligned?: boolean; /** - * For EACH ITEM in the collection: Specifies the horizontal alignment of every cell in the table. The value can be 'Left', 'Centered', 'Right', or 'Justified'. + * Specifies the ending heading level for the table of contents. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - horizontalAlignment?: boolean; + lowerHeadingLevel?: boolean; /** - * For EACH ITEM in the collection: Indicates whether all of the table rows are uniform. + * Specifies the character between entries and their page numbers in the table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - isUniform?: boolean; + tabLeader?: boolean; /** - * For EACH ITEM in the collection: Gets the nesting level of the table. Top-level tables have level 1. + * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - nestingLevel?: boolean; + tableId?: boolean; /** - * For EACH ITEM in the collection: Gets the number of rows in the table. + * Specifies the starting heading level for the table of contents. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - rowCount?: boolean; + upperHeadingLevel?: boolean; + } + /** + * Represents a collection of {@link Word.TableOfContents} objects in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface TableOfContentsCollectionLoadOptions { /** - * For EACH ITEM in the collection: Specifies the shading color. Color is specified in "#RRGGBB" format or by using the color name. + Specifying `$all` 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 portion of a document that is this table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - shadingColor?: boolean; + range?: Word.Interfaces.RangeLoadOptions; /** - * For EACH ITEM in the collection: Specifies the style name for the table. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * For EACH ITEM in the collection: Specifies whether built-in heading styles are used for the table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - style?: boolean; + areBuiltInHeadingStylesUsed?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the table has banded columns. + * For EACH ITEM in the collection: Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBandedColumns?: boolean; + areFieldsUsed?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the table has banded rows. + * For EACH ITEM in the collection: Specifies whether entries in the table of contents should be formatted as hyperlinks when publishing to the web. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBandedRows?: boolean; + areHyperlinksUsedOnWeb?: boolean; /** - * For EACH ITEM in the collection: Specifies the built-in style name for the table. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * For EACH ITEM in the collection: Specifies whether the page numbers in the table of contents should be hidden when publishing to the web. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleBuiltIn?: boolean; + arePageNumbersHiddenOnWeb?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the table has a first column with a special style. + * For EACH ITEM in the collection: Specifies whether page numbers are included in the table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleFirstColumn?: boolean; + arePageNumbersIncluded?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the table has a last column with a special style. + * For EACH ITEM in the collection: Specifies whether page numbers are aligned with the right margin in the table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleLastColumn?: boolean; + arePageNumbersRightAligned?: boolean; /** - * For EACH ITEM in the collection: Specifies whether the table has a total (last) row with a special style. + * For EACH ITEM in the collection: Specifies the ending heading level for the table of contents. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - styleTotalRow?: boolean; + lowerHeadingLevel?: boolean; /** - * For EACH ITEM in the collection: Specifies the text values in the table, as a 2D JavaScript array. + * For EACH ITEM in the collection: Specifies the character between entries and their page numbers in the table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - values?: boolean; + tabLeader?: boolean; /** - * For EACH ITEM in the collection: Specifies the vertical alignment of every cell in the table. The value can be 'Top', 'Center', or 'Bottom'. + * For EACH ITEM in the collection: Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of contents. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - verticalAlignment?: boolean; + tableId?: boolean; /** - * For EACH ITEM in the collection: Specifies the width of the table in points. + * For EACH ITEM in the collection: Specifies the starting heading level for the table of contents. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. * * @remarks - * [Api set: WordApi 1.3] + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - width?: boolean; + upperHeadingLevel?: boolean; } /** - * Represents a table column in a Word document. + * Represents a table of figures in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface TableColumnLoadOptions { + interface TableOfFiguresLoadOptions { /** Specifying `$all` 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 `ShadingUniversal` object that refers to the shading formatting for the column. + * Gets the portion of a document that is this table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shading?: Word.Interfaces.ShadingUniversalLoadOptions; + range?: Word.Interfaces.RangeLoadOptions; /** - * Returns the position of this column in a collection. + * Specifies whether built-in heading styles are used for the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - columnIndex?: boolean; + areBuiltInHeadingStylesUsed?: boolean; /** - * Returns `true` if the column or row is the first one in the table; `false` otherwise. + * Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isFirst?: boolean; + areFieldsUsed?: boolean; /** - * Returns `true` if the column or row is the last one in the table; `false` otherwise. + * Specifies whether entries in the table of figures should be formatted as hyperlinks when publishing to the web. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isLast?: boolean; + areHyperlinksUsedOnWeb?: boolean; /** - * Returns the nesting level of the column. + * Specifies whether the page numbers in the table of figures should be hidden when publishing to the web. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nestingLevel?: boolean; + arePageNumbersHiddenOnWeb?: boolean; /** - * Specifies the preferred width (in points or as a percentage of the window width) for the column. - The unit of measurement can be specified by the `preferredWidthType` property. + * Specifies whether page numbers are included in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - preferredWidth?: boolean; + arePageNumbersIncluded?: boolean; /** - * Specifies the preferred unit of measurement to use for the width of the table column. + * Specifies whether page numbers are aligned with the right margin in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - preferredWidthType?: boolean; + arePageNumbersRightAligned?: boolean; /** - * Specifies the width of the column, in points. + * Specifies the label that identifies the items to be included in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - width?: boolean; + captionLabel?: boolean; + /** + * Specifies whether the caption label and caption number are included in the table of figures. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isLabelIncluded?: boolean; + /** + * Specifies the ending heading level for the table of figures. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lowerHeadingLevel?: boolean; + /** + * Specifies the character between entries and their page numbers in the table of figures. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tabLeader?: boolean; + /** + * Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of figures. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tableId?: boolean; + /** + * Specifies the starting heading level for the table of figures. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + upperHeadingLevel?: boolean; } /** - * Represents a collection of {@link Word.TableColumn} objects in a Word document. + * Represents a collection of {@link Word.TableOfFigures} objects in a Word document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface TableColumnCollectionLoadOptions { + interface TableOfFiguresCollectionLoadOptions { /** Specifying `$all` 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 a `ShadingUniversal` object that refers to the shading formatting for the column. + * For EACH ITEM in the collection: Gets the portion of a document that is this table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shading?: Word.Interfaces.ShadingUniversalLoadOptions; + range?: Word.Interfaces.RangeLoadOptions; /** - * For EACH ITEM in the collection: Returns the position of this column in a collection. + * For EACH ITEM in the collection: Specifies whether built-in heading styles are used for the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - columnIndex?: boolean; + areBuiltInHeadingStylesUsed?: boolean; /** - * For EACH ITEM in the collection: Returns `true` if the column or row is the first one in the table; `false` otherwise. + * For EACH ITEM in the collection: Specifies whether {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} are included in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isFirst?: boolean; + areFieldsUsed?: boolean; /** - * For EACH ITEM in the collection: Returns `true` if the column or row is the last one in the table; `false` otherwise. + * For EACH ITEM in the collection: Specifies whether entries in the table of figures should be formatted as hyperlinks when publishing to the web. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isLast?: boolean; + areHyperlinksUsedOnWeb?: boolean; /** - * For EACH ITEM in the collection: Returns the nesting level of the column. + * For EACH ITEM in the collection: Specifies whether the page numbers in the table of figures should be hidden when publishing to the web. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - nestingLevel?: boolean; + arePageNumbersHiddenOnWeb?: boolean; /** - * For EACH ITEM in the collection: Specifies the preferred width (in points or as a percentage of the window width) for the column. - The unit of measurement can be specified by the `preferredWidthType` property. + * For EACH ITEM in the collection: Specifies whether page numbers are included in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - preferredWidth?: boolean; + arePageNumbersIncluded?: boolean; /** - * For EACH ITEM in the collection: Specifies the preferred unit of measurement to use for the width of the table column. + * For EACH ITEM in the collection: Specifies whether page numbers are aligned with the right margin in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - preferredWidthType?: boolean; + arePageNumbersRightAligned?: boolean; /** - * For EACH ITEM in the collection: Specifies the width of the column, in points. + * For EACH ITEM in the collection: Specifies the label that identifies the items to be included in the table of figures. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - width?: boolean; + captionLabel?: boolean; + /** + * For EACH ITEM in the collection: Specifies whether the caption label and caption number are included in the table of figures. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isLabelIncluded?: boolean; + /** + * For EACH ITEM in the collection: Specifies the ending heading level for the table of figures. Must be a value from 1 to 9 and greater than `upperHeadingLevel`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lowerHeadingLevel?: boolean; + /** + * For EACH ITEM in the collection: Specifies the character between entries and their page numbers in the table of figures. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tabLeader?: boolean; + /** + * For EACH ITEM in the collection: Specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for the table of figures. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tableId?: boolean; + /** + * For EACH ITEM in the collection: Specifies the starting heading level for the table of figures. Must be a value from 1 to 9 and smaller than `lowerHeadingLevel`. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + upperHeadingLevel?: boolean; } /** * Represents a row in a Word document. @@ -155399,6 +166008,22 @@ declare namespace Word { * [Api set: WordApi 1.3] */ parentTable?: Word.Interfaces.TableLoadOptions; + /** + * Returns the `Range` object that represents the table row. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeLoadOptions; + /** + * Returns the `ShadingUniversal` object that represents the shading of the table row. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** * Gets the number of cells in the row. * @@ -155481,6 +166106,22 @@ declare namespace Word { * [Api set: WordApi 1.3] */ parentTable?: Word.Interfaces.TableLoadOptions; + /** + * For EACH ITEM in the collection: Returns the `Range` object that represents the table row. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeLoadOptions; + /** + * For EACH ITEM in the collection: Returns the `ShadingUniversal` object that represents the shading of the table row. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** * For EACH ITEM in the collection: Gets the number of cells in the row. * @@ -155556,6 +166197,14 @@ declare namespace Word { * [Api set: WordApi 1.3] */ body?: Word.Interfaces.BodyLoadOptions; + /** + * Returns the `TableColumn` object that represents the table column that contains this cell. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + column?: Word.Interfaces.TableColumnLoadOptions; /** * Gets the parent row of the cell. * @@ -155570,6 +166219,14 @@ declare namespace Word { * [Api set: WordApi 1.3] */ parentTable?: Word.Interfaces.TableLoadOptions; + /** + * Returns the `ShadingUniversal` object that represents the shading of the table cell. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** * Gets the index of the cell in its row. * @@ -155645,6 +166302,14 @@ declare namespace Word { * [Api set: WordApi 1.3] */ body?: Word.Interfaces.BodyLoadOptions; + /** + * For EACH ITEM in the collection: Returns the `TableColumn` object that represents the table column that contains this cell. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + column?: Word.Interfaces.TableColumnLoadOptions; /** * For EACH ITEM in the collection: Gets the parent row of the cell. * @@ -155659,6 +166324,14 @@ declare namespace Word { * [Api set: WordApi 1.3] */ parentTable?: Word.Interfaces.TableLoadOptions; + /** + * For EACH ITEM in the collection: Returns the `ShadingUniversal` object that represents the shading of the table cell. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** * For EACH ITEM in the collection: Gets the index of the cell in its row. * @@ -157264,24 +167937,545 @@ declare namespace Word { /** Specifying `$all` 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; + $all?: boolean; + /** + * Returns the range of this repeating section item, excluding the start and end tags. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeLoadOptions; + } + /** + * Represents a single tracked change in a document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface RevisionLoadOptions { + /** + Specifying `$all` 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 a `Range` object that represents the range of text that was moved from one place to another in the document with tracked changes. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + movedRange?: Word.Interfaces.RangeLoadOptions; + /** + * Gets a `Range` object that represents the portion of the document that's contained within a revision mark. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeLoadOptions; + /** + * Gets the name of the user who made the tracked change. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + author?: boolean; + /** + * Gets the date and time when the tracked change was made. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + date?: boolean; + /** + * Gets the description of tracked formatting changes in the revision. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + formatDescription?: boolean; + /** + * Gets a number that represents the position of this item in a collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + index?: boolean; + /** + * Gets the revision type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type?: boolean; + } + /** + * A collection of Revision objects that represent the changes marked with revision marks in a range or document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface RevisionCollectionLoadOptions { + /** + Specifying `$all` 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 a `Range` object that represents the range of text that was moved from one place to another in the document with tracked changes. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + movedRange?: Word.Interfaces.RangeLoadOptions; + /** + * For EACH ITEM in the collection: Gets a `Range` object that represents the portion of the document that's contained within a revision mark. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeLoadOptions; + /** + * For EACH ITEM in the collection: Gets the name of the user who made the tracked change. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + author?: boolean; + /** + * For EACH ITEM in the collection: Gets the date and time when the tracked change was made. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + date?: boolean; + /** + * For EACH ITEM in the collection: Gets the description of tracked formatting changes in the revision. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + formatDescription?: boolean; + /** + * For EACH ITEM in the collection: Gets a number that represents the position of this item in a collection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + index?: boolean; + /** + * For EACH ITEM in the collection: Gets the revision type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type?: boolean; + } + /** + * Represents the `DatePickerContentControl` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface DatePickerContentControlLoadOptions { + /** + Specifying `$all` 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 `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; + /** + * Gets a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeLoadOptions; + /** + * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; + /** + * Specifies the appearance of the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + appearance?: boolean; + /** + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + color?: boolean; + /** + * Specifies a `CalendarType` value that represents the calendar type for the date picker content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + dateCalendarType?: boolean; + /** + * Specifies the format in which dates are displayed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + dateDisplayFormat?: boolean; + /** + * Specifies a `LanguageId` that represents the language format for the date displayed in the date picker content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + dateDisplayLocale?: boolean; + /** + * Specifies a `ContentControlDateStorageFormat` value that represents the format for storage and retrieval of dates when the date picker content control is bound to the XML data store of the active document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + dateStorageFormat?: boolean; + /** + * Gets the identification for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + id?: boolean; + /** + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isTemporary?: boolean; + /** + * Specifies the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + level?: boolean; + /** + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lockContentControl?: boolean; + /** + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lockContents?: boolean; + /** + * Gets whether the placeholder text for the content control is being displayed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + showingPlaceholderText?: boolean; + /** + * Specifies a tag to identify the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tag?: boolean; + /** + * Specifies the title for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + title?: boolean; + } + /** + * Represents the `PictureContentControl` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface PictureContentControlLoadOptions { + /** + Specifying `$all` 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 `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; + /** + * Returns a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeLoadOptions; + /** + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; + /** + * Specifies the appearance of the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + appearance?: boolean; + /** + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + color?: boolean; + /** + * Returns the identification for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + id?: boolean; + /** + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isTemporary?: boolean; + /** + * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + level?: boolean; + /** + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lockContentControl?: boolean; + /** + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lockContents?: boolean; + /** + * Returns whether the placeholder text for the content control is being displayed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + showingPlaceholderText?: boolean; + /** + * Specifies a tag to identify the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tag?: boolean; + /** + * Specifies the title for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + title?: boolean; + } + /** + * Represents the `GroupContentControl` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface GroupContentControlLoadOptions { + /** + Specifying `$all` 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 `BuildingBlock` object that represents the placeholder text for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; + /** + * Gets a `Range` object that represents the contents of the content control in the active document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + range?: Word.Interfaces.RangeLoadOptions; + /** + * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; + /** + * Specifies the appearance of the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + appearance?: boolean; + /** + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + color?: boolean; + /** + * Returns the identification for the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + id?: boolean; + /** + * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + isTemporary?: boolean; + /** + * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + level?: boolean; + /** + * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lockContentControl?: boolean; + /** + * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + lockContents?: boolean; + /** + * Returns whether the placeholder text for the content control is being displayed. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + showingPlaceholderText?: boolean; + /** + * Specifies a tag to identify the content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tag?: boolean; /** - * Returns the range of this repeating section item, excluding the start and end tags. + * Specifies the title for the content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeLoadOptions; + title?: boolean; } /** - * Represents the `DatePickerContentControl` object. + * Represents the `BuildingBlockGalleryContentControl` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface DatePickerContentControlLoadOptions { + interface BuildingBlockGalleryContentControlLoadOptions { /** Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ @@ -157295,7 +168489,7 @@ declare namespace Word { */ placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * Returns a `Range` object that represents the contents of the content control in the active document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -157303,7 +168497,7 @@ declare namespace Word { */ range?: Word.Interfaces.RangeLoadOptions; /** - * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -157319,45 +168513,29 @@ declare namespace Word { */ appearance?: boolean; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - color?: boolean; - /** - * Specifies a `CalendarType` value that represents the calendar type for the date picker content control. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - dateCalendarType?: boolean; - /** - * Specifies the format in which dates are displayed. + * Specifies the category for the building block content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateDisplayFormat?: boolean; + buildingBlockCategory?: boolean; /** - * Specifies a `LanguageId` that represents the language format for the date displayed in the date picker content control. + * Specifies a `BuildingBlockType` value that represents the type of building block for the building block content control. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateDisplayLocale?: boolean; + buildingBlockType?: boolean; /** - * Specifies a `ContentControlDateStorageFormat` value that represents the format for storage and retrieval of dates when the date picker content control is bound to the XML data store of the active document. + * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dateStorageFormat?: boolean; + color?: boolean; /** * Gets the identification for the content control. * @@ -157375,7 +168553,7 @@ declare namespace Word { */ isTemporary?: boolean; /** - * Specifies the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -157399,7 +168577,7 @@ declare namespace Word { */ lockContents?: boolean; /** - * Gets whether the placeholder text for the content control is being displayed. + * Gets if the placeholder text for the content control is being displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -157424,13 +168602,13 @@ declare namespace Word { title?: boolean; } /** - * Represents the `PictureContentControl` object. + * Represents the `RepeatingSectionContentControl` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface PictureContentControlLoadOptions { + interface RepeatingSectionContentControlLoadOptions { /** Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ @@ -157444,7 +168622,7 @@ declare namespace Word { */ placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; /** - * Returns a `Range` object that represents the contents of the content control in the active document. + * Gets a `Range` object that represents the contents of the content control in the active document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -157458,7 +168636,15 @@ declare namespace Word { * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; + xmlapping?: Word.Interfaces.XmlMappingLoadOptions; + /** + * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + allowInsertDeleteSection?: boolean; /** * Specifies the appearance of the content control. * @@ -157515,6 +168701,14 @@ declare namespace Word { * @beta */ lockContents?: boolean; + /** + * Specifies the name of the repeating section items used in the context menu associated with this repeating section content control. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + repeatingSectionItemTitle?: boolean; /** * Returns whether the placeholder text for the content control is being displayed. * @@ -157541,144 +168735,144 @@ declare namespace Word { title?: boolean; } /** - * Represents the `GroupContentControl` object. + * Represents a frame. The `Frame` object is a member of the {@link Word.FrameCollection} object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface GroupContentControlLoadOptions { + interface FrameLoadOptions { /** Specifying `$all` 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 `BuildingBlock` object that represents the placeholder text for the content control. + * Returns a `Range` object that represents the portion of the document that's contained within the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; + range?: Word.Interfaces.RangeLoadOptions; /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeLoadOptions; + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - * Gets an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Specifies the height (in points) of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; + height?: boolean; /** - * Specifies the appearance of the content control. + * Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: boolean; + heightRule?: boolean; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * Specifies the horizontal distance between the frame and the surrounding text, in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: boolean; + horizontalDistanceFromText?: boolean; /** - * Returns the identification for the content control. + * Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: boolean; + horizontalPosition?: boolean; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Specifies if the frame is locked. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + lockAnchor?: boolean; /** - * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Specifies the relative horizontal position of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - level?: boolean; + relativeHorizontalPosition?: boolean; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Specifies the relative vertical position of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + relativeVerticalPosition?: boolean; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * Specifies if document text wraps around the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + textWrap?: boolean; /** - * Returns whether the placeholder text for the content control is being displayed. + * Specifies the vertical distance (in points) between the frame and the surrounding text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showingPlaceholderText?: boolean; + verticalDistanceFromText?: boolean; /** - * Specifies a tag to identify the content control. + * Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: boolean; + verticalPosition?: boolean; /** - * Specifies the title for the content control. + * Specifies the width (in points) of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: boolean; + width?: boolean; + /** + * Specifies the rule used to determine the width of the frame. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + widthRule?: boolean; } /** - * Represents the `BuildingBlockGalleryContentControl` object. + * Represents the collection of {@link Word.Frame} objects. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface BuildingBlockGalleryContentControlLoadOptions { + interface FrameCollectionLoadOptions { /** Specifying `$all` 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 `BuildingBlock` object that represents the placeholder text for the content control. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; - /** - * Returns a `Range` object that represents the contents of the content control in the active document. + * For EACH ITEM in the collection: Returns a `Range` object that represents the portion of the document that's contained within the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -157686,1943 +168880,2120 @@ declare namespace Word { */ range?: Word.Interfaces.RangeLoadOptions; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * For EACH ITEM in the collection: Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlMapping?: Word.Interfaces.XmlMappingLoadOptions; + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - * Specifies the appearance of the content control. + * For EACH ITEM in the collection: Specifies the height (in points) of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: boolean; + height?: boolean; /** - * Specifies the category for the building block content control. + * For EACH ITEM in the collection: Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - buildingBlockCategory?: boolean; + heightRule?: boolean; /** - * Specifies a `BuildingBlockType` value that represents the type of building block for the building block content control. + * For EACH ITEM in the collection: Specifies the horizontal distance between the frame and the surrounding text, in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - buildingBlockType?: boolean; + horizontalDistanceFromText?: boolean; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * For EACH ITEM in the collection: Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: boolean; + horizontalPosition?: boolean; /** - * Gets the identification for the content control. + * For EACH ITEM in the collection: Specifies if the frame is locked. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: boolean; + lockAnchor?: boolean; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * For EACH ITEM in the collection: Specifies the relative horizontal position of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + relativeHorizontalPosition?: boolean; /** - * Gets the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * For EACH ITEM in the collection: Specifies the relative vertical position of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - level?: boolean; + relativeVerticalPosition?: boolean; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * For EACH ITEM in the collection: Specifies if document text wraps around the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + textWrap?: boolean; /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + * For EACH ITEM in the collection: Specifies the vertical distance (in points) between the frame and the surrounding text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + verticalDistanceFromText?: boolean; /** - * Gets if the placeholder text for the content control is being displayed. + * For EACH ITEM in the collection: Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showingPlaceholderText?: boolean; + verticalPosition?: boolean; /** - * Specifies a tag to identify the content control. + * For EACH ITEM in the collection: Specifies the width (in points) of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: boolean; + width?: boolean; /** - * Specifies the title for the content control. + * For EACH ITEM in the collection: Specifies the rule used to determine the width of the frame. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: boolean; + widthRule?: boolean; } /** - * Represents the `RepeatingSectionContentControl` object. + * Represents a document library version. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface RepeatingSectionContentControlLoadOptions { + interface DocumentLibraryVersionLoadOptions { /** Specifying `$all` 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 `BuildingBlock` object that represents the placeholder text for the content control. + * Gets any optional comments associated with this version of the shared document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - placeholderText?: Word.Interfaces.BuildingBlockLoadOptions; + comments?: boolean; /** - * Gets a `Range` object that represents the contents of the content control in the active document. + * Gets the date and time at which this version of the shared document was last saved to the server. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeLoadOptions; + modified?: boolean; /** - * Returns an `XmlMapping` object that represents the mapping of the content control to XML data in the data store of the document. + * Gets the name of the user who last saved this version of the shared document to the server. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xmlapping?: Word.Interfaces.XmlMappingLoadOptions; + modifiedBy?: boolean; + } + /** + * Represents the collection of {@link Word.DocumentLibraryVersion} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface DocumentLibraryVersionCollectionLoadOptions { /** - * Specifies whether users can add or remove sections from this repeating section content control by using the user interface. + Specifying `$all` 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 any optional comments associated with this version of the shared document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - allowInsertDeleteSection?: boolean; + comments?: boolean; /** - * Specifies the appearance of the content control. + * For EACH ITEM in the collection: Gets the date and time at which this version of the shared document was last saved to the server. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - appearance?: boolean; + modified?: boolean; /** - * Specifies the red-green-blue (RGB) value of the color of the content control. You can provide the value in the '#RRGGBB' format. + * For EACH ITEM in the collection: Gets the name of the user who last saved this version of the shared document to the server. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: boolean; + modifiedBy?: boolean; + } + /** + * Represents a dropped capital letter in a Word document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface DropCapLoadOptions { /** - * Returns the identification for the content control. + Specifying `$all` 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 distance (in points) between the dropped capital letter and the paragraph text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - id?: boolean; + distanceFromText?: boolean; /** - * Specifies whether to remove the content control from the active document when the user edits the contents of the control. + * Gets the name of the font for the dropped capital letter. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isTemporary?: boolean; + fontName?: boolean; /** - * Returns the level of the content control—whether the content control surrounds text, paragraphs, table cells, or table rows; or if it is inline. + * Gets the height (in lines) of the dropped capital letter. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - level?: boolean; + linesToDrop?: boolean; /** - * Specifies if the content control is locked (can't be deleted). `true` means that the user can't delete it from the active document, `false` means it can be deleted. + * Gets the position of the dropped capital letter. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContentControl?: boolean; + position?: boolean; + } + /** + * Represents the list formatting characteristics of a range. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface ListFormatLoadOptions { /** - * Specifies if the contents of the content control are locked (not editable). `true` means the user can't edit the contents, `false` means the contents are editable. + Specifying `$all` 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 `List` object that represents the first formatted list contained in the `ListFormat` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + list?: Word.Interfaces.ListLoadOptions; + /** + * Gets the list template associated with the `ListFormat` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + listTemplate?: Word.Interfaces.ListTemplateLoadOptions; + /** + * Indicates whether the `ListFormat` object contains a single list. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockContents?: boolean; + isSingleList?: boolean; /** - * Specifies the name of the repeating section items used in the context menu associated with this repeating section content control. + * Indicates whether the `ListFormat` object contains a single list template. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - repeatingSectionItemTitle?: boolean; + isSingleListTemplate?: boolean; /** - * Returns whether the placeholder text for the content control is being displayed. + * Specifies the list level number for the first paragraph for the `ListFormat` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showingPlaceholderText?: boolean; + listLevelNumber?: boolean; /** - * Specifies a tag to identify the content control. + * Gets the string representation of the list value of the first paragraph in the range for the `ListFormat` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: boolean; + listString?: boolean; /** - * Specifies the title for the content control. + * Gets the type of the list for the `ListFormat` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - title?: boolean; + listType?: boolean; + /** + * Gets the numeric value of the the first paragraph in the range for the `ListFormat` object. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + listValue?: boolean; } /** - * Represents a frame. The `Frame` object is a member of the {@link Word.FrameCollection} object. + * Represents the fill formatting for a shape or text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface FrameLoadOptions { + interface FillFormatLoadOptions { /** Specifying `$all` 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 `Range` object that represents the portion of the document that's contained within the frame. + * Returns a `ColorFormat` object that represents the background color for the fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeLoadOptions; + backgroundColor?: Word.Interfaces.ColorFormatLoadOptions; /** - * Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. + * Returns a `ColorFormat` object that represents the foreground color for the fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shading?: Word.Interfaces.ShadingUniversalLoadOptions; + foregroundColor?: Word.Interfaces.ColorFormatLoadOptions; /** - * Specifies the height (in points) of the frame. + * Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - height?: boolean; + gradientAngle?: boolean; /** - * Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. + * Gets the gradient color type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - heightRule?: boolean; + gradientColorType?: boolean; /** - * Specifies the horizontal distance between the frame and the surrounding text, in points. + * Returns how dark or light a one-color gradient fill is. + A value of 0 means that black is mixed in with the shape's foreground color to form the gradient. + A value of 1 means that white is mixed in. + Values between 0 and 1 mean that a darker or lighter shade of the foreground color is mixed in. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontalDistanceFromText?: boolean; + gradientDegree?: boolean; /** - * Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property. + * Returns the gradient style for the fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontalPosition?: boolean; + gradientStyle?: boolean; /** - * Specifies if the frame is locked. + * Returns the gradient variant for the fill as an integer value from 1 to 4 for most gradient fills. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockAnchor?: boolean; + gradientVariant?: boolean; /** - * Specifies the relative horizontal position of the frame. + * Specifies if the object, or the formatting applied to it, is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - relativeHorizontalPosition?: boolean; + isVisible?: boolean; /** - * Specifies the relative vertical position of the frame. + * Returns a `PatternType` value that represents the pattern applied to the fill or line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - relativeVerticalPosition?: boolean; + pattern?: boolean; /** - * Specifies if document text wraps around the frame. + * Returns the preset gradient type for the fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textWrap?: boolean; + presetGradientType?: boolean; /** - * Specifies the vertical distance (in points) between the frame and the surrounding text. + * Gets the preset texture. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - verticalDistanceFromText?: boolean; + presetTexture?: boolean; /** - * Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property. + * Specifies whether the fill rotates with the shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - verticalPosition?: boolean; + rotateWithObject?: boolean; /** - * Specifies the width (in points) of the frame. + * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - width?: boolean; + textureAlignment?: boolean; /** - * Specifies the rule used to determine the width of the frame. + * Specifies the horizontal scaling factor for the texture fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - widthRule?: boolean; + textureHorizontalScale?: boolean; + /** + * Returns the name of the custom texture file for the fill. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + textureName?: boolean; + /** + * Specifies the horizontal offset of the texture from the origin in points. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + textureOffsetX?: boolean; + /** + * Specifies the vertical offset of the texture. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + textureOffsetY?: boolean; + /** + * Specifies whether the texture is tiled. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + textureTile?: boolean; + /** + * Returns the texture type for the fill. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + textureType?: boolean; + /** + * Specifies the vertical scaling factor for the texture fill as a value between 0.0 and 1.0. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + textureVerticalScale?: boolean; + /** + * Specifies the degree of transparency of the fill for a shape as a value between 0.0 (opaque) and 1.0 (clear). + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + transparency?: boolean; + /** + * Gets the fill format type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type?: boolean; } /** - * Represents the collection of {@link Word.Frame} objects. + * Represents the glow formatting for the font used by the range of text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface FrameCollectionLoadOptions { + interface GlowFormatLoadOptions { /** Specifying `$all` 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 a `Range` object that represents the portion of the document that's contained within the frame. + * Returns a `ColorFormat` object that represents the color for a glow effect. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - range?: Word.Interfaces.RangeLoadOptions; + color?: Word.Interfaces.ColorFormatLoadOptions; + /** + * Specifies the length of the radius for a glow effect. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + radius?: boolean; + /** + * Specifies the degree of transparency for the glow effect as a value between 0.0 (opaque) and 1.0 (clear). + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + transparency?: boolean; + } + /** + * Represents line and arrowhead formatting. For a line, the `LineFormat` object contains formatting information for the line itself; + for a shape with a border, this object contains formatting information for the shape's border. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface LineFormatLoadOptions { + /** + Specifying `$all` 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 a `ColorFormat` object that represents the background color for a patterned line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + backgroundColor?: Word.Interfaces.ColorFormatLoadOptions; + /** + * Gets a `ColorFormat` object that represents the foreground color for the line. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + foregroundColor?: Word.Interfaces.ColorFormatLoadOptions; /** - * For EACH ITEM in the collection: Returns a `ShadingUniversal` object that refers to the shading formatting for the frame. + * Specifies the length of the arrowhead at the beginning of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - shading?: Word.Interfaces.ShadingUniversalLoadOptions; + beginArrowheadLength?: boolean; /** - * For EACH ITEM in the collection: Specifies the height (in points) of the frame. + * Specifies the style of the arrowhead at the beginning of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - height?: boolean; + beginArrowheadStyle?: boolean; /** - * For EACH ITEM in the collection: Specifies a `FrameSizeRule` value that represents the rule for determining the height of the frame. + * Specifies the width of the arrowhead at the beginning of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - heightRule?: boolean; + beginArrowheadWidth?: boolean; /** - * For EACH ITEM in the collection: Specifies the horizontal distance between the frame and the surrounding text, in points. + * Specifies the dash style for the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontalDistanceFromText?: boolean; + dashStyle?: boolean; /** - * For EACH ITEM in the collection: Specifies the horizontal distance between the edge of the frame and the item specified by the `relativeHorizontalPosition` property. + * Specifies the length of the arrowhead at the end of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - horizontalPosition?: boolean; + endArrowheadLength?: boolean; /** - * For EACH ITEM in the collection: Specifies if the frame is locked. + * Specifies the style of the arrowhead at the end of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lockAnchor?: boolean; + endArrowheadStyle?: boolean; /** - * For EACH ITEM in the collection: Specifies the relative horizontal position of the frame. + * Specifies the width of the arrowhead at the end of the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - relativeHorizontalPosition?: boolean; + endArrowheadWidth?: boolean; /** - * For EACH ITEM in the collection: Specifies the relative vertical position of the frame. + * Specifies if to draw lines inside a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - relativeVerticalPosition?: boolean; + insetPen?: boolean; /** - * For EACH ITEM in the collection: Specifies if document text wraps around the frame. + * Specifies if the object, or the formatting applied to it, is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textWrap?: boolean; + isVisible?: boolean; /** - * For EACH ITEM in the collection: Specifies the vertical distance (in points) between the frame and the surrounding text. + * Specifies the pattern applied to the line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - verticalDistanceFromText?: boolean; + pattern?: boolean; /** - * For EACH ITEM in the collection: Specifies the vertical distance between the edge of the frame and the item specified by the `relativeVerticalPosition` property. + * Specifies the line format style. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - verticalPosition?: boolean; + style?: boolean; /** - * For EACH ITEM in the collection: Specifies the width (in points) of the frame. + * Specifies the degree of transparency of the line as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - width?: boolean; + transparency?: boolean; /** - * For EACH ITEM in the collection: Specifies the rule used to determine the width of the frame. + * Specifies the thickness of the line in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - widthRule?: boolean; + weight?: boolean; } /** - * Represents a document library version. + * Represents the reflection formatting for a shape in Word. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface DocumentLibraryVersionLoadOptions { + interface ReflectionFormatLoadOptions { /** Specifying `$all` 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 any optional comments associated with this version of the shared document. + * Specifies the degree of blur effect applied to the `ReflectionFormat` object as a value between 0.0 and 100.0. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - comments?: boolean; + blur?: boolean; /** - * Gets the date and time at which this version of the shared document was last saved to the server. + * Specifies the amount of separation, in points, of the reflected image from the shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - modified?: boolean; + offset?: boolean; /** - * Gets the name of the user who last saved this version of the shared document to the server. + * Specifies the size of the reflection as a percentage of the reflected shape from 0 to 100. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - modifiedBy?: boolean; + size?: boolean; + /** + * Specifies the degree of transparency for the reflection effect as a value between 0.0 (opaque) and 1.0 (clear). + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + transparency?: boolean; + /** + * Specifies a `ReflectionType` value that represents the type and direction of the lighting for a shape reflection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type?: boolean; } /** - * Represents the collection of {@link Word.DocumentLibraryVersion} objects. + * Represents the color formatting of a shape or text in Word. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface DocumentLibraryVersionCollectionLoadOptions { + interface ColorFormatLoadOptions { /** Specifying `$all` 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 any optional comments associated with this version of the shared document. + * Specifies the brightness of a specified shape color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - comments?: boolean; + brightness?: boolean; /** - * For EACH ITEM in the collection: Gets the date and time at which this version of the shared document was last saved to the server. + * Specifies the theme color for a color format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - modified?: boolean; + objectThemeColor?: boolean; /** - * For EACH ITEM in the collection: Gets the name of the user who last saved this version of the shared document to the server. + * Specifies the red-green-blue (RGB) value of the specified color. You can provide the value in the '#RRGGBB' format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - modifiedBy?: boolean; + rgb?: boolean; + /** + * Specifies the lightening or darkening of a specified shape's color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + tintAndShade?: boolean; + /** + * Returns the shape color type. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + type?: boolean; } /** - * Represents a dropped capital letter in a Word document. + * Represents the shadow formatting for a shape or text in Word. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface DropCapLoadOptions { + interface ShadowFormatLoadOptions { /** Specifying `$all` 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 distance (in points) between the dropped capital letter and the paragraph text. + * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - distanceFromText?: boolean; + foregroundColor?: Word.Interfaces.ColorFormatLoadOptions; /** - * Gets the name of the font for the dropped capital letter. + * Specifies the blur level for a shadow format as a value between 0.0 and 100.0. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fontName?: boolean; + blur?: boolean; /** - * Gets the height (in lines) of the dropped capital letter. + * Specifies whether the object or the formatting applied to it is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - linesToDrop?: boolean; + isVisible?: boolean; /** - * Gets the position of the dropped capital letter. + * Specifies `true` if the shadow of the shape appears filled in and is obscured by the shape, even if the shape has no fill, + `false` if the shadow has no fill and the outline of the shadow is visible through the shape if the shape has no fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - position?: boolean; - } - /** - * Represents the list formatting characteristics of a range. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface ListFormatLoadOptions { + obscured?: boolean; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * Specifies the horizontal offset (in points) of the shadow from the shape. + A positive value offsets the shadow to the right of the shape; a negative value offsets it to the left. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; - /** - * Returns a `List` object that represents the first formatted list contained in the `ListFormat` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - list?: Word.Interfaces.ListLoadOptions; - /** - * Gets the list template associated with the `ListFormat` object. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - listTemplate?: Word.Interfaces.ListTemplateLoadOptions; + offsetX?: boolean; /** - * Indicates whether the `ListFormat` object contains a single list. + * Specifies the vertical offset (in points) of the shadow from the shape. + A positive value offsets the shadow to the top of the shape; a negative value offsets it to the bottom. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isSingleList?: boolean; + offsetY?: boolean; /** - * Indicates whether the `ListFormat` object contains a single list template. + * Specifies whether to rotate the shadow when rotating the shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isSingleListTemplate?: boolean; + rotateWithShape?: boolean; /** - * Specifies the list level number for the first paragraph for the `ListFormat` object. + * Specifies the width of the shadow. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listLevelNumber?: boolean; + size?: boolean; /** - * Gets the string representation of the list value of the first paragraph in the range for the `ListFormat` object. + * Specifies the type of shadow formatting to apply to a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listString?: boolean; + style?: boolean; /** - * Gets the type of the list for the `ListFormat` object. + * Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listType?: boolean; + transparency?: boolean; /** - * Gets the numeric value of the the first paragraph in the range for the `ListFormat` object. + * Specifies the shape shadow type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - listValue?: boolean; + type?: boolean; } /** - * Represents the fill formatting for a shape or text. + * Represents a shape's three-dimensional formatting. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface FillFormatLoadOptions { + interface ThreeDimensionalFormatLoadOptions { /** Specifying `$all` 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 `ColorFormat` object that represents the background color for the fill. + * Returns a `ColorFormat` object that represents color of the contour of a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - backgroundColor?: Word.Interfaces.ColorFormatLoadOptions; + contourColor?: Word.Interfaces.ColorFormatLoadOptions; /** - * Returns a `ColorFormat` object that represents the foreground color for the fill. + * Returns a `ColorFormat` object that represents the color of the shape's extrusion. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - foregroundColor?: Word.Interfaces.ColorFormatLoadOptions; + extrusionColor?: Word.Interfaces.ColorFormatLoadOptions; /** - * Specifies the angle of the gradient fill. The valid range of values is from 0 to 359.9. + * Specifies the depth of the bottom bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gradientAngle?: boolean; + bevelBottomDepth?: boolean; /** - * Gets the gradient color type. + * Specifies the inset size for the bottom bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gradientColorType?: boolean; + bevelBottomInset?: boolean; /** - * Returns how dark or light a one-color gradient fill is. - A value of 0 means that black is mixed in with the shape's foreground color to form the gradient. - A value of 1 means that white is mixed in. - Values between 0 and 1 mean that a darker or lighter shade of the foreground color is mixed in. + * Specifies a `BevelType` value that represents the bevel type for the bottom bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gradientDegree?: boolean; + bevelBottomType?: boolean; /** - * Returns the gradient style for the fill. + * Specifies the depth of the top bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gradientStyle?: boolean; + bevelTopDepth?: boolean; /** - * Returns the gradient variant for the fill as an integer value from 1 to 4 for most gradient fills. + * Specifies the inset size for the top bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gradientVariant?: boolean; + bevelTopInset?: boolean; /** - * Specifies if the object, or the formatting applied to it, is visible. + * Specifies a `BevelType` value that represents the bevel type for the top bevel. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + bevelTopType?: boolean; /** - * Returns a `PatternType` value that represents the pattern applied to the fill or line. + * Specifies the width of the contour of a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pattern?: boolean; + contourWidth?: boolean; /** - * Returns the preset gradient type for the fill. + * Specifies the depth of the shape's extrusion. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetGradientType?: boolean; + depth?: boolean; /** - * Gets the preset texture. + * Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion) + and automatically changes when the shape's fill changes, or whether the extrusion color is independent of the shape's fill. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetTexture?: boolean; + extrusionColorType?: boolean; /** - * Specifies whether the fill rotates with the shape. + * Specifies the amount of perspective for a shape. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotateWithObject?: boolean; + fieldOfView?: boolean; /** - * Specifies the alignment (the origin of the coordinate grid) for the tiling of the texture fill. + * Specifies `true` if the extrusion appears in perspective — that is, if the walls of the extrusion narrow toward a vanishing point, + `false` if the extrusion is a parallel, or orthographic, projection — that is, if the walls don't narrow toward a vanishing point. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureAlignment?: boolean; + isPerspective?: boolean; /** - * Specifies the horizontal scaling factor for the texture fill. + * Specifies if the specified object, or the formatting applied to it, is visible. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureHorizontalScale?: boolean; + isVisible?: boolean; /** - * Returns the name of the custom texture file for the fill. + * Specifies the angle of the lighting. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureName?: boolean; + lightAngle?: boolean; /** - * Specifies the horizontal offset of the texture from the origin in points. + * Returns a `PresetCamera` value that represents the camera presets. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureOffsetX?: boolean; + presetCamera?: boolean; /** - * Specifies the vertical offset of the texture. + * Returns the direction taken by the extrusion's sweep path leading away from the extruded shape (the front face of the extrusion). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureOffsetY?: boolean; + presetExtrusionDirection?: boolean; /** - * Specifies whether the texture is tiled. + * Specifies a `LightRigType` value that represents the lighting preset. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureTile?: boolean; + presetLighting?: boolean; /** - * Returns the texture type for the fill. + * Specifies the position of the light source relative to the extrusion. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureType?: boolean; + presetLightingDirection?: boolean; /** - * Specifies the vertical scaling factor for the texture fill as a value between 0.0 and 1.0. + * Specifies the intensity of the extrusion lighting. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - textureVerticalScale?: boolean; + presetLightingSoftness?: boolean; /** - * Specifies the degree of transparency of the fill for a shape as a value between 0.0 (opaque) and 1.0 (clear). + * Specifies the extrusion surface material. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency?: boolean; + presetMaterial?: boolean; /** - * Gets the fill format type. + * Returns the preset extrusion format. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: boolean; - } - /** - * Represents the glow formatting for the font used by the range of text. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface GlowFormatLoadOptions { + presetThreeDimensionalFormat?: boolean; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * Specifies whether text on a shape rotates with shape. `true` rotates the text. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + projectText?: boolean; /** - * Returns a `ColorFormat` object that represents the color for a glow effect. + * Specifies the rotation of the extruded shape around the x-axis in degrees. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - color?: Word.Interfaces.ColorFormatLoadOptions; + rotationX?: boolean; /** - * Specifies the length of the radius for a glow effect. + * Specifies the rotation of the extruded shape around the y-axis in degrees. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - radius?: boolean; + rotationY?: boolean; /** - * Specifies the degree of transparency for the glow effect as a value between 0.0 (opaque) and 1.0 (clear). + * Specifies the z-axis rotation of the camera. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency?: boolean; + rotationZ?: boolean; + /** + * Specifies the position on the z-axis for the shape. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + z?: boolean; } /** - * Represents line and arrowhead formatting. For a line, the `LineFormat` object contains formatting information for the line itself; - for a shape with a border, this object contains formatting information for the shape's border. + * Represents the list of available sources attached to the document (in the current list) or the list of sources available in the application (in the master list). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface LineFormatLoadOptions { + interface BibliographyLoadOptions { /** Specifying `$all` 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 a `ColorFormat` object that represents the background color for a patterned line. + * Specifies the name of the active style to use for the bibliography. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - backgroundColor?: Word.Interfaces.ColorFormatLoadOptions; + bibliographyStyle?: boolean; + } + /** + * Represents a collection of {@link Word.Source} objects. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface SourceCollectionLoadOptions { /** - * Gets a `ColorFormat` object that represents the foreground color for the line. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). */ - foregroundColor?: Word.Interfaces.ColorFormatLoadOptions; + $all?: boolean; /** - * Specifies the length of the arrowhead at the beginning of the line. + * For EACH ITEM in the collection: Gets if the `Source` object has been cited in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - beginArrowheadLength?: boolean; + isCited?: boolean; /** - * Specifies the style of the arrowhead at the beginning of the line. + * For EACH ITEM in the collection: Gets the tag of the source. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - beginArrowheadStyle?: boolean; + tag?: boolean; /** - * Specifies the width of the arrowhead at the beginning of the line. + * For EACH ITEM in the collection: Gets the XML representation of the source. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - beginArrowheadWidth?: boolean; + xml?: boolean; + } + /** + * Represents an individual source, such as a book, journal article, or interview. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface SourceLoadOptions { /** - * Specifies the dash style for the line. + Specifying `$all` 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 if the `Source` object has been cited in the document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - dashStyle?: boolean; + isCited?: boolean; /** - * Specifies the length of the arrowhead at the end of the line. + * Gets the tag of the source. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endArrowheadLength?: boolean; + tag?: boolean; /** - * Specifies the style of the arrowhead at the end of the line. + * Gets the XML representation of the source. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endArrowheadStyle?: boolean; + xml?: boolean; + } + /** + * Represents the page setup settings for a Word document or section. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface PageSetupLoadOptions { /** - * Specifies the width of the arrowhead at the end of the line. + Specifying `$all` 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 a `LineNumbering` object that represents the line numbers for the `PageSetup` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - endArrowheadWidth?: boolean; + lineNumbering?: Word.Interfaces.LineNumberingLoadOptions; /** - * Specifies if to draw lines inside a shape. + * Specifies whether Microsoft Word prints the document as a booklet. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - insetPen?: boolean; + bookFoldPrinting?: boolean; /** - * Specifies if the object, or the formatting applied to it, is visible. + * Specifies the number of pages for each booklet. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + bookFoldPrintingSheets?: boolean; /** - * Specifies the pattern applied to the line. + * Specifies if Microsoft Word reverses the printing order for book fold printing of bidirectional or Asian language documents. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pattern?: boolean; + bookFoldReversePrinting?: boolean; /** - * Specifies the line format style. + * Specifies the distance (in points) between the bottom edge of the page and the bottom boundary of the body text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - style?: boolean; + bottomMargin?: boolean; /** - * Specifies the degree of transparency of the line as a value between 0.0 (opaque) and 1.0 (clear). + * Specifies the number of characters per line in the document grid. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency?: boolean; + charsLine?: boolean; /** - * Specifies the thickness of the line in points. + * Specifies whether the first page has a different header and footer. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - weight?: boolean; - } - /** - * Represents the reflection formatting for a shape in Word. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface ReflectionFormatLoadOptions { - /** - Specifying `$all` 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; + differentFirstPageHeaderFooter?: boolean; /** - * Specifies the degree of blur effect applied to the `ReflectionFormat` object as a value between 0.0 and 100.0. + * Specifies the distance between the footer and the bottom of the page in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - blur?: boolean; + footerDistance?: boolean; /** - * Specifies the amount of separation, in points, of the reflected image from the shape. + * Specifies the amount (in points) of extra margin space added to each page in a document or section for binding. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - offset?: boolean; + gutter?: boolean; /** - * Specifies the size of the reflection as a percentage of the reflected shape from 0 to 100. + * Specifies on which side the gutter appears in a document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - size?: boolean; + gutterPosition?: boolean; /** - * Specifies the degree of transparency for the reflection effect as a value between 0.0 (opaque) and 1.0 (clear). + * Specifies whether Microsoft Word uses gutters for the current document based on a right-to-left language or a left-to-right language. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency?: boolean; + gutterStyle?: boolean; /** - * Specifies a `ReflectionType` value that represents the type and direction of the lighting for a shape reflection. + * Specifies the distance between the header and the top of the page in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: boolean; - } - /** - * Represents the color formatting of a shape or text in Word. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface ColorFormatLoadOptions { - /** - Specifying `$all` 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; + headerDistance?: boolean; /** - * Specifies the brightness of a specified shape color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. + * Specifies the layout mode for the current document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - brightness?: boolean; + layoutMode?: boolean; /** - * Specifies the theme color for a color format. + * Specifies the distance (in points) between the left edge of the page and the left boundary of the body text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - objectThemeColor?: boolean; + leftMargin?: boolean; /** - * Specifies the red-green-blue (RGB) value of the specified color. You can provide the value in the '#RRGGBB' format. + * Specifies the number of lines per page in the document grid. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rgb?: boolean; + linesPage?: boolean; /** - * Specifies the lightening or darkening of a specified shape's color. Valid values are from `-1` (darkest) to `1` (lightest), `0` represents neutral. + * Specifies if the inside and outside margins of facing pages are the same width. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tintAndShade?: boolean; + mirrorMargins?: boolean; /** - * Returns the shape color type. + * Specifies whether odd and even pages have different headers and footers. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: boolean; - } - /** - * Represents the shadow formatting for a shape or text in Word. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface ShadowFormatLoadOptions { + oddAndEvenPagesHeaderFooter?: boolean; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * Specifies the orientation of the page. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + orientation?: boolean; /** - * Returns a `ColorFormat` object that represents the foreground color for the fill, line, or shadow. + * Specifies the page height in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - foregroundColor?: Word.Interfaces.ColorFormatLoadOptions; + pageHeight?: boolean; /** - * Specifies the blur level for a shadow format as a value between 0.0 and 100.0. + * Specifies the page width in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - blur?: boolean; + pageWidth?: boolean; /** - * Specifies whether the object or the formatting applied to it is visible. + * Specifies the paper size of the page. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + paperSize?: boolean; /** - * Specifies `true` if the shadow of the shape appears filled in and is obscured by the shape, even if the shape has no fill, - `false` if the shadow has no fill and the outline of the shadow is visible through the shape if the shape has no fill. + * Specifies the distance (in points) between the right edge of the page and the right boundary of the body text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - obscured?: boolean; + rightMargin?: boolean; /** - * Specifies the horizontal offset (in points) of the shadow from the shape. - A positive value offsets the shadow to the right of the shape; a negative value offsets it to the left. + * Specifies the reading order and alignment for the specified sections. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - offsetX?: boolean; + sectionDirection?: boolean; /** - * Specifies the vertical offset (in points) of the shadow from the shape. - A positive value offsets the shadow to the top of the shape; a negative value offsets it to the bottom. + * Specifies the type of section break for the specified object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - offsetY?: boolean; + sectionStart?: boolean; /** - * Specifies whether to rotate the shadow when rotating the shape. + * Specifies whether to show the grid. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotateWithShape?: boolean; + showGrid?: boolean; /** - * Specifies the width of the shadow. + * Specifies if endnotes are printed at the end of the next section that doesn't suppress endnotes. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - size?: boolean; + suppressEndnotes?: boolean; /** - * Specifies the type of shadow formatting to apply to a shape. + * Specifies the top margin of the page in points. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - style?: boolean; + topMargin?: boolean; /** - * Specifies the degree of transparency of the shadow as a value between 0.0 (opaque) and 1.0 (clear). + * Specifies whether to print two pages per sheet. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - transparency?: boolean; + twoPagesOnOne?: boolean; /** - * Specifies the shape shadow type. + * Specifies the vertical alignment of text on each page in a document or section. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - type?: boolean; + verticalAlignment?: boolean; } /** - * Represents a shape's three-dimensional formatting. + * Represents line numbers in the left margin or to the left of each newspaper-style column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface ThreeDimensionalFormatLoadOptions { + interface LineNumberingLoadOptions { /** Specifying `$all` 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 `ColorFormat` object that represents color of the contour of a shape. + * Specifies the numeric increment for line numbers. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contourColor?: Word.Interfaces.ColorFormatLoadOptions; + countBy?: boolean; /** - * Returns a `ColorFormat` object that represents the color of the shape's extrusion. + * Specifies the distance (in points) between the right edge of line numbers and the left edge of the document text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - extrusionColor?: Word.Interfaces.ColorFormatLoadOptions; + distanceFromText?: boolean; /** - * Specifies the depth of the bottom bevel. + * Specifies if line numbering is active for the specified document, section, or sections. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelBottomDepth?: boolean; + isActive?: boolean; /** - * Specifies the inset size for the bottom bevel. + * Specifies the way line numbering runs; that is, whether it starts over at the beginning of a new page or section, or runs continuously. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelBottomInset?: boolean; + restartMode?: boolean; /** - * Specifies a `BevelType` value that represents the bevel type for the bottom bevel. + * Specifies the starting line number. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelBottomType?: boolean; + startingNumber?: boolean; + } + /** + * A collection of {@link Word.TextColumn} objects that represent all the columns of text in the document or a section of the document. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface TextColumnCollectionLoadOptions { /** - * Specifies the depth of the top bevel. + Specifying `$all` 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 amount of spacing (in points) after the specified paragraph or text column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelTopDepth?: boolean; + spaceAfter?: boolean; /** - * Specifies the inset size for the top bevel. + * For EACH ITEM in the collection: Specifies the width, in points, of the specified text columns. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelTopInset?: boolean; + width?: boolean; + } + /** + * Represents a single text column in a section. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface TextColumnLoadOptions { /** - * Specifies a `BevelType` value that represents the bevel type for the top bevel. + Specifying `$all` 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 amount of spacing (in points) after the specified paragraph or text column. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bevelTopType?: boolean; + spaceAfter?: boolean; /** - * Specifies the width of the contour of a shape. + * Specifies the width, in points, of the specified text columns. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - contourWidth?: boolean; + width?: boolean; + } + /** + * Represents a selected range or the insertion point in a Word document. + + - Note: {@link Word.Range | Range} objects share many of the same methods and properties as `Selection` objects. Using `Range` objects is preferable for manipulating a document when there isn't a reason to physically change the current selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface SelectionLoadOptions { /** - * Specifies the depth of the shape's extrusion. + Specifying `$all` 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 `Font` object that represents the character formatting of the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - depth?: boolean; + font?: Word.Interfaces.FontLoadOptions; /** - * Specifies whether the extrusion color is based on the extruded shape's fill (the front face of the extrusion) - and automatically changes when the shape's fill changes, or whether the extrusion color is independent of the shape's fill. + * Specifies a `Range` object that includes the formatted text in the range or selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - extrusionColorType?: boolean; + formattedText?: Word.Interfaces.RangeLoadOptions; /** - * Specifies the amount of perspective for a shape. + * Returns the `Range` object for the portion of the document contained in the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - fieldOfView?: boolean; + range?: Word.Interfaces.RangeLoadOptions; /** - * Specifies `true` if the extrusion appears in perspective — that is, if the walls of the extrusion narrow toward a vanishing point, - `false` if the extrusion is a parallel, or orthographic, projection — that is, if the walls don't narrow toward a vanishing point. + * Returns the `ShadingUniversal` object for the shading formatting for the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isPerspective?: boolean; + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - * Specifies if the specified object, or the formatting applied to it, is visible. + * Specifies the ending character position of the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isVisible?: boolean; + end?: boolean; /** - * Specifies the angle of the lighting. + * Specifies the width in which Word fits the text in the current selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - lightAngle?: boolean; + fitTextWidth?: boolean; /** - * Returns a `PresetCamera` value that represents the camera presets. + * Returns whether the spelling and grammar checker ignores the selected text. + If the selected text contains a mix of proofed and un-proofed content, this API returns `null`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetCamera?: boolean; + hasNoProofing?: boolean; /** - * Returns the direction taken by the extrusion's sweep path leading away from the extruded shape (the front face of the extrusion). + * Returns whether the selection in the specified window or pane is active. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetExtrusionDirection?: boolean; + isActive?: boolean; /** - * Specifies a `LightRigType` value that represents the lighting preset. + * Specifies whether column selection mode is active. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetLighting?: boolean; + isColumnSelectModeActive?: boolean; /** - * Specifies the position of the light source relative to the extrusion. + * Returns whether the selection is at the end-of-row mark in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetLightingDirection?: boolean; + isEndOfRowMark?: boolean; /** - * Specifies the intensity of the extrusion lighting. + * Specifies whether Extend mode is active. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetLightingSoftness?: boolean; + isExtendModeActive?: boolean; /** - * Specifies the extrusion surface material. + * Returns whether the insertion point is at the end of a line. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetMaterial?: boolean; + isInsertionPointAtEndOfLine?: boolean; /** - * Returns the preset extrusion format. + * Specifies whether the beginning of the selection is active. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - presetThreeDimensionalFormat?: boolean; + isStartActive?: boolean; /** - * Specifies whether text on a shape rotates with shape. `true` rotates the text. + * Specifies whether Word has detected the language of the selected text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - projectText?: boolean; + languageDetected?: boolean; /** - * Specifies the rotation of the extruded shape around the x-axis in degrees. + * Returns the language for the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotationX?: boolean; + languageId?: boolean; /** - * Specifies the rotation of the extruded shape around the y-axis in degrees. + * Returns the East Asian language for the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotationY?: boolean; + languageIdFarEast?: boolean; /** - * Specifies the z-axis rotation of the camera. + * Returns the language for the selection that isn't classified as an East Asian language. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - rotationZ?: boolean; + languageIdOther?: boolean; /** - * Specifies the position on the z-axis for the shape. + * Specifies the orientation of text in the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - z?: boolean; - } - /** - * Represents the list of available sources attached to the document (in the current list) or the list of sources available in the application (in the master list). - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface BibliographyLoadOptions { - /** - Specifying `$all` 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; + orientation?: boolean; /** - * Specifies the name of the active style to use for the bibliography. + * Specifies the starting character position of the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - bibliographyStyle?: boolean; - } - /** - * Represents a collection of {@link Word.Source} objects. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface SourceCollectionLoadOptions { + start?: boolean; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * Returns the number of characters in the story that contains the selection. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta */ - $all?: boolean; + storyLength?: boolean; /** - * For EACH ITEM in the collection: Gets if the `Source` object has been cited in the document. + * Returns the story type for the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isCited?: boolean; + storyType?: boolean; /** - * For EACH ITEM in the collection: Gets the tag of the source. + * Specifies the text in the selection. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: boolean; + text?: boolean; /** - * For EACH ITEM in the collection: Gets the XML representation of the source. + * Returns the selection type. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - xml?: boolean; + type?: boolean; } /** - * Represents an individual source, such as a book, journal article, or interview. + * Represents a collection of {@link Word.Range} objects that represents each character, word or sentence. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - interface SourceLoadOptions { + interface RangeScopedCollectionLoadOptions { /** Specifying `$all` 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 if the `Source` object has been cited in the document. + * For EACH ITEM in the collection: Gets the text format of the range. Use this to get and set font name, size, color, and other properties. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.1] */ - isCited?: boolean; + font?: Word.Interfaces.FontLoadOptions; /** - * Gets the tag of the source. + * For EACH ITEM in the collection: Returns a `ListFormat` object that represents all the list formatting characteristics of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - tag?: boolean; + listFormat?: Word.Interfaces.ListFormatLoadOptions; /** - * Gets the XML representation of the source. + * For EACH ITEM in the collection: Gets the parent body of the range. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - xml?: boolean; - } - /** - * Represents the page setup settings for a Word document or section. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface PageSetupLoadOptions { + parentBody?: Word.Interfaces.BodyLoadOptions; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * For EACH ITEM in the collection: Gets the currently supported content control that contains the range. Throws an `ItemNotFound` error if there isn't a parent content control. + * + * @remarks + * [Api set: WordApi 1.1] */ - $all?: boolean; + parentContentControl?: Word.Interfaces.ContentControlLoadOptions; /** - * Specifies a `LineNumbering` object that represents the line numbers for the `PageSetup` object. + * For EACH ITEM in the collection: Gets the currently supported content control that contains the range. If there isn't a parent content control, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - lineNumbering?: Word.Interfaces.LineNumberingLoadOptions; + parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions; /** - * Specifies whether Microsoft Word prints the document as a booklet. + * For EACH ITEM in the collection: Gets the table that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - bookFoldPrinting?: boolean; + parentTable?: Word.Interfaces.TableLoadOptions; /** - * Specifies the number of pages for each booklet. + * For EACH ITEM in the collection: Gets the table cell that contains the range. Throws an `ItemNotFound` error if it isn't contained in a table cell. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - bookFoldPrintingSheets?: boolean; + parentTableCell?: Word.Interfaces.TableCellLoadOptions; /** - * Specifies if Microsoft Word reverses the printing order for book fold printing of bidirectional or Asian language documents. + * For EACH ITEM in the collection: Gets the table cell that contains the range. If it isn't contained in a table cell, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - bookFoldReversePrinting?: boolean; + parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions; /** - * Specifies the distance (in points) between the bottom edge of the page and the bottom boundary of the body text. + * For EACH ITEM in the collection: Gets the table that contains the range. If it isn't contained in a table, then this method will return 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: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - bottomMargin?: boolean; + parentTableOrNullObject?: Word.Interfaces.TableLoadOptions; /** - * Specifies the number of characters per line in the document grid. + * For EACH ITEM in the collection: Returns a `ShadingUniversal` object that refers to the shading formatting for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - charsLine?: boolean; + shading?: Word.Interfaces.ShadingUniversalLoadOptions; /** - * Specifies whether the first page has a different header and footer. + * For EACH ITEM in the collection: Specifies whether the range is formatted as bold. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - differentFirstPageHeaderFooter?: boolean; + bold?: boolean; /** - * Specifies the distance between the footer and the bottom of the page in points. + * For EACH ITEM in the collection: Specifies whether the range is formatted as bold in a right-to-left language document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - footerDistance?: boolean; + boldBidirectional?: boolean; /** - * Specifies the amount (in points) of extra margin space added to each page in a document or section for binding. + * For EACH ITEM in the collection: Specifies a `CharacterCase` value that represents the case of the text in the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gutter?: boolean; + case?: boolean; /** - * Specifies on which side the gutter appears in a document. + * For EACH ITEM in the collection: Specifies the character width of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gutterPosition?: boolean; + characterWidth?: boolean; /** - * Specifies whether Microsoft Word uses gutters for the current document based on a right-to-left language or a left-to-right language. + * For EACH ITEM in the collection: Specifies if the range contains combined characters. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - gutterStyle?: boolean; + combineCharacters?: boolean; /** - * Specifies the distance between the header and the top of the page in points. + * For EACH ITEM in the collection: Specifies if Microsoft Word ignores the number of characters per line for the corresponding `Range` object. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - headerDistance?: boolean; + disableCharacterSpaceGrid?: boolean; /** - * Specifies the layout mode for the current document. + * For EACH ITEM in the collection: Specifies the emphasis mark for a character or designated character string. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - layoutMode?: boolean; + emphasisMark?: boolean; /** - * Specifies the distance (in points) between the left edge of the page and the left boundary of the body text. + * For EACH ITEM in the collection: Specifies the ending character position of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - leftMargin?: boolean; + end?: boolean; /** - * Specifies the number of lines per page in the document grid. + * For EACH ITEM in the collection: Specifies the width (in the current measurement units) in which Microsoft Word fits the text in the current selection or range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - linesPage?: boolean; + fitTextWidth?: boolean; /** - * Specifies if the inside and outside margins of facing pages are the same width. + * For EACH ITEM in the collection: Specifies if a grammar check has been run on the range or document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - mirrorMargins?: boolean; + grammarChecked?: boolean; /** - * Specifies whether odd and even pages have different headers and footers. + * For EACH ITEM in the collection: Specifies the proofing status (spelling and grammar checking) of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - oddAndEvenPagesHeaderFooter?: boolean; + hasNoProofing?: boolean; /** - * Specifies the orientation of the page. + * For EACH ITEM in the collection: Specifies the highlight color for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - orientation?: boolean; + highlightColorIndex?: boolean; /** - * Specifies the page height in points. + * For EACH ITEM in the collection: Specifies the formatting for horizontal text set within vertical text. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - pageHeight?: boolean; + horizontalInVertical?: boolean; /** - * Specifies the page width in points. + * For EACH ITEM in the collection: Gets the first hyperlink in the range, or sets a hyperlink on the range. All hyperlinks in the range are deleted when you set a new hyperlink on the range. Use a '#' to separate the address part from the optional location part. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - pageWidth?: boolean; + hyperlink?: boolean; /** - * Specifies the paper size of the page. + * For EACH ITEM in the collection: Specifies the ID for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - paperSize?: boolean; + id?: boolean; /** - * Specifies the distance (in points) between the right edge of the page and the right boundary of the body text. + * For EACH ITEM in the collection: Checks whether the range length is zero. * * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta + * [Api set: WordApi 1.3] */ - rightMargin?: boolean; + isEmpty?: boolean; /** - * Specifies the reading order and alignment for the specified sections. + * For EACH ITEM in the collection: Gets if the range is collapsed and is located at the end-of-row mark in a table. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sectionDirection?: boolean; + isEndOfRowMark?: boolean; /** - * Specifies the type of section break for the specified object. + * For EACH ITEM in the collection: Gets whether the text in the range is visible on the screen. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - sectionStart?: boolean; + isTextVisibleOnScreen?: boolean; /** - * Specifies whether to show the grid. + * For EACH ITEM in the collection: Specifies if the font or range is formatted as italic. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - showGrid?: boolean; + italic?: boolean; /** - * Specifies if endnotes are printed at the end of the next section that doesn't suppress endnotes. + * For EACH ITEM in the collection: Specifies if the font or range is formatted as italic (right-to-left languages). * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - suppressEndnotes?: boolean; + italicBidirectional?: boolean; /** - * Specifies the top margin of the page in points. + * For EACH ITEM in the collection: Specifies whether the range of Japanese language text is hiragana or katakana. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - topMargin?: boolean; + kana?: boolean; /** - * Specifies whether to print two pages per sheet. + * For EACH ITEM in the collection: Specifies whether Microsoft Word has detected the language of the text in the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - twoPagesOnOne?: boolean; + languageDetected?: boolean; /** - * Specifies the vertical alignment of text on each page in a document or section. + * For EACH ITEM in the collection: Specifies a `LanguageId` value that represents the language for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - verticalAlignment?: boolean; - } - /** - * Represents line numbers in the left margin or to the left of each newspaper-style column. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface LineNumberingLoadOptions { - /** - Specifying `$all` 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; + languageId?: boolean; /** - * Specifies the numeric increment for line numbers. + * For EACH ITEM in the collection: Specifies an East Asian language for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - countBy?: boolean; + languageIdFarEast?: boolean; /** - * Specifies the distance (in points) between the right edge of line numbers and the left edge of the document text. + * For EACH ITEM in the collection: Specifies a language for the range that isn't classified as an East Asian language. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - distanceFromText?: boolean; + languageIdOther?: boolean; /** - * Specifies if line numbering is active for the specified document, section, or sections. + * For EACH ITEM in the collection: Specifies if all nonprinting characters (such as hidden text, tab marks, space marks, and paragraph marks) are displayed. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - isActive?: boolean; + showAll?: boolean; /** - * Specifies the way line numbering runs; that is, whether it starts over at the beginning of a new page or section, or runs continuously. + * For EACH ITEM in the collection: Specifies if spelling has been checked throughout the range or document. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - restartMode?: boolean; + spellingChecked?: boolean; /** - * Specifies the starting line number. + * For EACH ITEM in the collection: Specifies the starting character position of the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - startingNumber?: boolean; - } - /** - * A collection of {@link Word.TextColumn} objects that represent all the columns of text in the document or a section of the document. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface TextColumnCollectionLoadOptions { - /** - Specifying `$all` 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; + start?: boolean; /** - * For EACH ITEM in the collection: Specifies the amount of spacing (in points) after the specified paragraph or text column. + * For EACH ITEM in the collection: Gets the number of characters in the story that contains the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spaceAfter?: boolean; + storyLength?: boolean; /** - * For EACH ITEM in the collection: Specifies the width, in points, of the specified text columns. + * For EACH ITEM in the collection: Gets the story type for the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - width?: boolean; - } - /** - * Represents a single text column in a section. - * - * @remarks - * [Api set: WordApi BETA (PREVIEW ONLY)] - * @beta - */ - interface TextColumnLoadOptions { + storyType?: boolean; /** - Specifying `$all` for the load options loads all the scalar properties (such as `Range.address`) but not the navigational properties (such as `Range.format.fill.color`). + * For EACH ITEM in the collection: Specifies the style name for the range. Use this property for custom styles and localized style names. To use the built-in styles that are portable between locales, see the "styleBuiltIn" property. + * + * @remarks + * [Api set: WordApi 1.1] */ - $all?: boolean; + style?: boolean; /** - * Specifies the amount of spacing (in points) after the specified paragraph or text column. + * For EACH ITEM in the collection: Specifies the built-in style name for the range. Use this property for built-in styles that are portable between locales. To use custom styles or localized style names, see the "style" property. + * + * @remarks + * [Api set: WordApi 1.3] + */ + styleBuiltIn?: boolean; + /** + * For EACH ITEM in the collection: Gets the text of the range. + * + * @remarks + * [Api set: WordApi 1.1] + */ + text?: boolean; + /** + * For EACH ITEM in the collection: Specifies whether Microsoft Word sets two lines of text in one and specifies the characters that enclose the text, if any. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - spaceAfter?: boolean; + twoLinesInOne?: boolean; /** - * Specifies the width, in points, of the specified text columns. + * For EACH ITEM in the collection: Specifies the type of underline applied to the range. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] * @beta */ - width?: boolean; + underline?: boolean; } /** * Represents a single bookmark in a document, selection, or range. The `Bookmark` object is a member of the `Bookmark` collection. @@ -159956,6 +171327,34 @@ declare namespace Word { */ type?: boolean; } + /** + * Contains a collection of {@link Word.ListTemplate} objects in a document, list template gallery, or document template. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + interface ListTemplateCollectionLoadOptions { + /** + Specifying `$all` 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 name of the list template. + * + * @remarks + * [Api set: WordApi BETA (PREVIEW ONLY)] + * @beta + */ + name?: boolean; + /** + * For EACH ITEM in the collection: Specifies whether the list template is outline numbered. + * + * @remarks + * [Api set: WordApiDesktop 1.1] + */ + outlineNumbered?: boolean; + } } } declare namespace Word { From fb306dc8b3c872c319e3e501d357ee938956423e Mon Sep 17 00:00:00 2001 From: Alex Jerabek <38896772+AlexJerabek@users.noreply.github.com> Date: Mon, 15 Sep 2025 16:19:50 -0700 Subject: [PATCH 4/5] Removing extra config files --- docs/includes/word-1_9.md | 76 ++++-------------- generate-docs/actual_configs.txt | Bin 0 -> 19484 bytes generate-docs/configs/excel-link-config.json | 17 ---- .../configs/officescript-preview-config.json | 12 --- .../configs/outlook-link-config.json | 17 ---- .../configs/powerpoint-link-config.json | 17 ---- ...-link-config.json => word-1_9-config.json} | 19 ++++- generate-docs/referenced_configs.txt | Bin 0 -> 3284 bytes 8 files changed, 34 insertions(+), 124 deletions(-) create mode 100644 generate-docs/actual_configs.txt delete mode 100644 generate-docs/configs/excel-link-config.json delete mode 100644 generate-docs/configs/officescript-preview-config.json delete mode 100644 generate-docs/configs/outlook-link-config.json delete mode 100644 generate-docs/configs/powerpoint-link-config.json rename generate-docs/configs/{word-link-config.json => word-1_9-config.json} (71%) create mode 100644 generate-docs/referenced_configs.txt diff --git a/docs/includes/word-1_9.md b/docs/includes/word-1_9.md index 273886aece..66c5486496 100644 --- a/docs/includes/word-1_9.md +++ b/docs/includes/word-1_9.md @@ -1,62 +1,18 @@ | Class | Fields | Description | |:---|:---|:---| -|[ComboBoxContentControl](/.comboboxcontentcontrol)|[addListItem(displayText: string, value?: string, index?: number)](/.comboboxcontentcontrol#word-javascript/api/word/-comboboxcontentcontrol-addlistitem-member(1))|Adds a new list item to this combo box content control and returns a Word.ContentControlListItem object.| -||[context](/.comboboxcontentcontrol#word-javascript/api/word/-comboboxcontentcontrol-context-member)|The request context associated with the object.| -||[deleteAllListItems()](/.comboboxcontentcontrol#word-javascript/api/word/-comboboxcontentcontrol-deletealllistitems-member(1))|Deletes all list items in this combo box content control.| -||[listItems](/.comboboxcontentcontrol#word-javascript/api/word/-comboboxcontentcontrol-listitems-member)|Gets the collection of list items in the combo box content control.| -||[load(propertyNames?: string \| string[])](/.comboboxcontentcontrol#word-javascript/api/word/-comboboxcontentcontrol-load-member(1))|Queues up a command to load the specified properties of the object.| -||[load(propertyNamesAndPaths?: { select?: string expand?: string })](/.comboboxcontentcontrol#word-javascript/api/word/-comboboxcontentcontrol-load-member(1))|Queues up a command to load the specified properties of the object.| -||[toJSON()](/.comboboxcontentcontrol#word-javascript/api/word/-comboboxcontentcontrol-tojson-member(1))|Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`.| -||[track()](/.comboboxcontentcontrol#word-javascript/api/word/-comboboxcontentcontrol-track-member(1))|Track the object for automatic adjustment based on surrounding changes in the document.| -||[untrack()](/.comboboxcontentcontrol#word-javascript/api/word/-comboboxcontentcontrol-untrack-member(1))|Release the memory associated with this object, if it has previously been tracked.| -|[ContentControl](/.contentcontrol)|[comboBoxContentControl](/.contentcontrol#word-javascript/api/word/-contentcontrol-comboboxcontentcontrol-member)|Gets the data of the content control when its type is `ComboBox`.| -||[dropDownListContentControl](/.contentcontrol#word-javascript/api/word/-contentcontrol-dropdownlistcontentcontrol-member)|Gets the data of the content control when its type is `DropDownList`.| -|[ContentControlData](/.contentcontroldata)|[comboBoxContentControl](/.contentcontroldata#word-javascript/api/word/-contentcontroldata-comboboxcontentcontrol-member)|Gets the data of the content control when its type is `ComboBox`.| -||[dropDownListContentControl](/.contentcontroldata#word-javascript/api/word/-contentcontroldata-dropdownlistcontentcontrol-member)|Gets the data of the content control when its type is `DropDownList`.| -|[ContentControlListItem](/.contentcontrollistitem)|[context](/.contentcontrollistitem#word-javascript/api/word/-contentcontrollistitem-context-member)|The request context associated with the object.| -||[delete()](/.contentcontrollistitem#word-javascript/api/word/-contentcontrollistitem-delete-member(1))|Deletes the list item.| -||[displayText](/.contentcontrollistitem#word-javascript/api/word/-contentcontrollistitem-displaytext-member)|Specifies the display text of a list item for a dropdown list or combo box content control.| -||[index](/.contentcontrollistitem#word-javascript/api/word/-contentcontrollistitem-index-member)|Specifies the index location of a content control list item in the collection of list items.| -||[load(options?: Word.Interfaces.ContentControlListItemLoadOptions)](/.contentcontrollistitem#word-javascript/api/word/-contentcontrollistitem-load-member(1))|Queues up a command to load the specified properties of the object.| -||[load(propertyNames?: string \| string[])](/.contentcontrollistitem#word-javascript/api/word/-contentcontrollistitem-load-member(1))|Queues up a command to load the specified properties of the object.| -||[load(propertyNamesAndPaths?: { select?: string expand?: string })](/.contentcontrollistitem#word-javascript/api/word/-contentcontrollistitem-load-member(1))|Queues up a command to load the specified properties of the object.| -||[select()](/.contentcontrollistitem#word-javascript/api/word/-contentcontrollistitem-select-member(1))|Selects the list item and sets the text of the content control to the value of the list item.| -||[set(properties: Interfaces.ContentControlListItemUpdateData, options?: OfficeExtension.UpdateOptions)](/.contentcontrollistitem#word-javascript/api/word/-contentcontrollistitem-set-member(1))|Sets multiple properties of an object at the same time.| -||[set(properties: Word.ContentControlListItem)](/.contentcontrollistitem#word-javascript/api/word/-contentcontrollistitem-set-member(1))|Sets multiple properties on the object at the same time, based on an existing loaded object.| -||[toJSON()](/.contentcontrollistitem#word-javascript/api/word/-contentcontrollistitem-tojson-member(1))|Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`.| -||[track()](/.contentcontrollistitem#word-javascript/api/word/-contentcontrollistitem-track-member(1))|Track the object for automatic adjustment based on surrounding changes in the document.| -||[untrack()](/.contentcontrollistitem#word-javascript/api/word/-contentcontrollistitem-untrack-member(1))|Release the memory associated with this object, if it has previously been tracked.| -||[value](/.contentcontrollistitem#word-javascript/api/word/-contentcontrollistitem-value-member)|Specifies the programmatic value of a list item for a dropdown list or combo box content control.| -|[ContentControlListItemCollection](/.contentcontrollistitemcollection)|[context](/.contentcontrollistitemcollection#word-javascript/api/word/-contentcontrollistitemcollection-context-member)|The request context associated with the object.| -||[getFirst()](/.contentcontrollistitemcollection#word-javascript/api/word/-contentcontrollistitemcollection-getfirst-member(1))|Gets the first list item in this collection.| -||[getFirstOrNullObject()](/.contentcontrollistitemcollection#word-javascript/api/word/-contentcontrollistitemcollection-getfirstornullobject-member(1))|Gets the first list item in this collection.| -||[items](/.contentcontrollistitemcollection#word-javascript/api/word/-contentcontrollistitemcollection-items-member)|Gets the loaded child items in this collection.| -||[load(options?: Word.Interfaces.ContentControlListItemCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions)](/.contentcontrollistitemcollection#word-javascript/api/word/-contentcontrollistitemcollection-load-member(1))|Queues up a command to load the specified properties of the object.| -||[load(propertyNames?: string \| string[])](/.contentcontrollistitemcollection#word-javascript/api/word/-contentcontrollistitemcollection-load-member(1))|Queues up a command to load the specified properties of the object.| -||[load(propertyNamesAndPaths?: OfficeExtension.LoadOption)](/.contentcontrollistitemcollection#word-javascript/api/word/-contentcontrollistitemcollection-load-member(1))|Queues up a command to load the specified properties of the object.| -||[toJSON()](/.contentcontrollistitemcollection#word-javascript/api/word/-contentcontrollistitemcollection-tojson-member(1))|Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`.| -||[track()](/.contentcontrollistitemcollection#word-javascript/api/word/-contentcontrollistitemcollection-track-member(1))|Track the object for automatic adjustment based on surrounding changes in the document.| -||[untrack()](/.contentcontrollistitemcollection#word-javascript/api/word/-contentcontrollistitemcollection-untrack-member(1))|Release the memory associated with this object, if it has previously been tracked.| -|[ContentControlListItemCollectionLoadOptions](/.contentcontrollistitemcollectionloadoptions)|[$all](/.contentcontrollistitemcollectionloadoptions#word-javascript/api/word/-contentcontrollistitemcollectionloadoptions-$all-member)|**| -||[displayText](/.contentcontrollistitemcollectionloadoptions#word-javascript/api/word/-contentcontrollistitemcollectionloadoptions-displaytext-member)|For EACH ITEM in the collection: Specifies the display text of a list item for a dropdown list or combo box content control.| -||[index](/.contentcontrollistitemcollectionloadoptions#word-javascript/api/word/-contentcontrollistitemcollectionloadoptions-index-member)|For EACH ITEM in the collection: Specifies the index location of a content control list item in the collection of list items.| -||[value](/.contentcontrollistitemcollectionloadoptions#word-javascript/api/word/-contentcontrollistitemcollectionloadoptions-value-member)|For EACH ITEM in the collection: Specifies the programmatic value of a list item for a dropdown list or combo box content control.| -|[ContentControlListItemData](/.contentcontrollistitemdata)|[displayText](/.contentcontrollistitemdata#word-javascript/api/word/-contentcontrollistitemdata-displaytext-member)|Specifies the display text of a list item for a dropdown list or combo box content control.| -||[index](/.contentcontrollistitemdata#word-javascript/api/word/-contentcontrollistitemdata-index-member)|Specifies the index location of a content control list item in the collection of list items.| -||[value](/.contentcontrollistitemdata#word-javascript/api/word/-contentcontrollistitemdata-value-member)|Specifies the programmatic value of a list item for a dropdown list or combo box content control.| -|[ContentControlListItemLoadOptions](/.contentcontrollistitemloadoptions)|[$all](/.contentcontrollistitemloadoptions#word-javascript/api/word/-contentcontrollistitemloadoptions-$all-member)|**| -||[displayText](/.contentcontrollistitemloadoptions#word-javascript/api/word/-contentcontrollistitemloadoptions-displaytext-member)|Specifies the display text of a list item for a dropdown list or combo box content control.| -||[index](/.contentcontrollistitemloadoptions#word-javascript/api/word/-contentcontrollistitemloadoptions-index-member)|Specifies the index location of a content control list item in the collection of list items.| -||[value](/.contentcontrollistitemloadoptions#word-javascript/api/word/-contentcontrollistitemloadoptions-value-member)|Specifies the programmatic value of a list item for a dropdown list or combo box content control.| -|[ContentControlListItemUpdateData](/.contentcontrollistitemupdatedata)|[displayText](/.contentcontrollistitemupdatedata#word-javascript/api/word/-contentcontrollistitemupdatedata-displaytext-member)|Specifies the display text of a list item for a dropdown list or combo box content control.| -||[index](/.contentcontrollistitemupdatedata#word-javascript/api/word/-contentcontrollistitemupdatedata-index-member)|Specifies the index location of a content control list item in the collection of list items.| -||[value](/.contentcontrollistitemupdatedata#word-javascript/api/word/-contentcontrollistitemupdatedata-value-member)|Specifies the programmatic value of a list item for a dropdown list or combo box content control.| -|[DropDownListContentControl](/.dropdownlistcontentcontrol)|[addListItem(displayText: string, value?: string, index?: number)](/.dropdownlistcontentcontrol#word-javascript/api/word/-dropdownlistcontentcontrol-addlistitem-member(1))|Adds a new list item to this dropdown list content control and returns a Word.ContentControlListItem object.| -||[context](/.dropdownlistcontentcontrol#word-javascript/api/word/-dropdownlistcontentcontrol-context-member)|The request context associated with the object.| -||[deleteAllListItems()](/.dropdownlistcontentcontrol#word-javascript/api/word/-dropdownlistcontentcontrol-deletealllistitems-member(1))|Deletes all list items in this dropdown list content control.| -||[listItems](/.dropdownlistcontentcontrol#word-javascript/api/word/-dropdownlistcontentcontrol-listitems-member)|Gets the collection of list items in the dropdown list content control.| -||[load(propertyNames?: string \| string[])](/.dropdownlistcontentcontrol#word-javascript/api/word/-dropdownlistcontentcontrol-load-member(1))|Queues up a command to load the specified properties of the object.| -||[load(propertyNamesAndPaths?: { select?: string expand?: string })](/.dropdownlistcontentcontrol#word-javascript/api/word/-dropdownlistcontentcontrol-load-member(1))|Queues up a command to load the specified properties of the object.| -||[toJSON()](/.dropdownlistcontentcontrol#word-javascript/api/word/-dropdownlistcontentcontrol-tojson-member(1))|Overrides the JavaScript `toJSON()` method in order to provide more useful output when an API object is passed to `JSON.stringify()`.| -||[track()](/.dropdownlistcontentcontrol#word-javascript/api/word/-dropdownlistcontentcontrol-track-member(1))|Track the object for automatic adjustment based on surrounding changes in the document.| -||[untrack()](/.dropdownlistcontentcontrol#word-javascript/api/word/-dropdownlistcontentcontrol-untrack-member(1))|Release the memory associated with this object, if it has previously been tracked.| +|[ComboBoxContentControl](/javascript/api/word/word.comboboxcontentcontrol)|[addListItem(displayText: string, value?: string, index?: number)](/javascript/api/word/word.comboboxcontentcontrol#word-word-comboboxcontentcontrol-addlistitem-member(1))|Adds a new list item to this combo box content control and returns a Word.ContentControlListItem object.| +||[deleteAllListItems()](/javascript/api/word/word.comboboxcontentcontrol#word-word-comboboxcontentcontrol-deletealllistitems-member(1))|Deletes all list items in this combo box content control.| +||[listItems](/javascript/api/word/word.comboboxcontentcontrol#word-word-comboboxcontentcontrol-listitems-member)|Gets the collection of list items in the combo box content control.| +|[ContentControl](/javascript/api/word/word.contentcontrol)|[comboBoxContentControl](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-comboboxcontentcontrol-member)|Gets the data of the content control when its type is `ComboBox`.| +||[dropDownListContentControl](/javascript/api/word/word.contentcontrol#word-word-contentcontrol-dropdownlistcontentcontrol-member)|Gets the data of the content control when its type is `DropDownList`.| +|[ContentControlListItem](/javascript/api/word/word.contentcontrollistitem)|[delete()](/javascript/api/word/word.contentcontrollistitem#word-word-contentcontrollistitem-delete-member(1))|Deletes the list item.| +||[displayText](/javascript/api/word/word.contentcontrollistitem#word-word-contentcontrollistitem-displaytext-member)|Specifies the display text of a list item for a dropdown list or combo box content control.| +||[index](/javascript/api/word/word.contentcontrollistitem#word-word-contentcontrollistitem-index-member)|Specifies the index location of a content control list item in the collection of list items.| +||[select()](/javascript/api/word/word.contentcontrollistitem#word-word-contentcontrollistitem-select-member(1))|Selects the list item and sets the text of the content control to the value of the list item.| +||[value](/javascript/api/word/word.contentcontrollistitem#word-word-contentcontrollistitem-value-member)|Specifies the programmatic value of a list item for a dropdown list or combo box content control.| +|[ContentControlListItemCollection](/javascript/api/word/word.contentcontrollistitemcollection)|[getFirst()](/javascript/api/word/word.contentcontrollistitemcollection#word-word-contentcontrollistitemcollection-getfirst-member(1))|Gets the first list item in this collection.| +||[getFirstOrNullObject()](/javascript/api/word/word.contentcontrollistitemcollection#word-word-contentcontrollistitemcollection-getfirstornullobject-member(1))|Gets the first list item in this collection.| +||[items](/javascript/api/word/word.contentcontrollistitemcollection#word-word-contentcontrollistitemcollection-items-member)|Gets the loaded child items in this collection.| +|[DropDownListContentControl](/javascript/api/word/word.dropdownlistcontentcontrol)|[addListItem(displayText: string, value?: string, index?: number)](/javascript/api/word/word.dropdownlistcontentcontrol#word-word-dropdownlistcontentcontrol-addlistitem-member(1))|Adds a new list item to this dropdown list content control and returns a Word.ContentControlListItem object.| +||[deleteAllListItems()](/javascript/api/word/word.dropdownlistcontentcontrol#word-word-dropdownlistcontentcontrol-deletealllistitems-member(1))|Deletes all list items in this dropdown list content control.| +||[listItems](/javascript/api/word/word.dropdownlistcontentcontrol#word-word-dropdownlistcontentcontrol-listitems-member)|Gets the collection of list items in the dropdown list content control.| diff --git a/generate-docs/actual_configs.txt b/generate-docs/actual_configs.txt new file mode 100644 index 0000000000000000000000000000000000000000..bad3c037cb33ab19b4db8f5686b7a6e6fa2f6064 GIT binary patch literal 19484 zcmeI4+iuf95QgU(iFfb|xZpSkn_H0JqD5RFaT6(m)-8n)M>!C9dElRQjN^Kv-msou z!m{F1*Y@t$+4aBU+5P?NsXP(iFP3VFM~V{Z^nQ1^UUL*9Rn4=`U9-*QnItm7dL+;Bn;c7!BBy#Ll6P|T zw^Yq_)m|bwQbnyYY>|fzp1(%kVyrdi-*H^X0mrBLyKtq|{64&IsN>K)GMUO4r8$7e z2LF{dP7&4zQ99+KbZF7;QWFsD$P*1rKd=OS~IS?SrcoZQ7FXJZ5N7yF3!PzY?;~^m!p1+A$O44; zNK`$#(Dvcy!Pv94F!og-Rr}eVpgP*~hix z!P%#?+HZu~jvJXx*W~Wa%)tDU* zPBmu7gHw&!@!(Wrc04%Mm>myJHD2R>ImxirIBCF!9wFuJ_8nv5&Ev>*W0WL0ThpOwj3kIoikPWKq|bD?~o371xZ; xZ!ama9$Ou=(!J&qXIGfBX@`+6k-Wu~{&d|dEzf9u`2)?a^+o^y literal 0 HcmV?d00001 diff --git a/generate-docs/configs/excel-link-config.json b/generate-docs/configs/excel-link-config.json deleted file mode 100644 index 41167d66d6..0000000000 --- a/generate-docs/configs/excel-link-config.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "linkConfigs": [ - { - "name": "Excel Standard Pattern", - "pathPattern": "javascript/api/excel", - "description": "Standard URL pattern for Excel APIs", - "globalFunctionTemplate": "/javascript/api/excel/#excel-excel-{fieldName}-function(1)", - "classTemplate": "/javascript/api/excel/excel.{className}", - "classMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}{suffix}", - "enumTemplate": "/javascript/api/excel/excel.{className}", - "enumMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}", - "interfaceTemplate": "/javascript/api/excel/excel.{className}", - "interfaceMemberTemplate": "/javascript/api/excel/excel.{className}#excel-excel-{className}-{fieldName}{suffix}", - "typeAliasTemplate": "/javascript/api/excel/excel.{className}" - } - ] -} diff --git a/generate-docs/configs/officescript-preview-config.json b/generate-docs/configs/officescript-preview-config.json deleted file mode 100644 index 0385017d61..0000000000 --- a/generate-docs/configs/officescript-preview-config.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "excludedFieldPatterns": [ - "toJSON", - "^_" - ], - "excludedFieldNames": [ - "context", - "isNullObject" - ], - "includeStaticFields": false, - "includeEnums": false -} \ No newline at end of file diff --git a/generate-docs/configs/outlook-link-config.json b/generate-docs/configs/outlook-link-config.json deleted file mode 100644 index b3db65b07f..0000000000 --- a/generate-docs/configs/outlook-link-config.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "linkConfigs": [ - { - "name": "Outlook Standard Pattern", - "pathPattern": "javascript/api/outlook", - "description": "Standard URL pattern for Outlook APIs", - "globalFunctionTemplate": "/javascript/api/outlook/office#{fieldName}", - "classTemplate": "/javascript/api/outlook/office.{className}", - "classMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}{suffix}", - "enumTemplate": "/javascript/api/outlook/office.{className}", - "enumMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}", - "interfaceTemplate": "/javascript/api/outlook/office.{className}", - "interfaceMemberTemplate": "/javascript/api/outlook/office.{className}#outlook-office-{className}-{fieldName}{suffix}", - "typeAliasTemplate": "/javascript/api/outlook/office.{className}" - } - ] -} diff --git a/generate-docs/configs/powerpoint-link-config.json b/generate-docs/configs/powerpoint-link-config.json deleted file mode 100644 index 1a14c3c0e4..0000000000 --- a/generate-docs/configs/powerpoint-link-config.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "linkConfigs": [ - { - "name": "PowerPoint Standard Pattern", - "pathPattern": "javascript/api/powerpoint", - "description": "Standard URL pattern for PowerPoint APIs", - "globalFunctionTemplate": "/javascript/api/powerpoint/powerpoint#{fieldName}", - "classTemplate": "/javascript/api/powerpoint/powerpoint.{className}", - "classMemberTemplate": "/javascript/api/powerpoint/powerpoint.{className}#powerpoint-powerpoint-{className}-{fieldName}{suffix}", - "enumTemplate": "/javascript/api/powerpoint/powerpoint.{className}", - "enumMemberTemplate": "/javascript/api/powerpoint/powerpoint.{className}#powerpoint-powerpoint-{className}-{fieldName}", - "interfaceTemplate": "/javascript/api/powerpoint/powerpoint.{className}", - "interfaceMemberTemplate": "/javascript/api/powerpoint/powerpoint.{className}#powerpoint-powerpoint-{className}-{fieldName}{suffix}", - "typeAliasTemplate": "/javascript/api/powerpoint/powerpoint.{className}" - } - ] -} diff --git a/generate-docs/configs/word-link-config.json b/generate-docs/configs/word-1_9-config.json similarity index 71% rename from generate-docs/configs/word-link-config.json rename to generate-docs/configs/word-1_9-config.json index a270b71c84..7a9e947224 100644 --- a/generate-docs/configs/word-link-config.json +++ b/generate-docs/configs/word-1_9-config.json @@ -1,4 +1,21 @@ { + "excludedFieldPatterns": [ + "([a-zA-Z]+)(\\??:)([\\n]?([ |]*\"[\\w]*\"[|,\\n]*)+?)([ ]*[\\),])" + ], + "excludedFieldNames": [ + "load", + "set", + "toJSON", + "context", + "track", + "untrack" + ], + "excludedClassPatterns": [ + "LoadOptions$", + "Data$" + ], + "includeStaticFields": false, + "includeEnums": false, "linkConfigs": [ { "name": "Word Standard Pattern", @@ -14,4 +31,4 @@ "typeAliasTemplate": "/javascript/api/word/word.{className}" } ] -} +} \ No newline at end of file diff --git a/generate-docs/referenced_configs.txt b/generate-docs/referenced_configs.txt new file mode 100644 index 0000000000000000000000000000000000000000..131fcc6335bc588274371d1caf004c303490670d GIT binary patch literal 3284 zcmb`J+irs}7=wL1X^*mL^svLz^rB_Qt{_Uso_?F*rV9Gw#ZrY3AlZb-pF@6sYJ6jh z8hhNJ!iMJ^@3v@gz%$J({f8qwh`!ol6pQa)2(@f-jnvA?p^O5&yO7cFw7gA!Mz1p^ literal 0 HcmV?d00001 From df69533bb8c34c390406e0b0b288aa716cb44647 Mon Sep 17 00:00:00 2001 From: Alex Jerabek <38896772+AlexJerabek@users.noreply.github.com> Date: Mon, 15 Sep 2025 16:21:18 -0700 Subject: [PATCH 5/5] Remove temp file --- generate-docs/referenced_configs.txt | Bin 3284 -> 0 bytes 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 generate-docs/referenced_configs.txt diff --git a/generate-docs/referenced_configs.txt b/generate-docs/referenced_configs.txt deleted file mode 100644 index 131fcc6335bc588274371d1caf004c303490670d..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 3284 zcmb`J+irs}7=wL1X^*mL^svLz^rB_Qt{_Uso_?F*rV9Gw#ZrY3AlZb-pF@6sYJ6jh z8hhNJ!iMJ^@3v@gz%$J({f8qwh`!ol6pQa)2(@f-jnvA?p^O5&yO7cFw7gA!Mz1p^